qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2024-11-23 12:52:46 +00:00
Code Issues Projects Releases Packages Wiki Activity
quakeforge/libs/ruamoko/rua_script.c

219 lines
5 KiB
C
Raw Normal View History

Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
/*
rua_script.c
Script api for ruamoko
Copyright (C) 2004 Bill Currie
Author: Bill Currie
Date: 2002/11/11
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to:
Free Software Foundation, Inc.
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <stdlib.h>
#ifdef HAVE_STRING_H
# include <string.h>
#endif
#ifdef HAVE_STRINGS_H
# include <strings.h>
#endif
#include "QF/progs.h"
#include "QF/script.h"
#include "rua_internal.h"
typedef struct {
script_t script;
[gamecode] Clean up string_t and pointer_t They are both gone, and pr_pointer_t is now pr_ptr_t (pointer may be a little clearer than ptr, but ptr is consistent with things like intptr, and keeps the type name short).
2022-01-18 03:11:14 +00:00
pr_string_t dstr;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
progs_t *pr;
} rua_script_t;
typedef struct {
PR_RESMAP(rua_script_t) scripts;
} script_resources_t;
static rua_script_t *
script_new (script_resources_t *res)
{
[gamecode] Make PR_RESMAP macros more function-like I never liked that some of the macros needed the type as a parameter (yay typeof and __auto_type) or those that returned a value hid the return statement so they couldn't be used in assignments.
2021-03-21 12:26:36 +00:00
return PR_RESNEW (res->scripts);
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
}
static void
script_free (script_resources_t *res, rua_script_t *script)
{
[gamecode] Make PR_RESMAP macros more function-like I never liked that some of the macros needed the type as a parameter (yay typeof and __auto_type) or those that returned a value hid the return statement so they couldn't be used in assignments.
2021-03-21 12:26:36 +00:00
PR_RESFREE (res->scripts, script);
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
}
static void
script_reset (script_resources_t *res)
{
[gamecode] Make PR_RESMAP macros more function-like I never liked that some of the macros needed the type as a parameter (yay typeof and __auto_type) or those that returned a value hid the return statement so they couldn't be used in assignments.
2021-03-21 12:26:36 +00:00
PR_RESRESET (res->scripts);
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
}
static inline rua_script_t *
script_get (script_resources_t *res, int index)
{
[gamecode] Make PR_RESMAP macros more function-like I never liked that some of the macros needed the type as a parameter (yay typeof and __auto_type) or those that returned a value hid the return statement so they couldn't be used in assignments.
2021-03-21 12:26:36 +00:00
return PR_RESGET(res->scripts, index);
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
}
[build] Fix a pile of gcc 10 issues gcc got stricter about array accesses, complicating progs macros, and much better at detecting buffer overflows.
2020-12-20 17:12:51 +00:00
static inline int __attribute__((pure))
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
script_index (script_resources_t *res, rua_script_t *script)
{
[gamecode] Make PR_RESMAP macros more function-like I never liked that some of the macros needed the type as a parameter (yay typeof and __auto_type) or those that returned a value hid the return statement so they couldn't be used in assignments.
2021-03-21 12:26:36 +00:00
return PR_RESINDEX(res->scripts, script);
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_script_clear (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = (script_resources_t *) _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
script_reset (res);
}
[gamecode] Add PR_Shutdown for tearing down a VM This is meant for a "permanent" tear-down before freeing the memory holding the VM state or at program shutdown. As a consequence, builtin sub-systems registering resources are now required to pass a "destroy" function pointer that will be called just before the memory holding those resources is freed by the VM resource manager (ie, the manager owns the resource memory block, but each subsystem is responsible for cleaning up any resources held within that block). This even enhances thread-safety in rua_obj (there are some problems with cmd, cvar, and gib).
2022-05-12 09:23:32 +00:00
static void
bi_script_destroy (progs_t *pr, void *_res)
{
[gamecode] Make modules responsible for freeing resources It should have been this way all along, and it seems I thought they were when I did rua_gui.c as it already freed its resource block, which would have been a double free (oops). Fixes an invalid write when shutting down progs in qwaq-cmd (relevant change not committed).
2023-03-03 10:36:28 +00:00
free (_res);
[gamecode] Add PR_Shutdown for tearing down a VM This is meant for a "permanent" tear-down before freeing the memory holding the VM state or at program shutdown. As a consequence, builtin sub-systems registering resources are now required to pass a "destroy" function pointer that will be called just before the memory holding those resources is freed by the VM resource manager (ie, the manager owns the resource memory block, but each subsystem is responsible for cleaning up any resources held within that block). This even enhances thread-safety in rua_obj (there are some problems with cmd, cvar, and gib).
2022-05-12 09:23:32 +00:00
}
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_New (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_new (res);
if (!script)
PR_RunError (pr, "out of memory");
script->dstr = PR_NewMutableString (pr);
script->script.token = PR_GetMutableString (pr, script->dstr);
script->pr = pr;
R_INT (pr) = script_index (res, script);
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_Delete (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_get (res, P_INT (pr, 0));
if (!script)
PR_RunError (pr, "invalid script handle");
PR_FreeString (pr, script->dstr);
script_free (res, script);
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_Start (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_get (res, P_INT (pr, 0));
if (!script)
PR_RunError (pr, "invalid script handle");
Script_Start (&script->script, P_GSTRING (pr, 1), P_GSTRING (pr, 2));
R_STRING (pr) = script->dstr;
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_TokenAvailable (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_get (res, P_INT (pr, 0));
if (!script)
PR_RunError (pr, "invalid script handle");
R_INT (pr) = Script_TokenAvailable (&script->script, P_INT (pr, 1));
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_GetToken (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_get (res, P_INT (pr, 0));
if (!script)
PR_RunError (pr, "invalid script handle");
R_INT (pr) = Script_GetToken (&script->script, P_INT (pr, 1));
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_UngetToken (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_get (res, P_INT (pr, 0));
if (!script)
PR_RunError (pr, "invalid script handle");
Script_UngetToken (&script->script);
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_Error (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_get (res, P_INT (pr, 0));
if (!script)
PR_RunError (pr, "invalid script handle");
Make script much friendlier to use It now simply sets an error message pointer and returns false if there's an error.
2020-02-26 00:39:03 +00:00
R_STRING (pr) = PR_SetString (pr, script->script.error);
script->script.error = 0;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
}
static void
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
bi_Script_NoQuoteLines (progs_t *pr, void *_res)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{
[gamecode] Pass registered data pointer to builtins This is the bulk of the work for recording the resource pointer with with builtin data. I don't know how much of a difference it makes for most things, but it's probably pretty big for qwaq-curses due to the very high number of calls to the curses builtins. Closes #26
2022-02-14 03:28:38 +00:00
script_resources_t *res = _res;
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
rua_script_t *script = script_get (res, P_INT (pr, 0));
if (!script)
PR_RunError (pr, "invalid script handle");
R_INT (pr) = script->script.no_quote_lines;
script->script.no_quote_lines = P_INT (pr, 1);
}
[gamecode] Provide builtins with information about their parameters This will make it possible for the engine to set up their parameter pointers when running Ruamoko progs. At this stage, it doesn't matter *too* much, except for varargs functions, because no builtin yet takes anything larger than a float quaternion, but it will be critical when double or long vec3 and vec4 values are passed.
2022-01-23 12:54:03 +00:00
#define bi(x,np,params...) {#x, bi_##x, -1, np, {params}}
#define p(type) PR_PARAM(type)
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
static builtin_t builtins[] = {
[gamecode] Provide builtins with information about their parameters This will make it possible for the engine to set up their parameter pointers when running Ruamoko progs. At this stage, it doesn't matter *too* much, except for varargs functions, because no builtin yet takes anything larger than a float quaternion, but it will be critical when double or long vec3 and vec4 values are passed.
2022-01-23 12:54:03 +00:00
bi(Script_New, 0),
bi(Script_Delete, 1, p(ptr)),
bi(Script_Start, 3, p(ptr), p(string), p(string)),
bi(Script_TokenAvailable, 2, p(ptr), p(int)),
bi(Script_GetToken, 2, p(ptr), p(int)),
bi(Script_UngetToken, 1, p(ptr)),
bi(Script_Error, 1, p(ptr)),
bi(Script_NoQuoteLines, 1, p(ptr)),
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
{0}
};
void
RUA_Script_Init (progs_t *pr, int secure)
{
script_resources_t *res = calloc (1, sizeof (script_resources_t));
[gamecode] Add PR_Shutdown for tearing down a VM This is meant for a "permanent" tear-down before freeing the memory holding the VM state or at program shutdown. As a consequence, builtin sub-systems registering resources are now required to pass a "destroy" function pointer that will be called just before the memory holding those resources is freed by the VM resource manager (ie, the manager owns the resource memory block, but each subsystem is responsible for cleaning up any resources held within that block). This even enhances thread-safety in rua_obj (there are some problems with cmd, cvar, and gib).
2022-05-12 09:23:32 +00:00
PR_Resources_Register (pr, "Script", res, bi_script_clear,
bi_script_destroy);
[gamecode] Add a data pointer passed to builtin functions This is part of the work for #26 (Record resource pointer with builtin function data). Currently, the data pointer gets as far as the per-instance VM function table (I don't feel like tackling the job of converting all the builtin functions tonight). All the builtin modules that register a resources data block pass that block on to PR_RegisterBuiltins.
2022-01-23 15:20:05 +00:00
PR_RegisterBuiltins (pr, builtins, res);
Add a rua wrapper for scripts (seems, to work, too:). Also added generic resource handle support based on strref handling in pr_strings.c. This is an imperfect revision of history.
2004-11-11 04:06:00 +00:00
}
Reference in a new issue Copy permalink