Class Description

ALib Enum Record type used by class OptionDecl.

Definition at line 298 of file arguments.hpp.

Public Fields
String	identifierChar

integer	qtyExpectedArgsFollowing

String	shortcutReplacementString

String	valueSeparator

Public Fields inherited from ERSerializable
String	EnumElementName

int	MinimumRecognitionLength

Public Methods
	EROptionDecl () noexcept=default

ALIB_API void	Parse ()

Public Methods inherited from ERSerializable
	ERSerializable () noexcept=default

	ERSerializable (const String &name, int minLength=0) noexcept

ALIB_API void	Parse ()

Constructor & Destructor Documentation

◆ EROptionDecl()

EROptionDecl ( )

defaultnoexcept

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

Member Function Documentation

◆ Parse()

void Parse ( )

Implementation of EnumRecordPrototype::Parse.

Definition at line 285 of file arguments.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ 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 303 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 313 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 318 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 308 of file arguments.hpp.

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