Namespaces |
|
| namespace | detail |
| namespace | factory |
| Console node factories. |
|
| namespace | kw |
| Keyword argument tags. |
|
Classes |
|
| class | ConfigBundle |
| Combine multiple configuration sources. More... |
|
| class | ConfigFile |
| Console node tree based config file parser. More... |
|
| class | Executor |
| Execute config/console commands. More... |
|
| class | LazyDirectory |
| class | GenericNode |
| Config/console node tree base-class. More... |
|
| class | LinkNode |
| Config/console tree link node. More... |
|
| class | DirectoryNode |
| Config/console tree directory node. More... |
|
| struct | UnknownNodeNameException |
|
Exception: Unknown node name. More... |
|
| class | CommandNode |
| Config/console tree command node. More... |
|
| class | SimpleCommandNode |
| Most simple CommandNode implementation. More... |
|
| struct | ArgumentDoc |
| Documentation for a single argument. More... |
|
| class | CommandOverload |
| Base class for command overload of OverloadedCommandNode. More... |
|
| class | OverloadedCommandNode |
| Command node which allows multiple registered callbacks. More... |
|
| class | SimpleCommandOverload |
| Basic command overload. More... |
|
| class | SimpleOverloadAttributor |
| class | Token |
| Single argument token. More... |
|
| class | ParseCommandInfo |
| Single parsed console command. More... |
|
| struct | SyntaxErrorException |
| Syntax error parsing command arguments exception. More... |
|
| class | CheckedArgumentIteratorWrapper |
| Wrapper checking argument iterator access for validity. More... |
|
| class | CommandParser |
| Parse commands. More... |
|
| class | ParsedCommandOverloadBase |
|
CommandOverload implementation with automatic argument parsing. More... |
|
| class | ParsedCommandOverload |
| Parsed command overload. More... |
|
| class | ParsedCommandAttributorBase |
| Generic ParsedCommandOverloadBase attributes. More... |
|
| class | ParsedCommandAttributor |
| Non argument dependent ParsedCommandBase attributes. More... |
|
| class | ParsedArgumentAttributorBase |
| Derived class dependent ParsedCommandBase attributes. More... |
|
| class | ParsedArgumentAttributor |
| Argument dependent ParsedCommandBase attributes. More... |
|
| class | ProgramOptions |
| Console node tree based command line option parser. More... |
|
| class | ScopedDirectoryBase |
| Internal: Marker base class for all ScopedDirectory proxies. More... |
|
| class | ScopedDirectory |
|
DirectoryNode member proxy. More... |
|
| class | Server |
| Interactive console server. More... |
|
| class | Client |
|
Server client instance. More... |
|
| class | SysInfo |
| struct | ArgumentTraits |
| Customize argument parsing. More... |
|
| struct | ReturnValueTraits |
| Customize return value formating. More... |
|
| class | UDPServer |
| UDP Console server. More... |
|
| struct | CharAsString |
| Parse character value as single-char string. More... |
|
| struct | ValueRange |
| Value range. More... |
|
| struct | FlagCollection |
| Bit-mask flag argument type. More... |
|
Functions |
|
| void | senf_console_format_value (DirectoryNode::ptr value, std::ostream &os) |
| DirectoryNode & | root () |
| Get console root node. |
|
| void | dump (std::ostream &os, DirectoryNode &dir=root()) |
| Dump console directory structure. |
|
| DirectoryNode & | provideDirectory (DirectoryNode &dir, std::string const &name) |
| std::ostream & | operator<< (std::ostream &os, Token const &token) |
| std::ostream & | operator<< (std::ostream &stream, ParseCommandInfo const &info) |
| ScopedDirectory & | sysdir () |
| template<class Type > | |
| void | parse (ParseCommandInfo::TokensRange const &tokens, Type &out) |
| Parse token range. |
|
| template<class Type > | |
| std::string | str (Type const &value) |
| Format value. |
|
| template<class Type > | |
| void | format (Type const &value, std::ostream &os) |
| Format return value. |
|
| void | formatTrueFalse (bool value, std::ostream &os) |
Format boolean value as true / false. |
|
| void | formatYesNo (bool value, std::ostream &os) |
Format boolean value as yes / no. |
|
| void | formatEnabledDisabled (bool value, std::ostream &os) |
Format boolean value as enabled / disabled. |
|
| void | formatOnOff (bool value, std::ostream &os) |
Format boolean value as on / off. |
|
| void | formatOneZero (bool value, std::ostream &os) |
Format boolean value as 1 / 0. |
|
| void senf::console:: | ||||
| dump | ( | std::ostream & | os, | |
| DirectoryNode & |
dir = root()
|
) | ||
| void senf::console:: | ||||
| format | ( | Type const & | value, | |
| std::ostream & | os | ) | ||
Format return value.
This helper will invoke the correct ReturnValueTraits::format function to write value into the out stream.
Definition at line 75 of file Traits.cti.
| void senf::console:: | ||||
| formatEnabledDisabled | ( | bool | value, | |
| std::ostream & | os | ) | ||
Format boolean value as enabled / disabled.
Definition at line 92 of file Traits.cci.
| void senf::console:: | ||||
| formatOneZero | ( | bool | value, | |
| std::ostream & | os | ) | ||
Format boolean value as 1 / 0.
Definition at line 102 of file Traits.cci.
| void senf::console:: | ||||
| formatOnOff | ( | bool | value, | |
| std::ostream & | os | ) | ||
Format boolean value as on / off.
Definition at line 97 of file Traits.cci.
| void senf::console:: | ||||
| formatTrueFalse | ( | bool | value, | |
| std::ostream & | os | ) | ||
Format boolean value as true / false.
Definition at line 82 of file Traits.cci.
| void senf::console:: | ||||
| formatYesNo | ( | bool | value, | |
| std::ostream & | os | ) | ||
Format boolean value as yes / no.
Definition at line 87 of file Traits.cci.
| std::ostream & senf::console:: | ||||
| operator<< | ( | std::ostream & | stream, | |
| ParseCommandInfo const & | info | ) | ||
| std::ostream & senf::console:: | ||||
| operator<< | ( | std::ostream & | os, | |
| Token const & | token | ) | ||
| void senf::console:: | ||||
| parse | ( | ParseCommandInfo::TokensRange const & | tokens, | |
| Type & | out | ) | ||
Parse token range.
This helper will invoke the correct ArgumentTraits::parse function to parse the input tokens into the passed in variable.
Definition at line 63 of file Traits.cti.
| senf::console::DirectoryNode & senf::console:: | ||||
| provideDirectory | ( | DirectoryNode & | dir, | |
| std::string const & | name | ) | ||
| senf::console::DirectoryNode & senf::console:: | ||||
| root | () | |||
| void senf::console:: | ||||
| senf_console_format_value | ( | DirectoryNode::ptr | value, | |
| std::ostream & | os | ) | ||
Definition at line 465 of file Executor.cc.
| std::string senf::console:: | ||||
| str | ( | Type const & | value | ) |
Format value.
This helper will call the correct ArgumentTraits::str function to format value
Definition at line 69 of file Traits.cti.
| senf::console::ScopedDirectory & senf::console:: | ||||
| sysdir | () | |||
Definition at line 34 of file Sysdir.cci.