path: root/src/Progmasoft/Catch3/Matchers/Templated.hpp

//              Copyright Catch2 Authors
// Distributed under the Boost Software License, Version 1.0.
//   (See accompanying file LICENSE.txt or copy at
//        https://www.boost.org/LICENSE_1_0.txt)

// SPDX-License-Identifier: BSL-1.0
#pragma once

#include <Progmasoft/Catch3/Matchers/Matchers.hpp>
#include <Progmasoft/Catch3/Internal/StringRef.hpp>
#include <Progmasoft/Catch3/Internal/MoveAndForward.hpp>
#include <Progmasoft/Catch3/Internal/LifetimeBound.hpp>
#include <Progmasoft/Catch3/Internal/LogicalTraits.hpp>

#include <array>
#include <algorithm>
#include <string>
#include <type_traits>

namespace Catch {
namespace Matchers {
    class MatcherGenericBase : public MatcherUntypedBase {
        std::string describe() const override;
    public:
        constexpr MatcherGenericBase() = default;

        constexpr MatcherGenericBase(MatcherGenericBase const&) = default;
        constexpr MatcherGenericBase(MatcherGenericBase&&) = default;

        MatcherGenericBase& operator=(MatcherGenericBase const&) = delete;
        MatcherGenericBase& operator=(MatcherGenericBase&&) = delete;
    };


    namespace Detail {
        template<std::size_t N, std::size_t M>
        constexpr std::array<void const*, N + M>
        array_cat( std::array<void const*, N>&& lhs,
                   std::array<void const*, M>&& rhs ) {
            std::array<void const*, N + M> arr{};
            std::copy_n(lhs.begin(), N, arr.begin());
            std::copy_n(rhs.begin(), M, arr.begin() + N);
            return arr;
        }

        template<std::size_t N>
        constexpr std::array<void const*, N + 1>
        array_cat( std::array<void const*, N>&& lhs, void const* rhs ) {
            std::array<void const*, N+1> arr{};
            std::copy_n(lhs.begin(), N, arr.begin());
            arr[N] = rhs;
            return arr;
        }

        template<std::size_t N>
        constexpr std::array<void const*, N + 1>
        array_cat( void const* lhs, std::array<void const*, N>&& rhs ) {
            std::array<void const*, N + 1> arr{ {lhs} };
            std::copy_n(rhs.begin(), N, arr.begin() + 1);
            return arr;
        }

        template<typename T>
        static constexpr bool is_generic_matcher_v = std::is_base_of<
            Catch::Matchers::MatcherGenericBase,
            std::remove_cv_t<std::remove_reference_t<T>>
        >::value;

        template<typename... Ts>
        static constexpr bool are_generic_matchers_v = Catch::Detail::conjunction<std::integral_constant<bool,is_generic_matcher_v<Ts>>...>::value;

        template<typename T>
        static constexpr bool is_matcher_v = std::is_base_of<
            Catch::Matchers::MatcherUntypedBase,
            std::remove_cv_t<std::remove_reference_t<T>>
        >::value;


        template<std::size_t N, typename Arg>
        constexpr bool match_all_of( Arg&&,
                                    std::array<void const*, N> const&,
                                    std::index_sequence<> ) {
            return true;
        }

        template<typename T, typename... MatcherTs, std::size_t N, typename Arg, std::size_t Idx, std::size_t... Indices>
        constexpr bool match_all_of( Arg&& arg,
                                    std::array<void const*, N> const& matchers,
                                    std::index_sequence<Idx, Indices...> ) {
            return static_cast<T const*>(matchers[Idx])->match(arg) && match_all_of<MatcherTs...>(arg, matchers, std::index_sequence<Indices...>{});
        }


        template<std::size_t N, typename Arg>
        constexpr bool match_any_of( Arg&&,
                                     std::array<void const*, N> const&,
                                     std::index_sequence<> ) {
            return false;
        }

