File Search should offer to search in all opened editors

iloveeclipse · iloveeclipse · commit befcf9238c80 · 2023-09-19T11:21:12.000+02:00
Adds "Files opened in editors" scope to the "Text" search. Fixes #1116
diff --git a/bundles/org.eclipse.search/new search/org/eclipse/search/ui/ISearchPageContainer.java b/bundles/org.eclipse.search/new search/org/eclipse/search/ui/ISearchPageContainer.java
@@ -61,6 +61,13 @@ public interface ISearchPageContainer {
 	 */
 	public static final int SELECTED_PROJECTS_SCOPE= 3;
 
+	/**
+	 * Current Project scope (value <code>4</code>).
+	 *
+	 * @since 3.16
+	 */
+	public static final int OPENED_EDITORS_SCOPE = 4;
+
 	/**
 	 * Returns the selection with which this container was opened.
 	 *
@@ -85,18 +92,22 @@ public interface ISearchPageContainer {
 	 public void setPerformActionEnabled(boolean state);
 
 	/**
-	 * Returns search container's selected scope.
-	 * The scope is WORKSPACE_SCOPE, SELECTED_PROJECTS_SCOPE, SELECTION_SCOPE or WORKING_SET_SCOPE.
+	 * Returns search container's selected scope. The scope is WORKSPACE_SCOPE,
+	 * SELECTED_PROJECTS_SCOPE, SELECTION_SCOPE, OPENED_EDITORS_SCOPE or
+	 * WORKING_SET_SCOPE.
 	 *
 	 * @return the selected scope
 	 * @since 2.0
 	 */
 	public int getSelectedScope();
 
 	/**
-	 * Sets the selected scope of this search page container.
-	 * The scope is WORKSPACE_SCOPE, SELECTED_PROJECTS_SCOPE, SELECTION_SCOPE or WORKING_SET_SCOPE.
-	 * @param scope the newly selected scope
+	 * Sets the selected scope of this search page container. The scope is
+	 * WORKSPACE_SCOPE, SELECTED_PROJECTS_SCOPE, SELECTION_SCOPE,
+	 * OPENED_EDITORS_SCOPE or WORKING_SET_SCOPE.
+	 * 
+	 * @param scope
+	 *            the newly selected scope
 	 *
 	 * @since 2.0
 	 */
diff --git a/bundles/org.eclipse.search/plugin.xml b/bundles/org.eclipse.search/plugin.xml
@@ -293,6 +293,7 @@
 			extensions="*:1"
 			showScopeSection="true"		
 			canSearchEnclosingProjects="true"
+			canSearchOpenedEditors="true"
 			class="org.eclipse.search.internal.ui.text.TextSearchPage">
 		</page>
 	</extension>
diff --git a/bundles/org.eclipse.search/schema/searchPages.exsd b/bundles/org.eclipse.search/schema/searchPages.exsd
@@ -170,6 +170,14 @@ The page can be activated by the user via the &quot;Customize...&quot; button on
             <annotation>
                <documentation>
                   If this attribute is missing or set to &quot;false&quot;, the &quot;Enclosing Projects&quot; search scope is not shown in the search dialog&apos;s scope part.
+If the attribute &quot;showScopeSection&quot; is missing or set to &quot;false&quot;, this attribute will be ignored.
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="canSearchOpenedEditors" type="boolean">
+            <annotation>
+               <documentation>
+                  If this attribute is missing or set to &quot;false&quot;, the &quot;Opened Editors&quot; search scope is not shown in the search dialog&apos;s scope part.
 If the attribute &quot;showScopeSection&quot; is missing or set to &quot;false&quot;, this attribute will be ignored.
                </documentation>
             </annotation>
diff --git a/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/ScopePart.java b/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/ScopePart.java
@@ -19,6 +19,7 @@
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Set;
 
@@ -50,9 +51,13 @@
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.jface.window.Window;
 
+import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.IEditorReference;
 import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.IWorkingSet;
 import org.eclipse.ui.IWorkingSetManager;
+import org.eclipse.ui.PartInitException;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.dialogs.IWorkingSetSelectionDialog;
 
@@ -77,9 +82,11 @@ public class ScopePart {
 	private Button fUseSelection;
 	private Button fUseProject;
 	private Button fUseWorkingSet;
+	private Button fUseOpenedEditors;
 
 	private int fScope;
 	private boolean fCanSearchEnclosingProjects;
+	private boolean fCanSearchOpenedEditors;
 	private Text fWorkingSetText;
 	private IWorkingSet[] fWorkingSets;
 
@@ -89,36 +96,50 @@ public class ScopePart {
 	private boolean fActiveEditorCanProvideScopeSelection;
 
 	/**
-	 * Returns a new scope part with workspace as initial scope.
-	 * The part is not yet created.
-	 * @param searchDialog The parent container
-	 * @param searchEnclosingProjects If true, add the 'search enclosing project' radio button
+	 * Returns a new scope part with workspace as initial scope. The part is not
+	 * yet created.
+	 * 
+	 * @param searchDialog
+	 *            The parent container
+	 * @param searchEnclosingProjects
+	 *            If true, add the 'search enclosing project' radio button
+	 * @param searchOpenedEditors
+	 *            If true, add the 'search opened editors' radio button
 	 */
-	public ScopePart(SearchDialog searchDialog, boolean searchEnclosingProjects) {
+	public ScopePart(SearchDialog searchDialog, boolean searchEnclosingProjects, boolean searchOpenedEditors) {
 		fSearchDialog= searchDialog;
 		fCanSearchEnclosingProjects= searchEnclosingProjects;
+		fCanSearchOpenedEditors = searchOpenedEditors;
 
 		fSettingsStore= SearchPlugin.getDefault().getDialogSettingsSection(DIALOG_SETTINGS_KEY);
-		fScope= getStoredScope(fSettingsStore, searchEnclosingProjects);
+		fScope = getStoredScope(fSettingsStore, searchEnclosingProjects, searchOpenedEditors);
 
 		fWorkingSets= getStoredWorkingSets();
 	}
 
-	private static int getStoredScope(IDialogSettings settingsStore, boolean canSearchEnclosingProjects) {
+	private static int getStoredScope(IDialogSettings settingsStore, boolean canSearchEnclosingProjects,
+			boolean cansearchOpenedEditors) {
 		int scope;
 		try {
 			scope= settingsStore.getInt(STORE_SCOPE);
 		} catch (NumberFormatException ex) {
 			scope= ISearchPageContainer.WORKSPACE_SCOPE;
 		}
-		if (scope != ISearchPageContainer.WORKING_SET_SCOPE
-			&& scope != ISearchPageContainer.SELECTION_SCOPE
-			&& scope != ISearchPageContainer.SELECTED_PROJECTS_SCOPE
-			&& scope != ISearchPageContainer.WORKSPACE_SCOPE)
-			scope= ISearchPageContainer.WORKSPACE_SCOPE;
+		if (scope != ISearchPageContainer.WORKING_SET_SCOPE 
+				&& scope != ISearchPageContainer.SELECTION_SCOPE
+				&& scope != ISearchPageContainer.SELECTED_PROJECTS_SCOPE
+				&& scope != ISearchPageContainer.OPENED_EDITORS_SCOPE
+				&& scope != ISearchPageContainer.WORKSPACE_SCOPE) {
+			scope = ISearchPageContainer.WORKSPACE_SCOPE;
+		}
+
+		if (!canSearchEnclosingProjects && scope == ISearchPageContainer.SELECTED_PROJECTS_SCOPE) {
+			scope = ISearchPageContainer.WORKSPACE_SCOPE;
+		}
 
-		if (!canSearchEnclosingProjects && scope == ISearchPageContainer.SELECTED_PROJECTS_SCOPE)
+		if (!cansearchOpenedEditors && scope == ISearchPageContainer.OPENED_EDITORS_SCOPE) {
 			scope= ISearchPageContainer.WORKSPACE_SCOPE;
+		}
 
 		return scope;
 	}
@@ -203,6 +224,43 @@ public static List<IResource> selectedResourcesFromContainer(ISearchPageContaine
 		return resources;
 	}
 
+	public static List<IResource> selectedResourcesFromEditors() {
+		IEditorReference[] editorReferences = getEditorReferences();
+		Set<IResource> resources = new LinkedHashSet<>();
+		for (IEditorReference ref : editorReferences) {
+			IFile file;
+			IResource resource;
+			try {
+				IEditorInput editorInput = ref.getEditorInput();
+				resource = editorInput.getAdapter(IResource.class);
+				if (resource != null) {
+					resources.add(resource);
+					continue;
+				}
+				file = editorInput.getAdapter(IFile.class);
+				if (file != null) {
+					resources.add(file);
+					continue;
+				}
+				// May trigger editor init
+				IEditorPart editor = ref.getEditor(true);
+				resource = editor.getAdapter(IResource.class);
+				if (resource != null) {
+					resources.add(resource);
+					continue;
+				}
+				file = editor.getAdapter(IFile.class);
+				if (file != null) {
+					resources.add(file);
+					continue;
+				}
+			} catch (PartInitException e) {
+				// continue
+			}
+		}
+		return new ArrayList<>(resources);
+	}
+
 	private String getSelectedResurcesButtonText() {
 		int size = selectedResourcesFromContainer(fSearchDialog).size();
 		if (size == 1) {
@@ -242,11 +300,13 @@ public int getSelectedScope() {
 	 * @param scope the scope to be selected in this part
 	 */
 	public void setSelectedScope(int scope) {
-		Assert.isLegal(scope >= 0 && scope <= 3);
+		Assert.isLegal(
+				scope >= ISearchPageContainer.WORKSPACE_SCOPE && scope <= ISearchPageContainer.OPENED_EDITORS_SCOPE);
 		Assert.isNotNull(fUseWorkspace);
 		Assert.isNotNull(fUseSelection);
 		Assert.isNotNull(fUseWorkingSet);
 		Assert.isNotNull(fUseProject);
+		Assert.isNotNull(fUseOpenedEditors);
 
 		fSettingsStore.put(STORE_SCOPE, scope);
 
@@ -259,13 +319,22 @@ public void setSelectedScope(int scope) {
 			}
 		} else if (scope == ISearchPageContainer.SELECTION_SCOPE && !fUseSelection.isEnabled()) {
 			scope= fUseProject.isEnabled() ? ISearchPageContainer.SELECTED_PROJECTS_SCOPE : ISearchPageContainer.WORKSPACE_SCOPE;
+		} else if (scope == ISearchPageContainer.OPENED_EDITORS_SCOPE) {
+			if (!fCanSearchOpenedEditors) {
+				SearchPlugin.log(new Status(IStatus.WARNING, NewSearchUI.PLUGIN_ID, IStatus.WARNING,
+						"Opened editors scope set on search page that does not support it", null)); //$NON-NLS-1$
+				scope = ISearchPageContainer.WORKSPACE_SCOPE;
+			} else if (!fUseOpenedEditors.isEnabled()) {
+				scope = ISearchPageContainer.WORKSPACE_SCOPE;
+			}
 		}
 		fScope= scope;
 
 		fUseWorkspace.setSelection(scope == ISearchPageContainer.WORKSPACE_SCOPE);
 		fUseSelection.setSelection(scope == ISearchPageContainer.SELECTION_SCOPE);
 		fUseProject.setSelection(scope == ISearchPageContainer.SELECTED_PROJECTS_SCOPE);
 		fUseWorkingSet.setSelection(scope == ISearchPageContainer.WORKING_SET_SCOPE);
+		fUseOpenedEditors.setSelection(scope == ISearchPageContainer.OPENED_EDITORS_SCOPE);
 
 		updateSearchPageContainerActionPerformedEnablement();
 
@@ -276,7 +345,7 @@ public void setActiveEditorCanProvideScopeSelection(boolean state) {
 		fUseSelection.setEnabled(canSearchInSelection());
 
 		// Reinitialize the controls
-		fScope= getStoredScope(fSettingsStore, fCanSearchEnclosingProjects);
+		fScope = getStoredScope(fSettingsStore, fCanSearchEnclosingProjects, fCanSearchOpenedEditors);
 		setSelectedScope(fScope);
 	}
 
@@ -381,6 +450,16 @@ public Composite createPart(Composite parent) {
 		if (!fCanSearchEnclosingProjects)
 			fUseProject.setVisible(false);
 
+		fUseOpenedEditors = new Button(fPart, SWT.RADIO);
+		fUseOpenedEditors.setData(Integer.valueOf(ISearchPageContainer.OPENED_EDITORS_SCOPE));
+		fUseOpenedEditors.setText(SearchMessages.ScopePart_openedEditorsScope_text);
+		fUseOpenedEditors.setToolTipText(SearchMessages.ScopePart_openedEditorsScope_tooltip_text);
+		fUseOpenedEditors.setEnabled(!selectedResourcesFromEditors().isEmpty());
+
+		gd = new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING);
+		gd.horizontalSpan = 4;
+		fUseOpenedEditors.setLayoutData(gd);
+
 		fUseWorkingSet= new Button(fPart, SWT.RADIO);
 		fUseWorkingSet.setData(Integer.valueOf(ISearchPageContainer.WORKING_SET_SCOPE));
 		fUseWorkingSet.setText(SearchMessages.ScopePart_workingSetScope_text);
@@ -421,6 +500,7 @@ public void widgetSelected(SelectionEvent e) {
 		fUseSelection.addSelectionListener(scopeChangedLister);
 		fUseProject.addSelectionListener(scopeChangedLister);
 		fUseWorkingSet.addSelectionListener(scopeChangedLister);
+		fUseOpenedEditors.addSelectionListener(scopeChangedLister);
 
 		// Set initial scope
 		setSelectedScope(fScope);
@@ -432,6 +512,10 @@ public void widgetSelected(SelectionEvent e) {
 		return fPart;
 	}
 
+	private static IEditorReference[] getEditorReferences() {
+		return PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().getEditorReferences();
+	}
+
 	private boolean canSearchInSelection() {
 		ISelection selection= fSearchDialog.getSelection();
 		return (selection instanceof IStructuredSelection) && !selection.isEmpty()
diff --git a/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchDialog.java b/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchDialog.java
@@ -771,7 +771,8 @@ public void handleException(Throwable ex) {
 			c.setLayout(new GridLayout());
 
 			int index= fDescriptors.indexOf(descriptor);
-			fScopeParts[index]= new ScopePart(this, descriptor.canSearchInProjects());
+			fScopeParts[index] = new ScopePart(this, descriptor.canSearchInProjects(),
+					descriptor.canSearchInOpenedEditors());
 			Control part= fScopeParts[index].createPart(c);
 			applyDialogFont(part);
 			part.setLayoutData(new GridData(SWT.FILL, SWT.BEGINNING, true, false));
diff --git a/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchMessages.java b/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchMessages.java
@@ -191,6 +191,8 @@ private SearchMessages() {
 	public static String ScopePart_workingSetText_accessible_label;
 	public static String ScopePart_workingSetScope_text;
 	public static String ScopePart_workspaceScope_text;
+	public static String ScopePart_openedEditorsScope_text;
+	public static String ScopePart_openedEditorsScope_tooltip_text;
 	public static String ScopePart_workingSetConcatenation;
 	public static String CopyToClipboardAction_label;
 	public static String CopyToClipboardAction_tooltip;
diff --git a/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchMessages.properties b/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchMessages.properties
@@ -202,6 +202,8 @@ ScopePart_workingSetChooseButton_text= C&hoose...
 ScopePart_workingSetText_accessible_label=Working set name
 ScopePart_workingSetScope_text=Wor&king set:
 ScopePart_workspaceScope_text= &Workspace
+ScopePart_openedEditorsScope_text=Files opened in &editors
+ScopePart_openedEditorsScope_tooltip_text=Only workspace files (in projects) are supported
 
 # Concatenate two working set names e.g. "Source, Lib"
 ScopePart_workingSetConcatenation= {0}, {1}
diff --git a/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchPageDescriptor.java b/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/SearchPageDescriptor.java
@@ -64,6 +64,7 @@ class SearchPageDescriptor implements IPluginContribution, Comparable<SearchPage
 	private final static String EXTENSIONS_ATTRIBUTE= "extensions"; //$NON-NLS-1$
 	private final static String SHOW_SCOPE_SECTION_ATTRIBUTE= "showScopeSection"; //$NON-NLS-1$
 	private final static String CAN_SEARCH_ENCLOSING_PROJECTS= "canSearchEnclosingProjects"; //$NON-NLS-1$
+	private final static String CAN_SEARCH_OPENED_EDITORS = "canSearchOpenedEditors"; //$NON-NLS-1$
 	private final static String ENABLED_ATTRIBUTE= "enabled"; //$NON-NLS-1$
 	private final static String SEARCH_VIEW_HELP_CONTEXT_ID_ATTRIBUTE= "searchViewHelpContextId"; //$NON-NLS-1$
 
@@ -186,6 +187,19 @@ public boolean canSearchInProjects() {
 		return Boolean.parseBoolean(fElement.getAttribute(CAN_SEARCH_ENCLOSING_PROJECTS));
 	}
 
+	/**
+	 * Returns <code>true</code> if the page can handle searches in opened
+	 * editors. The value should be ignored if <code>showScopeSection()</code>
+	 * returns <code>false</code>.
+	 *
+	 * This attribute is optional and defaults to <code>false</code>.
+	 * 
+	 * @return Returns if the page can handle searches in opened editors
+	 */
+	public boolean canSearchInOpenedEditors() {
+		return Boolean.parseBoolean(fElement.getAttribute(CAN_SEARCH_OPENED_EDITORS));
+	}
+
 	/**
 	 * @return Returns the page's preferred size
 	 */
diff --git a/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/text/TextSearchPage.java b/bundles/org.eclipse.search/search/org/eclipse/search/internal/ui/text/TextSearchPage.java
@@ -323,6 +323,8 @@ public FileTextSearchScope createTextSearchScope() {
 				return getSelectedResourcesScope();
 			case ISearchPageContainer.SELECTED_PROJECTS_SCOPE:
 				return getEnclosingProjectScope();
+			case ISearchPageContainer.OPENED_EDITORS_SCOPE:
+				return getOpenedEditorstScope();
 			case ISearchPageContainer.WORKING_SET_SCOPE:
 				IWorkingSet[] workingSets= getContainer().getSelectedWorkingSets();
 				return FileTextSearchScope.newSearchScope(workingSets, getExtensions(), fSearchDerived);
@@ -352,6 +354,10 @@ private FileTextSearchScope getEnclosingProjectScope() {
 		return FileTextSearchScope.newSearchScope(res, getExtensions(), fSearchDerived);
 	}
 
+	private FileTextSearchScope getOpenedEditorstScope() {
+		IResource[] arr = ScopePart.selectedResourcesFromEditors().toArray(new IResource[0]);
+		return FileTextSearchScope.newSearchScope(arr, getExtensions(), fSearchDerived);
+	}
 
 	private SearchPatternData findInPrevious(String pattern) {
 		for (SearchPatternData element : fPreviousSearchPatterns) {
