/*******************************************************************************
* Copyright (c) 2000, 2010 IBM Corporation 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
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.internal.core.search;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IPath;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaModel;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.IPackageFragmentRoot;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.ITypeHierarchy;
import org.eclipse.jdt.core.ITypeRoot;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.compiler.CharOperation;
import org.eclipse.jdt.core.search.IJavaSearchScope;
import org.eclipse.jdt.core.search.SearchPattern;
import org.eclipse.jdt.internal.compiler.util.SimpleSet;
import org.eclipse.jdt.internal.core.JarPackageFragmentRoot;
import org.eclipse.jdt.internal.core.JavaModel;
import org.eclipse.jdt.internal.core.JavaModelManager;
import org.eclipse.jdt.internal.core.JavaProject;
import org.eclipse.jdt.internal.core.builder.ReferenceCollection;
import org.eclipse.jdt.internal.core.builder.State;
import org.eclipse.jdt.internal.core.search.indexing.IndexManager;
import org.eclipse.jdt.internal.core.search.matching.MatchLocator;
import org.eclipse.jdt.internal.core.search.matching.MethodPattern;
/**
* Selects the indexes that correspond to projects in a given search scope and that are dependent on
* a given focus element.
*/
public class IndexSelector {
IJavaSearchScope searchScope;
SearchPattern pattern;
IPath[] indexLocations; // cache of the keys for looking index up
public IndexSelector(
IJavaSearchScope searchScope,
SearchPattern pattern) {
this.searchScope= searchScope;
this.pattern= pattern;
}
/**
* Returns whether elements of the given project or jar can see the given focus (an IJavaProject
* or a JarPackageFragmentRot) either because the focus is part of the project or the jar, or
* because it is accessible throught the project's classpath
*/
public static boolean canSeeFocus(SearchPattern pattern, IPath projectOrJarPath) {
try {
IJavaModel model= JavaModelManager.getJavaModelManager().getJavaModel();
IJavaProject project= getJavaProject(projectOrJarPath, model);
IJavaElement[] focuses= getFocusedElements(pattern, project);
if (focuses.length == 0)
return false;
if (project != null) {
return canSeeFocus(focuses, (JavaProject)project, null);
}
// projectOrJarPath is a jar
// it can see the focus only if it is on the classpath of a project that can see the focus
IJavaProject[] allProjects= model.getJavaProjects();
for (int i= 0, length= allProjects.length; i < length; i++) {
JavaProject otherProject= (JavaProject)allProjects[i];
IClasspathEntry entry= otherProject.getClasspathEntryFor(projectOrJarPath);
if (entry != null && entry.getEntryKind() == IClasspathEntry.CPE_LIBRARY) {
if (canSeeFocus(focuses, otherProject, null)) {
return true;
}
}
}
return false;
} catch (JavaModelException e) {
return false;
}
}
private static boolean canSeeFocus(IJavaElement[] focuses, JavaProject javaProject, char[][] focusQualifiedName) {
int length= focuses.length;
for (int i= 0; i < length; i++) {
if (canSeeFocus(focuses[i], javaProject, focusQualifiedName))
return true;
}
return false;
}
private static boolean canSeeFocus(IJavaElement focus, JavaProject javaProject, char[][] focusQualifiedName) {
try {
if (focus == null)
return false;
if (focus.equals(javaProject))
return true;
if (focus instanceof JarPackageFragmentRoot) {
// focus is part of a jar
IPath focusPath= focus.getPath();
IClasspathEntry[] entries= javaProject.getExpandedClasspath();
for (int i= 0, length= entries.length; i < length; i++) {
IClasspathEntry entry= entries[i];
if (entry.getEntryKind() == IClasspathEntry.CPE_LIBRARY && entry.getPath().equals(focusPath))
return true;
}
return false;
}
// look for dependent projects
IPath focusPath= ((JavaProject)focus).getProject().getFullPath();
IClasspathEntry[] entries= javaProject.getExpandedClasspath();
for (int i= 0, length= entries.length; i < length; i++) {
IClasspathEntry entry= entries[i];
if (entry.getEntryKind() == IClasspathEntry.CPE_PROJECT && entry.getPath().equals(focusPath)) {
if (focusQualifiedName != null) { // builder state is usable, hence use it to try to reduce project which can see the focus...
State projectState= (State)JavaModelManager.getJavaModelManager().getLastBuiltState(javaProject.getProject(), null);
if (projectState != null) {
Object[] values= projectState.getReferences().valueTable;
int vLength= values.length;
for (int j= 0; j < vLength; j++) {
if (values[j] == null)
continue;
ReferenceCollection references= (ReferenceCollection)values[j];
if (references.includes(focusQualifiedName)) {
return true;
}
}
return false;
}
}
return true;
}
}
return false;
} catch (JavaModelException e) {
return false;
}
}
/*
* Create the list of focused jars or projects.
*/
private static IJavaElement[] getFocusedElements(SearchPattern pattern, IJavaElement focusElement) throws JavaModelException {
if (pattern instanceof MethodPattern) {
// For method pattern, it needs to walk along the focus type super hierarchy
// and add jars/projects of all the encountered types.
IType type= (IType)pattern.focus.getAncestor(IJavaElement.TYPE);
MethodPattern methodPattern= (MethodPattern)pattern;
String selector= new String(methodPattern.selector);
int parameterCount= methodPattern.parameterCount;
ITypeHierarchy superHierarchy= type.newSupertypeHierarchy(null);
IType[] allTypes= superHierarchy.getAllSupertypes(type);
int length= allTypes.length;
SimpleSet focusSet= new SimpleSet(length + 1);
if (focusElement != null)
focusSet.add(focusElement);
for (int i= 0; i < length; i++) {
IMethod[] methods= allTypes[i].getMethods();
int mLength= methods.length;
for (int m= 0; m < mLength; m++) {
if (parameterCount == methods[m].getNumberOfParameters() && methods[m].getElementName().equals(selector)) {
IPackageFragmentRoot root= (IPackageFragmentRoot)allTypes[i].getAncestor(IJavaElement.PACKAGE_FRAGMENT_ROOT);
IJavaElement element= root.isArchive() ? root : root.getParent();
focusSet.add(element);
}
}
}
// Rebuilt a contiguous array
IJavaElement[] focuses= new IJavaElement[focusSet.elementSize];
Object[] values= focusSet.values;
int count= 0;
for (int i= values.length; --i >= 0;) {
if (values[i] != null) {
focuses[count++]= (IJavaElement)values[i];
}
}
return focuses;
}
if (focusElement == null)
return new IJavaElement[0];
return new IJavaElement[] { focusElement };
}
/*
* Compute the list of paths which are keying index files.
*/
private void initializeIndexLocations() {
IPath[] projectsAndJars= this.searchScope.enclosingProjectsAndJars();
IndexManager manager= JavaModelManager.getIndexManager();
SimpleSet locations= new SimpleSet();
IJavaElement focus= MatchLocator.projectOrJarFocus(this.pattern);
if (focus == null) {
for (int i= 0; i < projectsAndJars.length; i++) {
IPath path= projectsAndJars[i];
Object target= JavaModel.getTarget(path, false/*don't check existence*/);
if (target instanceof IFolder) // case of an external folder
path= ((IFolder)target).getFullPath();
locations.add(manager.computeIndexLocation(path));
}
} else {
try {
// See whether the state builder might be used to reduce the number of index locations
boolean isAutoBuilding= ResourcesPlugin.getWorkspace().getDescription().isAutoBuilding();
char[][] focusQualifiedName= null;
if (isAutoBuilding && focus instanceof IJavaProject) {
IJavaElement javaElement= this.pattern.focus;
while (javaElement != null && !(javaElement instanceof ITypeRoot)) {
javaElement= javaElement.getParent();
}
if (javaElement != null) {
IType primaryType= ((ITypeRoot)javaElement).findPrimaryType();
if (primaryType != null) {
char[][] qualifiedName= CharOperation.splitOn('.', primaryType.getFullyQualifiedName().toCharArray());
char[][][] qualifiedNames= ReferenceCollection.internQualifiedNames(new char[][][] { qualifiedName });
focusQualifiedName= qualifiedNames.length == 0 ? qualifiedName : qualifiedNames[0];
}
}
}
// find the projects from projectsAndJars that see the focus then walk those projects looking for the jars from projectsAndJars
int length= projectsAndJars.length;
JavaProject[] projectsCanSeeFocus= new JavaProject[length];
SimpleSet visitedProjects= new SimpleSet(length);
int projectIndex= 0;
SimpleSet externalLibsToCheck= new SimpleSet(length);
IJavaElement[] focuses= getFocusedElements(this.pattern, focus);
IJavaModel model= JavaModelManager.getJavaModelManager().getJavaModel();
for (int i= 0; i < length; i++) {
IPath path= projectsAndJars[i];
JavaProject project= (JavaProject)getJavaProject(path, model);
if (project != null) {
visitedProjects.add(project);
if (canSeeFocus(focuses, project, focusQualifiedName)) {
locations.add(manager.computeIndexLocation(path));
projectsCanSeeFocus[projectIndex++]= project;
}
} else {
externalLibsToCheck.add(path);
}
}
for (int i= 0; i < projectIndex && externalLibsToCheck.elementSize > 0; i++) {
IClasspathEntry[] entries= projectsCanSeeFocus[i].getResolvedClasspath();
for (int j= entries.length; --j >= 0;) {
IClasspathEntry entry= entries[j];
if (entry.getEntryKind() == IClasspathEntry.CPE_LIBRARY) {
IPath path= entry.getPath();
if (externalLibsToCheck.remove(path) != null) {
Object target= JavaModel.getTarget(path, false/*don't check existence*/);
if (target instanceof IFolder) // case of an external folder
path= ((IFolder)target).getFullPath();
locations.add(manager.computeIndexLocation(path));
}
}
}
}
// jar files can be included in the search scope without including one of the projects that references them, so scan all projects that have not been visited
if (externalLibsToCheck.elementSize > 0) {
IJavaProject[] allProjects= model.getJavaProjects();
for (int i= 0, l= allProjects.length; i < l && externalLibsToCheck.elementSize > 0; i++) {
JavaProject project= (JavaProject)allProjects[i];
if (!visitedProjects.includes(project)) {
IClasspathEntry[] entries= project.getResolvedClasspath();
for (int j= entries.length; --j >= 0;) {
IClasspathEntry entry= entries[j];
if (entry.getEntryKind() == IClasspathEntry.CPE_LIBRARY) {
IPath path= entry.getPath();
if (externalLibsToCheck.remove(path) != null) {
Object target= JavaModel.getTarget(path, false/*don't check existence*/);
if (target instanceof IFolder) // case of an external folder
path= ((IFolder)target).getFullPath();
locations.add(manager.computeIndexLocation(path));
}
}
}
}
}
}
} catch (JavaModelException e) {
// ignored
}
}
this.indexLocations= new IPath[locations.elementSize];
Object[] values= locations.values;
int count= 0;
for (int i= values.length; --i >= 0;)
if (values[i] != null)
this.indexLocations[count++]= (IPath)values[i];
}
public IPath[] getIndexLocations() {
if (this.indexLocations == null) {
initializeIndexLocations();
}
return this.indexLocations;
}
/**
* Returns the java project that corresponds to the given path. Returns null if the path doesn't
* correspond to a project.
*/
private static IJavaProject getJavaProject(IPath path, IJavaModel model) {
IJavaProject project= model.getJavaProject(path.lastSegment());
if (project.exists()) {
return project;
}
return null;
}
}