entt/test/entt/meta/meta_utility.cpp

#include <array>
#include <iterator>
#include <utility>
#include <gtest/gtest.h>
#include <entt/core/type_traits.hpp>
#include <entt/meta/meta.hpp>
#include <entt/meta/policy.hpp>
#include <entt/meta/resolve.hpp>
#include <entt/meta/utility.hpp>
#include "../../common/config.h"
#include "../../common/value_type.h"

struct MetaUtility: ::testing::Test {
    struct clazz {
        void setter(int iv) {
            member = iv;
        }

        [[nodiscard]] int getter() const {
            return member;
        }

        static void static_setter(clazz &instance, int iv) {
            instance.member = iv;
        }

        [[nodiscard]] static int static_getter(const clazz &instance) {
            return instance.member;
        }

        static void reset_value() {
            value = 0;
        }

        [[nodiscard]] static int get_value() {
            return value;
        }

        [[nodiscard]] static clazz factory(int iv) {
            clazz instance{};
            instance.member = iv;
            return instance;
        }

        int member{};
        const int cmember{};              // NOLINT
        inline static int value{};        // NOLINT
        inline static const int cvalue{}; // NOLINT
        inline static int arr[3u]{};      // NOLINT
    };

    void SetUp() override {
        clazz::value = 0;
    }
};

using MetaUtilityDeathTest = MetaUtility;

TEST_F(MetaUtility, MetaDispatch) {
    int value = 2;

    auto as_cref = entt::meta_dispatch<entt::as_cref_t>(value);
    auto as_ref = entt::meta_dispatch<entt::as_ref_t>(value);
    auto as_void = entt::meta_dispatch<entt::as_void_t>(value);
    auto as_is_copy = entt::meta_dispatch<entt::as_is_t>(static_cast<int &&>(value));
    auto as_is_cref = entt::meta_dispatch<entt::as_is_t>(std::as_const(value));
    auto as_is_ref = entt::meta_dispatch<entt::as_is_t>(value);
    auto as_value = entt::meta_dispatch(value);

    ASSERT_EQ(as_cref.type(), entt::resolve<int>());
    ASSERT_EQ(as_ref.type(), entt::resolve<int>());
    ASSERT_EQ(as_void.type(), entt::resolve<void>());
    ASSERT_EQ(as_is_copy.type(), entt::resolve<int>());
    ASSERT_EQ(as_is_cref.type(), entt::resolve<int>());
    ASSERT_EQ(as_is_ref.type(), entt::resolve<int>());
    ASSERT_EQ(as_value.type(), entt::resolve<int>());

    ASSERT_EQ(as_cref.base().policy(), entt::any_policy::cref);
    ASSERT_EQ(as_ref.base().policy(), entt::any_policy::ref);
    ASSERT_EQ(as_void.base().policy(), entt::any_policy::empty);
    ASSERT_EQ(as_is_copy.base().policy(), entt::any_policy::embedded);
    ASSERT_EQ(as_is_cref.base().policy(), entt::any_policy::cref);
    ASSERT_EQ(as_is_ref.base().policy(), entt::any_policy::ref);
    ASSERT_EQ(as_value.base().policy(), entt::any_policy::embedded);

    ASSERT_EQ(as_cref.try_cast<int>(), nullptr);
    ASSERT_NE(as_cref.try_cast<const int>(), nullptr);
    ASSERT_NE(as_ref.try_cast<int>(), nullptr);
    ASSERT_NE(as_is_copy.try_cast<int>(), nullptr);
    ASSERT_EQ(as_is_cref.try_cast<int>(), nullptr);
    ASSERT_NE(as_is_ref.try_cast<int>(), nullptr);
    ASSERT_NE(as_value.try_cast<int>(), nullptr);

    ASSERT_EQ(as_cref.cast<int>(), 2);
    ASSERT_EQ(as_ref.cast<int>(), 2);
    ASSERT_EQ(as_is_copy.cast<int>(), 2);
    ASSERT_EQ(as_is_cref.cast<int>(), 2);
    ASSERT_EQ(as_is_ref.cast<int>(), 2);
    ASSERT_EQ(as_value.cast<int>(), 2);
}

TEST_F(MetaUtility, MetaDispatchMetaAny) {
    entt::meta_any any{2};

    auto from_any = entt::meta_dispatch(any);
    auto from_const_any = entt::meta_dispatch(std::as_const(any));

    ASSERT_EQ(from_any.type(), entt::resolve<int>());
    ASSERT_EQ(from_const_any.type(), entt::resolve<int>());

    ASSERT_NE(from_any.try_cast<int>(), nullptr);
    ASSERT_NE(from_const_any.try_cast<int>(), nullptr);

    ASSERT_EQ(from_any.cast<int>(), 2);
    ASSERT_EQ(from_const_any.cast<int>(), 2);
}

