blob: c5f89b7f44bbf6a5ba845364a925b166d3b1f5d7 [file] [log] [blame]
/*
* Copyright (C) 2020 Sony Interactive Entertainment Inc.
* Copyright (C) 2021 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 "IntlLocale.h"
#include "IntlObjectInlines.h"
#include "JSCInlines.h"
#include <unicode/uloc.h>
#include <wtf/unicode/icu/ICUHelpers.h>
namespace JSC {
const ClassInfo IntlLocale::s_info = { "Object", &Base::s_info, nullptr, nullptr, CREATE_METHOD_TABLE(IntlLocale) };
IntlLocale* IntlLocale::create(VM& vm, Structure* structure)
{
auto* object = new (NotNull, allocateCell<IntlLocale>(vm.heap)) IntlLocale(vm, structure);
object->finishCreation(vm);
return object;
}
Structure* IntlLocale::createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
{
return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
}
IntlLocale::IntlLocale(VM& vm, Structure* structure)
: Base(vm, structure)
{
}
void IntlLocale::finishCreation(VM& vm)
{
Base::finishCreation(vm);
ASSERT(inherits(vm, info()));
}
template<typename Visitor>
void IntlLocale::visitChildrenImpl(JSCell* cell, Visitor& visitor)
{
auto* thisObject = jsCast<IntlLocale*>(cell);
ASSERT_GC_OBJECT_INHERITS(thisObject, info());
Base::visitChildren(thisObject, visitor);
}
DEFINE_VISIT_CHILDREN(IntlLocale);
class LocaleIDBuilder final {
public:
bool initialize(const String&);
CString toCanonical();
void overrideLanguageScriptRegion(StringView language, StringView script, StringView region);
void setKeywordValue(ASCIILiteral key, StringView value);
private:
Vector<char, 32> m_buffer;
};
bool LocaleIDBuilder::initialize(const String& tag)
{
if (!isStructurallyValidLanguageTag(tag))
return false;
ASSERT(tag.isAllASCII());
m_buffer = localeIDBufferForLanguageTag(tag.ascii());
return m_buffer.size();
}
CString LocaleIDBuilder::toCanonical()
{
ASSERT(m_buffer.size());
Vector<char, 32> buffer;
auto status = callBufferProducingFunction(uloc_canonicalize, m_buffer.data(), buffer);
if (U_FAILURE(status))
return CString();
auto result = canonicalizeUnicodeExtensionsAfterICULocaleCanonicalization(WTFMove(buffer));
return CString(result.data(), result.size());
}
// Because ICU's C API doesn't have set[Language|Script|Region] functions...
void LocaleIDBuilder::overrideLanguageScriptRegion(StringView language, StringView script, StringView region)
{
unsigned length = strlen(m_buffer.data());
ASSERT(length);
StringView localeIDView { m_buffer.data(), length };
auto endOfLanguageScriptRegionVariant = localeIDView.find(ULOC_KEYWORD_SEPARATOR);
if (endOfLanguageScriptRegionVariant == notFound)
endOfLanguageScriptRegionVariant = length;
Vector<StringView> subtags;
for (auto subtag : localeIDView.left(endOfLanguageScriptRegionVariant).splitAllowingEmptyEntries('_'))
subtags.append(subtag);
if (!language.isNull())
subtags[0] = language;
bool hasScript = subtags.size() > 1 && subtags[1].length() == 4;
if (!script.isNull()) {
if (hasScript)
subtags[1] = script;
else {
subtags.insert(1, script);
hasScript = true;
}
}
if (!region.isNull()) {
size_t index = hasScript ? 2 : 1;
bool hasRegion = subtags.size() > index && subtags[index].length() < 4;
if (hasRegion)
subtags[index] = region;
else
subtags.insert(index, region);
}
Vector<char, 32> buffer;
bool hasAppended = false;
for (auto subtag : subtags) {
if (hasAppended)
buffer.append('_');
else
hasAppended = true;
ASSERT(subtag.is8Bit() && subtag.isAllASCII());
buffer.append(reinterpret_cast<const char*>(subtag.characters8()), subtag.length());
}
if (endOfLanguageScriptRegionVariant != length) {
auto rest = localeIDView.right(length - endOfLanguageScriptRegionVariant);
ASSERT(rest.is8Bit() && rest.isAllASCII());
buffer.append(reinterpret_cast<const char*>(rest.characters8()), rest.length());
}
buffer.append('\0');
m_buffer.swap(buffer);
}
void LocaleIDBuilder::setKeywordValue(ASCIILiteral key, StringView value)
{
ASSERT(m_buffer.size());
ASSERT(value.is8Bit() && value.isAllASCII());
CString rawValue { reinterpret_cast<const char*>(value.characters8()), value.length() };
UErrorCode status = U_ZERO_ERROR;
auto length = uloc_setKeywordValue(key.characters(), rawValue.data(), m_buffer.data(), m_buffer.size(), &status);
// uloc_setKeywordValue does not set U_STRING_NOT_TERMINATED_WARNING.
if (needsToGrowToProduceBuffer(status)) {
m_buffer.grow(length + 1);
status = U_ZERO_ERROR;
uloc_setKeywordValue(key.characters(), rawValue.data(), m_buffer.data(), length + 1, &status);
}
ASSERT(U_SUCCESS(status));
}
String IntlLocale::keywordValue(ASCIILiteral key, bool isBoolean) const
{
UErrorCode status = U_ZERO_ERROR;
Vector<char, 32> buffer(32);
auto bufferLength = uloc_getKeywordValue(m_localeID.data(), key.characters(), buffer.data(), buffer.size(), &status);
if (needsToGrowToProduceCString(status)) {
buffer.grow(bufferLength + 1);
status = U_ZERO_ERROR;
uloc_getKeywordValue(m_localeID.data(), key.characters(), buffer.data(), bufferLength + 1, &status);
}
ASSERT(U_SUCCESS(status));
if (isBoolean)
return String(buffer.data());
const char* value = uloc_toUnicodeLocaleType(key.characters(), buffer.data());
if (!value)
return nullString();
String result(value);
if (result == "true"_s)
return emptyString();
return result;
}
// https://tc39.es/ecma402/#sec-Intl.Locale
void IntlLocale::initializeLocale(JSGlobalObject* globalObject, JSValue tagValue, JSValue optionsValue)
{
VM& vm = globalObject->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
String tag = tagValue.inherits<IntlLocale>(vm) ? jsCast<IntlLocale*>(tagValue)->toString() : tagValue.toWTFString(globalObject);
RETURN_IF_EXCEPTION(scope, void());
scope.release();
initializeLocale(globalObject, tag, optionsValue);
}
// https://tc39.es/ecma402/#sec-Intl.Locale
void IntlLocale::initializeLocale(JSGlobalObject* globalObject, const String& tag, JSValue optionsValue)
{
VM& vm = globalObject->vm();
auto scope = DECLARE_THROW_SCOPE(vm);
Optional<JSObject&> options = intlCoerceOptionsToObject(globalObject, optionsValue);
RETURN_IF_EXCEPTION(scope, void());
LocaleIDBuilder localeID;
if (!localeID.initialize(tag)) {
throwRangeError(globalObject, scope, "invalid language tag"_s);
return;
}
String language = intlStringOption(globalObject, options, vm.propertyNames->language, { }, nullptr, nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!language.isNull() && !isUnicodeLanguageSubtag(language)) {
throwRangeError(globalObject, scope, "language is not a well-formed language value"_s);
return;
}
String script = intlStringOption(globalObject, options, vm.propertyNames->script, { }, nullptr, nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!script.isNull() && !isUnicodeScriptSubtag(script)) {
throwRangeError(globalObject, scope, "script is not a well-formed script value"_s);
return;
}
String region = intlStringOption(globalObject, options, vm.propertyNames->region, { }, nullptr, nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!region.isNull() && !isUnicodeRegionSubtag(region)) {
throwRangeError(globalObject, scope, "region is not a well-formed region value"_s);
return;
}
if (!language.isNull() || !script.isNull() || !region.isNull())
localeID.overrideLanguageScriptRegion(language, script, region);
String calendar = intlStringOption(globalObject, options, vm.propertyNames->calendar, { }, nullptr, nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!calendar.isNull()) {
if (!isUnicodeLocaleIdentifierType(calendar)) {
throwRangeError(globalObject, scope, "calendar is not a well-formed calendar value"_s);
return;
}
localeID.setKeywordValue("calendar"_s, calendar);
}
String collation = intlStringOption(globalObject, options, vm.propertyNames->collation, { }, nullptr, nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!collation.isNull()) {
if (!isUnicodeLocaleIdentifierType(collation)) {
throwRangeError(globalObject, scope, "collation is not a well-formed collation value"_s);
return;
}
localeID.setKeywordValue("collation"_s, collation);
}
String hourCycle = intlStringOption(globalObject, options, vm.propertyNames->hourCycle, { "h11", "h12", "h23", "h24" }, "hourCycle must be \"h11\", \"h12\", \"h23\", or \"h24\"", nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!hourCycle.isNull())
localeID.setKeywordValue("hours"_s, hourCycle);
String caseFirst = intlStringOption(globalObject, options, vm.propertyNames->caseFirst, { "upper", "lower", "false" }, "caseFirst must be either \"upper\", \"lower\", or \"false\"", nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!caseFirst.isNull())
localeID.setKeywordValue("colcasefirst"_s, caseFirst);
TriState numeric = intlBooleanOption(globalObject, options, vm.propertyNames->numeric);
RETURN_IF_EXCEPTION(scope, void());
if (numeric != TriState::Indeterminate)
localeID.setKeywordValue("colnumeric"_s, numeric == TriState::True ? "yes" : "no");
String numberingSystem = intlStringOption(globalObject, options, vm.propertyNames->numberingSystem, { }, nullptr, nullptr);
RETURN_IF_EXCEPTION(scope, void());
if (!numberingSystem.isNull()) {
if (!isUnicodeLocaleIdentifierType(numberingSystem)) {
throwRangeError(globalObject, scope, "numberingSystem is not a well-formed numbering system value"_s);
return;
}
localeID.setKeywordValue("numbers"_s, numberingSystem);
}
m_localeID = localeID.toCanonical();
if (m_localeID.isNull()) {
throwTypeError(globalObject, scope, "failed to initialize Locale"_s);
return;
}
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.maximize
const String& IntlLocale::maximal()
{
if (m_maximal.isNull()) {
UErrorCode status = U_ZERO_ERROR;
Vector<char, 32> buffer(32);
auto bufferLength = uloc_addLikelySubtags(m_localeID.data(), buffer.data(), buffer.size(), &status);
if (needsToGrowToProduceCString(status)) {
buffer.grow(bufferLength + 1);
status = U_ZERO_ERROR;
uloc_addLikelySubtags(m_localeID.data(), buffer.data(), bufferLength + 1, &status);
}
ASSERT(U_SUCCESS(status));
m_maximal = languageTagForLocaleID(buffer.data());
}
return m_maximal;
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.minimize
const String& IntlLocale::minimal()
{
if (m_minimal.isNull()) {
UErrorCode status = U_ZERO_ERROR;
Vector<char, 32> buffer(32);
auto bufferLength = uloc_minimizeSubtags(m_localeID.data(), buffer.data(), buffer.size(), &status);
if (needsToGrowToProduceCString(status)) {
buffer.grow(bufferLength + 1);
status = U_ZERO_ERROR;
uloc_minimizeSubtags(m_localeID.data(), buffer.data(), bufferLength + 1, &status);
}
ASSERT(U_SUCCESS(status));
m_minimal = languageTagForLocaleID(buffer.data());
}
return m_minimal;
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.toString
const String& IntlLocale::toString()
{
if (m_fullString.isNull())
m_fullString = languageTagForLocaleID(m_localeID.data());
return m_fullString;
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.baseName
const String& IntlLocale::baseName()
{
if (m_baseName.isNull()) {
UErrorCode status = U_ZERO_ERROR;
Vector<char, 32> buffer(32);
auto bufferLength = uloc_getBaseName(m_localeID.data(), buffer.data(), buffer.size(), &status);
if (needsToGrowToProduceCString(status)) {
buffer.grow(bufferLength + 1);
status = U_ZERO_ERROR;
uloc_getBaseName(m_localeID.data(), buffer.data(), bufferLength + 1, &status);
}
ASSERT(U_SUCCESS(status));
m_baseName = languageTagForLocaleID(buffer.data());
}
return m_baseName;
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.language
const String& IntlLocale::language()
{
if (m_language.isNull()) {
Vector<char, 8> buffer;
auto status = callBufferProducingFunction(uloc_getLanguage, m_localeID.data(), buffer);
ASSERT_UNUSED(status, U_SUCCESS(status));
m_language = String(buffer.data(), buffer.size());
}
return m_language;
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.script
const String& IntlLocale::script()
{
if (m_script.isNull()) {
Vector<char, 4> buffer;
auto status = callBufferProducingFunction(uloc_getScript, m_localeID.data(), buffer);
ASSERT_UNUSED(status, U_SUCCESS(status));
m_script = String(buffer.data(), buffer.size());
}
return m_script;
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.region
const String& IntlLocale::region()
{
if (m_region.isNull()) {
Vector<char, 3> buffer;
auto status = callBufferProducingFunction(uloc_getCountry, m_localeID.data(), buffer);
ASSERT_UNUSED(status, U_SUCCESS(status));
m_region = String(buffer.data(), buffer.size());
}
return m_region;
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.calendar
const String& IntlLocale::calendar()
{
if (!m_calendar)
m_calendar = keywordValue("calendar"_s);
return m_calendar.value();
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.caseFirst
const String& IntlLocale::caseFirst()
{
if (!m_caseFirst)
m_caseFirst = keywordValue("colcasefirst"_s);
return m_caseFirst.value();
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.collation
const String& IntlLocale::collation()
{
if (!m_collation)
m_collation = keywordValue("collation"_s);
return m_collation.value();
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.hourCycle
const String& IntlLocale::hourCycle()
{
if (!m_hourCycle)
m_hourCycle = keywordValue("hours"_s);
return m_hourCycle.value();
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.numberingSystem
const String& IntlLocale::numberingSystem()
{
if (!m_numberingSystem)
m_numberingSystem = keywordValue("numbers"_s);
return m_numberingSystem.value();
}
// https://tc39.es/ecma402/#sec-Intl.Locale.prototype.numeric
TriState IntlLocale::numeric()
{
constexpr bool isBoolean = true;
if (m_numeric == TriState::Indeterminate)
m_numeric = triState(keywordValue("colnumeric"_s, isBoolean) == "yes"_s);
return m_numeric;
}
} // namespace JSC