the input method can act as another source of key events for Key Mapper

Author: Seth Schroeder

app/src/main/AndroidManifest.xml

@@ -15,13 +15,14 @@
 -->
 
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-        coreApp="true"
-        package="io.github.sds100.keymapper.inputmethod.latin">
+    coreApp="true"
+    package="io.github.sds100.keymapper.inputmethod.latin">
 
     <uses-permission android:name="android.permission.READ_USER_DICTIONARY" />
     <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
     <uses-permission android:name="android.permission.VIBRATE" />
     <uses-permission android:name="android.permission.WRITE_USER_DICTIONARY" />
+    <uses-permission android:name="io.github.sds100.keymapper.KEY_EVENT_RECEIVER" />
 
     <!-- A signature-protected permission to ask AOSP Keyboard to close the software keyboard.
          To use this, add the following line into calling application's AndroidManifest.xml

app/src/main/aidl/io/github/sds100/keymapper/api/IKeyEventReceiver.aidl

@@ -0,0 +1,7 @@
+package io.github.sds100.keymapper.api;
+
+import android.view.KeyEvent;
+
+interface IKeyEventReceiver {
+    boolean onKeyEvent(in KeyEvent event);
+}

app/src/main/java/io/github/sds100/keymapper/inputmethod/latin/LatinIME.java

@@ -16,13 +16,19 @@
 
 package io.github.sds100.keymapper.inputmethod.latin;
 
+import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.FORCE_ASCII;
+import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE;
+import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE_COMPAT;
+
 import android.app.AlertDialog;
 import android.content.BroadcastReceiver;
+import android.content.ComponentName;
 import android.content.Context;
 import android.content.DialogInterface;
 import android.content.DialogInterface.OnClickListener;
 import android.content.Intent;
 import android.content.IntentFilter;
+import android.content.ServiceConnection;
 import android.content.res.Configuration;
 import android.content.res.Resources;
 import android.graphics.Color;
@@ -33,7 +39,7 @@
 import android.os.IBinder;
 import android.os.Message;
 import android.os.Process;
-import android.os.SystemClock;
+import android.os.RemoteException;
 import android.text.InputType;
 import android.util.Log;
 import android.util.PrintWriterPrinter;
@@ -50,6 +56,16 @@
 import android.view.inputmethod.InputConnection;
 import android.view.inputmethod.InputMethodSubtype;
 
+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 io.github.sds100.keymapper.api.IKeyEventReceiver;
 import io.github.sds100.keymapper.inputmethod.accessibility.AccessibilityUtils;
 import io.github.sds100.keymapper.inputmethod.annotations.UsedForTesting;
 import io.github.sds100.keymapper.inputmethod.compat.EditorInfoCompatUtils;
@@ -92,19 +108,6 @@
 import io.github.sds100.keymapper.inputmethod.latin.utils.SubtypeLocaleUtils;
 import io.github.sds100.keymapper.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 static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.FORCE_ASCII;
-import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE;
-import static io.github.sds100.keymapper.inputmethod.latin.common.Constants.ImeOption.NO_MICROPHONE_COMPAT;
-
 /**
  * Input method implementation for Qwerty'ish keyboard.
  */
@@ -214,8 +217,28 @@ public void onReceive(Context context, Intent intent) {
             }
         }
     }
+
     final RestartAfterDeviceUnlockReceiver mRestartAfterDeviceUnlockReceiver = new RestartAfterDeviceUnlockReceiver();
 
+    private final Object keyEventReceiverLock = new Object();
+    private IKeyEventReceiver keyEventReceiverBinder = null;
+
+    private final ServiceConnection keyEventReceiverConnection = new ServiceConnection() {
+        @Override
+        public void onServiceConnected(ComponentName name, IBinder service) {
+            synchronized (keyEventReceiverLock) {
+                keyEventReceiverBinder = IKeyEventReceiver.Stub.asInterface(service);
+            }
+        }
+
+        @Override
+        public void onServiceDisconnected(ComponentName name) {
+            synchronized (keyEventReceiverLock) {
+                keyEventReceiverBinder = null;
+            }
+        }
+    };
+
     final static class KeyMapperBroadcastReceiver extends BroadcastReceiver {
         private final InputMethodService mIms;
 
@@ -759,6 +782,15 @@ public void onCreate() {
 
         registerReceiver(mKeyMapperBroadcastReceiver, keyMapperIntentFilter);
 
+        try {
+            ComponentName keyEventReceiverComponent = new ComponentName("io.github.sds100.keymapper", "io.github.sds100.keymapper.api.KeyEventReceiver");
+            Intent keyEventReceiverServiceIntent = new Intent();
+            keyEventReceiverServiceIntent.setComponent(keyEventReceiverComponent);
+            bindService(keyEventReceiverServiceIntent, keyEventReceiverConnection, 0);
+        } catch (SecurityException e) {
+            Log.e(TAG, e.toString());
+        }
+
         StatsUtils.onCreate(mSettings.getCurrent(), mRichImm);
     }
 
@@ -871,6 +903,7 @@ public void onDestroy() {
         unregisterReceiver(mRestartAfterDeviceUnlockReceiver);
         unregisterReceiver(mKeyMapperBroadcastReceiver);
         mStatsUtilsManager.onDestroy(this /* context */);
+        unbindService(keyEventReceiverConnection);
         super.onDestroy();
     }
 
@@ -1889,6 +1922,17 @@ private HardwareEventDecoder getHardwareKeyEventDecoder(final int deviceId) {
     // Hooks for hardware keyboard
     @Override
     public boolean onKeyDown(final int keyCode, final KeyEvent keyEvent) {
+
+        if (keyEventReceiverBinder != null) {
+            try {
+                if (keyEventReceiverBinder.onKeyEvent(keyEvent)) {
+                    return true;
+                }
+            } catch (RemoteException e) {
+
+            }
+        }
+
         if (mEmojiAltPhysicalKeyDetector == null) {
             mEmojiAltPhysicalKeyDetector = new EmojiAltPhysicalKeyDetector(
                     getApplicationContext().getResources());
@@ -1909,11 +1953,22 @@ public boolean onKeyDown(final int keyCode, final KeyEvent keyEvent) {
                     mHandler);
             return true;
         }
+
         return super.onKeyDown(keyCode, keyEvent);
     }
 
     @Override
     public boolean onKeyUp(final int keyCode, final KeyEvent keyEvent) {
+        if (keyEventReceiverBinder != null) {
+            try {
+                if (keyEventReceiverBinder.onKeyEvent(keyEvent)) {
+                    return true;
+                }
+            } catch (RemoteException e) {
+
+            }
+        }
+
         if (mEmojiAltPhysicalKeyDetector == null) {
             mEmojiAltPhysicalKeyDetector = new EmojiAltPhysicalKeyDetector(
                     getApplicationContext().getResources());
@@ -1926,6 +1981,7 @@ public boolean onKeyUp(final int keyCode, final KeyEvent keyEvent) {
         if (mInputLogic.mCurrentlyPressedHardwareKeys.remove(keyIdentifier)) {
             return true;
         }
+
         return super.onKeyUp(keyCode, keyEvent);
     }