libstdc++-v3/include/ext/pb_ds/detail/unordered_iterator/const_iterator.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006, 2009 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the terms
   7 // of the GNU General Public License as published by the Free Software
   8 // Foundation; either version 3, or (at your option) any later
   9 // version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15
  16 // Under Section 7 of GPL version 3, you are granted additional
  17 // permissions described in the GCC Runtime Library Exception, version
  18 // 3.1, as published by the Free Software Foundation.
  19
  20 // You should have received a copy of the GNU General Public License and
  21 // a copy of the GCC Runtime Library Exception along with this program;
  22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 // <http://www.gnu.org/licenses/>.
  24
  25 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  26
  27 // Permission to use, copy, modify, sell, and distribute this software
  28 // is hereby granted without fee, provided that the above copyright
  29 // notice appears in all copies, and that both that copyright notice
  30 // and this permission notice appear in supporting documentation. None
  31 // of the above authors, nor IBM Haifa Research Laboratories, make any
  32 // representation about the suitability of this software for any
  33 // purpose. It is provided "as is" without express or implied
  34 // warranty.
  35
  36 /**
  37  * @file const_iterator.hpp
  38  * Contains an iterator class used for const ranging over the elements of the
  39  *     table.
  40  */
  41
  42 // Const range-type iterator.
  43 class const_iterator_ :
  44   public const_point_iterator_
  45
  46 {
  47
  48 public:
  49
  50   // Category.
  51   typedef std::forward_iterator_tag iterator_category;
  52
  53   // Difference type.
  54   typedef typename Allocator::difference_type difference_type;
  55
  56   // Iterator's value type.
  57   typedef value_type_ value_type;
  58
  59   // Iterator's pointer type.
  60   typedef pointer_ pointer;
  61
  62   // Iterator's const pointer type.
  63   typedef const_pointer_ const_pointer;
  64
  65   // Iterator's reference type.
  66   typedef reference_ reference;
  67
  68   // Iterator's const reference type.
  69   typedef const_reference_ const_reference;
  70
  71 public:
  72
  73   // Default constructor.
  74   inline
  75   const_iterator_()
  76
  77     : m_p_tbl(0)
  78   { }
  79
  80   // Increments.
  81   inline const_iterator_&
  82   operator++()
  83   {
  84     m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
  85
  86     return (*this);
  87   }
  88
  89   // Increments.
  90   inline const_iterator_
  91   operator++(int)
  92   {
  93     const_iterator_ ret =* this;
  94
  95     m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
  96
  97     return (ret);
  98   }
  99
 100 protected:
 101
 102   typedef const_point_iterator_ base_type;
 103
 104 protected:
 105
 106   /**
 107    *  Constructor used by the table to initiate the generalized
 108    *      pointer and position (e.g., this is called from within a find()
 109    *      of a table.
 110    * */
 111   inline
 112   const_iterator_(const_pointer_ p_value,  PB_DS_GEN_POS pos,  const PB_DS_CLASS_C_DEC* p_tbl) : const_point_iterator_(p_value),
 113                                                                                                  m_p_tbl(p_tbl),
 114                                                                                                  m_pos(pos)
 115   { }
 116
 117 protected:
 118
 119   /**
 120    *  Pointer to the table object which created the iterator (used for
 121    *      incrementing its position.
 122    * */
 123   const PB_DS_CLASS_C_DEC* m_p_tbl;
 124
 125   PB_DS_GEN_POS m_pos;
 126
 127   friend class PB_DS_CLASS_C_DEC;
 128 };
 129