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