src/views/versioncontrol/updateitemstatesthread.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef UPDATEITEMSTATESTHREAD_H
  21 #define UPDATEITEMSTATESTHREAD_H
  22
  23 #include "dolphin_export.h"
  24 #include <views/versioncontrol/versioncontrolobserver.h>
  25
  26 #include <QMutex>
  27 #include <QThread>
  28
  29 /**
  30  * The performance of updating the version state of items depends
  31  * on the used plugin. To prevent that Dolphin gets blocked by a
  32  * slow plugin, the updating is delegated to a thread.
  33  */
  34 class DOLPHIN_EXPORT UpdateItemStatesThread : public QThread
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     /**
  40      * @param plugin     Version control plugin that is used to update the
  41      *                   state of the items. Whenever the plugin is accessed
  42      *                   from the thread creator after starting the thread,
  43      *                   UpdateItemStatesThread::lockPlugin() and
  44      *                   UpdateItemStatesThread::unlockPlugin() must be used.
  45      * @param itemStates List of items, where the states get updated.
  46      */
  47     UpdateItemStatesThread(KVersionControlPlugin* plugin,
  48                            const QMap<QString, QVector<VersionControlObserver::ItemState> >& itemStates);
  49     ~UpdateItemStatesThread() override;
  50
  51     QMap<QString, QVector<VersionControlObserver::ItemState> > itemStates() const;
  52
  53 protected:
  54     void run() override;
  55
  56 private:
  57     QMutex* m_globalPluginMutex; // Protects the m_plugin globally
  58     KVersionControlPlugin* m_plugin;
  59
  60     QMap<QString, QVector<VersionControlObserver::ItemState> > m_itemStates;
  61 };
  62
  63 #endif // UPDATEITEMSTATESTHREAD_H