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