        template<typename T, typename... MatcherTs, std::size_t N, typename Arg, std::size_t Idx, std::size_t... Indices>
        constexpr bool match_any_of( Arg&& arg,
                                     std::array<void const*, N> const& matchers,
                                     std::index_sequence<Idx, Indices...> ) {
            return static_cast<T const*>(matchers[Idx])->match(arg) || match_any_of<MatcherTs...>(arg, matchers, std::index_sequence<Indices...>{});
        }

        std::string describe_multi_matcher(StringRef combine, std::string const* descriptions_begin, std::string const* descriptions_end);

        template<typename... MatcherTs, std::size_t... Idx>
        std::string describe_multi_matcher(StringRef combine, std::array<void const*, sizeof...(MatcherTs)> const& matchers, std::index_sequence<Idx...>) {
            std::array<std::string, sizeof...(MatcherTs)> descriptions {{
                static_cast<MatcherTs const*>(matchers[Idx])->toString()...
            }};

            return describe_multi_matcher(combine, descriptions.data(), descriptions.data() + descriptions.size());
        }


        template<typename... MatcherTs>
        class MatchAllOfGeneric final : public MatcherGenericBase {
        public:
            MatchAllOfGeneric(MatchAllOfGeneric const&) = delete;
            MatchAllOfGeneric& operator=(MatchAllOfGeneric const&) = delete;
            constexpr MatchAllOfGeneric( MatchAllOfGeneric&& ) = default;
            constexpr MatchAllOfGeneric& operator=(MatchAllOfGeneric&&) = default;

            constexpr MatchAllOfGeneric(
                MatcherTs const&... matchers CATCH_ATTR_LIFETIMEBOUND )
                : m_matchers{ {std::addressof(matchers)...} } {}
            constexpr explicit MatchAllOfGeneric(
                std::array<void const*, sizeof...( MatcherTs )> matchers ):
                m_matchers{ matchers } {}

            template<typename Arg>
            constexpr bool match( Arg&& arg ) const {
                return match_all_of<MatcherTs...>(arg, m_matchers, std::index_sequence_for<MatcherTs...>{});
            }

            std::string describe() const override {
                return describe_multi_matcher<MatcherTs...>(" and "_sr, m_matchers, std::index_sequence_for<MatcherTs...>{});
            }

            // Has to be public to enable the concatenating operators
            // below, because they are not friend of the RHS, only LHS,
            // and thus cannot access private fields of RHS
            std::array<void const*, sizeof...( MatcherTs )> m_matchers;


            //! Avoids type nesting for `GenericAllOf && GenericAllOf` case
            template<typename... MatchersRHS>
            constexpr friend
            MatchAllOfGeneric<MatcherTs..., MatchersRHS...> operator && (
                MatchAllOfGeneric<MatcherTs...>&& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatchAllOfGeneric<MatchersRHS...>&& rhs CATCH_ATTR_LIFETIMEBOUND ) {
                return MatchAllOfGeneric<MatcherTs..., MatchersRHS...>{array_cat(CATCH_MOVE(lhs.m_matchers), CATCH_MOVE(rhs.m_matchers))};
            }

            //! Avoids type nesting for `GenericAllOf && some matcher` case
            template<typename MatcherRHS>
            constexpr friend std::enable_if_t<
                is_matcher_v<MatcherRHS>,
            MatchAllOfGeneric<MatcherTs..., MatcherRHS>> operator && (
                MatchAllOfGeneric<MatcherTs...>&& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatcherRHS const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
                return MatchAllOfGeneric<MatcherTs..., MatcherRHS>{array_cat(CATCH_MOVE(lhs.m_matchers), static_cast<void const*>(&rhs))};
            }

