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_local               ///< from the command buffer
  62 } cmd_source_t;
  63
  64 typedef struct cmd_alias_s
  65 {
  66         struct cmd_alias_s *next;
  67         char name[MAX_ALIAS_NAME];
  68         char *value;
  69         qbool initstate; // indicates this command existed at init
  70         char *initialvalue; // backup copy of value at init
  71 } cmd_alias_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         qbool csqcfunc;
  81         qbool autofunc;
  82         qbool 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         cmd_alias_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 cmd_input_s
 138 {
 139         llist_t list;
 140         cmd_state_t *source;
 141         double delay;
 142         size_t size;
 143         size_t length;
 144         char *text;
 145         qbool pending;
 146 } cmd_input_t;
 147
 148 typedef struct cbuf_s
 149 {
 150         llist_t start;
 151         llist_t deferred;
 152         llist_t free;
 153         qbool wait;
 154         size_t maxsize;
 155         size_t size;
 156         char tokenizebuffer[CMD_TOKENIZELENGTH];
 157         int tokenizebufferpos;
 158         double deferred_oldtime;
 159         void *lock;
 160 } cbuf_t;
 161
 162 extern cmd_userdefined_t cmd_userdefined_all; // aliases and csqc functions
 163 extern cmd_userdefined_t cmd_userdefined_null; // intentionally empty
 164
 165 // command interpreter for client commands injected by CSQC, MQC or client engine code
 166 // uses cmddefs_all
 167 extern cmd_state_t cmd_client;
 168 // command interpreter for server commands injected by MQC, SVQC, menu engine code or server engine code
 169 // uses cmddefs_all
 170 extern cmd_state_t cmd_server;
 171 // command interpreter for server commands received over network from clients
 172 // uses cmddefs_null
 173 extern cmd_state_t cmd_serverfromclient;
 174
 175 extern qbool host_stuffcmdsrun;
 176
 177 void Cbuf_Lock(cbuf_t *cbuf);
 178 void Cbuf_Unlock(cbuf_t *cbuf);
 179
 180 /*! as new commands are generated from the console or keybindings,
 181  * the text is added to the end of the command buffer.
 182  */
 183 void Cbuf_AddText (cmd_state_t *cmd, const char *text);
 184
 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
 187  * commands.
 188  */
 189 void Cbuf_InsertText (cmd_state_t *cmd, const char *text);
 190
 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!
 195  */
 196 void Cbuf_Execute (cbuf_t *cbuf);
 197 /*! Performs deferred commands and runs Cbuf_Execute, called by Host_Frame */
 198 void Cbuf_Frame (cbuf_t *cbuf);
 199
 200 //===========================================================================
 201
 202 /*
 203
 204 Command execution takes a null terminated string, breaks it into tokens,
 205 then searches for a command or variable that matches the first token.
 206
 207 Commands can come from three sources, but the handler functions may choose
 208 to dissallow the action or forward it to a remote server if the source is
 209 not apropriate.
 210
 211 */
 212
 213 void Cmd_Init(void);
 214 void Cmd_Shutdown(void);
 215
 216 // called by Host_Init, this marks cvars, commands and aliases with their init values
 217 void Cmd_SaveInitState(void);
 218 // called by FS_GameDir_f, this restores cvars, commands and aliases to init values
 219 void Cmd_RestoreInitState(void);
 220
 221 void Cmd_AddCommand(int flags, const char *cmd_name, xcommand_t function, const char *description);
 222 // called by the init functions of other parts of the program to
 223 // register commands and functions to call for them.
 224 // The cmd_name is referenced later, so it should not be in temp memory
 225
 226 cmd_function_t *Cmd_GetCommand(cmd_state_t *cmd, const char *partial, size_t len, qbool casesensitive);
 227
 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);
 230
 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);
 234
 235 int Cmd_CompleteAliasCountPossible (cmd_state_t *cmd, const char *partial);
 236
 237 const char **Cmd_CompleteAliasBuildList (cmd_state_t *cmd, const char *partial);
 238
 239 int Cmd_CompleteCountPossible (cmd_state_t *cmd, const char *partial);
 240
 241 const char **Cmd_CompleteBuildList (cmd_state_t *cmd, const char *partial);
 242
 243 void Cmd_CompleteCommandPrint (cmd_state_t *cmd, const char *partial);
 244
 245 const char *Cmd_CompleteAlias (cmd_state_t *cmd, const char *partial);
 246
 247 void Cmd_CompleteAliasPrint (cmd_state_t *cmd, const char *partial);
 248
 249 // Enhanced console completion by Fett erich@heintz.com
 250
 251 // Added by EvilTypeGuy eviltypeguy@qeradiant.com
 252
 253 int Cmd_Argc (cmd_state_t *cmd);
 254 const char *Cmd_Argv (cmd_state_t *cmd, int arg);
 255 const char *Cmd_Args (cmd_state_t *cmd);
 256 // The functions that execute commands get their parameters with these
 257 // functions. Cmd_Argv(cmd, ) will return an empty string, not a NULL
 258 // if arg > argc, so string operations are always safe.
 259
 260 /// Returns the position (1 to argc-1) in the command's argument list
 261 /// where the given parameter apears, or 0 if not present
 262 int Cmd_CheckParm (cmd_state_t *cmd, const char *parm);
 263
 264 //void Cmd_TokenizeString (char *text);
 265 // Takes a null terminated string.  Does not need to be /n terminated.
 266 // breaks the string up into arg tokens.
 267
 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);
 271
 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);
 279
 280 void Cmd_ClearCSQCCommands (cmd_state_t *cmd);
 281
 282 #endif
 283