ALib Enum Record type used by class OptionDecl.
Definition at line 246 of file arguments.inl.
Public Field Index: | |
String | identifierChar |
integer | RequiredArguments |
String | shortcutReplacementString |
String | valueSeparator |
![]() | |
String | EnumElementName |
The name of the enum element. | |
int | MinimumRecognitionLength |
Public Method Index: | |
EROptionDecl () noexcept=default | |
ALIB_DLL void | Parse () |
Implementation of EnumRecordPrototype::Parse. | |
![]() | |
ERSerializable () noexcept=default | |
Defaulted constructor leaving the record undefined. | |
ERSerializable (const String &name, int minLength=0) noexcept | |
ALIB_DLL void | Parse () |
String alib::cli::EROptionDecl::identifierChar |
The name of the option as parsed from command line if single hyphen '-'
is used. Defined as string to be able to have empty strings, which disables single character options.
Definition at line 251 of file arguments.inl.
integer alib::cli::EROptionDecl::RequiredArguments |
The number of arguments to consume and store in Option::Args. If this field is set and this value is not 0
, then a missing separator string leads to a parsing exception.
Definition at line 261 of file arguments.inl.
String alib::cli::EROptionDecl::shortcutReplacementString |
If not empty, the argument string will be replaced by this and the search for next options continues. Note: Shortcut options have to occur earlier in the enumeration's resource definition.
Definition at line 266 of file arguments.inl.
String alib::cli::EROptionDecl::valueSeparator |
An optional separator string (usually "=") that separates the option name from a value within the first argument itself. If this is not given, field RequiredArguments has to be 0
.
Definition at line 256 of file arguments.inl.
|
defaultnoexcept |
Defaulted constructor leaving the record undefined. (Implementation required as documented here.)
void alib::cli::EROptionDecl::Parse | ( | ) |
Implementation of EnumRecordPrototype::Parse.
Definition at line 285 of file arguments.cpp.