            //! Avoids type nesting for `some matcher && GenericAllOf` case
            template<typename MatcherLHS>
            constexpr friend std::enable_if_t<
                is_matcher_v<MatcherLHS>,
            MatchAllOfGeneric<MatcherLHS, MatcherTs...>> operator && (
                MatcherLHS const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatchAllOfGeneric<MatcherTs...>&& rhs CATCH_ATTR_LIFETIMEBOUND ) {
                return MatchAllOfGeneric<MatcherLHS, MatcherTs...>{array_cat(static_cast<void const*>(std::addressof(lhs)), CATCH_MOVE(rhs.m_matchers))};
            }
        };


        template<typename... MatcherTs>
        class MatchAnyOfGeneric final : public MatcherGenericBase {
        public:
            MatchAnyOfGeneric(MatchAnyOfGeneric const&) = delete;
            MatchAnyOfGeneric& operator=(MatchAnyOfGeneric const&) = delete;
            constexpr MatchAnyOfGeneric( MatchAnyOfGeneric&& ) = default;
            constexpr MatchAnyOfGeneric& operator=(MatchAnyOfGeneric&&) = default;

            constexpr MatchAnyOfGeneric(
                MatcherTs const&... matchers CATCH_ATTR_LIFETIMEBOUND )
                : m_matchers{ {std::addressof(matchers)...} } {}
            constexpr explicit MatchAnyOfGeneric(
                std::array<void const*, sizeof...( MatcherTs )> matchers ):
                m_matchers{ matchers } {}

            template<typename Arg>
            constexpr bool match( Arg&& arg ) const {
                return match_any_of<MatcherTs...>(arg, m_matchers, std::index_sequence_for<MatcherTs...>{});
            }

            std::string describe() const override {
                return describe_multi_matcher<MatcherTs...>(" or "_sr, m_matchers, std::index_sequence_for<MatcherTs...>{});
            }


            // Has to be public to enable the concatenating operators
            // below, because they are not friend of the RHS, only LHS,
            // and thus cannot access private fields of RHS
            std::array<void const*, sizeof...( MatcherTs )> m_matchers;

            //! Avoids type nesting for `GenericAnyOf || GenericAnyOf` case
            template<typename... MatchersRHS>
            constexpr friend MatchAnyOfGeneric<MatcherTs..., MatchersRHS...>
            operator||(
                MatchAnyOfGeneric<MatcherTs...>&& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatchAnyOfGeneric<MatchersRHS...>&& rhs CATCH_ATTR_LIFETIMEBOUND ) {
                return MatchAnyOfGeneric<MatcherTs..., MatchersRHS...>{array_cat(CATCH_MOVE(lhs.m_matchers), CATCH_MOVE(rhs.m_matchers))};
            }

            //! Avoids type nesting for `GenericAnyOf || some matcher` case
            template<typename MatcherRHS>
            constexpr friend std::enable_if_t<
                is_matcher_v<MatcherRHS>,
            MatchAnyOfGeneric<MatcherTs..., MatcherRHS>> operator || (
                    MatchAnyOfGeneric<MatcherTs...>&& lhs CATCH_ATTR_LIFETIMEBOUND,
                    MatcherRHS const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
                return MatchAnyOfGeneric<MatcherTs..., MatcherRHS>{array_cat(CATCH_MOVE(lhs.m_matchers), static_cast<void const*>(std::addressof(rhs)))};
            }

            //! Avoids type nesting for `some matcher || GenericAnyOf` case
            template<typename MatcherLHS>
            constexpr friend std::enable_if_t<
                is_matcher_v<MatcherLHS>,
            MatchAnyOfGeneric<MatcherLHS, MatcherTs...>> operator || (
                MatcherLHS const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatchAnyOfGeneric<MatcherTs...>&& rhs CATCH_ATTR_LIFETIMEBOUND) {
                return MatchAnyOfGeneric<MatcherLHS, MatcherTs...>{array_cat(static_cast<void const*>(std::addressof(lhs)), CATCH_MOVE(rhs.m_matchers))};
            }
        };


        template<typename MatcherT>
        class MatchNotOfGeneric final : public MatcherGenericBase {
            MatcherT const& m_matcher;

