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 #ifndef DP_SMALLMEMORY
40 // forward declaration of clgecko_t
43 typedef struct prvm_stack_s
49 double builtinsprofile_acc;
53 typedef union prvm_eval_s
64 typedef struct prvm_required_field_s
68 } prvm_required_field_t;
71 // AK: I dont call it engine private cause it doesnt really belongs to the engine
72 // it belongs to prvm.
73 typedef struct prvm_edict_private_s
78 const char *allocation_origin;
79 } prvm_edict_private_t;
81 typedef struct prvm_edict_s
83 // engine-private fields (stored in dynamically resized array)
84 //edict_engineprivate_t *e;
87 prvm_edict_private_t *required;
89 // FIXME: this server pointer really means world, not server
90 // (it is used by both server qc and client qc, but not menu qc)
91 edict_engineprivate_t *server;
92 // add other private structs as you desire
93 // new structs have to start with the elements of prvm_edit_private_t
94 // e.g. a new struct has to either look like this:
95 // typedef struct server_edict_private_s {
96 // prvm_edict_private_t base;
98 // vec3_t moved_fromangles;
99 // ... } server_edict_private_t;
101 // typedef struct server_edict_private_s {
104 // vec3_t moved_from;
105 // vec3_t moved_fromangles;
106 // ... } server_edict_private_t;
107 // However, the first one should be preferred.
109 // QuakeC fields (stored in dynamically resized array)
114 cl_entvars_t *client;
118 extern prvm_eval_t prvm_badvalue;
121 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) (fieldoffset < 0 ? Con_Printf("Invalid fieldoffset at %s:%i\n", __FILE__, __LINE__), &prvm_badvalue : (prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))
122 #define PRVM_EDICTFIELDFLOAT(ed, fieldoffset) (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->_float)
123 #define PRVM_EDICTFIELDVECTOR(ed, fieldoffset) (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->vector)
124 #define PRVM_EDICTFIELDSTRING(ed, fieldoffset) (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->string)
125 #define PRVM_EDICTFIELDEDICT(ed, fieldoffset) (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->edict)
126 #define PRVM_EDICTFIELDFUNCTION(ed, fieldoffset) (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->function)
127 #define PRVM_GLOBALFIELDVALUE(fieldoffset) (fieldoffset < 0 ? Con_Printf("Invalid fieldoffset at %s:%i\n", __FILE__, __LINE__), &prvm_badvalue : (prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))
128 #define PRVM_GLOBALFIELDFLOAT(fieldoffset) (PRVM_GLOBALFIELDVALUE(fieldoffset)->_float)
129 #define PRVM_GLOBALFIELDVECTOR(fieldoffset) (PRVM_GLOBALFIELDVALUE(fieldoffset)->vector)
130 #define PRVM_GLOBALFIELDSTRING(fieldoffset) (PRVM_GLOBALFIELDVALUE(fieldoffset)->string)
131 #define PRVM_GLOBALFIELDEDICT(fieldoffset) (PRVM_GLOBALFIELDVALUE(fieldoffset)->edict)
132 #define PRVM_GLOBALFIELDFUNCTION(fieldoffset) (PRVM_GLOBALFIELDVALUE(fieldoffset)->function)
134 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) ((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))
135 #define PRVM_EDICTFIELDFLOAT(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->_float)
136 #define PRVM_EDICTFIELDVECTOR(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->vector)
137 #define PRVM_EDICTFIELDSTRING(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->string)
138 #define PRVM_EDICTFIELDEDICT(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->edict)
139 #define PRVM_EDICTFIELDFUNCTION(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->function)
140 #define PRVM_GLOBALFIELDVALUE(fieldoffset) ((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))
141 #define PRVM_GLOBALFIELDFLOAT(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->_float)
142 #define PRVM_GLOBALFIELDVECTOR(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->vector)
143 #define PRVM_GLOBALFIELDSTRING(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->string)
144 #define PRVM_GLOBALFIELDEDICT(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->edict)
145 #define PRVM_GLOBALFIELDFUNCTION(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->function)
148 //============================================================================
149 #define PRVM_OP_STATE 1
151 #ifdef DP_SMALLMEMORY
152 #define PRVM_MAX_STACK_DEPTH 128
153 #define PRVM_LOCALSTACK_SIZE 2048
155 #define PRVM_MAX_OPENFILES 16
156 #define PRVM_MAX_OPENSEARCHES 8
157 #define PRVM_MAX_GECKOINSTANCES 1
159 #define PRVM_MAX_STACK_DEPTH 1024
160 #define PRVM_LOCALSTACK_SIZE 16384
162 #define PRVM_MAX_OPENFILES 256
163 #define PRVM_MAX_OPENSEARCHES 128
164 #define PRVM_MAX_GECKOINSTANCES 32
167 typedef void (*prvm_builtin_t) (void);
169 // NOTE: field offsets use -1 for NULL
170 typedef struct prvm_prog_fieldoffsets_s
172 // server and client use a lot of similar fields, so this is combined
173 int SendEntity; // ssqc
174 int SendFlags; // ssqc
175 int Version; // ssqc (legacy)
176 int alpha; // ssqc / csqc
177 int ammo_cells1; // ssqc - Dissolution of Eternity mission pack
178 int ammo_lava_nails; // ssqc - Dissolution of Eternity mission pack
179 int ammo_multi_rockets; // ssqc - Dissolution of Eternity mission pack
180 int ammo_nails1; // ssqc - Dissolution of Eternity mission pack
181 int ammo_plasma; // ssqc - Dissolution of Eternity mission pack
182 int ammo_rockets1; // ssqc - Dissolution of Eternity mission pack
183 int ammo_shells1; // ssqc - Dissolution of Eternity mission pack
184 int angles; // common - used by changeyaw/changepitch
192 int button10; // ssqc
193 int button11; // ssqc
194 int button12; // ssqc
195 int button13; // ssqc
196 int button14; // ssqc
197 int button15; // ssqc
198 int button16; // ssqc
199 int buttonchat; // ssqc
200 int buttonuse; // ssqc
201 int chain; // common - used by find builtins
202 int classname; // common
203 int clientcamera; // ssqc
204 int clientcolors; // ssqc
205 int clientstatus; // ssqc
207 int colormod; // ssqc / csqc
208 int contentstransition; // ssqc
209 int cursor_active; // ssqc
210 int cursor_screen; // ssqc
211 int cursor_trace_endpos; // ssqc
212 int cursor_trace_ent; // ssqc
213 int cursor_trace_start; // ssqc
214 int customizeentityforclient; // ssqc
215 int dimension_hit; // ssqc / csqc
216 int dimension_solid; // ssqc / csqc
217 int disableclientprediction; // ssqc
218 int discardabledemo; // ssqc
219 int dphitcontentsmask; // ssqc / csqc
220 int drawonlytoclient; // ssqc
221 int exteriormodeltoclient; // ssqc
222 int fatness; // ssqc / csqc
223 int forceshader; // csqc
224 int frame1time; // csqc
226 int frame2time; // csqc
228 int frame3time; // csqc
230 int frame4time; // csqc
231 int frame; // common - used by OP_STATE
232 int fullbright; // ssqc - Nehahra support
233 int glow_color; // ssqc
234 int glow_size; // ssqc
235 int glow_trail; // ssqc
236 int glowmod; // ssqc / csqc
238 int groundentity; // ssqc / csqc
239 int hull; // ssqc / csqc
240 int ideal_yaw; // ssqc / csqc
241 int idealpitch; // ssqc / csqc
243 int lerpfrac3; // csqc
244 int lerpfrac4; // csqc
245 int lerpfrac; // csqc
246 int light_lev; // ssqc
248 int modelflags; // ssqc
249 int movement; // ssqc
250 int movetypesteplandevent; // ssqc
251 int netaddress; // ssqc
252 int nextthink; // common - used by OP_STATE
253 int nodrawtoclient; // ssqc
256 int ping_packetloss; // ssqc
257 int ping_movementloss; // ssqc
258 int pitch_speed; // ssqc / csqc
259 int playermodel; // ssqc
260 int playerskin; // ssqc
262 int punchvector; // ssqc
263 int renderamt; // ssqc - HalfLife support
264 int renderflags; // csqc
265 int rendermode; // ssqc - HalfLife support
266 int scale; // ssqc / csqc
267 int shadertime; // csqc
268 int skeletonindex; // csqc / ssqc FTE_CSQC_SKELETONOBJECTS / DP_SKELETONOBJECTS
270 int tag_entity; // ssqc / csqc
271 int tag_index; // ssqc / csqc
272 int think; // common - used by OP_STATE
273 int viewmodelforclient; // ssqc
274 int viewzoom; // ssqc
275 int yaw_speed; // ssqc / csqc
276 int bouncefactor; // ssqc
277 int bouncestop; // ssqc
278 int sendcomplexanimation; // ssqc
280 int solid; // ssqc / csqc (physics)
281 int movetype; // ssqc / csqc (physics)
282 int modelindex; // ssqc / csqc (physics)
283 int mins; // ssqc / csqc (physics)
284 int maxs; // ssqc / csqc (physics)
285 int mass; // ssqc / csqc (physics)
286 int origin; // ssqc / csqc (physics)
287 int velocity; // ssqc / csqc (physics)
288 //int axis_forward; // ssqc / csqc (physics)
289 //int axis_left; // ssqc / csqc (physics)
290 //int axis_up; // ssqc / csqc (physics)
291 //int spinvelocity; // ssqc / csqc (physics)
292 //int angles; // ssqc / csqc (physics)
293 int avelocity; // ssqc / csqc (physics)
294 int jointtype; // ssqc / csqc (physics)
295 int enemy; // ssqc / csqc (physics)
296 int aiment; // ssqc / csqc (physics)
297 int movedir; // ssqc / csqc (physics)
299 int camera_transform; // csqc (warpzones)
301 int userwavefunc_param0; // csqc (userwavefunc)
302 int userwavefunc_param1; // csqc (userwavefunc)
303 int userwavefunc_param2; // csqc (userwavefunc)
304 int userwavefunc_param3; // csqc (userwavefunc)
306 int crypto_keyfp; // ssqc (DP_CRYPTO)
307 int crypto_mykeyfp; // ssqc (DP_CRYPTO)
308 int crypto_idfp; // ssqc (DP_CRYPTO)
309 int crypto_encryptmethod; // ssqc (DP_CRYPTO)
310 int crypto_signmethod; // ssqc (DP_CRYPTO)
312 prvm_prog_fieldoffsets_t;
314 // NOTE: global offsets use -1 for NULL
315 typedef struct prvm_prog_globaloffsets_s
317 // server and client use a lot of similar globals, so this is combined
318 int SV_InitCmd; // ssqc
320 int time; // ssqc / csqc
321 int v_forward; // ssqc / csqc
322 int v_right; // ssqc / csqc
323 int v_up; // ssqc / csqc
324 int view_angles; // csqc
325 int view_punchangle; // csqc
326 int view_punchvector; // csqc
327 int trace_allsolid; // ssqc / csqc
328 int trace_startsolid; // ssqc / csqc
329 int trace_fraction; // ssqc / csqc
330 int trace_inwater; // ssqc / csqc
331 int trace_inopen; // ssqc / csqc
332 int trace_endpos; // ssqc / csqc
333 int trace_plane_normal; // ssqc / csqc
334 int trace_plane_dist; // ssqc / csqc
335 int trace_ent; // ssqc / csqc
336 int trace_networkentity; // csqc
337 int trace_dphitcontents; // ssqc / csqc
338 int trace_dphitq3surfaceflags; // ssqc / csqc
339 int trace_dphittexturename; // ssqc / csqc
340 int trace_dpstartcontents; // ssqc / csqc
341 int intermission; // csqc
343 int deathmatch; // csqc
344 int dmg_take; // csqc
345 int dmg_save; // csqc
346 int dmg_origin; // csqc
347 int sb_showscores; // csqc
348 int drawfont; // csqc / menu
349 int drawfontscale; // csqc / menu
350 int require_spawnfunc_prefix; // ssqc
351 int worldstatus; // ssqc
352 int servertime; // csqc
353 int serverprevtime; // csqc
354 int serverdeltatime; // csqc
355 int gettaginfo_name; // ssqc / csqc
356 int gettaginfo_parent; // ssqc / csqc
357 int gettaginfo_offset; // ssqc / csqc
358 int gettaginfo_forward; // ssqc / csqc
359 int gettaginfo_right; // ssqc / csqc
360 int gettaginfo_up; // ssqc / csqc
361 int transparent_offset; // csqc
363 int particles_alphamin; // csqc
364 int particles_alphamax; // csqc
365 int particles_colormin; // csqc
366 int particles_colormax; // csqc
368 prvm_prog_globaloffsets_t;
370 // these are initialized using PRVM_ED_FindFunction
371 // NOTE: function offsets use 0 for NULL
372 typedef struct prvm_prog_funcoffsets_s
374 func_t CSQC_ConsoleCommand; // csqc
375 func_t CSQC_Ent_Remove; // csqc
376 func_t CSQC_Ent_Spawn; // csqc DP_CSQC_ENT_SPAWN extension (BlackHC - TODO: needs to be added to dpextensions.qc)
377 func_t CSQC_Ent_Update; // csqc
378 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...
379 func_t CSQC_Event_Sound; // csqc : called by engine when an incoming sound packet arrives so CSQC can act on it
380 func_t CSQC_Init; // csqc
381 func_t CSQC_InputEvent; // csqc
382 func_t CSQC_Parse_CenterPrint; // csqc
383 func_t CSQC_Parse_Print; // csqc
384 func_t CSQC_Parse_StuffCmd; // csqc
385 func_t CSQC_Parse_TempEntity; // csqc [515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
386 func_t CSQC_Shutdown; // csqc
387 func_t CSQC_UpdateView; // csqc
388 func_t Gecko_Query; // csqc, mqc
389 func_t EndFrame; // ssqc
390 func_t RestoreGame; // ssqc
391 func_t SV_ChangeTeam; // ssqc
392 func_t SV_ParseClientCommand; // ssqc
393 func_t SV_PlayerPhysics; // ssqc
394 func_t SV_OnEntityPreSpawnFunction; // ssqc
395 func_t SV_OnEntityNoSpawnFunction; // ssqc
396 func_t SV_OnEntityPostSpawnFunction; // ssqc
397 func_t GameCommand; // any
398 func_t SV_Shutdown; // ssqc
399 func_t URI_Get_Callback; // any
400 func_t SV_PausedTic; //ssqc
402 // menu qc only uses some functions, nothing else
403 func_t m_draw; // mqc
404 func_t m_init; // mqc
405 func_t m_keydown; // mqc
406 func_t m_keyup; // mqc
407 func_t m_shutdown; // mqc
408 func_t m_toggle; // mqc
409 func_t m_newmap; // mqc
411 prvm_prog_funcoffsets_t;
413 // stringbuffer flags
414 #define STRINGBUFFER_SAVED 1 // saved in savegames
416 typedef struct prvm_stringbuffer_s
426 // [INIT] variables flagged with this token can be initialized by 'you'
427 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
428 typedef struct prvm_prog_s
431 unsigned int id; // increasing unique id of progs instance
432 mfunction_t *functions;
437 mstatement_t *statements;
438 int entityfields; // number of vec_t fields in progs (some variables are 3)
439 int entityfieldsarea; // LordHavoc: equal to max_edicts * entityfields (for bounds checking)
441 // loaded values from the disk format
444 int progs_numstatements;
445 int progs_numglobaldefs;
446 int progs_numfielddefs;
447 int progs_numfunctions;
448 int progs_numstrings;
449 int progs_numglobals;
450 int progs_entityfields;
452 // real values in memory (some modified by loader)
460 int *statement_linenums; // NULL if not available
462 double *statement_profile; // only incremented if prvm_statementprofiling is on
466 globalvars_t *server;
467 cl_globalvars_t *client;
472 // this is updated whenever a string is removed or added
473 // (simple optimization of the free string search)
474 int firstfreeknownstring;
475 const char **knownstrings;
476 unsigned char *knownstrings_freeable;
477 const char **knownstrings_origin;
478 const char ***stringshash;
480 memexpandablearray_t stringbuffersarray;
482 // all memory allocations related to this vm_prog (code, edicts, strings)
483 mempool_t *progs_mempool; // [INIT]
485 prvm_builtin_t *builtins; // [INIT]
486 int numbuiltins; // [INIT]
491 mfunction_t *xfunction;
494 // stacktrace writes into stack[MAX_STACK_DEPTH]
495 // thus increase the array, so depth wont be overwritten
496 prvm_stack_t stack[PRVM_MAX_STACK_DEPTH+1];
499 int localstack[PRVM_LOCALSTACK_SIZE];
502 unsigned short headercrc; // [INIT]
503 unsigned short headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
505 unsigned short filecrc;
507 //============================================================================
508 // until this point everything also exists (with the pr_ prefix) in the old vm
510 qfile_t *openfiles[PRVM_MAX_OPENFILES];
511 const char * openfiles_origin[PRVM_MAX_OPENFILES];
512 fssearch_t *opensearches[PRVM_MAX_OPENSEARCHES];
513 const char * opensearches_origin[PRVM_MAX_OPENSEARCHES];
514 struct clgecko_s *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
515 skeleton_t *skeletons[MAX_EDICTS];
517 // copies of some vars that were former read from sv
519 // number of edicts for which space has been (should be) allocated
520 int max_edicts; // [INIT]
521 // used instead of the constant MAX_EDICTS
522 int limit_edicts; // [INIT]
524 // number of reserved edicts (allocated from 1)
525 int reserved_edicts; // [INIT]
527 prvm_edict_t *edicts;
531 // size of the engine private struct
532 int edictprivate_size; // [INIT]
534 prvm_prog_fieldoffsets_t fieldoffsets;
535 prvm_prog_globaloffsets_t globaloffsets;
536 prvm_prog_funcoffsets_t funcoffsets;
538 // allow writing to world entity fields, this is set by server init and
539 // cleared before first server frame
540 qboolean allowworldwrites;
542 // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
543 const char *name; // [INIT]
545 // flag - used to store general flags like PRVM_GE_SELF, etc.
548 const char *extensionstring; // [INIT]
550 qboolean loadintoworld; // [INIT]
552 // used to indicate whether a prog is loaded
554 qboolean leaktest_active;
556 // translation buffer (only needs to be freed on unloading progs, type is private to prvm_edict.c)
559 // printed together with backtraces
560 const char *statestring;
562 // prvm_builtin_mem_t *mem_list;
564 // now passed as parameter of PRVM_LoadProgs
565 // char **required_func;
566 // int numrequiredfunc;
568 //============================================================================
570 ddef_t *self; // if self != 0 then there is a global self
572 //============================================================================
575 void (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
576 void (*end_increase_edicts)(void); // [INIT]
578 void (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
579 void (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
581 void (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
583 qboolean (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
585 void (*init_cmd)(void); // [INIT] used by PRVM_InitProg
586 void (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
588 void (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
590 void (*ExecuteProgram)(func_t fnum, const char *errormessage); // pointer to one of the *VM_ExecuteProgram functions
593 extern prvm_prog_t * prog;
595 #define PRVM_MAXPROGS 3
596 #define PRVM_SERVERPROG 0 // actually not used at the moment
597 #define PRVM_CLIENTPROG 1
598 #define PRVM_MENUPROG 2
600 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
602 //============================================================================
605 extern prvm_builtin_t vm_sv_builtins[];
606 extern prvm_builtin_t vm_cl_builtins[];
607 extern prvm_builtin_t vm_m_builtins[];
609 extern const int vm_sv_numbuiltins;
610 extern const int vm_cl_numbuiltins;
611 extern const int vm_m_numbuiltins;
613 extern const char * vm_sv_extensions; // client also uses this
614 extern const char * vm_m_extensions;
616 void VM_SV_Cmd_Init(void);
617 void VM_SV_Cmd_Reset(void);
619 void VM_CL_Cmd_Init(void);
620 void VM_CL_Cmd_Reset(void);
622 void VM_M_Cmd_Init(void);
623 void VM_M_Cmd_Reset(void);
625 void VM_Cmd_Init(void);
626 void VM_Cmd_Reset(void);
627 //============================================================================
629 void PRVM_Init (void);
632 void MVM_ExecuteProgram (func_t fnum, const char *errormessage);
633 void CLVM_ExecuteProgram (func_t fnum, const char *errormessage);
634 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
636 #define MVM_ExecuteProgram SVVM_ExecuteProgram
637 #define CLVM_ExecuteProgram SVVM_ExecuteProgram
638 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
640 #define PRVM_ExecuteProgram prog->ExecuteProgram
642 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
643 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
644 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
645 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
646 void _PRVM_Free (void *buffer, const char *filename, int fileline);
647 void _PRVM_FreeAll (const char *filename, int fileline);
649 void PRVM_Profile (int maxfunctions, double mintime, int sortby);
650 void PRVM_Profile_f (void);
651 void PRVM_ChildProfile_f (void);
652 void PRVM_CallProfile_f (void);
653 void PRVM_PrintFunction_f (void);
655 void PRVM_PrintState(void);
656 void PRVM_CrashAll (void);
657 void PRVM_Crash (void);
658 void PRVM_ShortStackTrace(char *buf, size_t bufsize);
659 const char *PRVM_AllocationOrigin(void);
661 ddef_t *PRVM_ED_FindField(const char *name);
662 ddef_t *PRVM_ED_FindGlobal(const char *name);
663 mfunction_t *PRVM_ED_FindFunction(const char *name);
665 int PRVM_ED_FindFieldOffset(const char *name);
666 int PRVM_ED_FindGlobalOffset(const char *name);
667 func_t PRVM_ED_FindFunctionOffset(const char *name);
668 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
669 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
671 void PRVM_MEM_IncreaseEdicts(void);
673 qboolean PRVM_ED_CanAlloc(prvm_edict_t *e);
674 prvm_edict_t *PRVM_ED_Alloc (void);
675 void PRVM_ED_Free (prvm_edict_t *ed);
676 void PRVM_ED_ClearEdict (prvm_edict_t *e);
678 void PRVM_PrintFunctionStatements (const char *name);
679 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
680 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
681 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
683 void PRVM_ED_WriteGlobals (qfile_t *f);
684 void PRVM_ED_ParseGlobals (const char *data);
686 void PRVM_ED_LoadFromFile (const char *data);
688 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, const char *filename, int fileline);
689 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
690 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
692 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
693 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
694 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
696 #define PRVM_NEXT_EDICT(e) ((e) + 1)
698 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
699 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
700 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
701 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
703 //============================================================================
705 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
706 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
707 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
708 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
709 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
710 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
711 //#define PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
713 // FIXME: make these go away?
714 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
715 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
716 //#define PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
717 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
719 extern int prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
720 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
722 void PRVM_Init_Exec(void);
724 void PRVM_ED_PrintEdicts_f (void);
725 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
727 const char *PRVM_GetString(int num);
728 int PRVM_SetEngineString(const char *s);
729 const char *PRVM_ChangeEngineString(int i, const char *s);
730 int PRVM_SetTempString(const char *s);
731 int PRVM_AllocString(size_t bufferlength, char **pointer);
732 void PRVM_FreeString(int num);
734 //============================================================================
736 // used as replacement for a prog stack
737 //#define PRVM_DEBUGPRSTACK
739 #ifdef PRVM_DEBUGPRSTACK
740 #define PRVM_Begin if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
741 #define PRVM_End prog = 0
744 #define PRVM_End prog = 0
747 //#define PRVM_SAFENAME
748 #ifndef PRVM_SAFENAME
749 # define PRVM_NAME (prog->name)
751 # define PRVM_NAME (prog->name ? prog->name : "Unknown prog name")
754 // helper macro to make function pointer calls easier
755 #define PRVM_GCALL(func) if(prog->func) prog->func
757 #define PRVM_ERROR prog->error_cmd
759 // other prog handling functions
760 qboolean PRVM_SetProgFromString(const char *str);
761 void PRVM_SetProg(int prognr);
765 Call InitProg with the num
766 Set up the fields marked with [INIT] in the prog struct
767 Load a program with LoadProgs
769 void PRVM_InitProg(int prognr);
770 // LoadProgs expects to be called right after InitProg
771 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, const char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, prvm_required_field_t *required_global);
772 void PRVM_ResetProg(void);
774 qboolean PRVM_ProgLoaded(int prognr);
776 int PRVM_GetProgNr(void);
778 void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
780 // TODO: fill in the params
781 //void PRVM_Create();
783 void VM_GenerateFrameGroupBlend(framegroupblend_t *framegroupblend, const prvm_edict_t *ed);
784 void VM_FrameBlendFromFrameGroupBlend(frameblend_t *frameblend, const framegroupblend_t *framegroupblend, const dp_model_t *model);
785 void VM_UpdateEdictSkeleton(prvm_edict_t *ed, const dp_model_t *edmodel, const frameblend_t *frameblend);
786 void VM_RemoveEdictSkeleton(prvm_edict_t *ed);