libstdc++-v3/include/ext/pb_ds/detail/unordered_iterator/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 iterator.hpp
  38  * Contains an iterator_ class used for ranging over the elements of the
  39  *    table.
  40  */
  41
  42 // Range-type iterator.
  43 class iterator_ :
  44   public const_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   iterator_()
  76
  77     : const_iterator_(0, PB_DS_GEN_POS(), 0)
  78   { }
  79
  80   // Conversion to a point-type iterator.
  81   inline
  82   operator point_iterator_()
  83   {
  84     return (point_iterator_(
  85                             const_cast<pointer>(const_iterator_::m_p_value)));
  86   }
  87
  88   // Conversion to a point-type iterator.
  89   inline
  90   operator const point_iterator_() const
  91   {
  92     return (point_iterator_(
  93                             const_cast<pointer>(const_iterator_::m_p_value)));
  94   }
  95
  96   // Access.
  97   inline pointer
  98   operator->() const
  99   {
 100     _GLIBCXX_DEBUG_ASSERT(base_type::m_p_value != 0);
 101
 102     return (const_cast<pointer>(base_type::m_p_value));
 103   }
 104
 105   // Access.
 106   inline reference
 107   operator*() const
 108   {
 109     _GLIBCXX_DEBUG_ASSERT(base_type::m_p_value != 0);
 110
 111     return (const_cast<reference>(*base_type::m_p_value));
 112   }
 113
 114   // Increments.
 115   inline iterator_&
 116   operator++()
 117   {
 118     base_type::m_p_tbl->inc_it_state(base_type::m_p_value, base_type::m_pos);
 119
 120     return (*this);
 121   }
 122
 123   // Increments.
 124   inline iterator_
 125   operator++(int)
 126   {
 127     iterator_ ret =* this;
 128
 129     base_type::m_p_tbl->inc_it_state(base_type::m_p_value, base_type::m_pos);
 130
 131     return (ret);
 132   }
 133
 134 protected:
 135   typedef const_iterator_ base_type;
 136
 137 protected:
 138
 139   /**
 140    *  Constructor used by the table to initiate the generalized
 141    *      pointer and position (e.g., this is called from within a find()
 142    *      of a table.
 143    * */
 144   inline
 145   iterator_(pointer p_value, PB_DS_GEN_POS pos, PB_DS_CLASS_C_DEC* p_tbl) : const_iterator_(p_value, pos, p_tbl)
 146   { }
 147
 148   friend class PB_DS_CLASS_C_DEC;
 149 };
 150