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 const char *cvar_dummy_description = "custom cvar";
26 cvar_t *cvar_vars = NULL;
27 cvar_t *cvar_hashtable[CVAR_HASHSIZE];
28 const 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)) % CVAR_HASHSIZE;
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)
73 cvar_t *Cvar_FindVarLink (const char *var_name, cvar_t **parent, cvar_t ***link, cvar_t **prev_alpha)
78 // use hash lookup to minimize search time
79 hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name));
80 if(parent) *parent = NULL;
81 if(prev_alpha) *prev_alpha = NULL;
82 if(link) *link = &cvar_hashtable[hashindex];
83 for (var = cvar_hashtable[hashindex];var;var = var->nextonhashchain)
85 if (!strcmp (var_name, var->name))
87 if(!prev_alpha || var == cvar_vars)
90 *prev_alpha = cvar_vars;
91 // if prev_alpha happens to become NULL then there has been some inconsistency elsewhere
92 // already - should I still insert '*prev_alpha &&' in the loop?
93 while((*prev_alpha)->next != var)
94 *prev_alpha = (*prev_alpha)->next;
97 if(parent) *parent = var;
108 float Cvar_VariableValue (const char *var_name)
112 var = Cvar_FindVar (var_name);
115 return atof (var->string);
124 const char *Cvar_VariableString (const char *var_name)
128 var = Cvar_FindVar (var_name);
130 return cvar_null_string;
136 Cvar_VariableDefString
139 const char *Cvar_VariableDefString (const char *var_name)
143 var = Cvar_FindVar (var_name);
145 return cvar_null_string;
146 return var->defstring;
151 Cvar_VariableDescription
154 const char *Cvar_VariableDescription (const char *var_name)
158 var = Cvar_FindVar (var_name);
160 return cvar_null_string;
161 return var->description;
167 Cvar_CompleteVariable
170 const char *Cvar_CompleteVariable (const char *partial)
175 len = strlen(partial);
181 for (cvar=cvar_vars ; cvar ; cvar=cvar->next)
182 if (!strncasecmp (partial,cvar->name, len))
190 CVar_CompleteCountPossible
192 New function for tab-completion system
194 Thanks to Fett erich@heintz.com
197 int Cvar_CompleteCountPossible (const char *partial)
204 len = strlen(partial);
209 // Loop through the cvars and count all possible matches
210 for (cvar = cvar_vars; cvar; cvar = cvar->next)
211 if (!strncasecmp(partial, cvar->name, len))
218 CVar_CompleteBuildList
220 New function for tab-completion system
222 Thanks to Fett erich@heintz.com
226 const char **Cvar_CompleteBuildList (const char *partial)
231 size_t sizeofbuf = (Cvar_CompleteCountPossible (partial) + 1) * sizeof (const char *);
234 len = strlen(partial);
235 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
236 // Loop through the alias list and print all matches
237 for (cvar = cvar_vars; cvar; cvar = cvar->next)
238 if (!strncasecmp(partial, cvar->name, len))
239 buf[bpos++] = cvar->name;
245 // written by LordHavoc
246 void Cvar_CompleteCvarPrint (const char *partial)
249 size_t len = strlen(partial);
250 // Loop through the command list and print all matches
251 for (cvar = cvar_vars; cvar; cvar = cvar->next)
252 if (!strncasecmp(partial, cvar->name, len))
253 Con_Printf ("^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
256 // we assume that prog is already set to the target progs
257 static void Cvar_UpdateAutoCvar(cvar_t *var)
261 Host_Error("Cvar_UpdateAutoCvar: no prog set");
262 i = PRVM_GetProgNr();
263 if(var->globaldefindex_progid[i] == prog->id)
265 // MUST BE SYNCED WITH prvm_edict.c PRVM_LoadProgs
268 prvm_eval_t *val = (prvm_eval_t *)(prog->globals.generic + prog->globaldefs[var->globaldefindex[i]].ofs);
269 switch(prog->globaldefs[var->globaldefindex[i]].type & ~DEF_SAVEGLOBAL)
272 val->_float = var->value;
276 VectorClear(val->vector);
277 for (j = 0;j < 3;j++)
279 while (*s && ISWHITESPACE(*s))
283 val->vector[j] = atof(s);
284 while (!ISWHITESPACE(*s))
291 PRVM_ChangeEngineString(var->globaldefindex_stringno[i], var->string);
292 val->string = var->globaldefindex_stringno[i];
298 // called after loading a savegame
299 void Cvar_UpdateAllAutoCvars(void)
302 for (var = cvar_vars ; var ; var = var->next)
303 Cvar_UpdateAutoCvar(var);
311 void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
315 prvm_prog_t *tmpprog;
318 changed = strcmp(var->string, value) != 0;
319 // LordHavoc: don't reallocate when there is no change
323 // LordHavoc: don't reallocate when the buffer is the same size
324 valuelen = strlen(value);
325 if (!var->string || strlen(var->string) != valuelen)
327 Z_Free ((char *)var->string); // free the old value string
329 var->string = (char *)Z_Malloc (valuelen + 1);
331 memcpy ((char *)var->string, value, valuelen + 1);
332 var->value = atof (var->string);
333 var->integer = (int) var->value;
334 if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
335 SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
337 // TODO: add infostring support to the server?
338 if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
340 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
343 MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
344 MSG_WriteString (&sv.reliable_datagram, var->name);
345 MSG_WriteString (&sv.reliable_datagram, var->string);
349 if ((var->flags & CVAR_USERINFO) && cls.state != ca_dedicated)
350 CL_SetInfo(var->name, var->string, true, false, false, false);
351 else if ((var->flags & CVAR_NQUSERINFOHACK) && cls.state != ca_dedicated)
353 // update the cls.userinfo to have proper values for the
354 // silly nq config variables.
356 // this is done when these variables are changed rather than at
357 // connect time because if the user or code checks the userinfo and it
358 // holds weird values it may cause confusion...
359 if (!strcmp(var->name, "_cl_color"))
361 int top = (var->integer >> 4) & 15, bottom = var->integer & 15;
362 CL_SetInfo("topcolor", va("%i", top), true, false, false, false);
363 CL_SetInfo("bottomcolor", va("%i", bottom), true, false, false, false);
364 if (cls.protocol != PROTOCOL_QUAKEWORLD && cls.netcon)
366 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
367 MSG_WriteString(&cls.netcon->message, va("color %i %i", top, bottom));
370 else if (!strcmp(var->name, "_cl_rate"))
371 CL_SetInfo("rate", va("%i", var->integer), true, false, false, false);
372 else if (!strcmp(var->name, "_cl_playerskin"))
373 CL_SetInfo("playerskin", var->string, true, false, false, false);
374 else if (!strcmp(var->name, "_cl_playermodel"))
375 CL_SetInfo("playermodel", var->string, true, false, false, false);
376 else if (!strcmp(var->name, "_cl_name"))
377 CL_SetInfo("name", var->string, true, false, false, false);
378 else if (!strcmp(var->name, "rcon_secure"))
380 // whenever rcon_secure is changed to 0, clear rcon_password for
381 // security reasons (prevents a send-rcon-password-as-plaintext
382 // attack based on NQ protocol session takeover and svc_stufftext)
383 if(var->integer <= 0)
384 Cvar_Set("rcon_password", "");
386 else if (!strcmp(var->name, "net_slist_favorites"))
387 NetConn_UpdateFavorites();
391 for(i = 0; i < PRVM_MAXPROGS; ++i)
393 if(PRVM_ProgLoaded(i))
396 Cvar_UpdateAutoCvar(var);
402 void Cvar_SetQuick (cvar_t *var, const char *value)
406 Con_Print("Cvar_SetQuick: var == NULL\n");
410 if (developer_extra.integer)
411 Con_DPrintf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
413 Cvar_SetQuick_Internal(var, value);
416 void Cvar_Set (const char *var_name, const char *value)
419 var = Cvar_FindVar (var_name);
422 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
425 Cvar_SetQuick(var, value);
433 void Cvar_SetValueQuick(cvar_t *var, float value)
435 char val[MAX_INPUTLINE];
437 if ((float)((int)value) == value)
438 dpsnprintf(val, sizeof(val), "%i", (int)value);
440 dpsnprintf(val, sizeof(val), "%f", value);
441 Cvar_SetQuick(var, val);
444 void Cvar_SetValue(const char *var_name, float value)
446 char val[MAX_INPUTLINE];
448 if ((float)((int)value) == value)
449 dpsnprintf(val, sizeof(val), "%i", (int)value);
451 dpsnprintf(val, sizeof(val), "%f", value);
452 Cvar_Set(var_name, val);
457 Cvar_RegisterVariable
459 Adds a freestanding variable to the variable list.
462 void Cvar_RegisterVariable (cvar_t *variable)
465 cvar_t *current, *next, *cvar;
469 if (developer_extra.integer)
470 Con_DPrintf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
472 // first check to see if it has already been defined
473 cvar = Cvar_FindVar (variable->name);
476 if (cvar->flags & CVAR_ALLOCATED)
478 if (developer_extra.integer)
479 Con_DPrintf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
480 // fixed variables replace allocated ones
481 // (because the engine directly accesses fixed variables)
482 // NOTE: this isn't actually used currently
483 // (all cvars are registered before config parsing)
484 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
485 // cvar->string is now owned by variable instead
486 variable->string = cvar->string;
487 variable->defstring = cvar->defstring;
488 variable->value = atof (variable->string);
489 variable->integer = (int) variable->value;
490 // replace cvar with this one...
491 variable->next = cvar->next;
492 if (cvar_vars == cvar)
494 // head of the list is easy to change
495 cvar_vars = variable;
499 // otherwise find it somewhere in the list
500 for (current = cvar_vars;current->next != cvar;current = current->next)
502 current->next = variable;
505 // get rid of old allocated cvar
506 // (but not cvar->string and cvar->defstring, because we kept those)
507 Z_Free((char *)cvar->name);
511 Con_DPrintf("Can't register variable %s, already defined\n", variable->name);
515 // check for overlap with a command
516 if (Cmd_Exists (variable->name))
518 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
522 // copy the value off, because future sets will Z_Free it
523 oldstr = (char *)variable->string;
524 alloclen = strlen(variable->string) + 1;
525 variable->string = (char *)Z_Malloc (alloclen);
526 memcpy ((char *)variable->string, oldstr, alloclen);
527 variable->defstring = (char *)Z_Malloc (alloclen);
528 memcpy ((char *)variable->defstring, oldstr, alloclen);
529 variable->value = atof (variable->string);
530 variable->integer = (int) variable->value;
532 // link the variable in
533 // alphanumerical order
534 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
537 current->next = variable;
539 cvar_vars = variable;
541 variable->next = next;
543 // link to head of list in this hash table index
544 hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name)) % CVAR_HASHSIZE;
545 variable->nextonhashchain = cvar_hashtable[hashindex];
546 cvar_hashtable[hashindex] = variable;
553 Adds a newly allocated variable to the variable list or sets its value.
556 cvar_t *Cvar_Get (const char *name, const char *value, int flags, const char *newdescription)
559 cvar_t *current, *next, *cvar;
562 if (developer_extra.integer)
563 Con_DPrintf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
565 // first check to see if it has already been defined
566 cvar = Cvar_FindVar (name);
569 cvar->flags |= flags;
570 Cvar_SetQuick_Internal (cvar, value);
571 if(newdescription && (cvar->flags & CVAR_ALLOCATED))
573 if(cvar->description != cvar_dummy_description)
574 Z_Free((char *)cvar->description);
578 alloclen = strlen(newdescription) + 1;
579 cvar->description = (char *)Z_Malloc(alloclen);
580 memcpy((char *)cvar->description, newdescription, alloclen);
583 cvar->description = cvar_dummy_description;
588 // check for pure evil
591 Con_Printf("Cvar_Get: invalid variable name\n");
595 // check for overlap with a command
596 if (Cmd_Exists (name))
598 Con_Printf("Cvar_Get: %s is a command\n", name);
602 // allocate a new cvar, cvar name, and cvar string
603 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
604 // FIXME: these never get Z_Free'd
605 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
606 cvar->flags = flags | CVAR_ALLOCATED;
607 alloclen = strlen(name) + 1;
608 cvar->name = (char *)Z_Malloc(alloclen);
609 memcpy((char *)cvar->name, name, alloclen);
610 alloclen = strlen(value) + 1;
611 cvar->string = (char *)Z_Malloc(alloclen);
612 memcpy((char *)cvar->string, value, alloclen);
613 cvar->defstring = (char *)Z_Malloc(alloclen);
614 memcpy((char *)cvar->defstring, value, alloclen);
615 cvar->value = atof (cvar->string);
616 cvar->integer = (int) cvar->value;
618 if(newdescription && *newdescription)
620 alloclen = strlen(newdescription) + 1;
621 cvar->description = (char *)Z_Malloc(alloclen);
622 memcpy((char *)cvar->description, newdescription, alloclen);
625 cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
627 // link the variable in
628 // alphanumerical order
629 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
632 current->next = cvar;
637 // link to head of list in this hash table index
638 hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name)) % CVAR_HASHSIZE;
639 cvar->nextonhashchain = cvar_hashtable[hashindex];
640 cvar_hashtable[hashindex] = cvar;
650 Handles variable inspection and changing from the console
653 qboolean Cvar_Command (void)
658 v = Cvar_FindVar (Cmd_Argv(0));
662 // perform a variable print or set
665 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, ((v->flags & CVAR_PRIVATE) ? "********"/*hunter2*/ : v->string), v->defstring);
669 if (developer_extra.integer)
670 Con_DPrint("Cvar_Command: ");
672 if (v->flags & CVAR_READONLY)
674 Con_Printf("%s is read-only\n", v->name);
677 Cvar_Set (v->name, Cmd_Argv(1));
678 if (developer_extra.integer)
684 void Cvar_UnlockDefaults (void)
687 // unlock the default values of all cvars
688 for (var = cvar_vars ; var ; var = var->next)
689 var->flags &= ~CVAR_DEFAULTSET;
693 void Cvar_LockDefaults_f (void)
696 // lock in the default values of all cvars
697 for (var = cvar_vars ; var ; var = var->next)
699 if (!(var->flags & CVAR_DEFAULTSET))
703 //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
704 var->flags |= CVAR_DEFAULTSET;
705 Z_Free((char *)var->defstring);
706 alloclen = strlen(var->string) + 1;
707 var->defstring = (char *)Z_Malloc(alloclen);
708 memcpy((char *)var->defstring, var->string, alloclen);
714 void Cvar_ResetToDefaults_All_f (void)
717 // restore the default values of all cvars
718 for (var = cvar_vars ; var ; var = var->next)
719 if((var->flags & CVAR_NORESETTODEFAULTS) == 0)
720 Cvar_SetQuick(var, var->defstring);
724 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
727 // restore the default values of all cvars
728 for (var = cvar_vars ; var ; var = var->next)
729 if ((var->flags & (CVAR_NORESETTODEFAULTS | CVAR_SAVE)) == 0)
730 Cvar_SetQuick(var, var->defstring);
734 void Cvar_ResetToDefaults_SaveOnly_f (void)
737 // restore the default values of all cvars
738 for (var = cvar_vars ; var ; var = var->next)
739 if ((var->flags & (CVAR_NORESETTODEFAULTS | CVAR_SAVE)) == CVAR_SAVE)
740 Cvar_SetQuick(var, var->defstring);
748 Writes lines containing "set variable value" for all variables
749 with the archive flag set to true.
752 void Cvar_WriteVariables (qfile_t *f)
755 char buf1[MAX_INPUTLINE], buf2[MAX_INPUTLINE];
757 // don't save cvars that match their default value
758 for (var = cvar_vars ; var ; var = var->next)
759 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || !(var->flags & CVAR_DEFAULTSET)))
761 Cmd_QuoteString(buf1, sizeof(buf1), var->name, "\"\\$");
762 Cmd_QuoteString(buf2, sizeof(buf2), var->string, "\"\\$");
763 FS_Printf(f, "%s\"%s\" \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", buf1, buf2);
768 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
769 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
775 void Cvar_List_f (void)
785 partial = Cmd_Argv (1);
786 len = strlen(partial);
794 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
797 for (cvar = cvar_vars; cvar; cvar = cvar->next)
799 if (len && (ispattern ? !matchpattern_with_separator(cvar->name, partial, false, "", false) : strncmp (partial,cvar->name,len)))
802 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, ((cvar->flags & CVAR_PRIVATE) ? "********"/*hunter2*/ : cvar->string), cvar->defstring, cvar->description);
809 Con_Printf("%i cvar%s matching \"%s\"\n", count, (count > 1) ? "s" : "", partial);
811 Con_Printf("%i cvar%s beginning with \"%s\"\n", count, (count > 1) ? "s" : "", partial);
814 Con_Printf("%i cvar(s)\n", count);
816 // 2000-01-09 CvarList command by Maddes
818 void Cvar_Set_f (void)
822 // make sure it's the right number of parameters
825 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
829 // check if it's read-only
830 cvar = Cvar_FindVar(Cmd_Argv(1));
831 if (cvar && cvar->flags & CVAR_READONLY)
833 Con_Printf("Set: %s is read-only\n", cvar->name);
837 if (developer_extra.integer)
840 // all looks ok, create/modify the cvar
841 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);
844 void Cvar_SetA_f (void)
848 // make sure it's the right number of parameters
851 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
855 // check if it's read-only
856 cvar = Cvar_FindVar(Cmd_Argv(1));
857 if (cvar && cvar->flags & CVAR_READONLY)
859 Con_Printf("SetA: %s is read-only\n", cvar->name);
863 if (developer_extra.integer)
864 Con_DPrint("SetA: ");
866 // all looks ok, create/modify the cvar
867 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE, Cmd_Argc() > 3 ? Cmd_Argv(3) : NULL);
870 void Cvar_Del_f (void)
873 cvar_t *cvar, *parent, **link, *prev;
877 Con_Printf("Del: wrong number of parameters, useage: unset <variablename1> [<variablename2> ...]\n");
880 for(i = 1; i < Cmd_Argc(); ++i)
882 cvar = Cvar_FindVarLink(Cmd_Argv(i), &parent, &link, &prev);
885 Con_Printf("Del: %s is not defined\n", Cmd_Argv(i));
888 if(cvar->flags & CVAR_READONLY)
890 Con_Printf("Del: %s is read-only\n", cvar->name);
893 if(!(cvar->flags & CVAR_ALLOCATED))
895 Con_Printf("Del: %s is static and cannot be deleted\n", cvar->name);
898 if(cvar == cvar_vars)
900 cvar_vars = cvar->next;
904 // in this case, prev must be set, otherwise there has been some inconsistensy
905 // elsewhere already... should I still check for prev != NULL?
906 prev->next = cvar->next;
910 parent->nextonhashchain = cvar->nextonhashchain;
912 *link = cvar->nextonhashchain;
914 if(cvar->description != cvar_dummy_description)
915 Z_Free((char *)cvar->description);
917 Z_Free((char *)cvar->name);
918 Z_Free((char *)cvar->string);
919 Z_Free((char *)cvar->defstring);
924 #ifdef FILLALLCVARSWITHRUBBISH
925 void Cvar_FillAll_f()
933 Con_Printf("Usage: %s length to plant rubbish\n", Cmd_Argv(0));
934 Con_Printf("Usage: %s -length to verify that the rubbish is still there\n", Cmd_Argv(0));
937 n = atoi(Cmd_Argv(1));
941 buf = Z_Malloc(n + 1);
943 for(var = cvar_vars; var; var = var->next)
945 for(i = 0, p = buf, q = var->name; i < n; ++i)
951 if(verify && strcmp(var->string, buf))
953 Con_Printf("\n%s does not contain the right rubbish, either this is the first run or a possible overrun was detected, or something changed it intentionally; it DOES contain: %s\n", var->name, var->string);
955 Cvar_SetQuick(var, buf);
959 #endif /* FILLALLCVARSWITHRUBBISH */