1// -*- C++ -*-
2
3// Copyright (C) 2005 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
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 2, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License along
17// with this library; see the file COPYING.  If not, write to the Free
18// Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19// USA.
20
21// As a special exception, you may use this file as part of a free software
22// library without restriction.  Specifically, if other files instantiate
23// templates or use macros or inline functions from this file, or you compile
24// this file and link it with other files to produce an executable, this
25// file does not by itself cause the resulting executable to be covered by
26// the GNU General Public License.  This exception does not however
27// invalidate any other reasons why the executable file might be covered by
28// the GNU General Public License.
29
30// Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
31
32// Permission to use, copy, modify, sell, and distribute this software
33// is hereby granted without fee, provided that the above copyright
34// notice appears in all copies, and that both that copyright notice and
35// this permission notice appear in supporting documentation. None of
36// the above authors, nor IBM Haifa Research Laboratories, make any
37// representation about the suitability of this software for any
38// purpose. It is provided "as is" without express or implied warranty.
39
40/**
41 * @file find_iterator.hpp
42 * Contains an iterator class returned by the tables' find and insert
43 *   methods.
44 */
45
46class find_iterator_
47{
48
49public:
50
51  typedef trivial_iterator_tag iterator_category;
52
53  typedef trivial_iterator_difference_type difference_type;
54
55  typedef mapped_value_type value_type;
56
57  typedef mapped_pointer pointer;
58
59  typedef const_mapped_pointer const_pointer;
60
61  typedef mapped_reference reference;
62
63  typedef const_mapped_reference const_reference;
64
65public:
66
67  inline
68  find_iterator_()
69
70    : m_p_value(NULL)
71  { }
72
73  inline
74  find_iterator_(const find_iterator_& r_other)
75
76    : m_p_value(r_other.m_p_value)
77  { }
78
79  inline pointer
80  operator->()
81  {
82    PB_ASSOC_DBG_ASSERT(m_p_value != NULL);
83
84    return (m_p_value);
85  }
86
87  inline const_pointer
88  operator->() const
89  {
90    PB_ASSOC_DBG_ASSERT(m_p_value != NULL);
91
92    return (m_p_value);
93  }
94
95  inline reference
96  operator*()
97  {
98    PB_ASSOC_DBG_ASSERT(m_p_value != NULL);
99
100    return (*m_p_value);
101  }
102
103  inline const_reference
104  operator*() const
105  {
106    PB_ASSOC_DBG_ASSERT(m_p_value != NULL);
107
108    return (*m_p_value);
109  }
110
111  inline bool
112  operator==(const find_iterator_& r_other) const
113  {
114    return (m_p_value == r_other.m_p_value);
115  }
116
117  inline bool
118  operator==(const const_find_iterator_& r_other) const
119  {
120    return (m_p_value == r_other.m_p_value);
121  }
122
123  inline bool
124  operator!=(const find_iterator_& r_other) const
125  {
126    return (m_p_value != r_other.m_p_value);
127  }
128
129  inline bool
130  operator!=(const const_find_iterator_& r_other) const
131  {
132    return (m_p_value != r_other.m_p_value);
133  }
134
135  inline
136  find_iterator_(pointer p_value) : m_p_value(p_value)
137  { }
138
139protected:
140  friend class const_find_iterator_;
141
142  friend class PB_ASSOC_CLASS_C_DEC;
143
144protected:
145  pointer m_p_value;
146};
147
148