assert that wxRound() argument is in the supported range

[wxWidgets.git] / include / wx / datetime.h

diff --git a/include/wx/datetime.h b/include/wx/datetime.h
index d1172a10e594959ae24d5cd759d4fd36440855d6..281fe06575eb5f8dc6f9af98258657b56b180a77 100644 (file)
--- a/include/wx/datetime.h
+++ b/include/wx/datetime.h
@@ -52,6 +52,27 @@ class WXDLLIMPEXP_BASE wxDateSpan;
  *   5. wxDateTimeHolidayAuthority for Easter and other christian feasts
  */
 
  *   5. wxDateTimeHolidayAuthority for Easter and other christian feasts
  */
 

+/* Two wrapper functions for thread safety */
+#ifdef HAVE_LOCALTIME_R
+#define wxLocaltime_r localtime_r
+#else
+WXDLLIMPEXP_BASE struct tm *wxLocaltime_r(const time_t*, struct tm*);
+#if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
+     // On Windows, localtime _is_ threadsafe!
+#warning using pseudo thread-safe wrapper for localtime to emulate localtime_r
+#endif
+#endif
+
+#ifdef HAVE_GMTIME_R
+#define wxGmtime_r gmtime_r
+#else
+WXDLLIMPEXP_BASE struct tm *wxGmtime_r(const time_t*, struct tm*);
+#if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
+     // On Windows, gmtime _is_ threadsafe!
+#warning using pseudo thread-safe wrapper for gmtime to emulate gmtime_r
+#endif
+#endif
+

 /*
   The three (main) classes declared in this header represent:
 
 /*
   The three (main) classes declared in this header represent:
 


@@ -147,7 +168,7 @@ public:
         GMT_6, GMT_5, GMT_4, GMT_3, GMT_2, GMT_1,
         GMT0,
         GMT1, GMT2, GMT3, GMT4, GMT5, GMT6,
         GMT_6, GMT_5, GMT_4, GMT_3, GMT_2, GMT_1,
         GMT0,
         GMT1, GMT2, GMT3, GMT4, GMT5, GMT6,

-        GMT7, GMT8, GMT9, GMT10, GMT11, GMT12,
+        GMT7, GMT8, GMT9, GMT10, GMT11, GMT12, GMT13,

         // Note that GMT12 and GMT_12 are not the same: there is a difference
         // of exactly one day between them
 
         // Note that GMT12 and GMT_12 are not the same: there is a difference
         // of exactly one day between them
 


@@ -181,10 +202,14 @@ public:
         // Australia
 
         A_WST = GMT8,                       // Western Standard Time
         // Australia
 
         A_WST = GMT8,                       // Western Standard Time

-        A_CST = GMT12 + 1,                  // Central Standard Time (+9.5)
+        A_CST = GMT13 + 1,                  // Central Standard Time (+9.5)

         A_EST = GMT10,                      // Eastern Standard Time
         A_ESST = GMT11,                     // Eastern Summer Time
 
         A_EST = GMT10,                      // Eastern Standard Time
         A_ESST = GMT11,                     // Eastern Summer Time
 

+        // New Zealand
+        NZST = GMT12,                       // Standard Time
+        NZDT = GMT13,                       // Daylight Saving Time
+

         // TODO add more symbolic timezone names here
 
         // Universal Coordinated Time = the new and politically correct name
         // TODO add more symbolic timezone names here
 
         // Universal Coordinated Time = the new and politically correct name


@@ -482,7 +507,7 @@ public:
     static bool IsLeapYear(int year = Inv_Year, Calendar cal = Gregorian);
 
         // get the century (19 for 1999, 20 for 2000 and -5 for 492 BC)
     static bool IsLeapYear(int year = Inv_Year, Calendar cal = Gregorian);
 
         // get the century (19 for 1999, 20 for 2000 and -5 for 492 BC)

-    static int GetCentury(int year = Inv_Year);
+    static int GetCentury(int year);

 
         // returns the number of days in this year (356 or 355 for Gregorian
         // calendar usually :-)
 
         // returns the number of days in this year (356 or 355 for Gregorian
         // calendar usually :-)


@@ -539,7 +564,7 @@ public:
     // ------------------------------------------------------------------------
 
         // default ctor does not initialize the object, use Set()!
     // ------------------------------------------------------------------------
 
         // default ctor does not initialize the object, use Set()!

-    wxDateTime() { m_time = wxLongLong((long)ULONG_MAX, ULONG_MAX); }
+    wxDateTime() { m_time = wxLongLong(wxINT32_MIN, 0); }

 
         // from time_t: seconds since the Epoch 00:00:00 UTC, Jan 1, 1970)
 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
 
         // from time_t: seconds since the Epoch 00:00:00 UTC, Jan 1, 1970)
 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))


@@ -614,6 +639,10 @@ public:
         // resets time to 00:00:00, doesn't change the date
     wxDateTime& ResetTime();
 
         // resets time to 00:00:00, doesn't change the date
     wxDateTime& ResetTime();
 

+        // get the date part of this object only, i.e. the object which has the
+        // same date as this one but time of 00:00:00
+    wxDateTime GetDateOnly() const;
+

         // the following functions don't change the values of the other
         // fields, i.e. SetMinute() won't change either hour or seconds value
 
         // the following functions don't change the values of the other
         // fields, i.e. SetMinute() won't change either hour or seconds value
 


@@ -683,6 +712,7 @@ public:
                                      Month month = Inv_Month,
                                      int year = Inv_Year);
 
                                      Month month = Inv_Month,
                                      int year = Inv_Year);
 

+#if WXWIN_COMPATIBILITY_2_6

         // sets the date to the given day of the given week in the year,
         // returns true on success and false if given date doesn't exist (e.g.
         // numWeek is > 53)
         // sets the date to the given day of the given week in the year,
         // returns true on success and false if given date doesn't exist (e.g.
         // numWeek is > 53)


@@ -695,6 +725,7 @@ public:
     wxDEPRECATED( wxDateTime GetWeek(wxDateTime_t numWeek,
                                      WeekDay weekday = Mon,
                                      WeekFlags flags = Monday_First) const );
     wxDEPRECATED( wxDateTime GetWeek(wxDateTime_t numWeek,
                                      WeekDay weekday = Mon,
                                      WeekFlags flags = Monday_First) const );

+#endif // WXWIN_COMPATIBILITY_2_6

 
         // returns the date corresponding to the given week day of the given
         // week (in ISO notation) of the specified year
 
         // returns the date corresponding to the given week day of the given
         // week (in ISO notation) of the specified year


@@ -769,12 +800,10 @@ public:
     inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
     wxDateTime& MakeTimezone(const TimeZone& tz, bool noDST = false);
 
     inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
     wxDateTime& MakeTimezone(const TimeZone& tz, bool noDST = false);
 

-#if wxABI_VERSION >= 20602

         // interpret current value as being in another timezone and transform
         // it to local one
     inline wxDateTime FromTimezone(const TimeZone& tz, bool noDST = false) const;
     wxDateTime& MakeFromTimezone(const TimeZone& tz, bool noDST = false);
         // interpret current value as being in another timezone and transform
         // it to local one
     inline wxDateTime FromTimezone(const TimeZone& tz, bool noDST = false) const;
     wxDateTime& MakeFromTimezone(const TimeZone& tz, bool noDST = false);

-#endif // ABI >= 2.6.2

 
         // transform to/from GMT/UTC
     wxDateTime ToUTC(bool noDST = false) const { return ToTimezone(UTC, noDST); }
 
         // transform to/from GMT/UTC
     wxDateTime ToUTC(bool noDST = false) const { return ToTimezone(UTC, noDST); }


@@ -783,12 +812,10 @@ public:
     wxDateTime ToGMT(bool noDST = false) const { return ToUTC(noDST); }
     wxDateTime& MakeGMT(bool noDST = false) { return MakeUTC(noDST); }
 
     wxDateTime ToGMT(bool noDST = false) const { return ToUTC(noDST); }
     wxDateTime& MakeGMT(bool noDST = false) { return MakeUTC(noDST); }
 

-#if wxABI_VERSION >= 20602

     wxDateTime FromUTC(bool noDST = false) const
         { return FromTimezone(UTC, noDST); }
     wxDateTime& MakeFromUTC(bool noDST = false)
         { return MakeFromTimezone(UTC, noDST); }
     wxDateTime FromUTC(bool noDST = false) const
         { return FromTimezone(UTC, noDST); }
     wxDateTime& MakeFromUTC(bool noDST = false)
         { return MakeFromTimezone(UTC, noDST); }

-#endif // ABI >= 2.6.2

 
         // is daylight savings time in effect at this moment according to the
         // rules of the specified country?
 
         // is daylight savings time in effect at this moment according to the
         // rules of the specified country?


@@ -819,6 +846,9 @@ public:
         // if the value is out of range
     inline time_t GetTicks() const;
 
         // if the value is out of range
     inline time_t GetTicks() const;
 

+        // get the century, same as GetCentury(GetYear())
+    int GetCentury(const TimeZone& tz = Local) const
+            { return GetCentury(GetYear(tz)); }

         // get the year (returns Inv_Year if date is invalid)
     int GetYear(const TimeZone& tz = Local) const
             { return GetTm(tz).year; }
         // get the year (returns Inv_Year if date is invalid)
     int GetYear(const TimeZone& tz = Local) const
             { return GetTm(tz).year; }


@@ -1059,6 +1089,9 @@ public:
         return localtime(&t);
     }
 
         return localtime(&t);
     }
 

+    // get current time using thread-safe function
+    static struct tm *GetTmNow(struct tm *tmstruct);
+

 private:
     // the current country - as it's the same for all program objects (unless
     // it runs on a _really_ big cluster system :-), this is a static member:
 private:
     // the current country - as it's the same for all program objects (unless
     // it runs on a _really_ big cluster system :-), this is a static member:


@@ -1092,8 +1125,12 @@ public:
     // constructors
     // ------------------------------------------------------------------------
 
     // constructors
     // ------------------------------------------------------------------------
 

+        // return the timespan for the given number of milliseconds
+    static wxTimeSpan Milliseconds(wxLongLong ms) { return wxTimeSpan(0, 0, 0, ms); }
+    static wxTimeSpan Millisecond() { return Milliseconds(1); }
+

         // return the timespan for the given number of seconds
         // return the timespan for the given number of seconds

-    static wxTimeSpan Seconds(long sec) { return wxTimeSpan(0, 0, sec); }
+    static wxTimeSpan Seconds(wxLongLong sec) { return wxTimeSpan(0, 0, sec); }

     static wxTimeSpan Second() { return Seconds(1); }
 
         // return the timespan for the given number of minutes
     static wxTimeSpan Second() { return Seconds(1); }
 
         // return the timespan for the given number of minutes


@@ -1120,8 +1157,8 @@ public:
         // milliseconds)
     inline wxTimeSpan(long hours,
                       long minutes = 0,
         // milliseconds)
     inline wxTimeSpan(long hours,
                       long minutes = 0,

-                      long seconds = 0,
-                      long milliseconds = 0);
+                      wxLongLong seconds = 0,
+                      wxLongLong milliseconds = 0);

 
         // default copy ctor is ok
 
 
         // default copy ctor is ok
 


@@ -1541,7 +1578,8 @@ inline bool wxDateTime::IsInStdRange() const
 /* static */
 inline wxDateTime wxDateTime::Now()
 {
 /* static */
 inline wxDateTime wxDateTime::Now()
 {

-    return wxDateTime(*GetTmNow());
+    struct tm tmstruct;
+    return wxDateTime(*GetTmNow(&tmstruct));

 }
 
 /* static */
 }
 
 /* static */


