2010-12-10 11:50:30 +00:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2010 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 android.view.inputmethod.CompletionInfo;
|
|
|
|
|
|
|
|
import java.util.ArrayList;
|
|
|
|
import java.util.Collections;
|
2011-01-21 06:03:09 +00:00
|
|
|
import java.util.HashSet;
|
2010-12-10 11:50:30 +00:00
|
|
|
import java.util.List;
|
|
|
|
|
|
|
|
public class SuggestedWords {
|
2012-03-14 06:33:47 +00:00
|
|
|
public static final SuggestedWords EMPTY = new SuggestedWords(
|
|
|
|
Collections.<SuggestedWordInfo>emptyList(), false, false, false, false, false);
|
2010-12-10 11:50:30 +00:00
|
|
|
|
|
|
|
public final boolean mTypedWordValid;
|
2012-03-02 10:49:24 +00:00
|
|
|
public final boolean mHasAutoCorrectionCandidate;
|
2011-06-30 01:09:21 +00:00
|
|
|
public final boolean mIsPunctuationSuggestions;
|
2012-03-13 11:16:18 +00:00
|
|
|
public final boolean mAllowsToBeAutoCorrected;
|
2011-08-04 05:38:22 +00:00
|
|
|
private final List<SuggestedWordInfo> mSuggestedWordInfoList;
|
2010-12-10 11:50:30 +00:00
|
|
|
|
2012-03-14 06:33:47 +00:00
|
|
|
private SuggestedWords(final List<SuggestedWordInfo> suggestedWordInfoList,
|
|
|
|
final boolean typedWordValid,
|
2012-03-13 11:16:18 +00:00
|
|
|
final boolean hasAutoCorrectionCandidate,
|
|
|
|
final boolean allowsToBeAutoCorrected,
|
2012-03-14 06:33:47 +00:00
|
|
|
final boolean isPunctuationSuggestions,
|
|
|
|
final boolean shouldBlockAutoCorrectionBySafetyNet) {
|
|
|
|
mSuggestedWordInfoList = suggestedWordInfoList;
|
2010-12-10 11:50:30 +00:00
|
|
|
mTypedWordValid = typedWordValid;
|
2012-03-09 13:02:26 +00:00
|
|
|
mHasAutoCorrectionCandidate = hasAutoCorrectionCandidate
|
|
|
|
&& !shouldBlockAutoCorrectionBySafetyNet;
|
2012-03-13 11:16:18 +00:00
|
|
|
mAllowsToBeAutoCorrected = allowsToBeAutoCorrected;
|
2012-03-14 06:33:47 +00:00
|
|
|
mIsPunctuationSuggestions = isPunctuationSuggestions;
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public int size() {
|
2012-03-12 09:56:02 +00:00
|
|
|
return mSuggestedWordInfoList.size();
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public CharSequence getWord(int pos) {
|
2012-03-12 09:56:02 +00:00
|
|
|
return mSuggestedWordInfoList.get(pos).mWord;
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
|
|
|
|
2011-08-04 05:38:22 +00:00
|
|
|
public SuggestedWordInfo getInfo(int pos) {
|
|
|
|
return mSuggestedWordInfoList != null ? mSuggestedWordInfoList.get(pos) : null;
|
|
|
|
}
|
|
|
|
|
2010-12-10 11:50:30 +00:00
|
|
|
public boolean hasAutoCorrectionWord() {
|
2012-03-09 13:02:26 +00:00
|
|
|
return mHasAutoCorrectionCandidate && size() > 1 && !mTypedWordValid;
|
2011-10-13 05:25:26 +00:00
|
|
|
}
|
|
|
|
|
2012-03-05 10:54:21 +00:00
|
|
|
public boolean willAutoCorrect() {
|
2012-03-09 13:02:26 +00:00
|
|
|
return !mTypedWordValid && mHasAutoCorrectionCandidate;
|
2012-03-05 13:08:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public String toString() {
|
|
|
|
// Pretty-print method to help debug
|
|
|
|
return "SuggestedWords:"
|
|
|
|
+ " mTypedWordValid=" + mTypedWordValid
|
|
|
|
+ " mHasAutoCorrectionCandidate=" + mHasAutoCorrectionCandidate
|
2012-03-12 09:56:02 +00:00
|
|
|
+ " mIsPunctuationSuggestions=" + mIsPunctuationSuggestions;
|
2012-03-05 05:19:35 +00:00
|
|
|
}
|
|
|
|
|
2012-03-14 06:22:57 +00:00
|
|
|
private static class Builder {
|
2012-03-13 11:05:00 +00:00
|
|
|
private final boolean mTypedWordValid;
|
|
|
|
private final boolean mHasMinimalSuggestion;
|
2012-03-13 10:40:24 +00:00
|
|
|
private final boolean mIsPunctuationSuggestions;
|
2012-03-13 11:33:13 +00:00
|
|
|
private final boolean mShouldBlockAutoCorrectionBySafetyNet;
|
2012-03-13 10:40:24 +00:00
|
|
|
private final boolean mAllowsToBeAutoCorrected;
|
2012-03-13 10:26:52 +00:00
|
|
|
private final List<SuggestedWordInfo> mSuggestedWordInfoList;
|
2010-12-10 11:50:30 +00:00
|
|
|
|
2012-03-14 06:22:57 +00:00
|
|
|
private Builder(final List<SuggestedWordInfo> suggestedWordInfoList,
|
2012-03-13 11:05:00 +00:00
|
|
|
final boolean typedWordValid,
|
|
|
|
final boolean hasMinimalSuggestion,
|
2012-03-13 10:40:24 +00:00
|
|
|
final boolean allowsToBeAutoCorrected,
|
2012-03-13 11:33:13 +00:00
|
|
|
final boolean isPunctuationSuggestions,
|
|
|
|
final boolean shouldBlockAutoCorrectionBySafetyNet) {
|
2012-03-13 07:36:21 +00:00
|
|
|
mSuggestedWordInfoList = suggestedWordInfoList;
|
2012-03-13 11:05:00 +00:00
|
|
|
mTypedWordValid = typedWordValid;
|
|
|
|
mHasMinimalSuggestion = hasMinimalSuggestion;
|
2012-03-13 10:40:24 +00:00
|
|
|
mAllowsToBeAutoCorrected = allowsToBeAutoCorrected;
|
|
|
|
mIsPunctuationSuggestions = isPunctuationSuggestions;
|
2012-03-13 11:33:13 +00:00
|
|
|
mShouldBlockAutoCorrectionBySafetyNet = shouldBlockAutoCorrectionBySafetyNet;
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
|
|
|
|
2012-03-13 11:39:21 +00:00
|
|
|
public SuggestedWords build() {
|
2012-03-14 06:33:47 +00:00
|
|
|
return new SuggestedWords(mSuggestedWordInfoList, mTypedWordValid,
|
|
|
|
mHasMinimalSuggestion, mAllowsToBeAutoCorrected,
|
|
|
|
mIsPunctuationSuggestions, mShouldBlockAutoCorrectionBySafetyNet);
|
2012-03-13 06:05:44 +00:00
|
|
|
}
|
2012-03-13 11:39:21 +00:00
|
|
|
}
|
2012-03-13 06:05:44 +00:00
|
|
|
|
2012-03-14 06:22:57 +00:00
|
|
|
public static SuggestedWords getSuggestedWords(
|
|
|
|
final List<SuggestedWordInfo> suggestedWordInfoList,
|
|
|
|
final boolean typedWordValid,
|
|
|
|
final boolean hasMinimalSuggestion,
|
|
|
|
final boolean allowsToBeAutoCorrected,
|
|
|
|
final boolean isPunctuationSuggestions,
|
|
|
|
final boolean shouldBlockAutoCorrectionBySafetyNet) {
|
|
|
|
return new Builder(suggestedWordInfoList,
|
|
|
|
typedWordValid,
|
|
|
|
hasMinimalSuggestion,
|
|
|
|
allowsToBeAutoCorrected,
|
|
|
|
isPunctuationSuggestions,
|
|
|
|
shouldBlockAutoCorrectionBySafetyNet).build();
|
|
|
|
}
|
|
|
|
|
2012-03-13 11:39:21 +00:00
|
|
|
public static ArrayList<SuggestedWordInfo> getFromCharSequenceList(
|
|
|
|
final List<CharSequence> wordList) {
|
|
|
|
final ArrayList<SuggestedWordInfo> result = new ArrayList<SuggestedWordInfo>();
|
|
|
|
for (CharSequence word : wordList) {
|
|
|
|
if (null != word) result.add(new SuggestedWordInfo(word, null, false));
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
2012-03-13 11:39:21 +00:00
|
|
|
return result;
|
|
|
|
}
|
2010-12-10 11:50:30 +00:00
|
|
|
|
2012-03-13 11:39:21 +00:00
|
|
|
public static List<SuggestedWordInfo> getFromApplicationSpecifiedCompletions(
|
|
|
|
final CompletionInfo[] infos) {
|
|
|
|
final ArrayList<SuggestedWordInfo> result = new ArrayList<SuggestedWordInfo>();
|
|
|
|
for (CompletionInfo info : infos) {
|
|
|
|
if (null != info) result.add(new SuggestedWordInfo(info.getText(), null, false));
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
2012-03-13 11:39:21 +00:00
|
|
|
return result;
|
|
|
|
}
|
2010-12-10 11:50:30 +00:00
|
|
|
|
2012-03-13 11:39:21 +00:00
|
|
|
// Should get rid of the first one (what the user typed previously) from suggestions
|
|
|
|
// and replace it with what the user currently typed.
|
|
|
|
public static ArrayList<SuggestedWordInfo> getTypedWordAndPreviousSuggestions(
|
|
|
|
final CharSequence typedWord, final SuggestedWords previousSuggestions) {
|
|
|
|
final ArrayList<SuggestedWordInfo> suggestionsList = new ArrayList<SuggestedWordInfo>();
|
|
|
|
final HashSet<String> alreadySeen = new HashSet<String>();
|
|
|
|
suggestionsList.add(new SuggestedWordInfo(typedWord, null, false));
|
|
|
|
alreadySeen.add(typedWord.toString());
|
|
|
|
final int previousSize = previousSuggestions.size();
|
|
|
|
for (int pos = 1; pos < previousSize; pos++) {
|
|
|
|
final String prevWord = previousSuggestions.getWord(pos).toString();
|
|
|
|
// Filter out duplicate suggestion.
|
|
|
|
if (!alreadySeen.contains(prevWord)) {
|
|
|
|
suggestionsList.add(new SuggestedWordInfo(prevWord, null, true));
|
|
|
|
alreadySeen.add(prevWord);
|
|
|
|
}
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
2012-03-13 11:39:21 +00:00
|
|
|
return suggestionsList;
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|
2011-01-19 08:29:27 +00:00
|
|
|
|
|
|
|
public static class SuggestedWordInfo {
|
2012-03-13 11:26:47 +00:00
|
|
|
public final CharSequence mWord;
|
2011-01-19 08:29:27 +00:00
|
|
|
private final CharSequence mDebugString;
|
|
|
|
private final boolean mPreviousSuggestedWord;
|
|
|
|
|
2012-03-12 09:56:02 +00:00
|
|
|
public SuggestedWordInfo(final CharSequence word) {
|
|
|
|
mWord = word;
|
2011-01-19 08:29:27 +00:00
|
|
|
mDebugString = "";
|
|
|
|
mPreviousSuggestedWord = false;
|
|
|
|
}
|
|
|
|
|
2012-03-12 09:56:02 +00:00
|
|
|
public SuggestedWordInfo(final CharSequence word, final CharSequence debugString,
|
|
|
|
final boolean previousSuggestedWord) {
|
|
|
|
mWord = word;
|
2011-01-19 08:29:27 +00:00
|
|
|
mDebugString = debugString;
|
|
|
|
mPreviousSuggestedWord = previousSuggestedWord;
|
|
|
|
}
|
|
|
|
|
|
|
|
public String getDebugString() {
|
|
|
|
if (mDebugString == null) {
|
|
|
|
return "";
|
|
|
|
} else {
|
|
|
|
return mDebugString.toString();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2011-08-26 10:04:54 +00:00
|
|
|
public boolean isObsoleteSuggestedWord () {
|
2011-01-19 08:29:27 +00:00
|
|
|
return mPreviousSuggestedWord;
|
|
|
|
}
|
|
|
|
}
|
2010-12-10 11:50:30 +00:00
|
|
|
}
|