xref: /llvm-project-15.0.7/libcxx/include/ranges (revision 87ed73fe)
1// -*- C++ -*-
2//===--------------------------- ranges -----------------------------------===//
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<class T>
41    using iterator_t = decltype(ranges::begin(declval<T&>()));
42  template<range R>
43    using sentinel_t = decltype(ranges::end(declval<R&>()));
44  template<range R>
45    using range_difference_t = iter_difference_t<iterator_t<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
53  // [range.sized], sized ranges
54  template<class>
55    inline constexpr bool disable_sized_range = false;
56
57  template<class T>
58    concept sized_range = ...;
59
60  // [range.view], views
61  template<class T>
62    inline constexpr bool enable_view = ...;
63
64  struct view_base { };
65
66  template<class T>
67    concept view = ...;
68
69  // [range.refinements], other range refinements
70  template<class T>
71    concept input_range = see below;
72
73  template<class T>
74    concept forward_range = see below;
75
76  template<class T>
77  concept bidirectional_range = see below;
78
79  template<class T>
80  concept random_access_range = see below;
81
82  template<class T>
83  concept contiguous_range = see below;
84
85  template <class _Tp>
86    concept common_range = see below;
87
88  template<class T>
89  concept viewable_range = see below;
90
91  // [view.interface], class template view_interface
92  template<class D>
93    requires is_class_v<D> && same_as<D, remove_cv_t<D>>
94  class view_interface;
95
96  // [range.subrange], sub-ranges
97  enum class subrange_kind : bool { unsized, sized };
98
99  template<input_or_output_iterator I, sentinel_for<I> S = I, subrange_kind K = see below>
100    requires (K == subrange_kind::sized || !sized_sentinel_for<S, I>)
101  class subrange;
102
103  template<class I, class S, subrange_kind K>
104    inline constexpr bool enable_borrowed_range<subrange<I, S, K>> = true;
105
106  // [range.dangling], dangling iterator handling
107  struct dangling;
108
109  template<range R>
110    using borrowed_iterator_t = see below;
111
112  template<range R>
113    using borrowed_subrange_t = see below;
114
115  // [range.empty], empty view
116  template<class T>
117    requires is_object_v<T>
118  class empty_view;
119
120  // [range.all], all view
121  namespace views {
122    inline constexpr unspecified all = unspecified;
123
124    template<viewable_range R>
125      using all_t = decltype(all(declval<R>()));
126  }
127
128  template<range R>
129    requires is_object_v<R>
130  class ref_view;
131
132  template<class T>
133    inline constexpr bool enable_borrowed_range<ref_view<T>> = true;
134
135  // [range.drop], drop view
136  template<view V>
137    class drop_view;
138
139  template<class T>
140    inline constexpr bool enable_borrowed_range<drop_view<T>> = enable_borrowed_range<T>;
141
142  // [range.transform], transform view
143  template<input_range V, copy_constructible F>
144    requires view<V> && is_object_v<F> &&
145             regular_invocable<F&, range_reference_t<V>> &&
146             can-reference<invoke_result_t<F&, range_reference_t<V>>>
147  class transform_view;
148
149  // [range.common], common view
150  template<view V>
151    requires (!common_range<V> && copyable<iterator_t<V>>)
152  class common_view;
153
154  template<class T>
155  inline constexpr bool enable_borrowed_range<common_view<T>> = enable_borrowed_range<T>;
156}
157
158*/
159
160#include <__config>
161#include <__ranges/access.h>
162#include <__ranges/all.h>
163#include <__ranges/common_view.h>
164#include <__ranges/concepts.h>
165#include <__ranges/dangling.h>
166#include <__ranges/data.h>
167#include <__ranges/drop_view.h>
168#include <__ranges/empty.h>
169#include <__ranges/empty_view.h>
170#include <__ranges/enable_borrowed_range.h>
171#include <__ranges/enable_view.h>
172#include <__ranges/ref_view.h>
173#include <__ranges/size.h>
174#include <__ranges/subrange.h>
175#include <__ranges/transform_view.h>
176#include <__ranges/view_interface.h>
177#include <compare>          // Required by the standard.
178#include <initializer_list> // Required by the standard.
179#include <iterator>         // Required by the standard.
180#include <type_traits>
181#include <version>
182
183#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
184#pragma GCC system_header
185#endif
186
187_LIBCPP_PUSH_MACROS
188#include <__undef_macros>
189
190_LIBCPP_BEGIN_NAMESPACE_STD
191
192#if _LIBCPP_STD_VER > 17 && !defined(_LIBCPP_HAS_NO_RANGES)
193
194#endif // _LIBCPP_STD_VER > 17 && !defined(_LIBCPP_HAS_NO_RANGES)
195
196_LIBCPP_END_NAMESPACE_STD
197
198_LIBCPP_POP_MACROS
199
200#endif // _LIBCPP_RANGES
201