cmd.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 // cmd.c -- Quake script command processing module
  21
  22 #include "quakedef.h"
  23
  24 #define MAX_ALIAS_NAME  32
  25 // this is the largest script file that can be executed in one step
  26 // LordHavoc: inreased this from 8192 to 32768
  27 #define CMDBUFSIZE 32768
  28 // maximum number of parameters to a command
  29 #define MAX_ARGS 80
  30 // maximum tokenizable commandline length (counting NUL terminations)
  31 #define CMD_TOKENIZELENGTH (MAX_INPUTLINE + 80)
  32
  33 typedef struct cmdalias_s
  34 {
  35         struct cmdalias_s *next;
  36         char name[MAX_ALIAS_NAME];
  37         char *value;
  38 } cmdalias_t;
  39
  40 static cmdalias_t *cmd_alias;
  41
  42 static qboolean cmd_wait;
  43
  44 static mempool_t *cmd_mempool;
  45
  46 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
  47 static int cmd_tokenizebufferpos = 0;
  48
  49 //=============================================================================
  50
  51 /*
  52 ============
  53 Cmd_Wait_f
  54
  55 Causes execution of the remainder of the command buffer to be delayed until
  56 next frame.  This allows commands like:
  57 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
  58 ============
  59 */
  60 static void Cmd_Wait_f (void)
  61 {
  62         cmd_wait = true;
  63 }
  64
  65 /*
  66 =============================================================================
  67
  68                                                 COMMAND BUFFER
  69
  70 =============================================================================
  71 */
  72
  73 static sizebuf_t        cmd_text;
  74 static unsigned char            cmd_text_buf[CMDBUFSIZE];
  75
  76 /*
  77 ============
  78 Cbuf_AddText
  79
  80 Adds command text at the end of the buffer
  81 ============
  82 */
  83 void Cbuf_AddText (const char *text)
  84 {
  85         int             l;
  86
  87         l = (int)strlen (text);
  88
  89         if (cmd_text.cursize + l >= cmd_text.maxsize)
  90         {
  91                 Con_Print("Cbuf_AddText: overflow\n");
  92                 return;
  93         }
  94
  95         SZ_Write (&cmd_text, (const unsigned char *)text, (int)strlen (text));
  96 }
  97
  98
  99 /*
 100 ============
 101 Cbuf_InsertText
 102
 103 Adds command text immediately after the current command
 104 Adds a \n to the text
 105 FIXME: actually change the command buffer to do less copying
 106 ============
 107 */
 108 void Cbuf_InsertText (const char *text)
 109 {
 110         char    *temp;
 111         int             templen;
 112
 113         // copy off any commands still remaining in the exec buffer
 114         templen = cmd_text.cursize;
 115         if (templen)
 116         {
 117                 temp = (char *)Mem_Alloc (tempmempool, templen);
 118                 memcpy (temp, cmd_text.data, templen);
 119                 SZ_Clear (&cmd_text);
 120         }
 121         else
 122                 temp = NULL;
 123
 124         // add the entire text of the file
 125         Cbuf_AddText (text);
 126
 127         // add the copied off data
 128         if (temp != NULL)
 129         {
 130                 SZ_Write (&cmd_text, (const unsigned char *)temp, templen);
 131                 Mem_Free (temp);
 132         }
 133 }
 134
 135 /*
 136 ============
 137 Cbuf_Execute
 138 ============
 139 */
 140 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
 141 void Cbuf_Execute (void)
 142 {
 143         int i;
 144         char *text;
 145         char line[MAX_INPUTLINE];
 146         char preprocessed[MAX_INPUTLINE];
 147         int quotes;
 148
 149         // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
 150         cmd_tokenizebufferpos = 0;
 151
 152         while (cmd_text.cursize)
 153         {
 154 // find a \n or ; line break
 155                 text = (char *)cmd_text.data;
 156
 157                 quotes = 0;
 158                 for (i=0 ; i< cmd_text.cursize ; i++)
 159                 {
 160                         if (text[i] == '"')
 161                                 quotes ^= 1;
 162                         if ( !quotes &&  text[i] == ';')
 163                                 break;  // don't break if inside a quoted string
 164                         if (text[i] == '\r' || text[i] == '\n')
 165                                 break;
 166                 }
 167
 168                 memcpy (line, text, i);
 169                 line[i] = 0;
 170
 171 // delete the text from the command buffer and move remaining commands down
 172 // this is necessary because commands (exec, alias) can insert data at the
 173 // beginning of the text buffer
 174
 175                 if (i == cmd_text.cursize)
 176                         cmd_text.cursize = 0;
 177                 else
 178                 {
 179                         i++;
 180                         cmd_text.cursize -= i;
 181                         memcpy (cmd_text.data, text+i, cmd_text.cursize);
 182                 }
 183
 184 // execute the command line
 185                 Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
 186                 Cmd_ExecuteString (preprocessed, src_command);
 187
 188                 if (cmd_wait)
 189                 {       // skip out while text still remains in buffer, leaving it
 190                         // for next frame
 191                         cmd_wait = false;
 192                         break;
 193                 }
 194         }
 195 }
 196
 197 /*
 198 ==============================================================================
 199
 200                                                 SCRIPT COMMANDS
 201
 202 ==============================================================================
 203 */
 204
 205 /*
 206 ===============
 207 Cmd_StuffCmds_f
 208
 209 Adds command line parameters as script statements
 210 Commands lead with a +, and continue until a - or another +
 211 quake +prog jctest.qp +cmd amlev1
 212 quake -nosound +cmd amlev1
 213 ===============
 214 */
 215 qboolean host_stuffcmdsrun = false;
 216 void Cmd_StuffCmds_f (void)
 217 {
 218         int             i, j, l;
 219         // this is for all commandline options combined (and is bounds checked)
 220         char    build[MAX_INPUTLINE];
 221
 222         if (Cmd_Argc () != 1)
 223         {
 224                 Con_Print("stuffcmds : execute command line parameters\n");
 225                 return;
 226         }
 227
 228         // no reason to run the commandline arguments twice
 229         if (host_stuffcmdsrun)
 230                 return;
 231
 232         host_stuffcmdsrun = true;
 233         build[0] = 0;
 234         l = 0;
 235         for (i = 0;i < com_argc;i++)
 236         {
 237                 if (com_argv[i] && com_argv[i][0] == '+' && (com_argv[i][1] < '0' || com_argv[i][1] > '9') && l + strlen(com_argv[i]) - 1 <= sizeof(build) - 1)
 238                 {
 239                         j = 1;
 240                         while (com_argv[i][j])
 241                                 build[l++] = com_argv[i][j++];
 242                         i++;
 243                         for (;i < com_argc;i++)
 244                         {
 245                                 if (!com_argv[i])
 246                                         continue;
 247                                 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
 248                                         break;
 249                                 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
 250                                         break;
 251                                 build[l++] = ' ';
 252                                 if (strchr(com_argv[i], ' '))
 253                                         build[l++] = '\"';
 254                                 for (j = 0;com_argv[i][j];j++)
 255                                         build[l++] = com_argv[i][j];
 256                                 if (strchr(com_argv[i], ' '))
 257                                         build[l++] = '\"';
 258                         }
 259                         build[l++] = '\n';
 260                         i--;
 261                 }
 262         }
 263         // now terminate the combined string and prepend it to the command buffer
 264         // we already reserved space for the terminator
 265         build[l++] = 0;
 266         Cbuf_InsertText (build);
 267 }
 268
 269
 270 /*
 271 ===============
 272 Cmd_Exec_f
 273 ===============
 274 */
 275 static void Cmd_Exec_f (void)
 276 {
 277         char *f;
 278
 279         if (Cmd_Argc () != 2)
 280         {
 281                 Con_Print("exec <filename> : execute a script file\n");
 282                 return;
 283         }
 284
 285         f = (char *)FS_LoadFile (Cmd_Argv(1), tempmempool, false, NULL);
 286         if (!f)
 287         {
 288                 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
 289                 return;
 290         }
 291         Con_DPrintf("execing %s\n",Cmd_Argv(1));
 292
 293         // if executing default.cfg for the first time, lock the cvar defaults
 294         // it may seem backwards to insert this text BEFORE the default.cfg
 295         // but Cbuf_InsertText inserts before, so this actually ends up after it.
 296         if (!strcmp(Cmd_Argv(1), "default.cfg"))
 297                 Cbuf_InsertText("\ncvar_lockdefaults\n");
 298
 299         // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
 300         // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
 301         Cbuf_InsertText ("\n");
 302         Cbuf_InsertText (f);
 303         Mem_Free(f);
 304 }
 305
 306
 307 /*
 308 ===============
 309 Cmd_Echo_f
 310
 311 Just prints the rest of the line to the console
 312 ===============
 313 */
 314 static void Cmd_Echo_f (void)
 315 {
 316         int             i;
 317
 318         for (i=1 ; i<Cmd_Argc() ; i++)
 319                 Con_Printf("%s ",Cmd_Argv(i));
 320         Con_Print("\n");
 321 }
 322
 323 // DRESK - 5/14/06
 324 // Support Doom3-style Toggle Console Command
 325 /*
 326 ===============
 327 Cmd_Toggle_f
 328
 329 Toggles a specified console variable amongst the values specified (default is 0 and 1)
 330 ===============
 331 */
 332 static void Cmd_Toggle_f(void)
 333 {
 334         // Acquire Number of Arguments
 335         int nNumArgs = Cmd_Argc();
 336
 337         if(nNumArgs == 1)
 338                 // No Arguments Specified; Print Usage
 339                 Con_Print("Toggle Console Variable - Usage\n  toggle <variable> - toggles between 0 and 1\n  toggle <variable> <value> - toggles between 0 and <value>\n  toggle <variable> [string 1] [string 2]...[string n] - cycles through all strings\n");
 340         else
 341         { // Correct Arguments Specified
 342                 // Acquire Potential CVar
 343                 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
 344
 345                 if(cvCVar != NULL)
 346                 { // Valid CVar
 347                         if(nNumArgs == 2)
 348                         { // Default Usage
 349                                 if(cvCVar->integer)
 350                                         Cvar_SetValueQuick(cvCVar, 0);
 351                                 else
 352                                         Cvar_SetValueQuick(cvCVar, 1);
 353                         }
 354                         else
 355                         if(nNumArgs == 3)
 356                         { // 0 and Specified Usage
 357                                 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
 358                                         // CVar is Specified Value; // Reset to 0
 359                                         Cvar_SetValueQuick(cvCVar, 0);
 360                                 else
 361                                 if(cvCVar->integer == 0)
 362                                         // CVar is 0; Specify Value
 363                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
 364                                 else
 365                                         // CVar does not match; Reset to 0
 366                                         Cvar_SetValueQuick(cvCVar, 0);
 367                         }
 368                         else
 369                         { // Variable Values Specified
 370                                 int nCnt;
 371                                 int bFound = 0;
 372
 373                                 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
 374                                 { // Cycle through Values
 375                                         if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
 376                                         { // Current Value Located; Increment to Next
 377                                                 if( (nCnt + 1) == nNumArgs)
 378                                                         // Max Value Reached; Reset
 379                                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
 380                                                 else
 381                                                         // Next Value
 382                                                         Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
 383
 384                                                 // End Loop
 385                                                 nCnt = nNumArgs;
 386                                                 // Assign Found
 387                                                 bFound = 1;
 388                                         }
 389                                 }
 390                                 if(!bFound)
 391                                         // Value not Found; Reset to Original
 392                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
 393                         }
 394
 395                 }
 396                 else
 397                 { // Invalid CVar
 398                         Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(2) );
 399                 }
 400         }
 401 }
 402
 403 /*
 404 ===============
 405 Cmd_Alias_f
 406
 407 Creates a new command that executes a command string (possibly ; seperated)
 408 ===============
 409 */
 410 static void Cmd_Alias_f (void)
 411 {
 412         cmdalias_t      *a;
 413         char            cmd[MAX_INPUTLINE];
 414         int                     i, c;
 415         const char              *s;
 416         size_t          alloclen;
 417
 418         if (Cmd_Argc() == 1)
 419         {
 420                 Con_Print("Current alias commands:\n");
 421                 for (a = cmd_alias ; a ; a=a->next)
 422                         Con_Printf("%s : %s\n", a->name, a->value);
 423                 return;
 424         }
 425
 426         s = Cmd_Argv(1);
 427         if (strlen(s) >= MAX_ALIAS_NAME)
 428         {
 429                 Con_Print("Alias name is too long\n");
 430                 return;
 431         }
 432
 433         // if the alias already exists, reuse it
 434         for (a = cmd_alias ; a ; a=a->next)
 435         {
 436                 if (!strcmp(s, a->name))
 437                 {
 438                         Z_Free (a->value);
 439                         break;
 440                 }
 441         }
 442
 443         if (!a)
 444         {
 445                 cmdalias_t *prev, *current;
 446
 447                 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
 448                 strlcpy (a->name, s, sizeof (a->name));
 449                 // insert it at the right alphanumeric position
 450                 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
 451                         ;
 452                 if( prev ) {
 453                         prev->next = a;
 454                 } else {
 455                         cmd_alias = a;
 456                 }
 457                 a->next = current;
 458         }
 459
 460
 461 // copy the rest of the command line
 462         cmd[0] = 0;             // start out with a null string
 463         c = Cmd_Argc();
 464         for (i=2 ; i< c ; i++)
 465         {
 466                 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
 467                 if (i != c)
 468                         strlcat (cmd, " ", sizeof (cmd));
 469         }
 470         strlcat (cmd, "\n", sizeof (cmd));
 471
 472         alloclen = strlen (cmd) + 1;
 473         a->value = (char *)Z_Malloc (alloclen);
 474         memcpy (a->value, cmd, alloclen);
 475 }
 476
 477 /*
 478 =============================================================================
 479
 480                                         COMMAND EXECUTION
 481
 482 =============================================================================
 483 */
 484
 485 typedef struct cmd_function_s
 486 {
 487         struct cmd_function_s *next;
 488         const char *name;
 489         const char *description;
 490         xcommand_t consolefunction;
 491         xcommand_t clientfunction;
 492         qboolean csqcfunc;
 493 } cmd_function_t;
 494
 495 static int cmd_argc;
 496 static const char *cmd_argv[MAX_ARGS];
 497 static const char *cmd_null_string = "";
 498 static const char *cmd_args;
 499 cmd_source_t cmd_source;
 500
 501
 502 static cmd_function_t *cmd_functions;           // possible commands to execute
 503
 504 /*
 505 Cmd_PreprocessString
 506
 507 Preprocesses strings and replaces $*, $param#, $cvar accordingly
 508 */
 509 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
 510         const char *in;
 511         unsigned outlen;
 512         int inquote;
 513
 514         // don't crash if there's no room in the outtext buffer
 515         if( maxoutlen == 0 ) {
 516                 return;
 517         }
 518         maxoutlen--; // because of \0
 519
 520         in = intext;
 521         outlen = 0;
 522         inquote = 0;
 523
 524         while( *in && outlen < maxoutlen ) {
 525                 if( *in == '$' && !inquote ) {
 526                         // this is some kind of expansion, see what comes after the $
 527                         in++;
 528                         // replacements that can always be used:
 529                         // $$ is replaced with $, to allow escaping $
 530                         // $<cvarname> is replaced with the contents of the cvar
 531                         //
 532                         // the following can be used in aliases only:
 533                         // $* is replaced with all formal parameters (including name of the alias - this probably is not desirable)
 534                         // $0 is replaced with the name of this alias
 535                         // $<number> is replaced with an argument to this alias (or copied as-is if no such parameter exists), can be multiple digits
 536                         if( *in == '$' ) {
 537                                 outtext[outlen++] = *in++;
 538                         } else if( *in == '*' && alias ) {
 539                                 const char *linein = Cmd_Args();
 540
 541                                 // include all parameters
 542                                 if (linein) {
 543                                         while( *linein && outlen < maxoutlen ) {
 544                                                 outtext[outlen++] = *linein++;
 545                                         }
 546                                 }
 547
 548                                 in++;
 549                         } else if( '0' <= *in && *in <= '9' && alias ) {
 550                                 char *nexttoken;
 551                                 int argnum;
 552
 553                                 argnum = strtol( in, &nexttoken, 10 );
 554
 555                                 if( 0 <= argnum && argnum < Cmd_Argc() ) {
 556                                         const char *param = Cmd_Argv( argnum );
 557                                         while( *param && outlen < maxoutlen ) {
 558                                                 outtext[outlen++] = *param++;
 559                                         }
 560                                         in = nexttoken;
 561                                 } else if( argnum >= Cmd_Argc() ) {
 562                                         Con_Printf( "Warning: Not enough parameters passed to alias '%s', at least %i expected:\n    %s\n", alias->name, argnum, alias->value );
 563                                         outtext[outlen++] = '$';
 564                                 }
 565                         } else {
 566                                 cvar_t *cvar;
 567                                 const char *tempin = in;
 568
 569                                 COM_ParseTokenConsole( &tempin );
 570                                 // don't expand rcon_password or similar cvars (CVAR_PRIVATE flag)
 571                                 if ((cvar = Cvar_FindVar(&com_token[0])) && !(cvar->flags & CVAR_PRIVATE)) {
 572                                         const char *cvarcontent = cvar->string;
 573                                         while( *cvarcontent && outlen < maxoutlen ) {
 574                                                 outtext[outlen++] = *cvarcontent++;
 575                                         }
 576                                         in = tempin;
 577                                 } else {
 578                                         if( alias ) {
 579                                                 Con_Printf( "Warning: could not find cvar %s when expanding alias %s\n    %s\n", com_token, alias->name, alias->value );
 580                                         } else {
 581                                                 Con_Printf( "Warning: could not find cvar %s\n", com_token );
 582                                         }
 583                                         outtext[outlen++] = '$';
 584                                 }
 585                         }
 586                 } else {
 587                         if( *in == '"' ) {
 588                                 inquote ^= 1;
 589                         }
 590                         outtext[outlen++] = *in++;
 591                 }
 592         }
 593         outtext[outlen] = 0;
 594 }
 595
 596 /*
 597 ============
 598 Cmd_ExecuteAlias
 599
 600 Called for aliases and fills in the alias into the cbuffer
 601 ============
 602 */
 603 static void Cmd_ExecuteAlias (cmdalias_t *alias)
 604 {
 605         static char buffer[ MAX_INPUTLINE + 2 ];
 606         Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
 607         // insert at start of command buffer, so that aliases execute in order
 608         // (fixes bug introduced by Black on 20050705)
 609         Cbuf_InsertText( buffer );
 610 }
 611
 612 /*
 613 ========
 614 Cmd_List
 615
 616         CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
 617         Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 618
 619 ========
 620 */
 621 static void Cmd_List_f (void)
 622 {
 623         cmd_function_t *cmd;
 624         const char *partial;
 625         int len, count;
 626
 627         if (Cmd_Argc() > 1)
 628         {
 629                 partial = Cmd_Argv (1);
 630                 len = (int)strlen(partial);
 631         }
 632         else
 633         {
 634                 partial = NULL;
 635                 len = 0;
 636         }
 637
 638         count = 0;
 639         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 640         {
 641                 if (partial && strncmp(partial, cmd->name, len))
 642                         continue;
 643                 Con_Printf("%s : %s\n", cmd->name, cmd->description);
 644                 count++;
 645         }
 646
 647         if (partial)
 648                 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
 649         else
 650                 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
 651 }
 652
 653 /*
 654 ============
 655 Cmd_Init
 656 ============
 657 */
 658 void Cmd_Init (void)
 659 {
 660         cmd_mempool = Mem_AllocPool("commands", 0, NULL);
 661         // space for commands and script files
 662         cmd_text.data = cmd_text_buf;
 663         cmd_text.maxsize = sizeof(cmd_text_buf);
 664         cmd_text.cursize = 0;
 665 }
 666
 667 void Cmd_Init_Commands (void)
 668 {
 669 //
 670 // register our commands
 671 //
 672         Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
 673         Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
 674         Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
 675         Cmd_AddCommand ("alias",Cmd_Alias_f, "create a script function (parameters are passed in as $1 through $9, and $* for all parameters)");
 676         Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
 677         Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
 678         Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
 679         Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
 680
 681         // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
 682         // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
 683         Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix");
 684         Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix");
 685
 686         Cmd_AddCommand ("cvar_lockdefaults", Cvar_LockDefaults_f, "stores the current values of all cvars into their default values, only used once during startup after parsing default.cfg");
 687         Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
 688         Cmd_AddCommand ("cvar_resettodefaults_nosaveonly", Cvar_ResetToDefaults_NoSaveOnly_f, "sets all non-saved cvars to their locked default values (variables that will not be saved to config.cfg)");
 689         Cmd_AddCommand ("cvar_resettodefaults_saveonly", Cvar_ResetToDefaults_SaveOnly_f, "sets all saved cvars to their locked default values (variables that will be saved to config.cfg)");
 690
 691         // DRESK - 5/14/06
 692         // Support Doom3-style Toggle Command
 693         Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
 694 }
 695
 696 /*
 697 ============
 698 Cmd_Shutdown
 699 ============
 700 */
 701 void Cmd_Shutdown(void)
 702 {
 703         Mem_FreePool(&cmd_mempool);
 704 }
 705
 706 /*
 707 ============
 708 Cmd_Argc
 709 ============
 710 */
 711 int             Cmd_Argc (void)
 712 {
 713         return cmd_argc;
 714 }
 715
 716 /*
 717 ============
 718 Cmd_Argv
 719 ============
 720 */
 721 const char *Cmd_Argv (int arg)
 722 {
 723         if (arg >= cmd_argc )
 724                 return cmd_null_string;
 725         return cmd_argv[arg];
 726 }
 727
 728 /*
 729 ============
 730 Cmd_Args
 731 ============
 732 */
 733 const char *Cmd_Args (void)
 734 {
 735         return cmd_args;
 736 }
 737
 738
 739 /*
 740 ============
 741 Cmd_TokenizeString
 742
 743 Parses the given string into command line tokens.
 744 ============
 745 */
 746 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
 747 static void Cmd_TokenizeString (const char *text)
 748 {
 749         int l;
 750
 751         cmd_argc = 0;
 752         cmd_args = NULL;
 753
 754         while (1)
 755         {
 756                 // skip whitespace up to a /n
 757                 while (*text && *text <= ' ' && *text != '\r' && *text != '\n')
 758                         text++;
 759
 760                 // line endings:
 761                 // UNIX: \n
 762                 // Mac: \r
 763                 // Windows: \r\n
 764                 if (*text == '\n' || *text == '\r')
 765                 {
 766                         // a newline separates commands in the buffer
 767                         if (*text == '\r' && text[1] == '\n')
 768                                 text++;
 769                         text++;
 770                         break;
 771                 }
 772
 773                 if (!*text)
 774                         return;
 775
 776                 if (cmd_argc == 1)
 777                         cmd_args = text;
 778
 779                 if (!COM_ParseTokenConsole(&text))
 780                         return;
 781
 782                 if (cmd_argc < MAX_ARGS)
 783                 {
 784                         l = (int)strlen(com_token) + 1;
 785                         if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
 786                         {
 787                                 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
 788                                 break;
 789                         }
 790                         memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
 791                         cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
 792                         cmd_tokenizebufferpos += l;
 793                         cmd_argc++;
 794                 }
 795         }
 796 }
 797
 798
 799 /*
 800 ============
 801 Cmd_AddCommand
 802 ============
 803 */
 804 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
 805 {
 806         cmd_function_t *cmd;
 807         cmd_function_t *prev, *current;
 808
 809 // fail if the command is a variable name
 810         if (Cvar_FindVar( cmd_name ))
 811         {
 812                 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
 813                 return;
 814         }
 815
 816 // fail if the command already exists
 817         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
 818         {
 819                 if (!strcmp (cmd_name, cmd->name))
 820                 {
 821                         if (consolefunction || clientfunction)
 822                         {
 823                                 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
 824                                 return;
 825                         }
 826                         else    //[515]: csqc
 827                         {
 828                                 cmd->csqcfunc = true;
 829                                 return;
 830                         }
 831                 }
 832         }
 833
 834         cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
 835         cmd->name = cmd_name;
 836         cmd->consolefunction = consolefunction;
 837         cmd->clientfunction = clientfunction;
 838         cmd->description = description;
 839         if(!consolefunction && !clientfunction)                 //[515]: csqc
 840                 cmd->csqcfunc = true;
 841         cmd->next = cmd_functions;
 842
 843 // insert it at the right alphanumeric position
 844         for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
 845                 ;
 846         if( prev ) {
 847                 prev->next = cmd;
 848         } else {
 849                 cmd_functions = cmd;
 850         }
 851         cmd->next = current;
 852 }
 853
 854 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
 855 {
 856         Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
 857 }
 858
 859 /*
 860 ============
 861 Cmd_Exists
 862 ============
 863 */
 864 qboolean Cmd_Exists (const char *cmd_name)
 865 {
 866         cmd_function_t  *cmd;
 867
 868         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
 869                 if (!strcmp (cmd_name,cmd->name))
 870                         return true;
 871
 872         return false;
 873 }
 874
 875
 876 /*
 877 ============
 878 Cmd_CompleteCommand
 879 ============
 880 */
 881 const char *Cmd_CompleteCommand (const char *partial)
 882 {
 883         cmd_function_t *cmd;
 884         size_t len;
 885
 886         len = strlen(partial);
 887
 888         if (!len)
 889                 return NULL;
 890
 891 // check functions
 892         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 893                 if (!strncasecmp(partial, cmd->name, len))
 894                         return cmd->name;
 895
 896         return NULL;
 897 }
 898
 899 /*
 900         Cmd_CompleteCountPossible
 901
 902         New function for tab-completion system
 903         Added by EvilTypeGuy
 904         Thanks to Fett erich@heintz.com
 905         Thanks to taniwha
 906
 907 */
 908 int Cmd_CompleteCountPossible (const char *partial)
 909 {
 910         cmd_function_t *cmd;
 911         size_t len;
 912         int h;
 913
 914         h = 0;
 915         len = strlen(partial);
 916
 917         if (!len)
 918                 return 0;
 919
 920         // Loop through the command list and count all partial matches
 921         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 922                 if (!strncasecmp(partial, cmd->name, len))
 923                         h++;
 924
 925         return h;
 926 }
 927
 928 /*
 929         Cmd_CompleteBuildList
 930
 931         New function for tab-completion system
 932         Added by EvilTypeGuy
 933         Thanks to Fett erich@heintz.com
 934         Thanks to taniwha
 935
 936 */
 937 const char **Cmd_CompleteBuildList (const char *partial)
 938 {
 939         cmd_function_t *cmd;
 940         size_t len = 0;
 941         size_t bpos = 0;
 942         size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
 943         const char **buf;
 944
 945         len = strlen(partial);
 946         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
 947         // Loop through the alias list and print all matches
 948         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 949                 if (!strncasecmp(partial, cmd->name, len))
 950                         buf[bpos++] = cmd->name;
 951
 952         buf[bpos] = NULL;
 953         return buf;
 954 }
 955
 956 // written by LordHavoc
 957 void Cmd_CompleteCommandPrint (const char *partial)
 958 {
 959         cmd_function_t *cmd;
 960         size_t len = strlen(partial);
 961         // Loop through the command list and print all matches
 962         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 963                 if (!strncasecmp(partial, cmd->name, len))
 964                         Con_Printf("%s : %s\n", cmd->name, cmd->description);
 965 }
 966
 967 /*
 968         Cmd_CompleteAlias
 969
 970         New function for tab-completion system
 971         Added by EvilTypeGuy
 972         Thanks to Fett erich@heintz.com
 973         Thanks to taniwha
 974
 975 */
 976 const char *Cmd_CompleteAlias (const char *partial)
 977 {
 978         cmdalias_t *alias;
 979         size_t len;
 980
 981         len = strlen(partial);
 982
 983         if (!len)
 984                 return NULL;
 985
 986         // Check functions
 987         for (alias = cmd_alias; alias; alias = alias->next)
 988                 if (!strncasecmp(partial, alias->name, len))
 989                         return alias->name;
 990
 991         return NULL;
 992 }
 993
 994 // written by LordHavoc
 995 void Cmd_CompleteAliasPrint (const char *partial)
 996 {
 997         cmdalias_t *alias;
 998         size_t len = strlen(partial);
 999         // Loop through the alias list and print all matches
1000         for (alias = cmd_alias; alias; alias = alias->next)
1001                 if (!strncasecmp(partial, alias->name, len))
1002                         Con_Printf("%s : %s\n", alias->name, alias->value);
1003 }
1004
1005
1006 /*
1007         Cmd_CompleteAliasCountPossible
1008
1009         New function for tab-completion system
1010         Added by EvilTypeGuy
1011         Thanks to Fett erich@heintz.com
1012         Thanks to taniwha
1013
1014 */
1015 int Cmd_CompleteAliasCountPossible (const char *partial)
1016 {
1017         cmdalias_t      *alias;
1018         size_t          len;
1019         int                     h;
1020
1021         h = 0;
1022
1023         len = strlen(partial);
1024
1025         if (!len)
1026                 return 0;
1027
1028         // Loop through the command list and count all partial matches
1029         for (alias = cmd_alias; alias; alias = alias->next)
1030                 if (!strncasecmp(partial, alias->name, len))
1031                         h++;
1032
1033         return h;
1034 }
1035
1036 /*
1037         Cmd_CompleteAliasBuildList
1038
1039         New function for tab-completion system
1040         Added by EvilTypeGuy
1041         Thanks to Fett erich@heintz.com
1042         Thanks to taniwha
1043
1044 */
1045 const char **Cmd_CompleteAliasBuildList (const char *partial)
1046 {
1047         cmdalias_t *alias;
1048         size_t len = 0;
1049         size_t bpos = 0;
1050         size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1051         const char **buf;
1052
1053         len = strlen(partial);
1054         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1055         // Loop through the alias list and print all matches
1056         for (alias = cmd_alias; alias; alias = alias->next)
1057                 if (!strncasecmp(partial, alias->name, len))
1058                         buf[bpos++] = alias->name;
1059
1060         buf[bpos] = NULL;
1061         return buf;
1062 }
1063
1064 void Cmd_ClearCsqcFuncs (void)
1065 {
1066         cmd_function_t *cmd;
1067         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1068                 cmd->csqcfunc = false;
1069 }
1070
1071 qboolean CL_VM_ConsoleCommand (const char *cmd);
1072 /*
1073 ============
1074 Cmd_ExecuteString
1075
1076 A complete command line has been parsed, so try to execute it
1077 FIXME: lookupnoadd the token to speed search?
1078 ============
1079 */
1080 void Cmd_ExecuteString (const char *text, cmd_source_t src)
1081 {
1082         int oldpos;
1083         cmd_function_t *cmd;
1084         cmdalias_t *a;
1085
1086         oldpos = cmd_tokenizebufferpos;
1087         cmd_source = src;
1088
1089         Cmd_TokenizeString (text);
1090
1091 // execute the command line
1092         if (!Cmd_Argc())
1093         {
1094                 cmd_tokenizebufferpos = oldpos;
1095                 return;         // no tokens
1096         }
1097
1098 // check functions
1099         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1100         {
1101                 if (!strcasecmp (cmd_argv[0],cmd->name))
1102                 {
1103                         if (cmd->csqcfunc && CL_VM_ConsoleCommand (text))       //[515]: csqc
1104                                 return;
1105                         switch (src)
1106                         {
1107                         case src_command:
1108                                 if (cmd->consolefunction)
1109                                         cmd->consolefunction ();
1110                                 else if (cmd->clientfunction)
1111                                 {
1112                                         if (cls.state == ca_connected)
1113                                         {
1114                                                 // forward remote commands to the server for execution
1115                                                 Cmd_ForwardToServer();
1116                                         }
1117                                         else
1118                                                 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1119                                 }
1120                                 else
1121                                         Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1122                                 cmd_tokenizebufferpos = oldpos;
1123                                 return;
1124                         case src_client:
1125                                 if (cmd->clientfunction)
1126                                 {
1127                                         cmd->clientfunction ();
1128                                         cmd_tokenizebufferpos = oldpos;
1129                                         return;
1130                                 }
1131                                 break;
1132                         }
1133                         break;
1134                 }
1135         }
1136
1137         // if it's a client command and no command was found, say so.
1138         if (cmd_source == src_client)
1139         {
1140                 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1141                 return;
1142         }
1143
1144 // check alias
1145         for (a=cmd_alias ; a ; a=a->next)
1146         {
1147                 if (!strcasecmp (cmd_argv[0], a->name))
1148                 {
1149                         Cmd_ExecuteAlias(a);
1150                         cmd_tokenizebufferpos = oldpos;
1151                         return;
1152                 }
1153         }
1154
1155 // check cvars
1156         if (!Cvar_Command () && host_framecount > 0)
1157                 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1158
1159         cmd_tokenizebufferpos = oldpos;
1160 }
1161
1162
1163 /*
1164 ===================
1165 Cmd_ForwardStringToServer
1166
1167 Sends an entire command string over to the server, unprocessed
1168 ===================
1169 */
1170 void Cmd_ForwardStringToServer (const char *s)
1171 {
1172         if (cls.state != ca_connected)
1173         {
1174                 Con_Printf("Can't \"%s\", not connected\n", s);
1175                 return;
1176         }
1177
1178         if (!cls.netcon)
1179                 return;
1180
1181         // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1182         // attention, it has been eradicated from here, its only (former) use in
1183         // all of darkplaces.
1184         if (cls.protocol == PROTOCOL_QUAKEWORLD)
1185                 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1186         else
1187                 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1188         SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1189 }
1190
1191 /*
1192 ===================
1193 Cmd_ForwardToServer
1194
1195 Sends the entire command line over to the server
1196 ===================
1197 */
1198 void Cmd_ForwardToServer (void)
1199 {
1200         const char *s;
1201         if (!strcasecmp(Cmd_Argv(0), "cmd"))
1202         {
1203                 // we want to strip off "cmd", so just send the args
1204                 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1205         }
1206         else
1207         {
1208                 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1209                 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1210         }
1211         // don't send an empty forward message if the user tries "cmd" by itself
1212         if (!s || !*s)
1213                 return;
1214         Cmd_ForwardStringToServer(s);
1215 }
1216
1217
1218 /*
1219 ================
1220 Cmd_CheckParm
1221
1222 Returns the position (1 to argc-1) in the command's argument list
1223 where the given parameter apears, or 0 if not present
1224 ================
1225 */
1226
1227 int Cmd_CheckParm (const char *parm)
1228 {
1229         int i;
1230
1231         if (!parm)
1232         {
1233                 Con_Printf ("Cmd_CheckParm: NULL");
1234                 return 0;
1235         }
1236
1237         for (i = 1; i < Cmd_Argc (); i++)
1238                 if (!strcasecmp (parm, Cmd_Argv (i)))
1239                         return i;
1240
1241         return 0;
1242 }
1243