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 typedef struct cmdalias_s
  25 {
  26         struct cmdalias_s *next;
  27         char name[MAX_ALIAS_NAME];
  28         char *value;
  29         qboolean initstate; // indicates this command existed at init
  30         char *initialvalue; // backup copy of value at init
  31 } cmdalias_t;
  32
  33 static cmdalias_t *cmd_alias;
  34
  35 static qboolean cmd_wait;
  36
  37 static mempool_t *cmd_mempool;
  38
  39 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
  40 static int cmd_tokenizebufferpos = 0;
  41
  42 //=============================================================================
  43
  44 /*
  45 ============
  46 Cmd_Wait_f
  47
  48 Causes execution of the remainder of the command buffer to be delayed until
  49 next frame.  This allows commands like:
  50 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
  51 ============
  52 */
  53 static void Cmd_Wait_f (void)
  54 {
  55         cmd_wait = true;
  56 }
  57
  58 typedef struct cmddeferred_s
  59 {
  60         struct cmddeferred_s *next;
  61         char *value;
  62         double time;
  63 } cmddeferred_t;
  64
  65 static cmddeferred_t *cmd_deferred_list = NULL;
  66
  67 /*
  68 ============
  69 Cmd_Defer_f
  70
  71 Cause a command to be executed after a delay.
  72 ============
  73 */
  74 static void Cmd_Defer_f (void)
  75 {
  76         if(Cmd_Argc() == 1)
  77         {
  78                 double time = Sys_DoubleTime();
  79                 cmddeferred_t *next = cmd_deferred_list;
  80                 if(!next)
  81                         Con_Printf("No commands are pending.\n");
  82                 while(next)
  83                 {
  84                         Con_Printf("-> In %9.2f: %s\n", next->time-time, next->value);
  85                         next = next->next;
  86                 }
  87         } else if(Cmd_Argc() == 2 && !strcasecmp("clear", Cmd_Argv(1)))
  88         {
  89                 while(cmd_deferred_list)
  90                 {
  91                         cmddeferred_t *cmd = cmd_deferred_list;
  92                         cmd_deferred_list = cmd->next;
  93                         Mem_Free(cmd->value);
  94                         Mem_Free(cmd);
  95                 }
  96         } else if(Cmd_Argc() == 3)
  97         {
  98                 const char *value = Cmd_Argv(2);
  99                 cmddeferred_t *defcmd = (cmddeferred_t*)Mem_Alloc(tempmempool, sizeof(*defcmd));
 100                 size_t len = strlen(value);
 101
 102                 defcmd->time = Sys_DoubleTime() + atof(Cmd_Argv(1));
 103                 defcmd->value = (char*)Mem_Alloc(tempmempool, len+1);
 104                 memcpy(defcmd->value, value, len+1);
 105                 defcmd->next = NULL;
 106
 107                 if(cmd_deferred_list)
 108                 {
 109                         cmddeferred_t *next = cmd_deferred_list;
 110                         while(next->next)
 111                                 next = next->next;
 112                         next->next = defcmd;
 113                 } else
 114                         cmd_deferred_list = defcmd;
 115                 /* Stupid me... this changes the order... so commands with the same delay go blub :S
 116                   defcmd->next = cmd_deferred_list;
 117                   cmd_deferred_list = defcmd;*/
 118         } else {
 119                 Con_Printf("usage: defer <seconds> <command>\n"
 120                            "       defer clear\n");
 121                 return;
 122         }
 123 }
 124
 125 /*
 126 ============
 127 Cmd_Centerprint_f
 128
 129 Print something to the center of the screen using SCR_Centerprint
 130 ============
 131 */
 132 static void Cmd_Centerprint_f (void)
 133 {
 134         char msg[MAX_INPUTLINE];
 135         unsigned int i, c, p;
 136         c = Cmd_Argc();
 137         if(c >= 2)
 138         {
 139                 strlcpy(msg, Cmd_Argv(1), sizeof(msg));
 140                 for(i = 2; i < c; ++i)
 141                 {
 142                         strlcat(msg, " ", sizeof(msg));
 143                         strlcat(msg, Cmd_Argv(i), sizeof(msg));
 144                 }
 145                 c = strlen(msg);
 146                 for(p = 0, i = 0; i < c; ++i)
 147                 {
 148                         if(msg[i] == '\\')
 149                         {
 150                                 if(msg[i+1] == 'n')
 151                                         msg[p++] = '\n';
 152                                 else if(msg[i+1] == '\\')
 153                                         msg[p++] = '\\';
 154                                 else {
 155                                         msg[p++] = '\\';
 156                                         msg[p++] = msg[i+1];
 157                                 }
 158                                 ++i;
 159                         } else {
 160                                 msg[p++] = msg[i];
 161                         }
 162                 }
 163                 msg[p] = '\0';
 164                 SCR_CenterPrint(msg);
 165         }
 166 }
 167
 168 /*
 169 =============================================================================
 170
 171                                                 COMMAND BUFFER
 172
 173 =============================================================================
 174 */
 175
 176 static sizebuf_t        cmd_text;
 177 static unsigned char            cmd_text_buf[CMDBUFSIZE];
 178
 179 /*
 180 ============
 181 Cbuf_AddText
 182
 183 Adds command text at the end of the buffer
 184 ============
 185 */
 186 void Cbuf_AddText (const char *text)
 187 {
 188         int             l;
 189
 190         l = (int)strlen (text);
 191
 192         if (cmd_text.cursize + l >= cmd_text.maxsize)
 193         {
 194                 Con_Print("Cbuf_AddText: overflow\n");
 195                 return;
 196         }
 197
 198         SZ_Write (&cmd_text, (const unsigned char *)text, (int)strlen (text));
 199 }
 200
 201
 202 /*
 203 ============
 204 Cbuf_InsertText
 205
 206 Adds command text immediately after the current command
 207 Adds a \n to the text
 208 FIXME: actually change the command buffer to do less copying
 209 ============
 210 */
 211 void Cbuf_InsertText (const char *text)
 212 {
 213         char    *temp;
 214         int             templen;
 215
 216         // copy off any commands still remaining in the exec buffer
 217         templen = cmd_text.cursize;
 218         if (templen)
 219         {
 220                 temp = (char *)Mem_Alloc (tempmempool, templen);
 221                 memcpy (temp, cmd_text.data, templen);
 222                 SZ_Clear (&cmd_text);
 223         }
 224         else
 225                 temp = NULL;
 226
 227         // add the entire text of the file
 228         Cbuf_AddText (text);
 229
 230         // add the copied off data
 231         if (temp != NULL)
 232         {
 233                 SZ_Write (&cmd_text, (const unsigned char *)temp, templen);
 234                 Mem_Free (temp);
 235         }
 236 }
 237
 238 /*
 239 ============
 240 Cbuf_Execute_Deferred --blub
 241 ============
 242 */
 243 void Cbuf_Execute_Deferred (void)
 244 {
 245         cmddeferred_t *cmd, *prev;
 246         double time = Sys_DoubleTime();
 247         prev = NULL;
 248         cmd = cmd_deferred_list;
 249         while(cmd)
 250         {
 251                 if(cmd->time <= time)
 252                 {
 253                         Cbuf_AddText(cmd->value);
 254                         Cbuf_AddText(";\n");
 255                         Mem_Free(cmd->value);
 256
 257                         if(prev) {
 258                                 prev->next = cmd->next;
 259                                 Mem_Free(cmd);
 260                                 cmd = prev->next;
 261                         } else {
 262                                 cmd_deferred_list = cmd->next;
 263                                 Mem_Free(cmd);
 264                                 cmd = cmd_deferred_list;
 265                         }
 266                         continue;
 267                 }
 268                 prev = cmd;
 269                 cmd = cmd->next;
 270         }
 271 }
 272
 273 /*
 274 ============
 275 Cbuf_Execute
 276 ============
 277 */
 278 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
 279 void Cbuf_Execute (void)
 280 {
 281         int i;
 282         char *text;
 283         char line[MAX_INPUTLINE];
 284         char preprocessed[MAX_INPUTLINE];
 285         char *firstchar;
 286         qboolean quotes;
 287         char *comment;
 288
 289         // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
 290         cmd_tokenizebufferpos = 0;
 291
 292         Cbuf_Execute_Deferred();
 293         while (cmd_text.cursize)
 294         {
 295 // find a \n or ; line break
 296                 text = (char *)cmd_text.data;
 297
 298                 quotes = false;
 299                 comment = NULL;
 300                 for (i=0 ; i < cmd_text.cursize ; i++)
 301                 {
 302                         if(!comment)
 303                         {
 304                                 if (text[i] == '"')
 305                                         quotes = !quotes;
 306
 307                                 if(quotes)
 308                                 {
 309                                         // make sure i doesn't get > cursize which causes a negative
 310                                         // size in memmove, which is fatal --blub
 311                                         if (i < (cmd_text.cursize-1) && (text[i] == '\\' && (text[i+1] == '"' || text[i+1] == '\\')))
 312                                                 i++;
 313                                 }
 314                                 else
 315                                 {
 316                                         if(text[i] == '/' && text[i + 1] == '/' && (i == 0 || ISWHITESPACE(text[i-1])))
 317                                                 comment = &text[i];
 318                                         if(text[i] == ';')
 319                                                 break;  // don't break if inside a quoted string or comment
 320                                 }
 321                         }
 322
 323                         if (text[i] == '\r' || text[i] == '\n')
 324                                 break;
 325                 }
 326
 327                 // better than CRASHING on overlong input lines that may SOMEHOW enter the buffer
 328                 if(i >= MAX_INPUTLINE)
 329                 {
 330                         Con_Printf("Warning: console input buffer had an overlong line. Ignored.\n");
 331                         line[0] = 0;
 332                 }
 333                 else
 334                 {
 335                         memcpy (line, text, comment ? (comment - text) : i);
 336                         line[comment ? (comment - text) : i] = 0;
 337                 }
 338
 339 // delete the text from the command buffer and move remaining commands down
 340 // this is necessary because commands (exec, alias) can insert data at the
 341 // beginning of the text buffer
 342
 343                 if (i == cmd_text.cursize)
 344                         cmd_text.cursize = 0;
 345                 else
 346                 {
 347                         i++;
 348                         cmd_text.cursize -= i;
 349                         memmove (cmd_text.data, text+i, cmd_text.cursize);
 350                 }
 351
 352 // execute the command line
 353                 firstchar = line;
 354                 while(*firstchar && ISWHITESPACE(*firstchar))
 355                         ++firstchar;
 356                 if(
 357                         (strncmp(firstchar, "alias", 5) || !ISWHITESPACE(firstchar[5]))
 358                         &&
 359                         (strncmp(firstchar, "bind", 4) || !ISWHITESPACE(firstchar[4]))
 360                         &&
 361                         (strncmp(firstchar, "in_bind", 7) || !ISWHITESPACE(firstchar[7]))
 362                 )
 363                 {
 364                         Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
 365                         Cmd_ExecuteString (preprocessed, src_command);
 366                 }
 367                 else
 368                 {
 369                         Cmd_ExecuteString (line, src_command);
 370                 }
 371
 372                 if (cmd_wait)
 373                 {       // skip out while text still remains in buffer, leaving it
 374                         // for next frame
 375                         cmd_wait = false;
 376                         break;
 377                 }
 378         }
 379 }
 380
 381 /*
 382 ==============================================================================
 383
 384                                                 SCRIPT COMMANDS
 385
 386 ==============================================================================
 387 */
 388
 389 /*
 390 ===============
 391 Cmd_StuffCmds_f
 392
 393 Adds command line parameters as script statements
 394 Commands lead with a +, and continue until a - or another +
 395 quake +prog jctest.qp +cmd amlev1
 396 quake -nosound +cmd amlev1
 397 ===============
 398 */
 399 qboolean host_stuffcmdsrun = false;
 400 void Cmd_StuffCmds_f (void)
 401 {
 402         int             i, j, l;
 403         // this is for all commandline options combined (and is bounds checked)
 404         char    build[MAX_INPUTLINE];
 405
 406         if (Cmd_Argc () != 1)
 407         {
 408                 Con_Print("stuffcmds : execute command line parameters\n");
 409                 return;
 410         }
 411
 412         // no reason to run the commandline arguments twice
 413         if (host_stuffcmdsrun)
 414                 return;
 415
 416         host_stuffcmdsrun = true;
 417         build[0] = 0;
 418         l = 0;
 419         for (i = 0;i < com_argc;i++)
 420         {
 421                 if (com_argv[i] && com_argv[i][0] == '+' && (com_argv[i][1] < '0' || com_argv[i][1] > '9') && l + strlen(com_argv[i]) - 1 <= sizeof(build) - 1)
 422                 {
 423                         j = 1;
 424                         while (com_argv[i][j])
 425                                 build[l++] = com_argv[i][j++];
 426                         i++;
 427                         for (;i < com_argc;i++)
 428                         {
 429                                 if (!com_argv[i])
 430                                         continue;
 431                                 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
 432                                         break;
 433                                 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
 434                                         break;
 435                                 build[l++] = ' ';
 436                                 if (strchr(com_argv[i], ' '))
 437                                         build[l++] = '\"';
 438                                 for (j = 0;com_argv[i][j];j++)
 439                                         build[l++] = com_argv[i][j];
 440                                 if (strchr(com_argv[i], ' '))
 441                                         build[l++] = '\"';
 442                         }
 443                         build[l++] = '\n';
 444                         i--;
 445                 }
 446         }
 447         // now terminate the combined string and prepend it to the command buffer
 448         // we already reserved space for the terminator
 449         build[l++] = 0;
 450         Cbuf_InsertText (build);
 451 }
 452
 453 static void Cmd_Exec(const char *filename)
 454 {
 455         char *f;
 456         qboolean isdefaultcfg = strlen(filename) >= 11 && !strcmp(filename + strlen(filename) - 11, "default.cfg");
 457
 458         if (!strcmp(filename, "config.cfg"))
 459         {
 460                 filename = CONFIGFILENAME;
 461                 if (COM_CheckParm("-noconfig"))
 462                         return; // don't execute config.cfg
 463         }
 464
 465         f = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
 466         if (!f)
 467         {
 468                 Con_Printf("couldn't exec %s\n",filename);
 469                 return;
 470         }
 471         Con_Printf("execing %s\n",filename);
 472
 473         // if executing default.cfg for the first time, lock the cvar defaults
 474         // it may seem backwards to insert this text BEFORE the default.cfg
 475         // but Cbuf_InsertText inserts before, so this actually ends up after it.
 476         if (isdefaultcfg)
 477                 Cbuf_InsertText("\ncvar_lockdefaults\n");
 478
 479         // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
 480         // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
 481         Cbuf_InsertText ("\n");
 482         Cbuf_InsertText (f);
 483         Mem_Free(f);
 484
 485         if (isdefaultcfg)
 486         {
 487                 // special defaults for specific games go here, these execute before default.cfg
 488                 // Nehahra pushable crates malfunction in some levels if this is on
 489                 // Nehahra NPC AI is confused by blowupfallenzombies
 490                 if (gamemode == GAME_NEHAHRA)
 491                         Cbuf_InsertText("\nsv_gameplayfix_upwardvelocityclearsongroundflag 0\nsv_gameplayfix_blowupfallenzombies 0\n\n");
 492                 // hipnotic mission pack has issues in their 'friendly monster' ai, which seem to attempt to attack themselves for some reason when findradius() returns non-solid entities.
 493                 // hipnotic mission pack has issues with bobbing water entities 'jittering' between different heights on alternate frames at the default 0.0138889 ticrate, 0.02 avoids this issue
 494                 // hipnotic mission pack has issues in their proximity mine sticking code, which causes them to bounce off.
 495                 if (gamemode == GAME_HIPNOTIC)
 496                         Cbuf_InsertText("\nsv_gameplayfix_blowupfallenzombies 0\nsys_ticrate 0.02\nsv_gameplayfix_slidemoveprojectiles 0\n\n");
 497                 // rogue mission pack has a guardian boss that does not wake up if findradius returns one of the entities around its spawn area
 498                 if (gamemode == GAME_ROGUE)
 499                         Cbuf_InsertText("\nsv_gameplayfix_findradiusdistancetobox 0\n\n");
 500                 if (gamemode == GAME_NEXUIZ)
 501                         Cbuf_InsertText("\nsv_gameplayfix_q2airaccelerate 1\nsv_gameplayfix_stepmultipletimes 1\n\n");
 502                 if (gamemode == GAME_TENEBRAE)
 503                         Cbuf_InsertText("\nr_shadow_gloss 2\nr_shadow_bumpscale_basetexture 4\n\n");
 504                 // Steel Storm: Burning Retribution csqc misinterprets CSQC_InputEvent if type is a value other than 0 or 1
 505                 if (gamemode == GAME_STEELSTORM)
 506                         Cbuf_InsertText("\ncl_csqc_generatemousemoveevents 0\n\n");
 507         }
 508 }
 509
 510 /*
 511 ===============
 512 Cmd_Exec_f
 513 ===============
 514 */
 515 static void Cmd_Exec_f (void)
 516 {
 517         fssearch_t *s;
 518         int i;
 519
 520         if (Cmd_Argc () != 2)
 521         {
 522                 Con_Print("exec <filename> : execute a script file\n");
 523                 return;
 524         }
 525
 526         s = FS_Search(Cmd_Argv(1), true, true);
 527         if(!s || !s->numfilenames)
 528         {
 529                 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
 530                 return;
 531         }
 532
 533         for(i = 0; i < s->numfilenames; ++i)
 534                 Cmd_Exec(s->filenames[i]);
 535
 536         FS_FreeSearch(s);
 537 }
 538
 539
 540 /*
 541 ===============
 542 Cmd_Echo_f
 543
 544 Just prints the rest of the line to the console
 545 ===============
 546 */
 547 static void Cmd_Echo_f (void)
 548 {
 549         int             i;
 550
 551         for (i=1 ; i<Cmd_Argc() ; i++)
 552                 Con_Printf("%s ",Cmd_Argv(i));
 553         Con_Print("\n");
 554 }
 555
 556 // DRESK - 5/14/06
 557 // Support Doom3-style Toggle Console Command
 558 /*
 559 ===============
 560 Cmd_Toggle_f
 561
 562 Toggles a specified console variable amongst the values specified (default is 0 and 1)
 563 ===============
 564 */
 565 static void Cmd_Toggle_f(void)
 566 {
 567         // Acquire Number of Arguments
 568         int nNumArgs = Cmd_Argc();
 569
 570         if(nNumArgs == 1)
 571                 // No Arguments Specified; Print Usage
 572                 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");
 573         else
 574         { // Correct Arguments Specified
 575                 // Acquire Potential CVar
 576                 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
 577
 578                 if(cvCVar != NULL)
 579                 { // Valid CVar
 580                         if(nNumArgs == 2)
 581                         { // Default Usage
 582                                 if(cvCVar->integer)
 583                                         Cvar_SetValueQuick(cvCVar, 0);
 584                                 else
 585                                         Cvar_SetValueQuick(cvCVar, 1);
 586                         }
 587                         else
 588                         if(nNumArgs == 3)
 589                         { // 0 and Specified Usage
 590                                 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
 591                                         // CVar is Specified Value; // Reset to 0
 592                                         Cvar_SetValueQuick(cvCVar, 0);
 593                                 else
 594                                 if(cvCVar->integer == 0)
 595                                         // CVar is 0; Specify Value
 596                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
 597                                 else
 598                                         // CVar does not match; Reset to 0
 599                                         Cvar_SetValueQuick(cvCVar, 0);
 600                         }
 601                         else
 602                         { // Variable Values Specified
 603                                 int nCnt;
 604                                 int bFound = 0;
 605
 606                                 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
 607                                 { // Cycle through Values
 608                                         if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
 609                                         { // Current Value Located; Increment to Next
 610                                                 if( (nCnt + 1) == nNumArgs)
 611                                                         // Max Value Reached; Reset
 612                                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
 613                                                 else
 614                                                         // Next Value
 615                                                         Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
 616
 617                                                 // End Loop
 618                                                 nCnt = nNumArgs;
 619                                                 // Assign Found
 620                                                 bFound = 1;
 621                                         }
 622                                 }
 623                                 if(!bFound)
 624                                         // Value not Found; Reset to Original
 625                                         Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
 626                         }
 627
 628                 }
 629                 else
 630                 { // Invalid CVar
 631                         Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(1) );
 632                 }
 633         }
 634 }
 635
 636 /*
 637 ===============
 638 Cmd_Alias_f
 639
 640 Creates a new command that executes a command string (possibly ; seperated)
 641 ===============
 642 */
 643 static void Cmd_Alias_f (void)
 644 {
 645         cmdalias_t      *a;
 646         char            cmd[MAX_INPUTLINE];
 647         int                     i, c;
 648         const char              *s;
 649         size_t          alloclen;
 650
 651         if (Cmd_Argc() == 1)
 652         {
 653                 Con_Print("Current alias commands:\n");
 654                 for (a = cmd_alias ; a ; a=a->next)
 655                         Con_Printf("%s : %s", a->name, a->value);
 656                 return;
 657         }
 658
 659         s = Cmd_Argv(1);
 660         if (strlen(s) >= MAX_ALIAS_NAME)
 661         {
 662                 Con_Print("Alias name is too long\n");
 663                 return;
 664         }
 665
 666         // if the alias already exists, reuse it
 667         for (a = cmd_alias ; a ; a=a->next)
 668         {
 669                 if (!strcmp(s, a->name))
 670                 {
 671                         Z_Free (a->value);
 672                         break;
 673                 }
 674         }
 675
 676         if (!a)
 677         {
 678                 cmdalias_t *prev, *current;
 679
 680                 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
 681                 strlcpy (a->name, s, sizeof (a->name));
 682                 // insert it at the right alphanumeric position
 683                 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
 684                         ;
 685                 if( prev ) {
 686                         prev->next = a;
 687                 } else {
 688                         cmd_alias = a;
 689                 }
 690                 a->next = current;
 691         }
 692
 693
 694 // copy the rest of the command line
 695         cmd[0] = 0;             // start out with a null string
 696         c = Cmd_Argc();
 697         for (i=2 ; i < c ; i++)
 698         {
 699                 if (i != 2)
 700                         strlcat (cmd, " ", sizeof (cmd));
 701                 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
 702         }
 703         strlcat (cmd, "\n", sizeof (cmd));
 704
 705         alloclen = strlen (cmd) + 1;
 706         if(alloclen >= 2)
 707                 cmd[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
 708         a->value = (char *)Z_Malloc (alloclen);
 709         memcpy (a->value, cmd, alloclen);
 710 }
 711
 712 /*
 713 ===============
 714 Cmd_UnAlias_f
 715
 716 Remove existing aliases.
 717 ===============
 718 */
 719 static void Cmd_UnAlias_f (void)
 720 {
 721         cmdalias_t      *a, *p;
 722         int i;
 723         const char *s;
 724
 725         if(Cmd_Argc() == 1)
 726         {
 727                 Con_Print("unalias: Usage: unalias alias1 [alias2 ...]\n");
 728                 return;
 729         }
 730
 731         for(i = 1; i < Cmd_Argc(); ++i)
 732         {
 733                 s = Cmd_Argv(i);
 734                 p = NULL;
 735                 for(a = cmd_alias; a; p = a, a = a->next)
 736                 {
 737                         if(!strcmp(s, a->name))
 738                         {
 739                                 if (a->initstate) // we can not remove init aliases
 740                                         continue;
 741                                 if(a == cmd_alias)
 742                                         cmd_alias = a->next;
 743                                 if(p)
 744                                         p->next = a->next;
 745                                 Z_Free(a->value);
 746                                 Z_Free(a);
 747                                 break;
 748                         }
 749                 }
 750                 if(!a)
 751                         Con_Printf("unalias: %s alias not found\n", s);
 752         }
 753 }
 754
 755 /*
 756 =============================================================================
 757
 758                                         COMMAND EXECUTION
 759
 760 =============================================================================
 761 */
 762
 763 typedef struct cmd_function_s
 764 {
 765         struct cmd_function_s *next;
 766         const char *name;
 767         const char *description;
 768         xcommand_t consolefunction;
 769         xcommand_t clientfunction;
 770         qboolean csqcfunc;
 771         qboolean initstate; // indicates this command existed at init
 772 } cmd_function_t;
 773
 774 static int cmd_argc;
 775 static const char *cmd_argv[MAX_ARGS];
 776 static const char *cmd_null_string = "";
 777 static const char *cmd_args;
 778 cmd_source_t cmd_source;
 779
 780
 781 static cmd_function_t *cmd_functions;           // possible commands to execute
 782
 783 static const char *Cmd_GetDirectCvarValue(const char *varname, cmdalias_t *alias, qboolean *is_multiple)
 784 {
 785         cvar_t *cvar;
 786         long argno;
 787         char *endptr;
 788
 789         if(is_multiple)
 790                 *is_multiple = false;
 791
 792         if(!varname || !*varname)
 793                 return NULL;
 794
 795         if(alias)
 796         {
 797                 if(!strcmp(varname, "*"))
 798                 {
 799                         if(is_multiple)
 800                                 *is_multiple = true;
 801                         return Cmd_Args();
 802                 }
 803                 else if(!strcmp(varname, "#"))
 804                 {
 805                         return va("%d", Cmd_Argc());
 806                 }
 807                 else if(varname[strlen(varname) - 1] == '-')
 808                 {
 809                         argno = strtol(varname, &endptr, 10);
 810                         if(endptr == varname + strlen(varname) - 1)
 811                         {
 812                                 // whole string is a number, apart from the -
 813                                 const char *p = Cmd_Args();
 814                                 for(; argno > 1; --argno)
 815                                         if(!COM_ParseToken_Console(&p))
 816                                                 break;
 817                                 if(p)
 818                                 {
 819                                         if(is_multiple)
 820                                                 *is_multiple = true;
 821
 822                                         // kill pre-argument whitespace
 823                                         for (;*p && ISWHITESPACE(*p);p++)
 824                                                 ;
 825
 826                                         return p;
 827                                 }
 828                         }
 829                 }
 830                 else
 831                 {
 832                         argno = strtol(varname, &endptr, 10);
 833                         if(*endptr == 0)
 834                         {
 835                                 // whole string is a number
 836                                 // NOTE: we already made sure we don't have an empty cvar name!
 837                                 if(argno >= 0 && argno < Cmd_Argc())
 838                                         return Cmd_Argv(argno);
 839                         }
 840                 }
 841         }
 842
 843         if((cvar = Cvar_FindVar(varname)) && !(cvar->flags & CVAR_PRIVATE))
 844                 return cvar->string;
 845
 846         return NULL;
 847 }
 848
 849 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes)
 850 {
 851         qboolean quote_quot = !!strchr(quoteset, '"');
 852         qboolean quote_backslash = !!strchr(quoteset, '\\');
 853         qboolean quote_dollar = !!strchr(quoteset, '$');
 854
 855         if(putquotes)
 856         {
 857                 if(outlen <= 2)
 858                 {
 859                         *out++ = 0;
 860                         return false;
 861                 }
 862                 *out++ = '"'; --outlen;
 863                 --outlen;
 864         }
 865
 866         while(*in)
 867         {
 868                 if(*in == '"' && quote_quot)
 869                 {
 870                         if(outlen <= 2)
 871                                 goto fail;
 872                         *out++ = '\\'; --outlen;
 873                         *out++ = '"'; --outlen;
 874                 }
 875                 else if(*in == '\\' && quote_backslash)
 876                 {
 877                         if(outlen <= 2)
 878                                 goto fail;
 879                         *out++ = '\\'; --outlen;
 880                         *out++ = '\\'; --outlen;
 881                 }
 882                 else if(*in == '$' && quote_dollar)
 883                 {
 884                         if(outlen <= 2)
 885                                 goto fail;
 886                         *out++ = '$'; --outlen;
 887                         *out++ = '$'; --outlen;
 888                 }
 889                 else
 890                 {
 891                         if(outlen <= 1)
 892                                 goto fail;
 893                         *out++ = *in; --outlen;
 894                 }
 895                 ++in;
 896         }
 897         if(putquotes)
 898                 *out++ = '"';
 899         *out++ = 0;
 900         return true;
 901 fail:
 902         if(putquotes)
 903                 *out++ = '"';
 904         *out++ = 0;
 905         return false;
 906 }
 907
 908 static const char *Cmd_GetCvarValue(const char *var, size_t varlen, cmdalias_t *alias)
 909 {
 910         static char varname[MAX_INPUTLINE];
 911         static char varval[MAX_INPUTLINE];
 912         const char *varstr;
 913         char *varfunc;
 914 static char asis[] = "asis"; // just to suppress const char warnings
 915
 916         if(varlen >= MAX_INPUTLINE)
 917                 varlen = MAX_INPUTLINE - 1;
 918         memcpy(varname, var, varlen);
 919         varname[varlen] = 0;
 920         varfunc = strchr(varname, ' ');
 921
 922         if(varfunc)
 923         {
 924                 *varfunc = 0;
 925                 ++varfunc;
 926         }
 927
 928         if(*var == 0)
 929         {
 930                 // empty cvar name?
 931                 return NULL;
 932         }
 933
 934         varstr = NULL;
 935
 936         if(varname[0] == '$')
 937                 varstr = Cmd_GetDirectCvarValue(Cmd_GetDirectCvarValue(varname + 1, alias, NULL), alias, NULL);
 938         else
 939         {
 940                 qboolean is_multiple = false;
 941                 // Exception: $* and $n- don't use the quoted form by default
 942                 varstr = Cmd_GetDirectCvarValue(varname, alias, &is_multiple);
 943                 if(is_multiple)
 944                         if(!varfunc)
 945                                 varfunc = asis;
 946         }
 947
 948         if(!varstr)
 949         {
 950                 if(alias)
 951                         Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
 952                 else
 953                         Con_Printf("Warning: Could not expand $%s\n", varname);
 954                 return NULL;
 955         }
 956
 957         if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
 958         {
 959                 // quote it so it can be used inside double quotes
 960                 // we just need to replace " by \", and of course, double backslashes
 961                 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\", false);
 962                 return varval;
 963         }
 964         else if(!strcmp(varfunc, "asis"))
 965         {
 966                 return varstr;
 967         }
 968         else
 969                 Con_Printf("Unknown variable function %s\n", varfunc);
 970
 971         return varstr;
 972 }
 973
 974 /*
 975 Cmd_PreprocessString
 976
 977 Preprocesses strings and replaces $*, $param#, $cvar accordingly. Also strips comments.
 978 */
 979 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
 980         const char *in;
 981         size_t eat, varlen;
 982         unsigned outlen;
 983         const char *val;
 984
 985         // don't crash if there's no room in the outtext buffer
 986         if( maxoutlen == 0 ) {
 987                 return;
 988         }
 989         maxoutlen--; // because of \0
 990
 991         in = intext;
 992         outlen = 0;
 993
 994         while( *in && outlen < maxoutlen ) {
 995                 if( *in == '$' ) {
 996                         // this is some kind of expansion, see what comes after the $
 997                         in++;
 998
 999                         // The console does the following preprocessing:
1000                         //
1001                         // - $$ is transformed to a single dollar sign.
1002                         // - $var or ${var} are expanded to the contents of the named cvar,
1003                         //   with quotation marks and backslashes quoted so it can safely
1004                         //   be used inside quotation marks (and it should always be used
1005                         //   that way)
1006                         // - ${var asis} inserts the cvar value as is, without doing this
1007                         //   quoting
1008                         // - prefix the cvar name with a dollar sign to do indirection;
1009                         //   for example, if $x has the value timelimit, ${$x} will return
1010                         //   the value of $timelimit
1011                         // - when expanding an alias, the special variable name $* refers
1012                         //   to all alias parameters, and a number refers to that numbered
1013                         //   alias parameter, where the name of the alias is $0, the first
1014                         //   parameter is $1 and so on; as a special case, $* inserts all
1015                         //   parameters, without extra quoting, so one can use $* to just
1016                         //   pass all parameters around. All parameters starting from $n
1017                         //   can be referred to as $n- (so $* is equivalent to $1-).
1018                         //
1019                         // Note: when expanding an alias, cvar expansion is done in the SAME step
1020                         // as alias expansion so that alias parameters or cvar values containing
1021                         // dollar signs have no unwanted bad side effects. However, this needs to
1022                         // be accounted for when writing complex aliases. For example,
1023                         //   alias foo "set x NEW; echo $x"
1024                         // actually expands to
1025                         //   "set x NEW; echo OLD"
1026                         // and will print OLD! To work around this, use a second alias:
1027                         //   alias foo "set x NEW; foo2"
1028                         //   alias foo2 "echo $x"
1029                         //
1030                         // Also note: lines starting with alias are exempt from cvar expansion.
1031                         // If you want cvar expansion, write "alias" instead:
1032                         //
1033                         //   set x 1
1034                         //   alias foo "echo $x"
1035                         //   "alias" bar "echo $x"
1036                         //   set x 2
1037                         //
1038                         // foo will print 2, because the variable $x will be expanded when the alias
1039                         // gets expanded. bar will print 1, because the variable $x was expanded
1040                         // at definition time. foo can be equivalently defined as
1041                         //
1042                         //   "alias" foo "echo $$x"
1043                         //
1044                         // because at definition time, $$ will get replaced to a single $.
1045
1046                         if( *in == '$' ) {
1047                                 val = "$";
1048                                 eat = 1;
1049                         } else if(*in == '{') {
1050                                 varlen = strcspn(in + 1, "}");
1051                                 if(in[varlen + 1] == '}')
1052                                 {
1053                                         val = Cmd_GetCvarValue(in + 1, varlen, alias);
1054                                         eat = varlen + 2;
1055                                 }
1056                                 else
1057                                 {
1058                                         // ran out of data?
1059                                         val = NULL;
1060                                         eat = varlen + 1;
1061                                 }
1062                         } else {
1063                                 varlen = strspn(in, "#*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
1064                                 val = Cmd_GetCvarValue(in, varlen, alias);
1065                                 eat = varlen;
1066                         }
1067                         if(val)
1068                         {
1069                                 // insert the cvar value
1070                                 while(*val && outlen < maxoutlen)
1071                                         outtext[outlen++] = *val++;
1072                                 in += eat;
1073                         }
1074                         else
1075                         {
1076                                 // copy the unexpanded text
1077                                 outtext[outlen++] = '$';
1078                                 while(eat && outlen < maxoutlen)
1079                                 {
1080                                         outtext[outlen++] = *in++;
1081                                         --eat;
1082                                 }
1083                         }
1084                 }
1085                 else
1086                         outtext[outlen++] = *in++;
1087         }
1088         outtext[outlen] = 0;
1089 }
1090
1091 /*
1092 ============
1093 Cmd_ExecuteAlias
1094
1095 Called for aliases and fills in the alias into the cbuffer
1096 ============
1097 */
1098 static void Cmd_ExecuteAlias (cmdalias_t *alias)
1099 {
1100         static char buffer[ MAX_INPUTLINE ];
1101         static char buffer2[ MAX_INPUTLINE ];
1102         Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
1103         // insert at start of command buffer, so that aliases execute in order
1104         // (fixes bug introduced by Black on 20050705)
1105
1106         // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1107         // have to make sure that no second variable expansion takes place, otherwise
1108         // alias parameters containing dollar signs can have bad effects.
1109         Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$", false);
1110         Cbuf_InsertText( buffer2 );
1111 }
1112
1113 /*
1114 ========
1115 Cmd_List
1116
1117         CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1118         Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1119
1120 ========
1121 */
1122 static void Cmd_List_f (void)
1123 {
1124         cmd_function_t *cmd;
1125         const char *partial;
1126         size_t len;
1127         int count;
1128         qboolean ispattern;
1129
1130         if (Cmd_Argc() > 1)
1131         {
1132                 partial = Cmd_Argv (1);
1133                 len = strlen(partial);
1134         }
1135         else
1136         {
1137                 partial = NULL;
1138                 len = 0;
1139         }
1140
1141         ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1142
1143         count = 0;
1144         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1145         {
1146                 if (partial && (ispattern ? !matchpattern_with_separator(cmd->name, partial, false, "", false) : strncmp(partial, cmd->name, len)))
1147                         continue;
1148                 Con_Printf("%s : %s\n", cmd->name, cmd->description);
1149                 count++;
1150         }
1151
1152         if (len)
1153         {
1154                 if(ispattern)
1155                         Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1156                 else
1157                         Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1158         }
1159         else
1160                 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1161 }
1162
1163 static void Cmd_Apropos_f(void)
1164 {
1165         cmd_function_t *cmd;
1166         cvar_t *cvar;
1167         cmdalias_t *alias;
1168         const char *partial;
1169         int count;
1170         qboolean ispattern;
1171
1172         if (Cmd_Argc() > 1)
1173                 partial = Cmd_Args();
1174         else
1175         {
1176                 Con_Printf("usage: apropos <string>\n");
1177                 return;
1178         }
1179
1180         ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1181         if(!ispattern)
1182                 partial = va("*%s*", partial);
1183
1184         count = 0;
1185         for (cvar = cvar_vars; cvar; cvar = cvar->next)
1186         {
1187                 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1188                 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1189                         continue;
1190                 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1191                 count++;
1192         }
1193         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1194         {
1195                 if (!matchpattern_with_separator(cmd->name, partial, true, "", false))
1196                 if (!matchpattern_with_separator(cmd->description, partial, true, "", false))
1197                         continue;
1198                 Con_Printf("command ^2%s^7: %s\n", cmd->name, cmd->description);
1199                 count++;
1200         }
1201         for (alias = cmd_alias; alias; alias = alias->next)
1202         {
1203                 // procede here a bit differently as an alias value always got a final \n
1204                 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1205                 if (!matchpattern_with_separator(alias->value, partial, true, "\n", false)) // when \n is as separator wildcards don't match it
1206                         continue;
1207                 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value); // do not print an extra \n
1208                 count++;
1209         }
1210         Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1211 }
1212
1213 /*
1214 ============
1215 Cmd_Init
1216 ============
1217 */
1218 void Cmd_Init (void)
1219 {
1220         cmd_mempool = Mem_AllocPool("commands", 0, NULL);
1221         // space for commands and script files
1222         cmd_text.data = cmd_text_buf;
1223         cmd_text.maxsize = sizeof(cmd_text_buf);
1224         cmd_text.cursize = 0;
1225 }
1226
1227 void Cmd_Init_Commands (void)
1228 {
1229 //
1230 // register our commands
1231 //
1232         Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1233         Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
1234         Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1235         Cmd_AddCommand ("alias",Cmd_Alias_f, "create a script function (parameters are passed in as $X (being X a number), $* for all parameters, $X- for all parameters starting from $X). Without arguments show the list of all alias");
1236         Cmd_AddCommand ("unalias",Cmd_UnAlias_f, "remove an alias");
1237         Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
1238         Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1239         Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
1240         Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1241         Cmd_AddCommand ("unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1242 #ifdef FILLALLCVARSWITHRUBBISH
1243         Cmd_AddCommand ("fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1244 #endif /* FILLALLCVARSWITHRUBBISH */
1245
1246         // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1247         // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1248         Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1249         Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1250         Cmd_AddCommand ("apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1251
1252         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");
1253         Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1254         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)");
1255         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)");
1256
1257         Cmd_AddCommand ("cprint", Cmd_Centerprint_f, "print something at the screen center");
1258         Cmd_AddCommand ("defer", Cmd_Defer_f, "execute a command in the future");
1259
1260         // DRESK - 5/14/06
1261         // Support Doom3-style Toggle Command
1262         Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1263 }
1264
1265 /*
1266 ============
1267 Cmd_Shutdown
1268 ============
1269 */
1270 void Cmd_Shutdown(void)
1271 {
1272         Mem_FreePool(&cmd_mempool);
1273 }
1274
1275 /*
1276 ============
1277 Cmd_Argc
1278 ============
1279 */
1280 int             Cmd_Argc (void)
1281 {
1282         return cmd_argc;
1283 }
1284
1285 /*
1286 ============
1287 Cmd_Argv
1288 ============
1289 */
1290 const char *Cmd_Argv (int arg)
1291 {
1292         if (arg >= cmd_argc )
1293                 return cmd_null_string;
1294         return cmd_argv[arg];
1295 }
1296
1297 /*
1298 ============
1299 Cmd_Args
1300 ============
1301 */
1302 const char *Cmd_Args (void)
1303 {
1304         return cmd_args;
1305 }
1306
1307
1308 /*
1309 ============
1310 Cmd_TokenizeString
1311
1312 Parses the given string into command line tokens.
1313 ============
1314 */
1315 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1316 static void Cmd_TokenizeString (const char *text)
1317 {
1318         int l;
1319
1320         cmd_argc = 0;
1321         cmd_args = NULL;
1322
1323         while (1)
1324         {
1325                 // skip whitespace up to a /n
1326                 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1327                         text++;
1328
1329                 // line endings:
1330                 // UNIX: \n
1331                 // Mac: \r
1332                 // Windows: \r\n
1333                 if (*text == '\n' || *text == '\r')
1334                 {
1335                         // a newline separates commands in the buffer
1336                         if (*text == '\r' && text[1] == '\n')
1337                                 text++;
1338                         text++;
1339                         break;
1340                 }
1341
1342                 if (!*text)
1343                         return;
1344
1345                 if (cmd_argc == 1)
1346                         cmd_args = text;
1347
1348                 if (!COM_ParseToken_Console(&text))
1349                         return;
1350
1351                 if (cmd_argc < MAX_ARGS)
1352                 {
1353                         l = (int)strlen(com_token) + 1;
1354                         if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1355                         {
1356                                 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1357                                 break;
1358                         }
1359                         memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
1360                         cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
1361                         cmd_tokenizebufferpos += l;
1362                         cmd_argc++;
1363                 }
1364         }
1365 }
1366
1367
1368 /*
1369 ============
1370 Cmd_AddCommand
1371 ============
1372 */
1373 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
1374 {
1375         cmd_function_t *cmd;
1376         cmd_function_t *prev, *current;
1377
1378 // fail if the command is a variable name
1379         if (Cvar_FindVar( cmd_name ))
1380         {
1381                 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1382                 return;
1383         }
1384
1385 // fail if the command already exists
1386         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1387         {
1388                 if (!strcmp (cmd_name, cmd->name))
1389                 {
1390                         if (consolefunction || clientfunction)
1391                         {
1392                                 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1393                                 return;
1394                         }
1395                         else    //[515]: csqc
1396                         {
1397                                 cmd->csqcfunc = true;
1398                                 return;
1399                         }
1400                 }
1401         }
1402
1403         cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
1404         cmd->name = cmd_name;
1405         cmd->consolefunction = consolefunction;
1406         cmd->clientfunction = clientfunction;
1407         cmd->description = description;
1408         if(!consolefunction && !clientfunction)                 //[515]: csqc
1409                 cmd->csqcfunc = true;
1410         cmd->next = cmd_functions;
1411
1412 // insert it at the right alphanumeric position
1413         for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
1414                 ;
1415         if( prev ) {
1416                 prev->next = cmd;
1417         } else {
1418                 cmd_functions = cmd;
1419         }
1420         cmd->next = current;
1421 }
1422
1423 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
1424 {
1425         Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
1426 }
1427
1428 /*
1429 ============
1430 Cmd_Exists
1431 ============
1432 */
1433 qboolean Cmd_Exists (const char *cmd_name)
1434 {
1435         cmd_function_t  *cmd;
1436
1437         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1438                 if (!strcmp (cmd_name,cmd->name))
1439                         return true;
1440
1441         return false;
1442 }
1443
1444
1445 /*
1446 ============
1447 Cmd_CompleteCommand
1448 ============
1449 */
1450 const char *Cmd_CompleteCommand (const char *partial)
1451 {
1452         cmd_function_t *cmd;
1453         size_t len;
1454
1455         len = strlen(partial);
1456
1457         if (!len)
1458                 return NULL;
1459
1460 // check functions
1461         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1462                 if (!strncasecmp(partial, cmd->name, len))
1463                         return cmd->name;
1464
1465         return NULL;
1466 }
1467
1468 /*
1469         Cmd_CompleteCountPossible
1470
1471         New function for tab-completion system
1472         Added by EvilTypeGuy
1473         Thanks to Fett erich@heintz.com
1474         Thanks to taniwha
1475
1476 */
1477 int Cmd_CompleteCountPossible (const char *partial)
1478 {
1479         cmd_function_t *cmd;
1480         size_t len;
1481         int h;
1482
1483         h = 0;
1484         len = strlen(partial);
1485
1486         if (!len)
1487                 return 0;
1488
1489         // Loop through the command list and count all partial matches
1490         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1491                 if (!strncasecmp(partial, cmd->name, len))
1492                         h++;
1493
1494         return h;
1495 }
1496
1497 /*
1498         Cmd_CompleteBuildList
1499
1500         New function for tab-completion system
1501         Added by EvilTypeGuy
1502         Thanks to Fett erich@heintz.com
1503         Thanks to taniwha
1504
1505 */
1506 const char **Cmd_CompleteBuildList (const char *partial)
1507 {
1508         cmd_function_t *cmd;
1509         size_t len = 0;
1510         size_t bpos = 0;
1511         size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
1512         const char **buf;
1513
1514         len = strlen(partial);
1515         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1516         // Loop through the alias list and print all matches
1517         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1518                 if (!strncasecmp(partial, cmd->name, len))
1519                         buf[bpos++] = cmd->name;
1520
1521         buf[bpos] = NULL;
1522         return buf;
1523 }
1524
1525 // written by LordHavoc
1526 void Cmd_CompleteCommandPrint (const char *partial)
1527 {
1528         cmd_function_t *cmd;
1529         size_t len = strlen(partial);
1530         // Loop through the command list and print all matches
1531         for (cmd = cmd_functions; cmd; cmd = cmd->next)
1532                 if (!strncasecmp(partial, cmd->name, len))
1533                         Con_Printf("^2%s^7: %s\n", cmd->name, cmd->description);
1534 }
1535
1536 /*
1537         Cmd_CompleteAlias
1538
1539         New function for tab-completion system
1540         Added by EvilTypeGuy
1541         Thanks to Fett erich@heintz.com
1542         Thanks to taniwha
1543
1544 */
1545 const char *Cmd_CompleteAlias (const char *partial)
1546 {
1547         cmdalias_t *alias;
1548         size_t len;
1549
1550         len = strlen(partial);
1551
1552         if (!len)
1553                 return NULL;
1554
1555         // Check functions
1556         for (alias = cmd_alias; alias; alias = alias->next)
1557                 if (!strncasecmp(partial, alias->name, len))
1558                         return alias->name;
1559
1560         return NULL;
1561 }
1562
1563 // written by LordHavoc
1564 void Cmd_CompleteAliasPrint (const char *partial)
1565 {
1566         cmdalias_t *alias;
1567         size_t len = strlen(partial);
1568         // Loop through the alias list and print all matches
1569         for (alias = cmd_alias; alias; alias = alias->next)
1570                 if (!strncasecmp(partial, alias->name, len))
1571                         Con_Printf("^5%s^7: %s", alias->name, alias->value);
1572 }
1573
1574
1575 /*
1576         Cmd_CompleteAliasCountPossible
1577
1578         New function for tab-completion system
1579         Added by EvilTypeGuy
1580         Thanks to Fett erich@heintz.com
1581         Thanks to taniwha
1582
1583 */
1584 int Cmd_CompleteAliasCountPossible (const char *partial)
1585 {
1586         cmdalias_t      *alias;
1587         size_t          len;
1588         int                     h;
1589
1590         h = 0;
1591
1592         len = strlen(partial);
1593
1594         if (!len)
1595                 return 0;
1596
1597         // Loop through the command list and count all partial matches
1598         for (alias = cmd_alias; alias; alias = alias->next)
1599                 if (!strncasecmp(partial, alias->name, len))
1600                         h++;
1601
1602         return h;
1603 }
1604
1605 /*
1606         Cmd_CompleteAliasBuildList
1607
1608         New function for tab-completion system
1609         Added by EvilTypeGuy
1610         Thanks to Fett erich@heintz.com
1611         Thanks to taniwha
1612
1613 */
1614 const char **Cmd_CompleteAliasBuildList (const char *partial)
1615 {
1616         cmdalias_t *alias;
1617         size_t len = 0;
1618         size_t bpos = 0;
1619         size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1620         const char **buf;
1621
1622         len = strlen(partial);
1623         buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1624         // Loop through the alias list and print all matches
1625         for (alias = cmd_alias; alias; alias = alias->next)
1626                 if (!strncasecmp(partial, alias->name, len))
1627                         buf[bpos++] = alias->name;
1628
1629         buf[bpos] = NULL;
1630         return buf;
1631 }
1632
1633 void Cmd_ClearCsqcFuncs (void)
1634 {
1635         cmd_function_t *cmd;
1636         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1637                 cmd->csqcfunc = false;
1638 }
1639
1640 qboolean CL_VM_ConsoleCommand (const char *cmd);
1641 /*
1642 ============
1643 Cmd_ExecuteString
1644
1645 A complete command line has been parsed, so try to execute it
1646 FIXME: lookupnoadd the token to speed search?
1647 ============
1648 */
1649 void Cmd_ExecuteString (const char *text, cmd_source_t src)
1650 {
1651         int oldpos;
1652         int found;
1653         cmd_function_t *cmd;
1654         cmdalias_t *a;
1655
1656         oldpos = cmd_tokenizebufferpos;
1657         cmd_source = src;
1658         found = false;
1659
1660         Cmd_TokenizeString (text);
1661
1662 // execute the command line
1663         if (!Cmd_Argc())
1664         {
1665                 cmd_tokenizebufferpos = oldpos;
1666                 return;         // no tokens
1667         }
1668
1669 // check functions
1670         for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1671         {
1672                 if (!strcasecmp (cmd_argv[0],cmd->name))
1673                 {
1674                         if (cmd->csqcfunc && CL_VM_ConsoleCommand (text))       //[515]: csqc
1675                                 return;
1676                         switch (src)
1677                         {
1678                         case src_command:
1679                                 if (cmd->consolefunction)
1680                                         cmd->consolefunction ();
1681                                 else if (cmd->clientfunction)
1682                                 {
1683                                         if (cls.state == ca_connected)
1684                                         {
1685                                                 // forward remote commands to the server for execution
1686                                                 Cmd_ForwardToServer();
1687                                         }
1688                                         else
1689                                                 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1690                                 }
1691                                 else
1692                                         Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1693                                 found = true;
1694                                 goto command_found;
1695                         case src_client:
1696                                 if (cmd->clientfunction)
1697                                 {
1698                                         cmd->clientfunction ();
1699                                         cmd_tokenizebufferpos = oldpos;
1700                                         return;
1701                                 }
1702                                 break;
1703                         }
1704                         break;
1705                 }
1706         }
1707 command_found:
1708
1709         // if it's a client command and no command was found, say so.
1710         if (cmd_source == src_client)
1711         {
1712                 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1713                 cmd_tokenizebufferpos = oldpos;
1714                 return;
1715         }
1716
1717 // check alias
1718         for (a=cmd_alias ; a ; a=a->next)
1719         {
1720                 if (!strcasecmp (cmd_argv[0], a->name))
1721                 {
1722                         Cmd_ExecuteAlias(a);
1723                         cmd_tokenizebufferpos = oldpos;
1724                         return;
1725                 }
1726         }
1727
1728         if(found) // if the command was hooked and found, all is good
1729         {
1730                 cmd_tokenizebufferpos = oldpos;
1731                 return;
1732         }
1733
1734 // check cvars
1735         if (!Cvar_Command () && host_framecount > 0)
1736                 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1737
1738         cmd_tokenizebufferpos = oldpos;
1739 }
1740
1741
1742 /*
1743 ===================
1744 Cmd_ForwardStringToServer
1745
1746 Sends an entire command string over to the server, unprocessed
1747 ===================
1748 */
1749 void Cmd_ForwardStringToServer (const char *s)
1750 {
1751         char temp[128];
1752         if (cls.state != ca_connected)
1753         {
1754                 Con_Printf("Can't \"%s\", not connected\n", s);
1755                 return;
1756         }
1757
1758         if (!cls.netcon)
1759                 return;
1760
1761         // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1762         // attention, it has been eradicated from here, its only (former) use in
1763         // all of darkplaces.
1764         if (cls.protocol == PROTOCOL_QUAKEWORLD)
1765                 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1766         else
1767                 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1768         if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
1769         {
1770                 // say/say_team commands can replace % character codes with status info
1771                 while (*s)
1772                 {
1773                         if (*s == '%' && s[1])
1774                         {
1775                                 // handle proquake message macros
1776                                 temp[0] = 0;
1777                                 switch (s[1])
1778                                 {
1779                                 case 'l': // current location
1780                                         CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
1781                                         break;
1782                                 case 'h': // current health
1783                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
1784                                         break;
1785                                 case 'a': // current armor
1786                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
1787                                         break;
1788                                 case 'x': // current rockets
1789                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
1790                                         break;
1791                                 case 'c': // current cells
1792                                         dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
1793                                         break;
1794                                 // silly proquake macros
1795                                 case 'd': // loc at last death
1796                                         CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
1797                                         break;
1798                                 case 't': // current time
1799                                         dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
1800                                         break;
1801                                 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
1802                                         if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
1803                                                 dpsnprintf(temp, sizeof(temp), "I need RL");
1804                                         else if (!cl.stats[STAT_ROCKETS])
1805                                                 dpsnprintf(temp, sizeof(temp), "I need rockets");
1806                                         else
1807                                                 dpsnprintf(temp, sizeof(temp), "I have RL");
1808                                         break;
1809                                 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
1810                                         if (cl.stats[STAT_ITEMS] & IT_QUAD)
1811                                         {
1812                                                 if (temp[0])
1813                                                         strlcat(temp, " ", sizeof(temp));
1814                                                 strlcat(temp, "quad", sizeof(temp));
1815                                         }
1816                                         if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
1817                                         {
1818                                                 if (temp[0])
1819                                                         strlcat(temp, " ", sizeof(temp));
1820                                                 strlcat(temp, "pent", sizeof(temp));
1821                                         }
1822                                         if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
1823                                         {
1824                                                 if (temp[0])
1825                                                         strlcat(temp, " ", sizeof(temp));
1826                                                 strlcat(temp, "eyes", sizeof(temp));
1827                                         }
1828                                         break;
1829                                 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
1830                                         if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
1831                                                 strlcat(temp, "SSG", sizeof(temp));
1832                                         strlcat(temp, ":", sizeof(temp));
1833                                         if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
1834                                                 strlcat(temp, "NG", sizeof(temp));
1835                                         strlcat(temp, ":", sizeof(temp));
1836                                         if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
1837                                                 strlcat(temp, "SNG", sizeof(temp));
1838                                         strlcat(temp, ":", sizeof(temp));
1839                                         if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
1840                                                 strlcat(temp, "GL", sizeof(temp));
1841                                         strlcat(temp, ":", sizeof(temp));
1842                                         if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
1843                                                 strlcat(temp, "RL", sizeof(temp));
1844                                         strlcat(temp, ":", sizeof(temp));
1845                                         if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
1846                                                 strlcat(temp, "LG", sizeof(temp));
1847                                         break;
1848                                 default:
1849                                         // not a recognized macro, print it as-is...
1850                                         temp[0] = s[0];
1851                                         temp[1] = s[1];
1852                                         temp[2] = 0;
1853                                         break;
1854                                 }
1855                                 // write the resulting text
1856                                 SZ_Write(&cls.netcon->message, (unsigned char *)temp, strlen(temp));
1857                                 s += 2;
1858                                 continue;
1859                         }
1860                         MSG_WriteByte(&cls.netcon->message, *s);
1861                         s++;
1862                 }
1863                 MSG_WriteByte(&cls.netcon->message, 0);
1864         }
1865         else // any other command is passed on as-is
1866                 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1867 }
1868
1869 /*
1870 ===================
1871 Cmd_ForwardToServer
1872
1873 Sends the entire command line over to the server
1874 ===================
1875 */
1876 void Cmd_ForwardToServer (void)
1877 {
1878         const char *s;
1879         if (!strcasecmp(Cmd_Argv(0), "cmd"))
1880         {
1881                 // we want to strip off "cmd", so just send the args
1882                 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1883         }
1884         else
1885         {
1886                 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1887                 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1888         }
1889         // don't send an empty forward message if the user tries "cmd" by itself
1890         if (!s || !*s)
1891                 return;
1892         Cmd_ForwardStringToServer(s);
1893 }
1894
1895
1896 /*
1897 ================
1898 Cmd_CheckParm
1899
1900 Returns the position (1 to argc-1) in the command's argument list
1901 where the given parameter apears, or 0 if not present
1902 ================
1903 */
1904
1905 int Cmd_CheckParm (const char *parm)
1906 {
1907         int i;
1908
1909         if (!parm)
1910         {
1911                 Con_Printf ("Cmd_CheckParm: NULL");
1912                 return 0;
1913         }
1914
1915         for (i = 1; i < Cmd_Argc (); i++)
1916                 if (!strcasecmp (parm, Cmd_Argv (i)))
1917                         return i;
1918
1919         return 0;
1920 }
1921
1922
1923
1924 void Cmd_SaveInitState(void)
1925 {
1926         cmd_function_t *f;
1927         cmdalias_t *a;
1928         for (f = cmd_functions;f;f = f->next)
1929                 f->initstate = true;
1930         for (a = cmd_alias;a;a = a->next)
1931         {
1932                 a->initstate = true;
1933                 a->initialvalue = Mem_strdup(zonemempool, a->value);
1934         }
1935         Cvar_SaveInitState();
1936 }
1937
1938 void Cmd_RestoreInitState(void)
1939 {
1940         cmd_function_t *f, **fp;
1941         cmdalias_t *a, **ap;
1942         for (fp = &cmd_functions;(f = *fp);)
1943         {
1944                 if (f->initstate)
1945                         fp = &f->next;
1946                 else
1947                 {
1948                         // destroy this command, it didn't exist at init
1949                         Con_DPrintf("Cmd_RestoreInitState: Destroying command %s\n", f->name);
1950                         *fp = f->next;
1951                         Z_Free(f);
1952                 }
1953         }
1954         for (ap = &cmd_alias;(a = *ap);)
1955         {
1956                 if (a->initstate)
1957                 {
1958                         // restore this alias, it existed at init
1959                         if (strcmp(a->value ? a->value : "", a->initialvalue ? a->initialvalue : ""))
1960                         {
1961                                 Con_DPrintf("Cmd_RestoreInitState: Restoring alias %s\n", a->name);
1962                                 if (a->value)
1963                                         Z_Free(a->value);
1964                                 a->value = Mem_strdup(zonemempool, a->initialvalue);
1965                         }
1966                         ap = &a->next;
1967                 }
1968                 else
1969                 {
1970                         // free this alias, it didn't exist at init...
1971                         Con_DPrintf("Cmd_RestoreInitState: Destroying alias %s\n", a->name);
1972                         *ap = a->next;
1973                         if (a->value)
1974                                 Z_Free(a->value);
1975                         Z_Free(a);
1976                 }
1977         }
1978         Cvar_RestoreInitState();
1979 }