orxStructure.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008- 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 _orxSTRUCTURE_H_
#define _orxSTRUCTURE_H_
 
#include "orxInclude.h"
 
#include "core/orxClock.h"
#include "memory/orxMemory.h"
#include "utils/orxLinkList.h"
#include "utils/orxTree.h"
 

#define orxSTRUCTURE_GET_POINTER(STRUCTURE, TYPE) ((orx##TYPE *)_orxStructure_GetPointer(STRUCTURE, orxSTRUCTURE_ID_##TYPE))
 
#define orxSTRUCTURE(STRUCTURE)     ((((STRUCTURE) != orxNULL) && (((((orxSTRUCTURE *)STRUCTURE)->u64GUID & orxSTRUCTURE_GUID_MASK_STRUCTURE_ID) >> orxSTRUCTURE_GUID_SHIFT_STRUCTURE_ID) < orxSTRUCTURE_ID_NUMBER)) ? (orxSTRUCTURE *)(STRUCTURE) : (orxSTRUCTURE *)orxNULL)
 
#define orxANIM(STRUCTURE)          orxSTRUCTURE_GET_POINTER(STRUCTURE, ANIM)
#define orxANIMPOINTER(STRUCTURE)   orxSTRUCTURE_GET_POINTER(STRUCTURE, ANIMPOINTER)
#define orxANIMSET(STRUCTURE)       orxSTRUCTURE_GET_POINTER(STRUCTURE, ANIMSET)
#define orxBODY(STRUCTURE)          orxSTRUCTURE_GET_POINTER(STRUCTURE, BODY)
#define orxCAMERA(STRUCTURE)        orxSTRUCTURE_GET_POINTER(STRUCTURE, CAMERA)
#define orxCLOCK(STRUCTURE)         orxSTRUCTURE_GET_POINTER(STRUCTURE, CLOCK)
#define orxFONT(STRUCTURE)          orxSTRUCTURE_GET_POINTER(STRUCTURE, FONT)
#define orxFRAME(STRUCTURE)         orxSTRUCTURE_GET_POINTER(STRUCTURE, FRAME)
#define orxFX(STRUCTURE)            orxSTRUCTURE_GET_POINTER(STRUCTURE, FX)
#define orxFXPOINTER(STRUCTURE)     orxSTRUCTURE_GET_POINTER(STRUCTURE, FXPOINTER)
#define orxGRAPHIC(STRUCTURE)       orxSTRUCTURE_GET_POINTER(STRUCTURE, GRAPHIC)
#define orxOBJECT(STRUCTURE)        orxSTRUCTURE_GET_POINTER(STRUCTURE, OBJECT)
#define orxSOUND(STRUCTURE)         orxSTRUCTURE_GET_POINTER(STRUCTURE, SOUND)
#define orxSOUNDPOINTER(STRUCTURE)  orxSTRUCTURE_GET_POINTER(STRUCTURE, SOUNDPOINTER)
#define orxSHADER(STRUCTURE)        orxSTRUCTURE_GET_POINTER(STRUCTURE, SHADER)
#define orxSPAWNER(STRUCTURE)       orxSTRUCTURE_GET_POINTER(STRUCTURE, SPAWNER)
#define orxTEXT(STRUCTURE)          orxSTRUCTURE_GET_POINTER(STRUCTURE, TEXT)
#define orxTEXTURE(STRUCTURE)       orxSTRUCTURE_GET_POINTER(STRUCTURE, TEXTURE)
#define orxTIMELINE(STRUCTURE)      orxSTRUCTURE_GET_POINTER(STRUCTURE, TIMELINE)
#define orxTRIGGER(STRUCTURE)       orxSTRUCTURE_GET_POINTER(STRUCTURE, TRIGGER)
#define orxVIEWPORT(STRUCTURE)      orxSTRUCTURE_GET_POINTER(STRUCTURE, VIEWPORT)

