summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel/qelapsedtimer.h
blob: e71573456d4291e45aac9f67805383270157b2c3 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
// Copyright (C) 2016 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 QELAPSEDTIMER_H
#define QELAPSEDTIMER_H

#include <QtCore/qcompare.h>
#include <QtCore/qglobal.h>

#include <chrono>

QT_BEGIN_NAMESPACE

class Q_CORE_EXPORT QElapsedTimer
{
public:
    enum ClockType {
        SystemTime,
        MonotonicClock,
        TickCounter Q_DECL_ENUMERATOR_DEPRECATED_X(
                "Not supported anymore. Use PerformanceCounter instead."),
        MachAbsoluteTime,
        PerformanceCounter
    };

    // similar to std::chrono::*_clock
    using Duration = std::chrono::nanoseconds;
    using TimePoint = std::chrono::time_point<std::chrono::steady_clock, Duration>;

    constexpr QElapsedTimer() = default;

    static ClockType clockType() noexcept;
    static bool isMonotonic() noexcept;

    void start() noexcept;
    qint64 restart() noexcept;
    void invalidate() noexcept;
    bool isValid() const noexcept;

    Duration durationElapsed() const noexcept;
    qint64 nsecsElapsed() const noexcept;
    qint64 elapsed() const noexcept;
    bool hasExpired(qint64 timeout) const noexcept;

    qint64 msecsSinceReference() const noexcept;
    Duration durationTo(const QElapsedTimer &other) const noexcept;
    qint64 msecsTo(const QElapsedTimer &other) const noexcept;
    qint64 secsTo(const QElapsedTimer &other) const noexcept;
    friend bool Q_CORE_EXPORT operator<(const QElapsedTimer &lhs, const QElapsedTimer &rhs) noexcept;

private:
    friend bool comparesEqual(const QElapsedTimer &lhs, const QElapsedTimer &rhs) noexcept
    {
        return lhs.t1 == rhs.t1 && lhs.t2 == rhs.t2;
    }
    Q_DECLARE_EQUALITY_COMPARABLE(QElapsedTimer)

    friend Qt::strong_ordering compareThreeWay(const QElapsedTimer &lhs,
                                               const QElapsedTimer &rhs) noexcept
    {
        return Qt::compareThreeWay(lhs.t1, rhs.t1);
    }

#if defined(__cpp_lib_three_way_comparison)
    friend std::strong_ordering
    operator<=>(const QElapsedTimer &lhs, const QElapsedTimer &rhs) noexcept
    {
        return compareThreeWay(lhs, rhs);
    }
#else
    friend bool operator>(const QElapsedTimer &lhs, const QElapsedTimer &rhs) noexcept
    {
        return is_gt(compareThreeWay(lhs, rhs));
    }
    friend bool operator<=(const QElapsedTimer &lhs, const QElapsedTimer &rhs) noexcept
    {
        return is_lteq(compareThreeWay(lhs, rhs));
    }
    friend bool operator>=(const QElapsedTimer &lhs, const QElapsedTimer &rhs) noexcept
    {
        return is_gteq(compareThreeWay(lhs, rhs));
    }
#endif // defined(__cpp_lib_three_way_comparison)
    qint64 t1 = Q_INT64_C(0x8000000000000000);
    qint64 t2 = Q_INT64_C(0x8000000000000000);
};

QT_END_NAMESPACE

#endif // QELAPSEDTIMER_H