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
26 typedef struct cmdalias_s
28 struct cmdalias_s *next;
29 char name[MAX_ALIAS_NAME];
33 static cmdalias_t *cmd_alias;
35 static qboolean cmd_wait;
37 static mempool_t *cmd_mempool;
39 //=============================================================================
45 Causes execution of the remainder of the command buffer to be delayed until
46 next frame. This allows commands like:
47 bind g "impulse 5 ; +attack ; wait ; -attack ; impulse 2"
50 static void Cmd_Wait_f (void)
56 =============================================================================
60 =============================================================================
63 static sizebuf_t cmd_text;
72 // LordHavoc: inreased this from 8192 to 32768
73 SZ_Alloc (&cmd_text, 32768, "command buffer"); // space for commands and script files
81 Adds command text at the end of the buffer
84 void Cbuf_AddText (const char *text)
90 if (cmd_text.cursize + l >= cmd_text.maxsize)
92 Con_Printf ("Cbuf_AddText: overflow\n");
96 SZ_Write (&cmd_text, text, strlen (text));
104 Adds command text immediately after the current command
105 Adds a \n to the text
106 FIXME: actually change the command buffer to do less copying
109 void Cbuf_InsertText (const char *text)
114 // copy off any commands still remaining in the exec buffer
115 templen = cmd_text.cursize;
118 temp = Z_Malloc (templen);
119 memcpy (temp, cmd_text.data, templen);
120 SZ_Clear (&cmd_text);
123 temp = NULL; // shut up compiler
125 // add the entire text of the file
128 // add the copied off data
131 SZ_Write (&cmd_text, temp, templen);
141 void Cbuf_Execute (void)
148 while (cmd_text.cursize)
150 // find a \n or ; line break
151 text = (char *)cmd_text.data;
154 for (i=0 ; i< cmd_text.cursize ; i++)
158 if ( !(quotes&1) && text[i] == ';')
159 break; // don't break if inside a quoted string
164 memcpy (line, text, i);
167 // delete the text from the command buffer and move remaining commands down
168 // this is necessary because commands (exec, alias) can insert data at the
169 // beginning of the text buffer
171 if (i == cmd_text.cursize)
172 cmd_text.cursize = 0;
176 cmd_text.cursize -= i;
177 memcpy (text, text+i, cmd_text.cursize);
180 // execute the command line
181 Cmd_ExecuteString (line, src_command);
184 { // skip out while text still remains in buffer, leaving it
193 ==============================================================================
197 ==============================================================================
204 Adds command line parameters as script statements
205 Commands lead with a +, and continue until a - or another +
206 quake +prog jctest.qp +cmd amlev1
207 quake -nosound +cmd amlev1
210 void Cmd_StuffCmds_f (void)
214 char *text, *build, c;
216 if (Cmd_Argc () != 1)
218 Con_Printf ("stuffcmds : execute command line parameters\n");
222 // build the combined string to parse from
224 for (i=1 ; i<com_argc ; i++)
227 continue; // NEXTSTEP nulls out -NXHost
228 s += strlen (com_argv[i]) + 1;
233 text = Z_Malloc (s+1);
235 for (i=1 ; i<com_argc ; i++)
238 continue; // NEXTSTEP nulls out -NXHost
239 strcat (text,com_argv[i]);
244 // pull out the commands
245 build = Z_Malloc (s+1);
248 for (i=0 ; i<s-1 ; i++)
254 for (j=i ; (text[j] != '+') && (text[j] != '-') && (text[j] != 0) ; j++)
260 strcat (build, text+i);
261 strcat (build, "\n");
268 Cbuf_InsertText (build);
280 static void Cmd_Exec_f (void)
284 if (Cmd_Argc () != 2)
286 Con_Printf ("exec <filename> : execute a script file\n");
290 f = (char *)COM_LoadFile (Cmd_Argv(1), false);
293 Con_Printf ("couldn't exec %s\n",Cmd_Argv(1));
296 Con_Printf ("execing %s\n",Cmd_Argv(1));
307 Just prints the rest of the line to the console
310 static void Cmd_Echo_f (void)
314 for (i=1 ; i<Cmd_Argc() ; i++)
315 Con_Printf ("%s ",Cmd_Argv(i));
323 Creates a new command that executes a command string (possibly ; seperated)
326 static char *CopyString (char *in)
330 out = Z_Malloc (strlen(in)+1);
335 static void Cmd_Alias_f (void)
344 Con_Printf ("Current alias commands:\n");
345 for (a = cmd_alias ; a ; a=a->next)
346 Con_Printf ("%s : %s\n", a->name, a->value);
351 if (strlen(s) >= MAX_ALIAS_NAME)
353 Con_Printf ("Alias name is too long\n");
357 // if the alias already exists, reuse it
358 for (a = cmd_alias ; a ; a=a->next)
360 if (!strcmp(s, a->name))
369 a = Z_Malloc (sizeof(cmdalias_t));
375 // copy the rest of the command line
376 cmd[0] = 0; // start out with a null string
378 for (i=2 ; i< c ; i++)
380 strcat (cmd, Cmd_Argv(i));
386 a->value = CopyString (cmd);
390 =============================================================================
394 =============================================================================
397 typedef struct cmd_function_s
399 struct cmd_function_s *next;
408 static const char *cmd_argv[MAX_ARGS];
409 static const char *cmd_null_string = "";
410 static const char *cmd_args = NULL;
412 cmd_source_t cmd_source;
415 static cmd_function_t *cmd_functions; // possible commands to execute
421 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
422 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
426 static void Cmd_List_f (void)
434 partial = Cmd_Argv (1);
435 len = strlen(partial);
444 for (cmd = cmd_functions; cmd; cmd = cmd->next)
446 if (partial && strncmp(partial, cmd->name, len))
448 Con_Printf ("%s\n", cmd->name);
452 Con_Printf ("%i Command%s", count, (count > 1) ? "s" : "");
454 Con_Printf(" beginning with \"%s\"", partial);
466 cmd_mempool = Mem_AllocPool("commands");
469 // register our commands
471 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f);
472 Cmd_AddCommand ("exec",Cmd_Exec_f);
473 Cmd_AddCommand ("echo",Cmd_Echo_f);
474 Cmd_AddCommand ("alias",Cmd_Alias_f);
475 Cmd_AddCommand ("cmd", Cmd_ForwardToServer);
476 Cmd_AddCommand ("wait", Cmd_Wait_f);
477 Cmd_AddCommand ("cmdlist", Cmd_List_f); // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
478 Cmd_AddCommand ("cvarlist", Cvar_List_f); // 2000-01-09 CmdList, CvarList commands
479 // By Matthias "Maddes" Buecher
497 const char *Cmd_Argv (int arg)
499 if (arg >= cmd_argc )
500 return cmd_null_string;
501 return cmd_argv[arg];
509 const char *Cmd_Args (void)
515 #define CMD_TOKENIZELENGTH 4096
516 char cmd_tokenizebuffer[CMD_TOKENIZELENGTH];
522 Parses the given string into command line tokens.
525 static void Cmd_TokenizeString (const char *text)
536 // skip whitespace up to a /n
537 while (*text && *text <= ' ' && *text != '\n')
543 { // a newline seperates commands in the buffer
554 if (!COM_ParseToken (&text))
557 if (cmd_argc < MAX_ARGS)
559 l = strlen(com_token) + 1;
560 if (pos + l > CMD_TOKENIZELENGTH)
561 Sys_Error("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
562 strcpy (cmd_tokenizebuffer + pos, com_token);
563 cmd_argv[cmd_argc] = cmd_tokenizebuffer + pos;
577 void Cmd_AddCommand (const char *cmd_name, xcommand_t function)
581 // fail if the command is a variable name
582 if (Cvar_VariableString(cmd_name)[0])
584 Con_Printf ("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
588 // fail if the command already exists
589 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
591 if (!strcmp (cmd_name, cmd->name))
593 Con_Printf ("Cmd_AddCommand: %s already defined\n", cmd_name);
598 cmd = Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
599 cmd->name = cmd_name;
600 cmd->function = function;
601 cmd->next = cmd_functions;
610 qboolean Cmd_Exists (const char *cmd_name)
614 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
615 if (!strcmp (cmd_name,cmd->name))
627 const char *Cmd_CompleteCommand (const char *partial)
632 len = strlen(partial);
638 for (cmd = cmd_functions; cmd; cmd = cmd->next)
639 if (!strncmp(partial, cmd->name, len))
646 Cmd_CompleteCountPossible
648 New function for tab-completion system
650 Thanks to Fett erich@heintz.com
654 int Cmd_CompleteCountPossible (const char *partial)
660 len = strlen(partial);
665 // Loop through the command list and count all partial matches
666 for (cmd = cmd_functions; cmd; cmd = cmd->next)
667 if (!strncasecmp(partial, cmd->name, len))
674 Cmd_CompleteBuildList
676 New function for tab-completion system
678 Thanks to Fett erich@heintz.com
682 const char **Cmd_CompleteBuildList (const char *partial)
687 int sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
690 len = strlen(partial);
691 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
692 // Loop through the alias list and print all matches
693 for (cmd = cmd_functions; cmd; cmd = cmd->next)
694 if (!strncasecmp(partial, cmd->name, len))
695 buf[bpos++] = cmd->name;
704 New function for tab-completion system
706 Thanks to Fett erich@heintz.com
710 const char *Cmd_CompleteAlias (const char *partial)
715 len = strlen(partial);
721 for (alias = cmd_alias; alias; alias = alias->next)
722 if (!strncasecmp(partial, alias->name, len))
729 Cmd_CompleteAliasCountPossible
731 New function for tab-completion system
733 Thanks to Fett erich@heintz.com
737 int Cmd_CompleteAliasCountPossible (const char *partial)
745 len = strlen(partial);
750 // Loop through the command list and count all partial matches
751 for (alias = cmd_alias; alias; alias = alias->next)
752 if (!strncasecmp(partial, alias->name, len))
759 Cmd_CompleteAliasBuildList
761 New function for tab-completion system
763 Thanks to Fett erich@heintz.com
767 const char **Cmd_CompleteAliasBuildList (const char *partial)
772 int sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
775 len = strlen(partial);
776 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
777 // Loop through the alias list and print all matches
778 for (alias = cmd_alias; alias; alias = alias->next)
779 if (!strncasecmp(partial, alias->name, len))
780 buf[bpos++] = alias->name;
790 A complete command line has been parsed, so try to execute it
791 FIXME: lookupnoadd the token to speed search?
794 void Cmd_ExecuteString (const char *text, cmd_source_t src)
800 Cmd_TokenizeString (text);
802 // execute the command line
807 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
809 if (!Q_strcasecmp (cmd_argv[0],cmd->name))
817 for (a=cmd_alias ; a ; a=a->next)
819 if (!Q_strcasecmp (cmd_argv[0], a->name))
821 Cbuf_InsertText (a->value);
827 if (!Cvar_Command ())
828 Con_Printf ("Unknown command \"%s\"\n", Cmd_Argv(0));
836 Sends the entire command line over to the server
839 void Cmd_ForwardToServer (void)
841 if (cls.state != ca_connected)
843 Con_Printf ("Can't \"%s\", not connected\n", Cmd_Argv(0));
847 if (cls.demoplayback)
848 return; // not really connected
850 MSG_WriteByte (&cls.message, clc_stringcmd);
851 if (Q_strcasecmp(Cmd_Argv(0), "cmd") != 0)
853 SZ_Print (&cls.message, Cmd_Argv(0));
854 SZ_Print (&cls.message, " ");
857 SZ_Print (&cls.message, Cmd_Args());
859 SZ_Print (&cls.message, "\n");
867 Returns the position (1 to argc-1) in the command's argument list
868 where the given parameter apears, or 0 if not present
872 int Cmd_CheckParm (const char *parm)
877 Sys_Error ("Cmd_CheckParm: NULL");
879 for (i = 1; i < Cmd_Argc (); i++)
880 if (!Q_strcasecmp (parm, Cmd_Argv (i)))