- port to minGw
git-svn-id: http://moon:8086/svn/software/trunk/projects/JaySynth@235 b431acfa-c32f-4a4a-93f1-934dc6c82436
This commit is contained in:
@@ -0,0 +1,132 @@
|
||||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the juce_core module of the JUCE library.
|
||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any purpose with
|
||||
or without fee is hereby granted, provided that the above copyright notice and this
|
||||
permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
|
||||
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
|
||||
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
||||
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
|
||||
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
|
||||
All other JUCE modules are covered by a dual GPL/commercial license, so if you are
|
||||
using any other modules, be sure to check that you also comply with their license.
|
||||
|
||||
For more details, visit www.juce.com
|
||||
|
||||
==============================================================================
|
||||
*/
|
||||
|
||||
static void appendToFile (const File& f, const String& s)
|
||||
{
|
||||
if (f.getFullPathName().isNotEmpty())
|
||||
{
|
||||
FileOutputStream out (f);
|
||||
|
||||
if (! out.failedToOpen())
|
||||
out << s << newLine;
|
||||
}
|
||||
}
|
||||
|
||||
PerformanceCounter::PerformanceCounter (const String& name, int runsPerPrintout, const File& loggingFile)
|
||||
: runsPerPrint (runsPerPrintout), startTime (0), outputFile (loggingFile)
|
||||
{
|
||||
stats.name = name;
|
||||
appendToFile (outputFile, "**** Counter for \"" + name + "\" started at: " + Time::getCurrentTime().toString (true, true));
|
||||
}
|
||||
|
||||
PerformanceCounter::~PerformanceCounter()
|
||||
{
|
||||
printStatistics();
|
||||
}
|
||||
|
||||
PerformanceCounter::Statistics::Statistics() noexcept
|
||||
: averageSeconds(), maximumSeconds(), minimumSeconds(), totalSeconds(), numRuns()
|
||||
{
|
||||
}
|
||||
|
||||
void PerformanceCounter::Statistics::clear() noexcept
|
||||
{
|
||||
averageSeconds = maximumSeconds = minimumSeconds = totalSeconds = 0;
|
||||
numRuns = 0;
|
||||
}
|
||||
|
||||
void PerformanceCounter::Statistics::addResult (double elapsed) noexcept
|
||||
{
|
||||
if (numRuns == 0)
|
||||
{
|
||||
maximumSeconds = elapsed;
|
||||
minimumSeconds = elapsed;
|
||||
}
|
||||
else
|
||||
{
|
||||
maximumSeconds = jmax (maximumSeconds, elapsed);
|
||||
minimumSeconds = jmin (minimumSeconds, elapsed);
|
||||
}
|
||||
|
||||
++numRuns;
|
||||
totalSeconds += elapsed;
|
||||
}
|
||||
|
||||
static String timeToString (double secs)
|
||||
{
|
||||
return String ((int64) (secs * (secs < 0.01 ? 1000000.0 : 1000.0) + 0.5))
|
||||
+ (secs < 0.01 ? " microsecs" : " millisecs");
|
||||
}
|
||||
|
||||
String PerformanceCounter::Statistics::toString() const
|
||||
{
|
||||
MemoryOutputStream s;
|
||||
|
||||
s << "Performance count for \"" << name << "\" over " << numRuns << " run(s)" << newLine
|
||||
<< "Average = " << timeToString (averageSeconds)
|
||||
<< ", minimum = " << timeToString (minimumSeconds)
|
||||
<< ", maximum = " << timeToString (maximumSeconds)
|
||||
<< ", total = " << timeToString (totalSeconds);
|
||||
|
||||
return s.toString();
|
||||
}
|
||||
|
||||
void PerformanceCounter::start() noexcept
|
||||
{
|
||||
startTime = Time::getHighResolutionTicks();
|
||||
}
|
||||
|
||||
bool PerformanceCounter::stop()
|
||||
{
|
||||
stats.addResult (Time::highResolutionTicksToSeconds (Time::getHighResolutionTicks() - startTime));
|
||||
|
||||
if (stats.numRuns < runsPerPrint)
|
||||
return false;
|
||||
|
||||
printStatistics();
|
||||
return true;
|
||||
}
|
||||
|
||||
void PerformanceCounter::printStatistics()
|
||||
{
|
||||
const String desc (getStatisticsAndReset().toString());
|
||||
|
||||
Logger::outputDebugString (desc);
|
||||
appendToFile (outputFile, desc);
|
||||
}
|
||||
|
||||
PerformanceCounter::Statistics PerformanceCounter::getStatisticsAndReset()
|
||||
{
|
||||
Statistics s (stats);
|
||||
stats.clear();
|
||||
|
||||
if (s.numRuns > 0)
|
||||
s.averageSeconds = s.totalSeconds / s.numRuns;
|
||||
|
||||
return s;
|
||||
}
|
||||
@@ -0,0 +1,127 @@
|
||||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the juce_core module of the JUCE library.
|
||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any purpose with
|
||||
or without fee is hereby granted, provided that the above copyright notice and this
|
||||
permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
|
||||
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
|
||||
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
||||
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
|
||||
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
|
||||
All other JUCE modules are covered by a dual GPL/commercial license, so if you are
|
||||
using any other modules, be sure to check that you also comply with their license.
|
||||
|
||||
For more details, visit www.juce.com
|
||||
|
||||
==============================================================================
|
||||
*/
|
||||
|
||||
#ifndef JUCE_PERFORMANCECOUNTER_H_INCLUDED
|
||||
#define JUCE_PERFORMANCECOUNTER_H_INCLUDED
|
||||
|
||||
|
||||
//==============================================================================
|
||||
/** A timer for measuring performance of code and dumping the results to a file.
|
||||
|
||||
e.g. @code
|
||||
|
||||
PerformanceCounter pc ("fish", 50, "/temp/myfishlog.txt");
|
||||
|
||||
for (;;)
|
||||
{
|
||||
pc.start();
|
||||
|
||||
doSomethingFishy();
|
||||
|
||||
pc.stop();
|
||||
}
|
||||
@endcode
|
||||
|
||||
In this example, the time of each period between calling start/stop will be
|
||||
measured and averaged over 50 runs, and the results printed to a file
|
||||
every 50 times round the loop.
|
||||
*/
|
||||
class JUCE_API PerformanceCounter
|
||||
{
|
||||
public:
|
||||
//==============================================================================
|
||||
/** Creates a PerformanceCounter object.
|
||||
|
||||
@param counterName the name used when printing out the statistics
|
||||
@param runsPerPrintout the number of start/stop iterations before calling
|
||||
printStatistics()
|
||||
@param loggingFile a file to dump the results to - if this is File::nonexistent,
|
||||
the results are just written to the debugger output
|
||||
*/
|
||||
PerformanceCounter (const String& counterName,
|
||||
int runsPerPrintout = 100,
|
||||
const File& loggingFile = File());
|
||||
|
||||
/** Destructor. */
|
||||
~PerformanceCounter();
|
||||
|
||||
//==============================================================================
|
||||
/** Starts timing.
|
||||
@see stop
|
||||
*/
|
||||
void start() noexcept;
|
||||
|
||||
/** Stops timing and prints out the results.
|
||||
|
||||
The number of iterations before doing a printout of the
|
||||
results is set in the constructor.
|
||||
|
||||
@see start
|
||||
*/
|
||||
bool stop();
|
||||
|
||||
/** Dumps the current metrics to the debugger output and to a file.
|
||||
|
||||
As well as using Logger::outputDebugString to print the results,
|
||||
this will write then to the file specified in the constructor (if
|
||||
this was valid).
|
||||
*/
|
||||
void printStatistics();
|
||||
|
||||
/** Holds the current statistics. */
|
||||
struct Statistics
|
||||
{
|
||||
Statistics() noexcept;
|
||||
|
||||
void clear() noexcept;
|
||||
String toString() const;
|
||||
|
||||
void addResult (double elapsed) noexcept;
|
||||
|
||||
String name;
|
||||
double averageSeconds;
|
||||
double maximumSeconds;
|
||||
double minimumSeconds;
|
||||
double totalSeconds;
|
||||
int64 numRuns;
|
||||
};
|
||||
|
||||
/** Returns a copy of the current stats, and resets the internal counter. */
|
||||
Statistics getStatisticsAndReset();
|
||||
|
||||
private:
|
||||
//==============================================================================
|
||||
Statistics stats;
|
||||
int64 runsPerPrint, startTime;
|
||||
File outputFile;
|
||||
|
||||
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (PerformanceCounter)
|
||||
};
|
||||
|
||||
|
||||
#endif // JUCE_PERFORMANCECOUNTER_H_INCLUDED
|
||||
@@ -0,0 +1,139 @@
|
||||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the juce_core module of the JUCE library.
|
||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any purpose with
|
||||
or without fee is hereby granted, provided that the above copyright notice and this
|
||||
permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
|
||||
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
|
||||
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
||||
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
|
||||
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
|
||||
All other JUCE modules are covered by a dual GPL/commercial license, so if you are
|
||||
using any other modules, be sure to check that you also comply with their license.
|
||||
|
||||
For more details, visit www.juce.com
|
||||
|
||||
==============================================================================
|
||||
*/
|
||||
|
||||
RelativeTime::RelativeTime (const double secs) noexcept : numSeconds (secs) {}
|
||||
RelativeTime::RelativeTime (const RelativeTime& other) noexcept : numSeconds (other.numSeconds) {}
|
||||
RelativeTime::~RelativeTime() noexcept {}
|
||||
|
||||
//==============================================================================
|
||||
RelativeTime RelativeTime::milliseconds (const int milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
|
||||
RelativeTime RelativeTime::milliseconds (const int64 milliseconds) noexcept { return RelativeTime (milliseconds * 0.001); }
|
||||
RelativeTime RelativeTime::seconds (double s) noexcept { return RelativeTime (s); }
|
||||
RelativeTime RelativeTime::minutes (const double numberOfMinutes) noexcept { return RelativeTime (numberOfMinutes * 60.0); }
|
||||
RelativeTime RelativeTime::hours (const double numberOfHours) noexcept { return RelativeTime (numberOfHours * (60.0 * 60.0)); }
|
||||
RelativeTime RelativeTime::days (const double numberOfDays) noexcept { return RelativeTime (numberOfDays * (60.0 * 60.0 * 24.0)); }
|
||||
RelativeTime RelativeTime::weeks (const double numberOfWeeks) noexcept { return RelativeTime (numberOfWeeks * (60.0 * 60.0 * 24.0 * 7.0)); }
|
||||
|
||||
//==============================================================================
|
||||
int64 RelativeTime::inMilliseconds() const noexcept { return (int64) (numSeconds * 1000.0); }
|
||||
double RelativeTime::inMinutes() const noexcept { return numSeconds / 60.0; }
|
||||
double RelativeTime::inHours() const noexcept { return numSeconds / (60.0 * 60.0); }
|
||||
double RelativeTime::inDays() const noexcept { return numSeconds / (60.0 * 60.0 * 24.0); }
|
||||
double RelativeTime::inWeeks() const noexcept { return numSeconds / (60.0 * 60.0 * 24.0 * 7.0); }
|
||||
|
||||
//==============================================================================
|
||||
RelativeTime& RelativeTime::operator= (const RelativeTime& other) noexcept { numSeconds = other.numSeconds; return *this; }
|
||||
|
||||
RelativeTime RelativeTime::operator+= (RelativeTime t) noexcept { numSeconds += t.numSeconds; return *this; }
|
||||
RelativeTime RelativeTime::operator-= (RelativeTime t) noexcept { numSeconds -= t.numSeconds; return *this; }
|
||||
RelativeTime RelativeTime::operator+= (const double secs) noexcept { numSeconds += secs; return *this; }
|
||||
RelativeTime RelativeTime::operator-= (const double secs) noexcept { numSeconds -= secs; return *this; }
|
||||
|
||||
RelativeTime operator+ (RelativeTime t1, RelativeTime t2) noexcept { return t1 += t2; }
|
||||
RelativeTime operator- (RelativeTime t1, RelativeTime t2) noexcept { return t1 -= t2; }
|
||||
|
||||
bool operator== (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() == t2.inSeconds(); }
|
||||
bool operator!= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() != t2.inSeconds(); }
|
||||
bool operator> (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() > t2.inSeconds(); }
|
||||
bool operator< (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() < t2.inSeconds(); }
|
||||
bool operator>= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() >= t2.inSeconds(); }
|
||||
bool operator<= (RelativeTime t1, RelativeTime t2) noexcept { return t1.inSeconds() <= t2.inSeconds(); }
|
||||
|
||||
//==============================================================================
|
||||
static void translateTimeField (String& result, int n, const char* singular, const char* plural)
|
||||
{
|
||||
result << TRANS (n == 1 ? singular : plural)
|
||||
.replace (n == 1 ? "1" : "2", String (n))
|
||||
<< ' ';
|
||||
}
|
||||
|
||||
String RelativeTime::getDescription (const String& returnValueForZeroTime) const
|
||||
{
|
||||
if (numSeconds < 0.001 && numSeconds > -0.001)
|
||||
return returnValueForZeroTime;
|
||||
|
||||
String result;
|
||||
result.preallocateBytes (32);
|
||||
|
||||
if (numSeconds < 0)
|
||||
result << '-';
|
||||
|
||||
int fieldsShown = 0;
|
||||
int n = std::abs ((int) inWeeks());
|
||||
if (n > 0)
|
||||
{
|
||||
translateTimeField (result, n, NEEDS_TRANS("1 week"), NEEDS_TRANS("2 weeks"));
|
||||
++fieldsShown;
|
||||
}
|
||||
|
||||
n = std::abs ((int) inDays()) % 7;
|
||||
if (n > 0)
|
||||
{
|
||||
translateTimeField (result, n, NEEDS_TRANS("1 day"), NEEDS_TRANS("2 days"));
|
||||
++fieldsShown;
|
||||
}
|
||||
|
||||
if (fieldsShown < 2)
|
||||
{
|
||||
n = std::abs ((int) inHours()) % 24;
|
||||
if (n > 0)
|
||||
{
|
||||
translateTimeField (result, n, NEEDS_TRANS("1 hr"), NEEDS_TRANS("2 hrs"));
|
||||
++fieldsShown;
|
||||
}
|
||||
|
||||
if (fieldsShown < 2)
|
||||
{
|
||||
n = std::abs ((int) inMinutes()) % 60;
|
||||
if (n > 0)
|
||||
{
|
||||
translateTimeField (result, n, NEEDS_TRANS("1 min"), NEEDS_TRANS("2 mins"));
|
||||
++fieldsShown;
|
||||
}
|
||||
|
||||
if (fieldsShown < 2)
|
||||
{
|
||||
n = std::abs ((int) inSeconds()) % 60;
|
||||
if (n > 0)
|
||||
{
|
||||
translateTimeField (result, n, NEEDS_TRANS("1 sec"), NEEDS_TRANS("2 secs"));
|
||||
++fieldsShown;
|
||||
}
|
||||
|
||||
if (fieldsShown == 0)
|
||||
{
|
||||
n = std::abs ((int) inMilliseconds()) % 1000;
|
||||
if (n > 0)
|
||||
result << n << ' ' << TRANS ("ms");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return result.trimEnd();
|
||||
}
|
||||
@@ -0,0 +1,184 @@
|
||||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the juce_core module of the JUCE library.
|
||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any purpose with
|
||||
or without fee is hereby granted, provided that the above copyright notice and this
|
||||
permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
|
||||
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
|
||||
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
||||
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
|
||||
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
|
||||
All other JUCE modules are covered by a dual GPL/commercial license, so if you are
|
||||
using any other modules, be sure to check that you also comply with their license.
|
||||
|
||||
For more details, visit www.juce.com
|
||||
|
||||
==============================================================================
|
||||
*/
|
||||
|
||||
#ifndef JUCE_RELATIVETIME_H_INCLUDED
|
||||
#define JUCE_RELATIVETIME_H_INCLUDED
|
||||
|
||||
|
||||
//==============================================================================
|
||||
/** A relative measure of time.
|
||||
|
||||
The time is stored as a number of seconds, at double-precision floating
|
||||
point accuracy, and may be positive or negative.
|
||||
|
||||
If you need an absolute time, (i.e. a date + time), see the Time class.
|
||||
*/
|
||||
class JUCE_API RelativeTime
|
||||
{
|
||||
public:
|
||||
//==============================================================================
|
||||
/** Creates a RelativeTime.
|
||||
|
||||
@param seconds the number of seconds, which may be +ve or -ve.
|
||||
@see milliseconds, minutes, hours, days, weeks
|
||||
*/
|
||||
explicit RelativeTime (double seconds = 0.0) noexcept;
|
||||
|
||||
/** Copies another relative time. */
|
||||
RelativeTime (const RelativeTime& other) noexcept;
|
||||
|
||||
/** Copies another relative time. */
|
||||
RelativeTime& operator= (const RelativeTime& other) noexcept;
|
||||
|
||||
/** Destructor. */
|
||||
~RelativeTime() noexcept;
|
||||
|
||||
//==============================================================================
|
||||
/** Creates a new RelativeTime object representing a number of milliseconds.
|
||||
@see seconds, minutes, hours, days, weeks
|
||||
*/
|
||||
static RelativeTime milliseconds (int milliseconds) noexcept;
|
||||
|
||||
/** Creates a new RelativeTime object representing a number of milliseconds.
|
||||
@see seconds, minutes, hours, days, weeks
|
||||
*/
|
||||
static RelativeTime milliseconds (int64 milliseconds) noexcept;
|
||||
|
||||
/** Creates a new RelativeTime object representing a number of seconds.
|
||||
@see milliseconds, minutes, hours, days, weeks
|
||||
*/
|
||||
static RelativeTime seconds (double seconds) noexcept;
|
||||
|
||||
/** Creates a new RelativeTime object representing a number of minutes.
|
||||
@see milliseconds, hours, days, weeks
|
||||
*/
|
||||
static RelativeTime minutes (double numberOfMinutes) noexcept;
|
||||
|
||||
/** Creates a new RelativeTime object representing a number of hours.
|
||||
@see milliseconds, minutes, days, weeks
|
||||
*/
|
||||
static RelativeTime hours (double numberOfHours) noexcept;
|
||||
|
||||
/** Creates a new RelativeTime object representing a number of days.
|
||||
@see milliseconds, minutes, hours, weeks
|
||||
*/
|
||||
static RelativeTime days (double numberOfDays) noexcept;
|
||||
|
||||
/** Creates a new RelativeTime object representing a number of weeks.
|
||||
@see milliseconds, minutes, hours, days
|
||||
*/
|
||||
static RelativeTime weeks (double numberOfWeeks) noexcept;
|
||||
|
||||
//==============================================================================
|
||||
/** Returns the number of milliseconds this time represents.
|
||||
@see milliseconds, inSeconds, inMinutes, inHours, inDays, inWeeks
|
||||
*/
|
||||
int64 inMilliseconds() const noexcept;
|
||||
|
||||
/** Returns the number of seconds this time represents.
|
||||
@see inMilliseconds, inMinutes, inHours, inDays, inWeeks
|
||||
*/
|
||||
double inSeconds() const noexcept { return numSeconds; }
|
||||
|
||||
/** Returns the number of minutes this time represents.
|
||||
@see inMilliseconds, inSeconds, inHours, inDays, inWeeks
|
||||
*/
|
||||
double inMinutes() const noexcept;
|
||||
|
||||
/** Returns the number of hours this time represents.
|
||||
@see inMilliseconds, inSeconds, inMinutes, inDays, inWeeks
|
||||
*/
|
||||
double inHours() const noexcept;
|
||||
|
||||
/** Returns the number of days this time represents.
|
||||
@see inMilliseconds, inSeconds, inMinutes, inHours, inWeeks
|
||||
*/
|
||||
double inDays() const noexcept;
|
||||
|
||||
/** Returns the number of weeks this time represents.
|
||||
@see inMilliseconds, inSeconds, inMinutes, inHours, inDays
|
||||
*/
|
||||
double inWeeks() const noexcept;
|
||||
|
||||
/** Returns a readable textual description of the time.
|
||||
|
||||
The exact format of the string returned will depend on
|
||||
the magnitude of the time - e.g.
|
||||
|
||||
"1 min 4 secs", "1 hr 45 mins", "2 weeks 5 days", "140 ms"
|
||||
|
||||
so that only the two most significant units are printed.
|
||||
|
||||
The returnValueForZeroTime value is the result that is returned if the
|
||||
length is zero. Depending on your application you might want to use this
|
||||
to return something more relevant like "empty" or "0 secs", etc.
|
||||
|
||||
@see inMilliseconds, inSeconds, inMinutes, inHours, inDays, inWeeks
|
||||
*/
|
||||
String getDescription (const String& returnValueForZeroTime = "0") const;
|
||||
|
||||
|
||||
//==============================================================================
|
||||
/** Adds another RelativeTime to this one. */
|
||||
RelativeTime operator+= (RelativeTime timeToAdd) noexcept;
|
||||
/** Subtracts another RelativeTime from this one. */
|
||||
RelativeTime operator-= (RelativeTime timeToSubtract) noexcept;
|
||||
|
||||
/** Adds a number of seconds to this time. */
|
||||
RelativeTime operator+= (double secondsToAdd) noexcept;
|
||||
/** Subtracts a number of seconds from this time. */
|
||||
RelativeTime operator-= (double secondsToSubtract) noexcept;
|
||||
|
||||
private:
|
||||
//==============================================================================
|
||||
double numSeconds;
|
||||
};
|
||||
|
||||
//==============================================================================
|
||||
/** Compares two RelativeTimes. */
|
||||
bool operator== (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
/** Compares two RelativeTimes. */
|
||||
bool operator!= (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
/** Compares two RelativeTimes. */
|
||||
bool operator> (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
/** Compares two RelativeTimes. */
|
||||
bool operator< (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
/** Compares two RelativeTimes. */
|
||||
bool operator>= (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
/** Compares two RelativeTimes. */
|
||||
bool operator<= (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
|
||||
//==============================================================================
|
||||
/** Adds two RelativeTimes together. */
|
||||
RelativeTime operator+ (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
/** Subtracts two RelativeTimes. */
|
||||
RelativeTime operator- (RelativeTime t1, RelativeTime t2) noexcept;
|
||||
|
||||
|
||||
|
||||
#endif // JUCE_RELATIVETIME_H_INCLUDED
|
||||
@@ -0,0 +1,469 @@
|
||||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the juce_core module of the JUCE library.
|
||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any purpose with
|
||||
or without fee is hereby granted, provided that the above copyright notice and this
|
||||
permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
|
||||
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
|
||||
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
||||
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
|
||||
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
|
||||
All other JUCE modules are covered by a dual GPL/commercial license, so if you are
|
||||
using any other modules, be sure to check that you also comply with their license.
|
||||
|
||||
For more details, visit www.juce.com
|
||||
|
||||
==============================================================================
|
||||
*/
|
||||
|
||||
namespace TimeHelpers
|
||||
{
|
||||
static struct tm millisToLocal (const int64 millis) noexcept
|
||||
{
|
||||
struct tm result;
|
||||
const int64 seconds = millis / 1000;
|
||||
|
||||
if (seconds < 86400LL || seconds >= 2145916800LL)
|
||||
{
|
||||
// use extended maths for dates beyond 1970 to 2037..
|
||||
const int timeZoneAdjustment = 31536000 - (int) (Time (1971, 0, 1, 0, 0).toMilliseconds() / 1000);
|
||||
const int64 jdm = seconds + timeZoneAdjustment + 210866803200LL;
|
||||
|
||||
const int days = (int) (jdm / 86400LL);
|
||||
const int a = 32044 + days;
|
||||
const int b = (4 * a + 3) / 146097;
|
||||
const int c = a - (b * 146097) / 4;
|
||||
const int d = (4 * c + 3) / 1461;
|
||||
const int e = c - (d * 1461) / 4;
|
||||
const int m = (5 * e + 2) / 153;
|
||||
|
||||
result.tm_mday = e - (153 * m + 2) / 5 + 1;
|
||||
result.tm_mon = m + 2 - 12 * (m / 10);
|
||||
result.tm_year = b * 100 + d - 6700 + (m / 10);
|
||||
result.tm_wday = (days + 1) % 7;
|
||||
result.tm_yday = -1;
|
||||
|
||||
int t = (int) (jdm % 86400LL);
|
||||
result.tm_hour = t / 3600;
|
||||
t %= 3600;
|
||||
result.tm_min = t / 60;
|
||||
result.tm_sec = t % 60;
|
||||
result.tm_isdst = -1;
|
||||
}
|
||||
else
|
||||
{
|
||||
time_t now = static_cast <time_t> (seconds);
|
||||
|
||||
#if JUCE_WINDOWS
|
||||
#ifdef _INC_TIME_INL
|
||||
if (now >= 0 && now <= 0x793406fff)
|
||||
localtime_s (&result, &now);
|
||||
else
|
||||
zerostruct (result);
|
||||
#else
|
||||
result = *localtime (&now);
|
||||
#endif
|
||||
#else
|
||||
|
||||
localtime_r (&now, &result); // more thread-safe
|
||||
#endif
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
static int extendedModulo (const int64 value, const int modulo) noexcept
|
||||
{
|
||||
return (int) (value >= 0 ? (value % modulo)
|
||||
: (value - ((value / modulo) + 1) * modulo));
|
||||
}
|
||||
|
||||
static inline String formatString (const String& format, const struct tm* const tm)
|
||||
{
|
||||
#if JUCE_ANDROID
|
||||
typedef CharPointer_UTF8 StringType;
|
||||
#elif JUCE_WINDOWS
|
||||
typedef CharPointer_UTF16 StringType;
|
||||
#else
|
||||
typedef CharPointer_UTF32 StringType;
|
||||
#endif
|
||||
|
||||
for (size_t bufferSize = 256; ; bufferSize += 256)
|
||||
{
|
||||
HeapBlock<StringType::CharType> buffer (bufferSize);
|
||||
|
||||
#if JUCE_ANDROID
|
||||
const size_t numChars = strftime (buffer, bufferSize - 1, format.toUTF8(), tm);
|
||||
#elif JUCE_WINDOWS
|
||||
const size_t numChars = wcsftime (buffer, bufferSize - 1, format.toWideCharPointer(), tm);
|
||||
#else
|
||||
const size_t numChars = wcsftime (buffer, bufferSize - 1, format.toUTF32(), tm);
|
||||
#endif
|
||||
|
||||
if (numChars > 0 || format.isEmpty())
|
||||
return String (StringType (buffer),
|
||||
StringType (buffer) + (int) numChars);
|
||||
}
|
||||
}
|
||||
|
||||
static uint32 lastMSCounterValue = 0;
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
Time::Time() noexcept
|
||||
: millisSinceEpoch (0)
|
||||
{
|
||||
}
|
||||
|
||||
Time::Time (const Time& other) noexcept
|
||||
: millisSinceEpoch (other.millisSinceEpoch)
|
||||
{
|
||||
}
|
||||
|
||||
Time::Time (const int64 ms) noexcept
|
||||
: millisSinceEpoch (ms)
|
||||
{
|
||||
}
|
||||
|
||||
Time::Time (const int year,
|
||||
const int month,
|
||||
const int day,
|
||||
const int hours,
|
||||
const int minutes,
|
||||
const int seconds,
|
||||
const int milliseconds,
|
||||
const bool useLocalTime) noexcept
|
||||
{
|
||||
jassert (year > 100); // year must be a 4-digit version
|
||||
|
||||
if (year < 1971 || year >= 2038 || ! useLocalTime)
|
||||
{
|
||||
// use extended maths for dates beyond 1970 to 2037..
|
||||
const int timeZoneAdjustment = useLocalTime ? (31536000 - (int) (Time (1971, 0, 1, 0, 0).toMilliseconds() / 1000))
|
||||
: 0;
|
||||
const int a = (13 - month) / 12;
|
||||
const int y = year + 4800 - a;
|
||||
const int jd = day + (153 * (month + 12 * a - 2) + 2) / 5
|
||||
+ (y * 365) + (y / 4) - (y / 100) + (y / 400)
|
||||
- 32045;
|
||||
|
||||
const int64 s = ((int64) jd) * 86400LL - 210866803200LL;
|
||||
|
||||
millisSinceEpoch = 1000 * (s + (hours * 3600 + minutes * 60 + seconds - timeZoneAdjustment))
|
||||
+ milliseconds;
|
||||
}
|
||||
else
|
||||
{
|
||||
struct tm t;
|
||||
t.tm_year = year - 1900;
|
||||
t.tm_mon = month;
|
||||
t.tm_mday = day;
|
||||
t.tm_hour = hours;
|
||||
t.tm_min = minutes;
|
||||
t.tm_sec = seconds;
|
||||
t.tm_isdst = -1;
|
||||
|
||||
millisSinceEpoch = 1000 * (int64) mktime (&t);
|
||||
|
||||
if (millisSinceEpoch < 0)
|
||||
millisSinceEpoch = 0;
|
||||
else
|
||||
millisSinceEpoch += milliseconds;
|
||||
}
|
||||
}
|
||||
|
||||
Time::~Time() noexcept
|
||||
{
|
||||
}
|
||||
|
||||
Time& Time::operator= (const Time& other) noexcept
|
||||
{
|
||||
millisSinceEpoch = other.millisSinceEpoch;
|
||||
return *this;
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
int64 Time::currentTimeMillis() noexcept
|
||||
{
|
||||
#if JUCE_WINDOWS
|
||||
struct _timeb t;
|
||||
#ifdef _INC_TIME_INL
|
||||
_ftime_s (&t);
|
||||
#else
|
||||
_ftime (&t);
|
||||
#endif
|
||||
return ((int64) t.time) * 1000 + t.millitm;
|
||||
#else
|
||||
struct timeval tv;
|
||||
gettimeofday (&tv, nullptr);
|
||||
return ((int64) tv.tv_sec) * 1000 + tv.tv_usec / 1000;
|
||||
#endif
|
||||
}
|
||||
|
||||
Time JUCE_CALLTYPE Time::getCurrentTime() noexcept
|
||||
{
|
||||
return Time (currentTimeMillis());
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
uint32 juce_millisecondsSinceStartup() noexcept;
|
||||
|
||||
uint32 Time::getMillisecondCounter() noexcept
|
||||
{
|
||||
const uint32 now = juce_millisecondsSinceStartup();
|
||||
|
||||
if (now < TimeHelpers::lastMSCounterValue)
|
||||
{
|
||||
// in multi-threaded apps this might be called concurrently, so
|
||||
// make sure that our last counter value only increases and doesn't
|
||||
// go backwards..
|
||||
if (now < TimeHelpers::lastMSCounterValue - 1000)
|
||||
TimeHelpers::lastMSCounterValue = now;
|
||||
}
|
||||
else
|
||||
{
|
||||
TimeHelpers::lastMSCounterValue = now;
|
||||
}
|
||||
|
||||
return now;
|
||||
}
|
||||
|
||||
uint32 Time::getApproximateMillisecondCounter() noexcept
|
||||
{
|
||||
if (TimeHelpers::lastMSCounterValue == 0)
|
||||
getMillisecondCounter();
|
||||
|
||||
return TimeHelpers::lastMSCounterValue;
|
||||
}
|
||||
|
||||
void Time::waitForMillisecondCounter (const uint32 targetTime) noexcept
|
||||
{
|
||||
for (;;)
|
||||
{
|
||||
const uint32 now = getMillisecondCounter();
|
||||
|
||||
if (now >= targetTime)
|
||||
break;
|
||||
|
||||
const int toWait = (int) (targetTime - now);
|
||||
|
||||
if (toWait > 2)
|
||||
{
|
||||
Thread::sleep (jmin (20, toWait >> 1));
|
||||
}
|
||||
else
|
||||
{
|
||||
// xxx should consider using mutex_pause on the mac as it apparently
|
||||
// makes it seem less like a spinlock and avoids lowering the thread pri.
|
||||
for (int i = 10; --i >= 0;)
|
||||
Thread::yield();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
double Time::highResolutionTicksToSeconds (const int64 ticks) noexcept
|
||||
{
|
||||
return ticks / (double) getHighResolutionTicksPerSecond();
|
||||
}
|
||||
|
||||
int64 Time::secondsToHighResolutionTicks (const double seconds) noexcept
|
||||
{
|
||||
return (int64) (seconds * (double) getHighResolutionTicksPerSecond());
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
String Time::toString (const bool includeDate,
|
||||
const bool includeTime,
|
||||
const bool includeSeconds,
|
||||
const bool use24HourClock) const noexcept
|
||||
{
|
||||
String result;
|
||||
|
||||
if (includeDate)
|
||||
{
|
||||
result << getDayOfMonth() << ' '
|
||||
<< getMonthName (true) << ' '
|
||||
<< getYear();
|
||||
|
||||
if (includeTime)
|
||||
result << ' ';
|
||||
}
|
||||
|
||||
if (includeTime)
|
||||
{
|
||||
const int mins = getMinutes();
|
||||
|
||||
result << (use24HourClock ? getHours() : getHoursInAmPmFormat())
|
||||
<< (mins < 10 ? ":0" : ":") << mins;
|
||||
|
||||
if (includeSeconds)
|
||||
{
|
||||
const int secs = getSeconds();
|
||||
result << (secs < 10 ? ":0" : ":") << secs;
|
||||
}
|
||||
|
||||
if (! use24HourClock)
|
||||
result << (isAfternoon() ? "pm" : "am");
|
||||
}
|
||||
|
||||
return result.trimEnd();
|
||||
}
|
||||
|
||||
String Time::formatted (const String& format) const
|
||||
{
|
||||
struct tm t (TimeHelpers::millisToLocal (millisSinceEpoch));
|
||||
return TimeHelpers::formatString (format, &t);
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
int Time::getYear() const noexcept { return TimeHelpers::millisToLocal (millisSinceEpoch).tm_year + 1900; }
|
||||
int Time::getMonth() const noexcept { return TimeHelpers::millisToLocal (millisSinceEpoch).tm_mon; }
|
||||
int Time::getDayOfYear() const noexcept { return TimeHelpers::millisToLocal (millisSinceEpoch).tm_yday; }
|
||||
int Time::getDayOfMonth() const noexcept { return TimeHelpers::millisToLocal (millisSinceEpoch).tm_mday; }
|
||||
int Time::getDayOfWeek() const noexcept { return TimeHelpers::millisToLocal (millisSinceEpoch).tm_wday; }
|
||||
int Time::getHours() const noexcept { return TimeHelpers::millisToLocal (millisSinceEpoch).tm_hour; }
|
||||
int Time::getMinutes() const noexcept { return TimeHelpers::millisToLocal (millisSinceEpoch).tm_min; }
|
||||
int Time::getSeconds() const noexcept { return TimeHelpers::extendedModulo (millisSinceEpoch / 1000, 60); }
|
||||
int Time::getMilliseconds() const noexcept { return TimeHelpers::extendedModulo (millisSinceEpoch, 1000); }
|
||||
|
||||
int Time::getHoursInAmPmFormat() const noexcept
|
||||
{
|
||||
const int hours = getHours();
|
||||
|
||||
if (hours == 0) return 12;
|
||||
if (hours <= 12) return hours;
|
||||
|
||||
return hours - 12;
|
||||
}
|
||||
|
||||
bool Time::isAfternoon() const noexcept
|
||||
{
|
||||
return getHours() >= 12;
|
||||
}
|
||||
|
||||
bool Time::isDaylightSavingTime() const noexcept
|
||||
{
|
||||
return TimeHelpers::millisToLocal (millisSinceEpoch).tm_isdst != 0;
|
||||
}
|
||||
|
||||
String Time::getTimeZone() const noexcept
|
||||
{
|
||||
String zone[2];
|
||||
|
||||
#if JUCE_WINDOWS
|
||||
_tzset();
|
||||
|
||||
#ifdef _INC_TIME_INL
|
||||
for (int i = 0; i < 2; ++i)
|
||||
{
|
||||
char name[128] = { 0 };
|
||||
size_t length;
|
||||
_get_tzname (&length, name, 127, i);
|
||||
zone[i] = name;
|
||||
}
|
||||
#else
|
||||
const char** const zonePtr = (const char**) _tzname;
|
||||
zone[0] = zonePtr[0];
|
||||
zone[1] = zonePtr[1];
|
||||
#endif
|
||||
#else
|
||||
tzset();
|
||||
const char** const zonePtr = (const char**) tzname;
|
||||
zone[0] = zonePtr[0];
|
||||
zone[1] = zonePtr[1];
|
||||
#endif
|
||||
|
||||
if (isDaylightSavingTime())
|
||||
{
|
||||
zone[0] = zone[1];
|
||||
|
||||
if (zone[0].length() > 3
|
||||
&& zone[0].containsIgnoreCase ("daylight")
|
||||
&& zone[0].contains ("GMT"))
|
||||
zone[0] = "BST";
|
||||
}
|
||||
|
||||
return zone[0].substring (0, 3);
|
||||
}
|
||||
|
||||
String Time::getMonthName (const bool threeLetterVersion) const
|
||||
{
|
||||
return getMonthName (getMonth(), threeLetterVersion);
|
||||
}
|
||||
|
||||
String Time::getWeekdayName (const bool threeLetterVersion) const
|
||||
{
|
||||
return getWeekdayName (getDayOfWeek(), threeLetterVersion);
|
||||
}
|
||||
|
||||
static const char* const shortMonthNames[] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
|
||||
static const char* const longMonthNames[] = { "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" };
|
||||
|
||||
String Time::getMonthName (int monthNumber, const bool threeLetterVersion)
|
||||
{
|
||||
monthNumber %= 12;
|
||||
|
||||
return TRANS (threeLetterVersion ? shortMonthNames [monthNumber]
|
||||
: longMonthNames [monthNumber]);
|
||||
}
|
||||
|
||||
String Time::getWeekdayName (int day, const bool threeLetterVersion)
|
||||
{
|
||||
static const char* const shortDayNames[] = { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
|
||||
static const char* const longDayNames[] = { "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" };
|
||||
|
||||
day %= 7;
|
||||
|
||||
return TRANS (threeLetterVersion ? shortDayNames [day]
|
||||
: longDayNames [day]);
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
Time& Time::operator+= (RelativeTime delta) noexcept { millisSinceEpoch += delta.inMilliseconds(); return *this; }
|
||||
Time& Time::operator-= (RelativeTime delta) noexcept { millisSinceEpoch -= delta.inMilliseconds(); return *this; }
|
||||
|
||||
Time operator+ (Time time, RelativeTime delta) noexcept { Time t (time); return t += delta; }
|
||||
Time operator- (Time time, RelativeTime delta) noexcept { Time t (time); return t -= delta; }
|
||||
Time operator+ (RelativeTime delta, Time time) noexcept { Time t (time); return t += delta; }
|
||||
const RelativeTime operator- (Time time1, Time time2) noexcept { return RelativeTime::milliseconds (time1.toMilliseconds() - time2.toMilliseconds()); }
|
||||
|
||||
bool operator== (Time time1, Time time2) noexcept { return time1.toMilliseconds() == time2.toMilliseconds(); }
|
||||
bool operator!= (Time time1, Time time2) noexcept { return time1.toMilliseconds() != time2.toMilliseconds(); }
|
||||
bool operator< (Time time1, Time time2) noexcept { return time1.toMilliseconds() < time2.toMilliseconds(); }
|
||||
bool operator> (Time time1, Time time2) noexcept { return time1.toMilliseconds() > time2.toMilliseconds(); }
|
||||
bool operator<= (Time time1, Time time2) noexcept { return time1.toMilliseconds() <= time2.toMilliseconds(); }
|
||||
bool operator>= (Time time1, Time time2) noexcept { return time1.toMilliseconds() >= time2.toMilliseconds(); }
|
||||
|
||||
static int getMonthNumberForCompileDate (const String& m) noexcept
|
||||
{
|
||||
for (int i = 0; i < 12; ++i)
|
||||
if (m.equalsIgnoreCase (shortMonthNames[i]))
|
||||
return i;
|
||||
|
||||
// If you hit this because your compiler has a non-standard __DATE__ format,
|
||||
// let me know so we can add support for it!
|
||||
jassertfalse;
|
||||
return 0;
|
||||
}
|
||||
|
||||
Time Time::getCompilationDate()
|
||||
{
|
||||
StringArray dateTokens;
|
||||
dateTokens.addTokens (__DATE__, true);
|
||||
dateTokens.removeEmptyStrings (true);
|
||||
|
||||
return Time (dateTokens[2].getIntValue(),
|
||||
getMonthNumberForCompileDate (dateTokens[0]),
|
||||
dateTokens[1].getIntValue(), 12, 0);
|
||||
}
|
||||
@@ -0,0 +1,404 @@
|
||||
/*
|
||||
==============================================================================
|
||||
|
||||
This file is part of the juce_core module of the JUCE library.
|
||||
Copyright (c) 2013 - Raw Material Software Ltd.
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any purpose with
|
||||
or without fee is hereby granted, provided that the above copyright notice and this
|
||||
permission notice appear in all copies.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
|
||||
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
|
||||
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
||||
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
|
||||
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
||||
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
|
||||
All other JUCE modules are covered by a dual GPL/commercial license, so if you are
|
||||
using any other modules, be sure to check that you also comply with their license.
|
||||
|
||||
For more details, visit www.juce.com
|
||||
|
||||
==============================================================================
|
||||
*/
|
||||
|
||||
#ifndef JUCE_TIME_H_INCLUDED
|
||||
#define JUCE_TIME_H_INCLUDED
|
||||
|
||||
|
||||
//==============================================================================
|
||||
/**
|
||||
Holds an absolute date and time.
|
||||
|
||||
Internally, the time is stored at millisecond precision.
|
||||
|
||||
@see RelativeTime
|
||||
*/
|
||||
class JUCE_API Time
|
||||
{
|
||||
public:
|
||||
//==============================================================================
|
||||
/** Creates a Time object.
|
||||
|
||||
This default constructor creates a time of 1st January 1970, (which is
|
||||
represented internally as 0ms).
|
||||
|
||||
To create a time object representing the current time, use getCurrentTime().
|
||||
|
||||
@see getCurrentTime
|
||||
*/
|
||||
Time() noexcept;
|
||||
|
||||
/** Creates a time based on a number of milliseconds.
|
||||
|
||||
The internal millisecond count is set to 0 (1st January 1970). To create a
|
||||
time object set to the current time, use getCurrentTime().
|
||||
|
||||
@param millisecondsSinceEpoch the number of milliseconds since the unix
|
||||
'epoch' (midnight Jan 1st 1970).
|
||||
@see getCurrentTime, currentTimeMillis
|
||||
*/
|
||||
explicit Time (int64 millisecondsSinceEpoch) noexcept;
|
||||
|
||||
/** Creates a time from a set of date components.
|
||||
|
||||
The timezone is assumed to be whatever the system is using as its locale.
|
||||
|
||||
@param year the year, in 4-digit format, e.g. 2004
|
||||
@param month the month, in the range 0 to 11
|
||||
@param day the day of the month, in the range 1 to 31
|
||||
@param hours hours in 24-hour clock format, 0 to 23
|
||||
@param minutes minutes 0 to 59
|
||||
@param seconds seconds 0 to 59
|
||||
@param milliseconds milliseconds 0 to 999
|
||||
@param useLocalTime if true, encode using the current machine's local time; if
|
||||
false, it will always work in GMT.
|
||||
*/
|
||||
Time (int year,
|
||||
int month,
|
||||
int day,
|
||||
int hours,
|
||||
int minutes,
|
||||
int seconds = 0,
|
||||
int milliseconds = 0,
|
||||
bool useLocalTime = true) noexcept;
|
||||
|
||||
/** Creates a copy of another Time object. */
|
||||
Time (const Time& other) noexcept;
|
||||
|
||||
/** Destructor. */
|
||||
~Time() noexcept;
|
||||
|
||||
/** Copies this time from another one. */
|
||||
Time& operator= (const Time& other) noexcept;
|
||||
|
||||
//==============================================================================
|
||||
/** Returns a Time object that is set to the current system time.
|
||||
|
||||
@see currentTimeMillis
|
||||
*/
|
||||
static Time JUCE_CALLTYPE getCurrentTime() noexcept;
|
||||
|
||||
/** Returns the time as a number of milliseconds.
|
||||
|
||||
@returns the number of milliseconds this Time object represents, since
|
||||
midnight jan 1st 1970.
|
||||
@see getMilliseconds
|
||||
*/
|
||||
int64 toMilliseconds() const noexcept { return millisSinceEpoch; }
|
||||
|
||||
/** Returns the year.
|
||||
|
||||
A 4-digit format is used, e.g. 2004.
|
||||
*/
|
||||
int getYear() const noexcept;
|
||||
|
||||
/** Returns the number of the month.
|
||||
|
||||
The value returned is in the range 0 to 11.
|
||||
@see getMonthName
|
||||
*/
|
||||
int getMonth() const noexcept;
|
||||
|
||||
/** Returns the name of the month.
|
||||
|
||||
@param threeLetterVersion if true, it'll be a 3-letter abbreviation, e.g. "Jan"; if false
|
||||
it'll return the long form, e.g. "January"
|
||||
@see getMonth
|
||||
*/
|
||||
String getMonthName (bool threeLetterVersion) const;
|
||||
|
||||
/** Returns the day of the month.
|
||||
The value returned is in the range 1 to 31.
|
||||
*/
|
||||
int getDayOfMonth() const noexcept;
|
||||
|
||||
/** Returns the number of the day of the week.
|
||||
The value returned is in the range 0 to 6 (0 = sunday, 1 = monday, etc).
|
||||
*/
|
||||
int getDayOfWeek() const noexcept;
|
||||
|
||||
/** Returns the number of the day of the year.
|
||||
The value returned is in the range 0 to 365.
|
||||
*/
|
||||
int getDayOfYear() const noexcept;
|
||||
|
||||
/** Returns the name of the weekday.
|
||||
|
||||
@param threeLetterVersion if true, it'll return a 3-letter abbreviation, e.g. "Tue"; if
|
||||
false, it'll return the full version, e.g. "Tuesday".
|
||||
*/
|
||||
String getWeekdayName (bool threeLetterVersion) const;
|
||||
|
||||
/** Returns the number of hours since midnight.
|
||||
|
||||
This is in 24-hour clock format, in the range 0 to 23.
|
||||
|
||||
@see getHoursInAmPmFormat, isAfternoon
|
||||
*/
|
||||
int getHours() const noexcept;
|
||||
|
||||
/** Returns true if the time is in the afternoon.
|
||||
|
||||
So it returns true for "PM", false for "AM".
|
||||
|
||||
@see getHoursInAmPmFormat, getHours
|
||||
*/
|
||||
bool isAfternoon() const noexcept;
|
||||
|
||||
/** Returns the hours in 12-hour clock format.
|
||||
|
||||
This will return a value 1 to 12 - use isAfternoon() to find out
|
||||
whether this is in the afternoon or morning.
|
||||
|
||||
@see getHours, isAfternoon
|
||||
*/
|
||||
int getHoursInAmPmFormat() const noexcept;
|
||||
|
||||
/** Returns the number of minutes, 0 to 59. */
|
||||
int getMinutes() const noexcept;
|
||||
|
||||
/** Returns the number of seconds, 0 to 59. */
|
||||
int getSeconds() const noexcept;
|
||||
|
||||
/** Returns the number of milliseconds, 0 to 999.
|
||||
|
||||
Unlike toMilliseconds(), this just returns the position within the
|
||||
current second rather than the total number since the epoch.
|
||||
|
||||
@see toMilliseconds
|
||||
*/
|
||||
int getMilliseconds() const noexcept;
|
||||
|
||||
/** Returns true if the local timezone uses a daylight saving correction. */
|
||||
bool isDaylightSavingTime() const noexcept;
|
||||
|
||||
/** Returns a 3-character string to indicate the local timezone. */
|
||||
String getTimeZone() const noexcept;
|
||||
|
||||
//==============================================================================
|
||||
/** Quick way of getting a string version of a date and time.
|
||||
|
||||
For a more powerful way of formatting the date and time, see the formatted() method.
|
||||
|
||||
@param includeDate whether to include the date in the string
|
||||
@param includeTime whether to include the time in the string
|
||||
@param includeSeconds if the time is being included, this provides an option not to include
|
||||
the seconds in it
|
||||
@param use24HourClock if the time is being included, sets whether to use am/pm or 24
|
||||
hour notation.
|
||||
@see formatted
|
||||
*/
|
||||
String toString (bool includeDate,
|
||||
bool includeTime,
|
||||
bool includeSeconds = true,
|
||||
bool use24HourClock = false) const noexcept;
|
||||
|
||||
/** Converts this date/time to a string with a user-defined format.
|
||||
|
||||
This uses the C strftime() function to format this time as a string. To save you
|
||||
looking it up, these are the escape codes that strftime uses (other codes might
|
||||
work on some platforms and not others, but these are the common ones):
|
||||
|
||||
%a is replaced by the locale's abbreviated weekday name.
|
||||
%A is replaced by the locale's full weekday name.
|
||||
%b is replaced by the locale's abbreviated month name.
|
||||
%B is replaced by the locale's full month name.
|
||||
%c is replaced by the locale's appropriate date and time representation.
|
||||
%d is replaced by the day of the month as a decimal number [01,31].
|
||||
%H is replaced by the hour (24-hour clock) as a decimal number [00,23].
|
||||
%I is replaced by the hour (12-hour clock) as a decimal number [01,12].
|
||||
%j is replaced by the day of the year as a decimal number [001,366].
|
||||
%m is replaced by the month as a decimal number [01,12].
|
||||
%M is replaced by the minute as a decimal number [00,59].
|
||||
%p is replaced by the locale's equivalent of either a.m. or p.m.
|
||||
%S is replaced by the second as a decimal number [00,61].
|
||||
%U is replaced by the week number of the year (Sunday as the first day of the week) as a decimal number [00,53].
|
||||
%w is replaced by the weekday as a decimal number [0,6], with 0 representing Sunday.
|
||||
%W is replaced by the week number of the year (Monday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Monday are considered to be in week 0.
|
||||
%x is replaced by the locale's appropriate date representation.
|
||||
%X is replaced by the locale's appropriate time representation.
|
||||
%y is replaced by the year without century as a decimal number [00,99].
|
||||
%Y is replaced by the year with century as a decimal number.
|
||||
%Z is replaced by the timezone name or abbreviation, or by no bytes if no timezone information exists.
|
||||
%% is replaced by %.
|
||||
|
||||
@see toString
|
||||
*/
|
||||
String formatted (const String& format) const;
|
||||
|
||||
//==============================================================================
|
||||
/** Adds a RelativeTime to this time. */
|
||||
Time& operator+= (RelativeTime delta) noexcept;
|
||||
/** Subtracts a RelativeTime from this time. */
|
||||
Time& operator-= (RelativeTime delta) noexcept;
|
||||
|
||||
//==============================================================================
|
||||
/** Tries to set the computer's clock.
|
||||
|
||||
@returns true if this succeeds, although depending on the system, the
|
||||
application might not have sufficient privileges to do this.
|
||||
*/
|
||||
bool setSystemTimeToThisTime() const;
|
||||
|
||||
//==============================================================================
|
||||
/** Returns the name of a day of the week.
|
||||
|
||||
@param dayNumber the day, 0 to 6 (0 = sunday, 1 = monday, etc)
|
||||
@param threeLetterVersion if true, it'll return a 3-letter abbreviation, e.g. "Tue"; if
|
||||
false, it'll return the full version, e.g. "Tuesday".
|
||||
*/
|
||||
static String getWeekdayName (int dayNumber, bool threeLetterVersion);
|
||||
|
||||
/** Returns the name of one of the months.
|
||||
|
||||
@param monthNumber the month, 0 to 11
|
||||
@param threeLetterVersion if true, it'll be a 3-letter abbreviation, e.g. "Jan"; if false
|
||||
it'll return the long form, e.g. "January"
|
||||
*/
|
||||
static String getMonthName (int monthNumber, bool threeLetterVersion);
|
||||
|
||||
//==============================================================================
|
||||
// Static methods for getting system timers directly..
|
||||
|
||||
/** Returns the current system time.
|
||||
|
||||
Returns the number of milliseconds since midnight jan 1st 1970.
|
||||
|
||||
Should be accurate to within a few millisecs, depending on platform,
|
||||
hardware, etc.
|
||||
*/
|
||||
static int64 currentTimeMillis() noexcept;
|
||||
|
||||
/** Returns the number of millisecs since a fixed event (usually system startup).
|
||||
|
||||
This returns a monotonically increasing value which it unaffected by changes to the
|
||||
system clock. It should be accurate to within a few millisecs, depending on platform,
|
||||
hardware, etc.
|
||||
|
||||
Being a 32-bit return value, it will of course wrap back to 0 after 2^32 seconds of
|
||||
uptime, so be careful to take that into account. If you need a 64-bit time, you can
|
||||
use currentTimeMillis() instead.
|
||||
|
||||
@see getApproximateMillisecondCounter
|
||||
*/
|
||||
static uint32 getMillisecondCounter() noexcept;
|
||||
|
||||
/** Returns the number of millisecs since a fixed event (usually system startup).
|
||||
|
||||
This has the same function as getMillisecondCounter(), but returns a more accurate
|
||||
value, using a higher-resolution timer if one is available.
|
||||
|
||||
@see getMillisecondCounter
|
||||
*/
|
||||
static double getMillisecondCounterHiRes() noexcept;
|
||||
|
||||
/** Waits until the getMillisecondCounter() reaches a given value.
|
||||
|
||||
This will make the thread sleep as efficiently as it can while it's waiting.
|
||||
*/
|
||||
static void waitForMillisecondCounter (uint32 targetTime) noexcept;
|
||||
|
||||
/** Less-accurate but faster version of getMillisecondCounter().
|
||||
|
||||
This will return the last value that getMillisecondCounter() returned, so doesn't
|
||||
need to make a system call, but is less accurate - it shouldn't be more than
|
||||
100ms away from the correct time, though, so is still accurate enough for a
|
||||
lot of purposes.
|
||||
|
||||
@see getMillisecondCounter
|
||||
*/
|
||||
static uint32 getApproximateMillisecondCounter() noexcept;
|
||||
|
||||
//==============================================================================
|
||||
// High-resolution timers..
|
||||
|
||||
/** Returns the current high-resolution counter's tick-count.
|
||||
|
||||
This is a similar idea to getMillisecondCounter(), but with a higher
|
||||
resolution.
|
||||
|
||||
@see getHighResolutionTicksPerSecond, highResolutionTicksToSeconds,
|
||||
secondsToHighResolutionTicks
|
||||
*/
|
||||
static int64 getHighResolutionTicks() noexcept;
|
||||
|
||||
/** Returns the resolution of the high-resolution counter in ticks per second.
|
||||
|
||||
@see getHighResolutionTicks, highResolutionTicksToSeconds,
|
||||
secondsToHighResolutionTicks
|
||||
*/
|
||||
static int64 getHighResolutionTicksPerSecond() noexcept;
|
||||
|
||||
/** Converts a number of high-resolution ticks into seconds.
|
||||
|
||||
@see getHighResolutionTicks, getHighResolutionTicksPerSecond,
|
||||
secondsToHighResolutionTicks
|
||||
*/
|
||||
static double highResolutionTicksToSeconds (int64 ticks) noexcept;
|
||||
|
||||
/** Converts a number seconds into high-resolution ticks.
|
||||
|
||||
@see getHighResolutionTicks, getHighResolutionTicksPerSecond,
|
||||
highResolutionTicksToSeconds
|
||||
*/
|
||||
static int64 secondsToHighResolutionTicks (double seconds) noexcept;
|
||||
|
||||
/** Returns a Time based on the value of the __DATE__ macro when this module was compiled */
|
||||
static Time getCompilationDate();
|
||||
|
||||
private:
|
||||
//==============================================================================
|
||||
int64 millisSinceEpoch;
|
||||
};
|
||||
|
||||
//==============================================================================
|
||||
/** Adds a RelativeTime to a Time. */
|
||||
JUCE_API Time operator+ (Time time, RelativeTime delta) noexcept;
|
||||
/** Adds a RelativeTime to a Time. */
|
||||
JUCE_API Time operator+ (RelativeTime delta, Time time) noexcept;
|
||||
|
||||
/** Subtracts a RelativeTime from a Time. */
|
||||
JUCE_API Time operator- (Time time, RelativeTime delta) noexcept;
|
||||
/** Returns the relative time difference between two times. */
|
||||
JUCE_API const RelativeTime operator- (Time time1, Time time2) noexcept;
|
||||
|
||||
/** Compares two Time objects. */
|
||||
JUCE_API bool operator== (Time time1, Time time2) noexcept;
|
||||
/** Compares two Time objects. */
|
||||
JUCE_API bool operator!= (Time time1, Time time2) noexcept;
|
||||
/** Compares two Time objects. */
|
||||
JUCE_API bool operator< (Time time1, Time time2) noexcept;
|
||||
/** Compares two Time objects. */
|
||||
JUCE_API bool operator<= (Time time1, Time time2) noexcept;
|
||||
/** Compares two Time objects. */
|
||||
JUCE_API bool operator> (Time time1, Time time2) noexcept;
|
||||
/** Compares two Time objects. */
|
||||
JUCE_API bool operator>= (Time time1, Time time2) noexcept;
|
||||
|
||||
|
||||
#endif // JUCE_TIME_H_INCLUDED
|
||||
Reference in New Issue
Block a user