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 // LordHavoc: inreased this from 8192 to 32768
68 static sizebuf_t cmd_text;
69 static qbyte cmd_text_buf[32768];
78 // space for commands and script files
79 cmd_text.data = cmd_text_buf;
80 cmd_text.maxsize = sizeof(cmd_text_buf);
89 void Cbuf_Shutdown (void)
97 Adds command text at the end of the buffer
100 void Cbuf_AddText (const char *text)
106 if (cmd_text.cursize + l >= cmd_text.maxsize)
108 Con_Print("Cbuf_AddText: overflow\n");
112 SZ_Write (&cmd_text, text, strlen (text));
120 Adds command text immediately after the current command
121 Adds a \n to the text
122 FIXME: actually change the command buffer to do less copying
125 void Cbuf_InsertText (const char *text)
130 // copy off any commands still remaining in the exec buffer
131 templen = cmd_text.cursize;
134 temp = Mem_Alloc (tempmempool, templen);
135 memcpy (temp, cmd_text.data, templen);
136 SZ_Clear (&cmd_text);
141 // add the entire text of the file
144 // add the copied off data
147 SZ_Write (&cmd_text, temp, templen);
157 void Cbuf_Execute (void)
164 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
165 cmd_tokenizebufferpos = 0;
167 while (cmd_text.cursize)
169 // find a \n or ; line break
170 text = (char *)cmd_text.data;
173 for (i=0 ; i< cmd_text.cursize ; i++)
177 if ( !(quotes&1) && text[i] == ';')
178 break; // don't break if inside a quoted string
179 if (text[i] == '\r' || text[i] == '\n')
183 memcpy (line, text, i);
186 // delete the text from the command buffer and move remaining commands down
187 // this is necessary because commands (exec, alias) can insert data at the
188 // beginning of the text buffer
190 if (i == cmd_text.cursize)
191 cmd_text.cursize = 0;
195 cmd_text.cursize -= i;
196 memcpy (cmd_text.data, text+i, cmd_text.cursize);
199 // execute the command line
200 Cmd_ExecuteString (line, src_command);
203 { // skip out while text still remains in buffer, leaving it
212 ==============================================================================
216 ==============================================================================
223 Adds command line parameters as script statements
224 Commands lead with a +, and continue until a - or another +
225 quake +prog jctest.qp +cmd amlev1
226 quake -nosound +cmd amlev1
229 void Cmd_StuffCmds_f (void)
232 // this is per command, and bounds checked (no buffer overflows)
235 if (Cmd_Argc () != 1)
237 Con_Print("stuffcmds : execute command line parameters\n");
241 for (i = 0;i < com_argc;i++)
243 if (com_argv[i] && com_argv[i][0] == '+' && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
247 while (com_argv[i][j])
248 build[l++] = com_argv[i][j++];
250 for (;i < com_argc;i++)
254 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
256 if (l + strlen(com_argv[i]) + 5 > sizeof(build))
260 for (j = 0;com_argv[i][j];j++)
261 build[l++] = com_argv[i][j];
266 Cbuf_InsertText (build);
278 static void Cmd_Exec_f (void)
282 if (Cmd_Argc () != 2)
284 Con_Print("exec <filename> : execute a script file\n");
288 f = (char *)FS_LoadFile (Cmd_Argv(1), tempmempool, false);
291 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
294 Con_DPrintf("execing %s\n",Cmd_Argv(1));
305 Just prints the rest of the line to the console
308 static void Cmd_Echo_f (void)
312 for (i=1 ; i<Cmd_Argc() ; i++)
313 Con_Printf("%s ",Cmd_Argv(i));
321 Creates a new command that executes a command string (possibly ; seperated)
324 static void Cmd_Alias_f (void)
333 Con_Print("Current alias commands:\n");
334 for (a = cmd_alias ; a ; a=a->next)
335 Con_Printf("%s : %s\n", a->name, a->value);
340 if (strlen(s) >= MAX_ALIAS_NAME)
342 Con_Print("Alias name is too long\n");
346 // if the alias already exists, reuse it
347 for (a = cmd_alias ; a ; a=a->next)
349 if (!strcmp(s, a->name))
358 cmdalias_t *prev, *current;
360 a = Z_Malloc (sizeof(cmdalias_t));
361 strlcpy (a->name, s, sizeof (a->name));
362 // insert it at the right alphanumeric position
363 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
374 // copy the rest of the command line
375 cmd[0] = 0; // start out with a null string
377 for (i=2 ; i< c ; i++)
379 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
381 strlcat (cmd, " ", sizeof (cmd));
383 strlcat (cmd, "\n", sizeof (cmd));
385 a->value = Z_Malloc (strlen (cmd) + 1);
386 strcpy (a->value, 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", 0, NULL);
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
480 Cmd_AddCommand ("set", Cvar_Set_f);
481 Cmd_AddCommand ("seta", Cvar_SetA_f);
489 void Cmd_Shutdown(void)
491 Mem_FreePool(&cmd_mempool);
509 const char *Cmd_Argv (int arg)
511 if (arg >= cmd_argc )
512 return cmd_null_string;
513 return cmd_argv[arg];
521 const char *Cmd_Args (void)
531 Parses the given string into command line tokens.
534 static void Cmd_TokenizeString (const char *text)
543 // skip whitespace up to a /n
544 while (*text && *text <= ' ' && *text != '\r' && *text != '\n')
551 if (*text == '\n' || *text == '\r')
553 // a newline seperates commands in the buffer
554 if (*text == '\r' && text[1] == '\n')
566 if (!COM_ParseTokenConsole(&text))
569 if (cmd_argc < MAX_ARGS)
571 l = strlen(com_token) + 1;
572 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
573 Sys_Error("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
574 strcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token);
575 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
576 cmd_tokenizebufferpos += l;
589 void Cmd_AddCommand (const char *cmd_name, xcommand_t function)
592 cmd_function_t *prev, *current;
594 // fail if the command is a variable name
595 if (Cvar_VariableString(cmd_name)[0])
597 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
601 // fail if the command already exists
602 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
604 if (!strcmp (cmd_name, cmd->name))
606 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
611 cmd = Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
612 cmd->name = cmd_name;
613 cmd->function = function;
614 cmd->next = cmd_functions;
616 // insert it at the right alphanumeric position
617 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
632 qboolean Cmd_Exists (const char *cmd_name)
636 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
637 if (!strcmp (cmd_name,cmd->name))
649 const char *Cmd_CompleteCommand (const char *partial)
654 len = strlen(partial);
660 for (cmd = cmd_functions; cmd; cmd = cmd->next)
661 if (!strncmp(partial, cmd->name, len))
668 Cmd_CompleteCountPossible
670 New function for tab-completion system
672 Thanks to Fett erich@heintz.com
676 int Cmd_CompleteCountPossible (const char *partial)
682 len = strlen(partial);
687 // Loop through the command list and count all partial matches
688 for (cmd = cmd_functions; cmd; cmd = cmd->next)
689 if (!strncasecmp(partial, cmd->name, len))
696 Cmd_CompleteBuildList
698 New function for tab-completion system
700 Thanks to Fett erich@heintz.com
704 const char **Cmd_CompleteBuildList (const char *partial)
709 int sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
712 len = strlen(partial);
713 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
714 // Loop through the alias list and print all matches
715 for (cmd = cmd_functions; cmd; cmd = cmd->next)
716 if (!strncasecmp(partial, cmd->name, len))
717 buf[bpos++] = cmd->name;
726 New function for tab-completion system
728 Thanks to Fett erich@heintz.com
732 const char *Cmd_CompleteAlias (const char *partial)
737 len = strlen(partial);
743 for (alias = cmd_alias; alias; alias = alias->next)
744 if (!strncasecmp(partial, alias->name, len))
751 Cmd_CompleteAliasCountPossible
753 New function for tab-completion system
755 Thanks to Fett erich@heintz.com
759 int Cmd_CompleteAliasCountPossible (const char *partial)
767 len = strlen(partial);
772 // Loop through the command list and count all partial matches
773 for (alias = cmd_alias; alias; alias = alias->next)
774 if (!strncasecmp(partial, alias->name, len))
781 Cmd_CompleteAliasBuildList
783 New function for tab-completion system
785 Thanks to Fett erich@heintz.com
789 const char **Cmd_CompleteAliasBuildList (const char *partial)
794 int sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
797 len = strlen(partial);
798 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
799 // Loop through the alias list and print all matches
800 for (alias = cmd_alias; alias; alias = alias->next)
801 if (!strncasecmp(partial, alias->name, len))
802 buf[bpos++] = alias->name;
812 A complete command line has been parsed, so try to execute it
813 FIXME: lookupnoadd the token to speed search?
816 void Cmd_ExecuteString (const char *text, cmd_source_t src)
822 oldpos = cmd_tokenizebufferpos;
824 Cmd_TokenizeString (text);
826 // execute the command line
829 cmd_tokenizebufferpos = oldpos;
833 // check functions (only after host_initialized)
834 if (host_initialized || !strcasecmp(cmd_argv[0], "exec") || !strcasecmp(cmd_argv[0], "set") || !strcasecmp(cmd_argv[0], "seta"))
836 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
838 if (!strcasecmp (cmd_argv[0],cmd->name))
841 cmd_tokenizebufferpos = oldpos;
847 // check alias (only after host_initialized)
848 if (host_initialized)
850 for (a=cmd_alias ; a ; a=a->next)
852 if (!strcasecmp (cmd_argv[0], a->name))
854 Cbuf_InsertText (a->value);
855 cmd_tokenizebufferpos = oldpos;
861 // check cvars (always)
862 if (!Cvar_Command () && host_initialized)
863 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
865 cmd_tokenizebufferpos = oldpos;
871 Cmd_ForwardStringToServer
873 Sends an entire command string over to the server, unprocessed
876 void Cmd_ForwardStringToServer (const char *s)
878 if (cls.state != ca_connected)
880 Con_Printf("Can't \"%s\", not connected\n", s);
884 if (cls.demoplayback)
885 return; // not really connected
887 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
888 // attention, it has been eradicated from here, its only (former) use in
889 // all of darkplaces.
890 MSG_WriteByte(&cls.message, clc_stringcmd);
891 SZ_Write(&cls.message, s, strlen(s) + 1);
898 Sends the entire command line over to the server
901 void Cmd_ForwardToServer (void)
904 if (strcasecmp(Cmd_Argv(0), "cmd"))
905 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
907 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
908 Cmd_ForwardStringToServer(s);
916 Returns the position (1 to argc-1) in the command's argument list
917 where the given parameter apears, or 0 if not present
921 int Cmd_CheckParm (const char *parm)
926 Sys_Error ("Cmd_CheckParm: NULL");
928 for (i = 1; i < Cmd_Argc (); i++)
929 if (!strcasecmp (parm, Cmd_Argv (i)))