Refactors find/replace overlay to restore cursor position when search

input is cleared in incremental mode

Author: deepika-u

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

@@ -324,6 +324,9 @@ public boolean performSearch() {
 	private boolean performSearch(boolean updateFromIncrementalBaseLocation) {
 		resetStatus();
 		if (findString.isEmpty()) {
+			if (isAvailableAndActive(SearchOptions.INCREMENTAL)) {
+				restoreSelectionIfEmpty();
+			}
 			return false;
 		}
 
@@ -338,6 +341,19 @@ private boolean performSearch(boolean updateFromIncrementalBaseLocation) {
 		return somethingFound;
 	}
 
+	/**
+	 * Restores the original caret/selection position when the search field becomes
+	 * empty.
+	 */
+	private void restoreSelectionIfEmpty() {
+		if (incrementalBaseLocation == null) {
+			return;
+		}
+		if (target instanceof IFindReplaceTargetExtension extension) {
+			extension.setSelection(incrementalBaseLocation.x, incrementalBaseLocation.y);
+		}
+	}
+
 	/**
 	 * Replaces all occurrences of the user's findString with the replace string.
 	 * Returns the number of replacements that occur.

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

@@ -833,6 +833,53 @@ public void testResetIncrementalBaseLocation() {
 		findReplaceLogic.resetIncrementalBaseLocation();
 		findReplaceLogic.performSearch();
 		assertThat(textViewer.getSelectedRange(), is(new Point(5, 4)));
+		textViewer.setSelectedRange(7, 0);
+		findReplaceLogic.resetIncrementalBaseLocation();
+		findReplaceLogic.performSearch();
+		assertThat(textViewer.getSelectedRange(), is(new Point(10, 4)));
+		textViewer.setSelectedRange(10, 0);
+		findReplaceLogic.resetIncrementalBaseLocation();
+		findReplaceLogic.performSearch();
+		assertThat(textViewer.getSelectedRange(), is(new Point(10, 4)));
+		// Verify that after clearing the search, caret goes back to last active location
+		findReplaceLogic.setFindString("");
+		findReplaceLogic.performSearch();
+		assertThat(textViewer.getSelectedRange(), is(new Point(10, 4)));
+	}
+
+	@Test
+	public void testRestoreSelectionOnEmptyFindStringInIncrementalMode() {
+		String setupString= "test\ntest\ntest";
+		TextViewer textViewer= setupTextViewer(setupString);
+		textViewer.setSelectedRange(5, 0); // Set initial selection
+		IFindReplaceLogic findReplaceLogic= setupFindReplaceLogicObject(textViewer);
+		findReplaceLogic.activate(SearchOptions.FORWARD);
+		findReplaceLogic.activate(SearchOptions.WRAP);
+		findReplaceLogic.activate(SearchOptions.INCREMENTAL);
+
+		findReplaceLogic.resetIncrementalBaseLocation(); // Set base location
+		findReplaceLogic.setFindString("test");
+		assertThat(textViewer.getSelectedRange(), is(new Point(5, 4)));
+		findReplaceLogic.setFindString(""); // Clear the find string
+		assertThat(textViewer.getSelectedRange(), is(new Point(5, 0))); // Restored to base location
+	}
+
+	@Test
+	public void testNoRestoreOnEmptyFindStringWhenNotIncremental() {
+		String setupString= "test\ntest\ntest";
+		TextViewer textViewer= setupTextViewer(setupString);
+		textViewer.setSelectedRange(5, 0); // Set initial selection
+		IFindReplaceLogic findReplaceLogic= setupFindReplaceLogicObject(textViewer);
+		findReplaceLogic.activate(SearchOptions.FORWARD);
+		findReplaceLogic.activate(SearchOptions.WRAP);
+		// Do NOT activate incremental mode
+
+		findReplaceLogic.resetIncrementalBaseLocation();
+		findReplaceLogic.setFindString("test");
+		assertThat(textViewer.getSelectedRange(), is(new Point(5, 0)));
+		findReplaceLogic.setFindString(""); // Clear the find string
+		// Will not restore selection since incremental mode is not active
+		assertThat(textViewer.getSelectedRange(), is(new Point(5, 0))); // Remains unchanged
 	}
 
 	@Test
@@ -866,8 +913,8 @@ public void testSetFindString_incrementalActive() {
 		findReplaceLogic.setFindString("Te");
 		assertEquals(new Point(0, 2), findReplaceLogic.getTarget().getSelection());
 
-		findReplaceLogic.setFindString(""); // this clears the incremental search, but the "old search" still remains active
-		assertEquals(new Point(0, 2), findReplaceLogic.getTarget().getSelection());
+		findReplaceLogic.setFindString(""); // clears the incremental search input, restoring the caret to the base location
+		assertEquals(new Point(0, 0), findReplaceLogic.getTarget().getSelection());
 	}
 
 	@Test