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