OpenShot Audio Library | OpenShotAudio  0.3.3
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 
23 namespace juce
24 {
25 
26 RelativeTime::RelativeTime (const double secs) noexcept : numSeconds (secs) {}
27 RelativeTime::RelativeTime (const RelativeTime& other) noexcept : numSeconds (other.numSeconds) {}
29 
30 //==============================================================================
31 RelativeTime RelativeTime::milliseconds (int milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
32 RelativeTime RelativeTime::milliseconds (int64 milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
33 RelativeTime RelativeTime::seconds (double s) noexcept { return RelativeTime (s); }
34 RelativeTime RelativeTime::minutes (double numberOfMinutes) noexcept { return RelativeTime (numberOfMinutes * 60.0); }
35 RelativeTime RelativeTime::hours (double numberOfHours) noexcept { return RelativeTime (numberOfHours * (60.0 * 60.0)); }
36 RelativeTime RelativeTime::days (double numberOfDays) noexcept { return RelativeTime (numberOfDays * (60.0 * 60.0 * 24.0)); }
37 RelativeTime RelativeTime::weeks (double numberOfWeeks) noexcept { return RelativeTime (numberOfWeeks * (60.0 * 60.0 * 24.0 * 7.0)); }
38 
39 //==============================================================================
40 int64 RelativeTime::inMilliseconds() const noexcept { return (int64) (numSeconds * 1000.0); }
41 double RelativeTime::inMinutes() const noexcept { return numSeconds / 60.0; }
42 double RelativeTime::inHours() const noexcept { return numSeconds / (60.0 * 60.0); }
43 double RelativeTime::inDays() const noexcept { return numSeconds / (60.0 * 60.0 * 24.0); }
44 double RelativeTime::inWeeks() const noexcept { return numSeconds / (60.0 * 60.0 * 24.0 * 7.0); }
45 
46 //==============================================================================
47 RelativeTime& RelativeTime::operator= (const RelativeTime& other) noexcept { numSeconds = other.numSeconds; return *this; }
48 
49 RelativeTime RelativeTime::operator+= (RelativeTime t) noexcept { numSeconds += t.numSeconds; return *this; }
50 RelativeTime RelativeTime::operator-= (RelativeTime t) noexcept { numSeconds -= t.numSeconds; return *this; }
51 RelativeTime RelativeTime::operator+= (double secs) noexcept { numSeconds += secs; return *this; }
52 RelativeTime RelativeTime::operator-= (double secs) noexcept { numSeconds -= secs; return *this; }
53 
54 JUCE_API RelativeTime JUCE_CALLTYPE operator+ (RelativeTime t1, RelativeTime t2) noexcept { return t1 += t2; }
55 JUCE_API RelativeTime JUCE_CALLTYPE operator- (RelativeTime t1, RelativeTime t2) noexcept { return t1 -= t2; }
56 
57 JUCE_API bool JUCE_CALLTYPE operator== (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() == t2.inSeconds(); }
58 JUCE_API bool JUCE_CALLTYPE operator!= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() != t2.inSeconds(); }
59 JUCE_API bool JUCE_CALLTYPE operator> (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() > t2.inSeconds(); }
60 JUCE_API bool JUCE_CALLTYPE operator< (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() < t2.inSeconds(); }
61 JUCE_API bool JUCE_CALLTYPE operator>= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() >= t2.inSeconds(); }
62 JUCE_API bool JUCE_CALLTYPE operator<= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() <= t2.inSeconds(); }
63 
64 //==============================================================================
65 static 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 
70 static String describeYears (int n) { return translateTimeField (n, NEEDS_TRANS("1 year"), NEEDS_TRANS("2 years")); }
71 static String describeMonths (int n) { return translateTimeField (n, NEEDS_TRANS("1 month"), NEEDS_TRANS("2 months")); }
72 static String describeWeeks (int n) { return translateTimeField (n, NEEDS_TRANS("1 week"), NEEDS_TRANS("2 weeks")); }
73 static String describeDays (int n) { return translateTimeField (n, NEEDS_TRANS("1 day"), NEEDS_TRANS("2 days")); }
74 static String describeHours (int n) { return translateTimeField (n, NEEDS_TRANS("1 hr"), NEEDS_TRANS("2 hrs")); }
75 static String describeMinutes (int n) { return translateTimeField (n, NEEDS_TRANS("1 min"), NEEDS_TRANS("2 mins")); }
76 static 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 
107 String 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
int64 inMilliseconds() const noexcept
static RelativeTime minutes(double numberOfMinutes) noexcept
double inWeeks() const noexcept
String getDescription(const String &returnValueForZeroTime="0") const
double inDays() const noexcept
double inHours() const noexcept
static RelativeTime milliseconds(int milliseconds) noexcept
double inSeconds() const noexcept
static RelativeTime hours(double numberOfHours) noexcept
static RelativeTime days(double numberOfDays) noexcept
RelativeTime & operator=(const RelativeTime &other) noexcept
RelativeTime operator+=(RelativeTime timeToAdd) noexcept
RelativeTime operator-=(RelativeTime timeToSubtract) noexcept
String getApproximateDescription() const
static RelativeTime weeks(double numberOfWeeks) noexcept
static RelativeTime seconds(double seconds) noexcept
RelativeTime(double seconds=0.0) noexcept
double inMinutes() const noexcept
String joinIntoString(StringRef separatorString, int startIndex=0, int numberOfElements=-1) const
int size() const noexcept
void add(String stringToAdd)
bool isEmpty() const noexcept