blob: 3456c0bdda8b6fa2f57b751630e901c755fdb33b [file] [log] [blame]
/*
* Copyright (C) 2015 Andy VanWagoner (thetalecrafter@gmail.com)
* Copyright (C) 2016 Sukolsak Sakshuwong (sukolsak@gmail.com)
* Copyright (C) 2016-2017 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "IntlNumberFormat.h"
#if ENABLE(INTL)
#include "CatchScope.h"
#include "Error.h"
#include "IntlNumberFormatConstructor.h"
#include "IntlObject.h"
#include "JSBoundFunction.h"
#include "JSCInlines.h"
#include "ObjectConstructor.h"
namespace JSC {
const ClassInfo IntlNumberFormat::s_info = { "Object", &Base::s_info, nullptr, nullptr, CREATE_METHOD_TABLE(IntlNumberFormat) };
static const char* const relevantNumberExtensionKeys[1] = { "nu" };
void IntlNumberFormat::UNumberFormatDeleter::operator()(UNumberFormat* numberFormat) const
{
if (numberFormat)
unum_close(numberFormat);
}
IntlNumberFormat* IntlNumberFormat::create(VM& vm, Structure* structure)
{
IntlNumberFormat* format = new (NotNull, allocateCell<IntlNumberFormat>(vm.heap)) IntlNumberFormat(vm, structure);
format->finishCreation(vm);
return format;
}
Structure* IntlNumberFormat::createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
{
return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
}
IntlNumberFormat::IntlNumberFormat(VM& vm, Structure* structure)
: JSDestructibleObject(vm, structure)
{
}
void IntlNumberFormat::finishCreation(VM& vm)
{
Base::finishCreation(vm);
ASSERT(inherits(vm, info()));
}
void IntlNumberFormat::destroy(JSCell* cell)
{
static_cast<IntlNumberFormat*>(cell)->IntlNumberFormat::~IntlNumberFormat();
}
void IntlNumberFormat::visitChildren(JSCell* cell, SlotVisitor& visitor)
{
IntlNumberFormat* thisObject = jsCast<IntlNumberFormat*>(cell);
ASSERT_GC_OBJECT_INHERITS(thisObject, info());
Base::visitChildren(thisObject, visitor);
visitor.append(thisObject->m_boundFormat);
}
namespace IntlNFInternal {
static Vector<String> localeData(const String& locale, size_t keyIndex)
{
// 9.1 Internal slots of Service Constructors & 11.2.3 Internal slots (ECMA-402 2.0)
ASSERT_UNUSED(keyIndex, !keyIndex); // The index of the extension key "nu" in relevantExtensionKeys is 0.
return numberingSystemsForLocale(locale);
}
}
static inline unsigned computeCurrencySortKey(const String& currency)
{
ASSERT(currency.length() == 3);
ASSERT(currency.isAllSpecialCharacters<isASCIIUpper>());
return (currency[0] << 16) + (currency[1] << 8) + currency[2];
}
static inline unsigned computeCurrencySortKey(const char* currency)
{
ASSERT(strlen(currency) == 3);
ASSERT(isAllSpecialCharacters<isASCIIUpper>(currency, 3));
return (currency[0] << 16) + (currency[1] << 8) + currency[2];
}
static unsigned extractCurrencySortKey(std::pair<const char*, unsigned>* currencyMinorUnit)
{
return computeCurrencySortKey(currencyMinorUnit->first);
}
static unsigned computeCurrencyDigits(const String& currency)
{
// 11.1.1 The abstract operation CurrencyDigits (currency)
// "If the ISO 4217 currency and funds code list contains currency as an alphabetic code,
// then return the minor unit value corresponding to the currency from the list; else return 2.
std::pair<const char*, unsigned> currencyMinorUnits[] = {
{ "BHD", 3 },
{ "BIF", 0 },
{ "BYR", 0 },
{ "CLF", 4 },
{ "CLP", 0 },
{ "DJF", 0 },
{ "GNF", 0 },
{ "IQD", 3 },
{ "ISK", 0 },
{ "JOD", 3 },
{ "JPY", 0 },
{ "KMF", 0 },
{ "KRW", 0 },
{ "KWD", 3 },
{ "LYD", 3 },
{ "OMR", 3 },
{ "PYG", 0 },
{ "RWF", 0 },
{ "TND", 3 },
{ "UGX", 0 },
{ "UYI", 0 },
{ "VND", 0 },
{ "VUV", 0 },
{ "XAF", 0 },
{ "XOF", 0 },
{ "XPF", 0 }
};
auto* currencyMinorUnit = tryBinarySearch<std::pair<const char*, unsigned>>(currencyMinorUnits, WTF_ARRAY_LENGTH(currencyMinorUnits), computeCurrencySortKey(currency), extractCurrencySortKey);
if (currencyMinorUnit)
return currencyMinorUnit->second;
return 2;
}
void IntlNumberFormat::initializeNumberFormat(ExecState& state, JSValue locales, JSValue optionsValue)
{
// 11.1.1 InitializeNumberFormat (numberFormat, locales, options) (ECMA-402 2.0)
VM& vm = state.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
// 1. If numberFormat has an [[initializedIntlObject]] internal slot with value true, throw a TypeError exception.
// 2. Set numberFormat.[[initializedIntlObject]] to true.
// 3. Let requestedLocales be CanonicalizeLocaleList(locales).
auto requestedLocales = canonicalizeLocaleList(state, locales);
// 4. ReturnIfAbrupt(requestedLocales).
RETURN_IF_EXCEPTION(scope, void());
// 5. If options is undefined, then
JSObject* options;
if (optionsValue.isUndefined()) {
// a. Let options be ObjectCreate(%ObjectPrototype%).
options = constructEmptyObject(&state);
} else { // 6. Else
// a. Let options be ToObject(options).
options = optionsValue.toObject(&state);
// b. ReturnIfAbrupt(options).
RETURN_IF_EXCEPTION(scope, void());
}
// 7. Let opt be a new Record.
HashMap<String, String> opt;
// 8. Let matcher be GetOption(options, "localeMatcher", "string", «"lookup", "best fit"», "best fit").
String matcher = intlStringOption(state, options, vm.propertyNames->localeMatcher, { "lookup", "best fit" }, "localeMatcher must be either \"lookup\" or \"best fit\"", "best fit");
// 9. ReturnIfAbrupt(matcher).
RETURN_IF_EXCEPTION(scope, void());
// 10. Set opt.[[localeMatcher]] to matcher.
opt.add(ASCIILiteral("localeMatcher"), matcher);
// 11. Let localeData be %NumberFormat%.[[localeData]].
// 12. Let r be ResolveLocale(%NumberFormat%.[[availableLocales]], requestedLocales, opt, %NumberFormat%.[[relevantExtensionKeys]], localeData).
auto& availableLocales = state.jsCallee()->globalObject()->intlNumberFormatAvailableLocales();
auto result = resolveLocale(state, availableLocales, requestedLocales, opt, relevantNumberExtensionKeys, WTF_ARRAY_LENGTH(relevantNumberExtensionKeys), IntlNFInternal::localeData);
// 13. Set numberFormat.[[locale]] to the value of r.[[locale]].
m_locale = result.get(ASCIILiteral("locale"));
if (m_locale.isEmpty()) {
throwTypeError(&state, scope, ASCIILiteral("failed to initialize NumberFormat due to invalid locale"));
return;
}
// 14. Set numberFormat.[[numberingSystem]] to the value of r.[[nu]].
m_numberingSystem = result.get(ASCIILiteral("nu"));
// 15. Let dataLocale be r.[[dataLocale]].
// 16. Let s be GetOption(options, "style", "string", « "decimal", "percent", "currency"», "decimal").
String styleString = intlStringOption(state, options, Identifier::fromString(&vm, "style"), { "decimal", "percent", "currency" }, "style must be either \"decimal\", \"percent\", or \"currency\"", "decimal");
// 17. ReturnIfAbrupt(s).
RETURN_IF_EXCEPTION(scope, void());
// 18. Set numberFormat.[[style]] to s.
if (styleString == "decimal")
m_style = Style::Decimal;
else if (styleString == "percent")
m_style = Style::Percent;
else if (styleString == "currency")
m_style = Style::Currency;
else
ASSERT_NOT_REACHED();
// 19. Let c be GetOption(options, "currency", "string", undefined, undefined).
String currency = intlStringOption(state, options, Identifier::fromString(&vm, "currency"), { }, nullptr, nullptr);
// 20. ReturnIfAbrupt(c).
RETURN_IF_EXCEPTION(scope, void());
// 21. If c is not undefined, then
if (!currency.isNull()) {
// a. If the result of IsWellFormedCurrencyCode(c), is false, then throw a RangeError exception.
if (currency.length() != 3 || !currency.isAllSpecialCharacters<isASCIIAlpha>()) {
throwException(&state, scope, createRangeError(&state, ASCIILiteral("currency is not a well-formed currency code")));
return;
}
}
unsigned currencyDigits = 0;
if (m_style == Style::Currency) {
// 22. If s is "currency" and c is undefined, throw a TypeError exception.
if (currency.isNull()) {
throwTypeError(&state, scope, ASCIILiteral("currency must be a string"));
return;
}
// 23. If s is "currency", then
// a. Let c be converting c to upper case as specified in 6.1.
currency = currency.convertToASCIIUppercase();
// b. Set numberFormat.[[currency]] to c.
m_currency = currency;
// c. Let cDigits be CurrencyDigits(c)
currencyDigits = computeCurrencyDigits(currency);
}
// 24. Let cd be GetOption(options, "currencyDisplay", "string", «"code", "symbol", "name"», "symbol").
String currencyDisplayString = intlStringOption(state, options, Identifier::fromString(&vm, "currencyDisplay"), { "code", "symbol", "name" }, "currencyDisplay must be either \"code\", \"symbol\", or \"name\"", "symbol");
// 25. ReturnIfAbrupt(cd).
RETURN_IF_EXCEPTION(scope, void());
// 26. If s is "currency", set numberFormat.[[currencyDisplay]] to cd.
if (m_style == Style::Currency) {
if (currencyDisplayString == "code")
m_currencyDisplay = CurrencyDisplay::Code;
else if (currencyDisplayString == "symbol")
m_currencyDisplay = CurrencyDisplay::Symbol;
else if (currencyDisplayString == "name")
m_currencyDisplay = CurrencyDisplay::Name;
else
ASSERT_NOT_REACHED();
}
// 27. Let mnid be GetNumberOption(options, "minimumIntegerDigits", 1, 21, 1).
// 28. ReturnIfAbrupt(mnid).
// 29. Set numberFormat.[[minimumIntegerDigits]] to mnid.
unsigned minimumIntegerDigits = intlNumberOption(state, options, Identifier::fromString(&vm, "minimumIntegerDigits"), 1, 21, 1);
RETURN_IF_EXCEPTION(scope, void());
m_minimumIntegerDigits = minimumIntegerDigits;
// 30. If s is "currency", let mnfdDefault be cDigits; else let mnfdDefault be 0.
unsigned minimumFractionDigitsDefault = (m_style == Style::Currency) ? currencyDigits : 0;
// 31. Let mnfd be GetNumberOption(options, "minimumFractionDigits", 0, 20, mnfdDefault).
// 32. ReturnIfAbrupt(mnfd).
// 33. Set numberFormat.[[minimumFractionDigits]] to mnfd.
unsigned minimumFractionDigits = intlNumberOption(state, options, Identifier::fromString(&vm, "minimumFractionDigits"), 0, 20, minimumFractionDigitsDefault);
RETURN_IF_EXCEPTION(scope, void());
m_minimumFractionDigits = minimumFractionDigits;
// 34. If s is "currency", let mxfdDefault be max(mnfd, cDigits);
unsigned maximumFractionDigitsDefault;
if (m_style == Style::Currency)
maximumFractionDigitsDefault = std::max(minimumFractionDigits, currencyDigits);
else if (m_style == Style::Percent) // else if s is "percent", let mxfdDefault be max(mnfd, 0);
maximumFractionDigitsDefault = minimumFractionDigits;
else // else let mxfdDefault be max(mnfd, 3).
maximumFractionDigitsDefault = std::max(minimumFractionDigits, 3u);
// 35. Let mxfd be GetNumberOption(options, "maximumFractionDigits", mnfd, 20, mxfdDefault).
// 36. ReturnIfAbrupt(mxfd).
// 37. Set numberFormat.[[maximumFractionDigits]] to mxfd.
unsigned maximumFractionDigits = intlNumberOption(state, options, Identifier::fromString(&vm, "maximumFractionDigits"), minimumFractionDigits, 20, maximumFractionDigitsDefault);
RETURN_IF_EXCEPTION(scope, void());
m_maximumFractionDigits = maximumFractionDigits;
// 38. Let mnsd be Get(options, "minimumSignificantDigits").
JSValue minimumSignificantDigitsValue = options->get(&state, Identifier::fromString(&vm, "minimumSignificantDigits"));
// 39. ReturnIfAbrupt(mnsd).
RETURN_IF_EXCEPTION(scope, void());
// 40. Let mxsd be Get(options, "maximumSignificantDigits").
JSValue maximumSignificantDigitsValue = options->get(&state, Identifier::fromString(&vm, "maximumSignificantDigits"));
// 41. ReturnIfAbrupt(mxsd).
RETURN_IF_EXCEPTION(scope, void());
// 42. If mnsd is not undefined or mxsd is not undefined, then
if (!minimumSignificantDigitsValue.isUndefined() || !maximumSignificantDigitsValue.isUndefined()) {
// a. Let mnsd be GetNumberOption(options, "minimumSignificantDigits", 1, 21, 1).
unsigned minimumSignificantDigits = intlNumberOption(state, options, Identifier::fromString(&vm, "minimumSignificantDigits"), 1, 21, 1);
// b. ReturnIfAbrupt(mnsd).
RETURN_IF_EXCEPTION(scope, void());
// c. Let mxsd be GetNumberOption(options, "maximumSignificantDigits", mnsd, 21, 21).
unsigned maximumSignificantDigits = intlNumberOption(state, options, Identifier::fromString(&vm, "maximumSignificantDigits"), minimumSignificantDigits, 21, 21);
// d. ReturnIfAbrupt(mxsd).
RETURN_IF_EXCEPTION(scope, void());
// e. Set numberFormat.[[minimumSignificantDigits]] to mnsd.
m_minimumSignificantDigits = minimumSignificantDigits;
// f. Set numberFormat.[[maximumSignificantDigits]] to mxsd.
m_maximumSignificantDigits = maximumSignificantDigits;
}
// 43. Let g be GetOption(options, "useGrouping", "boolean", undefined, true).
bool usesFallback;
bool useGrouping = intlBooleanOption(state, options, Identifier::fromString(&vm, "useGrouping"), usesFallback);
if (usesFallback)
useGrouping = true;
// 44. ReturnIfAbrupt(g).
RETURN_IF_EXCEPTION(scope, void());
// 45. Set numberFormat.[[useGrouping]] to g.
m_useGrouping = useGrouping;
// Steps 46 - 51 are not necessary to our implementation.
// 46. Let dataLocaleData be Get(localeData, dataLocale).
// 47. Let patterns be Get(dataLocaleData, "patterns").
// 48. Assert: patterns is an object (see 11.2.3).
// 49. Let stylePatterns be Get(patterns, s).
// 50. Set numberFormat.[[positivePattern]] to Get(stylePatterns, "positivePattern").
// 51. Set numberFormat.[[negativePattern]] to Get(stylePatterns, "negativePattern").
// 52. Set numberFormat.[[boundFormat]] to undefined.
// 53. Set numberFormat.[[initializedNumberFormat]] to true.
m_initializedNumberFormat = true;
// 54. Return numberFormat.
}
void IntlNumberFormat::createNumberFormat(ExecState& state)
{
VM& vm = state.vm();
auto scope = DECLARE_CATCH_SCOPE(vm);
ASSERT(!m_numberFormat);
if (!m_initializedNumberFormat) {
initializeNumberFormat(state, jsUndefined(), jsUndefined());
scope.assertNoException();
}
UNumberFormatStyle style = UNUM_DEFAULT;
switch (m_style) {
case Style::Decimal:
style = UNUM_DECIMAL;
break;
case Style::Percent:
style = UNUM_PERCENT;
break;
case Style::Currency:
switch (m_currencyDisplay) {
case CurrencyDisplay::Code:
style = UNUM_CURRENCY_ISO;
break;
case CurrencyDisplay::Symbol:
style = UNUM_CURRENCY;
break;
case CurrencyDisplay::Name:
style = UNUM_CURRENCY_PLURAL;
break;
default:
ASSERT_NOT_REACHED();
}
break;
default:
ASSERT_NOT_REACHED();
}
UErrorCode status = U_ZERO_ERROR;
auto numberFormat = std::unique_ptr<UNumberFormat, UNumberFormatDeleter>(unum_open(style, nullptr, 0, m_locale.utf8().data(), nullptr, &status));
if (U_FAILURE(status))
return;
if (m_style == Style::Currency)
unum_setTextAttribute(numberFormat.get(), UNUM_CURRENCY_CODE, StringView(m_currency).upconvertedCharacters(), 3, &status);
if (!m_minimumSignificantDigits) {
unum_setAttribute(numberFormat.get(), UNUM_MIN_INTEGER_DIGITS, m_minimumIntegerDigits);
unum_setAttribute(numberFormat.get(), UNUM_MIN_FRACTION_DIGITS, m_minimumFractionDigits);
unum_setAttribute(numberFormat.get(), UNUM_MAX_FRACTION_DIGITS, m_maximumFractionDigits);
} else {
unum_setAttribute(numberFormat.get(), UNUM_SIGNIFICANT_DIGITS_USED, true);
unum_setAttribute(numberFormat.get(), UNUM_MIN_SIGNIFICANT_DIGITS, m_minimumSignificantDigits);
unum_setAttribute(numberFormat.get(), UNUM_MAX_SIGNIFICANT_DIGITS, m_maximumSignificantDigits);
}
unum_setAttribute(numberFormat.get(), UNUM_GROUPING_USED, m_useGrouping);
unum_setAttribute(numberFormat.get(), UNUM_ROUNDING_MODE, UNUM_ROUND_HALFUP);
if (U_FAILURE(status))
return;
m_numberFormat = WTFMove(numberFormat);
}
JSValue IntlNumberFormat::formatNumber(ExecState& state, double number)
{
VM& vm = state.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
// 11.3.4 FormatNumber abstract operation (ECMA-402 2.0)
if (!m_numberFormat) {
createNumberFormat(state);
if (!m_numberFormat)
return throwException(&state, scope, createError(&state, ASCIILiteral("Failed to format a number.")));
}
// Map negative zero to positive zero.
if (!number)
number = 0.0;
UErrorCode status = U_ZERO_ERROR;
Vector<UChar, 32> buffer(32);
auto length = unum_formatDouble(m_numberFormat.get(), number, buffer.data(), buffer.size(), nullptr, &status);
if (status == U_BUFFER_OVERFLOW_ERROR) {
buffer.grow(length);
status = U_ZERO_ERROR;
unum_formatDouble(m_numberFormat.get(), number, buffer.data(), length, nullptr, &status);
}
if (U_FAILURE(status))
return throwException(&state, scope, createError(&state, ASCIILiteral("Failed to format a number.")));
return jsString(&state, String(buffer.data(), length));
}
const char* IntlNumberFormat::styleString(Style style)
{
switch (style) {
case Style::Decimal:
return "decimal";
case Style::Percent:
return "percent";
case Style::Currency:
return "currency";
}
ASSERT_NOT_REACHED();
return nullptr;
}
const char* IntlNumberFormat::currencyDisplayString(CurrencyDisplay currencyDisplay)
{
switch (currencyDisplay) {
case CurrencyDisplay::Code:
return "code";
case CurrencyDisplay::Symbol:
return "symbol";
case CurrencyDisplay::Name:
return "name";
}
ASSERT_NOT_REACHED();
return nullptr;
}
JSObject* IntlNumberFormat::resolvedOptions(ExecState& state)
{
VM& vm = state.vm();
auto scope = DECLARE_THROW_SCOPE(vm);
// 11.3.5 Intl.NumberFormat.prototype.resolvedOptions() (ECMA-402 2.0)
// The function returns a new object whose properties and attributes are set as if
// constructed by an object literal assigning to each of the following properties the
// value of the corresponding internal slot of this NumberFormat object (see 11.4):
// locale, numberingSystem, style, currency, currencyDisplay, minimumIntegerDigits,
// minimumFractionDigits, maximumFractionDigits, minimumSignificantDigits,
// maximumSignificantDigits, and useGrouping. Properties whose corresponding internal
// slots are not present are not assigned.
if (!m_initializedNumberFormat) {
initializeNumberFormat(state, jsUndefined(), jsUndefined());
scope.assertNoException();
}
JSObject* options = constructEmptyObject(&state);
options->putDirect(vm, vm.propertyNames->locale, jsString(&state, m_locale));
options->putDirect(vm, Identifier::fromString(&vm, "numberingSystem"), jsString(&state, m_numberingSystem));
options->putDirect(vm, Identifier::fromString(&vm, "style"), jsNontrivialString(&state, ASCIILiteral(styleString(m_style))));
if (m_style == Style::Currency) {
options->putDirect(vm, Identifier::fromString(&vm, "currency"), jsNontrivialString(&state, m_currency));
options->putDirect(vm, Identifier::fromString(&vm, "currencyDisplay"), jsNontrivialString(&state, ASCIILiteral(currencyDisplayString(m_currencyDisplay))));
}
options->putDirect(vm, Identifier::fromString(&vm, "minimumIntegerDigits"), jsNumber(m_minimumIntegerDigits));
options->putDirect(vm, Identifier::fromString(&vm, "minimumFractionDigits"), jsNumber(m_minimumFractionDigits));
options->putDirect(vm, Identifier::fromString(&vm, "maximumFractionDigits"), jsNumber(m_maximumFractionDigits));
if (m_minimumSignificantDigits) {
ASSERT(m_maximumSignificantDigits);
options->putDirect(vm, Identifier::fromString(&vm, "minimumSignificantDigits"), jsNumber(m_minimumSignificantDigits));
options->putDirect(vm, Identifier::fromString(&vm, "maximumSignificantDigits"), jsNumber(m_maximumSignificantDigits));
}
options->putDirect(vm, Identifier::fromString(&vm, "useGrouping"), jsBoolean(m_useGrouping));
return options;
}
void IntlNumberFormat::setBoundFormat(VM& vm, JSBoundFunction* format)
{
m_boundFormat.set(vm, this, format);
}
} // namespace JSC
#endif // ENABLE(INTL)