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_SENF_Scheduler_Console_ScopedDirectory_
27 #define HH_SENF_Scheduler_Console_ScopedDirectory_ 1
30 #include <boost/utility.hpp>
31 #include <boost/type_traits/is_convertible.hpp>
33 #include "LazyDirectory.hh" // For ScopedDirectory template default arg
35 //#include "ScopedDirectory.mpp"
36 ///////////////////////////////hh.p////////////////////////////////////////
41 /** \brief Internal: Node creation helper traits (ScopedDirectory proxy)
43 This class is used like NodeCreateTraits to customize the child node creation. This trait
44 class is used however by the ScopedDirectory proxy.
46 template <class Owner, class Object>
47 struct OwnerNodeCreateTraits
49 typedef BOOST_TYPEOF_TPL( senf_console_add_node(
50 * static_cast<DirectoryNode *>(0),
51 * static_cast<Owner *>(0),
52 * static_cast<std::string const *>(0),
53 * static_cast<Object *>(0),
54 * static_cast<int *>(0)) ) base_type;
55 typedef typename senf::remove_cvref<base_type>::type value_type;
57 typedef typename value_type::node_type NodeType;
58 typedef typename value_type::return_type result_type;
62 static result_type create(DirectoryNode & node, Owner & owner,
63 std::string const & name, Object & ob);
67 /** \brief Internal: Marker base class for all ScopedDirectory proxies
69 class ScopedDirectoryBase
72 DirectoryNode & node() const; ///< Access the proxied DirectoryNode
73 operator DirectoryNode & () const; ///< Access the proxied DirectoryNode
75 ///////////////////////////////////////////////////////////////////////////
76 ///\name Proxied members (see DirectoryNode)
79 GenericNode::ptr remove(std::string const & name);
80 bool hasChild(std::string const & name) const;
81 DirectoryNode & getDirectory(std::string const & name) const;
82 DirectoryNode & operator[](std::string const & name) const;
83 CommandNode & getCommand(std::string const & name) const;
84 CommandNode & operator()(std::string const & name) const;
85 GenericNode & get(std::string const & name) const;
86 DirectoryNode & mkdir(std::string const & name);
87 void link(std::string const & name, GenericNode & node);
88 DirectoryNode::ChildrenRange children() const;
89 DirectoryNode & doc(std::string const & doc);
94 ScopedDirectoryBase();
95 ~ScopedDirectoryBase();
98 DirectoryNode::ptr node_;
101 /** \brief DirectoryNode member proxy
103 ScopedDirectory is used whenever a class wants to manage it's own directory. The class
104 allows to declare the directory as a public member object. This allows the user of the class
105 to register the directory in the command tree. By using the proxy, the node is automatically
106 detached from the tree (and thereby destroyed) when the object (and thereby the proxy) is
113 ScopedDirectory<MyClass> configDir;
115 MyClass() : configDir(this)
122 The ScopedDirectory proxy implements 'add()' to add new children to the proxied
123 DirectoryNode. All add() variants supported by DirectoryNode are supported by
126 \idea This proxy could be made obsolete by allowing to allocate node objects
127 statically. This could be achieved by moving back to an intrusive_ptr implementation for
128 normal pointing needs with an added twist: Give each node a smart_ptr member pointing to
129 itself with a null deleter. This allows to create weak_ptr's to the nodes which will
130 automatically expire when the node is deleted (either statically or by the
135 template <class Owner>
136 class ScopedDirectory : public ScopedDirectoryBase
139 ///////////////////////////////////////////////////////////////////////////
144 ///////////////////////////////////////////////////////////////////////////
145 ///\name Structors and default members
148 explicit ScopedDirectory(Owner * owner);
151 ///////////////////////////////////////////////////////////////////////////
153 template <class Object>
154 typename OwnerNodeCreateTraits<Owner, Object>::result_type add(std::string const & name,
156 ///< Create new child node
157 /**< Adds a new child node to the (proxied)
158 DirectoryNode. How the node is added is configured
159 using the OwnerNodeCreateTraits template. The default
160 implementation just forwards the call to the proxied
163 template <class Object>
164 typename OwnerNodeCreateTraits<Owner, Object>::result_type add(std::string const & name,
166 ///< Create new child node
178 class ScopedDirectory<void> : public ScopedDirectoryBase
181 template <class Object>
182 typename NodeCreateTraits<Object>::result_type add(std::string const & name,
185 template <class Object>
186 typename NodeCreateTraits<Object>::result_type add(std::string const & name,
190 template <class Owner, class Function>
191 SimpleCommandNode & senf_console_add_node(
192 DirectoryNode & node, Owner & owner, std::string const & name,
193 SimpleCommandNode::Function fn, int);
195 template <class Owner>
196 SimpleCommandNode & senf_console_add_node(
197 DirectoryNode & node, Owner & owner, std::string const & name,
198 void (Owner::*fn)(std::ostream &, ParseCommandInfo const &), int);
200 template <class Node>
201 DirectoryNode & senf_console_add_node(
202 DirectoryNode & dir, std::string const & name, Node const & node, int,
203 typename boost::enable_if< boost::is_convertible<Node*, ScopedDirectoryBase*> >::type * = 0);
208 ///////////////////////////////hh.e////////////////////////////////////////
209 #include "ScopedDirectory.cci"
210 //#include "ScopedDirectory.ct"
211 #include "ScopedDirectory.cti"
218 // comment-column: 40
219 // c-file-style: "senf"
220 // indent-tabs-mode: nil
221 // ispell-local-dictionary: "american"
222 // compile-command: "scons -u test"