2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // cmd.c -- Quake script command processing module
24 #define MAX_ALIAS_NAME 32
25 // this is the largest script file that can be executed in one step
26 // LordHavoc: inreased this from 8192 to 32768
27 // div0: increased this from 32k to 128k
28 #define CMDBUFSIZE 131072
29 // maximum number of parameters to a command
31 // maximum tokenizable commandline length (counting NUL terminations)
32 #define CMD_TOKENIZELENGTH (MAX_INPUTLINE + MAX_ARGS)
34 typedef struct cmdalias_s
36 struct cmdalias_s *next;
37 char name[MAX_ALIAS_NAME];
41 static cmdalias_t *cmd_alias;
43 static qboolean cmd_wait;
45 static mempool_t *cmd_mempool;
47 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
48 static int cmd_tokenizebufferpos = 0;
50 //=============================================================================
56 Causes execution of the remainder of the command buffer to be delayed until
57 next frame. This allows commands like:
58 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
61 static void Cmd_Wait_f (void)
66 typedef struct cmddeferred_s
68 struct cmddeferred_s *next;
73 static cmddeferred_t *cmd_deferred_list = NULL;
79 Cause a command to be executed after a delay.
82 static void Cmd_Defer_f (void)
86 double time = Sys_DoubleTime();
87 cmddeferred_t *next = cmd_deferred_list;
89 Con_Printf("No commands are pending.\n");
92 Con_Printf("-> In %9.2f: %s\n", next->time-time, next->value);
95 } else if(Cmd_Argc() == 2 && !strcasecmp("clear", Cmd_Argv(1)))
97 while(cmd_deferred_list)
99 cmddeferred_t *cmd = cmd_deferred_list;
100 cmd_deferred_list = cmd->next;
101 Mem_Free(cmd->value);
104 } else if(Cmd_Argc() == 3)
106 const char *value = Cmd_Argv(2);
107 cmddeferred_t *defcmd = (cmddeferred_t*)Mem_Alloc(tempmempool, sizeof(*defcmd));
108 size_t len = strlen(value);
110 defcmd->time = Sys_DoubleTime() + atof(Cmd_Argv(1));
111 defcmd->value = (char*)Mem_Alloc(tempmempool, len+1);
112 memcpy(defcmd->value, value, len+1);
115 if(cmd_deferred_list)
117 cmddeferred_t *next = cmd_deferred_list;
122 cmd_deferred_list = defcmd;
123 /* Stupid me... this changes the order... so commands with the same delay go blub :S
124 defcmd->next = cmd_deferred_list;
125 cmd_deferred_list = defcmd;*/
127 Con_Printf("usage: defer <seconds> <command>\n"
137 Print something to the center of the screen using SCR_Centerprint
140 static void Cmd_Centerprint_f (void)
142 char msg[MAX_INPUTLINE];
143 unsigned int i, c, p;
147 strlcpy(msg, Cmd_Argv(1), sizeof(msg));
148 for(i = 2; i < c; ++i)
150 strlcat(msg, " ", sizeof(msg));
151 strlcat(msg, Cmd_Argv(i), sizeof(msg));
154 for(p = 0, i = 0; i < c; ++i)
160 else if(msg[i+1] == '\\')
172 SCR_CenterPrint(msg);
177 =============================================================================
181 =============================================================================
184 static sizebuf_t cmd_text;
185 static unsigned char cmd_text_buf[CMDBUFSIZE];
191 Adds command text at the end of the buffer
194 void Cbuf_AddText (const char *text)
198 l = (int)strlen (text);
200 if (cmd_text.cursize + l >= cmd_text.maxsize)
202 Con_Print("Cbuf_AddText: overflow\n");
206 SZ_Write (&cmd_text, (const unsigned char *)text, (int)strlen (text));
214 Adds command text immediately after the current command
215 Adds a \n to the text
216 FIXME: actually change the command buffer to do less copying
219 void Cbuf_InsertText (const char *text)
224 // copy off any commands still remaining in the exec buffer
225 templen = cmd_text.cursize;
228 temp = (char *)Mem_Alloc (tempmempool, templen);
229 memcpy (temp, cmd_text.data, templen);
230 SZ_Clear (&cmd_text);
235 // add the entire text of the file
238 // add the copied off data
241 SZ_Write (&cmd_text, (const unsigned char *)temp, templen);
248 Cbuf_Execute_Deferred --blub
251 void Cbuf_Execute_Deferred (void)
253 cmddeferred_t *cmd, *prev;
254 double time = Sys_DoubleTime();
256 cmd = cmd_deferred_list;
259 if(cmd->time <= time)
261 Cbuf_AddText(cmd->value);
263 Mem_Free(cmd->value);
266 prev->next = cmd->next;
270 cmd_deferred_list = cmd->next;
272 cmd = cmd_deferred_list;
286 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
287 void Cbuf_Execute (void)
291 char line[MAX_INPUTLINE];
292 char preprocessed[MAX_INPUTLINE];
294 qboolean quotes, comment;
296 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
297 cmd_tokenizebufferpos = 0;
299 Cbuf_Execute_Deferred();
300 while (cmd_text.cursize)
302 // find a \n or ; line break
303 text = (char *)cmd_text.data;
307 for (i=0 ; i < cmd_text.cursize ; i++)
316 // make sure i doesn't get > cursize which causes a negative
317 // size in memmove, which is fatal --blub
318 if (i < (cmd_text.cursize-1) && (text[i] == '\\' && (text[i+1] == '"' || text[i+1] == '\\')))
323 if(text[i] == '/' && text[i + 1] == '/')
326 break; // don't break if inside a quoted string or comment
330 if (text[i] == '\r' || text[i] == '\n')
334 // better than CRASHING on overlong input lines that may SOMEHOW enter the buffer
335 if(i >= MAX_INPUTLINE)
337 Con_Printf("Warning: console input buffer had an overlong line. Ignored.\n");
342 memcpy (line, text, i);
346 // delete the text from the command buffer and move remaining commands down
347 // this is necessary because commands (exec, alias) can insert data at the
348 // beginning of the text buffer
350 if (i == cmd_text.cursize)
351 cmd_text.cursize = 0;
355 cmd_text.cursize -= i;
356 memmove (cmd_text.data, text+i, cmd_text.cursize);
359 // execute the command line
360 firstchar = line + strspn(line, " \t");
362 (strncmp(firstchar, "alias", 5) || (firstchar[5] != ' ' && firstchar[5] != '\t'))
364 (strncmp(firstchar, "bind", 4) || (firstchar[4] != ' ' && firstchar[4] != '\t'))
366 (strncmp(firstchar, "in_bind", 7) || (firstchar[7] != ' ' && firstchar[7] != '\t'))
369 Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
370 Cmd_ExecuteString (preprocessed, src_command);
374 Cmd_ExecuteString (line, src_command);
378 { // skip out while text still remains in buffer, leaving it
387 ==============================================================================
391 ==============================================================================
398 Adds command line parameters as script statements
399 Commands lead with a +, and continue until a - or another +
400 quake +prog jctest.qp +cmd amlev1
401 quake -nosound +cmd amlev1
404 qboolean host_stuffcmdsrun = false;
405 void Cmd_StuffCmds_f (void)
408 // this is for all commandline options combined (and is bounds checked)
409 char build[MAX_INPUTLINE];
411 if (Cmd_Argc () != 1)
413 Con_Print("stuffcmds : execute command line parameters\n");
417 // no reason to run the commandline arguments twice
418 if (host_stuffcmdsrun)
421 host_stuffcmdsrun = true;
424 for (i = 0;i < com_argc;i++)
426 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)
429 while (com_argv[i][j])
430 build[l++] = com_argv[i][j++];
432 for (;i < com_argc;i++)
436 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
438 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
441 if (strchr(com_argv[i], ' '))
443 for (j = 0;com_argv[i][j];j++)
444 build[l++] = com_argv[i][j];
445 if (strchr(com_argv[i], ' '))
452 // now terminate the combined string and prepend it to the command buffer
453 // we already reserved space for the terminator
455 Cbuf_InsertText (build);
464 static void Cmd_Exec_f (void)
468 if (Cmd_Argc () != 2)
470 Con_Print("exec <filename> : execute a script file\n");
474 f = (char *)FS_LoadFile (Cmd_Argv(1), tempmempool, false, NULL);
477 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
480 Con_Printf("execing %s\n",Cmd_Argv(1));
482 // if executing default.cfg for the first time, lock the cvar defaults
483 // it may seem backwards to insert this text BEFORE the default.cfg
484 // but Cbuf_InsertText inserts before, so this actually ends up after it.
485 if (!strcmp(Cmd_Argv(1), "default.cfg"))
486 Cbuf_InsertText("\ncvar_lockdefaults\n");
488 // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
489 // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
490 Cbuf_InsertText ("\n");
500 Just prints the rest of the line to the console
503 static void Cmd_Echo_f (void)
507 for (i=1 ; i<Cmd_Argc() ; i++)
508 Con_Printf("%s ",Cmd_Argv(i));
513 // Support Doom3-style Toggle Console Command
518 Toggles a specified console variable amongst the values specified (default is 0 and 1)
521 static void Cmd_Toggle_f(void)
523 // Acquire Number of Arguments
524 int nNumArgs = Cmd_Argc();
527 // No Arguments Specified; Print Usage
528 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");
530 { // Correct Arguments Specified
531 // Acquire Potential CVar
532 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
539 Cvar_SetValueQuick(cvCVar, 0);
541 Cvar_SetValueQuick(cvCVar, 1);
545 { // 0 and Specified Usage
546 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
547 // CVar is Specified Value; // Reset to 0
548 Cvar_SetValueQuick(cvCVar, 0);
550 if(cvCVar->integer == 0)
551 // CVar is 0; Specify Value
552 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
554 // CVar does not match; Reset to 0
555 Cvar_SetValueQuick(cvCVar, 0);
558 { // Variable Values Specified
562 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
563 { // Cycle through Values
564 if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
565 { // Current Value Located; Increment to Next
566 if( (nCnt + 1) == nNumArgs)
567 // Max Value Reached; Reset
568 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
571 Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
580 // Value not Found; Reset to Original
581 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
587 Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(1) );
596 Creates a new command that executes a command string (possibly ; seperated)
599 static void Cmd_Alias_f (void)
602 char cmd[MAX_INPUTLINE];
609 Con_Print("Current alias commands:\n");
610 for (a = cmd_alias ; a ; a=a->next)
611 Con_Printf("%s : %s", a->name, a->value);
616 if (strlen(s) >= MAX_ALIAS_NAME)
618 Con_Print("Alias name is too long\n");
622 // if the alias already exists, reuse it
623 for (a = cmd_alias ; a ; a=a->next)
625 if (!strcmp(s, a->name))
634 cmdalias_t *prev, *current;
636 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
637 strlcpy (a->name, s, sizeof (a->name));
638 // insert it at the right alphanumeric position
639 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
650 // copy the rest of the command line
651 cmd[0] = 0; // start out with a null string
653 for (i=2 ; i< c ; i++)
655 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
657 strlcat (cmd, " ", sizeof (cmd));
659 strlcat (cmd, "\n", sizeof (cmd));
661 alloclen = strlen (cmd) + 1;
663 cmd[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
664 a->value = (char *)Z_Malloc (alloclen);
665 memcpy (a->value, cmd, alloclen);
669 =============================================================================
673 =============================================================================
676 typedef struct cmd_function_s
678 struct cmd_function_s *next;
680 const char *description;
681 xcommand_t consolefunction;
682 xcommand_t clientfunction;
687 static const char *cmd_argv[MAX_ARGS];
688 static const char *cmd_null_string = "";
689 static const char *cmd_args;
690 cmd_source_t cmd_source;
693 static cmd_function_t *cmd_functions; // possible commands to execute
695 static const char *Cmd_GetDirectCvarValue(const char *varname, cmdalias_t *alias, qboolean *is_multiple)
702 *is_multiple = false;
704 if(!varname || !*varname)
709 if(!strcmp(varname, "*"))
715 else if(varname[strlen(varname) - 1] == '-')
717 argno = strtol(varname, &endptr, 10);
718 if(endptr == varname + strlen(varname) - 1)
720 // whole string is a number, apart from the -
721 const char *p = Cmd_Args();
722 for(; argno > 1; --argno)
723 if(!COM_ParseToken_Console(&p))
730 // kill pre-argument whitespace
731 for (;*p && ISWHITESPACE(*p);p++)
740 argno = strtol(varname, &endptr, 10);
743 // whole string is a number
744 // NOTE: we already made sure we don't have an empty cvar name!
745 if(argno >= 0 && argno < Cmd_Argc())
746 return Cmd_Argv(argno);
751 if((cvar = Cvar_FindVar(varname)) && !(cvar->flags & CVAR_PRIVATE))
757 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset)
759 qboolean quote_quot = !!strchr(quoteset, '"');
760 qboolean quote_backslash = !!strchr(quoteset, '\\');
761 qboolean quote_dollar = !!strchr(quoteset, '$');
765 if(*in == '"' && quote_quot)
772 *out++ = '\\'; --outlen;
773 *out++ = '"'; --outlen;
775 else if(*in == '\\' && quote_backslash)
782 *out++ = '\\'; --outlen;
783 *out++ = '\\'; --outlen;
785 else if(*in == '$' && quote_dollar)
792 *out++ = '$'; --outlen;
793 *out++ = '$'; --outlen;
802 *out++ = *in; --outlen;
810 static const char *Cmd_GetCvarValue(const char *var, size_t varlen, cmdalias_t *alias)
812 static char varname[MAX_INPUTLINE];
813 static char varval[MAX_INPUTLINE];
817 if(varlen >= MAX_INPUTLINE)
818 varlen = MAX_INPUTLINE - 1;
819 memcpy(varname, var, varlen);
821 varfunc = strchr(varname, ' ');
837 if(varname[0] == '$')
838 varstr = Cmd_GetDirectCvarValue(Cmd_GetDirectCvarValue(varname + 1, alias, NULL), alias, NULL);
841 qboolean is_multiple = false;
842 // Exception: $* and $n- don't use the quoted form by default
843 varstr = Cmd_GetDirectCvarValue(varname, alias, &is_multiple);
852 Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
854 Con_Printf("Warning: Could not expand $%s\n", varname);
858 if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
860 // quote it so it can be used inside double quotes
861 // we just need to replace " by \", and of course, double backslashes
862 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\");
865 else if(!strcmp(varfunc, "asis"))
870 Con_Printf("Unknown variable function %s\n", varfunc);
878 Preprocesses strings and replaces $*, $param#, $cvar accordingly
880 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
886 // don't crash if there's no room in the outtext buffer
887 if( maxoutlen == 0 ) {
890 maxoutlen--; // because of \0
895 while( *in && outlen < maxoutlen ) {
897 // this is some kind of expansion, see what comes after the $
900 // The console does the following preprocessing:
902 // - $$ is transformed to a single dollar sign.
903 // - $var or ${var} are expanded to the contents of the named cvar,
904 // with quotation marks and backslashes quoted so it can safely
905 // be used inside quotation marks (and it should always be used
907 // - ${var asis} inserts the cvar value as is, without doing this
909 // - prefix the cvar name with a dollar sign to do indirection;
910 // for example, if $x has the value timelimit, ${$x} will return
911 // the value of $timelimit
912 // - when expanding an alias, the special variable name $* refers
913 // to all alias parameters, and a number refers to that numbered
914 // alias parameter, where the name of the alias is $0, the first
915 // parameter is $1 and so on; as a special case, $* inserts all
916 // parameters, without extra quoting, so one can use $* to just
917 // pass all parameters around. All parameters starting from $n
918 // can be referred to as $n- (so $* is equivalent to $1-).
920 // Note: when expanding an alias, cvar expansion is done in the SAME step
921 // as alias expansion so that alias parameters or cvar values containing
922 // dollar signs have no unwanted bad side effects. However, this needs to
923 // be accounted for when writing complex aliases. For example,
924 // alias foo "set x NEW; echo $x"
925 // actually expands to
926 // "set x NEW; echo OLD"
927 // and will print OLD! To work around this, use a second alias:
928 // alias foo "set x NEW; foo2"
929 // alias foo2 "echo $x"
931 // Also note: lines starting with alias are exempt from cvar expansion.
932 // If you want cvar expansion, write "alias" instead:
935 // alias foo "echo $x"
936 // "alias" bar "echo $x"
939 // foo will print 2, because the variable $x will be expanded when the alias
940 // gets expanded. bar will print 1, because the variable $x was expanded
941 // at definition time. foo can be equivalently defined as
943 // "alias" foo "echo $$x"
945 // because at definition time, $$ will get replaced to a single $.
950 } else if(*in == '{') {
951 varlen = strcspn(in + 1, "}");
952 if(in[varlen + 1] == '}')
954 val = Cmd_GetCvarValue(in + 1, varlen, alias);
964 varlen = strspn(in, "*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
965 val = Cmd_GetCvarValue(in, varlen, alias);
970 // insert the cvar value
971 while(*val && outlen < maxoutlen)
972 outtext[outlen++] = *val++;
977 // copy the unexpanded text
978 outtext[outlen++] = '$';
979 while(eat && outlen < maxoutlen)
981 outtext[outlen++] = *in++;
986 outtext[outlen++] = *in++;
996 Called for aliases and fills in the alias into the cbuffer
999 static void Cmd_ExecuteAlias (cmdalias_t *alias)
1001 static char buffer[ MAX_INPUTLINE ];
1002 static char buffer2[ MAX_INPUTLINE ];
1003 Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
1004 // insert at start of command buffer, so that aliases execute in order
1005 // (fixes bug introduced by Black on 20050705)
1007 // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1008 // have to make sure that no second variable expansion takes place, otherwise
1009 // alias parameters containing dollar signs can have bad effects.
1010 Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$");
1011 Cbuf_InsertText( buffer2 );
1018 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1019 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1023 static void Cmd_List_f (void)
1025 cmd_function_t *cmd;
1026 const char *partial;
1033 partial = Cmd_Argv (1);
1034 len = strlen(partial);
1042 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1045 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1047 if (partial && (ispattern ? !matchpattern_with_separator(cmd->name, partial, false, "", false) : strncmp(partial, cmd->name, len)))
1049 Con_Printf("%s : %s\n", cmd->name, cmd->description);
1056 Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1058 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1061 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1064 static void Cmd_Apropos_f(void)
1066 cmd_function_t *cmd;
1069 const char *partial;
1076 partial = Cmd_Args();
1077 len = strlen(partial);
1081 Con_Printf("usage: apropos <string>\n");
1085 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1088 partial = va("*%s*", partial);
1093 for (cvar = cvar_vars; cvar; cvar = cvar->next)
1095 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1096 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1098 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1101 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1103 if (!matchpattern_with_separator(cmd->name, partial, true, "", false))
1104 if (!matchpattern_with_separator(cmd->description, partial, true, "", false))
1106 Con_Printf("command ^2%s^7: %s\n", cmd->name, cmd->description);
1109 for (alias = cmd_alias; alias; alias = alias->next)
1111 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1112 if (!matchpattern_with_separator(alias->value, partial, true, "", false))
1114 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value);
1117 Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1125 void Cmd_Init (void)
1127 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
1128 // space for commands and script files
1129 cmd_text.data = cmd_text_buf;
1130 cmd_text.maxsize = sizeof(cmd_text_buf);
1131 cmd_text.cursize = 0;
1134 void Cmd_Init_Commands (void)
1137 // register our commands
1139 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1140 Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
1141 Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1142 Cmd_AddCommand ("alias",Cmd_Alias_f, "create a script function (parameters are passed in as $1 through $9, and $* for all parameters)");
1143 Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
1144 Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1145 Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
1146 Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1148 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1149 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1150 Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix");
1151 Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix");
1152 Cmd_AddCommand ("apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1154 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");
1155 Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1156 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)");
1157 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)");
1159 Cmd_AddCommand ("cprint", Cmd_Centerprint_f, "print something at the screen center");
1160 Cmd_AddCommand ("defer", Cmd_Defer_f, "execute a command in the future");
1163 // Support Doom3-style Toggle Command
1164 Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1172 void Cmd_Shutdown(void)
1174 Mem_FreePool(&cmd_mempool);
1192 const char *Cmd_Argv (int arg)
1194 if (arg >= cmd_argc )
1195 return cmd_null_string;
1196 return cmd_argv[arg];
1204 const char *Cmd_Args (void)
1214 Parses the given string into command line tokens.
1217 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1218 static void Cmd_TokenizeString (const char *text)
1227 // skip whitespace up to a /n
1228 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1235 if (*text == '\n' || *text == '\r')
1237 // a newline separates commands in the buffer
1238 if (*text == '\r' && text[1] == '\n')
1250 if (!COM_ParseToken_Console(&text))
1253 if (cmd_argc < MAX_ARGS)
1255 l = (int)strlen(com_token) + 1;
1256 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1258 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1261 memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
1262 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
1263 cmd_tokenizebufferpos += l;
1275 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
1277 cmd_function_t *cmd;
1278 cmd_function_t *prev, *current;
1280 // fail if the command is a variable name
1281 if (Cvar_FindVar( cmd_name ))
1283 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1287 // fail if the command already exists
1288 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1290 if (!strcmp (cmd_name, cmd->name))
1292 if (consolefunction || clientfunction)
1294 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1299 cmd->csqcfunc = true;
1305 cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
1306 cmd->name = cmd_name;
1307 cmd->consolefunction = consolefunction;
1308 cmd->clientfunction = clientfunction;
1309 cmd->description = description;
1310 if(!consolefunction && !clientfunction) //[515]: csqc
1311 cmd->csqcfunc = true;
1312 cmd->next = cmd_functions;
1314 // insert it at the right alphanumeric position
1315 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
1320 cmd_functions = cmd;
1322 cmd->next = current;
1325 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
1327 Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
1335 qboolean Cmd_Exists (const char *cmd_name)
1337 cmd_function_t *cmd;
1339 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1340 if (!strcmp (cmd_name,cmd->name))
1352 const char *Cmd_CompleteCommand (const char *partial)
1354 cmd_function_t *cmd;
1357 len = strlen(partial);
1363 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1364 if (!strncasecmp(partial, cmd->name, len))
1371 Cmd_CompleteCountPossible
1373 New function for tab-completion system
1374 Added by EvilTypeGuy
1375 Thanks to Fett erich@heintz.com
1379 int Cmd_CompleteCountPossible (const char *partial)
1381 cmd_function_t *cmd;
1386 len = strlen(partial);
1391 // Loop through the command list and count all partial matches
1392 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1393 if (!strncasecmp(partial, cmd->name, len))
1400 Cmd_CompleteBuildList
1402 New function for tab-completion system
1403 Added by EvilTypeGuy
1404 Thanks to Fett erich@heintz.com
1408 const char **Cmd_CompleteBuildList (const char *partial)
1410 cmd_function_t *cmd;
1413 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
1416 len = strlen(partial);
1417 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1418 // Loop through the alias list and print all matches
1419 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1420 if (!strncasecmp(partial, cmd->name, len))
1421 buf[bpos++] = cmd->name;
1427 // written by LordHavoc
1428 void Cmd_CompleteCommandPrint (const char *partial)
1430 cmd_function_t *cmd;
1431 size_t len = strlen(partial);
1432 // Loop through the command list and print all matches
1433 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1434 if (!strncasecmp(partial, cmd->name, len))
1435 Con_Printf("^2%s^7: %s\n", cmd->name, cmd->description);
1441 New function for tab-completion system
1442 Added by EvilTypeGuy
1443 Thanks to Fett erich@heintz.com
1447 const char *Cmd_CompleteAlias (const char *partial)
1452 len = strlen(partial);
1458 for (alias = cmd_alias; alias; alias = alias->next)
1459 if (!strncasecmp(partial, alias->name, len))
1465 // written by LordHavoc
1466 void Cmd_CompleteAliasPrint (const char *partial)
1469 size_t len = strlen(partial);
1470 // Loop through the alias list and print all matches
1471 for (alias = cmd_alias; alias; alias = alias->next)
1472 if (!strncasecmp(partial, alias->name, len))
1473 Con_Printf("^5%s^7: %s", alias->name, alias->value);
1478 Cmd_CompleteAliasCountPossible
1480 New function for tab-completion system
1481 Added by EvilTypeGuy
1482 Thanks to Fett erich@heintz.com
1486 int Cmd_CompleteAliasCountPossible (const char *partial)
1494 len = strlen(partial);
1499 // Loop through the command list and count all partial matches
1500 for (alias = cmd_alias; alias; alias = alias->next)
1501 if (!strncasecmp(partial, alias->name, len))
1508 Cmd_CompleteAliasBuildList
1510 New function for tab-completion system
1511 Added by EvilTypeGuy
1512 Thanks to Fett erich@heintz.com
1516 const char **Cmd_CompleteAliasBuildList (const char *partial)
1521 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1524 len = strlen(partial);
1525 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1526 // Loop through the alias list and print all matches
1527 for (alias = cmd_alias; alias; alias = alias->next)
1528 if (!strncasecmp(partial, alias->name, len))
1529 buf[bpos++] = alias->name;
1535 void Cmd_ClearCsqcFuncs (void)
1537 cmd_function_t *cmd;
1538 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1539 cmd->csqcfunc = false;
1542 qboolean CL_VM_ConsoleCommand (const char *cmd);
1547 A complete command line has been parsed, so try to execute it
1548 FIXME: lookupnoadd the token to speed search?
1551 void Cmd_ExecuteString (const char *text, cmd_source_t src)
1555 cmd_function_t *cmd;
1558 oldpos = cmd_tokenizebufferpos;
1562 Cmd_TokenizeString (text);
1564 // execute the command line
1567 cmd_tokenizebufferpos = oldpos;
1568 return; // no tokens
1572 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1574 if (!strcasecmp (cmd_argv[0],cmd->name))
1576 if (cmd->csqcfunc && CL_VM_ConsoleCommand (text)) //[515]: csqc
1581 if (cmd->consolefunction)
1582 cmd->consolefunction ();
1583 else if (cmd->clientfunction)
1585 if (cls.state == ca_connected)
1587 // forward remote commands to the server for execution
1588 Cmd_ForwardToServer();
1591 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1594 Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1599 if (cmd->clientfunction)
1601 cmd->clientfunction ();
1602 cmd_tokenizebufferpos = oldpos;
1612 // if it's a client command and no command was found, say so.
1613 if (cmd_source == src_client)
1615 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1616 cmd_tokenizebufferpos = oldpos;
1621 for (a=cmd_alias ; a ; a=a->next)
1623 if (!strcasecmp (cmd_argv[0], a->name))
1625 Cmd_ExecuteAlias(a);
1626 cmd_tokenizebufferpos = oldpos;
1631 if(found) // if the command was hooked and found, all is good
1633 cmd_tokenizebufferpos = oldpos;
1638 if (!Cvar_Command () && host_framecount > 0)
1639 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1641 cmd_tokenizebufferpos = oldpos;
1647 Cmd_ForwardStringToServer
1649 Sends an entire command string over to the server, unprocessed
1652 void Cmd_ForwardStringToServer (const char *s)
1655 if (cls.state != ca_connected)
1657 Con_Printf("Can't \"%s\", not connected\n", s);
1664 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1665 // attention, it has been eradicated from here, its only (former) use in
1666 // all of darkplaces.
1667 if (cls.protocol == PROTOCOL_QUAKEWORLD)
1668 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1670 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1671 if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
1673 // say/say_team commands can replace % character codes with status info
1676 if (*s == '%' && s[1])
1678 // handle proquake message macros
1682 case 'l': // current location
1683 CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
1685 case 'h': // current health
1686 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
1688 case 'a': // current armor
1689 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
1691 case 'x': // current rockets
1692 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
1694 case 'c': // current cells
1695 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
1697 // silly proquake macros
1698 case 'd': // loc at last death
1699 CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
1701 case 't': // current time
1702 dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
1704 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
1705 if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
1706 dpsnprintf(temp, sizeof(temp), "I need RL");
1707 else if (!cl.stats[STAT_ROCKETS])
1708 dpsnprintf(temp, sizeof(temp), "I need rockets");
1710 dpsnprintf(temp, sizeof(temp), "I have RL");
1712 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
1713 if (cl.stats[STAT_ITEMS] & IT_QUAD)
1716 strlcat(temp, " ", sizeof(temp));
1717 strlcat(temp, "quad", sizeof(temp));
1719 if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
1722 strlcat(temp, " ", sizeof(temp));
1723 strlcat(temp, "pent", sizeof(temp));
1725 if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
1728 strlcat(temp, " ", sizeof(temp));
1729 strlcat(temp, "eyes", sizeof(temp));
1732 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
1733 if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
1734 strlcat(temp, "SSG", sizeof(temp));
1735 strlcat(temp, ":", sizeof(temp));
1736 if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
1737 strlcat(temp, "NG", sizeof(temp));
1738 strlcat(temp, ":", sizeof(temp));
1739 if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
1740 strlcat(temp, "SNG", sizeof(temp));
1741 strlcat(temp, ":", sizeof(temp));
1742 if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
1743 strlcat(temp, "GL", sizeof(temp));
1744 strlcat(temp, ":", sizeof(temp));
1745 if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
1746 strlcat(temp, "RL", sizeof(temp));
1747 strlcat(temp, ":", sizeof(temp));
1748 if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
1749 strlcat(temp, "LG", sizeof(temp));
1752 // not a recognized macro, print it as-is...
1758 // write the resulting text
1759 SZ_Write(&cls.netcon->message, (unsigned char *)temp, strlen(temp));
1763 MSG_WriteByte(&cls.netcon->message, *s);
1766 MSG_WriteByte(&cls.netcon->message, 0);
1768 else // any other command is passed on as-is
1769 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1776 Sends the entire command line over to the server
1779 void Cmd_ForwardToServer (void)
1782 if (!strcasecmp(Cmd_Argv(0), "cmd"))
1784 // we want to strip off "cmd", so just send the args
1785 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1789 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1790 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1792 // don't send an empty forward message if the user tries "cmd" by itself
1795 Cmd_ForwardStringToServer(s);
1803 Returns the position (1 to argc-1) in the command's argument list
1804 where the given parameter apears, or 0 if not present
1808 int Cmd_CheckParm (const char *parm)
1814 Con_Printf ("Cmd_CheckParm: NULL");
1818 for (i = 1; i < Cmd_Argc (); i++)
1819 if (!strcasecmp (parm, Cmd_Argv (i)))