2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // cmd.c -- Quake script command processing module
24 #define MAX_ALIAS_NAME 32
25 // this is the largest script file that can be executed in one step
26 // LordHavoc: inreased this from 8192 to 32768
27 #define CMDBUFSIZE 32768
28 // maximum number of parameters to a command
30 // maximum tokenizable commandline length (counting NUL terminations)
31 #define CMD_TOKENIZELENGTH (MAX_INPUTLINE + 80)
33 typedef struct cmdalias_s
35 struct cmdalias_s *next;
36 char name[MAX_ALIAS_NAME];
40 static cmdalias_t *cmd_alias;
42 static qboolean cmd_wait;
44 static mempool_t *cmd_mempool;
46 static char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
47 static int cmd_tokenizebufferpos = 0;
49 //=============================================================================
55 Causes execution of the remainder of the command buffer to be delayed until
56 next frame. This allows commands like:
57 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
60 static void Cmd_Wait_f (void)
66 =============================================================================
70 =============================================================================
73 static sizebuf_t cmd_text;
74 static unsigned char cmd_text_buf[CMDBUFSIZE];
80 Adds command text at the end of the buffer
83 void Cbuf_AddText (const char *text)
87 l = (int)strlen (text);
89 if (cmd_text.cursize + l >= cmd_text.maxsize)
91 Con_Print("Cbuf_AddText: overflow\n");
95 SZ_Write (&cmd_text, (const unsigned char *)text, (int)strlen (text));
103 Adds command text immediately after the current command
104 Adds a \n to the text
105 FIXME: actually change the command buffer to do less copying
108 void Cbuf_InsertText (const char *text)
113 // copy off any commands still remaining in the exec buffer
114 templen = cmd_text.cursize;
117 temp = (char *)Mem_Alloc (tempmempool, templen);
118 memcpy (temp, cmd_text.data, templen);
119 SZ_Clear (&cmd_text);
124 // add the entire text of the file
127 // add the copied off data
130 SZ_Write (&cmd_text, (const unsigned char *)temp, templen);
140 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias );
141 void Cbuf_Execute (void)
145 char line[MAX_INPUTLINE];
146 char preprocessed[MAX_INPUTLINE];
149 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
150 cmd_tokenizebufferpos = 0;
152 while (cmd_text.cursize)
154 // find a \n or ; line break
155 text = (char *)cmd_text.data;
158 for (i=0 ; i< cmd_text.cursize ; i++)
162 if ( !quotes && text[i] == ';')
163 break; // don't break if inside a quoted string
164 if (text[i] == '\r' || text[i] == '\n')
168 memcpy (line, text, i);
171 // delete the text from the command buffer and move remaining commands down
172 // this is necessary because commands (exec, alias) can insert data at the
173 // beginning of the text buffer
175 if (i == cmd_text.cursize)
176 cmd_text.cursize = 0;
180 cmd_text.cursize -= i;
181 memcpy (cmd_text.data, text+i, cmd_text.cursize);
184 // execute the command line
185 Cmd_PreprocessString( line, preprocessed, sizeof(preprocessed), NULL );
186 Cmd_ExecuteString (preprocessed, src_command);
189 { // skip out while text still remains in buffer, leaving it
198 ==============================================================================
202 ==============================================================================
209 Adds command line parameters as script statements
210 Commands lead with a +, and continue until a - or another +
211 quake +prog jctest.qp +cmd amlev1
212 quake -nosound +cmd amlev1
215 qboolean host_stuffcmdsrun = false;
216 void Cmd_StuffCmds_f (void)
219 // this is per command, and bounds checked (no buffer overflows)
220 char build[MAX_INPUTLINE];
222 if (Cmd_Argc () != 1)
224 Con_Print("stuffcmds : execute command line parameters\n");
228 host_stuffcmdsrun = true;
229 for (i = 0;i < com_argc;i++)
231 if (com_argv[i] && com_argv[i][0] == '+' && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
235 while (com_argv[i][j])
236 build[l++] = com_argv[i][j++];
238 for (;i < com_argc;i++)
242 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
244 if (l + strlen(com_argv[i]) + 5 > sizeof(build))
248 for (j = 0;com_argv[i][j];j++)
249 build[l++] = com_argv[i][j];
254 Cbuf_InsertText (build);
266 static void Cmd_Exec_f (void)
270 if (Cmd_Argc () != 2)
272 Con_Print("exec <filename> : execute a script file\n");
276 f = (char *)FS_LoadFile (Cmd_Argv(1), tempmempool, false, NULL);
279 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
282 Con_DPrintf("execing %s\n",Cmd_Argv(1));
293 Just prints the rest of the line to the console
296 static void Cmd_Echo_f (void)
300 for (i=1 ; i<Cmd_Argc() ; i++)
301 Con_Printf("%s ",Cmd_Argv(i));
306 // Support Doom3-style Toggle Console Command
311 Toggles a specified console variable amongst the values specified (default is 0 and 1)
314 static void Cmd_Toggle_f(void)
316 // Acquire Number of Arguments
317 int nNumArgs = Cmd_Argc();
320 // No Arguments Specified; Print Usage
321 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");
323 { // Correct Arguments Specified
324 // Acquire Potential CVar
325 cvar_t* cvCVar = Cvar_FindVar( Cmd_Argv(1) );
332 Cvar_SetValueQuick(cvCVar, 0);
334 Cvar_SetValueQuick(cvCVar, 1);
338 { // 0 and Specified Usage
339 if(cvCVar->integer == atoi(Cmd_Argv(2) ) )
340 // CVar is Specified Value; // Reset to 0
341 Cvar_SetValueQuick(cvCVar, 0);
343 if(cvCVar->integer == 0)
344 // CVar is 0; Specify Value
345 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
347 // CVar does not match; Reset to 0
348 Cvar_SetValueQuick(cvCVar, 0);
351 { // Variable Values Specified
355 for(nCnt = 2; nCnt < nNumArgs; nCnt++)
356 { // Cycle through Values
357 if( strcmp(cvCVar->string, Cmd_Argv(nCnt) ) == 0)
358 { // Current Value Located; Increment to Next
359 if( (nCnt + 1) == nNumArgs)
360 // Max Value Reached; Reset
361 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
364 Cvar_SetQuick(cvCVar, Cmd_Argv(nCnt + 1) );
373 // Value not Found; Reset to Original
374 Cvar_SetQuick(cvCVar, Cmd_Argv(2) );
380 Con_Printf("ERROR : CVar '%s' not found\n", Cmd_Argv(2) );
389 Creates a new command that executes a command string (possibly ; seperated)
392 static void Cmd_Alias_f (void)
395 char cmd[MAX_INPUTLINE];
401 Con_Print("Current alias commands:\n");
402 for (a = cmd_alias ; a ; a=a->next)
403 Con_Printf("%s : %s\n", a->name, a->value);
408 if (strlen(s) >= MAX_ALIAS_NAME)
410 Con_Print("Alias name is too long\n");
414 // if the alias already exists, reuse it
415 for (a = cmd_alias ; a ; a=a->next)
417 if (!strcmp(s, a->name))
426 cmdalias_t *prev, *current;
428 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
429 strlcpy (a->name, s, sizeof (a->name));
430 // insert it at the right alphanumeric position
431 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
442 // copy the rest of the command line
443 cmd[0] = 0; // start out with a null string
445 for (i=2 ; i< c ; i++)
447 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
449 strlcat (cmd, " ", sizeof (cmd));
451 strlcat (cmd, "\n", sizeof (cmd));
453 a->value = (char *)Z_Malloc (strlen (cmd) + 1);
454 strcpy (a->value, cmd);
458 =============================================================================
462 =============================================================================
465 typedef struct cmd_function_s
467 struct cmd_function_s *next;
469 const char *description;
475 static const char *cmd_argv[MAX_ARGS];
476 static const char *cmd_null_string = "";
477 static const char *cmd_args;
478 cmd_source_t cmd_source;
481 static cmd_function_t *cmd_functions; // possible commands to execute
486 Preprocesses strings and replaces $*, $param#, $cvar accordingly
488 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
493 // don't crash if there's no room in the outtext buffer
494 if( maxoutlen == 0 ) {
497 maxoutlen--; // because of \0
503 while( *in && outlen < maxoutlen ) {
504 if( *in == '$' && !inquote ) {
505 // this is some kind of expansion, see what comes after the $
507 // replacements that can always be used:
508 // $$ is replaced with $, to allow escaping $
509 // $<cvarname> is replaced with the contents of the cvar
511 // the following can be used in aliases only:
512 // $* is replaced with all formal parameters (including name of the alias - this probably is not desirable)
513 // $0 is replaced with the name of this alias
514 // $<number> is replaced with an argument to this alias (or copied as-is if no such parameter exists), can be multiple digits
516 outtext[outlen++] = *in++;
517 } else if( *in == '*' && alias ) {
518 const char *linein = Cmd_Args();
520 // include all parameters
522 while( *linein && outlen < maxoutlen ) {
523 outtext[outlen++] = *linein++;
528 } else if( '0' <= *in && *in <= '9' && alias ) {
532 argnum = strtol( in, &nexttoken, 10 );
534 if( 0 <= argnum && argnum < Cmd_Argc() ) {
535 const char *param = Cmd_Argv( argnum );
536 while( *param && outlen < maxoutlen ) {
537 outtext[outlen++] = *param++;
540 } else if( argnum >= Cmd_Argc() ) {
541 Con_Printf( "Warning: Not enough parameters passed to alias '%s', at least %i expected:\n %s\n", alias->name, argnum, alias->value );
542 outtext[outlen++] = '$';
546 const char *tempin = in;
548 COM_ParseTokenConsole( &tempin );
549 if ((cvar = Cvar_FindVar(&com_token[0]))) {
550 const char *cvarcontent = cvar->string;
551 while( *cvarcontent && outlen < maxoutlen ) {
552 outtext[outlen++] = *cvarcontent++;
557 Con_Printf( "Warning: could not find cvar %s when expanding alias %s\n %s\n", com_token, alias->name, alias->value );
559 Con_Printf( "Warning: could not find cvar %s\n", com_token );
561 outtext[outlen++] = '$';
568 outtext[outlen++] = *in++;
578 Called for aliases and fills in the alias into the cbuffer
581 static void Cmd_ExecuteAlias (cmdalias_t *alias)
583 static char buffer[ MAX_INPUTLINE + 2 ];
584 Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
585 // insert at start of command buffer, so that aliases execute in order
586 // (fixes bug introduced by Black on 20050705)
587 Cbuf_InsertText( buffer );
594 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
595 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
599 static void Cmd_List_f (void)
607 partial = Cmd_Argv (1);
608 len = (int)strlen(partial);
617 for (cmd = cmd_functions; cmd; cmd = cmd->next)
619 if (partial && strncmp(partial, cmd->name, len))
621 Con_Printf("%s : %s\n", cmd->name, cmd->description);
626 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
628 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
638 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
639 // space for commands and script files
640 cmd_text.data = cmd_text_buf;
641 cmd_text.maxsize = sizeof(cmd_text_buf);
642 cmd_text.cursize = 0;
645 void Cmd_Init_Commands (void)
648 // register our commands
650 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
651 Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
652 Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
653 Cmd_AddCommand ("alias",Cmd_Alias_f, "create a script function (parameters are passed in as $1 through $9, and $* for all parameters)");
654 Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
655 Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
656 Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
657 Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
659 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
660 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
661 Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix");
662 Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix");
665 // Support Doom3-style Toggle Command
666 Cmd_AddCommand( "toggle", Cmd_Toggle_f, "toggles a console variable's values (use for more info)");
674 void Cmd_Shutdown(void)
676 Mem_FreePool(&cmd_mempool);
694 const char *Cmd_Argv (int arg)
696 if (arg >= cmd_argc )
697 return cmd_null_string;
698 return cmd_argv[arg];
706 const char *Cmd_Args (void)
716 Parses the given string into command line tokens.
719 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
720 static void Cmd_TokenizeString (const char *text)
729 // skip whitespace up to a /n
730 while (*text && *text <= ' ' && *text != '\r' && *text != '\n')
737 if (*text == '\n' || *text == '\r')
739 // a newline separates commands in the buffer
740 if (*text == '\r' && text[1] == '\n')
752 if (!COM_ParseTokenConsole(&text))
755 if (cmd_argc < MAX_ARGS)
757 l = (int)strlen(com_token) + 1;
758 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
760 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
763 strcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token);
764 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
765 cmd_tokenizebufferpos += l;
777 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
780 cmd_function_t *prev, *current;
782 // fail if the command is a variable name
783 if (Cvar_FindVar( cmd_name ))
785 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
789 // fail if the command already exists
790 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
792 if (!strcmp (cmd_name, cmd->name))
796 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
801 cmd->csqcfunc = true;
807 cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
808 cmd->name = cmd_name;
809 cmd->function = function;
810 cmd->description = description;
811 if(!function) //[515]: csqc
812 cmd->csqcfunc = true;
813 cmd->next = cmd_functions;
815 // insert it at the right alphanumeric position
816 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
831 qboolean Cmd_Exists (const char *cmd_name)
835 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
836 if (!strcmp (cmd_name,cmd->name))
848 const char *Cmd_CompleteCommand (const char *partial)
853 len = strlen(partial);
859 for (cmd = cmd_functions; cmd; cmd = cmd->next)
860 if (!strncasecmp(partial, cmd->name, len))
867 Cmd_CompleteCountPossible
869 New function for tab-completion system
871 Thanks to Fett erich@heintz.com
875 int Cmd_CompleteCountPossible (const char *partial)
882 len = strlen(partial);
887 // Loop through the command list and count all partial matches
888 for (cmd = cmd_functions; cmd; cmd = cmd->next)
889 if (!strncasecmp(partial, cmd->name, len))
896 Cmd_CompleteBuildList
898 New function for tab-completion system
900 Thanks to Fett erich@heintz.com
904 const char **Cmd_CompleteBuildList (const char *partial)
909 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
912 len = strlen(partial);
913 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
914 // Loop through the alias list and print all matches
915 for (cmd = cmd_functions; cmd; cmd = cmd->next)
916 if (!strncasecmp(partial, cmd->name, len))
917 buf[bpos++] = cmd->name;
923 // written by LordHavoc
924 void Cmd_CompleteCommandPrint (const char *partial)
927 size_t len = strlen(partial);
928 // Loop through the command list and print all matches
929 for (cmd = cmd_functions; cmd; cmd = cmd->next)
930 if (!strncasecmp(partial, cmd->name, len))
931 Con_Printf("%s : %s\n", cmd->name, cmd->description);
937 New function for tab-completion system
939 Thanks to Fett erich@heintz.com
943 const char *Cmd_CompleteAlias (const char *partial)
948 len = strlen(partial);
954 for (alias = cmd_alias; alias; alias = alias->next)
955 if (!strncasecmp(partial, alias->name, len))
961 // written by LordHavoc
962 void Cmd_CompleteAliasPrint (const char *partial)
965 size_t len = strlen(partial);
966 // Loop through the alias list and print all matches
967 for (alias = cmd_alias; alias; alias = alias->next)
968 if (!strncasecmp(partial, alias->name, len))
969 Con_Printf("%s : %s\n", alias->name, alias->value);
974 Cmd_CompleteAliasCountPossible
976 New function for tab-completion system
978 Thanks to Fett erich@heintz.com
982 int Cmd_CompleteAliasCountPossible (const char *partial)
990 len = strlen(partial);
995 // Loop through the command list and count all partial matches
996 for (alias = cmd_alias; alias; alias = alias->next)
997 if (!strncasecmp(partial, alias->name, len))
1004 Cmd_CompleteAliasBuildList
1006 New function for tab-completion system
1007 Added by EvilTypeGuy
1008 Thanks to Fett erich@heintz.com
1012 const char **Cmd_CompleteAliasBuildList (const char *partial)
1017 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
1020 len = strlen(partial);
1021 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
1022 // Loop through the alias list and print all matches
1023 for (alias = cmd_alias; alias; alias = alias->next)
1024 if (!strncasecmp(partial, alias->name, len))
1025 buf[bpos++] = alias->name;
1031 void Cmd_ClearCsqcFuncs (void)
1033 cmd_function_t *cmd;
1034 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1035 cmd->csqcfunc = false;
1038 qboolean CL_VM_ConsoleCommand (const char *cmd);
1043 A complete command line has been parsed, so try to execute it
1044 FIXME: lookupnoadd the token to speed search?
1047 void Cmd_ExecuteString (const char *text, cmd_source_t src)
1050 cmd_function_t *cmd;
1053 oldpos = cmd_tokenizebufferpos;
1056 Cmd_TokenizeString (text);
1058 // execute the command line
1061 cmd_tokenizebufferpos = oldpos;
1062 return; // no tokens
1066 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
1068 if (!strcasecmp (cmd_argv[0],cmd->name))
1070 if(cmd->function && !cmd->csqcfunc)
1073 if(CL_VM_ConsoleCommand (text)) //[515]: csqc
1078 cmd_tokenizebufferpos = oldpos;
1084 for (a=cmd_alias ; a ; a=a->next)
1086 if (!strcasecmp (cmd_argv[0], a->name))
1088 Cmd_ExecuteAlias(a);
1089 cmd_tokenizebufferpos = oldpos;
1095 if (!Cvar_Command () && host_framecount > 0)
1096 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1098 cmd_tokenizebufferpos = oldpos;
1104 Cmd_ForwardStringToServer
1106 Sends an entire command string over to the server, unprocessed
1109 void Cmd_ForwardStringToServer (const char *s)
1111 if (cls.state != ca_connected)
1113 Con_Printf("Can't \"%s\", not connected\n", s);
1120 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1121 // attention, it has been eradicated from here, its only (former) use in
1122 // all of darkplaces.
1123 if (cls.protocol == PROTOCOL_QUAKEWORLD)
1124 MSG_WriteByte(&cls.netcon->message, qw_clc_stringcmd);
1126 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1127 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1134 Sends the entire command line over to the server
1137 void Cmd_ForwardToServer (void)
1140 if (!strcasecmp(Cmd_Argv(0), "cmd"))
1142 // we want to strip off "cmd", so just send the args
1143 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1147 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1148 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1150 // don't send an empty forward message if the user tries "cmd" by itself
1153 Cmd_ForwardStringToServer(s);
1161 Returns the position (1 to argc-1) in the command's argument list
1162 where the given parameter apears, or 0 if not present
1166 int Cmd_CheckParm (const char *parm)
1172 Con_Printf ("Cmd_CheckParm: NULL");
1176 for (i = 1; i < Cmd_Argc (); i++)
1177 if (!strcasecmp (parm, Cmd_Argv (i)))