2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // cvar.c -- dynamic variable tracking
24 cvar_t *cvar_vars = NULL;
25 cvar_t *cvar_hashtable[65536];
26 char *cvar_null_string = "";
33 cvar_t *Cvar_FindVar (const char *var_name)
38 // use hash lookup to minimize search time
39 hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name));
40 for (var = cvar_hashtable[hashindex];var;var = var->nextonhashchain)
41 if (!strcasecmp (var_name, var->name))
47 cvar_t *Cvar_FindVarAfter (const char *prev_var_name, int neededflags)
53 var = Cvar_FindVar (prev_var_name);
61 // search for the next cvar matching the needed flags
64 if ((var->flags & neededflags) || !neededflags)
76 float Cvar_VariableValue (const char *var_name)
80 var = Cvar_FindVar (var_name);
83 return atof (var->string);
92 const char *Cvar_VariableString (const char *var_name)
96 var = Cvar_FindVar (var_name);
98 return cvar_null_string;
104 Cvar_VariableDefString
107 const char *Cvar_VariableDefString (const char *var_name)
111 var = Cvar_FindVar (var_name);
113 return cvar_null_string;
114 return var->defstring;
120 Cvar_CompleteVariable
123 const char *Cvar_CompleteVariable (const char *partial)
128 len = strlen(partial);
134 for (cvar=cvar_vars ; cvar ; cvar=cvar->next)
135 if (!strncasecmp (partial,cvar->name, len))
143 CVar_CompleteCountPossible
145 New function for tab-completion system
147 Thanks to Fett erich@heintz.com
150 int Cvar_CompleteCountPossible (const char *partial)
157 len = strlen(partial);
162 // Loop through the cvars and count all possible matches
163 for (cvar = cvar_vars; cvar; cvar = cvar->next)
164 if (!strncasecmp(partial, cvar->name, len))
171 CVar_CompleteBuildList
173 New function for tab-completion system
175 Thanks to Fett erich@heintz.com
179 const char **Cvar_CompleteBuildList (const char *partial)
184 size_t sizeofbuf = (Cvar_CompleteCountPossible (partial) + 1) * sizeof (const char *);
187 len = strlen(partial);
188 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
189 // Loop through the alias list and print all matches
190 for (cvar = cvar_vars; cvar; cvar = cvar->next)
191 if (!strncasecmp(partial, cvar->name, len))
192 buf[bpos++] = cvar->name;
198 // written by LordHavoc
199 void Cvar_CompleteCvarPrint (const char *partial)
202 size_t len = strlen(partial);
203 // Loop through the command list and print all matches
204 for (cvar = cvar_vars; cvar; cvar = cvar->next)
205 if (!strncasecmp(partial, cvar->name, len))
206 Con_Printf ("%c3%s%s : \"%s\" (\"%s\") : %s\n", STRING_COLOR_TAG, cvar->name, STRING_COLOR_DEFAULT_STR, cvar->string, cvar->defstring, cvar->description);
215 void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
219 changed = strcmp(var->string, value);
220 // LordHavoc: don't reallocate when there is no change
224 // LordHavoc: don't reallocate when the buffer is the same size
225 if (!var->string || strlen(var->string) != strlen(value))
227 Z_Free (var->string); // free the old value string
229 var->string = (char *)Z_Malloc (strlen(value)+1);
231 strcpy (var->string, value);
232 var->value = atof (var->string);
233 var->integer = (int) var->value;
234 if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
235 SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
237 // TODO: add infostring support to the server?
238 if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
240 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
243 MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
244 MSG_WriteString (&sv.reliable_datagram, var->name);
245 MSG_WriteString (&sv.reliable_datagram, var->string);
249 if ((var->flags & CVAR_USERINFO) && changed && cls.state != ca_dedicated)
251 InfoString_SetValue(cls.userinfo, sizeof(cls.userinfo), var->name, var->string);
252 if (cls.state == ca_connected)
253 Cmd_ForwardStringToServer(va("setinfo \"%s\" \"%s\"\n", var->name, var->string));
257 void Cvar_SetQuick (cvar_t *var, const char *value)
261 Con_Print("Cvar_SetQuick: var == NULL\n");
265 if (developer.integer >= 100)
266 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
268 Cvar_SetQuick_Internal(var, value);
271 void Cvar_Set (const char *var_name, const char *value)
274 var = Cvar_FindVar (var_name);
277 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
280 Cvar_SetQuick(var, value);
288 void Cvar_SetValueQuick(cvar_t *var, float value)
290 char val[MAX_INPUTLINE];
292 if ((float)((int)value) == value)
293 sprintf(val, "%i", (int)value);
295 sprintf(val, "%f", value);
296 Cvar_SetQuick(var, val);
299 void Cvar_SetValue(const char *var_name, float value)
301 char val[MAX_INPUTLINE];
303 if ((float)((int)value) == value)
304 sprintf(val, "%i", (int)value);
306 sprintf(val, "%f", value);
307 Cvar_Set(var_name, val);
312 Cvar_RegisterVariable
314 Adds a freestanding variable to the variable list.
317 void Cvar_RegisterVariable (cvar_t *variable)
320 cvar_t *current, *next, *cvar;
323 if (developer.integer >= 100)
324 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
326 // first check to see if it has already been defined
327 cvar = Cvar_FindVar (variable->name);
330 if (cvar->flags & CVAR_ALLOCATED)
332 if (developer.integer >= 100)
333 Con_Printf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
334 // fixed variables replace allocated ones
335 // (because the engine directly accesses fixed variables)
336 // NOTE: this isn't actually used currently
337 // (all cvars are registered before config parsing)
338 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
339 // cvar->string is now owned by variable instead
340 variable->string = cvar->string;
341 variable->defstring = cvar->defstring;
342 variable->value = atof (variable->string);
343 variable->integer = (int) variable->value;
344 // replace cvar with this one...
345 variable->next = cvar->next;
346 if (cvar_vars == cvar)
348 // head of the list is easy to change
349 cvar_vars = variable;
353 // otherwise find it somewhere in the list
354 for (current = cvar_vars;current->next != cvar;current = current->next)
356 current->next = variable;
359 // get rid of old allocated cvar
360 // (but not cvar->string and cvar->defstring, because we kept those)
365 Con_Printf("Can't register variable %s, already defined\n", variable->name);
369 // check for overlap with a command
370 if (Cmd_Exists (variable->name))
372 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
376 // copy the value off, because future sets will Z_Free it
377 oldstr = variable->string;
378 variable->string = (char *)Z_Malloc (strlen(variable->string)+1);
379 strcpy (variable->string, oldstr);
380 variable->defstring = (char *)Z_Malloc (strlen(variable->string)+1);
381 strcpy (variable->defstring, oldstr);
382 variable->value = atof (variable->string);
383 variable->integer = (int) variable->value;
385 // link the variable in
386 // alphanumerical order
387 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
390 current->next = variable;
392 cvar_vars = variable;
394 variable->next = next;
396 // link to head of list in this hash table index
397 hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
398 variable->nextonhashchain = cvar_hashtable[hashindex];
399 cvar_hashtable[hashindex] = variable;
406 Adds a newly allocated variable to the variable list or sets its value.
409 cvar_t *Cvar_Get (const char *name, const char *value, int flags)
412 cvar_t *current, *next, *cvar;
414 if (developer.integer >= 100)
415 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
417 // first check to see if it has already been defined
418 cvar = Cvar_FindVar (name);
421 cvar->flags |= flags;
422 Cvar_SetQuick_Internal (cvar, value);
423 // also set the default value (but only once)
424 if (~cvar->flags & CVAR_DEFAULTSET)
426 cvar->flags |= CVAR_DEFAULTSET;
428 Z_Free(cvar->defstring);
429 cvar->defstring = (char *)Z_Malloc(strlen(value) + 1);
430 strcpy(cvar->defstring, value);
435 // check for overlap with a command
436 if (Cmd_Exists (name))
438 Con_Printf("Cvar_Get: %s is a command\n", name);
442 // allocate a new cvar, cvar name, and cvar string
443 // FIXME: these never get Z_Free'd
444 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
445 cvar->flags = flags | CVAR_ALLOCATED | CVAR_DEFAULTSET;
446 cvar->name = (char *)Z_Malloc(strlen(name)+1);
447 strcpy(cvar->name, name);
448 cvar->string = (char *)Z_Malloc(strlen(value)+1);
449 strcpy(cvar->string, value);
450 cvar->defstring = (char *)Z_Malloc(strlen(value)+1);
451 strcpy(cvar->defstring, value);
452 cvar->value = atof (cvar->string);
453 cvar->integer = (int) cvar->value;
454 cvar->description = "custom cvar";
456 // link the variable in
457 // alphanumerical order
458 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
461 current->next = cvar;
466 // link to head of list in this hash table index
467 hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
468 cvar->nextonhashchain = cvar_hashtable[hashindex];
469 cvar_hashtable[hashindex] = cvar;
479 Handles variable inspection and changing from the console
482 qboolean Cvar_Command (void)
487 v = Cvar_FindVar (Cmd_Argv(0));
491 // perform a variable print or set
494 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
498 if (developer.integer >= 100)
499 Con_DPrint("Cvar_Command: ");
501 if (v->flags & CVAR_READONLY)
503 Con_Printf("%s is read-only\n", v->name);
506 Cvar_Set (v->name, Cmd_Argv(1));
507 if (developer.integer >= 100)
517 Writes lines containing "set variable value" for all variables
518 with the archive flag set to true.
521 void Cvar_WriteVariables (qfile_t *f)
525 for (var = cvar_vars ; var ; var = var->next)
526 if (var->flags & CVAR_SAVE)
527 FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
531 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
532 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
538 void Cvar_List_f (void)
547 partial = Cmd_Argv (1);
548 len = strlen(partial);
557 for (cvar = cvar_vars; cvar; cvar = cvar->next)
559 if (partial && strncasecmp (partial,cvar->name,len))
562 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
567 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
569 Con_Printf("%i cvar(s)\n", count);
571 // 2000-01-09 CvarList command by Maddes
573 void Cvar_Set_f (void)
577 // make sure it's the right number of parameters
580 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
584 // check if it's read-only
585 cvar = Cvar_FindVar(Cmd_Argv(1));
586 if (cvar && cvar->flags & CVAR_READONLY)
588 Con_Printf("Set: %s is read-only\n", cvar->name);
594 // all looks ok, create/modify the cvar
595 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
598 void Cvar_SetA_f (void)
602 // make sure it's the right number of parameters
605 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
609 // check if it's read-only
610 cvar = Cvar_FindVar(Cmd_Argv(1));
611 if (cvar && cvar->flags & CVAR_READONLY)
613 Con_Printf("SetA: %s is read-only\n", cvar->name);
617 Con_DPrint("SetA: ");
619 // all looks ok, create/modify the cvar
620 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);