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));
309 Creates a new command that executes a command string (possibly ; seperated)
312 static void Cmd_Alias_f (void)
315 char cmd[MAX_INPUTLINE];
321 Con_Print("Current alias commands:\n");
322 for (a = cmd_alias ; a ; a=a->next)
323 Con_Printf("%s : %s\n", a->name, a->value);
328 if (strlen(s) >= MAX_ALIAS_NAME)
330 Con_Print("Alias name is too long\n");
334 // if the alias already exists, reuse it
335 for (a = cmd_alias ; a ; a=a->next)
337 if (!strcmp(s, a->name))
346 cmdalias_t *prev, *current;
348 a = (cmdalias_t *)Z_Malloc (sizeof(cmdalias_t));
349 strlcpy (a->name, s, sizeof (a->name));
350 // insert it at the right alphanumeric position
351 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
362 // copy the rest of the command line
363 cmd[0] = 0; // start out with a null string
365 for (i=2 ; i< c ; i++)
367 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
369 strlcat (cmd, " ", sizeof (cmd));
371 strlcat (cmd, "\n", sizeof (cmd));
373 a->value = (char *)Z_Malloc (strlen (cmd) + 1);
374 strcpy (a->value, cmd);
378 =============================================================================
382 =============================================================================
385 typedef struct cmd_function_s
387 struct cmd_function_s *next;
389 const char *description;
395 static const char *cmd_argv[MAX_ARGS];
396 static const char *cmd_null_string = "";
397 static const char *cmd_args;
398 cmd_source_t cmd_source;
401 static cmd_function_t *cmd_functions; // possible commands to execute
406 Preprocesses strings and replaces $*, $param#, $cvar accordingly
408 static void Cmd_PreprocessString( const char *intext, char *outtext, unsigned maxoutlen, cmdalias_t *alias ) {
413 // don't crash if there's no room in the outtext buffer
414 if( maxoutlen == 0 ) {
417 maxoutlen--; // because of \0
423 while( *in && outlen < maxoutlen ) {
424 if( *in == '$' && !inquote ) {
425 // this is some kind of expansion, see what comes after the $
427 // replacements that can always be used:
428 // $$ is replaced with $, to allow escaping $
429 // $<cvarname> is replaced with the contents of the cvar
431 // the following can be used in aliases only:
432 // $* is replaced with all formal parameters (including name of the alias - this probably is not desirable)
433 // $0 is replaced with the name of this alias
434 // $<number> is replaced with an argument to this alias (or copied as-is if no such parameter exists), can be multiple digits
436 outtext[outlen++] = *in++;
437 } else if( *in == '*' && alias ) {
438 const char *linein = Cmd_Args();
440 // include all parameters
442 while( *linein && outlen < maxoutlen ) {
443 outtext[outlen++] = *linein++;
448 } else if( '0' <= *in && *in <= '9' && alias ) {
452 argnum = strtol( in, &nexttoken, 10 );
454 if( 0 <= argnum && argnum < Cmd_Argc() ) {
455 const char *param = Cmd_Argv( argnum );
456 while( *param && outlen < maxoutlen ) {
457 outtext[outlen++] = *param++;
460 } else if( argnum >= Cmd_Argc() ) {
461 Con_Printf( "Warning: Not enough parameters passed to alias '%s', at least %i expected:\n %s\n", alias->name, argnum, alias->value );
462 outtext[outlen++] = '$';
466 const char *tempin = in;
468 COM_ParseTokenConsole( &tempin );
469 if ((cvar = Cvar_FindVar(&com_token[0]))) {
470 const char *cvarcontent = cvar->string;
471 while( *cvarcontent && outlen < maxoutlen ) {
472 outtext[outlen++] = *cvarcontent++;
477 Con_Printf( "Warning: could not find cvar %s when expanding alias %s\n %s\n", com_token, alias->name, alias->value );
479 Con_Printf( "Warning: could not find cvar %s\n", com_token );
481 outtext[outlen++] = '$';
488 outtext[outlen++] = *in++;
498 Called for aliases and fills in the alias into the cbuffer
501 static void Cmd_ExecuteAlias (cmdalias_t *alias)
503 static char buffer[ MAX_INPUTLINE + 2 ];
504 Cmd_PreprocessString( alias->value, buffer, sizeof(buffer) - 2, alias );
505 Cbuf_AddText( buffer );
512 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
513 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
517 static void Cmd_List_f (void)
525 partial = Cmd_Argv (1);
526 len = (int)strlen(partial);
535 for (cmd = cmd_functions; cmd; cmd = cmd->next)
537 if (partial && strncmp(partial, cmd->name, len))
539 Con_Printf("%s : %s\n", cmd->name, cmd->description);
544 Con_Printf("%i Command%s beginning with \"%s\"\n\n", count, (count > 1) ? "s" : "", partial);
546 Con_Printf("%i Command%s\n\n", count, (count > 1) ? "s" : "");
556 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
557 // space for commands and script files
558 cmd_text.data = cmd_text_buf;
559 cmd_text.maxsize = sizeof(cmd_text_buf);
560 cmd_text.cursize = 0;
563 void Cmd_Init_Commands (void)
566 // register our commands
568 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f, "execute commandline parameters (must be present in quake.rc script)");
569 Cmd_AddCommand ("exec",Cmd_Exec_f, "execute a script file");
570 Cmd_AddCommand ("echo",Cmd_Echo_f, "print a message to the console (useful in scripts)");
571 Cmd_AddCommand ("alias",Cmd_Alias_f, "create a script function (parameters are passed in as $1 through $9, and $* for all parameters)");
572 Cmd_AddCommand ("cmd", Cmd_ForwardToServer, "send a console commandline to the server (used by some mods)");
573 Cmd_AddCommand ("wait", Cmd_Wait_f, "make script execution wait for next rendered frame");
574 Cmd_AddCommand ("set", Cvar_Set_f, "create or change the value of a console variable");
575 Cmd_AddCommand ("seta", Cvar_SetA_f, "create or change the value of a console variable that will be saved to config.cfg");
577 // 2000-01-09 CmdList, CvarList commands By Matthias "Maddes" Buecher
578 // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
579 Cmd_AddCommand ("cmdlist", Cmd_List_f, "lists all console commands beginning with the specified prefix");
580 Cmd_AddCommand ("cvarlist", Cvar_List_f, "lists all console variables beginning with the specified prefix");
588 void Cmd_Shutdown(void)
590 Mem_FreePool(&cmd_mempool);
608 const char *Cmd_Argv (int arg)
610 if (arg >= cmd_argc )
611 return cmd_null_string;
612 return cmd_argv[arg];
620 const char *Cmd_Args (void)
630 Parses the given string into command line tokens.
633 // AK: This function should only be called from ExcuteString because the current design is a bit of an hack
634 static void Cmd_TokenizeString (const char *text)
643 // skip whitespace up to a /n
644 while (*text && *text <= ' ' && *text != '\r' && *text != '\n')
651 if (*text == '\n' || *text == '\r')
653 // a newline separates commands in the buffer
654 if (*text == '\r' && text[1] == '\n')
666 if (!COM_ParseTokenConsole(&text))
669 if (cmd_argc < MAX_ARGS)
671 l = (int)strlen(com_token) + 1;
672 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
674 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
677 strcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token);
678 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
679 cmd_tokenizebufferpos += l;
691 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description)
694 cmd_function_t *prev, *current;
696 // fail if the command is a variable name
697 if (Cvar_FindVar( cmd_name ))
699 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
703 // fail if the command already exists
704 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
706 if (!strcmp (cmd_name, cmd->name))
710 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
715 cmd->csqcfunc = true;
721 cmd = (cmd_function_t *)Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
722 cmd->name = cmd_name;
723 cmd->function = function;
724 cmd->description = description;
725 if(!function) //[515]: csqc
726 cmd->csqcfunc = true;
727 cmd->next = cmd_functions;
729 // insert it at the right alphanumeric position
730 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
745 qboolean Cmd_Exists (const char *cmd_name)
749 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
750 if (!strcmp (cmd_name,cmd->name))
762 const char *Cmd_CompleteCommand (const char *partial)
767 len = strlen(partial);
773 for (cmd = cmd_functions; cmd; cmd = cmd->next)
774 if (!strncasecmp(partial, cmd->name, len))
781 Cmd_CompleteCountPossible
783 New function for tab-completion system
785 Thanks to Fett erich@heintz.com
789 int Cmd_CompleteCountPossible (const char *partial)
796 len = strlen(partial);
801 // Loop through the command list and count all partial matches
802 for (cmd = cmd_functions; cmd; cmd = cmd->next)
803 if (!strncasecmp(partial, cmd->name, len))
810 Cmd_CompleteBuildList
812 New function for tab-completion system
814 Thanks to Fett erich@heintz.com
818 const char **Cmd_CompleteBuildList (const char *partial)
823 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
826 len = strlen(partial);
827 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
828 // Loop through the alias list and print all matches
829 for (cmd = cmd_functions; cmd; cmd = cmd->next)
830 if (!strncasecmp(partial, cmd->name, len))
831 buf[bpos++] = cmd->name;
837 // written by LordHavoc
838 void Cmd_CompleteCommandPrint (const char *partial)
841 size_t len = strlen(partial);
842 // Loop through the command list and print all matches
843 for (cmd = cmd_functions; cmd; cmd = cmd->next)
844 if (!strncasecmp(partial, cmd->name, len))
845 Con_Printf("%s : %s\n", cmd->name, cmd->description);
851 New function for tab-completion system
853 Thanks to Fett erich@heintz.com
857 const char *Cmd_CompleteAlias (const char *partial)
862 len = strlen(partial);
868 for (alias = cmd_alias; alias; alias = alias->next)
869 if (!strncasecmp(partial, alias->name, len))
875 // written by LordHavoc
876 void Cmd_CompleteAliasPrint (const char *partial)
879 size_t len = strlen(partial);
880 // Loop through the alias list and print all matches
881 for (alias = cmd_alias; alias; alias = alias->next)
882 if (!strncasecmp(partial, alias->name, len))
883 Con_Printf("%s : %s\n", alias->name, alias->value);
888 Cmd_CompleteAliasCountPossible
890 New function for tab-completion system
892 Thanks to Fett erich@heintz.com
896 int Cmd_CompleteAliasCountPossible (const char *partial)
904 len = strlen(partial);
909 // Loop through the command list and count all partial matches
910 for (alias = cmd_alias; alias; alias = alias->next)
911 if (!strncasecmp(partial, alias->name, len))
918 Cmd_CompleteAliasBuildList
920 New function for tab-completion system
922 Thanks to Fett erich@heintz.com
926 const char **Cmd_CompleteAliasBuildList (const char *partial)
931 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
934 len = strlen(partial);
935 buf = (const char **)Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
936 // Loop through the alias list and print all matches
937 for (alias = cmd_alias; alias; alias = alias->next)
938 if (!strncasecmp(partial, alias->name, len))
939 buf[bpos++] = alias->name;
945 void Cmd_ClearCsqcFuncs (void)
948 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
949 cmd->csqcfunc = false;
952 qboolean CL_VM_ConsoleCommand (const char *cmd);
957 A complete command line has been parsed, so try to execute it
958 FIXME: lookupnoadd the token to speed search?
961 void Cmd_ExecuteString (const char *text, cmd_source_t src)
967 oldpos = cmd_tokenizebufferpos;
970 Cmd_TokenizeString (text);
972 // execute the command line
975 cmd_tokenizebufferpos = oldpos;
980 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
982 if (!strcasecmp (cmd_argv[0],cmd->name))
984 if(cmd->function && !cmd->csqcfunc)
987 if(CL_VM_ConsoleCommand (text)) //[515]: csqc
992 cmd_tokenizebufferpos = oldpos;
998 for (a=cmd_alias ; a ; a=a->next)
1000 if (!strcasecmp (cmd_argv[0], a->name))
1002 Cmd_ExecuteAlias(a);
1003 cmd_tokenizebufferpos = oldpos;
1009 if (!Cvar_Command () && host_framecount > 0)
1010 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
1012 cmd_tokenizebufferpos = oldpos;
1018 Cmd_ForwardStringToServer
1020 Sends an entire command string over to the server, unprocessed
1023 void Cmd_ForwardStringToServer (const char *s)
1025 if (cls.state != ca_connected)
1027 Con_Printf("Can't \"%s\", not connected\n", s);
1034 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
1035 // attention, it has been eradicated from here, its only (former) use in
1036 // all of darkplaces.
1037 MSG_WriteByte(&cls.netcon->message, clc_stringcmd);
1038 SZ_Write(&cls.netcon->message, (const unsigned char *)s, (int)strlen(s) + 1);
1045 Sends the entire command line over to the server
1048 void Cmd_ForwardToServer (void)
1051 if (!strcasecmp(Cmd_Argv(0), "cmd"))
1053 // we want to strip off "cmd", so just send the args
1054 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
1058 // we need to keep the command name, so send Cmd_Argv(0), a space and then Cmd_Args()
1059 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
1061 // don't send an empty forward message if the user tries "cmd" by itself
1064 Cmd_ForwardStringToServer(s);
1072 Returns the position (1 to argc-1) in the command's argument list
1073 where the given parameter apears, or 0 if not present
1077 int Cmd_CheckParm (const char *parm)
1083 Con_Printf ("Cmd_CheckParm: NULL");
1087 for (i = 1; i < Cmd_Argc (); i++)
1088 if (!strcasecmp (parm, Cmd_Argv (i)))