replaced C++ comments with C ones

[wxWidgets.git] / src / common / datetime.cpp

diff --git a/src/common/datetime.cpp b/src/common/datetime.cpp
index 6dab7627004e93baeb2ec20eaed898d582c18b88..672a97e7a96c8cd97a3cf54a427e2af21f91df6f 100644 (file)
--- a/src/common/datetime.cpp
+++ b/src/common/datetime.cpp
@@ -63,12 +63,14 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if !defined(wxUSE_DATETIME) || wxUSE_DATETIME
+

 #ifndef WX_PRECOMP
     #include "wx/string.h"
 #ifndef WX_PRECOMP
     #include "wx/string.h"

-    #include "wx/intl.h"

     #include "wx/log.h"
 #endif // WX_PRECOMP
 
     #include "wx/log.h"
 #endif // WX_PRECOMP
 

+#include "wx/intl.h"

 #include "wx/thread.h"
 #include "wx/tokenzr.h"
 #include "wx/module.h"
 #include "wx/thread.h"
 #include "wx/tokenzr.h"
 #include "wx/module.h"


@@ -152,10 +154,16 @@ IMPLEMENT_DYNAMIC_CLASS(wxDateTimeHolidaysModule, wxModule)
 // some trivial ones
 static const int MONTHS_IN_YEAR = 12;
 
 // some trivial ones
 static const int MONTHS_IN_YEAR = 12;
 

-static const int SECONDS_IN_MINUTE = 60;
+static const int SEC_PER_MIN = 60;
+
+static const int MIN_PER_HOUR = 60;
+
+static const int HOURS_PER_DAY = 24;

 
 static const long SECONDS_PER_DAY = 86400l;
 
 
 static const long SECONDS_PER_DAY = 86400l;
 

+static const int DAYS_PER_WEEK = 7;
+

 static const long MILLISECONDS_PER_DAY = 86400000l;
 
 // this is the integral part of JDN of the midnight of Jan 1, 1970
 static const long MILLISECONDS_PER_DAY = 86400000l;
 
 // this is the integral part of JDN of the midnight of Jan 1, 1970


@@ -188,7 +196,8 @@ static const wxDateTime::wxDateTime_t gs_cumulatedDays[2][MONTHS_IN_YEAR] =
 
 // in the fine tradition of ANSI C we use our equivalent of (time_t)-1 to
 // indicate an invalid wxDateTime object
 
 // in the fine tradition of ANSI C we use our equivalent of (time_t)-1 to
 // indicate an invalid wxDateTime object

-static const wxDateTime gs_dtDefault = wxLongLong((long)ULONG_MAX, ULONG_MAX);
+
+static const wxDateTime gs_dtDefault;

 
 const wxDateTime& wxDefaultDateTime = gs_dtDefault;
 
 
 const wxDateTime& wxDefaultDateTime = gs_dtDefault;
 


@@ -1061,8 +1070,6 @@ wxDateTime wxDateTime::GetEndDST(int year, Country country)
 // the values in the tm structure contain the local time
 wxDateTime& wxDateTime::Set(const struct tm& tm)
 {
 // the values in the tm structure contain the local time
 wxDateTime& wxDateTime::Set(const struct tm& tm)
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
-

     struct tm tm2(tm);
     time_t timet = mktime(&tm2);
 
     struct tm tm2(tm);
     time_t timet = mktime(&tm2);
 


@@ -1101,8 +1108,6 @@ wxDateTime& wxDateTime::Set(wxDateTime_t hour,
                             wxDateTime_t second,
                             wxDateTime_t millisec)
 {
                             wxDateTime_t second,
                             wxDateTime_t millisec)
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
-

     // we allow seconds to be 61 to account for the leap seconds, even if we
     // don't use them really
     wxDATETIME_CHECK( hour < 24 &&
     // we allow seconds to be 61 to account for the leap seconds, even if we
     // don't use them really
     wxDATETIME_CHECK( hour < 24 &&


@@ -1135,8 +1140,6 @@ wxDateTime& wxDateTime::Set(wxDateTime_t day,
                             wxDateTime_t second,
                             wxDateTime_t millisec)
 {
                             wxDateTime_t second,
                             wxDateTime_t millisec)
 {

-    wxASSERT_MSG( IsValid(), _T("invalid wxDateTime") );
-

     wxDATETIME_CHECK( hour < 24 &&
                       second < 62 &&
                       minute < 60 &&
     wxDATETIME_CHECK( hour < 24 &&
                       second < 62 &&
                       minute < 60 &&


@@ -1243,7 +1246,7 @@ wxDateTime::Tm wxDateTime::GetTm(const TimeZone& tz) const
         else
         {
             time += (time_t)tz.GetOffset();
         else
         {
             time += (time_t)tz.GetOffset();

-#ifdef __VMS__ // time is unsigned so avoid warning
+#if defined(__VMS__) || defined(__WATCOMC__) // time is unsigned so avoid warning

             int time2 = (int) time;
             if ( time2 >= 0 )
 #else
             int time2 = (int) time;
             if ( time2 >= 0 )
 #else


@@ -1329,8 +1332,6 @@ wxDateTime::Tm wxDateTime::GetTm(const TimeZone& tz) const
     // check that the algorithm gave us something reasonable
     wxASSERT_MSG( (0 < month) && (month <= 12), _T("invalid month") );
     wxASSERT_MSG( (1 <= day) && (day < 32), _T("invalid day") );
     // check that the algorithm gave us something reasonable
     wxASSERT_MSG( (0 < month) && (month <= 12), _T("invalid month") );
     wxASSERT_MSG( (1 <= day) && (day < 32), _T("invalid day") );

-    wxASSERT_MSG( (INT_MIN <= year) && (year <= INT_MAX),
-                  _T("year range overflow") );

 
     // construct Tm from these values
     Tm tm;
 
     // construct Tm from these values
     Tm tm;


@@ -1810,7 +1811,7 @@ wxString wxDateTime::Format(const wxChar *format, const TimeZone& tz) const
         {
             time += (int)tz.GetOffset();
 
         {
             time += (int)tz.GetOffset();
 

-#ifdef __VMS__ // time is unsigned so avoid the warning
+#if defined(__VMS__) || defined(__WATCOMC__) // time is unsigned so avoid warning

             int time2 = (int) time;
             if ( time2 >= 0 )
 #else
             int time2 = (int) time;
             if ( time2 >= 0 )
 #else


@@ -2927,11 +2928,7 @@ const wxChar *wxDateTime::ParseFormat(const wxChar *date,
         // take this date as default
         tmDef = dateDef.GetTm();
     }
         // take this date as default
         tmDef = dateDef.GetTm();
     }

-#ifdef __WIN16__
-    else if ( m_time != 0 )
-#else
-    else if ( m_time != wxLongLong(0) )
-#endif
+    else if ( IsValid() )

     {
         // if this date is valid, don't change it
         tmDef = GetTm();
     {
         // if this date is valid, don't change it
         tmDef = GetTm();


@@ -3113,7 +3110,7 @@ const wxChar *wxDateTime::ParseDate(const wxChar *date)
                     : 31;
 
                 // can it be day?
                     : 31;
 
                 // can it be day?

-                if ( (val == 0) || (val > maxDays) )
+                if ( (val == 0) || (val > (unsigned long)maxDays) )  // cast to shut up compiler warning in BCC

                 {
                     isYear = TRUE;
                 }
                 {
                     isYear = TRUE;
                 }


@@ -3160,7 +3157,7 @@ const wxChar *wxDateTime::ParseDate(const wxChar *date)
                     // but we already have a month - maybe we guessed wrong?
                     if ( !haveDay )
                     {
                     // but we already have a month - maybe we guessed wrong?
                     if ( !haveDay )
                     {

-                       // no need to check in month range as always < 12, but
+                        // no need to check in month range as always < 12, but

                         // the days are counted from 1 unlike the months
                         day = (wxDateTime_t)mon + 1;
                         haveDay = TRUE;
                         // the days are counted from 1 unlike the months
                         day = (wxDateTime_t)mon + 1;
                         haveDay = TRUE;


@@ -3170,7 +3167,7 @@ const wxChar *wxDateTime::ParseDate(const wxChar *date)
                         // could possible be the year (doesn't the year come
                         // before the month in the japanese format?) (FIXME)
                         break;
                         // could possible be the year (doesn't the year come
                         // before the month in the japanese format?) (FIXME)
                         break;

-                       }
+                    }

                 }
 
                 mon = mon2;
                 }
 
                 mon = mon2;


@@ -3245,7 +3242,7 @@ const wxChar *wxDateTime::ParseDate(const wxChar *date)
 
                     haveDay = TRUE;
 
 
                     haveDay = TRUE;
 

-                    day = n + 1;
+                    day = (wxDateTime_t)(n + 1);

                 }
             }
         }
                 }
             }
         }


@@ -3282,7 +3279,8 @@ const wxChar *wxDateTime::ParseDate(const wxChar *date)
                 mon = (wxDateTime::Month)(day - 1);
 
                 // we're in the current year then
                 mon = (wxDateTime::Month)(day - 1);
 
                 // we're in the current year then

-                if ( year <= GetNumOfDaysInMonth(Inv_Year, mon) )
+                if ( (year > 0) &&
+                        (unsigned)year <= GetNumOfDaysInMonth(Inv_Year, mon) )

                 {
                     day = year;
 
                 {
                     day = year;
 


@@ -3375,8 +3373,12 @@ const wxChar *wxDateTime::ParseTime(const wxChar *time)
         }
     }
 
         }
     }
 

-    // try all time formats we may think about starting with the standard one
-    const wxChar *result = ParseFormat(time, _T("%X"));
+    // try all time formats we may think about in the order from longest to
+    // shortest
+
+    // 12hour with AM/PM?
+    const wxChar *result = ParseFormat(time, _T("%I:%M:%S %p"));
+

     if ( !result )
     {
         // normally, it's the same, but why not try it?
     if ( !result )
     {
         // normally, it's the same, but why not try it?


@@ -3385,8 +3387,8 @@ const wxChar *wxDateTime::ParseTime(const wxChar *time)
 
     if ( !result )
     {
 
     if ( !result )
     {

-        // 12hour with AM/PM?
-        result = ParseFormat(time, _T("%I:%M:%S %p"));
+        // 12hour with AM/PM but without seconds?
+        result = ParseFormat(time, _T("%I:%M %p"));

     }
 
     if ( !result )
     }
 
     if ( !result )


@@ -3397,8 +3399,8 @@ const wxChar *wxDateTime::ParseTime(const wxChar *time)
 
     if ( !result )
     {
 
     if ( !result )
     {

-        // 12hour with AM/PM but without seconds?
-        result = ParseFormat(time, _T("%I:%M %p"));
+        // just the hour and AM/PM?
+        result = ParseFormat(time, _T("%I %p"));

     }
 
     if ( !result )
     }
 
     if ( !result )


@@ -3409,8 +3411,9 @@ const wxChar *wxDateTime::ParseTime(const wxChar *time)
 
     if ( !result )
     {
 
     if ( !result )
     {

-        // just the hour and AM/PM?
-        result = ParseFormat(time, _T("%I %p"));
+        // parse the standard format: normally it is one of the formats above
+        // but it may be set to something completely different by the user
+        result = ParseFormat(time, _T("%X"));

     }
 
     // TODO: parse timezones
     }
 
     // TODO: parse timezones


@@ -3431,6 +3434,19 @@ bool wxDateTime::IsWorkDay(Country WXUNUSED(country)) const
 // wxTimeSpan
 // ============================================================================
 
 // wxTimeSpan
 // ============================================================================
 

+// this enum is only used in wxTimeSpan::Format() below but we can't declare
+// it locally to the method as it provokes an internal compiler error in egcs
+// 2.91.60 when building with -O2
+enum TimeSpanPart
+{
+    Part_Week,
+    Part_Day,
+    Part_Hour,
+    Part_Min,
+    Part_Sec,
+    Part_MSec
+};
+

 // not all strftime(3) format specifiers make sense here because, for example,
 // a time span doesn't have a year nor a timezone
 //
 // not all strftime(3) format specifiers make sense here because, for example,
 // a time span doesn't have a year nor a timezone
 //


@@ -3454,13 +3470,33 @@ wxString wxTimeSpan::Format(const wxChar *format) const
     wxString str;
     str.Alloc(wxStrlen(format));
 
     wxString str;
     str.Alloc(wxStrlen(format));
 

+    // Suppose we have wxTimeSpan ts(1 /* hour */, 2 /* min */, 3 /* sec */)
+    //
+    // Then, of course, ts.Format("%H:%M:%S") must return "01:02:03", but the
+    // question is what should ts.Format("%S") do? The code here returns "3273"
+    // in this case (i.e. the total number of seconds, not just seconds % 60)
+    // because, for me, this call means "give me entire time interval in
+    // seconds" and not "give me the seconds part of the time interval"
+    //
+    // If we agree that it should behave like this, it is clear that the
+    // interpretation of each format specifier depends on the presence of the
+    // other format specs in the string: if there was "%H" before "%M", we
+    // should use GetMinutes() % 60, otherwise just GetMinutes() &c
+
+    // we remember the most important unit found so far
+    TimeSpanPart partBiggest = Part_MSec;
+

     for ( const wxChar *pch = format; *pch; pch++ )
     {
         wxChar ch = *pch;
 
         if ( ch == _T('%') )
         {
     for ( const wxChar *pch = format; *pch; pch++ )
     {
         wxChar ch = *pch;
 
         if ( ch == _T('%') )
         {

-            wxString tmp;
+            // the start of the format specification of the printf() below
+            wxString fmtPrefix = _T('%');
+
+            // the number
+            long n;

 
             ch = *++pch;    // get the format spec char
             switch ( ch )
 
             ch = *++pch;    // get the format spec char
             switch ( ch )


@@ -3470,44 +3506,90 @@ wxString wxTimeSpan::Format(const wxChar *format) const
                     // fall through
 
                 case _T('%'):
                     // fall through
 
                 case _T('%'):

-                    // will get to str << ch below
-                    break;
+                    str += ch;
+
+                    // skip the part below switch
+                    continue;

 
                 case _T('D'):
 
                 case _T('D'):

-                    tmp.Printf(_T("%d"), GetDays());
+                    n = GetDays();
+                    if ( partBiggest < Part_Day )
+                    {
+                        n %= DAYS_PER_WEEK;
+                    }
+                    else
+                    {
+                        partBiggest = Part_Day;
+                    }

                     break;
 
                 case _T('E'):
                     break;
 
                 case _T('E'):

-                    tmp.Printf(_T("%d"), GetWeeks());
+                    partBiggest = Part_Week;
+                    n = GetWeeks();

                     break;
 
                 case _T('H'):
                     break;
 
                 case _T('H'):

-                    tmp.Printf(_T("%02d"), GetHours());
+                    n = GetHours();
+                    if ( partBiggest < Part_Hour )
+                    {
+                        n %= HOURS_PER_DAY;
+                    }
+                    else
+                    {
+                        partBiggest = Part_Hour;
+                    }
+
+                    fmtPrefix += _T("02");

                     break;
 
                 case _T('l'):
                     break;
 
                 case _T('l'):

-                    tmp.Printf(_T("%03ld"), GetMilliseconds().ToLong());
+                    n = GetMilliseconds().ToLong();
+                    if ( partBiggest < Part_MSec )
+                    {
+                        n %= 1000;
+                    }
+                    //else: no need to reset partBiggest to Part_MSec, it is
+                    //      the least significant one anyhow
+
+                    fmtPrefix += _T("03");

                     break;
 
                 case _T('M'):
                     break;
 
                 case _T('M'):

-                    tmp.Printf(_T("%02d"), GetMinutes());
+                    n = GetMinutes();
+                    if ( partBiggest < Part_Min )
+                    {
+                        n %= MIN_PER_HOUR;
+                    }
+                    else
+                    {
+                        partBiggest = Part_Min;
+                    }
+
+                    fmtPrefix += _T("02");

                     break;
 
                 case _T('S'):
                     break;
 
                 case _T('S'):

-                    tmp.Printf(_T("%02ld"), GetSeconds().ToLong());
+                    n = GetSeconds().ToLong();
+                    if ( partBiggest < Part_Sec )
+                    {
+                        n %= SEC_PER_MIN;
+                    }
+                    else
+                    {
+                        partBiggest = Part_Sec;
+                    }
+
+                    fmtPrefix += _T("02");

                     break;
             }
 
                     break;
             }
 

-            if ( !!tmp )
-            {
-                str += tmp;
-
-                // skip str += ch below
-                continue;
-            }
+            str += wxString::Format(fmtPrefix + _T("ld"), n);
+        }
+        else
+        {
+            // normal character, just copy
+            str += ch;

         }
         }

-
-        str += ch;

     }
 
     return str;
     }
 
     return str;


@@ -3631,4 +3713,4 @@ size_t wxDateTimeWorkDays::DoGetHolidaysInRange(const wxDateTime& dtStart,
     return holidays.GetCount();
 }
 
     return holidays.GetCount();
 }
 

-
+#endif // wxUSE_DATETIME