Packets/ParseArray.ih

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.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 #ifndef IH_ParseArray_
  24 #define IH_ParseArray_ 1
  25
  26 // Custom includes
  27 #include <boost/iterator/iterator_facade.hpp>
  28
  29 ///////////////////////////////ih.p////////////////////////////////////////
  30
  31 /** \brief Internal: Array and Vector iterator
  32
  33     \internal
  34
  35     This is the iterator type used for both Parse_Array and Parse_Vector. It is a model of random
  36     access iterator.
  37  */
  38 template <class ElementParser>
  39 class senf::detail::Parse_Array_iterator
  40     : public boost::iterator_facade< Parse_Array_iterator<ElementParser>,
  41                                      ElementParser,
  42                                      boost::random_access_traversal_tag,
  43                                      ElementParser >
  44 {
  45 public:
  46     Parse_Array_iterator();
  47     Parse_Array_iterator(PacketParserBase::data_iterator const & i,
  48                          PacketParserBase::state_type s);
  49
  50     // Needed to elide the []-proxy of iterator_facade
  51     ElementParser operator[](int i) const;
  52
  53     PacketParserBase::data_iterator raw() const; ///< Return data_iterator
  54                                         /**< Returns the raw data_iterator pointing to the beginning
  55                                              of the current element */
  56
  57 protected:
  58
  59 private:
  60     friend class boost::iterator_core_access;
  61
  62     // iterator_facade interface
  63
  64     ElementParser dereference() const;
  65     bool equal(Parse_Array_iterator const & other) const;
  66     int distance_to(Parse_Array_iterator const & other) const;
  67     void increment();
  68     void decrement();
  69     void advance(int n);
  70
  71     PacketParserBase::data_iterator i_;
  72     PacketParserBase::state_type s_;
  73 };
  74
  75 ///////////////////////////////ih.e////////////////////////////////////////
  76 #endif
  77
  78 \f
  79 // Local Variables:
  80 // mode: c++
  81 // fill-column: 100
  82 // c-file-style: "senf"
  83 // indent-tabs-mode: nil
  84 // ispell-local-dictionary: "american"
  85 // compile-command: "scons -u test"
  86 // comment-column: 40
  87 // End: