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