Bug 1760013 - Add intl/locale/rust/locale_service_glue/. r=hsivonen,bolsson

This uses icu_locale for the added functions, but does not migrate existing unic_langid usage to it.

The initial data matches the current localized values.

I'll be filing a follow-up PR in https://github.com/mozilla-l10n/documentation to add a section to the "Adding a new locale to Beta and Release builds" page (https://mozilla-l10n.github.io/documentation/products/firefox_desktop/adding_release.html) to give some additional visibility for needing to review these behaviours when adding a new locale.

Differential Revision: https://phabricator.services.mozilla.com/D266753

Author: eemeli

Cargo.lock

@@ -14,6 +14,7 @@
 #include "mozilla/intl/AppDateTimeFormat.h"
 #include "mozilla/intl/Locale.h"
 #include "mozilla/intl/OSPreferences.h"
+#include "mozilla/intl/locale_service_glue_generated.h"
 #include "nsContentUtils.h"
 #include "nsDirectoryService.h"
 #include "nsDirectoryServiceDefs.h"
@@ -31,6 +32,9 @@
 
 #define INTL_SYSTEM_LOCALES_CHANGED "intl:system-locales-changed"
 
+#define ACCEPT_LANGUAGES_PREF "intl.accept_languages"
+#define FONT_LANGUAGE_GROUP_PREF "font.language.group"
+
 #define PSEUDO_LOCALE_PREF "intl.l10n.pseudo"
 #define REQUESTED_LOCALES_PREF "intl.locale.requested"
 #define WEB_EXPOSED_LOCALES_PREF "intl.locale.privacy.web_exposed"
@@ -694,3 +698,78 @@ LocaleService::GetPackagedLocales(nsTArray<nsCString>& aRetVal) {
   aRetVal = mPackagedLocales.Clone();
   return NS_OK;
 }
