utils::SubCommand Class Reference

#include <SubCommand.h>

Inheritance diagram for utils::SubCommand:

Collaboration diagram for utils::SubCommand:

Public Member Functions
	SubCommand (const SubCommand &)=delete
	SubCommand (SubCommand &&)=delete
SubCommand &	operator= (const SubCommand &)=delete
SubCommand &	operator= (SubCommand &&)=delete
virtual	~SubCommand ()
std::string	getName () const
std::string	version () const
std::string	configToStr () const
std::string	help (const CLI::App *helpApp, const CLI::AppFormatMode &mode) const
bool	hasParent () const
SubCommand *	getParent () const
SubCommand *	allowExtras (bool allow=true)
SubCommand *	forceUnrequired (bool unrequired=true)
SubCommand *	required (bool required=true)
SubCommand *	required (CLI::Option *option, bool required=true)
bool	getRequired () const
SubCommand *	needs (SubCommand *subCommand, bool needs=true)
SubCommand *	setRequireCallback (const std::function< void(void)> &callback)
SubCommand *	finalCallback (const std::function< void()> &finalCallback)
void	addSubCommandApp (std::shared_ptr< utils::AppWithPtr > subCommand)
template<typename NewSubCommand, typename... Args>
NewSubCommand *	newSubCommand (Args &&... args)
template<typename RequestedSubCommand>
RequestedSubCommand *	getSubCommand ()
template<typename RequestedSubCommand>
RequestedSubCommand *	getSubCommand () const
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addOption (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator) const
template<typename ValueTypeT>
CLI::Option *	addOptionVariable (const std::string &name, ValueTypeT &variable, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator) const
CLI::Option *	addOptionFunction (const std::string &name, const std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addOptionFunction (const std::string &name, const std::function< void(const std::string &)> &callback, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
template<typename ValueTypeT>
CLI::Option *	addFlag (const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
CLI::Option *	addFlagFunction (const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator) const
CLI::Option *	getOption (const std::string &name) const
template<typename ValueTypeT>
CLI::Option *	setDefaultValue (CLI::Option *option, const ValueTypeT &value, bool clear=true) const
CLI::Option *	setConfigurable (CLI::Option *option, bool configurable) const

Protected Member Functions
	SubCommand (SubCommand *parent, std::shared_ptr< utils::AppWithPtr > appWithPtr, const std::string &group, bool final=false)
template<typename ConcretSubCommand>
	SubCommand (SubCommand *parent, ConcretSubCommand *concretSubCommand, const std::string &group, bool final=false)
void	parse (int argc, char *argv[]) const
SubCommand *	description (const std::string &description)
SubCommand *	footer (const std::string &footer)
void	removeSubCommand ()
CLI::Option *	addConfigFlag (const std::string &defaultConfigFile) const
CLI::Option *	addLogFileFlag (const std::string &defaultLogFile) const
CLI::Option *	addVersionFlag (const std::string &version) const

Static Protected Member Functions
static CLI::App *	getHelpTriggerApp ()
static CLI::App *	getShowConfigTriggerApp ()
static CLI::App *	getCommandlineTriggerApp ()

Protected Attributes
CLI::Option *	helpOpt = nullptr
CLI::Option *	showConfigOpt = nullptr
CLI::Option *	commandlineOpt = nullptr

Static Protected Attributes
static std::map< std::string, std::string >	aliases
static CLI::App *	helpTriggerApp = nullptr
static CLI::App *	showConfigTriggerApp = nullptr
static CLI::App *	commandlineTriggerApp = nullptr

Private Member Functions
CLI::Option *	initialize (CLI::Option *option, const std::string &typeName, const CLI::Validator &validator, bool configurable) const

Private Attributes
AppWithPtr *	subCommandApp
std::string	name
SubCommand *	parent
std::shared_ptr< AppWithPtr >	selfAnchoredSubCommandApp
std::set< SubCommand * >	childSubCommands
int	requiredCount = 0
bool	requiredForced = false
bool	final

Detailed Description

Definition at line 97 of file SubCommand.h.

Constructor & Destructor Documentation

SubCommand() [1/4]

utils::SubCommand::SubCommand ( SubCommand * parent, std::shared_ptr< utils::AppWithPtr > appWithPtr, const std::string & group, bool final = false )

protected

Definition at line 57 of file SubCommand.cpp.

        : subCommandApp(appWithPtr.get())
        , name(subCommandApp != nullptr ? subCommandApp->get_name() : "<NOAPP>")
        , parent(parent)
        , final(final) {
        if (appWithPtr != nullptr) {
            if (parent != nullptr) {
                parent->addSubCommandApp(appWithPtr);
            } else {
                selfAnchoredSubCommandApp = std::move(appWithPtr);
            }
 
            subCommandApp->group(group);
            subCommandApp->configurable(false);
            subCommandApp->fallthrough();
 
            static const std::shared_ptr<CLI::HelpFormatter> helpFormatter = std::make_shared<CLI::HelpFormatter>();
            subCommandApp->formatter(helpFormatter);
 
            static const std::shared_ptr<CLI::Config> configFormatter = std::make_shared<CLI::ConfigFormatter>();
            subCommandApp->config_formatter(configFormatter);
 
            subCommandApp->option_defaults()->take_last()->group(subCommandApp->get_formatter()->get_label("Nonpersistent Options"));
 
            helpOpt = setConfigurable(subCommandApp
                                          ->set_help_flag(
                                              "--help{exact},-h{exact}",
                                              [subCommandApp = this->subCommandApp](std::size_t) {
                                                  helpTriggerApp = subCommandApp;
                                              },
                                              "Print help message and exit\n"
                                              "* standard: display help for the last command processed\n"
                                              "* exact: display help for the command directly preceding --help")
                                          ->type_name("MODE")
                                          ->take_first()
                                          ->check(CLI::IsMember({"standard", "exact"}))
                                          ->trigger_on_parse(),
                                      false);
 
            showConfigOpt = setConfigurable(subCommandApp
                                                ->add_flag_function(
                                                    "-s,--show-config",
                                                    [subCommandApp = this->subCommandApp](std::size_t) {
                                                        showConfigTriggerApp = subCommandApp;
                                                    },
                                                    "Show current configuration and exit")
                                                ->take_first()
                                                ->disable_flag_override()
                                                ->configurable(false)
                                                ->trigger_on_parse(),
                                            false);
 
            commandlineOpt = setConfigurable(subCommandApp
                                                 ->add_flag_function(
                                                     "--command-line{standard}",
                                                     [subCommandApp = this->subCommandApp]([[maybe_unused]] std::int64_t count) {
                                                         commandlineTriggerApp = subCommandApp;
                                                     },
                                                     "Print command-line\n"
                                                     "* standard (default): Show all non-default and required options\n"
                                                     "* active: Show all active options\n"
                                                     "* complete: Show the complete option set with default values\n"
                                                     "* required: Show only required options")
                                                 ->type_name("MODE")
                                                 ->take_first()
                                                 ->check(CLI::IsMember({"standard", "active", "complete", "required"}))
                                                 ->trigger_on_parse(),
                                             false);
        }
    }

References addSubCommandApp(), commandlineOpt, commandlineTriggerApp, final, helpOpt, helpTriggerApp, name, parent, selfAnchoredSubCommandApp, setConfigurable(), showConfigOpt, showConfigTriggerApp, and subCommandApp.

Referenced by net::config::ConfigInstance::ConfigInstance(), and utils::ConfigRoot::ConfigRoot().

Here is the call graph for this function:

Here is the caller graph for this function:

SubCommand() [2/4]

template<typename ConcretSubCommand>

utils::SubCommand::SubCommand ( SubCommand * parent, ConcretSubCommand * concretSubCommand, const std::string & group, bool final = false )

inlineprotected

Definition at line 271 of file SubCommand.h.

        : SubCommand(parent,
                     std::make_shared<utils::AppWithPtr>(
                         std::string(ConcretSubCommand::DESCRIPTION), std::string(ConcretSubCommand::NAME), concretSubCommand),
                     group,
                     final) {
    }

Referenced by web::http::client::ConfigHTTP::ConfigHTTP(), and subcommand::ConfigWWW::ConfigWWW().

Here is the caller graph for this function:

SubCommand() [3/4]

utils::SubCommand::SubCommand ( const SubCommand & )

delete

SubCommand() [4/4]

utils::SubCommand::SubCommand ( SubCommand && )

delete

~SubCommand()

utils::SubCommand::~SubCommand ( )

virtual

Definition at line 128 of file SubCommand.cpp.

                            {
        removeSubCommand();
    }

References removeSubCommand().

Here is the call graph for this function:

Member Function Documentation

addConfigFlag()

CLI::Option * utils::SubCommand::addConfigFlag ( const std::string & defaultConfigFile ) const

protected

Definition at line 296 of file SubCommand.cpp.

                                                                                 {
        return subCommandApp
            ->set_config( //
                "-c,--config-file",
                defaultConfigFile,
                "Read a config file",
                false) //
            ->take_all()
            ->type_name("configfile")
            ->check(!CLI::ExistingDirectory);
    }

References subCommandApp.

Referenced by utils::ConfigRoot::addRootOptions().

Here is the caller graph for this function:

addFlag() [1/2]

CLI::Option * utils::SubCommand::addFlag	(	const std::string &	name,
		const std::string &	description,
		const std::string &	typeName,
		const CLI::Validator &	validator ) const

Definition at line 339 of file SubCommand.cpp.

                                                                          {
        return initialize(subCommandApp //
                              ->add_flag(name, description),
                          typeName,
                          validator,
                          !subCommandApp->get_disabled());
    }

References initialize(), and subCommandApp.

Referenced by addFlag(), and utils::ConfigRoot::addRootOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

addFlag() [2/2]

template<typename ValueTypeT>

CLI::Option * utils::SubCommand::addFlag	(	const std::string &	name,
		const std::string &	description,
		const std::string &	typeName,
		ValueTypeT	defaultValue,
		const CLI::Validator &	validator ) const

Definition at line 351 of file SubCommand.h.

                                                                                    {
        return setDefaultValue(addFlag(name, description, typeName, additionalValidator), defaultValue);
    }

References addFlag().

Referenced by utils::ConfigRoot::addRootOptions(), web::http::client::ConfigHTTP::ConfigHTTP(), net::config::ConfigPhysicalSocket::ConfigPhysicalSocket(), net::config::ConfigTls::ConfigTls(), and net::config::ConfigTlsServer::ConfigTlsServer().

Here is the call graph for this function:

Here is the caller graph for this function:

addFlagFunction() [1/2]

CLI::Option * utils::SubCommand::addFlagFunction	(	const std::string &	name,
		const std::function< void()> &	callback,
		const std::string &	description,
		const std::string &	typeName,
		const CLI::Validator &	validator ) const

Definition at line 350 of file SubCommand.cpp.

                                                                                  {
        CLI::Option* opt = subCommandApp //
                               ->add_flag_function(
                                   name,
                                   [callback](std::int64_t) {
                                       callback();
                                   },
                                   description)
                               ->type_name(typeName)
                               ->check(validator)
                               ->take_last();
        if (opt->get_configurable()) {
            opt->group(subCommandApp->get_formatter()->get_label("Persistent Options"));
        }
 
        return opt;
    }

References subCommandApp.

Referenced by addFlagFunction().

Here is the caller graph for this function:

addFlagFunction() [2/2]

CLI::Option * utils::SubCommand::addFlagFunction	(	const std::string &	name,
		const std::function< void()> &	callback,
		const std::string &	description,
		const std::string &	typeName,
		const std::string &	defaultValue,
		const CLI::Validator &	validator ) const

Definition at line 372 of file SubCommand.cpp.

                                                                                  {
        return setDefaultValue(addFlagFunction(name, callback, description, typeName, validator), defaultValue);
    }

References addFlagFunction(), and setDefaultValue().

Referenced by utils::ConfigRoot::addRootOptions(), net::config::ConfigPhysicalSocket::addSocketOption(), net::config::ConfigInstance::ConfigInstance(), and net::config::ConfigPhysicalSocketClient::ConfigPhysicalSocketClient().

Here is the call graph for this function:

Here is the caller graph for this function:

addLogFileFlag()

CLI::Option * utils::SubCommand::addLogFileFlag ( const std::string & defaultLogFile ) const

protected

Definition at line 308 of file SubCommand.cpp.

                                                                                    {
        return addOption("-l,--log-file", "Log file", "logFile", defaultLogFile, !CLI::ExistingDirectory);
    }

References addOption().

Referenced by utils::ConfigRoot::addRootOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

addOption() [1/2]

CLI::Option * utils::SubCommand::addOption	(	const std::string &	name,
		const std::string &	description,
		const std::string &	typeName,
		const CLI::Validator &	validator ) const

Definition at line 316 of file SubCommand.cpp.

                                                                            {
        return initialize(subCommandApp //
                              ->add_option(name, description),
                          typeName,
                          validator,
                          !subCommandApp->get_disabled());
    }

References initialize(), and subCommandApp.

Referenced by addOption(), utils::ConfigRoot::addRootOptions(), web::http::client::ConfigHTTP::ConfigHTTP(), net::config::ConfigTls::ConfigTls(), net::config::ConfigTlsClient::ConfigTlsClient(), and subcommand::ConfigWWW::ConfigWWW().

Here is the call graph for this function:

Here is the caller graph for this function:

addOption() [2/2]

template<typename ValueTypeT>

CLI::Option * utils::SubCommand::addOption	(	const std::string &	name,
		const std::string &	description,
		const std::string &	typeName,
		ValueTypeT	defaultValue,
		const CLI::Validator &	validator ) const

Definition at line 312 of file SubCommand.h.

                                                                                      {
        return setDefaultValue(addOption(name, description, typeName, additionalValidator), defaultValue);
    }

References addOption().

Referenced by addLogFileFlag(), utils::ConfigRoot::addRootOptions(), net::config::ConfigPhysicalSocket::ConfigPhysicalSocket(), and net::config::ConfigTls::ConfigTls().

Here is the call graph for this function:

Here is the caller graph for this function:

addOptionFunction() [1/2]

CLI::Option * utils::SubCommand::addOptionFunction	(	const std::string &	name,
		const std::function< void(const std::string &)> &	callback,
		const std::string &	description,
		const std::string &	typeName,
		const CLI::Validator &	validator ) const

Definition at line 327 of file SubCommand.cpp.

                                                                                    {
        return initialize(subCommandApp //
                              ->add_option_function(name, callback, description),
                          typeName,
                          validator,
                          !subCommandApp->get_disabled());
    }

References initialize(), and subCommandApp.

Referenced by addOptionFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

addOptionFunction() [2/2]

template<typename ValueTypeT>

CLI::Option * utils::SubCommand::addOptionFunction	(	const std::string &	name,
		const std::function< void(const std::string &)> &	callback,
		const std::string &	description,
		const std::string &	typeName,
		ValueTypeT	defaultValue,
		const CLI::Validator &	validator ) const

Definition at line 341 of file SubCommand.h.

                                                                                    {
        return setDefaultValue(addOptionFunction(name, callback, description, typeName, validator), defaultValue);
    }

References addOptionFunction().

Here is the call graph for this function:

addOptionVariable() [1/2]

template<typename ValueTypeT>

CLI::Option * utils::SubCommand::addOptionVariable	(	const std::string &	name,
		ValueTypeT &	variable,
		const std::string &	description,
		const std::string &	typeName,
		const CLI::Validator &	additionalValidator ) const

Definition at line 321 of file SubCommand.h.

                                                                                              {
        return initialize(
            subCommandApp->add_option(name, variable, description), typeName, additionalValidator, !subCommandApp->get_disabled());
    }

References initialize(), and subCommandApp.

Referenced by net::config::ConfigTlsServer::ConfigTlsServer().

Here is the call graph for this function:

Here is the caller graph for this function:

addOptionVariable() [2/2]

template<typename ValueTypeT>

CLI::Option * utils::SubCommand::addOptionVariable	(	const std::string &	name,
		ValueTypeT &	variable,
		const std::string &	description,
		const std::string &	typeName,
		ValueTypeT	defaultValue,
		const CLI::Validator &	additionalValidator ) const

Definition at line 331 of file SubCommand.h.

                                                                                              {
        return setDefaultValue(addOptionVariable(name, variable, description, typeName, additionalValidator), defaultValue);
    }

addSubCommandApp()

void utils::SubCommand::addSubCommandApp

(

std::shared_ptr< utils::AppWithPtr >

subCommand

)

Definition at line 282 of file SubCommand.cpp.

                                                                          {
        if (subCommandApp->get_subcommands({}).empty()) {
            helpOpt->description("Print help message and exit\n"
                                 "* standard: display help for the last command processed\n"
                                 "* exact: display help for the command directly preceding --help\n"
                                 "* expanded: display help including all descendant sections");
            if (auto* existing = helpOpt->get_validator(); existing != nullptr) {
                *existing = std::move(CLI::IsMember({"standard", "exact", "expanded"})); // replace, do not append
            }
        }
 
        subCommandApp->add_subcommand(subCommand);
    }

References helpOpt, and subCommandApp.

Referenced by SubCommand().

Here is the caller graph for this function:

addVersionFlag()

CLI::Option * utils::SubCommand::addVersionFlag ( const std::string & version ) const

protected

Definition at line 312 of file SubCommand.cpp.

                                                                        {
        return subCommandApp->set_version_flag("-v,--version", version, "Framework version");
    }

References subCommandApp.

Referenced by utils::ConfigRoot::addRootOptions().

Here is the caller graph for this function:

allowExtras()

SubCommand * utils::SubCommand::allowExtras

(

bool

allow = true

)

Definition at line 191 of file SubCommand.cpp.

                                                  {
        subCommandApp->allow_extras(allow);
 
        return this;
    }

References subCommandApp.

Referenced by utils::ConfigRoot::parse1().

Here is the caller graph for this function:

configToStr()

std::string utils::SubCommand::configToStr

(

)

const

Definition at line 175 of file SubCommand.cpp.

                                            {
        return subCommandApp->config_to_str(true, true);
    }

References subCommandApp.

Referenced by utils::doWriteConfig().

Here is the caller graph for this function:

description()

SubCommand * utils::SubCommand::description ( const std::string & description )

protected

Definition at line 144 of file SubCommand.cpp.

                                                                    {
        subCommandApp->description(description);
 
        return this;
    }

References subCommandApp.

Referenced by utils::ConfigRoot::addRootOptions(), and net::config::ConfigSection::ConfigSection().

Here is the caller graph for this function:

finalCallback()

SubCommand * utils::SubCommand::finalCallback

(

const std::function< void()> &

finalCallback

)

Definition at line 276 of file SubCommand.cpp.

                                                                                  {
        subCommandApp->final_callback(finalCallback);
 
        return this;
    }

References subCommandApp.

Referenced by utils::ConfigRoot::bootstrap(), and net::config::ConfigTlsServer::ConfigTlsServer().

Here is the caller graph for this function:

footer()

SubCommand * utils::SubCommand::footer ( const std::string & footer )

protected

Definition at line 150 of file SubCommand.cpp.

                                                          {
        subCommandApp->footer(footer);
 
        return this;
    }

References subCommandApp.

Referenced by utils::ConfigRoot::addRootOptions().

Here is the caller graph for this function:

forceUnrequired()

SubCommand * utils::SubCommand::forceUnrequired

(

bool

unrequired = true

)

Definition at line 197 of file SubCommand.cpp.

                                                           {
        const bool previouslyRequired = subCommandApp->get_required();
        const bool countedRequired = subCommandApp->get_ignore_case();
 
        requiredForced = unrequired;
 
        const bool effectiveRequired = requiredForced ? false : countedRequired;
        if (previouslyRequired != effectiveRequired) {
            subCommandApp->required(effectiveRequired);
 
            if (hasParent()) {
                SubCommand* parent = getParent();
                parent->needs(this, effectiveRequired);
                parent->required(effectiveRequired);
            }
        }
 
        return this;
    }

References getParent(), hasParent(), needs(), required(), requiredForced, and subCommandApp.

Referenced by net::config::ConfigInstance::ConfigInstance(), and net::config::ConfigInstance::setDisabled().

Here is the call graph for this function:

Here is the caller graph for this function:

getCommandlineTriggerApp()

CLI::App * utils::SubCommand::getCommandlineTriggerApp ( )

staticprotected

Definition at line 399 of file SubCommand.cpp.

                                                 {
        return commandlineTriggerApp;
    }

References commandlineTriggerApp.

Referenced by net::config::ConfigInstance::getCommandlineTriggerApp().

Here is the caller graph for this function:

getHelpTriggerApp()

CLI::App * utils::SubCommand::getHelpTriggerApp ( )

staticprotected

Definition at line 391 of file SubCommand.cpp.

                                          {
        return helpTriggerApp;
    }

References helpTriggerApp.

Referenced by net::config::ConfigInstance::getHelpTriggerApp().

Here is the caller graph for this function:

getName()

std::string utils::SubCommand::getName

(

)

const

Definition at line 132 of file SubCommand.cpp.

                                        {
        return name;
    }

References name.

Referenced by net::config::ConfigTlsServer::ConfigTlsServer().

Here is the caller graph for this function:

getOption()

CLI::Option * utils::SubCommand::getOption

(

const std::string &

name

)

const

Definition at line 381 of file SubCommand.cpp.

                                                                {
        return subCommandApp->get_option_no_throw(name);
    }

References subCommandApp.

Referenced by net::config::ConfigPhysicalSocket::addSocketOption(), utils::doWriteConfig(), utils::getHelp(), and utils::ConfigRoot::parse2().

Here is the caller graph for this function:

getParent()

SubCommand * utils::SubCommand::getParent

(

)

const

Definition at line 187 of file SubCommand.cpp.

                                            {
        return parent;
    }

References parent.

Referenced by net::config::ConfigTlsServer::ConfigTlsServer(), forceUnrequired(), and required().

Here is the caller graph for this function:

getRequired()

bool utils::SubCommand::getRequired

(

)

const

Definition at line 256 of file SubCommand.cpp.

                                       {
        return subCommandApp->get_required();
    }

References subCommandApp.

getShowConfigTriggerApp()

CLI::App * utils::SubCommand::getShowConfigTriggerApp ( )

staticprotected

Definition at line 395 of file SubCommand.cpp.

                                                {
        return showConfigTriggerApp;
    }

References showConfigTriggerApp.

Referenced by net::config::ConfigInstance::getShowConfigTriggerApp().

Here is the caller graph for this function:

getSubCommand() [1/2]

template<typename RequestedSubCommand>

RequestedSubCommand * utils::SubCommand::getSubCommand

(

)

Definition at line 286 of file SubCommand.h.

                                                   {
        auto* appWithPtr = subCommandApp->get_subcommand_no_throw(std::string(RequestedSubCommand::NAME));
 
        AppWithPtr* subCommandApp = nullptr;
 
        if (appWithPtr != nullptr) {
            subCommandApp = dynamic_cast<utils::AppWithPtr*>(appWithPtr);
        }
 
        return subCommandApp != nullptr ? dynamic_cast<RequestedSubCommand*>(subCommandApp->getPtr()) : nullptr;
    }

References utils::AppWithPtr::getPtr(), and subCommandApp.

Referenced by web::http::client::SocketContextFactory::create(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

getSubCommand() [2/2]

template<typename RequestedSubCommand>

RequestedSubCommand * utils::SubCommand::getSubCommand

(

)

const

Definition at line 299 of file SubCommand.h.

                                                         {
        auto* appWithPtr = subCommandApp->get_subcommand_no_throw(std::string(RequestedSubCommand::NAME));
 
        AppWithPtr* subCommandApp = nullptr;
 
        if (appWithPtr != nullptr) {
            subCommandApp = dynamic_cast<utils::AppWithPtr*>(appWithPtr);
        }
 
        return subCommandApp != nullptr ? dynamic_cast<RequestedSubCommand*>(subCommandApp->getPtr()) : nullptr;
    }

References utils::AppWithPtr::getPtr(), and subCommandApp.

Here is the call graph for this function:

hasParent()

bool utils::SubCommand::hasParent

(

)

const

Definition at line 183 of file SubCommand.cpp.

                                     {
        return subCommandApp->get_parent() != nullptr;
    }

References subCommandApp.

Referenced by forceUnrequired(), and required().

Here is the caller graph for this function:

help()

std::string utils::SubCommand::help	(	const CLI::App *	helpApp,
		const CLI::AppFormatMode &	mode ) const

Definition at line 179 of file SubCommand.cpp.

                                                                                        {
        return subCommandApp->help(helpApp, "", mode);
    }

References subCommandApp.

Referenced by utils::getHelp().

Here is the caller graph for this function:

initialize()

CLI::Option * utils::SubCommand::initialize ( CLI::Option * option, const std::string & typeName, const CLI::Validator & validator, bool configurable ) const

private

Definition at line 404 of file SubCommand.cpp.

                                                                                                                               {
        return setConfigurable(option, configurable) //
            ->type_name(typeName)
            ->check(validator);
    }

References setConfigurable().

Referenced by addFlag(), addOption(), addOptionFunction(), and addOptionVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

needs()

SubCommand * utils::SubCommand::needs	(	SubCommand *	subCommand,
		bool	needs = true )

Definition at line 260 of file SubCommand.cpp.

                                                                    {
        if (needs) {
            subCommandApp->needs(subCommand->subCommandApp);
        } else {
            subCommandApp->remove_needs(subCommand->subCommandApp);
        }
 
        return this;
    }

References subCommandApp.

Referenced by forceUnrequired(), and required().

Here is the caller graph for this function:

newSubCommand()

template<typename NewSubCommand, typename... Args>

NewSubCommand * utils::SubCommand::newSubCommand

(

Args &&...

args

)

Definition at line 280 of file SubCommand.h.

                                                           {
        return !final ? dynamic_cast<NewSubCommand*>(*childSubCommands.insert(new NewSubCommand(this, std::forward(args)...)).first)
                      : nullptr;
    }

Referenced by main().

Here is the caller graph for this function:

operator=() [1/2]

SubCommand & utils::SubCommand::operator= ( const SubCommand & )

delete

operator=() [2/2]

SubCommand & utils::SubCommand::operator= ( SubCommand && )

delete

parse()

void utils::SubCommand::parse ( int argc, char * argv[] ) const

protected

Definition at line 140 of file SubCommand.cpp.

                                                       {
        subCommandApp->parse(argc, argv);
    }

References subCommandApp.

Referenced by utils::Config::parse(), and utils::ConfigRoot::parse2().

Here is the caller graph for this function:

removeSubCommand()

void utils::SubCommand::removeSubCommand ( )

protected

Definition at line 156 of file SubCommand.cpp.

                                      {
        while (!childSubCommands.empty()) {
            SubCommand* child = *childSubCommands.begin();
            childSubCommands.erase(child);
 
            delete child;
        }
 
        if (parent != nullptr) {
            parent->childSubCommands.erase(this);
 
            if (parent->subCommandApp != nullptr && subCommandApp != nullptr) {
                parent->subCommandApp->remove_subcommand(subCommandApp);
            }
 
            parent = nullptr;
        }
    }

References childSubCommands, parent, and subCommandApp.

Referenced by utils::ConfigRoot::terminate(), net::config::ConfigInstance::~ConfigInstance(), and ~SubCommand().

Here is the caller graph for this function:

required() [1/2]

SubCommand * utils::SubCommand::required

(

bool

required = true

)

Definition at line 217 of file SubCommand.cpp.

                                                  {
        const bool previousEffectiveRequired = subCommandApp->get_required();
 
        requiredCount += required ? 1 : -1;
        const bool countedRequired = requiredCount > 0;
        const bool effectiveRequired = requiredForced ? false : countedRequired;
 
        subCommandApp->ignore_case(countedRequired);
        if (subCommandApp->get_required() != effectiveRequired) {
            subCommandApp->required(effectiveRequired);
        }
 
        if (hasParent() && previousEffectiveRequired != effectiveRequired) {
            SubCommand* parent = getParent();
 
            parent->needs(this, effectiveRequired);
            parent->required(effectiveRequired);
        }
 
        return this;
    }

References getParent(), hasParent(), needs(), required(), requiredCount, requiredForced, and subCommandApp.

Referenced by forceUnrequired(), required(), and required().

Here is the call graph for this function:

Here is the caller graph for this function:

required() [2/2]

SubCommand * utils::SubCommand::required	(	CLI::Option *	option,
		bool	required = true )

Definition at line 239 of file SubCommand.cpp.

                                                                     {
        if (option->get_required() != required) {
            option->required(required);
 
            if (required) {
                subCommandApp->needs(option);
                option->default_str("");
            } else {
                subCommandApp->remove_needs(option);
            }
 
            this->required(required);
        }
 
        return this;
    }

References required(), and subCommandApp.

Referenced by subcommand::ConfigWWW::ConfigWWW(), and subcommand::ConfigWWW::setHtmlRoot().

Here is the call graph for this function:

Here is the caller graph for this function:

setConfigurable()

CLI::Option * utils::SubCommand::setConfigurable	(	CLI::Option *	option,
		bool	configurable ) const

Definition at line 385 of file SubCommand.cpp.

                                                                                     {
        return option //
            ->configurable(configurable)
            ->group(subCommandApp->get_formatter()->get_label(configurable ? "Persistent Options" : "Nonpersistent Options"));
    }

References subCommandApp.

Referenced by utils::ConfigRoot::addRootOptions(), ConfigDb::ConfigDb(), net::config::ConfigInstance::ConfigInstance(), net::config::ConfigInstance::configurable(), initialize(), and SubCommand().

Here is the caller graph for this function:

setDefaultValue()

template<typename ValueTypeT>

CLI::Option * utils::SubCommand::setDefaultValue	(	CLI::Option *	option,
		const ValueTypeT &	value,
		bool	clear = true ) const

Definition at line 360 of file SubCommand.h.

                                                                                                       {
        try {
            option->default_val(value);
 
            if (clear) {
                option->clear();
            }
        } catch (const CLI::ParseError&) {
            option = nullptr;
        }
 
        return option;
    }

Referenced by addFlagFunction(), net::in6::stream::config::ConfigSocketClient::ConfigSocketClient(), net::in::stream::config::ConfigSocketClient::ConfigSocketClient(), net::in6::stream::config::ConfigSocketServer::ConfigSocketServer(), net::in::stream::config::ConfigSocketServer::ConfigSocketServer(), net::config::ConfigPhysicalSocketServer::setAcceptsPerTick(), net::config::ConfigPhysicalSocketServer::setAcceptTimeout(), net::config::ConfigPhysicalSocketServer::setBacklog(), net::config::ConfigTls::setCaCert(), net::config::ConfigTls::setCaCertAcceptUnknown(), net::config::ConfigTls::setCaCertDir(), net::config::ConfigTls::setCaCertDirUseDefault(), net::config::ConfigTls::setCert(), net::config::ConfigTls::setCertKey(), net::config::ConfigTls::setCertKeyPassword(), net::config::ConfigTls::setCipherList(), net::config::ConfigPhysicalSocketClient::setConnectTimeout(), net::config::ConfigInstance::setDisabled(), net::in6::stream::config::ConfigSocketClient::setDisableNagleAlgorithm(), net::in6::stream::config::ConfigSocketServer::setDisableNagleAlgorithm(), net::in::stream::config::ConfigSocketClient::setDisableNagleAlgorithm(), net::in::stream::config::ConfigSocketServer::setDisableNagleAlgorithm(), net::config::ConfigTlsServer::setForceSni(), web::http::client::ConfigHTTP::setHostHeader(), subcommand::ConfigWWW::setHtmlRoot(), net::config::ConfigTls::setInitTimeout(), net::in6::stream::config::ConfigSocketServer::setIPv6Only(), web::http::client::ConfigHTTP::setPipelinedRequests(), net::config::ConfigConnection::setReadBlockSize(), net::config::ConfigConnection::setReadTimeout(), net::config::ConfigPhysicalSocketClient::setReconnect(), net::config::ConfigPhysicalSocketClient::setReconnectTime(), net::config::ConfigPhysicalSocket::setRetry(), net::config::ConfigPhysicalSocket::setRetryBase(), net::config::ConfigPhysicalSocket::setRetryJitter(), net::config::ConfigPhysicalSocket::setRetryLimit(), net::config::ConfigPhysicalSocket::setRetryOnFatal(), net::config::ConfigPhysicalSocket::setRetryTimeout(), net::config::ConfigPhysicalSocket::setRetryTries(), net::in6::stream::config::ConfigSocketServer::setReuseAddress(), net::in::stream::config::ConfigSocketServer::setReuseAddress(), net::in6::stream::config::ConfigSocketServer::setReusePort(), net::in::stream::config::ConfigSocketServer::setReusePort(), net::config::ConfigTls::setShutdownTimeout(), net::config::ConfigTlsClient::setSni(), net::config::ConfigTls::setSslOptions(), net::config::ConfigConnection::setTerminateTimeout(), net::config::ConfigConnection::setWriteBlockSize(), and net::config::ConfigConnection::setWriteTimeout().

Here is the caller graph for this function:

setRequireCallback()

SubCommand * utils::SubCommand::setRequireCallback

(

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

callback

)

Definition at line 270 of file SubCommand.cpp.

                                                                                  {
        subCommandApp->require_callback(callback);
 
        return this;
    }

References subCommandApp.

version()

std::string utils::SubCommand::version

(

)

const

Definition at line 136 of file SubCommand.cpp.

                                        {
        return subCommandApp->version();
    }

References subCommandApp.

Referenced by utils::ConfigRoot::parse2().

Here is the caller graph for this function:

Member Data Documentation

aliases

std::map< std::string, std::string > utils::SubCommand::aliases

staticprotected

Definition at line 239 of file SubCommand.h.

Referenced by utils::ConfigRoot::parse2().

childSubCommands

std::set<SubCommand*> utils::SubCommand::childSubCommands

private

Definition at line 262 of file SubCommand.h.

Referenced by removeSubCommand().

commandlineOpt

CLI::Option* utils::SubCommand::commandlineOpt = nullptr

protected

Definition at line 255 of file SubCommand.h.

Referenced by SubCommand().

commandlineTriggerApp

CLI::App * utils::SubCommand::commandlineTriggerApp = nullptr

staticprotected

Definition at line 243 of file SubCommand.h.

Referenced by utils::ConfigRoot::bootstrap(), getCommandlineTriggerApp(), utils::ConfigRoot::parse1(), utils::ConfigRoot::parse2(), and SubCommand().

final

bool utils::SubCommand::final

private

Definition at line 267 of file SubCommand.h.

Referenced by SubCommand().

helpOpt

CLI::Option* utils::SubCommand::helpOpt = nullptr

protected

Definition at line 253 of file SubCommand.h.

Referenced by addSubCommandApp(), utils::ConfigRoot::parse1(), and SubCommand().

helpTriggerApp

CLI::App * utils::SubCommand::helpTriggerApp = nullptr

staticprotected

Definition at line 241 of file SubCommand.h.

Referenced by utils::ConfigRoot::bootstrap(), getHelpTriggerApp(), utils::ConfigRoot::parse1(), utils::ConfigRoot::parse2(), and SubCommand().

name

std::string utils::SubCommand::name

private

Definition at line 249 of file SubCommand.h.

Referenced by getName(), and SubCommand().

parent

SubCommand* utils::SubCommand::parent

private

Definition at line 250 of file SubCommand.h.

Referenced by getParent(), removeSubCommand(), and SubCommand().

requiredCount

int utils::SubCommand::requiredCount = 0

private

Definition at line 264 of file SubCommand.h.

Referenced by required().

requiredForced

bool utils::SubCommand::requiredForced = false

private

Definition at line 265 of file SubCommand.h.

Referenced by forceUnrequired(), and required().

selfAnchoredSubCommandApp

std::shared_ptr<AppWithPtr> utils::SubCommand::selfAnchoredSubCommandApp

private

Definition at line 258 of file SubCommand.h.

Referenced by SubCommand().

showConfigOpt

CLI::Option* utils::SubCommand::showConfigOpt = nullptr

protected

Definition at line 254 of file SubCommand.h.

Referenced by SubCommand().

showConfigTriggerApp

CLI::App * utils::SubCommand::showConfigTriggerApp = nullptr

staticprotected

Definition at line 242 of file SubCommand.h.

Referenced by utils::ConfigRoot::bootstrap(), getShowConfigTriggerApp(), utils::ConfigRoot::parse1(), utils::ConfigRoot::parse2(), and SubCommand().

subCommandApp

AppWithPtr* utils::SubCommand::subCommandApp

private

Definition at line 248 of file SubCommand.h.

Referenced by addConfigFlag(), addFlag(), addFlagFunction(), addOption(), addOptionFunction(), addOptionVariable(), addSubCommandApp(), addVersionFlag(), allowExtras(), configToStr(), description(), finalCallback(), footer(), forceUnrequired(), getOption(), getRequired(), getSubCommand(), getSubCommand(), hasParent(), help(), needs(), parse(), removeSubCommand(), required(), required(), setConfigurable(), setRequireCallback(), SubCommand(), and version().

---

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

• utils/SubCommand.h
• utils/SubCommand.cpp