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