ToolsProtocol.h

//
// Copyright 2014 - 2025 (C). Alex Robenko. All rights reserved.
//
 
// This file is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#pragma once
 
#include "cc_tools_qt/ToolsApi.h"
#include "cc_tools_qt/ToolsDataInfo.h"
#include "cc_tools_qt/ToolsFrame.h"
#include "cc_tools_qt/ToolsMessage.h"
 
#include <QtCore/QObject>
#include <QtCore/QMetaType>
#include <QtCore/QString>
 
#include <cstdint>
#include <cstddef>
#include <list>
#include <memory>
 
namespace cc_tools_qt
{
 
 
class CC_TOOLS_API ToolsProtocol : public QObject
{
    Q_OBJECT
public:
    using DataInfosList = std::list<ToolsDataInfoPtr>;
 
    using MsgDataSeq = ToolsMessage::DataSeq ;
 
    enum class UpdateStatus
    {
        NoChange, 
        Changed 
    };
 
    virtual ~ToolsProtocol() noexcept;
 
    const QString& name() const;
 
    ToolsMessagesList read(const ToolsDataInfo& dataInfo, bool final = false);
 
    ToolsDataInfoPtr write(ToolsMessage& msg);
 
    ToolsMessagesList createAllMessages();
 
    ToolsMessagePtr createMessage(const QString& idAsString, unsigned idx = 0);
 
    UpdateStatus updateMessage(ToolsMessage& msg);
 
    ToolsMessagePtr cloneMessage(const ToolsMessage& msg);
 
    ToolsMessagePtr createInvalidMessage(const MsgDataSeq& data);
 
    void socketConnectionReport(bool connected);   
 
    void messageReceivedReport(ToolsMessagePtr msg);
 
    void messageSentReport(ToolsMessagePtr msg);
 
    void applyInterPluginConfig(const QVariantMap& props);      
 
    void setDebugOutputLevel(unsigned level = 0U);     
 
signals:
    void sigSendMessageReport(ToolsMessagePtr msg);
 
    void sigErrorReport(const QString& str);
 
    void sigInterPluginConfigReport(const QVariantMap& props);    
 
protected:
    explicit ToolsProtocol(ToolsFramePtr frame);
 
    virtual const QString& nameImpl() const = 0;
 
    virtual void socketConnectionReportImpl(bool connected);    
 
    virtual void messageReceivedReportImpl(ToolsMessagePtr msg);
 
    virtual void messageSentReportImpl(ToolsMessagePtr msg);    
 
    virtual void applyInterPluginConfigImpl(const QVariantMap& props);      
 
    void setNameToMessageProperties(ToolsMessage& msg);
 
    void reportError(const QString& str);  
 
    void sendMessageRequest(ToolsMessagePtr msg);  
 
    void reportInterPluginConfig(const QVariantMap& props);      
 
    unsigned getDebugOutputLevel() const;    
 
    static void setTransportToMessageProperties(ToolsMessagePtr transportMsg, ToolsMessage& msg);
 
    static void setRawDataToMessageProperties(ToolsMessagePtr rawDataMsg, ToolsMessage& msg);
 
    static void setExtraInfoMsgToMessageProperties(ToolsMessagePtr extraInfoMsg, ToolsMessage& msg);
 
    static ToolsMessagePtr getExtraInfoMsgToMessageProperties(const ToolsMessage& msg);
 
    static QVariantMap getExtraInfoFromMessageProperties(const ToolsMessage& msg);
 
    static void setExtraInfoToMessageProperties(const QVariantMap& extraInfo, ToolsMessage& msg);
 
    static void mergeExtraInfoToMessageProperties(const QVariantMap& extraInfo, ToolsMessage& msg);
 
    static void setForceExtraInfoExistenceToMessageProperties(ToolsMessage& msg);
 
    static bool getForceExtraInfoExistenceFromMessageProperties(const ToolsMessage& msg);
 
private:
    struct InnerState;
    std::unique_ptr<InnerState> m_state;
};
 
using ToolsProtocolPtr = std::shared_ptr<ToolsProtocol>;
 
}  // namespace cc_tools_qt
 
Q_DECLARE_METATYPE(cc_tools_qt::ToolsProtocolPtr);