diff options
| author | Yohei Yukawa <yukawa@google.com> | 2021-07-09 09:46:58 -0700 |
|---|---|---|
| committer | Yohei Yukawa <yukawa@google.com> | 2021-07-13 15:54:10 +0000 |
| commit | a975bfc447b04fe90a5ec9c3d4757810f7d07af1 (patch) | |
| tree | 43527584fe64c505f2fc958e7bbd44876008fa02 /core/java/android/inputmethodservice/InputMethodServiceInternal.java | |
| parent | 26b594af104352c397200de2f0f40b8e2d1a1f04 (diff) | |
Introduce InputMethodServiceInternal for better abstraction
This is a mechanical refactoring CL that has no behavior change.
This CL removes the direct dependency on AbstractInputMethodService
from whenever possible. As a result, the following classes no longer
directly depend on AbstractInputMethodService.
* android.inputmethodservice.IInputMethodWrapper
* android.inputmethodservice.RemoteInputConnection
* com.android.internal.inputmethod.ImeTracing
* com.android.internal.inputmethod.ImeTracingClientImpl
* com.android.internal.inputmethod.ImeTracingServerImpl
This is still a purely mechanical refactoring. There should be no
observable behavior change.
Bug: 192412909
Test: atest CtsInputMethodTestCases
Test: Manually verified that IME tracing still works
Change-Id: I2aeeeacd27195ce10059d6590e098a4a969e774d
Diffstat (limited to 'core/java/android/inputmethodservice/InputMethodServiceInternal.java')
| -rw-r--r-- | core/java/android/inputmethodservice/InputMethodServiceInternal.java | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/core/java/android/inputmethodservice/InputMethodServiceInternal.java b/core/java/android/inputmethodservice/InputMethodServiceInternal.java new file mode 100644 index 000000000000..7cd4ff61b2c8 --- /dev/null +++ b/core/java/android/inputmethodservice/InputMethodServiceInternal.java @@ -0,0 +1,86 @@ +/* + * Copyright (C) 2021 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package android.inputmethodservice; + +import android.annotation.NonNull; +import android.annotation.Nullable; +import android.content.Context; +import android.os.Bundle; +import android.view.inputmethod.InputConnection; +import android.view.inputmethod.InputContentInfo; + +import java.io.FileDescriptor; +import java.io.PrintWriter; + +/** + * A set of internal methods exposed by {@link InputMethodService} to be called only from other + * framework classes for internal use. + * + * <p>CAVEATS: {@link AbstractInputMethodService} does not support all the methods here.</p> + */ +interface InputMethodServiceInternal { + /** + * @return {@link Context} associated with the service. + */ + @NonNull + Context getContext(); + + /** + * Allow the receiver of {@link InputContentInfo} to obtain a temporary read-only access + * permission to the content. + * + * @param inputContentInfo Content to be temporarily exposed from the input method to the + * application. This cannot be {@code null}. + * @param inputConnection {@link InputConnection} with which + * {@link InputConnection#commitContent(InputContentInfo, int, Bundle)} + * will be called. + */ + default void exposeContent(@NonNull InputContentInfo inputContentInfo, + @NonNull InputConnection inputConnection) { + } + + /** + * Called when the user took some actions that should be taken into consideration to update the + * MRU list for input method rotation. + */ + default void notifyUserActionIfNecessary() { + } + + /** + * Called when the system is asking the IME to dump its information for debugging. + * + * <p>The caller is responsible for checking {@link android.Manifest.permission.DUMP}.</p> + * + * @param fd The raw file descriptor that the dump is being sent to. + * @param fout The file to which you should dump your state. This will be + * closed for you after you return. + * @param args additional arguments to the dump request. + */ + default void dump(FileDescriptor fd, PrintWriter fout, String[] args) { + } + + /** + * Called with {@link com.android.internal.inputmethod.ImeTracing#triggerServiceDump(String, + * com.android.internal.inputmethod.ImeTracing.ServiceDumper, byte[])} needs to be triggered + * with the given parameters. + * + * @param where {@code where} parameter to be passed. + * @param icProto {@code icProto} parameter to be passed. + */ + default void triggerServiceDump(String where, @Nullable byte[] icProto) { + } +} |
