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
 219         changed = strcmp(var->string, value);
 220         // LordHavoc: don't reallocate when there is no change
 221         if (!changed)
 222                 return;
 223
 224         // LordHavoc: don't reallocate when the buffer is the same size
 225         if (!var->string || strlen(var->string) != strlen(value))
 226         {
 227                 Z_Free (var->string);   // free the old value string
 228
 229                 var->string = (char *)Z_Malloc (strlen(value)+1);
 230         }
 231         strcpy (var->string, value);
 232         var->value = atof (var->string);
 233         var->integer = (int) var->value;
 234         if ((var->flags & CVAR_NOTIFY) && changed && sv.active)
 235                 SV_BroadcastPrintf("\"%s\" changed to \"%s\"\n", var->name, var->string);
 236 #if 0
 237         // TODO: add infostring support to the server?
 238         if ((var->flags & CVAR_SERVERINFO) && changed && sv.active)
 239         {
 240                 InfoString_SetValue(svs.serverinfo, sizeof(svs.serverinfo), var->name, var->string);
 241                 if (sv.active)
 242                 {
 243                         MSG_WriteByte (&sv.reliable_datagram, svc_serverinfostring);
 244                         MSG_WriteString (&sv.reliable_datagram, var->name);
 245                         MSG_WriteString (&sv.reliable_datagram, var->string);
 246                 }
 247         }
 248 #endif
 249         if ((var->flags & CVAR_USERINFO) && changed && cls.state != ca_dedicated)
 250         {
 251                 InfoString_SetValue(cls.userinfo, sizeof(cls.userinfo), var->name, var->string);
 252                 if (cls.state == ca_connected)
 253                         Cmd_ForwardStringToServer(va("setinfo \"%s\" \"%s\"\n", var->name, var->string));
 254         }
 255 }
 256
 257 void Cvar_SetQuick (cvar_t *var, const char *value)
 258 {
 259         if (var == NULL)
 260         {
 261                 Con_Print("Cvar_SetQuick: var == NULL\n");
 262                 return;
 263         }
 264
 265         if (developer.integer >= 100)
 266                 Con_Printf("Cvar_SetQuick({\"%s\", \"%s\", %i, \"%s\"}, \"%s\");\n", var->name, var->string, var->flags, var->defstring, value);
 267
 268         Cvar_SetQuick_Internal(var, value);
 269 }
 270
 271 void Cvar_Set (const char *var_name, const char *value)
 272 {
 273         cvar_t *var;
 274         var = Cvar_FindVar (var_name);
 275         if (var == NULL)
 276         {
 277                 Con_Printf("Cvar_Set: variable %s not found\n", var_name);
 278                 return;
 279         }
 280         Cvar_SetQuick(var, value);
 281 }
 282
 283 /*
 284 ============
 285 Cvar_SetValue
 286 ============
 287 */
 288 void Cvar_SetValueQuick(cvar_t *var, float value)
 289 {
 290         char val[MAX_INPUTLINE];
 291
 292         if ((float)((int)value) == value)
 293                 sprintf(val, "%i", (int)value);
 294         else
 295                 sprintf(val, "%f", value);
 296         Cvar_SetQuick(var, val);
 297 }
 298
 299 void Cvar_SetValue(const char *var_name, float value)
 300 {
 301         char val[MAX_INPUTLINE];
 302
 303         if ((float)((int)value) == value)
 304                 sprintf(val, "%i", (int)value);
 305         else
 306                 sprintf(val, "%f", value);
 307         Cvar_Set(var_name, val);
 308 }
 309
 310 /*
 311 ============
 312 Cvar_RegisterVariable
 313
 314 Adds a freestanding variable to the variable list.
 315 ============
 316 */
 317 void Cvar_RegisterVariable (cvar_t *variable)
 318 {
 319         int hashindex;
 320         cvar_t *current, *next, *cvar;
 321         char *oldstr;
 322
 323         if (developer.integer >= 100)
 324                 Con_Printf("Cvar_RegisterVariable({\"%s\", \"%s\", %i});\n", variable->name, variable->string, variable->flags);
 325
 326 // first check to see if it has already been defined
 327         cvar = Cvar_FindVar (variable->name);
 328         if (cvar)
 329         {
 330                 if (cvar->flags & CVAR_ALLOCATED)
 331                 {
 332                         if (developer.integer >= 100)
 333                                 Con_Printf("...  replacing existing allocated cvar {\"%s\", \"%s\", %i}\n", cvar->name, cvar->string, cvar->flags);
 334                         // fixed variables replace allocated ones
 335                         // (because the engine directly accesses fixed variables)
 336                         // NOTE: this isn't actually used currently
 337                         // (all cvars are registered before config parsing)
 338                         variable->flags |= (cvar->flags & ~CVAR_ALLOCATED);
 339                         // cvar->string is now owned by variable instead
 340                         variable->string = cvar->string;
 341                         variable->defstring = cvar->defstring;
 342                         variable->value = atof (variable->string);
 343                         variable->integer = (int) variable->value;
 344                         // replace cvar with this one...
 345                         variable->next = cvar->next;
 346                         if (cvar_vars == cvar)
 347                         {
 348                                 // head of the list is easy to change
 349                                 cvar_vars = variable;
 350                         }
 351                         else
 352                         {
 353                                 // otherwise find it somewhere in the list
 354                                 for (current = cvar_vars;current->next != cvar;current = current->next)
 355                                         ;
 356                                 current->next = variable;
 357                         }
 358
 359                         // get rid of old allocated cvar
 360                         // (but not cvar->string and cvar->defstring, because we kept those)
 361                         Z_Free(cvar->name);
 362                         Z_Free(cvar);
 363                 }
 364                 else
 365                         Con_Printf("Can't register variable %s, already defined\n", variable->name);
 366                 return;
 367         }
 368
 369 // check for overlap with a command
 370         if (Cmd_Exists (variable->name))
 371         {
 372                 Con_Printf("Cvar_RegisterVariable: %s is a command\n", variable->name);
 373                 return;
 374         }
 375
 376 // copy the value off, because future sets will Z_Free it
 377         oldstr = variable->string;
 378         variable->string = (char *)Z_Malloc (strlen(variable->string)+1);
 379         strcpy (variable->string, oldstr);
 380         variable->defstring = (char *)Z_Malloc (strlen(variable->string)+1);
 381         strcpy (variable->defstring, oldstr);
 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
 414         if (developer.integer >= 100)
 415                 Con_Printf("Cvar_Get(\"%s\", \"%s\", %i);\n", name, value, flags);
 416
 417 // first check to see if it has already been defined
 418         cvar = Cvar_FindVar (name);
 419         if (cvar)
 420         {
 421                 cvar->flags |= flags;
 422                 Cvar_SetQuick_Internal (cvar, value);
 423                 // also set the default value (but only once)
 424                 if (~cvar->flags & CVAR_DEFAULTSET)
 425                 {
 426                         cvar->flags |= CVAR_DEFAULTSET;
 427
 428                         Z_Free(cvar->defstring);
 429                         cvar->defstring = (char *)Z_Malloc(strlen(value) + 1);
 430                         strcpy(cvar->defstring, value);
 431                 }
 432                 return cvar;
 433         }
 434
 435 // check for overlap with a command
 436         if (Cmd_Exists (name))
 437         {
 438                 Con_Printf("Cvar_Get: %s is a command\n", name);
 439                 return NULL;
 440         }
 441
 442 // allocate a new cvar, cvar name, and cvar string
 443 // FIXME: these never get Z_Free'd
 444         cvar = (cvar_t *)Z_Malloc(sizeof(cvar_t));
 445         cvar->flags = flags | CVAR_ALLOCATED | CVAR_DEFAULTSET;
 446         cvar->name = (char *)Z_Malloc(strlen(name)+1);
 447         strcpy(cvar->name, name);
 448         cvar->string = (char *)Z_Malloc(strlen(value)+1);
 449         strcpy(cvar->string, value);
 450         cvar->defstring = (char *)Z_Malloc(strlen(value)+1);
 451         strcpy(cvar->defstring, value);
 452         cvar->value = atof (cvar->string);
 453         cvar->integer = (int) cvar->value;
 454         cvar->description = "custom cvar";
 455
 456 // link the variable in
 457 // alphanumerical order
 458         for( current = NULL, next = cvar_vars ; next && strcmp( next->name, cvar->name ) < 0 ; current = next, next = next->next )
 459                 ;
 460         if( current )
 461                 current->next = cvar;
 462         else
 463                 cvar_vars = cvar;
 464         cvar->next = next;
 465
 466         // link to head of list in this hash table index
 467         hashindex = CRC_Block((const unsigned char *)cvar->name, strlen(cvar->name));
 468         cvar->nextonhashchain = cvar_hashtable[hashindex];
 469         cvar_hashtable[hashindex] = cvar;
 470
 471         return cvar;
 472 }
 473
 474
 475 /*
 476 ============
 477 Cvar_Command
 478
 479 Handles variable inspection and changing from the console
 480 ============
 481 */
 482 qboolean        Cvar_Command (void)
 483 {
 484         cvar_t                  *v;
 485
 486 // check variables
 487         v = Cvar_FindVar (Cmd_Argv(0));
 488         if (!v)
 489                 return false;
 490
 491 // perform a variable print or set
 492         if (Cmd_Argc() == 1)
 493         {
 494                 Con_Printf("\"%s\" is \"%s\" [\"%s\"]\n", v->name, v->string, v->defstring);
 495                 return true;
 496         }
 497
 498         Con_DPrint("Cvar_Command: ");
 499
 500         if (v->flags & CVAR_READONLY)
 501         {
 502                 Con_Printf("%s is read-only\n", v->name);
 503                 return true;
 504         }
 505         Cvar_Set (v->name, Cmd_Argv(1));
 506         return true;
 507 }
 508
 509
 510 /*
 511 ============
 512 Cvar_WriteVariables
 513
 514 Writes lines containing "set variable value" for all variables
 515 with the archive flag set to true.
 516 ============
 517 */
 518 void Cvar_WriteVariables (qfile_t *f)
 519 {
 520         cvar_t  *var;
 521
 522         for (var = cvar_vars ; var ; var = var->next)
 523                 if (var->flags & CVAR_SAVE)
 524                         FS_Printf(f, "%s%s \"%s\"\n", var->flags & CVAR_ALLOCATED ? "seta " : "", var->name, var->string);
 525 }
 526
 527
 528 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 529 // 2000-01-09 CvarList command By Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 530 /*
 531 =========
 532 Cvar_List
 533 =========
 534 */
 535 void Cvar_List_f (void)
 536 {
 537         cvar_t *cvar;
 538         const char *partial;
 539         size_t len;
 540         int count;
 541
 542         if (Cmd_Argc() > 1)
 543         {
 544                 partial = Cmd_Argv (1);
 545                 len = strlen(partial);
 546         }
 547         else
 548         {
 549                 partial = NULL;
 550                 len = 0;
 551         }
 552
 553         count = 0;
 554         for (cvar = cvar_vars; cvar; cvar = cvar->next)
 555         {
 556                 if (partial && strncasecmp (partial,cvar->name,len))
 557                         continue;
 558
 559                 Con_Printf("%s is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
 560                 count++;
 561         }
 562
 563         if (partial)
 564                 Con_Printf("%i cvar(s) beginning with \"%s\"\n", count, partial);
 565         else
 566                 Con_Printf("%i cvar(s)\n", count);
 567 }
 568 // 2000-01-09 CvarList command by Maddes
 569
 570 void Cvar_Set_f (void)
 571 {
 572         cvar_t *cvar;
 573
 574         // make sure it's the right number of parameters
 575         if (Cmd_Argc() < 3)
 576         {
 577                 Con_Printf("Set: wrong number of parameters, usage: set <variablename> <value>\n");
 578                 return;
 579         }
 580
 581         // check if it's read-only
 582         cvar = Cvar_FindVar(Cmd_Argv(1));
 583         if (cvar && cvar->flags & CVAR_READONLY)
 584         {
 585                 Con_Printf("Set: %s is read-only\n", cvar->name);
 586                 return;
 587         }
 588
 589         Con_DPrint("Set: ");
 590
 591         // all looks ok, create/modify the cvar
 592         Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), 0);
 593 }
 594
 595 void Cvar_SetA_f (void)
 596 {
 597         cvar_t *cvar;
 598
 599         // make sure it's the right number of parameters
 600         if (Cmd_Argc() < 3)
 601         {
 602                 Con_Printf("SetA: wrong number of parameters, usage: seta <variablename> <value>\n");
 603                 return;
 604         }
 605
 606         // check if it's read-only
 607         cvar = Cvar_FindVar(Cmd_Argv(1));
 608         if (cvar && cvar->flags & CVAR_READONLY)
 609         {
 610                 Con_Printf("SetA: %s is read-only\n", cvar->name);
 611                 return;
 612         }
 613
 614         Con_DPrint("SetA: ");
 615
 616         // all looks ok, create/modify the cvar
 617         Cvar_Get(Cmd_Argv(1), Cmd_Argv(2), CVAR_SAVE);
 618 }
 619
 620