Console/Node.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   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.
  12 //
  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.
  17 //
  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.
  22
  23 /** \file
  24     \brief Node public header */
  25
  26 /** \defgroup node_tree The console/config file-system node tree
  27
  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
  30     interface.
  31
  32     \autotoc
  33
  34     \section console_tree The tree
  35
  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.
  38
  39     \code
  40     // Define callback function.
  41     void mycommand(std::ostream & os, senf::console::ParseCommandInfo const & command)
  42     {
  43         // ...
  44         os << "!! Important message ...\n";
  45     }
  46
  47     class SomeClass
  48     {
  49     public:
  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;
  53
  54         SomeClass() : dir(this)
  55         {
  56             // You may document the directory here or later when adding it to the tree
  57             dir.doc("Manager for something");
  58
  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");
  62         }
  63
  64         void member(std::ostream & os, senf::console::ParseCommandInfo const & command)
  65         {
  66             // ...
  67         }
  68     };
  69
  70     int main(int, char**)
  71     {
  72         // Provide global documentation
  73         senf::console::root()
  74             .doc("This is someServer server");
  75
  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 (
  79                 .mkdir("myserver")
  80                 .doc("My server specific directory"));
  81
  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");
  86
  87         // Create a SomeClass instance and add it's directory.
  88         SomeClass someClass;
  89         mydir.add("someClass", someClass.dir);
  90
  91         // Start the interactive console server
  92         senf::console::Server::start(senf::INet4SocketAddress(senf::INet4Address::None, 23232u))
  93             .name("someServer");
  94     }
  95     \endcode
  96
  97     \subsection console_nodes Node types
  98
  99     The console/config library tree consists of two basic node types:
 100
 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
 104     senf::console::CommandNode is the base-class of all command nodes of which there are several,
 105     depending on the type of command.
 106
 107     There is a single root node, the senf::console::DirectoryNode called senf::console::root(). From
 108     this node, the tree is traversed.
 109
 110     All nodes are allocated on the heap and are managed using a smart pointer.
 111
 112     \subsection console_manipulate Manipulating the node tree
 113
 114     There are several ways to add nodes to the tree:
 115
 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.
 121
 122     When directly adding a node callback, the type of node added depends on the type of
 123     callback. The callback types which can be added are listed at \ref console_callbacks.
 124
 125     \code
 126     void callback(std::ostream & os, senf::console::ParseCommandInfo const & command) { ... }
 127     // ...
 128     myDirectory.add("foo",&callback);
 129     \endcode
 130
 131     Every node is identified among it's siblings by it's name. The name of the node is set when
 132     adding the node to the tree. If the name is empty or non-unique, a unique name will be
 133     automatically provided.
 134
 135     To remove a node from the tree, just use the nodes senf::console::GenericNode::unlink() or the
 136     parents senf::console::DirectoryNode::remove() member. This call removes the node from it's
 137     parent and returns a (smart) node pointer.
 138
 139     \li If you ignore the return value, the node (and it's children) will be deleted.
 140     \li Alternatively, you may store away the node and re-attach it later.
 141     \li An node (or subtree) can be moved to a different place by unlinking the node at it's old
 142         place and re-adding it at it's new location.
 143     \li To rename a node, unlink and re-add it with a different name.
 144
 145     \code
 146     myDirectory.add("bar", myDirectory.remove("foo"));
 147     \endcode
 148
 149     \subsection console_node_param Assigning additional node parameters
 150
 151     Depending on the node type added, additional node parameters may be set. For example, every node
 152     has a documentation parameter which is used by the online-help system. To assign these
 153     parameters, the node exposes corresponding member functions. Since
 154     senf::console::DirectoryNode::add() returns the newly added node by reference, additional
 155     parameters may just be added to the end of the add command:
 156     \code
 157     myDirectory.add("foo",&fooCallback).doc("The foo method");
 158     \endcode
 159     Since the parameter setters all return the node reference, additional parameters may just be
 160     added to the end of the command.
 161
 162     \subsection console_tree_traverse Traversing the tree
 163
 164     The simplest way to access tree elements is to save the return value of the
 165     senf::console::DirectoryNode::add() members. However, saving the reference will not ensure, that
 166     the node is not removed. If the node might be removed from the tree, you should use a smart
 167     pointer (either <tt>ptr</tt> or <tt>weak_ptr</tt>) to hold the node.
 168
 169     Another possibility is to traverse the tree explicitly. For this purpose, the operators '[]' and
 170     '()' have been overloaded in senf::console::DirectoryNode.
 171     \code
 172     senf::console::root().getDirectory("myDirectory").getCommand("foo")
 173     \\ or more concise but otherwise completely identical
 174     senf::console::root()["myDirectory"]("foo")
 175     \endcode
 176
 177     getDirectory and the '[]' operator will return a senf::console::DirectoryNode whereas getCommand
 178     and the '()' operator will return a senf::console::CommandNode. If the node is not found or is
 179     not of the correct type, an exception will be raised.
 180
 181     \section console_object_dir Assigning a directory to an object instance
 182
 183     Most objects will register several commands. So it makes sense for these objects to manage their
 184     own directory. Since directories are however allocated on the heap, they cannot be directly
 185     added to a class. To facilitate this usage, the senf::console::ScopedDirectory is used. This
 186     class provides a senf::console::DirectoryNode facade. Internally, it automatically creates a
 187     senf::console::DirectoryNode to which all calls are forwarded.
 188
 189     The senf::console::ScopedDirectory member should be declared public. This allows the user of the
 190     class to add the node to the tree.
 191  */
 192
 193 #ifndef HH_Node_
 194 #define HH_Node_ 1
 195
 196 // Custom includes
 197 #include <map>
 198 #include <boost/shared_ptr.hpp>
 199 #include <boost/weak_ptr.hpp>
 200 #include <boost/enable_shared_from_this.hpp>
 201 #include <boost/utility.hpp>
 202 #include <boost/range/iterator_range.hpp>
 203 #include <boost/typeof/typeof.hpp>
 204 #include <boost/type_traits/remove_reference.hpp>
 205 #include "../Utils/Exception.hh"
 206 #include "../Utils/mpl.hh"
 207 #include "../Utils/Logger/SenfLog.hh"
 208 #include "Parse.hh"
 209
 210 //#include "Node.mpp"
 211 ///////////////////////////////hh.p////////////////////////////////////////
 212
 213 namespace senf {
 214 namespace console {
 215
 216     class DirectoryNode;
 217     class CommandNode;
 218
 219     /** \brief Config/console node tree base-class
 220
 221         GenericNode is the base class of all node objects. There are two basic node types derived
 222         from GenericNode:  DirectoryNode and CommandNode.
 223
 224         All nodes are dynamically allocated and automatically managed using reference counting.
 225
 226         All nodes are normally linked into a single tree which root node is
 227         senf::console::root(). Nodes may however be orphaned (not linked to the tree) either
 228         directly (the node has no parent) or indirectly (the node has a parent but is part of an
 229         orphaned subtree which is not linked to the root node).
 230
 231         Every active (non-orphaned) node (except the root() node) has a non-empty node name. This
 232         name is assigned to the node when adding the node to the tree.
 233
 234         \ingroup node_tree
 235       */
 236     class GenericNode
 237         : public boost::enable_shared_from_this<GenericNode>
 238     {
 239         SENF_LOG_CLASS_AREA();
 240     public:
 241         ///////////////////////////////////////////////////////////////////////////
 242         // Types
 243
 244         typedef boost::shared_ptr<GenericNode> ptr;
 245         typedef boost::shared_ptr<GenericNode const> cptr;
 246         typedef boost::weak_ptr<GenericNode> weak_ptr;
 247
 248         ///////////////////////////////////////////////////////////////////////////
 249
 250         virtual ~GenericNode();
 251
 252         std::string const & name() const; ///< Node name
 253         boost::shared_ptr<DirectoryNode> parent() const; ///< Parent node
 254                                         /**< May be null, if the node is the root node or if it is
 255                                              not linked to the tree */
 256
 257         std::string path() const;       ///< Node path
 258                                         /**< The node path is built by joining the names of all
 259                                              parent nodes with '/' chars. */
 260
 261         ptr unlink();                   ///< Remove node from it's parent directory
 262                                         /**< You may either discard the return value and thereby
 263                                              dispose the node or may re-attach the node at some
 264                                              other place using DirectoryNode::add(). */
 265
 266         bool active() const;            ///< \c true, if node is attached to the root() node
 267
 268         void help(std::ostream & output) const; /// Write help info to \a output
 269
 270         ptr thisptr();                  ///< Get smart pointer to node
 271         cptr thisptr() const;           ///< Get smart pointer to node (const)
 272
 273     protected:
 274         GenericNode();
 275
 276         void name(std::string const & name);
 277
 278 #ifndef DOXYGEN
 279     private:
 280 #else
 281     public:
 282 #endif
 283         virtual void v_help(std::ostream & output) const = 0;
 284                                         ///< Provide help information
 285                                         /**< This member must be implemented in derived classes
 286                                              to provide node specific help information. */
 287
 288     private:
 289         std::string name_;
 290         DirectoryNode * parent_;
 291
 292         friend class DirectoryNode;
 293     };
 294
 295     class SimpleCommandNode;
 296
 297     /** \brief Internal: Node creation helper traits
 298
 299         This class is used internally to find out the type of node to create for a specific argument
 300         type.
 301      */
 302     template <class Object>
 303     struct NodeCreateTraits
 304     {
 305         typedef BOOST_TYPEOF_TPL( senf_console_add_node(
 306                                       * static_cast<DirectoryNode *>(0),
 307                                       * static_cast<std::string const *>(0),
 308                                       * static_cast<Object const *>(0),
 309                                       0) ) result_type;
 310
 311         typedef typename boost::remove_reference<result_type>::type NodeType;
 312
 313         /// Internal
 314         struct Creator {
 315             static NodeType & create(DirectoryNode & node, std::string const & name,
 316                                      Object const & ob);
 317         };
 318     };
 319
 320     /** \brief Config/console tree directory node
 321
 322         This node type provides the internal and root nodes of the tree. It allows to add arbitrary
 323         children and supports directory traversal.
 324
 325         Nodes are normally not instantiated manually but are created by the DirectoryNode via
 326         mkdir() or add(). Special add() members however allow externally allocated node objects.
 327
 328         Nodes may be added to the tree only once, otherwise chaos will ensue. Since nodes are always
 329         managed dynamically, there is a special ScopedDirectory proxy template which provides a
 330         DirectoryNode facade. ScopedDirectory is used if a class wants to manage it's own directory
 331         as a data member.
 332
 333         Every node is assigned a (new) name when it is added to a directory. If the directory
 334         already has an entry of that name, the name is made unique by appending a suffix of the form
 335         '-n' where n is a number starting at 1. If the name is empty, int is set to 'unnamed' and
 336         then uniquified as above. Automatically providing unique names simplifies adding
 337         configuration/console support to generic components.
 338
 339         \ingroup node_tree
 340       */
 341     class DirectoryNode : public GenericNode
 342     {
 343         SENF_LOG_CLASS_AREA();
 344         typedef std::map<std::string, GenericNode::ptr> ChildMap;
 345     public:
 346         ///////////////////////////////////////////////////////////////////////////
 347         // Types
 348
 349         typedef boost::shared_ptr<DirectoryNode> ptr;
 350         typedef boost::shared_ptr<DirectoryNode const> cptr;
 351         typedef boost::weak_ptr<DirectoryNode> weak_ptr;
 352
 353         typedef boost::iterator_range<ChildMap::const_iterator> ChildrenRange;
 354         typedef ChildMap::const_iterator child_iterator;
 355
 356         ///////////////////////////////////////////////////////////////////////////
 357         ///\name Structors and default members
 358         ///\{
 359
 360         static ptr create();            ///< Create node object.
 361                                         /**< You should normally use either mkdir() or
 362                                              ScopedDirectory instead of create() */
 363
 364         ///\}
 365         ///////////////////////////////////////////////////////////////////////////
 366         ///\name Children
 367         ///\{
 368
 369         template <class NodeType>
 370         NodeType & add(std::string const & name, boost::shared_ptr<NodeType> node);
 371                                         ///< Add node to tree
 372                                         /**< Adds the \a node to the tree as a child of \a this
 373                                              node. The node is given the name \a name. If a node of
 374                                              that name already exists, a numeric suffix of the form
 375                                              '-n' is added to the name until the name is unique. If
 376                                              \a name is empty, it is set to 'unnamed'. */
 377
 378         template <class Object>
 379         typename NodeCreateTraits<Object>::NodeType & add (std::string const & name,
 380                                                            Object const & ob);
 381                                         ///< Generic child node factory
 382                                         /**< This member is used to create a new child node of the
 383                                              current directory. The type of node created depends on
 384                                              the type of argument passed.
 385
 386                                              The node type is selected by the NodeCreateTraits
 387                                              class. To allow adding a specific node type, you need
 388                                              to provide an overload for
 389                                              <tt>senf_console_add_node</tt> which must be visible at
 390                                              when you register the new node.
 391                                              \code
 392                                              MyNodeType & senf_console_add_node(
 393                                                  DirectoryNode & dir,
 394                                                  std::string const & name,
 395                                                  MySpecialObject const & ob,
 396                                                  int)
 397                                              {
 398                                                  return dir.add(name, MyNodeType::create(ob));
 399                                              }
 400                                              \endcode
 401                                              (Do not forget the last unnamed 'int' parameter which
 402                                              is not used but serves to disambiguate the
 403                                              overloads). */
 404
 405         GenericNode::ptr remove(std::string const & name);
 406                                         ///< Remove node \a name from the tree
 407                                         /**< The returned pointer may either be discarded, which
 408                                              will automatically dispose the removed node, or it may
 409                                              be saved and/or re-attached at some other place in the
 410                                              tree. */
 411
 412         bool hasChild(std::string const & name) const;
 413                                         ///< \c true, if there is a child with name \a name
 414
 415         GenericNode & get(std::string const & name) const;
 416                                         ///< Get child node
 417                                         /**< \throws UnknownNodeNameException if a child \a name
 418                                                  does not exist */
 419
 420         DirectoryNode & getDirectory(std::string const & name) const;
 421                                         ///< Get directory child node
 422                                         /**< Same as operator[]
 423                                              \throws UnknownNodeNameException if a child \a name
 424                                                  does not exist.
 425                                              \throws std::bad_cast if the child \a name is not a
 426                                                  directory node. */
 427
 428         DirectoryNode & operator[](std::string const & name) const;
 429                                         ///< Get directory child node
 430                                         /**< Same as getDirectory
 431                                              \throws UnknownNodeNameException if a child \a name
 432                                                  does not exist.
 433                                              \throws std::bad_cast if the child \a name is not a
 434                                                  directory node. */
 435
 436         CommandNode & getCommand(std::string const & name) const;
 437                                         ///< Get command child node
 438                                         /**< Same as operator()
 439                                              \throws UnknownNodeNameException if a child \a name
 440                                                  does not exist
 441                                              \throws std::bad_cast if the child \a name is not a
 442                                                  command node. */
 443
 444         CommandNode & operator()(std::string const & name) const;
 445                                         ///< Get command child node
 446                                         /**< Same as getCommand()
 447                                              \throws UnknownNodeNameException if a child \a name
 448                                                  does not exist
 449                                              \throws std::bad_cast if the child \a name is not a
 450                                                  command node. */
 451
 452         DirectoryNode & mkdir(std::string const & name);
 453                                         ///< Create sub-directory node
 454
 455         ChildrenRange children() const;
 456                                         ///< Return iterator range over all children.
 457                                         /**< The returned range is sorted by child name. */
 458
 459         ///\}
 460         ///////////////////////////////////////////////////////////////////////////
 461
 462         template <class ForwardRange>
 463         GenericNode & traverse(ForwardRange const & range);
 464                                         ///< Traverse node path starting at this node
 465                                         /**< The <tt>ForwardRange::value_type</tt> must be
 466                                              (convertible to) std::string. Each range element
 467                                              constitutes a step along the node traversal.
 468
 469                                              If the range starts with an empty element, the
 470                                              traversal is started at the root() node, otherwise it
 471                                              is started at \a this node. The traversal supports '.',
 472                                              '..' and ignores further empty elements. */
 473
 474         DirectoryNode & doc(std::string const & doc);
 475                                         ///< Set node documentation
 476
 477         ptr thisptr();
 478         cptr thisptr() const;
 479
 480     protected:
 481         DirectoryNode();
 482
 483     private:
 484         void add(GenericNode::ptr node);
 485         virtual void v_help(std::ostream & output) const;
 486
 487         ChildMap children_;
 488         std::string doc_;
 489
 490         friend DirectoryNode & root();
 491     };
 492
 493     /// Exception: Unknown node name
 494     struct UnknownNodeNameException : public senf::Exception
 495     { UnknownNodeNameException() : senf::Exception("Unknown node name") {}};
 496
 497 #ifndef DOXYGEN
 498     template <class Type>
 499     struct NodeCreateTraits< boost::shared_ptr<Type> >
 500     {};
 501 #endif
 502
 503     struct SyntaxErrorException : public senf::Exception
 504     {
 505         explicit SyntaxErrorException(std::string const & msg = "");
 506
 507         virtual char const * what() const throw();
 508     };
 509
 510     /** \brief Config/console tree command node
 511
 512         The CommandNode is the base-class for the tree leaf nodes. Concrete command node
 513         implementations are derived from this class.
 514
 515         To execute a command, CommandNode::operator()() or CommandNode::execute() is called.
 516
 517         \ingroup node_tree
 518       */
 519     class CommandNode : public GenericNode
 520     {
 521         SENF_LOG_CLASS_AREA();
 522     public:
 523         ///////////////////////////////////////////////////////////////////////////
 524         // Types
 525
 526         typedef boost::shared_ptr<CommandNode> ptr;
 527         typedef boost::shared_ptr<CommandNode const> cptr;
 528         typedef boost::weak_ptr<CommandNode> weak_ptr;
 529
 530         ///////////////////////////////////////////////////////////////////////////
 531
 532         void execute(std::ostream & output, ParseCommandInfo const & command) const;
 533                                         ///< Execute the command
 534                                         /**< Same as operator()()
 535                                              \param[in] output stream where result messages may be
 536                                                  written to
 537                                              \param[in] arguments command arguments. This is a
 538                                                  range of ranges of ArgumentToken instances. */
 539
 540         void operator()(std::ostream & output, ParseCommandInfo const & command) const;
 541                                         ///< Execute the command
 542                                         /**< Same as execute()
 543                                              \param[in] output stream where result messages may be
 544                                                  written to
 545                                              \param[in] arguments command arguments. This is a
 546                                                  range of ranges of ArgumentToken instances. */
 547
 548         ptr thisptr();
 549         cptr thisptr() const;
 550
 551     protected:
 552         CommandNode();
 553
 554 #ifndef DOXYGEN
 555     private:
 556 #endif
 557         virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const = 0;
 558                                         ///< Called to execute the command
 559                                         /**< \param[in] output stream where result messages may be
 560                                                  written to
 561                                              \param[in] arguments command arguments. This is a
 562                                                  range of ranges of ArgumentToken instances. */
 563
 564     private:
 565     };
 566
 567     /** \brief Most simple CommandNode implementation
 568
 569         This CommandNode implementation simply forwards the \a output and \a arguments arguments to
 570         an arbitrary callback.
 571
 572         \ingroup node_tree
 573      */
 574     class SimpleCommandNode : public CommandNode
 575     {
 576         SENF_LOG_CLASS_AREA();
 577     public:
 578         ///////////////////////////////////////////////////////////////////////////
 579         // Types
 580
 581         typedef boost::shared_ptr<SimpleCommandNode> ptr;
 582         typedef boost::shared_ptr<SimpleCommandNode const> cptr;
 583         typedef boost::weak_ptr<SimpleCommandNode> weak_ptr;
 584
 585         typedef boost::function<void (std::ostream &, ParseCommandInfo const &)> Function;
 586
 587         ///////////////////////////////////////////////////////////////////////////
 588         ///\name Structors and default members
 589         ///\{
 590
 591         static ptr create(Function const & fn);
 592
 593         ///\}
 594         ///////////////////////////////////////////////////////////////////////////
 595
 596         ptr thisptr();
 597         cptr thisptr() const;
 598
 599         SimpleCommandNode & doc(std::string const & doc);
 600
 601     protected:
 602         SimpleCommandNode(Function const & fn);
 603
 604     private:
 605         virtual void v_help(std::ostream & output) const;
 606         virtual void v_execute(std::ostream & output, ParseCommandInfo const & command) const;
 607
 608
 609         Function fn_;
 610         std::string doc_;
 611     };
 612
 613 #ifndef DOXYGEN
 614     template <class Function>
 615     SimpleCommandNode & senf_console_add_node(DirectoryNode & node, std::string const & name,
 616                                               Function const & fn, ...);
 617 #endif
 618
 619     DirectoryNode & root();
 620
 621 }}
 622
 623 #include BOOST_TYPEOF_INCREMENT_REGISTRATION_GROUP()
 624
 625 BOOST_TYPEOF_REGISTER_TYPE(senf::console::DirectoryNode)
 626 BOOST_TYPEOF_REGISTER_TYPE(senf::console::SimpleCommandNode)
 627
 628
 629 ///////////////////////////////hh.e////////////////////////////////////////
 630 #include "Node.cci"
 631 #include "Node.ct"
 632 #include "Node.cti"
 633 #endif
 634
 635 \f
 636 // Local Variables:
 637 // mode: c++
 638 // fill-column: 100
 639 // comment-column: 40
 640 // c-file-style: "senf"
 641 // indent-tabs-mode: nil
 642 // ispell-local-dictionary: "american"
 643 // compile-command: "scons -u test"
 644 // End: