2 Copyright (C) 1996-1997 Id Software, Inc.
3 Copyright (C) 2000-2021 DarkPlaces contributors
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 // cvar.c -- dynamic variable tracking
25 const char *cvar_dummy_description = "custom cvar";
26 static const char *cvar_null_string = "";
28 cvar_state_t cvars_all;
29 cvar_state_t cvars_null;
36 cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
41 // use hash lookup to minimize search time
42 hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name)) % CVAR_HASHSIZE;
43 for (hash = cvars->hashtable[hashindex];hash;hash = hash->next)
44 if (!strcmp (var_name, hash->cvar->name) && (hash->cvar->flags & neededflags))
47 for (char **alias = hash->cvar->aliases; alias && *alias; alias++)
48 if (!strcmp (var_name, *alias) && (hash->cvar->flags & neededflags))
53 cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, unsigned neededflags)
59 var = Cvar_FindVar(cvars, prev_var_name, neededflags);
67 // search for the next cvar matching the needed flags
70 if (var->flags & neededflags)
78 * Returns a pointer to the pointer stored in hashtable[] (or the one it links to)
79 * because we'll need to update that when deleting a cvar as other cvar(s) may share its hashindex.
81 static cvar_hash_t **Cvar_FindVarLink(cvar_state_t *cvars, const char *var_name, cvar_t **parent, cvar_t ***link, cvar_t **prev_alpha, unsigned neededflags)
85 cvar_hash_t **hashlinkptr;
87 // use hash lookup to minimize search time
88 hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name)) % CVAR_HASHSIZE;
89 if(parent) *parent = NULL;
90 if(prev_alpha) *prev_alpha = NULL;
91 if(link) *link = &cvars->hashtable[hashindex]->cvar;
92 hashlinkptr = &cvars->hashtable[hashindex];
93 for (hashlinkptr = &cvars->hashtable[hashindex]; *hashlinkptr; hashlinkptr = &(*hashlinkptr)->next)
95 cvar = (*hashlinkptr)->cvar;
96 if (!strcmp (var_name, cvar->name) && (cvar->flags & neededflags))
99 for (char **alias = cvar->aliases; alias && *alias; alias++)
100 if (!strcmp (var_name, *alias) && (cvar->flags & neededflags))
102 if(parent) *parent = cvar;
106 if(!prev_alpha || cvar == cvars->vars)
109 *prev_alpha = cvars->vars;
110 // if prev_alpha happens to become NULL then there has been some inconsistency elsewhere
111 // already - should I still insert '*prev_alpha &&' in the loop?
112 while((*prev_alpha)->next != cvar)
113 *prev_alpha = (*prev_alpha)->next;
122 float Cvar_VariableValueOr(cvar_state_t *cvars, const char *var_name, float def, unsigned neededflags)
126 var = Cvar_FindVar(cvars, var_name, neededflags);
129 return atof (var->string);
132 float Cvar_VariableValue(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
134 return Cvar_VariableValueOr(cvars, var_name, 0, neededflags);
142 const char *Cvar_VariableStringOr(cvar_state_t *cvars, const char *var_name, const char *def, unsigned neededflags)
146 var = Cvar_FindVar(cvars, var_name, neededflags);
152 const char *Cvar_VariableString(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
154 return Cvar_VariableStringOr(cvars, var_name, cvar_null_string, neededflags);
159 Cvar_VariableDefString
162 const char *Cvar_VariableDefString(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
166 var = Cvar_FindVar(cvars, var_name, neededflags);
168 return cvar_null_string;
169 return var->defstring;
174 Cvar_VariableDescription
177 const char *Cvar_VariableDescription(cvar_state_t *cvars, const char *var_name, unsigned neededflags)
181 var = Cvar_FindVar(cvars, var_name, neededflags);
183 return cvar_null_string;
184 return var->description;
190 Cvar_CompleteVariable
193 const char *Cvar_CompleteVariable(cvar_state_t *cvars, const char *partial, unsigned neededflags)
198 len = strlen(partial);
204 for (cvar=cvars->vars ; cvar ; cvar=cvar->next)
205 if (!strncasecmp (partial,cvar->name, len) && (cvar->flags & neededflags))
213 CVar_CompleteCountPossible
215 New function for tab-completion system
217 Thanks to Fett erich@heintz.com
220 int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, unsigned neededflags)
227 len = strlen(partial);
232 // Loop through the cvars and count all possible matches
233 for (cvar = cvars->vars; cvar; cvar = cvar->next)
234 if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
237 for (char **alias = cvar->aliases; alias && *alias; alias++)
238 if (!strncasecmp(partial, *alias, len) && (cvar->flags & neededflags))
245 CVar_CompleteBuildList
247 New function for tab-completion system
249 Thanks to Fett erich@heintz.com
253 const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, unsigned neededflags)
258 size_t sizeofbuf = (Cvar_CompleteCountPossible(cvars, partial, neededflags) + 1) * sizeof(const char *);
261 len = strlen(partial);
262 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof(const char *));
263 // Loop through the alias list and print all matches
264 for (cvar = cvars->vars; cvar; cvar = cvar->next)
265 if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
266 buf[bpos++] = cvar->name;
268 for (char **alias = cvar->aliases; alias && *alias; alias++)
269 if (!strncasecmp(partial, *alias, len) && (cvar->flags & neededflags))
270 buf[bpos++] = *alias;
277 void Cvar_PrintHelp(cvar_t *cvar, const char *name, qbool full)
279 // Aliases are purple, cvars are yellow
280 if (strcmp(cvar->name, name))
281 Con_Printf("^6%s^7 (alias of ^3%s^7)", name, cvar->name);
283 Con_Printf("^3%s^7", name);
284 Con_Printf(" is \"%s^7\" [\"%s^7\"]", ((cvar->flags & CF_PRIVATE) ? "********"/*hunter2*/ : cvar->string), cvar->defstring);
286 Con_Printf(" %s", cvar->description);
290 // written by LadyHavoc
291 void Cvar_CompleteCvarPrint(cvar_state_t *cvars, const char *partial, unsigned neededflags)
294 size_t len = strlen(partial);
295 // Loop through the command list and print all matches
296 for (cvar = cvars->vars; cvar; cvar = cvar->next)
297 if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
298 Cvar_PrintHelp(cvar, cvar->name, true);
300 for (char **alias = cvar->aliases; alias && *alias; alias++)
301 if (!strncasecmp (partial, *alias, len) && (cvar->flags & neededflags))
302 Cvar_PrintHelp(cvar, *alias, true);
307 // check if a cvar is held by some progs
308 static qbool Cvar_IsAutoCvar(cvar_t *var)
312 for (i = 0;i < PRVM_PROG_MAX;i++)
314 prog = &prvm_prog_list[i];
315 if (prog->loaded && var->globaldefindex[i] >= 0)
321 // we assume that prog is already set to the target progs
322 static void Cvar_UpdateAutoCvar(cvar_t *var)
329 for (i = 0;i < PRVM_PROG_MAX;i++)
331 prog = &prvm_prog_list[i];
332 if (prog->loaded && var->globaldefindex[i] >= 0)
334 // MUST BE SYNCED WITH prvm_edict.c PRVM_LoadProgs
335 switch(prog->globaldefs[var->globaldefindex[i]].type & ~DEF_SAVEGLOBAL)
338 PRVM_GLOBALFIELDFLOAT(prog->globaldefs[var->globaldefindex[i]].ofs) = var->value;
343 for (j = 0;j < 3;j++)
345 while (*s && ISWHITESPACE(*s))
350 while (!ISWHITESPACE(*s))
355 VectorCopy(v, PRVM_GLOBALFIELDVECTOR(prog->globaldefs[var->globaldefindex[i]].ofs));
358 PRVM_ChangeEngineString(prog, var->globaldefindex_stringno[i], var->string);
359 PRVM_GLOBALFIELDSTRING(prog->globaldefs[var->globaldefindex[i]].ofs) = var->globaldefindex_stringno[i];
366 // called after loading a savegame
367 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars)
370 for (var = cvars->vars ; var ; var = var->next)
371 Cvar_UpdateAutoCvar(var);
374 void Cvar_Callback(cvar_t *var)
378 Con_Print(CON_WARN "Cvar_Callback: var == NULL\n");
391 extern cvar_t sv_disablenotify;
392 static void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
397 changed = strcmp(var->string, value) != 0;
398 // LadyHavoc: don't reallocate when there is no change
402 // LadyHavoc: don't reallocate when the buffer is the same size
403 valuelen = strlen(value);
404 if (!var->string || strlen(var->string) != valuelen)
406 Z_Free ((char *)var->string); // free the old value string
408 var->string = (char *)Z_Malloc (valuelen + 1);
410 memcpy ((char *)var->string, value, valuelen + 1);
411 var->value = atof (var->string);
412 var->integer = (int) var->value;
413 if ((var->flags & CF_NOTIFY) && sv.active && !sv_disablenotify.integer)
414 SV_BroadcastPrintf("\003^3Server cvar \"%s\" changed to \"%s\"\n", var->name, var->string);
416 // TODO: add infostring support to the server?
417 if ((var->flags & CF_SERVERINFO) && changed && sv.active)
419 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
422 MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
423 MSG_WriteString (&sv.reliable_datagram, var->name);
424 MSG_WriteString (&sv.reliable_datagram, var->string);
428 if (var->flags & CF_USERINFO)
429 CL_SetInfo(var->name, var->string, true, false, false, false);
431 Cvar_UpdateAutoCvar(var);
434 // Call the function stored in the cvar for bounds checking, cleanup, etc
438 void Cvar_SetQuick (cvar_t *var, const char *value)
442 Con_Print(CON_WARN "Cvar_SetQuick: var == NULL\n");
446 if (!(var->flags & CF_REGISTERED) && !(var->flags & CF_ALLOCATED))
448 Con_Printf(CON_WARN "Warning: Cvar_SetQuick() cannot set unregistered cvar \"%s\"\n", var->name);
449 return; // setting an unregistered engine cvar crashes
452 if (developer_extra.integer)
453 Con_DPrintf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
455 Cvar_SetQuick_Internal(var, value);
458 void Cvar_Set(cvar_state_t *cvars, const char *var_name, const char *value)
461 var = Cvar_FindVar(cvars, var_name, ~0);
464 Con_Printf(CON_WARN "Cvar_Set: variable %s not found\n", var_name);
467 Cvar_SetQuick(var, value);
475 void Cvar_SetValueQuick(cvar_t *var, float value)
477 char val[MAX_INPUTLINE];
479 if ((float)((int)value) == value)
480 dpsnprintf(val, sizeof(val), "%i", (int)value);
482 dpsnprintf(val, sizeof(val), "%f", value);
483 Cvar_SetQuick(var, val);
486 void Cvar_SetValue(cvar_state_t *cvars, const char *var_name, float value)
488 char val[MAX_INPUTLINE];
490 if ((float)((int)value) == value)
491 dpsnprintf(val, sizeof(val), "%i", (int)value);
493 dpsnprintf(val, sizeof(val), "%f", value);
494 Cvar_Set(cvars, var_name, val);
497 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *))
499 if (variable == NULL)
501 Con_Print(CON_WARN "Cvar_RegisterCallback: var == NULL\n");
505 if (!(variable->flags & cmd_local->cvars_flagsmask))
507 if (developer_extra.integer)
508 Con_DPrintf("^6Cvar_RegisterCallback: rejecting cvar \"%s\"\n", variable->name);
512 variable->callback = callback;
515 void Cvar_RegisterVirtual(cvar_t *variable, const char *name )
517 cvar_state_t *cvars = &cvars_all;
521 if (!(variable->flags & cmd_local->cvars_flagsmask))
523 if (developer_extra.integer)
524 Con_DPrintf("^6Cvar_RegisterVirtual: rejecting cvar \"%s\" alias \"%s\"\n", variable->name, name);
530 Con_Printf(CON_WARN "Cvar_RegisterVirtual: invalid virtual cvar name\n");
534 // check for overlap with a command
535 if (Cmd_Exists(cmd_local, name))
537 Con_Printf(CON_WARN "Cvar_RegisterVirtual: %s is a command\n", name);
541 if(Cvar_FindVar(&cvars_all, name, 0))
543 Con_Printf(CON_WARN "Cvar_RegisterVirtual: %s is a cvar\n", name);
547 // Resize the variable->aliases list to have room for another entry and a null terminator.
548 // This zero-pads when resizing, so we don't need to write the NULL terminator manually here.
549 // Also if aliases is NULL this allocates fresh for the correct size, so it's fine to just do this.
550 variable->aliases = (char **)Z_Realloc(variable->aliases, sizeof(char *) * (variable->aliases_size + 2));
551 // Add the new alias, and increment the number of aliases in the list
552 variable->aliases[variable->aliases_size++] = (char *)Z_strdup(name);
554 // link to head of list in this hash table index
555 hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
556 hashindex = CRC_Block((const unsigned char *)name, strlen(name)) % CVAR_HASHSIZE;
557 hash->next = cvars->hashtable[hashindex];
558 cvars->hashtable[hashindex] = hash;
559 hash->cvar = variable;
566 Links a variable to the variable list and hashtable
569 static void Cvar_Link(cvar_t *variable, cvar_state_t *cvars)
571 cvar_t *current, *next;
575 * Link the variable in
576 * alphanumerical order
578 for( current = NULL, next = cvars->vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
581 current->next = variable;
583 cvars->vars = variable;
584 variable->next = next;
586 // link to head of list in this hash table index
587 hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
588 hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name)) % CVAR_HASHSIZE;
589 hash->next = cvars->hashtable[hashindex];
590 hash->cvar = variable;
591 cvars->hashtable[hashindex] = hash;
596 Cvar_RegisterVariable
598 Adds a freestanding variable to the variable list.
601 void Cvar_RegisterVariable (cvar_t *variable)
603 cvar_state_t *cvars = &cvars_all;
604 cvar_t *current, *cvar;
607 if (!(variable->flags & cmd_local->cvars_flagsmask))
609 if (developer_extra.integer)
610 Con_DPrintf("^2Cvar_RegisterVariable: rejecting cvar \"%s\"\n", variable->name);
614 if (developer_extra.integer)
615 Con_DPrintf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
617 // first check to see if it has already been defined
618 cvar = Cvar_FindVar(cvars, variable->name, ~0);
621 if (cvar->flags & CF_ALLOCATED)
623 if (developer_extra.integer)
624 Con_DPrintf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
625 // fixed variables replace allocated ones
626 // (because the engine directly accesses fixed variables)
627 // NOTE: this isn't actually used currently
628 // (all cvars are registered before config parsing)
629 variable->flags &= ~CF_ALLOCATED;
630 // cvar->string is now owned by variable instead
631 variable->string = cvar->string;
632 variable->defstring = cvar->defstring;
633 variable->value = atof (variable->string);
634 variable->integer = (int) variable->value;
635 // Preserve autocvar status.
636 memcpy(variable->globaldefindex, cvar->globaldefindex, sizeof(variable->globaldefindex));
637 memcpy(variable->globaldefindex_stringno, cvar->globaldefindex_stringno, sizeof(variable->globaldefindex_stringno));
638 // replace cvar with this one...
639 variable->next = cvar->next;
640 if (cvars->vars == cvar)
642 // head of the list is easy to change
643 cvars->vars = variable;
647 // otherwise find it somewhere in the list
648 for (current = cvars->vars;current->next != cvar;current = current->next)
650 current->next = variable;
653 // get rid of old allocated cvar
654 // (but not cvar->string and cvar->defstring, because we kept those)
655 Z_Free((char *)cvar->name);
659 Con_DPrintf("Can't register variable %s, already defined\n", variable->name);
663 // check for overlap with a command
664 if (Cmd_Exists(cmd_local, variable->name))
666 Con_Printf(CON_WARN "Cvar_RegisterVariable: %s is a command\n", variable->name);
670 // copy the value off, because future sets will Z_Free it
671 variable->name = (char *)Mem_strdup(zonemempool, variable->name);
672 variable->string = (char *)Mem_strdup(zonemempool, variable->string);
673 variable->defstring = (char *)Mem_strdup(zonemempool, variable->string);
674 variable->value = atof (variable->string);
675 variable->integer = (int) variable->value;
676 variable->aliases = NULL;
677 variable->aliases_size = 0;
678 variable->initstate = NULL;
680 // Mark it as not an autocvar.
681 for (i = 0;i < PRVM_PROG_MAX;i++)
682 variable->globaldefindex[i] = -1;
684 // Safe for Cvar_SetQuick()
685 variable->flags |= CF_REGISTERED;
687 Cvar_Link(variable, cvars);
694 Adds a newly allocated variable to the variable list or sets its value.
697 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription)
702 if (developer_extra.integer)
703 Con_DPrintf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
705 // first check to see if it has already been defined
706 cvar = Cvar_FindVar(cvars, name, ~0);
709 cvar->flags |= flags;
710 Cvar_SetQuick_Internal (cvar, value);
711 if(newdescription && (cvar->flags & CF_ALLOCATED))
713 if(cvar->description != cvar_dummy_description)
714 Z_Free((char *)cvar->description);
717 cvar->description = (char *)Mem_strdup(zonemempool, newdescription);
719 cvar->description = cvar_dummy_description;
724 // check for pure evil
727 Con_Printf(CON_WARN "Cvar_Get: invalid variable name\n");
731 // check for overlap with a command
732 if (Cmd_Exists(cmd_local, name))
734 Con_Printf(CON_WARN "Cvar_Get: %s is a command\n", name);
738 // allocate a new cvar, cvar name, and cvar string
739 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
740 // FIXME: these never get Z_Free'd
741 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
742 cvar->flags = flags | CF_ALLOCATED;
743 cvar->name = (char *)Mem_strdup(zonemempool, name);
744 cvar->string = (char *)Mem_strdup(zonemempool, value);
745 cvar->defstring = (char *)Mem_strdup(zonemempool, value);
746 cvar->value = atof (cvar->string);
747 cvar->integer = (int) cvar->value;
748 cvar->aliases = NULL;
749 cvar->aliases_size = 0;
750 cvar->initstate = NULL;
752 if(newdescription && *newdescription)
753 cvar->description = (char *)Mem_strdup(zonemempool, newdescription);
755 cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
757 // Mark it as not an autocvar.
758 for (i = 0;i < PRVM_PROG_MAX;i++)
759 cvar->globaldefindex[i] = -1;
761 Cvar_Link(cvar, cvars);
766 qbool Cvar_Readonly (cvar_t *var, const char *cmd_name)
768 if (var->flags & CF_READONLY)
772 Con_Printf("%s: ",cmd_name);
773 Con_Printf("%s is read-only\n", var->name);
783 Handles variable inspection and changing from the console
786 qbool Cvar_Command (cmd_state_t *cmd)
788 cvar_state_t *cvars = cmd->cvars;
792 v = Cvar_FindVar(cvars, Cmd_Argv(cmd, 0), (cmd->cvars_flagsmask));
796 // perform a variable print or set
797 if (Cmd_Argc(cmd) == 1)
799 Cvar_PrintHelp(v, Cmd_Argv(cmd, 0), true);
803 if (developer_extra.integer)
804 Con_DPrint("Cvar_Command: ");
806 if(Cvar_Readonly(v, NULL))
809 Cvar_SetQuick(v, Cmd_Argv(cmd, 1));
810 if (developer_extra.integer)
815 void Cvar_UnlockDefaults(cmd_state_t *cmd)
817 cvar_state_t *cvars = cmd->cvars;
819 // unlock the default values of all cvars
820 for (var = cvars->vars ; var ; var = var->next)
821 var->flags &= ~CF_DEFAULTSET;
824 void Cvar_LockDefaults_f(cmd_state_t *cmd)
826 cvar_state_t *cvars = cmd->cvars;
828 // lock in the default values of all cvars
829 for (var = cvars->vars ; var ; var = var->next)
831 if (!(var->flags & CF_DEFAULTSET))
835 //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
836 var->flags |= CF_DEFAULTSET;
837 Z_Free((char *)var->defstring);
838 alloclen = strlen(var->string) + 1;
839 var->defstring = (char *)Z_Malloc(alloclen);
840 memcpy((char *)var->defstring, var->string, alloclen);
845 void Cvar_SaveInitState(cvar_state_t *cvars)
848 for (c = cvars->vars;c;c = c->next)
850 c->initstate = (cvar_t *)Z_Malloc(sizeof(cvar_t));
851 memcpy(c->initstate, c, sizeof(cvar_t));
855 void Cvar_RestoreInitState(cvar_state_t *cvars)
860 for (cp = &cvars->vars;(c = *cp);)
864 // restore this cvar, it existed at init
865 if (((c->flags ^ c->initstate->flags) & CF_MAXFLAGSVAL)
866 || strcmp(c->defstring ? c->defstring : "", c->initstate->defstring ? c->initstate->defstring : "")
867 || strcmp(c->string ? c->string : "", c->initstate->string ? c->initstate->string : ""))
869 Con_DPrintf("Cvar_RestoreInitState: Restoring cvar \"%s\"\n", c->name);
871 Z_Free((char *)c->defstring);
872 c->defstring = Mem_strdup(zonemempool, c->initstate->defstring);
874 Z_Free((char *)c->string);
875 c->string = Mem_strdup(zonemempool, c->initstate->string);
877 c->flags = c->initstate->flags;
878 c->value = c->initstate->value;
879 c->integer = c->initstate->integer;
880 VectorCopy(c->initstate->vector, c->vector);
885 if (!(c->flags & CF_ALLOCATED))
887 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it was registered after init!\n", c->name);
888 // In this case, at least reset it to the default.
889 if((c->flags & CF_PERSISTENT) == 0)
890 Cvar_SetQuick(c, c->defstring);
894 if (Cvar_IsAutoCvar(c))
896 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it is an autocvar used by running progs!\n", c->name);
897 // In this case, at least reset it to the default.
898 if((c->flags & CF_PERSISTENT) == 0)
899 Cvar_SetQuick(c, c->defstring);
903 // remove this cvar, it did not exist at init
904 Con_DPrintf("Cvar_RestoreInitState: Destroying cvar \"%s\"\n", c->name);
905 // unlink struct from hash
906 hashindex = CRC_Block((const unsigned char *)c->name, strlen(c->name)) % CVAR_HASHSIZE;
907 for (cp2 = &cvars->hashtable[hashindex]->cvar;(c2 = *cp2);)
911 *cp2 = cvars->hashtable[hashindex]->next->cvar;
915 cp2 = &cvars->hashtable[hashindex]->next->cvar;
917 // unlink struct from main list
921 Z_Free((char *)c->defstring);
923 Z_Free((char *)c->string);
924 if (c->description && c->description != cvar_dummy_description)
925 Z_Free((char *)c->description);
932 void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd)
934 cvar_state_t *cvars = cmd->cvars;
936 // restore the default values of all cvars
937 for (var = cvars->vars ; var ; var = var->next)
939 if((var->flags & CF_PERSISTENT) == 0)
940 Cvar_SetQuick(var, var->defstring);
944 void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd)
946 cvar_state_t *cvars = cmd->cvars;
948 // restore the default values of all cvars
949 for (var = cvars->vars ; var ; var = var->next)
951 if ((var->flags & (CF_PERSISTENT | CF_ARCHIVE)) == 0)
952 Cvar_SetQuick(var, var->defstring);
957 void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd)
959 cvar_state_t *cvars = cmd->cvars;
961 // restore the default values of all cvars
962 for (var = cvars->vars ; var ; var = var->next)
964 if ((var->flags & (CF_PERSISTENT | CF_ARCHIVE)) == CF_ARCHIVE)
965 Cvar_SetQuick(var, var->defstring);
973 Writes lines containing "set variable value" for all variables
974 with the archive flag set to true.
977 void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f)
980 char buf1[MAX_INPUTLINE], buf2[MAX_INPUTLINE];
982 // don't save cvars that match their default value
983 for (var = cvars->vars ; var ; var = var->next) {
984 if ((var->flags & CF_ARCHIVE) && (strcmp(var->string, var->defstring) || ((var->flags & CF_ALLOCATED) && !(var->flags & CF_DEFAULTSET))))
986 Cmd_QuoteString(buf1, sizeof(buf1), var->name, "\"\\$", false);
987 Cmd_QuoteString(buf2, sizeof(buf2), var->string, "\"\\$", false);
988 FS_Printf(f, "%s\"%s\" \"%s\"\n", var->flags & CF_ALLOCATED ? "seta " : "", buf1, buf2);
993 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
994 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1000 void Cvar_List_f(cmd_state_t *cmd)
1002 cvar_state_t *cvars = cmd->cvars;
1004 const char *partial;
1009 if (Cmd_Argc(cmd) > 1)
1011 partial = Cmd_Argv(cmd, 1);
1012 ispattern = (strchr(partial, '*') || strchr(partial, '?'));
1014 partial = va(vabuf, sizeof(vabuf), "%s*", partial);
1018 partial = va(vabuf, sizeof(vabuf), "*");
1023 for (cvar = cvars->vars; cvar; cvar = cvar->next)
1025 if (matchpattern_with_separator(cvar->name, partial, false, "", false))
1027 Cvar_PrintHelp(cvar, cvar->name, true);
1030 for (char **alias = cvar->aliases; alias && *alias; alias++)
1032 if (matchpattern_with_separator(*alias, partial, false, "", false))
1034 Cvar_PrintHelp(cvar, *alias, true);
1040 if (Cmd_Argc(cmd) > 1)
1043 Con_Printf("%i cvar%s matching \"%s\"\n", count, (count > 1) ? "s" : "", partial);
1045 Con_Printf("%i cvar%s beginning with \"%s\"\n", count, (count > 1) ? "s" : "", Cmd_Argv(cmd,1));
1048 Con_Printf("%i cvar(s)\n", count);
1050 // 2000-01-09 CvarList command by Maddes
1052 void Cvar_Set_f(cmd_state_t *cmd)
1054 cvar_state_t *cvars = cmd->cvars;
1057 // make sure it's the right number of parameters
1058 if (Cmd_Argc(cmd) < 3)
1060 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
1064 // check if it's read-only
1065 cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1067 if(Cvar_Readonly(cvar,"Set"))
1070 if (developer_extra.integer)
1071 Con_DPrint("Set: ");
1073 // all looks ok, create/modify the cvar
1074 Cvar_Get(cvars, Cmd_Argv(cmd, 1), Cmd_Argv(cmd, 2), cmd->cvars_flagsmask, Cmd_Argc(cmd) > 3 ? Cmd_Argv(cmd, 3) : NULL);
1077 void Cvar_SetA_f(cmd_state_t *cmd)
1079 cvar_state_t *cvars = cmd->cvars;
1082 // make sure it's the right number of parameters
1083 if (Cmd_Argc(cmd) < 3)
1085 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
1089 // check if it's read-only
1090 cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1092 if(Cvar_Readonly(cvar,"SetA"))
1095 if (developer_extra.integer)
1096 Con_DPrint("SetA: ");
1098 // all looks ok, create/modify the cvar
1099 Cvar_Get(cvars, Cmd_Argv(cmd, 1), Cmd_Argv(cmd, 2), cmd->cvars_flagsmask | CF_ARCHIVE, Cmd_Argc(cmd) > 3 ? Cmd_Argv(cmd, 3) : NULL);
1102 void Cvar_Del_f(cmd_state_t *cmd)
1104 cvar_state_t *cvars = cmd->cvars;
1106 cvar_t *parent, **link;
1107 cvar_t *cvar, *prev;
1108 cvar_hash_t **hashlinkptr, *oldhashlink;
1110 if(Cmd_Argc(cmd) < 2)
1112 Con_Printf("%s: wrong number of parameters, usage: unset <variablename1> [<variablename2> ...]\n", Cmd_Argv(cmd, 0));
1115 for(i = 1; i < Cmd_Argc(cmd); ++i)
1117 hashlinkptr = Cvar_FindVarLink(cvars, Cmd_Argv(cmd, i), &parent, &link, &prev, ~0);
1121 Con_Printf("%s: %s is not defined\n", Cmd_Argv(cmd, 0), Cmd_Argv(cmd, i));
1124 cvar = (*hashlinkptr)->cvar;
1126 if(Cvar_Readonly(cvar, Cmd_Argv(cmd, 0)))
1128 if(!(cvar->flags & CF_ALLOCATED))
1130 Con_Printf(CON_WARN "%s: %s is static and cannot be deleted\n", Cmd_Argv(cmd, 0), cvar->name);
1134 if(cvar == cvars->vars)
1136 cvars->vars = cvar->next;
1140 // in this case, prev must be set, otherwise there has been some inconsistensy
1141 // elsewhere already... should I still check for prev != NULL?
1142 prev->next = cvar->next;
1146 parent->next = cvar->next;
1149 if(cvar->description != cvar_dummy_description)
1150 Z_Free((char *)cvar->description);
1152 Z_Free((char *)cvar->name);
1153 Z_Free((char *)cvar->string);
1154 Z_Free((char *)cvar->defstring);
1157 oldhashlink = *hashlinkptr;
1158 *hashlinkptr = (*hashlinkptr)->next;
1159 Z_Free(oldhashlink);
1163 #ifdef FILLALLCVARSWITHRUBBISH
1164 void Cvar_FillAll_f(cmd_state_t *cmd)
1170 if(Cmd_Argc(cmd) != 2)
1172 Con_Printf("Usage: %s length to plant rubbish\n", Cmd_Argv(cmd, 0));
1173 Con_Printf("Usage: %s -length to verify that the rubbish is still there\n", Cmd_Argv(cmd, 0));
1176 n = atoi(Cmd_Argv(cmd, 1));
1180 buf = Z_Malloc(n + 1);
1182 for(var = cvars->vars; var; var = var->next)
1184 for(i = 0, p = buf, q = var->name; i < n; ++i)
1190 if(verify && strcmp(var->string, buf))
1192 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);
1194 Cvar_SetQuick(var, buf);
1198 #endif /* FILLALLCVARSWITHRUBBISH */