]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - cvar.h
gave names to nearly all structs and enums which should make for better C++ error...
[xonotic/darkplaces.git] / cvar.h
diff --git a/cvar.h b/cvar.h
index 61871b68afda2303f853cef1ea65cbe090ef011b..ef564156b01c8d69f8f37ed1727b808b38af9150 100644 (file)
--- a/cvar.h
+++ b/cvar.h
@@ -8,7 +8,7 @@ of the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
 See the GNU General Public License for more details.
 
@@ -53,10 +53,21 @@ Cvars are restricted from having the same names as commands to keep this
 interface from being ambiguous.
 */
 
+#ifndef CVAR_H
+#define CVAR_H
+
 // cvar flags
+
 #define CVAR_SAVE 1
 #define CVAR_NOTIFY 2
+#define        CVAR_READONLY 4
+// used to determine if flags is valid
+#define CVAR_MAXFLAGSVAL 7
+// for internal use only!
+#define CVAR_DEFAULTSET (1<<30)
+#define CVAR_ALLOCATED (1<<31)
 
+/*
 // type of a cvar for menu purposes
 #define CVARMENUTYPE_FLOAT 1
 #define CVARMENUTYPE_INTEGER 2
@@ -74,60 +85,72 @@ interface from being ambiguous.
 
 #define MAX_CVAROPTIONS 16
 
-typedef struct
+typedef struct cvaroption_s
 {
        int value;
-       char *name;
+       const char *name;
 }
 cvaroption_t;
 
-typedef struct
+typedef struct menucvar_s
 {
-       int                             type;
-       float                   valuemin, valuemax, valuestep;
-       int                             numoptions;
-       cvaroption_t    optionlist[MAX_CVAROPTIONS];
+       int type;
+       float valuemin, valuemax, valuestep;
+       int numoptions;
+       cvaroption_t optionlist[MAX_CVAROPTIONS];
 }
 menucvar_t;
+*/
 
 typedef struct cvar_s
 {
-       int                             flags;
-       char                    *name;
-       char                    *string;
-//     qboolean                archive;                // set to true to cause it to be saved to vars.rc
-//     qboolean                server;         // notifies players when changed
-       int                             intvalue;
-       float                   value;
-       float                   vector[3];
-       menucvar_t              menuinfo;
-       struct cvar_s   *next;
+       int flags;
+
+       char *name;
+
+       char *string;
+       int integer;
+       float value;
+       float vector[3];
+
+       char *defstring;
+
+       //menucvar_t menuinfo;
+       struct cvar_s *next;
 } cvar_t;
 
-void   Cvar_MenuSlider(cvar_t *variable, int menu, float slider_min, float slider_max, float slider_step);
-void   Cvar_MenuBool(cvar_t *variable, int menu, char *name_false, char *name_true);
-void   Cvar_MenuFloat(cvar_t *variable, int menu, float range_min, float range_max);
-void   Cvar_MenuInteger(cvar_t *variable, int menu, int range_min, int range_max);
-void   Cvar_MenuString(cvar_t *variable, int menu);
-void   Cvar_MenuOption(cvar_t *variable, int menu, int value[16], char *name[16]);
+/*
+void Cvar_MenuSlider(cvar_t *variable, int menu, float slider_min, float slider_max, float slider_step);
+void Cvar_MenuBool(cvar_t *variable, int menu, const char *name_false, const char *name_true);
+void Cvar_MenuFloat(cvar_t *variable, int menu, float range_min, float range_max);
+void Cvar_MenuInteger(cvar_t *variable, int menu, int range_min, int range_max);
+void Cvar_MenuString(cvar_t *variable, int menu);
+void Cvar_MenuOption(cvar_t *variable, int menu, int value[16], const char *name[16]);
+*/
 
-void   Cvar_RegisterVariable (cvar_t *variable);
+void Cvar_RegisterVariable (cvar_t *variable);
 // registers a cvar that already has the name, string, and optionally the
 // archive elements set.
 
-void   Cvar_Set (char *var_name, char *value);
+void Cvar_Set (const char *var_name, const char *value);
 // equivelant to "<name> <variable>" typed at the console
 
-void   Cvar_SetValue (char *var_name, float value);
+void Cvar_SetValue (const char *var_name, float value);
 // expands value to a string and calls Cvar_Set
 
-float  Cvar_VariableValue (char *var_name);
+void Cvar_SetQuick (cvar_t *var, const char *value);
+void Cvar_SetValueQuick (cvar_t *var, float value);
+
+float Cvar_VariableValue (const char *var_name);
 // returns 0 if not defined or non numeric
 
-char   *Cvar_VariableString (char *var_name);
+const char *Cvar_VariableString (const char *var_name);
+// returns an empty string if not defined
+
+const char *Cvar_VariableDefString (const char *var_name);
 // returns an empty string if not defined
 
-char   *Cvar_CompleteVariable (char *partial);
+const char *Cvar_CompleteVariable (const char *partial);
 // attempts to match a partial variable name for command line completion
 // returns NULL if nothing fits
 
@@ -136,23 +159,33 @@ qboolean Cvar_Command (void);
 // command.  Returns true if the command was a variable reference that
 // was handled. (print or change)
 
-void   Cvar_WriteVariables (QFile *f);
+void Cvar_WriteVariables (qfile_t *f);
 // Writes lines containing "set variable value" for all variables
 // with the archive flag set to true.
 
-cvar_t *Cvar_FindVar (char *var_name);
+cvar_t *Cvar_FindVar (const char *var_name);
+cvar_t *Cvar_FindVarAfter (const char *prev_var_name, int neededflags);
 
-extern cvar_t  *cvar_vars;
-
-int            Cvar_CompleteCountPossible (char *partial);
-char   **Cvar_CompleteBuildList (char *partial);
+int Cvar_CompleteCountPossible (const char *partial);
+const char **Cvar_CompleteBuildList (const char *partial);
 // Added by EvilTypeGuy - functions for tab completion system
 // Thanks to Fett erich@heintz.com
 // Thanks to taniwha
 
-void   Cvar_List_f (void);
+void Cvar_List_f (void);
 // Prints a list of Cvars including a count of them to the user console
 // 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_Set_f (void);
+void Cvar_SetA_f (void);
+// commands to create new cvars (or set existing ones)
+// seta creates an archived cvar (saved to config)
+
+cvar_t *Cvar_Get (const char *name, const char *value, int flags);
+// allocates a cvar by name and returns its address,
+// or merely sets its value if it already exists.
+
+#endif
+