senf/Packets/ArrayParser.ih

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief ArrayParser internal header */
  30
  31 #ifndef IH_SENF_Packets_ArrayParser_
  32 #define IH_SENF_Packets_ArrayParser_ 1
  33
  34 // Custom includes
  35 #include <boost/iterator/iterator_facade.hpp>
  36
  37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  38
  39 /** \brief Internal: Array and Vector iterator
  40
  41     \internal
  42
  43     This is the iterator type used for both ArrayParser and VectorParser. It is a model of random
  44     access iterator.
  45  */
  46 template <class ElementParser>
  47 class senf::detail::ArrayParser_iterator
  48     : public boost::iterator_facade< ArrayParser_iterator<ElementParser>,
  49                                      ElementParser,
  50                                      boost::random_access_traversal_tag,
  51                                      ElementParser >
  52 {
  53 public:
  54     ArrayParser_iterator();
  55     ArrayParser_iterator(PacketParserBase::data_iterator const & i,
  56                          PacketParserBase::state_type s);
  57
  58     // Needed to elide the []-proxy of iterator_facade
  59     ElementParser operator[](int i) const;
  60
  61     PacketParserBase::data_iterator raw() const; ///< Return data_iterator
  62                                         /**< Returns the raw data_iterator pointing to the beginning
  63                                              of the current element */
  64
  65 protected:
  66
  67 private:
  68     friend class boost::iterator_core_access;
  69
  70     // iterator_facade interface
  71
  72     ElementParser dereference() const;
  73     bool equal(ArrayParser_iterator const & other) const;
  74     int distance_to(ArrayParser_iterator const & other) const;
  75     void increment();
  76     void decrement();
  77     void advance(int n);
  78
  79     PacketParserBase::data_iterator i_;
  80     PacketParserBase::state_type s_;
  81 };
  82
  83 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  84 #endif
  85
  86 \f
  87 // Local Variables:
  88 // mode: c++
  89 // fill-column: 100
  90 // c-file-style: "senf"
  91 // indent-tabs-mode: nil
  92 // ispell-local-dictionary: "american"
  93 // compile-command: "scons -u test"
  94 // comment-column: 40
  95 // End: