summaryrefslogtreecommitdiff
path: root/Source/WTF/wtf/Seconds.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/WTF/wtf/Seconds.h')
-rw-r--r--Source/WTF/wtf/Seconds.h265
1 files changed, 265 insertions, 0 deletions
diff --git a/Source/WTF/wtf/Seconds.h b/Source/WTF/wtf/Seconds.h
new file mode 100644
index 000000000..5b8a7a369
--- /dev/null
+++ b/Source/WTF/wtf/Seconds.h
@@ -0,0 +1,265 @@
+/*
+ * Copyright (C) 2016 Apple Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef WTF_Seconds_h
+#define WTF_Seconds_h
+
+#include <wtf/MathExtras.h>
+
+namespace WTF {
+
+class MonotonicTime;
+class PrintStream;
+class TimeWithDynamicClockType;
+class WallTime;
+
+class Seconds {
+public:
+ Seconds() { }
+
+ explicit constexpr Seconds(double value)
+ : m_value(value)
+ {
+ }
+
+ double value() const { return m_value; }
+
+ double minutes() const { return m_value / 60; }
+ double seconds() const { return m_value; }
+ double milliseconds() const { return seconds() * 1000; }
+ double microseconds() const { return milliseconds() * 1000; }
+ double nanoseconds() const { return microseconds() * 1000; }
+
+ static constexpr Seconds fromMinutes(double minutes)
+ {
+ return Seconds(minutes * 60);
+ }
+
+ static constexpr Seconds fromMilliseconds(double milliseconds)
+ {
+ return Seconds(milliseconds / 1000);
+ }
+
+ static constexpr Seconds fromMicroseconds(double microseconds)
+ {
+ return fromMilliseconds(microseconds / 1000);
+ }
+
+ static constexpr Seconds fromNanoseconds(double nanoseconds)
+ {
+ return fromMicroseconds(nanoseconds / 1000);
+ }
+
+ static constexpr Seconds infinity()
+ {
+ return Seconds(std::numeric_limits<double>::infinity());
+ }
+
+ explicit operator bool() const { return !!m_value; }
+
+ Seconds operator+(Seconds other) const
+ {
+ return Seconds(value() + other.value());
+ }
+
+ Seconds operator-(Seconds other) const
+ {
+ return Seconds(value() - other.value());
+ }
+
+ Seconds operator-() const
+ {
+ return Seconds(-value());
+ }
+
+ // It makes sense to consider scaling a duration, like, "I want to wait 5 times as long as
+ // last time!".
+ Seconds operator*(double scalar) const
+ {
+ return Seconds(value() * scalar);
+ }
+
+ Seconds operator/(double scalar) const
+ {
+ return Seconds(value() / scalar);
+ }
+
+ // It's reasonable to think about ratios between Seconds.
+ double operator/(Seconds other) const
+ {
+ return value() / other.value();
+ }
+
+ Seconds operator%(double scalar) const
+ {
+ return Seconds(fmod(value(), scalar));
+ }
+
+ // This solves for r, where:
+ //
+ // floor(this / other) + r / other = this / other
+ //
+ // Therefore, if this is Seconds then r is Seconds.
+ Seconds operator%(Seconds other) const
+ {
+ return Seconds(fmod(value(), other.value()));
+ }
+
+ Seconds& operator+=(Seconds other)
+ {
+ return *this = *this + other;
+ }
+
+ Seconds& operator-=(Seconds other)
+ {
+ return *this = *this - other;
+ }
+
+ Seconds& operator*=(double scalar)
+ {
+ return *this = *this * scalar;
+ }
+
+ Seconds& operator/=(double scalar)
+ {
+ return *this = *this / scalar;
+ }
+
+ Seconds& operator%=(double scalar)
+ {
+ return *this = *this % scalar;
+ }
+
+ Seconds& operator%=(Seconds other)
+ {
+ return *this = *this % other;
+ }
+
+ WTF_EXPORT_PRIVATE WallTime operator+(WallTime) const;
+ WTF_EXPORT_PRIVATE MonotonicTime operator+(MonotonicTime) const;
+ WTF_EXPORT_PRIVATE TimeWithDynamicClockType operator+(const TimeWithDynamicClockType&) const;
+
+ WTF_EXPORT_PRIVATE WallTime operator-(WallTime) const;
+ WTF_EXPORT_PRIVATE MonotonicTime operator-(MonotonicTime) const;
+ WTF_EXPORT_PRIVATE TimeWithDynamicClockType operator-(const TimeWithDynamicClockType&) const;
+
+ bool operator==(Seconds other) const
+ {
+ return m_value == other.m_value;
+ }
+
+ bool operator!=(Seconds other) const
+ {
+ return m_value != other.m_value;
+ }
+
+ bool operator<(Seconds other) const
+ {
+ return m_value < other.m_value;
+ }
+
+ bool operator>(Seconds other) const
+ {
+ return m_value > other.m_value;
+ }
+
+ bool operator<=(Seconds other) const
+ {
+ return m_value <= other.m_value;
+ }
+
+ bool operator>=(Seconds other) const
+ {
+ return m_value >= other.m_value;
+ }
+
+ WTF_EXPORT_PRIVATE void dump(PrintStream&) const;
+
+private:
+ double m_value { 0 };
+};
+
+inline namespace seconds_literals {
+
+constexpr Seconds operator"" _min(long double minutes)
+{
+ return Seconds::fromMinutes(minutes);
+}
+
+constexpr Seconds operator"" _s(long double seconds)
+{
+ return Seconds(seconds);
+}
+
+constexpr Seconds operator"" _ms(long double milliseconds)
+{
+ return Seconds::fromMilliseconds(milliseconds);
+}
+
+constexpr Seconds operator"" _us(long double microseconds)
+{
+ return Seconds::fromMicroseconds(microseconds);
+}
+
+constexpr Seconds operator"" _ns(long double nanoseconds)
+{
+ return Seconds::fromNanoseconds(nanoseconds);
+}
+
+constexpr Seconds operator"" _min(unsigned long long minutes)
+{
+ return Seconds::fromMinutes(minutes);
+}
+
+constexpr Seconds operator"" _s(unsigned long long seconds)
+{
+ return Seconds(seconds);
+}
+
+constexpr Seconds operator"" _ms(unsigned long long milliseconds)
+{
+ return Seconds::fromMilliseconds(milliseconds);
+}
+
+constexpr Seconds operator"" _us(unsigned long long microseconds)
+{
+ return Seconds::fromMicroseconds(microseconds);
+}
+
+constexpr Seconds operator"" _ns(unsigned long long nanoseconds)
+{
+ return Seconds::fromNanoseconds(nanoseconds);
+}
+
+} // inline seconds_literals
+
+WTF_EXPORT_PRIVATE void sleep(Seconds);
+
+} // namespace WTF
+
+using namespace WTF::seconds_literals;
+using WTF::Seconds;
+
+#endif // WTF_Seconds_h