ToolsPlugin.h

//
// Copyright 2014 - 2026 (C). Alex Robenko. All rights reserved.
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
// 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/ToolsFilter.h"
#include "cc_tools_qt/ToolsProtocol.h"
#include "cc_tools_qt/ToolsSocket.h"
#include "cc_tools_qt/version.h"
 
#include <QtCore/QObject>
#include <QtCore/QList>
#include <QtCore/QtPlugin>
#include <QtCore/QVariantMap>
 
#include <memory>
 
class QAction;
class QWidget;
 
namespace cc_tools_qt
{
 
class CC_TOOLS_API ToolsPlugin : public QObject
{
    Q_OBJECT
public:
 
    enum Type : unsigned
    {
        Type_Socket, 
        Type_Filter, 
        Type_Protocol, 
        Type_NumOfValues 
    };
 
    using ListOfGuiActions = QList<QAction*>;
 
    explicit ToolsPlugin(Type type);
 
    virtual ~ToolsPlugin() noexcept;
 
    Type type() const;
 
    void getCurrentConfig(QVariantMap& config);
 
    QVariantMap getCurrentConfig();
 
    void reconfigure(const QVariantMap& config);
 
    ToolsSocketPtr createSocket();
 
    ToolsFilterPtr createFilter();
 
    ToolsProtocolPtr createProtocol();
 
    QWidget* createConfigurationWidget();
 
    ListOfGuiActions createGuiActions();
 
    void applyInterPluginConfig(const QVariantMap& props);
 
    void setDebugOutputLevel(unsigned level = 0U);
 
signals:
    void sigInterPluginConfigReport(const QVariantMap& props);
 
protected:
    virtual void getCurrentConfigImpl(QVariantMap& config);
 
    virtual void reconfigureImpl(const QVariantMap& config);
 
    virtual void applyInterPluginConfigImpl(const QVariantMap& props);
 
    virtual ToolsSocketPtr createSocketImpl();
 
    virtual ToolsFilterPtr createFilterImpl();
 
    virtual ToolsProtocolPtr createProtocolImpl();
 
    virtual QWidget* createConfigurationWidgetImpl();
 
    virtual ListOfGuiActions createGuiActionsImpl();
 
protected slots:
    void reportInterPluginConfig(const QVariantMap& props);
 
private:
    struct InnerState;
    std::unique_ptr<InnerState> m_state;
};
 
}  // namespace cc_tools_qt
 
Q_DECLARE_INTERFACE(cc_tools_qt::ToolsPlugin, "cc.ToolsPlugin")