// Author: Vadim Zeitlin
// Modified by:
// Created: 10.02.99
-// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_DATETIME_H
#define _WX_DATETIME_H
-#ifdef __GNUG__
- #pragma interface "datetime.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_DATETIME
+
+#ifdef __WXWINCE__
+ #include "wx/msw/wince/time.h"
+#else
+ #include <time.h>
+#endif // OS
-#include <time.h>
#include <limits.h> // for INT_MIN
#include "wx/longlong.h"
+#include "wx/anystr.h"
-class WXDLLEXPORT wxDateTime;
-class WXDLLEXPORT wxTimeSpan;
-class WXDLLEXPORT wxDateSpan;
+class WXDLLIMPEXP_FWD_BASE wxDateTime;
+class WXDLLIMPEXP_FWD_BASE wxTimeSpan;
+class WXDLLIMPEXP_FWD_BASE wxDateSpan;
+#ifdef __WINDOWS__
+struct _SYSTEMTIME;
+#endif
-// don't use inline functions in debug builds - we don't care about
-// performances and this only leads to increased rebuild time (because every
-// time an inline method is changed, all files including the header must be
-// rebuilt)
-// For Mingw32, causes a link error.
-#if defined( __WXDEBUG__) && !defined(__MINGW32__)
- #undef inline
- #define inline
-#endif // Debug
+#include "wx/dynarray.h"
// not all c-runtimes are based on 1/1/1970 being (time_t) 0
// set this to the corresponding value in seconds 1/1/1970 has on your
// systems c-runtime
-#ifdef __WXMAC__
-#if __MSL__ < 0x6000
- #define WX_TIME_BASE_OFFSET ( 2082844800L + 126144000L )
-#else
- #define WX_TIME_BASE_OFFSET 0
-#endif
-#else
- #define WX_TIME_BASE_OFFSET 0
-#endif
+#define WX_TIME_BASE_OFFSET 0
+
/*
* TODO
*
// 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 WXDLLEXPORT wxDateTime;
+class WXDLLIMPEXP_FWD_BASE wxDateTime;
+
+extern WXDLLIMPEXP_DATA_BASE(const char) wxDefaultDateTimeFormat[];
+extern WXDLLIMPEXP_DATA_BASE(const char) wxDefaultTimeSpanFormat[];
+extern WXDLLIMPEXP_DATA_BASE(const wxDateTime) wxDefaultDateTime;
-WXDLLEXPORT_DATA(extern const wxDateTime&) wxDefaultDateTime;
#define wxInvalidDateTime wxDefaultDateTime
+
+// ----------------------------------------------------------------------------
+// conditional compilation
+// ----------------------------------------------------------------------------
+
+// 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
+
// ----------------------------------------------------------------------------
// wxDateTime represents an absolute moment in the time
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxDateTime
+class WXDLLIMPEXP_BASE wxDateTime
{
public:
// types
// the time in the current time zone
Local,
- // zones from GMT (= Greenwhich Mean Time): they're guaranteed to be
+ // zones from GMT (= Greenwich Mean Time): they're guaranteed to be
// consequent numbers, so writing something like `GMT0 + offset' is
// safe if abs(offset) <= 12
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
// TODO Hebrew, Chinese, Maya, ... (just kidding) (or then may be not?)
};
- // these values only are used to identify the different dates of
- // 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
- // except for the comments "we take".
- //
- // Symbol "->" should be read as "was followed by" in the comments
- // which follow.
- enum GregorianAdoption
- {
- Gr_Unknown, // no data for this country or it's too uncertain to use
- Gr_Standard, // on the day 0 of Gregorian calendar: 15 Oct 1582
-
- Gr_Alaska, // Oct 1867 when Alaska became part of the USA
- Gr_Albania, // Dec 1912
-
- Gr_Austria = Gr_Unknown, // Different regions on different dates
- Gr_Austria_Brixen, // 5 Oct 1583 -> 16 Oct 1583
- Gr_Austria_Salzburg = Gr_Austria_Brixen,
- Gr_Austria_Tyrol = Gr_Austria_Brixen,
- Gr_Austria_Carinthia, // 14 Dec 1583 -> 25 Dec 1583
- Gr_Austria_Styria = Gr_Austria_Carinthia,
-
- Gr_Belgium, // Then part of the Netherlands
-
- Gr_Bulgaria = Gr_Unknown, // Unknown precisely (from 1915 to 1920)
- Gr_Bulgaria_1, // 18 Mar 1916 -> 1 Apr 1916
- Gr_Bulgaria_2, // 31 Mar 1916 -> 14 Apr 1916
- Gr_Bulgaria_3, // 3 Sep 1920 -> 17 Sep 1920
-
- Gr_Canada = Gr_Unknown, // Different regions followed the changes in
- // Great Britain or France
-
- Gr_China = Gr_Unknown, // Different authorities say:
- Gr_China_1, // 18 Dec 1911 -> 1 Jan 1912
- Gr_China_2, // 18 Dec 1928 -> 1 Jan 1929
-
- Gr_Czechoslovakia, // (Bohemia and Moravia) 6 Jan 1584 -> 17 Jan 1584
- Gr_Denmark, // (including Norway) 18 Feb 1700 -> 1 Mar 1700
- Gr_Egypt, // 1875
- Gr_Estonia, // 1918
- Gr_Finland, // Then part of Sweden
-
- Gr_France, // 9 Dec 1582 -> 20 Dec 1582
- Gr_France_Alsace, // 4 Feb 1682 -> 16 Feb 1682
- Gr_France_Lorraine, // 16 Feb 1760 -> 28 Feb 1760
- Gr_France_Strasbourg, // February 1682
-
- Gr_Germany = Gr_Unknown, // Different states on different dates:
- Gr_Germany_Catholic, // 1583-1585 (we take 1584)
- Gr_Germany_Prussia, // 22 Aug 1610 -> 2 Sep 1610
- Gr_Germany_Protestant, // 18 Feb 1700 -> 1 Mar 1700
-
- Gr_GreatBritain, // 2 Sep 1752 -> 14 Sep 1752 (use 'cal(1)')
-
- Gr_Greece, // 9 Mar 1924 -> 23 Mar 1924
- Gr_Hungary, // 21 Oct 1587 -> 1 Nov 1587
- Gr_Ireland = Gr_GreatBritain,
- Gr_Italy = Gr_Standard,
-
- Gr_Japan = Gr_Unknown, // Different authorities say:
- Gr_Japan_1, // 19 Dec 1872 -> 1 Jan 1873
- Gr_Japan_2, // 19 Dec 1892 -> 1 Jan 1893
- Gr_Japan_3, // 18 Dec 1918 -> 1 Jan 1919
-
- Gr_Latvia, // 1915-1918 (we take 1915)
- Gr_Lithuania, // 1915
- Gr_Luxemburg, // 14 Dec 1582 -> 25 Dec 1582
- Gr_Netherlands = Gr_Belgium, // (including Belgium) 1 Jan 1583
-
- // this is too weird to take into account: the Gregorian calendar was
- // introduced twice in Groningen, first time 28 Feb 1583 was followed
- // by 11 Mar 1583, then it has gone back to Julian in the summer of
- // 1584 and then 13 Dec 1700 -> 12 Jan 1701 - which is
- // the date we take here
- Gr_Netherlands_Groningen, // 13 Dec 1700 -> 12 Jan 1701
- Gr_Netherlands_Gelderland, // 30 Jun 1700 -> 12 Jul 1700
- Gr_Netherlands_Utrecht, // (and Overijssel) 30 Nov 1700->12 Dec 1700
- Gr_Netherlands_Friesland, // (and Drenthe) 31 Dec 1700 -> 12 Jan 1701
-
- Gr_Norway = Gr_Denmark, // Then part of Denmark
- Gr_Poland = Gr_Standard,
- Gr_Portugal = Gr_Standard,
- Gr_Romania, // 31 Mar 1919 -> 14 Apr 1919
- Gr_Russia, // 31 Jan 1918 -> 14 Feb 1918
- Gr_Scotland = Gr_GreatBritain,
- Gr_Spain = Gr_Standard,
-
- // Sweden has a curious history. Sweden decided to make a gradual
- // change from the Julian to the Gregorian calendar. By dropping every
- // leap year from 1700 through 1740 the eleven superfluous days would
- // be omitted and from 1 Mar 1740 they would be in sync with the
- // Gregorian calendar. (But in the meantime they would be in sync with
- // nobody!)
- //
- // So 1700 (which should have been a leap year in the Julian calendar)
- // was not a leap year in Sweden. However, by mistake 1704 and 1708
- // became leap years. This left Sweden out of synchronisation with
- // both the Julian and the Gregorian world, so they decided to go back
- // to the Julian calendar. In order to do this, they inserted an extra
- // day in 1712, making that year a double leap year! So in 1712,
- // February had 30 days in Sweden.
- //
- // Later, in 1753, Sweden changed to the Gregorian calendar by
- // dropping 11 days like everyone else.
- Gr_Sweden = Gr_Finland, // 17 Feb 1753 -> 1 Mar 1753
-
- Gr_Switzerland = Gr_Unknown,// Different cantons used different dates
- Gr_Switzerland_Catholic, // 1583, 1584 or 1597 (we take 1584)
- Gr_Switzerland_Protestant, // 31 Dec 1700 -> 12 Jan 1701
-
- Gr_Turkey, // 1 Jan 1927
- Gr_USA = Gr_GreatBritain,
- Gr_Wales = Gr_GreatBritain,
- Gr_Yugoslavia // 1919
- };
-
// the country parameter is used so far for calculating the start and
// the end of DST period and for deciding whether the date is a work
// day or not
//
// TODO move this to intl.h
+
+// Required for WinCE
+#ifdef USA
+#undef USA
+#endif
+
enum Country
{
Country_Unknown, // no special information for this country
Country_WesternEurope_End = UK,
Russia,
-
USA
};
-
// symbolic names for the months
enum Month
{
// helper classes
// ------------------------------------------------------------------------
- // a class representing a time zone: basicly, this is just an offset
+ // a class representing a time zone: basically, this is just an offset
// (in seconds) from GMT
- class WXDLLEXPORT TimeZone
+ class WXDLLIMPEXP_BASE TimeZone
{
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; }
// NB: this struct should always be kept normalized (i.e. mon should
// be < 12, 1 <= day <= 31 &c), so use AddMonths(), AddDays()
// instead of modifying the member fields directly!
- struct WXDLLEXPORT Tm
+ 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;
// 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
// get the current country
static Country GetCountry();
- // return TRUE if the country is a West European one (in practice,
+ // return true if the country is a West European one (in practice,
// this means that the same DST rules as for EEC apply)
static bool IsWestEuropeanCountry(Country country = Country_Default);
// return the current month
static Month GetCurrentMonth(Calendar cal = Gregorian);
- // returns TRUE if the given year is a leap year in the given calendar
+ // returns true if the given year is a leap year in the given calendar
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 :-)
int year = Inv_Year,
Calendar cal = Gregorian);
+
// get the full (default) or abbreviated month name in the current
// locale, returns empty string on error
static wxString GetMonthName(Month month,
NameFlags flags = Name_Full);
+ // get the standard English full (default) or abbreviated month name
+ static wxString GetEnglishMonthName(Month month,
+ NameFlags flags = Name_Full);
+
// get the full (default) or abbreviated weekday name in the current
// locale, returns empty string on error
static wxString GetWeekDayName(WeekDay weekday,
NameFlags flags = Name_Full);
+ // get the standard English full (default) or abbreviated weekday name
+ static wxString GetEnglishWeekDayName(WeekDay weekday,
+ NameFlags flags = Name_Full);
+
// get the AM and PM strings in the current locale (may be empty)
static void GetAmPmStrings(wxString *am, wxString *pm);
- // return TRUE if the given country uses DST for this year
+ // return true if the given country uses DST for this year
static bool IsDSTApplicable(int year = Inv_Year,
Country country = Country_Default);
// ------------------------------------------------------------------------
// default ctor does not initialize the object, use Set()!
- wxDateTime() { }
+ 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 millisec = 0);
// from separate values for each component with explicit date
inline wxDateTime(wxDateTime_t day, // day of the month
- Month month = Inv_Month,
+ Month month,
int year = Inv_Year, // 1999, not 99 please!
wxDateTime_t hour = 0,
wxDateTime_t minute = 0,
wxDateTime_t second = 0,
wxDateTime_t millisec = 0);
+#ifdef __WINDOWS__
+ wxDateTime(const struct _SYSTEMTIME& st)
+ {
+ SetFromMSWSysTime(st);
+ }
+#endif
// default copy ctor ok
// from separate values for each component with explicit date
// (defaults for month and year are the current values)
wxDateTime& Set(wxDateTime_t day,
- Month month = Inv_Month,
+ Month month,
int year = Inv_Year, // 1999, not 99 please!
wxDateTime_t hour = 0,
wxDateTime_t minute = 0,
// 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
// default assignment operator is ok
// calendar calculations (functions which set the date only leave the time
- // unchanged, e.g. don't explictly zero it): SetXXX() functions modify the
+ // unchanged, e.g. don't explicitly zero it): SetXXX() functions modify the
// object itself, GetXXX() ones return a new object.
// ------------------------------------------------------------------------
// set to the given week day in the same week as this one
- wxDateTime& SetToWeekDayInSameWeek(WeekDay weekday);
- inline wxDateTime GetWeekDayInSameWeek(WeekDay weekday) const;
+ wxDateTime& SetToWeekDayInSameWeek(WeekDay weekday,
+ WeekFlags flags = Monday_First);
+ inline wxDateTime GetWeekDayInSameWeek(WeekDay weekday,
+ WeekFlags flags = Monday_First) const;
// set to the next week day following this one
wxDateTime& SetToNextWeekDay(WeekDay weekday);
wxDateTime& SetToPrevWeekDay(WeekDay weekday);
inline wxDateTime GetPrevWeekDay(WeekDay weekday) const;
- // set to Nth occurence of given weekday in the given month of the
- // given year (time is set to 0), return TRUE on success and FALSE on
+ // set to Nth occurrence of given weekday in the given month of the
+ // given year (time is set to 0), return true on success and false on
// failure. n may be positive (1..5) or negative to count from the end
// of the month (see helper function SetToLastWeekDay())
bool SetToWeekDay(WeekDay weekday,
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.
+ // returns true on success and false if given date doesn't exist (e.g.
// numWeek is > 53)
- bool SetToTheWeek(wxDateTime_t numWeek, WeekDay weekday = Mon);
- inline wxDateTime GetWeek(wxDateTime_t numWeek, WeekDay weekday = Mon) const;
+ //
+ // these functions are badly defined as they're not the reverse of
+ // GetWeekOfYear(), use SetToTheWeekOfYear() instead
+ wxDEPRECATED( bool SetToTheWeek(wxDateTime_t numWeek,
+ WeekDay weekday = Mon,
+ WeekFlags flags = Monday_First) );
+ 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
+ static wxDateTime SetToWeekOfYear(int year,
+ wxDateTime_t numWeek,
+ WeekDay weekday = Mon);
// sets the date to the last day of the given (or current) month or the
// given (or current) 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);
+ inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
+ wxDateTime& MakeTimezone(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);
- // transform to GMT/UTC
- wxDateTime ToGMT(bool noDST = FALSE) const { return ToTimezone(GMT0, noDST); }
- wxDateTime& MakeGMT(bool noDST = FALSE) { return MakeTimezone(GMT0, noDST); }
+ // 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
// result of timezone shift)
// ------------------------------------------------------------------------
- // is the date valid? Note that this will return TRUE for non
- // initialized objects but FALSE if *this == wxInvalidDateTime
+ // is the date valid?
inline bool IsValid() const { return m_time != wxInvalidDateTime.m_time; }
// get the broken down date/time representation in the given timezone
// 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; }
// because the holidays are different in different countries
bool IsWorkDay(Country country = Country_Default) const;
- // is this date later than Gregorian calendar introduction for the
- // given country (see enum GregorianAdoption)?
- //
- // NB: this function shouldn't be considered as absolute authority in
- // the matter. Besides, for some countries the exact date of
- // adoption of the Gregorian calendar is simply unknown.
- bool IsGregorianDate(GregorianAdoption country = Gr_Standard) const;
+ // dos date and time format
+ // ------------------------------------------------------------------------
+
+ // set from the DOS packed format
+ wxDateTime& SetFromDOS(unsigned long ddt);
+
+ // pack the date in DOS format
+ unsigned long GetAsDOS() const;
+
+ // SYSTEMTIME format
+ // ------------------------------------------------------------------------
+#ifdef __WINDOWS__
+ // convert SYSTEMTIME to wxDateTime
+ wxDateTime& SetFromMSWSysTime(const struct _SYSTEMTIME& st);
+
+ // convert wxDateTime to SYSTEMTIME
+ 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 // __WINDOWS__
// comparison (see also functions below for operator versions)
// ------------------------------------------------------------------------
- // returns TRUE if the two moments are strictly identical
+ // returns true if the two moments are strictly identical
inline bool IsEqualTo(const wxDateTime& datetime) const;
- // returns TRUE if the date is strictly earlier than the given one
+ // returns true if the date is strictly earlier than the given one
inline bool IsEarlierThan(const wxDateTime& datetime) const;
- // returns TRUE if the date is strictly later than the given one
+ // returns true if the date is strictly later than the given one
inline bool IsLaterThan(const wxDateTime& datetime) const;
- // returns TRUE if the date is strictly in the given range
+ // returns true if the date is strictly in the given range
inline bool IsStrictlyBetween(const wxDateTime& t1,
const wxDateTime& t2) const;
- // returns TRUE if the date is in the given range
+ // returns true if the date is in the given range
inline bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
// do these two objects refer to the same date?
// are these two objects equal up to given timespan?
inline bool IsEqualUpTo(const wxDateTime& dt, const wxTimeSpan& ts) const;
+ inline bool operator<(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );
+ return GetValue() < dt.GetValue();
+ }
+
+ inline bool operator<=(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );
+ return GetValue() <= dt.GetValue();
+ }
+
+ inline bool operator>(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );
+ return GetValue() > dt.GetValue();
+ }
+
+ inline bool operator>=(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );
+ return GetValue() >= dt.GetValue();
+ }
+
+ inline bool operator==(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );
+ return GetValue() == dt.GetValue();
+ }
+
+ inline bool operator!=(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), wxT("invalid wxDateTime") );
+ return GetValue() != dt.GetValue();
+ }
+
// arithmetics with dates (see also below for more operators)
// ------------------------------------------------------------------------
inline wxDateTime& Add(const wxTimeSpan& diff);
// add a time span (positive or negative)
inline wxDateTime& operator+=(const wxTimeSpan& diff);
+ inline wxDateTime operator+(const wxTimeSpan& ts) const
+ {
+ wxDateTime dt(*this);
+ dt.Add(ts);
+ return dt;
+ }
// return the difference of the date with a time span
inline wxDateTime Subtract(const wxTimeSpan& diff) const;
inline wxDateTime& Subtract(const wxTimeSpan& diff);
// subtract a time span (positive or negative)
inline wxDateTime& operator-=(const wxTimeSpan& diff);
+ inline wxDateTime operator-(const wxTimeSpan& ts) const
+ {
+ wxDateTime dt(*this);
+ dt.Subtract(ts);
+ return dt;
+ }
// return the sum of the date with a date span
inline wxDateTime Add(const wxDateSpan& diff) const;
wxDateTime& Add(const wxDateSpan& diff);
// add a date span (positive or negative)
inline wxDateTime& operator+=(const wxDateSpan& diff);
+ inline wxDateTime operator+(const wxDateSpan& ds) const
+ {
+ wxDateTime dt(*this);
+ dt.Add(ds);
+ return dt;
+ }
// return the difference of the date with a date span
inline wxDateTime Subtract(const wxDateSpan& diff) const;
inline wxDateTime& Subtract(const wxDateSpan& diff);
// subtract a date span (positive or negative)
inline wxDateTime& operator-=(const wxDateSpan& diff);
+ inline wxDateTime operator-(const wxDateSpan& ds) const
+ {
+ wxDateTime dt(*this);
+ dt.Subtract(ds);
+ return dt;
+ }
// return the difference between two dates
inline wxTimeSpan Subtract(const wxDateTime& dt) const;
+ inline wxTimeSpan operator-(const wxDateTime& dt2) const;
+
+ wxDateSpan DiffAsDateSpan(const wxDateTime& dt) const;
- // 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.
+ // 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")
- const wxChar *ParseRfc822Date(const wxChar* date);
+ 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)
- const wxChar *ParseFormat(const wxChar *date,
- const wxChar *format = _T("%c"),
- const wxDateTime& dateDef = wxDefaultDateTime);
+ 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);
+ }
+
+ 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
+ //
+ // 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);
+ bool ParseDateTime(const wxString& datetime,
+ wxString::const_iterator *end);
+
// parse a string containing the date only in "free" format (less
// flexible than ParseDateTime)
- const wxChar *ParseDate(const wxChar *date);
+ bool ParseDate(const wxString& date,
+ wxString::const_iterator *end);
+
// parse a string containing the time only in "free" format
- const wxChar *ParseTime(const wxChar *time);
+ bool ParseTime(const wxString& time,
+ wxString::const_iterator *end);
+
// 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 = _T("%c"),
+ 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(); }
+
+
+ // 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();
+ }
+
+ // In addition to wxAnyStrPtr versions above we also must provide the
+ // overloads for C strings as we must return a pointer into the original
+ // string and not inside a temporary wxString which would have been created
+ // if the overloads above were used.
+ //
+ // And then we also have to provide the overloads for wxCStrData, as usual.
+ // Unfortunately those ones can't return anything as we don't have any
+ // sufficiently long-lived wxAnyStrPtr to return from them: any temporary
+ // strings it would point to would be destroyed when this function returns
+ // making it impossible to dereference the return value. So we just don't
+ // return anything from here which at least allows to keep compatibility
+ // with the code not testing the return value. Other uses of this method
+ // need to be converted to use one of the new bool-returning overloads
+ // above.
+ void ParseRfc822Date(const wxCStrData& date)
+ { ParseRfc822Date(wxString(date)); }
+ const char* ParseRfc822Date(const char* date);
+ const wchar_t* ParseRfc822Date(const wchar_t* date);
+
+ void ParseFormat(const wxCStrData& date,
+ const wxString& format = wxDefaultDateTimeFormat,
+ const wxDateTime& dateDef = wxDefaultDateTime)
+ { ParseFormat(wxString(date), format, dateDef); }
+ const char* ParseFormat(const char* date,
+ const wxString& format = wxDefaultDateTimeFormat,
+ const wxDateTime& dateDef = wxDefaultDateTime);
+ const wchar_t* ParseFormat(const wchar_t* date,
+ const wxString& format = wxDefaultDateTimeFormat,
+ const wxDateTime& dateDef = wxDefaultDateTime);
+
+ void ParseDateTime(const wxCStrData& datetime)
+ { ParseDateTime(wxString(datetime)); }
+ const char* ParseDateTime(const char* datetime);
+ const wchar_t* ParseDateTime(const wchar_t* datetime);
+
+ void ParseDate(const wxCStrData& date)
+ { ParseDate(wxString(date)); }
+ const char* ParseDate(const char* date);
+ const wchar_t* ParseDate(const wchar_t* date);
+
+ void ParseTime(const wxCStrData& time)
+ { ParseTime(wxString(time)); }
+ const char* ParseTime(const char* time);
+ const wchar_t* ParseTime(const wchar_t* time);
+
// implementation
// ------------------------------------------------------------------------
inline wxLongLong GetValue() const;
// a helper function to get the current time_t
- static time_t GetTimeNow() { return time((time_t *)NULL); }
+ static time_t GetTimeNow() { return time(NULL); }
// 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:
// 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:
// fixed to 1000
static const long TIME_T_FACTOR;
- // returns TRUE if we fall in range in which we can use standard ANSI C
+ // returns true if we fall in range in which we can use standard ANSI C
// functions
inline bool IsInStdRange() const;
// objects of that class. See also wxDateSpan.
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxTimeSpan
+class WXDLLIMPEXP_BASE wxTimeSpan
{
public:
// 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
inline wxTimeSpan& Add(const wxTimeSpan& diff);
// add two timespans together
wxTimeSpan& operator+=(const wxTimeSpan& diff) { return Add(diff); }
+ inline wxTimeSpan operator+(const wxTimeSpan& ts) const
+ {
+ return wxTimeSpan(GetValue() + ts.GetValue());
+ }
// return the difference of two timespans
inline wxTimeSpan Subtract(const wxTimeSpan& diff) const;
inline wxTimeSpan& Subtract(const wxTimeSpan& diff);
// subtract another timespan
wxTimeSpan& operator-=(const wxTimeSpan& diff) { return Subtract(diff); }
+ inline wxTimeSpan operator-(const wxTimeSpan& ts)
+ {
+ return wxTimeSpan(GetValue() - ts.GetValue());
+ }
// multiply timespan by a scalar
inline wxTimeSpan Multiply(int n) const;
inline wxTimeSpan& Multiply(int n);
// multiply timespan by a scalar
wxTimeSpan& operator*=(int n) { return Multiply(n); }
+ inline wxTimeSpan operator*(int n) const
+ {
+ return wxTimeSpan(*this).Multiply(n);
+ }
- // return this timespan with inversed sign
+ // return this timespan with opposite sign
wxTimeSpan Negate() const { return wxTimeSpan(-GetValue()); }
// negate the value of the timespan
wxTimeSpan& Neg() { m_diff = -GetValue(); return *this; }
// are two timespans equal?
inline bool IsEqualTo(const wxTimeSpan& ts) const;
// compare two timestamps: works with the absolute values, i.e. -2
- // hours is longer than 1 hour. Also, it will return FALSE if the
+ // hours is longer than 1 hour. Also, it will return false if the
// timespans are equal in absolute value.
inline bool IsLongerThan(const wxTimeSpan& ts) const;
// compare two timestamps: works with the absolute values, i.e. 1
- // hour is shorter than -2 hours. Also, it will return FALSE if the
+ // 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
+ {
+ return GetValue() < ts.GetValue();
+ }
+
+ inline bool operator<=(const wxTimeSpan &ts) const
+ {
+ return GetValue() <= ts.GetValue();
+ }
+
+ inline bool operator>(const wxTimeSpan &ts) const
+ {
+ return GetValue() > ts.GetValue();
+ }
+
+ inline bool operator>=(const wxTimeSpan &ts) const
+ {
+ return GetValue() >= ts.GetValue();
+ }
+
+ inline bool operator==(const wxTimeSpan &ts) const
+ {
+ return GetValue() == ts.GetValue();
+ }
+
+ inline bool operator!=(const wxTimeSpan &ts) const
+ {
+ return GetValue() != ts.GetValue();
+ }
// breaking into days, hours, minutes and seconds
// ------------------------------------------------------------------------
// 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 = _T("%H:%M:%S")) const;
+ wxString Format(const wxString& format = wxDefaultTimeSpanFormat) const;
// implementation
// ------------------------------------------------------------------------
// Beware about weeks: if you specify both weeks and days, the total number of
// days added will be 7*weeks + days! See also GetTotalDays() function.
//
+// Equality operators are defined for wxDateSpans. Two datespans are equal if
+// they both give the same target date when added to *every* source date.
+// Thus wxDateSpan::Months(1) is not equal to wxDateSpan::Days(30), because
+// they not give the same date when added to 1 Feb. But wxDateSpan::Days(14) is
+// equal to wxDateSpan::Weeks(2)
+//
// Finally, notice that for adding hours, minutes &c you don't need this
// class: wxTimeSpan will do the job because there are no subtleties
// associated with those.
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxDateSpan
+class WXDLLIMPEXP_BASE wxDateSpan
{
public:
// constructors
int GetYears() const { return m_years; }
// get number of months
int GetMonths() const { return m_months; }
+ // returns 12*GetYears() + GetMonths()
+ int GetTotalMonths() const { return 12*m_years + m_months; }
// get number of weeks
int GetWeeks() const { return m_weeks; }
// get number of days
inline wxDateSpan& Add(const wxDateSpan& other);
// add another wxDateSpan to us
inline wxDateSpan& operator+=(const wxDateSpan& other);
+ inline wxDateSpan operator+(const wxDateSpan& ds) const
+ {
+ return wxDateSpan(GetYears() + ds.GetYears(),
+ GetMonths() + ds.GetMonths(),
+ GetWeeks() + ds.GetWeeks(),
+ GetDays() + ds.GetDays());
+ }
// return difference of two date spans
inline wxDateSpan Subtract(const wxDateSpan& other) const;
inline wxDateSpan& Subtract(const wxDateSpan& other);
// subtract another wxDateSpan from us
inline wxDateSpan& operator-=(const wxDateSpan& other);
+ inline wxDateSpan operator-(const wxDateSpan& ds) const
+ {
+ return wxDateSpan(GetYears() - ds.GetYears(),
+ GetMonths() - ds.GetMonths(),
+ GetWeeks() - ds.GetWeeks(),
+ GetDays() - ds.GetDays());
+ }
// return a copy of this time span with changed sign
inline wxDateSpan Negate() const;
inline wxDateSpan& Multiply(int factor);
// multiply all components by a (signed) number
inline wxDateSpan& operator*=(int factor) { return Multiply(factor); }
+ inline wxDateSpan operator*(int n) const
+ {
+ return wxDateSpan(*this).Multiply(n);
+ }
+
+ // ds1 == d2 if and only if for every wxDateTime t t + ds1 == t + ds2
+ inline bool operator==(const wxDateSpan& ds) const
+ {
+ return GetYears() == ds.GetYears() &&
+ GetMonths() == ds.GetMonths() &&
+ GetTotalDays() == ds.GetTotalDays();
+ }
+
+ inline bool operator!=(const wxDateSpan& ds) const
+ {
+ return !(*this == ds);
+ }
private:
int m_years,
// wxDateTimeArray: array of dates.
// ----------------------------------------------------------------------------
-#include "wx/dynarray.h"
-
-WX_DECLARE_EXPORTED_OBJARRAY(wxDateTime, wxDateTimeArray);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDateTime, wxDateTimeArray, WXDLLIMPEXP_BASE);
// ----------------------------------------------------------------------------
// wxDateTimeHolidayAuthority: an object of this class will decide whether a
// virtual methods to work with the holidays they correspond to.
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxDateTimeHolidayAuthority;
-WX_DEFINE_EXPORTED_ARRAY(wxDateTimeHolidayAuthority *, wxHolidayAuthoritiesArray);
+class WXDLLIMPEXP_FWD_BASE wxDateTimeHolidayAuthority;
+WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxDateTimeHolidayAuthority *,
+ wxHolidayAuthoritiesArray,
+ class WXDLLIMPEXP_BASE);
class wxDateTimeHolidaysModule;
-class WXDLLEXPORT wxDateTimeHolidayAuthority
+class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority
{
friend class wxDateTimeHolidaysModule;
public:
- // returns TRUE if the given date is a holiday
+ // returns true if the given date is a holiday
static bool IsHoliday(const wxDateTime& dt);
// fills the provided array with all holidays in the given range, returns
// wxDateTimeHolidayAuthority)
static void AddAuthority(wxDateTimeHolidayAuthority *auth);
+ // the base class must have a virtual dtor
+ virtual ~wxDateTimeHolidayAuthority();
+
protected:
// this function is called to determine whether a given day is a holiday
virtual bool DoIsHoliday(const wxDateTime& dt) const = 0;
};
// the holidays for this class are all Saturdays and Sundays
-class WXDLLEXPORT wxDateTimeWorkDays : public wxDateTimeHolidayAuthority
+class WXDLLIMPEXP_BASE wxDateTimeWorkDays : public wxDateTimeHolidayAuthority
{
protected:
virtual bool DoIsHoliday(const wxDateTime& dt) const;
// inline functions implementation
// ============================================================================
-// don't include inline functions definitions when we're included from anything
-// else than datetime.cpp in debug builds: this minimizes rebuilds if we change
-// some inline function and the performance doesn't matter in the debug builds.
+// ----------------------------------------------------------------------------
+// private macros
+// ----------------------------------------------------------------------------
+
+#define MILLISECONDS_PER_DAY 86400000l
-#if !defined(__WXDEBUG__) || defined(wxDEFINE_TIME_CONSTANTS)
- #define INCLUDED_FROM_WX_DATETIME_H
- #include "wx/datetime.inl"
- #undef INCLUDED_FROM_WX_DATETIME_H
+// 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
-// if we defined it to be empty above, restore it now
-#undef inline
+// ----------------------------------------------------------------------------
+// wxDateTime construction
+// ----------------------------------------------------------------------------
-// ============================================================================
-// binary operators
-// ============================================================================
+inline bool wxDateTime::IsInStdRange() const
+{
+ // 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 */
+inline wxDateTime wxDateTime::Now()
+{
+ struct tm tmstruct;
+ return wxDateTime(*GetTmNow(&tmstruct));
+}
+
+/* static */
+inline wxDateTime wxDateTime::Today()
+{
+ wxDateTime dt(Now());
+ dt.ResetTime();
+
+ return dt;
+}
+
+#if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
+inline wxDateTime& wxDateTime::Set(time_t timet)
+{
+ if ( timet == (time_t)-1 )
+ {
+ m_time = wxInvalidDateTime.m_time;
+ }
+ else
+ {
+ // assign first to avoid long multiplication overflow!
+ m_time = timet - WX_TIME_BASE_OFFSET;
+ m_time *= TIME_T_FACTOR;
+ }
+
+ return *this;
+}
+#endif
+
+inline wxDateTime& wxDateTime::SetToCurrent()
+{
+ *this = Now();
+ return *this;
+}
+
+#if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
+inline wxDateTime::wxDateTime(time_t timet)
+{
+ Set(timet);
+}
+#endif
+
+inline wxDateTime::wxDateTime(const struct tm& tm)
+{
+ Set(tm);
+}
+
+inline wxDateTime::wxDateTime(const Tm& tm)
+{
+ Set(tm);
+}
+
+inline wxDateTime::wxDateTime(double jdn)
+{
+ Set(jdn);
+}
+
+inline wxDateTime& wxDateTime::Set(const Tm& tm)
+{
+ 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);
+}
+
+inline wxDateTime::wxDateTime(wxDateTime_t hour,
+ wxDateTime_t minute,
+ wxDateTime_t second,
+ wxDateTime_t millisec)
+{
+ Set(hour, minute, second, 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);
+}
// ----------------------------------------------------------------------------
-// wxDateTime operators
+// wxDateTime accessors
// ----------------------------------------------------------------------------
-// arithmetics
-// -----------
+inline wxLongLong wxDateTime::GetValue() const
+{
+ wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));
+
+ return m_time;
+}
+
+inline time_t wxDateTime::GetTicks() const
+{
+ wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));
+ if ( !IsInStdRange() )
+ {
+ return (time_t)-1;
+ }
+
+ return (time_t)((m_time / (long)TIME_T_FACTOR).ToLong()) + WX_TIME_BASE_OFFSET;
+}
+
+inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday,
+ Month month,
+ int year)
+{
+ return SetToWeekDay(weekday, -1, month, year);
+}
+
+inline wxDateTime
+wxDateTime::GetWeekDayInSameWeek(WeekDay weekday,
+ WeekFlags WXUNUSED(flags)) const
+{
+ MODIFY_AND_RETURN( SetToWeekDayInSameWeek(weekday) );
+}
-// no need to check for validity - the member functions we call will do it
+inline wxDateTime wxDateTime::GetNextWeekDay(WeekDay weekday) const
+{
+ MODIFY_AND_RETURN( SetToNextWeekDay(weekday) );
+}
-inline wxDateTime WXDLLEXPORT operator+(const wxDateTime& dt,
- const wxTimeSpan& ts)
+inline wxDateTime wxDateTime::GetPrevWeekDay(WeekDay weekday) const
{
- return dt.Add(ts);
+ MODIFY_AND_RETURN( SetToPrevWeekDay(weekday) );
}
-inline wxDateTime WXDLLEXPORT operator-(const wxDateTime& dt,
- const wxTimeSpan& ts)
+inline wxDateTime wxDateTime::GetWeekDay(WeekDay weekday,
+ int n,
+ Month month,
+ int year) const
{
- return dt.Subtract(ts);
+ wxDateTime dt(*this);
+
+ return dt.SetToWeekDay(weekday, n, month, year) ? dt : wxInvalidDateTime;
}
-inline wxDateTime WXDLLEXPORT operator+(const wxDateTime& dt,
- const wxDateSpan& ds)
+inline wxDateTime wxDateTime::GetLastWeekDay(WeekDay weekday,
+ Month month,
+ int year)
{
- return dt.Add(ds);
+ wxDateTime dt(*this);
+
+ return dt.SetToLastWeekDay(weekday, month, year) ? dt : wxInvalidDateTime;
}
-inline wxDateTime WXDLLEXPORT operator-(const wxDateTime& dt,
- const wxDateSpan& ds)
+inline wxDateTime wxDateTime::GetLastMonthDay(Month month, int year) const
{
- return dt.Subtract(ds);
+ MODIFY_AND_RETURN( SetToLastMonthDay(month, year) );
}
-inline wxTimeSpan WXDLLEXPORT operator-(const wxDateTime& dt1,
- const wxDateTime& dt2)
+inline wxDateTime wxDateTime::GetYearDay(wxDateTime_t yday) const
{
- return dt1.Subtract(dt2);
+ MODIFY_AND_RETURN( SetToYearDay(yday) );
}
-// comparison
-// ----------
+// ----------------------------------------------------------------------------
+// wxDateTime comparison
+// ----------------------------------------------------------------------------
-inline bool WXDLLEXPORT operator<(const wxDateTime& t1, const wxDateTime& t2)
+inline bool wxDateTime::IsEqualTo(const wxDateTime& datetime) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));
- return t1.GetValue() < t2.GetValue();
+ return m_time == datetime.m_time;
}
-inline bool WXDLLEXPORT operator<=(const wxDateTime& t1, const wxDateTime& t2)
+inline bool wxDateTime::IsEarlierThan(const wxDateTime& datetime) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));
- return t1.GetValue() <= t2.GetValue();
+ return m_time < datetime.m_time;
}
-inline bool WXDLLEXPORT operator>(const wxDateTime& t1, const wxDateTime& t2)
+inline bool wxDateTime::IsLaterThan(const wxDateTime& datetime) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));
- return t1.GetValue() > t2.GetValue();
+ return m_time > datetime.m_time;
}
-inline bool WXDLLEXPORT operator>=(const wxDateTime& t1, const wxDateTime& t2)
+inline bool wxDateTime::IsStrictlyBetween(const wxDateTime& t1,
+ const wxDateTime& t2) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+ // no need for assert, will be checked by the functions we call
+ return IsLaterThan(t1) && IsEarlierThan(t2);
+}
- return t1.GetValue() >= t2.GetValue();
+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 WXDLLEXPORT operator==(const wxDateTime& t1, const wxDateTime& t2)
+inline bool wxDateTime::IsSameDate(const wxDateTime& dt) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+ Tm tm1 = GetTm(),
+ tm2 = dt.GetTm();
- return t1.GetValue() == t2.GetValue();
+ return tm1.year == tm2.year &&
+ tm1.mon == tm2.mon &&
+ tm1.mday == tm2.mday;
}
-inline bool WXDLLEXPORT operator!=(const wxDateTime& t1, const wxDateTime& t2)
+inline bool wxDateTime::IsSameTime(const wxDateTime& dt) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+ // 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;
+}
- return t1.GetValue() != t2.GetValue();
+inline bool wxDateTime::IsEqualUpTo(const wxDateTime& dt,
+ const wxTimeSpan& ts) const
+{
+ return IsBetween(dt.Subtract(ts), dt.Add(ts));
}
// ----------------------------------------------------------------------------
-// wxTimeSpan operators
+// wxDateTime arithmetics
// ----------------------------------------------------------------------------
-// arithmetics
-// -----------
+inline wxDateTime wxDateTime::Add(const wxTimeSpan& diff) const
+{
+ wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));
+
+ return wxDateTime(m_time + diff.GetValue());
+}
+
+inline wxDateTime& wxDateTime::Add(const wxTimeSpan& diff)
+{
+ wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));
+
+ m_time += diff.GetValue();
+
+ return *this;
+}
-inline wxTimeSpan WXDLLEXPORT operator+(const wxTimeSpan& ts1,
- const wxTimeSpan& ts2)
+inline wxDateTime& wxDateTime::operator+=(const wxTimeSpan& diff)
{
- return wxTimeSpan(ts1.GetValue() + ts2.GetValue());
+ return Add(diff);
}
-inline wxTimeSpan WXDLLEXPORT operator-(const wxTimeSpan& ts1,
- const wxTimeSpan& ts2)
+inline wxDateTime wxDateTime::Subtract(const wxTimeSpan& diff) const
{
- return wxTimeSpan(ts1.GetValue() - ts2.GetValue());
+ wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));
+
+ return wxDateTime(m_time - diff.GetValue());
}
-inline wxTimeSpan WXDLLEXPORT operator*(const wxTimeSpan& ts, int n)
+inline wxDateTime& wxDateTime::Subtract(const wxTimeSpan& diff)
{
- return wxTimeSpan(ts).Multiply(n);
+ wxASSERT_MSG( IsValid(), wxT("invalid wxDateTime"));
+
+ m_time -= diff.GetValue();
+
+ return *this;
}
-inline wxTimeSpan WXDLLEXPORT operator*(int n, const wxTimeSpan& ts)
+inline wxDateTime& wxDateTime::operator-=(const wxTimeSpan& diff)
{
- return wxTimeSpan(ts).Multiply(n);
+ return Subtract(diff);
}
-// comparison
-// ----------
+inline wxTimeSpan wxDateTime::Subtract(const wxDateTime& datetime) const
+{
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), wxT("invalid wxDateTime"));
+
+ return wxTimeSpan(GetValue() - datetime.GetValue());
+}
-inline bool WXDLLEXPORT operator<(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxTimeSpan wxDateTime::operator-(const wxDateTime& dt2) const
{
- return t1.GetValue() < t2.GetValue();
+ return this->Subtract(dt2);
}
-inline bool WXDLLEXPORT operator<=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime wxDateTime::Add(const wxDateSpan& diff) const
{
- return t1.GetValue() <= t2.GetValue();
+ return wxDateTime(*this).Add(diff);
}
-inline bool WXDLLEXPORT operator>(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime& wxDateTime::Subtract(const wxDateSpan& diff)
{
- return t1.GetValue() > t2.GetValue();
+ return Add(diff.Negate());
}
-inline bool WXDLLEXPORT operator>=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime wxDateTime::Subtract(const wxDateSpan& diff) const
{
- return t1.GetValue() >= t2.GetValue();
+ return wxDateTime(*this).Subtract(diff);
}
-inline bool WXDLLEXPORT operator==(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime& wxDateTime::operator-=(const wxDateSpan& diff)
{
- return t1.GetValue() == t2.GetValue();
+ return Subtract(diff);
}
-inline bool WXDLLEXPORT operator!=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime& wxDateTime::operator+=(const wxDateSpan& diff)
{
- return t1.GetValue() != t2.GetValue();
+ return Add(diff);
}
// ----------------------------------------------------------------------------
-// wxDateSpan
+// wxDateTime and timezones
// ----------------------------------------------------------------------------
-// arithmetics
-// -----------
+inline wxDateTime
+wxDateTime::ToTimezone(const wxDateTime::TimeZone& tz, bool noDST) const
+{
+ MODIFY_AND_RETURN( MakeTimezone(tz, noDST) );
+}
-inline WXDLLEXPORT wxDateSpan operator+(const wxDateSpan& ds1,
- const wxDateSpan& ds2)
+inline wxDateTime
+wxDateTime::FromTimezone(const wxDateTime::TimeZone& tz, bool noDST) const
{
- return wxDateSpan(ds1.GetYears() + ds2.GetYears(),
- ds1.GetMonths() + ds2.GetMonths(),
- ds1.GetWeeks() + ds2.GetWeeks(),
- ds1.GetDays() + ds2.GetDays());
+ MODIFY_AND_RETURN( MakeFromTimezone(tz, noDST) );
}
-inline WXDLLEXPORT wxDateSpan operator-(const wxDateSpan& ds1,
- const wxDateSpan& ds2)
+// ----------------------------------------------------------------------------
+// wxTimeSpan construction
+// ----------------------------------------------------------------------------
+
+inline wxTimeSpan::wxTimeSpan(long hours,
+ long minutes,
+ wxLongLong seconds,
+ wxLongLong milliseconds)
{
- return wxDateSpan(ds1.GetYears() - ds2.GetYears(),
- ds1.GetMonths() - ds2.GetMonths(),
- ds1.GetWeeks() - ds2.GetWeeks(),
- ds1.GetDays() - ds2.GetDays());
+ // 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;
}
-inline WXDLLEXPORT wxDateSpan operator*(const wxDateSpan& ds, int n)
+// ----------------------------------------------------------------------------
+// wxTimeSpan accessors
+// ----------------------------------------------------------------------------
+
+inline wxLongLong wxTimeSpan::GetSeconds() const
{
- return wxDateSpan(ds).Multiply(n);
+ return m_diff / 1000l;
}
-inline WXDLLEXPORT wxDateSpan operator*(int n, const wxDateSpan& ds)
+inline int wxTimeSpan::GetMinutes() const
{
- return wxDateSpan(ds).Multiply(n);
+ // For compatibility, this method (and the other accessors) return int,
+ // even though GetLo() actually returns unsigned long with greater range.
+ return static_cast<int>((GetSeconds() / 60l).GetLo());
}
-// ============================================================================
-// other helper functions
-// ============================================================================
+inline int wxTimeSpan::GetHours() const
+{
+ return GetMinutes() / 60;
+}
+
+inline int wxTimeSpan::GetDays() const
+{
+ return GetHours() / 24;
+}
+
+inline int wxTimeSpan::GetWeeks() const
+{
+ return GetDays() / 7;
+}
// ----------------------------------------------------------------------------
-// iteration helpers: can be used to write a for loop over enum variable like
-// this:
-// for ( m = wxDateTime::Jan; m < wxDateTime::Inv_Month; wxNextMonth(m) )
+// wxTimeSpan arithmetics
// ----------------------------------------------------------------------------
-inline WXDLLEXPORT void wxNextMonth(wxDateTime::Month& m)
+inline wxTimeSpan wxTimeSpan::Add(const wxTimeSpan& diff) const
+{
+ return wxTimeSpan(m_diff + diff.GetValue());
+}
+
+inline wxTimeSpan& wxTimeSpan::Add(const wxTimeSpan& diff)
+{
+ m_diff += diff.GetValue();
+
+ return *this;
+}
+
+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;
+}
+
+inline wxTimeSpan& wxTimeSpan::Multiply(int n)
{
- wxASSERT_MSG( m < wxDateTime::Inv_Month, _T("invalid month") );
+ m_diff *= (long)n;
- // no wrapping or the for loop above would never end!
- m = (wxDateTime::Month)(m + 1);
+ return *this;
}
-inline WXDLLEXPORT void wxPrevMonth(wxDateTime::Month& m)
+inline wxTimeSpan wxTimeSpan::Multiply(int n) const
{
- wxASSERT_MSG( m < wxDateTime::Inv_Month, _T("invalid month") );
+ return wxTimeSpan(m_diff * (long)n);
+}
+
+inline wxTimeSpan wxTimeSpan::Abs() const
+{
+ return wxTimeSpan(GetValue().Abs());
+}
- m = m == wxDateTime::Jan ? wxDateTime::Inv_Month
- : (wxDateTime::Month)(m - 1);
+inline bool wxTimeSpan::IsEqualTo(const wxTimeSpan& ts) const
+{
+ return GetValue() == ts.GetValue();
}
-inline WXDLLEXPORT void wxNextWDay(wxDateTime::WeekDay& wd)
+inline bool wxTimeSpan::IsLongerThan(const wxTimeSpan& ts) const
{
- wxASSERT_MSG( wd < wxDateTime::Inv_WeekDay, _T("invalid week day") );
+ return GetValue().Abs() > ts.GetValue().Abs();
+}
- // no wrapping or the for loop above would never end!
- wd = (wxDateTime::WeekDay)(wd + 1);
+inline bool wxTimeSpan::IsShorterThan(const wxTimeSpan& ts) const
+{
+ return GetValue().Abs() < ts.GetValue().Abs();
}
-inline WXDLLEXPORT void wxPrevWDay(wxDateTime::WeekDay& wd)
+// ----------------------------------------------------------------------------
+// wxDateSpan
+// ----------------------------------------------------------------------------
+
+inline wxDateSpan& wxDateSpan::operator+=(const wxDateSpan& other)
{
- wxASSERT_MSG( wd < wxDateTime::Inv_WeekDay, _T("invalid week day") );
+ m_years += other.m_years;
+ m_months += other.m_months;
+ m_weeks += other.m_weeks;
+ m_days += other.m_days;
- wd = wd == wxDateTime::Sun ? wxDateTime::Inv_WeekDay
- : (wxDateTime::WeekDay)(wd - 1);
+ return *this;
}
+inline wxDateSpan& wxDateSpan::Add(const wxDateSpan& other)
+{
+ 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;
+}
+
+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);
+}
+
+inline wxDateSpan& wxDateSpan::Neg()
+{
+ m_years = -m_years;
+ m_months = -m_months;
+ m_weeks = -m_weeks;
+ m_days = -m_days;
+
+ 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
+
+// ============================================================================
+// binary operators
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxTimeSpan operators
+// ----------------------------------------------------------------------------
+
+wxTimeSpan WXDLLIMPEXP_BASE operator*(int n, const wxTimeSpan& ts);
+
+// ----------------------------------------------------------------------------
+// wxDateSpan
+// ----------------------------------------------------------------------------
+
+wxDateSpan WXDLLIMPEXP_BASE operator*(int n, const wxDateSpan& ds);
+
+// ============================================================================
+// other helper functions
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// iteration helpers: can be used to write a for loop over enum variable like
+// this:
+// for ( m = wxDateTime::Jan; m < wxDateTime::Inv_Month; wxNextMonth(m) )
+// ----------------------------------------------------------------------------
+
+WXDLLIMPEXP_BASE void wxNextMonth(wxDateTime::Month& m);
+WXDLLIMPEXP_BASE void wxPrevMonth(wxDateTime::Month& m);
+WXDLLIMPEXP_BASE void wxNextWDay(wxDateTime::WeekDay& wd);
+WXDLLIMPEXP_BASE void wxPrevWDay(wxDateTime::WeekDay& wd);
+
+#endif // wxUSE_DATETIME
+
#endif // _WX_DATETIME_H
projects / wxWidgets.git / blobdiff