TEST_F(MetaUtility, MetaDispatchMetaAnyAsRef) {
    entt::meta_any any{2};

    auto from_any = entt::meta_dispatch(any.as_ref());
    auto from_const_any = entt::meta_dispatch(std::as_const(any).as_ref());

    ASSERT_EQ(from_any.type(), entt::resolve<int>());
    ASSERT_EQ(from_const_any.type(), entt::resolve<int>());

    ASSERT_NE(from_any.try_cast<int>(), nullptr);
    ASSERT_EQ(from_const_any.try_cast<int>(), nullptr);
    ASSERT_NE(from_const_any.try_cast<const int>(), nullptr);

    ASSERT_EQ(from_any.cast<int>(), 2);
    ASSERT_EQ(from_const_any.cast<int>(), 2);
}

TEST_F(MetaUtility, MetaArg) {
    ASSERT_EQ((entt::meta_arg<entt::type_list<int, char>>(0u)), entt::resolve<int>());
    ASSERT_EQ((entt::meta_arg<entt::type_list<int, char>>(1u)), entt::resolve<char>());
}

ENTT_DEBUG_TEST_F(MetaUtilityDeathTest, MetaArg) {
    ASSERT_DEATH([[maybe_unused]] auto type = entt::meta_arg<entt::type_list<>>(0u), "");
    ASSERT_DEATH([[maybe_unused]] auto type = entt::meta_arg<entt::type_list<int>>(3u), "");
}

TEST_F(MetaUtility, MetaSetter) {
    const int invalid{};
    clazz instance{};

    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::static_setter>(instance, instance)));
    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::static_setter>(std::as_const(instance), 4)));
    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::static_setter>(invalid, 4)));
    ASSERT_TRUE((entt::meta_setter<clazz, &clazz::static_setter>(instance, 4)));
    ASSERT_EQ(instance.member, 4);

    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::setter>(instance, instance)));
    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::setter>(std::as_const(instance), 3)));
    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::setter>(invalid, 3)));
    ASSERT_TRUE((entt::meta_setter<clazz, &clazz::setter>(instance, 3)));
    ASSERT_EQ(instance.member, 3);

    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::member>(instance, instance)));
    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::member>(invalid, 8)));
    ASSERT_TRUE((entt::meta_setter<clazz, &clazz::member>(instance, 8)));
    ASSERT_EQ(instance.member, 8);

    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::cmember>(instance, 8)));
    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::cmember>(invalid, 8)));
    ASSERT_EQ(instance.cmember, 0);

    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::value>(instance, instance)));
    ASSERT_TRUE((entt::meta_setter<clazz, &clazz::value>(invalid, 1)));
    ASSERT_TRUE((entt::meta_setter<clazz, &clazz::value>(instance, 2)));
    ASSERT_EQ(clazz::value, 2);

    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::cvalue>(instance, 1)));
    ASSERT_FALSE((entt::meta_setter<clazz, &clazz::cvalue>(invalid, 1)));
    ASSERT_EQ(clazz::cvalue, 0);
}

TEST_F(MetaUtility, MetaGetter) {
    const int invalid{};
    clazz instance{};

    ASSERT_FALSE((entt::meta_getter<clazz, &clazz::static_getter>(invalid)));
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::static_getter>(instance)).cast<int>(), 0);

    ASSERT_FALSE((entt::meta_getter<clazz, &clazz::getter>(invalid)));
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::getter>(instance)).cast<int>(), 0);

    ASSERT_FALSE((entt::meta_getter<clazz, &clazz::member>(invalid)));
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::member>(instance)).cast<int>(), 0);
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::member>(std::as_const(instance))).cast<int>(), 0);

    ASSERT_FALSE((entt::meta_getter<clazz, &clazz::cmember>(invalid)));
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::cmember>(instance)).cast<int>(), 0);
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::cmember>(std::as_const(instance))).cast<int>(), 0);

    ASSERT_FALSE((entt::meta_getter<clazz, &clazz::arr>(invalid)));
    ASSERT_FALSE((entt::meta_getter<clazz, &clazz::arr>(instance)));

    ASSERT_EQ((entt::meta_getter<clazz, &clazz::value>(invalid)).cast<int>(), 0);
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::value>(instance)).cast<int>(), 0);

    ASSERT_EQ((entt::meta_getter<clazz, &clazz::cvalue>(invalid)).cast<int>(), 0);
    ASSERT_EQ((entt::meta_getter<clazz, &clazz::cvalue>(instance)).cast<int>(), 0);

    ASSERT_EQ((entt::meta_getter<clazz, 1>(invalid)).cast<int>(), 1);
    ASSERT_EQ((entt::meta_getter<clazz, 1>(instance)).cast<int>(), 1);
}

