]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - progsvm.h
redesigned csqc shared entity .Version handling, now internally uses a
[xonotic/darkplaces.git] / progsvm.h
index 17f93f2df4933895bfebb14aeaea203688d7de5a..41640fc42910c913408ca9c51904f8de98817234 100644 (file)
--- a/progsvm.h
+++ b/progsvm.h
@@ -33,6 +33,9 @@ The code uses void pointers instead.
 #include "progdefs.h"                  // generated by program cdefs
 #include "clprogdefs.h"                        // generated by program cdefs
 
+// forward declaration of clgecko_t
+struct clgecko_s;
+
 typedef struct prvm_stack_s
 {
        int                             s;
@@ -64,6 +67,8 @@ typedef struct prvm_edict_private_s
 {
        qboolean free;
        float freetime;
+       int mark;
+       const char *allocation_origin;
 } prvm_edict_private_t;
 
 typedef struct prvm_edict_s
@@ -103,8 +108,8 @@ typedef struct prvm_edict_s
        } fields;
 } prvm_edict_t;
 
-#define PRVM_EDICTFIELDVALUE(ed, fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((unsigned char *)ed->fields.vp + fieldoffset) : NULL)
-#define PRVM_GLOBALFIELDVALUE(fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((unsigned char *)prog->globals.generic + fieldoffset) : NULL)
+#define PRVM_EDICTFIELDVALUE(ed, fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)ed->fields.vp + fieldoffset) : NULL)
+#define PRVM_GLOBALFIELDVALUE(fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)prog->globals.generic + fieldoffset) : NULL)
 
 //============================================================================
 #define PRVM_OP_STATE          1
@@ -114,20 +119,26 @@ typedef struct prvm_edict_s
 
 #define PRVM_MAX_OPENFILES 256
 #define PRVM_MAX_OPENSEARCHES 128
