xref: /openbsd-src/gnu/gcc/libstdc++-v3/include/ext/pb_ds/detail/unordered_iterator/const_iterator.hpp (revision 404b540a9034ac75a6199ad1a32d1bbc7a0d4210)
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_iterator.hpp
44  * Contains an iterator class used for const ranging over the elements of the
45  *     table.
46  */
47 
48 // Const range-type iterator.
49 class const_iterator_ :
50   public const_point_iterator_
51 
52 {
53 
54 public:
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 
77 public:
78 
79   // Default constructor.
80   inline
const_iterator_()81   const_iterator_()
82 
83     : m_p_tbl(NULL)
84   { }
85 
86   // Increments.
87   inline const_iterator_&
operator ++()88   operator++()
89   {
90     m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
91 
92     return (*this);
93   }
94 
95   // Increments.
96   inline const_iterator_
operator ++(int)97   operator++(int)
98   {
99     const_iterator_ ret =* this;
100 
101     m_p_tbl->inc_it_state(base_type::m_p_value, m_pos);
102 
103     return (ret);
104   }
105 
106 protected:
107 
108   typedef const_point_iterator_ base_type;
109 
110 protected:
111 
112   /**
113    *  Constructor used by the table to initiate the generalized
114    *      pointer and position (e.g., this is called from within a find()
115    *      of a table.
116    * */
117   inline
const_iterator_(const_pointer_ p_value,PB_DS_GEN_POS pos,const PB_DS_CLASS_C_DEC * p_tbl)118   const_iterator_(const_pointer_ p_value,  PB_DS_GEN_POS pos,  const PB_DS_CLASS_C_DEC* p_tbl) : const_point_iterator_(p_value),
119 												 m_p_tbl(p_tbl),
120 												 m_pos(pos)
121   { }
122 
123 protected:
124 
125   /**
126    *  Pointer to the table object which created the iterator (used for
127    *      incrementing its position.
128    * */
129   const PB_DS_CLASS_C_DEC* m_p_tbl;
130 
131   PB_DS_GEN_POS m_pos;
132 
133   friend class PB_DS_CLASS_C_DEC;
134 };
135 
136