orxPluginUser.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 _orxPLUGIN_USER_H_
#define _orxPLUGIN_USER_H_
 
 
#include "orxInclude.h"
 
#include "plugin/orxPluginType.h"
#include "plugin/define/orxPlugin_CoreDefine.h"
 
#include "memory/orxMemory.h"
#include "utils/orxString.h"
 
 
/*********************************************
 Constants
 *********************************************/

typedef orxSTATUS (orxFASTCALL *orxPLUGIN_ENTRY_POINT)(orxPLUGIN_ENTRY_MODE _eMode);
 
 
/* Defines a user plugin init entry function (that take an entry mode argument and return an orxSTATUS value) */
#define orxPLUGIN_DECLARE_INIT_ENTRY_POINT(ENTRY_FUNCTION)                                                                            \
extern orxIMPORT orxDLLEXPORT orxSTATUS orxPLUGIN_K_INIT_FUNCTION_NAME(orxS32 *_ps32Number, orxPLUGIN_USER_FUNCTION_INFO **_ppstInfo) \
{                                                                                                                                     \
  orxSTATUS eResult;                                                                                                                  \
                                                                                                                                      \
  /* Calls entry point function */                                                                                                    \
  eResult = ((orxPLUGIN_ENTRY_POINT)ENTRY_FUNCTION)(orxPLUGIN_ENTRY_MODE_INIT);                                                       \
                                                                                                                                      \
  /* Updates parameters */                                                                                                            \
  *_ps32Number  = 0;                                                                                                                  \
  *_ppstInfo    = orxNULL;                                                                                                            \
                                                                                                                                      \
  /* Done! */                                                                                                                         \
  return eResult;                                                                                                                     \
}
 
/* Defines a user plugin exit entry function (that take an entry mode argument and return an orxSTATUS value) */
#define orxPLUGIN_DECLARE_EXIT_ENTRY_POINT(ENTRY_FUNCTION)                                                                            \
extern orxIMPORT orxDLLEXPORT orxSTATUS orxPLUGIN_K_EXIT_FUNCTION_NAME()                                                              \
{                                                                                                                                     \
  /* Done! */                                                                                                                         \
  return ((orxPLUGIN_ENTRY_POINT)ENTRY_FUNCTION)(orxPLUGIN_ENTRY_MODE_EXIT);                                                          \
}
 
/* Defines a user plugin swap entry function (that take an entry mode argument and return an orxSTATUS value) */
#define orxPLUGIN_DECLARE_SWAP_ENTRY_POINT(ENTRY_FUNCTION)                                                                            \
extern orxIMPORT orxDLLEXPORT orxSTATUS orxPLUGIN_K_SWAP_FUNCTION_NAME(orxPLUGIN_ENTRY_MODE _eMode)                                   \
{                                                                                                                                     \
  /* Done! */                                                                                                                         \
  return ((orxPLUGIN_ENTRY_POINT)ENTRY_FUNCTION)(_eMode);                                                                                                      \
}
 
/* Defines a user plugin entry function (that take an entry mode argument and return an orxSTATUS value) */
#define orxPLUGIN_DECLARE_ENTRY_POINT(ENTRY_FUNCTION)                                                                                 \
orxPLUGIN_DECLARE_INIT_ENTRY_POINT(ENTRY_FUNCTION);                                                                                   \
orxPLUGIN_DECLARE_EXIT_ENTRY_POINT(ENTRY_FUNCTION);                                                                                   \
orxPLUGIN_DECLARE_SWAP_ENTRY_POINT(ENTRY_FUNCTION);
 
 
/*********************************************
 Structures
 *********************************************/
 
