base/i18n/time_formatting.cc

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/i18n/time_formatting.h"
   6
   7 #include <stddef.h>
   8
   9 #include <memory>
  10
  11 #include "base/i18n/unicodestring.h"
  12 #include "base/logging.h"
  13 #include "base/strings/utf_string_conversions.h"
  14 #include "base/time/time.h"
  15 #include "third_party/icu/source/common/unicode/utypes.h"
  16 #include "third_party/icu/source/i18n/unicode/datefmt.h"
  17 #include "third_party/icu/source/i18n/unicode/dtitvfmt.h"
  18 #include "third_party/icu/source/i18n/unicode/dtptngen.h"
  19 #include "third_party/icu/source/i18n/unicode/fmtable.h"
  20 #include "third_party/icu/source/i18n/unicode/measfmt.h"
  21 #include "third_party/icu/source/i18n/unicode/smpdtfmt.h"
  22
  23 namespace base {
  24 namespace {
  25
  26 string16 TimeFormat(const icu::DateFormat* formatter,
  27                     const Time& time) {
  28   DCHECK(formatter);
  29   icu::UnicodeString date_string;
  30
  31   formatter->format(static_cast<UDate>(time.ToDoubleT() * 1000), date_string);
  32   return i18n::UnicodeStringToString16(date_string);
  33 }
  34
  35 string16 TimeFormatWithoutAmPm(const icu::DateFormat* formatter,
  36                                const Time& time) {
  37   DCHECK(formatter);
  38   icu::UnicodeString time_string;
  39
  40   icu::FieldPosition ampm_field(icu::DateFormat::kAmPmField);
  41   formatter->format(
  42       static_cast<UDate>(time.ToDoubleT() * 1000), time_string, ampm_field);
  43   int ampm_length = ampm_field.getEndIndex() - ampm_field.getBeginIndex();
  44   if (ampm_length) {
  45     int begin = ampm_field.getBeginIndex();
  46     // Doesn't include any spacing before the field.
  47     if (begin)
  48       begin--;
  49     time_string.removeBetween(begin, ampm_field.getEndIndex());
  50   }
  51   return i18n::UnicodeStringToString16(time_string);
  52 }
  53
  54 icu::SimpleDateFormat CreateSimpleDateFormatter(const char* pattern) {
  55   // Generate a locale-dependent format pattern. The generator will take
  56   // care of locale-dependent formatting issues like which separator to
  57   // use (some locales use '.' instead of ':'), and where to put the am/pm
  58   // marker.
  59   UErrorCode status = U_ZERO_ERROR;
  60   std::unique_ptr<icu::DateTimePatternGenerator> generator(
  61       icu::DateTimePatternGenerator::createInstance(status));
  62   DCHECK(U_SUCCESS(status));
  63   icu::UnicodeString generated_pattern =
  64       generator->getBestPattern(icu::UnicodeString(pattern), status);
  65   DCHECK(U_SUCCESS(status));
  66
  67   // Then, format the time using the generated pattern.
  68   icu::SimpleDateFormat formatter(generated_pattern, status);
  69   DCHECK(U_SUCCESS(status));
  70
  71   return formatter;
  72 }
  73
  74 UMeasureFormatWidth DurationWidthToMeasureWidth(DurationFormatWidth width) {
  75   switch (width) {
  76     case DURATION_WIDTH_WIDE: return UMEASFMT_WIDTH_WIDE;
  77     case DURATION_WIDTH_SHORT: return UMEASFMT_WIDTH_SHORT;
  78     case DURATION_WIDTH_NARROW: return UMEASFMT_WIDTH_NARROW;
  79     case DURATION_WIDTH_NUMERIC: return UMEASFMT_WIDTH_NUMERIC;
  80   }
  81   NOTREACHED();
  82   return UMEASFMT_WIDTH_COUNT;
  83 }
  84
  85 const char* DateFormatToString(DateFormat format) {
  86   switch (format) {
  87     case DATE_FORMAT_YEAR_MONTH:
  88       return UDAT_YEAR_MONTH;
  89     case DATE_FORMAT_MONTH_WEEKDAY_DAY:
  90       return UDAT_MONTH_WEEKDAY_DAY;
  91   }
  92   NOTREACHED();
  93   return UDAT_YEAR_MONTH_DAY;
  94 }
  95
  96 }  // namespace
  97
  98 string16 TimeFormatTimeOfDay(const Time& time) {
  99   // We can omit the locale parameter because the default should match
 100   // Chrome's application locale.
 101   std::unique_ptr<icu::DateFormat> formatter(
 102       icu::DateFormat::createTimeInstance(icu::DateFormat::kShort));
 103   return TimeFormat(formatter.get(), time);
 104 }
 105
 106 string16 TimeFormatTimeOfDayWithMilliseconds(const Time& time) {
 107   icu::SimpleDateFormat formatter = CreateSimpleDateFormatter("HmsSSS");
 108   return TimeFormatWithoutAmPm(&formatter, time);
 109 }
 110
 111 string16 TimeFormatTimeOfDayWithHourClockType(const Time& time,
 112                                               HourClockType type,
 113                                               AmPmClockType ampm) {
 114   // Just redirect to the normal function if the default type matches the
 115   // given type.
 116   HourClockType default_type = GetHourClockType();
 117   if (default_type == type && (type == k24HourClock || ampm == kKeepAmPm)) {
 118     return TimeFormatTimeOfDay(time);
 119   }
 120
 121   const char* base_pattern = (type == k12HourClock ? "ahm" : "Hm");
 122   icu::SimpleDateFormat formatter = CreateSimpleDateFormatter(base_pattern);
 123
 124   if (ampm == kKeepAmPm) {
 125     return TimeFormat(&formatter, time);
 126   }
 127   return TimeFormatWithoutAmPm(&formatter, time);
 128 }
 129
 130 string16 TimeFormatShortDate(const Time& time) {
 131   std::unique_ptr<icu::DateFormat> formatter(
 132       icu::DateFormat::createDateInstance(icu::DateFormat::kMedium));
 133   return TimeFormat(formatter.get(), time);
 134 }
 135
 136 string16 TimeFormatShortDateNumeric(const Time& time) {
 137   std::unique_ptr<icu::DateFormat> formatter(
 138       icu::DateFormat::createDateInstance(icu::DateFormat::kShort));
 139   return TimeFormat(formatter.get(), time);
 140 }
 141
 142 string16 TimeFormatShortDateAndTime(const Time& time) {
 143   std::unique_ptr<icu::DateFormat> formatter(
 144       icu::DateFormat::createDateTimeInstance(icu::DateFormat::kShort));
 145   return TimeFormat(formatter.get(), time);
 146 }
 147
 148 string16 TimeFormatShortDateAndTimeWithTimeZone(const Time& time) {
 149   std::unique_ptr<icu::DateFormat> formatter(
 150       icu::DateFormat::createDateTimeInstance(icu::DateFormat::kShort,
 151                                               icu::DateFormat::kLong));
 152   return TimeFormat(formatter.get(), time);
 153 }
 154
 155 string16 TimeFormatMonthAndYear(const Time& time) {
 156   icu::SimpleDateFormat formatter =
 157       CreateSimpleDateFormatter(DateFormatToString(DATE_FORMAT_YEAR_MONTH));
 158   return TimeFormat(&formatter, time);
 159 }
 160
 161 string16 TimeFormatFriendlyDateAndTime(const Time& time) {
 162   std::unique_ptr<icu::DateFormat> formatter(
 163       icu::DateFormat::createDateTimeInstance(icu::DateFormat::kFull));
 164   return TimeFormat(formatter.get(), time);
 165 }
 166
 167 string16 TimeFormatFriendlyDate(const Time& time) {
 168   std::unique_ptr<icu::DateFormat> formatter(
 169       icu::DateFormat::createDateInstance(icu::DateFormat::kFull));
 170   return TimeFormat(formatter.get(), time);
 171 }
 172
 173 string16 TimeFormatWithPattern(const Time& time, const char* pattern) {
 174   icu::SimpleDateFormat formatter = CreateSimpleDateFormatter(pattern);
 175   return TimeFormat(&formatter, time);
 176 }
 177
 178 bool TimeDurationFormat(const TimeDelta time,
 179                         const DurationFormatWidth width,
 180                         string16* out) {
 181   DCHECK(out);
 182   UErrorCode status = U_ZERO_ERROR;
 183   const int total_minutes = static_cast<int>(time.InSecondsF() / 60 + 0.5);
 184   const int hours = total_minutes / 60;
 185   const int minutes = total_minutes % 60;
 186   UMeasureFormatWidth u_width = DurationWidthToMeasureWidth(width);
 187
 188   // TODO(derat): Delete the |status| checks and LOG(ERROR) calls throughout
 189   // this function once the cause of http://crbug.com/677043 is tracked down.
 190   const icu::Measure measures[] = {
 191       icu::Measure(hours, icu::MeasureUnit::createHour(status), status),
 192       icu::Measure(minutes, icu::MeasureUnit::createMinute(status), status)};
 193   if (U_FAILURE(status)) {
 194     LOG(ERROR) << "Creating MeasureUnit or Measure for " << hours << "h"
 195                << minutes << "m failed: " << u_errorName(status);
 196     return false;
 197   }
 198
 199   icu::MeasureFormat measure_format(icu::Locale::getDefault(), u_width, status);
 200   if (U_FAILURE(status)) {
 201     LOG(ERROR) << "Creating MeasureFormat for "
 202                << icu::Locale::getDefault().getName()
 203                << " failed: " << u_errorName(status);
 204     return false;
 205   }
 206
 207   icu::UnicodeString formatted;
 208   icu::FieldPosition ignore(icu::FieldPosition::DONT_CARE);
 209   measure_format.formatMeasures(measures, 2, formatted, ignore, status);
 210   if (U_FAILURE(status)) {
 211     LOG(ERROR) << "formatMeasures failed: " << u_errorName(status);
 212     return false;
 213   }
 214
 215   *out = i18n::UnicodeStringToString16(formatted);
 216   return true;
 217 }
 218
 219 bool TimeDurationFormatWithSeconds(const TimeDelta time,
 220                                    const DurationFormatWidth width,
 221                                    string16* out) {
 222   DCHECK(out);
 223   UErrorCode status = U_ZERO_ERROR;
 224   const int64_t total_seconds = static_cast<int>(time.InSecondsF() + 0.5);
 225   const int hours = total_seconds / 3600;
 226   const int minutes = (total_seconds - hours * 3600) / 60;
 227   const int seconds = total_seconds % 60;
 228   UMeasureFormatWidth u_width = DurationWidthToMeasureWidth(width);
 229
 230   const icu::Measure measures[] = {
 231       icu::Measure(hours, icu::MeasureUnit::createHour(status), status),
 232       icu::Measure(minutes, icu::MeasureUnit::createMinute(status), status),
 233       icu::Measure(seconds, icu::MeasureUnit::createSecond(status), status)};
 234   icu::MeasureFormat measure_format(icu::Locale::getDefault(), u_width, status);
 235   icu::UnicodeString formatted;
 236   icu::FieldPosition ignore(icu::FieldPosition::DONT_CARE);
 237   measure_format.formatMeasures(measures, 3, formatted, ignore, status);
 238   *out = i18n::UnicodeStringToString16(formatted);
 239   return U_SUCCESS(status) == TRUE;
 240 }
 241
 242 string16 DateIntervalFormat(const Time& begin_time,
 243                             const Time& end_time,
 244                             DateFormat format) {
 245   UErrorCode status = U_ZERO_ERROR;
 246
 247   std::unique_ptr<icu::DateIntervalFormat> formatter(
 248       icu::DateIntervalFormat::createInstance(DateFormatToString(format),
 249                                               status));
 250
 251   icu::FieldPosition pos = 0;
 252   UDate start_date = static_cast<UDate>(begin_time.ToDoubleT() * 1000);
 253   UDate end_date = static_cast<UDate>(end_time.ToDoubleT() * 1000);
 254   icu::DateInterval interval(start_date, end_date);
 255   icu::UnicodeString formatted;
 256   formatter->format(&interval, formatted, pos, status);
 257   return i18n::UnicodeStringToString16(formatted);
 258 }
 259
 260 HourClockType GetHourClockType() {
 261   // TODO(satorux,jshin): Rework this with ures_getByKeyWithFallback()
 262   // once it becomes public. The short time format can be found at
 263   // "calendar/gregorian/DateTimePatterns/3" in the resources.
 264   std::unique_ptr<icu::SimpleDateFormat> formatter(
 265       static_cast<icu::SimpleDateFormat*>(
 266           icu::DateFormat::createTimeInstance(icu::DateFormat::kShort)));
 267   // Retrieve the short time format.
 268   icu::UnicodeString pattern_unicode;
 269   formatter->toPattern(pattern_unicode);
 270
 271   // Determine what hour clock type the current locale uses, by checking
 272   // "a" (am/pm marker) in the short time format. This is reliable as "a"
 273   // is used by all of 12-hour clock formats, but not any of 24-hour clock
 274   // formats, as shown below.
 275   //
 276   // % grep -A4 DateTimePatterns third_party/icu/source/data/locales/*.txt |
 277   //   grep -B1 -- -- |grep -v -- '--' |
 278   //   perl -nle 'print $1 if /^\S+\s+"(.*)"/' |sort -u
 279   //
 280   // H.mm
 281   // H:mm
 282   // HH.mm
 283   // HH:mm
 284   // a h:mm
 285   // ah:mm
 286   // ahh:mm
 287   // h-mm a
 288   // h:mm a
 289   // hh:mm a
 290   //
 291   // See http://userguide.icu-project.org/formatparse/datetime for details
 292   // about the date/time format syntax.
 293   return pattern_unicode.indexOf('a') == -1 ? k24HourClock : k12HourClock;
 294 }
 295
 296 }  // namespace base