do platform-specific checks after ensuring that the symbols we use are defined; extra...

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

diff --git a/include/wx/datetime.h b/include/wx/datetime.h
index 16bf40e690c2bc873f857383c39c18ea0ffe486f..c5f9f365df2f6cbfb0e487c6407ccce8ec72bbde 100644 (file)
--- a/include/wx/datetime.h
+++ b/include/wx/datetime.h
@@ -13,10 +13,6 @@
 #ifndef _WX_DATETIME_H
 #define _WX_DATETIME_H
 
 #ifndef _WX_DATETIME_H
 #define _WX_DATETIME_H
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "datetime.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_DATETIME
 #include "wx/defs.h"
 
 #if wxUSE_DATETIME


@@ -31,9 +27,9 @@
 
 #include "wx/longlong.h"
 
 
 #include "wx/longlong.h"
 

-class WXDLLIMPEXP_BASE wxDateTime;
-class WXDLLIMPEXP_BASE wxTimeSpan;
-class WXDLLIMPEXP_BASE wxDateSpan;
+class WXDLLIMPEXP_FWD_BASE wxDateTime;
+class WXDLLIMPEXP_FWD_BASE wxTimeSpan;
+class WXDLLIMPEXP_FWD_BASE wxDateSpan;

 
 #include "wx/dynarray.h"
 
 
 #include "wx/dynarray.h"
 


@@ -56,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:
 


@@ -108,7 +125,7 @@ class WXDLLIMPEXP_BASE wxDateSpan;
 // argument for arguments of type wxDateTime; it is also returned by all
 // functions returning wxDateTime on failure (this is why it is also called
 // wxInvalidDateTime)
 // argument for arguments of type wxDateTime; it is also returned by all
 // functions returning wxDateTime on failure (this is why it is also called
 // wxInvalidDateTime)

-class WXDLLIMPEXP_BASE wxDateTime;
+class WXDLLIMPEXP_FWD_BASE wxDateTime;

 
 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDefaultDateTimeFormat;
 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDefaultTimeSpanFormat;
 
 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDefaultDateTimeFormat;
 extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDefaultTimeSpanFormat;


@@ -151,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
 


@@ -185,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


@@ -486,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 :-)


@@ -543,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))


@@ -618,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
 


@@ -687,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)


@@ -699,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


@@ -757,26 +784,38 @@ public:
         //      religious holidays (Easter...) or moon/solar eclipses? Some
         //      algorithms can be found in the calendar FAQ
 
         //      religious holidays (Easter...) or moon/solar eclipses? Some
         //      algorithms can be found in the calendar FAQ
 

-    // timezone stuff: a wxDateTime object constructed using given
-    // day/month/year/hour/min/sec values correspond to this moment in local
-    // time. Using the functions below, it may be converted to another time
-    // zone (for example, the Unix epoch is wxDateTime(1, Jan, 1970).ToGMT())
+
+    // Timezone stuff: a wxDateTime object constructed using given
+    // day/month/year/hour/min/sec values is interpreted as this moment in
+    // local time. Using the functions below, it may be converted to another
+    // time zone (e.g., the Unix epoch is wxDateTime(1, Jan, 1970).ToGMT()).

     //
     //

-    // these functions try to handle DST internally, but there is no magical
+    // These functions try to handle DST internally, but there is no magical

     // way to know all rules for it in all countries in the world, so if the
     // program can handle it itself (or doesn't want to handle it at all for
     // whatever reason), the DST handling can be disabled with noDST.
     // way to know all rules for it in all countries in the world, so if the
     // program can handle it itself (or doesn't want to handle it at all for
     // whatever reason), the DST handling can be disabled with noDST.

-    //
-    // Converting to the local time zone doesn't do anything.

     // ------------------------------------------------------------------------
 
         // transform to any given timezone
     inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
     wxDateTime& MakeTimezone(const TimeZone& tz, bool noDST = false);
 
     // ------------------------------------------------------------------------
 
         // transform to any given timezone
     inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
     wxDateTime& MakeTimezone(const TimeZone& tz, bool noDST = false);
 

-        // transform to GMT/UTC
-    wxDateTime ToGMT(bool noDST = false) const { return ToTimezone(GMT0, noDST); }
-    wxDateTime& MakeGMT(bool noDST = false) { return MakeTimezone(GMT0, noDST); }
+        // 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);
+
+        // transform to/from GMT/UTC
+    wxDateTime ToUTC(bool noDST = false) const { return ToTimezone(UTC, noDST); }
+    wxDateTime& MakeUTC(bool noDST = false) { return MakeTimezone(UTC, noDST); }
+
+    wxDateTime ToGMT(bool noDST = false) const { return ToUTC(noDST); }
+    wxDateTime& MakeGMT(bool noDST = false) { return MakeUTC(noDST); }
+
+    wxDateTime FromUTC(bool noDST = false) const
+        { return FromTimezone(UTC, noDST); }
+    wxDateTime& MakeFromUTC(bool noDST = false)
+        { return MakeFromTimezone(UTC, noDST); }

 
         // 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?


