]> git.saurik.com Git - wxWidgets.git/blob - include/wx/datetime.h
Fixed a rare wxAuiFloatingFrame dtor crash on MSW using a registration mechanism...
[wxWidgets.git] / include / wx / datetime.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/datetime.h
3 // Purpose: declarations of time/date related classes (wxDateTime,
4 // wxTimeSpan)
5 // Author: Vadim Zeitlin
6 // Modified by:
7 // Created: 10.02.99
8 // RCS-ID: $Id$
9 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifndef _WX_DATETIME_H
14 #define _WX_DATETIME_H
15
16 #include "wx/defs.h"
17
18 #if wxUSE_DATETIME
19
20 #ifndef __WXWINCE__
21 #include <time.h>
22 #else
23 #include "wx/msw/wince/time.h"
24 #endif
25
26 #include <limits.h> // for INT_MIN
27
28 #include "wx/longlong.h"
29
30 class WXDLLIMPEXP_FWD_BASE wxDateTime;
31 class WXDLLIMPEXP_FWD_BASE wxTimeSpan;
32 class WXDLLIMPEXP_FWD_BASE wxDateSpan;
33
34 #include "wx/dynarray.h"
35
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
38 // systems c-runtime
39
40 #define WX_TIME_BASE_OFFSET 0
41
42 /*
43 * TODO
44 *
45 * + 1. Time zones with minutes (make TimeZone a class)
46 * ? 2. getdate() function like under Solaris
47 * + 3. text conversion for wxDateSpan
48 * + 4. pluggable modules for the workdays calculations
49 * 5. wxDateTimeHolidayAuthority for Easter and other christian feasts
50 */
51
52 /* Two wrapper functions for thread safety */
53 #ifdef HAVE_LOCALTIME_R
54 #define wxLocaltime_r localtime_r
55 #else
56 WXDLLIMPEXP_BASE struct tm *wxLocaltime_r(const time_t*, struct tm*);
57 #if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
58 // On Windows, localtime _is_ threadsafe!
59 #warning using pseudo thread-safe wrapper for localtime to emulate localtime_r
60 #endif
61 #endif
62
63 #ifdef HAVE_GMTIME_R
64 #define wxGmtime_r gmtime_r
65 #else
66 WXDLLIMPEXP_BASE struct tm *wxGmtime_r(const time_t*, struct tm*);
67 #if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
68 // On Windows, gmtime _is_ threadsafe!
69 #warning using pseudo thread-safe wrapper for gmtime to emulate gmtime_r
70 #endif
71 #endif
72
73 /*
74 The three (main) classes declared in this header represent:
75
76 1. An absolute moment in the time (wxDateTime)
77 2. A difference between two moments in the time, positive or negative
78 (wxTimeSpan)
79 3. A logical difference between two dates expressed in
80 years/months/weeks/days (wxDateSpan)
81
82 The following arithmetic operations are permitted (all others are not):
83
84 addition
85 --------
86
87 wxDateTime + wxTimeSpan = wxDateTime
88 wxDateTime + wxDateSpan = wxDateTime
89 wxTimeSpan + wxTimeSpan = wxTimeSpan
90 wxDateSpan + wxDateSpan = wxDateSpan
91
92 subtraction
93 ------------
94 wxDateTime - wxDateTime = wxTimeSpan
95 wxDateTime - wxTimeSpan = wxDateTime
96 wxDateTime - wxDateSpan = wxDateTime
97 wxTimeSpan - wxTimeSpan = wxTimeSpan
98 wxDateSpan - wxDateSpan = wxDateSpan
99
100 multiplication
101 --------------
102 wxTimeSpan * number = wxTimeSpan
103 number * wxTimeSpan = wxTimeSpan
104 wxDateSpan * number = wxDateSpan
105 number * wxDateSpan = wxDateSpan
106
107 unitary minus
108 -------------
109 -wxTimeSpan = wxTimeSpan
110 -wxDateSpan = wxDateSpan
111
112 For each binary operation OP (+, -, *) we have the following operatorOP=() as
113 a method and the method with a symbolic name OPER (Add, Subtract, Multiply)
114 as a synonym for it and another const method with the same name which returns
115 the changed copy of the object and operatorOP() as a global function which is
116 implemented in terms of the const version of OPEN. For the unary - we have
117 operator-() as a method, Neg() as synonym for it and Negate() which returns
118 the copy of the object with the changed sign.
119 */
120
121 // an invalid/default date time object which may be used as the default
122 // argument for arguments of type wxDateTime; it is also returned by all
123 // functions returning wxDateTime on failure (this is why it is also called
124 // wxInvalidDateTime)
125 class WXDLLIMPEXP_FWD_BASE wxDateTime;
126
127 extern WXDLLIMPEXP_DATA_BASE(const char *) wxDefaultDateTimeFormat;
128 extern WXDLLIMPEXP_DATA_BASE(const char *) wxDefaultTimeSpanFormat;
129 extern WXDLLIMPEXP_DATA_BASE(const wxDateTime) wxDefaultDateTime;
130
131 #define wxInvalidDateTime wxDefaultDateTime
132
133 // ----------------------------------------------------------------------------
134 // wxDateTime represents an absolute moment in the time
135 // ----------------------------------------------------------------------------
136
137 class WXDLLIMPEXP_BASE wxDateTime
138 {
139 public:
140 // types
141 // ------------------------------------------------------------------------
142
143 // a small unsigned integer type for storing things like minutes,
144 // seconds &c. It should be at least short (i.e. not char) to contain
145 // the number of milliseconds - it may also be 'int' because there is
146 // no size penalty associated with it in our code, we don't store any
147 // data in this format
148 typedef unsigned short wxDateTime_t;
149
150 // constants
151 // ------------------------------------------------------------------------
152
153 // the timezones
154 enum TZ
155 {
156 // the time in the current time zone
157 Local,
158
159 // zones from GMT (= Greenwhich Mean Time): they're guaranteed to be
160 // consequent numbers, so writing something like `GMT0 + offset' is
161 // safe if abs(offset) <= 12
162
163 // underscore stands for minus
164 GMT_12, GMT_11, GMT_10, GMT_9, GMT_8, GMT_7,
165 GMT_6, GMT_5, GMT_4, GMT_3, GMT_2, GMT_1,
166 GMT0,
167 GMT1, GMT2, GMT3, GMT4, GMT5, GMT6,
168 GMT7, GMT8, GMT9, GMT10, GMT11, GMT12, GMT13,
169 // Note that GMT12 and GMT_12 are not the same: there is a difference
170 // of exactly one day between them
171
172 // some symbolic names for TZ
173
174 // Europe
175 WET = GMT0, // Western Europe Time
176 WEST = GMT1, // Western Europe Summer Time
177 CET = GMT1, // Central Europe Time
178 CEST = GMT2, // Central Europe Summer Time
179 EET = GMT2, // Eastern Europe Time
180 EEST = GMT3, // Eastern Europe Summer Time
181 MSK = GMT3, // Moscow Time
182 MSD = GMT4, // Moscow Summer Time
183
184 // US and Canada
185 AST = GMT_4, // Atlantic Standard Time
186 ADT = GMT_3, // Atlantic Daylight Time
187 EST = GMT_5, // Eastern Standard Time
188 EDT = GMT_4, // Eastern Daylight Saving Time
189 CST = GMT_6, // Central Standard Time
190 CDT = GMT_5, // Central Daylight Saving Time
191 MST = GMT_7, // Mountain Standard Time
192 MDT = GMT_6, // Mountain Daylight Saving Time
193 PST = GMT_8, // Pacific Standard Time
194 PDT = GMT_7, // Pacific Daylight Saving Time
195 HST = GMT_10, // Hawaiian Standard Time
196 AKST = GMT_9, // Alaska Standard Time
197 AKDT = GMT_8, // Alaska Daylight Saving Time
198
199 // Australia
200
201 A_WST = GMT8, // Western Standard Time
202 A_CST = GMT13 + 1, // Central Standard Time (+9.5)
203 A_EST = GMT10, // Eastern Standard Time
204 A_ESST = GMT11, // Eastern Summer Time
205
206 // New Zealand
207 NZST = GMT12, // Standard Time
208 NZDT = GMT13, // Daylight Saving Time
209
210 // TODO add more symbolic timezone names here
211
212 // Universal Coordinated Time = the new and politically correct name
213 // for GMT
214 UTC = GMT0
215 };
216
217 // the calendar systems we know about: notice that it's valid (for
218 // this classes purpose anyhow) to work with any of these calendars
219 // even with the dates before the historical appearance of the
220 // calendar
221 enum Calendar
222 {
223 Gregorian, // current calendar
224 Julian // calendar in use since -45 until the 1582 (or later)
225
226 // TODO Hebrew, Chinese, Maya, ... (just kidding) (or then may be not?)
227 };
228
229 // these values only are used to identify the different dates of
230 // adoption of the Gregorian calendar (see IsGregorian())
231 //
232 // All data and comments taken verbatim from "The Calendar FAQ (v 2.0)"
233 // by Claus Tøndering, http://www.pip.dknet.dk/~c-t/calendar.html
234 // except for the comments "we take".
235 //
236 // Symbol "->" should be read as "was followed by" in the comments
237 // which follow.
238 enum GregorianAdoption
239 {
240 Gr_Unknown, // no data for this country or it's too uncertain to use
241 Gr_Standard, // on the day 0 of Gregorian calendar: 15 Oct 1582
242
243 Gr_Alaska, // Oct 1867 when Alaska became part of the USA
244 Gr_Albania, // Dec 1912
245
246 Gr_Austria = Gr_Unknown, // Different regions on different dates
247 Gr_Austria_Brixen, // 5 Oct 1583 -> 16 Oct 1583
248 Gr_Austria_Salzburg = Gr_Austria_Brixen,
249 Gr_Austria_Tyrol = Gr_Austria_Brixen,
250 Gr_Austria_Carinthia, // 14 Dec 1583 -> 25 Dec 1583
251 Gr_Austria_Styria = Gr_Austria_Carinthia,
252
253 Gr_Belgium, // Then part of the Netherlands
254
255 Gr_Bulgaria = Gr_Unknown, // Unknown precisely (from 1915 to 1920)
256 Gr_Bulgaria_1, // 18 Mar 1916 -> 1 Apr 1916
257 Gr_Bulgaria_2, // 31 Mar 1916 -> 14 Apr 1916
258 Gr_Bulgaria_3, // 3 Sep 1920 -> 17 Sep 1920
259
260 Gr_Canada = Gr_Unknown, // Different regions followed the changes in
261 // Great Britain or France
262
263 Gr_China = Gr_Unknown, // Different authorities say:
264 Gr_China_1, // 18 Dec 1911 -> 1 Jan 1912
265 Gr_China_2, // 18 Dec 1928 -> 1 Jan 1929
266
267 Gr_Czechoslovakia, // (Bohemia and Moravia) 6 Jan 1584 -> 17 Jan 1584
268 Gr_Denmark, // (including Norway) 18 Feb 1700 -> 1 Mar 1700
269 Gr_Egypt, // 1875
270 Gr_Estonia, // 1918
271 Gr_Finland, // Then part of Sweden
272
273 Gr_France, // 9 Dec 1582 -> 20 Dec 1582
274 Gr_France_Alsace, // 4 Feb 1682 -> 16 Feb 1682
275 Gr_France_Lorraine, // 16 Feb 1760 -> 28 Feb 1760
276 Gr_France_Strasbourg, // February 1682
277
278 Gr_Germany = Gr_Unknown, // Different states on different dates:
279 Gr_Germany_Catholic, // 1583-1585 (we take 1584)
280 Gr_Germany_Prussia, // 22 Aug 1610 -> 2 Sep 1610
281 Gr_Germany_Protestant, // 18 Feb 1700 -> 1 Mar 1700
282
283 Gr_GreatBritain, // 2 Sep 1752 -> 14 Sep 1752 (use 'cal(1)')
284
285 Gr_Greece, // 9 Mar 1924 -> 23 Mar 1924
286 Gr_Hungary, // 21 Oct 1587 -> 1 Nov 1587
287 Gr_Ireland = Gr_GreatBritain,
288 Gr_Italy = Gr_Standard,
289
290 Gr_Japan = Gr_Unknown, // Different authorities say:
291 Gr_Japan_1, // 19 Dec 1872 -> 1 Jan 1873
292 Gr_Japan_2, // 19 Dec 1892 -> 1 Jan 1893
293 Gr_Japan_3, // 18 Dec 1918 -> 1 Jan 1919
294
295 Gr_Latvia, // 1915-1918 (we take 1915)
296 Gr_Lithuania, // 1915
297 Gr_Luxemburg, // 14 Dec 1582 -> 25 Dec 1582
298 Gr_Netherlands = Gr_Belgium, // (including Belgium) 1 Jan 1583
299
300 // this is too weird to take into account: the Gregorian calendar was
301 // introduced twice in Groningen, first time 28 Feb 1583 was followed
302 // by 11 Mar 1583, then it has gone back to Julian in the summer of
303 // 1584 and then 13 Dec 1700 -> 12 Jan 1701 - which is
304 // the date we take here
305 Gr_Netherlands_Groningen, // 13 Dec 1700 -> 12 Jan 1701
306 Gr_Netherlands_Gelderland, // 30 Jun 1700 -> 12 Jul 1700
307 Gr_Netherlands_Utrecht, // (and Overijssel) 30 Nov 1700->12 Dec 1700
308 Gr_Netherlands_Friesland, // (and Drenthe) 31 Dec 1700 -> 12 Jan 1701
309
310 Gr_Norway = Gr_Denmark, // Then part of Denmark
311 Gr_Poland = Gr_Standard,
312 Gr_Portugal = Gr_Standard,
313 Gr_Romania, // 31 Mar 1919 -> 14 Apr 1919
314 Gr_Russia, // 31 Jan 1918 -> 14 Feb 1918
315 Gr_Scotland = Gr_GreatBritain,
316 Gr_Spain = Gr_Standard,
317
318 // Sweden has a curious history. Sweden decided to make a gradual
319 // change from the Julian to the Gregorian calendar. By dropping every
320 // leap year from 1700 through 1740 the eleven superfluous days would
321 // be omitted and from 1 Mar 1740 they would be in sync with the
322 // Gregorian calendar. (But in the meantime they would be in sync with
323 // nobody!)
324 //
325 // So 1700 (which should have been a leap year in the Julian calendar)
326 // was not a leap year in Sweden. However, by mistake 1704 and 1708
327 // became leap years. This left Sweden out of synchronisation with
328 // both the Julian and the Gregorian world, so they decided to go back
329 // to the Julian calendar. In order to do this, they inserted an extra
330 // day in 1712, making that year a double leap year! So in 1712,
331 // February had 30 days in Sweden.
332 //
333 // Later, in 1753, Sweden changed to the Gregorian calendar by
334 // dropping 11 days like everyone else.
335 Gr_Sweden = Gr_Finland, // 17 Feb 1753 -> 1 Mar 1753
336
337 Gr_Switzerland = Gr_Unknown,// Different cantons used different dates
338 Gr_Switzerland_Catholic, // 1583, 1584 or 1597 (we take 1584)
339 Gr_Switzerland_Protestant, // 31 Dec 1700 -> 12 Jan 1701
340
341 Gr_Turkey, // 1 Jan 1927
342 Gr_USA = Gr_GreatBritain,
343 Gr_Wales = Gr_GreatBritain,
344 Gr_Yugoslavia // 1919
345 };
346
347 // the country parameter is used so far for calculating the start and
348 // the end of DST period and for deciding whether the date is a work
349 // day or not
350 //
351 // TODO move this to intl.h
352
353 // Required for WinCE
354 #ifdef USA
355 #undef USA
356 #endif
357
358 enum Country
359 {
360 Country_Unknown, // no special information for this country
361 Country_Default, // set the default country with SetCountry() method
362 // or use the default country with any other
363
364 // TODO add more countries (for this we must know about DST and/or
365 // holidays for this country)
366
367 // Western European countries: we assume that they all follow the same
368 // DST rules (true or false?)
369 Country_WesternEurope_Start,
370 Country_EEC = Country_WesternEurope_Start,
371 France,
372 Germany,
373 UK,
374 Country_WesternEurope_End = UK,
375
376 Russia,
377 USA
378 };
379 // symbolic names for the months
380 enum Month
381 {
382 Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec, Inv_Month
383 };
384
385 // symbolic names for the weekdays
386 enum WeekDay
387 {
388 Sun, Mon, Tue, Wed, Thu, Fri, Sat, Inv_WeekDay
389 };
390
391 // invalid value for the year
392 enum Year
393 {
394 Inv_Year = SHRT_MIN // should hold in wxDateTime_t
395 };
396
397 // flags for GetWeekDayName and GetMonthName
398 enum NameFlags
399 {
400 Name_Full = 0x01, // return full name
401 Name_Abbr = 0x02 // return abbreviated name
402 };
403
404 // flags for GetWeekOfYear and GetWeekOfMonth
405 enum WeekFlags
406 {
407 Default_First, // Sunday_First for US, Monday_First for the rest
408 Monday_First, // week starts with a Monday
409 Sunday_First // week starts with a Sunday
410 };
411
412 // helper classes
413 // ------------------------------------------------------------------------
414
415 // a class representing a time zone: basicly, this is just an offset
416 // (in seconds) from GMT
417 class WXDLLIMPEXP_BASE TimeZone
418 {
419 public:
420 TimeZone(TZ tz);
421
422 // create time zone object with the given offset
423 TimeZone(long offset = 0) { m_offset = offset; }
424
425 static TimeZone Make(long offset)
426 {
427 TimeZone tz;
428 tz.m_offset = offset;
429 return tz;
430 }
431
432 long GetOffset() const { return m_offset; }
433
434 private:
435 // offset for this timezone from GMT in seconds
436 long m_offset;
437 };
438
439 // standard struct tm is limited to the years from 1900 (because
440 // tm_year field is the offset from 1900), so we use our own struct
441 // instead to represent broken down time
442 //
443 // NB: this struct should always be kept normalized (i.e. mon should
444 // be < 12, 1 <= day <= 31 &c), so use AddMonths(), AddDays()
445 // instead of modifying the member fields directly!
446 struct WXDLLIMPEXP_BASE Tm
447 {
448 wxDateTime_t msec, sec, min, hour, mday;
449 Month mon;
450 int year;
451
452 // default ctor inits the object to an invalid value
453 Tm();
454
455 // ctor from struct tm and the timezone
456 Tm(const struct tm& tm, const TimeZone& tz);
457
458 // check that the given date/time is valid (in Gregorian calendar)
459 bool IsValid() const;
460
461 // get the week day
462 WeekDay GetWeekDay() // not const because wday may be changed
463 {
464 if ( wday == Inv_WeekDay )
465 ComputeWeekDay();
466
467 return (WeekDay)wday;
468 }
469
470 // add the given number of months to the date keeping it normalized
471 void AddMonths(int monDiff);
472
473 // add the given number of months to the date keeping it normalized
474 void AddDays(int dayDiff);
475
476 private:
477 // compute the weekday from other fields
478 void ComputeWeekDay();
479
480 // the timezone we correspond to
481 TimeZone m_tz;
482
483 // these values can't be accessed directly because they're not always
484 // computed and we calculate them on demand
485 wxDateTime_t wday, yday;
486 };
487
488 // static methods
489 // ------------------------------------------------------------------------
490
491 // set the current country
492 static void SetCountry(Country country);
493 // get the current country
494 static Country GetCountry();
495
496 // return true if the country is a West European one (in practice,
497 // this means that the same DST rules as for EEC apply)
498 static bool IsWestEuropeanCountry(Country country = Country_Default);
499
500 // return the current year
501 static int GetCurrentYear(Calendar cal = Gregorian);
502
503 // convert the year as returned by wxDateTime::GetYear() to a year
504 // suitable for BC/AD notation. The difference is that BC year 1
505 // corresponds to the year 0 (while BC year 0 didn't exist) and AD
506 // year N is just year N.
507 static int ConvertYearToBC(int year);
508
509 // return the current month
510 static Month GetCurrentMonth(Calendar cal = Gregorian);
511
512 // returns true if the given year is a leap year in the given calendar
513 static bool IsLeapYear(int year = Inv_Year, Calendar cal = Gregorian);
514
515 // get the century (19 for 1999, 20 for 2000 and -5 for 492 BC)
516 static int GetCentury(int year);
517
518 // returns the number of days in this year (356 or 355 for Gregorian
519 // calendar usually :-)
520 static wxDateTime_t GetNumberOfDays(int year, Calendar cal = Gregorian);
521
522 // get the number of the days in the given month (default value for
523 // the year means the current one)
524 static wxDateTime_t GetNumberOfDays(Month month,
525 int year = Inv_Year,
526 Calendar cal = Gregorian);
527
528 // get the full (default) or abbreviated month name in the current
529 // locale, returns empty string on error
530 static wxString GetMonthName(Month month,
531 NameFlags flags = Name_Full);
532
533 // get the full (default) or abbreviated weekday name in the current
534 // locale, returns empty string on error
535 static wxString GetWeekDayName(WeekDay weekday,
536 NameFlags flags = Name_Full);
537
538 // get the AM and PM strings in the current locale (may be empty)
539 static void GetAmPmStrings(wxString *am, wxString *pm);
540
541 // return true if the given country uses DST for this year
542 static bool IsDSTApplicable(int year = Inv_Year,
543 Country country = Country_Default);
544
545 // get the beginning of DST for this year, will return invalid object
546 // if no DST applicable in this year. The default value of the
547 // parameter means to take the current year.
548 static wxDateTime GetBeginDST(int year = Inv_Year,
549 Country country = Country_Default);
550 // get the end of DST for this year, will return invalid object
551 // if no DST applicable in this year. The default value of the
552 // parameter means to take the current year.
553 static wxDateTime GetEndDST(int year = Inv_Year,
554 Country country = Country_Default);
555
556 // return the wxDateTime object for the current time
557 static inline wxDateTime Now();
558
559 // return the wxDateTime object for the current time with millisecond
560 // precision (if available on this platform)
561 static wxDateTime UNow();
562
563 // return the wxDateTime object for today midnight: i.e. as Now() but
564 // with time set to 0
565 static inline wxDateTime Today();
566
567 // constructors: you should test whether the constructor succeeded with
568 // IsValid() function. The values Inv_Month and Inv_Year for the
569 // parameters mean take current month and/or year values.
570 // ------------------------------------------------------------------------
571
572 // default ctor does not initialize the object, use Set()!
573 wxDateTime() { m_time = wxLongLong(wxINT32_MIN, 0); }
574
575 // from time_t: seconds since the Epoch 00:00:00 UTC, Jan 1, 1970)
576 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
577 // VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
578 inline wxDateTime(time_t timet);
579 #endif
580 // from broken down time/date (only for standard Unix range)
581 inline wxDateTime(const struct tm& tm);
582 // from broken down time/date (any range)
583 inline wxDateTime(const Tm& tm);
584
585 // from JDN (beware of rounding errors)
586 inline wxDateTime(double jdn);
587
588 // from separate values for each component, date set to today
589 inline wxDateTime(wxDateTime_t hour,
590 wxDateTime_t minute = 0,
591 wxDateTime_t second = 0,
592 wxDateTime_t millisec = 0);
593 // from separate values for each component with explicit date
594 inline wxDateTime(wxDateTime_t day, // day of the month
595 Month month,
596 int year = Inv_Year, // 1999, not 99 please!
597 wxDateTime_t hour = 0,
598 wxDateTime_t minute = 0,
599 wxDateTime_t second = 0,
600 wxDateTime_t millisec = 0);
601
602 // default copy ctor ok
603
604 // no dtor
605
606 // assignment operators and Set() functions: all non const methods return
607 // the reference to this object. IsValid() should be used to test whether
608 // the function succeeded.
609 // ------------------------------------------------------------------------
610
611 // set to the current time
612 inline wxDateTime& SetToCurrent();
613
614 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
615 // VA C++ confuses this with wxDateTime(double jdn) thinking it is a duplicate declaration
616 // set to given time_t value
617 inline wxDateTime& Set(time_t timet);
618 #endif
619
620 // set to given broken down time/date
621 wxDateTime& Set(const struct tm& tm);
622
623 // set to given broken down time/date
624 inline wxDateTime& Set(const Tm& tm);
625
626 // set to given JDN (beware of rounding errors)
627 wxDateTime& Set(double jdn);
628
629 // set to given time, date = today
630 wxDateTime& Set(wxDateTime_t hour,
631 wxDateTime_t minute = 0,
632 wxDateTime_t second = 0,
633 wxDateTime_t millisec = 0);
634
635 // from separate values for each component with explicit date
636 // (defaults for month and year are the current values)
637 wxDateTime& Set(wxDateTime_t day,
638 Month month,
639 int year = Inv_Year, // 1999, not 99 please!
640 wxDateTime_t hour = 0,
641 wxDateTime_t minute = 0,
642 wxDateTime_t second = 0,
643 wxDateTime_t millisec = 0);
644
645 // resets time to 00:00:00, doesn't change the date
646 wxDateTime& ResetTime();
647
648 // get the date part of this object only, i.e. the object which has the
649 // same date as this one but time of 00:00:00
650 wxDateTime GetDateOnly() const;
651
652 // the following functions don't change the values of the other
653 // fields, i.e. SetMinute() won't change either hour or seconds value
654
655 // set the year
656 wxDateTime& SetYear(int year);
657 // set the month
658 wxDateTime& SetMonth(Month month);
659 // set the day of the month
660 wxDateTime& SetDay(wxDateTime_t day);
661 // set hour
662 wxDateTime& SetHour(wxDateTime_t hour);
663 // set minute
664 wxDateTime& SetMinute(wxDateTime_t minute);
665 // set second
666 wxDateTime& SetSecond(wxDateTime_t second);
667 // set millisecond
668 wxDateTime& SetMillisecond(wxDateTime_t millisecond);
669
670 // assignment operator from time_t
671 wxDateTime& operator=(time_t timet) { return Set(timet); }
672
673 // assignment operator from broken down time/date
674 wxDateTime& operator=(const struct tm& tm) { return Set(tm); }
675
676 // assignment operator from broken down time/date
677 wxDateTime& operator=(const Tm& tm) { return Set(tm); }
678
679 // default assignment operator is ok
680
681 // calendar calculations (functions which set the date only leave the time
682 // unchanged, e.g. don't explictly zero it): SetXXX() functions modify the
683 // object itself, GetXXX() ones return a new object.
684 // ------------------------------------------------------------------------
685
686 // set to the given week day in the same week as this one
687 wxDateTime& SetToWeekDayInSameWeek(WeekDay weekday,
688 WeekFlags flags = Monday_First);
689 inline wxDateTime GetWeekDayInSameWeek(WeekDay weekday,
690 WeekFlags flags = Monday_First) const;
691
692 // set to the next week day following this one
693 wxDateTime& SetToNextWeekDay(WeekDay weekday);
694 inline wxDateTime GetNextWeekDay(WeekDay weekday) const;
695
696 // set to the previous week day before this one
697 wxDateTime& SetToPrevWeekDay(WeekDay weekday);
698 inline wxDateTime GetPrevWeekDay(WeekDay weekday) const;
699
700 // set to Nth occurence of given weekday in the given month of the
701 // given year (time is set to 0), return true on success and false on
702 // failure. n may be positive (1..5) or negative to count from the end
703 // of the month (see helper function SetToLastWeekDay())
704 bool SetToWeekDay(WeekDay weekday,
705 int n = 1,
706 Month month = Inv_Month,
707 int year = Inv_Year);
708 inline wxDateTime GetWeekDay(WeekDay weekday,
709 int n = 1,
710 Month month = Inv_Month,
711 int year = Inv_Year) const;
712
713 // sets to the last weekday in the given month, year
714 inline bool SetToLastWeekDay(WeekDay weekday,
715 Month month = Inv_Month,
716 int year = Inv_Year);
717 inline wxDateTime GetLastWeekDay(WeekDay weekday,
718 Month month = Inv_Month,
719 int year = Inv_Year);
720
721 #if WXWIN_COMPATIBILITY_2_6
722 // sets the date to the given day of the given week in the year,
723 // returns true on success and false if given date doesn't exist (e.g.
724 // numWeek is > 53)
725 //
726 // these functions are badly defined as they're not the reverse of
727 // GetWeekOfYear(), use SetToTheWeekOfYear() instead
728 wxDEPRECATED( bool SetToTheWeek(wxDateTime_t numWeek,
729 WeekDay weekday = Mon,
730 WeekFlags flags = Monday_First) );
731 wxDEPRECATED( wxDateTime GetWeek(wxDateTime_t numWeek,
732 WeekDay weekday = Mon,
733 WeekFlags flags = Monday_First) const );
734 #endif // WXWIN_COMPATIBILITY_2_6
735
736 // returns the date corresponding to the given week day of the given
737 // week (in ISO notation) of the specified year
738 static wxDateTime SetToWeekOfYear(int year,
739 wxDateTime_t numWeek,
740 WeekDay weekday = Mon);
741
742 // sets the date to the last day of the given (or current) month or the
743 // given (or current) year
744 wxDateTime& SetToLastMonthDay(Month month = Inv_Month,
745 int year = Inv_Year);
746 inline wxDateTime GetLastMonthDay(Month month = Inv_Month,
747 int year = Inv_Year) const;
748
749 // sets to the given year day (1..365 or 366)
750 wxDateTime& SetToYearDay(wxDateTime_t yday);
751 inline wxDateTime GetYearDay(wxDateTime_t yday) const;
752
753 // The definitions below were taken verbatim from
754 //
755 // http://www.capecod.net/~pbaum/date/date0.htm
756 //
757 // (Peter Baum's home page)
758 //
759 // definition: The Julian Day Number, Julian Day, or JD of a
760 // particular instant of time is the number of days and fractions of a
761 // day since 12 hours Universal Time (Greenwich mean noon) on January
762 // 1 of the year -4712, where the year is given in the Julian
763 // proleptic calendar. The idea of using this reference date was
764 // originally proposed by Joseph Scalizer in 1582 to count years but
765 // it was modified by 19th century astronomers to count days. One
766 // could have equivalently defined the reference time to be noon of
767 // November 24, -4713 if were understood that Gregorian calendar rules
768 // were applied. Julian days are Julian Day Numbers and are not to be
769 // confused with Julian dates.
770 //
771 // definition: The Rata Die number is a date specified as the number
772 // of days relative to a base date of December 31 of the year 0. Thus
773 // January 1 of the year 1 is Rata Die day 1.
774
775 // get the Julian Day number (the fractional part specifies the time of
776 // the day, related to noon - beware of rounding errors!)
777 double GetJulianDayNumber() const;
778 double GetJDN() const { return GetJulianDayNumber(); }
779
780 // get the Modified Julian Day number: it is equal to JDN - 2400000.5
781 // and so integral MJDs correspond to the midnights (and not noons).
782 // MJD 0 is Nov 17, 1858
783 double GetModifiedJulianDayNumber() const { return GetJDN() - 2400000.5; }
784 double GetMJD() const { return GetModifiedJulianDayNumber(); }
785
786 // get the Rata Die number
787 double GetRataDie() const;
788
789 // TODO algorithms for calculating some important dates, such as
790 // religious holidays (Easter...) or moon/solar eclipses? Some
791 // algorithms can be found in the calendar FAQ
792
793
794 // Timezone stuff: a wxDateTime object constructed using given
795 // day/month/year/hour/min/sec values is interpreted as this moment in
796 // local time. Using the functions below, it may be converted to another
797 // time zone (e.g., the Unix epoch is wxDateTime(1, Jan, 1970).ToGMT()).
798 //
799 // These functions try to handle DST internally, but there is no magical
800 // way to know all rules for it in all countries in the world, so if the
801 // program can handle it itself (or doesn't want to handle it at all for
802 // whatever reason), the DST handling can be disabled with noDST.
803 // ------------------------------------------------------------------------
804
805 // transform to any given timezone
806 inline wxDateTime ToTimezone(const TimeZone& tz, bool noDST = false) const;
807 wxDateTime& MakeTimezone(const TimeZone& tz, bool noDST = false);
808
809 // interpret current value as being in another timezone and transform
810 // it to local one
811 inline wxDateTime FromTimezone(const TimeZone& tz, bool noDST = false) const;
812 wxDateTime& MakeFromTimezone(const TimeZone& tz, bool noDST = false);
813
814 // transform to/from GMT/UTC
815 wxDateTime ToUTC(bool noDST = false) const { return ToTimezone(UTC, noDST); }
816 wxDateTime& MakeUTC(bool noDST = false) { return MakeTimezone(UTC, noDST); }
817
818 wxDateTime ToGMT(bool noDST = false) const { return ToUTC(noDST); }
819 wxDateTime& MakeGMT(bool noDST = false) { return MakeUTC(noDST); }
820
821 wxDateTime FromUTC(bool noDST = false) const
822 { return FromTimezone(UTC, noDST); }
823 wxDateTime& MakeFromUTC(bool noDST = false)
824 { return MakeFromTimezone(UTC, noDST); }
825
826 // is daylight savings time in effect at this moment according to the
827 // rules of the specified country?
828 //
829 // Return value is > 0 if DST is in effect, 0 if it is not and -1 if
830 // the information is not available (this is compatible with ANSI C)
831 int IsDST(Country country = Country_Default) const;
832
833
834 // accessors: many of them take the timezone parameter which indicates the
835 // timezone for which to make the calculations and the default value means
836 // to do it for the current timezone of this machine (even if the function
837 // only operates with the date it's necessary because a date may wrap as
838 // result of timezone shift)
839 // ------------------------------------------------------------------------
840
841 // is the date valid?
842 inline bool IsValid() const { return m_time != wxInvalidDateTime.m_time; }
843
844 // get the broken down date/time representation in the given timezone
845 //
846 // If you wish to get several time components (day, month and year),
847 // consider getting the whole Tm strcuture first and retrieving the
848 // value from it - this is much more efficient
849 Tm GetTm(const TimeZone& tz = Local) const;
850
851 // get the number of seconds since the Unix epoch - returns (time_t)-1
852 // if the value is out of range
853 inline time_t GetTicks() const;
854
855 // get the century, same as GetCentury(GetYear())
856 int GetCentury(const TimeZone& tz = Local) const
857 { return GetCentury(GetYear(tz)); }
858 // get the year (returns Inv_Year if date is invalid)
859 int GetYear(const TimeZone& tz = Local) const
860 { return GetTm(tz).year; }
861 // get the month (Inv_Month if date is invalid)
862 Month GetMonth(const TimeZone& tz = Local) const
863 { return (Month)GetTm(tz).mon; }
864 // get the month day (in 1..31 range, 0 if date is invalid)
865 wxDateTime_t GetDay(const TimeZone& tz = Local) const
866 { return GetTm(tz).mday; }
867 // get the day of the week (Inv_WeekDay if date is invalid)
868 WeekDay GetWeekDay(const TimeZone& tz = Local) const
869 { return GetTm(tz).GetWeekDay(); }
870 // get the hour of the day
871 wxDateTime_t GetHour(const TimeZone& tz = Local) const
872 { return GetTm(tz).hour; }
873 // get the minute
874 wxDateTime_t GetMinute(const TimeZone& tz = Local) const
875 { return GetTm(tz).min; }
876 // get the second
877 wxDateTime_t GetSecond(const TimeZone& tz = Local) const
878 { return GetTm(tz).sec; }
879 // get milliseconds
880 wxDateTime_t GetMillisecond(const TimeZone& tz = Local) const
881 { return GetTm(tz).msec; }
882
883 // get the day since the year start (1..366, 0 if date is invalid)
884 wxDateTime_t GetDayOfYear(const TimeZone& tz = Local) const;
885 // get the week number since the year start (1..52 or 53, 0 if date is
886 // invalid)
887 wxDateTime_t GetWeekOfYear(WeekFlags flags = Monday_First,
888 const TimeZone& tz = Local) const;
889 // get the week number since the month start (1..5, 0 if date is
890 // invalid)
891 wxDateTime_t GetWeekOfMonth(WeekFlags flags = Monday_First,
892 const TimeZone& tz = Local) const;
893
894 // is this date a work day? This depends on a country, of course,
895 // because the holidays are different in different countries
896 bool IsWorkDay(Country country = Country_Default) const;
897
898 // is this date later than Gregorian calendar introduction for the
899 // given country (see enum GregorianAdoption)?
900 //
901 // NB: this function shouldn't be considered as absolute authority in
902 // the matter. Besides, for some countries the exact date of
903 // adoption of the Gregorian calendar is simply unknown.
904 bool IsGregorianDate(GregorianAdoption country = Gr_Standard) const;
905
906 // dos date and time format
907 // ------------------------------------------------------------------------
908
909 // set from the DOS packed format
910 wxDateTime& SetFromDOS(unsigned long ddt);
911
912 // pack the date in DOS format
913 unsigned long GetAsDOS() const;
914
915 // comparison (see also functions below for operator versions)
916 // ------------------------------------------------------------------------
917
918 // returns true if the two moments are strictly identical
919 inline bool IsEqualTo(const wxDateTime& datetime) const;
920
921 // returns true if the date is strictly earlier than the given one
922 inline bool IsEarlierThan(const wxDateTime& datetime) const;
923
924 // returns true if the date is strictly later than the given one
925 inline bool IsLaterThan(const wxDateTime& datetime) const;
926
927 // returns true if the date is strictly in the given range
928 inline bool IsStrictlyBetween(const wxDateTime& t1,
929 const wxDateTime& t2) const;
930
931 // returns true if the date is in the given range
932 inline bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
933
934 // do these two objects refer to the same date?
935 inline bool IsSameDate(const wxDateTime& dt) const;
936
937 // do these two objects have the same time?
938 inline bool IsSameTime(const wxDateTime& dt) const;
939
940 // are these two objects equal up to given timespan?
941 inline bool IsEqualUpTo(const wxDateTime& dt, const wxTimeSpan& ts) const;
942
943 inline bool operator<(const wxDateTime& dt) const
944 {
945 wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
946 return GetValue() < dt.GetValue();
947 }
948
949 inline bool operator<=(const wxDateTime& dt) const
950 {
951 wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
952 return GetValue() <= dt.GetValue();
953 }
954
955 inline bool operator>(const wxDateTime& dt) const
956 {
957 wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
958 return GetValue() > dt.GetValue();
959 }
960
961 inline bool operator>=(const wxDateTime& dt) const
962 {
963 wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
964 return GetValue() >= dt.GetValue();
965 }
966
967 inline bool operator==(const wxDateTime& dt) const
968 {
969 wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
970 return GetValue() == dt.GetValue();
971 }
972
973 inline bool operator!=(const wxDateTime& dt) const
974 {
975 wxASSERT_MSG( IsValid() && dt.IsValid(), _T("invalid wxDateTime") );
976 return GetValue() != dt.GetValue();
977 }
978
979 // arithmetics with dates (see also below for more operators)
980 // ------------------------------------------------------------------------
981
982 // return the sum of the date with a time span (positive or negative)
983 inline wxDateTime Add(const wxTimeSpan& diff) const;
984 // add a time span (positive or negative)
985 inline wxDateTime& Add(const wxTimeSpan& diff);
986 // add a time span (positive or negative)
987 inline wxDateTime& operator+=(const wxTimeSpan& diff);
988 inline wxDateTime operator+(const wxTimeSpan& ts) const
989 {
990 wxDateTime dt(*this);
991 dt.Add(ts);
992 return dt;
993 }
994
995 // return the difference of the date with a time span
996 inline wxDateTime Subtract(const wxTimeSpan& diff) const;
997 // subtract a time span (positive or negative)
998 inline wxDateTime& Subtract(const wxTimeSpan& diff);
999 // subtract a time span (positive or negative)
1000 inline wxDateTime& operator-=(const wxTimeSpan& diff);
1001 inline wxDateTime operator-(const wxTimeSpan& ts) const
1002 {
1003 wxDateTime dt(*this);
1004 dt.Subtract(ts);
1005 return dt;
1006 }
1007
1008 // return the sum of the date with a date span
1009 inline wxDateTime Add(const wxDateSpan& diff) const;
1010 // add a date span (positive or negative)
1011 wxDateTime& Add(const wxDateSpan& diff);
1012 // add a date span (positive or negative)
1013 inline wxDateTime& operator+=(const wxDateSpan& diff);
1014 inline wxDateTime operator+(const wxDateSpan& ds) const
1015 {
1016 wxDateTime dt(*this);
1017 dt.Add(ds);
1018 return dt;
1019 }
1020
1021 // return the difference of the date with a date span
1022 inline wxDateTime Subtract(const wxDateSpan& diff) const;
1023 // subtract a date span (positive or negative)
1024 inline wxDateTime& Subtract(const wxDateSpan& diff);
1025 // subtract a date span (positive or negative)
1026 inline wxDateTime& operator-=(const wxDateSpan& diff);
1027 inline wxDateTime operator-(const wxDateSpan& ds) const
1028 {
1029 wxDateTime dt(*this);
1030 dt.Subtract(ds);
1031 return dt;
1032 }
1033
1034 // return the difference between two dates
1035 inline wxTimeSpan Subtract(const wxDateTime& dt) const;
1036 inline wxTimeSpan operator-(const wxDateTime& dt2) const;
1037
1038 // conversion to/from text: all conversions from text return the pointer to
1039 // the next character following the date specification (i.e. the one where
1040 // the scan had to stop) or NULL on failure; for the versions taking
1041 // wxString or wxCStrData, we don't know if the user code needs char* or
1042 // wchar_t* pointer and so we return char* one for compatibility with the
1043 // existing ANSI code and also return iterator in another output parameter
1044 // (it will be equal to end if the entire string was parsed)
1045 // ------------------------------------------------------------------------
1046
1047 // parse a string in RFC 822 format (found e.g. in mail headers and
1048 // having the form "Wed, 10 Feb 1999 19:07:07 +0100")
1049 const char *ParseRfc822Date(const wxString& date,
1050 wxString::const_iterator *end = NULL);
1051 const char *ParseRfc822Date(const wxCStrData& date,
1052 wxString::const_iterator *end = NULL)
1053 {
1054 return ParseRfc822Date(date.AsString(), end);
1055 }
1056
1057 const wchar_t *ParseRfc822Date(const wchar_t* date)
1058 {
1059 return ReturnEndAsWidePtr(&wxDateTime::ParseRfc822Date, date);
1060 }
1061
1062 const char *ParseRfc822Date(const char* date)
1063 {
1064 return ParseRfc822Date(wxString(date));
1065 }
1066
1067 // parse a date/time in the given format (see strptime(3)), fill in
1068 // the missing (in the string) fields with the values of dateDef (by
1069 // default, they will not change if they had valid values or will
1070 // default to Today() otherwise)
1071 const char *ParseFormat(const wxString& date,
1072 const wxString& format = wxDefaultDateTimeFormat,
1073 const wxDateTime& dateDef = wxDefaultDateTime,
1074 wxString::const_iterator *end = NULL);
1075
1076 const char *ParseFormat(const wxString& date,
1077 const char *format = wxDefaultDateTimeFormat,
1078 const wxDateTime& dateDef = wxDefaultDateTime,
1079 wxString::const_iterator *end = NULL)
1080 {
1081 return ParseFormat(date, wxString(format), dateDef, end);
1082 }
1083
1084 const char *ParseFormat(const wxString& date,
1085 const wxString& format = wxDefaultDateTimeFormat,
1086 wxString::const_iterator *end = NULL)
1087 {
1088 return ParseFormat(date, format, wxDefaultDateTime, end);
1089 }
1090
1091 const char *ParseFormat(const wxCStrData& date,
1092 const wxString& format = wxDefaultDateTimeFormat,
1093 const wxDateTime& dateDef = wxDefaultDateTime,
1094 wxString::const_iterator *end = NULL)
1095 {
1096 return ParseFormat(date.AsString(), format, dateDef, end);
1097 }
1098
1099 const wchar_t *ParseFormat(const wchar_t *date,
1100 const wxString& format = wxDefaultDateTimeFormat,
1101 const wxDateTime& dateDef = wxDefaultDateTime)
1102 {
1103 const wxString datestr(date);
1104 wxString::const_iterator end;
1105 if ( !ParseFormat(datestr, format, dateDef, &end) )
1106 return NULL;
1107
1108 return date + (end - datestr.begin());
1109 }
1110
1111 const char *ParseFormat(const char *date,
1112 const wxString& format = L"%c",
1113 const wxDateTime& dateDef = wxDefaultDateTime)
1114 {
1115 return ParseFormat(wxString(date), format, dateDef);
1116 }
1117
1118 const char *ParseFormat(const char *date,
1119 const char *format = wxDefaultDateTimeFormat,
1120 const wxDateTime& dateDef = wxDefaultDateTime)
1121 {
1122 return ParseFormat(wxString(date), wxString(format), dateDef);
1123 }
1124
1125 // parse a string containing the date/time in "free" format, this
1126 // function will try to make an educated guess at the string contents
1127 const char *ParseDateTime(const wxString& datetime,
1128 wxString::const_iterator *end = NULL);
1129
1130 const char *ParseDateTime(const wxCStrData& datetime,
1131 wxString::const_iterator *end = NULL)
1132 {
1133 return ParseDateTime(datetime.AsString(), end);
1134 }
1135
1136 const wchar_t *ParseDateTime(const wchar_t *datetime)
1137 {
1138 return ReturnEndAsWidePtr(&wxDateTime::ParseDateTime, datetime);
1139 }
1140
1141 const char *ParseDateTime(const char *datetime)
1142 {
1143 return ParseDateTime(wxString(datetime));
1144 }
1145
1146 // parse a string containing the date only in "free" format (less
1147 // flexible than ParseDateTime)
1148 const char *ParseDate(const wxString& date,
1149 wxString::const_iterator *end = NULL);
1150
1151 const char *ParseDate(const wxCStrData& date,
1152 wxString::const_iterator *end = NULL)
1153 {
1154 return ParseDate(date.AsString(), end);
1155 }
1156
1157 const wchar_t *ParseDate(const wchar_t *date)
1158 {
1159 return ReturnEndAsWidePtr(&wxDateTime::ParseDate, date);
1160 }
1161
1162 const char *ParseDate(const char *date)
1163 {
1164 return ParseDate(wxString(date));
1165 }
1166
1167 // parse a string containing the time only in "free" format
1168 const char *ParseTime(const wxString& time,
1169 wxString::const_iterator *end = NULL);
1170
1171 const char *ParseTime(const wxCStrData& time,
1172 wxString::const_iterator *end = NULL)
1173 {
1174 return ParseTime(time.AsString(), end);
1175 }
1176
1177 const wchar_t *ParseTime(const wchar_t *time)
1178 {
1179 return ReturnEndAsWidePtr(&wxDateTime::ParseTime, time);
1180 }
1181
1182 const char *ParseTime(const char *time)
1183 {
1184 return ParseTime(wxString(time));
1185 }
1186
1187 // this function accepts strftime()-like format string (default
1188 // argument corresponds to the preferred date and time representation
1189 // for the current locale) and returns the string containing the
1190 // resulting text representation
1191 wxString Format(const wxString& format = wxDefaultDateTimeFormat,
1192 const TimeZone& tz = Local) const;
1193 // preferred date representation for the current locale
1194 wxString FormatDate() const { return Format(_T("%x")); }
1195 // preferred time representation for the current locale
1196 wxString FormatTime() const { return Format(_T("%X")); }
1197 // returns the string representing the date in ISO 8601 format
1198 // (YYYY-MM-DD)
1199 wxString FormatISODate() const { return Format(_T("%Y-%m-%d")); }
1200 // returns the string representing the time in ISO 8601 format
1201 // (HH:MM:SS)
1202 wxString FormatISOTime() const { return Format(_T("%H:%M:%S")); }
1203
1204 // implementation
1205 // ------------------------------------------------------------------------
1206
1207 // construct from internal representation
1208 wxDateTime(const wxLongLong& time) { m_time = time; }
1209
1210 // get the internal representation
1211 inline wxLongLong GetValue() const;
1212
1213 // a helper function to get the current time_t
1214 static time_t GetTimeNow() { return time((time_t *)NULL); }
1215
1216 // another one to get the current time broken down
1217 static struct tm *GetTmNow()
1218 {
1219 static struct tm l_CurrentTime;
1220 return GetTmNow(&l_CurrentTime);
1221 }
1222
1223 // get current time using thread-safe function
1224 static struct tm *GetTmNow(struct tm *tmstruct);
1225
1226 private:
1227 // helper function for defining backward-compatible wrappers for code
1228 // using wchar_t* pointer instead of wxString iterators
1229 typedef
1230 const char *(wxDateTime::*StringMethod)(const wxString& s,
1231 wxString::const_iterator *end);
1232
1233 const wchar_t *ReturnEndAsWidePtr(StringMethod func, const wchar_t *p)
1234 {
1235 const wxString s(p);
1236 wxString::const_iterator end;
1237 if ( !(this->*func)(s, &end) )
1238 return NULL;
1239
1240 return p + (end - s.begin());
1241 }
1242
1243
1244 // the current country - as it's the same for all program objects (unless
1245 // it runs on a _really_ big cluster system :-), this is a static member:
1246 // see SetCountry() and GetCountry()
1247 static Country ms_country;
1248
1249 // this constant is used to transform a time_t value to the internal
1250 // representation, as time_t is in seconds and we use milliseconds it's
1251 // fixed to 1000
1252 static const long TIME_T_FACTOR;
1253
1254 // returns true if we fall in range in which we can use standard ANSI C
1255 // functions
1256 inline bool IsInStdRange() const;
1257
1258 // the internal representation of the time is the amount of milliseconds
1259 // elapsed since the origin which is set by convention to the UNIX/C epoch
1260 // value: the midnight of January 1, 1970 (UTC)
1261 wxLongLong m_time;
1262 };
1263
1264 // ----------------------------------------------------------------------------
1265 // This class contains a difference between 2 wxDateTime values, so it makes
1266 // sense to add it to wxDateTime and it is the result of subtraction of 2
1267 // objects of that class. See also wxDateSpan.
1268 // ----------------------------------------------------------------------------
1269
1270 class WXDLLIMPEXP_BASE wxTimeSpan
1271 {
1272 public:
1273 // constructors
1274 // ------------------------------------------------------------------------
1275
1276 // return the timespan for the given number of milliseconds
1277 static wxTimeSpan Milliseconds(wxLongLong ms) { return wxTimeSpan(0, 0, 0, ms); }
1278 static wxTimeSpan Millisecond() { return Milliseconds(1); }
1279
1280 // return the timespan for the given number of seconds
1281 static wxTimeSpan Seconds(wxLongLong sec) { return wxTimeSpan(0, 0, sec); }
1282 static wxTimeSpan Second() { return Seconds(1); }
1283
1284 // return the timespan for the given number of minutes
1285 static wxTimeSpan Minutes(long min) { return wxTimeSpan(0, min, 0 ); }
1286 static wxTimeSpan Minute() { return Minutes(1); }
1287
1288 // return the timespan for the given number of hours
1289 static wxTimeSpan Hours(long hours) { return wxTimeSpan(hours, 0, 0); }
1290 static wxTimeSpan Hour() { return Hours(1); }
1291
1292 // return the timespan for the given number of days
1293 static wxTimeSpan Days(long days) { return Hours(24 * days); }
1294 static wxTimeSpan Day() { return Days(1); }
1295
1296 // return the timespan for the given number of weeks
1297 static wxTimeSpan Weeks(long days) { return Days(7 * days); }
1298 static wxTimeSpan Week() { return Weeks(1); }
1299
1300 // default ctor constructs the 0 time span
1301 wxTimeSpan() { }
1302
1303 // from separate values for each component, date set to 0 (hours are
1304 // not restricted to 0..24 range, neither are minutes, seconds or
1305 // milliseconds)
1306 inline wxTimeSpan(long hours,
1307 long minutes = 0,
1308 wxLongLong seconds = 0,
1309 wxLongLong milliseconds = 0);
1310
1311 // default copy ctor is ok
1312
1313 // no dtor
1314
1315 // arithmetics with time spans (see also below for more operators)
1316 // ------------------------------------------------------------------------
1317
1318 // return the sum of two timespans
1319 inline wxTimeSpan Add(const wxTimeSpan& diff) const;
1320 // add two timespans together
1321 inline wxTimeSpan& Add(const wxTimeSpan& diff);
1322 // add two timespans together
1323 wxTimeSpan& operator+=(const wxTimeSpan& diff) { return Add(diff); }
1324 inline wxTimeSpan operator+(const wxTimeSpan& ts) const
1325 {
1326 return wxTimeSpan(GetValue() + ts.GetValue());
1327 }
1328
1329 // return the difference of two timespans
1330 inline wxTimeSpan Subtract(const wxTimeSpan& diff) const;
1331 // subtract another timespan
1332 inline wxTimeSpan& Subtract(const wxTimeSpan& diff);
1333 // subtract another timespan
1334 wxTimeSpan& operator-=(const wxTimeSpan& diff) { return Subtract(diff); }
1335 inline wxTimeSpan operator-(const wxTimeSpan& ts)
1336 {
1337 return wxTimeSpan(GetValue() - ts.GetValue());
1338 }
1339
1340 // multiply timespan by a scalar
1341 inline wxTimeSpan Multiply(int n) const;
1342 // multiply timespan by a scalar
1343 inline wxTimeSpan& Multiply(int n);
1344 // multiply timespan by a scalar
1345 wxTimeSpan& operator*=(int n) { return Multiply(n); }
1346 inline wxTimeSpan operator*(int n) const
1347 {
1348 return wxTimeSpan(*this).Multiply(n);
1349 }
1350
1351 // return this timespan with opposite sign
1352 wxTimeSpan Negate() const { return wxTimeSpan(-GetValue()); }
1353 // negate the value of the timespan
1354 wxTimeSpan& Neg() { m_diff = -GetValue(); return *this; }
1355 // negate the value of the timespan
1356 wxTimeSpan& operator-() { return Neg(); }
1357
1358 // return the absolute value of the timespan: does _not_ modify the
1359 // object
1360 inline wxTimeSpan Abs() const;
1361
1362 // there is intentionally no division because we don't want to
1363 // introduce rounding errors in time calculations
1364
1365 // comparaison (see also operator versions below)
1366 // ------------------------------------------------------------------------
1367
1368 // is the timespan null?
1369 bool IsNull() const { return m_diff == 0l; }
1370 // returns true if the timespan is null
1371 bool operator!() const { return !IsNull(); }
1372
1373 // is the timespan positive?
1374 bool IsPositive() const { return m_diff > 0l; }
1375
1376 // is the timespan negative?
1377 bool IsNegative() const { return m_diff < 0l; }
1378
1379 // are two timespans equal?
1380 inline bool IsEqualTo(const wxTimeSpan& ts) const;
1381 // compare two timestamps: works with the absolute values, i.e. -2
1382 // hours is longer than 1 hour. Also, it will return false if the
1383 // timespans are equal in absolute value.
1384 inline bool IsLongerThan(const wxTimeSpan& ts) const;
1385 // compare two timestamps: works with the absolute values, i.e. 1
1386 // hour is shorter than -2 hours. Also, it will return false if the
1387 // timespans are equal in absolute value.
1388 bool IsShorterThan(const wxTimeSpan& t) const { return !IsLongerThan(t); }
1389
1390 inline bool operator<(const wxTimeSpan &ts) const
1391 {
1392 return GetValue() < ts.GetValue();
1393 }
1394
1395 inline bool operator<=(const wxTimeSpan &ts) const
1396 {
1397 return GetValue() <= ts.GetValue();
1398 }
1399
1400 inline bool operator>(const wxTimeSpan &ts) const
1401 {
1402 return GetValue() > ts.GetValue();
1403 }
1404
1405 inline bool operator>=(const wxTimeSpan &ts) const
1406 {
1407 return GetValue() >= ts.GetValue();
1408 }
1409
1410 inline bool operator==(const wxTimeSpan &ts) const
1411 {
1412 return GetValue() == ts.GetValue();
1413 }
1414
1415 inline bool operator!=(const wxTimeSpan &ts) const
1416 {
1417 return GetValue() != ts.GetValue();
1418 }
1419
1420 // breaking into days, hours, minutes and seconds
1421 // ------------------------------------------------------------------------
1422
1423 // get the max number of weeks in this timespan
1424 inline int GetWeeks() const;
1425 // get the max number of days in this timespan
1426 inline int GetDays() const;
1427 // get the max number of hours in this timespan
1428 inline int GetHours() const;
1429 // get the max number of minutes in this timespan
1430 inline int GetMinutes() const;
1431 // get the max number of seconds in this timespan
1432 inline wxLongLong GetSeconds() const;
1433 // get the number of milliseconds in this timespan
1434 wxLongLong GetMilliseconds() const { return m_diff; }
1435
1436 // conversion to text
1437 // ------------------------------------------------------------------------
1438
1439 // this function accepts strftime()-like format string (default
1440 // argument corresponds to the preferred date and time representation
1441 // for the current locale) and returns the string containing the
1442 // resulting text representation. Notice that only some of format
1443 // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
1444 // minutes and seconds make sense, but not "PM/AM" string for example.
1445 wxString Format(const wxString& format = wxDefaultTimeSpanFormat) const;
1446
1447 // implementation
1448 // ------------------------------------------------------------------------
1449
1450 // construct from internal representation
1451 wxTimeSpan(const wxLongLong& diff) { m_diff = diff; }
1452
1453 // get the internal representation
1454 wxLongLong GetValue() const { return m_diff; }
1455
1456 private:
1457 // the (signed) time span in milliseconds
1458 wxLongLong m_diff;
1459 };
1460
1461 // ----------------------------------------------------------------------------
1462 // This class is a "logical time span" and is useful for implementing program
1463 // logic for such things as "add one month to the date" which, in general,
1464 // doesn't mean to add 60*60*24*31 seconds to it, but to take the same date
1465 // the next month (to understand that this is indeed different consider adding
1466 // one month to Feb, 15 - we want to get Mar, 15, of course).
1467 //
1468 // When adding a month to the date, all lesser components (days, hours, ...)
1469 // won't be changed unless the resulting date would be invalid: for example,
1470 // Jan 31 + 1 month will be Feb 28, not (non existing) Feb 31.
1471 //
1472 // Because of this feature, adding and subtracting back again the same
1473 // wxDateSpan will *not*, in general give back the original date: Feb 28 - 1
1474 // month will be Jan 28, not Jan 31!
1475 //
1476 // wxDateSpan can be either positive or negative. They may be
1477 // multiplied by scalars which multiply all deltas by the scalar: i.e. 2*(1
1478 // month and 1 day) is 2 months and 2 days. They can be added together and
1479 // with wxDateTime or wxTimeSpan, but the type of result is different for each
1480 // case.
1481 //
1482 // Beware about weeks: if you specify both weeks and days, the total number of
1483 // days added will be 7*weeks + days! See also GetTotalDays() function.
1484 //
1485 // Equality operators are defined for wxDateSpans. Two datespans are equal if
1486 // they both give the same target date when added to *every* source date.
1487 // Thus wxDateSpan::Months(1) is not equal to wxDateSpan::Days(30), because
1488 // they not give the same date when added to 1 Feb. But wxDateSpan::Days(14) is
1489 // equal to wxDateSpan::Weeks(2)
1490 //
1491 // Finally, notice that for adding hours, minutes &c you don't need this
1492 // class: wxTimeSpan will do the job because there are no subtleties
1493 // associated with those.
1494 // ----------------------------------------------------------------------------
1495
1496 class WXDLLIMPEXP_BASE wxDateSpan
1497 {
1498 public:
1499 // constructors
1500 // ------------------------------------------------------------------------
1501
1502 // this many years/months/weeks/days
1503 wxDateSpan(int years = 0, int months = 0, int weeks = 0, int days = 0)
1504 {
1505 m_years = years;
1506 m_months = months;
1507 m_weeks = weeks;
1508 m_days = days;
1509 }
1510
1511 // get an object for the given number of days
1512 static wxDateSpan Days(int days) { return wxDateSpan(0, 0, 0, days); }
1513 static wxDateSpan Day() { return Days(1); }
1514
1515 // get an object for the given number of weeks
1516 static wxDateSpan Weeks(int weeks) { return wxDateSpan(0, 0, weeks, 0); }
1517 static wxDateSpan Week() { return Weeks(1); }
1518
1519 // get an object for the given number of months
1520 static wxDateSpan Months(int mon) { return wxDateSpan(0, mon, 0, 0); }
1521 static wxDateSpan Month() { return Months(1); }
1522
1523 // get an object for the given number of years
1524 static wxDateSpan Years(int years) { return wxDateSpan(years, 0, 0, 0); }
1525 static wxDateSpan Year() { return Years(1); }
1526
1527 // default copy ctor is ok
1528
1529 // no dtor
1530
1531 // accessors (all SetXXX() return the (modified) wxDateSpan object)
1532 // ------------------------------------------------------------------------
1533
1534 // set number of years
1535 wxDateSpan& SetYears(int n) { m_years = n; return *this; }
1536 // set number of months
1537 wxDateSpan& SetMonths(int n) { m_months = n; return *this; }
1538 // set number of weeks
1539 wxDateSpan& SetWeeks(int n) { m_weeks = n; return *this; }
1540 // set number of days
1541 wxDateSpan& SetDays(int n) { m_days = n; return *this; }
1542
1543 // get number of years
1544 int GetYears() const { return m_years; }
1545 // get number of months
1546 int GetMonths() const { return m_months; }
1547 // get number of weeks
1548 int GetWeeks() const { return m_weeks; }
1549 // get number of days
1550 int GetDays() const { return m_days; }
1551 // returns 7*GetWeeks() + GetDays()
1552 int GetTotalDays() const { return 7*m_weeks + m_days; }
1553
1554 // arithmetics with date spans (see also below for more operators)
1555 // ------------------------------------------------------------------------
1556
1557 // return sum of two date spans
1558 inline wxDateSpan Add(const wxDateSpan& other) const;
1559 // add another wxDateSpan to us
1560 inline wxDateSpan& Add(const wxDateSpan& other);
1561 // add another wxDateSpan to us
1562 inline wxDateSpan& operator+=(const wxDateSpan& other);
1563 inline wxDateSpan operator+(const wxDateSpan& ds) const
1564 {
1565 return wxDateSpan(GetYears() + ds.GetYears(),
1566 GetMonths() + ds.GetMonths(),
1567 GetWeeks() + ds.GetWeeks(),
1568 GetDays() + ds.GetDays());
1569 }
1570
1571 // return difference of two date spans
1572 inline wxDateSpan Subtract(const wxDateSpan& other) const;
1573 // subtract another wxDateSpan from us
1574 inline wxDateSpan& Subtract(const wxDateSpan& other);
1575 // subtract another wxDateSpan from us
1576 inline wxDateSpan& operator-=(const wxDateSpan& other);
1577 inline wxDateSpan operator-(const wxDateSpan& ds) const
1578 {
1579 return wxDateSpan(GetYears() - ds.GetYears(),
1580 GetMonths() - ds.GetMonths(),
1581 GetWeeks() - ds.GetWeeks(),
1582 GetDays() - ds.GetDays());
1583 }
1584
1585 // return a copy of this time span with changed sign
1586 inline wxDateSpan Negate() const;
1587 // inverse the sign of this timespan
1588 inline wxDateSpan& Neg();
1589 // inverse the sign of this timespan
1590 wxDateSpan& operator-() { return Neg(); }
1591
1592 // return the date span proportional to this one with given factor
1593 inline wxDateSpan Multiply(int factor) const;
1594 // multiply all components by a (signed) number
1595 inline wxDateSpan& Multiply(int factor);
1596 // multiply all components by a (signed) number
1597 inline wxDateSpan& operator*=(int factor) { return Multiply(factor); }
1598 inline wxDateSpan operator*(int n) const
1599 {
1600 return wxDateSpan(*this).Multiply(n);
1601 }
1602
1603 // ds1 == d2 if and only if for every wxDateTime t t + ds1 == t + ds2
1604 inline bool operator==(const wxDateSpan& ds) const
1605 {
1606 return GetYears() == ds.GetYears() &&
1607 GetMonths() == ds.GetMonths() &&
1608 GetTotalDays() == ds.GetTotalDays();
1609 }
1610
1611 inline bool operator!=(const wxDateSpan& ds) const
1612 {
1613 return !(*this == ds);
1614 }
1615
1616 private:
1617 int m_years,
1618 m_months,
1619 m_weeks,
1620 m_days;
1621 };
1622
1623 // ----------------------------------------------------------------------------
1624 // wxDateTimeArray: array of dates.
1625 // ----------------------------------------------------------------------------
1626
1627 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxDateTime, wxDateTimeArray, WXDLLIMPEXP_BASE);
1628
1629 // ----------------------------------------------------------------------------
1630 // wxDateTimeHolidayAuthority: an object of this class will decide whether a
1631 // given date is a holiday and is used by all functions working with "work
1632 // days".
1633 //
1634 // NB: the base class is an ABC, derived classes must implement the pure
1635 // virtual methods to work with the holidays they correspond to.
1636 // ----------------------------------------------------------------------------
1637
1638 class WXDLLIMPEXP_FWD_BASE wxDateTimeHolidayAuthority;
1639 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxDateTimeHolidayAuthority *,
1640 wxHolidayAuthoritiesArray,
1641 class WXDLLIMPEXP_BASE);
1642
1643 class wxDateTimeHolidaysModule;
1644 class WXDLLIMPEXP_BASE wxDateTimeHolidayAuthority
1645 {
1646 friend class wxDateTimeHolidaysModule;
1647 public:
1648 // returns true if the given date is a holiday
1649 static bool IsHoliday(const wxDateTime& dt);
1650
1651 // fills the provided array with all holidays in the given range, returns
1652 // the number of them
1653 static size_t GetHolidaysInRange(const wxDateTime& dtStart,
1654 const wxDateTime& dtEnd,
1655 wxDateTimeArray& holidays);
1656
1657 // clear the list of holiday authorities
1658 static void ClearAllAuthorities();
1659
1660 // add a new holiday authority (the pointer will be deleted by
1661 // wxDateTimeHolidayAuthority)
1662 static void AddAuthority(wxDateTimeHolidayAuthority *auth);
1663
1664 // the base class must have a virtual dtor
1665 virtual ~wxDateTimeHolidayAuthority();
1666
1667 protected:
1668 // this function is called to determine whether a given day is a holiday
1669 virtual bool DoIsHoliday(const wxDateTime& dt) const = 0;
1670
1671 // this function should fill the array with all holidays between the two
1672 // given dates - it is implemented in the base class, but in a very
1673 // inefficient way (it just iterates over all days and uses IsHoliday() for
1674 // each of them), so it must be overridden in the derived class where the
1675 // base class version may be explicitly used if needed
1676 //
1677 // returns the number of holidays in the given range and fills holidays
1678 // array
1679 virtual size_t DoGetHolidaysInRange(const wxDateTime& dtStart,
1680 const wxDateTime& dtEnd,
1681 wxDateTimeArray& holidays) const = 0;
1682
1683 private:
1684 // all holiday authorities
1685 static wxHolidayAuthoritiesArray ms_authorities;
1686 };
1687
1688 // the holidays for this class are all Saturdays and Sundays
1689 class WXDLLIMPEXP_BASE wxDateTimeWorkDays : public wxDateTimeHolidayAuthority
1690 {
1691 protected:
1692 virtual bool DoIsHoliday(const wxDateTime& dt) const;
1693 virtual size_t DoGetHolidaysInRange(const wxDateTime& dtStart,
1694 const wxDateTime& dtEnd,
1695 wxDateTimeArray& holidays) const;
1696 };
1697
1698 // ============================================================================
1699 // inline functions implementation
1700 // ============================================================================
1701
1702 // ----------------------------------------------------------------------------
1703 // private macros
1704 // ----------------------------------------------------------------------------
1705
1706 #define MILLISECONDS_PER_DAY 86400000l
1707
1708 // some broken compilers (HP-UX CC) refuse to compile the "normal" version, but
1709 // using a temp variable always might prevent other compilers from optimising
1710 // it away - hence use of this ugly macro
1711 #ifndef __HPUX__
1712 #define MODIFY_AND_RETURN(op) return wxDateTime(*this).op
1713 #else
1714 #define MODIFY_AND_RETURN(op) wxDateTime dt(*this); dt.op; return dt
1715 #endif
1716
1717 // ----------------------------------------------------------------------------
1718 // wxDateTime construction
1719 // ----------------------------------------------------------------------------
1720
1721 inline bool wxDateTime::IsInStdRange() const
1722 {
1723 return m_time >= 0l && (m_time / TIME_T_FACTOR) < LONG_MAX;
1724 }
1725
1726 /* static */
1727 inline wxDateTime wxDateTime::Now()
1728 {
1729 struct tm tmstruct;
1730 return wxDateTime(*GetTmNow(&tmstruct));
1731 }
1732
1733 /* static */
1734 inline wxDateTime wxDateTime::Today()
1735 {
1736 wxDateTime dt(Now());
1737 dt.ResetTime();
1738
1739 return dt;
1740 }
1741
1742 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
1743 inline wxDateTime& wxDateTime::Set(time_t timet)
1744 {
1745 // assign first to avoid long multiplication overflow!
1746 m_time = timet - WX_TIME_BASE_OFFSET ;
1747 m_time *= TIME_T_FACTOR;
1748
1749 return *this;
1750 }
1751 #endif
1752
1753 inline wxDateTime& wxDateTime::SetToCurrent()
1754 {
1755 *this = Now();
1756 return *this;
1757 }
1758
1759 #if (!(defined(__VISAGECPP__) && __IBMCPP__ >= 400))
1760 inline wxDateTime::wxDateTime(time_t timet)
1761 {
1762 Set(timet);
1763 }
1764 #endif
1765
1766 inline wxDateTime::wxDateTime(const struct tm& tm)
1767 {
1768 Set(tm);
1769 }
1770
1771 inline wxDateTime::wxDateTime(const Tm& tm)
1772 {
1773 Set(tm);
1774 }
1775
1776 inline wxDateTime::wxDateTime(double jdn)
1777 {
1778 Set(jdn);
1779 }
1780
1781 inline wxDateTime& wxDateTime::Set(const Tm& tm)
1782 {
1783 wxASSERT_MSG( tm.IsValid(), _T("invalid broken down date/time") );
1784
1785 return Set(tm.mday, (Month)tm.mon, tm.year,
1786 tm.hour, tm.min, tm.sec, tm.msec);
1787 }
1788
1789 inline wxDateTime::wxDateTime(wxDateTime_t hour,
1790 wxDateTime_t minute,
1791 wxDateTime_t second,
1792 wxDateTime_t millisec)
1793 {
1794 Set(hour, minute, second, millisec);
1795 }
1796
1797 inline wxDateTime::wxDateTime(wxDateTime_t day,
1798 Month month,
1799 int year,
1800 wxDateTime_t hour,
1801 wxDateTime_t minute,
1802 wxDateTime_t second,
1803 wxDateTime_t millisec)
1804 {
1805 Set(day, month, year, hour, minute, second, millisec);
1806 }
1807
1808 // ----------------------------------------------------------------------------
1809 // wxDateTime accessors
1810 // ----------------------------------------------------------------------------
1811
1812 inline wxLongLong wxDateTime::GetValue() const
1813 {
1814 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1815
1816 return m_time;
1817 }
1818
1819 inline time_t wxDateTime::GetTicks() const
1820 {
1821 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1822 if ( !IsInStdRange() )
1823 {
1824 return (time_t)-1;
1825 }
1826
1827 return (time_t)((m_time / (long)TIME_T_FACTOR).ToLong()) + WX_TIME_BASE_OFFSET;
1828 }
1829
1830 inline bool wxDateTime::SetToLastWeekDay(WeekDay weekday,
1831 Month month,
1832 int year)
1833 {
1834 return SetToWeekDay(weekday, -1, month, year);
1835 }
1836
1837 inline wxDateTime
1838 wxDateTime::GetWeekDayInSameWeek(WeekDay weekday,
1839 WeekFlags WXUNUSED(flags)) const
1840 {
1841 MODIFY_AND_RETURN( SetToWeekDayInSameWeek(weekday) );
1842 }
1843
1844 inline wxDateTime wxDateTime::GetNextWeekDay(WeekDay weekday) const
1845 {
1846 MODIFY_AND_RETURN( SetToNextWeekDay(weekday) );
1847 }
1848
1849 inline wxDateTime wxDateTime::GetPrevWeekDay(WeekDay weekday) const
1850 {
1851 MODIFY_AND_RETURN( SetToPrevWeekDay(weekday) );
1852 }
1853
1854 inline wxDateTime wxDateTime::GetWeekDay(WeekDay weekday,
1855 int n,
1856 Month month,
1857 int year) const
1858 {
1859 wxDateTime dt(*this);
1860
1861 return dt.SetToWeekDay(weekday, n, month, year) ? dt : wxInvalidDateTime;
1862 }
1863
1864 inline wxDateTime wxDateTime::GetLastWeekDay(WeekDay weekday,
1865 Month month,
1866 int year)
1867 {
1868 wxDateTime dt(*this);
1869
1870 return dt.SetToLastWeekDay(weekday, month, year) ? dt : wxInvalidDateTime;
1871 }
1872
1873 inline wxDateTime wxDateTime::GetLastMonthDay(Month month, int year) const
1874 {
1875 MODIFY_AND_RETURN( SetToLastMonthDay(month, year) );
1876 }
1877
1878 inline wxDateTime wxDateTime::GetYearDay(wxDateTime_t yday) const
1879 {
1880 MODIFY_AND_RETURN( SetToYearDay(yday) );
1881 }
1882
1883 // ----------------------------------------------------------------------------
1884 // wxDateTime comparison
1885 // ----------------------------------------------------------------------------
1886
1887 inline bool wxDateTime::IsEqualTo(const wxDateTime& datetime) const
1888 {
1889 wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
1890
1891 return m_time == datetime.m_time;
1892 }
1893
1894 inline bool wxDateTime::IsEarlierThan(const wxDateTime& datetime) const
1895 {
1896 wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
1897
1898 return m_time < datetime.m_time;
1899 }
1900
1901 inline bool wxDateTime::IsLaterThan(const wxDateTime& datetime) const
1902 {
1903 wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
1904
1905 return m_time > datetime.m_time;
1906 }
1907
1908 inline bool wxDateTime::IsStrictlyBetween(const wxDateTime& t1,
1909 const wxDateTime& t2) const
1910 {
1911 // no need for assert, will be checked by the functions we call
1912 return IsLaterThan(t1) && IsEarlierThan(t2);
1913 }
1914
1915 inline bool wxDateTime::IsBetween(const wxDateTime& t1,
1916 const wxDateTime& t2) const
1917 {
1918 // no need for assert, will be checked by the functions we call
1919 return IsEqualTo(t1) || IsEqualTo(t2) || IsStrictlyBetween(t1, t2);
1920 }
1921
1922 inline bool wxDateTime::IsSameDate(const wxDateTime& dt) const
1923 {
1924 Tm tm1 = GetTm(),
1925 tm2 = dt.GetTm();
1926
1927 return tm1.year == tm2.year &&
1928 tm1.mon == tm2.mon &&
1929 tm1.mday == tm2.mday;
1930 }
1931
1932 inline bool wxDateTime::IsSameTime(const wxDateTime& dt) const
1933 {
1934 // notice that we can't do something like this:
1935 //
1936 // m_time % MILLISECONDS_PER_DAY == dt.m_time % MILLISECONDS_PER_DAY
1937 //
1938 // because we have also to deal with (possibly) different DST settings!
1939 Tm tm1 = GetTm(),
1940 tm2 = dt.GetTm();
1941
1942 return tm1.hour == tm2.hour &&
1943 tm1.min == tm2.min &&
1944 tm1.sec == tm2.sec &&
1945 tm1.msec == tm2.msec;
1946 }
1947
1948 inline bool wxDateTime::IsEqualUpTo(const wxDateTime& dt,
1949 const wxTimeSpan& ts) const
1950 {
1951 return IsBetween(dt.Subtract(ts), dt.Add(ts));
1952 }
1953
1954 // ----------------------------------------------------------------------------
1955 // wxDateTime arithmetics
1956 // ----------------------------------------------------------------------------
1957
1958 inline wxDateTime wxDateTime::Add(const wxTimeSpan& diff) const
1959 {
1960 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1961
1962 return wxDateTime(m_time + diff.GetValue());
1963 }
1964
1965 inline wxDateTime& wxDateTime::Add(const wxTimeSpan& diff)
1966 {
1967 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1968
1969 m_time += diff.GetValue();
1970
1971 return *this;
1972 }
1973
1974 inline wxDateTime& wxDateTime::operator+=(const wxTimeSpan& diff)
1975 {
1976 return Add(diff);
1977 }
1978
1979 inline wxDateTime wxDateTime::Subtract(const wxTimeSpan& diff) const
1980 {
1981 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1982
1983 return wxDateTime(m_time - diff.GetValue());
1984 }
1985
1986 inline wxDateTime& wxDateTime::Subtract(const wxTimeSpan& diff)
1987 {
1988 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime"));
1989
1990 m_time -= diff.GetValue();
1991
1992 return *this;
1993 }
1994
1995 inline wxDateTime& wxDateTime::operator-=(const wxTimeSpan& diff)
1996 {
1997 return Subtract(diff);
1998 }
1999
2000 inline wxTimeSpan wxDateTime::Subtract(const wxDateTime& datetime) const
2001 {
2002 wxASSERT_MSG( IsValid() && datetime.IsValid(), _T("invalid wxDateTime"));
2003
2004 return wxTimeSpan(GetValue() - datetime.GetValue());
2005 }
2006
2007 inline wxTimeSpan wxDateTime::operator-(const wxDateTime& dt2) const
2008 {
2009 return this->Subtract(dt2);
2010 }
2011
2012 inline wxDateTime wxDateTime::Add(const wxDateSpan& diff) const
2013 {
2014 return wxDateTime(*this).Add(diff);
2015 }
2016
2017 inline wxDateTime& wxDateTime::Subtract(const wxDateSpan& diff)
2018 {
2019 return Add(diff.Negate());
2020 }
2021
2022 inline wxDateTime wxDateTime::Subtract(const wxDateSpan& diff) const
2023 {
2024 return wxDateTime(*this).Subtract(diff);
2025 }
2026
2027 inline wxDateTime& wxDateTime::operator-=(const wxDateSpan& diff)
2028 {
2029 return Subtract(diff);
2030 }
2031
2032 inline wxDateTime& wxDateTime::operator+=(const wxDateSpan& diff)
2033 {
2034 return Add(diff);
2035 }
2036
2037 // ----------------------------------------------------------------------------
2038 // wxDateTime and timezones
2039 // ----------------------------------------------------------------------------
2040
2041 inline wxDateTime
2042 wxDateTime::ToTimezone(const wxDateTime::TimeZone& tz, bool noDST) const
2043 {
2044 MODIFY_AND_RETURN( MakeTimezone(tz, noDST) );
2045 }
2046
2047 inline wxDateTime
2048 wxDateTime::FromTimezone(const wxDateTime::TimeZone& tz, bool noDST) const
2049 {
2050 MODIFY_AND_RETURN( MakeFromTimezone(tz, noDST) );
2051 }
2052
2053 // ----------------------------------------------------------------------------
2054 // wxTimeSpan construction
2055 // ----------------------------------------------------------------------------
2056
2057 inline wxTimeSpan::wxTimeSpan(long hours,
2058 long minutes,
2059 wxLongLong seconds,
2060 wxLongLong milliseconds)
2061 {
2062 // assign first to avoid precision loss
2063 m_diff = hours;
2064 m_diff *= 60l;
2065 m_diff += minutes;
2066 m_diff *= 60l;
2067 m_diff += seconds;
2068 m_diff *= 1000l;
2069 m_diff += milliseconds;
2070 }
2071
2072 // ----------------------------------------------------------------------------
2073 // wxTimeSpan accessors
2074 // ----------------------------------------------------------------------------
2075
2076 inline wxLongLong wxTimeSpan::GetSeconds() const
2077 {
2078 return m_diff / 1000l;
2079 }
2080
2081 inline int wxTimeSpan::GetMinutes() const
2082 {
2083 // explicit cast to int suppresses a warning with CodeWarrior and possibly
2084 // others (changing the return type to long from int is impossible in 2.8)
2085 return (int)((GetSeconds() / 60l).GetLo());
2086 }
2087
2088 inline int wxTimeSpan::GetHours() const
2089 {
2090 return GetMinutes() / 60;
2091 }
2092
2093 inline int wxTimeSpan::GetDays() const
2094 {
2095 return GetHours() / 24;
2096 }
2097
2098 inline int wxTimeSpan::GetWeeks() const
2099 {
2100 return GetDays() / 7;
2101 }
2102
2103 // ----------------------------------------------------------------------------
2104 // wxTimeSpan arithmetics
2105 // ----------------------------------------------------------------------------
2106
2107 inline wxTimeSpan wxTimeSpan::Add(const wxTimeSpan& diff) const
2108 {
2109 return wxTimeSpan(m_diff + diff.GetValue());
2110 }
2111
2112 inline wxTimeSpan& wxTimeSpan::Add(const wxTimeSpan& diff)
2113 {
2114 m_diff += diff.GetValue();
2115
2116 return *this;
2117 }
2118
2119 inline wxTimeSpan wxTimeSpan::Subtract(const wxTimeSpan& diff) const
2120 {
2121 return wxTimeSpan(m_diff - diff.GetValue());
2122 }
2123
2124 inline wxTimeSpan& wxTimeSpan::Subtract(const wxTimeSpan& diff)
2125 {
2126 m_diff -= diff.GetValue();
2127
2128 return *this;
2129 }
2130
2131 inline wxTimeSpan& wxTimeSpan::Multiply(int n)
2132 {
2133 m_diff *= (long)n;
2134
2135 return *this;
2136 }
2137
2138 inline wxTimeSpan wxTimeSpan::Multiply(int n) const
2139 {
2140 return wxTimeSpan(m_diff * (long)n);
2141 }
2142
2143 inline wxTimeSpan wxTimeSpan::Abs() const
2144 {
2145 return wxTimeSpan(GetValue().Abs());
2146 }
2147
2148 inline bool wxTimeSpan::IsEqualTo(const wxTimeSpan& ts) const
2149 {
2150 return GetValue() == ts.GetValue();
2151 }
2152
2153 inline bool wxTimeSpan::IsLongerThan(const wxTimeSpan& ts) const
2154 {
2155 return GetValue().Abs() > ts.GetValue().Abs();
2156 }
2157
2158 // ----------------------------------------------------------------------------
2159 // wxDateSpan
2160 // ----------------------------------------------------------------------------
2161
2162 inline wxDateSpan& wxDateSpan::operator+=(const wxDateSpan& other)
2163 {
2164 m_years += other.m_years;
2165 m_months += other.m_months;
2166 m_weeks += other.m_weeks;
2167 m_days += other.m_days;
2168
2169 return *this;
2170 }
2171
2172 inline wxDateSpan& wxDateSpan::Add(const wxDateSpan& other)
2173 {
2174 return *this += other;
2175 }
2176
2177 inline wxDateSpan wxDateSpan::Add(const wxDateSpan& other) const
2178 {
2179 wxDateSpan ds(*this);
2180 ds.Add(other);
2181 return ds;
2182 }
2183
2184 inline wxDateSpan& wxDateSpan::Multiply(int factor)
2185 {
2186 m_years *= factor;
2187 m_months *= factor;
2188 m_weeks *= factor;
2189 m_days *= factor;
2190
2191 return *this;
2192 }
2193
2194 inline wxDateSpan wxDateSpan::Multiply(int factor) const
2195 {
2196 wxDateSpan ds(*this);
2197 ds.Multiply(factor);
2198 return ds;
2199 }
2200
2201 inline wxDateSpan wxDateSpan::Negate() const
2202 {
2203 return wxDateSpan(-m_years, -m_months, -m_weeks, -m_days);
2204 }
2205
2206 inline wxDateSpan& wxDateSpan::Neg()
2207 {
2208 m_years = -m_years;
2209 m_months = -m_months;
2210 m_weeks = -m_weeks;
2211 m_days = -m_days;
2212
2213 return *this;
2214 }
2215
2216 inline wxDateSpan& wxDateSpan::operator-=(const wxDateSpan& other)
2217 {
2218 return *this += other.Negate();
2219 }
2220
2221 inline wxDateSpan& wxDateSpan::Subtract(const wxDateSpan& other)
2222 {
2223 return *this -= other;
2224 }
2225
2226 inline wxDateSpan wxDateSpan::Subtract(const wxDateSpan& other) const
2227 {
2228 wxDateSpan ds(*this);
2229 ds.Subtract(other);
2230 return ds;
2231 }
2232
2233 #undef MILLISECONDS_PER_DAY
2234
2235 #undef MODIFY_AND_RETURN
2236
2237 // ============================================================================
2238 // binary operators
2239 // ============================================================================
2240
2241 // ----------------------------------------------------------------------------
2242 // wxTimeSpan operators
2243 // ----------------------------------------------------------------------------
2244
2245 wxTimeSpan WXDLLIMPEXP_BASE operator*(int n, const wxTimeSpan& ts);
2246
2247 // ----------------------------------------------------------------------------
2248 // wxDateSpan
2249 // ----------------------------------------------------------------------------
2250
2251 wxDateSpan WXDLLIMPEXP_BASE operator*(int n, const wxDateSpan& ds);
2252
2253 // ============================================================================
2254 // other helper functions
2255 // ============================================================================
2256
2257 // ----------------------------------------------------------------------------
2258 // iteration helpers: can be used to write a for loop over enum variable like
2259 // this:
2260 // for ( m = wxDateTime::Jan; m < wxDateTime::Inv_Month; wxNextMonth(m) )
2261 // ----------------------------------------------------------------------------
2262
2263 WXDLLIMPEXP_BASE void wxNextMonth(wxDateTime::Month& m);
2264 WXDLLIMPEXP_BASE void wxPrevMonth(wxDateTime::Month& m);
2265 WXDLLIMPEXP_BASE void wxNextWDay(wxDateTime::WeekDay& wd);
2266 WXDLLIMPEXP_BASE void wxPrevWDay(wxDateTime::WeekDay& wd);
2267
2268 #endif // wxUSE_DATETIME
2269
2270 #endif // _WX_DATETIME_H