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 namespace detail { struct OwnedNodeFactory {}; }
43 /** \brief Internal: Marker base class for all ScopedDirectory proxies
45 class ScopedDirectoryBase
48 DirectoryNode & node() const; ///< Access the proxied DirectoryNode
49 operator DirectoryNode & () const; ///< Access the proxied DirectoryNode
51 ///////////////////////////////////////////////////////////////////////////
52 ///\name Proxied members (see DirectoryNode)
55 GenericNode::ptr remove(std::string const & name);
56 bool hasChild(std::string const & name) const;
57 DirectoryNode & getDirectory(std::string const & name) const;
58 DirectoryNode & operator[](std::string const & name) const;
59 CommandNode & getCommand(std::string const & name) const;
60 CommandNode & operator()(std::string const & name) const;
61 GenericNode & get(std::string const & name) const;
62 DirectoryNode & mkdir(std::string const & name);
63 void link(std::string const & name, GenericNode & node);
64 DirectoryNode::ChildrenRange children() const;
65 DirectoryNode & doc(std::string const & doc);
70 ScopedDirectoryBase();
71 ~ScopedDirectoryBase();
74 DirectoryNode::ptr node_;
77 /** \brief DirectoryNode member proxy
79 ScopedDirectory is used whenever a class wants to manage it's own directory. The class
80 allows to declare the directory as a public member object. This allows the user of the class
81 to register the directory in the command tree. By using the proxy, the node is automatically
82 detached from the tree (and thereby destroyed) when the object (and thereby the proxy) is
89 ScopedDirectory<MyClass> configDir;
91 MyClass() : configDir(this)
98 The ScopedDirectory proxy implements 'add()' to add new children to the proxied
99 DirectoryNode. All add() variants supported by DirectoryNode are supported by
102 \idea This proxy could be made obsolete by allowing to allocate node objects
103 statically. This could be achieved by moving back to an intrusive_ptr implementation for
104 normal pointing needs with an added twist: Give each node a smart_ptr member pointing to
105 itself with a null deleter. This allows to create weak_ptr's to the nodes which will
106 automatically expire when the node is deleted (either statically or by the
111 template <class Owner>
112 class ScopedDirectory : public ScopedDirectoryBase
115 ///////////////////////////////////////////////////////////////////////////
120 ///////////////////////////////////////////////////////////////////////////
121 ///\name Structors and default members
124 explicit ScopedDirectory(Owner * owner);
127 ///////////////////////////////////////////////////////////////////////////
129 template <class NodeType>
130 NodeType & add(std::string const & name, boost::shared_ptr<NodeType> node);
131 template <class NodeType>
132 NodeType & add(std::string const & name, NodeType & node,
133 typename boost::enable_if< boost::is_convertible<NodeType &, GenericNode &> >::type * = 0);
134 template <class Factory>
135 typename Factory::result_type add(std::string const & name, Factory const & factory,
136 typename boost::enable_if< boost::is_convertible<Factory*, detail::OwnedNodeFactory*> >::type * = 0);
137 template <class Factory>
138 typename Factory::result_type add(std::string const & name, Factory const & factory,
139 typename boost::enable_if< boost::is_convertible<Factory*, detail::NodeFactory*> >::type * = 0,
140 typename boost::disable_if< boost::is_convertible<Factory*, detail::OwnedNodeFactory*> >::type * = 0);
151 class ScopedDirectory<void> : public ScopedDirectoryBase
154 template <class NodeType>
155 NodeType & add(std::string const & name, boost::shared_ptr<NodeType> node);
156 template <class NodeType>
157 NodeType & add(std::string const & name, NodeType & node,
158 typename boost::enable_if< boost::is_convertible<NodeType &, GenericNode &> >::type * = 0);
159 template <class Factory>
160 typename Factory::result_type add(std::string const & name, Factory const & factory,
161 typename boost::enable_if< boost::is_convertible<Factory*, detail::NodeFactory*> >::type * = 0);
168 ///////////////////////////////hh.e////////////////////////////////////////
169 #include "ScopedDirectory.cci"
170 //#include "ScopedDirectory.ct"
171 #include "ScopedDirectory.cti"
178 // comment-column: 40
179 // c-file-style: "senf"
180 // indent-tabs-mode: nil
181 // ispell-local-dictionary: "american"
182 // compile-command: "scons -u test"