I changed it again, this time to clarify namings and add docs. Please have a look at the description of EventTrigIndex as I am not sure what its purpose is.
--Dennis
Index: lib/script/script.h
===================================================================
--- lib/script/script.h (revision 369)
+++ lib/script/script.h (working copy)
@@ -60,13 +60,52 @@
*
* Return stack stuff
*/
+
+/**
+ * Reset the return address stack
+ */
extern void retStackReset(void);
-extern UDWORD RetStackRemember(UDWORD EvTrigIndex, UDWORD address);
-extern BOOL IsRetStackEmpty(void);
-extern BOOL PopRetStack(UDWORD *psVal);
-extern SDWORD GetCallDepth(void);
+/**
+ * Check whether the return address stack is empty
+ *
+ * \return True when empty, false otherwise
+ */
+extern inline BOOL retStackIsEmpty(void);
+/**
+ * Check whether the return address stack is full
+ *
+ * \return True when full, false otherwise
+ */
+extern inline BOOL retStackIsFull(void);
+
+/**
+ * Current call depth
+ *
+ * \return Number of calls on the return address stack
+ */
+extern inline SDWORD getCallDepth(void);
+
+/**
+ * Push a new address/event pair on the return address stack
+ *
+ * \param EventTrigIndex ??? Event associated with the return address ???
+ * \param ReturnAddress Address to return to
+ * \return False on failure (stack full)
+ */
+extern BOOL retStackPush(UDWORD EventTrigIndex, UDWORD *ReturnAddress);
+
+/**
+ * Pop an address/event pair from the return address stack
+ *
+ * \param EventTrigIndex ??? Event associated with the return address ???
+ * \param ReturnAddress Address to return to
+ * \return False on failure (stack empty)
+ */
+extern BOOL retStackPop(UDWORD *EventTrigIndex, UDWORD **ReturnAddress);
+
+
/***********************************************************************************
*
* Compiler functions
Index: lib/script/interp.c
===================================================================
--- lib/script/interp.c (revision 369)
+++ lib/script/interp.c (working copy)
@@ -19,8 +19,12 @@
// an infinite loop
#define INTERP_MAXINSTRUCTIONS 100000
+typedef struct
+{
+ UDWORD Event;
+ UDWORD *ReturnAddress;
+} ReturnAddressStack_t;
-
/* The size of each opcode */
SDWORD aOpSize[] =
{
@@ -34,8 +38,8 @@
1, // OP_PUSHARRAYGLOBAL | array_dimensions | array_base
1, // OP_POPARRAYGLOBAL | array_dimensions | array_base
- 2, // OP_CALL, func_pointer
- 2, // OP_VARCALL, func_pointer
+ 2, // OP_CALL | func_pointer
+ 2, // OP_VARCALL | func_pointer
1, // OP_JUMP | offset
1, // OP_JUMPTRUE | offset
@@ -46,6 +50,30 @@
1, // OP_EXIT
1, // OP_PAUSE
+
+ -1, // OP_ADD
+ -1, // OP_SUB
+ -1, // OP_MUL
+ -1, // OP_DIV
+ -1, // OP_NEG
+
+ -1, // OP_AND
+ -1, // OP_OR
+ -1, // OP_NOT
+
+ -1, // OP_CANC
+
+ -1, // OP_EQUAL
+ -1, // OP_NOTEQUAL
+ -1, // OP_GREATEREQUAL
+ -1, // OP_LESSEQUAL
+ -1, // OP_GREATER
+ -1, // OP_LESS
+
+ 2, // OP_FUNC | func_pointer
+ 1, // OP_POPLOCAL
+ 1, // OP_PUSHLOCAL
+ 2, // OP_PUSHLOCALREF
};
/* The type equivalence table */
@@ -113,14 +141,14 @@
UBYTE *elements; //[VAR_MAX_DIMENSIONS]
SDWORD size, val;//, elementDWords;
// UBYTE *pElem;
- UDWORD *ip = *pip;
+ UDWORD *InstrPointer = *pip;
UDWORD base, index;
// get the base index of the array
- base = (*ip) & ARRAY_BASE_MASK;
+ base = (*InstrPointer) & ARRAY_BASE_MASK;
// get the number of dimensions
- dimensions = ((*ip) & ARRAY_DIMENSION_MASK) >> ARRAY_DIMENSION_SHIFT;
+ dimensions = ((*InstrPointer) & ARRAY_DIMENSION_MASK) >> ARRAY_DIMENSION_SHIFT;
if (base >= psProg->numArrays)
{
@@ -208,7 +236,7 @@
/* Run a compiled script */
BOOL interpRunScript(SCRIPT_CONTEXT *psContext, INTERP_RUNTYPE runType, UDWORD index, UDWORD offset)
{
- UDWORD *ip, opcode, data;
+ UDWORD *InstrPointer, opcode, data;
INTERP_VAL sVal, *psVar;
VAL_CHUNK *psGlobals;
UDWORD numGlobals;
@@ -297,8 +325,8 @@
// Get the first opcode
- ip = pCodeStart;
- opcode = (*ip) >> OPCODE_SHIFT;
+ InstrPointer = pCodeStart;
+ opcode = (*InstrPointer) >> OPCODE_SHIFT;
instructionCount = 0;
CurEvent = index;
@@ -309,7 +337,7 @@
while(!bStop)
{
// Run the code
- if (ip < pCodeEnd)// && opcode != OP_EXIT)
+ if (InstrPointer < pCodeEnd)// && opcode != OP_EXIT)
{
if (instructionCount > INTERP_MAXINSTRUCTIONS)
{
@@ -320,25 +348,23 @@
}
instructionCount += 1;
- TRCPRINTF(("%-6d ", ip - psProg->pCode));
- opcode = (*ip) >> OPCODE_SHIFT;
- data = (*ip) & OPCODE_DATAMASK;
+ TRCPRINTF(("%-6d ", InstrPointer - psProg->pCode));
+ opcode = (*InstrPointer) >> OPCODE_SHIFT;
+ data = (*InstrPointer) & OPCODE_DATAMASK;
switch (opcode)
{
/* Custom function call */
case OP_FUNC:
//debug( LOG_SCRIPT, "-OP_FUNC" );
//debug( LOG_SCRIPT, "OP_FUNC: remember event %d, ip=%d", CurEvent, (ip + 2) );
- if(!RetStackRemember(CurEvent, *(ip + 2))) //Remember where to jump back later
+ if(!retStackPush(CurEvent, (InstrPointer + aOpSize[opcode]))) //Remember where to jump back later
{
- debug( LOG_ERROR, "interpRunScript() - RetStackRemember() failed.");
+ debug( LOG_ERROR, "interpRunScript() - retStackPush() failed.");
return FALSE;
}
- CurEvent = *(ip+1); //Current event = event to jump to
+ CurEvent = *(InstrPointer+1); //Current event = event to jump to
-
-
if (CurEvent > psProg->numEvents)
{
debug( LOG_ERROR, "interpRunScript: trigger index out of range");
@@ -351,7 +377,7 @@
pCodeStart = pCodeBase;
pCodeEnd = psProg->pCode + psProg->pEventTab[CurEvent+1];
- ip = pCodeStart; //Start at the beginning of the new event
+ InstrPointer = pCodeStart; //Start at the beginning of the new event
//debug( LOG_SCRIPT, "-OP_FUNC: jumped to event %d; ip=%d, numLocalVars: %d", CurEvent, ip, psContext->psCode->numLocalVars[CurEvent] );
@@ -383,7 +409,7 @@
//debug( LOG_SCRIPT, "OP_PUSHLOCAL 3");
- ip += 1;//aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_POPLOCAL:
@@ -408,17 +434,17 @@
//debug(LOG_SCRIPT, "OP_POPLOCAL: type=%d, val=%d", psContext->psCode->ppsLocalVarVal[CurEvent][data].type, psContext->psCode->ppsLocalVarVal[CurEvent][data].v.ival);
//debug( LOG_SCRIPT, "OP_POPLOCAL 3");
- ip += 1; //aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_PUSHLOCALREF:
// The type of the variable is stored in with the opcode
- sVal.type = (*ip) & OPCODE_DATAMASK;
+ sVal.type = (*InstrPointer) & OPCODE_DATAMASK;
/* get local var index */
- data = *(ip + 1);
+ data = *(InstrPointer + 1);
if (data >= psContext->psCode->numLocalVars[CurEvent])
{
@@ -440,14 +466,14 @@
debug(LOG_ERROR, "interpRunScript: OP_PUSHLOCALREF: push failed");
goto exit_with_error;
}
- ip += 2;
+ InstrPointer += aOpSize[opcode];
break;
case OP_PUSH:
// The type of the value is stored in with the opcode
- sVal.type = (*ip) & OPCODE_DATAMASK;
+ sVal.type = (*InstrPointer) & OPCODE_DATAMASK;
// Copy the data as a DWORD
- sVal.v.ival = (SDWORD)(*(ip+1));
+ sVal.v.ival = (SDWORD)(*(InstrPointer+1));
TRCPRINTF(("PUSH "));
TRCPRINTVAL(&sVal);
TRCPRINTF(("\n"));
@@ -458,13 +484,13 @@
ASSERT( FALSE, "interpRunScript: out of memory!" );
goto exit_with_error;
}
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_PUSHREF:
// The type of the variable is stored in with the opcode
- sVal.type = (*ip) & OPCODE_DATAMASK;
+ sVal.type = (*InstrPointer) & OPCODE_DATAMASK;
// store the pointer
- psVar = interpGetVarData(psGlobals, *(ip + 1));
+ psVar = interpGetVarData(psGlobals, *(InstrPointer + 1));
sVal.v.oval = &(psVar->v.ival);
TRCPRINTF(("PUSHREF "));
TRCPRINTVAL(&sVal);
@@ -476,7 +502,7 @@
ASSERT( FALSE, "interpRunScript: out of memory!" );
goto exit_with_error;
}
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_POP:
TRCPRINTF(("POP\n"));
@@ -486,7 +512,7 @@
ASSERT( FALSE, "interpRunScript: could not do stack pop" );
goto exit_with_error;
}
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_BINARYOP:
TRCPRINTMATHSOP(data);
@@ -498,7 +524,7 @@
}
TRCPRINTSTACKTOP();
TRCPRINTF(("\n"));
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_UNARYOP:
TRCPRINTMATHSOP(data);
@@ -510,7 +536,7 @@
}
TRCPRINTSTACKTOP();
TRCPRINTF(("\n"));
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_PUSHGLOBAL:
TRCPRINTF(("PUSHGLOBAL %d\n", data));
@@ -526,7 +552,7 @@
ASSERT( FALSE, "interpRunScript: could not do stack push" );
goto exit_with_error;
}
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_POPGLOBAL:
TRCPRINTF(("POPGLOBAL %d ", data));
@@ -544,7 +570,7 @@
ASSERT( FALSE, "interpRunScript: could not do stack pop" );
goto exit_with_error;
}
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_PUSHARRAYGLOBAL:
// get the number of array elements
@@ -567,7 +593,7 @@
// goto exit_with_error;
// }
TRCPRINTF(("PUSHARRAYGLOBAL "));
- if (!interpGetArrayVarData(&ip, psGlobals, psProg, &psVar))
+ if (!interpGetArrayVarData(&InstrPointer, psGlobals, psProg, &psVar))
{
debug( LOG_ERROR, "interpRunScript: could not get array var data, CurEvent=%d", CurEvent );
ASSERT( FALSE, "interpRunScript: could not get array var data" );
@@ -611,7 +637,7 @@
}
ip += aOpSize[opcode];*/
TRCPRINTF(("POPARRAYGLOBAL "));
- if (!interpGetArrayVarData(&ip, psGlobals, psProg, &psVar))
+ if (!interpGetArrayVarData(&InstrPointer, psGlobals, psProg, &psVar))
{
debug( LOG_ERROR, "interpRunScript: could not get array var data" );
ASSERT( FALSE, "interpRunScript: could not get array var data" );
@@ -628,7 +654,7 @@
break;
case OP_JUMPFALSE:
TRCPRINTF(("JUMPFALSE %d (%d)",
- (SWORD)data, ip - psProg->pCode + (SWORD)data));
+ (SWORD)data, InstrPointer - psProg->pCode + (SWORD)data));
if (!stackPop(&sVal))
{
debug( LOG_ERROR, "interpRunScript: could not do pop of stack" );
@@ -639,8 +665,8 @@
{
// Do the jump
TRCPRINTF((" - done -\n"));
- ip += (SWORD)data;
- if (ip < pCodeStart || ip > pCodeEnd)
+ InstrPointer += (SWORD)data;
+ if (InstrPointer < pCodeStart || InstrPointer > pCodeEnd)
{
debug( LOG_ERROR, "interpRunScript: jump out of range" );
ASSERT( FALSE, "interpRunScript: jump out of range" );
@@ -650,15 +676,15 @@
else
{
TRCPRINTF(("\n"));
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
}
break;
case OP_JUMP:
TRCPRINTF(("JUMP %d (%d)\n",
- (SWORD)data, ip - psProg->pCode + (SWORD)data));
+ (SWORD)data, InstrPointer - psProg->pCode + (SWORD)data));
// Do the jump
- ip += (SWORD)data;
- if (ip < pCodeStart || ip > pCodeEnd)
+ InstrPointer += (SWORD)data;
+ if (InstrPointer < pCodeStart || InstrPointer > pCodeEnd)
{
debug( LOG_ERROR, "interpRunScript: jump out of range" );
ASSERT( FALSE, "interpRunScript: jump out of range" );
@@ -667,9 +693,9 @@
break;
case OP_CALL:
//debug(LOG_SCRIPT, "OP_CALL");
- TRCPRINTFUNC( (SCRIPT_FUNC)(*(ip+1)) );
+ TRCPRINTFUNC( (SCRIPT_FUNC)(*(InstrPointer+1)) );
TRCPRINTF(("\n"));
- scriptFunc = (SCRIPT_FUNC)*(ip+1);
+ scriptFunc = (SCRIPT_FUNC)*(InstrPointer+1);
//debug(LOG_SCRIPT, "OP_CALL 1");
if (!scriptFunc())
{
@@ -678,40 +704,40 @@
goto exit_with_error;
}
//debug(LOG_SCRIPT, "OP_CALL 2");
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
//debug(LOG_SCRIPT, "OP_CALL 3");
break;
case OP_VARCALL:
TRCPRINTF(("VARCALL "));
- TRCPRINTVARFUNC( (SCRIPT_VARFUNC)(*(ip+1)), data );
+ TRCPRINTVARFUNC( (SCRIPT_VARFUNC)(*(InstrPointer+1)), data );
TRCPRINTF(("(%d)\n", data));
- scriptVarFunc = (SCRIPT_VARFUNC)*(ip+1);
+ scriptVarFunc = (SCRIPT_VARFUNC)*(InstrPointer+1);
if (!scriptVarFunc(data))
{
debug( LOG_ERROR, "interpRunScript: could not do var func" );
ASSERT( FALSE, "interpRunScript: could not do var func" );
goto exit_with_error;
}
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
break;
case OP_EXIT:
// jump out of the code
- ip = pCodeEnd;
+ InstrPointer = pCodeEnd;
break;
case OP_PAUSE:
TRCPRINTF(("PAUSE %d\n", data));
ASSERT( stackEmpty(),
"interpRunScript: OP_PAUSE without empty stack" );
- ip += aOpSize[opcode];
+ InstrPointer += aOpSize[opcode];
// tell the event system to reschedule this event
- if (!eventAddPauseTrigger(psContext, index, ip - pCodeBase, data))
+ if (!eventAddPauseTrigger(psContext, index, InstrPointer - pCodeBase, data))
{
debug( LOG_ERROR, "interpRunScript: could not add pause trigger" );
ASSERT( FALSE, "interpRunScript: could not add pause trigger" );
goto exit_with_error;
}
// now jump out of the event
- ip = pCodeEnd;
+ InstrPointer = pCodeEnd;
break;
default:
debug(LOG_ERROR, "interpRunScript: unknown opcode");
@@ -725,7 +751,7 @@
{
//debug(LOG_SCRIPT, "End of event reached");
- if(!IsRetStackEmpty()) //There was a caller function before this one
+ if(!retStackIsEmpty()) //There was a caller function before this one
{
//debug(LOG_SCRIPT, "GetCallDepth = %d", GetCallDepth());
@@ -736,25 +762,17 @@
goto exit_with_error;
}
- if(!PopRetStack((UDWORD *)&ip)) //Pop return address
+ if (!retStackPop(&CurEvent, &InstrPointer))
{
- debug( LOG_ERROR, "interpRunScript() - PopRetStack(): failed to pop return adress.");
+ debug( LOG_ERROR, "interpRunScript() - PopRetStack() failed.");
return FALSE;
}
- //debug(LOG_SCRIPT, "Return adress = %d", ip);
-
- if(!PopRetStack(&CurEvent)) //Pop event index
- {
- debug( LOG_ERROR, "interpRunScript() - PopRetStack(): failed to pop return event index.");
- return FALSE;
- }
-
//debug( LOG_SCRIPT, "RETURNED TO CALLER EVENT %d", CurEvent );
//Set new boundries
//--------------------------
- if(IsRetStackEmpty()) //if we jumped back to the original caller
+ if(retStackIsEmpty()) //if we jumped back to the original caller
{
if(!bEvent) //original caller was a trigger (is it possible at all?)
{
@@ -800,7 +818,7 @@
//debug(LOG_SCRIPT, "interpRunScript 3");
- TRCPRINTF(("%-6d EXIT\n", ip - psProg->pCode));
+ TRCPRINTF(("%-6d EXIT\n", InstrPointer - psProg->pCode));
bInterpRunning = FALSE;
return TRUE;
@@ -815,7 +833,7 @@
debug(LOG_ERROR,"Original trigger ID: %d (of %d)", index, psProg->numTriggers);
debug(LOG_ERROR,"Current event ID: %d (of %d)", CurEvent, psProg->numEvents);
- callDepth = GetCallDepth();
+ callDepth = getCallDepth();
debug(LOG_ERROR,"Call depth : %d", callDepth);
if(psProg->psDebug != NULL)
@@ -929,59 +947,65 @@
/* Call stack stuff */
+#define RETSTACK_SIZE 100
-static UDWORD retStack[200]; //Primitive stack
-static SDWORD retStackPos; //Current Position, always points to the last valid element
+static ReturnAddressStack_t retStack[RETSTACK_SIZE]; //Primitive stack
+static Sint8 retStackPos = -1; //Current Position, always points to the last valid element
void retStackReset(void)
{
retStackPos = -1; //Beginning of the stack
}
-//Remember current script execution adress
-UDWORD RetStackRemember(UDWORD EvTrigIndex, UDWORD address)
+inline BOOL retStackIsEmpty(void)
{
- //DbgMsg("To remember: %d, %d, %d", EvTrigIndex, address, retStackPos);
+ if(retStackPos < 0) return TRUE;
+ return FALSE;
+}
- if (retStackPos >= 200)
+inline BOOL retStackIsFull(void)
+{
+ if(retStackPos >= RETSTACK_SIZE) return TRUE;
+ return FALSE;
+}
+
+
+inline SDWORD getCallDepth(void)
+{
+ return (retStackPos + 1);
+}
+
+BOOL retStackPush(UDWORD EventTrigIndex, UDWORD *ReturnAddress)
+{
+ if (retStackIsFull())
{
- debug( LOG_ERROR, "RetStackRemember() - return address stack is full");
+ debug( LOG_ERROR, "retStackPush(): return address stack is full");
return FALSE; //Stack full
}
- retStackPos = retStackPos + 2;
- retStack[retStackPos - 1] = EvTrigIndex; //First store event index
- retStack[retStackPos] = address; //current ip
+ retStackPos++;
+ retStack[retStackPos].Event = EventTrigIndex; //First store event index
+ retStack[retStackPos].ReturnAddress = ReturnAddress; //current InstrPointer
- //debug( LOG_SCRIPT, "RetStackRemember: ip=%d, event=%d", address, EvTrigIndex);
+ //debug( LOG_SCRIPT, "retStackPush: Event=%i Address=%p, ", EventTrigIndex, ReturnAddress);
return TRUE;
}
-BOOL IsRetStackEmpty(void)
-{
- if(retStackPos == (-1)) return TRUE;
- return FALSE;
-}
-BOOL PopRetStack(UDWORD *psVal)
+BOOL retStackPop(UDWORD *EventTrigIndex, UDWORD **ReturnAddress)
{
- if(retStackPos < 0)
+ if (retStackIsEmpty())
{
- debug( LOG_ERROR, "PopRetStack: retStackPos < 0");
+ debug( LOG_ERROR, "retStackPop(): return address stack is empty");
return FALSE;
}
- *psVal = retStack[retStackPos];
+ *EventTrigIndex = retStack[retStackPos].Event;
+ *ReturnAddress = retStack[retStackPos].ReturnAddress;
+ retStackPos--;
- retStackPos = retStackPos - 1;
+ //debug( LOG_SCRIPT, "retStackPop: Event=%i Address=%p", *EventTrigIndex, *ReturnAddress);
- //debug( LOG_SCRIPT, "PopRetStack: val=%d", *psVal);
-
return TRUE;
}
-
-SDWORD GetCallDepth(void)
-{
- return (retStackPos + 1) / 2;
-}
Index: lib/script/event.c
===================================================================
--- lib/script/event.c (revision 369)
+++ lib/script/event.c (working copy)
@@ -972,7 +972,7 @@
TRIGGER_DATA *psTrigDat;
BOOL fired;
- // FIXME temporary check
+ // FIXME temporary check
// FIXME This needs to be removed as soon as we are sure the transport comes and we don't have any more problems with the VIDEO_QUIT callback !!
if(callback == 15)
debug(LOG_SCRIPT, "eventFireCallbackTrigger: processing CALL_VIDEO_QUIT");
@@ -1414,9 +1414,9 @@
if(EventIndex >= psCode->numEvents)
{
if(psCode->psDebug != NULL)
- debug(LOG_ERROR, "resetLocalVars: wrong event index: %d (Event name: %s, total events count = %d, stack depth = %d)", EventIndex, eventGetEventID(psCode, EventIndex), psCode->numEvents, GetCallDepth());
+ debug(LOG_ERROR, "resetLocalVars: wrong event index: %d (Event name: %s, total events count = %d, stack depth = %d)", EventIndex, eventGetEventID(psCode, EventIndex), psCode->numEvents, getCallDepth());
else
- debug(LOG_ERROR, "resetLocalVars: wrong event index: %d (total events count = %d, stack depth = %d)", EventIndex, psCode->numEvents, GetCallDepth());
+ debug(LOG_ERROR, "resetLocalVars: wrong event index: %d (total events count = %d, stack depth = %d)", EventIndex, psCode->numEvents, getCallDepth());
return FALSE;
}
pgpfEusS4EPC7.pgp
Description: PGP signature
_______________________________________________ Warzone-dev mailing list Warzone-dev@gna.org https://mail.gna.org/listinfo/warzone-dev