+#define PRVM_MAX_GECKOINSTANCES 32
 
 typedef void (*prvm_builtin_t) (void);
 
 // NOTE: field offsets use -1 for NULL
 typedef struct prvm_prog_fieldoffsets_s
 {
-       int classname; // common
-       int chain; // common - used by find builtins
-       int think; // common - used by OP_STATE
-       int nextthink; // common - used by OP_STATE
-       int frame; // common - used by OP_STATE
+       // server and client use a lot of similar fields, so this is combined
+       int SendEntity; // ssqc
+       int SendFlags; // ssqc
+       int Version; // ssqc (legacy)
+       int alpha; // ssqc / csqc
+       int ammo_cells1; // ssqc - Dissolution of Eternity mission pack
+       int ammo_lava_nails; // ssqc - Dissolution of Eternity mission pack
+       int ammo_multi_rockets; // ssqc - Dissolution of Eternity mission pack
+       int ammo_nails1; // ssqc - Dissolution of Eternity mission pack
+       int ammo_plasma; // ssqc - Dissolution of Eternity mission pack
+       int ammo_rockets1; // ssqc - Dissolution of Eternity mission pack
+       int ammo_shells1; // ssqc - Dissolution of Eternity mission pack
        int angles; // common - used by changeyaw/changepitch
-
-       int gravity; // ssqc
        int button3; // ssqc
        int button4; // ssqc
        int button5; // ssqc
@@ -142,96 +153,109 @@ typedef struct prvm_prog_fieldoffsets_s
        int button14; // ssqc
        int button15; // ssqc
        int button16; // ssqc
-       int buttonuse; // ssqc
        int buttonchat; // ssqc
+       int buttonuse; // ssqc
+       int chain; // common - used by find builtins
+       int classname; // common
+       int clientcolors; // ssqc
+       int color; // ssqc
+       int colormod; // ssqc / csqc
+       int contentstransition; // ssqc
+       int cursor_active; // ssqc
+       int cursor_screen; // ssqc
+       int cursor_trace_endpos; // ssqc
+       int cursor_trace_ent; // ssqc
+       int cursor_trace_start; // ssqc
+       int customizeentityforclient; // ssqc
+       int dimension_hit; // ssqc / csqc
+       int dimension_solid; // ssqc / csqc
+       int disableclientprediction; // ssqc
+       int dphitcontentsmask; // ssqc / csqc
+       int drawonlytoclient; // ssqc
+       int effects; // ssqc / csqc
+       int exteriormodeltoclient; // ssqc
+       int fatness; // ssqc / csqc
+       int forceshader; // csqc
+       int frame1time; // csqc
+       int frame2; // csqc
+       int frame2time; // csqc
+       int frame; // common - used by OP_STATE
+       int fullbright; // ssqc - Nehahra support
+       int glow_color; // ssqc
        int glow_size; // ssqc
        int glow_trail; // ssqc
-       int glow_color; // ssqc
-       int items2; // ssqc
-       int scale; // ssqc / csqc
-       int alpha; // ssqc / csqc
-       int renderamt; // ssqc - HalfLife support
-       int rendermode; // ssqc - HalfLife support
-       int fullbright; // ssqc - Nehahra support
-       int ammo_shells1; // ssqc - Dissolution of Eternity mission pack
-       int ammo_nails1; // ssqc - Dissolution of Eternity mission pack
-       int ammo_lava_nails; // ssqc - Dissolution of Eternity mission pack
-       int ammo_rockets1; // ssqc - Dissolution of Eternity mission pack
-       int ammo_multi_rockets; // ssqc - Dissolution of Eternity mission pack
-       int ammo_cells1; // ssqc - Dissolution of Eternity mission pack
-       int ammo_plasma; // ssqc - Dissolution of Eternity mission pack
+       int gravity; // ssqc
+       int groundentity; // ssqc / csqc
+       int hull; // ssqc / csqc
        int ideal_yaw; // ssqc / csqc
-       int yaw_speed; // ssqc / csqc
        int idealpitch; // ssqc / csqc
-       int pitch_speed; // ssqc / csqc
-       int viewmodelforclient; // ssqc
+       int items2; // ssqc
+       int lerpfrac; // csqc
+       int light_lev; // ssqc
+       int message; // csqc
+       int modelflags; // ssqc
+       int movement; // ssqc
+       int movetypesteplandevent; // ssqc
+       int netaddress; // ssqc
+       int nextthink; // common - used by OP_STATE
        int nodrawtoclient; // ssqc
-       int exteriormodeltoclient; // ssqc
-       int drawonlytoclient; // ssqc
+       int pflags; // ssqc
        int ping; // ssqc
-       int movement; // ssqc
+       int pitch_speed; // ssqc / csqc
+       int playermodel; // ssqc
+       int playerskin; // ssqc
        int pmodel; // ssqc
        int punchvector; // ssqc
-       int viewzoom; // ssqc
-       int clientcolors; // ssqc
-       int tag_entity; // ssqc
-       int tag_index; // ssqc
-       int light_lev; // ssqc
-       int color; // ssqc
+       int renderamt; // ssqc - HalfLife support
+       int renderflags; // csqc
+       int rendermode; // ssqc - HalfLife support
+       int scale; // ssqc / csqc
        int style; // ssqc
-       int pflags; // ssqc
-       int cursor_active; // ssqc
-       int cursor_screen; // ssqc
-       int cursor_trace_start; // ssqc
-       int cursor_trace_endpos; // ssqc
-       int cursor_trace_ent; // ssqc
-       int colormod; // ssqc / csqc
-       int playermodel; // ssqc
-       int playerskin; // ssqc
-       int SendEntity; // ssqc
-       int Version; // ssqc
-       int customizeentityforclient; // ssqc
-       int dphitcontentsmask; // ssqc
-       int contentstransition; // ssqc
-       //int fatness; // ssqc / csqc
-       //int dimension_hit; // ssqc / csqc
-       //int dimension_solid; // ssqc / csqc
-
-       // csqc
-       int frame2;
-       int frame1time;
-       int frame2time;
-       int lerpfrac;
-       int renderflags;
-       //int forceshader;
-       int groundentity;
-       //int hull;
-       int effects;
-       //int tag_entity;
-       //int tag_index;
-       //int dphitcontentsmask;
-
-       // mqc
+       int tag_entity; // ssqc / csqc
+       int tag_index; // ssqc / csqc
+       int think; // common - used by OP_STATE
+       int viewmodelforclient; // ssqc
+       int viewzoom; // ssqc
+       int yaw_speed; // ssqc / csqc
+       int clientcamera; // ssqc
+       int clientstatus; // ssqc
 }
 prvm_prog_fieldoffsets_t;
 
 // NOTE: global offsets use -1 for NULL
 typedef struct prvm_prog_globaloffsets_s
 {
-       // common
-       int self;
-       int time;
-
-       // ssqc
-       int trace_dpstartcontents;
-       int trace_dphitcontents;
-       int trace_dphitq3surfaceflags;
-       int trace_dphittexturename;
-       int SV_InitCmd;
-
-       // csqc
-
-       // mqc
+       // server and client use a lot of similar globals, so this is combined
+       int SV_InitCmd; // ssqc
+       int self; // common
+       int time; // ssqc / csqc
+       int v_forward; // ssqc / csqc
+       int v_right; // ssqc / csqc
+       int v_up; // ssqc / csqc
+       int view_angles; // csqc
+       int trace_allsolid; // ssqc / csqc
+       int trace_startsolid; // ssqc / csqc
+       int trace_fraction; // ssqc / csqc
+       int trace_inwater; // ssqc / csqc
+       int trace_inopen; // ssqc / csqc
+       int trace_endpos; // ssqc / csqc
+       int trace_plane_normal; // ssqc / csqc
+       int trace_plane_dist; // ssqc / csqc
+       int trace_ent; // ssqc / csqc
+       int trace_dphitcontents; // ssqc / csqc
+       int trace_dphitq3surfaceflags; // ssqc / csqc
+       int trace_dphittexturename; // ssqc / csqc
+       int trace_dpstartcontents; // ssqc / csqc
+       int intermission; // csqc
+       int coop; // csqc
+       int deathmatch; // csqc
+       int dmg_take; // csqc
+       int dmg_save; // csqc
+       int dmg_origin; // csqc
+       int sb_showscores; // csqc
+       int drawfont; // csqc / menu
+       int require_spawnfunc_prefix; // ssqc
+       int worldstatus; // ssqc
 }
 prvm_prog_globaloffsets_t;
 