TEST_F(MetaUtility, MetaInvokeWithCandidate) {
    std::array args{entt::meta_any{clazz{}}, entt::meta_any{4}};

    clazz::value = 3;

    ASSERT_FALSE((entt::meta_invoke<clazz>({}, &clazz::setter, std::next(args.data()))));
    ASSERT_FALSE((entt::meta_invoke<clazz>({}, &clazz::getter, nullptr)));

    ASSERT_TRUE((entt::meta_invoke<clazz>(args[0u], &clazz::setter, std::next(args.data()))));
    ASSERT_FALSE((entt::meta_invoke<clazz>(args[0u], &clazz::setter, args.data())));
    ASSERT_EQ((entt::meta_invoke<clazz>(args[0u], &clazz::getter, nullptr)).cast<int>(), 4);
    ASSERT_FALSE((entt::meta_invoke<clazz>(args[1u], &clazz::getter, nullptr)));

    ASSERT_EQ((entt::meta_invoke<clazz>({}, &clazz::get_value, nullptr)).cast<int>(), 3);
    ASSERT_TRUE((entt::meta_invoke<clazz>({}, &clazz::reset_value, nullptr)));
    ASSERT_EQ(args[0u].cast<clazz &>().value, 0);

    const auto setter = [](int &value) { value = 3; };
    const auto getter = [](int value) { return value * 2; };

    ASSERT_TRUE(entt::meta_invoke<test::empty>({}, setter, std::next(args.data())));
    ASSERT_EQ(entt::meta_invoke<test::empty>({}, getter, std::next(args.data())).cast<int>(), 6);
}

TEST_F(MetaUtility, MetaInvoke) {
    std::array args{entt::meta_any{clazz{}}, entt::meta_any{4}};

    clazz::value = 3;

    ASSERT_FALSE((entt::meta_invoke<clazz, &clazz::setter>({}, std::next(args.data()))));
    ASSERT_FALSE((entt::meta_invoke<clazz, &clazz::getter>({}, nullptr)));

    ASSERT_TRUE((entt::meta_invoke<clazz, &clazz::setter>(args[0u], std::next(args.data()))));
    ASSERT_FALSE((entt::meta_invoke<clazz, &clazz::setter>(args[0u], args.data())));
    ASSERT_EQ((entt::meta_invoke<clazz, &clazz::getter>(args[0u], nullptr)).cast<int>(), 4);
    ASSERT_FALSE((entt::meta_invoke<clazz, &clazz::getter>(args[1u], nullptr)));

    ASSERT_EQ((entt::meta_invoke<clazz, &clazz::get_value>({}, nullptr)).cast<int>(), 3);
    ASSERT_TRUE((entt::meta_invoke<clazz, &clazz::reset_value>({}, nullptr)));
    ASSERT_EQ(args[0u].cast<clazz &>().value, 0);
}

TEST_F(MetaUtility, MetaConstructArgsOnly) {
    std::array args{entt::meta_any{clazz{}}, entt::meta_any{4}};
    const auto any = entt::meta_construct<clazz, int>(std::next(args.data()));

    ASSERT_TRUE(any);
    ASSERT_FALSE((entt::meta_construct<clazz, int>(args.data())));
    ASSERT_EQ(any.cast<const clazz &>().member, 4);
}

TEST_F(MetaUtility, MetaConstructWithCandidate) {
    std::array args{entt::meta_any{clazz{}}, entt::meta_any{4}};
    const auto any = entt::meta_construct<clazz>(&clazz::factory, std::next(args.data()));

    ASSERT_TRUE(any);
    ASSERT_FALSE((entt::meta_construct<clazz>(&clazz::factory, args.data())));
    ASSERT_EQ(any.cast<const clazz &>().member, 4);

    ASSERT_EQ(args[0u].cast<const clazz &>().member, 0);
    ASSERT_TRUE((entt::meta_construct<clazz>(&clazz::static_setter, args.data())));
    ASSERT_EQ(args[0u].cast<const clazz &>().member, 4);

    const auto setter = [](int &value) { value = 3; };
    const auto builder = [](int value) { return value * 2; };

    ASSERT_TRUE(entt::meta_construct<test::empty>(setter, std::next(args.data())));
    ASSERT_EQ(entt::meta_construct<test::empty>(builder, std::next(args.data())).cast<int>(), 6);
}

TEST_F(MetaUtility, MetaConstruct) {
    std::array args{entt::meta_any{clazz{}}, entt::meta_any{4}};
    const auto any = entt::meta_construct<clazz, &clazz::factory>(std::next(args.data()));

    ASSERT_TRUE(any);
    ASSERT_FALSE((entt::meta_construct<clazz, &clazz::factory>(args.data())));
    ASSERT_EQ(any.cast<const clazz &>().member, 4);

    ASSERT_EQ(args[0u].cast<const clazz &>().member, 0);
    ASSERT_TRUE((entt::meta_construct<clazz, &clazz::static_setter>(args.data())));
    ASSERT_EQ(args[0u].cast<const clazz &>().member, 4);
}