src/views/versioncontrol/updateitemstatesthread.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at>                  *
   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 <libdolphin_export.h>
  24 #include <views/versioncontrol/versioncontrolobserver.h>
  25
  26 #include <QMutex>
  27 #include <QThread>
  28
  29 class KVersionControlPlugin;
  30
  31 /**
  32  * The performance of updating the version state of items depends
  33  * on the used plugin. To prevent that Dolphin gets blocked by a
  34  * slow plugin, the updating is delegated to a thread.
  35  */
  36 class LIBDOLPHINPRIVATE_EXPORT UpdateItemStatesThread : public QThread
  37 {
  38     Q_OBJECT
  39
  40 public:
  41     UpdateItemStatesThread();
  42     virtual ~UpdateItemStatesThread();
  43
  44     /**
  45      * @param plugin     Version control plugin that is used to update the
  46      *                   state of the items. Whenever the plugin is accessed
  47      *                   from the thread creator after starting the thread,
  48      *                   UpdateItemStatesThread::lockPlugin() and
  49      *                   UpdateItemStatesThread::unlockPlugin() must be used.
  50      * @param itemStates List of items, where the states get updated.
  51      */
  52     void setData(KVersionControlPlugin* plugin,
  53                  const QList<VersionControlObserver::ItemState>& itemStates);
  54
  55     /**
  56      * Whenever the plugin is accessed by the thread creator, lockPlugin() must
  57      * be invoked. True is returned, if the plugin could be locked within 300
  58      * milliseconds.
  59      */
  60     bool lockPlugin();
  61
  62     /**
  63      * Must be invoked if lockPlugin() returned true and plugin has been accessed
  64      * by the thread creator.
  65      */
  66     void unlockPlugin();
  67
  68     QList<VersionControlObserver::ItemState> itemStates() const;
  69
  70     bool retrievedItems() const;
  71
  72 protected:
  73     virtual void run();
  74
  75 private:
  76     QMutex* m_globalPluginMutex; // Protects the m_plugin globally
  77     KVersionControlPlugin* m_plugin;
  78
  79     mutable QMutex m_itemMutex; // Protects m_retrievedItems and m_itemStates
  80     bool m_retrievedItems;
  81     QList<VersionControlObserver::ItemState> m_itemStates;
  82 };
  83
  84 #endif // UPDATEITEMSTATESTHREAD_H