ArgParseConfigT< bool > Class Reference

Detailed Description

Definition at line 223 of file ArgParser.h.

Public Member Functions
	ArgParseConfigT (const std::string &flag, bool *output_location, bool firstPass)
virtual ArgParseConfig &	colour (const std::string &colour)
ArgParseConfig< bool > &	default_value (bool value) override
virtual ArgParseConfig &	description (const std::string &description)
std::string	flag_name () const override
bool	is_present () const
bool	is_required () const override
bool	matches (const std::string &flag) const override
int	num_arguments () const override
void	parse (const std::string &name, const std::vector< std::string > &arguments, bool firstPass, bool ignore_num_arguments=false)
void	parse_item (const std::vector< std::string > &arguments) override
std::string	printable (int description_column, int *chars_before_desc) const override
virtual ArgParseConfig &	required ()
ArgParseConfig< bool > &	takes_argument ()

Private Attributes
std::string	fColour
std::string	fDescription
bool	fFirstPass
std::vector< std::string >	fFlags
int	fNum_arguments_expected {0}
bool *	fOutput_location
bool	fPresent {false}
std::vector< std::string >	fRawFlags
bool	fRequired
bool	fStored_default_value {false}

Inheritance diagram for ArgParseConfigT< bool >:

Collaboration diagram for ArgParseConfigT< bool >:

Constructor & Destructor Documentation

ArgParseConfigT()

ArgParseConfigT< bool >::ArgParseConfigT ( const std::string & flag, bool * output_location, bool firstPass )

inline

Definition at line 225 of file ArgParser.h.

References ArgParseConfigT< T >::fOutput_location.

Member Function Documentation

colour()

virtual ArgParseConfig & ArgParseConfig< bool >::colour ( const std::string & colour )

inlinevirtualinherited

Definition at line 117 of file ArgParser.h.

default_value()

ArgParseConfig< bool > & ArgParseConfigT< bool >::default_value ( bool value )

inlineoverridevirtual

Implements ArgParseConfig< bool >.

Definition at line 231 of file ArgParser.h.

References ArgParseConfigT< T >::fOutput_location.

description()

virtual ArgParseConfig & ArgParseConfig< bool >::description ( const std::string & description )

inlinevirtualinherited

Definition at line 111 of file ArgParser.h.

flag_name()

std::string ArgParseConfig< bool >::flag_name ( ) const

inlineoverridevirtualinherited

Implements ArgParseItem.

Definition at line 90 of file ArgParser.h.

is_present()

bool ArgParseItem::is_present ( ) const

inlineinherited

Definition at line 35 of file ArgParser.h.

References ArgParseItem::fPresent.

is_required()

bool ArgParseConfig< bool >::is_required ( ) const

inlineoverridevirtualinherited

Implements ArgParseItem.

Definition at line 129 of file ArgParser.h.

matches()

bool ArgParseConfig< bool >::matches ( const std::string & flag ) const

inlineoverridevirtualinherited

Implements ArgParseItem.

Definition at line 101 of file ArgParser.h.

num_arguments()

int ArgParseConfigT< bool >::num_arguments ( ) const

inlineoverridevirtual

Implements ArgParseItem.

Definition at line 254 of file ArgParser.h.

parse()

void ArgParseItem::parse ( const std::string & name, const std::vector< std::string > & arguments, bool firstPass, bool ignore_num_arguments = false )

inlineinherited

Definition at line 38 of file ArgParser.h.

References ArgParseItem::fFirstPass, ArgParseItem::fPresent, ArgParseItem::num_arguments(), and ArgParseItem::parse_item().

Referenced by ArgParser::handle_default_option(), ArgParser::handle_long_flag(), ArgParser::handle_short_flag(), and ArgParser::parse_file().

parse_item()

void ArgParseConfigT< bool >::parse_item ( const std::vector< std::string > & arguments )

inlineoverridevirtual

Implements ArgParseItem.

Definition at line 244 of file ArgParser.h.

References ArgParseConfigT< T >::fOutput_location.

printable()

std::string ArgParseConfig< bool >::printable ( int description_column, int * chars_before_desc ) const

inlineoverridevirtualinherited

Implements ArgParseItem.

Definition at line 133 of file ArgParser.h.

required()

virtual ArgParseConfig & ArgParseConfig< bool >::required ( )

inlinevirtualinherited

Definition at line 123 of file ArgParser.h.

takes_argument()

ArgParseConfig< bool > & ArgParseConfigT< bool >::takes_argument ( )

inline

Definition at line 238 of file ArgParser.h.

Member Data Documentation

fColour

std::string ArgParseConfig< bool >::fColour

privateinherited

Colour string to be use for display.

Definition at line 184 of file ArgParser.h.

fDescription

std::string ArgParseConfig< bool >::fDescription

privateinherited

A description for display on the terminal.

Definition at line 181 of file ArgParser.h.

fFirstPass

bool ArgParseItem::fFirstPass

privateinherited

Definition at line 64 of file ArgParser.h.

Referenced by ArgParseItem::parse().

fFlags

std::vector<std::string> ArgParseConfig< bool >::fFlags

privateinherited

The literal flag that is searched for, including leading dashes.

Definition at line 187 of file ArgParser.h.

fNum_arguments_expected

int ArgParseConfigT< bool >::fNum_arguments_expected {0}

private

Definition at line 259 of file ArgParser.h.

fOutput_location

bool* ArgParseConfigT< bool >::fOutput_location

private

Definition at line 257 of file ArgParser.h.

fPresent

bool ArgParseItem::fPresent {false}

privateinherited

Definition at line 63 of file ArgParser.h.

Referenced by ArgParseItem::is_present(), and ArgParseItem::parse().

fRawFlags

std::vector<std::string> ArgParseConfig< bool >::fRawFlags

privateinherited

The flags without the leading dashes.

Definition at line 190 of file ArgParser.h.

fRequired

bool ArgParseConfig< bool >::fRequired

privateinherited

Whether the flag must be supplied.

Definition at line 193 of file ArgParser.h.

fStored_default_value

bool ArgParseConfigT< bool >::fStored_default_value {false}

private

Definition at line 258 of file ArgParser.h.