Plugin.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 <string>
#include <cassert>
#include <memory>
 
#include <QtCore/QObject>
#include <QtCore/QtPlugin>
#include <QtCore/QVariantMap>
#include <QtWidgets/QWidget>
 
#include "Api.h"
#include "PluginProperties.h"
 
namespace cc_tools_qt
{
 
class CC_API Plugin : public QObject
{
public:
    using WidgetPtr = std::unique_ptr<QWidget>;
 
    using ListOfFilters = PluginProperties::ListOfFilters;
 
    using ListOfGuiActions = PluginProperties::ListOfGuiActions;
 
    Plugin();
 
    virtual ~Plugin() noexcept;
 
    void getCurrentConfig(QVariantMap& config);
 
    QVariantMap getCurrentConfig();
 
    void reconfigure(const QVariantMap& config);
 
    SocketPtr createSocket() const;
 
    ListOfFilters createFilters() const;
 
    ProtocolPtr createProtocol() const;
 
    ListOfGuiActions createGuiActions() const;
 
    QWidget* createConfiguarionWidget() const;
 
    QVariant getCustomProperty(const QString& name);
 
    void applyInterPluginConfig(const QVariantMap& props);  
        
    using InterPluginConfigReportCallback = std::function <void (const QVariantMap&)>;
 
    void setInterPluginConfigReportCallback(InterPluginConfigReportCallback&& func);
 
    void setDebugOutputLevel(unsigned level = 0U);
 
protected:
    virtual void getCurrentConfigImpl(QVariantMap& config);
 
    virtual void reconfigureImpl(const QVariantMap& config);
 
    virtual void applyInterPluginConfigImpl(const QVariantMap& props);       
 
    PluginProperties& pluginProperties();
 
    void reportInterPluginConfig(const QVariantMap& props);       
 
private:
    PluginProperties m_props;
    InterPluginConfigReportCallback m_interPluginConfigReportCallback;
    unsigned m_debugOutputLevel = 0U;
};
 
}  // namespace cc_tools_qt
 
Q_DECLARE_INTERFACE(cc_tools_qt::Plugin, "cc.Plugin")