]> git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - progsvm.h
a cosmetic change as suggested by div0:
[xonotic/darkplaces.git] / progsvm.h
index e389f0f0516203f212daed08234b817db9c6eed3..17f93f2df4933895bfebb14aeaea203688d7de5a 100644 (file)
--- a/progsvm.h
+++ b/progsvm.h
@@ -31,108 +31,7 @@ The code uses void pointers instead.
 
 #include "pr_comp.h"                   // defs shared with qcc
 #include "progdefs.h"                  // generated by program cdefs
-
-/*
-typedef union vm_eval_s
-{
-       string_t                string;
-       float                   _float;
-       float                   vector[3];
-       func_t                  function;
-       int                             ivector[3];
-       int                             _int;
-       int                             edict;
-} vm_eval_t;
-
-typedef struct vm_link_s
-{
-       int entitynumber;
-       struct link_s   *prev, *next;
-} vm_link_t;
-
-#define ENTITYGRIDAREAS 16
-
-typedef struct vm_edict_engineprivate_s
-{
-       // true if this edict is unused
-       qboolean free;
-       // sv.time when the object was freed (to prevent early reuse which could
-       // mess up client interpolation or obscure severe QuakeC bugs)
-       float freetime;
-
-       // physics grid areas this edict is linked into
-       link_t areagrid[ENTITYGRIDAREAS];
-       // since the areagrid can have multiple references to one entity,
-       // we should avoid extensive checking on entities already encountered
-       int areagridmarknumber;
-
-       // old entity protocol, not used
-#ifdef QUAKEENTITIES
-       // baseline values
-       entity_state_t baseline;
-       // LordHavoc: previous frame
-       entity_state_t deltabaseline;
-#endif
-
-       // LordHavoc: gross hack to make floating items still work
-       int suspendedinairflag;
-       // used by PushMove to keep track of where objects were before they were
-       // moved, in case they need to be moved back
-       vec3_t moved_from;
-       vec3_t moved_fromangles;
-}
-vm_edict_engineprivate_t;
-
-// the entire server entity structure
-// NOTE: keep this small!  priv and v are dynamic but this struct is not!
-typedef struct vm_edict_s
-{
-       // engine-private fields (stored in dynamically resized array)
-       edict_engineprivate_t *e;
-       // QuakeC fields (stored in dynamically resized array)
-       entvars_t *v;
-}
-vm_edict_t;
-*/
-
-/*// LordHavoc: in an effort to eliminate time wasted on GetEdictFieldValue...  see pr_edict.c for the functions which use these.
-extern int eval_gravity;
-extern int eval_button3;
-extern int eval_button4;
-extern int eval_button5;
-extern int eval_button6;
-extern int eval_button7;
-extern int eval_button8;
-extern int eval_glow_size;
-extern int eval_glow_trail;
-extern int eval_glow_color;
-extern int eval_items2;
-extern int eval_scale;
-extern int eval_alpha;
-extern int eval_renderamt; // HalfLife support
-extern int eval_rendermode; // HalfLife support
-extern int eval_fullbright;
-extern int eval_ammo_shells1;
-extern int eval_ammo_nails1;
-extern int eval_ammo_lava_nails;
-extern int eval_ammo_rockets1;
-extern int eval_ammo_multi_rockets;
-extern int eval_ammo_cells1;
-extern int eval_ammo_plasma;
-extern int eval_idealpitch;
-extern int eval_pitch_speed;
-extern int eval_viewmodelforclient;
-extern int eval_nodrawtoclient;
-extern int eval_exteriormodeltoclient;
-extern int eval_drawonlytoclient;
-extern int eval_ping;
-extern int eval_movement;
-extern int eval_pmodel;
-extern int eval_punchvector;
-extern int eval_viewzoom;
-extern int eval_clientcolors;
-extern int eval_tag_entity;
-extern int eval_tag_index;*/
+#include "clprogdefs.h"                        // generated by program cdefs
 
 typedef struct prvm_stack_s
 {
@@ -159,12 +58,6 @@ typedef struct prvm_required_field_s
 } prvm_required_field_t;
 
 
-/*typedef struct prvm_link_s
-{
-       int entitynumber;
-       struct link_s   *prev, *next;
-} prvm_link_t;*/
-
 // AK: I dont call it engine private cause it doesnt really belongs to the engine
 //     it belongs to prvm.
 typedef struct prvm_edict_private_s
