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)
220 changed = strcmp(var->string, value);
221 // LordHavoc: don't reallocate when there is no change
225 // LordHavoc: don't reallocate when the buffer is the same size
226 valuelen = strlen(value);
227 if (!var->string || strlen(var->string) != valuelen)
229 Z_Free (var->string); // free the old value string
231 var->string = (char *)Z_Malloc (valuelen + 1);
233 memcpy (var->string, value, valuelen + 1);
234 var->value = atof (var->string);
235 var->integer = (int) var->value;
236 if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
237 SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
239 // TODO: add infostring support to the server?
240 if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
242 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
245 MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
246 MSG_WriteString (&sv.reliable_datagram, var->name);
247 MSG_WriteString (&sv.reliable_datagram, var->string);
251 if ((var->flags & CVAR_USERINFO) && cls.state != ca_dedicated)
252 CL_SetInfo(var->name, var->string, true, false, false, false);
255 void Cvar_SetQuick (cvar_t *var, const char *value)
259 Con_Print("Cvar_SetQuick: var == NULL\n");
263 if (developer.integer >= 100)
264 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
266 Cvar_SetQuick_Internal(var, value);
269 void Cvar_Set (const char *var_name, const char *value)
272 var = Cvar_FindVar (var_name);
275 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
278 Cvar_SetQuick(var, value);
286 void Cvar_SetValueQuick(cvar_t *var, float value)
288 char val[MAX_INPUTLINE];
290 if ((float)((int)value) == value)
291 sprintf(val, "%i", (int)value);
293 sprintf(val, "%f", value);
294 Cvar_SetQuick(var, val);
297 void Cvar_SetValue(const char *var_name, float value)
299 char val[MAX_INPUTLINE];
301 if ((float)((int)value) == value)
302 sprintf(val, "%i", (int)value);
304 sprintf(val, "%f", value);
305 Cvar_Set(var_name, val);
310 Cvar_RegisterVariable
312 Adds a freestanding variable to the variable list.
315 void Cvar_RegisterVariable (cvar_t *variable)
318 cvar_t *current, *next, *cvar;
322 if (developer.integer >= 100)
323 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
325 // first check to see if it has already been defined
326 cvar = Cvar_FindVar (variable->name);
329 if (cvar->flags & CVAR_ALLOCATED)
331 if (developer.integer >= 100)
332 Con_Printf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
333 // fixed variables replace allocated ones
334 // (because the engine directly accesses fixed variables)
335 // NOTE: this isn't actually used currently
336 // (all cvars are registered before config parsing)
337 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
338 // cvar->string is now owned by variable instead
339 variable->string = cvar->string;
340 variable->defstring = cvar->defstring;
341 variable->value = atof (variable->string);
342 variable->integer = (int) variable->value;
343 // replace cvar with this one...
344 variable->next = cvar->next;
345 if (cvar_vars == cvar)
347 // head of the list is easy to change
348 cvar_vars = variable;
352 // otherwise find it somewhere in the list
353 for (current = cvar_vars;current->next != cvar;current = current->next)
355 current->next = variable;
358 // get rid of old allocated cvar
359 // (but not cvar->string and cvar->defstring, because we kept those)
364 Con_Printf("Can't register variable %s, already defined\n", variable->name);
368 // check for overlap with a command
369 if (Cmd_Exists (variable->name))
371 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
375 // copy the value off, because future sets will Z_Free it
376 oldstr = variable->string;
377 alloclen = strlen(variable->string) + 1;
378 variable->string = (char *)Z_Malloc (alloclen);
379 memcpy (variable->string, oldstr, alloclen);
380 variable->defstring = (char *)Z_Malloc (alloclen);
381 memcpy (variable->defstring, oldstr, alloclen);
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;
415 if (developer.integer >= 100)
416 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
418 // first check to see if it has already been defined
419 cvar = Cvar_FindVar (name);
422 cvar->flags |= flags;
423 Cvar_SetQuick_Internal (cvar, value);
427 // check for overlap with a command
428 if (Cmd_Exists (name))
430 Con_Printf("Cvar_Get: %s is a command\n", name);
434 // allocate a new cvar, cvar name, and cvar string
435 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
436 // FIXME: these never get Z_Free'd
437 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
438 cvar->flags = flags | CVAR_ALLOCATED;
439 alloclen = strlen(name) + 1;
440 cvar->name = (char *)Z_Malloc(alloclen);
441 memcpy(cvar->name, name, alloclen);
442 alloclen = strlen(value) + 1;
443 cvar->string = (char *)Z_Malloc(alloclen);
444 memcpy(cvar->string, value, alloclen);
445 cvar->defstring = (char *)Z_Malloc(alloclen);
446 memcpy(cvar->defstring, value, alloclen);
447 cvar->value = atof (cvar->string);
448 cvar->integer = (int) cvar->value;
449 cvar->description = "custom cvar";
451 // link the variable in
452 // alphanumerical order
453 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
456 current->next = cvar;
461 // link to head of list in this hash table index
462 hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
463 cvar->nextonhashchain = cvar_hashtable[hashindex];
464 cvar_hashtable[hashindex] = cvar;
474 Handles variable inspection and changing from the console
477 qboolean Cvar_Command (void)
482 v = Cvar_FindVar (Cmd_Argv(0));
486 // perform a variable print or set
489 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
493 if (developer.integer >= 100)
494 Con_DPrint("Cvar_Command: ");
496 if (v->flags & CVAR_READONLY)
498 Con_Printf("%s is read-only\n", v->name);
501 Cvar_Set (v->name, Cmd_Argv(1));
502 if (developer.integer >= 100)
508 void Cvar_UnlockDefaults (void)
511 // unlock the default values of all cvars
512 for (var = cvar_vars ; var ; var = var->next)
513 var->flags &= ~CVAR_DEFAULTSET;
517 void Cvar_LockDefaults_f (void)
520 // lock in the default values of all cvars
521 for (var = cvar_vars ; var ; var = var->next)
523 if (!(var->flags & CVAR_DEFAULTSET))
527 //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
528 var->flags |= CVAR_DEFAULTSET;
529 Z_Free(var->defstring);
530 alloclen = strlen(var->string) + 1;
531 var->defstring = (char *)Z_Malloc(alloclen);
532 memcpy(var->defstring, var->string, alloclen);
538 void Cvar_ResetToDefaults_All_f (void)
541 // restore the default values of all cvars
542 for (var = cvar_vars ; var ; var = var->next)
543 Cvar_SetQuick(var, var->defstring);
547 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
550 // restore the default values of all cvars
551 for (var = cvar_vars ; var ; var = var->next)
552 if (!(var->flags & CVAR_SAVE))
553 Cvar_SetQuick(var, var->defstring);
557 void Cvar_ResetToDefaults_SaveOnly_f (void)
560 // restore the default values of all cvars
561 for (var = cvar_vars ; var ; var = var->next)
562 if (var->flags & CVAR_SAVE)
563 Cvar_SetQuick(var, var->defstring);
571 Writes lines containing "set variable value" for all variables
572 with the archive flag set to true.
575 void Cvar_WriteVariables (qfile_t *f)
579 // don't save cvars that match their default value
580 for (var = cvar_vars ; var ; var = var->next)
581 if (var->flags & CVAR_SAVE && strcmp(var->string, var->defstring))
582 FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
586 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
587 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
593 void Cvar_List_f (void)
602 partial = Cmd_Argv (1);
603 len = strlen(partial);
612 for (cvar = cvar_vars; cvar; cvar = cvar->next)
614 if (partial && strncasecmp (partial,cvar->name,len))
617 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
622 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
624 Con_Printf("%i cvar(s)\n", count);
626 // 2000-01-09 CvarList command by Maddes
628 void Cvar_Set_f (void)
632 // make sure it's the right number of parameters
635 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
639 // check if it's read-only
640 cvar = Cvar_FindVar(Cmd_Argv(1));
641 if (cvar && cvar->flags & CVAR_READONLY)
643 Con_Printf("Set: %s is read-only\n", cvar->name);
649 // all looks ok, create/modify the cvar
650 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
653 void Cvar_SetA_f (void)
657 // make sure it's the right number of parameters
660 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
664 // check if it's read-only
665 cvar = Cvar_FindVar(Cmd_Argv(1));
666 if (cvar && cvar->flags & CVAR_READONLY)
668 Con_Printf("SetA: %s is read-only\n", cvar->name);
672 Con_DPrint("SetA: ");
674 // all looks ok, create/modify the cvar
675 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);