        public:
            MatchNotOfGeneric(MatchNotOfGeneric const&) = delete;
            MatchNotOfGeneric& operator=(MatchNotOfGeneric const&) = delete;
            constexpr MatchNotOfGeneric( MatchNotOfGeneric&& ) = default;
            constexpr MatchNotOfGeneric& operator=(MatchNotOfGeneric&&) = default;

            constexpr explicit MatchNotOfGeneric(
                MatcherT const& matcher CATCH_ATTR_LIFETIMEBOUND )
                : m_matcher{matcher} {}

            template<typename Arg>
            constexpr bool match( Arg&& arg ) const {
                return !m_matcher.match(arg);
            }

            std::string describe() const override {
                return "not " + m_matcher.toString();
            }

            //! Negating negation can just unwrap and return underlying matcher
            constexpr friend MatcherT const&
            operator!( MatchNotOfGeneric<MatcherT> const& matcher
                           CATCH_ATTR_LIFETIMEBOUND ) {
                return matcher.m_matcher;
            }
        };
    } // namespace Detail


    // compose only generic matchers
    template<typename MatcherLHS, typename MatcherRHS>
    constexpr std::enable_if_t<
        Detail::are_generic_matchers_v<MatcherLHS, MatcherRHS>,
        Detail::MatchAllOfGeneric<MatcherLHS, MatcherRHS>>
    operator&&( MatcherLHS const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatcherRHS const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
        return { lhs, rhs };
    }

    template<typename MatcherLHS, typename MatcherRHS>
    constexpr std::enable_if_t<
        Detail::are_generic_matchers_v<MatcherLHS, MatcherRHS>,
        Detail::MatchAnyOfGeneric<MatcherLHS, MatcherRHS>>
    operator||( MatcherLHS const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatcherRHS const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
        return { lhs, rhs };
    }

    //! Wrap provided generic matcher in generic negator
    template<typename MatcherT>
    constexpr std::enable_if_t<Detail::is_generic_matcher_v<MatcherT>,
                               Detail::MatchNotOfGeneric<MatcherT>>
    operator!( MatcherT const& matcher CATCH_ATTR_LIFETIMEBOUND ) {
        return Detail::MatchNotOfGeneric<MatcherT>{matcher};
    }


    // compose mixed generic and non-generic matchers
    template<typename MatcherLHS, typename ArgRHS>
    std::enable_if_t<Detail::is_generic_matcher_v<MatcherLHS>, Detail::MatchAllOfGeneric<MatcherLHS, MatcherBase<ArgRHS>>>
    operator&&( MatcherLHS const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatcherBase<ArgRHS> const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
        return { lhs, rhs };
    }

    template<typename ArgLHS, typename MatcherRHS>
    std::enable_if_t<Detail::is_generic_matcher_v<MatcherRHS>, Detail::MatchAllOfGeneric<MatcherBase<ArgLHS>, MatcherRHS>>
    operator&&( MatcherBase<ArgLHS> const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatcherRHS const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
        return { lhs, rhs };
    }

    template<typename MatcherLHS, typename ArgRHS>
    std::enable_if_t<Detail::is_generic_matcher_v<MatcherLHS>, Detail::MatchAnyOfGeneric<MatcherLHS, MatcherBase<ArgRHS>>>
    operator||( MatcherLHS const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatcherBase<ArgRHS> const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
        return { lhs, rhs };
    }

    template<typename ArgLHS, typename MatcherRHS>
    std::enable_if_t<Detail::is_generic_matcher_v<MatcherRHS>, Detail::MatchAnyOfGeneric<MatcherBase<ArgLHS>, MatcherRHS>>
    operator||( MatcherBase<ArgLHS> const& lhs CATCH_ATTR_LIFETIMEBOUND,
                MatcherRHS const& rhs CATCH_ATTR_LIFETIMEBOUND ) {
        return { lhs, rhs };
    }

} // namespace Matchers
} // namespace Catch