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