added prvm_offsets.h which centralizes field/global/function lookups for
[xonotic/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 #include "clprogdefs.h"                 // generated by program cdefs
35
36 #ifndef DP_SMALLMEMORY
37 #define PROFILING
38 #endif
39
40 // forward declaration of clgecko_t
41 struct clgecko_s;
42
43 typedef struct prvm_stack_s
44 {
45         int                             s;
46         mfunction_t             *f;
47         double                  tprofile_acc;
48         double                  profile_acc;
49         double                  builtinsprofile_acc;
50 } prvm_stack_t;
51
52
53 typedef union prvm_eval_s
54 {
55         string_t                string;
56         float                   _float;
57         float                   vector[3];
58         func_t                  function;
59         int                             ivector[3];
60         int                             _int;
61         int                             edict;
62 } prvm_eval_t;
63
64 typedef struct prvm_required_field_s
65 {
66         int type;
67         const char *name;
68 } prvm_required_field_t;
69
70
71 // AK: I dont call it engine private cause it doesnt really belongs to the engine
72 //     it belongs to prvm.
73 typedef struct prvm_edict_private_s
74 {
75         qboolean free;
76         float freetime;
77         int mark;
78         const char *allocation_origin;
79 } prvm_edict_private_t;
80
81 typedef struct prvm_edict_s
82 {
83         // engine-private fields (stored in dynamically resized array)
84         //edict_engineprivate_t *e;
85         union
86         {
87                 prvm_edict_private_t *required;
88                 vec_t *vp;
89                 // FIXME: this server pointer really means world, not server
90                 // (it is used by both server qc and client qc, but not menu qc)
91                 edict_engineprivate_t *server;
92                 // add other private structs as you desire
93                 // new structs have to start with the elements of prvm_edit_private_t
94                 // e.g. a new struct has to either look like this:
95                 //      typedef struct server_edict_private_s {
96                 //              prvm_edict_private_t base;
97                 //              vec3_t moved_from;
98                 //      vec3_t moved_fromangles;
99                 //              ... } server_edict_private_t;
100                 // or:
101                 //      typedef struct server_edict_private_s {
102                 //              qboolean free;
103                 //              float freetime;
104                 //              vec3_t moved_from;
105                 //      vec3_t moved_fromangles;
106                 //              ... } server_edict_private_t;
107                 // However, the first one should be preferred.
108         } priv;
109         // QuakeC fields (stored in dynamically resized array)
110         union
111         {
112                 vec_t *vp;
113                 entvars_t               *server;
114                 cl_entvars_t    *client;
115         } fields;
116 } prvm_edict_t;
117
118 extern prvm_eval_t prvm_badvalue;
119
120 #define PRVM_alledictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
121 #define PRVM_alledictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
122 #define PRVM_alledictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
123 #define PRVM_alledictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
124 #define PRVM_alledictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
125 #define PRVM_allglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
126 #define PRVM_allglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
127 #define PRVM_allglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
128 #define PRVM_allglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
129 #define PRVM_allglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
130 #define PRVM_allfunction(funcname)           (prog->funcoffsets.funcname)
131
132 #define PRVM_drawedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
133 #define PRVM_drawedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
134 #define PRVM_drawedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
135 #define PRVM_drawedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
136 #define PRVM_drawedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
137 #define PRVM_drawglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
138 #define PRVM_drawglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
139 #define PRVM_drawglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
140 #define PRVM_drawglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
141 #define PRVM_drawglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
142 #define PRVM_drawfunction(funcname)           (prog->funcoffsets.funcname)
143
144 #define PRVM_gameedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
145 #define PRVM_gameedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
146 #define PRVM_gameedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
147 #define PRVM_gameedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
148 #define PRVM_gameedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
149 #define PRVM_gameglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
150 #define PRVM_gameglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
151 #define PRVM_gameglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
152 #define PRVM_gameglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
153 #define PRVM_gameglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
154 #define PRVM_gamefunction(funcname)           (prog->funcoffsets.funcname)
155
156 #define PRVM_serveredictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
157 #define PRVM_serveredictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
158 #define PRVM_serveredictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
159 #define PRVM_serveredictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
160 #define PRVM_serveredictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
161 #define PRVM_serverglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
162 #define PRVM_serverglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
163 #define PRVM_serverglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
164 #define PRVM_serverglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
165 #define PRVM_serverglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
166 #define PRVM_serverfunction(funcname)           (prog->funcoffsets.funcname)
167
168 #define PRVM_clientedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
169 #define PRVM_clientedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
170 #define PRVM_clientedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
171 #define PRVM_clientedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
172 #define PRVM_clientedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
173 #define PRVM_clientglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
174 #define PRVM_clientglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
175 #define PRVM_clientglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
176 #define PRVM_clientglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
177 #define PRVM_clientglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
178 #define PRVM_clientfunction(funcname)           (prog->funcoffsets.funcname)
179
180 #define PRVM_menuedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
181 #define PRVM_menuedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
182 #define PRVM_menuedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
183 #define PRVM_menuedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
184 #define PRVM_menuedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
185 #define PRVM_menuglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
186 #define PRVM_menuglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
187 #define PRVM_menuglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
188 #define PRVM_menuglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
189 #define PRVM_menuglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
190 #define PRVM_menufunction(funcname)           (prog->funcoffsets.funcname)
191
192 #if 1
193 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset)    (fieldoffset < 0 ? Con_Printf("Invalid fieldoffset at %s:%i\n", __FILE__, __LINE__), &prvm_badvalue : (prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))
194 #define PRVM_EDICTFIELDFLOAT(ed, fieldoffset)    (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->_float)
195 #define PRVM_EDICTFIELDVECTOR(ed, fieldoffset)   (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->vector)
196 #define PRVM_EDICTFIELDSTRING(ed, fieldoffset)   (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->string)
197 #define PRVM_EDICTFIELDEDICT(ed, fieldoffset)    (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->edict)
198 #define PRVM_EDICTFIELDFUNCTION(ed, fieldoffset) (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->function)
199 #define PRVM_GLOBALFIELDVALUE(fieldoffset)       (fieldoffset < 0 ? Con_Printf("Invalid fieldoffset at %s:%i\n", __FILE__, __LINE__), &prvm_badvalue : (prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))
200 #define PRVM_GLOBALFIELDFLOAT(fieldoffset)       (PRVM_GLOBALFIELDVALUE(fieldoffset)->_float)
201 #define PRVM_GLOBALFIELDVECTOR(fieldoffset)      (PRVM_GLOBALFIELDVALUE(fieldoffset)->vector)
202 #define PRVM_GLOBALFIELDSTRING(fieldoffset)      (PRVM_GLOBALFIELDVALUE(fieldoffset)->string)
203 #define PRVM_GLOBALFIELDEDICT(fieldoffset)       (PRVM_GLOBALFIELDVALUE(fieldoffset)->edict)
204 #define PRVM_GLOBALFIELDFUNCTION(fieldoffset)    (PRVM_GLOBALFIELDVALUE(fieldoffset)->function)
205 #else
206 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) ((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))
207 #define PRVM_EDICTFIELDFLOAT(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->_float)
208 #define PRVM_EDICTFIELDVECTOR(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->vector)
209 #define PRVM_EDICTFIELDSTRING(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->string)
210 #define PRVM_EDICTFIELDEDICT(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->edict)
211 #define PRVM_EDICTFIELDFUNCTION(ed, fieldoffset) (((prvm_eval_t *)((int *)ed->fields.vp + fieldoffset))->function)
212 #define PRVM_GLOBALFIELDVALUE(fieldoffset) ((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))
213 #define PRVM_GLOBALFIELDFLOAT(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->_float)
214 #define PRVM_GLOBALFIELDVECTOR(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->vector)
215 #define PRVM_GLOBALFIELDSTRING(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->string)
216 #define PRVM_GLOBALFIELDEDICT(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->edict)
217 #define PRVM_GLOBALFIELDFUNCTION(fieldoffset) (((prvm_eval_t *)((int *)prog->globals.generic + fieldoffset))->function)
218 #endif
219
220 //============================================================================
221 #define PRVM_OP_STATE           1
222
223 #ifdef DP_SMALLMEMORY
224 #define PRVM_MAX_STACK_DEPTH            128
225 #define PRVM_LOCALSTACK_SIZE            2048
226
227 #define PRVM_MAX_OPENFILES 16
228 #define PRVM_MAX_OPENSEARCHES 8
229 #define PRVM_MAX_GECKOINSTANCES 1
230 #else
231 #define PRVM_MAX_STACK_DEPTH            1024
232 #define PRVM_LOCALSTACK_SIZE            16384
233
234 #define PRVM_MAX_OPENFILES 256
235 #define PRVM_MAX_OPENSEARCHES 128
236 #define PRVM_MAX_GECKOINSTANCES 32
237 #endif
238
239 typedef void (*prvm_builtin_t) (void);
240
241 // NOTE: field offsets use -1 for NULL
242 typedef struct prvm_prog_fieldoffsets_s
243 {
244 #define PRVM_DECLARE_serverglobalfloat(x)
245 #define PRVM_DECLARE_serverglobalvector(x)
246 #define PRVM_DECLARE_serverglobalstring(x)
247 #define PRVM_DECLARE_serverglobaledict(x)
248 #define PRVM_DECLARE_serverglobalfunction(x)
249 #define PRVM_DECLARE_clientglobalfloat(x)
250 #define PRVM_DECLARE_clientglobalvector(x)
251 #define PRVM_DECLARE_clientglobalstring(x)
252 #define PRVM_DECLARE_clientglobaledict(x)
253 #define PRVM_DECLARE_clientglobalfunction(x)
254 #define PRVM_DECLARE_menuglobalfloat(x)
255 #define PRVM_DECLARE_menuglobalvector(x)
256 #define PRVM_DECLARE_menuglobalstring(x)
257 #define PRVM_DECLARE_menuglobaledict(x)
258 #define PRVM_DECLARE_menuglobalfunction(x)
259 #define PRVM_DECLARE_serverfieldfloat(x)
260 #define PRVM_DECLARE_serverfieldvector(x)
261 #define PRVM_DECLARE_serverfieldstring(x)
262 #define PRVM_DECLARE_serverfieldedict(x)
263 #define PRVM_DECLARE_serverfieldfunction(x)
264 #define PRVM_DECLARE_clientfieldfloat(x)
265 #define PRVM_DECLARE_clientfieldvector(x)
266 #define PRVM_DECLARE_clientfieldstring(x)
267 #define PRVM_DECLARE_clientfieldedict(x)
268 #define PRVM_DECLARE_clientfieldfunction(x)
269 #define PRVM_DECLARE_menufieldfloat(x)
270 #define PRVM_DECLARE_menufieldvector(x)
271 #define PRVM_DECLARE_menufieldstring(x)
272 #define PRVM_DECLARE_menufieldedict(x)
273 #define PRVM_DECLARE_menufieldfunction(x)
274 #define PRVM_DECLARE_serverfunction(x)
275 #define PRVM_DECLARE_clientfunction(x)
276 #define PRVM_DECLARE_menufunction(x)
277 #define PRVM_DECLARE_field(x) int x;
278 #define PRVM_DECLARE_global(x)
279 #define PRVM_DECLARE_function(x)
280 #include "prvm_offsets.h"
281 #undef PRVM_DECLARE_serverglobalfloat
282 #undef PRVM_DECLARE_serverglobalvector
283 #undef PRVM_DECLARE_serverglobalstring
284 #undef PRVM_DECLARE_serverglobaledict
285 #undef PRVM_DECLARE_serverglobalfunction
286 #undef PRVM_DECLARE_clientglobalfloat
287 #undef PRVM_DECLARE_clientglobalvector
288 #undef PRVM_DECLARE_clientglobalstring
289 #undef PRVM_DECLARE_clientglobaledict
290 #undef PRVM_DECLARE_clientglobalfunction
291 #undef PRVM_DECLARE_menuglobalfloat
292 #undef PRVM_DECLARE_menuglobalvector
293 #undef PRVM_DECLARE_menuglobalstring
294 #undef PRVM_DECLARE_menuglobaledict
295 #undef PRVM_DECLARE_menuglobalfunction
296 #undef PRVM_DECLARE_serverfieldfloat
297 #undef PRVM_DECLARE_serverfieldvector
298 #undef PRVM_DECLARE_serverfieldstring
299 #undef PRVM_DECLARE_serverfieldedict
300 #undef PRVM_DECLARE_serverfieldfunction
301 #undef PRVM_DECLARE_clientfieldfloat
302 #undef PRVM_DECLARE_clientfieldvector
303 #undef PRVM_DECLARE_clientfieldstring
304 #undef PRVM_DECLARE_clientfieldedict
305 #undef PRVM_DECLARE_clientfieldfunction
306 #undef PRVM_DECLARE_menufieldfloat
307 #undef PRVM_DECLARE_menufieldvector
308 #undef PRVM_DECLARE_menufieldstring
309 #undef PRVM_DECLARE_menufieldedict
310 #undef PRVM_DECLARE_menufieldfunction
311 #undef PRVM_DECLARE_serverfunction
312 #undef PRVM_DECLARE_clientfunction
313 #undef PRVM_DECLARE_menufunction
314 #undef PRVM_DECLARE_field
315 #undef PRVM_DECLARE_global
316 #undef PRVM_DECLARE_function
317 }
318 prvm_prog_fieldoffsets_t;
319
320 // NOTE: global offsets use -1 for NULL
321 typedef struct prvm_prog_globaloffsets_s
322 {
323 #define PRVM_DECLARE_serverglobalfloat(x)
324 #define PRVM_DECLARE_serverglobalvector(x)
325 #define PRVM_DECLARE_serverglobalstring(x)
326 #define PRVM_DECLARE_serverglobaledict(x)
327 #define PRVM_DECLARE_serverglobalfunction(x)
328 #define PRVM_DECLARE_clientglobalfloat(x)
329 #define PRVM_DECLARE_clientglobalvector(x)
330 #define PRVM_DECLARE_clientglobalstring(x)
331 #define PRVM_DECLARE_clientglobaledict(x)
332 #define PRVM_DECLARE_clientglobalfunction(x)
333 #define PRVM_DECLARE_menuglobalfloat(x)
334 #define PRVM_DECLARE_menuglobalvector(x)
335 #define PRVM_DECLARE_menuglobalstring(x)
336 #define PRVM_DECLARE_menuglobaledict(x)
337 #define PRVM_DECLARE_menuglobalfunction(x)
338 #define PRVM_DECLARE_serverfieldfloat(x)
339 #define PRVM_DECLARE_serverfieldvector(x)
340 #define PRVM_DECLARE_serverfieldstring(x)
341 #define PRVM_DECLARE_serverfieldedict(x)
342 #define PRVM_DECLARE_serverfieldfunction(x)
343 #define PRVM_DECLARE_clientfieldfloat(x)
344 #define PRVM_DECLARE_clientfieldvector(x)
345 #define PRVM_DECLARE_clientfieldstring(x)
346 #define PRVM_DECLARE_clientfieldedict(x)
347 #define PRVM_DECLARE_clientfieldfunction(x)
348 #define PRVM_DECLARE_menufieldfloat(x)
349 #define PRVM_DECLARE_menufieldvector(x)
350 #define PRVM_DECLARE_menufieldstring(x)
351 #define PRVM_DECLARE_menufieldedict(x)
352 #define PRVM_DECLARE_menufieldfunction(x)
353 #define PRVM_DECLARE_serverfunction(x)
354 #define PRVM_DECLARE_clientfunction(x)
355 #define PRVM_DECLARE_menufunction(x)
356 #define PRVM_DECLARE_field(x)
357 #define PRVM_DECLARE_global(x) int x;
358 #define PRVM_DECLARE_function(x)
359 #include "prvm_offsets.h"
360 #undef PRVM_DECLARE_serverglobalfloat
361 #undef PRVM_DECLARE_serverglobalvector
362 #undef PRVM_DECLARE_serverglobalstring
363 #undef PRVM_DECLARE_serverglobaledict
364 #undef PRVM_DECLARE_serverglobalfunction
365 #undef PRVM_DECLARE_clientglobalfloat
366 #undef PRVM_DECLARE_clientglobalvector
367 #undef PRVM_DECLARE_clientglobalstring
368 #undef PRVM_DECLARE_clientglobaledict
369 #undef PRVM_DECLARE_clientglobalfunction
370 #undef PRVM_DECLARE_menuglobalfloat
371 #undef PRVM_DECLARE_menuglobalvector
372 #undef PRVM_DECLARE_menuglobalstring
373 #undef PRVM_DECLARE_menuglobaledict
374 #undef PRVM_DECLARE_menuglobalfunction
375 #undef PRVM_DECLARE_serverfieldfloat
376 #undef PRVM_DECLARE_serverfieldvector
377 #undef PRVM_DECLARE_serverfieldstring
378 #undef PRVM_DECLARE_serverfieldedict
379 #undef PRVM_DECLARE_serverfieldfunction
380 #undef PRVM_DECLARE_clientfieldfloat
381 #undef PRVM_DECLARE_clientfieldvector
382 #undef PRVM_DECLARE_clientfieldstring
383 #undef PRVM_DECLARE_clientfieldedict
384 #undef PRVM_DECLARE_clientfieldfunction
385 #undef PRVM_DECLARE_menufieldfloat
386 #undef PRVM_DECLARE_menufieldvector
387 #undef PRVM_DECLARE_menufieldstring
388 #undef PRVM_DECLARE_menufieldedict
389 #undef PRVM_DECLARE_menufieldfunction
390 #undef PRVM_DECLARE_serverfunction
391 #undef PRVM_DECLARE_clientfunction
392 #undef PRVM_DECLARE_menufunction
393 #undef PRVM_DECLARE_field
394 #undef PRVM_DECLARE_global
395 #undef PRVM_DECLARE_function
396 }
397 prvm_prog_globaloffsets_t;
398
399 // NOTE: function offsets use 0 for NULL
400 typedef struct prvm_prog_funcoffsets_s
401 {
402 #define PRVM_DECLARE_serverglobalfloat(x)
403 #define PRVM_DECLARE_serverglobalvector(x)
404 #define PRVM_DECLARE_serverglobalstring(x)
405 #define PRVM_DECLARE_serverglobaledict(x)
406 #define PRVM_DECLARE_serverglobalfunction(x)
407 #define PRVM_DECLARE_clientglobalfloat(x)
408 #define PRVM_DECLARE_clientglobalvector(x)
409 #define PRVM_DECLARE_clientglobalstring(x)
410 #define PRVM_DECLARE_clientglobaledict(x)
411 #define PRVM_DECLARE_clientglobalfunction(x)
412 #define PRVM_DECLARE_menuglobalfloat(x)
413 #define PRVM_DECLARE_menuglobalvector(x)
414 #define PRVM_DECLARE_menuglobalstring(x)
415 #define PRVM_DECLARE_menuglobaledict(x)
416 #define PRVM_DECLARE_menuglobalfunction(x)
417 #define PRVM_DECLARE_serverfieldfloat(x)
418 #define PRVM_DECLARE_serverfieldvector(x)
419 #define PRVM_DECLARE_serverfieldstring(x)
420 #define PRVM_DECLARE_serverfieldedict(x)
421 #define PRVM_DECLARE_serverfieldfunction(x)
422 #define PRVM_DECLARE_clientfieldfloat(x)
423 #define PRVM_DECLARE_clientfieldvector(x)
424 #define PRVM_DECLARE_clientfieldstring(x)
425 #define PRVM_DECLARE_clientfieldedict(x)
426 #define PRVM_DECLARE_clientfieldfunction(x)
427 #define PRVM_DECLARE_menufieldfloat(x)
428 #define PRVM_DECLARE_menufieldvector(x)
429 #define PRVM_DECLARE_menufieldstring(x)
430 #define PRVM_DECLARE_menufieldedict(x)
431 #define PRVM_DECLARE_menufieldfunction(x)
432 #define PRVM_DECLARE_serverfunction(x)
433 #define PRVM_DECLARE_clientfunction(x)
434 #define PRVM_DECLARE_menufunction(x)
435 #define PRVM_DECLARE_field(x)
436 #define PRVM_DECLARE_global(x)
437 #define PRVM_DECLARE_function(x) int x;
438 #include "prvm_offsets.h"
439 #undef PRVM_DECLARE_serverglobalfloat
440 #undef PRVM_DECLARE_serverglobalvector
441 #undef PRVM_DECLARE_serverglobalstring
442 #undef PRVM_DECLARE_serverglobaledict
443 #undef PRVM_DECLARE_serverglobalfunction
444 #undef PRVM_DECLARE_clientglobalfloat
445 #undef PRVM_DECLARE_clientglobalvector
446 #undef PRVM_DECLARE_clientglobalstring
447 #undef PRVM_DECLARE_clientglobaledict
448 #undef PRVM_DECLARE_clientglobalfunction
449 #undef PRVM_DECLARE_menuglobalfloat
450 #undef PRVM_DECLARE_menuglobalvector
451 #undef PRVM_DECLARE_menuglobalstring
452 #undef PRVM_DECLARE_menuglobaledict
453 #undef PRVM_DECLARE_menuglobalfunction
454 #undef PRVM_DECLARE_serverfieldfloat
455 #undef PRVM_DECLARE_serverfieldvector
456 #undef PRVM_DECLARE_serverfieldstring
457 #undef PRVM_DECLARE_serverfieldedict
458 #undef PRVM_DECLARE_serverfieldfunction
459 #undef PRVM_DECLARE_clientfieldfloat
460 #undef PRVM_DECLARE_clientfieldvector
461 #undef PRVM_DECLARE_clientfieldstring
462 #undef PRVM_DECLARE_clientfieldedict
463 #undef PRVM_DECLARE_clientfieldfunction
464 #undef PRVM_DECLARE_menufieldfloat
465 #undef PRVM_DECLARE_menufieldvector
466 #undef PRVM_DECLARE_menufieldstring
467 #undef PRVM_DECLARE_menufieldedict
468 #undef PRVM_DECLARE_menufieldfunction
469 #undef PRVM_DECLARE_serverfunction
470 #undef PRVM_DECLARE_clientfunction
471 #undef PRVM_DECLARE_menufunction
472 #undef PRVM_DECLARE_field
473 #undef PRVM_DECLARE_global
474 #undef PRVM_DECLARE_function
475 }
476 prvm_prog_funcoffsets_t;
477
478 // stringbuffer flags
479 #define STRINGBUFFER_SAVED      1 // saved in savegames
480
481 typedef struct prvm_stringbuffer_s
482 {
483         int max_strings;
484         int num_strings;
485         char **strings;
486         const char *origin;
487         unsigned char flags;
488 }
489 prvm_stringbuffer_t;
490
491 // [INIT] variables flagged with this token can be initialized by 'you'
492 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
493 typedef struct prvm_prog_s
494 {
495         double              starttime;
496         unsigned int            id; // increasing unique id of progs instance
497         mfunction_t                     *functions;
498         char                            *strings;
499         int                                     stringssize;
500         ddef_t                          *fielddefs;
501         ddef_t                          *globaldefs;
502         mstatement_t            *statements;
503         int                                     entityfields;                   // number of vec_t fields in progs (some variables are 3)
504         int                                     entityfieldsarea;               // LordHavoc: equal to max_edicts * entityfields (for bounds checking)
505
506         // loaded values from the disk format
507         int                                     progs_version;
508         int                                     progs_crc;
509         int                                     progs_numstatements;
510         int                                     progs_numglobaldefs;
511         int                                     progs_numfielddefs;
512         int                                     progs_numfunctions;
513         int                                     progs_numstrings;
514         int                                     progs_numglobals;
515         int                                     progs_entityfields;
516
517         // real values in memory (some modified by loader)
518         int                                     numstatements;
519         int                                     numglobaldefs;
520         int                                     numfielddefs;
521         int                                     numfunctions;
522         int                                     numstrings;
523         int                                     numglobals;
524
525         int                                     *statement_linenums; // NULL if not available
526
527         double                          *statement_profile; // only incremented if prvm_statementprofiling is on
528
529         union {
530                 vec_t *generic;
531                 globalvars_t *server;
532                 cl_globalvars_t *client;
533         } globals;
534
535         int                                     maxknownstrings;
536         int                                     numknownstrings;
537         // this is updated whenever a string is removed or added
538         // (simple optimization of the free string search)
539         int                                     firstfreeknownstring;
540         const char                      **knownstrings;
541         unsigned char           *knownstrings_freeable;
542         const char          **knownstrings_origin;
543         const char                      ***stringshash;
544
545         memexpandablearray_t    stringbuffersarray;
546
547         // all memory allocations related to this vm_prog (code, edicts, strings)
548         mempool_t                       *progs_mempool; // [INIT]
549
550         prvm_builtin_t          *builtins; // [INIT]
551         int                                     numbuiltins; // [INIT]
552
553         int                                     argc;
554
555         int                                     trace;
556         mfunction_t                     *xfunction;
557         int                                     xstatement;
558
559         // stacktrace writes into stack[MAX_STACK_DEPTH]
560         // thus increase the array, so depth wont be overwritten
561         prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
562         int                                     depth;
563
564         int                                     localstack[PRVM_LOCALSTACK_SIZE];
565         int                                     localstack_used;
566
567         unsigned short          headercrc; // [INIT]
568         unsigned short          headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
569
570         unsigned short          filecrc;
571
572         //============================================================================
573         // until this point everything also exists (with the pr_ prefix) in the old vm
574
575         qfile_t                         *openfiles[PRVM_MAX_OPENFILES];
576         const char *         openfiles_origin[PRVM_MAX_OPENFILES];
577         fssearch_t                      *opensearches[PRVM_MAX_OPENSEARCHES];
578         const char *         opensearches_origin[PRVM_MAX_OPENSEARCHES];
579         struct clgecko_s                *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
580         skeleton_t                      *skeletons[MAX_EDICTS];
581
582         // copies of some vars that were former read from sv
583         int                                     num_edicts;
584         // number of edicts for which space has been (should be) allocated
585         int                                     max_edicts; // [INIT]
586         // used instead of the constant MAX_EDICTS
587         int                                     limit_edicts; // [INIT]
588
589         // number of reserved edicts (allocated from 1)
590         int                                     reserved_edicts; // [INIT]
591
592         prvm_edict_t            *edicts;
593         vec_t                           *edictsfields;
594         void                                    *edictprivate;
595
596         // size of the engine private struct
597         int                                     edictprivate_size; // [INIT]
598
599         prvm_prog_fieldoffsets_t        fieldoffsets;
600         prvm_prog_globaloffsets_t       globaloffsets;
601         prvm_prog_funcoffsets_t funcoffsets;
602
603         // allow writing to world entity fields, this is set by server init and
604         // cleared before first server frame
605         qboolean                        allowworldwrites;
606
607         // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
608         const char                      *name; // [INIT]
609
610         // flag - used to store general flags like PRVM_GE_SELF, etc.
611         int                             flag;
612
613         const char                      *extensionstring; // [INIT]
614
615         qboolean                        loadintoworld; // [INIT]
616
617         // used to indicate whether a prog is loaded
618         qboolean                        loaded;
619         qboolean                        leaktest_active;
620
621         // translation buffer (only needs to be freed on unloading progs, type is private to prvm_edict.c)
622         void *po;
623
624         // printed together with backtraces
625         const char *statestring;
626
627 //      prvm_builtin_mem_t  *mem_list;
628
629 // now passed as parameter of PRVM_LoadProgs
630 //      char                            **required_func;
631 //      int                                     numrequiredfunc;
632
633         //============================================================================
634
635         ddef_t                          *self; // if self != 0 then there is a global self
636
637         //============================================================================
638         // function pointers
639
640         void                            (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
641         void                            (*end_increase_edicts)(void); // [INIT]
642
643         void                            (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
644         void                            (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
645
646         void                            (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
647
648         qboolean                        (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
649
650         void                            (*init_cmd)(void); // [INIT] used by PRVM_InitProg
651         void                            (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
652
653         void                            (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
654
655         void                            (*ExecuteProgram)(func_t fnum, const char *errormessage); // pointer to one of the *VM_ExecuteProgram functions
656 } prvm_prog_t;
657
658 extern prvm_prog_t * prog;
659
660 #define PRVM_MAXPROGS 3
661 #define PRVM_SERVERPROG 0 // actually not used at the moment
662 #define PRVM_CLIENTPROG 1
663 #define PRVM_MENUPROG   2
664
665 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
666
667 //============================================================================
668 // prvm_cmds part
669
670 extern prvm_builtin_t vm_sv_builtins[];
671 extern prvm_builtin_t vm_cl_builtins[];
672 extern prvm_builtin_t vm_m_builtins[];
673
674 extern const int vm_sv_numbuiltins;
675 extern const int vm_cl_numbuiltins;
676 extern const int vm_m_numbuiltins;
677
678 extern const char * vm_sv_extensions; // client also uses this
679 extern const char * vm_m_extensions;
680
681 void VM_SV_Cmd_Init(void);
682 void VM_SV_Cmd_Reset(void);
683
684 void VM_CL_Cmd_Init(void);
685 void VM_CL_Cmd_Reset(void);
686
687 void VM_M_Cmd_Init(void);
688 void VM_M_Cmd_Reset(void);
689
690 void VM_Cmd_Init(void);
691 void VM_Cmd_Reset(void);
692 //============================================================================
693
694 void PRVM_Init (void);
695
696 #ifdef PROFILING
697 void MVM_ExecuteProgram (func_t fnum, const char *errormessage);
698 void CLVM_ExecuteProgram (func_t fnum, const char *errormessage);
699 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
700 #else
701 #define MVM_ExecuteProgram SVVM_ExecuteProgram
702 #define CLVM_ExecuteProgram SVVM_ExecuteProgram
703 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
704 #endif
705 #define PRVM_ExecuteProgram prog->ExecuteProgram
706
707 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
708 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
709 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
710 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
711 void _PRVM_Free (void *buffer, const char *filename, int fileline);
712 void _PRVM_FreeAll (const char *filename, int fileline);
713
714 void PRVM_Profile (int maxfunctions, double mintime, int sortby);
715 void PRVM_Profile_f (void);
716 void PRVM_ChildProfile_f (void);
717 void PRVM_CallProfile_f (void);
718 void PRVM_PrintFunction_f (void);
719
720 void PRVM_PrintState(void);
721 void PRVM_CrashAll (void);
722 void PRVM_Crash (void);
723 void PRVM_ShortStackTrace(char *buf, size_t bufsize);
724 const char *PRVM_AllocationOrigin(void);
725
726 ddef_t *PRVM_ED_FindField(const char *name);
727 ddef_t *PRVM_ED_FindGlobal(const char *name);
728 mfunction_t *PRVM_ED_FindFunction(const char *name);
729
730 int PRVM_ED_FindFieldOffset(const char *name);
731 int PRVM_ED_FindGlobalOffset(const char *name);
732 func_t PRVM_ED_FindFunctionOffset(const char *name);
733 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
734 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
735
736 void PRVM_MEM_IncreaseEdicts(void);
737
738 qboolean PRVM_ED_CanAlloc(prvm_edict_t *e);
739 prvm_edict_t *PRVM_ED_Alloc (void);
740 void PRVM_ED_Free (prvm_edict_t *ed);
741 void PRVM_ED_ClearEdict (prvm_edict_t *e);
742
743 void PRVM_PrintFunctionStatements (const char *name);
744 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
745 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
746 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
747
748 void PRVM_ED_WriteGlobals (qfile_t *f);
749 void PRVM_ED_ParseGlobals (const char *data);
750
751 void PRVM_ED_LoadFromFile (const char *data);
752
753 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, const char *filename, int fileline);
754 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
755 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
756
757 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
758 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
759 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
760
761 #define PRVM_NEXT_EDICT(e) ((e) + 1)
762
763 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
764 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
765 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
766 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
767
768 //============================================================================
769
770 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
771 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
772 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
773 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
774 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
775 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
776 //#define       PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
777
778 // FIXME: make these go away?
779 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
780 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
781 //#define       PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
782 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
783
784 extern  int             prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
785 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
786
787 void PRVM_Init_Exec(void);
788
789 void PRVM_ED_PrintEdicts_f (void);
790 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
791
792 const char *PRVM_GetString(int num);
793 int PRVM_SetEngineString(const char *s);
794 const char *PRVM_ChangeEngineString(int i, const char *s);
795 int PRVM_SetTempString(const char *s);
796 int PRVM_AllocString(size_t bufferlength, char **pointer);
797 void PRVM_FreeString(int num);
798
799 //============================================================================
800
801 // used as replacement for a prog stack
802 //#define PRVM_DEBUGPRSTACK
803
804 #ifdef PRVM_DEBUGPRSTACK
805 #define PRVM_Begin  if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
806 #define PRVM_End        prog = 0
807 #else
808 #define PRVM_Begin
809 #define PRVM_End        prog = 0
810 #endif
811
812 //#define PRVM_SAFENAME
813 #ifndef PRVM_SAFENAME
814 #       define PRVM_NAME        (prog->name)
815 #else
816 #       define PRVM_NAME        (prog->name ? prog->name : "Unknown prog name")
817 #endif
818
819 // helper macro to make function pointer calls easier
820 #define PRVM_GCALL(func)        if(prog->func) prog->func
821
822 #define PRVM_ERROR              prog->error_cmd
823
824 // other prog handling functions
825 qboolean PRVM_SetProgFromString(const char *str);
826 void PRVM_SetProg(int prognr);
827
828 /*
829 Initializing a vm:
830 Call InitProg with the num
831 Set up the fields marked with [INIT] in the prog struct
832 Load a program with LoadProgs
833 */
834 void PRVM_InitProg(int prognr);
835 // LoadProgs expects to be called right after InitProg
836 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, const char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, prvm_required_field_t *required_global);
837 void PRVM_ResetProg(void);
838
839 qboolean PRVM_ProgLoaded(int prognr);
840
841 int     PRVM_GetProgNr(void);
842
843 void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
844
845 // TODO: fill in the params
846 //void PRVM_Create();
847
848 void VM_GenerateFrameGroupBlend(framegroupblend_t *framegroupblend, const prvm_edict_t *ed);
849 void VM_FrameBlendFromFrameGroupBlend(frameblend_t *frameblend, const framegroupblend_t *framegroupblend, const dp_model_t *model);
850 void VM_UpdateEdictSkeleton(prvm_edict_t *ed, const dp_model_t *edmodel, const frameblend_t *frameblend);
851 void VM_RemoveEdictSkeleton(prvm_edict_t *ed);
852
853 #endif