Class for all kinds of validating groups, including ArgumentParser. More...

#include <args.hxx>

Inheritance diagram for args::Group:

Classes
struct	Validators
	Default validators. More...

Public Member Functions
	Group (const std::string &help_=std::string(), const std::function< bool(const Group &)> &validator_=Validators::DontCare, Options options_={})
	If help is empty, this group will not be printed in help output.

	Group (Group &group_, const std::string &help_=std::string(), const std::function< bool(const Group &)> &validator_=Validators::DontCare, Options options_={})
	If help is empty, this group will not be printed in help output.

void	Add (Base &child)
	Append a child to this Group.

const std::vector< Base * > &	Children () const
	Get all this group's children.

virtual FlagBase *	Match (const EitherFlag &flag) override
	Return the first FlagBase that matches flag, or nullptr.

virtual std::vector< FlagBase * >	GetAllFlags () override

virtual void	Validate (const std::string &shortPrefix, const std::string &longPrefix) const override

virtual PositionalBase *	GetNextPositional () override
	Get the next ready positional, or nullptr if there is none.

virtual bool	HasFlag () const override
	Get whether this has any FlagBase children.

virtual bool	HasPositional () const override
	Get whether this has any PositionalBase children.

virtual bool	HasCommand () const override
	Get whether this has any Command children.

std::vector< Base * >::size_type	MatchedChildren () const
	Count the number of matched children this group has.

std::vector< Base * >	GetMatchedChildren () const
	Get the list of children which were matched.

template<typename ChildType >
std::vector< ChildType * >	GetFilteredChildren (bool matching=false) const
	Gets the children which are a certain type.

virtual bool	Matched () const noexcept override
	Whether or not this group matches validation.

bool	Get () const
	Get validation.

virtual std::vector< std::tuple< std::string, std::string, unsigned > >	GetDescription (const HelpParams &params, const unsigned int indent) const override
	Get all the child descriptions for help generation.

virtual std::vector< std::string >	GetProgramLine (const HelpParams &params) const override
	Get the names of positional parameters.

virtual std::vector< Command * >	GetCommands () override

virtual bool	IsGroup () const override

virtual void	Reset () noexcept override

void	SignalDetectDuplicates ()
	Sends a signal to the root of the tree to begin checking for duplicates.

void	DetectDuplicateFlags ()
	Detect duplicate flags.

void	DetectDuplicateFlags (std::unordered_set< char > &usedShortFlags, std::unordered_set< std::string > &usedLongFlags)
	Used by parameterless DetectDuplicateFlags.

Public Member Functions inherited from args::Base
	Base (const std::string &help_, Options options_={})

Options	GetOptions () const noexcept

bool	IsRequired () const noexcept

	operator bool () const noexcept

virtual std::vector< std::tuple< std::string, std::string, unsigned > >	GetDescription (const HelpParams &, const unsigned indentLevel) const

virtual bool	IsFlag () const

void	KickOut (bool kickout_) noexcept
	Sets a kick-out value for building subparsers.

bool	KickOut () const noexcept
	Gets the kick-out value for building subparsers.

Additional Inherited Members
Protected Attributes inherited from args::Base
bool	matched = false

const std::string	help

Detailed Description

Class for all kinds of validating groups, including ArgumentParser.

Member Function Documentation

◆ DetectDuplicateFlags()

void args::Group::DetectDuplicateFlags ( )

inline

Detect duplicate flags.

In a noexcept context, sets an error on the duplicate flag. In a normal context, throws a ParseError.

◆ GetAllFlags()

virtual std::vector< FlagBase * > args::Group::GetAllFlags ( )

inlineoverridevirtual

Reimplemented from args::Base.

◆ GetCommands()

virtual std::vector< Command * > args::Group::GetCommands ( )

inlineoverridevirtual

Reimplemented from args::Base.

◆ GetDescription()

virtual std::vector< std::tuple< std::string, std::string, unsigned > > args::Group::GetDescription	(	const HelpParams &	params,
		const unsigned int	indent
	)		const

inlineoverridevirtual

Get all the child descriptions for help generation.

Reimplemented in args::Command.

◆ GetFilteredChildren()

template<typename ChildType >

std::vector< ChildType * > args::Group::GetFilteredChildren ( bool matching = false ) const

inline

Gets the children which are a certain type.

Template Parameters

ChildType The type of child to select.

Parameters

matching Return only children of the type which matched (default false).

Returns: Vector of children meeting the criteria.

◆ GetNextPositional()

virtual PositionalBase * args::Group::GetNextPositional ( )

inlineoverridevirtual

Get the next ready positional, or nullptr if there is none.

Returns: the first ready PositionalBase pointer, or nullptr if there is no match

Reimplemented from args::Base.

Reimplemented in args::Command.

◆ GetProgramLine()

virtual std::vector< std::string > args::Group::GetProgramLine ( const HelpParams & params ) const

inlineoverridevirtual

Get the names of positional parameters.

Reimplemented from args::Base.

Reimplemented in args::Command.

◆ HasCommand()

virtual bool args::Group::HasCommand ( ) const

inlineoverridevirtual

Get whether this has any Command children.

Returns: Whether or not there are any Command children

Reimplemented from args::Base.

Reimplemented in args::Command.

◆ HasFlag()

virtual bool args::Group::HasFlag ( ) const

inlineoverridevirtual

Get whether this has any FlagBase children.

Returns: Whether or not there are any FlagBase children

Reimplemented from args::Base.

Reimplemented in args::Command.

◆ HasPositional()

virtual bool args::Group::HasPositional ( ) const

inlineoverridevirtual

Get whether this has any PositionalBase children.

Returns: Whether or not there are any PositionalBase children

Reimplemented from args::Base.

Reimplemented in args::Command.

◆ IsGroup()

virtual bool args::Group::IsGroup ( ) const

inlineoverridevirtual

Reimplemented from args::Base.

◆ Match()

virtual FlagBase * args::Group::Match ( const EitherFlag & flag )

inlineoverridevirtual

Return the first FlagBase that matches flag, or nullptr.

Parameters

flag	The flag with prefixes stripped

Returns: the first matching FlagBase pointer, or nullptr if there is no match

Reimplemented from args::Base.

Reimplemented in args::Command.

◆ Matched()

virtual bool args::Group::Matched ( ) const

inlineoverridevirtualnoexcept

Whether or not this group matches validation.

Reimplemented from args::Base.

Reimplemented in args::Command.

◆ Reset()

virtual void args::Group::Reset ( )

inlineoverridevirtualnoexcept

Reimplemented from args::Base.

◆ SignalDetectDuplicates()

void args::Group::SignalDetectDuplicates ( )

inline

Sends a signal to the root of the tree to begin checking for duplicates.

If this is the root, begins checking.

◆ Validate()

virtual void args::Group::Validate	(	const std::string &	shortPrefix,
		const std::string &	longPrefix
	)		const

inlineoverridevirtual

Reimplemented from args::Base.

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

args.hxx

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DetectDuplicateFlags()

◆ GetAllFlags()

◆ GetCommands()

◆ GetDescription()

◆ GetFilteredChildren()

◆ GetNextPositional()

◆ GetProgramLine()

◆ HasCommand()

◆ HasFlag()

◆ HasPositional()

◆ IsGroup()

◆ Match()

◆ Matched()

◆ Reset()

◆ SignalDetectDuplicates()

◆ Validate()