Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

GenerateIndexFile Class Reference

For generating of index files. More...

#include <sgindgen.h>

Inheritance diagram for GenerateIndexFile:

CCObject SimpleCCObject List of all members.

Public Member Functions

 GenerateIndexFile ()
 Variable initalising constructor Notes:.
 ~GenerateIndexFile ()
BOOL Generate (PathName *IndexFile, PathName *LibDirPath, String_64 *Author, SGLibType Type, BOOL Thumbnails)

Static Public Member Functions

static BOOL IsDirectoryReadOnly (PathName *Directory)
static BOOL CheckForRemote (PathName *FilesDirectory, String_256 *RemoteDirectory)
static BOOL GiveMeAValidDirectoryName (String_256 *Input, String_256 *Output)
static BOOL ReplaceCharacters (StringBase *Source, TCHAR Search, TCHAR Replace)
static INT32 CountCommas (StringBase *Source, StringBase &SearchFor)
static BOOL GetToken (StringBase *Source, INT32 Count, String_256 *Result)
static UINT32 GetDirectoryChecksum (String_256 *Directory, SGLibType Type=SGLib_Blank)

Static Public Attributes

static BOOL UseAutomaticUpdate = FALSE
static BOOL CreateFontIndexes = FALSE
static BOOL UseOldIndexes = TRUE
static BOOL UseDocComments = TRUE

Protected Member Functions

BOOL CloseSearchHandle (void)
BOOL CloseIndexFileHandle (void)
BOOL CreateIndexFile (void)
INT32 CountValidFiles (void)
BOOL RemoteIndexSetup (PathName *FilesPath)
BOOL CheckExistingIndexForRemoteness (PathName *IndexFile, PathName *FilesPath)
BOOL DoIndexHeader (void)
BOOL AddToSubLibrary (void)
BOOL FixSubLibraryNumber (void)
BOOL AddFile (PathName *FileName)
INT16 GetShort (FILE *fp)
INT16 GetFixed (FILE *fp)
INT32 GetLONG (FILE *fp)
BOOL RipTrueTypeNameFromFile (PathName *FileName, String_256 *Name)
BOOL RipATMNameFromFile (PathName *FileName, String_256 *RetName, BOOL *Bold, BOOL *Italic)
BOOL CreateThumbnail (PathName *InFile, PathName *OutFile, UINT16 XSize, UINT16 YSize)
BOOL CreateThumbnails (PathName *FileName, BOOL NewSystem=TRUE)
BOOL RipDescriptionFromFile (PathName *FileName, String_256 *Text, String_256 *Keywords=NULL, String_256 *Title=NULL)
BOOL RipDescriptionFromEPSFile (PathName *FileName, String_256 *Text, String_256 *Keywords=NULL, String_256 *Title=NULL)
BOOL RipDescriptionFromCDRFile (PathName *FileName, String_256 *Text, String_256 *Keywords=NULL, String_256 *Title=NULL)
BOOL RipDescriptionFromNativeV2File (PathName *FileName, String_256 *Text, String_256 *Keywords=NULL, String_256 *Title=NULL, BOOL *FileIsNewNative=NULL)
BOOL RipDescriptionFromIndex (PathName *IndexFile, PathName *FileName, FilePos Start, INT32 DescriptionField, INT32 KeywordField, INT32 TitleField, String_256 *Text, String_256 *Keywords=NULL, String_256 *Title=NULL)
BOOL PrePassIndex (PathName *IndexFile, FilePos *Start, INT32 *DescriptionField, INT32 *KeywordField, INT32 *TitleField, String_256 *Description)
BOOL AddLineToIndex (String_256 *Text)

Static Protected Member Functions

static BOOL IsFileType (PathName *FileName, const SGLibType Type)
static BOOL PreCreateThumbnail (PathName *InFile)

Protected Attributes

PathName Index
PathName LibPath
SGLibType LibType
BOOL DoThumbnails
String_64 Author
CCDiskFile * IndexFile
FilePos IndexCountOff
HANDLE hSearch
UINT32 ID
INT32 TotalFiles
PathName * TmpIndexFile
IndGenFileBuffer FileNameBuffer
FilePos OldIndexStart
INT32 OldIndexDescriptionField
INT32 OldIndexKeywordField
INT32 OldIndexTitleField
BOOL OldIndexOK
String_256 OldIndexDescription
BOOL IndexIsRemote
String_256 RemoteLocationOfIndex
String_256 RemoteLocationOfFiles

Detailed Description

For generating of index files.

Author:
Richard_Millican (Xara Group Ltd) <camelotdev@xara.com>
Date:
09/04/95

Definition at line 157 of file sgindgen.h.

