Replace empty subtags within a Cldr.LanguageTag with the most likely subtag.

A subtag is called empty if it is a missing script or region subtag, or it is a base language subtag with the value und. In the description below, a subscript on a subtag x indicates which tag it is from: x_s is in the source, x_m is in a match, and x_r is in the final result.

This operation is performed in the following way:

Lookup

Lookup each of the following in order, and stop on the first match:

• language_s-script_s-region_s
• language_s-region_s
• language_s-script_s
• language_s
• und-script_s

Return

• If there is no match,either return

  • an error value, or
  • the match for und

• Otherwise there is a match = language_m-script_m-region_m

• Let x_r = x_s if x_s is not empty, and x_m otherwise.

• Return the language tag composed of language_r-script_r-region_r + variants + extensions .

Example

iex> Cldr.Locale.add_likely_subtags Cldr.LanguageTag.parse!("zh-SG")
%Cldr.LanguageTag{
  canonical_locale_name: nil,
  cldr_locale_name: nil,
  extensions: %{},
  language: "zh",
  locale: %{},
  private_use: [],
  rbnf_locale_name: nil,
  requested_locale_name: "zh-sg",
  script: "Hans",
  territory: "SG",
  transform: %{},
  variant: nil
}

Returns an error tuple for an invalid locale alias.

• locale_name is any locale name returned by Cldr.known_locale_names/0

Return a map of the known aliases for Language, Script and Territory

Return a map of the aliases for a given alias key and type

• type is one of [:language, :region, :script, :variant, :zone]

• key is the substitution key (a language, region, script, variant or zone)

Parses a locale name and returns a Cldr.LanguageTag struct that represents a locale.

• locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct

Returns:

• {:ok, language_tag} or

• {:eror, reason}

Several steps are followed to produce a canonical language tag:

1. The language tag is parsed in accordance with RFC5646

2. Any language, script or region aliases are replaced. This will replace any obsolete elements with current versions

3. If a territory or script is not specified, a default is provided using the CLDR information returned by Cldr.Locale.likely_subtags/1

4. A Cldr locale name is selected that is the nearest fit to the requested locale.

Example

iex> Cldr.Locale.canonical_language_tag "en"
{
  :ok,
  %Cldr.LanguageTag{
    canonical_locale_name: "en-Latn-US",
    cldr_locale_name: "en",
    extensions: %{},
    language: "en",
    locale: %{},
    private_use: [],
    rbnf_locale_name: "en",
    requested_locale_name: "en",
    script: "Latn",
    territory: "US",
    transform: %{},
    variant: nil
  }
}

Parses a locale name and returns a Cldr.LanguageTag struct that represents a locale or raises on error.

• locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct

See Cldr.Locale.canonical_language_tag/1 for more information.

Returns the map of likely subtags for a subset of available locale names.

Example

