Remove std::chrono completely
[WebKit.git] / Source / WTF / wtf / MonotonicTime.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WTF_MonotonicTime_h
27 #define WTF_MonotonicTime_h
28
29 #include <wtf/ClockType.h>
30 #include <wtf/Seconds.h>
31
32 namespace WTF {
33
34 class WallTime;
35 class PrintStream;
36
37 // The current time according to a monotonic clock. Monotonic clocks don't go backwards and
38 // possibly don't count downtime. This uses floating point internally so that you can reason about
39 // infinity and other things that arise in math. It's acceptable to use this to wrap NaN times,
40 // negative times, and infinite times, so long as they are all relative to the same clock.
41 // Specifically, MonotonicTime should be used in agreement with the principle that
42 // MonotonicTime::now().secondsSinceEpoch().value() is the same as
43 // WTF::monotonicallyIncreasingTime().
44 class MonotonicTime {
45 public:
46     static const ClockType clockType = ClockType::Monotonic;
47     
48     // This is the epoch. So, x.secondsSinceEpoch() should be the same as x - MonotonicTime().
49     constexpr MonotonicTime() { }
50     
51     // Call this if you know for sure that the double represents time according to
52     // WTF::monotonicallyIncreasingTime(). It must be in seconds and it must be from the same time
53     // source.
54     static constexpr MonotonicTime fromRawSeconds(double value)
55     {
56         return MonotonicTime(value);
57     }
58     
59     WTF_EXPORT_PRIVATE static MonotonicTime now();
60     
61     static constexpr MonotonicTime infinity() { return fromRawSeconds(std::numeric_limits<double>::infinity()); }
62     static constexpr MonotonicTime nan() { return fromRawSeconds(std::numeric_limits<double>::quiet_NaN()); }
63
64     constexpr Seconds secondsSinceEpoch() const { return Seconds(m_value); }
65     
66     MonotonicTime approximateMonotonicTime() const { return *this; }
67     WTF_EXPORT_PRIVATE WallTime approximateWallTime() const;
68     
69     explicit constexpr operator bool() const { return !!m_value; }
70     
71     constexpr MonotonicTime operator+(Seconds other) const
72     {
73         return fromRawSeconds(m_value + other.value());
74     }
75     
76     constexpr MonotonicTime operator-(Seconds other) const
77     {
78         return fromRawSeconds(m_value - other.value());
79     }
80
81     Seconds operator%(Seconds other) const
82     {
83         return Seconds { fmod(m_value, other.value()) };
84     }
85     
86     // Time is a scalar and scalars can be negated as this could arise from algebraic
87     // transformations. So, we allow it.
88     constexpr MonotonicTime operator-() const
89     {
90         return fromRawSeconds(-m_value);
91     }
92     
93     MonotonicTime operator+=(Seconds other)
94     {
95         return *this = *this + other;
96     }
97     
98     MonotonicTime operator-=(Seconds other)
99     {
100         return *this = *this - other;
101     }
102     
103     constexpr Seconds operator-(MonotonicTime other) const
104     {
105         return Seconds(m_value - other.m_value);
106     }
107     
108     constexpr bool operator==(MonotonicTime other) const
109     {
110         return m_value == other.m_value;
111     }
112     
113     constexpr bool operator!=(MonotonicTime other) const
114     {
115         return m_value != other.m_value;
116     }
117     
118     constexpr bool operator<(MonotonicTime other) const
119     {
120         return m_value < other.m_value;
121     }
122     
123     constexpr bool operator>(MonotonicTime other) const
124     {
125         return m_value > other.m_value;
126     }
127     
128     constexpr bool operator<=(MonotonicTime other) const
129     {
130         return m_value <= other.m_value;
131     }
132     
133     constexpr bool operator>=(MonotonicTime other) const
134     {
135         return m_value >= other.m_value;
136     }
137     
138     WTF_EXPORT_PRIVATE void dump(PrintStream&) const;
139
140     MonotonicTime isolatedCopy() const
141     {
142         return *this;
143     }
144 private:
145     constexpr MonotonicTime(double rawValue)
146         : m_value(rawValue)
147     {
148     }
149
150     double m_value { 0 };
151 };
152
153 } // namespace WTF
154
155 namespace std {
156
157 inline bool isnan(WTF::MonotonicTime time)
158 {
159     return std::isnan(time.secondsSinceEpoch().value());
160 }
161
162 inline bool isinf(WTF::MonotonicTime time)
163 {
164     return std::isinf(time.secondsSinceEpoch().value());
165 }
166
167 inline bool isfinite(WTF::MonotonicTime time)
168 {
169     return std::isfinite(time.secondsSinceEpoch().value());
170 }
171
172 } // namespace std
173
174 using WTF::MonotonicTime;
175
176 #endif // WTF_MonotonicTime_h