doom3-gpl
Doom 3 GPL source release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CmdArgs.h
Go to the documentation of this file.
1 /*
2 ===========================================================================
3 
4 Doom 3 GPL Source Code
5 Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
6 
7 This file is part of the Doom 3 GPL Source Code (?Doom 3 Source Code?).
8 
9 Doom 3 Source Code is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
13 
14 Doom 3 Source Code is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18 
19 You should have received a copy of the GNU General Public License
20 along with Doom 3 Source Code. If not, see <http://www.gnu.org/licenses/>.
21 
22 In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code. If not, please request a copy in writing from id Software at the address below.
23 
24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
25 
26 ===========================================================================
27 */
28 
29 #ifndef __CMDARGS_H__
30 #define __CMDARGS_H__
31 
32 /*
33 ===============================================================================
34 
35  Command arguments.
36 
37 ===============================================================================
38 */
39 
40 class idCmdArgs {
41 public:
42  idCmdArgs( void ) { argc = 0; }
43  idCmdArgs( const char *text, bool keepAsStrings ) { TokenizeString( text, keepAsStrings ); }
44 
45  void operator=( const idCmdArgs &args );
46 
47  // The functions that execute commands get their parameters with these functions.
48  int Argc( void ) const { return argc; }
49  // Argv() will return an empty string, not NULL if arg >= argc.
50  const char * Argv( int arg ) const { return ( arg >= 0 && arg < argc ) ? argv[arg] : ""; }
51  // Returns a single string containing argv(start) to argv(end)
52  // escapeArgs is a fugly way to put the string back into a state ready to tokenize again
53  const char * Args( int start = 1, int end = -1, bool escapeArgs = false ) const;
54 
55  // Takes a null terminated string and breaks the string up into arg tokens.
56  // Does not need to be /n terminated.
57  // Set keepAsStrings to true to only seperate tokens from whitespace and comments, ignoring punctuation
58  void TokenizeString( const char *text, bool keepAsStrings );
59 
60  void AppendArg( const char *text );
61  void Clear( void ) { argc = 0; }
62  const char ** GetArgs( int *argc );
63 
64 private:
65  static const int MAX_COMMAND_ARGS = 64;
66  static const int MAX_COMMAND_STRING = 2 * MAX_STRING_CHARS;
67 
68  int argc; // number of arguments
69  char * argv[MAX_COMMAND_ARGS]; // points into tokenized
70  char tokenized[MAX_COMMAND_STRING]; // will have 0 bytes inserted
71 };
72 
73 #endif /* !__CMDARGS_H__ */
static const int MAX_COMMAND_ARGS
Definition: CmdArgs.h:65
static const int MAX_COMMAND_STRING
Definition: CmdArgs.h:66
const char ** GetArgs(int *argc)
Definition: CmdArgs.cpp:194
const char * Args(int start=1, int end=-1, bool escapeArgs=false) const
Definition: CmdArgs.cpp:52
void AppendArg(const char *text)
Definition: CmdArgs.cpp:177
char * argv[MAX_COMMAND_ARGS]
Definition: CmdArgs.h:69
#define MAX_STRING_CHARS
Definition: Lib.h:95
int argc
Definition: CmdArgs.h:68
GLuint GLuint end
Definition: glext.h:2845
idCmdArgs(void)
Definition: CmdArgs.h:42
int Argc(void) const
Definition: CmdArgs.h:48
idCmdArgs(const char *text, bool keepAsStrings)
Definition: CmdArgs.h:43
void TokenizeString(const char *text, bool keepAsStrings)
Definition: CmdArgs.cpp:106
void Clear(void)
Definition: CmdArgs.h:61
void operator=(const idCmdArgs &args)
Definition: CmdArgs.cpp:37
const char * Argv(int arg) const
Definition: CmdArgs.h:50
char tokenized[MAX_COMMAND_STRING]
Definition: CmdArgs.h:70
GLuint start
Definition: glext.h:2845