Plugin.h

Go to the documentation of this file.

/***************************************************************************
               Plugin.h  -  base class of all Kwave plugins
                             -------------------
    begin                : Thu Jul 27 2000
    copyright            : (C) 2000 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef PLUGIN_H
#define PLUGIN_H

#include "config.h"

#include <QAtomicInt>
#include <QtGlobal>
#include <QList>
#include <QMutex>
#include <QObject>
#include <QString>
#include <QThread>
#include <QTimer>
#include <QVariantList>

#include <KPluginFactory>

#include "libkwave/Runnable.h"
#include "libkwave/Sample.h"
#include "libkwave/String.h"

class QProgressDialog;
class QStringList;
class QVariant;

/* forward declarations, to make clang happy */
Q_EXTERN_C Q_DECL_EXPORT const char *qt_plugin_query_metadata();
Q_EXTERN_C Q_DECL_EXPORT QT_PREPEND_NAMESPACE(QObject) *qt_plugin_instance();

#define KWAVE_PLUGIN(name,class)                               \
    K_PLUGIN_FACTORY_WITH_JSON(kwaveplugin_##name##_factory,   \
                               "kwaveplugin_"#name".json",     \
                               registerPlugin<Kwave::class>();)

namespace Kwave
{

    class ConfirmCancelProxy;
    class PluginManager;
    class SampleReader;
    class SignalManager;
    class TopWidget;
    class WorkerThread;

    class Q_DECL_EXPORT Plugin: public QObject, public Kwave::Runnable
    {
        Q_OBJECT

    public:

        Plugin(QObject *parent, const QVariantList &args);

        virtual ~Plugin() Q_DECL_OVERRIDE;

        virtual QString name() const;

        virtual QString description() const;

        virtual QString progressText();

        virtual bool canClose() const;

        bool isRunning() const;

        bool shouldStop() const { return m_stop; }

        virtual void load(QStringList &params);

        virtual void unload();

        virtual QStringList *setup(QStringList &previous_params);

        virtual int start(QStringList &params);

        virtual int stop();

        virtual void run(QStringList params);

        Kwave::PluginManager &manager() const;

        Kwave::SignalManager &signalManager();

        QWidget *parentWidget() const;

        QString signalName();

        virtual sample_index_t signalLength();

        virtual double signalRate();

        virtual const QList<unsigned int> selectedTracks();

        virtual sample_index_t selection(
            QList<unsigned int> *tracks = Q_NULLPTR,
            sample_index_t *left = Q_NULLPTR,
            sample_index_t *right = Q_NULLPTR,
            bool expand_if_empty = false);

        virtual void selectRange(sample_index_t offset, sample_index_t length);

        virtual void migrateToActiveContext();

    protected:

        friend class Kwave::PluginManager;

        int execute(QStringList &params);

        void emitCommand(const QString &command);

        void use();

        void setPluginManager(Kwave::PluginManager *new_plugin_manager);

    signals:

        void sigRunning(Kwave::Plugin *plugin);

        void sigDone(Kwave::Plugin *plugin);

        void sigClosed(Kwave::Plugin *p);

        void sigCommand(const QString &command);

        void setProgressText(const QString &text);

    public slots:

        virtual void setProgressDialogEnabled(bool enable);

        virtual void updateProgress(qreal progress);

        virtual void cancel();

        virtual void close();

        void release();

    private slots:

        void closeProgressDialog(Kwave::Plugin *);

        void updateProgressTick();

    protected:

        friend class Kwave::WorkerThread;

        virtual void run_wrapper(const QVariant &params) Q_DECL_OVERRIDE;

    private:

        Kwave::PluginManager *m_plugin_manager;

        QString m_name;

        QString m_description;

        Kwave::WorkerThread *m_thread;

        QMutex m_thread_lock;

        bool m_progress_enabled;

        QAtomicInt m_stop;

        QProgressDialog *m_progress;

        Kwave::ConfirmCancelProxy *m_confirm_cancel;

        unsigned int m_usage_count;

        QMutex m_usage_lock;

        QTimer m_progress_timer;

        qreal m_current_progress;

        QMutex m_progress_lock;

    };

}

#endif /* PLUGIN_H */

//***************************************************************************
//***************************************************************************