@@ -181,6 +74,8 @@ typedef struct prvm_edict_s
        {
                prvm_edict_private_t *required;
                void *vp;
+               // FIXME: this server pointer really means world, not server
+               // (it is used by both server qc and client qc, but not menu qc)
                edict_engineprivate_t *server;
                // add other private structs as you desire
                // new structs have to start with the elements of prvm_edit_private_t
@@ -203,49 +98,183 @@ typedef struct prvm_edict_s
        union
        {
                void *vp;
-               entvars_t *server;
+               entvars_t               *server;
+               cl_entvars_t    *client;
        } fields;
 } prvm_edict_t;
 
-#define PRVM_GETEDICTFIELDVALUE(ed, fieldoffset) (fieldoffset ? (prvm_eval_t *)((qbyte *)ed->fields.vp + fieldoffset) : NULL)
+#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)
 
-/*// this struct is the basic requirement for a qc prog
-typedef struct prvm_pr_globalvars_s
-{
-       int pad[28];
-} prvm_pr_globalvars_t;
-*/
-/*
-extern mfunction_t *SV_PlayerPhysicsQC;
-extern mfunction_t *EndFrameQC;
-//KrimZon - SERVER COMMANDS IN QUAKEC
-extern mfunction_t *SV_ParseClientCommandQC;
-*/
 //============================================================================
-/*
-typedef struct prvm_builtin_mem_s
+#define PRVM_OP_STATE          1
+
+#define        PRVM_MAX_STACK_DEPTH            1024
+#define        PRVM_LOCALSTACK_SIZE            16384
+
+#define PRVM_MAX_OPENFILES 256
+#define PRVM_MAX_OPENSEARCHES 128
+
+typedef void (*prvm_builtin_t) (void);
+
+// NOTE: field offsets use -1 for NULL
+typedef struct prvm_prog_fieldoffsets_s
 {
-       void (*init)(void);
-       void (*deinit)(void);
+       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
+       int angles; // common - used by changeyaw/changepitch
+
+       int gravity; // ssqc
+       int button3; // ssqc
+       int button4; // ssqc
+       int button5; // ssqc
+       int button6; // ssqc
+       int button7; // ssqc
+       int button8; // ssqc
+       int button9; // ssqc
+       int button10; // ssqc
+       int button11; // ssqc
+       int button12; // ssqc
+       int button13; // ssqc
+       int button14; // ssqc
+       int button15; // ssqc
+       int button16; // ssqc
+       int buttonuse; // ssqc
+       int buttonchat; // 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 ideal_yaw; // ssqc / csqc
+       int yaw_speed; // ssqc / csqc
+       int idealpitch; // ssqc / csqc
+       int pitch_speed; // ssqc / csqc
+       int viewmodelforclient; // ssqc
+       int nodrawtoclient; // ssqc
+       int exteriormodeltoclient; // ssqc
+       int drawonlytoclient; // ssqc
+       int ping; // ssqc
+       int movement; // 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 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
+}
+prvm_prog_fieldoffsets_t;
 
-       void *mem;
-} prvm_builtin_mem_t;
-*/
+// NOTE: global offsets use -1 for NULL
+typedef struct prvm_prog_globaloffsets_s
+{
+       // common
+       int self;
+       int time;
 
-//============================================================================
-/*
-#define PRVM_FE_NEXTHINK       2
-#define PRVM_FE_THINK          4
-#define PRVM_FE_FRAME          8
-*/
-#define PRVM_FE_CLASSNAME   8
-#define PRVM_FE_CHAIN          4
-#define PRVM_OP_STATE          1
+       // ssqc
+       int trace_dpstartcontents;
+       int trace_dphitcontents;
+       int trace_dphitq3surfaceflags;
+       int trace_dphittexturename;
+       int SV_InitCmd;
 
-#define        PRVM_MAX_STACK_DEPTH            256
-#define        PRVM_LOCALSTACK_SIZE            2048
+       // csqc
 
-typedef void (*prvm_builtin_t) (void);
+       // mqc
+}
+prvm_prog_globaloffsets_t;
+
+// these are initialized using PRVM_ED_FindFunction
+// 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;
+}
+prvm_prog_funcoffsets_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 !
@@ -261,14 +290,24 @@ typedef struct prvm_prog_s
        int                                     edict_size;                     // in bytes
        int                                     edictareasize;          // LordHavoc: in bytes (for bound checking)
 
+       int                                     *statement_linenums; // NULL if not available
+
+       double                          *statement_profile; // only incremented if prvm_statementprofiling is on
+
        union {
                float *generic;
                globalvars_t *server;
+               cl_globalvars_t *client;
        } globals;
 
        int                                     maxknownstrings;
        int                                     numknownstrings;
+       // this is updated whenever a string is removed or added
+       // (simple optimization of the free string search)
+       int                                     firstfreeknownstring;
        const char                      **knownstrings;
+       unsigned char                           *knownstrings_freeable;
+       const char                      ***stringshash;
 
        // all memory allocations related to this vm_prog (code, edicts, strings)
        mempool_t                       *progs_mempool; // [INIT]
