2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 This is a try to make the vm more generic, it is mainly based on the progs.h file.
22 For the license refer to progs.h.
24 Generic means, less as possible hard-coded links with the other parts of the engine.
25 This means no edict_engineprivate struct usage, etc.
26 The code uses void pointers instead.
32 #include "pr_comp.h" // defs shared with qcc
33 #include "progdefs.h" // generated by program cdefs
34 #include "clprogdefs.h" // generated by program cdefs
36 // forward declaration of clgecko_t
39 typedef struct prvm_stack_s
46 typedef union prvm_eval_s
57 typedef struct prvm_required_field_s
61 } prvm_required_field_t;
64 // AK: I dont call it engine private cause it doesnt really belongs to the engine
65 // it belongs to prvm.
66 typedef struct prvm_edict_private_s
70 } prvm_edict_private_t;
72 typedef struct prvm_edict_s
74 // engine-private fields (stored in dynamically resized array)
75 //edict_engineprivate_t *e;
78 prvm_edict_private_t *required;
80 // FIXME: this server pointer really means world, not server
81 // (it is used by both server qc and client qc, but not menu qc)
82 edict_engineprivate_t *server;
83 // add other private structs as you desire
84 // new structs have to start with the elements of prvm_edit_private_t
85 // e.g. a new struct has to either look like this:
86 // typedef struct server_edict_private_s {
87 // prvm_edict_private_t base;
89 // vec3_t moved_fromangles;
90 // ... } server_edict_private_t;
92 // typedef struct server_edict_private_s {
96 // vec3_t moved_fromangles;
97 // ... } server_edict_private_t;
98 // However, the first one should be preferred.
100 // QuakeC fields (stored in dynamically resized array)
105 cl_entvars_t *client;
109 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)ed->fields.vp + fieldoffset) : NULL)
110 #define PRVM_GLOBALFIELDVALUE(fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)prog->globals.generic + fieldoffset) : NULL)
112 //============================================================================
113 #define PRVM_OP_STATE 1
115 #define PRVM_MAX_STACK_DEPTH 1024
116 #define PRVM_LOCALSTACK_SIZE 16384
118 #define PRVM_MAX_OPENFILES 256
119 #define PRVM_MAX_OPENSEARCHES 128
120 #define PRVM_MAX_GECKOINSTANCES 32
122 typedef void (*prvm_builtin_t) (void);
124 // NOTE: field offsets use -1 for NULL
125 typedef struct prvm_prog_fieldoffsets_s
127 // server and client use a lot of similar fields, so this is combined
128 int SendEntity; // ssqc
130 int alpha; // ssqc / csqc
131 int ammo_cells1; // ssqc - Dissolution of Eternity mission pack
132 int ammo_lava_nails; // ssqc - Dissolution of Eternity mission pack
133 int ammo_multi_rockets; // ssqc - Dissolution of Eternity mission pack
134 int ammo_nails1; // ssqc - Dissolution of Eternity mission pack
135 int ammo_plasma; // ssqc - Dissolution of Eternity mission pack
136 int ammo_rockets1; // ssqc - Dissolution of Eternity mission pack
137 int ammo_shells1; // ssqc - Dissolution of Eternity mission pack
138 int angles; // common - used by changeyaw/changepitch
146 int button10; // ssqc
147 int button11; // ssqc
148 int button12; // ssqc
149 int button13; // ssqc
150 int button14; // ssqc
151 int button15; // ssqc
152 int button16; // ssqc
153 int buttonchat; // ssqc
154 int buttonuse; // ssqc
155 int chain; // common - used by find builtins
156 int classname; // common
157 int clientcolors; // ssqc
159 int colormod; // ssqc / csqc
160 int contentstransition; // ssqc
161 int cursor_active; // ssqc
162 int cursor_screen; // ssqc
163 int cursor_trace_endpos; // ssqc
164 int cursor_trace_ent; // ssqc
165 int cursor_trace_start; // ssqc
166 int customizeentityforclient; // ssqc
167 int dimension_hit; // ssqc / csqc
168 int dimension_solid; // ssqc / csqc
169 int disableclientprediction; // ssqc
170 int dphitcontentsmask; // ssqc / csqc
171 int drawonlytoclient; // ssqc
172 int effects; // ssqc / csqc
173 int exteriormodeltoclient; // ssqc
174 int fatness; // ssqc / csqc
175 int forceshader; // csqc
176 int frame1time; // csqc
178 int frame2time; // csqc
179 int frame; // common - used by OP_STATE
180 int fullbright; // ssqc - Nehahra support
181 int glow_color; // ssqc
182 int glow_size; // ssqc
183 int glow_trail; // ssqc
185 int groundentity; // ssqc / csqc
186 int hull; // ssqc / csqc
187 int ideal_yaw; // ssqc / csqc
188 int idealpitch; // ssqc / csqc
190 int lerpfrac; // csqc
191 int light_lev; // ssqc
193 int modelflags; // ssqc
194 int movement; // ssqc
195 int nextthink; // common - used by OP_STATE
196 int netaddress; // ssqc
197 int nodrawtoclient; // ssqc
200 int pitch_speed; // ssqc / csqc
201 int playermodel; // ssqc
202 int playerskin; // ssqc
204 int punchvector; // ssqc
205 int renderamt; // ssqc - HalfLife support
206 int renderflags; // csqc
207 int rendermode; // ssqc - HalfLife support
208 int scale; // ssqc / csqc
210 int tag_entity; // ssqc / csqc
211 int tag_index; // ssqc / csqc
212 int think; // common - used by OP_STATE
213 int viewmodelforclient; // ssqc
214 int viewzoom; // ssqc
215 int yaw_speed; // ssqc / csqc
216 int clientcamera; // ssqc
218 prvm_prog_fieldoffsets_t;
220 // NOTE: global offsets use -1 for NULL
221 typedef struct prvm_prog_globaloffsets_s
223 // server and client use a lot of similar globals, so this is combined
224 int SV_InitCmd; // ssqc
226 int time; // ssqc / csqc
227 int v_forward; // ssqc / csqc
228 int v_right; // ssqc / csqc
229 int v_up; // ssqc / csqc
230 int view_angles; // csqc
231 int trace_allsolid; // ssqc / csqc
232 int trace_startsolid; // ssqc / csqc
233 int trace_fraction; // ssqc / csqc
234 int trace_inwater; // ssqc / csqc
235 int trace_inopen; // ssqc / csqc
236 int trace_endpos; // ssqc / csqc
237 int trace_plane_normal; // ssqc / csqc
238 int trace_plane_dist; // ssqc / csqc
239 int trace_ent; // ssqc / csqc
240 int trace_dphitcontents; // ssqc / csqc
241 int trace_dphitq3surfaceflags; // ssqc / csqc
242 int trace_dphittexturename; // ssqc / csqc
243 int trace_dpstartcontents; // ssqc / csqc
244 int intermission; // csqc
246 int deathmatch; // csqc
247 int dmg_take; // csqc
248 int dmg_save; // csqc
249 int dmg_origin; // csqc
250 int sb_showscores; // csqc
251 int drawfont; // csqc / menu
253 prvm_prog_globaloffsets_t;
255 // these are initialized using PRVM_ED_FindFunction
256 // NOTE: function offsets use 0 for NULL
257 typedef struct prvm_prog_funcoffsets_s
259 func_t CSQC_ConsoleCommand; // csqc
260 func_t CSQC_Ent_Remove; // csqc
261 func_t CSQC_Ent_Spawn; // csqc DP_CSQC_ENT_SPAWN extension (BlackHC - TODO: needs to be added to dpextensions.qc)
262 func_t CSQC_Ent_Update; // csqc
263 func_t CSQC_Event; // csqc [515]: engine call this for its own needs so csqc can do some things according to what engine it's running on. example: to say about edicts increase, whatever...
264 func_t CSQC_Event_Sound; // csqc : called by engine when an incoming sound packet arrives so CSQC can act on it
265 func_t CSQC_Init; // csqc
266 func_t CSQC_InputEvent; // csqc
267 func_t CSQC_Parse_CenterPrint; // csqc
268 func_t CSQC_Parse_Print; // csqc
269 func_t CSQC_Parse_StuffCmd; // csqc
270 func_t CSQC_Parse_TempEntity; // csqc [515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
271 func_t CSQC_Shutdown; // csqc
272 func_t CSQC_UpdateView; // csqc
273 func_t Gecko_Query; // csqc, mqc
274 func_t EndFrame; // ssqc
275 func_t RestoreGame; // ssqc
276 func_t SV_ChangeTeam; // ssqc
277 func_t SV_ParseClientCommand; // ssqc
278 func_t SV_PlayerPhysics; // ssqc
279 func_t SV_OnEntityNoSpawnFunction; // ssqc
280 func_t GameCommand; // any
281 func_t SV_Shutdown; // ssqc
283 // menu qc only uses some functions, nothing else
284 func_t m_draw; // mqc
285 func_t m_init; // mqc
286 func_t m_keydown; // mqc
287 func_t m_keyup; // mqc
288 func_t m_shutdown; // mqc
289 func_t m_toggle; // mqc
291 prvm_prog_funcoffsets_t;
293 typedef struct prvm_stringbuffer_s
301 // [INIT] variables flagged with this token can be initialized by 'you'
302 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
303 typedef struct prvm_prog_s
307 mfunction_t *functions;
312 dstatement_t *statements;
313 int edict_size; // in bytes
314 int edictareasize; // LordHavoc: in bytes (for bound checking)
316 int *statement_linenums; // NULL if not available
318 double *statement_profile; // only incremented if prvm_statementprofiling is on
322 globalvars_t *server;
323 cl_globalvars_t *client;
328 // this is updated whenever a string is removed or added
329 // (simple optimization of the free string search)
330 int firstfreeknownstring;
331 const char **knownstrings;
332 unsigned char *knownstrings_freeable;
333 const char ***stringshash;
335 memexpandablearray_t stringbuffersarray;
337 // all memory allocations related to this vm_prog (code, edicts, strings)
338 mempool_t *progs_mempool; // [INIT]
340 prvm_builtin_t *builtins; // [INIT]
341 int numbuiltins; // [INIT]
346 mfunction_t *xfunction;
349 // stacktrace writes into stack[MAX_STACK_DEPTH]
350 // thus increase the array, so depth wont be overwritten
351 prvm_stack_t stack[PRVM_MAX_STACK_DEPTH+1];
354 int localstack[PRVM_LOCALSTACK_SIZE];
357 unsigned short headercrc; // [INIT]
358 unsigned short headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
360 unsigned short filecrc;
362 //============================================================================
363 // until this point everything also exists (with the pr_ prefix) in the old vm
365 qfile_t *openfiles[PRVM_MAX_OPENFILES];
366 fssearch_t *opensearches[PRVM_MAX_OPENSEARCHES];
367 struct clgecko_s *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
369 // copies of some vars that were former read from sv
371 // number of edicts for which space has been (should be) allocated
372 int max_edicts; // [INIT]
373 // used instead of the constant MAX_EDICTS
374 int limit_edicts; // [INIT]
376 // number of reserved edicts (allocated from 1)
377 int reserved_edicts; // [INIT]
379 prvm_edict_t *edicts;
383 // size of the engine private struct
384 int edictprivate_size; // [INIT]
386 prvm_prog_fieldoffsets_t fieldoffsets;
387 prvm_prog_globaloffsets_t globaloffsets;
388 prvm_prog_funcoffsets_t funcoffsets;
390 // allow writing to world entity fields, this is set by server init and
391 // cleared before first server frame
392 qboolean allowworldwrites;
394 // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
395 char *name; // [INIT]
397 // flag - used to store general flags like PRVM_GE_SELF, etc.
400 char *extensionstring; // [INIT]
402 qboolean loadintoworld; // [INIT]
404 // used to indicate whether a prog is loaded
407 // prvm_builtin_mem_t *mem_list;
409 // now passed as parameter of PRVM_LoadProgs
410 // char **required_func;
411 // int numrequiredfunc;
413 //============================================================================
415 ddef_t *self; // if self != 0 then there is a global self
417 //============================================================================
420 void (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
421 void (*end_increase_edicts)(void); // [INIT]
423 void (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
424 void (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
426 void (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
428 qboolean (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
430 void (*init_cmd)(void); // [INIT] used by PRVM_InitProg
431 void (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
433 void (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
437 extern prvm_prog_t * prog;
439 #define PRVM_MAXPROGS 3
440 #define PRVM_SERVERPROG 0 // actually not used at the moment
441 #define PRVM_CLIENTPROG 1
442 #define PRVM_MENUPROG 2
444 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
446 //============================================================================
449 extern prvm_builtin_t vm_sv_builtins[];
450 extern prvm_builtin_t vm_cl_builtins[];
451 extern prvm_builtin_t vm_m_builtins[];
453 extern const int vm_sv_numbuiltins;
454 extern const int vm_cl_numbuiltins;
455 extern const int vm_m_numbuiltins;
457 extern char * vm_sv_extensions; // client also uses this
458 extern char * vm_m_extensions;
460 void VM_SV_Cmd_Init(void);
461 void VM_SV_Cmd_Reset(void);
463 void VM_CL_Cmd_Init(void);
464 void VM_CL_Cmd_Reset(void);
466 void VM_M_Cmd_Init(void);
467 void VM_M_Cmd_Reset(void);
469 void VM_Cmd_Init(void);
470 void VM_Cmd_Reset(void);
471 //============================================================================
473 void PRVM_Init (void);
475 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
477 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
478 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
479 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
480 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
481 void _PRVM_Free (void *buffer, const char *filename, int fileline);
482 void _PRVM_FreeAll (const char *filename, int fileline);
484 void PRVM_Profile (int maxfunctions, int mininstructions);
485 void PRVM_Profile_f (void);
486 void PRVM_CallProfile_f (void);
487 void PRVM_PrintFunction_f (void);
489 void PRVM_PrintState(void);
490 void PRVM_CrashAll (void);
491 void PRVM_Crash (void);
493 ddef_t *PRVM_ED_FindField(const char *name);
494 ddef_t *PRVM_ED_FindGlobal(const char *name);
495 mfunction_t *PRVM_ED_FindFunction(const char *name);
497 int PRVM_ED_FindFieldOffset(const char *name);
498 int PRVM_ED_FindGlobalOffset(const char *name);
499 func_t PRVM_ED_FindFunctionOffset(const char *name);
500 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
501 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
503 void PRVM_MEM_IncreaseEdicts(void);
505 prvm_edict_t *PRVM_ED_Alloc (void);
506 void PRVM_ED_Free (prvm_edict_t *ed);
507 void PRVM_ED_ClearEdict (prvm_edict_t *e);
509 void PRVM_PrintFunctionStatements (const char *name);
510 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
511 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
512 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
514 void PRVM_ED_WriteGlobals (qfile_t *f);
515 void PRVM_ED_ParseGlobals (const char *data);
517 void PRVM_ED_LoadFromFile (const char *data);
519 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, char *filename, int fileline);
520 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
521 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
523 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
524 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
525 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
527 #define PRVM_NEXT_EDICT(e) ((e) + 1)
529 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
530 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
531 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
532 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
534 //============================================================================
536 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
537 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
538 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
539 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
540 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
541 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
542 //#define PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
544 // FIXME: make these go away?
545 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
546 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
547 //#define PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
548 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
550 extern int prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
551 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
553 void PRVM_Init_Exec(void);
555 void PRVM_ED_PrintEdicts_f (void);
556 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
558 const char *PRVM_GetString(int num);
559 int PRVM_SetEngineString(const char *s);
560 int PRVM_SetTempString(const char *s);
561 int PRVM_AllocString(size_t bufferlength, char **pointer);
562 void PRVM_FreeString(int num);
564 //============================================================================
566 // used as replacement for a prog stack
567 //#define PRVM_DEBUGPRSTACK
569 #ifdef PRVM_DEBUGPRSTACK
570 #define PRVM_Begin if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
571 #define PRVM_End prog = 0
574 #define PRVM_End prog = 0
577 //#define PRVM_SAFENAME
578 #ifndef PRVM_SAFENAME
579 # define PRVM_NAME (prog->name)
581 # define PRVM_NAME (prog->name ? prog->name : "Unknown prog name")
584 // helper macro to make function pointer calls easier
585 #define PRVM_GCALL(func) if(prog->func) prog->func
587 #define PRVM_ERROR prog->error_cmd
589 // other prog handling functions
590 qboolean PRVM_SetProgFromString(const char *str);
591 void PRVM_SetProg(int prognr);
595 Call InitProg with the num
596 Set up the fields marked with [INIT] in the prog struct
597 Load a program with LoadProgs
599 void PRVM_InitProg(int prognr);
600 // LoadProgs expects to be called right after InitProg
601 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, char **required_global);
602 void PRVM_ResetProg(void);
604 qboolean PRVM_ProgLoaded(int prognr);
606 int PRVM_GetProgNr(void);
608 void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
610 // TODO: fill in the params
611 //void PRVM_Create();