summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel/qtestsupport_core.h
blob: 27265903afe6ed6e47bfa2645ac4d994b80e12f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
// Copyright (C) 2018 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QTESTSUPPORT_CORE_H
#define QTESTSUPPORT_CORE_H

#include <QtCore/qcoreapplication.h>
#include <QtCore/qdeadlinetimer.h>

#include <chrono>

QT_BEGIN_NAMESPACE

namespace QTest {

Q_CORE_EXPORT void qSleep(int ms);
Q_CORE_EXPORT void qSleep(std::chrono::milliseconds msecs);

template <typename Functor>
[[nodiscard]] bool
qWaitFor(Functor predicate, QDeadlineTimer deadline = QDeadlineTimer(std::chrono::seconds{5}))
{
    // We should not spin the event loop in case the predicate is already true,
    // otherwise we might send new events that invalidate the predicate.
    if (predicate())
        return true;

    // qWait() is expected to spin the event loop at least once, even when
    // called with a small timeout like 1ns.

    do {
        // We explicitly do not pass the remaining time to processEvents, as
        // that would keep spinning processEvents for the whole duration if
        // new events were posted as part of processing events, and we need
        // to return back to this function to check the predicate between
        // each pass of processEvents. Our own timer will take care of the
        // timeout.
        QCoreApplication::processEvents(QEventLoop::AllEvents);
        QCoreApplication::sendPostedEvents(nullptr, QEvent::DeferredDelete);

        if (predicate())
            return true;

        using namespace std::chrono;

        if (const auto remaining = deadline.remainingTimeAsDuration(); remaining > 0ns)
            qSleep((std::min)(10ms, ceil<milliseconds>(remaining)));

    } while (!deadline.hasExpired());

    return predicate(); // Last chance
}

template <typename Functor>
[[nodiscard]] bool qWaitFor(Functor predicate, int timeout)
{
    return qWaitFor(predicate, QDeadlineTimer{timeout, Qt::PreciseTimer});
}

Q_CORE_EXPORT void qWait(int ms);

Q_CORE_EXPORT void qWait(std::chrono::milliseconds msecs);

} // namespace QTest

QT_END_NAMESPACE

#endif