ArgParseItem Class Reference

Base class used to parse an individual item. Most methods are implemented in the templated ArgParseConfig<T>

Definition at line 26 of file ArgParser.h.

Public Member Functions
	ArgParseItem (bool firstPass)
virtual	~ArgParseItem ()=default
virtual std::string	flag_name () const =0
bool	is_present () const
virtual bool	is_required () const =0
virtual bool	matches (const std::string &flag) const =0
virtual int	num_arguments () const =0
void	parse (const std::string &name, const std::vector< std::string > &arguments, bool firstPass, bool ignore_num_arguments=false)
virtual void	parse_item (const std::vector< std::string > &arguments)=0
virtual std::string	printable (int description_column=-1, int *chars_before_desc=nullptr) const =0

Private Attributes
bool	fFirstPass
bool	present_

#include <ArgParser.h>

Inheritance diagram for ArgParseItem:

Constructor & Destructor Documentation

ArgParseItem()

ArgParseItem::ArgParseItem ( bool  firstPass )

inline

Definition at line 28 of file ArgParser.h.

~ArgParseItem()

virtual ArgParseItem::~ArgParseItem ( )

virtualdefault

Member Function Documentation

flag_name()

virtual std::string ArgParseItem::flag_name ( ) const

pure virtual

Implemented in ArgParseConfig< T >, ArgParseConfig< std::vector< T > >, and ArgParseConfig< bool >.

is_present()

bool ArgParseItem::is_present ( ) const

inline

Definition at line 35 of file ArgParser.h.

References present_.

is_required()

virtual bool ArgParseItem::is_required ( ) const

pure virtual

Implemented in ArgParseConfig< T >, ArgParseConfig< std::vector< T > >, and ArgParseConfig< bool >.

matches()

virtual bool ArgParseItem::matches ( const std::string &  flag ) const

pure virtual

Implemented in ArgParseConfig< T >, ArgParseConfig< std::vector< T > >, and ArgParseConfig< bool >.

num_arguments()

virtual int ArgParseItem::num_arguments ( ) const

pure virtual

Implemented in ArgParseConfigT< bool >, and ArgParseConfigT< T >.

Referenced by ArgParser::handle_long_flag(), ArgParser::handle_short_flag(), parse(), and ArgParseConfig< bool >::printable().

parse()

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

inline

Definition at line 38 of file ArgParser.h.

References fFirstPass, num_arguments(), parse_item(), and present_.

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

parse_item()

virtual void ArgParseItem::parse_item ( const std::vector< std::string > &  arguments )

pure virtual

Implemented in ArgParseConfigT< bool >, and ArgParseConfigT< T >.

Referenced by parse().

printable()

virtual std::string ArgParseItem::printable ( int  description_column = -1, int *  chars_before_desc = nullptr  ) const

pure virtual

Implemented in ArgParseConfig< T >, ArgParseConfig< std::vector< T > >, and ArgParseConfig< bool >.

Referenced by ArgParser::print().

Member Data Documentation

fFirstPass

bool ArgParseItem::fFirstPass

private

Definition at line 64 of file ArgParser.h.

Referenced by parse().

present_

bool ArgParseItem::present_

private

Definition at line 63 of file ArgParser.h.

Referenced by is_present(), and parse().