Ticket #4418: 4418_duration_l18n.patch

binaries/data/mods/public/gui/common/functions_utility.js

@@ -132 +132 @@
         var format = translate("mm:ss");
     else
         var format = translate("HH:mm:ss");
-    return Engine.FormatMillisecondsIntoDateString(time, format);
+    return Engine.FormatMillisecondsIntoDurationString(time, format);
 }
 
 function removeDupes(array)

source/i18n/L10n.cpp

@@ -375 +375 @@
     return std::string(utf8Date, sink.NumberOfBytesWritten());
 }
 
-std::string L10n::FormatMillisecondsIntoDateString(const UDate& milliseconds, const std::string& formatString) const
+std::string L10n::FormatMillisecondsIntoDateString(const UDate& milliseconds, const std::string& formatString, bool isDuration) const
 {
     UErrorCode status = U_ZERO_ERROR;
     UnicodeString dateString;
@@ -386 +386 @@
     if (U_FAILURE(status))
         LOGERROR("Error creating SimpleDateFormat: %s", u_errorName(status));
 
-    const TimeZone* timeZone = TimeZone::createDefault();
+    const TimeZone* timeZone = isDuration ? TimeZone::getGMT() : TimeZone::createDefault();
 
     status = U_ZERO_ERROR;
     Calendar* calendar = Calendar::createInstance(*timeZone, currentLocale, status);

source/i18n/L10n.h

@@ -435 +435 @@
      *        symbols. Usually, you internationalize the format string and
      *        get it translated before you pass it to
      *        FormatMillisecondsIntoDateString().
+     * @param isDuration Boolean if the date is a duration don't convert to
+     *        the local timezone; default: false
      * @return String containing the specified date with the specified date
      *         format.
      *
@@ -441 +443 @@
      * @sa http://en.wikipedia.org/wiki/Unix_time
      * @sa https://sites.google.com/site/icuprojectuserguide/formatparse/datetime?pli=1#TOC-Date-Field-Symbol-Table
      */
-    std::string FormatMillisecondsIntoDateString(const UDate& milliseconds, const std::string& formatString) const;
+    std::string FormatMillisecondsIntoDateString(const UDate& milliseconds, const std::string& formatString, bool isDuration = false) const;
 
     /**
      * Returns the specified floating-point number as a string, with the number

source/i18n/scripting/JSInterface_L10n.cpp

@@ -74 +74 @@
     return wstring_from_utf8(g_L10n.FormatMillisecondsIntoDateString(milliseconds, utf8_from_wstring(formatString)));
 }
 
+// Return a localized version of a duration given in milliseconds.
+std::wstring JSI_L10n::FormatMillisecondsIntoDurationString(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), UDate milliseconds, const std::wstring& formatString)
+{
+    return wstring_from_utf8(g_L10n.FormatMillisecondsIntoDateString(milliseconds, utf8_from_wstring(formatString), true));
+}
+
 // Return a localized version of the given decimal number.
 std::wstring JSI_L10n::FormatDecimalNumberIntoString(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), double number)
 {
@@ -160 +166 @@
     scriptInterface.RegisterFunction<std::wstring, std::wstring, &TranslateLines>("TranslateLines");
     scriptInterface.RegisterFunction<std::vector<std::wstring>, std::vector<std::wstring>, &TranslateArray>("TranslateArray");
     scriptInterface.RegisterFunction<std::wstring, UDate, std::wstring, &FormatMillisecondsIntoDateString>("FormatMillisecondsIntoDateString");
+    scriptInterface.RegisterFunction<std::wstring, UDate, std::wstring, &FormatMillisecondsIntoDurationString>("FormatMillisecondsIntoDurationString");
     scriptInterface.RegisterFunction<std::wstring, double, &FormatDecimalNumberIntoString>("FormatDecimalNumberIntoString");
 
     scriptInterface.RegisterFunction<std::vector<std::string>, &GetSupportedLocaleBaseNames>("GetSupportedLocaleBaseNames");

source/i18n/scripting/JSInterface_L10n.h

@@ -175 +175 @@
     std::wstring FormatMillisecondsIntoDateString(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), UDate milliseconds, const std::wstring& formatString);
 
     /**
+    * Returns the specified duration using the specified date format.
+    *
+    * This is a JavaScript interface to
+    * L10n::FormatMillisecondsIntoDateString().
+    *
+    * @param pCxPrivate JavaScript context.
+    * @param milliseconds Date specified as a UNIX timestamp in milliseconds
+    *        (not seconds). If you have a JavaScript @c ​Date object, you can
+    *        use @c ​Date.getTime() to obtain the UNIX time in milliseconds.
+    * @param formatString Date format string defined using ICU date formatting
+    *        symbols. Usually, you internationalize the format string and
+    *        get it translated before you pass it to
+    *        FormatMillisecondsIntoDateString().
+    * @return String containing the specified date with the specified date
+    *         format.
+    *
+    * @sa http://en.wikipedia.org/wiki/Unix_time
+    * @sa https://sites.google.com/site/icuprojectuserguide/formatparse/datetime?pli=1#TOC-Date-Field-Symbol-Table
+    */
+    std::wstring FormatMillisecondsIntoDurationString(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), UDate milliseconds, const std::wstring& formatString);
+
+    /**
      * Returns the specified floating-point number as a string, with the number
      * formatted as a decimal number using the
      * @link L10n::GetCurrentLocale() current locale@endlink.