xref: /freebsd/contrib/llvm-project/libcxx/include/ranges (revision fe6060f10f634930ff71b7c50291ddc610da2475)
1*fe6060f1SDimitry Andric// -*- C++ -*-
2*fe6060f1SDimitry Andric//===--------------------------- ranges -----------------------------------===//
3*fe6060f1SDimitry Andric//
4*fe6060f1SDimitry Andric// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5*fe6060f1SDimitry Andric// See https://llvm.org/LICENSE.txt for license information.
6*fe6060f1SDimitry Andric// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7*fe6060f1SDimitry Andric//
8*fe6060f1SDimitry Andric//===----------------------------------------------------------------------===//
9*fe6060f1SDimitry Andric
10*fe6060f1SDimitry Andric#ifndef _LIBCPP_RANGES
11*fe6060f1SDimitry Andric#define _LIBCPP_RANGES
12*fe6060f1SDimitry Andric
13*fe6060f1SDimitry Andric/*
14*fe6060f1SDimitry Andric
15*fe6060f1SDimitry Andric#include <compare>              // see [compare.syn]
16*fe6060f1SDimitry Andric#include <initializer_list>     // see [initializer.list.syn]
17*fe6060f1SDimitry Andric#include <iterator>             // see [iterator.synopsis]
18*fe6060f1SDimitry Andric
19*fe6060f1SDimitry Andricnamespace std::ranges {
20*fe6060f1SDimitry Andric  inline namespace unspecified {
21*fe6060f1SDimitry Andric    // [range.access], range access
22*fe6060f1SDimitry Andric    inline constexpr unspecified begin = unspecified;
23*fe6060f1SDimitry Andric    inline constexpr unspecified end = unspecified;
24*fe6060f1SDimitry Andric    inline constexpr unspecified cbegin = unspecified;
25*fe6060f1SDimitry Andric    inline constexpr unspecified cend = unspecified;
26*fe6060f1SDimitry Andric
27*fe6060f1SDimitry Andric    inline constexpr unspecified size = unspecified;
28*fe6060f1SDimitry Andric    inline constexpr unspecified ssize = unspecified;
29*fe6060f1SDimitry Andric  }
30*fe6060f1SDimitry Andric
31*fe6060f1SDimitry Andric  // [range.range], ranges
32*fe6060f1SDimitry Andric  template<class T>
33*fe6060f1SDimitry Andric    concept range = see below;
34*fe6060f1SDimitry Andric
35*fe6060f1SDimitry Andric  template<class T>
36*fe6060f1SDimitry Andric    inline constexpr bool enable_borrowed_range = false;
37*fe6060f1SDimitry Andric
38*fe6060f1SDimitry Andric  template<class T>
39*fe6060f1SDimitry Andric    using iterator_t = decltype(ranges::begin(declval<R&>()));
40*fe6060f1SDimitry Andric  template<range R>
41*fe6060f1SDimitry Andric    using sentinel_t = decltype(ranges::end(declval<R&>()));
42*fe6060f1SDimitry Andric  template<range R>
43*fe6060f1SDimitry Andric    using range_difference_t = iter_difference_t<iterator_t<R>>;
44*fe6060f1SDimitry Andric  template<sized_range R>
45*fe6060f1SDimitry Andric    using range_size_t = decltype(ranges::size(declval<R&>()));
46*fe6060f1SDimitry Andric  template<range R>
47*fe6060f1SDimitry Andric    using range_value_t = iter_value_t<iterator_t<R>>;
48*fe6060f1SDimitry Andric  template<range R>
49*fe6060f1SDimitry Andric    using range_reference_t = iter_reference_t<iterator_t<R>>;
50*fe6060f1SDimitry Andric  template<range R>
51*fe6060f1SDimitry Andric    using range_rvalue_reference_t = iter_rvalue_reference_t<iterator_t<R>>;
52*fe6060f1SDimitry Andric
53*fe6060f1SDimitry Andric  // [range.sized], sized ranges
54*fe6060f1SDimitry Andric  template<class>
55*fe6060f1SDimitry Andric    inline constexpr bool disable_sized_range = false;
56*fe6060f1SDimitry Andric
57*fe6060f1SDimitry Andric  template<class T>
58*fe6060f1SDimitry Andric    concept sized_range = ...;
59*fe6060f1SDimitry Andric
60*fe6060f1SDimitry Andric  // [range.view], views
61*fe6060f1SDimitry Andric  template<class T>
62*fe6060f1SDimitry Andric    inline constexpr bool enable_view = ...;
63*fe6060f1SDimitry Andric
64*fe6060f1SDimitry Andric  struct view_base { };
65*fe6060f1SDimitry Andric
66*fe6060f1SDimitry Andric  template<class T>
67*fe6060f1SDimitry Andric    concept view = ...;
68*fe6060f1SDimitry Andric
69*fe6060f1SDimitry Andric  // [range.refinements], other range refinements
70*fe6060f1SDimitry Andric  template<class R, class T>
71*fe6060f1SDimitry Andric    concept output_range = see below;
72*fe6060f1SDimitry Andric
73*fe6060f1SDimitry Andric  template<class T>
74*fe6060f1SDimitry Andric    concept input_range = see below;
75*fe6060f1SDimitry Andric
76*fe6060f1SDimitry Andric  template<class T>
77*fe6060f1SDimitry Andric    concept forward_range = see below;
78*fe6060f1SDimitry Andric
79*fe6060f1SDimitry Andric  template<class T>
80*fe6060f1SDimitry Andric  concept bidirectional_range = see below;
81*fe6060f1SDimitry Andric
82*fe6060f1SDimitry Andric  template<class T>
83*fe6060f1SDimitry Andric  concept random_access_range = see below;
84*fe6060f1SDimitry Andric
85*fe6060f1SDimitry Andric  template<class T>
86*fe6060f1SDimitry Andric  concept contiguous_range = see below;
87*fe6060f1SDimitry Andric
88*fe6060f1SDimitry Andric  template <class _Tp>
89*fe6060f1SDimitry Andric    concept common_range = see below;
90*fe6060f1SDimitry Andric
91*fe6060f1SDimitry Andric  template<class T>
92*fe6060f1SDimitry Andric  concept viewable_range = see below;
93*fe6060f1SDimitry Andric
94*fe6060f1SDimitry Andric  // [view.interface], class template view_interface
95*fe6060f1SDimitry Andric  template<class D>
96*fe6060f1SDimitry Andric    requires is_class_v<D> && same_as<D, remove_cv_t<D>>
97*fe6060f1SDimitry Andric  class view_interface;
98*fe6060f1SDimitry Andric
99*fe6060f1SDimitry Andric  // [range.subrange], sub-ranges
100*fe6060f1SDimitry Andric  enum class subrange_kind : bool { unsized, sized };
101*fe6060f1SDimitry Andric
102*fe6060f1SDimitry Andric  template<input_or_output_iterator I, sentinel_for<I> S = I, subrange_kind K = see below>
103*fe6060f1SDimitry Andric    requires (K == subrange_kind::sized || !sized_sentinel_for<S, I>)
104*fe6060f1SDimitry Andric  class subrange;
105*fe6060f1SDimitry Andric
106*fe6060f1SDimitry Andric  template<class I, class S, subrange_kind K>
107*fe6060f1SDimitry Andric    inline constexpr bool enable_borrowed_range<subrange<I, S, K>> = true;
108*fe6060f1SDimitry Andric
109*fe6060f1SDimitry Andric  // [range.dangling], dangling iterator handling
110*fe6060f1SDimitry Andric  struct dangling;
111*fe6060f1SDimitry Andric
112*fe6060f1SDimitry Andric  template<range R>
113*fe6060f1SDimitry Andric    using borrowed_iterator_t = see below;
114*fe6060f1SDimitry Andric
115*fe6060f1SDimitry Andric  template<range R>
116*fe6060f1SDimitry Andric    using borrowed_subrange_t = see below;
117*fe6060f1SDimitry Andric
118*fe6060f1SDimitry Andric  // [range.empty], empty view
119*fe6060f1SDimitry Andric  template<class T>
120*fe6060f1SDimitry Andric    requires is_object_v<T>
121*fe6060f1SDimitry Andric  class empty_view;
122*fe6060f1SDimitry Andric
123*fe6060f1SDimitry Andric  // [range.all], all view
124*fe6060f1SDimitry Andric  namespace views {
125*fe6060f1SDimitry Andric    inline constexpr unspecified all = unspecified;
126*fe6060f1SDimitry Andric
127*fe6060f1SDimitry Andric    template<viewable_range R>
128*fe6060f1SDimitry Andric      using all_t = decltype(all(declval<R>()));
129*fe6060f1SDimitry Andric  }
130*fe6060f1SDimitry Andric
131*fe6060f1SDimitry Andric  template<range R>
132*fe6060f1SDimitry Andric    requires is_object_v<R>
133*fe6060f1SDimitry Andric  class ref_view;
134*fe6060f1SDimitry Andric
135*fe6060f1SDimitry Andric  template<class T>
136*fe6060f1SDimitry Andric    inline constexpr bool enable_borrowed_range<ref_view<T>> = true;
137*fe6060f1SDimitry Andric
138*fe6060f1SDimitry Andric  // [range.drop], drop view
139*fe6060f1SDimitry Andric  template<view V>
140*fe6060f1SDimitry Andric    class drop_view;
141*fe6060f1SDimitry Andric
142*fe6060f1SDimitry Andric  template<class T>
143*fe6060f1SDimitry Andric    inline constexpr bool enable_borrowed_range<drop_view<T>> = enable_borrowed_range<T>;
144*fe6060f1SDimitry Andric
145*fe6060f1SDimitry Andric  // [range.transform], transform view
146*fe6060f1SDimitry Andric  template<input_range V, copy_constructible F>
147*fe6060f1SDimitry Andric    requires view<V> && is_object_v<F> &&
148*fe6060f1SDimitry Andric             regular_invocable<F&, range_reference_t<V>> &&
149*fe6060f1SDimitry Andric             can-reference<invoke_result_t<F&, range_reference_t<V>>>
150*fe6060f1SDimitry Andric  class transform_view;
151*fe6060f1SDimitry Andric
152*fe6060f1SDimitry Andric  // [range.common], common view
153*fe6060f1SDimitry Andric  template<view V>
154*fe6060f1SDimitry Andric    requires (!common_range<V> && copyable<iterator_t<V>>)
155*fe6060f1SDimitry Andric  class common_view;
156*fe6060f1SDimitry Andric
157*fe6060f1SDimitry Andric  template<class T>
158*fe6060f1SDimitry Andric  inline constexpr bool enable_borrowed_range<common_view<T>> = enable_borrowed_range<T>;
159*fe6060f1SDimitry Andric}
160*fe6060f1SDimitry Andric
161*fe6060f1SDimitry Andric*/
162*fe6060f1SDimitry Andric
163*fe6060f1SDimitry Andric#include <__config>
164*fe6060f1SDimitry Andric#include <__ranges/access.h>
165*fe6060f1SDimitry Andric#include <__ranges/all.h>
166*fe6060f1SDimitry Andric#include <__ranges/common_view.h>
167*fe6060f1SDimitry Andric#include <__ranges/concepts.h>
168*fe6060f1SDimitry Andric#include <__ranges/dangling.h>
169*fe6060f1SDimitry Andric#include <__ranges/data.h>
170*fe6060f1SDimitry Andric#include <__ranges/drop_view.h>
171*fe6060f1SDimitry Andric#include <__ranges/empty.h>
172*fe6060f1SDimitry Andric#include <__ranges/empty_view.h>
173*fe6060f1SDimitry Andric#include <__ranges/enable_borrowed_range.h>
174*fe6060f1SDimitry Andric#include <__ranges/enable_view.h>
175*fe6060f1SDimitry Andric#include <__ranges/ref_view.h>
176*fe6060f1SDimitry Andric#include <__ranges/size.h>
177*fe6060f1SDimitry Andric#include <__ranges/subrange.h>
178*fe6060f1SDimitry Andric#include <__ranges/transform_view.h>
179*fe6060f1SDimitry Andric#include <__ranges/view_interface.h>
180*fe6060f1SDimitry Andric#include <compare>          // Required by the standard.
181*fe6060f1SDimitry Andric#include <initializer_list> // Required by the standard.
182*fe6060f1SDimitry Andric#include <iterator>         // Required by the standard.
183*fe6060f1SDimitry Andric#include <type_traits>
184*fe6060f1SDimitry Andric#include <version>
185*fe6060f1SDimitry Andric
186*fe6060f1SDimitry Andric#if defined(_LIBCPP_HAS_NO_INCOMPLETE_RANGES)
187*fe6060f1SDimitry Andric# error "The Ranges library is not supported since libc++ has been configured with LIBCXX_ENABLE_INCOMPLETE_FEATURES disabled"
188*fe6060f1SDimitry Andric#endif
189*fe6060f1SDimitry Andric
190*fe6060f1SDimitry Andric#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
191*fe6060f1SDimitry Andric#pragma GCC system_header
192*fe6060f1SDimitry Andric#endif
193*fe6060f1SDimitry Andric
194*fe6060f1SDimitry Andric_LIBCPP_PUSH_MACROS
195*fe6060f1SDimitry Andric#include <__undef_macros>
196*fe6060f1SDimitry Andric
197*fe6060f1SDimitry Andric_LIBCPP_BEGIN_NAMESPACE_STD
198*fe6060f1SDimitry Andric
199*fe6060f1SDimitry Andric#if _LIBCPP_STD_VER > 17 && !defined(_LIBCPP_HAS_NO_RANGES)
200*fe6060f1SDimitry Andric
201*fe6060f1SDimitry Andric#endif // _LIBCPP_STD_VER > 17 && !defined(_LIBCPP_HAS_NO_RANGES)
202*fe6060f1SDimitry Andric
203*fe6060f1SDimitry Andric_LIBCPP_END_NAMESPACE_STD
204*fe6060f1SDimitry Andric
205*fe6060f1SDimitry Andric_LIBCPP_POP_MACROS
206*fe6060f1SDimitry Andric
207*fe6060f1SDimitry Andric#endif // _LIBCPP_RANGES
208