entt/test/entt/meta/meta_factory.cpp

#include <array>
#include <iterator>
#include <string>
#include <utility>
#include <gtest/gtest.h>
#include <entt/core/type_info.hpp>
#include <entt/meta/context.hpp>
#include <entt/meta/factory.hpp>
#include <entt/meta/meta.hpp>
#include <entt/meta/range.hpp>
#include <entt/meta/resolve.hpp>
#include "../../common/boxed_type.h"
#include "../../common/config.h"
#include "../../common/meta_traits.h"

struct base {
    char member{};
};

struct clazz: base {
    clazz(int val)
        : value{val} {}

    [[nodiscard]] explicit operator int() const noexcept {
        return get_int();
    }

    void set_int(int val) noexcept {
        value = val;
    }

    void set_boxed_int(test::boxed_int val) noexcept {
        value = val.value;
    }

    [[nodiscard]] int get_int() const noexcept {
        return value;
    }

    [[nodiscard]] static std::string to_string(const clazz &instance) {
        return std::to_string(instance.get_int());
    }

    [[nodiscard]] static clazz from_string(const std::string &value) {
        return clazz{std::stoi(value)};
    }

private:
    int value{};
};

struct dtor_callback {
    dtor_callback(bool &ref)
        : cb{&ref} {}

    static void on_destroy(dtor_callback &instance) {
        *instance.cb = !*instance.cb;
    }

private:
    bool *cb;
};

struct MetaFactory: ::testing::Test {
    void TearDown() override {
        entt::meta_reset();
    }
};

using MetaFactoryDeathTest = MetaFactory;

TEST_F(MetaFactory, Constructors) {
    entt::meta_ctx ctx{};

    ASSERT_EQ(entt::resolve(entt::type_id<int>()), entt::meta_type{});
    ASSERT_EQ(entt::resolve(ctx, entt::type_id<int>()), entt::meta_type{});

    entt::meta_factory<int> factory{};

    ASSERT_NE(entt::resolve(entt::type_id<int>()), entt::meta_type{});
    ASSERT_EQ(entt::resolve(ctx, entt::type_id<int>()), entt::meta_type{});
    ASSERT_TRUE(entt::resolve(entt::type_id<int>()).is_integral());

    factory = entt::meta_factory<int>{ctx};

    ASSERT_NE(entt::resolve(entt::type_id<int>()), entt::meta_type{});
    ASSERT_NE(entt::resolve(ctx, entt::type_id<int>()), entt::meta_type{});
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()).is_integral());
}

TEST_F(MetaFactory, Type) {
    using namespace entt::literals;

    entt::meta_factory<int> factory{};

    ASSERT_EQ(entt::resolve("foo"_hs), entt::meta_type{});

    factory.type("foo"_hs);

    ASSERT_NE(entt::resolve("foo"_hs), entt::meta_type{});
    ASSERT_EQ(entt::resolve<int>().id(), "foo"_hs);

    factory.type("bar"_hs);

    ASSERT_EQ(entt::resolve("foo"_hs), entt::meta_type{});
    ASSERT_NE(entt::resolve("bar"_hs), entt::meta_type{});
    ASSERT_EQ(entt::resolve<int>().id(), "bar"_hs);
}

ENTT_DEBUG_TEST_F(MetaFactoryDeathTest, Type) {
    using namespace entt::literals;

    entt::meta_factory<int> factory{};
    entt::meta_factory<double> other{};

    factory.type("foo"_hs);

    ASSERT_DEATH(other.type("foo"_hs);, "");
}

TEST_F(MetaFactory, Base) {
    entt::meta_factory<clazz> factory{};
    decltype(std::declval<entt::meta_type>().base()) range{};

    ASSERT_NE(entt::resolve(entt::type_id<clazz>()), entt::meta_type{});
    ASSERT_EQ(entt::resolve(entt::type_id<base>()), entt::meta_type{});

    range = entt::resolve<clazz>().base();

    ASSERT_EQ(range.begin(), range.end());

    factory.base<base>();
    range = entt::resolve<clazz>().base();

    ASSERT_EQ(entt::resolve(entt::type_id<base>()), entt::meta_type{});
    ASSERT_NE(range.begin(), range.end());
    ASSERT_EQ(std::distance(range.begin(), range.end()), 1);
    ASSERT_EQ(range.begin()->first, entt::type_id<base>().hash());
    ASSERT_EQ(range.begin()->second.info(), entt::type_id<base>());
}

