dds/external/ranges-v3/include/range/v3/view/interface.hpp

/// \file
// Range v3 library
//
//  Copyright Eric Niebler 2014-present
//
//  Use, modification and distribution is subject to the
//  Boost Software License, Version 1.0. (See accompanying
//  file LICENSE_1_0.txt or copy at
//  http://www.boost.org/LICENSE_1_0.txt)
//
// Project home: https://github.com/ericniebler/range-v3
//
#ifndef RANGES_V3_VIEW_INTERFACE_HPP
#define RANGES_V3_VIEW_INTERFACE_HPP

#include <iosfwd>

#include <meta/meta.hpp>

#include <concepts/concepts.hpp>

#include <range/v3/range_fwd.hpp>

#include <range/v3/iterator/common_iterator.hpp>
#include <range/v3/iterator/operations.hpp>
#include <range/v3/range/access.hpp>
#include <range/v3/range/concepts.hpp>
#include <range/v3/range/conversion.hpp>
#include <range/v3/range/primitives.hpp>
#include <range/v3/range/traits.hpp>

#if defined(RANGES_WORKAROUND_GCC_91525)
#define CPP_template_gcc_workaround CPP_template_sfinae
#else
#define CPP_template_gcc_workaround CPP_template
#endif

namespace ranges
{
    /// \cond
    namespace detail
    {
        template<typename From, typename To = From>
        struct slice_bounds
        {
            From from;
            To to;
            template<typename F, typename T>
            constexpr CPP_ctor(slice_bounds)(F f, T t)( //
                requires convertible_to<F, From> && convertible_to<T, To>)
              : from(static_cast<From>(f))
              , to(static_cast<To>(t))
            {}
        };

        template<typename Int>
        struct from_end_
        {
            Int dist_;

            constexpr explicit from_end_(Int dist)
              : dist_(dist)
            {}

            CPP_template(typename Other)(                                               //
                requires integer_like_<Other> && explicitly_convertible_to<Other, Int>) //
                constexpr
                operator from_end_<Other>() const
            {
                return from_end_<Other>{static_cast<Other>(dist_)};
            }
        };

        template<typename Rng>
        using from_end_of_t = from_end_<range_difference_t<Rng>>;

        // clang-format off
        CPP_def
        (
            template(typename Rng)
            concept can_empty_,
                requires (Rng &rng)
                (
                    ranges::empty(rng)
                )
        );
        // clang-format on

        constexpr bool has_fixed_size_(cardinality c) noexcept
        {
            return c >= 0 || c == infinite;
        }

        template<bool>
        struct dependent_
        {
            template<typename T>
            using invoke = T;
        };

        template<typename Stream, typename Rng>
        Stream & print_rng_(Stream & sout, Rng & rng)
        {
            sout << '[';
            auto it = ranges::begin(rng);
            auto const e = ranges::end(rng);
            if(it != e)
            {
                for(;;)
                {
                    sout << *it;
                    if(++it == e)
                        break;
                    sout << ',';
                }
            }
            sout << ']';
            return sout;
        }
    } // namespace detail
    /// \endcond

    /// \addtogroup group-views
    /// @{
    template<typename Derived, cardinality Cardinality /* = finite*/>
    struct view_interface : basic_view<Cardinality>
    {
    protected:
        template<bool B>
        using D = meta::invoke<detail::dependent_<B>, Derived>;

        constexpr Derived & derived() noexcept
        {
            CPP_assert(derived_from<Derived, view_interface>);
            return static_cast<Derived &>(*this);
        }
        /// \overload
        constexpr Derived const & derived() const noexcept
        {
            CPP_assert(derived_from<Derived, view_interface>);
            return static_cast<Derived const &>(*this);
        }
        ~view_interface() = default;

