Console/ObjectDirectory.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 ObjectDirectory public header */
  25
  26 #ifndef HH_ObjectDirectory_
  27 #define HH_ObjectDirectory_ 1
  28
  29 // Custom includes
  30 #include <boost/utility.hpp>
  31 #include <boost/type_traits/is_convertible.hpp>
  32 #include "Node.hh"
  33
  34 //#include "ObjectDirectory.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace console {
  39
  40     /** \brief Internal: Node creation helper traits (ObjectDirectory proxy)
  41
  42         This class is used like NodeCreateTraits to customize the child node creation. This trait
  43         class is used however by the ObjectDirectory proxy.
  44      */
  45     template <class Owner, class Object>
  46     struct OwnerNodeCreateTraits
  47     {
  48         typedef BOOST_TYPEOF_TPL( senf_console_add_node(
  49                                       * static_cast<DirectoryNode *>(0),
  50                                       * static_cast<Owner *>(0),
  51                                       * static_cast<std::string const *>(0),
  52                                       * static_cast<Object const *>(0)) ) result_type;
  53
  54         typedef typename boost::remove_reference<result_type>::type NodeType;
  55
  56         /// Internal
  57         struct Creator {
  58             static NodeType & create(DirectoryNode & node, Owner & owner,
  59                                      std::string const & name, Object const & ob);
  60         };
  61     };
  62
  63     /** \brief Internal: Marker base class for all ObjectDirectory proxies
  64      */
  65     struct ObjectDirectoryBase {};
  66
  67     /** \brief DirectoryNode member proxy
  68
  69         ObjectDirectory is used whenever a class wants to manage it's own directory. The class
  70         allows to declare the directory as a public member object. This allows the user of the class
  71         to register the directory in the command tree. By using the proxy, the node is automatically
  72         detached from the tree (and thereby destroyed) when the object (and thereby the proxy) is
  73         destroyed.
  74
  75         \code
  76         class MyClass
  77         {
  78         public:
  79             ObjectDirectory<MyClass> configDir;
  80
  81             MyClass() : configDir(this)
  82             {
  83                 configDIr.add(...);
  84             }
  85         };
  86         \endcode
  87
  88         The ObjectDirectory proxy implements 'add()' to add new children to the proxied
  89         DirectoryNode. All add() variants supported by DirectoryNode are supported by
  90         ObjectDirectory.
  91
  92         \idea This proxy could be made obsolete by allowing to allocate node objects
  93             statically. This could be achieved by moving back to an intrusive_ptr implementation for
  94             normal pointing needs with an added twist: Give each node a smart_ptr member pointing to
  95             itself with a null deleter. This allows to create weak_ptr's to the nodes which will
  96             automatically expire when the node is deleted (either statically or by the
  97             intrusive_ptr).
  98
  99         \ingroup node_tree
 100       */
 101     template <class Owner>
 102     class ObjectDirectory : public ObjectDirectoryBase
 103     {
 104     public:
 105         ///////////////////////////////////////////////////////////////////////////
 106         // Types
 107
 108         typedef Owner owner;
 109
 110         ///////////////////////////////////////////////////////////////////////////
 111         ///\name Structors and default members
 112         ///@{
 113
 114         ObjectDirectory(Owner * owner);
 115         ~ObjectDirectory();
 116
 117         ///@}
 118         ///////////////////////////////////////////////////////////////////////////
 119
 120         template <class Object>
 121         typename OwnerNodeCreateTraits<Owner, Object>::NodeType & add(std::string const & name,
 122                                                                       Object const & ob);
 123                                         ///< Create new child node
 124                                         /**< Adds a new child node to the (proxied)
 125                                              DirectoryNode. How the node is added is configured
 126                                              using the OwnerNodeCreateTraits template. The default
 127                                              implementation just forwards the call to the proxied
 128                                              directory node. */
 129
 130         DirectoryNode & node() const;   ///< Access the proxied DirectoryNode
 131
 132         ///////////////////////////////////////////////////////////////////////////
 133         ///\name Proxied members (see DirectoryNode)
 134         ///\{
 135
 136         GenericNode::ptr remove(std::string const & name);
 137         DirectoryNode & operator[](std::string const & name) const;
 138         CommandNode & operator()(std::string const & name) const;
 139         GenericNode & get(std::string const & name) const;
 140         DirectoryNode & mkdir(std::string const & name);
 141         DirectoryNode::ChildrenRange children() const;
 142         DirectoryNode & doc(std::string const & doc);
 143
 144         ///\}
 145
 146     protected:
 147
 148     private:
 149         DirectoryNode::ptr node_;
 150         Owner * owner_;
 151     };
 152
 153 #ifndef DOXYGEN
 154     template <class Owner, class Function>
 155     SimpleCommandNode & senf_console_add_node(
 156         DirectoryNode & node, Owner & owner, std::string const & name, Function const & fn);
 157
 158     template <class Owner>
 159     SimpleCommandNode & senf_console_add_node(
 160         DirectoryNode & node, Owner & owner, std::string const & name,
 161         void (Owner::*fn)(std::ostream & output, CommandNode::Arguments const & arguments));
 162
 163     template <class Node>
 164     DirectoryNode & senf_console_add_node(
 165         DirectoryNode & dir, std::string const & name, Node const & node, int,
 166         typename boost::enable_if< boost::is_convertible<Node*, ObjectDirectoryBase*> >::type * = 0);
 167 #endif
 168
 169 }}
 170
 171 ///////////////////////////////hh.e////////////////////////////////////////
 172 //#include "ObjectDirectory.cci"
 173 //#include "ObjectDirectory.ct"
 174 #include "ObjectDirectory.cti"
 175 #endif
 176
 177 \f
 178 // Local Variables:
 179 // mode: c++
 180 // fill-column: 100
 181 // comment-column: 40
 182 // c-file-style: "senf"
 183 // indent-tabs-mode: nil
 184 // ispell-local-dictionary: "american"
 185 // compile-command: "scons -u test"
 186 // End: