More efficient access to name and value

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

diff --git a/include/wx/datetime.h b/include/wx/datetime.h
index 5b26a830a07bc4cd193d1f84960ac478856ce39f..286155f29f1b179f4588a1880ddad5c5847e0862 100644 (file)
--- a/include/wx/datetime.h
+++ b/include/wx/datetime.h
@@ -128,8 +128,8 @@ WXDLLIMPEXP_BASE struct tm *wxGmtime_r(const time_t*, struct tm*);
 // wxInvalidDateTime)
 class WXDLLIMPEXP_FWD_BASE wxDateTime;
 
 // wxInvalidDateTime)
 class WXDLLIMPEXP_FWD_BASE wxDateTime;
 

-extern WXDLLIMPEXP_DATA_BASE(const char *) wxDefaultDateTimeFormat;
-extern WXDLLIMPEXP_DATA_BASE(const char *) wxDefaultTimeSpanFormat;
+extern WXDLLIMPEXP_DATA_BASE(const char) wxDefaultDateTimeFormat[];
+extern WXDLLIMPEXP_DATA_BASE(const char) wxDefaultTimeSpanFormat[];

 extern WXDLLIMPEXP_DATA_BASE(const wxDateTime) wxDefaultDateTime;
 
 #define wxInvalidDateTime wxDefaultDateTime
 extern WXDLLIMPEXP_DATA_BASE(const wxDateTime) wxDefaultDateTime;
 
 #define wxInvalidDateTime wxDefaultDateTime


@@ -139,33 +139,12 @@ extern WXDLLIMPEXP_DATA_BASE(const wxDateTime) wxDefaultDateTime;
 // conditional compilation
 // ----------------------------------------------------------------------------
 
 // conditional compilation
 // ----------------------------------------------------------------------------
 

-#if defined(HAVE_STRPTIME) && defined(__GLIBC__) && \
-        ((__GLIBC__ == 2) && (__GLIBC_MINOR__ == 0))
-    // glibc 2.0.7 strptime() is broken - the following snippet causes it to
-    // crash (instead of just failing):
-    //
-    //      strncpy(buf, "Tue Dec 21 20:25:40 1999", 128);
-    //      strptime(buf, "%x", &tm);
-    //
-    // so don't use it
-    #undef HAVE_STRPTIME
-#endif // broken strptime()
-
-#if defined(HAVE_STRPTIME) && defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
-    // configure detects strptime as linkable because it's in the OS X
-    // System library but MSL headers don't declare it.
-
-//    char *strptime(const char *, const char *, struct tm *);
-    // However, we DON'T want to just provide it here because we would
-    // crash and/or overwrite data when strptime from OS X tries
-    // to fill in MW's struct tm which is two fields shorter (no TZ stuff)
-    // So for now let's just say we don't have strptime
-    #undef HAVE_STRPTIME
-#endif
-
-// everyone has strftime except Win CE unless VC8 is used
-#if !defined(__WXWINCE__) || defined(__VISUALC8__)
-    #define HAVE_STRFTIME
+// if configure detected strftime(), we have it too
+#ifdef HAVE_STRFTIME
+    #define wxHAS_STRFTIME
+// suppose everyone else has strftime except Win CE unless VC8 is used
+#elif !defined(__WXWINCE__) || defined(__VISUALC8__)
+    #define wxHAS_STRFTIME

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -268,7 +247,7 @@ public:
         // adoption of the Gregorian calendar (see IsGregorian())
         //
         // All data and comments taken verbatim from "The Calendar FAQ (v 2.0)"
         // adoption of the Gregorian calendar (see IsGregorian())
         //
         // All data and comments taken verbatim from "The Calendar FAQ (v 2.0)"

-        // by Claus T�ndering, http://www.pip.dknet.dk/~c-t/calendar.html
+        // by Claus Tøndering, http://www.pip.dknet.dk/~c-t/calendar.html

         // except for the comments "we take".
         //
         // Symbol "->" should be read as "was followed by" in the comments
         // except for the comments "we take".
         //
         // Symbol "->" should be read as "was followed by" in the comments


@@ -483,7 +462,9 @@ public:
         //     instead of modifying the member fields directly!
     struct WXDLLIMPEXP_BASE Tm
     {
         //     instead of modifying the member fields directly!
     struct WXDLLIMPEXP_BASE Tm
     {

-        wxDateTime_t msec, sec, min, hour, mday;
+        wxDateTime_t msec, sec, min, hour,
+                     mday,  // Day of the month in 1..31 range.
+                     yday;  // Day of the year in 0..365 range.

         Month mon;
         int year;
 
         Month mon;
         int year;
 


@@ -518,9 +499,10 @@ public:
         // the timezone we correspond to
         TimeZone m_tz;
 
         // the timezone we correspond to
         TimeZone m_tz;
 

-        // these values can't be accessed directly because they're not always
-        // computed and we calculate them on demand
-        wxDateTime_t wday, yday;
+        // This value can only be accessed via GetWeekDay() and not directly
+        // because it's not always computed when creating this object and may
+        // need to be calculated on demand.
+        wxDateTime_t wday;

     };
 
     // static methods
     };
 
     // static methods


@@ -968,12 +950,15 @@ public:
     // SYSTEMTIME format
     // ------------------------------------------------------------------------
 #ifdef __WXMSW__
     // SYSTEMTIME format
     // ------------------------------------------------------------------------
 #ifdef __WXMSW__

-

     // convert SYSTEMTIME to wxDateTime
     // convert SYSTEMTIME to wxDateTime

-    wxDateTime& SetFromMSWSysTime(const struct _SYSTEMTIME&);
+    wxDateTime& SetFromMSWSysTime(const struct _SYSTEMTIME& st);

 
     // convert wxDateTime to SYSTEMTIME
 
     // convert wxDateTime to SYSTEMTIME

-    void GetAsMSWSysTime(struct _SYSTEMTIME*) const;
+    void GetAsMSWSysTime(struct _SYSTEMTIME* st) const;
+
+    // same as above but only take date part into account, time is always zero
+    wxDateTime& SetFromMSWSysDate(const struct _SYSTEMTIME& st);
+    void GetAsMSWSysDate(struct _SYSTEMTIME* st) const;

 #endif // __WXMSW__
 
     // comparison (see also functions below for operator versions)
 #endif // __WXMSW__
 
     // comparison (see also functions below for operator versions)


@@ -1006,37 +991,37 @@ public:
 
     inline bool operator<(const wxDateTime& dt) const
     {
 
     inline bool operator<(const wxDateTime& dt) const
     {

-        wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+        wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );

         return GetValue() < dt.GetValue();
     }
 
     inline bool operator<=(const wxDateTime& dt) const
     {
         return GetValue() < dt.GetValue();
     }
 
     inline bool operator<=(const wxDateTime& dt) const
     {

-        wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+        wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );

         return GetValue() <= dt.GetValue();
     }
 
     inline bool operator>(const wxDateTime& dt) const
     {
         return GetValue() <= dt.GetValue();
     }
 
     inline bool operator>(const wxDateTime& dt) const
     {

-        wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+        wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );

         return GetValue() > dt.GetValue();
     }
 
     inline bool operator>=(const wxDateTime& dt) const
     {
         return GetValue() > dt.GetValue();
     }
 
     inline bool operator>=(const wxDateTime& dt) const
     {

-        wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+        wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );

         return GetValue() >= dt.GetValue();
     }
 
     inline bool operator==(const wxDateTime& dt) const
     {
         return GetValue() >= dt.GetValue();
     }
 
     inline bool operator==(const wxDateTime& dt) const
     {

-        wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+        wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );

         return GetValue() == dt.GetValue();
     }
 
     inline bool operator!=(const wxDateTime& dt) const
     {
         return GetValue() == dt.GetValue();
     }
 
     inline bool operator!=(const wxDateTime& dt) const
     {

-        wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+        wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );

         return GetValue() != dt.GetValue();
     }
 
         return GetValue() != dt.GetValue();
     }
 


@@ -1099,36 +1084,41 @@ public:
     inline wxTimeSpan Subtract(const wxDateTime& dt) const;
     inline wxTimeSpan operator-(const wxDateTime& dt2) const;
 
     inline wxTimeSpan Subtract(const wxDateTime& dt) const;
     inline wxTimeSpan operator-(const wxDateTime& dt2) const;
 

