src/testlib/qtesteventloop.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtTest module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QTESTEVENTLOOP_H
  43 #define QTESTEVENTLOOP_H
  44
  45 #include <QtTest/qtest_global.h>
  46
  47 #include <QtCore/qcoreapplication.h>
  48 #include <QtCore/qeventloop.h>
  49 #include <QtCore/qobject.h>
  50 #include <QtCore/qpointer.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class Q_TESTLIB_EXPORT QTestEventLoop : public QObject
  58 {
  59     Q_OBJECT
  60
  61 public:
  62     inline QTestEventLoop(QObject *aParent = 0)
  63         : QObject(aParent), inLoop(false), _timeout(false), timerId(-1), loop(0) {}
  64
  65     inline void enterLoopMSecs(int ms);
  66     inline void enterLoop(int secs) { enterLoopMSecs(secs * 1000); }
  67
  68     inline void changeInterval(int secs)
  69     { killTimer(timerId); timerId = startTimer(secs * 1000); }
  70
  71     inline bool timeout() const
  72     { return _timeout; }
  73
  74     inline static QTestEventLoop &instance()
  75     {
  76         static QPointer<QTestEventLoop> testLoop;
  77         if (testLoop.isNull())
  78             testLoop = new QTestEventLoop(QCoreApplication::instance());
  79         return *static_cast<QTestEventLoop *>(testLoop);
  80     }
  81
  82 public Q_SLOTS:
  83     inline void exitLoop();
  84
  85 protected:
  86     inline void timerEvent(QTimerEvent *e);
  87
  88 private:
  89     bool inLoop;
  90     bool _timeout;
  91     int timerId;
  92
  93     QEventLoop *loop;
  94 };
  95
  96 inline void QTestEventLoop::enterLoopMSecs(int ms)
  97 {
  98     Q_ASSERT(!loop);
  99
 100     QEventLoop l;
 101
 102     inLoop = true;
 103     _timeout = false;
 104
 105     timerId = startTimer(ms);
 106
 107     loop = &l;
 108     l.exec();
 109     loop = 0;
 110 }
 111
 112 inline void QTestEventLoop::exitLoop()
 113 {
 114     if (timerId != -1)
 115         killTimer(timerId);
 116     timerId = -1;
 117
 118     if (loop)
 119         loop->exit();
 120
 121     inLoop = false;
 122 }
 123
 124 inline void QTestEventLoop::timerEvent(QTimerEvent *e)
 125 {
 126     if (e->timerId() != timerId)
 127         return;
 128     _timeout = true;
 129     exitLoop();
 130 }
 131
 132 QT_END_NAMESPACE
 133
 134 QT_END_HEADER
 135
 136 #endif