src/corelib/concurrent/qfutureinterface_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtCore module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QFUTUREINTERFACE_P_H
  43 #define QFUTUREINTERFACE_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/qdatetime.h>
  57 #include <QtCore/qcoreevent.h>
  58 #include <QtCore/qlist.h>
  59 #include <QtCore/qwaitcondition.h>
  60 #include <QtCore/qrunnable.h>
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 class QFutureCallOutEvent : public QEvent
  65 {
  66 public:
  67     enum CallOutType {
  68         Started,
  69         Finished,
  70         Canceled,
  71         Paused,
  72         Resumed,
  73         Progress,
  74         ProgressRange,
  75         ResultsReady
  76     };
  77
  78     QFutureCallOutEvent()
  79         : QEvent(QEvent::FutureCallOut), callOutType(CallOutType(0)), index1(-1), index2(-1)
  80     { }
  81     QFutureCallOutEvent(CallOutType callOutType, int index1 = -1)
  82         : QEvent(QEvent::FutureCallOut), callOutType(callOutType), index1(index1), index2(-1)
  83     { }
  84     QFutureCallOutEvent(CallOutType callOutType, int index1, int index2)
  85         : QEvent(QEvent::FutureCallOut), callOutType(callOutType), index1(index1), index2(index2)
  86     { }
  87
  88     QFutureCallOutEvent(CallOutType callOutType, int index1, const QString &text)
  89         : QEvent(QEvent::FutureCallOut),
  90           callOutType(callOutType),
  91           index1(index1),
  92           index2(-1),
  93           text(text)
  94     { }
  95
  96     CallOutType callOutType;
  97     int index1;
  98     int index2;
  99     QString text;
 100
 101     QFutureCallOutEvent *clone() const
 102     {
 103         return new QFutureCallOutEvent(callOutType, index1, index2, text);
 104     }
 105
 106 private:
 107     QFutureCallOutEvent(CallOutType callOutType,
 108                         int index1,
 109                         int index2,
 110                         const QString &text)
 111         : QEvent(QEvent::FutureCallOut),
 112           callOutType(callOutType),
 113           index1(index1),
 114           index2(index2),
 115           text(text)
 116     { }
 117 };
 118
 119 class QFutureCallOutInterface
 120 {
 121 public:
 122     virtual ~QFutureCallOutInterface() {}
 123     virtual void postCallOutEvent(const QFutureCallOutEvent &) = 0;
 124     virtual void callOutInterfaceDisconnected() = 0;
 125 };
 126
 127 class QFutureInterfaceBasePrivate
 128 {
 129 public:
 130     QFutureInterfaceBasePrivate(QFutureInterfaceBase::State initialState);
 131
 132     QAtomicInt refCount;
 133     mutable QMutex m_mutex;
 134     QWaitCondition waitCondition;
 135     QList<QFutureCallOutInterface *> outputConnections;
 136     int m_progressValue;
 137     int m_progressMinimum;
 138     int m_progressMaximum;
 139     QFutureInterfaceBase::State state;
 140     QTime progressTime;
 141     bool progressTimeStarted;
 142     QWaitCondition pausedWaitCondition;
 143     int pendingResults;
 144     QtConcurrent::ResultStoreBase m_results;
 145     bool manualProgress;
 146     int m_expectedResultCount;
 147     QtConcurrent::internal::ExceptionStore m_exceptionStore;
 148     QString m_progressText;
 149     QRunnable *runnable;
 150
 151     // Internal functions that does not change the mutex state.
 152     // The mutex must be locked when calling these.
 153     int internal_resultCount() const;
 154     bool internal_isResultReadyAt(int index) const;
 155     bool internal_waitForNextResult();
 156     bool internal_updateProgress(int progress, const QString &progressText = QString());
 157     void internal_setThrottled(bool enable);
 158     void sendCallOut(const QFutureCallOutEvent &callOut);
 159     void sendCallOuts(const QFutureCallOutEvent &callOut1, const QFutureCallOutEvent &callOut2);
 160     void connectOutputInterface(QFutureCallOutInterface *iface);
 161     void disconnectOutputInterface(QFutureCallOutInterface *iface);
 162
 163     void setState(QFutureInterfaceBase::State state);
 164 };
 165
 166 QT_END_NAMESPACE
 167
 168 #endif