orxCommand.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 _orxCOMMAND_H_
#define _orxCOMMAND_H_


#include "orxInclude.h"
#include "math/orxVector.h"


#define orxCOMMAND_KC_BLOCK_MARKER                    '"'                             
#define orxCOMMAND_KC_PUSH_MARKER                     '>'                             
#define orxCOMMAND_KC_POP_MARKER                      '<'                             
#define orxCOMMAND_KC_GUID_MARKER                     '^'                             
#define orxCOMMAND_KC_SEPARATOR                       ','                             
typedef enum __orxCOMMAND_VAR_TYPE_t
{
  orxCOMMAND_VAR_TYPE_STRING = 0,
  orxCOMMAND_VAR_TYPE_FLOAT,
  orxCOMMAND_VAR_TYPE_S32,
  orxCOMMAND_VAR_TYPE_U32,
  orxCOMMAND_VAR_TYPE_S64,
  orxCOMMAND_VAR_TYPE_U64,
  orxCOMMAND_VAR_TYPE_BOOL,
  orxCOMMAND_VAR_TYPE_VECTOR,
  orxCOMMAND_VAR_TYPE_NUMERIC,

  orxCOMMAND_VAR_TYPE_NUMBER,

  orxCOMMAND_VAR_TYPE_NONE = orxENUM_NONE

} orxCOMMAND_VAR_TYPE;


typedef struct __orxCOMMAND_VAR_DEF_t
{
  const orxSTRING       zName;                        
  orxCOMMAND_VAR_TYPE   eType;                        
} orxCOMMAND_VAR_DEF;

typedef struct __orxCOMMAND_VAR_t
{
  union
  {
    orxVECTOR           vValue;                       
    const orxSTRING     zValue;                       
    orxU32              u32Value;                     
    orxS32              s32Value;                     
    orxU64              u64Value;                     
    orxS64              s64Value;                     
    orxFLOAT            fValue;                       
    orxBOOL             bValue;                       
  };

  orxCOMMAND_VAR_TYPE   eType;                        
} orxCOMMAND_VAR;

typedef void (orxFASTCALL *orxCOMMAND_FUNCTION)(orxU32 _u32ArgNumber, const orxCOMMAND_VAR *_astArgList, orxCOMMAND_VAR *_pstResult);