-    // conversion to/from text: all conversions from text return an object
-    // representing the next character following the date specification (i.e.
-    // the one where the scan had to stop) or a special NULL-like object
-    // on failure -- this object is necessary to preserve compatibility with
-    // the existing code assigning the return value of these functions to
-    // either char* or wxChar* (new code should treat the return value as bool
-    // and use end parameter to retrieve the end of the scan)
+    // conversion to/from text

     // ------------------------------------------------------------------------
 
     // ------------------------------------------------------------------------
 

+    // all conversions functions return true to indicate whether parsing
+    // succeeded or failed and fill in the provided end iterator, which must
+    // not be NULL, with the location of the character where the parsing
+    // stopped (this will be end() of the passed string if everything was
+    // parsed)
+

         // parse a string in RFC 822 format (found e.g. in mail headers and
         // having the form "Wed, 10 Feb 1999 19:07:07 +0100")
         // parse a string in RFC 822 format (found e.g. in mail headers and
         // having the form "Wed, 10 Feb 1999 19:07:07 +0100")

-    wxAnyStrPtr ParseRfc822Date(const wxString& date,
-                                wxString::const_iterator *end = NULL);
+    bool ParseRfc822Date(const wxString& date,
+                         wxString::const_iterator *end);

 
         // parse a date/time in the given format (see strptime(3)), fill in
         // the missing (in the string) fields with the values of dateDef (by
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)
 
         // parse a date/time in the given format (see strptime(3)), fill in
         // the missing (in the string) fields with the values of dateDef (by
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)

-    wxAnyStrPtr ParseFormat(const wxString& date,
-                            const wxString& format = wxDefaultDateTimeFormat,
-                            const wxDateTime& dateDef = wxDefaultDateTime,
-                            wxString::const_iterator *end = NULL);
-
-    wxAnyStrPtr ParseFormat(const wxString& date,
-                            const wxString& format,
-                            wxString::const_iterator *end)
+    bool ParseFormat(const wxString& date,
+                     const wxString& format,
+                     const wxDateTime& dateDef,
+                     wxString::const_iterator *end);
+
+    bool ParseFormat(const wxString& date,
+                     const wxString& format,
+                     wxString::const_iterator *end)

     {
         return ParseFormat(date, format, wxDefaultDateTime, end);
     }
 
     {
         return ParseFormat(date, format, wxDefaultDateTime, end);
     }
 

+    bool ParseFormat(const wxString& date,
+                     wxString::const_iterator *end)
+    {
+        return ParseFormat(date, wxDefaultDateTimeFormat, wxDefaultDateTime, end);
+    }

 
         // parse a string containing date, time or both in ISO 8601 format
         //
 
         // parse a string containing date, time or both in ISO 8601 format
         //


@@ -1136,49 +1126,36 @@ public:
         // provide compatibility overloads for them
     bool ParseISODate(const wxString& date)
     {
         // provide compatibility overloads for them
     bool ParseISODate(const wxString& date)
     {

-        // FIXME-VC6: notice that writing "return ParseFormat() && ..." crashes
-        //            VC6 with internal compiler error so don't attempt to
-        //            simplify this code like this
-

         wxString::const_iterator end;
         wxString::const_iterator end;

-        if ( !ParseFormat(date, wxS("%Y-%m-%d"), &end) )
-            return false;
-
-        return end == date.end();
+        return ParseFormat(date, wxS("%Y-%m-%d"), &end) && end == date.end();

     }
 
     bool ParseISOTime(const wxString& time)
     {
         wxString::const_iterator end;
     }
 
     bool ParseISOTime(const wxString& time)
     {
         wxString::const_iterator end;

-        if ( !ParseFormat(time, wxS("%H:%M:%S"), &end) )
-            return false;
-        
-        return end == time.end();
+        return ParseFormat(time, wxS("%H:%M:%S"), &end) && end == time.end();

     }
 
     bool ParseISOCombined(const wxString& datetime, char sep = 'T')
     {
         wxString::const_iterator end;
         const wxString fmt = wxS("%Y-%m-%d") + wxString(sep) + wxS("%H:%M:%S");
     }
 
     bool ParseISOCombined(const wxString& datetime, char sep = 'T')
     {
         wxString::const_iterator end;
         const wxString fmt = wxS("%Y-%m-%d") + wxString(sep) + wxS("%H:%M:%S");

-        if ( !ParseFormat(datetime, fmt, &end) )
-           return false;
-       
-        return end == datetime.end();
+        return ParseFormat(datetime, fmt, &end) && end == datetime.end();

     }
 
         // parse a string containing the date/time in "free" format, this
         // function will try to make an educated guess at the string contents
     }
 
         // parse a string containing the date/time in "free" format, this
         // function will try to make an educated guess at the string contents

