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_required_field_s
159 } prvm_required_field_t;
162 /*typedef struct prvm_link_s
165 struct link_s *prev, *next;
168 // AK: I dont call it engine private cause it doesnt really belongs to the engine
169 // it belongs to prvm.
170 typedef struct prvm_edict_private_s
174 } prvm_edict_private_t;
176 typedef struct prvm_edict_s
178 // engine-private fields (stored in dynamically resized array)
179 //edict_engineprivate_t *e;
182 prvm_edict_private_t *required;
184 edict_engineprivate_t *server;
185 // add other private structs as you desire
186 // new structs have to start with the elements of prvm_edit_private_t
187 // e.g. a new struct has to either look like this:
188 // typedef struct server_edict_private_s {
189 // prvm_edict_private_t base;
190 // vec3_t moved_from;
191 // vec3_t moved_fromangles;
192 // ... } server_edict_private_t;
194 // typedef struct server_edict_private_s {
197 // vec3_t moved_from;
198 // vec3_t moved_fromangles;
199 // ... } server_edict_private_t;
200 // However, the first one should be preferred.
202 // QuakeC fields (stored in dynamically resized array)
210 #define PRVM_GETEDICTFIELDVALUE(ed, fieldoffset) (fieldoffset ? (prvm_eval_t *)((qbyte *)ed->fields.vp + fieldoffset) : NULL)
212 /*// this struct is the basic requirement for a qc prog
213 typedef struct prvm_pr_globalvars_s
216 } prvm_pr_globalvars_t;
219 extern mfunction_t *SV_PlayerPhysicsQC;
220 extern mfunction_t *EndFrameQC;
221 //KrimZon - SERVER COMMANDS IN QUAKEC
222 extern mfunction_t *SV_ParseClientCommandQC;
224 //============================================================================
226 typedef struct prvm_builtin_mem_s
229 void (*deinit)(void);
232 } prvm_builtin_mem_t;
235 //============================================================================
237 #define PRVM_FE_NEXTHINK 2
238 #define PRVM_FE_THINK 4
239 #define PRVM_FE_FRAME 8
241 #define PRVM_FE_CLASSNAME 8
242 #define PRVM_FE_CHAIN 4
243 #define PRVM_OP_STATE 1
245 #define PRVM_MAX_STACK_DEPTH 256
246 #define PRVM_LOCALSTACK_SIZE 2048
248 typedef void (*prvm_builtin_t) (void);
250 // [INIT] variables flagged with this token can be initialized by 'you'
251 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
252 typedef struct prvm_prog_s
255 mfunction_t *functions;
260 dstatement_t *statements;
261 int edict_size; // in bytes
262 int edictareasize; // LordHavoc: in bytes (for bound checking)
266 globalvars_t *server;
271 const char **knownstrings;
273 // all memory allocations related to this vm_prog (code, edicts, strings)
274 mempool_t *progs_mempool; // [INIT]
276 prvm_builtin_t *builtins; // [INIT]
277 int numbuiltins; // [INIT]
282 mfunction_t *xfunction;
285 // stacktrace writes into stack[MAX_STACK_DEPTH]
286 // thus increase the array, so depth wont be overwritten
287 prvm_stack_t stack[PRVM_MAX_STACK_DEPTH+1];
290 int localstack[PRVM_LOCALSTACK_SIZE];
293 unsigned short headercrc; // [INIT]
295 unsigned short filecrc;
297 //============================================================================
298 // until this point everything also exists (with the pr_ prefix) in the old vm
300 // copies of some vars that were former read from sv
302 // number of edicts for which space has been (should be) allocated
303 int max_edicts; // [INIT]
304 // used instead of the constant MAX_EDICTS
305 int limit_edicts; // [INIT]
307 // number of reserved edicts (allocated from 1)
308 int reserved_edicts; // [INIT]
311 prvm_edict_t *edicts;
315 // size of the engine private struct
316 int edictprivate_size; // [INIT]
318 // has to be updated every frame - so the vm time is up-to-date
319 // AK changed so time will point to the time field (if there is one) else it points to _time
320 // actually should be double, but qc doesnt support it
324 // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
325 char *name; // [INIT]
327 // flag - used to store general flags like PRVM_GE_SELF, etc.
330 char *extensionstring; // [INIT]
332 qboolean loadintoworld; // [INIT]
334 // used to indicate whether a prog is loaded
337 // prvm_builtin_mem_t *mem_list;
339 // now passes as parameter of PRVM_LoadProgs
340 // char **required_func;
341 // int numrequiredfunc;
343 //============================================================================
345 ddef_t *self; // if self != 0 then there is a global self
347 //============================================================================
350 void (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
351 void (*end_increase_edicts)(void); // [INIT]
353 void (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
354 void (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
356 void (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
358 qboolean (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
360 void (*init_cmd)(void); // [INIT] used by PRVM_InitProg
361 void (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
363 void (*error_cmd)(const char *format, ...); // [INIT]
367 extern prvm_prog_t * prog;
369 #define PRVM_MAXPROGS 3
370 #define PRVM_SERVERPROG 0 // actually not used at the moment
371 #define PRVM_CLIENTPROG 1
372 #define PRVM_MENUPROG 2
374 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
376 //============================================================================
379 extern prvm_builtin_t vm_sv_builtins[];
380 extern prvm_builtin_t vm_cl_builtins[];
381 extern prvm_builtin_t vm_m_builtins[];
383 extern const int vm_sv_numbuiltins;
384 extern const int vm_cl_numbuiltins;
385 extern const int vm_m_numbuiltins;
387 extern char * vm_sv_extensions;
388 extern char * vm_cl_extensions;
389 extern char * vm_m_extensions;
391 void VM_SV_Cmd_Init(void);
392 void VM_SV_Cmd_Reset(void);
394 void VM_CL_Cmd_Init(void);
395 void VM_CL_Cmd_Reset(void);
397 void VM_M_Cmd_Init(void);
398 void VM_M_Cmd_Reset(void);
400 void VM_Cmd_Init(void);
401 void VM_Cmd_Reset(void);
402 //============================================================================
404 void PRVM_Init (void);
406 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
408 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
409 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
410 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
411 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
412 void _PRVM_Free (void *buffer, const char *filename, int fileline);
413 void _PRVM_FreeAll (const char *filename, int fileline);
415 void PRVM_Profile_f (void);
417 void PRVM_PrintState(void);
418 void PRVM_CrashAll (void);
419 void PRVM_Crash (void);
421 int PRVM_ED_FindFieldOffset(const char *field);
422 ddef_t *PRVM_ED_FindField (const char *name);
423 mfunction_t *PRVM_ED_FindFunction (const char *name);
425 void PRVM_MEM_IncreaseEdicts(void);
427 prvm_edict_t *PRVM_ED_Alloc (void);
428 void PRVM_ED_Free (prvm_edict_t *ed);
429 void PRVM_ED_ClearEdict (prvm_edict_t *e);
431 void PRVM_ED_Print(prvm_edict_t *ed);
432 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
433 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
435 void PRVM_ED_WriteGlobals (qfile_t *f);
436 void PRVM_ED_ParseGlobals (const char *data);
438 void PRVM_ED_LoadFromFile (const char *data);
440 prvm_edict_t *PRVM_EDICT_NUM_ERROR(int n, char *filename, int fileline);
441 #define PRVM_EDICT_NUM(n) (((n) >= 0 && (n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
442 #define PRVM_EDICT_NUM_UNSIGNED(n) (((n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
444 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
445 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
446 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
448 #define PRVM_NEXT_EDICT(e) ((e) + 1)
450 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
451 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
452 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
453 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
455 //============================================================================
457 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
458 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
459 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
460 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
461 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
462 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
463 //#define PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
465 // FIXME: make these go away?
466 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
467 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
468 //#define PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
469 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
471 extern int prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
472 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
474 void PRVM_Init_Exec(void);
476 void PRVM_ED_PrintEdicts_f (void);
477 void PRVM_ED_PrintNum (int ent);
479 const char *PRVM_GetString(int num);
480 int PRVM_SetQCString(const char *s);
481 int PRVM_SetEngineString(const char *s);
482 char *PRVM_AllocString(int bufferlength);
483 void PRVM_FreeString(char *s);
485 //============================================================================
487 // used as replacement for a prog stack
488 //#define PRVM_DEBUGPRSTACK
490 #ifdef PRVM_DEBUGPRSTACK
491 #define PRVM_Begin if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
492 #define PRVM_End prog = 0
495 #define PRVM_End prog = 0
499 //#define PRVM_SAFENAME
500 #ifndef PRVM_SAFENAME
501 #define PRVM_NAME (prog->name)
503 #define PRVM_NAME (prog->name ? prog->name : "Unknown prog name")
506 // helper macro to make function pointer calls easier
507 #define PRVM_GCALL(func) if(prog->func) prog->func
509 #define PRVM_ERROR prog->error_cmd
511 // other prog handling functions
512 qboolean PRVM_SetProgFromString(const char *str);
513 void PRVM_SetProg(int prognr);
517 Call InitProg with the num
518 Set up the fields marked with [INIT] in the prog struct
519 Load a program with LoadProgs
521 void PRVM_InitProg(int prognr);
522 // LoadProgs expects to be called right after InitProg
523 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field);
524 void PRVM_ResetProg(void);
526 qboolean PRVM_ProgLoaded(int prognr);
528 int PRVM_GetProgNr(void);
531 // TODO: fill in the params
532 //void PRVM_Create();