@@ -297,6 +336,9 @@ 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];
+       fssearch_t                      *opensearches[PRVM_MAX_OPENSEARCHES];
+
        // copies of some vars that were former read from sv
        int                                     num_edicts;
        // number of edicts for which space has been (should be) allocated
@@ -307,7 +349,6 @@ typedef struct prvm_prog_s
        // number of reserved edicts (allocated from 1)
        int                                     reserved_edicts; // [INIT]
 
-
        prvm_edict_t            *edicts;
        void                            *edictsfields;
        void                            *edictprivate;
@@ -315,11 +356,13 @@ typedef struct prvm_prog_s
        // size of the engine private struct
        int                                     edictprivate_size; // [INIT]
 
-       // has to be updated every frame - so the vm time is up-to-date
-       // AK changed so time will point to the time field (if there is one) else it points to _time
-       // actually should be double, but qc doesnt support it
-       float                           *time;
-       float                           _time;
+       prvm_prog_fieldoffsets_t        fieldoffsets;
+       prvm_prog_globaloffsets_t       globaloffsets;
+       prvm_prog_funcoffsets_t         funcoffsets;
+
+       // allow writing to world entity fields, this is set by server init and
+       // cleared before first server frame
+       qboolean                        allowworldwrites;
 
        // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
        char                            *name; // [INIT]
@@ -336,7 +379,7 @@ typedef struct prvm_prog_s
 
 //     prvm_builtin_mem_t  *mem_list;
 
-// now passes as parameter of PRVM_LoadProgs
+// now passed as parameter of PRVM_LoadProgs
 //     char                            **required_func;
 //     int                                     numrequiredfunc;
 
@@ -360,7 +403,7 @@ typedef struct prvm_prog_s
        void                            (*init_cmd)(void); // [INIT] used by PRVM_InitProg
        void                            (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
 
-       void                            (*error_cmd)(const char *format, ...); // [INIT]
+       void                            (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
 
 } prvm_prog_t;
 
@@ -412,15 +455,21 @@ void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
 void _PRVM_Free (void *buffer, const char *filename, int fileline);
 void _PRVM_FreeAll (const char *filename, int fileline);
 
+void PRVM_Profile (int maxfunctions, int mininstructions);
 void PRVM_Profile_f (void);
+void PRVM_PrintFunction_f (void);
 
 void PRVM_PrintState(void);
 void PRVM_CrashAll (void);
 void PRVM_Crash (void);
 
-int PRVM_ED_FindFieldOffset(const char *field);
-ddef_t *PRVM_ED_FindField (const char *name);
-mfunction_t *PRVM_ED_FindFunction (const char *name);
+ddef_t *PRVM_ED_FindField(const char *name);
+ddef_t *PRVM_ED_FindGlobal(const char *name);
+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);
 
 void PRVM_MEM_IncreaseEdicts(void);
 
@@ -428,6 +477,7 @@ prvm_edict_t *PRVM_ED_Alloc (void);
 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_Write (qfile_t *f, prvm_edict_t *ed);
 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
@@ -477,9 +527,9 @@ void PRVM_ED_PrintEdicts_f (void);
 void PRVM_ED_PrintNum (int ent);
 
 const char *PRVM_GetString(int num);
-int PRVM_SetQCString(const char *s);
 int PRVM_SetEngineString(const char *s);
-int PRVM_AllocString(int bufferlength, char **pointer);
+int PRVM_SetTempString(const char *s);
+int PRVM_AllocString(size_t bufferlength, char **pointer);
 void PRVM_FreeString(int num);
 
 //============================================================================
@@ -495,12 +545,11 @@ void PRVM_FreeString(int num);
 #define PRVM_End       prog = 0
 #endif
 
-
 //#define PRVM_SAFENAME
 #ifndef PRVM_SAFENAME
-       #define PRVM_NAME       (prog->name)
+#      define PRVM_NAME        (prog->name)
 #else
-       #define PRVM_NAME       (prog->name ? prog->name : "Unknown prog name")
+#      define PRVM_NAME        (prog->name ? prog->name : "Unknown prog name")
 #endif
 
 // helper macro to make function pointer calls easier
@@ -520,13 +569,14 @@ Load a program with LoadProgs
 */
 void PRVM_InitProg(int prognr);
 // LoadProgs expects to be called right after InitProg
-void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field);
+void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, char **required_global);
 void PRVM_ResetProg(void);
 
 qboolean PRVM_ProgLoaded(int prognr);
 
 int    PRVM_GetProgNr(void);
 
+void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
 
 // TODO: fill in the params
 //void PRVM_Create();