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