xref: /llvm-project/libcxx/test/support/test_range.h (revision 808d794a45e169601ff16f72beae2f7bd79342a2)

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LIBCXX_TEST_SUPPORT_TEST_RANGE_H
#define LIBCXX_TEST_SUPPORT_TEST_RANGE_H

#include <concepts>
#include <functional>
#include <iterator>
#include <ranges>
#include <type_traits>

#include "test_iterators.h"

#if TEST_STD_VER < 17
#  error "test/support/test_range.h" can only be included in builds supporting ranges
#endif

struct sentinel {
  bool operator==(std::input_or_output_iterator auto const&) const;
};

template <template <class...> class I, class T = int>
  requires std::input_or_output_iterator<I<T*> >
struct test_range {
  I<T*> begin();
  I<T const*> begin() const;
  sentinel end();
  sentinel end() const;
};

template <template <class...> class I, class T = int>
  requires std::input_or_output_iterator<I<T*> >
struct test_non_const_range {
  I<T*> begin();
  sentinel end();
};

template <template <class...> class I, class T = int>
  requires std::input_or_output_iterator<I<T*> >
struct test_common_range {
  I<T*> begin();
  I<T const*> begin() const;
  I<T*> end();
  I<T const*> end() const;
};

template <template <class...> class I, class T = int>
  requires std::input_or_output_iterator<I<T*> >
struct test_non_const_common_range {
  I<T*> begin();
  I<T*> end();
};

template <template <class...> class I, class T = int>
  requires std::input_or_output_iterator<I<T*> >
struct test_view : std::ranges::view_base {
  I<T*> begin();
  I<T const*> begin() const;
  sentinel end();
  sentinel end() const;
};

template <class T = int>
struct BorrowedRange {
  T* begin() const;
  T* end() const;
  BorrowedRange(BorrowedRange&&) = delete;
};
template <class T>
inline constexpr bool std::ranges::enable_borrowed_range<BorrowedRange<T>> = true;
static_assert(!std::ranges::view<BorrowedRange<>>);
static_assert(std::ranges::borrowed_range<BorrowedRange<>>);

using BorrowedView = std::ranges::empty_view<int>;
static_assert(std::ranges::view<BorrowedView>);
static_assert(std::ranges::borrowed_range<BorrowedView>);

using NonBorrowedView = std::ranges::single_view<int>;
static_assert(std::ranges::view<NonBorrowedView>);
static_assert(!std::ranges::borrowed_range<NonBorrowedView>);

template <class Range>
concept simple_view =
    std::ranges::view<Range> && std::ranges::range<const Range> &&
    std::same_as<std::ranges::iterator_t<Range>, std::ranges::iterator_t<const Range>> &&
    std::same_as<std::ranges::sentinel_t<Range>, std::ranges::sentinel_t<const Range>>;

template <class View, class T>
concept CanBePiped = requires(View&& view, T&& t) {
  { std::forward<View>(view) | std::forward<T>(t) };
};

// See [concept.equalitycomparable]
template <class T, class U>
concept weakly_equality_comparable_with =
    requires(const std::remove_reference_t<T>& t, const std::remove_reference_t<U>& u) {
      { t == u } -> std::same_as<bool>;
      { t != u } -> std::same_as<bool>;
      { u == t } -> std::same_as<bool>;
      { u != t } -> std::same_as<bool>;
    };

#endif // LIBCXX_TEST_SUPPORT_TEST_RANGE_H