2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
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.
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.
32 #include "pr_comp.h" // defs shared with qcc
33 //#include "progdefs.h" // generated by program cdefs
36 typedef union vm_eval_s
47 typedef struct vm_link_s
50 struct link_s *prev, *next;
53 #define ENTITYGRIDAREAS 16
55 typedef struct vm_edict_engineprivate_s
57 // true if this edict is unused
59 // sv.time when the object was freed (to prevent early reuse which could
60 // mess up client interpolation or obscure severe QuakeC bugs)
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;
69 // old entity protocol, not used
72 entity_state_t baseline;
73 // LordHavoc: previous frame
74 entity_state_t deltabaseline;
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
82 vec3_t moved_fromangles;
84 vm_edict_engineprivate_t;
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
90 // engine-private fields (stored in dynamically resized array)
91 edict_engineprivate_t *e;
92 // QuakeC fields (stored in dynamically resized array)
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;*/
137 typedef struct prvm_stack_s
144 typedef union prvm_eval_s
155 /*typedef struct prvm_link_s
158 struct link_s *prev, *next;
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
167 } prvm_edict_private_t;
169 typedef struct prvm_edict_s
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)
179 #define PRVM_GETEDICTFIELDVALUE(ed, fieldoffset) (fieldoffset ? (prvm_eval_t *)((qbyte *)ed->v + fieldoffset) : NULL)
181 /*// this struct is the basic requirement for a qc prog
182 typedef struct prvm_pr_globalvars_s
185 } prvm_pr_globalvars_t;
188 extern mfunction_t *SV_PlayerPhysicsQC;
189 extern mfunction_t *EndFrameQC;
190 //KrimZon - SERVER COMMANDS IN QUAKEC
191 extern mfunction_t *SV_ParseClientCommandQC;
193 //============================================================================
195 typedef struct prvm_builtin_mem_s
198 void (*deinit)(void);
201 } prvm_builtin_mem_t;
204 //============================================================================
206 #define PRVM_FE_NEXTHINK 2
207 #define PRVM_FE_THINK 4
208 #define PRVM_FE_FRAME 8
210 #define PRVM_FE_CLASSNAME 32
211 #define PRVM_GE_TIME 16
212 #define PRVM_OP_STATE 1
214 #define PRVM_MAX_STACK_DEPTH 256
215 #define PRVM_LOCALSTACK_SIZE 2048
217 typedef void (*prvm_builtin_t) (void);
219 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
220 typedef struct vm_prog_s
223 mfunction_t *functions;
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)
233 mempool_t *progs_mempool;
234 mempool_t *edictstring_mempool;
236 prvm_builtin_t *builtins;
242 mfunction_t *xfunction;
245 prvm_stack_t stack[PRVM_MAX_STACK_DEPTH];
248 int localstack[PRVM_LOCALSTACK_SIZE];
253 //============================================================================
254 // until this point everything also exists (with the pr_ prefix) in the old vm
256 // copies of some vars that were former read from sv
260 prvm_edict_t *edicts;
264 // size of the engine private struct
265 int edictprivate_size;
267 // instead of sv_editcts_mempool
268 mempool_t *edicts_mempool;
270 // has to be updated every frame - so the vm time is up-to-date
273 // name of the prog, e.g. "Server", "Client" or "Menu" (used in for text output)
276 // flag - used to store general flags like PRVM_GE_SELF, etc.
279 char *extensionstring;
281 // used to indicate whether a prog is loaded
284 // used instead of the constant MAX_EDICTS
287 // prvm_builtin_mem_t *mem_list;
289 // now passes as parameter of PRVM_LoadProgs
290 // char **required_func;
291 // int numrequiredfunc;
293 //============================================================================
295 ddef_t *self; // if self != 0 then there is a global self
297 //============================================================================
300 void (*begin_increase_edicts)(void); // used by PRVM_MEM_Increase_Edicts
301 void (*end_increase_edicts)(void);
303 void (*init_edict)(int num); // used by PRVM_ED_ClearEdict
304 void (*free_edict)(prvm_edict_t *ed); // used by PRVM_ED_Free
306 void (*count_edicts)(void); // used by PRVM_ED_Count_f
308 qboolean (*load_edict)(prvm_edict_t *ent); // used by PRVM_ED_LoadFromFile
310 void (*init_cmd)(void); // used by PRVM_InitProg
311 void (*reset_cmd)(void); // used by PRVM_ResetProg
313 void (*error_cmd)(void);
318 extern prvm_prog_t * prog;
320 #define PRVM_MAXPROGS 3
321 #define PRVM_SERVERPROG 0 // actually not used at the moment
322 #define PRVM_CLIENTPROG 1
323 #define PRVM_MENUPROG 2
325 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
327 //============================================================================
330 extern prvm_builtin_t vm_sv_builtins[];
331 extern prvm_builtin_t vm_cl_builtins[];
332 extern prvm_builtin_t vm_m_builtins[];
334 extern const int vm_sv_numbuiltins;
335 extern const int vm_cl_numbuiltins;
336 extern const int vm_m_numbuiltins;
338 extern char * vm_sv_extensions;
339 extern char * vm_cl_extensions;
340 extern char * vm_m_extensions;
342 void VM_SV_Cmd_Init(void);
343 void VM_SV_Cmd_Reset(void);
345 void VM_CL_Cmd_Init(void);
346 void VM_CL_Cmd_Reset(void);
348 void VM_M_Cmd_Init(void);
349 void VM_M_Cmd_Reset(void);
351 void VM_Cmd_Init(void);
352 void VM_Cmd_Reset(void);
353 //============================================================================
355 void PRVM_Init (void);
357 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
358 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func);
360 void PRVM_Profile_f (void);
362 void PRVM_CrashAll (void);
363 void PRVM_Crash (void);
365 prvm_edict_t *PRVM_ED_Alloc (void);
366 void PRVM_ED_Free (prvm_edict_t *ed);
367 void PRVM_ED_ClearEdict (prvm_edict_t *e);
369 char *PRVM_ED_NewString (const char *string);
370 // returns a copy of the string allocated from the server's string heap
372 void PRVM_ED_Print (prvm_edict_t *ed);
373 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
374 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
376 void PRVM_ED_WriteGlobals (qfile_t *f);
377 void PRVM_ED_ParseGlobals (const char *data);
379 void PRVM_ED_LoadFromFile (const char *data);
381 prvm_edict_t *PRVM_EDICT_NUM_ERROR(int n, char *filename, int fileline);
382 #define PRVM_EDICT_NUM(n) (((n) >= 0 && (n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
384 //int NUM_FOR_EDICT_ERROR(edict_t *e);
385 #define PRVM_NUM_FOR_EDICT(e) ((prvm_edict_t *)(e) - prog->edicts)
386 //int NUM_FOR_EDICT(edict_t *e);
388 #define PRVM_NEXT_EDICT(e) ((e) + 1)
390 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
391 //int PRVM_EDICT_TO_PROG(edict_t *e);
392 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
393 //edict_t *PRVM_PROG_TO_EDICT(int n);
395 //============================================================================
397 #define PRVM_G_FLOAT(o) (prog->globals[o])
398 #define PRVM_G_INT(o) (*(int *)&prog->globals[o])
399 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals[o]))
400 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
401 #define PRVM_G_VECTOR(o) (&prog->globals[o])
402 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals[o]))
403 //#define PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals[o])
405 // FIXME: make these go away?
406 #define PRVM_E_FLOAT(e,o) (((float*)e->v)[o])
407 //#define PRVM_E_INT(e,o) (((int*)e->v)[o])
408 //#define PRVM_E_VECTOR(e,o) (&((float*)e->v)[o])
409 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->v)[o]))
411 extern int prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
412 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
414 void PRVM_Init_Exec(void);
416 void PRVM_ED_PrintEdicts (void);
417 void PRVM_ED_PrintNum (int ent);
419 #define PRVM_GetString(num) (prog->strings + num)
420 #define PRVM_SetString(s) ((int) (s - prog->strings))
422 //============================================================================
424 // used as replacement for a prog stack
427 #define PRVM_End prog = 0;
429 #define PRVM_Begin { prvm_prog_t *_oldprog_ = prog
430 #define PRVM_End if(_oldprog_ != 0) Con_Print("Stack used !\n"); prog = _oldprog_;}
433 #define PRVM_NAME (prog->name ? prog->name : "Unknown prog name")
435 // helper macro to make function pointer calls easier
436 #define PRVM_GCALL(func) if(prog->func) prog->func
438 /*#define PRVM_ERROR if(!prog->error_cmd) \
439 Sys_Error("PRVM: No error_cmd specified !\n"); \
443 #define PRVM_ERROR PRVM_GCALL(error_cmd)(),Host_Error
447 // other prog handling functions
448 qboolean PRVM_SetProgFromString(const char *str);
449 void PRVM_SetProg(int prognr);
451 void PRVM_InitProg(int prognr);
452 void PRVM_ResetProg(void);
454 qboolean PRVM_ProgLoaded(int prognr);
456 int PRVM_GetProgNr(void);
459 // TODO: fill in the params
460 //void PRVM_Create();