ObjectRegistry.h

浏览该文件的文档.

#pragma once
 
#include "common/Export.h"
#include "common/Result.h"
#include "common/RuntimeHandle.h"
 
#include <simplesquirrel/simplesquirrel.hpp>
 
#include <cstddef>
#include <cstdint>
#include <map>
#include <optional>
#include <string>
#include <vector>
 
namespace eve::ui {
 
struct UiObjectHandleTag {};
 
using ObjectHandle = eve::RuntimeHandle<UiObjectHandleTag>;
 
struct EVENGINE_API_WORLD_INLINE ObjectEntry {
    ObjectHandle handle = ObjectHandle::invalid();
    std::string className;
    std::string label;
    ssq::Object object;
};
 
class EVENGINE_API_WORLD ObjectRegistry {
public:
    ObjectRegistry(const ObjectRegistry&) = delete;
    ObjectRegistry& operator=(const ObjectRegistry&) = delete;
    ~ObjectRegistry();
 
    static ObjectRegistry& instance();
 
    [[nodiscard("retain ObjectHandle or explicitly inspect the failure")]]
    eve::Result<ObjectHandle> create(const std::string& className);
    [[nodiscard("retain ObjectHandle or explicitly inspect the failure")]]
    eve::Result<ObjectHandle> registerObject(const std::string& className, const ssq::Object& object,
                                             const std::string& label = {});
    [[nodiscard]] eve::Result<void> unregister(ObjectHandle handle);
    void clear(const std::string& className);
    void clearAll();
 
    std::vector<std::string> classNames() const;
    std::vector<ObjectEntry> entries(const std::string& className) const;
    [[nodiscard("inspect the borrowed entry or explicitly ignore it")]]
    const ObjectEntry* entry(ObjectHandle handle) const noexcept;
    [[nodiscard]] bool isStale(ObjectHandle handle) const noexcept;
    size_t count(const std::string& className) const;
 
private:
    struct Slot {
        std::uint32_t              generation = 1;
        bool                       retired    = false;
        std::optional<ObjectEntry> entry;
    };
 
    [[nodiscard]] Slot* slot(ObjectHandle handle) noexcept;
    [[nodiscard]] const Slot* slot(ObjectHandle handle) const noexcept;
 
    ObjectRegistry() = default;
    std::vector<Slot>                                slots_;
    std::vector<std::uint32_t>                       freeSlots_;
    std::map<std::string, std::vector<ObjectHandle>> byClass_;
};
 
}  // namespace eve::ui