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