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 // 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)
  72 #define CVAR_NORESETTODEFAULTS 64
  73 // cvar is accessible in client
  74 #define CVAR_CLIENT 128
  75 // cvar is accessible in dedicated server
  76 #define CVAR_SERVER 256
  77 // used to determine if flags is valid
  78 #define CVAR_MAXFLAGSVAL 511
  79 // for internal use only!
  80 #define CVAR_DEFAULTSET (1<<30)
  81 #define CVAR_ALLOCATED (1<<31)
  82
  83 typedef struct cvar_s
  84 {
  85         int flags;
  86
  87         const char *name;
  88
  89         const char *string;
  90         const char *description;
  91         int integer;
  92         float value;
  93         float vector[3];
  94
  95         const char *defstring;
  96
  97         void (*callback)(struct cvar_s *var);
  98         qboolean ignore_callback;
  99
 100         char **aliases;
 101         int aliasindex;
 102
 103         // values at init (for Cvar_RestoreInitState)
 104         qboolean initstate; // indicates this existed at init
 105         int initflags;
 106         const char *initstring;
 107         const char *initdescription;
 108         int initinteger;
 109         float initvalue;
 110         float initvector[3];
 111         const char *initdefstring;
 112
 113         int globaldefindex[3];
 114         int globaldefindex_stringno[3];
 115
 116         struct cvar_s *next;
 117 } cvar_t;
 118
 119 typedef struct cvar_hash_s
 120 {
 121         cvar_t *cvar;
 122         struct cvar_hash_s *next;
 123 } cvar_hash_t;
 124
 125 typedef struct cvar_state_s
 126 {
 127         cvar_t *vars;
 128         cvar_hash_t *hashtable[CVAR_HASHSIZE];
 129 }
 130 cvar_state_t;
 131
 132 extern cvar_state_t cvars_all;
 133 extern cvar_state_t cvars_null; // used by cmd_serverfromclient which intentionally has no cvars available
 134
 135 void Cvar_RegisterAlias(cvar_t *variable, const char *alias );
 136
 137 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *));
 138
 139 /// registers a cvar that already has the name, string, and optionally the
 140 /// archive elements set.
 141 void Cvar_RegisterVariable(cvar_t *variable);
 142
 143 qboolean Cvar_Readonly (cvar_t *var, const char *cmd_name);
 144
 145 /// equivelant to "<name> <variable>" typed at the console
 146 void Cvar_Set (cvar_state_t *cvars, const char *var_name, const char *value);
 147 void Cvar_Set_NoCallback (cvar_t *var, const char *value);
 148
 149 /// expands value to a string and calls Cvar_Set
 150 void Cvar_SetValue (cvar_state_t *cvars, const char *var_name, float value);
 151
 152 void Cvar_SetQuick (cvar_t *var, const char *value);
 153 void Cvar_SetValueQuick (cvar_t *var, float value);
 154
 155 float Cvar_VariableValueOr (cvar_state_t *cvars, const char *var_name, float def, int neededflags);
 156 // returns def if not defined
 157
 158 float Cvar_VariableValue (cvar_state_t *cvars, const char *var_name, int neededflags);
 159 // returns 0 if not defined or non numeric
 160
 161 const char *Cvar_VariableStringOr (cvar_state_t *cvars, const char *var_name, const char *def, int neededflags);
 162 // returns def if not defined
 163
 164 const char *Cvar_VariableString (cvar_state_t *cvars, const char *var_name, int neededflags);
 165 // returns an empty string if not defined
 166
 167 const char *Cvar_VariableDefString (cvar_state_t *cvars, const char *var_name, int neededflags);
 168 // returns an empty string if not defined
 169
 170 const char *Cvar_VariableDescription (cvar_state_t *cvars, const char *var_name, int neededflags);
 171 // returns an empty string if not defined
 172
 173 const char *Cvar_CompleteVariable (cvar_state_t *cvars, const char *partial, int neededflags);
 174 // attempts to match a partial variable name for command line completion
 175 // returns NULL if nothing fits
 176
 177 void Cvar_PrintHelp(cvar_t *cvar, const char *name, qboolean full);
 178
 179 void Cvar_CompleteCvarPrint (cvar_state_t *cvars, const char *partial, int neededflags);
 180
 181 qboolean Cvar_Command (cmd_state_t *cmd);
 182 // called by Cmd_ExecuteString when Cmd_Argv(cmd, 0) doesn't match a known
 183 // command.  Returns true if the command was a variable reference that
 184 // was handled. (print or change)
 185
 186 void Cvar_SaveInitState(cvar_state_t *cvars);
 187 void Cvar_RestoreInitState(cvar_state_t *cvars);
 188
 189 void Cvar_UnlockDefaults(cmd_state_t *cmd);
 190 void Cvar_LockDefaults_f(cmd_state_t *cmd);
 191 void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd);
 192 void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd);
 193 void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd);
 194
 195 void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f);
 196 // Writes lines containing "set variable value" for all variables
 197 // with the archive flag set to true.
 198
 199 cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, int neededflags);
 200 cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, int neededflags);
 201
 202 int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, int neededflags);
 203 const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, int neededflags);
 204 // Added by EvilTypeGuy - functions for tab completion system
 205 // Thanks to Fett erich@heintz.com
 206 // Thanks to taniwha
 207
 208 /// Prints a list of Cvars including a count of them to the user console
 209 /// Referenced in cmd.c in Cmd_Init hence it's inclusion here.
 210 /// Added by EvilTypeGuy eviltypeguy@qeradiant.com
 211 /// Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 212 void Cvar_List_f(cmd_state_t *cmd);
 213
 214 void Cvar_Set_f(cmd_state_t *cmd);
 215 void Cvar_SetA_f(cmd_state_t *cmd);
 216 void Cvar_Del_f(cmd_state_t *cmd);
 217 // commands to create new cvars (or set existing ones)
 218 // seta creates an archived cvar (saved to config)
 219
 220 /// allocates a cvar by name and returns its address,
 221 /// or merely sets its value if it already exists.
 222 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription);
 223
 224 extern const char *cvar_dummy_description; // ALWAYS the same pointer
 225
 226 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars); // updates ALL autocvars of the active prog to the cvar values (savegame loading)
 227
 228 #ifdef FILLALLCVARSWITHRUBBISH
 229 void Cvar_FillAll_f(cmd_state_t *cmd);
 230 #endif /* FILLALLCVARSWITHRUBBISH */
 231
 232 #endif
 233