Packets/Packet.cti

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   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 Packet inline template implementation */
  25
  26 //#include "Packet.ih"
  27
  28 // Custom includes
  29 #include "../Utils/Exception.hh"
  30
  31 #define prefix_ inline
  32 ///////////////////////////////cti.p///////////////////////////////////////
  33
  34 ///////////////////////////////////////////////////////////////////////////
  35 // senf::Packet
  36
  37 // conversion constructors
  38
  39 template <class PacketType>
  40 prefix_ senf::Packet::Packet(ConcretePacket<PacketType> packet)
  41     : packet_(packet.ptr())
  42 {}
  43
  44 // interpreter chain access
  45
  46 template <class OtherPacket>
  47 prefix_ OtherPacket senf::Packet::parseNextAs()
  48     const
  49 {
  50     return OtherPacket(ptr()->parseNextAs<typename OtherPacket::type>());
  51 }
  52
  53 template <class OtherPacket>
  54 prefix_ bool senf::Packet::is()
  55     const
  56 {
  57     return ptr()->is<typename OtherPacket::type>();
  58 }
  59
  60 template <class OtherPacket>
  61 prefix_ OtherPacket senf::Packet::as()
  62     const
  63 {
  64     if (!is<OtherPacket>())
  65         throw WrapException<std::bad_cast>(std::bad_cast());
  66     return OtherPacket(ptr()->as<typename OtherPacket::type>());
  67 }
  68
  69 template <class OtherPacket>
  70 prefix_ OtherPacket senf::Packet::next()
  71     const
  72 {
  73     return next().as<OtherPacket>();
  74 }
  75
  76 template <class OtherPacket>
  77 prefix_ OtherPacket senf::Packet::next(NoThrow_t)
  78     const
  79 {
  80     Packet p (next(nothrow));
  81     return p && p.is<OtherPacket>() ? p.as<OtherPacket>() : OtherPacket();
  82 }
  83
  84 template <class OtherPacket>
  85 prefix_ OtherPacket senf::Packet::find()
  86     const
  87 {
  88     OtherPacket p (find<OtherPacket>(nothrow));
  89     if (!p) throw InvalidPacketChainException();
  90     return p;
  91 }
  92
  93 template <class OtherPacket>
  94 prefix_ OtherPacket senf::Packet::prev()
  95     const
  96 {
  97     return prev().as<OtherPacket>();
  98 }
  99
 100 template <class OtherPacket>
 101 prefix_ OtherPacket senf::Packet::prev(NoThrow_t)
 102     const
 103 {
 104     Packet p (prev(nothrow));
 105     return p && p.is<OtherPacket>() ? p.as<OtherPacket>() : OtherPacket();
 106 }
 107
 108 template <class OtherPacket>
 109 prefix_ OtherPacket senf::Packet::rfind()
 110     const
 111 {
 112     OtherPacket p (rfind<OtherPacket>(nothrow));
 113     if (!p) throw InvalidPacketChainException();
 114     return p;
 115 }
 116
 117 template <class OtherPacket>
 118 prefix_ OtherPacket senf::Packet::last()
 119     const
 120 {
 121     return last().as<OtherPacket>();
 122 }
 123
 124 template <class OtherPacket>
 125 prefix_ OtherPacket senf::Packet::first()
 126     const
 127 {
 128     return first().as<OtherPacket>();
 129 }
 130
 131 template <class Other>
 132 prefix_ void senf::Packet::finalizeTo()
 133 {
 134     Packet p (find<Other>(nothrow));
 135     ptr()->finalizeTo(p ? p.ptr() : last().ptr());
 136 }
 137
 138 template <class Annotation>
 139 prefix_ Annotation & senf::Packet::annotation()
 140 {
 141     return ptr()->annotation<Annotation>();
 142 }
 143
 144 ///////////////////////////////////////////////////////////////////////////
 145 // senf::ConcretePacket<PacketType>
 146
 147 // structors and default members
 148
 149 template <class PacketType>
 150 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket()
 151 {}
 152
 153 template <class PacketType>
 154 prefix_ typename senf::ConcretePacket<PacketType>::factory_t
 155 senf::ConcretePacket<PacketType>::factory()
 156 {
 157     return interpreter::factory();
 158 }
 159
 160 // Create completely new packet
 161
 162 template <class PacketType>
 163 prefix_ senf::ConcretePacket<PacketType>
 164 senf::ConcretePacket<PacketType>::create()
 165 {
 166     return ConcretePacket(interpreter::create());
 167 }
 168
 169 template <class PacketType>
 170 prefix_ senf::ConcretePacket<PacketType>
 171 senf::ConcretePacket<PacketType>::create(senf::NoInit_t)
 172 {
 173     return ConcretePacket(interpreter::create(senf::noinit));
 174 }
 175
 176 template <class PacketType>
 177 prefix_ senf::ConcretePacket<PacketType>
 178 senf::ConcretePacket<PacketType>::create(size_type size)
 179 {
 180     return ConcretePacket(interpreter::create(size));
 181 }
 182
 183 template <class PacketType>
 184 prefix_ senf::ConcretePacket<PacketType>
 185 senf::ConcretePacket<PacketType>::create(size_type size, senf::NoInit_t)
 186 {
 187     return ConcretePacket(interpreter::create(size,senf::noinit));
 188 }
 189
 190 #ifndef DOXYGEN
 191
 192 template <class PacketType>
 193 template <class ForwardReadableRange>
 194 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
 195 create(ForwardReadableRange const & range,
 196        typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
 197 {
 198     return ConcretePacket(interpreter::create(range));
 199 }
 200
 201 #endif
 202
 203 // Create packet as new packet after a given packet
 204
 205 template <class PacketType>
 206 prefix_ senf::ConcretePacket<PacketType>
 207 senf::ConcretePacket<PacketType>::createAfter(Packet packet)
 208 {
 209     return ConcretePacket(interpreter::createAfter(packet.ptr()));
 210 }
 211
 212 template <class PacketType>
 213 prefix_ senf::ConcretePacket<PacketType>
 214 senf::ConcretePacket<PacketType>::createAfter(Packet packet, senf::NoInit_t)
 215 {
 216     return ConcretePacket(interpreter::createAfter(packet.ptr(),senf::noinit));
 217 }
 218
 219 template <class PacketType>
 220 prefix_ senf::ConcretePacket<PacketType>
 221 senf::ConcretePacket<PacketType>::createAfter(Packet packet, size_type size)
 222 {
 223     return ConcretePacket(interpreter::createAfter(packet.ptr(), size));
 224 }
 225
 226 template <class PacketType>
 227 prefix_ senf::ConcretePacket<PacketType>
 228 senf::ConcretePacket<PacketType>::createAfter(Packet packet, size_type size, senf::NoInit_t)
 229 {
 230     return ConcretePacket(interpreter::createAfter(packet.ptr(), size, senf::noinit));
 231 }
 232
 233 #ifndef DOXYGEN
 234
 235 template <class PacketType>
 236 template <class ForwardReadableRange>
 237 prefix_ senf::ConcretePacket<PacketType> senf::ConcretePacket<PacketType>::
 238 createAfter(Packet packet, ForwardReadableRange const & range,
 239             typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type *)
 240 {
 241     return ConcretePacket(interpreter::createAfter(packet.ptr(), range));
 242 }
 243
 244 #endif
 245
 246 // Create packet as new packet (header) before a given packet
 247
 248 template <class PacketType>
 249 prefix_ senf::ConcretePacket<PacketType>
 250 senf::ConcretePacket<PacketType>::createBefore(Packet packet)
 251 {
 252     return ConcretePacket(interpreter::createBefore(packet.ptr()));
 253 }
 254
 255 template <class PacketType>
 256 prefix_ senf::ConcretePacket<PacketType>
 257 senf::ConcretePacket<PacketType>::createBefore(Packet packet, senf::NoInit_t)
 258 {
 259     return ConcretePacket(interpreter::createBefore(packet.ptr(), senf::noinit));
 260 }
 261
 262 // Create a clone of the current packet
 263
 264 template <class PacketType>
 265 prefix_ senf::ConcretePacket<PacketType>
 266 senf::ConcretePacket<PacketType>::clone()
 267     const
 268 {
 269     return ConcretePacket(ptr()->clone());
 270 }
 271
 272 // Field access
 273
 274 template <class PacketType>
 275 prefix_ typename senf::ConcretePacket<PacketType>::Parser *
 276 senf::ConcretePacket<PacketType>::operator->()
 277     const
 278 {
 279     return ptr()->fields_p();
 280 }
 281
 282 template <class PacketType>
 283 prefix_ typename senf::ConcretePacket<PacketType>::Parser
 284 senf::ConcretePacket<PacketType>::parser()
 285     const
 286 {
 287     return ptr()->fields();
 288 }
 289
 290 // private members
 291
 292 template <class PacketType>
 293 prefix_ senf::ConcretePacket<PacketType>::ConcretePacket(typename interpreter::ptr packet_)
 294     : Packet(packet_)
 295 {}
 296
 297 template <class PacketType>
 298 prefix_ typename senf::ConcretePacket<PacketType>::interpreter::ptr
 299 senf::ConcretePacket<PacketType>::ptr()
 300     const
 301 {
 302     return boost::static_pointer_cast< PacketInterpreter<PacketType> >(Packet::ptr());
 303 }
 304
 305 ///////////////////////////////cti.e///////////////////////////////////////
 306 #undef prefix_
 307
 308 \f
 309 // Local Variables:
 310 // mode: c++
 311 // fill-column: 100
 312 // c-file-style: "senf"
 313 // indent-tabs-mode: nil
 314 // ispell-local-dictionary: "american"
 315 // compile-command: "scons -u test"
 316 // comment-column: 40
 317 // End: