ALib C++ Library
Library Version: 2412 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
CommandDecl Class Reference

Description:

A declaration for a cli::Command.

Construction is done by passing a custom enum element of an enum type equipped with ALib Enum Records of type ERCommandDecl.

When bootstrapping ALib CLI, method CommandLine::DefineCommands has to be invoked for (each) enum type.

Definition at line 461 of file arguments.hpp.

#include <arguments.hpp>

Collaboration diagram for CommandDecl:
[legend]

Public Field Index:

CommandLineCmdLine
 The command line instance we belong to.
 
List< MonoAllocator, ParameterDecl * > Parameters
 Command parameters.
 

Public Method Index:

template<typename TEnum >
 CommandDecl (TEnum element, CommandLine &cmdLine)
 
const EnumElement () const
 
ALIB_API ParameterDeclGetParameterDecl (const String &name)
 
const StringHelpTextLong ()
 
const StringHelpTextShort ()
 
const StringIdentifier ()
 
int MinimumRecognitionLength ()
 

Protected Field Index:

Enum declElement
 The enumeration element given with construction.
 
ERCommandDecl record
 A copy (!) of the enum record.
 
ResourceInfo resourceInfo
 The resource information of the enumeration type given with construction.
 

Protected Method Index:

ALIB_API void addParamDecls ()
 

Field Details:

◆ CmdLine

CommandLine& CmdLine

The command line instance we belong to.

Definition at line 475 of file arguments.hpp.

◆ declElement

Enum declElement
protected

The enumeration element given with construction.

Definition at line 465 of file arguments.hpp.

◆ Parameters

Command parameters.

Definition at line 478 of file arguments.hpp.

◆ record

ERCommandDecl record
protected

A copy (!) of the enum record.

Definition at line 468 of file arguments.hpp.

◆ resourceInfo

ResourceInfo resourceInfo
protected

The resource information of the enumeration type given with construction.

Definition at line 471 of file arguments.hpp.

Constructor(s) / Destructor Details:

◆ CommandDecl()

template<typename TEnum >
CommandDecl ( TEnum element,
CommandLine & cmdLine )
inline

Templated constructor which takes an enum element of a custom type equipped with ALib Enum Records of type ERCommandDecl.

Field Parameters is filled as specified in the enum record.

Template Parameters
TEnumC++ enum type equipped with corresponding ALib Enum Records.
Parameters
elementThe enum element
cmdLineThe command line object. Will be stored.

Definition at line 559 of file commandline.hpp.

Here is the call graph for this function:

Method Details:

◆ addParamDecls()

void addParamDecls ( )
protected

Called from the constructor. Parses field ERCommandDecl::parameters of the enum record, and loads the corresponding parameters.

Definition at line 28 of file arguments.cpp.

Here is the call graph for this function:

◆ Element()

const Enum & Element ( ) const
inline

Returns the type and integral value of the enumeration element used with construction.

Returns
The enumeration element used with construction.

Definition at line 494 of file arguments.hpp.

◆ GetParameterDecl()

ParameterDecl * GetParameterDecl ( const String & name)

Searches in Parameters for the declaration of parameter name.

Parameters
nameThe declaration name of the parameter.
Returns
A pointer to the parameter's declaration, nullptr if parameter was not declared.

Definition at line 49 of file arguments.cpp.

◆ HelpTextLong()

const String & HelpTextLong ( )
inline

Returns the long version of the help text. Loads the string from resourceInfo using resource name "THlpCmdLngNN", where NN is the enum element's integral value.

Returns
The help text.

Definition at line 526 of file arguments.hpp.

Here is the call graph for this function:

◆ HelpTextShort()

const String & HelpTextShort ( )
inline

Returns the short version of the help text. Loads the string from resourceInfo using resource name "THlpCmdShtNN", where NN is the enum element's integral value.

Returns
The help text.

Definition at line 517 of file arguments.hpp.

Here is the call graph for this function:

◆ Identifier()

const String & Identifier ( )
inline

Returns the identifier (name) of the command

Returns
The command identifier.

Definition at line 501 of file arguments.hpp.

◆ MinimumRecognitionLength()

int MinimumRecognitionLength ( )
inline

Returns the minimum parse length of the identifier.

Returns
The minimum characters to satisfy the command to be parsed.

Definition at line 508 of file arguments.hpp.


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