// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package org.chromium.components.spellcheck;
import android.content.Context;
import android.text.style.SuggestionSpan;
import android.view.textservice.SentenceSuggestionsInfo;
import android.view.textservice.SpellCheckerSession;
import android.view.textservice.SpellCheckerSession.SpellCheckerSessionListener;
import android.view.textservice.SuggestionsInfo;
import android.view.textservice.TextInfo;
import android.view.textservice.TextServicesManager;
import org.jni_zero.CalledByNative;
import org.jni_zero.NativeMethods;
import org.chromium.base.ContextUtils;
import java.util.ArrayList;
/** JNI interface for native SpellCheckerSessionBridge to use Android's spellchecker. */
public class SpellCheckerSessionBridge implements SpellCheckerSessionListener {
private long mNativeSpellCheckerSessionBridge;
private final SpellCheckerSession mSpellCheckerSession;
/**
* Constructs a SpellCheckerSessionBridge object as well as its SpellCheckerSession object.
* @param nativeSpellCheckerSessionBridge Pointer to the native SpellCheckerSessionBridge.
*/
private SpellCheckerSessionBridge(long nativeSpellCheckerSessionBridge) {
mNativeSpellCheckerSessionBridge = nativeSpellCheckerSessionBridge;
Context context = ContextUtils.getApplicationContext();
final TextServicesManager textServicesManager =
(TextServicesManager)
context.getSystemService(Context.TEXT_SERVICES_MANAGER_SERVICE);
// This combination of parameters will cause the spellchecker to be based off of
// the language specified at "Settings > Language & input > Spell checker > Language".
// If that setting is set to "Use system language" and the system language is not on the
// list of supported spellcheck languages, this call will return null. This call will also
// return null if the user has turned spellchecking off at "Settings > Language & input >
// Spell checker".
mSpellCheckerSession = textServicesManager.newSpellCheckerSession(null, null, this, true);
}
/**
* Returns a new SpellCheckerSessionBridge object if the internal SpellCheckerSession object
* was able to be created.
* @param nativeSpellCheckerSessionBridge Pointer to the native SpellCheckerSessionBridge.
*/
@CalledByNative
private static SpellCheckerSessionBridge create(long nativeSpellCheckerSessionBridge) {
SpellCheckerSessionBridge bridge =
new SpellCheckerSessionBridge(nativeSpellCheckerSessionBridge);
if (bridge.mSpellCheckerSession == null) {
return null;
}
return bridge;
}
/** Reset the native bridge pointer, called when the native counterpart is destroyed. */
@CalledByNative
private void disconnect() {
mNativeSpellCheckerSessionBridge = 0;
mSpellCheckerSession.cancel();
mSpellCheckerSession.close();
}
/**
* Queries the input text against the SpellCheckerSession.
* @param text Text to be queried.
*/
@CalledByNative
private void requestTextCheck(String text) {
// SpellCheckerSession thinks that any word ending with a period is a typo.
// We trim the period off before sending the text for spellchecking in order to avoid
// unnecessary red underlines when the user ends a sentence with a period.
// Filed as an Android bug here: https://code.google.com/p/android/issues/detail?id=183294
if (text.endsWith(".")) {
text = text.substring(0, text.length() - 1);
}
mSpellCheckerSession.getSentenceSuggestions(
new TextInfo[] {new TextInfo(text)}, SuggestionSpan.SUGGESTIONS_MAX_SIZE);
}
/**
* Checks for typos and sends results back to native through a JNI call.
* @param results Results returned by the Android spellchecker.
*/
@Override
public void onGetSentenceSuggestions(SentenceSuggestionsInfo[] results) {
if (mNativeSpellCheckerSessionBridge == 0) {
return;
}
ArrayList<Integer> offsets = new ArrayList<Integer>();
ArrayList<Integer> lengths = new ArrayList<Integer>();
ArrayList<String[]> suggestions = new ArrayList<String[]>();
for (SentenceSuggestionsInfo result : results) {
if (result == null) {
// In some cases null can be returned by the selected spellchecking service,
// see crbug.com/651458. In this case skip to next result to avoid a
// NullPointerException later on.
continue;
}
for (int i = 0; i < result.getSuggestionsCount(); i++) {
// If a word looks like a typo, record its offset and length.
if ((result.getSuggestionsInfoAt(i).getSuggestionsAttributes()
& SuggestionsInfo.RESULT_ATTR_LOOKS_LIKE_TYPO)
== SuggestionsInfo.RESULT_ATTR_LOOKS_LIKE_TYPO) {
offsets.add(result.getOffsetAt(i));
lengths.add(result.getLengthAt(i));
SuggestionsInfo info = result.getSuggestionsInfoAt(i);
ArrayList<String> suggestions_for_word = new ArrayList<String>();
for (int j = 0; j < info.getSuggestionsCount(); ++j) {
String suggestion = info.getSuggestionAt(j);
// Remove zero-length space from end of suggestion, if any
if (suggestion.charAt(suggestion.length() - 1) == 0x200b) {
suggestion = suggestion.substring(0, suggestion.length() - 1);
}
suggestions_for_word.add(suggestion);
}
suggestions.add(
suggestions_for_word.toArray(new String[suggestions_for_word.size()]));
}
}
}
SpellCheckerSessionBridgeJni.get()
.processSpellCheckResults(
mNativeSpellCheckerSessionBridge,
SpellCheckerSessionBridge.this,
convertListToArray(offsets),
convertListToArray(lengths),
suggestions.toArray(new String[suggestions.size()][]));
}
/**
* Helper method to convert an ArrayList of Integer objects into an array of primitive ints
* for easier JNI handling of these objects on the native side.
* @param list List to be converted to an array.
*/
private int[] convertListToArray(ArrayList<Integer> list) {
int[] array = new int[list.size()];
for (int index = 0; index < array.length; index++) {
array[index] = list.get(index).intValue();
}
return array;
}
@Override
public void onGetSuggestions(SuggestionsInfo[] results) {}
@NativeMethods
interface Natives {
void processSpellCheckResults(
long nativeSpellCheckerSessionBridge,
SpellCheckerSessionBridge caller,
int[] offsets,
int[] lengths,
String[][] suggestions);
}
}
Codebase Browser
chromium