RootHandler.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	TRootHandler

Macros
#define	CASC_MNDX_ROOT_SIGNATURE   0x58444E4D
#define	CASC_DIABLO3_ROOT_SIGNATURE   0x8007D0C4
#define	CASC_OVERWATCH_ROOT_SIGNATURE   0x35444D23
#define	ROOT_FLAG_HAS_NAMES   0x00000001
#define	DUMP_LEVEL_ROOT_FILE   1
#define	DUMP_LEVEL_ENCODING_FILE   2
#define	DUMP_LEVEL_INDEX_ENTRIES   3

Typedefs
typedef int(*	ROOT_INSERT )(struct TRootHandler *pRootHandler, const char *szFileName, LPBYTE pbEncodingKey)
typedef LPBYTE(*	ROOT_SEARCH )(struct TRootHandler *pRootHandler, struct _TCascSearch *pSearch, PDWORD PtrFileSize, PDWORD PtrLocaleFlags)
typedef void(*	ROOT_ENDSEARCH )(struct TRootHandler *pRootHandler, struct _TCascSearch *pSearch)
typedef LPBYTE(*	ROOT_GETKEY )(struct TRootHandler *pRootHandler, const char *szFileName)
typedef void(*	ROOT_DUMP )(struct _TCascStorage *hs, TDumpContext *dc, LPBYTE pbRootHandler, DWORD cbRootHandler, const TCHAR *szListFile, int nDumpLevel)
typedef void(*	ROOT_CLOSE )(struct TRootHandler *pRootHandler)

Functions
int	RootHandler_Insert (TRootHandler *pRootHandler, const char *szFileName, LPBYTE pbEncodingKey)
LPBYTE	RootHandler_Search (TRootHandler *pRootHandler, struct _TCascSearch *pSearch, PDWORD PtrFileSize, PDWORD PtrLocaleFlags)
void	RootHandler_EndSearch (TRootHandler *pRootHandler, struct _TCascSearch *pSearch)
LPBYTE	RootHandler_GetKey (TRootHandler *pRootHandler, const char *szFileName)
void	RootHandler_Dump (struct _TCascStorage *hs, LPBYTE pbRootHandler, DWORD cbRootHandler, const TCHAR *szNameFormat, const TCHAR *szListFile, int nDumpLevel)
void	RootHandler_Close (TRootHandler *pRootHandler)

Macro Definition Documentation

#define CASC_DIABLO3_ROOT_SIGNATURE   0x8007D0C4

#define CASC_MNDX_ROOT_SIGNATURE   0x58444E4D

#define CASC_OVERWATCH_ROOT_SIGNATURE   0x35444D23

#define DUMP_LEVEL_ENCODING_FILE   2

#define DUMP_LEVEL_INDEX_ENTRIES   3

#define DUMP_LEVEL_ROOT_FILE   1

#define ROOT_FLAG_HAS_NAMES   0x00000001

Typedef Documentation

typedef void(* ROOT_CLOSE)(struct TRootHandler *pRootHandler)

typedef void(* ROOT_DUMP)(struct _TCascStorage *hs,TDumpContext *dc,LPBYTE pbRootHandler,DWORD cbRootHandler,const TCHAR *szListFile, int nDumpLevel)

typedef void(* ROOT_ENDSEARCH)(struct TRootHandler *pRootHandler,struct _TCascSearch *pSearch)

typedef LPBYTE(* ROOT_GETKEY)(struct TRootHandler *pRootHandler,const char *szFileName)

typedef int(* ROOT_INSERT)(struct TRootHandler *pRootHandler,const char *szFileName,LPBYTE pbEncodingKey)

typedef LPBYTE(* ROOT_SEARCH)(struct TRootHandler *pRootHandler,struct _TCascSearch *pSearch,PDWORD PtrFileSize,PDWORD PtrLocaleFlags)

Function Documentation

void RootHandler_Close

(

TRootHandler *

pRootHandler

)

{
 // Check if the root structure is allocated at all
 if(pRootHandler != NULL)
 {
 pRootHandler->Close(pRootHandler);
 }
}

Here is the caller graph for this function:

void RootHandler_Dump	(	struct _TCascStorage *	hs,
		LPBYTE	pbRootHandler,
		DWORD	cbRootHandler,
		const TCHAR *	szNameFormat,
		const TCHAR *	szListFile,
		int	nDumpLevel
	)

{
 TDumpContext * dc;

 // Only if the ROOT provider suports the dump option
 if(hs->pRootHandler != NULL && hs->pRootHandler->Dump != NULL)
 {
 // Create the dump file
 dc = CreateDumpContext(hs, szNameFormat);
 if(dc != NULL)
 {
 // Dump the content and close the file
 hs->pRootHandler->Dump(hs, dc, pbRootHandler, cbRootHandler, szListFile, nDumpLevel);
 dump_close(dc);
 }
 }
}

Here is the call graph for this function:

void RootHandler_EndSearch	(	TRootHandler *	pRootHandler,
		struct _TCascSearch *	pSearch
	)

{
 // Check if the root structure is valid at all
 if(pRootHandler != NULL)
 {
 pRootHandler->EndSearch(pRootHandler, pSearch);
 }
}

Here is the caller graph for this function:

LPBYTE RootHandler_GetKey	(	TRootHandler *	pRootHandler,
		const char *	szFileName
	)

{
 // Check if the root structure is valid at all
 if(pRootHandler == NULL)
 return NULL;

 return pRootHandler->GetKey(pRootHandler, szFileName);
}

Here is the caller graph for this function:

int RootHandler_Insert	(	TRootHandler *	pRootHandler,
		const char *	szFileName,
		LPBYTE	pbEncodingKey
	)

{
 if(pRootHandler == NULL || pRootHandler->Insert == NULL)
 return ERROR_NOT_SUPPORTED;

 return pRootHandler->Insert(pRootHandler, szFileName, pbEncodingKey);
}

Here is the caller graph for this function:

LPBYTE RootHandler_Search	(	TRootHandler *	pRootHandler,
		struct _TCascSearch *	pSearch,
		PDWORD	PtrFileSize,
		PDWORD	PtrLocaleFlags
	)

{
 // Check if the root structure is valid at all
 if(pRootHandler == NULL)
 return NULL;

 return pRootHandler->Search(pRootHandler, pSearch, PtrFileSize, PtrLocaleFlags);
}

Here is the caller graph for this function: