// 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_TIME_H
-#define _WX_TIME_H
+#ifndef _WX_DATETIME_H
+#define _WX_DATETIME_H
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
#pragma interface "datetime.h"
#endif
+#include "wx/defs.h"
+
+#if wxUSE_DATETIME
+
#include <time.h>
+#include <limits.h> // for INT_MIN
#include "wx/longlong.h"
-class WXDLLEXPORT wxDateTime;
-class WXDLLEXPORT wxTimeSpan;
-class WXDLLEXPORT wxDateSpan;
-
+class WXDLLIMPEXP_BASE wxDateTime;
+class WXDLLIMPEXP_BASE wxTimeSpan;
+class WXDLLIMPEXP_BASE wxDateSpan;
+
+// a hack: 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. (VZ: why?)
+#if defined( __WXDEBUG__) && !defined(__MINGW32__) && !(defined(_MSC_VER) && wxUSE_ACCESSIBILITY)
+ #define wxDATETIME_DONT_INLINE
+
+ #undef inline
+ #define inline
+#else
+ // just in case
+ #undef wxDATETIME_DONT_INLINE
+#endif // Debug
+
+// 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
*/
/*
- 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_BASE wxDateTime;
+
+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 TimeZone
+ enum TZ
{
// the time in the current time zone
Local,
// Note that GMT12 and GMT_12 are not the same: there is a difference
// of exactly one day between them
- // Universal Coordinated Time
+ // some symbolic names for TZ
+
+ // Europe
+ WET = GMT0, // Western Europe Time
+ WEST = GMT1, // Western Europe Summer Time
+ CET = GMT1, // Central Europe Time
+ CEST = GMT2, // Central Europe Summer Time
+ EET = GMT2, // Eastern Europe Time
+ EEST = GMT3, // Eastern Europe Summer Time
+ MSK = GMT3, // Moscow Time
+ MSD = GMT4, // Moscow Summer Time
+
+ // US and Canada
+ AST = GMT_4, // Atlantic Standard Time
+ ADT = GMT_3, // Atlantic Daylight Time
+ EST = GMT_5, // Eastern Standard Time
+ EDT = GMT_4, // Eastern Daylight Saving Time
+ CST = GMT_6, // Central Standard Time
+ CDT = GMT_5, // Central Daylight Saving Time
+ MST = GMT_7, // Mountain Standard Time
+ MDT = GMT_6, // Mountain Daylight Saving Time
+ PST = GMT_8, // Pacific Standard Time
+ PDT = GMT_7, // Pacific Daylight Saving Time
+ HST = GMT_10, // Hawaiian Standard Time
+ AKST = GMT_9, // Alaska Standard Time
+ AKDT = GMT_8, // Alaska Daylight Saving Time
+
+ // Australia
+
+ A_WST = GMT8, // Western Standard Time
+ A_CST = GMT12 + 1, // Central Standard Time (+9.5)
+ A_EST = GMT10, // Eastern Standard Time
+ A_ESST = GMT11, // Eastern Summer Time
+
+ // TODO add more symbolic timezone names here
+
+ // Universal Coordinated Time = the new and politically correct name
+ // for GMT
UTC = GMT0
-
- // TODO add symbolic names for TZ (EST, MET, ...)?
};
// the calendar systems we know about: notice that it's valid (for
{
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
};
// invalid value for the year
enum Year
{
- Inv_Year = INT_MIN
+ 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 WXDLLIMPEXP_BASE Tm
+ {
+ 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 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;
+
+ // get the week day
+ WeekDay GetWeekDay() // not const because wday may be changed
+ {
+ if ( wday == Inv_WeekDay )
+ ComputeWeekDay();
+
+ return (WeekDay)wday;
+ }
+
+ // add the given number of months to the date keeping it normalized
+ void AddMonths(int monDiff);
+
+ // add the given number of months to the date keeping it normalized
+ 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;
};
// static methods
// get the current country
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);
static Month GetCurrentMonth(Calendar cal = Gregorian);
// returns TRUE if the given year is a leap year in the given calendar
- static bool IsLeapYear(int year, Calendar cal = Gregorian);
+ 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);
- // returns the number of days in this year (356 or 355 typically :-)
+ // returns the number of days in this year (356 or 355 for Gregorian
+ // calendar usually :-)
static wxDateTime_t GetNumberOfDays(int year, Calendar cal = Gregorian);
// get the number of the days in the given month (default value for
int year = Inv_Year,
Calendar cal = Gregorian);
- // get the month name in the current locale
- static wxString GetMonthName(Month month);
+ // 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 weekday name in the current locale
- static wxString GetDayOfWeekName(WeekDay weekday);
+ // 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 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
// ------------------------------------------------------------------------
// default ctor does not initialize the object, use Set()!
- wxDateTime() { }
+ wxDateTime() { m_time = wxLongLong((long)ULONG_MAX, ULONG_MAX); }
// 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);
- // from broken down time/date
+#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 second = 0,
wxDateTime_t millisec = 0);
// from separate values for each component with explicit date
- inline wxDateTime(wxDateTime_t day,
- Month month = Inv_Month,
+ inline wxDateTime(wxDateTime_t day, // day of the 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,
// assignment operator from broken down time/date
wxDateTime& operator=(const struct tm& tm) { return Set(tm); }
+ // assignment operator from broken down time/date
+ wxDateTime& operator=(const Tm& tm) { return Set(tm); }
+
// 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
// 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,
- wxDateTime_t month = Inv_Month,
+ 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,
- wxDateTime_t month = Inv_Month,
+ Month month = Inv_Month,
int year = Inv_Year);
+ inline wxDateTime GetLastWeekDay(WeekDay weekday,
+ Month month = Inv_Month,
+ int year = Inv_Year);
// sets the date to the given day of the given week in the year,
// returns TRUE on success and FALSE if given date doesn't exist (e.g.
// numWeek is > 53)
- bool SetToTheWeek(wxDateTime_t numWeek, WeekDay weekday = Mon);
-
- // get the century (19 for 1999, 20 for 2000 and -5 for 492 BC)
- int GetCentury() const;
+ bool SetToTheWeek(wxDateTime_t numWeek,
+ WeekDay weekday = Mon,
+ WeekFlags flags = Monday_First);
+ inline wxDateTime GetWeek(wxDateTime_t numWeek,
+ WeekDay weekday = Mon,
+ WeekFlags flags = Monday_First) const;
+
+ // 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: 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())
+ //
+ // these functions try to handle DST internally, but there is no magical
+ // way to know all rules for it in all countries in the world, so if the
+ // program can handle it itself (or doesn't want to handle it at all for
+ // whatever reason), the DST handling can be disabled with noDST.
+ //
+ // Converting to the local time zone doesn't do anything.
+ // ------------------------------------------------------------------------
+
+ // transform to any given timezone
+ inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = FALSE) const;
+ wxDateTime& MakeTimezone(const TimeZone& tz, bool noDST = FALSE);
+
+ // transform to GMT/UTC
+ wxDateTime ToGMT(bool noDST = FALSE) const { return ToTimezone(GMT0, noDST); }
+ wxDateTime& MakeGMT(bool noDST = FALSE) { return MakeTimezone(GMT0, noDST); }
+
+ // 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;
+
// 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 (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 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 year (returns Inv_Year if date is invalid)
- int GetYear(TimeZone zone = Local) const;
+ int GetYear(const TimeZone& tz = Local) const
+ { return GetTm(tz).year; }
// get the month (Inv_Month if date is invalid)
- Month GetMonth(TimeZone zone = Local) const;
+ 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(TimeZone zone = Local) const;
+ 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 GetDayOfWeek(TimeZone zone = Local) const;
+ WeekDay GetWeekDay(const TimeZone& tz = Local) const
+ { return GetTm(tz).GetWeekDay(); }
// get the hour of the day
- wxDateTime_t GetHour(TimeZone zone = Local) const;
+ wxDateTime_t GetHour(const TimeZone& tz = Local) const
+ { return GetTm(tz).hour; }
// get the minute
- wxDateTime_t GetMinute(TimeZone zone = Local) const;
+ wxDateTime_t GetMinute(const TimeZone& tz = Local) const
+ { return GetTm(tz).min; }
// get the second
- wxDateTime_t GetSecond(TimeZone zone = Local) const;
+ wxDateTime_t GetSecond(const TimeZone& tz = Local) const
+ { return GetTm(tz).sec; }
// get milliseconds
- wxDateTime_t GetMillisecond(TimeZone zone = Local) const;
+ 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(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 GetWeekOfYear() const;
+ 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 = Current, 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 = Gregorian_Standard) const;
+ 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
+ inline bool IsEqualTo(const wxDateTime& datetime) const;
+
// returns TRUE if the date is strictly earlier than the given one
- bool IsEarlierThan(const wxDateTime& datetime) const;
+ inline bool IsEarlierThan(const wxDateTime& datetime) const;
// returns TRUE if the date is strictly later than the given one
- bool IsLaterThan(const wxDateTime& datetime) const;
+ inline bool IsLaterThan(const wxDateTime& datetime) const;
// returns TRUE if the date is strictly in the given range
- bool IsStrictlyBetween(const wxDateTime& t1, const wxDateTime& t2) const;
+ inline bool IsStrictlyBetween(const wxDateTime& t1,
+ const wxDateTime& t2) const;
+
// returns TRUE if the date is in the given range
- bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
+ inline bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
+
+ // 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;
- // date operations: for the non-const methods, the return value is this
- // object itself (see also functions below for operator versions)
+ // are these two objects equal up to given timespan?
+ inline bool IsEqualUpTo(const wxDateTime& dt, const wxTimeSpan& ts) const;
+
+ // 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)
- wxDateTime& Add(const wxTimeSpan& diff);
+ inline wxDateTime& Add(const wxTimeSpan& diff);
// add a time span (positive or negative)
- wxDateTime& operator+=(const wxTimeSpan& diff) { return Add(diff); }
+ inline wxDateTime& operator+=(const wxTimeSpan& diff);
- // 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);
+ // 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)
- wxDateTime& operator+=(const wxDateSpan& diff) { return Add(diff); }
+ inline wxDateTime& operator+=(const wxDateSpan& diff);
- // 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);
- // substract a date (may result in positive or negative time span)
- wxTimeSpan Substract(const wxDateTime& datetime) const;
- // substract a date (may result in positive or negative time span)
- wxTimeSpan operator-(const wxDateTime& datetime) const;
+ // return the difference between two dates
+ inline wxTimeSpan Subtract(const wxDateTime& dt) 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 wxChar *format = _T("%c"),
+ 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 char *format = "%c") const;
+ wxString Format(const wxChar *format = _T("%c"),
+ const TimeZone& tz = Local) const;
// preferred date representation for the current locale
- wxString FormatDate() const { return Format("%x"); }
+ wxString FormatDate() const { return Format(_T("%x")); }
// preferred time representation for the current locale
- wxString FormatTime() const { return Format("%X"); }
+ 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;
-private:
// a helper function to get the current time_t
- static inline time_t GetTimeNow() { return time((time_t *)NULL); }
+ static time_t GetTimeNow() { return time((time_t *)NULL); }
+ // another one to get the current time broken down
+ static struct tm *GetTmNow()
+ {
+ time_t t = GetTimeNow();
+ return localtime(&t);
+ }
+
+private:
// the current country - as it's the same for all program objects (unless
- // it runs on a _really_ big load balancing system), this is a static
- // member: see SetCountry() and GetCountry()
+ // it runs on a _really_ big cluster system :-), this is a static member:
+ // see SetCountry() and GetCountry()
static Country ms_country;
- // the internal representation of the time is the amount of milliseconds
- // elapsed since the origin which is set by convention to the UNIX/C epoch
- // value: the midnight of on January 1, 1970 (UTC)
- wxLongLong m_time;
-
// 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 int TIME_T_FACTOR;
+ static const long TIME_T_FACTOR;
+
+ // returns TRUE if we fall in range in which we can use standard ANSI C
+ // functions
+ inline bool IsInStdRange() const;
- // invalid wxDateTime object - returned by all functions which return
- // "wxDateTime &" on failure
- static wxDateTime ms_InvDateTime;
+ // the internal representation of the time is the amount of milliseconds
+ // elapsed since the origin which is set by convention to the UNIX/C epoch
+ // value: the midnight of January 1, 1970 (UTC)
+ wxLongLong m_time;
};
// ----------------------------------------------------------------------------
// 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 seconds
+ static wxTimeSpan Seconds(long sec) { return wxTimeSpan(0, 0, sec); }
+ static wxTimeSpan Second() { return Seconds(1); }
+
+ // return the timespan for the given number of minutes
+ 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(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)
- wxTimeSpan(int hours,
- int minutes = 0,
- int seconds = 0,
- int milliseconds = 0);
- // from separate values for each component with explicit date (none of
- // the parameters isn't restricted to any range)
- wxTimeSpan(int years,
- int months,
- int days,
- int hours = 0,
- 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,
+ long seconds = 0,
+ long 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); }
- // add two timespans together
- inline wxTimeSpan operator+(const wxTimeSpan& ts1, const wxTimeSpan& ts2);
- // substract another timespan
- inline wxTimeSpan& Substract(const wxTimeSpan& diff);
- // substract another timespan
- wxTimeSpan& operator-=(const wxTimeSpan& diff) { return Substract(diff); }
- // substract two timespans
- inline wxTimeSpan operator-(const wxTimeSpan& ts1, const wxTimeSpan& ts2);
+ // 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); }
+ // 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;
// return this timespan with inversed sign
- wxTimeSpan Negate() { return wxTimeSpan(-GetValue()); }
+ wxTimeSpan Negate() const { return wxTimeSpan(-GetValue()); }
// negate the value of the timespan
wxTimeSpan& Neg() { m_diff = -GetValue(); return *this; }
// negate the value of the timespan
// ------------------------------------------------------------------------
// is the timespan null?
- bool IsNull() const { return m_diff == 0; }
+ bool IsNull() const { return m_diff == 0l; }
// returns true if the timespan is null
bool operator!() const { return !IsNull(); }
// is the timespan positive?
- bool IsPositive() const { return m_diff > 0; }
+ bool IsPositive() const { return m_diff > 0l; }
// is the timespan negative?
- bool IsNegative() const { return m_diff < 0; }
+ bool IsNegative() const { return m_diff < 0l; }
// are two timespans equal?
inline bool IsEqualTo(const wxTimeSpan& ts) const;
// 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.
+ // 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
- int GetMilliseconds() const { return m_diff; }
+ wxLongLong GetMilliseconds() const { return m_diff; }
// conversion to text
// ------------------------------------------------------------------------
// 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 char *format = "%c") const;
- // preferred date representation for the current locale
- wxString FormatDate() const { return Format("%x"); }
- // preferred time representation for the current locale
- wxString FormatTime() const { return Format("%X"); }
+ wxString Format(const wxChar *format = _T("%H:%M:%S")) 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
// ------------------------------------------------------------------------
// this many years/months/weeks/days
- wxDateSpan(int years, int months, int weeks, int days);
+ wxDateSpan(int years = 0, int months = 0, int weeks = 0, int days = 0)
+ {
+ m_years = years;
+ m_months = months;
+ m_weeks = weeks;
+ m_days = days;
+ }
+
+ // 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
// ------------------------------------------------------------------------
// set number of years
- wxDateSpan& SetYears(int n) { m_years = n; return this; }
+ wxDateSpan& SetYears(int n) { m_years = n; return *this; }
// set number of months
- wxDateSpan& SetMonths(int n) { m_months = n; return this; }
+ wxDateSpan& SetMonths(int n) { m_months = n; return *this; }
// set number of weeks
- wxDateSpan& SetWeeks(int n) { m_weeks = n; return this; }
+ wxDateSpan& SetWeeks(int n) { m_weeks = n; return *this; }
// set number of days
- wxDateSpan& SetDays(int n) { m_days = n; return this; }
+ wxDateSpan& SetDays(int n) { m_days = n; return *this; }
// get number of years
int GetYears() const { return m_years; }
// 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);
- // 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);
// return a copy of this time span with changed sign
// 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& operator*=(int factor);
+ inline wxDateSpan& Multiply(int factor);
+ // multiply all components by a (signed) number
+ inline wxDateSpan& operator*=(int factor) { return Multiply(factor); }
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;
-
-// ============================================================================
-// binary operators
-// ============================================================================
-
// ----------------------------------------------------------------------------
-// wxDateTime operators
+// wxDateTimeArray: array of dates.
// ----------------------------------------------------------------------------
-inline bool WXDLLEXPORT operator<(const wxDateTime &t1, const wxDateTime &t2)
-{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
-
- return t1.GetValue() < t2.GetValue()
-}
+#include "wx/dynarray.h"
-inline bool WXDLLEXPORT operator<=(const wxDateTime &t1, const wxDateTime &t2)
-{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
-
- return t1.GetValue() <= t2.GetValue()
-}
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDateTime, wxDateTimeArray, WXDLLIMPEXP_BASE);
-inline bool WXDLLEXPORT operator>(const wxDateTime &t1, const wxDateTime &t2)
-{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+// ----------------------------------------------------------------------------
+// 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.
+// ----------------------------------------------------------------------------
- return t1.GetValue() > t2.GetValue()
-}
+class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority;
+WX_DEFINE_USER_EXPORTED_ARRAY(wxDateTimeHolidayAuthority *,
+ wxHolidayAuthoritiesArray,
+ class WXDLLIMPEXP_BASE);
-inline bool WXDLLEXPORT operator>=(const wxDateTime &t1, const wxDateTime &t2)
+class wxDateTimeHolidaysModule;
+class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+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;
- return t1.GetValue() >= t2.GetValue()
-}
+private:
+ // all holiday authorities
+ static wxHolidayAuthoritiesArray ms_authorities;
+};
-inline bool WXDLLEXPORT operator==(const wxDateTime &t1, const wxDateTime &t2)
+// the holidays for this class are all Saturdays and Sundays
+class WXDLLIMPEXP_BASE wxDateTimeWorkDays : public wxDateTimeHolidayAuthority
{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+protected:
+ virtual bool DoIsHoliday(const wxDateTime& dt) const;
+ virtual size_t DoGetHolidaysInRange(const wxDateTime& dtStart,
+ const wxDateTime& dtEnd,
+ wxDateTimeArray& holidays) const;
+};
- return t1.GetValue() == t2.GetValue()
-}
+// ============================================================================
+// inline functions implementation
+// ============================================================================
-inline bool WXDLLEXPORT operator!=(const wxDateTime &t1, const wxDateTime &t2)
-{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+// 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.
- return t1.GetValue() != t2.GetValue()
-}
+#if !defined(wxDATETIME_DONT_INLINE) || defined(wxDEFINE_TIME_CONSTANTS)
+ #define INCLUDED_FROM_WX_DATETIME_H
+ #include "wx/datetime.inl"
+ #undef INCLUDED_FROM_WX_DATETIME_H
+#endif
-inline wxTimeSpan WXDLLEXPORT operator-(const wxDateTime &t1,
- const wxDateTime &t2)
-{
- wxASSERT_MSG( t1.IsValid() && t2.IsValid(), "invalid wxDateTime" );
+// if we defined it to be empty above, restore it now
+#ifdef wxDATETIME_DONT_INLINE
+ #undef inline
+#endif
- return wxTimeSpan(t1.GetValue() - t2.GetValue());
-}
+// ============================================================================
+// binary operators
+// ============================================================================
// ----------------------------------------------------------------------------
-// wxTimeSpan operators
+// wxDateTime operators
// ----------------------------------------------------------------------------
-inline bool WXDLLEXPORT operator<(const wxTimeSpan &t1, const wxTimeSpan &t2)
-{
- return t1.GetValue() < t2.GetValue()
-}
+// arithmetics
+// -----------
+
+// no need to check for validity - the member functions we call will do it
-inline bool WXDLLEXPORT operator<=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime WXDLLIMPEXP_BASE operator+(const wxDateTime& dt,
+ const wxTimeSpan& ts)
{
- return t1.GetValue() <= t2.GetValue()
+ return dt.Add(ts);
}
-inline bool WXDLLEXPORT operator>(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime WXDLLIMPEXP_BASE operator-(const wxDateTime& dt,
+ const wxTimeSpan& ts)
{
- return t1.GetValue() > t2.GetValue()
+ return dt.Subtract(ts);
}
-inline bool WXDLLEXPORT operator>=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime WXDLLIMPEXP_BASE operator+(const wxDateTime& dt,
+ const wxDateSpan& ds)
{
- return t1.GetValue() >= t2.GetValue()
+ return dt.Add(ds);
}
-inline bool WXDLLEXPORT operator==(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxDateTime WXDLLIMPEXP_BASE operator-(const wxDateTime& dt,
+ const wxDateSpan& ds)
{
- return t1.GetValue() == t2.GetValue()
+ return dt.Subtract(ds);
}
-inline bool WXDLLEXPORT operator!=(const wxTimeSpan &t1, const wxTimeSpan &t2)
+inline wxTimeSpan WXDLLIMPEXP_BASE operator-(const wxDateTime& dt1,
+ const wxDateTime& dt2)
{
- return t1.GetValue() != t2.GetValue();
+ return dt1.Subtract(dt2);
}
-// ----------------------------------------------------------------------------
-// wxDateSpan
-// ----------------------------------------------------------------------------
+// comparison
+// ----------
-inline WXDLLEXPORT wxDateSpan operator+(const wxDateSpan& rt1,
- const wxDateSpan& rt2)
+inline bool WXDLLIMPEXP_BASE operator<(const wxDateTime& t1, const wxDateTime& t2)
{
- return wxDateSpan(rt1.m_years + rt2.m_years,
- rt1.m_months + rt2.m_months,
- rt1.m_weeks + rt2.m_weeks,
- rt1.m_days + rt2.m_days);
-}
+ wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
-// ============================================================================
-// inline functions implementation
-// ============================================================================
+ return t1.GetValue() < t2.GetValue();
+}
-// ----------------------------------------------------------------------------
-// wxDateTime
-// ----------------------------------------------------------------------------
+inline bool WXDLLIMPEXP_BASE operator<=(const wxDateTime& t1, const wxDateTime& t2)
+{
+ wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
-const int wxDateTime::TIME_T_FACTOR = 1000;
+ return t1.GetValue() <= t2.GetValue();
+}
-wxDateTime& Set(time_t timet)
+inline bool WXDLLIMPEXP_BASE operator>(const wxDateTime& t1, const wxDateTime& t2)
{
- m_time = timet * wxDateTime::TIME_T_FACTOR;
+ wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
- return *this;
+ return t1.GetValue() > t2.GetValue();
}
-wxDateTime& SetToCurrent()
+inline bool WXDLLIMPEXP_BASE operator>=(const wxDateTime& t1, const wxDateTime& t2)
{
- return Set(GetTimeNow());
+ wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+
+ return t1.GetValue() >= t2.GetValue();
}
-wxDateTime::wxDateTime(time_t timet)
+inline bool WXDLLIMPEXP_BASE operator==(const wxDateTime& t1, const wxDateTime& t2)
{
- Set(timet);
+ wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+
+ return t1.GetValue() == t2.GetValue();
}
-wxDateTime::wxDateTime(const struct tm& tm)
+inline bool WXDLLIMPEXP_BASE operator!=(const wxDateTime& t1, const wxDateTime& t2)
{
- Set(tm);
+ wxASSERT_MSG( t1.IsValid() && t2.IsValid(), _T("invalid wxDateTime") );
+
+ return t1.GetValue() != t2.GetValue();
}
-wxDateTime::wxDateTime(wxDateTime_t hour,
- wxDateTime_t minute,
- wxDateTime_t second,
- wxDateTime_t millisec)
+// ----------------------------------------------------------------------------
+// wxTimeSpan operators
+// ----------------------------------------------------------------------------
+
+// arithmetics
+// -----------
+
+inline wxTimeSpan WXDLLIMPEXP_BASE operator+(const wxTimeSpan& ts1,
+ const wxTimeSpan& ts2)
{
- Set(hour, minute, second, millisec);
+ return wxTimeSpan(ts1.GetValue() + ts2.GetValue());
}
-wxDateTime::wxDateTime(wxDateTime_t day,
- Month month,
- int year,
- wxDateTime_t hour,
- wxDateTime_t minute,
- wxDateTime_t second,
- wxDateTime_t millisec)
+inline wxTimeSpan WXDLLIMPEXP_BASE operator-(const wxTimeSpan& ts1,
+ const wxTimeSpan& ts2)
{
- Set(day, month, year, hour, minute, second, millisec);
+ return wxTimeSpan(ts1.GetValue() - ts2.GetValue());
}
-wxLongLong wxDateTime::GetValue() const
+inline wxTimeSpan WXDLLIMPEXP_BASE operator*(const wxTimeSpan& ts, int n)
{
- wxASSERT_MSG( IsValid(), "invalid wxDateTime");
+ return wxTimeSpan(ts).Multiply(n);
+}
- return m_time;
+inline wxTimeSpan WXDLLIMPEXP_BASE operator*(int n, const wxTimeSpan& ts)
+{
+ return wxTimeSpan(ts).Multiply(n);
}
-bool wxDateTime::SetToLastWeekDay(WeekDay weekday,
- wxDateTime_t month,
- int year)
+// comparison
+// ----------
+
+inline bool WXDLLIMPEXP_BASE operator<(const wxTimeSpan &t1, const wxTimeSpan &t2)
{
- SetToWeekDay(weekday, -1, month, year);
+ return t1.GetValue() < t2.GetValue();
}
-wxDateTime& wxDateTime::Substract(const wxTimeSpan& diff)
+inline bool WXDLLIMPEXP_BASE operator<=(const wxTimeSpan &t1, const wxTimeSpan &t2)
{
- return Add(diff.Negate());
+ return t1.GetValue() <= t2.GetValue();
}
-wxDateTime& wxDateTime::operator-=(const wxTimeSpan& diff)
+inline bool WXDLLIMPEXP_BASE operator>(const wxTimeSpan &t1, const wxTimeSpan &t2)
{
- return Add(diff.Negate());
+ return t1.GetValue() > t2.GetValue();
}
-wxDateTime& wxDateTime::Substract(const wxDateSpan& diff)
+inline bool WXDLLIMPEXP_BASE operator>=(const wxTimeSpan &t1, const wxTimeSpan &t2)
{
- return Add(diff.Negate());
+ return t1.GetValue() >= t2.GetValue();
}
-wxDateTime& wxDateTime::operator-=(const wxDateSpan& diff)
+inline bool WXDLLIMPEXP_BASE operator==(const wxTimeSpan &t1, const wxTimeSpan &t2)
{
- return Add(diff.Negate());
+ return t1.GetValue() == t2.GetValue();
}
-wxTimeSpan wxDateTime::operator-(const wxDateTime& datetime) const
+inline bool WXDLLIMPEXP_BASE operator!=(const wxTimeSpan &t1, const wxTimeSpan &t2)
{
- return Substract(datetime);
+ return t1.GetValue() != t2.GetValue();
}
// ----------------------------------------------------------------------------
-// wxTimeSpan
+// wxDateSpan
// ----------------------------------------------------------------------------
-wxTimeSpan& wxTimeSpan::Add(const wxTimeSpan& diff)
-{
- m_diff += diff.GetValue();
+// comparison
+// ----------
- return *this;
-}
-
-wxTimeSpan& wxTimeSpan::Substract(const wxTimeSpan& diff)
+// ds1 == d2 if and only if for every wxDateTime t t + ds1 == t + ds2
+inline WXDLLIMPEXP_BASE bool operator==(const wxDateSpan& ds1,
+ const wxDateSpan& ds2)
{
- m_diff -= diff.GetValue();
-
- return *this;
+ return ds1.GetYears() == ds2.GetYears() &&
+ ds1.GetMonths() == ds2.GetMonths() &&
+ ds1.GetTotalDays() == ds2.GetTotalDays();
}
-wxTimeSpan& wxTimeSpan::Multiply(int n)
+inline WXDLLIMPEXP_BASE bool operator!=(const wxDateSpan& ds1,
+ const wxDateSpan& ds2)
{
- m_diff *= n;
-
- return *this;
+ return !(ds1 == ds2);
}
-wxTimeSpan wxTimeSpan::operator*(int n) const
-{
- wxTimeSpan result(*this);
- result.Multiply(n);
+// arithmetics
+// -----------
- return result;
+inline WXDLLIMPEXP_BASE wxDateSpan operator+(const wxDateSpan& ds1,
+ const wxDateSpan& ds2)
+{
+ return wxDateSpan(ds1.GetYears() + ds2.GetYears(),
+ ds1.GetMonths() + ds2.GetMonths(),
+ ds1.GetWeeks() + ds2.GetWeeks(),
+ ds1.GetDays() + ds2.GetDays());
}
-wxTimeSpan wxTimeSpan::Abs() const
+inline WXDLLIMPEXP_BASE wxDateSpan operator-(const wxDateSpan& ds1,
+ const wxDateSpan& ds2)
{
- return wxTimeSpan(GetValue().Abs());
+ return wxDateSpan(ds1.GetYears() - ds2.GetYears(),
+ ds1.GetMonths() - ds2.GetMonths(),
+ ds1.GetWeeks() - ds2.GetWeeks(),
+ ds1.GetDays() - ds2.GetDays());
}
-bool wxTimeSpan::IsEqualTo(const wxTimeSpan& ts) const
+inline WXDLLIMPEXP_BASE wxDateSpan operator*(const wxDateSpan& ds, int n)
{
- return GetValue() == ts.GetValue();
+ return wxDateSpan(ds).Multiply(n);
}
-bool wxTimeSpan::IsLongerThan(const wxTimeSpan& ts) const
+inline WXDLLIMPEXP_BASE wxDateSpan operator*(int n, const wxDateSpan& ds)
{
- return Abs() > ts.Abs();
+ return wxDateSpan(ds).Multiply(n);
}
+// ============================================================================
+// other helper functions
+// ============================================================================
+
// ----------------------------------------------------------------------------
-// wxDateSpan
+// 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) )
// ----------------------------------------------------------------------------
-wxDateSpan&
-wxDateSpan::operator+=(const wxDateSpan& other)
+inline WXDLLIMPEXP_BASE void wxNextMonth(wxDateTime::Month& m)
{
- m_years += other.m_years;
- m_months += other.m_months;
- m_weeks += other.m_weeks;
- m_days += other.m_days;
+ wxASSERT_MSG( m < wxDateTime::Inv_Month, _T("invalid month") );
- return *this;
+ // no wrapping or the for loop above would never end!
+ m = (wxDateTime::Month)(m + 1);
}
-wxDateSpan& wxDateSpan::operator*=(int factor)
+inline WXDLLIMPEXP_BASE void wxPrevMonth(wxDateTime::Month& m)
{
- m_years *= m_years;
- m_months *= m_months;
- m_weeks *= m_weeks;
- m_days *= m_days;
+ wxASSERT_MSG( m < wxDateTime::Inv_Month, _T("invalid month") );
- return *this;
+ m = m == wxDateTime::Jan ? wxDateTime::Inv_Month
+ : (wxDateTime::Month)(m - 1);
}
-wxDateSpan Negate() const
+inline WXDLLIMPEXP_BASE void wxNextWDay(wxDateTime::WeekDay& wd)
{
- return wxDateSpan(-m_years, -m_months, -m_weeks, -m_days);
+ wxASSERT_MSG( wd < wxDateTime::Inv_WeekDay, _T("invalid week day") );
+
+ // no wrapping or the for loop above would never end!
+ wd = (wxDateTime::WeekDay)(wd + 1);
}
-wxDateSpan& Neg()
+inline WXDLLIMPEXP_BASE void wxPrevWDay(wxDateTime::WeekDay& wd)
{
- m_years = -m_years;
- m_months = -m_months;
- m_weeks = -m_weeks;
- m_days = -m_days;
+ wxASSERT_MSG( wd < wxDateTime::Inv_WeekDay, _T("invalid week day") );
- return *this;
+ wd = wd == wxDateTime::Sun ? wxDateTime::Inv_WeekDay
+ : (wxDateTime::WeekDay)(wd - 1);
}
-#endif // _WX_TIME_H
+#endif // wxUSE_DATETIME
+
+#endif // _WX_DATETIME_H
projects / wxWidgets.git / blobdiff