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];
29 qboolean initstate; // indicates this command existed at init
30 char *initialvalue; // backup copy of value at init
33 static cmdalias_t *cmd_alias;
35 static qboolean cmd_wait;
37 static mempool_t *cmd_mempool;
39 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
40 static int cmd_tokenizebufferpos = 0;
42 //=============================================================================
48 Causes execution of the remainder of the command buffer to be delayed until
49 next frame. This allows commands like:
50 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
53 static void Cmd_Wait_f (void)
58 typedef struct cmddeferred_s
60 struct cmddeferred_s *next;
65 static cmddeferred_t *cmd_deferred_list = NULL;
71 Cause a command to be executed after a delay.
74 static void Cmd_Defer_f (void)
78 double time = Sys_DoubleTime();
79 cmddeferred_t *next = cmd_deferred_list;
81 Con_Printf("No commands are pending.\n");
84 Con_Printf("-> In %9.2f: %s\n", next->time-time, 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->time = Sys_DoubleTime() + 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];
183 Adds command text at the end of the buffer
186 void Cbuf_AddText (const char *text)
190 l = (int)strlen (text);
192 if (cmd_text.cursize + l >= cmd_text.maxsize)
194 Con_Print("Cbuf_AddText: overflow\n");
198 SZ_Write (&cmd_text, (const unsigned char *)text, (int)strlen (text));
206 Adds command text immediately after the current command
207 Adds a \n to the text
208 FIXME: actually change the command buffer to do less copying
211 void Cbuf_InsertText (const char *text)
216 // copy off any commands still remaining in the exec buffer
217 templen = cmd_text.cursize;
220 temp = (char *)Mem_Alloc (tempmempool, templen);
221 memcpy (temp, cmd_text.data, templen);
222 SZ_Clear (&cmd_text);
227 // add the entire text of the file
230 // add the copied off data
233 SZ_Write (&cmd_text, (const unsigned char *)temp, templen);
240 Cbuf_Execute_Deferred --blub
243 void Cbuf_Execute_Deferred (void)
245 cmddeferred_t *cmd, *prev;
246 double time = Sys_DoubleTime();
248 cmd = cmd_deferred_list;
251 if(cmd->time <= time)
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);
369 Cmd_ExecuteString (line, src_command);
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 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)
457 if (!strcmp(filename, "config.cfg"))
459 filename = CONFIGFILENAME;
460 if (COM_CheckParm("-noconfig"))
461 return; // don't execute config.cfg
464 f = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
467 Con_Printf("couldn't exec %s\n",filename);
470 Con_Printf("execing %s\n",filename);
472 // if executing default.cfg for the first time, lock the cvar defaults
473 // it may seem backwards to insert this text BEFORE the default.cfg
474 // but Cbuf_InsertText inserts before, so this actually ends up after it.
475 if (strlen(filename) >= 11 && !strcmp(filename + strlen(filename) - 11, "default.cfg"))
476 Cbuf_InsertText("\ncvar_lockdefaults\n");
478 // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
479 // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
480 Cbuf_InsertText ("\n");
484 // special defaults for specific games go here, these execute before default.cfg
485 // Nehahra pushable crates malfunction in some levels if this is on
486 // Nehahra NPC AI is confused by blowupfallenzombies
487 if (gamemode == GAME_NEHAHRA)
488 Cbuf_InsertText("\nsv_gameplayfix_upwardvelocityclearsongroundflag 0\nsv_gameplayfix_blowupfallenzombies 0\n\n");
489 // 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.
490 // 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
491 // hipnotic mission pack has issues in their proximity mine sticking code, which causes them to bounce off.
492 if (gamemode == GAME_HIPNOTIC)
493 Cbuf_InsertText("\nsv_gameplayfix_blowupfallenzombies 0\nsys_ticrate 0.02\nsv_gameplayfix_slidemoveprojectiles 0\n\n");
494 // rogue mission pack has a guardian boss that does not wake up if findradius returns one of the entities around its spawn area
495 if (gamemode == GAME_ROGUE)
496 Cbuf_InsertText("\nsv_gameplayfix_findradiusdistancetobox 0\n\n");
497 if (gamemode == GAME_NEXUIZ)
498 Cbuf_InsertText("\nsv_gameplayfix_q2airaccelerate 1\nsv_gameplayfix_stepmultipletimes 1\n\n");
499 if (gamemode == GAME_TENEBRAE)
500 Cbuf_InsertText("\nr_shadow_gloss 2\nr_shadow_bumpscale_basetexture 4\n\n");
508 static void Cmd_Exec_f (void)
513 if (Cmd_Argc () != 2)
515 Con_Print("exec <filename> : execute a script file\n");
519 s = FS_Search(Cmd_Argv(1), true, true);
520 if(!s || !s->numfilenames)
522 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
526 for(i = 0; i < s->numfilenames; ++i)
527 Cmd_Exec(s->filenames[i]);
537 Just prints the rest of the line to the console
540 static void Cmd_Echo_f (void)
544 for (i=1 ; i<Cmd_Argc() ; i++)
545 Con_Printf("%s ",Cmd_Argv(i));
550 // Support Doom3-style Toggle Console Command
555 Toggles a specified console variable amongst the values specified (default is 0 and 1)
558 static void Cmd_Toggle_f(void)
560 // Acquire Number of Arguments
561 int nNumArgs = Cmd_Argc();
564 // No Arguments Specified; Print Usage
565 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");
567 { // Correct Arguments Specified
568 // Acquire Potential CVar
569 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
576 Cvar_SetValueQuick(cvCVar, 0);
578 Cvar_SetValueQuick(cvCVar, 1);
582 { // 0 and Specified Usage
583 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
584 // CVar is Specified Value; // Reset to 0
585 Cvar_SetValueQuick(cvCVar, 0);
587 if(cvCVar->integer == 0)
588 // CVar is 0; Specify Value
589 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
591 // CVar does not match; Reset to 0
592 Cvar_SetValueQuick(cvCVar, 0);
595 { // Variable Values Specified
599 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
600 { // Cycle through Values
601 if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
602 { // Current Value Located; Increment to Next
603 if( (nCnt + 1) == nNumArgs)
604 // Max Value Reached; Reset
605 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
608 Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
617 // Value not Found; Reset to Original
618 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
624 Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(1) );
633 Creates a new command that executes a command string (possibly ; seperated)
636 static void Cmd_Alias_f (void)
639 char cmd[MAX_INPUTLINE];
646 Con_Print("Current alias commands:\n");
647 for (a = cmd_alias ; a ; a=a->next)
648 Con_Printf("%s : %s", a->name, a->value);
653 if (strlen(s) >= MAX_ALIAS_NAME)
655 Con_Print("Alias name is too long\n");
659 // if the alias already exists, reuse it
660 for (a = cmd_alias ; a ; a=a->next)
662 if (!strcmp(s, a->name))
671 cmdalias_t *prev, *current;
673 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
674 strlcpy (a->name, s, sizeof (a->name));
675 // insert it at the right alphanumeric position
676 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
687 // copy the rest of the command line
688 cmd[0] = 0; // start out with a null string
690 for (i=2 ; i < c ; i++)
693 strlcat (cmd, " ", sizeof (cmd));
694 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
696 strlcat (cmd, "\n", sizeof (cmd));
698 alloclen = strlen (cmd) + 1;
700 cmd[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
701 a->value = (char *)Z_Malloc (alloclen);
702 memcpy (a->value, cmd, alloclen);
709 Remove existing aliases.
712 static void Cmd_UnAlias_f (void)
720 Con_Print("unalias: Usage: unalias alias1 [alias2 ...]\n");
724 for(i = 1; i < Cmd_Argc(); ++i)
728 for(a = cmd_alias; a; p = a, a = a->next)
730 if(!strcmp(s, a->name))
732 if (a->initstate) // we can not remove init aliases
744 Con_Printf("unalias: %s alias not found\n", s);
749 =============================================================================
753 =============================================================================
756 typedef struct cmd_function_s
758 struct cmd_function_s *next;
760 const char *description;
761 xcommand_t consolefunction;
762 xcommand_t clientfunction;
764 qboolean initstate; // indicates this command existed at init
768 static const char *cmd_argv[MAX_ARGS];
769 static const char *cmd_null_string = "";
770 static const char *cmd_args;
771 cmd_source_t cmd_source;
774 static cmd_function_t *cmd_functions; // possible commands to execute
776 static const char *Cmd_GetDirectCvarValue(const char *varname, cmdalias_t *alias, qboolean *is_multiple)
783 *is_multiple = false;
785 if(!varname || !*varname)
790 if(!strcmp(varname, "*"))
796 else if(!strcmp(varname, "#"))
798 return va("%d", Cmd_Argc());
800 else if(varname[strlen(varname) - 1] == '-')
802 argno = strtol(varname, &endptr, 10);
803 if(endptr == varname + strlen(varname) - 1)
805 // whole string is a number, apart from the -
806 const char *p = Cmd_Args();
807 for(; argno > 1; --argno)
808 if(!COM_ParseToken_Console(&p))
815 // kill pre-argument whitespace
816 for (;*p && ISWHITESPACE(*p);p++)
825 argno = strtol(varname, &endptr, 10);
828 // whole string is a number
829 // NOTE: we already made sure we don't have an empty cvar name!
830 if(argno >= 0 && argno < Cmd_Argc())
831 return Cmd_Argv(argno);
836 if((cvar = Cvar_FindVar(varname)) && !(cvar->flags & CVAR_PRIVATE))
842 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes)
844 qboolean quote_quot = !!strchr(quoteset, '"');
845 qboolean quote_backslash = !!strchr(quoteset, '\\');
846 qboolean quote_dollar = !!strchr(quoteset, '$');
855 *out++ = '"'; --outlen;
861 if(*in == '"' && quote_quot)
865 *out++ = '\\'; --outlen;
866 *out++ = '"'; --outlen;
868 else if(*in == '\\' && quote_backslash)
872 *out++ = '\\'; --outlen;
873 *out++ = '\\'; --outlen;
875 else if(*in == '$' && quote_dollar)
879 *out++ = '$'; --outlen;
880 *out++ = '$'; --outlen;
886 *out++ = *in; --outlen;
901 static const char *Cmd_GetCvarValue(const char *var, size_t varlen, cmdalias_t *alias)
903 static char varname[MAX_INPUTLINE];
904 static char varval[MAX_INPUTLINE];
907 static char asis[] = "asis"; // just to suppress const char warnings
909 if(varlen >= MAX_INPUTLINE)
910 varlen = MAX_INPUTLINE - 1;
911 memcpy(varname, var, varlen);
913 varfunc = strchr(varname, ' ');
929 if(varname[0] == '$')
930 varstr = Cmd_GetDirectCvarValue(Cmd_GetDirectCvarValue(varname + 1, alias, NULL), alias, NULL);
933 qboolean is_multiple = false;
934 // Exception: $* and $n- don't use the quoted form by default
935 varstr = Cmd_GetDirectCvarValue(varname, alias, &is_multiple);
944 Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
946 Con_Printf("Warning: Could not expand $%s\n", varname);
950 if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
952 // quote it so it can be used inside double quotes
953 // we just need to replace " by \", and of course, double backslashes
954 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\", false);
957 else if(!strcmp(varfunc, "asis"))
962 Con_Printf("Unknown variable function %s\n", varfunc);
970 Preprocesses strings and replaces $*, $param#, $cvar accordingly. Also strips comments.
972 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
978 // don't crash if there's no room in the outtext buffer
979 if( maxoutlen == 0 ) {
982 maxoutlen--; // because of \0
987 while( *in && outlen < maxoutlen ) {
989 // this is some kind of expansion, see what comes after the $
992 // The console does the following preprocessing:
994 // - $$ is transformed to a single dollar sign.
995 // - $var or ${var} are expanded to the contents of the named cvar,
996 // with quotation marks and backslashes quoted so it can safely
997 // be used inside quotation marks (and it should always be used
999 // - ${var asis} inserts the cvar value as is, without doing this
1001 // - prefix the cvar name with a dollar sign to do indirection;
1002 // for example, if $x has the value timelimit, ${$x} will return
1003 // the value of $timelimit
1004 // - when expanding an alias, the special variable name $* refers
1005 // to all alias parameters, and a number refers to that numbered
1006 // alias parameter, where the name of the alias is $0, the first
1007 // parameter is $1 and so on; as a special case, $* inserts all
1008 // parameters, without extra quoting, so one can use $* to just
1009 // pass all parameters around. All parameters starting from $n
1010 // can be referred to as $n- (so $* is equivalent to $1-).
1012 // Note: when expanding an alias, cvar expansion is done in the SAME step
1013 // as alias expansion so that alias parameters or cvar values containing
1014 // dollar signs have no unwanted bad side effects. However, this needs to
1015 // be accounted for when writing complex aliases. For example,
1016 // alias foo "set x NEW; echo $x"
1017 // actually expands to
1018 // "set x NEW; echo OLD"
1019 // and will print OLD! To work around this, use a second alias:
1020 // alias foo "set x NEW; foo2"
1021 // alias foo2 "echo $x"
1023 // Also note: lines starting with alias are exempt from cvar expansion.
1024 // If you want cvar expansion, write "alias" instead:
1027 // alias foo "echo $x"
1028 // "alias" bar "echo $x"
1031 // foo will print 2, because the variable $x will be expanded when the alias
1032 // gets expanded. bar will print 1, because the variable $x was expanded
1033 // at definition time. foo can be equivalently defined as
1035 // "alias" foo "echo $$x"
1037 // because at definition time, $$ will get replaced to a single $.
1042 } else if(*in == '{') {
1043 varlen = strcspn(in + 1, "}");
1044 if(in[varlen + 1] == '}')
1046 val = Cmd_GetCvarValue(in + 1, varlen, alias);
1056 varlen = strspn(in, "#*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
1057 val = Cmd_GetCvarValue(in, varlen, alias);
1062 // insert the cvar value
1063 while(*val && outlen < maxoutlen)
1064 outtext[outlen++] = *val++;
1069 // copy the unexpanded text
1070 outtext[outlen++] = '$';
1071 while(eat && outlen < maxoutlen)
1073 outtext[outlen++] = *in++;
1079 outtext[outlen++] = *in++;
1081 outtext[outlen] = 0;
1088 Called for aliases and fills in the alias into the cbuffer
1091 static void Cmd_ExecuteAlias (cmdalias_t *alias)
1093 static char buffer[ MAX_INPUTLINE ];
1094 static char buffer2[ MAX_INPUTLINE ];
1095 Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
1096 // insert at start of command buffer, so that aliases execute in order
1097 // (fixes bug introduced by Black on 20050705)
1099 // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1100 // have to make sure that no second variable expansion takes place, otherwise
1101 // alias parameters containing dollar signs can have bad effects.
1102 Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$", false);
1103 Cbuf_InsertText( buffer2 );
1110 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1111 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1115 static void Cmd_List_f (void)
1117 cmd_function_t *cmd;
1118 const char *partial;
1125 partial = Cmd_Argv (1);
1126 len = strlen(partial);
1134 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1137 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1139 if (partial && (ispattern ? !matchpattern_with_separator(cmd->name, partial, false, "", false) : strncmp(partial, cmd->name, len)))
1141 Con_Printf("%s : %s\n", cmd->name, cmd->description);
1148 Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1150 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1153 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1156 static void Cmd_Apropos_f(void)
1158 cmd_function_t *cmd;
1161 const char *partial;
1166 partial = Cmd_Args();
1169 Con_Printf("usage: apropos <string>\n");
1173 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1175 partial = va("*%s*", partial);
1178 for (cvar = cvar_vars; cvar; cvar = cvar->next)
1180 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1181 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1183 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1186 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1188 if (!matchpattern_with_separator(cmd->name, partial, true, "", false))
1189 if (!matchpattern_with_separator(cmd->description, partial, true, "", false))
1191 Con_Printf("command ^2%s^7: %s\n", cmd->name, cmd->description);
1194 for (alias = cmd_alias; alias; alias = alias->next)
1196 // procede here a bit differently as an alias value always got a final \n
1197 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1198 if (!matchpattern_with_separator(alias->value, partial, true, "\n", false)) // when \n is as separator wildcards don't match it
1200 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value); // do not print an extra \n
1203 Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1211 void Cmd_Init (void)
1213 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
1214 // space for commands and script files
1215 cmd_text.data = cmd_text_buf;
1216 cmd_text.maxsize = sizeof(cmd_text_buf);
1217 cmd_text.cursize = 0;
1220 void Cmd_Init_Commands (void)
1223 // register our commands
1225 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1226 Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
1227 Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1228 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");
1229 Cmd_AddCommand ("unalias",Cmd_UnAlias_f, "remove an alias");
1230 Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
1231 Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1232 Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
1233 Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1234 Cmd_AddCommand ("unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1235 #ifdef FILLALLCVARSWITHRUBBISH
1236 Cmd_AddCommand ("fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1237 #endif /* FILLALLCVARSWITHRUBBISH */
1239 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1240 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1241 Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1242 Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1243 Cmd_AddCommand ("apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1245 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");
1246 Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1247 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)");
1248 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)");
1250 Cmd_AddCommand ("cprint", Cmd_Centerprint_f, "print something at the screen center");
1251 Cmd_AddCommand ("defer", Cmd_Defer_f, "execute a command in the future");
1254 // Support Doom3-style Toggle Command
1255 Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1263 void Cmd_Shutdown(void)
1265 Mem_FreePool(&cmd_mempool);
1283 const char *Cmd_Argv (int arg)
1285 if (arg >= cmd_argc )
1286 return cmd_null_string;
1287 return cmd_argv[arg];
1295 const char *Cmd_Args (void)
1305 Parses the given string into command line tokens.
1308 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1309 static void Cmd_TokenizeString (const char *text)
1318 // skip whitespace up to a /n
1319 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1326 if (*text == '\n' || *text == '\r')
1328 // a newline separates commands in the buffer
1329 if (*text == '\r' && text[1] == '\n')
1341 if (!COM_ParseToken_Console(&text))
1344 if (cmd_argc < MAX_ARGS)
1346 l = (int)strlen(com_token) + 1;
1347 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1349 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1352 memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
1353 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
1354 cmd_tokenizebufferpos += l;
1366 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
1368 cmd_function_t *cmd;
1369 cmd_function_t *prev, *current;
1371 // fail if the command is a variable name
1372 if (Cvar_FindVar( cmd_name ))
1374 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1378 // fail if the command already exists
1379 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1381 if (!strcmp (cmd_name, cmd->name))
1383 if (consolefunction || clientfunction)
1385 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1390 cmd->csqcfunc = true;
1396 cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
1397 cmd->name = cmd_name;
1398 cmd->consolefunction = consolefunction;
1399 cmd->clientfunction = clientfunction;
1400 cmd->description = description;
1401 if(!consolefunction && !clientfunction) //[515]: csqc
1402 cmd->csqcfunc = true;
1403 cmd->next = cmd_functions;
1405 // insert it at the right alphanumeric position
1406 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
1411 cmd_functions = cmd;
1413 cmd->next = current;
1416 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
1418 Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
1426 qboolean Cmd_Exists (const char *cmd_name)
1428 cmd_function_t *cmd;
1430 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1431 if (!strcmp (cmd_name,cmd->name))
1443 const char *Cmd_CompleteCommand (const char *partial)
1445 cmd_function_t *cmd;
1448 len = strlen(partial);
1454 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1455 if (!strncasecmp(partial, cmd->name, len))
1462 Cmd_CompleteCountPossible
1464 New function for tab-completion system
1465 Added by EvilTypeGuy
1466 Thanks to Fett erich@heintz.com
1470 int Cmd_CompleteCountPossible (const char *partial)
1472 cmd_function_t *cmd;
1477 len = strlen(partial);
1482 // Loop through the command list and count all partial matches
1483 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1484 if (!strncasecmp(partial, cmd->name, len))
1491 Cmd_CompleteBuildList
1493 New function for tab-completion system
1494 Added by EvilTypeGuy
1495 Thanks to Fett erich@heintz.com
1499 const char **Cmd_CompleteBuildList (const char *partial)
1501 cmd_function_t *cmd;
1504 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
1507 len = strlen(partial);
1508 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1509 // Loop through the alias list and print all matches
1510 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1511 if (!strncasecmp(partial, cmd->name, len))
1512 buf[bpos++] = cmd->name;
1518 // written by LordHavoc
1519 void Cmd_CompleteCommandPrint (const char *partial)
1521 cmd_function_t *cmd;
1522 size_t len = strlen(partial);
1523 // Loop through the command list and print all matches
1524 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1525 if (!strncasecmp(partial, cmd->name, len))
1526 Con_Printf("^2%s^7: %s\n", cmd->name, cmd->description);
1532 New function for tab-completion system
1533 Added by EvilTypeGuy
1534 Thanks to Fett erich@heintz.com
1538 const char *Cmd_CompleteAlias (const char *partial)
1543 len = strlen(partial);
1549 for (alias = cmd_alias; alias; alias = alias->next)
1550 if (!strncasecmp(partial, alias->name, len))
1556 // written by LordHavoc
1557 void Cmd_CompleteAliasPrint (const char *partial)
1560 size_t len = strlen(partial);
1561 // Loop through the alias list and print all matches
1562 for (alias = cmd_alias; alias; alias = alias->next)
1563 if (!strncasecmp(partial, alias->name, len))
1564 Con_Printf("^5%s^7: %s", alias->name, alias->value);
1569 Cmd_CompleteAliasCountPossible
1571 New function for tab-completion system
1572 Added by EvilTypeGuy
1573 Thanks to Fett erich@heintz.com
1577 int Cmd_CompleteAliasCountPossible (const char *partial)
1585 len = strlen(partial);
1590 // Loop through the command list and count all partial matches
1591 for (alias = cmd_alias; alias; alias = alias->next)
1592 if (!strncasecmp(partial, alias->name, len))
1599 Cmd_CompleteAliasBuildList
1601 New function for tab-completion system
1602 Added by EvilTypeGuy
1603 Thanks to Fett erich@heintz.com
1607 const char **Cmd_CompleteAliasBuildList (const char *partial)
1612 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1615 len = strlen(partial);
1616 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1617 // Loop through the alias list and print all matches
1618 for (alias = cmd_alias; alias; alias = alias->next)
1619 if (!strncasecmp(partial, alias->name, len))
1620 buf[bpos++] = alias->name;
1626 void Cmd_ClearCsqcFuncs (void)
1628 cmd_function_t *cmd;
1629 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1630 cmd->csqcfunc = false;
1633 qboolean CL_VM_ConsoleCommand (const char *cmd);
1638 A complete command line has been parsed, so try to execute it
1639 FIXME: lookupnoadd the token to speed search?
1642 void Cmd_ExecuteString (const char *text, cmd_source_t src)
1646 cmd_function_t *cmd;
1649 oldpos = cmd_tokenizebufferpos;
1653 Cmd_TokenizeString (text);
1655 // execute the command line
1658 cmd_tokenizebufferpos = oldpos;
1659 return; // no tokens
1663 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1665 if (!strcasecmp (cmd_argv[0],cmd->name))
1667 if (cmd->csqcfunc && CL_VM_ConsoleCommand (text)) //[515]: csqc
1672 if (cmd->consolefunction)
1673 cmd->consolefunction ();
1674 else if (cmd->clientfunction)
1676 if (cls.state == ca_connected)
1678 // forward remote commands to the server for execution
1679 Cmd_ForwardToServer();
1682 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1685 Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1689 if (cmd->clientfunction)
1691 cmd->clientfunction ();
1692 cmd_tokenizebufferpos = oldpos;
1702 // if it's a client command and no command was found, say so.
1703 if (cmd_source == src_client)
1705 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1706 cmd_tokenizebufferpos = oldpos;
1711 for (a=cmd_alias ; a ; a=a->next)
1713 if (!strcasecmp (cmd_argv[0], a->name))
1715 Cmd_ExecuteAlias(a);
1716 cmd_tokenizebufferpos = oldpos;
1721 if(found) // if the command was hooked and found, all is good
1723 cmd_tokenizebufferpos = oldpos;
1728 if (!Cvar_Command () && host_framecount > 0)
1729 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1731 cmd_tokenizebufferpos = oldpos;
1737 Cmd_ForwardStringToServer
1739 Sends an entire command string over to the server, unprocessed
1742 void Cmd_ForwardStringToServer (const char *s)
1745 if (cls.state != ca_connected)
1747 Con_Printf("Can't \"%s\", not connected\n", s);
1754 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1755 // attention, it has been eradicated from here, its only (former) use in
1756 // all of darkplaces.
1757 if (cls.protocol == PROTOCOL_QUAKEWORLD)
1758 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1760 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1761 if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
1763 // say/say_team commands can replace % character codes with status info
1766 if (*s == '%' && s[1])
1768 // handle proquake message macros
1772 case 'l': // current location
1773 CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
1775 case 'h': // current health
1776 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
1778 case 'a': // current armor
1779 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
1781 case 'x': // current rockets
1782 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
1784 case 'c': // current cells
1785 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
1787 // silly proquake macros
1788 case 'd': // loc at last death
1789 CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
1791 case 't': // current time
1792 dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
1794 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
1795 if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
1796 dpsnprintf(temp, sizeof(temp), "I need RL");
1797 else if (!cl.stats[STAT_ROCKETS])
1798 dpsnprintf(temp, sizeof(temp), "I need rockets");
1800 dpsnprintf(temp, sizeof(temp), "I have RL");
1802 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
1803 if (cl.stats[STAT_ITEMS] & IT_QUAD)
1806 strlcat(temp, " ", sizeof(temp));
1807 strlcat(temp, "quad", sizeof(temp));
1809 if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
1812 strlcat(temp, " ", sizeof(temp));
1813 strlcat(temp, "pent", sizeof(temp));
1815 if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
1818 strlcat(temp, " ", sizeof(temp));
1819 strlcat(temp, "eyes", sizeof(temp));
1822 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
1823 if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
1824 strlcat(temp, "SSG", sizeof(temp));
1825 strlcat(temp, ":", sizeof(temp));
1826 if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
1827 strlcat(temp, "NG", sizeof(temp));
1828 strlcat(temp, ":", sizeof(temp));
1829 if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
1830 strlcat(temp, "SNG", sizeof(temp));
1831 strlcat(temp, ":", sizeof(temp));
1832 if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
1833 strlcat(temp, "GL", sizeof(temp));
1834 strlcat(temp, ":", sizeof(temp));
1835 if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
1836 strlcat(temp, "RL", sizeof(temp));
1837 strlcat(temp, ":", sizeof(temp));
1838 if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
1839 strlcat(temp, "LG", sizeof(temp));
1842 // not a recognized macro, print it as-is...
1848 // write the resulting text
1849 SZ_Write(&cls.netcon->message, (unsigned char *)temp, strlen(temp));
1853 MSG_WriteByte(&cls.netcon->message, *s);
1856 MSG_WriteByte(&cls.netcon->message, 0);
1858 else // any other command is passed on as-is
1859 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1866 Sends the entire command line over to the server
1869 void Cmd_ForwardToServer (void)
1872 if (!strcasecmp(Cmd_Argv(0), "cmd"))
1874 // we want to strip off "cmd", so just send the args
1875 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1879 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1880 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1882 // don't send an empty forward message if the user tries "cmd" by itself
1885 Cmd_ForwardStringToServer(s);
1893 Returns the position (1 to argc-1) in the command's argument list
1894 where the given parameter apears, or 0 if not present
1898 int Cmd_CheckParm (const char *parm)
1904 Con_Printf ("Cmd_CheckParm: NULL");
1908 for (i = 1; i < Cmd_Argc (); i++)
1909 if (!strcasecmp (parm, Cmd_Argv (i)))
1917 void Cmd_SaveInitState(void)
1921 for (f = cmd_functions;f;f = f->next)
1922 f->initstate = true;
1923 for (a = cmd_alias;a;a = a->next)
1925 a->initstate = true;
1926 a->initialvalue = Mem_strdup(zonemempool, a->value);
1928 Cvar_SaveInitState();
1931 void Cmd_RestoreInitState(void)
1933 cmd_function_t *f, **fp;
1934 cmdalias_t *a, **ap;
1935 for (fp = &cmd_functions;(f = *fp);)
1941 // destroy this command, it didn't exist at init
1942 Con_DPrintf("Cmd_RestoreInitState: Destroying command %s\n", f->name);
1947 for (ap = &cmd_alias;(a = *ap);)
1951 // restore this alias, it existed at init
1952 if (strcmp(a->value ? a->value : "", a->initialvalue ? a->initialvalue : ""))
1954 Con_DPrintf("Cmd_RestoreInitState: Restoring alias %s\n", a->name);
1957 a->value = Mem_strdup(zonemempool, a->initialvalue);
1963 // free this alias, it didn't exist at init...
1964 Con_DPrintf("Cmd_RestoreInitState: Destroying alias %s\n", a->name);
1971 Cvar_RestoreInitState();