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_t *Cvar_FindVarLink(cvar_state_t *cvars, const char *var_name, cvar_t **parent, cvar_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]->cvar;
  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->cvar;
  95         }
  96         return NULL;
  97 match:
  98         if(!prev_alpha || hash->cvar == cvars->vars)
  99                 return hash->cvar;
 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->cvar;
 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, qbool 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 & CF_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 qbool 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         qbool changed;
 377         size_t valuelen;
 378
 379         changed = strcmp(var->string, value) != 0;
 380         // LadyHavoc: don't reallocate when there is no change
 381         if (!changed)
 382                 return;
 383
 384         // LadyHavoc: don't reallocate when the buffer is the same size
 385         valuelen = strlen(value);
 386         if (!var->string || strlen(var->string) != valuelen)
 387         {
 388                 Z_Free ((char *)var->string);   // free the old value string
 389
 390                 var->string = (char *)Z_Malloc (valuelen + 1);
 391         }
 392         memcpy ((char *)var->string, value, valuelen + 1);
 393         var->value = atof (var->string);
 394         var->integer = (int) var->value;
 395         if ((var->flags & CF_NOTIFY) && sv.active && !sv_disablenotify.integer)
 396                 SV_BroadcastPrintf("\003^3Server cvar \"%s\" changed to \"%s\"\n", var->name, var->string);
 397 #if 0
 398         // TODO: add infostring support to the server?
 399         if ((var->flags & CF_SERVERINFO) && changed && sv.active)
 400         {
 401                 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
 402                 if (sv.active)
 403                 {
 404                         MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
 405                         MSG_WriteString (&sv.reliable_datagram, var->name);
 406                         MSG_WriteString (&sv.reliable_datagram, var->string);
 407                 }
 408         }
 409 #endif
 410         if (var->flags & CF_USERINFO)
 411                 CL_SetInfo(var->name, var->string, true, false, false, false);
 412
 413         Cvar_UpdateAutoCvar(var);
 414
 415         // Call the function stored in the cvar for bounds checking, cleanup, etc
 416         if (var->callback)
 417                 var->callback(var);
 418 }
 419
 420 void Cvar_SetQuick (cvar_t *var, const char *value)
 421 {
 422         if (var == NULL)
 423         {
 424                 Con_Print("Cvar_SetQuick: var == NULL\n");
 425                 return;
 426         }
 427
 428         if (developer_extra.integer)
 429                 Con_DPrintf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
 430
 431         Cvar_SetQuick_Internal(var, value);
 432 }
 433
 434 void Cvar_Set(cvar_state_t *cvars, const char *var_name, const char *value)
 435 {
 436         cvar_t *var;
 437         var = Cvar_FindVar(cvars, var_name, ~0);
 438         if (var == NULL)
 439         {
 440                 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
 441                 return;
 442         }
 443         Cvar_SetQuick(var, value);
 444 }
 445
 446 /*
 447 ============
 448 Cvar_SetValue
 449 ============
 450 */
 451 void Cvar_SetValueQuick(cvar_t *var, float value)
 452 {
 453         char val[MAX_INPUTLINE];
 454
 455         if ((float)((int)value) == value)
 456                 dpsnprintf(val, sizeof(val), "%i", (int)value);
 457         else
 458                 dpsnprintf(val, sizeof(val), "%f", value);
 459         Cvar_SetQuick(var, val);
 460 }
 461
 462 void Cvar_SetValue(cvar_state_t *cvars, const char *var_name, 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_Set(cvars, var_name, val);
 471 }
 472
 473 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *))
 474 {
 475         variable->callback = callback;
 476 }
 477
 478 void Cvar_RegisterAlias(cvar_t *variable, const char *alias )
 479 {
 480         cvar_state_t *cvars = &cvars_all;
 481         cvar_hash_t *hash;
 482         int hashindex;
 483
 484         variable->aliases = (char **)Mem_Realloc(zonemempool, variable->aliases, sizeof(char *) * (variable->aliasindex + 1));
 485         // Add to it
 486         variable->aliases[variable->aliasindex] = (char *)Z_Malloc(strlen(alias) + 1);
 487         memcpy(variable->aliases[variable->aliasindex], alias, strlen(alias) + 1);
 488         variable->aliasindex++;
 489
 490         // link to head of list in this hash table index
 491         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
 492         hashindex = CRC_Block((const unsigned char *)alias, strlen(alias)) % CVAR_HASHSIZE;
 493         hash->next = cvars->hashtable[hashindex];
 494         cvars->hashtable[hashindex] = hash;
 495         hash->cvar = variable;
 496 }
 497
 498 /*
 499 ============
 500 Cvar_Link
 501
 502 Links a variable to the variable list and hashtable
 503 ============
 504 */
 505 static void Cvar_Link(cvar_t *variable, cvar_state_t *cvars)
 506 {
 507         cvar_t *current, *next;
 508         cvar_hash_t *hash;
 509         int hashindex;
 510         /*
 511          * Link the variable in
 512          * alphanumerical order
 513          */
 514         for( current = NULL, next = cvars->vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
 515                 ;
 516         if(current)
 517                 current->next = variable;
 518         else
 519                 cvars->vars = variable;
 520         variable->next = next;
 521
 522         // link to head of list in this hash table index
 523         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
 524         hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name)) % CVAR_HASHSIZE;
 525         hash->next = cvars->hashtable[hashindex];
 526         hash->cvar = variable;
 527         cvars->hashtable[hashindex] = hash;
 528 }
 529
 530 /*
 531 ============
 532 Cvar_RegisterVariable
 533
 534 Adds a freestanding variable to the variable list.
 535 ============
 536 */
 537 void Cvar_RegisterVariable (cvar_t *variable)
 538 {
 539         cvar_state_t *cvars = NULL;
 540         cvar_t *current, *cvar;
 541         int i;
 542
 543         switch (variable->flags & (CF_CLIENT | CF_SERVER))
 544         {
 545         case CF_CLIENT:
 546         case CF_SERVER:
 547         case CF_CLIENT | CF_SERVER:
 548                 cvars = &cvars_all;
 549                 break;
 550         case 0:
 551                 Sys_Error("Cvar_RegisterVariable({\"%s\", \"%s\", %i}) with no CF_CLIENT | CF_SERVER flags\n", variable->name, variable->string, variable->flags);
 552                 break;
 553         default:
 554                 Sys_Error("Cvar_RegisterVariable({\"%s\", \"%s\", %i}) with weird CF_CLIENT | CF_SERVER flags\n", variable->name, variable->string, variable->flags);
 555                 break;
 556         }
 557
 558         if (developer_extra.integer)
 559                 Con_DPrintf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
 560
 561         // first check to see if it has already been defined
 562         cvar = Cvar_FindVar(cvars, variable->name, ~0);
 563         if (cvar)
 564         {
 565                 if (cvar->flags & CF_ALLOCATED)
 566                 {
 567                         if (developer_extra.integer)
 568                                 Con_DPrintf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
 569                         // fixed variables replace allocated ones
 570                         // (because the engine directly accesses fixed variables)
 571                         // NOTE: this isn't actually used currently
 572                         // (all cvars are registered before config parsing)
 573                         variable->flags |= (cvar->flags & ~CF_ALLOCATED);
 574                         // cvar->string is now owned by variable instead
 575                         variable->string = cvar->string;
 576                         variable->defstring = cvar->defstring;
 577                         variable->value = atof (variable->string);
 578                         variable->integer = (int) variable->value;
 579                         // Preserve autocvar status.
 580                         memcpy(variable->globaldefindex, cvar->globaldefindex, sizeof(variable->globaldefindex));
 581                         memcpy(variable->globaldefindex_stringno, cvar->globaldefindex_stringno, sizeof(variable->globaldefindex_stringno));
 582                         // replace cvar with this one...
 583                         variable->next = cvar->next;
 584                         if (cvars->vars == cvar)
 585                         {
 586                                 // head of the list is easy to change
 587                                 cvars->vars = variable;
 588                         }
 589                         else
 590                         {
 591                                 // otherwise find it somewhere in the list
 592                                 for (current = cvars->vars;current->next != cvar;current = current->next)
 593                                         ;
 594                                 current->next = variable;
 595                         }
 596
 597                         // get rid of old allocated cvar
 598                         // (but not cvar->string and cvar->defstring, because we kept those)
 599                         Z_Free((char *)cvar->name);
 600                         Z_Free(cvar);
 601                 }
 602                 else
 603                         Con_DPrintf("Can't register variable %s, already defined\n", variable->name);
 604                 return;
 605         }
 606
 607         // check for overlap with a command
 608         if (Cmd_Exists(&cmd_client, variable->name) || Cmd_Exists(&cmd_server, variable->name))
 609         {
 610                 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
 611                 return;
 612         }
 613
 614         // copy the value off, because future sets will Z_Free it
 615         variable->name = (char *)Mem_strdup(zonemempool, variable->name);
 616         variable->string = (char *)Mem_strdup(zonemempool, variable->string);
 617         variable->defstring = (char *)Mem_strdup(zonemempool, variable->string);
 618         variable->value = atof (variable->string);
 619         variable->integer = (int) variable->value;
 620         variable->aliasindex = 0;
 621         variable->initstate = NULL;
 622
 623         // Mark it as not an autocvar.
 624         for (i = 0;i < PRVM_PROG_MAX;i++)
 625                 variable->globaldefindex[i] = -1;
 626
 627         Cvar_Link(variable, cvars);
 628 }
 629
 630 /*
 631 ============
 632 Cvar_Get
 633
 634 Adds a newly allocated variable to the variable list or sets its value.
 635 ============
 636 */
 637 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription)
 638 {
 639         cvar_t *cvar;
 640         int i;
 641
 642         if (developer_extra.integer)
 643                 Con_DPrintf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
 644
 645         // first check to see if it has already been defined
 646         cvar = Cvar_FindVar(cvars, name, ~0);
 647         if (cvar)
 648         {
 649                 cvar->flags |= flags;
 650                 Cvar_SetQuick_Internal (cvar, value);
 651                 if(newdescription && (cvar->flags & CF_ALLOCATED))
 652                 {
 653                         if(cvar->description != cvar_dummy_description)
 654                                 Z_Free((char *)cvar->description);
 655
 656                         if(*newdescription)
 657                                 cvar->description = (char *)Mem_strdup(zonemempool, newdescription);
 658                         else
 659                                 cvar->description = cvar_dummy_description;
 660                 }
 661                 return cvar;
 662         }
 663
 664         // check for pure evil
 665         if (!*name)
 666         {
 667                 Con_Printf("Cvar_Get: invalid variable name\n");
 668                 return NULL;
 669         }
 670
 671         // check for overlap with a command
 672         if (Cmd_Exists(&cmd_client, name) || Cmd_Exists(&cmd_server, name))
 673         {
 674                 Con_Printf("Cvar_Get: %s is a command\n", name);
 675                 return NULL;
 676         }
 677
 678         // allocate a new cvar, cvar name, and cvar string
 679         // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
 680         // FIXME: these never get Z_Free'd
 681         cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
 682         cvar->flags = flags | CF_ALLOCATED;
 683         cvar->name = (char *)Mem_strdup(zonemempool, name);
 684         cvar->string = (char *)Mem_strdup(zonemempool, value);
 685         cvar->defstring = (char *)Mem_strdup(zonemempool, value);
 686         cvar->value = atof (cvar->string);
 687         cvar->integer = (int) cvar->value;
 688         cvar->aliases = (char **)Z_Malloc(sizeof(char **));
 689         cvar->initstate = NULL;
 690         memset(cvar->aliases, 0, sizeof(char *));
 691
 692         if(newdescription && *newdescription)
 693                 cvar->description = (char *)Mem_strdup(zonemempool, newdescription);
 694         else
 695                 cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
 696
 697         // Mark it as not an autocvar.
 698         for (i = 0;i < PRVM_PROG_MAX;i++)
 699                 cvar->globaldefindex[i] = -1;
 700
 701         Cvar_Link(cvar, cvars);
 702
 703         return cvar;
 704 }
 705
 706 qbool Cvar_Readonly (cvar_t *var, const char *cmd_name)
 707 {
 708         if (var->flags & CF_READONLY)
 709         {
 710                 if(cmd_name)
 711                         Con_Printf("%s: ",cmd_name);
 712                 Con_Printf("%s", var->name);
 713                 Con_Printf(" is read-only\n");
 714                 return true;
 715         }
 716         return false;
 717 }
 718
 719 /*
 720 ============
 721 Cvar_Command
 722
 723 Handles variable inspection and changing from the console
 724 ============
 725 */
 726 qbool   Cvar_Command (cmd_state_t *cmd)
 727 {
 728         cvar_state_t    *cvars = cmd->cvars;
 729         cvar_t                  *v;
 730
 731         // check variables
 732         v = Cvar_FindVar(cvars, Cmd_Argv(cmd, 0), (cmd->cvars_flagsmask));
 733         if (!v)
 734                 return false;
 735
 736         // perform a variable print or set
 737         if (Cmd_Argc(cmd) == 1)
 738         {
 739                 Cvar_PrintHelp(v, Cmd_Argv(cmd, 0), true);
 740                 return true;
 741         }
 742
 743         if (developer_extra.integer)
 744                 Con_DPrint("Cvar_Command: ");
 745
 746         if(Cvar_Readonly(v, NULL))
 747                 return true;
 748
 749         Cvar_SetQuick(v, Cmd_Argv(cmd, 1));
 750         if (developer_extra.integer)
 751                 Con_DPrint("\n");
 752         return true;
 753 }
 754
 755 void Cvar_UnlockDefaults(cmd_state_t *cmd)
 756 {
 757         cvar_state_t *cvars = cmd->cvars;
 758         cvar_t *var;
 759         // unlock the default values of all cvars
 760         for (var = cvars->vars ; var ; var = var->next)
 761                 var->flags &= ~CF_DEFAULTSET;
 762 }
 763
 764 void Cvar_LockDefaults_f(cmd_state_t *cmd)
 765 {
 766         cvar_state_t *cvars = cmd->cvars;
 767         cvar_t *var;
 768         // lock in the default values of all cvars
 769         for (var = cvars->vars ; var ; var = var->next)
 770         {
 771                 if (!(var->flags & CF_DEFAULTSET))
 772                 {
 773                         size_t alloclen;
 774
 775                         //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
 776                         var->flags |= CF_DEFAULTSET;
 777                         Z_Free((char *)var->defstring);
 778                         alloclen = strlen(var->string) + 1;
 779                         var->defstring = (char *)Z_Malloc(alloclen);
 780                         memcpy((char *)var->defstring, var->string, alloclen);
 781                 }
 782         }
 783 }
 784
 785 void Cvar_SaveInitState(cvar_state_t *cvars)
 786 {
 787         cvar_t *c;
 788         for (c = cvars->vars;c;c = c->next)
 789         {
 790                 c->initstate = (cvar_t *)Z_Malloc(sizeof(cvar_t));
 791                 memcpy(c->initstate, c, sizeof(cvar_t));
 792         }
 793 }
 794
 795 void Cvar_RestoreInitState(cvar_state_t *cvars)
 796 {
 797         int hashindex;
 798         cvar_t *c, **cp;
 799         cvar_t *c2, **cp2;
 800         for (cp = &cvars->vars;(c = *cp);)
 801         {
 802                 if (c->initstate)
 803                 {
 804                         // restore this cvar, it existed at init
 805                         if (((c->flags ^ c->initstate->flags) & CF_MAXFLAGSVAL)
 806                          || strcmp(c->defstring ? c->defstring : "", c->initstate->defstring ? c->initstate->defstring : "")
 807                          || strcmp(c->string ? c->string : "", c->initstate->string ? c->initstate->string : ""))
 808                         {
 809                                 Con_DPrintf("Cvar_RestoreInitState: Restoring cvar \"%s\"\n", c->name);
 810                                 if (c->defstring)
 811                                         Z_Free((char *)c->defstring);
 812                                 c->defstring = Mem_strdup(zonemempool, c->initstate->defstring);
 813                                 if (c->string)
 814                                         Z_Free((char *)c->string);
 815                                 c->string = Mem_strdup(zonemempool, c->initstate->string);
 816                         }
 817                         c->flags = c->initstate->flags;
 818                         c->value = c->initstate->value;
 819                         c->integer = c->initstate->integer;
 820                         VectorCopy(c->initstate->vector, c->vector);
 821                         cp = &c->next;
 822                 }
 823                 else
 824                 {
 825                         if (!(c->flags & CF_ALLOCATED))
 826                         {
 827                                 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it was registered after init!\n", c->name);
 828                                 // In this case, at least reset it to the default.
 829                                 if((c->flags & CF_PERSISTENT) == 0)
 830                                         Cvar_SetQuick(c, c->defstring);
 831                                 cp = &c->next;
 832                                 continue;
 833                         }
 834                         if (Cvar_IsAutoCvar(c))
 835                         {
 836                                 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it is an autocvar used by running progs!\n", c->name);
 837                                 // In this case, at least reset it to the default.
 838                                 if((c->flags & CF_PERSISTENT) == 0)
 839                                         Cvar_SetQuick(c, c->defstring);
 840                                 cp = &c->next;
 841                                 continue;
 842                         }
 843                         // remove this cvar, it did not exist at init
 844                         Con_DPrintf("Cvar_RestoreInitState: Destroying cvar \"%s\"\n", c->name);
 845                         // unlink struct from hash
 846                         hashindex = CRC_Block((const unsigned char *)c->name, strlen(c->name)) % CVAR_HASHSIZE;
 847                         for (cp2 = &cvars->hashtable[hashindex]->cvar;(c2 = *cp2);)
 848                         {
 849                                 if (c2 == c)
 850                                 {
 851                                         *cp2 = cvars->hashtable[hashindex]->next->cvar;
 852                                         break;
 853                                 }
 854                                 else
 855                                         cp2 = &cvars->hashtable[hashindex]->next->cvar;
 856                         }
 857                         // unlink struct from main list
 858                         *cp = c->next;
 859                         // free strings
 860                         if (c->defstring)
 861                                 Z_Free((char *)c->defstring);
 862                         if (c->string)
 863                                 Z_Free((char *)c->string);
 864                         if (c->description && c->description != cvar_dummy_description)
 865                                 Z_Free((char *)c->description);
 866                         // free struct
 867                         Z_Free(c);
 868                 }
 869         }
 870 }
 871
 872 void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd)
 873 {
 874         cvar_state_t *cvars = cmd->cvars;
 875         cvar_t *var;
 876         // restore the default values of all cvars
 877         for (var = cvars->vars ; var ; var = var->next)
 878         {
 879                 if((var->flags & CF_PERSISTENT) == 0)
 880                         Cvar_SetQuick(var, var->defstring);
 881         }
 882 }
 883
 884 void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd)
 885 {
 886         cvar_state_t *cvars = cmd->cvars;
 887         cvar_t *var;
 888         // restore the default values of all cvars
 889         for (var = cvars->vars ; var ; var = var->next)
 890         {
 891                 if ((var->flags & (CF_PERSISTENT | CF_ARCHIVE)) == 0)
 892                         Cvar_SetQuick(var, var->defstring);
 893         }
 894 }
 895
 896
 897 void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd)
 898 {
 899         cvar_state_t *cvars = cmd->cvars;
 900         cvar_t *var;
 901         // restore the default values of all cvars
 902         for (var = cvars->vars ; var ; var = var->next)
 903         {
 904                 if ((var->flags & (CF_PERSISTENT | CF_ARCHIVE)) == CF_ARCHIVE)
 905                         Cvar_SetQuick(var, var->defstring);
 906         }
 907 }
 908
 909 /*
 910 ============
 911 Cvar_WriteVariables
 912
 913 Writes lines containing "set variable value" for all variables
 914 with the archive flag set to true.
 915 ============
 916 */
 917 void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f)
 918 {
 919         cvar_t  *var;
 920         char buf1[MAX_INPUTLINE], buf2[MAX_INPUTLINE];
 921
 922         // don't save cvars that match their default value
 923         for (var = cvars->vars ; var ; var = var->next) {
 924                 if ((var->flags & CF_ARCHIVE) && (strcmp(var->string, var->defstring) || ((var->flags & CF_ALLOCATED) && !(var->flags & CF_DEFAULTSET))))
 925                 {
 926                         Cmd_QuoteString(buf1, sizeof(buf1), var->name, "\"\\$", false);
 927                         Cmd_QuoteString(buf2, sizeof(buf2), var->string, "\"\\$", false);
 928                         FS_Printf(f, "%s\"%s\" \"%s\"\n", var->flags & CF_ALLOCATED ? "seta " : "", buf1, buf2);
 929                 }
 930         }
 931 }
 932
 933 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 934 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 935 /*
 936 =========
 937 Cvar_List
 938 =========
 939 */
 940 void Cvar_List_f(cmd_state_t *cmd)
 941 {
 942         cvar_state_t *cvars = cmd->cvars;
 943         cvar_t *cvar;
 944         const char *partial;
 945         int count;
 946         qbool ispattern;
 947         char vabuf[1024];
 948
 949         if (Cmd_Argc(cmd) > 1)
 950         {
 951                 partial = Cmd_Argv(cmd, 1);
 952                 ispattern = (strchr(partial, '*') || strchr(partial, '?'));
 953                 if(!ispattern)
 954                         partial = va(vabuf, sizeof(vabuf), "%s*", partial);
 955         }
 956         else
 957         {
 958                 partial = va(vabuf, sizeof(vabuf), "*");
 959                 ispattern = false;
 960         }
 961
 962         count = 0;
 963         for (cvar = cvars->vars; cvar; cvar = cvar->next)
 964         {
 965                 if (matchpattern_with_separator(cvar->name, partial, false, "", false))
 966                 {
 967                         Cvar_PrintHelp(cvar, cvar->name, true);
 968                         count++;
 969                 }
 970                 for (int i = 0; i < cvar->aliasindex; i++)
 971                 {
 972                         if (matchpattern_with_separator(cvar->aliases[i], partial, false, "", false))
 973                         {
 974                                 Cvar_PrintHelp(cvar, cvar->aliases[i], true);
 975                                 count++;
 976                         }
 977                 }
 978         }
 979
 980         if (Cmd_Argc(cmd) > 1)
 981         {
 982                 if(ispattern)
 983                         Con_Printf("%i cvar%s matching \"%s\"\n", count, (count > 1) ? "s" : "", partial);
 984                 else
 985                         Con_Printf("%i cvar%s beginning with \"%s\"\n", count, (count > 1) ? "s" : "", Cmd_Argv(cmd,1));
 986         }
 987         else
 988                 Con_Printf("%i cvar(s)\n", count);
 989 }
 990 // 2000-01-09 CvarList command by Maddes
 991
 992 void Cvar_Set_f(cmd_state_t *cmd)
 993 {
 994         cvar_state_t *cvars = cmd->cvars;
 995         cvar_t *cvar;
 996
 997         // make sure it's the right number of parameters
 998         if (Cmd_Argc(cmd) < 3)
 999         {
1000                 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
1001                 return;
1002         }
1003
1004         // check if it's read-only
1005         cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1006         if (cvar)
1007                 if(Cvar_Readonly(cvar,"Set"))
1008                         return;
1009
1010         if (developer_extra.integer)
1011                 Con_DPrint("Set: ");
1012
1013         // all looks ok, create/modify the cvar
1014         Cvar_Get(cvars, Cmd_Argv(cmd, 1), Cmd_Argv(cmd, 2), cmd->cvars_flagsmask, Cmd_Argc(cmd) > 3 ? Cmd_Argv(cmd, 3) : NULL);
1015 }
1016
1017 void Cvar_SetA_f(cmd_state_t *cmd)
1018 {
1019         cvar_state_t *cvars = cmd->cvars;
1020         cvar_t *cvar;
1021
1022         // make sure it's the right number of parameters
1023         if (Cmd_Argc(cmd) < 3)
1024         {
1025                 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
1026                 return;
1027         }
1028
1029         // check if it's read-only
1030         cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1031         if (cvar)
1032                 if(Cvar_Readonly(cvar,"SetA"))
1033                         return;
1034
1035         if (developer_extra.integer)
1036                 Con_DPrint("SetA: ");
1037
1038         // all looks ok, create/modify the cvar
1039         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);
1040 }
1041
1042 void Cvar_Del_f(cmd_state_t *cmd)
1043 {
1044         cvar_state_t *cvars = cmd->cvars;
1045         int neededflags = ~0;
1046         int i;
1047         cvar_t *parent, **link;
1048         cvar_t *cvar, *prev;
1049
1050         if(Cmd_Argc(cmd) < 2)
1051         {
1052                 Con_Printf("%s: wrong number of parameters, usage: unset <variablename1> [<variablename2> ...]\n", Cmd_Argv(cmd, 0));
1053                 return;
1054         }
1055         for(i = 1; i < Cmd_Argc(cmd); ++i)
1056         {
1057                 cvar = Cvar_FindVarLink(cvars, Cmd_Argv(cmd, i), &parent, &link, &prev, neededflags);
1058
1059                 if(!cvar)
1060                 {
1061                         Con_Printf("%s: %s is not defined\n", Cmd_Argv(cmd, 0), Cmd_Argv(cmd, i));
1062                         continue;
1063                 }
1064                 if(Cvar_Readonly(cvar, Cmd_Argv(cmd, 0)))
1065                         continue;
1066                 if(!(cvar->flags & CF_ALLOCATED))
1067                 {
1068                         Con_Printf("%s: %s is static and cannot be deleted\n", Cmd_Argv(cmd, 0), cvar->name);
1069                         continue;
1070                 }
1071                 if(cvar == cvars->vars)
1072                 {
1073                         cvars->vars = cvar->next;
1074                 }
1075                 else
1076                 {
1077                         // in this case, prev must be set, otherwise there has been some inconsistensy
1078                         // elsewhere already... should I still check for prev != NULL?
1079                         prev->next = cvar->next;
1080                 }
1081
1082                 if(parent)
1083                         parent->next = cvar->next;
1084                 else if(link)
1085                         *link = cvar->next;
1086                 if(cvar->description != cvar_dummy_description)
1087                         Z_Free((char *)cvar->description);
1088
1089                 Z_Free((char *)cvar->name);
1090                 Z_Free((char *)cvar->string);
1091                 Z_Free((char *)cvar->defstring);
1092                 Z_Free(cvar);
1093         }
1094 }
1095
1096 #ifdef FILLALLCVARSWITHRUBBISH
1097 void Cvar_FillAll_f(cmd_state_t *cmd)
1098 {
1099         char *buf, *p, *q;
1100         int n, i;
1101         cvar_t *var;
1102         qbool verify;
1103         if(Cmd_Argc(cmd) != 2)
1104         {
1105                 Con_Printf("Usage: %s length to plant rubbish\n", Cmd_Argv(cmd, 0));
1106                 Con_Printf("Usage: %s -length to verify that the rubbish is still there\n", Cmd_Argv(cmd, 0));
1107                 return;
1108         }
1109         n = atoi(Cmd_Argv(cmd, 1));
1110         verify = (n < 0);
1111         if(verify)
1112                 n = -n;
1113         buf = Z_Malloc(n + 1);
1114         buf[n] = 0;
1115         for(var = cvars->vars; var; var = var->next)
1116         {
1117                 for(i = 0, p = buf, q = var->name; i < n; ++i)
1118                 {
1119                         *p++ = *q++;
1120                         if(!*q)
1121                                 q = var->name;
1122                 }
1123                 if(verify && strcmp(var->string, buf))
1124                 {
1125                         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);
1126                 }
1127                 Cvar_SetQuick(var, buf);
1128         }
1129         Z_Free(buf);
1130 }
1131 #endif /* FILLALLCVARSWITHRUBBISH */