orxResource.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2022 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxRESOURCE_H_
#define _orxRESOURCE_H_


#include "orxInclude.h"


#define orxRESOURCE_KC_LOCATION_SEPARATOR                 ':'

#define orxRESOURCE_KZ_DEFAULT_STORAGE                    "."
#define orxRESOURCE_KZ_TYPE_TAG_FILE                      "file"


typedef void (orxFASTCALL *orxRESOURCE_OP_FUNCTION)(orxHANDLE _hResource, orxS64 _s64Size, void *_pBuffer, void *_pContext);


typedef const orxSTRING (orxFASTCALL *orxRESOURCE_FUNCTION_LOCATE)(const orxSTRING _zGroup, const orxSTRING _zStorage, const orxSTRING _zName, orxBOOL _bRequireExistence);
typedef orxS64          (orxFASTCALL *orxRESOURCE_FUNCTION_GET_TIME)(const orxSTRING _zLocation);
typedef orxHANDLE       (orxFASTCALL *orxRESOURCE_FUNCTION_OPEN)(const orxSTRING _zLocation, orxBOOL _bEraseMode);
typedef void            (orxFASTCALL *orxRESOURCE_FUNCTION_CLOSE)(orxHANDLE _hResource);
typedef orxS64          (orxFASTCALL *orxRESOURCE_FUNCTION_GET_SIZE)(orxHANDLE _hResource);
typedef orxS64          (orxFASTCALL *orxRESOURCE_FUNCTION_SEEK)(orxHANDLE _hResource, orxS64 _s64Offset, orxSEEK_OFFSET_WHENCE _eWhence);
typedef orxS64          (orxFASTCALL *orxRESOURCE_FUNCTION_TELL)(orxHANDLE _hResource);
typedef orxS64          (orxFASTCALL *orxRESOURCE_FUNCTION_READ)(orxHANDLE _hResource, orxS64 _s64Size, void *_pBuffer);
typedef orxS64          (orxFASTCALL *orxRESOURCE_FUNCTION_WRITE)(orxHANDLE _hResource, orxS64 _s64Size, const void *_pBuffer);
typedef orxSTATUS       (orxFASTCALL *orxRESOURCE_FUNCTION_DELETE)(const orxSTRING _zLocation);

typedef struct __orxRESOURCE_TYPE_INFO_t
{
  const orxSTRING               zTag;                     
  orxRESOURCE_FUNCTION_LOCATE   pfnLocate;                
  orxRESOURCE_FUNCTION_GET_TIME pfnGetTime;               
  orxRESOURCE_FUNCTION_OPEN     pfnOpen;                  
  orxRESOURCE_FUNCTION_CLOSE    pfnClose;                 
  orxRESOURCE_FUNCTION_GET_SIZE pfnGetSize;               
  orxRESOURCE_FUNCTION_SEEK     pfnSeek;                  
  orxRESOURCE_FUNCTION_TELL     pfnTell;                  
  orxRESOURCE_FUNCTION_READ     pfnRead;                  
  orxRESOURCE_FUNCTION_WRITE    pfnWrite;                 
  orxRESOURCE_FUNCTION_DELETE   pfnDelete;                
} orxRESOURCE_TYPE_INFO;

typedef enum __orxRESOURCE_EVENT_t
{
  orxRESOURCE_EVENT_UPDATE = 0,
  orxRESOURCE_EVENT_ADD,
  orxRESOURCE_EVENT_REMOVE,

  orxRESOURCE_EVENT_NUMBER,

  orxRESOURCE_EVENT_NONE = orxENUM_NONE

} orxRESOURCE_EVENT;

typedef struct __orxRESOURCE_EVENT_PAYLOAD_t
{
  orxS64                        s64Time;                  
  const orxSTRING               zLocation;                
  const orxRESOURCE_TYPE_INFO  *pstTypeInfo;              
  orxSTRINGID                   stGroupID;                
  orxSTRINGID                   stStorageID;              
  orxSTRINGID                   stNameID;                 
} orxRESOURCE_EVENT_PAYLOAD;


extern orxDLLAPI void orxFASTCALL                         orxResource_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_Init();