#define orxSTRUCTURE_REGISTER(TYPE, STORAGE_TYPE, MEMORY_TYPE, BANK_SIZE, UPDATE_FUNCTION) \
  orxStructure_Register(orxSTRUCTURE_ID_##TYPE, STORAGE_TYPE, MEMORY_TYPE, sizeof(orx##TYPE), BANK_SIZE, UPDATE_FUNCTION)

#define orxSTRUCTURE_ASSERT(STRUCTURE) \
  orxASSERT((STRUCTURE != orxNULL) && (((((orxSTRUCTURE *)(STRUCTURE))->u64GUID & orxSTRUCTURE_GUID_MASK_STRUCTURE_ID) >> orxSTRUCTURE_GUID_SHIFT_STRUCTURE_ID) < orxSTRUCTURE_ID_NUMBER));

#define orxSTRUCTURE_GUID_MAGIC_TAG_DELETED   0xDEFACED0DEADC0DEULL

#define orxSTRUCTURE_GUID_MASK_STRUCTURE_ID   0x00000000000000FFULL
#define orxSTRUCTURE_GUID_SHIFT_STRUCTURE_ID  0
 
#define orxSTRUCTURE_GUID_MASK_ITEM_ID        0x00000000FFFFFF00ULL
#define orxSTRUCTURE_GUID_SHIFT_ITEM_ID       8
 
#define orxSTRUCTURE_GUID_MASK_INSTANCE_ID    0xFFFFFFFF00000000ULL
#define orxSTRUCTURE_GUID_SHIFT_INSTANCE_ID   32
 

typedef enum __orxSTRUCTURE_ID_t
{
  /* *** Following structures can be linked to objects *** */
 
  orxSTRUCTURE_ID_ANIMPOINTER = 0,
  orxSTRUCTURE_ID_BODY,
  orxSTRUCTURE_ID_CLOCK,
  orxSTRUCTURE_ID_FRAME,
  orxSTRUCTURE_ID_FXPOINTER,
  orxSTRUCTURE_ID_GRAPHIC,
  orxSTRUCTURE_ID_SHADER,
  orxSTRUCTURE_ID_SOUNDPOINTER,
  orxSTRUCTURE_ID_SPAWNER,
  orxSTRUCTURE_ID_TIMELINE,
  orxSTRUCTURE_ID_TRIGGER,
 
  orxSTRUCTURE_ID_LINKABLE_NUMBER,
 
  /* *** Below this point, structures can not be linked to objects *** */
 
  orxSTRUCTURE_ID_ANIM = orxSTRUCTURE_ID_LINKABLE_NUMBER,
  orxSTRUCTURE_ID_ANIMSET,
  orxSTRUCTURE_ID_CAMERA,
  orxSTRUCTURE_ID_FONT,
  orxSTRUCTURE_ID_FX,
  orxSTRUCTURE_ID_OBJECT,
  orxSTRUCTURE_ID_SOUND,
  orxSTRUCTURE_ID_TEXT,
  orxSTRUCTURE_ID_TEXTURE,
  orxSTRUCTURE_ID_VIEWPORT,
 
  orxSTRUCTURE_ID_NUMBER,
 
  orxSTRUCTURE_ID_NONE = orxENUM_NONE
 
} orxSTRUCTURE_ID;

typedef enum __orxSTRUCTURE_STORAGE_TYPE_t
{
  orxSTRUCTURE_STORAGE_TYPE_LINKLIST = 0,
  orxSTRUCTURE_STORAGE_TYPE_TREE,
 
  orxSTRUCTURE_STORAGE_TYPE_NUMBER,
 
  orxSTRUCTURE_STORAGE_TYPE_NONE = orxENUM_NONE,
 
} orxSTRUCTURE_STORAGE_TYPE;

typedef struct __orxSTRUCTURE_t
{
  orxU64              u64GUID;        
  orxU64              u64OwnerGUID;   
  orxU32              u32Flags;       
  orxU32              u32RefCount;    
 
  union
  {
    orxLINKLIST_NODE  stLinkListNode; 
    orxTREE_NODE      stTreeNode;     
  } stStorage;                        
 
} orxSTRUCTURE;
 

typedef orxSTATUS (orxFASTCALL *orxSTRUCTURE_UPDATE_FUNCTION)(orxSTRUCTURE *_pstStructure, const orxSTRUCTURE *_pstCaller, const orxCLOCK_INFO *_pstClockInfo);
 

static orxINLINE orxSTRUCTURE *_orxStructure_GetPointer(const void *_pStructure, orxSTRUCTURE_ID _eStructureID)
{
  orxSTRUCTURE *pstResult;
 
  /* Updates result */
  pstResult = ((_pStructure != orxNULL) && ((((orxSTRUCTURE *)_pStructure)->u64GUID & orxSTRUCTURE_GUID_MASK_STRUCTURE_ID) >> orxSTRUCTURE_GUID_SHIFT_STRUCTURE_ID) == _eStructureID) ? (orxSTRUCTURE *)_pStructure : (orxSTRUCTURE *)orxNULL;
 
  /* Done! */
  return pstResult;
}

static orxINLINE const orxSTRING orxStructure_GetIDString(orxSTRUCTURE_ID _eID)
{
  const orxSTRING zResult;
 
#define orxSTRUCTURE_DECLARE_ID_ENTRY(ID)    case orxSTRUCTURE_ID_##ID: zResult = #ID; break
 
  /* Depending on ID */
  switch(_eID)
  {
    orxSTRUCTURE_DECLARE_ID_ENTRY(ANIMPOINTER);
    orxSTRUCTURE_DECLARE_ID_ENTRY(BODY);
    orxSTRUCTURE_DECLARE_ID_ENTRY(CLOCK);
    orxSTRUCTURE_DECLARE_ID_ENTRY(FRAME);
    orxSTRUCTURE_DECLARE_ID_ENTRY(FXPOINTER);
    orxSTRUCTURE_DECLARE_ID_ENTRY(GRAPHIC);
    orxSTRUCTURE_DECLARE_ID_ENTRY(SHADER);
    orxSTRUCTURE_DECLARE_ID_ENTRY(SOUNDPOINTER);
    orxSTRUCTURE_DECLARE_ID_ENTRY(SPAWNER);
    orxSTRUCTURE_DECLARE_ID_ENTRY(TIMELINE);
    orxSTRUCTURE_DECLARE_ID_ENTRY(TRIGGER);
    orxSTRUCTURE_DECLARE_ID_ENTRY(ANIM);
    orxSTRUCTURE_DECLARE_ID_ENTRY(ANIMSET);
    orxSTRUCTURE_DECLARE_ID_ENTRY(CAMERA);
    orxSTRUCTURE_DECLARE_ID_ENTRY(FONT);
    orxSTRUCTURE_DECLARE_ID_ENTRY(FX);
    orxSTRUCTURE_DECLARE_ID_ENTRY(OBJECT);
    orxSTRUCTURE_DECLARE_ID_ENTRY(SOUND);
    orxSTRUCTURE_DECLARE_ID_ENTRY(TEXT);
    orxSTRUCTURE_DECLARE_ID_ENTRY(TEXTURE);
    orxSTRUCTURE_DECLARE_ID_ENTRY(VIEWPORT);
 
    default: zResult = "INVALID STRUCTURE ID"; break;
  }
 
#undef orxSTRUCTURE_DECLARE_ID_ENTRY
 
  /* Done! */
  return zResult;
}
 

extern orxDLLAPI void orxFASTCALL                       orxStructure_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_Init();

extern orxDLLAPI void orxFASTCALL                       orxStructure_Exit();
 

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_Register(orxSTRUCTURE_ID _eStructureID, orxSTRUCTURE_STORAGE_TYPE _eStorageType, orxMEMORY_TYPE _eMemoryType, orxU32 _u32Size, orxU32 _u32BankSize, const orxSTRUCTURE_UPDATE_FUNCTION _pfnUpdate);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_Unregister(orxSTRUCTURE_ID _eStructureID);
 

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_Create(orxSTRUCTURE_ID _eStructureID);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_Delete(void *_pStructure);
 

extern orxDLLAPI orxSTRUCTURE_STORAGE_TYPE orxFASTCALL  orxStructure_GetStorageType(orxSTRUCTURE_ID _eStructureID);

extern orxDLLAPI orxU32 orxFASTCALL                     orxStructure_GetCount(orxSTRUCTURE_ID _eStructureID);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_Update(void *_pStructure, const void *_phCaller, const orxCLOCK_INFO *_pstClockInfo);
 

 

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_Get(orxU64 _u64GUID);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetOwner(const void *_pStructure);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_SetOwner(void *_pStructure, void *_pOwner);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetFirst(orxSTRUCTURE_ID _eStructureID);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetLast(orxSTRUCTURE_ID _eStructureID);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetParent(const void *_pStructure);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetChild(const void *_pStructure);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetSibling(const void *_pStructure);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetPrevious(const void *_pStructure);

extern orxDLLAPI orxSTRUCTURE *orxFASTCALL              orxStructure_GetNext(const void *_pStructure);

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_SetParent(void *_pStructure, void *_phParent);
 

extern orxDLLAPI orxSTATUS orxFASTCALL                  orxStructure_LogAll(orxBOOL _bPrivate);
 

 

static orxINLINE void                                   orxStructure_IncreaseCount(void *_pStructure)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
  orxASSERT(orxSTRUCTURE(_pStructure)->u32RefCount < 0xFFFFFFFF);
 
  /* Increases ref count */
  orxSTRUCTURE(_pStructure)->u32RefCount++;
 
  /* Done! */
  return;
}

