OpenShot Library | OpenShotAudio 0.2.2
juce_RelativeTime.cpp
1/*
2 ==============================================================================
3
4 This file is part of the JUCE library.
5 Copyright (c) 2017 - ROLI Ltd.
6
7 JUCE is an open source library subject to commercial or open-source
8 licensing.
9
10 The code included in this file is provided under the terms of the ISC license
11 http://www.isc.org/downloads/software-support-policy/isc-license. Permission
12 To use, copy, modify, and/or distribute this software for any purpose with or
13 without fee is hereby granted provided that the above copyright notice and
14 this permission notice appear in all copies.
15
16 JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
17 EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
18 DISCLAIMED.
19
20 ==============================================================================
21*/
22
23namespace juce
24{
25
26RelativeTime::RelativeTime (const double secs) noexcept : numSeconds (secs) {}
27RelativeTime::RelativeTime (const RelativeTime& other) noexcept : numSeconds (other.numSeconds) {}
29
30//==============================================================================
31RelativeTime RelativeTime::milliseconds (int milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
32RelativeTime RelativeTime::milliseconds (int64 milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
33RelativeTime RelativeTime::seconds (double s) noexcept { return RelativeTime (s); }
34RelativeTime RelativeTime::minutes (double numberOfMinutes) noexcept { return RelativeTime (numberOfMinutes * 60.0); }
35RelativeTime RelativeTime::hours (double numberOfHours) noexcept { return RelativeTime (numberOfHours * (60.0 * 60.0)); }
36RelativeTime RelativeTime::days (double numberOfDays) noexcept { return RelativeTime (numberOfDays * (60.0 * 60.0 * 24.0)); }
37RelativeTime RelativeTime::weeks (double numberOfWeeks) noexcept { return RelativeTime (numberOfWeeks * (60.0 * 60.0 * 24.0 * 7.0)); }
38
39//==============================================================================
40int64 RelativeTime::inMilliseconds() const noexcept { return (int64) (numSeconds * 1000.0); }
41double RelativeTime::inMinutes() const noexcept { return numSeconds / 60.0; }
42double RelativeTime::inHours() const noexcept { return numSeconds / (60.0 * 60.0); }
43double RelativeTime::inDays() const noexcept { return numSeconds / (60.0 * 60.0 * 24.0); }
44double RelativeTime::inWeeks() const noexcept { return numSeconds / (60.0 * 60.0 * 24.0 * 7.0); }
45
46//==============================================================================
47RelativeTime& RelativeTime::operator= (const RelativeTime& other) noexcept { numSeconds = other.numSeconds; return *this; }
48
49RelativeTime RelativeTime::operator+= (RelativeTime t) noexcept { numSeconds += t.numSeconds; return *this; }
50RelativeTime RelativeTime::operator-= (RelativeTime t) noexcept { numSeconds -= t.numSeconds; return *this; }
51RelativeTime RelativeTime::operator+= (double secs) noexcept { numSeconds += secs; return *this; }
52RelativeTime RelativeTime::operator-= (double secs) noexcept { numSeconds -= secs; return *this; }
53
54JUCE_API RelativeTime JUCE_CALLTYPE operator+ (RelativeTime t1, RelativeTime t2) noexcept { return t1 += t2; }
55JUCE_API RelativeTime JUCE_CALLTYPE operator- (RelativeTime t1, RelativeTime t2) noexcept { return t1 -= t2; }
56
57JUCE_API bool JUCE_CALLTYPE operator== (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() == t2.inSeconds(); }
58JUCE_API bool JUCE_CALLTYPE operator!= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() != t2.inSeconds(); }
59JUCE_API bool JUCE_CALLTYPE operator> (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() > t2.inSeconds(); }
60JUCE_API bool JUCE_CALLTYPE operator< (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() < t2.inSeconds(); }
61JUCE_API bool JUCE_CALLTYPE operator>= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() >= t2.inSeconds(); }
62JUCE_API bool JUCE_CALLTYPE operator<= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() <= t2.inSeconds(); }
63
64//==============================================================================
65static String translateTimeField (int n, const char* singular, const char* plural)
66{
67 return TRANS (n == 1 ? singular : plural).replace (n == 1 ? "1" : "2", String (n));
68}
69
70static String describeYears (int n) { return translateTimeField (n, NEEDS_TRANS("1 year"), NEEDS_TRANS("2 years")); }
71static String describeMonths (int n) { return translateTimeField (n, NEEDS_TRANS("1 month"), NEEDS_TRANS("2 months")); }
72static String describeWeeks (int n) { return translateTimeField (n, NEEDS_TRANS("1 week"), NEEDS_TRANS("2 weeks")); }
73static String describeDays (int n) { return translateTimeField (n, NEEDS_TRANS("1 day"), NEEDS_TRANS("2 days")); }
74static String describeHours (int n) { return translateTimeField (n, NEEDS_TRANS("1 hr"), NEEDS_TRANS("2 hrs")); }
75static String describeMinutes (int n) { return translateTimeField (n, NEEDS_TRANS("1 min"), NEEDS_TRANS("2 mins")); }
76static String describeSeconds (int n) { return translateTimeField (n, NEEDS_TRANS("1 sec"), NEEDS_TRANS("2 secs")); }
77
79{
80 if (numSeconds <= 1.0)
81 return "< 1 sec";
82
83 auto weeks = (int) inWeeks();
84
85 if (weeks > 52) return describeYears (weeks / 52);
86 if (weeks > 8) return describeMonths ((weeks * 12) / 52);
87 if (weeks > 1) return describeWeeks (weeks);
88
89 auto days = (int) inWeeks();
90
91 if (days > 1)
92 return describeDays (days);
93
94 auto hours = (int) inHours();
95
96 if (hours > 0)
97 return describeHours (hours);
98
99 auto minutes = (int) inMinutes();
100
101 if (minutes > 0)
102 return describeMinutes (minutes);
103
104 return describeSeconds ((int) numSeconds);
105}
106
107String RelativeTime::getDescription (const String& returnValueForZeroTime) const
108{
109 if (std::abs (numSeconds) < 0.001)
110 return returnValueForZeroTime;
111
112 if (numSeconds < 0)
113 return "-" + RelativeTime (-numSeconds).getDescription();
114
115 StringArray fields;
116
117 auto n = (int) inWeeks();
118
119 if (n > 0)
120 fields.add (describeWeeks (n));
121
122 n = ((int) inDays()) % 7;
123
124 if (n > 0)
125 fields.add (describeDays (n));
126
127 if (fields.size() < 2)
128 {
129 n = ((int) inHours()) % 24;
130
131 if (n > 0)
132 fields.add (describeHours (n));
133
134 if (fields.size() < 2)
135 {
136 n = ((int) inMinutes()) % 60;
137
138 if (n > 0)
139 fields.add (describeMinutes (n));
140
141 if (fields.size() < 2)
142 {
143 n = ((int) inSeconds()) % 60;
144
145 if (n > 0)
146 fields.add (describeSeconds (n));
147
148 if (fields.isEmpty())
149 fields.add (String (((int) inMilliseconds()) % 1000) + " " + TRANS ("ms"));
150 }
151 }
152 }
153
154 return fields.joinIntoString (" ");
155}
156
157} // namespace juce
A relative measure of time.
int64 inMilliseconds() const noexcept
Returns the number of milliseconds this time represents.
static RelativeTime minutes(double numberOfMinutes) noexcept
Creates a new RelativeTime object representing a number of minutes.
double inWeeks() const noexcept
Returns the number of weeks this time represents.
String getDescription(const String &returnValueForZeroTime="0") const
Returns a readable textual description of the time.
double inDays() const noexcept
Returns the number of days this time represents.
double inHours() const noexcept
Returns the number of hours this time represents.
static RelativeTime milliseconds(int milliseconds) noexcept
Creates a new RelativeTime object representing a number of milliseconds.
double inSeconds() const noexcept
Returns the number of seconds this time represents.
~RelativeTime() noexcept
Destructor.
static RelativeTime hours(double numberOfHours) noexcept
Creates a new RelativeTime object representing a number of hours.
static RelativeTime days(double numberOfDays) noexcept
Creates a new RelativeTime object representing a number of days.
RelativeTime & operator=(const RelativeTime &other) noexcept
Copies another relative time.
RelativeTime operator+=(RelativeTime timeToAdd) noexcept
Adds another RelativeTime to this one.
RelativeTime operator-=(RelativeTime timeToSubtract) noexcept
Subtracts another RelativeTime from this one.
String getApproximateDescription() const
This returns a string that roughly describes how long ago this time was, which can be handy for showi...
static RelativeTime weeks(double numberOfWeeks) noexcept
Creates a new RelativeTime object representing a number of weeks.
static RelativeTime seconds(double seconds) noexcept
Creates a new RelativeTime object representing a number of seconds.
RelativeTime(double seconds=0.0) noexcept
Creates a RelativeTime.
double inMinutes() const noexcept
Returns the number of minutes this time represents.
A special array for holding a list of strings.
String joinIntoString(StringRef separatorString, int startIndex=0, int numberOfElements=-1) const
Joins the strings in the array together into one string.
int size() const noexcept
Returns the number of strings in the array.
void add(String stringToAdd)
Appends a string at the end of the array.
bool isEmpty() const noexcept
Returns true if the array is empty, false otherwise.
The JUCE String class!
Definition: juce_String.h:43
#define JUCE_API
This macro is added to all JUCE public class declarations.