Constructor & Destructor Documentation

GenerateIndexFile::GenerateIndexFile (   ) 
 

Variable initalising constructor Notes:.

Author:
Richard_Millican (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/05/95
Parameters:
[INPUTS] 
[OUTPUTS] 
Returns:

Definition at line 200 of file sgindgen.cpp.

00201 {
00202     LibType = SGLib_Blank;
00203     DoThumbnails = FALSE;
00204     Author = _T("");
00205     IndexFile = NULL;
00206     IndexCountOff = 0;
00207     hSearch = NULL;
00208     ID = 0;
00209     TotalFiles = 0;
00210     TmpIndexFile = NULL;
00211     OldIndexStart = 0;
00212     OldIndexDescriptionField = OldIndexKeywordField = OldIndexTitleField = 0;
00213     OldIndexOK = FALSE;
00214     OldIndexDescription = "";
00215 //  TmpDiskFile = NULL;
00216 }

GenerateIndexFile::~GenerateIndexFile (   )  [inline]
 

Definition at line 167 of file sgindgen.h.

00167 {}

Member Function Documentation

BOOL GenerateIndexFile::AddFile (  PathName *  FileName  )  [protected]
 

BOOL GenerateIndexFile::AddLineToIndex (  String_256 *  Text  )  [protected]
 

BOOL GenerateIndexFile::AddToSubLibrary (  void   )  [protected]
 

BOOL GenerateIndexFile::CheckExistingIndexForRemoteness (  PathName *  IndexFile,
PathName *  FilesPath
)  [protected]
 

static BOOL GenerateIndexFile::CheckForRemote (  PathName *  FilesDirectory,
String_256 *  RemoteDirectory
)  [static]
 

BOOL GenerateIndexFile::CloseIndexFileHandle (  void   )  [protected]
 

BOOL GenerateIndexFile::CloseSearchHandle (  void   )  [protected]
 

static INT32 GenerateIndexFile::CountCommas (  StringBase *  Source,
StringBase &  SearchFor
)  [static]
 

INT32 GenerateIndexFile::CountValidFiles (  void   )  [protected]
 

BOOL GenerateIndexFile::CreateIndexFile (  void   )  [protected]
 

BOOL GenerateIndexFile::CreateThumbnail (  PathName *  InFile,
PathName *  OutFile,
UINT16  XSize,
UINT16  YSize
)  [protected]
 

BOOL GenerateIndexFile::CreateThumbnails (  PathName *  FileName,
BOOL  NewSystem = TRUE
)  [protected]
 

BOOL GenerateIndexFile::DoIndexHeader (  void   )  [protected]
 

BOOL GenerateIndexFile::FixSubLibraryNumber (  void   )  [protected]
 

BOOL GenerateIndexFile::Generate (  PathName *  IndexFile,
PathName *  LibDirPath,
String_64 *  Author,
SGLibType  Type,
BOOL  Thumbnails
) 
 

static UINT32 GenerateIndexFile::GetDirectoryChecksum (  String_256 *  Directory,
SGLibType  Type = SGLib_Blank
)  [static]
 

INT16 GenerateIndexFile::GetFixed (  FILE *  fp  )  [protected]
 

INT32 GenerateIndexFile::GetLONG (  FILE *  fp  )  [protected]
 

INT16 GenerateIndexFile::GetShort (  FILE *  fp  )  [protected]
 

static BOOL GenerateIndexFile::GetToken (  StringBase *  Source,
INT32  Count,
String_256 *  Result
)  [static]
 

static BOOL GenerateIndexFile::GiveMeAValidDirectoryName (  String_256 *  Input,
String_256 *  Output
)  [static]
 

static BOOL GenerateIndexFile::IsDirectoryReadOnly (  PathName *  Directory  )  [static]
 

static BOOL GenerateIndexFile::IsFileType (  PathName *  FileName,
const SGLibType  Type
)  [static, protected]
 

static BOOL GenerateIndexFile::PreCreateThumbnail (  PathName *  InFile  )  [static, protected]
 

BOOL GenerateIndexFile::PrePassIndex (  PathName *  IndexFile,
FilePos *  Start,
INT32 *  DescriptionField,
INT32 *  KeywordField,
INT32 *  TitleField,
String_256 *  Description
)  [protected]
 

BOOL GenerateIndexFile::RemoteIndexSetup (  PathName *  FilesPath  )  [protected]
 

static BOOL GenerateIndexFile::ReplaceCharacters (  StringBase *  Source,
TCHAR  Search,
TCHAR  Replace
)  [static]
 

BOOL GenerateIndexFile::RipATMNameFromFile (  PathName *  FileName,
String_256 *  RetName,
BOOL *  Bold,
BOOL *  Italic
)  [protected]
 

BOOL GenerateIndexFile::RipDescriptionFromCDRFile (  PathName *  FileName,
String_256 *  Text,
String_256 *  Keywords = NULL,
String_256 *  Title = NULL
)  [protected]
 

BOOL GenerateIndexFile::RipDescriptionFromEPSFile (  PathName *  FileName,
String_256 *  Text,
String_256 *  Keywords = NULL,
String_256 *  Title = NULL
)  [protected]
 

BOOL GenerateIndexFile::RipDescriptionFromFile (  PathName *  FileName,
String_256 *  Text,
String_256 *  Keywords = NULL,
String_256 *  Title = NULL
)  [protected]
 

BOOL GenerateIndexFile::RipDescriptionFromIndex (  PathName *  IndexFile,
PathName *  FileName,
FilePos  Start,
INT32  DescriptionField,
INT32  KeywordField,
INT32  TitleField,
String_256 *  Text,
String_256 *  Keywords = NULL,
String_256 *  Title = NULL
)  [protected]
 

BOOL GenerateIndexFile::RipDescriptionFromNativeV2File (  PathName *  FileName,
String_256 *  Text,
String_256 *  Keywords = NULL,
String_256 *  Title = NULL,
BOOL *  FileIsNewNative = NULL
)  [protected]
 

BOOL GenerateIndexFile::RipTrueTypeNameFromFile (  PathName *  FileName,
String_256 *  Name
)  [protected]
 

Member Data Documentation

String_64 GenerateIndexFile::Author [protected]
 

Definition at line 293 of file sgindgen.h.

BOOL GenerateIndexFile::CreateFontIndexes = FALSE [static]
 

Definition at line 338 of file sgindgen.h.

BOOL GenerateIndexFile::DoThumbnails [protected]
 

Definition at line 292 of file sgindgen.h.

IndGenFileBuffer GenerateIndexFile::FileNameBuffer [protected]
 

Definition at line 315 of file sgindgen.h.

HANDLE GenerateIndexFile::hSearch [protected]
 

Definition at line 302 of file sgindgen.h.

UINT32 GenerateIndexFile::ID [protected]
 

Definition at line 305 of file sgindgen.h.

PathName GenerateIndexFile::Index [protected]
 

Definition at line 289 of file sgindgen.h.

FilePos GenerateIndexFile::IndexCountOff [protected]
 

Definition at line 299 of file sgindgen.h.

CCDiskFile* GenerateIndexFile::IndexFile [protected]
 

Definition at line 296 of file sgindgen.h.

BOOL GenerateIndexFile::IndexIsRemote [protected]
 

Definition at line 326 of file sgindgen.h.

PathName GenerateIndexFile::LibPath [protected]
 

Definition at line 290 of file sgindgen.h.

SGLibType GenerateIndexFile::LibType [protected]
 

Definition at line 291 of file sgindgen.h.

String_256 GenerateIndexFile::OldIndexDescription [protected]
 

Definition at line 323 of file sgindgen.h.

INT32 GenerateIndexFile::OldIndexDescriptionField [protected]
 

Definition at line 319 of file sgindgen.h.

INT32 GenerateIndexFile::OldIndexKeywordField [protected]
 

Definition at line 320 of file sgindgen.h.

BOOL GenerateIndexFile::OldIndexOK [protected]
 

Definition at line 322 of file sgindgen.h.

FilePos GenerateIndexFile::OldIndexStart [protected]
 

Definition at line 318 of file sgindgen.h.

INT32 GenerateIndexFile::OldIndexTitleField [protected]
 

Definition at line 321 of file sgindgen.h.

String_256 GenerateIndexFile::RemoteLocationOfFiles [protected]
 

Definition at line 328 of file sgindgen.h.

String_256 GenerateIndexFile::RemoteLocationOfIndex [protected]
 

Definition at line 327 of file sgindgen.h.

PathName* GenerateIndexFile::TmpIndexFile [protected]
 

Definition at line 311 of file sgindgen.h.

INT32 GenerateIndexFile::TotalFiles [protected]
 

Definition at line 308 of file sgindgen.h.

BOOL GenerateIndexFile::UseAutomaticUpdate = FALSE [static]
 

Definition at line 334 of file sgindgen.h.

BOOL GenerateIndexFile::UseDocComments = TRUE [static]
 

Definition at line 342 of file sgindgen.h.

BOOL GenerateIndexFile::UseOldIndexes = TRUE [static]
 

Definition at line 341 of file sgindgen.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:54:46 2007 for Camelot by  doxygen 1.4.4