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