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