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