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 <stddef.h>
  33 #include "qtypes.h"
  34 #include "qdefs.h"
  35 #include "common.h"
  36 #include "zone.h"
  37 #include "pr_comp.h"                    // defs shared with qcc
  38 #include "progdefs.h"                   // generated by program cdefs
  39 #include "clprogdefs.h"                 // generated by program cdefs
  40
  41 struct framegroupblend_s;
  42 struct frameblend_s;
  43 struct cmd_state_s;
  44 struct qfile_s;
  45
  46 #ifndef DP_SMALLMEMORY
  47 #define PROFILING
  48 #endif
  49
  50 typedef struct prvm_stack_s
  51 {
  52         int                             s;
  53         mfunction_t             *f;
  54         double                  tprofile_acc;
  55         double                  profile_acc;
  56         double                  builtinsprofile_acc;
  57 } prvm_stack_t;
  58
  59
  60 typedef union prvm_eval_s
  61 {
  62         prvm_int_t              string;
  63         prvm_vec_t      _float;
  64         prvm_vec_t      vector[3];
  65         prvm_int_t              function;
  66         prvm_int_t              ivector[3];
  67         prvm_int_t              _int;
  68         prvm_int_t              edict;
  69 } prvm_eval_t;
  70
  71 typedef struct prvm_required_field_s
  72 {
  73         int type;
  74         const char *name;
  75 } prvm_required_field_t;
  76
  77 #define PRVM_EDICT_MARK_WAIT_FOR_SETORIGIN -1
  78 #define PRVM_EDICT_MARK_SETORIGIN_CAUGHT -2
  79 // AK: I dont call it engine private cause it doesnt really belongs to the engine
  80 //     it belongs to prvm.
  81 typedef struct prvm_edict_private_s
  82 {
  83         // mark for the leak detector
  84         int mark;
  85         // place in the code where it was allocated (for the leak detector)
  86         const char *allocation_origin;
  87 } prvm_edict_private_t;
  88
  89 typedef struct prvm_edict_s
  90 {
  91         // true if this edict is unused
  92         qbool free;
  93         // sv.time when the object was freed (to prevent early reuse which could
  94         // mess up client interpolation or obscure severe QuakeC bugs)
  95         double freetime;
  96
  97         // engine-private fields (stored in dynamically resized array)
  98         union
  99         {
 100                 prvm_edict_private_t *required;
 101                 prvm_vec_t *fp;
 102                 prvm_int_t *ip;
 103                 // FIXME: this server pointer really means world, not server
 104                 // (it is used by both server qc and client qc, but not menu qc)
 105                 struct edict_engineprivate_s *server;
 106                 // add other private structs as you desire
 107                 // new structs have to start with the elements of prvm_edit_private_t
 108                 // e.g. a new struct has to either look like this:
 109                 //      typedef struct server_edict_private_s {
 110                 //              prvm_edict_private_t base;
 111                 //              vec3_t moved_from;
 112                 //      vec3_t moved_fromangles;
 113                 //              ... } server_edict_private_t;
 114                 // or:
 115                 //      typedef struct server_edict_private_s {
 116                 //              qbool free;
 117                 //              float freetime;
 118                 //              vec3_t moved_from;
 119                 //      vec3_t moved_fromangles;
 120                 //              ... } server_edict_private_t;
 121                 // However, the first one should be preferred.
 122         } priv;
 123         // QuakeC fields (stored in dynamically resized array)
 124         union
 125         {
 126                 prvm_vec_t *fp;
 127                 prvm_int_t *ip;
 128 //              entvars_t               *server;
 129 //              cl_entvars_t    *client;
 130         } fields;
 131 } prvm_edict_t;
 132
 133 extern prvm_eval_t prvm_badvalue;
 134
 135 #define PRVM_alledictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
 136 #define PRVM_alledictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
 137 #define PRVM_alledictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
 138 #define PRVM_alledictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
 139 #define PRVM_alledictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
 140 #define PRVM_allglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
 141 #define PRVM_allglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
 142 #define PRVM_allglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
 143 #define PRVM_allglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
 144 #define PRVM_allglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
 145 #define PRVM_allfunction(funcname)           (prog->funcoffsets.funcname)
 146
 147 #define PRVM_drawedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
 148 #define PRVM_drawedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
 149 #define PRVM_drawedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
 150 #define PRVM_drawedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
 151 #define PRVM_drawedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
 152 #define PRVM_drawglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
 153 #define PRVM_drawglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
 154 #define PRVM_drawglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
 155 #define PRVM_drawglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
 156 #define PRVM_drawglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
 157 #define PRVM_drawfunction(funcname)           (prog->funcoffsets.funcname)
 158
 159 #define PRVM_gameedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
 160 #define PRVM_gameedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
 161 #define PRVM_gameedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
 162 #define PRVM_gameedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
 163 #define PRVM_gameedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
 164 #define PRVM_gameglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
 165 #define PRVM_gameglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
 166 #define PRVM_gameglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
 167 #define PRVM_gameglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
 168 #define PRVM_gameglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
 169 #define PRVM_gamefunction(funcname)           (prog->funcoffsets.funcname)
 170
 171 #define PRVM_serveredictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
 172 #define PRVM_serveredictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
 173 #define PRVM_serveredictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
 174 #define PRVM_serveredictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
 175 #define PRVM_serveredictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
 176 #define PRVM_serverglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
 177 #define PRVM_serverglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
 178 #define PRVM_serverglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
 179 #define PRVM_serverglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
 180 #define PRVM_serverglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
 181 #define PRVM_serverfunction(funcname)           (prog->funcoffsets.funcname)
 182
 183 #define PRVM_clientedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
 184 #define PRVM_clientedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
 185 #define PRVM_clientedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
 186 #define PRVM_clientedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
 187 #define PRVM_clientedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
 188 #define PRVM_clientglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
 189 #define PRVM_clientglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
 190 #define PRVM_clientglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
 191 #define PRVM_clientglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
 192 #define PRVM_clientglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
 193 #define PRVM_clientfunction(funcname)           (prog->funcoffsets.funcname)
 194
 195 #define PRVM_menuedictfloat(ed, fieldname)    (PRVM_EDICTFIELDFLOAT(ed, prog->fieldoffsets.fieldname))
 196 #define PRVM_menuedictvector(ed, fieldname)   (PRVM_EDICTFIELDVECTOR(ed, prog->fieldoffsets.fieldname))
 197 #define PRVM_menuedictstring(ed, fieldname)   (PRVM_EDICTFIELDSTRING(ed, prog->fieldoffsets.fieldname))
 198 #define PRVM_menuedictedict(ed, fieldname)    (PRVM_EDICTFIELDEDICT(ed, prog->fieldoffsets.fieldname))
 199 #define PRVM_menuedictfunction(ed, fieldname) (PRVM_EDICTFIELDFUNCTION(ed, prog->fieldoffsets.fieldname))
 200 #define PRVM_menuglobalfloat(fieldname)       (PRVM_GLOBALFIELDFLOAT(prog->globaloffsets.fieldname))
 201 #define PRVM_menuglobalvector(fieldname)      (PRVM_GLOBALFIELDVECTOR(prog->globaloffsets.fieldname))
 202 #define PRVM_menuglobalstring(fieldname)      (PRVM_GLOBALFIELDSTRING(prog->globaloffsets.fieldname))
 203 #define PRVM_menuglobaledict(fieldname)       (PRVM_GLOBALFIELDEDICT(prog->globaloffsets.fieldname))
 204 #define PRVM_menuglobalfunction(fieldname)    (PRVM_GLOBALFIELDFUNCTION(prog->globaloffsets.fieldname))
 205 #define PRVM_menufunction(funcname)           (prog->funcoffsets.funcname)
 206
 207 #if 1
 208 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset)    ((fieldoffset) < 0 ? Con_Printf("Invalid fieldoffset at %s:%i\n", __FILE__, __LINE__), &prvm_badvalue : (prvm_eval_t *)((ed)->fields.fp + (fieldoffset)))
 209 #define PRVM_EDICTFIELDFLOAT(ed, fieldoffset)    (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->_float)
 210 #define PRVM_EDICTFIELDVECTOR(ed, fieldoffset)   (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->vector)
 211 #define PRVM_EDICTFIELDSTRING(ed, fieldoffset)   (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->string)
 212 #define PRVM_EDICTFIELDEDICT(ed, fieldoffset)    (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->edict)
 213 #define PRVM_EDICTFIELDFUNCTION(ed, fieldoffset) (PRVM_EDICTFIELDVALUE(ed, fieldoffset)->function)
 214 #define PRVM_GLOBALFIELDVALUE(fieldoffset)       ((fieldoffset) < 0 ? Con_Printf("Invalid fieldoffset at %s:%i\n", __FILE__, __LINE__), &prvm_badvalue : (prvm_eval_t *)(prog->globals.fp + (fieldoffset)))
 215 #define PRVM_GLOBALFIELDFLOAT(fieldoffset)       (PRVM_GLOBALFIELDVALUE(fieldoffset)->_float)
 216 #define PRVM_GLOBALFIELDVECTOR(fieldoffset)      (PRVM_GLOBALFIELDVALUE(fieldoffset)->vector)
 217 #define PRVM_GLOBALFIELDSTRING(fieldoffset)      (PRVM_GLOBALFIELDVALUE(fieldoffset)->string)
 218 #define PRVM_GLOBALFIELDEDICT(fieldoffset)       (PRVM_GLOBALFIELDVALUE(fieldoffset)->edict)
 219 #define PRVM_GLOBALFIELDFUNCTION(fieldoffset)    (PRVM_GLOBALFIELDVALUE(fieldoffset)->function)
 220 #else
 221 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) ((prvm_eval_t *)(ed->fields.fp + fieldoffset))
 222 #define PRVM_EDICTFIELDFLOAT(ed, fieldoffset) (((prvm_eval_t *)(ed->fields.fp + fieldoffset))->_float)
 223 #define PRVM_EDICTFIELDVECTOR(ed, fieldoffset) (((prvm_eval_t *)(ed->fields.fp + fieldoffset))->vector)
 224 #define PRVM_EDICTFIELDSTRING(ed, fieldoffset) (((prvm_eval_t *)(ed->fields.fp + fieldoffset))->string)
 225 #define PRVM_EDICTFIELDEDICT(ed, fieldoffset) (((prvm_eval_t *)(ed->fields.fp + fieldoffset))->edict)
 226 #define PRVM_EDICTFIELDFUNCTION(ed, fieldoffset) (((prvm_eval_t *)(ed->fields.fp + fieldoffset))->function)
 227 #define PRVM_GLOBALFIELDVALUE(fieldoffset) ((prvm_eval_t *)(prog->globals.fp + fieldoffset))
 228 #define PRVM_GLOBALFIELDFLOAT(fieldoffset) (((prvm_eval_t *)(prog->globals.fp + fieldoffset))->_float)
 229 #define PRVM_GLOBALFIELDVECTOR(fieldoffset) (((prvm_eval_t *)(prog->globals.fp + fieldoffset))->vector)
 230 #define PRVM_GLOBALFIELDSTRING(fieldoffset) (((prvm_eval_t *)(prog->globals.fp + fieldoffset))->string)
 231 #define PRVM_GLOBALFIELDEDICT(fieldoffset) (((prvm_eval_t *)(prog->globals.fp + fieldoffset))->edict)
 232 #define PRVM_GLOBALFIELDFUNCTION(fieldoffset) (((prvm_eval_t *)(prog->globals.fp + fieldoffset))->function)
 233 #endif
 234
 235 //============================================================================
 236 // prog->flag
 237 #define PRVM_OP_STATE       1
 238 #define PRVM_CSQC_SIMPLE    2
 239
 240 #ifdef DP_SMALLMEMORY
 241 #define PRVM_MAX_STACK_DEPTH            128
 242 #define PRVM_LOCALSTACK_SIZE            2048
 243
 244 #define PRVM_MAX_OPENFILES 16
 245 #define PRVM_MAX_OPENSEARCHES 8
 246 #else
 247 #define PRVM_MAX_STACK_DEPTH            1024
 248 #define PRVM_LOCALSTACK_SIZE            16384
 249
 250 #define PRVM_MAX_OPENFILES 256
 251 #define PRVM_MAX_OPENSEARCHES 128
 252 #endif
 253
 254 struct prvm_prog_s;
 255 typedef void (*prvm_builtin_t) (struct prvm_prog_s *prog);
 256
 257 // NOTE: field offsets use -1 for NULL
 258 typedef struct prvm_prog_fieldoffsets_s
 259 {
 260 #define PRVM_DECLARE_serverglobalfloat(x)
 261 #define PRVM_DECLARE_serverglobalvector(x)
 262 #define PRVM_DECLARE_serverglobalstring(x)
 263 #define PRVM_DECLARE_serverglobaledict(x)
 264 #define PRVM_DECLARE_serverglobalfunction(x)
 265 #define PRVM_DECLARE_clientglobalfloat(x)
 266 #define PRVM_DECLARE_clientglobalvector(x)
 267 #define PRVM_DECLARE_clientglobalstring(x)
 268 #define PRVM_DECLARE_clientglobaledict(x)
 269 #define PRVM_DECLARE_clientglobalfunction(x)
 270 #define PRVM_DECLARE_menuglobalfloat(x)
 271 #define PRVM_DECLARE_menuglobalvector(x)
 272 #define PRVM_DECLARE_menuglobalstring(x)
 273 #define PRVM_DECLARE_menuglobaledict(x)
 274 #define PRVM_DECLARE_menuglobalfunction(x)
 275 #define PRVM_DECLARE_serverfieldfloat(x)
 276 #define PRVM_DECLARE_serverfieldvector(x)
 277 #define PRVM_DECLARE_serverfieldstring(x)
 278 #define PRVM_DECLARE_serverfieldedict(x)
 279 #define PRVM_DECLARE_serverfieldfunction(x)
 280 #define PRVM_DECLARE_clientfieldfloat(x)
 281 #define PRVM_DECLARE_clientfieldvector(x)
 282 #define PRVM_DECLARE_clientfieldstring(x)
 283 #define PRVM_DECLARE_clientfieldedict(x)
 284 #define PRVM_DECLARE_clientfieldfunction(x)
 285 #define PRVM_DECLARE_menufieldfloat(x)
 286 #define PRVM_DECLARE_menufieldvector(x)
 287 #define PRVM_DECLARE_menufieldstring(x)
 288 #define PRVM_DECLARE_menufieldedict(x)
 289 #define PRVM_DECLARE_menufieldfunction(x)
 290 #define PRVM_DECLARE_serverfunction(x)
 291 #define PRVM_DECLARE_clientfunction(x)
 292 #define PRVM_DECLARE_menufunction(x)
 293 #define PRVM_DECLARE_field(x) int x;
 294 #define PRVM_DECLARE_global(x)
 295 #define PRVM_DECLARE_function(x)
 296 #include "prvm_offsets.h"
 297 #undef PRVM_DECLARE_serverglobalfloat
 298 #undef PRVM_DECLARE_serverglobalvector
 299 #undef PRVM_DECLARE_serverglobalstring
 300 #undef PRVM_DECLARE_serverglobaledict
 301 #undef PRVM_DECLARE_serverglobalfunction
 302 #undef PRVM_DECLARE_clientglobalfloat
 303 #undef PRVM_DECLARE_clientglobalvector
 304 #undef PRVM_DECLARE_clientglobalstring
 305 #undef PRVM_DECLARE_clientglobaledict
 306 #undef PRVM_DECLARE_clientglobalfunction
 307 #undef PRVM_DECLARE_menuglobalfloat
 308 #undef PRVM_DECLARE_menuglobalvector
 309 #undef PRVM_DECLARE_menuglobalstring
 310 #undef PRVM_DECLARE_menuglobaledict
 311 #undef PRVM_DECLARE_menuglobalfunction
 312 #undef PRVM_DECLARE_serverfieldfloat
 313 #undef PRVM_DECLARE_serverfieldvector
 314 #undef PRVM_DECLARE_serverfieldstring
 315 #undef PRVM_DECLARE_serverfieldedict
 316 #undef PRVM_DECLARE_serverfieldfunction
 317 #undef PRVM_DECLARE_clientfieldfloat
 318 #undef PRVM_DECLARE_clientfieldvector
 319 #undef PRVM_DECLARE_clientfieldstring
 320 #undef PRVM_DECLARE_clientfieldedict
 321 #undef PRVM_DECLARE_clientfieldfunction
 322 #undef PRVM_DECLARE_menufieldfloat
 323 #undef PRVM_DECLARE_menufieldvector
 324 #undef PRVM_DECLARE_menufieldstring
 325 #undef PRVM_DECLARE_menufieldedict
 326 #undef PRVM_DECLARE_menufieldfunction
 327 #undef PRVM_DECLARE_serverfunction
 328 #undef PRVM_DECLARE_clientfunction
 329 #undef PRVM_DECLARE_menufunction
 330 #undef PRVM_DECLARE_field
 331 #undef PRVM_DECLARE_global
 332 #undef PRVM_DECLARE_function
 333 }
 334 prvm_prog_fieldoffsets_t;
 335
 336 // NOTE: global offsets use -1 for NULL
 337 typedef struct prvm_prog_globaloffsets_s
 338 {
 339 #define PRVM_DECLARE_serverglobalfloat(x)
 340 #define PRVM_DECLARE_serverglobalvector(x)
 341 #define PRVM_DECLARE_serverglobalstring(x)
 342 #define PRVM_DECLARE_serverglobaledict(x)
 343 #define PRVM_DECLARE_serverglobalfunction(x)
 344 #define PRVM_DECLARE_clientglobalfloat(x)
 345 #define PRVM_DECLARE_clientglobalvector(x)
 346 #define PRVM_DECLARE_clientglobalstring(x)
 347 #define PRVM_DECLARE_clientglobaledict(x)
 348 #define PRVM_DECLARE_clientglobalfunction(x)
 349 #define PRVM_DECLARE_menuglobalfloat(x)
 350 #define PRVM_DECLARE_menuglobalvector(x)
 351 #define PRVM_DECLARE_menuglobalstring(x)
 352 #define PRVM_DECLARE_menuglobaledict(x)
 353 #define PRVM_DECLARE_menuglobalfunction(x)
 354 #define PRVM_DECLARE_serverfieldfloat(x)
 355 #define PRVM_DECLARE_serverfieldvector(x)
 356 #define PRVM_DECLARE_serverfieldstring(x)
 357 #define PRVM_DECLARE_serverfieldedict(x)
 358 #define PRVM_DECLARE_serverfieldfunction(x)
 359 #define PRVM_DECLARE_clientfieldfloat(x)
 360 #define PRVM_DECLARE_clientfieldvector(x)
 361 #define PRVM_DECLARE_clientfieldstring(x)
 362 #define PRVM_DECLARE_clientfieldedict(x)
 363 #define PRVM_DECLARE_clientfieldfunction(x)
 364 #define PRVM_DECLARE_menufieldfloat(x)
 365 #define PRVM_DECLARE_menufieldvector(x)
 366 #define PRVM_DECLARE_menufieldstring(x)
 367 #define PRVM_DECLARE_menufieldedict(x)
 368 #define PRVM_DECLARE_menufieldfunction(x)
 369 #define PRVM_DECLARE_serverfunction(x)
 370 #define PRVM_DECLARE_clientfunction(x)
 371 #define PRVM_DECLARE_menufunction(x)
 372 #define PRVM_DECLARE_field(x)
 373 #define PRVM_DECLARE_global(x) int x;
 374 #define PRVM_DECLARE_function(x)
 375 #include "prvm_offsets.h"
 376 #undef PRVM_DECLARE_serverglobalfloat
 377 #undef PRVM_DECLARE_serverglobalvector
 378 #undef PRVM_DECLARE_serverglobalstring
 379 #undef PRVM_DECLARE_serverglobaledict
 380 #undef PRVM_DECLARE_serverglobalfunction
 381 #undef PRVM_DECLARE_clientglobalfloat
 382 #undef PRVM_DECLARE_clientglobalvector
 383 #undef PRVM_DECLARE_clientglobalstring
 384 #undef PRVM_DECLARE_clientglobaledict
 385 #undef PRVM_DECLARE_clientglobalfunction
 386 #undef PRVM_DECLARE_menuglobalfloat
 387 #undef PRVM_DECLARE_menuglobalvector
 388 #undef PRVM_DECLARE_menuglobalstring
 389 #undef PRVM_DECLARE_menuglobaledict
 390 #undef PRVM_DECLARE_menuglobalfunction
 391 #undef PRVM_DECLARE_serverfieldfloat
 392 #undef PRVM_DECLARE_serverfieldvector
 393 #undef PRVM_DECLARE_serverfieldstring
 394 #undef PRVM_DECLARE_serverfieldedict
 395 #undef PRVM_DECLARE_serverfieldfunction
 396 #undef PRVM_DECLARE_clientfieldfloat
 397 #undef PRVM_DECLARE_clientfieldvector
 398 #undef PRVM_DECLARE_clientfieldstring
 399 #undef PRVM_DECLARE_clientfieldedict
 400 #undef PRVM_DECLARE_clientfieldfunction
 401 #undef PRVM_DECLARE_menufieldfloat
 402 #undef PRVM_DECLARE_menufieldvector
 403 #undef PRVM_DECLARE_menufieldstring
 404 #undef PRVM_DECLARE_menufieldedict
 405 #undef PRVM_DECLARE_menufieldfunction
 406 #undef PRVM_DECLARE_serverfunction
 407 #undef PRVM_DECLARE_clientfunction
 408 #undef PRVM_DECLARE_menufunction
 409 #undef PRVM_DECLARE_field
 410 #undef PRVM_DECLARE_global
 411 #undef PRVM_DECLARE_function
 412 }
 413 prvm_prog_globaloffsets_t;
 414
 415 // NOTE: function offsets use 0 for NULL
 416 typedef struct prvm_prog_funcoffsets_s
 417 {
 418 #define PRVM_DECLARE_serverglobalfloat(x)
 419 #define PRVM_DECLARE_serverglobalvector(x)
 420 #define PRVM_DECLARE_serverglobalstring(x)
 421 #define PRVM_DECLARE_serverglobaledict(x)
 422 #define PRVM_DECLARE_serverglobalfunction(x)
 423 #define PRVM_DECLARE_clientglobalfloat(x)
 424 #define PRVM_DECLARE_clientglobalvector(x)
 425 #define PRVM_DECLARE_clientglobalstring(x)
 426 #define PRVM_DECLARE_clientglobaledict(x)
 427 #define PRVM_DECLARE_clientglobalfunction(x)
 428 #define PRVM_DECLARE_menuglobalfloat(x)
 429 #define PRVM_DECLARE_menuglobalvector(x)
 430 #define PRVM_DECLARE_menuglobalstring(x)
 431 #define PRVM_DECLARE_menuglobaledict(x)
 432 #define PRVM_DECLARE_menuglobalfunction(x)
 433 #define PRVM_DECLARE_serverfieldfloat(x)
 434 #define PRVM_DECLARE_serverfieldvector(x)
 435 #define PRVM_DECLARE_serverfieldstring(x)
 436 #define PRVM_DECLARE_serverfieldedict(x)
 437 #define PRVM_DECLARE_serverfieldfunction(x)
 438 #define PRVM_DECLARE_clientfieldfloat(x)
 439 #define PRVM_DECLARE_clientfieldvector(x)
 440 #define PRVM_DECLARE_clientfieldstring(x)
 441 #define PRVM_DECLARE_clientfieldedict(x)
 442 #define PRVM_DECLARE_clientfieldfunction(x)
 443 #define PRVM_DECLARE_menufieldfloat(x)
 444 #define PRVM_DECLARE_menufieldvector(x)
 445 #define PRVM_DECLARE_menufieldstring(x)
 446 #define PRVM_DECLARE_menufieldedict(x)
 447 #define PRVM_DECLARE_menufieldfunction(x)
 448 #define PRVM_DECLARE_serverfunction(x)
 449 #define PRVM_DECLARE_clientfunction(x)
 450 #define PRVM_DECLARE_menufunction(x)
 451 #define PRVM_DECLARE_field(x)
 452 #define PRVM_DECLARE_global(x)
 453 #define PRVM_DECLARE_function(x) int x;
 454 #include "prvm_offsets.h"
 455 #undef PRVM_DECLARE_serverglobalfloat
 456 #undef PRVM_DECLARE_serverglobalvector
 457 #undef PRVM_DECLARE_serverglobalstring
 458 #undef PRVM_DECLARE_serverglobaledict
 459 #undef PRVM_DECLARE_serverglobalfunction
 460 #undef PRVM_DECLARE_clientglobalfloat
 461 #undef PRVM_DECLARE_clientglobalvector
 462 #undef PRVM_DECLARE_clientglobalstring
 463 #undef PRVM_DECLARE_clientglobaledict
 464 #undef PRVM_DECLARE_clientglobalfunction
 465 #undef PRVM_DECLARE_menuglobalfloat
 466 #undef PRVM_DECLARE_menuglobalvector
 467 #undef PRVM_DECLARE_menuglobalstring
 468 #undef PRVM_DECLARE_menuglobaledict
 469 #undef PRVM_DECLARE_menuglobalfunction
 470 #undef PRVM_DECLARE_serverfieldfloat
 471 #undef PRVM_DECLARE_serverfieldvector
 472 #undef PRVM_DECLARE_serverfieldstring
 473 #undef PRVM_DECLARE_serverfieldedict
 474 #undef PRVM_DECLARE_serverfieldfunction
 475 #undef PRVM_DECLARE_clientfieldfloat
 476 #undef PRVM_DECLARE_clientfieldvector
 477 #undef PRVM_DECLARE_clientfieldstring
 478 #undef PRVM_DECLARE_clientfieldedict
 479 #undef PRVM_DECLARE_clientfieldfunction
 480 #undef PRVM_DECLARE_menufieldfloat
 481 #undef PRVM_DECLARE_menufieldvector
 482 #undef PRVM_DECLARE_menufieldstring
 483 #undef PRVM_DECLARE_menufieldedict
 484 #undef PRVM_DECLARE_menufieldfunction
 485 #undef PRVM_DECLARE_serverfunction
 486 #undef PRVM_DECLARE_clientfunction
 487 #undef PRVM_DECLARE_menufunction
 488 #undef PRVM_DECLARE_field
 489 #undef PRVM_DECLARE_global
 490 #undef PRVM_DECLARE_function
 491 }
 492 prvm_prog_funcoffsets_t;
 493
 494 // stringbuffer flags
 495 #define STRINGBUFFER_SAVED     1   // saved in savegames
 496 #define STRINGBUFFER_QCFLAGS   1   // allowed to be set by QC
 497 #define STRINGBUFFER_TEMP      128 // internal use ONLY
 498 typedef struct prvm_stringbuffer_s
 499 {
 500         int max_strings;
 501         int num_strings;
 502         char **strings;
 503         const char *origin;
 504         unsigned char flags;
 505 }
 506 prvm_stringbuffer_t;
 507
 508 // flags for knownstrings
 509 #define KNOWNSTRINGFLAG_ENGINE 1
 510 #define KNOWNSTRINGFLAG_GCMARK 2
 511 #define KNOWNSTRINGFLAG_GCPRUNE 4 // cleared by GCMARK code, string is freed if prune remains after two sweeps
 512
 513 typedef enum prvm_prog_garbagecollection_state_stage_e
 514 {
 515         PRVM_GC_START = 0,
 516         PRVM_GC_GLOBALS_MARK,
 517         PRVM_GC_FIELDS_MARK,
 518         PRVM_GC_KNOWNSTRINGS_SWEEP,
 519         PRVM_GC_RESET,
 520 }
 521 prvm_prog_garbagecollection_state_stage_t;
 522
 523 typedef struct prvm_prog_garbagecollection_state_s
 524 {
 525         int stage;
 526         int globals_mark_progress;
 527         int fields_mark_progress;
 528         int fields_mark_progress_entity;
 529         int knownstrings_sweep_progress;
 530 }
 531 prvm_prog_garbagecollection_state_t;
 532
 533 // [INIT] variables flagged with this token can be initialized by 'you'
 534 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
 535 typedef struct prvm_prog_s
 536 {
 537         double                          starttime; // system time when PRVM_Prog_Load was called
 538         double                          inittime; // system time when QC initialization code finished (any entity created before is not a leak)
 539         double                          profiletime; // system time when last PRVM_CallProfile was called (or PRVM_Prog_Load initially)
 540         mfunction_t                     *functions;
 541         int                             functions_covered;
 542         char                            *strings;
 543         int                                     stringssize;
 544         mdef_t                          *fielddefs;
 545         mdef_t                          *globaldefs;
 546         mstatement_t            *statements;
 547         int                                     entityfields;                   // number of vec_t fields in progs (some variables are 3)
 548         int                                     entityfieldsarea;               // LadyHavoc: equal to max_edicts * entityfields (for bounds checking)
 549
 550         // loaded values from the disk format
 551         int                                     progs_version;
 552         int                                     progs_crc;
 553         int                                     progs_numstatements;
 554         int                                     progs_numglobaldefs;
 555         int                                     progs_numfielddefs;
 556         int                                     progs_numfunctions;
 557         int                                     progs_numstrings;
 558         int                                     progs_numglobals;
 559         int                                     progs_entityfields;
 560
 561         // real values in memory (some modified by loader)
 562         int                                     numstatements;
 563         int                                     numglobaldefs;
 564         int                                     numfielddefs;
 565         int                                     numfunctions;
 566         int                                     numstrings;
 567         int                                     numglobals;
 568
 569         int                                     *statement_linenums; // NULL if not available
 570         int                                     *statement_columnnums; // NULL if not available
 571
 572         double                          *statement_profile; // only incremented if prvm_statementprofiling is on
 573         int                             statements_covered;
 574         double                          *explicit_profile; // only incremented if prvm_statementprofiling is on
 575         int                             explicit_covered;
 576         int                             numexplicitcoveragestatements;
 577
 578         union {
 579                 prvm_vec_t *fp;
 580                 prvm_int_t *ip;
 581 //              globalvars_t *server;
 582 //              cl_globalvars_t *client;
 583         } globals;
 584
 585         int                                     maxknownstrings;
 586         int                                     numknownstrings;
 587         // this is updated whenever a string is removed or added
 588         // (simple optimization of the free string search)
 589         int                                     firstfreeknownstring;
 590         const char                      **knownstrings;
 591         unsigned char           *knownstrings_flags;
 592         const char          **knownstrings_origin;
 593         const char                      ***stringshash;
 594
 595         memexpandablearray_t    stringbuffersarray;
 596
 597         // garbage collection status
 598         prvm_prog_garbagecollection_state_t gc;
 599
 600         // all memory allocations related to this vm_prog (code, edicts, strings)
 601         mempool_t                       *progs_mempool; // [INIT]
 602
 603         prvm_builtin_t          *builtins; // [INIT]
 604         int                                     numbuiltins; // [INIT]
 605
 606         int                                     argc;
 607
 608         int                                     trace;
 609         int                                     break_statement;
 610         int                                     break_stack_index;
 611         int                                     watch_global;
 612         etype_t                                 watch_global_type;
 613         prvm_eval_t                             watch_global_value;
 614         int                                     watch_edict;
 615         int                                     watch_field;
 616         etype_t                                 watch_field_type;
 617         prvm_eval_t                             watch_edictfield_value;
 618
 619         mfunction_t                     *xfunction;
 620         int                                     xstatement;
 621
 622         // stacktrace writes into stack[MAX_STACK_DEPTH]
 623         // thus increase the array, so depth wont be overwritten
 624         prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
 625         int                                     depth;
 626
 627         prvm_int_t                      localstack[PRVM_LOCALSTACK_SIZE];
 628         int                                     localstack_used;
 629
 630         unsigned short          filecrc;
 631
 632         //============================================================================
 633         // until this point everything also exists (with the pr_ prefix) in the old vm
 634
 635         struct qfile_s                          *openfiles[PRVM_MAX_OPENFILES];
 636         const char *         openfiles_origin[PRVM_MAX_OPENFILES];
 637         struct fssearch_s                       *opensearches[PRVM_MAX_OPENSEARCHES];
 638         const char *         opensearches_origin[PRVM_MAX_OPENSEARCHES];
 639         struct skeleton_s       *skeletons[MAX_EDICTS];
 640         struct cmd_state_s      *console_cmd; // points to the relevant console command interpreter for this vm (cmd_local or &cmd_server), also used to access cvars
 641
 642         // buffer for storing all tempstrings created during one invocation of ExecuteProgram
 643         sizebuf_t                       tempstringsbuf;
 644
 645         // polygonbegin, polygonvertex, polygonend state
 646         // the polygon is buffered here until polygonend commits it to the relevant
 647         // CL_Mesh entity, because important decisions depend on the vertex data
 648         // provided (e.g. whether the polygon is transparent), we can't really do much
 649         // with it until we have all of the data...
 650
 651         // this tracks the last polygonbegin's choice of
 652         // CL_Mesh_CSQC or CL_Mesh_UI for this polygon
 653         struct model_s          *polygonbegin_model;
 654         // indicates if polygonbegin should be interpreted as 2d
 655         // (clearscene sets this to false, renderscene sets this to true, drawpic
 656         //  also sets this to true)
 657         // note that in FTEQW polygonbegin with 2 args is handled very differently,
 658         // where the behavior is always 3D unless DRAWFLAG_2D is passed, but
 659         // DRAWFLAG_2D conflicts with our DRAWFLAG_SCREEN.
 660         qbool                   polygonbegin_guess2d;
 661         // the texture name and drawflags provided to polygonbegin
 662         char                            polygonbegin_texname[MAX_QPATH];
 663         int                                     polygonbegin_drawflags;
 664         // the vertex data
 665         int                                     polygonbegin_numvertices;
 666         int                                     polygonbegin_maxvertices;
 667         float                           *polygonbegin_vertexdata;
 668
 669         // copies of some vars that were former read from sv
 670         int                                     num_edicts;
 671         // number of edicts for which space has been (should be) allocated
 672         int                                     max_edicts; // [INIT]
 673         // used instead of the constant MAX_EDICTS
 674         int                                     limit_edicts; // [INIT]
 675
 676         // number of reserved edicts (allocated from 1)
 677         int                                     reserved_edicts; // [INIT]
 678
 679         prvm_edict_t            *edicts;
 680         union
 681         {
 682                 prvm_vec_t *fp;
 683                 prvm_int_t *ip;
 684         } edictsfields;
 685         void                            *edictprivate;
 686
 687         // size of the engine private struct
 688         int                                     edictprivate_size; // [INIT]
 689
 690         prvm_prog_fieldoffsets_t        fieldoffsets;
 691         prvm_prog_globaloffsets_t       globaloffsets;
 692         prvm_prog_funcoffsets_t funcoffsets;
 693
 694         // allow writing to world entity fields, this is set by server init and
 695         // cleared before first server frame
 696         qbool                   allowworldwrites;
 697
 698         // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
 699         const char                      *name; // [INIT]
 700
 701         // flag - used to store general flags like PRVM_GE_SELF, etc.
 702         unsigned                        flag;
 703
 704         const char                      **extensionstring; // [INIT]
 705
 706         qbool                   loadintoworld; // [INIT]
 707
 708         // used to indicate whether a prog is loaded
 709         qbool                   loaded;
 710         qbool                   leaktest_active;
 711
 712         // translation buffer (only needs to be freed on unloading progs, type is private to prvm_edict.c)
 713         void *po;
 714
 715         // printed together with backtraces
 716         const char *statestring;
 717
 718         struct animatemodel_cache *animatemodel_cache;
 719
 720 //      prvm_builtin_mem_t  *mem_list;
 721
 722 // now passed as parameter of PRVM_Prog_Load
 723 //      char                            **required_func;
 724 //      int                                     numrequiredfunc;
 725
 726         //============================================================================
 727
 728         mdef_t                          *self; // if self != 0 then there is a global self
 729
 730         //============================================================================
 731         // function pointers
 732
 733         void                            (*begin_increase_edicts)(struct prvm_prog_s *prog); // [INIT] used by PRVM_MEM_Increase_Edicts
 734         void                            (*end_increase_edicts)(struct prvm_prog_s *prog); // [INIT]
 735
 736         void                            (*init_edict)(struct prvm_prog_s *prog, prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
 737         void                            (*free_edict)(struct prvm_prog_s *prog, prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
 738
 739         void                            (*count_edicts)(struct prvm_prog_s *prog); // [INIT] used by PRVM_ED_Count_f
 740
 741         qbool                   (*load_edict)(struct prvm_prog_s *prog, prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
 742
 743         void                            (*init_cmd)(struct prvm_prog_s *prog); // [INIT] used by PRVM_InitProg
 744         void                            (*reset_cmd)(struct prvm_prog_s *prog); // [INIT] used by PRVM_ResetProg
 745
 746         void                            (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
 747
 748         void                            (*ExecuteProgram)(struct prvm_prog_s *prog, func_t fnum, const char *errormessage); // pointer to one of the *VM_ExecuteProgram functions
 749 } prvm_prog_t;
 750
 751 typedef enum prvm_progindex_e
 752 {
 753         PRVM_PROG_SERVER,
 754         PRVM_PROG_CLIENT,
 755         PRVM_PROG_MENU,
 756         PRVM_PROG_MAX
 757 }
 758 prvm_progindex_t;
 759
 760 extern prvm_prog_t prvm_prog_list[PRVM_PROG_MAX];
 761 prvm_prog_t *PRVM_ProgFromString(const char *str);
 762 prvm_prog_t *PRVM_FriendlyProgFromString(const char *str); // for console commands (prints error if name unknown and returns NULL, prints error if prog not loaded and returns NULL)
 763 #define PRVM_GetProg(n) (&prvm_prog_list[(n)])
 764 #define PRVM_ProgLoaded(n) (PRVM_GetProg(n)->loaded)
 765 #define SVVM_prog (&prvm_prog_list[PRVM_PROG_SERVER])
 766 #define CLVM_prog (&prvm_prog_list[PRVM_PROG_CLIENT])
 767 #ifdef CONFIG_MENU
 768 #define MVM_prog (&prvm_prog_list[PRVM_PROG_MENU])
 769 #endif
 770
 771 //============================================================================
 772 // prvm_cmds part
 773
 774 extern prvm_builtin_t vm_sv_builtins[];
 775 extern prvm_builtin_t vm_cl_builtins[];
 776 extern prvm_builtin_t vm_m_builtins[];
 777
 778 extern const int vm_sv_numbuiltins;
 779 extern const int vm_cl_numbuiltins;
 780 extern const int vm_m_numbuiltins;
 781
 782 extern const char *vm_sv_extensions[]; // client also uses this
 783 extern const char *vm_m_extensions[];
 784
 785 void SVVM_init_cmd(prvm_prog_t *prog);
 786 void SVVM_reset_cmd(prvm_prog_t *prog);
 787
 788 void CLVM_init_cmd(prvm_prog_t *prog);
 789 void CLVM_reset_cmd(prvm_prog_t *prog);
 790
 791 #ifdef CONFIG_MENU
 792 void MVM_init_cmd(prvm_prog_t *prog);
 793 void MVM_reset_cmd(prvm_prog_t *prog);
 794 #endif
 795
 796 void VM_Cmd_Init(prvm_prog_t *prog);
 797 void VM_Cmd_Reset(prvm_prog_t *prog);
 798 //============================================================================
 799
 800 void PRVM_Init (void);
 801
 802 #ifdef PROFILING
 803 void SVVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage);
 804 void CLVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage);
 805 #ifdef CONFIG_MENU
 806 void MVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage);
 807 #endif
 808 #else
 809 #define SVVM_ExecuteProgram PRVM_ExecuteProgram
 810 #define CLVM_ExecuteProgram PRVM_ExecuteProgram
 811 #ifdef CONFIG_MENU
 812 #define MVM_ExecuteProgram PRVM_ExecuteProgram
 813 #endif
 814 void PRVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage);
 815 #endif
 816
 817 #define PRVM_Alloc(buffersize) Mem_Alloc(prog->progs_mempool, buffersize)
 818 #define PRVM_Free(buffer) Mem_Free(buffer)
 819
 820 void PRVM_Profile (prvm_prog_t *prog, int maxfunctions, double mintime, int sortby);
 821 void PRVM_Profile_f(struct cmd_state_s *cmd);
 822 void PRVM_ChildProfile_f(struct cmd_state_s *cmd);
 823 void PRVM_CallProfile_f(struct cmd_state_s *cmd);
 824 void PRVM_PrintFunction_f(struct cmd_state_s *cmd);
 825
 826 void PRVM_PrintState(prvm_prog_t *prog, int stack_index);
 827 void PRVM_Crash(void);
 828 void PRVM_ShortStackTrace(prvm_prog_t *prog, char *buf, size_t bufsize);
 829 const char *PRVM_AllocationOrigin(prvm_prog_t *prog);
 830 void PRVM_GarbageCollection(prvm_prog_t *prog);
 831
 832 mdef_t *PRVM_ED_FindField(prvm_prog_t *prog, const char *name);
 833 mdef_t *PRVM_ED_FindGlobal(prvm_prog_t *prog, const char *name);
 834 prvm_eval_t *PRVM_ED_FindGlobalEval(prvm_prog_t *prog, const char *name);
 835 mfunction_t *PRVM_ED_FindFunction(prvm_prog_t *prog, const char *name);
 836
 837 int PRVM_ED_FindFieldOffset(prvm_prog_t *prog, const char *name);
 838 int PRVM_ED_FindGlobalOffset(prvm_prog_t *prog, const char *name);
 839 func_t PRVM_ED_FindFunctionOffset(prvm_prog_t *prog, const char *name);
 840 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
 841 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
 842
 843 void PRVM_MEM_IncreaseEdicts(prvm_prog_t *prog);
 844
 845 qbool PRVM_ED_CanAlloc(prvm_prog_t *prog, prvm_edict_t *e);
 846 prvm_edict_t *PRVM_ED_Alloc(prvm_prog_t *prog);
 847 void PRVM_ED_Free(prvm_prog_t *prog, prvm_edict_t *ed);
 848 void PRVM_ED_ClearEdict(prvm_prog_t *prog, prvm_edict_t *e);
 849
 850 void PRVM_PrintFunctionStatements(prvm_prog_t *prog, const char *name);
 851 void PRVM_ED_Print(prvm_prog_t *prog, prvm_edict_t *ed, const char *wildcard_fieldname);
 852 void PRVM_ED_Write(prvm_prog_t *prog, struct qfile_s *f, prvm_edict_t *ed);
 853 const char *PRVM_ED_ParseEdict(prvm_prog_t *prog, const char *data, prvm_edict_t *ent);
 854
 855 void PRVM_ED_WriteGlobals(prvm_prog_t *prog, struct qfile_s *f);
 856 void PRVM_ED_ParseGlobals(prvm_prog_t *prog, const char *data);
 857
 858 void PRVM_ED_CallPrespawnFunction(prvm_prog_t *prog, prvm_edict_t *ent);
 859 qbool PRVM_ED_CallSpawnFunction(prvm_prog_t *prog, prvm_edict_t *ent, const char *data, const char *start);
 860 void PRVM_ED_CallPostspawnFunction (prvm_prog_t *prog, prvm_edict_t *ent);
 861
 862 void PRVM_ED_LoadFromFile(prvm_prog_t *prog, const char *data);
 863
 864 unsigned int PRVM_EDICT_NUM_ERROR(prvm_prog_t *prog, unsigned int n, const char *filename, int fileline);
 865 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR(prog, (unsigned int)(n), __FILE__, __LINE__))
 866 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
 867
 868 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
 869 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
 870 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
 871
 872 #define PRVM_NEXT_EDICT(e) ((e) + 1)
 873
 874 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
 875 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
 876 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
 877 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
 878
 879 //============================================================================
 880
 881 #define PRVM_G_FLOAT(o) (prog->globals.fp[o])
 882 #define PRVM_G_INT(o) (prog->globals.ip[o])
 883 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(prog->globals.ip[o]))
 884 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
 885 #define PRVM_G_VECTOR(o) (&prog->globals.fp[o])
 886 #define PRVM_G_STRING(o) (PRVM_GetString(prog, prog->globals.ip[o]))
 887 //#define PRVM_G_FUNCTION(prog, o) (prog->globals.ip[o])
 888
 889 // FIXME: make these go away?
 890 #define PRVM_E_FLOAT(e,o) (e->fields.fp[o])
 891 #define PRVM_E_INT(e,o) (e->fields.ip[o])
 892 //#define PRVM_E_VECTOR(e,o) (&(e->fields.fp[o]))
 893 #define PRVM_E_STRING(e,o) (PRVM_GetString(prog, e->fields.ip[o]))
 894
 895 extern int prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
 896 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
 897
 898 void PRVM_Init_Exec(prvm_prog_t *prog);
 899
 900 void PRVM_ED_PrintEdicts_f(struct cmd_state_s *cmd);
 901 void PRVM_ED_PrintNum (prvm_prog_t *prog, int ent, const char *wildcard_fieldname);
 902
 903 const char *PRVM_GetString(prvm_prog_t *prog, int num);
 904 int PRVM_SetEngineString(prvm_prog_t *prog, const char *s);
 905 const char *PRVM_ChangeEngineString(prvm_prog_t *prog, int i, const char *s);
 906 /// Takes an strlen (not a buffer size).
 907 int PRVM_SetTempString(prvm_prog_t *prog, const char *s, size_t slen);
 908 int PRVM_AllocString(prvm_prog_t *prog, size_t bufferlength, char **pointer);
 909 void PRVM_FreeString(prvm_prog_t *prog, int num);
 910
 911 mdef_t *PRVM_ED_FieldAtOfs(prvm_prog_t *prog, unsigned int ofs);
 912 qbool PRVM_ED_ParseEpair(prvm_prog_t *prog, prvm_edict_t *ent, mdef_t *key, const char *s, qbool parsebackslash);
 913 char *PRVM_UglyValueString(prvm_prog_t *prog, etype_t type, prvm_eval_t *val, char *line, size_t linelength);
 914 char *PRVM_GlobalString(prvm_prog_t *prog, int ofs, char *line, size_t linelength);
 915 char *PRVM_GlobalStringNoContents(prvm_prog_t *prog, int ofs, char *line, size_t linelength);
 916
 917 //============================================================================
 918
 919 /*
 920 Initializing a vm:
 921 Call InitProg with the num
 922 Set up the fields marked with [INIT] in the prog struct
 923 Load a program with LoadProgs
 924 */
 925 // Load expects to be called right after Reset
 926 void PRVM_Prog_Init(prvm_prog_t *prog, struct cmd_state_s *cmd);
 927 void PRVM_Prog_Load(prvm_prog_t *prog, const char *filename, unsigned char *data, fs_offset_t size, void CheckRequiredFuncs(prvm_prog_t *prog, const char *filename), int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, prvm_required_field_t *required_global);
 928 void PRVM_Prog_Reset(prvm_prog_t *prog);
 929
 930 void PRVM_StackTrace(prvm_prog_t *prog);
 931 void PRVM_Breakpoint(prvm_prog_t *prog, int stack_index, const char *text);
 932 void PRVM_Watchpoint(prvm_prog_t *prog, int stack_index, const char *text, etype_t type, prvm_eval_t *o, prvm_eval_t *n);
 933
 934 void VM_Warning(prvm_prog_t *prog, const char *fmt, ...) DP_FUNC_PRINTF(2);
 935
 936 void VM_GenerateFrameGroupBlend(prvm_prog_t *prog, struct framegroupblend_s *framegroupblend, const prvm_edict_t *ed);
 937 void VM_FrameBlendFromFrameGroupBlend(struct frameblend_s *frameblend, const struct framegroupblend_s *framegroupblend, const struct model_s *model, double curtime);
 938 void VM_UpdateEdictSkeleton(prvm_prog_t *prog, prvm_edict_t *ed, const struct model_s *edmodel, const struct frameblend_s *frameblend);
 939 void VM_RemoveEdictSkeleton(prvm_prog_t *prog, prvm_edict_t *ed);
 940
 941 void PRVM_ExplicitCoverageEvent(prvm_prog_t *prog, mfunction_t *func, int statement);
 942
 943 #endif