@ui5/webcomponents-localization 0.0.0-d9933bd82 → 0.0.0-da0d3eb88

package/dist/sap/ui/core/Locale.js

@@ -1,120 +1,194 @@
-import BaseObject from '../base/Object.js';
-import assert from '../../base/assert.js';
-var rLocale = /^((?:[A-Z]{2,3}(?:-[A-Z]{3}){0,3})|[A-Z]{4}|[A-Z]{5,8})(?:-([A-Z]{4}))?(?:-([A-Z]{2}|[0-9]{3}))?((?:-[0-9A-Z]{5,8}|-[0-9][0-9A-Z]{3})*)((?:-[0-9A-WYZ](?:-[0-9A-Z]{2,8})+)*)(?:-(X(?:-[0-9A-Z]{1,8})+))?$/i;
-var Locale = BaseObject.extend('sap.ui.core.Locale', {
-    constructor: function (sLocaleId) {
-        BaseObject.apply(this);
-        var aResult = rLocale.exec(sLocaleId.replace(/_/g, '-'));
-        if (aResult === null) {
-            throw 'The given language \'' + sLocaleId + '\' does not adhere to BCP-47.';
-        }
-        this.sLocaleId = sLocaleId;
-        this.sLanguage = aResult[1] || null;
-        this.sScript = aResult[2] || null;
-        this.sRegion = aResult[3] || null;
-        this.sVariant = aResult[4] && aResult[4].slice(1) || null;
-        this.sExtension = aResult[5] && aResult[5].slice(1) || null;
-        this.sPrivateUse = aResult[6] || null;
-        if (this.sLanguage) {
-            this.sLanguage = this.sLanguage.toLowerCase();
-        }
-        if (this.sScript) {
-            this.sScript = this.sScript.toLowerCase().replace(/^[a-z]/, function ($) {
-                return $.toUpperCase();
-            });
-        }
-        if (this.sRegion) {
-            this.sRegion = this.sRegion.toUpperCase();
-        }
-    },
-    getLanguage: function () {
-        return this.sLanguage;
-    },
-    getScript: function () {
-        return this.sScript;
-    },
-    getRegion: function () {
-        return this.sRegion;
-    },
-    getVariant: function () {
-        return this.sVariant;
-    },
-    getVariantSubtags: function () {
-        return this.sVariant ? this.sVariant.split('-') : [];
-    },
-    getExtension: function () {
-        return this.sExtension;
-    },
-    getExtensionSubtags: function () {
-        return this.sExtension ? this.sExtension.slice(2).split('-') : [];
-    },
-    getPrivateUse: function () {
-        return this.sPrivateUse;
-    },
-    getPrivateUseSubtags: function () {
-        return this.sPrivateUse ? this.sPrivateUse.slice(2).split('-') : [];
-    },
-    hasPrivateUseSubtag: function (sSubtag) {
-        assert(sSubtag && sSubtag.match(/^[0-9A-Z]{1,8}$/i), 'subtag must be a valid BCP47 private use tag');
-        return this.getPrivateUseSubtags().indexOf(sSubtag) >= 0;
-    },
-    toString: function () {
-        var r = [this.sLanguage];
-        if (this.sScript) {
-            r.push(this.sScript);
-        }
-        if (this.sRegion) {
-            r.push(this.sRegion);
-        }
-        if (this.sVariant) {
-            r.push(this.sVariant);
-        }
-        if (this.sExtension) {
-            r.push(this.sExtension);
-        }
-        if (this.sPrivateUse) {
-            r.push(this.sPrivateUse);
-        }
-        return r.join('-');
-    },
-    getSAPLogonLanguage: function () {
-        var sLanguage = this.sLanguage || '', m;
-        if (sLanguage.indexOf('-') >= 0) {
-            sLanguage = sLanguage.slice(0, sLanguage.indexOf('-'));
-        }
-        sLanguage = M_ISO639_OLD_TO_NEW[sLanguage] || sLanguage;
-        if (sLanguage === 'zh') {
-            if (this.sScript === 'Hant' || !this.sScript && this.sRegion === 'TW') {
-                sLanguage = 'zf';
-            }
-        }
-        if (this.sPrivateUse && (m = /-(saptrc|sappsd)(?:-|$)/i.exec(this.sPrivateUse))) {
-            sLanguage = m[1].toLowerCase() === 'saptrc' ? '1Q' : '2Q';
-        }
-        return sLanguage.toUpperCase();
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+//Provides the locale object sap.ui.core.Locale
+import assert from "../../base/assert.js";
+import BaseObject from "../base/Object.js";
+import Localization from "../../base/i18n/Localization.js";
+import LanguageTag from "../../base/i18n/LanguageTag.js";
+var mCache = Object.create(null);
+
+/**
+ * Creates an instance of the Locale.
+ *
+ * @class Locale represents a locale setting, consisting of a language, script, region, variants, extensions and private use section.
+ *
+ * @param {string} sLocale the locale identifier, in format en-US or en_US.
+ *
+ * @extends sap.ui.base.Object
+ * @author SAP SE
+ * @version 1.120.5
+ * @public
+ * @alias sap.ui.core.Locale
+ */
+var Locale = BaseObject.extend("sap.ui.core.Locale", /** @lends sap.ui.core.Locale.prototype */{
+  constructor: function (vLocale) {
+    BaseObject.apply(this);
+    if (vLocale instanceof LanguageTag) {
+      this.oLanguageTag = vLocale;
+      this.sLocaleId = this.oLanguageTag.toString();
+    } else {
+      this.oLanguageTag = new LanguageTag(vLocale);
+      this.sLocaleId = vLocale;
     }
+    Object.assign(this, this.oLanguageTag);
+    this.sLanguage = this.language;
+  },
+  /**
+   * Get the locale language.
+   *
+   * Note that the case might differ from the original script tag
+   * (Lower case is enforced as recommended by BCP47/ISO639).
+   *
+   * @returns {string} the language code
+   * @public
+   */
+  getLanguage: function () {
+    return this.language;
+  },
+  /**
+   * Get the locale script or <code>null</code> if none was specified.
+   *
+   * Note that the case might differ from the original language tag
+   * (Upper case first letter and lower case reminder enforced as
+   * recommended by BCP47/ISO15924)
+   *
+   * @returns {string|null} the script code or <code>null</code>
+   * @public
+   */
+  getScript: function () {
+    return this.script;
+  },
+  /**
+   * Get the locale region or <code>null</code> if none was specified.
+   *
+   * Note that the case might differ from the original script tag
+   * (Upper case is enforced as recommended by BCP47/ISO3166-1).
+   *
+   * @returns {string} the ISO3166-1 region code (2-letter or 3-digits)
+   * @public
+   */
+  getRegion: function () {
+    return this.region;
+  },
+  /**
+   * Get the locale variants as a single string or <code>null</code>.
+   *
+   * Multiple variants are separated by a dash '-'.
+   *
+   * @returns {string|null} the variant or <code>null</code>
+   * @public
+   */
+  getVariant: function () {
+    return this.variant;
+  },
+  /**
+   * Get the locale variants as an array of individual variants.
+   *
+   * The separating dashes are not part of the result.
+   * If there is no variant section in the locale tag, an empty array is returned.
+   *
+   * @returns {string[]} the individual variant sections
+   * @public
+   */
+  getVariantSubtags: function () {
+    return this.variantSubtags;
+  },
+  /**
+   * Get the locale extension as a single string or <code>null</code>.
+   *
+   * The extension always consists of a singleton character (not 'x'),
+   * a dash '-' and one or more extension token, each separated
+   * again with a dash.
+   *
+   * Use {@link #getExtensions} to get the individual extension tokens as an array.
+   *
+   * @returns {string|null} the extension or <code>null</code>
+   * @public
+   */
+  getExtension: function () {
+    return this.extension;
+  },
+  /**
+   * Get the locale extensions as an array of tokens.
+   *
+   * The leading singleton and the separating dashes are not part of the result.
+   * If there is no extensions section in the locale tag, an empty array is returned.
+   *
+   * @returns {string[]} the individual extension sections
+   * @public
+   */
+  getExtensionSubtags: function () {
+    return this.extensionSubtags;
+  },
+  /**
+   * Get the locale private use section or <code>null</code>.
+   *
+   * @returns {string} the private use section
+   * @public
+   */
+  getPrivateUse: function () {
+    return this.privateUse;
+  },
+  /**
+   * Get the locale private use section as an array of tokens.
+   *
+   * The leading singleton and the separating dashes are not part of the result.
+   * If there is no private use section in the locale tag, an empty array is returned.
+   *
+   * @returns {string[]} the tokens of the private use section
+   * @public
+   */
+  getPrivateUseSubtags: function () {
+    return this.privateUseSubtags;
+  },
+  /**
+   * Check if a subtag is provided
+   *
+   * @param {string} sSubtag The subtag to check
+   * @returns {boolean} Wether the subtag is provided or not
+   */
+  hasPrivateUseSubtag: function (sSubtag) {
+    assert(sSubtag && sSubtag.match(/^[0-9A-Z]{1,8}$/i), "subtag must be a valid BCP47 private use tag");
+    return this.privateUseSubtags.indexOf(sSubtag) >= 0;
+  },
+  toString: function () {
+    return this.oLanguageTag.toString();
+  },
+  /**
+   * Best guess to get a proper SAP Logon Language for this locale.
+   *
+   * Conversions taken into account:
+   * <ul>
+   * <li>use the language part only</li>
+   * <li>convert old ISO639 codes to newer ones (e.g. 'iw' to 'he')</li>
+   * <li>for Chinese, map 'Traditional Chinese' or region 'TW' to SAP proprietary code 'zf'</li>
+   * <li>map private extensions x-saptrc, x-sappsd and saprigi to SAP pseudo languages '1Q', '2Q' and '3Q'</li>
+   * <li>remove ext. language sub tags</li>
+   * <li>convert to uppercase</li>
+   * </ul>
+   *
+   * Note that the conversion also returns a result for languages that are not
+   * supported by the default set of SAP languages. This method has no knowledge
+   * about the concrete languages of any given backend system.
+   *
+   * @returns {string} a language code that should
+   * @public
+   * @since 1.17.0
+   * @deprecated As of 1.44, use {@link sap.ui.core.Configuration#getSAPLogonLanguage} instead
+   *   as that class allows to configure an SAP Logon language.
+   */
+  getSAPLogonLanguage: function () {
+    return Localization._getSAPLogonLanguage(this);
+  }
 });
-var M_ISO639_OLD_TO_NEW = {
-    'iw': 'he',
-    'ji': 'yi',
-    'in': 'id',
-    'sh': 'sr'
-};
-function getDesigntimePropertyAsArray(sValue) {
-    var m = /\$([-a-z0-9A-Z._]+)(?::([^$]*))?\$/.exec(sValue);
-    return m && m[2] ? m[2].split(/,/) : null;
-}
-var A_RTL_LOCALES = getDesigntimePropertyAsArray('$cldr-rtl-locales:ar,fa,he$') || [];
-Locale._cldrLocales = getDesigntimePropertyAsArray('$cldr-locales:ar,ar_EG,ar_SA,bg,br,ca,cs,da,de,de_AT,de_CH,el,el_CY,en,en_AU,en_GB,en_HK,en_IE,en_IN,en_NZ,en_PG,en_SG,en_ZA,es,es_AR,es_BO,es_CL,es_CO,es_MX,es_PE,es_UY,es_VE,et,fa,fi,fr,fr_BE,fr_CA,fr_CH,fr_LU,he,hi,hr,hu,id,it,it_CH,ja,kk,ko,lt,lv,ms,nb,nl,nl_BE,nn,pl,pt,pt_PT,ro,ru,ru_UA,sk,sl,sr,sv,th,tr,uk,vi,zh_CN,zh_HK,zh_SG,zh_TW$');
-Locale._coreI18nLocales = getDesigntimePropertyAsArray('$core-i18n-locales:,ar,bg,ca,cs,da,de,el,en,es,et,fi,fr,hi,hr,hu,it,iw,ja,kk,ko,lt,lv,ms,nl,no,pl,pt,ro,ru,sh,sk,sl,sv,th,tr,uk,vi,zh_CN,zh_TW$');
-Locale._impliesRTL = function (vLanguage) {
-    var oLocale = vLanguage instanceof Locale ? vLanguage : new Locale(vLanguage);
-    var sLanguage = oLocale.getLanguage() || '';
-    sLanguage = sLanguage && M_ISO639_OLD_TO_NEW[sLanguage] || sLanguage;
-    var sRegion = oLocale.getRegion() || '';
-    if (sRegion && A_RTL_LOCALES.indexOf(sLanguage + '_' + sRegion) >= 0) {
-        return true;
-    }
-    return A_RTL_LOCALES.indexOf(sLanguage) >= 0;
+Locale._getCoreLocale = function (oLocale) {
+  if (oLocale instanceof LanguageTag) {
+    oLocale = mCache[oLocale.toString()] || new Locale(oLocale);
+    mCache[oLocale.toString()] = oLocale;
+  }
+  return oLocale;
 };
 export default Locale;