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