]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/datetime.inl
renamed wxWave to wxSound; compatibility fixes
[wxWidgets.git] / include / wx / datetime.inl
index 57555e63553df0994b2d37e52075709c39e95698..546de23f8af8148cebfe54264644e71f056e182f 100644 (file)
 #endif
 
 // ----------------------------------------------------------------------------
-// wxDateTime statics
+// private macros
 // ----------------------------------------------------------------------------
 
-/* static */
-wxDateTime::Country wxDateTime::GetCountry()
-{
-    return ms_country;
-}
+#define MILLISECONDS_PER_DAY 86400000l
+
+// some broken compilers (HP-UX CC) refuse to compile the "normal" version, but
+// using a temp variable always might prevent other compilers from optimising
+// it away - hence use of this ugly macro
+#ifndef __HPUX__
+    #define MODIFY_AND_RETURN(op) return wxDateTime(*this).op
+#else
+    #define MODIFY_AND_RETURN(op) wxDateTime dt(*this); dt.op; return dt
+#endif
 
 // ----------------------------------------------------------------------------
 // wxDateTime construction
 // ----------------------------------------------------------------------------
 
-// only define this once, when included from datetime.cpp
-#ifdef wxDEFINE_TIME_CONSTANTS
-    const unsigned int wxDateTime::TIME_T_FACTOR = 1000;
-#endif // wxDEFINE_TIME_CONSTANTS
+inline bool wxDateTime::IsInStdRange() const
+{
+    return m_time >= 0l && (m_time / TIME_T_FACTOR) < LONG_MAX;
+}
 
-bool wxDateTime::IsInStdRange() const
+/* static */
+inline wxDateTime wxDateTime::Now()
 {
-    return m_time >= 0l && (m_time / (long)TIME_T_FACTOR) < LONG_MAX;
+    return wxDateTime(*GetTmNow());
 }
 
 /* static */
-wxDateTime wxDateTime::Now()
+inline wxDateTime wxDateTime::Today()
 {
-    return wxDateTime(GetTimeNow());
+    struct tm *time = GetTmNow();
+    time->tm_hour = 0;
+    time->tm_min = 0;
+    time->tm_sec = 0;
+
+    return wxDateTime(*time);
 }
 
-wxDateTime& wxDateTime::Set(time_t timet)
+#if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
+inline wxDateTime& wxDateTime::Set(time_t timet)
 {
     // assign first to avoid long multiplication overflow!
-    m_time = timet;
+    m_time = timet - WX_TIME_BASE_OFFSET ;
     m_time *= TIME_T_FACTOR;
 
     return *this;
 }
+#endif
 
-wxDateTime& wxDateTime::SetToCurrent()
+inline wxDateTime& wxDateTime::SetToCurrent()
 {
-    return Set(GetTimeNow());
+    *this = Now();
+    return *this;
 }
 
-wxDateTime::wxDateTime(time_t timet)
+#if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
+inline wxDateTime::wxDateTime(time_t timet)
 {
     Set(timet);
 }
+#endif
 
-wxDateTime::wxDateTime(const struct tm& tm)
+inline wxDateTime::wxDateTime(const struct tm& tm)
 {
     Set(tm);
 }
 
-wxDateTime::wxDateTime(const Tm& tm)
+inline wxDateTime::wxDateTime(const Tm& tm)
 {
     Set(tm);
 }
 
-wxDateTime& wxDateTime::Set(const Tm& tm)
+inline wxDateTime::wxDateTime(double jdn)
+{
+    Set(jdn);
+}
+
+inline wxDateTime& wxDateTime::Set(const Tm& tm)
 {
     wxASSERT_MSG( tm.IsValid(), _T("invalid broken down date/time") );
 
-    return Set(tm.mday, (Month)tm.mon, tm.year, tm.hour, tm.min, tm.sec);
+    return Set(tm.mday, (Month)tm.mon, tm.year,
+               tm.hour, tm.min, tm.sec, tm.msec);
 }
 
-wxDateTime::wxDateTime(wxDateTime_t hour,
-                       wxDateTime_t minute,
-                       wxDateTime_t second,
-                       wxDateTime_t millisec)
+inline wxDateTime::wxDateTime(wxDateTime_t hour,
+                              wxDateTime_t minute,
+                              wxDateTime_t second,
+                              wxDateTime_t millisec)
 {
     Set(hour, minute, second, millisec);
 }
 
