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];
75 Adds command text at the end of the buffer
78 void Cbuf_AddText (const char *text)
82 l = (int)strlen (text);
84 if (cmd_text.cursize + l >= cmd_text.maxsize)
86 Con_Print("Cbuf_AddText: overflow\n");
90 SZ_Write (&cmd_text, text, (int)strlen (text));
98 Adds command text immediately after the current command
100 FIXME: actually change the command buffer to do less copying
103 void Cbuf_InsertText (const char *text)
108 // copy off any commands still remaining in the exec buffer
109 templen = cmd_text.cursize;
112 temp = Mem_Alloc (tempmempool, templen);
113 memcpy (temp, cmd_text.data, templen);
114 SZ_Clear (&cmd_text);
119 // add the entire text of the file
122 // add the copied off data
125 SZ_Write (&cmd_text, temp, templen);
135 void Cbuf_Execute (void)
142 // LordHavoc: making sure the tokenizebuffer doesn't get filled up by repeated crashes
143 cmd_tokenizebufferpos = 0;
145 while (cmd_text.cursize)
147 // find a \n or ; line break
148 text = (char *)cmd_text.data;
151 for (i=0 ; i< cmd_text.cursize ; i++)
155 if ( !(quotes&1) && text[i] == ';')
156 break; // don't break if inside a quoted string
157 if (text[i] == '\r' || text[i] == '\n')
161 memcpy (line, text, i);
164 // delete the text from the command buffer and move remaining commands down
165 // this is necessary because commands (exec, alias) can insert data at the
166 // beginning of the text buffer
168 if (i == cmd_text.cursize)
169 cmd_text.cursize = 0;
173 cmd_text.cursize -= i;
174 memcpy (cmd_text.data, text+i, cmd_text.cursize);
177 // execute the command line
178 Cmd_ExecuteString (line, src_command);
181 { // skip out while text still remains in buffer, leaving it
190 ==============================================================================
194 ==============================================================================
201 Adds command line parameters as script statements
202 Commands lead with a +, and continue until a - or another +
203 quake +prog jctest.qp +cmd amlev1
204 quake -nosound +cmd amlev1
207 qboolean host_stuffcmdsrun = false;
208 void Cmd_StuffCmds_f (void)
211 // this is per command, and bounds checked (no buffer overflows)
214 if (Cmd_Argc () != 1)
216 Con_Print("stuffcmds : execute command line parameters\n");
220 host_stuffcmdsrun = true;
221 for (i = 0;i < com_argc;i++)
223 if (com_argv[i] && com_argv[i][0] == '+' && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
227 while (com_argv[i][j])
228 build[l++] = com_argv[i][j++];
230 for (;i < com_argc;i++)
234 if ((com_argv[i][0] == '+' || com_argv[i][0] == '-') && (com_argv[i][1] < '0' || com_argv[i][1] > '9'))
236 if (l + strlen(com_argv[i]) + 5 > sizeof(build))
240 for (j = 0;com_argv[i][j];j++)
241 build[l++] = com_argv[i][j];
246 Cbuf_InsertText (build);
258 static void Cmd_Exec_f (void)
262 if (Cmd_Argc () != 2)
264 Con_Print("exec <filename> : execute a script file\n");
268 f = (char *)FS_LoadFile (Cmd_Argv(1), tempmempool, false);
271 Con_Printf("couldn't exec %s\n",Cmd_Argv(1));
274 Con_DPrintf("execing %s\n",Cmd_Argv(1));
285 Just prints the rest of the line to the console
288 static void Cmd_Echo_f (void)
292 for (i=1 ; i<Cmd_Argc() ; i++)
293 Con_Printf("%s ",Cmd_Argv(i));
301 Creates a new command that executes a command string (possibly ; seperated)
304 static void Cmd_Alias_f (void)
313 Con_Print("Current alias commands:\n");
314 for (a = cmd_alias ; a ; a=a->next)
315 Con_Printf("%s : %s\n", a->name, a->value);
320 if (strlen(s) >= MAX_ALIAS_NAME)
322 Con_Print("Alias name is too long\n");
326 // if the alias already exists, reuse it
327 for (a = cmd_alias ; a ; a=a->next)
329 if (!strcmp(s, a->name))
338 cmdalias_t *prev, *current;
340 a = Z_Malloc (sizeof(cmdalias_t));
341 strlcpy (a->name, s, sizeof (a->name));
342 // insert it at the right alphanumeric position
343 for( prev = NULL, current = cmd_alias ; current && strcmp( current->name, a->name ) < 0 ; prev = current, current = current->next )
354 // copy the rest of the command line
355 cmd[0] = 0; // start out with a null string
357 for (i=2 ; i< c ; i++)
359 strlcat (cmd, Cmd_Argv(i), sizeof (cmd));
361 strlcat (cmd, " ", sizeof (cmd));
363 strlcat (cmd, "\n", sizeof (cmd));
365 a->value = Z_Malloc (strlen (cmd) + 1);
366 strcpy (a->value, cmd);
370 =============================================================================
374 =============================================================================
377 typedef struct cmd_function_s
379 struct cmd_function_s *next;
388 static const char *cmd_argv[MAX_ARGS];
389 static const char *cmd_null_string = "";
390 static const char *cmd_args = NULL;
392 cmd_source_t cmd_source;
395 static cmd_function_t *cmd_functions; // possible commands to execute
401 CmdList Added by EvilTypeGuy eviltypeguy@qeradiant.com
402 Thanks to Matthias "Maddes" Buecher, http://www.inside3d.com/qip/
406 static void Cmd_List_f (void)
414 partial = Cmd_Argv (1);
415 len = (int)strlen(partial);
424 for (cmd = cmd_functions; cmd; cmd = cmd->next)
426 if (partial && strncmp(partial, cmd->name, len))
428 Con_Printf("%s\n", cmd->name);
432 Con_Printf("%i Command%s", count, (count > 1) ? "s" : "");
434 Con_Printf(" beginning with \"%s\"", partial);
446 cmd_mempool = Mem_AllocPool("commands", 0, NULL);
447 // space for commands and script files
448 cmd_text.data = cmd_text_buf;
449 cmd_text.maxsize = sizeof(cmd_text_buf);
450 cmd_text.cursize = 0;
453 void Cmd_Init_Commands (void)
456 // register our commands
458 Cmd_AddCommand ("stuffcmds",Cmd_StuffCmds_f);
459 Cmd_AddCommand ("exec",Cmd_Exec_f);
460 Cmd_AddCommand ("echo",Cmd_Echo_f);
461 Cmd_AddCommand ("alias",Cmd_Alias_f);
462 Cmd_AddCommand ("cmd", Cmd_ForwardToServer);
463 Cmd_AddCommand ("wait", Cmd_Wait_f);
464 Cmd_AddCommand ("cmdlist", Cmd_List_f); // Added/Modified by EvilTypeGuy eviltypeguy@qeradiant.com
465 Cmd_AddCommand ("cvarlist", Cvar_List_f); // 2000-01-09 CmdList, CvarList commands
466 // By Matthias "Maddes" Buecher
467 Cmd_AddCommand ("set", Cvar_Set_f);
468 Cmd_AddCommand ("seta", Cvar_SetA_f);
476 void Cmd_Shutdown(void)
478 Mem_FreePool(&cmd_mempool);
496 const char *Cmd_Argv (int arg)
498 if (arg >= cmd_argc )
499 return cmd_null_string;
500 return cmd_argv[arg];
508 const char *Cmd_Args (void)
518 Parses the given string into command line tokens.
521 static void Cmd_TokenizeString (const char *text)
530 // skip whitespace up to a /n
531 while (*text && *text <= ' ' && *text != '\r' && *text != '\n')
538 if (*text == '\n' || *text == '\r')
540 // a newline seperates commands in the buffer
541 if (*text == '\r' && text[1] == '\n')
553 if (!COM_ParseTokenConsole(&text))
556 if (cmd_argc < MAX_ARGS)
558 l = (int)strlen(com_token) + 1;
559 if (cmd_tokenizebufferpos + l > CMD_TOKENIZELENGTH)
561 Con_Printf("Cmd_TokenizeString: ran out of %i character buffer space for command arguements\n", CMD_TOKENIZELENGTH);
564 strcpy (cmd_tokenizebuffer + cmd_tokenizebufferpos, com_token);
565 cmd_argv[cmd_argc] = cmd_tokenizebuffer + cmd_tokenizebufferpos;
566 cmd_tokenizebufferpos += l;
578 void Cmd_AddCommand (const char *cmd_name, xcommand_t function)
581 cmd_function_t *prev, *current;
583 // fail if the command is a variable name
584 if (Cvar_VariableString(cmd_name)[0])
586 Con_Printf("Cmd_AddCommand: %s already defined as a var\n", cmd_name);
590 // fail if the command already exists
591 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
593 if (!strcmp (cmd_name, cmd->name))
595 Con_Printf("Cmd_AddCommand: %s already defined\n", cmd_name);
600 cmd = Mem_Alloc(cmd_mempool, sizeof(cmd_function_t));
601 cmd->name = cmd_name;
602 cmd->function = function;
603 cmd->next = cmd_functions;
605 // insert it at the right alphanumeric position
606 for( prev = NULL, current = cmd_functions ; current && strcmp( current->name, cmd->name ) < 0 ; prev = current, current = current->next )
621 qboolean Cmd_Exists (const char *cmd_name)
625 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
626 if (!strcmp (cmd_name,cmd->name))
638 const char *Cmd_CompleteCommand (const char *partial)
643 len = strlen(partial);
649 for (cmd = cmd_functions; cmd; cmd = cmd->next)
650 if (!strncmp(partial, cmd->name, len))
657 Cmd_CompleteCountPossible
659 New function for tab-completion system
661 Thanks to Fett erich@heintz.com
665 int Cmd_CompleteCountPossible (const char *partial)
672 len = strlen(partial);
677 // Loop through the command list and count all partial matches
678 for (cmd = cmd_functions; cmd; cmd = cmd->next)
679 if (!strncasecmp(partial, cmd->name, len))
686 Cmd_CompleteBuildList
688 New function for tab-completion system
690 Thanks to Fett erich@heintz.com
694 const char **Cmd_CompleteBuildList (const char *partial)
699 size_t sizeofbuf = (Cmd_CompleteCountPossible (partial) + 1) * sizeof (const char *);
702 len = strlen(partial);
703 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
704 // Loop through the alias list and print all matches
705 for (cmd = cmd_functions; cmd; cmd = cmd->next)
706 if (!strncasecmp(partial, cmd->name, len))
707 buf[bpos++] = cmd->name;
716 New function for tab-completion system
718 Thanks to Fett erich@heintz.com
722 const char *Cmd_CompleteAlias (const char *partial)
727 len = strlen(partial);
733 for (alias = cmd_alias; alias; alias = alias->next)
734 if (!strncasecmp(partial, alias->name, len))
741 Cmd_CompleteAliasCountPossible
743 New function for tab-completion system
745 Thanks to Fett erich@heintz.com
749 int Cmd_CompleteAliasCountPossible (const char *partial)
757 len = strlen(partial);
762 // Loop through the command list and count all partial matches
763 for (alias = cmd_alias; alias; alias = alias->next)
764 if (!strncasecmp(partial, alias->name, len))
771 Cmd_CompleteAliasBuildList
773 New function for tab-completion system
775 Thanks to Fett erich@heintz.com
779 const char **Cmd_CompleteAliasBuildList (const char *partial)
784 size_t sizeofbuf = (Cmd_CompleteAliasCountPossible (partial) + 1) * sizeof (const char *);
787 len = strlen(partial);
788 buf = Mem_Alloc(tempmempool, sizeofbuf + sizeof (const char *));
789 // Loop through the alias list and print all matches
790 for (alias = cmd_alias; alias; alias = alias->next)
791 if (!strncasecmp(partial, alias->name, len))
792 buf[bpos++] = alias->name;
802 A complete command line has been parsed, so try to execute it
803 FIXME: lookupnoadd the token to speed search?
806 void Cmd_ExecuteString (const char *text, cmd_source_t src)
812 oldpos = cmd_tokenizebufferpos;
814 Cmd_TokenizeString (text);
816 // execute the command line
819 cmd_tokenizebufferpos = oldpos;
824 for (cmd=cmd_functions ; cmd ; cmd=cmd->next)
826 if (!strcasecmp (cmd_argv[0],cmd->name))
829 cmd_tokenizebufferpos = oldpos;
835 for (a=cmd_alias ; a ; a=a->next)
837 if (!strcasecmp (cmd_argv[0], a->name))
839 Cbuf_InsertText (a->value);
840 cmd_tokenizebufferpos = oldpos;
846 if (!Cvar_Command () && host_framecount > 0)
847 Con_Printf("Unknown command \"%s\"\n", Cmd_Argv(0));
849 cmd_tokenizebufferpos = oldpos;
855 Cmd_ForwardStringToServer
857 Sends an entire command string over to the server, unprocessed
860 void Cmd_ForwardStringToServer (const char *s)
862 if (cls.state != ca_connected)
864 Con_Printf("Can't \"%s\", not connected\n", s);
868 if (cls.demoplayback)
869 return; // not really connected
871 // LordHavoc: thanks to Fuh for bringing the pure evil of SZ_Print to my
872 // attention, it has been eradicated from here, its only (former) use in
873 // all of darkplaces.
874 MSG_WriteByte(&cls.message, clc_stringcmd);
875 SZ_Write(&cls.message, s, (int)strlen(s) + 1);
882 Sends the entire command line over to the server
885 void Cmd_ForwardToServer (void)
888 if (strcasecmp(Cmd_Argv(0), "cmd"))
889 s = va("%s %s", Cmd_Argv(0), Cmd_Argc() > 1 ? Cmd_Args() : "");
891 s = Cmd_Argc() > 1 ? Cmd_Args() : "";
892 Cmd_ForwardStringToServer(s);
900 Returns the position (1 to argc-1) in the command's argument list
901 where the given parameter apears, or 0 if not present
905 int Cmd_CheckParm (const char *parm)
911 Con_Printf ("Cmd_CheckParm: NULL");
915 for (i = 1; i < Cmd_Argc (); i++)
916 if (!strcasecmp (parm, Cmd_Argv (i)))