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