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.
21 // cmd.h -- Command buffer and command execution
23 //===========================================================================
27 Any number of commands can be added in a frame, from several different sources.
28 Most commands come from either keybindings or console line input, but remote
29 servers can also send across commands and entire text files can be execed.
31 The + command line options are also added to the command buffer.
33 The game starts with a Cbuf_AddText ("exec quake.rc\n"); Cbuf_Execute ();
44 typedef void(*xcommand_t) (struct cmd_state_s *cmd);
48 src_client, ///< came in over a net connection as a clc_stringcmd
49 ///< host_client will be valid during this state.
50 src_command ///< from the command buffer
53 typedef struct cmdalias_s
55 struct cmdalias_s *next;
56 char name[MAX_ALIAS_NAME];
58 qboolean initstate; // indicates this command existed at init
59 char *initialvalue; // backup copy of value at init
62 typedef struct cmd_function_s
64 struct cmd_function_s *next;
66 const char *description;
69 qboolean initstate; // indicates this command existed at init
72 typedef struct cmddeferred_s
74 struct cmddeferred_s *next;
79 typedef struct cmd_state_s
87 char tokenizebuffer[CMD_TOKENIZELENGTH];
88 int tokenizebufferpos;
90 cmddeferred_t *deferred_list;
93 unsigned char text_buf[CMDBUFSIZE];
94 Thread_SpinLock text_lock;
97 const char *argv[MAX_ARGS];
98 const char *null_string;
102 cmd_function_t *functions; // possible commands to execute
104 cvar_state_t *cvars; // which cvar system is this cmd state able to access? (&cvars_all or &cvars_null)
105 int cvars_flagsmask; // which CVAR_* flags should be visible to this interpreter? (CVAR_CLIENT | CVAR_SERVER, or just CVAR_SERVER)
109 // command interpreter for client commands injected by CSQC, MQC or client engine code
110 extern cmd_state_t cmd_client;
111 // command interpreter for client commands received over network from server
112 extern cmd_state_t cmd_clientfromserver;
113 // command interpreter for server commands injected by MQC, SVQC, menu engine code or server engine code
114 extern cmd_state_t cmd_server;
115 // command interpreter for server commands received over network from clients
116 extern cmd_state_t cmd_serverfromclient;
118 extern qboolean host_stuffcmdsrun;
120 void Cbuf_Lock(cmd_state_t *cmd);
121 void Cbuf_Unlock(cmd_state_t *cmd);
123 void Cmd_Init_Commands(qboolean dedicated_server);
125 /*! as new commands are generated from the console or keybindings,
126 * the text is added to the end of the command buffer.
128 void Cbuf_AddText (cmd_state_t *cmd, const char *text);
130 /*! when a command wants to issue other commands immediately, the text is
131 * inserted at the beginning of the buffer, before any remaining unexecuted
134 void Cbuf_InsertText (cmd_state_t *cmd, const char *text);
136 /*! Pulls off terminated lines of text from the command buffer and sends
137 * them through Cmd_ExecuteString. Stops when the buffer is empty.
138 * Normally called once per frame, but may be explicitly invoked.
139 * \note Do not call inside a command function!
141 void Cbuf_Execute (cmd_state_t *cmd);
142 /*! Performs deferred commands and runs Cbuf_Execute, called by Host_Main */
143 void Cbuf_Frame (cmd_state_t *cmd);
145 //===========================================================================
149 Command execution takes a null terminated string, breaks it into tokens,
150 then searches for a command or variable that matches the first token.
152 Commands can come from three sources, but the handler functions may choose
153 to dissallow the action or forward it to a remote server if the source is
159 void Cmd_Shutdown(void);
161 // called by Host_Init, this marks cvars, commands and aliases with their init values
162 void Cmd_SaveInitState(void);
163 // called by FS_GameDir_f, this restores cvars, commands and aliases to init values
164 void Cmd_RestoreInitState(void);
166 void Cmd_AddCommand(cmd_state_t *cmd, const char *cmd_name, xcommand_t function, const char *description);
167 // called by the init functions of other parts of the program to
168 // register commands and functions to call for them.
169 // The cmd_name is referenced later, so it should not be in temp memory
171 /// used by the cvar code to check for cvar / command name overlap
172 qboolean Cmd_Exists (cmd_state_t *cmd, const char *cmd_name);
174 /// attempts to match a partial command for automatic command line completion
175 /// returns NULL if nothing fits
176 const char *Cmd_CompleteCommand (cmd_state_t *cmd, const char *partial);
178 int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial);
180 const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial);
182 int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial);
184 const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial);
186 void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial);
188 const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial);
190 void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial);
192 // Enhanced console completion by Fett erich@heintz.com
194 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
196 int Cmd_Argc (cmd_state_t *cmd);
197 const char *Cmd_Argv (cmd_state_t *cmd, int arg);
198 const char *Cmd_Args (cmd_state_t *cmd);
199 // The functions that execute commands get their parameters with these
200 // functions. Cmd_Argv(cmd, ) will return an empty string, not a NULL
201 // if arg > argc, so string operations are always safe.
203 /// Returns the position (1 to argc-1) in the command's argument list
204 /// where the given parameter apears, or 0 if not present
205 int Cmd_CheckParm (cmd_state_t *cmd, const char *parm);
207 //void Cmd_TokenizeString (char *text);
208 // Takes a null terminated string. Does not need to be /n terminated.
209 // breaks the string up into arg tokens.
211 /// Parses a single line of text into arguments and tries to execute it.
212 /// The text can come from the command buffer, a remote client, or stdin.
213 void Cmd_ExecuteString (cmd_state_t *cmd, const char *text, cmd_source_t src, qboolean lockmutex);
215 /// adds the string as a clc_stringcmd to the client message.
216 /// (used when there is no reason to generate a local command to do it)
217 void Cmd_ForwardStringToServer (const char *s);
219 /// adds the current command line as a clc_stringcmd to the client message.
220 /// things like godmode, noclip, etc, are commands directed to the server,
221 /// so when they are typed in at the console, they will need to be forwarded.
222 void Cmd_ForwardToServer_f (cmd_state_t *cmd);
224 /// quotes a string so that it can be used as a command argument again;
225 /// quoteset is a string that contains one or more of ", \, $ and specifies
226 /// the characters to be quoted (you usually want to either pass "\"\\" or
227 /// "\"\\$"). Returns true on success, and false on overrun (in which case out
228 /// will contain a part of the quoted string). If putquotes is set, the
229 /// enclosing quote marks are also put.
230 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes);
232 void Cmd_ClearCsqcFuncs (cmd_state_t *cmd);