Protocol.h

//
// Copyright 2014 - 2024 (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 <memory>
#include <cstdint>
#include <cstddef>
#include <list>
 
#include <QtCore/QMetaType>
#include <QtCore/QString>
 
#include "Api.h"
#include "Message.h"
#include "ErrorStatus.h"
#include "DataInfo.h"
 
namespace cc_tools_qt
{
 
 
class CC_API Protocol
{
public:
    using MessagesList = std::list<MessagePtr>;
 
    using DataInfosList = std::list<DataInfoPtr>;
 
    using MsgDataSeq = Message::DataSeq ;
 
    enum class UpdateStatus
    {
        NoChange, 
        Changed 
    };
 
    virtual ~Protocol() noexcept;
 
    const QString& name() const;
 
    MessagesList read(const DataInfo& dataInfo, bool final = false);
 
    DataInfoPtr write(Message& msg);
 
    MessagesList createAllMessages();
 
    MessagePtr createMessage(const QString& idAsString, unsigned idx = 0);
 
    UpdateStatus updateMessage(Message& msg);
 
    MessagePtr cloneMessage(const Message& msg);
 
    MessagePtr createInvalidMessage(const MsgDataSeq& data);
 
    void socketConnectionReport(bool connected);   
 
    void messageReceivedReport(MessagePtr msg);
 
    void messageSentReport(MessagePtr msg);
 
    void applyInterPluginConfig(const QVariantMap& props);      
 
    void setDebugOutputLevel(unsigned level = 0U);     
 
    using ErrorReportCallback = std::function<void (const QString& msg)>;
 
    template <typename TFunc>
    void setErrorReportCallback(TFunc&& func)
    {
        m_errorReportCallback = std::forward<TFunc>(func);
    }     
 
    using SendMessageRequestCallback = std::function<void (MessagePtr)>;
 
    template <typename TFunc>
    void setSendMessageRequestCallback(TFunc&& func)
    {
        m_sendMessageRequestCallback = std::forward<TFunc>(func);
    }
 
    using InterPluginConfigReportCallback = std::function <void (const QVariantMap&)>;
 
    template <typename TFunc>
    void setInterPluginConfigReportCallback(TFunc&& func)
    {
        m_interPluginConfigReportCallback = std::forward<TFunc>(func);
    }    
 
protected:
    virtual const QString& nameImpl() const = 0;
 
    virtual MessagesList readImpl(const DataInfo& dataInfo, bool final) = 0;
 
    virtual DataInfoPtr writeImpl(Message& msg) = 0;
 
    virtual MessagesList createAllMessagesImpl() = 0;
 
    virtual MessagePtr createMessageImpl(const QString& idAsString, unsigned idx) = 0;
 
    virtual UpdateStatus updateMessageImpl(Message& msg) = 0;
 
    virtual MessagePtr cloneMessageImpl(const Message& msg) = 0;
 
    virtual MessagePtr createInvalidMessageImpl() = 0;
 
    virtual MessagePtr createRawDataMessageImpl() = 0;
 
    virtual MessagePtr createExtraInfoMessageImpl() = 0;
 
    virtual void socketConnectionReportImpl(bool connected);    
 
    virtual void messageReceivedReportImpl(MessagePtr msg);
 
    virtual void messageSentReportImpl(MessagePtr msg);    
 
    virtual void applyInterPluginConfigImpl(const QVariantMap& props);      
 
    void setNameToMessageProperties(Message& msg);
 
    void reportError(const QString& str);  
 
    void sendMessageRequest(MessagePtr msg);  
 
    void reportInterPluginConfig(const QVariantMap& props);      
 
    unsigned getDebugOutputLevel() const;    
 
    static void setTransportToMessageProperties(MessagePtr transportMsg, Message& msg);
 
    static void setRawDataToMessageProperties(MessagePtr rawDataMsg, Message& msg);
 
    static void setExtraInfoMsgToMessageProperties(MessagePtr extraInfoMsg, Message& msg);
 
    static MessagePtr getExtraInfoMsgToMessageProperties(const Message& msg);
 
    static QVariantMap getExtraInfoFromMessageProperties(const Message& msg);
 
    static void setExtraInfoToMessageProperties(const QVariantMap& extraInfo, Message& msg);
 
    static void mergeExtraInfoToMessageProperties(const QVariantMap& extraInfo, Message& msg);
 
    static void setForceExtraInfoExistenceToMessageProperties(Message& msg);
 
    static bool getForceExtraInfoExistenceFromMessageProperties(const Message& msg);
 
private:
    ErrorReportCallback m_errorReportCallback;
    SendMessageRequestCallback m_sendMessageRequestCallback;
    InterPluginConfigReportCallback m_interPluginConfigReportCallback;
    unsigned m_debugLevel = 0U;
};
 
using ProtocolPtr = std::shared_ptr<Protocol>;
 
}  // namespace cc_tools_qt
 
Q_DECLARE_METATYPE(cc_tools_qt::ProtocolPtr);