ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::cli::EROptionDecl Struct Reference

Description:

ALib Enum Record type used by class OptionDecl.

Definition at line 246 of file arguments.inl.

Inheritance diagram for alib::cli::EROptionDecl:
[legend]
Collaboration diagram for alib::cli::EROptionDecl:
[legend]

Public Field Index:

String identifierChar
 
integer RequiredArguments
 
String shortcutReplacementString
 
String valueSeparator
 
- Public Field Index: inherited from alib::enumrecords::ERSerializable
String EnumElementName
 The name of the enum element.
 
int MinimumRecognitionLength
 

Public Method Index:

 EROptionDecl () noexcept=default
 
ALIB_DLL void Parse ()
 Implementation of EnumRecordPrototype::Parse.
 
- Public Method Index: inherited from alib::enumrecords::ERSerializable
 ERSerializable () noexcept=default
 Defaulted constructor leaving the record undefined.
 
 ERSerializable (const String &name, int minLength=0) noexcept
 
ALIB_DLL void Parse ()
 

Field Details:

◆ identifierChar

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.

◆ RequiredArguments

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.

◆ shortcutReplacementString

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.

◆ valueSeparator

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.

Constructor(s) / Destructor Details:

◆ EROptionDecl()

alib::cli::EROptionDecl::EROptionDecl ( )
defaultnoexcept

Defaulted constructor leaving the record undefined. (Implementation required as documented here.)

Here is the call graph for this function:

Method Details:

◆ Parse()

void alib::cli::EROptionDecl::Parse ( )

Implementation of EnumRecordPrototype::Parse.

Definition at line 285 of file arguments.cpp.

Here is the call graph for this function:

The documentation for this struct was generated from the following files: