senf/Packets/GenericTLV.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Thorsten Horstmann <tho@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 GenericTLV public header */
  25
  26 #ifndef HH_SENF_Packets_GenericTLV_
  27 #define HH_SENF_Packets_GenericTLV_ 1
  28
  29 // Custom includes
  30 #include <boost/ptr_container/ptr_map.hpp>
  31 #include <senf/Packets/Packets.hh>
  32 #include <senf/Utils/type_traits.hh>
  33 #include <senf/Utils/singleton.hh>
  34
  35 //#include "GenericTLV.hh.mpp"
  36 ///////////////////////////////hh.p////////////////////////////////////////
  37
  38 namespace senf {
  39
  40     /** \brief Base class for generic TLV parsers
  41
  42        This abstract base class can be used to define generic TLV parsers. The following
  43        class structure is assumed:
  44        \image html GenericTLV.png
  45
  46         Your TLVParser base class has to define a \c type and a \c length field:
  47         \code
  48         struct MyTLVParserBase : public senf::PacketParserBase
  49         {
  50         #   include SENF_PARSER()
  51             SENF_PARSER_FIELD    ( type,   senf::UInt8Parser );
  52             SENF_PARSER_FIELD_RO ( length, senf::UInt8Parser );
  53             SENF_PARSER_FINALIZE ( MyTLVParserBase           );
  54         };
  55         \endcode
  56
  57         Your concrete TLV parsers will inherit from this base class and have to define a specific
  58         value field and a \c typeId member:
  59         \code
  60         struct MyConcreteTLVParser : public MyTLVParserBase
  61         {
  62         #   include SENF_PARSER()
  63             SENF_PARSER_INHERIT  ( MyTLVParserBase             );
  64             SENF_PARSER_FIELD    ( myValue, senf::UInt32Parser );
  65             SENF_PARSER_FINALIZE ( MyConcreteTLVParser         );
  66
  67             SENF_PARSER_INIT() {
  68                 type() = typeId;
  69                 length_() = 4;
  70             }
  71             static const type_t::value_type typeId = 0x42;
  72         };
  73         \endcode
  74
  75         With GenericTLVParserBase you can define a generic parser class which provides
  76         members to access the value data and and to cast the parser to a concrete tlv
  77         parser:
  78         \code
  79         struct MyGenericTLVParser : public senf::GenericTLVParserBase<MyTLVParserBase>
  80         {
  81             typedef senf::GenericTLVParserBase<MyTLVParserBase> base;
  82             MyGenericTLVParser(data_iterator i, state_type s) : base(i,s) {}
  83
  84             // members for your generic TLV parser...
  85         };
  86         \endcode
  87
  88         If your generic TLV parser just inherits from GenericTLVParserBase and doesn't
  89         add any additional functionality you can use a simple \c typedef as well:
  90         \code
  91         typedef senf::GenericTLVParserBase<MyTLVParserBase> MyGenericTLVParser;
  92         \endcode
  93
  94         This generic tlv parser can now be used for example in a list:
  95         \code
  96         class MyTestPacketParser : public senf::PacketParserBase
  97         {
  98         #   include SENF_PARSER()
  99             SENF_PARSER_FIELD_RO ( list_length, senf::UInt8Parser );
 100             SENF_PARSER_LIST     ( tlv_list, list_length, MyGenericTLVParser );
 101             SENF_PARSER_FINALIZE ( MyTestPacketParser );
 102         };
 103         \endcode
 104
 105         Now, you can access the TLV parsers in the list in a generic way or you
 106         can cast the parsers to some concrete tlv parser:
 107         \code
 108         MyTestPacket p (...
 109         typedef MyTestPacket::Parser::tlv_list_t::container container_t;
 110         container_t tlvContainer (p->tlv_list() );
 111         optContainer_t::iterator listIter (tlvContainer.begin());
 112
 113         // listIter points to a MyGenericTLVParser, so you have generic access:
 114         listIter->type() = 0x42;
 115         listIter->value( someRangeOfValueData);
 116
 117         // cast to an instance of MyConcreteTLVParser:
 118         if (listIter->is<MyConcreteTLVParser>()) {
 119             MyConcreteTLVParser concreteTLVParser ( listIter->as<MyConcreteTLVParser>());
 120             concreteTLVParser.myValue() = 0xabababab;
 121         }
 122
 123         // add a MyConcreteTLV to the list:
 124         MyConcreteTLVParser tlv ( tlvContainer.push_back_space().init<MyConcreteTLVParser>());
 125         tlv.myValue() = 0xffff;
 126         \endcode
 127
 128         \see
 129             IPv6GenericOptionTLVParser, WLANGenericInfoElementParser, MIHGenericTLVParser
 130      */
 131     template <class Base>
 132     class GenericTLVParserBase : public Base
 133     {
 134     public:
 135         GenericTLVParserBase(senf::PacketParserBase::data_iterator i, senf::PacketParserBase::state_type s)
 136             : Base(i,s) {}
 137
 138         senf::PacketParserBase::size_type bytes();
 139         void init() const;
 140
 141         template <class Parser>
 142         Parser init();
 143
 144         template <class Parser>
 145         Parser as() const;
 146
 147         template <class Parser>
 148         bool is() const;
 149
 150         senf::PacketInterpreterBase::range value() const;
 151
 152         void dump(std::ostream & os) const;
 153
 154 #ifndef DOXYGEN
 155         template<class ForwardReadableRange>
 156         void value(ForwardReadableRange const & val,
 157                 typename boost::disable_if<senf::is_pair<ForwardReadableRange> >::type * = 0);
 158
 159         template<class First, class Second>
 160         void value(std::pair<First, Second> const & val,
 161                 typename boost::disable_if<boost::is_convertible<First, typename Base::type_t::value_type> >::type * = 0);
 162
 163         template <class Type, class ForwardReadableRange>
 164         void value(std::pair<Type, ForwardReadableRange> const & val,
 165                 typename boost::enable_if<boost::is_convertible<Type, typename Base::type_t::value_type> >::type * = 0);
 166 #else
 167         template<class ForwardReadableRange>
 168         void value(ForwardReadableRange const & val);
 169
 170         template <class ForwardReadableRange>
 171         void value(std::pair<typename Base::type_t::value_type, ForwardReadableRange> const & val);
 172 #endif
 173
 174     private:
 175         template<class ForwardReadableRange>
 176         void value_(ForwardReadableRange const &range);
 177
 178         Base & self();
 179         Base const & self() const;
 180     };
 181
 182
 183     namespace detail {
 184         template <class BaseParser>
 185         struct GenericTLVParserRegistry_EntryBase {
 186             virtual void dump(GenericTLVParserBase<BaseParser> const & parser, std::ostream & os) = 0;
 187         };
 188
 189         template <class BaseParser, class Parser>
 190         struct GenericTLVParserRegistry_Entry
 191             : GenericTLVParserRegistry_EntryBase<BaseParser>
 192         {
 193             virtual void dump(GenericTLVParserBase<BaseParser> const & parser, std::ostream & os);
 194         };
 195     }
 196
 197     template <class BaseParser>
 198     class GenericTLVParserRegistry
 199         : public senf::singleton<GenericTLVParserRegistry<BaseParser> >
 200     {
 201         typedef boost::ptr_map<
 202             typename BaseParser::type_t::value_type,
 203             detail::GenericTLVParserRegistry_EntryBase<BaseParser> > Map;
 204         Map map_;
 205
 206         GenericTLVParserRegistry() {};
 207     public:
 208         using senf::singleton<GenericTLVParserRegistry<BaseParser> >::instance;
 209         friend class senf::singleton<GenericTLVParserRegistry<BaseParser> >;
 210
 211         template <class PacketParser>
 212         struct RegistrationProxy {
 213             RegistrationProxy();
 214         };
 215
 216         template <typename Parser>
 217         void registerParser();
 218
 219         void dump(GenericTLVParserBase<BaseParser> const & parser, std::ostream & os);
 220     };
 221
 222 #   define SENF_PACKET_TLV_REGISTRY_REGISTER( ConreteTLVParser )                \
 223         namespace {                                                             \
 224             ConreteTLVParser::Registry::RegistrationProxy<ConreteTLVParser>     \
 225                     BOOST_PP_CAT(tlvparserRegistration_, __LINE__);             \
 226         }
 227
 228 }
 229
 230 ///////////////////////////////hh.e////////////////////////////////////////
 231 //#include "GenericTLV.cci"
 232 #include "GenericTLV.ct"
 233 #include "GenericTLV.cti"
 234 #endif
 235
 236 \f
 237 // Local Variables:
 238 // mode: c++
 239 // fill-column: 100
 240 // comment-column: 40
 241 // c-file-style: "senf"
 242 // indent-tabs-mode: nil
 243 // ispell-local-dictionary: "american"
 244 // compile-command: "scons -u test"
 245 // End: