InterfaceMock.hpp

Go to the documentation of this file.

//          Copyright Dominic (DNKpp) Koepke 2024 - 2025.
// Distributed under the Boost Software License, Version 1.0.
//    (See accompanying file LICENSE_1_0.txt or copy at
//          https://www.boost.org/LICENSE_1_0.txt)
 
#ifndef MIMICPP_INTERFACE_MOCK_HPP
#define MIMICPP_INTERFACE_MOCK_HPP
 
#pragma once
 
#include "mimic++/Fwd.hpp"
#include "mimic++/Mock.hpp"
#include "mimic++/Utility.hpp"
 
#include <type_traits>
#include <utility>
 
namespace mimicpp
{


}

#define MIMICPP_DETAIL_STRIP_PARENS(x) MIMICPP_DETAIL_STRIP_PARENS_OUTER(MIMICPP_DETAIL_STRIP_PARENS_INNER x)

#define MIMICPP_DETAIL_STRIP_PARENS_INNER(...) MIMICPP_DETAIL_STRIP_PARENS_INNER __VA_ARGS__

#define MIMICPP_DETAIL_STRIP_PARENS_OUTER(...) MIMICPP_DETAIL_STRIP_PARENS_OUTER_(__VA_ARGS__)

#define MIMICPP_DETAIL_STRIP_PARENS_OUTER_(...) MIMICPP_DETAIL_STRIP_PARENS_STRIPPED_##__VA_ARGS__

#define MIMICPP_DETAIL_STRIP_PARENS_STRIPPED_MIMICPP_DETAIL_STRIP_PARENS_INNER
 
namespace mimicpp
{
}

#define MIMICPP_DETAIL_PARENS ()

#define MIMICPP_DETAIL_COMMA_DELIMITER() ,

#define MIMICPP_DETAIL_NO_DELIMITER()

#define MIMICPP_DETAIL_IDENTITY(...) __VA_ARGS__

#define MIMICPP_DETAIL_EXPAND(...) MIMICPP_DETAIL_EXPAND3(MIMICPP_DETAIL_EXPAND3(MIMICPP_DETAIL_EXPAND3(MIMICPP_DETAIL_EXPAND3(__VA_ARGS__))))

#define MIMICPP_DETAIL_EXPAND3(...) MIMICPP_DETAIL_EXPAND2(MIMICPP_DETAIL_EXPAND2(MIMICPP_DETAIL_EXPAND2(MIMICPP_DETAIL_EXPAND2(__VA_ARGS__))))

#define MIMICPP_DETAIL_EXPAND2(...) MIMICPP_DETAIL_EXPAND1(MIMICPP_DETAIL_EXPAND1(MIMICPP_DETAIL_EXPAND1(MIMICPP_DETAIL_EXPAND1(__VA_ARGS__))))

#define MIMICPP_DETAIL_EXPAND1(...) __VA_ARGS__

#define MIMICPP_DETAIL_FOR_EACH_EXT_INDIRECT(macro, sequence, ...) macro(sequence, __VA_ARGS__)

#define MIMICPP_DETAIL_FOR_EACH_EXT(macro, token, delimiter, projection_macro, bound, ...) \
    __VA_OPT__(MIMICPP_DETAIL_EXPAND(MIMICPP_DETAIL_FOR_EACH_EXT_HELPER(macro, token, token, delimiter, projection_macro, bound, __VA_ARGS__)))

#define MIMICPP_DETAIL_FOR_EACH_EXT_HELPER(macro, token, sequence, delimiter, projection_macro, bound, a1, ...)     \
    MIMICPP_DETAIL_FOR_EACH_EXT_INDIRECT(macro, sequence, MIMICPP_DETAIL_STRIP_PARENS(bound), projection_macro(a1)) \
    __VA_OPT__(delimiter() MIMICPP_FOR_EACH_EXT_AGAIN MIMICPP_DETAIL_PARENS(macro, token, sequence##token, delimiter, projection_macro, bound, __VA_ARGS__))

#define MIMICPP_FOR_EACH_EXT_AGAIN() MIMICPP_DETAIL_FOR_EACH_EXT_HELPER
 
namespace mimicpp
{
}

#define MIMICPP_DETAIL_MAKE_SIGNATURE(sequence, bound_data, ret, call_convention, param_type_list, specs, ...) \
    MIMICPP_DETAIL_STRIP_PARENS(ret)                                                                           \
    call_convention param_type_list specs

#define MIMICPP_DETAIL_MAKE_SIGNATURE_LIST(...) \
    MIMICPP_DETAIL_FOR_EACH_EXT(                \
        MIMICPP_DETAIL_MAKE_SIGNATURE,          \
        ,                                       \
        MIMICPP_DETAIL_COMMA_DELIMITER,         \
        MIMICPP_DETAIL_STRIP_PARENS,            \
        ,                                       \
        __VA_ARGS__)
 
namespace mimicpp::detail
{
    // Removes the following stacktrace-entries from stacktraces generated by interface mocks:
    // * detail::indirectly_apply_mock
    // * detail::indirectly_apply_mock::lambda
    // * the generated interface implementation
    inline constexpr std::size_t interfaceMockStacktraceSkip{3u};
}

#define MIMICPP_DETAIL_MAKE_OVERLOADED_MOCK(mock_name, signatures)     \
    ::mimicpp::Mock<MIMICPP_DETAIL_STRIP_PARENS(signatures)> mock_name \
    {                                                                  \
        ::mimicpp::detail::interfaceMockStacktraceSkip                 \
    }
 
namespace mimicpp
{
}

#define MIMICPP_DETAIL_MAKE_PARAM(sequence, bound_data, type) MIMICPP_DETAIL_STRIP_PARENS(type) arg_##sequence

#define MIMICPP_DETAIL_MAKE_PARAM_LIST(...) \
    MIMICPP_DETAIL_FOR_EACH_EXT(            \
        MIMICPP_DETAIL_MAKE_PARAM,          \
        i,                                  \
        MIMICPP_DETAIL_COMMA_DELIMITER,     \
        MIMICPP_DETAIL_IDENTITY,            \
        ,                                   \
        __VA_ARGS__)
 
namespace mimicpp
{
}

#define MIMICPP_DETAIL_FORWARD_ARG_AS_TUPLE(sequence, bound_data, param_type)              \
    [&]<typename... Type>([[maybe_unused]] const ::mimicpp::type_list<Type...>) noexcept { \
        return ::std::forward_as_tuple(                                                    \
            ::std::forward<Type>(arg_##sequence)...);                                      \
    }(::mimicpp::type_list<MIMICPP_DETAIL_STRIP_PARENS(param_type)>{})

#define MIMICPP_DETAIL_FORWARD_ARGS_AS_TUPLE(...) \
    MIMICPP_DETAIL_FOR_EACH_EXT(                  \
        MIMICPP_DETAIL_FORWARD_ARG_AS_TUPLE,      \
        i,                                        \
        MIMICPP_DETAIL_COMMA_DELIMITER,           \
        MIMICPP_DETAIL_IDENTITY,                  \
        ,                                         \
        __VA_ARGS__)
 
namespace mimicpp
{
}

#define MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_ALL(ret, param_type_list, specs, call_convention, ...) \
    (                                                                                             \
        ret,                                                                                      \
        MIMICPP_DETAIL_STRIP_PARENS(call_convention),                                             \
        param_type_list,                                                                          \
        MIMICPP_DETAIL_STRIP_PARENS(specs),                                                       \
        (MIMICPP_DETAIL_MAKE_PARAM_LIST(MIMICPP_DETAIL_STRIP_PARENS(param_type_list))),           \
        (MIMICPP_DETAIL_FORWARD_ARGS_AS_TUPLE(MIMICPP_DETAIL_STRIP_PARENS(param_type_list))))

#define MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_SPECS(ret, param_type_list, specs, ...) \
    MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_ALL(ret, param_type_list, specs, )

#define MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_BASIC(ret, param_type_list, ...) \
    MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_ALL(ret, param_type_list, , )

#define MIMICPP_DETAIL_SELECT_MAKE_OVERLOAD_INFOS(_1, _2, N, ...) N

#define MIMICPP_ADD_OVERLOAD(ret, param_type_list, ...) \
    MIMICPP_DETAIL_SELECT_MAKE_OVERLOAD_INFOS(          \
        __VA_ARGS__,                                    \
        MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_ALL,         \
        MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_SPECS,       \
        MIMICPP_DETAIL_MAKE_OVERLOAD_INFOS_BASIC)(ret, param_type_list, __VA_ARGS__, ) // clangCl doesn't compile without that extra ,
 
namespace mimicpp
{
}
 
namespace mimicpp::detail
{
    template <typename Signature, typename Mock, typename... Args>
    constexpr signature_return_type_t<Signature> indirectly_apply_mock(Mock& mock, std::tuple<Args...>&& args)
    {
        using mock_ref_t = std::conditional_t<
            ValueCategory::rvalue == signature_ref_qualification_v<Signature>,
            Mock&&,
            Mock&>;
        const auto forward_apply = [&]<std::size_t... indices>([[maybe_unused]] const std::index_sequence<indices...>)
            -> signature_return_type_t<Signature> {
            return static_cast<mock_ref_t>(mock)(
                std::forward<Args>(std::get<indices>(args))...);
        };
 
        constexpr auto sequence = std::index_sequence_for<Args...>{};
        return forward_apply(sequence);
    };
}

#define MIMICPP_DETAIL_MAKE_METHOD_OVERRIDE(ignore, mock_name, fn_name, ret, call_convention, param_type_list, specs, param_list, forward_list, ...) \
    inline MIMICPP_DETAIL_STRIP_PARENS(ret) call_convention fn_name param_list specs override                                                        \
    {                                                                                                                                                \
        using SignatureT = MIMICPP_DETAIL_STRIP_PARENS(ret) param_type_list specs;                                                                   \
        return ::mimicpp::detail::indirectly_apply_mock<SignatureT>(                                                                                 \
            mock_name,                                                                                                                               \
            ::std::tuple_cat(MIMICPP_DETAIL_STRIP_PARENS(forward_list)));                                                                            \
    }

#define MIMICPP_DETAIL_MAKE_METHOD_OVERRIDES(mock_name, fn_name, ...) \
    MIMICPP_DETAIL_FOR_EACH_EXT(                                      \
        MIMICPP_DETAIL_MAKE_METHOD_OVERRIDE,                          \
        ,                                                             \
        MIMICPP_DETAIL_NO_DELIMITER,                                  \
        MIMICPP_DETAIL_STRIP_PARENS,                                  \
        (mock_name, fn_name),                                         \
        __VA_ARGS__)

#define MIMICPP_MOCK_OVERLOADED_METHOD(fn_name, ...)                       \
    MIMICPP_DETAIL_MAKE_METHOD_OVERRIDES(fn_name##_, fn_name, __VA_ARGS__) \
    MIMICPP_DETAIL_MAKE_OVERLOADED_MOCK(                                   \
        fn_name##_,                                                        \
        (MIMICPP_DETAIL_MAKE_SIGNATURE_LIST(__VA_ARGS__)))

#define MIMICPP_MOCK_METHOD(fn_name, ret, param_type_list, ...) \
    MIMICPP_MOCK_OVERLOADED_METHOD(                             \
        fn_name,                                                \
        MIMICPP_ADD_OVERLOAD(ret, param_type_list __VA_OPT__(, ) __VA_ARGS__))
 
#ifndef MIMICPP_CONFIG_ONLY_PREFIXED_MACROS

    #define MOCK_METHOD MIMICPP_MOCK_METHOD

    #define MOCK_OVERLOADED_METHOD MIMICPP_MOCK_OVERLOADED_METHOD

    #define ADD_OVERLOAD MIMICPP_ADD_OVERLOAD
 
#endif
 
#endif