1693576 - Implement Intl.LocaleInfo

Status: ASSIGNED

(Core :: JavaScript: Internationalization API, enhancement, P3)

Description

[Yulia Startsev [:yulia] | Back in Oct.]

Currently at stage 2

Comment 1

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 1: Add CompareStrings overload for linear strings. r=yulia!

Comment 2

[André Bargull [:anba]]

Only a draft patch for now until the various issues I've reported at https://github.com/tc39/proposal-intl-locale-info/issues have been resolved resp. clarified.

Comment 4

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 11: Implement Intl.Locale.prototype.calendars.

LocaleObject doesn't use a reserved slot to store the [[Calendar]] internal
slot, so we have to extract any Unicode "ca" extension sequences directly
from the locale identifier via GetUnicodeExtension().

If no "ca" Unicode keyword is present in the locale, we're calling into ICU
to retrieve all commonly used calendars of the locale (via
ucal_getKeywordValuesForLocale()).

ICU has certain internal limits on how large the input locale can be, so to make
sure we don't run into these limits, the LocaleLSR helper class extracts the
language, script, and region subtags of a locale. The LSR-subtags are guaranteed
to fit into the ICU limits.

Depends on D115223

Comment 5

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 12: Implement Intl.Locale.prototype.collations.

Similar to part 2, but this time for collations instead of calendars.

Depends on D116467

Comment 6

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 13: Implement Intl.Locale.prototype.hourCycles.

Unfortunately support for hour cycles is more convoluted, because ICU doesn't
have public APIs to get the complete set of supported hour cycles for a locale:

There is udatpg_getDefaultHourCycle(), but that function only returns the
default hour cycle, but not any additionally allowed hour cycles. So we have to
do it the hard way and directly read ICU resource bundles to get the data we
need for this feature.

Depends on D116468

Comment 7

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 14: Implement Intl.Locale.prototype.numberingSystems.