-    wxAnyStrPtr ParseDateTime(const wxString& datetime,
-                              wxString::const_iterator *end = NULL);
+    bool ParseDateTime(const wxString& datetime,
+                       wxString::const_iterator *end);

 
         // parse a string containing the date only in "free" format (less
         // flexible than ParseDateTime)
 
         // parse a string containing the date only in "free" format (less
         // flexible than ParseDateTime)

-    wxAnyStrPtr ParseDate(const wxString& date,
-                          wxString::const_iterator *end = NULL);
+    bool ParseDate(const wxString& date,
+                   wxString::const_iterator *end);

 
         // parse a string containing the time only in "free" format
 
         // parse a string containing the time only in "free" format

-    wxAnyStrPtr ParseTime(const wxString& time,
-                          wxString::const_iterator *end = NULL);
+    bool ParseTime(const wxString& time,
+                   wxString::const_iterator *end);

 
 
         // this function accepts strftime()-like format string (default
 
 
         // this function accepts strftime()-like format string (default


@@ -1203,6 +1180,52 @@ public:
     wxString FormatISOCombined(char sep = 'T') const
         { return FormatISODate() + sep + FormatISOTime(); }
 
     wxString FormatISOCombined(char sep = 'T') const
         { return FormatISODate() + sep + FormatISOTime(); }
 

+
+    // backwards compatible versions of the parsing functions: they return an
+    // object representing the next character following the date specification
+    // (i.e. the one where the scan had to stop) or a special NULL-like object
+    // on failure
+    //
+    // they're not deprecated because a lot of existing code uses them and
+    // there is no particular harm in keeping them but you should still prefer
+    // the versions above in the new code
+    wxAnyStrPtr ParseRfc822Date(const wxString& date)
+    {
+        wxString::const_iterator end;
+        return ParseRfc822Date(date, &end) ? wxAnyStrPtr(date, end)
+                                           : wxAnyStrPtr();
+    }
+
+    wxAnyStrPtr ParseFormat(const wxString& date,
+                            const wxString& format = wxDefaultDateTimeFormat,
+                            const wxDateTime& dateDef = wxDefaultDateTime)
+    {
+        wxString::const_iterator end;
+        return ParseFormat(date, format, dateDef, &end) ? wxAnyStrPtr(date, end)
+                                                        : wxAnyStrPtr();
+    }
+
+    wxAnyStrPtr ParseDateTime(const wxString& datetime)
+    {
+        wxString::const_iterator end;
+        return ParseDateTime(datetime, &end) ? wxAnyStrPtr(datetime, end)
+                                             : wxAnyStrPtr();
+    }
+
+    wxAnyStrPtr ParseDate(const wxString& date)
+    {
+        wxString::const_iterator end;
+        return ParseDate(date, &end) ? wxAnyStrPtr(date, end)
+                                     : wxAnyStrPtr();
+    }
+
+    wxAnyStrPtr ParseTime(const wxString& time)
+    {
+        wxString::const_iterator end;
+        return ParseTime(time, &end) ? wxAnyStrPtr(time, end)
+                                     : wxAnyStrPtr();
+    }
+

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


