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
34 #include "clprogdefs.h" // generated by program cdefs
37 typedef union vm_eval_s
48 typedef struct vm_link_s
51 struct link_s *prev, *next;
54 #define ENTITYGRIDAREAS 16
56 typedef struct vm_edict_engineprivate_s
58 // true if this edict is unused
60 // sv.time when the object was freed (to prevent early reuse which could
61 // mess up client interpolation or obscure severe QuakeC bugs)
64 // physics grid areas this edict is linked into
65 link_t areagrid[ENTITYGRIDAREAS];
66 // since the areagrid can have multiple references to one entity,
67 // we should avoid extensive checking on entities already encountered
68 int areagridmarknumber;
70 // old entity protocol, not used
73 entity_state_t baseline;
74 // LordHavoc: previous frame
75 entity_state_t deltabaseline;
78 // LordHavoc: gross hack to make floating items still work
79 int suspendedinairflag;
80 // used by PushMove to keep track of where objects were before they were
81 // moved, in case they need to be moved back
83 vec3_t moved_fromangles;
85 vm_edict_engineprivate_t;
87 // the entire server entity structure
88 // NOTE: keep this small! priv and v are dynamic but this struct is not!
89 typedef struct vm_edict_s
91 // engine-private fields (stored in dynamically resized array)
92 edict_engineprivate_t *e;
93 // QuakeC fields (stored in dynamically resized array)
99 /*// LordHavoc: in an effort to eliminate time wasted on GetEdictFieldValue... see pr_edict.c for the functions which use these.
100 extern int eval_gravity;
101 extern int eval_button3;
102 extern int eval_button4;
103 extern int eval_button5;
104 extern int eval_button6;
105 extern int eval_button7;
106 extern int eval_button8;
107 extern int eval_glow_size;
108 extern int eval_glow_trail;
109 extern int eval_glow_color;
110 extern int eval_items2;
111 extern int eval_scale;
112 extern int eval_alpha;
113 extern int eval_renderamt; // HalfLife support
114 extern int eval_rendermode; // HalfLife support
115 extern int eval_fullbright;
116 extern int eval_ammo_shells1;
117 extern int eval_ammo_nails1;
118 extern int eval_ammo_lava_nails;
119 extern int eval_ammo_rockets1;
120 extern int eval_ammo_multi_rockets;
121 extern int eval_ammo_cells1;
122 extern int eval_ammo_plasma;
123 extern int eval_idealpitch;
124 extern int eval_pitch_speed;
125 extern int eval_viewmodelforclient;
126 extern int eval_nodrawtoclient;
127 extern int eval_exteriormodeltoclient;
128 extern int eval_drawonlytoclient;
129 extern int eval_ping;
130 extern int eval_movement;
131 extern int eval_pmodel;
132 extern int eval_punchvector;
133 extern int eval_viewzoom;
134 extern int eval_clientcolors;
135 extern int eval_tag_entity;
136 extern int eval_tag_index;*/
138 typedef struct prvm_stack_s
145 typedef union prvm_eval_s
156 typedef struct prvm_required_field_s
160 } prvm_required_field_t;
163 /*typedef struct prvm_link_s
166 struct link_s *prev, *next;
169 // AK: I dont call it engine private cause it doesnt really belongs to the engine
170 // it belongs to prvm.
171 typedef struct prvm_edict_private_s
175 } prvm_edict_private_t;
177 typedef struct prvm_edict_s
179 // engine-private fields (stored in dynamically resized array)
180 //edict_engineprivate_t *e;
183 prvm_edict_private_t *required;
185 edict_engineprivate_t *server;
186 // add other private structs as you desire
187 // new structs have to start with the elements of prvm_edit_private_t
188 // e.g. a new struct has to either look like this:
189 // typedef struct server_edict_private_s {
190 // prvm_edict_private_t base;
191 // vec3_t moved_from;
192 // vec3_t moved_fromangles;
193 // ... } server_edict_private_t;
195 // typedef struct server_edict_private_s {
198 // vec3_t moved_from;
199 // vec3_t moved_fromangles;
200 // ... } server_edict_private_t;
201 // However, the first one should be preferred.
203 // QuakeC fields (stored in dynamically resized array)
208 cl_entvars_t *client;
212 #define PRVM_GETEDICTFIELDVALUE(ed, fieldoffset) (fieldoffset ? (prvm_eval_t *)((unsigned char *)ed->fields.vp + fieldoffset) : NULL)
214 /*// this struct is the basic requirement for a qc prog
215 typedef struct prvm_pr_globalvars_s
218 } prvm_pr_globalvars_t;
221 extern mfunction_t *SV_PlayerPhysicsQC;
222 extern mfunction_t *EndFrameQC;
223 //KrimZon - SERVER COMMANDS IN QUAKEC
224 extern mfunction_t *SV_ParseClientCommandQC;
226 //============================================================================
228 typedef struct prvm_builtin_mem_s
231 void (*deinit)(void);
234 } prvm_builtin_mem_t;
237 //============================================================================
239 #define PRVM_FE_NEXTHINK 2
240 #define PRVM_FE_THINK 4
241 #define PRVM_FE_FRAME 8
243 #define PRVM_FE_CLASSNAME 8
244 #define PRVM_FE_CHAIN 4
245 #define PRVM_OP_STATE 1
247 #define PRVM_MAX_STACK_DEPTH 256
248 #define PRVM_LOCALSTACK_SIZE 2048
250 typedef void (*prvm_builtin_t) (void);
252 // [INIT] variables flagged with this token can be initialized by 'you'
253 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
254 typedef struct prvm_prog_s
257 mfunction_t *functions;
262 dstatement_t *statements;
263 int edict_size; // in bytes
264 int edictareasize; // LordHavoc: in bytes (for bound checking)
266 int *statement_linenums; // NULL if not available
270 globalvars_t *server;
271 cl_globalvars_t *client;
276 // this is updated whenever a string is removed or added
277 // (simple optimization of the free string search)
278 int firstfreeknownstring;
279 const char **knownstrings;
280 unsigned char *knownstrings_freeable;
281 const char ***stringshash;
283 // all memory allocations related to this vm_prog (code, edicts, strings)
284 mempool_t *progs_mempool; // [INIT]
286 prvm_builtin_t *builtins; // [INIT]
287 int numbuiltins; // [INIT]
292 mfunction_t *xfunction;
295 // stacktrace writes into stack[MAX_STACK_DEPTH]
296 // thus increase the array, so depth wont be overwritten
297 prvm_stack_t stack[PRVM_MAX_STACK_DEPTH+1];
300 int localstack[PRVM_LOCALSTACK_SIZE];
303 unsigned short headercrc; // [INIT]
305 unsigned short filecrc;
307 //============================================================================
308 // until this point everything also exists (with the pr_ prefix) in the old vm
310 // copies of some vars that were former read from sv
312 // number of edicts for which space has been (should be) allocated
313 int max_edicts; // [INIT]
314 // used instead of the constant MAX_EDICTS
315 int limit_edicts; // [INIT]
317 // number of reserved edicts (allocated from 1)
318 int reserved_edicts; // [INIT]
321 prvm_edict_t *edicts;
325 // size of the engine private struct
326 int edictprivate_size; // [INIT]
328 // has to be updated every frame - so the vm time is up-to-date
329 // AK changed so time will point to the time field (if there is one) else it points to _time
330 // actually should be double, but qc doesnt support it
334 // allow writing to world entity fields, this is set by server init and
335 // cleared before first server frame
336 qboolean allowworldwrites;
338 // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
339 char *name; // [INIT]
341 // flag - used to store general flags like PRVM_GE_SELF, etc.
344 char *extensionstring; // [INIT]
346 qboolean loadintoworld; // [INIT]
348 // used to indicate whether a prog is loaded
351 // prvm_builtin_mem_t *mem_list;
353 // now passes as parameter of PRVM_LoadProgs
354 // char **required_func;
355 // int numrequiredfunc;
357 //============================================================================
359 ddef_t *self; // if self != 0 then there is a global self
361 //============================================================================
364 void (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
365 void (*end_increase_edicts)(void); // [INIT]
367 void (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
368 void (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
370 void (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
372 qboolean (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
374 void (*init_cmd)(void); // [INIT] used by PRVM_InitProg
375 void (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
377 void (*error_cmd)(const char *format, ...); // [INIT]
381 extern prvm_prog_t * prog;
383 #define PRVM_MAXPROGS 3
384 #define PRVM_SERVERPROG 0 // actually not used at the moment
385 #define PRVM_CLIENTPROG 1
386 #define PRVM_MENUPROG 2
388 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
390 //============================================================================
393 extern prvm_builtin_t vm_sv_builtins[];
394 extern prvm_builtin_t vm_cl_builtins[];
395 extern prvm_builtin_t vm_m_builtins[];
397 extern const int vm_sv_numbuiltins;
398 extern const int vm_cl_numbuiltins;
399 extern const int vm_m_numbuiltins;
401 extern char * vm_sv_extensions;
402 extern char * vm_cl_extensions;
403 extern char * vm_m_extensions;
405 void VM_SV_Cmd_Init(void);
406 void VM_SV_Cmd_Reset(void);
408 void VM_CL_Cmd_Init(void);
409 void VM_CL_Cmd_Reset(void);
411 void VM_M_Cmd_Init(void);
412 void VM_M_Cmd_Reset(void);
414 void VM_Cmd_Init(void);
415 void VM_Cmd_Reset(void);
416 //============================================================================
418 void PRVM_Init (void);
420 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
422 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
423 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
424 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
425 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
426 void _PRVM_Free (void *buffer, const char *filename, int fileline);
427 void _PRVM_FreeAll (const char *filename, int fileline);
429 void PRVM_Profile_f (void);
431 void PRVM_PrintState(void);
432 void PRVM_CrashAll (void);
433 void PRVM_Crash (void);
435 int PRVM_ED_FindFieldOffset(const char *field);
436 ddef_t *PRVM_ED_FindField (const char *name);
437 mfunction_t *PRVM_ED_FindFunction (const char *name);
439 void PRVM_MEM_IncreaseEdicts(void);
441 prvm_edict_t *PRVM_ED_Alloc (void);
442 void PRVM_ED_Free (prvm_edict_t *ed);
443 void PRVM_ED_ClearEdict (prvm_edict_t *e);
445 void PRVM_ED_Print(prvm_edict_t *ed);
446 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
447 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
449 void PRVM_ED_WriteGlobals (qfile_t *f);
450 void PRVM_ED_ParseGlobals (const char *data);
452 void PRVM_ED_LoadFromFile (const char *data);
454 prvm_edict_t *PRVM_EDICT_NUM_ERROR(int n, char *filename, int fileline);
455 #define PRVM_EDICT_NUM(n) (((n) >= 0 && (n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
456 #define PRVM_EDICT_NUM_UNSIGNED(n) (((n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
458 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
459 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
460 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
462 #define PRVM_NEXT_EDICT(e) ((e) + 1)
464 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
465 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
466 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
467 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
469 //============================================================================
471 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
472 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
473 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
474 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
475 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
476 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
477 //#define PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
479 // FIXME: make these go away?
480 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
481 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
482 //#define PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
483 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
485 extern int prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
486 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
488 void PRVM_Init_Exec(void);
490 void PRVM_ED_PrintEdicts_f (void);
491 void PRVM_ED_PrintNum (int ent);
493 const char *PRVM_GetString(int num);
494 int PRVM_SetEngineString(const char *s);
495 int PRVM_AllocString(size_t bufferlength, char **pointer);
496 void PRVM_FreeString(int num);
498 //============================================================================
500 // used as replacement for a prog stack
501 //#define PRVM_DEBUGPRSTACK
503 #ifdef PRVM_DEBUGPRSTACK
504 #define PRVM_Begin if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
505 #define PRVM_End prog = 0
508 #define PRVM_End prog = 0
512 //#define PRVM_SAFENAME
513 #ifndef PRVM_SAFENAME
514 # define PRVM_NAME (prog->name)
516 # define PRVM_NAME (prog->name ? prog->name : "Unknown prog name")
519 // helper macro to make function pointer calls easier
520 #define PRVM_GCALL(func) if(prog->func) prog->func
522 #define PRVM_ERROR prog->error_cmd
524 // other prog handling functions
525 qboolean PRVM_SetProgFromString(const char *str);
526 void PRVM_SetProg(int prognr);
530 Call InitProg with the num
531 Set up the fields marked with [INIT] in the prog struct
532 Load a program with LoadProgs
534 void PRVM_InitProg(int prognr);
535 // LoadProgs expects to be called right after InitProg
536 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field);
537 void PRVM_ResetProg(void);
539 qboolean PRVM_ProgLoaded(int prognr);
541 int PRVM_GetProgNr(void);
544 // TODO: fill in the params
545 //void PRVM_Create();