1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore 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#include "qtestsupport_core.h"
41
42#ifdef Q_OS_WIN
43#include <qt_windows.h>
44#endif
45
46QT_BEGIN_NAMESPACE
47
48/*!
49 Sleeps for \a ms milliseconds, blocking execution of the
50 test. qSleep() will not do any event processing and leave your test
51 unresponsive. Network communication might time out while
52 sleeping. Use \l {QTest::qWait()} to do non-blocking sleeping.
53
54 \a ms must be greater than 0.
55
56 \b {Note:} The qSleep() function calls either \c nanosleep() on
57 unix or \c Sleep() on windows, so the accuracy of time spent in
58 qSleep() depends on the operating system.
59
60 Example:
61 \snippet code/src_qtestlib_qtestcase.cpp 23
62
63 \sa {QTest::qWait()}
64*/
65Q_CORE_EXPORT void QTest::qSleep(int ms)
66{
67 Q_ASSERT(ms > 0);
68
69#if defined(Q_OS_WIN)
70 Sleep(uint(ms));
71#else
72 struct timespec ts = { time_t(ms / 1000), (ms % 1000) * 1000 * 1000 };
73 nanosleep(&ts, nullptr);
74#endif
75}
76
77/*! \fn template <typename Functor> bool QTest::qWaitFor(Functor predicate, int timeout)
78
79 Waits for \a timeout milliseconds or until the \a predicate returns true.
80
81 Returns \c true if the \a predicate returned true at any point, otherwise returns \c false.
82
83 Example:
84
85 \snippet code/src_corelib_kernel_qtestsupport_core_snippet.cpp 0
86
87 The code above will wait for the object to become ready, for a
88 maximum of three seconds.
89
90 \since 5.10
91*/
92
93
94/*! \fn void QTest::qWait(int ms)
95
96 Waits for \a ms milliseconds. While waiting, events will be processed and
97 your test will stay responsive to user interface events or network communication.
98
99 Example:
100
101 \snippet code/src_corelib_kernel_qtestsupport_core.cpp 1
102
103 The code above will wait until the network server is responding for a
104 maximum of about 12.5 seconds.
105
106 \sa QTest::qSleep(), QSignalSpy::wait()
107*/
108Q_CORE_EXPORT void QTest::qWait(int ms)
109{
110 // Ideally this method would be implemented in terms of qWaitFor, with
111 // a predicate that always returns false, but due to a compiler bug in
112 // GCC 6 we can't do that.
113
114 Q_ASSERT(QCoreApplication::instance());
115
116 QDeadlineTimer timer(ms, Qt::PreciseTimer);
117 int remaining = ms;
118 do {
119 QCoreApplication::processEvents(QEventLoop::AllEvents, remaining);
120 QCoreApplication::sendPostedEvents(nullptr, QEvent::DeferredDelete);
121 remaining = timer.remainingTime();
122 if (remaining <= 0)
123 break;
124 QTest::qSleep(qMin(10, remaining));
125 remaining = timer.remainingTime();
126 } while (remaining > 0);
127}
128
129QT_END_NAMESPACE
130