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