Description:

ALib Enum Record type used by class OptionDecl.

Definition at line 216 of file arguments.inl.

Inheritance diagram for alib::cli::EROptionDecl:

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
void	Parse ()
	Implementation of void 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
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 221 of file arguments.inl.

◆ RequiredArguments

integer alib::cli::EROptionDecl::RequiredArguments

The number of arguments to consume and store in ListMA< String, Recycling::Shared > 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 231 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 236 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 226 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.)

Method Details:

◆ Parse()

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

Implementation of void Parse() .

Definition at line 263 of file arguments.cpp.

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