[intl] Implement Intl.PluralRules

src/i18n.cc

 // Copyright 2013 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 // limitations under the License.
 
 #include "src/i18n.h"
 
 #include <memory>
 
 #include "src/api.h"
 #include "src/factory.h"
 #include "src/isolate.h"
 #include "src/objects-inl.h"
+#include "src/property-descriptor.h"
 #include "unicode/brkiter.h"
 #include "unicode/calendar.h"
 #include "unicode/coll.h"
 #include "unicode/curramt.h"
 #include "unicode/dcfmtsym.h"
 #include "unicode/decimfmt.h"
 #include "unicode/dtfmtsym.h"
 #include "unicode/dtptngen.h"
 #include "unicode/gregocal.h"
 #include "unicode/locid.h"
 #include "unicode/numfmt.h"
 #include "unicode/numsys.h"
+#include "unicode/plurrule.h"
 #include "unicode/rbbi.h"
 #include "unicode/smpdtfmt.h"
 #include "unicode/timezone.h"
 #include "unicode/uchar.h"
 #include "unicode/ucol.h"
 #include "unicode/ucurr.h"
 #include "unicode/unum.h"
+#include "unicode/upluralrules.h"
 #include "unicode/uversion.h"
 
 namespace v8 {
 namespace internal {
 
 namespace {
 
 bool ExtractStringSetting(Isolate* isolate,
                           Handle<JSObject> options,
                           const char* key,
@@ skipping 174 matching lines @@
                           factory->NewStringFromAsciiChecked(result),
                           SLOPPY).Assert();
   } else {
     // This would never happen, since we got the locale from ICU.
     JSObject::SetProperty(resolved, factory->NewStringFromStaticChars("locale"),
                           factory->NewStringFromStaticChars("und"),
                           SLOPPY).Assert();
   }
 }
 
+void SetNumericSettings(Isolate* isolate, icu::DecimalFormat* number_format,
+                        Handle<JSObject> options) {
+  int32_t digits;
+  if (ExtractIntegerSetting(isolate, options, "minimumIntegerDigits",
+                            &digits)) {
+    number_format->setMinimumIntegerDigits(digits);
+  }
+
+  if (ExtractIntegerSetting(isolate, options, "minimumFractionDigits",
+                            &digits)) {
+    number_format->setMinimumFractionDigits(digits);
+  }
+
+  if (ExtractIntegerSetting(isolate, options, "maximumFractionDigits",
+                            &digits)) {
+    number_format->setMaximumFractionDigits(digits);
+  }
+
+  bool significant_digits_used = false;
+  if (ExtractIntegerSetting(isolate, options, "minimumSignificantDigits",
+                            &digits)) {
+    number_format->setMinimumSignificantDigits(digits);
+    significant_digits_used = true;
+  }
+
+  if (ExtractIntegerSetting(isolate, options, "maximumSignificantDigits",
+                            &digits)) {
+    number_format->setMaximumSignificantDigits(digits);
+    significant_digits_used = true;
+  }
+
+  number_format->setSignificantDigitsUsed(significant_digits_used);
+
+  number_format->setRoundingMode(icu::DecimalFormat::kRoundHalfUp);
+}
 
 icu::DecimalFormat* CreateICUNumberFormat(
     Isolate* isolate,
     const icu::Locale& icu_locale,
     Handle<JSObject> options) {
   // Make formatter from options. Numbering system is added
   // to the locale as Unicode extension (if it was specified at all).
   UErrorCode status = U_ZERO_ERROR;
   icu::DecimalFormat* number_format = NULL;
   icu::UnicodeString style;
@@ skipping 50 matching lines @@
   if (U_FAILURE(status)) {
     delete number_format;
     return NULL;
   }
 
   // Set all options.
   if (!currency.isEmpty()) {
     number_format->setCurrency(currency.getBuffer(), status);
   }
 
-  int32_t digits;
-  if (ExtractIntegerSetting(
-          isolate, options, "minimumIntegerDigits", &digits)) {
-    number_format->setMinimumIntegerDigits(digits);
-  }
-
-  if (ExtractIntegerSetting(
-          isolate, options, "minimumFractionDigits", &digits)) {
-    number_format->setMinimumFractionDigits(digits);
-  }
-
-  if (ExtractIntegerSetting(
-          isolate, options, "maximumFractionDigits", &digits)) {
-    number_format->setMaximumFractionDigits(digits);
-  }
-
-  bool significant_digits_used = false;
-  if (ExtractIntegerSetting(
-          isolate, options, "minimumSignificantDigits", &digits)) {
-    number_format->setMinimumSignificantDigits(digits);
-    significant_digits_used = true;
-  }
-
-  if (ExtractIntegerSetting(
-          isolate, options, "maximumSignificantDigits", &digits)) {
-    number_format->setMaximumSignificantDigits(digits);
-    significant_digits_used = true;
-  }
-
-  number_format->setSignificantDigitsUsed(significant_digits_used);
+  SetNumericSettings(isolate, number_format, options);
 
   bool grouping;
   if (ExtractBooleanSetting(isolate, options, "useGrouping", &grouping)) {
     number_format->setGroupingUsed(grouping);
   }
 
-  // Set rounding mode.
-  number_format->setRoundingMode(icu::DecimalFormat::kRoundHalfUp);
-
   return number_format;
 }
 
+void SetResolvedNumericSettings(Isolate* isolate, const icu::Locale& icu_locale,
+                                icu::DecimalFormat* number_format,
+                                Handle<JSObject> resolved) {
+  Factory* factory = isolate->factory();
 
+  JSObject::SetProperty(
+      resolved, factory->NewStringFromStaticChars("minimumIntegerDigits"),
+      factory->NewNumberFromInt(number_format->getMinimumIntegerDigits()),
+      SLOPPY)
+      .Assert();
+
+  JSObject::SetProperty(
+      resolved, factory->NewStringFromStaticChars("minimumFractionDigits"),
+      factory->NewNumberFromInt(number_format->getMinimumFractionDigits()),
+      SLOPPY)
+      .Assert();
+
+  JSObject::SetProperty(
+      resolved, factory->NewStringFromStaticChars("maximumFractionDigits"),
+      factory->NewNumberFromInt(number_format->getMaximumFractionDigits()),
+      SLOPPY)
+      .Assert();
+
+  Handle<String> key =
+      factory->NewStringFromStaticChars("minimumSignificantDigits");
+  Maybe<bool> maybe = JSReceiver::HasOwnProperty(resolved, key);
+  CHECK(maybe.IsJust());
+  if (maybe.FromJust()) {
+    JSObject::SetProperty(
+        resolved, factory->NewStringFromStaticChars("minimumSignificantDigits"),
+        factory->NewNumberFromInt(number_format->getMinimumSignificantDigits()),
+        SLOPPY)
+        .Assert();
+  }
+
+  key = factory->NewStringFromStaticChars("maximumSignificantDigits");
+  maybe = JSReceiver::HasOwnProperty(resolved, key);
+  CHECK(maybe.IsJust());
+  if (maybe.FromJust()) {
+    JSObject::SetProperty(
+        resolved, factory->NewStringFromStaticChars("maximumSignificantDigits"),
+        factory->NewNumberFromInt(number_format->getMaximumSignificantDigits()),
+        SLOPPY)
+        .Assert();
+  }
+
+  // Set the locale
+  char result[ULOC_FULLNAME_CAPACITY];
+  UErrorCode status = U_ZERO_ERROR;
+  uloc_toLanguageTag(icu_locale.getName(), result, ULOC_FULLNAME_CAPACITY,
+                     FALSE, &status);
+  if (U_SUCCESS(status)) {
+    JSObject::SetProperty(resolved, factory->NewStringFromStaticChars("locale"),
+                          factory->NewStringFromAsciiChecked(result), SLOPPY)
+        .Assert();
+  } else {
+    // This would never happen, since we got the locale from ICU.
+    JSObject::SetProperty(resolved, factory->NewStringFromStaticChars("locale"),
+                          factory->NewStringFromStaticChars("und"), SLOPPY)
+        .Assert();
+  }
+}
+
+
 void SetResolvedNumberSettings(Isolate* isolate,
                                const icu::Locale& icu_locale,
                                icu::DecimalFormat* number_format,
                                Handle<JSObject> resolved) {
   Factory* factory = isolate->factory();
-  icu::UnicodeString pattern;
-  number_format->toPattern(pattern);
-  JSObject::SetProperty(
-      resolved, factory->intl_pattern_symbol(),
-      factory->NewStringFromTwoByte(
-                   Vector<const uint16_t>(
-                       reinterpret_cast<const uint16_t*>(pattern.getBuffer()),
-                       pattern.length())).ToHandleChecked(),
-      SLOPPY).Assert();
 
   // Set resolved currency code in options.currency if not empty.
   icu::UnicodeString currency(number_format->getCurrency());
   if (!currency.isEmpty()) {
     JSObject::SetProperty(
         resolved, factory->NewStringFromStaticChars("currency"),
         factory->NewStringFromTwoByte(Vector<const uint16_t>(
                                           reinterpret_cast<const uint16_t*>(
                                               currency.getBuffer()),
                                           currency.length())).ToHandleChecked(),
@@ skipping 15 matching lines @@
     JSObject::SetProperty(resolved,
                           factory->NewStringFromStaticChars("numberingSystem"),
                           factory->undefined_value(), SLOPPY).Assert();
   }
   delete numbering_system;
 
   JSObject::SetProperty(
       resolved, factory->NewStringFromStaticChars("useGrouping"),
       factory->ToBoolean(number_format->isGroupingUsed()), SLOPPY).Assert();
 
-  JSObject::SetProperty(
-      resolved, factory->NewStringFromStaticChars("minimumIntegerDigits"),
-      factory->NewNumberFromInt(number_format->getMinimumIntegerDigits()),
-      SLOPPY).Assert();
-
-  JSObject::SetProperty(
-      resolved, factory->NewStringFromStaticChars("minimumFractionDigits"),
-      factory->NewNumberFromInt(number_format->getMinimumFractionDigits()),
-      SLOPPY).Assert();
-
-  JSObject::SetProperty(
-      resolved, factory->NewStringFromStaticChars("maximumFractionDigits"),
-      factory->NewNumberFromInt(number_format->getMaximumFractionDigits()),
-      SLOPPY).Assert();
-
-  Handle<String> key =
-      factory->NewStringFromStaticChars("minimumSignificantDigits");
-  Maybe<bool> maybe = JSReceiver::HasOwnProperty(resolved, key);
-  CHECK(maybe.IsJust());
-  if (maybe.FromJust()) {
-    JSObject::SetProperty(
-        resolved, factory->NewStringFromStaticChars("minimumSignificantDigits"),
-        factory->NewNumberFromInt(number_format->getMinimumSignificantDigits()),
-        SLOPPY).Assert();
-  }
-
-  key = factory->NewStringFromStaticChars("maximumSignificantDigits");
-  maybe = JSReceiver::HasOwnProperty(resolved, key);
-  CHECK(maybe.IsJust());
-  if (maybe.FromJust()) {
-    JSObject::SetProperty(
-        resolved, factory->NewStringFromStaticChars("maximumSignificantDigits"),
-        factory->NewNumberFromInt(number_format->getMaximumSignificantDigits()),
-        SLOPPY).Assert();
-  }
-
-  // Set the locale
-  char result[ULOC_FULLNAME_CAPACITY];
-  status = U_ZERO_ERROR;
-  uloc_toLanguageTag(
-      icu_locale.getName(), result, ULOC_FULLNAME_CAPACITY, FALSE, &status);
-  if (U_SUCCESS(status)) {
-    JSObject::SetProperty(resolved, factory->NewStringFromStaticChars("locale"),
-                          factory->NewStringFromAsciiChecked(result),
-                          SLOPPY).Assert();
-  } else {
-    // This would never happen, since we got the locale from ICU.
-    JSObject::SetProperty(resolved, factory->NewStringFromStaticChars("locale"),
-                          factory->NewStringFromStaticChars("und"),
-                          SLOPPY).Assert();
-  }
+  SetResolvedNumericSettings(isolate, icu_locale, number_format, resolved);
 }
 
 
 icu::Collator* CreateICUCollator(
     Isolate* isolate,
     const icu::Locale& icu_locale,
     Handle<JSObject> options) {
   // Make collator from options.
   icu::Collator* collator = NULL;
   UErrorCode status = U_ZERO_ERROR;
@@ skipping 153 matching lines @@
                           factory->NewStringFromAsciiChecked(result),
                           SLOPPY).Assert();
   } else {
     // This would never happen, since we got the locale from ICU.
     JSObject::SetProperty(resolved, factory->NewStringFromStaticChars("locale"),
                           factory->NewStringFromStaticChars("und"),
                           SLOPPY).Assert();
   }
 }
 