/* Macro for Structure Handling */
#define _orxPLUGIN_USER_FUNCTION_ADD_LOW_LEVEL(FUNCTION, FUNCTION_ID, NAME, ARGS) \
  if(u32UserPluginFunctionCount < u32UserPluginFunctionMaxNumber) \
  { \
    pstUserPluginFunctionInfo[u32UserPluginFunctionCount].pfnFunction   = (orxPLUGIN_FUNCTION) FUNCTION; \
    pstUserPluginFunctionInfo[u32UserPluginFunctionCount].eFunctionID   = FUNCTION_ID; \
    pstUserPluginFunctionInfo[u32UserPluginFunctionCount].zFunctionName = #NAME; \
    orxString_NCopy(pstUserPluginFunctionInfo[u32UserPluginFunctionCount].zFunctionArgs, ARGS, orxPLUGIN_KU32_FUNCTION_ARG_SIZE - 1); \
    pstUserPluginFunctionInfo[u32UserPluginFunctionCount].zFunctionArgs[orxPLUGIN_KU32_FUNCTION_ARG_SIZE - 1] = orxCHAR_NULL; \
    u32UserPluginFunctionCount++; \
  } \
  else \
  { \
    /* Logs message */ \
    orxDEBUG_PRINT(orxDEBUG_LEVEL_SYSTEM, "Maximum number of plugin functions reached."); \
  }
 
#define orxPLUGIN_USER_FUNCTION_START(STRUCTURE) \
{ \
  orxU32 u32UserPluginFunctionCount = 0; \
  orxU32 u32UserPluginFunctionMaxNumber = sizeof(STRUCTURE) / sizeof(orxPLUGIN_USER_FUNCTION_INFO); \
  orxPLUGIN_USER_FUNCTION_INFO *pstUserPluginFunctionInfo = STRUCTURE; \
  orxMemory_Zero(pstUserPluginFunctionInfo, u32UserPluginFunctionMaxNumber * sizeof(orxPLUGIN_USER_FUNCTION_INFO));
 
#define orxPLUGIN_USER_FUNCTION_ADD(FUNCTION, ARGS, PLUGIN_ID, FUNCTION_BASE_ID, NAME) \
  _orxPLUGIN_USER_FUNCTION_ADD_LOW_LEVEL(&FUNCTION, \
                                         orxPLUGIN_MAKE_FUNCTION_ID(PLUGIN_ID, FUNCTION_BASE_ID), \
                                         NAME, \
                                         ARGS)
 
#define orxPLUGIN_USER_FUNCTION_END(NUMBER_ADDRESS, STRUCTURE_ADDRESS) \
  *NUMBER_ADDRESS = u32UserPluginFunctionCount; \
  *STRUCTURE_ADDRESS = pstUserPluginFunctionInfo; \
}
 
#define orxPLUGIN_USER_CORE_FUNCTION_START(PLUGIN_SUFFIX) \
  static orxPLUGIN_USER_FUNCTION_INFO sau32##PLUGIN_SUFFIX##_Function[orxPLUGIN_FUNCTION_BASE_ID_##PLUGIN_SUFFIX##_NUMBER]; \
  extern orxIMPORT orxDLLEXPORT orxSTATUS orxPLUGIN_K_CORE_INIT_FUNCTION_NAME(PLUGIN_SUFFIX)(orxS32 *_ps32Number, orxPLUGIN_USER_FUNCTION_INFO **_ppstInfo) \
  { \
    orxSTATUS eResult = orxSTATUS_SUCCESS; \
    orxPLUGIN_USER_FUNCTION_START(sau32##PLUGIN_SUFFIX##_Function);
 
#define orxPLUGIN_USER_CORE_FUNCTION_ADD(FUNCTION, PLUGIN_SUFFIX, NAME_SUFFIX) \
  _orxPLUGIN_USER_FUNCTION_ADD_LOW_LEVEL(&FUNCTION, \
                                         orxPLUGIN_MAKE_CORE_FUNCTION_ID(orxPLUGIN_CORE_ID_##PLUGIN_SUFFIX, orxPLUGIN_FUNCTION_BASE_ID_##PLUGIN_SUFFIX##_##NAME_SUFFIX), \
                                         PLUGIN_SUFFIX##_##NAME_SUFFIX, \
                                         orxSTRING_EMPTY)
 
#define orxPLUGIN_USER_CORE_FUNCTION_END() \
  orxPLUGIN_USER_FUNCTION_END(_ps32Number, _ppstInfo); \
  return eResult; \
  }
 
#endif /* _orxPLUGIN_USER_H_ */