ClanLib  2.3.7
command_line.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Ingo Ruhnke
27 */
28 
31 
32 #pragma once
33 
34 #include "../api_core.h"
35 #include "../Text/string_types.h"
36 #include <vector>
37 
38 class CL_CommandLine_Generic;
39 
78 {
81 
82 public:
84 
85  ~CL_CommandLine();
86 
87 
91 
92 public:
93  enum
94  {
95  REST_ARG = -2
96  };
97 
99  int get_key();
100 
102  CL_String8 get_argument();
103 
104 
108 
109 public:
111  void set_help_indent(int i);
112 
116  void add_usage(const CL_String8& usage);
117 
120  void add_doc(const CL_String8& doc);
121 
124  void add_group(const CL_String8& grouptopic);
125 
140  void add_option(
141  int key,
142  const CL_String8& long_option,
143  const CL_String8& argument,
144  const CL_String8& help,
145  bool visible = true);
146 
150  void parse_args(int argc, char** argv);
151 
153  void print_help();
154 
156  bool next();
157 
158 
162 
163 private:
164  CL_CommandLine_Generic* impl;
166 };
167 
168