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 #define CMD_TOKENIZELENGTH 4096
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)
60 =============================================================================
64 =============================================================================
67 static sizebuf_t cmd_text;
76 // LordHavoc: inreased this from 8192 to 32768
77 SZ_Alloc (&cmd_text, 32768, "command buffer"); // space for commands and script files
85 Adds command text at the end of the buffer
88 void Cbuf_AddText (const char *text)
94 if (cmd_text.cursize + l >= cmd_text.maxsize)
96 Con_Print("Cbuf_AddText: overflow\n");
100 SZ_Write (&cmd_text, text, strlen (text));
108 Adds command text immediately after the current command
109 Adds a \n to the text
110 FIXME: actually change the command buffer to do less copying
113 void Cbuf_InsertText (const char *text)
118 // copy off any commands still remaining in the exec buffer
119 templen = cmd_text.cursize;
122 temp = Mem_Alloc (tempmempool, templen);
123 memcpy (temp, cmd_text.data, templen);
124 SZ_Clear (&cmd_text);
129 // add the entire text of the file
132 // add the copied off data
135 SZ_Write (&cmd_text, temp, templen);
145 void Cbuf_Execute (void)
152 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
153 cmd_tokenizebufferpos = 0;
155 while (cmd_text.cursize)
157 // find a \n or ; line break
158 text = (char *)cmd_text.data;
161 for (i=0 ; i< cmd_text.cursize ; i++)
165 if ( !(quotes&1) && text[i] == ';')
166 break; // don't break if inside a quoted string
167 if (text[i] == '\r' || text[i] == '\n')
171 memcpy (line, text, i);
174 // delete the text from the command buffer and move remaining commands down
175 // this is necessary because commands (exec, alias) can insert data at the
176 // beginning of the text buffer
178 if (i == cmd_text.cursize)
179 cmd_text.cursize = 0;
183 cmd_text.cursize -= i;
184 memcpy (cmd_text.data, text+i, cmd_text.cursize);
187 // execute the command line
188 Cmd_ExecuteString (line, src_command);
191 { // skip out while text still remains in buffer, leaving it
200 ==============================================================================
204 ==============================================================================
211 Adds command line parameters as script statements
212 Commands lead with a +, and continue until a - or another +
213 quake +prog jctest.qp +cmd amlev1
214 quake -nosound +cmd amlev1
217 void Cmd_StuffCmds_f (void)
220 // this is per command, and bounds checked (no buffer overflows)
223 if (Cmd_Argc () != 1)
225 Con_Print("stuffcmds : execute command line parameters\n");
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);
265 static void Cmd_Exec_f (void)
269 if (Cmd_Argc () != 2)
271 Con_Print("exec <filename> : execute a script file\n");
275 f = (char *)FS_LoadFile (Cmd_Argv(1), tempmempool, false);
278 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
281 Con_DPrintf("execing %s\n",Cmd_Argv(1));
292 Just prints the rest of the line to the console
295 static void Cmd_Echo_f (void)
299 for (i=1 ; i<Cmd_Argc() ; i++)
300 Con_Printf("%s ",Cmd_Argv(i));
308 Creates a new command that executes a command string (possibly ; seperated)
311 static void Cmd_Alias_f (void)
320 Con_Print("Current alias commands:\n");
321 for (a = cmd_alias ; a ; a=a->next)
322 Con_Printf("%s : %s\n", a->name, a->value);
327 if (strlen(s) >= MAX_ALIAS_NAME)
329 Con_Print("Alias name is too long\n");
333 // if the alias already exists, reuse it
334 for (a = cmd_alias ; a ; a=a->next)
336 if (!strcmp(s, a->name))
345 a = Z_Malloc (sizeof(cmdalias_t));
349 strlcpy (a->name, s, sizeof (a->name));
351 // copy the rest of the command line
352 cmd[0] = 0; // start out with a null string
354 for (i=2 ; i< c ; i++)
356 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
358 strlcat (cmd, " ", sizeof (cmd));
360 strlcat (cmd, "\n", sizeof (cmd));
362 a->value = Z_Malloc (strlen (cmd) + 1);
363 strcpy (a->value, cmd);
367 =============================================================================
371 =============================================================================
374 typedef struct cmd_function_s
376 struct cmd_function_s *next;
385 static const char *cmd_argv[MAX_ARGS];
386 static const char *cmd_null_string = "";
387 static const char *cmd_args = NULL;
389 cmd_source_t cmd_source;
392 static cmd_function_t *cmd_functions; // possible commands to execute
398 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
399 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
403 static void Cmd_List_f (void)
411 partial = Cmd_Argv (1);
412 len = strlen(partial);
421 for (cmd = cmd_functions; cmd; cmd = cmd->next)
423 if (partial && strncmp(partial, cmd->name, len))
425 Con_Printf("%s\n", cmd->name);
429 Con_Printf("%i Command%s", count, (count > 1) ? "s" : "");
431 Con_Printf(" beginning with \"%s\"", partial);
443 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
446 // register our commands
448 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f);
449 Cmd_AddCommand ("exec",Cmd_Exec_f);
450 Cmd_AddCommand ("echo",Cmd_Echo_f);
451 Cmd_AddCommand ("alias",Cmd_Alias_f);
452 Cmd_AddCommand ("cmd", Cmd_ForwardToServer);
453 Cmd_AddCommand ("wait", Cmd_Wait_f);
454 Cmd_AddCommand ("cmdlist", Cmd_List_f); // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
455 Cmd_AddCommand ("cvarlist", Cvar_List_f); // 2000-01-09 CmdList, CvarList commands
456 // By Matthias "Maddes" Buecher
474 const char *Cmd_Argv (int arg)
476 if (arg >= cmd_argc )
477 return cmd_null_string;
478 return cmd_argv[arg];
486 const char *Cmd_Args (void)
496 Parses the given string into command line tokens.
499 static void Cmd_TokenizeString (const char *text)
508 // skip whitespace up to a /n
509 while (*text && *text <= ' ' && *text != '\n')
514 // a newline seperates commands in the buffer
525 if (!COM_ParseTokenConsole(&text))
528 if (cmd_argc < MAX_ARGS)
530 l = strlen(com_token) + 1;
531 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
532 Sys_Error("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
533 strcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token);
534 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
535 cmd_tokenizebufferpos += l;
548 void Cmd_AddCommand (const char *cmd_name, xcommand_t function)
552 // fail if the command is a variable name
553 if (Cvar_VariableString(cmd_name)[0])
555 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
559 // fail if the command already exists
560 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
562 if (!strcmp (cmd_name, cmd->name))
564 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
569 cmd = Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
570 cmd->name = cmd_name;
571 cmd->function = function;
572 cmd->next = cmd_functions;
581 qboolean Cmd_Exists (const char *cmd_name)
585 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
586 if (!strcmp (cmd_name,cmd->name))
598 const char *Cmd_CompleteCommand (const char *partial)
603 len = strlen(partial);
609 for (cmd = cmd_functions; cmd; cmd = cmd->next)
610 if (!strncmp(partial, cmd->name, len))
617 Cmd_CompleteCountPossible
619 New function for tab-completion system
621 Thanks to Fett erich@heintz.com
625 int Cmd_CompleteCountPossible (const char *partial)
631 len = strlen(partial);
636 // Loop through the command list and count all partial matches
637 for (cmd = cmd_functions; cmd; cmd = cmd->next)
638 if (!strncasecmp(partial, cmd->name, len))
645 Cmd_CompleteBuildList
647 New function for tab-completion system
649 Thanks to Fett erich@heintz.com
653 const char **Cmd_CompleteBuildList (const char *partial)
658 int sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
661 len = strlen(partial);
662 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
663 // Loop through the alias list and print all matches
664 for (cmd = cmd_functions; cmd; cmd = cmd->next)
665 if (!strncasecmp(partial, cmd->name, len))
666 buf[bpos++] = cmd->name;
675 New function for tab-completion system
677 Thanks to Fett erich@heintz.com
681 const char *Cmd_CompleteAlias (const char *partial)
686 len = strlen(partial);
692 for (alias = cmd_alias; alias; alias = alias->next)
693 if (!strncasecmp(partial, alias->name, len))
700 Cmd_CompleteAliasCountPossible
702 New function for tab-completion system
704 Thanks to Fett erich@heintz.com
708 int Cmd_CompleteAliasCountPossible (const char *partial)
716 len = strlen(partial);
721 // Loop through the command list and count all partial matches
722 for (alias = cmd_alias; alias; alias = alias->next)
723 if (!strncasecmp(partial, alias->name, len))
730 Cmd_CompleteAliasBuildList
732 New function for tab-completion system
734 Thanks to Fett erich@heintz.com
738 const char **Cmd_CompleteAliasBuildList (const char *partial)
743 int sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
746 len = strlen(partial);
747 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
748 // Loop through the alias list and print all matches
749 for (alias = cmd_alias; alias; alias = alias->next)
750 if (!strncasecmp(partial, alias->name, len))
751 buf[bpos++] = alias->name;
761 A complete command line has been parsed, so try to execute it
762 FIXME: lookupnoadd the token to speed search?
765 void Cmd_ExecuteString (const char *text, cmd_source_t src)
771 oldpos = cmd_tokenizebufferpos;
773 Cmd_TokenizeString (text);
775 // execute the command line
778 cmd_tokenizebufferpos = oldpos;
782 // check functions (only after host_initialized)
783 if (host_initialized || !strcasecmp(cmd_argv[0], "exec"))
785 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
787 if (!strcasecmp (cmd_argv[0],cmd->name))
790 cmd_tokenizebufferpos = oldpos;
796 // check alias (only after host_initialized)
797 if (host_initialized)
799 for (a=cmd_alias ; a ; a=a->next)
801 if (!strcasecmp (cmd_argv[0], a->name))
803 Cbuf_InsertText (a->value);
804 cmd_tokenizebufferpos = oldpos;
810 // check cvars (always)
811 if (!Cvar_Command () && host_initialized)
812 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
814 cmd_tokenizebufferpos = oldpos;
822 Sends the entire command line over to the server
825 void Cmd_ForwardToServer (void)
828 if (cls.state != ca_connected)
830 Con_Printf("Can't \"%s\", not connected\n", Cmd_Argv(0));
834 if (cls.demoplayback)
835 return; // not really connected
837 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
838 // attention, it has been eradicated from here, its only (former) use in
839 // all of darkplaces.
840 if (strcasecmp(Cmd_Argv(0), "cmd") != 0)
841 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "\n");
843 s = Cmd_Argc() > 1 ? Cmd_Args() : "\n";
844 MSG_WriteByte(&cls.message, clc_stringcmd);
845 SZ_Write(&cls.message, s, strlen(s) + 1);
853 Returns the position (1 to argc-1) in the command's argument list
854 where the given parameter apears, or 0 if not present
858 int Cmd_CheckParm (const char *parm)
863 Sys_Error ("Cmd_CheckParm: NULL");
865 for (i = 1; i < Cmd_Argc (); i++)
866 if (!strcasecmp (parm, Cmd_Argv (i)))