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                         int top = (var->integer >> 4) & 15, bottom = var->integer & 15;
 264                         CL_SetInfo("topcolor", va("%i", top), true, false, false, false);
 265                         CL_SetInfo("bottomcolor", va("%i", bottom), true, false, false, false);
 266                         if (cls.protocol != PROTOCOL_QUAKEWORLD && cls.netcon)
 267                         {
 268                                 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
 269                                 MSG_WriteString(&cls.netcon->message, va("color %i %i", top, bottom));
 270                         }
 271                 }
 272                 else if (!strcmp(var->name, "_cl_rate"))
 273                         CL_SetInfo("rate", va("%i", var->integer), true, false, false, false);
 274                 else if (!strcmp(var->name, "_cl_playerskin"))
 275                         CL_SetInfo("playerskin", var->string, true, false, false, false);
 276                 else if (!strcmp(var->name, "_cl_playermodel"))
 277                         CL_SetInfo("playermodel", var->string, true, false, false, false);
 278                 else if (!strcmp(var->name, "_cl_name"))
 279                         CL_SetInfo("name", var->string, true, false, false, false);
 280         }
 281 }
 282
 283 void Cvar_SetQuick (cvar_t *var, const char *value)
 284 {
 285         if (var == NULL)
 286         {
 287                 Con_Print("Cvar_SetQuick: var == NULL\n");
 288                 return;
 289         }
 290
 291         if (developer.integer >= 100)
 292                 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
 293
 294         Cvar_SetQuick_Internal(var, value);
 295 }
 296
 297 void Cvar_Set (const char *var_name, const char *value)
 298 {
 299         cvar_t *var;
 300         var = Cvar_FindVar (var_name);
 301         if (var == NULL)
 302         {
 303                 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
 304                 return;
 305         }
 306         Cvar_SetQuick(var, value);
 307 }
 308
 309 /*
 310 ============
 311 Cvar_SetValue
 312 ============
 313 */
 314 void Cvar_SetValueQuick(cvar_t *var, float value)
 315 {
 316         char val[MAX_INPUTLINE];
 317
 318         if ((float)((int)value) == value)
 319                 sprintf(val, "%i", (int)value);
 320         else
 321                 sprintf(val, "%f", value);
 322         Cvar_SetQuick(var, val);
 323 }
 324
 325 void Cvar_SetValue(const char *var_name, float value)
 326 {
 327         char val[MAX_INPUTLINE];
 328
 329         if ((float)((int)value) == value)
 330                 sprintf(val, "%i", (int)value);
 331         else
 332                 sprintf(val, "%f", value);
 333         Cvar_Set(var_name, val);
 334 }
 335
 336 /*
 337 ============
 338 Cvar_RegisterVariable
 339
 340 Adds a freestanding variable to the variable list.
 341 ============
 342 */
 343 void Cvar_RegisterVariable (cvar_t *variable)
 344 {
 345         int hashindex;
 346         cvar_t *current, *next, *cvar;
 347         char *oldstr;
 348         size_t alloclen;
 349
 350         if (developer.integer >= 100)
 351                 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
 352
 353 // first check to see if it has already been defined
 354         cvar = Cvar_FindVar (variable->name);
 355         if (cvar)
 356         {
 357                 if (cvar->flags & CVAR_ALLOCATED)
 358                 {
 359                         if (developer.integer >= 100)
 360                                 Con_Printf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
 361                         // fixed variables replace allocated ones
 362                         // (because the engine directly accesses fixed variables)
 363                         // NOTE: this isn't actually used currently
 364                         // (all cvars are registered before config parsing)
 365                         variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
 366                         // cvar->string is now owned by variable instead
 367                         variable->string = cvar->string;
 368                         variable->defstring = cvar->defstring;
 369                         variable->value = atof (variable->string);
 370                         variable->integer = (int) variable->value;
 371                         // replace cvar with this one...
 372                         variable->next = cvar->next;
 373                         if (cvar_vars == cvar)
 374                         {
 375                                 // head of the list is easy to change
 376                                 cvar_vars = variable;
 377                         }
 378                         else
 379                         {
 380                                 // otherwise find it somewhere in the list
 381                                 for (current = cvar_vars;current->next != cvar;current = current->next)
 382                                         ;
 383                                 current->next = variable;
 384                         }
 385
 386                         // get rid of old allocated cvar
 387                         // (but not cvar->string and cvar->defstring, because we kept those)
 388                         Z_Free(cvar->name);
 389                         Z_Free(cvar);
 390                 }
 391                 else
 392                         Con_Printf("Can't register variable %s, already defined\n", variable->name);
 393                 return;
 394         }
 395
 396 // check for overlap with a command
 397         if (Cmd_Exists (variable->name))
 398         {
 399                 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
 400                 return;
 401         }
 402
 403 // copy the value off, because future sets will Z_Free it
 404         oldstr = variable->string;
 405         alloclen = strlen(variable->string) + 1;
 406         variable->string = (char *)Z_Malloc (alloclen);
 407         memcpy (variable->string, oldstr, alloclen);
 408         variable->defstring = (char *)Z_Malloc (alloclen);
 409         memcpy (variable->defstring, oldstr, alloclen);
 410         variable->value = atof (variable->string);
 411         variable->integer = (int) variable->value;
 412
 413 // link the variable in
 414 // alphanumerical order
 415         for( current = NULL, next = cvar_vars ; next && strcmp( next->name, variable->name ) < 0 ; current = next, next = next->next )
 416                 ;
 417         if( current ) {
 418                 current->next = variable;
 419         } else {
 420                 cvar_vars = variable;
 421         }
 422         variable->next = next;
 423
 424         // link to head of list in this hash table index
 425         hashindex = CRC_Block((const unsigned char *)variable->name, strlen(variable->name));
 426         variable->nextonhashchain = cvar_hashtable[hashindex];
 427         cvar_hashtable[hashindex] = variable;
 428 }
 429
 430 /*
 431 ============
 432 Cvar_Get
 433
 434 Adds a newly allocated variable to the variable list or sets its value.
 435 ============
 436 */
 437 cvar_t *Cvar_Get (const char *name, const char *value, int flags)
 438 {
 439         int hashindex;
 440         cvar_t *current, *next, *cvar;
 441         size_t alloclen;
 442
 443         if (developer.integer >= 100)
 444                 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
 445
 446 // first check to see if it has already been defined
 447         cvar = Cvar_FindVar (name);
 448         if (cvar)
 449         {
 450                 cvar->flags |= flags;
 451                 Cvar_SetQuick_Internal (cvar, value);
 452                 return cvar;
 453         }
 454
 455 // check for overlap with a command
 456         if (Cmd_Exists (name))
 457         {
 458                 Con_Printf("Cvar_Get: %s is a command\n", name);
 459                 return NULL;
 460         }
 461
 462 // allocate a new cvar, cvar name, and cvar string
 463 // TODO: factorize the following code with the one at the end of Cvar_RegisterVariable()
 464 // FIXME: these never get Z_Free'd
 465         cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
 466         cvar->flags = flags | CVAR_ALLOCATED;
 467         alloclen = strlen(name) + 1;
 468         cvar->name = (char *)Z_Malloc(alloclen);
 469         memcpy(cvar->name, name, alloclen);
 470         alloclen = strlen(value) + 1;
 471         cvar->string = (char *)Z_Malloc(alloclen);
 472         memcpy(cvar->string, value, alloclen);
 473         cvar->defstring = (char *)Z_Malloc(alloclen);
 474         memcpy(cvar->defstring, value, alloclen);
 475         cvar->value = atof (cvar->string);
 476         cvar->integer = (int) cvar->value;
 477         cvar->description = "custom cvar";
 478
 479 // link the variable in
 480 // alphanumerical order
 481         for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
 482                 ;
 483         if( current )
 484                 current->next = cvar;
 485         else
 486                 cvar_vars = cvar;
 487         cvar->next = next;
 488
 489         // link to head of list in this hash table index
 490         hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
 491         cvar->nextonhashchain = cvar_hashtable[hashindex];
 492         cvar_hashtable[hashindex] = cvar;
 493
 494         return cvar;
 495 }
 496
 497
 498 /*
 499 ============
 500 Cvar_Command
 501
 502 Handles variable inspection and changing from the console
 503 ============
 504 */
 505 qboolean        Cvar_Command (void)
 506 {
 507         cvar_t                  *v;
 508
 509 // check variables
 510         v = Cvar_FindVar (Cmd_Argv(0));
 511         if (!v)
 512                 return false;
 513
 514 // perform a variable print or set
 515         if (Cmd_Argc() == 1)
 516         {
 517                 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
 518                 return true;
 519         }
 520
 521         if (developer.integer >= 100)
 522                 Con_DPrint("Cvar_Command: ");
 523
 524         if (v->flags & CVAR_READONLY)
 525         {
 526                 Con_Printf("%s is read-only\n", v->name);
 527                 return true;
 528         }
 529         Cvar_Set (v->name, Cmd_Argv(1));
 530         if (developer.integer >= 100)
 531                 Con_DPrint("\n");
 532         return true;
 533 }
 534
 535
 536 void Cvar_UnlockDefaults (void)
 537 {
 538         cvar_t *var;
 539         // unlock the default values of all cvars
 540         for (var = cvar_vars ; var ; var = var->next)
 541                 var->flags &= ~CVAR_DEFAULTSET;
 542 }
 543
 544
 545 void Cvar_LockDefaults_f (void)
 546 {
 547         cvar_t *var;
 548         // lock in the default values of all cvars
 549         for (var = cvar_vars ; var ; var = var->next)
 550         {
 551                 if (!(var->flags & CVAR_DEFAULTSET))
 552                 {
 553                         size_t alloclen;
 554
 555                         //Con_Printf("locking cvar %s (%s -> %s)\n", var->name, var->string, var->defstring);
 556                         var->flags |= CVAR_DEFAULTSET;
 557                         Z_Free(var->defstring);
 558                         alloclen = strlen(var->string) + 1;
 559                         var->defstring = (char *)Z_Malloc(alloclen);
 560                         memcpy(var->defstring, var->string, alloclen);
 561                 }
 562         }
 563 }
 564
 565
 566 void Cvar_ResetToDefaults_All_f (void)
 567 {
 568         cvar_t *var;
 569         // restore the default values of all cvars
 570         for (var = cvar_vars ; var ; var = var->next)
 571                 Cvar_SetQuick(var, var->defstring);
 572 }
 573
 574
 575 void Cvar_ResetToDefaults_NoSaveOnly_f (void)
 576 {
 577         cvar_t *var;
 578         // restore the default values of all cvars
 579         for (var = cvar_vars ; var ; var = var->next)
 580                 if (!(var->flags & CVAR_SAVE))
 581                         Cvar_SetQuick(var, var->defstring);
 582 }
 583
 584
 585 void Cvar_ResetToDefaults_SaveOnly_f (void)
 586 {
 587         cvar_t *var;
 588         // restore the default values of all cvars
 589         for (var = cvar_vars ; var ; var = var->next)
 590                 if (var->flags & CVAR_SAVE)
 591                         Cvar_SetQuick(var, var->defstring);
 592 }
 593
 594
 595 /*
 596 ============
 597 Cvar_WriteVariables
 598
 599 Writes lines containing "set variable value" for all variables
 600 with the archive flag set to true.
 601 ============
 602 */
 603 void Cvar_WriteVariables (qfile_t *f)
 604 {
 605         cvar_t  *var;
 606
 607         // don't save cvars that match their default value
 608         for (var = cvar_vars ; var ; var = var->next)
 609                 if ((var->flags & CVAR_SAVE) && (strcmp(var->string, var->defstring) || (var->flags & CVAR_ALLOCATED)))
 610                         FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
 611 }
 612
 613
 614 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 615 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 616 /*
 617 =========
 618 Cvar_List
 619 =========
 620 */
 621 void Cvar_List_f (void)
 622 {
 623         cvar_t *cvar;
 624         const char *partial;
 625         size_t len;
 626         int count;
 627
 628         if (Cmd_Argc() > 1)
 629         {
 630                 partial = Cmd_Argv (1);
 631                 len = strlen(partial);
 632         }
 633         else
 634         {
 635                 partial = NULL;
 636                 len = 0;
 637         }
 638
 639         count = 0;
 640         for (cvar = cvar_vars; cvar; cvar = cvar->next)
 641         {
 642                 if (partial && strncasecmp (partial,cvar->name,len))
 643                         continue;
 644
 645                 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
 646                 count++;
 647         }
 648
 649         if (partial)
 650                 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
 651         else
 652                 Con_Printf("%i cvar(s)\n", count);
 653 }
 654 // 2000-01-09 CvarList command by Maddes
 655
 656 void Cvar_Set_f (void)
 657 {
 658         cvar_t *cvar;
 659
 660         // make sure it's the right number of parameters
 661         if (Cmd_Argc() < 3)
 662         {
 663                 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
 664                 return;
 665         }
 666
 667         // check if it's read-only
 668         cvar = Cvar_FindVar(Cmd_Argv(1));
 669         if (cvar && cvar->flags & CVAR_READONLY)
 670         {
 671                 Con_Printf("Set: %s is read-only\n", cvar->name);
 672                 return;
 673         }
 674
 675         if (developer.integer >= 100)
 676                 Con_DPrint("Set: ");
 677
 678         // all looks ok, create/modify the cvar
 679         Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
 680 }
 681
 682 void Cvar_SetA_f (void)
 683 {
 684         cvar_t *cvar;
 685
 686         // make sure it's the right number of parameters
 687         if (Cmd_Argc() < 3)
 688         {
 689                 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
 690                 return;
 691         }
 692
 693         // check if it's read-only
 694         cvar = Cvar_FindVar(Cmd_Argv(1));
 695         if (cvar && cvar->flags & CVAR_READONLY)
 696         {
 697                 Con_Printf("SetA: %s is read-only\n", cvar->name);
 698                 return;
 699         }
 700
 701         if (developer.integer >= 100)
 702                 Con_DPrint("SetA: ");
 703
 704         // all looks ok, create/modify the cvar
 705         Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);
 706 }
 707
 708