1/*
2Copyright (C) 1996-1997 Id Software, Inc.
3
4This program is free software; you can redistribute it and/or
5modify it under the terms of the GNU General Public License
6as published by the Free Software Foundation; either version 2
7of the License, or (at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13See the GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with this program; if not, write to the Free Software
17Foundation, 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
27Any number of commands can be added in a frame, from several different sources.
28Most commands come from either keybindings or console line input, but remote
29servers can also send across commands and entire text files can be execed.
30
31The + command line options are also added to the command buffer.
32
33The game starts with a Cbuf_AddText ("exec quake.rc\n"); Cbuf_Execute ();
34
35*/
36
37
38void Cbuf_Init (void);
39// allocates an initial text buffer that will grow as needed
40
41void Cbuf_AddText (const char *text);
42// as new commands are generated from the console or keybindings,
43// the text is added to the end of the command buffer.
44
45void Cbuf_InsertText (const char *text);
46// when a command wants to issue other commands immediately, the text is
47// inserted at the beginning of the buffer, before any remaining unexecuted
48// commands.
49
50void Cbuf_Execute (void);
51// Pulls off \n terminated lines of text from the command buffer and sends
52// them through Cmd_ExecuteString.  Stops when the buffer is empty.
53// Normally called once per frame, but may be explicitly invoked.
54// Do not call inside a command function!
55
56//===========================================================================
57
58/*
59
60Command execution takes a null terminated string, breaks it into tokens,
61then searches for a command or variable that matches the first token.
62
63Commands can come from three sources, but the handler functions may choose
64to dissallow the action or forward it to a remote server if the source is
65not apropriate.
66
67*/
68
69typedef void (*xcommand_t) (void);
70
71typedef enum
72{
73    src_client,        // came in over a net connection as a clc_stringcmd
74                    // host_client will be valid during this state.
75    src_command,        // from the command buffer
76    cmd_src_t_max = 1 << 30
77} cmd_source_t;
78
79extern    cmd_source_t    cmd_source;
80
81void    Cmd_Init (void);
82
83void    Cmd_AddCommand (const char *cmd_name, xcommand_t function);
84// called by the init functions of other parts of the program to
85// register commands and functions to call for them.
86// The cmd_name is referenced later, so it should not be in temp memory
87
88qboolean Cmd_Exists (const char *cmd_name);
89// used by the cvar code to check for cvar / command name overlap
90
91const char     *Cmd_CompleteCommand (const char *partial);
92// attempts to match a partial command for automatic command line completion
93// returns NULL if nothing fits
94
95int        Cmd_Argc (void);
96char    *Cmd_Argv (int arg);
97char    *Cmd_Args (void);
98// The functions that execute commands get their parameters with these
99// functions. Cmd_Argv () will return an empty string, not a NULL
100// if arg > argc, so string operations are allways safe.
101
102int Cmd_CheckParm (const char *parm);
103// Returns the position (1 to argc-1) in the command's argument list
104// where the given parameter apears, or 0 if not present
105
106void Cmd_TokenizeString (char *text);
107// Takes a null terminated string.  Does not need to be /n terminated.
108// breaks the string up into arg tokens.
109
110void    Cmd_ExecuteString (char *text, cmd_source_t src);
111
112// Same as Cmd_ExecuteString, but for string constants.
113void    Cmd_ExecuteString2 (const char *text, cmd_source_t src);
114
115// Parses a single line of text into arguments and tries to execute it.
116// The text can come from the command buffer, a remote client, or stdin.
117
118void    Cmd_ForwardToServer (void);
119// adds the current command line as a clc_stringcmd to the client message.
120// things like godmode, noclip, etc, are commands directed to the server,
121// so when they are typed in at the console, they will need to be forwarded.
122
123void    Cmd_Print (const char *text);
124// used by command functions to send output to either the graphics console or
125// passed as a print message to the client
126
127