SimsWorld/SimsBasic/simsbasic.h

#pragma once

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

/// <summary>
/// <20><><EFBFBD><EFBFBD><EFBFBD>쳣<EFBFBD><ECB3A3><EFBFBD><EFBFBD>
/// </summary>
class SIMSBASIC_EXPORT UniException {
private:
	QString _error_store;

public:
	explicit UniException(const QString& msg);
	virtual ~UniException() = default;

	virtual QString content() const noexcept;
};

/// <summary>
/// <20><><EFBFBD><EFBFBD><EFBFBD>л<EFBFBD><D0BB><EFBFBD><EFBFBD><EFBFBD>
/// </summary>
class Serializable {
public:
	/// <summary>
	/// <summary>
	/// <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>Ĭ<EFBFBD><C4AC>ֵ<EFBFBD><D6B5>ʵ<EFBFBD><CAB5>
	/// </summary>
	/// <returns></returns>
	virtual std::shared_ptr<Serializable> newDefault() const = 0;

	/// ͨ<><CDA8><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>л<EFBFBD><D0BB><EFBFBD>ȫ<EFBFBD>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <param name="obj"><3E><><EFBFBD><EFBFBD>Json</param>
	virtual void recoveryFrom(const QJsonObject& obj) = 0;
	/// <summary>
	/// ͨ<><CDA8><EFBFBD><EFBFBD><EFBFBD>л<EFBFBD><D0BB><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <param name="obj">Ŀ<><C4BF>Json</param>
	virtual void saveTo(QJsonObject& obj) const = 0;
};

/// <summary>
/// <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
/// </summary>
class TopicData : public Serializable {
public:
	/// <summary>
	/// <20><>ȡ<EFBFBD><C8A1>Ϣ<EFBFBD><CFA2><EFBFBD><EFBFBD><EFBFBD>ַ<EFBFBD><D6B7><EFBFBD>
	/// </summary>
	/// <returns><3E><>Ϣ<EFBFBD><CFA2><EFBFBD><EFBFBD></returns>
	virtual QString topicString() const = 0;
};

/// <summary>
/// ͨ<><CDA8><EFBFBD><EFBFBD>Ϣ<EFBFBD><CFA2><EFBFBD><EFBFBD>
/// </summary>
class WsMessage : public TopicData {
public:
	virtual ~WsMessage() = default;
	/// <summary>
	/// Ŀ<><C4BF>ʵ<EFBFBD><CAB5>ID
	/// </summary>
	/// <returns>ID</returns>
	virtual uint64_t targetEntity() const = 0;
	/// <summary>
	/// <20><>Դʵ<D4B4><CAB5>ID
	/// </summary>
	/// <returns>ID</returns>
	virtual uint64_t sourceEntity() const = 0;
};

/// <summary>
/// Respondǩ<64><C7A9><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
/// </summary>
using WsRespondSignatureType = std::pair<QString, QString>;
/// <summary>
/// Requestǩ<74><C7A9><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
/// </summary>
using WsRequestSignatureType = std::pair<QString, QString>;
/// <summary>
/// <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><CFA2><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ԫͨ<D4AA>ýӿ<C3BD>
/// </summary>
using WsRespondEntry = std::function<void(std::shared_ptr<const WsMessage>, QList<std::shared_ptr<WsMessage>>&)>;

/// <summary>
/// ʵ<><CAB5><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ӿ<EFBFBD>
/// </summary>
class WsEntity : public Serializable {
public:
	virtual ~WsEntity() = default;

	/// <summary>
	/// <20><>ȡ<EFBFBD><C8A1>ʵ<EFBFBD><CAB5><EFBFBD><EFBFBD>ģ<EFBFBD><C4A3><EFBFBD><EFBFBD>
	/// </summary>
	/// <returns>ģ<><C4A3><EFBFBD><EFBFBD><EFBFBD><EFBFBD></returns>
	virtual QString templetName() const = 0;

	/// <summary>
	/// <20><>ȡ<EFBFBD><C8A1>ʵ<EFBFBD><CAB5><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ID
	/// </summary>
	/// <returns></returns>
	virtual uint64_t entityID() const = 0;
	/// <summary>
	/// <20><>ȡ<EFBFBD><C8A1>ʵ<EFBFBD><CAB5><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <returns><3E><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD></returns>
	virtual QString name() const = 0;

