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