4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief IntParser internal header */
26 #ifndef IH_SENF_Packets_IntParser_
27 #define IH_SENF_Packets_IntParser_ 1
30 #include "PacketTypes.hh"
32 ///////////////////////////////ih.p////////////////////////////////////////
38 ///////////////////////////////////////////////////////////////////////////
41 /** \brief Internal: Integer operation mixin for integer parsers
45 This class contains all the integer operations supported by the integer parsers. It is
46 inherited by each integer parser.
48 template <class Derived, class Value>
52 typedef Value value_type;
54 operator Value () const { return derived().value(); }
57 Value operator op () const { return op derived().value(); }
58 # define mutator(op) \
59 template <class Other> Derived const & operator op ## = (Other other) \
60 { derived().value( derived().value() op other ); return derived(); }
80 Derived const & operator ++ ()
81 { derived().value( derived().value()+1 ); return derived(); }
82 Derived const & operator -- ()
83 { derived().value( derived().value()-1 ); return derived(); }
85 Value operator ++ (int)
86 { Value v (derived().value()); derived().value( v+1 ); return v; }
87 Value operator -- (int)
88 { Value v (derived().value()); derived().value( v-1 ); return v; }
91 Derived & derived() { return *static_cast<Derived *>(this); }
92 Derived const & derived() const { return *static_cast<Derived const *>(this); };
95 ///////////////////////////////////////////////////////////////////////////
96 // Network byte order integer extraction
98 /** \brief Internal: Extract 16bit network byte order value
102 inline boost::uint16_t parse_uint16(iterator i)
104 return i[1] | i[0]<<8;
107 /** \brief Internal: Write 16bit network byte order value
111 inline void write_uint16(iterator i, boost::uint16_t v)
113 i[0] = ( v >> 8 ) & 0xff;
117 /** \brief Internal: Extract 16bit least significant bit order value
121 inline boost::uint16_t parse_uint16LSB(iterator i)
123 return i[0] | i[1]<<8;
126 /** \brief Internal: Write 16bit least significant bit order value
130 inline void write_uint16LSB(iterator i, boost::uint16_t v)
133 i[1] = ( v >> 8 ) & 0xff;
136 /** \brief Internal: Extract 24bit network byte order value
140 inline boost::uint32_t parse_uint24(iterator i)
142 return i[2] | i[1]<<8 | i[0]<<16;
145 /** \brief Internal: Write 24bit network byte order value
149 inline void write_uint24(iterator i, boost::uint32_t v)
151 i[0] = ( v >> 16 ) & 0xff;
152 i[1] = ( v >> 8 ) & 0xff;
156 /** \brief Internal: Extract 32bit network byte order value
160 inline boost::uint32_t parse_uint32(iterator i)
162 return i[3] | i[2]<<8 | i[1]<<16 | i[0]<<24;
165 /** \brief Internal: Write 32bit network byte order value
169 inline void write_uint32(iterator i, boost::uint32_t v)
171 i[0] = ( v >> 24 ) & 0xff;
172 i[1] = ( v >> 16 ) & 0xff;
173 i[2] = ( v >> 8 ) & 0xff;
177 /** \brief Internal: Extract 32bit network byte order value
181 inline boost::uint32_t parse_uint32LSB(iterator i)
183 return i[0] | i[1]<<8 | i[2]<<16 | i[3]<<24;
186 /** \brief Internal: Write 32bit network byte order value
190 inline void write_uint32LSB(iterator i, boost::uint32_t v)
192 i[3] = ( v >> 24 ) & 0xff;
193 i[2] = ( v >> 16 ) & 0xff;
194 i[1] = ( v >> 8 ) & 0xff;
198 /** \brief Internal: Extract 64bit network byte order value
202 inline boost::uint64_t parse_uint64(iterator i)
204 return ((boost::uint64_t)i[7]) | ((boost::uint64_t)i[6])<<8
205 | ((boost::uint64_t)i[5])<<16 | ((boost::uint64_t)i[4])<<24
206 | ((boost::uint64_t)i[3])<<32 | ((boost::uint64_t)i[2])<<40
207 | ((boost::uint64_t)i[1])<<48 | ((boost::uint64_t)i[0])<<56;
210 /** \brief Internal: Write 64bit network byte order value
214 inline void write_uint64(iterator i, boost::uint64_t v)
216 i[0] = ( v >> 56 ) & 0xff;
217 i[1] = ( v >> 48 ) & 0xff;
218 i[2] = ( v >> 40 ) & 0xff;
219 i[3] = ( v >> 32 ) & 0xff;
220 i[4] = ( v >> 24 ) & 0xff;
221 i[5] = ( v >> 16 ) & 0xff;
222 i[6] = ( v >> 8 ) & 0xff;
226 /** \brief Internal: Extract 64bit least significant bit order value
230 inline boost::uint64_t parse_uint64LSB(iterator i)
232 return ((boost::uint64_t)i[0]) | ((boost::uint64_t)i[1])<<8
233 | ((boost::uint64_t)i[2])<<16 | ((boost::uint64_t)i[3])<<24
234 | ((boost::uint64_t)i[4])<<32 | ((boost::uint64_t)i[5])<<40
235 | ((boost::uint64_t)i[6])<<48 | ((boost::uint64_t)i[7])<<56;
238 /** \brief Internal: Write 64bit least significant bit order value
242 inline void write_uint64LSB(iterator i, boost::uint64_t v)
245 i[1] = ( v >> 8 ) & 0xff;
246 i[2] = ( v >> 16 ) & 0xff;
247 i[3] = ( v >> 24 ) & 0xff;
248 i[4] = ( v >> 32 ) & 0xff;
249 i[5] = ( v >> 40 ) & 0xff;
250 i[6] = ( v >> 48 ) & 0xff;
251 i[7] = ( v >> 56 ) & 0xff;
254 ///////////////////////////////////////////////////////////////////////////
255 // bitfield extraction
257 // Doxygen doesn't like this stuff ...
261 template <unsigned offset, unsigned endb, unsigned start, unsigned end>
262 struct parse_bitfield_i
264 static boost::uint32_t parse(iterator i) {
265 return ( ( ( parse_uint32(i+offset+1)>>(40-end) ) // Beware of sign extension !!
266 & boost::low_bits_mask_t<32-(40-end)>::sig_bits )
267 | (i[offset]<<(32-(40-end))) )
268 & boost::low_bits_mask_t<end-start>::sig_bits;
271 static void write(iterator i, boost::uint32_t v) {
272 write_uint32(i+offset+1,
273 (parse_uint32(i+offset+1) & ~(boost::low_bits_mask_t<end-8>::sig_bits<<(40-end)))
274 | ((v & boost::low_bits_mask_t<end-8>::sig_bits) << (40-end)));
275 i[offset] = (i[offset] & ~(boost::low_bits_mask_t<8-start>::sig_bits))
276 | ((v>>(end-8)) & boost::low_bits_mask_t<8-start>::sig_bits);
280 template <unsigned offset, unsigned start, unsigned end>
281 struct parse_bitfield_i<offset, 3, start, end>
283 static boost::uint32_t parse(iterator i) {
284 return ( parse_uint32(i+offset)>>(32-end) )
285 & boost::low_bits_mask_t<end-start>::sig_bits;
288 static void write(iterator i, boost::uint32_t v) {
289 write_uint32(i+offset,
290 (parse_uint32(i+offset) & ~(boost::low_bits_mask_t<end-start>::sig_bits<<(32-end)))
291 | ((v & boost::low_bits_mask_t<end-start>::sig_bits) << (32-end)));
295 template <unsigned offset, unsigned start, unsigned end>
296 struct parse_bitfield_i<offset, 2, start, end>
298 static boost::uint32_t parse(iterator i) {
299 return ( parse_uint24(i+offset)>>(24-end) )
300 & boost::low_bits_mask_t<end-start>::sig_bits;
303 static void write(iterator i, boost::uint32_t v) {
304 write_uint24(i+offset,
305 (parse_uint24(i+offset) & ~(boost::low_bits_mask_t<end-start>::sig_bits<<(24-end)))
306 | ((v & boost::low_bits_mask_t<end-start>::sig_bits) << (24-end)));
310 template <unsigned offset, unsigned start, unsigned end>
311 struct parse_bitfield_i<offset, 1, start, end>
313 static boost::uint32_t parse(iterator i) {
314 return ( parse_uint16(i+offset)>>(16-end) )
315 & boost::low_bits_mask_t<end-start>::sig_bits;
318 static void write(iterator i, boost::uint32_t v) {
319 write_uint16(i+offset,
320 (parse_uint16(i+offset) & ~(boost::low_bits_mask_t<end-start>::sig_bits<<(16-end)))
321 | ((v & boost::low_bits_mask_t<end-start>::sig_bits) << (16-end)));
325 template <unsigned offset, unsigned start, unsigned end>
326 struct parse_bitfield_i<offset, 0, start, end>
328 static boost::uint32_t parse(iterator i) {
329 return ( i[offset]>>(8-end) )
330 & boost::low_bits_mask_t<end-start>::sig_bits;
333 static void write(iterator i, boost::uint32_t v) {
334 i[offset] = (i[offset] & ~(boost::low_bits_mask_t<end-start>::sig_bits<<(8-end)))
335 | ((v & boost::low_bits_mask_t<end-start>::sig_bits) << (8-end));
341 /** \brief Internal: Bitfield read/write helper
345 Using template specializations, this class provides optimized bitfield parsers and
346 writers. For each number of bytes the bitfield covers (from 1 to 5 bytes), a template
347 specialization is provided in \c parse_bitfield_i.
349 This helper always processes unsigned values. For signed values sign extension still needs
352 template <unsigned start, unsigned end>
353 struct parse_bitfield
354 : public parse_bitfield_i<start/8,(end-1)/8-start/8,start%8,end-8*(start/8)>
359 ///////////////////////////////ih.e////////////////////////////////////////
366 // c-file-style: "senf"
367 // indent-tabs-mode: nil
368 // ispell-local-dictionary: "american"
369 // compile-command: "scons -u test"
370 // comment-column: 40