Introduce ThreadedInputConnection behind a switch

content/public/android/java/src/org/chromium/content/browser/input/ThreadedInputConnection.java

+// Copyright 2016 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.content.browser.input;
+
+import android.os.Bundle;
+import android.view.KeyCharacterMap;
+import android.view.KeyEvent;
+import android.view.inputmethod.CompletionInfo;
+import android.view.inputmethod.CorrectionInfo;
+import android.view.inputmethod.EditorInfo;
+import android.view.inputmethod.ExtractedText;
+import android.view.inputmethod.ExtractedTextRequest;
+import android.view.inputmethod.InputConnection;
+
+import org.chromium.base.Log;
+import org.chromium.base.ThreadUtils;
+
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.LinkedBlockingQueue;
+
+/**
+ * An implementation of {@link InputConnection} to communicate with external input method
+ * apps. Note that it is running on IME thread (except for constructor and calls from ImeAdapter)
+ * such that it does not block UI thread and returns text values immediately after any change
+ * to them.
+ */
+public class ThreadedInputConnection implements ChromiumBaseInputConnection {
+    private static final String TAG = "cr_Ime";
+
+    private final ImeAdapter mImeAdapter;
+    private final ThreadManager mThreadManager;
+    private int mNumNestedBatchEdits = 0;

[Ted C, 2016/02/02 23:14:43]

zero is the default...no need for this.

[Changwan Ryu, 2016/02/11 16:21:08]

Done.

+    private final BlockingQueue<TextInputState> mQueue = new LinkedBlockingQueue<>();

[Ted C, 2016/02/02 23:14:43]

do we get a new TextInputState for every key stroke?  If so, we should probably
avoid creating a bunch of new objects each time.  Should we look into keeping a
pool of these and reusing them as possible?

[Changwan Ryu, 2016/02/11 16:21:08]

Hmm... I noticed that android.os.Message is using recycling technique.
But I think typing shouldn't be as frequent nor as fast as message handling.
Do we have other examples of object pooling in clank?

In any case, I've added a TODO for now.

+    private int mPendingAccent;
+    // Only accessible on UI thread.
+    private TextInputState mLastUpdatedTextInputState;
+
+
+    ThreadedInputConnection(ImeAdapter imeAdapter, ThreadManager threadManager) {
+        Log.d(TAG, "constructor");
+        ImeUtils.assertOnUiThread();
+        mImeAdapter = imeAdapter;
+        mThreadManager = threadManager;
+    }
+
+    void initializeOutAttrsOnUiThread(int inputType, int inputFlags, EditorInfo outAttrs) {
+        Log.d(TAG, "initializeOutAttrs");
+        ImeUtils.assertOnUiThread();
+        int initialSelStart = 0;
+        int initialSelEnd = 0;
+        mNumNestedBatchEdits = 0;
+        mPendingAccent = 0;
+        if (mLastUpdatedTextInputState != null) {
+            initialSelStart = mLastUpdatedTextInputState.selection().start();
+            initialSelEnd = mLastUpdatedTextInputState.selection().end();
+        }
+        ImeUtils.computeEditorInfo(inputType, inputFlags, initialSelStart, initialSelEnd, outAttrs);
+    }
+
+    @Override
+    public void updateStateOnUiThread(final String text, final int selectionStart,
+            final int selectionEnd, final int compositionStart, final int compositionEnd,
+            boolean singleLine, final boolean isNonImeChange) {
+        ImeUtils.assertOnUiThread();
+
+        final TextInputState newState =
+                new TextInputState(text, new Range(selectionStart, selectionEnd),
+                        new Range(compositionStart, compositionEnd), singleLine, !isNonImeChange);
+        Log.d(TAG, "updateState: %s", newState);
+        mLastUpdatedTextInputState = newState;
+
+        addToQueueOnUiThread(newState);
+        if (isNonImeChange) {
+            mThreadManager.post(new Runnable() {
+                @Override
+                public void run() {
+                    checkQueueForNonImeUpdate();
+                }
+            });
+        }
+    }
+
+    /**
+     * @see ChromiumBaseInputConnection#getThreadManager()
+     */
+    @Override
+    public ThreadManager getThreadManager() {
+        return mThreadManager;
+    }
+
+    /**
+     * @see ChromiumBaseInputConnection#onRestartInputOnUiThread()
+     */
+    @Override
+    public void onRestartInputOnUiThread() {}
+
+    /**
+     * @see ChromiumBaseInputConnection#sendKeyEventOnUiThread(KeyEvent)
+     */
+    @Override
+    public boolean sendKeyEventOnUiThread(final KeyEvent event) {
+        ImeUtils.assertOnUiThread();
+        mThreadManager.post(new Runnable() {
+            @Override
+            public void run() {
+                sendKeyEvent(event);
+            }
+        });
+        return true;
+    }
+
+    /**
+     * @see ChromiumBaseInputConnection#moveCursorToSelectionEndOnUiThread()
+     */
+    @Override
+    public void moveCursorToSelectionEndOnUiThread() {
+        mThreadManager.post(new Runnable() {
+            @Override
+            public void run() {
+                TextInputState textInputState = requestTextInputState();
+                if (textInputState == null) return;
+                Range selection = textInputState.selection();
+                setSelection(selection.end(), selection.end());
+            }
+        });
+    }
+
+    @Override
+    public void unblockOnUiThread() {
+        Log.d(TAG, "unblock");
+        ImeUtils.assertOnUiThread();
+        addToQueueOnUiThread(new TextInputState.Unblocker());
+        mThreadManager.post(new Runnable() {
+            @Override
+            public void run() {
+                checkQueueForUnblocker();
+            }
+        });
+    }
+
+    private void checkQueueForNonImeUpdate() {
+        assertOnImeThread();
+        TextInputState state = mQueue.peek();
+        if (state == null) {
+            Log.d(TAG, "checkQueueForNonImeUpdate: no state");
+            return;
+        }
+        mQueue.poll();
+        ImeUtils.assertReally(!state.fromIme());
+        updateSelection(state);
+        Log.d(TAG, "checkQueueForNonImeUpdate done: %d", mQueue.size());
+    }
+
+    private void checkQueueForUnblocker() {
+        Log.d(TAG, "checkQueueForUnblocker");
+        assertOnImeThread();
+        // Clear all the states in the queue.
+        while (true) {
+            TextInputState state = mQueue.poll();
+            if (state == null) return;
+            if (state.shouldUnblock()) return;
+        }
+    }
+
+    private void updateSelection(TextInputState textInputState) {
+        assertOnImeThread();
+        if (mNumNestedBatchEdits != 0) return;
+        ImeUtils.assertReally(textInputState != null);
+        Range selection = textInputState.selection();
+        Range composition = textInputState.composition();
+        mImeAdapter.updateSelection(
+                selection.start(), selection.end(), composition.start(), composition.end());
+    }
+
+    private TextInputState requestTextInputState() {
+        Log.d(TAG, "requestTextInputState");
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                boolean result = mImeAdapter.requestTextInputStateUpdate();
+                if (!result) unblockOnUiThread();
+            }
+        });
+        return blockAndGetStateUpdate();
+    }
+
+    private void addToQueueOnUiThread(TextInputState textInputState) {
+        ImeUtils.assertOnUiThread();
+        try {
+            mQueue.put(textInputState);
+        } catch (InterruptedException e) {
+            Log.e(TAG, "addToQueueOnUiThread interrupted", e);
+        }
+        Log.d(TAG, "addToQueueOnUiThread finished: %d", mQueue.size());
+    }
+
+    /**
+     * @return BlockingQueue for white box unit testing.
+     */
+    BlockingQueue<TextInputState> getQueueForTest() {
+        return mQueue;
+    }
+
+    private void assertOnImeThread() {
+        ImeUtils.assertReally(mThreadManager.runningOnThisThread());
+    }
+
+    /**
+     * Block until we get the expected state update.
+     * @return TextInputState if we get it successfully. null otherwise.
+     */
+    private TextInputState blockAndGetStateUpdate() {
+        Log.d(TAG, "blockAndGetStateUpdate");
+        assertOnImeThread();
+        boolean shouldUpdateSelection = false;
+        while (true) {
+            TextInputState state;
+            try {
+                state = mQueue.take();
+            } catch (InterruptedException e) {
+                e.printStackTrace();
+                return null;
+            }
+            if (state == null) return null;
+            if (state.fromIme()) {
+                if (state.shouldUnblock()) {
+                    Log.d(TAG, "blockAndGetStateUpdate: unblocked");
+                    return null;
+                }
+                if (shouldUpdateSelection) updateSelection(state);
+                Log.d(TAG, "blockAndGetStateUpdate done: %d", mQueue.size());
+                return state;
+            }
+            // Ignore when state is not from IME, but make sure to update state when we handle
+            // state from IME.
+            shouldUpdateSelection = true;
+        }
+    }
+
+    private void notifyUserAction() {
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.notifyUserAction();
+            }
+        });
+    }
+
+    /**
+     * @see InputConnection#setComposingText(java.lang.CharSequence, int)
+     */
+    @Override
+    public boolean setComposingText(final CharSequence text, final int newCursorPosition) {
+        Log.d(TAG, "setComposingText [%s] [%d]", text, newCursorPosition);
+        assertOnImeThread();
+        cancelCombiningAccent();
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.sendCompositionToNative(text, newCursorPosition, false);
+            }
+        });
+        notifyUserAction();
+        return true;
+    }
+
+    /**
+     * @see InputConnection#commitText(java.lang.CharSequence, int)
+     */
+    @Override
+    public boolean commitText(final CharSequence text, final int newCursorPosition) {
+        Log.d(TAG, "commitText [%s] [%d]", text, newCursorPosition);
+        assertOnImeThread();
+        cancelCombiningAccent();
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.sendCompositionToNative(text, newCursorPosition, text.length() > 0);
+            }
+        });
+        notifyUserAction();
+        return true;
+    }
+
+    /**
+     * @see InputConnection#performEditorAction(int)
+     */
+    @Override
+    public boolean performEditorAction(final int actionCode) {
+        Log.d(TAG, "performEditorAction [%d]", actionCode);
+        assertOnImeThread();
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.performEditorAction(actionCode);
+            }
+        });
+        return true;
+    }
+
+    /**
+     * @see InputConnection#performContextMenuAction(int)
+     */
+    @Override
+    public boolean performContextMenuAction(final int id) {
+        Log.d(TAG, "performContextMenuAction [%d]", id);
+        assertOnImeThread();
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.performContextMenuAction(id);
+            }
+        });
+        return true;
+    }
+
+    /**
+     * @see InputConnection#getExtractedText(android.view.inputmethod.ExtractedTextRequest,
+     *                                           int)
+     */
+    @Override
+    public ExtractedText getExtractedText(ExtractedTextRequest request, int flags) {
+        Log.d(TAG, "getExtractedText");
+        assertOnImeThread();
+        TextInputState textInputState = requestTextInputState();
+        if (textInputState == null) return null;
+        ExtractedText extractedText = new ExtractedText();
+        extractedText.text = textInputState.text();
+        extractedText.partialEndOffset = textInputState.text().length();
+        extractedText.selectionStart = textInputState.selection().start();
+        extractedText.selectionEnd = textInputState.selection().end();
+        extractedText.flags = textInputState.singleLine() ? ExtractedText.FLAG_SINGLE_LINE : 0;
+        return extractedText;
+    }
+
+    /**
+     * @see InputConnection#beginBatchEdit()
+     */
+    @Override
+    public boolean beginBatchEdit() {
+        Log.d(TAG, "beginBatchEdit [%b]", (mNumNestedBatchEdits == 0));
+        assertOnImeThread();
+        mNumNestedBatchEdits++;
+        return true;
+    }
+
+    /**
+     * @see InputConnection#endBatchEdit()
+     */
+    @Override
+    public boolean endBatchEdit() {
+        assertOnImeThread();
+        if (mNumNestedBatchEdits == 0) return false;
+        --mNumNestedBatchEdits;
+        Log.d(TAG, "endBatchEdit [%b]", (mNumNestedBatchEdits == 0));
+        if (mNumNestedBatchEdits == 0) {
+            updateSelection(requestTextInputState());
+        }
+        return mNumNestedBatchEdits != 0;
+    }
+
+    /**
+     * @see InputConnection#deleteSurroundingText(int, int)
+     */
+    @Override
+    public boolean deleteSurroundingText(final int beforeLength, final int afterLength) {
+        Log.d(TAG, "deleteSurroundingText [%d %d]", beforeLength, afterLength);
+        assertOnImeThread();
+        if (mPendingAccent != 0) {
+            finishComposingText();
+        }
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.deleteSurroundingText(beforeLength, afterLength);
+            }
+        });
+        return true;
+    }
+
+    /**
+     * @see InputConnection#sendKeyEvent(android.view.KeyEvent)
+     */
+    @Override
+    public boolean sendKeyEvent(final KeyEvent event) {
+        Log.d(TAG, "sendKeyEvent [%d %d]", event.getAction(), event.getKeyCode());
+        assertOnImeThread();
+
+        if (handleCombiningAccent(event)) return true;
+
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.sendKeyEvent(event);
+            }
+        });
+        notifyUserAction();
+        return true;
+    }
+
+    private boolean handleCombiningAccent(final KeyEvent event) {
+        // TODO(changwan): this will break the current composition. check if we can
+        // implement it in the renderer instead.
+        int action = event.getAction();
+        int unicodeChar = event.getUnicodeChar();
+
+        if (action != KeyEvent.ACTION_DOWN) return false;
+        if ((unicodeChar & KeyCharacterMap.COMBINING_ACCENT) != 0) {
+            int pendingAccent = unicodeChar & KeyCharacterMap.COMBINING_ACCENT_MASK;
+            StringBuilder builder = new StringBuilder();
+            builder.appendCodePoint(pendingAccent);
+            setComposingText(builder.toString(), 1);
+            mPendingAccent = pendingAccent;
+            return true;
+        } else if (mPendingAccent != 0 && unicodeChar != 0) {
+            int combined = KeyEvent.getDeadChar(mPendingAccent, unicodeChar);
+            if (combined != 0) {
+                StringBuilder builder = new StringBuilder();
+                builder.appendCodePoint(combined);
+                commitText(builder.toString(), 1);
+                return true;
+            }
+            // Noncombinable character; commit the accent character and fall through to sending
+            // the key event for the character afterwards.
+            finishComposingText();
+        }
+        return false;
+    }
+
+    private void cancelCombiningAccent() {
+        mPendingAccent = 0;
+    }
+
+    /**
+     * @see InputConnection#finishComposingText()
+     */
+    @Override
+    public boolean finishComposingText() {
+        Log.d(TAG, "finishComposingText");
+        cancelCombiningAccent();
+        // This is the only function that may be called on UI thread because
+        // of direct calls from InputMethodManager.
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.finishComposingText();
+            }
+        });
+        return true;
+    }
+
+    /**
+     * @see InputConnection#setSelection(int, int)
+     */
+    @Override
+    public boolean setSelection(final int start, final int end) {
+        Log.d(TAG, "setSelection [%d %d]", start, end);
+        assertOnImeThread();
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.setEditableSelectionOffsets(start, end);
+            }
+        });
+        return true;
+    }
+
+    /**
+     * @see InputConnection#setComposingRegion(int, int)
+     */
+    @Override
+    public boolean setComposingRegion(final int start, final int end) {
+        Log.d(TAG, "setComposingRegion [%d %d]", start, end);
+        assertOnImeThread();
+        ThreadUtils.postOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                mImeAdapter.setComposingRegion(start, end);
+            }
+        });
+        return true;
+    }
+
+    /**
+     * @see InputConnection#getTextBeforeCursor(int, int)
+     */
+    @Override
+    public CharSequence getTextBeforeCursor(int maxChars, int flags) {
+        Log.d(TAG, "getTextBeforeCursor [%d %x]", maxChars, flags);
+        assertOnImeThread();
+        TextInputState textInputState = requestTextInputState();
+        if (textInputState == null) return null;
+        return textInputState.getTextBeforeSelection(maxChars);
+    }
+
+    /**
+     * @see InputConnection#getTextAfterCursor(int, int)
+     */
+    @Override
+    public CharSequence getTextAfterCursor(int maxChars, int flags) {
+        Log.d(TAG, "getTextAfterCursor [%d %x]", maxChars, flags);
+        assertOnImeThread();
+        TextInputState textInputState = requestTextInputState();
+        if (textInputState == null) return null;
+        return textInputState.getTextAfterSelection(maxChars);
+    }
+
+    /**
+     * @see InputConnection#getSelectedText(int)
+     */
+    @Override
+    public CharSequence getSelectedText(int flags) {
+        Log.d(TAG, "getSelectedText [%x]", flags);
+        assertOnImeThread();
+        TextInputState textInputState = requestTextInputState();
+        if (textInputState == null) return null;
+        return textInputState.getSelectedText();
+    }
+
+    /**
+     * @see InputConnection#getCursorCapsMode(int)
+     */
+    @Override
+    public int getCursorCapsMode(int reqModes) {
+        Log.d(TAG, "getCursorCapsMode [%x]", reqModes);
+        assertOnImeThread();
+        // TODO(changwan): Auto-generated method stub
+        return 0;
+    }
+
+    /**
+     * @see InputConnection#commitCompletion(android.view.inputmethod.CompletionInfo)
+     */
+    @Override
+    public boolean commitCompletion(CompletionInfo text) {
+        Log.d(TAG, "commitCompletion [%s]", text);
+        assertOnImeThread();
+        // TODO(changwan): Auto-generated method stub
+        return false;
+    }
+
+    /**
+     * @see InputConnection#commitCorrection(android.view.inputmethod.CorrectionInfo)
+     */
+    @Override
+    public boolean commitCorrection(CorrectionInfo correctionInfo) {
+        Log.d(TAG, "commitCorrection [%s]", ImeUtils.dumpCorrectionInfo(correctionInfo));
+        assertOnImeThread();
+        // TODO(changwan): Auto-generated method stub
+        return false;
+    }
+
+    /**
+     * @see InputConnection#clearMetaKeyStates(int)
+     */
+    @Override
+    public boolean clearMetaKeyStates(int states) {
+        Log.d(TAG, "clearMetaKeyStates [%x]", states);
+        assertOnImeThread();
+        // TODO(changwan): Auto-generated method stub
+        return false;
+    }
+
+    /**
+     * @see InputConnection#reportFullscreenMode(boolean)
+     */
+    @Override
+    public boolean reportFullscreenMode(boolean enabled) {
+        Log.d(TAG, "reportFullscreenMode [%b]", enabled);
+        // We ignore fullscreen mode for now. That's why we set
+        // EditorInfo.IME_FLAG_NO_FULLSCREEN in constructor.
+        // Note that this may be called on UI thread.
+        return false;
+    }
+
+    /**
+     * @see InputConnection#performPrivateCommand(java.lang.String, android.os.Bundle)
+     */
+    @Override
+    public boolean performPrivateCommand(String action, Bundle data) {
+        Log.d(TAG, "performPrivateCommand [%s]", action);
+        assertOnImeThread();
+        // TODO(changwan): Auto-generated method stub
+        return false;
+    }
+
+    /**
+     * @see InputConnection#requestCursorUpdates(int)
+     */
+    @Override
+    public boolean requestCursorUpdates(int cursorUpdateMode) {
+        Log.d(TAG, "requestCursorUpdates [%x]", cursorUpdateMode);
+        assertOnImeThread();
+        // TODO(changwan): Auto-generated method stub
+        return false;
+    }
+}