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;
179 qboolean cmd_text_mutex_locked = false;
181 static void Cbuf_LockThreadMutex(void)
185 Thread_LockMutex(cmd_text_mutex);
186 cmd_text_mutex_locked = true;
190 static void Cbuf_UnlockThreadMutex(void)
194 cmd_text_mutex_locked = false;
195 Thread_UnlockMutex(cmd_text_mutex);
203 Adds command text at the end of the buffer
206 void Cbuf_AddText (const char *text)
210 l = (int)strlen(text);
212 Cbuf_LockThreadMutex();
213 if (cmd_text.cursize + l >= cmd_text.maxsize)
214 Con_Print("Cbuf_AddText: overflow\n");
216 SZ_Write(&cmd_text, (const unsigned char *)text, (int)strlen (text));
217 Cbuf_UnlockThreadMutex();
225 Adds command text immediately after the current command
226 Adds a \n to the text
227 FIXME: actually change the command buffer to do less copying
230 void Cbuf_InsertText (const char *text)
235 Cbuf_LockThreadMutex();
237 // copy off any commands still remaining in the exec buffer
238 templen = cmd_text.cursize;
241 temp = (char *)Mem_Alloc (tempmempool, templen);
242 memcpy (temp, cmd_text.data, templen);
243 SZ_Clear (&cmd_text);
248 // add the entire text of the file
251 // add the copied off data
254 SZ_Write (&cmd_text, (const unsigned char *)temp, templen);
258 Cbuf_UnlockThreadMutex();
263 Cbuf_Execute_Deferred --blub
266 static void Cbuf_Execute_Deferred (void)
268 static double oldrealtime = 0;
269 cmddeferred_t *cmd, *prev;
271 if (realtime - oldrealtime < 0 || realtime - oldrealtime > 1800) oldrealtime = realtime;
272 eat = realtime - oldrealtime;
273 if (eat < (1.0 / 120.0))
275 oldrealtime = realtime;
277 cmd = cmd_deferred_list;
283 Cbuf_AddText(cmd->value);
285 Mem_Free(cmd->value);
288 prev->next = cmd->next;
292 cmd_deferred_list = cmd->next;
294 cmd = cmd_deferred_list;
308 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
309 void Cbuf_Execute (void)
313 char line[MAX_INPUTLINE];
314 char preprocessed[MAX_INPUTLINE];
319 SV_LockThreadMutex();
320 Cbuf_LockThreadMutex();
322 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
323 cmd_tokenizebufferpos = 0;
325 Cbuf_Execute_Deferred();
326 while (cmd_text.cursize)
328 // find a \n or ; line break
329 text = (char *)cmd_text.data;
333 for (i=0 ; i < cmd_text.cursize ; i++)
342 // make sure i doesn't get > cursize which causes a negative
343 // size in memmove, which is fatal --blub
344 if (i < (cmd_text.cursize-1) && (text[i] == '\\' && (text[i+1] == '"' || text[i+1] == '\\')))
349 if(text[i] == '/' && text[i + 1] == '/' && (i == 0 || ISWHITESPACE(text[i-1])))
352 break; // don't break if inside a quoted string or comment
356 if (text[i] == '\r' || text[i] == '\n')
360 // better than CRASHING on overlong input lines that may SOMEHOW enter the buffer
361 if(i >= MAX_INPUTLINE)
363 Con_Printf("Warning: console input buffer had an overlong line. Ignored.\n");
368 memcpy (line, text, comment ? (comment - text) : i);
369 line[comment ? (comment - text) : i] = 0;
372 // delete the text from the command buffer and move remaining commands down
373 // this is necessary because commands (exec, alias) can insert data at the
374 // beginning of the text buffer
376 if (i == cmd_text.cursize)
377 cmd_text.cursize = 0;
381 cmd_text.cursize -= i;
382 memmove (cmd_text.data, text+i, cmd_text.cursize);
385 // execute the command line
387 while(*firstchar && ISWHITESPACE(*firstchar))
390 (strncmp(firstchar, "alias", 5) || !ISWHITESPACE(firstchar[5]))
392 (strncmp(firstchar, "bind", 4) || !ISWHITESPACE(firstchar[4]))
394 (strncmp(firstchar, "in_bind", 7) || !ISWHITESPACE(firstchar[7]))
397 Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
398 Cmd_ExecuteString (preprocessed, src_command, false);
402 Cmd_ExecuteString (line, src_command, false);
406 { // skip out while text still remains in buffer, leaving it
413 SV_UnlockThreadMutex();
414 Cbuf_UnlockThreadMutex();
418 ==============================================================================
422 ==============================================================================
429 Adds command line parameters as script statements
430 Commands lead with a +, and continue until a - or another +
431 quake +prog jctest.qp +cmd amlev1
432 quake -nosound +cmd amlev1
435 qboolean host_stuffcmdsrun = false;
436 static void Cmd_StuffCmds_f (void)
439 // this is for all commandline options combined (and is bounds checked)
440 char build[MAX_INPUTLINE];
442 if (Cmd_Argc () != 1)
444 Con_Print("stuffcmds : execute command line parameters\n");
448 // no reason to run the commandline arguments twice
449 if (host_stuffcmdsrun)
452 host_stuffcmdsrun = true;
455 for (i = 0;i < com_argc;i++)
457 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)
460 while (com_argv[i][j])
461 build[l++] = com_argv[i][j++];
463 for (;i < com_argc;i++)
467 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
469 if (l + strlen(com_argv[i]) + 4 > sizeof(build) - 1)
472 if (strchr(com_argv[i], ' '))
474 for (j = 0;com_argv[i][j];j++)
475 build[l++] = com_argv[i][j];
476 if (strchr(com_argv[i], ' '))
483 // now terminate the combined string and prepend it to the command buffer
484 // we already reserved space for the terminator
486 Cbuf_InsertText (build);
489 static void Cmd_Exec(const char *filename)
492 qboolean isdefaultcfg = strlen(filename) >= 11 && !strcmp(filename + strlen(filename) - 11, "default.cfg");
494 if (!strcmp(filename, "config.cfg"))
496 filename = CONFIGFILENAME;
497 if (COM_CheckParm("-noconfig"))
498 return; // don't execute config.cfg
501 f = (char *)FS_LoadFile (filename, tempmempool, false, NULL);
504 Con_Printf("couldn't exec %s\n",filename);
507 Con_Printf("execing %s\n",filename);
509 // if executing default.cfg for the first time, lock the cvar defaults
510 // it may seem backwards to insert this text BEFORE the default.cfg
511 // but Cbuf_InsertText inserts before, so this actually ends up after it.
513 Cbuf_InsertText("\ncvar_lockdefaults\n");
515 // insert newline after the text to make sure the last line is terminated (some text editors omit the trailing newline)
516 // (note: insertion order here is backwards from execution order, so this adds it after the text, by calling it before...)
517 Cbuf_InsertText ("\n");
523 // special defaults for specific games go here, these execute before default.cfg
524 // Nehahra pushable crates malfunction in some levels if this is on
525 // Nehahra NPC AI is confused by blowupfallenzombies
526 if (gamemode == GAME_NEHAHRA)
527 Cbuf_InsertText("\nsv_gameplayfix_upwardvelocityclearsongroundflag 0\nsv_gameplayfix_blowupfallenzombies 0\n\n");
528 // 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.
529 // 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
530 // hipnotic mission pack has issues in their proximity mine sticking code, which causes them to bounce off.
531 if (gamemode == GAME_HIPNOTIC)
532 Cbuf_InsertText("\nsv_gameplayfix_blowupfallenzombies 0\nsys_ticrate 0.02\nsv_gameplayfix_slidemoveprojectiles 0\n\n");
533 // rogue mission pack has a guardian boss that does not wake up if findradius returns one of the entities around its spawn area
534 if (gamemode == GAME_ROGUE)
535 Cbuf_InsertText("\nsv_gameplayfix_findradiusdistancetobox 0\n\n");
536 if (gamemode == GAME_NEXUIZ)
537 Cbuf_InsertText("\nsv_gameplayfix_q2airaccelerate 1\nsv_gameplayfix_stepmultipletimes 1\n\n");
538 if (gamemode == GAME_TENEBRAE)
539 Cbuf_InsertText("\nr_shadow_gloss 2\nr_shadow_bumpscale_basetexture 4\n\n");
540 // Steel Storm: Burning Retribution csqc misinterprets CSQC_InputEvent if type is a value other than 0 or 1
541 if (gamemode == GAME_STEELSTORM)
542 Cbuf_InsertText("\ncl_csqc_generatemousemoveevents 0\n\n");
551 static void Cmd_Exec_f (void)
556 if (Cmd_Argc () != 2)
558 Con_Print("exec <filename> : execute a script file\n");
562 s = FS_Search(Cmd_Argv(1), true, true);
563 if(!s || !s->numfilenames)
565 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
569 for(i = 0; i < s->numfilenames; ++i)
570 Cmd_Exec(s->filenames[i]);
580 Just prints the rest of the line to the console
583 static void Cmd_Echo_f (void)
587 for (i=1 ; i<Cmd_Argc() ; i++)
588 Con_Printf("%s ",Cmd_Argv(i));
593 // Support Doom3-style Toggle Console Command
598 Toggles a specified console variable amongst the values specified (default is 0 and 1)
601 static void Cmd_Toggle_f(void)
603 // Acquire Number of Arguments
604 int nNumArgs = Cmd_Argc();
607 // No Arguments Specified; Print Usage
608 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");
610 { // Correct Arguments Specified
611 // Acquire Potential CVar
612 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
619 Cvar_SetValueQuick(cvCVar, 0);
621 Cvar_SetValueQuick(cvCVar, 1);
625 { // 0 and Specified Usage
626 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
627 // CVar is Specified Value; // Reset to 0
628 Cvar_SetValueQuick(cvCVar, 0);
630 if(cvCVar->integer == 0)
631 // CVar is 0; Specify Value
632 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
634 // CVar does not match; Reset to 0
635 Cvar_SetValueQuick(cvCVar, 0);
638 { // Variable Values Specified
642 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
643 { // Cycle through Values
644 if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
645 { // Current Value Located; Increment to Next
646 if( (nCnt + 1) == nNumArgs)
647 // Max Value Reached; Reset
648 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
651 Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
660 // Value not Found; Reset to Original
661 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
667 Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(1) );
676 Creates a new command that executes a command string (possibly ; seperated)
679 static void Cmd_Alias_f (void)
682 char cmd[MAX_INPUTLINE];
689 Con_Print("Current alias commands:\n");
690 for (a = cmd_alias ; a ; a=a->next)
691 Con_Printf("%s : %s", a->name, a->value);
696 if (strlen(s) >= MAX_ALIAS_NAME)
698 Con_Print("Alias name is too long\n");
702 // if the alias already exists, reuse it
703 for (a = cmd_alias ; a ; a=a->next)
705 if (!strcmp(s, a->name))
714 cmdalias_t *prev, *current;
716 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
717 strlcpy (a->name, s, sizeof (a->name));
718 // insert it at the right alphanumeric position
719 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
730 // copy the rest of the command line
731 cmd[0] = 0; // start out with a null string
733 for (i=2 ; i < c ; i++)
736 strlcat (cmd, " ", sizeof (cmd));
737 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
739 strlcat (cmd, "\n", sizeof (cmd));
741 alloclen = strlen (cmd) + 1;
743 cmd[alloclen - 2] = '\n'; // to make sure a newline is appended even if too long
744 a->value = (char *)Z_Malloc (alloclen);
745 memcpy (a->value, cmd, alloclen);
752 Remove existing aliases.
755 static void Cmd_UnAlias_f (void)
763 Con_Print("unalias: Usage: unalias alias1 [alias2 ...]\n");
767 for(i = 1; i < Cmd_Argc(); ++i)
771 for(a = cmd_alias; a; p = a, a = a->next)
773 if(!strcmp(s, a->name))
775 if (a->initstate) // we can not remove init aliases
787 Con_Printf("unalias: %s alias not found\n", s);
792 =============================================================================
796 =============================================================================
799 typedef struct cmd_function_s
801 struct cmd_function_s *next;
803 const char *description;
804 xcommand_t consolefunction;
805 xcommand_t clientfunction;
807 qboolean initstate; // indicates this command existed at init
811 static const char *cmd_argv[MAX_ARGS];
812 static const char *cmd_null_string = "";
813 static const char *cmd_args;
814 cmd_source_t cmd_source;
817 static cmd_function_t *cmd_functions; // possible commands to execute
819 static const char *Cmd_GetDirectCvarValue(const char *varname, cmdalias_t *alias, qboolean *is_multiple)
827 *is_multiple = false;
829 if(!varname || !*varname)
834 if(!strcmp(varname, "*"))
840 else if(!strcmp(varname, "#"))
842 return va(vabuf, sizeof(vabuf), "%d", Cmd_Argc());
844 else if(varname[strlen(varname) - 1] == '-')
846 argno = strtol(varname, &endptr, 10);
847 if(endptr == varname + strlen(varname) - 1)
849 // whole string is a number, apart from the -
850 const char *p = Cmd_Args();
851 for(; argno > 1; --argno)
852 if(!COM_ParseToken_Console(&p))
859 // kill pre-argument whitespace
860 for (;*p && ISWHITESPACE(*p);p++)
869 argno = strtol(varname, &endptr, 10);
872 // whole string is a number
873 // NOTE: we already made sure we don't have an empty cvar name!
874 if(argno >= 0 && argno < Cmd_Argc())
875 return Cmd_Argv(argno);
880 if((cvar = Cvar_FindVar(varname)) && !(cvar->flags & CVAR_PRIVATE))
886 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes)
888 qboolean quote_quot = !!strchr(quoteset, '"');
889 qboolean quote_backslash = !!strchr(quoteset, '\\');
890 qboolean quote_dollar = !!strchr(quoteset, '$');
899 *out++ = '"'; --outlen;
905 if(*in == '"' && quote_quot)
909 *out++ = '\\'; --outlen;
910 *out++ = '"'; --outlen;
912 else if(*in == '\\' && quote_backslash)
916 *out++ = '\\'; --outlen;
917 *out++ = '\\'; --outlen;
919 else if(*in == '$' && quote_dollar)
923 *out++ = '$'; --outlen;
924 *out++ = '$'; --outlen;
930 *out++ = *in; --outlen;
945 static const char *Cmd_GetCvarValue(const char *var, size_t varlen, cmdalias_t *alias)
947 static char varname[MAX_INPUTLINE]; // cmd_mutex
948 static char varval[MAX_INPUTLINE]; // cmd_mutex
951 static char asis[] = "asis"; // just to suppress const char warnings
953 if(varlen >= MAX_INPUTLINE)
954 varlen = MAX_INPUTLINE - 1;
955 memcpy(varname, var, varlen);
957 varfunc = strchr(varname, ' ');
973 if(varname[0] == '$')
974 varstr = Cmd_GetDirectCvarValue(Cmd_GetDirectCvarValue(varname + 1, alias, NULL), alias, NULL);
977 qboolean is_multiple = false;
978 // Exception: $* and $n- don't use the quoted form by default
979 varstr = Cmd_GetDirectCvarValue(varname, alias, &is_multiple);
988 Con_Printf("Warning: Could not expand $%s in alias %s\n", varname, alias->name);
990 Con_Printf("Warning: Could not expand $%s\n", varname);
994 if(!varfunc || !strcmp(varfunc, "q")) // note: quoted form is default, use "asis" to override!
996 // quote it so it can be used inside double quotes
997 // we just need to replace " by \", and of course, double backslashes
998 Cmd_QuoteString(varval, sizeof(varval), varstr, "\"\\", false);
1001 else if(!strcmp(varfunc, "asis"))
1006 Con_Printf("Unknown variable function %s\n", varfunc);
1012 Cmd_PreprocessString
1014 Preprocesses strings and replaces $*, $param#, $cvar accordingly. Also strips comments.
1016 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
1022 // don't crash if there's no room in the outtext buffer
1023 if( maxoutlen == 0 ) {
1026 maxoutlen--; // because of \0
1031 while( *in && outlen < maxoutlen ) {
1033 // this is some kind of expansion, see what comes after the $
1036 // The console does the following preprocessing:
1038 // - $$ is transformed to a single dollar sign.
1039 // - $var or ${var} are expanded to the contents of the named cvar,
1040 // with quotation marks and backslashes quoted so it can safely
1041 // be used inside quotation marks (and it should always be used
1043 // - ${var asis} inserts the cvar value as is, without doing this
1045 // - prefix the cvar name with a dollar sign to do indirection;
1046 // for example, if $x has the value timelimit, ${$x} will return
1047 // the value of $timelimit
1048 // - when expanding an alias, the special variable name $* refers
1049 // to all alias parameters, and a number refers to that numbered
1050 // alias parameter, where the name of the alias is $0, the first
1051 // parameter is $1 and so on; as a special case, $* inserts all
1052 // parameters, without extra quoting, so one can use $* to just
1053 // pass all parameters around. All parameters starting from $n
1054 // can be referred to as $n- (so $* is equivalent to $1-).
1056 // Note: when expanding an alias, cvar expansion is done in the SAME step
1057 // as alias expansion so that alias parameters or cvar values containing
1058 // dollar signs have no unwanted bad side effects. However, this needs to
1059 // be accounted for when writing complex aliases. For example,
1060 // alias foo "set x NEW; echo $x"
1061 // actually expands to
1062 // "set x NEW; echo OLD"
1063 // and will print OLD! To work around this, use a second alias:
1064 // alias foo "set x NEW; foo2"
1065 // alias foo2 "echo $x"
1067 // Also note: lines starting with alias are exempt from cvar expansion.
1068 // If you want cvar expansion, write "alias" instead:
1071 // alias foo "echo $x"
1072 // "alias" bar "echo $x"
1075 // foo will print 2, because the variable $x will be expanded when the alias
1076 // gets expanded. bar will print 1, because the variable $x was expanded
1077 // at definition time. foo can be equivalently defined as
1079 // "alias" foo "echo $$x"
1081 // because at definition time, $$ will get replaced to a single $.
1086 } else if(*in == '{') {
1087 varlen = strcspn(in + 1, "}");
1088 if(in[varlen + 1] == '}')
1090 val = Cmd_GetCvarValue(in + 1, varlen, alias);
1100 varlen = strspn(in, "#*0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_-");
1101 val = Cmd_GetCvarValue(in, varlen, alias);
1106 // insert the cvar value
1107 while(*val && outlen < maxoutlen)
1108 outtext[outlen++] = *val++;
1113 // copy the unexpanded text
1114 outtext[outlen++] = '$';
1115 while(eat && outlen < maxoutlen)
1117 outtext[outlen++] = *in++;
1123 outtext[outlen++] = *in++;
1125 outtext[outlen] = 0;
1132 Called for aliases and fills in the alias into the cbuffer
1135 static void Cmd_ExecuteAlias (cmdalias_t *alias)
1137 static char buffer[ MAX_INPUTLINE ]; // cmd_mutex
1138 static char buffer2[ MAX_INPUTLINE ]; // cmd_mutex
1139 Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
1140 // insert at start of command buffer, so that aliases execute in order
1141 // (fixes bug introduced by Black on 20050705)
1143 // Note: Cbuf_PreprocessString will be called on this string AGAIN! So we
1144 // have to make sure that no second variable expansion takes place, otherwise
1145 // alias parameters containing dollar signs can have bad effects.
1146 Cmd_QuoteString(buffer2, sizeof(buffer2), buffer, "$", false);
1147 Cbuf_InsertText( buffer2 );
1154 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
1155 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
1159 static void Cmd_List_f (void)
1161 cmd_function_t *cmd;
1162 const char *partial;
1169 partial = Cmd_Argv (1);
1170 len = strlen(partial);
1178 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1181 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1183 if (partial && (ispattern ? !matchpattern_with_separator(cmd->name, partial, false, "", false) : strncmp(partial, cmd->name, len)))
1185 Con_Printf("%s : %s\n", cmd->name, cmd->description);
1192 Con_Printf("%i Command%s matching \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1194 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
1197 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
1200 static void Cmd_Apropos_f(void)
1202 cmd_function_t *cmd;
1205 const char *partial;
1211 partial = Cmd_Args();
1214 Con_Printf("usage: apropos <string>\n");
1218 ispattern = partial && (strchr(partial, '*') || strchr(partial, '?'));
1220 partial = va(vabuf, sizeof(vabuf), "*%s*", partial);
1223 for (cvar = cvar_vars; cvar; cvar = cvar->next)
1225 if (!matchpattern_with_separator(cvar->name, partial, true, "", false))
1226 if (!matchpattern_with_separator(cvar->description, partial, true, "", false))
1228 Con_Printf ("cvar ^3%s^7 is \"%s\" [\"%s\"] %s\n", cvar->name, cvar->string, cvar->defstring, cvar->description);
1231 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1233 if (!matchpattern_with_separator(cmd->name, partial, true, "", false))
1234 if (!matchpattern_with_separator(cmd->description, partial, true, "", false))
1236 Con_Printf("command ^2%s^7: %s\n", cmd->name, cmd->description);
1239 for (alias = cmd_alias; alias; alias = alias->next)
1241 // procede here a bit differently as an alias value always got a final \n
1242 if (!matchpattern_with_separator(alias->name, partial, true, "", false))
1243 if (!matchpattern_with_separator(alias->value, partial, true, "\n", false)) // when \n is as separator wildcards don't match it
1245 Con_Printf("alias ^5%s^7: %s", alias->name, alias->value); // do not print an extra \n
1248 Con_Printf("%i result%s\n\n", count, (count > 1) ? "s" : "");
1256 void Cmd_Init (void)
1258 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
1259 // space for commands and script files
1260 cmd_text.data = cmd_text_buf;
1261 cmd_text.maxsize = sizeof(cmd_text_buf);
1262 cmd_text.cursize = 0;
1264 if (Thread_HasThreads())
1265 cmd_text_mutex = Thread_CreateMutex();
1268 void Cmd_Init_Commands (void)
1271 // register our commands
1273 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
1274 Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
1275 Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
1276 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");
1277 Cmd_AddCommand ("unalias",Cmd_UnAlias_f, "remove an alias");
1278 Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
1279 Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
1280 Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
1281 Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
1282 Cmd_AddCommand ("unset", Cvar_Del_f, "delete a cvar (does not work for static ones like _cl_name, or read-only ones)");
1283 #ifdef FILLALLCVARSWITHRUBBISH
1284 Cmd_AddCommand ("fillallcvarswithrubbish", Cvar_FillAll_f, "fill all cvars with a specified number of characters to provoke buffer overruns");
1285 #endif /* FILLALLCVARSWITHRUBBISH */
1287 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
1288 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
1289 Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix or matching the specified wildcard pattern");
1290 Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix or matching the specified wildcard pattern");
1291 Cmd_AddCommand ("apropos", Cmd_Apropos_f, "lists all console variables/commands/aliases containing the specified string in the name or description");
1293 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");
1294 Cmd_AddCommand ("cvar_resettodefaults_all", Cvar_ResetToDefaults_All_f, "sets all cvars to their locked default values");
1295 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)");
1296 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)");
1298 Cmd_AddCommand ("cprint", Cmd_Centerprint_f, "print something at the screen center");
1299 Cmd_AddCommand ("defer", Cmd_Defer_f, "execute a command in the future");
1302 // Support Doom3-style Toggle Command
1303 Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
1311 void Cmd_Shutdown(void)
1315 // we usually have this locked when we get here from Host_Quit_f
1316 Cbuf_UnlockThreadMutex();
1317 Thread_DestroyMutex(cmd_text_mutex);
1319 cmd_text_mutex = NULL;
1321 Mem_FreePool(&cmd_mempool);
1339 const char *Cmd_Argv (int arg)
1341 if (arg >= cmd_argc )
1342 return cmd_null_string;
1343 return cmd_argv[arg];
1351 const char *Cmd_Args (void)
1361 Parses the given string into command line tokens.
1364 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
1365 static void Cmd_TokenizeString (const char *text)
1374 // skip whitespace up to a /n
1375 while (*text && ISWHITESPACE(*text) && *text != '\r' && *text != '\n')
1382 if (*text == '\n' || *text == '\r')
1384 // a newline separates commands in the buffer
1385 if (*text == '\r' && text[1] == '\n')
1397 if (!COM_ParseToken_Console(&text))
1400 if (cmd_argc < MAX_ARGS)
1402 l = (int)strlen(com_token) + 1;
1403 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
1405 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
1408 memcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token, l);
1409 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
1410 cmd_tokenizebufferpos += l;
1422 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description)
1424 cmd_function_t *cmd;
1425 cmd_function_t *prev, *current;
1427 // fail if the command is a variable name
1428 if (Cvar_FindVar( cmd_name ))
1430 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
1434 // fail if the command already exists
1435 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1437 if (!strcmp (cmd_name, cmd->name))
1439 if (consolefunction || clientfunction)
1441 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
1446 cmd->csqcfunc = true;
1452 cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
1453 cmd->name = cmd_name;
1454 cmd->consolefunction = consolefunction;
1455 cmd->clientfunction = clientfunction;
1456 cmd->description = description;
1457 if(!consolefunction && !clientfunction) //[515]: csqc
1458 cmd->csqcfunc = true;
1459 cmd->next = cmd_functions;
1461 // insert it at the right alphanumeric position
1462 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
1467 cmd_functions = cmd;
1469 cmd->next = current;
1472 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
1474 Cmd_AddCommand_WithClientCommand (cmd_name, function, NULL, description);
1482 qboolean Cmd_Exists (const char *cmd_name)
1484 cmd_function_t *cmd;
1486 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1487 if (!strcmp (cmd_name,cmd->name))
1499 const char *Cmd_CompleteCommand (const char *partial)
1501 cmd_function_t *cmd;
1504 len = strlen(partial);
1510 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1511 if (!strncasecmp(partial, cmd->name, len))
1518 Cmd_CompleteCountPossible
1520 New function for tab-completion system
1521 Added by EvilTypeGuy
1522 Thanks to Fett erich@heintz.com
1526 int Cmd_CompleteCountPossible (const char *partial)
1528 cmd_function_t *cmd;
1533 len = strlen(partial);
1538 // Loop through the command list and count all partial matches
1539 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1540 if (!strncasecmp(partial, cmd->name, len))
1547 Cmd_CompleteBuildList
1549 New function for tab-completion system
1550 Added by EvilTypeGuy
1551 Thanks to Fett erich@heintz.com
1555 const char **Cmd_CompleteBuildList (const char *partial)
1557 cmd_function_t *cmd;
1560 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
1563 len = strlen(partial);
1564 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1565 // Loop through the alias list and print all matches
1566 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1567 if (!strncasecmp(partial, cmd->name, len))
1568 buf[bpos++] = cmd->name;
1574 // written by LordHavoc
1575 void Cmd_CompleteCommandPrint (const char *partial)
1577 cmd_function_t *cmd;
1578 size_t len = strlen(partial);
1579 // Loop through the command list and print all matches
1580 for (cmd = cmd_functions; cmd; cmd = cmd->next)
1581 if (!strncasecmp(partial, cmd->name, len))
1582 Con_Printf("^2%s^7: %s\n", cmd->name, cmd->description);
1588 New function for tab-completion system
1589 Added by EvilTypeGuy
1590 Thanks to Fett erich@heintz.com
1594 const char *Cmd_CompleteAlias (const char *partial)
1599 len = strlen(partial);
1605 for (alias = cmd_alias; alias; alias = alias->next)
1606 if (!strncasecmp(partial, alias->name, len))
1612 // written by LordHavoc
1613 void Cmd_CompleteAliasPrint (const char *partial)
1616 size_t len = strlen(partial);
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 Con_Printf("^5%s^7: %s", alias->name, alias->value);
1625 Cmd_CompleteAliasCountPossible
1627 New function for tab-completion system
1628 Added by EvilTypeGuy
1629 Thanks to Fett erich@heintz.com
1633 int Cmd_CompleteAliasCountPossible (const char *partial)
1641 len = strlen(partial);
1646 // Loop through the command list and count all partial matches
1647 for (alias = cmd_alias; alias; alias = alias->next)
1648 if (!strncasecmp(partial, alias->name, len))
1655 Cmd_CompleteAliasBuildList
1657 New function for tab-completion system
1658 Added by EvilTypeGuy
1659 Thanks to Fett erich@heintz.com
1663 const char **Cmd_CompleteAliasBuildList (const char *partial)
1668 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1671 len = strlen(partial);
1672 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1673 // Loop through the alias list and print all matches
1674 for (alias = cmd_alias; alias; alias = alias->next)
1675 if (!strncasecmp(partial, alias->name, len))
1676 buf[bpos++] = alias->name;
1682 void Cmd_ClearCsqcFuncs (void)
1684 cmd_function_t *cmd;
1685 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1686 cmd->csqcfunc = false;
1693 A complete command line has been parsed, so try to execute it
1694 FIXME: lookupnoadd the token to speed search?
1697 void Cmd_ExecuteString (const char *text, cmd_source_t src, qboolean lockmutex)
1701 cmd_function_t *cmd;
1705 Cbuf_LockThreadMutex();
1706 oldpos = cmd_tokenizebufferpos;
1710 Cmd_TokenizeString (text);
1712 // execute the command line
1714 goto done; // no tokens
1717 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1719 if (!strcasecmp (cmd_argv[0],cmd->name))
1721 if (cmd->csqcfunc && CL_VM_ConsoleCommand (text)) //[515]: csqc
1726 if (cmd->consolefunction)
1727 cmd->consolefunction ();
1728 else if (cmd->clientfunction)
1730 if (cls.state == ca_connected)
1732 // forward remote commands to the server for execution
1733 Cmd_ForwardToServer();
1736 Con_Printf("Can not send command \"%s\", not connected.\n", Cmd_Argv(0));
1739 Con_Printf("Command \"%s\" can not be executed\n", Cmd_Argv(0));
1743 if (cmd->clientfunction)
1745 cmd->clientfunction ();
1755 // if it's a client command and no command was found, say so.
1756 if (cmd_source == src_client)
1758 Con_Printf("player \"%s\" tried to %s\n", host_client->name, text);
1763 for (a=cmd_alias ; a ; a=a->next)
1765 if (!strcasecmp (cmd_argv[0], a->name))
1767 Cmd_ExecuteAlias(a);
1772 if(found) // if the command was hooked and found, all is good
1776 if (!Cvar_Command () && host_framecount > 0)
1777 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1780 cmd_tokenizebufferpos = oldpos;
1782 Cbuf_UnlockThreadMutex();
1788 Cmd_ForwardStringToServer
1790 Sends an entire command string over to the server, unprocessed
1793 void Cmd_ForwardStringToServer (const char *s)
1796 if (cls.state != ca_connected)
1798 Con_Printf("Can't \"%s\", not connected\n", s);
1805 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1806 // attention, it has been eradicated from here, its only (former) use in
1807 // all of darkplaces.
1808 if (cls.protocol == PROTOCOL_QUAKEWORLD)
1809 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1811 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1812 if ((!strncmp(s, "say ", 4) || !strncmp(s, "say_team ", 9)) && cl_locs_enable.integer)
1814 // say/say_team commands can replace % character codes with status info
1817 if (*s == '%' && s[1])
1819 // handle proquake message macros
1823 case 'l': // current location
1824 CL_Locs_FindLocationName(temp, sizeof(temp), cl.movement_origin);
1826 case 'h': // current health
1827 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_HEALTH]);
1829 case 'a': // current armor
1830 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ARMOR]);
1832 case 'x': // current rockets
1833 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_ROCKETS]);
1835 case 'c': // current cells
1836 dpsnprintf(temp, sizeof(temp), "%i", cl.stats[STAT_CELLS]);
1838 // silly proquake macros
1839 case 'd': // loc at last death
1840 CL_Locs_FindLocationName(temp, sizeof(temp), cl.lastdeathorigin);
1842 case 't': // current time
1843 dpsnprintf(temp, sizeof(temp), "%.0f:%.0f", floor(cl.time / 60), cl.time - floor(cl.time / 60) * 60);
1845 case 'r': // rocket launcher status ("I have RL", "I need rockets", "I need RL")
1846 if (!(cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER))
1847 dpsnprintf(temp, sizeof(temp), "I need RL");
1848 else if (!cl.stats[STAT_ROCKETS])
1849 dpsnprintf(temp, sizeof(temp), "I need rockets");
1851 dpsnprintf(temp, sizeof(temp), "I have RL");
1853 case 'p': // powerup status (outputs "quad" "pent" and "eyes" according to status)
1854 if (cl.stats[STAT_ITEMS] & IT_QUAD)
1857 strlcat(temp, " ", sizeof(temp));
1858 strlcat(temp, "quad", sizeof(temp));
1860 if (cl.stats[STAT_ITEMS] & IT_INVULNERABILITY)
1863 strlcat(temp, " ", sizeof(temp));
1864 strlcat(temp, "pent", sizeof(temp));
1866 if (cl.stats[STAT_ITEMS] & IT_INVISIBILITY)
1869 strlcat(temp, " ", sizeof(temp));
1870 strlcat(temp, "eyes", sizeof(temp));
1873 case 'w': // weapon status (outputs "SSG:NG:SNG:GL:RL:LG" with the text between : characters omitted if you lack the weapon)
1874 if (cl.stats[STAT_ITEMS] & IT_SUPER_SHOTGUN)
1875 strlcat(temp, "SSG", sizeof(temp));
1876 strlcat(temp, ":", sizeof(temp));
1877 if (cl.stats[STAT_ITEMS] & IT_NAILGUN)
1878 strlcat(temp, "NG", sizeof(temp));
1879 strlcat(temp, ":", sizeof(temp));
1880 if (cl.stats[STAT_ITEMS] & IT_SUPER_NAILGUN)
1881 strlcat(temp, "SNG", sizeof(temp));
1882 strlcat(temp, ":", sizeof(temp));
1883 if (cl.stats[STAT_ITEMS] & IT_GRENADE_LAUNCHER)
1884 strlcat(temp, "GL", sizeof(temp));
1885 strlcat(temp, ":", sizeof(temp));
1886 if (cl.stats[STAT_ITEMS] & IT_ROCKET_LAUNCHER)
1887 strlcat(temp, "RL", sizeof(temp));
1888 strlcat(temp, ":", sizeof(temp));
1889 if (cl.stats[STAT_ITEMS] & IT_LIGHTNING)
1890 strlcat(temp, "LG", sizeof(temp));
1893 // not a recognized macro, print it as-is...
1899 // write the resulting text
1900 SZ_Write(&cls.netcon->message, (unsigned char *)temp, strlen(temp));
1904 MSG_WriteByte(&cls.netcon->message, *s);
1907 MSG_WriteByte(&cls.netcon->message, 0);
1909 else // any other command is passed on as-is
1910 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1917 Sends the entire command line over to the server
1920 void Cmd_ForwardToServer (void)
1924 if (!strcasecmp(Cmd_Argv(0), "cmd"))
1926 // we want to strip off "cmd", so just send the args
1927 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1931 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1932 s = va(vabuf, sizeof(vabuf), "%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1934 // don't send an empty forward message if the user tries "cmd" by itself
1937 Cmd_ForwardStringToServer(s);
1945 Returns the position (1 to argc-1) in the command's argument list
1946 where the given parameter apears, or 0 if not present
1950 int Cmd_CheckParm (const char *parm)
1956 Con_Printf ("Cmd_CheckParm: NULL");
1960 for (i = 1; i < Cmd_Argc (); i++)
1961 if (!strcasecmp (parm, Cmd_Argv (i)))
1969 void Cmd_SaveInitState(void)
1973 for (f = cmd_functions;f;f = f->next)
1974 f->initstate = true;
1975 for (a = cmd_alias;a;a = a->next)
1977 a->initstate = true;
1978 a->initialvalue = Mem_strdup(zonemempool, a->value);
1980 Cvar_SaveInitState();
1983 void Cmd_RestoreInitState(void)
1985 cmd_function_t *f, **fp;
1986 cmdalias_t *a, **ap;
1987 for (fp = &cmd_functions;(f = *fp);)
1993 // destroy this command, it didn't exist at init
1994 Con_DPrintf("Cmd_RestoreInitState: Destroying command %s\n", f->name);
1999 for (ap = &cmd_alias;(a = *ap);)
2003 // restore this alias, it existed at init
2004 if (strcmp(a->value ? a->value : "", a->initialvalue ? a->initialvalue : ""))
2006 Con_DPrintf("Cmd_RestoreInitState: Restoring alias %s\n", a->name);
2009 a->value = Mem_strdup(zonemempool, a->initialvalue);
2015 // free this alias, it didn't exist at init...
2016 Con_DPrintf("Cmd_RestoreInitState: Destroying alias %s\n", a->name);
2023 Cvar_RestoreInitState();