mixin.hpp

#ifndef ENTT_ENTITY_MIXIN_HPP
#define ENTT_ENTITY_MIXIN_HPP
 
#include "../config/config.h"
#include "../core/any.hpp"
#include "../core/type_info.hpp"
#include "../signal/sigh.hpp"
#include "../stl/concepts.hpp"
#include "../stl/iterator.hpp"
#include "../stl/type_traits.hpp"
#include "../stl/utility.hpp"
#include "../stl/vector.hpp"
#include "entity.hpp"
#include "fwd.hpp"
 
namespace entt {

namespace internal {
 
template<typename, typename>
struct has_on_construct final: stl::false_type {};
 
template<typename Type, typename Registry>
requires stl::invocable<decltype(&Type::on_construct), Registry &, typename Registry::entity_type>
struct has_on_construct<Type, Registry>: stl::true_type {};
 
template<typename, typename>
struct has_on_update final: stl::false_type {};
 
template<typename Type, typename Registry>
requires stl::invocable<decltype(&Type::on_update), Registry &, typename Registry::entity_type>
struct has_on_update<Type, Registry>: stl::true_type {};
 
template<typename, typename>
struct has_on_destroy final: stl::false_type {};
 
template<typename Type, typename Registry>
requires stl::invocable<decltype(&Type::on_destroy), Registry &, typename Registry::entity_type>
struct has_on_destroy<Type, Registry>: stl::true_type {};
 
} // namespace internal

template<typename Type, typename Registry>
class basic_sigh_mixin final: public Type {
    using underlying_type = Type;
    using owner_type = Registry;
 
    using basic_registry_type = basic_registry<typename owner_type::entity_type, typename owner_type::allocator_type>;
    using sigh_type = sigh<void(owner_type &, const typename underlying_type::entity_type), typename underlying_type::allocator_type>;
    using underlying_iterator = underlying_type::base_type::basic_iterator;
 
    static_assert(stl::is_base_of_v<basic_registry_type, owner_type>, "Invalid registry type");
 
    [[nodiscard]] auto &owner_or_assert() const noexcept {
        ENTT_ASSERT(owner != nullptr, "Invalid pointer to registry");
        return static_cast<owner_type &>(*owner);
    }
 
private:
    void pop(underlying_iterator first, underlying_iterator last) final {
        if(auto &reg = owner_or_assert(); destruction.empty()) {
            underlying_type::pop(first, last);
        } else {
            for(; first != last; ++first) {
                const auto entt = *first;
                destruction.publish(reg, entt);
                const auto it = underlying_type::find(entt);
                underlying_type::pop(it, it + 1u);
            }
        }
    }
 
    void pop_all() final {
        if(auto &reg = owner_or_assert(); !destruction.empty()) {
            if constexpr(stl::is_same_v<typename underlying_type::element_type, entity_type>) {
                for(typename underlying_type::size_type pos{}, last = underlying_type::free_list(); pos < last; ++pos) {
                    destruction.publish(reg, underlying_type::base_type::operator[](pos));
                }
            } else {
                for(auto entt: static_cast<underlying_type::base_type &>(*this)) {
                    if constexpr(underlying_type::storage_policy == deletion_policy::in_place) {
                        if(entt != tombstone) {
                            destruction.publish(reg, entt);
                        }
                    } else {
                        destruction.publish(reg, entt);
                    }
                }
            }
        }
 
        underlying_type::pop_all();
    }
 
    underlying_iterator try_emplace(const underlying_type::entity_type entt, const bool force_back, const void *value) final {
        const auto it = underlying_type::try_emplace(entt, force_back, value);
 
        if(auto &reg = owner_or_assert(); it != underlying_type::base_type::end()) {
            construction.publish(reg, *it);
        }
 
        return it;
    }
 
    void bind_any(any value) noexcept final {
        owner = any_cast<basic_registry_type>(&value);
 
        if constexpr(!stl::is_same_v<registry_type, basic_registry_type>) {
            if(owner == nullptr) {
                owner = any_cast<registry_type>(&value);
            }
        }
 
        underlying_type::bind_any(stl::move(value));
    }
 
public:
    using allocator_type = underlying_type::allocator_type;
    using entity_type = underlying_type::entity_type;
    using registry_type = owner_type;

    basic_sigh_mixin()
        : basic_sigh_mixin{allocator_type{}} {}

    explicit basic_sigh_mixin(const allocator_type &allocator)
        : underlying_type{allocator},
          owner{},
          construction{allocator},
          destruction{allocator},
          update{allocator} {
        if constexpr(internal::has_on_construct<typename underlying_type::element_type, Registry>::value) {
            sink{construction}.template connect<&underlying_type::element_type::on_construct>();
        }
 
        if constexpr(internal::has_on_update<typename underlying_type::element_type, Registry>::value) {
            sink{update}.template connect<&underlying_type::element_type::on_update>();
        }
 
        if constexpr(internal::has_on_destroy<typename underlying_type::element_type, Registry>::value) {
            sink{destruction}.template connect<&underlying_type::element_type::on_destroy>();
        }
    }

