1// -*- C++ -*-
2//===----------------------------------------------------------------------===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP___ITERATOR_REVERSE_ITERATOR_H
11#define _LIBCPP___ITERATOR_REVERSE_ITERATOR_H
12
13#include <__algorithm/unwrap_iter.h>
14#include <__compare/compare_three_way_result.h>
15#include <__compare/three_way_comparable.h>
16#include <__concepts/convertible_to.h>
17#include <__config>
18#include <__iterator/concepts.h>
19#include <__iterator/incrementable_traits.h>
20#include <__iterator/iter_move.h>
21#include <__iterator/iter_swap.h>
22#include <__iterator/iterator.h>
23#include <__iterator/iterator_traits.h>
24#include <__memory/addressof.h>
25#include <__type_traits/conditional.h>
26#include <__type_traits/enable_if.h>
27#include <__type_traits/is_assignable.h>
28#include <__type_traits/is_convertible.h>
29#include <__type_traits/is_nothrow_constructible.h>
30#include <__type_traits/is_pointer.h>
31#include <__type_traits/is_same.h>
32#include <__utility/declval.h>
33
34#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
35# pragma GCC system_header
36#endif
37
38_LIBCPP_BEGIN_NAMESPACE_STD
39
40template <class _Iter>
41class reverse_iterator
42 : public __iterator_base<reverse_iterator<_Iter>,
43 typename iterator_traits<_Iter>::iterator_category,
44 typename iterator_traits<_Iter>::value_type,
45 typename iterator_traits<_Iter>::difference_type,
46 typename iterator_traits<_Iter>::pointer,
47 typename iterator_traits<_Iter>::reference> {
48private:
49#ifndef _LIBCPP_ABI_NO_REVERSE_ITERATOR_SECOND_MEMBER
50 _Iter __t_; // no longer used as of LWG #2360, not removed due to ABI break
51#endif
52
53#if _LIBCPP_STD_VER >= 20
54 static_assert(__has_bidirectional_iterator_category<_Iter>::value || bidirectional_iterator<_Iter>,
55 "reverse_iterator<It> requires It to be a bidirectional iterator.");
56#endif // _LIBCPP_STD_VER >= 20
57
58protected:
59 _Iter current;
60
61public:
62 using iterator_type = _Iter;
63
64 using iterator_category =
65 _If<__has_random_access_iterator_category<_Iter>::value,
66 random_access_iterator_tag,
67 typename iterator_traits<_Iter>::iterator_category>;
68 using pointer = typename iterator_traits<_Iter>::pointer;
69#if _LIBCPP_STD_VER >= 20
70 using iterator_concept = _If<random_access_iterator<_Iter>, random_access_iterator_tag, bidirectional_iterator_tag>;
71 using value_type = iter_value_t<_Iter>;
72 using difference_type = iter_difference_t<_Iter>;
73 using reference = iter_reference_t<_Iter>;
74#else
75 using value_type = typename iterator_traits<_Iter>::value_type;
76 using difference_type = typename iterator_traits<_Iter>::difference_type;
77 using reference = typename iterator_traits<_Iter>::reference;
78#endif
79
80#ifndef _LIBCPP_ABI_NO_REVERSE_ITERATOR_SECOND_MEMBER
81 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator() : __t_(), current() {}
82
83 _LIBCPP_CONSTEXPR_SINCE_CXX17 explicit reverse_iterator(_Iter __x) : __t_(__x), current(__x) {}
84
85 template <class _Up, __enable_if_t<!is_same<_Up, _Iter>::value && is_convertible<_Up const&, _Iter>::value, int> = 0>
86 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator(const reverse_iterator<_Up>& __u)
87 : __t_(__u.base()), current(__u.base()) {}
88
89 template <class _Up,
90 __enable_if_t<!is_same<_Up, _Iter>::value && is_convertible<_Up const&, _Iter>::value &&
91 is_assignable<_Iter&, _Up const&>::value,
92 int> = 0>
93 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator& operator=(const reverse_iterator<_Up>& __u) {
94 __t_ = current = __u.base();
95 return *this;
96 }
97#else
98 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator() : current() {}
99
100 _LIBCPP_CONSTEXPR_SINCE_CXX17 explicit reverse_iterator(_Iter __x) : current(__x) {}
101
102 template <class _Up, __enable_if_t<!is_same<_Up, _Iter>::value && is_convertible<_Up const&, _Iter>::value, int> = 0>
103 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator(const reverse_iterator<_Up>& __u) : current(__u.base()) {}
104
105 template <class _Up,
106 __enable_if_t<!is_same<_Up, _Iter>::value && is_convertible<_Up const&, _Iter>::value &&
107 is_assignable<_Iter&, _Up const&>::value,
108 int> = 0>
109 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator& operator=(const reverse_iterator<_Up>& __u) {
110 current = __u.base();
111 return *this;
112 }
113#endif
114 [[__nodiscard__]] _LIBCPP_CONSTEXPR_SINCE_CXX17 _Iter base() const { return current; }
115 [[__nodiscard__]] _LIBCPP_CONSTEXPR_SINCE_CXX17 reference operator*() const {
116 _Iter __tmp = current;
117 return *--__tmp;
118 }
119
120#if _LIBCPP_STD_VER >= 20
121 constexpr pointer operator->() const
122 requires is_pointer_v<_Iter> || requires(const _Iter __i) { __i.operator->(); }
123 {
124 _Iter __tmp = current;
125 --__tmp;
126 if constexpr (is_pointer_v<_Iter>) {
127 return __tmp;
128 } else {
129 return __tmp.operator->();
130 }
131 }
132#else
133 _LIBCPP_CONSTEXPR_SINCE_CXX17 pointer operator->() const { return std::addressof(operator*()); }
134#endif // _LIBCPP_STD_VER >= 20
135
136 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator& operator++() {
137 --current;
138 return *this;
139 }
140 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator operator++(int) {
141 reverse_iterator __tmp(*this);
142 --current;
143 return __tmp;
144 }
145 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator& operator--() {
146 ++current;
147 return *this;
148 }
149 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator operator--(int) {
150 reverse_iterator __tmp(*this);
151 ++current;
152 return __tmp;
153 }
154 [[__nodiscard__]] _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator operator+(difference_type __n) const {
155 return reverse_iterator(current - __n);
156 }
157 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator& operator+=(difference_type __n) {
158 current -= __n;
159 return *this;
160 }
161 [[__nodiscard__]] _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator operator-(difference_type __n) const {
162 return reverse_iterator(current + __n);
163 }
164 _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator& operator-=(difference_type __n) {
165 current += __n;
166 return *this;
167 }
168 [[__nodiscard__]] _LIBCPP_CONSTEXPR_SINCE_CXX17 reference operator[](difference_type __n) const {
169 return *(*this + __n);
170 }
171
172#if _LIBCPP_STD_VER >= 20
173 [[nodiscard]]
174 friend constexpr iter_rvalue_reference_t<_Iter> iter_move(const reverse_iterator& __i) noexcept(
175 is_nothrow_copy_constructible_v<_Iter> && noexcept(ranges::iter_move(--std::declval<_Iter&>()))) {
176 auto __tmp = __i.base();
177 return ranges::iter_move(--__tmp);
178 }
179
180 template <indirectly_swappable<_Iter> _Iter2>
181 friend constexpr void iter_swap(const reverse_iterator& __x, const reverse_iterator<_Iter2>& __y) noexcept(
182 is_nothrow_copy_constructible_v<_Iter> && is_nothrow_copy_constructible_v<_Iter2> &&
183 noexcept(ranges::iter_swap(--std::declval<_Iter&>(), --std::declval<_Iter2&>()))) {
184 auto __xtmp = __x.base();
185 auto __ytmp = __y.base();
186 ranges::iter_swap(--__xtmp, --__ytmp);
187 }
188#endif // _LIBCPP_STD_VER >= 20
189};
190
191template <class _Iter1, class _Iter2>
192inline _LIBCPP_CONSTEXPR_SINCE_CXX17 bool
193operator==(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y)
194#if _LIBCPP_STD_VER >= 20
195 requires requires {
196 { __x.base() == __y.base() } -> convertible_to<bool>;
197 }
198#endif // _LIBCPP_STD_VER >= 20
199{
200 return __x.base() == __y.base();
201}
202
203template <class _Iter1, class _Iter2>
204inline _LIBCPP_CONSTEXPR_SINCE_CXX17 bool
205operator<(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y)
206#if _LIBCPP_STD_VER >= 20
207 requires requires {
208 { __x.base() > __y.base() } -> convertible_to<bool>;
209 }
210#endif // _LIBCPP_STD_VER >= 20
211{
212 return __x.base() > __y.base();
213}
214
215template <class _Iter1, class _Iter2>
216inline _LIBCPP_CONSTEXPR_SINCE_CXX17 bool
217operator!=(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y)
218#if _LIBCPP_STD_VER >= 20
219 requires requires {
220 { __x.base() != __y.base() } -> convertible_to<bool>;
221 }
222#endif // _LIBCPP_STD_VER >= 20
223{
224 return __x.base() != __y.base();
225}
226
227template <class _Iter1, class _Iter2>
228inline _LIBCPP_CONSTEXPR_SINCE_CXX17 bool
229operator>(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y)
230#if _LIBCPP_STD_VER >= 20
231 requires requires {
232 { __x.base() < __y.base() } -> convertible_to<bool>;
233 }
234#endif // _LIBCPP_STD_VER >= 20
235{
236 return __x.base() < __y.base();
237}
238
239template <class _Iter1, class _Iter2>
240inline _LIBCPP_CONSTEXPR_SINCE_CXX17 bool
241operator>=(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y)
242#if _LIBCPP_STD_VER >= 20
243 requires requires {
244 { __x.base() <= __y.base() } -> convertible_to<bool>;
245 }
246#endif // _LIBCPP_STD_VER >= 20
247{
248 return __x.base() <= __y.base();
249}
250
251template <class _Iter1, class _Iter2>
252inline _LIBCPP_CONSTEXPR_SINCE_CXX17 bool
253operator<=(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y)
254#if _LIBCPP_STD_VER >= 20
255 requires requires {
256 { __x.base() >= __y.base() } -> convertible_to<bool>;
257 }
258#endif // _LIBCPP_STD_VER >= 20
259{
260 return __x.base() >= __y.base();
261}
262
263#if _LIBCPP_STD_VER >= 20
264template <class _Iter1, three_way_comparable_with<_Iter1> _Iter2>
265constexpr compare_three_way_result_t<_Iter1, _Iter2>
266operator<=>(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y) {
267 return __y.base() <=> __x.base();
268}
269#endif // _LIBCPP_STD_VER >= 20
270
271#ifndef _LIBCPP_CXX03_LANG
272template <class _Iter1, class _Iter2>
273[[__nodiscard__]] inline _LIBCPP_CONSTEXPR_SINCE_CXX17 auto
274operator-(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y)
275 -> decltype(__y.base() - __x.base()) {
276 return __y.base() - __x.base();
277}
278#else
279template <class _Iter1, class _Iter2>
280[[__nodiscard__]] inline typename reverse_iterator<_Iter1>::difference_type
281operator-(const reverse_iterator<_Iter1>& __x, const reverse_iterator<_Iter2>& __y) {
282 return __y.base() - __x.base();
283}
284#endif
285
286template <class _Iter>
287[[__nodiscard__]] inline _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator<_Iter>
288operator+(typename reverse_iterator<_Iter>::difference_type __n, const reverse_iterator<_Iter>& __x) {
289 return reverse_iterator<_Iter>(__x.base() - __n);
290}
291
292#if _LIBCPP_STD_VER >= 20
293template <class _Iter1, class _Iter2>
294 requires(!sized_sentinel_for<_Iter1, _Iter2>)
295inline constexpr bool disable_sized_sentinel_for<reverse_iterator<_Iter1>, reverse_iterator<_Iter2>> = true;
296#endif // _LIBCPP_STD_VER >= 20
297
298#if _LIBCPP_STD_VER >= 14
299template <class _Iter>
300[[__nodiscard__]] inline _LIBCPP_CONSTEXPR_SINCE_CXX17 reverse_iterator<_Iter> make_reverse_iterator(_Iter __i) {
301 return reverse_iterator<_Iter>(__i);
302}
303#endif
304
305template <class _Iter, bool __b>
306struct __unwrap_iter_impl<reverse_iterator<reverse_iterator<_Iter> >, __b> {
307 using _UnwrappedIter _LIBCPP_NODEBUG = decltype(__unwrap_iter_impl<_Iter>::__unwrap(std::declval<_Iter>()));
308 using _ReverseWrapper _LIBCPP_NODEBUG = reverse_iterator<reverse_iterator<_Iter> >;
309
310 static _LIBCPP_CONSTEXPR _ReverseWrapper __rewrap(_ReverseWrapper __orig_iter, _UnwrappedIter __unwrapped_iter) {
311 return _ReverseWrapper(
312 reverse_iterator<_Iter>(__unwrap_iter_impl<_Iter>::__rewrap(__orig_iter.base().base(), __unwrapped_iter)));
313 }
314
315 static _LIBCPP_CONSTEXPR _UnwrappedIter __unwrap(_ReverseWrapper __i) _NOEXCEPT {
316 return __unwrap_iter_impl<_Iter>::__unwrap(__i.base().base());
317 }
318};
319
320_LIBCPP_END_NAMESPACE_STD
321
322#endif // _LIBCPP___ITERATOR_REVERSE_ITERATOR_H
323