| ... |
... |
@@ -30,17 +30,16 @@
|
| 30 |
30 |
|
| 31 |
31 |
///\ingroup misc
|
| 32 |
32 |
///\file
|
| 33 |
|
///\brief A tools to parse command line arguments.
|
| 34 |
|
///
|
| 35 |
|
///\author Alpar Juttner
|
|
33 |
///\brief A tool to parse command line arguments.
|
| 36 |
34 |
|
| 37 |
35 |
namespace lemon {
|
| 38 |
36 |
|
| 39 |
37 |
///Command line arguments parser
|
| 40 |
38 |
|
| 41 |
39 |
///\ingroup misc
|
| 42 |
|
///Command line arguments parser
|
|
40 |
///Command line arguments parser.
|
| 43 |
41 |
///
|
|
42 |
///For a complete example see the \ref arg_parser_demo.cc demo file.
|
| 44 |
43 |
class ArgParser {
|
| 45 |
44 |
|
| 46 |
45 |
static void _showHelp(void *p);
|
| ... |
... |
@@ -165,7 +164,7 @@
|
| 165 |
164 |
const std::string &help,
|
| 166 |
165 |
std::string value="", bool obl=false);
|
| 167 |
166 |
|
| 168 |
|
///\name Options with an external strorage.
|
|
167 |
///\name Options with external storage
|
| 169 |
168 |
///Using this functions, the value of the option will be directly written
|
| 170 |
169 |
///into a variable once the option appears in the command line.
|
| 171 |
170 |
|
| ... |
... |
@@ -222,9 +221,9 @@
|
| 222 |
221 |
///Boundle some options into a group
|
| 223 |
222 |
|
| 224 |
223 |
/// You can group some option by calling this function repeatedly for each
|
| 225 |
|
/// option to be grupped with the same groupname.
|
| 226 |
|
///\param group The group name
|
| 227 |
|
///\param opt The option name
|
|
224 |
/// option to be grouped with the same groupname.
|
|
225 |
///\param group The group name.
|
|
226 |
///\param opt The option name.
|
| 228 |
227 |
ArgParser &optionGroup(const std::string &group,
|
| 229 |
228 |
const std::string &opt);
|
| 230 |
229 |
|
| ... |
... |
@@ -242,7 +241,7 @@
|
| 242 |
241 |
|
| 243 |
242 |
///Create synonym to an option
|
| 244 |
243 |
|
| 245 |
|
///With this function you can create a sysnonym called \c sys of the
|
|
244 |
///With this function you can create a synonym \c syn of the
|
| 246 |
245 |
///option \c opt.
|
| 247 |
246 |
ArgParser &synonym(const std::string &syn,
|
| 248 |
247 |
const std::string &opt);
|
| ... |
... |
@@ -252,14 +251,14 @@
|
| 252 |
251 |
///Give help string for non-parsed arguments.
|
| 253 |
252 |
|
| 254 |
253 |
///With this function you can give help string for non-parsed arguments.
|
| 255 |
|
///the parameter \c name will be printed in the short usage line, while
|
|
254 |
///The parameter \c name will be printed in the short usage line, while
|
| 256 |
255 |
///\c help gives a more detailed description.
|
| 257 |
256 |
ArgParser &other(const std::string &name,
|
| 258 |
257 |
const std::string &help="");
|
| 259 |
258 |
|
| 260 |
|
///Non option type arguments.
|
|
259 |
///Give back the non-option type arguments.
|
| 261 |
260 |
|
| 262 |
|
///Gives back a reference to a vector consisting of the program arguments
|
|
261 |
///Give back a reference to a vector consisting of the program arguments
|
| 263 |
262 |
///not starting with a '-' character.
|
| 264 |
263 |
std::vector<std::string> &files() { return _file_args; }
|
| 265 |
264 |
|
| ... |
... |
@@ -298,9 +297,9 @@
|
| 298 |
297 |
///Magic type for operator[]
|
| 299 |
298 |
|
| 300 |
299 |
///This is the type of the return value of ArgParser::operator[]().
|
| 301 |
|
///It automatically converts to int, double, bool or std::string if
|
| 302 |
|
///the type of the option matches, otherwise it throws an exception.
|
| 303 |
|
///(i.e. it performs runtime type checking).
|
|
300 |
///It automatically converts to \c int, \c double, \c bool or
|
|
301 |
///\c std::string if the type of the option matches, otherwise it
|
|
302 |
///throws an exception (i.e. it performs runtime type checking).
|
| 304 |
303 |
class RefType
|
| 305 |
304 |
{
|
| 306 |
305 |
ArgParser &_parser;
|
| ... |
... |
@@ -355,7 +354,7 @@
|
| 355 |
354 |
|
| 356 |
355 |
///Give back the value of an option
|
| 357 |
356 |
|
| 358 |
|
///Give back the value of an option
|
|
357 |
///Give back the value of an option.
|
| 359 |
358 |
///\sa RefType
|
| 360 |
359 |
RefType operator[](const std::string &n)
|
| 361 |
360 |
{
|