#include <options.hpp>

Inheritance diagram for vg::subcommand::ValueArgSpec< T, Receiver, Holder >:

Public Member Functions
	ValueArgSpec (const std::string &option, char short_option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
	Make an option with a long and short option name.

	ValueArgSpec (const std::string &option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
	Make an option with a long option name only.

virtual	~ValueArgSpec ()=default

virtual void	set_value (const T &replacement)
	Allow setting our stored value.

virtual T	get_value () const
	And getting our current effective value.

virtual bool	was_set () const
	Return true if a value has been set from parsing or a preset.

virtual void	parse (const char *optarg)

virtual void	apply (Receiver &receiver) const
	Apply the value to the right field of the given object.

virtual void	print_metavar (ostream &out, const char *sep="") const
	Print value metavar placeholder to the given stream after the given separator.

virtual void	print_value (ostream &out, const char *sep="") const
	Print value to the given stream after the given separator.

virtual void	print_default (ostream &out) const
	Print default value to the given stream, if appropriate.

virtual struct option	get_option_struct () const
	Get the getopt structure for this option. Option must outlive it and not move.

Public Member Functions inherited from vg::subcommand::ArgSpec< T, Receiver >
	ArgSpec (const std::string &option, char short_option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
	Make an option with a long and short option name.

	ArgSpec (const std::string &option, T Receiver::*dest, const T &default_value, const std::string &help, const ValidatorFunction< T > &validator)
	Make an option with a long option name only.

virtual	~ArgSpec ()=default

virtual void	preset (const BaseValuation &entry)

virtual void	set (const BaseValuation &entry)

virtual void	query (BaseValuation &entry) const

Public Member Functions inherited from vg::subcommand::BaseArgSpec< Receiver >
	BaseArgSpec (const std::string &option, char short_option, const std::string &help)
	Make an option with a long and short option name.

	BaseArgSpec (const std::string &option, const std::string &help)
	Make an option with a long option name only.

virtual	~BaseArgSpec ()=default

virtual void	print (ostream &out, const char sep="", const char after="", bool slug=false) const

Public Member Functions inherited from vg::subcommand::TickChainLink
virtual void	reset_chain ()
	Reset the chain to its initial values.

virtual bool	tick_chain ()

virtual TickChainLink &	chain (TickChainLink &next)

virtual std::function< void(const std::function< void(void)> &)>	get_iterator ()

Public Attributes
Holder	value

bool	value_set = false

Public Attributes inherited from vg::subcommand::ArgSpec< T, Receiver >
T Receiver::*	dest
	Field in the receiving type we set.

T	default_value
	Original default value.

ValidatorFunction< T >	validator
	Function to check value with.

Public Attributes inherited from vg::subcommand::BaseArgSpec< Receiver >
std::string	option
	Name of the option (long opt)

std::string	help
	Help for the option.

char	short_option
	Character of the option (short opt), or 0.

int	option_id
	Int value to represent the option.

Public Attributes inherited from vg::subcommand::TickChainLink
std::function< void(void)>	reset_chain_parent
	This will be called when we want to reset_chain what we are chained onto.

std::function< bool(void)>	tick_chain_parent
	This will be called when we need to tick_chain our parent.

Detailed Description

template<typename T, typename Receiver, typename Holder = T>
struct vg::subcommand::ValueArgSpec< T, Receiver, Holder >

Definition structure for normal value-having options. Lets you specify storage type for the actual value.

Constructor & Destructor Documentation

◆ ValueArgSpec() [1/2]

template<typename T , typename Receiver , typename Holder = T>

vg::subcommand::ValueArgSpec< T, Receiver, Holder >::ValueArgSpec	(	const std::string &	option,
		char	short_option,
		T Receiver::*	dest,
		const T &	default_value,
		const std::string &	help,
		const ValidatorFunction< T > &	validator
	)

inline

Make an option with a long and short option name.

◆ ValueArgSpec() [2/2]

template<typename T , typename Receiver , typename Holder = T>

vg::subcommand::ValueArgSpec< T, Receiver, Holder >::ValueArgSpec	(	const std::string &	option,
		T Receiver::*	dest,
		const T &	default_value,
		const std::string &	help,
		const ValidatorFunction< T > &	validator
	)

inline

Make an option with a long option name only.

◆ ~ValueArgSpec()

template<typename T , typename Receiver , typename Holder = T>

virtual vg::subcommand::ValueArgSpec< T, Receiver, Holder >::~ValueArgSpec ( )

virtualdefault

Member Function Documentation

◆ apply()

template<typename T , typename Receiver , typename Holder = T>

virtual void vg::subcommand::ValueArgSpec< T, Receiver, Holder >::apply ( Receiver & receiver ) const

inlinevirtual

Apply the value to the right field of the given object.

Implements vg::subcommand::BaseArgSpec< Receiver >.

◆ get_option_struct()

template<typename T , typename Receiver , typename Holder = T>

virtual struct option vg::subcommand::ValueArgSpec< T, Receiver, Holder >::get_option_struct ( ) const

inlinevirtual

Get the getopt structure for this option. Option must outlive it and not move.

Implements vg::subcommand::BaseArgSpec< Receiver >.

Reimplemented in vg::subcommand::FlagArgSpec< Receiver >.

◆ get_value()

template<typename T , typename Receiver , typename Holder = T>

virtual T vg::subcommand::ValueArgSpec< T, Receiver, Holder >::get_value ( ) const

inlinevirtual

And getting our current effective value.

Implements vg::subcommand::ArgSpec< T, Receiver >.

◆ parse()

template<typename T , typename Receiver , typename Holder = T>

virtual void vg::subcommand::ValueArgSpec< T, Receiver, Holder >::parse ( const char * optarg )

inlinevirtual

Parse the argument's value from the command line. Throws std::domain_error if validation fails.

Implements vg::subcommand::BaseArgSpec< Receiver >.

Reimplemented in vg::subcommand::FlagArgSpec< Receiver >.

◆ print_default()

template<typename T , typename Receiver , typename Holder = T>

virtual void vg::subcommand::ValueArgSpec< T, Receiver, Holder >::print_default ( ostream & out ) const

inlinevirtual

Print default value to the given stream, if appropriate.

Implements vg::subcommand::BaseArgSpec< Receiver >.

Reimplemented in vg::subcommand::FlagArgSpec< Receiver >.

◆ print_metavar()

template<typename T , typename Receiver , typename Holder = T>

virtual void vg::subcommand::ValueArgSpec< T, Receiver, Holder >::print_metavar	(	ostream &	out,
		const char *	sep = `""`
	)		const

inlinevirtual

Print value metavar placeholder to the given stream after the given separator.

Implements vg::subcommand::BaseArgSpec< Receiver >.

Reimplemented in vg::subcommand::FlagArgSpec< Receiver >.

◆ print_value()

template<typename T , typename Receiver , typename Holder = T>

virtual void vg::subcommand::ValueArgSpec< T, Receiver, Holder >::print_value	(	ostream &	out,
		const char *	sep = `""`
	)		const

inlinevirtual

Print value to the given stream after the given separator.

Implements vg::subcommand::BaseArgSpec< Receiver >.

Reimplemented in vg::subcommand::FlagArgSpec< Receiver >.

◆ set_value()

template<typename T , typename Receiver , typename Holder = T>

virtual void vg::subcommand::ValueArgSpec< T, Receiver, Holder >::set_value ( const T & value )

inlinevirtual

Allow setting our stored value.

Implements vg::subcommand::ArgSpec< T, Receiver >.

◆ was_set()

template<typename T , typename Receiver , typename Holder = T>

virtual bool vg::subcommand::ValueArgSpec< T, Receiver, Holder >::was_set ( ) const

inlinevirtual

Return true if a value has been set from parsing or a preset.

Implements vg::subcommand::ArgSpec< T, Receiver >.

Member Data Documentation

◆ value

template<typename T , typename Receiver , typename Holder = T>

Holder vg::subcommand::ValueArgSpec< T, Receiver, Holder >::value

◆ value_set

template<typename T , typename Receiver , typename Holder = T>

bool vg::subcommand::ValueArgSpec< T, Receiver, Holder >::value_set = false

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

src/subcommand/options.hpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ValueArgSpec() [1/2]

◆ ValueArgSpec() [2/2]

◆ ~ValueArgSpec()

Member Function Documentation

◆ apply()

◆ get_option_struct()

◆ get_value()

◆ parse()

◆ print_default()

◆ print_metavar()

◆ print_value()

◆ set_value()

◆ was_set()

Member Data Documentation

◆ value

◆ value_set