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 
RelativeTime(const double secs)26 RelativeTime::RelativeTime (const double secs) noexcept           : numSeconds (secs) {}
RelativeTime(const RelativeTime & other)27 RelativeTime::RelativeTime (const RelativeTime& other) noexcept   : numSeconds (other.numSeconds) {}
~RelativeTime()28 RelativeTime::~RelativeTime() noexcept {}
29 
30 //==============================================================================
milliseconds(int milliseconds)31 RelativeTime RelativeTime::milliseconds (int milliseconds) noexcept         { return RelativeTime (milliseconds * 0.001); }
milliseconds(int64 milliseconds)32 RelativeTime RelativeTime::milliseconds (int64 milliseconds) noexcept       { return RelativeTime (milliseconds * 0.001); }
seconds(double s)33 RelativeTime RelativeTime::seconds (double s) noexcept                      { return RelativeTime (s); }
minutes(double numberOfMinutes)34 RelativeTime RelativeTime::minutes (double numberOfMinutes) noexcept        { return RelativeTime (numberOfMinutes * 60.0); }
hours(double numberOfHours)35 RelativeTime RelativeTime::hours (double numberOfHours) noexcept            { return RelativeTime (numberOfHours * (60.0 * 60.0)); }
days(double numberOfDays)36 RelativeTime RelativeTime::days (double numberOfDays) noexcept              { return RelativeTime (numberOfDays  * (60.0 * 60.0 * 24.0)); }
weeks(double numberOfWeeks)37 RelativeTime RelativeTime::weeks (double numberOfWeeks) noexcept            { return RelativeTime (numberOfWeeks * (60.0 * 60.0 * 24.0 * 7.0)); }
38 
39 //==============================================================================
inMilliseconds() const40 int64 RelativeTime::inMilliseconds() const noexcept { return (int64) (numSeconds * 1000.0); }
inMinutes() const41 double RelativeTime::inMinutes() const noexcept     { return numSeconds / 60.0; }
inHours() const42 double RelativeTime::inHours() const noexcept       { return numSeconds / (60.0 * 60.0); }
inDays() const43 double RelativeTime::inDays() const noexcept        { return numSeconds / (60.0 * 60.0 * 24.0); }
inWeeks() const44 double RelativeTime::inWeeks() const noexcept       { return numSeconds / (60.0 * 60.0 * 24.0 * 7.0); }
45 
46 //==============================================================================
operator =(const RelativeTime & other)47 RelativeTime& RelativeTime::operator= (const RelativeTime& other) noexcept      { numSeconds = other.numSeconds; return *this; }
48 
operator +=(RelativeTime t)49 RelativeTime RelativeTime::operator+= (RelativeTime t) noexcept     { numSeconds += t.numSeconds; return *this; }
operator -=(RelativeTime t)50 RelativeTime RelativeTime::operator-= (RelativeTime t) noexcept     { numSeconds -= t.numSeconds; return *this; }
operator +=(double secs)51 RelativeTime RelativeTime::operator+= (double secs) noexcept        { numSeconds += secs; return *this; }
operator -=(double secs)52 RelativeTime RelativeTime::operator-= (double secs) noexcept        { numSeconds -= secs; return *this; }
53 
operator +(RelativeTime t1,RelativeTime t2)54 JUCE_API RelativeTime JUCE_CALLTYPE operator+ (RelativeTime t1, RelativeTime t2) noexcept  { return t1 += t2; }
operator -(RelativeTime t1,RelativeTime t2)55 JUCE_API RelativeTime JUCE_CALLTYPE operator- (RelativeTime t1, RelativeTime t2) noexcept  { return t1 -= t2; }
56 
operator ==(RelativeTime t1,RelativeTime t2)57 JUCE_API bool JUCE_CALLTYPE operator== (RelativeTime t1, RelativeTime t2) noexcept       { return t1.inSeconds() == t2.inSeconds(); }
operator !=(RelativeTime t1,RelativeTime t2)58 JUCE_API bool JUCE_CALLTYPE operator!= (RelativeTime t1, RelativeTime t2) noexcept       { return t1.inSeconds() != t2.inSeconds(); }
operator >(RelativeTime t1,RelativeTime t2)59 JUCE_API bool JUCE_CALLTYPE operator>  (RelativeTime t1, RelativeTime t2) noexcept       { return t1.inSeconds() >  t2.inSeconds(); }
operator <(RelativeTime t1,RelativeTime t2)60 JUCE_API bool JUCE_CALLTYPE operator<  (RelativeTime t1, RelativeTime t2) noexcept       { return t1.inSeconds() <  t2.inSeconds(); }
operator >=(RelativeTime t1,RelativeTime t2)61 JUCE_API bool JUCE_CALLTYPE operator>= (RelativeTime t1, RelativeTime t2) noexcept       { return t1.inSeconds() >= t2.inSeconds(); }
operator <=(RelativeTime t1,RelativeTime t2)62 JUCE_API bool JUCE_CALLTYPE operator<= (RelativeTime t1, RelativeTime t2) noexcept       { return t1.inSeconds() <= t2.inSeconds(); }
63 
64 //==============================================================================
translateTimeField(int n,const char * singular,const char * plural)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 
describeYears(int n)70 static String describeYears   (int n)      { return translateTimeField (n, NEEDS_TRANS("1 year"),  NEEDS_TRANS("2 years")); }
describeMonths(int n)71 static String describeMonths  (int n)      { return translateTimeField (n, NEEDS_TRANS("1 month"), NEEDS_TRANS("2 months")); }
describeWeeks(int n)72 static String describeWeeks   (int n)      { return translateTimeField (n, NEEDS_TRANS("1 week"),  NEEDS_TRANS("2 weeks")); }
describeDays(int n)73 static String describeDays    (int n)      { return translateTimeField (n, NEEDS_TRANS("1 day"),   NEEDS_TRANS("2 days")); }
describeHours(int n)74 static String describeHours   (int n)      { return translateTimeField (n, NEEDS_TRANS("1 hr"),    NEEDS_TRANS("2 hrs")); }
describeMinutes(int n)75 static String describeMinutes (int n)      { return translateTimeField (n, NEEDS_TRANS("1 min"),   NEEDS_TRANS("2 mins")); }
describeSeconds(int n)76 static String describeSeconds (int n)      { return translateTimeField (n, NEEDS_TRANS("1 sec"),   NEEDS_TRANS("2 secs")); }
77 
getApproximateDescription() const78 String RelativeTime::getApproximateDescription() const
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 
getDescription(const String & returnValueForZeroTime) const107 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
158