static orxINLINE void                                   orxStructure_DecreaseCount(void *_pStructure)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
  orxASSERT(orxSTRUCTURE(_pStructure)->u32RefCount != 0);
 
  /* Decreases ref count */
  orxSTRUCTURE(_pStructure)->u32RefCount--;
 
  /* Done! */
  return;
}

static orxINLINE orxU32                                 orxStructure_GetRefCount(const void *_pStructure)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
 
  /* Done! */
  return orxSTRUCTURE(_pStructure)->u32RefCount;
}

static orxINLINE orxU64                                 orxStructure_GetGUID(const void *_pStructure)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
 
  /* Done! */
  return orxSTRUCTURE(_pStructure)->u64GUID;
}

static orxINLINE orxSTRUCTURE_ID                        orxStructure_GetID(const void *_pStructure)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
 
  /* Done! */
  return((orxSTRUCTURE_ID)((orxSTRUCTURE(_pStructure)->u64GUID & orxSTRUCTURE_GUID_MASK_STRUCTURE_ID) >> orxSTRUCTURE_GUID_SHIFT_STRUCTURE_ID));
}

static orxINLINE orxBOOL                                orxStructure_TestFlags(const void *_pStructure, orxU32 _u32Flags)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
 
  /* Done! */
  return(orxFLAG_TEST(orxSTRUCTURE(_pStructure)->u32Flags, _u32Flags));
}

static orxINLINE orxBOOL                                orxStructure_TestAllFlags(const void *_pStructure, orxU32 _u32Flags)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
 
  /* Done! */
  return(orxFLAG_TEST_ALL(orxSTRUCTURE(_pStructure)->u32Flags, _u32Flags));
}

static orxINLINE orxU32                                 orxStructure_GetFlags(const void *_pStructure, orxU32 _u32Mask)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
 
  /* Done! */
  return(orxFLAG_GET(orxSTRUCTURE(_pStructure)->u32Flags, _u32Mask));
}

static orxINLINE void                                   orxStructure_SetFlags(void *_pStructure, orxU32 _u32AddFlags, orxU32 _u32RemoveFlags)
{
  /* Checks */
  orxSTRUCTURE_ASSERT(_pStructure);
 
  orxFLAG_SET(orxSTRUCTURE(_pStructure)->u32Flags, _u32AddFlags, _u32RemoveFlags);
 
  /* Done! */
  return;
}
 
#endif /* _orxSTRUCTURE_H_ */