Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Packets / PacketRegistry.ct
1 // $Id$
2 //
3 // Copyright (C) 2006
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 PacketRegistry non-inline template implementation */
25
26 #include "PacketRegistry.ih"
27
28 // Custom includes
29 #include <senf/Utils/senfassert.hh>
30 #include <iostream>
31 #include <iomanip>
32 #include <cmath>
33 #include <senf/Utils/TypeInfo.hh>
34 #include <senf/Utils/Format.hh>
35
36 #define prefix_
37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
38
39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
40 // senf::detail::PacketRegistryImpl<KeyType>::Entry
41
42 template <class KeyType>
43 prefix_ senf::detail::PacketRegistryImpl<KeyType>::Entry::Entry(KeyType const & key_,
44                                                                 int priority_)
45     : key (key_), priority (priority_)
46 {}
47
48 template <class KeyType>
49 prefix_ senf::detail::PacketRegistryImpl<KeyType>::Entry::~Entry()
50 {}
51
52 //-/////////////////////////////////////////////////////////////////////////////////////////////////
53 // senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>
54
55 template <class KeyType>
56 template <class PacketType>
57 prefix_ senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::
58 EntryImpl(KeyType const & key, int priority)
59     : Entry (key, priority)
60 {}
61
62 template <class KeyType>
63 template <class PacketType>
64 prefix_ senf::Packet::factory_t
65 senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::factory()
66     const
67 {
68     return PacketType::factory();
69 }
70
71 template <class KeyType>
72 template <class PacketType>
73 prefix_ std::string senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::name()
74     const
75 {
76     return prettyName(typeid(PacketType));
77 }
78
79 template <class KeyType>
80 template <class PacketType>
81 prefix_ std::type_info const &
82 senf::detail::PacketRegistryImpl<KeyType>::EntryImpl<PacketType>::type()
83     const
84 {
85     return typeid(PacketType);
86 }
87
88 //-/////////////////////////////////////////////////////////////////////////////////////////////////
89 // senf::detail::PacketRegistryImpl<KeyType>:
90
91 template <class KeyType>
92 template <class PacketType>
93 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::registerPacket(key_t key, int priority)
94 {
95     SENF_ASSERT_EXPRESSION(
96         registry_.insert(
97             typename Entry::ptr(new EntryImpl<PacketType>(key,priority))).second,
98         "Duplicate packet registration");
99 }
100
101 template <class KeyType>
102 template <class PacketType>
103 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::unregisterPacket()
104 {
105     registry_.template get<ByType>().erase(typeid(PacketType));
106 }
107
108 template <class KeyType>
109 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::unregisterPacket(key_t key, int priority)
110 {
111     // Why doesn't this work:
112     // registry_.erase(boost::make_tuple(key,priority));
113     typename Registry::iterator i (registry_.find(boost::make_tuple(key,priority)));
114     if (i != registry_.end())
115         registry_.erase(i);
116 }
117
118 template <class KeyType>
119 prefix_ typename senf::detail::PacketRegistryImpl<KeyType>::key_t
120 senf::detail::PacketRegistryImpl<KeyType>::key(senf::TypeIdValue const & type)
121 {
122     boost::optional<KeyType> k (key(type,true));
123     if (! k)
124         throw PacketTypeNotRegisteredException();
125     return *k;
126 }
127
128 template <class KeyType>
129 prefix_ boost::optional<typename senf::detail::PacketRegistryImpl<KeyType>::key_t>
130 senf::detail::PacketRegistryImpl<KeyType>::key(senf::TypeIdValue const & type, bool)
131 {
132     typedef typename Registry::template index<ByType>::type TypeIndex;
133     TypeIndex const & typeIndex (registry_.template get<ByType>());
134     typename TypeIndex::const_iterator i (typeIndex.find(type.id()));
135     if (i == typeIndex.end())
136         return boost::optional<key_t>();
137     return (*i)->key;
138 }
139
140 template <class KeyType>
141 prefix_ typename senf::detail::PacketRegistryImpl<KeyType>::Entry const &
142 senf::detail::PacketRegistryImpl<KeyType>::lookup(key_t key)
143 {
144     Entry const * e (lookup(key, true));
145     if (!e)
146         throw PacketTypeNotRegisteredException();
147     return *e;
148 }
149
150 template <class KeyType>
151 prefix_ typename senf::detail::PacketRegistryImpl<KeyType>::Entry const *
152 senf::detail::PacketRegistryImpl<KeyType>::lookup(key_t key, bool)
153 {
154     typedef typename Registry::template index<ByKey>::type KeyIndex;
155     KeyIndex const & keyIndex (registry_.template get<ByKey>());
156     typename KeyIndex::const_iterator i (keyIndex.lower_bound(key));
157     if (i == keyIndex.end() || (*i)->key != key)
158         return 0;
159     return i->get();
160 }
161
162 template <class KeyType>
163 prefix_ bool senf::detail::PacketRegistryImpl<KeyType>::v_empty()
164     const
165 {
166     return registry_.empty();
167 }
168
169 template <class KeyType>
170 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::v_dump(std::ostream & os)
171     const
172 {
173     typedef typename Registry::template index<ByKey>::type KeyIndex;
174     KeyIndex const & keyIndex (registry_.template get<ByKey>());
175     for (typename KeyIndex::iterator i (keyIndex.begin()), i_end (keyIndex.end());
176          i != i_end; ++i) {
177         std::string n ((*i)->name());
178         senf::detail::DumpKey<KeyType>::dump((*i)->key, os);
179         os << ' ' << std::setw(6) << (*i)->priority << ' ' << n.substr(21,n.size()-22) << '\n';
180     }
181 }
182
183 template <class KeyType>
184 prefix_ void senf::detail::PacketRegistryImpl<KeyType>::v_clear()
185 {
186     registry_.clear();
187 }
188
189 //-/////////////////////////////////////////////////////////////////////////////////////////////////
190 // senf::detail::DumpKey<KeyType,is_integral>
191
192 template <class KeyType, bool is_integral>
193 prefix_ void senf::detail::DumpKey<KeyType,is_integral>::dump(KeyType const & v,
194                                                               std::ostream & os)
195 {
196     os << "  " << std::setw(16) << std::left << v << std::setw(0) << std::right;
197 }
198
199 // senf::detail::DumpKey<KeyType, true>
200
201 template <class KeyType>
202 prefix_ void senf::detail::DumpKey<KeyType, true>::dump(KeyType const & v, std::ostream & os)
203 {
204     os << "  " << senf::format::dumpint(v);
205 }
206
207 //-/////////////////////////////////////////////////////////////////////////////////////////////////
208 #undef prefix_
209
210 \f
211 // Local Variables:
212 // mode: c++
213 // fill-column: 100
214 // c-file-style: "senf"
215 // indent-tabs-mode: nil
216 // ispell-local-dictionary: "american"
217 // compile-command: "scons -u test"
218 // comment-column: 40
219 // End: