aboutsummaryrefslogtreecommitdiffstats
path: root/java/src/com/android/inputmethod/latin/Dictionary.java
diff options
context:
space:
mode:
authorAmin Bandali <bandali@kelar.org>2024-12-16 21:45:41 -0500
committerAmin Bandali <bandali@kelar.org>2025-01-11 14:17:35 -0500
commite9a0e66716dab4dd3184d009d8920de1961efdfa (patch)
tree02dcc096643d74645bf28459c2834c3d4a2ad7f2 /java/src/com/android/inputmethod/latin/Dictionary.java
parentfb3b9360d70596d7e921de8bf7d3ca99564a077e (diff)
downloadlatinime-e9a0e66716dab4dd3184d009d8920de1961efdfa.tar.gz
latinime-e9a0e66716dab4dd3184d009d8920de1961efdfa.tar.xz
latinime-e9a0e66716dab4dd3184d009d8920de1961efdfa.zip
Rename to Kelar Keyboard (org.kelar.inputmethod.latin)
Diffstat (limited to 'java/src/com/android/inputmethod/latin/Dictionary.java')
-rw-r--r--java/src/com/android/inputmethod/latin/Dictionary.java216
1 files changed, 0 insertions, 216 deletions
diff --git a/java/src/com/android/inputmethod/latin/Dictionary.java b/java/src/com/android/inputmethod/latin/Dictionary.java
deleted file mode 100644
index e00219c98..000000000
--- a/java/src/com/android/inputmethod/latin/Dictionary.java
+++ /dev/null
@@ -1,216 +0,0 @@
-/*
- * Copyright (C) 2008 The Android Open Source Project
- *
- * 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.android.inputmethod.latin;
-
-import com.android.inputmethod.annotations.UsedForTesting;
-import com.android.inputmethod.latin.SuggestedWords.SuggestedWordInfo;
-import com.android.inputmethod.latin.common.ComposedData;
-import com.android.inputmethod.latin.settings.SettingsValuesForSuggestion;
-
-import java.util.ArrayList;
-import java.util.Locale;
-import java.util.Arrays;
-import java.util.HashSet;
-
-/**
- * Abstract base class for a dictionary that can do a fuzzy search for words based on a set of key
- * strokes.
- */
-public abstract class Dictionary {
- public static final int NOT_A_PROBABILITY = -1;
- public static final float NOT_A_WEIGHT_OF_LANG_MODEL_VS_SPATIAL_MODEL = -1.0f;
-
- // The following types do not actually come from real dictionary instances, so we create
- // corresponding instances.
- public static final String TYPE_USER_TYPED = "user_typed";
- public static final PhonyDictionary DICTIONARY_USER_TYPED = new PhonyDictionary(TYPE_USER_TYPED);
-
- public static final String TYPE_USER_SHORTCUT = "user_shortcut";
- public static final PhonyDictionary DICTIONARY_USER_SHORTCUT =
- new PhonyDictionary(TYPE_USER_SHORTCUT);
-
- public static final String TYPE_APPLICATION_DEFINED = "application_defined";
- public static final PhonyDictionary DICTIONARY_APPLICATION_DEFINED =
- new PhonyDictionary(TYPE_APPLICATION_DEFINED);
-
- public static final String TYPE_HARDCODED = "hardcoded"; // punctuation signs and such
- public static final PhonyDictionary DICTIONARY_HARDCODED =
- new PhonyDictionary(TYPE_HARDCODED);
-
- // Spawned by resuming suggestions. Comes from a span that was in the TextView.
- public static final String TYPE_RESUMED = "resumed";
- public static final PhonyDictionary DICTIONARY_RESUMED = new PhonyDictionary(TYPE_RESUMED);
-
- // The following types of dictionary have actual functional instances. We don't need final
- // phony dictionary instances for them.
- public static final String TYPE_MAIN = "main";
- public static final String TYPE_CONTACTS = "contacts";
- // User dictionary, the system-managed one.
- public static final String TYPE_USER = "user";
- // User history dictionary internal to LatinIME.
- public static final String TYPE_USER_HISTORY = "history";
- public final String mDictType;
- // The locale for this dictionary. May be null if unknown (phony dictionary for example).
- public final Locale mLocale;
-
- /**
- * Set out of the dictionary types listed above that are based on data specific to the user,
- * e.g., the user's contacts.
- */
- private static final HashSet<String> sUserSpecificDictionaryTypes = new HashSet<>(Arrays.asList(
- TYPE_USER_TYPED,
- TYPE_USER,
- TYPE_CONTACTS,
- TYPE_USER_HISTORY));
-
- public Dictionary(final String dictType, final Locale locale) {
- mDictType = dictType;
- mLocale = locale;
- }
-
- /**
- * Searches for suggestions for a given context.
- * @param composedData the key sequence to match with coordinate info
- * @param ngramContext the context for n-gram.
- * @param proximityInfoHandle the handle for key proximity. Is ignored by some implementations.
- * @param settingsValuesForSuggestion the settings values used for the suggestion.
- * @param sessionId the session id.
- * @param weightForLocale the weight given to this locale, to multiply the output scores for
- * multilingual input.
- * @param inOutWeightOfLangModelVsSpatialModel the weight of the language model as a ratio of
- * the spatial model, used for generating suggestions. inOutWeightOfLangModelVsSpatialModel is
- * a float array that has only one element. This can be updated when a different value is used.
- * @return the list of suggestions (possibly null if none)
- */
- abstract public ArrayList<SuggestedWordInfo> getSuggestions(final ComposedData composedData,
- final NgramContext ngramContext, final long proximityInfoHandle,
- final SettingsValuesForSuggestion settingsValuesForSuggestion,
- final int sessionId, final float weightForLocale,
- final float[] inOutWeightOfLangModelVsSpatialModel);
-
- /**
- * Checks if the given word has to be treated as a valid word. Please note that some
- * dictionaries have entries that should be treated as invalid words.
- * @param word the word to search for. The search should be case-insensitive.
- * @return true if the word is valid, false otherwise
- */
- public boolean isValidWord(final String word) {
- return isInDictionary(word);
- }
-
- /**
- * Checks if the given word is in the dictionary regardless of it being valid or not.
- */
- abstract public boolean isInDictionary(final String word);
-
- /**
- * Get the frequency of the word.
- * @param word the word to get the frequency of.
- */
- public int getFrequency(final String word) {
- return NOT_A_PROBABILITY;
- }
-
- /**
- * Get the maximum frequency of the word.
- * @param word the word to get the maximum frequency of.
- */
- public int getMaxFrequencyOfExactMatches(final String word) {
- return NOT_A_PROBABILITY;
- }
-
- /**
- * Compares the contents of the character array with the typed word and returns true if they
- * are the same.
- * @param word the array of characters that make up the word
- * @param length the number of valid characters in the character array
- * @param typedWord the word to compare with
- * @return true if they are the same, false otherwise.
- */
- protected boolean same(final char[] word, final int length, final String typedWord) {
- if (typedWord.length() != length) {
- return false;
- }
- for (int i = 0; i < length; i++) {
- if (word[i] != typedWord.charAt(i)) {
- return false;
- }
- }
- return true;
- }
-
- /**
- * Override to clean up any resources.
- */
- public void close() {
- // empty base implementation
- }
-
- /**
- * Subclasses may override to indicate that this Dictionary is not yet properly initialized.
- */
- public boolean isInitialized() {
- return true;
- }
-
- /**
- * Whether we think this suggestion should trigger an auto-commit. prevWord is the word
- * before the suggestion, so that we can use n-gram frequencies.
- * @param candidate The candidate suggestion, in whole (not only the first part).
- * @return whether we should auto-commit or not.
- */
- public boolean shouldAutoCommit(final SuggestedWordInfo candidate) {
- // If we don't have support for auto-commit, or if we don't know, we return false to
- // avoid auto-committing stuff. Implementations of the Dictionary class that know to
- // determine whether we should auto-commit will override this.
- return false;
- }
-
- /**
- * Whether this dictionary is based on data specific to the user, e.g., the user's contacts.
- * @return Whether this dictionary is specific to the user.
- */
- public boolean isUserSpecific() {
- return sUserSpecificDictionaryTypes.contains(mDictType);
- }
-
- /**
- * Not a true dictionary. A placeholder used to indicate suggestions that don't come from any
- * real dictionary.
- */
- @UsedForTesting
- static class PhonyDictionary extends Dictionary {
- @UsedForTesting
- PhonyDictionary(final String type) {
- super(type, null);
- }
-
- @Override
- public ArrayList<SuggestedWordInfo> getSuggestions(final ComposedData composedData,
- final NgramContext ngramContext, final long proximityInfoHandle,
- final SettingsValuesForSuggestion settingsValuesForSuggestion,
- final int sessionId, final float weightForLocale,
- final float[] inOutWeightOfLangModelVsSpatialModel) {
- return null;
- }
-
- @Override
- public boolean isInDictionary(String word) {
- return false;
- }
- }
-}