134 lines
4.4 KiB
C
134 lines
4.4 KiB
C
/*
|
|
* FrameResources.h
|
|
*
|
|
* Resource file processing functions
|
|
*/
|
|
|
|
#ifndef _resource_h
|
|
#define _resource_h
|
|
|
|
/* Maximum number of characters in a resource type */
|
|
#define RESTYPE_MAXCHAR 20
|
|
|
|
/* Maximum number of characters in a resource ID */
|
|
#define RESID_MAXCHAR 40
|
|
|
|
/* Function pointer for a function that loads from a memory buffer */
|
|
typedef BOOL (*RES_BUFFERLOAD)(UBYTE *pBuffer, UDWORD size, void **pData);
|
|
/* Function pointer for a function that loads from a filename */
|
|
typedef BOOL (*RES_FILELOAD)(STRING *pFile, void **pData);
|
|
|
|
/* Function pointer for releasing a resource loaded by the above functions */
|
|
typedef void (*RES_FREE)(void *pData);
|
|
|
|
/* callback type for resload display callback*/
|
|
typedef void (*RESLOAD_CALLBACK)(void);
|
|
|
|
|
|
typedef struct res_data
|
|
{
|
|
STRING aID[RESID_MAXCHAR]; // ID of the resource - filename from the .wrf - e.g. "TRON.PIE"
|
|
void *pData; // pointer to the acutal data
|
|
SDWORD blockID; // which of the blocks is it in (so we can clear some of them...)
|
|
|
|
UDWORD HashedID; // hashed version of the name of the id
|
|
struct res_data *psNext; // next entry - most likely to be following on!
|
|
UDWORD usage;
|
|
} RES_DATA;
|
|
|
|
|
|
// New reduced resource type ... specially for PSX
|
|
// These types are statically defined in data.c
|
|
typedef struct _res_type
|
|
{
|
|
// type is still needed on psx ... strings are defined in source - data.c (yak!)
|
|
STRING aType[RESTYPE_MAXCHAR]; // type string (e.g. "PIE" - just for debug use only, only aplicable when loading from wrf (not wdg)
|
|
|
|
RES_BUFFERLOAD buffLoad; // routine to process the data for this type
|
|
RES_FREE release; // routine to release the data (NULL indicates none)
|
|
|
|
// we must have a pointer to the data here so that we can do a resGetData();
|
|
RES_DATA *psRes; // Linked list of data items of this type
|
|
UDWORD HashedType; // hashed version of the name of the id - // a null hashedtype indicates end of list
|
|
|
|
RES_FILELOAD fileLoad; // This isn't really used any more ?
|
|
struct _res_type *psNext;
|
|
} RES_TYPE;
|
|
|
|
|
|
/* set the function to call when loading files with resloadfile*/
|
|
extern VOID resSetLoadCallback(RESLOAD_CALLBACK funcToCall);
|
|
|
|
|
|
/* callback type for res pre-load callback*/
|
|
typedef BOOL (*RESPRELOAD_CALLBACK)(char *type, char *name, char *directory);
|
|
|
|
/* set the function to call when loading files with resloadfile*/
|
|
extern VOID resSetPreLoadCallback(RESPRELOAD_CALLBACK funcToCall);
|
|
|
|
|
|
|
|
/* Initialise the resource module */
|
|
extern BOOL resInitialise(void);
|
|
|
|
/* Shutdown the resource module */
|
|
extern void resShutDown(void);
|
|
|
|
// set the base resource directory
|
|
extern void resSetBaseDir(STRING *pResDir);
|
|
|
|
/* Parse the res file */
|
|
struct _block_heap;
|
|
BOOL resLoad(STRING *pResFile, SDWORD blockID,
|
|
UBYTE *pLoadBuffer, SDWORD bufferSize,
|
|
struct _block_heap *psMemHeap);
|
|
|
|
/* Release all the resources currently loaded and the resource load functions */
|
|
extern void resReleaseAll(void);
|
|
|
|
// release the data for a particular block ID
|
|
extern void resReleaseBlockData(SDWORD blockID);
|
|
|
|
/* Release all the resources currently loaded but keep the resource load functions */
|
|
extern void resReleaseAllData(void);
|
|
|
|
/* Add a buffer load and release function for a file type */
|
|
extern BOOL resAddBufferLoad(STRING *pType, RES_BUFFERLOAD buffLoad,
|
|
RES_FREE release);
|
|
|
|
/* Add a file name load and release function for a file type */
|
|
extern BOOL resAddFileLoad(STRING *pType, RES_FILELOAD fileLoad,
|
|
RES_FREE release);
|
|
|
|
/* Call the load function for a file */
|
|
extern BOOL resLoadFile(STRING *pType, STRING *pFile);
|
|
|
|
// Add data to the resource system
|
|
extern BOOL resAddData(STRING *pType, STRING *pID, void *pData);
|
|
|
|
/* Return the resource for a type and ID */
|
|
extern void *resGetDataFromHash(STRING *pType, UDWORD HashedID);
|
|
extern void *resGetData(STRING *pType, STRING *pID);
|
|
extern BOOL resPresent(STRING *pType, STRING *pID);
|
|
void resToLower(STRING *pStr);
|
|
|
|
// return the HashedID string for a piece of data
|
|
extern BOOL resGetHashfromData(STRING *pType, void *pData, UDWORD *pHash);
|
|
|
|
VOID resDoResLoadCallback();
|
|
|
|
//return last imd resource
|
|
char *GetLastResourceFilename(void);
|
|
// Set the resource name of the last resource file loaded
|
|
void SetLastResourceFilename(char *pName);
|
|
|
|
// Returns the filename of the last resource file loaded
|
|
UDWORD GetLastHashName(void);
|
|
// Set the resource name of the last resource file loaded
|
|
void SetLastHashName(UDWORD HashName);
|
|
|
|
void SetLastResourceHash(char *fname);
|
|
|
|
#endif
|
|
|