#include <args.hh>

Inheritance diagram for nix::MultiCommand:

Public Member Functions
	MultiCommand (const CommandMap &commands, bool allowExternal=false)
bool	processFlag (Strings::iterator &pos, Strings::iterator end) override
bool	processArgs (const Strings &args, bool finish) override
JSON	toJSON () override
Public Member Functions inherited from nix::Command
virtual void	run ()=0
virtual std::optional< ExperimentalFeature >	experimentalFeature ()
virtual Category	category ()
Public Member Functions inherited from nix::Args
virtual std::string	description ()
virtual bool	forceImpureByDefault ()
virtual std::string	doc ()
virtual AsyncIoRoot &	aio ()=0
void	addFlag (Flag &&flag)
void	removeFlag (const std::string &longName)
void	expectArgs (ExpectedArg &&arg)
void	expectArg (const std::string &label, std::string *dest, bool optional=false)
void	expectArgs (const std::string &label, std::vector< std::string > *dest)
RootArgs &	getRoot ()

Public Attributes
CommandMap	commands
Strings	customCommandSearchPaths
bool	isExternalSubcommand
std::map< Command::Category, std::string >	categories
std::optional< std::pair< std::string, ref< Command > > >	command
Public Attributes inherited from nix::Args
MultiCommand *	parent = nullptr

Additional Inherited Members
Public Types inherited from nix::Command
typedef int	Category
Static Public Attributes inherited from nix::Command
static constexpr Category	catDefault = 0
static constexpr Category	catCustom = 1000
Static Public Attributes inherited from nix::Args
static CompleterFun	completePath
static CompleterFun	completeDir
Protected Types inherited from nix::Args
typedef void	CompleterFun(AddCompletions &, size_t, std::string_view)
typedef std::function< CompleterFun >	CompleterClosure
Protected Member Functions inherited from nix::Args
virtual Strings::iterator	rewriteArgs (Strings &args, Strings::iterator pos)
virtual void	initialFlagsProcessed ()
virtual std::optional< std::reference_wrapper< RootArgs > >	asRootArgs ()
Protected Attributes inherited from nix::Args
std::map< std::string, Flag::ptr >	longFlags
std::map< char, Flag::ptr >	shortFlags
std::list< ExpectedArg >	expectedArgs
std::list< ExpectedArg >	processedArgs
std::set< std::string >	hiddenCategories
Static Protected Attributes inherited from nix::Args
static const size_t	ArityAny = std::numeric_limits<size_t>::max()

Detailed Description

An argument parser that supports multiple subcommands, i.e. ‘<command> <subcommand>’.

Member Function Documentation

bool nix::MultiCommand::processArgs	(	const Strings &	args,
		bool	finish )

overridevirtual

Process some positional arugments

Parameters

finish We have parsed everything else, and these are the only arguments left. Used because we accumulate some "pending args" we might have left over.

Returns: true if the passed arguments were fully consumed and no further processing is required, false if the passed arguments should be processed with more context.

Reimplemented from nix::Args.

bool nix::MultiCommand::processFlag	(	Strings::iterator &	pos,
		Strings::iterator	end )

overridevirtual

Process a single flag and its arguments, pulling from an iterator of raw CLI args as needed.

Reimplemented from nix::Args.

JSON nix::MultiCommand::toJSON ( )

overridevirtual

Reimplemented from nix::Args.

std::optional<std::pair<std::string, ref<Command> > > nix::MultiCommand::command

Selected command, if any.

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