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