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
25 typedef struct cmdalias_s
27 struct cmdalias_s *next;
28 char name[MAX_ALIAS_NAME];
30 qboolean initstate; // indicates this command existed at init
31 char *initialvalue; // backup copy of value at init
34 static cmdalias_t *cmd_alias;
36 static qboolean cmd_wait;
38 static mempool_t *cmd_mempool;
40 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
41 static int cmd_tokenizebufferpos = 0;
43 //=============================================================================
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"
54 static void Cmd_Wait_f (void)
59 typedef struct cmddeferred_s
61 struct cmddeferred_s *next;
66 static cmddeferred_t *cmd_deferred_list = NULL;
72 Cause a command to be executed after a delay.
75 static void Cmd_Defer_f (void)
79 cmddeferred_t *next = cmd_deferred_list;
81 Con_Printf("No commands are pending.\n");
84 Con_Printf("-> In %9.2f: %s\n", next->delay, next->value);
87 } else if(Cmd_Argc() == 2 && !strcasecmp("clear", Cmd_Argv(1)))
89 while(cmd_deferred_list)
91 cmddeferred_t *cmd = cmd_deferred_list;
92 cmd_deferred_list = cmd->next;
96 } else if(Cmd_Argc() == 3)
98 const char *value = Cmd_Argv(2);
99 cmddeferred_t *defcmd = (cmddeferred_t*)Mem_Alloc(tempmempool, sizeof(*defcmd));
100 size_t len = strlen(value);
102 defcmd->delay = atof(Cmd_Argv(1));
103 defcmd->value = (char*)Mem_Alloc(tempmempool, len+1);
104 memcpy(defcmd->value, value, len+1);
107 if(cmd_deferred_list)
109 cmddeferred_t *next = cmd_deferred_list;
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;*/
119 Con_Printf("usage: defer <seconds> <command>\n"
129 Print something to the center of the screen using SCR_Centerprint
132 static void Cmd_Centerprint_f (void)
134 char msg[MAX_INPUTLINE];
135 unsigned int i, c, p;
139 strlcpy(msg, Cmd_Argv(1), sizeof(msg));
140 for(i = 2; i < c; ++i)
142 strlcat(msg, " ", sizeof(msg));
143 strlcat(msg, Cmd_Argv(i), sizeof(msg));
146 for(p = 0, i = 0; i < c; ++i)
152 else if(msg[i+1] == '\\')
164 SCR_CenterPrint(msg);
169 =============================================================================
173 =============================================================================
176 static sizebuf_t cmd_text;
177 static unsigned char cmd_text_buf[CMDBUFSIZE];
178 void *cmd_text_mutex = NULL;
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)
187 Adds command text at the end of the buffer
190 void Cbuf_AddText (const char *text)
194 l = (int)strlen(text);
196 Cbuf_LockThreadMutex();
197 if (cmd_text.cursize + l >= cmd_text.maxsize)
198 Con_Print("Cbuf_AddText: overflow\n");
200 SZ_Write(&cmd_text, (const unsigned char *)text, l);
201 Cbuf_UnlockThreadMutex();
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
214 void Cbuf_InsertText (const char *text)
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");
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);
228 Cbuf_UnlockThreadMutex();
233 Cbuf_Execute_Deferred --blub
236 static void Cbuf_Execute_Deferred (void)
238 static double oldrealtime = 0;
239 cmddeferred_t *cmd, *prev;
241 if (realtime - oldrealtime < 0 || realtime - oldrealtime > 1800) oldrealtime = realtime;
242 eat = realtime - oldrealtime;
243 if (eat < (1.0 / 120.0))
245 oldrealtime = realtime;
247 cmd = cmd_deferred_list;
253 Cbuf_AddText(cmd->value);
255 Mem_Free(cmd->value);
258 prev->next = cmd->next;
262 cmd_deferred_list = cmd->next;
264 cmd = cmd_deferred_list;
278 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
279 void Cbuf_Execute (void)
283 char line[MAX_INPUTLINE];
284 char preprocessed[MAX_INPUTLINE];
289 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
290 cmd_tokenizebufferpos = 0;
292 Cbuf_Execute_Deferred();
293 while (cmd_text.cursize)
295 // find a \n or ; line break
296 text = (char *)cmd_text.data;
300 for (i=0 ; i < cmd_text.cursize ; i++)
309 // make sure i doesn't get > cursize which causes a negative
310 // size in memmove, which is fatal --blub
311 if (i < (cmd_text.cursize-1) && (text[i] == '\\' && (text[i+1] == '"' || text[i+1] == '\\')))
316 if(text[i] == '/' && text[i + 1] == '/' && (i == 0 || ISWHITESPACE(text[i-1])))
319 break; // don't break if inside a quoted string or comment
323 if (text[i] == '\r' || text[i] == '\n')
327 // better than CRASHING on overlong input lines that may SOMEHOW enter the buffer
328 if(i >= MAX_INPUTLINE)
330 Con_Printf("Warning: console input buffer had an overlong line. Ignored.\n");
335 memcpy (line, text, comment ? (comment - text) : i);
336 line[comment ? (comment - text) : i] = 0;
339 // delete the text from the command buffer and move remaining commands down
340 // this is necessary because commands (exec, alias) can insert data at the
341 // beginning of the text buffer
343 if (i == cmd_text.cursize)
344 cmd_text.cursize = 0;
348 cmd_text.cursize -= i;
349 memmove (cmd_text.data, text+i, cmd_text.cursize);
352 // execute the command line
354 while(*firstchar && ISWHITESPACE(*firstchar))
357 (strncmp(firstchar, "alias", 5) || !ISWHITESPACE(firstchar[5]))
359 (strncmp(firstchar, "bind", 4) || !ISWHITESPACE(firstchar[4]))
361 (strncmp(firstchar, "in_bind", 7) || !ISWHITESPACE(firstchar[7]))
364 Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
365 Cmd_ExecuteString (preprocessed, src_command, false);
369 Cmd_ExecuteString (line, src_command, false);
373 { // skip out while text still remains in buffer, leaving it
382 ==============================================================================
386 ==============================================================================
393 Adds command line parameters as script statements
394 Commands lead with a +, and continue until a - or another +
395 quake +prog jctest.qp +cmd amlev1
396 quake -nosound +cmd amlev1
399 qboolean host_stuffcmdsrun = false;
400 static void Cmd_StuffCmds_f (void)
403 // this is for all commandline options combined (and is bounds checked)
404 char build[MAX_INPUTLINE];
406 if (Cmd_Argc () != 1)
408 Con_Print("stuffcmds : execute command line parameters\n");
412 // no reason to run the commandline arguments twice
413 if (host_stuffcmdsrun)
416 host_stuffcmdsrun = true;
419 for (i = 0;i < com_argc;i++)
421 if (com_argv[i] && com_argv[i][0] == '+' && (com_argv[i][1] < '0' || com_argv[i][1] > '9') && l + strlen(com_argv[i]) - 1 <= sizeof(build) - 1)
424 while (com_argv[i][j])
425 build[l++] = com_argv[i][j++];
427 for (;i < com_argc;i++)
431 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
433 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
436 if (strchr(com_argv[i], ' '))
438 for (j = 0;com_argv[i][j];j++)
439 build[l++] = com_argv[i][j];
440 if (strchr(com_argv[i], ' '))
447 // now terminate the combined string and prepend it to the command buffer
448 // we already reserved space for the terminator
450 Cbuf_InsertText (build);
453 static void Cmd_Exec(const char *filename)
456 qboolean isdefaultcfg = strlen(filename) >= 11 && !strcmp(filename + strlen(filename) - 11, "default.cfg");
458 if (!strcmp(filename, "config.cfg"))
460 filename = CONFIGFILENAME;
461 if (COM_CheckParm("-noconfig"))
462 return; // don't execute config.cfg
465 f = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
468 Con_Printf("couldn't exec %s\n",filename);
471 Con_Printf("execing %s\n",filename);
473 // if executing default.cfg for the first time, lock the cvar defaults
474 // it may seem backwards to insert this text BEFORE the default.cfg
475 // but Cbuf_InsertText inserts before, so this actually ends up after it.
477 Cbuf_InsertText("\ncvar_lockdefaults\n");
479 // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
480 // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
481 Cbuf_InsertText ("\n");
487 // special defaults for specific games go here, these execute before default.cfg
488 // Nehahra pushable crates malfunction in some levels if this is on
489 // Nehahra NPC AI is confused by blowupfallenzombies
490 if (gamemode == GAME_NEHAHRA)
491 Cbuf_InsertText("\nsv_gameplayfix_upwardvelocityclearsongroundflag 0\nsv_gameplayfix_blowupfallenzombies 0\n\n");
492 // hipnotic mission pack has issues in their 'friendly monster' ai, which seem to attempt to attack themselves for some reason when findradius() returns non-solid entities.
493 // hipnotic mission pack has issues with bobbing water entities 'jittering' between different heights on alternate frames at the default 0.0138889 ticrate, 0.02 avoids this issue
494 // hipnotic mission pack has issues in their proximity mine sticking code, which causes them to bounce off.
495 if (gamemode == GAME_HIPNOTIC)
496 Cbuf_InsertText("\nsv_gameplayfix_blowupfallenzombies 0\nsys_ticrate 0.02\nsv_gameplayfix_slidemoveprojectiles 0\n\n");
497 // rogue mission pack has a guardian boss that does not wake up if findradius returns one of the entities around its spawn area
498 if (gamemode == GAME_ROGUE)
499 Cbuf_InsertText("\nsv_gameplayfix_findradiusdistancetobox 0\n\n");
500 if (gamemode == GAME_NEXUIZ)
501 Cbuf_InsertText("\nsv_gameplayfix_q2airaccelerate 1\nsv_gameplayfix_stepmultipletimes 1\n\n");
502 if (gamemode == GAME_TENEBRAE)
503 Cbuf_InsertText("\nr_shadow_gloss 2\nr_shadow_bumpscale_basetexture 4\n\n");
504 // Steel Storm: Burning Retribution csqc misinterprets CSQC_InputEvent if type is a value other than 0 or 1
505 if (gamemode == GAME_STEELSTORM)
506 Cbuf_InsertText("\ncl_csqc_generatemousemoveevents 0\n\n");
515 static void Cmd_Exec_f (void)
520 if (Cmd_Argc () != 2)
522 Con_Print("exec <filename> : execute a script file\n");
526 s = FS_Search(Cmd_Argv(1), true, true);
527 if(!s || !s->numfilenames)
529 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
533 for(i = 0; i < s->numfilenames; ++i)
534 Cmd_Exec(s->filenames[i]);
544 Just prints the rest of the line to the console
547 static void Cmd_Echo_f (void)
551 for (i=1 ; i<Cmd_Argc() ; i++)
552 Con_Printf("%s ",Cmd_Argv(i));
557 // Support Doom3-style Toggle Console Command
562 Toggles a specified console variable amongst the values specified (default is 0 and 1)
565 static void Cmd_Toggle_f(void)
567 // Acquire Number of Arguments
568 int nNumArgs = Cmd_Argc();
571 // No Arguments Specified; Print Usage
572 Con_Print("Toggle Console Variable - Usage\n toggle <variable> - toggles between 0 and 1\n toggle <variable> <value> - toggles between 0 and <value>\n toggle <variable> [string 1] [string 2]...[string n] - cycles through all strings\n");
574 { // Correct Arguments Specified
575 // Acquire Potential CVar
576 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
583 Cvar_SetValueQuick(cvCVar, 0);
585 Cvar_SetValueQuick(cvCVar, 1);
589 { // 0 and Specified Usage
590 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
591 // CVar is Specified Value; // Reset to 0
592 Cvar_SetValueQuick(cvCVar, 0);
594 if(cvCVar->integer == 0)
595 // CVar is 0; Specify Value
596 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
598 // CVar does not match; Reset to 0
599 Cvar_SetValueQuick(cvCVar, 0);
602 { // Variable Values Specified
606 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
607 { // Cycle through Values
608 if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
609 { // Current Value Located; Increment to Next
610 if( (nCnt + 1) == nNumArgs)
611 // Max Value Reached; Reset
612 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
615 Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
624 // Value not Found; Reset to Original
625 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
631 Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(1) );
640 Creates a new command that executes a command string (possibly ; seperated)
643 static void Cmd_Alias_f (void)
646 char cmd[MAX_INPUTLINE];
653 Con_Print("Current alias commands:\n");
654 for (a = cmd_alias ; a ; a=a->next)
655 Con_Printf("%s : %s", a->name, a->value);
660 if (strlen(s) >= MAX_ALIAS_NAME)
662 Con_Print("Alias name is too long\n");
666 // if the alias already exists, reuse it
667 for (a = cmd_alias ; a ; a=a->next)
669 if (!strcmp(s, a->name))
678 cmdalias_t *prev, *current;
680 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
681 strlcpy (a->name, s, sizeof (a->name));
682 // insert it at the right alphanumeric position
683 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
694 // copy the rest of the command line
695 cmd[0] = 0; // start out with a null string
697 for (i=2 ; i < c ; i++)
700 strlcat (cmd, " ", sizeof (cmd));
701 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
703 strlcat (cmd, "\n", sizeof (cmd));
705 alloclen = strlen (cmd) + 1;
707 cmd[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
708 a->value = (char *)Z_Malloc (alloclen);
709 memcpy (a->value, cmd, alloclen);
716 Remove existing aliases.
719 static void Cmd_UnAlias_f (void)
727 Con_Print("unalias: Usage: unalias alias1 [alias2 ...]\n");
731 for(i = 1; i < Cmd_Argc(); ++i)
735 for(a = cmd_alias; a; p = a, a = a->next)
737 if(!strcmp(s, a->name))
739 if (a->initstate) // we can not remove init aliases
751 Con_Printf("unalias: %s alias not found\n", s);
756 =============================================================================
760 =============================================================================
763 typedef struct cmd_function_s
765 struct cmd_function_s *next;
767 const char *description;
768 xcommand_t consolefunction;
769 xcommand_t clientfunction;
771 qboolean initstate; // indicates this command existed at init
775 static const char *cmd_argv[MAX_ARGS];
776 static const char *cmd_null_string = "";
777 static const char *cmd_args;
778 cmd_source_t cmd_source;
781 static cmd_function_t *cmd_functions; // possible commands to execute
783 static const char *Cmd_GetDirectCvarValue(const char *varname, cmdalias_t *alias, qboolean *is_multiple)
791 *is_multiple = false;
793 if(!varname || !*varname)
798 if(!strcmp(varname, "*"))
804 else if(!strcmp(varname, "#"))
806 return va(vabuf, sizeof(vabuf), "%d", Cmd_Argc());
808 else if(varname[strlen(varname) - 1] == '-')
810 argno = strtol(varname, &endptr, 10);
811 if(endptr == varname + strlen(varname) - 1)
813 // whole string is a number, apart from the -
814 const char *p = Cmd_Args();
815 for(; argno > 1; --argno)
816 if(!COM_ParseToken_Console(&p))
823 // kill pre-argument whitespace
824 for (;*p && ISWHITESPACE(*p);p++)
833 argno = strtol(varname, &endptr, 10);
836 // whole string is a number
837 // NOTE: we already made sure we don't have an empty cvar name!
838 if(argno >= 0 && argno < Cmd_Argc())
839 return Cmd_Argv(argno);
844 if((cvar = Cvar_FindVar(varname)) && !(cvar->flags & CVAR_PRIVATE))
850 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes)
852 qboolean quote_quot = !!strchr(quoteset, '"');
853 qboolean quote_backslash = !!strchr(quoteset, '\\');
854 qboolean quote_dollar = !!strchr(quoteset, '$');
863 *out++ = '"'; --outlen;
869 if(*in == '"' && quote_quot)
873 *out++ = '\\'; --outlen;
874 *out++ = '"'; --outlen;
876 else if(*in == '\\' && quote_backslash)
880 *out++ = '\\'; --outlen;
881 *out++ = '\\'; --outlen;
883 else if(*in == '$' && quote_dollar)
887 *out++ = '$'; --outlen;
888 *out++ = '$'; --outlen;
894 *out++ = *in; --outlen;
909 static const char *Cmd_GetCvarValue(const char *var, size_t varlen, cmdalias_t *alias)
911 static char varname[MAX_INPUTLINE]; // cmd_mutex
912 static char varval[MAX_INPUTLINE]; // cmd_mutex
915 static char asis[] = "asis"; // just to suppress const char warnings
917 if(varlen >= MAX_INPUTLINE)
918 varlen = MAX_INPUTLINE - 1;
919 memcpy(varname, var, varlen);
921 varfunc = strchr(varname, ' ');
937 if(varname[0] == '$')
938 varstr = Cmd_GetDirectCvarValue(Cmd_GetDirectCvarValue(varname + 1, alias, NULL), alias, NULL);
941 qboolean is_multiple = false;
942 // Exception: $* and $n- don't use the quoted form by default
943 varstr = Cmd_GetDirectCvarValue(varname, alias, &is_multiple);
952 Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
954 Con_Printf("Warning: Could not expand $%s\n", varname);
958 if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
960 // quote it so it can be used inside double quotes
961 // we just need to replace " by \", and of course, double backslashes
962 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\", false);
965 else if(!strcmp(varfunc, "asis"))
970 Con_Printf("Unknown variable function %s\n", varfunc);
978 Preprocesses strings and replaces $*, $param#, $cvar accordingly. Also strips comments.
980 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
986 // don't crash if there's no room in the outtext buffer
987 if( maxoutlen == 0 ) {
990 maxoutlen--; // because of \0
995 while( *in && outlen < maxoutlen ) {
997 // this is some kind of expansion, see what comes after the $
1000 // The console does the following preprocessing:
1002 // - $$ is transformed to a single dollar sign.
1003 // - $var or ${var} are expanded to the contents of the named cvar,
1004 // with quotation marks and backslashes quoted so it can safely
1005 // be used inside quotation marks (and it should always be used
1007 // - ${var asis} inserts the cvar value as is, without doing this
1009 // - prefix the cvar name with a dollar sign to do indirection;
1010 // for example, if $x has the value timelimit, ${$x} will return
1011 // the value of $timelimit
1012 // - when expanding an alias, the special variable name $* refers
1013 // to all alias parameters, and a number refers to that numbered
1014 // alias parameter, where the name of the alias is $0, the first
1015 // parameter is $1 and so on; as a special case, $* inserts all
1016 // parameters, without extra quoting, so one can use $* to just
1017 // pass all parameters around. All parameters starting from $n
1018 // can be referred to as $n- (so $* is equivalent to $1-).
1020 // Note: when expanding an alias, cvar expansion is done in the SAME step
1021 // as alias expansion so that alias parameters or cvar values containing
1022 // dollar signs have no unwanted bad side effects. However, this needs to
1023 // be accounted for when writing complex aliases. For example,
1024 // alias foo "set x NEW; echo $x"
1025 // actually expands to
1026 // "set x NEW; echo OLD"
1027 // and will print OLD! To work around this, use a second alias:
1028 // alias foo "set x NEW; foo2"
1029 // alias foo2 "echo $x"
1031 // Also note: lines starting with alias are exempt from cvar expansion.
1032 // If you want cvar expansion, write "alias" instead:
1035 // alias foo "echo $x"
1036 // "alias" bar "echo $x"
1039 // foo will print 2, because the variable $x will be expanded when the alias
1040 // gets expanded. bar will print 1, because the variable $x was expanded
1041 // at definition time. foo can be equivalently defined as
1043 // "alias" foo "echo $$x"
1045 // because at definition time, $$ will get replaced to a single $.
1050 } else if(*in == '{') {
1051 varlen = strcspn(in + 1, "}");
1052 if(in[varlen + 1] == '}')
1054 val = Cmd_GetCvarValue(in + 1, varlen, alias);
1064 varlen = strspn(in, "#*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
1065 val = Cmd_GetCvarValue(in, varlen, alias);
1070 // insert the cvar value
1071 while(*val && outlen < maxoutlen)
1072 outtext[outlen++] = *val++;
1077 // copy the unexpanded text
1078 outtext[outlen++] = '$';
1079 while(eat && outlen < maxoutlen)
1081 outtext[outlen++] = *in++;
1087 outtext[outlen++] = *in++;
1089 outtext[outlen] = 0;
1096 Called for aliases and fills in the alias into the cbuffer
1099 static void Cmd_ExecuteAlias (cmdalias_t *alias)
1101 static char buffer[ MAX_INPUTLINE ]; // cmd_mutex
1102 static char buffer2[ MAX_INPUTLINE ]; // cmd_mutex
1103 Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
1104 // insert at start of command buffer, so that aliases execute in order
1105 // (fixes bug introduced by Black on 20050705)
1107 // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1108 // have to make sure that no second variable expansion takes place, otherwise
1109 // alias parameters containing dollar signs can have bad effects.
1110 Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$", false);
1111 Cbuf_InsertText( buffer2 );
1118 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1119 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1123 static void Cmd_List_f (void)
1125 cmd_function_t *cmd;
1126 const char *partial;
1133 partial = Cmd_Argv (1);
1134 len = strlen(partial);
1142 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1145 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1147 if (partial && (ispattern ? !matchpattern_with_separator(cmd->name, partial, false, "", false) : strncmp(partial, cmd->name, len)))
1149 Con_Printf("%s : %s\n", cmd->name, cmd->description);
1156 Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1158 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1161 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1164 static void Cmd_Apropos_f(void)
1166 cmd_function_t *cmd;
1169 const char *partial;
1175 partial = Cmd_Args();
1178 Con_Printf("usage: apropos <string>\n");
1182 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1184 partial = va(vabuf, sizeof(vabuf), "*%s*", partial);
1187 for (cvar = cvar_vars; cvar; cvar = cvar->next)
1189 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1190 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1192 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1195 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1197 if (!matchpattern_with_separator(cmd->name, partial, true, "", false))
1198 if (!matchpattern_with_separator(cmd->description, partial, true, "", false))
1200 Con_Printf("command ^2%s^7: %s\n", cmd->name, cmd->description);
1203 for (alias = cmd_alias; alias; alias = alias->next)
1205 // procede here a bit differently as an alias value always got a final \n
1206 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1207 if (!matchpattern_with_separator(alias->value, partial, true, "\n", false)) // when \n is as separator wildcards don't match it
1209 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value); // do not print an extra \n
1212 Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1220 void Cmd_Init (void)
1222 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
1223 // space for commands and script files
1224 cmd_text.data = cmd_text_buf;
1225 cmd_text.maxsize = sizeof(cmd_text_buf);
1226 cmd_text.cursize = 0;
1228 if (Thread_HasThreads())
1229 cmd_text_mutex = Thread_CreateMutex();
1232 void Cmd_Init_Commands (void)
1235 // register our commands
1237 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1238 Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
1239 Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1240 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");
1241 Cmd_AddCommand ("unalias",Cmd_UnAlias_f, "remove an alias");
1242 Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
1243 Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1244 Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
1245 Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1246 Cmd_AddCommand ("unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1247 #ifdef FILLALLCVARSWITHRUBBISH
1248 Cmd_AddCommand ("fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1249 #endif /* FILLALLCVARSWITHRUBBISH */
1251 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1252 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1253 Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1254 Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1255 Cmd_AddCommand ("apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1257 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");
1258 Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1259 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)");
1260 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)");
1262 Cmd_AddCommand ("cprint", Cmd_Centerprint_f, "print something at the screen center");
1263 Cmd_AddCommand ("defer", Cmd_Defer_f, "execute a command in the future");
1266 // Support Doom3-style Toggle Command
1267 Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1275 void Cmd_Shutdown(void)
1279 // we usually have this locked when we get here from Host_Quit_f
1280 Cbuf_UnlockThreadMutex();
1281 Thread_DestroyMutex(cmd_text_mutex);
1283 cmd_text_mutex = NULL;
1285 Mem_FreePool(&cmd_mempool);
1303 const char *Cmd_Argv (int arg)
1305 if (arg >= cmd_argc )
1306 return cmd_null_string;
1307 return cmd_argv[arg];
1315 const char *Cmd_Args (void)
1325 Parses the given string into command line tokens.
1328 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1329 static void Cmd_TokenizeString (const char *text)
1338 // skip whitespace up to a /n
1339 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1346 if (*text == '\n' || *text == '\r')
1348 // a newline separates commands in the buffer
1349 if (*text == '\r' && text[1] == '\n')
1361 if (!COM_ParseToken_Console(&text))
1364 if (cmd_argc < MAX_ARGS)
1366 l = (int)strlen(com_token) + 1;
1367 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1369 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1372 memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
1373 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
1374 cmd_tokenizebufferpos += l;
1386 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
1388 cmd_function_t *cmd;
1389 cmd_function_t *prev, *current;
1391 // fail if the command is a variable name
1392 if (Cvar_FindVar( cmd_name ))
1394 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1398 // fail if the command already exists
1399 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1401 if (!strcmp (cmd_name, cmd->name))
1403 if (consolefunction || clientfunction)
1405 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1410 cmd->csqcfunc = true;
1416 cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
1417 cmd->name = cmd_name;
1418 cmd->consolefunction = consolefunction;
1419 cmd->clientfunction = clientfunction;
1420 cmd->description = description;
1421 if(!consolefunction && !clientfunction) //[515]: csqc
1422 cmd->csqcfunc = true;
1423 cmd->next = cmd_functions;
1425 // insert it at the right alphanumeric position
1426 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
1431 cmd_functions = cmd;
1433 cmd->next = current;
1436 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
1438 Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
1446 qboolean Cmd_Exists (const char *cmd_name)
1448 cmd_function_t *cmd;
1450 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1451 if (!strcmp (cmd_name,cmd->name))
1463 const char *Cmd_CompleteCommand (const char *partial)
1465 cmd_function_t *cmd;
1468 len = strlen(partial);
1474 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1475 if (!strncasecmp(partial, cmd->name, len))
1482 Cmd_CompleteCountPossible
1484 New function for tab-completion system
1485 Added by EvilTypeGuy
1486 Thanks to Fett erich@heintz.com
1490 int Cmd_CompleteCountPossible (const char *partial)
1492 cmd_function_t *cmd;
1497 len = strlen(partial);
1502 // Loop through the command list and count all partial matches
1503 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1504 if (!strncasecmp(partial, cmd->name, len))
1511 Cmd_CompleteBuildList
1513 New function for tab-completion system
1514 Added by EvilTypeGuy
1515 Thanks to Fett erich@heintz.com
1519 const char **Cmd_CompleteBuildList (const char *partial)
1521 cmd_function_t *cmd;
1524 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
1527 len = strlen(partial);
1528 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1529 // Loop through the alias list and print all matches
1530 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1531 if (!strncasecmp(partial, cmd->name, len))
1532 buf[bpos++] = cmd->name;
1538 // written by LordHavoc
1539 void Cmd_CompleteCommandPrint (const char *partial)
1541 cmd_function_t *cmd;
1542 size_t len = strlen(partial);
1543 // Loop through the command list and print all matches
1544 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1545 if (!strncasecmp(partial, cmd->name, len))
1546 Con_Printf("^2%s^7: %s\n", cmd->name, cmd->description);
1552 New function for tab-completion system
1553 Added by EvilTypeGuy
1554 Thanks to Fett erich@heintz.com
1558 const char *Cmd_CompleteAlias (const char *partial)
1563 len = strlen(partial);
1569 for (alias = cmd_alias; alias; alias = alias->next)
1570 if (!strncasecmp(partial, alias->name, len))
1576 // written by LordHavoc
1577 void Cmd_CompleteAliasPrint (const char *partial)
1580 size_t len = strlen(partial);
1581 // Loop through the alias list and print all matches
1582 for (alias = cmd_alias; alias; alias = alias->next)
1583 if (!strncasecmp(partial, alias->name, len))
1584 Con_Printf("^5%s^7: %s", alias->name, alias->value);
1589 Cmd_CompleteAliasCountPossible
1591 New function for tab-completion system
1592 Added by EvilTypeGuy
1593 Thanks to Fett erich@heintz.com
1597 int Cmd_CompleteAliasCountPossible (const char *partial)
1605 len = strlen(partial);
1610 // Loop through the command list and count all partial matches
1611 for (alias = cmd_alias; alias; alias = alias->next)
1612 if (!strncasecmp(partial, alias->name, len))
1619 Cmd_CompleteAliasBuildList
1621 New function for tab-completion system
1622 Added by EvilTypeGuy
1623 Thanks to Fett erich@heintz.com
1627 const char **Cmd_CompleteAliasBuildList (const char *partial)
1632 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1635 len = strlen(partial);
1636 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1637 // Loop through the alias list and print all matches
1638 for (alias = cmd_alias; alias; alias = alias->next)
1639 if (!strncasecmp(partial, alias->name, len))
1640 buf[bpos++] = alias->name;
1646 void Cmd_ClearCsqcFuncs (void)
1648 cmd_function_t *cmd;
1649 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1650 cmd->csqcfunc = false;
1657 A complete command line has been parsed, so try to execute it
1658 FIXME: lookupnoadd the token to speed search?
1661 void Cmd_ExecuteString (const char *text, cmd_source_t src, qboolean lockmutex)
1665 cmd_function_t *cmd;
1668 oldpos = cmd_tokenizebufferpos;
1672 Cmd_TokenizeString (text);
1674 // execute the command line
1676 goto done; // no tokens
1679 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1681 if (!strcasecmp (cmd_argv[0],cmd->name))
1683 if (cmd->csqcfunc && CL_VM_ConsoleCommand (text)) //[515]: csqc
1688 if (cmd->consolefunction)
1689 cmd->consolefunction ();
1690 else if (cmd->clientfunction)
1692 if (cls.state == ca_connected)
1694 // forward remote commands to the server for execution
1695 Cmd_ForwardToServer();
1698 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1701 Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1705 if (cmd->clientfunction)
1707 cmd->clientfunction ();
1717 // if it's a client command and no command was found, say so.
1718 if (cmd_source == src_client)
1720 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1725 for (a=cmd_alias ; a ; a=a->next)
1727 if (!strcasecmp (cmd_argv[0], a->name))
1729 Cmd_ExecuteAlias(a);
1734 if(found) // if the command was hooked and found, all is good
1738 if (!Cvar_Command () && host_framecount > 0)
1739 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1742 cmd_tokenizebufferpos = oldpos;
1748 Cmd_ForwardStringToServer
1750 Sends an entire command string over to the server, unprocessed
1753 void Cmd_ForwardStringToServer (const char *s)
1756 if (cls.state != ca_connected)
1758 Con_Printf("Can't \"%s\", not connected\n", s);
1765 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1766 // attention, it has been eradicated from here, its only (former) use in
1767 // all of darkplaces.
1768 if (cls.protocol == PROTOCOL_QUAKEWORLD)
1769 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1771 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1772 if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
1774 // say/say_team commands can replace % character codes with status info
1777 if (*s == '%' && s[1])
1779 // handle proquake message macros
1783 case 'l': // current location
1784 CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
1786 case 'h': // current health
1787 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
1789 case 'a': // current armor
1790 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
1792 case 'x': // current rockets
1793 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
1795 case 'c': // current cells
1796 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
1798 // silly proquake macros
1799 case 'd': // loc at last death
1800 CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
1802 case 't': // current time
1803 dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
1805 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
1806 if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
1807 dpsnprintf(temp, sizeof(temp), "I need RL");
1808 else if (!cl.stats[STAT_ROCKETS])
1809 dpsnprintf(temp, sizeof(temp), "I need rockets");
1811 dpsnprintf(temp, sizeof(temp), "I have RL");
1813 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
1814 if (cl.stats[STAT_ITEMS] & IT_QUAD)
1817 strlcat(temp, " ", sizeof(temp));
1818 strlcat(temp, "quad", sizeof(temp));
1820 if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
1823 strlcat(temp, " ", sizeof(temp));
1824 strlcat(temp, "pent", sizeof(temp));
1826 if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
1829 strlcat(temp, " ", sizeof(temp));
1830 strlcat(temp, "eyes", sizeof(temp));
1833 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
1834 if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
1835 strlcat(temp, "SSG", sizeof(temp));
1836 strlcat(temp, ":", sizeof(temp));
1837 if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
1838 strlcat(temp, "NG", sizeof(temp));
1839 strlcat(temp, ":", sizeof(temp));
1840 if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
1841 strlcat(temp, "SNG", sizeof(temp));
1842 strlcat(temp, ":", sizeof(temp));
1843 if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
1844 strlcat(temp, "GL", sizeof(temp));
1845 strlcat(temp, ":", sizeof(temp));
1846 if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
1847 strlcat(temp, "RL", sizeof(temp));
1848 strlcat(temp, ":", sizeof(temp));
1849 if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
1850 strlcat(temp, "LG", sizeof(temp));
1853 // not a recognized macro, print it as-is...
1859 // write the resulting text
1860 SZ_Write(&cls.netcon->message, (unsigned char *)temp, strlen(temp));
1864 MSG_WriteByte(&cls.netcon->message, *s);
1867 MSG_WriteByte(&cls.netcon->message, 0);
1869 else // any other command is passed on as-is
1870 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1877 Sends the entire command line over to the server
1880 void Cmd_ForwardToServer (void)
1884 if (!strcasecmp(Cmd_Argv(0), "cmd"))
1886 // we want to strip off "cmd", so just send the args
1887 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1891 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1892 s = va(vabuf, sizeof(vabuf), "%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1894 // don't send an empty forward message if the user tries "cmd" by itself
1897 Cmd_ForwardStringToServer(s);
1905 Returns the position (1 to argc-1) in the command's argument list
1906 where the given parameter apears, or 0 if not present
1910 int Cmd_CheckParm (const char *parm)
1916 Con_Printf ("Cmd_CheckParm: NULL");
1920 for (i = 1; i < Cmd_Argc (); i++)
1921 if (!strcasecmp (parm, Cmd_Argv (i)))
1929 void Cmd_SaveInitState(void)
1933 for (f = cmd_functions;f;f = f->next)
1934 f->initstate = true;
1935 for (a = cmd_alias;a;a = a->next)
1937 a->initstate = true;
1938 a->initialvalue = Mem_strdup(zonemempool, a->value);
1940 Cvar_SaveInitState();
1943 void Cmd_RestoreInitState(void)
1945 cmd_function_t *f, **fp;
1946 cmdalias_t *a, **ap;
1947 for (fp = &cmd_functions;(f = *fp);)
1953 // destroy this command, it didn't exist at init
1954 Con_DPrintf("Cmd_RestoreInitState: Destroying command %s\n", f->name);
1959 for (ap = &cmd_alias;(a = *ap);)
1963 // restore this alias, it existed at init
1964 if (strcmp(a->value ? a->value : "", a->initialvalue ? a->initialvalue : ""))
1966 Con_DPrintf("Cmd_RestoreInitState: Restoring alias %s\n", a->name);
1969 a->value = Mem_strdup(zonemempool, a->initialvalue);
1975 // free this alias, it didn't exist at init...
1976 Con_DPrintf("Cmd_RestoreInitState: Destroying alias %s\n", a->name);
1983 Cvar_RestoreInitState();