| /******************************************************************************* |
| * Copyright (c) 2000, 2013 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.search.internal.ui; |
| |
| import java.util.ArrayList; |
| import java.util.Collections; |
| import java.util.Iterator; |
| import java.util.List; |
| |
| import org.osgi.framework.BundleContext; |
| |
| import org.eclipse.swt.widgets.Control; |
| import org.eclipse.swt.widgets.Display; |
| import org.eclipse.swt.widgets.Shell; |
| |
| import org.eclipse.core.runtime.Assert; |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IConfigurationElement; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.Platform; |
| import org.eclipse.core.runtime.Status; |
| |
| import org.eclipse.core.resources.IWorkspace; |
| import org.eclipse.core.resources.IWorkspaceDescription; |
| import org.eclipse.core.resources.ResourcesPlugin; |
| |
| import org.eclipse.jface.action.GroupMarker; |
| import org.eclipse.jface.action.IMenuManager; |
| import org.eclipse.jface.action.Separator; |
| import org.eclipse.jface.dialogs.IDialogSettings; |
| |
| import org.eclipse.ui.IWorkbenchPage; |
| import org.eclipse.ui.IWorkbenchWindow; |
| import org.eclipse.ui.plugin.AbstractUIPlugin; |
| |
| import org.eclipse.search.internal.core.text.TextSearchEngineRegistry; |
| import org.eclipse.search.internal.ui.util.ExceptionHandler; |
| import org.eclipse.search.ui.IContextMenuConstants; |
| import org.eclipse.search.ui.NewSearchUI; |
| |
| import org.eclipse.search2.internal.ui.InternalSearchUI; |
| import org.eclipse.search2.internal.ui.text2.TextSearchQueryProviderRegistry; |
| |
| |
| /** |
| * The plug-in runtime class for Search plug-in |
| */ |
| public class SearchPlugin extends AbstractUIPlugin { |
| |
| public static final String SEARCH_PAGE_EXTENSION_POINT= "searchPages"; //$NON-NLS-1$ |
| public static final String SORTER_EXTENSION_POINT= "searchResultSorters"; //$NON-NLS-1$ |
| |
| /** |
| * Filtered search marker type (value <code>"org.eclipse.search.filteredsearchmarker"</code>). |
| * |
| * @see org.eclipse.core.resources.IMarker |
| */ |
| public static final String FILTERED_SEARCH_MARKER= NewSearchUI.PLUGIN_ID + ".filteredsearchmarker"; //$NON-NLS-1$ |
| |
| /** |
| * Search annotation type (value <code>"org.eclipse.search.results"</code>). |
| * |
| * @since 3.2 |
| */ |
| public static final String SEARCH_ANNOTATION_TYPE= NewSearchUI.PLUGIN_ID + ".results"; //$NON-NLS-1$ |
| |
| /** |
| * Filtered search annotation type (value <code>"org.eclipse.search.filteredResults"</code>). |
| * |
| * @since 3.2 |
| */ |
| public static final String FILTERED_SEARCH_ANNOTATION_TYPE= NewSearchUI.PLUGIN_ID + ".filteredResults"; //$NON-NLS-1$ |
| |
| /** Status code describing an internal error */ |
| public static final int INTERNAL_ERROR= 1; |
| |
| private static SearchPlugin fgSearchPlugin; |
| |
| |
| private List<SearchPageDescriptor> fPageDescriptors; |
| private List<SorterDescriptor> fSorterDescriptors; |
| private TextSearchEngineRegistry fTextSearchEngineRegistry; |
| private TextSearchQueryProviderRegistry fTextSearchQueryProviderRegistry; |
| |
| public SearchPlugin() { |
| super(); |
| Assert.isTrue(fgSearchPlugin == null); |
| fgSearchPlugin= this; |
| fTextSearchEngineRegistry= null; |
| fTextSearchQueryProviderRegistry= null; |
| } |
| |
| /** |
| * @return Returns the search plugin instance. |
| */ |
| public static SearchPlugin getDefault() { |
| return fgSearchPlugin; |
| } |
| |
| /** |
| * Returns the active workbench window. |
| * @return returns <code>null</code> if the active window is not a workbench window |
| */ |
| public static IWorkbenchWindow getActiveWorkbenchWindow() { |
| IWorkbenchWindow window= fgSearchPlugin.getWorkbench().getActiveWorkbenchWindow(); |
| if (window == null) { |
| final WindowRef windowRef= new WindowRef(); |
| Display.getDefault().syncExec(() -> setActiveWorkbenchWindow(windowRef)); |
| return windowRef.window; |
| } |
| return window; |
| } |
| |
| private static class WindowRef { |
| public IWorkbenchWindow window; |
| } |
| |
| private static void setActiveWorkbenchWindow(WindowRef windowRef) { |
| windowRef.window= null; |
| Display display= Display.getCurrent(); |
| if (display == null) |
| return; |
| Control shell= display.getActiveShell(); |
| while (shell != null) { |
| Object data= shell.getData(); |
| if (data instanceof IWorkbenchWindow) { |
| windowRef.window= (IWorkbenchWindow)data; |
| return; |
| } |
| shell= shell.getParent(); |
| } |
| Shell shells[]= display.getShells(); |
| for (Shell shell2 : shells) { |
| Object data= shell2.getData(); |
| if (data instanceof IWorkbenchWindow) { |
| windowRef.window= (IWorkbenchWindow)data; |
| return; |
| } |
| } |
| } |
| |
| /** |
| * @return Returns the shell of the active workbench window. |
| */ |
| public static Shell getActiveWorkbenchShell() { |
| IWorkbenchWindow window= getActiveWorkbenchWindow(); |
| if (window != null) |
| return window.getShell(); |
| return null; |
| } |
| |
| /** |
| * Beeps using the display of the active workbench window. |
| */ |
| public static void beep() { |
| getActiveWorkbenchShell().getDisplay().beep(); |
| } |
| |
| /** |
| * @return Returns the active workbench window's currrent page. |
| */ |
| public static IWorkbenchPage getActivePage() { |
| return getActiveWorkbenchWindow().getActivePage(); |
| } |
| |
| /** |
| * @return Returns the workbench from which this plugin has been loaded. |
| */ |
| public static IWorkspace getWorkspace() { |
| return ResourcesPlugin.getWorkspace(); |
| } |
| |
| |
| |
| static boolean setAutoBuilding(boolean state) { |
| IWorkspaceDescription workspaceDesc= getWorkspace().getDescription(); |
| boolean isAutobuilding= workspaceDesc.isAutoBuilding(); |
| |
| if (isAutobuilding != state) { |
| workspaceDesc.setAutoBuilding(state); |
| try { |
| getWorkspace().setDescription(workspaceDesc); |
| } |
| catch (CoreException ex) { |
| ExceptionHandler.handle(ex, SearchMessages.Search_Error_setDescription_title, SearchMessages.Search_Error_setDescription_message); |
| } |
| } |
| return isAutobuilding; |
| } |
| |
| @Override |
| public void start(BundleContext context) throws Exception { |
| super.start(context); |
| } |
| |
| @Override |
| public void stop(BundleContext context) throws Exception { |
| InternalSearchUI.shutdown(); |
| disposeOldSearchManager(); |
| super.stop(context); |
| fgSearchPlugin= null; |
| } |
| |
| /** |
| * @deprecated old search |
| */ |
| @Deprecated |
| private void disposeOldSearchManager() { |
| if (SearchManager.fgDefault != null) |
| SearchManager.fgDefault.dispose(); |
| } |
| |
| /** |
| * @return Returns all search pages contributed to the workbench. |
| */ |
| public List<SearchPageDescriptor> getSearchPageDescriptors() { |
| if (fPageDescriptors == null) { |
| IConfigurationElement[] elements= Platform.getExtensionRegistry().getConfigurationElementsFor(NewSearchUI.PLUGIN_ID, SEARCH_PAGE_EXTENSION_POINT); |
| fPageDescriptors= createSearchPageDescriptors(elements); |
| } |
| return fPageDescriptors; |
| } |
| |
| /** |
| * @param pageId the page id or <code>null</code> |
| * @return all descriptors of the enabled search pages, plus the descriptor for the given page id |
| */ |
| public List<SearchPageDescriptor> getEnabledSearchPageDescriptors(String pageId) { |
| Iterator<SearchPageDescriptor> iter= getSearchPageDescriptors().iterator(); |
| List<SearchPageDescriptor> enabledDescriptors= new ArrayList<>(5); |
| while (iter.hasNext()) { |
| SearchPageDescriptor desc= iter.next(); |
| if (desc.isEnabled() || desc.getId().equals(pageId)) |
| enabledDescriptors.add(desc); |
| } |
| return enabledDescriptors; |
| } |
| |
| /** |
| * @return Returns the help context ID for the Search view |
| * as provided by the current search page extension. |
| * |
| * @since 3.0 |
| * @deprecated old search |
| */ |
| @Deprecated |
| public String getSearchViewHelpContextId() { |
| Search currentSearch= SearchManager.getDefault().getCurrentSearch(); |
| if (currentSearch != null) { |
| String pageId= currentSearch.getPageId(); |
| Iterator<SearchPageDescriptor> iter= getSearchPageDescriptors().iterator(); |
| while (iter.hasNext()) { |
| SearchPageDescriptor desc= iter.next(); |
| if (desc.getId().equals(pageId)) { |
| String helpId= desc.getSearchViewHelpContextId(); |
| if (helpId == null) |
| return ISearchHelpContextIds.SEARCH_VIEW; |
| return desc.getSearchViewHelpContextId(); |
| } |
| } |
| } |
| return ISearchHelpContextIds.SEARCH_VIEW; |
| } |
| |
| /** |
| * Creates all necessary search page nodes. |
| * @param elements the configuration elements |
| * @return the created SearchPageDescriptor |
| */ |
| private List<SearchPageDescriptor> createSearchPageDescriptors(IConfigurationElement[] elements) { |
| List<SearchPageDescriptor> result= new ArrayList<>(5); |
| for (IConfigurationElement element : elements) { |
| if (SearchPageDescriptor.PAGE_TAG.equals(element.getName())) { |
| SearchPageDescriptor desc= new SearchPageDescriptor(element); |
| result.add(desc); |
| } |
| } |
| Collections.sort(result); |
| return result; |
| } |
| |
| /** |
| * @return Returns all sorters contributed to the workbench. |
| */ |
| public List<SorterDescriptor> getSorterDescriptors() { |
| if (fSorterDescriptors == null) { |
| IConfigurationElement[] elements= Platform.getExtensionRegistry().getConfigurationElementsFor(NewSearchUI.PLUGIN_ID, SORTER_EXTENSION_POINT); |
| fSorterDescriptors= createSorterDescriptors(elements); |
| } |
| return fSorterDescriptors; |
| } |
| |
| |
| public TextSearchEngineRegistry getTextSearchEngineRegistry() { |
| if (fTextSearchEngineRegistry == null) { |
| fTextSearchEngineRegistry= new TextSearchEngineRegistry(); |
| } |
| return fTextSearchEngineRegistry; |
| } |
| |
| public TextSearchQueryProviderRegistry getTextSearchQueryProviderRegistry() { |
| if (fTextSearchQueryProviderRegistry == null) { |
| fTextSearchQueryProviderRegistry= new TextSearchQueryProviderRegistry(); |
| } |
| return fTextSearchQueryProviderRegistry; |
| } |
| |
| /** |
| * Creates all necessary sorter description nodes. |
| * @param elements the configuration elements |
| * @return the created SorterDescriptor |
| */ |
| private List<SorterDescriptor> createSorterDescriptors(IConfigurationElement[] elements) { |
| List<SorterDescriptor> result= new ArrayList<>(5); |
| for (IConfigurationElement element : elements) { |
| if (SorterDescriptor.SORTER_TAG.equals(element.getName())) |
| result.add(new SorterDescriptor(element)); |
| } |
| return result; |
| } |
| |
| public IDialogSettings getDialogSettingsSection(String name) { |
| IDialogSettings dialogSettings= getDialogSettings(); |
| IDialogSettings section= dialogSettings.getSection(name); |
| if (section == null) { |
| section= dialogSettings.addNewSection(name); |
| } |
| return section; |
| } |
| |
| |
| /** |
| * Log status to platform log |
| * @param status the status to log |
| */ |
| public static void log(IStatus status) { |
| getDefault().getLog().log(status); |
| } |
| |
| public static void log(Throwable e) { |
| log(new Status(IStatus.ERROR, NewSearchUI.PLUGIN_ID, INTERNAL_ERROR, SearchMessages.SearchPlugin_internal_error, e)); |
| } |
| |
| public static String getID() { |
| return NewSearchUI.PLUGIN_ID; |
| } |
| |
| /** |
| * Creates the Search plugin standard groups in a context menu. |
| * |
| * @param menu the menu to create in |
| * @deprecated old search |
| */ |
| @Deprecated |
| public static void createStandardGroups(IMenuManager menu) { |
| if (!menu.isEmpty()) |
| return; |
| menu.add(new Separator(IContextMenuConstants.GROUP_NEW)); |
| menu.add(new GroupMarker(IContextMenuConstants.GROUP_GOTO)); |
| menu.add(new GroupMarker(IContextMenuConstants.GROUP_OPEN)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_SHOW)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_BUILD)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_REORGANIZE)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_REMOVE_MATCHES)); |
| menu.add(new GroupMarker(IContextMenuConstants.GROUP_GENERATE)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_SEARCH)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_ADDITIONS)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_VIEWER_SETUP)); |
| menu.add(new Separator(IContextMenuConstants.GROUP_PROPERTIES)); |
| } |
| } |