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