Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.widget; |
| 18 | |
| 19 | import android.annotation.NonNull; |
| 20 | import android.annotation.Nullable; |
| 21 | import android.annotation.UiThread; |
| 22 | import android.annotation.WorkerThread; |
| 23 | import android.os.AsyncTask; |
Abodunrinwa Toki | 4cfda0b | 2017-02-28 18:56:47 +0000 | [diff] [blame] | 24 | import android.os.LocaleList; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 25 | import android.text.Selection; |
| 26 | import android.text.Spannable; |
| 27 | import android.text.TextUtils; |
| 28 | import android.view.ActionMode; |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 29 | import android.view.textclassifier.TextClassification; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 30 | import android.view.textclassifier.TextClassifier; |
| 31 | import android.view.textclassifier.TextSelection; |
| 32 | import android.widget.Editor.SelectionModifierCursorController; |
| 33 | |
| 34 | import com.android.internal.util.Preconditions; |
| 35 | |
Abodunrinwa Toki | fdf57ba | 2017-05-02 20:32:23 +0100 | [diff] [blame] | 36 | import java.util.Objects; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 37 | import java.util.function.Consumer; |
| 38 | import java.util.function.Supplier; |
| 39 | |
| 40 | /** |
| 41 | * Helper class for starting selection action mode |
| 42 | * (synchronously without the TextClassifier, asynchronously with the TextClassifier). |
| 43 | */ |
| 44 | @UiThread |
| 45 | final class SelectionActionModeHelper { |
| 46 | |
| 47 | /** |
| 48 | * Maximum time (in milliseconds) to wait for a result before timing out. |
| 49 | */ |
| 50 | // TODO: Consider making this a ViewConfiguration. |
| 51 | private static final int TIMEOUT_DURATION = 200; |
| 52 | |
| 53 | private final Editor mEditor; |
| 54 | private final TextClassificationHelper mTextClassificationHelper; |
| 55 | |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 56 | private TextClassification mTextClassification; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 57 | private AsyncTask mTextClassificationAsyncTask; |
| 58 | |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 59 | private final SelectionTracker mSelectionTracker; |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 60 | |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 61 | SelectionActionModeHelper(@NonNull Editor editor) { |
| 62 | mEditor = Preconditions.checkNotNull(editor); |
| 63 | final TextView textView = mEditor.getTextView(); |
| 64 | mTextClassificationHelper = new TextClassificationHelper( |
Abodunrinwa Toki | 4cfda0b | 2017-02-28 18:56:47 +0000 | [diff] [blame] | 65 | textView.getTextClassifier(), textView.getText(), 0, 1, textView.getTextLocales()); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 66 | mSelectionTracker = new SelectionTracker(textView.getTextClassifier()); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 67 | } |
| 68 | |
Abodunrinwa Toki | 66c1627 | 2017-05-03 20:22:55 +0100 | [diff] [blame] | 69 | public void startActionModeAsync(boolean adjustSelection) { |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 70 | cancelAsyncTask(); |
Abodunrinwa Toki | 76b51dc | 2017-07-13 23:37:11 +0100 | [diff] [blame] | 71 | if (skipTextClassification()) { |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 72 | startActionMode(null); |
| 73 | } else { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 74 | resetTextClassificationHelper(true /* resetSelectionTag */); |
Makoto Onuki | 1488a3a | 2017-05-24 12:25:46 -0700 | [diff] [blame] | 75 | final TextView tv = mEditor.getTextView(); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 76 | mTextClassificationAsyncTask = new TextClassificationAsyncTask( |
Makoto Onuki | 1488a3a | 2017-05-24 12:25:46 -0700 | [diff] [blame] | 77 | tv, |
Abodunrinwa Toki | 66c1627 | 2017-05-03 20:22:55 +0100 | [diff] [blame] | 78 | TIMEOUT_DURATION, |
| 79 | adjustSelection |
| 80 | ? mTextClassificationHelper::suggestSelection |
| 81 | : mTextClassificationHelper::classifyText, |
| 82 | this::startActionMode) |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 83 | .execute(); |
| 84 | } |
| 85 | } |
| 86 | |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 87 | public void invalidateActionModeAsync() { |
| 88 | cancelAsyncTask(); |
Abodunrinwa Toki | 76b51dc | 2017-07-13 23:37:11 +0100 | [diff] [blame] | 89 | if (skipTextClassification()) { |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 90 | invalidateActionMode(null); |
| 91 | } else { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 92 | resetTextClassificationHelper(false /* resetSelectionTag */); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 93 | mTextClassificationAsyncTask = new TextClassificationAsyncTask( |
| 94 | mEditor.getTextView(), TIMEOUT_DURATION, |
| 95 | mTextClassificationHelper::classifyText, this::invalidateActionMode) |
| 96 | .execute(); |
| 97 | } |
| 98 | } |
| 99 | |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 100 | public void onSelectionAction() { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 101 | mSelectionTracker.onSelectionAction(mTextClassificationHelper.getSelectionTag()); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 102 | } |
| 103 | |
Abodunrinwa Toki | 8dd3a74 | 2017-05-02 18:44:19 +0100 | [diff] [blame] | 104 | public boolean resetSelection(int textIndex) { |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 105 | if (mSelectionTracker.resetSelection( |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 106 | textIndex, mEditor, mTextClassificationHelper.getSelectionTag())) { |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 107 | invalidateActionModeAsync(); |
| 108 | return true; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 109 | } |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 110 | return false; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | @Nullable |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 114 | public TextClassification getTextClassification() { |
| 115 | return mTextClassification; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 116 | } |
| 117 | |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 118 | public void onDestroyActionMode() { |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 119 | mSelectionTracker.onSelectionDestroyed(); |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 120 | cancelAsyncTask(); |
| 121 | } |
| 122 | |
| 123 | private void cancelAsyncTask() { |
| 124 | if (mTextClassificationAsyncTask != null) { |
| 125 | mTextClassificationAsyncTask.cancel(true); |
| 126 | mTextClassificationAsyncTask = null; |
| 127 | } |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 128 | mTextClassification = null; |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 129 | } |
| 130 | |
Abodunrinwa Toki | 76b51dc | 2017-07-13 23:37:11 +0100 | [diff] [blame] | 131 | private boolean skipTextClassification() { |
Abodunrinwa Toki | 792d820 | 2017-03-06 23:51:11 +0000 | [diff] [blame] | 132 | final TextView textView = mEditor.getTextView(); |
Abodunrinwa Toki | 76b51dc | 2017-07-13 23:37:11 +0100 | [diff] [blame] | 133 | // No need to make an async call for a no-op TextClassifier. |
| 134 | final boolean noOpTextClassifier = textView.getTextClassifier() == TextClassifier.NO_OP; |
| 135 | // Do not call the TextClassifier if there is no selection. |
| 136 | final boolean noSelection = textView.getSelectionEnd() == textView.getSelectionStart(); |
| 137 | // Do not call the TextClassifier if this is a password field. |
| 138 | final boolean password = textView.hasPasswordTransformationMethod() |
| 139 | || TextView.isPasswordInputType(textView.getInputType()); |
| 140 | return noOpTextClassifier || noSelection || password; |
Abodunrinwa Toki | 792d820 | 2017-03-06 23:51:11 +0000 | [diff] [blame] | 141 | } |
| 142 | |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 143 | private void startActionMode(@Nullable SelectionResult result) { |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 144 | final TextView textView = mEditor.getTextView(); |
| 145 | final CharSequence text = textView.getText(); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 146 | mSelectionTracker.setOriginalSelection( |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 147 | textView.getSelectionStart(), textView.getSelectionEnd()); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 148 | if (result != null && text instanceof Spannable) { |
| 149 | Selection.setSelection((Spannable) text, result.mStart, result.mEnd); |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 150 | mTextClassification = result.mClassification; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 151 | } else { |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 152 | mTextClassification = null; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 153 | } |
| 154 | if (mEditor.startSelectionActionModeInternal()) { |
| 155 | final SelectionModifierCursorController controller = mEditor.getSelectionController(); |
| 156 | if (controller != null) { |
| 157 | controller.show(); |
| 158 | } |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 159 | if (result != null) { |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 160 | mSelectionTracker.onSelectionStarted( |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 161 | result.mStart, result.mEnd, mTextClassificationHelper.getSelectionTag()); |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 162 | } |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 163 | } |
| 164 | mEditor.setRestartActionModeOnNextRefresh(false); |
| 165 | mTextClassificationAsyncTask = null; |
| 166 | } |
| 167 | |
| 168 | private void invalidateActionMode(@Nullable SelectionResult result) { |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 169 | mTextClassification = result != null ? result.mClassification : null; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 170 | final ActionMode actionMode = mEditor.getTextActionMode(); |
| 171 | if (actionMode != null) { |
| 172 | actionMode.invalidate(); |
| 173 | } |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 174 | final TextView textView = mEditor.getTextView(); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 175 | mSelectionTracker.onSelectionUpdated( |
| 176 | textView.getSelectionStart(), textView.getSelectionEnd(), |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 177 | mTextClassificationHelper.getSelectionTag()); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 178 | mTextClassificationAsyncTask = null; |
| 179 | } |
| 180 | |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 181 | private void resetTextClassificationHelper(boolean resetSelectionTag) { |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 182 | final TextView textView = mEditor.getTextView(); |
| 183 | mTextClassificationHelper.reset(textView.getTextClassifier(), textView.getText(), |
Abodunrinwa Toki | 4cfda0b | 2017-02-28 18:56:47 +0000 | [diff] [blame] | 184 | textView.getSelectionStart(), textView.getSelectionEnd(), |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 185 | resetSelectionTag, textView.getTextLocales()); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | /** |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 189 | * Tracks and logs smart selection changes. |
| 190 | * It is important to trigger this object's methods at the appropriate event so that it tracks |
| 191 | * smart selection events appropriately. |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 192 | */ |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 193 | private static final class SelectionTracker { |
| 194 | |
| 195 | // Log event: Smart selection happened. |
| 196 | private static final String LOG_EVENT_MULTI_SELECTION = |
| 197 | "textClassifier_multiSelection"; |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 198 | private static final String LOG_EVENT_SINGLE_SELECTION = |
| 199 | "textClassifier_singleSelection"; |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 200 | |
| 201 | // Log event: Smart selection acted upon. |
| 202 | private static final String LOG_EVENT_MULTI_SELECTION_ACTION = |
| 203 | "textClassifier_multiSelection_action"; |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 204 | private static final String LOG_EVENT_SINGLE_SELECTION_ACTION = |
| 205 | "textClassifier_singleSelection_action"; |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 206 | |
| 207 | // Log event: Smart selection was reset to original selection. |
| 208 | private static final String LOG_EVENT_MULTI_SELECTION_RESET = |
| 209 | "textClassifier_multiSelection_reset"; |
| 210 | |
| 211 | // Log event: Smart selection was user modified. |
| 212 | private static final String LOG_EVENT_MULTI_SELECTION_MODIFIED = |
| 213 | "textClassifier_multiSelection_modified"; |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 214 | private static final String LOG_EVENT_SINGLE_SELECTION_MODIFIED = |
| 215 | "textClassifier_singleSelection_modified"; |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 216 | |
| 217 | private final TextClassifier mClassifier; |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 218 | |
| 219 | private int mOriginalStart; |
| 220 | private int mOriginalEnd; |
| 221 | private int mSelectionStart; |
| 222 | private int mSelectionEnd; |
| 223 | |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 224 | private boolean mMultiSelection; |
| 225 | private boolean mClassifierSelection; |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 226 | |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 227 | SelectionTracker(TextClassifier classifier) { |
| 228 | mClassifier = classifier; |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * Called to initialize the original selection before smart selection is triggered. |
| 233 | */ |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 234 | public void setOriginalSelection(int selectionStart, int selectionEnd) { |
| 235 | mOriginalStart = selectionStart; |
| 236 | mOriginalEnd = selectionEnd; |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 237 | resetSelectionFlags(); |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 238 | } |
| 239 | |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 240 | /** |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 241 | * Called when selection action mode is started and the results come from a classifier. |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 242 | * If the selection indices are different from the original selection indices, we have a |
| 243 | * smart selection. |
| 244 | */ |
| 245 | public void onSelectionStarted(int selectionStart, int selectionEnd, String logTag) { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 246 | mClassifierSelection = !logTag.isEmpty(); |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 247 | mSelectionStart = selectionStart; |
| 248 | mSelectionEnd = selectionEnd; |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 249 | // If the started selection is different from the original selection, we have a |
| 250 | // smart selection. |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 251 | mMultiSelection = |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 252 | mSelectionStart != mOriginalStart || mSelectionEnd != mOriginalEnd; |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 253 | if (mMultiSelection) { |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 254 | mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION); |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 255 | } else if (mClassifierSelection) { |
| 256 | mClassifier.logEvent(logTag, LOG_EVENT_SINGLE_SELECTION); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 257 | } |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 258 | } |
| 259 | |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 260 | /** |
| 261 | * Called when selection bounds change. |
| 262 | */ |
| 263 | public void onSelectionUpdated(int selectionStart, int selectionEnd, String logTag) { |
| 264 | final boolean selectionChanged = |
| 265 | selectionStart != mSelectionStart || selectionEnd != mSelectionEnd; |
| 266 | if (selectionChanged) { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 267 | if (mMultiSelection) { |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 268 | mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_MODIFIED); |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 269 | } else if (mClassifierSelection) { |
| 270 | mClassifier.logEvent(logTag, LOG_EVENT_SINGLE_SELECTION_MODIFIED); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 271 | } |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 272 | resetSelectionFlags(); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 273 | } |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 274 | } |
| 275 | |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 276 | /** |
| 277 | * Called when the selection action mode is destroyed. |
| 278 | */ |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 279 | public void onSelectionDestroyed() { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 280 | resetSelectionFlags(); |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 281 | } |
| 282 | |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 283 | /** |
| 284 | * Logs if the action was taken on a smart selection. |
| 285 | */ |
| 286 | public void onSelectionAction(String logTag) { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 287 | if (mMultiSelection) { |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 288 | mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_ACTION); |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 289 | } else if (mClassifierSelection) { |
| 290 | mClassifier.logEvent(logTag, LOG_EVENT_SINGLE_SELECTION_ACTION); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 291 | } |
| 292 | } |
| 293 | |
| 294 | /** |
| 295 | * Returns true if the current smart selection should be reset to normal selection based on |
| 296 | * information that has been recorded about the original selection and the smart selection. |
| 297 | * The expected UX here is to allow the user to select a word inside of the smart selection |
| 298 | * on a single tap. |
| 299 | */ |
| 300 | public boolean resetSelection(int textIndex, Editor editor, String logTag) { |
Abodunrinwa Toki | 8dd3a74 | 2017-05-02 18:44:19 +0100 | [diff] [blame] | 301 | final CharSequence text = editor.getTextView().getText(); |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 302 | if (mMultiSelection |
Abodunrinwa Toki | 8dd3a74 | 2017-05-02 18:44:19 +0100 | [diff] [blame] | 303 | && textIndex >= mSelectionStart && textIndex <= mSelectionEnd |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 304 | && text instanceof Spannable) { |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 305 | // Only allow a reset once. |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 306 | resetSelectionFlags(); |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 307 | mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_RESET); |
Abodunrinwa Toki | 8dd3a74 | 2017-05-02 18:44:19 +0100 | [diff] [blame] | 308 | return editor.selectCurrentWord(); |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 309 | } |
| 310 | return false; |
| 311 | } |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 312 | |
| 313 | private void resetSelectionFlags() { |
| 314 | mMultiSelection = false; |
| 315 | mClassifierSelection = false; |
| 316 | } |
Abodunrinwa Toki | 89ba5fb | 2017-02-23 02:52:05 +0000 | [diff] [blame] | 317 | } |
| 318 | |
| 319 | /** |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 320 | * AsyncTask for running a query on a background thread and returning the result on the |
| 321 | * UiThread. The AsyncTask times out after a specified time, returning a null result if the |
| 322 | * query has not yet returned. |
| 323 | */ |
| 324 | private static final class TextClassificationAsyncTask |
| 325 | extends AsyncTask<Void, Void, SelectionResult> { |
| 326 | |
| 327 | private final int mTimeOutDuration; |
| 328 | private final Supplier<SelectionResult> mSelectionResultSupplier; |
| 329 | private final Consumer<SelectionResult> mSelectionResultCallback; |
| 330 | private final TextView mTextView; |
| 331 | private final String mOriginalText; |
| 332 | |
| 333 | /** |
| 334 | * @param textView the TextView |
| 335 | * @param timeOut time in milliseconds to timeout the query if it has not completed |
| 336 | * @param selectionResultSupplier fetches the selection results. Runs on a background thread |
| 337 | * @param selectionResultCallback receives the selection results. Runs on the UiThread |
| 338 | */ |
| 339 | TextClassificationAsyncTask( |
| 340 | @NonNull TextView textView, int timeOut, |
| 341 | @NonNull Supplier<SelectionResult> selectionResultSupplier, |
| 342 | @NonNull Consumer<SelectionResult> selectionResultCallback) { |
Makoto Onuki | 1488a3a | 2017-05-24 12:25:46 -0700 | [diff] [blame] | 343 | super(textView != null ? textView.getHandler() : null); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 344 | mTextView = Preconditions.checkNotNull(textView); |
| 345 | mTimeOutDuration = timeOut; |
| 346 | mSelectionResultSupplier = Preconditions.checkNotNull(selectionResultSupplier); |
| 347 | mSelectionResultCallback = Preconditions.checkNotNull(selectionResultCallback); |
| 348 | // Make a copy of the original text. |
| 349 | mOriginalText = mTextView.getText().toString(); |
| 350 | } |
| 351 | |
| 352 | @Override |
| 353 | @WorkerThread |
| 354 | protected SelectionResult doInBackground(Void... params) { |
| 355 | final Runnable onTimeOut = this::onTimeOut; |
| 356 | mTextView.postDelayed(onTimeOut, mTimeOutDuration); |
| 357 | final SelectionResult result = mSelectionResultSupplier.get(); |
| 358 | mTextView.removeCallbacks(onTimeOut); |
| 359 | return result; |
| 360 | } |
| 361 | |
| 362 | @Override |
| 363 | @UiThread |
| 364 | protected void onPostExecute(SelectionResult result) { |
| 365 | result = TextUtils.equals(mOriginalText, mTextView.getText()) ? result : null; |
| 366 | mSelectionResultCallback.accept(result); |
| 367 | } |
| 368 | |
| 369 | private void onTimeOut() { |
| 370 | if (getStatus() == Status.RUNNING) { |
| 371 | onPostExecute(null); |
| 372 | } |
| 373 | cancel(true); |
| 374 | } |
| 375 | } |
| 376 | |
| 377 | /** |
| 378 | * Helper class for querying the TextClassifier. |
| 379 | * It trims text so that only text necessary to provide context of the selected text is |
| 380 | * sent to the TextClassifier. |
| 381 | */ |
| 382 | private static final class TextClassificationHelper { |
| 383 | |
Abodunrinwa Toki | d2d1399 | 2017-03-24 21:43:13 +0000 | [diff] [blame] | 384 | private static final int TRIM_DELTA = 120; // characters |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 385 | |
| 386 | private TextClassifier mTextClassifier; |
| 387 | |
| 388 | /** The original TextView text. **/ |
| 389 | private String mText; |
| 390 | /** Start index relative to mText. */ |
| 391 | private int mSelectionStart; |
| 392 | /** End index relative to mText. */ |
| 393 | private int mSelectionEnd; |
Abodunrinwa Toki | 4cfda0b | 2017-02-28 18:56:47 +0000 | [diff] [blame] | 394 | private LocaleList mLocales; |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 395 | /** A tag for the classifier that returned the latest smart selection. */ |
| 396 | private String mSelectionTag = ""; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 397 | |
| 398 | /** Trimmed text starting from mTrimStart in mText. */ |
| 399 | private CharSequence mTrimmedText; |
| 400 | /** Index indicating the start of mTrimmedText in mText. */ |
| 401 | private int mTrimStart; |
| 402 | /** Start index relative to mTrimmedText */ |
| 403 | private int mRelativeStart; |
| 404 | /** End index relative to mTrimmedText */ |
| 405 | private int mRelativeEnd; |
| 406 | |
Abodunrinwa Toki | fdf57ba | 2017-05-02 20:32:23 +0100 | [diff] [blame] | 407 | /** Information about the last classified text to avoid re-running a query. */ |
| 408 | private CharSequence mLastClassificationText; |
| 409 | private int mLastClassificationSelectionStart; |
| 410 | private int mLastClassificationSelectionEnd; |
| 411 | private LocaleList mLastClassificationLocales; |
| 412 | private SelectionResult mLastClassificationResult; |
| 413 | |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 414 | TextClassificationHelper(TextClassifier textClassifier, |
Abodunrinwa Toki | 4cfda0b | 2017-02-28 18:56:47 +0000 | [diff] [blame] | 415 | CharSequence text, int selectionStart, int selectionEnd, LocaleList locales) { |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 416 | reset(textClassifier, text, selectionStart, selectionEnd, true, locales); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 417 | } |
| 418 | |
| 419 | @UiThread |
| 420 | public void reset(TextClassifier textClassifier, |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 421 | CharSequence text, int selectionStart, int selectionEnd, |
| 422 | boolean resetSelectionTag, LocaleList locales) { |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 423 | mTextClassifier = Preconditions.checkNotNull(textClassifier); |
| 424 | mText = Preconditions.checkNotNull(text).toString(); |
Abodunrinwa Toki | 08925e6 | 2017-05-12 13:48:50 +0100 | [diff] [blame] | 425 | mLastClassificationText = null; // invalidate. |
Abodunrinwa Toki | 792d820 | 2017-03-06 23:51:11 +0000 | [diff] [blame] | 426 | Preconditions.checkArgument(selectionEnd > selectionStart); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 427 | mSelectionStart = selectionStart; |
| 428 | mSelectionEnd = selectionEnd; |
Abodunrinwa Toki | 4cfda0b | 2017-02-28 18:56:47 +0000 | [diff] [blame] | 429 | mLocales = locales; |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 430 | if (resetSelectionTag) { |
| 431 | mSelectionTag = ""; |
| 432 | } |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 433 | } |
| 434 | |
| 435 | @WorkerThread |
| 436 | public SelectionResult classifyText() { |
Abodunrinwa Toki | fdf57ba | 2017-05-02 20:32:23 +0100 | [diff] [blame] | 437 | if (!Objects.equals(mText, mLastClassificationText) |
| 438 | || mSelectionStart != mLastClassificationSelectionStart |
| 439 | || mSelectionEnd != mLastClassificationSelectionEnd |
| 440 | || !Objects.equals(mLocales, mLastClassificationLocales)) { |
| 441 | |
| 442 | mLastClassificationText = mText; |
| 443 | mLastClassificationSelectionStart = mSelectionStart; |
| 444 | mLastClassificationSelectionEnd = mSelectionEnd; |
| 445 | mLastClassificationLocales = mLocales; |
| 446 | |
| 447 | trimText(); |
| 448 | mLastClassificationResult = new SelectionResult( |
| 449 | mSelectionStart, |
| 450 | mSelectionEnd, |
| 451 | mTextClassifier.classifyText( |
| 452 | mTrimmedText, mRelativeStart, mRelativeEnd, mLocales)); |
| 453 | |
| 454 | } |
| 455 | return mLastClassificationResult; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 456 | } |
| 457 | |
| 458 | @WorkerThread |
| 459 | public SelectionResult suggestSelection() { |
| 460 | trimText(); |
| 461 | final TextSelection sel = mTextClassifier.suggestSelection( |
Abodunrinwa Toki | 4cfda0b | 2017-02-28 18:56:47 +0000 | [diff] [blame] | 462 | mTrimmedText, mRelativeStart, mRelativeEnd, mLocales); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 463 | mSelectionStart = Math.max(0, sel.getSelectionStartIndex() + mTrimStart); |
| 464 | mSelectionEnd = Math.min(mText.length(), sel.getSelectionEndIndex() + mTrimStart); |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 465 | mSelectionTag = sel.getSourceClassifier(); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 466 | return classifyText(); |
| 467 | } |
| 468 | |
Abodunrinwa Toki | e78ac52 | 2017-05-23 14:51:22 +0100 | [diff] [blame] | 469 | String getSelectionTag() { |
| 470 | return mSelectionTag; |
Abodunrinwa Toki | 1d77557 | 2017-05-08 16:03:01 +0100 | [diff] [blame] | 471 | } |
| 472 | |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 473 | private void trimText() { |
| 474 | mTrimStart = Math.max(0, mSelectionStart - TRIM_DELTA); |
| 475 | final int referenceEnd = Math.min(mText.length(), mSelectionEnd + TRIM_DELTA); |
| 476 | mTrimmedText = mText.subSequence(mTrimStart, referenceEnd); |
| 477 | mRelativeStart = mSelectionStart - mTrimStart; |
| 478 | mRelativeEnd = mSelectionEnd - mTrimStart; |
| 479 | } |
| 480 | } |
| 481 | |
| 482 | /** |
| 483 | * Selection result. |
| 484 | */ |
| 485 | private static final class SelectionResult { |
| 486 | private final int mStart; |
| 487 | private final int mEnd; |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 488 | private final TextClassification mClassification; |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 489 | |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 490 | SelectionResult(int start, int end, TextClassification classification) { |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 491 | mStart = start; |
| 492 | mEnd = end; |
Abodunrinwa Toki | e0b5789 | 2017-04-28 19:59:57 +0100 | [diff] [blame] | 493 | mClassification = Preconditions.checkNotNull(classification); |
Abodunrinwa Toki | 8710ea1 | 2017-01-24 10:34:13 -0800 | [diff] [blame] | 494 | } |
| 495 | } |
| 496 | } |