diff options
Diffstat (limited to 'dep/CascLib/src/common/FileTree.h')
| -rw-r--r-- | dep/CascLib/src/common/FileTree.h | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/dep/CascLib/src/common/FileTree.h b/dep/CascLib/src/common/FileTree.h new file mode 100644 index 00000000000..904da6c4c46 --- /dev/null +++ b/dep/CascLib/src/common/FileTree.h @@ -0,0 +1,116 @@ +/*****************************************************************************/ +/* FileTree.h Copyright (c) Ladislav Zezula 2018 */ +/*---------------------------------------------------------------------------*/ +/* Common implementation of a file tree object for various ROOt file formats */ +/*---------------------------------------------------------------------------*/ +/* Date Ver Who Comment */ +/* -------- ---- --- ------- */ +/* 29.05.18 1.00 Lad The first version of FileTree.h */ +/*****************************************************************************/ + +#ifndef __FILETREE_H__ +#define __FILETREE_H__ + +//----------------------------------------------------------------------------- +// Structures + +#define FTREE_FLAG_USE_DATA_ID 0x0001 // The FILE_NODE also contains file data ID +#define FTREE_FLAG_USE_LOCALE_FLAGS 0x0002 // The FILE_NODE also contains file locale flags +#define FTREE_FLAG_USE_CONTENT_FLAGS 0x0004 // The FILE_NODE also contains content flags + +#define CFN_FLAG_FOLDER 0x0001 // This item is a folder +#define CFN_FLAG_MOUNT_POINT 0x0002 // This item is a mount point. + +// Common structure for holding a single folder/file node +typedef struct _CASC_FILE_NODE +{ + ULONGLONG FileNameHash; // Jenkins hash of the normalized file name (uppercase, backslashes) + PCASC_CKEY_ENTRY pCKeyEntry; // Pointer to the CKey entry. + DWORD Parent; // The index of a parent directory. If CASC_INVALID_INDEX, then this is the root item + DWORD NameIndex; // Index of the node name. If CASC_INVALID_INDEX, then this node has no name + USHORT NameLength; // Length of the node name (without the zero terminator) + USHORT Flags; // See CFE_FLAG_XXX + + DWORD ExtraValues[4]; // FileDataId: Only if FTREE_FLAG_USE_DATA_ID specified at create + // LocaleFlags: Only if FTREE_FLAG_USE_LOCALE_FLAGS specified at create + // ContentFlags: Only if FTREE_FLAG_USE_CONTENT_FLAGS specified at create +} CASC_FILE_NODE, *PCASC_FILE_NODE; + +// Common structure for comparing a file node +typedef struct _CASC_COMPARE_CONTEXT +{ + ULONGLONG FileNameHash; + const char * szFileName; + void * pThis; +} CASC_COMPARE_CONTEXT, *PCASC_COMPARE_CONTEXT; + +// Main structure for the file tree +class CASC_FILE_TREE +{ + public: + + // Initializes/destroys the entire tree + int Create(DWORD Flags = 0); + void Free(); + + // Inserts a new node to the tree; either with name or nameless + PCASC_FILE_NODE InsertByName(PCASC_CKEY_ENTRY pCKeyEntry, const char * szFileName, DWORD FileDataId = CASC_INVALID_ID, DWORD LocaleFlags = CASC_INVALID_ID, DWORD ContentFlags = CASC_INVALID_ID); + PCASC_FILE_NODE InsertByHash(PCASC_CKEY_ENTRY pCKeyEntry, ULONGLONG FileNameHash, DWORD FileDataId, DWORD LocaleFlags = CASC_INVALID_ID, DWORD ContentFlags = CASC_INVALID_ID); + PCASC_FILE_NODE InsertById(PCASC_CKEY_ENTRY pCKeyEntry, DWORD FileDataId, DWORD LocaleFlags = CASC_INVALID_ID, DWORD ContentFlags = CASC_INVALID_ID); + + // Returns an item at the given index. The PathAt also builds the full path of the node + PCASC_FILE_NODE ItemAt(size_t nItemIndex); + PCASC_FILE_NODE PathAt(char * szBuffer, size_t cchBuffer, size_t nItemIndex); + size_t PathAt(char * szBuffer, size_t cchBuffer, PCASC_FILE_NODE pFileNode); + + // Finds a file using its full path, FileDataId or CKey/EKey + PCASC_FILE_NODE Find(const char * szFullPath, DWORD FileDataId, struct _CASC_FIND_DATA * pFindData); + PCASC_FILE_NODE Find(PCASC_CKEY_ENTRY pCKeyEntry); + PCASC_FILE_NODE Find(ULONGLONG FileNameHash); + PCASC_FILE_NODE FindById(DWORD FileDataId); + + // Assigns a file name to the node + bool SetNodeFileName(PCASC_FILE_NODE pFileNode, const char * szFileName); + + // Returns the number of items in the tree + size_t GetMaxFileIndex(); + size_t GetCount(); + + // Returns the index of an item in the tree + size_t IndexOf(PCASC_FILE_NODE pFileNode); + + // Retrieves the extra values from the node (if supported) + void GetExtras(PCASC_FILE_NODE pFileNode, PDWORD PtrFileDataId, PDWORD PtrLocaleFlags, PDWORD PtrContentFlags); + void SetExtras(PCASC_FILE_NODE pFileNode, DWORD FileDataId, DWORD LocaleFlags, DWORD ContentFlags); + + // Change the length of the key + bool SetKeyLength(DWORD KeyLength); + + // Retrieve the maximum FileDataId ever inserted + DWORD GetNextFileDataId(); + + protected: + + PCASC_FILE_NODE InsertNew(PCASC_CKEY_ENTRY pCKeyEntry); + PCASC_FILE_NODE InsertNew(); + bool InsertToHashTable(PCASC_FILE_NODE pFileNode); + bool InsertToIdTable(PCASC_FILE_NODE pFileNode); + + bool SetNodePlainName(PCASC_FILE_NODE pFileNode, const char * szPlainName, const char * szPlainNameEnd); + bool RebuildNameMaps(); + + CASC_ARRAY NodeTable; // Dynamic array that holds all CASC_FILE_NODEs + CASC_ARRAY NameTable; // Dynamic array that holds all node names + + CASC_ARRAY FileDataIds; // Dynamic array that maps FileDataId -> CASC_FILE_NODE + CASC_MAP NameMap; // Map of FileNameHash -> CASC_FILE_NODE + + size_t FileDataIdOffset; // If nonzero, this is the offset of the "FileDataId" field in the CASC_FILE_NODE + size_t LocaleFlagsOffset; // If nonzero, this is the offset of the "LocaleFlags" field in the CASC_FILE_NODE + size_t ContentFlagsOffset; // If nonzero, this is the offset of the "ContentFlags" field in the CASC_FILE_NODE + DWORD KeyLength; // Actual length of the key supported by the root handler +}; + +typedef CASC_FILE_TREE * PCASC_FILE_TREE; + +#endif // __FILETREE_H__ |