4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at
9 // http://senf.berlios.de/license.html
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
15 // Software distributed under the License is distributed on an "AS IS" basis,
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
17 // for the specific language governing rights and limitations under the License.
19 // The Original Code is Fraunhofer FOKUS code.
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
26 // Stefan Bund <g0dil@berlios.de>
29 \brief Packet inline template implementation */
31 //#include "Packet.ih"
34 #include <senf/Utils/Exception.hh>
36 #define prefix_ inline
37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
42 // conversion constructors
44 template <class PacketType>
45 prefix_ senf::Packet::Packet(ConcretePacket<PacketType> const & packet)
46 : packet_(packet.ptr())
49 // interpreter chain access
51 template <class OtherPacket>
52 prefix_ OtherPacket senf::Packet::parseNextAs()
55 return OtherPacket(ptr()->parseNextAs<typename OtherPacket::type>());
58 template <class OtherPacket>
59 prefix_ bool senf::Packet::is()
62 // ensure that the template class is included in the corresponding object file when linking:
63 { static typename PacketInterpreter<typename OtherPacket::type>::factory_t _ (
64 PacketInterpreter<typename OtherPacket::type>::factory()); (void) _;}
65 return valid() && typeId() == typeIdValue<OtherPacket>();
68 template <class OtherPacket>
69 prefix_ OtherPacket senf::Packet::as()
72 if (!is<OtherPacket>())
73 throw WrapException<std::bad_cast>(std::bad_cast())
74 << ": called packet::as() with wrong PacketType: "
75 << (valid() ? typeId().prettyName() : "invalid packet")
76 << " != " << prettyName(typeid(OtherPacket));
77 return OtherPacket(ptr()->as<typename OtherPacket::type>());
80 template <class OtherPacket>
81 prefix_ OtherPacket senf::Packet::as(NoThrow_t)
84 SENF_ASSERT( is<OtherPacket>(), "Bad cast, called packet::as(nothrow) with wrong PacketType");
85 return OtherPacket(ptr()->as<typename OtherPacket::type>());
88 template <class OtherPacket>
89 prefix_ OtherPacket senf::Packet::next()
92 return next().as<OtherPacket>();
95 template <class OtherPacket>
96 prefix_ OtherPacket senf::Packet::next(NoThrow_t)
99 Packet p (next(nothrow));
100 return p && p.is<OtherPacket>() ?
101 OtherPacket(p.ptr()->as<typename OtherPacket::type>()) : OtherPacket();
104 template <class OtherPacket>
105 prefix_ OtherPacket senf::Packet::find()
108 OtherPacket p (find<OtherPacket>(nothrow));
109 if (!p) throw InvalidPacketChainException();
113 template <class OtherPacket>
114 prefix_ OtherPacket senf::Packet::prev()
117 return prev().as<OtherPacket>();
120 template <class OtherPacket>
121 prefix_ OtherPacket senf::Packet::prev(NoThrow_t)
124 Packet p (prev(nothrow));
125 return p && p.is<OtherPacket>() ?
126 OtherPacket(p.ptr()->as<typename OtherPacket::type>()) : OtherPacket();
129 template <class OtherPacket>
130 prefix_ OtherPacket senf::Packet::rfind()
133 OtherPacket p (rfind<OtherPacket>(nothrow));
134 if (!p) throw InvalidPacketChainException();
138 template <class OtherPacket>
139 prefix_ OtherPacket senf::Packet::last()
142 return last().as<OtherPacket>();
145 template <class OtherPacket>
146 prefix_ OtherPacket senf::Packet::first()
149 return first().as<OtherPacket>();
152 template <class Other>
153 prefix_ void senf::Packet::finalizeTo()
155 Packet p (find<Other>(nothrow));
156 ptr()->finalizeTo(p ? p.ptr() : last().ptr());
159 template <class Annotation>
160 prefix_ Annotation & senf::Packet::annotation()
162 return ptr()->annotation<Annotation>();
165 template <class Annotation>
166 prefix_ Annotation const & senf::Packet::annotation()
169 return ptr()->annotation<Annotation>();
172 //-/////////////////////////////////////////////////////////////////////////////////////////////////
173 // senf::ConcretePacket<PacketType>
175 // structors and default members
177 template <class PacketType>
178 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket()
181 template <class PacketType>
182 prefix_ typename senf::ConcretePacket<PacketType>::factory_t
183 senf::ConcretePacket<PacketType>::factory()
185 return interpreter::factory();
188 // Create completely new packet
190 template <class PacketType>
191 prefix_ senf::ConcretePacket<PacketType>
192 senf::ConcretePacket<PacketType>::create()
194 return ConcretePacket(interpreter::create());
197 template <class PacketType>
198 prefix_ senf::ConcretePacket<PacketType>
199 senf::ConcretePacket<PacketType>::create(senf::NoInit_t)
201 return ConcretePacket(interpreter::create(senf::noinit));
204 template <class PacketType>
205 prefix_ senf::ConcretePacket<PacketType>
206 senf::ConcretePacket<PacketType>::create(size_type size)
208 return ConcretePacket(interpreter::create(size));
211 template <class PacketType>
212 prefix_ senf::ConcretePacket<PacketType>
213 senf::ConcretePacket<PacketType>::create(size_type size, senf::NoInit_t)
215 return ConcretePacket(interpreter::create(size,senf::noinit));
220 template <class PacketType>
221 template <class ForwardReadableRange>
222 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
223 create(ForwardReadableRange const & range,
224 typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
226 return ConcretePacket(interpreter::create(range));
231 // Create packet as new packet after a given packet
233 template <class PacketType>
234 prefix_ senf::ConcretePacket<PacketType>
235 senf::ConcretePacket<PacketType>::createAfter(Packet const & packet)
237 return ConcretePacket(interpreter::createAfter(packet.ptr()));
240 template <class PacketType>
241 prefix_ senf::ConcretePacket<PacketType>
242 senf::ConcretePacket<PacketType>::createAfter(Packet const & packet, senf::NoInit_t)
244 return ConcretePacket(interpreter::createAfter(packet.ptr(),senf::noinit));
247 template <class PacketType>
248 prefix_ senf::ConcretePacket<PacketType>
249 senf::ConcretePacket<PacketType>::createAfter(Packet const & packet, size_type size)
251 return ConcretePacket(interpreter::createAfter(packet.ptr(), size));
254 template <class PacketType>
255 prefix_ senf::ConcretePacket<PacketType>
256 senf::ConcretePacket<PacketType>::createAfter(Packet const & packet, size_type size,
259 return ConcretePacket(interpreter::createAfter(packet.ptr(), size, senf::noinit));
264 template <class PacketType>
265 template <class ForwardReadableRange>
266 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
267 createAfter(Packet const & packet, ForwardReadableRange const & range,
268 typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
270 return ConcretePacket(interpreter::createAfter(packet.ptr(), range));
275 // Create packet as new packet (header) before a given packet
277 template <class PacketType>
278 prefix_ senf::ConcretePacket<PacketType>
279 senf::ConcretePacket<PacketType>::createBefore(Packet const & packet)
281 return ConcretePacket(interpreter::createBefore(packet.ptr()));
284 template <class PacketType>
285 prefix_ senf::ConcretePacket<PacketType>
286 senf::ConcretePacket<PacketType>::createBefore(Packet const & packet, senf::NoInit_t)
288 return ConcretePacket(interpreter::createBefore(packet.ptr(), senf::noinit));
291 template <class PacketType>
292 prefix_ senf::ConcretePacket<PacketType>
293 senf::ConcretePacket<PacketType>::createInsertBefore(Packet const & packet)
295 return ConcretePacket(interpreter::createInsertBefore(packet.ptr()));
298 template <class PacketType>
299 prefix_ senf::ConcretePacket<PacketType>
300 senf::ConcretePacket<PacketType>::createInsertBefore(Packet const & packet, senf::NoInit_t)
302 return ConcretePacket(interpreter::createInsertBefore(packet.ptr(), senf::noinit));
305 // Create a clone of the current packet
307 template <class PacketType>
308 prefix_ senf::ConcretePacket<PacketType>
309 senf::ConcretePacket<PacketType>::clone()
312 return ConcretePacket(ptr()->clone());
317 template <class PacketType>
318 prefix_ typename senf::ConcretePacket<PacketType>::Parser
319 senf::ConcretePacket<PacketType>::parser()
322 return ptr()->fields();
325 template <class PacketType>
326 prefix_ typename senf::ConcretePacket<PacketType>::ParserProxy
327 senf::ConcretePacket<PacketType>::operator->()
330 return ParserProxy(parser());
333 template <class PacketType>
334 prefix_ senf::Packet senf::ConcretePacket<PacketType>::next(NoThrow_t)
337 PacketInterpreterBase::ptr p (Packet::ptr()->next());
338 if (p) return Packet(p);
339 PacketInterpreterBase::optional_range r (type::nextPacketRange(*this));
340 return (r && ! r->empty()) ? Packet(getNext(r)) : Packet();
345 template <class PacketType>
346 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket(typename interpreter::ptr const & packet_)
350 template <class PacketType>
351 prefix_ typename senf::ConcretePacket<PacketType>::interpreter * senf::ConcretePacket<PacketType>::ptr()
354 return static_cast< PacketInterpreter<PacketType> *>( Packet::ptr().get());
357 //-/////////////////////////////////////////////////////////////////////////////////////////////////
364 // c-file-style: "senf"
365 // indent-tabs-mode: nil
366 // ispell-local-dictionary: "american"
367 // compile-command: "scons -u test"
368 // comment-column: 40