ListFile.cpp File Reference

#include "../CascLib.h"
#include "../CascCommon.h"

Include dependency graph for ListFile.cpp:

Classes
struct	_LISTFILE_CACHE

Macros
#define	__CASCLIB_SELF__
#define	LISTMAP_INITIAL   0x100000

Typedefs
typedef struct _LISTFILE_CACHE	LISTFILE_CACHE
typedef struct _LISTFILE_CACHE *	PLISTFILE_CACHE

Functions
static PLISTFILE_CACHE	CreateListFileCache (DWORD dwFileSize)
void *	ListFile_OpenExternal (const TCHAR *szListFile)
void *	ListFile_FromBuffer (LPBYTE pbBuffer, DWORD cbBuffer)
bool	ListFile_VerifyMD5 (void *pvListFile, LPBYTE pbHashMD5)
size_t	ListFile_GetNextLine (void *pvListFile, const char **pszLineBegin, const char **pszLineEnd)
size_t	ListFile_GetNextLine (void *pvListFile, char *szBuffer, size_t nMaxChars)
size_t	ListFile_GetNext (void *pvListFile, const char *szMask, char *szBuffer, size_t nMaxChars)
void	ListFile_Free (void *pvListFile)
static PLISTFILE_MAP	ListMap_Create ()
static PLISTFILE_MAP	ListMap_InsertName (PLISTFILE_MAP pListMap, const char *szFileName, size_t nLength)
static PLISTFILE_MAP	ListMap_Finish (PLISTFILE_MAP pListMap)
PLISTFILE_MAP	ListFile_CreateMap (const TCHAR *szListFile)
const char *	ListFile_FindName (PLISTFILE_MAP pListMap, ULONGLONG FileNameHash)
void	ListFile_FreeMap (PLISTFILE_MAP pListMap)

Macro Definition Documentation

#define __CASCLIB_SELF__

#define LISTMAP_INITIAL   0x100000

Typedef Documentation

typedef struct _LISTFILE_CACHE LISTFILE_CACHE

typedef struct _LISTFILE_CACHE * PLISTFILE_CACHE

Function Documentation

static PLISTFILE_CACHE CreateListFileCache ( DWORD  dwFileSize )

static

{
 PLISTFILE_CACHE pCache;

 // Allocate cache for one file block
 pCache = (PLISTFILE_CACHE)CASC_ALLOC(BYTE, sizeof(LISTFILE_CACHE) + dwFileSize);
 if(pCache != NULL)
 {
 // Set the initial pointers
 pCache->pBegin =
 pCache->pPos = (char *)(pCache + 1);
 pCache->pEnd = pCache->pBegin + dwFileSize;
 }

 // Return the cache
 return pCache;
}

Here is the caller graph for this function:

PLISTFILE_MAP ListFile_CreateMap

(

const TCHAR *

szListFile

)

{
 PLISTFILE_MAP pListMap = NULL;
 void * pvListFile;
 char szFileName[MAX_PATH+1];
 size_t nLength;

 // Only if the listfile name has been given
 if(szListFile != NULL)
 {
 // Create map for the listfile
 pListMap = ListMap_Create();
 if(pListMap != NULL)
 {
 // Open the external listfile
 pvListFile = ListFile_OpenExternal(szListFile);
 if(pvListFile != NULL)
 {
 // Go through the entire listfile and insert each name to the map
 while((nLength = ListFile_GetNext(pvListFile, "*", szFileName, MAX_PATH)) != 0)
 {
 // Insert the file name to the map
 pListMap = ListMap_InsertName(pListMap, szFileName, nLength);
 if(pListMap == NULL)
 break;
 }

 // Finish the listfile map
 pListMap = ListMap_Finish(pListMap);

 // Free the listfile
 ListFile_Free(pvListFile);
 }
 }
 }

 // Return the created map
 return pListMap;
}

Here is the call graph for this function:

const char* ListFile_FindName	(	PLISTFILE_MAP	pListMap,
		ULONGLONG	FileNameHash
	)

{
 PLISTFILE_ENTRY pListEntry = NULL;

 if(pListMap != NULL)
 pListEntry = (PLISTFILE_ENTRY)Map_FindObject(pListMap->pNameMap, &FileNameHash, NULL);
 return (pListEntry != NULL) ? pListEntry->szFileName : "";
}

Here is the call graph for this function:

void ListFile_Free

(

void *

pvListFile

)

{
 if(pvListFile != NULL)
 {
 CASC_FREE(pvListFile);
 }
}

Here is the caller graph for this function:

void ListFile_FreeMap

(

PLISTFILE_MAP

pListMap

)

{
 if(pListMap != NULL)
 {
 if(pListMap->pNameMap != NULL)
 Map_Free(pListMap->pNameMap);
 CASC_FREE(pListMap);
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void* ListFile_FromBuffer	(	LPBYTE	pbBuffer,
		DWORD	cbBuffer
	)

{
 PLISTFILE_CACHE pCache = NULL;

 // Create the in-memory cache for the entire listfile
 // The listfile does not have any data loaded yet
 pCache = CreateListFileCache(cbBuffer);
 if(pCache != NULL)
 memcpy(pCache->pBegin, pbBuffer, cbBuffer);

 return pCache;
}

Here is the call graph for this function:

Here is the caller graph for this function:

size_t ListFile_GetNext	(	void *	pvListFile,
		const char *	szMask,
		char *	szBuffer,
		size_t	nMaxChars
	)

{
 size_t nLength = 0;
 int nError = ERROR_SUCCESS;

 // Check for parameters
 for(;;)
 {
 // Read the (next) line
 nLength = ListFile_GetNextLine(pvListFile, szBuffer, nMaxChars);
 if(nLength == 0)
 {
 nError = ERROR_NO_MORE_FILES;
 break;
 }

 // If some mask entered, check it
 if(CheckWildCard(szBuffer, szMask))
 {
 nError = ERROR_SUCCESS;
 break;
 }
 }

 if(nError != ERROR_SUCCESS)
 SetLastError(nError);
 return nLength;
}

Here is the call graph for this function:

Here is the caller graph for this function:

size_t ListFile_GetNextLine	(	void *	pvListFile,
		const char **	pszLineBegin,
		const char **	pszLineEnd
	)

{
 PLISTFILE_CACHE pCache = (PLISTFILE_CACHE)pvListFile;
 char * szExtraString = NULL;
 char * szLineBegin;
 char * szLineEnd;

 // Skip newlines, spaces, tabs and another non-printable stuff
 while(pCache->pPos < pCache->pEnd && pCache->pPos[0] <= 0x20)
 pCache->pPos++;

 // Remember the begin of the line
 szLineBegin = pCache->pPos;

 // Copy the remaining characters
 while(pCache->pPos < pCache->pEnd)
 {
 // If we have found a newline, stop loading
 if(pCache->pPos[0] == 0x0D || pCache->pPos[0] == 0x0A)
 break;

 // Blizzard listfiles can also contain information about patch:
 // Pass1\Files\MacOS\unconditional\user\Background Downloader.app\Contents\Info.plist~Patch(Data#frFR#base-frFR,1326)
 if(pCache->pPos[0] == '~')
 szExtraString = pCache->pPos;

 // Move the position by one character forward
 pCache->pPos++;
 }

 // Remember the end of the line
 szLineEnd = (szExtraString != NULL && szExtraString[0] == '~' && szExtraString[1] == 'P') ? szExtraString : pCache->pPos;

 // Give the caller the positions of the begin and end of the line
 pszLineBegin[0] = szLineBegin;
 pszLineEnd[0] = szLineEnd;
 return (size_t)(szLineEnd - szLineBegin);
}

Here is the caller graph for this function:

size_t ListFile_GetNextLine	(	void *	pvListFile,
		char *	szBuffer,
		size_t	nMaxChars
	)

{
 const char * szLineBegin = NULL;
 const char * szLineEnd = NULL;
 size_t nLength;

 // Retrieve the next line
 nLength = ListFile_GetNextLine(pvListFile, &szLineBegin, &szLineEnd);

 // Check the length
 if(nLength > nMaxChars)
 {
 SetLastError(ERROR_INSUFFICIENT_BUFFER);
 return 0;
 }

 // Copy the line to the user buffer
 memcpy(szBuffer, szLineBegin, nLength);
 szBuffer[nLength] = 0;
 return nLength;
}

Here is the call graph for this function:

void* ListFile_OpenExternal

(

const TCHAR *

szListFile

)

{
 PLISTFILE_CACHE pCache = NULL;
 TFileStream * pStream;
 ULONGLONG FileSize = 0;

 // Open the external listfile
 pStream = FileStream_OpenFile(szListFile, STREAM_FLAG_READ_ONLY);
 if(pStream != NULL)
 {
 // Retrieve the size of the external listfile
 FileStream_GetSize(pStream, &FileSize);
 if(0 < FileSize && FileSize <= 0x30000000)
 {
 // Create the in-memory cache for the entire listfile
 // The listfile does not have any data loaded yet
 pCache = CreateListFileCache((DWORD)FileSize);
 if(pCache != NULL)
 {
 if(!FileStream_Read(pStream, NULL, pCache->pBegin, (DWORD)FileSize))
 {
 ListFile_Free(pCache);
 pCache = NULL;
 }
 }
 }

 // Close the file stream
 FileStream_Close(pStream);
 }

 return pCache;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool ListFile_VerifyMD5	(	void *	pvListFile,
		LPBYTE	pbHashMD5
	)

{
 PLISTFILE_CACHE pCache = (PLISTFILE_CACHE)pvListFile;

 // Must be at the beginning
 assert(pCache->pPos == pCache->pBegin);

 // Verify the MD5 hash for the entire block
 return VerifyDataBlockHash(pCache->pBegin, (DWORD)(pCache->pEnd - pCache->pBegin), pbHashMD5);
}

Here is the call graph for this function:

Here is the caller graph for this function:

static PLISTFILE_MAP ListMap_Create ( )

static

{
 PLISTFILE_MAP pListMap;
 size_t cbToAllocate;

 // Create buffer for the listfile
 // Note that because the listfile is quite big and CASC_REALLOC
 // is a costly operation, we want to have as few reallocs as possible.
 cbToAllocate = sizeof(LISTFILE_MAP) + LISTMAP_INITIAL;
 pListMap = (PLISTFILE_MAP)CASC_ALLOC(BYTE, cbToAllocate);
 if(pListMap != NULL)
 {
 // Fill the listfile buffer
 memset(pListMap, 0, sizeof(LISTFILE_MAP));
 pListMap->cbBufferMax = LISTMAP_INITIAL;
 }

 return pListMap;
}

Here is the caller graph for this function:

static PLISTFILE_MAP ListMap_Finish ( PLISTFILE_MAP  pListMap )

static

{
 PLISTFILE_ENTRY pListEntry;
 PCASC_MAP pMap;
 LPBYTE pbEntry;

 // Sanity check
 assert(pListMap->pNameMap == NULL);

 // Create the map
 pListMap->pNameMap = pMap = Map_Create((DWORD)pListMap->nEntries, sizeof(ULONGLONG), 0);
 if(pListMap->pNameMap == NULL)
 {
 ListFile_FreeMap(pListMap);
 return NULL;
 }

 // Fill the map
 pbEntry = (LPBYTE)(pListMap + 1);
 for(size_t i = 0; i < pListMap->nEntries; i++)
 {
 // Get the listfile entry
 pListEntry = (PLISTFILE_ENTRY)pbEntry;
 pbEntry += pListEntry->cbEntrySize;

 // Insert the entry to the map
 Map_InsertObject(pMap, pListEntry, &pListEntry->FileNameHash);
 }

 return pListMap;
}

Here is the call graph for this function:

Here is the caller graph for this function:

static PLISTFILE_MAP ListMap_InsertName ( PLISTFILE_MAP  pListMap, const char *  szFileName, size_t  nLength  )

static

{
 PLISTFILE_ENTRY pListEntry;
 size_t cbToAllocate;
 size_t cbEntrySize;

 // Make sure there is enough space in the list map
 cbEntrySize = sizeof(LISTFILE_ENTRY) + nLength;
 cbEntrySize = ALIGN_TO_SIZE(cbEntrySize, 8);
 if((pListMap->cbBuffer + cbEntrySize) > pListMap->cbBufferMax)
 {
 cbToAllocate = sizeof(LISTFILE_MAP) + (pListMap->cbBufferMax * 3) / 2;
 pListMap = (PLISTFILE_MAP)CASC_REALLOC(BYTE, pListMap, cbToAllocate);
 if(pListMap == NULL)
 return NULL;

 pListMap->cbBufferMax = (pListMap->cbBufferMax * 3) / 2;
 }

 // Get the pointer to the first entry
 pListEntry = (PLISTFILE_ENTRY)((LPBYTE)(pListMap + 1) + pListMap->cbBuffer);
 pListEntry->FileNameHash = CalcFileNameHash(szFileName);
 pListEntry->cbEntrySize = (DWORD)cbEntrySize;

 // Copy the file name to the entry
 memcpy(pListEntry->szFileName, szFileName, nLength);
 pListEntry->szFileName[nLength] = 0;

 // Move the next entry
 pListMap->cbBuffer += cbEntrySize;
 pListMap->nEntries++;
 return pListMap;
}

Here is the call graph for this function:

Here is the caller graph for this function: