X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Console%2FNode.hh;h=6a2732c4ba8b4f80718b3bf5f41f9af76000dce2;hb=0eaf5340de8c2fbb02b1e0e13a797931e221dff3;hp=cf484036d4a675f5e552abbf45661a8b9f58bb22;hpb=c70f7413515b513656f850f51a3cc2ea9d776a37;p=senf.git diff --git a/Console/Node.hh b/Console/Node.hh index cf48403..6a2732c 100644 --- a/Console/Node.hh +++ b/Console/Node.hh @@ -23,6 +23,174 @@ /** \file \brief Node public header */ +/** \defgroup node_tree The node tree + + The console/config node tree is the central data-structure of the library. Into this tree, all + commands and parameters are entered. The tree is then exposed using a file-system like + interface. + + \autotoc + + \section console_tree The tree + + We will start by giving a more complete example. This example contains most of the stuff needed + for using the console/config library. + + \code + // Define callback function. + void mycommand(std::ostream & os, senf::console::ParseCommandInfo const & command) + { + // ... + os << "!! Important message ...\n"; + } + + class SomeClass + { + public: + // Declare a directory node (proxy) for use by this class. This must be public so we can add + // it to the node tree later. + senf::console::ScopedDirectory dir; + + SomeClass() : dir(this) + { + // You may document the directory here or later when adding it to the tree + dir.doc("Manager for something"); + + // Add a member function (the pointer-to-member is automatically bound to this instance) + dir.add("member", &SomeClass::member) + .doc("Do the member operation"); + } + + void member(std::ostream & os, senf::console::ParseCommandInfo const & command) + { + // ... + } + }; + + int main(int, char**) + { + // Provide global documentation + senf::console::root() + .doc("This is someServer server"); + + // Add a new directory to the root and document it. All the mutators return the node object + // itself so operations can be chained. + senf::console::DirectoryNode & mydir ( + .mkdir("myserver") + .doc("My server specific directory")); + + // Add a command to that directory + mydir.add("mycommand", &mycommand) + .doc("mycommand []\n\n" + "If is given, flurgle the , otherwise burgle it"); + + // Create a SomeClass instance and add it's directory. + SomeClass someClass; + mydir.add("someClass", someClass.dir); + + // Start the interactive console server + senf::console::Server::start(senf::INet4SocketAddress(senf::INet4Address::None, 23232u)) + .name("someServer"); + } + \endcode + + \subsection console_nodes Node types + + The console/config library tree consists of two basic node types: + + \li senf::console::DirectoryNode provides internal nodes with an arbitrary number of children + \li senf::console::CommandNode describes a command entry in the tree + + senf::console::CommandNode is the base-class of all command nodes of which there are several, + depending on the type of command. + + There is a single root node, the senf::console::DirectoryNode called senf::console::root(). From + this node, the tree is traversed. + + All nodes are allocated on the heap and are managed using a smart pointer. + + \subsection console_manipulate Manipulating the node tree + + There are several ways to add nodes to the tree: + + \li A senf::console::DirectoryNode can be added using senf::console::DirectoryNode::mkdir(). + \li An arbitrary node can be created and then (possibly later) added to the tree using the + corresponding senf::console::DirectoryNode::add() overload. + \li A senf::console::CommandNode is normally added to the tree by directly adding a callback + using one of the overloaded senf::console::DirectoryNode::add() members. See \ref + console_commands. + + When directly adding a node callback, the type of node added depends on the type of + callback. The callback types which can be added are listed at \ref console_callbacks. + + \code + void callback(std::ostream & os, senf::console::ParseCommandInfo const & command) { ... } + // ... + myDirectory.add("foo",&callback); + \endcode + + Every node is identified among it's siblings by it's name. The name of the node is set when + adding the node to the tree. If the name is empty or non-unique, a unique name will be + automatically provided. + + To remove a node from the tree, just use the nodes senf::console::GenericNode::unlink() or the + parents senf::console::DirectoryNode::remove() member. This call removes the node from it's + parent and returns a (smart) node pointer. + + \li If you ignore the return value, the node (and it's children) will be deleted. + \li Alternatively, you may store away the node and re-attach it later. + \li An node (or subtree) can be moved to a different place by unlinking the node at it's old + place and re-adding it at it's new location. + \li To rename a node, unlink and re-add it with a different name. + + \code + myDirectory.add("bar", myDirectory.remove("foo")); + \endcode + + \subsection console_node_param Assigning additional node parameters + + Depending on the node type added, additional node parameters may be set. For example, every node + has a documentation parameter which is used by the online-help system. To assign these + parameters, the node exposes corresponding member functions. Since + senf::console::DirectoryNode::add() returns the newly added node by reference, additional + parameters may just be added to the end of the add command: + \code + myDirectory.add("foo",&fooCallback).doc("The foo method"); + \endcode + Since the parameter setters all return the node reference, additional parameters may just be + added to the end of the command. + + \subsection console_tree_traverse Traversing the tree + + The simplest way to access tree elements is to save the return value of the + senf::console::DirectoryNode::add() members. However, saving the reference will not ensure, that + the node is not removed. If the node might be removed from the tree, you should use a smart + pointer (either ptr or weak_ptr) to hold the node. + + Another possibility is to traverse the tree explicitly. For this purpose, the operators '[]' and + '()' have been overloaded in senf::console::DirectoryNode. + \code + senf::console::root().getDirectory("myDirectory").getCommand("foo") + \\ or more concise but otherwise completely identical + senf::console::root()["myDirectory"]("foo") + \endcode + + getDirectory and the '[]' operator will return a senf::console::DirectoryNode whereas getCommand + and the '()' operator will return a senf::console::CommandNode. If the node is not found or is + not of the correct type, an exception will be raised. + + \section console_object_dir Assigning a directory to an object instance + + Most objects will register several commands. So it makes sense for these objects to manage their + own directory. Since directories are however allocated on the heap, they cannot be directly + added to a class. To facilitate this usage, the senf::console::ScopedDirectory is used. This + class provides a senf::console::DirectoryNode facade. Internally, it automatically creates a + senf::console::DirectoryNode to which all calls are forwarded. + + The senf::console::ScopedDirectory member should be declared public. This allows the user of the + class to add the node to the tree. + */ + #ifndef HH_Node_ #define HH_Node_ 1 @@ -38,13 +206,12 @@ #include "../Utils/Exception.hh" #include "../Utils/mpl.hh" #include "../Utils/Logger/SenfLog.hh" +#include "../Utils/type_traits.hh" #include "Parse.hh" //#include "Node.mpp" ///////////////////////////////hh.p//////////////////////////////////////// -#include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP() - namespace senf { namespace console { @@ -65,6 +232,8 @@ namespace console { Every active (non-orphaned) node (except the root() node) has a non-empty node name. This name is assigned to the node when adding the node to the tree. + + \ingroup node_tree */ class GenericNode : public boost::enable_shared_from_this @@ -138,14 +307,17 @@ namespace console { typedef BOOST_TYPEOF_TPL( senf_console_add_node( * static_cast(0), * static_cast(0), - * static_cast(0), - 0) ) result_type; + * static_cast(0), + 0) ) base_type; + typedef typename senf::remove_cvref::type value_type; - typedef typename boost::remove_reference::type NodeType; + typedef typename value_type::node_type NodeType; + typedef typename value_type::return_type result_type; + /// Internal struct Creator { - static NodeType & create(DirectoryNode & node, std::string const & name, - Object const & ob); + static result_type create(DirectoryNode & node, std::string const & name, + Object & ob); }; }; @@ -158,8 +330,8 @@ namespace console { mkdir() or add(). Special add() members however allow externally allocated node objects. Nodes may be added to the tree only once, otherwise chaos will ensue. Since nodes are always - managed dynamically, there is a special ObjectDirectory proxy template which provides a - DirectoryNode facade. ObjectDirectory is used if a class wants to manage it's own directory + managed dynamically, there is a special ScopedDirectory proxy template which provides a + DirectoryNode facade. ScopedDirectory is used if a class wants to manage it's own directory as a data member. Every node is assigned a (new) name when it is added to a directory. If the directory @@ -167,6 +339,8 @@ namespace console { '-n' where n is a number starting at 1. If the name is empty, int is set to 'unnamed' and then uniquified as above. Automatically providing unique names simplifies adding configuration/console support to generic components. + + \ingroup node_tree */ class DirectoryNode : public GenericNode { @@ -183,13 +357,16 @@ namespace console { typedef boost::iterator_range ChildrenRange; typedef ChildMap::const_iterator child_iterator; + typedef DirectoryNode node_type; + typedef DirectoryNode & return_type; + /////////////////////////////////////////////////////////////////////////// ///\name Structors and default members ///\{ static ptr create(); ///< Create node object. /**< You should normally use either mkdir() or - ObjectDirectory instead of create() */ + ScopedDirectory instead of create() */ ///\} /////////////////////////////////////////////////////////////////////////// @@ -206,7 +383,7 @@ namespace console { \a name is empty, it is set to 'unnamed'. */ template - typename NodeCreateTraits::NodeType & add (std::string const & name, + typename NodeCreateTraits::result_type add(std::string const & name, Object const & ob); ///< Generic child node factory /**< This member is used to create a new child node of the @@ -232,6 +409,12 @@ namespace console { is not used but serves to disambiguate the overloads). */ + template + typename NodeCreateTraits::result_type add(std::string const & name, + Object & ob); + ///< Generic child node factory + /**< \see add() */ + GenericNode::ptr remove(std::string const & name); ///< Remove node \a name from the tree /**< The returned pointer may either be discarded, which @@ -239,24 +422,45 @@ namespace console { be saved and/or re-attached at some other place in the tree. */ + bool hasChild(std::string const & name) const; + ///< \c true, if there is a child with name \a name + + GenericNode & get(std::string const & name) const; + ///< Get child node + /**< \throws UnknownNodeNameException if a child \a name + does not exist */ + + DirectoryNode & getDirectory(std::string const & name) const; + ///< Get directory child node + /**< Same as operator[] + \throws UnknownNodeNameException if a child \a name + does not exist. + \throws std::bad_cast if the child \a name is not a + directory node. */ + DirectoryNode & operator[](std::string const & name) const; ///< Get directory child node - /**< \throws UnknownNodeNameException if a child \a name + /**< Same as getDirectory + \throws UnknownNodeNameException if a child \a name does not exist. \throws std::bad_cast if the child \a name is not a directory node. */ - CommandNode & operator()(std::string const & name) const; + CommandNode & getCommand(std::string const & name) const; ///< Get command child node - /**< \throws UnknownNodeNameException if a child \a name + /**< Same as operator() + \throws UnknownNodeNameException if a child \a name does not exist \throws std::bad_cast if the child \a name is not a command node. */ - GenericNode & get(std::string const & name) const; - ///< Get child node - /**< \throws UnknownNodeNameException if a child \a name - does not exist */ + CommandNode & operator()(std::string const & name) const; + ///< Get command child node + /**< Same as getCommand() + \throws UnknownNodeNameException if a child \a name + does not exist + \throws std::bad_cast if the child \a name is not a + command node. */ DirectoryNode & mkdir(std::string const & name); ///< Create sub-directory node @@ -271,7 +475,7 @@ namespace console { template GenericNode & traverse(ForwardRange const & range); ///< Traverse node path starting at this node - /**< The FordwareRange::value_type must be + /**< The ForwardRange::value_type must be (convertible to) std::string. Each range element constitutes a step along the node traversal. @@ -299,8 +503,6 @@ namespace console { friend DirectoryNode & root(); }; - BOOST_TYPEOF_REGISTER_TYPE(DirectoryNode); - /// Exception: Unknown node name struct UnknownNodeNameException : public senf::Exception { UnknownNodeNameException() : senf::Exception("Unknown node name") {}}; @@ -311,13 +513,29 @@ namespace console { {}; #endif + /** \brief Syntax error parsing command arguments exception + + All errors while parsing the arguments of a command must be signaled by throwing an instance + of SyntaxErrorException. This is important, so command overloading works. + */ + struct SyntaxErrorException : public senf::Exception + { + explicit SyntaxErrorException(std::string const & msg = ""); + + virtual char const * what() const throw(); + }; + /** \brief Config/console tree command node The CommandNode is the base-class for the tree leaf nodes. Concrete command node implementations are derived from this class. - To execute a command, CommandNode::operator()() is called. This abstract virtual function - must be implemented in a derived class. + To execute a command, CommandNode::operator()() or CommandNode::execute() is called. + + Subclass instances of this node type are automatically created when adding commands to the + tree. See \ref console_commands. + + \ingroup node_tree */ class CommandNode : public GenericNode { @@ -330,13 +548,20 @@ namespace console { typedef boost::shared_ptr cptr; typedef boost::weak_ptr weak_ptr; - typedef ParseCommandInfo::ArgumentsRange Arguments; - /////////////////////////////////////////////////////////////////////////// - virtual void operator()(std::ostream & output, Arguments const & arguments) = 0; - ///< Called to execute the command - /**< \param[in] output stream where result messages may be + void execute(std::ostream & output, ParseCommandInfo const & command) const; + ///< Execute the command + /**< Same as operator()() + \param[in] output stream where result messages may be + written to + \param[in] arguments command arguments. This is a + range of ranges of ArgumentToken instances. */ + + void operator()(std::ostream & output, ParseCommandInfo const & command) const; + ///< Execute the command + /**< Same as execute() + \param[in] output stream where result messages may be written to \param[in] arguments command arguments. This is a range of ranges of ArgumentToken instances. */ @@ -347,14 +572,31 @@ namespace console { protected: CommandNode(); +#ifndef DOXYGEN + private: +#endif + virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const = 0; + ///< Called to execute the command + /**< \param[in] output stream where result messages may be + written to + \param[in] arguments command arguments. This is a + range of ranges of ArgumentToken instances. */ + private: }; /** \brief Most simple CommandNode implementation This CommandNode implementation simply forwards the \a output and \a arguments arguments to - an arbitrary callback. - */ + an arbitrary callback. Thus, it allows to add callbacks with the signature + \code + void callback(std::ostream & os, senf::console::ParseCommandInfo const & command) + { ... } + \endcode + to the tree. + + \ingroup console_commands + */ class SimpleCommandNode : public CommandNode { SENF_LOG_CLASS_AREA(); @@ -366,17 +608,23 @@ namespace console { typedef boost::shared_ptr cptr; typedef boost::weak_ptr weak_ptr; - typedef boost::function Function; + typedef boost::function Function; + + typedef SimpleCommandNode node_type; + typedef SimpleCommandNode & return_type; /////////////////////////////////////////////////////////////////////////// + ///\name Structors and default members + ///\{ + + static ptr create(Function const & fn); - virtual void operator()(std::ostream & output, Arguments const & arguments); + ///\} + /////////////////////////////////////////////////////////////////////////// ptr thisptr(); cptr thisptr() const; - static ptr create(Function const & fn); - SimpleCommandNode & doc(std::string const & doc); protected: @@ -384,23 +632,30 @@ namespace console { private: virtual void v_help(std::ostream & output) const; + virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const; + Function fn_; std::string doc_; }; #ifndef DOXYGEN - template + SimpleCommandNode & senf_console_add_node(DirectoryNode & node, std::string const & name, - Function const & fn, ...); -#endif + SimpleCommandNode::Function fn, int); - BOOST_TYPEOF_REGISTER_TYPE(SimpleCommandNode); +#endif DirectoryNode & root(); }} +#include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP() + +BOOST_TYPEOF_REGISTER_TYPE(senf::console::DirectoryNode) +BOOST_TYPEOF_REGISTER_TYPE(senf::console::SimpleCommandNode) + + ///////////////////////////////hh.e//////////////////////////////////////// #include "Node.cci" #include "Node.ct"