Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Packets / PacketInterpreter.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 PacketInterpreter inline template implementation */
25
26 //#include "PacketInterpreter.ih"
27
28 // Custom includes
29
30 #define prefix_ inline
31 //-/////////////////////////////////////////////////////////////////////////////////////////////////
32
33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
34 // senf::PacketInterpreterBase
35
36 // Interpreter chain access
37
38 template <class Type>
39 prefix_ bool senf::PacketInterpreterBase::is()
40 {
41     { static void const * const _ ((void*)&Type::dump); (void) _; }
42     return dynamic_cast< PacketInterpreter<Type>* >(this);
43 }
44
45 template <class Type>
46 prefix_ typename senf::PacketInterpreter<Type>::ptr senf::PacketInterpreterBase::as()
47 {
48     { static void const * const _ ((void*)&Type::dump); (void) _; }
49     return typename PacketInterpreter<Type>::ptr(
50         static_cast< PacketInterpreter<Type>* >(this));
51 }
52
53 template <class Annotation>
54 prefix_ Annotation & senf::PacketInterpreterBase::annotation()
55 {
56     return impl().annotation<Annotation>();
57 }
58
59 //-/////////////////////////////////////////////////////////////////////////////////////////////////
60 // senf::PacketInterpreter<PacketType>
61
62 template <class PacketType>
63 prefix_ typename senf::PacketInterpreter<PacketType>::factory_t
64 senf::PacketInterpreter<PacketType>::factory()
65 {
66     return & factory_;
67 }
68
69 // Create completely new packet
70
71 template <class PacketType>
72 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
73 senf::PacketInterpreter<PacketType>::create()
74 {
75     return create(initSize());
76 }
77
78 template <class PacketType>
79 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
80 senf::PacketInterpreter<PacketType>::create(senf::NoInit_t)
81 {
82     return create(0,senf::noinit);
83 }
84
85 template <class PacketType>
86 template <class ForwardReadableRange>
87 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
88 senf::PacketInterpreter<PacketType>::create(ForwardReadableRange const & range)
89 {
90     detail::PacketImpl::Guard p (new detail::PacketImpl(boost::begin(range),boost::end(range)));
91     ptr pi (create(p.p,p.p->begin(),p.p->end(),Append));
92     return pi;
93 }
94
95 // Create packet as new packet after a given packet
96
97 template <class PacketType>
98 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
99 senf::PacketInterpreter<PacketType>::createAfter(PacketInterpreterBase::ptr packet)
100 {
101     return createAfter(packet, initSize());
102 }
103
104 template <class PacketType>
105 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
106 senf::PacketInterpreter<PacketType>::createAfter(PacketInterpreterBase::ptr packet, senf::NoInit_t)
107 {
108     return createAfter(packet, 0, senf::noinit);
109 }
110
111 // Create clone of current packet
112
113 template <class PacketType>
114 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
115 senf::PacketInterpreter<PacketType>::clone()
116 {
117     return boost::static_pointer_cast<typename ptr::element_type>(PacketInterpreterBase::clone());
118 }
119
120 // Packet field access
121
122 template <class PacketType>
123 prefix_ typename senf::PacketInterpreter<PacketType>::parser
124 senf::PacketInterpreter<PacketType>::fields()
125 {
126     return parser (data().begin(),&data());
127 }
128
129 //-/////////////////////////////////////////////////////////////////////////////////////////////////
130 // private members
131
132 // Private structors
133
134 template <class PacketType>
135 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
136 senf::PacketInterpreter<PacketType>::create(detail::PacketImpl * impl, iterator b, iterator e,
137                                             Append_t)
138 {
139     return ptr(new PacketInterpreter(impl,b,e,Append));
140 }
141
142 template <class PacketType>
143 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
144 senf::PacketInterpreter<PacketType>::create(detail::PacketImpl * impl, iterator b, iterator e,
145                                             Prepend_t)
146 {
147     return ptr(new PacketInterpreter(impl,b,e,Prepend));
148 }
149
150 template <class PacketType>
151 prefix_ typename senf::PacketInterpreter<PacketType>::ptr
152 senf::PacketInterpreter<PacketType>::create(detail::PacketImpl * impl, iterator b, iterator e,
153                                             PacketInterpreterBase::ptr before)
154 {
155     return ptr(new PacketInterpreter(impl,b,e,before));
156 }
157
158 template <class PacketType>
159 prefix_ senf::PacketInterpreter<PacketType>::PacketInterpreter(detail::PacketImpl * impl,
160                                                                iterator b, iterator e, Append_t)
161     : PacketInterpreterBase(impl,b,e,Append)
162 {}
163
164 template <class PacketType>
165 prefix_ senf::PacketInterpreter<PacketType>::PacketInterpreter(detail::PacketImpl * impl,
166                                                                iterator b, iterator e, Prepend_t)
167     : PacketInterpreterBase(impl,b,e,Prepend)
168 {}
169
170 template <class PacketType>
171 prefix_
172 senf::PacketInterpreter<PacketType>::PacketInterpreter(detail::PacketImpl * impl, iterator b,
173                                                        iterator e,
174                                                        PacketInterpreterBase::ptr before)
175     : PacketInterpreterBase(impl,b,e,before)
176 {}
177
178 // PacketType access
179
180 template <class PacketType>
181 prefix_ typename senf::PacketInterpreter<PacketType>::size_type
182 senf::PacketInterpreter<PacketType>::initSize()
183 {
184     return type::initSize();
185 }
186
187 template <class PacketType>
188 prefix_ typename senf::PacketInterpreter<PacketType>::size_type
189 senf::PacketInterpreter<PacketType>::initHeadSize()
190 {
191     size_type sz (type::initHeadSize());
192     return  sz == size_type(-1) ? initSize() : sz ;
193 }
194
195 template <class PacketType>
196 prefix_ void senf::PacketInterpreter<PacketType>::init()
197 {
198     return type::init(ConcretePacket<PacketType>(ptr(this)));
199 }
200
201 //-/////////////////////////////////////////////////////////////////////////////////////////////////
202 #undef prefix_
203
204 \f
205 // Local Variables:
206 // mode: c++
207 // fill-column: 100
208 // c-file-style: "senf"
209 // indent-tabs-mode: nil
210 // ispell-local-dictionary: "american"
211 // compile-command: "scons -u test"
212 // comment-column: 40
213 // End: