SNode.C
Loading...
Searching...
No Matches
subcommand::ConfigWWW Class Reference

#include <ConfigWWW.h>

Inheritance diagram for subcommand::ConfigWWW:
Collaboration diagram for subcommand::ConfigWWW:

Public Member Functions

 ConfigWWW (utils::SubCommand *parent)
ConfigWWWsetHtmlRoot (const std::string &htmlRoot)
std::string getHtmlRoot ()
Public Member Functions inherited from utils::SubCommand
 SubCommand (const SubCommand &)=delete
 SubCommand (SubCommand &&)=delete
SubCommandoperator= (const SubCommand &)=delete
SubCommandoperator= (SubCommand &&)=delete
virtual ~SubCommand ()
std::string getName () const
std::string version () const
void parse (int argc, char *argv[])
CLI::Option * setConfig (const std::string &defaultConfigFile) const
CLI::Option * setLogFile (const std::string &defaultLogFile) const
CLI::Option * setVersionFlag (const std::string &version) const
bool hasParent () const
SubCommandgetParent ()
SubCommandallowExtras (bool allow=true)
SubCommandrequired (bool required=true, bool force=true)
SubCommandrequired (SubCommand *subCommand, bool required=true)
SubCommandrequired (CLI::Option *option, bool required=true)
SubCommandneeds (SubCommand *subCommand, bool needs=true)
SubCommanddisabled (SubCommand *subCommand, bool disabled=true)
SubCommandsetRequireCallback (const std::function< void(void)> &callback)
SubCommandfinalCallback (const std::function< void()> &finalCallback)
std::string configToStr () const
std::string help (const CLI::App *helpApp, const CLI::AppFormatMode &mode) const
template<typename NewSubCommand, typename... Args>
NewSubCommand * newSubCommand (Args &&... args)
template<typename RequestedSubCommand>
RequestedSubCommand * getSubCommand ()
template<typename RequestedSubCommand>
RequestedSubCommand * getSubCommand () const
CLI::Option * getOption (const std::string &name) 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, 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, 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)
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)

Static Public Attributes

static constexpr std::string_view NAME {"www"}
static constexpr std::string_view DESCRIPTION {"Web behavior of httpserver"}
Static Public Attributes inherited from utils::SubCommand
static std::shared_ptr< CLI::Formatter > sectionFormatter = makeSectionFormatter()

Private Attributes

CLI::Option * htmlRootOpt

Additional Inherited Members

Static Public Member Functions inherited from utils::SubCommand
static CLI::App * getHelpTriggerApp ()
static CLI::App * getShowConfigTriggerApp ()
static CLI::App * getCommandlineTriggerApp ()
Protected Member Functions inherited from utils::SubCommand
 SubCommand (SubCommand *parent, std::shared_ptr< utils::AppWithPtr > appWithPtr, const std::string &group, bool final)
template<typename ConcretSubCommand>
 SubCommand (SubCommand *parent, ConcretSubCommand *concretSubCommand, const std::string &group, bool final=true)
SubCommanddescription (const std::string &description)
SubCommandfooter (const std::string &footer)
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
Static Protected Attributes inherited from utils::SubCommand
static std::map< std::string, std::string > aliases
static CLI::App * helpTriggerApp = nullptr
static CLI::App * showConfigTriggerApp = nullptr
static CLI::App * commandlineTriggerApp = nullptr

Detailed Description

Definition at line 56 of file ConfigWWW.h.

Constructor & Destructor Documentation

◆ ConfigWWW()

subcommand::ConfigWWW::ConfigWWW ( utils::SubCommand * parent)

Definition at line 50 of file ConfigWWW.cpp.

51 : utils::SubCommand(parent, this, "Applications", false) {
52 htmlRootOpt = addOption("--html-root", "HTML root directory", "directory", CLI::ExistingDirectory);
53
55 }
CLI::Option * htmlRootOpt
Definition ConfigWWW.h:67
SubCommand * required(bool required=true, bool force=true)
SubCommand * parent
Definition SubCommand.h:245
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const

References utils::SubCommand::addOption(), htmlRootOpt, utils::SubCommand::required(), and utils::SubCommand::SubCommand().

Here is the call graph for this function:

Member Function Documentation

◆ getHtmlRoot()

std::string subcommand::ConfigWWW::getHtmlRoot ( )

Definition at line 65 of file ConfigWWW.cpp.

65 {
66 return htmlRootOpt->as<std::string>();
67 }

References htmlRootOpt.

Referenced by main().

Here is the caller graph for this function:

◆ setHtmlRoot()

ConfigWWW & subcommand::ConfigWWW::setHtmlRoot ( const std::string & htmlRoot)

Definition at line 57 of file ConfigWWW.cpp.

57 {
59
60 required(htmlRootOpt, false);
61
62 return *this;
63 }
CLI::Option * setDefaultValue(CLI::Option *option, const ValueTypeT &value, bool clear=true) const
Definition SubCommand.h:337

References htmlRootOpt, utils::SubCommand::required(), and utils::SubCommand::setDefaultValue().

Here is the call graph for this function:

Member Data Documentation

◆ DESCRIPTION

std::string_view subcommand::ConfigWWW::DESCRIPTION {"Web behavior of httpserver"}
staticconstexpr

Definition at line 59 of file ConfigWWW.h.

59{"Web behavior of httpserver"};

◆ htmlRootOpt

CLI::Option* subcommand::ConfigWWW::htmlRootOpt
private

Definition at line 67 of file ConfigWWW.h.

Referenced by ConfigWWW(), getHtmlRoot(), and setHtmlRoot().

◆ NAME

std::string_view subcommand::ConfigWWW::NAME {"www"}
staticconstexpr

Definition at line 58 of file ConfigWWW.h.

58{"www"};

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