+
+NS_IMETHODIMP
+LocaleService::GetEllipsis(nsAString& aRetVal) {
+  if (mAppLocales.IsEmpty()) {
+    NegotiateAppLocales(mAppLocales);
+  }
+  ffi::locale_service_ellipsis(&mAppLocales[0], &aRetVal);
+  return NS_OK;
+}
+
+bool LocaleService::AlwaysAppendAccesskeys() {
+  if (mAppLocales.IsEmpty()) {
+    NegotiateAppLocales(mAppLocales);
+  }
+  return ffi::locale_service_always_append_accesskeys(&mAppLocales[0]);
+}
+
+bool LocaleService::InsertSeparatorBeforeAccesskeys() {
+  if (mAppLocales.IsEmpty()) {
+    NegotiateAppLocales(mAppLocales);
+  }
+  return ffi::locale_service_insert_separator_before_accesskeys(
+      &mAppLocales[0]);
+}
+
+NS_IMETHODIMP
+LocaleService::GetAlwaysAppendAccesskeys(bool* aRetVal) {
+  (*aRetVal) = AlwaysAppendAccesskeys();
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+LocaleService::GetInsertSeparatorBeforeAccesskeys(bool* aRetVal) {
+  (*aRetVal) = InsertSeparatorBeforeAccesskeys();
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+LocaleService::GetAcceptLanguages(nsACString& aRetVal) {
+  // if there is a user (or locked) value, use it
+  if (Preferences::HasUserValue(ACCEPT_LANGUAGES_PREF) ||
+      Preferences::IsLocked(ACCEPT_LANGUAGES_PREF)) {
+    nsresult rv = Preferences::GetCString(ACCEPT_LANGUAGES_PREF, aRetVal);
+    if (NS_SUCCEEDED(rv)) {
+      return NS_OK;
+    }
+  }
+
+  // if we need to fetch the default value, do that instead
+  if (mAppLocales.IsEmpty()) {
+    NegotiateAppLocales(mAppLocales);
+  }
+  ffi::locale_service_default_accept_languages(&mAppLocales[0], &aRetVal);
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+LocaleService::GetFontLanguageGroup(nsACString& aRetVal) {
+  // if there is a user (or locked) value, use it
+  if (Preferences::HasUserValue(FONT_LANGUAGE_GROUP_PREF) ||
+      Preferences::IsLocked(FONT_LANGUAGE_GROUP_PREF)) {
+    nsresult rv = Preferences::GetCString(FONT_LANGUAGE_GROUP_PREF, aRetVal);
+    if (NS_SUCCEEDED(rv)) {
+      return NS_OK;
+    }
+  }
+
+  // if we need to fetch the default value, do that instead
+  if (mAppLocales.IsEmpty()) {
+    NegotiateAppLocales(mAppLocales);
+  }
+  ffi::locale_service_default_font_language_group(&mAppLocales[0], &aRetVal);
+
+  return NS_OK;
+}

intl/locale/LocaleService.cpp

@@ -168,6 +168,16 @@ class LocaleService final : public mozILocaleService,
    */
   bool IsAppLocaleRTL();
 
+  /**
+   * If true, accesskeys should always be appended for the current app locale.
+   */
+  bool AlwaysAppendAccesskeys();
+
+  /**
+   * If true, accesskeys should always be separated from the label.
+   */
+  bool InsertSeparatorBeforeAccesskeys();
+
   static bool LanguagesMatch(const nsACString& aRequested,
                              const nsACString& aAvailable);
 

intl/locale/LocaleService.h

@@ -77,6 +77,10 @@ if CONFIG["COMPILE_ENVIRONMENT"]:
         "fluent_langneg_ffi_generated.h",
         inputs=["/intl/locale/rust/fluent-langneg-ffi"],
     )
+    CbindgenHeader(
+        "locale_service_glue_generated.h",
+        inputs=["/intl/locale/rust/locale_service_glue"],
+    )
     CbindgenHeader(
         "oxilangtag_ffi_generated.h", inputs=["/intl/locale/rust/oxilangtag-ffi"]
     )
@@ -86,6 +90,7 @@ if CONFIG["COMPILE_ENVIRONMENT"]:
 
     EXPORTS.mozilla.intl += [
         "!fluent_langneg_ffi_generated.h",
+        "!locale_service_glue_generated.h",
         "!oxilangtag_ffi_generated.h",
         "!unic_langid_ffi_generated.h",
     ]

intl/locale/moz.build

@@ -174,4 +174,33 @@ interface mozILocaleService : nsISupports
    * Example: ["en-US", "de", "pl", "sr-Cyrl", "zh-Hans-HK"]
    */
   readonly attribute Array<ACString> packagedLocales;
+
+  /**
+   * The unicode ellipsis char "…", or "...", depending on the current app locale.
+   */
+  readonly attribute AString ellipsis;
+
+  /**
+   * If true, accesskeys should always be appended for the current app locale.
+   */
+  readonly attribute boolean alwaysAppendAccesskeys;
+
+  /**
+   * If true, accesskeys should always be separated from the label.
+   */
+  readonly attribute boolean insertSeparatorBeforeAccesskeys;
+
+  /**
+   * A comma-separated list of valid BCP 47 language tags.
+   */
+  readonly attribute ACString acceptLanguages;
+
+  /**
+   * The initial setting of the language drop-down menu
+   * in the Fonts and Colors > Advanced preference panel.
+   *
+   * Takes one of the values of the menuitems in the "selectLangs" menulist in
+   * https://searchfox.org/firefox-main/source/browser/components/preferences/dialogs/fonts.xhtml
+   */
+  readonly attribute ACString fontLanguageGroup;
 };

intl/locale/mozILocaleService.idl

@@ -0,0 +1,13 @@
+[package]
+edition = "2021"
+name = "locale_service_glue"
+version = "0.1.0"
+license = "MPL-2.0"
+authors = ["Eemeli Aro <eemeli@mozilla.com>"]
+
+[dependencies]
+nsstring = { path = "../../../../xpcom/rust/nsstring" }
+
+[dependencies.icu_locale]
+version = "~2.0.0"
+default-features = false

intl/locale/rust/locale_service_glue/Cargo.toml

@@ -0,0 +1,18 @@
+header = """/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */"""
+autogen_warning = """/* DO NOT MODIFY THIS MANUALLY! This file was generated using cbindgen. See RunCbindgen.py */
+#ifndef mozilla_intl_locale_MozLocaleBindings_h
+#error "Don't include this file directly, instead include MozLocaleBindings.h"
+#endif
+"""
+include_version = true
+braces = "SameLine"
+line_length = 100
+tab_width = 2
+language = "C++"
+namespaces = ["mozilla", "intl", "ffi"]
+
+[parse]
+parse_deps = true
+include = ["icu_locale"]