Skip to content

Split script to script_vm and script #2333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AZero13 wants to merge 1 commit into
base: master
Choose a base branch
from
+159 −160
Open

Split script to script_vm and script #2333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ld_script.ld
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ SECTIONS {
src/field_message_box.o(.text);
src/event_object_lock.o(.text);
src/text_window.o(.text);
src/script_vm.o(.text);
src/script.o(.text);
src/scrcmd.o(.text);
src/field_control_avatar.o(.text);
Expand Down Expand Up @@ -509,6 +510,7 @@ SECTIONS {
src/field_player_avatar.o(.rodata);
src/event_object_movement.o(.rodata);
src/text_window.o(.rodata);
src/script_vm.o(.rodata);
src/scrcmd.o(.rodata);
src/field_control_avatar.o(.rodata);
src/coord_event_weather.o(.rodata);
Expand Down
4 changes: 0 additions & 4 deletions src/scrcmd.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,6 @@ extern const u8 *gStdScripts_End[];

static void CloseBrailleWindow(void);

// This is defined in here so the optimizer can't see its value when compiling
// script.c.
void *const gNullScriptPtr = NULL;

static const u8 sScriptConditionTable[COMPARISON_OPERATORS_COUNT][3] =
{
// < = >
Expand Down
157 changes: 1 addition & 156 deletions src/script.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,176 +8,21 @@

#define RAM_SCRIPT_MAGIC 51

enum {
SCRIPT_MODE_STOPPED,
SCRIPT_MODE_BYTECODE,
SCRIPT_MODE_NATIVE,
};
extern const u8 *gRamScriptRetAddr;

enum {
CONTEXT_RUNNING,
CONTEXT_WAITING,
CONTEXT_SHUTDOWN,
};

extern const u8 *gRamScriptRetAddr;

static u8 sGlobalScriptContextStatus;
static struct ScriptContext sGlobalScriptContext;
static struct ScriptContext sImmediateScriptContext;
static bool8 sLockFieldControls;

extern ScrCmdFunc gScriptCmdTable[];
extern ScrCmdFunc gScriptCmdTableEnd[];
extern void *const gNullScriptPtr;

void InitScriptContext(struct ScriptContext *ctx, void *cmdTable, void *cmdTableEnd)
{
s32 i;

ctx->mode = SCRIPT_MODE_STOPPED;
ctx->scriptPtr = NULL;
ctx->stackDepth = 0;
ctx->nativePtr = NULL;
ctx->cmdTable = cmdTable;
ctx->cmdTableEnd = cmdTableEnd;

for (i = 0; i < (int)ARRAY_COUNT(ctx->data); i++)
ctx->data[i] = 0;

for (i = 0; i < (int)ARRAY_COUNT(ctx->stack); i++)
ctx->stack[i] = NULL;
}

u8 SetupBytecodeScript(struct ScriptContext *ctx, const u8 *ptr)
{
ctx->scriptPtr = ptr;
ctx->mode = SCRIPT_MODE_BYTECODE;
return 1;
}

void SetupNativeScript(struct ScriptContext *ctx, bool8 (*ptr)(void))
{
ctx->mode = SCRIPT_MODE_NATIVE;
ctx->nativePtr = ptr;
}

void StopScript(struct ScriptContext *ctx)
{
ctx->mode = SCRIPT_MODE_STOPPED;
ctx->scriptPtr = NULL;
}

bool8 RunScriptCommand(struct ScriptContext *ctx)
{
if (ctx->mode == SCRIPT_MODE_STOPPED)
return FALSE;

switch (ctx->mode)
{
case SCRIPT_MODE_STOPPED:
return FALSE;
case SCRIPT_MODE_NATIVE:
// Try to call a function in C
// Continue to bytecode if no function or it returns TRUE
if (ctx->nativePtr)
{
if (ctx->nativePtr() == TRUE)
ctx->mode = SCRIPT_MODE_BYTECODE;
return TRUE;
}
ctx->mode = SCRIPT_MODE_BYTECODE;
// fallthrough
case SCRIPT_MODE_BYTECODE:
while (1)
{
u8 cmdCode;
ScrCmdFunc *func;

if (!ctx->scriptPtr)
{
ctx->mode = SCRIPT_MODE_STOPPED;
return FALSE;
}

if (ctx->scriptPtr == gNullScriptPtr)
{
while (1)
asm("svc 2"); // HALT
}

cmdCode = *(ctx->scriptPtr);
ctx->scriptPtr++;
func = &ctx->cmdTable[cmdCode];

if (func >= ctx->cmdTableEnd)
{
ctx->mode = SCRIPT_MODE_STOPPED;
return FALSE;
}

if ((*func)(ctx) == TRUE)
return TRUE;
}
}

return TRUE;
}

static bool8 ScriptPush(struct ScriptContext *ctx, const u8 *ptr)
{
if (ctx->stackDepth + 1 >= (int)ARRAY_COUNT(ctx->stack))
{
return TRUE;
}
else
{
ctx->stack[ctx->stackDepth] = ptr;
ctx->stackDepth++;
return FALSE;
}
}

static const u8 *ScriptPop(struct ScriptContext *ctx)
{
if (ctx->stackDepth == 0)
return NULL;

ctx->stackDepth--;
return ctx->stack[ctx->stackDepth];
}

void ScriptJump(struct ScriptContext *ctx, const u8 *ptr)
{
ctx->scriptPtr = ptr;
}

void ScriptCall(struct ScriptContext *ctx, const u8 *ptr)
{
ScriptPush(ctx, ctx->scriptPtr);
ctx->scriptPtr = ptr;
}

void ScriptReturn(struct ScriptContext *ctx)
{
ctx->scriptPtr = ScriptPop(ctx);
}

u16 ScriptReadHalfword(struct ScriptContext *ctx)
{
u16 value = *(ctx->scriptPtr++);
value |= *(ctx->scriptPtr++) << 8;
return value;
}

u32 ScriptReadWord(struct ScriptContext *ctx)
{
u32 value0 = *(ctx->scriptPtr++);
u32 value1 = *(ctx->scriptPtr++);
u32 value2 = *(ctx->scriptPtr++);
u32 value3 = *(ctx->scriptPtr++);
return (((((value3 << 8) + value2) << 8) + value1) << 8) + value0;
}

void LockPlayerFieldControls(void)
{
Expand Down
156 changes: 156 additions & 0 deletions src/script_vm.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
#include "global.h"
#include "script.h"

enum {
SCRIPT_MODE_STOPPED,
SCRIPT_MODE_BYTECODE,
SCRIPT_MODE_NATIVE,
};

extern ScrCmdFunc gScriptCmdTable[];
extern ScrCmdFunc gScriptCmdTableEnd[];

// Has to be u32, otherwise agbcc will optimize the null check out and it won't match.
const u32 gNullScriptPtr = 0;

void InitScriptContext(struct ScriptContext *ctx, void *cmdTable, void *cmdTableEnd)
{
s32 i;

ctx->mode = SCRIPT_MODE_STOPPED;
ctx->scriptPtr = NULL;
ctx->stackDepth = 0;
ctx->nativePtr = NULL;
ctx->cmdTable = cmdTable;
ctx->cmdTableEnd = cmdTableEnd;

for (i = 0; i < (int)ARRAY_COUNT(ctx->data); i++)
ctx->data[i] = 0;

for (i = 0; i < (int)ARRAY_COUNT(ctx->stack); i++)
ctx->stack[i] = NULL;
}

u8 SetupBytecodeScript(struct ScriptContext *ctx, const u8 *ptr)
{
ctx->scriptPtr = ptr;
ctx->mode = SCRIPT_MODE_BYTECODE;
return 1;
}

void SetupNativeScript(struct ScriptContext *ctx, bool8 (*ptr)(void))
{
ctx->mode = SCRIPT_MODE_NATIVE;
ctx->nativePtr = ptr;
}

void StopScript(struct ScriptContext *ctx)
{
ctx->mode = SCRIPT_MODE_STOPPED;
ctx->scriptPtr = NULL;
}

bool8 RunScriptCommand(struct ScriptContext *ctx)
{
if (ctx->mode == SCRIPT_MODE_STOPPED)
return FALSE;

switch (ctx->mode)
{
case SCRIPT_MODE_STOPPED:
return FALSE;
case SCRIPT_MODE_NATIVE:
// Try to call a function in C
// Continue to bytecode if no function or it returns TRUE
if (ctx->nativePtr)
{
if (ctx->nativePtr() == TRUE)
ctx->mode = SCRIPT_MODE_BYTECODE;
return TRUE;
}
ctx->mode = SCRIPT_MODE_BYTECODE;
// fallthrough
case SCRIPT_MODE_BYTECODE:
while (1)
{
u8 cmdCode;
if (!ctx->scriptPtr)
{
ctx->mode = SCRIPT_MODE_STOPPED;
return FALSE;
}

// Redundant, and needed to match, though one could change gNullScriptPtr if they need a
// script debug breakpoint
if (ctx->scriptPtr == (const u8 *)gNullScriptPtr)
{
while (1)
asm("svc 2"); // HALT
}

cmdCode = *(ctx->scriptPtr++);

if (&ctx->cmdTable[cmdCode] >= ctx->cmdTableEnd)
{
ctx->mode = SCRIPT_MODE_STOPPED;
return FALSE;
}

if (ctx->cmdTable[cmdCode](ctx) == 1)
return TRUE;
}
}

return TRUE;
}

static bool8 ScriptPush(struct ScriptContext *ctx, const u8 *ptr)
{
if (ctx->stackDepth + 1 >= (int)ARRAY_COUNT(ctx->stack))
return TRUE;

ctx->stack[ctx->stackDepth] = ptr;
ctx->stackDepth++;
return FALSE;
}

static const u8 *ScriptPop(struct ScriptContext *ctx)
{
if (ctx->stackDepth == 0)
return NULL;

ctx->stackDepth--;
return ctx->stack[ctx->stackDepth];
}

void ScriptJump(struct ScriptContext *ctx, const u8 *ptr)
{
ctx->scriptPtr = ptr;
}

void ScriptCall(struct ScriptContext *ctx, const u8 *ptr)
{
ScriptPush(ctx, ctx->scriptPtr);
ctx->scriptPtr = ptr;
}

void ScriptReturn(struct ScriptContext *ctx)
{
ctx->scriptPtr = ScriptPop(ctx);
}

u16 ScriptReadHalfword(struct ScriptContext *ctx)
{
u16 value = *(ctx->scriptPtr++);
value += *(ctx->scriptPtr++) << 8;
return value;
}

u32 ScriptReadWord(struct ScriptContext *ctx)
{
u32 value0 = *(ctx->scriptPtr++);
u32 value1 = *(ctx->scriptPtr++);
u32 value2 = *(ctx->scriptPtr++);
u32 value3 = *(ctx->scriptPtr++);
return (((((value3 << 8) + value2) << 8) + value1) << 8) + value0;
}