1// -*- C++ -*- 2 3// Copyright (C) 2005, 2006 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 2, 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// You should have received a copy of the GNU General Public License 17// along with this library; see the file COPYING. If not, write to 18// the Free Software Foundation, 59 Temple Place - Suite 330, Boston, 19// MA 02111-1307, USA. 20 21// As a special exception, you may use this file as part of a free 22// software library without restriction. Specifically, if other files 23// instantiate templates or use macros or inline functions from this 24// file, or you compile this file and link it with other files to 25// produce an executable, this file does not by itself cause the 26// resulting executable to be covered by the GNU General Public 27// License. This exception does not however invalidate any other 28// reasons why the executable file might be covered by the GNU General 29// Public License. 30 31// Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL. 32 33// Permission to use, copy, modify, sell, and distribute this software 34// is hereby granted without fee, provided that the above copyright 35// notice appears in all copies, and that both that copyright notice 36// and this permission notice appear in supporting documentation. None 37// of the above authors, nor IBM Haifa Research Laboratories, make any 38// representation about the suitability of this software for any 39// purpose. It is provided "as is" without express or implied 40// warranty. 41 42/** 43 * @file iterator.hpp 44 * Contains an iterator_ class used for ranging over the elements of the 45 * table. 46 */ 47 48// Range-type iterator. 49class iterator_ : 50 public const_iterator_ 51 52{ 53 54public: 55 56 // Category. 57 typedef std::forward_iterator_tag iterator_category; 58 59 // Difference type. 60 typedef typename Allocator::difference_type difference_type; 61 62 // Iterator's value type. 63 typedef value_type_ value_type; 64 65 // Iterator's pointer type. 66 typedef pointer_ pointer; 67 68 // Iterator's const pointer type. 69 typedef const_pointer_ const_pointer; 70 71 // Iterator's reference type. 72 typedef reference_ reference; 73 74 // Iterator's const reference type. 75 typedef const_reference_ const_reference; 76 77public: 78 79 // Default constructor. 80 inline 81 iterator_() 82 83 : const_iterator_(NULL, PB_DS_GEN_POS(), NULL) 84 { } 85 86 // Conversion to a point-type iterator. 87 inline 88 operator point_iterator_() 89 { 90 return (point_iterator_( 91 const_cast<pointer>(const_iterator_::m_p_value))); 92 } 93 94 // Conversion to a point-type iterator. 95 inline 96 operator const point_iterator_() const 97 { 98 return (point_iterator_( 99 const_cast<pointer>(const_iterator_::m_p_value))); 100 } 101 102 // Access. 103 inline pointer 104 operator->() const 105 { 106 _GLIBCXX_DEBUG_ASSERT(base_type::m_p_value != NULL); 107 108 return (const_cast<pointer>(base_type::m_p_value)); 109 } 110 111 // Access. 112 inline reference 113 operator*() const 114 { 115 _GLIBCXX_DEBUG_ASSERT(base_type::m_p_value != NULL); 116 117 return (const_cast<reference>(*base_type::m_p_value)); 118 } 119 120 // Increments. 121 inline iterator_& 122 operator++() 123 { 124 base_type::m_p_tbl->inc_it_state(base_type::m_p_value, base_type::m_pos); 125 126 return (*this); 127 } 128 129 // Increments. 130 inline iterator_ 131 operator++(int) 132 { 133 iterator_ ret =* this; 134 135 base_type::m_p_tbl->inc_it_state(base_type::m_p_value, base_type::m_pos); 136 137 return (ret); 138 } 139 140protected: 141 typedef const_iterator_ base_type; 142 143protected: 144 145 /** 146 * Constructor used by the table to initiate the generalized 147 * pointer and position (e.g., this is called from within a find() 148 * of a table. 149 * */ 150 inline 151 iterator_(pointer p_value, PB_DS_GEN_POS pos, PB_DS_CLASS_C_DEC* p_tbl) : const_iterator_(p_value, pos, p_tbl) 152 { } 153 154 friend class PB_DS_CLASS_C_DEC; 155}; 156 157