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 extern void *cmd_text_mutex; 41 #define Cbuf_LockThreadMutex() (void)(cmd_text_mutex ? Thread_LockMutex(cmd_text_mutex) : 0) 42 #define Cbuf_UnlockThreadMutex() (void)(cmd_text_mutex ? Thread_UnlockMutex(cmd_text_mutex) : 0) 43 44 /// allocates an initial text buffer that will grow as needed 45 void Cbuf_Init (void); 46 47 void Cmd_Init_Commands (void); 48 49 void Cbuf_Shutdown (void); 50 51 /*! as new commands are generated from the console or keybindings, 52 * the text is added to the end of the command buffer. 53 */ 54 void Cbuf_AddText (const char *text); 55 56 /*! when a command wants to issue other commands immediately, the text is 57 * inserted at the beginning of the buffer, before any remaining unexecuted 58 * commands. 59 */ 60 void Cbuf_InsertText (const char *text); 61 62 /*! Pulls off terminated lines of text from the command buffer and sends 63 * them through Cmd_ExecuteString. Stops when the buffer is empty. 64 * Normally called once per frame, but may be explicitly invoked. 65 * \note Do not call inside a command function! 66 */ 67 void Cbuf_Execute (void); 68 /*! Performs deferred commands and runs Cbuf_Execute, called by Host_Main */ 69 void Cbuf_Frame (void); 70 71 //=========================================================================== 72 73 /* 74 75 Command execution takes a null terminated string, breaks it into tokens, 76 then searches for a command or variable that matches the first token. 77 78 Commands can come from three sources, but the handler functions may choose 79 to dissallow the action or forward it to a remote server if the source is 80 not apropriate. 81 82 */ 83 84 typedef void (*xcommand_t) (void); 85 86 typedef enum 87 { 88 src_client, ///< came in over a net connection as a clc_stringcmd 89 ///< host_client will be valid during this state. 90 src_command ///< from the command buffer 91 } cmd_source_t; 92 93 extern cmd_source_t cmd_source; 94 95 void Cmd_Init (void); 96 void Cmd_Shutdown (void); 97 98 // called by Host_Init, this marks cvars, commands and aliases with their init values 99 void Cmd_SaveInitState (void); 100 // called by FS_GameDir_f, this restores cvars, commands and aliases to init values 101 void Cmd_RestoreInitState (void); 102 103 void Cmd_AddCommand_WithClientCommand (const char *cmd_name, xcommand_t consolefunction, xcommand_t clientfunction, const char *description); 104 void Cmd_AddCommand (const char *cmd_name, xcommand_t function, const char *description); 105 // called by the init functions of other parts of the program to 106 // register commands and functions to call for them. 107 // The cmd_name is referenced later, so it should not be in temp memory 108 109 /// used by the cvar code to check for cvar / command name overlap 110 qboolean Cmd_Exists (const char *cmd_name); 111 112 /// attempts to match a partial command for automatic command line completion 113 /// returns NULL if nothing fits 114 const char *Cmd_CompleteCommand (const char *partial); 115 116 int Cmd_CompleteAliasCountPossible (const char *partial); 117 118 const char **Cmd_CompleteAliasBuildList (const char *partial); 119 120 int Cmd_CompleteCountPossible (const char *partial); 121 122 const char **Cmd_CompleteBuildList (const char *partial); 123 124 void Cmd_CompleteCommandPrint (const char *partial); 125 126 const char *Cmd_CompleteAlias (const char *partial); 127 128 void Cmd_CompleteAliasPrint (const char *partial); 129 130 // Enhanced console completion by Fett erich@heintz.com 131 132 // Added by EvilTypeGuy eviltypeguy@qeradiant.com 133 134 int Cmd_Argc (void); 135 const char *Cmd_Argv (int arg); 136 const char *Cmd_Args (void); 137 // The functions that execute commands get their parameters with these 138 // functions. Cmd_Argv () will return an empty string, not a NULL 139 // if arg > argc, so string operations are always safe. 140 141 /// Returns the position (1 to argc-1) in the command's argument list 142 /// where the given parameter apears, or 0 if not present 143 int Cmd_CheckParm (const char *parm); 144 145 //void Cmd_TokenizeString (char *text); 146 // Takes a null terminated string. Does not need to be /n terminated. 147 // breaks the string up into arg tokens. 148 149 /// Parses a single line of text into arguments and tries to execute it. 150 /// The text can come from the command buffer, a remote client, or stdin. 151 void Cmd_ExecuteString (const char *text, cmd_source_t src, qboolean lockmutex); 152 153 /// adds the string as a clc_stringcmd to the client message. 154 /// (used when there is no reason to generate a local command to do it) 155 void Cmd_ForwardStringToServer (const char *s); 156 157 /// adds the current command line as a clc_stringcmd to the client message. 158 /// things like godmode, noclip, etc, are commands directed to the server, 159 /// so when they are typed in at the console, they will need to be forwarded. 160 void Cmd_ForwardToServer (void); 161 162 /// used by command functions to send output to either the graphics console or 163 /// passed as a print message to the client 164 void Cmd_Print(const char *text); 165 166 /// quotes a string so that it can be used as a command argument again; 167 /// quoteset is a string that contains one or more of ", \, $ and specifies 168 /// the characters to be quoted (you usually want to either pass "\"\\" or 169 /// "\"\\$"). Returns true on success, and false on overrun (in which case out 170 /// will contain a part of the quoted string). If putquotes is set, the 171 /// enclosing quote marks are also put. 172 qboolean Cmd_QuoteString(char *out, size_t outlen, const char *in, const char *quoteset, qboolean putquotes); 173 174 void Cmd_ClearCsqcFuncs (void); 175 176 #endif 177 178