@@ -785,6 +824,7 @@ public:
         // the information is not available (this is compatible with ANSI C)
     int IsDST(Country country = Country_Default) const;
 
         // the information is not available (this is compatible with ANSI C)
     int IsDST(Country country = Country_Default) const;
 

+

     // accessors: many of them take the timezone parameter which indicates the
     // timezone for which to make the calculations and the default value means
     // to do it for the current timezone of this machine (even if the function
     // accessors: many of them take the timezone parameter which indicates the
     // timezone for which to make the calculations and the default value means
     // to do it for the current timezone of this machine (even if the function


@@ -806,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; }


@@ -999,7 +1042,7 @@ public:
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)
     const wxChar *ParseFormat(const wxChar *date,
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)
     const wxChar *ParseFormat(const wxChar *date,

-                              const wxChar *format = wxDefaultDateTimeFormat,
+                              const wxString& format = wxDefaultDateTimeFormat,

                               const wxDateTime& dateDef = wxDefaultDateTime);
         // parse a string containing the date/time in "free" format, this
         // function will try to make an educated guess at the string contents
                               const wxDateTime& dateDef = wxDefaultDateTime);
         // parse a string containing the date/time in "free" format, this
         // function will try to make an educated guess at the string contents


@@ -1014,7 +1057,7 @@ public:
         // argument corresponds to the preferred date and time representation
         // for the current locale) and returns the string containing the
         // resulting text representation
         // argument corresponds to the preferred date and time representation
         // for the current locale) and returns the string containing the
         // resulting text representation

-    wxString Format(const wxChar *format = wxDefaultDateTimeFormat,
+    wxString Format(const wxString& format = wxDefaultDateTimeFormat,

                     const TimeZone& tz = Local) const;
         // preferred date representation for the current locale
     wxString FormatDate() const { return Format(_T("%x")); }
                     const TimeZone& tz = Local) const;
         // preferred date representation for the current locale
     wxString FormatDate() const { return Format(_T("%x")); }


@@ -1046,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:


@@ -1079,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


@@ -1107,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
 


@@ -1244,7 +1294,7 @@ public:
         // resulting text representation. Notice that only some of format
         // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
         // minutes and seconds make sense, but not "PM/AM" string for example.
         // resulting text representation. Notice that only some of format
         // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
         // minutes and seconds make sense, but not "PM/AM" string for example.

-    wxString Format(const wxChar *format = wxDefaultTimeSpanFormat) const;
+    wxString Format(const wxString& format = wxDefaultTimeSpanFormat) const;

 
     // implementation
     // ------------------------------------------------------------------------
 
     // implementation
     // ------------------------------------------------------------------------


@@ -1437,7 +1487,7 @@ WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDateTime, wxDateTimeArray, WXDLLIMPEXP_BASE)
 //     virtual methods to work with the holidays they correspond to.
 // ----------------------------------------------------------------------------
 
 //     virtual methods to work with the holidays they correspond to.
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority;
+class WXDLLIMPEXP_FWD_BASE wxDateTimeHolidayAuthority;

 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxDateTimeHolidayAuthority *,
                               wxHolidayAuthoritiesArray,
                               class WXDLLIMPEXP_BASE);
 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxDateTimeHolidayAuthority *,
                               wxHolidayAuthoritiesArray,
                               class WXDLLIMPEXP_BASE);


@@ -1528,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 */


@@ -1625,7 +1676,7 @@ inline time_t wxDateTime::GetTicks() const
         return (time_t)-1;
     }
 
         return (time_t)-1;
     }
 

-    return (time_t)((m_time / (long)TIME_T_FACTOR).GetLo())+WX_TIME_BASE_OFFSET ;
+    return (time_t)((m_time / (long)TIME_T_FACTOR).ToLong()) + WX_TIME_BASE_OFFSET;

 }
 
 inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday,
 }
 
 inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday,


@@ -1839,20 +1890,26 @@ inline wxDateTime& wxDateTime::operator+=(const wxDateSpan& diff)
 // wxDateTime and timezones
 // ----------------------------------------------------------------------------
 
 // wxDateTime and timezones
 // ----------------------------------------------------------------------------
 

-inline wxDateTime wxDateTime::ToTimezone(const wxDateTime::TimeZone& tz,
-                                         bool noDST) const
+inline wxDateTime
+wxDateTime::ToTimezone(const wxDateTime::TimeZone& tz, bool noDST) const

 {
     MODIFY_AND_RETURN( MakeTimezone(tz, noDST) );
 }
 
 {
     MODIFY_AND_RETURN( MakeTimezone(tz, noDST) );
 }
 

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

 // ----------------------------------------------------------------------------
 // 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;


@@ -1875,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