+ * IStatus - warnings or errors from the search
+ * ICElement - for C/C++ elements, including TUs, folders, projects
+ * IPath - directory container, full path
+ * IIndexFileLocation - for file entries inside IPath directory containers
+ * {@link IPDOMSearchContentProvider#URI_CONTAINER} - container for URIs
+ * URI - from IIndexFileLocations not resolvable to the local filesystem, under URI_CONTAINER
* @author Doug Schaefer
+ * @author Ed Swartz
*
*/
public interface IPDOMSearchContentProvider {
+ /** This node encapsulates results in the search tree for results not resolvable to files. */
+ static Object URI_CONTAINER = new Object();
+
+ /** This node appears in the tree when the indexer was running during the search
+ * to warn the user that the results are suspicious.
+ *
+ * TODO: it would be better if IIndexManager told us which projects specifically + * were being indexed at the time, so we could annotate per-project whose results are suspicious + * (which may be none at all for a given search). + * See the handling of {@link PDOMSearchResult#wasIndexerBusy()}. + */ + static IStatus INCOMPLETE_RESULTS_NODE = + new Status(IStatus.WARNING, CUIPlugin.PLUGIN_ID, + CSearchMessages.CSearchMessages_IndexRunningIncompleteWarning); + public void elementsChanged(Object[] elements); public void clear(); diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchLabelProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchLabelProvider.java index 1da11060411..9ab080db056 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchLabelProvider.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchLabelProvider.java @@ -7,14 +7,20 @@ * * Contributors: * Markus Schorn - initial API and implementation + * Ed Swartz (Nokia) *******************************************************************************/ package org.eclipse.cdt.internal.ui.search; +import java.net.URI; + import org.eclipse.core.runtime.IPath; +import org.eclipse.core.runtime.IStatus; import org.eclipse.jface.viewers.LabelProvider; import org.eclipse.search.ui.text.AbstractTextSearchViewPage; import org.eclipse.swt.graphics.Image; +import org.eclipse.ui.ISharedImages; +import org.eclipse.ui.PlatformUI; import org.eclipse.cdt.core.index.IIndexFileLocation; import org.eclipse.cdt.core.index.IndexLocationFactory; @@ -25,7 +31,16 @@ import org.eclipse.cdt.internal.ui.viewsupport.CElementImageProvider; import org.eclipse.cdt.internal.ui.viewsupport.CUILabelProvider; /** + * The content in the tree and list views may be either: + *
+ * IStatus - warnings or errors from the search
+ * ICElement - for C/C++ elements, including TUs, folders, projects
+ * IPath - directory container, full path
+ * IIndexFileLocation - for file entries inside IPath directory containers
+ * {@link IPDOMSearchContentProvider#URI_CONTAINER} - container for URIs
+ * URI - for IIndexFileLocations not resolvable to the local filesystem, under URI_CONTAINER
* @author Doug Schaefer
+ * @author Ed Swartz
*
*/
public class PDOMSearchLabelProvider extends LabelProvider {
@@ -44,10 +59,33 @@ public class PDOMSearchLabelProvider extends LabelProvider {
if (element instanceof PDOMSearchElement)
return fTypeInfoLabelProvider.getImage(((PDOMSearchElement)element).getTypeInfo());
- if (element instanceof IIndexFileLocation) {
+ if (element instanceof IIndexFileLocation
+ || element instanceof URI) {
return CPluginImages.get(CPluginImages.IMG_OBJS_INCLUDE);
}
+ if (element == IPDOMSearchContentProvider.URI_CONTAINER) {
+ // TODO: perhaps a better icon?
+ return CPluginImages.get(CPluginImages.IMG_OBJS_INCLUDES_CONTAINER);
+ }
+
+ if (element instanceof IPath) {
+ return CPluginImages.get(CPluginImages.IMG_OBJS_INCLUDES_FOLDER);
+ }
+
+ if (element instanceof IStatus) {
+ IStatus status = (IStatus) element;
+ ISharedImages sharedImages = PlatformUI.getWorkbench().getSharedImages();
+ switch (status.getSeverity()) {
+ case IStatus.WARNING:
+ return sharedImages.getImage(ISharedImages.IMG_OBJS_WARN_TSK);
+ case IStatus.ERROR:
+ return sharedImages.getImage(ISharedImages.IMG_OBJS_ERROR_TSK);
+ default:
+ return sharedImages.getImage(ISharedImages.IMG_OBJS_INFO_TSK);
+ }
+ }
+
return fCElementLabelProvider.getImage(element);
}
@@ -56,13 +94,26 @@ public class PDOMSearchLabelProvider extends LabelProvider {
return fTypeInfoLabelProvider.getText(((PDOMSearchElement)element).getTypeInfo());
}
+ if (element instanceof IPath) {
+ return ((IPath) element).toString();
+ }
+
if (element instanceof IIndexFileLocation) {
IPath path= IndexLocationFactory.getPath((IIndexFileLocation)element);
if(path!=null) {
- return path.toString();
+ // these are categorized into directories already
+ return path.lastSegment();
}
}
+ if (element instanceof URI) {
+ return ((URI)element).toString();
+ }
+
+ if (element instanceof IStatus) {
+ return ((IStatus) element).getMessage();
+ }
+
return fCElementLabelProvider.getText(element);
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListContentProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListContentProvider.java
index 41a3138a7cc..98ba06bd943 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListContentProvider.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListContentProvider.java
@@ -7,14 +7,30 @@
*
* Contributors:
* QNX - Initial API and implementation
+ * Ed Swartz (Nokia)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.search;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Path;
+import org.eclipse.core.runtime.Status;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;
+import com.ibm.icu.text.MessageFormat;
+
+import org.eclipse.cdt.core.CCorePlugin;
+import org.eclipse.cdt.core.model.ICProject;
+import org.eclipse.cdt.ui.CUIPlugin;
+
/**
* @author Doug Schaefer
*
@@ -26,7 +42,60 @@ public class PDOMSearchListContentProvider implements
private PDOMSearchResult result;
public Object[] getElements(Object inputElement) {
- return result.getElements();
+ Set uncoveredProjects = new HashSet();
+
+ PDOMSearchResult result = (PDOMSearchResult) inputElement;
+
+ Object[] results = result.getElements();
+ List resultList = new ArrayList(Arrays.asList(results));
+
+ // see if indexer was busy
+ if (result.wasIndexerBusy()) {
+ resultList.add(IPDOMSearchContentProvider.INCOMPLETE_RESULTS_NODE);
+ }
+
+ // see which projects returned results
+ for (int i = 0; i < results.length; i++) {
+ if (results[i] instanceof PDOMSearchElement) {
+ PDOMSearchElement searchElement = (PDOMSearchElement) results[i];
+ String path = searchElement.getLocation().getFullPath();
+ if (path != null) {
+ uncoveredProjects.add(new Path(path).segment(0));
+ }
+ }
+ }
+
+ // add message for all the projects which have no results
+ ICProject[] projects = ((PDOMSearchQuery)result.getQuery()).getProjects();
+ for (int i = 0; i < projects.length; ++i) {
+ ICProject project = projects[i];
+ boolean foundProject = uncoveredProjects.contains(project.getProject().getName());
+ if (!foundProject) {
+ if (project.isOpen()) {
+ if (!CCorePlugin.getIndexManager().isProjectIndexed(project)) {
+ resultList.add(createUnindexedProjectWarningElement(project));
+ }
+ } else {
+ resultList.add(createClosedProjectWarningElement(project));
+ }
+ }
+ }
+
+ return resultList.toArray();
+ }
+
+ private Status createUnindexedProjectWarningElement(ICProject project) {
+ return new Status(IStatus.WARNING, CUIPlugin.PLUGIN_ID,
+ MessageFormat.format(
+ CSearchMessages.PDOMSearchListContentProvider_IndexerNotEnabledMessageFormat,
+ new Object[] { project.getProject().getName() }));
+ }
+
+ private Status createClosedProjectWarningElement(ICProject project) {
+ return new Status(IStatus.WARNING, CUIPlugin.PLUGIN_ID,
+ MessageFormat.format(
+ CSearchMessages.PDOMSearchListContentProvider_ProjectClosedMessageFormat,
+ new Object[] { project.getProject().getName() }));
}
public void dispose() {
@@ -35,6 +104,7 @@ public class PDOMSearchListContentProvider implements
public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
this.viewer = (TableViewer)viewer;
result = (PDOMSearchResult)newInput;
+ viewer.refresh();
}
public void elementsChanged(Object[] elements) {
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListLabelProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListLabelProvider.java
index 6fccadd3009..330916afc63 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListLabelProvider.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchListLabelProvider.java
@@ -8,6 +8,7 @@
* Contributors:
* QNX - Initial API and implementation
* Markus Schorn (Wind River Systems)
+ * Ed Swartz (Nokia)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.search;
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchQuery.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchQuery.java
index f63623bbee1..895e5088d15 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchQuery.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchQuery.java
@@ -8,6 +8,7 @@
* Contributors:
* QNX - Initial API and implementation
* Markus Schorn (Wind River Systems)
+ * Ed Swartz (Nokia)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.search;
@@ -32,6 +33,7 @@ import org.eclipse.cdt.core.index.IIndexName;
import org.eclipse.cdt.core.model.CoreModel;
import org.eclipse.cdt.core.model.ICElement;
import org.eclipse.cdt.core.model.ICProject;
+import org.eclipse.cdt.core.parser.util.ArrayUtil;
import org.eclipse.cdt.ui.CUIPlugin;
/**
@@ -59,7 +61,16 @@ public abstract class PDOMSearchQuery implements ISearchQuery {
try {
if (scope == null) {
// All CDT projects in workspace
- projects = CoreModel.getDefault().getCModel().getCProjects();
+ ICProject[] allProjects = CoreModel.getDefault().getCModel().getCProjects();
+
+ // Filter out closed projects for this case
+ for (int i = 0; i < allProjects.length; i++) {
+ if (!allProjects[i].isOpen()) {
+ allProjects[i] = null;
+ }
+ }
+
+ projects = (ICProject[]) ArrayUtil.removeNulls(ICProject.class, allProjects);
} else {
Map projectMap = new HashMap();
@@ -131,6 +142,8 @@ public abstract class PDOMSearchQuery implements ISearchQuery {
PDOMSearchResult result= (PDOMSearchResult) getSearchResult();
result.removeAll();
+ result.setIndexerBusy(!CCorePlugin.getIndexManager().isIndexerIdle());
+
try {
IIndex index= CCorePlugin.getIndexManager().getIndex(projects, 0);
try {
@@ -150,4 +163,12 @@ public abstract class PDOMSearchQuery implements ISearchQuery {
}
abstract protected IStatus runWithIndex(IIndex index, IProgressMonitor monitor);
+
+ /**
+ * Get the projects involved in the search.
+ * @return array, never null
+ */
+ public ICProject[] getProjects() {
+ return projects;
+ }
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchResult.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchResult.java
index 2828243be78..0c51c35d96f 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchResult.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchResult.java
@@ -8,6 +8,7 @@
* Contributors:
* QNX - Initial API and implementation
* Markus Schorn (Wind River Systems)
+ * Ed Swartz (Nokia)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.search;
@@ -40,6 +41,7 @@ import org.eclipse.cdt.core.index.IndexLocationFactory;
import org.eclipse.cdt.ui.CUIPlugin;
import org.eclipse.cdt.internal.ui.util.ExternalEditorInput;
+import org.eclipse.cdt.internal.ui.util.Messages;
/**
* @author Doug Schaefer
@@ -48,6 +50,7 @@ import org.eclipse.cdt.internal.ui.util.ExternalEditorInput;
public class PDOMSearchResult extends AbstractTextSearchResult implements IEditorMatchAdapter, IFileMatchAdapter {
private PDOMSearchQuery query;
+ private boolean indexerBusy;
public PDOMSearchResult(PDOMSearchQuery query) {
super();
@@ -152,7 +155,10 @@ public class PDOMSearchResult extends AbstractTextSearchResult implements IEdito
}
public String getLabel() {
- return query.getLabel();
+ // report pattern and number of matches
+ String label = query.getLabel();
+ String countLabel = Messages.format(CSearchMessages.CSearchResultCollector_matches, new Integer(getElements().length));
+ return label + " " + countLabel; //$NON-NLS-1$
}
public String getTooltip() {
@@ -167,4 +173,19 @@ public class PDOMSearchResult extends AbstractTextSearchResult implements IEdito
return query;
}
+ /**
+ * Remember whether the indexer was busy when the search was performed.
+ * @param b
+ */
+ public void setIndexerBusy(boolean b) {
+ this.indexerBusy = b;
+ }
+
+ /**
+ * Tell if the indexer was busy when search results were gathered.
+ */
+ public boolean wasIndexerBusy() {
+ return indexerBusy;
+ }
+
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeContentProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeContentProvider.java
index 0e81e3eeb1c..c9874ac3d0c 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeContentProvider.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeContentProvider.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2006, 2007 QNX Software Systems and others.
+ * Copyright (c) 2006, 2008 QNX Software Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,6 +8,7 @@
* Contributors:
* QNX - Initial API and implementation
* Markus Schorn (Wind River Systems)
+ * Ed Swartz (Nokia)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.search;
@@ -43,7 +44,7 @@ public class PDOMSearchTreeContentProvider implements ITreeContentProvider, IPDO
private TreeViewer viewer;
private PDOMSearchResult result;
private Map tree = new HashMap();
-
+
public Object[] getChildren(Object parentElement) {
Set children = (Set)tree.get(parentElement);
if (children == null)
@@ -67,7 +68,7 @@ public class PDOMSearchTreeContentProvider implements ITreeContentProvider, IPDO
}
public Object[] getElements(Object inputElement) {
- return getChildren(result);
+ return getChildren(inputElement);
}
public void dispose() {
@@ -115,8 +116,18 @@ public class PDOMSearchTreeContentProvider implements ITreeContentProvider, IPDO
}
}
if (!handled) {
- insertChild(element.getLocation(), element);
- insertChild(result, element.getLocation());
+ // insert a folder and then the file under that
+ IPath path = IndexLocationFactory.getAbsolutePath(location);
+ if (path != null) {
+ IPath directory = path.removeLastSegments(1);
+ insertChild(location, element);
+ insertChild(directory, location);
+ insertChild(result, directory);
+ } else {
+ // URI not representable as a file
+ insertChild(IPDOMSearchContentProvider.URI_CONTAINER, location.getURI());
+ insertChild(result, IPDOMSearchContentProvider.URI_CONTAINER);
+ }
}
}
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeLabelProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeLabelProvider.java
index a90aac653d1..34cebb0c3a8 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeLabelProvider.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchTreeLabelProvider.java
@@ -8,6 +8,7 @@
* Contributors:
* QNX - Initial API and implementation
* Markus Schorn (Wind River Systems)
+ * Ed Swartz (Nokia)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.search;
diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchViewPage.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchViewPage.java
index f558086b39a..18805df10e9 100644
--- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchViewPage.java
+++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/search/PDOMSearchViewPage.java
@@ -7,15 +7,20 @@
*
* Contributors:
* QNX - Initial API and implementation
+ * Ed Swartz (Nokia)
*******************************************************************************/
package org.eclipse.cdt.internal.ui.search;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
+import org.eclipse.core.runtime.IStatus;
import org.eclipse.jface.viewers.StructuredViewer;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.TreeViewer;
+import org.eclipse.jface.viewers.Viewer;
+import org.eclipse.jface.viewers.ViewerComparator;
+import org.eclipse.jface.viewers.ViewerSorter;
import org.eclipse.search.ui.text.AbstractTextSearchViewPage;
import org.eclipse.search.ui.text.Match;
import org.eclipse.ui.IEditorPart;
@@ -24,6 +29,7 @@ import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.cdt.core.index.IIndexFileLocation;
import org.eclipse.cdt.core.index.IndexLocationFactory;
+import org.eclipse.cdt.core.model.ICElement;
import org.eclipse.cdt.ui.CUIPlugin;
import org.eclipse.cdt.internal.ui.util.EditorUtility;
@@ -54,14 +60,78 @@ public class PDOMSearchViewPage extends AbstractTextSearchViewPage {
contentProvider.clear();
}
+ /**
+ * Supply a sorter for the list and tree content providers to supply some order to the
+ * large numbers of matches that may result.
+ *
+ * This sorter categorizes the different kinds of ICElement matches (as well as IStatus + * messages and External Files groups) to place them in groups. The items within a + * category are sorted in the default way {@link ViewerSorter#compare(Viewer, Object, Object)} works, + * by comparing text labels. + *
+ * A potential concern here is that, in sorting the elements by name, the user may + * find himself randomly jumping around a file when navigating search results in order. + * As this only happens when a search matches different identifiers or identifiers of + * different types, and since the user can use a textual search within a file to navigate + * the same results (ignoring extraneous hits in comments or disabled code), I argue it's not + * a big deal. Furthermore, usually it would be a wildcard search that would result in + * this situation -- indicating the user doesn't know the identifier and wants to find it using + * search. In such a case, a sorted list of results in much more friendly to navigate. + * @author eswartz + * + */ + private class SearchViewerComparator extends ViewerComparator { + /* (non-Javadoc) + * @see org.eclipse.jface.viewers.ViewerComparator#category(java.lang.Object) + */ + public int category(Object element) { + // place status messages first + if (element instanceof IStatus) { + return -1000; + } + + // keep elements of the same type together + if (element instanceof PDOMSearchElement) { + PDOMSearchElement searchElement = (PDOMSearchElement)element; + int type = searchElement.getTypeInfo().getCElementType(); + // handle unknown types + if (type < 0) { + type = 0; + } + return type; + } else if (element instanceof ICElement) { + int type = ((ICElement) element).getElementType(); + // handle unknown types + if (type < 0) { + type = 0; + } + return Math.min(Math.max(0, type), 900); + } + + // place external folders next to last + if (element instanceof IPath || element instanceof IIndexFileLocation) { + return 999; + } + + // place external file matches last + if (element == IPDOMSearchContentProvider.URI_CONTAINER) { + return 1000; + } + + return 2000; + } + } + protected void configureTreeViewer(TreeViewer viewer) { contentProvider = new PDOMSearchTreeContentProvider(); + viewer.setComparator(new SearchViewerComparator()); viewer.setContentProvider((PDOMSearchTreeContentProvider)contentProvider); viewer.setLabelProvider(new PDOMSearchTreeLabelProvider(this)); } protected void configureTableViewer(TableViewer viewer) { contentProvider = new PDOMSearchListContentProvider(); + viewer.setComparator(new SearchViewerComparator()); viewer.setContentProvider((PDOMSearchListContentProvider)contentProvider); viewer.setLabelProvider(new PDOMSearchListLabelProvider(this)); }