Eradicated the CVAR_NQUSERINFOHACK flag, for good
[xonotic/darkplaces.git] / cvar.c
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
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.
8
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.
12
13 See the GNU General Public License for more details.
14
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.
18
19 */
20 // cvar.c -- dynamic variable tracking
21
22 #include "quakedef.h"
23
24 const char *cvar_dummy_description = "custom cvar";
25 static const char *cvar_null_string = "";
26
27 cvar_state_t cvars_all;
28 cvar_state_t cvars_null;
29
30 /*
31 ============
32 Cvar_FindVar
33 ============
34 */
35 cvar_t *Cvar_FindVar(cvar_state_t *cvars, const char *var_name, int neededflags)
36 {
37         int hashindex;
38         cvar_hash_t *hash;
39
40         // use hash lookup to minimize search time
41         hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name)) % CVAR_HASHSIZE;
42         for (hash = cvars->hashtable[hashindex];hash;hash = hash->next)
43                 if (!strcmp (var_name, hash->cvar->name) && (hash->cvar->flags & neededflags))
44                         return hash->cvar;
45                 else
46                         for (int i = 0; i < hash->cvar->aliasindex; i++)
47                                 if (!strcmp (var_name, hash->cvar->aliases[i]) && (hash->cvar->flags & neededflags))
48                                         return hash->cvar;
49         return NULL;
50 }
51
52 cvar_t *Cvar_FindVarAfter(cvar_state_t *cvars, const char *prev_var_name, int neededflags)
53 {
54         cvar_t *var;
55
56         if (*prev_var_name)
57         {
58                 var = Cvar_FindVar(cvars, prev_var_name, neededflags);
59                 if (!var)
60                         return NULL;
61                 var = var->next;
62         }
63         else
64                 var = cvars->vars;
65
66         // search for the next cvar matching the needed flags
67         while (var)
68         {
69                 if (var->flags & neededflags)
70                         break;
71                 var = var->next;
72         }
73         return var;
74 }
75
76 static cvar_hash_t *Cvar_FindVarLink(cvar_state_t *cvars, const char *var_name, cvar_hash_t **parent, cvar_hash_t ***link, cvar_t **prev_alpha, int neededflags)
77 {
78         int hashindex;
79         cvar_hash_t *hash;
80
81         // use hash lookup to minimize search time
82         hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name)) % CVAR_HASHSIZE;
83         if(parent) *parent = NULL;
84         if(prev_alpha) *prev_alpha = NULL;
85         if(link) *link = &cvars->hashtable[hashindex];
86         for (hash = cvars->hashtable[hashindex];hash;hash = hash->next)
87         {
88                 if (!strcmp (var_name, hash->cvar->name) && (hash->cvar->flags & neededflags))
89                         goto match;
90                 else
91                         for (int i = 0; i < hash->cvar->aliasindex; i++)
92                                 if (!strcmp (var_name, hash->cvar->aliases[i]) && (hash->cvar->flags & neededflags))
93                                         goto match;
94                 if(parent) *parent = hash;
95         }
96         return NULL;
97 match:
98         if(!prev_alpha || hash->cvar == cvars->vars)
99                 return hash;
100
101         *prev_alpha = cvars->vars;
102         // if prev_alpha happens to become NULL then there has been some inconsistency elsewhere
103         // already - should I still insert '*prev_alpha &&' in the loop?
104         while((*prev_alpha)->next != hash->cvar)
105                 *prev_alpha = (*prev_alpha)->next;
106         return hash;
107 }
108
109 /*
110 ============
111 Cvar_VariableValue
112 ============
113 */
114 float Cvar_VariableValueOr(cvar_state_t *cvars, const char *var_name, float def, int neededflags)
115 {
116         cvar_t *var;
117
118         var = Cvar_FindVar(cvars, var_name, neededflags);
119         if (!var)
120                 return def;
121         return atof (var->string);
122 }
123
124 float Cvar_VariableValue(cvar_state_t *cvars, const char *var_name, int neededflags)
125 {
126         return Cvar_VariableValueOr(cvars, var_name, 0, neededflags);
127 }
128
129 /*
130 ============
131 Cvar_VariableString
132 ============
133 */
134 const char *Cvar_VariableStringOr(cvar_state_t *cvars, const char *var_name, const char *def, int neededflags)
135 {
136         cvar_t *var;
137
138         var = Cvar_FindVar(cvars, var_name, neededflags);
139         if (!var)
140                 return def;
141         return var->string;
142 }
143
144 const char *Cvar_VariableString(cvar_state_t *cvars, const char *var_name, int neededflags)
145 {
146         return Cvar_VariableStringOr(cvars, var_name, cvar_null_string, neededflags);
147 }
148
149 /*
150 ============
151 Cvar_VariableDefString
152 ============
153 */
154 const char *Cvar_VariableDefString(cvar_state_t *cvars, const char *var_name, int neededflags)
155 {
156         cvar_t *var;
157
158         var = Cvar_FindVar(cvars, var_name, neededflags);
159         if (!var)
160                 return cvar_null_string;
161         return var->defstring;
162 }
163
164 /*
165 ============
166 Cvar_VariableDescription
167 ============
168 */
169 const char *Cvar_VariableDescription(cvar_state_t *cvars, const char *var_name, int neededflags)
170 {
171         cvar_t *var;
172
173         var = Cvar_FindVar(cvars, var_name, neededflags);
174         if (!var)
175                 return cvar_null_string;
176         return var->description;
177 }
178
179
180 /*
181 ============
182 Cvar_CompleteVariable
183 ============
184 */
185 const char *Cvar_CompleteVariable(cvar_state_t *cvars, const char *partial, int neededflags)
186 {
187         cvar_t          *cvar;
188         size_t          len;
189
190         len = strlen(partial);
191
192         if (!len)
193                 return NULL;
194
195 // check functions
196         for (cvar=cvars->vars ; cvar ; cvar=cvar->next)
197                 if (!strncasecmp (partial,cvar->name, len) && (cvar->flags & neededflags))
198                         return cvar->name;
199
200         return NULL;
201 }
202
203
204 /*
205         CVar_CompleteCountPossible
206
207         New function for tab-completion system
208         Added by EvilTypeGuy
209         Thanks to Fett erich@heintz.com
210
211 */
212 int Cvar_CompleteCountPossible(cvar_state_t *cvars, const char *partial, int neededflags)
213 {
214         cvar_t  *cvar;
215         size_t  len;
216         int             h;
217
218         h = 0;
219         len = strlen(partial);
220
221         if (!len)
222                 return  0;
223
224         // Loop through the cvars and count all possible matches
225         for (cvar = cvars->vars; cvar; cvar = cvar->next)
226                 if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
227                         h++;
228                 else
229                         for(int i = 0; i < cvar->aliasindex; i++)
230                                 if (!strncasecmp(partial, cvar->aliases[i], len) && (cvar->flags & neededflags))
231                                         h++;
232                 
233         return h;
234 }
235
236 /*
237         CVar_CompleteBuildList
238
239         New function for tab-completion system
240         Added by EvilTypeGuy
241         Thanks to Fett erich@heintz.com
242         Thanks to taniwha
243
244 */
245 const char **Cvar_CompleteBuildList(cvar_state_t *cvars, const char *partial, int neededflags)
246 {
247         const cvar_t *cvar;
248         size_t len = 0;
249         size_t bpos = 0;
250         size_t sizeofbuf = (Cvar_CompleteCountPossible(cvars, partial, neededflags) + 1) * sizeof(const char *);
251         const char **buf;
252
253         len = strlen(partial);
254         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof(const char *));
255         // Loop through the alias list and print all matches
256         for (cvar = cvars->vars; cvar; cvar = cvar->next)
257                 if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
258                         buf[bpos++] = cvar->name;
259                 else
260                         for(int i = 0; i < cvar->aliasindex; i++)
261                                 if (!strncasecmp(partial, cvar->aliases[i], len) && (cvar->flags & neededflags))
262                                         buf[bpos++] = cvar->aliases[i];
263                 
264
265         buf[bpos] = NULL;
266         return buf;
267 }
268
269 void Cvar_PrintHelp(cvar_t *cvar, const char *name, qboolean full)
270 {
271         // Aliases are purple, cvars are yellow
272         if (strcmp(cvar->name, name))
273                 Con_Printf("^6");
274         else
275                 Con_Printf("^3");
276         Con_Printf("%s^7 is \"%s\" [\"%s\"]", name, ((cvar->flags & CVAR_PRIVATE) ? "********"/*hunter2*/ : cvar->string), cvar->defstring);
277         if (strcmp(cvar->name, name))
278                 Con_Printf(" (also ^3%s^7)", cvar->name);
279         if (full)
280                 Con_Printf(" %s", cvar->description);
281         Con_Printf("\n");
282 }
283
284 // written by LadyHavoc
285 void Cvar_CompleteCvarPrint(cvar_state_t *cvars, const char *partial, int neededflags)
286 {
287         cvar_t *cvar;
288         size_t len = strlen(partial);
289         // Loop through the command list and print all matches
290         for (cvar = cvars->vars; cvar; cvar = cvar->next)
291                 if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
292                         Cvar_PrintHelp(cvar, cvar->name, true);
293                 else
294                         for (int i = 0; i < cvar->aliasindex; i++)
295                                 if (!strncasecmp (partial, cvar->aliases[i], len) && (cvar->flags & neededflags))
296                                         Cvar_PrintHelp(cvar, cvar->aliases[i], true);
297
298                 
299 }
300
301 // check if a cvar is held by some progs
302 static qboolean Cvar_IsAutoCvar(cvar_t *var)
303 {
304         int i;
305         prvm_prog_t *prog;
306         for (i = 0;i < PRVM_PROG_MAX;i++)
307         {
308                 prog = &prvm_prog_list[i];
309                 if (prog->loaded && var->globaldefindex[i] >= 0)
310                         return true;
311         }
312         return false;
313 }
314
315 // we assume that prog is already set to the target progs
316 static void Cvar_UpdateAutoCvar(cvar_t *var)
317 {
318         int i;
319         int j;
320         const char *s;
321         vec3_t v;
322         prvm_prog_t *prog;
323         for (i = 0;i < PRVM_PROG_MAX;i++)
324         {
325                 prog = &prvm_prog_list[i];
326                 if (prog->loaded && var->globaldefindex[i] >= 0)
327                 {
328                         // MUST BE SYNCED WITH prvm_edict.c PRVM_LoadProgs
329                         switch(prog->globaldefs[var->globaldefindex[i]].type & ~DEF_SAVEGLOBAL)
330                         {
331                         case ev_float:
332                                 PRVM_GLOBALFIELDFLOAT(prog->globaldefs[var->globaldefindex[i]].ofs) = var->value;
333                                 break;
334                         case ev_vector:
335                                 s = var->string;
336                                 VectorClear(v);
337                                 for (j = 0;j < 3;j++)
338                                 {
339                                         while (*s && ISWHITESPACE(*s))
340                                                 s++;
341                                         if (!*s)
342                                                 break;
343                                         v[j] = atof(s);
344                                         while (!ISWHITESPACE(*s))
345                                                 s++;
346                                         if (!*s)
347                                                 break;
348                                 }
349                                 VectorCopy(v, PRVM_GLOBALFIELDVECTOR(prog->globaldefs[var->globaldefindex[i]].ofs));
350                                 break;
351                         case ev_string:
352                                 PRVM_ChangeEngineString(prog, var->globaldefindex_stringno[i], var->string);
353                                 PRVM_GLOBALFIELDSTRING(prog->globaldefs[var->globaldefindex[i]].ofs) = var->globaldefindex_stringno[i];
354                                 break;
355                         }
356                 }
357         }
358 }
359
360 // called after loading a savegame
361 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars)
362 {
363         cvar_t *var;
364         for (var = cvars->vars ; var ; var = var->next)
365                 Cvar_UpdateAutoCvar(var);
366 }
367
368 /*
369 ============
370 Cvar_Set
371 ============
372 */
373 extern cvar_t sv_disablenotify;
374 static void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
375 {
376         qboolean changed;
377         size_t valuelen;
378         char new_value[MAX_INPUTLINE];
379
380         changed = strcmp(var->string, value) != 0;
381         // LadyHavoc: don't reallocate when there is no change
382         if (!changed)
383                 return;
384
385         memcpy(new_value,value,MAX_INPUTLINE);
386
387         // Call the function stored in the cvar for bounds checking, cleanup, etc
388         if (var->callback)
389                 var->callback(new_value);
390
391         // LadyHavoc: don't reallocate when the buffer is the same size
392         valuelen = strlen(new_value);
393         if (!var->string || strlen(var->string) != valuelen)
394         {
395                 Z_Free ((char *)var->string);   // free the old value string
396
397                 var->string = (char *)Z_Malloc (valuelen + 1);
398         }
399         memcpy ((char *)var->string, new_value, valuelen + 1);
400         var->value = atof (var->string);
401         var->integer = (int) var->value;
402         if ((var->flags & CVAR_NOTIFY) && changed && sv.active && !sv_disablenotify.integer)
403                 SV_BroadcastPrintf("\003^3Server cvar \"%s\" changed to \"%s\"\n", var->name, var->string);
404 #if 0
405         // TODO: add infostring support to the server?
406         if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
407         {
408                 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
409                 if (sv.active)
410                 {
411                         MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
412                         MSG_WriteString (&sv.reliable_datagram, var->name);
413                         MSG_WriteString (&sv.reliable_datagram, var->string);
414                 }
415         }
416 #endif
417         if (var->flags & CVAR_USERINFO)
418                 CL_SetInfo(var->name, var->string, true, false, false, false);
419
420         Cvar_UpdateAutoCvar(var);
421 }
422
423 void Cvar_SetQuick (cvar_t *var, const char *value)
424 {
425         if (var == NULL)
426         {
427                 Con_Print("Cvar_SetQuick: var == NULL\n");
428                 return;
429         }
430
431         if (developer_extra.integer)
432                 Con_DPrintf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
433
434         Cvar_SetQuick_Internal(var, value);
435 }
436
437 void Cvar_Set(cvar_state_t *cvars, const char *var_name, const char *value)
438 {
439         cvar_t *var;
440         var = Cvar_FindVar(cvars, var_name, ~0);
441         if (var == NULL)
442         {
443                 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
444                 return;
445         }
446         Cvar_SetQuick(var, value);
447 }
448
449 void Cvar_Set_NoCallback(cvar_t *var, const char *value)
450 {
451         void (*callback_save)(char *) = var->callback;
452         var->callback = NULL;
453         Cvar_SetQuick_Internal(var, value);
454         var->callback = callback_save;
455 }
456
457 /*
458 ============
459 Cvar_SetValue
460 ============
461 */
462 void Cvar_SetValueQuick(cvar_t *var, float value)
463 {
464         char val[MAX_INPUTLINE];
465
466         if ((float)((int)value) == value)
467                 dpsnprintf(val, sizeof(val), "%i", (int)value);
468         else
469                 dpsnprintf(val, sizeof(val), "%f", value);
470         Cvar_SetQuick(var, val);
471 }
472
473 void Cvar_SetValue(cvar_state_t *cvars, const char *var_name, float value)
474 {
475         char val[MAX_INPUTLINE];
476
477         if ((float)((int)value) == value)
478                 dpsnprintf(val, sizeof(val), "%i", (int)value);
479         else
480                 dpsnprintf(val, sizeof(val), "%f", value);
481         Cvar_Set(cvars, var_name, val);
482 }
483
484 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(char *))
485 {
486         variable->callback = callback;
487 }
488
489 void Cvar_RegisterAlias(cvar_t *variable, const char *alias )
490 {
491         cvar_state_t *cvars = &cvars_all;
492         cvar_hash_t *hash;
493         int hashindex;
494
495         variable->aliases = (char **)Mem_Realloc(zonemempool, variable->aliases, sizeof(char *) * (variable->aliasindex + 1));
496         // Add to it
497         variable->aliases[variable->aliasindex] = (char *)Z_Malloc(strlen(alias) + 1);
498         memcpy(variable->aliases[variable->aliasindex], alias, strlen(alias) + 1);
499         variable->aliasindex++;
500
501         // link to head of list in this hash table index
502         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
503         hashindex = CRC_Block((const unsigned char *)alias, strlen(alias)) % CVAR_HASHSIZE;
504         hash->next = cvars->hashtable[hashindex];
505         cvars->hashtable[hashindex] = hash;
506         hash->cvar = variable;
507 }
508
509 /*
510 ============
511 Cvar_RegisterVariable
512
513 Adds a freestanding variable to the variable list.
514 ============
515 */
516 void Cvar_RegisterVariable (cvar_t *variable)
517 {
518         cvar_state_t *cvars = NULL;
519         int hashindex;
520         cvar_hash_t *hash;
521         cvar_t *current, *next, *cvar;
522         char *oldstr;
523         size_t alloclen;
524         int i;
525
526         switch (variable->flags & (CVAR_CLIENT | CVAR_SERVER))
527         {
528         case CVAR_CLIENT:
529         case CVAR_SERVER:
530         case CVAR_CLIENT | CVAR_SERVER:
531                 cvars = &cvars_all;
532                 break;
533         case 0:
534                 Sys_Error("Cvar_RegisterVariable({\"%s\", \"%s\", %i}) with no CVAR_CLIENT | CVAR_SERVER flags\n", variable->name, variable->string, variable->flags);
535                 break;
536         default:
537                 Sys_Error("Cvar_RegisterVariable({\"%s\", \"%s\", %i}) with weird CVAR_CLIENT | CVAR_SERVER flags\n", variable->name, variable->string, variable->flags);
538                 break;
539         }
540
541         if (developer_extra.integer)
542                 Con_DPrintf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
543
544 // first check to see if it has already been defined
545         cvar = Cvar_FindVar(cvars, variable->name, ~0);
546         if (cvar)
547         {
548                 if (cvar->flags & CVAR_ALLOCATED)
549                 {
550                         if (developer_extra.integer)
551                                 Con_DPrintf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
552                         // fixed variables replace allocated ones
553                         // (because the engine directly accesses fixed variables)
554                         // NOTE: this isn't actually used currently
555                         // (all cvars are registered before config parsing)
556                         variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
557                         // cvar->string is now owned by variable instead
558                         variable->string = cvar->string;
559                         variable->defstring = cvar->defstring;
560                         variable->value = atof (variable->string);
561                         variable->integer = (int) variable->value;
562                         // Preserve autocvar status.
563                         memcpy(variable->globaldefindex, cvar->globaldefindex, sizeof(variable->globaldefindex));
564                         memcpy(variable->globaldefindex_stringno, cvar->globaldefindex_stringno, sizeof(variable->globaldefindex_stringno));
565                         // replace cvar with this one...
566                         variable->next = cvar->next;
567                         if (cvars->vars == cvar)
568                         {
569                                 // head of the list is easy to change
570                                 cvars->vars = variable;
571                         }
572                         else
573                         {
574                                 // otherwise find it somewhere in the list
575                                 for (current = cvars->vars;current->next != cvar;current = current->next)
576                                         ;
577                                 current->next = variable;
578                         }
579
580                         // get rid of old allocated cvar
581                         // (but not cvar->string and cvar->defstring, because we kept those)
582                         Z_Free((char *)cvar->name);
583                         Z_Free(cvar);
584                 }
585                 else
586                         Con_DPrintf("Can't register variable %s, already defined\n", variable->name);
587                 return;
588         }
589
590 // check for overlap with a command
591         if (Cmd_Exists(&cmd_client, variable->name) || Cmd_Exists(&cmd_server, variable->name))
592         {
593                 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
594                 return;
595         }
596
597 // copy the value off, because future sets will Z_Free it
598         oldstr = (char *)variable->string;
599         alloclen = strlen(variable->string) + 1;
600         variable->string = (char *)Z_Malloc (alloclen);
601         memcpy ((char *)variable->string, oldstr, alloclen);
602         variable->defstring = (char *)Z_Malloc (alloclen);
603         memcpy ((char *)variable->defstring, oldstr, alloclen);
604         variable->value = atof (variable->string);
605         variable->integer = (int) variable->value;
606         variable->aliasindex = 0;
607
608         // Mark it as not an autocvar.
609         for (i = 0;i < PRVM_PROG_MAX;i++)
610                 variable->globaldefindex[i] = -1;
611
612 // link the variable in
613 // alphanumerical order
614         for( current = NULL, next = cvars->vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
615                 ;
616         if( current ) {
617                 current->next = variable;
618         } else {
619                 cvars->vars = variable;
620         }
621         variable->next = next;
622
623         // link to head of list in this hash table index
624         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
625         hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name)) % CVAR_HASHSIZE;
626         hash->next = cvars->hashtable[hashindex];
627         hash->cvar = variable;
628         cvars->hashtable[hashindex] = hash;
629 }
630
631 /*
632 ============
633 Cvar_Get
634
635 Adds a newly allocated variable to the variable list or sets its value.
636 ============
637 */
638 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription)
639 {
640         int hashindex;
641         cvar_hash_t *hash;
642         cvar_t *current, *next, *cvar;
643         int i;
644
645         if (developer_extra.integer)
646                 Con_DPrintf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
647
648 // first check to see if it has already been defined
649         cvar = Cvar_FindVar(cvars, name, ~0);
650         if (cvar)
651         {
652                 cvar->flags |= flags;
653                 Cvar_SetQuick_Internal (cvar, value);
654                 if(newdescription && (cvar->flags & CVAR_ALLOCATED))
655                 {
656                         if(cvar->description != cvar_dummy_description)
657                                 Z_Free((char *)cvar->description);
658
659                         if(*newdescription)
660                                 cvar->description = (char *)Mem_strdup(zonemempool, newdescription);
661                         else
662                                 cvar->description = cvar_dummy_description;
663                 }
664                 return cvar;
665         }
666
667 // check for pure evil
668         if (!*name)
669         {
670                 Con_Printf("Cvar_Get: invalid variable name\n");
671                 return NULL;
672         }
673
674 // check for overlap with a command
675         if (Cmd_Exists(&cmd_client, name) || Cmd_Exists(&cmd_server, name))
676         {
677                 Con_Printf("Cvar_Get: %s is a command\n", name);
678                 return NULL;
679         }
680
681 // allocate a new cvar, cvar name, and cvar string
682 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
683 // FIXME: these never get Z_Free'd
684         cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
685         cvar->flags = flags | CVAR_ALLOCATED;
686         cvar->name = (char *)Mem_strdup(zonemempool, name);
687         cvar->string = (char *)Mem_strdup(zonemempool, value);
688         cvar->defstring = (char *)Mem_strdup(zonemempool, value);
689         cvar->value = atof (cvar->string);
690         cvar->integer = (int) cvar->value;
691         cvar->aliases = (char **)Z_Malloc(sizeof(char **));
692         memset(cvar->aliases, 0, sizeof(char *));
693
694         if(newdescription && *newdescription)
695                 cvar->description = (char *)Mem_strdup(zonemempool, newdescription);
696         else
697                 cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
698
699         // Mark it as not an autocvar.
700         for (i = 0;i < PRVM_PROG_MAX;i++)
701                 cvar->globaldefindex[i] = -1;
702
703 // link the variable in
704 // alphanumerical order
705         for( current = NULL, next = cvars->vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
706                 ;
707         if( current )
708                 current->next = cvar;
709         else
710                 cvars->vars = cvar;
711         cvar->next = next;
712
713         // link to head of list in this hash table index
714         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
715         hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name)) % CVAR_HASHSIZE;
716         hash->next = cvars->hashtable[hashindex];
717         cvars->hashtable[hashindex] = hash;
718         hash->cvar = cvar;
719
720         return cvar;
721 }
722
723 qboolean Cvar_Readonly (cvar_t *var, const char *cmd_name)
724 {
725         if (var->flags & CVAR_READONLY)
726         {
727                 if(cmd_name)
728                         Con_Printf("%s: ",cmd_name);
729                 Con_Printf("%s", var->name);
730                 Con_Printf(" is read-only\n");
731                 return true;
732         }
733         return false;
734 }
735
736 /*
737 ============
738 Cvar_Command
739
740 Handles variable inspection and changing from the console
741 ============
742 */
743 qboolean        Cvar_Command (cmd_state_t *cmd)
744 {
745         cvar_state_t    *cvars = cmd->cvars;
746         cvar_t                  *v;
747
748 // check variables
749         v = Cvar_FindVar(cvars, Cmd_Argv(cmd, 0), (cmd->cvars_flagsmask));
750         if (!v)
751                 return false;
752
753 // perform a variable print or set
754         if (Cmd_Argc(cmd) == 1)
755         {
756                 Cvar_PrintHelp(v, Cmd_Argv(cmd, 0), true);
757                 return true;
758         }
759
760         if (developer_extra.integer)
761                 Con_DPrint("Cvar_Command: ");
762         
763         if(Cvar_Readonly(v, NULL))
764                 return true;
765         
766         Cvar_SetQuick(v, Cmd_Argv(cmd, 1));
767         if (developer_extra.integer)
768                 Con_DPrint("\n");
769         return true;
770 }
771
772
773 void Cvar_UnlockDefaults(cmd_state_t *cmd)
774 {
775         cvar_state_t *cvars = cmd->cvars;
776         cvar_t *var;
777         // unlock the default values of all cvars
778         for (var = cvars->vars ; var ; var = var->next)
779                 var->flags &= ~CVAR_DEFAULTSET;
780 }
781
782
783 void Cvar_LockDefaults_f(cmd_state_t *cmd)
784 {
785         cvar_state_t *cvars = cmd->cvars;
786         cvar_t *var;
787         // lock in the default values of all cvars
788         for (var = cvars->vars ; var ; var = var->next)
789         {
790                 if (!(var->flags & CVAR_DEFAULTSET))
791                 {
792                         size_t alloclen;
793
794                         //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
795                         var->flags |= CVAR_DEFAULTSET;
796                         Z_Free((char *)var->defstring);
797                         alloclen = strlen(var->string) + 1;
798                         var->defstring = (char *)Z_Malloc(alloclen);
799                         memcpy((char *)var->defstring, var->string, alloclen);
800                 }
801         }
802 }
803
804 void Cvar_SaveInitState(cvar_state_t *cvars)
805 {
806         cvar_t *c;
807         for (c = cvars->vars;c;c = c->next)
808         {
809                 c->initstate = true;
810                 c->initflags = c->flags;
811                 c->initdefstring = Mem_strdup(zonemempool, c->defstring);
812                 c->initstring = Mem_strdup(zonemempool, c->string);
813                 c->initvalue = c->value;
814                 c->initinteger = c->integer;
815                 VectorCopy(c->vector, c->initvector);
816         }
817 }
818
819 void Cvar_RestoreInitState(cvar_state_t *cvars)
820 {
821         int hashindex;
822         cvar_t *c, **cp;
823         cvar_t *c2, **cp2;
824         for (cp = &cvars->vars;(c = *cp);)
825         {
826                 if (c->initstate)
827                 {
828                         // restore this cvar, it existed at init
829                         if (((c->flags ^ c->initflags) & CVAR_MAXFLAGSVAL)
830                          || strcmp(c->defstring ? c->defstring : "", c->initdefstring ? c->initdefstring : "")
831                          || strcmp(c->string ? c->string : "", c->initstring ? c->initstring : ""))
832                         {
833                                 Con_DPrintf("Cvar_RestoreInitState: Restoring cvar \"%s\"\n", c->name);
834                                 if (c->defstring)
835                                         Z_Free((char *)c->defstring);
836                                 c->defstring = Mem_strdup(zonemempool, c->initdefstring);
837                                 if (c->string)
838                                         Z_Free((char *)c->string);
839                                 c->string = Mem_strdup(zonemempool, c->initstring);
840                         }
841                         c->flags = c->initflags;
842                         c->value = c->initvalue;
843                         c->integer = c->initinteger;
844                         VectorCopy(c->initvector, c->vector);
845                         cp = &c->next;
846                 }
847                 else
848                 {
849                         if (!(c->flags & CVAR_ALLOCATED))
850                         {
851                                 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it was registered after init!\n", c->name);
852                                 // In this case, at least reset it to the default.
853                                 if((c->flags & CVAR_NORESETTODEFAULTS) == 0)
854                                         Cvar_SetQuick(c, c->defstring);
855                                 cp = &c->next;
856                                 continue;
857                         }
858                         if (Cvar_IsAutoCvar(c))
859                         {
860                                 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it is an autocvar used by running progs!\n", c->name);
861                                 // In this case, at least reset it to the default.
862                                 if((c->flags & CVAR_NORESETTODEFAULTS) == 0)
863                                         Cvar_SetQuick(c, c->defstring);
864                                 cp = &c->next;
865                                 continue;
866                         }
867                         // remove this cvar, it did not exist at init
868                         Con_DPrintf("Cvar_RestoreInitState: Destroying cvar \"%s\"\n", c->name);
869                         // unlink struct from hash
870                         hashindex = CRC_Block((const unsigned char *)c->name, strlen(c->name)) % CVAR_HASHSIZE;
871                         for (cp2 = &cvars->hashtable[hashindex]->cvar;(c2 = *cp2);)
872                         {
873                                 if (c2 == c)
874                                 {
875                                         *cp2 = cvars->hashtable[hashindex]->next->cvar;
876                                         break;
877                                 }
878                                 else
879                                         cp2 = &cvars->hashtable[hashindex]->next->cvar;
880                         }
881                         // unlink struct from main list
882                         *cp = c->next;
883                         // free strings
884                         if (c->defstring)
885                                 Z_Free((char *)c->defstring);
886                         if (c->string)
887                                 Z_Free((char *)c->string);
888                         if (c->description && c->description != cvar_dummy_description)
889                                 Z_Free((char *)c->description);
890                         // free struct
891                         Z_Free(c);
892                 }
893         }
894 }
895
896 void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd)
897 {
898         cvar_state_t *cvars = cmd->cvars;
899         cvar_t *var;
900         // restore the default values of all cvars
901         for (var = cvars->vars ; var ; var = var->next)
902         {
903                 if((var->flags & CVAR_NORESETTODEFAULTS) == 0)
904                         Cvar_SetQuick(var, var->defstring);
905         }
906 }
907
908
909 void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd)
910 {
911         cvar_state_t *cvars = cmd->cvars;
912         cvar_t *var;
913         // restore the default values of all cvars
914         for (var = cvars->vars ; var ; var = var->next)
915         {
916                 if ((var->flags & (CVAR_NORESETTODEFAULTS | CVAR_SAVE)) == 0)
917                         Cvar_SetQuick(var, var->defstring);
918         }
919 }
920
921
922 void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd)
923 {
924         cvar_state_t *cvars = cmd->cvars;
925         cvar_t *var;
926         // restore the default values of all cvars
927         for (var = cvars->vars ; var ; var = var->next)
928         {
929                 if ((var->flags & (CVAR_NORESETTODEFAULTS | CVAR_SAVE)) == CVAR_SAVE)
930                         Cvar_SetQuick(var, var->defstring);
931         }
932 }
933
934
935 /*
936 ============
937 Cvar_WriteVariables
938
939 Writes lines containing "set variable value" for all variables
940 with the archive flag set to true.
941 ============
942 */
943 void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f)
944 {
945         cvar_t  *var;
946         char buf1[MAX_INPUTLINE], buf2[MAX_INPUTLINE];
947
948         // don't save cvars that match their default value
949         for (var = cvars->vars ; var ; var = var->next) {
950                 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || ((var->flags & CVAR_ALLOCATED) && !(var->flags & CVAR_DEFAULTSET))))
951                 {
952                         Cmd_QuoteString(buf1, sizeof(buf1), var->name, "\"\\$", false);
953                         Cmd_QuoteString(buf2, sizeof(buf2), var->string, "\"\\$", false);
954                         FS_Printf(f, "%s\"%s\" \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", buf1, buf2);
955                 }
956         }
957 }
958
959
960 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
961 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
962 /*
963 =========
964 Cvar_List
965 =========
966 */
967 void Cvar_List_f(cmd_state_t *cmd)
968 {
969         cvar_state_t *cvars = cmd->cvars;
970         cvar_t *cvar;
971         const char *partial;
972         int count;
973         qboolean ispattern;
974         char vabuf[1024];
975
976         if (Cmd_Argc(cmd) > 1)
977         {
978                 partial = Cmd_Argv(cmd, 1);
979                 ispattern = (strchr(partial, '*') || strchr(partial, '?'));
980                 if(!ispattern)
981                         partial = va(vabuf, sizeof(vabuf), "%s*", partial);
982         }
983         else
984         {
985                 partial = va(vabuf, sizeof(vabuf), "*");
986                 ispattern = false;
987         }
988
989         count = 0;
990         for (cvar = cvars->vars; cvar; cvar = cvar->next)
991         {
992                 if (matchpattern_with_separator(cvar->name, partial, false, "", false))
993                 {
994                         Cvar_PrintHelp(cvar, cvar->name, true);
995                         count++;
996                 }
997                 for (int i = 0; i < cvar->aliasindex; i++)
998                 {
999                         if (matchpattern_with_separator(cvar->aliases[i], partial, false, "", false))
1000                         {
1001                                 Cvar_PrintHelp(cvar, cvar->aliases[i], true);
1002                                 count++;
1003                         }
1004                 }
1005         }
1006
1007         if (Cmd_Argc(cmd) > 1)
1008         {
1009                 if(ispattern)
1010                         Con_Printf("%i cvar%s matching \"%s\"\n", count, (count > 1) ? "s" : "", partial);
1011                 else
1012                         Con_Printf("%i cvar%s beginning with \"%s\"\n", count, (count > 1) ? "s" : "", Cmd_Argv(cmd,1));
1013         }
1014         else
1015                 Con_Printf("%i cvar(s)\n", count);
1016 }
1017 // 2000-01-09 CvarList command by Maddes
1018
1019 void Cvar_Set_f(cmd_state_t *cmd)
1020 {
1021         cvar_state_t *cvars = cmd->cvars;
1022         cvar_t *cvar;
1023
1024         // make sure it's the right number of parameters
1025         if (Cmd_Argc(cmd) < 3)
1026         {
1027                 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
1028                 return;
1029         }
1030
1031         // check if it's read-only
1032         cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1033         if (cvar)
1034                 if(Cvar_Readonly(cvar,"Set"))
1035                         return;
1036
1037         if (developer_extra.integer)
1038                 Con_DPrint("Set: ");
1039
1040         // all looks ok, create/modify the cvar
1041         Cvar_Get(cvars, Cmd_Argv(cmd, 1), Cmd_Argv(cmd, 2), cmd->cvars_flagsmask, Cmd_Argc(cmd) > 3 ? Cmd_Argv(cmd, 3) : NULL);
1042 }
1043
1044 void Cvar_SetA_f(cmd_state_t *cmd)
1045 {
1046         cvar_state_t *cvars = cmd->cvars;
1047         cvar_t *cvar;
1048
1049         // make sure it's the right number of parameters
1050         if (Cmd_Argc(cmd) < 3)
1051         {
1052                 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
1053                 return;
1054         }
1055
1056         // check if it's read-only
1057         cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1058         if (cvar)
1059                 if(Cvar_Readonly(cvar,"SetA"))
1060                         return;
1061
1062         if (developer_extra.integer)
1063                 Con_DPrint("SetA: ");
1064
1065         // all looks ok, create/modify the cvar
1066         Cvar_Get(cvars, Cmd_Argv(cmd, 1), Cmd_Argv(cmd, 2), cmd->cvars_flagsmask | CVAR_SAVE, Cmd_Argc(cmd) > 3 ? Cmd_Argv(cmd, 3) : NULL);
1067 }
1068
1069 void Cvar_Del_f(cmd_state_t *cmd)
1070 {
1071         cvar_state_t *cvars = cmd->cvars;
1072         int neededflags = ~0;
1073         int i;
1074         cvar_hash_t *hash, *parent, **link;
1075         cvar_t *cvar, *prev;
1076
1077         if(Cmd_Argc(cmd) < 2)
1078         {
1079                 Con_Printf("%s: wrong number of parameters, usage: unset <variablename1> [<variablename2> ...]\n", Cmd_Argv(cmd, 0));
1080                 return;
1081         }
1082         for(i = 1; i < Cmd_Argc(cmd); ++i)
1083         {
1084                 hash = Cvar_FindVarLink(cvars, Cmd_Argv(cmd, i), &parent, &link, &prev, neededflags);
1085                 cvar = hash->cvar;
1086
1087                 if(!cvar)
1088                 {
1089                         Con_Printf("%s: %s is not defined\n", Cmd_Argv(cmd, 0), Cmd_Argv(cmd, i));
1090                         continue;
1091                 }
1092                 if(Cvar_Readonly(cvar, Cmd_Argv(cmd, 0)))
1093                         continue;
1094                 if(!(cvar->flags & CVAR_ALLOCATED))
1095                 {
1096                         Con_Printf("%s: %s is static and cannot be deleted\n", Cmd_Argv(cmd, 0), cvar->name);
1097                         continue;
1098                 }
1099                 if(cvar == cvars->vars)
1100                 {
1101                         cvars->vars = cvar->next;
1102                 }
1103                 else
1104                 {
1105                         // in this case, prev must be set, otherwise there has been some inconsistensy
1106                         // elsewhere already... should I still check for prev != NULL?
1107                         prev->next = cvar->next;
1108                 }
1109
1110                 if(parent)
1111                         parent->next = hash->next;
1112                 else if(link)
1113                         *link = hash->next;
1114                 if(cvar->description != cvar_dummy_description)
1115                         Z_Free((char *)cvar->description);
1116
1117                 Z_Free((char *)cvar->name);
1118                 Z_Free((char *)cvar->string);
1119                 Z_Free((char *)cvar->defstring);
1120                 Z_Free(cvar);
1121         }
1122 }
1123
1124 #ifdef FILLALLCVARSWITHRUBBISH
1125 void Cvar_FillAll_f(cmd_state_t *cmd)
1126 {
1127         char *buf, *p, *q;
1128         int n, i;
1129         cvar_t *var;
1130         qboolean verify;
1131         if(Cmd_Argc(cmd) != 2)
1132         {
1133                 Con_Printf("Usage: %s length to plant rubbish\n", Cmd_Argv(cmd, 0));
1134                 Con_Printf("Usage: %s -length to verify that the rubbish is still there\n", Cmd_Argv(cmd, 0));
1135                 return;
1136         }
1137         n = atoi(Cmd_Argv(cmd, 1));
1138         verify = (n < 0);
1139         if(verify)
1140                 n = -n;
1141         buf = Z_Malloc(n + 1);
1142         buf[n] = 0;
1143         for(var = cvars->vars; var; var = var->next)
1144         {
1145                 for(i = 0, p = buf, q = var->name; i < n; ++i)
1146                 {
1147                         *p++ = *q++;
1148                         if(!*q)
1149                                 q = var->name;
1150                 }
1151                 if(verify && strcmp(var->string, buf))
1152                 {
1153                         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);
1154                 }
1155                 Cvar_SetQuick(var, buf);
1156         }
1157         Z_Free(buf);
1158 }
1159 #endif /* FILLALLCVARSWITHRUBBISH */