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
51QT_BEGIN_NAMESPACE
52
53
54class Q_TESTLIB_EXPORT QTestEventLoop : public QObject
55{
56 Q_OBJECT
57
58public:
59 QTestEventLoop(QObject *parent = nullptr)
60 : QObject(parent), _timeout(false)
61 {}
62
63 inline void enterLoopMSecs(int ms);
64 inline void enterLoop(int secs) { enterLoopMSecs(secs * 1000); }
65
66 inline void changeInterval(int secs)
67 { killTimer(timerId); timerId = startTimer(secs * 1000); }
68
69 inline bool timeout() const
70 { return _timeout; }
71
72 inline static QTestEventLoop &instance()
73 {
74 static QPointer<QTestEventLoop> testLoop;
75 if (testLoop.isNull())
76 testLoop = new QTestEventLoop(QCoreApplication::instance());
77 return *static_cast<QTestEventLoop *>(testLoop);
78 }
79
80public Q_SLOTS:
81 inline void exitLoop();
82
83protected:
84 inline void timerEvent(QTimerEvent *e) override;
85
86private:
87 QEventLoop *loop = nullptr;
88 int timerId = -1;
89 uint _timeout :1;
90 Q_DECL_UNUSED_MEMBER uint reserved :31;
91};
92
93inline void QTestEventLoop::enterLoopMSecs(int ms)
94{
95 Q_ASSERT(!loop);
96
97 QEventLoop l;
98
99 _timeout = false;
100
101 timerId = startTimer(ms);
102
103 loop = &l;
104 l.exec();
105 loop = nullptr;
106}
107
108inline void QTestEventLoop::exitLoop()
109{
110 if (thread() != QThread::currentThread())
111 {
112 QMetaObject::invokeMethod(this, "exitLoop", Qt::QueuedConnection);
113 return;
114 }
115
116 if (timerId != -1)
117 killTimer(timerId);
118 timerId = -1;
119
120 if (loop)
121 loop->exit();
122}
123
124inline void QTestEventLoop::timerEvent(QTimerEvent *e)
125{
126 if (e->timerId() != timerId)
127 return;
128 _timeout = true;
129 exitLoop();
130}
131
132QT_END_NAMESPACE
133
134#endif
135