4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief ScopedDirectory public header */
26 #ifndef HH_ScopedDirectory_
27 #define HH_ScopedDirectory_ 1
30 #include <boost/utility.hpp>
31 #include <boost/type_traits/is_convertible.hpp>
34 //#include "ScopedDirectory.mpp"
35 ///////////////////////////////hh.p////////////////////////////////////////
40 /** \brief Internal: Node creation helper traits (ScopedDirectory proxy)
42 This class is used like NodeCreateTraits to customize the child node creation. This trait
43 class is used however by the ScopedDirectory proxy.
45 template <class Owner, class Object>
46 struct OwnerNodeCreateTraits
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;
54 typedef typename boost::remove_reference<result_type>::type NodeType;
58 static NodeType & create(DirectoryNode & node, Owner & owner,
59 std::string const & name, Object const & ob);
63 /** \brief Internal: Marker base class for all ScopedDirectory proxies
65 class ScopedDirectoryBase
68 DirectoryNode & node() const; ///< Access the proxied DirectoryNode
70 ///////////////////////////////////////////////////////////////////////////
71 ///\name Proxied members (see DirectoryNode)
74 GenericNode::ptr remove(std::string const & name);
75 DirectoryNode & getDirectory(std::string const & name) const;
76 DirectoryNode & operator[](std::string const & name) const;
77 CommandNode & getCommand(std::string const & name) const;
78 CommandNode & operator()(std::string const & name) const;
79 GenericNode & get(std::string const & name) const;
80 DirectoryNode & mkdir(std::string const & name);
81 DirectoryNode::ChildrenRange children() const;
82 DirectoryNode & doc(std::string const & doc);
87 ScopedDirectoryBase();
88 ~ScopedDirectoryBase();
91 DirectoryNode::ptr node_;
94 /** \brief DirectoryNode member proxy
96 ScopedDirectory is used whenever a class wants to manage it's own directory. The class
97 allows to declare the directory as a public member object. This allows the user of the class
98 to register the directory in the command tree. By using the proxy, the node is automatically
99 detached from the tree (and thereby destroyed) when the object (and thereby the proxy) is
106 ScopedDirectory<MyClass> configDir;
108 MyClass() : configDir(this)
115 The ScopedDirectory proxy implements 'add()' to add new children to the proxied
116 DirectoryNode. All add() variants supported by DirectoryNode are supported by
119 \idea This proxy could be made obsolete by allowing to allocate node objects
120 statically. This could be achieved by moving back to an intrusive_ptr implementation for
121 normal pointing needs with an added twist: Give each node a smart_ptr member pointing to
122 itself with a null deleter. This allows to create weak_ptr's to the nodes which will
123 automatically expire when the node is deleted (either statically or by the
128 template <class Owner=void>
129 class ScopedDirectory : public ScopedDirectoryBase
132 ///////////////////////////////////////////////////////////////////////////
137 ///////////////////////////////////////////////////////////////////////////
138 ///\name Structors and default members
141 ScopedDirectory(Owner * owner);
144 ///////////////////////////////////////////////////////////////////////////
146 template <class Object>
147 typename OwnerNodeCreateTraits<Owner, Object>::NodeType & add(std::string const & name,
149 ///< Create new child node
150 /**< Adds a new child node to the (proxied)
151 DirectoryNode. How the node is added is configured
152 using the OwnerNodeCreateTraits template. The default
153 implementation just forwards the call to the proxied
163 class ScopedDirectory<void> : public ScopedDirectoryBase
166 template <class Object>
167 typename NodeCreateTraits<Object>::NodeType & add(std::string const & name,
172 template <class Owner, class Function>
173 SimpleCommandNode & senf_console_add_node(
174 DirectoryNode & node, Owner & owner, std::string const & name, Function const & fn);
176 template <class Owner>
177 SimpleCommandNode & senf_console_add_node(
178 DirectoryNode & node, Owner & owner, std::string const & name,
179 void (Owner::*fn)(std::ostream &, ParseCommandInfo const &));
181 template <class Node>
182 DirectoryNode & senf_console_add_node(
183 DirectoryNode & dir, std::string const & name, Node const & node, int,
184 typename boost::enable_if< boost::is_convertible<Node*, ScopedDirectoryBase*> >::type * = 0);
189 ///////////////////////////////hh.e////////////////////////////////////////
190 #include "ScopedDirectory.cci"
191 //#include "ScopedDirectory.ct"
192 #include "ScopedDirectory.cti"
199 // comment-column: 40
200 // c-file-style: "senf"
201 // indent-tabs-mode: nil
202 // ispell-local-dictionary: "american"
203 // compile-command: "scons -u test"