TEST_F(MetaFactory, Conv) {
    const clazz instance{3};
    entt::meta_factory<clazz> factory{};
    const entt::meta_any any = entt::forward_as_meta(instance);

    ASSERT_FALSE(any.allow_cast<int>());
    ASSERT_FALSE(any.allow_cast<std::string>());

    factory.conv<int>().conv<&clazz::to_string>();

    ASSERT_TRUE(any.allow_cast<int>());
    ASSERT_TRUE(any.allow_cast<std::string>());
    ASSERT_EQ(any.allow_cast<int>().cast<int>(), instance.get_int());
    ASSERT_EQ(any.allow_cast<std::string>().cast<std::string>(), clazz::to_string(instance));
}

TEST_F(MetaFactory, Ctor) {
    const std::array values{1, 3};
    entt::meta_factory<clazz> factory{};

    ASSERT_FALSE(entt::resolve<clazz>().construct(values[0u]));
    ASSERT_FALSE(entt::resolve<clazz>().construct(std::to_string(values[1u])));

    factory.ctor<int>().ctor<&clazz::from_string>();

    const auto instance = entt::resolve<clazz>().construct(values[0u]);
    const auto other = entt::resolve<clazz>().construct(std::to_string(values[1u]));

    ASSERT_TRUE(instance);
    ASSERT_TRUE(other);
    ASSERT_TRUE(instance.allow_cast<clazz>());
    ASSERT_TRUE(other.allow_cast<clazz>());
    ASSERT_EQ(instance.cast<const clazz &>().get_int(), values[0u]);
    ASSERT_EQ(other.cast<const clazz &>().get_int(), values[1u]);
}

TEST_F(MetaFactory, Dtor) {
    bool check = false;
    entt::meta_factory<dtor_callback> factory{};
    entt::meta_any any{std::in_place_type<dtor_callback>, check};

    any.reset();

    ASSERT_FALSE(check);

    factory.dtor<&dtor_callback::on_destroy>();
    any.emplace<dtor_callback>(check);
    any.reset();

    ASSERT_TRUE(check);
}

TEST_F(MetaFactory, DataMemberObject) {
    using namespace entt::literals;

    base instance{'c'};
    entt::meta_factory<base> factory{};
    entt::meta_type type = entt::resolve<base>();

    ASSERT_FALSE(type.data("member"_hs));

    factory.data<&base::member>("member"_hs);
    type = entt::resolve<base>();

    ASSERT_TRUE(type.data("member"_hs));
    ASSERT_EQ(type.get("member"_hs, std::as_const(instance)), instance.member);
    ASSERT_EQ(type.get("member"_hs, instance), instance.member);
    ASSERT_FALSE(type.set("member"_hs, std::as_const(instance), instance.member));
    ASSERT_TRUE(type.set("member"_hs, instance, instance.member));
}

TEST_F(MetaFactory, DataPointer) {
    using namespace entt::literals;

    entt::meta_factory<int> factory{};
    entt::meta_type type = entt::resolve<int>();

    ASSERT_FALSE(type.data("value"_hs));

    static int value = 1;
    factory.data<&value>("value"_hs);
    type = entt::resolve<int>();

    ASSERT_TRUE(type.data("value"_hs));
    ASSERT_EQ(type.get("value"_hs, {}), value);
    ASSERT_TRUE(type.set("value"_hs, {}, value));
}

TEST_F(MetaFactory, DataValue) {
    using namespace entt::literals;

    constexpr int value = 1;
    entt::meta_factory<int> factory{};
    entt::meta_type type = entt::resolve<int>();

    ASSERT_FALSE(type.data("value"_hs));

    factory.data<value>("value"_hs);
    type = entt::resolve<int>();

    ASSERT_TRUE(type.data("value"_hs));
    ASSERT_EQ(type.get("value"_hs, {}), value);
    ASSERT_FALSE(type.set("value"_hs, {}, value));
}

TEST_F(MetaFactory, DataGetterOnly) {
    using namespace entt::literals;

    clazz instance{1};
    entt::meta_factory<clazz> factory{};
    entt::meta_type type = entt::resolve<clazz>();

    ASSERT_FALSE(type.data("value"_hs));

    factory.data<nullptr, &clazz::get_int>("value"_hs);
    type = entt::resolve<clazz>();

    ASSERT_TRUE(type.data("value"_hs));
    ASSERT_EQ(type.get("value"_hs, std::as_const(instance)), instance.get_int());
    ASSERT_EQ(type.get("value"_hs, instance), instance.get_int());
    ASSERT_FALSE(type.set("value"_hs, std::as_const(instance), instance.get_int()));
    ASSERT_FALSE(type.set("value"_hs, instance, instance.get_int()));
}

