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