This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
#ifndef CMD_H
#define CMD_H
-void Cbuf_Init (void);
-// allocates an initial text buffer that will grow as needed
+#include "thread.h"
-void Cbuf_AddText (char *text);
-// as new commands are generated from the console or keybindings,
-// the text is added to the end of the command buffer.
+struct cmd_state_s;
-void Cbuf_InsertText (char *text);
-// when a command wants to issue other commands immediately, the text is
-// inserted at the beginning of the buffer, before any remaining unexecuted
-// commands.
+typedef void(*xcommand_t) (struct cmd_state_s *cmd);
-void Cbuf_Execute (void);
-// Pulls off \n terminated lines of text from the command buffer and sends
-// them through Cmd_ExecuteString. Stops when the buffer is empty.
-// Normally called once per frame, but may be explicitly invoked.
-// Do not call inside a command function!
+typedef enum
+{
+ src_client, ///< came in over a net connection as a clc_stringcmd
+ ///< host_client will be valid during this state.
+ src_command ///< from the command buffer
+} cmd_source_t;
+
+typedef struct cmdalias_s
+{
+ struct cmdalias_s *next;
+ char name[MAX_ALIAS_NAME];
+ char *value;
+ qboolean initstate; // indicates this command existed at init
+ char *initialvalue; // backup copy of value at init
+} cmdalias_t;
+
+typedef struct cmd_function_s
+{
+ struct cmd_function_s *next;
+ const char *name;
+ const char *description;
+ xcommand_t function;
+ qboolean csqcfunc;
+ qboolean initstate; // indicates this command existed at init
+} cmd_function_t;
+
+typedef struct cmddeferred_s
+{
+ struct cmddeferred_s *next;
+ char *value;
+ double delay;
+} cmddeferred_t;
+
+/// container for user-defined QC functions and aliases, shared between different command interpreters
+typedef struct cmd_userdefined_s
+{
+ // csqc functions - this is a mess
+ cmd_function_t *csqc_functions;
+
+ // aliases
+ cmdalias_t *alias;
+}
+cmd_userdefined_t;
+
+/// command interpreter state - the tokenizing and execution of commands, as well as pointers to which cvars and aliases they can access
+typedef struct cmd_state_s
+{
+ qboolean wait;
+
+ mempool_t *mempool;
+
+ char tokenizebuffer[CMD_TOKENIZELENGTH];
+ int tokenizebufferpos;
+
+ cmddeferred_t *deferred_list;
+ double deferred_oldrealtime;
+
+ sizebuf_t text;
+ unsigned char text_buf[CMDBUFSIZE];
+ Thread_SpinLock text_lock;
+
+ int argc;
+ const char *argv[MAX_ARGS];
+ const char *null_string;
+ const char *args;
+ cmd_source_t source;
+
+ cmd_userdefined_t *userdefined; // possible csqc functions and aliases to execute
+
+ cmd_function_t *engine_functions;
+
+ cvar_state_t *cvars; // which cvar system is this cmd state able to access? (&cvars_all or &cvars_null)
+ int cvars_flagsmask; // which CVAR_* flags should be visible to this interpreter? (CVAR_CLIENT | CVAR_SERVER, or just CVAR_SERVER)
+}
+cmd_state_t;
+
+extern cmd_userdefined_t cmd_userdefined_all; // aliases and csqc functions
+extern cmd_userdefined_t cmd_userdefined_null; // intentionally empty
+
+// command interpreter for client commands injected by CSQC, MQC or client engine code
+// uses cmddefs_all
+extern cmd_state_t cmd_client;
+// command interpreter for server commands injected by MQC, SVQC, menu engine code or server engine code
+// uses cmddefs_all
+extern cmd_state_t cmd_server;
+// command interpreter for server commands received over network from clients
+// uses cmddefs_null
+extern cmd_state_t cmd_serverfromclient;
+
+extern qboolean host_stuffcmdsrun;
+
+void Cbuf_Lock(cmd_state_t *cmd);
+void Cbuf_Unlock(cmd_state_t *cmd);
+
+void Cmd_Init_Commands(qboolean dedicated_server);
+
+/*! as new commands are generated from the console or keybindings,
+ * the text is added to the end of the command buffer.
+ */
+void Cbuf_AddText (cmd_state_t *cmd, const char *text);
+
+/*! when a command wants to issue other commands immediately, the text is
+ * inserted at the beginning of the buffer, before any remaining unexecuted
+ * commands.
+ */
+void Cbuf_InsertText (cmd_state_t *cmd, const char *text);
+
+/*! Pulls off terminated lines of text from the command buffer and sends
+ * them through Cmd_ExecuteString. Stops when the buffer is empty.
+ * Normally called once per frame, but may be explicitly invoked.
+ * \note Do not call inside a command function!
+ */
+void Cbuf_Execute (cmd_state_t *cmd);
+/*! Performs deferred commands and runs Cbuf_Execute, called by Host_Main */
+void Cbuf_Frame (cmd_state_t *cmd);
//===========================================================================
*/
-typedef void (*xcommand_t) (void);
+void Cmd_Init(void);
+void Cmd_Shutdown(void);
-typedef enum
-{
- src_client, // came in over a net connection as a clc_stringcmd
- // host_client will be valid during this state.
- src_command // from the command buffer
-} cmd_source_t;
-
-extern cmd_source_t cmd_source;
-
-void Cmd_Init (void);
+// called by Host_Init, this marks cvars, commands and aliases with their init values
+void Cmd_SaveInitState(void);
+// called by FS_GameDir_f, this restores cvars, commands and aliases to init values
+void Cmd_RestoreInitState(void);
-void Cmd_AddCommand (char *cmd_name, xcommand_t function);
+void Cmd_AddCommand(cmd_state_t *cmd, const char *cmd_name, xcommand_t function, const char *description);
// called by the init functions of other parts of the program to
// register commands and functions to call for them.
// The cmd_name is referenced later, so it should not be in temp memory
-qboolean Cmd_Exists (char *cmd_name);
-// used by the cvar code to check for cvar / command name overlap
+/// used by the cvar code to check for cvar / command name overlap
+qboolean Cmd_Exists (cmd_state_t *cmd, const char *cmd_name);
-char *Cmd_CompleteCommand (char *partial);
-// attempts to match a partial command for automatic command line completion
-// returns NULL if nothing fits
+/// attempts to match a partial command for automatic command line completion
+/// returns NULL if nothing fits
+const char *Cmd_CompleteCommand (cmd_state_t *cmd, const char *partial);
-int Cmd_CompleteAliasCountPossible (char *partial);
+int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial);
-char **Cmd_CompleteAliasBuildList (char *partial);
+const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial);
-int Cmd_CompleteCountPossible (char *partial);
+int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial);
-char **Cmd_CompleteBuildList (char *partial);
+const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial);
-char *Cmd_CompleteAlias (char *partial);
+void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial);
+
+const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial);
+
+void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial);
// Enhanced console completion by Fett erich@heintz.com
// Added by EvilTypeGuy eviltypeguy@qeradiant.com
-int Cmd_Argc (void);
-char *Cmd_Argv (int arg);
-char *Cmd_Args (void);
+int Cmd_Argc (cmd_state_t *cmd);
+const char *Cmd_Argv (cmd_state_t *cmd, int arg);
+const char *Cmd_Args (cmd_state_t *cmd);
// The functions that execute commands get their parameters with these
-// functions. Cmd_Argv () will return an empty string, not a NULL
+// functions. Cmd_Argv(cmd, ) will return an empty string, not a NULL
// if arg > argc, so string operations are always safe.
-int Cmd_CheckParm (char *parm);
-// Returns the position (1 to argc-1) in the command's argument list
-// where the given parameter apears, or 0 if not present
+/// Returns the position (1 to argc-1) in the command's argument list
+/// where the given parameter apears, or 0 if not present
+int Cmd_CheckParm (cmd_state_t *cmd, const char *parm);
//void Cmd_TokenizeString (char *text);
// Takes a null terminated string. Does not need to be /n terminated.
// breaks the string up into arg tokens.
-void Cmd_ExecuteString (char *text, cmd_source_t src);
-// Parses a single line of text into arguments and tries to execute it.
-// The text can come from the command buffer, a remote client, or stdin.
+/// Parses a single line of text into arguments and tries to execute it.
+/// The text can come from the command buffer, a remote client, or stdin.
+void Cmd_ExecuteString (cmd_state_t *cmd, const char *text, cmd_source_t src, qboolean lockmutex);
+
+/// adds the string as a clc_stringcmd to the client message.
+/// (used when there is no reason to generate a local command to do it)
+void Cmd_ForwardStringToServer (const char *s);
+
+/// adds the current command line as a clc_stringcmd to the client message.
+/// things like godmode, noclip, etc, are commands directed to the server,
+/// so when they are typed in at the console, they will need to be forwarded.
+void Cmd_ForwardToServer_f (cmd_state_t *cmd);
-void Cmd_ForwardToServer (void);
-// adds the current command line as a clc_stringcmd to the client message.
-// things like godmode, noclip, etc, are commands directed to the server,
-// so when they are typed in at the console, they will need to be forwarded.
+/// quotes a string so that it can be used as a command argument again;
+/// quoteset is a string that contains one or more of ", \, $ and specifies
+/// the characters to be quoted (you usually want to either pass "\"\\" or
+/// "\"\\$"). Returns true on success, and false on overrun (in which case out
+/// will contain a part of the quoted string). If putquotes is set, the
+/// enclosing quote marks are also put.
+qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes);
-void Cmd_Print (char *text);
-// used by command functions to send output to either the graphics console or
-// passed as a print message to the client
+void Cmd_ClearCSQCCommands (cmd_state_t *cmd);
#endif
projects / xonotic / darkplaces.git / blobdiff