-wxDateTime::wxDateTime(wxDateTime_t day,
-                       Month        month,
-                       int          year,
-                       wxDateTime_t hour,
-                       wxDateTime_t minute,
-                       wxDateTime_t second,
-                       wxDateTime_t millisec)
+inline wxDateTime::wxDateTime(wxDateTime_t day,
+                              Month        month,
+                              int          year,
+                              wxDateTime_t hour,
+                              wxDateTime_t minute,
+                              wxDateTime_t second,
+                              wxDateTime_t millisec)
 {
     Set(day, month, year, hour, minute, second, millisec);
 }
@@ -105,134 +127,230 @@ wxDateTime::wxDateTime(wxDateTime_t day,
 // wxDateTime accessors
 // ----------------------------------------------------------------------------
 
-wxLongLong wxDateTime::GetValue() const
+inline wxLongLong wxDateTime::GetValue() const
 {
-    wxASSERT_MSG( IsValid(), "invalid wxDateTime");
+    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
 
     return m_time;
 }
 
-time_t wxDateTime::GetTicks() const
+inline time_t wxDateTime::GetTicks() const
 {
-    wxASSERT_MSG( IsValid(), "invalid wxDateTime");
+    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
     if ( !IsInStdRange() )
     {
         return (time_t)-1;
     }
 
-    return (time_t)((m_time / (long)TIME_T_FACTOR).GetLo());
+    return (time_t)((m_time / (long)TIME_T_FACTOR).GetLo())+WX_TIME_BASE_OFFSET ;
 }
 
-bool wxDateTime::SetToLastWeekDay(WeekDay weekday,
-                                  Month month,
-                                  int year)
+inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday,
+                                         Month month,
+                                         int year)
 {
     return SetToWeekDay(weekday, -1, month, year);
 }
 
-// ----------------------------------------------------------------------------
-// wxDateTime comparison
-// ----------------------------------------------------------------------------
+inline wxDateTime wxDateTime::GetWeekDayInSameWeek(WeekDay weekday,
+                                                   WeekFlags flags) const
+{
+    MODIFY_AND_RETURN( SetToWeekDayInSameWeek(weekday) );
+}
 
-bool wxDateTime::IsEqualTo(const wxDateTime& datetime) const
+inline wxDateTime wxDateTime::GetNextWeekDay(WeekDay weekday) const
 {
-    wxASSERT_MSG( IsValid() && datetime.IsValid(), "invalid wxDateTime");
+    MODIFY_AND_RETURN( SetToNextWeekDay(weekday) );
+}
 
-    return m_time == datetime.m_time;
+inline wxDateTime wxDateTime::GetPrevWeekDay(WeekDay weekday) const
+{
+    MODIFY_AND_RETURN( SetToPrevWeekDay(weekday) );
 }
 
-bool wxDateTime::operator==(const wxDateTime& datetime) const
+inline wxDateTime wxDateTime::GetWeekDay(WeekDay weekday,
+                                         int n,
+                                         Month month,
+                                         int year) const
 {
-    return IsEqualTo(datetime);
+    wxDateTime dt(*this);
+
+    return dt.SetToWeekDay(weekday, n, month, year) ? dt : wxInvalidDateTime;
 }
 
-bool wxDateTime::operator!=(const wxDateTime& datetime) const
+inline wxDateTime wxDateTime::GetLastWeekDay(WeekDay weekday,
+                                             Month month,
+                                             int year)
 {
-    return !IsEqualTo(datetime);
+    wxDateTime dt(*this);
+
+    return dt.SetToLastWeekDay(weekday, month, year) ? dt : wxInvalidDateTime;
 }
 
-bool wxDateTime::IsEarlierThan(const wxDateTime& datetime) const
+inline wxDateTime wxDateTime::GetWeek(wxDateTime_t numWeek,
+                                      WeekDay weekday,
+                                      WeekFlags flags) const
 {
-    wxASSERT_MSG( IsValid() && datetime.IsValid(), "invalid wxDateTime");
+    wxDateTime dt(*this);
+
+    return dt.SetToTheWeek(numWeek, weekday, flags) ? dt : wxInvalidDateTime;
+}
+
+inline wxDateTime wxDateTime::GetLastMonthDay(Month month, int year) const
+{
+    MODIFY_AND_RETURN( SetToLastMonthDay(month, year) );
+}
+
+inline wxDateTime wxDateTime::GetYearDay(wxDateTime_t yday) const
+{
+    MODIFY_AND_RETURN( SetToYearDay(yday) );
+}
+
+// ----------------------------------------------------------------------------
+// wxDateTime comparison
+// ----------------------------------------------------------------------------
+
+inline bool wxDateTime::IsEqualTo(const wxDateTime& datetime) const
+{
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+
+    return m_time == datetime.m_time;
+}
+
+inline bool wxDateTime::IsEarlierThan(const wxDateTime& datetime) const
+{
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
 
     return m_time < datetime.m_time;
 }
 
