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