#define orxCOMMAND_REGISTER_CORE_COMMAND(MODULE, COMMAND, RESULT_NAME, RESULT_TYPE, REQ_PARAM_NUMBER, OPT_PARAM_NUMBER, ...)                                    \
do                                                                                                                                                              \
{                                                                                                                                                               \
  orxCOMMAND_VAR_DEF  stResult;                                                                                                                                 \
  orxCOMMAND_VAR_DEF  astParamList[REQ_PARAM_NUMBER + OPT_PARAM_NUMBER + 1] = {{"Dummy", orxCOMMAND_VAR_TYPE_NONE}, __VA_ARGS__};                               \
  orxSTATUS           eStatus;                                                                                                                                  \
  stResult.eType    = RESULT_TYPE;                                                                                                                              \
  stResult.zName    = RESULT_NAME;                                                                                                                              \
  eStatus           = orxCommand_Register(#MODULE"."#COMMAND, &orx##MODULE##_Command##COMMAND, REQ_PARAM_NUMBER, OPT_PARAM_NUMBER, &astParamList[1], &stResult);\
  orxASSERT(eStatus != orxSTATUS_FAILURE);                                                                                                                      \
} while(orxFALSE)

#define orxCOMMAND_UNREGISTER_CORE_COMMAND(MODULE, COMMAND)                                                                                                     \
do                                                                                                                                                              \
{                                                                                                                                                               \
  orxCommand_Unregister(#MODULE"."#COMMAND);                                                                                                                    \
} while(orxFALSE)

#define orxCOMMAND_REGISTER(NAME, FUNCTION, RESULT_NAME, RESULT_TYPE, REQ_PARAM_NUMBER, OPT_PARAM_NUMBER, ...)                                                  \
do                                                                                                                                                              \
{                                                                                                                                                               \
  orxCOMMAND_VAR_DEF  stResult;                                                                                                                                 \
  orxCOMMAND_VAR_DEF  astParamList[REQ_PARAM_NUMBER + OPT_PARAM_NUMBER + 1] = {{"Dummy", orxCOMMAND_VAR_TYPE_NONE}, __VA_ARGS__};                               \
  orxSTATUS           eStatus;                                                                                                                                  \
  stResult.eType    = RESULT_TYPE;                                                                                                                              \
  stResult.zName    = RESULT_NAME;                                                                                                                              \
  eStatus           = orxCommand_Register(NAME, &FUNCTION, REQ_PARAM_NUMBER, OPT_PARAM_NUMBER, &astParamList[1], &stResult);                                    \
  orxASSERT(eStatus != orxSTATUS_FAILURE);                                                                                                                      \
} while(orxFALSE)

#define orxCOMMAND_UNREGISTER(NAME)                                                                                                                             \
do                                                                                                                                                              \
{                                                                                                                                                               \
  orxCommand_Unregister(NAME);                                                                                                                                  \
} while(orxFALSE)


extern orxDLLAPI void orxFASTCALL                     orxCommand_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                orxCommand_Init();

extern orxDLLAPI void orxFASTCALL                     orxCommand_Exit();


extern orxDLLAPI orxSTATUS orxFASTCALL                orxCommand_Register(const orxSTRING _zCommand, const orxCOMMAND_FUNCTION _pfnFunction, orxU32 _u32RequiredParamNumber, orxU32 _u32OptionalParamNumber, const orxCOMMAND_VAR_DEF *_astParamList, const orxCOMMAND_VAR_DEF *_pstResult);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxCommand_Unregister(const orxSTRING _zCommand);

extern orxDLLAPI orxBOOL orxFASTCALL                  orxCommand_IsRegistered(const orxSTRING _zCommand);


extern orxDLLAPI orxSTATUS orxFASTCALL                orxCommand_AddAlias(const orxSTRING _zAlias, const orxSTRING _zCommand, const orxSTRING _zArgs);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxCommand_RemoveAlias(const orxSTRING _zAlias);

extern orxDLLAPI orxBOOL orxFASTCALL                  orxCommand_IsAlias(const orxSTRING _zAlias);


extern orxDLLAPI const orxSTRING orxFASTCALL          orxCommand_GetPrototype(const orxSTRING _zCommand);

extern orxDLLAPI const orxSTRING orxFASTCALL          orxCommand_GetNext(const orxSTRING _zBase, const orxSTRING _zPrevious, orxU32 *_pu32CommonLength);


extern orxDLLAPI orxCOMMAND_VAR *orxFASTCALL          orxCommand_Evaluate(const orxSTRING _zCommandLine, orxCOMMAND_VAR *_pstResult);

extern orxDLLAPI orxCOMMAND_VAR *orxFASTCALL          orxCommand_EvaluateWithGUID(const orxSTRING _zCommandLine, orxU64 _u64GUID, orxCOMMAND_VAR *_pstResult);

extern orxDLLAPI orxCOMMAND_VAR *orxFASTCALL          orxCommand_Execute(const orxSTRING _zCommand, orxU32 _u32ArgNumber, const orxCOMMAND_VAR *_astArgList, orxCOMMAND_VAR *_pstResult);


extern orxDLLAPI orxSTATUS orxFASTCALL                orxCommand_ParseNumericalArguments(orxU32 _u32ArgNumber, const orxCOMMAND_VAR *_astArgList, orxCOMMAND_VAR *_astOperandList);

extern orxDLLAPI orxU32 orxFASTCALL                   orxCommand_PrintVar(orxSTRING _zDstString, orxU32 _u32Size, const orxCOMMAND_VAR *_pstVar);


#endif /* _orxCOMMAND_H_ */