Packets/VariantParser.hh

   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 VariantParser public header */
  25
  26 #ifndef HH_VariantParser_
  27 #define HH_VariantParser_ 1
  28
  29 #ifndef HH_Packets_
  30 #error "Don't include 'VariantParser.hh' directly, include 'Packets.hh'"
  31 #endif
  32
  33 // Custom includes
  34 #include <boost/mpl/vector.hpp>
  35 #include <boost/mpl/at.hpp>
  36 #include <boost/preprocessor/repetition/enum_params_with_a_default.hpp>
  37 #include <boost/preprocessor/repetition/enum_params.hpp>
  38 #include <boost/preprocessor/seq/for_each.hpp>
  39 #include "PacketParser.hh"
  40
  41 //#include "VariantParser.mpp"
  42 ///////////////////////////////hh.p////////////////////////////////////////
  43
  44 namespace senf {
  45
  46 #   ifndef SENF_LIMIT_PARSE_VARIANT
  47         /** \brief Maximum number of senf::VariantParser sub-parsers.
  48
  49             This number defines the maximum number of parser arguments senf::VariantParser takes.
  50          */
  51 #       define SENF_LIMIT_PARSE_VARIANT 6
  52 #   endif
  53
  54     /** \brief Variant parser
  55
  56         This is not really a collection parser (it does not provide a collection
  57         interface). However, it is not a composite parser or value parser either.
  58
  59         A variant parser will parse any number of sub-parsers discriminated by an arbitrary, policy
  60         defined condition. This is the parser to use, if the type and/or number of fields of a
  61         packet change depending on some condition.
  62         \code
  63         typedef senf::VariantParser<
  64             MyAuxPolicy,
  65             senf::mpl::vector<senf::VoidPacketParser, TypeAParser, TypeBParser> > MyVariantParser;
  66         \endcode
  67         This typedef defines a variant parser choosing one of three sub
  68         parsers. senf::VoidPacketParser is an empty parser, it effectively makes this parser
  69         optional.
  70
  71         When creating a new packet containing a variant parser, the variant parser will always be
  72         initialized to the first sub-parser.
  73
  74         \see
  75             ExampleAuxPolicy on how to implement the \a AuxPolicy \n
  76             \ref SENF_PARSER_VARIANT() on how to integrate the parser into another parser
  77         \ingroup parsecollection
  78      */
  79     template <class AuxPolicy, class Parsers>
  80     class VariantParser
  81         : public PacketParserBase, private AuxPolicy
  82     {
  83         typedef Parsers parsers;
  84
  85     public:
  86         ///\name Parser interface
  87         ///\{
  88
  89         VariantParser(data_iterator i, state_type s);
  90         VariantParser(AuxPolicy policy, data_iterator i, state_type s);
  91
  92         size_type bytes() const;
  93         void init();
  94
  95         static const size_type init_bytes = senf::init_bytes<
  96             typename boost::mpl::at<parsers, boost::mpl::int_<0> >::type>::value
  97                 + AuxPolicy::aux_bytes;
  98
  99         ///\}
 100         ///////////////////////////////////////////////////////////////////////////
 101
 102         unsigned variant() const;       ///< Get current variant
 103                                         /**< Get the currently selected variant index. The returned
 104                                              number directly indexes the list of sub parsers.
 105                                              \returns Index of currently selected variant. Integer
 106                                                  in the range from 0 to (number-of-sub-parsers - 1)
 107                                           */
 108
 109         template <unsigned N>
 110         typename boost::mpl::at< parsers, boost::mpl::int_<N> >::type get() const;
 111                                         ///< Access sub-parser
 112                                         /**< This call will return the sub-parser at index \a
 113                                              N. This call will fail, if the currently active
 114                                              variant() is not \a N.
 115                                              \pre variant() == \a N
 116                                              \returns sub-parser at index \a N */
 117
 118         template <unsigned N>
 119         void init();                    ///< Re-initialize field
 120                                         /**< This will reinitialize the field to the variant
 121                                              sub-parser at index \a N changing the currently
 122                                              selected variant.
 123                                              \post variant() == \a N */
 124     };
 125
 126     /** \brief Define VariantParser field
 127
 128         This macro is a special helper to define a senf::DirectVariantParser type field. This is a
 129         variant field which chooses the sub-type by directly taking the value of some other field.
 130
 131         \code
 132         struct SomeParser : public PacketParserBase
 133         {
 134         #   include SENF_PARSER()
 135
 136             SENF_PARSER_PRIVATE_FIELD( type, senf::UInt8Parser );
 137             SENF_PARSER_PRIVATE_VARIANT( content, type,
 138                                             (senf::VoidPacketParser)
 139                                             (senf::UInt8Parser)
 140                                             (senf::UInt16Parser)
 141                                             (senf::UInt24Parser)
 142                                             (senf::UInt32Parser) );
 143
 144             senf::UInt8Parser  uint8()  const { return content().get<1>(); }
 145             senf::UInt16Parser uint16() const { return content().get<2>(); }
 146             senf::UInt24Parser uint24() const { return content().get<3>(); }
 147             senf::UInt32Parser uint32() const { return content().get<4>(); }
 148
 149             void disable()    const { content().init<0>(); }
 150             void set_uint8()  const { content().init<1>(); }
 151             void set_uint16() const { content().init<2>(); }
 152             void set_uint24)  const { content().init<3>(); }
 153             void set_uint23() const { content().init<4>(); }
 154
 155             SENF_PARSER_FINALIZE(SomeParser);
 156         };
 157         \endcode
 158
 159         The variant \c content chooses one of the sub parsers depending on the \c type field. If \c
 160         type is 0, senf::VoidPacketParser is selected, if it is 1, senf::UInt8Parser and so on.
 161
 162         It is customary, to hide the variant parser (by defining it private) and provide more
 163         conveniently named accessors.
 164
 165         Further additional tags are supported which modify the way, the \a chooser field is
 166         interpreted:
 167
 168         <table class="senf fixedcolumn">
 169         <tr><td>\c transform(\a transform, \a size)</td><td>The \a transform is applied to the \a
 170         chooser value, the value is not used directly</td>
 171         </table>
 172
 173         The optional \a transform is a class with the following layout
 174
 175         \code
 176         struct MyTransform
 177         {
 178             typedef ... value_type;
 179             static value_type get(other_type v);
 180             static other_type set(value_type v);
 181         };
 182         \endcode \c other_type is the \a chooser ::\c value_type where as the \c value_type typedef
 183         is the arbitrary return type of the transform.
 184
 185         The tags are applied to the \a chooser parameter:
 186         \code
 187         SENF_PARSER_VARIANT ( content, transform(MyTransform, type_),
 188                                             (senf::VoidPacketParser)
 189                                             (senf::UInt8Parser)
 190                                             (senf::UInt16Parser)
 191                                             (senf::UInt24Parser)
 192                                             (senf::UInt32Parser) );
 193         \endcode
 194
 195         \param[in] name name of the field
 196         \param[in] chooser name of the field choosing the variant to use
 197         \param[in] types a Boost.Preprocessor style sequence of sub-parser types
 198
 199         \see
 200             senf::VariantParser \n
 201             \ref SENF_PARSER_PRIVATE_VARIANT()
 202         \hideinitializer
 203         \ingroup packetparsermacros
 204      */
 205 #   define SENF_PARSER_VARIANT(name, chooser, types) \
 206         SENF_PARSER_VARIANT_I(public, name, chooser, types)
 207
 208     /** \brief Define private VariantParser field
 209
 210         \see \ref SENF_PARSER_VARIANT()
 211         \hideinitializer
 212         \ingroup packetparsermacros
 213      */
 214 #   define SENF_PARSER_PRIVATE_VARIANT(name, chooser, types) \
 215         SENF_PARSER_VARIANT_I(private, name, chooser, types)
 216 }
 217
 218 ///////////////////////////////hh.e////////////////////////////////////////
 219 #endif
 220 #if !defined(HH_Packets__decls_) && !defined(HH_VariantParser_i_)
 221 #define HH_VariantParser_i_
 222 //#include "VariantParser.cci"
 223 #include "VariantParser.ct"
 224 #include "VariantParser.cti"
 225 #endif
 226
 227 \f
 228 // Local Variables:
 229 // mode: c++
 230 // fill-column: 100
 231 // comment-column: 40
 232 // c-file-style: "senf"
 233 // indent-tabs-mode: nil
 234 // ispell-local-dictionary: "american"
 235 // compile-command: "scons -u test"
 236 // End: