progsvm.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20 /*
  21 This is a try to make the vm more generic, it is mainly based on the progs.h file.
  22 For the license refer to progs.h.
  23
  24 Generic means, less as possible hard-coded links with the other parts of the engine.
  25 This means no edict_engineprivate struct usage, etc.
  26 The code uses void pointers instead.
  27 */
  28
  29 #ifndef PROGSVM_H
  30 #define PROGSVM_H
  31
  32 #include "pr_comp.h"                    // defs shared with qcc
  33 #include "progdefs.h"                   // generated by program cdefs
  34 #include "clprogdefs.h"                 // generated by program cdefs
  35
  36 // forward declaration of clgecko_t
  37 struct clgecko_s;
  38
  39 typedef struct prvm_stack_s
  40 {
  41         int                             s;
  42         mfunction_t             *f;
  43         double                  profile_acc;
  44         double                  builtinsprofile_acc;
  45 } prvm_stack_t;
  46
  47
  48 typedef union prvm_eval_s
  49 {
  50         string_t                string;
  51         float                   _float;
  52         float                   vector[3];
  53         func_t                  function;
  54         int                             ivector[3];
  55         int                             _int;
  56         int                             edict;
  57 } prvm_eval_t;
  58
  59 typedef struct prvm_required_field_s
  60 {
  61         int type;
  62         const char *name;
  63 } prvm_required_field_t;
  64
  65
  66 // AK: I dont call it engine private cause it doesnt really belongs to the engine
  67 //     it belongs to prvm.
  68 typedef struct prvm_edict_private_s
  69 {
  70         qboolean free;
  71         float freetime;
  72         int mark;
  73         const char *allocation_origin;
  74 } prvm_edict_private_t;
  75
  76 typedef struct prvm_edict_s
  77 {
  78         // engine-private fields (stored in dynamically resized array)
  79         //edict_engineprivate_t *e;
  80         union
  81         {
  82                 prvm_edict_private_t *required;
  83                 void *vp;
  84                 // FIXME: this server pointer really means world, not server
  85                 // (it is used by both server qc and client qc, but not menu qc)
  86                 edict_engineprivate_t *server;
  87                 // add other private structs as you desire
  88                 // new structs have to start with the elements of prvm_edit_private_t
  89                 // e.g. a new struct has to either look like this:
  90                 //      typedef struct server_edict_private_s {
  91                 //              prvm_edict_private_t base;
  92                 //              vec3_t moved_from;
  93                 //      vec3_t moved_fromangles;
  94                 //              ... } server_edict_private_t;
  95                 // or:
  96                 //      typedef struct server_edict_private_s {
  97                 //              qboolean free;
  98                 //              float freetime;
  99                 //              vec3_t moved_from;
 100                 //      vec3_t moved_fromangles;
 101                 //              ... } server_edict_private_t;
 102                 // However, the first one should be preferred.
 103         } priv;
 104         // QuakeC fields (stored in dynamically resized array)
 105         union
 106         {
 107                 void *vp;
 108                 entvars_t               *server;
 109                 cl_entvars_t    *client;
 110         } fields;
 111 } prvm_edict_t;
 112
 113 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)ed->fields.vp + fieldoffset) : NULL)
 114 #define PRVM_GLOBALFIELDVALUE(fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)prog->globals.generic + fieldoffset) : NULL)
 115
 116 //============================================================================
 117 #define PRVM_OP_STATE           1
 118
 119 #define PRVM_MAX_STACK_DEPTH            1024
 120 #define PRVM_LOCALSTACK_SIZE            16384
 121
 122 #define PRVM_MAX_OPENFILES 256
 123 #define PRVM_MAX_OPENSEARCHES 128
 124 #define PRVM_MAX_GECKOINSTANCES 32
 125
 126 typedef void (*prvm_builtin_t) (void);
 127
 128 // NOTE: field offsets use -1 for NULL
 129 typedef struct prvm_prog_fieldoffsets_s
 130 {
 131         // server and client use a lot of similar fields, so this is combined
 132         int SendEntity; // ssqc
 133         int SendFlags; // ssqc
 134         int Version; // ssqc (legacy)
 135         int alpha; // ssqc / csqc
 136         int ammo_cells1; // ssqc - Dissolution of Eternity mission pack
 137         int ammo_lava_nails; // ssqc - Dissolution of Eternity mission pack
 138         int ammo_multi_rockets; // ssqc - Dissolution of Eternity mission pack
 139         int ammo_nails1; // ssqc - Dissolution of Eternity mission pack
 140         int ammo_plasma; // ssqc - Dissolution of Eternity mission pack
 141         int ammo_rockets1; // ssqc - Dissolution of Eternity mission pack
 142         int ammo_shells1; // ssqc - Dissolution of Eternity mission pack
 143         int angles; // common - used by changeyaw/changepitch
 144         int button3; // ssqc
 145         int button4; // ssqc
 146         int button5; // ssqc
 147         int button6; // ssqc
 148         int button7; // ssqc
 149         int button8; // ssqc
 150         int button9; // ssqc
 151         int button10; // ssqc
 152         int button11; // ssqc
 153         int button12; // ssqc
 154         int button13; // ssqc
 155         int button14; // ssqc
 156         int button15; // ssqc
 157         int button16; // ssqc
 158         int buttonchat; // ssqc
 159         int buttonuse; // ssqc
 160         int chain; // common - used by find builtins
 161         int classname; // common
 162         int clientcamera; // ssqc
 163         int clientcolors; // ssqc
 164         int clientstatus; // ssqc
 165         int color; // ssqc
 166         int colormod; // ssqc / csqc
 167         int contentstransition; // ssqc
 168         int cursor_active; // ssqc
 169         int cursor_screen; // ssqc
 170         int cursor_trace_endpos; // ssqc
 171         int cursor_trace_ent; // ssqc
 172         int cursor_trace_start; // ssqc
 173         int customizeentityforclient; // ssqc
 174         int dimension_hit; // ssqc / csqc
 175         int dimension_solid; // ssqc / csqc
 176         int disableclientprediction; // ssqc
 177         int dphitcontentsmask; // ssqc / csqc
 178         int drawonlytoclient; // ssqc
 179         int effects; // ssqc / csqc
 180         int exteriormodeltoclient; // ssqc
 181         int fatness; // ssqc / csqc
 182         int forceshader; // csqc
 183         int frame1time; // csqc
 184         int frame2; // csqc
 185         int frame2time; // csqc
 186         int frame3; // csqc
 187         int frame3time; // csqc
 188         int frame4; // csqc
 189         int frame4time; // csqc
 190         int frame; // common - used by OP_STATE
 191         int fullbright; // ssqc - Nehahra support
 192         int glow_color; // ssqc
 193         int glow_size; // ssqc
 194         int glow_trail; // ssqc
 195         int glowmod; // ssqc / csqc
 196         int gravity; // ssqc
 197         int groundentity; // ssqc / csqc
 198         int hull; // ssqc / csqc
 199         int ideal_yaw; // ssqc / csqc
 200         int idealpitch; // ssqc / csqc
 201         int items2; // ssqc
 202         int lerpfrac3; // csqc
 203         int lerpfrac4; // csqc
 204         int lerpfrac; // csqc
 205         int light_lev; // ssqc
 206         int message; // csqc
 207         int modelflags; // ssqc
 208         int movement; // ssqc
 209         int movetypesteplandevent; // ssqc
 210         int netaddress; // ssqc
 211         int nextthink; // common - used by OP_STATE
 212         int nodrawtoclient; // ssqc
 213         int pflags; // ssqc
 214         int ping; // ssqc
 215         int pitch_speed; // ssqc / csqc
 216         int playermodel; // ssqc
 217         int playerskin; // ssqc
 218         int pmodel; // ssqc
 219         int punchvector; // ssqc
 220         int renderamt; // ssqc - HalfLife support
 221         int renderflags; // csqc
 222         int rendermode; // ssqc - HalfLife support
 223         int scale; // ssqc / csqc
 224         int shadertime; // csqc
 225         int style; // ssqc
 226         int tag_entity; // ssqc / csqc
 227         int tag_index; // ssqc / csqc
 228         int think; // common - used by OP_STATE
 229         int viewmodelforclient; // ssqc
 230         int viewzoom; // ssqc
 231         int yaw_speed; // ssqc / csqc
 232         int bouncefactor; // ssqc
 233         int bouncestop; // ssqc
 234
 235         int solid; // ssqc / csqc (physics)
 236         int movetype; // ssqc / csqc (physics)
 237         int modelindex; // ssqc / csqc (physics)
 238         int mins; // ssqc / csqc (physics)
 239         int maxs; // ssqc / csqc (physics)
 240         int mass; // ssqc / csqc (physics)
 241         int origin; // ssqc / csqc (physics)
 242         int velocity; // ssqc / csqc (physics)
 243         //int axis_forward; // ssqc / csqc (physics)
 244         //int axis_left; // ssqc / csqc (physics)
 245         //int axis_up; // ssqc / csqc (physics)
 246         //int spinvelocity; // ssqc / csqc (physics)
 247         //int angles; // ssqc / csqc (physics)
 248         int avelocity; // ssqc / csqc (physics)
 249         int jointtype; // ssqc / csqc (physics)
 250         int enemy; // ssqc / csqc (physics)
 251         int aiment; // ssqc / csqc (physics)
 252         int movedir; // ssqc / csqc (physics)
 253 }
 254 prvm_prog_fieldoffsets_t;
 255
 256 // NOTE: global offsets use -1 for NULL
 257 typedef struct prvm_prog_globaloffsets_s
 258 {
 259         // server and client use a lot of similar globals, so this is combined
 260         int SV_InitCmd; // ssqc
 261         int self; // common
 262         int time; // ssqc / csqc
 263         int v_forward; // ssqc / csqc
 264         int v_right; // ssqc / csqc
 265         int v_up; // ssqc / csqc
 266         int view_angles; // csqc
 267         int trace_allsolid; // ssqc / csqc
 268         int trace_startsolid; // ssqc / csqc
 269         int trace_fraction; // ssqc / csqc
 270         int trace_inwater; // ssqc / csqc
 271         int trace_inopen; // ssqc / csqc
 272         int trace_endpos; // ssqc / csqc
 273         int trace_plane_normal; // ssqc / csqc
 274         int trace_plane_dist; // ssqc / csqc
 275         int trace_ent; // ssqc / csqc
 276         int trace_networkentity; // csqc
 277         int trace_dphitcontents; // ssqc / csqc
 278         int trace_dphitq3surfaceflags; // ssqc / csqc
 279         int trace_dphittexturename; // ssqc / csqc
 280         int trace_dpstartcontents; // ssqc / csqc
 281         int intermission; // csqc
 282         int coop; // csqc
 283         int deathmatch; // csqc
 284         int dmg_take; // csqc
 285         int dmg_save; // csqc
 286         int dmg_origin; // csqc
 287         int sb_showscores; // csqc
 288         int drawfont; // csqc / menu
 289         int require_spawnfunc_prefix; // ssqc
 290         int worldstatus; // ssqc
 291         int servertime; // csqc
 292         int serverprevtime; // csqc
 293         int serverdeltatime; // csqc
 294         int gettaginfo_name; // ssqc / csqc
 295         int gettaginfo_parent; // ssqc / csqc
 296         int gettaginfo_offset; // ssqc / csqc
 297         int gettaginfo_forward; // ssqc / csqc
 298         int gettaginfo_right; // ssqc / csqc
 299         int gettaginfo_up; // ssqc / csqc
 300         int transparent_offset; // csqc
 301 }
 302 prvm_prog_globaloffsets_t;
 303
 304 // these are initialized using PRVM_ED_FindFunction
 305 // NOTE: function offsets use 0 for NULL
 306 typedef struct prvm_prog_funcoffsets_s
 307 {
 308         func_t CSQC_ConsoleCommand; // csqc
 309         func_t CSQC_Ent_Remove; // csqc
 310         func_t CSQC_Ent_Spawn; // csqc DP_CSQC_ENT_SPAWN extension (BlackHC - TODO: needs to be added to dpextensions.qc)
 311         func_t CSQC_Ent_Update; // csqc
 312         func_t CSQC_Event; // csqc [515]: engine call this for its own needs so csqc can do some things according to what engine it's running on.  example: to say about edicts increase, whatever...
 313         func_t CSQC_Event_Sound; // csqc : called by engine when an incoming sound packet arrives so CSQC can act on it
 314         func_t CSQC_Init; // csqc
 315         func_t CSQC_InputEvent; // csqc
 316         func_t CSQC_Parse_CenterPrint; // csqc
 317         func_t CSQC_Parse_Print; // csqc
 318         func_t CSQC_Parse_StuffCmd; // csqc
 319         func_t CSQC_Parse_TempEntity; // csqc [515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
 320         func_t CSQC_Shutdown; // csqc
 321         func_t CSQC_UpdateView; // csqc
 322         func_t Gecko_Query; // csqc, mqc
 323         func_t EndFrame; // ssqc
 324         func_t RestoreGame; // ssqc
 325         func_t SV_ChangeTeam; // ssqc
 326         func_t SV_ParseClientCommand; // ssqc
 327         func_t SV_PlayerPhysics; // ssqc
 328         func_t SV_OnEntityPreSpawnFunction; // ssqc
 329         func_t SV_OnEntityNoSpawnFunction; // ssqc
 330         func_t SV_OnEntityPostSpawnFunction; // ssqc
 331         func_t GameCommand; // any
 332         func_t SV_Shutdown; // ssqc
 333         func_t URI_Get_Callback; // any
 334         func_t SV_PausedTic; //ssqc
 335
 336         // menu qc only uses some functions, nothing else
 337         func_t m_draw; // mqc
 338         func_t m_init; // mqc
 339         func_t m_keydown; // mqc
 340         func_t m_keyup; // mqc
 341         func_t m_shutdown; // mqc
 342         func_t m_toggle; // mqc
 343 }
 344 prvm_prog_funcoffsets_t;
 345
 346 typedef struct prvm_stringbuffer_s
 347 {
 348         int max_strings;
 349         int num_strings;
 350         char **strings;
 351         const char *origin;
 352 }
 353 prvm_stringbuffer_t;
 354
 355 // [INIT] variables flagged with this token can be initialized by 'you'
 356 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
 357 typedef struct prvm_prog_s
 358 {
 359         double              starttime;
 360         dprograms_t                     *progs;
 361         mfunction_t                     *functions;
 362         char                            *strings;
 363         int                                     stringssize;
 364         ddef_t                          *fielddefs;
 365         ddef_t                          *globaldefs;
 366         dstatement_t            *statements;
 367         int                                     edict_size;                     // in bytes
 368         int                                     edictareasize;          // LordHavoc: in bytes (for bound checking)
 369
 370         int                                     *statement_linenums; // NULL if not available
 371
 372         double                          *statement_profile; // only incremented if prvm_statementprofiling is on
 373
 374         union {
 375                 float *generic;
 376                 globalvars_t *server;
 377                 cl_globalvars_t *client;
 378         } globals;
 379
 380         int                                     maxknownstrings;
 381         int                                     numknownstrings;
 382         // this is updated whenever a string is removed or added
 383         // (simple optimization of the free string search)
 384         int                                     firstfreeknownstring;
 385         const char                      **knownstrings;
 386         unsigned char           *knownstrings_freeable;
 387         const char          **knownstrings_origin;
 388         const char                      ***stringshash;
 389
 390         memexpandablearray_t    stringbuffersarray;
 391
 392         // all memory allocations related to this vm_prog (code, edicts, strings)
 393         mempool_t                       *progs_mempool; // [INIT]
 394
 395         prvm_builtin_t          *builtins; // [INIT]
 396         int                                     numbuiltins; // [INIT]
 397
 398         int                                     argc;
 399
 400         int                                     trace;
 401         mfunction_t                     *xfunction;
 402         int                                     xstatement;
 403
 404         // stacktrace writes into stack[MAX_STACK_DEPTH]
 405         // thus increase the array, so depth wont be overwritten
 406         prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
 407         int                                     depth;
 408
 409         int                                     localstack[PRVM_LOCALSTACK_SIZE];
 410         int                                     localstack_used;
 411
 412         unsigned short          headercrc; // [INIT]
 413         unsigned short          headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
 414
 415         unsigned short          filecrc;
 416
 417         //============================================================================
 418         // until this point everything also exists (with the pr_ prefix) in the old vm
 419
 420         qfile_t                         *openfiles[PRVM_MAX_OPENFILES];
 421         const char *         openfiles_origin[PRVM_MAX_OPENFILES];
 422         fssearch_t                      *opensearches[PRVM_MAX_OPENSEARCHES];
 423         const char *         opensearches_origin[PRVM_MAX_OPENSEARCHES];
 424         struct clgecko_s                *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
 425
 426         // copies of some vars that were former read from sv
 427         int                                     num_edicts;
 428         // number of edicts for which space has been (should be) allocated
 429         int                                     max_edicts; // [INIT]
 430         // used instead of the constant MAX_EDICTS
 431         int                                     limit_edicts; // [INIT]
 432
 433         // number of reserved edicts (allocated from 1)
 434         int                                     reserved_edicts; // [INIT]
 435
 436         prvm_edict_t            *edicts;
 437         void                                    *edictsfields;
 438         void                                    *edictprivate;
 439
 440         // size of the engine private struct
 441         int                                     edictprivate_size; // [INIT]
 442
 443         prvm_prog_fieldoffsets_t        fieldoffsets;
 444         prvm_prog_globaloffsets_t       globaloffsets;
 445         prvm_prog_funcoffsets_t         funcoffsets;
 446
 447         // allow writing to world entity fields, this is set by server init and
 448         // cleared before first server frame
 449         qboolean                        allowworldwrites;
 450
 451         // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
 452         char                            *name; // [INIT]
 453
 454         // flag - used to store general flags like PRVM_GE_SELF, etc.
 455         int                             flag;
 456
 457         char                            *extensionstring; // [INIT]
 458
 459         qboolean                        loadintoworld; // [INIT]
 460
 461         // used to indicate whether a prog is loaded
 462         qboolean                        loaded;
 463         qboolean                        leaktest_active;
 464
 465         // printed together with backtraces
 466         const char *statestring;
 467
 468 //      prvm_builtin_mem_t  *mem_list;
 469
 470 // now passed as parameter of PRVM_LoadProgs
 471 //      char                            **required_func;
 472 //      int                                     numrequiredfunc;
 473
 474         //============================================================================
 475
 476         ddef_t                          *self; // if self != 0 then there is a global self
 477
 478         //============================================================================
 479         // function pointers
 480
 481         void                            (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
 482         void                            (*end_increase_edicts)(void); // [INIT]
 483
 484         void                            (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
 485         void                            (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
 486
 487         void                            (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
 488
 489         qboolean                        (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
 490
 491         void                            (*init_cmd)(void); // [INIT] used by PRVM_InitProg
 492         void                            (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
 493
 494         void                            (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
 495
 496         void                            (*ExecuteProgram)(func_t fnum, const char *errormessage); // pointer to one of the *VM_ExecuteProgram functions
 497 } prvm_prog_t;
 498
 499 extern prvm_prog_t * prog;
 500
 501 #define PRVM_MAXPROGS 3
 502 #define PRVM_SERVERPROG 0 // actually not used at the moment
 503 #define PRVM_CLIENTPROG 1
 504 #define PRVM_MENUPROG   2
 505
 506 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
 507
 508 //============================================================================
 509 // prvm_cmds part
 510
 511 extern prvm_builtin_t vm_sv_builtins[];
 512 extern prvm_builtin_t vm_cl_builtins[];
 513 extern prvm_builtin_t vm_m_builtins[];
 514
 515 extern const int vm_sv_numbuiltins;
 516 extern const int vm_cl_numbuiltins;
 517 extern const int vm_m_numbuiltins;
 518
 519 extern char * vm_sv_extensions; // client also uses this
 520 extern char * vm_m_extensions;
 521
 522 void VM_SV_Cmd_Init(void);
 523 void VM_SV_Cmd_Reset(void);
 524
 525 void VM_CL_Cmd_Init(void);
 526 void VM_CL_Cmd_Reset(void);
 527
 528 void VM_M_Cmd_Init(void);
 529 void VM_M_Cmd_Reset(void);
 530
 531 void VM_Cmd_Init(void);
 532 void VM_Cmd_Reset(void);
 533 //============================================================================
 534
 535 void PRVM_Init (void);
 536
 537 void MVM_ExecuteProgram (func_t fnum, const char *errormessage);
 538 void CLVM_ExecuteProgram (func_t fnum, const char *errormessage);
 539 void SVVM_ExecuteProgram (func_t fnum, const char *errormessage);
 540 #define PRVM_ExecuteProgram prog->ExecuteProgram
 541
 542 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
 543 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
 544 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
 545 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
 546 void _PRVM_Free (void *buffer, const char *filename, int fileline);
 547 void _PRVM_FreeAll (const char *filename, int fileline);
 548
 549 void PRVM_Profile (int maxfunctions, int mininstructions, int sortby);
 550 void PRVM_Profile_f (void);
 551 void PRVM_ChildProfile_f (void);
 552 void PRVM_CallProfile_f (void);
 553 void PRVM_PrintFunction_f (void);
 554
 555 void PRVM_PrintState(void);
 556 void PRVM_CrashAll (void);
 557 void PRVM_Crash (void);
 558 void PRVM_ShortStackTrace(char *buf, size_t bufsize);
 559 const char *PRVM_AllocationOrigin(void);
 560
 561 ddef_t *PRVM_ED_FindField(const char *name);
 562 ddef_t *PRVM_ED_FindGlobal(const char *name);
 563 mfunction_t *PRVM_ED_FindFunction(const char *name);
 564
 565 int PRVM_ED_FindFieldOffset(const char *name);
 566 int PRVM_ED_FindGlobalOffset(const char *name);
 567 func_t PRVM_ED_FindFunctionOffset(const char *name);
 568 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
 569 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
 570
 571 void PRVM_MEM_IncreaseEdicts(void);
 572
 573 qboolean PRVM_ED_CanAlloc(prvm_edict_t *e);
 574 prvm_edict_t *PRVM_ED_Alloc (void);
 575 void PRVM_ED_Free (prvm_edict_t *ed);
 576 void PRVM_ED_ClearEdict (prvm_edict_t *e);
 577
 578 void PRVM_PrintFunctionStatements (const char *name);
 579 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
 580 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
 581 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
 582
 583 void PRVM_ED_WriteGlobals (qfile_t *f);
 584 void PRVM_ED_ParseGlobals (const char *data);
 585
 586 void PRVM_ED_LoadFromFile (const char *data);
 587
 588 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, char *filename, int fileline);
 589 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
 590 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
 591
 592 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
 593 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
 594 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
 595
 596 #define PRVM_NEXT_EDICT(e) ((e) + 1)
 597
 598 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
 599 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
 600 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
 601 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
 602
 603 //============================================================================
 604
 605 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
 606 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
 607 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
 608 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
 609 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
 610 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
 611 //#define       PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
 612
 613 // FIXME: make these go away?
 614 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
 615 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
 616 //#define       PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
 617 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
 618
 619 extern  int             prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
 620 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
 621
 622 void PRVM_Init_Exec(void);
 623
 624 void PRVM_ED_PrintEdicts_f (void);
 625 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
 626
 627 const char *PRVM_GetString(int num);
 628 int PRVM_SetEngineString(const char *s);
 629 int PRVM_SetTempString(const char *s);
 630 int PRVM_AllocString(size_t bufferlength, char **pointer);
 631 void PRVM_FreeString(int num);
 632
 633 //============================================================================
 634
 635 // used as replacement for a prog stack
 636 //#define PRVM_DEBUGPRSTACK
 637
 638 #ifdef PRVM_DEBUGPRSTACK
 639 #define PRVM_Begin  if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
 640 #define PRVM_End        prog = 0
 641 #else
 642 #define PRVM_Begin
 643 #define PRVM_End        prog = 0
 644 #endif
 645
 646 //#define PRVM_SAFENAME
 647 #ifndef PRVM_SAFENAME
 648 #       define PRVM_NAME        (prog->name)
 649 #else
 650 #       define PRVM_NAME        (prog->name ? prog->name : "Unknown prog name")
 651 #endif
 652
 653 // helper macro to make function pointer calls easier
 654 #define PRVM_GCALL(func)        if(prog->func) prog->func
 655
 656 #define PRVM_ERROR              prog->error_cmd
 657
 658 // other prog handling functions
 659 qboolean PRVM_SetProgFromString(const char *str);
 660 void PRVM_SetProg(int prognr);
 661
 662 /*
 663 Initializing a vm:
 664 Call InitProg with the num
 665 Set up the fields marked with [INIT] in the prog struct
 666 Load a program with LoadProgs
 667 */
 668 void PRVM_InitProg(int prognr);
 669 // LoadProgs expects to be called right after InitProg
 670 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, char **required_global);
 671 void PRVM_ResetProg(void);
 672
 673 qboolean PRVM_ProgLoaded(int prognr);
 674
 675 int     PRVM_GetProgNr(void);
 676
 677 void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
 678
 679 // TODO: fill in the params
 680 //void PRVM_Create();
 681
 682 #endif