const_point_iterator.hpp revision 169691
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 const_point_iterator.hpp 44 * Contains an iterator class returned by the tables' const find and insert 45 * methods. 46 */ 47 48class point_iterator_; 49 50// Const point-type iterator. 51class const_point_iterator_ 52{ 53 54public: 55 56 // Category. 57 typedef trivial_iterator_tag iterator_category; 58 59 // Difference type. 60 typedef trivial_iterator_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 inline 80 const_point_iterator_(const_pointer p_value) : m_p_value(p_value) 81 { } 82 83 // Default constructor. 84 inline 85 const_point_iterator_() 86 87 : m_p_value(NULL) 88 { } 89 90 // Copy constructor. 91 inline 92 const_point_iterator_(const const_point_iterator_& other) 93 94 : m_p_value(other.m_p_value) 95 { } 96 97 // Copy constructor. 98 inline 99 const_point_iterator_(const point_iterator_& other) 100 101 : m_p_value(other.m_p_value) 102 { } 103 104 // Access. 105 inline const_pointer 106 operator->() const 107 { 108 _GLIBCXX_DEBUG_ASSERT(m_p_value != NULL); 109 110 return (m_p_value); 111 } 112 113 // Access. 114 inline const_reference 115 operator*() const 116 { 117 _GLIBCXX_DEBUG_ASSERT(m_p_value != NULL); 118 119 return (*m_p_value); 120 } 121 122 // Compares content to a different iterator object. 123 inline bool 124 operator==(const point_iterator_& other) const 125 { 126 return (m_p_value == other.m_p_value); 127 } 128 129 // Compares content to a different iterator object. 130 inline bool 131 operator==(const const_point_iterator_& other) const 132 { 133 return (m_p_value == other.m_p_value); 134 } 135 136 // Compares content (negatively) to a different iterator object. 137 inline bool 138 operator!=(const point_iterator_& other) const 139 { 140 return (m_p_value != other.m_p_value); 141 } 142 143 // Compares content (negatively) to a different iterator object. 144 inline bool 145 operator!=(const const_point_iterator_& other) const 146 { 147 return (m_p_value != other.m_p_value); 148 } 149 150protected: 151 const_pointer m_p_value; 152 153 friend class point_iterator_; 154 155 friend class PB_DS_CLASS_C_DEC; 156}; 157 158