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___RANGES_ELEMENTS_VIEW_H
11#define _LIBCPP___RANGES_ELEMENTS_VIEW_H
12
13#include <__compare/three_way_comparable.h>
14#include <__concepts/constructible.h>
15#include <__concepts/convertible_to.h>
16#include <__concepts/derived_from.h>
17#include <__concepts/equality_comparable.h>
18#include <__config>
19#include <__fwd/get.h>
20#include <__iterator/concepts.h>
21#include <__iterator/iterator_traits.h>
22#include <__ranges/access.h>
23#include <__ranges/all.h>
24#include <__ranges/concepts.h>
25#include <__ranges/enable_borrowed_range.h>
26#include <__ranges/range_adaptor.h>
27#include <__ranges/size.h>
28#include <__ranges/view_interface.h>
29#include <__tuple/tuple_element.h>
30#include <__tuple/tuple_like.h>
31#include <__tuple/tuple_size.h>
32#include <__type_traits/is_reference.h>
33#include <__type_traits/maybe_const.h>
34#include <__type_traits/remove_cv.h>
35#include <__type_traits/remove_cvref.h>
36#include <__type_traits/remove_reference.h>
37#include <__utility/declval.h>
38#include <__utility/forward.h>
39#include <__utility/move.h>
40#include <tuple> // std::get
41
42#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
43# pragma GCC system_header
44#endif
45
46_LIBCPP_PUSH_MACROS
47#include <__undef_macros>
48
49#if _LIBCPP_STD_VER >= 20
50
51_LIBCPP_BEGIN_NAMESPACE_STD
52
53namespace ranges {
54
55template <class _Tp, size_t _Np>
56concept __has_tuple_element = __tuple_like<_Tp> && _Np < tuple_size<_Tp>::value && requires(_Tp __t) {
57 { std::get<_Np>(__t) } -> convertible_to<const tuple_element_t<_Np, _Tp>&>;
58};
59
60template <class _Tp, size_t _Np>
61concept __returnable_element = is_reference_v<_Tp> || move_constructible<tuple_element_t<_Np, _Tp>>;
62
63template <input_range _View, size_t _Np>
64 requires view<_View> && __has_tuple_element<range_value_t<_View>, _Np> &&
65 __has_tuple_element<remove_reference_t<range_reference_t<_View>>, _Np> &&
66 __returnable_element<range_reference_t<_View>, _Np>
67class elements_view : public view_interface<elements_view<_View, _Np>> {
68private:
69 template <bool>
70 class __iterator;
71
72 template <bool>
73 class __sentinel;
74
75public:
76 _LIBCPP_HIDE_FROM_ABI elements_view()
77 requires default_initializable<_View>
78 = default;
79
80 _LIBCPP_HIDE_FROM_ABI constexpr explicit elements_view(_View __base) : __base_(std::move(__base)) {}
81
82 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr _View base() const&
83 requires copy_constructible<_View>
84 {
85 return __base_;
86 }
87
88 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr _View base() && { return std::move(__base_); }
89
90 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto begin()
91 requires(!__simple_view<_View>)
92 {
93 return __iterator</*_Const=*/false>(ranges::begin(__base_));
94 }
95
96 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto begin() const
97 requires range<const _View>
98 {
99 return __iterator</*_Const=*/true>(ranges::begin(__base_));
100 }
101
102 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto end()
103 requires(!__simple_view<_View> && !common_range<_View>)
104 {
105 return __sentinel</*_Const=*/false>{ranges::end(__base_)};
106 }
107
108 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto end()
109 requires(!__simple_view<_View> && common_range<_View>)
110 {
111 return __iterator</*_Const=*/false>{ranges::end(__base_)};
112 }
113
114 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto end() const
115 requires range<const _View>
116 {
117 return __sentinel</*_Const=*/true>{ranges::end(__base_)};
118 }
119
120 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto end() const
121 requires common_range<const _View>
122 {
123 return __iterator</*_Const=*/true>{ranges::end(__base_)};
124 }
125
126 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto size()
127 requires sized_range<_View>
128 {
129 return ranges::size(__base_);
130 }
131
132 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto size() const
133 requires sized_range<const _View>
134 {
135 return ranges::size(__base_);
136 }
137
138private:
139 _LIBCPP_NO_UNIQUE_ADDRESS _View __base_ = _View();
140};
141
142template <class, size_t>
143struct __elements_view_iterator_category_base {};
144
145template <forward_range _Base, size_t _Np>
146struct __elements_view_iterator_category_base<_Base, _Np> {
147 static consteval auto __get_iterator_category() {
148 using _Result = decltype(std::get<_Np>(*std::declval<iterator_t<_Base>>()));
149 using _Cat = typename iterator_traits<iterator_t<_Base>>::iterator_category;
150
151 if constexpr (!is_lvalue_reference_v<_Result>) {
152 return input_iterator_tag{};
153 } else if constexpr (derived_from<_Cat, random_access_iterator_tag>) {
154 return random_access_iterator_tag{};
155 } else {
156 return _Cat{};
157 }
158 }
159
160 using iterator_category = decltype(__get_iterator_category());
161};
162
163template <input_range _View, size_t _Np>
164 requires view<_View> && __has_tuple_element<range_value_t<_View>, _Np> &&
165 __has_tuple_element<remove_reference_t<range_reference_t<_View>>, _Np> &&
166 __returnable_element<range_reference_t<_View>, _Np>
167template <bool _Const>
168class elements_view<_View, _Np>::__iterator
169 : public __elements_view_iterator_category_base<__maybe_const<_Const, _View>, _Np> {
170 friend class elements_view<_View, _Np>;
171
172 template <bool>
173 friend class __iterator;
174
175 template <bool>
176 friend class __sentinel;
177
178 using _Base _LIBCPP_NODEBUG = __maybe_const<_Const, _View>;
179
180 iterator_t<_Base> __current_ = iterator_t<_Base>();
181
182 _LIBCPP_HIDE_FROM_ABI constexpr explicit __iterator(iterator_t<_Base> __current) : __current_(std::move(__current)) {}
183
184 _LIBCPP_HIDE_FROM_ABI static constexpr decltype(auto) __get_element(const iterator_t<_Base>& __i) {
185 if constexpr (is_reference_v<range_reference_t<_Base>>) {
186 return std::get<_Np>(*__i);
187 } else {
188 using _Element = remove_cv_t<tuple_element_t<_Np, range_reference_t<_Base>>>;
189 return static_cast<_Element>(std::get<_Np>(*__i));
190 }
191 }
192
193 static consteval auto __get_iterator_concept() {
194 if constexpr (random_access_range<_Base>) {
195 return random_access_iterator_tag{};
196 } else if constexpr (bidirectional_range<_Base>) {
197 return bidirectional_iterator_tag{};
198 } else if constexpr (forward_range<_Base>) {
199 return forward_iterator_tag{};
200 } else {
201 return input_iterator_tag{};
202 }
203 }
204
205public:
206 using iterator_concept = decltype(__iterator::__get_iterator_concept());
207 using value_type = remove_cvref_t<tuple_element_t<_Np, range_value_t<_Base>>>;
208 using difference_type = range_difference_t<_Base>;
209
210 _LIBCPP_HIDE_FROM_ABI __iterator()
211 requires default_initializable<iterator_t<_Base>>
212 = default;
213
214 _LIBCPP_HIDE_FROM_ABI constexpr __iterator(__iterator<!_Const> __i)
215 requires _Const && convertible_to<iterator_t<_View>, iterator_t<_Base>>
216 : __current_(std::move(__i.__current_)) {}
217
218 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr const iterator_t<_Base>& base() const& noexcept { return __current_; }
219
220 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr iterator_t<_Base> base() && { return std::move(__current_); }
221
222 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr decltype(auto) operator*() const { return __get_element(i: __current_); }
223
224 _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator++() {
225 ++__current_;
226 return *this;
227 }
228
229 _LIBCPP_HIDE_FROM_ABI constexpr void operator++(int) { ++__current_; }
230
231 _LIBCPP_HIDE_FROM_ABI constexpr __iterator operator++(int)
232 requires forward_range<_Base>
233 {
234 auto __temp = *this;
235 ++__current_;
236 return __temp;
237 }
238
239 _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator--()
240 requires bidirectional_range<_Base>
241 {
242 --__current_;
243 return *this;
244 }
245
246 _LIBCPP_HIDE_FROM_ABI constexpr __iterator operator--(int)
247 requires bidirectional_range<_Base>
248 {
249 auto __temp = *this;
250 --__current_;
251 return __temp;
252 }
253
254 _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator+=(difference_type __n)
255 requires random_access_range<_Base>
256 {
257 __current_ += __n;
258 return *this;
259 }
260
261 _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator-=(difference_type __n)
262 requires random_access_range<_Base>
263 {
264 __current_ -= __n;
265 return *this;
266 }
267
268 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr decltype(auto) operator[](difference_type __n) const
269 requires random_access_range<_Base>
270 {
271 return __get_element(i: __current_ + __n);
272 }
273
274 _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator& __x, const __iterator& __y)
275 requires equality_comparable<iterator_t<_Base>>
276 {
277 return __x.__current_ == __y.__current_;
278 }
279
280 _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator<(const __iterator& __x, const __iterator& __y)
281 requires random_access_range<_Base>
282 {
283 return __x.__current_ < __y.__current_;
284 }
285
286 _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator>(const __iterator& __x, const __iterator& __y)
287 requires random_access_range<_Base>
288 {
289 return __y < __x;
290 }
291
292 _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator<=(const __iterator& __x, const __iterator& __y)
293 requires random_access_range<_Base>
294 {
295 return !(__y < __x);
296 }
297
298 _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator>=(const __iterator& __x, const __iterator& __y)
299 requires random_access_range<_Base>
300 {
301 return !(__x < __y);
302 }
303
304 _LIBCPP_HIDE_FROM_ABI friend constexpr auto operator<=>(const __iterator& __x, const __iterator& __y)
305 requires random_access_range<_Base> && three_way_comparable<iterator_t<_Base>>
306 {
307 return __x.__current_ <=> __y.__current_;
308 }
309
310 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI friend constexpr __iterator operator+(const __iterator& __x, difference_type __y)
311 requires random_access_range<_Base>
312 {
313 return __iterator{__x} += __y;
314 }
315
316 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI friend constexpr __iterator operator+(difference_type __x, const __iterator& __y)
317 requires random_access_range<_Base>
318 {
319 return __y + __x;
320 }
321
322 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI friend constexpr __iterator operator-(const __iterator& __x, difference_type __y)
323 requires random_access_range<_Base>
324 {
325 return __iterator{__x} -= __y;
326 }
327
328 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI friend constexpr difference_type
329 operator-(const __iterator& __x, const __iterator& __y)
330 requires sized_sentinel_for<iterator_t<_Base>, iterator_t<_Base>>
331 {
332 return __x.__current_ - __y.__current_;
333 }
334};
335
336template <input_range _View, size_t _Np>
337 requires view<_View> && __has_tuple_element<range_value_t<_View>, _Np> &&
338 __has_tuple_element<remove_reference_t<range_reference_t<_View>>, _Np> &&
339 __returnable_element<range_reference_t<_View>, _Np>
340template <bool _Const>
341class elements_view<_View, _Np>::__sentinel {
342private:
343 using _Base _LIBCPP_NODEBUG = __maybe_const<_Const, _View>;
344 _LIBCPP_NO_UNIQUE_ADDRESS sentinel_t<_Base> __end_ = sentinel_t<_Base>();
345
346 _LIBCPP_HIDE_FROM_ABI constexpr explicit __sentinel(sentinel_t<_Base> __end) : __end_(std::move(__end)) {}
347
348 friend class elements_view<_View, _Np>;
349
350 template <bool>
351 friend class __sentinel;
352
353 template <bool _AnyConst>
354 _LIBCPP_HIDE_FROM_ABI static constexpr decltype(auto) __get_current(const __iterator<_AnyConst>& __iter) {
355 return (__iter.__current_);
356 }
357
358public:
359 _LIBCPP_HIDE_FROM_ABI __sentinel() = default;
360
361 _LIBCPP_HIDE_FROM_ABI constexpr __sentinel(__sentinel<!_Const> __other)
362 requires _Const && convertible_to<sentinel_t<_View>, sentinel_t<_Base>>
363 : __end_(std::move(__other.__end_)) {}
364
365 _LIBCPP_HIDE_FROM_ABI constexpr sentinel_t<_Base> base() const { return __end_; }
366
367 template <bool _OtherConst>
368 requires sentinel_for<sentinel_t<_Base>, iterator_t<__maybe_const<_OtherConst, _View>>>
369 _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator<_OtherConst>& __x, const __sentinel& __y) {
370 return __get_current(__x) == __y.__end_;
371 }
372
373 template <bool _OtherConst>
374 requires sized_sentinel_for<sentinel_t<_Base>, iterator_t<__maybe_const<_OtherConst, _View>>>
375 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI friend constexpr range_difference_t<__maybe_const<_OtherConst, _View>>
376 operator-(const __iterator<_OtherConst>& __x, const __sentinel& __y) {
377 return __get_current(__x) - __y.__end_;
378 }
379
380 template <bool _OtherConst>
381 requires sized_sentinel_for<sentinel_t<_Base>, iterator_t<__maybe_const<_OtherConst, _View>>>
382 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI friend constexpr range_difference_t<__maybe_const<_OtherConst, _View>>
383 operator-(const __sentinel& __x, const __iterator<_OtherConst>& __y) {
384 return __x.__end_ - __get_current(__y);
385 }
386};
387
388template <class _Tp, size_t _Np>
389inline constexpr bool enable_borrowed_range<elements_view<_Tp, _Np>> = enable_borrowed_range<_Tp>;
390
391template <class _Tp>
392using keys_view = elements_view<_Tp, 0>;
393template <class _Tp>
394using values_view = elements_view<_Tp, 1>;
395
396namespace views {
397namespace __elements {
398
399template <size_t _Np>
400struct __fn : __range_adaptor_closure<__fn<_Np>> {
401 template <class _Range>
402 [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto operator()(_Range&& __range) const
403 /**/ noexcept(noexcept(elements_view<all_t<_Range&&>, _Np>(std::forward<_Range>(__range))))
404 /*------*/ -> decltype(elements_view<all_t<_Range&&>, _Np>(std::forward<_Range>(__range))) {
405 /*-------------*/ return elements_view<all_t<_Range&&>, _Np>(std::forward<_Range>(__range));
406 }
407};
408} // namespace __elements
409
410inline namespace __cpo {
411template <size_t _Np>
412inline constexpr auto elements = __elements::__fn<_Np>{};
413inline constexpr auto keys = elements<0>;
414inline constexpr auto values = elements<1>;
415} // namespace __cpo
416} // namespace views
417} // namespace ranges
418
419_LIBCPP_END_NAMESPACE_STD
420
421#endif // _LIBCPP_STD_VER >= 20
422
423_LIBCPP_POP_MACROS
424
425#endif // _LIBCPP___RANGES_ELEMENTS_VIEW_H
426