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
  38 void Cbuf_Init (void);
  39 // allocates an initial text buffer that will grow as needed
  40
  41 void Cbuf_AddText (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
  45 void Cbuf_InsertText (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
  50 void 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
  60 Command execution takes a null terminated string, breaks it into tokens,
  61 then searches for a command or variable that matches the first token.
  62
  63 Commands can come from three sources, but the handler functions may choose
  64 to dissallow the action or forward it to a remote server if the source is
  65 not apropriate.
  66
  67 */
  68
  69 typedef void (*xcommand_t) (void);
  70
  71 typedef 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_source_t;
  77
  78 extern  cmd_source_t    cmd_source;
  79
  80 void    Cmd_Init (void);
  81
  82 void    Cmd_AddCommand (char *cmd_name, xcommand_t function);
  83 // called by the init functions of other parts of the program to
  84 // register commands and functions to call for them.
  85 // The cmd_name is referenced later, so it should not be in temp memory
  86
  87 qboolean Cmd_Exists (char *cmd_name);
  88 // used by the cvar code to check for cvar / command name overlap
  89
  90 char    *Cmd_CompleteCommand (char *partial);
  91 // attempts to match a partial command for automatic command line completion
  92 // returns NULL if nothing fits
  93
  94 int             Cmd_Argc (void);
  95 char    *Cmd_Argv (int arg);
  96 char    *Cmd_Args (void);
  97 // The functions that execute commands get their parameters with these
  98 // functions. Cmd_Argv () will return an empty string, not a NULL
  99 // if arg > argc, so string operations are always safe.
 100
 101 int Cmd_CheckParm (char *parm);
 102 // Returns the position (1 to argc-1) in the command's argument list
 103 // where the given parameter apears, or 0 if not present
 104
 105 void Cmd_TokenizeString (char *text);
 106 // Takes a null terminated string.  Does not need to be /n terminated.
 107 // breaks the string up into arg tokens.
 108
 109 void    Cmd_ExecuteString (char *text, cmd_source_t src);
 110 // Parses a single line of text into arguments and tries to execute it.
 111 // The text can come from the command buffer, a remote client, or stdin.
 112
 113 void    Cmd_ForwardToServer (void);
 114 // adds the current command line as a clc_stringcmd to the client message.
 115 // things like godmode, noclip, etc, are commands directed to the server,
 116 // so when they are typed in at the console, they will need to be forwarded.
 117
 118 void    Cmd_Print (char *text);
 119 // used by command functions to send output to either the graphics console or
 120 // passed as a print message to the client
 121