]> git.saurik.com Git - wxWidgets.git/blob - src/common/datetime.cpp
merged 2 overloaded functions into a single membersections
[wxWidgets.git] / src / common / datetime.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/datetime.h
3 // Purpose: implementation of time/date related classes
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 11.05.99
7 // RCS-ID: $Id$
8 // Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // parts of code taken from sndcal library by Scott E. Lee:
10 //
11 // Copyright 1993-1995, Scott E. Lee, all rights reserved.
12 // Permission granted to use, copy, modify, distribute and sell
13 // so long as the above copyright and this permission statement
14 // are retained in all copies.
15 //
16 // Licence: wxWindows licence
17 ///////////////////////////////////////////////////////////////////////////////
18
19 /*
20 * Implementation notes:
21 *
22 * 1. the time is stored as a 64bit integer containing the signed number of
23 * milliseconds since Jan 1. 1970 (the Unix Epoch) - so it is always
24 * expressed in GMT.
25 *
26 * 2. the range is thus something about 580 million years, but due to current
27 * algorithms limitations, only dates from Nov 24, 4714BC are handled
28 *
29 * 3. standard ANSI C functions are used to do time calculations whenever
30 * possible, i.e. when the date is in the range Jan 1, 1970 to 2038
31 *
32 * 4. otherwise, the calculations are done by converting the date to/from JDN
33 * first (the range limitation mentioned above comes from here: the
34 * algorithm used by Scott E. Lee's code only works for positive JDNs, more
35 * or less)
36 *
37 * 5. the object constructed for the given DD-MM-YYYY HH:MM:SS corresponds to
38 * this moment in local time and may be converted to the object
39 * corresponding to the same date/time in another time zone by using
40 * ToTimezone()
41 *
42 * 6. the conversions to the current (or any other) timezone are done when the
43 * internal time representation is converted to the broken-down one in
44 * wxDateTime::Tm.
45 */
46
47 // ============================================================================
48 // declarations
49 // ============================================================================
50
51 // ----------------------------------------------------------------------------
52 // headers
53 // ----------------------------------------------------------------------------
54
55 #ifdef __GNUG__
56 #pragma implementation "datetime.h"
57 #endif
58
59 // For compilers that support precompilation, includes "wx.h".
60 #include "wx/wxprec.h"
61
62 #ifdef __BORLANDC__
63 #pragma hdrstop
64 #endif
65
66 #if !defined(wxUSE_DATETIME) || wxUSE_DATETIME
67
68 #ifndef WX_PRECOMP
69 #include "wx/string.h"
70 #include "wx/log.h"
71 #endif // WX_PRECOMP
72
73 #include "wx/intl.h"
74 #include "wx/thread.h"
75 #include "wx/tokenzr.h"
76 #include "wx/module.h"
77
78 #define wxDEFINE_TIME_CONSTANTS // before including datetime.h
79
80 #include <ctype.h>
81
82 #include "wx/datetime.h"
83 #include "wx/timer.h" // for wxGetLocalTimeMillis()
84
85 // ----------------------------------------------------------------------------
86 // conditional compilation
87 // ----------------------------------------------------------------------------
88
89 #if defined(HAVE_STRPTIME) && defined(__LINUX__)
90 // glibc 2.0.7 strptime() is broken - the following snippet causes it to
91 // crash (instead of just failing):
92 //
93 // strncpy(buf, "Tue Dec 21 20:25:40 1999", 128);
94 // strptime(buf, "%x", &tm);
95 //
96 // so don't use it
97 #undef HAVE_STRPTIME
98 #endif // broken strptime()
99
100 #if defined(__MWERKS__) && wxUSE_UNICODE
101 #include <wtime.h>
102 #endif
103
104 #if !defined(WX_TIMEZONE) && !defined(WX_GMTOFF_IN_TM)
105 #if defined(__BORLANDC__) || defined(__MINGW32__) || defined(__VISAGECPP__)
106 #define WX_TIMEZONE _timezone
107 #elif defined(__MWERKS__)
108 long wxmw_timezone = 28800;
109 #define WX_TIMEZONE wxmw_timezone
110 #elif defined(__DJGPP__) || defined(__WINE__)
111 #include <sys/timeb.h>
112 #include <values.h>
113 static long wxGetTimeZone()
114 {
115 static long timezone = MAXLONG; // invalid timezone
116 if (timezone == MAXLONG)
117 {
118 struct timeb tb;
119 ftime(&tb);
120 timezone = tb.timezone;
121 }
122 return timezone;
123 }
124 #define WX_TIMEZONE wxGetTimeZone()
125 #elif defined(__DARWIN__)
126 #define WX_GMTOFF_IN_TM
127 #else // unknown platform - try timezone
128 #define WX_TIMEZONE timezone
129 #endif
130 #endif // !WX_TIMEZONE && !WX_GMTOFF_IN_TM
131
132 // ----------------------------------------------------------------------------
133 // macros
134 // ----------------------------------------------------------------------------
135
136 // debugging helper: just a convenient replacement of wxCHECK()
137 #define wxDATETIME_CHECK(expr, msg) \
138 if ( !(expr) ) \
139 { \
140 wxFAIL_MSG(msg); \
141 *this = wxInvalidDateTime; \
142 return *this; \
143 }
144
145 // ----------------------------------------------------------------------------
146 // private classes
147 // ----------------------------------------------------------------------------
148
149 class wxDateTimeHolidaysModule : public wxModule
150 {
151 public:
152 virtual bool OnInit()
153 {
154 wxDateTimeHolidayAuthority::AddAuthority(new wxDateTimeWorkDays);
155
156 return TRUE;
157 }
158
159 virtual void OnExit()
160 {
161 wxDateTimeHolidayAuthority::ClearAllAuthorities();
162 wxDateTimeHolidayAuthority::ms_authorities.Clear();
163 }
164
165 private:
166 DECLARE_DYNAMIC_CLASS(wxDateTimeHolidaysModule)
167 };
168
169 IMPLEMENT_DYNAMIC_CLASS(wxDateTimeHolidaysModule, wxModule)
170
171 // ----------------------------------------------------------------------------
172 // constants
173 // ----------------------------------------------------------------------------
174
175 // some trivial ones
176 static const int MONTHS_IN_YEAR = 12;
177
178 static const int SEC_PER_MIN = 60;
179
180 static const int MIN_PER_HOUR = 60;
181
182 static const int HOURS_PER_DAY = 24;
183
184 static const long SECONDS_PER_DAY = 86400l;
185
186 static const int DAYS_PER_WEEK = 7;
187
188 static const long MILLISECONDS_PER_DAY = 86400000l;
189
190 // this is the integral part of JDN of the midnight of Jan 1, 1970
191 // (i.e. JDN(Jan 1, 1970) = 2440587.5)
192 static const long EPOCH_JDN = 2440587l;
193
194 // the date of JDN -0.5 (as we don't work with fractional parts, this is the
195 // reference date for us) is Nov 24, 4714BC
196 static const int JDN_0_YEAR = -4713;
197 static const int JDN_0_MONTH = wxDateTime::Nov;
198 static const int JDN_0_DAY = 24;
199
200 // the constants used for JDN calculations
201 static const long JDN_OFFSET = 32046l;
202 static const long DAYS_PER_5_MONTHS = 153l;
203 static const long DAYS_PER_4_YEARS = 1461l;
204 static const long DAYS_PER_400_YEARS = 146097l;
205
206 // this array contains the cumulated number of days in all previous months for
207 // normal and leap years
208 static const wxDateTime::wxDateTime_t gs_cumulatedDays[2][MONTHS_IN_YEAR] =
209 {
210 { 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334 },
211 { 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335 }
212 };
213
214 // ----------------------------------------------------------------------------
215 // global data
216 // ----------------------------------------------------------------------------
217
218 // in the fine tradition of ANSI C we use our equivalent of (time_t)-1 to
219 // indicate an invalid wxDateTime object
220 const wxDateTime wxDefaultDateTime;
221
222 wxDateTime::Country wxDateTime::ms_country = wxDateTime::Country_Unknown;
223
224 // ----------------------------------------------------------------------------
225 // private globals
226 // ----------------------------------------------------------------------------
227
228 // a critical section is needed to protect GetTimeZone() static
229 // variable in MT case
230 #if wxUSE_THREADS
231 static wxCriticalSection gs_critsectTimezone;
232 #endif // wxUSE_THREADS
233
234 // ----------------------------------------------------------------------------
235 // private functions
236 // ----------------------------------------------------------------------------
237
238 // debugger helper: shows what the date really is
239 #ifdef __WXDEBUG__
240 extern const wxChar *wxDumpDate(const wxDateTime* dt)
241 {
242 static wxChar buf[128];
243
244 wxStrcpy(buf, dt->Format(_T("%Y-%m-%d (%a) %H:%M:%S")));
245
246 return buf;
247 }
248 #endif // Debug
249
250 // get the number of days in the given month of the given year
251 static inline
252 wxDateTime::wxDateTime_t GetNumOfDaysInMonth(int year, wxDateTime::Month month)
253 {
254 // the number of days in month in Julian/Gregorian calendar: the first line
255 // is for normal years, the second one is for the leap ones
256 static wxDateTime::wxDateTime_t daysInMonth[2][MONTHS_IN_YEAR] =
257 {
258 { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 },
259 { 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }
260 };
261
262 return daysInMonth[wxDateTime::IsLeapYear(year)][month];
263 }
264
265 // returns the time zone in the C sense, i.e. the difference UTC - local
266 // (in seconds)
267 static int GetTimeZone()
268 {
269 // set to TRUE when the timezone is set
270 static bool s_timezoneSet = FALSE;
271 #ifdef WX_GMTOFF_IN_TM
272 static long gmtoffset = LONG_MAX; // invalid timezone
273 #endif
274
275 wxCRIT_SECT_LOCKER(lock, gs_critsectTimezone);
276
277 // ensure that the timezone variable is set by calling localtime
278 if ( !s_timezoneSet )
279 {
280 // just call localtime() instead of figuring out whether this system
281 // supports tzset(), _tzset() or something else
282 time_t t = 0;
283 struct tm *tm;
284
285 tm = localtime(&t);
286 s_timezoneSet = TRUE;
287
288 #ifdef WX_GMTOFF_IN_TM
289 // note that GMT offset is the opposite of time zone and so to return
290 // consistent results in both WX_GMTOFF_IN_TM and !WX_GMTOFF_IN_TM
291 // cases we have to negate it
292 gmtoffset = -tm->tm_gmtoff;
293 #endif
294 }
295
296 #ifdef WX_GMTOFF_IN_TM
297 return (int)gmtoffset;
298 #else
299 return (int)WX_TIMEZONE;
300 #endif
301 }
302
303 // return the integral part of the JDN for the midnight of the given date (to
304 // get the real JDN you need to add 0.5, this is, in fact, JDN of the
305 // noon of the previous day)
306 static long GetTruncatedJDN(wxDateTime::wxDateTime_t day,
307 wxDateTime::Month mon,
308 int year)
309 {
310 // CREDIT: code below is by Scott E. Lee (but bugs are mine)
311
312 // check the date validity
313 wxASSERT_MSG(
314 (year > JDN_0_YEAR) ||
315 ((year == JDN_0_YEAR) && (mon > JDN_0_MONTH)) ||
316 ((year == JDN_0_YEAR) && (mon == JDN_0_MONTH) && (day >= JDN_0_DAY)),
317 _T("date out of range - can't convert to JDN")
318 );
319
320 // make the year positive to avoid problems with negative numbers division
321 year += 4800;
322
323 // months are counted from March here
324 int month;
325 if ( mon >= wxDateTime::Mar )
326 {
327 month = mon - 2;
328 }
329 else
330 {
331 month = mon + 10;
332 year--;
333 }
334
335 // now we can simply add all the contributions together
336 return ((year / 100) * DAYS_PER_400_YEARS) / 4
337 + ((year % 100) * DAYS_PER_4_YEARS) / 4
338 + (month * DAYS_PER_5_MONTHS + 2) / 5
339 + day
340 - JDN_OFFSET;
341 }
342
343 // this function is a wrapper around strftime(3)
344 static wxString CallStrftime(const wxChar *format, const tm* tm)
345 {
346 wxChar buf[4096];
347 if ( !wxStrftime(buf, WXSIZEOF(buf), format, tm) )
348 {
349 // buffer is too small?
350 wxFAIL_MSG(_T("strftime() failed"));
351 }
352
353 return wxString(buf);
354 }
355
356 // if year and/or month have invalid values, replace them with the current ones
357 static void ReplaceDefaultYearMonthWithCurrent(int *year,
358 wxDateTime::Month *month)
359 {
360 struct tm *tmNow = NULL;
361
362 if ( *year == wxDateTime::Inv_Year )
363 {
364 tmNow = wxDateTime::GetTmNow();
365
366 *year = 1900 + tmNow->tm_year;
367 }
368
369 if ( *month == wxDateTime::Inv_Month )
370 {
371 if ( !tmNow )
372 tmNow = wxDateTime::GetTmNow();
373
374 *month = (wxDateTime::Month)tmNow->tm_mon;
375 }
376 }
377
378 // fll the struct tm with default values
379 static void InitTm(struct tm& tm)
380 {
381 // struct tm may have etxra fields (undocumented and with unportable
382 // names) which, nevertheless, must be set to 0
383 memset(&tm, 0, sizeof(struct tm));
384
385 tm.tm_mday = 1; // mday 0 is invalid
386 tm.tm_year = 76; // any valid year
387 tm.tm_isdst = -1; // auto determine
388 }
389
390 // parsing helpers
391 // ---------------
392
393 // return the month if the string is a month name or Inv_Month otherwise
394 static wxDateTime::Month GetMonthFromName(const wxString& name, int flags)
395 {
396 wxDateTime::Month mon;
397 for ( mon = wxDateTime::Jan; mon < wxDateTime::Inv_Month; wxNextMonth(mon) )
398 {
399 // case-insensitive comparison either one of or with both abbreviated
400 // and not versions
401 if ( flags & wxDateTime::Name_Full )
402 {
403 if ( name.CmpNoCase(wxDateTime::
404 GetMonthName(mon, wxDateTime::Name_Full)) == 0 )
405 {
406 break;
407 }
408 }
409
410 if ( flags & wxDateTime::Name_Abbr )
411 {
412 if ( name.CmpNoCase(wxDateTime::
413 GetMonthName(mon, wxDateTime::Name_Abbr)) == 0 )
414 {
415 break;
416 }
417 }
418 }
419
420 return mon;
421 }
422
423 // return the weekday if the string is a weekday name or Inv_WeekDay otherwise
424 static wxDateTime::WeekDay GetWeekDayFromName(const wxString& name, int flags)
425 {
426 wxDateTime::WeekDay wd;
427 for ( wd = wxDateTime::Sun; wd < wxDateTime::Inv_WeekDay; wxNextWDay(wd) )
428 {
429 // case-insensitive comparison either one of or with both abbreviated
430 // and not versions
431 if ( flags & wxDateTime::Name_Full )
432 {
433 if ( name.CmpNoCase(wxDateTime::
434 GetWeekDayName(wd, wxDateTime::Name_Full)) == 0 )
435 {
436 break;
437 }
438 }
439
440 if ( flags & wxDateTime::Name_Abbr )
441 {
442 if ( name.CmpNoCase(wxDateTime::
443 GetWeekDayName(wd, wxDateTime::Name_Abbr)) == 0 )
444 {
445 break;
446 }
447 }
448 }
449
450 return wd;
451 }
452
453 // scans all digits (but no more than len) and returns the resulting number
454 static bool GetNumericToken(size_t len, const wxChar*& p, unsigned long *number)
455 {
456 size_t n = 1;
457 wxString s;
458 while ( wxIsdigit(*p) )
459 {
460 s += *p++;
461
462 if ( len && ++n > len )
463 break;
464 }
465
466 return !!s && s.ToULong(number);
467 }
468
469 // scans all alphabetic characters and returns the resulting string
470 static wxString GetAlphaToken(const wxChar*& p)
471 {
472 wxString s;
473 while ( wxIsalpha(*p) )
474 {
475 s += *p++;
476 }
477
478 return s;
479 }
480
481 // ============================================================================
482 // implementation of wxDateTime
483 // ============================================================================
484
485 // ----------------------------------------------------------------------------
486 // struct Tm
487 // ----------------------------------------------------------------------------
488
489 wxDateTime::Tm::Tm()
490 {
491 year = (wxDateTime_t)wxDateTime::Inv_Year;
492 mon = wxDateTime::Inv_Month;
493 mday = 0;
494 hour = min = sec = msec = 0;
495 wday = wxDateTime::Inv_WeekDay;
496 }
497
498 wxDateTime::Tm::Tm(const struct tm& tm, const TimeZone& tz)
499 : m_tz(tz)
500 {
501 msec = 0;
502 sec = tm.tm_sec;
503 min = tm.tm_min;
504 hour = tm.tm_hour;
505 mday = tm.tm_mday;
506 mon = (wxDateTime::Month)tm.tm_mon;
507 year = 1900 + tm.tm_year;
508 wday = tm.tm_wday;
509 yday = tm.tm_yday;
510 }
511
512 bool wxDateTime::Tm::IsValid() const
513 {
514 // we allow for the leap seconds, although we don't use them (yet)
515 return (year != wxDateTime::Inv_Year) && (mon != wxDateTime::Inv_Month) &&
516 (mday <= GetNumOfDaysInMonth(year, mon)) &&
517 (hour < 24) && (min < 60) && (sec < 62) && (msec < 1000);
518 }
519
520 void wxDateTime::Tm::ComputeWeekDay()
521 {
522 // compute the week day from day/month/year: we use the dumbest algorithm
523 // possible: just compute our JDN and then use the (simple to derive)
524 // formula: weekday = (JDN + 1.5) % 7
525 wday = (wxDateTime::WeekDay)(GetTruncatedJDN(mday, mon, year) + 2) % 7;
526 }
527
528 void wxDateTime::Tm::AddMonths(int monDiff)
529 {
530 // normalize the months field
531 while ( monDiff < -mon )
532 {
533 year--;
534
535 monDiff += MONTHS_IN_YEAR;
536 }
537
538 while ( monDiff + mon >= MONTHS_IN_YEAR )
539 {
540 year++;
541
542 monDiff -= MONTHS_IN_YEAR;
543 }
544
545 mon = (wxDateTime::Month)(mon + monDiff);
546
547 wxASSERT_MSG( mon >= 0 && mon < MONTHS_IN_YEAR, _T("logic error") );
548
549 // NB: we don't check here that the resulting date is valid, this function
550 // is private and the caller must check it if needed
551 }
552
553 void wxDateTime::Tm::AddDays(int dayDiff)
554 {
555 // normalize the days field
556 while ( dayDiff + mday < 1 )
557 {
558 AddMonths(-1);
559
560 dayDiff += GetNumOfDaysInMonth(year, mon);
561 }
562
563 mday += dayDiff;
564 while ( mday > GetNumOfDaysInMonth(year, mon) )
565 {
566 mday -= GetNumOfDaysInMonth(year, mon);
567
568 AddMonths(1);
569 }
570
571 wxASSERT_MSG( mday > 0 && mday <= GetNumOfDaysInMonth(year, mon),
572 _T("logic error") );
573 }
574
575 // ----------------------------------------------------------------------------
576 // class TimeZone
577 // ----------------------------------------------------------------------------
578
579 wxDateTime::TimeZone::TimeZone(wxDateTime::TZ tz)
580 {
581 switch ( tz )
582 {
583 case wxDateTime::Local:
584 // get the offset from C RTL: it returns the difference GMT-local
585 // while we want to have the offset _from_ GMT, hence the '-'
586 m_offset = -GetTimeZone();
587 break;
588
589 case wxDateTime::GMT_12:
590 case wxDateTime::GMT_11:
591 case wxDateTime::GMT_10:
592 case wxDateTime::GMT_9:
593 case wxDateTime::GMT_8:
594 case wxDateTime::GMT_7:
595 case wxDateTime::GMT_6:
596 case wxDateTime::GMT_5:
597 case wxDateTime::GMT_4:
598 case wxDateTime::GMT_3:
599 case wxDateTime::GMT_2:
600 case wxDateTime::GMT_1:
601 m_offset = -3600*(wxDateTime::GMT0 - tz);
602 break;
603
604 case wxDateTime::GMT0:
605 case wxDateTime::GMT1:
606 case wxDateTime::GMT2:
607 case wxDateTime::GMT3:
608 case wxDateTime::GMT4:
609 case wxDateTime::GMT5:
610 case wxDateTime::GMT6:
611 case wxDateTime::GMT7:
612 case wxDateTime::GMT8:
613 case wxDateTime::GMT9:
614 case wxDateTime::GMT10:
615 case wxDateTime::GMT11:
616 case wxDateTime::GMT12:
617 m_offset = 3600*(tz - wxDateTime::GMT0);
618 break;
619
620 case wxDateTime::A_CST:
621 // Central Standard Time in use in Australia = UTC + 9.5
622 m_offset = 60l*(9*60 + 30);
623 break;
624
625 default:
626 wxFAIL_MSG( _T("unknown time zone") );
627 }
628 }
629
630 // ----------------------------------------------------------------------------
631 // static functions
632 // ----------------------------------------------------------------------------
633
634 /* static */
635 bool wxDateTime::IsLeapYear(int year, wxDateTime::Calendar cal)
636 {
637 if ( year == Inv_Year )
638 year = GetCurrentYear();
639
640 if ( cal == Gregorian )
641 {
642 // in Gregorian calendar leap years are those divisible by 4 except
643 // those divisible by 100 unless they're also divisible by 400
644 // (in some countries, like Russia and Greece, additional corrections
645 // exist, but they won't manifest themselves until 2700)
646 return (year % 4 == 0) && ((year % 100 != 0) || (year % 400 == 0));
647 }
648 else if ( cal == Julian )
649 {
650 // in Julian calendar the rule is simpler
651 return year % 4 == 0;
652 }
653 else
654 {
655 wxFAIL_MSG(_T("unknown calendar"));
656
657 return FALSE;
658 }
659 }
660
661 /* static */
662 int wxDateTime::GetCentury(int year)
663 {
664 return year > 0 ? year / 100 : year / 100 - 1;
665 }
666
667 /* static */
668 int wxDateTime::ConvertYearToBC(int year)
669 {
670 // year 0 is BC 1
671 return year > 0 ? year : year - 1;
672 }
673
674 /* static */
675 int wxDateTime::GetCurrentYear(wxDateTime::Calendar cal)
676 {
677 switch ( cal )
678 {
679 case Gregorian:
680 return Now().GetYear();
681
682 case Julian:
683 wxFAIL_MSG(_T("TODO"));
684 break;
685
686 default:
687 wxFAIL_MSG(_T("unsupported calendar"));
688 break;
689 }
690
691 return Inv_Year;
692 }
693
694 /* static */
695 wxDateTime::Month wxDateTime::GetCurrentMonth(wxDateTime::Calendar cal)
696 {
697 switch ( cal )
698 {
699 case Gregorian:
700 return Now().GetMonth();
701
702 case Julian:
703 wxFAIL_MSG(_T("TODO"));
704 break;
705
706 default:
707 wxFAIL_MSG(_T("unsupported calendar"));
708 break;
709 }
710
711 return Inv_Month;
712 }
713
714 /* static */
715 wxDateTime::wxDateTime_t wxDateTime::GetNumberOfDays(int year, Calendar cal)
716 {
717 if ( year == Inv_Year )
718 {
719 // take the current year if none given
720 year = GetCurrentYear();
721 }
722
723 switch ( cal )
724 {
725 case Gregorian:
726 case Julian:
727 return IsLeapYear(year) ? 366 : 365;
728
729 default:
730 wxFAIL_MSG(_T("unsupported calendar"));
731 break;
732 }
733
734 return 0;
735 }
736
737 /* static */
738 wxDateTime::wxDateTime_t wxDateTime::GetNumberOfDays(wxDateTime::Month month,
739 int year,
740 wxDateTime::Calendar cal)
741 {
742 wxCHECK_MSG( month < MONTHS_IN_YEAR, 0, _T("invalid month") );
743
744 if ( cal == Gregorian || cal == Julian )
745 {
746 if ( year == Inv_Year )
747 {
748 // take the current year if none given
749 year = GetCurrentYear();
750 }
751
752 return GetNumOfDaysInMonth(year, month);
753 }
754 else
755 {
756 wxFAIL_MSG(_T("unsupported calendar"));
757
758 return 0;
759 }
760 }
761
762 /* static */
763 wxString wxDateTime::GetMonthName(wxDateTime::Month month,
764 wxDateTime::NameFlags flags)
765 {
766 wxCHECK_MSG( month != Inv_Month, _T(""), _T("invalid month") );
767
768 // notice that we must set all the fields to avoid confusing libc (GNU one
769 // gets confused to a crash if we don't do this)
770 tm tm;
771 InitTm(tm);
772 tm.tm_mon = month;
773
774 return CallStrftime(flags == Name_Abbr ? _T("%b") : _T("%B"), &tm);
775 }
776
777 /* static */
778 wxString wxDateTime::GetWeekDayName(wxDateTime::WeekDay wday,
779 wxDateTime::NameFlags flags)
780 {
781 wxCHECK_MSG( wday != Inv_WeekDay, _T(""), _T("invalid weekday") );
782
783 // take some arbitrary Sunday
784 tm tm;
785 InitTm(tm);
786 tm.tm_mday = 28;
787 tm.tm_mon = Nov;
788 tm.tm_year = 99;
789
790 // and offset it by the number of days needed to get the correct wday
791 tm.tm_mday += wday;
792
793 // call mktime() to normalize it...
794 (void)mktime(&tm);
795
796 // ... and call strftime()
797 return CallStrftime(flags == Name_Abbr ? _T("%a") : _T("%A"), &tm);
798 }
799
800 /* static */
801 void wxDateTime::GetAmPmStrings(wxString *am, wxString *pm)
802 {
803 tm tm;
804 InitTm(tm);
805 if ( am )
806 {
807 *am = CallStrftime(_T("%p"), &tm);
808 }
809 if ( pm )
810 {
811 tm.tm_hour = 13;
812 *pm = CallStrftime(_T("%p"), &tm);
813 }
814 }
815
816 // ----------------------------------------------------------------------------
817 // Country stuff: date calculations depend on the country (DST, work days,
818 // ...), so we need to know which rules to follow.
819 // ----------------------------------------------------------------------------
820
821 /* static */
822 wxDateTime::Country wxDateTime::GetCountry()
823 {
824 // TODO use LOCALE_ICOUNTRY setting under Win32
825
826 if ( ms_country == Country_Unknown )
827 {
828 // try to guess from the time zone name
829 time_t t = time(NULL);
830 struct tm *tm = localtime(&t);
831
832 wxString tz = CallStrftime(_T("%Z"), tm);
833 if ( tz == _T("WET") || tz == _T("WEST") )
834 {
835 ms_country = UK;
836 }
837 else if ( tz == _T("CET") || tz == _T("CEST") )
838 {
839 ms_country = Country_EEC;
840 }
841 else if ( tz == _T("MSK") || tz == _T("MSD") )
842 {
843 ms_country = Russia;
844 }
845 else if ( tz == _T("AST") || tz == _T("ADT") ||
846 tz == _T("EST") || tz == _T("EDT") ||
847 tz == _T("CST") || tz == _T("CDT") ||
848 tz == _T("MST") || tz == _T("MDT") ||
849 tz == _T("PST") || tz == _T("PDT") )
850 {
851 ms_country = USA;
852 }
853 else
854 {
855 // well, choose a default one
856 ms_country = USA;
857 }
858 }
859
860 return ms_country;
861 }
862
863 /* static */
864 void wxDateTime::SetCountry(wxDateTime::Country country)
865 {
866 ms_country = country;
867 }
868
869 /* static */
870 bool wxDateTime::IsWestEuropeanCountry(Country country)
871 {
872 if ( country == Country_Default )
873 {
874 country = GetCountry();
875 }
876
877 return (Country_WesternEurope_Start <= country) &&
878 (country <= Country_WesternEurope_End);
879 }
880
881 // ----------------------------------------------------------------------------
882 // DST calculations: we use 3 different rules for the West European countries,
883 // USA and for the rest of the world. This is undoubtedly false for many
884 // countries, but I lack the necessary info (and the time to gather it),
885 // please add the other rules here!
886 // ----------------------------------------------------------------------------
887
888 /* static */
889 bool wxDateTime::IsDSTApplicable(int year, Country country)
890 {
891 if ( year == Inv_Year )
892 {
893 // take the current year if none given
894 year = GetCurrentYear();
895 }
896
897 if ( country == Country_Default )
898 {
899 country = GetCountry();
900 }
901
902 switch ( country )
903 {
904 case USA:
905 case UK:
906 // DST was first observed in the US and UK during WWI, reused
907 // during WWII and used again since 1966
908 return year >= 1966 ||
909 (year >= 1942 && year <= 1945) ||
910 (year == 1918 || year == 1919);
911
912 default:
913 // assume that it started after WWII
914 return year > 1950;
915 }
916 }
917
918 /* static */
919 wxDateTime wxDateTime::GetBeginDST(int year, Country country)
920 {
921 if ( year == Inv_Year )
922 {
923 // take the current year if none given
924 year = GetCurrentYear();
925 }
926
927 if ( country == Country_Default )
928 {
929 country = GetCountry();
930 }
931
932 if ( !IsDSTApplicable(year, country) )
933 {
934 return wxInvalidDateTime;
935 }
936
937 wxDateTime dt;
938
939 if ( IsWestEuropeanCountry(country) || (country == Russia) )
940 {
941 // DST begins at 1 a.m. GMT on the last Sunday of March
942 if ( !dt.SetToLastWeekDay(Sun, Mar, year) )
943 {
944 // weird...
945 wxFAIL_MSG( _T("no last Sunday in March?") );
946 }
947
948 dt += wxTimeSpan::Hours(1);
949
950 // disable DST tests because it could result in an infinite recursion!
951 dt.MakeGMT(TRUE);
952 }
953 else switch ( country )
954 {
955 case USA:
956 switch ( year )
957 {
958 case 1918:
959 case 1919:
960 // don't know for sure - assume it was in effect all year
961
962 case 1943:
963 case 1944:
964 case 1945:
965 dt.Set(1, Jan, year);
966 break;
967
968 case 1942:
969 // DST was installed Feb 2, 1942 by the Congress
970 dt.Set(2, Feb, year);
971 break;
972
973 // Oil embargo changed the DST period in the US
974 case 1974:
975 dt.Set(6, Jan, 1974);
976 break;
977
978 case 1975:
979 dt.Set(23, Feb, 1975);
980 break;
981
982 default:
983 // before 1986, DST begun on the last Sunday of April, but
984 // in 1986 Reagan changed it to begin at 2 a.m. of the
985 // first Sunday in April
986 if ( year < 1986 )
987 {
988 if ( !dt.SetToLastWeekDay(Sun, Apr, year) )
989 {
990 // weird...
991 wxFAIL_MSG( _T("no first Sunday in April?") );
992 }
993 }
994 else
995 {
996 if ( !dt.SetToWeekDay(Sun, 1, Apr, year) )
997 {
998 // weird...
999 wxFAIL_MSG( _T("no first Sunday in April?") );
1000 }
1001 }
1002
1003 dt += wxTimeSpan::Hours(2);
1004
1005 // TODO what about timezone??
1006 }
1007
1008 break;
1009
1010 default:
1011 // assume Mar 30 as the start of the DST for the rest of the world
1012 // - totally bogus, of course
1013 dt.Set(30, Mar, year);
1014 }
1015
1016 return dt;
1017 }
1018
1019 /* static */
1020 wxDateTime wxDateTime::GetEndDST(int year, Country country)
1021 {
1022 if ( year == Inv_Year )
1023 {
1024 // take the current year if none given
1025 year = GetCurrentYear();
1026 }
1027
1028 if ( country == Country_Default )
1029 {
1030 country = GetCountry();
1031 }
1032
1033 if ( !IsDSTApplicable(year, country) )
1034 {
1035 return wxInvalidDateTime;
1036 }
1037
1038 wxDateTime dt;
1039
1040 if ( IsWestEuropeanCountry(country) || (country == Russia) )
1041 {
1042 // DST ends at 1 a.m. GMT on the last Sunday of October
1043 if ( !dt.SetToLastWeekDay(Sun, Oct, year) )
1044 {
1045 // weirder and weirder...
1046 wxFAIL_MSG( _T("no last Sunday in October?") );
1047 }
1048
1049 dt += wxTimeSpan::Hours(1);
1050
1051 // disable DST tests because it could result in an infinite recursion!
1052 dt.MakeGMT(TRUE);
1053 }
1054 else switch ( country )
1055 {
1056 case USA:
1057 switch ( year )
1058 {
1059 case 1918:
1060 case 1919:
1061 // don't know for sure - assume it was in effect all year
1062
1063 case 1943:
1064 case 1944:
1065 dt.Set(31, Dec, year);
1066 break;
1067
1068 case 1945:
1069 // the time was reset after the end of the WWII
1070 dt.Set(30, Sep, year);
1071 break;
1072
1073 default:
1074 // DST ends at 2 a.m. on the last Sunday of October
1075 if ( !dt.SetToLastWeekDay(Sun, Oct, year) )
1076 {
1077 // weirder and weirder...
1078 wxFAIL_MSG( _T("no last Sunday in October?") );
1079 }
1080
1081 dt += wxTimeSpan::Hours(2);
1082
1083 // TODO what about timezone??
1084 }
1085 break;
1086
1087 default:
1088 // assume October 26th as the end of the DST - totally bogus too
1089 dt.Set(26, Oct, year);
1090 }
1091
1092 return dt;
1093 }
1094
1095 // ----------------------------------------------------------------------------
1096 // constructors and assignment operators
1097 // ----------------------------------------------------------------------------
1098
1099 // return the current time with ms precision
1100 /* static */ wxDateTime wxDateTime::UNow()
1101 {
1102 return wxDateTime(wxGetLocalTimeMillis());
1103 }
1104
1105 // the values in the tm structure contain the local time
1106 wxDateTime& wxDateTime::Set(const struct tm& tm)
1107 {
1108 struct tm tm2(tm);
1109 time_t timet = mktime(&tm2);
1110
1111 if ( timet == (time_t)-1 )
1112 {
1113 // mktime() rather unintuitively fails for Jan 1, 1970 if the hour is
1114 // less than timezone - try to make it work for this case
1115 if ( tm2.tm_year == 70 && tm2.tm_mon == 0 && tm2.tm_mday == 1 )
1116 {
1117 // add timezone to make sure that date is in range
1118 tm2.tm_sec -= GetTimeZone();
1119
1120 timet = mktime(&tm2);
1121 if ( timet != (time_t)-1 )
1122 {
1123 timet += GetTimeZone();
1124
1125 return Set(timet);
1126 }
1127 }
1128
1129 wxFAIL_MSG( _T("mktime() failed") );
1130
1131 *this = wxInvalidDateTime;
1132
1133 return *this;
1134 }
1135 else
1136 {
1137 return Set(timet);
1138 }
1139 }
1140
1141 wxDateTime& wxDateTime::Set(wxDateTime_t hour,
1142 wxDateTime_t minute,
1143 wxDateTime_t second,
1144 wxDateTime_t millisec)
1145 {
1146 // we allow seconds to be 61 to account for the leap seconds, even if we
1147 // don't use them really
1148 wxDATETIME_CHECK( hour < 24 &&
1149 second < 62 &&
1150 minute < 60 &&
1151 millisec < 1000,
1152 _T("Invalid time in wxDateTime::Set()") );
1153
1154 // get the current date from system
1155 struct tm *tm = GetTmNow();
1156
1157 wxDATETIME_CHECK( tm, _T("localtime() failed") );
1158
1159 // adjust the time
1160 tm->tm_hour = hour;
1161 tm->tm_min = minute;
1162 tm->tm_sec = second;
1163
1164 (void)Set(*tm);
1165
1166 // and finally adjust milliseconds
1167 return SetMillisecond(millisec);
1168 }
1169
1170 wxDateTime& wxDateTime::Set(wxDateTime_t day,
1171 Month month,
1172 int year,
1173 wxDateTime_t hour,
1174 wxDateTime_t minute,
1175 wxDateTime_t second,
1176 wxDateTime_t millisec)
1177 {
1178 wxDATETIME_CHECK( hour < 24 &&
1179 second < 62 &&
1180 minute < 60 &&
1181 millisec < 1000,
1182 _T("Invalid time in wxDateTime::Set()") );
1183
1184 ReplaceDefaultYearMonthWithCurrent(&year, &month);
1185
1186 wxDATETIME_CHECK( (0 < day) && (day <= GetNumberOfDays(month, year)),
1187 _T("Invalid date in wxDateTime::Set()") );
1188
1189 // the range of time_t type (inclusive)
1190 static const int yearMinInRange = 1970;
1191 static const int yearMaxInRange = 2037;
1192
1193 // test only the year instead of testing for the exact end of the Unix
1194 // time_t range - it doesn't bring anything to do more precise checks
1195 if ( year >= yearMinInRange && year <= yearMaxInRange )
1196 {
1197 // use the standard library version if the date is in range - this is
1198 // probably more efficient than our code
1199 struct tm tm;
1200 tm.tm_year = year - 1900;
1201 tm.tm_mon = month;
1202 tm.tm_mday = day;
1203 tm.tm_hour = hour;
1204 tm.tm_min = minute;
1205 tm.tm_sec = second;
1206 tm.tm_isdst = -1; // mktime() will guess it
1207
1208 (void)Set(tm);
1209
1210 // and finally adjust milliseconds
1211 return SetMillisecond(millisec);
1212 }
1213 else
1214 {
1215 // do time calculations ourselves: we want to calculate the number of
1216 // milliseconds between the given date and the epoch
1217
1218 // get the JDN for the midnight of this day
1219 m_time = GetTruncatedJDN(day, month, year);
1220 m_time -= EPOCH_JDN;
1221 m_time *= SECONDS_PER_DAY * TIME_T_FACTOR;
1222
1223 // JDN corresponds to GMT, we take localtime
1224 Add(wxTimeSpan(hour, minute, second + GetTimeZone(), millisec));
1225 }
1226
1227 return *this;
1228 }
1229
1230 wxDateTime& wxDateTime::Set(double jdn)
1231 {
1232 // so that m_time will be 0 for the midnight of Jan 1, 1970 which is jdn
1233 // EPOCH_JDN + 0.5
1234 jdn -= EPOCH_JDN + 0.5;
1235
1236 jdn *= MILLISECONDS_PER_DAY;
1237
1238 m_time.Assign(jdn);
1239
1240 return *this;
1241 }
1242
1243 wxDateTime& wxDateTime::ResetTime()
1244 {
1245 Tm tm = GetTm();
1246
1247 if ( tm.hour || tm.min || tm.sec || tm.msec )
1248 {
1249 tm.msec =
1250 tm.sec =
1251 tm.min =
1252 tm.hour = 0;
1253
1254 Set(tm);
1255 }
1256
1257 return *this;
1258 }
1259
1260 // ----------------------------------------------------------------------------
1261 // DOS Date and Time Format functions
1262 // ----------------------------------------------------------------------------
1263 // the dos date and time value is an unsigned 32 bit value in the format:
1264 // YYYYYYYMMMMDDDDDhhhhhmmmmmmsssss
1265 //
1266 // Y = year offset from 1980 (0-127)
1267 // M = month (1-12)
1268 // D = day of month (1-31)
1269 // h = hour (0-23)
1270 // m = minute (0-59)
1271 // s = bisecond (0-29) each bisecond indicates two seconds
1272 // ----------------------------------------------------------------------------
1273
1274 wxDateTime& wxDateTime::SetFromDOS(unsigned long ddt)
1275 {
1276 struct tm tm;
1277
1278 long year = ddt & 0xFE000000;
1279 year >>= 25;
1280 year += 80;
1281 tm.tm_year = year;
1282
1283 long month = ddt & 0x1E00000;
1284 month >>= 21;
1285 month -= 1;
1286 tm.tm_mon = month;
1287
1288 long day = ddt & 0x1F0000;
1289 day >>= 16;
1290 tm.tm_mday = day;
1291
1292 long hour = ddt & 0xF800;
1293 hour >>= 11;
1294 tm.tm_hour = hour;
1295
1296 long minute = ddt & 0x7E0;
1297 minute >>= 5;
1298 tm.tm_min = minute;
1299
1300 long second = ddt & 0x1F;
1301 tm.tm_sec = second * 2;
1302
1303 return Set(mktime(&tm));
1304 }
1305
1306 unsigned long wxDateTime::GetAsDOS() const
1307 {
1308 unsigned long ddt;
1309 time_t ticks = GetTicks();
1310 struct tm *tm = localtime(&ticks);
1311
1312 long year = tm->tm_year;
1313 year -= 80;
1314 year <<= 25;
1315
1316 long month = tm->tm_mon;
1317 month += 1;
1318 month <<= 21;
1319
1320 long day = tm->tm_mday;
1321 day <<= 16;
1322
1323 long hour = tm->tm_hour;
1324 hour <<= 11;
1325
1326 long minute = tm->tm_min;
1327 minute <<= 5;
1328
1329 long second = tm->tm_sec;
1330 second /= 2;
1331
1332 ddt = year | month | day | hour | minute | second;
1333 return ddt;
1334 }
1335
1336 // ----------------------------------------------------------------------------
1337 // time_t <-> broken down time conversions
1338 // ----------------------------------------------------------------------------
1339
1340 wxDateTime::Tm wxDateTime::GetTm(const TimeZone& tz) const
1341 {
1342 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1343
1344 time_t time = GetTicks();
1345 if ( time != (time_t)-1 )
1346 {
1347 // use C RTL functions
1348 tm *tm;
1349 if ( tz.GetOffset() == -GetTimeZone() )
1350 {
1351 // we are working with local time
1352 tm = localtime(&time);
1353
1354 // should never happen
1355 wxCHECK_MSG( tm, Tm(), _T("localtime() failed") );
1356 }
1357 else
1358 {
1359 time += (time_t)tz.GetOffset();
1360 #if defined(__VMS__) || defined(__WATCOMC__) // time is unsigned so avoid warning
1361 int time2 = (int) time;
1362 if ( time2 >= 0 )
1363 #else
1364 if ( time >= 0 )
1365 #endif
1366 {
1367 tm = gmtime(&time);
1368
1369 // should never happen
1370 wxCHECK_MSG( tm, Tm(), _T("gmtime() failed") );
1371 }
1372 else
1373 {
1374 tm = (struct tm *)NULL;
1375 }
1376 }
1377
1378 if ( tm )
1379 {
1380 // adjust the milliseconds
1381 Tm tm2(*tm, tz);
1382 long timeOnly = (m_time % MILLISECONDS_PER_DAY).ToLong();
1383 tm2.msec = (wxDateTime_t)(timeOnly % 1000);
1384 return tm2;
1385 }
1386 //else: use generic code below
1387 }
1388
1389 // remember the time and do the calculations with the date only - this
1390 // eliminates rounding errors of the floating point arithmetics
1391
1392 wxLongLong timeMidnight = m_time + tz.GetOffset() * 1000;
1393
1394 long timeOnly = (timeMidnight % MILLISECONDS_PER_DAY).ToLong();
1395
1396 // we want to always have positive time and timeMidnight to be really
1397 // the midnight before it
1398 if ( timeOnly < 0 )
1399 {
1400 timeOnly = MILLISECONDS_PER_DAY + timeOnly;
1401 }
1402
1403 timeMidnight -= timeOnly;
1404
1405 // calculate the Gregorian date from JDN for the midnight of our date:
1406 // this will yield day, month (in 1..12 range) and year
1407
1408 // actually, this is the JDN for the noon of the previous day
1409 long jdn = (timeMidnight / MILLISECONDS_PER_DAY).ToLong() + EPOCH_JDN;
1410
1411 // CREDIT: code below is by Scott E. Lee (but bugs are mine)
1412
1413 wxASSERT_MSG( jdn > -2, _T("JDN out of range") );
1414
1415 // calculate the century
1416 long temp = (jdn + JDN_OFFSET) * 4 - 1;
1417 long century = temp / DAYS_PER_400_YEARS;
1418
1419 // then the year and day of year (1 <= dayOfYear <= 366)
1420 temp = ((temp % DAYS_PER_400_YEARS) / 4) * 4 + 3;
1421 long year = (century * 100) + (temp / DAYS_PER_4_YEARS);
1422 long dayOfYear = (temp % DAYS_PER_4_YEARS) / 4 + 1;
1423
1424 // and finally the month and day of the month
1425 temp = dayOfYear * 5 - 3;
1426 long month = temp / DAYS_PER_5_MONTHS;
1427 long day = (temp % DAYS_PER_5_MONTHS) / 5 + 1;
1428
1429 // month is counted from March - convert to normal
1430 if ( month < 10 )
1431 {
1432 month += 3;
1433 }
1434 else
1435 {
1436 year += 1;
1437 month -= 9;
1438 }
1439
1440 // year is offset by 4800
1441 year -= 4800;
1442
1443 // check that the algorithm gave us something reasonable
1444 wxASSERT_MSG( (0 < month) && (month <= 12), _T("invalid month") );
1445 wxASSERT_MSG( (1 <= day) && (day < 32), _T("invalid day") );
1446
1447 // construct Tm from these values
1448 Tm tm;
1449 tm.year = (int)year;
1450 tm.mon = (Month)(month - 1); // algorithm yields 1 for January, not 0
1451 tm.mday = (wxDateTime_t)day;
1452 tm.msec = (wxDateTime_t)(timeOnly % 1000);
1453 timeOnly -= tm.msec;
1454 timeOnly /= 1000; // now we have time in seconds
1455
1456 tm.sec = (wxDateTime_t)(timeOnly % 60);
1457 timeOnly -= tm.sec;
1458 timeOnly /= 60; // now we have time in minutes
1459
1460 tm.min = (wxDateTime_t)(timeOnly % 60);
1461 timeOnly -= tm.min;
1462
1463 tm.hour = (wxDateTime_t)(timeOnly / 60);
1464
1465 return tm;
1466 }
1467
1468 wxDateTime& wxDateTime::SetYear(int year)
1469 {
1470 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1471
1472 Tm tm(GetTm());
1473 tm.year = year;
1474 Set(tm);
1475
1476 return *this;
1477 }
1478
1479 wxDateTime& wxDateTime::SetMonth(Month month)
1480 {
1481 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1482
1483 Tm tm(GetTm());
1484 tm.mon = month;
1485 Set(tm);
1486
1487 return *this;
1488 }
1489
1490 wxDateTime& wxDateTime::SetDay(wxDateTime_t mday)
1491 {
1492 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1493
1494 Tm tm(GetTm());
1495 tm.mday = mday;
1496 Set(tm);
1497
1498 return *this;
1499 }
1500
1501 wxDateTime& wxDateTime::SetHour(wxDateTime_t hour)
1502 {
1503 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1504
1505 Tm tm(GetTm());
1506 tm.hour = hour;
1507 Set(tm);
1508
1509 return *this;
1510 }
1511
1512 wxDateTime& wxDateTime::SetMinute(wxDateTime_t min)
1513 {
1514 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1515
1516 Tm tm(GetTm());
1517 tm.min = min;
1518 Set(tm);
1519
1520 return *this;
1521 }
1522
1523 wxDateTime& wxDateTime::SetSecond(wxDateTime_t sec)
1524 {
1525 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1526
1527 Tm tm(GetTm());
1528 tm.sec = sec;
1529 Set(tm);
1530
1531 return *this;
1532 }
1533
1534 wxDateTime& wxDateTime::SetMillisecond(wxDateTime_t millisecond)
1535 {
1536 wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
1537
1538 // we don't need to use GetTm() for this one
1539 m_time -= m_time % 1000l;
1540 m_time += millisecond;
1541
1542 return *this;
1543 }
1544
1545 // ----------------------------------------------------------------------------
1546 // wxDateTime arithmetics
1547 // ----------------------------------------------------------------------------
1548
1549 wxDateTime& wxDateTime::Add(const wxDateSpan& diff)
1550 {
1551 Tm tm(GetTm());
1552
1553 tm.year += diff.GetYears();
1554 tm.AddMonths(diff.GetMonths());
1555
1556 // check that the resulting date is valid
1557 if ( tm.mday > GetNumOfDaysInMonth(tm.year, tm.mon) )
1558 {
1559 // We suppose that when adding one month to Jan 31 we want to get Feb
1560 // 28 (or 29), i.e. adding a month to the last day of the month should
1561 // give the last day of the next month which is quite logical.
1562 //
1563 // Unfortunately, there is no logic way to understand what should
1564 // Jan 30 + 1 month be - Feb 28 too or Feb 27 (assuming non leap year)?
1565 // We make it Feb 28 (last day too), but it is highly questionable.
1566 tm.mday = GetNumOfDaysInMonth(tm.year, tm.mon);
1567 }
1568
1569 tm.AddDays(diff.GetTotalDays());
1570
1571 Set(tm);
1572
1573 wxASSERT_MSG( IsSameTime(tm),
1574 _T("Add(wxDateSpan) shouldn't modify time") );
1575
1576 return *this;
1577 }
1578
1579 // ----------------------------------------------------------------------------
1580 // Weekday and monthday stuff
1581 // ----------------------------------------------------------------------------
1582
1583 bool wxDateTime::SetToTheWeek(wxDateTime_t numWeek,
1584 WeekDay weekday,
1585 WeekFlags flags)
1586 {
1587 wxASSERT_MSG( numWeek > 0,
1588 _T("invalid week number: weeks are counted from 1") );
1589
1590 int year = GetYear();
1591
1592 // Jan 4 always lies in the 1st week of the year
1593 Set(4, Jan, year);
1594 SetToWeekDayInSameWeek(weekday, flags) += wxDateSpan::Weeks(numWeek - 1);
1595
1596 if ( GetYear() != year )
1597 {
1598 // oops... numWeek was too big
1599 return FALSE;
1600 }
1601
1602 return TRUE;
1603 }
1604
1605 wxDateTime& wxDateTime::SetToLastMonthDay(Month month,
1606 int year)
1607 {
1608 // take the current month/year if none specified
1609 if ( year == Inv_Year )
1610 year = GetYear();
1611 if ( month == Inv_Month )
1612 month = GetMonth();
1613
1614 return Set(GetNumOfDaysInMonth(year, month), month, year);
1615 }
1616
1617 wxDateTime& wxDateTime::SetToWeekDayInSameWeek(WeekDay weekday, WeekFlags flags)
1618 {
1619 wxDATETIME_CHECK( weekday != Inv_WeekDay, _T("invalid weekday") );
1620
1621 int wdayThis = GetWeekDay();
1622 if ( weekday == wdayThis )
1623 {
1624 // nothing to do
1625 return *this;
1626 }
1627
1628 if ( flags == Default_First )
1629 {
1630 flags = GetCountry() == USA ? Sunday_First : Monday_First;
1631 }
1632
1633 // the logic below based on comparing weekday and wdayThis works if Sun (0)
1634 // is the first day in the week, but breaks down for Monday_First case so
1635 // we adjust the week days in this case
1636 if( flags == Monday_First )
1637 {
1638 if ( wdayThis == Sun )
1639 wdayThis += 7;
1640 }
1641 //else: Sunday_First, nothing to do
1642
1643 // go forward or back in time to the day we want
1644 if ( weekday < wdayThis )
1645 {
1646 return Subtract(wxDateSpan::Days(wdayThis - weekday));
1647 }
1648 else // weekday > wdayThis
1649 {
1650 return Add(wxDateSpan::Days(weekday - wdayThis));
1651 }
1652 }
1653
1654 wxDateTime& wxDateTime::SetToNextWeekDay(WeekDay weekday)
1655 {
1656 wxDATETIME_CHECK( weekday != Inv_WeekDay, _T("invalid weekday") );
1657
1658 int diff;
1659 WeekDay wdayThis = GetWeekDay();
1660 if ( weekday == wdayThis )
1661 {
1662 // nothing to do
1663 return *this;
1664 }
1665 else if ( weekday < wdayThis )
1666 {
1667 // need to advance a week
1668 diff = 7 - (wdayThis - weekday);
1669 }
1670 else // weekday > wdayThis
1671 {
1672 diff = weekday - wdayThis;
1673 }
1674
1675 return Add(wxDateSpan::Days(diff));
1676 }
1677
1678 wxDateTime& wxDateTime::SetToPrevWeekDay(WeekDay weekday)
1679 {
1680 wxDATETIME_CHECK( weekday != Inv_WeekDay, _T("invalid weekday") );
1681
1682 int diff;
1683 WeekDay wdayThis = GetWeekDay();
1684 if ( weekday == wdayThis )
1685 {
1686 // nothing to do
1687 return *this;
1688 }
1689 else if ( weekday > wdayThis )
1690 {
1691 // need to go to previous week
1692 diff = 7 - (weekday - wdayThis);
1693 }
1694 else // weekday < wdayThis
1695 {
1696 diff = wdayThis - weekday;
1697 }
1698
1699 return Subtract(wxDateSpan::Days(diff));
1700 }
1701
1702 bool wxDateTime::SetToWeekDay(WeekDay weekday,
1703 int n,
1704 Month month,
1705 int year)
1706 {
1707 wxCHECK_MSG( weekday != Inv_WeekDay, FALSE, _T("invalid weekday") );
1708
1709 // we don't check explicitly that -5 <= n <= 5 because we will return FALSE
1710 // anyhow in such case - but may be should still give an assert for it?
1711
1712 // take the current month/year if none specified
1713 ReplaceDefaultYearMonthWithCurrent(&year, &month);
1714
1715 wxDateTime dt;
1716
1717 // TODO this probably could be optimised somehow...
1718
1719 if ( n > 0 )
1720 {
1721 // get the first day of the month
1722 dt.Set(1, month, year);
1723
1724 // get its wday
1725 WeekDay wdayFirst = dt.GetWeekDay();
1726
1727 // go to the first weekday of the month
1728 int diff = weekday - wdayFirst;
1729 if ( diff < 0 )
1730 diff += 7;
1731
1732 // add advance n-1 weeks more
1733 diff += 7*(n - 1);
1734
1735 dt += wxDateSpan::Days(diff);
1736 }
1737 else // count from the end of the month
1738 {
1739 // get the last day of the month
1740 dt.SetToLastMonthDay(month, year);
1741
1742 // get its wday
1743 WeekDay wdayLast = dt.GetWeekDay();
1744
1745 // go to the last weekday of the month
1746 int diff = wdayLast - weekday;
1747 if ( diff < 0 )
1748 diff += 7;
1749
1750 // and rewind n-1 weeks from there
1751 diff += 7*(-n - 1);
1752
1753 dt -= wxDateSpan::Days(diff);
1754 }
1755
1756 // check that it is still in the same month
1757 if ( dt.GetMonth() == month )
1758 {
1759 *this = dt;
1760
1761 return TRUE;
1762 }
1763 else
1764 {
1765 // no such day in this month
1766 return FALSE;
1767 }
1768 }
1769
1770 wxDateTime::wxDateTime_t wxDateTime::GetDayOfYear(const TimeZone& tz) const
1771 {
1772 Tm tm(GetTm(tz));
1773
1774 return gs_cumulatedDays[IsLeapYear(tm.year)][tm.mon] + tm.mday;
1775 }
1776
1777 wxDateTime::wxDateTime_t wxDateTime::GetWeekOfYear(wxDateTime::WeekFlags flags,
1778 const TimeZone& tz) const
1779 {
1780 if ( flags == Default_First )
1781 {
1782 flags = GetCountry() == USA ? Sunday_First : Monday_First;
1783 }
1784
1785 wxDateTime_t nDayInYear = GetDayOfYear(tz);
1786 wxDateTime_t week;
1787
1788 WeekDay wd = GetWeekDay(tz);
1789 if ( flags == Sunday_First )
1790 {
1791 week = (nDayInYear - wd + 7) / 7;
1792 }
1793 else
1794 {
1795 // have to shift the week days values
1796 week = (nDayInYear - (wd - 1 + 7) % 7 + 7) / 7;
1797 }
1798
1799 // FIXME some more elegant way??
1800 WeekDay wdYearStart = wxDateTime(1, Jan, GetYear()).GetWeekDay();
1801 if ( wdYearStart == Wed || wdYearStart == Thu )
1802 {
1803 week++;
1804 }
1805
1806 return week;
1807 }
1808
1809 wxDateTime::wxDateTime_t wxDateTime::GetWeekOfMonth(wxDateTime::WeekFlags flags,
1810 const TimeZone& tz) const
1811 {
1812 Tm tm = GetTm(tz);
1813 wxDateTime dtMonthStart = wxDateTime(1, tm.mon, tm.year);
1814 int nWeek = GetWeekOfYear(flags) - dtMonthStart.GetWeekOfYear(flags) + 1;
1815 if ( nWeek < 0 )
1816 {
1817 // this may happen for January when Jan, 1 is the last week of the
1818 // previous year
1819 nWeek += IsLeapYear(tm.year - 1) ? 53 : 52;
1820 }
1821
1822 return (wxDateTime::wxDateTime_t)nWeek;
1823 }
1824
1825 wxDateTime& wxDateTime::SetToYearDay(wxDateTime::wxDateTime_t yday)
1826 {
1827 int year = GetYear();
1828 wxDATETIME_CHECK( (0 < yday) && (yday <= GetNumberOfDays(year)),
1829 _T("invalid year day") );
1830
1831 bool isLeap = IsLeapYear(year);
1832 for ( Month mon = Jan; mon < Inv_Month; wxNextMonth(mon) )
1833 {
1834 // for Dec, we can't compare with gs_cumulatedDays[mon + 1], but we
1835 // don't need it neither - because of the CHECK above we know that
1836 // yday lies in December then
1837 if ( (mon == Dec) || (yday < gs_cumulatedDays[isLeap][mon + 1]) )
1838 {
1839 Set(yday - gs_cumulatedDays[isLeap][mon], mon, year);
1840
1841 break;
1842 }
1843 }
1844
1845 return *this;
1846 }
1847
1848 // ----------------------------------------------------------------------------
1849 // Julian day number conversion and related stuff
1850 // ----------------------------------------------------------------------------
1851
1852 double wxDateTime::GetJulianDayNumber() const
1853 {
1854 // JDN are always expressed for the GMT dates
1855 Tm tm(ToTimezone(GMT0).GetTm(GMT0));
1856
1857 double result = GetTruncatedJDN(tm.mday, tm.mon, tm.year);
1858
1859 // add the part GetTruncatedJDN() neglected
1860 result += 0.5;
1861
1862 // and now add the time: 86400 sec = 1 JDN
1863 return result + ((double)(60*(60*tm.hour + tm.min) + tm.sec)) / 86400;
1864 }
1865
1866 double wxDateTime::GetRataDie() const
1867 {
1868 // March 1 of the year 0 is Rata Die day -306 and JDN 1721119.5
1869 return GetJulianDayNumber() - 1721119.5 - 306;
1870 }
1871
1872 // ----------------------------------------------------------------------------
1873 // timezone and DST stuff
1874 // ----------------------------------------------------------------------------
1875
1876 int wxDateTime::IsDST(wxDateTime::Country country) const
1877 {
1878 wxCHECK_MSG( country == Country_Default, -1,
1879 _T("country support not implemented") );
1880
1881 // use the C RTL for the dates in the standard range
1882 time_t timet = GetTicks();
1883 if ( timet != (time_t)-1 )
1884 {
1885 tm *tm = localtime(&timet);
1886
1887 wxCHECK_MSG( tm, -1, _T("localtime() failed") );
1888
1889 return tm->tm_isdst;
1890 }
1891 else
1892 {
1893 int year = GetYear();
1894
1895 if ( !IsDSTApplicable(year, country) )
1896 {
1897 // no DST time in this year in this country
1898 return -1;
1899 }
1900
1901 return IsBetween(GetBeginDST(year, country), GetEndDST(year, country));
1902 }
1903 }
1904
1905 wxDateTime& wxDateTime::MakeTimezone(const TimeZone& tz, bool noDST)
1906 {
1907 long secDiff = GetTimeZone() + tz.GetOffset();
1908
1909 // we need to know whether DST is or not in effect for this date unless
1910 // the test disabled by the caller
1911 if ( !noDST && (IsDST() == 1) )
1912 {
1913 // FIXME we assume that the DST is always shifted by 1 hour
1914 secDiff -= 3600;
1915 }
1916
1917 return Subtract(wxTimeSpan::Seconds(secDiff));
1918 }
1919
1920 // ----------------------------------------------------------------------------
1921 // wxDateTime to/from text representations
1922 // ----------------------------------------------------------------------------
1923
1924 wxString wxDateTime::Format(const wxChar *format, const TimeZone& tz) const
1925 {
1926 wxCHECK_MSG( format, _T(""), _T("NULL format in wxDateTime::Format") );
1927
1928 // we have to use our own implementation if the date is out of range of
1929 // strftime() or if we use non standard specificators
1930 time_t time = GetTicks();
1931 if ( (time != (time_t)-1) && !wxStrstr(format, _T("%l")) )
1932 {
1933 // use strftime()
1934 tm *tm;
1935 if ( tz.GetOffset() == -GetTimeZone() )
1936 {
1937 // we are working with local time
1938 tm = localtime(&time);
1939
1940 // should never happen
1941 wxCHECK_MSG( tm, wxEmptyString, _T("localtime() failed") );
1942 }
1943 else
1944 {
1945 time += (int)tz.GetOffset();
1946
1947 #if defined(__VMS__) || defined(__WATCOMC__) // time is unsigned so avoid warning
1948 int time2 = (int) time;
1949 if ( time2 >= 0 )
1950 #else
1951 if ( time >= 0 )
1952 #endif
1953 {
1954 tm = gmtime(&time);
1955
1956 // should never happen
1957 wxCHECK_MSG( tm, wxEmptyString, _T("gmtime() failed") );
1958 }
1959 else
1960 {
1961 tm = (struct tm *)NULL;
1962 }
1963 }
1964
1965 if ( tm )
1966 {
1967 return CallStrftime(format, tm);
1968 }
1969 //else: use generic code below
1970 }
1971
1972 // we only parse ANSI C format specifications here, no POSIX 2
1973 // complications, no GNU extensions but we do add support for a "%l" format
1974 // specifier allowing to get the number of milliseconds
1975 Tm tm = GetTm(tz);
1976
1977 // used for calls to strftime() when we only deal with time
1978 struct tm tmTimeOnly;
1979 tmTimeOnly.tm_hour = tm.hour;
1980 tmTimeOnly.tm_min = tm.min;
1981 tmTimeOnly.tm_sec = tm.sec;
1982 tmTimeOnly.tm_wday = 0;
1983 tmTimeOnly.tm_yday = 0;
1984 tmTimeOnly.tm_mday = 1; // any date will do
1985 tmTimeOnly.tm_mon = 0;
1986 tmTimeOnly.tm_year = 76;
1987 tmTimeOnly.tm_isdst = 0; // no DST, we adjust for tz ourselves
1988
1989 wxString tmp, res, fmt;
1990 for ( const wxChar *p = format; *p; p++ )
1991 {
1992 if ( *p != _T('%') )
1993 {
1994 // copy as is
1995 res += *p;
1996
1997 continue;
1998 }
1999
2000 // set the default format
2001 switch ( *++p )
2002 {
2003 case _T('Y'): // year has 4 digits
2004 fmt = _T("%04d");
2005 break;
2006
2007 case _T('j'): // day of year has 3 digits
2008 case _T('l'): // milliseconds have 3 digits
2009 fmt = _T("%03d");
2010 break;
2011
2012 case _T('w'): // week day as number has only one
2013 fmt = _T("%d");
2014 break;
2015
2016 default:
2017 // it's either another valid format specifier in which case
2018 // the format is "%02d" (for all the rest) or we have the
2019 // field width preceding the format in which case it will
2020 // override the default format anyhow
2021 fmt = _T("%02d");
2022 }
2023
2024 bool restart = TRUE;
2025 while ( restart )
2026 {
2027 restart = FALSE;
2028
2029 // start of the format specification
2030 switch ( *p )
2031 {
2032 case _T('a'): // a weekday name
2033 case _T('A'):
2034 // second parameter should be TRUE for abbreviated names
2035 res += GetWeekDayName(tm.GetWeekDay(),
2036 *p == _T('a') ? Name_Abbr : Name_Full);
2037 break;
2038
2039 case _T('b'): // a month name
2040 case _T('B'):
2041 res += GetMonthName(tm.mon,
2042 *p == _T('b') ? Name_Abbr : Name_Full);
2043 break;
2044
2045 case _T('c'): // locale default date and time representation
2046 case _T('x'): // locale default date representation
2047 //
2048 // the problem: there is no way to know what do these format
2049 // specifications correspond to for the current locale.
2050 //
2051 // the solution: use a hack and still use strftime(): first
2052 // find the YEAR which is a year in the strftime() range (1970
2053 // - 2038) whose Jan 1 falls on the same week day as the Jan 1
2054 // of the real year. Then make a copy of the format and
2055 // replace all occurences of YEAR in it with some unique
2056 // string not appearing anywhere else in it, then use
2057 // strftime() to format the date in year YEAR and then replace
2058 // YEAR back by the real year and the unique replacement
2059 // string back with YEAR. Notice that "all occurences of YEAR"
2060 // means all occurences of 4 digit as well as 2 digit form!
2061 //
2062 // the bugs: we assume that neither of %c nor %x contains any
2063 // fields which may change between the YEAR and real year. For
2064 // example, the week number (%U, %W) and the day number (%j)
2065 // will change if one of these years is leap and the other one
2066 // is not!
2067 {
2068 // find the YEAR: normally, for any year X, Jan 1 or the
2069 // year X + 28 is the same weekday as Jan 1 of X (because
2070 // the weekday advances by 1 for each normal X and by 2
2071 // for each leap X, hence by 5 every 4 years or by 35
2072 // which is 0 mod 7 every 28 years) but this rule breaks
2073 // down if there are years between X and Y which are
2074 // divisible by 4 but not leap (i.e. divisible by 100 but
2075 // not 400), hence the correction.
2076
2077 int yearReal = GetYear(tz);
2078 int mod28 = yearReal % 28;
2079
2080 // be careful to not go too far - we risk to leave the
2081 // supported range
2082 int year;
2083 if ( mod28 < 10 )
2084 {
2085 year = 1988 + mod28; // 1988 == 0 (mod 28)
2086 }
2087 else
2088 {
2089 year = 1970 + mod28 - 10; // 1970 == 10 (mod 28)
2090 }
2091
2092 int nCentury = year / 100,
2093 nCenturyReal = yearReal / 100;
2094
2095 // need to adjust for the years divisble by 400 which are
2096 // not leap but are counted like leap ones if we just take
2097 // the number of centuries in between for nLostWeekDays
2098 int nLostWeekDays = (nCentury - nCenturyReal) -
2099 (nCentury / 4 - nCenturyReal / 4);
2100
2101 // we have to gain back the "lost" weekdays: note that the
2102 // effect of this loop is to not do anything to
2103 // nLostWeekDays (which we won't use any more), but to
2104 // (indirectly) set the year correctly
2105 while ( (nLostWeekDays % 7) != 0 )
2106 {
2107 nLostWeekDays += year++ % 4 ? 1 : 2;
2108 }
2109
2110 // at any rate, we couldn't go further than 1988 + 9 + 28!
2111 wxASSERT_MSG( year < 2030,
2112 _T("logic error in wxDateTime::Format") );
2113
2114 wxString strYear, strYear2;
2115 strYear.Printf(_T("%d"), year);
2116 strYear2.Printf(_T("%d"), year % 100);
2117
2118 // find two strings not occuring in format (this is surely
2119 // not optimal way of doing it... improvements welcome!)
2120 wxString fmt = format;
2121 wxString replacement = (wxChar)-1;
2122 while ( fmt.Find(replacement) != wxNOT_FOUND )
2123 {
2124 replacement << (wxChar)-1;
2125 }
2126
2127 wxString replacement2 = (wxChar)-2;
2128 while ( fmt.Find(replacement) != wxNOT_FOUND )
2129 {
2130 replacement << (wxChar)-2;
2131 }
2132
2133 // replace all occurences of year with it
2134 bool wasReplaced = fmt.Replace(strYear, replacement) > 0;
2135 if ( !wasReplaced )
2136 wasReplaced = fmt.Replace(strYear2, replacement2) > 0;
2137
2138 // use strftime() to format the same date but in supported
2139 // year
2140 //
2141 // NB: we assume that strftime() doesn't check for the
2142 // date validity and will happily format the date
2143 // corresponding to Feb 29 of a non leap year (which
2144 // may happen if yearReal was leap and year is not)
2145 struct tm tmAdjusted;
2146 InitTm(tmAdjusted);
2147 tmAdjusted.tm_hour = tm.hour;
2148 tmAdjusted.tm_min = tm.min;
2149 tmAdjusted.tm_sec = tm.sec;
2150 tmAdjusted.tm_wday = tm.GetWeekDay();
2151 tmAdjusted.tm_yday = GetDayOfYear();
2152 tmAdjusted.tm_mday = tm.mday;
2153 tmAdjusted.tm_mon = tm.mon;
2154 tmAdjusted.tm_year = year - 1900;
2155 tmAdjusted.tm_isdst = 0; // no DST, already adjusted
2156 wxString str = CallStrftime(*p == _T('c') ? _T("%c")
2157 : _T("%x"),
2158 &tmAdjusted);
2159
2160 // now replace the occurence of 1999 with the real year
2161 wxString strYearReal, strYearReal2;
2162 strYearReal.Printf(_T("%04d"), yearReal);
2163 strYearReal2.Printf(_T("%02d"), yearReal % 100);
2164 str.Replace(strYear, strYearReal);
2165 str.Replace(strYear2, strYearReal2);
2166
2167 // and replace back all occurences of replacement string
2168 if ( wasReplaced )
2169 {
2170 str.Replace(replacement2, strYear2);
2171 str.Replace(replacement, strYear);
2172 }
2173
2174 res += str;
2175 }
2176 break;
2177
2178 case _T('d'): // day of a month (01-31)
2179 res += wxString::Format(fmt, tm.mday);
2180 break;
2181
2182 case _T('H'): // hour in 24h format (00-23)
2183 res += wxString::Format(fmt, tm.hour);
2184 break;
2185
2186 case _T('I'): // hour in 12h format (01-12)
2187 {
2188 // 24h -> 12h, 0h -> 12h too
2189 int hour12 = tm.hour > 12 ? tm.hour - 12
2190 : tm.hour ? tm.hour : 12;
2191 res += wxString::Format(fmt, hour12);
2192 }
2193 break;
2194
2195 case _T('j'): // day of the year
2196 res += wxString::Format(fmt, GetDayOfYear(tz));
2197 break;
2198
2199 case _T('l'): // milliseconds (NOT STANDARD)
2200 res += wxString::Format(fmt, GetMillisecond(tz));
2201 break;
2202
2203 case _T('m'): // month as a number (01-12)
2204 res += wxString::Format(fmt, tm.mon + 1);
2205 break;
2206
2207 case _T('M'): // minute as a decimal number (00-59)
2208 res += wxString::Format(fmt, tm.min);
2209 break;
2210
2211 case _T('p'): // AM or PM string
2212 res += CallStrftime(_T("%p"), &tmTimeOnly);
2213 break;
2214
2215 case _T('S'): // second as a decimal number (00-61)
2216 res += wxString::Format(fmt, tm.sec);
2217 break;
2218
2219 case _T('U'): // week number in the year (Sunday 1st week day)
2220 res += wxString::Format(fmt, GetWeekOfYear(Sunday_First, tz));
2221 break;
2222
2223 case _T('W'): // week number in the year (Monday 1st week day)
2224 res += wxString::Format(fmt, GetWeekOfYear(Monday_First, tz));
2225 break;
2226
2227 case _T('w'): // weekday as a number (0-6), Sunday = 0
2228 res += wxString::Format(fmt, tm.GetWeekDay());
2229 break;
2230
2231 // case _T('x'): -- handled with "%c"
2232
2233 case _T('X'): // locale default time representation
2234 // just use strftime() to format the time for us
2235 res += CallStrftime(_T("%X"), &tmTimeOnly);
2236 break;
2237
2238 case _T('y'): // year without century (00-99)
2239 res += wxString::Format(fmt, tm.year % 100);
2240 break;
2241
2242 case _T('Y'): // year with century
2243 res += wxString::Format(fmt, tm.year);
2244 break;
2245
2246 case _T('Z'): // timezone name
2247 res += CallStrftime(_T("%Z"), &tmTimeOnly);
2248 break;
2249
2250 default:
2251 // is it the format width?
2252 fmt.Empty();
2253 while ( *p == _T('-') || *p == _T('+') ||
2254 *p == _T(' ') || wxIsdigit(*p) )
2255 {
2256 fmt += *p;
2257 }
2258
2259 if ( !fmt.IsEmpty() )
2260 {
2261 // we've only got the flags and width so far in fmt
2262 fmt.Prepend(_T('%'));
2263 fmt.Append(_T('d'));
2264
2265 restart = TRUE;
2266
2267 break;
2268 }
2269
2270 // no, it wasn't the width
2271 wxFAIL_MSG(_T("unknown format specificator"));
2272
2273 // fall through and just copy it nevertheless
2274
2275 case _T('%'): // a percent sign
2276 res += *p;
2277 break;
2278
2279 case 0: // the end of string
2280 wxFAIL_MSG(_T("missing format at the end of string"));
2281
2282 // just put the '%' which was the last char in format
2283 res += _T('%');
2284 break;
2285 }
2286 }
2287 }
2288
2289 return res;
2290 }
2291
2292 // this function parses a string in (strict) RFC 822 format: see the section 5
2293 // of the RFC for the detailed description, but briefly it's something of the
2294 // form "Sat, 18 Dec 1999 00:48:30 +0100"
2295 //
2296 // this function is "strict" by design - it must reject anything except true
2297 // RFC822 time specs.
2298 //
2299 // TODO a great candidate for using reg exps
2300 const wxChar *wxDateTime::ParseRfc822Date(const wxChar* date)
2301 {
2302 wxCHECK_MSG( date, (wxChar *)NULL, _T("NULL pointer in wxDateTime::Parse") );
2303
2304 const wxChar *p = date;
2305 const wxChar *comma = wxStrchr(p, _T(','));
2306 if ( comma )
2307 {
2308 // the part before comma is the weekday
2309
2310 // skip it for now - we don't use but might check that it really
2311 // corresponds to the specfied date
2312 p = comma + 1;
2313
2314 if ( *p != _T(' ') )
2315 {
2316 wxLogDebug(_T("no space after weekday in RFC822 time spec"));
2317
2318 return (wxChar *)NULL;
2319 }
2320
2321 p++; // skip space
2322 }
2323
2324 // the following 1 or 2 digits are the day number
2325 if ( !wxIsdigit(*p) )
2326 {
2327 wxLogDebug(_T("day number expected in RFC822 time spec, none found"));
2328
2329 return (wxChar *)NULL;
2330 }
2331
2332 wxDateTime_t day = *p++ - _T('0');
2333 if ( wxIsdigit(*p) )
2334 {
2335 day *= 10;
2336 day += *p++ - _T('0');
2337 }
2338
2339 if ( *p++ != _T(' ') )
2340 {
2341 return (wxChar *)NULL;
2342 }
2343
2344 // the following 3 letters specify the month
2345 wxString monName(p, 3);
2346 Month mon;
2347 if ( monName == _T("Jan") )
2348 mon = Jan;
2349 else if ( monName == _T("Feb") )
2350 mon = Feb;
2351 else if ( monName == _T("Mar") )
2352 mon = Mar;
2353 else if ( monName == _T("Apr") )
2354 mon = Apr;
2355 else if ( monName == _T("May") )
2356 mon = May;
2357 else if ( monName == _T("Jun") )
2358 mon = Jun;
2359 else if ( monName == _T("Jul") )
2360 mon = Jul;
2361 else if ( monName == _T("Aug") )
2362 mon = Aug;
2363 else if ( monName == _T("Sep") )
2364 mon = Sep;
2365 else if ( monName == _T("Oct") )
2366 mon = Oct;
2367 else if ( monName == _T("Nov") )
2368 mon = Nov;
2369 else if ( monName == _T("Dec") )
2370 mon = Dec;
2371 else
2372 {
2373 wxLogDebug(_T("Invalid RFC 822 month name '%s'"), monName.c_str());
2374
2375 return (wxChar *)NULL;
2376 }
2377
2378 p += 3;
2379
2380 if ( *p++ != _T(' ') )
2381 {
2382 return (wxChar *)NULL;
2383 }
2384
2385 // next is the year
2386 if ( !wxIsdigit(*p) )
2387 {
2388 // no year?
2389 return (wxChar *)NULL;
2390 }
2391
2392 int year = *p++ - _T('0');
2393
2394 if ( !wxIsdigit(*p) )
2395 {
2396 // should have at least 2 digits in the year
2397 return (wxChar *)NULL;
2398 }
2399
2400 year *= 10;
2401 year += *p++ - _T('0');
2402
2403 // is it a 2 digit year (as per original RFC 822) or a 4 digit one?
2404 if ( wxIsdigit(*p) )
2405 {
2406 year *= 10;
2407 year += *p++ - _T('0');
2408
2409 if ( !wxIsdigit(*p) )
2410 {
2411 // no 3 digit years please
2412 return (wxChar *)NULL;
2413 }
2414
2415 year *= 10;
2416 year += *p++ - _T('0');
2417 }
2418
2419 if ( *p++ != _T(' ') )
2420 {
2421 return (wxChar *)NULL;
2422 }
2423
2424 // time is in the format hh:mm:ss and seconds are optional
2425 if ( !wxIsdigit(*p) )
2426 {
2427 return (wxChar *)NULL;
2428 }
2429
2430 wxDateTime_t hour = *p++ - _T('0');
2431
2432 if ( !wxIsdigit(*p) )
2433 {
2434 return (wxChar *)NULL;
2435 }
2436
2437 hour *= 10;
2438 hour += *p++ - _T('0');
2439
2440 if ( *p++ != _T(':') )
2441 {
2442 return (wxChar *)NULL;
2443 }
2444
2445 if ( !wxIsdigit(*p) )
2446 {
2447 return (wxChar *)NULL;
2448 }
2449
2450 wxDateTime_t min = *p++ - _T('0');
2451
2452 if ( !wxIsdigit(*p) )
2453 {
2454 return (wxChar *)NULL;
2455 }
2456
2457 min *= 10;
2458 min += *p++ - _T('0');
2459
2460 wxDateTime_t sec = 0;
2461 if ( *p++ == _T(':') )
2462 {
2463 if ( !wxIsdigit(*p) )
2464 {
2465 return (wxChar *)NULL;
2466 }
2467
2468 sec = *p++ - _T('0');
2469
2470 if ( !wxIsdigit(*p) )
2471 {
2472 return (wxChar *)NULL;
2473 }
2474
2475 sec *= 10;
2476 sec += *p++ - _T('0');
2477 }
2478
2479 if ( *p++ != _T(' ') )
2480 {
2481 return (wxChar *)NULL;
2482 }
2483
2484 // and now the interesting part: the timezone
2485 int offset;
2486 if ( *p == _T('-') || *p == _T('+') )
2487 {
2488 // the explicit offset given: it has the form of hhmm
2489 bool plus = *p++ == _T('+');
2490
2491 if ( !wxIsdigit(*p) || !wxIsdigit(*(p + 1)) )
2492 {
2493 return (wxChar *)NULL;
2494 }
2495
2496 // hours
2497 offset = 60*(10*(*p - _T('0')) + (*(p + 1) - _T('0')));
2498
2499 p += 2;
2500
2501 if ( !wxIsdigit(*p) || !wxIsdigit(*(p + 1)) )
2502 {
2503 return (wxChar *)NULL;
2504 }
2505
2506 // minutes
2507 offset += 10*(*p - _T('0')) + (*(p + 1) - _T('0'));
2508
2509 if ( !plus )
2510 {
2511 offset = -offset;
2512 }
2513
2514 p += 2;
2515 }
2516 else
2517 {
2518 // the symbolic timezone given: may be either military timezone or one
2519 // of standard abbreviations
2520 if ( !*(p + 1) )
2521 {
2522 // military: Z = UTC, J unused, A = -1, ..., Y = +12
2523 static const int offsets[26] =
2524 {
2525 //A B C D E F G H I J K L M
2526 -1, -2, -3, -4, -5, -6, -7, -8, -9, 0, -10, -11, -12,
2527 //N O P R Q S T U V W Z Y Z
2528 +1, +2, +3, +4, +5, +6, +7, +8, +9, +10, +11, +12, 0
2529 };
2530
2531 if ( *p < _T('A') || *p > _T('Z') || *p == _T('J') )
2532 {
2533 wxLogDebug(_T("Invalid militaty timezone '%c'"), *p);
2534
2535 return (wxChar *)NULL;
2536 }
2537
2538 offset = offsets[*p++ - _T('A')];
2539 }
2540 else
2541 {
2542 // abbreviation
2543 wxString tz = p;
2544 if ( tz == _T("UT") || tz == _T("UTC") || tz == _T("GMT") )
2545 offset = 0;
2546 else if ( tz == _T("AST") )
2547 offset = AST - GMT0;
2548 else if ( tz == _T("ADT") )
2549 offset = ADT - GMT0;
2550 else if ( tz == _T("EST") )
2551 offset = EST - GMT0;
2552 else if ( tz == _T("EDT") )
2553 offset = EDT - GMT0;
2554 else if ( tz == _T("CST") )
2555 offset = CST - GMT0;
2556 else if ( tz == _T("CDT") )
2557 offset = CDT - GMT0;
2558 else if ( tz == _T("MST") )
2559 offset = MST - GMT0;
2560 else if ( tz == _T("MDT") )
2561 offset = MDT - GMT0;
2562 else if ( tz == _T("PST") )
2563 offset = PST - GMT0;
2564 else if ( tz == _T("PDT") )
2565 offset = PDT - GMT0;
2566 else
2567 {
2568 wxLogDebug(_T("Unknown RFC 822 timezone '%s'"), p);
2569
2570 return (wxChar *)NULL;
2571 }
2572
2573 p += tz.length();
2574 }
2575
2576 // make it minutes
2577 offset *= 60;
2578 }
2579
2580 // the spec was correct
2581 Set(day, mon, year, hour, min, sec);
2582 MakeTimezone((wxDateTime_t)(60*offset));
2583
2584 return p;
2585 }
2586
2587 const wxChar *wxDateTime::ParseFormat(const wxChar *date,
2588 const wxChar *format,
2589 const wxDateTime& dateDef)
2590 {
2591 wxCHECK_MSG( date && format, (wxChar *)NULL,
2592 _T("NULL pointer in wxDateTime::ParseFormat()") );
2593
2594 wxString str;
2595 unsigned long num;
2596
2597 // what fields have we found?
2598 bool haveWDay = FALSE,
2599 haveYDay = FALSE,
2600 haveDay = FALSE,
2601 haveMon = FALSE,
2602 haveYear = FALSE,
2603 haveHour = FALSE,
2604 haveMin = FALSE,
2605 haveSec = FALSE;
2606
2607 bool hourIsIn12hFormat = FALSE, // or in 24h one?
2608 isPM = FALSE; // AM by default
2609
2610 // and the value of the items we have (init them to get rid of warnings)
2611 wxDateTime_t sec = 0,
2612 min = 0,
2613 hour = 0;
2614 WeekDay wday = Inv_WeekDay;
2615 wxDateTime_t yday = 0,
2616 mday = 0;
2617 wxDateTime::Month mon = Inv_Month;
2618 int year = 0;
2619
2620 const wxChar *input = date;
2621 for ( const wxChar *fmt = format; *fmt; fmt++ )
2622 {
2623 if ( *fmt != _T('%') )
2624 {
2625 if ( wxIsspace(*fmt) )
2626 {
2627 // a white space in the format string matches 0 or more white
2628 // spaces in the input
2629 while ( wxIsspace(*input) )
2630 {
2631 input++;
2632 }
2633 }
2634 else // !space
2635 {
2636 // any other character (not whitespace, not '%') must be
2637 // matched by itself in the input
2638 if ( *input++ != *fmt )
2639 {
2640 // no match
2641 return (wxChar *)NULL;
2642 }
2643 }
2644
2645 // done with this format char
2646 continue;
2647 }
2648
2649 // start of a format specification
2650
2651 // parse the optional width
2652 size_t width = 0;
2653 while ( isdigit(*++fmt) )
2654 {
2655 width *= 10;
2656 width += *fmt - _T('0');
2657 }
2658
2659 // the default widths for the various fields
2660 if ( !width )
2661 {
2662 switch ( *fmt )
2663 {
2664 case _T('Y'): // year has 4 digits
2665 width = 4;
2666 break;
2667
2668 case _T('j'): // day of year has 3 digits
2669 case _T('l'): // milliseconds have 3 digits
2670 width = 3;
2671 break;
2672
2673 case _T('w'): // week day as number has only one
2674 width = 1;
2675 break;
2676
2677 default:
2678 // default for all other fields
2679 width = 2;
2680 }
2681 }
2682
2683 // then the format itself
2684 switch ( *fmt )
2685 {
2686 case _T('a'): // a weekday name
2687 case _T('A'):
2688 {
2689 int flag = *fmt == _T('a') ? Name_Abbr : Name_Full;
2690 wday = GetWeekDayFromName(GetAlphaToken(input), flag);
2691 if ( wday == Inv_WeekDay )
2692 {
2693 // no match
2694 return (wxChar *)NULL;
2695 }
2696 }
2697 haveWDay = TRUE;
2698 break;
2699
2700 case _T('b'): // a month name
2701 case _T('B'):
2702 {
2703 int flag = *fmt == _T('b') ? Name_Abbr : Name_Full;
2704 mon = GetMonthFromName(GetAlphaToken(input), flag);
2705 if ( mon == Inv_Month )
2706 {
2707 // no match
2708 return (wxChar *)NULL;
2709 }
2710 }
2711 haveMon = TRUE;
2712 break;
2713
2714 case _T('c'): // locale default date and time representation
2715 {
2716 wxDateTime dt;
2717
2718 // this is the format which corresponds to ctime() output
2719 // and strptime("%c") should parse it, so try it first
2720 static const wxChar *fmtCtime = _T("%a %b %d %H:%M:%S %Y");
2721
2722 const wxChar *result = dt.ParseFormat(input, fmtCtime);
2723 if ( !result )
2724 {
2725 result = dt.ParseFormat(input, _T("%x %X"));
2726 }
2727
2728 if ( !result )
2729 {
2730 result = dt.ParseFormat(input, _T("%X %x"));
2731 }
2732
2733 if ( !result )
2734 {
2735 // we've tried everything and still no match
2736 return (wxChar *)NULL;
2737 }
2738
2739 Tm tm = dt.GetTm();
2740
2741 haveDay = haveMon = haveYear =
2742 haveHour = haveMin = haveSec = TRUE;
2743
2744 hour = tm.hour;
2745 min = tm.min;
2746 sec = tm.sec;
2747
2748 year = tm.year;
2749 mon = tm.mon;
2750 mday = tm.mday;
2751
2752 input = result;
2753 }
2754 break;
2755
2756 case _T('d'): // day of a month (01-31)
2757 if ( !GetNumericToken(width, input, &num) ||
2758 (num > 31) || (num < 1) )
2759 {
2760 // no match
2761 return (wxChar *)NULL;
2762 }
2763
2764 // we can't check whether the day range is correct yet, will
2765 // do it later - assume ok for now
2766 haveDay = TRUE;
2767 mday = (wxDateTime_t)num;
2768 break;
2769
2770 case _T('H'): // hour in 24h format (00-23)
2771 if ( !GetNumericToken(width, input, &num) || (num > 23) )
2772 {
2773 // no match
2774 return (wxChar *)NULL;
2775 }
2776
2777 haveHour = TRUE;
2778 hour = (wxDateTime_t)num;
2779 break;
2780
2781 case _T('I'): // hour in 12h format (01-12)
2782 if ( !GetNumericToken(width, input, &num) || !num || (num > 12) )
2783 {
2784 // no match
2785 return (wxChar *)NULL;
2786 }
2787
2788 haveHour = TRUE;
2789 hourIsIn12hFormat = TRUE;
2790 hour = (wxDateTime_t)(num % 12); // 12 should be 0
2791 break;
2792
2793 case _T('j'): // day of the year
2794 if ( !GetNumericToken(width, input, &num) || !num || (num > 366) )
2795 {
2796 // no match
2797 return (wxChar *)NULL;
2798 }
2799
2800 haveYDay = TRUE;
2801 yday = (wxDateTime_t)num;
2802 break;
2803
2804 case _T('m'): // month as a number (01-12)
2805 if ( !GetNumericToken(width, input, &num) || !num || (num > 12) )
2806 {
2807 // no match
2808 return (wxChar *)NULL;
2809 }
2810
2811 haveMon = TRUE;
2812 mon = (Month)(num - 1);
2813 break;
2814
2815 case _T('M'): // minute as a decimal number (00-59)
2816 if ( !GetNumericToken(width, input, &num) || (num > 59) )
2817 {
2818 // no match
2819 return (wxChar *)NULL;
2820 }
2821
2822 haveMin = TRUE;
2823 min = (wxDateTime_t)num;
2824 break;
2825
2826 case _T('p'): // AM or PM string
2827 {
2828 wxString am, pm, token = GetAlphaToken(input);
2829
2830 GetAmPmStrings(&am, &pm);
2831 if ( token.CmpNoCase(pm) == 0 )
2832 {
2833 isPM = TRUE;
2834 }
2835 else if ( token.CmpNoCase(am) != 0 )
2836 {
2837 // no match
2838 return (wxChar *)NULL;
2839 }
2840 }
2841 break;
2842
2843 case _T('r'): // time as %I:%M:%S %p
2844 {
2845 wxDateTime dt;
2846 input = dt.ParseFormat(input, _T("%I:%M:%S %p"));
2847 if ( !input )
2848 {
2849 // no match
2850 return (wxChar *)NULL;
2851 }
2852
2853 haveHour = haveMin = haveSec = TRUE;
2854
2855 Tm tm = dt.GetTm();
2856 hour = tm.hour;
2857 min = tm.min;
2858 sec = tm.sec;
2859 }
2860 break;
2861
2862 case _T('R'): // time as %H:%M
2863 {
2864 wxDateTime dt;
2865 input = dt.ParseFormat(input, _T("%H:%M"));
2866 if ( !input )
2867 {
2868 // no match
2869 return (wxChar *)NULL;
2870 }
2871
2872 haveHour = haveMin = TRUE;
2873
2874 Tm tm = dt.GetTm();
2875 hour = tm.hour;
2876 min = tm.min;
2877 }
2878
2879 case _T('S'): // second as a decimal number (00-61)
2880 if ( !GetNumericToken(width, input, &num) || (num > 61) )
2881 {
2882 // no match
2883 return (wxChar *)NULL;
2884 }
2885
2886 haveSec = TRUE;
2887 sec = (wxDateTime_t)num;
2888 break;
2889
2890 case _T('T'): // time as %H:%M:%S
2891 {
2892 wxDateTime dt;
2893 input = dt.ParseFormat(input, _T("%H:%M:%S"));
2894 if ( !input )
2895 {
2896 // no match
2897 return (wxChar *)NULL;
2898 }
2899
2900 haveHour = haveMin = haveSec = TRUE;
2901
2902 Tm tm = dt.GetTm();
2903 hour = tm.hour;
2904 min = tm.min;
2905 sec = tm.sec;
2906 }
2907 break;
2908
2909 case _T('w'): // weekday as a number (0-6), Sunday = 0
2910 if ( !GetNumericToken(width, input, &num) || (wday > 6) )
2911 {
2912 // no match
2913 return (wxChar *)NULL;
2914 }
2915
2916 haveWDay = TRUE;
2917 wday = (WeekDay)num;
2918 break;
2919
2920 case _T('x'): // locale default date representation
2921 #ifdef HAVE_STRPTIME
2922 // try using strptime() - it may fail even if the input is
2923 // correct but the date is out of range, so we will fall back
2924 // to our generic code anyhow (FIXME !Unicode friendly)
2925 {
2926 struct tm tm;
2927 const wxChar *result = strptime(input, "%x", &tm);
2928 if ( result )
2929 {
2930 input = result;
2931
2932 haveDay = haveMon = haveYear = TRUE;
2933
2934 year = 1900 + tm.tm_year;
2935 mon = (Month)tm.tm_mon;
2936 mday = tm.tm_mday;
2937
2938 break;
2939 }
2940 }
2941 #endif // HAVE_STRPTIME
2942
2943 // TODO query the LOCALE_IDATE setting under Win32
2944 {
2945 wxDateTime dt;
2946
2947 wxString fmtDate, fmtDateAlt;
2948 if ( IsWestEuropeanCountry(GetCountry()) ||
2949 GetCountry() == Russia )
2950 {
2951 fmtDate = _T("%d/%m/%y");
2952 fmtDateAlt = _T("%m/%d/%y");
2953 }
2954 else // assume USA
2955 {
2956 fmtDate = _T("%m/%d/%y");
2957 fmtDateAlt = _T("%d/%m/%y");
2958 }
2959
2960 const wxChar *result = dt.ParseFormat(input, fmtDate);
2961
2962 if ( !result )
2963 {
2964 // ok, be nice and try another one
2965 result = dt.ParseFormat(input, fmtDateAlt);
2966 }
2967
2968 if ( !result )
2969 {
2970 // bad luck
2971 return (wxChar *)NULL;
2972 }
2973
2974 Tm tm = dt.GetTm();
2975
2976 haveDay = haveMon = haveYear = TRUE;
2977
2978 year = tm.year;
2979 mon = tm.mon;
2980 mday = tm.mday;
2981
2982 input = result;
2983 }
2984
2985 break;
2986
2987 case _T('X'): // locale default time representation
2988 #ifdef HAVE_STRPTIME
2989 {
2990 // use strptime() to do it for us (FIXME !Unicode friendly)
2991 struct tm tm;
2992 input = strptime(input, "%X", &tm);
2993 if ( !input )
2994 {
2995 return (wxChar *)NULL;
2996 }
2997
2998 haveHour = haveMin = haveSec = TRUE;
2999
3000 hour = tm.tm_hour;
3001 min = tm.tm_min;
3002 sec = tm.tm_sec;
3003 }
3004 #else // !HAVE_STRPTIME
3005 // TODO under Win32 we can query the LOCALE_ITIME system
3006 // setting which says whether the default time format is
3007 // 24 or 12 hour
3008 {
3009 // try to parse what follows as "%H:%M:%S" and, if this
3010 // fails, as "%I:%M:%S %p" - this should catch the most
3011 // common cases
3012 wxDateTime dt;
3013
3014 const wxChar *result = dt.ParseFormat(input, _T("%T"));
3015 if ( !result )
3016 {
3017 result = dt.ParseFormat(input, _T("%r"));
3018 }
3019
3020 if ( !result )
3021 {
3022 // no match
3023 return (wxChar *)NULL;
3024 }
3025
3026 haveHour = haveMin = haveSec = TRUE;
3027
3028 Tm tm = dt.GetTm();
3029 hour = tm.hour;
3030 min = tm.min;
3031 sec = tm.sec;
3032
3033 input = result;
3034 }
3035 #endif // HAVE_STRPTIME/!HAVE_STRPTIME
3036 break;
3037
3038 case _T('y'): // year without century (00-99)
3039 if ( !GetNumericToken(width, input, &num) || (num > 99) )
3040 {
3041 // no match
3042 return (wxChar *)NULL;
3043 }
3044
3045 haveYear = TRUE;
3046
3047 // TODO should have an option for roll over date instead of
3048 // hard coding it here
3049 year = (num > 30 ? 1900 : 2000) + (wxDateTime_t)num;
3050 break;
3051
3052 case _T('Y'): // year with century
3053 if ( !GetNumericToken(width, input, &num) )
3054 {
3055 // no match
3056 return (wxChar *)NULL;
3057 }
3058
3059 haveYear = TRUE;
3060 year = (wxDateTime_t)num;
3061 break;
3062
3063 case _T('Z'): // timezone name
3064 wxFAIL_MSG(_T("TODO"));
3065 break;
3066
3067 case _T('%'): // a percent sign
3068 if ( *input++ != _T('%') )
3069 {
3070 // no match
3071 return (wxChar *)NULL;
3072 }
3073 break;
3074
3075 case 0: // the end of string
3076 wxFAIL_MSG(_T("unexpected format end"));
3077
3078 // fall through
3079
3080 default: // not a known format spec
3081 return (wxChar *)NULL;
3082 }
3083 }
3084
3085 // format matched, try to construct a date from what we have now
3086 Tm tmDef;
3087 if ( dateDef.IsValid() )
3088 {
3089 // take this date as default
3090 tmDef = dateDef.GetTm();
3091 }
3092 else if ( IsValid() )
3093 {
3094 // if this date is valid, don't change it
3095 tmDef = GetTm();
3096 }
3097 else
3098 {
3099 // no default and this date is invalid - fall back to Today()
3100 tmDef = Today().GetTm();
3101 }
3102
3103 Tm tm = tmDef;
3104
3105 // set the date
3106 if ( haveYear )
3107 {
3108 tm.year = year;
3109 }
3110
3111 // TODO we don't check here that the values are consistent, if both year
3112 // day and month/day were found, we just ignore the year day and we
3113 // also always ignore the week day
3114 if ( haveMon && haveDay )
3115 {
3116 if ( mday > GetNumOfDaysInMonth(tm.year, mon) )
3117 {
3118 wxLogDebug(_T("bad month day in wxDateTime::ParseFormat"));
3119
3120 return (wxChar *)NULL;
3121 }
3122
3123 tm.mon = mon;
3124 tm.mday = mday;
3125 }
3126 else if ( haveYDay )
3127 {
3128 if ( yday > GetNumberOfDays(tm.year) )
3129 {
3130 wxLogDebug(_T("bad year day in wxDateTime::ParseFormat"));
3131
3132 return (wxChar *)NULL;
3133 }
3134
3135 Tm tm2 = wxDateTime(1, Jan, tm.year).SetToYearDay(yday).GetTm();
3136
3137 tm.mon = tm2.mon;
3138 tm.mday = tm2.mday;
3139 }
3140
3141 // deal with AM/PM
3142 if ( haveHour && hourIsIn12hFormat && isPM )
3143 {
3144 // translate to 24hour format
3145 hour += 12;
3146 }
3147 //else: either already in 24h format or no translation needed
3148
3149 // set the time
3150 if ( haveHour )
3151 {
3152 tm.hour = hour;
3153 }
3154
3155 if ( haveMin )
3156 {
3157 tm.min = min;
3158 }
3159
3160 if ( haveSec )
3161 {
3162 tm.sec = sec;
3163 }
3164
3165 Set(tm);
3166
3167 return input;
3168 }
3169
3170 const wxChar *wxDateTime::ParseDateTime(const wxChar *date)
3171 {
3172 wxCHECK_MSG( date, (wxChar *)NULL, _T("NULL pointer in wxDateTime::Parse") );
3173
3174 // there is a public domain version of getdate.y, but it only works for
3175 // English...
3176 wxFAIL_MSG(_T("TODO"));
3177
3178 return (wxChar *)NULL;
3179 }
3180
3181 const wxChar *wxDateTime::ParseDate(const wxChar *date)
3182 {
3183 // this is a simplified version of ParseDateTime() which understands only
3184 // "today" (for wxDate compatibility) and digits only otherwise (and not
3185 // all esoteric constructions ParseDateTime() knows about)
3186
3187 wxCHECK_MSG( date, (wxChar *)NULL, _T("NULL pointer in wxDateTime::Parse") );
3188
3189 const wxChar *p = date;
3190 while ( wxIsspace(*p) )
3191 p++;
3192
3193 // some special cases
3194 static struct
3195 {
3196 const wxChar *str;
3197 int dayDiffFromToday;
3198 } literalDates[] =
3199 {
3200 { wxTRANSLATE("today"), 0 },
3201 { wxTRANSLATE("yesterday"), -1 },
3202 { wxTRANSLATE("tomorrow"), 1 },
3203 };
3204
3205 for ( size_t n = 0; n < WXSIZEOF(literalDates); n++ )
3206 {
3207 wxString date = wxGetTranslation(literalDates[n].str);
3208 size_t len = date.length();
3209 if ( wxStrlen(p) >= len && (wxString(p, len).CmpNoCase(date) == 0) )
3210 {
3211 // nothing can follow this, so stop here
3212 p += len;
3213
3214 int dayDiffFromToday = literalDates[n].dayDiffFromToday;
3215 *this = Today();
3216 if ( dayDiffFromToday )
3217 {
3218 *this += wxDateSpan::Days(dayDiffFromToday);
3219 }
3220
3221 return p;
3222 }
3223 }
3224
3225 // We try to guess what we have here: for each new (numeric) token, we
3226 // determine if it can be a month, day or a year. Of course, there is an
3227 // ambiguity as some numbers may be days as well as months, so we also
3228 // have the ability to back track.
3229
3230 // what do we have?
3231 bool haveDay = FALSE, // the months day?
3232 haveWDay = FALSE, // the day of week?
3233 haveMon = FALSE, // the month?
3234 haveYear = FALSE; // the year?
3235
3236 // and the value of the items we have (init them to get rid of warnings)
3237 WeekDay wday = Inv_WeekDay;
3238 wxDateTime_t day = 0;
3239 wxDateTime::Month mon = Inv_Month;
3240 int year = 0;
3241
3242 // tokenize the string
3243 size_t nPosCur = 0;
3244 static const wxChar *dateDelimiters = _T(".,/-\t\r\n ");
3245 wxStringTokenizer tok(p, dateDelimiters);
3246 while ( tok.HasMoreTokens() )
3247 {
3248 wxString token = tok.GetNextToken();
3249 if ( !token )
3250 continue;
3251
3252 // is it a number?
3253 unsigned long val;
3254 if ( token.ToULong(&val) )
3255 {
3256 // guess what this number is
3257
3258 bool isDay = FALSE,
3259 isMonth = FALSE,
3260 isYear = FALSE;
3261
3262 if ( !haveMon && val > 0 && val <= 12 )
3263 {
3264 // assume it is month
3265 isMonth = TRUE;
3266 }
3267 else // not the month
3268 {
3269 wxDateTime_t maxDays = haveMon
3270 ? GetNumOfDaysInMonth(haveYear ? year : Inv_Year, mon)
3271 : 31;
3272
3273 // can it be day?
3274 if ( (val == 0) || (val > (unsigned long)maxDays) ) // cast to shut up compiler warning in BCC
3275 {
3276 isYear = TRUE;
3277 }
3278 else
3279 {
3280 isDay = TRUE;
3281 }
3282 }
3283
3284 if ( isYear )
3285 {
3286 if ( haveYear )
3287 break;
3288
3289 haveYear = TRUE;
3290
3291 year = (wxDateTime_t)val;
3292 }
3293 else if ( isDay )
3294 {
3295 if ( haveDay )
3296 break;
3297
3298 haveDay = TRUE;
3299
3300 day = (wxDateTime_t)val;
3301 }
3302 else if ( isMonth )
3303 {
3304 haveMon = TRUE;
3305
3306 mon = (Month)(val - 1);
3307 }
3308 }
3309 else // not a number
3310 {
3311 // be careful not to overwrite the current mon value
3312 Month mon2 = GetMonthFromName(token, Name_Full | Name_Abbr);
3313 if ( mon2 != Inv_Month )
3314 {
3315 // it's a month
3316 if ( haveMon )
3317 {
3318 // but we already have a month - maybe we guessed wrong?
3319 if ( !haveDay )
3320 {
3321 // no need to check in month range as always < 12, but
3322 // the days are counted from 1 unlike the months
3323 day = (wxDateTime_t)mon + 1;
3324 haveDay = TRUE;
3325 }
3326 else
3327 {
3328 // could possible be the year (doesn't the year come
3329 // before the month in the japanese format?) (FIXME)
3330 break;
3331 }
3332 }
3333
3334 mon = mon2;
3335
3336 haveMon = TRUE;
3337 }
3338 else // not a valid month name
3339 {
3340 wday = GetWeekDayFromName(token, Name_Full | Name_Abbr);
3341 if ( wday != Inv_WeekDay )
3342 {
3343 // a week day
3344 if ( haveWDay )
3345 {
3346 break;
3347 }
3348
3349 haveWDay = TRUE;
3350 }
3351 else // not a valid weekday name
3352 {
3353 // try the ordinals
3354 static const wxChar *ordinals[] =
3355 {
3356 wxTRANSLATE("first"),
3357 wxTRANSLATE("second"),
3358 wxTRANSLATE("third"),
3359 wxTRANSLATE("fourth"),
3360 wxTRANSLATE("fifth"),
3361 wxTRANSLATE("sixth"),
3362 wxTRANSLATE("seventh"),
3363 wxTRANSLATE("eighth"),
3364 wxTRANSLATE("ninth"),
3365 wxTRANSLATE("tenth"),
3366 wxTRANSLATE("eleventh"),
3367 wxTRANSLATE("twelfth"),
3368 wxTRANSLATE("thirteenth"),
3369 wxTRANSLATE("fourteenth"),
3370 wxTRANSLATE("fifteenth"),
3371 wxTRANSLATE("sixteenth"),
3372 wxTRANSLATE("seventeenth"),
3373 wxTRANSLATE("eighteenth"),
3374 wxTRANSLATE("nineteenth"),
3375 wxTRANSLATE("twentieth"),
3376 // that's enough - otherwise we'd have problems with
3377 // composite (or not) ordinals
3378 };
3379
3380 size_t n;
3381 for ( n = 0; n < WXSIZEOF(ordinals); n++ )
3382 {
3383 if ( token.CmpNoCase(ordinals[n]) == 0 )
3384 {
3385 break;
3386 }
3387 }
3388
3389 if ( n == WXSIZEOF(ordinals) )
3390 {
3391 // stop here - something unknown
3392 break;
3393 }
3394
3395 // it's a day
3396 if ( haveDay )
3397 {
3398 // don't try anything here (as in case of numeric day
3399 // above) - the symbolic day spec should always
3400 // precede the month/year
3401 break;
3402 }
3403
3404 haveDay = TRUE;
3405
3406 day = (wxDateTime_t)(n + 1);
3407 }
3408 }
3409 }
3410
3411 nPosCur = tok.GetPosition();
3412 }
3413
3414 // either no more tokens or the scan was stopped by something we couldn't
3415 // parse - in any case, see if we can construct a date from what we have
3416 if ( !haveDay && !haveWDay )
3417 {
3418 wxLogDebug(_T("ParseDate: no day, no weekday hence no date."));
3419
3420 return (wxChar *)NULL;
3421 }
3422
3423 if ( haveWDay && (haveMon || haveYear || haveDay) &&
3424 !(haveDay && haveMon && haveYear) )
3425 {
3426 // without adjectives (which we don't support here) the week day only
3427 // makes sense completely separately or with the full date
3428 // specification (what would "Wed 1999" mean?)
3429 return (wxChar *)NULL;
3430 }
3431
3432 if ( !haveWDay && haveYear && !(haveDay && haveMon) )
3433 {
3434 // may be we have month and day instead of day and year?
3435 if ( haveDay && !haveMon )
3436 {
3437 if ( day <= 12 )
3438 {
3439 // exchange day and month
3440 mon = (wxDateTime::Month)(day - 1);
3441
3442 // we're in the current year then
3443 if ( (year > 0) &&
3444 (unsigned)year <= GetNumOfDaysInMonth(Inv_Year, mon) )
3445 {
3446 day = year;
3447
3448 haveMon = TRUE;
3449 haveYear = FALSE;
3450 }
3451 //else: no, can't exchange, leave haveMon == FALSE
3452 }
3453 }
3454
3455 if ( !haveMon )
3456 {
3457 // if we give the year, month and day must be given too
3458 wxLogDebug(_T("ParseDate: day and month should be specified if year is."));
3459
3460 return (wxChar *)NULL;
3461 }
3462 }
3463
3464 if ( !haveMon )
3465 {
3466 mon = GetCurrentMonth();
3467 }
3468
3469 if ( !haveYear )
3470 {
3471 year = GetCurrentYear();
3472 }
3473
3474 if ( haveDay )
3475 {
3476 Set(day, mon, year);
3477
3478 if ( haveWDay )
3479 {
3480 // check that it is really the same
3481 if ( GetWeekDay() != wday )
3482 {
3483 // inconsistency detected
3484 wxLogDebug(_T("ParseDate: inconsistent day/weekday."));
3485
3486 return (wxChar *)NULL;
3487 }
3488 }
3489 }
3490 else // haveWDay
3491 {
3492 *this = Today();
3493
3494 SetToWeekDayInSameWeek(wday);
3495 }
3496
3497 // return the pointer to the first unparsed char
3498 p += nPosCur;
3499 if ( nPosCur && wxStrchr(dateDelimiters, *(p - 1)) )
3500 {
3501 // if we couldn't parse the token after the delimiter, put back the
3502 // delimiter as well
3503 p--;
3504 }
3505
3506 return p;
3507 }
3508
3509 const wxChar *wxDateTime::ParseTime(const wxChar *time)
3510 {
3511 wxCHECK_MSG( time, (wxChar *)NULL, _T("NULL pointer in wxDateTime::Parse") );
3512
3513 // first try some extra things
3514 static const struct
3515 {
3516 const wxChar *name;
3517 wxDateTime_t hour;
3518 } stdTimes[] =
3519 {
3520 { wxTRANSLATE("noon"), 12 },
3521 { wxTRANSLATE("midnight"), 00 },
3522 // anything else?
3523 };
3524
3525 for ( size_t n = 0; n < WXSIZEOF(stdTimes); n++ )
3526 {
3527 wxString timeString = wxGetTranslation(stdTimes[n].name);
3528 size_t len = timeString.length();
3529 if ( timeString.CmpNoCase(wxString(time, len)) == 0 )
3530 {
3531 Set(stdTimes[n].hour, 0, 0);
3532
3533 return time + len;
3534 }
3535 }
3536
3537 // try all time formats we may think about in the order from longest to
3538 // shortest
3539
3540 // 12hour with AM/PM?
3541 const wxChar *result = ParseFormat(time, _T("%I:%M:%S %p"));
3542
3543 if ( !result )
3544 {
3545 // normally, it's the same, but why not try it?
3546 result = ParseFormat(time, _T("%H:%M:%S"));
3547 }
3548
3549 if ( !result )
3550 {
3551 // 12hour with AM/PM but without seconds?
3552 result = ParseFormat(time, _T("%I:%M %p"));
3553 }
3554
3555 if ( !result )
3556 {
3557 // without seconds?
3558 result = ParseFormat(time, _T("%H:%M"));
3559 }
3560
3561 if ( !result )
3562 {
3563 // just the hour and AM/PM?
3564 result = ParseFormat(time, _T("%I %p"));
3565 }
3566
3567 if ( !result )
3568 {
3569 // just the hour?
3570 result = ParseFormat(time, _T("%H"));
3571 }
3572
3573 if ( !result )
3574 {
3575 // parse the standard format: normally it is one of the formats above
3576 // but it may be set to something completely different by the user
3577 result = ParseFormat(time, _T("%X"));
3578 }
3579
3580 // TODO: parse timezones
3581
3582 return result;
3583 }
3584
3585 // ----------------------------------------------------------------------------
3586 // Workdays and holidays support
3587 // ----------------------------------------------------------------------------
3588
3589 bool wxDateTime::IsWorkDay(Country WXUNUSED(country)) const
3590 {
3591 return !wxDateTimeHolidayAuthority::IsHoliday(*this);
3592 }
3593
3594 // ============================================================================
3595 // wxTimeSpan
3596 // ============================================================================
3597
3598 // this enum is only used in wxTimeSpan::Format() below but we can't declare
3599 // it locally to the method as it provokes an internal compiler error in egcs
3600 // 2.91.60 when building with -O2
3601 enum TimeSpanPart
3602 {
3603 Part_Week,
3604 Part_Day,
3605 Part_Hour,
3606 Part_Min,
3607 Part_Sec,
3608 Part_MSec
3609 };
3610
3611 // not all strftime(3) format specifiers make sense here because, for example,
3612 // a time span doesn't have a year nor a timezone
3613 //
3614 // Here are the ones which are supported (all of them are supported by strftime
3615 // as well):
3616 // %H hour in 24 hour format
3617 // %M minute (00 - 59)
3618 // %S second (00 - 59)
3619 // %% percent sign
3620 //
3621 // Also, for MFC CTimeSpan compatibility, we support
3622 // %D number of days
3623 //
3624 // And, to be better than MFC :-), we also have
3625 // %E number of wEeks
3626 // %l milliseconds (000 - 999)
3627 wxString wxTimeSpan::Format(const wxChar *format) const
3628 {
3629 wxCHECK_MSG( format, _T(""), _T("NULL format in wxTimeSpan::Format") );
3630
3631 wxString str;
3632 str.Alloc(wxStrlen(format));
3633
3634 // Suppose we have wxTimeSpan ts(1 /* hour */, 2 /* min */, 3 /* sec */)
3635 //
3636 // Then, of course, ts.Format("%H:%M:%S") must return "01:02:03", but the
3637 // question is what should ts.Format("%S") do? The code here returns "3273"
3638 // in this case (i.e. the total number of seconds, not just seconds % 60)
3639 // because, for me, this call means "give me entire time interval in
3640 // seconds" and not "give me the seconds part of the time interval"
3641 //
3642 // If we agree that it should behave like this, it is clear that the
3643 // interpretation of each format specifier depends on the presence of the
3644 // other format specs in the string: if there was "%H" before "%M", we
3645 // should use GetMinutes() % 60, otherwise just GetMinutes() &c
3646
3647 // we remember the most important unit found so far
3648 TimeSpanPart partBiggest = Part_MSec;
3649
3650 for ( const wxChar *pch = format; *pch; pch++ )
3651 {
3652 wxChar ch = *pch;
3653
3654 if ( ch == _T('%') )
3655 {
3656 // the start of the format specification of the printf() below
3657 wxString fmtPrefix = _T('%');
3658
3659 // the number
3660 long n;
3661
3662 ch = *++pch; // get the format spec char
3663 switch ( ch )
3664 {
3665 default:
3666 wxFAIL_MSG( _T("invalid format character") );
3667 // fall through
3668
3669 case _T('%'):
3670 str += ch;
3671
3672 // skip the part below switch
3673 continue;
3674
3675 case _T('D'):
3676 n = GetDays();
3677 if ( partBiggest < Part_Day )
3678 {
3679 n %= DAYS_PER_WEEK;
3680 }
3681 else
3682 {
3683 partBiggest = Part_Day;
3684 }
3685 break;
3686
3687 case _T('E'):
3688 partBiggest = Part_Week;
3689 n = GetWeeks();
3690 break;
3691
3692 case _T('H'):
3693 n = GetHours();
3694 if ( partBiggest < Part_Hour )
3695 {
3696 n %= HOURS_PER_DAY;
3697 }
3698 else
3699 {
3700 partBiggest = Part_Hour;
3701 }
3702
3703 fmtPrefix += _T("02");
3704 break;
3705
3706 case _T('l'):
3707 n = GetMilliseconds().ToLong();
3708 if ( partBiggest < Part_MSec )
3709 {
3710 n %= 1000;
3711 }
3712 //else: no need to reset partBiggest to Part_MSec, it is
3713 // the least significant one anyhow
3714
3715 fmtPrefix += _T("03");
3716 break;
3717
3718 case _T('M'):
3719 n = GetMinutes();
3720 if ( partBiggest < Part_Min )
3721 {
3722 n %= MIN_PER_HOUR;
3723 }
3724 else
3725 {
3726 partBiggest = Part_Min;
3727 }
3728
3729 fmtPrefix += _T("02");
3730 break;
3731
3732 case _T('S'):
3733 n = GetSeconds().ToLong();
3734 if ( partBiggest < Part_Sec )
3735 {
3736 n %= SEC_PER_MIN;
3737 }
3738 else
3739 {
3740 partBiggest = Part_Sec;
3741 }
3742
3743 fmtPrefix += _T("02");
3744 break;
3745 }
3746
3747 str += wxString::Format(fmtPrefix + _T("ld"), n);
3748 }
3749 else
3750 {
3751 // normal character, just copy
3752 str += ch;
3753 }
3754 }
3755
3756 return str;
3757 }
3758
3759 // ============================================================================
3760 // wxDateTimeHolidayAuthority and related classes
3761 // ============================================================================
3762
3763 #include "wx/arrimpl.cpp"
3764
3765 WX_DEFINE_OBJARRAY(wxDateTimeArray);
3766
3767 static int wxCMPFUNC_CONV
3768 wxDateTimeCompareFunc(wxDateTime **first, wxDateTime **second)
3769 {
3770 wxDateTime dt1 = **first,
3771 dt2 = **second;
3772
3773 return dt1 == dt2 ? 0 : dt1 < dt2 ? -1 : +1;
3774 }
3775
3776 // ----------------------------------------------------------------------------
3777 // wxDateTimeHolidayAuthority
3778 // ----------------------------------------------------------------------------
3779
3780 wxHolidayAuthoritiesArray wxDateTimeHolidayAuthority::ms_authorities;
3781
3782 /* static */
3783 bool wxDateTimeHolidayAuthority::IsHoliday(const wxDateTime& dt)
3784 {
3785 size_t count = ms_authorities.GetCount();
3786 for ( size_t n = 0; n < count; n++ )
3787 {
3788 if ( ms_authorities[n]->DoIsHoliday(dt) )
3789 {
3790 return TRUE;
3791 }
3792 }
3793
3794 return FALSE;
3795 }
3796
3797 /* static */
3798 size_t
3799 wxDateTimeHolidayAuthority::GetHolidaysInRange(const wxDateTime& dtStart,
3800 const wxDateTime& dtEnd,
3801 wxDateTimeArray& holidays)
3802 {
3803 wxDateTimeArray hol;
3804
3805 holidays.Empty();
3806
3807 size_t count = ms_authorities.GetCount();
3808 for ( size_t nAuth = 0; nAuth < count; nAuth++ )
3809 {
3810 ms_authorities[nAuth]->DoGetHolidaysInRange(dtStart, dtEnd, hol);
3811
3812 WX_APPEND_ARRAY(holidays, hol);
3813 }
3814
3815 holidays.Sort(wxDateTimeCompareFunc);
3816
3817 return holidays.GetCount();
3818 }
3819
3820 /* static */
3821 void wxDateTimeHolidayAuthority::ClearAllAuthorities()
3822 {
3823 WX_CLEAR_ARRAY(ms_authorities);
3824 }
3825
3826 /* static */
3827 void wxDateTimeHolidayAuthority::AddAuthority(wxDateTimeHolidayAuthority *auth)
3828 {
3829 ms_authorities.Add(auth);
3830 }
3831
3832 // ----------------------------------------------------------------------------
3833 // wxDateTimeWorkDays
3834 // ----------------------------------------------------------------------------
3835
3836 bool wxDateTimeWorkDays::DoIsHoliday(const wxDateTime& dt) const
3837 {
3838 wxDateTime::WeekDay wd = dt.GetWeekDay();
3839
3840 return (wd == wxDateTime::Sun) || (wd == wxDateTime::Sat);
3841 }
3842
3843 size_t wxDateTimeWorkDays::DoGetHolidaysInRange(const wxDateTime& dtStart,
3844 const wxDateTime& dtEnd,
3845 wxDateTimeArray& holidays) const
3846 {
3847 if ( dtStart > dtEnd )
3848 {
3849 wxFAIL_MSG( _T("invalid date range in GetHolidaysInRange") );
3850
3851 return 0u;
3852 }
3853
3854 holidays.Empty();
3855
3856 // instead of checking all days, start with the first Sat after dtStart and
3857 // end with the last Sun before dtEnd
3858 wxDateTime dtSatFirst = dtStart.GetNextWeekDay(wxDateTime::Sat),
3859 dtSatLast = dtEnd.GetPrevWeekDay(wxDateTime::Sat),
3860 dtSunFirst = dtStart.GetNextWeekDay(wxDateTime::Sun),
3861 dtSunLast = dtEnd.GetPrevWeekDay(wxDateTime::Sun),
3862 dt;
3863
3864 for ( dt = dtSatFirst; dt <= dtSatLast; dt += wxDateSpan::Week() )
3865 {
3866 holidays.Add(dt);
3867 }
3868
3869 for ( dt = dtSunFirst; dt <= dtSunLast; dt += wxDateSpan::Week() )
3870 {
3871 holidays.Add(dt);
3872 }
3873
3874 return holidays.GetCount();
3875 }
3876
3877 #endif // wxUSE_DATETIME