nfd::tools::nfdc::CommandDefinition Class Reference

declares semantics of a command More...

#include <command-definition.hpp>

Collaboration diagram for nfd::tools::nfdc::CommandDefinition:

Classes
class	Error

Public Member Functions
	CommandDefinition (const std::string &noun, const std::string &verb)
	~CommandDefinition ()
const std::string	getNoun () const
const std::string	getVerb () const
const std::string &	getTitle () const
CommandDefinition &	setTitle (const std::string &title)
	set one-line description More...
CommandDefinition &	addArg (const std::string &name, ArgValueType valueType, Required isRequired=Required::NO, Positional allowPositional=Positional::NO, const std::string &metavar="")
	declare an argument More...
CommandArguments	parse (const std::vector< std::string > &tokens, size_t start=0) const
	parse a command line More...

Detailed Description

declares semantics of a command

Definition at line 115 of file command-definition.hpp.

Constructor & Destructor Documentation

nfd::tools::nfdc::CommandDefinition::CommandDefinition	(	const std::string &	noun,
		const std::string &	verb
	)

Definition at line 91 of file command-definition.cpp.

nfd::tools::nfdc::CommandDefinition::~CommandDefinition ( )

default

Member Function Documentation

CommandDefinition & nfd::tools::nfdc::CommandDefinition::addArg	(	const std::string &	name,
		ArgValueType	valueType,
		Required	isRequired = Required::NO,
		Positional	allowPositional = Positional::NO,
		const std::string &	metavar = ""
	)

declare an argument

Parameters

name	argument name, must be unique
valueType	argument value type
isRequired	whether the argument is required
allowPositional	whether the argument value can be specified as positional
metavar	displayed argument value placeholder

Definition at line 100 of file command-definition.cpp.

const std::string nfd::tools::nfdc::CommandDefinition::getNoun ( ) const

inline

Definition at line 133 of file command-definition.hpp.

const std::string& nfd::tools::nfdc::CommandDefinition::getTitle ( ) const

inline

Returns

one-line description

Definition at line 148 of file command-definition.hpp.

const std::string nfd::tools::nfdc::CommandDefinition::getVerb ( ) const

inline

Definition at line 139 of file command-definition.hpp.

CommandArguments nfd::tools::nfdc::CommandDefinition::parse	(	const std::vector< std::string > &	tokens,
		size_t	start = 0
	)		const

parse a command line

Parameters

tokens	command line tokens
start	command line start position, after noun and verb

Exceptions

Error

command line is invalid

Definition at line 125 of file command-definition.cpp.

CommandDefinition& nfd::tools::nfdc::CommandDefinition::setTitle ( const std::string &  title )

inline

set one-line description

Parameters

title

one-line description, written in lower case

Definition at line 157 of file command-definition.hpp.