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                                 // don't expand rcon_password or similar cvars (CVAR_PRIVATE flag)
 556                                 if ((cvar = Cvar_FindVar(&com_token[0])) && !(cvar->flags & CVAR_PRIVATE)) {
 557                                         const char *cvarcontent = cvar->string;
 558                                         while( *cvarcontent && outlen < maxoutlen ) {
 559                                                 outtext[outlen++] = *cvarcontent++;
 560                                         }
 561                                         in = tempin;
 562                                 } else {
 563                                         if( alias ) {
 564                                                 Con_Printf( "Warning: could not find cvar %s when expanding alias %s\n    %s\n", com_token, alias->name, alias->value );
 565                                         } else {
 566                                                 Con_Printf( "Warning: could not find cvar %s\n", com_token );
 567                                         }
 568                                         outtext[outlen++] = '$';
 569                                 }
 570                         }
 571                 } else {
 572                         if( *in == '"' ) {
 573                                 inquote ^= 1;
 574                         }
 575                         outtext[outlen++] = *in++;
 576                 }
 577         }
 578         outtext[outlen] = 0;
 579 }
 580
 581 /*
 582 ============
 583 Cmd_ExecuteAlias
 584
 585 Called for aliases and fills in the alias into the cbuffer
 586 ============
 587 */
 588 static void Cmd_ExecuteAlias (cmdalias_t *alias)
 589 {
 590         static char buffer[ MAX_INPUTLINE + 2 ];
 591         Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
 592         // insert at start of command buffer, so that aliases execute in order
 593         // (fixes bug introduced by Black on 20050705)
 594         Cbuf_InsertText( buffer );
 595 }
 596
 597 /*
 598 ========
 599 Cmd_List
 600
 601         CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
 602         Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
 603
 604 ========
 605 */
 606 static void Cmd_List_f (void)
 607 {
 608         cmd_function_t *cmd;
 609         const char *partial;
 610         int len, count;
 611
 612         if (Cmd_Argc() > 1)
 613         {
 614                 partial = Cmd_Argv (1);
 615                 len = (int)strlen(partial);
 616         }
 617         else
 618         {
 619                 partial = NULL;
 620                 len = 0;
 621         }
 622
 623         count = 0;
 624         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 625         {
 626                 if (partial && strncmp(partial, cmd->name, len))
 627                         continue;
 628                 Con_Printf("%s : %s\n", cmd->name, cmd->description);
 629                 count++;
 630         }
 631
 632         if (partial)
 633                 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
 634         else
 635                 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
 636 }
 637
 638 /*
 639 ============
 640 Cmd_Init
 641 ============
 642 */
 643 void Cmd_Init (void)
 644 {
 645         cmd_mempool = Mem_AllocPool("commands", 0, NULL);
 646         // space for commands and script files
 647         cmd_text.data = cmd_text_buf;
 648         cmd_text.maxsize = sizeof(cmd_text_buf);
 649         cmd_text.cursize = 0;
 650 }
 651
 652 void Cmd_Init_Commands (void)
 653 {
 654 //
 655 // register our commands
 656 //
 657         Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
 658         Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
 659         Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
 660         Cmd_AddCommand ("alias",Cmd_Alias_f, "create a script function (parameters are passed in as $1 through $9, and $* for all parameters)");
 661         Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
 662         Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
 663         Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
 664         Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
 665
 666         // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
 667         // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
 668         Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix");
 669         Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix");
 670
 671         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");
 672         Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
 673         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)");
 674         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)");
 675
 676         // DRESK - 5/14/06
 677         // Support Doom3-style Toggle Command
 678         Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
 679 }
 680
 681 /*
 682 ============
 683 Cmd_Shutdown
 684 ============
 685 */
 686 void Cmd_Shutdown(void)
 687 {
 688         Mem_FreePool(&cmd_mempool);
 689 }
 690
 691 /*
 692 ============
 693 Cmd_Argc
 694 ============
 695 */
 696 int             Cmd_Argc (void)
 697 {
 698         return cmd_argc;
 699 }
 700
 701 /*
 702 ============
 703 Cmd_Argv
 704 ============
 705 */
 706 const char *Cmd_Argv (int arg)
 707 {
 708         if (arg >= cmd_argc )
 709                 return cmd_null_string;
 710         return cmd_argv[arg];
 711 }
 712
 713 /*
 714 ============
 715 Cmd_Args
 716 ============
 717 */
 718 const char *Cmd_Args (void)
 719 {
 720         return cmd_args;
 721 }
 722
 723
 724 /*
 725 ============
 726 Cmd_TokenizeString
 727
 728 Parses the given string into command line tokens.
 729 ============
 730 */
 731 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
 732 static void Cmd_TokenizeString (const char *text)
 733 {
 734         int l;
 735
 736         cmd_argc = 0;
 737         cmd_args = NULL;
 738
 739         while (1)
 740         {
 741                 // skip whitespace up to a /n
 742                 while (*text && *text <= ' ' && *text != '\r' && *text != '\n')
 743                         text++;
 744
 745                 // line endings:
 746                 // UNIX: \n
 747                 // Mac: \r
 748                 // Windows: \r\n
 749                 if (*text == '\n' || *text == '\r')
 750                 {
 751                         // a newline separates commands in the buffer
 752                         if (*text == '\r' && text[1] == '\n')
 753                                 text++;
 754                         text++;
 755                         break;
 756                 }
 757
 758                 if (!*text)
 759                         return;
 760
 761                 if (cmd_argc == 1)
 762                         cmd_args = text;
 763
 764                 if (!COM_ParseTokenConsole(&text))
 765                         return;
 766
 767                 if (cmd_argc < MAX_ARGS)
 768                 {
 769                         l = (int)strlen(com_token) + 1;
 770                         if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
 771                         {
 772                                 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
 773                                 break;
 774                         }
 775                         strcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token);
 776                         cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
 777                         cmd_tokenizebufferpos += l;
 778                         cmd_argc++;
 779                 }
 780         }
 781 }
 782
 783
 784 /*
 785 ============
 786 Cmd_AddCommand
 787 ============
 788 */
 789 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
 790 {
 791         cmd_function_t *cmd;
 792         cmd_function_t *prev, *current;
 793
 794 // fail if the command is a variable name
 795         if (Cvar_FindVar( cmd_name ))
 796         {
 797                 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
 798                 return;
 799         }
 800
 801 // fail if the command already exists
 802         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
 803         {
 804                 if (!strcmp (cmd_name, cmd->name))
 805                 {
 806                         if (function)
 807                         {
 808                                 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
 809                                 return;
 810                         }
 811                         else    //[515]: csqc
 812                         {
 813                                 cmd->csqcfunc = true;
 814                                 return;
 815                         }
 816                 }
 817         }
 818
 819         cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
 820         cmd->name = cmd_name;
 821         cmd->function = function;
 822         cmd->description = description;
 823         if(!function)                   //[515]: csqc
 824                 cmd->csqcfunc = true;
 825         cmd->next = cmd_functions;
 826
 827 // insert it at the right alphanumeric position
 828         for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
 829                 ;
 830         if( prev ) {
 831                 prev->next = cmd;
 832         } else {
 833                 cmd_functions = cmd;
 834         }
 835         cmd->next = current;
 836 }
 837
 838 /*
 839 ============
 840 Cmd_Exists
 841 ============
 842 */
 843 qboolean Cmd_Exists (const char *cmd_name)
 844 {
 845         cmd_function_t  *cmd;
 846
 847         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
 848                 if (!strcmp (cmd_name,cmd->name))
 849                         return true;
 850
 851         return false;
 852 }
 853
 854
 855 /*
 856 ============
 857 Cmd_CompleteCommand
 858 ============
 859 */
 860 const char *Cmd_CompleteCommand (const char *partial)
 861 {
 862         cmd_function_t *cmd;
 863         size_t len;
 864
 865         len = strlen(partial);
 866
 867         if (!len)
 868                 return NULL;
 869
 870 // check functions
 871         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 872                 if (!strncasecmp(partial, cmd->name, len))
 873                         return cmd->name;
 874
 875         return NULL;
 876 }
 877
 878 /*
 879         Cmd_CompleteCountPossible
 880
 881         New function for tab-completion system
 882         Added by EvilTypeGuy
 883         Thanks to Fett erich@heintz.com
 884         Thanks to taniwha
 885
 886 */
 887 int Cmd_CompleteCountPossible (const char *partial)
 888 {
 889         cmd_function_t *cmd;
 890         size_t len;
 891         int h;
 892
 893         h = 0;
 894         len = strlen(partial);
 895
 896         if (!len)
 897                 return 0;
 898
 899         // Loop through the command list and count all partial matches
 900         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 901                 if (!strncasecmp(partial, cmd->name, len))
 902                         h++;
 903
 904         return h;
 905 }
 906
 907 /*
 908         Cmd_CompleteBuildList
 909
 910         New function for tab-completion system
 911         Added by EvilTypeGuy
 912         Thanks to Fett erich@heintz.com
 913         Thanks to taniwha
 914
 915 */
 916 const char **Cmd_CompleteBuildList (const char *partial)
 917 {
 918         cmd_function_t *cmd;
 919         size_t len = 0;
 920         size_t bpos = 0;
 921         size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
 922         const char **buf;
 923
 924         len = strlen(partial);
 925         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
 926         // Loop through the alias list and print all matches
 927         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 928                 if (!strncasecmp(partial, cmd->name, len))
 929                         buf[bpos++] = cmd->name;
 930
 931         buf[bpos] = NULL;
 932         return buf;
 933 }
 934
 935 // written by LordHavoc
 936 void Cmd_CompleteCommandPrint (const char *partial)
 937 {
 938         cmd_function_t *cmd;
 939         size_t len = strlen(partial);
 940         // Loop through the command list and print all matches
 941         for (cmd = cmd_functions; cmd; cmd = cmd->next)
 942                 if (!strncasecmp(partial, cmd->name, len))
 943                         Con_Printf("%s : %s\n", cmd->name, cmd->description);
 944 }
 945
 946 /*
 947         Cmd_CompleteAlias
 948
 949         New function for tab-completion system
 950         Added by EvilTypeGuy
 951         Thanks to Fett erich@heintz.com
 952         Thanks to taniwha
 953
 954 */
 955 const char *Cmd_CompleteAlias (const char *partial)
 956 {
 957         cmdalias_t *alias;
 958         size_t len;
 959
 960         len = strlen(partial);
 961
 962         if (!len)
 963                 return NULL;
 964
 965         // Check functions
 966         for (alias = cmd_alias; alias; alias = alias->next)
 967                 if (!strncasecmp(partial, alias->name, len))
 968                         return alias->name;
 969
 970         return NULL;
 971 }
 972
 973 // written by LordHavoc
 974 void Cmd_CompleteAliasPrint (const char *partial)
 975 {
 976         cmdalias_t *alias;
 977         size_t len = strlen(partial);
 978         // Loop through the alias list and print all matches
 979         for (alias = cmd_alias; alias; alias = alias->next)
 980                 if (!strncasecmp(partial, alias->name, len))
 981                         Con_Printf("%s : %s\n", alias->name, alias->value);
 982 }
 983
 984
 985 /*
 986         Cmd_CompleteAliasCountPossible
 987
 988         New function for tab-completion system
 989         Added by EvilTypeGuy
 990         Thanks to Fett erich@heintz.com
 991         Thanks to taniwha
 992
 993 */
 994 int Cmd_CompleteAliasCountPossible (const char *partial)
 995 {
 996         cmdalias_t      *alias;
 997         size_t          len;
 998         int                     h;
 999
1000         h = 0;
1001
1002         len = strlen(partial);
1003
1004         if (!len)
1005                 return 0;
1006
1007         // Loop through the command list and count all partial matches
1008         for (alias = cmd_alias; alias; alias = alias->next)
1009                 if (!strncasecmp(partial, alias->name, len))
1010                         h++;
1011
1012         return h;
1013 }
1014
1015 /*
1016         Cmd_CompleteAliasBuildList
1017
1018         New function for tab-completion system
1019         Added by EvilTypeGuy
1020         Thanks to Fett erich@heintz.com
1021         Thanks to taniwha
1022
1023 */
1024 const char **Cmd_CompleteAliasBuildList (const char *partial)
1025 {
1026         cmdalias_t *alias;
1027         size_t len = 0;
1028         size_t bpos = 0;
1029         size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1030         const char **buf;
1031
1032         len = strlen(partial);
1033         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1034         // Loop through the alias list and print all matches
1035         for (alias = cmd_alias; alias; alias = alias->next)
1036                 if (!strncasecmp(partial, alias->name, len))
1037                         buf[bpos++] = alias->name;
1038
1039         buf[bpos] = NULL;
1040         return buf;
1041 }
1042
1043 void Cmd_ClearCsqcFuncs (void)
1044 {
1045         cmd_function_t *cmd;
1046         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1047                 cmd->csqcfunc = false;
1048 }
1049
1050 qboolean CL_VM_ConsoleCommand (const char *cmd);
1051 /*
1052 ============
1053 Cmd_ExecuteString
1054
1055 A complete command line has been parsed, so try to execute it
1056 FIXME: lookupnoadd the token to speed search?
1057 ============
1058 */
1059 void Cmd_ExecuteString (const char *text, cmd_source_t src)
1060 {
1061         int oldpos;
1062         cmd_function_t *cmd;
1063         cmdalias_t *a;
1064
1065         oldpos = cmd_tokenizebufferpos;
1066         cmd_source = src;
1067
1068         Cmd_TokenizeString (text);
1069
1070 // execute the command line
1071         if (!Cmd_Argc())
1072         {
1073                 cmd_tokenizebufferpos = oldpos;
1074                 return;         // no tokens
1075         }
1076
1077 // check functions
1078         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1079         {
1080                 if (!strcasecmp (cmd_argv[0],cmd->name))
1081                 {
1082                         if(cmd->function && !cmd->csqcfunc)
1083                                 cmd->function ();
1084                         else
1085                                 if(CL_VM_ConsoleCommand (text)) //[515]: csqc
1086                                         return;
1087                                 else
1088                                         if(cmd->function)
1089                                                 cmd->function ();
1090                         cmd_tokenizebufferpos = oldpos;
1091                         return;
1092                 }
1093         }
1094
1095 // check alias
1096         for (a=cmd_alias ; a ; a=a->next)
1097         {
1098                 if (!strcasecmp (cmd_argv[0], a->name))
1099                 {
1100                         Cmd_ExecuteAlias(a);
1101                         cmd_tokenizebufferpos = oldpos;
1102                         return;
1103                 }
1104         }
1105
1106 // check cvars
1107         if (!Cvar_Command () && host_framecount > 0)
1108                 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1109
1110         cmd_tokenizebufferpos = oldpos;
1111 }
1112
1113
1114 /*
1115 ===================
1116 Cmd_ForwardStringToServer
1117
1118 Sends an entire command string over to the server, unprocessed
1119 ===================
1120 */
1121 void Cmd_ForwardStringToServer (const char *s)
1122 {
1123         if (cls.state != ca_connected)
1124         {
1125                 Con_Printf("Can't \"%s\", not connected\n", s);
1126                 return;
1127         }
1128
1129         if (!cls.netcon)
1130                 return;
1131
1132         // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1133         // attention, it has been eradicated from here, its only (former) use in
1134         // all of darkplaces.
1135         if (cls.protocol == PROTOCOL_QUAKEWORLD)
1136                 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1137         else
1138                 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1139         SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1140 }
1141
1142 /*
1143 ===================
1144 Cmd_ForwardToServer
1145
1146 Sends the entire command line over to the server
1147 ===================
1148 */
1149 void Cmd_ForwardToServer (void)
1150 {
1151         const char *s;
1152         if (!strcasecmp(Cmd_Argv(0), "cmd"))
1153         {
1154                 // we want to strip off "cmd", so just send the args
1155                 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1156         }
1157         else
1158         {
1159                 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1160                 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1161         }
1162         // don't send an empty forward message if the user tries "cmd" by itself
1163         if (!s || !*s)
1164                 return;
1165         Cmd_ForwardStringToServer(s);
1166 }
1167
1168
1169 /*
1170 ================
1171 Cmd_CheckParm
1172
1173 Returns the position (1 to argc-1) in the command's argument list
1174 where the given parameter apears, or 0 if not present
1175 ================
1176 */
1177
1178 int Cmd_CheckParm (const char *parm)
1179 {
1180         int i;
1181
1182         if (!parm)
1183         {
1184                 Con_Printf ("Cmd_CheckParm: NULL");
1185                 return 0;
1186         }
1187
1188         for (i = 1; i < Cmd_Argc (); i++)
1189                 if (!strcasecmp (parm, Cmd_Argv (i)))
1190                         return i;
1191
1192         return 0;
1193 }
1194