// 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
+#ifndef __WXWINCE__
#include <time.h>
+#else
+#include "wx/msw/wince/time.h"
+#endif
+
#include <limits.h> // for INT_MIN
#include "wx/longlong.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;
-// 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)
-#ifdef __WXDEBUG__
- #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
+
+#if defined(__WXMAC__) && !defined(__DARWIN__) && __MSL__ < 0x6000
+ #define WX_TIME_BASE_OFFSET ( 2082844800L + 126144000L )
+#else
+ #define WX_TIME_BASE_OFFSET 0
+#endif
/*
- * TODO Well, everything :-)
+ * TODO
*
- * 1. Time zones with minutes (make wxTimeZone a class)
- * 2. getdate() function like under Solaris
- * 3. text conversion for wxDateSpan
+ * + 1. Time zones with minutes (make TimeZone a class)
+ * ? 2. getdate() function like under Solaris
+ * + 3. text conversion for wxDateSpan
+ * + 4. pluggable modules for the workdays calculations
+ * 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 classes declared in this header represent:
+ The three (main) classes declared in this header represent:
1. An absolute moment in the time (wxDateTime)
2. A difference between two moments in the time, positive or negative
wxTimeSpan + wxTimeSpan = wxTimeSpan
wxDateSpan + wxDateSpan = wxDateSpan
- substraction
+ subtraction
------------
wxDateTime - wxDateTime = wxTimeSpan
+ wxDateTime - wxTimeSpan = wxDateTime
+ wxDateTime - wxDateSpan = wxDateTime
wxTimeSpan - wxTimeSpan = wxTimeSpan
wxDateSpan - wxDateSpan = wxDateSpan
multiplication
--------------
wxTimeSpan * number = wxTimeSpan
+ number * wxTimeSpan = wxTimeSpan
wxDateSpan * number = wxDateSpan
+ number * wxDateSpan = wxDateSpan
unitary minus
-------------
-wxTimeSpan = wxTimeSpan
-wxDateSpan = wxDateSpan
+
+ For each binary operation OP (+, -, *) we have the following operatorOP=() as
+ a method and the method with a symbolic name OPER (Add, Subtract, Multiply)
+ as a synonym for it and another const method with the same name which returns
+ the changed copy of the object and operatorOP() as a global function which is
+ implemented in terms of the const version of OPEN. For the unary - we have
+ operator-() as a method, Neg() as synonym for it and Negate() which returns
+ the copy of the object with the changed sign.
*/
+// an invalid/default date time object which may be used as the default
+// 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_FWD_BASE wxDateTime;
+
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDefaultDateTimeFormat;
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDefaultTimeSpanFormat;
+extern WXDLLIMPEXP_DATA_BASE(const wxDateTime) wxDefaultDateTime;
+
+#define wxInvalidDateTime wxDefaultDateTime
+
// ----------------------------------------------------------------------------
-// This class represents an absolute moment in the time
+// wxDateTime represents an absolute moment in the time
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxDateTime
+class WXDLLIMPEXP_BASE wxDateTime
{
public:
// types
// ------------------------------------------------------------------------
- // a small unsigned integer type for storing things like seconds, days
- // of the week, &c. It should be at least short (i.e. not char) to
- // contain the number of milliseconds - it may also be 'int' because
- // there is no size penalty associated with it in our code, we don't
- // store any data in this format
+ // a small unsigned integer type for storing things like minutes,
+ // seconds &c. It should be at least short (i.e. not char) to contain
+ // the number of milliseconds - it may also be 'int' because there is
+ // no size penalty associated with it in our code, we don't store any
+ // data in this format
typedef unsigned short wxDateTime_t;
+ // constants
+ // ------------------------------------------------------------------------
+
// the timezones
enum TZ
{
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
// 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_Default, // set the default country with SetCountry() method
+ // or use the default country with any other
// TODO add more countries (for this we must know about DST and/or
// holidays for this country)
+
+ // Western European countries: we assume that they all follow the same
+ // DST rules (true or false?)
+ Country_WesternEurope_Start,
+ Country_EEC = Country_WesternEurope_Start,
France,
+ Germany,
+ UK,
+ Country_WesternEurope_End = UK,
+
+ Russia,
USA
};
-
// symbolic names for the months
enum Month
{
Inv_Year = SHRT_MIN // should hold in wxDateTime_t
};
+ // flags for GetWeekDayName and GetMonthName
+ enum NameFlags
+ {
+ Name_Full = 0x01, // return full name
+ Name_Abbr = 0x02 // return abbreviated name
+ };
+
+ // flags for GetWeekOfYear and GetWeekOfMonth
+ enum WeekFlags
+ {
+ Default_First, // Sunday_First for US, Monday_First for the rest
+ Monday_First, // week starts with a Monday
+ Sunday_First // week starts with a Sunday
+ };
+
// helper classes
// ------------------------------------------------------------------------
+ // a class representing a time zone: basicly, this is just an offset
+ // (in seconds) from GMT
+ class WXDLLIMPEXP_BASE TimeZone
+ {
+ public:
+ TimeZone(TZ tz);
+ TimeZone(wxDateTime_t offset = 0) { m_offset = offset; }
+
+ long GetOffset() const { return m_offset; }
+
+ private:
+ // offset for this timezone from GMT in seconds
+ long m_offset;
+ };
+
// standard struct tm is limited to the years from 1900 (because
// tm_year field is the offset from 1900), so we use our own struct
// instead to represent broken down time
// 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 Tm
+ struct WXDLLIMPEXP_BASE Tm
{
- wxDateTime_t sec, min, hour, mday;
+ wxDateTime_t msec, sec, min, hour, mday;
Month mon;
int year;
// default ctor inits the object to an invalid value
Tm();
- // ctor from struct tm
- Tm(const struct tm& tm);
+ // ctor from struct tm and the timezone
+ Tm(const struct tm& tm, const TimeZone& tz);
// check that the given date/time is valid (in Gregorian calendar)
bool IsValid() const;
}
// add the given number of months to the date keeping it normalized
- void AddMonths(wxDateTime_t monDiff);
+ void AddMonths(int monDiff);
// add the given number of months to the date keeping it normalized
- void AddDays(wxDateTime_t dayDiff);
+ void AddDays(int dayDiff);
private:
// compute the weekday from other fields
void ComputeWeekDay();
+ // 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;
};
- // a class representing a time zone: basicly, this is just an offset
- // (in minutes) from GMT
- class TimeZone
- {
- public:
- TimeZone(TZ tz);
- TimeZone(wxDateTime_t offset) { m_offset = offset; }
-
- int GetOffset() const { return m_offset; }
-
- private:
- // offset for this timezone from GMT in minutes
- int m_offset;
- };
-
// static methods
// ------------------------------------------------------------------------
// set the current country
static void SetCountry(Country country);
// get the current country
- static inline Country GetCountry();
+ static Country GetCountry();
+
+ // 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 year
static int GetCurrentYear(Calendar cal = Gregorian);
// 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 :-)
// get the full (default) or abbreviated month name in the current
// locale, returns empty string on error
- static wxString GetMonthName(Month month, bool abbr = FALSE);
+ static wxString GetMonthName(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, bool abbr = FALSE);
+ static wxString GetWeekDayName(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
+ static bool IsDSTApplicable(int year = Inv_Year,
+ Country country = Country_Default);
// get the beginning of DST for this year, will return invalid object
// if no DST applicable in this year. The default value of the
// parameter means to take the current year.
- static wxDateTime GetBeginDST(int year = Inv_Year);
+ static wxDateTime GetBeginDST(int year = Inv_Year,
+ Country country = Country_Default);
// get the end of DST for this year, will return invalid object
// if no DST applicable in this year. The default value of the
// parameter means to take the current year.
- static wxDateTime GetEndDST(int year = Inv_Year);
+ static wxDateTime GetEndDST(int year = Inv_Year,
+ Country country = Country_Default);
// return the wxDateTime object for the current time
static inline wxDateTime Now();
+ // return the wxDateTime object for the current time with millisecond
+ // precision (if available on this platform)
+ static wxDateTime UNow();
+
+ // return the wxDateTime object for today midnight: i.e. as Now() but
+ // with time set to 0
+ static inline wxDateTime Today();
+
// constructors: you should test whether the constructor succeeded with
// IsValid() function. The values Inv_Month and Inv_Year for the
// parameters mean take current month and/or year values.
- //
- // All new wxDateTime correspond to the local time, use ToUTC() or
- // MakeUTC() to get the time in UTC/GMT.
// ------------------------------------------------------------------------
// 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))
+// VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
inline wxDateTime(time_t timet);
+#endif
// from broken down time/date (only for standard Unix range)
inline wxDateTime(const struct tm& tm);
// from broken down time/date (any range)
inline wxDateTime(const Tm& tm);
+ // from JDN (beware of rounding errors)
+ inline wxDateTime(double jdn);
+
// from separate values for each component, date set to today
inline wxDateTime(wxDateTime_t hour,
wxDateTime_t minute = 0,
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,
// set to the current time
inline wxDateTime& SetToCurrent();
+#if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
+// VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
// set to given time_t value
inline wxDateTime& Set(time_t timet);
+#endif
// set to given broken down time/date
wxDateTime& Set(const struct tm& tm);
// set to given broken down time/date
inline wxDateTime& Set(const Tm& tm);
+ // set to given JDN (beware of rounding errors)
+ wxDateTime& Set(double jdn);
+
// set to given time, date = today
wxDateTime& Set(wxDateTime_t hour,
wxDateTime_t minute = 0,
// 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)
+ // unchanged, e.g. don't explictly 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,
+ 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);
+ inline wxDateTime GetNextWeekDay(WeekDay weekday) const;
+
+ // set to the previous week day before this one
+ 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
+ // 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,
int n = 1,
Month month = Inv_Month,
int year = Inv_Year);
+ inline wxDateTime GetWeekDay(WeekDay weekday,
+ int n = 1,
+ Month month = Inv_Month,
+ int year = Inv_Year) const;
// sets to the last weekday in the given month, year
inline bool SetToLastWeekDay(WeekDay weekday,
Month month = Inv_Month,
int year = Inv_Year);
+ inline wxDateTime GetLastWeekDay(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);
+ //
+ // 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
wxDateTime& SetToLastMonthDay(Month month = Inv_Month,
int year = Inv_Year);
+ inline wxDateTime GetLastMonthDay(Month month = Inv_Month,
+ int year = Inv_Year) const;
+
+ // sets to the given year day (1..365 or 366)
+ wxDateTime& SetToYearDay(wxDateTime_t yday);
+ inline wxDateTime GetYearDay(wxDateTime_t yday) const;
// The definitions below were taken verbatim from
//
// of days relative to a base date of December 31 of the year 0. Thus
// January 1 of the year 1 is Rata Die day 1.
- // get the Julian Day number
- long GetJulianDay() const;
+ // get the Julian Day number (the fractional part specifies the time of
+ // the day, related to noon - beware of rounding errors!)
+ double GetJulianDayNumber() const;
+ double GetJDN() const { return GetJulianDayNumber(); }
+
+ // get the Modified Julian Day number: it is equal to JDN - 2400000.5
+ // and so integral MJDs correspond to the midnights (and not noons).
+ // MJD 0 is Nov 17, 1858
+ double GetModifiedJulianDayNumber() const { return GetJDN() - 2400000.5; }
+ double GetMJD() const { return GetModifiedJulianDayNumber(); }
// get the Rata Die number
- long GetRataDie() const;
+ double GetRataDie() const;
// TODO algorithms for calculating some important dates, such as
// religious holidays (Easter...) or moon/solar eclipses? Some
// algorithms can be found in the calendar FAQ
- // timezone stuff: by default, we always work with local times, to get
- // anything else, it should be requested explicitly
+
+ // 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
+ // 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.
// ------------------------------------------------------------------------
- // transform this object to UTC/GMT
- wxDateTime& MakeUTC();
- wxDateTime& MakeGMT() { return MakeUTC(); }
+ // transform to any given timezone
+ inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
+ wxDateTime& MakeTimezone(const TimeZone& tz, bool noDST = false);
- // get the time corresponding to this one in UTC/GMT
- inline wxDateTime ToUTC() const;
- wxDateTime ToGMT() const { return ToUTC(); }
+ // 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);
- // generic versions of the above
+ // transform to/from GMT/UTC
+ wxDateTime ToUTC(bool noDST = false) const { return ToTimezone(UTC, noDST); }
+ wxDateTime& MakeUTC(bool noDST = false) { return MakeTimezone(UTC, noDST); }
- // transform from local time to any given timezone
- inline wxDateTime ToTimezone(const TimeZone& tz) const;
- wxDateTime& MakeTimezone(const TimeZone& tz);
+ 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?
+ //
+ // Return value is > 0 if DST is in effect, 0 if it is not and -1 if
+ // the information is not available (this is compatible with ANSI C)
+ int IsDST(Country country = Country_Default) const;
- // transform time from any timezone to the local time
- inline wxDateTime ToLocalTime(const TimeZone& tz) const;
- wxDateTime& MakeLocalTime(const TimeZone& tz);
// accessors: many of them take the timezone parameter which indicates the
// timezone for which to make the calculations and the default value means
// result of timezone shift)
// ------------------------------------------------------------------------
- // is the date valid (FALSE for uninitialized objects as well as after
- // the functions which failed to convert the date to supported range)
- inline bool IsValid() const { return this != &ms_InvDateTime; }
+ // is the date valid?
+ inline bool IsValid() const { return m_time != wxInvalidDateTime.m_time; }
- // get the broken down date/time representation
- Tm GetTm() const;
+ // get the broken down date/time representation in the given timezone
+ //
+ // If you wish to get several time components (day, month and year),
+ // consider getting the whole Tm strcuture first and retrieving the
+ // value from it - this is much more efficient
+ Tm GetTm(const TimeZone& tz = Local) const;
// get the number of seconds since the Unix epoch - returns (time_t)-1
// 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 { return GetTm().year; }
+ int GetYear(const TimeZone& tz = Local) const
+ { return GetTm(tz).year; }
// get the month (Inv_Month if date is invalid)
- Month GetMonth() const { return (Month)GetTm().mon; }
+ Month GetMonth(const TimeZone& tz = Local) const
+ { return (Month)GetTm(tz).mon; }
// get the month day (in 1..31 range, 0 if date is invalid)
- wxDateTime_t GetDay() const { return GetTm().mday; }
+ wxDateTime_t GetDay(const TimeZone& tz = Local) const
+ { return GetTm(tz).mday; }
// get the day of the week (Inv_WeekDay if date is invalid)
- WeekDay GetWeekDay() const { return GetTm().GetWeekDay(); }
+ WeekDay GetWeekDay(const TimeZone& tz = Local) const
+ { return GetTm(tz).GetWeekDay(); }
// get the hour of the day
- wxDateTime_t GetHour() const { return GetTm().hour; }
+ wxDateTime_t GetHour(const TimeZone& tz = Local) const
+ { return GetTm(tz).hour; }
// get the minute
- wxDateTime_t GetMinute() const { return GetTm().min; }
+ wxDateTime_t GetMinute(const TimeZone& tz = Local) const
+ { return GetTm(tz).min; }
// get the second
- wxDateTime_t GetSecond() const { return GetTm().sec; }
+ wxDateTime_t GetSecond(const TimeZone& tz = Local) const
+ { return GetTm(tz).sec; }
// get milliseconds
- wxDateTime_t GetMillisecond() const { return m_time.GetLo() % 1000; }
+ wxDateTime_t GetMillisecond(const TimeZone& tz = Local) const
+ { return GetTm(tz).msec; }
// get the day since the year start (1..366, 0 if date is invalid)
- wxDateTime_t GetDayOfYear() const;
- // get the week number since the year start (1..52, 0 if date is
+ wxDateTime_t GetDayOfYear(const TimeZone& tz = Local) const;
+ // get the week number since the year start (1..52 or 53, 0 if date is
// invalid)
- wxDateTime_t GetWeekOfYear() const;
+ wxDateTime_t GetWeekOfYear(WeekFlags flags = Monday_First,
+ const TimeZone& tz = Local) const;
+ // get the week number since the month start (1..5, 0 if date is
+ // invalid)
+ wxDateTime_t GetWeekOfMonth(WeekFlags flags = Monday_First,
+ const TimeZone& tz = Local) const;
// is this date a work day? This depends on a country, of course,
// because the holidays are different in different countries
- bool IsWorkDay(Country country = Country_Default,
- TimeZone zone = Local) const;
+ 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 authoiruty in
+ // 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;
- // is daylight savings time in effect at this moment?
- //
- // Return value is > 0 if DST is in effect, 0 if it is not and -1 if
- // the information is not available (this is compatible with ANSI C)
- int IsDST(Country country = Country_Default, TimeZone zone = Local) 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;
// 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 two moments are identical
- inline bool operator==(const wxDateTime& datetime) const;
-
- // returns TRUE if the two moments are different
- inline bool operator!=(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;
- // date operations: for the non-const methods, the return value is this
- // object itself (see also functions below for operator versions)
+ // do these two objects refer to the same date?
+ inline bool IsSameDate(const wxDateTime& dt) const;
+
+ // do these two objects have the same time?
+ inline bool IsSameTime(const wxDateTime& dt) const;
+
+ // 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(), _T("invalid wxDateTime") );
+ return GetValue() < dt.GetValue();
+ }
+
+ inline bool operator<=(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+ return GetValue() <= dt.GetValue();
+ }
+
+ inline bool operator>(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+ return GetValue() > dt.GetValue();
+ }
+
+ inline bool operator>=(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+ return GetValue() >= dt.GetValue();
+ }
+
+ inline bool operator==(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+ return GetValue() == dt.GetValue();
+ }
+
+ inline bool operator!=(const wxDateTime& dt) const
+ {
+ wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
+ return GetValue() != dt.GetValue();
+ }
+
+ // arithmetics with dates (see also below for more operators)
// ------------------------------------------------------------------------
+ // return the sum of the date with a time span (positive or negative)
+ inline wxDateTime Add(const wxTimeSpan& diff) const;
// add a time span (positive or negative)
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;
+ }
- // substract a time span (positive or negative)
- inline wxDateTime& Substract(const wxTimeSpan& diff);
- // substract a time span (positive or negative)
+ // return the difference of the date with a time span
+ inline wxDateTime Subtract(const wxTimeSpan& diff) const;
+ // subtract a time span (positive or negative)
+ 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;
// add a date span (positive or negative)
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;
+ }
- // substract a date span (positive or negative)
- inline wxDateTime& Substract(const wxDateSpan& diff);
- // substract a date span (positive or negative)
+ // return the difference of the date with a date span
+ inline wxDateTime Subtract(const wxDateSpan& diff) const;
+ // subtract a date span (positive or negative)
+ 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;
+ }
- // substract a date (may result in positive or negative time span)
- inline wxTimeSpan Substract(const wxDateTime& datetime) const;
- // substract a date (may result in positive or negative time span)
- inline wxTimeSpan operator-(const wxDateTime& datetime) const;
+ // return the difference between two dates
+ inline wxTimeSpan Subtract(const wxDateTime& dt) const;
+ inline wxTimeSpan operator-(const wxDateTime& dt2) const;
- // conversion to/from text: all conversions from text return TRUE on
- // success or FALSE if the date is malformed/out of supported range
+ // 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.
// ------------------------------------------------------------------------
// 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")
- bool ParseRfc822Date(const wxString& date);
- // parse a date/time in the given format (see strptime(3))
- bool ParseFormat(const wxString& date, const char *format = "%c");
+ const wxChar *ParseRfc822Date(const wxChar* 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 wxString& format = wxDefaultDateTimeFormat,
+ const wxDateTime& dateDef = wxDefaultDateTime);
// parse a string containing the date/time in "free" format, this
// function will try to make an educated guess at the string contents
- // (and return FALSE if it fails)
- bool ParseDateTime(const wxString& date);
+ const wxChar *ParseDateTime(const wxChar *datetime);
+ // parse a string containing the date only in "free" format (less
+ // flexible than ParseDateTime)
+ const wxChar *ParseDate(const wxChar *date);
+ // parse a string containing the time only in "free" format
+ const wxChar *ParseTime(const wxChar *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 = _T("%c")) const;
+ 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")); }
// preferred time representation for the current locale
wxString FormatTime() const { return Format(_T("%X")); }
+ // returns the string representing the date in ISO 8601 format
+ // (YYYY-MM-DD)
+ wxString FormatISODate() const { return Format(_T("%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")); }
// implementation
// ------------------------------------------------------------------------
+ // construct from internal representation
+ wxDateTime(const wxLongLong& time) { m_time = time; }
+
// get the internal representation
inline wxLongLong GetValue() const;
return localtime(&t);
}
+ // get current time using thread-safe function
+ static struct tm *GetTmNow(struct tm *tmstruct);
+
private:
// the current country - as it's the same for all program objects (unless
// it runs on a _really_ big cluster system :-), this is a static member:
// this constant is used to transform a time_t value to the internal
// representation, as time_t is in seconds and we use milliseconds it's
// fixed to 1000
- static const unsigned int TIME_T_FACTOR;
-
- // invalid wxDateTime object - returned by all functions which return
- // "wxDateTime &" on failure
- static wxDateTime ms_InvDateTime;
+ 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;
// ----------------------------------------------------------------------------
// This class contains a difference between 2 wxDateTime values, so it makes
-// sense to add it to wxDateTime and it is the result of substraction of 2
+// sense to add it to wxDateTime and it is the result of subtraction of 2
// 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(int sec) { return wxTimeSpan(0, 0, sec); }
+ static wxTimeSpan Seconds(wxLongLong sec) { return wxTimeSpan(0, 0, sec); }
+ static wxTimeSpan Second() { return Seconds(1); }
// return the timespan for the given number of minutes
- static wxTimeSpan Minutes(int min) { return wxTimeSpan(0, min, 0 ); }
+ static wxTimeSpan Minutes(long min) { return wxTimeSpan(0, min, 0 ); }
+ static wxTimeSpan Minute() { return Minutes(1); }
// return the timespan for the given number of hours
- static wxTimeSpan Hours(int hours) { return wxTimeSpan(hours, 0, 0); }
+ static wxTimeSpan Hours(long hours) { return wxTimeSpan(hours, 0, 0); }
+ static wxTimeSpan Hour() { return Hours(1); }
+
+ // return the timespan for the given number of days
+ static wxTimeSpan Days(long days) { return Hours(24 * days); }
+ static wxTimeSpan Day() { return Days(1); }
+
+ // return the timespan for the given number of weeks
+ static wxTimeSpan Weeks(long days) { return Days(7 * days); }
+ static wxTimeSpan Week() { return Weeks(1); }
// default ctor constructs the 0 time span
wxTimeSpan() { }
// from separate values for each component, date set to 0 (hours are
// not restricted to 0..24 range, neither are minutes, seconds or
// milliseconds)
- inline wxTimeSpan(int hours,
- int minutes = 0,
- int seconds = 0,
- int milliseconds = 0);
-
- // from internal representation
- wxTimeSpan(wxLongLong diff) : m_diff(diff) { }
+ inline wxTimeSpan(long hours,
+ long minutes = 0,
+ wxLongLong seconds = 0,
+ wxLongLong milliseconds = 0);
// default copy ctor is ok
// no dtor
- // arithmetics with time spans
+ // arithmetics with time spans (see also below for more operators)
// ------------------------------------------------------------------------
+ // return the sum of two timespans
+ inline wxTimeSpan Add(const wxTimeSpan& diff) const;
// add two timespans together
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());
+ }
- // substract another timespan
- inline wxTimeSpan& Substract(const wxTimeSpan& diff);
- // substract another timespan
- wxTimeSpan& operator-=(const wxTimeSpan& diff) { return Substract(diff); }
+ // return the difference of two timespans
+ inline wxTimeSpan Subtract(const wxTimeSpan& diff) const;
+ // subtract another timespan
+ 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;
// multiply timespan by a scalar
inline wxTimeSpan& Multiply(int n);
// multiply timespan by a scalar
wxTimeSpan& operator*=(int n) { return Multiply(n); }
- // multiply timespan by a scalar
- inline wxTimeSpan operator*(int n) const;
+ 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); }
- // breaking into years, ..., days, ..., seconds: all these functions
- // behave like GetYears() which returns 1 for the timespan of 1 year and 1
- // day, but 0 (and not -1) for the negative timespan of 1 year without 1
- // day. IOW, (ts - wxTimeSpan(ts.GetYears())).GetYears() is always 0.
+ 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
// ------------------------------------------------------------------------
- // get the max number of years in this timespan
- inline int GetYears() const;
- // get the max number of months in this timespan
- inline int GetMonths() const;
// get the max number of weeks in this timespan
inline int GetWeeks() const;
// get the max number of days in this timespan
// get the max number of minutes in this timespan
inline int GetMinutes() const;
// get the max number of seconds in this timespan
- inline int GetSeconds() const;
+ inline wxLongLong GetSeconds() const;
// get the number of milliseconds in this timespan
wxLongLong GetMilliseconds() const { return m_diff; }
// 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("%c")) const;
- // preferred date representation for the current locale
- wxString FormatDate() const { return Format(_T("%x")); }
- // preferred time representation for the current locale
- wxString FormatTime() const { return Format(_T("%X")); }
+ wxString Format(const wxString& format = wxDefaultTimeSpanFormat) const;
// implementation
// ------------------------------------------------------------------------
+ // construct from internal representation
+ wxTimeSpan(const wxLongLong& diff) { m_diff = diff; }
+
// get the internal representation
wxLongLong GetValue() const { return m_diff; }
// one month to Feb, 15 - we want to get Mar, 15, of course).
//
// When adding a month to the date, all lesser components (days, hours, ...)
-// won't be changed.
+// won't be changed unless the resulting date would be invalid: for example,
+// Jan 31 + 1 month will be Feb 28, not (non existing) Feb 31.
+//
+// Because of this feature, adding and subtracting back again the same
+// wxDateSpan will *not*, in general give back the original date: Feb 28 - 1
+// month will be Jan 28, not Jan 31!
//
// wxDateSpan can be either positive or negative. They may be
// multiplied by scalars which multiply all deltas by the scalar: i.e. 2*(1
// 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
// get an object for the given number of days
static wxDateSpan Days(int days) { return wxDateSpan(0, 0, 0, days); }
+ static wxDateSpan Day() { return Days(1); }
// get an object for the given number of weeks
static wxDateSpan Weeks(int weeks) { return wxDateSpan(0, 0, weeks, 0); }
+ static wxDateSpan Week() { return Weeks(1); }
// get an object for the given number of months
static wxDateSpan Months(int mon) { return wxDateSpan(0, mon, 0, 0); }
+ static wxDateSpan Month() { return Months(1); }
// get an object for the given number of years
static wxDateSpan Years(int years) { return wxDateSpan(years, 0, 0, 0); }
+ static wxDateSpan Year() { return Years(1); }
// default copy ctor is ok
// returns 7*GetWeeks() + GetDays()
int GetTotalDays() const { return 7*m_weeks + m_days; }
- // arithmetics
+ // arithmetics with date spans (see also below for more operators)
// ------------------------------------------------------------------------
+ // return sum of two date spans
+ inline wxDateSpan Add(const wxDateSpan& other) const;
// add another wxDateSpan to us
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());
+ }
- // substract another wxDateSpan from us
- inline wxDateSpan& Substract(const wxDateSpan& other);
- // substract another wxDateSpan from us
+ // return difference of two date spans
+ inline wxDateSpan Subtract(const wxDateSpan& other) const;
+ // subtract another wxDateSpan from us
+ 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;
// inverse the sign of this timespan
wxDateSpan& operator-() { return Neg(); }
+ // return the date span proportional to this one with given factor
+ inline wxDateSpan Multiply(int factor) const;
+ // multiply all components by a (signed) number
+ inline wxDateSpan& Multiply(int factor);
// multiply all components by a (signed) number
- inline wxDateSpan& operator*=(int factor);
+ 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,
m_days;
};
-WXDLLEXPORT_DATA(extern wxDateSpan) wxYear;
-WXDLLEXPORT_DATA(extern wxDateSpan) wxMonth;
-WXDLLEXPORT_DATA(extern wxDateSpan) wxWeek;
-WXDLLEXPORT_DATA(extern wxDateSpan) wxDay;
+// ----------------------------------------------------------------------------
+// wxDateTimeArray: array of dates.
+// ----------------------------------------------------------------------------
+
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDateTime, wxDateTimeArray, WXDLLIMPEXP_BASE);
+
+// ----------------------------------------------------------------------------
+// wxDateTimeHolidayAuthority: an object of this class will decide whether a
+// given date is a holiday and is used by all functions working with "work
+// days".
+//
+// NB: the base class is an ABC, derived classes must implement the pure
+// virtual methods to work with the holidays they correspond to.
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_FWD_BASE wxDateTimeHolidayAuthority;
+WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxDateTimeHolidayAuthority *,
+ wxHolidayAuthoritiesArray,
+ class WXDLLIMPEXP_BASE);
+
+class wxDateTimeHolidaysModule;
+class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority
+{
+friend class wxDateTimeHolidaysModule;
+public:
+ // 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
+ // the number of them
+ static size_t GetHolidaysInRange(const wxDateTime& dtStart,
+ const wxDateTime& dtEnd,
+ wxDateTimeArray& holidays);
+
+ // clear the list of holiday authorities
+ static void ClearAllAuthorities();
+
+ // add a new holiday authority (the pointer will be deleted by
+ // 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;
+
+ // this function should fill the array with all holidays between the two
+ // given dates - it is implemented in the base class, but in a very
+ // inefficient way (it just iterates over all days and uses IsHoliday() for
+ // each of them), so it must be overridden in the derived class where the
+ // base class version may be explicitly used if needed
+ //
+ // returns the number of holidays in the given range and fills holidays
+ // array
+ virtual size_t DoGetHolidaysInRange(const wxDateTime& dtStart,
+ const wxDateTime& dtEnd,
+ wxDateTimeArray& holidays) const = 0;
+
+private:
+ // all holiday authorities
+ static wxHolidayAuthoritiesArray ms_authorities;
+};
+
+// the holidays for this class are all Saturdays and Sundays
+class WXDLLIMPEXP_BASE wxDateTimeWorkDays : public wxDateTimeHolidayAuthority
+{
+protected:
+ virtual bool DoIsHoliday(const wxDateTime& dt) const;
+ virtual size_t DoGetHolidaysInRange(const wxDateTime& dtStart,
+ const wxDateTime& dtEnd,
+ wxDateTimeArray& holidays) 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
+// ----------------------------------------------------------------------------
-#if !defined(__WXDEBUG__) || defined(wxDEFINE_TIME_CONSTANTS)
- #define INCLUDED_FROM_WX_DATETIME_H
- #include "wx/datetime.inl"
- #undef INCLUDED_FROM_WX_DATETIME_H
+#define MILLISECONDS_PER_DAY 86400000l
+
+// 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
+{
+ return m_time >= 0l && (m_time / TIME_T_FACTOR) < LONG_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)
+{
+ // 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(), _T("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
// ----------------------------------------------------------------------------
-inline bool WXDLLEXPORT operator<(const wxDateTime &t1, const wxDateTime &t2)
+inline wxLongLong wxDateTime::GetValue() const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+ wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
- return t1.GetValue() < t2.GetValue();
+ return m_time;
}
-inline bool WXDLLEXPORT operator<=(const wxDateTime &t1, const wxDateTime &t2)
+inline time_t wxDateTime::GetTicks() const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+ wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+ if ( !IsInStdRange() )
+ {
+ return (time_t)-1;
+ }
- return t1.GetValue() <= t2.GetValue();
+ return (time_t)((m_time / (long)TIME_T_FACTOR).ToLong()) + WX_TIME_BASE_OFFSET;
}
-inline bool WXDLLEXPORT operator>(const wxDateTime &t1, const wxDateTime &t2)
+inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday,
+ Month month,
+ int year)
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+ return SetToWeekDay(weekday, -1, month, year);
+}
- return t1.GetValue() > t2.GetValue();
+inline wxDateTime
+wxDateTime::GetWeekDayInSameWeek(WeekDay weekday,
+ WeekFlags WXUNUSED(flags)) const
+{
+ MODIFY_AND_RETURN( SetToWeekDayInSameWeek(weekday) );
}
-inline bool WXDLLEXPORT operator>=(const wxDateTime &t1, const wxDateTime &t2)
+inline wxDateTime wxDateTime::GetNextWeekDay(WeekDay weekday) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+ MODIFY_AND_RETURN( SetToNextWeekDay(weekday) );
+}
- return t1.GetValue() >= t2.GetValue();
+inline wxDateTime wxDateTime::GetPrevWeekDay(WeekDay weekday) const
+{
+ MODIFY_AND_RETURN( SetToPrevWeekDay(weekday) );
}
-inline bool WXDLLEXPORT operator==(const wxDateTime &t1, const wxDateTime &t2)
+inline wxDateTime wxDateTime::GetWeekDay(WeekDay weekday,
+ int n,
+ Month month,
+ int year) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+ wxDateTime dt(*this);
- return t1.GetValue() == t2.GetValue();
+ return dt.SetToWeekDay(weekday, n, month, year) ? dt : wxInvalidDateTime;
}
-inline bool WXDLLEXPORT operator!=(const wxDateTime &t1, const wxDateTime &t2)
+inline wxDateTime wxDateTime::GetLastWeekDay(WeekDay weekday,
+ Month month,
+ int year)
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+ wxDateTime dt(*this);
- return t1.GetValue() != t2.GetValue();
+ return dt.SetToLastWeekDay(weekday, month, year) ? dt : wxInvalidDateTime;
}
-inline wxTimeSpan WXDLLEXPORT operator-(const wxDateTime &t1,
- const wxDateTime &t2)
+inline wxDateTime wxDateTime::GetLastMonthDay(Month month, int year) const
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+ MODIFY_AND_RETURN( SetToLastMonthDay(month, year) );
+}
- return wxTimeSpan(t1.GetValue() - t2.GetValue());
+inline wxDateTime wxDateTime::GetYearDay(wxDateTime_t yday) const
+{
+ MODIFY_AND_RETURN( SetToYearDay(yday) );
}
// ----------------------------------------------------------------------------
-// wxTimeSpan operators
+// wxDateTime comparison
+// ----------------------------------------------------------------------------
+
+inline bool wxDateTime::IsEqualTo(const wxDateTime& datetime) const
+{
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+
+ return m_time == datetime.m_time;
+}
+
+inline bool wxDateTime::IsEarlierThan(const wxDateTime& datetime) const
+{
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+
+ return m_time < datetime.m_time;
+}
+
+inline bool wxDateTime::IsLaterThan(const wxDateTime& datetime) const
+{
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+
+ return m_time > datetime.m_time;
+}
+
+inline bool wxDateTime::IsStrictlyBetween(const wxDateTime& t1,
+ const wxDateTime& t2) const
+{
+ // no need for assert, will be checked by the functions we call
+ return IsLaterThan(t1) && IsEarlierThan(t2);
+}
+
+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 wxDateTime::IsSameDate(const wxDateTime& dt) const
+{
+ Tm tm1 = GetTm(),
+ tm2 = dt.GetTm();
+
+ return tm1.year == tm2.year &&
+ tm1.mon == tm2.mon &&
+ tm1.mday == tm2.mday;
+}
+
+inline bool wxDateTime::IsSameTime(const wxDateTime& dt) const
+{
+ // 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;
+}
+
+inline bool wxDateTime::IsEqualUpTo(const wxDateTime& dt,
+ const wxTimeSpan& ts) const
+{
+ return IsBetween(dt.Subtract(ts), dt.Add(ts));
+}
+
+// ----------------------------------------------------------------------------
+// wxDateTime arithmetics
+// ----------------------------------------------------------------------------
+
+inline wxDateTime wxDateTime::Add(const wxTimeSpan& diff) const
+{
+ wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+
+ return wxDateTime(m_time + diff.GetValue());
+}
+
+inline wxDateTime& wxDateTime::Add(const wxTimeSpan& diff)
+{
+ wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+
+ m_time += diff.GetValue();
+
+ return *this;
+}
+
+inline wxDateTime& wxDateTime::operator+=(const wxTimeSpan& diff)
+{
+ return Add(diff);
+}
+
+inline wxDateTime wxDateTime::Subtract(const wxTimeSpan& diff) const
+{
+ wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+
+ return wxDateTime(m_time - diff.GetValue());
+}
+
+inline wxDateTime& wxDateTime::Subtract(const wxTimeSpan& diff)
+{
+ wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
+
+ m_time -= diff.GetValue();
+
+ return *this;
+}
+
+inline wxDateTime& wxDateTime::operator-=(const wxTimeSpan& diff)
+{
+ return Subtract(diff);
+}
+
+inline wxTimeSpan wxDateTime::Subtract(const wxDateTime& datetime) const
+{
+ wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
+
+ return wxTimeSpan(GetValue() - datetime.GetValue());
+}
+
+inline wxTimeSpan wxDateTime::operator-(const wxDateTime& dt2) const
+{
+ return this->Subtract(dt2);
+}
+
+inline wxDateTime wxDateTime::Add(const wxDateSpan& diff) const
+{
+ return wxDateTime(*this).Add(diff);
+}
+
+inline wxDateTime& wxDateTime::Subtract(const wxDateSpan& diff)
+{
+ return Add(diff.Negate());
+}
+
+inline wxDateTime wxDateTime::Subtract(const wxDateSpan& diff) const
+{
+ return wxDateTime(*this).Subtract(diff);
+}
+
+inline wxDateTime& wxDateTime::operator-=(const wxDateSpan& diff)
+{
+ return Subtract(diff);
+}
+
+inline wxDateTime& wxDateTime::operator+=(const wxDateSpan& diff)
+{
+ return Add(diff);
+}
+
+// ----------------------------------------------------------------------------
+// wxDateTime and timezones
+// ----------------------------------------------------------------------------
+
+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,
+ wxLongLong seconds,
+ wxLongLong milliseconds)
+{
+ // 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;
+}
+
+// ----------------------------------------------------------------------------
+// wxTimeSpan accessors
// ----------------------------------------------------------------------------
-inline wxTimeSpan WXDLLEXPORT operator+(const wxTimeSpan& ts1,
- const wxTimeSpan& ts2)
+inline wxLongLong wxTimeSpan::GetSeconds() const
{
- return wxTimeSpan(ts1.GetValue() + ts2.GetValue());
+ return m_diff / 1000l;
}
-inline wxTimeSpan WXDLLEXPORT operator-(const wxTimeSpan& ts1,
- const wxTimeSpan& ts2)
+inline int wxTimeSpan::GetMinutes() const
{
- return wxTimeSpan(ts1.GetValue() - ts2.GetValue());
+ // 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 bool WXDLLEXPORT operator<(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline int wxTimeSpan::GetHours() const
{
- return t1.GetValue() < t2.GetValue();
+ return GetMinutes() / 60;
}
-inline bool WXDLLEXPORT operator<=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline int wxTimeSpan::GetDays() const
{
- return t1.GetValue() <= t2.GetValue();
+ return GetHours() / 24;
}
-inline bool WXDLLEXPORT operator>(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline int wxTimeSpan::GetWeeks() const
{
- return t1.GetValue() > t2.GetValue();
+ return GetDays() / 7;
}
-inline bool WXDLLEXPORT operator>=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+// ----------------------------------------------------------------------------
+// wxTimeSpan arithmetics
+// ----------------------------------------------------------------------------
+
+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)
{
- return t1.GetValue() >= t2.GetValue();
+ m_diff -= diff.GetValue();
+
+ return *this;
}
-inline bool WXDLLEXPORT operator==(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxTimeSpan& wxTimeSpan::Multiply(int n)
{
- return t1.GetValue() == t2.GetValue();
+ m_diff *= (long)n;
+
+ return *this;
}
-inline bool WXDLLEXPORT operator!=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxTimeSpan wxTimeSpan::Multiply(int n) const
{
- return t1.GetValue() != t2.GetValue();
+ return wxTimeSpan(m_diff * (long)n);
+}
+
+inline wxTimeSpan wxTimeSpan::Abs() const
+{
+ return wxTimeSpan(GetValue().Abs());
+}
+
+inline bool wxTimeSpan::IsEqualTo(const wxTimeSpan& ts) const
+{
+ return GetValue() == ts.GetValue();
+}
+
+inline bool wxTimeSpan::IsLongerThan(const wxTimeSpan& ts) const
+{
+ return GetValue().Abs() > ts.GetValue().Abs();
}
// ----------------------------------------------------------------------------
// wxDateSpan
// ----------------------------------------------------------------------------
-inline WXDLLEXPORT wxDateSpan operator+(const wxDateSpan& rt1,
- const wxDateSpan& rt2)
+inline wxDateSpan& wxDateSpan::operator+=(const wxDateSpan& other)
+{
+ m_years += other.m_years;
+ m_months += other.m_months;
+ m_weeks += other.m_weeks;
+ m_days += other.m_days;
+
+ 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
{
- return wxDateSpan(rt1.GetYears() + rt2.GetYears(),
- rt1.GetMonths() + rt2.GetMonths(),
- rt1.GetWeeks() + rt2.GetWeeks(),
- rt1.GetDays() + rt2.GetDays());
+ 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