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