qfutureinterface.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:9k
源码类别:

系统编程

开发平台:

Unix_Linux

  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
  4. ** Contact: Qt Software Information (qt-info@nokia.com)
  5. **
  6. ** This file is part of the QtCore module of the Qt Toolkit.
  7. **
  8. ** Commercial Usage
  9. ** Licensees holding valid Qt Commercial licenses may use this file in
  10. ** accordance with the Qt Commercial License Agreement provided with the
  11. ** Software or, alternatively, in accordance with the terms contained in
  12. ** a written agreement between you and Nokia.
  13. **
  14. **
  15. ** GNU General Public License Usage
  16. ** Alternatively, this file may be used under the terms of the GNU
  17. ** General Public License versions 2.0 or 3.0 as published by the Free
  18. ** Software Foundation and appearing in the file LICENSE.GPL included in
  19. ** the packaging of this file.  Please review the following information
  20. ** to ensure GNU General Public Licensing requirements will be met:
  21. ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
  22. ** http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
  23. ** exception, Nokia gives you certain additional rights. These rights
  24. ** are described in the Nokia Qt GPL Exception version 1.3, included in
  25. ** the file GPL_EXCEPTION.txt in this package.
  26. **
  27. ** Qt for Windows(R) Licensees
  28. ** As a special exception, Nokia, as the sole copyright holder for Qt
  29. ** Designer, grants users of the Qt/Eclipse Integration plug-in the
  30. ** right for the Qt/Eclipse Integration to link to functionality
  31. ** provided by Qt Designer and its related libraries.
  32. **
  33. ** If you are unsure which license is appropriate for your use, please
  34. ** contact the sales department at qt-sales@nokia.com.
  35. **
  36. ****************************************************************************/
  37. #ifndef QFUTUREINTERFACE_H
  38. #define QFUTUREINTERFACE_H
  39. #include <QtCore/qglobal.h>
  40. #ifndef QT_NO_QFUTURE
  41. #include <QtCore/qmutex.h>
  42. #include <QtCore/qtconcurrentexception.h>
  43. #include <QtCore/qtconcurrentresultstore.h>
  44. QT_BEGIN_HEADER
  45. QT_BEGIN_NAMESPACE
  46. QT_MODULE(Core)
  47. template <typename T> class QFuture;
  48. class QFutureInterfaceBasePrivate;
  49. class QFutureWatcherBase;
  50. class QFutureWatcherBasePrivate;
  51. class Q_CORE_EXPORT QFutureInterfaceBase
  52. {
  53. public:
  54.     enum State {
  55.         NoState   = 0x00,
  56.         Running   = 0x01,
  57.         Started   = 0x02,
  58.         Finished  = 0x04,
  59.         Canceled  = 0x08,
  60.         Paused    = 0x10,
  61.         Throttled = 0x20
  62.     };
  63.     QFutureInterfaceBase(State initialState = NoState);
  64.     QFutureInterfaceBase(const QFutureInterfaceBase &other);
  65.     virtual ~QFutureInterfaceBase();
  66.     // reporting functions available to the engine author:
  67.     void reportStarted();
  68.     void reportFinished();
  69.     void reportCanceled();
  70. #ifndef QT_NO_EXCEPTIONS
  71.     void reportException(const QtConcurrent::Exception &e);
  72. #endif
  73.     void reportResultsReady(int beginIndex, int endIndex);
  74.     void setFilterMode(bool enable);
  75.     void setProgressRange(int minimum, int maximum);
  76.     int progressMinimum() const;
  77.     int progressMaximum() const;
  78.     bool isProgressUpdateNeeded() const;
  79.     void setProgressValue(int progressValue);
  80.     int progressValue() const;
  81.     void setProgressValueAndText(int progressValue, const QString &progressText);
  82.     QString progressText() const;
  83.     void setExpectedResultCount(int resultCount);
  84.     int expectedResultCount();
  85.     int resultCount() const;
  86.     bool queryState(State state) const;
  87.     bool isRunning() const;
  88.     bool isStarted() const;
  89.     bool isCanceled() const;
  90.     bool isFinished() const;
  91.     bool isPaused() const;
  92.     bool isThrottled() const;
  93.     bool isResultReadyAt(int index) const;
  94.     void cancel();
  95.     void setPaused(bool paused);
  96.     void togglePaused();
  97.     void setThrottled(bool enable);
  98.     void waitForFinished();
  99.     bool waitForNextResult();
  100.     void waitForResult(int resultIndex);
  101.     void waitForResume();
  102.     QMutex *mutex() const;
  103.     QtConcurrent::internal::ExceptionStore &exceptionStore();
  104.     QtConcurrent::ResultStoreBase &resultStoreBase();
  105.     const QtConcurrent::ResultStoreBase &resultStoreBase() const;
  106.     inline bool operator==(const QFutureInterfaceBase &other) const { return d == other.d; }
  107.     inline bool operator!=(const QFutureInterfaceBase &other) const { return d != other.d; }
  108.     QFutureInterfaceBase &operator=(const QFutureInterfaceBase &other);
  109. protected:
  110.     bool referenceCountIsOne() const;
  111. public:
  112. #ifndef QFUTURE_TEST
  113. private:
  114. #endif
  115.     QFutureInterfaceBasePrivate *d;
  116. private:
  117.     friend class QFutureWatcherBase;
  118.     friend class QFutureWatcherBasePrivate;
  119. };
  120. template <typename T>
  121. class QFutureInterface : public QFutureInterfaceBase
  122. {
  123. public:
  124.     QFutureInterface(State initialState = NoState)
  125.         : QFutureInterfaceBase(initialState)
  126.     { }
  127.     QFutureInterface(const QFutureInterface &other)
  128.         : QFutureInterfaceBase(other)
  129.     { }
  130.     ~QFutureInterface()
  131.     {
  132.         if (referenceCountIsOne())
  133.             resultStore().clear();
  134.     }
  135.     static QFutureInterface canceledResult()
  136.     { return QFutureInterface(State(Started | Finished | Canceled)); }
  137.     QFutureInterface &operator=(const QFutureInterface &other)
  138.     {
  139.         QFutureInterfaceBase::operator=(other);
  140.         return *this;
  141.     }
  142.     inline QFuture<T> future(); // implemented in qfuture.h
  143.     inline void reportResult(const T *result, int index = -1);
  144.     inline void reportResult(const T &result, int index = -1);
  145.     inline void reportResults(const QVector<T> &results, int beginIndex = -1, int count = -1);
  146.     inline void reportFinished(const T *result = 0);
  147.     inline const T &resultReference(int index) const;
  148.     inline const T *resultPointer(int index) const;
  149.     inline QList<T> results();
  150. private:
  151.     QtConcurrent::ResultStore<T> &resultStore()
  152.     { return static_cast<QtConcurrent::ResultStore<T> &>(resultStoreBase()); }
  153.     const QtConcurrent::ResultStore<T> &resultStore() const
  154.     { return static_cast<const QtConcurrent::ResultStore<T> &>(resultStoreBase()); }
  155. };
  156. template <typename T>
  157. inline void QFutureInterface<T>::reportResult(const T *result, int index)
  158. {
  159.     QMutexLocker locker(mutex());
  160.     if (this->queryState(Canceled) || this->queryState(Finished)) {
  161.         return;
  162.     }
  163.     QtConcurrent::ResultStore<T> &store = resultStore();
  164.     if (store.filterMode()) {
  165.         const int resultCountBefore = store.count();
  166.         store.addResult(index, result);
  167.         this->reportResultsReady(resultCountBefore, resultCountBefore + store.count());
  168.     } else {
  169.         const int insertIndex = store.addResult(index, result);
  170.         this->reportResultsReady(insertIndex, insertIndex + 1);
  171.     }
  172. }
  173. template <typename T>
  174. inline void QFutureInterface<T>::reportResult(const T &result, int index)
  175. {
  176.     reportResult(&result, index);
  177. }
  178. template <typename T>
  179. inline void QFutureInterface<T>::reportResults(const QVector<T> &_results, int beginIndex, int count)
  180. {
  181.     QMutexLocker locker(mutex());
  182.     if (this->queryState(Canceled) || this->queryState(Finished)) {
  183.         return;
  184.     }
  185.     QtConcurrent::ResultStore<T> &store = resultStore();
  186.     if (store.filterMode()) {
  187.         const int resultCountBefore = store.count();
  188.         store.addResults(beginIndex, &_results, count);
  189.         this->reportResultsReady(resultCountBefore, store.count());
  190.     } else {
  191.         const int insertIndex = store.addResults(beginIndex, &_results, count);
  192.         this->reportResultsReady(insertIndex, insertIndex + _results.count());    
  193.     }
  194. }
  195. template <typename T>
  196. inline void QFutureInterface<T>::reportFinished(const T *result)
  197. {
  198.     if (result)
  199.         reportResult(result);
  200.     QFutureInterfaceBase::reportFinished();
  201. }
  202. template <typename T>
  203. inline const T &QFutureInterface<T>::resultReference(int index) const
  204. {
  205.     QMutexLocker lock(mutex());
  206.     return resultStore().resultAt(index).value();
  207. }
  208. template <typename T>
  209. inline const T *QFutureInterface<T>::resultPointer(int index) const
  210. {
  211.     QMutexLocker lock(mutex());
  212.     return resultStore().resultAt(index).pointer();
  213. }
  214. template <typename T>
  215. inline QList<T> QFutureInterface<T>::results()
  216. {
  217.     if (this->isCanceled()) {
  218.         exceptionStore().throwPossibleException();
  219.         return QList<T>();
  220.     }
  221.     QFutureInterfaceBase::waitForResult(-1);
  222.     QList<T> res;
  223.     QMutexLocker lock(mutex());
  224.     QtConcurrent::ResultIterator<T> it = resultStore().begin();
  225.     while (it != resultStore().end()) {
  226.         res.append(it.value());
  227.         ++it;
  228.     }
  229.     return res;
  230. }
  231. template <>
  232. class QFutureInterface<void> : public QFutureInterfaceBase
  233. {
  234. public:
  235.     QFutureInterface<void>(State initialState = NoState)
  236.         : QFutureInterfaceBase(initialState)
  237.     { }
  238.     QFutureInterface<void>(const QFutureInterface<void> &other)
  239.         : QFutureInterfaceBase(other)
  240.     { }
  241.     static QFutureInterface<void> canceledResult()
  242.     { return QFutureInterface(State(Started | Finished | Canceled)); }
  243.     QFutureInterface<void> &operator=(const QFutureInterface<void> &other)
  244.     {
  245.         QFutureInterfaceBase::operator=(other);
  246.         return *this;
  247.     }
  248.     inline QFuture<void> future(); // implemented in qfuture.h
  249.     void reportResult(const void *, int) { }
  250.     void reportResults(const QVector<void> &, int) { }
  251.     void reportFinished(void * = 0) { QFutureInterfaceBase::reportFinished(); }
  252. };
  253. QT_END_NAMESPACE
  254. QT_END_HEADER
  255. #endif // QT_NO_CONCURRENT
  256. #endif // QFUTUREINTERFACE_H