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 iterator.hpp
42 * Contains an iterator_ class used for ranging over the elements of the
43 *	table.
44 */
45
46class iterator_ :
47  public const_iterator_
48
49{
50
51public:
52
53  typedef std::forward_iterator_tag iterator_category;
54
55  typedef typename Allocator::difference_type difference_type;
56
57  typedef mapped_value_type value_type;
58
59  typedef mapped_pointer pointer;
60
61  typedef const_mapped_pointer const_pointer;
62
63  typedef mapped_reference reference;
64
65  typedef const_mapped_reference const_reference;
66
67public:
68
69  inline
70  iterator_()
71
72    : const_iterator_(NULL, PB_ASSOC_GEN_POS(), NULL)
73  { }
74
75  inline
76  operator find_iterator_()
77  {
78    return (find_iterator_(
79			   const_cast<pointer>(const_iterator_::m_p_value)));
80  }
81
82  inline
83  operator const find_iterator_() const
84  {
85    return (find_iterator_(
86			   const_cast<pointer>(const_iterator_::m_p_value)));
87  }
88
89  inline pointer
90  operator->()
91  {
92    PB_ASSOC_DBG_ASSERT(my_base::m_p_value != NULL);
93
94    return (const_cast<pointer>(my_base::m_p_value));
95  }
96
97  inline reference
98  operator*()
99  {
100    PB_ASSOC_DBG_ASSERT(my_base::m_p_value != NULL);
101
102    return (*(operator->()));
103  }
104
105  inline iterator_&
106  operator++()
107  {
108    my_base::m_p_tbl->inc_it_state(my_base::m_p_value, my_base::m_pos);
109
110    return (*this);
111  }
112
113  inline iterator_
114  operator++(int)
115  {
116    iterator_ ret =* this;
117
118    my_base::m_p_tbl->inc_it_state(my_base::m_p_value, my_base::m_pos);
119
120    return (ret);
121  }
122
123protected:
124  typedef const_iterator_ my_base;
125
126protected:
127
128  /**
129   * Constructor used by the table to initiate the generalized
130   *   pointer and position (e.g., this is called from within a find()
131   *   of a table.
132   **/
133  inline
134  iterator_(pointer p_value, PB_ASSOC_GEN_POS pos, PB_ASSOC_CLASS_C_DEC* p_tbl) : const_iterator_(p_value, pos, p_tbl)
135  { }
136
137  friend class PB_ASSOC_CLASS_C_DEC;
138};
139
140