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 char *cvar_dummy_description = "custom cvar";
26 cvar_t *cvar_vars = NULL;
27 cvar_t *cvar_hashtable[65536];
28 char *cvar_null_string = "";
35 cvar_t *Cvar_FindVar (const char *var_name)
40 // use hash lookup to minimize search time
41 hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name));
42 for (var = cvar_hashtable[hashindex];var;var = var->nextonhashchain)
43 if (!strcmp (var_name, var->name))
49 cvar_t *Cvar_FindVarAfter (const char *prev_var_name, int neededflags)
55 var = Cvar_FindVar (prev_var_name);
63 // search for the next cvar matching the needed flags
66 if ((var->flags & neededflags) || !neededflags)
78 float Cvar_VariableValue (const char *var_name)
82 var = Cvar_FindVar (var_name);
85 return atof (var->string);
94 const char *Cvar_VariableString (const char *var_name)
98 var = Cvar_FindVar (var_name);
100 return cvar_null_string;
106 Cvar_VariableDefString
109 const char *Cvar_VariableDefString (const char *var_name)
113 var = Cvar_FindVar (var_name);
115 return cvar_null_string;
116 return var->defstring;
121 Cvar_VariableDescription
124 const char *Cvar_VariableDescription (const char *var_name)
128 var = Cvar_FindVar (var_name);
130 return cvar_null_string;
131 return var->description;
137 Cvar_CompleteVariable
140 const char *Cvar_CompleteVariable (const char *partial)
145 len = strlen(partial);
151 for (cvar=cvar_vars ; cvar ; cvar=cvar->next)
152 if (!strncasecmp (partial,cvar->name, len))
160 CVar_CompleteCountPossible
162 New function for tab-completion system
164 Thanks to Fett erich@heintz.com
167 int Cvar_CompleteCountPossible (const char *partial)
174 len = strlen(partial);
179 // Loop through the cvars and count all possible matches
180 for (cvar = cvar_vars; cvar; cvar = cvar->next)
181 if (!strncasecmp(partial, cvar->name, len))
188 CVar_CompleteBuildList
190 New function for tab-completion system
192 Thanks to Fett erich@heintz.com
196 const char **Cvar_CompleteBuildList (const char *partial)
201 size_t sizeofbuf = (Cvar_CompleteCountPossible (partial) + 1) * sizeof (const char *);
204 len = strlen(partial);
205 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
206 // Loop through the alias list and print all matches
207 for (cvar = cvar_vars; cvar; cvar = cvar->next)
208 if (!strncasecmp(partial, cvar->name, len))
209 buf[bpos++] = cvar->name;
215 // written by LordHavoc
216 void Cvar_CompleteCvarPrint (const char *partial)
219 size_t len = strlen(partial);
220 // Loop through the command list and print all matches
221 for (cvar = cvar_vars; cvar; cvar = cvar->next)
222 if (!strncasecmp(partial, cvar->name, len))
223 Con_Printf ("%c3%s%s : \"%s\" (\"%s\") : %s\n", STRING_COLOR_TAG, cvar->name, STRING_COLOR_DEFAULT_STR, cvar->string, cvar->defstring, cvar->description);
232 void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
237 changed = strcmp(var->string, value);
238 // LordHavoc: don't reallocate when there is no change
242 // LordHavoc: don't reallocate when the buffer is the same size
243 valuelen = strlen(value);
244 if (!var->string || strlen(var->string) != valuelen)
246 Z_Free (var->string); // free the old value string
248 var->string = (char *)Z_Malloc (valuelen + 1);
250 memcpy (var->string, value, valuelen + 1);
251 var->value = atof (var->string);
252 var->integer = (int) var->value;
253 if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
254 SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
256 // TODO: add infostring support to the server?
257 if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
259 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
262 MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
263 MSG_WriteString (&sv.reliable_datagram, var->name);
264 MSG_WriteString (&sv.reliable_datagram, var->string);
268 if ((var->flags & CVAR_USERINFO) && cls.state != ca_dedicated)
269 CL_SetInfo(var->name, var->string, true, false, false, false);
270 else if ((var->flags & CVAR_NQUSERINFOHACK) && cls.state != ca_dedicated)
272 // update the cls.userinfo to have proper values for the
273 // silly nq config variables.
275 // this is done when these variables are changed rather than at
276 // connect time because if the user or code checks the userinfo and it
277 // holds weird values it may cause confusion...
278 if (!strcmp(var->name, "_cl_color"))
280 int top = (var->integer >> 4) & 15, bottom = var->integer & 15;
281 CL_SetInfo("topcolor", va("%i", top), true, false, false, false);
282 CL_SetInfo("bottomcolor", va("%i", bottom), true, false, false, false);
283 if (cls.protocol != PROTOCOL_QUAKEWORLD && cls.netcon)
285 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
286 MSG_WriteString(&cls.netcon->message, va("color %i %i", top, bottom));
289 else if (!strcmp(var->name, "_cl_rate"))
290 CL_SetInfo("rate", va("%i", var->integer), true, false, false, false);
291 else if (!strcmp(var->name, "_cl_playerskin"))
292 CL_SetInfo("playerskin", var->string, true, false, false, false);
293 else if (!strcmp(var->name, "_cl_playermodel"))
294 CL_SetInfo("playermodel", var->string, true, false, false, false);
295 else if (!strcmp(var->name, "_cl_name"))
296 CL_SetInfo("name", var->string, true, false, false, false);
297 else if (!strcmp(var->name, "rcon_secure"))
299 // whenever rcon_secure is changed to 0, clear rcon_password for
300 // security reasons (prevents a send-rcon-password-as-plaintext
301 // attack based on NQ protocol session takeover and svc_stufftext)
303 Cvar_Set("rcon_password", "");
308 void Cvar_SetQuick (cvar_t *var, const char *value)
312 Con_Print("Cvar_SetQuick: var == NULL\n");
316 if (developer.integer >= 100)
317 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
319 Cvar_SetQuick_Internal(var, value);
322 void Cvar_Set (const char *var_name, const char *value)
325 var = Cvar_FindVar (var_name);
328 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
331 Cvar_SetQuick(var, value);
339 void Cvar_SetValueQuick(cvar_t *var, float value)
341 char val[MAX_INPUTLINE];
343 if ((float)((int)value) == value)
344 dpsnprintf(val, sizeof(val), "%i", (int)value);
346 dpsnprintf(val, sizeof(val), "%f", value);
347 Cvar_SetQuick(var, val);
350 void Cvar_SetValue(const char *var_name, float value)
352 char val[MAX_INPUTLINE];
354 if ((float)((int)value) == value)
355 dpsnprintf(val, sizeof(val), "%i", (int)value);
357 dpsnprintf(val, sizeof(val), "%f", value);
358 Cvar_Set(var_name, val);
363 Cvar_RegisterVariable
365 Adds a freestanding variable to the variable list.
368 void Cvar_RegisterVariable (cvar_t *variable)
371 cvar_t *current, *next, *cvar;
375 if (developer.integer >= 100)
376 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
378 // first check to see if it has already been defined
379 cvar = Cvar_FindVar (variable->name);
382 if (cvar->flags & CVAR_ALLOCATED)
384 if (developer.integer >= 100)
385 Con_Printf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
386 // fixed variables replace allocated ones
387 // (because the engine directly accesses fixed variables)
388 // NOTE: this isn't actually used currently
389 // (all cvars are registered before config parsing)
390 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
391 // cvar->string is now owned by variable instead
392 variable->string = cvar->string;
393 variable->defstring = cvar->defstring;
394 variable->value = atof (variable->string);
395 variable->integer = (int) variable->value;
396 // replace cvar with this one...
397 variable->next = cvar->next;
398 if (cvar_vars == cvar)
400 // head of the list is easy to change
401 cvar_vars = variable;
405 // otherwise find it somewhere in the list
406 for (current = cvar_vars;current->next != cvar;current = current->next)
408 current->next = variable;
411 // get rid of old allocated cvar
412 // (but not cvar->string and cvar->defstring, because we kept those)
417 Con_Printf("Can't register variable %s, already defined\n", variable->name);
421 // check for overlap with a command
422 if (Cmd_Exists (variable->name))
424 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
428 // copy the value off, because future sets will Z_Free it
429 oldstr = variable->string;
430 alloclen = strlen(variable->string) + 1;
431 variable->string = (char *)Z_Malloc (alloclen);
432 memcpy (variable->string, oldstr, alloclen);
433 variable->defstring = (char *)Z_Malloc (alloclen);
434 memcpy (variable->defstring, oldstr, alloclen);
435 variable->value = atof (variable->string);
436 variable->integer = (int) variable->value;
438 // link the variable in
439 // alphanumerical order
440 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
443 current->next = variable;
445 cvar_vars = variable;
447 variable->next = next;
449 // link to head of list in this hash table index
450 hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
451 variable->nextonhashchain = cvar_hashtable[hashindex];
452 cvar_hashtable[hashindex] = variable;
459 Adds a newly allocated variable to the variable list or sets its value.
462 cvar_t *Cvar_Get (const char *name, const char *value, int flags, const char *newdescription)
465 cvar_t *current, *next, *cvar;
468 if (developer.integer >= 100)
469 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
471 // first check to see if it has already been defined
472 cvar = Cvar_FindVar (name);
475 cvar->flags |= flags;
476 Cvar_SetQuick_Internal (cvar, value);
477 if(newdescription && (cvar->flags & CVAR_ALLOCATED))
479 if(cvar->description != cvar_dummy_description)
480 Z_Free(cvar->description);
484 alloclen = strlen(newdescription) + 1;
485 cvar->description = (char *)Z_Malloc(alloclen);
486 memcpy(cvar->description, newdescription, alloclen);
489 cvar->description = cvar_dummy_description;
494 // check for overlap with a command
495 if (Cmd_Exists (name))
497 Con_Printf("Cvar_Get: %s is a command\n", name);
501 // allocate a new cvar, cvar name, and cvar string
502 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
503 // FIXME: these never get Z_Free'd
504 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
505 cvar->flags = flags | CVAR_ALLOCATED;
506 alloclen = strlen(name) + 1;
507 cvar->name = (char *)Z_Malloc(alloclen);
508 memcpy(cvar->name, name, alloclen);
509 alloclen = strlen(value) + 1;
510 cvar->string = (char *)Z_Malloc(alloclen);
511 memcpy(cvar->string, value, alloclen);
512 cvar->defstring = (char *)Z_Malloc(alloclen);
513 memcpy(cvar->defstring, value, alloclen);
514 cvar->value = atof (cvar->string);
515 cvar->integer = (int) cvar->value;
517 if(newdescription && *newdescription)
519 alloclen = strlen(newdescription) + 1;
520 cvar->description = (char *)Z_Malloc(alloclen);
521 memcpy(cvar->description, newdescription, alloclen);
524 cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
526 // link the variable in
527 // alphanumerical order
528 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
531 current->next = cvar;
536 // link to head of list in this hash table index
537 hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
538 cvar->nextonhashchain = cvar_hashtable[hashindex];
539 cvar_hashtable[hashindex] = cvar;
549 Handles variable inspection and changing from the console
552 qboolean Cvar_Command (void)
557 v = Cvar_FindVar (Cmd_Argv(0));
561 // perform a variable print or set
564 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
568 if (developer.integer >= 100)
569 Con_DPrint("Cvar_Command: ");
571 if (v->flags & CVAR_READONLY)
573 Con_Printf("%s is read-only\n", v->name);
576 Cvar_Set (v->name, Cmd_Argv(1));
577 if (developer.integer >= 100)
583 void Cvar_UnlockDefaults (void)
586 // unlock the default values of all cvars
587 for (var = cvar_vars ; var ; var = var->next)
588 var->flags &= ~CVAR_DEFAULTSET;
592 void Cvar_LockDefaults_f (void)
595 // lock in the default values of all cvars
596 for (var = cvar_vars ; var ; var = var->next)
598 if (!(var->flags & CVAR_DEFAULTSET))
602 //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
603 var->flags |= CVAR_DEFAULTSET;
604 Z_Free(var->defstring);
605 alloclen = strlen(var->string) + 1;
606 var->defstring = (char *)Z_Malloc(alloclen);
607 memcpy(var->defstring, var->string, alloclen);
613 void Cvar_ResetToDefaults_All_f (void)
616 // restore the default values of all cvars
617 for (var = cvar_vars ; var ; var = var->next)
618 Cvar_SetQuick(var, var->defstring);
622 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
625 // restore the default values of all cvars
626 for (var = cvar_vars ; var ; var = var->next)
627 if (!(var->flags & CVAR_SAVE))
628 Cvar_SetQuick(var, var->defstring);
632 void Cvar_ResetToDefaults_SaveOnly_f (void)
635 // restore the default values of all cvars
636 for (var = cvar_vars ; var ; var = var->next)
637 if (var->flags & CVAR_SAVE)
638 Cvar_SetQuick(var, var->defstring);
646 Writes lines containing "set variable value" for all variables
647 with the archive flag set to true.
650 void Cvar_WriteVariables (qfile_t *f)
654 // don't save cvars that match their default value
655 for (var = cvar_vars ; var ; var = var->next)
656 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || (var->flags & CVAR_ALLOCATED)))
657 FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
661 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
662 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
668 void Cvar_List_f (void)
678 partial = Cmd_Argv (1);
679 len = strlen(partial);
687 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
690 for (cvar = cvar_vars; cvar; cvar = cvar->next)
692 if (len && (ispattern ? !matchpattern_with_separator(cvar->name, partial, false, "", false) : strncmp (partial,cvar->name,len)))
695 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
702 Con_Printf("%i cvar(s) matching \"%s\"\n", count, partial);
704 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
707 Con_Printf("%i cvar(s)\n", count);
709 // 2000-01-09 CvarList command by Maddes
711 void Cvar_Set_f (void)
715 // make sure it's the right number of parameters
718 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
722 // check if it's read-only
723 cvar = Cvar_FindVar(Cmd_Argv(1));
724 if (cvar && cvar->flags & CVAR_READONLY)
726 Con_Printf("Set: %s is read-only\n", cvar->name);
730 if (developer.integer >= 100)
733 // all looks ok, create/modify the cvar
734 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);
737 void Cvar_SetA_f (void)
741 // make sure it's the right number of parameters
744 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
748 // check if it's read-only
749 cvar = Cvar_FindVar(Cmd_Argv(1));
750 if (cvar && cvar->flags & CVAR_READONLY)
752 Con_Printf("SetA: %s is read-only\n", cvar->name);
756 if (developer.integer >= 100)
757 Con_DPrint("SetA: ");
759 // all looks ok, create/modify the cvar
760 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);