TEST_F(MetaFactory, DataSetterGetter) {
    using namespace entt::literals;

    clazz instance{1};
    entt::meta_factory<clazz> factory{};
    entt::meta_type type = entt::resolve<clazz>();

    ASSERT_FALSE(type.data("value"_hs));

    factory.data<&clazz::set_int, &clazz::get_int>("value"_hs);
    type = entt::resolve<clazz>();

    ASSERT_TRUE(type.data("value"_hs));
    ASSERT_EQ(type.get("value"_hs, std::as_const(instance)), instance.get_int());
    ASSERT_EQ(type.get("value"_hs, instance), instance.get_int());
    ASSERT_FALSE(type.set("value"_hs, std::as_const(instance), instance.get_int()));
    ASSERT_TRUE(type.set("value"_hs, instance, instance.get_int()));
}

TEST_F(MetaFactory, DataOverwrite) {
    using namespace entt::literals;

    entt::meta_factory<clazz> factory{};
    entt::meta_type type = entt::resolve<clazz>();

    ASSERT_FALSE(type.data("value"_hs));

    factory.data<nullptr, &clazz::get_int>("value"_hs);
    type = entt::resolve<clazz>();

    ASSERT_TRUE(type.data("value"_hs));
    ASSERT_TRUE(type.data("value"_hs).is_const());

    factory.data<&clazz::set_int, &clazz::get_int>("value"_hs);
    type = entt::resolve<clazz>();

    ASSERT_TRUE(type.data("value"_hs));
    ASSERT_FALSE(type.data("value"_hs).is_const());
}

TEST_F(MetaFactory, Func) {
    using namespace entt::literals;

    const clazz instance{1};
    entt::meta_factory<clazz> factory{};
    entt::meta_type type = entt::resolve<clazz>();

    ASSERT_FALSE(type.func("func"_hs));

    factory.func<&clazz::get_int>("func"_hs);
    type = entt::resolve<clazz>();

    ASSERT_TRUE(type.func("func"_hs));
    ASSERT_TRUE(type.invoke("func"_hs, instance));
    ASSERT_EQ(type.invoke("func"_hs, instance).cast<int>(), instance.get_int());
    ASSERT_FALSE(type.invoke("func"_hs, {}));
}

TEST_F(MetaFactory, FuncOverload) {
    using namespace entt::literals;

    clazz instance{1};
    entt::meta_factory<clazz> factory{};
    const entt::meta_type type = entt::resolve<clazz>();

    ASSERT_FALSE(type.func("func"_hs));

    factory.func<&clazz::set_int>("func"_hs);

    ASSERT_TRUE(type.func("func"_hs));
    ASSERT_FALSE(type.func("func"_hs).next());

    factory.func<&clazz::set_boxed_int>("func"_hs);

    ASSERT_TRUE(type.func("func"_hs));
    ASSERT_TRUE(type.func("func"_hs).next());
    ASSERT_FALSE(type.func("func"_hs).next().next());

    ASSERT_TRUE(type.invoke("func"_hs, instance, 2));
    ASSERT_EQ(instance.get_int(), 2);

    ASSERT_TRUE(type.invoke("func"_hs, instance, test::boxed_int{3}));
    ASSERT_EQ(instance.get_int(), 3);
}

TEST_F(MetaFactory, Traits) {
    using namespace entt::literals;

    entt::meta_factory<clazz>{}
        .data<&base::member>("member"_hs)
        .func<&clazz::set_int>("func"_hs)
        .func<&clazz::set_boxed_int>("func"_hs);

    entt::meta_type type = entt::resolve<clazz>();

    ASSERT_EQ(type.traits<test::meta_traits>(), test::meta_traits::none);
    ASSERT_EQ(type.data("member"_hs).traits<test::meta_traits>(), test::meta_traits::none);
    ASSERT_EQ(type.func("func"_hs).traits<test::meta_traits>(), test::meta_traits::none);
    ASSERT_EQ(type.func("func"_hs).next().traits<test::meta_traits>(), test::meta_traits::none);

    entt::meta_factory<clazz>{}
        .traits(test::meta_traits::one | test::meta_traits::three)
        .data<&base::member>("member"_hs)
        .traits(test::meta_traits::one)
        .func<&clazz::set_int>("func"_hs)
        .traits(test::meta_traits::two)
        .func<&clazz::set_boxed_int>("func"_hs)
        .traits(test::meta_traits::three);

    // traits are copied and never refreshed
    type = entt::resolve<clazz>();

    ASSERT_EQ(type.traits<test::meta_traits>(), test::meta_traits::one | test::meta_traits::three);
    ASSERT_EQ(type.data("member"_hs).traits<test::meta_traits>(), test::meta_traits::one);
    ASSERT_EQ(type.func("func"_hs).traits<test::meta_traits>(), test::meta_traits::two);
    ASSERT_EQ(type.func("func"_hs).next().traits<test::meta_traits>(), test::meta_traits::three);
}