@@ -1705,7 +1728,9 @@ protected:
 
 inline bool wxDateTime::IsInStdRange() const
 {
 
 inline bool wxDateTime::IsInStdRange() const
 {

-    return m_time >= 0l && (m_time / TIME_T_FACTOR) < LONG_MAX;
+    // currently we don't know what is the real type of time_t so prefer to err
+    // on the safe side and limit it to 32 bit values which is safe everywhere
+    return m_time >= 0l && (m_time / TIME_T_FACTOR) < wxINT32_MAX;

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


@@ -1765,7 +1790,7 @@ inline wxDateTime::wxDateTime(double jdn)
 
 inline wxDateTime& wxDateTime::Set(const Tm& tm)
 {
 
 inline wxDateTime& wxDateTime::Set(const Tm& tm)
 {

-    wxASSERT_MSG( tm.IsValid(), _T("invalid broken down date/time") );
+    wxASSERT_MSG( tm.IsValid(), wxT("invalid broken down date/time") );

 
     return Set(tm.mday, (Month)tm.mon, tm.year,
                tm.hour, tm.min, tm.sec, tm.msec);
 
     return Set(tm.mday, (Month)tm.mon, tm.year,
                tm.hour, tm.min, tm.sec, tm.msec);


@@ -1796,14 +1821,14 @@ inline wxDateTime::wxDateTime(wxDateTime_t day,
 
 inline wxLongLong wxDateTime::GetValue() const
 {
 
 inline wxLongLong wxDateTime::GetValue() const
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));

 
     return m_time;
 }
 
 inline time_t wxDateTime::GetTicks() const
 {
 
     return m_time;
 }
 
 inline time_t wxDateTime::GetTicks() const
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));

     if ( !IsInStdRange() )
     {
         return (time_t)-1;
     if ( !IsInStdRange() )
     {
         return (time_t)-1;


@@ -1871,21 +1896,21 @@ inline wxDateTime wxDateTime::GetYearDay(wxDateTime_t yday) const
 
 inline bool wxDateTime::IsEqualTo(const wxDateTime& datetime) const
 {
 
 inline bool wxDateTime::IsEqualTo(const wxDateTime& datetime) const
 {

-    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));

 
     return m_time == datetime.m_time;
 }
 
 inline bool wxDateTime::IsEarlierThan(const wxDateTime& datetime) const
 {
 
     return m_time == datetime.m_time;
 }
 
 inline bool wxDateTime::IsEarlierThan(const wxDateTime& datetime) const
 {

-    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));

 
     return m_time < datetime.m_time;
 }
 
 inline bool wxDateTime::IsLaterThan(const wxDateTime& datetime) const
 {
 
     return m_time < datetime.m_time;
 }
 
 inline bool wxDateTime::IsLaterThan(const wxDateTime& datetime) const
 {

-    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));

 
     return m_time > datetime.m_time;
 }
 
     return m_time > datetime.m_time;
 }


@@ -1942,14 +1967,14 @@ inline bool wxDateTime::IsEqualUpTo(const wxDateTime& dt,
 
 inline wxDateTime wxDateTime::Add(const wxTimeSpan& diff) const
 {
 
 inline wxDateTime wxDateTime::Add(const wxTimeSpan& diff) const
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));

 
     return wxDateTime(m_time + diff.GetValue());
 }
 
 inline wxDateTime& wxDateTime::Add(const wxTimeSpan& diff)
 {
 
     return wxDateTime(m_time + diff.GetValue());
 }
 
 inline wxDateTime& wxDateTime::Add(const wxTimeSpan& diff)
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));

 
     m_time += diff.GetValue();
 
 
     m_time += diff.GetValue();
 


@@ -1963,14 +1988,14 @@ inline wxDateTime& wxDateTime::operator+=(const wxTimeSpan& diff)
 
 inline wxDateTime wxDateTime::Subtract(const wxTimeSpan& diff) const
 {
 
 inline wxDateTime wxDateTime::Subtract(const wxTimeSpan& diff) const
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));

 
     return wxDateTime(m_time - diff.GetValue());
 }
 
 inline wxDateTime& wxDateTime::Subtract(const wxTimeSpan& diff)
 {
 
     return wxDateTime(m_time - diff.GetValue());
 }
 
 inline wxDateTime& wxDateTime::Subtract(const wxTimeSpan& diff)
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));

 
     m_time -= diff.GetValue();
 
 
     m_time -= diff.GetValue();
 


@@ -1984,7 +2009,7 @@ inline wxDateTime& wxDateTime::operator-=(const wxTimeSpan& diff)
 
 inline wxTimeSpan wxDateTime::Subtract(const wxDateTime& datetime) const
 {
 
 inline wxTimeSpan wxDateTime::Subtract(const wxDateTime& datetime) const
 {

-    wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+    wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));

 
     return wxTimeSpan(GetValue() - datetime.GetValue());
 }
 
     return wxTimeSpan(GetValue() - datetime.GetValue());
 }