@@ -239,47 +263,54 @@ prvm_prog_globaloffsets_t;
 // NOTE: function offsets use 0 for NULL
 typedef struct prvm_prog_funcoffsets_s
 {
-       // common
-
-       // ssqc
-       func_t SV_PlayerPhysics;
-       func_t SV_ParseClientCommand;
-       func_t SV_ChangeTeam;
-       func_t EndFrame;
-       func_t RestoreGame;
-
-       // csqc
-       func_t CSQC_Init;
-       func_t CSQC_InputEvent;
-       func_t CSQC_UpdateView;
-       func_t CSQC_ConsoleCommand;
-       func_t CSQC_Shutdown;
-       func_t CSQC_Parse_TempEntity; //[515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
-       func_t CSQC_Parse_StuffCmd;
-       func_t CSQC_Parse_Print;
-       func_t CSQC_Parse_CenterPrint;
-       func_t CSQC_Ent_Update;
-       func_t CSQC_Ent_Remove;
-       func_t CSQC_Event; //[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...
-
-       // mqc
-       func_t m_init;
-#ifdef NG_MENU
-       func_t m_display;
-       func_t m_hide;
-#endif
-       func_t m_keydown;
-       func_t m_keyup;
-       func_t m_draw;
-       func_t m_toggle;
-       func_t m_shutdown;
+       func_t CSQC_ConsoleCommand; // csqc
+       func_t CSQC_Ent_Remove; // csqc
+       func_t CSQC_Ent_Spawn; // csqc DP_CSQC_ENT_SPAWN extension (BlackHC - TODO: needs to be added to dpextensions.qc)
+       func_t CSQC_Ent_Update; // csqc
+       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...
+       func_t CSQC_Event_Sound; // csqc : called by engine when an incoming sound packet arrives so CSQC can act on it
+       func_t CSQC_Init; // csqc
+       func_t CSQC_InputEvent; // csqc
+       func_t CSQC_Parse_CenterPrint; // csqc
+       func_t CSQC_Parse_Print; // csqc
+       func_t CSQC_Parse_StuffCmd; // csqc
+       func_t CSQC_Parse_TempEntity; // csqc [515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
+       func_t CSQC_Shutdown; // csqc
+       func_t CSQC_UpdateView; // csqc
+       func_t Gecko_Query; // csqc, mqc
+       func_t EndFrame; // ssqc
+       func_t RestoreGame; // ssqc
+       func_t SV_ChangeTeam; // ssqc
+       func_t SV_ParseClientCommand; // ssqc
+       func_t SV_PlayerPhysics; // ssqc
+       func_t SV_OnEntityNoSpawnFunction; // ssqc
+       func_t GameCommand; // any
+       func_t SV_Shutdown; // ssqc
+
+       // menu qc only uses some functions, nothing else
+       func_t m_draw; // mqc
+       func_t m_init; // mqc
+       func_t m_keydown; // mqc
+       func_t m_keyup; // mqc
+       func_t m_shutdown; // mqc
+       func_t m_toggle; // mqc
 }
 prvm_prog_funcoffsets_t;
 
