302 lines
9.2 KiB
C
302 lines
9.2 KiB
C
/*
|
|
* Parse.h
|
|
*
|
|
* Definitions for the script parser
|
|
*/
|
|
#ifndef _parse_h
|
|
#define _parse_h
|
|
|
|
/* Maximum number of TEXT items in any one Yacc rule */
|
|
#define TEXT_BUFFERS 10
|
|
|
|
/* Definition for the chunks of code that are used within the compiler */
|
|
typedef struct _code_block
|
|
{
|
|
UDWORD size; // size of the code block
|
|
UDWORD *pCode; // pointer to the code data
|
|
UDWORD debugEntries;
|
|
SCRIPT_DEBUG *psDebug; // Debugging info for the script.
|
|
INTERP_TYPE type; // The type of the code block
|
|
} CODE_BLOCK;
|
|
|
|
/* The chunk of code returned from parsing a parameter list. */
|
|
typedef struct _param_block
|
|
{
|
|
UDWORD numParams;
|
|
INTERP_TYPE *aParams; // List of parameter types
|
|
UDWORD size;
|
|
UDWORD *pCode; // The code that puts the parameters onto the stack
|
|
}PARAM_BLOCK;
|
|
|
|
/* The types of a functions parameters, returned from parsing a parameter declaration */
|
|
typedef struct _param_decl
|
|
{
|
|
UDWORD numParams;
|
|
INTERP_TYPE *aParams;
|
|
} PARAM_DECL;
|
|
|
|
/* The chunk of code used while parsing a conditional statement */
|
|
typedef struct _cond_block
|
|
{
|
|
UDWORD numOffsets;
|
|
UDWORD *aOffsets; // Positions in the code that have to be
|
|
// replaced with the offset to the end of the
|
|
// conditional statment (for the jumps).
|
|
UDWORD size;
|
|
UDWORD *pCode;
|
|
UDWORD debugEntries; // Number of debugging entries in psDebug.
|
|
SCRIPT_DEBUG *psDebug; // Debugging info for the script.
|
|
} COND_BLOCK;
|
|
|
|
/* The possible access types for a type */
|
|
typedef enum _access_type
|
|
{
|
|
AT_SIMPLE, // The type represents a simple data value
|
|
AT_OBJECT, // The type represents an object
|
|
} ACCESS_TYPE;
|
|
|
|
|
|
// function pointer for script variable saving
|
|
// if pBuffer is NULL the script system is just asking how much space the saved variable will require
|
|
// otherwise pBuffer points to an array to store the value in
|
|
typedef BOOL (*SCR_VAL_SAVE)(INTERP_TYPE type, UDWORD data, UBYTE *pBuffer, UDWORD *pSize);
|
|
// function pointer for script variable loading
|
|
typedef BOOL (*SCR_VAL_LOAD)(SDWORD version, INTERP_TYPE type, UBYTE *pBuffer, UDWORD size, UDWORD *pData);
|
|
|
|
/* Type for a user type symbol */
|
|
typedef struct _type_symbol
|
|
{
|
|
SWORD typeID; // The type id to use in the type field of values
|
|
SWORD accessType; // Whether the type is an object or a simple value
|
|
STRING *pIdent; // Type identifier
|
|
SCR_VAL_SAVE saveFunc; // load and save functions
|
|
SCR_VAL_LOAD loadFunc; //
|
|
} TYPE_SYMBOL;
|
|
|
|
/* Type for a variable identifier declaration */
|
|
typedef struct _var_ident_decl
|
|
{
|
|
STRING *pIdent; // variable identifier
|
|
SDWORD dimensions; // number of dimensions of an array - 0 for normal var
|
|
SDWORD elements[VAR_MAX_DIMENSIONS]; // number of elements in an array
|
|
} VAR_IDENT_DECL;
|
|
|
|
/* Type for a variable symbol */
|
|
typedef struct _var_symbol
|
|
{
|
|
STRING *pIdent; // variable's identifier
|
|
INTERP_TYPE type; // variable type
|
|
STORAGE_TYPE storage; // Where the variable is stored
|
|
INTERP_TYPE objType; // The object type if this is an object variable
|
|
UDWORD index; // Index of the variable in its data space
|
|
SCRIPT_VARFUNC get, set; // Access functions if the variable is stored in an object/in-game
|
|
SDWORD dimensions; // number of dimensions of an array - 0 for normal var
|
|
SDWORD elements[VAR_MAX_DIMENSIONS]; // number of elements in an array
|
|
|
|
struct _var_symbol *psNext;
|
|
} VAR_SYMBOL;
|
|
|
|
|
|
/* Type for an array access block */
|
|
typedef struct _array_block
|
|
{
|
|
VAR_SYMBOL *psArrayVar;
|
|
SDWORD dimensions;
|
|
|
|
UDWORD size;
|
|
UDWORD *pCode;
|
|
UDWORD debugEntries; // Number of debugging entries in psDebug.
|
|
SCRIPT_DEBUG *psDebug; // Debugging info for the script.
|
|
} ARRAY_BLOCK;
|
|
|
|
/* Type for a constant symbol */
|
|
typedef struct _const_symbol
|
|
{
|
|
STRING *pIdent; // variable's identifier
|
|
INTERP_TYPE type; // variable type
|
|
|
|
/* The actual value of the constant.
|
|
* Only one of these will be valid depending on type.
|
|
* A union is not used as a union cannot be statically initialised
|
|
*/
|
|
BOOL bval;
|
|
SDWORD ival;
|
|
void *oval;
|
|
// float fval;
|
|
} CONST_SYMBOL;
|
|
|
|
/* The chunk of code used to reference an object variable */
|
|
typedef struct _objvar_block
|
|
{
|
|
VAR_SYMBOL *psObjVar; // The object variables symbol
|
|
|
|
UDWORD size;
|
|
UDWORD *pCode; // The code to get the object value on the stack
|
|
} OBJVAR_BLOCK;
|
|
|
|
/* The maximum number of parameters for an instinct function */
|
|
#define INST_MAXPARAMS 20
|
|
|
|
/* Type for a function symbol */
|
|
typedef struct _func_symbol
|
|
{
|
|
STRING *pIdent; // function's identifier
|
|
SCRIPT_FUNC pFunc; // Pointer to the instinct function
|
|
INTERP_TYPE type; // function type
|
|
UDWORD numParams; // Number of parameters to the function
|
|
INTERP_TYPE aParams[INST_MAXPARAMS];
|
|
// List of parameter types
|
|
BOOL script; // Whether the function is defined in the script
|
|
// or a C instinct function
|
|
UDWORD size; // The size of script code
|
|
UDWORD *pCode; // The code for a function if it is defined in the script
|
|
UDWORD location; // The position of the function in the final code block
|
|
UDWORD debugEntries; // Number of debugging entries in psDebug.
|
|
SCRIPT_DEBUG *psDebug; // Debugging info for the script.
|
|
|
|
struct _func_symbol *psNext;
|
|
} FUNC_SYMBOL;
|
|
|
|
/* The type for a variable declaration */
|
|
typedef struct _var_decl
|
|
{
|
|
INTERP_TYPE type;
|
|
STORAGE_TYPE storage;
|
|
} VAR_DECL;
|
|
|
|
/* The type for a trigger sub declaration */
|
|
typedef struct _trigger_decl
|
|
{
|
|
TRIGGER_TYPE type;
|
|
UDWORD size;
|
|
UDWORD *pCode;
|
|
UDWORD time;
|
|
} TRIGGER_DECL;
|
|
|
|
/* Type for a trigger symbol */
|
|
typedef struct _trigger_symbol
|
|
{
|
|
STRING *pIdent; // Trigger's identifier
|
|
UDWORD index; // The triggers index number
|
|
TRIGGER_TYPE type; // Trigger type
|
|
UDWORD size; // Code size for the trigger
|
|
UDWORD *pCode; // The trigger code
|
|
UDWORD time; // How often to check the trigger
|
|
|
|
UDWORD debugEntries;
|
|
SCRIPT_DEBUG *psDebug;
|
|
|
|
struct _trigger_symbol *psNext;
|
|
} TRIGGER_SYMBOL;
|
|
|
|
/* The type for a callback trigger symbol */
|
|
typedef struct _callback_symbol
|
|
{
|
|
STRING *pIdent; // Callback identifier
|
|
TRIGGER_TYPE type; // user defined callback id >= TR_CALLBACKSTART
|
|
SCRIPT_FUNC pFunc; // Pointer to the instinct function
|
|
UDWORD numParams; // Number of parameters to the function
|
|
INTERP_TYPE aParams[INST_MAXPARAMS];
|
|
// List of parameter types
|
|
} CALLBACK_SYMBOL;
|
|
|
|
|
|
/* Type for an event symbol */
|
|
typedef struct _event_symbol
|
|
{
|
|
STRING *pIdent; // Event's identifier
|
|
UDWORD index; // the events index number
|
|
UDWORD size; // Code size for the event
|
|
UDWORD *pCode; // Event code
|
|
SDWORD trigger; // Index of the event's trigger
|
|
|
|
UDWORD debugEntries;
|
|
SCRIPT_DEBUG *psDebug;
|
|
|
|
struct _event_symbol *psNext;
|
|
} EVENT_SYMBOL;
|
|
|
|
/* The table of user types */
|
|
extern TYPE_SYMBOL *asScrTypeTab;
|
|
|
|
/* The table of external variables and their access functions */
|
|
extern VAR_SYMBOL *asScrExternalTab;
|
|
|
|
/* The table of object variable access routines */
|
|
extern VAR_SYMBOL *asScrObjectVarTab;
|
|
|
|
/* The table of instinct function type definitions */
|
|
extern FUNC_SYMBOL *asScrInstinctTab;
|
|
|
|
/* The table of constant variables */
|
|
extern CONST_SYMBOL *asScrConstantTab;
|
|
|
|
/* The table of callback triggers */
|
|
extern CALLBACK_SYMBOL *asScrCallbackTab;
|
|
|
|
/* Set the current input buffer for the lexer */
|
|
extern void scriptSetInputBuffer(UBYTE *pBuffer, UDWORD size);
|
|
|
|
/* Initialise the parser ready for a new script */
|
|
extern BOOL scriptInitParser(void);
|
|
|
|
/* Set off the scenario file parser */
|
|
extern int scr_parse(void);
|
|
|
|
/* Give an error message */
|
|
void scr_error(char *pMessage, ...);
|
|
|
|
extern void scriptGetErrorData(int *pLine, char **ppText);
|
|
|
|
/* Look up a type symbol */
|
|
extern BOOL scriptLookUpType(STRING *pIdent, INTERP_TYPE *pType);
|
|
|
|
/* Add a new variable symbol */
|
|
extern BOOL scriptAddVariable(VAR_DECL *psStorage, VAR_IDENT_DECL *psVarIdent);
|
|
|
|
/* Add a new trigger symbol */
|
|
extern BOOL scriptAddTrigger(STRING *pIdent, TRIGGER_DECL *psDecl, UDWORD line);
|
|
|
|
/* Add a new event symbol */
|
|
extern BOOL scriptDeclareEvent(STRING *pIdent, EVENT_SYMBOL **ppsEvent);
|
|
|
|
// Add the code to a defined event
|
|
extern BOOL scriptDefineEvent(EVENT_SYMBOL *psEvent, CODE_BLOCK *psCode, SDWORD trigger);
|
|
|
|
/* Look up a variable symbol */
|
|
extern BOOL scriptLookUpVariable(STRING *pIdent, VAR_SYMBOL **ppsSym);
|
|
|
|
/* Look up a constant variable symbol */
|
|
extern BOOL scriptLookUpConstant(STRING *pIdent, CONST_SYMBOL **ppsSym);
|
|
|
|
/* Lookup a trigger symbol */
|
|
extern BOOL scriptLookUpTrigger(STRING *pIdent, TRIGGER_SYMBOL **ppsTrigger);
|
|
|
|
/* Lookup a callback trigger symbol */
|
|
extern BOOL scriptLookUpCallback(STRING *pIdent, CALLBACK_SYMBOL **ppsCallback);
|
|
|
|
/* Lookup an event symbol */
|
|
extern BOOL scriptLookUpEvent(STRING *pIdent, EVENT_SYMBOL **ppsEvent);
|
|
|
|
/* Reset the local variable symbol table */
|
|
extern void scriptClearLocalVariables(void);
|
|
|
|
/* Add a new function symbol */
|
|
extern BOOL scriptStartFunctionDef(STRING *pIdent, // Functions name
|
|
INTERP_TYPE type); // return type
|
|
|
|
/* Store the parameter types for the current script function definition */
|
|
extern BOOL scriptSetParameters(UDWORD numParams, // number of parameters
|
|
INTERP_TYPE *pParams); // parameter types
|
|
|
|
/* Store the code for a script function definition.
|
|
* Clean up the local variable list for this function definition.
|
|
*/
|
|
extern BOOL scriptSetCode(CODE_BLOCK *psBlock); // The code block
|
|
|
|
/* Look up a function symbol */
|
|
extern BOOL scriptLookUpFunction(STRING *pIdent, FUNC_SYMBOL **ppsSym);
|
|
|
|
#endif
|
|
|