SimsWorld/SimsBasic/simsbasic.h

316 lines
8.4 KiB
C++

#pragma once
#include "simsbasic_global.h"
#include <QJsonObject>
#include <memory>
#include <functional>
/// <summary>
/// 可序列化对象
/// </summary>
class Serializable {
public:
virtual ~Serializable() = default;
/// <summary>
/// 通过反序列化完全恢复数据
/// </summary>
/// <param name="obj">数据Json</param>
virtual void recoveryFrom(const QJsonObject& obj) = 0;
/// <summary>
/// 通过序列化输出所有数据
/// </summary>
/// <param name="obj">目标Json</param>
virtual void saveTo(QJsonObject& obj) const = 0;
};
/// <summary>
/// 所有异常基类
/// </summary>
class SIMSBASIC_EXPORT UniException {
private:
QString _error_store;
public:
explicit UniException(const QString& msg);
virtual ~UniException() = default;
virtual QString content() const noexcept;
};
/// <summary>
/// 通用消息基类
/// </summary>
class WsMessage : public Serializable {
public:
virtual ~WsMessage() = default;
/// <summary>
/// 获取消息类型字符串
/// </summary>
/// <returns>消息类型</returns>
virtual QString topicString() const = 0;
/// <summary>
/// 目标实体ID
/// </summary>
/// <returns>ID</returns>
virtual uint64_t targetEntity() const = 0;
/// <summary>
/// 来源实体ID
/// </summary>
/// <returns>ID</returns>
virtual uint64_t sourceEntity() const = 0;
};
/// <summary>
/// Respond签名类型
/// </summary>
using WsRespondSignatureType = std::pair<QString, QString>;
/// <summary>
/// 实体内立即执行入口
/// </summary>
class ImmediateMap {
public:
virtual ~ImmediateMap() = default;
/// <summary>
/// 获取实体管理器id
/// </summary>
/// <returns></returns>
virtual uint64_t entityManagerID() const = 0;
/// <summary>
/// 实体内指定类型的调用立即执行
/// </summary>
/// <param name="in"></param>
/// <returns></returns>
virtual QList<std::shared_ptr<WsMessage>> execute(const WsRespondSignatureType& resp_signature, std::shared_ptr<const WsMessage> in) = 0;
/// <summary>
/// 实体内兼容调用立即执行
/// </summary>
/// <param name="in"></param>
/// <returns></returns>
virtual QList<std::shared_ptr<WsMessage>> execute(std::shared_ptr<const WsMessage> in) = 0;
};
/// <summary>
/// 所有消息处理单元通用接口
/// </summary>
using WsRespondEntry = std::function<void(std::shared_ptr<ImmediateMap> map, std::shared_ptr<const WsMessage>, QList<std::shared_ptr<WsMessage>>&)>;
/// <summary>
/// 功能插件的基类
/// </summary>
class WsComponent : public Serializable, public std::enable_shared_from_this<WsComponent> {
public:
virtual ~WsComponent() = default;
/// <summary>
/// 克隆一个具有相同数据的实例
/// </summary>
/// <returns>实例指针</returns>
virtual std::shared_ptr<WsComponent> defaultNew() const = 0;
/// <summary>
/// 绑定Entity
/// </summary>
/// <param name="entity_id">EntityID</param>
virtual void bindEntity(uint64_t entity_id) = 0;
/// <summary>
/// 插件唯一命名
/// </summary>
/// <returns>插件名</returns>
virtual QString name() const = 0;
/// <summary>
/// 允许输入的消息类型
/// </summary>
/// <returns>消息类型集合</returns>
virtual QList<QString> inputTypes() const = 0;
/// <summary>
/// 通过指定的签名获取处理入口
/// </summary>
/// <param name="t">处理签名</param>
/// <returns>处理接口</returns>
virtual QList<WsRespondEntry> getEntryWithSignature(const WsRespondSignatureType& t) const = 0;
/// <summary>
/// 通过输入消息类型获取处理入口
/// </summary>
/// <param name="msg_type">输入消息类型</param>
/// <returns>处理接口列表</returns>
virtual QList<WsRespondEntry> getEntrysWithInType(const QString& msg_type) const = 0;
};
class WsEntity : public Serializable {
public:
virtual ~WsEntity() = default;
/// <summary>
/// 获取本实例的模板名
/// </summary>
/// <returns>模板名称</returns>
virtual QString templetName() const = 0;
/// <summary>
/// 获取本实例的运行ID
/// </summary>
/// <returns></returns>
virtual uint64_t entityID() const = 0;
/// <summary>
/// 获取本实例的运行名称
/// </summary>
/// <returns>运行名称</returns>
virtual QString name() const = 0;
/// <summary>
/// 深度克隆本实例,插件和数据一致
/// </summary>
/// <returns></returns>
virtual std::shared_ptr<WsEntity> defaultNew() const = 0;
/// <summary>
/// 通过指定的签名获取处理入口
/// </summary>
/// <param name="t">签名</param>
/// <returns>处理接口</returns>
virtual QList<WsRespondEntry> getEntryWithSignature(const WsRespondSignatureType& t) const = 0;
/// <summary>
/// 通过输入消息类型获取处理入口
/// </summary>
/// <param name="msg_type">输入消息类型</param>
/// <returns>处理接口列表</returns>
virtual QList<WsRespondEntry> getEntryWithInType(const QString& msg_type) const = 0;
};
#include <QHash>
/// <summary>
/// 内存实体实例类型
/// </summary>
class SIMSBASIC_EXPORT RtEntity : public WsEntity, public std::enable_shared_from_this<RtEntity> {
private:
uint64_t _entity_id = 0;
QString _templet_name, _runtime_name;
QHash<QString, std::shared_ptr<WsComponent>> _comps_list;
public:
explicit RtEntity();
virtual ~RtEntity() = default;
/// <summary>
/// 重置本实例模板名
/// </summary>
/// <param name="name">模板名称</param>
virtual void resetTemplet(const QString& name);
/// <summary>
/// 获取本实例的模板名
/// </summary>
/// <returns>模板名称</returns>
virtual QString templetName() const;
/// <summary>
/// 重置本实例的运行ID
/// </summary>
/// <param name="id"></param>
virtual void resetID(uint64_t id);
/// <summary>
/// 获取本实例的运行ID
/// </summary>
/// <returns></returns>
virtual uint64_t entityID() const;
/// <summary>
/// 重置本实例的运行名称
/// </summary>
/// <param name="name"></param>
virtual void resetName(const QString& name);
/// <summary>
/// 获取本实例的运行名称
/// </summary>
/// <returns>运行名称</returns>
virtual QString name() const;
/// <summary>
/// 为本实例添加指定类型的插件
/// </summary>
/// <param name="ins"></param>
virtual void append(std::shared_ptr<WsComponent> ins);
/// <summary>
/// 移除指定类型的插件实例
/// </summary>
/// <param name="component_type"></param>
virtual void remove(const QString& component_type);
/// <summary>
/// 获取本实例内包含的所有插件实例
/// </summary>
/// <returns></returns>
virtual QList<std::shared_ptr<WsComponent>> components() const;
/// <summary>
/// 深度克隆本实例,插件和数据一致
/// </summary>
/// <returns></returns>
virtual std::shared_ptr<WsEntity> defaultNew() const;
/// <summary>
/// 允许输入的消息类型
/// </summary>
/// <returns>消息类型集合</returns>
virtual QList<QString> inputTypes() const;
/// <summary>
/// 通过指定的签名获取处理入口
/// </summary>
/// <param name="t">签名</param>
/// <returns>处理接口</returns>
virtual QList<WsRespondEntry> getEntryWithSignature(const WsRespondSignatureType& t) const;
/// <summary>
/// 通过输入消息类型获取处理入口
/// </summary>
/// <param name="msg_type">输入消息类型</param>
/// <returns>处理接口列表</returns>
virtual QList<WsRespondEntry> getEntryWithInType(const QString& msg_type) const;
// 通过 Serializable 继承
void recoveryFrom(const QJsonObject& obj) override;
void saveTo(QJsonObject& obj) const override;
};
class SIMSBASIC_EXPORT EntitiesManager : public WsEntity {
public:
static const uint64_t const_id = 0x01ff;
QHash<QString, std::shared_ptr<WsComponent>> _comps_list;
QString templetName() const override;
uint64_t entityID() const override;
QString name() const override;
void append(std::shared_ptr<WsComponent> ins);
std::shared_ptr<WsEntity> defaultNew() const override;
QList<WsRespondEntry> getEntryWithSignature(const WsRespondSignatureType& t) const override;
QList<WsRespondEntry> getEntryWithInType(const QString& msg_type) const override;
void recoveryFrom(const QJsonObject& obj) override;
void saveTo(QJsonObject& obj) const override;
};
class SIMSBASIC_EXPORT ImmediateCore : public ImmediateMap, public std::enable_shared_from_this<ImmediateCore> {
private:
std::shared_ptr<WsEntity> _bind_entity = nullptr;
public:
ImmediateCore(std::shared_ptr<WsEntity> bind);
/// <summary>
/// 获取实体管理器id
/// </summary>
/// <returns></returns>
virtual uint64_t entityManagerID() const override;
/// <summary>
/// 实体内指定类型的调用立即执行
/// </summary>
/// <param name="in"></param>
/// <returns></returns>
virtual QList<std::shared_ptr<WsMessage>> execute(const WsRespondSignatureType& resp_signature, std::shared_ptr<const WsMessage> in) override;
/// <summary>
/// 实体内兼容调用立即执行
/// </summary>
/// <param name="in"></param>
/// <returns></returns>
virtual QList<std::shared_ptr<WsMessage>> execute(std::shared_ptr<const WsMessage> in) override;
};