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
11#define _LIBCPP_RANGES
12
13/*
14
15#include <compare> // see [compare.syn]
16#include <initializer_list> // see [initializer.list.syn]
17#include <iterator> // see [iterator.synopsis]
18
19namespace std::ranges {
20 inline namespace unspecified {
21 // [range.access], range access
22 inline constexpr unspecified begin = unspecified;
23 inline constexpr unspecified end = unspecified;
24 inline constexpr unspecified cbegin = unspecified;
25 inline constexpr unspecified cend = unspecified;
26
27 inline constexpr unspecified size = unspecified;
28 inline constexpr unspecified ssize = unspecified;
29 }
30
31 // [range.range], ranges
32 template<class T>
33 concept range = see below;
34
35 template<class T>
36 inline constexpr bool enable_borrowed_range = false;
37
38 template<class T>
39 using iterator_t = decltype(ranges::begin(declval<T&>()));
40 template<range R>
41 using sentinel_t = decltype(ranges::end(declval<R&>()));
42 template<range R>
43 using range_difference_t = iter_difference_t<iterator_t<R>>;
44 template<sized_range R>
45 using range_size_t = decltype(ranges::size(declval<R&>()));
46 template<range R>
47 using range_value_t = iter_value_t<iterator_t<R>>;
48 template<range R>
49 using range_reference_t = iter_reference_t<iterator_t<R>>;
50 template<range R>
51 using range_rvalue_reference_t = iter_rvalue_reference_t<iterator_t<R>>;
52 template <range R>
53 using range_common_reference_t = iter_common_reference_t<iterator_t<R>>;
54
55 // [range.sized], sized ranges
56 template<class>
57 inline constexpr bool disable_sized_range = false;
58
59 template<class T>
60 concept sized_range = ...;
61
62 // [range.view], views
63 template<class T>
64 inline constexpr bool enable_view = ...;
65
66 struct view_base { };
67
68 template<class T>
69 concept view = ...;
70
71 // [range.refinements], other range refinements
72 template<class R, class T>
73 concept output_range = see below;
74
75 template<class T>
76 concept input_range = see below;
77
78 template<class T>
79 concept forward_range = see below;
80
81 template<class T>
82 concept bidirectional_range = see below;
83
84 template<class T>
85 concept random_access_range = see below;
86
87 template<class T>
88 concept contiguous_range = see below;
89
90 template <class _Tp>
91 concept common_range = see below;
92
93 template<class T>
94 concept viewable_range = see below;
95
96 // [range.adaptor.object], range adaptor objects
97 template<class D>
98 requires is_class_v<D> && same_as<D, remove_cv_t<D>>
99 class range_adaptor_closure { }; // Since c++23
100
101 // [view.interface], class template view_interface
102 template<class D>
103 requires is_class_v<D> && same_as<D, remove_cv_t<D>>
104 class view_interface;
105
106 // [range.subrange], sub-ranges
107 enum class subrange_kind : bool { unsized, sized };
108
109 template<input_or_output_iterator I, sentinel_for<I> S = I, subrange_kind K = see below>
110 requires (K == subrange_kind::sized || !sized_sentinel_for<S, I>)
111 class subrange;
112
113 template<class I, class S, subrange_kind K>
114 inline constexpr bool enable_borrowed_range<subrange<I, S, K>> = true;
115
116 // [range.dangling], dangling iterator handling
117 struct dangling;
118
119 // [range.elementsof], class template elements_of
120 template<range R, class Allocator = allocator<byte>>
121 struct elements_of;
122
123 template<range R>
124 using borrowed_iterator_t = see below;
125
126 template<range R>
127 using borrowed_subrange_t = see below;
128
129 // [range.elements], elements view
130 template<input_range V, size_t N>
131 requires see below
132 class elements_view;
133
134 template<class T, size_t N>
135 inline constexpr bool enable_borrowed_range<elements_view<T, N>> =
136 enable_borrowed_range<T>;
137
138 template<class R>
139 using keys_view = elements_view<R, 0>;
140 template<class R>
141 using values_view = elements_view<R, 1>;
142
143 namespace views {
144 template<size_t N>
145 inline constexpr unspecified elements = unspecified;
146 inline constexpr auto keys = elements<0>;
147 inline constexpr auto values = elements<1>;
148 }
149
150 // [range.utility.conv], range conversions
151 template<class C, input_range R, class... Args> requires (!view<C>)
152 constexpr C to(R&& r, Args&&... args); // Since C++23
153 template<template<class...> class C, input_range R, class... Args>
154 constexpr auto to(R&& r, Args&&... args); // Since C++23
155 template<class C, class... Args> requires (!view<C>)
156 constexpr auto to(Args&&... args); // Since C++23
157 template<template<class...> class C, class... Args>
158 constexpr auto to(Args&&... args); // Since C++23
159
160 // [range.empty], empty view
161 template<class T>
162 requires is_object_v<T>
163 class empty_view;
164
165 template<class T>
166 inline constexpr bool enable_borrowed_range<empty_view<T>> = true;
167
168 namespace views {
169 template<class T>
170 inline constexpr empty_view<T> empty{};
171 }
172
173 // [range.all], all view
174 namespace views {
175 inline constexpr unspecified all = unspecified;
176
177 template<viewable_range R>
178 using all_t = decltype(all(declval<R>()));
179 }
180
181 template<range R>
182 requires is_object_v<R>
183 class ref_view;
184
185 template<class T>
186 inline constexpr bool enable_borrowed_range<ref_view<T>> = true;
187
188 template<range R>
189 requires see below
190 class owning_view;
191
192 template<class T>
193 inline constexpr bool enable_borrowed_range<owning_view<T>> = enable_borrowed_range<T>;
194
195 // [range.filter], filter view
196 template<input_range V, indirect_unary_predicate<iterator_t<V>> Pred>
197 requires view<V> && is_object_v<Pred>
198 class filter_view;
199
200 namespace views {
201 inline constexpr unspecified filter = unspecified;
202 }
203
204 // [range.drop], drop view
205 template<view V>
206 class drop_view;
207
208 template<class T>
209 inline constexpr bool enable_borrowed_range<drop_view<T>> = enable_borrowed_range<T>;
210
211 // [range.drop.while], drop while view
212 template<view V, class Pred>
213 requires input_range<V> && is_object_v<Pred> &&
214 indirect_unary_predicate<const Pred, iterator_t<V>>
215 class drop_while_view;
216
217 template<class T, class Pred>
218 inline constexpr bool enable_borrowed_range<drop_while_view<T, Pred>> =
219 enable_borrowed_range<T>;
220
221 namespace views { inline constexpr unspecified drop_while = unspecified; }
222
223 // [range.transform], transform view
224 template<input_range V, copy_constructible F>
225 requires view<V> && is_object_v<F> &&
226 regular_invocable<F&, range_reference_t<V>> &&
227 can-reference<invoke_result_t<F&, range_reference_t<V>>>
228 class transform_view;
229
230 // [range.counted], counted view
231 namespace views { inline constexpr unspecified counted = unspecified; }
232
233 // [range.common], common view
234 template<view V>
235 requires (!common_range<V> && copyable<iterator_t<V>>)
236 class common_view;
237
238 // [range.reverse], reverse view
239 template<view V>
240 requires bidirectional_range<V>
241 class reverse_view;
242
243 template<class T>
244 inline constexpr bool enable_borrowed_range<reverse_view<T>> = enable_borrowed_range<T>;
245
246 template<class T>
247 inline constexpr bool enable_borrowed_range<common_view<T>> = enable_borrowed_range<T>;
248
249 // [range.take], take view
250 template<view> class take_view;
251
252 template<class T>
253 inline constexpr bool enable_borrowed_range<take_view<T>> = enable_borrowed_range<T>;
254
255 // [range.take.while], take while view
256 template<view V, class Pred>
257 requires input_range<V> && is_object_v<Pred> &&
258 indirect_unary_predicate<const Pred, iterator_t<V>>
259 class take_while_view;
260
261 namespace views { inline constexpr unspecified take_while = unspecified; }
262
263 template<copy_constructible T>
264 requires is_object_v<T>
265 class single_view;
266
267 template<weakly_incrementable W, semiregular Bound = unreachable_sentinel_t>
268 requires weakly-equality-comparable-with<W, Bound> && copyable<W>
269 class iota_view;
270
271 template<class W, class Bound>
272 inline constexpr bool enable_borrowed_range<iota_view<W, Bound>> = true;
273
274 namespace views {
275 inline constexpr unspecified iota = unspecified;
276 inline constexpr unspecified indices = unspecified; // Since C++26
277 }
278
279 // [range.repeat], repeat view
280 template<class T>
281 concept integer-like-with-usable-difference-type = // exposition only
282 is-signed-integer-like<T> || (is-integer-like<T> && weakly_incrementable<T>);
283
284 template<move_constructible T, semiregular Bound = unreachable_sentinel_t>
285 requires (is_object_v<T> && same_as<T, remove_cv_t<T>> &&
286 (integer-like-with-usable-difference-type<Bound> ||
287 same_as<Bound, unreachable_sentinel_t>))
288 class repeat_view;
289
290 namespace views { inline constexpr unspecified repeat = unspecified; }
291
292 // [range.join], join view
293 template<input_range V>
294 requires view<V> && input_range<range_reference_t<V>>
295 class join_view;
296
297 // [range.join.with], join with view
298 template<input_range V, forward_range Pattern>
299 requires view<V> && input_range<range_reference_t<V>>
300 && view<Pattern>
301 && concatable<range_reference_t<V>, Pattern>
302 class join_with_view; // since C++23
303
304 namespace views { inline constexpr unspecified join_with = unspecified; } // since C++23
305
306 // [range.lazy.split], lazy split view
307 template<class R>
308 concept tiny-range = see below; // exposition only
309
310 template<input_range V, forward_range Pattern>
311 requires view<V> && view<Pattern> &&
312 indirectly_comparable<iterator_t<V>, iterator_t<Pattern>, ranges::equal_to> &&
313 (forward_range<V> || tiny-range<Pattern>)
314 class lazy_split_view;
315
316 // [range.split], split view
317 template<forward_range V, forward_range Pattern>
318 requires view<V> && view<Pattern> &&
319 indirectly_comparable<iterator_t<V>, iterator_t<Pattern>, ranges::equal_to>
320 class split_view;
321
322 namespace views {
323 inline constexpr unspecified lazy_split = unspecified;
324 inline constexpr unspecified split = unspecified;
325 }
326
327 // [range.istream], istream view
328 template<movable Val, class CharT, class Traits = char_traits<CharT>>
329 requires see below
330 class basic_istream_view;
331
332 template<class Val>
333 using istream_view = basic_istream_view<Val, char>;
334
335 template<class Val>
336 using wistream_view = basic_istream_view<Val, wchar_t>;
337
338 namespace views { template<class T> inline constexpr unspecified istream = unspecified; }
339
340 // [range.zip], zip view
341 template<input_range... Views>
342 requires (view<Views> && ...) && (sizeof...(Views) > 0)
343 class zip_view; // C++23
344
345 template<class... Views>
346 inline constexpr bool enable_borrowed_range<zip_view<Views...>> = // C++23
347 (enable_borrowed_range<Views> && ...);
348
349 namespace views { inline constexpr unspecified zip = unspecified; } // C++23
350
351 // [range.zip.transform], zip transform view
352 template<move_constructible F, input_range... Views>
353 requires (view<Views> && ...) && (sizeof...(Views) > 0) && is_object_v<F> &&
354 regular_invocable<F&, range_reference_t<Views>...> &&
355 can-reference<invoke_result_t<F&, range_reference_t<Views>...>>
356 class zip_transform_view; // C++23
357
358 namespace views { inline constexpr unspecified zip_transform = unspecified; } // C++23
359
360 // [range.adjacent], adjacent view
361 template<forward_range V, size_t N>
362 requires view<V> && (N > 0)
363 class adjacent_view;
364
365 template<class V, size_t N>
366 constexpr bool enable_borrowed_range<adjacent_view<V, N>> =
367 enable_borrowed_range<V>;
368
369 namespace views {
370 template<size_t N>
371 constexpr unspecified adjacent = unspecified;
372 inline constexpr auto pairwise = adjacent<2>;
373 }
374
375 // [range.adjacent.transform], adjacent transform view
376 template<forward_range V, move_constructible F, size_t N>
377 requires see below
378 class adjacent_transform_view;
379
380 namespace views {
381 template<size_t N>
382 constexpr unspecified adjacent_transform = unspecified;
383 inline constexpr auto pairwise_transform = adjacent_transform<2>;
384 }
385
386 // [range.as.rvalue]
387 template <view V>
388 requires input_range<V>
389 class as_rvalue_view; // C++23
390
391 namespace views { inline constexpr unspecified as_rvalue ) unspecified; } // C++23
392
393 [range.chunk.by]
394 template<forward_range V, indirect_binary_predicate<iterator_t<V>, iterator_t<V>> Pred>
395 requires view<V> && is_object_v<Pred>
396 class chunk_by_view; // C++23
397
398 namespace views { inline constexpr unspecified chunk_by = unspecified; } // C++23
399}
400
401namespace std {
402 namespace views = ranges::views;
403
404 template<class T> struct tuple_size;
405 template<size_t I, class T> struct tuple_element;
406
407 template<class I, class S, ranges::subrange_kind K>
408 struct tuple_size<ranges::subrange<I, S, K>>
409 : integral_constant<size_t, 2> {};
410
411 template<class I, class S, ranges::subrange_kind K>
412 struct tuple_element<0, ranges::subrange<I, S, K>> {
413 using type = I;
414 };
415
416 template<class I, class S, ranges::subrange_kind K>
417 struct tuple_element<1, ranges::subrange<I, S, K>> {
418 using type = S;
419 };
420
421 template<class I, class S, ranges::subrange_kind K>
422 struct tuple_element<0, const ranges::subrange<I, S, K>> {
423 using type = I;
424 };
425
426 template<class I, class S, ranges::subrange_kind K>
427 struct tuple_element<1, const ranges::subrange<I, S, K>> {
428 using type = S;
429 };
430
431 struct from_range_t { explicit from_range_t() = default; }; // Since C++23
432 inline constexpr from_range_t from_range{}; // Since C++23
433}
434*/
435
436#if __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
437# include <__cxx03/__config>
438#else
439# include <__config>
440
441# if _LIBCPP_STD_VER >= 20
442# include <__ranges/access.h>
443# include <__ranges/all.h>
444# include <__ranges/common_view.h>
445# include <__ranges/concepts.h>
446# include <__ranges/counted.h>
447# include <__ranges/dangling.h>
448# include <__ranges/data.h>
449# include <__ranges/drop_view.h>
450# include <__ranges/drop_while_view.h>
451# include <__ranges/elements_of.h>
452# include <__ranges/elements_view.h>
453# include <__ranges/empty.h>
454# include <__ranges/empty_view.h>
455# include <__ranges/enable_borrowed_range.h>
456# include <__ranges/enable_view.h>
457# include <__ranges/filter_view.h>
458# include <__ranges/iota_view.h>
459# include <__ranges/join_view.h>
460# include <__ranges/lazy_split_view.h>
461# include <__ranges/rbegin.h>
462# include <__ranges/ref_view.h>
463# include <__ranges/rend.h>
464# include <__ranges/reverse_view.h>
465# include <__ranges/single_view.h>
466# include <__ranges/size.h>
467# include <__ranges/split_view.h>
468# include <__ranges/subrange.h>
469# include <__ranges/take_view.h>
470# include <__ranges/take_while_view.h>
471# include <__ranges/transform_view.h>
472# include <__ranges/view_interface.h>
473# include <__ranges/views.h>
474
475# if _LIBCPP_HAS_LOCALIZATION
476# include <__ranges/istream_view.h>
477# endif
478# endif
479
480# if _LIBCPP_STD_VER >= 23
481# include <__ranges/adjacent_transform_view.h>
482# include <__ranges/adjacent_view.h>
483# include <__ranges/as_rvalue_view.h>
484# include <__ranges/chunk_by_view.h>
485# include <__ranges/from_range.h>
486# include <__ranges/join_with_view.h>
487# include <__ranges/repeat_view.h>
488# include <__ranges/to.h>
489# include <__ranges/zip_transform_view.h>
490# include <__ranges/zip_view.h>
491# endif
492
493# include <version>
494
495// standard-mandated includes
496
497// [ranges.syn]
498# include <compare>
499# include <initializer_list>
500# include <iterator>
501
502// [tuple.helper]
503# include <__tuple/tuple_element.h>
504# include <__tuple/tuple_size.h>
505
506# if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
507# pragma GCC system_header
508# endif
509
510# if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
511# include <cstdlib>
512# include <iosfwd>
513# include <type_traits>
514# endif
515#endif // __cplusplus < 201103L && defined(_LIBCPP_USE_FROZEN_CXX03_HEADERS)
516
517#endif // _LIBCPP_RANGES
518