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 // Command flags
  45 #define CMD_CLIENT                              (1<<0)
  46 #define CMD_SERVER                              (1<<1)
  47 #define CMD_CLIENT_FROM_SERVER  (1<<2)
  48 #define CMD_SERVER_FROM_CLIENT  (1<<3)
  49 #define CMD_USERINFO                    (1<<4)
  50 #define CMD_CHEAT                               (1<<5)
  51
  52
  53 #define CMD_SHARED 3
  54
  55 typedef void(*xcommand_t) (struct cmd_state_s *cmd);
  56
  57 typedef enum
  58 {
  59         src_client,             ///< came in over a net connection as a clc_stringcmd
  60                                         ///< host_client will be valid during this state.
  61         src_command             ///< from the command buffer
  62 } cmd_source_t;
  63
  64 typedef struct cmdalias_s
  65 {
  66         struct cmdalias_s *next;
  67         char name[MAX_ALIAS_NAME];
  68         char *value;
  69         qboolean initstate; // indicates this command existed at init
  70         char *initialvalue; // backup copy of value at init
  71 } cmdalias_t;
  72
  73 typedef struct cmd_function_s
  74 {
  75         int flags;
  76         struct cmd_function_s *next;
  77         const char *name;
  78         const char *description;
  79         xcommand_t function;
  80         qboolean csqcfunc;
  81         qboolean autofunc;
  82         qboolean initstate; // indicates this command existed at init
  83 } cmd_function_t;
  84
  85 typedef struct cmddeferred_s
  86 {
  87         struct cmddeferred_s *next;
  88         char *value;
  89         double delay;
  90 } cmddeferred_t;
  91
  92 /// container for user-defined QC functions and aliases, shared between different command interpreters
  93 typedef struct cmd_userdefined_s
  94 {
  95         // csqc functions - this is a mess
  96         cmd_function_t *csqc_functions;
  97
  98         // aliases
  99         cmdalias_t *alias;
 100 }
 101 cmd_userdefined_t;
 102
 103 /// command interpreter state - the tokenizing and execution of commands, as well as pointers to which cvars and aliases they can access
 104 typedef struct cmd_state_s
 105 {
 106         mempool_t *mempool;
 107
 108         int argc;
 109         const char *argv[MAX_ARGS];
 110         const char *null_string;
 111         const char *args;
 112         cmd_source_t source;
 113
 114         struct cbuf_s *cbuf;
 115
 116         cmd_userdefined_t *userdefined; // possible csqc functions and aliases to execute
 117
 118         cmd_function_t *engine_functions;
 119
 120         cvar_state_t *cvars; // which cvar system is this cmd state able to access? (&cvars_all or &cvars_null)
 121         int cvars_flagsmask; // which CVAR_* flags should be visible to this interpreter? (CVAR_CLIENT | CVAR_SERVER, or just CVAR_SERVER)
 122
 123         int cmd_flags; // cmd flags that identify this interpreter
 124
 125         /*
 126          * If a requested flag matches auto_flags, a command will be
 127          * added to a given interpreter with auto_function. For example,
 128          * a CMD_SERVER_FROM_CLIENT command should be automatically added
 129          * to the client interpreter as CL_ForwardToServer_f. It can be
 130          * overridden at any time.
 131          */
 132         int auto_flags;
 133         xcommand_t auto_function;
 134 }
 135 cmd_state_t;
 136
 137 typedef struct cbuf_cmd_s
 138 {
 139         struct cbuf_cmd_s *prev, *next;
 140         cmd_state_t *source;
 141         double delay;
 142         size_t size;
 143         char text[MAX_INPUTLINE];
 144         qboolean pending;
 145 } cbuf_cmd_t;
 146
 147 typedef struct cbuf_s
 148 {
 149         cbuf_cmd_t *start;
 150         cbuf_cmd_t *deferred;
 151         cbuf_cmd_t *free;
 152         qboolean wait;
 153         size_t maxsize;
 154         size_t size;
 155         char tokenizebuffer[CMD_TOKENIZELENGTH];
 156         int tokenizebufferpos;
 157         double deferred_oldtime;
 158         void *lock;
 159 } cbuf_t;
 160
 161 extern cmd_userdefined_t cmd_userdefined_all; // aliases and csqc functions
 162 extern cmd_userdefined_t cmd_userdefined_null; // intentionally empty
 163
 164 // command interpreter for client commands injected by CSQC, MQC or client engine code
 165 // uses cmddefs_all
 166 extern cmd_state_t cmd_client;
 167 // command interpreter for server commands injected by MQC, SVQC, menu engine code or server engine code
 168 // uses cmddefs_all
 169 extern cmd_state_t cmd_server;
 170 // command interpreter for server commands received over network from clients
 171 // uses cmddefs_null
 172 extern cmd_state_t cmd_serverfromclient;
 173
 174 extern qboolean host_stuffcmdsrun;
 175
 176 void Cbuf_Lock(cbuf_t *cbuf);
 177 void Cbuf_Unlock(cbuf_t *cbuf);
 178
 179 /*! as new commands are generated from the console or keybindings,
 180  * the text is added to the end of the command buffer.
 181  */
 182 void Cbuf_AddText (cmd_state_t *cmd, const char *text);
 183
 184 /*! when a command wants to issue other commands immediately, the text is
 185  * inserted at the beginning of the buffer, before any remaining unexecuted
 186  * commands.
 187  */
 188 void Cbuf_InsertText (cmd_state_t *cmd, const char *text);
 189
 190 /*! Pulls off terminated lines of text from the command buffer and sends
 191  * them through Cmd_ExecuteString.  Stops when the buffer is empty.
 192  * Normally called once per frame, but may be explicitly invoked.
 193  * \note Do not call inside a command function!
 194  */
 195 void Cbuf_Execute (cbuf_t *cbuf);
 196 /*! Performs deferred commands and runs Cbuf_Execute, called by Host_Frame */
 197 void Cbuf_Frame (cbuf_t *cbuf);
 198
 199 //===========================================================================
 200
 201 /*
 202
 203 Command execution takes a null terminated string, breaks it into tokens,
 204 then searches for a command or variable that matches the first token.
 205
 206 Commands can come from three sources, but the handler functions may choose
 207 to dissallow the action or forward it to a remote server if the source is
 208 not apropriate.
 209
 210 */
 211
 212 void Cmd_Init(void);
 213 void Cmd_Shutdown(void);
 214
 215 // called by Host_Init, this marks cvars, commands and aliases with their init values
 216 void Cmd_SaveInitState(void);
 217 // called by FS_GameDir_f, this restores cvars, commands and aliases to init values
 218 void Cmd_RestoreInitState(void);
 219
 220 void Cmd_AddCommand(int flags, const char *cmd_name, xcommand_t function, const char *description);
 221 // called by the init functions of other parts of the program to
 222 // register commands and functions to call for them.
 223 // The cmd_name is referenced later, so it should not be in temp memory
 224
 225 cmd_function_t *Cmd_GetCommand(cmd_state_t *cmd, const char *partial, size_t len, qboolean casesensitive);
 226
 227 /// used by the cvar code to check for cvar / command name overlap
 228 qboolean Cmd_Exists (cmd_state_t *cmd, const char *cmd_name);
 229
 230 /// attempts to match a partial command for automatic command line completion
 231 /// returns NULL if nothing fits
 232 const char *Cmd_CompleteCommand (cmd_state_t *cmd, const char *partial);
 233
 234 int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial);
 235
 236 const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial);
 237
 238 int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial);
 239
 240 const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial);
 241
 242 void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial);
 243
 244 const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial);
 245
 246 void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial);
 247
 248 // Enhanced console completion by Fett erich@heintz.com
 249
 250 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 251
 252 int Cmd_Argc (cmd_state_t *cmd);
 253 const char *Cmd_Argv (cmd_state_t *cmd, int arg);
 254 const char *Cmd_Args (cmd_state_t *cmd);
 255 // The functions that execute commands get their parameters with these
 256 // functions. Cmd_Argv(cmd, ) will return an empty string, not a NULL
 257 // if arg > argc, so string operations are always safe.
 258
 259 /// Returns the position (1 to argc-1) in the command's argument list
 260 /// where the given parameter apears, or 0 if not present
 261 int Cmd_CheckParm (cmd_state_t *cmd, const char *parm);
 262
 263 //void Cmd_TokenizeString (char *text);
 264 // Takes a null terminated string.  Does not need to be /n terminated.
 265 // breaks the string up into arg tokens.
 266
 267 /// Parses a single line of text into arguments and tries to execute it.
 268 /// The text can come from the command buffer, a remote client, or stdin.
 269 void Cmd_ExecuteString (cmd_state_t *cmd, const char *text, cmd_source_t src, qboolean lockmutex);
 270
 271 /// quotes a string so that it can be used as a command argument again;
 272 /// quoteset is a string that contains one or more of ", \, $ and specifies
 273 /// the characters to be quoted (you usually want to either pass "\"\\" or
 274 /// "\"\\$"). Returns true on success, and false on overrun (in which case out
 275 /// will contain a part of the quoted string). If putquotes is set, the
 276 /// enclosing quote marks are also put.
 277 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes);
 278
 279 void Cmd_ClearCSQCCommands (cmd_state_t *cmd);
 280
 281 #endif
 282