DP code cleanup, stage one - all headers that can be protected by ifdef
[divverent/darkplaces.git] / 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 /*
23
24 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
25 in C code.
26
27 it is sufficient to initialize a cvar_t with just the first two fields, or
28 you can add a ,true flag for variables that you want saved to the configuration
29 file when the game is quit:
30
31 cvar_t  r_draworder = {"r_draworder","1"};
32 cvar_t  scr_screensize = {"screensize","1",true};
33
34 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:
35 Cvar_RegisterVariable (&host_framerate);
36
37
38 C code usually just references a cvar in place:
39 if ( r_draworder.value )
40
41 It could optionally ask for the value to be looked up for a string name:
42 if (Cvar_VariableValue ("r_draworder"))
43
44 Interpreted prog code can access cvars with the cvar(name) or
45 cvar_set (name, value) internal functions:
46 teamplay = cvar("teamplay");
47 cvar_set ("registered", "1");
48
49 The user can access cvars from the console in two ways:
50 r_draworder                     prints the current value
51 r_draworder 0           sets the current value to 0
52 Cvars are restricted from having the same names as commands to keep this
53 interface from being ambiguous.
54 */
55
56 #ifndef CVAR_H
57 #define CVAR_H
58
59 // cvar flags
60 #define CVAR_SAVE 1
61 #define CVAR_NOTIFY 2
62
63 // type of a cvar for menu purposes
64 #define CVARMENUTYPE_FLOAT 1
65 #define CVARMENUTYPE_INTEGER 2
66 #define CVARMENUTYPE_SLIDER 3
67 #define CVARMENUTYPE_BOOL 4
68 #define CVARMENUTYPE_STRING 5
69 #define CVARMENUTYPE_OPTION 6
70
71 // which menu to put a cvar in
72 #define CVARMENU_GRAPHICS 1
73 #define CVARMENU_SOUND 2
74 #define CVARMENU_INPUT 3
75 #define CVARMENU_NETWORK 4
76 #define CVARMENU_SERVER 5
77
78 #define MAX_CVAROPTIONS 16
79
80 typedef struct
81 {
82         int value;
83         char *name;
84 }
85 cvaroption_t;
86
87 typedef struct
88 {
89         int                             type;
90         float                   valuemin, valuemax, valuestep;
91         int                             numoptions;
92         cvaroption_t    optionlist[MAX_CVAROPTIONS];
93 }
94 menucvar_t;
95
96 typedef struct cvar_s
97 {
98         int                             flags;
99         char                    *name;
100         char                    *string;
101         int                             integer;
102         float                   value;
103         float                   vector[3];
104         menucvar_t              menuinfo;
105         struct cvar_s   *next;
106 } cvar_t;
107
108 void    Cvar_MenuSlider(cvar_t *variable, int menu, float slider_min, float slider_max, float slider_step);
109 void    Cvar_MenuBool(cvar_t *variable, int menu, char *name_false, char *name_true);
110 void    Cvar_MenuFloat(cvar_t *variable, int menu, float range_min, float range_max);
111 void    Cvar_MenuInteger(cvar_t *variable, int menu, int range_min, int range_max);
112 void    Cvar_MenuString(cvar_t *variable, int menu);
113 void    Cvar_MenuOption(cvar_t *variable, int menu, int value[16], char *name[16]);
114
115 void    Cvar_RegisterVariable (cvar_t *variable);
116 // registers a cvar that already has the name, string, and optionally the
117 // archive elements set.
118
119 void    Cvar_Set (char *var_name, char *value);
120 // equivelant to "<name> <variable>" typed at the console
121
122 void    Cvar_SetValue (char *var_name, float value);
123 // expands value to a string and calls Cvar_Set
124
125 void    Cvar_SetQuick (cvar_t *var, char *value);
126 void    Cvar_SetValueQuick (cvar_t *var, float value);
127
128 float   Cvar_VariableValue (char *var_name);
129 // returns 0 if not defined or non numeric
130
131 char    *Cvar_VariableString (char *var_name);
132 // returns an empty string if not defined
133
134 char    *Cvar_CompleteVariable (char *partial);
135 // attempts to match a partial variable name for command line completion
136 // returns NULL if nothing fits
137
138 qboolean Cvar_Command (void);
139 // called by Cmd_ExecuteString when Cmd_Argv(0) doesn't match a known
140 // command.  Returns true if the command was a variable reference that
141 // was handled. (print or change)
142
143 void    Cvar_WriteVariables (QFile *f);
144 // Writes lines containing "set variable value" for all variables
145 // with the archive flag set to true.
146
147 cvar_t *Cvar_FindVar (char *var_name);
148
149 extern cvar_t   *cvar_vars;
150
151 int             Cvar_CompleteCountPossible (char *partial);
152 char    **Cvar_CompleteBuildList (char *partial);
153 // Added by EvilTypeGuy - functions for tab completion system
154 // Thanks to Fett erich@heintz.com
155 // Thanks to taniwha
156
157 void    Cvar_List_f (void);
158 // Prints a list of Cvars including a count of them to the user console
159 // Referenced in cmd.c in Cmd_Init hence it's inclusion here
160 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
161 // Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
162
163 #endif
164