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