@@ -1858,24 +1896,20 @@ wxDateTime::ToTimezone(const wxDateTime::TimeZone& tz, bool noDST) const
     MODIFY_AND_RETURN( MakeTimezone(tz, noDST) );
 }
 
     MODIFY_AND_RETURN( MakeTimezone(tz, noDST) );
 }
 

-#if wxABI_VERSION >= 20602
-

 inline wxDateTime
 wxDateTime::FromTimezone(const wxDateTime::TimeZone& tz, bool noDST) const
 {
     MODIFY_AND_RETURN( MakeFromTimezone(tz, noDST) );
 }
 
 inline wxDateTime
 wxDateTime::FromTimezone(const wxDateTime::TimeZone& tz, bool noDST) const
 {
     MODIFY_AND_RETURN( MakeFromTimezone(tz, noDST) );
 }
 

-#endif // ABI >= 2.6.2
-

 // ----------------------------------------------------------------------------
 // wxTimeSpan construction
 // ----------------------------------------------------------------------------
 
 inline wxTimeSpan::wxTimeSpan(long hours,
                               long minutes,
 // ----------------------------------------------------------------------------
 // wxTimeSpan construction
 // ----------------------------------------------------------------------------
 
 inline wxTimeSpan::wxTimeSpan(long hours,
                               long minutes,

-                              long seconds,
-                              long milliseconds)
+                              wxLongLong seconds,
+                              wxLongLong milliseconds)

 {
     // assign first to avoid precision loss
     m_diff = hours;
 {
     // assign first to avoid precision loss
     m_diff = hours;


@@ -1898,7 +1932,9 @@ inline wxLongLong wxTimeSpan::GetSeconds() const
 
 inline int wxTimeSpan::GetMinutes() const
 {
 
 inline int wxTimeSpan::GetMinutes() const
 {

-    return (GetSeconds() / 60l).GetLo();
+    // explicit cast to int suppresses a warning with CodeWarrior and possibly
+    // others (changing the return type to long from int is impossible in 2.8)
+    return (int)((GetSeconds() / 60l).GetLo());

 }
 
 inline int wxTimeSpan::GetHours() const
 }
 
 inline int wxTimeSpan::GetHours() const