	/// <summary>
	/// ͨ<><CDA8>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD>ǩ<EFBFBD><C7A9><EFBFBD><EFBFBD>ȡ<EFBFBD><C8A1>Ϣ<EFBFBD><CFA2>Ӧ<EFBFBD><D3A6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <param name="t">ǩ<><C7A9></param>
	/// <returns><3E><><EFBFBD><EFBFBD><EFBFBD>ӿ<EFBFBD></returns>
	virtual QList<WsRespondEntry> getRespondWithSignature(const WsRespondSignatureType& t) const = 0;
	/// <summary>
	/// ͨ<><CDA8><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><CFA2><EFBFBD>ͻ<EFBFBD>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <param name="msg_type"><3E><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><CFA2><EFBFBD><EFBFBD></param>
	/// <returns><3E><><EFBFBD><EFBFBD><EFBFBD>ӿ<EFBFBD><D3BF>б<EFBFBD></returns>
	virtual QList<WsRespondEntry> getRespondWithInType(const QString& msg_type) const = 0;
};

/// <summary>
/// <20><><EFBFBD>ܲ<EFBFBD><DCB2><EFBFBD><EFBFBD>Ļ<EFBFBD><C4BB><EFBFBD>
/// </summary>
class WsComponent : public Serializable, public std::enable_shared_from_this<WsComponent> {
public:
	/// <summary>
	/// <20><><EFBFBD><EFBFBD>Ψһ<CEA8><D2BB><EFBFBD><EFBFBD>
	/// </summary>
	/// <returns><3E><><EFBFBD><EFBFBD><EFBFBD><EFBFBD></returns>
	virtual QString name() const = 0;

	/// <summary>
	/// <20><>¡һ<C2A1><D2BB><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͬ<EFBFBD><CDAC><EFBFBD>ݵ<EFBFBD>ʵ<EFBFBD><CAB5>
	/// </summary>
	/// <returns>ʵ<><CAB5>ָ<EFBFBD><D6B8></returns>
	virtual std::shared_ptr<WsComponent> defaultNew() const = 0;
	/// <summary>
	/// <20><><EFBFBD><EFBFBD>Entity
	/// </summary>
	/// <param name="entity_id">ʵ<><CAB5>ʵ<EFBFBD><CAB5></param>
	virtual void bindEntity(std::weak_ptr<WsEntity> host) = 0;
	
	/// <summary>
	/// <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>͵<EFBFBD><CDB5><EFBFBD>Ϣ<EFBFBD><CFA2><EFBFBD><EFBFBD>ǩ<EFBFBD><C7A9>
	/// </summary>
	/// <returns></returns>
	virtual QList<WsRequestSignatureType> requestSignatures() const = 0;

	/// <summary>
	/// <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ӧ<EFBFBD><D3A6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣǩ<CFA2><C7A9><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <returns><3E><>Ϣǩ<CFA2><C7A9><EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC><EFBFBD></returns>
	virtual QList<WsRespondSignatureType> respondSignatures() const = 0;
	/// <summary>
	/// ͨ<><CDA8>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD>ǩ<EFBFBD><C7A9><EFBFBD><EFBFBD>ȡ<EFBFBD><C8A1>Ϣ<EFBFBD><CFA2>Ӧ<EFBFBD><D3A6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <param name="t"><3E><><EFBFBD><EFBFBD>ǩ<EFBFBD><C7A9></param>
	/// <returns><3E><><EFBFBD><EFBFBD><EFBFBD>ӿ<EFBFBD></returns>
	virtual QList<WsRespondEntry> getRespondWithSignature(const WsRespondSignatureType& t) const = 0;
	/// <summary>
	/// ͨ<><CDA8><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><CFA2><EFBFBD>ͻ<EFBFBD>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	/// </summary>
	/// <param name="msg_type"><3E><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><CFA2><EFBFBD><EFBFBD></param>
	/// <returns><3E><><EFBFBD><EFBFBD><EFBFBD>ӿ<EFBFBD><D3BF>б<EFBFBD></returns>
	virtual QList<WsRespondEntry> getRespondWithInType(const QString& msg_type) const = 0;
};

/// <summary>
/// <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ӿ<EFBFBD>
/// </summary>
class ComponentSet {
public:
	/// <summary>
	/// Ϊ<><CEAA>ʵ<EFBFBD><CAB5><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD><EFBFBD>͵IJ<CDB5><C4B2><EFBFBD>
	/// </summary>
	/// <param name="ins"></param>
	virtual void append(std::shared_ptr<WsComponent> ins) = 0;
	/// <summary>
	/// <20>Ƴ<EFBFBD>ָ<EFBFBD><D6B8><EFBFBD><EFBFBD><EFBFBD>͵IJ<CDB5><C4B2><EFBFBD>ʵ<EFBFBD><CAB5>
	/// </summary>
	/// <param name="component_type"></param>
	virtual void remove(const QString& component_type) = 0;
	/// <summary>
	/// <20><>ȡ<EFBFBD><C8A1>ʵ<EFBFBD><CAB5><EFBFBD>ڰ<EFBFBD><DAB0><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>в<EFBFBD><D0B2><EFBFBD>ʵ<EFBFBD><CAB5>
	/// </summary>
	/// <returns></returns>
	virtual QList<std::shared_ptr<WsComponent>> components() const = 0;
};