aboutsummaryrefslogtreecommitdiffstats
path: root/java/src/com/android/inputmethod/latin/LatinIME.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/LatinIME.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/LatinIME.java')
-rw-r--r--java/src/com/android/inputmethod/latin/LatinIME.java2033
1 files changed, 0 insertions, 2033 deletions
diff --git a/java/src/com/android/inputmethod/latin/LatinIME.java b/java/src/com/android/inputmethod/latin/LatinIME.java
deleted file mode 100644
index e68b43b39..000000000
--- a/java/src/com/android/inputmethod/latin/LatinIME.java
+++ /dev/null
@@ -1,2033 +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 static com.android.inputmethod.latin.common.Constants.ImeOption.FORCE_ASCII;
-import static com.android.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE;
-import static com.android.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE_COMPAT;
-
-import android.Manifest.permission;
-import android.app.ActivityOptions;
-import android.app.AlertDialog;
-import android.content.BroadcastReceiver;
-import android.content.Context;
-import android.content.DialogInterface;
-import android.content.DialogInterface.OnClickListener;
-import android.content.Intent;
-import android.content.IntentFilter;
-import android.content.res.Configuration;
-import android.content.res.Resources;
-import android.graphics.Color;
-import android.inputmethodservice.InputMethodService;
-import android.media.AudioManager;
-import android.os.Build;
-import android.os.Debug;
-import android.os.IBinder;
-import android.os.Message;
-import android.preference.PreferenceManager;
-import android.text.InputType;
-import android.util.Log;
-import android.util.PrintWriterPrinter;
-import android.util.Printer;
-import android.util.SparseArray;
-import android.view.Display;
-import android.view.Gravity;
-import android.view.KeyEvent;
-import android.view.View;
-import android.view.ViewGroup.LayoutParams;
-import android.view.Window;
-import android.view.WindowManager;
-import android.view.inputmethod.CompletionInfo;
-import android.view.inputmethod.EditorInfo;
-import android.view.inputmethod.InputMethodSubtype;
-
-import androidx.annotation.NonNull;
-
-import com.android.inputmethod.accessibility.AccessibilityUtils;
-import com.android.inputmethod.annotations.UsedForTesting;
-import com.android.inputmethod.compat.BuildCompatUtils;
-import com.android.inputmethod.compat.EditorInfoCompatUtils;
-import com.android.inputmethod.compat.InputMethodServiceCompatUtils;
-import com.android.inputmethod.compat.ViewOutlineProviderCompatUtils;
-import com.android.inputmethod.compat.ViewOutlineProviderCompatUtils.InsetsUpdater;
-import com.android.inputmethod.dictionarypack.DictionaryPackConstants;
-import com.android.inputmethod.event.Event;
-import com.android.inputmethod.event.HardwareEventDecoder;
-import com.android.inputmethod.event.HardwareKeyboardEventDecoder;
-import com.android.inputmethod.event.InputTransaction;
-import com.android.inputmethod.keyboard.Keyboard;
-import com.android.inputmethod.keyboard.KeyboardActionListener;
-import com.android.inputmethod.keyboard.KeyboardId;
-import com.android.inputmethod.keyboard.KeyboardSwitcher;
-import com.android.inputmethod.keyboard.MainKeyboardView;
-import com.android.inputmethod.latin.Suggest.OnGetSuggestedWordsCallback;
-import com.android.inputmethod.latin.SuggestedWords.SuggestedWordInfo;
-import com.android.inputmethod.latin.common.Constants;
-import com.android.inputmethod.latin.common.CoordinateUtils;
-import com.android.inputmethod.latin.common.InputPointers;
-import com.android.inputmethod.latin.define.DebugFlags;
-import com.android.inputmethod.latin.define.ProductionFlags;
-import com.android.inputmethod.latin.inputlogic.InputLogic;
-import com.android.inputmethod.latin.permissions.PermissionsManager;
-import com.android.inputmethod.latin.personalization.PersonalizationHelper;
-import com.android.inputmethod.latin.settings.Settings;
-import com.android.inputmethod.latin.settings.SettingsActivity;
-import com.android.inputmethod.latin.settings.SettingsValues;
-import com.android.inputmethod.latin.suggestions.SuggestionStripView;
-import com.android.inputmethod.latin.suggestions.SuggestionStripViewAccessor;
-import com.android.inputmethod.latin.touchinputconsumer.GestureConsumer;
-import com.android.inputmethod.latin.utils.ApplicationUtils;
-import com.android.inputmethod.latin.utils.DialogUtils;
-import com.android.inputmethod.latin.utils.ImportantNoticeUtils;
-import com.android.inputmethod.latin.utils.IntentUtils;
-import com.android.inputmethod.latin.utils.JniUtils;
-import com.android.inputmethod.latin.utils.LeakGuardHandlerWrapper;
-import com.android.inputmethod.latin.utils.StatsUtils;
-import com.android.inputmethod.latin.utils.StatsUtilsManager;
-import com.android.inputmethod.latin.utils.SubtypeLocaleUtils;
-import com.android.inputmethod.latin.utils.ViewLayoutUtils;
-
-import java.io.FileDescriptor;
-import java.io.PrintWriter;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Locale;
-import java.util.concurrent.TimeUnit;
-
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
-/**
- * Input method implementation for Qwerty'ish keyboard.
- */
-public class LatinIME extends InputMethodService implements KeyboardActionListener,
- SuggestionStripView.Listener, SuggestionStripViewAccessor,
- DictionaryFacilitator.DictionaryInitializationListener,
- PermissionsManager.PermissionsResultCallback {
- static final String TAG = LatinIME.class.getSimpleName();
- private static final boolean TRACE = false;
-
- private static final int PERIOD_FOR_AUDIO_AND_HAPTIC_FEEDBACK_IN_KEY_REPEAT = 2;
- private static final int PENDING_IMS_CALLBACK_DURATION_MILLIS = 800;
- static final long DELAY_WAIT_FOR_DICTIONARY_LOAD_MILLIS = TimeUnit.SECONDS.toMillis(2);
- static final long DELAY_DEALLOCATE_MEMORY_MILLIS = TimeUnit.SECONDS.toMillis(10);
-
- /**
- * A broadcast intent action to hide the software keyboard.
- */
- static final String ACTION_HIDE_SOFT_INPUT =
- "com.android.inputmethod.latin.HIDE_SOFT_INPUT";
-
- /**
- * A custom permission for external apps to send {@link #ACTION_HIDE_SOFT_INPUT}.
- */
- static final String PERMISSION_HIDE_SOFT_INPUT =
- "com.android.inputmethod.latin.HIDE_SOFT_INPUT";
-
- /**
- * The name of the scheme used by the Package Manager to warn of a new package installation,
- * replacement or removal.
- */
- private static final String SCHEME_PACKAGE = "package";
-
- final Settings mSettings;
- private final DictionaryFacilitator mDictionaryFacilitator =
- DictionaryFacilitatorProvider.getDictionaryFacilitator(
- false /* isNeededForSpellChecking */);
- final InputLogic mInputLogic = new InputLogic(this /* LatinIME */,
- this /* SuggestionStripViewAccessor */, mDictionaryFacilitator);
- // We expect to have only one decoder in almost all cases, hence the default capacity of 1.
- // If it turns out we need several, it will get grown seamlessly.
- final SparseArray<HardwareEventDecoder> mHardwareEventDecoders = new SparseArray<>(1);
-
- // TODO: Move these {@link View}s to {@link KeyboardSwitcher}.
- private View mInputView;
- private InsetsUpdater mInsetsUpdater;
- private SuggestionStripView mSuggestionStripView;
-
- private RichInputMethodManager mRichImm;
- @UsedForTesting final KeyboardSwitcher mKeyboardSwitcher;
- private final SubtypeState mSubtypeState = new SubtypeState();
- private EmojiAltPhysicalKeyDetector mEmojiAltPhysicalKeyDetector;
- private StatsUtilsManager mStatsUtilsManager;
- // Working variable for {@link #startShowingInputView()} and
- // {@link #onEvaluateInputViewShown()}.
- private boolean mIsExecutingStartShowingInputView;
-
- // Used for re-initialize keyboard layout after onConfigurationChange.
- @Nullable private Context mDisplayContext;
-
- // Object for reacting to adding/removing a dictionary pack.
- private final BroadcastReceiver mDictionaryPackInstallReceiver =
- new DictionaryPackInstallBroadcastReceiver(this);
-
- private final BroadcastReceiver mDictionaryDumpBroadcastReceiver =
- new DictionaryDumpBroadcastReceiver(this);
-
- final static class HideSoftInputReceiver extends BroadcastReceiver {
- private final InputMethodService mIms;
-
- public HideSoftInputReceiver(InputMethodService ims) {
- mIms = ims;
- }
-
- @Override
- public void onReceive(Context context, Intent intent) {
- final String action = intent.getAction();
- if (ACTION_HIDE_SOFT_INPUT.equals(action)) {
- mIms.requestHideSelf(0 /* flags */);
- } else {
- Log.e(TAG, "Unexpected intent " + intent);
- }
- }
- }
- final HideSoftInputReceiver mHideSoftInputReceiver = new HideSoftInputReceiver(this);
-
- private AlertDialog mOptionsDialog;
-
- private final boolean mIsHardwareAcceleratedDrawingEnabled;
-
- private GestureConsumer mGestureConsumer = GestureConsumer.NULL_GESTURE_CONSUMER;
-
- public final UIHandler mHandler = new UIHandler(this);
-
- public static final class UIHandler extends LeakGuardHandlerWrapper<LatinIME> {
- private static final int MSG_UPDATE_SHIFT_STATE = 0;
- private static final int MSG_PENDING_IMS_CALLBACK = 1;
- private static final int MSG_UPDATE_SUGGESTION_STRIP = 2;
- private static final int MSG_SHOW_GESTURE_PREVIEW_AND_SUGGESTION_STRIP = 3;
- private static final int MSG_RESUME_SUGGESTIONS = 4;
- private static final int MSG_REOPEN_DICTIONARIES = 5;
- private static final int MSG_UPDATE_TAIL_BATCH_INPUT_COMPLETED = 6;
- private static final int MSG_RESET_CACHES = 7;
- private static final int MSG_WAIT_FOR_DICTIONARY_LOAD = 8;
- private static final int MSG_DEALLOCATE_MEMORY = 9;
- private static final int MSG_RESUME_SUGGESTIONS_FOR_START_INPUT = 10;
- private static final int MSG_SWITCH_LANGUAGE_AUTOMATICALLY = 11;
- // Update this when adding new messages
- private static final int MSG_LAST = MSG_SWITCH_LANGUAGE_AUTOMATICALLY;
-
- private static final int ARG1_NOT_GESTURE_INPUT = 0;
- private static final int ARG1_DISMISS_GESTURE_FLOATING_PREVIEW_TEXT = 1;
- private static final int ARG1_SHOW_GESTURE_FLOATING_PREVIEW_TEXT = 2;
- private static final int ARG2_UNUSED = 0;
- private static final int ARG1_TRUE = 1;
-
- private int mDelayInMillisecondsToUpdateSuggestions;
- private int mDelayInMillisecondsToUpdateShiftState;
-
- public UIHandler(@Nonnull final LatinIME ownerInstance) {
- super(ownerInstance);
- }
-
- public void onCreate() {
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme == null) {
- return;
- }
- final Resources res = latinIme.getResources();
- mDelayInMillisecondsToUpdateSuggestions = res.getInteger(
- R.integer.config_delay_in_milliseconds_to_update_suggestions);
- mDelayInMillisecondsToUpdateShiftState = res.getInteger(
- R.integer.config_delay_in_milliseconds_to_update_shift_state);
- }
-
- @Override
- public void handleMessage(final Message msg) {
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme == null) {
- return;
- }
- final KeyboardSwitcher switcher = latinIme.mKeyboardSwitcher;
- switch (msg.what) {
- case MSG_UPDATE_SUGGESTION_STRIP:
- cancelUpdateSuggestionStrip();
- latinIme.mInputLogic.performUpdateSuggestionStripSync(
- latinIme.mSettings.getCurrent(), msg.arg1 /* inputStyle */);
- break;
- case MSG_UPDATE_SHIFT_STATE:
- switcher.requestUpdatingShiftState(latinIme.getCurrentAutoCapsState(),
- latinIme.getCurrentRecapitalizeState());
- break;
- case MSG_SHOW_GESTURE_PREVIEW_AND_SUGGESTION_STRIP:
- if (msg.arg1 == ARG1_NOT_GESTURE_INPUT) {
- final SuggestedWords suggestedWords = (SuggestedWords) msg.obj;
- latinIme.showSuggestionStrip(suggestedWords);
- } else {
- latinIme.showGesturePreviewAndSuggestionStrip((SuggestedWords) msg.obj,
- msg.arg1 == ARG1_DISMISS_GESTURE_FLOATING_PREVIEW_TEXT);
- }
- break;
- case MSG_RESUME_SUGGESTIONS:
- latinIme.mInputLogic.restartSuggestionsOnWordTouchedByCursor(
- latinIme.mSettings.getCurrent(), false /* forStartInput */,
- latinIme.mKeyboardSwitcher.getCurrentKeyboardScriptId());
- break;
- case MSG_RESUME_SUGGESTIONS_FOR_START_INPUT:
- latinIme.mInputLogic.restartSuggestionsOnWordTouchedByCursor(
- latinIme.mSettings.getCurrent(), true /* forStartInput */,
- latinIme.mKeyboardSwitcher.getCurrentKeyboardScriptId());
- break;
- case MSG_REOPEN_DICTIONARIES:
- // We need to re-evaluate the currently composing word in case the script has
- // changed.
- postWaitForDictionaryLoad();
- latinIme.resetDictionaryFacilitatorIfNecessary();
- break;
- case MSG_UPDATE_TAIL_BATCH_INPUT_COMPLETED:
- final SuggestedWords suggestedWords = (SuggestedWords) msg.obj;
- latinIme.mInputLogic.onUpdateTailBatchInputCompleted(
- latinIme.mSettings.getCurrent(),
- suggestedWords, latinIme.mKeyboardSwitcher);
- latinIme.onTailBatchInputResultShown(suggestedWords);
- break;
- case MSG_RESET_CACHES:
- final SettingsValues settingsValues = latinIme.mSettings.getCurrent();
- if (latinIme.mInputLogic.retryResetCachesAndReturnSuccess(
- msg.arg1 == ARG1_TRUE /* tryResumeSuggestions */,
- msg.arg2 /* remainingTries */, this /* handler */)) {
- // If we were able to reset the caches, then we can reload the keyboard.
- // Otherwise, we'll do it when we can.
- latinIme.mKeyboardSwitcher.loadKeyboard(latinIme.getCurrentInputEditorInfo(),
- settingsValues, latinIme.getCurrentAutoCapsState(),
- latinIme.getCurrentRecapitalizeState());
- }
- break;
- case MSG_WAIT_FOR_DICTIONARY_LOAD:
- Log.i(TAG, "Timeout waiting for dictionary load");
- break;
- case MSG_DEALLOCATE_MEMORY:
- latinIme.deallocateMemory();
- break;
- case MSG_SWITCH_LANGUAGE_AUTOMATICALLY:
- latinIme.switchLanguage((InputMethodSubtype)msg.obj);
- break;
- }
- }
-
- public void postUpdateSuggestionStrip(final int inputStyle) {
- sendMessageDelayed(obtainMessage(MSG_UPDATE_SUGGESTION_STRIP, inputStyle,
- 0 /* ignored */), mDelayInMillisecondsToUpdateSuggestions);
- }
-
- public void postReopenDictionaries() {
- sendMessage(obtainMessage(MSG_REOPEN_DICTIONARIES));
- }
-
- private void postResumeSuggestionsInternal(final boolean shouldDelay,
- final boolean forStartInput) {
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme == null) {
- return;
- }
- if (!latinIme.mSettings.getCurrent().isSuggestionsEnabledPerUserSettings()) {
- return;
- }
- removeMessages(MSG_RESUME_SUGGESTIONS);
- removeMessages(MSG_RESUME_SUGGESTIONS_FOR_START_INPUT);
- final int message = forStartInput ? MSG_RESUME_SUGGESTIONS_FOR_START_INPUT
- : MSG_RESUME_SUGGESTIONS;
- if (shouldDelay) {
- sendMessageDelayed(obtainMessage(message),
- mDelayInMillisecondsToUpdateSuggestions);
- } else {
- sendMessage(obtainMessage(message));
- }
- }
-
- public void postResumeSuggestions(final boolean shouldDelay) {
- postResumeSuggestionsInternal(shouldDelay, false /* forStartInput */);
- }
-
- public void postResumeSuggestionsForStartInput(final boolean shouldDelay) {
- postResumeSuggestionsInternal(shouldDelay, true /* forStartInput */);
- }
-
- public void postResetCaches(final boolean tryResumeSuggestions, final int remainingTries) {
- removeMessages(MSG_RESET_CACHES);
- sendMessage(obtainMessage(MSG_RESET_CACHES, tryResumeSuggestions ? 1 : 0,
- remainingTries, null));
- }
-
- public void postWaitForDictionaryLoad() {
- sendMessageDelayed(obtainMessage(MSG_WAIT_FOR_DICTIONARY_LOAD),
- DELAY_WAIT_FOR_DICTIONARY_LOAD_MILLIS);
- }
-
- public void cancelWaitForDictionaryLoad() {
- removeMessages(MSG_WAIT_FOR_DICTIONARY_LOAD);
- }
-
- public boolean hasPendingWaitForDictionaryLoad() {
- return hasMessages(MSG_WAIT_FOR_DICTIONARY_LOAD);
- }
-
- public void cancelUpdateSuggestionStrip() {
- removeMessages(MSG_UPDATE_SUGGESTION_STRIP);
- }
-
- public boolean hasPendingUpdateSuggestions() {
- return hasMessages(MSG_UPDATE_SUGGESTION_STRIP);
- }
-
- public boolean hasPendingReopenDictionaries() {
- return hasMessages(MSG_REOPEN_DICTIONARIES);
- }
-
- public void postUpdateShiftState() {
- removeMessages(MSG_UPDATE_SHIFT_STATE);
- sendMessageDelayed(obtainMessage(MSG_UPDATE_SHIFT_STATE),
- mDelayInMillisecondsToUpdateShiftState);
- }
-
- public void postDeallocateMemory() {
- sendMessageDelayed(obtainMessage(MSG_DEALLOCATE_MEMORY),
- DELAY_DEALLOCATE_MEMORY_MILLIS);
- }
-
- public void cancelDeallocateMemory() {
- removeMessages(MSG_DEALLOCATE_MEMORY);
- }
-
- public boolean hasPendingDeallocateMemory() {
- return hasMessages(MSG_DEALLOCATE_MEMORY);
- }
-
- @UsedForTesting
- public void removeAllMessages() {
- for (int i = 0; i <= MSG_LAST; ++i) {
- removeMessages(i);
- }
- }
-
- public void showGesturePreviewAndSuggestionStrip(final SuggestedWords suggestedWords,
- final boolean dismissGestureFloatingPreviewText) {
- removeMessages(MSG_SHOW_GESTURE_PREVIEW_AND_SUGGESTION_STRIP);
- final int arg1 = dismissGestureFloatingPreviewText
- ? ARG1_DISMISS_GESTURE_FLOATING_PREVIEW_TEXT
- : ARG1_SHOW_GESTURE_FLOATING_PREVIEW_TEXT;
- obtainMessage(MSG_SHOW_GESTURE_PREVIEW_AND_SUGGESTION_STRIP, arg1,
- ARG2_UNUSED, suggestedWords).sendToTarget();
- }
-
- public void showSuggestionStrip(final SuggestedWords suggestedWords) {
- removeMessages(MSG_SHOW_GESTURE_PREVIEW_AND_SUGGESTION_STRIP);
- obtainMessage(MSG_SHOW_GESTURE_PREVIEW_AND_SUGGESTION_STRIP,
- ARG1_NOT_GESTURE_INPUT, ARG2_UNUSED, suggestedWords).sendToTarget();
- }
-
- public void showTailBatchInputResult(final SuggestedWords suggestedWords) {
- obtainMessage(MSG_UPDATE_TAIL_BATCH_INPUT_COMPLETED, suggestedWords).sendToTarget();
- }
-
- public void postSwitchLanguage(final InputMethodSubtype subtype) {
- obtainMessage(MSG_SWITCH_LANGUAGE_AUTOMATICALLY, subtype).sendToTarget();
- }
-
- // Working variables for the following methods.
- private boolean mIsOrientationChanging;
- private boolean mPendingSuccessiveImsCallback;
- private boolean mHasPendingStartInput;
- private boolean mHasPendingFinishInputView;
- private boolean mHasPendingFinishInput;
- private EditorInfo mAppliedEditorInfo;
-
- public void startOrientationChanging() {
- removeMessages(MSG_PENDING_IMS_CALLBACK);
- resetPendingImsCallback();
- mIsOrientationChanging = true;
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme == null) {
- return;
- }
- if (latinIme.isInputViewShown()) {
- latinIme.mKeyboardSwitcher.saveKeyboardState();
- }
- }
-
- private void resetPendingImsCallback() {
- mHasPendingFinishInputView = false;
- mHasPendingFinishInput = false;
- mHasPendingStartInput = false;
- }
-
- private void executePendingImsCallback(final LatinIME latinIme, final EditorInfo editorInfo,
- boolean restarting) {
- if (mHasPendingFinishInputView) {
- latinIme.onFinishInputViewInternal(mHasPendingFinishInput);
- }
- if (mHasPendingFinishInput) {
- latinIme.onFinishInputInternal();
- }
- if (mHasPendingStartInput) {
- latinIme.onStartInputInternal(editorInfo, restarting);
- }
- resetPendingImsCallback();
- }
-
- public void onStartInput(final EditorInfo editorInfo, final boolean restarting) {
- if (hasMessages(MSG_PENDING_IMS_CALLBACK)) {
- // Typically this is the second onStartInput after orientation changed.
- mHasPendingStartInput = true;
- } else {
- if (mIsOrientationChanging && restarting) {
- // This is the first onStartInput after orientation changed.
- mIsOrientationChanging = false;
- mPendingSuccessiveImsCallback = true;
- }
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme != null) {
- executePendingImsCallback(latinIme, editorInfo, restarting);
- latinIme.onStartInputInternal(editorInfo, restarting);
- }
- }
- }
-
- public void onStartInputView(final EditorInfo editorInfo, final boolean restarting) {
- if (hasMessages(MSG_PENDING_IMS_CALLBACK)
- && KeyboardId.equivalentEditorInfoForKeyboard(editorInfo, mAppliedEditorInfo)) {
- // Typically this is the second onStartInputView after orientation changed.
- resetPendingImsCallback();
- } else {
- if (mPendingSuccessiveImsCallback) {
- // This is the first onStartInputView after orientation changed.
- mPendingSuccessiveImsCallback = false;
- resetPendingImsCallback();
- sendMessageDelayed(obtainMessage(MSG_PENDING_IMS_CALLBACK),
- PENDING_IMS_CALLBACK_DURATION_MILLIS);
- }
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme != null) {
- executePendingImsCallback(latinIme, editorInfo, restarting);
- latinIme.onStartInputViewInternal(editorInfo, restarting);
- mAppliedEditorInfo = editorInfo;
- }
- cancelDeallocateMemory();
- }
- }
-
- public void onFinishInputView(final boolean finishingInput) {
- if (hasMessages(MSG_PENDING_IMS_CALLBACK)) {
- // Typically this is the first onFinishInputView after orientation changed.
- mHasPendingFinishInputView = true;
- } else {
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme != null) {
- latinIme.onFinishInputViewInternal(finishingInput);
- mAppliedEditorInfo = null;
- }
- if (!hasPendingDeallocateMemory()) {
- postDeallocateMemory();
- }
- }
- }
-
- public void onFinishInput() {
- if (hasMessages(MSG_PENDING_IMS_CALLBACK)) {
- // Typically this is the first onFinishInput after orientation changed.
- mHasPendingFinishInput = true;
- } else {
- final LatinIME latinIme = getOwnerInstance();
- if (latinIme != null) {
- executePendingImsCallback(latinIme, null, false);
- latinIme.onFinishInputInternal();
- }
- }
- }
- }
-
- static final class SubtypeState {
- private InputMethodSubtype mLastActiveSubtype;
- private boolean mCurrentSubtypeHasBeenUsed;
-
- public void setCurrentSubtypeHasBeenUsed() {
- mCurrentSubtypeHasBeenUsed = true;
- }
-
- public void switchSubtype(final IBinder token, final RichInputMethodManager richImm) {
- final InputMethodSubtype currentSubtype = richImm.getInputMethodManager()
- .getCurrentInputMethodSubtype();
- final InputMethodSubtype lastActiveSubtype = mLastActiveSubtype;
- final boolean currentSubtypeHasBeenUsed = mCurrentSubtypeHasBeenUsed;
- if (currentSubtypeHasBeenUsed) {
- mLastActiveSubtype = currentSubtype;
- mCurrentSubtypeHasBeenUsed = false;
- }
- if (currentSubtypeHasBeenUsed
- && richImm.checkIfSubtypeBelongsToThisImeAndEnabled(lastActiveSubtype)
- && !currentSubtype.equals(lastActiveSubtype)) {
- richImm.setInputMethodAndSubtype(token, lastActiveSubtype);
- return;
- }
- richImm.switchToNextInputMethod(token, true /* onlyCurrentIme */);
- }
- }
-
- // Loading the native library eagerly to avoid unexpected UnsatisfiedLinkError at the initial
- // JNI call as much as possible.
- static {
- JniUtils.loadNativeLibrary();
- }
-
- public LatinIME() {
- super();
- mSettings = Settings.getInstance();
- mKeyboardSwitcher = KeyboardSwitcher.getInstance();
- mStatsUtilsManager = StatsUtilsManager.getInstance();
- mIsHardwareAcceleratedDrawingEnabled =
- InputMethodServiceCompatUtils.enableHardwareAcceleration(this);
- Log.i(TAG, "Hardware accelerated drawing: " + mIsHardwareAcceleratedDrawingEnabled);
- }
-
- @Override
- public void onCreate() {
- Settings.init(this);
- DebugFlags.init(PreferenceManager.getDefaultSharedPreferences(this));
- RichInputMethodManager.init(this);
- mRichImm = RichInputMethodManager.getInstance();
- AudioAndHapticFeedbackManager.init(this);
- AccessibilityUtils.init(this);
- mStatsUtilsManager.onCreate(this /* context */, mDictionaryFacilitator);
- final WindowManager wm = getSystemService(WindowManager.class);
- mDisplayContext = getDisplayContext();
- KeyboardSwitcher.init(this);
- super.onCreate();
-
- mHandler.onCreate();
-
- // TODO: Resolve mutual dependencies of {@link #loadSettings()} and
- // {@link #resetDictionaryFacilitatorIfNecessary()}.
- loadSettings();
- resetDictionaryFacilitatorIfNecessary();
-
- // Register to receive ringer mode change.
- final IntentFilter filter = new IntentFilter();
- filter.addAction(AudioManager.RINGER_MODE_CHANGED_ACTION);
- registerReceiver(mRingerModeChangeReceiver, filter);
-
- // Register to receive installation and removal of a dictionary pack.
- final IntentFilter packageFilter = new IntentFilter();
- packageFilter.addAction(Intent.ACTION_PACKAGE_ADDED);
- packageFilter.addAction(Intent.ACTION_PACKAGE_REMOVED);
- packageFilter.addDataScheme(SCHEME_PACKAGE);
- registerReceiver(mDictionaryPackInstallReceiver, packageFilter);
-
- final IntentFilter newDictFilter = new IntentFilter();
- newDictFilter.addAction(DictionaryPackConstants.NEW_DICTIONARY_INTENT_ACTION);
- if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
- registerReceiver(mDictionaryPackInstallReceiver, newDictFilter,
- Context.RECEIVER_NOT_EXPORTED);
- } else {
- registerReceiver(mDictionaryPackInstallReceiver, newDictFilter);
- }
-
- final IntentFilter dictDumpFilter = new IntentFilter();
- dictDumpFilter.addAction(DictionaryDumpBroadcastReceiver.DICTIONARY_DUMP_INTENT_ACTION);
- if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
- registerReceiver(mDictionaryDumpBroadcastReceiver, dictDumpFilter,
- Context.RECEIVER_NOT_EXPORTED);
- } else {
- registerReceiver(mDictionaryDumpBroadcastReceiver, dictDumpFilter);
- }
-
- final IntentFilter hideSoftInputFilter = new IntentFilter();
- hideSoftInputFilter.addAction(ACTION_HIDE_SOFT_INPUT);
- if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
- registerReceiver(mHideSoftInputReceiver, hideSoftInputFilter,
- PERMISSION_HIDE_SOFT_INPUT, null /* scheduler */, Context.RECEIVER_EXPORTED);
- } else {
- registerReceiver(mHideSoftInputReceiver, hideSoftInputFilter,
- PERMISSION_HIDE_SOFT_INPUT, null /* scheduler */);
- }
-
- StatsUtils.onCreate(mSettings.getCurrent(), mRichImm);
- }
-
- // Has to be package-visible for unit tests
- @UsedForTesting
- void loadSettings() {
- final Locale locale = mRichImm.getCurrentSubtypeLocale();
- final EditorInfo editorInfo = getCurrentInputEditorInfo();
- final InputAttributes inputAttributes = new InputAttributes(
- editorInfo, isFullscreenMode(), getPackageName());
- mSettings.loadSettings(this, locale, inputAttributes);
- final SettingsValues currentSettingsValues = mSettings.getCurrent();
- AudioAndHapticFeedbackManager.getInstance().onSettingsChanged(currentSettingsValues);
- // This method is called on startup and language switch, before the new layout has
- // been displayed. Opening dictionaries never affects responsivity as dictionaries are
- // asynchronously loaded.
- if (!mHandler.hasPendingReopenDictionaries()) {
- resetDictionaryFacilitator(locale);
- }
- refreshPersonalizationDictionarySession(currentSettingsValues);
- resetDictionaryFacilitatorIfNecessary();
- mStatsUtilsManager.onLoadSettings(this /* context */, currentSettingsValues);
- }
-
- private void refreshPersonalizationDictionarySession(
- final SettingsValues currentSettingsValues) {
- if (!currentSettingsValues.mUsePersonalizedDicts) {
- // Remove user history dictionaries.
- PersonalizationHelper.removeAllUserHistoryDictionaries(this);
- mDictionaryFacilitator.clearUserHistoryDictionary(this);
- }
- }
-
- // Note that this method is called from a non-UI thread.
- @Override
- public void onUpdateMainDictionaryAvailability(final boolean isMainDictionaryAvailable) {
- final MainKeyboardView mainKeyboardView = mKeyboardSwitcher.getMainKeyboardView();
- if (mainKeyboardView != null) {
- mainKeyboardView.setMainDictionaryAvailability(isMainDictionaryAvailable);
- }
- if (mHandler.hasPendingWaitForDictionaryLoad()) {
- mHandler.cancelWaitForDictionaryLoad();
- mHandler.postResumeSuggestions(false /* shouldDelay */);
- }
- }
-
- void resetDictionaryFacilitatorIfNecessary() {
- final Locale subtypeSwitcherLocale = mRichImm.getCurrentSubtypeLocale();
- final Locale subtypeLocale;
- if (subtypeSwitcherLocale == null) {
- // This happens in very rare corner cases - for example, immediately after a switch
- // to LatinIME has been requested, about a frame later another switch happens. In this
- // case, we are about to go down but we still don't know it, however the system tells
- // us there is no current subtype.
- Log.e(TAG, "System is reporting no current subtype.");
- subtypeLocale = getResources().getConfiguration().locale;
- } else {
- subtypeLocale = subtypeSwitcherLocale;
- }
- if (mDictionaryFacilitator.isForLocale(subtypeLocale)
- && mDictionaryFacilitator.isForAccount(mSettings.getCurrent().mAccount)) {
- return;
- }
- resetDictionaryFacilitator(subtypeLocale);
- }
-
- /**
- * Reset the facilitator by loading dictionaries for the given locale and
- * the current settings values.
- *
- * @param locale the locale
- */
- // TODO: make sure the current settings always have the right locales, and read from them.
- private void resetDictionaryFacilitator(final Locale locale) {
- final SettingsValues settingsValues = mSettings.getCurrent();
- mDictionaryFacilitator.resetDictionaries(this /* context */, locale,
- settingsValues.mUseContactsDict, settingsValues.mUsePersonalizedDicts,
- false /* forceReloadMainDictionary */,
- settingsValues.mAccount, "" /* dictNamePrefix */,
- this /* DictionaryInitializationListener */);
- if (settingsValues.mAutoCorrectionEnabledPerUserSettings) {
- mInputLogic.mSuggest.setAutoCorrectionThreshold(
- settingsValues.mAutoCorrectionThreshold);
- }
- mInputLogic.mSuggest.setPlausibilityThreshold(settingsValues.mPlausibilityThreshold);
- }
-
- /**
- * Reset suggest by loading the main dictionary of the current locale.
- */
- /* package private */ void resetSuggestMainDict() {
- final SettingsValues settingsValues = mSettings.getCurrent();
- mDictionaryFacilitator.resetDictionaries(this /* context */,
- mDictionaryFacilitator.getLocale(), settingsValues.mUseContactsDict,
- settingsValues.mUsePersonalizedDicts,
- true /* forceReloadMainDictionary */,
- settingsValues.mAccount, "" /* dictNamePrefix */,
- this /* DictionaryInitializationListener */);
- }
-
- @Override
- public void onDestroy() {
- mDictionaryFacilitator.closeDictionaries();
- mSettings.onDestroy();
- unregisterReceiver(mHideSoftInputReceiver);
- unregisterReceiver(mRingerModeChangeReceiver);
- unregisterReceiver(mDictionaryPackInstallReceiver);
- unregisterReceiver(mDictionaryDumpBroadcastReceiver);
- mStatsUtilsManager.onDestroy(this /* context */);
- super.onDestroy();
- }
-
- @UsedForTesting
- public void recycle() {
- unregisterReceiver(mDictionaryPackInstallReceiver);
- unregisterReceiver(mDictionaryDumpBroadcastReceiver);
- unregisterReceiver(mRingerModeChangeReceiver);
- mInputLogic.recycle();
- }
-
- private boolean isImeSuppressedByHardwareKeyboard() {
- final KeyboardSwitcher switcher = KeyboardSwitcher.getInstance();
- return !onEvaluateInputViewShown() && switcher.isImeSuppressedByHardwareKeyboard(
- mSettings.getCurrent(), switcher.getKeyboardSwitchState());
- }
-
- @Override
- public void onConfigurationChanged(final Configuration conf) {
- SettingsValues settingsValues = mSettings.getCurrent();
- if (settingsValues.mDisplayOrientation != conf.orientation) {
- mHandler.startOrientationChanging();
- mInputLogic.onOrientationChange(mSettings.getCurrent());
- }
- if (settingsValues.mHasHardwareKeyboard != Settings.readHasHardwareKeyboard(conf)) {
- // If the state of having a hardware keyboard changed, then we want to reload the
- // settings to adjust for that.
- // TODO: we should probably do this unconditionally here, rather than only when we
- // have a change in hardware keyboard configuration.
- loadSettings();
- settingsValues = mSettings.getCurrent();
- if (isImeSuppressedByHardwareKeyboard()) {
- // We call cleanupInternalStateForFinishInput() because it's the right thing to do;
- // however, it seems at the moment the framework is passing us a seemingly valid
- // but actually non-functional InputConnection object. So if this bug ever gets
- // fixed we'll be able to remove the composition, but until it is this code is
- // actually not doing much.
- cleanupInternalStateForFinishInput();
- }
- }
- super.onConfigurationChanged(conf);
- }
-
- @Override
- public void onInitializeInterface() {
- mDisplayContext = getDisplayContext();
- mKeyboardSwitcher.updateKeyboardTheme(mDisplayContext);
- }
-
- /**
- * Returns the context object whose resources are adjusted to match the metrics of the display.
- *
- * Note that before {@link android.os.Build.VERSION_CODES#KITKAT}, there is no way to support
- * multi-display scenarios, so the context object will just return the IME context itself.
- *
- * With initiating multi-display APIs from {@link android.os.Build.VERSION_CODES#KITKAT}, the
- * context object has to return with re-creating the display context according the metrics
- * of the display in runtime.
- *
- * Starts from {@link android.os.Build.VERSION_CODES#S_V2}, the returning context object has
- * became to IME context self since it ends up capable of updating its resources internally.
- *
- * @see android.content.Context#createDisplayContext(Display)
- */
- private @NonNull Context getDisplayContext() {
- if (Build.VERSION.SDK_INT < Build.VERSION_CODES.KITKAT) {
- // createDisplayContext is not available.
- return this;
- }
- if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S_V2) {
- // IME context sources is now managed by WindowProviderService from Android 12L.
- return this;
- }
- // An issue in Q that non-activity components Resources / DisplayMetrics in
- // Context doesn't well updated when the IME window moving to external display.
- // Currently we do a workaround is to create new display context directly and re-init
- // keyboard layout with this context.
- final WindowManager wm = (WindowManager) getSystemService(Context.WINDOW_SERVICE);
- return createDisplayContext(wm.getDefaultDisplay());
- }
-
- @Override
- public View onCreateInputView() {
- StatsUtils.onCreateInputView();
- return mKeyboardSwitcher.onCreateInputView(mDisplayContext,
- mIsHardwareAcceleratedDrawingEnabled);
- }
-
- @Override
- public void setInputView(final View view) {
- super.setInputView(view);
- mInputView = view;
- mInsetsUpdater = ViewOutlineProviderCompatUtils.setInsetsOutlineProvider(view);
- updateSoftInputWindowLayoutParameters();
- mSuggestionStripView = (SuggestionStripView)view.findViewById(R.id.suggestion_strip_view);
- if (hasSuggestionStripView()) {
- mSuggestionStripView.setListener(this, view);
- }
- }
-
- @Override
- public void setCandidatesView(final View view) {
- // To ensure that CandidatesView will never be set.
- }
-
- @Override
- public void onStartInput(final EditorInfo editorInfo, final boolean restarting) {
- mHandler.onStartInput(editorInfo, restarting);
- }
-
- @Override
- public void onStartInputView(final EditorInfo editorInfo, final boolean restarting) {
- mHandler.onStartInputView(editorInfo, restarting);
- mStatsUtilsManager.onStartInputView();
- }
-
- @Override
- public void onFinishInputView(final boolean finishingInput) {
- StatsUtils.onFinishInputView();
- mHandler.onFinishInputView(finishingInput);
- mStatsUtilsManager.onFinishInputView();
- mGestureConsumer = GestureConsumer.NULL_GESTURE_CONSUMER;
- }
-
- @Override
- public void onFinishInput() {
- mHandler.onFinishInput();
- }
-
- @Override
- public void onCurrentInputMethodSubtypeChanged(final InputMethodSubtype subtype) {
- // Note that the calling sequence of onCreate() and onCurrentInputMethodSubtypeChanged()
- // is not guaranteed. It may even be called at the same time on a different thread.
- InputMethodSubtype oldSubtype = mRichImm.getCurrentSubtype().getRawSubtype();
- StatsUtils.onSubtypeChanged(oldSubtype, subtype);
- mRichImm.onSubtypeChanged(subtype);
- mInputLogic.onSubtypeChanged(SubtypeLocaleUtils.getCombiningRulesExtraValue(subtype),
- mSettings.getCurrent());
- loadKeyboard();
- }
-
- void onStartInputInternal(final EditorInfo editorInfo, final boolean restarting) {
- super.onStartInput(editorInfo, restarting);
-
- // If the primary hint language does not match the current subtype language, then try
- // to switch to the primary hint language.
- // TODO: Support all the locales in EditorInfo#hintLocales.
- final Locale primaryHintLocale = EditorInfoCompatUtils.getPrimaryHintLocale(editorInfo);
- if (primaryHintLocale == null) {
- return;
- }
- final InputMethodSubtype newSubtype = mRichImm.findSubtypeByLocale(primaryHintLocale);
- if (newSubtype == null || newSubtype.equals(mRichImm.getCurrentSubtype().getRawSubtype())) {
- return;
- }
- mHandler.postSwitchLanguage(newSubtype);
- }
-
- @SuppressWarnings("deprecation")
- void onStartInputViewInternal(final EditorInfo editorInfo, final boolean restarting) {
- super.onStartInputView(editorInfo, restarting);
-
- mDictionaryFacilitator.onStartInput();
- // Switch to the null consumer to handle cases leading to early exit below, for which we
- // also wouldn't be consuming gesture data.
- mGestureConsumer = GestureConsumer.NULL_GESTURE_CONSUMER;
- mRichImm.refreshSubtypeCaches();
- final KeyboardSwitcher switcher = mKeyboardSwitcher;
- switcher.updateKeyboardTheme(mDisplayContext);
- final MainKeyboardView mainKeyboardView = switcher.getMainKeyboardView();
- // If we are starting input in a different text field from before, we'll have to reload
- // settings, so currentSettingsValues can't be final.
- SettingsValues currentSettingsValues = mSettings.getCurrent();
-
- if (editorInfo == null) {
- Log.e(TAG, "Null EditorInfo in onStartInputView()");
- if (DebugFlags.DEBUG_ENABLED) {
- throw new NullPointerException("Null EditorInfo in onStartInputView()");
- }
- return;
- }
- if (DebugFlags.DEBUG_ENABLED) {
- Log.d(TAG, "onStartInputView: editorInfo:"
- + String.format("inputType=0x%08x imeOptions=0x%08x",
- editorInfo.inputType, editorInfo.imeOptions));
- Log.d(TAG, "All caps = "
- + ((editorInfo.inputType & InputType.TYPE_TEXT_FLAG_CAP_CHARACTERS) != 0)
- + ", sentence caps = "
- + ((editorInfo.inputType & InputType.TYPE_TEXT_FLAG_CAP_SENTENCES) != 0)
- + ", word caps = "
- + ((editorInfo.inputType & InputType.TYPE_TEXT_FLAG_CAP_WORDS) != 0));
- }
- Log.i(TAG, "Starting input. Cursor position = "
- + editorInfo.initialSelStart + "," + editorInfo.initialSelEnd);
- // TODO: Consolidate these checks with {@link InputAttributes}.
- if (InputAttributes.inPrivateImeOptions(null, NO_MICROPHONE_COMPAT, editorInfo)) {
- Log.w(TAG, "Deprecated private IME option specified: " + editorInfo.privateImeOptions);
- Log.w(TAG, "Use " + getPackageName() + "." + NO_MICROPHONE + " instead");
- }
- if (InputAttributes.inPrivateImeOptions(getPackageName(), FORCE_ASCII, editorInfo)) {
- Log.w(TAG, "Deprecated private IME option specified: " + editorInfo.privateImeOptions);
- Log.w(TAG, "Use EditorInfo.IME_FLAG_FORCE_ASCII flag instead");
- }
-
- // In landscape mode, this method gets called without the input view being created.
- if (mainKeyboardView == null) {
- return;
- }
-
- // Update to a gesture consumer with the current editor and IME state.
- mGestureConsumer = GestureConsumer.newInstance(editorInfo,
- mInputLogic.getPrivateCommandPerformer(),
- mRichImm.getCurrentSubtypeLocale(),
- switcher.getKeyboard());
-
- // Forward this event to the accessibility utilities, if enabled.
- final AccessibilityUtils accessUtils = AccessibilityUtils.getInstance();
- if (accessUtils.isTouchExplorationEnabled()) {
- accessUtils.onStartInputViewInternal(mainKeyboardView, editorInfo, restarting);
- }
-
- final boolean inputTypeChanged = !currentSettingsValues.isSameInputType(editorInfo);
- final boolean isDifferentTextField = !restarting || inputTypeChanged;
-
- StatsUtils.onStartInputView(editorInfo.inputType,
- Settings.getInstance().getCurrent().mDisplayOrientation,
- !isDifferentTextField);
-
- // The EditorInfo might have a flag that affects fullscreen mode.
- // Note: This call should be done by InputMethodService?
- updateFullscreenMode();
-
- // ALERT: settings have not been reloaded and there is a chance they may be stale.
- // In the practice, if it is, we should have gotten onConfigurationChanged so it should
- // be fine, but this is horribly confusing and must be fixed AS SOON AS POSSIBLE.
-
- // In some cases the input connection has not been reset yet and we can't access it. In
- // this case we will need to call loadKeyboard() later, when it's accessible, so that we
- // can go into the correct mode, so we need to do some housekeeping here.
- final boolean needToCallLoadKeyboardLater;
- final Suggest suggest = mInputLogic.mSuggest;
- if (!isImeSuppressedByHardwareKeyboard()) {
- // The app calling setText() has the effect of clearing the composing
- // span, so we should reset our state unconditionally, even if restarting is true.
- // We also tell the input logic about the combining rules for the current subtype, so
- // it can adjust its combiners if needed.
- mInputLogic.startInput(mRichImm.getCombiningRulesExtraValueOfCurrentSubtype(),
- currentSettingsValues);
-
- resetDictionaryFacilitatorIfNecessary();
-
- // TODO[IL]: Can the following be moved to InputLogic#startInput?
- if (!mInputLogic.mConnection.resetCachesUponCursorMoveAndReturnSuccess(
- editorInfo.initialSelStart, editorInfo.initialSelEnd,
- false /* shouldFinishComposition */)) {
- // Sometimes, while rotating, for some reason the framework tells the app we are not
- // connected to it and that means we can't refresh the cache. In this case, schedule
- // a refresh later.
- // We try resetting the caches up to 5 times before giving up.
- mHandler.postResetCaches(isDifferentTextField, 5 /* remainingTries */);
- // mLastSelection{Start,End} are reset later in this method, no need to do it here
- needToCallLoadKeyboardLater = true;
- } else {
- // When rotating, and when input is starting again in a field from where the focus
- // didn't move (the keyboard having been closed with the back key),
- // initialSelStart and initialSelEnd sometimes are lying. Make a best effort to
- // work around this bug.
- mInputLogic.mConnection.tryFixLyingCursorPosition();
- mHandler.postResumeSuggestionsForStartInput(true /* shouldDelay */);
- needToCallLoadKeyboardLater = false;
- }
- } else {
- // If we have a hardware keyboard we don't need to call loadKeyboard later anyway.
- needToCallLoadKeyboardLater = false;
- }
-
- if (isDifferentTextField ||
- !currentSettingsValues.hasSameOrientation(getResources().getConfiguration())) {
- loadSettings();
- }
- if (isDifferentTextField) {
- mainKeyboardView.closing();
- currentSettingsValues = mSettings.getCurrent();
-
- if (currentSettingsValues.mAutoCorrectionEnabledPerUserSettings) {
- suggest.setAutoCorrectionThreshold(
- currentSettingsValues.mAutoCorrectionThreshold);
- }
- suggest.setPlausibilityThreshold(currentSettingsValues.mPlausibilityThreshold);
-
- switcher.loadKeyboard(editorInfo, currentSettingsValues, getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- if (needToCallLoadKeyboardLater) {
- // If we need to call loadKeyboard again later, we need to save its state now. The
- // later call will be done in #retryResetCaches.
- switcher.saveKeyboardState();
- }
- } else if (restarting) {
- // TODO: Come up with a more comprehensive way to reset the keyboard layout when
- // a keyboard layout set doesn't get reloaded in this method.
- switcher.resetKeyboardStateToAlphabet(getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- // In apps like Talk, we come here when the text is sent and the field gets emptied and
- // we need to re-evaluate the shift state, but not the whole layout which would be
- // disruptive.
- // Space state must be updated before calling updateShiftState
- switcher.requestUpdatingShiftState(getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- }
- // This will set the punctuation suggestions if next word suggestion is off;
- // otherwise it will clear the suggestion strip.
- setNeutralSuggestionStrip();
-
- mHandler.cancelUpdateSuggestionStrip();
-
- mainKeyboardView.setMainDictionaryAvailability(
- mDictionaryFacilitator.hasAtLeastOneInitializedMainDictionary());
- mainKeyboardView.setKeyPreviewPopupEnabled(currentSettingsValues.mKeyPreviewPopupOn,
- currentSettingsValues.mKeyPreviewPopupDismissDelay);
- mainKeyboardView.setSlidingKeyInputPreviewEnabled(
- currentSettingsValues.mSlidingKeyInputPreviewEnabled);
- mainKeyboardView.setGestureHandlingEnabledByUser(
- currentSettingsValues.mGestureInputEnabled,
- currentSettingsValues.mGestureTrailEnabled,
- currentSettingsValues.mGestureFloatingPreviewTextEnabled);
-
- if (TRACE) Debug.startMethodTracing("/data/trace/latinime");
- }
-
- @Override
- public void onWindowShown() {
- super.onWindowShown();
- setNavigationBarVisibility(isInputViewShown());
- }
-
- @Override
- public void onWindowHidden() {
- super.onWindowHidden();
- final MainKeyboardView mainKeyboardView = mKeyboardSwitcher.getMainKeyboardView();
- if (mainKeyboardView != null) {
- mainKeyboardView.closing();
- }
- setNavigationBarVisibility(false);
- }
-
- void onFinishInputInternal() {
- super.onFinishInput();
-
- mDictionaryFacilitator.onFinishInput(this);
- final MainKeyboardView mainKeyboardView = mKeyboardSwitcher.getMainKeyboardView();
- if (mainKeyboardView != null) {
- mainKeyboardView.closing();
- }
- }
-
- void onFinishInputViewInternal(final boolean finishingInput) {
- super.onFinishInputView(finishingInput);
- cleanupInternalStateForFinishInput();
- }
-
- private void cleanupInternalStateForFinishInput() {
- // Remove pending messages related to update suggestions
- mHandler.cancelUpdateSuggestionStrip();
- // Should do the following in onFinishInputInternal but until JB MR2 it's not called :(
- mInputLogic.finishInput();
- }
-
- protected void deallocateMemory() {
- mKeyboardSwitcher.deallocateMemory();
- }
-
- @Override
- public void onUpdateSelection(final int oldSelStart, final int oldSelEnd,
- final int newSelStart, final int newSelEnd,
- final int composingSpanStart, final int composingSpanEnd) {
- super.onUpdateSelection(oldSelStart, oldSelEnd, newSelStart, newSelEnd,
- composingSpanStart, composingSpanEnd);
- if (DebugFlags.DEBUG_ENABLED) {
- Log.i(TAG, "onUpdateSelection: oss=" + oldSelStart + ", ose=" + oldSelEnd
- + ", nss=" + newSelStart + ", nse=" + newSelEnd
- + ", cs=" + composingSpanStart + ", ce=" + composingSpanEnd);
- }
-
- // This call happens whether our view is displayed or not, but if it's not then we should
- // not attempt recorrection. This is true even with a hardware keyboard connected: if the
- // view is not displayed we have no means of showing suggestions anyway, and if it is then
- // we want to show suggestions anyway.
- final SettingsValues settingsValues = mSettings.getCurrent();
- if (isInputViewShown()
- && mInputLogic.onUpdateSelection(oldSelStart, oldSelEnd, newSelStart, newSelEnd,
- settingsValues)) {
- mKeyboardSwitcher.requestUpdatingShiftState(getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- }
- }
-
- /**
- * This is called when the user has clicked on the extracted text view,
- * when running in fullscreen mode. The default implementation hides
- * the suggestions view when this happens, but only if the extracted text
- * editor has a vertical scroll bar because its text doesn't fit.
- * Here we override the behavior due to the possibility that a re-correction could
- * cause the suggestions strip to disappear and re-appear.
- */
- @Override
- public void onExtractedTextClicked() {
- if (mSettings.getCurrent().needsToLookupSuggestions()) {
- return;
- }
-
- super.onExtractedTextClicked();
- }
-
- /**
- * This is called when the user has performed a cursor movement in the
- * extracted text view, when it is running in fullscreen mode. The default
- * implementation hides the suggestions view when a vertical movement
- * happens, but only if the extracted text editor has a vertical scroll bar
- * because its text doesn't fit.
- * Here we override the behavior due to the possibility that a re-correction could
- * cause the suggestions strip to disappear and re-appear.
- */
- @Override
- public void onExtractedCursorMovement(final int dx, final int dy) {
- if (mSettings.getCurrent().needsToLookupSuggestions()) {
- return;
- }
-
- super.onExtractedCursorMovement(dx, dy);
- }
-
- @Override
- public void hideWindow() {
- mKeyboardSwitcher.onHideWindow();
-
- if (TRACE) Debug.stopMethodTracing();
- if (isShowingOptionDialog()) {
- mOptionsDialog.dismiss();
- mOptionsDialog = null;
- }
- super.hideWindow();
- }
-
- @Override
- public void onDisplayCompletions(final CompletionInfo[] applicationSpecifiedCompletions) {
- if (DebugFlags.DEBUG_ENABLED) {
- Log.i(TAG, "Received completions:");
- if (applicationSpecifiedCompletions != null) {
- for (int i = 0; i < applicationSpecifiedCompletions.length; i++) {
- Log.i(TAG, " #" + i + ": " + applicationSpecifiedCompletions[i]);
- }
- }
- }
- if (!mSettings.getCurrent().isApplicationSpecifiedCompletionsOn()) {
- return;
- }
- // If we have an update request in flight, we need to cancel it so it does not override
- // these completions.
- mHandler.cancelUpdateSuggestionStrip();
- if (applicationSpecifiedCompletions == null) {
- setNeutralSuggestionStrip();
- return;
- }
-
- final ArrayList<SuggestedWords.SuggestedWordInfo> applicationSuggestedWords =
- SuggestedWords.getFromApplicationSpecifiedCompletions(
- applicationSpecifiedCompletions);
- final SuggestedWords suggestedWords = new SuggestedWords(applicationSuggestedWords,
- null /* rawSuggestions */,
- null /* typedWord */,
- false /* typedWordValid */,
- false /* willAutoCorrect */,
- false /* isObsoleteSuggestions */,
- SuggestedWords.INPUT_STYLE_APPLICATION_SPECIFIED /* inputStyle */,
- SuggestedWords.NOT_A_SEQUENCE_NUMBER);
- // When in fullscreen mode, show completions generated by the application forcibly
- setSuggestedWords(suggestedWords);
- }
-
- @Override
- public void onComputeInsets(final InputMethodService.Insets outInsets) {
- super.onComputeInsets(outInsets);
- // This method may be called before {@link #setInputView(View)}.
- if (mInputView == null) {
- return;
- }
- final SettingsValues settingsValues = mSettings.getCurrent();
- final View visibleKeyboardView = mKeyboardSwitcher.getVisibleKeyboardView();
- if (visibleKeyboardView == null || !hasSuggestionStripView()) {
- return;
- }
- final int inputHeight = mInputView.getHeight();
- if (isImeSuppressedByHardwareKeyboard() && !visibleKeyboardView.isShown()) {
- // If there is a hardware keyboard and a visible software keyboard view has been hidden,
- // no visual element will be shown on the screen.
- outInsets.contentTopInsets = inputHeight;
- outInsets.visibleTopInsets = inputHeight;
- mInsetsUpdater.setInsets(outInsets);
- return;
- }
- final int suggestionsHeight = (!mKeyboardSwitcher.isShowingEmojiPalettes()
- && mSuggestionStripView.getVisibility() == View.VISIBLE)
- ? mSuggestionStripView.getHeight() : 0;
- final int visibleTopY = inputHeight - visibleKeyboardView.getHeight() - suggestionsHeight;
- mSuggestionStripView.setMoreSuggestionsHeight(visibleTopY);
- // Need to set expanded touchable region only if a keyboard view is being shown.
- if (visibleKeyboardView.isShown()) {
- final int touchLeft = 0;
- final int touchTop = mKeyboardSwitcher.isShowingMoreKeysPanel() ? 0 : visibleTopY;
- final int touchRight = visibleKeyboardView.getWidth();
- final int touchBottom = inputHeight;
- outInsets.touchableInsets = InputMethodService.Insets.TOUCHABLE_INSETS_REGION;
- outInsets.touchableRegion.set(touchLeft, touchTop, touchRight, touchBottom);
- }
- outInsets.contentTopInsets = visibleTopY;
- outInsets.visibleTopInsets = visibleTopY;
- mInsetsUpdater.setInsets(outInsets);
- }
-
- public void startShowingInputView(final boolean needsToLoadKeyboard) {
- mIsExecutingStartShowingInputView = true;
- // This {@link #showWindow(boolean)} will eventually call back
- // {@link #onEvaluateInputViewShown()}.
- showWindow(true /* showInput */);
- mIsExecutingStartShowingInputView = false;
- if (needsToLoadKeyboard) {
- loadKeyboard();
- }
- }
-
- public void stopShowingInputView() {
- showWindow(false /* showInput */);
- }
-
- @Override
- public boolean onShowInputRequested(final int flags, final boolean configChange) {
- if (isImeSuppressedByHardwareKeyboard()) {
- return true;
- }
- return super.onShowInputRequested(flags, configChange);
- }
-
- @Override
- public boolean onEvaluateInputViewShown() {
- if (mIsExecutingStartShowingInputView) {
- return true;
- }
- return super.onEvaluateInputViewShown();
- }
-
- @Override
- public boolean onEvaluateFullscreenMode() {
- final SettingsValues settingsValues = mSettings.getCurrent();
- if (isImeSuppressedByHardwareKeyboard()) {
- // If there is a hardware keyboard, disable full screen mode.
- return false;
- }
- // Reread resource value here, because this method is called by the framework as needed.
- final boolean isFullscreenModeAllowed = Settings.readUseFullscreenMode(getResources());
- if (super.onEvaluateFullscreenMode() && isFullscreenModeAllowed) {
- // TODO: Remove this hack. Actually we should not really assume NO_EXTRACT_UI
- // implies NO_FULLSCREEN. However, the framework mistakenly does. i.e. NO_EXTRACT_UI
- // without NO_FULLSCREEN doesn't work as expected. Because of this we need this
- // hack for now. Let's get rid of this once the framework gets fixed.
- final EditorInfo ei = getCurrentInputEditorInfo();
- return !(ei != null && ((ei.imeOptions & EditorInfo.IME_FLAG_NO_EXTRACT_UI) != 0));
- }
- return false;
- }
-
- @Override
- public void updateFullscreenMode() {
- super.updateFullscreenMode();
- updateSoftInputWindowLayoutParameters();
- }
-
- private void updateSoftInputWindowLayoutParameters() {
- // Override layout parameters to expand {@link SoftInputWindow} to the entire screen.
- // See {@link InputMethodService#setinputView(View)} and
- // {@link SoftInputWindow#updateWidthHeight(WindowManager.LayoutParams)}.
- final Window window = getWindow().getWindow();
- ViewLayoutUtils.updateLayoutHeightOf(window, LayoutParams.MATCH_PARENT);
- // This method may be called before {@link #setInputView(View)}.
- if (mInputView != null) {
- // In non-fullscreen mode, {@link InputView} and its parent inputArea should expand to
- // the entire screen and be placed at the bottom of {@link SoftInputWindow}.
- // In fullscreen mode, these shouldn't expand to the entire screen and should be
- // coexistent with {@link #mExtractedArea} above.
- // See {@link InputMethodService#setInputView(View) and
- // com.android.internal.R.layout.input_method.xml.
- final int layoutHeight = isFullscreenMode()
- ? LayoutParams.WRAP_CONTENT : LayoutParams.MATCH_PARENT;
- final View inputArea = window.findViewById(android.R.id.inputArea);
- ViewLayoutUtils.updateLayoutHeightOf(inputArea, layoutHeight);
- ViewLayoutUtils.updateLayoutGravityOf(inputArea, Gravity.BOTTOM);
- ViewLayoutUtils.updateLayoutHeightOf(mInputView, layoutHeight);
- }
- }
-
- int getCurrentAutoCapsState() {
- return mInputLogic.getCurrentAutoCapsState(mSettings.getCurrent());
- }
-
- int getCurrentRecapitalizeState() {
- return mInputLogic.getCurrentRecapitalizeState();
- }
-
- /**
- * @param codePoints code points to get coordinates for.
- * @return x,y coordinates for this keyboard, as a flattened array.
- */
- public int[] getCoordinatesForCurrentKeyboard(final int[] codePoints) {
- final Keyboard keyboard = mKeyboardSwitcher.getKeyboard();
- if (null == keyboard) {
- return CoordinateUtils.newCoordinateArray(codePoints.length,
- Constants.NOT_A_COORDINATE, Constants.NOT_A_COORDINATE);
- }
- return keyboard.getCoordinates(codePoints);
- }
-
- // Callback for the {@link SuggestionStripView}, to call when the important notice strip is
- // pressed.
- @Override
- public void showImportantNoticeContents() {
- PermissionsManager.get(this).requestPermissions(
- this /* PermissionsResultCallback */,
- null /* activity */, permission.READ_CONTACTS);
- }
-
- @Override
- public void onRequestPermissionsResult(boolean allGranted) {
- ImportantNoticeUtils.updateContactsNoticeShown(this /* context */);
- setNeutralSuggestionStrip();
- }
-
- public void displaySettingsDialog() {
- if (isShowingOptionDialog()) {
- return;
- }
- showSubtypeSelectorAndSettings();
- }
-
- @Override
- public boolean onCustomRequest(final int requestCode) {
- if (isShowingOptionDialog()) return false;
- switch (requestCode) {
- case Constants.CUSTOM_CODE_SHOW_INPUT_METHOD_PICKER:
- if (mRichImm.hasMultipleEnabledIMEsOrSubtypes(true /* include aux subtypes */)) {
- mRichImm.getInputMethodManager().showInputMethodPicker();
- return true;
- }
- return false;
- }
- return false;
- }
-
- private boolean isShowingOptionDialog() {
- return mOptionsDialog != null && mOptionsDialog.isShowing();
- }
-
- public void switchLanguage(final InputMethodSubtype subtype) {
- final IBinder token = getWindow().getWindow().getAttributes().token;
- mRichImm.setInputMethodAndSubtype(token, subtype);
- }
-
- // TODO: Revise the language switch key behavior to make it much smarter and more reasonable.
- public void switchToNextSubtype() {
- final IBinder token = getWindow().getWindow().getAttributes().token;
- if (shouldSwitchToOtherInputMethods()) {
- mRichImm.switchToNextInputMethod(token, false /* onlyCurrentIme */);
- return;
- }
- mSubtypeState.switchSubtype(token, mRichImm);
- }
-
- // TODO: Instead of checking for alphabetic keyboard here, separate keycodes for
- // alphabetic shift and shift while in symbol layout and get rid of this method.
- private int getCodePointForKeyboard(final int codePoint) {
- if (Constants.CODE_SHIFT == codePoint) {
- final Keyboard currentKeyboard = mKeyboardSwitcher.getKeyboard();
- if (null != currentKeyboard && currentKeyboard.mId.isAlphabetKeyboard()) {
- return codePoint;
- }
- return Constants.CODE_SYMBOL_SHIFT;
- }
- return codePoint;
- }
-
- // Implementation of {@link KeyboardActionListener}.
- @Override
- public void onCodeInput(final int codePoint, final int x, final int y,
- final boolean isKeyRepeat) {
- // TODO: this processing does not belong inside LatinIME, the caller should be doing this.
- final MainKeyboardView mainKeyboardView = mKeyboardSwitcher.getMainKeyboardView();
- // x and y include some padding, but everything down the line (especially native
- // code) needs the coordinates in the keyboard frame.
- // TODO: We should reconsider which coordinate system should be used to represent
- // keyboard event. Also we should pull this up -- LatinIME has no business doing
- // this transformation, it should be done already before calling onEvent.
- final int keyX = mainKeyboardView.getKeyX(x);
- final int keyY = mainKeyboardView.getKeyY(y);
- final Event event = createSoftwareKeypressEvent(getCodePointForKeyboard(codePoint),
- keyX, keyY, isKeyRepeat);
- onEvent(event);
- }
-
- // This method is public for testability of LatinIME, but also in the future it should
- // completely replace #onCodeInput.
- public void onEvent(@Nonnull final Event event) {
- if (Constants.CODE_SHORTCUT == event.mKeyCode) {
- mRichImm.switchToShortcutIme(this);
- }
- final InputTransaction completeInputTransaction =
- mInputLogic.onCodeInput(mSettings.getCurrent(), event,
- mKeyboardSwitcher.getKeyboardShiftMode(),
- mKeyboardSwitcher.getCurrentKeyboardScriptId(), mHandler);
- updateStateAfterInputTransaction(completeInputTransaction);
- mKeyboardSwitcher.onEvent(event, getCurrentAutoCapsState(), getCurrentRecapitalizeState());
- }
-
- // A helper method to split the code point and the key code. Ultimately, they should not be
- // squashed into the same variable, and this method should be removed.
- // public for testing, as we don't want to copy the same logic into test code
- @Nonnull
- public static Event createSoftwareKeypressEvent(final int keyCodeOrCodePoint, final int keyX,
- final int keyY, final boolean isKeyRepeat) {
- final int keyCode;
- final int codePoint;
- if (keyCodeOrCodePoint <= 0) {
- keyCode = keyCodeOrCodePoint;
- codePoint = Event.NOT_A_CODE_POINT;
- } else {
- keyCode = Event.NOT_A_KEY_CODE;
- codePoint = keyCodeOrCodePoint;
- }
- return Event.createSoftwareKeypressEvent(codePoint, keyCode, keyX, keyY, isKeyRepeat);
- }
-
- // Called from PointerTracker through the KeyboardActionListener interface
- @Override
- public void onTextInput(final String rawText) {
- // TODO: have the keyboard pass the correct key code when we need it.
- final Event event = Event.createSoftwareTextEvent(rawText, Constants.CODE_OUTPUT_TEXT);
- final InputTransaction completeInputTransaction =
- mInputLogic.onTextInput(mSettings.getCurrent(), event,
- mKeyboardSwitcher.getKeyboardShiftMode(), mHandler);
- updateStateAfterInputTransaction(completeInputTransaction);
- mKeyboardSwitcher.onEvent(event, getCurrentAutoCapsState(), getCurrentRecapitalizeState());
- }
-
- @Override
- public void onStartBatchInput() {
- mInputLogic.onStartBatchInput(mSettings.getCurrent(), mKeyboardSwitcher, mHandler);
- mGestureConsumer.onGestureStarted(
- mRichImm.getCurrentSubtypeLocale(),
- mKeyboardSwitcher.getKeyboard());
- }
-
- @Override
- public void onUpdateBatchInput(final InputPointers batchPointers) {
- mInputLogic.onUpdateBatchInput(batchPointers);
- }
-
- @Override
- public void onEndBatchInput(final InputPointers batchPointers) {
- mInputLogic.onEndBatchInput(batchPointers);
- mGestureConsumer.onGestureCompleted(batchPointers);
- }
-
- @Override
- public void onCancelBatchInput() {
- mInputLogic.onCancelBatchInput(mHandler);
- mGestureConsumer.onGestureCanceled();
- }
-
- /**
- * To be called after the InputLogic has gotten a chance to act on the suggested words by the
- * IME for the full gesture, possibly updating the TextView to reflect the first suggestion.
- * <p>
- * This method must be run on the UI Thread.
- * @param suggestedWords suggested words by the IME for the full gesture.
- */
- public void onTailBatchInputResultShown(final SuggestedWords suggestedWords) {
- mGestureConsumer.onImeSuggestionsProcessed(suggestedWords,
- mInputLogic.getComposingStart(), mInputLogic.getComposingLength(),
- mDictionaryFacilitator);
- }
-
- // This method must run on the UI Thread.
- void showGesturePreviewAndSuggestionStrip(@Nonnull final SuggestedWords suggestedWords,
- final boolean dismissGestureFloatingPreviewText) {
- showSuggestionStrip(suggestedWords);
- final MainKeyboardView mainKeyboardView = mKeyboardSwitcher.getMainKeyboardView();
- mainKeyboardView.showGestureFloatingPreviewText(suggestedWords,
- dismissGestureFloatingPreviewText /* dismissDelayed */);
- }
-
- // Called from PointerTracker through the KeyboardActionListener interface
- @Override
- public void onFinishSlidingInput() {
- // User finished sliding input.
- mKeyboardSwitcher.onFinishSlidingInput(getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- }
-
- // Called from PointerTracker through the KeyboardActionListener interface
- @Override
- public void onCancelInput() {
- // User released a finger outside any key
- // Nothing to do so far.
- }
-
- public boolean hasSuggestionStripView() {
- return null != mSuggestionStripView;
- }
-
- private void setSuggestedWords(final SuggestedWords suggestedWords) {
- final SettingsValues currentSettingsValues = mSettings.getCurrent();
- mInputLogic.setSuggestedWords(suggestedWords);
- // TODO: Modify this when we support suggestions with hard keyboard
- if (!hasSuggestionStripView()) {
- return;
- }
- if (!onEvaluateInputViewShown()) {
- return;
- }
-
- final boolean shouldShowImportantNotice =
- ImportantNoticeUtils.shouldShowImportantNotice(this, currentSettingsValues);
- final boolean shouldShowSuggestionCandidates =
- currentSettingsValues.mInputAttributes.mShouldShowSuggestions
- && currentSettingsValues.isSuggestionsEnabledPerUserSettings();
- final boolean shouldShowSuggestionsStripUnlessPassword = shouldShowImportantNotice
- || currentSettingsValues.mShowsVoiceInputKey
- || shouldShowSuggestionCandidates
- || currentSettingsValues.isApplicationSpecifiedCompletionsOn();
- final boolean shouldShowSuggestionsStrip = shouldShowSuggestionsStripUnlessPassword
- && !currentSettingsValues.mInputAttributes.mIsPasswordField;
- mSuggestionStripView.updateVisibility(shouldShowSuggestionsStrip, isFullscreenMode());
- if (!shouldShowSuggestionsStrip) {
- return;
- }
-
- final boolean isEmptyApplicationSpecifiedCompletions =
- currentSettingsValues.isApplicationSpecifiedCompletionsOn()
- && suggestedWords.isEmpty();
- final boolean noSuggestionsFromDictionaries = suggestedWords.isEmpty()
- || suggestedWords.isPunctuationSuggestions()
- || isEmptyApplicationSpecifiedCompletions;
- final boolean isBeginningOfSentencePrediction = (suggestedWords.mInputStyle
- == SuggestedWords.INPUT_STYLE_BEGINNING_OF_SENTENCE_PREDICTION);
- final boolean noSuggestionsToOverrideImportantNotice = noSuggestionsFromDictionaries
- || isBeginningOfSentencePrediction;
- if (shouldShowImportantNotice && noSuggestionsToOverrideImportantNotice) {
- if (mSuggestionStripView.maybeShowImportantNoticeTitle()) {
- return;
- }
- }
-
- if (currentSettingsValues.isSuggestionsEnabledPerUserSettings()
- || currentSettingsValues.isApplicationSpecifiedCompletionsOn()
- // We should clear the contextual strip if there is no suggestion from dictionaries.
- || noSuggestionsFromDictionaries) {
- mSuggestionStripView.setSuggestions(suggestedWords,
- mRichImm.getCurrentSubtype().isRtlSubtype());
- }
- }
-
- // TODO[IL]: Move this out of LatinIME.
- public void getSuggestedWords(final int inputStyle, final int sequenceNumber,
- final OnGetSuggestedWordsCallback callback) {
- final Keyboard keyboard = mKeyboardSwitcher.getKeyboard();
- if (keyboard == null) {
- callback.onGetSuggestedWords(SuggestedWords.getEmptyInstance());
- return;
- }
- mInputLogic.getSuggestedWords(mSettings.getCurrent(), keyboard,
- mKeyboardSwitcher.getKeyboardShiftMode(), inputStyle, sequenceNumber, callback);
- }
-
- @Override
- public void showSuggestionStrip(final SuggestedWords suggestedWords) {
- if (suggestedWords.isEmpty()) {
- setNeutralSuggestionStrip();
- } else {
- setSuggestedWords(suggestedWords);
- }
- // Cache the auto-correction in accessibility code so we can speak it if the user
- // touches a key that will insert it.
- AccessibilityUtils.getInstance().setAutoCorrection(suggestedWords);
- }
-
- // Called from {@link SuggestionStripView} through the {@link SuggestionStripView#Listener}
- // interface
- @Override
- public void pickSuggestionManually(final SuggestedWordInfo suggestionInfo) {
- final InputTransaction completeInputTransaction = mInputLogic.onPickSuggestionManually(
- mSettings.getCurrent(), suggestionInfo,
- mKeyboardSwitcher.getKeyboardShiftMode(),
- mKeyboardSwitcher.getCurrentKeyboardScriptId(),
- mHandler);
- updateStateAfterInputTransaction(completeInputTransaction);
- }
-
- // This will show either an empty suggestion strip (if prediction is enabled) or
- // punctuation suggestions (if it's disabled).
- @Override
- public void setNeutralSuggestionStrip() {
- final SettingsValues currentSettings = mSettings.getCurrent();
- final SuggestedWords neutralSuggestions = currentSettings.mBigramPredictionEnabled
- ? SuggestedWords.getEmptyInstance()
- : currentSettings.mSpacingAndPunctuations.mSuggestPuncList;
- setSuggestedWords(neutralSuggestions);
- }
-
- // Outside LatinIME, only used by the {@link InputTestsBase} test suite.
- @UsedForTesting
- void loadKeyboard() {
- // Since we are switching languages, the most urgent thing is to let the keyboard graphics
- // update. LoadKeyboard does that, but we need to wait for buffer flip for it to be on
- // the screen. Anything we do right now will delay this, so wait until the next frame
- // before we do the rest, like reopening dictionaries and updating suggestions. So we
- // post a message.
- mHandler.postReopenDictionaries();
- loadSettings();
- if (mKeyboardSwitcher.getMainKeyboardView() != null) {
- // Reload keyboard because the current language has been changed.
- mKeyboardSwitcher.loadKeyboard(getCurrentInputEditorInfo(), mSettings.getCurrent(),
- getCurrentAutoCapsState(), getCurrentRecapitalizeState());
- }
- }
-
- /**
- * After an input transaction has been executed, some state must be updated. This includes
- * the shift state of the keyboard and suggestions. This method looks at the finished
- * inputTransaction to find out what is necessary and updates the state accordingly.
- * @param inputTransaction The transaction that has been executed.
- */
- private void updateStateAfterInputTransaction(final InputTransaction inputTransaction) {
- switch (inputTransaction.getRequiredShiftUpdate()) {
- case InputTransaction.SHIFT_UPDATE_LATER:
- mHandler.postUpdateShiftState();
- break;
- case InputTransaction.SHIFT_UPDATE_NOW:
- mKeyboardSwitcher.requestUpdatingShiftState(getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- break;
- default: // SHIFT_NO_UPDATE
- }
- if (inputTransaction.requiresUpdateSuggestions()) {
- final int inputStyle;
- if (inputTransaction.mEvent.isSuggestionStripPress()) {
- // Suggestion strip press: no input.
- inputStyle = SuggestedWords.INPUT_STYLE_NONE;
- } else if (inputTransaction.mEvent.isGesture()) {
- inputStyle = SuggestedWords.INPUT_STYLE_TAIL_BATCH;
- } else {
- inputStyle = SuggestedWords.INPUT_STYLE_TYPING;
- }
- mHandler.postUpdateSuggestionStrip(inputStyle);
- }
- if (inputTransaction.didAffectContents()) {
- mSubtypeState.setCurrentSubtypeHasBeenUsed();
- }
- }
-
- private void hapticAndAudioFeedback(final int code, final int repeatCount) {
- final MainKeyboardView keyboardView = mKeyboardSwitcher.getMainKeyboardView();
- if (keyboardView != null && keyboardView.isInDraggingFinger()) {
- // No need to feedback while finger is dragging.
- return;
- }
- if (repeatCount > 0) {
- if (code == Constants.CODE_DELETE && !mInputLogic.mConnection.canDeleteCharacters()) {
- // No need to feedback when repeat delete key will have no effect.
- return;
- }
- // TODO: Use event time that the last feedback has been generated instead of relying on
- // a repeat count to thin out feedback.
- if (repeatCount % PERIOD_FOR_AUDIO_AND_HAPTIC_FEEDBACK_IN_KEY_REPEAT == 0) {
- return;
- }
- }
- final AudioAndHapticFeedbackManager feedbackManager =
- AudioAndHapticFeedbackManager.getInstance();
- if (repeatCount == 0) {
- // TODO: Reconsider how to perform haptic feedback when repeating key.
- feedbackManager.performHapticFeedback(keyboardView);
- }
- feedbackManager.performAudioFeedback(code);
- }
-
- // Callback of the {@link KeyboardActionListener}. This is called when a key is depressed;
- // release matching call is {@link #onReleaseKey(int,boolean)} below.
- @Override
- public void onPressKey(final int primaryCode, final int repeatCount,
- final boolean isSinglePointer) {
- mKeyboardSwitcher.onPressKey(primaryCode, isSinglePointer, getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- hapticAndAudioFeedback(primaryCode, repeatCount);
- }
-
- // Callback of the {@link KeyboardActionListener}. This is called when a key is released;
- // press matching call is {@link #onPressKey(int,int,boolean)} above.
- @Override
- public void onReleaseKey(final int primaryCode, final boolean withSliding) {
- mKeyboardSwitcher.onReleaseKey(primaryCode, withSliding, getCurrentAutoCapsState(),
- getCurrentRecapitalizeState());
- }
-
- private HardwareEventDecoder getHardwareKeyEventDecoder(final int deviceId) {
- final HardwareEventDecoder decoder = mHardwareEventDecoders.get(deviceId);
- if (null != decoder) return decoder;
- // TODO: create the decoder according to the specification
- final HardwareEventDecoder newDecoder = new HardwareKeyboardEventDecoder(deviceId);
- mHardwareEventDecoders.put(deviceId, newDecoder);
- return newDecoder;
- }
-
- // Hooks for hardware keyboard
- @Override
- public boolean onKeyDown(final int keyCode, final KeyEvent keyEvent) {
- if (mEmojiAltPhysicalKeyDetector == null) {
- mEmojiAltPhysicalKeyDetector = new EmojiAltPhysicalKeyDetector(
- getApplicationContext().getResources());
- }
- mEmojiAltPhysicalKeyDetector.onKeyDown(keyEvent);
- if (!ProductionFlags.IS_HARDWARE_KEYBOARD_SUPPORTED) {
- return super.onKeyDown(keyCode, keyEvent);
- }
- final Event event = getHardwareKeyEventDecoder(
- keyEvent.getDeviceId()).decodeHardwareKey(keyEvent);
- // If the event is not handled by LatinIME, we just pass it to the parent implementation.
- // If it's handled, we return true because we did handle it.
- if (event.isHandled()) {
- mInputLogic.onCodeInput(mSettings.getCurrent(), event,
- mKeyboardSwitcher.getKeyboardShiftMode(),
- // TODO: this is not necessarily correct for a hardware keyboard right now
- mKeyboardSwitcher.getCurrentKeyboardScriptId(),
- mHandler);
- return true;
- }
- return super.onKeyDown(keyCode, keyEvent);
- }
-
- @Override
- public boolean onKeyUp(final int keyCode, final KeyEvent keyEvent) {
- if (mEmojiAltPhysicalKeyDetector == null) {
- mEmojiAltPhysicalKeyDetector = new EmojiAltPhysicalKeyDetector(
- getApplicationContext().getResources());
- }
- mEmojiAltPhysicalKeyDetector.onKeyUp(keyEvent);
- if (!ProductionFlags.IS_HARDWARE_KEYBOARD_SUPPORTED) {
- return super.onKeyUp(keyCode, keyEvent);
- }
- final long keyIdentifier = keyEvent.getDeviceId() << 32 + keyEvent.getKeyCode();
- if (mInputLogic.mCurrentlyPressedHardwareKeys.remove(keyIdentifier)) {
- return true;
- }
- return super.onKeyUp(keyCode, keyEvent);
- }
-
- // onKeyDown and onKeyUp are the main events we are interested in. There are two more events
- // related to handling of hardware key events that we may want to implement in the future:
- // boolean onKeyLongPress(final int keyCode, final KeyEvent event);
- // boolean onKeyMultiple(final int keyCode, final int count, final KeyEvent event);
-
- // receive ringer mode change.
- private final BroadcastReceiver mRingerModeChangeReceiver = new BroadcastReceiver() {
- @Override
- public void onReceive(final Context context, final Intent intent) {
- final String action = intent.getAction();
- if (action.equals(AudioManager.RINGER_MODE_CHANGED_ACTION)) {
- AudioAndHapticFeedbackManager.getInstance().onRingerModeChanged();
- }
- }
- };
-
- /**
- * Starts {@link android.app.Activity} on the same display where the IME is shown.
- *
- * @param intent {@link Intent} to be used to start {@link android.app.Activity}.
- */
- private void startActivityOnTheSameDisplay(Intent intent) {
- // Note that WindowManager#getDefaultDisplay() returns the display ID associated with the
- // Context from which the WindowManager instance was obtained. Therefore the following code
- // returns the display ID for the window where the IME is shown.
- final int currentDisplayId = ((WindowManager) getSystemService(Context.WINDOW_SERVICE))
- .getDefaultDisplay().getDisplayId();
-
- startActivity(intent,
- ActivityOptions.makeBasic().setLaunchDisplayId(currentDisplayId).toBundle());
- }
-
- void launchSettings(final String extraEntryValue) {
- mInputLogic.commitTyped(mSettings.getCurrent(), LastComposedWord.NOT_A_SEPARATOR);
- requestHideSelf(0);
- final MainKeyboardView mainKeyboardView = mKeyboardSwitcher.getMainKeyboardView();
- if (mainKeyboardView != null) {
- mainKeyboardView.closing();
- }
- final Intent intent = new Intent();
- intent.setClass(LatinIME.this, SettingsActivity.class);
- intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK
- | Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
- | Intent.FLAG_ACTIVITY_CLEAR_TOP);
- intent.putExtra(SettingsActivity.EXTRA_SHOW_HOME_AS_UP, false);
- intent.putExtra(SettingsActivity.EXTRA_ENTRY_KEY, extraEntryValue);
- startActivityOnTheSameDisplay(intent);
- }
-
- private void showSubtypeSelectorAndSettings() {
- final CharSequence title = getString(R.string.english_ime_input_options);
- // TODO: Should use new string "Select active input modes".
- final CharSequence languageSelectionTitle = getString(R.string.language_selection_title);
- final CharSequence[] items = new CharSequence[] {
- languageSelectionTitle,
- getString(ApplicationUtils.getActivityTitleResId(this, SettingsActivity.class))
- };
- final String imeId = mRichImm.getInputMethodIdOfThisIme();
- final OnClickListener listener = new OnClickListener() {
- @Override
- public void onClick(DialogInterface di, int position) {
- di.dismiss();
- switch (position) {
- case 0:
- final Intent intent = IntentUtils.getInputLanguageSelectionIntent(
- imeId,
- Intent.FLAG_ACTIVITY_NEW_TASK
- | Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
- | Intent.FLAG_ACTIVITY_CLEAR_TOP);
- intent.putExtra(Intent.EXTRA_TITLE, languageSelectionTitle);
- startActivityOnTheSameDisplay(intent);
- break;
- case 1:
- launchSettings(SettingsActivity.EXTRA_ENTRY_VALUE_LONG_PRESS_COMMA);
- break;
- }
- }
- };
- final AlertDialog.Builder builder = new AlertDialog.Builder(
- DialogUtils.getPlatformDialogThemeContext(this));
- builder.setItems(items, listener).setTitle(title);
- final AlertDialog dialog = builder.create();
- dialog.setCancelable(true /* cancelable */);
- dialog.setCanceledOnTouchOutside(true /* cancelable */);
- showOptionDialog(dialog);
- }
-
- // TODO: Move this method out of {@link LatinIME}.
- private void showOptionDialog(final AlertDialog dialog) {
- final IBinder windowToken = mKeyboardSwitcher.getMainKeyboardView().getWindowToken();
- if (windowToken == null) {
- return;
- }
-
- final Window window = dialog.getWindow();
- final WindowManager.LayoutParams lp = window.getAttributes();
- lp.token = windowToken;
- lp.type = WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG;
- window.setAttributes(lp);
- window.addFlags(WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM);
-
- mOptionsDialog = dialog;
- dialog.show();
- }
-
- @UsedForTesting
- SuggestedWords getSuggestedWordsForTest() {
- // You may not use this method for anything else than debug
- return DebugFlags.DEBUG_ENABLED ? mInputLogic.mSuggestedWords : null;
- }
-
- // DO NOT USE THIS for any other purpose than testing. This is information private to LatinIME.
- @UsedForTesting
- void waitForLoadingDictionaries(final long timeout, final TimeUnit unit)
- throws InterruptedException {
- mDictionaryFacilitator.waitForLoadingDictionariesForTesting(timeout, unit);
- }
-
- // DO NOT USE THIS for any other purpose than testing. This can break the keyboard badly.
- @UsedForTesting
- void replaceDictionariesForTest(final Locale locale) {
- final SettingsValues settingsValues = mSettings.getCurrent();
- mDictionaryFacilitator.resetDictionaries(this, locale,
- settingsValues.mUseContactsDict, settingsValues.mUsePersonalizedDicts,
- false /* forceReloadMainDictionary */,
- settingsValues.mAccount, "", /* dictionaryNamePrefix */
- this /* DictionaryInitializationListener */);
- }
-
- // DO NOT USE THIS for any other purpose than testing.
- @UsedForTesting
- void clearPersonalizedDictionariesForTest() {
- mDictionaryFacilitator.clearUserHistoryDictionary(this);
- }
-
- @UsedForTesting
- List<InputMethodSubtype> getEnabledSubtypesForTest() {
- return (mRichImm != null) ? mRichImm.getMyEnabledInputMethodSubtypeList(
- true /* allowsImplicitlySelectedSubtypes */) : new ArrayList<InputMethodSubtype>();
- }
-
- public void dumpDictionaryForDebug(final String dictName) {
- if (!mDictionaryFacilitator.isActive()) {
- resetDictionaryFacilitatorIfNecessary();
- }
- mDictionaryFacilitator.dumpDictionaryForDebug(dictName);
- }
-
- public void debugDumpStateAndCrashWithException(final String context) {
- final SettingsValues settingsValues = mSettings.getCurrent();
- final StringBuilder s = new StringBuilder(settingsValues.toString());
- s.append("\nAttributes : ").append(settingsValues.mInputAttributes)
- .append("\nContext : ").append(context);
- throw new RuntimeException(s.toString());
- }
-
- @Override
- protected void dump(final FileDescriptor fd, final PrintWriter fout, final String[] args) {
- super.dump(fd, fout, args);
-
- final Printer p = new PrintWriterPrinter(fout);
- p.println("LatinIME state :");
- p.println(" VersionCode = " + ApplicationUtils.getVersionCode(this));
- p.println(" VersionName = " + ApplicationUtils.getVersionName(this));
- final Keyboard keyboard = mKeyboardSwitcher.getKeyboard();
- final int keyboardMode = keyboard != null ? keyboard.mId.mMode : -1;
- p.println(" Keyboard mode = " + keyboardMode);
- final SettingsValues settingsValues = mSettings.getCurrent();
- p.println(settingsValues.dump());
- p.println(mDictionaryFacilitator.dump(this /* context */));
- // TODO: Dump all settings values
- }
-
- public boolean shouldSwitchToOtherInputMethods() {
- // TODO: Revisit here to reorganize the settings. Probably we can/should use different
- // strategy once the implementation of
- // {@link InputMethodManager#shouldOfferSwitchingToNextInputMethod} is defined well.
- final boolean fallbackValue = mSettings.getCurrent().mIncludesOtherImesInLanguageSwitchList;
- final IBinder token = getWindow().getWindow().getAttributes().token;
- if (token == null) {
- return fallbackValue;
- }
- return mRichImm.shouldOfferSwitchingToNextInputMethod(token, fallbackValue);
- }
-
- public boolean shouldShowLanguageSwitchKey() {
- // TODO: Revisit here to reorganize the settings. Probably we can/should use different
- // strategy once the implementation of
- // {@link InputMethodManager#shouldOfferSwitchingToNextInputMethod} is defined well.
- final boolean fallbackValue = mSettings.getCurrent().isLanguageSwitchKeyEnabled();
- final IBinder token = getWindow().getWindow().getAttributes().token;
- if (token == null) {
- return fallbackValue;
- }
- return mRichImm.shouldOfferSwitchingToNextInputMethod(token, fallbackValue);
- }
-
- private void setNavigationBarVisibility(final boolean visible) {
- if (BuildCompatUtils.EFFECTIVE_SDK_INT > Build.VERSION_CODES.M) {
- // For N and later, IMEs can specify Color.TRANSPARENT to make the navigation bar
- // transparent. For other colors the system uses the default color.
- getWindow().getWindow().setNavigationBarColor(
- visible ? Color.BLACK : Color.TRANSPARENT);
- }
- }
-}