TEST_F(MetaFactory, Custom) {
    using namespace entt::literals;

    entt::meta_factory<clazz>{}
        .data<&base::member>("member"_hs)
        .func<&clazz::set_int>("func"_hs)
        .func<&clazz::set_boxed_int>("func"_hs);

    entt::meta_type type = entt::resolve<clazz>();

    ASSERT_EQ(static_cast<const int *>(type.custom()), nullptr);
    ASSERT_EQ(static_cast<const int *>(type.data("member"_hs).custom()), nullptr);
    ASSERT_EQ(static_cast<const int *>(type.func("func"_hs).custom()), nullptr);
    ASSERT_EQ(static_cast<const int *>(type.func("func"_hs).next().custom()), nullptr);

    entt::meta_factory<clazz>{}
        .custom<int>(0)
        .data<&base::member>("member"_hs)
        .custom<int>(1)
        .func<&clazz::set_int>("func"_hs)
        .custom<int>(2)
        .func<&clazz::set_boxed_int>("func"_hs)
        .custom<int>(3);

    // custom data pointers are copied and never refreshed
    type = entt::resolve<clazz>();

    ASSERT_EQ(static_cast<int>(type.custom()), 0);
    ASSERT_EQ(static_cast<int>(type.data("member"_hs).custom()), 1);
    ASSERT_EQ(static_cast<int>(type.func("func"_hs).custom()), 2);
    ASSERT_EQ(static_cast<int>(type.func("func"_hs).next().custom()), 3);
}

TEST_F(MetaFactory, Meta) {
    entt::meta_ctx ctx{};

    ASSERT_EQ(entt::resolve(entt::type_id<int>()), entt::meta_type{});
    ASSERT_EQ(entt::resolve(ctx, entt::type_id<int>()), entt::meta_type{});

    auto factory = entt::meta<int>();

    ASSERT_NE(entt::resolve(entt::type_id<int>()), entt::meta_type{});
    ASSERT_EQ(entt::resolve(ctx, entt::type_id<int>()), entt::meta_type{});
    ASSERT_TRUE(entt::resolve(entt::type_id<int>()).is_integral());

    factory = entt::meta<int>(ctx);

    ASSERT_NE(entt::resolve(entt::type_id<int>()), entt::meta_type{});
    ASSERT_NE(entt::resolve(ctx, entt::type_id<int>()), entt::meta_type{});
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()).is_integral());
}

TEST_F(MetaFactory, MetaReset) {
    using namespace entt::literals;

    entt::meta_ctx ctx{};

    entt::meta_factory<int>{}.type("global"_hs);
    entt::meta_factory<int>{ctx}.type("local"_hs);

    ASSERT_TRUE(entt::resolve(entt::type_id<int>()));
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_reset();

    ASSERT_FALSE(entt::resolve(entt::type_id<int>()));
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_reset(ctx);

    ASSERT_FALSE(entt::resolve(entt::type_id<int>()));
    ASSERT_FALSE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_factory<int>{}.type("global"_hs);
    entt::meta_factory<int>{ctx}.type("local"_hs);

    ASSERT_TRUE(entt::resolve(entt::type_id<int>()));
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_reset<int>();

    ASSERT_FALSE(entt::resolve(entt::type_id<int>()));
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_reset<int>(ctx);

    ASSERT_FALSE(entt::resolve(entt::type_id<int>()));
    ASSERT_FALSE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_factory<int>{}.type("global"_hs);
    entt::meta_factory<int>{ctx}.type("local"_hs);

    ASSERT_TRUE(entt::resolve(entt::type_id<int>()));
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_reset("global"_hs);

    ASSERT_FALSE(entt::resolve(entt::type_id<int>()));
    ASSERT_TRUE(entt::resolve(ctx, entt::type_id<int>()));

    entt::meta_reset(ctx, "local"_hs);

    ASSERT_FALSE(entt::resolve(entt::type_id<int>()));
    ASSERT_FALSE(entt::resolve(ctx, entt::type_id<int>()));
}