Send correct key-codes when doing composition events instead of always 0.

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

 // Copyright 2012 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.Handler;
 import android.os.ResultReceiver;
 import android.os.SystemClock;
 import android.text.Editable;
@@ skipping 98 matching lines @@
     static int sTextInputTypeUrl;
     static int sTextInputTypeEmail;
     static int sTextInputTypeTel;
     static int sTextInputTypeNumber;
     static int sTextInputTypeContentEditable;
     static int sModifierShift;
     static int sModifierAlt;
     static int sModifierCtrl;
     static int sModifierCapsLockOn;
     static int sModifierNumLockOn;
+    static KeyCharacterMap sKeyCharacterMap;
 
     private long mNativeImeAdapterAndroid;
     private InputMethodManagerWrapper mInputMethodManagerWrapper;
     private AdapterInputConnection mInputConnection;
     private final ImeAdapterDelegate mViewEmbedder;
     private final Handler mHandler;
     private DelayedDismissInput mDismissInput = null;
     private int mTextInputType;
+    private String mLastComposeText;
+
+    @VisibleForTesting
+    int mLastSyntheticKeyCode;
 
     @VisibleForTesting
     boolean mIsShowWithoutHideOutstanding = false;
 
     /**
      * @param wrapper InputMethodManagerWrapper that should receive all the call directed to
      *                InputMethodManager.
      * @param embedder The view that is used for callbacks from ImeAdapter.
      */
     public ImeAdapter(InputMethodManagerWrapper wrapper, ImeAdapterDelegate embedder) {
@@ skipping 173 matching lines @@
     }
 
     private int shouldSendKeyEventWithKeyCode(String text) {
         if (text.length() != 1) return COMPOSITION_KEY_CODE;
 
         if (text.equals("\n")) return KeyEvent.KEYCODE_ENTER;
         else if (text.equals("\t")) return KeyEvent.KEYCODE_TAB;
         else return COMPOSITION_KEY_CODE;
     }
 
+    private static int androidKeyCodeForCharacter(char chr) {
+        if (sKeyCharacterMap == null) {
+            sKeyCharacterMap = KeyCharacterMap.load(KeyCharacterMap.VIRTUAL_KEYBOARD);
+        }
+        char[] chars = new char[1];
+        chars[0] = chr;
+        KeyEvent[] events = sKeyCharacterMap.getEvents(chars);
+        return events[0].getKeyCode();
+    }
+
+    @VisibleForTesting
+    public static int getTypedKeycodeGuess(String oldtext, String newtext) {
+        // Starting typing a new composition should add only a single character.  Any composition
+        // beginning with text longer than that must come from something other than typing so
+        // return 0.
+        if (oldtext == null) {
+            if (newtext.length() == 1) {
+                return androidKeyCodeForCharacter(newtext.charAt(0));
+            } else {
+                return 0;
+            }
+        }
+
+        // The content has grown in length: assume the last character is the key that caused it.
+        if (newtext.length() > oldtext.length() && newtext.startsWith(oldtext))
+            return androidKeyCodeForCharacter(newtext.charAt(newtext.length() - 1));
+
+        // The content has shrunk in length: assume that backspace was pressed.
+        if (oldtext.length() > newtext.length() && oldtext.startsWith(newtext))
+            return KeyEvent.KEYCODE_DEL;
+
+        // The content is unchanged or has undergone a complex change (i.e. not a simple tail
+        // modification) so return an unknown key-code.
+        return 0;
+    }
+
     void sendKeyEventWithKeyCode(int keyCode, int flags) {
         long eventTime = SystemClock.uptimeMillis();
         translateAndSendNativeEvents(new KeyEvent(eventTime, eventTime,
                 KeyEvent.ACTION_DOWN, keyCode, 0, 0,
                 KeyCharacterMap.VIRTUAL_KEYBOARD, 0,
                 flags));
         translateAndSendNativeEvents(new KeyEvent(SystemClock.uptimeMillis(), eventTime,
                 KeyEvent.ACTION_UP, keyCode, 0, 0,
                 KeyCharacterMap.VIRTUAL_KEYBOARD, 0,
                 flags));
     }
 
     // Calls from Java to C++
 
     boolean checkCompositionQueueAndCallNative(CharSequence text, int newCursorPosition,
             boolean isCommit) {
         if (mNativeImeAdapterAndroid == 0) return false;
         String textStr = text.toString();
 
         // Committing an empty string finishes the current composition.
         boolean isFinish = textStr.isEmpty();
         mViewEmbedder.onImeEvent(isFinish);
         int keyCode = shouldSendKeyEventWithKeyCode(textStr);
         long timeStampMs = SystemClock.uptimeMillis();
 
         if (keyCode != COMPOSITION_KEY_CODE) {
             sendKeyEventWithKeyCode(keyCode,
                     KeyEvent.FLAG_SOFT_KEYBOARD | KeyEvent.FLAG_KEEP_TOUCH_MODE);
         } else {
-            nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeRawKeyDown,
-                    timeStampMs, keyCode, 0);
+            keyCode = getTypedKeycodeGuess(mLastComposeText, textStr);
+            mLastComposeText = textStr;
+            mLastSyntheticKeyCode = keyCode;
+
+            if (keyCode != 0)
+                nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeRawKeyDown,
+                        timeStampMs, keyCode, 0);
             if (isCommit) {
                 nativeCommitText(mNativeImeAdapterAndroid, textStr);
+                mLastComposeText = null;
             } else {
                 nativeSetComposingText(mNativeImeAdapterAndroid, text, textStr, newCursorPosition);
             }
