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