#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
-#ifndef __WXWINCE__
-#include <time.h>
-#else
-#include "wx/msw/wince/time.h"
-#endif
+#ifdef __WXWINCE__
+ #include "wx/msw/wince/time.h"
+#elif !defined(__WXPALMOS5__)
+ #include <time.h>
+#endif // OS
#include <limits.h> // for INT_MIN
#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;
+#ifdef __WXMSW__
+struct _SYSTEMTIME;
+#endif
#include "wx/dynarray.h"
// set this to the corresponding value in seconds 1/1/1970 has on your
// systems c-runtime
-#if defined(__WXMAC__) && !defined(__DARWIN__) && __MSL__ < 0x6000
- #define WX_TIME_BASE_OFFSET ( 2082844800L + 126144000L )
-#else
- #define WX_TIME_BASE_OFFSET 0
-#endif
+#define WX_TIME_BASE_OFFSET 0
+
/*
* TODO
*
* 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:
// 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 char *) wxDefaultDateTimeFormat;
+extern WXDLLIMPEXP_DATA_BASE(const char *) wxDefaultTimeSpanFormat;
extern WXDLLIMPEXP_DATA_BASE(const wxDateTime) wxDefaultDateTime;
#define wxInvalidDateTime wxDefaultDateTime
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
// 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
+ // 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
{
public:
TimeZone(TZ tz);
- TimeZone(wxDateTime_t offset = 0) { m_offset = offset; }
+
+ // create time zone object with the given offset
+ TimeZone(long offset = 0) { m_offset = offset; }
+
+ static TimeZone Make(long offset)
+ {
+ TimeZone tz;
+ tz.m_offset = offset;
+ return tz;
+ }
long GetOffset() const { return m_offset; }
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 :-)
// ------------------------------------------------------------------------
// 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))
wxDateTime_t minute = 0,
wxDateTime_t second = 0,
wxDateTime_t millisec = 0);
+#ifdef __WXMSW__
+ wxDateTime(const struct _SYSTEMTIME& st)
+ {
+ SetFromMSWSysTime(st);
+ }
+#endif
// default copy ctor ok
// 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
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)
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
// 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.
- //
- // 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 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?
// 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
// 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; }
// pack the date in DOS format
unsigned long GetAsDOS() const;
+ // SYSTEMTIME format
+ // ------------------------------------------------------------------------
+#ifdef __WXMSW__
+
+ // convert SYSTEMTIME to wxDateTime
+ wxDateTime& SetFromMSWSysTime(const struct _SYSTEMTIME&);
+
+ // convert wxDateTime to SYSTEMTIME
+ void GetAsMSWSysTime(struct _SYSTEMTIME*) const;
+#endif // __WXMSW__
+
// comparison (see also functions below for operator versions)
// ------------------------------------------------------------------------
// conversion to/from text: all conversions from text return the pointer to
// the next character following the date specification (i.e. the one where
- // the scan had to stop) or NULL on failure.
+ // the scan had to stop) or NULL on failure; for the versions taking
+ // wxString or wxCStrData, we don't know if the user code needs char* or
+ // wchar_t* pointer and so we return char* one for compatibility with the
+ // existing ANSI code and also return iterator in another output parameter
+ // (it will be equal to end if the entire string 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")
- const wxChar *ParseRfc822Date(const wxChar* date);
+ const char *ParseRfc822Date(const wxString& date,
+ wxString::const_iterator *end = NULL);
+ const char *ParseRfc822Date(const wxCStrData& date,
+ wxString::const_iterator *end = NULL)
+ {
+ return ParseRfc822Date(date.AsString(), end);
+ }
+
+ const wchar_t *ParseRfc822Date(const wchar_t* date)
+ {
+ return ReturnEndAsWidePtr(&wxDateTime::ParseRfc822Date, date);
+ }
+
+ const char *ParseRfc822Date(const char* date)
+ {
+ return ParseRfc822Date(wxString(date));
+ }
+
// 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)
- const wxChar *ParseFormat(const wxChar *date,
- const wxChar *format = wxDefaultDateTimeFormat,
- const wxDateTime& dateDef = wxDefaultDateTime);
+
+ // notice that we unfortunately need all those overloads because we use
+ // the type of the date string to select the return value of the
+ // function: it's wchar_t if a wide string is passed for compatibility
+ // with the code doing "const wxChar *p = dt.ParseFormat(_T("..."))",
+ // but char* in all other cases for compatibility with ANSI build which
+ // allowed code like "const char *p = dt.ParseFormat("...")"
+ //
+ // so we need wchar_t overload and now passing s.c_str() as first
+ // argument is ambiguous because it's convertible to both wxString and
+ // wchar_t* and now it's passing char* which becomes ambiguous as it is
+ // convertible to both wxString and wxCStrData hence we need char*
+ // overload too
+ //
+ // and to make our life more miserable we also pay for having the
+ // optional dateDef parameter: as it's almost never used, we want to
+ // allow people to omit it when specifying the end iterator output
+ // parameter but we still have to allow specifying dateDef too, so we
+ // need another overload for this
+ //
+ // FIXME: all this mess could be avoided by using some class similar to
+ // wxFormatString, i.e. remembering string [pointer] of any type
+ // and convertible to either char* or wchar_t* as wxCStrData and
+ // having only 1 (or 2, because of the last paragraph above)
+ // overload taking it, see #9560
+ const char *ParseFormat(const wxString& date,
+ const wxString& format = wxDefaultDateTimeFormat,
+ const wxDateTime& dateDef = wxDefaultDateTime,
+ wxString::const_iterator *end = NULL);
+
+ const char *ParseFormat(const wxString& date,
+ const wxString& format,
+ wxString::const_iterator *end)
+ {
+ return ParseFormat(date, format, wxDefaultDateTime, end);
+ }
+
+ const char *ParseFormat(const wxCStrData& date,
+ const wxString& format = wxDefaultDateTimeFormat,
+ const wxDateTime& dateDef = wxDefaultDateTime,
+ wxString::const_iterator *end = NULL)
+ {
+ return ParseFormat(date.AsString(), format, dateDef, end);
+ }
+
+ const wchar_t *ParseFormat(const wchar_t *date,
+ const wxString& format = wxDefaultDateTimeFormat,
+ const wxDateTime& dateDef = wxDefaultDateTime)
+ {
+ const wxString datestr(date);
+ wxString::const_iterator end;
+ if ( !ParseFormat(datestr, format, dateDef, &end) )
+ return NULL;
+
+ return date + (end - datestr.begin());
+ }
+
+ const char *ParseFormat(const char *date,
+ const wxString& format = "%c",
+ const wxDateTime& dateDef = wxDefaultDateTime)
+ {
+ return ParseFormat(wxString(date), format, dateDef);
+ }
+
+
+ // parse a string containing date, time or both in ISO 8601 format
+ //
+ // notice that these functions are new in wx 3.0 and so we don't
+ // provide compatibility overloads for them
+ bool ParseISODate(const wxString& date)
+ {
+ wxString::const_iterator end;
+ return ParseFormat(date, wxS("%Y-%m-%d"), &end) && end == date.end();
+ }
+
+ bool ParseISOTime(const wxString& time)
+ {
+ wxString::const_iterator 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");
+ 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
- const wxChar *ParseDateTime(const wxChar *datetime);
+ const char *ParseDateTime(const wxString& datetime,
+ wxString::const_iterator *end = NULL);
+
+ const char *ParseDateTime(const wxCStrData& datetime,
+ wxString::const_iterator *end = NULL)
+ {
+ return ParseDateTime(datetime.AsString(), end);
+ }
+
+ const wchar_t *ParseDateTime(const wchar_t *datetime)
+ {
+ return ReturnEndAsWidePtr(&wxDateTime::ParseDateTime, datetime);
+ }
+
+ const char *ParseDateTime(const char *datetime)
+ {
+ return ParseDateTime(wxString(datetime));
+ }
+
// parse a string containing the date only in "free" format (less
// flexible than ParseDateTime)
- const wxChar *ParseDate(const wxChar *date);
+ const char *ParseDate(const wxString& date,
+ wxString::const_iterator *end = NULL);
+
+ const char *ParseDate(const wxCStrData& date,
+ wxString::const_iterator *end = NULL)
+ {
+ return ParseDate(date.AsString(), end);
+ }
+
+ const wchar_t *ParseDate(const wchar_t *date)
+ {
+ return ReturnEndAsWidePtr(&wxDateTime::ParseDate, date);
+ }
+
+ const char *ParseDate(const char *date)
+ {
+ return ParseDate(wxString(date));
+ }
+
// parse a string containing the time only in "free" format
- const wxChar *ParseTime(const wxChar *time);
+ const char *ParseTime(const wxString& time,
+ wxString::const_iterator *end = NULL);
+
+ const char *ParseTime(const wxCStrData& time,
+ wxString::const_iterator *end = NULL)
+ {
+ return ParseTime(time.AsString(), end);
+ }
+
+ const wchar_t *ParseTime(const wchar_t *time)
+ {
+ return ReturnEndAsWidePtr(&wxDateTime::ParseTime, time);
+ }
+
+ const char *ParseTime(const char *time)
+ {
+ return ParseTime(wxString(time));
+ }
// this function accepts strftime()-like format string (default
// 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")); }
+ wxString FormatDate() const { return Format(wxS("%x")); }
// preferred time representation for the current locale
- wxString FormatTime() const { return Format(_T("%X")); }
+ wxString FormatTime() const { return Format(wxS("%X")); }
// returns the string representing the date in ISO 8601 format
// (YYYY-MM-DD)
- wxString FormatISODate() const { return Format(_T("%Y-%m-%d")); }
+ wxString FormatISODate() const { return Format(wxS("%Y-%m-%d")); }
// returns the string representing the time in ISO 8601 format
// (HH:MM:SS)
- wxString FormatISOTime() const { return Format(_T("%H:%M:%S")); }
+ wxString FormatISOTime() const { return Format(wxS("%H:%M:%S")); }
+ // return the combined date time representation in ISO 8601 format; the
+ // separator character should be 'T' according to the standard but it
+ // can also be useful to set it to ' '
+ wxString FormatISOCombined(char sep = 'T') const
+ { return FormatISODate() + sep + FormatISOTime(); }
// implementation
// ------------------------------------------------------------------------
// another one to get the current time broken down
static struct tm *GetTmNow()
{
- time_t t = GetTimeNow();
- return localtime(&t);
+ static struct tm l_CurrentTime;
+ return GetTmNow(&l_CurrentTime);
}
+ // get current time using thread-safe function
+ static struct tm *GetTmNow(struct tm *tmstruct);
+
private:
+ // helper function for defining backward-compatible wrappers for code
+ // using wchar_t* pointer instead of wxString iterators
+ typedef
+ const char *(wxDateTime::*StringMethod)(const wxString& s,
+ wxString::const_iterator *end);
+
+ const wchar_t *ReturnEndAsWidePtr(StringMethod func, const wchar_t *p)
+ {
+ const wxString s(p);
+ wxString::const_iterator end;
+ if ( !(this->*func)(s, &end) )
+ return NULL;
+
+ return p + (end - s.begin());
+ }
+
+
// 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:
// see SetCountry() and GetCountry()
// 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
- 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
// 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
// compare two timestamps: works with the absolute values, i.e. 1
// hour is shorter than -2 hours. Also, it will return false if the
// timespans are equal in absolute value.
- bool IsShorterThan(const wxTimeSpan& t) const { return !IsLongerThan(t); }
+ bool IsShorterThan(const wxTimeSpan& t) const;
inline bool operator<(const wxTimeSpan &ts) const
{
// 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
// ------------------------------------------------------------------------
// 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);
/* static */
inline wxDateTime wxDateTime::Now()
{
- return wxDateTime(*GetTmNow());
+ struct tm tmstruct;
+ return wxDateTime(*GetTmNow(&tmstruct));
}
/* static */
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,
// 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) );
}
+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,
- long seconds,
- long milliseconds)
+ wxLongLong seconds,
+ wxLongLong milliseconds)
{
// assign first to avoid precision loss
m_diff = hours;
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
return GetValue().Abs() > ts.GetValue().Abs();
}
+inline bool wxTimeSpan::IsShorterThan(const wxTimeSpan& ts) const
+{
+ return GetValue().Abs() < ts.GetValue().Abs();
+}
+
// ----------------------------------------------------------------------------
// wxDateSpan
// ----------------------------------------------------------------------------
projects / wxWidgets.git / blobdiff