Medical Imaging Interaction Toolkit
2024.06.99-c70462f2
Medical Imaging Interaction Toolkit
|
#include <mitkCommandLineParser.h>
Public Types | |
enum | Type { String, Bool, StringList, Int, Float, Directory, File, Image } |
enum | Channel { None, Input, Output } |
typedef std::vector< std::string > | StringContainerType |
Public Member Functions | |
mitkCommandLineParser () | |
~mitkCommandLineParser () | |
std::map< std::string, us::Any > | parseArguments (const StringContainerType &arguments, bool *ok=nullptr) |
std::map< std::string, us::Any > | parseArguments (int argc, char **argv, bool *ok=nullptr) |
std::string | errorString () const |
const StringContainerType & | unparsedArguments () const |
bool | argumentAdded (const std::string &argument) const |
bool | argumentParsed (const std::string &argument) const |
void | addArgument (const std::string &longarg, const std::string &shortarg, Type type, const std::string &argLabel, const std::string &argHelp=std::string(), const us::Any &defaultValue=us::Any(), bool optional=true, bool ignoreRest=false, bool deprecated=false, mitkCommandLineParser::Channel channel=mitkCommandLineParser::Channel::None) |
void | addDeprecatedArgument (const std::string &longarg, const std::string &shortarg, const std::string &argLabel, const std::string &argHelp) |
std::vector< std::map< std::string, us::Any > > | getArgumentList () |
bool | setExactMatchRegularExpression (const std::string &argument, const std::string &expression, const std::string &exactMatchFailedMessage) |
std::string::size_type | fieldWidth () const |
std::string | helpText () const |
void | setArgumentPrefix (const std::string &longPrefix, const std::string &shortPrefix) |
void | beginGroup (const std::string &description) |
void | endGroup () |
void | setStrictModeEnabled (bool strictMode) |
void | generateXmlOutput () |
void | setTitle (std::string title) |
void | setContributor (std::string contributor) |
void | setCategory (std::string category) |
void | setDescription (std::string description) |
void | changeParameterGroup (std::string name, std::string tooltip) |
Protected Attributes | |
ctkInternal * | Internal |
std::string | Title |
std::string | Contributor |
std::string | Category |
std::string | Description |
std::string | ParameterGroupName |
std::string | ParameterGroupDescription |
The MITK command line parser, based on the CTK command line parser.
Use this class to add information about the command line arguments your program understands and to easily parse them from a given list of strings.
This parser provides the following features:
The main difference between the MITK command line parser and the CTK command line parser is that the former does not depend on Qt. Apart from that an image type was added and XML output improved for automatic GUI generation.
std::out is used for output to keep dependencies to a minimum.
Definition at line 50 of file mitkCommandLineParser.h.
typedef std::vector<std::string> mitkCommandLineParser::StringContainerType |
Definition at line 72 of file mitkCommandLineParser.h.
Enumerator | |
---|---|
None | |
Input | |
Output |
Definition at line 65 of file mitkCommandLineParser.h.
Enumerator | |
---|---|
String | |
Bool | |
StringList | |
Int | |
Float | |
Directory | |
File | |
Image |
Definition at line 53 of file mitkCommandLineParser.h.
mitkCommandLineParser::mitkCommandLineParser | ( | ) |
mitkCommandLineParser::~mitkCommandLineParser | ( | ) |
void mitkCommandLineParser::addArgument | ( | const std::string & | longarg, |
const std::string & | shortarg, | ||
Type | type, | ||
const std::string & | argLabel, | ||
const std::string & | argHelp = std::string() , |
||
const us::Any & | defaultValue = us::Any() , |
||
bool | optional = true , |
||
bool | ignoreRest = false , |
||
bool | deprecated = false , |
||
mitkCommandLineParser::Channel | channel = mitkCommandLineParser::Channel::None |
||
) |
Adds a command line argument. An argument can have a long name (like –long-argument-name), a short name (like -l), or both. The type of the argument can be specified by using the type
parameter. The following types are supported:
Type | # of parameters | Default regular expr | Example |
us::Any::String | 1 | .* | –test-string StringParameter |
us::Any::Bool | 0 | does not apply | –enable-something |
us::Any::StringList | -1 | .* | –test-list string1 string2 |
us::Any::Int | 1 | -?[0-9]+ | –test-int -5 |
The regular expressions are used to validate the parameters of command line arguments. You can restrict the valid set of parameters by calling setExactMatchRegularExpression()
for your argument.
Optionally, a help string and a default value can be provided for the argument. If the us::Any type of the default value does not match type
, an exception is thrown. Arguments with default values are always returned by parseArguments()
.
You can also declare an argument deprecated, by setting deprecated
to true
. Alternatively you can add a deprecated argument by calling addDeprecatedArgument()
.
If the long or short argument has already been added, or if both are empty strings, the method call has no effect.
longarg | The long argument name. |
shortarg | The short argument name. |
type | The argument type (see the list above for supported types). |
argLabel | The label of this argument, when auto generated interface is used. |
argHelp | A help string describing the argument. |
defaultValue | A default value for the argument. |
optional | |
ignoreRest | All arguments after the current one will be ignored. |
deprecated | Declares the argument deprecated. |
channel |
std::logic_error | If the us::Any type of defaultValue does not match type , a std::logic_error is thrown. |
void mitkCommandLineParser::addDeprecatedArgument | ( | const std::string & | longarg, |
const std::string & | shortarg, | ||
const std::string & | argLabel, | ||
const std::string & | argHelp | ||
) |
Adds a deprecated command line argument. If a deprecated argument is provided on the command line, argHelp
is displayed in the console and processing continues with the next argument.
Deprecated arguments are grouped separately at the end of the help text returned by helpText()
.
longarg | The long argument name. |
shortarg | The short argument name. |
argLabel | |
argHelp | A help string describing alternatives to the deprecated argument. |
bool mitkCommandLineParser::argumentAdded | ( | const std::string & | argument | ) | const |
Checks if the given argument has been added via a call to addArgument()
.
argument | The argument to be checked. |
true
if the argument was added, false
otherwise. bool mitkCommandLineParser::argumentParsed | ( | const std::string & | argument | ) | const |
Checks if the given argument has been parsed successfully by a previous call to parseArguments()
.
argument | The argument to be checked. |
true
if the argument was parsed, false
otherwise. void mitkCommandLineParser::beginGroup | ( | const std::string & | description | ) |
Begins a new group for documenting arguments. All newly added arguments via addArgument()
will be put in the new group. You can close the current group by calling endGroup()
or be opening a new group.
Note that groups cannot be nested and all arguments which do not belong to a group will be listed at the top of the text created by helpText()
.
description | The description of the group |
void mitkCommandLineParser::changeParameterGroup | ( | std::string | name, |
std::string | tooltip | ||
) |
Is used to group several Parameters in one groupbox in the auto generated interface. Default name is "Parameters", with the tooltip: "Groupbox containing parameters."
To change the group of several arguments, call this method before the arguments are added.
name | The name of the groupbox. |
tooltip | The tooltip of the groupbox. |
void mitkCommandLineParser::endGroup | ( | ) |
Ends the current group.
std::string mitkCommandLineParser::errorString | ( | ) | const |
Returns a detailed error description if a call to parseArguments()
failed.
std::string::size_type mitkCommandLineParser::fieldWidth | ( | ) | const |
The field width for the argument names without the help text.
void mitkCommandLineParser::generateXmlOutput | ( | ) |
Is used to generate an XML output for any commandline program.
std::vector< std::map<std::string, us::Any> > mitkCommandLineParser::getArgumentList | ( | ) |
Returns the vector of current Command line Parameter
std::string mitkCommandLineParser::helpText | ( | ) | const |
Creates a help text containing properly formatted argument names and help strings provided by calls to addArgument()
. The arguments can be grouped by using beginGroup()
and endGroup()
.
std::map<std::string, us::Any> mitkCommandLineParser::parseArguments | ( | const StringContainerType & | arguments, |
bool * | ok = nullptr |
||
) |
Parse a given list of command line arguments.
This method parses a list of string elements considering the known arguments added by calls to addArgument()
. If any one of the argument values does not match the corresponding regular expression, ok
is set to false and an empty map object is returned.
The keys in the returned map object correspond to the long argument string, if it is not empty. Otherwise, the short argument string is used as key. The us::Any values can safely be converted to the type specified in the addArgument()
method call.
arguments | A StringContainerType containing command line arguments. |
ok | A pointer to a boolean variable. Will be set to true if all regular expressions matched, false otherwise. |
std::map<std::string, us::Any> mitkCommandLineParser::parseArguments | ( | int | argc, |
char ** | argv, | ||
bool * | ok = nullptr |
||
) |
Convenient method allowing to parse a given list of command line arguments.
void mitkCommandLineParser::setArgumentPrefix | ( | const std::string & | longPrefix, |
const std::string & | shortPrefix | ||
) |
Sets the argument prefix for long and short argument names. This can be used to create native command line arguments without changing the calls to addArgument()
. For example on Unix-based systems, long argument names start with "--" and short names with "-", while on Windows argument names always start with "/".
Note that all methods in mitkCommandLineParser which take an argument name expect the name as it was supplied to addArgument
.
Example usage:
longPrefix | The prefix for long argument names. |
shortPrefix | The prefix for short argument names. |
void mitkCommandLineParser::setCategory | ( | std::string | category | ) |
Is used to categorize the apps in the commandline module.
category | The category of the app. |
void mitkCommandLineParser::setContributor | ( | std::string | contributor | ) |
Is used to set the contributor for the help view in the auto generated interface.
contributor | Contributor of the app. |
void mitkCommandLineParser::setDescription | ( | std::string | description | ) |
Is used as the help text in the auto generated interface.
description | A short description for the app. |
bool mitkCommandLineParser::setExactMatchRegularExpression | ( | const std::string & | argument, |
const std::string & | expression, | ||
const std::string & | exactMatchFailedMessage | ||
) |
Sets a custom regular expression for validating argument parameters. The method errorString()
can be used the get the last error description.
argument | The previously added long or short argument name. |
expression | A regular expression which the arugment parameters must match. |
exactMatchFailedMessage | An error message explaining why the parameter did not match. |
true
if the argument was found and the regular expression was set, false
otherwise.void mitkCommandLineParser::setStrictModeEnabled | ( | bool | strictMode | ) |
Can be used to teach the parser to stop parsing the arguments and return False when an unknown argument is encountered. By default StrictMode
is disabled.
void mitkCommandLineParser::setTitle | ( | std::string | title | ) |
Is used to set the title of the auto generated interface.
title | The title of the app. |
const StringContainerType& mitkCommandLineParser::unparsedArguments | ( | ) | const |
This method returns all unparsed arguments, i.e. all arguments for which no long or short name has been registered via a call to addArgument()
.
|
protected |
Definition at line 364 of file mitkCommandLineParser.h.
|
protected |
Definition at line 363 of file mitkCommandLineParser.h.
|
protected |
Definition at line 365 of file mitkCommandLineParser.h.
|
protected |
Definition at line 359 of file mitkCommandLineParser.h.
|
protected |
Definition at line 367 of file mitkCommandLineParser.h.
|
protected |
Definition at line 366 of file mitkCommandLineParser.h.
|
protected |
Definition at line 362 of file mitkCommandLineParser.h.