join_view.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  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. #ifndef _LIBCPP___RANGES_JOIN_VIEW_H
  10. #define _LIBCPP___RANGES_JOIN_VIEW_H
  11. #include <__concepts/constructible.h>
  12. #include <__concepts/convertible_to.h>
  13. #include <__concepts/copyable.h>
  14. #include <__concepts/derived_from.h>
  15. #include <__concepts/equality_comparable.h>
  16. #include <__config>
  17. #include <__iterator/concepts.h>
  18. #include <__iterator/iter_move.h>
  19. #include <__iterator/iter_swap.h>
  20. #include <__iterator/iterator_traits.h>
  21. #include <__iterator/iterator_with_data.h>
  22. #include <__iterator/segmented_iterator.h>
  23. #include <__memory/addressof.h>
  24. #include <__ranges/access.h>
  25. #include <__ranges/all.h>
  26. #include <__ranges/concepts.h>
  27. #include <__ranges/empty.h>
  28. #include <__ranges/non_propagating_cache.h>
  29. #include <__ranges/range_adaptor.h>
  30. #include <__ranges/view_interface.h>
  31. #include <__type_traits/common_type.h>
  32. #include <__type_traits/maybe_const.h>
  33. #include <__utility/as_lvalue.h>
  34. #include <__utility/empty.h>
  35. #include <__utility/forward.h>
  36. #include <optional>
  37. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  38. # pragma GCC system_header
  39. #endif
  40. _LIBCPP_PUSH_MACROS
  41. #include <__undef_macros>
  42. _LIBCPP_BEGIN_NAMESPACE_STD
  43. #if _LIBCPP_STD_VER >= 20
  44. namespace ranges {
  45. template <class>
  46. struct __join_view_iterator_category {};
  47. template <class _View>
  48. requires is_reference_v<range_reference_t<_View>> && forward_range<_View> && forward_range<range_reference_t<_View>>
  49. struct __join_view_iterator_category<_View> {
  50. using _OuterC = typename iterator_traits<iterator_t<_View>>::iterator_category;
  51. using _InnerC = typename iterator_traits<iterator_t<range_reference_t<_View>>>::iterator_category;
  52. using iterator_category =
  53. _If< derived_from<_OuterC, bidirectional_iterator_tag> && derived_from<_InnerC, bidirectional_iterator_tag> &&
  54. common_range<range_reference_t<_View>>,
  55. bidirectional_iterator_tag,
  56. _If< derived_from<_OuterC, forward_iterator_tag> && derived_from<_InnerC, forward_iterator_tag>,
  57. forward_iterator_tag,
  58. input_iterator_tag > >;
  59. };
  60. template <input_range _View>
  61. requires view<_View> && input_range<range_reference_t<_View>>
  62. class join_view : public view_interface<join_view<_View>> {
  63. private:
  64. using _InnerRange = range_reference_t<_View>;
  65. template <bool>
  66. struct __iterator;
  67. template <bool>
  68. struct __sentinel;
  69. template <class>
  70. friend struct std::__segmented_iterator_traits;
  71. _LIBCPP_NO_UNIQUE_ADDRESS _View __base_ = _View();
  72. static constexpr bool _UseOuterCache = !forward_range<_View>;
  73. using _OuterCache = _If<_UseOuterCache, __non_propagating_cache<iterator_t<_View>>, __empty_cache>;
  74. _LIBCPP_NO_UNIQUE_ADDRESS _OuterCache __outer_;
  75. static constexpr bool _UseInnerCache = !is_reference_v<_InnerRange>;
  76. using _InnerCache = _If<_UseInnerCache, __non_propagating_cache<remove_cvref_t<_InnerRange>>, __empty_cache>;
  77. _LIBCPP_NO_UNIQUE_ADDRESS _InnerCache __inner_;
  78. public:
  79. _LIBCPP_HIDE_FROM_ABI join_view()
  80. requires default_initializable<_View>
  81. = default;
  82. _LIBCPP_HIDE_FROM_ABI constexpr explicit join_view(_View __base) : __base_(std::move(__base)) {}
  83. _LIBCPP_HIDE_FROM_ABI constexpr _View base() const&
  84. requires copy_constructible<_View>
  85. {
  86. return __base_;
  87. }
  88. _LIBCPP_HIDE_FROM_ABI constexpr _View base() && { return std::move(__base_); }
  89. _LIBCPP_HIDE_FROM_ABI constexpr auto begin() {
  90. if constexpr (forward_range<_View>) {
  91. constexpr bool __use_const = __simple_view<_View> && is_reference_v<range_reference_t<_View>>;
  92. return __iterator<__use_const>{*this, ranges::begin(__base_)};
  93. } else {
  94. __outer_.__emplace(ranges::begin(__base_));
  95. return __iterator<false>{*this};
  96. }
  97. }
  98. template <class _V2 = _View>
  99. _LIBCPP_HIDE_FROM_ABI constexpr auto begin() const
  100. requires forward_range<const _V2> && is_reference_v<range_reference_t<const _V2>> &&
  101. input_range<range_reference_t<const _V2>>
  102. {
  103. return __iterator<true>{*this, ranges::begin(__base_)};
  104. }
  105. _LIBCPP_HIDE_FROM_ABI constexpr auto end() {
  106. if constexpr (forward_range<_View> && is_reference_v<_InnerRange> && forward_range<_InnerRange> &&
  107. common_range<_View> && common_range<_InnerRange>)
  108. return __iterator<__simple_view<_View>>{*this, ranges::end(__base_)};
  109. else
  110. return __sentinel<__simple_view<_View>>{*this};
  111. }
  112. template <class _V2 = _View>
  113. _LIBCPP_HIDE_FROM_ABI constexpr auto end() const
  114. requires forward_range<const _V2> && is_reference_v<range_reference_t<const _V2>> &&
  115. input_range<range_reference_t<const _V2>>
  116. {
  117. using _ConstInnerRange = range_reference_t<const _View>;
  118. if constexpr (forward_range<_ConstInnerRange> && common_range<const _View> && common_range<_ConstInnerRange>) {
  119. return __iterator<true>{*this, ranges::end(__base_)};
  120. } else {
  121. return __sentinel<true>{*this};
  122. }
  123. }
  124. };
  125. template <input_range _View>
  126. requires view<_View> && input_range<range_reference_t<_View>>
  127. template <bool _Const>
  128. struct join_view<_View>::__sentinel {
  129. private:
  130. template <bool>
  131. friend struct __sentinel;
  132. using _Parent = __maybe_const<_Const, join_view>;
  133. using _Base = __maybe_const<_Const, _View>;
  134. sentinel_t<_Base> __end_ = sentinel_t<_Base>();
  135. public:
  136. _LIBCPP_HIDE_FROM_ABI __sentinel() = default;
  137. _LIBCPP_HIDE_FROM_ABI constexpr explicit __sentinel(_Parent& __parent) : __end_(ranges::end(__parent.__base_)) {}
  138. _LIBCPP_HIDE_FROM_ABI constexpr __sentinel(__sentinel<!_Const> __s)
  139. requires _Const && convertible_to<sentinel_t<_View>, sentinel_t<_Base>>
  140. : __end_(std::move(__s.__end_)) {}
  141. template <bool _OtherConst>
  142. requires sentinel_for<sentinel_t<_Base>, iterator_t<__maybe_const<_OtherConst, _View>>>
  143. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator<_OtherConst>& __x, const __sentinel& __y) {
  144. return __x.__get_outer() == __y.__end_;
  145. }
  146. };
  147. // https://reviews.llvm.org/D142811#inline-1383022
  148. // To simplify the segmented iterator traits specialization,
  149. // make the iterator `final`
  150. template <input_range _View>
  151. requires view<_View> && input_range<range_reference_t<_View>>
  152. template <bool _Const>
  153. struct join_view<_View>::__iterator final : public __join_view_iterator_category<__maybe_const<_Const, _View>> {
  154. friend join_view;
  155. template <class>
  156. friend struct std::__segmented_iterator_traits;
  157. static constexpr bool __is_join_view_iterator = true;
  158. private:
  159. using _Parent = __maybe_const<_Const, join_view<_View>>;
  160. using _Base = __maybe_const<_Const, _View>;
  161. using _Outer = iterator_t<_Base>;
  162. using _Inner = iterator_t<range_reference_t<_Base>>;
  163. using _InnerRange = range_reference_t<_View>;
  164. static_assert(!_Const || forward_range<_Base>, "Const can only be true when Base models forward_range.");
  165. static constexpr bool __ref_is_glvalue = is_reference_v<range_reference_t<_Base>>;
  166. static constexpr bool _OuterPresent = forward_range<_Base>;
  167. using _OuterType = _If<_OuterPresent, _Outer, std::__empty>;
  168. _LIBCPP_NO_UNIQUE_ADDRESS _OuterType __outer_ = _OuterType();
  169. optional<_Inner> __inner_;
  170. _Parent* __parent_ = nullptr;
  171. _LIBCPP_HIDE_FROM_ABI constexpr void __satisfy() {
  172. for (; __get_outer() != ranges::end(__parent_->__base_); ++__get_outer()) {
  173. auto&& __inner = [this]() -> auto&& {
  174. if constexpr (__ref_is_glvalue)
  175. return *__get_outer();
  176. else
  177. return __parent_->__inner_.__emplace_from([&]() -> decltype(auto) { return *__get_outer(); });
  178. }();
  179. __inner_ = ranges::begin(__inner);
  180. if (*__inner_ != ranges::end(__inner))
  181. return;
  182. }
  183. if constexpr (__ref_is_glvalue)
  184. __inner_.reset();
  185. }
  186. _LIBCPP_HIDE_FROM_ABI constexpr _Outer& __get_outer() {
  187. if constexpr (forward_range<_Base>) {
  188. return __outer_;
  189. } else {
  190. return *__parent_->__outer_;
  191. }
  192. }
  193. _LIBCPP_HIDE_FROM_ABI constexpr const _Outer& __get_outer() const {
  194. if constexpr (forward_range<_Base>) {
  195. return __outer_;
  196. } else {
  197. return *__parent_->__outer_;
  198. }
  199. }
  200. _LIBCPP_HIDE_FROM_ABI constexpr __iterator(_Parent& __parent, _Outer __outer)
  201. requires forward_range<_Base>
  202. : __outer_(std::move(__outer)), __parent_(std::addressof(__parent)) {
  203. __satisfy();
  204. }
  205. _LIBCPP_HIDE_FROM_ABI constexpr explicit __iterator(_Parent& __parent)
  206. requires(!forward_range<_Base>)
  207. : __parent_(std::addressof(__parent)) {
  208. __satisfy();
  209. }
  210. _LIBCPP_HIDE_FROM_ABI constexpr __iterator(_Parent* __parent, _Outer __outer, _Inner __inner)
  211. requires forward_range<_Base>
  212. : __outer_(std::move(__outer)), __inner_(std::move(__inner)), __parent_(__parent) {}
  213. public:
  214. using iterator_concept =
  215. _If< __ref_is_glvalue && bidirectional_range<_Base> && bidirectional_range<range_reference_t<_Base>> &&
  216. common_range<range_reference_t<_Base>>,
  217. bidirectional_iterator_tag,
  218. _If< __ref_is_glvalue && forward_range<_Base> && forward_range<range_reference_t<_Base>>,
  219. forward_iterator_tag,
  220. input_iterator_tag > >;
  221. using value_type = range_value_t<range_reference_t<_Base>>;
  222. using difference_type = common_type_t< range_difference_t<_Base>, range_difference_t<range_reference_t<_Base>>>;
  223. _LIBCPP_HIDE_FROM_ABI __iterator() = default;
  224. _LIBCPP_HIDE_FROM_ABI constexpr __iterator(__iterator<!_Const> __i)
  225. requires _Const && convertible_to<iterator_t<_View>, _Outer> && convertible_to<iterator_t<_InnerRange>, _Inner>
  226. : __outer_(std::move(__i.__outer_)), __inner_(std::move(__i.__inner_)), __parent_(__i.__parent_) {}
  227. _LIBCPP_HIDE_FROM_ABI constexpr decltype(auto) operator*() const { return **__inner_; }
  228. _LIBCPP_HIDE_FROM_ABI constexpr _Inner operator->() const
  229. requires __has_arrow<_Inner> && copyable<_Inner>
  230. {
  231. return *__inner_;
  232. }
  233. _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator++() {
  234. auto __get_inner_range = [&]() -> decltype(auto) {
  235. if constexpr (__ref_is_glvalue)
  236. return *__get_outer();
  237. else
  238. return *__parent_->__inner_;
  239. };
  240. if (++*__inner_ == ranges::end(std::__as_lvalue(__get_inner_range()))) {
  241. ++__get_outer();
  242. __satisfy();
  243. }
  244. return *this;
  245. }
  246. _LIBCPP_HIDE_FROM_ABI constexpr void operator++(int) { ++*this; }
  247. _LIBCPP_HIDE_FROM_ABI constexpr __iterator operator++(int)
  248. requires __ref_is_glvalue && forward_range<_Base> && forward_range<range_reference_t<_Base>>
  249. {
  250. auto __tmp = *this;
  251. ++*this;
  252. return __tmp;
  253. }
  254. _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator--()
  255. requires __ref_is_glvalue && bidirectional_range<_Base> && bidirectional_range<range_reference_t<_Base>> &&
  256. common_range<range_reference_t<_Base>>
  257. {
  258. if (__outer_ == ranges::end(__parent_->__base_))
  259. __inner_ = ranges::end(std::__as_lvalue(*--__outer_));
  260. // Skip empty inner ranges when going backwards.
  261. while (*__inner_ == ranges::begin(std::__as_lvalue(*__outer_))) {
  262. __inner_ = ranges::end(std::__as_lvalue(*--__outer_));
  263. }
  264. --*__inner_;
  265. return *this;
  266. }
  267. _LIBCPP_HIDE_FROM_ABI constexpr __iterator operator--(int)
  268. requires __ref_is_glvalue && bidirectional_range<_Base> && bidirectional_range<range_reference_t<_Base>> &&
  269. common_range<range_reference_t<_Base>>
  270. {
  271. auto __tmp = *this;
  272. --*this;
  273. return __tmp;
  274. }
  275. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator& __x, const __iterator& __y)
  276. requires __ref_is_glvalue && forward_range<_Base> && equality_comparable<iterator_t<range_reference_t<_Base>>>
  277. {
  278. return __x.__outer_ == __y.__outer_ && __x.__inner_ == __y.__inner_;
  279. }
  280. _LIBCPP_HIDE_FROM_ABI friend constexpr decltype(auto)
  281. iter_move(const __iterator& __i) noexcept(noexcept(ranges::iter_move(*__i.__inner_))) {
  282. return ranges::iter_move(*__i.__inner_);
  283. }
  284. _LIBCPP_HIDE_FROM_ABI friend constexpr void
  285. iter_swap(const __iterator& __x,
  286. const __iterator& __y) noexcept(noexcept(ranges::iter_swap(*__x.__inner_, *__y.__inner_)))
  287. requires indirectly_swappable<_Inner>
  288. {
  289. return ranges::iter_swap(*__x.__inner_, *__y.__inner_);
  290. }
  291. };
  292. template <class _Range>
  293. explicit join_view(_Range&&) -> join_view<views::all_t<_Range>>;
  294. namespace views {
  295. namespace __join_view {
  296. struct __fn : __range_adaptor_closure<__fn> {
  297. template <class _Range>
  298. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto operator()(_Range&& __range) const
  299. noexcept(noexcept(join_view<all_t<_Range&&>>(std::forward<_Range>(__range))))
  300. -> decltype(join_view<all_t<_Range&&>>(std::forward<_Range>(__range))) {
  301. return join_view<all_t<_Range&&>>(std::forward<_Range>(__range));
  302. }
  303. };
  304. } // namespace __join_view
  305. inline namespace __cpo {
  306. inline constexpr auto join = __join_view::__fn{};
  307. } // namespace __cpo
  308. } // namespace views
  309. } // namespace ranges
  310. template <class _JoinViewIterator>
  311. requires(_JoinViewIterator::__is_join_view_iterator && ranges::common_range<typename _JoinViewIterator::_Parent> &&
  312. __has_random_access_iterator_category<typename _JoinViewIterator::_Outer>::value &&
  313. __has_random_access_iterator_category<typename _JoinViewIterator::_Inner>::value)
  314. struct __segmented_iterator_traits<_JoinViewIterator> {
  315. using __segment_iterator =
  316. _LIBCPP_NODEBUG __iterator_with_data<typename _JoinViewIterator::_Outer, typename _JoinViewIterator::_Parent*>;
  317. using __local_iterator = typename _JoinViewIterator::_Inner;
  318. // TODO: Would it make sense to enable the optimization for other iterator types?
  319. static constexpr _LIBCPP_HIDE_FROM_ABI __segment_iterator __segment(_JoinViewIterator __iter) {
  320. if (ranges::empty(__iter.__parent_->__base_))
  321. return {};
  322. if (!__iter.__inner_.has_value())
  323. return __segment_iterator(--__iter.__outer_, __iter.__parent_);
  324. return __segment_iterator(__iter.__outer_, __iter.__parent_);
  325. }
  326. static constexpr _LIBCPP_HIDE_FROM_ABI __local_iterator __local(_JoinViewIterator __iter) {
  327. if (ranges::empty(__iter.__parent_->__base_))
  328. return {};
  329. if (!__iter.__inner_.has_value())
  330. return ranges::end(*--__iter.__outer_);
  331. return *__iter.__inner_;
  332. }
  333. static constexpr _LIBCPP_HIDE_FROM_ABI __local_iterator __begin(__segment_iterator __iter) {
  334. return ranges::begin(*__iter.__get_iter());
  335. }
  336. static constexpr _LIBCPP_HIDE_FROM_ABI __local_iterator __end(__segment_iterator __iter) {
  337. return ranges::end(*__iter.__get_iter());
  338. }
  339. static constexpr _LIBCPP_HIDE_FROM_ABI _JoinViewIterator
  340. __compose(__segment_iterator __seg_iter, __local_iterator __local_iter) {
  341. return _JoinViewIterator(
  342. std::move(__seg_iter).__get_data(), std::move(__seg_iter).__get_iter(), std::move(__local_iter));
  343. }
  344. };
  345. #endif // #if _LIBCPP_STD_VER >= 20
  346. _LIBCPP_END_NAMESPACE_STD
  347. _LIBCPP_POP_MACROS
  348. #endif // _LIBCPP___RANGES_JOIN_VIEW_H