extern orxDLLAPI void orxFASTCALL                         orxResource_Exit();


extern orxDLLAPI orxU32 orxFASTCALL                       orxResource_GetGroupCount();

extern orxDLLAPI const orxSTRING orxFASTCALL              orxResource_GetGroup(orxU32 _u32Index);


extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_AddStorage(const orxSTRING _zGroup, const orxSTRING _zStorage, orxBOOL _bAddFirst);

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_RemoveStorage(const orxSTRING _zGroup, const orxSTRING _zStorage);

extern orxDLLAPI orxU32 orxFASTCALL                       orxResource_GetStorageCount(const orxSTRING _zGroup);

extern orxDLLAPI const orxSTRING orxFASTCALL              orxResource_GetStorage(const orxSTRING _zGroup, orxU32 _u32Index);

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_ReloadStorage();


extern orxDLLAPI const orxSTRING orxFASTCALL              orxResource_Locate(const orxSTRING _zGroup, const orxSTRING _zName);

extern orxDLLAPI const orxSTRING orxFASTCALL              orxResource_LocateInStorage(const orxSTRING _zGroup, const orxSTRING _zStorage, const orxSTRING _zName);

extern orxDLLAPI const orxSTRING orxFASTCALL              orxResource_GetPath(const orxSTRING _zLocation);

extern orxDLLAPI const orxRESOURCE_TYPE_INFO *orxFASTCALL orxResource_GetType(const orxSTRING _zLocation);


extern orxDLLAPI orxS64 orxFASTCALL                       orxResource_GetTime(const orxSTRING _zLocation);

extern orxDLLAPI orxHANDLE orxFASTCALL                    orxResource_Open(const orxSTRING _zLocation, orxBOOL _bEraseMode);

extern orxDLLAPI void orxFASTCALL                         orxResource_Close(orxHANDLE _hResource);

extern orxDLLAPI const orxSTRING orxFASTCALL              orxResource_GetLocation(orxHANDLE _hResource);

extern orxDLLAPI orxS64 orxFASTCALL                       orxResource_GetSize(orxHANDLE _hResource);

extern orxDLLAPI orxS64 orxFASTCALL                       orxResource_Seek(orxHANDLE _hResource, orxS64 _s64Offset, orxSEEK_OFFSET_WHENCE _eWhence);

extern orxDLLAPI orxS64 orxFASTCALL                       orxResource_Tell(orxHANDLE _hResource);

extern orxDLLAPI orxS64 orxFASTCALL                       orxResource_Read(orxHANDLE _hResource, orxS64 _s64Size, void *_pBuffer, orxRESOURCE_OP_FUNCTION _pfnCallback, void *_pContext);

extern orxDLLAPI orxS64 orxFASTCALL                       orxResource_Write(orxHANDLE _hResource, orxS64 _s64Size, const void *_pBuffer, orxRESOURCE_OP_FUNCTION _pfnCallback, void *_pContext);

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_Delete(const orxSTRING _zLocation);


extern orxDLLAPI orxU32 orxFASTCALL                       orxResource_GetPendingOpCount(const orxHANDLE _hResource);

extern orxDLLAPI orxU32 orxFASTCALL                       orxResource_GetTotalPendingOpCount();


extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_RegisterType(const orxRESOURCE_TYPE_INFO *_pstInfo);

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_UnregisterType(const orxSTRING _zTypeTag);

extern orxDLLAPI orxU32 orxFASTCALL                       orxResource_GetTypeCount();

extern orxDLLAPI const orxSTRING orxFASTCALL              orxResource_GetTypeTag(orxU32 _u32Index);


extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_Sync(const orxSTRING _zGroup);

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxResource_ClearCache(const orxSTRING _zGroup);

extern orxDLLAPI orxU32 orxFASTCALL                       orxResource_GetCacheCount(const orxSTRING _zGroup);

extern orxDLLAPI orxHANDLE orxFASTCALL                    orxResource_GetNextCachedLocation(const orxSTRING _zGroup, orxHANDLE _hIterator, const orxSTRING *_pzLocation, const orxSTRING *_pzStorage, const orxSTRING *_pzName);


#endif /* _orxRESOURCE_H_ */