xref: /dflybsd-src/contrib/gcc-8.0/libstdc++-v3/include/profile/iterator_tracker.h (revision 38fd149817dfbff97799f62fcb70be98c4e32523)
1*38fd1498Szrj // Profiling iterator implementation -*- C++ -*-
2*38fd1498Szrj 
3*38fd1498Szrj // Copyright (C) 2009-2018 Free Software Foundation, Inc.
4*38fd1498Szrj //
5*38fd1498Szrj // This file is part of the GNU ISO C++ Library.  This library is free
6*38fd1498Szrj // software; you can redistribute it and/or modify it under the
7*38fd1498Szrj // terms of the GNU General Public License as published by the
8*38fd1498Szrj // Free Software Foundation; either version 3, or (at your option)
9*38fd1498Szrj // any later version.
10*38fd1498Szrj 
11*38fd1498Szrj // This library is distributed in the hope that it will be useful,
12*38fd1498Szrj // but WITHOUT ANY WARRANTY; without even the implied warranty of
13*38fd1498Szrj // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14*38fd1498Szrj // GNU General Public License for more details.
15*38fd1498Szrj 
16*38fd1498Szrj // Under Section 7 of GPL version 3, you are granted additional
17*38fd1498Szrj // permissions described in the GCC Runtime Library Exception, version
18*38fd1498Szrj // 3.1, as published by the Free Software Foundation.
19*38fd1498Szrj 
20*38fd1498Szrj // You should have received a copy of the GNU General Public License and
21*38fd1498Szrj // a copy of the GCC Runtime Library Exception along with this program;
22*38fd1498Szrj // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
23*38fd1498Szrj // <http://www.gnu.org/licenses/>.
24*38fd1498Szrj 
25*38fd1498Szrj /** @file profile/iterator_tracker.h
26*38fd1498Szrj  *  This file is a GNU profile extension to the Standard C++ Library.
27*38fd1498Szrj  */
28*38fd1498Szrj 
29*38fd1498Szrj #ifndef _GLIBCXX_PROFILE_ITERATOR_TRACKER
30*38fd1498Szrj #define _GLIBCXX_PROFILE_ITERATOR_TRACKER 1
31*38fd1498Szrj 
32*38fd1498Szrj #include <ext/type_traits.h>
33*38fd1498Szrj 
_GLIBCXX_VISIBILITY(default)34*38fd1498Szrj namespace std _GLIBCXX_VISIBILITY(default)
35*38fd1498Szrj {
36*38fd1498Szrj namespace __profile
37*38fd1498Szrj {
38*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
39*38fd1498Szrj     class __iterator_tracker
40*38fd1498Szrj     {
41*38fd1498Szrj       typedef __iterator_tracker _Self;
42*38fd1498Szrj 
43*38fd1498Szrj       // The underlying iterator
44*38fd1498Szrj       _Iterator _M_current;
45*38fd1498Szrj 
46*38fd1498Szrj       // The underlying data structure
47*38fd1498Szrj       const _Sequence* _M_ds;
48*38fd1498Szrj       typedef std::iterator_traits<_Iterator> _Traits;
49*38fd1498Szrj 
50*38fd1498Szrj     public:
51*38fd1498Szrj       typedef _Iterator					_Base_iterator;
52*38fd1498Szrj       typedef typename _Traits::iterator_category	iterator_category;
53*38fd1498Szrj       typedef typename _Traits::value_type		value_type;
54*38fd1498Szrj       typedef typename _Traits::difference_type		difference_type;
55*38fd1498Szrj       typedef typename _Traits::reference		reference;
56*38fd1498Szrj       typedef typename _Traits::pointer			pointer;
57*38fd1498Szrj 
58*38fd1498Szrj       __iterator_tracker() _GLIBCXX_NOEXCEPT
59*38fd1498Szrj       : _M_current(), _M_ds(0) { }
60*38fd1498Szrj 
61*38fd1498Szrj       __iterator_tracker(const _Iterator& __i, const _Sequence* __seq)
62*38fd1498Szrj       _GLIBCXX_NOEXCEPT
63*38fd1498Szrj       : _M_current(__i), _M_ds(__seq) { }
64*38fd1498Szrj 
65*38fd1498Szrj       __iterator_tracker(const __iterator_tracker& __x) _GLIBCXX_NOEXCEPT
66*38fd1498Szrj       : _M_current(__x._M_current), _M_ds(__x._M_ds) { }
67*38fd1498Szrj 
68*38fd1498Szrj       template<typename _MutableIterator>
69*38fd1498Szrj 	__iterator_tracker(const __iterator_tracker<_MutableIterator,
70*38fd1498Szrj 			   typename __gnu_cxx::__enable_if
71*38fd1498Szrj 			   <(std::__are_same<_MutableIterator, typename
72*38fd1498Szrj 			     _Sequence::iterator::_Base_iterator>::__value),
73*38fd1498Szrj 			   _Sequence>::__type>& __x) _GLIBCXX_NOEXCEPT
74*38fd1498Szrj 	:  _M_current(__x.base()), _M_ds(__x._M_get_sequence()) { }
75*38fd1498Szrj 
76*38fd1498Szrj       _Iterator
77*38fd1498Szrj       base() const _GLIBCXX_NOEXCEPT { return _M_current; }
78*38fd1498Szrj 
79*38fd1498Szrj       /**
80*38fd1498Szrj        * @brief Conversion to underlying non-debug iterator to allow
81*38fd1498Szrj        * better interaction with non-profile containers.
82*38fd1498Szrj        */
83*38fd1498Szrj       operator _Iterator() const _GLIBCXX_NOEXCEPT { return _M_current; }
84*38fd1498Szrj 
85*38fd1498Szrj       pointer
86*38fd1498Szrj       operator->() const _GLIBCXX_NOEXCEPT { return &*_M_current; }
87*38fd1498Szrj 
88*38fd1498Szrj       __iterator_tracker&
89*38fd1498Szrj       operator++() _GLIBCXX_NOEXCEPT
90*38fd1498Szrj       {
91*38fd1498Szrj 	_M_ds->_M_profile_iterate();
92*38fd1498Szrj 	++_M_current;
93*38fd1498Szrj 	return *this;
94*38fd1498Szrj       }
95*38fd1498Szrj 
96*38fd1498Szrj       __iterator_tracker
97*38fd1498Szrj       operator++(int) _GLIBCXX_NOEXCEPT
98*38fd1498Szrj       {
99*38fd1498Szrj 	_M_ds->_M_profile_iterate();
100*38fd1498Szrj 	__iterator_tracker __tmp(*this);
101*38fd1498Szrj 	++_M_current;
102*38fd1498Szrj 	return __tmp;
103*38fd1498Szrj       }
104*38fd1498Szrj 
105*38fd1498Szrj       __iterator_tracker&
106*38fd1498Szrj       operator--() _GLIBCXX_NOEXCEPT
107*38fd1498Szrj       {
108*38fd1498Szrj 	_M_ds->_M_profile_iterate(1);
109*38fd1498Szrj 	--_M_current;
110*38fd1498Szrj 	return *this;
111*38fd1498Szrj       }
112*38fd1498Szrj 
113*38fd1498Szrj       __iterator_tracker
114*38fd1498Szrj       operator--(int) _GLIBCXX_NOEXCEPT
115*38fd1498Szrj       {
116*38fd1498Szrj 	_M_ds->_M_profile_iterate(1);
117*38fd1498Szrj 	__iterator_tracker __tmp(*this);
118*38fd1498Szrj 	--_M_current;
119*38fd1498Szrj 	return __tmp;
120*38fd1498Szrj       }
121*38fd1498Szrj 
122*38fd1498Szrj       __iterator_tracker&
123*38fd1498Szrj       operator=(const __iterator_tracker& __x) _GLIBCXX_NOEXCEPT
124*38fd1498Szrj       {
125*38fd1498Szrj 	_M_current = __x._M_current;
126*38fd1498Szrj 	_M_ds = __x._M_ds;
127*38fd1498Szrj 	return *this;
128*38fd1498Szrj       }
129*38fd1498Szrj 
130*38fd1498Szrj       reference
131*38fd1498Szrj       operator*() const _GLIBCXX_NOEXCEPT
132*38fd1498Szrj       { return *_M_current; }
133*38fd1498Szrj 
134*38fd1498Szrj       // ------ Random access iterator requirements ------
135*38fd1498Szrj       reference
136*38fd1498Szrj       operator[](const difference_type& __n) const  _GLIBCXX_NOEXCEPT
137*38fd1498Szrj       { return _M_current[__n]; }
138*38fd1498Szrj 
139*38fd1498Szrj       __iterator_tracker&
140*38fd1498Szrj       operator+=(const difference_type& __n) _GLIBCXX_NOEXCEPT
141*38fd1498Szrj       {
142*38fd1498Szrj 	_M_current += __n;
143*38fd1498Szrj 	return *this;
144*38fd1498Szrj       }
145*38fd1498Szrj 
146*38fd1498Szrj       __iterator_tracker
147*38fd1498Szrj       operator+(const difference_type& __n) const _GLIBCXX_NOEXCEPT
148*38fd1498Szrj       {
149*38fd1498Szrj 	__iterator_tracker __tmp(*this);
150*38fd1498Szrj 	__tmp += __n;
151*38fd1498Szrj 	return __tmp;
152*38fd1498Szrj       }
153*38fd1498Szrj 
154*38fd1498Szrj       __iterator_tracker&
155*38fd1498Szrj       operator-=(const difference_type& __n) _GLIBCXX_NOEXCEPT
156*38fd1498Szrj       {
157*38fd1498Szrj 	_M_current += -__n;
158*38fd1498Szrj 	return *this;
159*38fd1498Szrj       }
160*38fd1498Szrj 
161*38fd1498Szrj       __iterator_tracker
162*38fd1498Szrj       operator-(const difference_type& __n) const _GLIBCXX_NOEXCEPT
163*38fd1498Szrj       {
164*38fd1498Szrj 	__iterator_tracker __tmp(*this);
165*38fd1498Szrj 	__tmp -= __n;
166*38fd1498Szrj 	return __tmp;
167*38fd1498Szrj       }
168*38fd1498Szrj 
169*38fd1498Szrj       const _Sequence*
170*38fd1498Szrj       _M_get_sequence() const
171*38fd1498Szrj       { return static_cast<const _Sequence*>(_M_ds); }
172*38fd1498Szrj   };
173*38fd1498Szrj 
174*38fd1498Szrj   template<typename _IteratorL, typename _IteratorR, typename _Sequence>
175*38fd1498Szrj     inline bool
176*38fd1498Szrj     operator==(const __iterator_tracker<_IteratorL, _Sequence>& __lhs,
177*38fd1498Szrj 	       const __iterator_tracker<_IteratorR, _Sequence>& __rhs)
178*38fd1498Szrj     _GLIBCXX_NOEXCEPT
179*38fd1498Szrj     { return __lhs.base() == __rhs.base(); }
180*38fd1498Szrj 
181*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
182*38fd1498Szrj     inline bool
183*38fd1498Szrj     operator==(const __iterator_tracker<_Iterator, _Sequence>& __lhs,
184*38fd1498Szrj 	       const __iterator_tracker<_Iterator, _Sequence>& __rhs)
185*38fd1498Szrj     _GLIBCXX_NOEXCEPT
186*38fd1498Szrj     { return __lhs.base() == __rhs.base(); }
187*38fd1498Szrj 
188*38fd1498Szrj   template<typename _IteratorL, typename _IteratorR, typename _Sequence>
189*38fd1498Szrj     inline bool
190*38fd1498Szrj     operator!=(const __iterator_tracker<_IteratorL, _Sequence>& __lhs,
191*38fd1498Szrj 	       const __iterator_tracker<_IteratorR, _Sequence>& __rhs)
192*38fd1498Szrj     _GLIBCXX_NOEXCEPT
193*38fd1498Szrj     { return __lhs.base() != __rhs.base(); }
194*38fd1498Szrj 
195*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
196*38fd1498Szrj     inline bool
197*38fd1498Szrj     operator!=(const __iterator_tracker<_Iterator, _Sequence>& __lhs,
198*38fd1498Szrj 	       const __iterator_tracker<_Iterator, _Sequence>& __rhs)
199*38fd1498Szrj     _GLIBCXX_NOEXCEPT
200*38fd1498Szrj     { return __lhs.base() != __rhs.base(); }
201*38fd1498Szrj 
202*38fd1498Szrj   template<typename _IteratorL, typename _IteratorR, typename _Sequence>
203*38fd1498Szrj     inline bool
204*38fd1498Szrj     operator<(const __iterator_tracker<_IteratorL, _Sequence>& __lhs,
205*38fd1498Szrj 	      const __iterator_tracker<_IteratorR, _Sequence>& __rhs)
206*38fd1498Szrj     _GLIBCXX_NOEXCEPT
207*38fd1498Szrj     { return __lhs.base() < __rhs.base(); }
208*38fd1498Szrj 
209*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
210*38fd1498Szrj     inline bool
211*38fd1498Szrj     operator<(const __iterator_tracker<_Iterator, _Sequence>& __lhs,
212*38fd1498Szrj 	      const __iterator_tracker<_Iterator, _Sequence>& __rhs)
213*38fd1498Szrj     _GLIBCXX_NOEXCEPT
214*38fd1498Szrj     { return __lhs.base() < __rhs.base(); }
215*38fd1498Szrj 
216*38fd1498Szrj   template<typename _IteratorL, typename _IteratorR, typename _Sequence>
217*38fd1498Szrj     inline bool
218*38fd1498Szrj     operator<=(const __iterator_tracker<_IteratorL, _Sequence>& __lhs,
219*38fd1498Szrj 	       const __iterator_tracker<_IteratorR, _Sequence>& __rhs)
220*38fd1498Szrj     _GLIBCXX_NOEXCEPT
221*38fd1498Szrj     { return __lhs.base() <= __rhs.base(); }
222*38fd1498Szrj 
223*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
224*38fd1498Szrj     inline bool
225*38fd1498Szrj     operator<=(const __iterator_tracker<_Iterator, _Sequence>& __lhs,
226*38fd1498Szrj 	       const __iterator_tracker<_Iterator, _Sequence>& __rhs)
227*38fd1498Szrj     _GLIBCXX_NOEXCEPT
228*38fd1498Szrj     { return __lhs.base() <= __rhs.base(); }
229*38fd1498Szrj 
230*38fd1498Szrj   template<typename _IteratorL, typename _IteratorR, typename _Sequence>
231*38fd1498Szrj     inline bool
232*38fd1498Szrj     operator>(const __iterator_tracker<_IteratorL, _Sequence>& __lhs,
233*38fd1498Szrj 	      const __iterator_tracker<_IteratorR, _Sequence>& __rhs)
234*38fd1498Szrj     _GLIBCXX_NOEXCEPT
235*38fd1498Szrj     { return __lhs.base() > __rhs.base(); }
236*38fd1498Szrj 
237*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
238*38fd1498Szrj     inline bool
239*38fd1498Szrj     operator>(const __iterator_tracker<_Iterator, _Sequence>& __lhs,
240*38fd1498Szrj 	      const __iterator_tracker<_Iterator, _Sequence>& __rhs)
241*38fd1498Szrj     _GLIBCXX_NOEXCEPT
242*38fd1498Szrj     { return __lhs.base() > __rhs.base(); }
243*38fd1498Szrj 
244*38fd1498Szrj   template<typename _IteratorL, typename _IteratorR, typename _Sequence>
245*38fd1498Szrj     inline bool
246*38fd1498Szrj     operator>=(const __iterator_tracker<_IteratorL, _Sequence>& __lhs,
247*38fd1498Szrj 	       const __iterator_tracker<_IteratorR, _Sequence>& __rhs)
248*38fd1498Szrj     _GLIBCXX_NOEXCEPT
249*38fd1498Szrj     { return __lhs.base() >= __rhs.base(); }
250*38fd1498Szrj 
251*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
252*38fd1498Szrj     inline bool
253*38fd1498Szrj     operator>=(const __iterator_tracker<_Iterator, _Sequence>& __lhs,
254*38fd1498Szrj 	       const __iterator_tracker<_Iterator, _Sequence>& __rhs)
255*38fd1498Szrj     _GLIBCXX_NOEXCEPT
256*38fd1498Szrj     { return __lhs.base() >= __rhs.base(); }
257*38fd1498Szrj 
258*38fd1498Szrj   // _GLIBCXX_RESOLVE_LIB_DEFECTS
259*38fd1498Szrj   // According to the resolution of DR179 not only the various comparison
260*38fd1498Szrj   // operators but also operator- must accept mixed iterator/const_iterator
261*38fd1498Szrj   // parameters.
262*38fd1498Szrj   template<typename _IteratorL, typename _IteratorR, typename _Sequence>
263*38fd1498Szrj     inline typename __iterator_tracker<_IteratorL, _Sequence>::difference_type
264*38fd1498Szrj     operator-(const __iterator_tracker<_IteratorL, _Sequence>& __lhs,
265*38fd1498Szrj 	      const __iterator_tracker<_IteratorR, _Sequence>& __rhs)
266*38fd1498Szrj     _GLIBCXX_NOEXCEPT
267*38fd1498Szrj     { return __lhs.base() - __rhs.base(); }
268*38fd1498Szrj 
269*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
270*38fd1498Szrj     inline typename __iterator_tracker<_Iterator, _Sequence>::difference_type
271*38fd1498Szrj     operator-(const __iterator_tracker<_Iterator, _Sequence>& __lhs,
272*38fd1498Szrj 	      const __iterator_tracker<_Iterator, _Sequence>& __rhs)
273*38fd1498Szrj     _GLIBCXX_NOEXCEPT
274*38fd1498Szrj     { return __lhs.base() - __rhs.base(); }
275*38fd1498Szrj 
276*38fd1498Szrj   template<typename _Iterator, typename _Sequence>
277*38fd1498Szrj     inline __iterator_tracker<_Iterator, _Sequence>
278*38fd1498Szrj     operator+(typename __iterator_tracker<_Iterator,_Sequence>::difference_type
279*38fd1498Szrj 	      __n,
280*38fd1498Szrj 	      const __iterator_tracker<_Iterator, _Sequence>& __i)
281*38fd1498Szrj     _GLIBCXX_NOEXCEPT
282*38fd1498Szrj     { return __i + __n; }
283*38fd1498Szrj 
284*38fd1498Szrj }  // namespace __profile
285*38fd1498Szrj }  // namespace std
286*38fd1498Szrj #endif
287