OpenShot Library | libopenshot-audio  0.2.0
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 (const int milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
32 RelativeTime RelativeTime::milliseconds (const int64 milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
33 RelativeTime RelativeTime::seconds (double s) noexcept { return RelativeTime (s); }
34 RelativeTime RelativeTime::minutes (const double numberOfMinutes) noexcept { return RelativeTime (numberOfMinutes * 60.0); }
35 RelativeTime RelativeTime::hours (const double numberOfHours) noexcept { return RelativeTime (numberOfHours * (60.0 * 60.0)); }
36 RelativeTime RelativeTime::days (const double numberOfDays) noexcept { return RelativeTime (numberOfDays * (60.0 * 60.0 * 24.0)); }
37 RelativeTime RelativeTime::weeks (const 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+= (const double secs) noexcept { numSeconds += secs; return *this; }
52 RelativeTime RelativeTime::operator-= (const 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 void translateTimeField (String& result, int n, const char* singular, const char* plural)
66 {
67  result << TRANS (n == 1 ? singular : plural)
68  .replace (n == 1 ? "1" : "2", String (n))
69  << ' ';
70 }
71 
72 String RelativeTime::getDescription (const String& returnValueForZeroTime) const
73 {
74  if (numSeconds < 0.001 && numSeconds > -0.001)
75  return returnValueForZeroTime;
76 
77  String result;
78  result.preallocateBytes (32);
79 
80  if (numSeconds < 0)
81  result << '-';
82 
83  int fieldsShown = 0;
84  int n = std::abs ((int) inWeeks());
85  if (n > 0)
86  {
87  translateTimeField (result, n, NEEDS_TRANS("1 week"), NEEDS_TRANS("2 weeks"));
88  ++fieldsShown;
89  }
90 
91  n = std::abs ((int) inDays()) % 7;
92  if (n > 0)
93  {
94  translateTimeField (result, n, NEEDS_TRANS("1 day"), NEEDS_TRANS("2 days"));
95  ++fieldsShown;
96  }
97 
98  if (fieldsShown < 2)
99  {
100  n = std::abs ((int) inHours()) % 24;
101  if (n > 0)
102  {
103  translateTimeField (result, n, NEEDS_TRANS("1 hr"), NEEDS_TRANS("2 hrs"));
104  ++fieldsShown;
105  }
106 
107  if (fieldsShown < 2)
108  {
109  n = std::abs ((int) inMinutes()) % 60;
110  if (n > 0)
111  {
112  translateTimeField (result, n, NEEDS_TRANS("1 min"), NEEDS_TRANS("2 mins"));
113  ++fieldsShown;
114  }
115 
116  if (fieldsShown < 2)
117  {
118  n = std::abs ((int) inSeconds()) % 60;
119  if (n > 0)
120  {
121  translateTimeField (result, n, NEEDS_TRANS("1 sec"), NEEDS_TRANS("2 secs"));
122  ++fieldsShown;
123  }
124 
125  if (fieldsShown == 0)
126  {
127  n = std::abs ((int) inMilliseconds()) % 1000;
128  if (n > 0)
129  result << n << ' ' << TRANS ("ms");
130  }
131  }
132  }
133  }
134 
135  return result.trimEnd();
136 }
137 
138 } // namespace juce
juce::RelativeTime::seconds
static RelativeTime seconds(double seconds) noexcept
Creates a new RelativeTime object representing a number of seconds.
Definition: juce_RelativeTime.cpp:33
juce::RelativeTime::inSeconds
double inSeconds() const noexcept
Returns the number of seconds this time represents.
Definition: juce_RelativeTime.h:105
juce::RelativeTime::days
static RelativeTime days(double numberOfDays) noexcept
Creates a new RelativeTime object representing a number of days.
Definition: juce_RelativeTime.cpp:36
juce::RelativeTime::operator+=
RelativeTime operator+=(RelativeTime timeToAdd) noexcept
Adds another RelativeTime to this one.
Definition: juce_RelativeTime.cpp:49
juce::RelativeTime::inWeeks
double inWeeks() const noexcept
Returns the number of weeks this time represents.
Definition: juce_RelativeTime.cpp:44
juce::RelativeTime::~RelativeTime
~RelativeTime() noexcept
Destructor.
Definition: juce_RelativeTime.cpp:28
juce::RelativeTime::inMilliseconds
int64 inMilliseconds() const noexcept
Returns the number of milliseconds this time represents.
Definition: juce_RelativeTime.cpp:40
juce::RelativeTime::weeks
static RelativeTime weeks(double numberOfWeeks) noexcept
Creates a new RelativeTime object representing a number of weeks.
Definition: juce_RelativeTime.cpp:37
juce::RelativeTime::operator-=
RelativeTime operator-=(RelativeTime timeToSubtract) noexcept
Subtracts another RelativeTime from this one.
Definition: juce_RelativeTime.cpp:50
juce::RelativeTime
A relative measure of time.
Definition: juce_RelativeTime.h:40
juce::RelativeTime::getDescription
String getDescription(const String &returnValueForZeroTime="0") const
Returns a readable textual description of the time.
Definition: juce_RelativeTime.cpp:72
JUCE_API
#define JUCE_API
This macro is added to all JUCE public class declarations.
Definition: juce_StandardHeader.h:143
juce::RelativeTime::hours
static RelativeTime hours(double numberOfHours) noexcept
Creates a new RelativeTime object representing a number of hours.
Definition: juce_RelativeTime.cpp:35
juce::RelativeTime::inDays
double inDays() const noexcept
Returns the number of days this time represents.
Definition: juce_RelativeTime.cpp:43
juce::RelativeTime::minutes
static RelativeTime minutes(double numberOfMinutes) noexcept
Creates a new RelativeTime object representing a number of minutes.
Definition: juce_RelativeTime.cpp:34
juce::String::preallocateBytes
void preallocateBytes(size_t numBytesNeeded)
Increases the string's internally allocated storage.
Definition: juce_String.cpp:291
juce::RelativeTime::inMinutes
double inMinutes() const noexcept
Returns the number of minutes this time represents.
Definition: juce_RelativeTime.cpp:41
juce::RelativeTime::operator=
RelativeTime & operator=(const RelativeTime &other) noexcept
Copies another relative time.
Definition: juce_RelativeTime.cpp:47
juce::RelativeTime::RelativeTime
RelativeTime(double seconds=0.0) noexcept
Creates a RelativeTime.
Definition: juce_RelativeTime.cpp:26
juce::String
The JUCE String class!
Definition: juce_String.h:42
juce::String::trimEnd
String trimEnd() const
Returns a copy of this string with any whitespace characters removed from the end.
Definition: juce_String.cpp:1693
juce::RelativeTime::inHours
double inHours() const noexcept
Returns the number of hours this time represents.
Definition: juce_RelativeTime.cpp:42
juce::RelativeTime::milliseconds
static RelativeTime milliseconds(int milliseconds) noexcept
Creates a new RelativeTime object representing a number of milliseconds.
Definition: juce_RelativeTime.cpp:31