cvar.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20 // cvar.h
  21
  22 struct cmd_state_s;
  23 typedef struct cmd_state_s cmd_state_t;
  24
  25 /*
  26
  27 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
  28 in C code.
  29
  30 it is sufficient to initialize a cvar_t with just the first two fields, or
  31 you can add a ,true flag for variables that you want saved to the configuration
  32 file when the game is quit:
  33
  34 cvar_t  r_draworder = {"r_draworder","1"};
  35 cvar_t  scr_screensize = {"screensize","1",true};
  36
  37 Cvars must be registered before use, or they will have a 0 value instead of the float interpretation of the string.  Generally, all cvar_t declarations should be registered in the apropriate init function before any console commands are executed:
  38 Cvar_RegisterVariable (&host_framerate);
  39
  40
  41 C code usually just references a cvar in place:
  42 if ( r_draworder.value )
  43
  44 It could optionally ask for the value to be looked up for a string name:
  45 if (Cvar_VariableValue ("r_draworder"))
  46
  47 Interpreted prog code can access cvars with the cvar(name) or
  48 cvar_set (name, value) internal functions:
  49 teamplay = cvar("teamplay");
  50 cvar_set ("registered", "1");
  51
  52 The user can access cvars from the console in two ways:
  53 r_draworder                     prints the current value
  54 r_draworder 0           sets the current value to 0
  55 Cvars are restricted from having the same names as commands to keep this
  56 interface from being ambiguous.
  57 */
  58
  59 #ifndef CVAR_H
  60 #define CVAR_H
  61
  62 // cvar flags
  63
  64 #define CVAR_SAVE 1
  65 #define CVAR_NOTIFY 2
  66 #define CVAR_READONLY 4
  67 #define CVAR_SERVERINFO 8
  68 #define CVAR_USERINFO 16
  69 // CVAR_PRIVATE means do not $ expand or sendcvar this cvar under any circumstances (rcon_password uses this)
  70 #define CVAR_PRIVATE 32
  71 // this means that this cvar should update a userinfo key but the name does not correspond directly to the userinfo key to update, and may require additional conversion ("_cl_color" for example should update "topcolor" and "bottomcolor")
  72 #define CVAR_NQUSERINFOHACK 64
  73 // 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)
  74 #define CVAR_NORESETTODEFAULTS 128
  75 // cvar is accessible in client
  76 #define CVAR_CLIENT 256
  77 // cvar is accessible in dedicated server
  78 #define CVAR_SERVER 512
  79 // used to determine if flags is valid
  80 #define CVAR_MAXFLAGSVAL 1023
  81 // for internal use only!
  82 #define CVAR_DEFAULTSET (1<<30)
  83 #define CVAR_ALLOCATED (1<<31)
  84
  85 /*
  86 // type of a cvar for menu purposes
  87 #define CVARMENUTYPE_FLOAT 1
  88 #define CVARMENUTYPE_INTEGER 2
  89 #define CVARMENUTYPE_SLIDER 3
  90 #define CVARMENUTYPE_BOOL 4
  91 #define CVARMENUTYPE_STRING 5
  92 #define CVARMENUTYPE_OPTION 6
  93
  94 // which menu to put a cvar in
  95 #define CVARMENU_GRAPHICS 1
  96 #define CVARMENU_SOUND 2
  97 #define CVARMENU_INPUT 3
  98 #define CVARMENU_NETWORK 4
  99 #define CVARMENU_SERVER 5
 100
 101 #define MAX_CVAROPTIONS 16
 102
 103 typedef struct cvaroption_s
 104 {
 105         int value;
 106         const char *name;
 107 }
 108 cvaroption_t;
 109
 110 typedef struct menucvar_s
 111 {
 112         int type;
 113         float valuemin, valuemax, valuestep;
 114         int numoptions;
 115         cvaroption_t optionlist[MAX_CVAROPTIONS];
 116 }
 117 menucvar_t;
 118 */
 119
 120 typedef struct cvar_s
 121 {
 122         int flags;
 123
 124         const char *name;
 125
 126         const char *string;
 127         const char *description;
 128         int integer;
 129         float value;
 130         float vector[3];
 131
 132         const char *defstring;
 133
 134         void (*callback)(char *value);
 135
 136         // values at init (for Cvar_RestoreInitState)
 137         qboolean initstate; // indicates this existed at init
 138         int initflags;
 139         const char *initstring;
 140         const char *initdescription;
 141         int initinteger;
 142         float initvalue;
 143         float initvector[3];
 144         const char *initdefstring;
 145
 146         int globaldefindex[3];
 147         int globaldefindex_stringno[3];
 148
 149         //menucvar_t menuinfo;
 150         struct cvar_s *next;
 151         struct cvar_s *nextonhashchain;
 152 } cvar_t;
 153
 154 typedef struct cvar_state_s
 155 {
 156         cvar_t *vars;
 157         cvar_t *hashtable[CVAR_HASHSIZE];
 158 }
 159 cvar_state_t;
 160
 161 extern cvar_state_t cvars_all;
 162 extern cvar_state_t cvars_null; // used by cmd_serverfromclient which intentionally has no cvars available
 163
 164 /*
 165 void Cvar_MenuSlider(cvar_t *variable, int menu, float slider_min, float slider_max, float slider_step);
 166 void Cvar_MenuBool(cvar_t *variable, int menu, const char *name_false, const char *name_true);
 167 void Cvar_MenuFloat(cvar_t *variable, int menu, float range_min, float range_max);
 168 void Cvar_MenuInteger(cvar_t *variable, int menu, int range_min, int range_max);
 169 void Cvar_MenuString(cvar_t *variable, int menu);
 170 void Cvar_MenuOption(cvar_t *variable, int menu, int value[16], const char *name[16]);
 171 */
 172
 173 /// registers a cvar that already has the name, string, and optionally the
 174 /// archive elements set.
 175 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(char *));
 176
 177 void Cvar_RegisterVariable(cvar_t *variable);
 178
 179 /// equivelant to "<name> <variable>" typed at the console
 180 void Cvar_Set (cvar_state_t *cvars, const char *var_name, const char *value);
 181
 182 /// expands value to a string and calls Cvar_Set
 183 void Cvar_SetValue (cvar_state_t *cvars, const char *var_name, float value);
 184
 185 void Cvar_SetQuick (cvar_t *var, const char *value);
 186 void Cvar_SetValueQuick (cvar_t *var, float value);
 187
 188 float Cvar_VariableValueOr (cvar_state_t *cvars, const char *var_name, float def, int neededflags);
 189 // returns def if not defined
 190
 191 float Cvar_VariableValue (cvar_state_t *cvars, const char *var_name, int neededflags);
 192 // returns 0 if not defined or non numeric
 193
 194 const char *Cvar_VariableStringOr (cvar_state_t *cvars, const char *var_name, const char *def, int neededflags);
 195 // returns def if not defined
 196
 197 const char *Cvar_VariableString (cvar_state_t *cvars, const char *var_name, int neededflags);
 198 // returns an empty string if not defined
 199
 200 const char *Cvar_VariableDefString (cvar_state_t *cvars, const char *var_name, int neededflags);
 201 // returns an empty string if not defined
 202
 203 const char *Cvar_VariableDescription (cvar_state_t *cvars, const char *var_name, int neededflags);
 204 // returns an empty string if not defined
 205
 206 const char *Cvar_CompleteVariable (cvar_state_t *cvars, const char *partial, int neededflags);
 207 // attempts to match a partial variable name for command line completion
 208 // returns NULL if nothing fits
 209
 210 void Cvar_PrintHelp(cvar_t *cvar, qboolean full);
 211
 212 void Cvar_CompleteCvarPrint (cvar_state_t *cvars, const char *partial, int neededflags);
 213
 214 qboolean Cvar_Command (cmd_state_t *cmd);
 215 // called by Cmd_ExecuteString when Cmd_Argv(cmd, 0) doesn't match a known
 216 // command.  Returns true if the command was a variable reference that
 217 // was handled. (print or change)
 218
 219 void Cvar_SaveInitState(cvar_state_t *cvars);
 220 void Cvar_RestoreInitState(cvar_state_t *cvars);
 221
 222 void Cvar_UnlockDefaults(cmd_state_t *cmd);
 223 void Cvar_LockDefaults_f(cmd_state_t *cmd);
 224 void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd);
 225 void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd);
 226 void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd);
 227
 228 void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f);
 229 // Writes lines containing "set variable value" for all variables
 230 // with the archive flag set to true.
 231
 232 cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, int neededflags);
 233 cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, int neededflags);
 234
 235 int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, int neededflags);
 236 const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, int neededflags);
 237 // Added by EvilTypeGuy - functions for tab completion system
 238 // Thanks to Fett erich@heintz.com
 239 // Thanks to taniwha
 240
 241 /// Prints a list of Cvars including a count of them to the user console
 242 /// Referenced in cmd.c in Cmd_Init hence it's inclusion here.
 243 /// Added by EvilTypeGuy eviltypeguy@qeradiant.com
 244 /// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 245 void Cvar_List_f(cmd_state_t *cmd);
 246
 247 void Cvar_Set_f(cmd_state_t *cmd);
 248 void Cvar_SetA_f(cmd_state_t *cmd);
 249 void Cvar_Del_f(cmd_state_t *cmd);
 250 // commands to create new cvars (or set existing ones)
 251 // seta creates an archived cvar (saved to config)
 252
 253 /// allocates a cvar by name and returns its address,
 254 /// or merely sets its value if it already exists.
 255 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription);
 256
 257 extern const char *cvar_dummy_description; // ALWAYS the same pointer
 258
 259 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars); // updates ALL autocvars of the active prog to the cvar values (savegame loading)
 260
 261 #ifdef FILLALLCVARSWITHRUBBISH
 262 void Cvar_FillAll_f(cmd_state_t *cmd);
 263 #endif /* FILLALLCVARSWITHRUBBISH */
 264
 265 #endif
 266