BinaryDictionary.java revision e9f3e182e4b3217282831fd8805958270b4dbba3
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 private final DicTraverseSession mDicTraverseSession; 62 63 /** 64 * Constructor for the binary dictionary. This is supposed to be called from the 65 * dictionary factory. 66 * All implementations should pass null into flagArray, except for testing purposes. 67 * @param context the context to access the environment from. 68 * @param filename the name of the file to read through native code. 69 * @param offset the offset of the dictionary data within the file. 70 * @param length the length of the binary data. 71 * @param useFullEditDistance whether to use the full edit distance in suggestions 72 * @param dictType the dictionary type, as a human-readable string 73 */ 74 public BinaryDictionary(final Context context, 75 final String filename, final long offset, final long length, 76 final boolean useFullEditDistance, final Locale locale, final String dictType) { 77 super(dictType); 78 mUseFullEditDistance = useFullEditDistance; 79 loadDictionary(filename, offset, length); 80 mDicTraverseSession = new DicTraverseSession(locale); 81 } 82 83 static { 84 JniUtils.loadNativeLibrary(); 85 } 86 87 private native long openNative(String sourceDir, long dictOffset, long dictSize, 88 int typedLetterMultiplier, int fullWordMultiplier, int maxWordLength, int maxWords, 89 int maxPredictions); 90 private native void closeNative(long dict); 91 private native int getFrequencyNative(long dict, int[] word); 92 private native boolean isValidBigramNative(long dict, int[] word1, int[] word2); 93 private native int getSuggestionsNative(long dict, long proximityInfo, long traverseSession, 94 int[] xCoordinates, int[] yCoordinates, int[] times, int[] pointerIds, 95 int[] inputCodes, int codesSize, int commitPoint, boolean isGesture, 96 int[] prevWordCodePointArray, boolean useFullEditDistance, char[] outputChars, 97 int[] outputScores, int[] outputIndices, int[] outputTypes); 98 private static native float calcNormalizedScoreNative(char[] before, char[] after, int score); 99 private static native int editDistanceNative(char[] before, char[] after); 100 101 // TODO: Move native dict into session 102 private final void loadDictionary(String path, long startOffset, long length) { 103 mNativeDict = openNative(path, startOffset, length, TYPED_LETTER_MULTIPLIER, 104 FULL_WORD_SCORE_MULTIPLIER, MAX_WORD_LENGTH, MAX_WORDS, MAX_PREDICTIONS); 105 } 106 107 @Override 108 public ArrayList<SuggestedWordInfo> getSuggestions(final WordComposer composer, 109 final CharSequence prevWord, final ProximityInfo proximityInfo) { 110 if (!isValidDictionary()) return null; 111 Arrays.fill(mInputCodes, WordComposer.NOT_A_CODE); 112 Arrays.fill(mOutputChars, (char) 0); 113 Arrays.fill(mOutputScores, 0); 114 // TODO: toLowerCase in the native code 115 final int[] prevWordCodePointArray = (null == prevWord) 116 ? null : StringUtils.toCodePointArray(prevWord.toString()); 117 final int composerSize = composer.size(); 118 119 final boolean isGesture = composer.isBatchMode(); 120 if (composerSize <= 1 || !isGesture) { 121 if (composerSize > MAX_WORD_LENGTH - 1) return null; 122 for (int i = 0; i < composerSize; i++) { 123 mInputCodes[i] = composer.getCodeAt(i); 124 } 125 } 126 127 final InputPointers ips = composer.getInputPointers(); 128 final int codesSize = isGesture ? ips.getPointerSize() : composerSize; 129 // proximityInfo and/or prevWordForBigrams may not be null. 130 final int tmpCount = getSuggestionsNative(mNativeDict, 131 proximityInfo.getNativeProximityInfo(), 132 mDicTraverseSession.getSession(), ips.getXCoordinates(), 133 ips.getYCoordinates(), ips.getTimes(), ips.getPointerIds(), 134 mInputCodes, codesSize, 0 /* commitPoint */, isGesture, prevWordCodePointArray, 135 mUseFullEditDistance, mOutputChars, mOutputScores, mSpaceIndices, mOutputTypes); 136 final int count = Math.min(tmpCount, MAX_PREDICTIONS); 137 138 final ArrayList<SuggestedWordInfo> suggestions = new ArrayList<SuggestedWordInfo>(); 139 for (int j = 0; j < count; ++j) { 140 if (composerSize > 0 && mOutputScores[j] < 1) break; 141 final int start = j * MAX_WORD_LENGTH; 142 int len = 0; 143 while (len < MAX_WORD_LENGTH && mOutputChars[start + len] != 0) { 144 ++len; 145 } 146 if (len > 0) { 147 suggestions.add(new SuggestedWordInfo( 148 new String(mOutputChars, start, len), 149 mOutputScores[j], SuggestedWordInfo.KIND_CORRECTION, mDictType)); 150 } 151 } 152 return suggestions; 153 } 154 155 /* package for test */ boolean isValidDictionary() { 156 return mNativeDict != 0; 157 } 158 159 public static float calcNormalizedScore(String before, String after, int score) { 160 return calcNormalizedScoreNative(before.toCharArray(), after.toCharArray(), score); 161 } 162 163 public static int editDistance(String before, String after) { 164 return editDistanceNative(before.toCharArray(), after.toCharArray()); 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[] codePoints = StringUtils.toCodePointArray(word.toString()); 176 return getFrequencyNative(mNativeDict, codePoints); 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 mDicTraverseSession.close(); 191 closeInternal(); 192 } 193 194 private void closeInternal() { 195 if (mNativeDict != 0) { 196 closeNative(mNativeDict); 197 mNativeDict = 0; 198 } 199 } 200 201 @Override 202 protected void finalize() throws Throwable { 203 try { 204 closeInternal(); 205 } finally { 206 super.finalize(); 207 } 208 } 209} 210