Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement InputConnectionWrapper#takeSnapshot()

Browse Source 
This is a follow up CL to my previous CL [1], which forgot to
implement

  InputConnectionWrapper#takeSnapshot().

As a result, it has alreays returned null even if the wrapped
InputConnection does implement InputConnection#takeSnapshot().  This
means that InputMethodManager#invalidateInput() had always fallen back
to slow InputMethodManager#restartInput() path if an app returned a
wrapped InputConnection for example.

With this CL, wrapped InputConnection can also start taking advantage
of fast restart-input mechanism unless it's further overridden by the
app developer to return null for some reasons.

 [1]: I8e00dacce5ca915e276fdd8288ffc9167eb01a26
      dae4796235

Test: atest CtsInputMethodTestCases:InputConnectionWrapperTest
Fix: 263677142
Change-Id: I9064a4008d688f2e1188c8d78337f0454c101465
This commit is contained in:
Yohei Yukawa
2023-04-26 20:59:41 -07:00
parent 5568b8bc0e
commit 2e376ce96c
1 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
core/java/android/view/inputmethod/InputConnectionWrapper.java
View File

@@ -412,4 +412,32 @@ public class InputConnectionWrapper implements InputConnection {
public boolean setImeConsumesInput(boolean imeConsumesInput) {
return mTarget.setImeConsumesInput(imeConsumesInput);
}
/**
* Called by the system when it needs to take a snapshot of multiple text-related data in an
* atomic manner.
*
* <p><strong>Editor authors</strong>: Supporting this method is strongly encouraged. Atomically
* taken {@link TextSnapshot} is going to be really helpful for the system when optimizing IPCs
* in a safe and deterministic manner. Return {@code null} if an atomically taken
* {@link TextSnapshot} is unavailable. The system continues supporting such a scenario
* gracefully.</p>
*
* <p><strong>IME authors</strong>: Currently IMEs cannot call this method directly and always
* receive {@code null} as the result.</p>
*
* <p>Beware that there is a bug that this method was not overridden in
* {@link InputConnectionWrapper}, which ended up always returning {@code null} when gets
* called even if the wrapped {@link InputConnection} implements this method. The bug was
* fixed in {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE}.</p>
*
* @return {@code null} if {@link TextSnapshot} is unavailable and/or this API is called from
* IMEs. Beware the bug in older devices mentioned above.
* @throws NullPointerException if the target is {@code null}.
*/
@Nullable
@Override
public TextSnapshot takeSnapshot() {
return mTarget.takeSnapshot();
}
}