1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QTESTEVENTLOOP_H
41 #define QTESTEVENTLOOP_H
42 
43 #include <QtTest/qttestglobal.h>
44 
45 #include <QtCore/qcoreapplication.h>
46 #include <QtCore/qeventloop.h>
47 #include <QtCore/qobject.h>
48 #include <QtCore/qpointer.h>
49 #include <QtCore/qthread.h>
50 
51 QT_BEGIN_NAMESPACE
52 
53 
54 class Q_TESTLIB_EXPORT QTestEventLoop : public QObject
55 {
56     Q_OBJECT
57 
58 public:
59     using QObject::QObject;
60 
61     inline void enterLoopMSecs(int ms);
enterLoop(int secs)62     inline void enterLoop(int secs) { enterLoopMSecs(secs * 1000); }
63 
changeInterval(int secs)64     inline void changeInterval(int secs)
65     { killTimer(timerId); timerId = startTimer(secs * 1000); }
66 
timeout()67     inline bool timeout() const
68     { return _timeout; }
69 
instance()70     inline static QTestEventLoop &instance()
71     {
72         static QPointer<QTestEventLoop> testLoop;
73         if (testLoop.isNull())
74             testLoop = new QTestEventLoop(QCoreApplication::instance());
75         return *static_cast<QTestEventLoop *>(testLoop);
76     }
77 
78 public Q_SLOTS:
79     inline void exitLoop();
80 
81 protected:
82     inline void timerEvent(QTimerEvent *e) override;
83 
84 private:
85     Q_DECL_UNUSED_MEMBER bool inLoop; // ### Qt 6: remove
86     bool _timeout = false;
87     int timerId = -1;
88 
89     QEventLoop *loop = nullptr;
90 };
91 
enterLoopMSecs(int ms)92 inline void QTestEventLoop::enterLoopMSecs(int ms)
93 {
94     Q_ASSERT(!loop);
95 
96     QEventLoop l;
97 
98     _timeout = false;
99 
100     timerId = startTimer(ms);
101 
102     loop = &l;
103     l.exec();
104     loop = nullptr;
105 }
106 
exitLoop()107 inline void QTestEventLoop::exitLoop()
108 {
109     if (thread() != QThread::currentThread())
110     {
111         QMetaObject::invokeMethod(this, "exitLoop", Qt::QueuedConnection);
112         return;
113     }
114 
115     if (timerId != -1)
116         killTimer(timerId);
117     timerId = -1;
118 
119     if (loop)
120         loop->exit();
121 }
122 
timerEvent(QTimerEvent * e)123 inline void QTestEventLoop::timerEvent(QTimerEvent *e)
124 {
125     if (e->timerId() != timerId)
126         return;
127     _timeout = true;
128     exitLoop();
129 }
130 
131 QT_END_NAMESPACE
132 
133 #endif
134