Find/replace: unify search options availability and activity retrieval

The FindReplaceLogic provides different methods for retrieving the
active/available state of different search options. This change unifies
the state retrieval by providing an isAvailable() and
isAvailableAndActive() method accepting a search option instance, such
that the information can be retrieved for any search option of interest
in a unform way.

Author: HeikoKlare

bundles/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/findandreplace/FindReplaceLogic.java

@@ -61,7 +61,7 @@ public class FindReplaceLogic implements IFindReplaceLogic {
 	@Override
 	public void setFindString(String findString) {
 		this.findString = Objects.requireNonNull(findString);
-		if (isIncrementalSearchAvailable() && isActive(SearchOptions.INCREMENTAL)) {
+		if (isAvailableAndActive(SearchOptions.INCREMENTAL)) {
 			performSearch(true);
 		}
 	}
@@ -130,14 +130,28 @@ private void resetStatus() {
 	}
 
 	@Override
-	public boolean isIncrementalSearchAvailable() {
-		return !isRegExSearchAvailableAndActive();
+	public boolean isAvailable(SearchOptions searchOption) {
+		switch (searchOption) {
+		case INCREMENTAL:
+			return !isAvailableAndActive(SearchOptions.REGEX);
+		case REGEX:
+			return isTargetSupportingRegEx;
+		case WHOLE_WORD:
+			return !isAvailableAndActive(SearchOptions.REGEX) && isWord(findString);
+		case CASE_SENSITIVE:
+		case FORWARD:
+		case GLOBAL:
+		case WRAP:
+		default:
+			return true;
+		}
 	}
 
 	@Override
-	public boolean isWholeWordSearchAvailable() {
-		return !isRegExSearchAvailableAndActive() && isWord(findString);
+	public boolean isAvailableAndActive(SearchOptions searchOption) {
+		return isAvailable(searchOption) && isActive(searchOption);
 	}
+
 	/**
 	 * Tests whether each character in the given string is a letter.
 	 *
@@ -148,11 +162,6 @@ private static boolean isWord(String str) {
 		return str != null && str.chars().allMatch(Character::isJavaIdentifierPart);
 	}
 
-	@Override
-	public boolean isRegExSearchAvailableAndActive() {
-		return isActive(SearchOptions.REGEX) && isTargetSupportingRegEx;
-	}
-
 	@Override
 	public void resetIncrementalBaseLocation() {
 		if (target != null && shouldInitIncrementalBaseLocation()) {
@@ -185,7 +194,8 @@ private void initializeSearchScope() {
 		Point lineSelection = extensionTarget.getLineSelection();
 		scope = new Region(lineSelection.x, lineSelection.y);
 
-		int offset = isActive(SearchOptions.FORWARD) ? scope.getOffset() : scope.getOffset() + scope.getLength();
+		int offset = isAvailableAndActive(SearchOptions.FORWARD) ? scope.getOffset()
+				: scope.getOffset() + scope.getLength();
 
 		extensionTarget.setSelection(offset, 0);
 		extensionTarget.setScope(scope);
@@ -318,7 +328,7 @@ public boolean performSearch() {
 	private boolean performSearch(boolean validateSearchOptions) {
 		resetStatus();
 
-		if (validateSearchOptions && (isActive(SearchOptions.INCREMENTAL) && !isIncrementalSearchAvailable())) {
+		if (validateSearchOptions && !isAvailable(SearchOptions.INCREMENTAL) && isActive(SearchOptions.INCREMENTAL)) {
 			return false; // Do nothing if search options are not compatible
 		}
 		boolean somethingFound = false;
@@ -417,7 +427,7 @@ private int selectAll() {
 	 */
 	private int findIndex(int startPosition) {
 		int index = 0;
-		if (isActive(SearchOptions.FORWARD)) {
+		if (isAvailableAndActive(SearchOptions.FORWARD)) {
 			index = findAndSelect(startPosition);
 		} else {
 			index = startPosition == 0 ? -1
@@ -426,7 +436,7 @@ private int findIndex(int startPosition) {
 
 		if (index == -1) {
 
-			if (isActive(SearchOptions.WRAP)) {
+			if (isAvailableAndActive(SearchOptions.WRAP)) {
 				statusLineMessage(FindReplaceMessages.FindReplace_Status_wrapped_label);
 				status = new FindStatus(FindStatus.StatusCode.WRAPPED);
 				index = findAndSelect(-1);
@@ -439,10 +449,10 @@ private int findIndex(int startPosition) {
 
 	@Override
 	public int findAndSelect(int offset) {
-		boolean wholeWordSearch = isActive(SearchOptions.WHOLE_WORD) && isWholeWordSearchAvailable();
-		boolean forwardSearch = isActive(SearchOptions.FORWARD);
-		boolean caseSensitiveSearch = isActive(SearchOptions.CASE_SENSITIVE);
-		boolean regexSearch = isActive(SearchOptions.REGEX);
+		boolean wholeWordSearch = isAvailableAndActive(SearchOptions.WHOLE_WORD);
+		boolean forwardSearch = isAvailableAndActive(SearchOptions.FORWARD);
+		boolean caseSensitiveSearch = isAvailableAndActive(SearchOptions.CASE_SENSITIVE);
+		boolean regexSearch = isAvailableAndActive(SearchOptions.REGEX);
 
 		if (target instanceof IFindReplaceTargetExtension3 regexSupportingTarget) {
 			return (regexSupportingTarget).findAndSelect(offset, findString,
@@ -464,7 +474,8 @@ public int findAndSelect(int offset) {
 	 */
 	private Point replaceSelection() {
 		if (target instanceof IFindReplaceTargetExtension3)
-			((IFindReplaceTargetExtension3) target).replaceSelection(replaceString, isRegExSearchAvailableAndActive());
+			((IFindReplaceTargetExtension3) target).replaceSelection(replaceString,
+					isAvailableAndActive(SearchOptions.REGEX));
 		else
 			target.replaceSelection(replaceString);
 
@@ -553,9 +564,9 @@ public boolean performSelectAndReplace() {
 
 	private boolean isFindStringSelected() {
 		String selectedString = getCurrentSelection();
-		if (isRegExSearchAvailableAndActive()) {
+		if (isAvailableAndActive(SearchOptions.REGEX)) {
 			int patternFlags = 0;
-			if (!isActive(SearchOptions.CASE_SENSITIVE)) {
+			if (!isAvailableAndActive(SearchOptions.CASE_SENSITIVE)) {
 				patternFlags |= Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CASE;
 			}
 			Pattern pattern = Pattern.compile(findString, patternFlags);

bundles/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/findandreplace/IFindReplaceLogic.java

@@ -60,29 +60,37 @@ public interface IFindReplaceLogic {
 	public boolean isActive(SearchOptions searchOption);
 
 	/**
-	 * Returns the current status of FindReplaceLogic. The Status can inform about
-	 * events such as an error happening, a warning happening (e.g.: the
-	 * search-string wasn't found) and brings a method to retrieve a message that
-	 * can directly be displayed to the user.
+	 * Returns whether the given search options is currently available. This
+	 * includes validation of whether the target supports a specific option (such as
+	 * {@link SearchOptions#REGEX}) and the compatibility of search options (such as
+	 * {@link SearchOptions#INCREMENTAL} not being available when
+	 * {@link SearchOptions#REGEX} is active).
 	 *
-	 * @return FindAndReplaceMessageStatus
+	 * @param searchOption the search option to check for availability
+	 *
+	 * @return whether the search option is currently available
 	 */
-	public IFindReplaceStatus getStatus();
+	public boolean isAvailable(SearchOptions searchOption);
 
 	/**
-	 * RegEx-Search is not possible on every target. Hence, even after {code
-	 * activate(SearchOptions.REGEX)}, we need to check, whether we may use
-	 * RegEx-Search.
+	 * Returns whether the given search options is currently available and active.
+	 * Combines {@link #isActive(SearchOptions)} and
+	 * {@link #isAvailable(SearchOptions)}.
 	 *
-	 * @return whether RegEx search is currently used
+	 * @param searchOption the search option to check
+	 * @return whether the search option is currently available and active
 	 */
-	public boolean isRegExSearchAvailableAndActive();
+	public boolean isAvailableAndActive(SearchOptions searchOption);
 
 	/**
-	 * {@return whether incremental search may be performed by the
-	 * find/replace-logic based on the currently active options}
+	 * Returns the current status of FindReplaceLogic. The Status can inform about
+	 * events such as an error happening, a warning happening (e.g.: the
+	 * search-string wasn't found) and brings a method to retrieve a message that
+	 * can directly be displayed to the user.
+	 *
+	 * @return FindAndReplaceMessageStatus
 	 */
-	public boolean isIncrementalSearchAvailable();
+	public IFindReplaceStatus getStatus();
 
 	/**
 	 * Replaces all occurrences of the current find string with the replace string.
@@ -156,15 +164,6 @@ public interface IFindReplaceLogic {
 	 */
 	public IFindReplaceTarget getTarget();
 
-	/**
-	 * Returns <code>true</code> if searching can be restricted to entire words,
-	 * <code>false</code> if not. Searching for whole words requires the given find
-	 * string to be an entire word and the regex search option to be disabled.
-	 *
-	 * @return <code>true</code> if the search can be restricted to whole words
-	 */
-	public boolean isWholeWordSearchAvailable();
-
 	/**
 	 * Initializes the anchor used as the starting point for incremental searching.
 	 * Subsequent incremental searches will start from the first letter of the

bundles/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/internal/findandreplace/overlay/FindReplaceOverlay.java

@@ -556,7 +556,7 @@ private void createRegexSearchButton() {
 				.withToolTipText(FindReplaceMessages.FindReplaceOverlay_regexSearchButton_toolTip)
 				.withOperation(() -> {
 					activateInFindReplacerIf(SearchOptions.REGEX, regexSearchButton.getSelection());
-					wholeWordSearchButton.setEnabled(findReplaceLogic.isWholeWordSearchAvailable());
+					wholeWordSearchButton.setEnabled(findReplaceLogic.isAvailable(SearchOptions.WHOLE_WORD));
 					updateIncrementalSearch();
 					updateContentAssistAvailability();
 				}).withShortcuts(KeyboardShortcuts.OPTION_REGEX).build();
@@ -632,7 +632,7 @@ private void createSearchBar() {
 		searchBar.forceFocus();
 		searchBar.selectAll();
 		searchBar.addModifyListener(e -> {
-			wholeWordSearchButton.setEnabled(findReplaceLogic.isWholeWordSearchAvailable());
+			wholeWordSearchButton.setEnabled(findReplaceLogic.isAvailable(SearchOptions.WHOLE_WORD));
 
 			showUserFeedback(normalTextForegroundColor, true);
 			findReplaceLogic.setFindString(searchBar.getText());
@@ -978,7 +978,7 @@ private void updateFromTargetSelection() {
 			findReplaceLogic.deactivate(SearchOptions.GLOBAL);
 			searchInSelectionButton.setSelection(true);
 		} else if (!selectionText.isEmpty()) {
-			if (findReplaceLogic.isRegExSearchAvailableAndActive()) {
+			if (findReplaceLogic.isAvailable(SearchOptions.REGEX)) {
 				selectionText = FindReplaceDocumentAdapter.escapeForRegExPattern(selectionText);
 			}
 			searchBar.setText(selectionText);
@@ -1038,6 +1038,6 @@ private void setContentAssistsEnablement(boolean enable) {
 	}
 
 	private void updateContentAssistAvailability() {
-		setContentAssistsEnablement(findReplaceLogic.isRegExSearchAvailableAndActive());
+		setContentAssistsEnablement(findReplaceLogic.isAvailableAndActive(SearchOptions.REGEX));
 	}
 }

bundles/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/FindReplaceDialog.java

@@ -755,18 +755,18 @@ public void widgetSelected(SelectionEvent e) {
 				storeSettings();
 				updateButtonState();
 				setContentAssistsEnablement(newState);
-				fIncrementalCheckBox.setEnabled(findReplaceLogic.isIncrementalSearchAvailable());
+				fIncrementalCheckBox.setEnabled(findReplaceLogic.isAvailable(SearchOptions.INCREMENTAL));
 			}
 		});
 		storeButtonWithMnemonicInMap(fIsRegExCheckBox);
-		fWholeWordCheckBox.setEnabled(findReplaceLogic.isWholeWordSearchAvailable());
+		fWholeWordCheckBox.setEnabled(findReplaceLogic.isAvailable(SearchOptions.WHOLE_WORD));
 		fWholeWordCheckBox.addSelectionListener(new SelectionAdapter() {
 			@Override
 			public void widgetSelected(SelectionEvent e) {
 				updateButtonState();
 			}
 		});
-		fIncrementalCheckBox.setEnabled(findReplaceLogic.isIncrementalSearchAvailable());
+		fIncrementalCheckBox.setEnabled(findReplaceLogic.isAvailable(SearchOptions.INCREMENTAL));
 		return panel;
 	}
 
@@ -957,7 +957,7 @@ private void initFindStringFromSelection() {
 		String selection = getCurrentSelection();
 		String searchInput = getFirstLine(selection);
 		boolean isSingleLineInput = searchInput.equals(selection);
-		if (findReplaceLogic.isRegExSearchAvailableAndActive()) {
+		if (findReplaceLogic.isAvailableAndActive(SearchOptions.REGEX)) {
 			searchInput = FindReplaceDocumentAdapter.escapeForRegExPattern(selection);
 		}
 		fFindField.setText(searchInput);
@@ -1088,11 +1088,11 @@ private void updateButtonState(boolean disableReplace) {
 			boolean isFindStringSet = str != null && !str.isEmpty();
 			String selectionString = enable ? target.getSelection().toString() : ""; //$NON-NLS-1$
 			boolean isTargetEditable = enable ? target.isEditable() : false;
-			boolean isRegExSearchAvailableAndActive = findReplaceLogic.isRegExSearchAvailableAndActive();
+			boolean isRegExSearchAvailableAndActive = findReplaceLogic.isAvailableAndActive(SearchOptions.REGEX);
 			boolean isSelectionGoodForReplace = selectionString != "" //$NON-NLS-1$
 					|| !isRegExSearchAvailableAndActive;
 
-			fWholeWordCheckBox.setEnabled(findReplaceLogic.isWholeWordSearchAvailable());
+			fWholeWordCheckBox.setEnabled(findReplaceLogic.isAvailable(SearchOptions.WHOLE_WORD));
 			fFindNextButton.setEnabled(enable && isFindStringSet);
 			fSelectAllButton.setEnabled(enable && isFindStringSet && (target instanceof IFindReplaceTargetExtension4));
 			fReplaceSelectionButton.setEnabled(
@@ -1203,11 +1203,11 @@ public void updateTarget(IFindReplaceTarget target, boolean isTargetEditable, bo
 		}
 
 		if (okToUse(fWholeWordCheckBox)) {
-			fWholeWordCheckBox.setEnabled(findReplaceLogic.isWholeWordSearchAvailable());
+			fWholeWordCheckBox.setEnabled(findReplaceLogic.isAvailable(SearchOptions.WHOLE_WORD));
 		}
 
 		if (okToUse(fIncrementalCheckBox)) {
-			fIncrementalCheckBox.setEnabled(findReplaceLogic.isIncrementalSearchAvailable());
+			fIncrementalCheckBox.setEnabled(findReplaceLogic.isAvailable(SearchOptions.INCREMENTAL));
 		}
 
 		if (okToUse(fReplaceLabel)) {
@@ -1222,7 +1222,7 @@ public void updateTarget(IFindReplaceTarget target, boolean isTargetEditable, bo
 
 		updateButtonState();
 
-		setContentAssistsEnablement(findReplaceLogic.isRegExSearchAvailableAndActive());
+		setContentAssistsEnablement(findReplaceLogic.isAvailableAndActive(SearchOptions.REGEX));
 	}
 
 	/**

tests/org.eclipse.ui.workbench.texteditor.tests/src/org/eclipse/ui/internal/findandreplace/FindReplaceLogicTest.java

@@ -630,7 +630,7 @@ public void testWholeWordSearchAvailable() {
 
 		Predicate<String> isConsideredWholeWord= string -> {
 			findReplaceLogic.setFindString(string);
-			return findReplaceLogic.isWholeWordSearchAvailable();
+			return findReplaceLogic.isAvailable(SearchOptions.WHOLE_WORD);
 		};
 
 		assertTrue(isConsideredWholeWord.test("oneword"));

tests/org.eclipse.ui.workbench.texteditor.tests/src/org/eclipse/ui/internal/findandreplace/overlay/OverlayAccess.java

@@ -286,7 +286,7 @@ public void assertInitialConfiguration() {
 		assertEnabled(SearchOptions.GLOBAL);
 		assertEnabled(SearchOptions.REGEX);
 		assertEnabled(SearchOptions.CASE_SENSITIVE);
-		if (getFindText().equals("") || findReplaceLogic.isWholeWordSearchAvailable()) {
+		if (getFindText().equals("") || findReplaceLogic.isAvailable(SearchOptions.WHOLE_WORD)) {
 			assertEnabled(SearchOptions.WHOLE_WORD);
 		} else {
 			assertDisabled(SearchOptions.WHOLE_WORD);