#include <yat/utility/OptionFile.h>
Public Member Functions | |
OptionFile (CommandLine &cmd, std::string name, std::string desc, bool required=false, bool exist=false, std::string bits="") | |
Constructor. | |
virtual | ~OptionFile (void) |
Destructor. | |
void | print_arg (std::string arg) |
std::string | value (void) const |
void | value (std::stringv) |
set value | |
std::string | description (void) const |
void | description (const std::string &description) |
set description | |
std::string | long_name (void) const |
void | parse (std::vector< std::string >::iterator &, const std::vector< std::string >::iterator &) |
parsing the commandline | |
bool | present (void) const |
Get if option was found in cmd. | |
std::string | print (void) |
print help output | |
void | reset (void) |
sets present to false | |
char | short_name (void) const |
void | validate (void) |
Validate the Option. | |
Protected Member Functions | |
bool | required (void) const |
const CommandLine & | cmd (void) const |
This class could be used for an option with argument when the argument is a file. The class adds some convenience on top of OptionArg<std::string> by utilizing the FileUtil class. Besides setting the name and description of the option and whether the option must appear in the command line, you can declare whether the file must exist and whether it must fulfill certain file permissions. If any of these requirements are not met, an exception will be thrown during the validation phase in CommandLine::parse.
theplu::yat::utility::OptionFile::OptionFile | ( | CommandLine & | cmd, | |
std::string | name, | |||
std::string | desc, | |||
bool | required = false , |
|||
bool | exist = false , |
|||
std::string | bits = "" | |||
) |
Constructor.
cmd | Commandline Option is associated with | |
name | string such as "file" for --file, "f" for -f or "f,file" for having both short and long option name | |
desc | string used in help display | |
required | If true option must be found in commandline or exception is thrown in validation | |
exist | if true File must exist, see FileUtil::exists() | |
bits | used to check permission on file, see FileUtil::permissions() |
const CommandLine& theplu::yat::utility::Option::cmd | ( | void | ) | const [protected, inherited] |
void theplu::yat::utility::Option::description | ( | const std::string & | description | ) | [inherited] |
std::string theplu::yat::utility::Option::description | ( | void | ) | const [inherited] |
std::string theplu::yat::utility::Option::long_name | ( | void | ) | const [inherited] |
bool theplu::yat::utility::Option::present | ( | void | ) | const [inherited] |
Get if option was found in cmd.
std::string theplu::yat::utility::Option::print | ( | void | ) | [inherited] |
print help output
This function calls the four virtual private functions print1, print2, print3, and print4. This allows an inherited class to implement one (or several) of these functions and keep the default output of the others. The default behavior is that:
void theplu::yat::utility::OptionArg< std::string >::print_arg | ( | std::string | arg | ) | [inline, inherited] |
arg | string to be used in help output such as `=TARGET' in `--target=TARGET'. See print3(). |
bool theplu::yat::utility::OptionArg< std::string >::required | ( | void | ) | const [inline, protected, inherited] |
char theplu::yat::utility::Option::short_name | ( | void | ) | const [inherited] |
void theplu::yat::utility::Option::validate | ( | void | ) | [inherited] |
Validate the Option.
This function is called by CommandLine::parse() after all options have been detected and parsed (see Option::parse()).
void theplu::yat::utility::OptionArg< std::string >::value | ( | std::string | v | ) | [inline, inherited] |
set value
std::string theplu::yat::utility::OptionArg< std::string >::value | ( | void | ) | const [inline, inherited] |