SimsWorld/SimsBasic/simsbasic.h

#pragma once

#include "simsbasic_global.h"
#include <QJsonObject>
#include <memory>
#include <functional>

/// <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 Serializable {
public:
	/// <summary>
	/// <summary>
	/// 提取包含默认值的实例
	/// </summary>
	/// <returns></returns>
	virtual std::shared_ptr<Serializable> newDefault() const = 0;

	/// 通过反序列化完全恢复数据
	/// </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 TopicData : public Serializable {
public:
	/// <summary>
	/// 获取消息类型字符串
	/// </summary>
	/// <returns>消息类型</returns>
	virtual QString topicString() const = 0;
};

/// <summary>
/// 特殊用途的数据
/// </summary>
class WsSpecializedData : public TopicData {
public:
	/// <summary>
	/// 内存尺寸
	/// </summary>
	/// <returns></returns>
	virtual uint32_t inMemSize() const = 0;
};

/// <summary>
/// 通用消息基类
/// </summary>
class WsMessage : public TopicData {
public:
	virtual ~WsMessage() = default;
	/// <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>
/// Request签名类型
/// </summary>
using WsRequestSignatureType = std::pair<QString, QString>;
/// <summary>
/// 所有消息处理单元通用接口
/// </summary>
using WsRespondEntry = std::function<void(std::shared_ptr<const WsMessage>, QList<std::shared_ptr<WsMessage>>&)>;

/// <summary>
/// 实体抽象接口
/// </summary>
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>
	/// <param name="t">签名</param>
	/// <returns>处理接口</returns>
	virtual QList<WsRespondEntry> getRespondWithSignature(const WsRespondSignatureType& t) const = 0;
	/// <summary>
	/// 通过输入消息类型获取处理入口
	/// </summary>
	/// <param name="msg_type">输入消息类型</param>
	/// <returns>处理接口列表</returns>
	virtual QList<WsRespondEntry> getRespondWithInType(const QString& msg_type) const = 0;
};

/// <summary>
/// 功能插件的基类
/// </summary>
class WsSpecializedSystem : public Serializable, public std::enable_shared_from_this<WsSpecializedSystem> {
public:
	/// <summary>
	/// 针对指定数据Topic
	/// </summary>
	/// <returns></returns>
	virtual QString bindDataTopic() const = 0;
	/// <summary>
	/// 插件唯一命名
	/// </summary>
	/// <returns>插件名</returns>
	virtual QString name() const = 0;

	/// <summary>
	/// 绑定Entity
	/// </summary>
	/// <param name="entity_id">实体实例</param>
	virtual void bindEntity(std::weak_ptr<WsEntity> host) = 0;
	
	/// <summary>
	/// 允许发送的消息类型签名
	/// </summary>
	/// <returns></returns>
	virtual QList<WsRequestSignatureType> requestSignatures() const = 0;

	/// <summary>
	/// 允许响应处理的消息签名类型
	/// </summary>
	/// <returns>消息签名类型集合</returns>
	virtual QList<WsRespondSignatureType> respondSignatures() const = 0;
	/// <summary>
	/// 通过指定的签名获取消息响应处理入口
	/// </summary>
	/// <param name="t">处理签名</param>
	/// <returns>处理接口</returns>
	virtual QList<WsRespondEntry> getRespondWithSignature(const WsRespondSignatureType& t) const = 0;
	/// <summary>
	/// 通过输入消息类型获取处理入口
	/// </summary>
	/// <param name="msg_type">输入消息类型</param>
	/// <returns>处理接口列表</returns>
	virtual QList<WsRespondEntry> getRespondWithInType(const QString& msg_type) const = 0;
};

/// <summary>
/// 组件管理接口
/// </summary>
class ComponentSet {
public:
	/// <summary>
	/// 为本实例添加指定类型的插件
	/// </summary>
	/// <param name="ins"></param>
	virtual void append(std::shared_ptr<WsSpecializedSystem> ins) = 0;
	/// <summary>
	/// 移除指定类型的插件实例
	/// </summary>
	/// <param name="component_type"></param>
	virtual void remove(const QString& component_type) = 0;
	/// <summary>
	/// 获取本实例内包含的所有插件实例
	/// </summary>
	/// <returns></returns>
	virtual QList<std::shared_ptr<WsSpecializedSystem>> components() const = 0;
};