    basic_sigh_mixin(const basic_sigh_mixin &) = delete;

    basic_sigh_mixin(basic_sigh_mixin &&other) noexcept
        : underlying_type{static_cast<underlying_type &&>(other)},
          owner{other.owner},
          construction{stl::move(other.construction)},
          destruction{stl::move(other.destruction)},
          update{stl::move(other.update)} {}

    basic_sigh_mixin(basic_sigh_mixin &&other, const allocator_type &allocator)
        : underlying_type{static_cast<underlying_type &&>(other), allocator},
          owner{other.owner},
          construction{stl::move(other.construction), allocator},
          destruction{stl::move(other.destruction), allocator},
          update{stl::move(other.update), allocator} {}

    ~basic_sigh_mixin() override = default;

    basic_sigh_mixin &operator=(const basic_sigh_mixin &) = delete;

    basic_sigh_mixin &operator=(basic_sigh_mixin &&other) noexcept {
        swap(other);
        return *this;
    }

    void swap(basic_sigh_mixin &other) noexcept {
        using stl::swap;
        swap(owner, other.owner);
        swap(construction, other.construction);
        swap(destruction, other.destruction);
        swap(update, other.update);
        underlying_type::swap(other);
    }

    [[nodiscard]] auto on_construct() noexcept {
        return sink{construction};
    }

    [[nodiscard]] auto on_update() noexcept {
        return sink{update};
    }

    [[nodiscard]] auto on_destroy() noexcept {
        return sink{destruction};
    }

    [[nodiscard]] explicit operator bool() const noexcept {
        return (owner != nullptr);
    }

    [[nodiscard]] const registry_type &registry() const noexcept {
        return owner_or_assert();
    }

    [[nodiscard]] registry_type &registry() noexcept {
        return owner_or_assert();
    }

    auto generate() {
        const auto entt = underlying_type::generate();
        construction.publish(owner_or_assert(), entt);
        return entt;
    }

    entity_type generate(const entity_type hint) {
        const auto entt = underlying_type::generate(hint);
        construction.publish(owner_or_assert(), entt);
        return entt;
    }

    template<stl::output_iterator<entity_type> It>
    void generate(It first, It last) {
        underlying_type::generate(first, last);
 
        if(auto &reg = owner_or_assert(); !construction.empty()) {
            for(; first != last; ++first) {
                construction.publish(reg, *first);
            }
        }
    }

    template<typename... Args>
    decltype(auto) emplace(const entity_type entt, Args &&...args) {
        underlying_type::emplace(entt, stl::forward<Args>(args)...);
        construction.publish(owner_or_assert(), entt);
        return this->get(entt);
    }

    template<typename... Func>
    decltype(auto) patch(const entity_type entt, Func &&...func) {
        underlying_type::patch(entt, stl::forward<Func>(func)...);
        update.publish(owner_or_assert(), entt);
        return this->get(entt);
    }

    template<typename... Args>
    void insert(stl::input_iterator auto first, stl::input_iterator auto last, Args &&...args) {
        auto from = underlying_type::size();
        underlying_type::insert(first, last, stl::forward<Args>(args)...);
 
        if(auto &reg = owner_or_assert(); !construction.empty()) {
            // fine as long as insert passes force_back true to try_emplace
            for(const auto to = underlying_type::size(); from != to; ++from) {
                construction.publish(reg, underlying_type::operator[](from));
            }
        }
    }
 
private:
    basic_registry_type *owner;
    sigh_type construction;
    sigh_type destruction;
    sigh_type update;
};

template<typename Type, typename Registry>
class basic_reactive_mixin final: public Type {
    using underlying_type = Type;
    using owner_type = Registry;
 
    using alloc_traits = stl::allocator_traits<typename underlying_type::allocator_type>;
    using basic_registry_type = basic_registry<typename owner_type::entity_type, typename owner_type::allocator_type>;
    using container_type = stl::vector<connection, typename alloc_traits::template rebind_alloc<connection>>;
 
    static_assert(stl::is_base_of_v<basic_registry_type, owner_type>, "Invalid registry type");
 
    [[nodiscard]] auto &owner_or_assert() const noexcept {
        ENTT_ASSERT(owner != nullptr, "Invalid pointer to registry");
        return static_cast<owner_type &>(*owner);
    }
 
