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