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 char *cvar_null_string = "";
32 cvar_t *Cvar_FindVar (const char *var_name)
36 for (var = cvar_vars;var;var = var->next)
37 if (!strcasecmp (var_name, var->name))
43 cvar_t *Cvar_FindVarAfter (const char *prev_var_name, int neededflags)
49 var = Cvar_FindVar (prev_var_name);
57 // search for the next cvar matching the needed flags
60 if ((var->flags & neededflags) || !neededflags)
72 float Cvar_VariableValue (const char *var_name)
76 var = Cvar_FindVar (var_name);
79 return atof (var->string);
88 const char *Cvar_VariableString (const char *var_name)
92 var = Cvar_FindVar (var_name);
94 return cvar_null_string;
100 Cvar_VariableDefString
103 const char *Cvar_VariableDefString (const char *var_name)
107 var = Cvar_FindVar (var_name);
109 return cvar_null_string;
110 return var->defstring;
116 Cvar_CompleteVariable
119 const char *Cvar_CompleteVariable (const char *partial)
124 len = strlen(partial);
130 for (cvar=cvar_vars ; cvar ; cvar=cvar->next)
131 if (!strncasecmp (partial,cvar->name, len))
139 CVar_CompleteCountPossible
141 New function for tab-completion system
143 Thanks to Fett erich@heintz.com
146 int Cvar_CompleteCountPossible (const char *partial)
153 len = strlen(partial);
158 // Loop through the cvars and count all possible matches
159 for (cvar = cvar_vars; cvar; cvar = cvar->next)
160 if (!strncasecmp(partial, cvar->name, len))
167 CVar_CompleteBuildList
169 New function for tab-completion system
171 Thanks to Fett erich@heintz.com
175 const char **Cvar_CompleteBuildList (const char *partial)
180 size_t sizeofbuf = (Cvar_CompleteCountPossible (partial) + 1) * sizeof (const char *);
183 len = strlen(partial);
184 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
185 // Loop through the alias list and print all matches
186 for (cvar = cvar_vars; cvar; cvar = cvar->next)
187 if (!strncasecmp(partial, cvar->name, len))
188 buf[bpos++] = cvar->name;
194 // written by LordHavoc
195 void Cvar_CompleteCvarPrint (const char *partial)
198 size_t len = strlen(partial);
199 // Loop through the command list and print all matches
200 for (cvar = cvar_vars; cvar; cvar = cvar->next)
201 if (!strncasecmp(partial, cvar->name, len))
202 Con_Printf("%s : \"%s\" (\"%s\") : %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
211 void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
215 changed = strcmp(var->string, value);
216 // LordHavoc: don't reallocate when there is no change
220 // LordHavoc: don't reallocate when the buffer is the same size
221 if (!var->string || strlen(var->string) != strlen(value))
223 Z_Free (var->string); // free the old value string
225 var->string = (char *)Z_Malloc (strlen(value)+1);
227 strcpy (var->string, value);
228 var->value = atof (var->string);
229 var->integer = (int) var->value;
230 if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
231 SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
233 // TODO: add infostring support to the server?
234 if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
236 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
239 MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
240 MSG_WriteString (&sv.reliable_datagram, var->name);
241 MSG_WriteString (&sv.reliable_datagram, var->string);
245 if ((var->flags & CVAR_USERINFO) && changed && cls.state != ca_dedicated)
247 InfoString_SetValue(cls.userinfo, sizeof(cls.userinfo), var->name, var->string);
248 if (cls.state == ca_connected)
249 Cmd_ForwardStringToServer(va("setinfo \"%s\" \"%s\"\n", var->name, var->string));
253 void Cvar_SetQuick (cvar_t *var, const char *value)
257 Con_Print("Cvar_SetQuick: var == NULL\n");
261 if (developer.integer)
262 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
264 Cvar_SetQuick_Internal(var, value);
267 void Cvar_Set (const char *var_name, const char *value)
270 var = Cvar_FindVar (var_name);
273 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
276 Cvar_SetQuick(var, value);
284 void Cvar_SetValueQuick(cvar_t *var, float value)
286 char val[MAX_INPUTLINE];
288 if ((float)((int)value) == value)
289 sprintf(val, "%i", (int)value);
291 sprintf(val, "%f", value);
292 Cvar_SetQuick(var, val);
295 void Cvar_SetValue(const char *var_name, float value)
297 char val[MAX_INPUTLINE];
299 if ((float)((int)value) == value)
300 sprintf(val, "%i", (int)value);
302 sprintf(val, "%f", value);
303 Cvar_Set(var_name, val);
308 Cvar_RegisterVariable
310 Adds a freestanding variable to the variable list.
313 void Cvar_RegisterVariable (cvar_t *variable)
315 cvar_t *current, *next, *cvar;
318 if (developer.integer)
319 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
321 // first check to see if it has already been defined
322 cvar = Cvar_FindVar (variable->name);
325 if (cvar->flags & CVAR_ALLOCATED)
327 if (developer.integer)
328 Con_Printf("... replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
329 // fixed variables replace allocated ones
330 // (because the engine directly accesses fixed variables)
331 // NOTE: this isn't actually used currently
332 // (all cvars are registered before config parsing)
333 variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
334 // cvar->string is now owned by variable instead
335 variable->string = cvar->string;
336 variable->defstring = cvar->defstring;
337 variable->value = atof (variable->string);
338 variable->integer = (int) variable->value;
339 // replace cvar with this one...
340 variable->next = cvar->next;
341 if (cvar_vars == cvar)
343 // head of the list is easy to change
344 cvar_vars = variable;
348 // otherwise find it somewhere in the list
349 for (current = cvar_vars;current->next != cvar;current = current->next)
351 current->next = variable;
354 // get rid of old allocated cvar
355 // (but not cvar->string and cvar->defstring, because we kept those)
360 Con_Printf("Can't register variable %s, already defined\n", variable->name);
364 // check for overlap with a command
365 if (Cmd_Exists (variable->name))
367 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
371 // copy the value off, because future sets will Z_Free it
372 oldstr = variable->string;
373 variable->string = (char *)Z_Malloc (strlen(variable->string)+1);
374 strcpy (variable->string, oldstr);
375 variable->defstring = (char *)Z_Malloc (strlen(variable->string)+1);
376 strcpy (variable->defstring, oldstr);
377 variable->value = atof (variable->string);
378 variable->integer = (int) variable->value;
380 // link the variable in
381 // alphanumerical order
382 for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
385 current->next = variable;
387 cvar_vars = variable;
389 variable->next = next;
396 Adds a newly allocated variable to the variable list or sets its value.
399 cvar_t *Cvar_Get (const char *name, const char *value, int flags)
403 if (developer.integer)
404 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
406 // first check to see if it has already been defined
407 cvar = Cvar_FindVar (name);
410 cvar->flags |= flags;
411 Cvar_SetQuick_Internal (cvar, value);
412 // also set the default value (but only once)
413 if (~cvar->flags & CVAR_DEFAULTSET)
415 cvar->flags |= CVAR_DEFAULTSET;
417 Z_Free(cvar->defstring);
418 cvar->defstring = (char *)Z_Malloc(strlen(value) + 1);
419 strcpy(cvar->defstring, value);
424 // check for overlap with a command
425 if (Cmd_Exists (name))
427 Con_Printf("Cvar_Get: %s is a command\n", name);
431 // allocate a new cvar, cvar name, and cvar string
432 // FIXME: these never get Z_Free'd
433 cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
434 cvar->flags = flags | CVAR_ALLOCATED | CVAR_DEFAULTSET;
435 cvar->name = (char *)Z_Malloc(strlen(name)+1);
436 strcpy(cvar->name, name);
437 cvar->string = (char *)Z_Malloc(strlen(value)+1);
438 strcpy(cvar->string, value);
439 cvar->defstring = (char *)Z_Malloc(strlen(value)+1);
440 strcpy(cvar->defstring, value);
441 cvar->value = atof (cvar->string);
442 cvar->integer = (int) cvar->value;
443 cvar->description = "custom cvar";
445 // link the variable in
446 cvar->next = cvar_vars;
456 Handles variable inspection and changing from the console
459 qboolean Cvar_Command (void)
464 v = Cvar_FindVar (Cmd_Argv(0));
468 // perform a variable print or set
471 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
475 Con_DPrint("Cvar_Command: ");
477 if (v->flags & CVAR_READONLY)
479 Con_Printf("%s is read-only\n", v->name);
482 Cvar_Set (v->name, Cmd_Argv(1));
491 Writes lines containing "set variable value" for all variables
492 with the archive flag set to true.
495 void Cvar_WriteVariables (qfile_t *f)
499 for (var = cvar_vars ; var ; var = var->next)
500 if (var->flags & CVAR_SAVE)
501 FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
505 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
506 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
512 void Cvar_List_f (void)
521 partial = Cmd_Argv (1);
522 len = strlen(partial);
531 for (cvar = cvar_vars; cvar; cvar = cvar->next)
533 if (partial && strncasecmp (partial,cvar->name,len))
536 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
541 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
543 Con_Printf("%i cvar(s)\n", count);
545 // 2000-01-09 CvarList command by Maddes
547 void Cvar_Set_f (void)
551 // make sure it's the right number of parameters
554 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
558 // check if it's read-only
559 cvar = Cvar_FindVar(Cmd_Argv(1));
560 if (cvar && cvar->flags & CVAR_READONLY)
562 Con_Printf("Set: %s is read-only\n", cvar->name);
568 // all looks ok, create/modify the cvar
569 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
572 void Cvar_SetA_f (void)
576 // make sure it's the right number of parameters
579 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
583 // check if it's read-only
584 cvar = Cvar_FindVar(Cmd_Argv(1));
585 if (cvar && cvar->flags & CVAR_READONLY)
587 Con_Printf("SetA: %s is read-only\n", cvar->name);
591 Con_DPrint("SetA: ");
593 // all looks ok, create/modify the cvar
594 Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);