+bool CreateICUPluralRules(Isolate* isolate, const icu::Locale& icu_locale,
+                          Handle<JSObject> options, icu::PluralRules** pl,
+                          icu::DecimalFormat** nf) {
+  // Make formatter from options. Numbering system is added
+  // to the locale as Unicode extension (if it was specified at all).
+  UErrorCode status = U_ZERO_ERROR;
+
+  UPluralType type = UPLURAL_TYPE_CARDINAL;
+
+  icu::UnicodeString type_string;
+  if (ExtractStringSetting(isolate, options, "type", &type_string)) {
+    if (type_string == UNICODE_STRING_SIMPLE("ordinal")) {
+      type = UPLURAL_TYPE_ORDINAL;
+    } else {
+      CHECK(type_string == UNICODE_STRING_SIMPLE("cardinal"));
+    }
+  }
+
+  icu::PluralRules* plural_rules =
+      icu::PluralRules::forLocale(icu_locale, type, status);
+
+  if (U_FAILURE(status)) {
+    delete plural_rules;
+    return false;
+  }

[jungshik at Google, 2017/05/08 19:16:54]

nit:

NumberFormat::createInstance(....) will return right away if U_FAILURE(status)
is true. So, you don't need this check here. Just one at line 652 would suffice.

+
+  icu::DecimalFormat* number_format = static_cast<icu::DecimalFormat*>(
+      icu::NumberFormat::createInstance(icu_locale, status));
+
+  if (U_FAILURE(status)) {
+    delete plural_rules;
+    delete number_format;
+    return false;
+  }
+
+  *pl = plural_rules;
+  *nf = number_format;
+
+  SetNumericSettings(isolate, number_format, options);
+
+  // Set rounding mode.
+
+  return true;
+}
+
+bool SetResolvedPluralRulesSettings(Isolate* isolate,
+                                    const icu::Locale& icu_locale,
+                                    icu::PluralRules* plural_rules,
+                                    icu::DecimalFormat* number_format,
+                                    Handle<JSObject> resolved) {
+  SetResolvedNumericSettings(isolate, icu_locale, number_format, resolved);
+
+  Factory* factory = isolate->factory();
+
+  Handle<JSObject> pluralCategories = Handle<JSObject>::cast(
+      JSObject::GetProperty(
+          resolved, factory->NewStringFromStaticChars("pluralCategories"))
+          .ToHandleChecked());
+
+  UErrorCode status = U_ZERO_ERROR;
+  std::unique_ptr<icu::StringEnumeration> categories(
+      plural_rules->getKeywords(status));
+  if (!U_SUCCESS(status)) return false;

[jungshik at Google, 2017/05/08 19:16:54]

nit: U_FAILURE(status) ? 

Again, checking at line 688 (or inside a loop at line 692) would suffice. 
If you want to know exactly where it fails, you may add
DCHECK(U_SUCCESS(status)) here. ditto for my previous comment about |status|
check. 

+
+  int32_t count = categories->count(status);
+  if (!U_SUCCESS(status)) return false;

[jungshik at Google, 2017/05/08 19:16:54]

nit: U_FAILURE(status)

+
+  for (int32_t i = 0; i < count; i++) {
+    const icu::UnicodeString* category = categories->snext(status);
+    if (!U_SUCCESS(status)) return false;
+
+    Handle<String> value =
+        factory
+            ->NewStringFromTwoByte(Vector<const uint16_t>(
+                reinterpret_cast<const uint16_t*>(category->getBuffer()),
+                category->length()))
+            .ToHandleChecked();
+    LookupIterator it(isolate, pluralCategories, i, LookupIterator::OWN);
+    JSObject::DefineOwnPropertyIgnoreAttributes(&it, value,
+                                                PropertyAttributes::NONE)
+        .ToHandleChecked();
+  }
+
+  return true;
+}
 
 icu::BreakIterator* CreateICUBreakIterator(
     Isolate* isolate,
     const icu::Locale& icu_locale,
     Handle<JSObject> options) {
   UErrorCode status = U_ZERO_ERROR;
   icu::BreakIterator* break_iterator = NULL;
   icu::UnicodeString type;
   if (!ExtractStringSetting(isolate, options, "type", &type)) return NULL;
 
@@ skipping 204 matching lines @@
 icu::Collator* Collator::UnpackCollator(Isolate* isolate,
                                         Handle<JSObject> obj) {
   return reinterpret_cast<icu::Collator*>(obj->GetInternalField(0));
 }
 
 void Collator::DeleteCollator(const v8::WeakCallbackInfo<void>& data) {
   delete reinterpret_cast<icu::Collator*>(data.GetInternalField(0));
   GlobalHandles::Destroy(reinterpret_cast<Object**>(data.GetParameter()));
 }
 
+bool PluralRules::InitializePluralRules(Isolate* isolate, Handle<String> locale,
+                                        Handle<JSObject> options,
+                                        Handle<JSObject> resolved,
+                                        icu::PluralRules** plural_rules,
+                                        icu::DecimalFormat** number_format) {
+  // Convert BCP47 into ICU locale format.

[jungshik at Google, 2017/05/08 19:16:54]

Need to refactor (may be in another CL if you want to). There are a few more
places with this exact (or almost identical) code.  

+  UErrorCode status = U_ZERO_ERROR;
+  icu::Locale icu_locale;
+  char icu_result[ULOC_FULLNAME_CAPACITY];
+  int icu_length = 0;
+  v8::String::Utf8Value bcp47_locale(v8::Utils::ToLocal(locale));
+  if (bcp47_locale.length() != 0) {
+    uloc_forLanguageTag(*bcp47_locale, icu_result, ULOC_FULLNAME_CAPACITY,
+                        &icu_length, &status);
+    if (U_FAILURE(status) || icu_length == 0) {
+      return false;
+    }
+    icu_locale = icu::Locale(icu_result);
+  }
+
+  bool success = CreateICUPluralRules(isolate, icu_locale, options,
+                                      plural_rules, number_format);
+  if (!success) {
+    // Remove extensions and try again.
+    icu::Locale no_extension_locale(icu_locale.getBaseName());
+    success = CreateICUPluralRules(isolate, no_extension_locale, options,
+                                   plural_rules, number_format);
+
+    if (!success) {
+      FATAL("Failed to create ICU PluralRules, are ICU data files missing?");
+    }
+
+    // Set resolved settings (pattern, numbering system).
+    success = SetResolvedPluralRulesSettings(
+        isolate, no_extension_locale, *plural_rules, *number_format, resolved);
+  } else {
+    success = SetResolvedPluralRulesSettings(isolate, icu_locale, *plural_rules,
+                                             *number_format, resolved);
+  }
+
+  return success;
+}
+
+icu::PluralRules* PluralRules::UnpackPluralRules(Isolate* isolate,
+                                                 Handle<JSObject> obj) {
+  return reinterpret_cast<icu::PluralRules*>(obj->GetInternalField(0));
+}
+
+icu::DecimalFormat* PluralRules::UnpackNumberFormat(Isolate* isolate,
+                                                    Handle<JSObject> obj) {
+  return reinterpret_cast<icu::DecimalFormat*>(obj->GetInternalField(1));
+}
+
+void PluralRules::DeletePluralRules(const v8::WeakCallbackInfo<void>& data) {
+  delete reinterpret_cast<icu::PluralRules*>(data.GetInternalField(0));
+  delete reinterpret_cast<icu::DecimalFormat*>(data.GetInternalField(1));
+  GlobalHandles::Destroy(reinterpret_cast<Object**>(data.GetParameter()));
+}
+
 icu::BreakIterator* V8BreakIterator::InitializeBreakIterator(
     Isolate* isolate, Handle<String> locale, Handle<JSObject> options,
     Handle<JSObject> resolved) {
   // Convert BCP47 into ICU locale format.
   UErrorCode status = U_ZERO_ERROR;
   icu::Locale icu_locale;
   char icu_result[ULOC_FULLNAME_CAPACITY];
   int icu_length = 0;
   v8::String::Utf8Value bcp47_locale(v8::Utils::ToLocal(locale));
   if (bcp47_locale.length() != 0) {
@@ skipping 35 matching lines @@
 
 void V8BreakIterator::DeleteBreakIterator(
     const v8::WeakCallbackInfo<void>& data) {
   delete reinterpret_cast<icu::BreakIterator*>(data.GetInternalField(0));
   delete reinterpret_cast<icu::UnicodeString*>(data.GetInternalField(1));
   GlobalHandles::Destroy(reinterpret_cast<Object**>(data.GetParameter()));
 }
 
 }  // namespace internal
 }  // namespace v8