+typedef struct prvm_stringbuffer_s
+{
+       int max_strings;
+       int num_strings;
+       char **strings;
+       const char *origin;
+}
+prvm_stringbuffer_t;
+
 // [INIT] variables flagged with this token can be initialized by 'you'
 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
 typedef struct prvm_prog_s
 {
+       double              starttime;
        dprograms_t                     *progs;
        mfunction_t                     *functions;
        char                            *strings;
@@ -306,9 +337,12 @@ typedef struct prvm_prog_s
        // (simple optimization of the free string search)
        int                                     firstfreeknownstring;
        const char                      **knownstrings;
-       unsigned char                           *knownstrings_freeable;
+       unsigned char           *knownstrings_freeable;
+       const char          **knownstrings_origin;
        const char                      ***stringshash;
 
+       memexpandablearray_t    stringbuffersarray;
+
        // all memory allocations related to this vm_prog (code, edicts, strings)
        mempool_t                       *progs_mempool; // [INIT]
 
@@ -330,6 +364,7 @@ typedef struct prvm_prog_s
        int                                     localstack_used;
 
        unsigned short          headercrc; // [INIT]
+       unsigned short          headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
 
        unsigned short          filecrc;
 
@@ -337,7 +372,10 @@ typedef struct prvm_prog_s
        // until this point everything also exists (with the pr_ prefix) in the old vm
 
        qfile_t                         *openfiles[PRVM_MAX_OPENFILES];
+       const char *         openfiles_origin[PRVM_MAX_OPENFILES];
        fssearch_t                      *opensearches[PRVM_MAX_OPENSEARCHES];
+       const char *         opensearches_origin[PRVM_MAX_OPENSEARCHES];
+       struct clgecko_s                *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
 
        // copies of some vars that were former read from sv
        int                                     num_edicts;
@@ -350,8 +388,8 @@ typedef struct prvm_prog_s
        int                                     reserved_edicts; // [INIT]
 
        prvm_edict_t            *edicts;
-       void                            *edictsfields;
-       void                            *edictprivate;
+       void                                    *edictsfields;
+       void                                    *edictprivate;
 
        // size of the engine private struct
        int                                     edictprivate_size; // [INIT]
@@ -368,7 +406,7 @@ typedef struct prvm_prog_s
        char                            *name; // [INIT]
 
        // flag - used to store general flags like PRVM_GE_SELF, etc.
-       int                                     flag;
+       int                             flag;
 
        char                            *extensionstring; // [INIT]
 
@@ -376,6 +414,7 @@ typedef struct prvm_prog_s
 
        // used to indicate whether a prog is loaded
        qboolean                        loaded;
+       qboolean                        leaktest_active;
 
 //     prvm_builtin_mem_t  *mem_list;
 
@@ -427,8 +466,7 @@ extern const int vm_sv_numbuiltins;
 extern const int vm_cl_numbuiltins;
 extern const int vm_m_numbuiltins;
 
-extern char * vm_sv_extensions;
-extern char * vm_cl_extensions;
+extern char * vm_sv_extensions; // client also uses this
 extern char * vm_m_extensions;
 
 void VM_SV_Cmd_Init(void);
@@ -457,11 +495,14 @@ void _PRVM_FreeAll (const char *filename, int fileline);
 
 void PRVM_Profile (int maxfunctions, int mininstructions);
 void PRVM_Profile_f (void);
+void PRVM_CallProfile_f (void);
 void PRVM_PrintFunction_f (void);
 
 void PRVM_PrintState(void);
 void PRVM_CrashAll (void);
 void PRVM_Crash (void);
+void PRVM_ShortStackTrace(char *buf, size_t bufsize);
+const char *PRVM_AllocationOrigin();
 
 ddef_t *PRVM_ED_FindField(const char *name);
 ddef_t *PRVM_ED_FindGlobal(const char *name);
@@ -470,6 +511,8 @@ mfunction_t *PRVM_ED_FindFunction(const char *name);
 int PRVM_ED_FindFieldOffset(const char *name);
 int PRVM_ED_FindGlobalOffset(const char *name);
 func_t PRVM_ED_FindFunctionOffset(const char *name);
+#define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
+#define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
 
 void PRVM_MEM_IncreaseEdicts(void);
 
@@ -478,7 +521,7 @@ void PRVM_ED_Free (prvm_edict_t *ed);
 void PRVM_ED_ClearEdict (prvm_edict_t *e);
 
 void PRVM_PrintFunctionStatements (const char *name);
-void PRVM_ED_Print(prvm_edict_t *ed);
+void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
 
@@ -487,9 +530,9 @@ void PRVM_ED_ParseGlobals (const char *data);
 
 void PRVM_ED_LoadFromFile (const char *data);
 
-prvm_edict_t *PRVM_EDICT_NUM_ERROR(int n, char *filename, int fileline);
-#define        PRVM_EDICT_NUM(n) (((n) >= 0 && (n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
-#define        PRVM_EDICT_NUM_UNSIGNED(n) (((n) < prog->max_edicts) ? prog->edicts + (n) : PRVM_EDICT_NUM_ERROR(n, __FILE__, __LINE__))
+unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, char *filename, int fileline);
+#define        PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
+#define        PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
 
 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
@@ -524,7 +567,7 @@ extern      int             prvm_type_size[8]; // for consistency : I think a goal of this sub-p
 void PRVM_Init_Exec(void);
 
 void PRVM_ED_PrintEdicts_f (void);
-void PRVM_ED_PrintNum (int ent);
+void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
 
 const char *PRVM_GetString(int num);
 int PRVM_SetEngineString(const char *s);