MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

IDEA-169924 API: move breadcrumbs provider to platform

Browse Source
This commit is contained in:
Sergey Malenkov
2017-04-18 18:15:04 +03:00
parent c40ebdd86f
commit 5ee01073bb
9 changed files with 128 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/editor-ui-api/src/com/intellij/ui/breadcrumbs/BreadcrumbsProvider.java
+89
View File
@@ -0,0 +1,89 @@
/*
* Copyright 2000-2017 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.ui.breadcrumbs;
import com.intellij.lang.Language;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.psi.PsiElement;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.Icon;
import java.util.List;
import static java.util.Collections.emptyList;
/**
* @author Alexey.Pegov
* @author Sergey.Malenkov
*/
public interface BreadcrumbsProvider {
ExtensionPointName<BreadcrumbsProvider> EP_NAME = ExtensionPointName.create("com.intellij.breadcrumbsInfoProvider");
/**
* @return an array of languages supported by this provider
*/
Language[] getLanguages();
/**
* @param element that represents a single crumb
* @return {@code true} if the specified element is supported by this provider
*/
boolean acceptElement(@NotNull PsiElement element);
/**
* @param element that represents a single crumb
* @return a text for the specified element
*/
@NotNull
String getElementInfo(@NotNull PsiElement element);
/**
* @param element that represents a single crumb
* @return an icon for the specified element
*/
@Nullable
default Icon getElementIcon(@NotNull PsiElement element) {
return null;
}
/**
* @param element that represents a single crumb
* @return a description for the specified element
*/
@Nullable
default String getElementTooltip(@NotNull PsiElement element) {
return null;
}
/**
* @param element that represents a single crumb
* @return an element that represents a parent crumb, or {@code null}
*/
@Nullable
default PsiElement getParent(@NotNull PsiElement element) {
return element.getParent();
}
/**
* @param element that represents a single crumb
* @return a list of elements to navigate
*/
@NotNull
default List<PsiElement> getChildren(@NotNull PsiElement element) {
return emptyList();
}
}
platform/platform-resources/src/META-INF/LangExtensionPoints.xml
+3
View File
@@ -906,6 +906,9 @@
<extensionPoint name="longLineInspectionPolicy" interface="com.intellij.codeInspection.longLine.LongLineInspectionPolicy"/>
<extensionPoint qualifiedName="org.jetbrains.uast.uastLanguagePlugin"
interface="org.jetbrains.uast.UastLanguagePlugin"/>
<extensionPoint name="breadcrumbsInfoProvider" interface="com.intellij.ui.breadcrumbs.BreadcrumbsProvider"/>
</extensionPoints>
</idea-plugin>
platform/platform-resources/src/META-INF/XmlPlugin.xml
-2
View File
@@ -50,8 +50,6 @@
<extensionPoint name="xml.nsColorProvider"
interface="com.intellij.codeInsight.daemon.impl.analysis.XmlNSColorProvider"/>
<extensionPoint name="breadcrumbsInfoProvider" interface="com.intellij.xml.breadcrumbs.BreadcrumbsInfoProvider"/>
<extensionPoint name="breadcrumbsPresentationProvider" interface="com.intellij.xml.breadcrumbs.BreadcrumbsPresentationProvider"/>
<extensionPoint name="xmlStructureViewElementProvider"
plugins/yaml/testSrc/org/jetbrains/yaml/breadcrumbs/YAMLBreadcrumbsTest.java
+3 -3
View File
@@ -18,12 +18,11 @@ package org.jetbrains.yaml.breadcrumbs;
import com.intellij.lang.Language;
import com.intellij.openapi.editor.Caret;
import com.intellij.openapi.editor.CaretModel;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.psi.PsiElement;
import com.intellij.testFramework.fixtures.CodeInsightTestFixture;
import com.intellij.testFramework.fixtures.LightPlatformCodeInsightFixtureTestCase;
import com.intellij.ui.breadcrumbs.BreadcrumbsProvider;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.xml.breadcrumbs.BreadcrumbsInfoProvider;
import com.intellij.xml.breadcrumbs.BreadcrumbsItem;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -100,7 +99,8 @@ public class YAMLBreadcrumbsTest extends LightPlatformCodeInsightFixtureTestCase
}
final Language language = element.getContainingFile().getLanguage();
final BreadcrumbsInfoProvider provider = BreadcrumbsInfoProvider.find(language::equals);
final BreadcrumbsProvider provider = ContainerUtil.find(BreadcrumbsProvider.EP_NAME.getExtensions(),
(p) -> Arrays.asList(p.getLanguages()).contains(language));
if (provider == null) {
return Collections.emptyList();
}
xml/impl/src/com/intellij/codeInsight/daemon/impl/tagTreeHighlighting/XmlTagTreeHighlightingPass.java
+2 -2
View File
@@ -44,7 +44,7 @@ import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.psi.xml.XmlChildRole;
import com.intellij.psi.xml.XmlTag;
import com.intellij.psi.xml.XmlTokenType;
import com.intellij.xml.breadcrumbs.BreadcrumbsInfoProvider;
import com.intellij.ui.breadcrumbs.BreadcrumbsProvider;
import com.intellij.xml.breadcrumbs.BreadcrumbsXmlWrapper;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -65,7 +65,7 @@ public class XmlTagTreeHighlightingPass extends TextEditorHighlightingPass {
private final PsiFile myFile;
private final EditorEx myEditor;
private final BreadcrumbsInfoProvider myInfoProvider;
private final BreadcrumbsProvider myInfoProvider;
private final List<Pair<TextRange, TextRange>> myPairsToHighlight = new ArrayList<>();
xml/impl/src/com/intellij/xml/breadcrumbs/BreadcrumbsConfigurable.java
+2 -1
View File
@@ -23,6 +23,7 @@ import com.intellij.openapi.editor.ex.EditorSettingsExternalizable;
import com.intellij.openapi.options.Configurable;
import com.intellij.openapi.options.ConfigurationException;
import com.intellij.openapi.options.colors.pages.GeneralColorsPage;
import com.intellij.ui.breadcrumbs.BreadcrumbsProvider;
import com.intellij.ui.components.labels.LinkLabel;
import com.intellij.ui.components.panels.HorizontalLayout;
import com.intellij.ui.components.panels.VerticalLayout;
@@ -68,7 +69,7 @@ final class BreadcrumbsConfigurable implements Configurable {
JPanel boxes = new JPanel(new VerticalLayout(0));
boxes.setBorder(JBUI.Borders.emptyLeft(20));
for (BreadcrumbsInfoProvider provider : BreadcrumbsInfoProvider.EP_NAME.getExtensions()) {
for (BreadcrumbsProvider provider : BreadcrumbsProvider.EP_NAME.getExtensions()) {
for (Language language : provider.getLanguages()) {
String id = language.getID();
if (!map.containsKey(id)) {
xml/impl/src/com/intellij/xml/breadcrumbs/BreadcrumbsXmlWrapper.java
+23 -16
View File
@@ -47,6 +47,7 @@ import com.intellij.openapi.vcs.FileStatusManager;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.*;
import com.intellij.ui.Gray;
import com.intellij.ui.breadcrumbs.BreadcrumbsProvider;
import com.intellij.ui.components.breadcrumbs.Crumb;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.ui.MouseEventAdapter;
@@ -85,7 +86,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
private final VirtualFile myFile;
private boolean myUserCaretChange = true;
private final MergingUpdateQueue myQueue = new MergingUpdateQueue("Breadcrumbs.Queue", 200, true, breadcrumbs);
private final BreadcrumbsInfoProvider myInfoProvider;
private final BreadcrumbsProvider myInfoProvider;
private final Update myUpdate = new MyUpdate(this);
public static final Key<BreadcrumbsXmlWrapper> BREADCRUMBS_COMPONENT_KEY = new Key<>("BREADCRUMBS_KEY");
@@ -235,9 +236,8 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
}
@Nullable
private static BreadcrumbsInfoProvider findProviderForElement(@NotNull final PsiElement element,
final BreadcrumbsInfoProvider defaultProvider) {
final BreadcrumbsInfoProvider provider = getInfoProvider(element.getLanguage());
private static BreadcrumbsProvider findProviderForElement(@NotNull PsiElement element, BreadcrumbsProvider defaultProvider) {
final BreadcrumbsProvider provider = getInfoProvider(element.getLanguage());
return provider == null ? defaultProvider : provider;
}
@@ -270,7 +270,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
final VirtualFile file,
final Editor editor,
final Project project,
final BreadcrumbsInfoProvider defaultInfoProvider) {
final BreadcrumbsProvider defaultInfoProvider) {
final LinkedList<PsiCrumb> result =
getLineElements(editor.logicalPositionToOffset(position), file, project, defaultInfoProvider);
@@ -289,7 +289,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
}
@Nullable
public static PsiElement[] getLinePsiElements(int offset, VirtualFile file, Project project, BreadcrumbsInfoProvider infoProvider) {
public static PsiElement[] getLinePsiElements(int offset, VirtualFile file, Project project, BreadcrumbsProvider infoProvider) {
final LinkedList<PsiCrumb> lineElements = getLineElements(offset, file, project, infoProvider);
return lineElements != null ? toPsiElementArray(lineElements) : null;
}
@@ -298,13 +298,13 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
private static LinkedList<PsiCrumb> getLineElements(final int offset,
VirtualFile file,
Project project,
BreadcrumbsInfoProvider defaultInfoProvider) {
BreadcrumbsProvider defaultInfoProvider) {
PsiElement element = findFirstBreadcrumbedElement(offset, file, project, defaultInfoProvider);
if (element == null) return null;
final LinkedList<PsiCrumb> result = new LinkedList<>();
while (element != null) {
BreadcrumbsInfoProvider provider = findProviderForElement(element, defaultInfoProvider);
BreadcrumbsProvider provider = findProviderForElement(element, defaultInfoProvider);
if (provider != null && provider.acceptElement(element)) {
result.addFirst(new PsiCrumb(element, provider));
@@ -319,7 +319,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
private static PsiElement findFirstBreadcrumbedElement(final int offset,
final VirtualFile file,
final Project project,
final BreadcrumbsInfoProvider defaultInfoProvider) {
final BreadcrumbsProvider defaultInfoProvider) {
if (file == null || !file.isValid()) return null;
PriorityQueue<PsiElement> leafs =
@@ -346,7 +346,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
final PsiElement element = leafs.remove();
if (!element.isValid()) continue;
BreadcrumbsInfoProvider provider = findProviderForElement(element, defaultInfoProvider);
BreadcrumbsProvider provider = findProviderForElement(element, defaultInfoProvider);
if (provider != null && provider.acceptElement(element)) {
return element;
}
@@ -358,7 +358,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
}
@Nullable
private static PsiElement getParent(@NotNull PsiElement element, @Nullable BreadcrumbsInfoProvider provider) {
private static PsiElement getParent(@NotNull PsiElement element, @Nullable BreadcrumbsProvider provider) {
return provider != null ? provider.getParent(element) : element.getParent();
}
@@ -380,7 +380,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
}
@Nullable
static BreadcrumbsInfoProvider findInfoProvider(VirtualFile file, Project project) {
static BreadcrumbsProvider findInfoProvider(VirtualFile file, Project project) {
return project == null ? null : findInfoProvider(findViewProvider(file, project));
}
@@ -398,7 +398,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
}
@Nullable
public static BreadcrumbsInfoProvider findInfoProvider(@Nullable FileViewProvider viewProvider) {
public static BreadcrumbsProvider findInfoProvider(@Nullable FileViewProvider viewProvider) {
if (viewProvider == null) return null;
EditorSettingsExternalizable settings = EditorSettingsExternalizable.getInstance();
@@ -407,7 +407,7 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
Language baseLang = viewProvider.getBaseLanguage();
if (!settings.isBreadcrumbsShownFor(baseLang.getID())) return null;
BreadcrumbsInfoProvider provider = getInfoProvider(baseLang);
BreadcrumbsProvider provider = getInfoProvider(baseLang);
if (provider == null) {
for (Language language : viewProvider.getLanguages()) {
if (settings.isBreadcrumbsShownFor(language.getID())) {
@@ -481,9 +481,16 @@ public class BreadcrumbsXmlWrapper extends JComponent implements Disposable {
}
@Nullable
private static BreadcrumbsInfoProvider getInfoProvider(@NotNull final Language language) {
private static BreadcrumbsProvider getInfoProvider(@NotNull Language language) {
EditorSettingsExternalizable settings = EditorSettingsExternalizable.getInstance();
return BreadcrumbsInfoProvider.find(supported -> settings.isBreadcrumbsShownFor(language.getID()) && supported.isKindOf(language));
for (BreadcrumbsProvider provider : BreadcrumbsProvider.EP_NAME.getExtensions()) {
for (Language supported : provider.getLanguages()) {
if (settings.isBreadcrumbsShownFor(language.getID()) && supported.isKindOf(language)) {
return provider;
}
}
}
return null;
}
private static class MyUpdate extends Update {
xml/impl/src/com/intellij/xml/breadcrumbs/PsiCrumb.java
+3 -2
View File
@@ -16,6 +16,7 @@
package com.intellij.xml.breadcrumbs;
import com.intellij.psi.PsiElement;
import com.intellij.ui.breadcrumbs.BreadcrumbsProvider;
import com.intellij.ui.components.breadcrumbs.Crumb;
/**
@@ -25,8 +26,8 @@ final class PsiCrumb extends Crumb.Impl {
final PsiElement element;
CrumbPresentation presentation;
PsiCrumb(PsiElement element, BreadcrumbsInfoProvider provider) {
super(null, provider.getElementInfo(element), provider.getElementTooltip(element));
PsiCrumb(PsiElement element, BreadcrumbsProvider provider) {
super(provider.getElementIcon(element), provider.getElementInfo(element), provider.getElementTooltip(element));
this.element = element;
}
xml/openapi/src/com/intellij/xml/breadcrumbs/BreadcrumbsInfoProvider.java
+3 -52
View File
@@ -14,59 +14,10 @@
* limitations under the License.
*/
/*
* Created by IntelliJ IDEA.
* User: spleaner
* Date: Jun 19, 2007
* Time: 3:33:15 PM
*/
package com.intellij.xml.breadcrumbs;
import com.intellij.lang.Language;
import com.intellij.psi.PsiElement;
import com.intellij.openapi.extensions.ExtensionPointName;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import com.intellij.ui.breadcrumbs.BreadcrumbsProvider;
import java.util.LinkedHashMap;
import java.util.function.Predicate;
public abstract class BreadcrumbsInfoProvider {
public static final ExtensionPointName<BreadcrumbsInfoProvider> EP_NAME
= ExtensionPointName.create("com.intellij.breadcrumbsInfoProvider");
public abstract Language[] getLanguages();
public abstract boolean acceptElement(@NotNull final PsiElement e);
@Nullable
public PsiElement getParent(@NotNull final PsiElement e) {
return e.getParent();
}
@NotNull
public abstract String getElementInfo(@NotNull final PsiElement e);
@Nullable
public abstract String getElementTooltip(@NotNull final PsiElement e);
@NotNull
public static Iterable<Language> getSupportedLanguages() {
LinkedHashMap<String, Language> map = new LinkedHashMap<>();
for (BreadcrumbsInfoProvider provider : EP_NAME.getExtensions()) {
for (Language language : provider.getLanguages()) {
map.put(language.getID(), language);
}
}
return map.values();
}
public static BreadcrumbsInfoProvider find(Predicate<Language> predicate) {
for (BreadcrumbsInfoProvider provider : EP_NAME.getExtensions()) {
for (Language language : provider.getLanguages()) {
if (predicate.test(language)) return provider;
}
}
return null;
}
@Deprecated
public abstract class BreadcrumbsInfoProvider implements BreadcrumbsProvider {
}