-bool wxDateTime::IsLaterThan(const wxDateTime& datetime) const
+inline bool wxDateTime::IsLaterThan(const wxDateTime& datetime) const
 {
-    wxASSERT_MSG( IsValid() && datetime.IsValid(), "invalid wxDateTime");
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
 
     return m_time > datetime.m_time;
 }
 
-bool wxDateTime::IsStrictlyBetween(const wxDateTime& t1,
-                                   const wxDateTime& t2) const
+inline bool wxDateTime::IsStrictlyBetween(const wxDateTime& t1,
+                                          const wxDateTime& t2) const
 {
     // no need for assert, will be checked by the functions we call
     return IsLaterThan(t1) && IsEarlierThan(t2);
 }
 
-bool wxDateTime::IsBetween(const wxDateTime& t1, const wxDateTime& t2) const
+inline bool wxDateTime::IsBetween(const wxDateTime& t1,
+                                  const wxDateTime& t2) const
 {
     // no need for assert, will be checked by the functions we call
     return IsEqualTo(t1) || IsEqualTo(t2) || IsStrictlyBetween(t1, t2);
 }
 
+inline bool wxDateTime::IsSameDate(const wxDateTime& dt) const
+{
+    Tm tm1 = GetTm(),
+       tm2 = dt.GetTm();
+
+    return tm1.year == tm2.year &&
+           tm1.mon == tm2.mon &&
+           tm1.mday == tm2.mday;
+}
+
+inline bool wxDateTime::IsSameTime(const wxDateTime& dt) const
+{
+    // notice that we can't do something like this:
+    //
+    //    m_time % MILLISECONDS_PER_DAY == dt.m_time % MILLISECONDS_PER_DAY
+    //
+    // because we have also to deal with (possibly) different DST settings!
+    Tm tm1 = GetTm(),
+       tm2 = dt.GetTm();
+
+    return tm1.hour == tm2.hour &&
+           tm1.min == tm2.min &&
+           tm1.sec == tm2.sec &&
+           tm1.msec == tm2.msec;
+}
+
+inline bool wxDateTime::IsEqualUpTo(const wxDateTime& dt,
+                                    const wxTimeSpan& ts) const
+{
+    return IsBetween(dt.Subtract(ts), dt.Add(ts));
+}
+
 // ----------------------------------------------------------------------------
 // wxDateTime arithmetics
 // ----------------------------------------------------------------------------
 
-wxDateTime& wxDateTime::Add(const wxTimeSpan& diff)
+inline wxDateTime wxDateTime::Add(const wxTimeSpan& diff) const
+{
+    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+
+    return wxDateTime(m_time + diff.GetValue());
+}
+
+inline wxDateTime& wxDateTime::Add(const wxTimeSpan& diff)
 {
-    wxASSERT_MSG( IsValid(), "invalid wxDateTime");
+    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
 
     m_time += diff.GetValue();
 
     return *this;
 }
 
-wxDateTime& wxDateTime::operator+=(const wxTimeSpan& diff)
+inline wxDateTime& wxDateTime::operator+=(const wxTimeSpan& diff)
 {
     return Add(diff);
 }
 
-wxDateTime& wxDateTime::Substract(const wxTimeSpan& diff)
+inline wxDateTime wxDateTime::Subtract(const wxTimeSpan& diff) const
 {
-    wxASSERT_MSG( IsValid(), "invalid wxDateTime");
+    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+
+    return wxDateTime(m_time - diff.GetValue());
+}
+
+inline wxDateTime& wxDateTime::Subtract(const wxTimeSpan& diff)
+{
+    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
 
     m_time -= diff.GetValue();
 
     return *this;
 }
 
-wxDateTime& wxDateTime::operator-=(const wxTimeSpan& diff)
+inline wxDateTime& wxDateTime::operator-=(const wxTimeSpan& diff)
 {
-    return Substract(diff);
+    return Subtract(diff);
 }
 
