Packets/PacketParser.hh

   1 // Copyright (C) 2007
   2 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   3 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   4 //     Stefan Bund <g0dil@berlios.be>
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 2 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the
  18 // Free Software Foundation, Inc.,
  19 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20
  21 /** \file
  22     \brief PacketParser public header */
  23
  24 /** \defgroup packetparser The PacketParser facility
  25
  26     The PacketParser facility provides a framework to implement very lightweight classes which parse
  27     the raw content of a packet into meaningful values. PacketParsers are always passed around
  28     <em>by value</em>, they can be understood as pointers into the packet data with added type
  29     information providing parsing functions.
  30
  31     Packet parsers are \e only used within the packet framework. You should never allocate a new
  32     parser instance directly, you should the Packet library let that do for you (either by having
  33     the parser as a packet parser in a packet type or by having a member in the packet parser which
  34     allocates the parser as a sub-parser).
  35
  36     Parsers are built hierarchically. A high-level parser will return other parsers when accessing
  37     an element (Example: Asking an EthernetParser for the ethertype field by calling the parsers \c
  38     type() member will return an \c UInt16 parser). The lowest level building blocks then return the
  39     values. This hierarchical structure greatly simplifies building complex parsers.
  40
  41     Since parsers are very lightweight and are passed by value, packet fields are accessed using the
  42     corresponding accessor method:
  43     \code
  44       SomePacket p (...)
  45       SomePacket q (...)
  46
  47       // Assign new value to an integer parser
  48       p->someField() = 10;
  49
  50       // Write out above value
  51       std::cerr << p->someField() << "\n";
  52
  53       // Use the generic parser-assignment operator '<<' to copy field values
  54       p->someVector()[1].someOtherField() << q->someField();
  55       p->someVector() << q->someVector()
  56     \endcode
  57
  58     Here \c someField(), \c someOtherField() and \c someVector() are accessor methods named after
  59     the field name. Each returns a parser object. Simple parsers can be used like their
  60     corresponding basic type (e.g. a Parse_UInt16 field can be used like an unsigned integer), more
  61     complex parsers provide type specific access members. Assigning a value to a parser will change
  62     the underlying representation (the packet data).
  63
  64     Parsers can be grouped into several categories. These categories are not all defined rigorously
  65     but are nevertheless helpful when working with the parsers:
  66     \li <em>\ref parserimpl_value</em> provide the lowest level parsers (e.g. senf::Parse_UInt16 which
  67         returns an integer value).
  68     \li <em>\ref parserimpl_collection</em> are parsers which model a collection of sub-elements like
  69         senf::Parse_List or senf::Parse_Vector.
  70     \li <em>\ref parserimpl_composite</em> collect several fields of arbitrary type into a new
  71         parser. Parsers defined using the \ref packetparsermacros fall under this category.
  72     \li <em>\ref parserimpl_packet</em> are used to define a packet type.
  73
  74     \warning Parsers are like iterators: They are invalidated <em>whenever the size of the packet's
  75     data is changed</em>. You should not store a parser anywhere. If you want to keep a parser
  76     reference, use the senf::SafePacketParser wrapper. You still will need to take extra care to
  77     ensure the parser is not invalidated.
  78
  79     \section parserimpl Packet parser categories
  80
  81     Every parser is derived from senf::PacketParserBase. This class provides the necessary
  82     housekeeping information and provides the parsers with access to the data. You may in principle
  83     define arbitrary methods as parser members (e.g. methods to calculate a checksum, methods
  84     processing fields in some way and so on). You should however be very wary to access data outside
  85     the range assigned to the packet (the range starting at \c i() and with a size of senf::bytes()
  86     bytes).
  87
  88     Each parser type has specific features
  89
  90     \subsection parserimpl_value Value parsers
  91
  92     For a parser \a SomeParser to be a value parser, the following expressions must be valid:
  93     \code
  94     // SomeParser must have a 'value_type', The 'value_type' must be default constructible, copy
  95     // constructible and assignable
  96     SomeParser::value_type v;
  97
  98     // An instance of 'SomeParser' must have a 'value' member which returns a value which may be
  99     // assigned to a variable of type 'value_type'
 100     v = p.someParserField().value()
 101
 102     // It must be possible to assign a new value using the 'value' member
 103     p.someParserField().value(v)
 104     \endcode
 105
 106     If at all possible, the 'value_type' should not reference the packet data using iterators or
 107     pointers, it should hold a copy of the value (it's Ok for \c value() to return such a reference
 108     as long as assigning it to a \c value_type variable will copy the value).
 109
 110     \subsection parserimpl_collection Collection parsers
 111
 112     A collection parser \a SomeParser should model STL containers. The parsers themselves will
 113     probably only // provide a reduced interface, but the collection parser should have a \c
 114     collection member which is a wrapper providing the full interface.
 115     \code
 116     SomeParser::container c (p.someParserField());
 117     \endcode
 118
 119     You will probably only very seldom need to implement a completely new collection
 120     parser. Instead, you can rely on senf::Parse_Vector or senf::Parse_List and implement new
 121     policies.
 122
 123     \subsection parserimpl_composite Composite parsers
 124
 125     If possible, composite parsers should be implemented using the \ref packetparsermacros. In
 126     addition to the normal parser requirements, these macros ensure, that for each field,
 127     <em>fieldname</em><tt>_t</tt> is a typedef for the fields parser and
 128     <em>fieldname</em><tt>_offset</tt> is the offset of the field in bytes from the beginning of the
 129     parser (either a constant for fixed size parsers or a member function for dynamically sized
 130     parsers). When defining composite parsers without the help of the \ref packetparsermacros, you
 131     should provide those same members.
 132
 133     \subsection parserimpl_packet Packet parsers
 134
 135     Packet parsers are composite parsers with relaxed requirements. Since a packet parser will never
 136     be used as a sub-parser (it will not be used within another composite parser or as value type in
 137     a collection parser), the value returned by senf::bytes for this parser must not necessarily
 138     cover the complete packet (e.g. if the packet has a trailer, the trailer will live outside the
 139     range given by senf::bytes). You may define any member you want to have in your packets field
 140     interface. These members may access the packet data in any way. You just need to ensure, that
 141     the integration into the packet-type is correct (the senf::PacketTypeMixin will by default use
 142     senf::bytes() to find the end of the header).
 143
 144     <hr>
 145  */
 146
 147 #ifndef HH_PacketParser_
 148 #define HH_PacketParser_ 1
 149
 150 // Custom includes
 151 #include <boost/utility/enable_if.hpp>
 152 #include <boost/type_traits.hpp>
 153 #include <boost/optional.hpp>
 154 #include "../Utils/SafeBool.hh"
 155 #include "PacketTypes.hh"
 156 #include "PacketData.hh"
 157
 158 #include "PacketParser.mpp"
 159 ///////////////////////////////hh.p////////////////////////////////////////
 160
 161 namespace senf {
 162
 163     /** \brief Parser Base class
 164
 165         Parsers come in two flavors: fixed and dynamically sized parsers. A <em>fixed size
 166         parser</em> has a constant size, it will always parse a fixed number of bytes. The low-level
 167         'final'  parsers (like the integer parsers) are fixed size parsers as are composite parsers
 168         built up only of fixed-size fields.
 169
 170         A <em>dynamically sized</em> parser on the other hand infers it's size from the contents of
 171         the data parsed. Any parser containing at least one dynamically sized sub-parser will itself
 172         be dynamically sized.
 173
 174         Both kinds of parser need to derive from PacketParserBase and implement several required
 175         members. Which members to implement depends on the parsers flavor. There are two ways how to
 176         do this.
 177         \li If the parser just consists of a simple sequence of consecutive fields (sub-parsers),
 178             the \ref SENF_PACKET_PARSER_DEFINE_FIELDS and \ref
 179             SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS macros provide a simple and convenient way to
 180             define the packet
 181         \li In more complex cases, you need to implement the necessary members manually.
 182
 183         This documentation is about the manual implementation. You should nevertheless read through
 184         this to understand, what above macros are doing.
 185
 186         The following example documents the interface (which must be) provided by a parser:
 187         \code
 188           struct FooParser : public PacketParserBase
 189           {
 190               FooParser(data_iterator i, state_type s) : PacketParserBase(i,s) {}
 191
 192               // If this parser has a fixed size, you must define this size here This definition
 193               // allows the parser to be used within the list, vector and array parsers static
 194               static const size_type fixed_bytes = some_constant_size;
 195
 196               // If the parser does not have a fixed size, you must implement the bytes() member to
 197               // return the size. ONLY EVER DEFINE ONE OF fixed_bytes OR bytes().
 198               size_type bytes() const;
 199
 200               // If you define bytes(), you also need to define the init_bytes. This is the number
 201               // of bytes to allocate when creating a new object
 202               static const size_type init_bytes = some_constant_size;
 203
 204               // You also may define an init() member. This will be called to initialize a newly
 205               // created data object. The default implementation just does nothing.
 206               void init() const;
 207
 208               // ////////////////////////////////////////////////////////////////////////
 209
 210               // Add here members returning (sub-)parsers for the fields. The 'parse' member is
 211               // used to construct the sub-parsers. This member either takes an iterator to the
 212               // data to be parsed or just an offset in bytes.
 213
 214               senf::Parse_UInt16 type() const { return parse<Parse_UInt16>( 0 ); }
 215               senf::Parse_UInt16 size() const { return parse<Parse_UInt16>( 2 ); }
 216           };
 217         \endcode
 218
 219         You should never call the \c bytes() member of a parser directly. Instead you should use the
 220         freestanding senf::bytes() function. This function will return the correct size irrespective
 221         of the parsers flavor. You may access \c fixed_bytes directly, however be aware that this
 222         will restrict your code to fixed size parsers (which depending on the circumstances may be
 223         exactly what you want).
 224
 225         In the same way, don't access \c init_bytes directly, always use the senf::init_bytes
 226         meta-function class which correctly supports fixed size parsers.
 227
 228         \ingroup packetparser
 229       */
 230     class PacketParserBase
 231     {
 232     public:
 233         ///////////////////////////////////////////////////////////////////////////
 234         // Types
 235
 236         typedef detail::packet::iterator data_iterator; ///< Raw data iterator type
 237         typedef detail::packet::size_type size_type; ///< Unsigned integral type
 238         typedef detail::packet::difference_type difference_type; ///< Signed integral type
 239         typedef detail::packet::byte byte; ///< Unsigned 8bit value, the raw value type
 240         typedef PacketData * state_type; ///< Type of the 'state' parameter
 241
 242         ///////////////////////////////////////////////////////////////////////////
 243         ///\name Structors and default members
 244         ///@{
 245
 246         // no default constructor
 247         // default copy
 248         // default destructor
 249         // no conversion constructors
 250
 251         ///@}
 252         ///////////////////////////////////////////////////////////////////////////
 253
 254         data_iterator i() const;        ///< Return beginning of data to parse
 255                                         /**< The parser is expected to interpret the data beginning
 256                                              here. The size of the interpreted is given by
 257                                              <tt>senf::bytes(</tt><em>parser
 258                                              instance</em><tt>)</tt>. */
 259         state_type state() const;       ///< Return state of this parser
 260                                         /**< The value returned should be interpreted as an opaque
 261                                              value provided just to be forwarded to other
 262                                              parsers. */
 263         PacketData & data() const;      ///< Access the packets raw data container
 264                                         /**< This member will return the raw data container holding
 265                                              the data which is parsed by \c this parser. */
 266
 267         void init() const;              ///< Default implementation
 268                                         /**< This is just an empty default
 269                                              implementation. Re-implement this member in your own
 270                                              parsers if needed. */
 271
 272     protected:
 273         PacketParserBase(data_iterator i, state_type s); ///< Standard constructor
 274                                         /**< This is the constructor used by most parsers. The
 275                                              parameters are just forwarded from the derived classes
 276                                              constructor parameters. */
 277         PacketParserBase(data_iterator i, state_type s, size_type size);
 278                                         ///< Size checking constructor
 279                                         /**< In addition to the standard constructor, this
 280                                              constructor will validate, that there is enough data in
 281                                              the raw data container to parse \a size bytes after \a
 282                                              i.
 283
 284                                              This constructor is called by all 'final' parsers
 285                                              (e.g. the integer parsers) and \e only by those
 286                                              parsers. Most parsers do \e not check the validity of
 287                                              the iterator, this is delayed until the very last
 288                                              parser. This allows to partial parse truncated
 289                                              packets.
 290
 291                                              \throw TruncatedPacketException if the raw data
 292                                                  container does not hold at least \a size bytes
 293                                                  beginning at \a i. */
 294
 295         bool check(size_type size);     ///< Check size of data container
 296                                         /**< \returns \c true, if the data container holds at least
 297                                              \a size beginning at i(), \c false otherwise. */
 298         void validate(size_type size);  ///< Validate size of data container
 299                                         /**< \throws TruncatedPacketException if the raw data
 300                                              container does not hold at least \a size bytes
 301                                              beginning at i(). */
 302
 303         template <class Parser> Parser parse(data_iterator i) const; ///< Create sub-parser
 304                                         /**< Creates a new instance of \a Parser to parse data
 305                                              beginning at \a i. Automatically passes \a state() to
 306                                              the new parser. */
 307         template <class Parser> Parser parse(size_type n) const; ///< Create sub-parser
 308                                         /**< Creates a new instance of \a Parser to parse data
 309                                          * beginning at i()<tt> + </tt>\a n. Automatically passes \a
 310                                              state() to the new parser. */
 311
 312         void defaultInit() const;       ///< Default implementation
 313                                         /**< This is just an empty default
 314                                              implementation. Re-implement this member in your own
 315                                              parsers if needed. */
 316
 317     private:
 318         data_iterator end();
 319
 320         data_iterator i_;
 321         PacketData * data_;
 322
 323         template <class Parser> friend class SafePacketParser;
 324     };
 325
 326     /** \brief Return raw size parsed by the given parser object
 327
 328         This function will either call <tt>p.bytes()</tt> or return <tt>Parser::fixed_bytes</tt>
 329         depending on the type of parser.
 330
 331         The value returned does \e not take into account the amount of data actually available. So
 332         you always need to validate this value against the packet size if you directly access the
 333         data. The standard low-level parses all do this check automatically to guard against
 334         malformed packets.
 335
 336         \param[in] p Parser object to check
 337         \returns number of bytes this parser expects to parser
 338         \ingroup packetparser
 339      */
 340     template <class Parser>
 341     PacketParserBase::size_type bytes(Parser p);
 342
 343     namespace detail { template <class Parser> class ParserInitBytes; }
 344
 345     /** \brief Return number of bytes to allocate to new object of given type
 346
 347         This meta-function is called like
 348         \code
 349             senf::init_bytes<SomeParser>::value
 350         \endcode
 351
 352         This expression evaluates to a compile-time constant integral expression of type
 353         senf::PacketParserBase::size_type. This meta-function will return \c Parser::fixed_bytes or
 354         \c Parser::init_bytes depending on the type of parser.
 355
 356         \param[in] Parser The Parser to return init_bytes for
 357         \returns Number of bytes to allocate to the new object
 358         \ingroup packetparser
 359      */
 360     template <class Parser>
 361     struct init_bytes : public detail::ParserInitBytes<Parser>
 362     {};
 363
 364 #   ifndef DOXYGEN
 365     template <class Parser>
 366     typename boost::enable_if<
 367         boost::is_base_of<PacketParserBase, Parser>,
 368         Parser >::type
 369     operator<<(Parser target, Parser source);
 370 #   else
 371     /** \brief Generic parser copying
 372
 373
 374         This operator allows to copy the values of identical parsers. This operation does \e not
 375         depend on the parsers detailed implementation, it will just replace the data bytes of the
 376         target parser with those from the source parser. This allows to easily copy around complex
 377         packet substructures.
 378
 379         This operation is different from the ordinary assignment operator: It does not change the \a
 380         target parser, it changes the data referenced by the \a target parser.
 381
 382         \ingroup packetparser
 383      */
 384     template <class Parser>
 385     Parser operator<<(Parser target, Parser source);
 386 #   endif
 387
 388 #   ifndef DOXYGEN
 389     template <class Parser, class Value>
 390     typename boost::enable_if_c <
 391         boost::is_base_of<PacketParserBase, Parser>::value
 392             && ! boost::is_base_of<PacketParserBase, Value>::value,
 393         Parser >::type
 394     operator<<(Parser target, Value const & value);
 395 #   else
 396     /** \brief Generic parser value assignment
 397
 398         This operator allows to assign a value to parsers which implement a <tt>value(</tt>\a
 399         value<tt>)</tt> member. This operator allows to use a common syntax for assigning values or
 400         parsers to a parser.
 401
 402         \ingroup packetparser
 403      */
 404     template <class Parser, class Value>
 405     Parser operator<<(Parser target, Value const & value);
 406 #   endif
 407
 408 #   ifndef DOXYGEN
 409     template <class Parser, class Value>
 410     typename boost::enable_if_c <
 411         boost::is_base_of<PacketParserBase, Parser>::value
 412             && ! boost::is_base_of<PacketParserBase, Value>::value,
 413         Parser >::type
 414     operator<<(Parser target, boost::optional<Value> const & value);
 415 #   else
 416     /** \brief Generic parser value assignment
 417
 418         This operator allows to assign a value to parsers which implement a <tt>value(</tt>\a
 419         value<tt>)</tt> member. This special version allows to assign optional values: IF the
 420         optional value is not set, the assignment will be skipped.
 421
 422         This operator allows to use a common syntax for assigning values or parsers to a parser.
 423
 424         \ingroup packetparser
 425      */
 426     template <class Parser, class Value>
 427     Parser operator<<(Parser target, boost::optional<Value> const & value);
 428 #   endif
 429
 430     /** \defgroup packetparsermacros Helper macros for defining new packet parsers
 431
 432         To simplify the definition of simple packet parsers, several macros are provided. Before
 433         using these macros you should familiarize yourself with the packet parser interface as
 434         described in senf::PacketParserBase.
 435
 436         These macros simplify providing the above defined interface. A typical packet declaration
 437         using these macros has the following form (This is a concrete example from the definition of
 438         the ethernet packet in <tt>DefaultBundle/EthernetPacket.hh</tt>)
 439
 440         \code
 441         struct Parse_EthVLan : public PacketParserBase
 442         {
 443             typedef Parse_UIntField < 0,  3 > Parse_Priority;
 444             typedef Parse_Flag          < 3 > Parse_CFI;
 445             typedef Parse_UIntField < 4, 16 > Parse_VLanId;
 446             typedef Parse_UInt16              Parse_Type;
 447
 448             SENF_PACKET_PARSER_INIT(Parse_EthVLan);
 449
 450             SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
 451                 ((OverlayField)( priority, Parse_Priority ))
 452                 ((OverlayField)( cfi,      Parse_CFI      ))
 453                 ((Field       )( vlanId,   Parse_VLanId   ))
 454                 ((Field       )( type,     Parse_Type     )) );
 455         };
 456         \endcode
 457
 458         The macros take care of the following:
 459         \li They define the accessor functions returning parsers of the given type.
 460         \li They automatically calculate the offset of the fields from the preceding fields.
 461         \li The macros provide a definition for \c init()
 462         \li The macros define the \c bytes(), \c fixed_bytes and \c init_bytes members as needed.
 463
 464         You may define either a fixed or a dynamically sized parser. Fixed size parsers are defined
 465         using \ref SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS, dynamically sized parsers are defined
 466         using \ref SENF_PACKET_PARSER_DEFINE_FIELDS. The different members are implemented such
 467         that:
 468
 469         \li The needed parser constructor is defined
 470         \li \c init() calls \c defaultInit(). \c defaultInit() is defined to call \c init() on each
 471             of the fields.
 472         \li \c bytes() (on dynamically sized parser) respectively \c fixed_bytes (on fixed size
 473             parsers) is defined to return the sum of the sizes of all fields.
 474         \li On dynamically sized parsers, \c init_bytes is defined to return the sum of the
 475             \c init_size's of all fields
 476
 477         The central definition macros are \ref SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS and \ref
 478         SENF_PACKET_PARSER_DEFINE_FIELDS. The argument to both has the same structure. It is a
 479         (boost preprocessor style) sequence of field definitions where each field definition
 480         provides the builder macro to use and the name and type of the field to define:
 481         \code
 482           SENF_PACKET_PARSER_DEFINE[_FIXED]_FIELDS(
 483               (( <builder> )( <name>, <type> ))
 484               ...
 485           )
 486         \endcode
 487
 488         For each field, this command will define
 489         \li A method \a name() returning an instance of the \a type parser
 490         \li \a name<tt>_t</tt> as a typedef for \a type, the fields value
 491         \li \a name<tt>_offset</tt> to give the offset of the field from the beginning of the
 492             parser. If the parser is a fixed size parser, this will be a static constant, otherwise
 493             it will be a method.
 494
 495         The \a builder argument selects, how the field is defined
 496         \li <tt>Field</tt> defines a field and increments the current position by the size of the
 497             field
 498         \li <tt>OverlayField</tt> defines a field like <tt>Field</tt> but does \e not increment the
 499             position. In the above example, this is used to overlay the different bitfield parsers:
 500             All overlaying bitfield parser except the last one (the one with the highest bit
 501             numbers) is marked as OverlayField.
 502
 503         The \a name argument defines the name of the accessor method.
 504
 505         The \a type argument is the parser to return for that field. Since none of the arguments may
 506         contain a comma, <em>This argument cannot be a multi-parameter template</em>. Always use
 507         typedefs to access templated parsers as shown above.
 508
 509         The \ref SENF_PACKET_PARSER_INIT macro defines the constructor and the \c init() member. If
 510         you want to provide your own \c init() implementation, use \ref
 511         SENF_PACKET_PARSER_NO_INIT. The first statement in your init method should probably to call
 512         \c defaultInit(). This will call the \c init() member of all the fields. Afterwards you can
 513         set up the field values as needed:
 514         \code
 515           struct SomePacket : public senf::PacketParserBase
 516           {
 517               SENF_PACKET_PARSER_NO_INIT(SomePacket);
 518
 519               typedef senf::Parse_UInt8 Parse_Type;
 520               typedef senf::Parse_Vector< senf::Parse_UInt32,
 521                                           senf::SimpleVectorSizer<senf::Parse_UInt16>
 522                                         > Parse_Elements;
 523
 524               SENF_PACKET_PARSER_DEFINE_FIELDS(
 525                   ((Field)( type,     Parse_Type     ))
 526                   ((Field)( elements, Parse_Elements ))
 527               );
 528
 529               void init() const {
 530                   defaultInit();
 531                   type() = 0x01;
 532                   elements().push_back(0x01020304u);
 533               }
 534           }
 535         \endcode
 536
 537         \ingroup packetparser
 538      */
 539
 540     /** \brief Define initialization members of a parser
 541
 542         This macro defines the packet parser constructor and the \c init() member. \c init() is
 543         defined to just call \c defaultInit() which is defined by the other macros to call \c init()
 544         on each of the parsers fields.
 545
 546         \ingroup packetparsermacros
 547         \hideinitializer
 548      */
 549 #   define SENF_PACKET_PARSER_INIT(name)                                                          \
 550     name(data_iterator i, state_type s) : senf::PacketParserBase(i,s) {}                          \
 551     void init() const { defaultInit(); }
 552
 553     /** \brief Define initialization members of a parser except init()
 554
 555         This macro is like SENF_PACKET_PARSER_INIT but does \e not define \c init(). This allows you
 556         to provide your own implementation. You should call \c defaultInit() first before
 557         initializing your data fields.
 558
 559         \ingroup packetparsermacros
 560         \hideinitializer
 561      */
 562 #   define SENF_PACKET_PARSER_NO_INIT(name)                                                       \
 563     name(data_iterator i, state_type s) : senf::PacketParserBase(i,s) {}
 564
 565     /** \brief Define fields for a dynamically sized parser
 566
 567         Define the fields as specified in \a fields. This macro supports dynamically sized
 568         subfields, the resulting parser will be dynamically sized.
 569
 570         \ingroup packetparsermacros
 571         \hideinitializer
 572      */
 573 #   define SENF_PACKET_PARSER_DEFINE_FIELDS(fields)                                               \
 574     SENF_PACKET_PARSER_I_DEFINE_FIELDS(0,fields)
 575
 576     /** \brief Define fields for a dynamically sized parser (with offset)
 577
 578         Define the fields as specified in \a fields. This macro supports dynamically sized
 579         subfields, the resulting parser will be dynamically sized.
 580
 581         The \a offset argument gives the byte offset at which to start parsing the fields. This
 582         helps defining extended parser deriving from a base parser:
 583         \code
 584            struct ExtendedParser : public BaseParser
 585            {
 586                ExtendedParser(data_iterator i, state_type s) : BaseParser(i,s) {}
 587
 588                SENF_PACKET_PARSER_DEFINE_FIELDS_OFFSET(senf::bytes(BaseParser(*this)),
 589                  ( ... fields ... ) );
 590
 591                void init() {
 592                    BaseParser::init();
 593                    defaultInit();
 594                    // other init code
 595                }
 596            }
 597         \endcode
 598
 599         \ingroup packetparsermacros
 600         \hideinitializer
 601      */
 602 #   define SENF_PACKET_PARSER_DEFINE_FIELDS_OFFSET(offset,fields)                                 \
 603     SENF_PACKET_PARSER_I_DEFINE_FIELDS(offset,fields)
 604
 605     /** \brief Define fields for a fixed size parser
 606
 607         Define the fields as specified in \a fields. This macro only supports fixed size
 608         subfields, the resulting parser will also be a fixed size parser.
 609
 610         \ingroup packetparsermacros
 611         \hideinitializer
 612      */
 613 #   define SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(fields)                                         \
 614     SENF_PACKET_PARSER_I_DEFINE_FIXED_FIELDS(0,fields)
 615
 616     /** \brief Define fields for a fixed size parser
 617
 618         Define the fields as specified in \a fields. This macro only supports fixed size
 619         subfields, the resulting parser will also be a fixed size parser.
 620
 621         The \a offset argument gives the byte offset at which to start parsing the fields. This
 622         helps defining extended parser deriving from a base parser:
 623         \code
 624            struct ExtendedParser : public BaseParser
 625            {
 626                ExtendedParser(data_iterator i, state_type s) : BaseParser(i,s) {}
 627
 628                SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS_OFFSET(BaseParser::fixed_bytes,
 629                  ( ... fields ... ) );
 630
 631                void init() {
 632                    BaseParser::init();
 633                    defaultInit();
 634                    // other init code
 635                }
 636            }
 637         \endcode
 638
 639         \ingroup packetparsermacros
 640         \hideinitializer
 641      */
 642 #   define SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS_OFFSET(offset,fields)                           \
 643     SENF_PACKET_PARSER_I_DEFINE_FIXED_FIELDS(offset,fields)
 644
 645     /** \brief Default parser parsing nothing
 646      */
 647     struct VoidPacketParser
 648         : public PacketParserBase
 649     {
 650         SENF_PACKET_PARSER_INIT(VoidPacketParser);
 651     };
 652
 653     /** \brief Iterator re-validating Parser wrapper
 654
 655         An ordinary parser will be invalidated whenever the raw data container's size is
 656         changed. This can complicate some algorithms considerably.
 657
 658         This wrapper will update the parsers iterator (the value returned by the i() member) on
 659         every access. This ensures that the iterator will stay valid.
 660
 661         \attention Beware however, if you insert or remove data before the safe wrapper, the
 662             location will \e not be updated accordingly and therefore the parser will be
 663             invalid.
 664
 665         Additionally a SafePacketParser has an uninitialized state. The only allowed operations in
 666         this state are the boolean test for validity and assigning another parser.
 667
 668         \ingroup packetparser
 669       */
 670     template <class Parser>
 671     class SafePacketParser
 672         : public SafeBool< SafePacketParser<Parser> >
 673     {
 674     public:
 675         ///////////////////////////////////////////////////////////////////////////
 676         // Types
 677
 678         ///////////////////////////////////////////////////////////////////////////
 679         ///\name Structors and default members
 680         ///@{
 681
 682         // default copy constructor
 683         // default copy assignment
 684         // default destructor
 685         SafePacketParser();             ///< Create an empty uninitialized SafePacketParser
 686
 687         // conversion constructors
 688         SafePacketParser(Parser parser); ///< Initialize SafePacketParser from \a parser
 689
 690         SafePacketParser & operator=(Parser parser); ///< Assign \a parser to \c this
 691
 692         ///@}
 693         ///////////////////////////////////////////////////////////////////////////
 694
 695         Parser operator*() const;       ///< Access the stored parser
 696                                         /**< On every access, the stored parsers iterator will be
 697                                              updated / re-validated. */
 698         Parser const * operator->() const; ///< Access the stored parser
 699                                         /**< On every access, the stored parsers iterator will be
 700                                              updated / re-validated. */
 701         bool boolean_test() const;      ///< Check validity
 702
 703     protected:
 704
 705     private:
 706         mutable boost::optional<Parser> parser_;
 707         senf::safe_data_iterator i_;
 708     };
 709
 710 }
 711
 712 ///////////////////////////////hh.e////////////////////////////////////////
 713 #endif
 714 #if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_PacketParser_i_)
 715 #define HH_PacketParser_i_
 716 #include "PacketParser.cci"
 717 #include "PacketParser.ct"
 718 #include "PacketParser.cti"
 719 #endif
 720
 721 \f
 722 // Local Variables:
 723 // mode: c++
 724 // fill-column: 100
 725 // c-file-style: "senf"
 726 // indent-tabs-mode: nil
 727 // ispell-local-dictionary: "american"
 728 // compile-command: "scons -u test"
 729 // comment-column: 40
 730 // End:
 731