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
104 senf::console::CommandNode is the base-class of all command nodes of which there are several,
105 depending on the type of command.
107 There is a single root node, the senf::console::DirectoryNode called senf::console::root(). From
108 this node, the tree is traversed.
110 All nodes are allocated on the heap and are managed using a smart pointer.
112 \subsection console_manipulate Manipulating the node tree
114 There are several ways to add nodes to the tree:
116 \li A senf::console::DirectoryNode can be added using senf::console::DirectoryNode::mkdir().
117 \li An arbitrary node can be created and then (possibly later) added to the tree using the
118 corresponding senf::console::DirectoryNode::add() overload.
119 \li A senf::console::CommandNode is normally added to the tree by directly adding a callback
120 using one of the overloaded senf::console::DirectoryNode::add() members. See \ref
123 When directly adding a node callback, the type of node added depends on the type of
124 callback. The callback types which can be added are listed at \ref console_callbacks.
127 void callback(std::ostream & os, senf::console::ParseCommandInfo const & command) { ... }
129 myDirectory.add("foo",&callback);
132 Every node is identified among it's siblings by it's name. The name of the node is set when
133 adding the node to the tree. If the name is empty or non-unique, a unique name will be
134 automatically provided.
136 To remove a node from the tree, just use the nodes senf::console::GenericNode::unlink() or the
137 parents senf::console::DirectoryNode::remove() member. This call removes the node from it's
138 parent and returns a (smart) node pointer.
140 \li If you ignore the return value, the node (and it's children) will be deleted.
141 \li Alternatively, you may store away the node and re-attach it later.
142 \li An node (or subtree) can be moved to a different place by unlinking the node at it's old
143 place and re-adding it at it's new location.
144 \li To rename a node, unlink and re-add it with a different name.
147 myDirectory.add("bar", myDirectory.remove("foo"));
150 \subsection console_node_param Assigning additional node parameters
152 Depending on the node type added, additional node parameters may be set. For example, every node
153 has a documentation parameter which is used by the online-help system. To assign these
154 parameters, the node exposes corresponding member functions. Since
155 senf::console::DirectoryNode::add() returns the newly added node by reference, additional
156 parameters may just be added to the end of the add command:
158 myDirectory.add("foo",&fooCallback).doc("The foo method");
160 Since the parameter setters all return the node reference, additional parameters may just be
161 added to the end of the command.
163 \subsection console_tree_traverse Traversing the tree
165 The simplest way to access tree elements is to save the return value of the
166 senf::console::DirectoryNode::add() members. However, saving the reference will not ensure, that
167 the node is not removed. If the node might be removed from the tree, you should use a smart
168 pointer (either <tt>ptr</tt> or <tt>weak_ptr</tt>) to hold the node.
170 Another possibility is to traverse the tree explicitly. For this purpose, the operators '[]' and
171 '()' have been overloaded in senf::console::DirectoryNode.
173 senf::console::root().getDirectory("myDirectory").getCommand("foo")
174 \\ or more concise but otherwise completely identical
175 senf::console::root()["myDirectory"]("foo")
178 getDirectory and the '[]' operator will return a senf::console::DirectoryNode whereas getCommand
179 and the '()' operator will return a senf::console::CommandNode. If the node is not found or is
180 not of the correct type, an exception will be raised.
182 \section console_object_dir Assigning a directory to an object instance
184 Most objects will register several commands. So it makes sense for these objects to manage their
185 own directory. Since directories are however allocated on the heap, they cannot be directly
186 added to a class. To facilitate this usage, the senf::console::ScopedDirectory is used. This
187 class provides a senf::console::DirectoryNode facade. Internally, it automatically creates a
188 senf::console::DirectoryNode to which all calls are forwarded.
190 The senf::console::ScopedDirectory member should be declared public. This allows the user of the
191 class to add the node to the tree.
199 #include <boost/shared_ptr.hpp>
200 #include <boost/weak_ptr.hpp>
201 #include <boost/enable_shared_from_this.hpp>
202 #include <boost/utility.hpp>
203 #include <boost/range/iterator_range.hpp>
204 #include <boost/typeof/typeof.hpp>
205 #include <boost/type_traits/remove_reference.hpp>
206 #include "../Utils/Exception.hh"
207 #include "../Utils/mpl.hh"
208 #include "../Utils/Logger/SenfLog.hh"
209 #include "../Utils/type_traits.hh"
212 //#include "Node.mpp"
213 ///////////////////////////////hh.p////////////////////////////////////////
222 DirectoryNode & root();
224 /** \brief Config/console node tree base-class
226 GenericNode is the base class of all node objects. There are two basic node types derived
227 from GenericNode: DirectoryNode and CommandNode.
229 All nodes are dynamically allocated and automatically managed using reference counting.
231 All nodes are normally linked into a single tree which root node is
232 senf::console::root(). Nodes may however be orphaned (not linked to the tree) either
233 directly (the node has no parent) or indirectly (the node has a parent but is part of an
234 orphaned subtree which is not linked to the root node).
236 Every active (non-orphaned) node (except the root() node) has a non-empty node name. This
237 name is assigned to the node when adding the node to the tree.
242 : public boost::enable_shared_from_this<GenericNode>
244 SENF_LOG_CLASS_AREA();
246 ///////////////////////////////////////////////////////////////////////////
249 typedef boost::shared_ptr<GenericNode> ptr;
250 typedef boost::shared_ptr<GenericNode const> cptr;
251 typedef boost::weak_ptr<GenericNode> weak_ptr;
253 ///////////////////////////////////////////////////////////////////////////
255 virtual ~GenericNode();
257 std::string const & name() const; ///< Node name
258 boost::shared_ptr<DirectoryNode> parent() const; ///< Parent node
259 /**< May be null, if the node is the root node or if it is
260 not linked to the tree */
262 std::string path() const; ///< Node path
263 /**< The node path is built by joining the names of all
264 parent nodes with '/' chars. */
265 std::string path(DirectoryNode const & root) const;
266 ///< Node path up to \a root
267 /**< The node path is built by joining the names of all
268 parent nodes up to \a root with '/' chars. */
270 ptr unlink(); ///< Remove node from it's parent directory
271 /**< You may either discard the return value and thereby
272 dispose the node or may re-attach the node at some
273 other place using DirectoryNode::add(). */
275 bool active() const; ///< \c true, if node is attached to the root() node
277 void help(std::ostream & output) const; /// Write help info to \a output
279 ptr thisptr(); ///< Get smart pointer to node
280 cptr thisptr() const; ///< Get smart pointer to node (const)
282 bool isChildOf(DirectoryNode & parent) const;
283 ///< \c true, if node is a child of \a parent
284 /**< Will also return \c true, if \a parent is the current
287 bool operator== (GenericNode & other) const;
288 /// \c true, if this and \a other are the same node
289 bool operator!= (GenericNode & other) const;
290 /// \c true, if this and \a other are different nodes
292 bool isDirectory() const; ///< \c true, if this is a drectory node
293 bool isLink() const; ///< \c true, if this is a link node
294 bool isCommand() const; ///< \c true, if this is a command node
299 void name(std::string const & name);
306 virtual void v_help(std::ostream & output) const = 0;
307 ///< Provide help information
308 /**< This member must be implemented in derived classes
309 to provide node specific help information. */
313 DirectoryNode * parent_;
315 friend class DirectoryNode;
318 /** \brief Config/console tree link node
320 A LinkNode references another node and provides an additional alias name for that node. A
321 LinkNode works like a mixture of UNIX symlinks and hardlinks: It is an explicit link like a
322 UNIX symlink but references another node directly (not via it's path) like a UNIX
323 hardlink. Therefore, a LinkNode works across chroot().
329 ///////////////////////////////////////////////////////////////////////////
332 typedef boost::shared_ptr<LinkNode> ptr;
333 typedef boost::shared_ptr<LinkNode const> cptr;
334 typedef boost::weak_ptr<LinkNode> weak_ptr;
336 ///////////////////////////////////////////////////////////////////////////
337 ///\name Structors and default members
340 static ptr create(GenericNode & node); ///< Create new link node.
341 /**< You should normally use DirectoryNode::link() to
342 create a link node. */
345 ///////////////////////////////////////////////////////////////////////////
347 GenericNode & follow() const; ///< Access the referenced node
352 explicit LinkNode(GenericNode & node);
354 virtual void v_help(std::ostream &) const;
356 GenericNode::ptr node_;
359 class SimpleCommandNode;
361 /** \brief Internal: Node creation helper traits
363 This class is used internally to find out the type of node to create for a specific argument
366 template <class Object>
367 struct NodeCreateTraits
369 typedef BOOST_TYPEOF_TPL( senf_console_add_node(
370 * static_cast<DirectoryNode *>(0),
371 * static_cast<std::string const *>(0),
372 * static_cast<Object *>(0),
374 typedef typename senf::remove_cvref<base_type>::type value_type;
376 typedef typename value_type::node_type NodeType;
377 typedef typename value_type::return_type result_type;
381 static result_type create(DirectoryNode & node, std::string const & name,
386 /** \brief Config/console tree directory node
388 This node type provides the internal and root nodes of the tree. It allows to add arbitrary
389 children and supports directory traversal.
391 Nodes are normally not instantiated manually but are created by the DirectoryNode via
392 mkdir() or add(). Special add() members however allow externally allocated node objects.
394 Nodes may be added to the tree only once, otherwise chaos will ensue. Since nodes are always
395 managed dynamically, there is a special ScopedDirectory proxy template which provides a
396 DirectoryNode facade. ScopedDirectory is used if a class wants to manage it's own directory
399 Every node is assigned a (new) name when it is added to a directory. If the directory
400 already has an entry of that name, the name is made unique by appending a suffix of the form
401 '-n' where n is a number starting at 1. If the name is empty, int is set to 'unnamed' and
402 then uniquified as above. Automatically providing unique names simplifies adding
403 configuration/console support to generic components.
407 class DirectoryNode : public GenericNode
409 SENF_LOG_CLASS_AREA();
410 typedef std::map<std::string, GenericNode::ptr> ChildMap;
412 ///////////////////////////////////////////////////////////////////////////
415 typedef boost::shared_ptr<DirectoryNode> ptr;
416 typedef boost::shared_ptr<DirectoryNode const> cptr;
417 typedef boost::weak_ptr<DirectoryNode> weak_ptr;
419 typedef boost::iterator_range<ChildMap::const_iterator> ChildrenRange;
420 typedef ChildMap::const_iterator child_iterator;
422 typedef DirectoryNode node_type;
423 typedef DirectoryNode & return_type;
425 ///////////////////////////////////////////////////////////////////////////
426 ///\name Structors and default members
429 static ptr create(); ///< Create node object.
430 /**< You should normally use either mkdir() or
431 ScopedDirectory instead of create() */
434 ///////////////////////////////////////////////////////////////////////////
438 template <class NodeType>
439 NodeType & add(std::string const & name, boost::shared_ptr<NodeType> node);
440 ///< Add node to tree
441 /**< Adds the \a node to the tree as a child of \a this
442 node. The node is given the name \a name. If a node of
443 that name already exists, a numeric suffix of the form
444 '-n' is added to the name until the name is unique. If
445 \a name is empty, it is set to 'unnamed'. */
447 template <class Object>
448 typename NodeCreateTraits<Object>::result_type add(std::string const & name,
450 ///< Generic child node factory
451 /**< This member is used to create a new child node of the
452 current directory. The type of node created depends on
453 the type of argument passed.
455 The node type is selected by the NodeCreateTraits
456 class. To allow adding a specific node type, you need
457 to provide an overload for
458 <tt>senf_console_add_node</tt> which must be visible at
459 when you register the new node.
461 MyNodeType & senf_console_add_node(
463 std::string const & name,
464 MySpecialObject const & ob,
467 return dir.add(name, MyNodeType::create(ob));
470 (Do not forget the last unnamed 'int' parameter which
471 is not used but serves to disambiguate the
474 template <class Object>
475 typename NodeCreateTraits<Object>::result_type add(std::string const & name,
477 ///< Generic child node factory
480 GenericNode::ptr remove(std::string const & name);
481 ///< Remove node \a name from the tree
482 /**< The returned pointer may either be discarded, which
483 will automatically dispose the removed node, or it may
484 be saved and/or re-attached at some other place in the
487 bool hasChild(std::string const & name) const;
488 ///< \c true, if there is a child with name \a name
490 GenericNode & get(std::string const & name) const;
492 /**< \throws UnknownNodeNameException if a child \a name
494 GenericNode & getLink(std::string const & name) const;
495 ///< Get child node without dereferencing links
496 /**< \throws UnknownNodeNameException if a child \a name
499 DirectoryNode & getDirectory(std::string const & name) const;
500 ///< Get directory child node
501 /**< Same as operator[]
502 \throws UnknownNodeNameException if a child \a name
504 \throws std::bad_cast if the child \a name is not a
507 DirectoryNode & operator[](std::string const & name) const;
508 ///< Get directory child node
509 /**< Same as getDirectory
510 \throws UnknownNodeNameException if a child \a name
512 \throws std::bad_cast if the child \a name is not a
515 CommandNode & getCommand(std::string const & name) const;
516 ///< Get command child node
517 /**< Same as operator()
518 \throws UnknownNodeNameException if a child \a name
520 \throws std::bad_cast if the child \a name is not a
523 CommandNode & operator()(std::string const & name) const;
524 ///< Get command child node
525 /**< Same as getCommand()
526 \throws UnknownNodeNameException if a child \a name
528 \throws std::bad_cast if the child \a name is not a
531 DirectoryNode & mkdir(std::string const & name);
532 ///< Create sub-directory node
534 ChildrenRange children() const; ///< Return iterator range over all children.
535 /**< The returned range is sorted by child name. */
537 ChildrenRange completions(std::string const & s) const;
538 ///< Return iterator range of completions for \a s
539 /**< The returned range is sorted by child name. */
541 void link(std::string const & name, GenericNode & target);
544 ///////////////////////////////////////////////////////////////////////////
546 DirectoryNode & doc(std::string const & doc); ///< Set node documentation
549 cptr thisptr() const;
555 void add(GenericNode::ptr node);
556 virtual void v_help(std::ostream & output) const;
561 friend DirectoryNode & root();
564 /// Exception: Unknown node name
565 struct UnknownNodeNameException : public senf::Exception
566 { UnknownNodeNameException() : senf::Exception("Unknown node name") {}};
569 template <class Type>
570 struct NodeCreateTraits< boost::shared_ptr<Type> >
574 /** \brief Config/console tree command node
576 The CommandNode is the base-class for the tree leaf nodes. Concrete command node
577 implementations are derived from this class.
579 To execute a command, CommandNode::operator()() or CommandNode::execute() is called.
581 Subclass instances of this node type are automatically created when adding commands to the
582 tree. See \ref console_commands.
586 class CommandNode : public GenericNode
588 SENF_LOG_CLASS_AREA();
590 ///////////////////////////////////////////////////////////////////////////
593 typedef boost::shared_ptr<CommandNode> ptr;
594 typedef boost::shared_ptr<CommandNode const> cptr;
595 typedef boost::weak_ptr<CommandNode> weak_ptr;
597 ///////////////////////////////////////////////////////////////////////////
599 void execute(std::ostream & output, ParseCommandInfo const & command) const;
600 ///< Execute the command
601 /**< Same as operator()()
602 \param[in] output stream where result messages may be
604 \param[in] arguments command arguments. This is a
605 range of ranges of Token instances. */
607 void operator()(std::ostream & output, ParseCommandInfo const & command) const;
608 ///< Execute the command
609 /**< Same as execute()
610 \param[in] output stream where result messages may be
612 \param[in] arguments command arguments. This is a
613 range of ranges of Token instances. */
616 cptr thisptr() const;
624 virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const = 0;
625 ///< Called to execute the command
626 /**< \param[in] output stream where result messages may be
628 \param[in] arguments command arguments. This is a
629 range of ranges of Token instances. */
634 /** \brief Most simple CommandNode implementation
636 This CommandNode implementation simply forwards the \a output and \a arguments arguments to
637 an arbitrary callback. Thus, it allows to add callbacks with the signature
639 void callback(std::ostream & os, senf::console::ParseCommandInfo const & command)
644 \ingroup console_commands
646 class SimpleCommandNode : public CommandNode
648 SENF_LOG_CLASS_AREA();
650 ///////////////////////////////////////////////////////////////////////////
653 typedef boost::shared_ptr<SimpleCommandNode> ptr;
654 typedef boost::shared_ptr<SimpleCommandNode const> cptr;
655 typedef boost::weak_ptr<SimpleCommandNode> weak_ptr;
657 typedef boost::function<void (std::ostream &, ParseCommandInfo const &)> Function;
659 typedef SimpleCommandNode node_type;
660 typedef SimpleCommandNode & return_type;
662 ///////////////////////////////////////////////////////////////////////////
663 ///\name Structors and default members
666 static ptr create(Function const & fn);
669 ///////////////////////////////////////////////////////////////////////////
672 cptr thisptr() const;
674 SimpleCommandNode & doc(std::string const & doc);
677 SimpleCommandNode(Function const & fn);
680 virtual void v_help(std::ostream & output) const;
681 virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const;
690 SimpleCommandNode & senf_console_add_node(DirectoryNode & node, std::string const & name,
691 SimpleCommandNode::Function fn, int);
697 #include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP()
699 BOOST_TYPEOF_REGISTER_TYPE(senf::console::DirectoryNode)
700 BOOST_TYPEOF_REGISTER_TYPE(senf::console::SimpleCommandNode)
703 ///////////////////////////////hh.e////////////////////////////////////////
713 // comment-column: 40
714 // c-file-style: "senf"
715 // indent-tabs-mode: nil
716 // ispell-local-dictionary: "american"
717 // compile-command: "scons -u test"