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, qboolean full)
 270 {
 271         // Aliases are purple, cvars are yellow
 272         if (strcmp(cvar->name, name))
 273                 Con_Printf("^6");
 274         else
 275                 Con_Printf("^3");
 276         Con_Printf("%s^7 is \"%s\" [\"%s\"]", name, ((cvar->flags & CVAR_PRIVATE) ? "********"/*hunter2*/ : cvar->string), cvar->defstring);
 277         if (strcmp(cvar->name, name))
 278                 Con_Printf(" (also ^3%s^7)", cvar->name);
 279         if (full)
 280                 Con_Printf(" %s", cvar->description);
 281         Con_Printf("\n");
 282 }
 283
 284 // written by LadyHavoc
 285 void Cvar_CompleteCvarPrint(cvar_state_t *cvars, const char *partial, int neededflags)
 286 {
 287         cvar_t *cvar;
 288         size_t len = strlen(partial);
 289         // Loop through the command list and print all matches
 290         for (cvar = cvars->vars; cvar; cvar = cvar->next)
 291                 if (!strncasecmp(partial, cvar->name, len) && (cvar->flags & neededflags))
 292                         Cvar_PrintHelp(cvar, cvar->name, true);
 293                 else
 294                         for (int i = 0; i < cvar->aliasindex; i++)
 295                                 if (!strncasecmp (partial, cvar->aliases[i], len) && (cvar->flags & neededflags))
 296                                         Cvar_PrintHelp(cvar, cvar->aliases[i], true);
 297
 298
 299 }
 300
 301 // check if a cvar is held by some progs
 302 static qboolean Cvar_IsAutoCvar(cvar_t *var)
 303 {
 304         int i;
 305         prvm_prog_t *prog;
 306         for (i = 0;i < PRVM_PROG_MAX;i++)
 307         {
 308                 prog = &prvm_prog_list[i];
 309                 if (prog->loaded && var->globaldefindex[i] >= 0)
 310                         return true;
 311         }
 312         return false;
 313 }
 314
 315 // we assume that prog is already set to the target progs
 316 static void Cvar_UpdateAutoCvar(cvar_t *var)
 317 {
 318         int i;
 319         int j;
 320         const char *s;
 321         vec3_t v;
 322         prvm_prog_t *prog;
 323         for (i = 0;i < PRVM_PROG_MAX;i++)
 324         {
 325                 prog = &prvm_prog_list[i];
 326                 if (prog->loaded && var->globaldefindex[i] >= 0)
 327                 {
 328                         // MUST BE SYNCED WITH prvm_edict.c PRVM_LoadProgs
 329                         switch(prog->globaldefs[var->globaldefindex[i]].type & ~DEF_SAVEGLOBAL)
 330                         {
 331                         case ev_float:
 332                                 PRVM_GLOBALFIELDFLOAT(prog->globaldefs[var->globaldefindex[i]].ofs) = var->value;
 333                                 break;
 334                         case ev_vector:
 335                                 s = var->string;
 336                                 VectorClear(v);
 337                                 for (j = 0;j < 3;j++)
 338                                 {
 339                                         while (*s && ISWHITESPACE(*s))
 340                                                 s++;
 341                                         if (!*s)
 342                                                 break;
 343                                         v[j] = atof(s);
 344                                         while (!ISWHITESPACE(*s))
 345                                                 s++;
 346                                         if (!*s)
 347                                                 break;
 348                                 }
 349                                 VectorCopy(v, PRVM_GLOBALFIELDVECTOR(prog->globaldefs[var->globaldefindex[i]].ofs));
 350                                 break;
 351                         case ev_string:
 352                                 PRVM_ChangeEngineString(prog, var->globaldefindex_stringno[i], var->string);
 353                                 PRVM_GLOBALFIELDSTRING(prog->globaldefs[var->globaldefindex[i]].ofs) = var->globaldefindex_stringno[i];
 354                                 break;
 355                         }
 356                 }
 357         }
 358 }
 359
 360 // called after loading a savegame
 361 void Cvar_UpdateAllAutoCvars(cvar_state_t *cvars)
 362 {
 363         cvar_t *var;
 364         for (var = cvars->vars ; var ; var = var->next)
 365                 Cvar_UpdateAutoCvar(var);
 366 }
 367
 368 /*
 369 ============
 370 Cvar_Set
 371 ============
 372 */
 373 extern cvar_t sv_disablenotify;
 374 static void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
 375 {
 376         qboolean changed;
 377         size_t valuelen;
 378
 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 & CVAR_NOTIFY) && changed && 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 & CVAR_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 & CVAR_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 void Cvar_Set_NoCallback(cvar_t *var, const char *value)
 447 {
 448         void (*callback_save)(cvar_t *) = var->callback;
 449         var->callback = NULL;
 450         Cvar_SetQuick_Internal(var, value);
 451         var->callback = callback_save;
 452 }
 453
 454 /*
 455 ============
 456 Cvar_SetValue
 457 ============
 458 */
 459 void Cvar_SetValueQuick(cvar_t *var, float value)
 460 {
 461         char val[MAX_INPUTLINE];
 462
 463         if ((float)((int)value) == value)
 464                 dpsnprintf(val, sizeof(val), "%i", (int)value);
 465         else
 466                 dpsnprintf(val, sizeof(val), "%f", value);
 467         Cvar_SetQuick(var, val);
 468 }
 469
 470 void Cvar_SetValue(cvar_state_t *cvars, const char *var_name, float value)
 471 {
 472         char val[MAX_INPUTLINE];
 473
 474         if ((float)((int)value) == value)
 475                 dpsnprintf(val, sizeof(val), "%i", (int)value);
 476         else
 477                 dpsnprintf(val, sizeof(val), "%f", value);
 478         Cvar_Set(cvars, var_name, val);
 479 }
 480
 481 void Cvar_RegisterCallback(cvar_t *variable, void (*callback)(cvar_t *))
 482 {
 483         variable->callback = callback;
 484 }
 485
 486 void Cvar_RegisterAlias(cvar_t *variable, const char *alias )
 487 {
 488         cvar_state_t *cvars = &cvars_all;
 489         cvar_hash_t *hash;
 490         int hashindex;
 491
 492         variable->aliases = (char **)Mem_Realloc(zonemempool, variable->aliases, sizeof(char *) * (variable->aliasindex + 1));
 493         // Add to it
 494         variable->aliases[variable->aliasindex] = (char *)Z_Malloc(strlen(alias) + 1);
 495         memcpy(variable->aliases[variable->aliasindex], alias, strlen(alias) + 1);
 496         variable->aliasindex++;
 497
 498         // link to head of list in this hash table index
 499         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
 500         hashindex = CRC_Block((const unsigned char *)alias, strlen(alias)) % CVAR_HASHSIZE;
 501         hash->next = cvars->hashtable[hashindex];
 502         cvars->hashtable[hashindex] = hash;
 503         hash->cvar = variable;
 504 }
 505
 506 /*
 507 ============
 508 Cvar_RegisterVariable
 509
 510 Adds a freestanding variable to the variable list.
 511 ============
 512 */
 513 void Cvar_RegisterVariable (cvar_t *variable)
 514 {
 515         cvar_state_t *cvars = NULL;
 516         int hashindex;
 517         cvar_hash_t *hash;
 518         cvar_t *current, *next, *cvar;
 519         char *oldstr;
 520         size_t alloclen;
 521         int i;
 522
 523         switch (variable->flags & (CVAR_CLIENT | CVAR_SERVER))
 524         {
 525         case CVAR_CLIENT:
 526         case CVAR_SERVER:
 527         case CVAR_CLIENT | CVAR_SERVER:
 528                 cvars = &cvars_all;
 529                 break;
 530         case 0:
 531                 Sys_Error("Cvar_RegisterVariable({\"%s\", \"%s\", %i}) with no CVAR_CLIENT | CVAR_SERVER flags\n", variable->name, variable->string, variable->flags);
 532                 break;
 533         default:
 534                 Sys_Error("Cvar_RegisterVariable({\"%s\", \"%s\", %i}) with weird CVAR_CLIENT | CVAR_SERVER flags\n", variable->name, variable->string, variable->flags);
 535                 break;
 536         }
 537
 538         if (developer_extra.integer)
 539                 Con_DPrintf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
 540
 541 // first check to see if it has already been defined
 542         cvar = Cvar_FindVar(cvars, variable->name, ~0);
 543         if (cvar)
 544         {
 545                 if (cvar->flags & CVAR_ALLOCATED)
 546                 {
 547                         if (developer_extra.integer)
 548                                 Con_DPrintf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
 549                         // fixed variables replace allocated ones
 550                         // (because the engine directly accesses fixed variables)
 551                         // NOTE: this isn't actually used currently
 552                         // (all cvars are registered before config parsing)
 553                         variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
 554                         // cvar->string is now owned by variable instead
 555                         variable->string = cvar->string;
 556                         variable->defstring = cvar->defstring;
 557                         variable->value = atof (variable->string);
 558                         variable->integer = (int) variable->value;
 559                         // Preserve autocvar status.
 560                         memcpy(variable->globaldefindex, cvar->globaldefindex, sizeof(variable->globaldefindex));
 561                         memcpy(variable->globaldefindex_stringno, cvar->globaldefindex_stringno, sizeof(variable->globaldefindex_stringno));
 562                         // replace cvar with this one...
 563                         variable->next = cvar->next;
 564                         if (cvars->vars == cvar)
 565                         {
 566                                 // head of the list is easy to change
 567                                 cvars->vars = variable;
 568                         }
 569                         else
 570                         {
 571                                 // otherwise find it somewhere in the list
 572                                 for (current = cvars->vars;current->next != cvar;current = current->next)
 573                                         ;
 574                                 current->next = variable;
 575                         }
 576
 577                         // get rid of old allocated cvar
 578                         // (but not cvar->string and cvar->defstring, because we kept those)
 579                         Z_Free((char *)cvar->name);
 580                         Z_Free(cvar);
 581                 }
 582                 else
 583                         Con_DPrintf("Can't register variable %s, already defined\n", variable->name);
 584                 return;
 585         }
 586
 587 // check for overlap with a command
 588         if (Cmd_Exists(&cmd_client, variable->name) || Cmd_Exists(&cmd_server, variable->name))
 589         {
 590                 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
 591                 return;
 592         }
 593
 594 // copy the value off, because future sets will Z_Free it
 595         oldstr = (char *)variable->string;
 596         alloclen = strlen(variable->string) + 1;
 597         variable->string = (char *)Z_Malloc (alloclen);
 598         memcpy ((char *)variable->string, oldstr, alloclen);
 599         variable->defstring = (char *)Z_Malloc (alloclen);
 600         memcpy ((char *)variable->defstring, oldstr, alloclen);
 601         variable->value = atof (variable->string);
 602         variable->integer = (int) variable->value;
 603         variable->aliasindex = 0;
 604
 605         // Mark it as not an autocvar.
 606         for (i = 0;i < PRVM_PROG_MAX;i++)
 607                 variable->globaldefindex[i] = -1;
 608
 609 // link the variable in
 610 // alphanumerical order
 611         for( current = NULL, next = cvars->vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
 612                 ;
 613         if( current ) {
 614                 current->next = variable;
 615         } else {
 616                 cvars->vars = variable;
 617         }
 618         variable->next = next;
 619
 620         // link to head of list in this hash table index
 621         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
 622         hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name)) % CVAR_HASHSIZE;
 623         hash->next = cvars->hashtable[hashindex];
 624         hash->cvar = variable;
 625         cvars->hashtable[hashindex] = hash;
 626 }
 627
 628 /*
 629 ============
 630 Cvar_Get
 631
 632 Adds a newly allocated variable to the variable list or sets its value.
 633 ============
 634 */
 635 cvar_t *Cvar_Get(cvar_state_t *cvars, const char *name, const char *value, int flags, const char *newdescription)
 636 {
 637         int hashindex;
 638         cvar_hash_t *hash;
 639         cvar_t *current, *next, *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 & CVAR_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 | CVAR_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         memset(cvar->aliases, 0, sizeof(char *));
 690
 691         if(newdescription && *newdescription)
 692                 cvar->description = (char *)Mem_strdup(zonemempool, newdescription);
 693         else
 694                 cvar->description = cvar_dummy_description; // actually checked by VM_cvar_type
 695
 696         // Mark it as not an autocvar.
 697         for (i = 0;i < PRVM_PROG_MAX;i++)
 698                 cvar->globaldefindex[i] = -1;
 699
 700 // link the variable in
 701 // alphanumerical order
 702         for( current = NULL, next = cvars->vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
 703                 ;
 704         if( current )
 705                 current->next = cvar;
 706         else
 707                 cvars->vars = cvar;
 708         cvar->next = next;
 709
 710         // link to head of list in this hash table index
 711         hash = (cvar_hash_t *)Z_Malloc(sizeof(cvar_hash_t));
 712         hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name)) % CVAR_HASHSIZE;
 713         hash->next = cvars->hashtable[hashindex];
 714         cvars->hashtable[hashindex] = hash;
 715         hash->cvar = cvar;
 716
 717         return cvar;
 718 }
 719
 720 qboolean Cvar_Readonly (cvar_t *var, const char *cmd_name)
 721 {
 722         if (var->flags & CVAR_READONLY)
 723         {
 724                 if(cmd_name)
 725                         Con_Printf("%s: ",cmd_name);
 726                 Con_Printf("%s", var->name);
 727                 Con_Printf(" is read-only\n");
 728                 return true;
 729         }
 730         return false;
 731 }
 732
 733 /*
 734 ============
 735 Cvar_Command
 736
 737 Handles variable inspection and changing from the console
 738 ============
 739 */
 740 qboolean        Cvar_Command (cmd_state_t *cmd)
 741 {
 742         cvar_state_t    *cvars = cmd->cvars;
 743         cvar_t                  *v;
 744
 745 // check variables
 746         v = Cvar_FindVar(cvars, Cmd_Argv(cmd, 0), (cmd->cvars_flagsmask));
 747         if (!v)
 748                 return false;
 749
 750 // perform a variable print or set
 751         if (Cmd_Argc(cmd) == 1)
 752         {
 753                 Cvar_PrintHelp(v, Cmd_Argv(cmd, 0), true);
 754                 return true;
 755         }
 756
 757         if (developer_extra.integer)
 758                 Con_DPrint("Cvar_Command: ");
 759
 760         if(Cvar_Readonly(v, NULL))
 761                 return true;
 762
 763         Cvar_SetQuick(v, Cmd_Argv(cmd, 1));
 764         if (developer_extra.integer)
 765                 Con_DPrint("\n");
 766         return true;
 767 }
 768
 769
 770 void Cvar_UnlockDefaults(cmd_state_t *cmd)
 771 {
 772         cvar_state_t *cvars = cmd->cvars;
 773         cvar_t *var;
 774         // unlock the default values of all cvars
 775         for (var = cvars->vars ; var ; var = var->next)
 776                 var->flags &= ~CVAR_DEFAULTSET;
 777 }
 778
 779
 780 void Cvar_LockDefaults_f(cmd_state_t *cmd)
 781 {
 782         cvar_state_t *cvars = cmd->cvars;
 783         cvar_t *var;
 784         // lock in the default values of all cvars
 785         for (var = cvars->vars ; var ; var = var->next)
 786         {
 787                 if (!(var->flags & CVAR_DEFAULTSET))
 788                 {
 789                         size_t alloclen;
 790
 791                         //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
 792                         var->flags |= CVAR_DEFAULTSET;
 793                         Z_Free((char *)var->defstring);
 794                         alloclen = strlen(var->string) + 1;
 795                         var->defstring = (char *)Z_Malloc(alloclen);
 796                         memcpy((char *)var->defstring, var->string, alloclen);
 797                 }
 798         }
 799 }
 800
 801 void Cvar_SaveInitState(cvar_state_t *cvars)
 802 {
 803         cvar_t *c;
 804         for (c = cvars->vars;c;c = c->next)
 805         {
 806                 c->initstate = true;
 807                 c->initflags = c->flags;
 808                 c->initdefstring = Mem_strdup(zonemempool, c->defstring);
 809                 c->initstring = Mem_strdup(zonemempool, c->string);
 810                 c->initvalue = c->value;
 811                 c->initinteger = c->integer;
 812                 VectorCopy(c->vector, c->initvector);
 813         }
 814 }
 815
 816 void Cvar_RestoreInitState(cvar_state_t *cvars)
 817 {
 818         int hashindex;
 819         cvar_t *c, **cp;
 820         cvar_t *c2, **cp2;
 821         for (cp = &cvars->vars;(c = *cp);)
 822         {
 823                 if (c->initstate)
 824                 {
 825                         // restore this cvar, it existed at init
 826                         if (((c->flags ^ c->initflags) & CVAR_MAXFLAGSVAL)
 827                          || strcmp(c->defstring ? c->defstring : "", c->initdefstring ? c->initdefstring : "")
 828                          || strcmp(c->string ? c->string : "", c->initstring ? c->initstring : ""))
 829                         {
 830                                 Con_DPrintf("Cvar_RestoreInitState: Restoring cvar \"%s\"\n", c->name);
 831                                 if (c->defstring)
 832                                         Z_Free((char *)c->defstring);
 833                                 c->defstring = Mem_strdup(zonemempool, c->initdefstring);
 834                                 if (c->string)
 835                                         Z_Free((char *)c->string);
 836                                 c->string = Mem_strdup(zonemempool, c->initstring);
 837                         }
 838                         c->flags = c->initflags;
 839                         c->value = c->initvalue;
 840                         c->integer = c->initinteger;
 841                         VectorCopy(c->initvector, c->vector);
 842                         cp = &c->next;
 843                 }
 844                 else
 845                 {
 846                         if (!(c->flags & CVAR_ALLOCATED))
 847                         {
 848                                 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it was registered after init!\n", c->name);
 849                                 // In this case, at least reset it to the default.
 850                                 if((c->flags & CVAR_NORESETTODEFAULTS) == 0)
 851                                         Cvar_SetQuick(c, c->defstring);
 852                                 cp = &c->next;
 853                                 continue;
 854                         }
 855                         if (Cvar_IsAutoCvar(c))
 856                         {
 857                                 Con_DPrintf("Cvar_RestoreInitState: Unable to destroy cvar \"%s\", it is an autocvar used by running progs!\n", c->name);
 858                                 // In this case, at least reset it to the default.
 859                                 if((c->flags & CVAR_NORESETTODEFAULTS) == 0)
 860                                         Cvar_SetQuick(c, c->defstring);
 861                                 cp = &c->next;
 862                                 continue;
 863                         }
 864                         // remove this cvar, it did not exist at init
 865                         Con_DPrintf("Cvar_RestoreInitState: Destroying cvar \"%s\"\n", c->name);
 866                         // unlink struct from hash
 867                         hashindex = CRC_Block((const unsigned char *)c->name, strlen(c->name)) % CVAR_HASHSIZE;
 868                         for (cp2 = &cvars->hashtable[hashindex]->cvar;(c2 = *cp2);)
 869                         {
 870                                 if (c2 == c)
 871                                 {
 872                                         *cp2 = cvars->hashtable[hashindex]->next->cvar;
 873                                         break;
 874                                 }
 875                                 else
 876                                         cp2 = &cvars->hashtable[hashindex]->next->cvar;
 877                         }
 878                         // unlink struct from main list
 879                         *cp = c->next;
 880                         // free strings
 881                         if (c->defstring)
 882                                 Z_Free((char *)c->defstring);
 883                         if (c->string)
 884                                 Z_Free((char *)c->string);
 885                         if (c->description && c->description != cvar_dummy_description)
 886                                 Z_Free((char *)c->description);
 887                         // free struct
 888                         Z_Free(c);
 889                 }
 890         }
 891 }
 892
 893 void Cvar_ResetToDefaults_All_f(cmd_state_t *cmd)
 894 {
 895         cvar_state_t *cvars = cmd->cvars;
 896         cvar_t *var;
 897         // restore the default values of all cvars
 898         for (var = cvars->vars ; var ; var = var->next)
 899         {
 900                 if((var->flags & CVAR_NORESETTODEFAULTS) == 0)
 901                         Cvar_SetQuick(var, var->defstring);
 902         }
 903 }
 904
 905
 906 void Cvar_ResetToDefaults_NoSaveOnly_f(cmd_state_t *cmd)
 907 {
 908         cvar_state_t *cvars = cmd->cvars;
 909         cvar_t *var;
 910         // restore the default values of all cvars
 911         for (var = cvars->vars ; var ; var = var->next)
 912         {
 913                 if ((var->flags & (CVAR_NORESETTODEFAULTS | CVAR_SAVE)) == 0)
 914                         Cvar_SetQuick(var, var->defstring);
 915         }
 916 }
 917
 918
 919 void Cvar_ResetToDefaults_SaveOnly_f(cmd_state_t *cmd)
 920 {
 921         cvar_state_t *cvars = cmd->cvars;
 922         cvar_t *var;
 923         // restore the default values of all cvars
 924         for (var = cvars->vars ; var ; var = var->next)
 925         {
 926                 if ((var->flags & (CVAR_NORESETTODEFAULTS | CVAR_SAVE)) == CVAR_SAVE)
 927                         Cvar_SetQuick(var, var->defstring);
 928         }
 929 }
 930
 931
 932 /*
 933 ============
 934 Cvar_WriteVariables
 935
 936 Writes lines containing "set variable value" for all variables
 937 with the archive flag set to true.
 938 ============
 939 */
 940 void Cvar_WriteVariables (cvar_state_t *cvars, qfile_t *f)
 941 {
 942         cvar_t  *var;
 943         char buf1[MAX_INPUTLINE], buf2[MAX_INPUTLINE];
 944
 945         // don't save cvars that match their default value
 946         for (var = cvars->vars ; var ; var = var->next) {
 947                 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || ((var->flags & CVAR_ALLOCATED) && !(var->flags & CVAR_DEFAULTSET))))
 948                 {
 949                         Cmd_QuoteString(buf1, sizeof(buf1), var->name, "\"\\$", false);
 950                         Cmd_QuoteString(buf2, sizeof(buf2), var->string, "\"\\$", false);
 951                         FS_Printf(f, "%s\"%s\" \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", buf1, buf2);
 952                 }
 953         }
 954 }
 955
 956
 957 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 958 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 959 /*
 960 =========
 961 Cvar_List
 962 =========
 963 */
 964 void Cvar_List_f(cmd_state_t *cmd)
 965 {
 966         cvar_state_t *cvars = cmd->cvars;
 967         cvar_t *cvar;
 968         const char *partial;
 969         int count;
 970         qboolean ispattern;
 971         char vabuf[1024];
 972
 973         if (Cmd_Argc(cmd) > 1)
 974         {
 975                 partial = Cmd_Argv(cmd, 1);
 976                 ispattern = (strchr(partial, '*') || strchr(partial, '?'));
 977                 if(!ispattern)
 978                         partial = va(vabuf, sizeof(vabuf), "%s*", partial);
 979         }
 980         else
 981         {
 982                 partial = va(vabuf, sizeof(vabuf), "*");
 983                 ispattern = false;
 984         }
 985
 986         count = 0;
 987         for (cvar = cvars->vars; cvar; cvar = cvar->next)
 988         {
 989                 if (matchpattern_with_separator(cvar->name, partial, false, "", false))
 990                 {
 991                         Cvar_PrintHelp(cvar, cvar->name, true);
 992                         count++;
 993                 }
 994                 for (int i = 0; i < cvar->aliasindex; i++)
 995                 {
 996                         if (matchpattern_with_separator(cvar->aliases[i], partial, false, "", false))
 997                         {
 998                                 Cvar_PrintHelp(cvar, cvar->aliases[i], true);
 999                                 count++;
1000                         }
1001                 }
1002         }
1003
1004         if (Cmd_Argc(cmd) > 1)
1005         {
1006                 if(ispattern)
1007                         Con_Printf("%i cvar%s matching \"%s\"\n", count, (count > 1) ? "s" : "", partial);
1008                 else
1009                         Con_Printf("%i cvar%s beginning with \"%s\"\n", count, (count > 1) ? "s" : "", Cmd_Argv(cmd,1));
1010         }
1011         else
1012                 Con_Printf("%i cvar(s)\n", count);
1013 }
1014 // 2000-01-09 CvarList command by Maddes
1015
1016 void Cvar_Set_f(cmd_state_t *cmd)
1017 {
1018         cvar_state_t *cvars = cmd->cvars;
1019         cvar_t *cvar;
1020
1021         // make sure it's the right number of parameters
1022         if (Cmd_Argc(cmd) < 3)
1023         {
1024                 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value> [<description>]\n");
1025                 return;
1026         }
1027
1028         // check if it's read-only
1029         cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1030         if (cvar)
1031                 if(Cvar_Readonly(cvar,"Set"))
1032                         return;
1033
1034         if (developer_extra.integer)
1035                 Con_DPrint("Set: ");
1036
1037         // all looks ok, create/modify the cvar
1038         Cvar_Get(cvars, Cmd_Argv(cmd, 1), Cmd_Argv(cmd, 2), cmd->cvars_flagsmask, Cmd_Argc(cmd) > 3 ? Cmd_Argv(cmd, 3) : NULL);
1039 }
1040
1041 void Cvar_SetA_f(cmd_state_t *cmd)
1042 {
1043         cvar_state_t *cvars = cmd->cvars;
1044         cvar_t *cvar;
1045
1046         // make sure it's the right number of parameters
1047         if (Cmd_Argc(cmd) < 3)
1048         {
1049                 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value> [<description>]\n");
1050                 return;
1051         }
1052
1053         // check if it's read-only
1054         cvar = Cvar_FindVar(cvars, Cmd_Argv(cmd, 1), ~0);
1055         if (cvar)
1056                 if(Cvar_Readonly(cvar,"SetA"))
1057                         return;
1058
1059         if (developer_extra.integer)
1060                 Con_DPrint("SetA: ");
1061
1062         // all looks ok, create/modify the cvar
1063         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);
1064 }
1065
1066 void Cvar_Del_f(cmd_state_t *cmd)
1067 {
1068         cvar_state_t *cvars = cmd->cvars;
1069         int neededflags = ~0;
1070         int i;
1071         cvar_t *parent, **link;
1072         cvar_t *cvar, *prev;
1073
1074         if(Cmd_Argc(cmd) < 2)
1075         {
1076                 Con_Printf("%s: wrong number of parameters, usage: unset <variablename1> [<variablename2> ...]\n", Cmd_Argv(cmd, 0));
1077                 return;
1078         }
1079         for(i = 1; i < Cmd_Argc(cmd); ++i)
1080         {
1081                 cvar = Cvar_FindVarLink(cvars, Cmd_Argv(cmd, i), &parent, &link, &prev, neededflags);
1082
1083                 if(!cvar)
1084                 {
1085                         Con_Printf("%s: %s is not defined\n", Cmd_Argv(cmd, 0), Cmd_Argv(cmd, i));
1086                         continue;
1087                 }
1088                 if(Cvar_Readonly(cvar, Cmd_Argv(cmd, 0)))
1089                         continue;
1090                 if(!(cvar->flags & CVAR_ALLOCATED))
1091                 {
1092                         Con_Printf("%s: %s is static and cannot be deleted\n", Cmd_Argv(cmd, 0), cvar->name);
1093                         continue;
1094                 }
1095                 if(cvar == cvars->vars)
1096                 {
1097                         cvars->vars = cvar->next;
1098                 }
1099                 else
1100                 {
1101                         // in this case, prev must be set, otherwise there has been some inconsistensy
1102                         // elsewhere already... should I still check for prev != NULL?
1103                         prev->next = cvar->next;
1104                 }
1105
1106                 if(parent)
1107                         parent->next = cvar->next;
1108                 else if(link)
1109                         *link = cvar->next;
1110                 if(cvar->description != cvar_dummy_description)
1111                         Z_Free((char *)cvar->description);
1112
1113                 Z_Free((char *)cvar->name);
1114                 Z_Free((char *)cvar->string);
1115                 Z_Free((char *)cvar->defstring);
1116                 Z_Free(cvar);
1117         }
1118 }
1119
1120 #ifdef FILLALLCVARSWITHRUBBISH
1121 void Cvar_FillAll_f(cmd_state_t *cmd)
1122 {
1123         char *buf, *p, *q;
1124         int n, i;
1125         cvar_t *var;
1126         qboolean verify;
1127         if(Cmd_Argc(cmd) != 2)
1128         {
1129                 Con_Printf("Usage: %s length to plant rubbish\n", Cmd_Argv(cmd, 0));
1130                 Con_Printf("Usage: %s -length to verify that the rubbish is still there\n", Cmd_Argv(cmd, 0));
1131                 return;
1132         }
1133         n = atoi(Cmd_Argv(cmd, 1));
1134         verify = (n < 0);
1135         if(verify)
1136                 n = -n;
1137         buf = Z_Malloc(n + 1);
1138         buf[n] = 0;
1139         for(var = cvars->vars; var; var = var->next)
1140         {
1141                 for(i = 0, p = buf, q = var->name; i < n; ++i)
1142                 {
1143                         *p++ = *q++;
1144                         if(!*q)
1145                                 q = var->name;
1146                 }
1147                 if(verify && strcmp(var->string, buf))
1148                 {
1149                         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);
1150                 }
1151                 Cvar_SetQuick(var, buf);
1152         }
1153         Z_Free(buf);
1154 }
1155 #endif /* FILLALLCVARSWITHRUBBISH */