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