xref: /openbsd-src/gnu/llvm/libcxx/include/__ranges/split_view.h (revision 4bdff4bed0e3d54e55670334c7d0077db4170f86)
1*4bdff4beSrobert // -*- C++ -*-
2*4bdff4beSrobert //===----------------------------------------------------------------------===//
3*4bdff4beSrobert //
4*4bdff4beSrobert // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5*4bdff4beSrobert // See https://llvm.org/LICENSE.txt for license information.
6*4bdff4beSrobert // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7*4bdff4beSrobert //
8*4bdff4beSrobert //===----------------------------------------------------------------------===//
9*4bdff4beSrobert 
10*4bdff4beSrobert #ifndef _LIBCPP___RANGES_SPLIT_VIEW_H
11*4bdff4beSrobert #define _LIBCPP___RANGES_SPLIT_VIEW_H
12*4bdff4beSrobert 
13*4bdff4beSrobert #include <__algorithm/ranges_search.h>
14*4bdff4beSrobert #include <__concepts/constructible.h>
15*4bdff4beSrobert #include <__config>
16*4bdff4beSrobert #include <__functional/bind_back.h>
17*4bdff4beSrobert #include <__functional/ranges_operations.h>
18*4bdff4beSrobert #include <__iterator/indirectly_comparable.h>
19*4bdff4beSrobert #include <__iterator/iterator_traits.h>
20*4bdff4beSrobert #include <__memory/addressof.h>
21*4bdff4beSrobert #include <__ranges/access.h>
22*4bdff4beSrobert #include <__ranges/all.h>
23*4bdff4beSrobert #include <__ranges/concepts.h>
24*4bdff4beSrobert #include <__ranges/empty.h>
25*4bdff4beSrobert #include <__ranges/non_propagating_cache.h>
26*4bdff4beSrobert #include <__ranges/range_adaptor.h>
27*4bdff4beSrobert #include <__ranges/single_view.h>
28*4bdff4beSrobert #include <__ranges/subrange.h>
29*4bdff4beSrobert #include <__ranges/view_interface.h>
30*4bdff4beSrobert #include <__type_traits/decay.h>
31*4bdff4beSrobert #include <__type_traits/is_nothrow_constructible.h>
32*4bdff4beSrobert #include <__utility/forward.h>
33*4bdff4beSrobert #include <__utility/move.h>
34*4bdff4beSrobert 
35*4bdff4beSrobert #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
36*4bdff4beSrobert #  pragma GCC system_header
37*4bdff4beSrobert #endif
38*4bdff4beSrobert 
39*4bdff4beSrobert _LIBCPP_BEGIN_NAMESPACE_STD
40*4bdff4beSrobert 
41*4bdff4beSrobert #if _LIBCPP_STD_VER >= 20
42*4bdff4beSrobert 
43*4bdff4beSrobert namespace ranges {
44*4bdff4beSrobert 
45*4bdff4beSrobert template <forward_range _View, forward_range _Pattern>
46*4bdff4beSrobert   requires view<_View> && view<_Pattern> &&
47*4bdff4beSrobert            indirectly_comparable<iterator_t<_View>, iterator_t<_Pattern>, ranges::equal_to>
48*4bdff4beSrobert class split_view : public view_interface<split_view<_View, _Pattern>> {
49*4bdff4beSrobert private:
50*4bdff4beSrobert   _LIBCPP_NO_UNIQUE_ADDRESS _View __base_       = _View();
51*4bdff4beSrobert   _LIBCPP_NO_UNIQUE_ADDRESS _Pattern __pattern_ = _Pattern();
52*4bdff4beSrobert   using _Cache                                  = __non_propagating_cache<subrange<iterator_t<_View>>>;
53*4bdff4beSrobert   _Cache __cached_begin_                        = _Cache();
54*4bdff4beSrobert 
55*4bdff4beSrobert   template <class, class>
56*4bdff4beSrobert   friend struct __iterator;
57*4bdff4beSrobert 
58*4bdff4beSrobert   template <class, class>
59*4bdff4beSrobert   friend struct __sentinel;
60*4bdff4beSrobert 
61*4bdff4beSrobert   struct __iterator;
62*4bdff4beSrobert   struct __sentinel;
63*4bdff4beSrobert 
__find_next(iterator_t<_View> __it)64*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr subrange<iterator_t<_View>> __find_next(iterator_t<_View> __it) {
65*4bdff4beSrobert     auto [__begin, __end] = ranges::search(subrange(__it, ranges::end(__base_)), __pattern_);
66*4bdff4beSrobert     if (__begin != ranges::end(__base_) && ranges::empty(__pattern_)) {
67*4bdff4beSrobert       ++__begin;
68*4bdff4beSrobert       ++__end;
69*4bdff4beSrobert     }
70*4bdff4beSrobert     return {__begin, __end};
71*4bdff4beSrobert   }
72*4bdff4beSrobert 
73*4bdff4beSrobert public:
74*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI split_view()
75*4bdff4beSrobert     requires default_initializable<_View> && default_initializable<_Pattern>
76*4bdff4beSrobert   = default;
77*4bdff4beSrobert 
split_view(_View __base,_Pattern __pattern)78*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr split_view(_View __base, _Pattern __pattern)
79*4bdff4beSrobert       : __base_(std::move(__base)), __pattern_(std::move((__pattern))) {}
80*4bdff4beSrobert 
81*4bdff4beSrobert   template <forward_range _Range>
82*4bdff4beSrobert     requires constructible_from<_View, views::all_t<_Range>> &&
83*4bdff4beSrobert                  constructible_from<_Pattern, single_view<range_value_t<_Range>>>
split_view(_Range && __range,range_value_t<_Range> __elem)84*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr split_view(_Range&& __range, range_value_t<_Range> __elem)
85*4bdff4beSrobert       : __base_(views::all(std::forward<_Range>(__range))), __pattern_(views::single(std::move(__elem))) {}
86*4bdff4beSrobert 
base()87*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr _View base() const&
88*4bdff4beSrobert     requires copy_constructible<_View>
89*4bdff4beSrobert   {
90*4bdff4beSrobert     return __base_;
91*4bdff4beSrobert   }
92*4bdff4beSrobert 
base()93*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr _View base() && { return std::move(__base_); }
94*4bdff4beSrobert 
begin()95*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr __iterator begin() {
96*4bdff4beSrobert     if (!__cached_begin_.__has_value()) {
97*4bdff4beSrobert       __cached_begin_.__emplace(__find_next(ranges::begin(__base_)));
98*4bdff4beSrobert     }
99*4bdff4beSrobert     return {*this, ranges::begin(__base_), *__cached_begin_};
100*4bdff4beSrobert   }
101*4bdff4beSrobert 
end()102*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr auto end() {
103*4bdff4beSrobert     if constexpr (common_range<_View>) {
104*4bdff4beSrobert       return __iterator{*this, ranges::end(__base_), {}};
105*4bdff4beSrobert     } else {
106*4bdff4beSrobert       return __sentinel{*this};
107*4bdff4beSrobert     }
108*4bdff4beSrobert   }
109*4bdff4beSrobert };
110*4bdff4beSrobert 
111*4bdff4beSrobert template <class _Range, class _Pattern>
112*4bdff4beSrobert split_view(_Range&&, _Pattern&&) -> split_view<views::all_t<_Range>, views::all_t<_Pattern>>;
113*4bdff4beSrobert 
114*4bdff4beSrobert template <forward_range _Range>
115*4bdff4beSrobert split_view(_Range&&, range_value_t<_Range>) -> split_view<views::all_t<_Range>, single_view<range_value_t<_Range>>>;
116*4bdff4beSrobert 
117*4bdff4beSrobert template <forward_range _View, forward_range _Pattern>
118*4bdff4beSrobert   requires view<_View> && view<_Pattern> &&
119*4bdff4beSrobert            indirectly_comparable<iterator_t<_View>, iterator_t<_Pattern>, ranges::equal_to>
120*4bdff4beSrobert struct split_view<_View, _Pattern>::__iterator {
121*4bdff4beSrobert private:
122*4bdff4beSrobert   split_view* __parent_                                         = nullptr;
123*4bdff4beSrobert   _LIBCPP_NO_UNIQUE_ADDRESS iterator_t<_View> __cur_            = iterator_t<_View>();
124*4bdff4beSrobert   _LIBCPP_NO_UNIQUE_ADDRESS subrange<iterator_t<_View>> __next_ = subrange<iterator_t<_View>>();
125*4bdff4beSrobert   bool __trailing_empty_                                        = false;
126*4bdff4beSrobert 
127*4bdff4beSrobert   friend struct __sentinel;
128*4bdff4beSrobert 
129*4bdff4beSrobert public:
130*4bdff4beSrobert   using iterator_concept  = forward_iterator_tag;
131*4bdff4beSrobert   using iterator_category = input_iterator_tag;
132*4bdff4beSrobert   using value_type        = subrange<iterator_t<_View>>;
133*4bdff4beSrobert   using difference_type   = range_difference_t<_View>;
134*4bdff4beSrobert 
135*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI __iterator() = default;
136*4bdff4beSrobert 
137*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr __iterator(
138*4bdff4beSrobert       split_view<_View, _Pattern>& __parent, iterator_t<_View> __current, subrange<iterator_t<_View>> __next)
139*4bdff4beSrobert       : __parent_(std::addressof(__parent)), __cur_(std::move(__current)), __next_(std::move(__next)) {}
140*4bdff4beSrobert 
141*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr iterator_t<_View> base() const { return __cur_; }
142*4bdff4beSrobert 
143*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr value_type operator*() const { return {__cur_, __next_.begin()}; }
144*4bdff4beSrobert 
145*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator++() {
146*4bdff4beSrobert     __cur_ = __next_.begin();
147*4bdff4beSrobert     if (__cur_ != ranges::end(__parent_->__base_)) {
148*4bdff4beSrobert       __cur_ = __next_.end();
149*4bdff4beSrobert       if (__cur_ == ranges::end(__parent_->__base_)) {
150*4bdff4beSrobert         __trailing_empty_ = true;
151*4bdff4beSrobert         __next_           = {__cur_, __cur_};
152*4bdff4beSrobert       } else {
153*4bdff4beSrobert         __next_ = __parent_->__find_next(__cur_);
154*4bdff4beSrobert       }
155*4bdff4beSrobert     } else {
156*4bdff4beSrobert       __trailing_empty_ = false;
157*4bdff4beSrobert     }
158*4bdff4beSrobert     return *this;
159*4bdff4beSrobert   }
160*4bdff4beSrobert 
161*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr __iterator operator++(int) {
162*4bdff4beSrobert     auto __tmp = *this;
163*4bdff4beSrobert     ++*this;
164*4bdff4beSrobert     return __tmp;
165*4bdff4beSrobert   }
166*4bdff4beSrobert 
167*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator& __x, const __iterator& __y) {
168*4bdff4beSrobert     return __x.__cur_ == __y.__cur_ && __x.__trailing_empty_ == __y.__trailing_empty_;
169*4bdff4beSrobert   }
170*4bdff4beSrobert };
171*4bdff4beSrobert 
172*4bdff4beSrobert template <forward_range _View, forward_range _Pattern>
173*4bdff4beSrobert   requires view<_View> && view<_Pattern> &&
174*4bdff4beSrobert            indirectly_comparable<iterator_t<_View>, iterator_t<_Pattern>, ranges::equal_to>
175*4bdff4beSrobert struct split_view<_View, _Pattern>::__sentinel {
176*4bdff4beSrobert private:
177*4bdff4beSrobert   _LIBCPP_NO_UNIQUE_ADDRESS sentinel_t<_View> __end_ = sentinel_t<_View>();
178*4bdff4beSrobert 
179*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI static constexpr bool __equals(const __iterator& __x, const __sentinel& __y) {
180*4bdff4beSrobert     return __x.__cur_ == __y.__end_ && !__x.__trailing_empty_;
181*4bdff4beSrobert   }
182*4bdff4beSrobert 
183*4bdff4beSrobert public:
184*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI __sentinel() = default;
185*4bdff4beSrobert 
186*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI constexpr explicit __sentinel(split_view<_View, _Pattern>& __parent)
187*4bdff4beSrobert       : __end_(ranges::end(__parent.__base_)) {}
188*4bdff4beSrobert 
189*4bdff4beSrobert   _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator& __x, const __sentinel& __y) {
190*4bdff4beSrobert     return __equals(__x, __y);
191*4bdff4beSrobert   }
192*4bdff4beSrobert };
193*4bdff4beSrobert 
194*4bdff4beSrobert namespace views {
195*4bdff4beSrobert namespace __split_view {
196*4bdff4beSrobert struct __fn : __range_adaptor_closure<__fn> {
197*4bdff4beSrobert   // clang-format off
198*4bdff4beSrobert   template <class _Range, class _Pattern>
199*4bdff4beSrobert   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI
200*4bdff4beSrobert   constexpr auto operator()(_Range&& __range, _Pattern&& __pattern) const
201*4bdff4beSrobert     noexcept(noexcept(split_view(std::forward<_Range>(__range), std::forward<_Pattern>(__pattern))))
202*4bdff4beSrobert     -> decltype(      split_view(std::forward<_Range>(__range), std::forward<_Pattern>(__pattern)))
203*4bdff4beSrobert     { return          split_view(std::forward<_Range>(__range), std::forward<_Pattern>(__pattern)); }
204*4bdff4beSrobert   // clang-format on
205*4bdff4beSrobert 
206*4bdff4beSrobert   template <class _Pattern>
207*4bdff4beSrobert     requires constructible_from<decay_t<_Pattern>, _Pattern>
208*4bdff4beSrobert   _LIBCPP_NODISCARD_EXT _LIBCPP_HIDE_FROM_ABI constexpr auto operator()(_Pattern&& __pattern) const
209*4bdff4beSrobert       noexcept(is_nothrow_constructible_v<decay_t<_Pattern>, _Pattern>) {
210*4bdff4beSrobert     return __range_adaptor_closure_t(std::__bind_back(*this, std::forward<_Pattern>(__pattern)));
211*4bdff4beSrobert   }
212*4bdff4beSrobert };
213*4bdff4beSrobert } // namespace __split_view
214*4bdff4beSrobert 
215*4bdff4beSrobert inline namespace __cpo {
216*4bdff4beSrobert inline constexpr auto split = __split_view::__fn{};
217*4bdff4beSrobert } // namespace __cpo
218*4bdff4beSrobert } // namespace views
219*4bdff4beSrobert 
220*4bdff4beSrobert } // namespace ranges
221*4bdff4beSrobert 
222*4bdff4beSrobert #endif // _LIBCPP_STD_VER >= 20
223*4bdff4beSrobert 
224*4bdff4beSrobert _LIBCPP_END_NAMESPACE_STD
225*4bdff4beSrobert 
226*4bdff4beSrobert #endif // _LIBCPP___RANGES_SPLIT_VIEW_H
227