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
23 #include "wx/msw/wince/time.h"
26 #include <limits.h> // for INT_MIN
28 #include "wx/longlong.h"
30 class WXDLLIMPEXP_FWD_BASE wxDateTime
;
31 class WXDLLIMPEXP_FWD_BASE wxTimeSpan
;
32 class WXDLLIMPEXP_FWD_BASE wxDateSpan
;
34 #include "wx/dynarray.h"
36 // not all c-runtimes are based on 1/1/1970 being (time_t) 0
37 // set this to the corresponding value in seconds 1/1/1970 has on your
40 #if defined(__WXMAC__) && !defined(__DARWIN__) && __MSL__ < 0x6000
41 #define WX_TIME_BASE_OFFSET ( 2082844800L + 126144000L )
43 #define WX_TIME_BASE_OFFSET 0
48 * + 1. Time zones with minutes (make TimeZone a class)
49 * ? 2. getdate() function like under Solaris
50 * + 3. text conversion for wxDateSpan
51 * + 4. pluggable modules for the workdays calculations
52 * 5. wxDateTimeHolidayAuthority for Easter and other christian feasts
55 /* Two wrapper functions for thread safety */
56 #ifdef HAVE_LOCALTIME_R
57 #define wxLocaltime_r localtime_r
59 WXDLLIMPEXP_BASE
struct tm
*wxLocaltime_r(const time_t*, struct tm
*);
60 #if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
61 // On Windows, localtime _is_ threadsafe!
62 #warning using pseudo thread-safe wrapper for localtime to emulate localtime_r
67 #define wxGmtime_r gmtime_r
69 WXDLLIMPEXP_BASE
struct tm
*wxGmtime_r(const time_t*, struct tm
*);
70 #if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
71 // On Windows, gmtime _is_ threadsafe!
72 #warning using pseudo thread-safe wrapper for gmtime to emulate gmtime_r
77 The three (main) classes declared in this header represent:
79 1. An absolute moment in the time (wxDateTime)
80 2. A difference between two moments in the time, positive or negative
82 3. A logical difference between two dates expressed in
83 years/months/weeks/days (wxDateSpan)
85 The following arithmetic operations are permitted (all others are not):
90 wxDateTime + wxTimeSpan = wxDateTime
91 wxDateTime + wxDateSpan = wxDateTime
92 wxTimeSpan + wxTimeSpan = wxTimeSpan
93 wxDateSpan + wxDateSpan = wxDateSpan
97 wxDateTime - wxDateTime = wxTimeSpan
98 wxDateTime - wxTimeSpan = wxDateTime
99 wxDateTime - wxDateSpan = wxDateTime
100 wxTimeSpan - wxTimeSpan = wxTimeSpan
101 wxDateSpan - wxDateSpan = wxDateSpan
105 wxTimeSpan * number = wxTimeSpan
106 number * wxTimeSpan = wxTimeSpan
107 wxDateSpan * number = wxDateSpan
108 number * wxDateSpan = wxDateSpan
112 -wxTimeSpan = wxTimeSpan
113 -wxDateSpan = wxDateSpan
115 For each binary operation OP (+, -, *) we have the following operatorOP=() as
116 a method and the method with a symbolic name OPER (Add, Subtract, Multiply)
117 as a synonym for it and another const method with the same name which returns
118 the changed copy of the object and operatorOP() as a global function which is
119 implemented in terms of the const version of OPEN. For the unary - we have
120 operator-() as a method, Neg() as synonym for it and Negate() which returns
121 the copy of the object with the changed sign.
124 // an invalid/default date time object which may be used as the default
125 // argument for arguments of type wxDateTime; it is also returned by all
126 // functions returning wxDateTime on failure (this is why it is also called
127 // wxInvalidDateTime)
128 class WXDLLIMPEXP_FWD_BASE wxDateTime
;
130 extern WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxDefaultDateTimeFormat
;
131 extern WXDLLIMPEXP_DATA_BASE(const wxChar
*) wxDefaultTimeSpanFormat
;
132 extern WXDLLIMPEXP_DATA_BASE(const wxDateTime
) wxDefaultDateTime
;
134 #define wxInvalidDateTime wxDefaultDateTime
136 // ----------------------------------------------------------------------------
137 // wxDateTime represents an absolute moment in the time
138 // ----------------------------------------------------------------------------
140 class WXDLLIMPEXP_BASE wxDateTime
144 // ------------------------------------------------------------------------
146 // a small unsigned integer type for storing things like minutes,
147 // seconds &c. It should be at least short (i.e. not char) to contain
148 // the number of milliseconds - it may also be 'int' because there is
149 // no size penalty associated with it in our code, we don't store any
150 // data in this format
151 typedef unsigned short wxDateTime_t
;
154 // ------------------------------------------------------------------------
159 // the time in the current time zone
162 // zones from GMT (= Greenwhich Mean Time): they're guaranteed to be
163 // consequent numbers, so writing something like `GMT0 + offset' is
164 // safe if abs(offset) <= 12
166 // underscore stands for minus
167 GMT_12
, GMT_11
, GMT_10
, GMT_9
, GMT_8
, GMT_7
,
168 GMT_6
, GMT_5
, GMT_4
, GMT_3
, GMT_2
, GMT_1
,
170 GMT1
, GMT2
, GMT3
, GMT4
, GMT5
, GMT6
,
171 GMT7
, GMT8
, GMT9
, GMT10
, GMT11
, GMT12
, GMT13
,
172 // Note that GMT12 and GMT_12 are not the same: there is a difference
173 // of exactly one day between them
175 // some symbolic names for TZ
178 WET
= GMT0
, // Western Europe Time
179 WEST
= GMT1
, // Western Europe Summer Time
180 CET
= GMT1
, // Central Europe Time
181 CEST
= GMT2
, // Central Europe Summer Time
182 EET
= GMT2
, // Eastern Europe Time
183 EEST
= GMT3
, // Eastern Europe Summer Time
184 MSK
= GMT3
, // Moscow Time
185 MSD
= GMT4
, // Moscow Summer Time
188 AST
= GMT_4
, // Atlantic Standard Time
189 ADT
= GMT_3
, // Atlantic Daylight Time
190 EST
= GMT_5
, // Eastern Standard Time
191 EDT
= GMT_4
, // Eastern Daylight Saving Time
192 CST
= GMT_6
, // Central Standard Time
193 CDT
= GMT_5
, // Central Daylight Saving Time
194 MST
= GMT_7
, // Mountain Standard Time
195 MDT
= GMT_6
, // Mountain Daylight Saving Time
196 PST
= GMT_8
, // Pacific Standard Time
197 PDT
= GMT_7
, // Pacific Daylight Saving Time
198 HST
= GMT_10
, // Hawaiian Standard Time
199 AKST
= GMT_9
, // Alaska Standard Time
200 AKDT
= GMT_8
, // Alaska Daylight Saving Time
204 A_WST
= GMT8
, // Western Standard Time
205 A_CST
= GMT13
+ 1, // Central Standard Time (+9.5)
206 A_EST
= GMT10
, // Eastern Standard Time
207 A_ESST
= GMT11
, // Eastern Summer Time
210 NZST
= GMT12
, // Standard Time
211 NZDT
= GMT13
, // Daylight Saving Time
213 // TODO add more symbolic timezone names here
215 // Universal Coordinated Time = the new and politically correct name
220 // the calendar systems we know about: notice that it's valid (for
221 // this classes purpose anyhow) to work with any of these calendars
222 // even with the dates before the historical appearance of the
226 Gregorian
, // current calendar
227 Julian
// calendar in use since -45 until the 1582 (or later)
229 // TODO Hebrew, Chinese, Maya, ... (just kidding) (or then may be not?)
232 // these values only are used to identify the different dates of
233 // adoption of the Gregorian calendar (see IsGregorian())
235 // All data and comments taken verbatim from "The Calendar FAQ (v 2.0)"
236 // by Claus Tøndering, http://www.pip.dknet.dk/~c-t/calendar.html
237 // except for the comments "we take".
239 // Symbol "->" should be read as "was followed by" in the comments
241 enum GregorianAdoption
243 Gr_Unknown
, // no data for this country or it's too uncertain to use
244 Gr_Standard
, // on the day 0 of Gregorian calendar: 15 Oct 1582
246 Gr_Alaska
, // Oct 1867 when Alaska became part of the USA
247 Gr_Albania
, // Dec 1912
249 Gr_Austria
= Gr_Unknown
, // Different regions on different dates
250 Gr_Austria_Brixen
, // 5 Oct 1583 -> 16 Oct 1583
251 Gr_Austria_Salzburg
= Gr_Austria_Brixen
,
252 Gr_Austria_Tyrol
= Gr_Austria_Brixen
,
253 Gr_Austria_Carinthia
, // 14 Dec 1583 -> 25 Dec 1583
254 Gr_Austria_Styria
= Gr_Austria_Carinthia
,
256 Gr_Belgium
, // Then part of the Netherlands
258 Gr_Bulgaria
= Gr_Unknown
, // Unknown precisely (from 1915 to 1920)
259 Gr_Bulgaria_1
, // 18 Mar 1916 -> 1 Apr 1916
260 Gr_Bulgaria_2
, // 31 Mar 1916 -> 14 Apr 1916
261 Gr_Bulgaria_3
, // 3 Sep 1920 -> 17 Sep 1920
263 Gr_Canada
= Gr_Unknown
, // Different regions followed the changes in
264 // Great Britain or France
266 Gr_China
= Gr_Unknown
, // Different authorities say:
267 Gr_China_1
, // 18 Dec 1911 -> 1 Jan 1912
268 Gr_China_2
, // 18 Dec 1928 -> 1 Jan 1929
270 Gr_Czechoslovakia
, // (Bohemia and Moravia) 6 Jan 1584 -> 17 Jan 1584
271 Gr_Denmark
, // (including Norway) 18 Feb 1700 -> 1 Mar 1700
274 Gr_Finland
, // Then part of Sweden
276 Gr_France
, // 9 Dec 1582 -> 20 Dec 1582
277 Gr_France_Alsace
, // 4 Feb 1682 -> 16 Feb 1682
278 Gr_France_Lorraine
, // 16 Feb 1760 -> 28 Feb 1760
279 Gr_France_Strasbourg
, // February 1682
281 Gr_Germany
= Gr_Unknown
, // Different states on different dates:
282 Gr_Germany_Catholic
, // 1583-1585 (we take 1584)
283 Gr_Germany_Prussia
, // 22 Aug 1610 -> 2 Sep 1610
284 Gr_Germany_Protestant
, // 18 Feb 1700 -> 1 Mar 1700
286 Gr_GreatBritain
, // 2 Sep 1752 -> 14 Sep 1752 (use 'cal(1)')
288 Gr_Greece
, // 9 Mar 1924 -> 23 Mar 1924
289 Gr_Hungary
, // 21 Oct 1587 -> 1 Nov 1587
290 Gr_Ireland
= Gr_GreatBritain
,
291 Gr_Italy
= Gr_Standard
,
293 Gr_Japan
= Gr_Unknown
, // Different authorities say:
294 Gr_Japan_1
, // 19 Dec 1872 -> 1 Jan 1873
295 Gr_Japan_2
, // 19 Dec 1892 -> 1 Jan 1893
296 Gr_Japan_3
, // 18 Dec 1918 -> 1 Jan 1919
298 Gr_Latvia
, // 1915-1918 (we take 1915)
299 Gr_Lithuania
, // 1915
300 Gr_Luxemburg
, // 14 Dec 1582 -> 25 Dec 1582
301 Gr_Netherlands
= Gr_Belgium
, // (including Belgium) 1 Jan 1583
303 // this is too weird to take into account: the Gregorian calendar was
304 // introduced twice in Groningen, first time 28 Feb 1583 was followed
305 // by 11 Mar 1583, then it has gone back to Julian in the summer of
306 // 1584 and then 13 Dec 1700 -> 12 Jan 1701 - which is
307 // the date we take here
308 Gr_Netherlands_Groningen
, // 13 Dec 1700 -> 12 Jan 1701
309 Gr_Netherlands_Gelderland
, // 30 Jun 1700 -> 12 Jul 1700
310 Gr_Netherlands_Utrecht
, // (and Overijssel) 30 Nov 1700->12 Dec 1700
311 Gr_Netherlands_Friesland
, // (and Drenthe) 31 Dec 1700 -> 12 Jan 1701
313 Gr_Norway
= Gr_Denmark
, // Then part of Denmark
314 Gr_Poland
= Gr_Standard
,
315 Gr_Portugal
= Gr_Standard
,
316 Gr_Romania
, // 31 Mar 1919 -> 14 Apr 1919
317 Gr_Russia
, // 31 Jan 1918 -> 14 Feb 1918
318 Gr_Scotland
= Gr_GreatBritain
,
319 Gr_Spain
= Gr_Standard
,
321 // Sweden has a curious history. Sweden decided to make a gradual
322 // change from the Julian to the Gregorian calendar. By dropping every
323 // leap year from 1700 through 1740 the eleven superfluous days would
324 // be omitted and from 1 Mar 1740 they would be in sync with the
325 // Gregorian calendar. (But in the meantime they would be in sync with
328 // So 1700 (which should have been a leap year in the Julian calendar)
329 // was not a leap year in Sweden. However, by mistake 1704 and 1708
330 // became leap years. This left Sweden out of synchronisation with
331 // both the Julian and the Gregorian world, so they decided to go back
332 // to the Julian calendar. In order to do this, they inserted an extra
333 // day in 1712, making that year a double leap year! So in 1712,
334 // February had 30 days in Sweden.
336 // Later, in 1753, Sweden changed to the Gregorian calendar by
337 // dropping 11 days like everyone else.
338 Gr_Sweden
= Gr_Finland
, // 17 Feb 1753 -> 1 Mar 1753
340 Gr_Switzerland
= Gr_Unknown
,// Different cantons used different dates
341 Gr_Switzerland_Catholic
, // 1583, 1584 or 1597 (we take 1584)
342 Gr_Switzerland_Protestant
, // 31 Dec 1700 -> 12 Jan 1701
344 Gr_Turkey
, // 1 Jan 1927
345 Gr_USA
= Gr_GreatBritain
,
346 Gr_Wales
= Gr_GreatBritain
,
347 Gr_Yugoslavia
// 1919
350 // the country parameter is used so far for calculating the start and
351 // the end of DST period and for deciding whether the date is a work
354 // TODO move this to intl.h
356 // Required for WinCE
363 Country_Unknown
, // no special information for this country
364 Country_Default
, // set the default country with SetCountry() method
365 // or use the default country with any other
367 // TODO add more countries (for this we must know about DST and/or
368 // holidays for this country)
370 // Western European countries: we assume that they all follow the same
371 // DST rules (true or false?)
372 Country_WesternEurope_Start
,
373 Country_EEC
= Country_WesternEurope_Start
,
377 Country_WesternEurope_End
= UK
,
382 // symbolic names for the months
385 Jan
, Feb
, Mar
, Apr
, May
, Jun
, Jul
, Aug
, Sep
, Oct
, Nov
, Dec
, Inv_Month
388 // symbolic names for the weekdays
391 Sun
, Mon
, Tue
, Wed
, Thu
, Fri
, Sat
, Inv_WeekDay
394 // invalid value for the year
397 Inv_Year
= SHRT_MIN
// should hold in wxDateTime_t
400 // flags for GetWeekDayName and GetMonthName
403 Name_Full
= 0x01, // return full name
404 Name_Abbr
= 0x02 // return abbreviated name
407 // flags for GetWeekOfYear and GetWeekOfMonth
410 Default_First
, // Sunday_First for US, Monday_First for the rest
411 Monday_First
, // week starts with a Monday
412 Sunday_First
// week starts with a Sunday
416 // ------------------------------------------------------------------------
418 // a class representing a time zone: basicly, this is just an offset
419 // (in seconds) from GMT
420 class WXDLLIMPEXP_BASE TimeZone
424 TimeZone(wxDateTime_t offset
= 0) { m_offset
= offset
; }
426 long GetOffset() const { return m_offset
; }
429 // offset for this timezone from GMT in seconds
433 // standard struct tm is limited to the years from 1900 (because
434 // tm_year field is the offset from 1900), so we use our own struct
435 // instead to represent broken down time
437 // NB: this struct should always be kept normalized (i.e. mon should
438 // be < 12, 1 <= day <= 31 &c), so use AddMonths(), AddDays()
439 // instead of modifying the member fields directly!
440 struct WXDLLIMPEXP_BASE Tm
442 wxDateTime_t msec
, sec
, min
, hour
, mday
;
446 // default ctor inits the object to an invalid value
449 // ctor from struct tm and the timezone
450 Tm(const struct tm
& tm
, const TimeZone
& tz
);
452 // check that the given date/time is valid (in Gregorian calendar)
453 bool IsValid() const;
456 WeekDay
GetWeekDay() // not const because wday may be changed
458 if ( wday
== Inv_WeekDay
)
461 return (WeekDay
)wday
;
464 // add the given number of months to the date keeping it normalized
465 void AddMonths(int monDiff
);
467 // add the given number of months to the date keeping it normalized
468 void AddDays(int dayDiff
);
471 // compute the weekday from other fields
472 void ComputeWeekDay();
474 // the timezone we correspond to
477 // these values can't be accessed directly because they're not always
478 // computed and we calculate them on demand
479 wxDateTime_t wday
, yday
;
483 // ------------------------------------------------------------------------
485 // set the current country
486 static void SetCountry(Country country
);
487 // get the current country
488 static Country
GetCountry();
490 // return true if the country is a West European one (in practice,
491 // this means that the same DST rules as for EEC apply)
492 static bool IsWestEuropeanCountry(Country country
= Country_Default
);
494 // return the current year
495 static int GetCurrentYear(Calendar cal
= Gregorian
);
497 // convert the year as returned by wxDateTime::GetYear() to a year
498 // suitable for BC/AD notation. The difference is that BC year 1
499 // corresponds to the year 0 (while BC year 0 didn't exist) and AD
500 // year N is just year N.
501 static int ConvertYearToBC(int year
);
503 // return the current month
504 static Month
GetCurrentMonth(Calendar cal
= Gregorian
);
506 // returns true if the given year is a leap year in the given calendar
507 static bool IsLeapYear(int year
= Inv_Year
, Calendar cal
= Gregorian
);
509 // get the century (19 for 1999, 20 for 2000 and -5 for 492 BC)
510 static int GetCentury(int year
);
512 // returns the number of days in this year (356 or 355 for Gregorian
513 // calendar usually :-)
514 static wxDateTime_t
GetNumberOfDays(int year
, Calendar cal
= Gregorian
);
516 // get the number of the days in the given month (default value for
517 // the year means the current one)
518 static wxDateTime_t
GetNumberOfDays(Month month
,
520 Calendar cal
= Gregorian
);
522 // get the full (default) or abbreviated month name in the current
523 // locale, returns empty string on error
524 static wxString
GetMonthName(Month month
,
525 NameFlags flags
= Name_Full
);
527 // get the full (default) or abbreviated weekday name in the current
528 // locale, returns empty string on error
529 static wxString
GetWeekDayName(WeekDay weekday
,
530 NameFlags flags
= Name_Full
);
532 // get the AM and PM strings in the current locale (may be empty)
533 static void GetAmPmStrings(wxString
*am
, wxString
*pm
);
535 // return true if the given country uses DST for this year
536 static bool IsDSTApplicable(int year
= Inv_Year
,
537 Country country
= Country_Default
);
539 // get the beginning of DST for this year, will return invalid object
540 // if no DST applicable in this year. The default value of the
541 // parameter means to take the current year.
542 static wxDateTime
GetBeginDST(int year
= Inv_Year
,
543 Country country
= Country_Default
);
544 // get the end of DST for this year, will return invalid object
545 // if no DST applicable in this year. The default value of the
546 // parameter means to take the current year.
547 static wxDateTime
GetEndDST(int year
= Inv_Year
,
548 Country country
= Country_Default
);
550 // return the wxDateTime object for the current time
551 static inline wxDateTime
Now();
553 // return the wxDateTime object for the current time with millisecond
554 // precision (if available on this platform)
555 static wxDateTime
UNow();
557 // return the wxDateTime object for today midnight: i.e. as Now() but
558 // with time set to 0
559 static inline wxDateTime
Today();
561 // constructors: you should test whether the constructor succeeded with
562 // IsValid() function. The values Inv_Month and Inv_Year for the
563 // parameters mean take current month and/or year values.
564 // ------------------------------------------------------------------------
566 // default ctor does not initialize the object, use Set()!
567 wxDateTime() { m_time
= wxLongLong(wxINT32_MIN
, 0); }
569 // from time_t: seconds since the Epoch 00:00:00 UTC, Jan 1, 1970)
570 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
571 // VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
572 inline wxDateTime(time_t timet
);
574 // from broken down time/date (only for standard Unix range)
575 inline wxDateTime(const struct tm
& tm
);
576 // from broken down time/date (any range)
577 inline wxDateTime(const Tm
& tm
);
579 // from JDN (beware of rounding errors)
580 inline wxDateTime(double jdn
);
582 // from separate values for each component, date set to today
583 inline wxDateTime(wxDateTime_t hour
,
584 wxDateTime_t minute
= 0,
585 wxDateTime_t second
= 0,
586 wxDateTime_t millisec
= 0);
587 // from separate values for each component with explicit date
588 inline wxDateTime(wxDateTime_t day
, // day of the month
590 int year
= Inv_Year
, // 1999, not 99 please!
591 wxDateTime_t hour
= 0,
592 wxDateTime_t minute
= 0,
593 wxDateTime_t second
= 0,
594 wxDateTime_t millisec
= 0);
596 // default copy ctor ok
600 // assignment operators and Set() functions: all non const methods return
601 // the reference to this object. IsValid() should be used to test whether
602 // the function succeeded.
603 // ------------------------------------------------------------------------
605 // set to the current time
606 inline wxDateTime
& SetToCurrent();
608 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
609 // VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
610 // set to given time_t value
611 inline wxDateTime
& Set(time_t timet
);
614 // set to given broken down time/date
615 wxDateTime
& Set(const struct tm
& tm
);
617 // set to given broken down time/date
618 inline wxDateTime
& Set(const Tm
& tm
);
620 // set to given JDN (beware of rounding errors)
621 wxDateTime
& Set(double jdn
);
623 // set to given time, date = today
624 wxDateTime
& Set(wxDateTime_t hour
,
625 wxDateTime_t minute
= 0,
626 wxDateTime_t second
= 0,
627 wxDateTime_t millisec
= 0);
629 // from separate values for each component with explicit date
630 // (defaults for month and year are the current values)
631 wxDateTime
& Set(wxDateTime_t day
,
633 int year
= Inv_Year
, // 1999, not 99 please!
634 wxDateTime_t hour
= 0,
635 wxDateTime_t minute
= 0,
636 wxDateTime_t second
= 0,
637 wxDateTime_t millisec
= 0);
639 // resets time to 00:00:00, doesn't change the date
640 wxDateTime
& ResetTime();
642 // get the date part of this object only, i.e. the object which has the
643 // same date as this one but time of 00:00:00
644 wxDateTime
GetDateOnly() const;
646 // the following functions don't change the values of the other
647 // fields, i.e. SetMinute() won't change either hour or seconds value
650 wxDateTime
& SetYear(int year
);
652 wxDateTime
& SetMonth(Month month
);
653 // set the day of the month
654 wxDateTime
& SetDay(wxDateTime_t day
);
656 wxDateTime
& SetHour(wxDateTime_t hour
);
658 wxDateTime
& SetMinute(wxDateTime_t minute
);
660 wxDateTime
& SetSecond(wxDateTime_t second
);
662 wxDateTime
& SetMillisecond(wxDateTime_t millisecond
);
664 // assignment operator from time_t
665 wxDateTime
& operator=(time_t timet
) { return Set(timet
); }
667 // assignment operator from broken down time/date
668 wxDateTime
& operator=(const struct tm
& tm
) { return Set(tm
); }
670 // assignment operator from broken down time/date
671 wxDateTime
& operator=(const Tm
& tm
) { return Set(tm
); }
673 // default assignment operator is ok
675 // calendar calculations (functions which set the date only leave the time
676 // unchanged, e.g. don't explictly zero it): SetXXX() functions modify the
677 // object itself, GetXXX() ones return a new object.
678 // ------------------------------------------------------------------------
680 // set to the given week day in the same week as this one
681 wxDateTime
& SetToWeekDayInSameWeek(WeekDay weekday
,
682 WeekFlags flags
= Monday_First
);
683 inline wxDateTime
GetWeekDayInSameWeek(WeekDay weekday
,
684 WeekFlags flags
= Monday_First
) const;
686 // set to the next week day following this one
687 wxDateTime
& SetToNextWeekDay(WeekDay weekday
);
688 inline wxDateTime
GetNextWeekDay(WeekDay weekday
) const;
690 // set to the previous week day before this one
691 wxDateTime
& SetToPrevWeekDay(WeekDay weekday
);
692 inline wxDateTime
GetPrevWeekDay(WeekDay weekday
) const;
694 // set to Nth occurence of given weekday in the given month of the
695 // given year (time is set to 0), return true on success and false on
696 // failure. n may be positive (1..5) or negative to count from the end
697 // of the month (see helper function SetToLastWeekDay())
698 bool SetToWeekDay(WeekDay weekday
,
700 Month month
= Inv_Month
,
701 int year
= Inv_Year
);
702 inline wxDateTime
GetWeekDay(WeekDay weekday
,
704 Month month
= Inv_Month
,
705 int year
= Inv_Year
) const;
707 // sets to the last weekday in the given month, year
708 inline bool SetToLastWeekDay(WeekDay weekday
,
709 Month month
= Inv_Month
,
710 int year
= Inv_Year
);
711 inline wxDateTime
GetLastWeekDay(WeekDay weekday
,
712 Month month
= Inv_Month
,
713 int year
= Inv_Year
);
715 #if WXWIN_COMPATIBILITY_2_6
716 // sets the date to the given day of the given week in the year,
717 // returns true on success and false if given date doesn't exist (e.g.
720 // these functions are badly defined as they're not the reverse of
721 // GetWeekOfYear(), use SetToTheWeekOfYear() instead
722 wxDEPRECATED( bool SetToTheWeek(wxDateTime_t numWeek
,
723 WeekDay weekday
= Mon
,
724 WeekFlags flags
= Monday_First
) );
725 wxDEPRECATED( wxDateTime
GetWeek(wxDateTime_t numWeek
,
726 WeekDay weekday
= Mon
,
727 WeekFlags flags
= Monday_First
) const );
728 #endif // WXWIN_COMPATIBILITY_2_6
730 // returns the date corresponding to the given week day of the given
731 // week (in ISO notation) of the specified year
732 static wxDateTime
SetToWeekOfYear(int year
,
733 wxDateTime_t numWeek
,
734 WeekDay weekday
= Mon
);
736 // sets the date to the last day of the given (or current) month or the
737 // given (or current) year
738 wxDateTime
& SetToLastMonthDay(Month month
= Inv_Month
,
739 int year
= Inv_Year
);
740 inline wxDateTime
GetLastMonthDay(Month month
= Inv_Month
,
741 int year
= Inv_Year
) const;
743 // sets to the given year day (1..365 or 366)
744 wxDateTime
& SetToYearDay(wxDateTime_t yday
);
745 inline wxDateTime
GetYearDay(wxDateTime_t yday
) const;
747 // The definitions below were taken verbatim from
749 // http://www.capecod.net/~pbaum/date/date0.htm
751 // (Peter Baum's home page)
753 // definition: The Julian Day Number, Julian Day, or JD of a
754 // particular instant of time is the number of days and fractions of a
755 // day since 12 hours Universal Time (Greenwich mean noon) on January
756 // 1 of the year -4712, where the year is given in the Julian
757 // proleptic calendar. The idea of using this reference date was
758 // originally proposed by Joseph Scalizer in 1582 to count years but
759 // it was modified by 19th century astronomers to count days. One
760 // could have equivalently defined the reference time to be noon of
761 // November 24, -4713 if were understood that Gregorian calendar rules
762 // were applied. Julian days are Julian Day Numbers and are not to be
763 // confused with Julian dates.
765 // definition: The Rata Die number is a date specified as the number
766 // of days relative to a base date of December 31 of the year 0. Thus
767 // January 1 of the year 1 is Rata Die day 1.
769 // get the Julian Day number (the fractional part specifies the time of
770 // the day, related to noon - beware of rounding errors!)
771 double GetJulianDayNumber() const;
772 double GetJDN() const { return GetJulianDayNumber(); }
774 // get the Modified Julian Day number: it is equal to JDN - 2400000.5
775 // and so integral MJDs correspond to the midnights (and not noons).
776 // MJD 0 is Nov 17, 1858
777 double GetModifiedJulianDayNumber() const { return GetJDN() - 2400000.5; }
778 double GetMJD() const { return GetModifiedJulianDayNumber(); }
780 // get the Rata Die number
781 double GetRataDie() const;
783 // TODO algorithms for calculating some important dates, such as
784 // religious holidays (Easter...) or moon/solar eclipses? Some
785 // algorithms can be found in the calendar FAQ
788 // Timezone stuff: a wxDateTime object constructed using given
789 // day/month/year/hour/min/sec values is interpreted as this moment in
790 // local time. Using the functions below, it may be converted to another
791 // time zone (e.g., the Unix epoch is wxDateTime(1, Jan, 1970).ToGMT()).
793 // These functions try to handle DST internally, but there is no magical
794 // way to know all rules for it in all countries in the world, so if the
795 // program can handle it itself (or doesn't want to handle it at all for
796 // whatever reason), the DST handling can be disabled with noDST.
797 // ------------------------------------------------------------------------
799 // transform to any given timezone
800 inline wxDateTime
ToTimezone(const TimeZone
& tz
, bool noDST
= false) const;
801 wxDateTime
& MakeTimezone(const TimeZone
& tz
, bool noDST
= false);
803 // interpret current value as being in another timezone and transform
805 inline wxDateTime
FromTimezone(const TimeZone
& tz
, bool noDST
= false) const;
806 wxDateTime
& MakeFromTimezone(const TimeZone
& tz
, bool noDST
= false);
808 // transform to/from GMT/UTC
809 wxDateTime
ToUTC(bool noDST
= false) const { return ToTimezone(UTC
, noDST
); }
810 wxDateTime
& MakeUTC(bool noDST
= false) { return MakeTimezone(UTC
, noDST
); }
812 wxDateTime
ToGMT(bool noDST
= false) const { return ToUTC(noDST
); }
813 wxDateTime
& MakeGMT(bool noDST
= false) { return MakeUTC(noDST
); }
815 wxDateTime
FromUTC(bool noDST
= false) const
816 { return FromTimezone(UTC
, noDST
); }
817 wxDateTime
& MakeFromUTC(bool noDST
= false)
818 { return MakeFromTimezone(UTC
, noDST
); }
820 // is daylight savings time in effect at this moment according to the
821 // rules of the specified country?
823 // Return value is > 0 if DST is in effect, 0 if it is not and -1 if
824 // the information is not available (this is compatible with ANSI C)
825 int IsDST(Country country
= Country_Default
) const;
828 // accessors: many of them take the timezone parameter which indicates the
829 // timezone for which to make the calculations and the default value means
830 // to do it for the current timezone of this machine (even if the function
831 // only operates with the date it's necessary because a date may wrap as
832 // result of timezone shift)
833 // ------------------------------------------------------------------------
835 // is the date valid?
836 inline bool IsValid() const { return m_time
!= wxInvalidDateTime
.m_time
; }
838 // get the broken down date/time representation in the given timezone
840 // If you wish to get several time components (day, month and year),
841 // consider getting the whole Tm strcuture first and retrieving the
842 // value from it - this is much more efficient
843 Tm
GetTm(const TimeZone
& tz
= Local
) const;
845 // get the number of seconds since the Unix epoch - returns (time_t)-1
846 // if the value is out of range
847 inline time_t GetTicks() const;
849 // get the century, same as GetCentury(GetYear())
850 int GetCentury(const TimeZone
& tz
= Local
) const
851 { return GetCentury(GetYear(tz
)); }
852 // get the year (returns Inv_Year if date is invalid)
853 int GetYear(const TimeZone
& tz
= Local
) const
854 { return GetTm(tz
).year
; }
855 // get the month (Inv_Month if date is invalid)
856 Month
GetMonth(const TimeZone
& tz
= Local
) const
857 { return (Month
)GetTm(tz
).mon
; }
858 // get the month day (in 1..31 range, 0 if date is invalid)
859 wxDateTime_t
GetDay(const TimeZone
& tz
= Local
) const
860 { return GetTm(tz
).mday
; }
861 // get the day of the week (Inv_WeekDay if date is invalid)
862 WeekDay
GetWeekDay(const TimeZone
& tz
= Local
) const
863 { return GetTm(tz
).GetWeekDay(); }
864 // get the hour of the day
865 wxDateTime_t
GetHour(const TimeZone
& tz
= Local
) const
866 { return GetTm(tz
).hour
; }
868 wxDateTime_t
GetMinute(const TimeZone
& tz
= Local
) const
869 { return GetTm(tz
).min
; }
871 wxDateTime_t
GetSecond(const TimeZone
& tz
= Local
) const
872 { return GetTm(tz
).sec
; }
874 wxDateTime_t
GetMillisecond(const TimeZone
& tz
= Local
) const
875 { return GetTm(tz
).msec
; }
877 // get the day since the year start (1..366, 0 if date is invalid)
878 wxDateTime_t
GetDayOfYear(const TimeZone
& tz
= Local
) const;
879 // get the week number since the year start (1..52 or 53, 0 if date is
881 wxDateTime_t
GetWeekOfYear(WeekFlags flags
= Monday_First
,
882 const TimeZone
& tz
= Local
) const;
883 // get the week number since the month start (1..5, 0 if date is
885 wxDateTime_t
GetWeekOfMonth(WeekFlags flags
= Monday_First
,
886 const TimeZone
& tz
= Local
) const;
888 // is this date a work day? This depends on a country, of course,
889 // because the holidays are different in different countries
890 bool IsWorkDay(Country country
= Country_Default
) const;
892 // is this date later than Gregorian calendar introduction for the
893 // given country (see enum GregorianAdoption)?
895 // NB: this function shouldn't be considered as absolute authority in
896 // the matter. Besides, for some countries the exact date of
897 // adoption of the Gregorian calendar is simply unknown.
898 bool IsGregorianDate(GregorianAdoption country
= Gr_Standard
) const;
900 // dos date and time format
901 // ------------------------------------------------------------------------
903 // set from the DOS packed format
904 wxDateTime
& SetFromDOS(unsigned long ddt
);
906 // pack the date in DOS format
907 unsigned long GetAsDOS() const;
909 // comparison (see also functions below for operator versions)
910 // ------------------------------------------------------------------------
912 // returns true if the two moments are strictly identical
913 inline bool IsEqualTo(const wxDateTime
& datetime
) const;
915 // returns true if the date is strictly earlier than the given one
916 inline bool IsEarlierThan(const wxDateTime
& datetime
) const;
918 // returns true if the date is strictly later than the given one
919 inline bool IsLaterThan(const wxDateTime
& datetime
) const;
921 // returns true if the date is strictly in the given range
922 inline bool IsStrictlyBetween(const wxDateTime
& t1
,
923 const wxDateTime
& t2
) const;
925 // returns true if the date is in the given range
926 inline bool IsBetween(const wxDateTime
& t1
, const wxDateTime
& t2
) const;
928 // do these two objects refer to the same date?
929 inline bool IsSameDate(const wxDateTime
& dt
) const;
931 // do these two objects have the same time?
932 inline bool IsSameTime(const wxDateTime
& dt
) const;
934 // are these two objects equal up to given timespan?
935 inline bool IsEqualUpTo(const wxDateTime
& dt
, const wxTimeSpan
& ts
) const;
937 inline bool operator<(const wxDateTime
& dt
) const
939 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
940 return GetValue() < dt
.GetValue();
943 inline bool operator<=(const wxDateTime
& dt
) const
945 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
946 return GetValue() <= dt
.GetValue();
949 inline bool operator>(const wxDateTime
& dt
) const
951 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
952 return GetValue() > dt
.GetValue();
955 inline bool operator>=(const wxDateTime
& dt
) const
957 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
958 return GetValue() >= dt
.GetValue();
961 inline bool operator==(const wxDateTime
& dt
) const
963 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
964 return GetValue() == dt
.GetValue();
967 inline bool operator!=(const wxDateTime
& dt
) const
969 wxASSERT_MSG( IsValid() && dt
.IsValid(), _T("invalid wxDateTime") );
970 return GetValue() != dt
.GetValue();
973 // arithmetics with dates (see also below for more operators)
974 // ------------------------------------------------------------------------
976 // return the sum of the date with a time span (positive or negative)
977 inline wxDateTime
Add(const wxTimeSpan
& diff
) const;
978 // add a time span (positive or negative)
979 inline wxDateTime
& Add(const wxTimeSpan
& diff
);
980 // add a time span (positive or negative)
981 inline wxDateTime
& operator+=(const wxTimeSpan
& diff
);
982 inline wxDateTime
operator+(const wxTimeSpan
& ts
) const
984 wxDateTime
dt(*this);
989 // return the difference of the date with a time span
990 inline wxDateTime
Subtract(const wxTimeSpan
& diff
) const;
991 // subtract a time span (positive or negative)
992 inline wxDateTime
& Subtract(const wxTimeSpan
& diff
);
993 // subtract a time span (positive or negative)
994 inline wxDateTime
& operator-=(const wxTimeSpan
& diff
);
995 inline wxDateTime
operator-(const wxTimeSpan
& ts
) const
997 wxDateTime
dt(*this);
1002 // return the sum of the date with a date span
1003 inline wxDateTime
Add(const wxDateSpan
& diff
) const;
1004 // add a date span (positive or negative)
1005 wxDateTime
& Add(const wxDateSpan
& diff
);
1006 // add a date span (positive or negative)
1007 inline wxDateTime
& operator+=(const wxDateSpan
& diff
);
1008 inline wxDateTime
operator+(const wxDateSpan
& ds
) const
1010 wxDateTime
dt(*this);
1015 // return the difference of the date with a date span
1016 inline wxDateTime
Subtract(const wxDateSpan
& diff
) const;
1017 // subtract a date span (positive or negative)
1018 inline wxDateTime
& Subtract(const wxDateSpan
& diff
);
1019 // subtract a date span (positive or negative)
1020 inline wxDateTime
& operator-=(const wxDateSpan
& diff
);
1021 inline wxDateTime
operator-(const wxDateSpan
& ds
) const
1023 wxDateTime
dt(*this);
1028 // return the difference between two dates
1029 inline wxTimeSpan
Subtract(const wxDateTime
& dt
) const;
1030 inline wxTimeSpan
operator-(const wxDateTime
& dt2
) const;
1032 // conversion to/from text: all conversions from text return the pointer to
1033 // the next character following the date specification (i.e. the one where
1034 // the scan had to stop) or NULL on failure.
1035 // ------------------------------------------------------------------------
1037 // parse a string in RFC 822 format (found e.g. in mail headers and
1038 // having the form "Wed, 10 Feb 1999 19:07:07 +0100")
1039 const wxChar
*ParseRfc822Date(const wxChar
* date
);
1040 // parse a date/time in the given format (see strptime(3)), fill in
1041 // the missing (in the string) fields with the values of dateDef (by
1042 // default, they will not change if they had valid values or will
1043 // default to Today() otherwise)
1044 const wxChar
*ParseFormat(const wxChar
*date
,
1045 const wxString
& format
= wxDefaultDateTimeFormat
,
1046 const wxDateTime
& dateDef
= wxDefaultDateTime
);
1047 // parse a string containing the date/time in "free" format, this
1048 // function will try to make an educated guess at the string contents
1049 const wxChar
*ParseDateTime(const wxChar
*datetime
);
1050 // parse a string containing the date only in "free" format (less
1051 // flexible than ParseDateTime)
1052 const wxChar
*ParseDate(const wxChar
*date
);
1053 // parse a string containing the time only in "free" format
1054 const wxChar
*ParseTime(const wxChar
*time
);
1056 // this function accepts strftime()-like format string (default
1057 // argument corresponds to the preferred date and time representation
1058 // for the current locale) and returns the string containing the
1059 // resulting text representation
1060 wxString
Format(const wxString
& format
= wxDefaultDateTimeFormat
,
1061 const TimeZone
& tz
= Local
) const;
1062 // preferred date representation for the current locale
1063 wxString
FormatDate() const { return Format(_T("%x")); }
1064 // preferred time representation for the current locale
1065 wxString
FormatTime() const { return Format(_T("%X")); }
1066 // returns the string representing the date in ISO 8601 format
1068 wxString
FormatISODate() const { return Format(_T("%Y-%m-%d")); }
1069 // returns the string representing the time in ISO 8601 format
1071 wxString
FormatISOTime() const { return Format(_T("%H:%M:%S")); }
1074 // ------------------------------------------------------------------------
1076 // construct from internal representation
1077 wxDateTime(const wxLongLong
& time
) { m_time
= time
; }
1079 // get the internal representation
1080 inline wxLongLong
GetValue() const;
1082 // a helper function to get the current time_t
1083 static time_t GetTimeNow() { return time((time_t *)NULL
); }
1085 // another one to get the current time broken down
1086 static struct tm
*GetTmNow()
1088 time_t t
= GetTimeNow();
1089 return localtime(&t
);
1092 // get current time using thread-safe function
1093 static struct tm
*GetTmNow(struct tm
*tmstruct
);
1096 // the current country - as it's the same for all program objects (unless
1097 // it runs on a _really_ big cluster system :-), this is a static member:
1098 // see SetCountry() and GetCountry()
1099 static Country ms_country
;
1101 // this constant is used to transform a time_t value to the internal
1102 // representation, as time_t is in seconds and we use milliseconds it's
1104 static const long TIME_T_FACTOR
;
1106 // returns true if we fall in range in which we can use standard ANSI C
1108 inline bool IsInStdRange() const;
1110 // the internal representation of the time is the amount of milliseconds
1111 // elapsed since the origin which is set by convention to the UNIX/C epoch
1112 // value: the midnight of January 1, 1970 (UTC)
1116 // ----------------------------------------------------------------------------
1117 // This class contains a difference between 2 wxDateTime values, so it makes
1118 // sense to add it to wxDateTime and it is the result of subtraction of 2
1119 // objects of that class. See also wxDateSpan.
1120 // ----------------------------------------------------------------------------
1122 class WXDLLIMPEXP_BASE wxTimeSpan
1126 // ------------------------------------------------------------------------
1128 // return the timespan for the given number of milliseconds
1129 static wxTimeSpan
Milliseconds(wxLongLong ms
) { return wxTimeSpan(0, 0, 0, ms
); }
1130 static wxTimeSpan
Millisecond() { return Milliseconds(1); }
1132 // return the timespan for the given number of seconds
1133 static wxTimeSpan
Seconds(wxLongLong sec
) { return wxTimeSpan(0, 0, sec
); }
1134 static wxTimeSpan
Second() { return Seconds(1); }
1136 // return the timespan for the given number of minutes
1137 static wxTimeSpan
Minutes(long min
) { return wxTimeSpan(0, min
, 0 ); }
1138 static wxTimeSpan
Minute() { return Minutes(1); }
1140 // return the timespan for the given number of hours
1141 static wxTimeSpan
Hours(long hours
) { return wxTimeSpan(hours
, 0, 0); }
1142 static wxTimeSpan
Hour() { return Hours(1); }
1144 // return the timespan for the given number of days
1145 static wxTimeSpan
Days(long days
) { return Hours(24 * days
); }
1146 static wxTimeSpan
Day() { return Days(1); }
1148 // return the timespan for the given number of weeks
1149 static wxTimeSpan
Weeks(long days
) { return Days(7 * days
); }
1150 static wxTimeSpan
Week() { return Weeks(1); }
1152 // default ctor constructs the 0 time span
1155 // from separate values for each component, date set to 0 (hours are
1156 // not restricted to 0..24 range, neither are minutes, seconds or
1158 inline wxTimeSpan(long hours
,
1160 wxLongLong seconds
= 0,
1161 wxLongLong milliseconds
= 0);
1163 // default copy ctor is ok
1167 // arithmetics with time spans (see also below for more operators)
1168 // ------------------------------------------------------------------------
1170 // return the sum of two timespans
1171 inline wxTimeSpan
Add(const wxTimeSpan
& diff
) const;
1172 // add two timespans together
1173 inline wxTimeSpan
& Add(const wxTimeSpan
& diff
);
1174 // add two timespans together
1175 wxTimeSpan
& operator+=(const wxTimeSpan
& diff
) { return Add(diff
); }
1176 inline wxTimeSpan
operator+(const wxTimeSpan
& ts
) const
1178 return wxTimeSpan(GetValue() + ts
.GetValue());
1181 // return the difference of two timespans
1182 inline wxTimeSpan
Subtract(const wxTimeSpan
& diff
) const;
1183 // subtract another timespan
1184 inline wxTimeSpan
& Subtract(const wxTimeSpan
& diff
);
1185 // subtract another timespan
1186 wxTimeSpan
& operator-=(const wxTimeSpan
& diff
) { return Subtract(diff
); }
1187 inline wxTimeSpan
operator-(const wxTimeSpan
& ts
)
1189 return wxTimeSpan(GetValue() - ts
.GetValue());
1192 // multiply timespan by a scalar
1193 inline wxTimeSpan
Multiply(int n
) const;
1194 // multiply timespan by a scalar
1195 inline wxTimeSpan
& Multiply(int n
);
1196 // multiply timespan by a scalar
1197 wxTimeSpan
& operator*=(int n
) { return Multiply(n
); }
1198 inline wxTimeSpan
operator*(int n
) const
1200 return wxTimeSpan(*this).Multiply(n
);
1203 // return this timespan with opposite sign
1204 wxTimeSpan
Negate() const { return wxTimeSpan(-GetValue()); }
1205 // negate the value of the timespan
1206 wxTimeSpan
& Neg() { m_diff
= -GetValue(); return *this; }
1207 // negate the value of the timespan
1208 wxTimeSpan
& operator-() { return Neg(); }
1210 // return the absolute value of the timespan: does _not_ modify the
1212 inline wxTimeSpan
Abs() const;
1214 // there is intentionally no division because we don't want to
1215 // introduce rounding errors in time calculations
1217 // comparaison (see also operator versions below)
1218 // ------------------------------------------------------------------------
1220 // is the timespan null?
1221 bool IsNull() const { return m_diff
== 0l; }
1222 // returns true if the timespan is null
1223 bool operator!() const { return !IsNull(); }
1225 // is the timespan positive?
1226 bool IsPositive() const { return m_diff
> 0l; }
1228 // is the timespan negative?
1229 bool IsNegative() const { return m_diff
< 0l; }
1231 // are two timespans equal?
1232 inline bool IsEqualTo(const wxTimeSpan
& ts
) const;
1233 // compare two timestamps: works with the absolute values, i.e. -2
1234 // hours is longer than 1 hour. Also, it will return false if the
1235 // timespans are equal in absolute value.
1236 inline bool IsLongerThan(const wxTimeSpan
& ts
) const;
1237 // compare two timestamps: works with the absolute values, i.e. 1
1238 // hour is shorter than -2 hours. Also, it will return false if the
1239 // timespans are equal in absolute value.
1240 bool IsShorterThan(const wxTimeSpan
& t
) const { return !IsLongerThan(t
); }
1242 inline bool operator<(const wxTimeSpan
&ts
) const
1244 return GetValue() < ts
.GetValue();
1247 inline bool operator<=(const wxTimeSpan
&ts
) const
1249 return GetValue() <= ts
.GetValue();
1252 inline bool operator>(const wxTimeSpan
&ts
) const
1254 return GetValue() > ts
.GetValue();
1257 inline bool operator>=(const wxTimeSpan
&ts
) const
1259 return GetValue() >= ts
.GetValue();
1262 inline bool operator==(const wxTimeSpan
&ts
) const
1264 return GetValue() == ts
.GetValue();
1267 inline bool operator!=(const wxTimeSpan
&ts
) const
1269 return GetValue() != ts
.GetValue();
1272 // breaking into days, hours, minutes and seconds
1273 // ------------------------------------------------------------------------
1275 // get the max number of weeks in this timespan
1276 inline int GetWeeks() const;
1277 // get the max number of days in this timespan
1278 inline int GetDays() const;
1279 // get the max number of hours in this timespan
1280 inline int GetHours() const;
1281 // get the max number of minutes in this timespan
1282 inline int GetMinutes() const;
1283 // get the max number of seconds in this timespan
1284 inline wxLongLong
GetSeconds() const;
1285 // get the number of milliseconds in this timespan
1286 wxLongLong
GetMilliseconds() const { return m_diff
; }
1288 // conversion to text
1289 // ------------------------------------------------------------------------
1291 // this function accepts strftime()-like format string (default
1292 // argument corresponds to the preferred date and time representation
1293 // for the current locale) and returns the string containing the
1294 // resulting text representation. Notice that only some of format
1295 // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
1296 // minutes and seconds make sense, but not "PM/AM" string for example.
1297 wxString
Format(const wxString
& format
= wxDefaultTimeSpanFormat
) const;
1300 // ------------------------------------------------------------------------
1302 // construct from internal representation
1303 wxTimeSpan(const wxLongLong
& diff
) { m_diff
= diff
; }
1305 // get the internal representation
1306 wxLongLong
GetValue() const { return m_diff
; }
1309 // the (signed) time span in milliseconds
1313 // ----------------------------------------------------------------------------
1314 // This class is a "logical time span" and is useful for implementing program
1315 // logic for such things as "add one month to the date" which, in general,
1316 // doesn't mean to add 60*60*24*31 seconds to it, but to take the same date
1317 // the next month (to understand that this is indeed different consider adding
1318 // one month to Feb, 15 - we want to get Mar, 15, of course).
1320 // When adding a month to the date, all lesser components (days, hours, ...)
1321 // won't be changed unless the resulting date would be invalid: for example,
1322 // Jan 31 + 1 month will be Feb 28, not (non existing) Feb 31.
1324 // Because of this feature, adding and subtracting back again the same
1325 // wxDateSpan will *not*, in general give back the original date: Feb 28 - 1
1326 // month will be Jan 28, not Jan 31!
1328 // wxDateSpan can be either positive or negative. They may be
1329 // multiplied by scalars which multiply all deltas by the scalar: i.e. 2*(1
1330 // month and 1 day) is 2 months and 2 days. They can be added together and
1331 // with wxDateTime or wxTimeSpan, but the type of result is different for each
1334 // Beware about weeks: if you specify both weeks and days, the total number of
1335 // days added will be 7*weeks + days! See also GetTotalDays() function.
1337 // Equality operators are defined for wxDateSpans. Two datespans are equal if
1338 // they both give the same target date when added to *every* source date.
1339 // Thus wxDateSpan::Months(1) is not equal to wxDateSpan::Days(30), because
1340 // they not give the same date when added to 1 Feb. But wxDateSpan::Days(14) is
1341 // equal to wxDateSpan::Weeks(2)
1343 // Finally, notice that for adding hours, minutes &c you don't need this
1344 // class: wxTimeSpan will do the job because there are no subtleties
1345 // associated with those.
1346 // ----------------------------------------------------------------------------
1348 class WXDLLIMPEXP_BASE wxDateSpan
1352 // ------------------------------------------------------------------------
1354 // this many years/months/weeks/days
1355 wxDateSpan(int years
= 0, int months
= 0, int weeks
= 0, int days
= 0)
1363 // get an object for the given number of days
1364 static wxDateSpan
Days(int days
) { return wxDateSpan(0, 0, 0, days
); }
1365 static wxDateSpan
Day() { return Days(1); }
1367 // get an object for the given number of weeks
1368 static wxDateSpan
Weeks(int weeks
) { return wxDateSpan(0, 0, weeks
, 0); }
1369 static wxDateSpan
Week() { return Weeks(1); }
1371 // get an object for the given number of months
1372 static wxDateSpan
Months(int mon
) { return wxDateSpan(0, mon
, 0, 0); }
1373 static wxDateSpan
Month() { return Months(1); }
1375 // get an object for the given number of years
1376 static wxDateSpan
Years(int years
) { return wxDateSpan(years
, 0, 0, 0); }
1377 static wxDateSpan
Year() { return Years(1); }
1379 // default copy ctor is ok
1383 // accessors (all SetXXX() return the (modified) wxDateSpan object)
1384 // ------------------------------------------------------------------------
1386 // set number of years
1387 wxDateSpan
& SetYears(int n
) { m_years
= n
; return *this; }
1388 // set number of months
1389 wxDateSpan
& SetMonths(int n
) { m_months
= n
; return *this; }
1390 // set number of weeks
1391 wxDateSpan
& SetWeeks(int n
) { m_weeks
= n
; return *this; }
1392 // set number of days
1393 wxDateSpan
& SetDays(int n
) { m_days
= n
; return *this; }
1395 // get number of years
1396 int GetYears() const { return m_years
; }
1397 // get number of months
1398 int GetMonths() const { return m_months
; }
1399 // get number of weeks
1400 int GetWeeks() const { return m_weeks
; }
1401 // get number of days
1402 int GetDays() const { return m_days
; }
1403 // returns 7*GetWeeks() + GetDays()
1404 int GetTotalDays() const { return 7*m_weeks
+ m_days
; }
1406 // arithmetics with date spans (see also below for more operators)
1407 // ------------------------------------------------------------------------
1409 // return sum of two date spans
1410 inline wxDateSpan
Add(const wxDateSpan
& other
) const;
1411 // add another wxDateSpan to us
1412 inline wxDateSpan
& Add(const wxDateSpan
& other
);
1413 // add another wxDateSpan to us
1414 inline wxDateSpan
& operator+=(const wxDateSpan
& other
);
1415 inline wxDateSpan
operator+(const wxDateSpan
& ds
) const
1417 return wxDateSpan(GetYears() + ds
.GetYears(),
1418 GetMonths() + ds
.GetMonths(),
1419 GetWeeks() + ds
.GetWeeks(),
1420 GetDays() + ds
.GetDays());
1423 // return difference of two date spans
1424 inline wxDateSpan
Subtract(const wxDateSpan
& other
) const;
1425 // subtract another wxDateSpan from us
1426 inline wxDateSpan
& Subtract(const wxDateSpan
& other
);
1427 // subtract another wxDateSpan from us
1428 inline wxDateSpan
& operator-=(const wxDateSpan
& other
);
1429 inline wxDateSpan
operator-(const wxDateSpan
& ds
) const
1431 return wxDateSpan(GetYears() - ds
.GetYears(),
1432 GetMonths() - ds
.GetMonths(),
1433 GetWeeks() - ds
.GetWeeks(),
1434 GetDays() - ds
.GetDays());
1437 // return a copy of this time span with changed sign
1438 inline wxDateSpan
Negate() const;
1439 // inverse the sign of this timespan
1440 inline wxDateSpan
& Neg();
1441 // inverse the sign of this timespan
1442 wxDateSpan
& operator-() { return Neg(); }
1444 // return the date span proportional to this one with given factor
1445 inline wxDateSpan
Multiply(int factor
) const;
1446 // multiply all components by a (signed) number
1447 inline wxDateSpan
& Multiply(int factor
);
1448 // multiply all components by a (signed) number
1449 inline wxDateSpan
& operator*=(int factor
) { return Multiply(factor
); }
1450 inline wxDateSpan
operator*(int n
) const
1452 return wxDateSpan(*this).Multiply(n
);
1455 // ds1 == d2 if and only if for every wxDateTime t t + ds1 == t + ds2
1456 inline bool operator==(const wxDateSpan
& ds
) const
1458 return GetYears() == ds
.GetYears() &&
1459 GetMonths() == ds
.GetMonths() &&
1460 GetTotalDays() == ds
.GetTotalDays();
1463 inline bool operator!=(const wxDateSpan
& ds
) const
1465 return !(*this == ds
);
1475 // ----------------------------------------------------------------------------
1476 // wxDateTimeArray: array of dates.
1477 // ----------------------------------------------------------------------------
1479 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDateTime
, wxDateTimeArray
, WXDLLIMPEXP_BASE
);
1481 // ----------------------------------------------------------------------------
1482 // wxDateTimeHolidayAuthority: an object of this class will decide whether a
1483 // given date is a holiday and is used by all functions working with "work
1486 // NB: the base class is an ABC, derived classes must implement the pure
1487 // virtual methods to work with the holidays they correspond to.
1488 // ----------------------------------------------------------------------------
1490 class WXDLLIMPEXP_FWD_BASE wxDateTimeHolidayAuthority
;
1491 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxDateTimeHolidayAuthority
*,
1492 wxHolidayAuthoritiesArray
,
1493 class WXDLLIMPEXP_BASE
);
1495 class wxDateTimeHolidaysModule
;
1496 class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority
1498 friend class wxDateTimeHolidaysModule
;
1500 // returns true if the given date is a holiday
1501 static bool IsHoliday(const wxDateTime
& dt
);
1503 // fills the provided array with all holidays in the given range, returns
1504 // the number of them
1505 static size_t GetHolidaysInRange(const wxDateTime
& dtStart
,
1506 const wxDateTime
& dtEnd
,
1507 wxDateTimeArray
& holidays
);
1509 // clear the list of holiday authorities
1510 static void ClearAllAuthorities();
1512 // add a new holiday authority (the pointer will be deleted by
1513 // wxDateTimeHolidayAuthority)
1514 static void AddAuthority(wxDateTimeHolidayAuthority
*auth
);
1516 // the base class must have a virtual dtor
1517 virtual ~wxDateTimeHolidayAuthority();
1520 // this function is called to determine whether a given day is a holiday
1521 virtual bool DoIsHoliday(const wxDateTime
& dt
) const = 0;
1523 // this function should fill the array with all holidays between the two
1524 // given dates - it is implemented in the base class, but in a very
1525 // inefficient way (it just iterates over all days and uses IsHoliday() for
1526 // each of them), so it must be overridden in the derived class where the
1527 // base class version may be explicitly used if needed
1529 // returns the number of holidays in the given range and fills holidays
1531 virtual size_t DoGetHolidaysInRange(const wxDateTime
& dtStart
,
1532 const wxDateTime
& dtEnd
,
1533 wxDateTimeArray
& holidays
) const = 0;
1536 // all holiday authorities
1537 static wxHolidayAuthoritiesArray ms_authorities
;
1540 // the holidays for this class are all Saturdays and Sundays
1541 class WXDLLIMPEXP_BASE wxDateTimeWorkDays
: public wxDateTimeHolidayAuthority
1544 virtual bool DoIsHoliday(const wxDateTime
& dt
) const;
1545 virtual size_t DoGetHolidaysInRange(const wxDateTime
& dtStart
,
1546 const wxDateTime
& dtEnd
,
1547 wxDateTimeArray
& holidays
) const;
1550 // ============================================================================
1551 // inline functions implementation
1552 // ============================================================================
1554 // ----------------------------------------------------------------------------
1556 // ----------------------------------------------------------------------------
1558 #define MILLISECONDS_PER_DAY 86400000l
1560 // some broken compilers (HP-UX CC) refuse to compile the "normal" version, but
1561 // using a temp variable always might prevent other compilers from optimising
1562 // it away - hence use of this ugly macro
1564 #define MODIFY_AND_RETURN(op) return wxDateTime(*this).op
1566 #define MODIFY_AND_RETURN(op) wxDateTime dt(*this); dt.op; return dt
1569 // ----------------------------------------------------------------------------
1570 // wxDateTime construction
1571 // ----------------------------------------------------------------------------
1573 inline bool wxDateTime::IsInStdRange() const
1575 return m_time
>= 0l && (m_time
/ TIME_T_FACTOR
) < LONG_MAX
;
1579 inline wxDateTime
wxDateTime::Now()
1582 return wxDateTime(*GetTmNow(&tmstruct
));
1586 inline wxDateTime
wxDateTime::Today()
1588 wxDateTime
dt(Now());
1594 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
1595 inline wxDateTime
& wxDateTime::Set(time_t timet
)
1597 // assign first to avoid long multiplication overflow!
1598 m_time
= timet
- WX_TIME_BASE_OFFSET
;
1599 m_time
*= TIME_T_FACTOR
;
1605 inline wxDateTime
& wxDateTime::SetToCurrent()
1611 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
1612 inline wxDateTime::wxDateTime(time_t timet
)
1618 inline wxDateTime::wxDateTime(const struct tm
& tm
)
1623 inline wxDateTime::wxDateTime(const Tm
& tm
)
1628 inline wxDateTime::wxDateTime(double jdn
)
1633 inline wxDateTime
& wxDateTime::Set(const Tm
& tm
)
1635 wxASSERT_MSG( tm
.IsValid(), _T("invalid broken down date/time") );
1637 return Set(tm
.mday
, (Month
)tm
.mon
, tm
.year
,
1638 tm
.hour
, tm
.min
, tm
.sec
, tm
.msec
);
1641 inline wxDateTime::wxDateTime(wxDateTime_t hour
,
1642 wxDateTime_t minute
,
1643 wxDateTime_t second
,
1644 wxDateTime_t millisec
)
1646 Set(hour
, minute
, second
, millisec
);
1649 inline wxDateTime::wxDateTime(wxDateTime_t day
,
1653 wxDateTime_t minute
,
1654 wxDateTime_t second
,
1655 wxDateTime_t millisec
)
1657 Set(day
, month
, year
, hour
, minute
, second
, millisec
);
1660 // ----------------------------------------------------------------------------
1661 // wxDateTime accessors
1662 // ----------------------------------------------------------------------------
1664 inline wxLongLong
wxDateTime::GetValue() const
1666 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1671 inline time_t wxDateTime::GetTicks() const
1673 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1674 if ( !IsInStdRange() )
1679 return (time_t)((m_time
/ (long)TIME_T_FACTOR
).GetLo())+WX_TIME_BASE_OFFSET
;
1682 inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday
,
1686 return SetToWeekDay(weekday
, -1, month
, year
);
1690 wxDateTime::GetWeekDayInSameWeek(WeekDay weekday
,
1691 WeekFlags
WXUNUSED(flags
)) const
1693 MODIFY_AND_RETURN( SetToWeekDayInSameWeek(weekday
) );
1696 inline wxDateTime
wxDateTime::GetNextWeekDay(WeekDay weekday
) const
1698 MODIFY_AND_RETURN( SetToNextWeekDay(weekday
) );
1701 inline wxDateTime
wxDateTime::GetPrevWeekDay(WeekDay weekday
) const
1703 MODIFY_AND_RETURN( SetToPrevWeekDay(weekday
) );
1706 inline wxDateTime
wxDateTime::GetWeekDay(WeekDay weekday
,
1711 wxDateTime
dt(*this);
1713 return dt
.SetToWeekDay(weekday
, n
, month
, year
) ? dt
: wxInvalidDateTime
;
1716 inline wxDateTime
wxDateTime::GetLastWeekDay(WeekDay weekday
,
1720 wxDateTime
dt(*this);
1722 return dt
.SetToLastWeekDay(weekday
, month
, year
) ? dt
: wxInvalidDateTime
;
1725 inline wxDateTime
wxDateTime::GetLastMonthDay(Month month
, int year
) const
1727 MODIFY_AND_RETURN( SetToLastMonthDay(month
, year
) );
1730 inline wxDateTime
wxDateTime::GetYearDay(wxDateTime_t yday
) const
1732 MODIFY_AND_RETURN( SetToYearDay(yday
) );
1735 // ----------------------------------------------------------------------------
1736 // wxDateTime comparison
1737 // ----------------------------------------------------------------------------
1739 inline bool wxDateTime::IsEqualTo(const wxDateTime
& datetime
) const
1741 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1743 return m_time
== datetime
.m_time
;
1746 inline bool wxDateTime::IsEarlierThan(const wxDateTime
& datetime
) const
1748 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1750 return m_time
< datetime
.m_time
;
1753 inline bool wxDateTime::IsLaterThan(const wxDateTime
& datetime
) const
1755 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1757 return m_time
> datetime
.m_time
;
1760 inline bool wxDateTime::IsStrictlyBetween(const wxDateTime
& t1
,
1761 const wxDateTime
& t2
) const
1763 // no need for assert, will be checked by the functions we call
1764 return IsLaterThan(t1
) && IsEarlierThan(t2
);
1767 inline bool wxDateTime::IsBetween(const wxDateTime
& t1
,
1768 const wxDateTime
& t2
) const
1770 // no need for assert, will be checked by the functions we call
1771 return IsEqualTo(t1
) || IsEqualTo(t2
) || IsStrictlyBetween(t1
, t2
);
1774 inline bool wxDateTime::IsSameDate(const wxDateTime
& dt
) const
1779 return tm1
.year
== tm2
.year
&&
1780 tm1
.mon
== tm2
.mon
&&
1781 tm1
.mday
== tm2
.mday
;
1784 inline bool wxDateTime::IsSameTime(const wxDateTime
& dt
) const
1786 // notice that we can't do something like this:
1788 // m_time % MILLISECONDS_PER_DAY == dt.m_time % MILLISECONDS_PER_DAY
1790 // because we have also to deal with (possibly) different DST settings!
1794 return tm1
.hour
== tm2
.hour
&&
1795 tm1
.min
== tm2
.min
&&
1796 tm1
.sec
== tm2
.sec
&&
1797 tm1
.msec
== tm2
.msec
;
1800 inline bool wxDateTime::IsEqualUpTo(const wxDateTime
& dt
,
1801 const wxTimeSpan
& ts
) const
1803 return IsBetween(dt
.Subtract(ts
), dt
.Add(ts
));
1806 // ----------------------------------------------------------------------------
1807 // wxDateTime arithmetics
1808 // ----------------------------------------------------------------------------
1810 inline wxDateTime
wxDateTime::Add(const wxTimeSpan
& diff
) const
1812 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1814 return wxDateTime(m_time
+ diff
.GetValue());
1817 inline wxDateTime
& wxDateTime::Add(const wxTimeSpan
& diff
)
1819 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1821 m_time
+= diff
.GetValue();
1826 inline wxDateTime
& wxDateTime::operator+=(const wxTimeSpan
& diff
)
1831 inline wxDateTime
wxDateTime::Subtract(const wxTimeSpan
& diff
) const
1833 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1835 return wxDateTime(m_time
- diff
.GetValue());
1838 inline wxDateTime
& wxDateTime::Subtract(const wxTimeSpan
& diff
)
1840 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1842 m_time
-= diff
.GetValue();
1847 inline wxDateTime
& wxDateTime::operator-=(const wxTimeSpan
& diff
)
1849 return Subtract(diff
);
1852 inline wxTimeSpan
wxDateTime::Subtract(const wxDateTime
& datetime
) const
1854 wxASSERT_MSG( IsValid() && datetime
.IsValid(), _T("invalid wxDateTime"));
1856 return wxTimeSpan(GetValue() - datetime
.GetValue());
1859 inline wxTimeSpan
wxDateTime::operator-(const wxDateTime
& dt2
) const
1861 return this->Subtract(dt2
);
1864 inline wxDateTime
wxDateTime::Add(const wxDateSpan
& diff
) const
1866 return wxDateTime(*this).Add(diff
);
1869 inline wxDateTime
& wxDateTime::Subtract(const wxDateSpan
& diff
)
1871 return Add(diff
.Negate());
1874 inline wxDateTime
wxDateTime::Subtract(const wxDateSpan
& diff
) const
1876 return wxDateTime(*this).Subtract(diff
);
1879 inline wxDateTime
& wxDateTime::operator-=(const wxDateSpan
& diff
)
1881 return Subtract(diff
);
1884 inline wxDateTime
& wxDateTime::operator+=(const wxDateSpan
& diff
)
1889 // ----------------------------------------------------------------------------
1890 // wxDateTime and timezones
1891 // ----------------------------------------------------------------------------
1894 wxDateTime::ToTimezone(const wxDateTime::TimeZone
& tz
, bool noDST
) const
1896 MODIFY_AND_RETURN( MakeTimezone(tz
, noDST
) );
1900 wxDateTime::FromTimezone(const wxDateTime::TimeZone
& tz
, bool noDST
) const
1902 MODIFY_AND_RETURN( MakeFromTimezone(tz
, noDST
) );
1905 // ----------------------------------------------------------------------------
1906 // wxTimeSpan construction
1907 // ----------------------------------------------------------------------------
1909 inline wxTimeSpan::wxTimeSpan(long hours
,
1912 wxLongLong milliseconds
)
1914 // assign first to avoid precision loss
1921 m_diff
+= milliseconds
;
1924 // ----------------------------------------------------------------------------
1925 // wxTimeSpan accessors
1926 // ----------------------------------------------------------------------------
1928 inline wxLongLong
wxTimeSpan::GetSeconds() const
1930 return m_diff
/ 1000l;
1933 inline int wxTimeSpan::GetMinutes() const
1935 // explicit cast to int suppresses a warning with CodeWarrior and possibly
1936 // others (changing the return type to long from int is impossible in 2.8)
1937 return (int)((GetSeconds() / 60l).GetLo());
1940 inline int wxTimeSpan::GetHours() const
1942 return GetMinutes() / 60;
1945 inline int wxTimeSpan::GetDays() const
1947 return GetHours() / 24;
1950 inline int wxTimeSpan::GetWeeks() const
1952 return GetDays() / 7;
1955 // ----------------------------------------------------------------------------
1956 // wxTimeSpan arithmetics
1957 // ----------------------------------------------------------------------------
1959 inline wxTimeSpan
wxTimeSpan::Add(const wxTimeSpan
& diff
) const
1961 return wxTimeSpan(m_diff
+ diff
.GetValue());
1964 inline wxTimeSpan
& wxTimeSpan::Add(const wxTimeSpan
& diff
)
1966 m_diff
+= diff
.GetValue();
1971 inline wxTimeSpan
wxTimeSpan::Subtract(const wxTimeSpan
& diff
) const
1973 return wxTimeSpan(m_diff
- diff
.GetValue());
1976 inline wxTimeSpan
& wxTimeSpan::Subtract(const wxTimeSpan
& diff
)
1978 m_diff
-= diff
.GetValue();
1983 inline wxTimeSpan
& wxTimeSpan::Multiply(int n
)
1990 inline wxTimeSpan
wxTimeSpan::Multiply(int n
) const
1992 return wxTimeSpan(m_diff
* (long)n
);
1995 inline wxTimeSpan
wxTimeSpan::Abs() const
1997 return wxTimeSpan(GetValue().Abs());
2000 inline bool wxTimeSpan::IsEqualTo(const wxTimeSpan
& ts
) const
2002 return GetValue() == ts
.GetValue();
2005 inline bool wxTimeSpan::IsLongerThan(const wxTimeSpan
& ts
) const
2007 return GetValue().Abs() > ts
.GetValue().Abs();
2010 // ----------------------------------------------------------------------------
2012 // ----------------------------------------------------------------------------
2014 inline wxDateSpan
& wxDateSpan::operator+=(const wxDateSpan
& other
)
2016 m_years
+= other
.m_years
;
2017 m_months
+= other
.m_months
;
2018 m_weeks
+= other
.m_weeks
;
2019 m_days
+= other
.m_days
;
2024 inline wxDateSpan
& wxDateSpan::Add(const wxDateSpan
& other
)
2026 return *this += other
;
2029 inline wxDateSpan
wxDateSpan::Add(const wxDateSpan
& other
) const
2031 wxDateSpan
ds(*this);
2036 inline wxDateSpan
& wxDateSpan::Multiply(int factor
)
2046 inline wxDateSpan
wxDateSpan::Multiply(int factor
) const
2048 wxDateSpan
ds(*this);
2049 ds
.Multiply(factor
);
2053 inline wxDateSpan
wxDateSpan::Negate() const
2055 return wxDateSpan(-m_years
, -m_months
, -m_weeks
, -m_days
);
2058 inline wxDateSpan
& wxDateSpan::Neg()
2061 m_months
= -m_months
;
2068 inline wxDateSpan
& wxDateSpan::operator-=(const wxDateSpan
& other
)
2070 return *this += other
.Negate();
2073 inline wxDateSpan
& wxDateSpan::Subtract(const wxDateSpan
& other
)
2075 return *this -= other
;
2078 inline wxDateSpan
wxDateSpan::Subtract(const wxDateSpan
& other
) const
2080 wxDateSpan
ds(*this);
2085 #undef MILLISECONDS_PER_DAY
2087 #undef MODIFY_AND_RETURN
2089 // ============================================================================
2091 // ============================================================================
2093 // ----------------------------------------------------------------------------
2094 // wxTimeSpan operators
2095 // ----------------------------------------------------------------------------
2097 wxTimeSpan WXDLLIMPEXP_BASE
operator*(int n
, const wxTimeSpan
& ts
);
2099 // ----------------------------------------------------------------------------
2101 // ----------------------------------------------------------------------------
2103 wxDateSpan WXDLLIMPEXP_BASE
operator*(int n
, const wxDateSpan
& ds
);
2105 // ============================================================================
2106 // other helper functions
2107 // ============================================================================
2109 // ----------------------------------------------------------------------------
2110 // iteration helpers: can be used to write a for loop over enum variable like
2112 // for ( m = wxDateTime::Jan; m < wxDateTime::Inv_Month; wxNextMonth(m) )
2113 // ----------------------------------------------------------------------------
2115 WXDLLIMPEXP_BASE
void wxNextMonth(wxDateTime::Month
& m
);
2116 WXDLLIMPEXP_BASE
void wxPrevMonth(wxDateTime::Month
& m
);
2117 WXDLLIMPEXP_BASE
void wxNextWDay(wxDateTime::WeekDay
& wd
);
2118 WXDLLIMPEXP_BASE
void wxPrevWDay(wxDateTime::WeekDay
& wd
);
2120 #endif // wxUSE_DATETIME
2122 #endif // _WX_DATETIME_H