-wxTimeSpan wxDateTime::Substract(const wxDateTime& datetime) const
+inline wxTimeSpan wxDateTime::Subtract(const wxDateTime& datetime) const
 {
-    wxASSERT_MSG( IsValid() && datetime.IsValid(), "invalid wxDateTime");
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
 
-    return wxTimeSpan(datetime.GetValue() - GetValue());
+    return wxTimeSpan(GetValue() - datetime.GetValue());
 }
 
-wxTimeSpan wxDateTime::operator-(const wxDateTime& datetime) const
+inline wxDateTime wxDateTime::Add(const wxDateSpan& diff) const
 {
-    return Substract(datetime);
+    return wxDateTime(*this).Add(diff);
 }
 
-wxDateTime& wxDateTime::Substract(const wxDateSpan& diff)
+inline wxDateTime& wxDateTime::Subtract(const wxDateSpan& diff)
 {
     return Add(diff.Negate());
 }
 
-wxDateTime& wxDateTime::operator-=(const wxDateSpan& diff)
+inline wxDateTime wxDateTime::Subtract(const wxDateSpan& diff) const
 {
-    return Substract(diff);
+    return wxDateTime(*this).Subtract(diff);
 }
 
-wxDateTime& wxDateTime::operator+=(const wxDateSpan& diff)
+inline wxDateTime& wxDateTime::operator-=(const wxDateSpan& diff)
+{
+    return Subtract(diff);
+}
+
+inline wxDateTime& wxDateTime::operator+=(const wxDateSpan& diff)
 {
     return Add(diff);
 }
@@ -241,77 +359,111 @@ wxDateTime& wxDateTime::operator+=(const wxDateSpan& diff)
 // wxDateTime and timezones
 // ----------------------------------------------------------------------------
 
-wxDateTime wxDateTime::ToUTC() const
+inline wxDateTime wxDateTime::ToTimezone(const wxDateTime::TimeZone& tz,
+                                         bool noDST) const
+{
+    MODIFY_AND_RETURN( MakeTimezone(tz, noDST) );
+}
+
+// ----------------------------------------------------------------------------
+// wxTimeSpan construction
+// ----------------------------------------------------------------------------
+
+inline wxTimeSpan::wxTimeSpan(long hours,
+                              long minutes,
+                              long seconds,
+                              long milliseconds)
+{
+    // assign first to avoid precision loss
+    m_diff = hours;
+    m_diff *= 60l;
+    m_diff += minutes;
+    m_diff *= 60l;
+    m_diff += seconds;
+    m_diff *= 1000l;
+    m_diff += milliseconds;
+}
+
+// ----------------------------------------------------------------------------
+// wxTimeSpan accessors
+// ----------------------------------------------------------------------------
+
+inline wxLongLong wxTimeSpan::GetSeconds() const
+{
+    return m_diff / 1000l;
+}
+
+inline int wxTimeSpan::GetMinutes() const
+{
+    return (GetSeconds() / 60l).GetLo();
+}
+
+inline int wxTimeSpan::GetHours() const
 {
-    return wxDateTime(*this).MakeUTC();
+    return GetMinutes() / 60;
 }
 
-wxDateTime wxDateTime::ToTimezone(const wxDateTime::TimeZone& tz) const
+inline int wxTimeSpan::GetDays() const
 {
-    return wxDateTime(*this).MakeTimezone(tz);
+    return GetHours() / 24;
 }
 
-wxDateTime wxDateTime::ToLocalTime(const wxDateTime::TimeZone& tz) const
+inline int wxTimeSpan::GetWeeks() const
 {
-    return wxDateTime(*this).MakeLocalTime(tz);
+    return GetDays() / 7;
 }
 
 // ----------------------------------------------------------------------------
-// wxTimeSpan
+// wxTimeSpan arithmetics
 // ----------------------------------------------------------------------------
 
-wxTimeSpan::wxTimeSpan(int hours, int minutes, int seconds, int milliseconds)
+inline wxTimeSpan wxTimeSpan::Add(const wxTimeSpan& diff) const
 {
-    // assign first to avoid precision loss
-    m_diff = hours;
-    m_diff *= 60;
-    m_diff += minutes;
-    m_diff *= 60;
-    m_diff += seconds;
-    m_diff *= 1000;
-    m_diff += milliseconds;
+    return wxTimeSpan(m_diff + diff.GetValue());
 }
 
-wxTimeSpan& wxTimeSpan::Add(const wxTimeSpan& diff)
+inline wxTimeSpan& wxTimeSpan::Add(const wxTimeSpan& diff)
 {
     m_diff += diff.GetValue();
 
     return *this;
 }
 
