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