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);
253 else if ((var->flags & CVAR_NQUSERINFOHACK) && cls.state != ca_dedicated)
255 // update the cls.userinfo to have proper values for the
256 // silly nq config variables.
258 // this is done when these variables are changed rather than at
259 // connect time because if the user or code checks the userinfo and it
260 // holds weird values it may cause confusion...
261 if (!strcmp(var->name, "_cl_color"))
263 int top = (var->integer >> 4) & 15, bottom = var->integer & 15;
264 CL_SetInfo("topcolor", va("%i", top), true, false, false, false);
265 CL_SetInfo("bottomcolor", va("%i", bottom), true, false, false, false);
266 if (cls.protocol != PROTOCOL_QUAKEWORLD && cls.netcon)
268 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
269 MSG_WriteString(&cls.netcon->message, va("color %i %i", top, bottom));
272 else if (!strcmp(var->name, "_cl_rate"))
273 CL_SetInfo("rate", va("%i", var->integer), true, false, false, false);
274 else if (!strcmp(var->name, "_cl_playerskin"))
275 CL_SetInfo("playerskin", var->string, true, false, false, false);
276 else if (!strcmp(var->name, "_cl_playermodel"))
277 CL_SetInfo("playermodel", var->string, true, false, false, false);
278 else if (!strcmp(var->name, "_cl_name"))
279 CL_SetInfo("name", var->string, true, false, false, false);
283 void Cvar_SetQuick (cvar_t *var, const char *value)
287 Con_Print("Cvar_SetQuick: var == NULL\n");
291 if (developer.integer >= 100)
292 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
294 Cvar_SetQuick_Internal(var, value);
297 void Cvar_Set (const char *var_name, const char *value)
300 var = Cvar_FindVar (var_name);
303 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
306 Cvar_SetQuick(var, value);
314 void Cvar_SetValueQuick(cvar_t *var, float value)
316 char val[MAX_INPUTLINE];
318 if ((float)((int)value) == value)
319 sprintf(val, "%i", (int)value);
321 sprintf(val, "%f", value);
322 Cvar_SetQuick(var, val);
325 void Cvar_SetValue(const char *var_name, float value)
327 char val[MAX_INPUTLINE];
329 if ((float)((int)value) == value)
330 sprintf(val, "%i", (int)value);
332 sprintf(val, "%f", value);
333 Cvar_Set(var_name, val);
338 Cvar_RegisterVariable
340 Adds a freestanding variable to the variable list.
343 void Cvar_RegisterVariable (cvar_t *variable)
346 cvar_t *current, *next, *cvar;
350 if (developer.integer >= 100)
351 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
353 // first check to see if it has already been defined
354 cvar = Cvar_FindVar (variable->name);
357 if (cvar->flags & CVAR_ALLOCATED)
359 if (developer.integer >= 100)
360 Con_Printf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
361 // fixed variables replace allocated ones
362 // (because the engine directly accesses fixed variables)
363 // NOTE: this isn't actually used currently
364 // (all cvars are registered before config parsing)
365 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
366 // cvar->string is now owned by variable instead
367 variable->string = cvar->string;
368 variable->defstring = cvar->defstring;
369 variable->value = atof (variable->string);
370 variable->integer = (int) variable->value;
371 // replace cvar with this one...
372 variable->next = cvar->next;
373 if (cvar_vars == cvar)
375 // head of the list is easy to change
376 cvar_vars = variable;
380 // otherwise find it somewhere in the list
381 for (current = cvar_vars;current->next != cvar;current = current->next)
383 current->next = variable;
386 // get rid of old allocated cvar
387 // (but not cvar->string and cvar->defstring, because we kept those)
392 Con_Printf("Can't register variable %s, already defined\n", variable->name);
396 // check for overlap with a command
397 if (Cmd_Exists (variable->name))
399 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
403 // copy the value off, because future sets will Z_Free it
404 oldstr = variable->string;
405 alloclen = strlen(variable->string) + 1;
406 variable->string = (char *)Z_Malloc (alloclen);
407 memcpy (variable->string, oldstr, alloclen);
408 variable->defstring = (char *)Z_Malloc (alloclen);
409 memcpy (variable->defstring, oldstr, alloclen);
410 variable->value = atof (variable->string);
411 variable->integer = (int) variable->value;
413 // link the variable in
414 // alphanumerical order
415 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
418 current->next = variable;
420 cvar_vars = variable;
422 variable->next = next;
424 // link to head of list in this hash table index
425 hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
426 variable->nextonhashchain = cvar_hashtable[hashindex];
427 cvar_hashtable[hashindex] = variable;
434 Adds a newly allocated variable to the variable list or sets its value.
437 cvar_t *Cvar_Get (const char *name, const char *value, int flags)
440 cvar_t *current, *next, *cvar;
443 if (developer.integer >= 100)
444 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
446 // first check to see if it has already been defined
447 cvar = Cvar_FindVar (name);
450 cvar->flags |= flags;
451 Cvar_SetQuick_Internal (cvar, value);
455 // check for overlap with a command
456 if (Cmd_Exists (name))
458 Con_Printf("Cvar_Get: %s is a command\n", name);
462 // allocate a new cvar, cvar name, and cvar string
463 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
464 // FIXME: these never get Z_Free'd
465 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
466 cvar->flags = flags | CVAR_ALLOCATED;
467 alloclen = strlen(name) + 1;
468 cvar->name = (char *)Z_Malloc(alloclen);
469 memcpy(cvar->name, name, alloclen);
470 alloclen = strlen(value) + 1;
471 cvar->string = (char *)Z_Malloc(alloclen);
472 memcpy(cvar->string, value, alloclen);
473 cvar->defstring = (char *)Z_Malloc(alloclen);
474 memcpy(cvar->defstring, value, alloclen);
475 cvar->value = atof (cvar->string);
476 cvar->integer = (int) cvar->value;
477 cvar->description = "custom cvar"; // actually checked by VM_cvar_type
479 // link the variable in
480 // alphanumerical order
481 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
484 current->next = cvar;
489 // link to head of list in this hash table index
490 hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
491 cvar->nextonhashchain = cvar_hashtable[hashindex];
492 cvar_hashtable[hashindex] = cvar;
502 Handles variable inspection and changing from the console
505 qboolean Cvar_Command (void)
510 v = Cvar_FindVar (Cmd_Argv(0));
514 // perform a variable print or set
517 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
521 if (developer.integer >= 100)
522 Con_DPrint("Cvar_Command: ");
524 if (v->flags & CVAR_READONLY)
526 Con_Printf("%s is read-only\n", v->name);
529 Cvar_Set (v->name, Cmd_Argv(1));
530 if (developer.integer >= 100)
536 void Cvar_UnlockDefaults (void)
539 // unlock the default values of all cvars
540 for (var = cvar_vars ; var ; var = var->next)
541 var->flags &= ~CVAR_DEFAULTSET;
545 void Cvar_LockDefaults_f (void)
548 // lock in the default values of all cvars
549 for (var = cvar_vars ; var ; var = var->next)
551 if (!(var->flags & CVAR_DEFAULTSET))
555 //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
556 var->flags |= CVAR_DEFAULTSET;
557 Z_Free(var->defstring);
558 alloclen = strlen(var->string) + 1;
559 var->defstring = (char *)Z_Malloc(alloclen);
560 memcpy(var->defstring, var->string, alloclen);
566 void Cvar_ResetToDefaults_All_f (void)
569 // restore the default values of all cvars
570 for (var = cvar_vars ; var ; var = var->next)
571 Cvar_SetQuick(var, var->defstring);
575 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
578 // restore the default values of all cvars
579 for (var = cvar_vars ; var ; var = var->next)
580 if (!(var->flags & CVAR_SAVE))
581 Cvar_SetQuick(var, var->defstring);
585 void Cvar_ResetToDefaults_SaveOnly_f (void)
588 // restore the default values of all cvars
589 for (var = cvar_vars ; var ; var = var->next)
590 if (var->flags & CVAR_SAVE)
591 Cvar_SetQuick(var, var->defstring);
599 Writes lines containing "set variable value" for all variables
600 with the archive flag set to true.
603 void Cvar_WriteVariables (qfile_t *f)
607 // don't save cvars that match their default value
608 for (var = cvar_vars ; var ; var = var->next)
609 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || (var->flags & CVAR_ALLOCATED)))
610 FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
614 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
615 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
621 void Cvar_List_f (void)
630 partial = Cmd_Argv (1);
631 len = strlen(partial);
640 for (cvar = cvar_vars; cvar; cvar = cvar->next)
642 if (partial && strncasecmp (partial,cvar->name,len))
645 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
650 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
652 Con_Printf("%i cvar(s)\n", count);
654 // 2000-01-09 CvarList command by Maddes
656 void Cvar_Set_f (void)
660 // make sure it's the right number of parameters
663 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
667 // check if it's read-only
668 cvar = Cvar_FindVar(Cmd_Argv(1));
669 if (cvar && cvar->flags & CVAR_READONLY)
671 Con_Printf("Set: %s is read-only\n", cvar->name);
675 if (developer.integer >= 100)
678 // all looks ok, create/modify the cvar
679 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
682 void Cvar_SetA_f (void)
686 // make sure it's the right number of parameters
689 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
693 // check if it's read-only
694 cvar = Cvar_FindVar(Cmd_Argv(1));
695 if (cvar && cvar->flags & CVAR_READONLY)
697 Con_Printf("SetA: %s is read-only\n", cvar->name);
701 if (developer.integer >= 100)
702 Con_DPrint("SetA: ");
704 // all looks ok, create/modify the cvar
705 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);