    public:
        view_interface() = default;
        view_interface(view_interface &&) = default;
        view_interface(view_interface const &) = default;
        view_interface & operator=(view_interface &&) = default;
        view_interface & operator=(view_interface const &) = default;
        // A few ways of testing whether a range can be empty:
        CPP_member
        constexpr auto empty() const noexcept -> CPP_ret(bool)( //
            requires(detail::has_fixed_size_(Cardinality)))
        {
            return Cardinality == 0;
        }
        /// \overload
        template<bool True = true>
        constexpr auto empty() noexcept(noexcept(
            bool(ranges::size(std::declval<D<True> &>()) == 0))) -> CPP_ret(bool)( //
            requires True && (Cardinality < 0) && (Cardinality != infinite) &&
            (!forward_range<D<True>>)&&sized_range<D<True>>)
        {
            return ranges::size(derived()) == 0;
        }
        /// \overload
        template<bool True = true>
        constexpr auto empty() const
            noexcept(noexcept(bool(ranges::size(std::declval<D<True> const &>()) == 0)))
                -> CPP_ret(bool)( //
                    requires True && (Cardinality < 0) && (Cardinality != infinite) &&
                    (!forward_range<D<True> const>)&&sized_range<D<True> const>)
        {
            return ranges::size(derived()) == 0;
        }
        /// \overload
        template<bool True = true>
        constexpr auto empty() noexcept(
            noexcept(bool(ranges::begin(std::declval<D<True> &>()) ==
                          ranges::end(std::declval<D<True> &>())))) -> CPP_ret(bool)( //
            requires True && (!detail::has_fixed_size_(Cardinality)) &&
            forward_range<D<True>>)
        {
            return bool(ranges::begin(derived()) == ranges::end(derived()));
        }
        /// \overload
        template<bool True = true>
        constexpr auto empty() const
            noexcept(noexcept(bool(ranges::begin(std::declval<D<True> const &>()) ==
                                   ranges::end(std::declval<D<True> const &>()))))
                -> CPP_ret(bool)( //
                    requires True && (!detail::has_fixed_size_(Cardinality)) &&
                    forward_range<D<True> const>)
        {
            return bool(ranges::begin(derived()) == ranges::end(derived()));
        }
        CPP_template_gcc_workaround(bool True = true)(    //
            requires True && detail::can_empty_<D<True>>) // clang-format off
        constexpr explicit operator bool()
            noexcept(noexcept(ranges::empty(std::declval<D<True> &>())))
        {
            return !ranges::empty(derived());
        }
        // clang-format on
        /// \overload
        CPP_template_gcc_workaround(bool True = true)(          //
            requires True && detail::can_empty_<D<True> const>) // clang-format off
        constexpr explicit operator bool() const
            noexcept(noexcept(ranges::empty(std::declval<D<True> const &>())))
        {
            return !ranges::empty(derived());
        }
        // clang-format on
        /// If the size of the range is known at compile-time and finite,
        /// return it.
        template<bool True = true, int = 42>
        static constexpr auto size() noexcept -> CPP_ret(std::size_t)( //
            requires True && (Cardinality >= 0))
        {
            return static_cast<std::size_t>(Cardinality);
        }
        /// If `sized_sentinel_for<sentinel_t<Derived>, iterator_t<Derived>>` is
        /// satisfied, and if `Derived` is a `forward_range`, then return
        /// `end - begin` cast to an unsigned integer.
        template<bool True = true>
        constexpr auto size() -> CPP_ret(detail::iter_size_t<iterator_t<D<True>>>)( //
            requires True && (Cardinality < 0) &&
            sized_sentinel_for<sentinel_t<D<True>>, iterator_t<D<True>>> &&
            forward_range<D<True>>)
        {
            using size_type = detail::iter_size_t<iterator_t<D<True>>>;
            return static_cast<size_type>(derived().end() - derived().begin());
        }
        /// \overload
        template<bool True = true>
        constexpr auto size() const                               //
            -> CPP_ret(detail::iter_size_t<iterator_t<D<True>>>)( //
                requires True && (Cardinality < 0) &&
                sized_sentinel_for<sentinel_t<D<True> const>,
                                   iterator_t<D<True> const>> &&
                forward_range<D<True> const>)
        {
            using size_type = detail::iter_size_t<iterator_t<D<True>>>;
            return static_cast<size_type>(derived().end() - derived().begin());
        }
        /// Access the first element in a range:
        template<bool True = true>
        constexpr auto front() -> CPP_ret(range_reference_t<D<True>>)( //
            requires True && forward_range<D<True>>)
        {
            return *derived().begin();
        }
        /// \overload
        template<bool True = true>
        constexpr auto front() const -> CPP_ret(range_reference_t<D<True> const>)( //
            requires True && forward_range<D<True> const>)
        {
            return *derived().begin();
        }
        /// Access the last element in a range:
        template<bool True = true>
        constexpr auto back() -> CPP_ret(range_reference_t<D<True>>)( //
            requires True && common_range<D<True>> && bidirectional_range<D<True>>)
        {
            return *prev(derived().end());
        }
        /// \overload
        template<bool True = true>
        constexpr auto back() const -> CPP_ret(range_reference_t<D<True> const>)( //
            requires True && common_range<D<True> const> &&
                bidirectional_range<D<True> const>)
        {
            return *prev(derived().end());
        }
        /// Simple indexing:
        template<bool True = true>
        constexpr auto operator[](range_difference_t<D<True>> n)
            -> CPP_ret(range_reference_t<D<True>>)( //
                requires True && random_access_range<D<True>>)
        {
            return derived().begin()[n];
        }
        /// \overload
        template<bool True = true>
        constexpr auto operator[](range_difference_t<D<True>> n) const
            -> CPP_ret(range_reference_t<D<True> const>)( //
                requires True && random_access_range<D<True> const>)
        {
            return derived().begin()[n];
        }
        /// Returns a reference to the element at specified location pos, with bounds
        /// checking.
        template<bool True = true>
        constexpr auto at(range_difference_t<D<True>> n)
            -> CPP_ret(range_reference_t<D<True>>)( //
                requires True && random_access_range<D<True>> && sized_range<D<True>>)
        {
            using size_type = range_size_t<Derived>;
            if(n < 0 || size_type(n) >= ranges::size(derived()))
            {
                throw std::out_of_range("view_interface::at");
            }
            return derived().begin()[n];
        }
        /// \overload
        template<bool True = true>
        constexpr auto at(range_difference_t<D<True>> n) const
            -> CPP_ret(range_reference_t<D<True> const>)( //
                requires True && random_access_range<D<True> const> &&
                    sized_range<D<True> const>)
        {
            using size_type = range_size_t<Derived const>;
            if(n < 0 || size_type(n) >= ranges::size(derived()))
            {
                throw std::out_of_range("view_interface::at");
            }
            return derived().begin()[n];
        }
        /// Python-ic slicing:
        //      rng[{4,6}]
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && input_range<D<True> &>)                      //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>> offs) &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && input_range<D<True> const &>)                //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>> offs) const &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && input_range<D<True>>)                        //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>> offs) &&
        {
            return Slice{}(detail::move(derived()), offs.from, offs.to);
        }
        //      rng[{4,end-2}]
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)(      //
            requires True && input_range<D<True> &> && sized_range<D<True> &>) //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>,
                                            detail::from_end_of_t<D<True>>>
                           offs) &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && input_range<D<True> const &> &&
                sized_range<D<True> const &>) //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>,
                                            detail::from_end_of_t<D<True>>>
                           offs) const &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)(  //
            requires True && input_range<D<True>> && sized_range<D<True>>) //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>,
                                            detail::from_end_of_t<D<True>>>
                           offs) &&
        {
            return Slice{}(detail::move(derived()), offs.from, offs.to);
        }
        //      rng[{end-4,end-2}]
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && (forward_range<D<True> &> ||
                              (input_range<D<True> &> && sized_range<D<True> &>))) //
            constexpr auto
            operator[](detail::slice_bounds<detail::from_end_of_t<D<True>>,
                                            detail::from_end_of_t<D<True>>>
                           offs) &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True &&
            (forward_range<D<True> const &> ||
             (input_range<D<True> const &> && sized_range<D<True> const &>))) //
            constexpr auto
            operator[](detail::slice_bounds<detail::from_end_of_t<D<True>>,
                                            detail::from_end_of_t<D<True>>>
                           offs) const &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True &&
            (forward_range<D<True>> || (input_range<D<True>> && sized_range<D<True>>))) //
            constexpr auto
            operator[](detail::slice_bounds<detail::from_end_of_t<D<True>>,
                                            detail::from_end_of_t<D<True>>>
                           offs) &&
        {
            return Slice{}(detail::move(derived()), offs.from, offs.to);
        }
        //      rng[{4,end}]
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && input_range<D<True> &>)                      //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>, end_fn> offs) &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && input_range<D<True> const &>)                //
            constexpr auto
            operator[](
                detail::slice_bounds<range_difference_t<D<True>>, end_fn> offs) const &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && input_range<D<True>>)                        //
            constexpr auto
            operator[](detail::slice_bounds<range_difference_t<D<True>>, end_fn> offs) &&
        {
            return Slice{}(detail::move(derived()), offs.from, offs.to);
        }
        //      rng[{end-4,end}]
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True && (forward_range<D<True> &> ||
                              (input_range<D<True> &> && sized_range<D<True> &>))) //
            constexpr auto
            operator[](
                detail::slice_bounds<detail::from_end_of_t<D<True>>, end_fn> offs) &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True &&
            (forward_range<D<True> const &> ||
             (input_range<D<True> const &> && sized_range<D<True> const &>))) //
            constexpr auto
            operator[](
                detail::slice_bounds<detail::from_end_of_t<D<True>>, end_fn> offs) const &
        {
            return Slice{}(derived(), offs.from, offs.to);
        }
        /// \overload
        CPP_template(bool True = true, typename Slice = views::slice_fn)( //
            requires True &&
            (forward_range<D<True>> || (input_range<D<True>> && sized_range<D<True>>))) //
            constexpr auto
            operator[](
                detail::slice_bounds<detail::from_end_of_t<D<True>>, end_fn> offs) &&
        {
            return Slice{}(detail::move(derived()), offs.from, offs.to);
        }
        /// \cond
        /// Implicit conversion to something that looks like a container.
        CPP_template(typename Container, bool True = true)( // clang-format off
            requires detail::convertible_to_container<D<True>, Container>)
        RANGES_DEPRECATED(
            "Implicit conversion from a view to a container is deprecated. "
            "Please use ranges::to in <range/v3/range/conversion.hpp> instead.")
        constexpr operator Container() // clang-format on
        {
            return ranges::to<Container>(derived());
        }
        /// \overload
        CPP_template(typename Container, bool True = true)( // clang-format off
            requires detail::convertible_to_container<D<True> const, Container>)
        RANGES_DEPRECATED(
            "Implicit conversion from a view to a container is deprecated. "
            "Please use ranges::to in <range/v3/range/conversion.hpp> instead.")
        constexpr operator Container() const // clang-format on
        {
            return ranges::to<Container>(derived());
        }
        /// \endcond
    private:
        /// \brief Print a range to an ostream
        template<bool True = true>
        friend auto operator<<(std::ostream & sout, Derived const & rng)
            -> CPP_broken_friend_ret(std::ostream &)( //
                requires True && input_range<D<True> const>)
        {
            return detail::print_rng_(sout, rng);
        }
        /// \overload
        template<bool True = true>
        friend auto operator<<(std::ostream & sout, Derived & rng)
            -> CPP_broken_friend_ret(std::ostream &)( //
                requires True && (!range<D<True> const>)&&input_range<D<True>>)
        {
            return detail::print_rng_(sout, rng);
        }
        /// \overload
        template<bool True = true>
        friend auto operator<<(std::ostream & sout, Derived && rng)
            -> CPP_broken_friend_ret(std::ostream &)( //
                requires True && (!range<D<True> const>)&&input_range<D<True>>)
        {
            return detail::print_rng_(sout, rng);
        }
    };

    namespace cpp20
    {
        CPP_template(typename Derived)( //
            requires std::is_class<Derived>::value &&
                same_as<Derived, meta::_t<std::remove_cv<Derived>>>) //
            using view_interface = ranges::view_interface<Derived, ranges::unknown>;
    }
    /// @}
} // namespace ranges

#endif