-            nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeKeyUp,
-                    timeStampMs, keyCode, 0);
+            if (keyCode != 0)
+                nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeKeyUp,
+                        timeStampMs, keyCode, 0);
         }
 
         return true;
     }
 
     void finishComposingText() {
         if (mNativeImeAdapterAndroid == 0) return;
+        /*int keyCode = mLastComposeText != null && mLastComposeText.length() == 1 ?
+                KeyEvent.KEYCODE_DEL : 0;
+        long timeStampMs = SystemClock.uptimeMillis();
+        mLastComposeText = null;
+
+        if (keyCode != 0)
+            nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeRawKeyDown,
+                    timeStampMs, keyCode, 0);*/
         nativeFinishComposingText(mNativeImeAdapterAndroid);
+        /*if (keyCode != 0)
+            nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeKeyUp,
+                    timeStampMs, keyCode, 0);*/
     }
 
     boolean translateAndSendNativeEvents(KeyEvent event) {
         if (mNativeImeAdapterAndroid == 0) return false;
 
         int action = event.getAction();
         if (action != KeyEvent.ACTION_DOWN &&
             action != KeyEvent.ACTION_UP) {
             // action == KeyEvent.ACTION_MULTIPLE
             // TODO(bulach): confirm the actual behavior. Apparently:
@@ skipping 25 matching lines @@
      * Send a request to the native counterpart to delete a given range of characters.
      * @param beforeLength Number of characters to extend the selection by before the existing
      *                     selection.
      * @param afterLength Number of characters to extend the selection by after the existing
      *                    selection.
      * @return Whether the native counterpart of ImeAdapter received the call.
      */
     boolean deleteSurroundingText(int beforeLength, int afterLength) {
         mViewEmbedder.onImeEvent(false);
         if (mNativeImeAdapterAndroid == 0) return false;
-        // Can't send the deletion key code yet because it will delete an extra char at the end.
-        // Also the deleteSurroundingText message is not always ordered properly with key event
-        // messages yet.
-        // TODO(guohui): fix the ordering and send the deletion key code for single-char deletion.
-        sendSyntheticKeyEvent(
-                sEventTypeRawKeyDown, SystemClock.uptimeMillis(), KeyEvent.KEYCODE_UNKNOWN, 0);
+        int keyCode = beforeLength > 0 && afterLength == 0 ?
+                KeyEvent.KEYCODE_DEL : 0;
+        long timeStampMs = SystemClock.uptimeMillis();
+        mLastSyntheticKeyCode = keyCode;
+
+        // TODO(guohui): The ordering of the following three events is not maintained with the
+        // "delete" message typically arriving before the other two (which do arrive in order).
+        // It is possibly due to the processing of Key messages to begin/end other operations.
+        if (keyCode != 0)
+            nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeRawKeyDown,

[guohui, 2014/07/11 15:20:09]

please see review comments in https://codereview.chromium.org/348413003/. In
that CL I tried the same thing of sending del keycode in deleteSurroundingText
and that caused double-deletion and incorrect composition context, thus the
landed patch only sends keycode 0. Have you verified with this change no
double-deletion and composition messup happens?

Also the beforeLength and afterLength in this method is already sanitized,
meaning that it is 0 at the beginning fo the input, thus your change will break
my fix in cl 348413003.

Unless you verified that no double-deletion and incorrect composition position
happens with your CL, i think you should keep deleteSurroudingText as it is, and
address the issue in a later CL.

[guohui, 2014/07/11 19:00:37]

just tried your patch locally, it suffered the same issues as i had before,
double deletion and incorrect composition context, and it actually crashes from
time to time on a debug build...

+                    timeStampMs, keyCode, 0);
         nativeDeleteSurroundingText(mNativeImeAdapterAndroid, beforeLength, afterLength);
-        sendSyntheticKeyEvent(
-                sEventTypeKeyUp, SystemClock.uptimeMillis(), KeyEvent.KEYCODE_UNKNOWN, 0);
+        if (keyCode != 0)
+            nativeSendSyntheticKeyEvent(mNativeImeAdapterAndroid, sEventTypeKeyUp,
+                    timeStampMs, keyCode, 0);
         return true;
     }
 
     /**
      * Send a request to the native counterpart to set the selection to given range.
      * @param start Selection start index.
      * @param end Selection end index.
      * @return Whether the native counterpart of ImeAdapter received the call.
      */
     boolean setEditableSelectionOffsets(int start, int end) {
         if (mNativeImeAdapterAndroid == 0) return false;
         nativeSetEditableSelectionOffsets(mNativeImeAdapterAndroid, start, end);
         return true;
     }
 
     /**
-     * Send a request to the native counterpart to set compositing region to given indices.
+     * Send a request to the native counterpart to set composing region to given indices.
      * @param start The start of the composition.
      * @param end The end of the composition.
      * @return Whether the native counterpart of ImeAdapter received the call.
      */
-    boolean setComposingRegion(int start, int end) {
+    boolean setComposingRegion(CharSequence text, int start, int end) {
         if (mNativeImeAdapterAndroid == 0) return false;
         nativeSetComposingRegion(mNativeImeAdapterAndroid, start, end);
+        mLastComposeText = text != null ? text.toString() : null;
         return true;
     }
 
     /**
      * Send a request to the native counterpart to unselect text.
      * @return Whether the native counterpart of ImeAdapter received the call.
      */
     public boolean unselect() {
         if (mNativeImeAdapterAndroid == 0) return false;
         nativeUnselect(mNativeImeAdapterAndroid);
@@ skipping 93 matching lines @@
             } else if (span instanceof UnderlineSpan) {
                 nativeAppendUnderlineSpan(underlines, spannableString.getSpanStart(span),
                         spannableString.getSpanEnd(span));
             }
         }
     }
 
     @CalledByNative
     private void cancelComposition() {
         if (mInputConnection != null) mInputConnection.restartInput();
+        mLastComposeText = null;
     }
 
     @CalledByNative
     void detach() {
         if (mDismissInput != null) mHandler.removeCallbacks(mDismissInput);
         mNativeImeAdapterAndroid = 0;
         mTextInputType = 0;
     }
 
     private native boolean nativeSendSyntheticKeyEvent(long nativeImeAdapterAndroid,
@@ skipping 25 matching lines @@
     private native void nativeDeleteSurroundingText(long nativeImeAdapterAndroid,
             int before, int after);
 
     private native void nativeUnselect(long nativeImeAdapterAndroid);
     private native void nativeSelectAll(long nativeImeAdapterAndroid);
     private native void nativeCut(long nativeImeAdapterAndroid);
     private native void nativeCopy(long nativeImeAdapterAndroid);
     private native void nativePaste(long nativeImeAdapterAndroid);
     private native void nativeResetImeAdapter(long nativeImeAdapterAndroid);
 }