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