]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - progsvm.h
-Split prvm_cmds.c into prvm_cmds.c, prvm_cmds.h and mvm_cmds.c (clvm_cmds.c
[xonotic/darkplaces.git] / progsvm.h
index eb2215bbaeea2fc04ab1979f99bc44ce20e0a24d..4f51861bf7941f6656da980a52e9c41c2bade6b9 100644 (file)
--- a/progsvm.h
+++ b/progsvm.h
@@ -170,12 +170,35 @@ typedef struct prvm_edict_s
 {
        // engine-private fields (stored in dynamically resized array)
        //edict_engineprivate_t *e;
-       prvm_edict_private_t *e;
+       union
+       {
+               prvm_edict_private_t *required;
+               void                             *vp;
+               // add other private structs as you desire
+               // new structs have to start with the elements of prvm_edit_private_t
+               // e.g. a new struct has to either look like this:
+               //      typedef struct server_edict_private_s {
+               //              prvm_edict_private_t base;
+               //              vec3_t moved_from;
+               //      vec3_t moved_fromangles;
+               //              ... } server_edict_private_t;
+               // or:
+               //      typedef struct server_edict_private_s {
+               //              qboolean free;
+               //              float freetime;
+               //              vec3_t moved_from;
+               //      vec3_t moved_fromangles;
+               //              ... } server_edict_private_t;
+               // However, the first one should be preferred.
+       } priv;
        // QuakeC fields (stored in dynamically resized array)
        //entvars_t *v;
-       void *v;
+       union 
+       {
+               void *vp;
+       } fields;
 } prvm_edict_t;
-       
+
 #define PRVM_GETEDICTFIELDVALUE(ed, fieldoffset) (fieldoffset ? (prvm_eval_t *)((qbyte *)ed->v + fieldoffset) : NULL)
 
 /*// this struct is the basic requirement for a qc prog
@@ -216,28 +239,34 @@ typedef struct prvm_builtin_mem_s
 
 typedef void (*prvm_builtin_t) (void);
 
+// [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 vm_prog_s
 {
        dprograms_t                     *progs;
        mfunction_t                     *functions;
        char                            *strings;
+       int                                     stringssize;
        ddef_t                          *fielddefs;
        ddef_t                          *globaldefs;
        dstatement_t            *statements;
-       //prvm_pr_globalvars_t*pr_global_struct; 
+       //prvm_pr_globalvars_t*pr_global_struct;
        float                           *globals;                       // same as pr_global_struct
        int                                     edict_size;                     // in bytes
        int                                     edictareasize;          // LordHavoc: in bytes (for bound checking)
-       
-       mempool_t                       *progs_mempool;
-       mempool_t                       *edictstring_mempool;
 
-       prvm_builtin_t          *builtins;
-       int                                     numbuiltins;
-       
+       int                                     maxknownstrings;
+       int                                     numknownstrings;
+       const char                      **knownstrings;
+
+       // all memory allocations related to this vm_prog (code, edicts, strings)
+       mempool_t                       *progs_mempool; // [INIT]
+
+       prvm_builtin_t          *builtins; // [INIT]
+       int                                     numbuiltins; // [INIT]
+
        int                                     argc;
-       
+
        int                                     trace;
        mfunction_t                     *xfunction;
        int                                     xstatement;
@@ -246,11 +275,11 @@ typedef struct vm_prog_s
        // thus increase the array, so depth wont be overwritten
        prvm_stack_t            stack[PRVM_MAX_STACK_DEPTH+1];
        int                                     depth;
-       
+
        int                                     localstack[PRVM_LOCALSTACK_SIZE];
        int                                     localstack_used;
 
-       unsigned short          crc;    
+       unsigned short          crc; // [INIT]
 
        //============================================================================
        // until this point everything also exists (with the pr_ prefix) in the old vm
@@ -264,58 +293,55 @@ typedef struct vm_prog_s
        void                            *edictprivate;
 
        // size of the engine private struct
-       int                                     edictprivate_size;
+       int                                     edictprivate_size; // [INIT]
 
-       // instead of sv_editcts_mempool
-       mempool_t                       *edicts_mempool;
-       
        // 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;
 
-       // name of the prog, e.g. "Server", "Client" or "Menu" (used in for text output)
-       char                            *name;
+       // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
+       char                            *name; // [INIT]
 
        // flag - used to store general flags like PRVM_GE_SELF, etc.
        int                                     flag;
 
-       char                            *extensionstring;
+       char                            *extensionstring; // [INIT]
 
        // used to indicate whether a prog is loaded
        qboolean                        loaded;
 
        // used instead of the constant MAX_EDICTS
-       int                                     limit_edicts;
+       int                                     limit_edicts; // [INIT]
 
 //     prvm_builtin_mem_t  *mem_list;
 
 // now passes as parameter of PRVM_LoadProgs
-//     char                            **required_func; 
+//     char                            **required_func;
 //     int                                     numrequiredfunc;
 
        //============================================================================
-       
+
        ddef_t                          *self; // if self != 0 then there is a global self
-       
+
        //============================================================================
        // function pointers
-       
-       void                            (*begin_increase_edicts)(void);  // used by PRVM_MEM_Increase_Edicts
-       void                            (*end_increase_edicts)(void); 
-       
-       void                            (*init_edict)(int num);         // used by PRVM_ED_ClearEdict
-       void                            (*free_edict)(prvm_edict_t *ed); // used by PRVM_ED_Free
 
-       void                            (*count_edicts)(void);  // used by PRVM_ED_Count_f
+       void                            (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
+       void                            (*end_increase_edicts)(void); // [INIT]
+
+       void                            (*init_edict)(int num); // [INIT] used by PRVM_ED_ClearEdict
+       void                            (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
+
+       void                            (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
 
-       qboolean                        (*load_edict)(prvm_edict_t *ent); // used by PRVM_ED_LoadFromFile
+       qboolean                        (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
 
-       void                            (*init_cmd)(void);      // used by PRVM_InitProg
-       void                            (*reset_cmd)(void); // used by PRVM_ResetProg
+       void                            (*init_cmd)(void); // [INIT] used by PRVM_InitProg
+       void                            (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
 
-       void                            (*error_cmd)(void);
+       void                            (*error_cmd)(void); // [INIT]
 
 } prvm_prog_t;
 
@@ -332,25 +358,25 @@ extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
 //============================================================================
 // prvm_cmds part
 
-extern prvm_builtin_t vm_sv_builtins[];  
-extern prvm_builtin_t vm_cl_builtins[];  
-extern prvm_builtin_t vm_m_builtins[];  
+extern prvm_builtin_t vm_sv_builtins[];
+extern prvm_builtin_t vm_cl_builtins[];
+extern prvm_builtin_t vm_m_builtins[];
 
 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_m_extensions; 
+extern char * vm_sv_extensions;
+extern char * vm_cl_extensions;
+extern char * vm_m_extensions;
 
-void VM_SV_Cmd_Init(void); 
-void VM_SV_Cmd_Reset(void); 
+void VM_SV_Cmd_Init(void);
+void VM_SV_Cmd_Reset(void);
 
-void VM_CL_Cmd_Init(void); 
-void VM_CL_Cmd_Reset(void); 
+void VM_CL_Cmd_Init(void);
+void VM_CL_Cmd_Reset(void);
 
-void VM_M_Cmd_Init(void); 
+void VM_M_Cmd_Init(void);
 void VM_M_Cmd_Reset(void);
 
 void VM_Cmd_Init(void);
@@ -362,8 +388,16 @@ void PRVM_Init (void);
 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func);
 
+#define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
+#define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
+#define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
+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_f (void);
 
+void PRVM_PrintState(void);
 void PRVM_CrashAll (void);
 void PRVM_Crash (void);
 
@@ -371,10 +405,7 @@ prvm_edict_t *PRVM_ED_Alloc (void);
 void PRVM_ED_Free (prvm_edict_t *ed);
 void PRVM_ED_ClearEdict (prvm_edict_t *e);
 
-char *PRVM_ED_NewString (const char *string);
-// returns a copy of the string allocated from the server's string heap
-
-void PRVM_ED_Print (prvm_edict_t *ed);
+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);
 
@@ -387,7 +418,7 @@ 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__))
 
 //int NUM_FOR_EDICT_ERROR(edict_t *e);
-#define PRVM_NUM_FOR_EDICT(e) ((prvm_edict_t *)(e) - prog->edicts)
+#define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
 //int NUM_FOR_EDICT(edict_t *e);
 
 #define        PRVM_NEXT_EDICT(e) ((e) + 1)
@@ -408,10 +439,10 @@ prvm_edict_t *PRVM_EDICT_NUM_ERROR(int n, char *filename, int fileline);
 //#define      PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals[o])
 
 // FIXME: make these go away?
-#define        PRVM_E_FLOAT(e,o) (((float*)e->v)[o])
-//#define      PRVM_E_INT(e,o) (((int*)e->v)[o])
-//#define      PRVM_E_VECTOR(e,o) (&((float*)e->v)[o])
-#define        PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->v)[o]))
+#define        PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
+#define        PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
+//#define      PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
+#define        PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
 
 extern int             prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
@@ -421,8 +452,11 @@ void PRVM_Init_Exec(void);
 void PRVM_ED_PrintEdicts_f (void);
 void PRVM_ED_PrintNum (int ent);
 
-#define PRVM_GetString(num) (prog->strings + num)
-#define PRVM_SetString(s) ((int) (s - prog->strings))
+const char *PRVM_GetString(int num);
+int PRVM_SetQCString(const char *s);
+int PRVM_SetEngineString(const char *s);
+char *PRVM_AllocString(int bufferlength);
+void PRVM_FreeString(char *s);
 
 //============================================================================
 
@@ -433,7 +467,7 @@ void PRVM_ED_PrintNum (int ent);
 #define PRVM_Begin  if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
 #define PRVM_End       prog = 0
 #else
-#define PRVM_Begin  
+#define PRVM_Begin
 #define PRVM_End       prog = 0
 #endif
 
@@ -460,7 +494,7 @@ void         PRVM_ResetProg(void);
 qboolean PRVM_ProgLoaded(int prognr);
 
 int             PRVM_GetProgNr(void);
-       
+
 
 // TODO: fill in the params
 //void PRVM_Create();