0f81f292b1fa033be2a0fe266f2ccd2148b260b7
[xonotic/darkplaces.git] / progsvm.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
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.
8
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.
12
13 See the GNU General Public License for more details.
14
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.
18
19 */
20 /*
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.
23
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.
27 */
28
29 #ifndef PROGSVM_H
30 #define PROGSVM_H
31
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
35
36 #ifndef DP_SMALLMEMORY
37 #define PROFILING
38 #endif
39
40 // forward declaration of clgecko_t
41 struct clgecko_s;
42
43 typedef struct prvm_stack_s
44 {
45         int                             s;
46         mfunction_t             *f;
47         double                  tprofile_acc;
48         double                  profile_acc;
49         double                  builtinsprofile_acc;
50 } prvm_stack_t;
51
52
53 typedef union prvm_eval_s
54 {
55         string_t                string;
56         float                   _float;
57         float                   vector[3];
58         func_t                  function;
59         int                             ivector[3];
60         int                             _int;
61         int                             edict;
62 } prvm_eval_t;
63
64 typedef struct prvm_required_field_s
65 {
66         int type;
67         const char *name;
68 } prvm_required_field_t;
69
70
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
74 {
75         qboolean free;
76         float freetime;
77         int mark;
78         const char *allocation_origin;
79 } prvm_edict_private_t;
80
81 typedef struct prvm_edict_s
82 {
83         // engine-private fields (stored in dynamically resized array)
84         //edict_engineprivate_t *e;
85         union
86         {
87                 prvm_edict_private_t *required;
88                 vec_t *vp;
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;
97                 //              vec3_t moved_from;
98                 //      vec3_t moved_fromangles;
99                 //              ... } server_edict_private_t;
100                 // or:
101                 //      typedef struct server_edict_private_s {
102                 //              qboolean free;
103                 //              float freetime;
104                 //              vec3_t moved_from;
105                 //      vec3_t moved_fromangles;
106                 //              ... } server_edict_private_t;
107                 // However, the first one should be preferred.
108         } priv;
109         // QuakeC fields (stored in dynamically resized array)
110         union
111         {
112                 vec_t *vp;
113                 entvars_t               *server;
114                 cl_entvars_t    *client;
115         } fields;
116 } prvm_edict_t;
117
118 extern prvm_eval_t prvm_badvalue;
119
120 #if 1
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)
133 #else
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)
146 #endif
147
148 //============================================================================
149 #define PRVM_OP_STATE           1
150
151 #ifdef DP_SMALLMEMORY
152 #define PRVM_MAX_STACK_DEPTH            128
153 #define PRVM_LOCALSTACK_SIZE            2048
154
155 #define PRVM_MAX_OPENFILES 16
156 #define PRVM_MAX_OPENSEARCHES 8
157 #define PRVM_MAX_GECKOINSTANCES 1
158 #else
159 #define PRVM_MAX_STACK_DEPTH            1024
160 #define PRVM_LOCALSTACK_SIZE            16384
161
162 #define PRVM_MAX_OPENFILES 256
163 #define PRVM_MAX_OPENSEARCHES 128
164 #define PRVM_MAX_GECKOINSTANCES 32
165 #endif
166
167 typedef void (*prvm_builtin_t) (void);
168
169 // NOTE: field offsets use -1 for NULL
170 typedef struct prvm_prog_fieldoffsets_s
171 {
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
185         int button3; // ssqc
186         int button4; // ssqc
187         int button5; // ssqc
188         int button6; // ssqc
189         int button7; // ssqc
190         int button8; // ssqc
191         int button9; // ssqc
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
206         int color; // 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
225         int frame2; // csqc
226         int frame2time; // csqc
227         int frame3; // csqc
228         int frame3time; // csqc
229         int frame4; // 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
237         int gravity; // ssqc
238         int groundentity; // ssqc / csqc
239         int hull; // ssqc / csqc
240         int ideal_yaw; // ssqc / csqc
241         int idealpitch; // ssqc / csqc
242         int items2; // ssqc
243         int lerpfrac3; // csqc
244         int lerpfrac4; // csqc
245         int lerpfrac; // csqc
246         int light_lev; // ssqc
247         int message; // csqc
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
254         int pflags; // ssqc
255         int ping; // 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
261         int pmodel; // 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
269         int style; // ssqc
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
279
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)
298
299         int camera_transform; // csqc (warpzones)
300
301         int userwavefunc_param0; // csqc (userwavefunc)
302         int userwavefunc_param1; // csqc (userwavefunc)
303         int userwavefunc_param2; // csqc (userwavefunc)
304         int userwavefunc_param3; // csqc (userwavefunc)
305
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)
311 }
312 prvm_prog_fieldoffsets_t;
313
314 // NOTE: global offsets use -1 for NULL
315 typedef struct prvm_prog_globaloffsets_s
316 {
317         // server and client use a lot of similar globals, so this is combined
318         int SV_InitCmd; // ssqc
319         int self; // common
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
342         int coop; // 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 pmove_onground; // csqc
351         int pmove_inwater; // csqc
352         int require_spawnfunc_prefix; // ssqc
353         int worldstatus; // ssqc
354         int servertime; // csqc
355         int serverprevtime; // csqc
356         int serverdeltatime; // csqc
357         int gettaginfo_name; // ssqc / csqc
358         int gettaginfo_parent; // ssqc / csqc
359         int gettaginfo_offset; // ssqc / csqc
360         int gettaginfo_forward; // ssqc / csqc
361         int gettaginfo_right; // ssqc / csqc
362         int gettaginfo_up; // ssqc / csqc
363         int transparent_offset; // csqc
364
365         int particles_alphamin; // csqc
366         int particles_alphamax; // csqc
367         int particles_colormin; // csqc
368         int particles_colormax; // csqc
369 }
370 prvm_prog_globaloffsets_t;
371
372 // these are initialized using PRVM_ED_FindFunction
373 // NOTE: function offsets use 0 for NULL
374 typedef struct prvm_prog_funcoffsets_s
375 {
376         func_t CSQC_ConsoleCommand; // csqc
377         func_t CSQC_Ent_Remove; // csqc
378         func_t CSQC_Ent_Spawn; // csqc DP_CSQC_ENT_SPAWN extension (BlackHC - TODO: needs to be added to dpextensions.qc)
379         func_t CSQC_Ent_Update; // csqc
380         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...
381         func_t CSQC_Event_Sound; // csqc : called by engine when an incoming sound packet arrives so CSQC can act on it
382         func_t CSQC_Init; // csqc
383         func_t CSQC_InputEvent; // csqc
384         func_t CSQC_Parse_CenterPrint; // csqc
385         func_t CSQC_Parse_Print; // csqc
386         func_t CSQC_Parse_StuffCmd; // csqc
387         func_t CSQC_Parse_TempEntity; // csqc [515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
388         func_t CSQC_Shutdown; // csqc
389         func_t CSQC_UpdateView; // csqc
390         func_t Gecko_Query; // csqc, mqc
391         func_t EndFrame; // ssqc
392         func_t RestoreGame; // ssqc
393         func_t SV_ChangeTeam; // ssqc
394         func_t SV_ParseClientCommand; // ssqc
395         func_t SV_PlayerPhysics; // ssqc
396         func_t SV_OnEntityPreSpawnFunction; // ssqc
397         func_t SV_OnEntityNoSpawnFunction; // ssqc
398         func_t SV_OnEntityPostSpawnFunction; // ssqc
399         func_t GameCommand; // any
400         func_t SV_Shutdown; // ssqc
401         func_t URI_Get_Callback; // any
402         func_t SV_PausedTic; //ssqc
403
404         // menu qc only uses some functions, nothing else
405         func_t m_draw; // mqc
406         func_t m_init; // mqc
407         func_t m_keydown; // mqc
408         func_t m_keyup; // mqc
409         func_t m_shutdown; // mqc
410         func_t m_toggle; // mqc
411         func_t m_newmap; // mqc
412 }
413 prvm_prog_funcoffsets_t;
414
415 // stringbuffer flags
416 #define STRINGBUFFER_SAVED      1 // saved in savegames
417
418 typedef struct prvm_stringbuffer_s
419 {
420         int max_strings;
421         int num_strings;
422         char **strings;
423         const char *origin;
424         unsigned char flags;
425 }
426 prvm_stringbuffer_t;
427
428 // [INIT] variables flagged with this token can be initialized by 'you'
429 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
430 typedef struct prvm_prog_s
431 {
432         double              starttime;
433         unsigned int            id; // increasing unique id of progs instance
434         mfunction_t                     *functions;
435         char                            *strings;
436         int                                     stringssize;
437         ddef_t                          *fielddefs;
438         ddef_t                          *globaldefs;
439         mstatement_t            *statements;
440         int                                     entityfields;                   // number of vec_t fields in progs (some variables are 3)
441         int                                     entityfieldsarea;               // LordHavoc: equal to max_edicts * entityfields (for bounds checking)
442
443         // loaded values from the disk format
444         int                                     progs_version;
445         int                                     progs_crc;
446         int                                     progs_numstatements;
447         int                                     progs_numglobaldefs;
448         int                                     progs_numfielddefs;
449         int                                     progs_numfunctions;
450         int                                     progs_numstrings;
451         int                                     progs_numglobals;
452         int                                     progs_entityfields;
453
454         // real values in memory (some modified by loader)
455         int                                     numstatements;
456         int                                     numglobaldefs;
457         int                                     numfielddefs;
458         int                                     numfunctions;
459         int                                     numstrings;
460         int                                     numglobals;
461
462         int                                     *statement_linenums; // NULL if not available
463
464         double                          *statement_profile; // only incremented if prvm_statementprofiling is on
465
466         union {
467                 vec_t *generic;
468                 globalvars_t *server;
469                 cl_globalvars_t *client;
470         } globals;
471
472         int                                     maxknownstrings;
473         int                                     numknownstrings;
474         // this is updated whenever a string is removed or added
475         // (simple optimization of the free string search)
476         int                                     firstfreeknownstring;
477         const char                      **knownstrings;
478         unsigned char           *knownstrings_freeable;
479         const char          **knownstrings_origin;
480         const char                      ***stringshash;
481
482         memexpandablearray_t    stringbuffersarray;
483
484         // all memory allocations related to this vm_prog (code, edicts, strings)
485         mempool_t                       *progs_mempool; // [INIT]
486
487         prvm_builtin_t          *builtins; // [INIT]
488         int                                     numbuiltins; // [INIT]
489
490         int                                     argc;
491
492         int                                     trace;
493         mfunction_t                     *xfunction;
494         int                                     xstatement;
495
496         // stacktrace writes into stack[MAX_STACK_DEPTH]
497         // thus increase the array, so depth wont be overwritten
498         prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
499         int                                     depth;
500
501         int                                     localstack[PRVM_LOCALSTACK_SIZE];
502         int                                     localstack_used;
503
504         unsigned short          headercrc; // [INIT]
505         unsigned short          headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
506
507         unsigned short          filecrc;
508
509         //============================================================================
510         // until this point everything also exists (with the pr_ prefix) in the old vm
511
512         qfile_t                         *openfiles[PRVM_MAX_OPENFILES];
513         const char *         openfiles_origin[PRVM_MAX_OPENFILES];
514         fssearch_t                      *opensearches[PRVM_MAX_OPENSEARCHES];
515         const char *         opensearches_origin[PRVM_MAX_OPENSEARCHES];
516         struct clgecko_s                *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
517         skeleton_t                      *skeletons[MAX_EDICTS];
518
519         // copies of some vars that were former read from sv
520         int                                     num_edicts;
521         // number of edicts for which space has been (should be) allocated
522         int                                     max_edicts; // [INIT]
523         // used instead of the constant MAX_EDICTS
524         int                                     limit_edicts; // [INIT]
525
526         // number of reserved edicts (allocated from 1)
527         int                                     reserved_edicts; // [INIT]
528
529         prvm_edict_t            *edicts;
530         vec_t                           *edictsfields;
531         void                                    *edictprivate;
532
533         // size of the engine private struct
534         int                                     edictprivate_size; // [INIT]
535
536         prvm_prog_fieldoffsets_t        fieldoffsets;
537         prvm_prog_globaloffsets_t       globaloffsets;
538         prvm_prog_funcoffsets_t         funcoffsets;
539
540         // allow writing to world entity fields, this is set by server init and
541         // cleared before first server frame
542         qboolean                        allowworldwrites;
543
544         // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
545         const char                      *name; // [INIT]
546
547         // flag - used to store general flags like PRVM_GE_SELF, etc.
548         int                             flag;
549
550         const char                      *extensionstring; // [INIT]
551
552         qboolean                        loadintoworld; // [INIT]
553
554         // used to indicate whether a prog is loaded
555         qboolean                        loaded;
556         qboolean                        leaktest_active;
557
558         // translation buffer (only needs to be freed on unloading progs, type is private to prvm_edict.c)
559         void *po;
560
561         // printed together with backtraces
562         const char *statestring;
563
564 //      prvm_builtin_mem_t  *mem_list;
565
566 // now passed as parameter of PRVM_LoadProgs
567 //      char                            **required_func;
568 //      int                                     numrequiredfunc;
569
570         //============================================================================
571
572         ddef_t                          *self; // if self != 0 then there is a global self
573
574         //============================================================================
575         // function pointers
576
577         void                            (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
578         void                            (*end_increase_edicts)(void); // [INIT]
579
580         void                            (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
581         void                            (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
582
583         void                            (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
584
585         qboolean                        (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
586
587         void                            (*init_cmd)(void); // [INIT] used by PRVM_InitProg
588         void                            (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
589
590         void                            (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
591
592         void                            (*ExecuteProgram)(func_t fnum, const char *errormessage); // pointer to one of the *VM_ExecuteProgram functions
593 } prvm_prog_t;
594
595 extern prvm_prog_t * prog;
596
597 #define PRVM_MAXPROGS 3
598 #define PRVM_SERVERPROG 0 // actually not used at the moment
599 #define PRVM_CLIENTPROG 1
600 #define PRVM_MENUPROG   2
601
602 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
603
604 //============================================================================
605 // prvm_cmds part
606
607 extern prvm_builtin_t vm_sv_builtins[];
608 extern prvm_builtin_t vm_cl_builtins[];
609 extern prvm_builtin_t vm_m_builtins[];
610
611 extern const int vm_sv_numbuiltins;
612 extern const int vm_cl_numbuiltins;
613 extern const int vm_m_numbuiltins;
614
615 extern const char * vm_sv_extensions; // client also uses this
616 extern const char * vm_m_extensions;
617
618 void VM_SV_Cmd_Init(void);
619 void VM_SV_Cmd_Reset(void);
620
621 void VM_CL_Cmd_Init(void);
622 void VM_CL_Cmd_Reset(void);
623
624 void VM_M_Cmd_Init(void);
625 void VM_M_Cmd_Reset(void);
626
627 void VM_Cmd_Init(void);
628 void VM_Cmd_Reset(void);
629 //============================================================================
630
631 void PRVM_Init (void);
632
633 #ifdef PROFILING
634 void MVM_ExecuteProgram (func_t fnum, const char *errormessage);
635 void CLVM_ExecuteProgram (func_t fnum, const char *errormessage);
636 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
637 #else
638 #define MVM_ExecuteProgram SVVM_ExecuteProgram
639 #define CLVM_ExecuteProgram SVVM_ExecuteProgram
640 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
641 #endif
642 #define PRVM_ExecuteProgram prog->ExecuteProgram
643
644 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
645 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
646 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
647 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
648 void _PRVM_Free (void *buffer, const char *filename, int fileline);
649 void _PRVM_FreeAll (const char *filename, int fileline);
650
651 void PRVM_Profile (int maxfunctions, double mintime, int sortby);
652 void PRVM_Profile_f (void);
653 void PRVM_ChildProfile_f (void);
654 void PRVM_CallProfile_f (void);
655 void PRVM_PrintFunction_f (void);
656
657 void PRVM_PrintState(void);
658 void PRVM_CrashAll (void);
659 void PRVM_Crash (void);
660 void PRVM_ShortStackTrace(char *buf, size_t bufsize);
661 const char *PRVM_AllocationOrigin(void);
662
663 ddef_t *PRVM_ED_FindField(const char *name);
664 ddef_t *PRVM_ED_FindGlobal(const char *name);
665 mfunction_t *PRVM_ED_FindFunction(const char *name);
666
667 int PRVM_ED_FindFieldOffset(const char *name);
668 int PRVM_ED_FindGlobalOffset(const char *name);
669 func_t PRVM_ED_FindFunctionOffset(const char *name);
670 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
671 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
672
673 void PRVM_MEM_IncreaseEdicts(void);
674
675 qboolean PRVM_ED_CanAlloc(prvm_edict_t *e);
676 prvm_edict_t *PRVM_ED_Alloc (void);
677 void PRVM_ED_Free (prvm_edict_t *ed);
678 void PRVM_ED_ClearEdict (prvm_edict_t *e);
679
680 void PRVM_PrintFunctionStatements (const char *name);
681 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
682 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
683 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
684
685 void PRVM_ED_WriteGlobals (qfile_t *f);
686 void PRVM_ED_ParseGlobals (const char *data);
687
688 void PRVM_ED_LoadFromFile (const char *data);
689
690 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, const char *filename, int fileline);
691 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
692 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
693
694 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
695 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
696 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
697
698 #define PRVM_NEXT_EDICT(e) ((e) + 1)
699
700 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
701 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
702 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
703 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
704
705 //============================================================================
706
707 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
708 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
709 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
710 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
711 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
712 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
713 //#define       PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
714
715 // FIXME: make these go away?
716 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
717 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
718 //#define       PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
719 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
720
721 extern  int             prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
722 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
723
724 void PRVM_Init_Exec(void);
725
726 void PRVM_ED_PrintEdicts_f (void);
727 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
728
729 const char *PRVM_GetString(int num);
730 int PRVM_SetEngineString(const char *s);
731 const char *PRVM_ChangeEngineString(int i, const char *s);
732 int PRVM_SetTempString(const char *s);
733 int PRVM_AllocString(size_t bufferlength, char **pointer);
734 void PRVM_FreeString(int num);
735
736 //============================================================================
737
738 // used as replacement for a prog stack
739 //#define PRVM_DEBUGPRSTACK
740
741 #ifdef PRVM_DEBUGPRSTACK
742 #define PRVM_Begin  if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
743 #define PRVM_End        prog = 0
744 #else
745 #define PRVM_Begin
746 #define PRVM_End        prog = 0
747 #endif
748
749 //#define PRVM_SAFENAME
750 #ifndef PRVM_SAFENAME
751 #       define PRVM_NAME        (prog->name)
752 #else
753 #       define PRVM_NAME        (prog->name ? prog->name : "Unknown prog name")
754 #endif
755
756 // helper macro to make function pointer calls easier
757 #define PRVM_GCALL(func)        if(prog->func) prog->func
758
759 #define PRVM_ERROR              prog->error_cmd
760
761 // other prog handling functions
762 qboolean PRVM_SetProgFromString(const char *str);
763 void PRVM_SetProg(int prognr);
764
765 /*
766 Initializing a vm:
767 Call InitProg with the num
768 Set up the fields marked with [INIT] in the prog struct
769 Load a program with LoadProgs
770 */
771 void PRVM_InitProg(int prognr);
772 // LoadProgs expects to be called right after InitProg
773 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);
774 void PRVM_ResetProg(void);
775
776 qboolean PRVM_ProgLoaded(int prognr);
777
778 int     PRVM_GetProgNr(void);
779
780 void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
781
782 // TODO: fill in the params
783 //void PRVM_Create();
784
785 void VM_GenerateFrameGroupBlend(framegroupblend_t *framegroupblend, const prvm_edict_t *ed);
786 void VM_FrameBlendFromFrameGroupBlend(frameblend_t *frameblend, const framegroupblend_t *framegroupblend, const dp_model_t *model);
787 void VM_UpdateEdictSkeleton(prvm_edict_t *ed, const dp_model_t *edmodel, const frameblend_t *frameblend);
788 void VM_RemoveEdictSkeleton(prvm_edict_t *ed);
789
790 #endif