| 1 | // License: GPL. For details, see LICENSE file.
|
|---|
| 2 | package org.openstreetmap.josm.tools;
|
|---|
| 3 |
|
|---|
| 4 | import java.util.ArrayList;
|
|---|
| 5 | import java.util.List;
|
|---|
| 6 | import java.util.Locale;
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * This is a utility class that provides information about locales and allows to convert locale codes.
|
|---|
| 10 | */
|
|---|
| 11 | public final class LanguageInfo {
|
|---|
| 12 |
|
|---|
| 13 | private LanguageInfo() {
|
|---|
| 14 | // Hide default constructor for utils classes
|
|---|
| 15 | }
|
|---|
| 16 |
|
|---|
| 17 | /**
|
|---|
| 18 | * Type of the locale to use
|
|---|
| 19 | * @since 5915
|
|---|
| 20 | */
|
|---|
| 21 | public enum LocaleType {
|
|---|
| 22 | /** The current default language */
|
|---|
| 23 | DEFAULT,
|
|---|
| 24 | /** The current default language, but not english */
|
|---|
| 25 | DEFAULTNOTENGLISH,
|
|---|
| 26 | /** The base language (i.e. pt for pt_BR) */
|
|---|
| 27 | BASELANGUAGE,
|
|---|
| 28 | /** The standard english texts */
|
|---|
| 29 | ENGLISH,
|
|---|
| 30 | /** The locale prefix on the OSM wiki */
|
|---|
| 31 | OSM_WIKI,
|
|---|
| 32 | }
|
|---|
| 33 |
|
|---|
| 34 | /**
|
|---|
| 35 | * Replies the wiki language prefix for the given locale. The wiki language
|
|---|
| 36 | * prefix has the form 'Xy:' where 'Xy' is a ISO 639 language code in title
|
|---|
| 37 | * case (or Xy_AB: for sub languages).
|
|---|
| 38 | *
|
|---|
| 39 | * @param type the type
|
|---|
| 40 | * @return the wiki language prefix or {@code null} for {@link LocaleType#BASELANGUAGE}, when
|
|---|
| 41 | * base language is identical to default or english
|
|---|
| 42 | * @since 5915
|
|---|
| 43 | */
|
|---|
| 44 | public static String getWikiLanguagePrefix(LocaleType type) {
|
|---|
| 45 | return getWikiLanguagePrefix(Locale.getDefault(), type);
|
|---|
| 46 | }
|
|---|
| 47 |
|
|---|
| 48 | static String getWikiLanguagePrefix(Locale locale, LocaleType type) {
|
|---|
| 49 | if (type == LocaleType.ENGLISH) {
|
|---|
| 50 | return "";
|
|---|
| 51 | } else if (type == LocaleType.OSM_WIKI && Locale.ENGLISH.getLanguage().equals(locale.getLanguage())) {
|
|---|
| 52 | return "";
|
|---|
| 53 | } else if (type == LocaleType.OSM_WIKI && Locale.SIMPLIFIED_CHINESE.equals(locale)) {
|
|---|
| 54 | return "Zh-hans:";
|
|---|
| 55 | } else if (type == LocaleType.OSM_WIKI && Locale.TRADITIONAL_CHINESE.equals(locale)) {
|
|---|
| 56 | return "Zh-hant:";
|
|---|
| 57 | }
|
|---|
| 58 |
|
|---|
| 59 | String code = getJOSMLocaleCode(locale);
|
|---|
| 60 |
|
|---|
| 61 | if (type == LocaleType.OSM_WIKI) {
|
|---|
| 62 | if (code.matches("[^_@]+[_@][^_]+")) {
|
|---|
| 63 | code = code.substring(0, 2);
|
|---|
| 64 | if ("en".equals(code)) {
|
|---|
| 65 | return "";
|
|---|
| 66 | }
|
|---|
| 67 | }
|
|---|
| 68 | switch (code) {
|
|---|
| 69 | case "nb": /* OSM-Wiki has "no", but no "nb" */
|
|---|
| 70 | return "No:";
|
|---|
| 71 | case "sr@latin": /* OSM-Wiki has "Sr-latn" and not Sr-latin */
|
|---|
| 72 | return "Sr-latn:";
|
|---|
| 73 | case "de":
|
|---|
| 74 | case "es":
|
|---|
| 75 | case "fr":
|
|---|
| 76 | case "it":
|
|---|
| 77 | case "nl":
|
|---|
| 78 | case "ru":
|
|---|
| 79 | case "ja":
|
|---|
| 80 | return code.toUpperCase(Locale.ENGLISH) + ":";
|
|---|
| 81 | default:
|
|---|
| 82 | return code.substring(0, 1).toUpperCase(Locale.ENGLISH) + code.substring(1) + ":";
|
|---|
| 83 | }
|
|---|
| 84 | }
|
|---|
| 85 |
|
|---|
| 86 | if (type == LocaleType.BASELANGUAGE) {
|
|---|
| 87 | if (code.matches("[^_]+_[^_]+")) {
|
|---|
| 88 | code = code.substring(0, 2);
|
|---|
| 89 | if ("en".equals(code))
|
|---|
| 90 | return null;
|
|---|
| 91 | } else {
|
|---|
| 92 | return null;
|
|---|
| 93 | }
|
|---|
| 94 | } else if (type == LocaleType.DEFAULTNOTENGLISH && "en".equals(code)) {
|
|---|
| 95 | return null;
|
|---|
| 96 | } else if (code.matches(".+@.+")) {
|
|---|
| 97 | return code.substring(0, 1).toUpperCase(Locale.ENGLISH)
|
|---|
| 98 | + code.substring(1, 2)
|
|---|
| 99 | + '-'
|
|---|
| 100 | + code.substring(3, 4).toUpperCase(Locale.ENGLISH)
|
|---|
| 101 | + code.substring(4)
|
|---|
| 102 | + ':';
|
|---|
| 103 | }
|
|---|
| 104 | return code.substring(0, 1).toUpperCase(Locale.ENGLISH) + code.substring(1) + ':';
|
|---|
| 105 | }
|
|---|
| 106 |
|
|---|
| 107 | /**
|
|---|
| 108 | * Replies the wiki language prefix for the current locale.
|
|---|
| 109 | *
|
|---|
| 110 | * @return the wiki language prefix
|
|---|
| 111 | * @see Locale#getDefault()
|
|---|
| 112 | * @see #getWikiLanguagePrefix(LocaleType)
|
|---|
| 113 | */
|
|---|
| 114 | public static String getWikiLanguagePrefix() {
|
|---|
| 115 | return getWikiLanguagePrefix(LocaleType.DEFAULT);
|
|---|
| 116 | }
|
|---|
| 117 |
|
|---|
| 118 | /**
|
|---|
| 119 | * Replies the JOSM locale code for the default locale.
|
|---|
| 120 | *
|
|---|
| 121 | * @return the JOSM locale code for the default locale
|
|---|
| 122 | * @see #getJOSMLocaleCode(Locale)
|
|---|
| 123 | */
|
|---|
| 124 | public static String getJOSMLocaleCode() {
|
|---|
| 125 | return getJOSMLocaleCode(Locale.getDefault());
|
|---|
| 126 | }
|
|---|
| 127 |
|
|---|
| 128 | /**
|
|---|
| 129 | * Replies the locale code used by JOSM for a given locale.
|
|---|
| 130 | *
|
|---|
| 131 | * In most cases JOSM uses the 2-character ISO 639 language code ({@link Locale#getLanguage()}
|
|---|
| 132 | * to identify the locale of a localized resource, but in some cases it may use the
|
|---|
| 133 | * programmatic name for locales, as replied by {@link Locale#toString()}.
|
|---|
| 134 | *
|
|---|
| 135 | * For unknown country codes and variants this function already does fallback to
|
|---|
| 136 | * internally known translations.
|
|---|
| 137 | *
|
|---|
| 138 | * @param locale the locale. Replies "en" if null.
|
|---|
| 139 | * @return the JOSM code for the given locale
|
|---|
| 140 | */
|
|---|
| 141 | public static String getJOSMLocaleCode(Locale locale) {
|
|---|
| 142 | if (locale == null) return "en";
|
|---|
| 143 | for (String full : getLanguageCodes(locale)) {
|
|---|
| 144 | if ("iw_IL".equals(full))
|
|---|
| 145 | return "he";
|
|---|
| 146 | else if ("in".equals(full))
|
|---|
| 147 | return "id";
|
|---|
| 148 | else if (I18n.hasCode(full)) // catch all non-single codes
|
|---|
| 149 | return full;
|
|---|
| 150 | }
|
|---|
| 151 |
|
|---|
| 152 | // return single code as fallback
|
|---|
| 153 | return locale.getLanguage();
|
|---|
| 154 | }
|
|---|
| 155 |
|
|---|
| 156 | /**
|
|---|
| 157 | * Replies the OSM locale codes for the default locale.
|
|---|
| 158 | *
|
|---|
| 159 | * @return the OSM locale codes for the default locale
|
|---|
| 160 | * @see #getOSMLocaleCodes(String, Locale)
|
|---|
| 161 | * @since 19045
|
|---|
| 162 | */
|
|---|
| 163 | public static String[] getOSMLocaleCodes(String prefix) {
|
|---|
| 164 | return getOSMLocaleCodes(prefix, Locale.getDefault());
|
|---|
| 165 | }
|
|---|
| 166 |
|
|---|
| 167 | /**
|
|---|
| 168 | * Replies the locale codes used by OSM for a given locale.
|
|---|
| 169 | *
|
|---|
| 170 | * In most cases OSM uses the 2-character ISO 639 language code ({@link Locale#getLanguage()}
|
|---|
| 171 | * to identify the locale of a localized resource, but in some cases it may use the
|
|---|
| 172 | * programmatic name for locales, as replied by {@link Locale#toString()}.
|
|---|
| 173 | *
|
|---|
| 174 | * For unknown country codes and variants this function already does fallback to
|
|---|
| 175 | * internally known translations.
|
|---|
| 176 | *
|
|---|
| 177 | * @param prefix a prefix like {@code name:}.
|
|---|
| 178 | * @param locale the locale. Replies "en" if null.
|
|---|
| 179 | * @return the OSM codes for the given locale
|
|---|
| 180 | * @since 19045
|
|---|
| 181 | */
|
|---|
| 182 | public static String[] getOSMLocaleCodes(String prefix, Locale locale) {
|
|---|
| 183 | if (prefix == null) {
|
|---|
| 184 | prefix = "";
|
|---|
| 185 | }
|
|---|
| 186 | String main = getJOSMLocaleCode(locale);
|
|---|
| 187 | switch (main) {
|
|---|
| 188 | case "zh_CN":
|
|---|
| 189 | return new String[]{prefix+"zh-Hans-CN", prefix+"zh-Hans", prefix+"zh"};
|
|---|
| 190 | case "zh_TW":
|
|---|
| 191 | return new String[]{prefix+"zh-Hant-TW", prefix+"zh-Hant", prefix+"zh"};
|
|---|
| 192 | default:
|
|---|
| 193 | var r = new ArrayList<String>();
|
|---|
| 194 | for (String s : LanguageInfo.getLanguageCodes(null)) {
|
|---|
| 195 | r.add(prefix + s);
|
|---|
| 196 | }
|
|---|
| 197 | return r.toArray(String[]::new);
|
|---|
| 198 | }
|
|---|
| 199 | }
|
|---|
| 200 |
|
|---|
| 201 | /**
|
|---|
| 202 | * Replies the locale code used by Java for a given locale.
|
|---|
| 203 | *
|
|---|
| 204 | * In most cases JOSM and Java uses the same codes, but for some exceptions this is needed.
|
|---|
| 205 | *
|
|---|
| 206 | * @param localeName the locale. Replies "en" if null.
|
|---|
| 207 | * @return the Java code for the given locale
|
|---|
| 208 | * @since 8232
|
|---|
| 209 | */
|
|---|
| 210 | public static String getJavaLocaleCode(String localeName) {
|
|---|
| 211 | if (localeName == null) return "en";
|
|---|
| 212 | switch (localeName) {
|
|---|
| 213 | case "ca@valencia":
|
|---|
| 214 | return "ca__valencia";
|
|---|
| 215 | case "sr@latin":
|
|---|
| 216 | return "sr__latin";
|
|---|
| 217 | case "he":
|
|---|
| 218 | return "iw_IL";
|
|---|
| 219 | case "id":
|
|---|
| 220 | return "in";
|
|---|
| 221 | }
|
|---|
| 222 | return localeName;
|
|---|
| 223 | }
|
|---|
| 224 |
|
|---|
| 225 | /**
|
|---|
| 226 | * Replies the display string used by JOSM for a given locale.
|
|---|
| 227 | *
|
|---|
| 228 | * In most cases returns text replied by {@link Locale#getDisplayName()}, for some
|
|---|
| 229 | * locales an override is used (i.e. when unsupported by Java).
|
|---|
| 230 | *
|
|---|
| 231 | * @param locale the locale. Replies "en" if null.
|
|---|
| 232 | * @return the display string for the given locale
|
|---|
| 233 | * @since 8232
|
|---|
| 234 | */
|
|---|
| 235 | public static String getDisplayName(Locale locale) {
|
|---|
| 236 | String currentCountry = Locale.getDefault().getCountry();
|
|---|
| 237 | String localeCountry = locale.getCountry();
|
|---|
| 238 | // Don't display locale country if country has been forced to current country at JOSM startup
|
|---|
| 239 | if (currentCountry.equals(localeCountry) && !I18n.hasCode(getLanguageCodes(locale).get(0))) {
|
|---|
| 240 | return new Locale(locale.getLanguage(), "", locale.getVariant()).getDisplayName();
|
|---|
| 241 | }
|
|---|
| 242 | return locale.getDisplayName();
|
|---|
| 243 | }
|
|---|
| 244 |
|
|---|
| 245 | /**
|
|---|
| 246 | * Replies the locale used by Java for a given language code.
|
|---|
| 247 | *
|
|---|
| 248 | * Accepts JOSM and Java codes as input.
|
|---|
| 249 | *
|
|---|
| 250 | * @param localeName the locale code.
|
|---|
| 251 | * @return the resulting locale
|
|---|
| 252 | */
|
|---|
| 253 | public static Locale getLocale(String localeName) {
|
|---|
| 254 | return getLocale(localeName, false);
|
|---|
| 255 | }
|
|---|
| 256 |
|
|---|
| 257 | /**
|
|---|
| 258 | * Replies the locale used by Java for a given language code.
|
|---|
| 259 | *
|
|---|
| 260 | * Accepts JOSM, Java and POSIX codes as input.
|
|---|
| 261 | *
|
|---|
| 262 | * @param localeName the locale code.
|
|---|
| 263 | * @param useDefaultCountry if {@code true}, the current locale country will be used if no country is specified
|
|---|
| 264 | * @return the resulting locale
|
|---|
| 265 | * @since 15547
|
|---|
| 266 | */
|
|---|
| 267 | public static Locale getLocale(String localeName, boolean useDefaultCountry) {
|
|---|
| 268 | final int encoding = localeName.indexOf('.');
|
|---|
| 269 | if (encoding > 0) {
|
|---|
| 270 | localeName = localeName.substring(0, encoding);
|
|---|
| 271 | }
|
|---|
| 272 | int country = localeName.indexOf('_');
|
|---|
| 273 | int variant = localeName.indexOf('@');
|
|---|
| 274 | if (variant < 0 && country >= 0)
|
|---|
| 275 | variant = localeName.indexOf('_', country+1);
|
|---|
| 276 | Locale l;
|
|---|
| 277 | if (variant > 0 && country > 0) {
|
|---|
| 278 | l = new Locale(localeName.substring(0, country), localeName.substring(country+1, variant), localeName.substring(variant + 1));
|
|---|
| 279 | } else if (variant > 0) {
|
|---|
| 280 | l = new Locale(localeName.substring(0, variant), "", localeName.substring(variant + 1));
|
|---|
| 281 | } else if (country > 0) {
|
|---|
| 282 | l = new Locale(localeName.substring(0, country), localeName.substring(country + 1));
|
|---|
| 283 | } else {
|
|---|
| 284 | l = new Locale(localeName, useDefaultCountry ? Locale.getDefault().getCountry() : "");
|
|---|
| 285 | }
|
|---|
| 286 | return l;
|
|---|
| 287 | }
|
|---|
| 288 |
|
|---|
| 289 | /**
|
|---|
| 290 | * Check if a new language is better than a previous existing. Can be used in classes where
|
|---|
| 291 | * multiple user supplied language marked strings appear and the best one is searched. Following
|
|---|
| 292 | * priorities: current language, english, any other
|
|---|
| 293 | *
|
|---|
| 294 | * @param oldLanguage the language code of the existing string
|
|---|
| 295 | * @param newLanguage the language code of the new string
|
|---|
| 296 | * @return true if new one is better
|
|---|
| 297 | * @since 8091
|
|---|
| 298 | */
|
|---|
| 299 | public static boolean isBetterLanguage(String oldLanguage, String newLanguage) {
|
|---|
| 300 | if (oldLanguage == null)
|
|---|
| 301 | return true;
|
|---|
| 302 | String want = getJOSMLocaleCode();
|
|---|
| 303 | return want.equals(newLanguage) || (!want.equals(oldLanguage) && newLanguage.startsWith("en"));
|
|---|
| 304 | }
|
|---|
| 305 |
|
|---|
| 306 | /**
|
|---|
| 307 | * Replies the language prefix for use in XML elements (with a dot appended).
|
|---|
| 308 | *
|
|---|
| 309 | * @return the XML language prefix
|
|---|
| 310 | * @see #getJOSMLocaleCode()
|
|---|
| 311 | */
|
|---|
| 312 | public static String getLanguageCodeXML() {
|
|---|
| 313 | String code = getJOSMLocaleCode();
|
|---|
| 314 | code = code.replace('@', '-');
|
|---|
| 315 | return code+'.';
|
|---|
| 316 | }
|
|---|
| 317 |
|
|---|
| 318 | /**
|
|---|
| 319 | * Replies the language prefix for use in manifests (with an underscore appended).
|
|---|
| 320 | *
|
|---|
| 321 | * @return the manifest language prefix
|
|---|
| 322 | * @see #getJOSMLocaleCode()
|
|---|
| 323 | */
|
|---|
| 324 | public static String getLanguageCodeManifest() {
|
|---|
| 325 | String code = getJOSMLocaleCode();
|
|---|
| 326 | code = code.replace('@', '-');
|
|---|
| 327 | return code+'_';
|
|---|
| 328 | }
|
|---|
| 329 |
|
|---|
| 330 | /**
|
|---|
| 331 | * Replies a list of language codes for local names. Prefixes range from very specific
|
|---|
| 332 | * to more generic.
|
|---|
| 333 | * <ul>
|
|---|
| 334 | * <li>lang_COUNTRY@variant of the current locale</li>
|
|---|
| 335 | * <li>lang@variant of the current locale</li>
|
|---|
| 336 | * <li>lang_COUNTRY of the current locale</li>
|
|---|
| 337 | * <li>lang of the current locale</li>
|
|---|
| 338 | * </ul>
|
|---|
| 339 | *
|
|---|
| 340 | * @param l the locale to use, <code>null</code> for default locale
|
|---|
| 341 | * @return list of codes
|
|---|
| 342 | * @since 8283
|
|---|
| 343 | */
|
|---|
| 344 | public static List<String> getLanguageCodes(Locale l) {
|
|---|
| 345 | List<String> list = new ArrayList<>(4);
|
|---|
| 346 | if (l == null)
|
|---|
| 347 | l = Locale.getDefault();
|
|---|
| 348 | String lang = l.getLanguage();
|
|---|
| 349 | String c = l.getCountry();
|
|---|
| 350 | String v = l.getVariant();
|
|---|
| 351 | if (c.isEmpty())
|
|---|
| 352 | c = null;
|
|---|
| 353 | if (!Utils.isEmpty(v)) {
|
|---|
| 354 | if (c != null)
|
|---|
| 355 | list.add(lang+'_'+c+'@'+v);
|
|---|
| 356 | list.add(lang+'@'+v);
|
|---|
| 357 | }
|
|---|
| 358 | if (c != null)
|
|---|
| 359 | list.add(lang+'_'+c);
|
|---|
| 360 | list.add(lang);
|
|---|
| 361 | return list;
|
|---|
| 362 | }
|
|---|
| 363 | }
|
|---|
