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) && cls.state != ca_dedicated)
250 CL_SetInfo(var->name, var->string, true, false, false, false);
253 void Cvar_SetQuick (cvar_t *var, const char *value)
257 Con_Print("Cvar_SetQuick: var == NULL\n");
261 if (developer.integer >= 100)
262 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
264 Cvar_SetQuick_Internal(var, value);
267 void Cvar_Set (const char *var_name, const char *value)
270 var = Cvar_FindVar (var_name);
273 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
276 Cvar_SetQuick(var, value);
284 void Cvar_SetValueQuick(cvar_t *var, float value)
286 char val[MAX_INPUTLINE];
288 if ((float)((int)value) == value)
289 sprintf(val, "%i", (int)value);
291 sprintf(val, "%f", value);
292 Cvar_SetQuick(var, val);
295 void Cvar_SetValue(const char *var_name, float value)
297 char val[MAX_INPUTLINE];
299 if ((float)((int)value) == value)
300 sprintf(val, "%i", (int)value);
302 sprintf(val, "%f", value);
303 Cvar_Set(var_name, val);
308 Cvar_RegisterVariable
310 Adds a freestanding variable to the variable list.
313 void Cvar_RegisterVariable (cvar_t *variable)
316 cvar_t *current, *next, *cvar;
319 if (developer.integer >= 100)
320 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
322 // first check to see if it has already been defined
323 cvar = Cvar_FindVar (variable->name);
326 if (cvar->flags & CVAR_ALLOCATED)
328 if (developer.integer >= 100)
329 Con_Printf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
330 // fixed variables replace allocated ones
331 // (because the engine directly accesses fixed variables)
332 // NOTE: this isn't actually used currently
333 // (all cvars are registered before config parsing)
334 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
335 // cvar->string is now owned by variable instead
336 variable->string = cvar->string;
337 variable->defstring = cvar->defstring;
338 variable->value = atof (variable->string);
339 variable->integer = (int) variable->value;
340 // replace cvar with this one...
341 variable->next = cvar->next;
342 if (cvar_vars == cvar)
344 // head of the list is easy to change
345 cvar_vars = variable;
349 // otherwise find it somewhere in the list
350 for (current = cvar_vars;current->next != cvar;current = current->next)
352 current->next = variable;
355 // get rid of old allocated cvar
356 // (but not cvar->string and cvar->defstring, because we kept those)
361 Con_Printf("Can't register variable %s, already defined\n", variable->name);
365 // check for overlap with a command
366 if (Cmd_Exists (variable->name))
368 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
372 // copy the value off, because future sets will Z_Free it
373 oldstr = variable->string;
374 variable->string = (char *)Z_Malloc (strlen(variable->string)+1);
375 strcpy (variable->string, oldstr);
376 variable->defstring = (char *)Z_Malloc (strlen(variable->string)+1);
377 strcpy (variable->defstring, oldstr);
378 variable->value = atof (variable->string);
379 variable->integer = (int) variable->value;
381 // link the variable in
382 // alphanumerical order
383 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
386 current->next = variable;
388 cvar_vars = variable;
390 variable->next = next;
392 // link to head of list in this hash table index
393 hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
394 variable->nextonhashchain = cvar_hashtable[hashindex];
395 cvar_hashtable[hashindex] = variable;
402 Adds a newly allocated variable to the variable list or sets its value.
405 cvar_t *Cvar_Get (const char *name, const char *value, int flags)
408 cvar_t *current, *next, *cvar;
410 if (developer.integer >= 100)
411 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
413 // first check to see if it has already been defined
414 cvar = Cvar_FindVar (name);
417 cvar->flags |= flags;
418 Cvar_SetQuick_Internal (cvar, value);
422 // check for overlap with a command
423 if (Cmd_Exists (name))
425 Con_Printf("Cvar_Get: %s is a command\n", name);
429 // allocate a new cvar, cvar name, and cvar string
430 // FIXME: these never get Z_Free'd
431 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
432 cvar->flags = flags | CVAR_ALLOCATED;
433 cvar->name = (char *)Z_Malloc(strlen(name)+1);
434 strcpy(cvar->name, name);
435 cvar->string = (char *)Z_Malloc(strlen(value)+1);
436 strcpy(cvar->string, value);
437 cvar->defstring = (char *)Z_Malloc(strlen(value)+1);
438 strcpy(cvar->defstring, value);
439 cvar->value = atof (cvar->string);
440 cvar->integer = (int) cvar->value;
441 cvar->description = "custom cvar";
443 // link the variable in
444 // alphanumerical order
445 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
448 current->next = cvar;
453 // link to head of list in this hash table index
454 hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
455 cvar->nextonhashchain = cvar_hashtable[hashindex];
456 cvar_hashtable[hashindex] = cvar;
466 Handles variable inspection and changing from the console
469 qboolean Cvar_Command (void)
474 v = Cvar_FindVar (Cmd_Argv(0));
478 // perform a variable print or set
481 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
485 if (developer.integer >= 100)
486 Con_DPrint("Cvar_Command: ");
488 if (v->flags & CVAR_READONLY)
490 Con_Printf("%s is read-only\n", v->name);
493 Cvar_Set (v->name, Cmd_Argv(1));
494 if (developer.integer >= 100)
500 void Cvar_LockDefaults_f (void)
503 // lock in the default values of all cvars
504 for (var = cvar_vars ; var ; var = var->next)
506 if (!(var->flags & CVAR_DEFAULTSET))
508 //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
509 var->flags |= CVAR_DEFAULTSET;
510 Z_Free(var->defstring);
511 var->defstring = (char *)Z_Malloc(strlen(var->string) + 1);
512 strcpy(var->defstring, var->string);
518 void Cvar_ResetToDefaults_All_f (void)
521 // restore the default values of all cvars
522 for (var = cvar_vars ; var ; var = var->next)
523 Cvar_SetQuick(var, var->defstring);
527 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
530 // restore the default values of all cvars
531 for (var = cvar_vars ; var ; var = var->next)
532 if (!(var->flags & CVAR_SAVE))
533 Cvar_SetQuick(var, var->defstring);
537 void Cvar_ResetToDefaults_SaveOnly_f (void)
540 // restore the default values of all cvars
541 for (var = cvar_vars ; var ; var = var->next)
542 if (var->flags & CVAR_SAVE)
543 Cvar_SetQuick(var, var->defstring);
551 Writes lines containing "set variable value" for all variables
552 with the archive flag set to true.
555 void Cvar_WriteVariables (qfile_t *f)
559 // don't save cvars that match their default value
560 for (var = cvar_vars ; var ; var = var->next)
561 if (var->flags & CVAR_SAVE && strcmp(var->string, var->defstring))
562 FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
566 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
567 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
573 void Cvar_List_f (void)
582 partial = Cmd_Argv (1);
583 len = strlen(partial);
592 for (cvar = cvar_vars; cvar; cvar = cvar->next)
594 if (partial && strncasecmp (partial,cvar->name,len))
597 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
602 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
604 Con_Printf("%i cvar(s)\n", count);
606 // 2000-01-09 CvarList command by Maddes
608 void Cvar_Set_f (void)
612 // make sure it's the right number of parameters
615 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
619 // check if it's read-only
620 cvar = Cvar_FindVar(Cmd_Argv(1));
621 if (cvar && cvar->flags & CVAR_READONLY)
623 Con_Printf("Set: %s is read-only\n", cvar->name);
629 // all looks ok, create/modify the cvar
630 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
633 void Cvar_SetA_f (void)
637 // make sure it's the right number of parameters
640 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
644 // check if it's read-only
645 cvar = Cvar_FindVar(Cmd_Argv(1));
646 if (cvar && cvar->flags & CVAR_READONLY)
648 Con_Printf("SetA: %s is read-only\n", cvar->name);
652 Con_DPrint("SetA: ");
654 // all looks ok, create/modify the cvar
655 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);