enable the separate CLVM_ and MVM_ExecuteProgram functions unless
[divverent/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                  profile_acc;
48         double                  builtinsprofile_acc;
49 } prvm_stack_t;
50
51
52 typedef union prvm_eval_s
53 {
54         string_t                string;
55         float                   _float;
56         float                   vector[3];
57         func_t                  function;
58         int                             ivector[3];
59         int                             _int;
60         int                             edict;
61 } prvm_eval_t;
62
63 typedef struct prvm_required_field_s
64 {
65         int type;
66         const char *name;
67 } prvm_required_field_t;
68
69
70 // AK: I dont call it engine private cause it doesnt really belongs to the engine
71 //     it belongs to prvm.
72 typedef struct prvm_edict_private_s
73 {
74         qboolean free;
75         float freetime;
76         int mark;
77         const char *allocation_origin;
78 } prvm_edict_private_t;
79
80 typedef struct prvm_edict_s
81 {
82         // engine-private fields (stored in dynamically resized array)
83         //edict_engineprivate_t *e;
84         union
85         {
86                 prvm_edict_private_t *required;
87                 vec_t *vp;
88                 // FIXME: this server pointer really means world, not server
89                 // (it is used by both server qc and client qc, but not menu qc)
90                 edict_engineprivate_t *server;
91                 // add other private structs as you desire
92                 // new structs have to start with the elements of prvm_edit_private_t
93                 // e.g. a new struct has to either look like this:
94                 //      typedef struct server_edict_private_s {
95                 //              prvm_edict_private_t base;
96                 //              vec3_t moved_from;
97                 //      vec3_t moved_fromangles;
98                 //              ... } server_edict_private_t;
99                 // or:
100                 //      typedef struct server_edict_private_s {
101                 //              qboolean free;
102                 //              float freetime;
103                 //              vec3_t moved_from;
104                 //      vec3_t moved_fromangles;
105                 //              ... } server_edict_private_t;
106                 // However, the first one should be preferred.
107         } priv;
108         // QuakeC fields (stored in dynamically resized array)
109         union
110         {
111                 vec_t *vp;
112                 entvars_t               *server;
113                 cl_entvars_t    *client;
114         } fields;
115 } prvm_edict_t;
116
117 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)ed->fields.vp + fieldoffset) : NULL)
118 #define PRVM_GLOBALFIELDVALUE(fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)prog->globals.generic + fieldoffset) : NULL)
119
120 //============================================================================
121 #define PRVM_OP_STATE           1
122
123 #ifdef DP_SMALLMEMORY
124 #define PRVM_MAX_STACK_DEPTH            128
125 #define PRVM_LOCALSTACK_SIZE            2048
126
127 #define PRVM_MAX_OPENFILES 16
128 #define PRVM_MAX_OPENSEARCHES 8
129 #define PRVM_MAX_GECKOINSTANCES 1
130 #else
131 #define PRVM_MAX_STACK_DEPTH            1024
132 #define PRVM_LOCALSTACK_SIZE            16384
133
134 #define PRVM_MAX_OPENFILES 256
135 #define PRVM_MAX_OPENSEARCHES 128
136 #define PRVM_MAX_GECKOINSTANCES 32
137 #endif
138
139 typedef void (*prvm_builtin_t) (void);
140
141 // NOTE: field offsets use -1 for NULL
142 typedef struct prvm_prog_fieldoffsets_s
143 {
144         // server and client use a lot of similar fields, so this is combined
145         int SendEntity; // ssqc
146         int SendFlags; // ssqc
147         int Version; // ssqc (legacy)
148         int alpha; // ssqc / csqc
149         int ammo_cells1; // ssqc - Dissolution of Eternity mission pack
150         int ammo_lava_nails; // ssqc - Dissolution of Eternity mission pack
151         int ammo_multi_rockets; // ssqc - Dissolution of Eternity mission pack
152         int ammo_nails1; // ssqc - Dissolution of Eternity mission pack
153         int ammo_plasma; // ssqc - Dissolution of Eternity mission pack
154         int ammo_rockets1; // ssqc - Dissolution of Eternity mission pack
155         int ammo_shells1; // ssqc - Dissolution of Eternity mission pack
156         int angles; // common - used by changeyaw/changepitch
157         int button3; // ssqc
158         int button4; // ssqc
159         int button5; // ssqc
160         int button6; // ssqc
161         int button7; // ssqc
162         int button8; // ssqc
163         int button9; // ssqc
164         int button10; // ssqc
165         int button11; // ssqc
166         int button12; // ssqc
167         int button13; // ssqc
168         int button14; // ssqc
169         int button15; // ssqc
170         int button16; // ssqc
171         int buttonchat; // ssqc
172         int buttonuse; // ssqc
173         int chain; // common - used by find builtins
174         int classname; // common
175         int clientcamera; // ssqc
176         int clientcolors; // ssqc
177         int clientstatus; // ssqc
178         int color; // ssqc
179         int colormod; // ssqc / csqc
180         int contentstransition; // ssqc
181         int cursor_active; // ssqc
182         int cursor_screen; // ssqc
183         int cursor_trace_endpos; // ssqc
184         int cursor_trace_ent; // ssqc
185         int cursor_trace_start; // ssqc
186         int customizeentityforclient; // ssqc
187         int dimension_hit; // ssqc / csqc
188         int dimension_solid; // ssqc / csqc
189         int disableclientprediction; // ssqc
190         int dphitcontentsmask; // ssqc / csqc
191         int drawonlytoclient; // ssqc
192         int effects; // ssqc / csqc
193         int exteriormodeltoclient; // ssqc
194         int fatness; // ssqc / csqc
195         int forceshader; // csqc
196         int frame1time; // csqc
197         int frame2; // csqc
198         int frame2time; // csqc
199         int frame3; // csqc
200         int frame3time; // csqc
201         int frame4; // csqc
202         int frame4time; // csqc
203         int frame; // common - used by OP_STATE
204         int fullbright; // ssqc - Nehahra support
205         int glow_color; // ssqc
206         int glow_size; // ssqc
207         int glow_trail; // ssqc
208         int glowmod; // ssqc / csqc
209         int gravity; // ssqc
210         int groundentity; // ssqc / csqc
211         int hull; // ssqc / csqc
212         int ideal_yaw; // ssqc / csqc
213         int idealpitch; // ssqc / csqc
214         int items2; // ssqc
215         int lerpfrac3; // csqc
216         int lerpfrac4; // csqc
217         int lerpfrac; // csqc
218         int light_lev; // ssqc
219         int message; // csqc
220         int modelflags; // ssqc
221         int movement; // ssqc
222         int movetypesteplandevent; // ssqc
223         int netaddress; // ssqc
224         int nextthink; // common - used by OP_STATE
225         int nodrawtoclient; // ssqc
226         int pflags; // ssqc
227         int ping; // ssqc
228         int packetloss; // ssqc
229         int movementloss; // ssqc
230         int pitch_speed; // ssqc / csqc
231         int playermodel; // ssqc
232         int playerskin; // ssqc
233         int pmodel; // ssqc
234         int punchvector; // ssqc
235         int renderamt; // ssqc - HalfLife support
236         int renderflags; // csqc
237         int rendermode; // ssqc - HalfLife support
238         int scale; // ssqc / csqc
239         int shadertime; // csqc
240         int skeletonindex; // csqc / ssqc FTE_CSQC_SKELETONOBJECTS / DP_SKELETONOBJECTS
241         int style; // ssqc
242         int tag_entity; // ssqc / csqc
243         int tag_index; // ssqc / csqc
244         int think; // common - used by OP_STATE
245         int viewmodelforclient; // ssqc
246         int viewzoom; // ssqc
247         int yaw_speed; // ssqc / csqc
248         int bouncefactor; // ssqc
249         int bouncestop; // ssqc
250
251         int solid; // ssqc / csqc (physics)
252         int movetype; // ssqc / csqc (physics)
253         int modelindex; // ssqc / csqc (physics)
254         int mins; // ssqc / csqc (physics)
255         int maxs; // ssqc / csqc (physics)
256         int mass; // ssqc / csqc (physics)
257         int origin; // ssqc / csqc (physics)
258         int velocity; // ssqc / csqc (physics)
259         //int axis_forward; // ssqc / csqc (physics)
260         //int axis_left; // ssqc / csqc (physics)
261         //int axis_up; // ssqc / csqc (physics)
262         //int spinvelocity; // ssqc / csqc (physics)
263         //int angles; // ssqc / csqc (physics)
264         int avelocity; // ssqc / csqc (physics)
265         int jointtype; // ssqc / csqc (physics)
266         int enemy; // ssqc / csqc (physics)
267         int aiment; // ssqc / csqc (physics)
268         int movedir; // ssqc / csqc (physics)
269 }
270 prvm_prog_fieldoffsets_t;
271
272 // NOTE: global offsets use -1 for NULL
273 typedef struct prvm_prog_globaloffsets_s
274 {
275         // server and client use a lot of similar globals, so this is combined
276         int SV_InitCmd; // ssqc
277         int self; // common
278         int time; // ssqc / csqc
279         int v_forward; // ssqc / csqc
280         int v_right; // ssqc / csqc
281         int v_up; // ssqc / csqc
282         int view_angles; // csqc
283         int trace_allsolid; // ssqc / csqc
284         int trace_startsolid; // ssqc / csqc
285         int trace_fraction; // ssqc / csqc
286         int trace_inwater; // ssqc / csqc
287         int trace_inopen; // ssqc / csqc
288         int trace_endpos; // ssqc / csqc
289         int trace_plane_normal; // ssqc / csqc
290         int trace_plane_dist; // ssqc / csqc
291         int trace_ent; // ssqc / csqc
292         int trace_networkentity; // csqc
293         int trace_dphitcontents; // ssqc / csqc
294         int trace_dphitq3surfaceflags; // ssqc / csqc
295         int trace_dphittexturename; // ssqc / csqc
296         int trace_dpstartcontents; // ssqc / csqc
297         int intermission; // csqc
298         int coop; // csqc
299         int deathmatch; // csqc
300         int dmg_take; // csqc
301         int dmg_save; // csqc
302         int dmg_origin; // csqc
303         int sb_showscores; // csqc
304         int drawfont; // csqc / menu
305         int drawfontscale; // csqc / menu
306         int require_spawnfunc_prefix; // ssqc
307         int worldstatus; // ssqc
308         int servertime; // csqc
309         int serverprevtime; // csqc
310         int serverdeltatime; // csqc
311         int gettaginfo_name; // ssqc / csqc
312         int gettaginfo_parent; // ssqc / csqc
313         int gettaginfo_offset; // ssqc / csqc
314         int gettaginfo_forward; // ssqc / csqc
315         int gettaginfo_right; // ssqc / csqc
316         int gettaginfo_up; // ssqc / csqc
317         int transparent_offset; // csqc
318 }
319 prvm_prog_globaloffsets_t;
320
321 // these are initialized using PRVM_ED_FindFunction
322 // NOTE: function offsets use 0 for NULL
323 typedef struct prvm_prog_funcoffsets_s
324 {
325         func_t CSQC_ConsoleCommand; // csqc
326         func_t CSQC_Ent_Remove; // csqc
327         func_t CSQC_Ent_Spawn; // csqc DP_CSQC_ENT_SPAWN extension (BlackHC - TODO: needs to be added to dpextensions.qc)
328         func_t CSQC_Ent_Update; // csqc
329         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...
330         func_t CSQC_Event_Sound; // csqc : called by engine when an incoming sound packet arrives so CSQC can act on it
331         func_t CSQC_Init; // csqc
332         func_t CSQC_InputEvent; // csqc
333         func_t CSQC_Parse_CenterPrint; // csqc
334         func_t CSQC_Parse_Print; // csqc
335         func_t CSQC_Parse_StuffCmd; // csqc
336         func_t CSQC_Parse_TempEntity; // csqc [515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
337         func_t CSQC_Shutdown; // csqc
338         func_t CSQC_UpdateView; // csqc
339         func_t Gecko_Query; // csqc, mqc
340         func_t EndFrame; // ssqc
341         func_t RestoreGame; // ssqc
342         func_t SV_ChangeTeam; // ssqc
343         func_t SV_ParseClientCommand; // ssqc
344         func_t SV_PlayerPhysics; // ssqc
345         func_t SV_OnEntityPreSpawnFunction; // ssqc
346         func_t SV_OnEntityNoSpawnFunction; // ssqc
347         func_t SV_OnEntityPostSpawnFunction; // ssqc
348         func_t GameCommand; // any
349         func_t SV_Shutdown; // ssqc
350         func_t URI_Get_Callback; // any
351         func_t SV_PausedTic; //ssqc
352
353         // menu qc only uses some functions, nothing else
354         func_t m_draw; // mqc
355         func_t m_init; // mqc
356         func_t m_keydown; // mqc
357         func_t m_keyup; // mqc
358         func_t m_shutdown; // mqc
359         func_t m_toggle; // mqc
360 }
361 prvm_prog_funcoffsets_t;
362
363 typedef struct prvm_stringbuffer_s
364 {
365         int max_strings;
366         int num_strings;
367         char **strings;
368         const char *origin;
369 }
370 prvm_stringbuffer_t;
371
372 // [INIT] variables flagged with this token can be initialized by 'you'
373 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
374 typedef struct prvm_prog_s
375 {
376         double              starttime;
377         unsigned int            id; // increasing unique id of progs instance
378         dprograms_t                     *progs;
379         mfunction_t                     *functions;
380         char                            *strings;
381         int                                     stringssize;
382         ddef_t                          *fielddefs;
383         ddef_t                          *globaldefs;
384         dstatement_t            *statements;
385         int                                     entityfields;                   // number of vec_t fields in progs (some variables are 3)
386         int                                     entityfieldsarea;               // LordHavoc: equal to max_edicts * entityfields (for bounds checking)
387
388         int                                     *statement_linenums; // NULL if not available
389
390         double                          *statement_profile; // only incremented if prvm_statementprofiling is on
391
392         union {
393                 vec_t *generic;
394                 globalvars_t *server;
395                 cl_globalvars_t *client;
396         } globals;
397
398         int                                     maxknownstrings;
399         int                                     numknownstrings;
400         // this is updated whenever a string is removed or added
401         // (simple optimization of the free string search)
402         int                                     firstfreeknownstring;
403         const char                      **knownstrings;
404         unsigned char           *knownstrings_freeable;
405         const char          **knownstrings_origin;
406         const char                      ***stringshash;
407
408         memexpandablearray_t    stringbuffersarray;
409
410         // all memory allocations related to this vm_prog (code, edicts, strings)
411         mempool_t                       *progs_mempool; // [INIT]
412
413         prvm_builtin_t          *builtins; // [INIT]
414         int                                     numbuiltins; // [INIT]
415
416         int                                     argc;
417
418         int                                     trace;
419         mfunction_t                     *xfunction;
420         int                                     xstatement;
421
422         // stacktrace writes into stack[MAX_STACK_DEPTH]
423         // thus increase the array, so depth wont be overwritten
424         prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
425         int                                     depth;
426
427         int                                     localstack[PRVM_LOCALSTACK_SIZE];
428         int                                     localstack_used;
429
430         unsigned short          headercrc; // [INIT]
431         unsigned short          headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
432
433         unsigned short          filecrc;
434
435         //============================================================================
436         // until this point everything also exists (with the pr_ prefix) in the old vm
437
438         qfile_t                         *openfiles[PRVM_MAX_OPENFILES];
439         const char *         openfiles_origin[PRVM_MAX_OPENFILES];
440         fssearch_t                      *opensearches[PRVM_MAX_OPENSEARCHES];
441         const char *         opensearches_origin[PRVM_MAX_OPENSEARCHES];
442         struct clgecko_s                *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
443         skeleton_t                      *skeletons[MAX_EDICTS];
444
445         // copies of some vars that were former read from sv
446         int                                     num_edicts;
447         // number of edicts for which space has been (should be) allocated
448         int                                     max_edicts; // [INIT]
449         // used instead of the constant MAX_EDICTS
450         int                                     limit_edicts; // [INIT]
451
452         // number of reserved edicts (allocated from 1)
453         int                                     reserved_edicts; // [INIT]
454
455         prvm_edict_t            *edicts;
456         vec_t                           *edictsfields;
457         void                                    *edictprivate;
458
459         // size of the engine private struct
460         int                                     edictprivate_size; // [INIT]
461
462         prvm_prog_fieldoffsets_t        fieldoffsets;
463         prvm_prog_globaloffsets_t       globaloffsets;
464         prvm_prog_funcoffsets_t         funcoffsets;
465
466         // allow writing to world entity fields, this is set by server init and
467         // cleared before first server frame
468         qboolean                        allowworldwrites;
469
470         // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
471         char                            *name; // [INIT]
472
473         // flag - used to store general flags like PRVM_GE_SELF, etc.
474         int                             flag;
475
476         char                            *extensionstring; // [INIT]
477
478         qboolean                        loadintoworld; // [INIT]
479
480         // used to indicate whether a prog is loaded
481         qboolean                        loaded;
482         qboolean                        leaktest_active;
483
484         // translation buffer (only needs to be freed on unloading progs, type is private to prvm_edict.c)
485         void *po;
486
487         // printed together with backtraces
488         const char *statestring;
489
490 //      prvm_builtin_mem_t  *mem_list;
491
492 // now passed as parameter of PRVM_LoadProgs
493 //      char                            **required_func;
494 //      int                                     numrequiredfunc;
495
496         //============================================================================
497
498         ddef_t                          *self; // if self != 0 then there is a global self
499
500         //============================================================================
501         // function pointers
502
503         void                            (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
504         void                            (*end_increase_edicts)(void); // [INIT]
505
506         void                            (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
507         void                            (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
508
509         void                            (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
510
511         qboolean                        (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
512
513         void                            (*init_cmd)(void); // [INIT] used by PRVM_InitProg
514         void                            (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
515
516         void                            (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
517
518         void                            (*ExecuteProgram)(func_t fnum, const char *errormessage); // pointer to one of the *VM_ExecuteProgram functions
519 } prvm_prog_t;
520
521 extern prvm_prog_t * prog;
522
523 #define PRVM_MAXPROGS 3
524 #define PRVM_SERVERPROG 0 // actually not used at the moment
525 #define PRVM_CLIENTPROG 1
526 #define PRVM_MENUPROG   2
527
528 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
529
530 //============================================================================
531 // prvm_cmds part
532
533 extern prvm_builtin_t vm_sv_builtins[];
534 extern prvm_builtin_t vm_cl_builtins[];
535 extern prvm_builtin_t vm_m_builtins[];
536
537 extern const int vm_sv_numbuiltins;
538 extern const int vm_cl_numbuiltins;
539 extern const int vm_m_numbuiltins;
540
541 extern char * vm_sv_extensions; // client also uses this
542 extern char * vm_m_extensions;
543
544 void VM_SV_Cmd_Init(void);
545 void VM_SV_Cmd_Reset(void);
546
547 void VM_CL_Cmd_Init(void);
548 void VM_CL_Cmd_Reset(void);
549
550 void VM_M_Cmd_Init(void);
551 void VM_M_Cmd_Reset(void);
552
553 void VM_Cmd_Init(void);
554 void VM_Cmd_Reset(void);
555 //============================================================================
556
557 void PRVM_Init (void);
558
559 #ifdef PROFILING
560 void MVM_ExecuteProgram (func_t fnum, const char *errormessage);
561 void CLVM_ExecuteProgram (func_t fnum, const char *errormessage);
562 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
563 #else
564 #define MVM_ExecuteProgram SVVM_ExecuteProgram
565 #define CLVM_ExecuteProgram SVVM_ExecuteProgram
566 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
567 #endif
568 #define PRVM_ExecuteProgram prog->ExecuteProgram
569
570 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
571 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
572 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
573 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
574 void _PRVM_Free (void *buffer, const char *filename, int fileline);
575 void _PRVM_FreeAll (const char *filename, int fileline);
576
577 void PRVM_Profile (int maxfunctions, int mininstructions, int sortby);
578 void PRVM_Profile_f (void);
579 void PRVM_ChildProfile_f (void);
580 void PRVM_CallProfile_f (void);
581 void PRVM_PrintFunction_f (void);
582
583 void PRVM_PrintState(void);
584 void PRVM_CrashAll (void);
585 void PRVM_Crash (void);
586 void PRVM_ShortStackTrace(char *buf, size_t bufsize);
587 const char *PRVM_AllocationOrigin(void);
588
589 ddef_t *PRVM_ED_FindField(const char *name);
590 ddef_t *PRVM_ED_FindGlobal(const char *name);
591 mfunction_t *PRVM_ED_FindFunction(const char *name);
592
593 int PRVM_ED_FindFieldOffset(const char *name);
594 int PRVM_ED_FindGlobalOffset(const char *name);
595 func_t PRVM_ED_FindFunctionOffset(const char *name);
596 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
597 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
598
599 void PRVM_MEM_IncreaseEdicts(void);
600
601 qboolean PRVM_ED_CanAlloc(prvm_edict_t *e);
602 prvm_edict_t *PRVM_ED_Alloc (void);
603 void PRVM_ED_Free (prvm_edict_t *ed);
604 void PRVM_ED_ClearEdict (prvm_edict_t *e);
605
606 void PRVM_PrintFunctionStatements (const char *name);
607 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
608 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
609 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
610
611 void PRVM_ED_WriteGlobals (qfile_t *f);
612 void PRVM_ED_ParseGlobals (const char *data);
613
614 void PRVM_ED_LoadFromFile (const char *data);
615
616 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, char *filename, int fileline);
617 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
618 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
619
620 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
621 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
622 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
623
624 #define PRVM_NEXT_EDICT(e) ((e) + 1)
625
626 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
627 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
628 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
629 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
630
631 //============================================================================
632
633 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
634 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
635 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
636 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
637 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
638 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
639 //#define       PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
640
641 // FIXME: make these go away?
642 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
643 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
644 //#define       PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
645 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
646
647 extern  int             prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
648 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
649
650 void PRVM_Init_Exec(void);
651
652 void PRVM_ED_PrintEdicts_f (void);
653 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
654
655 const char *PRVM_GetString(int num);
656 int PRVM_SetEngineString(const char *s);
657 const char *PRVM_ChangeEngineString(int i, const char *s);
658 int PRVM_SetTempString(const char *s);
659 int PRVM_AllocString(size_t bufferlength, char **pointer);
660 void PRVM_FreeString(int num);
661
662 //============================================================================
663
664 // used as replacement for a prog stack
665 //#define PRVM_DEBUGPRSTACK
666
667 #ifdef PRVM_DEBUGPRSTACK
668 #define PRVM_Begin  if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
669 #define PRVM_End        prog = 0
670 #else
671 #define PRVM_Begin
672 #define PRVM_End        prog = 0
673 #endif
674
675 //#define PRVM_SAFENAME
676 #ifndef PRVM_SAFENAME
677 #       define PRVM_NAME        (prog->name)
678 #else
679 #       define PRVM_NAME        (prog->name ? prog->name : "Unknown prog name")
680 #endif
681
682 // helper macro to make function pointer calls easier
683 #define PRVM_GCALL(func)        if(prog->func) prog->func
684
685 #define PRVM_ERROR              prog->error_cmd
686
687 // other prog handling functions
688 qboolean PRVM_SetProgFromString(const char *str);
689 void PRVM_SetProg(int prognr);
690
691 /*
692 Initializing a vm:
693 Call InitProg with the num
694 Set up the fields marked with [INIT] in the prog struct
695 Load a program with LoadProgs
696 */
697 void PRVM_InitProg(int prognr);
698 // LoadProgs expects to be called right after InitProg
699 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, char **required_global);
700 void PRVM_ResetProg(void);
701
702 qboolean PRVM_ProgLoaded(int prognr);
703
704 int     PRVM_GetProgNr(void);
705
706 void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
707
708 // TODO: fill in the params
709 //void PRVM_Create();
710
711 void VM_GenerateFrameGroupBlend(framegroupblend_t *framegroupblend, const prvm_edict_t *ed);
712 void VM_FrameBlendFromFrameGroupBlend(frameblend_t *frameblend, const framegroupblend_t *framegroupblend, const dp_model_t *model);
713 void VM_UpdateEdictSkeleton(prvm_edict_t *ed, const dp_model_t *edmodel, const frameblend_t *frameblend);
714 void VM_RemoveEdictSkeleton(prvm_edict_t *ed);
715
716 #endif