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