actionthreadbase.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2011-12-28
 * Description : Low level threads management for batch processing on multi-core
 *
 * Copyright (C) 2011-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C)      2014 by Veaceslav Munteanu <veaceslav dot munteanu90 at gmail dot com>
 * Copyright (C) 2011-2012 by Janardhan Reddy <annapareddyjanardhanreddy at gmail dot com>
 *
 * 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_ACTION_THREAD_BASE_H
#define DIGIKAM_ACTION_THREAD_BASE_H
 
// Qt includes
 
#include <QHash>
#include <QObject>
#include <QThread>
#include <QRunnable>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT ActionJob : public QObject,
                                 public QRunnable
{
    Q_OBJECT
 
public:
 
    explicit ActionJob(QObject* const parent = nullptr);
 
    ~ActionJob() override;
 
Q_SIGNALS:
 
    void signalStarted();
 
    void signalProgress(int);
 
    void signalDone();
 
public Q_SLOTS:
 
    void cancel();
 
protected:
 
    bool m_cancel;
};
 
typedef QHash<ActionJob*, int> ActionJobCollection;
 
// -------------------------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT ActionThreadBase : public QThread
{
    Q_OBJECT
 
public:
 
    explicit ActionThreadBase(QObject* const parent = nullptr);
    ~ActionThreadBase() override;
 
    void setMaximumNumberOfThreads(int n);
 
    int  maximumNumberOfThreads()   const;
 
    void setDefaultMaximumNumberOfThreads();
 
    void cancel();
 
protected:
 
    void run()                            override;
 
    void appendJobs(const ActionJobCollection& jobs);
 
    bool isEmpty()                  const;
 
    int pendingCount()              const;
 
protected Q_SLOTS:
 
    void slotJobFinished();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ACTION_THREAD_BASE_H