Auxiliary API. More...

#include <api.hpp>

Public Member Functions
	API (PARENT &parent, Command &self)

virtual	~API ()

template<typename NAME >
API< API< PARENT, Command, ARGPTR, false >, OnlyOneGroup, ARGPTR, false >	addOnlyOneGroup (NAME &&name, bool required=false)
	Add OnlyOneGroup.

template<typename NAME >
API< API< PARENT, Command, ARGPTR, false >, AllOfGroup, ARGPTR, false >	addAllOfGroup (NAME &&name, bool required=false)
	Add AllOfGroup.

template<typename NAME >
API< API< PARENT, Command, ARGPTR, false >, AtLeastOneGroup, ARGPTR, false >	addAtLeastOneGroup (NAME &&name, bool required=false)
	Add AtLeastOneGroup.

template<typename NAME >
API< PARENT, Command, ARGPTR, false > &	addArgWithFlagAndName (Char flag, NAME &&name, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const String &defaultValue=String(), const String &valueSpecifier=String())
	Add argument.

API< PARENT, Command, ARGPTR, false > &	addArgWithFlagOnly (Char flag, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const String &defaultValue=String(), const String &valueSpecifier=String())
	Add argument with flag only.

template<typename NAME >
API< PARENT, Command, ARGPTR, false > &	addArgWithNameOnly (NAME &&name, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const String &defaultValue=String(), const String &valueSpecifier=String())
	Add argument with name only.

template<typename NAME >
API< PARENT, Command, ARGPTR, false > &	addMultiArg (Char flag, NAME &&name, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const String &defaultValue=String(), const String &valueSpecifier=String())
	Add multi argument.

API< PARENT, Command, ARGPTR, false > &	addMultiArgWithFlagOnly (Char flag, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const String &defaultValue=String(), const String &valueSpecifier=String())
	Add multi argument with flag only.

template<typename NAME >
API< PARENT, Command, ARGPTR, false > &	addMultiArgWithNameOnly (NAME &&name, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const String &defaultValue=String(), const String &valueSpecifier=String())
	Add multi argument with name only.

template<typename NAME >
API< PARENT, Command, ARGPTR, false > &	addMultiArgWithDefaulValues (Char flag, NAME &&name, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const StringList &defaultValues=StringList(), const String &valueSpecifier=String())
	Add multi argument.

API< PARENT, Command, ARGPTR, false > &	addMultiArgWithFlagOnlyAndDefaultValues (Char flag, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const StringList &defaultValues=StringList(), const String &valueSpecifier=String())
	Add multi argument with flag only.

template<typename NAME >
API< PARENT, Command, ARGPTR, false > &	addMultiArgWithNameOnlyAndDefaultValues (NAME &&name, bool isWithValue=false, bool isRequired=false, const String &desc=String(), const String &longDesc=String(), const StringList &defaultValues=StringList(), const String &valueSpecifier=String())
	Add multi argument with name only.

API< PARENT, Command, ARGPTR, false >	addArg (ArgIface &arg)
	Add argument.

API< PARENT, Command, ARGPTR, false >	addArg (ArgIface *arg)
	Add argument.

API< PARENT, Command, ARGPTR, false >	addArg (GroupIface::ArgPtr arg)
	Add argument.

template<typename NAME >
API< API< PARENT, Command, ARGPTR, false >, Command, ARGPTR, false >	addCommand (NAME &&name, ValueOptions opt=ValueOptions::NoValue, bool isSubCommandRequired=false, const String &desc=String(), const String &longDesc=String(), const String &defaultValue=String(), const String &valueSpecifier=String())
	Add Command.

template<typename NAME >
API< API< PARENT, Command, ARGPTR, false >, Command, ARGPTR, false >	addCommandWithDefaultValues (NAME &&name, ValueOptions opt=ValueOptions::NoValue, bool isSubCommandRequired=false, const String &desc=String(), const String &longDesc=String(), const StringList &defaultValues=StringList(), const String &valueSpecifier=String())
	Add Command.

PARENT &	end () const
	End this group.

Detailed Description

