BinaryDictionary.java revision 6931df9c17aaeb04288f937cabf956c1b9eb0cc9
1/* 2 * Copyright (C) 2008 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 * use this file except in compliance with the License. You may obtain a copy of 6 * the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 * License for the specific language governing permissions and limitations under 14 * the License. 15 */ 16 17package com.android.inputmethod.latin; 18 19import android.content.Context; 20import android.text.TextUtils; 21 22import com.android.inputmethod.keyboard.ProximityInfo; 23import com.android.inputmethod.latin.SuggestedWords.SuggestedWordInfo; 24 25import java.util.ArrayList; 26import java.util.Arrays; 27import java.util.Locale; 28 29/** 30 * Implements a static, compacted, binary dictionary of standard words. 31 */ 32public class BinaryDictionary extends Dictionary { 33 34 public static final String DICTIONARY_PACK_AUTHORITY = 35 "com.android.inputmethod.latin.dictionarypack"; 36 37 /** 38 * There is a difference between what java and native code can handle. 39 * This value should only be used in BinaryDictionary.java 40 * It is necessary to keep it at this value because some languages e.g. German have 41 * really long words. 42 */ 43 public static final int MAX_WORD_LENGTH = 48; 44 public static final int MAX_WORDS = 18; 45 public static final int MAX_SPACES = 16; 46 47 private static final String TAG = "BinaryDictionary"; 48 private static final int MAX_PREDICTIONS = 60; 49 private static final int MAX_RESULTS = Math.max(MAX_PREDICTIONS, MAX_WORDS); 50 51 private static final int TYPED_LETTER_MULTIPLIER = 2; 52 53 private long mNativeDict; 54 private final int[] mInputCodes = new int[MAX_WORD_LENGTH]; 55 private final char[] mOutputChars = new char[MAX_WORD_LENGTH * MAX_RESULTS]; 56 private final int[] mSpaceIndices = new int[MAX_SPACES]; 57 private final int[] mOutputScores = new int[MAX_RESULTS]; 58 private final int[] mOutputTypes = new int[MAX_RESULTS]; 59 60 private final boolean mUseFullEditDistance; 61 62 /** 63 * Constructor for the binary dictionary. This is supposed to be called from the 64 * dictionary factory. 65 * All implementations should pass null into flagArray, except for testing purposes. 66 * @param context the context to access the environment from. 67 * @param filename the name of the file to read through native code. 68 * @param offset the offset of the dictionary data within the file. 69 * @param length the length of the binary data. 70 * @param useFullEditDistance whether to use the full edit distance in suggestions 71 * @param dictType the dictionary type, as a human-readable string 72 */ 73 public BinaryDictionary(final Context context, 74 final String filename, final long offset, final long length, 75 final boolean useFullEditDistance, final Locale locale, final String dictType) { 76 super(dictType); 77 mUseFullEditDistance = useFullEditDistance; 78 loadDictionary(filename, offset, length); 79 } 80 81 static { 82 JniUtils.loadNativeLibrary(); 83 } 84 85 private native long openNative(String sourceDir, long dictOffset, long dictSize, 86 int typedLetterMultiplier, int fullWordMultiplier, int maxWordLength, int maxWords, 87 int maxPredictions); 88 private native void closeNative(long dict); 89 private native int getFrequencyNative(long dict, int[] word, int wordLength); 90 private native boolean isValidBigramNative(long dict, int[] word1, int[] word2); 91 private native int getSuggestionsNative(long dict, long proximityInfo, int[] xCoordinates, 92 int[] yCoordinates, int[] times, int[] pointerIds, int[] inputCodes, int codesSize, 93 int commitPoint, boolean isGesture, 94 int[] prevWordCodePointArray, boolean useFullEditDistance, char[] outputChars, 95 int[] outputScores, int[] outputIndices, int[] outputTypes); 96 private static native float calcNormalizedScoreNative( 97 char[] before, int beforeLength, char[] after, int afterLength, int score); 98 private static native int editDistanceNative( 99 char[] before, int beforeLength, char[] after, int afterLength); 100 101 private final void loadDictionary(String path, long startOffset, long length) { 102 mNativeDict = openNative(path, startOffset, length, TYPED_LETTER_MULTIPLIER, 103 FULL_WORD_SCORE_MULTIPLIER, MAX_WORD_LENGTH, MAX_WORDS, MAX_PREDICTIONS); 104 } 105 106 @Override 107 public ArrayList<SuggestedWordInfo> getSuggestions(final WordComposer composer, 108 final CharSequence prevWord, final ProximityInfo proximityInfo) { 109 if (!isValidDictionary()) return null; 110 Arrays.fill(mInputCodes, WordComposer.NOT_A_CODE); 111 Arrays.fill(mOutputChars, (char) 0); 112 Arrays.fill(mOutputScores, 0); 113 // TODO: toLowerCase in the native code 114 final int[] prevWordCodePointArray = (null == prevWord) 115 ? null : StringUtils.toCodePointArray(prevWord.toString()); 116 final int composerSize = composer.size(); 117 118 final boolean isGesture = composer.isBatchMode(); 119 if (composerSize <= 1 || !isGesture) { 120 if (composerSize > MAX_WORD_LENGTH - 1) return null; 121 for (int i = 0; i < composerSize; i++) { 122 mInputCodes[i] = composer.getCodeAt(i); 123 } 124 } 125 126 final InputPointers ips = composer.getInputPointers(); 127 final int codesSize = isGesture ? ips.getPointerSize() : composerSize; 128 // proximityInfo and/or prevWordForBigrams may not be null. 129 final int tmpCount = getSuggestionsNative(mNativeDict, 130 proximityInfo.getNativeProximityInfo(), ips.getXCoordinates(), 131 ips.getYCoordinates(), ips.getTimes(), ips.getPointerIds(), 132 mInputCodes, codesSize, 0 /* commitPoint */, isGesture, prevWordCodePointArray, 133 mUseFullEditDistance, mOutputChars, mOutputScores, mSpaceIndices, mOutputTypes); 134 final int count = Math.min(tmpCount, MAX_PREDICTIONS); 135 136 final ArrayList<SuggestedWordInfo> suggestions = new ArrayList<SuggestedWordInfo>(); 137 for (int j = 0; j < count; ++j) { 138 if (composerSize > 0 && mOutputScores[j] < 1) break; 139 final int start = j * MAX_WORD_LENGTH; 140 int len = 0; 141 while (len < MAX_WORD_LENGTH && mOutputChars[start + len] != 0) { 142 ++len; 143 } 144 if (len > 0) { 145 suggestions.add(new SuggestedWordInfo( 146 new String(mOutputChars, start, len), 147 mOutputScores[j], SuggestedWordInfo.KIND_CORRECTION, mDictType)); 148 } 149 } 150 return suggestions; 151 } 152 153 /* package for test */ boolean isValidDictionary() { 154 return mNativeDict != 0; 155 } 156 157 public static float calcNormalizedScore(String before, String after, int score) { 158 return calcNormalizedScoreNative(before.toCharArray(), before.length(), 159 after.toCharArray(), after.length(), score); 160 } 161 162 public static int editDistance(String before, String after) { 163 return editDistanceNative( 164 before.toCharArray(), before.length(), after.toCharArray(), after.length()); 165 } 166 167 @Override 168 public boolean isValidWord(CharSequence word) { 169 return getFrequency(word) >= 0; 170 } 171 172 @Override 173 public int getFrequency(CharSequence word) { 174 if (word == null) return -1; 175 int[] chars = StringUtils.toCodePointArray(word.toString()); 176 return getFrequencyNative(mNativeDict, chars, chars.length); 177 } 178 179 // TODO: Add a batch process version (isValidBigramMultiple?) to avoid excessive numbers of jni 180 // calls when checking for changes in an entire dictionary. 181 public boolean isValidBigram(CharSequence word1, CharSequence word2) { 182 if (TextUtils.isEmpty(word1) || TextUtils.isEmpty(word2)) return false; 183 int[] chars1 = StringUtils.toCodePointArray(word1.toString()); 184 int[] chars2 = StringUtils.toCodePointArray(word2.toString()); 185 return isValidBigramNative(mNativeDict, chars1, chars2); 186 } 187 188 @Override 189 public synchronized void close() { 190 closeInternal(); 191 } 192 193 private void closeInternal() { 194 if (mNativeDict != 0) { 195 closeNative(mNativeDict); 196 mNativeDict = 0; 197 } 198 } 199 200 @Override 201 protected void finalize() throws Throwable { 202 try { 203 closeInternal(); 204 } finally { 205 super.finalize(); 206 } 207 } 208} 209