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