[python] Replace print operator with print() function for python3 compatibility
[WebKit-https.git] / PerformanceTests / StitchMarker / wtf / WallTime.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_WallTime_h
27 #define WTF_WallTime_h
28
29 #include <wtf/ClockType.h>
30 #include <wtf/Seconds.h>
31
32 namespace WTF {
33
34 class MonotonicTime;
35 class PrintStream;
36
37 // The current time according to a wall clock (aka real time clock). This uses floating point
38 // internally so that you can reason about infinity and other things that arise in math. It's
39 // acceptable to use this to wrap NaN times, negative times, and infinite times, so long as they
40 // are relative to the same clock. Specifically, WallTime should be used in agreement with the
41 // principle that WallTime::now().secondsSinceEpoch().value() is the same as WTF::currentTime().
42 class WallTime {
43 public:
44     static const ClockType clockType = ClockType::Wall;
45     
46     // This is the epoch. So, x.secondsSinceEpoch() should be the same as x - WallTime().
47     WallTime() { }
48     
49     // Call this if you know for sure that the double represents time according to
50     // WTF::currentTime(). It must be in seconds and it must be from the same time source.
51     static WallTime fromRawSeconds(double value)
52     {
53         WallTime result;
54         result.m_value = value;
55         return result;
56     }
57     
58     WTF_EXPORT_PRIVATE static WallTime now();
59     
60     static WallTime infinity() { return fromRawSeconds(std::numeric_limits<double>::infinity()); }
61     
62     Seconds secondsSinceEpoch() const { return Seconds(m_value); }
63     
64     WallTime approximateWallTime() const { return *this; }
65     WTF_EXPORT_PRIVATE MonotonicTime approximateMonotonicTime() const;
66     
67     explicit operator bool() const { return !!m_value; }
68     
69     WallTime operator+(Seconds other) const
70     {
71         return fromRawSeconds(m_value + other.value());
72     }
73     
74     WallTime operator-(Seconds other) const
75     {
76         return fromRawSeconds(m_value - other.value());
77     }
78     
79     // Time is a scalar and scalars can be negated as this could arise from algebraic
80     // transformations. So, we allow it.
81     WallTime operator-() const
82     {
83         return fromRawSeconds(-m_value);
84     }
85     
86     WallTime& operator+=(Seconds other)
87     {
88         return *this = *this + other;
89     }
90     
91     WallTime& operator-=(Seconds other)
92     {
93         return *this = *this - other;
94     }
95     
96     Seconds operator-(WallTime other) const
97     {
98         return Seconds(m_value - other.m_value);
99     }
100     
101     bool operator==(WallTime other) const
102     {
103         return m_value == other.m_value;
104     }
105     
106     bool operator!=(WallTime other) const
107     {
108         return m_value != other.m_value;
109     }
110     
111     bool operator<(WallTime other) const
112     {
113         return m_value < other.m_value;
114     }
115     
116     bool operator>(WallTime other) const
117     {
118         return m_value > other.m_value;
119     }
120     
121     bool operator<=(WallTime other) const
122     {
123         return m_value <= other.m_value;
124     }
125     
126     bool operator>=(WallTime other) const
127     {
128         return m_value >= other.m_value;
129     }
130     
131     WTF_EXPORT_PRIVATE void dump(PrintStream&) const;
132     
133 private:
134     double m_value { 0 };
135 };
136
137 WTF_EXPORT_PRIVATE void sleep(WallTime);
138
139 } // namespace WTF
140
141 namespace std {
142
143 inline bool isnan(WTF::WallTime time)
144 {
145     return std::isnan(time.secondsSinceEpoch().value());
146 }
147
148 inline bool isinf(WTF::WallTime time)
149 {
150     return std::isinf(time.secondsSinceEpoch().value());
151 }
152
153 inline bool isfinite(WTF::WallTime time)
154 {
155     return std::isfinite(time.secondsSinceEpoch().value());
156 }
157
158 } // namespace std
159
160 using WTF::WallTime;
161
162 #endif // WTF_WallTime_h