1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: declarations of time/date related classes (wxDateTime,
5 // Author: Vadim Zeitlin
9 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 #ifndef _WX_DATETIME_H
14 #define _WX_DATETIME_H
21 #include "wx/msw/wince/time.h"
22 #elif !defined(__WXPALMOS5__)
26 #include <limits.h> // for INT_MIN
28 #include "wx/longlong.h"
29 #include "wx/anystr.h"
31 class WXDLLIMPEXP_FWD_BASE wxDateTime
;
32 class WXDLLIMPEXP_FWD_BASE wxTimeSpan
;
33 class WXDLLIMPEXP_FWD_BASE wxDateSpan
;
38 #include "wx/dynarray.h"
40 // not all c-runtimes are based on 1/1/1970 being (time_t) 0
41 // set this to the corresponding value in seconds 1/1/1970 has on your
44 #define WX_TIME_BASE_OFFSET 0
49 * + 1. Time zones with minutes (make TimeZone a class)
50 * ? 2. getdate() function like under Solaris
51 * + 3. text conversion for wxDateSpan
52 * + 4. pluggable modules for the workdays calculations
53 * 5. wxDateTimeHolidayAuthority for Easter and other christian feasts
56 /* Two wrapper functions for thread safety */
57 #ifdef HAVE_LOCALTIME_R
58 #define wxLocaltime_r localtime_r
60 WXDLLIMPEXP_BASE
struct tm
*wxLocaltime_r(const time_t*, struct tm
*);
61 #if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
62 // On Windows, localtime _is_ threadsafe!
63 #warning using pseudo thread-safe wrapper for localtime to emulate localtime_r
68 #define wxGmtime_r gmtime_r
70 WXDLLIMPEXP_BASE
struct tm
*wxGmtime_r(const time_t*, struct tm
*);
71 #if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
72 // On Windows, gmtime _is_ threadsafe!
73 #warning using pseudo thread-safe wrapper for gmtime to emulate gmtime_r
78 The three (main) classes declared in this header represent:
80 1. An absolute moment in the time (wxDateTime)
81 2. A difference between two moments in the time, positive or negative
83 3. A logical difference between two dates expressed in
84 years/months/weeks/days (wxDateSpan)
86 The following arithmetic operations are permitted (all others are not):
91 wxDateTime + wxTimeSpan = wxDateTime
92 wxDateTime + wxDateSpan = wxDateTime
93 wxTimeSpan + wxTimeSpan = wxTimeSpan
94 wxDateSpan + wxDateSpan = wxDateSpan
98 wxDateTime - wxDateTime = wxTimeSpan
99 wxDateTime - wxTimeSpan = wxDateTime
100 wxDateTime - wxDateSpan = wxDateTime
101 wxTimeSpan - wxTimeSpan = wxTimeSpan
102 wxDateSpan - wxDateSpan = wxDateSpan
106 wxTimeSpan * number = wxTimeSpan
107 number * wxTimeSpan = wxTimeSpan
108 wxDateSpan * number = wxDateSpan
109 number * wxDateSpan = wxDateSpan
113 -wxTimeSpan = wxTimeSpan
114 -wxDateSpan = wxDateSpan
116 For each binary operation OP (+, -, *) we have the following operatorOP=() as
117 a method and the method with a symbolic name OPER (Add, Subtract, Multiply)
118 as a synonym for it and another const method with the same name which returns
119 the changed copy of the object and operatorOP() as a global function which is
120 implemented in terms of the const version of OPEN. For the unary - we have
121 operator-() as a method, Neg() as synonym for it and Negate() which returns
122 the copy of the object with the changed sign.
125 // an invalid/default date time object which may be used as the default
126 // argument for arguments of type wxDateTime; it is also returned by all
127 // functions returning wxDateTime on failure (this is why it is also called
128 // wxInvalidDateTime)
129 class WXDLLIMPEXP_FWD_BASE wxDateTime
;
131 extern WXDLLIMPEXP_DATA_BASE(const char *) wxDefaultDateTimeFormat
;
132 extern WXDLLIMPEXP_DATA_BASE(const char *) wxDefaultTimeSpanFormat
;
133 extern WXDLLIMPEXP_DATA_BASE(const wxDateTime
) wxDefaultDateTime
;
135 #define wxInvalidDateTime wxDefaultDateTime
138 // ----------------------------------------------------------------------------
139 // conditional compilation
140 // ----------------------------------------------------------------------------
142 #if defined(HAVE_STRPTIME) && defined(__GLIBC__) && \
143 ((__GLIBC__ == 2) && (__GLIBC_MINOR__ == 0))
144 // glibc 2.0.7 strptime() is broken - the following snippet causes it to
145 // crash (instead of just failing):
147 // strncpy(buf, "Tue Dec 21 20:25:40 1999", 128);
148 // strptime(buf, "%x", &tm);
152 #endif // broken strptime()
154 #if defined(HAVE_STRPTIME) && defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
155 // configure detects strptime as linkable because it's in the OS X
156 // System library but MSL headers don't declare it.
158 // char *strptime(const char *, const char *, struct tm *);
159 // However, we DON'T want to just provide it here because we would
160 // crash and/or overwrite data when strptime from OS X tries
161 // to fill in MW's struct tm which is two fields shorter (no TZ stuff)
162 // So for now let's just say we don't have strptime
166 // everyone has strftime except Win CE unless VC8 is used
167 #if !defined(__WXWINCE__) || defined(__VISUALC8__)
168 #define HAVE_STRFTIME
171 // ----------------------------------------------------------------------------
172 // wxDateTime represents an absolute moment in the time
173 // ----------------------------------------------------------------------------
175 class WXDLLIMPEXP_BASE wxDateTime
179 // ------------------------------------------------------------------------
181 // a small unsigned integer type for storing things like minutes,
182 // seconds &c. It should be at least short (i.e. not char) to contain
183 // the number of milliseconds - it may also be 'int' because there is
184 // no size penalty associated with it in our code, we don't store any
185 // data in this format
186 typedef unsigned short wxDateTime_t
;
189 // ------------------------------------------------------------------------
194 // the time in the current time zone
197 // zones from GMT (= Greenwhich Mean Time): they're guaranteed to be
198 // consequent numbers, so writing something like `GMT0 + offset' is
199 // safe if abs(offset) <= 12
201 // underscore stands for minus
202 GMT_12
, GMT_11
, GMT_10
, GMT_9
, GMT_8
, GMT_7
,
203 GMT_6
, GMT_5
, GMT_4
, GMT_3
, GMT_2
, GMT_1
,
205 GMT1
, GMT2
, GMT3
, GMT4
, GMT5
, GMT6
,
206 GMT7
, GMT8
, GMT9
, GMT10
, GMT11
, GMT12
, GMT13
,
207 // Note that GMT12 and GMT_12 are not the same: there is a difference
208 // of exactly one day between them
210 // some symbolic names for TZ
213 WET
= GMT0
, // Western Europe Time
214 WEST
= GMT1
, // Western Europe Summer Time
215 CET
= GMT1
, // Central Europe Time
216 CEST
= GMT2
, // Central Europe Summer Time
217 EET
= GMT2
, // Eastern Europe Time
218 EEST
= GMT3
, // Eastern Europe Summer Time
219 MSK
= GMT3
, // Moscow Time
220 MSD
= GMT4
, // Moscow Summer Time
223 AST
= GMT_4
, // Atlantic Standard Time
224 ADT
= GMT_3
, // Atlantic Daylight Time
225 EST
= GMT_5
, // Eastern Standard Time
226 EDT
= GMT_4
, // Eastern Daylight Saving Time
227 CST
= GMT_6
, // Central Standard Time
228 CDT
= GMT_5
, // Central Daylight Saving Time
229 MST
= GMT_7
, // Mountain Standard Time
230 MDT
= GMT_6
, // Mountain Daylight Saving Time
231 PST
= GMT_8
, // Pacific Standard Time
232 PDT
= GMT_7
, // Pacific Daylight Saving Time
233 HST
= GMT_10
, // Hawaiian Standard Time
234 AKST
= GMT_9
, // Alaska Standard Time
235 AKDT
= GMT_8
, // Alaska Daylight Saving Time
239 A_WST
= GMT8
, // Western Standard Time
240 A_CST
= GMT13
+ 1, // Central Standard Time (+9.5)
241 A_EST
= GMT10
, // Eastern Standard Time
242 A_ESST
= GMT11
, // Eastern Summer Time
245 NZST
= GMT12
, // Standard Time
246 NZDT
= GMT13
, // Daylight Saving Time
248 // TODO add more symbolic timezone names here
250 // Universal Coordinated Time = the new and politically correct name
255 // the calendar systems we know about: notice that it's valid (for
256 // this classes purpose anyhow) to work with any of these calendars
257 // even with the dates before the historical appearance of the
261 Gregorian
, // current calendar
262 Julian
// calendar in use since -45 until the 1582 (or later)
264 // TODO Hebrew, Chinese, Maya, ... (just kidding) (or then may be not?)
267 // these values only are used to identify the different dates of
268 // adoption of the Gregorian calendar (see IsGregorian())
270 // All data and comments taken verbatim from "The Calendar FAQ (v 2.0)"
271 // by Claus T�ndering, http://www.pip.dknet.dk/~c-t/calendar.html
272 // except for the comments "we take".
274 // Symbol "->" should be read as "was followed by" in the comments
276 enum GregorianAdoption
278 Gr_Unknown
, // no data for this country or it's too uncertain to use
279 Gr_Standard
, // on the day 0 of Gregorian calendar: 15 Oct 1582
281 Gr_Alaska
, // Oct 1867 when Alaska became part of the USA
282 Gr_Albania
, // Dec 1912
284 Gr_Austria
= Gr_Unknown
, // Different regions on different dates
285 Gr_Austria_Brixen
, // 5 Oct 1583 -> 16 Oct 1583
286 Gr_Austria_Salzburg
= Gr_Austria_Brixen
,
287 Gr_Austria_Tyrol
= Gr_Austria_Brixen
,
288 Gr_Austria_Carinthia
, // 14 Dec 1583 -> 25 Dec 1583
289 Gr_Austria_Styria
= Gr_Austria_Carinthia
,
291 Gr_Belgium
, // Then part of the Netherlands
293 Gr_Bulgaria
= Gr_Unknown
, // Unknown precisely (from 1915 to 1920)
294 Gr_Bulgaria_1
, // 18 Mar 1916 -> 1 Apr 1916
295 Gr_Bulgaria_2
, // 31 Mar 1916 -> 14 Apr 1916
296 Gr_Bulgaria_3
, // 3 Sep 1920 -> 17 Sep 1920
298 Gr_Canada
= Gr_Unknown
, // Different regions followed the changes in
299 // Great Britain or France
301 Gr_China
= Gr_Unknown
, // Different authorities say:
302 Gr_China_1
, // 18 Dec 1911 -> 1 Jan 1912
303 Gr_China_2
, // 18 Dec 1928 -> 1 Jan 1929
305 Gr_Czechoslovakia
, // (Bohemia and Moravia) 6 Jan 1584 -> 17 Jan 1584
306 Gr_Denmark
, // (including Norway) 18 Feb 1700 -> 1 Mar 1700
309 Gr_Finland
, // Then part of Sweden
311 Gr_France
, // 9 Dec 1582 -> 20 Dec 1582
312 Gr_France_Alsace
, // 4 Feb 1682 -> 16 Feb 1682
313 Gr_France_Lorraine
, // 16 Feb 1760 -> 28 Feb 1760
314 Gr_France_Strasbourg
, // February 1682
316 Gr_Germany
= Gr_Unknown
, // Different states on different dates:
317 Gr_Germany_Catholic
, // 1583-1585 (we take 1584)
318 Gr_Germany_Prussia
, // 22 Aug 1610 -> 2 Sep 1610
319 Gr_Germany_Protestant
, // 18 Feb 1700 -> 1 Mar 1700
321 Gr_GreatBritain
, // 2 Sep 1752 -> 14 Sep 1752 (use 'cal(1)')
323 Gr_Greece
, // 9 Mar 1924 -> 23 Mar 1924
324 Gr_Hungary
, // 21 Oct 1587 -> 1 Nov 1587
325 Gr_Ireland
= Gr_GreatBritain
,
326 Gr_Italy
= Gr_Standard
,
328 Gr_Japan
= Gr_Unknown
, // Different authorities say:
329 Gr_Japan_1
, // 19 Dec 1872 -> 1 Jan 1873
330 Gr_Japan_2
, // 19 Dec 1892 -> 1 Jan 1893
331 Gr_Japan_3
, // 18 Dec 1918 -> 1 Jan 1919
333 Gr_Latvia
, // 1915-1918 (we take 1915)
334 Gr_Lithuania
, // 1915
335 Gr_Luxemburg
, // 14 Dec 1582 -> 25 Dec 1582
336 Gr_Netherlands
= Gr_Belgium
, // (including Belgium) 1 Jan 1583
338 // this is too weird to take into account: the Gregorian calendar was
339 // introduced twice in Groningen, first time 28 Feb 1583 was followed
340 // by 11 Mar 1583, then it has gone back to Julian in the summer of
341 // 1584 and then 13 Dec 1700 -> 12 Jan 1701 - which is
342 // the date we take here
343 Gr_Netherlands_Groningen
, // 13 Dec 1700 -> 12 Jan 1701
344 Gr_Netherlands_Gelderland
, // 30 Jun 1700 -> 12 Jul 1700
345 Gr_Netherlands_Utrecht
, // (and Overijssel) 30 Nov 1700->12 Dec 1700
346 Gr_Netherlands_Friesland
, // (and Drenthe) 31 Dec 1700 -> 12 Jan 1701
348 Gr_Norway
= Gr_Denmark
, // Then part of Denmark
349 Gr_Poland
= Gr_Standard
,
350 Gr_Portugal
= Gr_Standard
,
351 Gr_Romania
, // 31 Mar 1919 -> 14 Apr 1919
352 Gr_Russia
, // 31 Jan 1918 -> 14 Feb 1918
353 Gr_Scotland
= Gr_GreatBritain
,
354 Gr_Spain
= Gr_Standard
,
356 // Sweden has a curious history. Sweden decided to make a gradual
357 // change from the Julian to the Gregorian calendar. By dropping every
358 // leap year from 1700 through 1740 the eleven superfluous days would
359 // be omitted and from 1 Mar 1740 they would be in sync with the
360 // Gregorian calendar. (But in the meantime they would be in sync with
363 // So 1700 (which should have been a leap year in the Julian calendar)
364 // was not a leap year in Sweden. However, by mistake 1704 and 1708
365 // became leap years. This left Sweden out of synchronisation with
366 // both the Julian and the Gregorian world, so they decided to go back
367 // to the Julian calendar. In order to do this, they inserted an extra
368 // day in 1712, making that year a double leap year! So in 1712,
369 // February had 30 days in Sweden.
371 // Later, in 1753, Sweden changed to the Gregorian calendar by
372 // dropping 11 days like everyone else.
373 Gr_Sweden
= Gr_Finland
, // 17 Feb 1753 -> 1 Mar 1753
375 Gr_Switzerland
= Gr_Unknown
,// Different cantons used different dates
376 Gr_Switzerland_Catholic
, // 1583, 1584 or 1597 (we take 1584)
377 Gr_Switzerland_Protestant
, // 31 Dec 1700 -> 12 Jan 1701
379 Gr_Turkey
, // 1 Jan 1927
380 Gr_USA
= Gr_GreatBritain
,
381 Gr_Wales
= Gr_GreatBritain
,
382 Gr_Yugoslavia
// 1919
385 // the country parameter is used so far for calculating the start and
386 // the end of DST period and for deciding whether the date is a work
389 // TODO move this to intl.h
391 // Required for WinCE
398 Country_Unknown
, // no special information for this country
399 Country_Default
, // set the default country with SetCountry() method
400 // or use the default country with any other
402 // TODO add more countries (for this we must know about DST and/or
403 // holidays for this country)
405 // Western European countries: we assume that they all follow the same
406 // DST rules (true or false?)
407 Country_WesternEurope_Start
,
408 Country_EEC
= Country_WesternEurope_Start
,
412 Country_WesternEurope_End
= UK
,
417 // symbolic names for the months
420 Jan
, Feb
, Mar
, Apr
, May
, Jun
, Jul
, Aug
, Sep
, Oct
, Nov
, Dec
, Inv_Month
423 // symbolic names for the weekdays
426 Sun
, Mon
, Tue
, Wed
, Thu
, Fri
, Sat
, Inv_WeekDay
429 // invalid value for the year
432 Inv_Year
= SHRT_MIN
// should hold in wxDateTime_t
435 // flags for GetWeekDayName and GetMonthName
438 Name_Full
= 0x01, // return full name
439 Name_Abbr
= 0x02 // return abbreviated name
442 // flags for GetWeekOfYear and GetWeekOfMonth
445 Default_First
, // Sunday_First for US, Monday_First for the rest
446 Monday_First
, // week starts with a Monday
447 Sunday_First
// week starts with a Sunday
451 // ------------------------------------------------------------------------
453 // a class representing a time zone: basicly, this is just an offset
454 // (in seconds) from GMT
455 class WXDLLIMPEXP_BASE TimeZone
460 // create time zone object with the given offset
461 TimeZone(long offset
= 0) { m_offset
= offset
; }
463 static TimeZone
Make(long offset
)
466 tz
.m_offset
= offset
;
470 long GetOffset() const { return m_offset
; }
473 // offset for this timezone from GMT in seconds
477 // standard struct tm is limited to the years from 1900 (because
478 // tm_year field is the offset from 1900), so we use our own struct
479 // instead to represent broken down time
481 // NB: this struct should always be kept normalized (i.e. mon should
482 // be < 12, 1 <= day <= 31 &c), so use AddMonths(), AddDays()
483 // instead of modifying the member fields directly!
484 struct WXDLLIMPEXP_BASE Tm
486 wxDateTime_t msec
, sec
, min
, hour
, mday
;
490 // default ctor inits the object to an invalid value
493 // ctor from struct tm and the timezone
494 Tm(const struct tm
& tm
, const TimeZone
& tz
);
496 // check that the given date/time is valid (in Gregorian calendar)
497 bool IsValid() const;
500 WeekDay
GetWeekDay() // not const because wday may be changed
502 if ( wday
== Inv_WeekDay
)
505 return (WeekDay
)wday
;
508 // add the given number of months to the date keeping it normalized
509 void AddMonths(int monDiff
);
511 // add the given number of months to the date keeping it normalized
512 void AddDays(int dayDiff
);
515 // compute the weekday from other fields
516 void ComputeWeekDay();
518 // the timezone we correspond to
521 // these values can't be accessed directly because they're not always
522 // computed and we calculate them on demand
523 wxDateTime_t wday
, yday
;
527 // ------------------------------------------------------------------------
529 // set the current country
530 static void SetCountry(Country country
);
531 // get the current country
532 static Country
GetCountry();
534 // return true if the country is a West European one (in practice,
535 // this means that the same DST rules as for EEC apply)
536 static bool IsWestEuropeanCountry(Country country
= Country_Default
);
538 // return the current year
539 static int GetCurrentYear(Calendar cal
= Gregorian
);
541 // convert the year as returned by wxDateTime::GetYear() to a year
542 // suitable for BC/AD notation. The difference is that BC year 1
543 // corresponds to the year 0 (while BC year 0 didn't exist) and AD
544 // year N is just year N.
545 static int ConvertYearToBC(int year
);
547 // return the current month
548 static Month
GetCurrentMonth(Calendar cal
= Gregorian
);
550 // returns true if the given year is a leap year in the given calendar
551 static bool IsLeapYear(int year
= Inv_Year
, Calendar cal
= Gregorian
);
553 // get the century (19 for 1999, 20 for 2000 and -5 for 492 BC)
554 static int GetCentury(int year
);
556 // returns the number of days in this year (356 or 355 for Gregorian
557 // calendar usually :-)
558 static wxDateTime_t
GetNumberOfDays(int year
, Calendar cal
= Gregorian
);
560 // get the number of the days in the given month (default value for
561 // the year means the current one)
562 static wxDateTime_t
GetNumberOfDays(Month month
,
564 Calendar cal
= Gregorian
);
567 // get the full (default) or abbreviated month name in the current
568 // locale, returns empty string on error
569 static wxString
GetMonthName(Month month
,
570 NameFlags flags
= Name_Full
);
572 // get the standard English full (default) or abbreviated month name
573 static wxString
GetEnglishMonthName(Month month
,
574 NameFlags flags
= Name_Full
);
576 // get the full (default) or abbreviated weekday name in the current
577 // locale, returns empty string on error
578 static wxString
GetWeekDayName(WeekDay weekday
,
579 NameFlags flags
= Name_Full
);
581 // get the standard English full (default) or abbreviated weekday name
582 static wxString
GetEnglishWeekDayName(WeekDay weekday
,
583 NameFlags flags
= Name_Full
);
585 // get the AM and PM strings in the current locale (may be empty)
586 static void GetAmPmStrings(wxString
*am
, wxString
*pm
);
588 // return true if the given country uses DST for this year
589 static bool IsDSTApplicable(int year
= Inv_Year
,
590 Country country
= Country_Default
);
592 // get the beginning of DST for this year, will return invalid object
593 // if no DST applicable in this year. The default value of the
594 // parameter means to take the current year.
595 static wxDateTime
GetBeginDST(int year
= Inv_Year
,
596 Country country
= Country_Default
);
597 // get the end of DST for this year, will return invalid object
598 // if no DST applicable in this year. The default value of the
599 // parameter means to take the current year.
600 static wxDateTime
GetEndDST(int year
= Inv_Year
,
601 Country country
= Country_Default
);
603 // return the wxDateTime object for the current time
604 static inline wxDateTime
Now();
606 // return the wxDateTime object for the current time with millisecond
607 // precision (if available on this platform)
608 static wxDateTime
UNow();
610 // return the wxDateTime object for today midnight: i.e. as Now() but
611 // with time set to 0
612 static inline wxDateTime
Today();
614 // constructors: you should test whether the constructor succeeded with
615 // IsValid() function. The values Inv_Month and Inv_Year for the
616 // parameters mean take current month and/or year values.
617 // ------------------------------------------------------------------------
619 // default ctor does not initialize the object, use Set()!
620 wxDateTime() { m_time
= wxLongLong(wxINT32_MIN
, 0); }
622 // from time_t: seconds since the Epoch 00:00:00 UTC, Jan 1, 1970)
623 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
624 // VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
625 inline wxDateTime(time_t timet
);
627 // from broken down time/date (only for standard Unix range)
628 inline wxDateTime(const struct tm
& tm
);
629 // from broken down time/date (any range)
630 inline wxDateTime(const Tm
& tm
);
632 // from JDN (beware of rounding errors)
633 inline wxDateTime(double jdn
);
635 // from separate values for each component, date set to today
636 inline wxDateTime(wxDateTime_t hour
,
637 wxDateTime_t minute
= 0,
638 wxDateTime_t second
= 0,
639 wxDateTime_t millisec
= 0);
640 // from separate values for each component with explicit date
641 inline wxDateTime(wxDateTime_t day
, // day of the month
643 int year
= Inv_Year
, // 1999, not 99 please!
644 wxDateTime_t hour
= 0,
645 wxDateTime_t minute
= 0,
646 wxDateTime_t second
= 0,
647 wxDateTime_t millisec
= 0);
649 wxDateTime(const struct _SYSTEMTIME
& st
)
651 SetFromMSWSysTime(st
);
655 // default copy ctor ok
659 // assignment operators and Set() functions: all non const methods return
660 // the reference to this object. IsValid() should be used to test whether
661 // the function succeeded.
662 // ------------------------------------------------------------------------
664 // set to the current time
665 inline wxDateTime
& SetToCurrent();
667 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
668 // VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
669 // set to given time_t value
670 inline wxDateTime
& Set(time_t timet
);
673 // set to given broken down time/date
674 wxDateTime
& Set(const struct tm
& tm
);
676 // set to given broken down time/date
677 inline wxDateTime
& Set(const Tm
& tm
);
679 // set to given JDN (beware of rounding errors)
680 wxDateTime
& Set(double jdn
);
682 // set to given time, date = today
683 wxDateTime
& Set(wxDateTime_t hour
,
684 wxDateTime_t minute
= 0,
685 wxDateTime_t second
= 0,
686 wxDateTime_t millisec
= 0);
688 // from separate values for each component with explicit date
689 // (defaults for month and year are the current values)
690 wxDateTime
& Set(wxDateTime_t day
,
692 int year
= Inv_Year
, // 1999, not 99 please!
693 wxDateTime_t hour
= 0,
694 wxDateTime_t minute
= 0,
695 wxDateTime_t second
= 0,
696 wxDateTime_t millisec
= 0);
698 // resets time to 00:00:00, doesn't change the date
699 wxDateTime
& ResetTime();
701 // get the date part of this object only, i.e. the object which has the
702 // same date as this one but time of 00:00:00
703 wxDateTime
GetDateOnly() const;
705 // the following functions don't change the values of the other
706 // fields, i.e. SetMinute() won't change either hour or seconds value
709 wxDateTime
& SetYear(int year
);
711 wxDateTime
& SetMonth(Month month
);
712 // set the day of the month
713 wxDateTime
& SetDay(wxDateTime_t day
);
715 wxDateTime
& SetHour(wxDateTime_t hour
);
717 wxDateTime
& SetMinute(wxDateTime_t minute
);
719 wxDateTime
& SetSecond(wxDateTime_t second
);
721 wxDateTime
& SetMillisecond(wxDateTime_t millisecond
);
723 // assignment operator from time_t
724 wxDateTime
& operator=(time_t timet
) { return Set(timet
); }
726 // assignment operator from broken down time/date
727 wxDateTime
& operator=(const struct tm
& tm
) { return Set(tm
); }
729 // assignment operator from broken down time/date
730 wxDateTime
& operator=(const Tm
& tm
) { return Set(tm
); }
732 // default assignment operator is ok
734 // calendar calculations (functions which set the date only leave the time
735 // unchanged, e.g. don't explictly zero it): SetXXX() functions modify the
736 // object itself, GetXXX() ones return a new object.
737 // ------------------------------------------------------------------------
739 // set to the given week day in the same week as this one
740 wxDateTime
& SetToWeekDayInSameWeek(WeekDay weekday
,
741 WeekFlags flags
= Monday_First
);
742 inline wxDateTime
GetWeekDayInSameWeek(WeekDay weekday
,
743 WeekFlags flags
= Monday_First
) const;
745 // set to the next week day following this one
746 wxDateTime
& SetToNextWeekDay(WeekDay weekday
);
747 inline wxDateTime
GetNextWeekDay(WeekDay weekday
) const;
749 // set to the previous week day before this one
750 wxDateTime
& SetToPrevWeekDay(WeekDay weekday
);
751 inline wxDateTime
GetPrevWeekDay(WeekDay weekday
) const;
753 // set to Nth occurrence of given weekday in the given month of the
754 // given year (time is set to 0), return true on success and false on
755 // failure. n may be positive (1..5) or negative to count from the end
756 // of the month (see helper function SetToLastWeekDay())
757 bool SetToWeekDay(WeekDay weekday
,
759 Month month
= Inv_Month
,
760 int year
= Inv_Year
);
761 inline wxDateTime
GetWeekDay(WeekDay weekday
,
763 Month month
= Inv_Month
,
764 int year
= Inv_Year
) const;
766 // sets to the last weekday in the given month, year
767 inline bool SetToLastWeekDay(WeekDay weekday
,
768 Month month
= Inv_Month
,
769 int year
= Inv_Year
);
770 inline wxDateTime
GetLastWeekDay(WeekDay weekday
,
771 Month month
= Inv_Month
,
772 int year
= Inv_Year
);
774 #if WXWIN_COMPATIBILITY_2_6
775 // sets the date to the given day of the given week in the year,
776 // returns true on success and false if given date doesn't exist (e.g.
779 // these functions are badly defined as they're not the reverse of
780 // GetWeekOfYear(), use SetToTheWeekOfYear() instead
781 wxDEPRECATED( bool SetToTheWeek(wxDateTime_t numWeek
,
782 WeekDay weekday
= Mon
,
783 WeekFlags flags
= Monday_First
) );
784 wxDEPRECATED( wxDateTime
GetWeek(wxDateTime_t numWeek
,
785 WeekDay weekday
= Mon
,
786 WeekFlags flags
= Monday_First
) const );
787 #endif // WXWIN_COMPATIBILITY_2_6
789 // returns the date corresponding to the given week day of the given
790 // week (in ISO notation) of the specified year
791 static wxDateTime
SetToWeekOfYear(int year
,
792 wxDateTime_t numWeek
,
793 WeekDay weekday
= Mon
);
795 // sets the date to the last day of the given (or current) month or the
796 // given (or current) year
797 wxDateTime
& SetToLastMonthDay(Month month
= Inv_Month
,
798 int year
= Inv_Year
);
799 inline wxDateTime
GetLastMonthDay(Month month
= Inv_Month
,
800 int year
= Inv_Year
) const;
802 // sets to the given year day (1..365 or 366)
803 wxDateTime
& SetToYearDay(wxDateTime_t yday
);
804 inline wxDateTime
GetYearDay(wxDateTime_t yday
) const;
806 // The definitions below were taken verbatim from
808 // http://www.capecod.net/~pbaum/date/date0.htm
810 // (Peter Baum's home page)
812 // definition: The Julian Day Number, Julian Day, or JD of a
813 // particular instant of time is the number of days and fractions of a
814 // day since 12 hours Universal Time (Greenwich mean noon) on January
815 // 1 of the year -4712, where the year is given in the Julian
816 // proleptic calendar. The idea of using this reference date was
817 // originally proposed by Joseph Scalizer in 1582 to count years but
818 // it was modified by 19th century astronomers to count days. One
819 // could have equivalently defined the reference time to be noon of
820 // November 24, -4713 if were understood that Gregorian calendar rules
821 // were applied. Julian days are Julian Day Numbers and are not to be
822 // confused with Julian dates.
824 // definition: The Rata Die number is a date specified as the number
825 // of days relative to a base date of December 31 of the year 0. Thus
826 // January 1 of the year 1 is Rata Die day 1.
828 // get the Julian Day number (the fractional part specifies the time of
829 // the day, related to noon - beware of rounding errors!)
830 double GetJulianDayNumber() const;
831 double GetJDN() const { return GetJulianDayNumber(); }
833 // get the Modified Julian Day number: it is equal to JDN - 2400000.5
834 // and so integral MJDs correspond to the midnights (and not noons).
835 // MJD 0 is Nov 17, 1858
836 double GetModifiedJulianDayNumber() const { return GetJDN() - 2400000.5; }
837 double GetMJD() const { return GetModifiedJulianDayNumber(); }
839 // get the Rata Die number
840 double GetRataDie() const;
842 // TODO algorithms for calculating some important dates, such as
843 // religious holidays (Easter...) or moon/solar eclipses? Some
844 // algorithms can be found in the calendar FAQ
847 // Timezone stuff: a wxDateTime object constructed using given
848 // day/month/year/hour/min/sec values is interpreted as this moment in
849 // local time. Using the functions below, it may be converted to another
850 // time zone (e.g., the Unix epoch is wxDateTime(1, Jan, 1970).ToGMT()).
852 // These functions try to handle DST internally, but there is no magical
853 // way to know all rules for it in all countries in the world, so if the
854 // program can handle it itself (or doesn't want to handle it at all for
855 // whatever reason), the DST handling can be disabled with noDST.
856 // ------------------------------------------------------------------------
858 // transform to any given timezone
859 inline wxDateTime
ToTimezone(const TimeZone
& tz
, bool noDST
= false) const;
860 wxDateTime
& MakeTimezone(const TimeZone
& tz
, bool noDST
= false);
862 // interpret current value as being in another timezone and transform
864 inline wxDateTime
FromTimezone(const TimeZone
& tz
, bool noDST
= false) const;
865 wxDateTime
& MakeFromTimezone(const TimeZone
& tz
, bool noDST
= false);
867 // transform to/from GMT/UTC
868 wxDateTime
ToUTC(bool noDST
= false) const { return ToTimezone(UTC
, noDST
); }
869 wxDateTime
& MakeUTC(bool noDST
= false) { return MakeTimezone(UTC
, noDST
); }
871 wxDateTime
ToGMT(bool noDST
= false) const { return ToUTC(noDST
); }
872 wxDateTime
& MakeGMT(bool noDST
= false) { return MakeUTC(noDST
); }
874 wxDateTime
FromUTC(bool noDST
= false) const
875 { return FromTimezone(UTC
, noDST
); }
876 wxDateTime
& MakeFromUTC(bool noDST
= false)
877 { return MakeFromTimezone(UTC
, noDST
); }
879 // is daylight savings time in effect at this moment according to the
880 // rules of the specified country?
882 // Return value is > 0 if DST is in effect, 0 if it is not and -1 if
883 // the information is not available (this is compatible with ANSI C)
884 int IsDST(Country country
= Country_Default
) const;
887 // accessors: many of them take the timezone parameter which indicates the
888 // timezone for which to make the calculations and the default value means
889 // to do it for the current timezone of this machine (even if the function
890 // only operates with the date it's necessary because a date may wrap as
891 // result of timezone shift)
892 // ------------------------------------------------------------------------
894 // is the date valid?
895 inline bool IsValid() const { return m_time
!= wxInvalidDateTime
.m_time
; }
897 // get the broken down date/time representation in the given timezone
899 // If you wish to get several time components (day, month and year),
900 // consider getting the whole Tm strcuture first and retrieving the
901 // value from it - this is much more efficient
902 Tm
GetTm(const TimeZone
& tz
= Local
) const;
904 // get the number of seconds since the Unix epoch - returns (time_t)-1
905 // if the value is out of range
906 inline time_t GetTicks() const;
908 // get the century, same as GetCentury(GetYear())
909 int GetCentury(const TimeZone
& tz
= Local
) const
910 { return GetCentury(GetYear(tz
)); }
911 // get the year (returns Inv_Year if date is invalid)
912 int GetYear(const TimeZone
& tz
= Local
) const
913 { return GetTm(tz
).year
; }
914 // get the month (Inv_Month if date is invalid)
915 Month
GetMonth(const TimeZone
& tz
= Local
) const
916 { return (Month
)GetTm(tz
).mon
; }
917 // get the month day (in 1..31 range, 0 if date is invalid)
918 wxDateTime_t
GetDay(const TimeZone
& tz
= Local
) const
919 { return GetTm(tz
).mday
; }
920 // get the day of the week (Inv_WeekDay if date is invalid)
921 WeekDay
GetWeekDay(const TimeZone
& tz
= Local
) const
922 { return GetTm(tz
).GetWeekDay(); }
923 // get the hour of the day
924 wxDateTime_t
GetHour(const TimeZone
& tz
= Local
) const
925 { return GetTm(tz
).hour
; }
927 wxDateTime_t
GetMinute(const TimeZone
& tz
= Local
) const
928 { return GetTm(tz
).min
; }
930 wxDateTime_t
GetSecond(const TimeZone
& tz
= Local
) const
931 { return GetTm(tz
).sec
; }
933 wxDateTime_t
GetMillisecond(const TimeZone
& tz
= Local
) const
934 { return GetTm(tz
).msec
; }
936 // get the day since the year start (1..366, 0 if date is invalid)
937 wxDateTime_t
GetDayOfYear(const TimeZone
& tz
= Local
) const;
938 // get the week number since the year start (1..52 or 53, 0 if date is
940 wxDateTime_t
GetWeekOfYear(WeekFlags flags
= Monday_First
,
941 const TimeZone
& tz
= Local
) const;
942 // get the week number since the month start (1..5, 0 if date is
944 wxDateTime_t
GetWeekOfMonth(WeekFlags flags
= Monday_First
,
945 const TimeZone
& tz
= Local
) const;
947 // is this date a work day? This depends on a country, of course,
948 // because the holidays are different in different countries
949 bool IsWorkDay(Country country
= Country_Default
) const;
951 // is this date later than Gregorian calendar introduction for the
952 // given country (see enum GregorianAdoption)?
954 // NB: this function shouldn't be considered as absolute authority in
955 // the matter. Besides, for some countries the exact date of
956 // adoption of the Gregorian calendar is simply unknown.
957 bool IsGregorianDate(GregorianAdoption country
= Gr_Standard
) const;
959 // dos date and time format
960 // ------------------------------------------------------------------------
962 // set from the DOS packed format
963 wxDateTime
& SetFromDOS(unsigned long ddt
);
965 // pack the date in DOS format
966 unsigned long GetAsDOS() const;
969 // ------------------------------------------------------------------------
972 // convert SYSTEMTIME to wxDateTime
973 wxDateTime
& SetFromMSWSysTime(const struct _SYSTEMTIME
&);
975 // convert wxDateTime to SYSTEMTIME
976 void GetAsMSWSysTime(struct _SYSTEMTIME
*) const;
979 // comparison (see also functions below for operator versions)
980 // ------------------------------------------------------------------------
982 // returns true if the two moments are strictly identical
983 inline bool IsEqualTo(const wxDateTime
& datetime
) const;
985 // returns true if the date is strictly earlier than the given one
986 inline bool IsEarlierThan(const wxDateTime
& datetime
) const;
988 // returns true if the date is strictly later than the given one
989 inline bool IsLaterThan(const wxDateTime
& datetime
) const;
991 // returns true if the date is strictly in the given range
992 inline bool IsStrictlyBetween(const wxDateTime
& t1
,
993 const wxDateTime
& t2
) const;
995 // returns true if the date is in the given range
996 inline bool IsBetween(const wxDateTime
& t1
, const wxDateTime
& t2
) const;
998 // do these two objects refer to the same date?
999 inline bool IsSameDate(const wxDateTime
& dt
) const;
1001 // do these two objects have the same time?
1002 inline bool IsSameTime(const wxDateTime
& dt
) const;
1004 // are these two objects equal up to given timespan?
1005 inline bool IsEqualUpTo(const wxDateTime
& dt
, const wxTimeSpan
& ts
) const;
1007 inline bool operator<(const wxDateTime
& dt
) const
1009 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
1010 return GetValue() < dt
.GetValue();
1013 inline bool operator<=(const wxDateTime
& dt
) const
1015 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
1016 return GetValue() <= dt
.GetValue();
1019 inline bool operator>(const wxDateTime
& dt
) const
1021 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
1022 return GetValue() > dt
.GetValue();
1025 inline bool operator>=(const wxDateTime
& dt
) const
1027 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
1028 return GetValue() >= dt
.GetValue();
1031 inline bool operator==(const wxDateTime
& dt
) const
1033 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
1034 return GetValue() == dt
.GetValue();
1037 inline bool operator!=(const wxDateTime
& dt
) const
1039 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
1040 return GetValue() != dt
.GetValue();
1043 // arithmetics with dates (see also below for more operators)
1044 // ------------------------------------------------------------------------
1046 // return the sum of the date with a time span (positive or negative)
1047 inline wxDateTime
Add(const wxTimeSpan
& diff
) const;
1048 // add a time span (positive or negative)
1049 inline wxDateTime
& Add(const wxTimeSpan
& diff
);
1050 // add a time span (positive or negative)
1051 inline wxDateTime
& operator+=(const wxTimeSpan
& diff
);
1052 inline wxDateTime
operator+(const wxTimeSpan
& ts
) const
1054 wxDateTime
dt(*this);
1059 // return the difference of the date with a time span
1060 inline wxDateTime
Subtract(const wxTimeSpan
& diff
) const;
1061 // subtract a time span (positive or negative)
1062 inline wxDateTime
& Subtract(const wxTimeSpan
& diff
);
1063 // subtract a time span (positive or negative)
1064 inline wxDateTime
& operator-=(const wxTimeSpan
& diff
);
1065 inline wxDateTime
operator-(const wxTimeSpan
& ts
) const
1067 wxDateTime
dt(*this);
1072 // return the sum of the date with a date span
1073 inline wxDateTime
Add(const wxDateSpan
& diff
) const;
1074 // add a date span (positive or negative)
1075 wxDateTime
& Add(const wxDateSpan
& diff
);
1076 // add a date span (positive or negative)
1077 inline wxDateTime
& operator+=(const wxDateSpan
& diff
);
1078 inline wxDateTime
operator+(const wxDateSpan
& ds
) const
1080 wxDateTime
dt(*this);
1085 // return the difference of the date with a date span
1086 inline wxDateTime
Subtract(const wxDateSpan
& diff
) const;
1087 // subtract a date span (positive or negative)
1088 inline wxDateTime
& Subtract(const wxDateSpan
& diff
);
1089 // subtract a date span (positive or negative)
1090 inline wxDateTime
& operator-=(const wxDateSpan
& diff
);
1091 inline wxDateTime
operator-(const wxDateSpan
& ds
) const
1093 wxDateTime
dt(*this);
1098 // return the difference between two dates
1099 inline wxTimeSpan
Subtract(const wxDateTime
& dt
) const;
1100 inline wxTimeSpan
operator-(const wxDateTime
& dt2
) const;
1102 // conversion to/from text: all conversions from text return an object
1103 // representing the next character following the date specification (i.e.
1104 // the one where the scan had to stop) or a special NULL-like object
1105 // on failure -- this object is necessary to preserve compatibility with
1106 // the existing code assigning the return value of these functions to
1107 // either char* or wxChar* (new code should treat the return value as bool
1108 // and use end parameter to retrieve the end of the scan)
1109 // ------------------------------------------------------------------------
1111 // parse a string in RFC 822 format (found e.g. in mail headers and
1112 // having the form "Wed, 10 Feb 1999 19:07:07 +0100")
1113 wxAnyStrPtr
ParseRfc822Date(const wxString
& date
,
1114 wxString::const_iterator
*end
= NULL
);
1116 // parse a date/time in the given format (see strptime(3)), fill in
1117 // the missing (in the string) fields with the values of dateDef (by
1118 // default, they will not change if they had valid values or will
1119 // default to Today() otherwise)
1120 wxAnyStrPtr
ParseFormat(const wxString
& date
,
1121 const wxString
& format
= wxDefaultDateTimeFormat
,
1122 const wxDateTime
& dateDef
= wxDefaultDateTime
,
1123 wxString::const_iterator
*end
= NULL
);
1125 wxAnyStrPtr
ParseFormat(const wxString
& date
,
1126 const wxString
& format
,
1127 wxString::const_iterator
*end
)
1129 return ParseFormat(date
, format
, wxDefaultDateTime
, end
);
1133 // parse a string containing date, time or both in ISO 8601 format
1135 // notice that these functions are new in wx 3.0 and so we don't
1136 // provide compatibility overloads for them
1137 bool ParseISODate(const wxString
& date
)
1139 // FIXME-VC6: notice that writing "return ParseFormat() && ..." crashes
1140 // VC6 with internal compiler error so don't attempt to
1141 // simplify this code like this
1143 wxString::const_iterator end
;
1144 if ( !ParseFormat(date
, wxS("%Y-%m-%d"), &end
) )
1147 return end
== date
.end();
1150 bool ParseISOTime(const wxString
& time
)
1152 wxString::const_iterator end
;
1153 if ( !ParseFormat(time
, wxS("%H:%M:%S"), &end
) )
1156 return end
== time
.end();
1159 bool ParseISOCombined(const wxString
& datetime
, char sep
= 'T')
1161 wxString::const_iterator end
;
1162 const wxString fmt
= wxS("%Y-%m-%d") + wxString(sep
) + wxS("%H:%M:%S");
1163 if ( !ParseFormat(datetime
, fmt
, &end
) )
1166 return end
== datetime
.end();
1169 // parse a string containing the date/time in "free" format, this
1170 // function will try to make an educated guess at the string contents
1171 wxAnyStrPtr
ParseDateTime(const wxString
& datetime
,
1172 wxString::const_iterator
*end
= NULL
);
1174 // parse a string containing the date only in "free" format (less
1175 // flexible than ParseDateTime)
1176 wxAnyStrPtr
ParseDate(const wxString
& date
,
1177 wxString::const_iterator
*end
= NULL
);
1179 // parse a string containing the time only in "free" format
1180 wxAnyStrPtr
ParseTime(const wxString
& time
,
1181 wxString::const_iterator
*end
= NULL
);
1184 // this function accepts strftime()-like format string (default
1185 // argument corresponds to the preferred date and time representation
1186 // for the current locale) and returns the string containing the
1187 // resulting text representation
1188 wxString
Format(const wxString
& format
= wxDefaultDateTimeFormat
,
1189 const TimeZone
& tz
= Local
) const;
1190 // preferred date representation for the current locale
1191 wxString
FormatDate() const { return Format(wxS("%x")); }
1192 // preferred time representation for the current locale
1193 wxString
FormatTime() const { return Format(wxS("%X")); }
1194 // returns the string representing the date in ISO 8601 format
1196 wxString
FormatISODate() const { return Format(wxS("%Y-%m-%d")); }
1197 // returns the string representing the time in ISO 8601 format
1199 wxString
FormatISOTime() const { return Format(wxS("%H:%M:%S")); }
1200 // return the combined date time representation in ISO 8601 format; the
1201 // separator character should be 'T' according to the standard but it
1202 // can also be useful to set it to ' '
1203 wxString
FormatISOCombined(char sep
= 'T') const
1204 { return FormatISODate() + sep
+ FormatISOTime(); }
1207 // ------------------------------------------------------------------------
1209 // construct from internal representation
1210 wxDateTime(const wxLongLong
& time
) { m_time
= time
; }
1212 // get the internal representation
1213 inline wxLongLong
GetValue() const;
1215 // a helper function to get the current time_t
1216 static time_t GetTimeNow() { return time(NULL
); }
1218 // another one to get the current time broken down
1219 static struct tm
*GetTmNow()
1221 static struct tm l_CurrentTime
;
1222 return GetTmNow(&l_CurrentTime
);
1225 // get current time using thread-safe function
1226 static struct tm
*GetTmNow(struct tm
*tmstruct
);
1229 // the current country - as it's the same for all program objects (unless
1230 // it runs on a _really_ big cluster system :-), this is a static member:
1231 // see SetCountry() and GetCountry()
1232 static Country ms_country
;
1234 // this constant is used to transform a time_t value to the internal
1235 // representation, as time_t is in seconds and we use milliseconds it's
1237 static const long TIME_T_FACTOR
;
1239 // returns true if we fall in range in which we can use standard ANSI C
1241 inline bool IsInStdRange() const;
1243 // the internal representation of the time is the amount of milliseconds
1244 // elapsed since the origin which is set by convention to the UNIX/C epoch
1245 // value: the midnight of January 1, 1970 (UTC)
1249 // ----------------------------------------------------------------------------
1250 // This class contains a difference between 2 wxDateTime values, so it makes
1251 // sense to add it to wxDateTime and it is the result of subtraction of 2
1252 // objects of that class. See also wxDateSpan.
1253 // ----------------------------------------------------------------------------
1255 class WXDLLIMPEXP_BASE wxTimeSpan
1259 // ------------------------------------------------------------------------
1261 // return the timespan for the given number of milliseconds
1262 static wxTimeSpan
Milliseconds(wxLongLong ms
) { return wxTimeSpan(0, 0, 0, ms
); }
1263 static wxTimeSpan
Millisecond() { return Milliseconds(1); }
1265 // return the timespan for the given number of seconds
1266 static wxTimeSpan
Seconds(wxLongLong sec
) { return wxTimeSpan(0, 0, sec
); }
1267 static wxTimeSpan
Second() { return Seconds(1); }
1269 // return the timespan for the given number of minutes
1270 static wxTimeSpan
Minutes(long min
) { return wxTimeSpan(0, min
, 0 ); }
1271 static wxTimeSpan
Minute() { return Minutes(1); }
1273 // return the timespan for the given number of hours
1274 static wxTimeSpan
Hours(long hours
) { return wxTimeSpan(hours
, 0, 0); }
1275 static wxTimeSpan
Hour() { return Hours(1); }
1277 // return the timespan for the given number of days
1278 static wxTimeSpan
Days(long days
) { return Hours(24 * days
); }
1279 static wxTimeSpan
Day() { return Days(1); }
1281 // return the timespan for the given number of weeks
1282 static wxTimeSpan
Weeks(long days
) { return Days(7 * days
); }
1283 static wxTimeSpan
Week() { return Weeks(1); }
1285 // default ctor constructs the 0 time span
1288 // from separate values for each component, date set to 0 (hours are
1289 // not restricted to 0..24 range, neither are minutes, seconds or
1291 inline wxTimeSpan(long hours
,
1293 wxLongLong seconds
= 0,
1294 wxLongLong milliseconds
= 0);
1296 // default copy ctor is ok
1300 // arithmetics with time spans (see also below for more operators)
1301 // ------------------------------------------------------------------------
1303 // return the sum of two timespans
1304 inline wxTimeSpan
Add(const wxTimeSpan
& diff
) const;
1305 // add two timespans together
1306 inline wxTimeSpan
& Add(const wxTimeSpan
& diff
);
1307 // add two timespans together
1308 wxTimeSpan
& operator+=(const wxTimeSpan
& diff
) { return Add(diff
); }
1309 inline wxTimeSpan
operator+(const wxTimeSpan
& ts
) const
1311 return wxTimeSpan(GetValue() + ts
.GetValue());
1314 // return the difference of two timespans
1315 inline wxTimeSpan
Subtract(const wxTimeSpan
& diff
) const;
1316 // subtract another timespan
1317 inline wxTimeSpan
& Subtract(const wxTimeSpan
& diff
);
1318 // subtract another timespan
1319 wxTimeSpan
& operator-=(const wxTimeSpan
& diff
) { return Subtract(diff
); }
1320 inline wxTimeSpan
operator-(const wxTimeSpan
& ts
)
1322 return wxTimeSpan(GetValue() - ts
.GetValue());
1325 // multiply timespan by a scalar
1326 inline wxTimeSpan
Multiply(int n
) const;
1327 // multiply timespan by a scalar
1328 inline wxTimeSpan
& Multiply(int n
);
1329 // multiply timespan by a scalar
1330 wxTimeSpan
& operator*=(int n
) { return Multiply(n
); }
1331 inline wxTimeSpan
operator*(int n
) const
1333 return wxTimeSpan(*this).Multiply(n
);
1336 // return this timespan with opposite sign
1337 wxTimeSpan
Negate() const { return wxTimeSpan(-GetValue()); }
1338 // negate the value of the timespan
1339 wxTimeSpan
& Neg() { m_diff
= -GetValue(); return *this; }
1340 // negate the value of the timespan
1341 wxTimeSpan
& operator-() { return Neg(); }
1343 // return the absolute value of the timespan: does _not_ modify the
1345 inline wxTimeSpan
Abs() const;
1347 // there is intentionally no division because we don't want to
1348 // introduce rounding errors in time calculations
1350 // comparaison (see also operator versions below)
1351 // ------------------------------------------------------------------------
1353 // is the timespan null?
1354 bool IsNull() const { return m_diff
== 0l; }
1355 // returns true if the timespan is null
1356 bool operator!() const { return !IsNull(); }
1358 // is the timespan positive?
1359 bool IsPositive() const { return m_diff
> 0l; }
1361 // is the timespan negative?
1362 bool IsNegative() const { return m_diff
< 0l; }
1364 // are two timespans equal?
1365 inline bool IsEqualTo(const wxTimeSpan
& ts
) const;
1366 // compare two timestamps: works with the absolute values, i.e. -2
1367 // hours is longer than 1 hour. Also, it will return false if the
1368 // timespans are equal in absolute value.
1369 inline bool IsLongerThan(const wxTimeSpan
& ts
) const;
1370 // compare two timestamps: works with the absolute values, i.e. 1
1371 // hour is shorter than -2 hours. Also, it will return false if the
1372 // timespans are equal in absolute value.
1373 bool IsShorterThan(const wxTimeSpan
& t
) const;
1375 inline bool operator<(const wxTimeSpan
&ts
) const
1377 return GetValue() < ts
.GetValue();
1380 inline bool operator<=(const wxTimeSpan
&ts
) const
1382 return GetValue() <= ts
.GetValue();
1385 inline bool operator>(const wxTimeSpan
&ts
) const
1387 return GetValue() > ts
.GetValue();
1390 inline bool operator>=(const wxTimeSpan
&ts
) const
1392 return GetValue() >= ts
.GetValue();
1395 inline bool operator==(const wxTimeSpan
&ts
) const
1397 return GetValue() == ts
.GetValue();
1400 inline bool operator!=(const wxTimeSpan
&ts
) const
1402 return GetValue() != ts
.GetValue();
1405 // breaking into days, hours, minutes and seconds
1406 // ------------------------------------------------------------------------
1408 // get the max number of weeks in this timespan
1409 inline int GetWeeks() const;
1410 // get the max number of days in this timespan
1411 inline int GetDays() const;
1412 // get the max number of hours in this timespan
1413 inline int GetHours() const;
1414 // get the max number of minutes in this timespan
1415 inline int GetMinutes() const;
1416 // get the max number of seconds in this timespan
1417 inline wxLongLong
GetSeconds() const;
1418 // get the number of milliseconds in this timespan
1419 wxLongLong
GetMilliseconds() const { return m_diff
; }
1421 // conversion to text
1422 // ------------------------------------------------------------------------
1424 // this function accepts strftime()-like format string (default
1425 // argument corresponds to the preferred date and time representation
1426 // for the current locale) and returns the string containing the
1427 // resulting text representation. Notice that only some of format
1428 // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
1429 // minutes and seconds make sense, but not "PM/AM" string for example.
1430 wxString
Format(const wxString
& format
= wxDefaultTimeSpanFormat
) const;
1433 // ------------------------------------------------------------------------
1435 // construct from internal representation
1436 wxTimeSpan(const wxLongLong
& diff
) { m_diff
= diff
; }
1438 // get the internal representation
1439 wxLongLong
GetValue() const { return m_diff
; }
1442 // the (signed) time span in milliseconds
1446 // ----------------------------------------------------------------------------
1447 // This class is a "logical time span" and is useful for implementing program
1448 // logic for such things as "add one month to the date" which, in general,
1449 // doesn't mean to add 60*60*24*31 seconds to it, but to take the same date
1450 // the next month (to understand that this is indeed different consider adding
1451 // one month to Feb, 15 - we want to get Mar, 15, of course).
1453 // When adding a month to the date, all lesser components (days, hours, ...)
1454 // won't be changed unless the resulting date would be invalid: for example,
1455 // Jan 31 + 1 month will be Feb 28, not (non existing) Feb 31.
1457 // Because of this feature, adding and subtracting back again the same
1458 // wxDateSpan will *not*, in general give back the original date: Feb 28 - 1
1459 // month will be Jan 28, not Jan 31!
1461 // wxDateSpan can be either positive or negative. They may be
1462 // multiplied by scalars which multiply all deltas by the scalar: i.e. 2*(1
1463 // month and 1 day) is 2 months and 2 days. They can be added together and
1464 // with wxDateTime or wxTimeSpan, but the type of result is different for each
1467 // Beware about weeks: if you specify both weeks and days, the total number of
1468 // days added will be 7*weeks + days! See also GetTotalDays() function.
1470 // Equality operators are defined for wxDateSpans. Two datespans are equal if
1471 // they both give the same target date when added to *every* source date.
1472 // Thus wxDateSpan::Months(1) is not equal to wxDateSpan::Days(30), because
1473 // they not give the same date when added to 1 Feb. But wxDateSpan::Days(14) is
1474 // equal to wxDateSpan::Weeks(2)
1476 // Finally, notice that for adding hours, minutes &c you don't need this
1477 // class: wxTimeSpan will do the job because there are no subtleties
1478 // associated with those.
1479 // ----------------------------------------------------------------------------
1481 class WXDLLIMPEXP_BASE wxDateSpan
1485 // ------------------------------------------------------------------------
1487 // this many years/months/weeks/days
1488 wxDateSpan(int years
= 0, int months
= 0, int weeks
= 0, int days
= 0)
1496 // get an object for the given number of days
1497 static wxDateSpan
Days(int days
) { return wxDateSpan(0, 0, 0, days
); }
1498 static wxDateSpan
Day() { return Days(1); }
1500 // get an object for the given number of weeks
1501 static wxDateSpan
Weeks(int weeks
) { return wxDateSpan(0, 0, weeks
, 0); }
1502 static wxDateSpan
Week() { return Weeks(1); }
1504 // get an object for the given number of months
1505 static wxDateSpan
Months(int mon
) { return wxDateSpan(0, mon
, 0, 0); }
1506 static wxDateSpan
Month() { return Months(1); }
1508 // get an object for the given number of years
1509 static wxDateSpan
Years(int years
) { return wxDateSpan(years
, 0, 0, 0); }
1510 static wxDateSpan
Year() { return Years(1); }
1512 // default copy ctor is ok
1516 // accessors (all SetXXX() return the (modified) wxDateSpan object)
1517 // ------------------------------------------------------------------------
1519 // set number of years
1520 wxDateSpan
& SetYears(int n
) { m_years
= n
; return *this; }
1521 // set number of months
1522 wxDateSpan
& SetMonths(int n
) { m_months
= n
; return *this; }
1523 // set number of weeks
1524 wxDateSpan
& SetWeeks(int n
) { m_weeks
= n
; return *this; }
1525 // set number of days
1526 wxDateSpan
& SetDays(int n
) { m_days
= n
; return *this; }
1528 // get number of years
1529 int GetYears() const { return m_years
; }
1530 // get number of months
1531 int GetMonths() const { return m_months
; }
1532 // get number of weeks
1533 int GetWeeks() const { return m_weeks
; }
1534 // get number of days
1535 int GetDays() const { return m_days
; }
1536 // returns 7*GetWeeks() + GetDays()
1537 int GetTotalDays() const { return 7*m_weeks
+ m_days
; }
1539 // arithmetics with date spans (see also below for more operators)
1540 // ------------------------------------------------------------------------
1542 // return sum of two date spans
1543 inline wxDateSpan
Add(const wxDateSpan
& other
) const;
1544 // add another wxDateSpan to us
1545 inline wxDateSpan
& Add(const wxDateSpan
& other
);
1546 // add another wxDateSpan to us
1547 inline wxDateSpan
& operator+=(const wxDateSpan
& other
);
1548 inline wxDateSpan
operator+(const wxDateSpan
& ds
) const
1550 return wxDateSpan(GetYears() + ds
.GetYears(),
1551 GetMonths() + ds
.GetMonths(),
1552 GetWeeks() + ds
.GetWeeks(),
1553 GetDays() + ds
.GetDays());
1556 // return difference of two date spans
1557 inline wxDateSpan
Subtract(const wxDateSpan
& other
) const;
1558 // subtract another wxDateSpan from us
1559 inline wxDateSpan
& Subtract(const wxDateSpan
& other
);
1560 // subtract another wxDateSpan from us
1561 inline wxDateSpan
& operator-=(const wxDateSpan
& other
);
1562 inline wxDateSpan
operator-(const wxDateSpan
& ds
) const
1564 return wxDateSpan(GetYears() - ds
.GetYears(),
1565 GetMonths() - ds
.GetMonths(),
1566 GetWeeks() - ds
.GetWeeks(),
1567 GetDays() - ds
.GetDays());
1570 // return a copy of this time span with changed sign
1571 inline wxDateSpan
Negate() const;
1572 // inverse the sign of this timespan
1573 inline wxDateSpan
& Neg();
1574 // inverse the sign of this timespan
1575 wxDateSpan
& operator-() { return Neg(); }
1577 // return the date span proportional to this one with given factor
1578 inline wxDateSpan
Multiply(int factor
) const;
1579 // multiply all components by a (signed) number
1580 inline wxDateSpan
& Multiply(int factor
);
1581 // multiply all components by a (signed) number
1582 inline wxDateSpan
& operator*=(int factor
) { return Multiply(factor
); }
1583 inline wxDateSpan
operator*(int n
) const
1585 return wxDateSpan(*this).Multiply(n
);
1588 // ds1 == d2 if and only if for every wxDateTime t t + ds1 == t + ds2
1589 inline bool operator==(const wxDateSpan
& ds
) const
1591 return GetYears() == ds
.GetYears() &&
1592 GetMonths() == ds
.GetMonths() &&
1593 GetTotalDays() == ds
.GetTotalDays();
1596 inline bool operator!=(const wxDateSpan
& ds
) const
1598 return !(*this == ds
);
1608 // ----------------------------------------------------------------------------
1609 // wxDateTimeArray: array of dates.
1610 // ----------------------------------------------------------------------------
1612 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDateTime
, wxDateTimeArray
, WXDLLIMPEXP_BASE
);
1614 // ----------------------------------------------------------------------------
1615 // wxDateTimeHolidayAuthority: an object of this class will decide whether a
1616 // given date is a holiday and is used by all functions working with "work
1619 // NB: the base class is an ABC, derived classes must implement the pure
1620 // virtual methods to work with the holidays they correspond to.
1621 // ----------------------------------------------------------------------------
1623 class WXDLLIMPEXP_FWD_BASE wxDateTimeHolidayAuthority
;
1624 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxDateTimeHolidayAuthority
*,
1625 wxHolidayAuthoritiesArray
,
1626 class WXDLLIMPEXP_BASE
);
1628 class wxDateTimeHolidaysModule
;
1629 class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority
1631 friend class wxDateTimeHolidaysModule
;
1633 // returns true if the given date is a holiday
1634 static bool IsHoliday(const wxDateTime
& dt
);
1636 // fills the provided array with all holidays in the given range, returns
1637 // the number of them
1638 static size_t GetHolidaysInRange(const wxDateTime
& dtStart
,
1639 const wxDateTime
& dtEnd
,
1640 wxDateTimeArray
& holidays
);
1642 // clear the list of holiday authorities
1643 static void ClearAllAuthorities();
1645 // add a new holiday authority (the pointer will be deleted by
1646 // wxDateTimeHolidayAuthority)
1647 static void AddAuthority(wxDateTimeHolidayAuthority
*auth
);
1649 // the base class must have a virtual dtor
1650 virtual ~wxDateTimeHolidayAuthority();
1653 // this function is called to determine whether a given day is a holiday
1654 virtual bool DoIsHoliday(const wxDateTime
& dt
) const = 0;
1656 // this function should fill the array with all holidays between the two
1657 // given dates - it is implemented in the base class, but in a very
1658 // inefficient way (it just iterates over all days and uses IsHoliday() for
1659 // each of them), so it must be overridden in the derived class where the
1660 // base class version may be explicitly used if needed
1662 // returns the number of holidays in the given range and fills holidays
1664 virtual size_t DoGetHolidaysInRange(const wxDateTime
& dtStart
,
1665 const wxDateTime
& dtEnd
,
1666 wxDateTimeArray
& holidays
) const = 0;
1669 // all holiday authorities
1670 static wxHolidayAuthoritiesArray ms_authorities
;
1673 // the holidays for this class are all Saturdays and Sundays
1674 class WXDLLIMPEXP_BASE wxDateTimeWorkDays
: public wxDateTimeHolidayAuthority
1677 virtual bool DoIsHoliday(const wxDateTime
& dt
) const;
1678 virtual size_t DoGetHolidaysInRange(const wxDateTime
& dtStart
,
1679 const wxDateTime
& dtEnd
,
1680 wxDateTimeArray
& holidays
) const;
1683 // ============================================================================
1684 // inline functions implementation
1685 // ============================================================================
1687 // ----------------------------------------------------------------------------
1689 // ----------------------------------------------------------------------------
1691 #define MILLISECONDS_PER_DAY 86400000l
1693 // some broken compilers (HP-UX CC) refuse to compile the "normal" version, but
1694 // using a temp variable always might prevent other compilers from optimising
1695 // it away - hence use of this ugly macro
1697 #define MODIFY_AND_RETURN(op) return wxDateTime(*this).op
1699 #define MODIFY_AND_RETURN(op) wxDateTime dt(*this); dt.op; return dt
1702 // ----------------------------------------------------------------------------
1703 // wxDateTime construction
1704 // ----------------------------------------------------------------------------
1706 inline bool wxDateTime::IsInStdRange() const
1708 return m_time
>= 0l && (m_time
/ TIME_T_FACTOR
) < LONG_MAX
;
1712 inline wxDateTime
wxDateTime::Now()
1715 return wxDateTime(*GetTmNow(&tmstruct
));
1719 inline wxDateTime
wxDateTime::Today()
1721 wxDateTime
dt(Now());
1727 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
1728 inline wxDateTime
& wxDateTime::Set(time_t timet
)
1730 // assign first to avoid long multiplication overflow!
1731 m_time
= timet
- WX_TIME_BASE_OFFSET
;
1732 m_time
*= TIME_T_FACTOR
;
1738 inline wxDateTime
& wxDateTime::SetToCurrent()
1744 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
1745 inline wxDateTime::wxDateTime(time_t timet
)
1751 inline wxDateTime::wxDateTime(const struct tm
& tm
)
1756 inline wxDateTime::wxDateTime(const Tm
& tm
)
1761 inline wxDateTime::wxDateTime(double jdn
)
1766 inline wxDateTime
& wxDateTime::Set(const Tm
& tm
)
1768 wxASSERT_MSG( tm
.IsValid(), _T("invalid broken down date/time") );
1770 return Set(tm
.mday
, (Month
)tm
.mon
, tm
.year
,
1771 tm
.hour
, tm
.min
, tm
.sec
, tm
.msec
);
1774 inline wxDateTime::wxDateTime(wxDateTime_t hour
,
1775 wxDateTime_t minute
,
1776 wxDateTime_t second
,
1777 wxDateTime_t millisec
)
1779 Set(hour
, minute
, second
, millisec
);
1782 inline wxDateTime::wxDateTime(wxDateTime_t day
,
1786 wxDateTime_t minute
,
1787 wxDateTime_t second
,
1788 wxDateTime_t millisec
)
1790 Set(day
, month
, year
, hour
, minute
, second
, millisec
);
1793 // ----------------------------------------------------------------------------
1794 // wxDateTime accessors
1795 // ----------------------------------------------------------------------------
1797 inline wxLongLong
wxDateTime::GetValue() const
1799 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1804 inline time_t wxDateTime::GetTicks() const
1806 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1807 if ( !IsInStdRange() )
1812 return (time_t)((m_time
/ (long)TIME_T_FACTOR
).ToLong()) + WX_TIME_BASE_OFFSET
;
1815 inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday
,
1819 return SetToWeekDay(weekday
, -1, month
, year
);
1823 wxDateTime::GetWeekDayInSameWeek(WeekDay weekday
,
1824 WeekFlags
WXUNUSED(flags
)) const
1826 MODIFY_AND_RETURN( SetToWeekDayInSameWeek(weekday
) );
1829 inline wxDateTime
wxDateTime::GetNextWeekDay(WeekDay weekday
) const
1831 MODIFY_AND_RETURN( SetToNextWeekDay(weekday
) );
1834 inline wxDateTime
wxDateTime::GetPrevWeekDay(WeekDay weekday
) const
1836 MODIFY_AND_RETURN( SetToPrevWeekDay(weekday
) );
1839 inline wxDateTime
wxDateTime::GetWeekDay(WeekDay weekday
,
1844 wxDateTime
dt(*this);
1846 return dt
.SetToWeekDay(weekday
, n
, month
, year
) ? dt
: wxInvalidDateTime
;
1849 inline wxDateTime
wxDateTime::GetLastWeekDay(WeekDay weekday
,
1853 wxDateTime
dt(*this);
1855 return dt
.SetToLastWeekDay(weekday
, month
, year
) ? dt
: wxInvalidDateTime
;
1858 inline wxDateTime
wxDateTime::GetLastMonthDay(Month month
, int year
) const
1860 MODIFY_AND_RETURN( SetToLastMonthDay(month
, year
) );
1863 inline wxDateTime
wxDateTime::GetYearDay(wxDateTime_t yday
) const
1865 MODIFY_AND_RETURN( SetToYearDay(yday
) );
1868 // ----------------------------------------------------------------------------
1869 // wxDateTime comparison
1870 // ----------------------------------------------------------------------------
1872 inline bool wxDateTime::IsEqualTo(const wxDateTime
& datetime
) const
1874 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1876 return m_time
== datetime
.m_time
;
1879 inline bool wxDateTime::IsEarlierThan(const wxDateTime
& datetime
) const
1881 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1883 return m_time
< datetime
.m_time
;
1886 inline bool wxDateTime::IsLaterThan(const wxDateTime
& datetime
) const
1888 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1890 return m_time
> datetime
.m_time
;
1893 inline bool wxDateTime::IsStrictlyBetween(const wxDateTime
& t1
,
1894 const wxDateTime
& t2
) const
1896 // no need for assert, will be checked by the functions we call
1897 return IsLaterThan(t1
) && IsEarlierThan(t2
);
1900 inline bool wxDateTime::IsBetween(const wxDateTime
& t1
,
1901 const wxDateTime
& t2
) const
1903 // no need for assert, will be checked by the functions we call
1904 return IsEqualTo(t1
) || IsEqualTo(t2
) || IsStrictlyBetween(t1
, t2
);
1907 inline bool wxDateTime::IsSameDate(const wxDateTime
& dt
) const
1912 return tm1
.year
== tm2
.year
&&
1913 tm1
.mon
== tm2
.mon
&&
1914 tm1
.mday
== tm2
.mday
;
1917 inline bool wxDateTime::IsSameTime(const wxDateTime
& dt
) const
1919 // notice that we can't do something like this:
1921 // m_time % MILLISECONDS_PER_DAY == dt.m_time % MILLISECONDS_PER_DAY
1923 // because we have also to deal with (possibly) different DST settings!
1927 return tm1
.hour
== tm2
.hour
&&
1928 tm1
.min
== tm2
.min
&&
1929 tm1
.sec
== tm2
.sec
&&
1930 tm1
.msec
== tm2
.msec
;
1933 inline bool wxDateTime::IsEqualUpTo(const wxDateTime
& dt
,
1934 const wxTimeSpan
& ts
) const
1936 return IsBetween(dt
.Subtract(ts
), dt
.Add(ts
));
1939 // ----------------------------------------------------------------------------
1940 // wxDateTime arithmetics
1941 // ----------------------------------------------------------------------------
1943 inline wxDateTime
wxDateTime::Add(const wxTimeSpan
& diff
) const
1945 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1947 return wxDateTime(m_time
+ diff
.GetValue());
1950 inline wxDateTime
& wxDateTime::Add(const wxTimeSpan
& diff
)
1952 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1954 m_time
+= diff
.GetValue();
1959 inline wxDateTime
& wxDateTime::operator+=(const wxTimeSpan
& diff
)
1964 inline wxDateTime
wxDateTime::Subtract(const wxTimeSpan
& diff
) const
1966 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1968 return wxDateTime(m_time
- diff
.GetValue());
1971 inline wxDateTime
& wxDateTime::Subtract(const wxTimeSpan
& diff
)
1973 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1975 m_time
-= diff
.GetValue();
1980 inline wxDateTime
& wxDateTime::operator-=(const wxTimeSpan
& diff
)
1982 return Subtract(diff
);
1985 inline wxTimeSpan
wxDateTime::Subtract(const wxDateTime
& datetime
) const
1987 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1989 return wxTimeSpan(GetValue() - datetime
.GetValue());
1992 inline wxTimeSpan
wxDateTime::operator-(const wxDateTime
& dt2
) const
1994 return this->Subtract(dt2
);
1997 inline wxDateTime
wxDateTime::Add(const wxDateSpan
& diff
) const
1999 return wxDateTime(*this).Add(diff
);
2002 inline wxDateTime
& wxDateTime::Subtract(const wxDateSpan
& diff
)
2004 return Add(diff
.Negate());
2007 inline wxDateTime
wxDateTime::Subtract(const wxDateSpan
& diff
) const
2009 return wxDateTime(*this).Subtract(diff
);
2012 inline wxDateTime
& wxDateTime::operator-=(const wxDateSpan
& diff
)
2014 return Subtract(diff
);
2017 inline wxDateTime
& wxDateTime::operator+=(const wxDateSpan
& diff
)
2022 // ----------------------------------------------------------------------------
2023 // wxDateTime and timezones
2024 // ----------------------------------------------------------------------------
2027 wxDateTime::ToTimezone(const wxDateTime::TimeZone
& tz
, bool noDST
) const
2029 MODIFY_AND_RETURN( MakeTimezone(tz
, noDST
) );
2033 wxDateTime::FromTimezone(const wxDateTime::TimeZone
& tz
, bool noDST
) const
2035 MODIFY_AND_RETURN( MakeFromTimezone(tz
, noDST
) );
2038 // ----------------------------------------------------------------------------
2039 // wxTimeSpan construction
2040 // ----------------------------------------------------------------------------
2042 inline wxTimeSpan::wxTimeSpan(long hours
,
2045 wxLongLong milliseconds
)
2047 // assign first to avoid precision loss
2054 m_diff
+= milliseconds
;
2057 // ----------------------------------------------------------------------------
2058 // wxTimeSpan accessors
2059 // ----------------------------------------------------------------------------
2061 inline wxLongLong
wxTimeSpan::GetSeconds() const
2063 return m_diff
/ 1000l;
2066 inline int wxTimeSpan::GetMinutes() const
2068 // explicit cast to int suppresses a warning with CodeWarrior and possibly
2069 // others (changing the return type to long from int is impossible in 2.8)
2070 return (int)((GetSeconds() / 60l).GetLo());
2073 inline int wxTimeSpan::GetHours() const
2075 return GetMinutes() / 60;
2078 inline int wxTimeSpan::GetDays() const
2080 return GetHours() / 24;
2083 inline int wxTimeSpan::GetWeeks() const
2085 return GetDays() / 7;
2088 // ----------------------------------------------------------------------------
2089 // wxTimeSpan arithmetics
2090 // ----------------------------------------------------------------------------
2092 inline wxTimeSpan
wxTimeSpan::Add(const wxTimeSpan
& diff
) const
2094 return wxTimeSpan(m_diff
+ diff
.GetValue());
2097 inline wxTimeSpan
& wxTimeSpan::Add(const wxTimeSpan
& diff
)
2099 m_diff
+= diff
.GetValue();
2104 inline wxTimeSpan
wxTimeSpan::Subtract(const wxTimeSpan
& diff
) const
2106 return wxTimeSpan(m_diff
- diff
.GetValue());
2109 inline wxTimeSpan
& wxTimeSpan::Subtract(const wxTimeSpan
& diff
)
2111 m_diff
-= diff
.GetValue();
2116 inline wxTimeSpan
& wxTimeSpan::Multiply(int n
)
2123 inline wxTimeSpan
wxTimeSpan::Multiply(int n
) const
2125 return wxTimeSpan(m_diff
* (long)n
);
2128 inline wxTimeSpan
wxTimeSpan::Abs() const
2130 return wxTimeSpan(GetValue().Abs());
2133 inline bool wxTimeSpan::IsEqualTo(const wxTimeSpan
& ts
) const
2135 return GetValue() == ts
.GetValue();
2138 inline bool wxTimeSpan::IsLongerThan(const wxTimeSpan
& ts
) const
2140 return GetValue().Abs() > ts
.GetValue().Abs();
2143 inline bool wxTimeSpan::IsShorterThan(const wxTimeSpan
& ts
) const
2145 return GetValue().Abs() < ts
.GetValue().Abs();
2148 // ----------------------------------------------------------------------------
2150 // ----------------------------------------------------------------------------
2152 inline wxDateSpan
& wxDateSpan::operator+=(const wxDateSpan
& other
)
2154 m_years
+= other
.m_years
;
2155 m_months
+= other
.m_months
;
2156 m_weeks
+= other
.m_weeks
;
2157 m_days
+= other
.m_days
;
2162 inline wxDateSpan
& wxDateSpan::Add(const wxDateSpan
& other
)
2164 return *this += other
;
2167 inline wxDateSpan
wxDateSpan::Add(const wxDateSpan
& other
) const
2169 wxDateSpan
ds(*this);
2174 inline wxDateSpan
& wxDateSpan::Multiply(int factor
)
2184 inline wxDateSpan
wxDateSpan::Multiply(int factor
) const
2186 wxDateSpan
ds(*this);
2187 ds
.Multiply(factor
);
2191 inline wxDateSpan
wxDateSpan::Negate() const
2193 return wxDateSpan(-m_years
, -m_months
, -m_weeks
, -m_days
);
2196 inline wxDateSpan
& wxDateSpan::Neg()
2199 m_months
= -m_months
;
2206 inline wxDateSpan
& wxDateSpan::operator-=(const wxDateSpan
& other
)
2208 return *this += other
.Negate();
2211 inline wxDateSpan
& wxDateSpan::Subtract(const wxDateSpan
& other
)
2213 return *this -= other
;
2216 inline wxDateSpan
wxDateSpan::Subtract(const wxDateSpan
& other
) const
2218 wxDateSpan
ds(*this);
2223 #undef MILLISECONDS_PER_DAY
2225 #undef MODIFY_AND_RETURN
2227 // ============================================================================
2229 // ============================================================================
2231 // ----------------------------------------------------------------------------
2232 // wxTimeSpan operators
2233 // ----------------------------------------------------------------------------
2235 wxTimeSpan WXDLLIMPEXP_BASE
operator*(int n
, const wxTimeSpan
& ts
);
2237 // ----------------------------------------------------------------------------
2239 // ----------------------------------------------------------------------------
2241 wxDateSpan WXDLLIMPEXP_BASE
operator*(int n
, const wxDateSpan
& ds
);
2243 // ============================================================================
2244 // other helper functions
2245 // ============================================================================
2247 // ----------------------------------------------------------------------------
2248 // iteration helpers: can be used to write a for loop over enum variable like
2250 // for ( m = wxDateTime::Jan; m < wxDateTime::Inv_Month; wxNextMonth(m) )
2251 // ----------------------------------------------------------------------------
2253 WXDLLIMPEXP_BASE
void wxNextMonth(wxDateTime::Month
& m
);
2254 WXDLLIMPEXP_BASE
void wxPrevMonth(wxDateTime::Month
& m
);
2255 WXDLLIMPEXP_BASE
void wxNextWDay(wxDateTime::WeekDay
& wd
);
2256 WXDLLIMPEXP_BASE
void wxPrevWDay(wxDateTime::WeekDay
& wd
);
2258 #endif // wxUSE_DATETIME
2260 #endif // _WX_DATETIME_H