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 typedef struct cmdalias_s
26 struct cmdalias_s *next;
27 char name[MAX_ALIAS_NAME];
31 static cmdalias_t *cmd_alias;
33 static qboolean cmd_wait;
35 static mempool_t *cmd_mempool;
37 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
38 static int cmd_tokenizebufferpos = 0;
40 //=============================================================================
46 Causes execution of the remainder of the command buffer to be delayed until
47 next frame. This allows commands like:
48 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
51 static void Cmd_Wait_f (void)
56 typedef struct cmddeferred_s
58 struct cmddeferred_s *next;
63 static cmddeferred_t *cmd_deferred_list = NULL;
69 Cause a command to be executed after a delay.
72 static void Cmd_Defer_f (void)
76 double time = Sys_DoubleTime();
77 cmddeferred_t *next = cmd_deferred_list;
79 Con_Printf("No commands are pending.\n");
82 Con_Printf("-> In %9.2f: %s\n", next->time-time, next->value);
85 } else if(Cmd_Argc() == 2 && !strcasecmp("clear", Cmd_Argv(1)))
87 while(cmd_deferred_list)
89 cmddeferred_t *cmd = cmd_deferred_list;
90 cmd_deferred_list = cmd->next;
94 } else if(Cmd_Argc() == 3)
96 const char *value = Cmd_Argv(2);
97 cmddeferred_t *defcmd = (cmddeferred_t*)Mem_Alloc(tempmempool, sizeof(*defcmd));
98 size_t len = strlen(value);
100 defcmd->time = Sys_DoubleTime() + atof(Cmd_Argv(1));
101 defcmd->value = (char*)Mem_Alloc(tempmempool, len+1);
102 memcpy(defcmd->value, value, len+1);
105 if(cmd_deferred_list)
107 cmddeferred_t *next = cmd_deferred_list;
112 cmd_deferred_list = defcmd;
113 /* Stupid me... this changes the order... so commands with the same delay go blub :S
114 defcmd->next = cmd_deferred_list;
115 cmd_deferred_list = defcmd;*/
117 Con_Printf("usage: defer <seconds> <command>\n"
127 Print something to the center of the screen using SCR_Centerprint
130 static void Cmd_Centerprint_f (void)
132 char msg[MAX_INPUTLINE];
133 unsigned int i, c, p;
137 strlcpy(msg, Cmd_Argv(1), sizeof(msg));
138 for(i = 2; i < c; ++i)
140 strlcat(msg, " ", sizeof(msg));
141 strlcat(msg, Cmd_Argv(i), sizeof(msg));
144 for(p = 0, i = 0; i < c; ++i)
150 else if(msg[i+1] == '\\')
162 SCR_CenterPrint(msg);
167 =============================================================================
171 =============================================================================
174 static sizebuf_t cmd_text;
175 static unsigned char cmd_text_buf[CMDBUFSIZE];
181 Adds command text at the end of the buffer
184 void Cbuf_AddText (const char *text)
188 l = (int)strlen (text);
190 if (cmd_text.cursize + l >= cmd_text.maxsize)
192 Con_Print("Cbuf_AddText: overflow\n");
196 SZ_Write (&cmd_text, (const unsigned char *)text, (int)strlen (text));
204 Adds command text immediately after the current command
205 Adds a \n to the text
206 FIXME: actually change the command buffer to do less copying
209 void Cbuf_InsertText (const char *text)
214 // copy off any commands still remaining in the exec buffer
215 templen = cmd_text.cursize;
218 temp = (char *)Mem_Alloc (tempmempool, templen);
219 memcpy (temp, cmd_text.data, templen);
220 SZ_Clear (&cmd_text);
225 // add the entire text of the file
228 // add the copied off data
231 SZ_Write (&cmd_text, (const unsigned char *)temp, templen);
238 Cbuf_Execute_Deferred --blub
241 void Cbuf_Execute_Deferred (void)
243 cmddeferred_t *cmd, *prev;
244 double time = Sys_DoubleTime();
246 cmd = cmd_deferred_list;
249 if(cmd->time <= time)
251 Cbuf_AddText(cmd->value);
253 Mem_Free(cmd->value);
256 prev->next = cmd->next;
260 cmd_deferred_list = cmd->next;
262 cmd = cmd_deferred_list;
276 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
277 void Cbuf_Execute (void)
281 char line[MAX_INPUTLINE];
282 char preprocessed[MAX_INPUTLINE];
284 qboolean quotes, comment;
286 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
287 cmd_tokenizebufferpos = 0;
289 Cbuf_Execute_Deferred();
290 while (cmd_text.cursize)
292 // find a \n or ; line break
293 text = (char *)cmd_text.data;
297 for (i=0 ; i < cmd_text.cursize ; i++)
306 // make sure i doesn't get > cursize which causes a negative
307 // size in memmove, which is fatal --blub
308 if (i < (cmd_text.cursize-1) && (text[i] == '\\' && (text[i+1] == '"' || text[i+1] == '\\')))
313 if(text[i] == '/' && text[i + 1] == '/' && (i == 0 || ISWHITESPACE(text[i-1])))
316 break; // don't break if inside a quoted string or comment
320 if (text[i] == '\r' || text[i] == '\n')
324 // better than CRASHING on overlong input lines that may SOMEHOW enter the buffer
325 if(i >= MAX_INPUTLINE)
327 Con_Printf("Warning: console input buffer had an overlong line. Ignored.\n");
332 memcpy (line, text, i);
336 // delete the text from the command buffer and move remaining commands down
337 // this is necessary because commands (exec, alias) can insert data at the
338 // beginning of the text buffer
340 if (i == cmd_text.cursize)
341 cmd_text.cursize = 0;
345 cmd_text.cursize -= i;
346 memmove (cmd_text.data, text+i, cmd_text.cursize);
349 // execute the command line
350 firstchar = line + strspn(line, " \t");
352 (strncmp(firstchar, "alias", 5) || (firstchar[5] != ' ' && firstchar[5] != '\t'))
354 (strncmp(firstchar, "bind", 4) || (firstchar[4] != ' ' && firstchar[4] != '\t'))
356 (strncmp(firstchar, "in_bind", 7) || (firstchar[7] != ' ' && firstchar[7] != '\t'))
359 Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
360 Cmd_ExecuteString (preprocessed, src_command);
364 Cmd_ExecuteString (line, src_command);
368 { // skip out while text still remains in buffer, leaving it
377 ==============================================================================
381 ==============================================================================
388 Adds command line parameters as script statements
389 Commands lead with a +, and continue until a - or another +
390 quake +prog jctest.qp +cmd amlev1
391 quake -nosound +cmd amlev1
394 qboolean host_stuffcmdsrun = false;
395 void Cmd_StuffCmds_f (void)
398 // this is for all commandline options combined (and is bounds checked)
399 char build[MAX_INPUTLINE];
401 if (Cmd_Argc () != 1)
403 Con_Print("stuffcmds : execute command line parameters\n");
407 // no reason to run the commandline arguments twice
408 if (host_stuffcmdsrun)
411 host_stuffcmdsrun = true;
414 for (i = 0;i < com_argc;i++)
416 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)
419 while (com_argv[i][j])
420 build[l++] = com_argv[i][j++];
422 for (;i < com_argc;i++)
426 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
428 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
431 if (strchr(com_argv[i], ' '))
433 for (j = 0;com_argv[i][j];j++)
434 build[l++] = com_argv[i][j];
435 if (strchr(com_argv[i], ' '))
442 // now terminate the combined string and prepend it to the command buffer
443 // we already reserved space for the terminator
445 Cbuf_InsertText (build);
454 static void Cmd_Exec_f (void)
457 const char *filename;
459 if (Cmd_Argc () != 2)
461 Con_Print("exec <filename> : execute a script file\n");
465 filename = Cmd_Argv(1);
466 if (!strcmp(filename, "config.cfg"))
468 filename = CONFIGFILENAME;
469 if (COM_CheckParm("-noconfig"))
470 return; // don't execute config.cfg
473 f = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
476 Con_Printf("couldn't exec %s\n",filename);
479 Con_Printf("execing %s\n",filename);
481 // if executing default.cfg for the first time, lock the cvar defaults
482 // it may seem backwards to insert this text BEFORE the default.cfg
483 // but Cbuf_InsertText inserts before, so this actually ends up after it.
484 if (strlen(filename) >= 11 && !strcmp(filename + strlen(filename) - 11, "default.cfg"))
485 Cbuf_InsertText("\ncvar_lockdefaults\n");
487 // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
488 // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
489 Cbuf_InsertText ("\n");
499 Just prints the rest of the line to the console
502 static void Cmd_Echo_f (void)
506 for (i=1 ; i<Cmd_Argc() ; i++)
507 Con_Printf("%s ",Cmd_Argv(i));
512 // Support Doom3-style Toggle Console Command
517 Toggles a specified console variable amongst the values specified (default is 0 and 1)
520 static void Cmd_Toggle_f(void)
522 // Acquire Number of Arguments
523 int nNumArgs = Cmd_Argc();
526 // No Arguments Specified; Print Usage
527 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");
529 { // Correct Arguments Specified
530 // Acquire Potential CVar
531 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
538 Cvar_SetValueQuick(cvCVar, 0);
540 Cvar_SetValueQuick(cvCVar, 1);
544 { // 0 and Specified Usage
545 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
546 // CVar is Specified Value; // Reset to 0
547 Cvar_SetValueQuick(cvCVar, 0);
549 if(cvCVar->integer == 0)
550 // CVar is 0; Specify Value
551 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
553 // CVar does not match; Reset to 0
554 Cvar_SetValueQuick(cvCVar, 0);
557 { // Variable Values Specified
561 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
562 { // Cycle through Values
563 if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
564 { // Current Value Located; Increment to Next
565 if( (nCnt + 1) == nNumArgs)
566 // Max Value Reached; Reset
567 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
570 Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
579 // Value not Found; Reset to Original
580 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
586 Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(1) );
595 Creates a new command that executes a command string (possibly ; seperated)
598 static void Cmd_Alias_f (void)
601 char cmd[MAX_INPUTLINE];
608 Con_Print("Current alias commands:\n");
609 for (a = cmd_alias ; a ; a=a->next)
610 Con_Printf("%s : %s", a->name, a->value);
615 if (strlen(s) >= MAX_ALIAS_NAME)
617 Con_Print("Alias name is too long\n");
621 // if the alias already exists, reuse it
622 for (a = cmd_alias ; a ; a=a->next)
624 if (!strcmp(s, a->name))
633 cmdalias_t *prev, *current;
635 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
636 strlcpy (a->name, s, sizeof (a->name));
637 // insert it at the right alphanumeric position
638 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
649 // copy the rest of the command line
650 cmd[0] = 0; // start out with a null string
652 for (i=2 ; i< c ; i++)
654 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
656 strlcat (cmd, " ", sizeof (cmd));
658 strlcat (cmd, "\n", sizeof (cmd));
660 alloclen = strlen (cmd) + 1;
662 cmd[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
663 a->value = (char *)Z_Malloc (alloclen);
664 memcpy (a->value, cmd, alloclen);
671 Remove existing aliases.
674 static void Cmd_UnAlias_f (void)
682 Con_Print("unalias: Usage: unalias alias1 [alias2 ...]\n");
686 for(i = 1; i < Cmd_Argc(); ++i)
690 for(a = cmd_alias; a; p = a, a = a->next)
692 if(!strcmp(s, a->name))
704 Con_Printf("unalias: %s alias not found\n", s);
709 =============================================================================
713 =============================================================================
716 typedef struct cmd_function_s
718 struct cmd_function_s *next;
720 const char *description;
721 xcommand_t consolefunction;
722 xcommand_t clientfunction;
727 static const char *cmd_argv[MAX_ARGS];
728 static const char *cmd_null_string = "";
729 static const char *cmd_args;
730 cmd_source_t cmd_source;
733 static cmd_function_t *cmd_functions; // possible commands to execute
735 static const char *Cmd_GetDirectCvarValue(const char *varname, cmdalias_t *alias, qboolean *is_multiple)
742 *is_multiple = false;
744 if(!varname || !*varname)
749 if(!strcmp(varname, "*"))
755 else if(!strcmp(varname, "#"))
757 return va("%d", Cmd_Argc());
759 else if(varname[strlen(varname) - 1] == '-')
761 argno = strtol(varname, &endptr, 10);
762 if(endptr == varname + strlen(varname) - 1)
764 // whole string is a number, apart from the -
765 const char *p = Cmd_Args();
766 for(; argno > 1; --argno)
767 if(!COM_ParseToken_Console(&p))
774 // kill pre-argument whitespace
775 for (;*p && ISWHITESPACE(*p);p++)
784 argno = strtol(varname, &endptr, 10);
787 // whole string is a number
788 // NOTE: we already made sure we don't have an empty cvar name!
789 if(argno >= 0 && argno < Cmd_Argc())
790 return Cmd_Argv(argno);
795 if((cvar = Cvar_FindVar(varname)) && !(cvar->flags & CVAR_PRIVATE))
801 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset)
803 qboolean quote_quot = !!strchr(quoteset, '"');
804 qboolean quote_backslash = !!strchr(quoteset, '\\');
805 qboolean quote_dollar = !!strchr(quoteset, '$');
809 if(*in == '"' && quote_quot)
816 *out++ = '\\'; --outlen;
817 *out++ = '"'; --outlen;
819 else if(*in == '\\' && quote_backslash)
826 *out++ = '\\'; --outlen;
827 *out++ = '\\'; --outlen;
829 else if(*in == '$' && quote_dollar)
836 *out++ = '$'; --outlen;
837 *out++ = '$'; --outlen;
846 *out++ = *in; --outlen;
854 static const char *Cmd_GetCvarValue(const char *var, size_t varlen, cmdalias_t *alias)
856 static char varname[MAX_INPUTLINE];
857 static char varval[MAX_INPUTLINE];
861 if(varlen >= MAX_INPUTLINE)
862 varlen = MAX_INPUTLINE - 1;
863 memcpy(varname, var, varlen);
865 varfunc = strchr(varname, ' ');
881 if(varname[0] == '$')
882 varstr = Cmd_GetDirectCvarValue(Cmd_GetDirectCvarValue(varname + 1, alias, NULL), alias, NULL);
885 qboolean is_multiple = false;
886 // Exception: $* and $n- don't use the quoted form by default
887 varstr = Cmd_GetDirectCvarValue(varname, alias, &is_multiple);
896 Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
898 Con_Printf("Warning: Could not expand $%s\n", varname);
902 if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
904 // quote it so it can be used inside double quotes
905 // we just need to replace " by \", and of course, double backslashes
906 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\");
909 else if(!strcmp(varfunc, "asis"))
914 Con_Printf("Unknown variable function %s\n", varfunc);
922 Preprocesses strings and replaces $*, $param#, $cvar accordingly. Also strips comments.
924 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
930 // don't crash if there's no room in the outtext buffer
931 if( maxoutlen == 0 ) {
934 maxoutlen--; // because of \0
939 while( *in && outlen < maxoutlen ) {
941 // this is some kind of expansion, see what comes after the $
944 // The console does the following preprocessing:
946 // - $$ is transformed to a single dollar sign.
947 // - $var or ${var} are expanded to the contents of the named cvar,
948 // with quotation marks and backslashes quoted so it can safely
949 // be used inside quotation marks (and it should always be used
951 // - ${var asis} inserts the cvar value as is, without doing this
953 // - prefix the cvar name with a dollar sign to do indirection;
954 // for example, if $x has the value timelimit, ${$x} will return
955 // the value of $timelimit
956 // - when expanding an alias, the special variable name $* refers
957 // to all alias parameters, and a number refers to that numbered
958 // alias parameter, where the name of the alias is $0, the first
959 // parameter is $1 and so on; as a special case, $* inserts all
960 // parameters, without extra quoting, so one can use $* to just
961 // pass all parameters around. All parameters starting from $n
962 // can be referred to as $n- (so $* is equivalent to $1-).
964 // Note: when expanding an alias, cvar expansion is done in the SAME step
965 // as alias expansion so that alias parameters or cvar values containing
966 // dollar signs have no unwanted bad side effects. However, this needs to
967 // be accounted for when writing complex aliases. For example,
968 // alias foo "set x NEW; echo $x"
969 // actually expands to
970 // "set x NEW; echo OLD"
971 // and will print OLD! To work around this, use a second alias:
972 // alias foo "set x NEW; foo2"
973 // alias foo2 "echo $x"
975 // Also note: lines starting with alias are exempt from cvar expansion.
976 // If you want cvar expansion, write "alias" instead:
979 // alias foo "echo $x"
980 // "alias" bar "echo $x"
983 // foo will print 2, because the variable $x will be expanded when the alias
984 // gets expanded. bar will print 1, because the variable $x was expanded
985 // at definition time. foo can be equivalently defined as
987 // "alias" foo "echo $$x"
989 // because at definition time, $$ will get replaced to a single $.
994 } else if(*in == '{') {
995 varlen = strcspn(in + 1, "}");
996 if(in[varlen + 1] == '}')
998 val = Cmd_GetCvarValue(in + 1, varlen, alias);
1008 varlen = strspn(in, "#*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
1009 val = Cmd_GetCvarValue(in, varlen, alias);
1014 // insert the cvar value
1015 while(*val && outlen < maxoutlen)
1016 outtext[outlen++] = *val++;
1021 // copy the unexpanded text
1022 outtext[outlen++] = '$';
1023 while(eat && outlen < maxoutlen)
1025 outtext[outlen++] = *in++;
1031 outtext[outlen++] = *in++;
1033 outtext[outlen] = 0;
1040 Called for aliases and fills in the alias into the cbuffer
1043 static void Cmd_ExecuteAlias (cmdalias_t *alias)
1045 static char buffer[ MAX_INPUTLINE ];
1046 static char buffer2[ MAX_INPUTLINE ];
1047 Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
1048 // insert at start of command buffer, so that aliases execute in order
1049 // (fixes bug introduced by Black on 20050705)
1051 // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1052 // have to make sure that no second variable expansion takes place, otherwise
1053 // alias parameters containing dollar signs can have bad effects.
1054 Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$");
1055 Cbuf_InsertText( buffer2 );
1062 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1063 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1067 static void Cmd_List_f (void)
1069 cmd_function_t *cmd;
1070 const char *partial;
1077 partial = Cmd_Argv (1);
1078 len = strlen(partial);
1086 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1089 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1091 if (partial && (ispattern ? !matchpattern_with_separator(cmd->name, partial, false, "", false) : strncmp(partial, cmd->name, len)))
1093 Con_Printf("%s : %s\n", cmd->name, cmd->description);
1100 Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1102 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1105 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1108 static void Cmd_Apropos_f(void)
1110 cmd_function_t *cmd;
1113 const char *partial;
1118 partial = Cmd_Args();
1121 Con_Printf("usage: apropos <string>\n");
1125 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1127 partial = va("*%s*", partial);
1130 for (cvar = cvar_vars; cvar; cvar = cvar->next)
1132 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1133 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1135 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1138 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1140 if (!matchpattern_with_separator(cmd->name, partial, true, "", false))
1141 if (!matchpattern_with_separator(cmd->description, partial, true, "", false))
1143 Con_Printf("command ^2%s^7: %s\n", cmd->name, cmd->description);
1146 for (alias = cmd_alias; alias; alias = alias->next)
1148 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1149 if (!matchpattern_with_separator(alias->value, partial, true, "", false))
1151 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value);
1154 Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1162 void Cmd_Init (void)
1164 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
1165 // space for commands and script files
1166 cmd_text.data = cmd_text_buf;
1167 cmd_text.maxsize = sizeof(cmd_text_buf);
1168 cmd_text.cursize = 0;
1171 void Cmd_Init_Commands (void)
1174 // register our commands
1176 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1177 Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
1178 Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1179 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");
1180 Cmd_AddCommand ("unalias",Cmd_UnAlias_f, "remove an alias");
1181 Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
1182 Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1183 Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
1184 Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1185 Cmd_AddCommand ("unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1186 #ifdef FILLALLCVARSWITHRUBBISH
1187 Cmd_AddCommand ("fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1188 #endif /* FILLALLCVARSWITHRUBBISH */
1190 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1191 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1192 Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1193 Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1194 Cmd_AddCommand ("apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1196 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");
1197 Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1198 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)");
1199 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)");
1201 Cmd_AddCommand ("cprint", Cmd_Centerprint_f, "print something at the screen center");
1202 Cmd_AddCommand ("defer", Cmd_Defer_f, "execute a command in the future");
1205 // Support Doom3-style Toggle Command
1206 Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1214 void Cmd_Shutdown(void)
1216 Mem_FreePool(&cmd_mempool);
1234 const char *Cmd_Argv (int arg)
1236 if (arg >= cmd_argc )
1237 return cmd_null_string;
1238 return cmd_argv[arg];
1246 const char *Cmd_Args (void)
1256 Parses the given string into command line tokens.
1259 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1260 static void Cmd_TokenizeString (const char *text)
1269 // skip whitespace up to a /n
1270 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1277 if (*text == '\n' || *text == '\r')
1279 // a newline separates commands in the buffer
1280 if (*text == '\r' && text[1] == '\n')
1292 if (!COM_ParseToken_Console(&text))
1295 if (cmd_argc < MAX_ARGS)
1297 l = (int)strlen(com_token) + 1;
1298 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1300 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1303 memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
1304 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
1305 cmd_tokenizebufferpos += l;
1317 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
1319 cmd_function_t *cmd;
1320 cmd_function_t *prev, *current;
1322 // fail if the command is a variable name
1323 if (Cvar_FindVar( cmd_name ))
1325 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1329 // fail if the command already exists
1330 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1332 if (!strcmp (cmd_name, cmd->name))
1334 if (consolefunction || clientfunction)
1336 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1341 cmd->csqcfunc = true;
1347 cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
1348 cmd->name = cmd_name;
1349 cmd->consolefunction = consolefunction;
1350 cmd->clientfunction = clientfunction;
1351 cmd->description = description;
1352 if(!consolefunction && !clientfunction) //[515]: csqc
1353 cmd->csqcfunc = true;
1354 cmd->next = cmd_functions;
1356 // insert it at the right alphanumeric position
1357 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
1362 cmd_functions = cmd;
1364 cmd->next = current;
1367 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
1369 Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
1377 qboolean Cmd_Exists (const char *cmd_name)
1379 cmd_function_t *cmd;
1381 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1382 if (!strcmp (cmd_name,cmd->name))
1394 const char *Cmd_CompleteCommand (const char *partial)
1396 cmd_function_t *cmd;
1399 len = strlen(partial);
1405 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1406 if (!strncasecmp(partial, cmd->name, len))
1413 Cmd_CompleteCountPossible
1415 New function for tab-completion system
1416 Added by EvilTypeGuy
1417 Thanks to Fett erich@heintz.com
1421 int Cmd_CompleteCountPossible (const char *partial)
1423 cmd_function_t *cmd;
1428 len = strlen(partial);
1433 // Loop through the command list and count all partial matches
1434 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1435 if (!strncasecmp(partial, cmd->name, len))
1442 Cmd_CompleteBuildList
1444 New function for tab-completion system
1445 Added by EvilTypeGuy
1446 Thanks to Fett erich@heintz.com
1450 const char **Cmd_CompleteBuildList (const char *partial)
1452 cmd_function_t *cmd;
1455 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
1458 len = strlen(partial);
1459 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1460 // Loop through the alias list and print all matches
1461 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1462 if (!strncasecmp(partial, cmd->name, len))
1463 buf[bpos++] = cmd->name;
1469 // written by LordHavoc
1470 void Cmd_CompleteCommandPrint (const char *partial)
1472 cmd_function_t *cmd;
1473 size_t len = strlen(partial);
1474 // Loop through the command list and print all matches
1475 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1476 if (!strncasecmp(partial, cmd->name, len))
1477 Con_Printf("^2%s^7: %s\n", cmd->name, cmd->description);
1483 New function for tab-completion system
1484 Added by EvilTypeGuy
1485 Thanks to Fett erich@heintz.com
1489 const char *Cmd_CompleteAlias (const char *partial)
1494 len = strlen(partial);
1500 for (alias = cmd_alias; alias; alias = alias->next)
1501 if (!strncasecmp(partial, alias->name, len))
1507 // written by LordHavoc
1508 void Cmd_CompleteAliasPrint (const char *partial)
1511 size_t len = strlen(partial);
1512 // Loop through the alias list and print all matches
1513 for (alias = cmd_alias; alias; alias = alias->next)
1514 if (!strncasecmp(partial, alias->name, len))
1515 Con_Printf("^5%s^7: %s", alias->name, alias->value);
1520 Cmd_CompleteAliasCountPossible
1522 New function for tab-completion system
1523 Added by EvilTypeGuy
1524 Thanks to Fett erich@heintz.com
1528 int Cmd_CompleteAliasCountPossible (const char *partial)
1536 len = strlen(partial);
1541 // Loop through the command list and count all partial matches
1542 for (alias = cmd_alias; alias; alias = alias->next)
1543 if (!strncasecmp(partial, alias->name, len))
1550 Cmd_CompleteAliasBuildList
1552 New function for tab-completion system
1553 Added by EvilTypeGuy
1554 Thanks to Fett erich@heintz.com
1558 const char **Cmd_CompleteAliasBuildList (const char *partial)
1563 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1566 len = strlen(partial);
1567 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1568 // Loop through the alias list and print all matches
1569 for (alias = cmd_alias; alias; alias = alias->next)
1570 if (!strncasecmp(partial, alias->name, len))
1571 buf[bpos++] = alias->name;
1577 void Cmd_ClearCsqcFuncs (void)
1579 cmd_function_t *cmd;
1580 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1581 cmd->csqcfunc = false;
1584 qboolean CL_VM_ConsoleCommand (const char *cmd);
1589 A complete command line has been parsed, so try to execute it
1590 FIXME: lookupnoadd the token to speed search?
1593 void Cmd_ExecuteString (const char *text, cmd_source_t src)
1597 cmd_function_t *cmd;
1600 oldpos = cmd_tokenizebufferpos;
1604 Cmd_TokenizeString (text);
1606 // execute the command line
1609 cmd_tokenizebufferpos = oldpos;
1610 return; // no tokens
1614 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1616 if (!strcasecmp (cmd_argv[0],cmd->name))
1618 if (cmd->csqcfunc && CL_VM_ConsoleCommand (text)) //[515]: csqc
1623 if (cmd->consolefunction)
1624 cmd->consolefunction ();
1625 else if (cmd->clientfunction)
1627 if (cls.state == ca_connected)
1629 // forward remote commands to the server for execution
1630 Cmd_ForwardToServer();
1633 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1636 Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1640 if (cmd->clientfunction)
1642 cmd->clientfunction ();
1643 cmd_tokenizebufferpos = oldpos;
1653 // if it's a client command and no command was found, say so.
1654 if (cmd_source == src_client)
1656 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1657 cmd_tokenizebufferpos = oldpos;
1662 for (a=cmd_alias ; a ; a=a->next)
1664 if (!strcasecmp (cmd_argv[0], a->name))
1666 Cmd_ExecuteAlias(a);
1667 cmd_tokenizebufferpos = oldpos;
1672 if(found) // if the command was hooked and found, all is good
1674 cmd_tokenizebufferpos = oldpos;
1679 if (!Cvar_Command () && host_framecount > 0)
1680 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1682 cmd_tokenizebufferpos = oldpos;
1688 Cmd_ForwardStringToServer
1690 Sends an entire command string over to the server, unprocessed
1693 void Cmd_ForwardStringToServer (const char *s)
1696 if (cls.state != ca_connected)
1698 Con_Printf("Can't \"%s\", not connected\n", s);
1705 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1706 // attention, it has been eradicated from here, its only (former) use in
1707 // all of darkplaces.
1708 if (cls.protocol == PROTOCOL_QUAKEWORLD)
1709 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1711 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1712 if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
1714 // say/say_team commands can replace % character codes with status info
1717 if (*s == '%' && s[1])
1719 // handle proquake message macros
1723 case 'l': // current location
1724 CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
1726 case 'h': // current health
1727 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
1729 case 'a': // current armor
1730 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
1732 case 'x': // current rockets
1733 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
1735 case 'c': // current cells
1736 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
1738 // silly proquake macros
1739 case 'd': // loc at last death
1740 CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
1742 case 't': // current time
1743 dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
1745 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
1746 if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
1747 dpsnprintf(temp, sizeof(temp), "I need RL");
1748 else if (!cl.stats[STAT_ROCKETS])
1749 dpsnprintf(temp, sizeof(temp), "I need rockets");
1751 dpsnprintf(temp, sizeof(temp), "I have RL");
1753 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
1754 if (cl.stats[STAT_ITEMS] & IT_QUAD)
1757 strlcat(temp, " ", sizeof(temp));
1758 strlcat(temp, "quad", sizeof(temp));
1760 if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
1763 strlcat(temp, " ", sizeof(temp));
1764 strlcat(temp, "pent", sizeof(temp));
1766 if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
1769 strlcat(temp, " ", sizeof(temp));
1770 strlcat(temp, "eyes", sizeof(temp));
1773 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
1774 if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
1775 strlcat(temp, "SSG", sizeof(temp));
1776 strlcat(temp, ":", sizeof(temp));
1777 if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
1778 strlcat(temp, "NG", sizeof(temp));
1779 strlcat(temp, ":", sizeof(temp));
1780 if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
1781 strlcat(temp, "SNG", sizeof(temp));
1782 strlcat(temp, ":", sizeof(temp));
1783 if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
1784 strlcat(temp, "GL", sizeof(temp));
1785 strlcat(temp, ":", sizeof(temp));
1786 if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
1787 strlcat(temp, "RL", sizeof(temp));
1788 strlcat(temp, ":", sizeof(temp));
1789 if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
1790 strlcat(temp, "LG", sizeof(temp));
1793 // not a recognized macro, print it as-is...
1799 // write the resulting text
1800 SZ_Write(&cls.netcon->message, (unsigned char *)temp, strlen(temp));
1804 MSG_WriteByte(&cls.netcon->message, *s);
1807 MSG_WriteByte(&cls.netcon->message, 0);
1809 else // any other command is passed on as-is
1810 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1817 Sends the entire command line over to the server
1820 void Cmd_ForwardToServer (void)
1823 if (!strcasecmp(Cmd_Argv(0), "cmd"))
1825 // we want to strip off "cmd", so just send the args
1826 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1830 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1831 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1833 // don't send an empty forward message if the user tries "cmd" by itself
1836 Cmd_ForwardStringToServer(s);
1844 Returns the position (1 to argc-1) in the command's argument list
1845 where the given parameter apears, or 0 if not present
1849 int Cmd_CheckParm (const char *parm)
1855 Con_Printf ("Cmd_CheckParm: NULL");
1859 for (i = 1; i < Cmd_Argc (); i++)
1860 if (!strcasecmp (parm, Cmd_Argv (i)))