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, 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)
302 Cvar_Set("rcon_password", "");
307 void Cvar_SetQuick (cvar_t *var, const char *value)
311 Con_Print("Cvar_SetQuick: var == NULL\n");
315 if (developer.integer >= 100)
316 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
318 Cvar_SetQuick_Internal(var, value);
321 void Cvar_Set (const char *var_name, const char *value)
324 var = Cvar_FindVar (var_name);
327 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
330 Cvar_SetQuick(var, value);
338 void Cvar_SetValueQuick(cvar_t *var, float value)
340 char val[MAX_INPUTLINE];
342 if ((float)((int)value) == value)
343 dpsnprintf(val, sizeof(val), "%i", (int)value);
345 dpsnprintf(val, sizeof(val), "%f", value);
346 Cvar_SetQuick(var, val);
349 void Cvar_SetValue(const char *var_name, float value)
351 char val[MAX_INPUTLINE];
353 if ((float)((int)value) == value)
354 dpsnprintf(val, sizeof(val), "%i", (int)value);
356 dpsnprintf(val, sizeof(val), "%f", value);
357 Cvar_Set(var_name, val);
362 Cvar_RegisterVariable
364 Adds a freestanding variable to the variable list.
367 void Cvar_RegisterVariable (cvar_t *variable)
370 cvar_t *current, *next, *cvar;
374 if (developer.integer >= 100)
375 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
377 // first check to see if it has already been defined
378 cvar = Cvar_FindVar (variable->name);
381 if (cvar->flags & CVAR_ALLOCATED)
383 if (developer.integer >= 100)
384 Con_Printf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
385 // fixed variables replace allocated ones
386 // (because the engine directly accesses fixed variables)
387 // NOTE: this isn't actually used currently
388 // (all cvars are registered before config parsing)
389 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
390 // cvar->string is now owned by variable instead
391 variable->string = cvar->string;
392 variable->defstring = cvar->defstring;
393 variable->value = atof (variable->string);
394 variable->integer = (int) variable->value;
395 // replace cvar with this one...
396 variable->next = cvar->next;
397 if (cvar_vars == cvar)
399 // head of the list is easy to change
400 cvar_vars = variable;
404 // otherwise find it somewhere in the list
405 for (current = cvar_vars;current->next != cvar;current = current->next)
407 current->next = variable;
410 // get rid of old allocated cvar
411 // (but not cvar->string and cvar->defstring, because we kept those)
416 Con_Printf("Can't register variable %s, already defined\n", variable->name);
420 // check for overlap with a command
421 if (Cmd_Exists (variable->name))
423 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
427 // copy the value off, because future sets will Z_Free it
428 oldstr = variable->string;
429 alloclen = strlen(variable->string) + 1;
430 variable->string = (char *)Z_Malloc (alloclen);
431 memcpy (variable->string, oldstr, alloclen);
432 variable->defstring = (char *)Z_Malloc (alloclen);
433 memcpy (variable->defstring, oldstr, alloclen);
434 variable->value = atof (variable->string);
435 variable->integer = (int) variable->value;
437 // link the variable in
438 // alphanumerical order
439 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
442 current->next = variable;
444 cvar_vars = variable;
446 variable->next = next;
448 // link to head of list in this hash table index
449 hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
450 variable->nextonhashchain = cvar_hashtable[hashindex];
451 cvar_hashtable[hashindex] = variable;
458 Adds a newly allocated variable to the variable list or sets its value.
461 cvar_t *Cvar_Get (const char *name, const char *value, int flags, const char *newdescription)
464 cvar_t *current, *next, *cvar;
467 if (developer.integer >= 100)
468 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
470 // first check to see if it has already been defined
471 cvar = Cvar_FindVar (name);
474 cvar->flags |= flags;
475 Cvar_SetQuick_Internal (cvar, value);
476 if(newdescription && (cvar->flags & CVAR_ALLOCATED))
478 if(cvar->description != cvar_dummy_description)
479 Z_Free(cvar->description);
483 alloclen = strlen(newdescription) + 1;
484 cvar->description = (char *)Z_Malloc(alloclen);
485 memcpy(cvar->description, newdescription, alloclen);
488 cvar->description = cvar_dummy_description;
493 // check for overlap with a command
494 if (Cmd_Exists (name))
496 Con_Printf("Cvar_Get: %s is a command\n", name);
500 // allocate a new cvar, cvar name, and cvar string
501 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
502 // FIXME: these never get Z_Free'd
503 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
504 cvar->flags = flags | CVAR_ALLOCATED;
505 alloclen = strlen(name) + 1;
506 cvar->name = (char *)Z_Malloc(alloclen);
507 memcpy(cvar->name, name, alloclen);
508 alloclen = strlen(value) + 1;
509 cvar->string = (char *)Z_Malloc(alloclen);
510 memcpy(cvar->string, value, alloclen);
511 cvar->defstring = (char *)Z_Malloc(alloclen);
512 memcpy(cvar->defstring, value, alloclen);
513 cvar->value = atof (cvar->string);
514 cvar->integer = (int) cvar->value;
516 if(newdescription && *newdescription)
518 alloclen = strlen(newdescription) + 1;
519 cvar->description = (char *)Z_Malloc(alloclen);
520 memcpy(cvar->description, newdescription, alloclen);
523 cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
525 // link the variable in
526 // alphanumerical order
527 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
530 current->next = cvar;
535 // link to head of list in this hash table index
536 hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
537 cvar->nextonhashchain = cvar_hashtable[hashindex];
538 cvar_hashtable[hashindex] = cvar;
548 Handles variable inspection and changing from the console
551 qboolean Cvar_Command (void)
556 v = Cvar_FindVar (Cmd_Argv(0));
560 // perform a variable print or set
563 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
567 if (developer.integer >= 100)
568 Con_DPrint("Cvar_Command: ");
570 if (v->flags & CVAR_READONLY)
572 Con_Printf("%s is read-only\n", v->name);
575 Cvar_Set (v->name, Cmd_Argv(1));
576 if (developer.integer >= 100)
582 void Cvar_UnlockDefaults (void)
585 // unlock the default values of all cvars
586 for (var = cvar_vars ; var ; var = var->next)
587 var->flags &= ~CVAR_DEFAULTSET;
591 void Cvar_LockDefaults_f (void)
594 // lock in the default values of all cvars
595 for (var = cvar_vars ; var ; var = var->next)
597 if (!(var->flags & CVAR_DEFAULTSET))
601 //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
602 var->flags |= CVAR_DEFAULTSET;
603 Z_Free(var->defstring);
604 alloclen = strlen(var->string) + 1;
605 var->defstring = (char *)Z_Malloc(alloclen);
606 memcpy(var->defstring, var->string, alloclen);
612 void Cvar_ResetToDefaults_All_f (void)
615 // restore the default values of all cvars
616 for (var = cvar_vars ; var ; var = var->next)
617 Cvar_SetQuick(var, var->defstring);
621 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
624 // restore the default values of all cvars
625 for (var = cvar_vars ; var ; var = var->next)
626 if (!(var->flags & CVAR_SAVE))
627 Cvar_SetQuick(var, var->defstring);
631 void Cvar_ResetToDefaults_SaveOnly_f (void)
634 // restore the default values of all cvars
635 for (var = cvar_vars ; var ; var = var->next)
636 if (var->flags & CVAR_SAVE)
637 Cvar_SetQuick(var, var->defstring);
645 Writes lines containing "set variable value" for all variables
646 with the archive flag set to true.
649 void Cvar_WriteVariables (qfile_t *f)
653 // don't save cvars that match their default value
654 for (var = cvar_vars ; var ; var = var->next)
655 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || (var->flags & CVAR_ALLOCATED)))
656 FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
660 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
661 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
667 void Cvar_List_f (void)
677 partial = Cmd_Argv (1);
678 len = strlen(partial);
686 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
689 for (cvar = cvar_vars; cvar; cvar = cvar->next)
691 if (len && (ispattern ? !matchpattern_with_separator(cvar->name, partial, false, "", false) : strncmp (partial,cvar->name,len)))
694 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
701 Con_Printf("%i cvar(s) matching \"%s\"\n", count, partial);
703 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
706 Con_Printf("%i cvar(s)\n", count);
708 // 2000-01-09 CvarList command by Maddes
710 void Cvar_Set_f (void)
714 // make sure it's the right number of parameters
717 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
721 // check if it's read-only
722 cvar = Cvar_FindVar(Cmd_Argv(1));
723 if (cvar && cvar->flags & CVAR_READONLY)
725 Con_Printf("Set: %s is read-only\n", cvar->name);
729 if (developer.integer >= 100)
732 // all looks ok, create/modify the cvar
733 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);
736 void Cvar_SetA_f (void)
740 // make sure it's the right number of parameters
743 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
747 // check if it's read-only
748 cvar = Cvar_FindVar(Cmd_Argv(1));
749 if (cvar && cvar->flags & CVAR_READONLY)
751 Con_Printf("SetA: %s is read-only\n", cvar->name);
755 if (developer.integer >= 100)
756 Con_DPrint("SetA: ");
758 // all looks ok, create/modify the cvar
759 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);