/*
* Copyright 2000-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.codeInsight.navigation;
import com.intellij.codeInsight.CodeInsightBundle;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.progress.ProgressManager;
import com.intellij.openapi.project.DumbService;
import com.intellij.openapi.project.IndexNotReadyException;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Computable;
import com.intellij.psi.PsiElement;
import com.intellij.psi.search.PsiElementProcessor;
import com.intellij.psi.search.PsiElementProcessorAdapter;
import com.intellij.psi.search.SearchScope;
import com.intellij.psi.search.searches.DefinitionsScopedSearch;
import com.intellij.util.ArrayUtil;
import com.intellij.util.CommonProcessors;
import com.intellij.util.Query;
import com.intellij.util.containers.ContainerUtil;
import consulo.codeInsight.TargetElementUtil;
import consulo.codeInsight.TargetElementUtilEx;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Set;
public class ImplementationSearcher {
public static final String SEARCHING_FOR_IMPLEMENTATIONS = CodeInsightBundle.message("searching.for.implementations");
@Nullable
PsiElement[] searchImplementations(Editor editor, PsiElement element, int offset) {
boolean onRef = ApplicationManager.getApplication().runReadAction((Computable<Boolean>)() -> {
Set<String> flags = ContainerUtil.newHashSet(getFlags());
flags.remove(TargetElementUtilEx.REFERENCED_ELEMENT_ACCEPTED);
flags.remove(TargetElementUtilEx.LOOKUP_ITEM_ACCEPTED);
return TargetElementUtil.findTargetElement(editor, flags, offset) == null;
});
return searchImplementations(element, editor, onRef &&
ApplicationManager.getApplication().runReadAction((Computable<Boolean>)() -> element == null ||
TargetElementUtil
.includeSelfInGotoImplementation(
element)),
onRef);
}
@Nullable
public PsiElement[] searchImplementations(PsiElement element, Editor editor, boolean includeSelfAlways, boolean includeSelfIfNoOthers) {
if (element == null) return PsiElement.EMPTY_ARRAY;
PsiElement[] elements = searchDefinitions(element, editor);
if (elements == null) return null; //the search has been cancelled
if (elements.length > 0) return filterElements(element, includeSelfAlways ? ArrayUtil.prepend(element, elements) : elements);
if (includeSelfAlways || includeSelfIfNoOthers) return new PsiElement[]{element};
return PsiElement.EMPTY_ARRAY;
}
protected static SearchScope getSearchScope(PsiElement element, Editor editor) {
return ApplicationManager.getApplication().runReadAction((Computable<SearchScope>)() -> TargetElementUtil.getSearchScope(editor, element));
}
@Nullable("For the case the search has been cancelled")
protected PsiElement[] searchDefinitions(PsiElement element, Editor editor) {
PsiElement[][] result = new PsiElement[1][];
if (!ProgressManager.getInstance().runProcessWithProgressSynchronously(() -> {
try {
result[0] = search(element, editor).toArray(PsiElement.EMPTY_ARRAY);
}
catch (IndexNotReadyException e) {
dumbModeNotification(element);
result[0] = null;
}
}, SEARCHING_FOR_IMPLEMENTATIONS, true, element.getProject())) {
return null;
}
return result[0];
}
protected Query<PsiElement> search(PsiElement element, Editor editor) {
return DefinitionsScopedSearch.search(element, getSearchScope(element, editor), isSearchDeep());
}
protected boolean isSearchDeep() {
return true;
}
private static void dumbModeNotification(@NotNull PsiElement element) {
Project project = ApplicationManager.getApplication().runReadAction((Computable<Project>)() -> element.getProject());
DumbService.getInstance(project).showDumbModeNotification("Implementation information isn't available while indices are built");
}
protected PsiElement[] filterElements(PsiElement element, PsiElement[] targetElements) {
return targetElements;
}
@NotNull
public static Set<String> getFlags() {
return TargetElementUtil.getDefinitionSearchFlags();
}
public static class FirstImplementationsSearcher extends ImplementationSearcher {
@Override
protected PsiElement[] searchDefinitions(PsiElement element, Editor editor) {
if (canShowPopupWithOneItem(element)) {
return new PsiElement[]{element};
}
PsiElementProcessor.FindElement<PsiElement> collectProcessor = new PsiElementProcessor.FindElement<>();
PsiElement[] result = new PsiElement[1];
if (!ProgressManager.getInstance().runProcessWithProgressSynchronously(new Runnable() {
@Override
public void run() {
try {
search(element, editor).forEach(new PsiElementProcessorAdapter<PsiElement>(collectProcessor) {
@Override
public boolean processInReadAction(PsiElement element) {
return !accept(element) || super.processInReadAction(element);
}
});
result[0] = collectProcessor.getFoundElement();
}
catch (IndexNotReadyException e) {
ImplementationSearcher.dumbModeNotification(element);
result[0] = null;
}
}
}, SEARCHING_FOR_IMPLEMENTATIONS, true, element.getProject())) {
return null;
}
PsiElement foundElement = result[0];
return foundElement != null ? new PsiElement[]{foundElement} : PsiElement.EMPTY_ARRAY;
}
protected boolean canShowPopupWithOneItem(PsiElement element) {
return accept(element);
}
protected boolean accept(PsiElement element) {
return true;
}
}
public abstract static class BackgroundableImplementationSearcher extends ImplementationSearcher {
@Override
protected PsiElement[] searchDefinitions(PsiElement element, Editor editor) {
CommonProcessors.CollectProcessor<PsiElement> processor = new CommonProcessors.CollectProcessor<PsiElement>() {
@Override
public boolean process(PsiElement element) {
processElement(element);
return super.process(element);
}
};
try {
search(element, editor).forEach(processor);
}
catch (IndexNotReadyException e) {
ImplementationSearcher.dumbModeNotification(element);
return null;
}
return processor.toArray(PsiElement.EMPTY_ARRAY);
}
protected abstract void processElement(PsiElement element);
}
}