Client.h

// Author: Kang Lin <kl222@126.com>

#ifndef CMANAGECONNECTER_H
#define CMANAGECONNECTER_H

#pragma once

#include <QObject>
#include <QDir>
#include <QMap>
#include <QIcon>
#include <QTranslator>
#include <QSharedPointer>

#include "PluginClient.h"
#include "Hook.h"
#include "ParameterClient.h"

#if defined(__clang__) || defined(__GNUC__)
	#define CPP_STANDARD __cplusplus
#elif defined(_MSC_VER)
	#define CPP_STANDARD _MSVC_LANG
#endif
#if CPP_STANDARD >= 199711L
	#define HAS_CPP_03 1
#endif
#if CPP_STANDARD >= 201103L
	#define HAS_CPP_11 1
#endif
#if CPP_STANDARD >= 201402L
	#define HAS_CPP_14 1
#endif
#if CPP_STANDARD >= 201703L
	#define HAS_CPP_17 1
#endif

#if HAS_CPP_11
    #include <functional>
#endif

/**
 * \~chinese \brief 管理插件和连接者
 * \~english \brief manage plugins and connecter
 * \~
 * \see   CPluginClient CConnecter
 * \ingroup CLIENT_API
 */
class CLIENT_EXPORT CClient : public QObject
{
    Q_OBJECT

public:
    explicit CClient(QObject *parent = nullptr, QString szFile = QString());
    virtual ~CClient();

    /*!
     * \~chinese
     * \brief 新建 CConnecter 指针，所有者是调用者。
     *    <b>当不在使用时，调用者必调用　DeteleConnecter()　须释放指针</b>。
     *       调用者必须连接信号 CConnecter::sigDisconnected 。
     *       释放指针 (使用 DeleteConnecter() )
     * \param id 插件 ID
     * \~english New CConnecter pointer, the owner is caller.
     *    <b>The caller must be call CConnecter::sigDisconnected() to delete it,
     *       when it isn't need</b>.
     *       The caller must connect CConnecter::sigDisconnected,
     *       then delete it(Use DeleteConnecter() )
     * \param id Plugin ID
     * \~
     * \callgraph
     * \see DeleteConnecter
     */
    virtual CConnecter* CreateConnecter(const QString &id);
    /*!
     * Delete CConnecter
     */
    virtual int DeleteConnecter(CConnecter* p);

    /*! \~chinese 从文件中新建 CConnecter 指针，所有者是调用者。
     *     <b>当不再使用时，调用者必须负责调用　DeleteConnecter() 删除此指针</b>。
     *        调用者必须连接信号 CConnecter::sigDisconnected 。
     *        释放指针(使用 DeleteConnecter() )
     * \~english New CConnecter pointer from file, the owner is caller.
     *     <b>The caller must delete it(call DeleteConnecter()),
     *        when it isn't need</b>.
     *        The caller must connect CConnecter::sigDisconnected,
     *        then delete it (Use DeleteConnecter() )
     * \~
     * \callgraph
     * \see DeleteConnecter
     */
    virtual CConnecter* LoadConnecter(const QString& szFile);

    /*! \~chinese 保存连接参数到文件
     * \~english Accept connecter parameters to file
     * \~
     * \callgraph
     */
    virtual int SaveConnecter(CConnecter* pConnecter);

    /*!
     * \~chinese 得到设置参数窗口
     * \return 设置参数窗口。此窗口的所有者为调用者。
     * \note 此窗口必须从 CParameterUI 派生。
     *       例如: CFrmParameterClient
     * 用法示例：
     * \snippet App/Client/mainwindow.cpp Get the widget that settings client parameters
     * 
     * 在 CParameterDlgSettings 的构造函数中连接信号和槽
     * \snippet App/Client/ParameterDlgSettings.cpp connect accepted to slotAccept of widget
     * 
     * \~english Get parameter settings widget
     * \return Parameter widget. The QWidget owner is caller.
     * \note The widget must be a derivative of CParameterUI.
     *         Eg: CFrmParameterClient
     *
     * \snippet Client/FrmParameterClient.h Accept parameters
     * Usage:
     * \snippet App/Client/mainwindow.cpp Get the widget that settings client parameters
     * Connect the signal(accepted) to the slot(slotAccept) in CParameterDlgSettings
     * \snippet App/Client/ParameterDlgSettings.cpp connect accepted to slotAccept of widget
     * 
     * \~
     * \see CFrmParameterClient CParameterDlgSettings
     */   
    virtual QList<QWidget*> GetSettingsWidgets(QWidget *parent);
    /*!
     * \~chinese
     * \brief 从文件中加载客户端参数
     * \param szFile: 文件名
     * \~english Load Client parameters from file.
     * \param szFile: file name
     */
    virtual int LoadSettings(const QString szFile = QString());
    /*!
     * \~chinese
     * \brief 保存客户端参数到文件
     * \param szFile：文件名
     * \~english Save Client parameters to file
     * \param szFile: file name
     */
    virtual int SaveSettings(const QString szFile = QString());

    /**
     * \~chinese
     * \brief 处理连接者。用于客户端得到连接者信号
     * 
     * \~english
     * \brief The Handle CConnecter class
     */
    class Handle{
    public:
        Handle(){}
        /**
         * \brief Process plugins
         * \param id: plugin id
         * \param pPlug: CPluginClient pointer
         */
        virtual int onProcess(const QString& id, CPluginClient* pPlug) = 0;
    };
    /*!
     * \brief Enum plugins
     */
    virtual int EnumPlugins(Handle* handle);
#if HAS_CPP_11
    /*!
     * \brief Enum plugins
     * \note It is need c++ standard 11
     */
    virtual int EnumPlugins(
            /**
             * \brief Process plugins callback function
             * \param id: plugin id
             * \param pPlug: CPluginClient pointer
             */
            std::function<int(const QString& id, CPluginClient* pPlug)> cb);
#endif

    const QString Details() const;

private:
    int LoadPlugins();
    int FindPlugins(QDir dir, QStringList filters);
    int AppendPlugin(CPluginClient* plugin);

private:
    QString m_szSettingsFile;
    QMap<QString, CPluginClient*> m_Plugins;
    qint8 m_FileVersion;
    QSharedPointer<QTranslator> m_Translator;
    CHook* m_pHook;
    CParameterClient* m_pParameterClient;
    QString m_szDetails;
};

#endif // CMANAGECONNECTER_H