-Its now possible to add support for other edict_private structs easily.
[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 types as you desire
178         } p;
179         // QuakeC fields (stored in dynamically resized array)
180         //entvars_t *v;
181         void *v;
182 } prvm_edict_t;
183         
184 #define PRVM_GETEDICTFIELDVALUE(ed, fieldoffset) (fieldoffset ? (prvm_eval_t *)((qbyte *)ed->v + fieldoffset) : NULL)
185
186 /*// this struct is the basic requirement for a qc prog
187 typedef struct prvm_pr_globalvars_s
188 {
189         int pad[28];
190 } prvm_pr_globalvars_t;
191 */
192 /*
193 extern mfunction_t *SV_PlayerPhysicsQC;
194 extern mfunction_t *EndFrameQC;
195 //KrimZon - SERVER COMMANDS IN QUAKEC
196 extern mfunction_t *SV_ParseClientCommandQC;
197 */
198 //============================================================================
199 /*
200 typedef struct prvm_builtin_mem_s
201 {
202         void (*init)(void);
203         void (*deinit)(void);
204
205         void *mem;
206 } prvm_builtin_mem_t;
207 */
208
209 //============================================================================
210 /*
211 #define PRVM_FE_NEXTHINK        2
212 #define PRVM_FE_THINK           4
213 #define PRVM_FE_FRAME           8
214 */
215 #define PRVM_FE_CLASSNAME   8
216 #define PRVM_FE_CHAIN           4
217 #define PRVM_OP_STATE           1
218
219 #define PRVM_MAX_STACK_DEPTH            256
220 #define PRVM_LOCALSTACK_SIZE            2048
221
222 typedef void (*prvm_builtin_t) (void);
223
224 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
225 typedef struct vm_prog_s
226 {
227         dprograms_t                     *progs;
228         mfunction_t                     *functions;
229         char                            *strings;
230         ddef_t                          *fielddefs;
231         ddef_t                          *globaldefs;
232         dstatement_t            *statements;
233         //prvm_pr_globalvars_t*pr_global_struct; 
234         float                           *globals;                       // same as pr_global_struct
235         int                                     edict_size;                     // in bytes
236         int                                     edictareasize;          // LordHavoc: in bytes (for bound checking)
237         
238         mempool_t                       *progs_mempool;
239         mempool_t                       *edictstring_mempool;
240
241         prvm_builtin_t          *builtins;
242         int                                     numbuiltins;
243         
244         int                                     argc;
245         
246         int                                     trace;
247         mfunction_t                     *xfunction;
248         int                                     xstatement;
249
250         // stacktrace writes into stack[MAX_STACK_DEPTH]
251         // thus increase the array, so depth wont be overwritten
252         prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
253         int                                     depth;
254         
255         int                                     localstack[PRVM_LOCALSTACK_SIZE];
256         int                                     localstack_used;
257
258         unsigned short          crc;    
259
260         //============================================================================
261         // until this point everything also exists (with the pr_ prefix) in the old vm
262
263         // copies of some vars that were former read from sv
264         int                                     num_edicts;
265         int                                     max_edicts;
266
267         prvm_edict_t            *edicts;
268         void                            *edictsfields;
269         void                            *edictprivate;
270
271         // size of the engine private struct
272         int                                     edictprivate_size;
273
274         // instead of sv_editcts_mempool
275         mempool_t                       *edicts_mempool;
276         
277         // has to be updated every frame - so the vm time is up-to-date
278         // AK changed so time will point to the time field (if there is one) else it points to _time
279         // actually should be double, but qc doesnt support it
280         float                           *time;
281         float                           _time;
282
283         // name of the prog, e.g. "Server", "Client" or "Menu" (used in for text output)
284         char                            *name;
285
286         // flag - used to store general flags like PRVM_GE_SELF, etc.
287         int                                     flag;
288
289         char                            *extensionstring;
290
291         // used to indicate whether a prog is loaded
292         qboolean                        loaded;
293
294         // used instead of the constant MAX_EDICTS
295         int                                     limit_edicts;
296
297 //      prvm_builtin_mem_t  *mem_list;
298
299 // now passes as parameter of PRVM_LoadProgs
300 //      char                            **required_func; 
301 //      int                                     numrequiredfunc;
302
303         //============================================================================
304         
305         ddef_t                          *self; // if self != 0 then there is a global self
306         
307         //============================================================================
308         // function pointers
309         
310         void                            (*begin_increase_edicts)(void);  // used by PRVM_MEM_Increase_Edicts
311         void                            (*end_increase_edicts)(void); 
312         
313         void                            (*init_edict)(int num);         // used by PRVM_ED_ClearEdict
314         void                            (*free_edict)(prvm_edict_t *ed); // used by PRVM_ED_Free
315
316         void                            (*count_edicts)(void);  // used by PRVM_ED_Count_f
317
318         qboolean                        (*load_edict)(prvm_edict_t *ent); // used by PRVM_ED_LoadFromFile
319
320         void                            (*init_cmd)(void);      // used by PRVM_InitProg
321         void                            (*reset_cmd)(void); // used by PRVM_ResetProg
322
323         void                            (*error_cmd)(void);
324
325 } prvm_prog_t;
326
327
328 extern prvm_prog_t * prog;
329
330 #define PRVM_MAXPROGS 3
331 #define PRVM_SERVERPROG 0 // actually not used at the moment
332 #define PRVM_CLIENTPROG 1
333 #define PRVM_MENUPROG   2
334
335 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
336
337 //============================================================================
338 // prvm_cmds part
339
340 extern prvm_builtin_t vm_sv_builtins[];  
341 extern prvm_builtin_t vm_cl_builtins[];  
342 extern prvm_builtin_t vm_m_builtins[];  
343
344 extern const int vm_sv_numbuiltins;
345 extern const int vm_cl_numbuiltins;
346 extern const int vm_m_numbuiltins;
347
348 extern char * vm_sv_extensions; 
349 extern char * vm_cl_extensions; 
350 extern char * vm_m_extensions; 
351
352 void VM_SV_Cmd_Init(void); 
353 void VM_SV_Cmd_Reset(void); 
354
355 void VM_CL_Cmd_Init(void); 
356 void VM_CL_Cmd_Reset(void); 
357
358 void VM_M_Cmd_Init(void); 
359 void VM_M_Cmd_Reset(void);
360
361 void VM_Cmd_Init(void);
362 void VM_Cmd_Reset(void);
363 //============================================================================
364
365 void PRVM_Init (void);
366
367 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
368 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func);
369
370 void PRVM_Profile_f (void);
371
372 void PRVM_PrintState(void);
373 void PRVM_CrashAll (void);
374 void PRVM_Crash (void);
375
376 prvm_edict_t *PRVM_ED_Alloc (void);
377 void PRVM_ED_Free (prvm_edict_t *ed);
378 void PRVM_ED_ClearEdict (prvm_edict_t *e);
379
380 char *PRVM_ED_NewString (const char *string);
381 // returns a copy of the string allocated from the server's string heap
382
383 void PRVM_ED_Print(prvm_edict_t *ed);
384 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
385 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
386
387 void PRVM_ED_WriteGlobals (qfile_t *f);
388 void PRVM_ED_ParseGlobals (const char *data);
389
390 void PRVM_ED_LoadFromFile (const char *data);
391
392 prvm_edict_t *PRVM_EDICT_NUM_ERROR(int n, char *filename, int fileline);
393 #define PRVM_EDICT_NUM(n) (((n) >= 0 && (n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
394
395 //int NUM_FOR_EDICT_ERROR(edict_t *e);
396 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
397 //int NUM_FOR_EDICT(edict_t *e);
398
399 #define PRVM_NEXT_EDICT(e) ((e) + 1)
400
401 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
402 //int PRVM_EDICT_TO_PROG(edict_t *e);
403 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
404 //edict_t *PRVM_PROG_TO_EDICT(int n);
405
406 //============================================================================
407
408 #define PRVM_G_FLOAT(o) (prog->globals[o])
409 #define PRVM_G_INT(o) (*(int *)&prog->globals[o])
410 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals[o]))
411 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
412 #define PRVM_G_VECTOR(o) (&prog->globals[o])
413 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals[o]))
414 //#define       PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals[o])
415
416 // FIXME: make these go away?
417 #define PRVM_E_FLOAT(e,o) (((float*)e->v)[o])
418 //#define       PRVM_E_INT(e,o) (((int*)e->v)[o])
419 //#define       PRVM_E_VECTOR(e,o) (&((float*)e->v)[o])
420 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->v)[o]))
421
422 extern  int             prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
423 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
424
425 void PRVM_Init_Exec(void);
426
427 void PRVM_ED_PrintEdicts_f (void);
428 void PRVM_ED_PrintNum (int ent);
429
430 #define PRVM_GetString(num) (prog->strings + num)
431 #define PRVM_SetString(s)   ((s) != NULL ? (int) (s - prog->strings) : 0)
432
433 //============================================================================
434
435 // used as replacement for a prog stack
436 //#define PRVM_DEBUGPRSTACK
437
438 #ifdef PRVM_DEBUGPRSTACK
439 #define PRVM_Begin  if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
440 #define PRVM_End        prog = 0
441 #else
442 #define PRVM_Begin  
443 #define PRVM_End        prog = 0
444 #endif
445
446
447 //#define PRVM_SAFENAME
448 #ifndef PRVM_SAFENAME
449         #define PRVM_NAME       (prog->name)
450 #else
451         #define PRVM_NAME       (prog->name ? prog->name : "Unknown prog name")
452 #endif
453
454 // helper macro to make function pointer calls easier
455 #define PRVM_GCALL(func)        if(prog->func) prog->func
456
457 #define PRVM_ERROR              Host_Error
458
459 // other prog handling functions
460 qboolean PRVM_SetProgFromString(const char *str);
461 void     PRVM_SetProg(int prognr);
462
463 void     PRVM_InitProg(int prognr);
464 void     PRVM_ResetProg(void);
465
466 qboolean PRVM_ProgLoaded(int prognr);
467
468 int              PRVM_GetProgNr(void);
469         
470
471 // TODO: fill in the params
472 //void PRVM_Create();
473
474 #endif