InputConnection is warned when finished

As said in https://android-git.corp.google.com/g/#/c/155992
finishComposingText is indeed too broad of a method.

Introducing a new dedicated method to warn the InputConnection.

Should solve the problems with a negative counter value.

Change-Id: I5525d776916f0c42d5e6d4a4282aed590d7f0e9a

Author: Gilles Debunne

core/java/android/view/inputmethod/BaseInputConnection.java

@@ -151,6 +151,15 @@ public boolean endBatchEdit() {
         return false;
     }
 
+    /**
+     * Called when this InputConnection is no longer used by the InputMethodManager.
+     *
+     * @hide
+     */
+    protected void reportFinish() {
+        // Intentionaly empty
+    }
+
     /**
      * Default implementation uses
      * {@link MetaKeyKeyListener#clearMetaKeyState(long, int)

core/java/android/view/inputmethod/InputMethodManager.java

@@ -26,7 +26,6 @@
 import com.android.internal.view.InputBindResult;
 
 import android.content.Context;
-import android.content.pm.PackageManager;
 import android.graphics.Rect;
 import android.os.Bundle;
 import android.os.Handler;
@@ -690,6 +689,10 @@ private void notifyInputConnectionFinished() {
     public void reportFinishInputConnection(InputConnection ic) {
         if (mServedInputConnection != ic) {
             ic.finishComposingText();
+            // To avoid modifying the public InputConnection interface
+            if (ic instanceof BaseInputConnection) {
+                ((BaseInputConnection) ic).reportFinish();
+            }
         }
     }
 

core/java/com/android/internal/widget/EditableInputConnection.java

@@ -70,7 +70,7 @@ public boolean beginBatchEdit() {
     public boolean endBatchEdit() {
         synchronized(this) {
             if (mBatchEditNesting > 0) {
-                // When the connection is reset by the InputMethodManager and finishComposingText
+                // When the connection is reset by the InputMethodManager and reportFinish
                 // is called, some endBatchEdit calls may still be asynchronously received from the
                 // IME. Do not take these into account, thus ensuring that this IC's final
                 // contribution to mTextView's nested batch edit count is zero.
@@ -82,6 +82,19 @@ public boolean endBatchEdit() {
         return false;
     }
 
+    @Override
+    protected void reportFinish() {
+        super.reportFinish();
+
+        synchronized(this) {
+            while (mBatchEditNesting > 0) {
+                endBatchEdit();
+            }
+            // Will prevent any further calls to begin or endBatchEdit
+            mBatchEditNesting = -1;
+        }
+    }
+
     @Override
     public boolean clearMetaKeyStates(int states) {
         final Editable content = getEditable();
@@ -98,23 +111,6 @@ public boolean clearMetaKeyStates(int states) {
         return true;
     }
 
-    @Override
-    public boolean finishComposingText() {
-        final boolean superResult = super.finishComposingText();
-        synchronized(this) {
-            if (mBatchEditNesting < 0) {
-                // The connection was already finished
-                return false;
-            }
-            while (mBatchEditNesting > 0) {
-                endBatchEdit();
-            }
-            // Will prevent any further calls to begin or endBatchEdit
-            mBatchEditNesting = -1;
-        }
-        return superResult;
-    }
-
     @Override
     public boolean commitCompletion(CompletionInfo text) {
         if (DEBUG) Log.v(TAG, "commitCompletion " + text);