template<typename PARENT, typename ARGPTR>
class Args::details::API< PARENT, Command, ARGPTR, false >

Auxiliary API.

Definition at line 62 of file api.hpp.

Constructor & Destructor Documentation

◆ API()

template<typename PARENT , typename ARGPTR >

Args::details::API< PARENT, Command, ARGPTR, false >::API	(	PARENT &	parent,
		Command &	self
	)

inline

Definition at line 64 of file api.hpp.

◆ ~API()

template<typename PARENT , typename ARGPTR >

virtual Args::details::API< PARENT, Command, ARGPTR, false >::~API ( )

inlinevirtual

Definition at line 70 of file api.hpp.

Member Function Documentation

◆ addAllOfGroup()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< API< PARENT, Command, ARGPTR, false >, AllOfGroup, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addAllOfGroup	(	NAME &&	name,
		bool	required = `false`
	)

inline

Add AllOfGroup.

Parameters

name	Name of the group.
required	Is group required?

Definition at line 98 of file api.hpp.

◆ addArg() [1/3]

template<typename PARENT , typename ARGPTR >

API< PARENT, Command, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addArg ( ArgIface & arg )

inline

Add argument.

Note: Developer should handle lifetime of the argument.

Definition at line 529 of file api.hpp.

◆ addArg() [2/3]

template<typename PARENT , typename ARGPTR >

API< PARENT, Command, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addArg ( ArgIface * arg )

inline

Add argument.

Note: Developer should handle lifetime of the argument.

Definition at line 538 of file api.hpp.

◆ addArg() [3/3]

template<typename PARENT , typename ARGPTR >

API< PARENT, Command, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addArg ( GroupIface::ArgPtr arg )

inline

Add argument.

Definition at line 547 of file api.hpp.