-wxTimeSpan& wxTimeSpan::Substract(const wxTimeSpan& diff)
+inline wxTimeSpan wxTimeSpan::Subtract(const wxTimeSpan& diff) const
+{
+    return wxTimeSpan(m_diff - diff.GetValue());
+}
+
+inline wxTimeSpan& wxTimeSpan::Subtract(const wxTimeSpan& diff)
 {
     m_diff -= diff.GetValue();
 
     return *this;
 }
 
-wxTimeSpan& wxTimeSpan::Multiply(int n)
+inline wxTimeSpan& wxTimeSpan::Multiply(int n)
 {
-    m_diff *= n;
+    m_diff *= (long)n;
 
     return *this;
 }
 
-wxTimeSpan wxTimeSpan::operator*(int n) const
+inline wxTimeSpan wxTimeSpan::Multiply(int n) const
 {
-    wxTimeSpan result(*this);
-    result.Multiply(n);
-
-    return result;
+    return wxTimeSpan(m_diff * (long)n);
 }
 
-wxTimeSpan wxTimeSpan::Abs() const
+inline wxTimeSpan wxTimeSpan::Abs() const
 {
     return wxTimeSpan(GetValue().Abs());
 }
 
-bool wxTimeSpan::IsEqualTo(const wxTimeSpan& ts) const
+inline bool wxTimeSpan::IsEqualTo(const wxTimeSpan& ts) const
 {
     return GetValue() == ts.GetValue();
 }
 
-bool wxTimeSpan::IsLongerThan(const wxTimeSpan& ts) const
+inline bool wxTimeSpan::IsLongerThan(const wxTimeSpan& ts) const
 {
     return GetValue().Abs() > ts.GetValue().Abs();
 }
@@ -320,8 +472,7 @@ bool wxTimeSpan::IsLongerThan(const wxTimeSpan& ts) const
 // wxDateSpan
 // ----------------------------------------------------------------------------
 
-wxDateSpan&
-wxDateSpan::operator+=(const wxDateSpan& other)
+inline wxDateSpan& wxDateSpan::operator+=(const wxDateSpan& other)
 {
     m_years += other.m_years;
     m_months += other.m_months;
@@ -331,22 +482,41 @@ wxDateSpan::operator+=(const wxDateSpan& other)
     return *this;
 }
 
-wxDateSpan& wxDateSpan::operator*=(int factor)
+inline wxDateSpan& wxDateSpan::Add(const wxDateSpan& other)
 {
-    m_years *= m_years;
-    m_months *= m_months;
-    m_weeks *= m_weeks;
-    m_days *= m_days;
+    return *this += other;
+}
+
+inline wxDateSpan wxDateSpan::Add(const wxDateSpan& other) const
+{
+    wxDateSpan ds(*this);
+    ds.Add(other);
+    return ds;
+}
+
+inline wxDateSpan& wxDateSpan::Multiply(int factor)
+{
+    m_years *= factor;
+    m_months *= factor;
+    m_weeks *= factor;
+    m_days *= factor;
 
     return *this;
 }
 
-wxDateSpan wxDateSpan::Negate() const
+inline wxDateSpan wxDateSpan::Multiply(int factor) const
+{
+    wxDateSpan ds(*this);
+    ds.Multiply(factor);
+    return ds;
+}
+
+inline wxDateSpan wxDateSpan::Negate() const
 {
     return wxDateSpan(-m_years, -m_months, -m_weeks, -m_days);
 }
 
-wxDateSpan& wxDateSpan::Neg()
+inline wxDateSpan& wxDateSpan::Neg()
 {
     m_years = -m_years;
     m_months = -m_months;
@@ -356,3 +526,23 @@ wxDateSpan& wxDateSpan::Neg()
     return *this;
 }
 
+inline wxDateSpan& wxDateSpan::operator-=(const wxDateSpan& other)
+{
+    return *this += other.Negate();
+}
+
+inline wxDateSpan& wxDateSpan::Subtract(const wxDateSpan& other)
+{
+    return *this -= other;
+}
+
+inline wxDateSpan wxDateSpan::Subtract(const wxDateSpan& other) const
+{
+    wxDateSpan ds(*this);
+    ds.Subtract(other);
+    return ds;
+}
+
+#undef MILLISECONDS_PER_DAY
+
+#undef MODIFY_AND_RETURN