cvar.c

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