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