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 ObjectDirectory public header */
26 #ifndef HH_ObjectDirectory_
27 #define HH_ObjectDirectory_ 1
30 #include <boost/utility.hpp>
31 #include <boost/type_traits/is_convertible.hpp>
34 //#include "ObjectDirectory.mpp"
35 ///////////////////////////////hh.p////////////////////////////////////////
40 /** \brief Internal: Node creation helper traits (ObjectDirectory proxy)
42 This class is used like NodeCreateTraits to customize the child node creation. This trait
43 class is used however by the ObjectDirectory 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 ObjectDirectory proxies
65 struct ObjectDirectoryBase {};
67 /** \brief DirectoryNode member proxy
69 ObjectDirectory is used whenever a class wants to manage it's own directory. The class
70 allows to declare the directory as a public member object. This allows the user of the class
71 to register the directory in the command tree. By using the proxy, the node is automatically
72 detached from the tree (and thereby destroyed) when the object (and thereby the proxy) is
79 ObjectDirectory<MyClass> configDir;
81 MyClass() : configDir(this)
88 The ObjectDirectory proxy implements 'add()' to add new children to the proxied
89 DirectoryNode. All add() variants supported by DirectoryNode are supported by
92 \idea This proxy could be made obsolete by allowing to allocate node objects
93 statically. This could be achieved by moving back to an intrusive_ptr implementation for
94 normal pointing needs with an added twist: Give each node a smart_ptr member pointing to
95 itself with a null deleter. This allows to create weak_ptr's to the nodes which will
96 automatically expire when the node is deleted (either statically or by the
101 template <class Owner>
102 class ObjectDirectory : public ObjectDirectoryBase
105 ///////////////////////////////////////////////////////////////////////////
110 ///////////////////////////////////////////////////////////////////////////
111 ///\name Structors and default members
114 ObjectDirectory(Owner * owner);
118 ///////////////////////////////////////////////////////////////////////////
120 template <class Object>
121 typename OwnerNodeCreateTraits<Owner, Object>::NodeType & add(std::string const & name,
123 ///< Create new child node
124 /**< Adds a new child node to the (proxied)
125 DirectoryNode. How the node is added is configured
126 using the OwnerNodeCreateTraits template. The default
127 implementation just forwards the call to the proxied
130 DirectoryNode & node() const; ///< Access the proxied DirectoryNode
132 ///////////////////////////////////////////////////////////////////////////
133 ///\name Proxied members (see DirectoryNode)
136 GenericNode::ptr remove(std::string const & name);
137 DirectoryNode & operator[](std::string const & name) const;
138 CommandNode & operator()(std::string const & name) const;
139 GenericNode & get(std::string const & name) const;
140 DirectoryNode & mkdir(std::string const & name);
141 DirectoryNode::ChildrenRange children() const;
142 DirectoryNode & doc(std::string const & doc);
149 DirectoryNode::ptr node_;
154 template <class Owner, class Function>
155 SimpleCommandNode & senf_console_add_node(
156 DirectoryNode & node, Owner & owner, std::string const & name, Function const & fn);
158 template <class Owner>
159 SimpleCommandNode & senf_console_add_node(
160 DirectoryNode & node, Owner & owner, std::string const & name,
161 void (Owner::*fn)(std::ostream & output, CommandNode::Arguments const & arguments));
163 template <class Node>
164 DirectoryNode & senf_console_add_node(
165 DirectoryNode & dir, std::string const & name, Node const & node, int,
166 typename boost::enable_if< boost::is_convertible<Node*, ObjectDirectoryBase*> >::type * = 0);
171 ///////////////////////////////hh.e////////////////////////////////////////
172 //#include "ObjectDirectory.cci"
173 //#include "ObjectDirectory.ct"
174 #include "ObjectDirectory.cti"
181 // comment-column: 40
182 // c-file-style: "senf"
183 // indent-tabs-mode: nil
184 // ispell-local-dictionary: "american"
185 // compile-command: "scons -u test"