Helper class to parse command line arguments. More...
Derived from: | None |
Derived by: | None |
Group: | System (Core) |
#include <ClanLib/core.h>
Class Members:
Construction: | |
| |
Return the key of the current option. | |
Return the argument to the current option. |
| |
Change the indention used for the help message, default is 18. | |
Add a usage line to the help output, usage is for example. | |
Adds extra documentation to the help output, should only be. | |
Starts a new group of options, the grouptopic gets printed. | |
Adds a option to the parser. | |
Parse the options arcording to the options added with. | |
Print the help output, normaly done via a help option. | |
Goto the next option. |
Detailed description:
The CL_CommandLine class helps to parse command line arguments, namely the argc/argv pair that you get from main(). CL_CommandLine mimics getopt_long() behaviour as closely as possible, while providing a cleaner interface and a few additional features, like automatic generation of 'help' t.tput. CL_CommandLine can parse long arguments in the following styles:program file FILENAMEprogram file=FILENAME
Short arguments are handled like this:
program -f FILENAME
Concatenating short arguments is also supported, so that:
program -f -a -b FILENAME
is equivalent to:
program -fab FILENAME
Non-option arguments (aka rest arguments) are supported as well:
program SOMEFILE SOMEOTHERFILE ...
To avoid ambiguity when a filename starts with 's; pos; CL_CommandLine stops parsing arguments after the first encounter of a '', so in
program -f -b -f -b
In the above example the first '-f -b&apotions are td as d as n while thee the afterafter the &ahe '' are treated as rest arguments (aka filenam most most programs).