There is no way to figure out which numbering systems are commonly used by a
specific locale (because this data isn't even recorded in CLDR), so we can
only return the default numbering system.

Depends on D116469

Comment 8

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 15: Implement Intl.Locale.prototype.timeZones.

Time zone names are canonicalised and sorted alphabetically. Canonicalisation
has the usual problem that ICU uses CLDR time zone canonicalisation, whereas
the spec requires IANA canonicalisation, so we have to perform some extra
steps here.

Depends on D116470

Comment 9

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 16: Implement Intl.Locale.prototype.textInfo.

Depends on D116471

Comment 10

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 17: Implement Intl.Locale.prototype.weekInfo.

This code is based on the existing code in js::intl_GetCalendarInfo() with
the exception of gracefully handling UCAL_WEEKEND_{ONSET,CEASE} instead of
throwing an error.

Depends on D116472

Comment 11

[André Bargull [:anba]]

Patches split for review, but I'm still waiting for the open spec issues to be resolved before actually requesting review.

Comment 12

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 1: Add "commonlyUsed" to Calendar and Collator. r=#platform-i18n-reviewers!

Pass through the "commonlyUsed" parameter to ICU to be able to filter any
uncommon keyword values.

Comment 13

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 2: Add DateTimeFormat::GetAllowedHourCycles(). r=#platform-i18n-reviewers!

ICU's public API only provides a function to return the preferred hour cycle
(udatpg_getDefaultHourCycle()), whereas for Intl.Locale we want to be able
to determine all allowed hour cycles. So we have to do it the hard way and
directly read ICU resource bundles to get the data we need for this feature.

Depends on D125570

Comment 14

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 3: Add NumberingSystem class to the unified Intl API component. r=#platform-i18n-reviewers!

Depends on D125571

Comment 15

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 4: Switch intl_numberingSystem to use mozilla::intl::NumberingSystem. r=#platform-i18n-reviewers!

Use the new NumberingSystem class to replace UNumberingSystem in SpiderMonkey.

Depends on D125572

Comment 16

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 5: Move time zone functions from mozilla::Calendar into mozilla::TimeZone. r=#platform-i18n-reviewers!

Time zone functions being part of UCalendar is an internal implementation
detail of ICU4C. For the public unified Intl API we should rather follow
Temporal (or ICU4C's C++ API) and have a separate TimeZone class.

The files were moved using hg cp to preserve the file history.

Depends on D125573

Comment 17

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 6: Rename GetDefaultTimeZoneOffsetMs() to GetRawOffsetMs(). r=#platform-i18n-reviewers!

• TimeZone objects can be created with any time zone identifier, so the "Default"
  part in the name isn't correct.
• The "TimeZone" part is no longer needed, now that there's a distinct class for
  TimeZone objects.

Therefore let's rename GetDefaultTimeZoneOffsetMs() to GetRawOffsetMs().

Depends on D125574

Comment 18

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 7: Add method to enumerate over all time zones used in a region. r=#platform-i18n-reviewers!

The filter type is UCAL_ZONE_TYPE_ANY to ensure all possible time zones are
returned, and not just CLDR canonical time zones. (CLDR canonical time zones
are different from IANA canonical time zones.)

Depends on D125575

Comment 19

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 8: Add a new TextLayout class to the unified Intl API. r=#platform-i18n-reviewers!

Currently only provides a single method to retrieve the character orientation.

The default constructor was deleted because all methods are static.

Depends on D125576

Comment 20

[André Bargull [:anba]]

Attachment: Bug 1693576 - Part 8: Add a method to retrieve week day information to Calendar. r=#platform-i18n-reviewers!

The last addition for the "Intl Locale Info API" proposal.

Depends on D125577

Comment 21

[André Bargull [:anba]]

Attachment: WIP: Bug 1693576 - Part 10: Move CreateArrayFromList to CommonFunctions.

Move CreateArrayFromList to intl/CommonFunctions so later patches in this
patch stack can use it.

Comment 22

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/5518e046d03a
Part 1: Add "commonlyUsed" to Calendar and Collator. r=platform-i18n-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/4fb2491acf41
Part 2: Add DateTimeFormat::GetAllowedHourCycles(). r=platform-i18n-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/91c7f73689b3
Part 3: Add NumberingSystem class to the unified Intl API component. r=platform-i18n-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/a56309fdebdd
Part 4: Switch intl_numberingSystem to use mozilla::intl::NumberingSystem. r=platform-i18n-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/2478cae35f36
Part 5: Move time zone functions from mozilla::Calendar into mozilla::TimeZone. r=platform-i18n-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/afb87d21b97b
Part 6: Rename GetDefaultTimeZoneOffsetMs() to GetRawOffsetMs(). r=platform-i18n-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/3e6b7914038c
Part 7: Add method to enumerate over all time zones used in a region. r=platform-i18n-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/5c5ea857c3d9
Part 8: Add a method to retrieve week day information to Calendar. r=platform-i18n-reviewers,gregtatum

Comment 23

[Sandor Molnar]

https://hg.mozilla.org/mozilla-central/rev/5518e046d03a
https://hg.mozilla.org/mozilla-central/rev/4fb2491acf41
https://hg.mozilla.org/mozilla-central/rev/91c7f73689b3
https://hg.mozilla.org/mozilla-central/rev/a56309fdebdd
https://hg.mozilla.org/mozilla-central/rev/2478cae35f36
https://hg.mozilla.org/mozilla-central/rev/afb87d21b97b
https://hg.mozilla.org/mozilla-central/rev/3e6b7914038c
https://hg.mozilla.org/mozilla-central/rev/5c5ea857c3d9

Comment 24

[BugBot [:suhaib / :marco/ :calixte]]

The leave-open keyword is there and there is no activity for 6 months.
:sdetar, maybe it's time to close this bug?
For more information, please visit auto_nag documentation.

Comment 25

[André Bargull [:anba]]

The spec for the proposal didn't progress in the last months.

Comment 26

[Dan Minor [:dminor]]

Hi Anba, Frank is hoping to advance this to stage 4 in the near term, and he is wondering if you are waiting on any information from him prior to you being able to continue with the implementation. Thanks!

Comment 27

[André Bargull [:anba]]

Issues like https://github.com/tc39/proposal-intl-locale-info/issues/30 still need to be resolved. The last comment seems to be confused about the meaning of [[RelevantExtensionKeys]] for Intl.Locale: While it is true that Intl.Locale has a [[RelevantExtensionKeys]] internal slot, Intl.Locale isn't an Intl service constructor, so Intl.Locale.[[RelevantExtensionKeys]] doesn't imply that Intl.Locale instances have to care about any extension keys.