subrange.h 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  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_SUBRANGE_H
  10. #define _LIBCPP___RANGES_SUBRANGE_H
  11. #include <__assert>
  12. #include <__concepts/constructible.h>
  13. #include <__concepts/convertible_to.h>
  14. #include <__concepts/copyable.h>
  15. #include <__concepts/derived_from.h>
  16. #include <__concepts/different_from.h>
  17. #include <__config>
  18. #include <__fwd/subrange.h>
  19. #include <__iterator/advance.h>
  20. #include <__iterator/concepts.h>
  21. #include <__iterator/incrementable_traits.h>
  22. #include <__iterator/iterator_traits.h>
  23. #include <__ranges/access.h>
  24. #include <__ranges/concepts.h>
  25. #include <__ranges/dangling.h>
  26. #include <__ranges/enable_borrowed_range.h>
  27. #include <__ranges/size.h>
  28. #include <__ranges/view_interface.h>
  29. #include <__tuple/pair_like.h>
  30. #include <__tuple/tuple_element.h>
  31. #include <__tuple/tuple_size.h>
  32. #include <__type_traits/conditional.h>
  33. #include <__type_traits/decay.h>
  34. #include <__type_traits/is_pointer.h>
  35. #include <__type_traits/is_reference.h>
  36. #include <__type_traits/make_unsigned.h>
  37. #include <__type_traits/remove_const.h>
  38. #include <__type_traits/remove_pointer.h>
  39. #include <__utility/move.h>
  40. #include <cstddef>
  41. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  42. # pragma GCC system_header
  43. #endif
  44. _LIBCPP_PUSH_MACROS
  45. #include <__undef_macros>
  46. _LIBCPP_BEGIN_NAMESPACE_STD
  47. #if _LIBCPP_STD_VER >= 20
  48. namespace ranges {
  49. template <class _From, class _To>
  50. concept __uses_nonqualification_pointer_conversion =
  51. is_pointer_v<_From> && is_pointer_v<_To> &&
  52. !convertible_to<remove_pointer_t<_From> (*)[], remove_pointer_t<_To> (*)[]>;
  53. template <class _From, class _To>
  54. concept __convertible_to_non_slicing =
  55. convertible_to<_From, _To> && !__uses_nonqualification_pointer_conversion<decay_t<_From>, decay_t<_To>>;
  56. template <class _Pair, class _Iter, class _Sent>
  57. concept __pair_like_convertible_from =
  58. !range<_Pair> && __pair_like<_Pair> && constructible_from<_Pair, _Iter, _Sent> &&
  59. __convertible_to_non_slicing<_Iter, tuple_element_t<0, _Pair>> && convertible_to<_Sent, tuple_element_t<1, _Pair>>;
  60. template <input_or_output_iterator _Iter,
  61. sentinel_for<_Iter> _Sent = _Iter,
  62. subrange_kind _Kind = sized_sentinel_for<_Sent, _Iter> ? subrange_kind::sized : subrange_kind::unsized>
  63. requires(_Kind == subrange_kind::sized || !sized_sentinel_for<_Sent, _Iter>)
  64. class _LIBCPP_TEMPLATE_VIS subrange : public view_interface<subrange<_Iter, _Sent, _Kind>> {
  65. public:
  66. // Note: this is an internal implementation detail that is public only for internal usage.
  67. static constexpr bool _StoreSize = (_Kind == subrange_kind::sized && !sized_sentinel_for<_Sent, _Iter>);
  68. private:
  69. static constexpr bool _MustProvideSizeAtConstruction = !_StoreSize; // just to improve compiler diagnostics
  70. struct _Empty {
  71. _LIBCPP_HIDE_FROM_ABI constexpr _Empty(auto) noexcept {}
  72. };
  73. using _Size = conditional_t<_StoreSize, make_unsigned_t<iter_difference_t<_Iter>>, _Empty>;
  74. _LIBCPP_NO_UNIQUE_ADDRESS _Iter __begin_ = _Iter();
  75. _LIBCPP_NO_UNIQUE_ADDRESS _Sent __end_ = _Sent();
  76. _LIBCPP_NO_UNIQUE_ADDRESS _Size __size_ = 0;
  77. public:
  78. _LIBCPP_HIDE_FROM_ABI subrange()
  79. requires default_initializable<_Iter>
  80. = default;
  81. _LIBCPP_HIDE_FROM_ABI constexpr subrange(__convertible_to_non_slicing<_Iter> auto __iter, _Sent __sent)
  82. requires _MustProvideSizeAtConstruction
  83. : __begin_(std::move(__iter)), __end_(std::move(__sent)) {}
  84. _LIBCPP_HIDE_FROM_ABI constexpr subrange(
  85. __convertible_to_non_slicing<_Iter> auto __iter, _Sent __sent, make_unsigned_t<iter_difference_t<_Iter>> __n)
  86. requires(_Kind == subrange_kind::sized)
  87. : __begin_(std::move(__iter)), __end_(std::move(__sent)), __size_(__n) {
  88. if constexpr (sized_sentinel_for<_Sent, _Iter>)
  89. _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS((__end_ - __begin_) == static_cast<iter_difference_t<_Iter>>(__n),
  90. "std::ranges::subrange was passed an invalid size hint");
  91. }
  92. template <__different_from<subrange> _Range>
  93. requires borrowed_range<_Range> && __convertible_to_non_slicing<iterator_t<_Range>, _Iter> &&
  94. convertible_to<sentinel_t<_Range>, _Sent>
  95. _LIBCPP_HIDE_FROM_ABI constexpr subrange(_Range&& __range)
  96. requires(!_StoreSize)
  97. : subrange(ranges::begin(__range), ranges::end(__range)) {}
  98. template <__different_from<subrange> _Range>
  99. requires borrowed_range<_Range> && __convertible_to_non_slicing<iterator_t<_Range>, _Iter> &&
  100. convertible_to<sentinel_t<_Range>, _Sent>
  101. _LIBCPP_HIDE_FROM_ABI constexpr subrange(_Range&& __range)
  102. requires _StoreSize && sized_range<_Range>
  103. : subrange(__range, ranges::size(__range)) {}
  104. template <borrowed_range _Range>
  105. requires __convertible_to_non_slicing<iterator_t<_Range>, _Iter> &&
  106. convertible_to<sentinel_t<_Range>, _Sent>
  107. _LIBCPP_HIDE_FROM_ABI constexpr subrange(_Range&& __range, make_unsigned_t<iter_difference_t<_Iter>> __n)
  108. requires(_Kind == subrange_kind::sized)
  109. : subrange(ranges::begin(__range), ranges::end(__range), __n) {}
  110. template <__different_from<subrange> _Pair>
  111. requires __pair_like_convertible_from<_Pair, const _Iter&, const _Sent&>
  112. _LIBCPP_HIDE_FROM_ABI constexpr operator _Pair() const {
  113. return _Pair(__begin_, __end_);
  114. }
  115. _LIBCPP_HIDE_FROM_ABI constexpr _Iter begin() const
  116. requires copyable<_Iter>
  117. {
  118. return __begin_;
  119. }
  120. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr _Iter begin()
  121. requires(!copyable<_Iter>)
  122. {
  123. return std::move(__begin_);
  124. }
  125. _LIBCPP_HIDE_FROM_ABI constexpr _Sent end() const { return __end_; }
  126. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr bool empty() const { return __begin_ == __end_; }
  127. _LIBCPP_HIDE_FROM_ABI constexpr make_unsigned_t<iter_difference_t<_Iter>> size() const
  128. requires(_Kind == subrange_kind::sized)
  129. {
  130. if constexpr (_StoreSize)
  131. return __size_;
  132. else
  133. return std::__to_unsigned_like(__end_ - __begin_);
  134. }
  135. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr subrange next(iter_difference_t<_Iter> __n = 1) const&
  136. requires forward_iterator<_Iter>
  137. {
  138. auto __tmp = *this;
  139. __tmp.advance(__n);
  140. return __tmp;
  141. }
  142. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr subrange next(iter_difference_t<_Iter> __n = 1) && {
  143. advance(__n);
  144. return std::move(*this);
  145. }
  146. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr subrange prev(iter_difference_t<_Iter> __n = 1) const
  147. requires bidirectional_iterator<_Iter>
  148. {
  149. auto __tmp = *this;
  150. __tmp.advance(-__n);
  151. return __tmp;
  152. }
  153. _LIBCPP_HIDE_FROM_ABI constexpr subrange& advance(iter_difference_t<_Iter> __n) {
  154. if constexpr (bidirectional_iterator<_Iter>) {
  155. if (__n < 0) {
  156. ranges::advance(__begin_, __n);
  157. if constexpr (_StoreSize)
  158. __size_ += std::__to_unsigned_like(-__n);
  159. return *this;
  160. }
  161. }
  162. auto __d = __n - ranges::advance(__begin_, __n, __end_);
  163. if constexpr (_StoreSize)
  164. __size_ -= std::__to_unsigned_like(__d);
  165. return *this;
  166. }
  167. };
  168. template <input_or_output_iterator _Iter, sentinel_for<_Iter> _Sent>
  169. subrange(_Iter, _Sent) -> subrange<_Iter, _Sent>;
  170. template <input_or_output_iterator _Iter, sentinel_for<_Iter> _Sent>
  171. subrange(_Iter, _Sent, make_unsigned_t<iter_difference_t<_Iter>>) -> subrange<_Iter, _Sent, subrange_kind::sized>;
  172. template <borrowed_range _Range>
  173. subrange(_Range&&)
  174. -> subrange<iterator_t<_Range>,
  175. sentinel_t<_Range>,
  176. (sized_range<_Range> || sized_sentinel_for<sentinel_t<_Range>, iterator_t<_Range>>)
  177. ? subrange_kind::sized
  178. : subrange_kind::unsized>;
  179. template <borrowed_range _Range>
  180. subrange(_Range&&, make_unsigned_t<range_difference_t<_Range>>)
  181. -> subrange<iterator_t<_Range>, sentinel_t<_Range>, subrange_kind::sized>;
  182. template <size_t _Index, class _Iter, class _Sent, subrange_kind _Kind>
  183. requires((_Index == 0 && copyable<_Iter>) || _Index == 1)
  184. _LIBCPP_HIDE_FROM_ABI constexpr auto get(const subrange<_Iter, _Sent, _Kind>& __subrange) {
  185. if constexpr (_Index == 0)
  186. return __subrange.begin();
  187. else
  188. return __subrange.end();
  189. }
  190. template <size_t _Index, class _Iter, class _Sent, subrange_kind _Kind>
  191. requires(_Index < 2)
  192. _LIBCPP_HIDE_FROM_ABI constexpr auto get(subrange<_Iter, _Sent, _Kind>&& __subrange) {
  193. if constexpr (_Index == 0)
  194. return __subrange.begin();
  195. else
  196. return __subrange.end();
  197. }
  198. template <class _Ip, class _Sp, subrange_kind _Kp>
  199. inline constexpr bool enable_borrowed_range<subrange<_Ip, _Sp, _Kp>> = true;
  200. template <range _Rp>
  201. using borrowed_subrange_t = _If<borrowed_range<_Rp>, subrange<iterator_t<_Rp>>, dangling>;
  202. } // namespace ranges
  203. // [range.subrange.general]
  204. using ranges::get;
  205. // [ranges.syn]
  206. template <class _Ip, class _Sp, ranges::subrange_kind _Kp>
  207. struct tuple_size<ranges::subrange<_Ip, _Sp, _Kp>> : integral_constant<size_t, 2> {};
  208. template <class _Ip, class _Sp, ranges::subrange_kind _Kp>
  209. struct tuple_element<0, ranges::subrange<_Ip, _Sp, _Kp>> {
  210. using type = _Ip;
  211. };
  212. template <class _Ip, class _Sp, ranges::subrange_kind _Kp>
  213. struct tuple_element<1, ranges::subrange<_Ip, _Sp, _Kp>> {
  214. using type = _Sp;
  215. };
  216. template <class _Ip, class _Sp, ranges::subrange_kind _Kp>
  217. struct tuple_element<0, const ranges::subrange<_Ip, _Sp, _Kp>> {
  218. using type = _Ip;
  219. };
  220. template <class _Ip, class _Sp, ranges::subrange_kind _Kp>
  221. struct tuple_element<1, const ranges::subrange<_Ip, _Sp, _Kp>> {
  222. using type = _Sp;
  223. };
  224. #endif // _LIBCPP_STD_VER >= 20
  225. _LIBCPP_END_NAMESPACE_STD
  226. _LIBCPP_POP_MACROS
  227. #endif // _LIBCPP___RANGES_SUBRANGE_H