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