cvar: Rename aliasindex to aliases_size and only use it for size of the aliases array...

[xonotic/darkplaces.git] / cvar.h

diff --git a/cvar.h b/cvar.h
index 9d0eb032d6e5feefcd1b0f902af754306848f081..660320390f99358d826e0f8f1fa0b12f790840c4 100644 (file)
--- a/cvar.h
+++ b/cvar.h
@@ -1,5 +1,6 @@
 /*
 Copyright (C) 1996-1997 Id Software, Inc.
+Copyright (C) 2006-2021 DarkPlaces contributors
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
@@ -19,9 +20,6 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 // cvar.h
 
-struct cmd_state_s;
-typedef struct cmd_state_s cmd_state_t;
-
 /*
 
 cvar_t variables are used to hold scalar or string variables that can be changed or displayed at the console or prog code as well as accessed directly
@@ -59,26 +57,10 @@ interface from being ambiguous.
 #ifndef CVAR_H
 #define CVAR_H
 
-// cvar flags
-
-#define CVAR_SAVE 1
-#define CVAR_NOTIFY 2
-#define CVAR_READONLY 4
-#define CVAR_SERVERINFO 8
-#define CVAR_USERINFO 16
-// CVAR_PRIVATE means do not $ expand or sendcvar this cvar under any circumstances (rcon_password uses this)
-#define CVAR_PRIVATE 32
-// for engine-owned cvars that must not be reset on gametype switch (e.g. scr_screenshot_name, which otherwise isn't set to the mod name properly)
-#define CVAR_NORESETTODEFAULTS 64
-// cvar is accessible in client
-#define CVAR_CLIENT 128
-// cvar is accessible in dedicated server
-#define CVAR_SERVER 256
-// used to determine if flags is valid
-#define CVAR_MAXFLAGSVAL 511
-// for internal use only!
-#define CVAR_DEFAULTSET (1<<30)
-#define CVAR_ALLOCATED (1<<31)
+#include "qtypes.h"
+#include "qdefs.h"
+struct cmd_state_s;
+struct qfile_s;
 
 typedef struct cvar_s
 {
@@ -95,20 +77,11 @@ typedef struct cvar_s
        const char *defstring;
 
        void (*callback)(struct cvar_s *var);
-       qbool ignore_callback;
 
        char **aliases;
-       int aliasindex;
-
-       // values at init (for Cvar_RestoreInitState)
-       qbool initstate; // indicates this existed at init
-       int initflags;
-       const char *initstring;
-       const char *initdescription;
-       int initinteger;
-       float initvalue;
-       float initvector[3];
-       const char *initdefstring;
+       int aliases_size;
+
+       struct cvar_s *initstate; // snapshot of cvar during init
 
        int globaldefindex[3];
        int globaldefindex_stringno[3];
@@ -142,9 +115,10 @@ void Cvar_RegisterVariable(cvar_t *variable);
 
 qbool Cvar_Readonly (cvar_t *var, const char *cmd_name);
 
+void Cvar_Callback(cvar_t *var);
+
 /// equivelant to "<name> <variable>" typed at the console
 void Cvar_Set (cvar_state_t *cvars, const char *var_name, const char *value);
-void Cvar_Set_NoCallback (cvar_t *var, const char *value);
 
 /// expands value to a string and calls Cvar_Set
 void Cvar_SetValue (cvar_state_t *cvars, const char *var_name, float value);
@@ -178,7 +152,7 @@ void Cvar_PrintHelp(cvar_t *cvar, const char *name, qbool full);
 
 void Cvar_CompleteCvarPrint (cvar_state_t *cvars, const char *partial, int neededflags);
 
-qbool Cvar_Command (cmd_state_t *cmd);
+qbool Cvar_Command (struct cmd_state_s *cmd);
 // called by Cmd_ExecuteString when Cmd_Argv(cmd, 0) doesn't match a known
 // command.  Returns true if the command was a variable reference that
 // was handled. (print or change)
@@ -186,13 +160,13 @@ qbool Cvar_Command (cmd_state_t *cmd);
 void Cvar_SaveInitState(cvar_state_t *cvars);
 void Cvar_RestoreInitState(cvar_state_t *cvars);
 
-void Cvar_UnlockDefaults(cmd_state_t *cmd);
-void Cvar_LockDefaults_f(cmd_state_t *cmd);
-void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd);
-void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd);
-void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd);
+void Cvar_UnlockDefaults(struct cmd_state_s *cmd);
+void Cvar_LockDefaults_f(struct cmd_state_s *cmd);
+void Cvar_ResetToDefaults_All_f(struct cmd_state_s *cmd);
+void Cvar_ResetToDefaults_NoSaveOnly_f(struct cmd_state_s *cmd);
+void Cvar_ResetToDefaults_SaveOnly_f(struct cmd_state_s *cmd);
 
-void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f);
+void Cvar_WriteVariables (cvar_state_t *cvars, struct qfile_s *f);
 // Writes lines containing "set variable value" for all variables
 // with the archive flag set to true.
 
@@ -209,11 +183,11 @@ const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, in
 /// Referenced in cmd.c in Cmd_Init hence it's inclusion here.
 /// Added by EvilTypeGuy eviltypeguy@qeradiant.com
 /// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
-void Cvar_List_f(cmd_state_t *cmd);
+void Cvar_List_f(struct cmd_state_s *cmd);
 
-void Cvar_Set_f(cmd_state_t *cmd);
-void Cvar_SetA_f(cmd_state_t *cmd);
-void Cvar_Del_f(cmd_state_t *cmd);
+void Cvar_Set_f(struct cmd_state_s *cmd);
+void Cvar_SetA_f(struct cmd_state_s *cmd);
+void Cvar_Del_f(struct cmd_state_s *cmd);
 // commands to create new cvars (or set existing ones)
 // seta creates an archived cvar (saved to config)