1102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa/* 2102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * Copyright (C) 2016 The Android Open Source Project 3102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * 4102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * Licensed under the Apache License, Version 2.0 (the "License"); 5102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * you may not use this file except in compliance with the License. 6102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * You may obtain a copy of the License at 7102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * 8102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * http://www.apache.org/licenses/LICENSE-2.0 9102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * 10102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * Unless required by applicable law or agreed to in writing, software 11102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * distributed under the License is distributed on an "AS IS" BASIS, 12102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * See the License for the specific language governing permissions and 14102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * limitations under the License. 15102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa */ 16102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 17102ff0726dad764df741e41766d78fcfb829184aYohei Yukawapackage com.android.internal.inputmethod; 18102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 19102ff0726dad764df741e41766d78fcfb829184aYohei Yukawaimport com.android.internal.annotations.VisibleForTesting; 20102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 21072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonakaimport android.annotation.IntRange; 22102ff0726dad764df741e41766d78fcfb829184aYohei Yukawaimport android.annotation.NonNull; 23102ff0726dad764df741e41766d78fcfb829184aYohei Yukawaimport android.annotation.Nullable; 24072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonakaimport android.icu.util.ULocale; 2523cbe85610f780134cc77dd4a54732a22ed6e86eYohei Yukawaimport android.os.LocaleList; 26dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawaimport android.text.TextUtils; 27102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 28102ff0726dad764df741e41766d78fcfb829184aYohei Yukawaimport java.util.ArrayList; 29072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonakaimport java.util.Arrays; 30072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonakaimport java.util.HashMap; 31102ff0726dad764df741e41766d78fcfb829184aYohei Yukawaimport java.util.List; 32102ff0726dad764df741e41766d78fcfb829184aYohei Yukawaimport java.util.Locale; 33102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 34102ff0726dad764df741e41766d78fcfb829184aYohei Yukawapublic final class LocaleUtils { 35102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 36102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa @VisibleForTesting 37102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa public interface LocaleExtractor<T> { 38102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa @Nullable 39102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa Locale get(@Nullable T source); 40102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa } 41102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 42072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka /** 43072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * Calculates a matching score for the single desired locale. 44072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * 45dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa * @see LocaleUtils#filterByLanguage(List, LocaleExtractor, LocaleList, ArrayList) 46072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * 47072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * @param supported The locale supported by IME subtype. 48072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * @param desired The locale preferred by user. 49072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * @return A score based on the locale matching for the default subtype enabling. 50072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka */ 51072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka @IntRange(from=1, to=3) 52072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka private static byte calculateMatchingSubScore(@NonNull final ULocale supported, 53072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka @NonNull final ULocale desired) { 54072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka // Assuming supported/desired is fully expanded. 55072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka if (supported.equals(desired)) { 56072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return 3; // Exact match. 57072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 58072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 59072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka // Skip language matching since it was already done in calculateMatchingScore. 60072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 61072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final String supportedScript = supported.getScript(); 62072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka if (supportedScript.isEmpty() || !supportedScript.equals(desired.getScript())) { 63072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka // TODO: Need subscript matching. For example, Hanb should match with Bopo. 64072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return 1; 65072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 66072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 67072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final String supportedCountry = supported.getCountry(); 68072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka if (supportedCountry.isEmpty() || !supportedCountry.equals(desired.getCountry())) { 69072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return 2; 70072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 71072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 72072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka // Ignore others e.g. variants, extensions. 73072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return 3; 74072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 75072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 76072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka private static final class ScoreEntry implements Comparable<ScoreEntry> { 77072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka public int mIndex = -1; 78072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka @NonNull public final byte[] mScore; // matching score of the i-th system languages. 79072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 80072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka ScoreEntry(@NonNull byte[] score, int index) { 81072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka mScore = new byte[score.length]; 82072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka set(score, index); 83072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 84072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 85072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka private void set(@NonNull byte[] score, int index) { 86072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka for (int i = 0; i < mScore.length; ++i) { 87072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka mScore[i] = score[i]; 88072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 89072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka mIndex = index; 90072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 91072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 92072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka /** 93072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * Update score and index if the given score is better than this. 94072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka */ 95072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka public void updateIfBetter(@NonNull byte[] score, int index) { 96072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka if (compare(mScore, score) == -1) { // mScore < score 97072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka set(score, index); 98072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 99072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 100072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 101072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka /** 102072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * Provides comaprison for bytes[]. 103072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * 104072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * <p> Comparison does as follows. If the first value of {@code left} is larger than the 105072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * first value of {@code right}, {@code left} is large than {@code right}. If the first 106072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * value of {@code left} is less than the first value of {@code right}, {@code left} is less 107072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * than {@code right}. If the first value of {@code left} and the first value of 108072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * {@code right} is equal, do the same comparison to the next value. Finally if all values 109072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * in {@code left} and {@code right} are equal, {@code left} and {@code right} is equal.</p> 110072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * 111072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * @param left The length must be equal to {@code right}. 112072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * @param right The length must be equal to {@code left}. 113072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * @return 1 if {@code left} is larger than {@code right}. -1 if {@code left} is less than 114072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * {@code right}. 0 if {@code left} and {@code right} is equal. 115072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka */ 116072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka @IntRange(from=-1, to=1) 117072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka private static int compare(@NonNull byte[] left, @NonNull byte[] right) { 118072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka for (int i = 0; i < left.length; ++i) { 119072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka if (left[i] > right[i]) { 120072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return 1; 121072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } else if (left[i] < right[i]) { 122072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return -1; 123072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 124072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 125072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return 0; 126072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 127072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka 128072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka @Override 129072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka public int compareTo(final ScoreEntry other) { 130072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka return -1 * compare(mScore, other.mScore); // Order by descending order. 131102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa } 132102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa } 133102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 134102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa /** 135102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * Filters the given items based on language preferences. 136102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * 137dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa * <p>For each language found in {@code preferredLocales}, this method tries to copy at most 138102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * one best-match item from {@code source} to {@code dest}. For example, if 139dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa * {@code "en-GB", "ja", "en-AU", "fr-CA", "en-IN"} is specified to {@code preferredLocales}, 140102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * this method tries to copy at most one English locale, at most one Japanese, and at most one 141102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * French locale from {@code source} to {@code dest}. Here the best matching English locale 142072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka * will be searched from {@code source} based on matching score. For the score design, see 143dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa * {@link LocaleUtils#calculateMatchingSubScore(ULocale, ULocale)}</p> 144102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * 145102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * @param sources Source items to be filtered. 146102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * @param extractor Type converter from the source items to {@link Locale} object. 147dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa * @param preferredLocales Ordered list of locales with which the input items will be 148102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * filtered. 149102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * @param dest Destination into which the filtered items will be added. 150102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa * @param <T> Type of the data items. 151102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa */ 152102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa @VisibleForTesting 153102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa public static <T> void filterByLanguage( 154102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa @NonNull List<T> sources, 155102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa @NonNull LocaleExtractor<T> extractor, 156dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa @NonNull LocaleList preferredLocales, 157102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa @NonNull ArrayList<T> dest) { 158dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa if (preferredLocales.isEmpty()) { 159dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa return; 160dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa } 161dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa 162dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa final int numPreferredLocales = preferredLocales.size(); 163072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final HashMap<String, ScoreEntry> scoreboard = new HashMap<>(); 164dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa final byte[] score = new byte[numPreferredLocales]; 165dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa final ULocale[] preferredULocaleCache = new ULocale[numPreferredLocales]; 16677dd59fc2a0db94f0c58e17097fd6f07c1b5db8cYohei Yukawa 167072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final int sourceSize = sources.size(); 168072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka for (int i = 0; i < sourceSize; ++i) { 169072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final Locale locale = extractor.get(sources.get(i)); 170dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa if (locale == null) { 171dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa continue; 172dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa } 173dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa 174dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa boolean canSkip = true; 175dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa for (int j = 0; j < numPreferredLocales; ++j) { 176dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa final Locale preferredLocale = preferredLocales.get(j); 177dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa if (!TextUtils.equals(locale.getLanguage(), preferredLocale.getLanguage())) { 178dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa score[j] = 0; 179dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa continue; 180dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa } 181dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa if (preferredULocaleCache[j] == null) { 182dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa preferredULocaleCache[j] = ULocale.addLikelySubtags( 183dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa ULocale.forLocale(preferredLocale)); 184dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa } 185dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa score[j] = calculateMatchingSubScore( 186dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa preferredULocaleCache[j], 187dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa ULocale.addLikelySubtags(ULocale.forLocale(locale))); 188dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa if (canSkip && score[j] != 0) { 189dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa canSkip = false; 190dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa } 191dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa } 192dce7df3ec23788d002a8696229483f71b19b9d6bYohei Yukawa if (canSkip) { 193072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka continue; 194102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa } 195102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa 196072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final String lang = locale.getLanguage(); 197072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final ScoreEntry bestScore = scoreboard.get(lang); 198072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka if (bestScore == null) { 199072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka scoreboard.put(lang, new ScoreEntry(score, i)); 200072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } else { 201072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka bestScore.updateIfBetter(score, i); 20277dd59fc2a0db94f0c58e17097fd6f07c1b5db8cYohei Yukawa } 203072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka } 2049e7a1c9824cffca32fd7d58bb13bd3416ab32091Seigo Nonaka 205072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka final ScoreEntry[] result = scoreboard.values().toArray(new ScoreEntry[scoreboard.size()]); 206072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka Arrays.sort(result); 207072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka for (final ScoreEntry entry : result) { 208072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka dest.add(sources.get(entry.mIndex)); 209102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa } 210102ff0726dad764df741e41766d78fcfb829184aYohei Yukawa } 211072a95a3094af2ced4f009ad62c4553c28e3f830Seigo Nonaka} 212