dynamicthread.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-04-13
 * Description : Dynamically active thread
 *
 * Copyright (C) 2010-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot 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, 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DYNAMIC_THREAD_H
#define DIGIKAM_DYNAMIC_THREAD_H
 
// Qt includes
 
#include <QObject>
#include <QThread>
#include <QRunnable>
#include <QMutex>
#include <QMutexLocker>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DynamicThread : public QObject
{
    Q_OBJECT
 
public:
 
    enum State
    {
        Inactive,
        Scheduled,
        Running,
        Deactivating
    };
 
public:
 
    explicit DynamicThread(QObject* const parent = nullptr);
 
    ~DynamicThread() override;
 
    virtual void run() = 0;
 
    State state()               const;
    bool  isRunning()           const;
    bool  isFinished()          const;
 
    void setEmitSignals(bool emitThem);
 
    void setPriority(QThread::Priority priority);
    QThread::Priority priority() const;
 
public Q_SLOTS:
 
    void start();
 
    void stop();
 
    void wait();
 
Q_SIGNALS:
 
    void starting();
    void finished();
 
protected:
 
    void shutDown();
 
    bool runningFlag() const volatile;
 
    QMutex* threadMutex() const;
 
#if (QT_VERSION > QT_VERSION_CHECK(5, 99, 0))
    void start(QMutexLocker<QMutex>& locker);
    void stop(QMutexLocker<QMutex>& locker);
    void wait(QMutexLocker<QMutex>& locker);
#else
    void start(QMutexLocker& locker);
    void stop(QMutexLocker& locker);
    void wait(QMutexLocker& locker);
#endif
 
private:
 
    // Disable
    DynamicThread(const DynamicThread&)            = delete;
    DynamicThread& operator=(const DynamicThread&) = delete;
 
private:
 
    friend class DynamicThreadPriv;
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DYNAMIC_THREAD_H