    void emplace_element(const Registry &, underlying_type::entity_type entity) {
        if(!underlying_type::contains(entity)) {
            underlying_type::emplace(entity);
        }
    }
 
private:
    void bind_any(any value) noexcept final {
        owner = any_cast<basic_registry_type>(&value);
 
        if constexpr(!stl::is_same_v<registry_type, basic_registry_type>) {
            if(owner == nullptr) {
                owner = any_cast<registry_type>(&value);
            }
        }
 
        underlying_type::bind_any(stl::move(value));
    }
 
public:
    using allocator_type = underlying_type::allocator_type;
    using entity_type = underlying_type::entity_type;
    using registry_type = owner_type;

    basic_reactive_mixin()
        : basic_reactive_mixin{allocator_type{}} {}

    explicit basic_reactive_mixin(const allocator_type &allocator)
        : underlying_type{allocator},
          owner{},
          conn{allocator} {
    }

    basic_reactive_mixin(const basic_reactive_mixin &) = delete;

    basic_reactive_mixin(basic_reactive_mixin &&other) noexcept
        : underlying_type{static_cast<underlying_type &&>(other)},
          owner{other.owner},
          conn{stl::move(other.conn)} {
    }

    basic_reactive_mixin(basic_reactive_mixin &&other, const allocator_type &allocator)
        : underlying_type{static_cast<underlying_type &&>(other), allocator},
          owner{other.owner},
          conn{stl::move(other.conn), allocator} {
    }

    ~basic_reactive_mixin() override = default;

    basic_reactive_mixin &operator=(const basic_reactive_mixin &) = delete;

    basic_reactive_mixin &operator=(basic_reactive_mixin &&other) noexcept {
        underlying_type::swap(other);
        return *this;
    }

    template<typename Clazz, auto Candidate = &basic_reactive_mixin::emplace_element>
    basic_reactive_mixin &on_construct(const id_type id = type_hash<Clazz>::value()) {
        auto curr = owner_or_assert().template storage<Clazz>(id).on_construct().template connect<Candidate>(*this);
        conn.push_back(stl::move(curr));
        return *this;
    }

    template<typename Clazz, auto Candidate = &basic_reactive_mixin::emplace_element>
    basic_reactive_mixin &on_update(const id_type id = type_hash<Clazz>::value()) {
        auto curr = owner_or_assert().template storage<Clazz>(id).on_update().template connect<Candidate>(*this);
        conn.push_back(stl::move(curr));
        return *this;
    }

    template<typename Clazz, auto Candidate = &basic_reactive_mixin::emplace_element>
    basic_reactive_mixin &on_destroy(const id_type id = type_hash<Clazz>::value()) {
        auto curr = owner_or_assert().template storage<Clazz>(id).on_destroy().template connect<Candidate>(*this);
        conn.push_back(stl::move(curr));
        return *this;
    }

    [[nodiscard]] explicit operator bool() const noexcept {
        return (owner != nullptr);
    }

    [[nodiscard]] const registry_type &registry() const noexcept {
        return owner_or_assert();
    }

    [[nodiscard]] registry_type &registry() noexcept {
        return owner_or_assert();
    }

    template<typename... Get, typename... Exclude>
    [[nodiscard]] basic_view<get_t<const basic_reactive_mixin, typename basic_registry_type::template storage_for_type<const Get>...>, exclude_t<typename basic_registry_type::template storage_for_type<const Exclude>...>>
    view(exclude_t<Exclude...> = exclude_t{}) const {
        const owner_type &parent = owner_or_assert();
        basic_view<get_t<const basic_reactive_mixin, typename basic_registry_type::template storage_for_type<const Get>...>, exclude_t<typename basic_registry_type::template storage_for_type<const Exclude>...>> elem{};
        [&elem](const auto *...curr) { ((curr ? elem.storage(*curr) : void()), ...); }(parent.template storage<stl::remove_const_t<Exclude>>()..., parent.template storage<stl::remove_const_t<Get>>()..., this);
        return elem;
    }

    template<typename... Get, typename... Exclude>
    [[nodiscard]] basic_view<get_t<const basic_reactive_mixin, typename basic_registry_type::template storage_for_type<Get>...>, exclude_t<typename basic_registry_type::template storage_for_type<Exclude>...>>
    view(exclude_t<Exclude...> = exclude_t{}) {
        stl::conditional_t<((stl::is_const_v<Get> && ...) && (stl::is_const_v<Exclude> && ...)), const owner_type, owner_type> &parent = owner_or_assert();
        return {*this, parent.template storage<stl::remove_const_t<Get>>()..., parent.template storage<stl::remove_const_t<Exclude>>()...};
    }

    void reset() {
        for(auto &&curr: conn) {
            curr.release();
        }
 
        conn.clear();
    }
 
private:
    basic_registry_type *owner;
    container_type conn;
};
 
} // namespace entt
 
#endif