cmd.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   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.
   8
   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.
  12
  13 See the GNU General Public License for more details.
  14
  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.
  18
  19 */
  20
  21 // cmd.h -- Command buffer and command execution
  22
  23 //===========================================================================
  24
  25 /*
  26
  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.
  30
  31 The + command line options are also added to the command buffer.
  32
  33 The game starts with a Cbuf_AddText ("exec quake.rc\n"); Cbuf_Execute ();
  34
  35 */
  36
  37 #ifndef CMD_H
  38 #define CMD_H
  39
  40 #include "thread.h"
  41
  42 struct cmd_state_s;
  43
  44 typedef void(*xcommand_t) (struct cmd_state_s *cmd);
  45
  46 typedef enum
  47 {
  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
  51 } cmd_source_t;
  52
  53 typedef struct cmdalias_s
  54 {
  55         struct cmdalias_s *next;
  56         char name[MAX_ALIAS_NAME];
  57         char *value;
  58         qboolean initstate; // indicates this command existed at init
  59         char *initialvalue; // backup copy of value at init
  60 } cmdalias_t;
  61
  62 typedef struct cmd_function_s
  63 {
  64         struct cmd_function_s *next;
  65         const char *name;
  66         const char *description;
  67         xcommand_t function;
  68         qboolean csqcfunc;
  69         qboolean initstate; // indicates this command existed at init
  70 } cmd_function_t;
  71
  72 typedef struct cmddeferred_s
  73 {
  74         struct cmddeferred_s *next;
  75         char *value;
  76         double delay;
  77 } cmddeferred_t;
  78
  79 /// container for user-defined QC functions and aliases, shared between different command interpreters
  80 typedef struct cmd_userdefined_s
  81 {
  82         // csqc functions - this is a mess
  83         cmd_function_t *csqc_functions;
  84
  85         // aliases
  86         cmdalias_t *alias;
  87 }
  88 cmd_userdefined_t;
  89
  90 /// command interpreter state - the tokenizing and execution of commands, as well as pointers to which cvars and aliases they can access
  91 typedef struct cmd_state_s
  92 {
  93         qboolean wait;
  94
  95         mempool_t *mempool;
  96
  97         char tokenizebuffer[CMD_TOKENIZELENGTH];
  98         int tokenizebufferpos;
  99
 100         cmddeferred_t *deferred_list;
 101
 102         sizebuf_t text;
 103         unsigned char text_buf[CMDBUFSIZE];
 104         Thread_SpinLock text_lock;
 105
 106         int argc;
 107         const char *argv[MAX_ARGS];
 108         const char *null_string;
 109         const char *args;
 110         cmd_source_t source;
 111
 112         cmd_userdefined_t *userdefined; // possible csqc functions and aliases to execute
 113
 114         cmd_function_t *engine_functions;
 115
 116         cvar_state_t *cvars; // which cvar system is this cmd state able to access? (&cvars_all or &cvars_null)
 117         int cvars_flagsmask; // which CVAR_* flags should be visible to this interpreter? (CVAR_CLIENT | CVAR_SERVER, or just CVAR_SERVER)
 118 }
 119 cmd_state_t;
 120
 121 extern cmd_userdefined_t cmd_userdefined_all; // aliases and csqc functions
 122 extern cmd_userdefined_t cmd_userdefined_null; // intentionally empty
 123
 124 // command interpreter for client commands injected by CSQC, MQC or client engine code
 125 // uses cmddefs_all
 126 extern cmd_state_t cmd_client;
 127 // command interpreter for client commands received over network from server
 128 // uses cmddefs_all
 129 extern cmd_state_t cmd_clientfromserver;
 130 // command interpreter for server commands injected by MQC, SVQC, menu engine code or server engine code
 131 // uses cmddefs_all
 132 extern cmd_state_t cmd_server;
 133 // command interpreter for server commands received over network from clients
 134 // uses cmddefs_null
 135 extern cmd_state_t cmd_serverfromclient;
 136
 137 extern qboolean host_stuffcmdsrun;
 138
 139 void Cbuf_Lock(cmd_state_t *cmd);
 140 void Cbuf_Unlock(cmd_state_t *cmd);
 141
 142 void Cmd_Init_Commands(qboolean dedicated_server);
 143
 144 /*! as new commands are generated from the console or keybindings,
 145  * the text is added to the end of the command buffer.
 146  */
 147 void Cbuf_AddText (cmd_state_t *cmd, const char *text);
 148
 149 /*! when a command wants to issue other commands immediately, the text is
 150  * inserted at the beginning of the buffer, before any remaining unexecuted
 151  * commands.
 152  */
 153 void Cbuf_InsertText (cmd_state_t *cmd, const char *text);
 154
 155 /*! Pulls off terminated lines of text from the command buffer and sends
 156  * them through Cmd_ExecuteString.  Stops when the buffer is empty.
 157  * Normally called once per frame, but may be explicitly invoked.
 158  * \note Do not call inside a command function!
 159  */
 160 void Cbuf_Execute (cmd_state_t *cmd);
 161 /*! Performs deferred commands and runs Cbuf_Execute, called by Host_Main */
 162 void Cbuf_Frame (cmd_state_t *cmd);
 163
 164 //===========================================================================
 165
 166 /*
 167
 168 Command execution takes a null terminated string, breaks it into tokens,
 169 then searches for a command or variable that matches the first token.
 170
 171 Commands can come from three sources, but the handler functions may choose
 172 to dissallow the action or forward it to a remote server if the source is
 173 not apropriate.
 174
 175 */
 176
 177 void Cmd_Init(void);
 178 void Cmd_Shutdown(void);
 179
 180 // called by Host_Init, this marks cvars, commands and aliases with their init values
 181 void Cmd_SaveInitState(void);
 182 // called by FS_GameDir_f, this restores cvars, commands and aliases to init values
 183 void Cmd_RestoreInitState(void);
 184
 185 void Cmd_AddCommand(cmd_state_t *cmd, const char *cmd_name, xcommand_t function, const char *description);
 186 // called by the init functions of other parts of the program to
 187 // register commands and functions to call for them.
 188 // The cmd_name is referenced later, so it should not be in temp memory
 189
 190 /// used by the cvar code to check for cvar / command name overlap
 191 qboolean Cmd_Exists (cmd_state_t *cmd, const char *cmd_name);
 192
 193 /// attempts to match a partial command for automatic command line completion
 194 /// returns NULL if nothing fits
 195 const char *Cmd_CompleteCommand (cmd_state_t *cmd, const char *partial);
 196
 197 int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial);
 198
 199 const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial);
 200
 201 int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial);
 202
 203 const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial);
 204
 205 void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial);
 206
 207 const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial);
 208
 209 void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial);
 210
 211 // Enhanced console completion by Fett erich@heintz.com
 212
 213 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 214
 215 int Cmd_Argc (cmd_state_t *cmd);
 216 const char *Cmd_Argv (cmd_state_t *cmd, int arg);
 217 const char *Cmd_Args (cmd_state_t *cmd);
 218 // The functions that execute commands get their parameters with these
 219 // functions. Cmd_Argv(cmd, ) will return an empty string, not a NULL
 220 // if arg > argc, so string operations are always safe.
 221
 222 /// Returns the position (1 to argc-1) in the command's argument list
 223 /// where the given parameter apears, or 0 if not present
 224 int Cmd_CheckParm (cmd_state_t *cmd, const char *parm);
 225
 226 //void Cmd_TokenizeString (char *text);
 227 // Takes a null terminated string.  Does not need to be /n terminated.
 228 // breaks the string up into arg tokens.
 229
 230 /// Parses a single line of text into arguments and tries to execute it.
 231 /// The text can come from the command buffer, a remote client, or stdin.
 232 void Cmd_ExecuteString (cmd_state_t *cmd, const char *text, cmd_source_t src, qboolean lockmutex);
 233
 234 /// adds the string as a clc_stringcmd to the client message.
 235 /// (used when there is no reason to generate a local command to do it)
 236 void Cmd_ForwardStringToServer (const char *s);
 237
 238 /// adds the current command line as a clc_stringcmd to the client message.
 239 /// things like godmode, noclip, etc, are commands directed to the server,
 240 /// so when they are typed in at the console, they will need to be forwarded.
 241 void Cmd_ForwardToServer_f (cmd_state_t *cmd);
 242
 243 /// quotes a string so that it can be used as a command argument again;
 244 /// quoteset is a string that contains one or more of ", \, $ and specifies
 245 /// the characters to be quoted (you usually want to either pass "\"\\" or
 246 /// "\"\\$"). Returns true on success, and false on overrun (in which case out
 247 /// will contain a part of the quoted string). If putquotes is set, the
 248 /// enclosing quote marks are also put.
 249 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes);
 250
 251 void Cmd_ClearCSQCCommands (cmd_state_t *cmd);
 252
 253 #endif
 254