Add API for IME control by Accessibility Services. (9b278112) · Commits · e / os / android_frameworks_base

api/current.txt

+13 −0

Original line number	Diff line number	Diff line
		@@ -2616,6 +2616,7 @@ package android.accessibilityservice {
		method public final android.accessibilityservice.AccessibilityService.MagnificationController getMagnificationController();
		method public android.view.accessibility.AccessibilityNodeInfo getRootInActiveWindow();
		method public final android.accessibilityservice.AccessibilityServiceInfo getServiceInfo();
		method public final android.accessibilityservice.AccessibilityService.SoftKeyboardController getSoftKeyboardController();
		method public java.util.List<android.view.accessibility.AccessibilityWindowInfo> getWindows();
		method public abstract void onAccessibilityEvent(android.view.accessibility.AccessibilityEvent);
		method public final android.os.IBinder onBind(android.content.Intent);
		@@ -2674,6 +2675,18 @@ package android.accessibilityservice {
		method public abstract void onMagnificationChanged(android.accessibilityservice.AccessibilityService.MagnificationController, android.graphics.Region, float, float, float);
		}

		public static final class AccessibilityService.SoftKeyboardController {
		method public void addOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener);
		method public void addOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener, android.os.Handler);
		method public int getShowMode();
		method public boolean removeOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener);
		method public boolean setShowMode(int);
		}

		public static abstract interface AccessibilityService.SoftKeyboardController.OnShowModeChangedListener {
		method public abstract void onShowModeChanged(android.accessibilityservice.AccessibilityService.SoftKeyboardController, int);
		}

		public class AccessibilityServiceInfo implements android.os.Parcelable {
		ctor public AccessibilityServiceInfo();
		method public static java.lang.String capabilityToString(int);

api/system-current.txt

+13 −0

Original line number	Diff line number	Diff line
		@@ -2718,6 +2718,7 @@ package android.accessibilityservice {
		method public final android.accessibilityservice.AccessibilityService.MagnificationController getMagnificationController();
		method public android.view.accessibility.AccessibilityNodeInfo getRootInActiveWindow();
		method public final android.accessibilityservice.AccessibilityServiceInfo getServiceInfo();
		method public final android.accessibilityservice.AccessibilityService.SoftKeyboardController getSoftKeyboardController();
		method public java.util.List<android.view.accessibility.AccessibilityWindowInfo> getWindows();
		method public abstract void onAccessibilityEvent(android.view.accessibility.AccessibilityEvent);
		method public final android.os.IBinder onBind(android.content.Intent);
		@@ -2776,6 +2777,18 @@ package android.accessibilityservice {
		method public abstract void onMagnificationChanged(android.accessibilityservice.AccessibilityService.MagnificationController, android.graphics.Region, float, float, float);
		}

		public static final class AccessibilityService.SoftKeyboardController {
		method public void addOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener);
		method public void addOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener, android.os.Handler);
		method public int getShowMode();
		method public boolean removeOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener);
		method public boolean setShowMode(int);
		}

		public static abstract interface AccessibilityService.SoftKeyboardController.OnShowModeChangedListener {
		method public abstract void onShowModeChanged(android.accessibilityservice.AccessibilityService.SoftKeyboardController, int);
		}

		public class AccessibilityServiceInfo implements android.os.Parcelable {
		ctor public AccessibilityServiceInfo();
		method public static java.lang.String capabilityToString(int);

api/test-current.txt

+13 −0

Original line number	Diff line number	Diff line
		@@ -2616,6 +2616,7 @@ package android.accessibilityservice {
		method public final android.accessibilityservice.AccessibilityService.MagnificationController getMagnificationController();
		method public android.view.accessibility.AccessibilityNodeInfo getRootInActiveWindow();
		method public final android.accessibilityservice.AccessibilityServiceInfo getServiceInfo();
		method public final android.accessibilityservice.AccessibilityService.SoftKeyboardController getSoftKeyboardController();
		method public java.util.List<android.view.accessibility.AccessibilityWindowInfo> getWindows();
		method public abstract void onAccessibilityEvent(android.view.accessibility.AccessibilityEvent);
		method public final android.os.IBinder onBind(android.content.Intent);
		@@ -2674,6 +2675,18 @@ package android.accessibilityservice {
		method public abstract void onMagnificationChanged(android.accessibilityservice.AccessibilityService.MagnificationController, android.graphics.Region, float, float, float);
		}

		public static final class AccessibilityService.SoftKeyboardController {
		method public void addOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener);
		method public void addOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener, android.os.Handler);
		method public int getShowMode();
		method public boolean removeOnShowModeChangedListener(android.accessibilityservice.AccessibilityService.SoftKeyboardController.OnShowModeChangedListener);
		method public boolean setShowMode(int);
		}

		public static abstract interface AccessibilityService.SoftKeyboardController.OnShowModeChangedListener {
		method public abstract void onShowModeChanged(android.accessibilityservice.AccessibilityService.SoftKeyboardController, int);
		}

		public class AccessibilityServiceInfo implements android.os.Parcelable {
		ctor public AccessibilityServiceInfo();
		method public static java.lang.String capabilityToString(int);

core/java/android/accessibilityservice/AccessibilityService.java

+325 −37

Original line number	Diff line number	Diff line
		@@ -17,6 +17,7 @@
		package android.accessibilityservice;

		import android.accessibilityservice.GestureDescription.MotionEventGenerator;
		import android.annotation.IntDef;
		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.app.Service;
		@@ -29,6 +30,7 @@ import android.os.IBinder;
		import android.os.Looper;
		import android.os.Message;
		import android.os.RemoteException;
		import android.provider.Settings;
		import android.util.ArrayMap;
		import android.util.Log;
		import android.util.Pair;
		@@ -46,6 +48,8 @@ import android.view.accessibility.AccessibilityWindowInfo;
		import com.android.internal.os.HandlerCaller;
		import com.android.internal.os.SomeArgs;

		import java.lang.annotation.Retention;
		import java.lang.annotation.RetentionPolicy;
		import java.util.List;

		/**
		@@ -378,9 +382,26 @@ public abstract class AccessibilityService extends Service {
		public boolean onKeyEvent(KeyEvent event);
		public void onMagnificationChanged(@NonNull Region region,
		float scale, float centerX, float centerY);
		public void onSoftKeyboardShowModeChanged(int showMode);
		public void onPerformGestureResult(int sequence, boolean completedSuccessfully);
		}

		/**
		* Annotations for Soft Keyboard show modes so tools can catch invalid show modes.
		* @hide
		*/
		@Retention(RetentionPolicy.SOURCE)
		@IntDef({SHOW_MODE_AUTO, SHOW_MODE_HIDDEN})
		public @interface SoftKeyboardShowMode {};
		/**
		* @hide
		*/
		public static final int SHOW_MODE_AUTO = 0;
		/**
		* @hide
		*/
		public static final int SHOW_MODE_HIDDEN = 1;

		private int mConnectionId;

		private AccessibilityServiceInfo mInfo;
		@@ -390,6 +411,7 @@ public abstract class AccessibilityService extends Service {
		private WindowManager mWindowManager;

		private MagnificationController mMagnificationController;
		private SoftKeyboardController mSoftKeyboardController;

		private int mGestureStatusCallbackSequence;

		@@ -554,11 +576,13 @@ public abstract class AccessibilityService extends Service {
		*/
		@NonNull
		public final MagnificationController getMagnificationController() {
		synchronized (mLock) {
		if (mMagnificationController == null) {
		mMagnificationController = new MagnificationController(this);
		mMagnificationController = new MagnificationController(this, mLock);
		}
		return mMagnificationController;
		}
		}

		/**
		* Dispatch a gesture to the touch screen. Any gestures currently in progress, whether from
		@@ -661,19 +685,23 @@ public abstract class AccessibilityService extends Service {
		* first magnification listener.
		*/
		private ArrayMap<OnMagnificationChangedListener, Handler> mListeners;
		private final Object mLock;

		MagnificationController(@NonNull AccessibilityService service) {
		MagnificationController(@NonNull AccessibilityService service, @NonNull Object lock) {
		mService = service;
		mLock = lock;
		}

		/**
		* Called when the service is connected.
		*/
		void onServiceConnected() {
		synchronized (mLock) {
		if (mListeners != null && !mListeners.isEmpty()) {
		setMagnificationCallbackEnabled(true);
		}
		}
		}

		/**
		* Adds the specified change listener to the list of magnification
		@@ -698,6 +726,7 @@ public abstract class AccessibilityService extends Service {
		*/
		public void addListener(@NonNull OnMagnificationChangedListener listener,
		@Nullable Handler handler) {
		synchronized (mLock) {
		if (mListeners == null) {
		mListeners = new ArrayMap<>();
		}
		@@ -711,6 +740,7 @@ public abstract class AccessibilityService extends Service {
		setMagnificationCallbackEnabled(true);
		}
		}
		}

		/**
		* Removes all instances of the specified change listener from the list
		@@ -725,6 +755,7 @@ public abstract class AccessibilityService extends Service {
		return false;
		}

		synchronized (mLock) {
		final int keyIndex = mListeners.indexOfKey(listener);
		final boolean hasKey = keyIndex >= 0;
		if (hasKey) {
		@@ -739,6 +770,7 @@ public abstract class AccessibilityService extends Service {

		return hasKey;
		}
		}

		private void setMagnificationCallbackEnabled(boolean enabled) {
		final IAccessibilityServiceConnection connection =
		@@ -759,6 +791,8 @@ public abstract class AccessibilityService extends Service {
		*/
		void dispatchMagnificationChanged(final @NonNull Region region, final float scale,
		final float centerX, final float centerY) {
		final ArrayMap<OnMagnificationChangedListener, Handler> entries;
		synchronized (mLock) {
		if (mListeners == null \|\| mListeners.isEmpty()) {
		Slog.d(LOG_TAG, "Received magnification changed "
		+ "callback with no listeners registered!");
		@@ -766,10 +800,10 @@ public abstract class AccessibilityService extends Service {
		return;
		}

		// Listeners may remove themselves. Perform a shallow copy to avoid
		// concurrent modification.
		final ArrayMap<OnMagnificationChangedListener, Handler> entries =
		new ArrayMap<>(mListeners);
		// Listeners may remove themselves. Perform a shallow copy to avoid concurrent
		// modification.
		entries = new ArrayMap<>(mListeners);
		}

		for (int i = 0, count = entries.size(); i < count; i++) {
		final OnMagnificationChangedListener listener = entries.keyAt(i);
		@@ -1001,6 +1035,243 @@ public abstract class AccessibilityService extends Service {
		}
		}

		/**
		* Returns the soft keyboard controller, which may be used to query and modify the soft keyboard
		* show mode.
		*
		* @return the soft keyboard controller
		*/
		@NonNull
		public final SoftKeyboardController getSoftKeyboardController() {
		synchronized (mLock) {
		if (mSoftKeyboardController == null) {
		mSoftKeyboardController = new SoftKeyboardController(this, mLock);
		}
		return mSoftKeyboardController;
		}
		}

		private void onSoftKeyboardShowModeChanged(int showMode) {
		if (mSoftKeyboardController != null) {
		mSoftKeyboardController.dispatchSoftKeyboardShowModeChanged(showMode);
		}
		}

		/**
		* Used to control and query the soft keyboard show mode.
		*/
		public static final class SoftKeyboardController {
		private final AccessibilityService mService;

		/**
		* Map of listeners to their handlers. Lazily created when adding the first
		* soft keyboard change listener.
		*/
		private ArrayMap<OnShowModeChangedListener, Handler> mListeners;
		private final Object mLock;

		SoftKeyboardController(@NonNull AccessibilityService service, @NonNull Object lock) {
		mService = service;
		mLock = lock;
		}

		/**
		* Called when the service is connected.
		*/
		void onServiceConnected() {
		synchronized(mLock) {
		if (mListeners != null && !mListeners.isEmpty()) {
		setSoftKeyboardCallbackEnabled(true);
		}
		}
		}

		/**
		* Adds the specified change listener to the list of show mode change listeners. The
		* callback will occur on the service's main thread. Listener is not called on registration.
		*/
		public void addOnShowModeChangedListener(@NonNull OnShowModeChangedListener listener) {
		addOnShowModeChangedListener(listener, null);
		}

		/**
		* Adds the specified change listener to the list of soft keyboard show mode change
		* listeners. The callback will occur on the specified {@link Handler}'s thread, or on the
		* services's main thread if the handler is {@code null}.
		*
		* @param listener the listener to add, must be non-null
		* @param handler the handler on which to callback should execute, or {@code null} to
		* execute on the service's main thread
		*/
		public void addOnShowModeChangedListener(@NonNull OnShowModeChangedListener listener,
		@Nullable Handler handler) {
		synchronized (mLock) {
		if (mListeners == null) {
		mListeners = new ArrayMap<>();
		}

		final boolean shouldEnableCallback = mListeners.isEmpty();
		mListeners.put(listener, handler);

		if (shouldEnableCallback) {
		// This may fail if the service is not connected yet, but if we still have
		// listeners when it connects, we can try again.
		setSoftKeyboardCallbackEnabled(true);
		}
		}
		}

		/**
		* Removes all instances of the specified change listener from teh list of magnification
		* change listeners.
		*
		* @param listener the listener to remove, must be non-null
		* @return {@code true} if at least one instance of the listener was removed
		*/
		public boolean removeOnShowModeChangedListener(@NonNull OnShowModeChangedListener listener) {
		if (mListeners == null) {
		return false;
		}

		synchronized (mLock) {
		final int keyIndex = mListeners.indexOfKey(listener);
		final boolean hasKey = keyIndex >= 0;
		if (hasKey) {
		mListeners.removeAt(keyIndex);
		}

		if (hasKey && mListeners.isEmpty()) {
		// We just removed the last listener, so we don't need callbacks from the
		// service anymore.
		setSoftKeyboardCallbackEnabled(false);
		}

		return hasKey;
		}
		}

		private void setSoftKeyboardCallbackEnabled(boolean enabled) {
		final IAccessibilityServiceConnection connection =
		AccessibilityInteractionClient.getInstance().getConnection(
		mService.mConnectionId);
		if (connection != null) {
		try {
		connection.setSoftKeyboardCallbackEnabled(enabled);
		} catch (RemoteException re) {
		throw new RuntimeException(re);
		}
		}
		}

		/**
		* Dispatches the soft keyboard show mode change to any registered listeners. This should
		* be called on the service's main thread.
		*/
		void dispatchSoftKeyboardShowModeChanged(final int showMode) {
		final ArrayMap<OnShowModeChangedListener, Handler> entries;
		synchronized (mLock) {
		if (mListeners == null \|\| mListeners.isEmpty()) {
		Slog.d(LOG_TAG, "Received soft keyboard show mode changed callback"
		+ " with no listeners registered!");
		setSoftKeyboardCallbackEnabled(false);
		return;
		}

		// Listeners may remove themselves. Perform a shallow copy to avoid concurrent
		// modification.
		entries = new ArrayMap<>(mListeners);
		}

		for (int i = 0, count = entries.size(); i < count; i++) {
		final OnShowModeChangedListener listener = entries.keyAt(i);
		final Handler handler = entries.valueAt(i);
		if (handler != null) {
		handler.post(new Runnable() {
		@Override
		public void run() {
		listener.onShowModeChanged(SoftKeyboardController.this, showMode);
		}
		});
		} else {
		// We're already on the main thread, just run the listener.
		listener.onShowModeChanged(this, showMode);
		}
		}
		}

		/**
		* Returns the show mode of the soft keyboard. The default show mode is
		* {@code Settings.Secure.SHOW_MODE_AUTO}, where the soft keyboard is shown when a text
		* input field is focused. An AccessibilityService can also request the show mode
		* {@code Settings.Secure.SHOW_MODE_HIDDEN}, where the soft keyboard is never shown.
		*
		* @return the current soft keyboard show mode
		*
		* @see Settings#Secure#SHOW_MODE_AUTO
		* @see Settings#Secure#SHOW_MODE_HIDDEN
		*/
		@SoftKeyboardShowMode
		public int getShowMode() {
		try {
		return Settings.Secure.getInt(mService.getContentResolver(),
		Settings.Secure.ACCESSIBILITY_SOFT_KEYBOARD_MODE);
		} catch (Settings.SettingNotFoundException e) {
		Log.v(LOG_TAG, "Failed to obtain the soft keyboard mode", e);
		// The settings hasn't been changed yet, so it's value is null. Return the default.
		return 0;
		}
		}

		/**
		* Sets the soft keyboard show mode. The default show mode is
		* {@code Settings.Secure.SHOW_MODE_AUTO}, where the soft keyboard is shown when a text
		* input field is focused. An AccessibilityService can also request the show mode
		* {@code Settings.Secure.SHOW_MODE_HIDDEN}, where the soft keyboard is never shown. The
		* The lastto this method will be honored, regardless of any previous calls (including those
		* made by other AccessibilityServices).
		* <p>
		* <strong>Note:</strong> If the service is not yet conected (e.g.
		* {@link AccessibilityService#onServiceConnected()} has not yet been called) or the
		* service has been disconnected, this method will hav no effect and return {@code false}.
		*
		* @param showMode the new show mode for the soft keyboard
		* @return {@code true} on success
		*
		* @see Settings#Secure#SHOW_MODE_AUTO
		* @see Settings#Secure#SHOW_MODE_HIDDEN
		*/
		public boolean setShowMode(@SoftKeyboardShowMode int showMode) {
		final IAccessibilityServiceConnection connection =
		AccessibilityInteractionClient.getInstance().getConnection(
		mService.mConnectionId);
		if (connection != null) {
		try {
		return connection.setSoftKeyboardShowMode(showMode);
		} catch (RemoteException re) {
		Log.w(LOG_TAG, "Falied to set soft keyboard behavior", re);
		}
		}
		return false;
		}

		/**
		* Listener for changes in the soft keyboard show mode.
		*/
		public interface OnShowModeChangedListener {
		/**
		* Called when the soft keyboard behavior changes. The default show mode is
		* {@code Settings.Secure.SHOW_MODE_AUTO}, where the soft keyboard is shown when a text
		* input field is focused. An AccessibilityService can also request the show mode
		* {@code Settings.Secure.SHOW_MODE_HIDDEN}, where the soft keyboard is never shown.
		*
		* @param controller the soft keyboard controller
		* @param showMode the current soft keyboard show mode
		*/
		void onShowModeChanged(@NonNull SoftKeyboardController controller,
		@SoftKeyboardShowMode int showMode);
		}
		}

		/**
		* Performs a global action. Such an action can be performed
		* at any moment regardless of the current application or user
		@@ -1174,6 +1445,11 @@ public abstract class AccessibilityService extends Service {
		AccessibilityService.this.onMagnificationChanged(region, scale, centerX, centerY);
		}

		@Override
		public void onSoftKeyboardShowModeChanged(int showMode) {
		AccessibilityService.this.onSoftKeyboardShowModeChanged(showMode);
		}

		@Override
		public void onPerformGestureResult(int sequence, boolean completedSuccessfully) {
		AccessibilityService.this.onPerformGestureResult(sequence, completedSuccessfully);
		@@ -1196,7 +1472,8 @@ public abstract class AccessibilityService extends Service {
		private static final int DO_CLEAR_ACCESSIBILITY_CACHE = 5;
		private static final int DO_ON_KEY_EVENT = 6;
		private static final int DO_ON_MAGNIFICATION_CHANGED = 7;
		private static final int DO_GESTURE_COMPLETE = 8;
		private static final int DO_ON_SOFT_KEYBOARD_SHOW_MODE_CHANGED = 8;
		private static final int DO_GESTURE_COMPLETE = 9;

		private final HandlerCaller mCaller;

		@@ -1255,6 +1532,12 @@ public abstract class AccessibilityService extends Service {
		mCaller.sendMessage(message);
		}

		public void onSoftKeyboardShowModeChanged(int showMode) {
		final Message message =
		mCaller.obtainMessageI(DO_ON_SOFT_KEYBOARD_SHOW_MODE_CHANGED, showMode);
		mCaller.sendMessage(message);
		}

		public void onPerformGestureResult(int sequence, boolean successfully) {
		Message message = mCaller.obtainMessageII(DO_GESTURE_COMPLETE, sequence,
		successfully ? 1 : 0);
		@@ -1345,6 +1628,11 @@ public abstract class AccessibilityService extends Service {
		mCallback.onMagnificationChanged(region, scale, centerX, centerY);
		} return;

		case DO_ON_SOFT_KEYBOARD_SHOW_MODE_CHANGED: {
		final int showMode = (int) message.arg1;
		mCallback.onSoftKeyboardShowModeChanged(showMode);
		} return;

		case DO_GESTURE_COMPLETE: {
		final boolean successfully = message.arg2 == 1;
		mCallback.onPerformGestureResult(message.arg1, successfully);

core/java/android/accessibilityservice/IAccessibilityServiceClient.aidl

+2 −0

Original line number	Diff line number	Diff line
		@@ -43,5 +43,7 @@ import android.view.KeyEvent;

		void onMagnificationChanged(in Region region, float scale, float centerX, float centerY);

		void onSoftKeyboardShowModeChanged(int showMode);

		void onPerformGestureResult(int sequence, boolean completedSuccessfully);
		}