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 cvar_t *cvar_vars = NULL;
  25 cvar_t *cvar_hashtable[65536];
  26 char *cvar_null_string = "";
  27
  28 /*
  29 ============
  30 Cvar_FindVar
  31 ============
  32 */
  33 cvar_t *Cvar_FindVar (const char *var_name)
  34 {
  35         int hashindex;
  36         cvar_t *var;
  37
  38         // use hash lookup to minimize search time
  39         hashindex = CRC_Block((const unsigned char *)var_name, strlen(var_name));
  40         for (var = cvar_hashtable[hashindex];var;var = var->nextonhashchain)
  41                 if (!strcasecmp (var_name, var->name))
  42                         return var;
  43
  44         return NULL;
  45 }
  46
  47 cvar_t *Cvar_FindVarAfter (const char *prev_var_name, int neededflags)
  48 {
  49         cvar_t *var;
  50
  51         if (*prev_var_name)
  52         {
  53                 var = Cvar_FindVar (prev_var_name);
  54                 if (!var)
  55                         return NULL;
  56                 var = var->next;
  57         }
  58         else
  59                 var = cvar_vars;
  60
  61         // search for the next cvar matching the needed flags
  62         while (var)
  63         {
  64                 if ((var->flags & neededflags) || !neededflags)
  65                         break;
  66                 var = var->next;
  67         }
  68         return var;
  69 }
  70
  71 /*
  72 ============
  73 Cvar_VariableValue
  74 ============
  75 */
  76 float Cvar_VariableValue (const char *var_name)
  77 {
  78         cvar_t *var;
  79
  80         var = Cvar_FindVar (var_name);
  81         if (!var)
  82                 return 0;
  83         return atof (var->string);
  84 }
  85
  86
  87 /*
  88 ============
  89 Cvar_VariableString
  90 ============
  91 */
  92 const char *Cvar_VariableString (const char *var_name)
  93 {
  94         cvar_t *var;
  95
  96         var = Cvar_FindVar (var_name);
  97         if (!var)
  98                 return cvar_null_string;
  99         return var->string;
 100 }
 101
 102 /*
 103 ============
 104 Cvar_VariableDefString
 105 ============
 106 */
 107 const char *Cvar_VariableDefString (const char *var_name)
 108 {
 109         cvar_t *var;
 110
 111         var = Cvar_FindVar (var_name);
 112         if (!var)
 113                 return cvar_null_string;
 114         return var->defstring;
 115 }
 116
 117
 118 /*
 119 ============
 120 Cvar_CompleteVariable
 121 ============
 122 */
 123 const char *Cvar_CompleteVariable (const char *partial)
 124 {
 125         cvar_t          *cvar;
 126         size_t          len;
 127
 128         len = strlen(partial);
 129
 130         if (!len)
 131                 return NULL;
 132
 133 // check functions
 134         for (cvar=cvar_vars ; cvar ; cvar=cvar->next)
 135                 if (!strncasecmp (partial,cvar->name, len))
 136                         return cvar->name;
 137
 138         return NULL;
 139 }
 140
 141
 142 /*
 143         CVar_CompleteCountPossible
 144
 145         New function for tab-completion system
 146         Added by EvilTypeGuy
 147         Thanks to Fett erich@heintz.com
 148
 149 */
 150 int Cvar_CompleteCountPossible (const char *partial)
 151 {
 152         cvar_t  *cvar;
 153         size_t  len;
 154         int             h;
 155
 156         h = 0;
 157         len = strlen(partial);
 158
 159         if (!len)
 160                 return  0;
 161
 162         // Loop through the cvars and count all possible matches
 163         for (cvar = cvar_vars; cvar; cvar = cvar->next)
 164                 if (!strncasecmp(partial, cvar->name, len))
 165                         h++;
 166
 167         return h;
 168 }
 169
 170 /*
 171         CVar_CompleteBuildList
 172
 173         New function for tab-completion system
 174         Added by EvilTypeGuy
 175         Thanks to Fett erich@heintz.com
 176         Thanks to taniwha
 177
 178 */
 179 const char **Cvar_CompleteBuildList (const char *partial)
 180 {
 181         const cvar_t *cvar;
 182         size_t len = 0;
 183         size_t bpos = 0;
 184         size_t sizeofbuf = (Cvar_CompleteCountPossible (partial) + 1) * sizeof (const char *);
 185         const char **buf;
 186
 187         len = strlen(partial);
 188         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
 189         // Loop through the alias list and print all matches
 190         for (cvar = cvar_vars; cvar; cvar = cvar->next)
 191                 if (!strncasecmp(partial, cvar->name, len))
 192                         buf[bpos++] = cvar->name;
 193
 194         buf[bpos] = NULL;
 195         return buf;
 196 }
 197
 198 // written by LordHavoc
 199 void Cvar_CompleteCvarPrint (const char *partial)
 200 {
 201         cvar_t *cvar;
 202         size_t len = strlen(partial);
 203         // Loop through the command list and print all matches
 204         for (cvar = cvar_vars; cvar; cvar = cvar->next)
 205                 if (!strncasecmp(partial, cvar->name, len))
 206                         Con_Printf ("%c3%s%s : \"%s\" (\"%s\") : %s\n", STRING_COLOR_TAG, cvar->name, STRING_COLOR_DEFAULT_STR, cvar->string, cvar->defstring, cvar->description);
 207 }
 208
 209
 210 /*
 211 ============
 212 Cvar_Set
 213 ============
 214 */
 215 void Cvar_SetQuick_Internal (cvar_t *var, const char *value)
 216 {
 217         qboolean changed;
 218         size_t valuelen;
 219
 220         changed = strcmp(var->string, value);
 221         // LordHavoc: don't reallocate when there is no change
 222         if (!changed)
 223                 return;
 224
 225         // LordHavoc: don't reallocate when the buffer is the same size
 226         valuelen = strlen(value);
 227         if (!var->string || strlen(var->string) != valuelen)
 228         {
 229                 Z_Free (var->string);   // free the old value string
 230
 231                 var->string = (char *)Z_Malloc (valuelen + 1);
 232         }
 233         memcpy (var->string, value, valuelen + 1);
 234         var->value = atof (var->string);
 235         var->integer = (int) var->value;
 236         if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
 237                 SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
 238 #if 0
 239         // TODO: add infostring support to the server?
 240         if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
 241         {
 242                 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
 243                 if (sv.active)
 244                 {
 245                         MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
 246                         MSG_WriteString (&sv.reliable_datagram, var->name);
 247                         MSG_WriteString (&sv.reliable_datagram, var->string);
 248                 }
 249         }
 250 #endif
 251         if ((var->flags & CVAR_USERINFO) && cls.state != ca_dedicated)
 252                 CL_SetInfo(var->name, var->string, true, false, false, false);
 253         else if ((var->flags & CVAR_NQUSERINFOHACK) && cls.state != ca_dedicated)
 254         {
 255                 // update the cls.userinfo to have proper values for the
 256                 // silly nq config variables.
 257                 //
 258                 // this is done when these variables are changed rather than at
 259                 // connect time because if the user or code checks the userinfo and it
 260                 // holds weird values it may cause confusion...
 261                 if (!strcmp(var->name, "_cl_color"))
 262                 {
 263                         CL_SetInfo("topcolor", va("%i", (var->integer >> 4) & 15), true, false, false, false);
 264                         CL_SetInfo("bottomcolor", va("%i", (var->integer) & 15), true, false, false, false);
 265                 }
 266                 else if (!strcmp(var->name, "_cl_rate"))
 267                         CL_SetInfo("rate", va("%i", var->integer), true, false, false, false);
 268                 else if (!strcmp(var->name, "_cl_playerskin"))
 269                         CL_SetInfo("playerskin", var->string, true, false, false, false);
 270                 else if (!strcmp(var->name, "_cl_playermodel"))
 271                         CL_SetInfo("playermodel", var->string, true, false, false, false);
 272                 else if (!strcmp(var->name, "_cl_name"))
 273                         CL_SetInfo("name", var->string, true, false, false, false);
 274         }
 275 }
 276
 277 void Cvar_SetQuick (cvar_t *var, const char *value)
 278 {
 279         if (var == NULL)
 280         {
 281                 Con_Print("Cvar_SetQuick: var == NULL\n");
 282                 return;
 283         }
 284
 285         if (developer.integer >= 100)
 286                 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
 287
 288         Cvar_SetQuick_Internal(var, value);
 289 }
 290
 291 void Cvar_Set (const char *var_name, const char *value)
 292 {
 293         cvar_t *var;
 294         var = Cvar_FindVar (var_name);
 295         if (var == NULL)
 296         {
 297                 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
 298                 return;
 299         }
 300         Cvar_SetQuick(var, value);
 301 }
 302
 303 /*
 304 ============
 305 Cvar_SetValue
 306 ============
 307 */
 308 void Cvar_SetValueQuick(cvar_t *var, float value)
 309 {
 310         char val[MAX_INPUTLINE];
 311
 312         if ((float)((int)value) == value)
 313                 sprintf(val, "%i", (int)value);
 314         else
 315                 sprintf(val, "%f", value);
 316         Cvar_SetQuick(var, val);
 317 }
 318
 319 void Cvar_SetValue(const char *var_name, float value)
 320 {
 321         char val[MAX_INPUTLINE];
 322
 323         if ((float)((int)value) == value)
 324                 sprintf(val, "%i", (int)value);
 325         else
 326                 sprintf(val, "%f", value);
 327         Cvar_Set(var_name, val);
 328 }
 329
 330 /*
 331 ============
 332 Cvar_RegisterVariable
 333
 334 Adds a freestanding variable to the variable list.
 335 ============
 336 */
 337 void Cvar_RegisterVariable (cvar_t *variable)
 338 {
 339         int hashindex;
 340         cvar_t *current, *next, *cvar;
 341         char *oldstr;
 342         size_t alloclen;
 343
 344         if (developer.integer >= 100)
 345                 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
 346
 347 // first check to see if it has already been defined
 348         cvar = Cvar_FindVar (variable->name);
 349         if (cvar)
 350         {
 351                 if (cvar->flags & CVAR_ALLOCATED)
 352                 {
 353                         if (developer.integer >= 100)
 354                                 Con_Printf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
 355                         // fixed variables replace allocated ones
 356                         // (because the engine directly accesses fixed variables)
 357                         // NOTE: this isn't actually used currently
 358                         // (all cvars are registered before config parsing)
 359                         variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
 360                         // cvar->string is now owned by variable instead
 361                         variable->string = cvar->string;
 362                         variable->defstring = cvar->defstring;
 363                         variable->value = atof (variable->string);
 364                         variable->integer = (int) variable->value;
 365                         // replace cvar with this one...
 366                         variable->next = cvar->next;
 367                         if (cvar_vars == cvar)
 368                         {
 369                                 // head of the list is easy to change
 370                                 cvar_vars = variable;
 371                         }
 372                         else
 373                         {
 374                                 // otherwise find it somewhere in the list
 375                                 for (current = cvar_vars;current->next != cvar;current = current->next)
 376                                         ;
 377                                 current->next = variable;
 378                         }
 379
 380                         // get rid of old allocated cvar
 381                         // (but not cvar->string and cvar->defstring, because we kept those)
 382                         Z_Free(cvar->name);
 383                         Z_Free(cvar);
 384                 }
 385                 else
 386                         Con_Printf("Can't register variable %s, already defined\n", variable->name);
 387                 return;
 388         }
 389
 390 // check for overlap with a command
 391         if (Cmd_Exists (variable->name))
 392         {
 393                 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
 394                 return;
 395         }
 396
 397 // copy the value off, because future sets will Z_Free it
 398         oldstr = variable->string;
 399         alloclen = strlen(variable->string) + 1;
 400         variable->string = (char *)Z_Malloc (alloclen);
 401         memcpy (variable->string, oldstr, alloclen);
 402         variable->defstring = (char *)Z_Malloc (alloclen);
 403         memcpy (variable->defstring, oldstr, alloclen);
 404         variable->value = atof (variable->string);
 405         variable->integer = (int) variable->value;
 406
 407 // link the variable in
 408 // alphanumerical order
 409         for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
 410                 ;
 411         if( current ) {
 412                 current->next = variable;
 413         } else {
 414                 cvar_vars = variable;
 415         }
 416         variable->next = next;
 417
 418         // link to head of list in this hash table index
 419         hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
 420         variable->nextonhashchain = cvar_hashtable[hashindex];
 421         cvar_hashtable[hashindex] = variable;
 422 }
 423
 424 /*
 425 ============
 426 Cvar_Get
 427
 428 Adds a newly allocated variable to the variable list or sets its value.
 429 ============
 430 */
 431 cvar_t *Cvar_Get (const char *name, const char *value, int flags)
 432 {
 433         int hashindex;
 434         cvar_t *current, *next, *cvar;
 435         size_t alloclen;
 436
 437         if (developer.integer >= 100)
 438                 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
 439
 440 // first check to see if it has already been defined
 441         cvar = Cvar_FindVar (name);
 442         if (cvar)
 443         {
 444                 cvar->flags |= flags;
 445                 Cvar_SetQuick_Internal (cvar, value);
 446                 return cvar;
 447         }
 448
 449 // check for overlap with a command
 450         if (Cmd_Exists (name))
 451         {
 452                 Con_Printf("Cvar_Get: %s is a command\n", name);
 453                 return NULL;
 454         }
 455
 456 // allocate a new cvar, cvar name, and cvar string
 457 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
 458 // FIXME: these never get Z_Free'd
 459         cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
 460         cvar->flags = flags | CVAR_ALLOCATED;
 461         alloclen = strlen(name) + 1;
 462         cvar->name = (char *)Z_Malloc(alloclen);
 463         memcpy(cvar->name, name, alloclen);
 464         alloclen = strlen(value) + 1;
 465         cvar->string = (char *)Z_Malloc(alloclen);
 466         memcpy(cvar->string, value, alloclen);
 467         cvar->defstring = (char *)Z_Malloc(alloclen);
 468         memcpy(cvar->defstring, value, alloclen);
 469         cvar->value = atof (cvar->string);
 470         cvar->integer = (int) cvar->value;
 471         cvar->description = "custom cvar";
 472
 473 // link the variable in
 474 // alphanumerical order
 475         for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
 476                 ;
 477         if( current )
 478                 current->next = cvar;
 479         else
 480                 cvar_vars = cvar;
 481         cvar->next = next;
 482
 483         // link to head of list in this hash table index
 484         hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
 485         cvar->nextonhashchain = cvar_hashtable[hashindex];
 486         cvar_hashtable[hashindex] = cvar;
 487
 488         return cvar;
 489 }
 490
 491
 492 /*
 493 ============
 494 Cvar_Command
 495
 496 Handles variable inspection and changing from the console
 497 ============
 498 */
 499 qboolean        Cvar_Command (void)
 500 {
 501         cvar_t                  *v;
 502
 503 // check variables
 504         v = Cvar_FindVar (Cmd_Argv(0));
 505         if (!v)
 506                 return false;
 507
 508 // perform a variable print or set
 509         if (Cmd_Argc() == 1)
 510         {
 511                 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
 512                 return true;
 513         }
 514
 515         if (developer.integer >= 100)
 516                 Con_DPrint("Cvar_Command: ");
 517
 518         if (v->flags & CVAR_READONLY)
 519         {
 520                 Con_Printf("%s is read-only\n", v->name);
 521                 return true;
 522         }
 523         Cvar_Set (v->name, Cmd_Argv(1));
 524         if (developer.integer >= 100)
 525                 Con_DPrint("\n");
 526         return true;
 527 }
 528
 529
 530 void Cvar_UnlockDefaults (void)
 531 {
 532         cvar_t *var;
 533         // unlock the default values of all cvars
 534         for (var = cvar_vars ; var ; var = var->next)
 535                 var->flags &= ~CVAR_DEFAULTSET;
 536 }
 537
 538
 539 void Cvar_LockDefaults_f (void)
 540 {
 541         cvar_t *var;
 542         // lock in the default values of all cvars
 543         for (var = cvar_vars ; var ; var = var->next)
 544         {
 545                 if (!(var->flags & CVAR_DEFAULTSET))
 546                 {
 547                         size_t alloclen;
 548
 549                         //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
 550                         var->flags |= CVAR_DEFAULTSET;
 551                         Z_Free(var->defstring);
 552                         alloclen = strlen(var->string) + 1;
 553                         var->defstring = (char *)Z_Malloc(alloclen);
 554                         memcpy(var->defstring, var->string, alloclen);
 555                 }
 556         }
 557 }
 558
 559
 560 void Cvar_ResetToDefaults_All_f (void)
 561 {
 562         cvar_t *var;
 563         // restore the default values of all cvars
 564         for (var = cvar_vars ; var ; var = var->next)
 565                 Cvar_SetQuick(var, var->defstring);
 566 }
 567
 568
 569 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
 570 {
 571         cvar_t *var;
 572         // restore the default values of all cvars
 573         for (var = cvar_vars ; var ; var = var->next)
 574                 if (!(var->flags & CVAR_SAVE))
 575                         Cvar_SetQuick(var, var->defstring);
 576 }
 577
 578
 579 void Cvar_ResetToDefaults_SaveOnly_f (void)
 580 {
 581         cvar_t *var;
 582         // restore the default values of all cvars
 583         for (var = cvar_vars ; var ; var = var->next)
 584                 if (var->flags & CVAR_SAVE)
 585                         Cvar_SetQuick(var, var->defstring);
 586 }
 587
 588
 589 /*
 590 ============
 591 Cvar_WriteVariables
 592
 593 Writes lines containing "set variable value" for all variables
 594 with the archive flag set to true.
 595 ============
 596 */
 597 void Cvar_WriteVariables (qfile_t *f)
 598 {
 599         cvar_t  *var;
 600
 601         // don't save cvars that match their default value
 602         for (var = cvar_vars ; var ; var = var->next)
 603                 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || (var->flags & CVAR_ALLOCATED)))
 604                         FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
 605 }
 606
 607
 608 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 609 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 610 /*
 611 =========
 612 Cvar_List
 613 =========
 614 */
 615 void Cvar_List_f (void)
 616 {
 617         cvar_t *cvar;
 618         const char *partial;
 619         size_t len;
 620         int count;
 621
 622         if (Cmd_Argc() > 1)
 623         {
 624                 partial = Cmd_Argv (1);
 625                 len = strlen(partial);
 626         }
 627         else
 628         {
 629                 partial = NULL;
 630                 len = 0;
 631         }
 632
 633         count = 0;
 634         for (cvar = cvar_vars; cvar; cvar = cvar->next)
 635         {
 636                 if (partial && strncasecmp (partial,cvar->name,len))
 637                         continue;
 638
 639                 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
 640                 count++;
 641         }
 642
 643         if (partial)
 644                 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
 645         else
 646                 Con_Printf("%i cvar(s)\n", count);
 647 }
 648 // 2000-01-09 CvarList command by Maddes
 649
 650 void Cvar_Set_f (void)
 651 {
 652         cvar_t *cvar;
 653
 654         // make sure it's the right number of parameters
 655         if (Cmd_Argc() < 3)
 656         {
 657                 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
 658                 return;
 659         }
 660
 661         // check if it's read-only
 662         cvar = Cvar_FindVar(Cmd_Argv(1));
 663         if (cvar && cvar->flags & CVAR_READONLY)
 664         {
 665                 Con_Printf("Set: %s is read-only\n", cvar->name);
 666                 return;
 667         }
 668
 669         Con_DPrint("Set: ");
 670
 671         // all looks ok, create/modify the cvar
 672         Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
 673 }
 674
 675 void Cvar_SetA_f (void)
 676 {
 677         cvar_t *cvar;
 678
 679         // make sure it's the right number of parameters
 680         if (Cmd_Argc() < 3)
 681         {
 682                 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
 683                 return;
 684         }
 685
 686         // check if it's read-only
 687         cvar = Cvar_FindVar(Cmd_Argv(1));
 688         if (cvar && cvar->flags & CVAR_READONLY)
 689         {
 690                 Con_Printf("SetA: %s is read-only\n", cvar->name);
 691                 return;
 692         }
 693
 694         Con_DPrint("SetA: ");
 695
 696         // all looks ok, create/modify the cvar
 697         Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);
 698 }
 699
 700