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                                             (novalue( disable, senf::VoidPacketParser ))
 139                                             (     id( uint8,   senf::UInt8Parser      ))
 140                                             (     id( uint16,  senf::UInt16Parser     ))
 141                                             (     id( uint24,  senf::UInt24Parser     ))
 142                                             (     id( uint32,  senf::UInt32Parser     )) );
 143
 144             SENF_PARSER_FINALIZE(SomeParser);
 145         };
 146         \endcode
 147
 148         The variant \c content chooses one of the sub parsers depending on the \c type field. If \c
 149         type is 0, senf::VoidPacketParser is selected, if it is 1, senf::UInt8Parser and so on.
 150
 151         The \a types parameter specifies the types of sub-objects supported by this variant
 152         parser. This parameter is a (Boost.Preprocessor style) sequence
 153         <pre>(\a type) (\a type) ...</pre>
 154         of parser types with additional optional information:
 155
 156         <table class="senf fixedcolumn">
 157         <tr><td>\a type</td><td>Do not provide accessor and use the 0-based type index as
 158         key.</td></tr>
 159
 160         <tr><td>\c id(\a name, \a type)</td><td>Automatically create an accessor \a name for this
 161         type</td></tr>
 162
 163         <tr><td>\c novalue(\a name, \a type)</td><td>This is like \c id but only provides an
 164         initializer called \a name and no accessor</td></tr>
 165
 166         <tr><td>\c key(\a value, \a type)</td><td>Use \a value to identity this type. The type is
 167         selected, when the \a chooser is equal to \a value</td></tr>
 168
 169         <tr><td>\c id(\a name, \c key(\a value, \a type))<br/>\c novalue(\a name, \c key(\a value,
 170         \a type))</td><td>The options may be nested in this way.</td></tr> </table>
 171
 172         It is customary, to hide the variant parser (by defining it private) and provide
 173         more conveniently named accessors. In above example, these accessors are automatically
 174         generated using the id's given. The exact members defined are:
 175
 176         <table class="senf fixedcolumn">
 177         <tr><td>\a name \c _t</td><td>The type for this specific variant value if not \c
 178         novalue.</td></tr>
 179
 180         <tr><td><em>name</em><tt>_t</tt> <em>name</em>()</td><td>Return the variant value at this id
 181         if not \c novalue.</td></tr>
 182
 183         <tr><td><tt>void</tt> <tt>init_</tt><em>name</em>()</td><td>Set the variant to have a value
 184         of this type. If the field is \c novalue, the \c init_ prefix is omitted.</td></tr>
 185
 186         <tr><td><tt>bool</tt> <tt>has_</tt><em>name</em>()</td><td>Return \c true, if the variant
 187         currently holds this kind of value, \c false otherwise. Only if not \c novalue.</td></tr>
 188         </table>
 189
 190         If \a value keys are given, they designate the value to expect in the \a chooser field to
 191         select a specific variant type. If the \a chooser value does not match any key, the variant
 192         will be initialized to the \e first type.
 193
 194         Further additional tags are supported which modify the way, the \a chooser field is
 195         interpreted:
 196
 197         <table class="senf fixedcolumn">
 198         <tr><td>\c transform(\a transform, \a chooser)</td><td>The \a transform is applied to the \a
 199         chooser value, the value is not used directly</td>
 200         </table>
 201
 202         The optional \a transform is a class with the following layout
 203
 204         \code
 205         struct MyTransform
 206         {
 207             typedef ... value_type;
 208             static value_type get(other_type v);
 209             static other_type set(value_type v);
 210         };
 211         \endcode \c other_type is the \a chooser ::\c value_type whereas the \c value_type typedef
 212         is the arbitrary return type of the transform.
 213
 214         The tags are applied to the \a chooser parameter:
 215         \code
 216         SENF_PARSER_VARIANT ( content, transform(MyTransform, type),
 217                                             (senf::VoidPacketParser)
 218                                             (senf::UInt8Parser)
 219                                             (senf::UInt16Parser)
 220                                             (senf::UInt24Parser)
 221                                             (senf::UInt32Parser) );
 222         \endcode
 223
 224         \param[in] name name of the field
 225         \param[in] chooser name of the field choosing the variant to use
 226         \param[in] types a Boost.Preprocessor style sequence of sub-parser types
 227
 228         \see
 229             senf::VariantParser \n
 230             \ref SENF_PARSER_PRIVATE_VARIANT()
 231         \hideinitializer
 232         \ingroup packetparsermacros
 233      */
 234 #   define SENF_PARSER_VARIANT(name, chooser, types) \
 235         SENF_PARSER_VARIANT_I(public, name, chooser, types)
 236
 237     /** \brief Define private VariantParser field
 238
 239         \see \ref SENF_PARSER_VARIANT()
 240         \hideinitializer
 241         \ingroup packetparsermacros
 242      */
 243 #   define SENF_PARSER_PRIVATE_VARIANT(name, chooser, types) \
 244         SENF_PARSER_VARIANT_I(private, name, chooser, types)
 245 }
 246
 247 ///////////////////////////////hh.e////////////////////////////////////////
 248 #endif
 249 #if !defined(HH_Packets__decls_) && !defined(HH_VariantParser_i_)
 250 #define HH_VariantParser_i_
 251 //#include "VariantParser.cci"
 252 #include "VariantParser.ct"
 253 #include "VariantParser.cti"
 254 #endif
 255
 256 \f
 257 // Local Variables:
 258 // mode: c++
 259 // fill-column: 100
 260 // comment-column: 40
 261 // c-file-style: "senf"
 262 // indent-tabs-mode: nil
 263 // ispell-local-dictionary: "american"
 264 // compile-command: "scons -u test"
 265 // End: