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 ();
48 #define CF_CLIENT (1<<0) // cvar/command that only the client can change/execute
49 #define CF_SERVER (1<<1) // cvar/command that only the server can change/execute
50 #define CF_CLIENT_FROM_SERVER (1<<2) // command that the server is allowed to execute on the client
51 #define CF_SERVER_FROM_CLIENT (1<<3) // command the client is allowed to execute on the server as a stringcmd
52 #define CF_CHEAT (1<<4) // command or cvar that gives an unfair advantage over other players and is blocked unless sv_cheats is 1
53 #define CF_ARCHIVE (1<<5) // cvar should have its set value saved to config.cfg and persist across sessions
54 #define CF_READONLY (1<<6) // cvar cannot be changed from the console or the command buffer
55 #define CF_NOTIFY (1<<7) // cvar should trigger a chat notification to all connected clients when changed
56 #define CF_SERVERINFO (1<<8) // command or cvar relevant to serverinfo string handling
57 #define CF_USERINFO (1<<9) // command or cvar used to communicate userinfo to the server
58 #define CF_PERSISTENT (1<<10) // cvar must not be reset on gametype switch (such as scr_screenshot_name, which otherwise isn't set to the mod name properly)
59 #define CF_PRIVATE (1<<11) // cvar should not be $ expanded or sent to the server under any circumstances (rcon_password, etc)
60 #define CF_MAXFLAGSVAL ((1<<12) - 1) // used to determine if flags is valid
61 // for internal use only!
62 #define CF_REGISTERED (1<<29) // created by Cvar_RegisterVariable()
63 #define CF_DEFAULTSET (1<<30)
64 #define CF_ALLOCATED (1<<31) // created by Cvar_Get() (console or QC)
68 typedef void(*xcommand_t) (struct cmd_state_s *cmd);
70 typedef enum cmd_source_s
72 src_client, ///< came in over a net connection as a clc_stringcmd
73 ///< host_client will be valid during this state.
74 src_local ///< from the command buffer
77 typedef struct cmd_alias_s
79 struct cmd_alias_s *next;
80 char name[MAX_ALIAS_NAME];
82 qbool initstate; // indicates this command existed at init
83 char *initialvalue; // backup copy of value at init
86 typedef struct cmd_function_s
89 struct cmd_function_s *next;
91 const char *description;
94 struct cmd_function_s *overridden; // the engine cmd overriden by this QC cmd, if applicable
96 qbool initstate; // indicates this command existed at init
99 /// container for user-defined QC functions and aliases, shared between different command interpreters
100 typedef struct cmd_userdefined_s
102 // csqc functions - this is a mess
103 cmd_function_t *qc_functions;
110 typedef struct cmd_buf_s
118 char tokenizebuffer[CMD_TOKENIZELENGTH];
119 int tokenizebufferpos;
120 double deferred_oldtime;
124 /// command interpreter state - the tokenizing and execution of commands, as well as pointers to which cvars and aliases they can access
125 typedef struct cmd_state_s
127 struct mempool_s *mempool;
131 const char *argv[MAX_ARGS];
132 const char *null_string;
138 cmd_userdefined_t *userdefined; // possible csqc functions and aliases to execute
140 cmd_function_t *engine_functions;
142 struct cvar_state_s *cvars; // which cvar system is this cmd state able to access? (&cvars_all or &cvars_null)
143 unsigned cvars_flagsmask; // which CVAR_* flags should be visible to this interpreter? (CF_CLIENT | CF_SERVER, or just CF_SERVER)
144 unsigned cmd_flagsmask; // cmd flags that identify this interpreter
146 qbool (*Handle)(struct cmd_state_s *, struct cmd_function_s *, const char *, enum cmd_source_s);
150 qbool Cmd_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, cmd_source_t src);
151 qbool Cmd_CL_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, cmd_source_t src);
152 qbool Cmd_SV_Callback(cmd_state_t *cmd, cmd_function_t *func, const char *text, cmd_source_t src);
154 typedef struct cmd_input_s
165 extern cmd_userdefined_t cmd_userdefined_all; // aliases and csqc functions
166 extern cmd_userdefined_t cmd_userdefined_null; // intentionally empty
168 // command interpreter for local commands injected by SVQC, CSQC, MQC, server or client engine code
170 extern cmd_state_t *cmd_local;
171 // command interpreter for server commands received over network from clients
173 extern cmd_state_t *cmd_serverfromclient;
175 extern qbool host_stuffcmdsrun;
177 void Cbuf_Lock(cmd_buf_t *cbuf);
178 void Cbuf_Unlock(cmd_buf_t *cbuf);
180 /*! as new commands are generated from the console or keybindings,
181 * the text is added to the end of the command buffer.
183 void Cbuf_AddText (cmd_state_t *cmd, const char *text);
185 /*! when a command wants to issue other commands immediately, the text is
186 * inserted at the beginning of the buffer, before any remaining unexecuted
189 void Cbuf_InsertText (cmd_state_t *cmd, const char *text);
191 /*! Pulls off terminated lines of text from the command buffer and sends
192 * them through Cmd_ExecuteString. Stops when the buffer is empty.
193 * Normally called once per frame, but may be explicitly invoked.
194 * \note Do not call inside a command function!
196 void Cbuf_Execute (cmd_buf_t *cbuf);
197 /*! Performs deferred commands and runs Cbuf_Execute, called by Host_Frame */
198 void Cbuf_Frame (cmd_buf_t *cbuf);
199 /// Clears all command buffers
200 void Cbuf_Clear(cmd_buf_t *cbuf);
202 //===========================================================================
206 Command execution takes a null terminated string, breaks it into tokens,
207 then searches for a command or variable that matches the first token.
209 Commands can come from three sources, but the handler functions may choose
210 to dissallow the action or forward it to a remote server if the source is
216 void Cmd_Shutdown(void);
218 // called by Host_Init, this marks cvars, commands and aliases with their init values
219 void Cmd_SaveInitState(void);
220 // called by FS_GameDir_f, this restores cvars, commands and aliases to init values
221 void Cmd_RestoreInitState(void);
223 void Cmd_AddCommand(unsigned flags, const char *cmd_name, xcommand_t function, const char *description);
224 // called by the init functions of other parts of the program to
225 // register commands and functions to call for them.
226 // The cmd_name is referenced later, so it should not be in temp memory
228 /// used by the cvar code to check for cvar / command name overlap
229 qbool Cmd_Exists (cmd_state_t *cmd, const char *cmd_name);
231 /// attempts to match a partial command for automatic command line completion
232 /// returns NULL if nothing fits
233 const char *Cmd_CompleteCommand (cmd_state_t *cmd, const char *partial);
235 int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial);
236 const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial);
237 int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial);
238 const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial);
239 void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial);
240 const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial);
241 void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial);
243 // Enhanced console completion by Fett erich@heintz.com
244 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
246 // The functions that execute commands get their parameters with these
247 // functions. Cmd_Argv(cmd, ) will return an empty string, not a NULL
248 // if arg > argc, so string operations are always safe.
249 static inline int Cmd_Argc (cmd_state_t *cmd)
253 static inline const char *Cmd_Argv(cmd_state_t *cmd, int arg)
255 if (arg >= cmd->argc )
256 return cmd->null_string;
257 return cmd->argv[arg];
259 static inline const char *Cmd_Args (cmd_state_t *cmd)
264 /// Returns the position (1 to argc-1) in the command's argument list
265 /// where the given parameter apears, or 0 if not present
266 int Cmd_CheckParm (cmd_state_t *cmd, const char *parm);
268 /// Parses a single line of text into arguments and tries to execute it.
269 /// The text can come from the command buffer, a remote client, or stdin.
270 void Cmd_ExecuteString (cmd_state_t *cmd, const char *text, cmd_source_t src, qbool lockmutex);
272 /// quotes a string so that it can be used as a command argument again;
273 /// quoteset is a string that contains one or more of ", \, $ and specifies
274 /// the characters to be quoted (you usually want to either pass "\"\\" or
275 /// "\"\\$"). Returns true on success, and false on overrun (in which case out
276 /// will contain a part of the quoted string). If putquotes is set, the
277 /// enclosing quote marks are also put.
278 qbool Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qbool putquotes);
280 void Cmd_ClearCSQCCommands (cmd_state_t *cmd);
282 void Cmd_NoOperation_f(cmd_state_t *cmd);