Cldr.Locale.likely_subtags
%{
  "bez" => %Cldr.LanguageTag{
    canonical_locale_name: nil,
    cldr_locale_name: nil,
    extensions: %{},
    language: "bez",
    locale: %{},
    private_use: [],
    rbnf_locale_name: nil,
    requested_locale_name: nil,
    script: "Latn",
    territory: "TZ",
    transform: %{},
    variant: nil
  },
  "fuf" => %Cldr.LanguageTag{
    canonical_locale_name: nil,
    cldr_locale_name: nil,
    extensions: %{},
    language: "fuf",
    locale: %{},
    private_use: [],
    rbnf_locale_name: nil,
    requested_locale_name: nil,
    script: "Latn",
    territory: "GN",
    transform: %{},
    variant: nil
  },
  ...

Returns the likely substags, as a Cldr.LanguageTag, for a given locale name.

• locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct

Examples

iex> Cldr.Locale.likely_subtags "en"
%Cldr.LanguageTag{
  canonical_locale_name: nil,
  cldr_locale_name: nil,
  extensions: %{},
  language: "en",
  locale: %{},
  private_use: [],
  rbnf_locale_name: nil,
  requested_locale_name: nil,
  script: "Latn",
  territory: "US",
  transform: %{},
  variant: nil
}

iex> Cldr.Locale.likely_subtags Cldr.Locale.new!("th")
%Cldr.LanguageTag{
  canonical_locale_name: nil,
  cldr_locale_name: nil,
  extensions: %{},
  language: "th",
  locale: %{},
  private_use: [],
  rbnf_locale_name: nil,
  requested_locale_name: nil,
  script: "Thai",
  territory: "TH",
  transform: %{},
  variant: nil
}

Returns an error tuple for an invalid locale.

• locale_name is any locale name returned by Cldr.known_locale_names/0

Examples

iex> Cldr.Locale.locale_error :invalid
{Cldr.UnknownLocaleError, "The locale :invalid is not known."}

Return a locale name from a Cldr.LanguageTag

• locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct

Example

iex> Cldr.Locale.locale_name_from Cldr.Locale.new!("en")
"en-Latn-US"

Return a locale name by combining language, script, territory and variant parameters

• language, script, territory and variant are string representations, or nil, of the language subtags

Example

iex> Cldr.Locale.locale_name_from("en", "Latn", "001", nil)
"en-Latn-001"

See Cldr.Locale.canonical_language_tag/1.

See Cldr.Locale.canonical_language_tag!/1.

Normalize the casing of a locale name.

• locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct

Locale names are case insensitive but certain common casing is followed in practise:

• lower case for a language
• capital case for a script
• upper case for a region/territory

Note this function is intended to support only the CLDR locale names which have a format that is a subset of the full langauge tag specification.

For proper parsing of local names and language tags, see Cldr.Locale.canonical_language_tag/1

Examples

iex> Cldr.Locale.normalize_locale_name "zh_hant"
"zh-Hant"

iex> Cldr.Locale.normalize_locale_name "en_us"
"en-US"

iex> Cldr.Locale.normalize_locale_name "EN"
"en"

iex> Cldr.Locale.normalize_locale_name "ca_es_valencia"
"ca-ES-VALENCIA"

Substitute deprectated subtags with a Cldr.LanguageTag with their non-deprecated alternatives.

• Replace any deprecated subtags with their canonical values using the alias data. Use the first value in the replacement list, if it exists. Language tag replacements may have multiple parts, such as sh ➞ sr_Latn or mo ➞ ro_MD. In such a case, the original script and/or region/territory are retained if there is one. Thus sh_Arab_AQ ➞ sr_Arab_AQ, not sr_Latn_AQ.

• Remove the script code ‘Zzzz’ and the territory code ‘ZZ’ if they occur.

• Get the components of the cleaned-up source tag (languages, scripts, and regions/territories), plus any variants and extensions.

Examples

iex> Cldr.Locale.substitute_aliases Cldr.LanguageTag.Parser.parse!("en-US")
%Cldr.LanguageTag{
  canonical_locale_name: nil,
  cldr_locale_name: nil,
  extensions: %{},
  language: "en",
  locale: %{},
  private_use: [],
  rbnf_locale_name: nil,
  requested_locale_name: "en-us",
  script: nil,
  territory: "US",
  transform: %{},
  variant: nil
}

iex> Cldr.Locale.substitute_aliases Cldr.LanguageTag.Parser.parse!("sh_Arab_AQ")
%Cldr.LanguageTag{
  canonical_locale_name: nil,
  cldr_locale_name: nil,
  extensions: %{},
  language: "sr",
  locale: %{},
  private_use: [],
  rbnf_locale_name: nil,
  requested_locale_name: "sh-arab-aq",
  script: "Arab",
  territory: "AQ",
  transform: %{},
  variant: nil
}

iex> Cldr.Locale.substitute_aliases Cldr.LanguageTag.Parser.parse!("sh_AQ")
%Cldr.LanguageTag{
   canonical_locale_name: nil,
   cldr_locale_name: nil,
   extensions: %{},
   language: "sr",
   locale: %{},
   private_use: [],
   rbnf_locale_name: nil,
   requested_locale_name: "sh-aq",
   script: "Latn",
   territory: "AQ",
   transform: %{},
   variant: nil
 }

iex> Cldr.Locale.substitute_aliases Cldr.LanguageTag.Parser.parse!("mo")
%Cldr.LanguageTag{
  canonical_locale_name: nil,
  cldr_locale_name: nil,
  extensions: %{},
  language: "ro",
  locale: %{},
  private_use: [],
  rbnf_locale_name: nil,
  requested_locale_name: "mo",
  script: nil,
  territory: "MD",
  transform: %{},
  variant: nil
}