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