◆ addArgWithFlagAndName()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addArgWithFlagAndName	(	Char	flag,
		NAME &&	name,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const String &	defaultValue = `String()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add argument.

Parameters

flag	Flag for this argument.
name	Name for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValue	Default value.
valueSpecifier	Value specifier.

Definition at line 142 of file api.hpp.

◆ addArgWithFlagOnly()

template<typename PARENT , typename ARGPTR >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addArgWithFlagOnly	(	Char	flag,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const String &	defaultValue = `String()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add argument with flag only.

Parameters

flag	Flag for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValue	Default value.
valueSpecifier	Value specifier.

Definition at line 186 of file api.hpp.

◆ addArgWithNameOnly()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addArgWithNameOnly	(	NAME &&	name,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const String &	defaultValue = `String()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add argument with name only.

Parameters

name	Name for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValue	Default value.
valueSpecifier	Value specifier.

Definition at line 228 of file api.hpp.

◆ addAtLeastOneGroup()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< API< PARENT, Command, ARGPTR, false >, AtLeastOneGroup, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addAtLeastOneGroup	(	NAME &&	name,
		bool	required = `false`
	)

inline

Add AtLeastOneGroup.

Parameters

name	Name of the group.
required	Is group required?

Definition at line 120 of file api.hpp.

◆ addCommand()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< API< PARENT, Command, ARGPTR, false >, Command, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addCommand	(	NAME &&	name,
		ValueOptions	opt = `ValueOptions::NoValue`,
		bool	isSubCommandRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const String &	defaultValue = `String()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add Command.

Parameters

name	Name of the group.
opt	Value type.
isSubCommandRequired	Is sub-command required?
desc	Description of the argument.
longDesc	Long description.
defaultValue	Default value.
valueSpecifier	Value specifier.

Definition at line 556 of file api.hpp.

◆ addCommandWithDefaultValues()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< API< PARENT, Command, ARGPTR, false >, Command, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addCommandWithDefaultValues	(	NAME &&	name,
		ValueOptions	opt = `ValueOptions::NoValue`,
		bool	isSubCommandRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const StringList &	defaultValues = `StringList()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add Command.

Parameters

name	Name of the group.
opt	Value type.
isSubCommandRequired	Is sub-command required?
desc	Description of the argument.
longDesc	Long description.
defaultValues	Default value.
valueSpecifier	Value specifier.

Definition at line 599 of file api.hpp.

◆ addMultiArg()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addMultiArg	(	Char	flag,
		NAME &&	name,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const String &	defaultValue = `String()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add multi argument.

Parameters

flag	Flag for this argument.
name	Name for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValue	Default value.
valueSpecifier	Value specifier.

Definition at line 271 of file api.hpp.

◆ addMultiArgWithDefaulValues()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addMultiArgWithDefaulValues	(	Char	flag,
		NAME &&	name,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const StringList &	defaultValues = `StringList()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add multi argument.

Parameters

flag	Flag for this argument.
name	Name for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValues	Default value.
valueSpecifier	Value specifier.

Definition at line 400 of file api.hpp.

◆ addMultiArgWithFlagOnly()

template<typename PARENT , typename ARGPTR >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addMultiArgWithFlagOnly	(	Char	flag,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const String &	defaultValue = `String()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add multi argument with flag only.

Parameters

flag	Flag for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValue	Default value.
valueSpecifier	Value specifier.

Definition at line 315 of file api.hpp.

◆ addMultiArgWithFlagOnlyAndDefaultValues()

template<typename PARENT , typename ARGPTR >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addMultiArgWithFlagOnlyAndDefaultValues	(	Char	flag,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const StringList &	defaultValues = `StringList()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add multi argument with flag only.

Parameters

flag	Flag for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValues	Default value.
valueSpecifier	Value specifier.

Definition at line 444 of file api.hpp.

◆ addMultiArgWithNameOnly()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addMultiArgWithNameOnly	(	NAME &&	name,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const String &	defaultValue = `String()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add multi argument with name only.

Parameters

name	Name for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValue	Default value.
valueSpecifier	Value specifier.

Definition at line 357 of file api.hpp.

◆ addMultiArgWithNameOnlyAndDefaultValues()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< PARENT, Command, ARGPTR, false > & Args::details::API< PARENT, Command, ARGPTR, false >::addMultiArgWithNameOnlyAndDefaultValues	(	NAME &&	name,
		bool	isWithValue = `false`,
		bool	isRequired = `false`,
		const String &	desc = `String()`,
		const String &	longDesc = `String()`,
		const StringList &	defaultValues = `StringList()`,
		const String &	valueSpecifier = `String()`
	)

inline

Add multi argument with name only.

Parameters

name	Name for this argument.
isWithValue	Is this argument with value?
isRequired	Is this argument required?
desc	Description of the argument.
longDesc	Long description.
defaultValues	Default value.
valueSpecifier	Value specifier.

Definition at line 486 of file api.hpp.

◆ addOnlyOneGroup()

template<typename PARENT , typename ARGPTR >

template<typename NAME >

API< API< PARENT, Command, ARGPTR, false >, OnlyOneGroup, ARGPTR, false > Args::details::API< PARENT, Command, ARGPTR, false >::addOnlyOneGroup	(	NAME &&	name,
		bool	required = `false`
	)

inline

Add OnlyOneGroup.

Parameters

name	Name of the group.
required	Is group required?

Definition at line 76 of file api.hpp.

◆ end()

template<typename PARENT , typename ARGPTR >

PARENT & Args::details::API< PARENT, Command, ARGPTR, false >::end ( ) const

inline

End this group.

Returns: Command object.

Definition at line 641 of file api.hpp.

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

api.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ API()

◆ ~API()

Member Function Documentation

◆ addAllOfGroup()

◆ addArg() [1/3]

◆ addArg() [2/3]

◆ addArg() [3/3]

◆ addArgWithFlagAndName()

◆ addArgWithFlagOnly()

◆ addArgWithNameOnly()

◆ addAtLeastOneGroup()

◆ addCommand()

◆ addCommandWithDefaultValues()

◆ addMultiArg()

◆ addMultiArgWithDefaulValues()

◆ addMultiArgWithFlagOnly()

◆ addMultiArgWithFlagOnlyAndDefaultValues()

◆ addMultiArgWithNameOnly()

◆ addMultiArgWithNameOnlyAndDefaultValues()

◆ addOnlyOneGroup()

◆ end()