LocaleUtil.java

/*
Copyright (c) 2026 James Ahlborn

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package com.healthmarketscience.jackcess.impl.expr;

import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

/**
 * Utility for mapping Windows Locale Identifier (LCID) values to locale info.
 * Holds every locale id in the ms access sort locale map, which is the set a
 * database can record as the sort order of a text column, and azerbaijani,
 * which has no sort order of its own and can still be asked for by name in an
 * expression.
 *
 * @author James Ahlborn
 */
public class LocaleUtil
{
  private static final Map<Integer,LcidInfo> LCID_TO_INFO;

  static {
    Map<Integer,LcidInfo> map = new HashMap<>();
    // General / English
    add(map, 1033, "General", Locale.US);
    // Western European
    add(map, 1031, "German",     Locale.GERMAN);
    add(map, 1036, "French",     Locale.FRENCH);
    add(map, 1040, "Italian",    Locale.ITALIAN);
    add(map, 1043, "Dutch",      lc("nl"));
    add(map, 1046, "Portuguese", lc("pt"));
    add(map, 1053, "Swedish",    lc("sv"));
    add(map, 1030, "Danish",     lc("da"));
    add(map, 1035, "Finnish",    lc("fi"));
    // Central/Eastern European
    add(map, 1045, "Polish",     lc("pl"));
    add(map, 1029, "Czech",      lc("cs"));
    add(map, 1038, "Hungarian",  lc("hu"));
    add(map, 1050, "Croatian",   lc("hr"));
    add(map, 1051, "Slovak",     lc("sk"));
    add(map, 1060, "Slovenian",  lc("sl"));
    add(map, 1048, "Romanian",   lc("ro"));
    add(map, 1026, "Bulgarian",  lc("bg"));
    // Cyrillic
    add(map, 1049, "Russian",    lc("ru"));
    add(map, 1058, "Ukrainian",  lc("uk"));
    // Baltic
    add(map, 1061, "Estonian",   lc("et"));
    add(map, 1062, "Latvian",    lc("lv"));
    add(map, 1063, "Lithuanian", lc("lt"));
    // Turkish and related
    add(map, 1055, "Turkish",    lc("tr"));
    add(map, 1068, "Azerbaijani",lc("az"));
    // Greek
    add(map, 1032, "Greek",      lc("el"));
    // East Asian
    add(map, 1041, "Japanese",         Locale.JAPANESE);
    add(map, 1042, "Korean",           Locale.KOREAN);
    add(map, 2052, "Chinese Simplified",  Locale.SIMPLIFIED_CHINESE);
    add(map, 1028, "Chinese Traditional", Locale.TRADITIONAL_CHINESE);
    // Nordic/Romance
    add(map, 1069, "Basque",   lc("eu"));
    add(map, 1027, "Catalan",  lc("ca"));

    // Arabic and Hebrew
    add(map, 1025, "Arabic (Saudi Arabia)", lc("ar-SA"));
    add(map, 2049, "Arabic (Iraq)", lc("ar-IQ"));
    add(map, 3073, "Arabic (Egypt)", lc("ar-EG"));
    add(map, 4097, "Arabic (Libya)", lc("ar-LY"));
    add(map, 5121, "Arabic (Algeria)", lc("ar-DZ"));
    add(map, 6145, "Arabic (Morocco)", lc("ar-MA"));
    add(map, 7169, "Arabic (Tunisia)", lc("ar-TN"));
    add(map, 8193, "Arabic (Oman)", lc("ar-OM"));
    add(map, 9217, "Arabic (Yemen)", lc("ar-YE"));
    add(map, 10241, "Arabic (Syria)", lc("ar-SY"));
    add(map, 11265, "Arabic (Jordan)", lc("ar-JO"));
    add(map, 12289, "Arabic (Lebanon)", lc("ar-LB"));
    add(map, 13313, "Arabic (Kuwait)", lc("ar-KW"));
    add(map, 14337, "Arabic (United Arab Emirates)", lc("ar-AE"));
    add(map, 15361, "Arabic (Bahrain)", lc("ar-BH"));
    add(map, 1037, "Hebrew", lc("he"));
    // English
    add(map, 2057, "English (United Kingdom)", lc("en-GB"));
    add(map, 3081, "English (Australia)", lc("en-AU"));
    add(map, 4105, "English (Canada)", lc("en-CA"));
    add(map, 5129, "English (New Zealand)", lc("en-NZ"));
    add(map, 6153, "English (Ireland)", lc("en-IE"));
    add(map, 7177, "English (South Africa)", lc("en-ZA"));
    add(map, 8201, "English (Jamaica)", lc("en-JM"));
    add(map, 9225, "English (Caribbean)", lc("en-029"));
    add(map, 10249, "English (Belize)", lc("en-BZ"));
    add(map, 11273, "English (Trinidad and Tobago)", lc("en-TT"));
    add(map, 12297, "English (Zimbabwe)", lc("en-ZW"));
    add(map, 13321, "English (Philippines)", lc("en-PH"));
    // German, Dutch and the other west germanic locales
    add(map, 2055, "German (Switzerland)", lc("de-CH"));
    add(map, 3079, "German (Austria)", lc("de-AT"));
    add(map, 4103, "German (Luxembourg)", lc("de-LU"));
    add(map, 5127, "German (Liechtenstein)", lc("de-LI"));
    add(map, 2067, "Dutch (Belgium)", lc("nl-BE"));
    add(map, 1078, "Afrikaans", lc("af-ZA"));
    // French
    add(map, 2060, "French (Belgium)", lc("fr-BE"));
    add(map, 3084, "French (Canada)", lc("fr-CA"));
    add(map, 4108, "French (Switzerland)", lc("fr-CH"));
    add(map, 5132, "French (Luxembourg)", lc("fr-LU"));
    add(map, 6156, "French (Monaco)", lc("fr-MC"));
    // Spanish and Portuguese
    add(map, 1034, "Spanish (Traditional Sort)", lc("es-ES"));
    add(map, 3082, "Spanish (Modern Sort)", lc("es-ES"));
    add(map, 2058, "Spanish (Mexico)", lc("es-MX"));
    add(map, 4106, "Spanish (Guatemala)", lc("es-GT"));
    add(map, 5130, "Spanish (Costa Rica)", lc("es-CR"));
    add(map, 6154, "Spanish (Panama)", lc("es-PA"));
    add(map, 7178, "Spanish (Dominican Republic)", lc("es-DO"));
    add(map, 8202, "Spanish (Venezuela)", lc("es-VE"));
    add(map, 9226, "Spanish (Colombia)", lc("es-CO"));
    add(map, 10250, "Spanish (Peru)", lc("es-PE"));
    add(map, 11274, "Spanish (Argentina)", lc("es-AR"));
    add(map, 12298, "Spanish (Ecuador)", lc("es-EC"));
    add(map, 13322, "Spanish (Chile)", lc("es-CL"));
    add(map, 14346, "Spanish (Uruguay)", lc("es-UY"));
    add(map, 15370, "Spanish (Paraguay)", lc("es-PY"));
    add(map, 2070, "Portuguese (Portugal)", lc("pt-PT"));
    // Italian
    add(map, 2064, "Italian (Switzerland)", lc("it-CH"));
    // Nordic
    add(map, 1044, "Norwegian", lc("nb-NO"));
    add(map, 2068, "Norwegian Nynorsk", lc("nn-NO"));
    add(map, 2077, "Swedish (Finland)", lc("sv-FI"));
    add(map, 1039, "Icelandic", lc("is-IS"));
    add(map, 1080, "Faroese", lc("fo-FO"));
    // Central and eastern european
    add(map, 1052, "Albanian", lc("sq-AL"));
    add(map, 1071, "Macedonian", lc("mk-MK"));
    add(map, 2074, "Serbian (Latin)", lc("sr-Latn"));
    add(map, 3098, "Serbian (Cyrillic)", lc("sr-Cyrl"));
    add(map, 5146, "Bosnian (Latin)", lc("bs-Latn"));
    add(map, 1059, "Belarusian", lc("be-BY"));
    // Baltic
    add(map, 2087, "Lithuanian (Classic)", lc("lt-LT"));
    // Central, south and southeast asian
    add(map, 1054, "Thai", lc("th-TH"));
    add(map, 1056, "Urdu", lc("ur-PK"));
    add(map, 1057, "Indonesian", lc("id-ID"));
    add(map, 1065, "Persian", lc("fa-IR"));
    add(map, 1066, "Vietnamese", lc("vi-VN"));
    add(map, 1081, "Hindi", lc("hi-IN"));
    add(map, 1086, "Malay (Malaysia)", lc("ms-MY"));
    add(map, 2110, "Malay (Brunei)", lc("ms-BN"));
    // East asian
    add(map, 3076, "Chinese (Hong Kong)", lc("zh-HK"));
    add(map, 4100, "Chinese (Singapore)", lc("zh-SG"));
    add(map, 5124, "Chinese (Macau)", lc("zh-MO"));
    // Caucasian and african
    add(map, 1079, "Georgian", lc("ka-GE"));
    add(map, 1089, "Swahili", lc("sw-KE"));
    LCID_TO_INFO = map;
  }

  private LocaleUtil() {}

  public static LcidInfo getInfo(int localeId) {
    return LCID_TO_INFO.get(localeId);
  }

  private static Locale lc(String tag) {
    return Locale.forLanguageTag(tag);
  }

  private static void add(Map<Integer,LcidInfo> map, int lcid,
                          String name, Locale locale) {
    if(map.put(lcid, new LcidInfo(name, locale)) != null) {
      throw new IllegalStateException("duplicate locale id " + lcid);
    }
  }

  /**
   * Holds the display name and Java {@link Locale} for a Windows LCID.
   */
  public static final class LcidInfo
  {
    private final String _name;
    private final Locale _locale;

    private LcidInfo(String name, Locale locale) {
      _name = name;
      _locale = locale;
    }

    public Locale getLocale() {
      return _locale;
    }

    @Override
    public String toString() {
      return _name;
    }
  }
}