ALib C++ Library
Library Version: 2402 R1
Documentation generated by doxygen
No Matches
EROptionDecl Struct Reference


ALib Enum Record type used by class OptionDecl .

Definition at line 297 of file arguments.hpp.

#include <arguments.hpp>

Inheritance diagram for EROptionDecl:
Collaboration diagram for EROptionDecl:

Public Field Index:

String identifierChar
integer qtyExpectedArgsFollowing
String shortcutReplacementString
String valueSeparator
- Public Field Index: inherited from ERSerializable
String EnumElementName
int MinimumRecognitionLength

Public Method Index:

 EROptionDecl () noexcept=default
ALIB_API void Parse ()
- Public Method Index: inherited from ERSerializable
 ERSerializable () noexcept=default
 ERSerializable (const String &name, int minLength=0) noexcept
ALIB_API void Parse ()

Field Details:

◆ identifierChar

String 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 302 of file arguments.hpp.

◆ qtyExpectedArgsFollowing

integer qtyExpectedArgsFollowing

The number of arguments to consume and store in Option::Args . If field qtyExpectedArgsFollowing is set and this value is not 0, then a missing separator string leads to a parsing exception.

Definition at line 312 of file arguments.hpp.

◆ shortcutReplacementString

String 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 317 of file arguments.hpp.

◆ valueSeparator

String 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 qtyExpectedArgsFollowing has to be 0.

Definition at line 307 of file arguments.hpp.

Constructor(s) / Destructor Details::

◆ EROptionDecl()

EROptionDecl ( )

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

Method Details:

◆ Parse()

void 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: