-Added an comment ('[INIT]') to all fields of vm_prog that can/should be
[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
35 /*
36 typedef union vm_eval_s
37 {
38         string_t                string;
39         float                   _float;
40         float                   vector[3];
41         func_t                  function;
42         int                             ivector[3];
43         int                             _int;
44         int                             edict;
45 } vm_eval_t;
46
47 typedef struct vm_link_s
48 {
49         int entitynumber;
50         struct link_s   *prev, *next;
51 } vm_link_t;
52
53 #define ENTITYGRIDAREAS 16
54
55 typedef struct vm_edict_engineprivate_s
56 {
57         // true if this edict is unused
58         qboolean free;
59         // sv.time when the object was freed (to prevent early reuse which could
60         // mess up client interpolation or obscure severe QuakeC bugs)
61         float freetime;
62
63         // physics grid areas this edict is linked into
64         link_t areagrid[ENTITYGRIDAREAS];
65         // since the areagrid can have multiple references to one entity,
66         // we should avoid extensive checking on entities already encountered
67         int areagridmarknumber;
68
69         // old entity protocol, not used
70 #ifdef QUAKEENTITIES
71         // baseline values
72         entity_state_t baseline;
73         // LordHavoc: previous frame
74         entity_state_t deltabaseline;
75 #endif
76
77         // LordHavoc: gross hack to make floating items still work
78         int suspendedinairflag;
79         // used by PushMove to keep track of where objects were before they were
80         // moved, in case they need to be moved back
81         vec3_t moved_from;
82         vec3_t moved_fromangles;
83 }
84 vm_edict_engineprivate_t;
85
86 // the entire server entity structure
87 // NOTE: keep this small!  priv and v are dynamic but this struct is not!
88 typedef struct vm_edict_s
89 {
90         // engine-private fields (stored in dynamically resized array)
91         edict_engineprivate_t *e;
92         // QuakeC fields (stored in dynamically resized array)
93         entvars_t *v;
94 }
95 vm_edict_t;
96 */
97
98 /*// LordHavoc: in an effort to eliminate time wasted on GetEdictFieldValue...  see pr_edict.c for the functions which use these.
99 extern int eval_gravity;
100 extern int eval_button3;
101 extern int eval_button4;
102 extern int eval_button5;
103 extern int eval_button6;
104 extern int eval_button7;
105 extern int eval_button8;
106 extern int eval_glow_size;
107 extern int eval_glow_trail;
108 extern int eval_glow_color;
109 extern int eval_items2;
110 extern int eval_scale;
111 extern int eval_alpha;
112 extern int eval_renderamt; // HalfLife support
113 extern int eval_rendermode; // HalfLife support
114 extern int eval_fullbright;
115 extern int eval_ammo_shells1;
116 extern int eval_ammo_nails1;
117 extern int eval_ammo_lava_nails;
118 extern int eval_ammo_rockets1;
119 extern int eval_ammo_multi_rockets;
120 extern int eval_ammo_cells1;
121 extern int eval_ammo_plasma;
122 extern int eval_idealpitch;
123 extern int eval_pitch_speed;
124 extern int eval_viewmodelforclient;
125 extern int eval_nodrawtoclient;
126 extern int eval_exteriormodeltoclient;
127 extern int eval_drawonlytoclient;
128 extern int eval_ping;
129 extern int eval_movement;
130 extern int eval_pmodel;
131 extern int eval_punchvector;
132 extern int eval_viewzoom;
133 extern int eval_clientcolors;
134 extern int eval_tag_entity;
135 extern int eval_tag_index;*/
136
137 typedef struct prvm_stack_s
138 {
139         int                             s;
140         mfunction_t             *f;
141 } prvm_stack_t;
142
143
144 typedef union prvm_eval_s
145 {
146         string_t                string;
147         float                   _float;
148         float                   vector[3];
149         func_t                  function;
150         int                             ivector[3];
151         int                             _int;
152         int                             edict;
153 } prvm_eval_t;
154
155 /*typedef struct prvm_link_s
156 {
157         int entitynumber;
158         struct link_s   *prev, *next;
159 } prvm_link_t;*/
160
161 // AK: I dont call it engine private cause it doesnt really belongs to the engine
162 //     it belongs to prvm.
163 typedef struct prvm_edict_private_s
164 {
165         qboolean free;
166         float freetime;
167 } prvm_edict_private_t;
168
169 typedef struct prvm_edict_s
170 {
171         // engine-private fields (stored in dynamically resized array)
172         //edict_engineprivate_t *e;
173         union
174         {
175                 prvm_edict_private_t *e;
176                 void                             *vp;
177                 // add other private structs as you desire
178                 // new structs have to start with the elements of prvm_edit_private_t
179                 // e.g. a new struct has to either look like this:
180                 //      typedef struct server_edict_private_s {
181                 //              prvm_edict_private_t base;
182                 //              vec3_t moved_from;
183                 //      vec3_t moved_fromangles;
184                 //              ... } server_edict_private_t;
185                 // or:
186                 //      typedef struct server_edict_private_s {
187                 //              qboolean free;
188                 //              float freetime;
189                 //              vec3_t moved_from;
190                 //      vec3_t moved_fromangles;
191                 //              ... } server_edict_private_t;
192                 // However, the first one should be preferred.
193         } p;
194         // QuakeC fields (stored in dynamically resized array)
195         //entvars_t *v;
196         void *v;
197 } prvm_edict_t;
198
199 #define PRVM_GETEDICTFIELDVALUE(ed, fieldoffset) (fieldoffset ? (prvm_eval_t *)((qbyte *)ed->v + fieldoffset) : NULL)
200
201 /*// this struct is the basic requirement for a qc prog
202 typedef struct prvm_pr_globalvars_s
203 {
204         int pad[28];
205 } prvm_pr_globalvars_t;
206 */
207 /*
208 extern mfunction_t *SV_PlayerPhysicsQC;
209 extern mfunction_t *EndFrameQC;
210 //KrimZon - SERVER COMMANDS IN QUAKEC
211 extern mfunction_t *SV_ParseClientCommandQC;
212 */
213 //============================================================================
214 /*
215 typedef struct prvm_builtin_mem_s
216 {
217         void (*init)(void);
218         void (*deinit)(void);
219
220         void *mem;
221 } prvm_builtin_mem_t;
222 */
223
224 //============================================================================
225 /*
226 #define PRVM_FE_NEXTHINK        2
227 #define PRVM_FE_THINK           4
228 #define PRVM_FE_FRAME           8
229 */
230 #define PRVM_FE_CLASSNAME   8
231 #define PRVM_FE_CHAIN           4
232 #define PRVM_OP_STATE           1
233
234 #define PRVM_MAX_STACK_DEPTH            256
235 #define PRVM_LOCALSTACK_SIZE            2048
236
237 typedef void (*prvm_builtin_t) (void);
238
239 // [INIT] variables flagged with this token can be initialized by 'you'
240 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
241 typedef struct vm_prog_s
242 {
243         dprograms_t                     *progs;
244         mfunction_t                     *functions;
245         char                            *strings;
246         int                                     stringssize;
247         ddef_t                          *fielddefs;
248         ddef_t                          *globaldefs;
249         dstatement_t            *statements;
250         //prvm_pr_globalvars_t*pr_global_struct;
251         float                           *globals;                       // same as pr_global_struct
252         int                                     edict_size;                     // in bytes
253         int                                     edictareasize;          // LordHavoc: in bytes (for bound checking)
254
255         int                                     maxknownstrings;
256         int                                     numknownstrings;
257         const char                      **knownstrings;
258
259         // all memory allocations related to this vm_prog (code, edicts, strings)
260         mempool_t                       *progs_mempool; // [INIT]
261
262         prvm_builtin_t          *builtins; // [INIT]
263         int                                     numbuiltins; // [INIT]
264
265         int                                     argc;
266
267         int                                     trace;
268         mfunction_t                     *xfunction;
269         int                                     xstatement;
270
271         // stacktrace writes into stack[MAX_STACK_DEPTH]
272         // thus increase the array, so depth wont be overwritten
273         prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
274         int                                     depth;
275
276         int                                     localstack[PRVM_LOCALSTACK_SIZE];
277         int                                     localstack_used;
278
279         unsigned short          crc; // [INIT]
280
281         //============================================================================
282         // until this point everything also exists (with the pr_ prefix) in the old vm
283
284         // copies of some vars that were former read from sv
285         int                                     num_edicts;
286         int                                     max_edicts;
287
288         prvm_edict_t            *edicts;
289         void                            *edictsfields;
290         void                            *edictprivate;
291
292         // size of the engine private struct
293         int                                     edictprivate_size; // [INIT]
294
295         // has to be updated every frame - so the vm time is up-to-date
296         // AK changed so time will point to the time field (if there is one) else it points to _time
297         // actually should be double, but qc doesnt support it
298         float                           *time;
299         float                           _time;
300
301         // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
302         char                            *name; // [INIT]
303
304         // flag - used to store general flags like PRVM_GE_SELF, etc.
305         int                                     flag;
306
307         char                            *extensionstring; // [INIT]
308
309         // used to indicate whether a prog is loaded
310         qboolean                        loaded;
311
312         // used instead of the constant MAX_EDICTS
313         int                                     limit_edicts; // [INIT]
314
315 //      prvm_builtin_mem_t  *mem_list;
316
317 // now passes as parameter of PRVM_LoadProgs
318 //      char                            **required_func;
319 //      int                                     numrequiredfunc;
320
321         //============================================================================
322
323         ddef_t                          *self; // if self != 0 then there is a global self
324
325         //============================================================================
326         // function pointers
327
328         void                            (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
329         void                            (*end_increase_edicts)(void); // [INIT]
330
331         void                            (*init_edict)(int num); // [INIT] used by PRVM_ED_ClearEdict
332         void                            (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
333
334         void                            (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
335
336         qboolean                        (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
337
338         void                            (*init_cmd)(void); // [INIT] used by PRVM_InitProg
339         void                            (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
340
341         void                            (*error_cmd)(void); // [INIT]
342
343 } prvm_prog_t;
344
345
346 extern prvm_prog_t * prog;
347
348 #define PRVM_MAXPROGS 3
349 #define PRVM_SERVERPROG 0 // actually not used at the moment
350 #define PRVM_CLIENTPROG 1
351 #define PRVM_MENUPROG   2
352
353 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
354
355 //============================================================================
356 // prvm_cmds part
357
358 extern prvm_builtin_t vm_sv_builtins[];
359 extern prvm_builtin_t vm_cl_builtins[];
360 extern prvm_builtin_t vm_m_builtins[];
361
362 extern const int vm_sv_numbuiltins;
363 extern const int vm_cl_numbuiltins;
364 extern const int vm_m_numbuiltins;
365
366 extern char * vm_sv_extensions;
367 extern char * vm_cl_extensions;
368 extern char * vm_m_extensions;
369
370 void VM_SV_Cmd_Init(void);
371 void VM_SV_Cmd_Reset(void);
372
373 void VM_CL_Cmd_Init(void);
374 void VM_CL_Cmd_Reset(void);
375
376 void VM_M_Cmd_Init(void);
377 void VM_M_Cmd_Reset(void);
378
379 void VM_Cmd_Init(void);
380 void VM_Cmd_Reset(void);
381 //============================================================================
382
383 void PRVM_Init (void);
384
385 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
386 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func);
387
388 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
389 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
390 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
391 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
392 void _PRVM_Free (void *buffer, const char *filename, int fileline);
393 void _PRVM_FreeAll (const char *filename, int fileline);
394
395 void PRVM_Profile_f (void);
396
397 void PRVM_PrintState(void);
398 void PRVM_CrashAll (void);
399 void PRVM_Crash (void);
400
401 prvm_edict_t *PRVM_ED_Alloc (void);
402 void PRVM_ED_Free (prvm_edict_t *ed);
403 void PRVM_ED_ClearEdict (prvm_edict_t *e);
404
405 void PRVM_ED_Print(prvm_edict_t *ed);
406 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
407 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
408
409 void PRVM_ED_WriteGlobals (qfile_t *f);
410 void PRVM_ED_ParseGlobals (const char *data);
411
412 void PRVM_ED_LoadFromFile (const char *data);
413
414 prvm_edict_t *PRVM_EDICT_NUM_ERROR(int n, char *filename, int fileline);
415 #define PRVM_EDICT_NUM(n) (((n) >= 0 && (n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
416
417 //int NUM_FOR_EDICT_ERROR(edict_t *e);
418 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
419 //int NUM_FOR_EDICT(edict_t *e);
420
421 #define PRVM_NEXT_EDICT(e) ((e) + 1)
422
423 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
424 //int PRVM_EDICT_TO_PROG(edict_t *e);
425 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
426 //edict_t *PRVM_PROG_TO_EDICT(int n);
427
428 //============================================================================
429
430 #define PRVM_G_FLOAT(o) (prog->globals[o])
431 #define PRVM_G_INT(o) (*(int *)&prog->globals[o])
432 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals[o]))
433 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
434 #define PRVM_G_VECTOR(o) (&prog->globals[o])
435 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals[o]))
436 //#define       PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals[o])
437
438 // FIXME: make these go away?
439 #define PRVM_E_FLOAT(e,o) (((float*)e->v)[o])
440 #define PRVM_E_INT(e,o) (((int*)e->v)[o])
441 //#define       PRVM_E_VECTOR(e,o) (&((float*)e->v)[o])
442 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->v)[o]))
443
444 extern  int             prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
445 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
446
447 void PRVM_Init_Exec(void);
448
449 void PRVM_ED_PrintEdicts_f (void);
450 void PRVM_ED_PrintNum (int ent);
451
452 const char *PRVM_GetString(int num);
453 int PRVM_SetQCString(const char *s);
454 int PRVM_SetEngineString(const char *s);
455 char *PRVM_AllocString(int bufferlength);
456 void PRVM_FreeString(char *s);
457
458 //============================================================================
459
460 // used as replacement for a prog stack
461 //#define PRVM_DEBUGPRSTACK
462
463 #ifdef PRVM_DEBUGPRSTACK
464 #define PRVM_Begin  if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
465 #define PRVM_End        prog = 0
466 #else
467 #define PRVM_Begin
468 #define PRVM_End        prog = 0
469 #endif
470
471
472 //#define PRVM_SAFENAME
473 #ifndef PRVM_SAFENAME
474         #define PRVM_NAME       (prog->name)
475 #else
476         #define PRVM_NAME       (prog->name ? prog->name : "Unknown prog name")
477 #endif
478
479 // helper macro to make function pointer calls easier
480 #define PRVM_GCALL(func)        if(prog->func) prog->func
481
482 #define PRVM_ERROR              Host_Error
483
484 // other prog handling functions
485 qboolean PRVM_SetProgFromString(const char *str);
486 void     PRVM_SetProg(int prognr);
487
488 void     PRVM_InitProg(int prognr);
489 void     PRVM_ResetProg(void);
490
491 qboolean PRVM_ProgLoaded(int prognr);
492
493 int              PRVM_GetProgNr(void);
494
495
496 // TODO: fill in the params
497 //void PRVM_Create();
498
499 #endif