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