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