Merge "TRON: Smart selection events that don't change the selection." into oc-dev (afea5e8c) · Commits · e / os / android_frameworks_base

core/java/android/widget/SelectionActionModeHelper.java

+49 −25

Original line number	Original line	Diff line number	Diff line
	@@ -73,7 +73,7 @@ final class SelectionActionModeHelper {
	// Do not call the TextClassifier if there is no selection.		// Do not call the TextClassifier if there is no selection.
	startActionMode(null);		startActionMode(null);
	} else {		} else {
	resetTextClassificationHelper();		resetTextClassificationHelper(true /* resetSelectionTag */);
	mTextClassificationAsyncTask = new TextClassificationAsyncTask(		mTextClassificationAsyncTask = new TextClassificationAsyncTask(
	mEditor.getTextView(),		mEditor.getTextView(),
	TIMEOUT_DURATION,		TIMEOUT_DURATION,
	@@ -92,7 +92,7 @@ final class SelectionActionModeHelper {
	// Do not call the TextClassifier if there is no selection.		// Do not call the TextClassifier if there is no selection.
	invalidateActionMode(null);		invalidateActionMode(null);
	} else {		} else {
	resetTextClassificationHelper();		resetTextClassificationHelper(false /* resetSelectionTag */);
	mTextClassificationAsyncTask = new TextClassificationAsyncTask(		mTextClassificationAsyncTask = new TextClassificationAsyncTask(
	mEditor.getTextView(), TIMEOUT_DURATION,		mEditor.getTextView(), TIMEOUT_DURATION,
	mTextClassificationHelper::classifyText, this::invalidateActionMode)		mTextClassificationHelper::classifyText, this::invalidateActionMode)
	@@ -101,12 +101,12 @@ final class SelectionActionModeHelper {
	}		}

	public void onSelectionAction() {		public void onSelectionAction() {
	mSelectionTracker.onSelectionAction(mTextClassificationHelper.getClassifierTag());		mSelectionTracker.onSelectionAction(mTextClassificationHelper.getSelectionTag());
	}		}

	public boolean resetSelection(int textIndex) {		public boolean resetSelection(int textIndex) {
	if (mSelectionTracker.resetSelection(		if (mSelectionTracker.resetSelection(
	textIndex, mEditor, mTextClassificationHelper.getClassifierTag())) {		textIndex, mEditor, mTextClassificationHelper.getSelectionTag())) {
	invalidateActionModeAsync();		invalidateActionModeAsync();
	return true;		return true;
	}		}
	@@ -158,7 +158,7 @@ final class SelectionActionModeHelper {
	}		}
	if (result != null) {		if (result != null) {
	mSelectionTracker.onSelectionStarted(		mSelectionTracker.onSelectionStarted(
	result.mStart, result.mEnd, mTextClassificationHelper.getClassifierTag());		result.mStart, result.mEnd, mTextClassificationHelper.getSelectionTag());
	}		}
	}		}
	mEditor.setRestartActionModeOnNextRefresh(false);		mEditor.setRestartActionModeOnNextRefresh(false);
	@@ -174,15 +174,15 @@ final class SelectionActionModeHelper {
	final TextView textView = mEditor.getTextView();		final TextView textView = mEditor.getTextView();
	mSelectionTracker.onSelectionUpdated(		mSelectionTracker.onSelectionUpdated(
	textView.getSelectionStart(), textView.getSelectionEnd(),		textView.getSelectionStart(), textView.getSelectionEnd(),
	mTextClassificationHelper.getClassifierTag());		mTextClassificationHelper.getSelectionTag());
	mTextClassificationAsyncTask = null;		mTextClassificationAsyncTask = null;
	}		}

	private void resetTextClassificationHelper() {		private void resetTextClassificationHelper(boolean resetSelectionTag) {
	final TextView textView = mEditor.getTextView();		final TextView textView = mEditor.getTextView();
	mTextClassificationHelper.reset(textView.getTextClassifier(), textView.getText(),		mTextClassificationHelper.reset(textView.getTextClassifier(), textView.getText(),
	textView.getSelectionStart(), textView.getSelectionEnd(),		textView.getSelectionStart(), textView.getSelectionEnd(),
	textView.getTextLocales());		resetSelectionTag, textView.getTextLocales());
	}		}

	/**		/**
	@@ -195,10 +195,14 @@ final class SelectionActionModeHelper {
	// Log event: Smart selection happened.		// Log event: Smart selection happened.
	private static final String LOG_EVENT_MULTI_SELECTION =		private static final String LOG_EVENT_MULTI_SELECTION =
	"textClassifier_multiSelection";		"textClassifier_multiSelection";
			private static final String LOG_EVENT_SINGLE_SELECTION =
			"textClassifier_singleSelection";

	// Log event: Smart selection acted upon.		// Log event: Smart selection acted upon.
	private static final String LOG_EVENT_MULTI_SELECTION_ACTION =		private static final String LOG_EVENT_MULTI_SELECTION_ACTION =
	"textClassifier_multiSelection_action";		"textClassifier_multiSelection_action";
			private static final String LOG_EVENT_SINGLE_SELECTION_ACTION =
			"textClassifier_singleSelection_action";

	// Log event: Smart selection was reset to original selection.		// Log event: Smart selection was reset to original selection.
	private static final String LOG_EVENT_MULTI_SELECTION_RESET =		private static final String LOG_EVENT_MULTI_SELECTION_RESET =
	@@ -207,6 +211,8 @@ final class SelectionActionModeHelper {
	// Log event: Smart selection was user modified.		// Log event: Smart selection was user modified.
	private static final String LOG_EVENT_MULTI_SELECTION_MODIFIED =		private static final String LOG_EVENT_MULTI_SELECTION_MODIFIED =
	"textClassifier_multiSelection_modified";		"textClassifier_multiSelection_modified";
			private static final String LOG_EVENT_SINGLE_SELECTION_MODIFIED =
			"textClassifier_singleSelection_modified";

	private final TextClassifier mClassifier;		private final TextClassifier mClassifier;

	@@ -215,7 +221,8 @@ final class SelectionActionModeHelper {
	private int mSelectionStart;		private int mSelectionStart;
	private int mSelectionEnd;		private int mSelectionEnd;

	private boolean mSmartSelectionActive;		private boolean mMultiSelection;
			private boolean mClassifierSelection;

	SelectionTracker(TextClassifier classifier) {		SelectionTracker(TextClassifier classifier) {
	mClassifier = classifier;		mClassifier = classifier;
	@@ -227,23 +234,26 @@ final class SelectionActionModeHelper {
	public void setOriginalSelection(int selectionStart, int selectionEnd) {		public void setOriginalSelection(int selectionStart, int selectionEnd) {
	mOriginalStart = selectionStart;		mOriginalStart = selectionStart;
	mOriginalEnd = selectionEnd;		mOriginalEnd = selectionEnd;
	mSmartSelectionActive = false;		resetSelectionFlags();
	}		}

	/**		/**
	* Called when selection action mode is started.		* Called when selection action mode is started and the results come from a classifier.
	* If the selection indices are different from the original selection indices, we have a		* If the selection indices are different from the original selection indices, we have a
	* smart selection.		* smart selection.
	*/		*/
	public void onSelectionStarted(int selectionStart, int selectionEnd, String logTag) {		public void onSelectionStarted(int selectionStart, int selectionEnd, String logTag) {
			mClassifierSelection = !logTag.isEmpty();
	mSelectionStart = selectionStart;		mSelectionStart = selectionStart;
	mSelectionEnd = selectionEnd;		mSelectionEnd = selectionEnd;
	// If the started selection is different from the original selection, we have a		// If the started selection is different from the original selection, we have a
	// smart selection.		// smart selection.
	mSmartSelectionActive =		mMultiSelection =
	mSelectionStart != mOriginalStart \|\| mSelectionEnd != mOriginalEnd;		mSelectionStart != mOriginalStart \|\| mSelectionEnd != mOriginalEnd;
	if (mSmartSelectionActive) {		if (mMultiSelection) {
	mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION);		mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION);
			} else if (mClassifierSelection) {
			mClassifier.logEvent(logTag, LOG_EVENT_SINGLE_SELECTION);
	}		}
	}		}

	@@ -254,10 +264,12 @@ final class SelectionActionModeHelper {
	final boolean selectionChanged =		final boolean selectionChanged =
	selectionStart != mSelectionStart \|\| selectionEnd != mSelectionEnd;		selectionStart != mSelectionStart \|\| selectionEnd != mSelectionEnd;
	if (selectionChanged) {		if (selectionChanged) {
	if (mSmartSelectionActive) {		if (mMultiSelection) {
	mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_MODIFIED);		mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_MODIFIED);
			} else if (mClassifierSelection) {
			mClassifier.logEvent(logTag, LOG_EVENT_SINGLE_SELECTION_MODIFIED);
	}		}
	mSmartSelectionActive = false;		resetSelectionFlags();
	}		}
	}		}

	@@ -265,15 +277,17 @@ final class SelectionActionModeHelper {
	* Called when the selection action mode is destroyed.		* Called when the selection action mode is destroyed.
	*/		*/
	public void onSelectionDestroyed() {		public void onSelectionDestroyed() {
	mSmartSelectionActive = false;		resetSelectionFlags();
	}		}

	/**		/**
	* Logs if the action was taken on a smart selection.		* Logs if the action was taken on a smart selection.
	*/		*/
	public void onSelectionAction(String logTag) {		public void onSelectionAction(String logTag) {
	if (mSmartSelectionActive) {		if (mMultiSelection) {
	mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_ACTION);		mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_ACTION);
			} else if (mClassifierSelection) {
			mClassifier.logEvent(logTag, LOG_EVENT_SINGLE_SELECTION_ACTION);
	}		}
	}		}

	@@ -285,16 +299,21 @@ final class SelectionActionModeHelper {
	*/		*/
	public boolean resetSelection(int textIndex, Editor editor, String logTag) {		public boolean resetSelection(int textIndex, Editor editor, String logTag) {
	final CharSequence text = editor.getTextView().getText();		final CharSequence text = editor.getTextView().getText();
	if (mSmartSelectionActive		if (mMultiSelection
	&& textIndex >= mSelectionStart && textIndex <= mSelectionEnd		&& textIndex >= mSelectionStart && textIndex <= mSelectionEnd
	&& text instanceof Spannable) {		&& text instanceof Spannable) {
	// Only allow a reset once.		// Only allow a reset once.
	mSmartSelectionActive = false;		resetSelectionFlags();
	mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_RESET);		mClassifier.logEvent(logTag, LOG_EVENT_MULTI_SELECTION_RESET);
	return editor.selectCurrentWord();		return editor.selectCurrentWord();
	}		}
	return false;		return false;
	}		}

			private void resetSelectionFlags() {
			mMultiSelection = false;
			mClassifierSelection = false;
			}
	}		}

	/**		/**
	@@ -372,7 +391,8 @@ final class SelectionActionModeHelper {
	/** End index relative to mText. */		/** End index relative to mText. */
	private int mSelectionEnd;		private int mSelectionEnd;
	private LocaleList mLocales;		private LocaleList mLocales;
	private String mClassifierTag = "";		/** A tag for the classifier that returned the latest smart selection. */
			private String mSelectionTag = "";

	/** Trimmed text starting from mTrimStart in mText. */		/** Trimmed text starting from mTrimStart in mText. */
	private CharSequence mTrimmedText;		private CharSequence mTrimmedText;
	@@ -392,12 +412,13 @@ final class SelectionActionModeHelper {

	TextClassificationHelper(TextClassifier textClassifier,		TextClassificationHelper(TextClassifier textClassifier,
	CharSequence text, int selectionStart, int selectionEnd, LocaleList locales) {		CharSequence text, int selectionStart, int selectionEnd, LocaleList locales) {
	reset(textClassifier, text, selectionStart, selectionEnd, locales);		reset(textClassifier, text, selectionStart, selectionEnd, true, locales);
	}		}

	@UiThread		@UiThread
	public void reset(TextClassifier textClassifier,		public void reset(TextClassifier textClassifier,
	CharSequence text, int selectionStart, int selectionEnd, LocaleList locales) {		CharSequence text, int selectionStart, int selectionEnd,
			boolean resetSelectionTag, LocaleList locales) {
	mTextClassifier = Preconditions.checkNotNull(textClassifier);		mTextClassifier = Preconditions.checkNotNull(textClassifier);
	mText = Preconditions.checkNotNull(text).toString();		mText = Preconditions.checkNotNull(text).toString();
	mLastClassificationText = null; // invalidate.		mLastClassificationText = null; // invalidate.
	@@ -405,6 +426,9 @@ final class SelectionActionModeHelper {
	mSelectionStart = selectionStart;		mSelectionStart = selectionStart;
	mSelectionEnd = selectionEnd;		mSelectionEnd = selectionEnd;
	mLocales = locales;		mLocales = locales;
			if (resetSelectionTag) {
			mSelectionTag = "";
			}
	}		}

	@WorkerThread		@WorkerThread
	@@ -437,12 +461,12 @@ final class SelectionActionModeHelper {
	mTrimmedText, mRelativeStart, mRelativeEnd, mLocales);		mTrimmedText, mRelativeStart, mRelativeEnd, mLocales);
	mSelectionStart = Math.max(0, sel.getSelectionStartIndex() + mTrimStart);		mSelectionStart = Math.max(0, sel.getSelectionStartIndex() + mTrimStart);
	mSelectionEnd = Math.min(mText.length(), sel.getSelectionEndIndex() + mTrimStart);		mSelectionEnd = Math.min(mText.length(), sel.getSelectionEndIndex() + mTrimStart);
	mClassifierTag = sel.getSourceClassifier();		mSelectionTag = sel.getSourceClassifier();
	return classifyText();		return classifyText();
	}		}

	String getClassifierTag() {		String getSelectionTag() {
	return mClassifierTag;		return mSelectionTag;
	}		}

	private void trimText() {		private void trimText() {