4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief Node public header */
26 /** \defgroup node_tree The node tree
28 The console/config node tree is the central data-structure of the library. Into this tree, all
29 commands and parameters are entered. The tree is then exposed using a file-system like
34 \section console_tree The tree
36 We will start by giving a more complete example. This example contains most of the stuff needed
37 for using the console/config library.
40 // Define callback function.
41 void mycommand(std::ostream & os, senf::console::ParseCommandInfo const & command)
44 os << "!! Important message ...\n";
50 // Declare a directory node (proxy) for use by this class. This must be public so we can add
51 // it to the node tree later.
52 senf::console::ScopedDirectory<SomeClass> dir;
54 SomeClass() : dir(this)
56 // You may document the directory here or later when adding it to the tree
57 dir.doc("Manager for something");
59 // Add a member function (the pointer-to-member is automatically bound to this instance)
60 dir.add("member", &SomeClass::member)
61 .doc("Do the member operation");
64 void member(std::ostream & os, senf::console::ParseCommandInfo const & command)
72 // Provide global documentation
74 .doc("This is someServer server");
76 // Add a new directory to the root and document it. All the mutators return the node object
77 // itself so operations can be chained.
78 senf::console::DirectoryNode & mydir (
80 .doc("My server specific directory"));
82 // Add a command to that directory
83 mydir.add("mycommand", &mycommand)
84 .doc("mycommand <foo> [<bar>]\n\n"
85 "If <bar> is given, flurgle the <foo>, otherwise burgle it");
87 // Create a SomeClass instance and add it's directory.
89 mydir.add("someClass", someClass.dir);
91 // Start the interactive console server
92 senf::console::Server::start(senf::INet4SocketAddress(senf::INet4Address::None, 23232u))
97 \subsection console_nodes Node types
99 The console/config library tree consists of two basic node types:
101 \li senf::console::DirectoryNode provides internal nodes with an arbitrary number of children
102 \li senf::console::CommandNode describes a command entry in the tree
103 \li senf::console::LinkNode is a link to another node. It works much like a symlink on POSIX
106 senf::console::CommandNode is the base-class of all command nodes of which there are several,
107 depending on the type of command.
109 There is a single root node, the senf::console::DirectoryNode called senf::console::root(). From
110 this node, the tree is traversed.
112 All nodes are allocated on the heap and are managed using a smart pointer.
114 \subsection console_manipulate Manipulating the node tree
116 There are several ways to add nodes to the tree:
118 \li A senf::console::DirectoryNode can be added using senf::console::DirectoryNode::mkdir().
119 \li An arbitrary node can be created and then (possibly later) added to the tree using the
120 corresponding senf::console::DirectoryNode::add() overload.
121 \li A senf::console::CommandNode is normally added to the tree by directly adding a callback
122 using one of the overloaded senf::console::DirectoryNode::add() members. See \ref
124 \li A senf::console::LinkNode is created by senf::console::DirectoryNode::link()
126 When directly adding a node callback, the type of node added depends on the type of
127 callback. The callback types which can be added are listed at \ref console_callbacks.
130 void callback(std::ostream & os, senf::console::ParseCommandInfo const & command) { ... }
132 myDirectory.add("foo",&callback);
135 Every node is identified among it's siblings by it's name. The name of the node is set when
136 adding the node to the tree. If the name is empty or non-unique, a unique name will be
137 automatically provided.
139 To remove a node from the tree, just use the nodes senf::console::GenericNode::unlink() or the
140 parents senf::console::DirectoryNode::remove() member. This call removes the node from it's
141 parent and returns a (smart) node pointer.
143 \li If you ignore the return value, the node (and it's children) will be deleted.
144 \li Alternatively, you may store away the node and re-attach it later.
145 \li An node (or subtree) can be moved to a different place by unlinking the node at it's old
146 place and re-adding it at it's new location.
147 \li To rename a node, unlink and re-add it with a different name.
150 myDirectory.add("bar", myDirectory.remove("foo"));
153 \subsection console_node_param Assigning additional node parameters
155 Depending on the node type added, additional node parameters may be set. For example, every node
156 has a documentation parameter which is used by the online-help system. To assign these
157 parameters, the node exposes corresponding member functions. Since
158 senf::console::DirectoryNode::add() returns the newly added node by reference, additional
159 parameters may just be added to the end of the add command:
161 myDirectory.add("foo",&fooCallback).doc("The foo method");
163 Since the parameter setters all return the node reference, additional parameters may just be
164 added to the end of the command.
166 \subsection console_tree_traverse Traversing the tree
168 The simplest way to access tree elements is to save the return value of the
169 senf::console::DirectoryNode::add() members. However, saving the reference will not ensure, that
170 the node is not removed. If the node might be removed from the tree, you should use a smart
171 pointer (either <tt>ptr</tt> or <tt>weak_ptr</tt>) to hold the node.
173 Another possibility is to traverse the tree explicitly. For this purpose, the operators '[]' and
174 '()' have been overloaded in senf::console::DirectoryNode.
176 senf::console::root().getDirectory("myDirectory").getCommand("foo")
177 \\ or more concise but otherwise completely identical
178 senf::console::root()["myDirectory"]("foo")
181 getDirectory and the '[]' operator will return a senf::console::DirectoryNode whereas getCommand
182 and the '()' operator will return a senf::console::CommandNode. If the node is not found or is
183 not of the correct type, an exception will be raised.
185 \section console_object_dir Assigning a directory to an object instance
187 Most objects will register several commands. So it makes sense for these objects to manage their
188 own directory. Since directories are however allocated on the heap, they cannot be directly
189 added to a class. To facilitate this usage, the senf::console::ScopedDirectory is used. This
190 class provides a senf::console::DirectoryNode facade. Internally, it automatically creates a
191 senf::console::DirectoryNode to which all calls are forwarded.
193 The senf::console::ScopedDirectory member should be declared public. This allows the user of the
194 class to add the node to the tree.
202 #include <boost/shared_ptr.hpp>
203 #include <boost/weak_ptr.hpp>
204 #include <boost/enable_shared_from_this.hpp>
205 #include <boost/utility.hpp>
206 #include <boost/range/iterator_range.hpp>
207 #include <boost/typeof/typeof.hpp>
208 #include <boost/type_traits/remove_reference.hpp>
209 #include "../Utils/Exception.hh"
210 #include "../Utils/mpl.hh"
211 #include "../Utils/Logger/SenfLog.hh"
212 #include "../Utils/type_traits.hh"
215 //#include "Node.mpp"
216 ///////////////////////////////hh.p////////////////////////////////////////
225 DirectoryNode & root();
227 /** \brief Config/console node tree base-class
229 GenericNode is the base class of all node objects. There are two basic node types derived
230 from GenericNode: DirectoryNode and CommandNode.
232 All nodes are dynamically allocated and automatically managed using reference counting.
234 All nodes are normally linked into a single tree which root node is
235 senf::console::root(). Nodes may however be orphaned (not linked to the tree) either
236 directly (the node has no parent) or indirectly (the node has a parent but is part of an
237 orphaned subtree which is not linked to the root node).
239 Every active (non-orphaned) node (except the root() node) has a non-empty node name. This
240 name is assigned to the node when adding the node to the tree.
245 : public boost::enable_shared_from_this<GenericNode>
247 SENF_LOG_CLASS_AREA();
249 ///////////////////////////////////////////////////////////////////////////
252 typedef boost::shared_ptr<GenericNode> ptr;
253 typedef boost::shared_ptr<GenericNode const> cptr;
254 typedef boost::weak_ptr<GenericNode> weak_ptr;
256 ///////////////////////////////////////////////////////////////////////////
258 virtual ~GenericNode();
260 std::string const & name() const; ///< Node name
261 boost::shared_ptr<DirectoryNode> parent() const; ///< Parent node
262 /**< May be null, if the node is the root node or if it is
263 not linked to the tree */
265 std::string path() const; ///< Node path
266 /**< The node path is built by joining the names of all
267 parent nodes with '/' chars. */
268 std::string path(DirectoryNode const & root) const;
269 ///< Node path up to \a root
270 /**< The node path is built by joining the names of all
271 parent nodes up to \a root with '/' chars. */
273 ptr unlink(); ///< Remove node from it's parent directory
274 /**< You may either discard the return value and thereby
275 dispose the node or may re-attach the node at some
276 other place using DirectoryNode::add(). */
278 bool active() const; ///< \c true, if node is attached to the root() node
280 void help(std::ostream & output) const; /// Write help info to \a output
282 ptr thisptr(); ///< Get smart pointer to node
283 cptr thisptr() const; ///< Get smart pointer to node (const)
285 bool isChildOf(DirectoryNode & parent) const;
286 ///< \c true, if node is a child of \a parent
287 /**< Will also return \c true, if \a parent is the current
290 bool operator== (GenericNode & other) const;
291 /// \c true, if this and \a other are the same node
292 bool operator!= (GenericNode & other) const;
293 /// \c true, if this and \a other are different nodes
295 bool isDirectory() const; ///< \c true, if this is a drectory node
296 bool isLink() const; ///< \c true, if this is a link node
297 bool isCommand() const; ///< \c true, if this is a command node
302 void name(std::string const & name);
309 virtual void v_help(std::ostream & output) const = 0;
310 ///< Provide help information
311 /**< This member must be implemented in derived classes
312 to provide node specific help information. */
316 DirectoryNode * parent_;
318 friend class DirectoryNode;
321 /** \brief Config/console tree link node
323 A LinkNode references another node and provides an additional alias name for that node. A
324 LinkNode works like a mixture of UNIX symlinks and hardlinks: It is an explicit link like a
325 UNIX symlink but references another node directly (not via it's path) like a UNIX
326 hardlink. Therefore, a LinkNode works across chroot().
332 ///////////////////////////////////////////////////////////////////////////
335 typedef boost::shared_ptr<LinkNode> ptr;
336 typedef boost::shared_ptr<LinkNode const> cptr;
337 typedef boost::weak_ptr<LinkNode> weak_ptr;
339 ///////////////////////////////////////////////////////////////////////////
340 ///\name Structors and default members
343 static ptr create(GenericNode & node); ///< Create new link node.
344 /**< You should normally use DirectoryNode::link() to
345 create a link node. */
348 ///////////////////////////////////////////////////////////////////////////
350 GenericNode & follow() const; ///< Access the referenced node
355 explicit LinkNode(GenericNode & node);
357 virtual void v_help(std::ostream &) const;
359 GenericNode::ptr node_;
362 class SimpleCommandNode;
364 /** \brief Internal: Node creation helper traits
366 This class is used internally to find out the type of node to create for a specific argument
369 template <class Object>
370 struct NodeCreateTraits
372 typedef BOOST_TYPEOF_TPL( senf_console_add_node(
373 * static_cast<DirectoryNode *>(0),
374 * static_cast<std::string const *>(0),
375 * static_cast<Object *>(0),
377 typedef typename senf::remove_cvref<base_type>::type value_type;
379 typedef typename value_type::node_type NodeType;
380 typedef typename value_type::return_type result_type;
384 static result_type create(DirectoryNode & node, std::string const & name,
389 /** \brief Config/console tree directory node
391 This node type provides the internal and root nodes of the tree. It allows to add arbitrary
392 children and supports directory traversal.
394 Nodes are normally not instantiated manually but are created by the DirectoryNode via
395 mkdir() or add(). Special add() members however allow externally allocated node objects.
397 Nodes may be added to the tree only once, otherwise chaos will ensue. Since nodes are always
398 managed dynamically, there is a special ScopedDirectory proxy template which provides a
399 DirectoryNode facade. ScopedDirectory is used if a class wants to manage it's own directory
402 Every node is assigned a (new) name when it is added to a directory. If the directory
403 already has an entry of that name, the name is made unique by appending a suffix of the form
404 '-n' where n is a number starting at 1. If the name is empty, int is set to 'unnamed' and
405 then uniquified as above. Automatically providing unique names simplifies adding
406 configuration/console support to generic components.
410 class DirectoryNode : public GenericNode
412 SENF_LOG_CLASS_AREA();
413 typedef std::map<std::string, GenericNode::ptr> ChildMap;
415 ///////////////////////////////////////////////////////////////////////////
418 typedef boost::shared_ptr<DirectoryNode> ptr;
419 typedef boost::shared_ptr<DirectoryNode const> cptr;
420 typedef boost::weak_ptr<DirectoryNode> weak_ptr;
422 typedef boost::iterator_range<ChildMap::const_iterator> ChildrenRange;
423 typedef ChildMap::const_iterator child_iterator;
425 typedef DirectoryNode node_type;
426 typedef DirectoryNode & return_type;
428 ///////////////////////////////////////////////////////////////////////////
429 ///\name Structors and default members
432 static ptr create(); ///< Create node object.
433 /**< You should normally use either mkdir() or
434 ScopedDirectory instead of create() */
437 ///////////////////////////////////////////////////////////////////////////
441 template <class NodeType>
442 NodeType & add(std::string const & name, boost::shared_ptr<NodeType> node);
443 ///< Add node to tree
444 /**< Adds the \a node to the tree as a child of \a this
445 node. The node is given the name \a name. If a node of
446 that name already exists, a numeric suffix of the form
447 '-n' is added to the name until the name is unique. If
448 \a name is empty, it is set to 'unnamed'. */
450 template <class Object>
451 typename NodeCreateTraits<Object>::result_type add(std::string const & name,
453 ///< Generic child node factory
454 /**< This member is used to create a new child node of the
455 current directory. The type of node created depends on
456 the type of argument passed.
458 The node type is selected by the NodeCreateTraits
459 class. To allow adding a specific node type, you need
460 to provide an overload for
461 <tt>senf_console_add_node</tt> which must be visible at
462 when you register the new node.
464 MyNodeType & senf_console_add_node(
466 std::string const & name,
467 MySpecialObject const & ob,
470 return dir.add(name, MyNodeType::create(ob));
473 (Do not forget the last unnamed 'int' parameter which
474 is not used but serves to disambiguate the
477 template <class Object>
478 typename NodeCreateTraits<Object>::result_type add(std::string const & name,
480 ///< Generic child node factory
483 GenericNode::ptr remove(std::string const & name);
484 ///< Remove node \a name from the tree
485 /**< The returned pointer may either be discarded, which
486 will automatically dispose the removed node, or it may
487 be saved and/or re-attached at some other place in the
490 bool hasChild(std::string const & name) const;
491 ///< \c true, if there is a child with name \a name
493 GenericNode & get(std::string const & name) const;
495 /**< \throws UnknownNodeNameException if a child \a name
497 GenericNode & getLink(std::string const & name) const;
498 ///< Get child node without dereferencing links
499 /**< \throws UnknownNodeNameException if a child \a name
502 DirectoryNode & getDirectory(std::string const & name) const;
503 ///< Get directory child node
504 /**< Same as operator[]
505 \throws UnknownNodeNameException if a child \a name
507 \throws std::bad_cast if the child \a name is not a
510 DirectoryNode & operator[](std::string const & name) const;
511 ///< Get directory child node
512 /**< Same as getDirectory
513 \throws UnknownNodeNameException if a child \a name
515 \throws std::bad_cast if the child \a name is not a
518 CommandNode & getCommand(std::string const & name) const;
519 ///< Get command child node
520 /**< Same as operator()
521 \throws UnknownNodeNameException if a child \a name
523 \throws std::bad_cast if the child \a name is not a
526 CommandNode & operator()(std::string const & name) const;
527 ///< Get command child node
528 /**< Same as getCommand()
529 \throws UnknownNodeNameException if a child \a name
531 \throws std::bad_cast if the child \a name is not a
534 DirectoryNode & mkdir(std::string const & name);
535 ///< Create sub-directory node
537 ChildrenRange children() const; ///< Return iterator range over all children.
538 /**< The returned range is sorted by child name. */
540 ChildrenRange completions(std::string const & s) const;
541 ///< Return iterator range of completions for \a s
542 /**< The returned range is sorted by child name. */
544 void link(std::string const & name, GenericNode & target);
547 ///////////////////////////////////////////////////////////////////////////
549 DirectoryNode & doc(std::string const & doc); ///< Set node documentation
552 cptr thisptr() const;
558 void add(GenericNode::ptr node);
559 virtual void v_help(std::ostream & output) const;
564 friend DirectoryNode & root();
567 /// Exception: Unknown node name
568 struct UnknownNodeNameException : public senf::Exception
569 { UnknownNodeNameException() : senf::Exception("Unknown node name") {}};
572 template <class Type>
573 struct NodeCreateTraits< boost::shared_ptr<Type> >
577 /** \brief Config/console tree command node
579 The CommandNode is the base-class for the tree leaf nodes. Concrete command node
580 implementations are derived from this class.
582 To execute a command, CommandNode::operator()() or CommandNode::execute() is called.
584 Subclass instances of this node type are automatically created when adding commands to the
585 tree. See \ref console_commands.
589 class CommandNode : public GenericNode
591 SENF_LOG_CLASS_AREA();
593 ///////////////////////////////////////////////////////////////////////////
596 typedef boost::shared_ptr<CommandNode> ptr;
597 typedef boost::shared_ptr<CommandNode const> cptr;
598 typedef boost::weak_ptr<CommandNode> weak_ptr;
600 ///////////////////////////////////////////////////////////////////////////
602 void execute(std::ostream & output, ParseCommandInfo const & command) const;
603 ///< Execute the command
604 /**< Same as operator()()
605 \param[in] output stream where result messages may be
607 \param[in] arguments command arguments. This is a
608 range of ranges of Token instances. */
610 void operator()(std::ostream & output, ParseCommandInfo const & command) const;
611 ///< Execute the command
612 /**< Same as execute()
613 \param[in] output stream where result messages may be
615 \param[in] arguments command arguments. This is a
616 range of ranges of Token instances. */
619 cptr thisptr() const;
627 virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const = 0;
628 ///< Called to execute the command
629 /**< \param[in] output stream where result messages may be
631 \param[in] arguments command arguments. This is a
632 range of ranges of Token instances. */
637 /** \brief Most simple CommandNode implementation
639 This CommandNode implementation simply forwards the \a output and \a arguments arguments to
640 an arbitrary callback. Thus, it allows to add callbacks with the signature
642 void callback(std::ostream & os, senf::console::ParseCommandInfo const & command)
647 \ingroup console_commands
649 class SimpleCommandNode : public CommandNode
651 SENF_LOG_CLASS_AREA();
653 ///////////////////////////////////////////////////////////////////////////
656 typedef boost::shared_ptr<SimpleCommandNode> ptr;
657 typedef boost::shared_ptr<SimpleCommandNode const> cptr;
658 typedef boost::weak_ptr<SimpleCommandNode> weak_ptr;
660 typedef boost::function<void (std::ostream &, ParseCommandInfo const &)> Function;
662 typedef SimpleCommandNode node_type;
663 typedef SimpleCommandNode & return_type;
665 ///////////////////////////////////////////////////////////////////////////
666 ///\name Structors and default members
669 static ptr create(Function const & fn);
672 ///////////////////////////////////////////////////////////////////////////
675 cptr thisptr() const;
677 SimpleCommandNode & doc(std::string const & doc);
680 SimpleCommandNode(Function const & fn);
683 virtual void v_help(std::ostream & output) const;
684 virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const;
693 SimpleCommandNode & senf_console_add_node(DirectoryNode & node, std::string const & name,
694 SimpleCommandNode::Function fn, int);
700 #include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP()
702 BOOST_TYPEOF_REGISTER_TYPE(senf::console::DirectoryNode)
703 BOOST_TYPEOF_REGISTER_TYPE(senf::console::SimpleCommandNode)
706 ///////////////////////////////hh.e////////////////////////////////////////
716 // comment-column: 40
717 // c-file-style: "senf"
718 // indent-tabs-mode: nil
719 // ispell-local-dictionary: "american"
720 // compile-command: "scons -u test"