| /* |
| * Copyright 2000-2014 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 org.jetbrains.idea.devkit.navigation; |
| |
| import com.intellij.codeInsight.daemon.RelatedItemLineMarkerInfo; |
| import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder; |
| import com.intellij.icons.AllIcons; |
| import com.intellij.navigation.GotoRelatedItem; |
| import com.intellij.openapi.editor.markup.GutterIconRenderer; |
| import com.intellij.openapi.module.Module; |
| import com.intellij.openapi.module.ModuleUtilCore; |
| import com.intellij.openapi.util.text.StringUtil; |
| import com.intellij.psi.PsiClass; |
| import com.intellij.psi.PsiDirectory; |
| import com.intellij.psi.PsiElement; |
| import com.intellij.psi.PsiFile; |
| import com.intellij.psi.util.InheritanceUtil; |
| import com.intellij.util.NotNullFunction; |
| import com.intellij.util.containers.ContainerUtil; |
| import com.intellij.util.containers.SortedList; |
| import org.jetbrains.annotations.NotNull; |
| import org.jetbrains.idea.devkit.inspections.DescriptionCheckerUtil; |
| import org.jetbrains.idea.devkit.inspections.DescriptionType; |
| import org.jetbrains.idea.devkit.inspections.InspectionDescriptionInfo; |
| import org.jetbrains.idea.devkit.util.PsiUtil; |
| |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.Comparator; |
| import java.util.List; |
| |
| public class DescriptionTypeRelatedItemLineMarkerProvider extends DevkitRelatedLineMarkerProviderBase { |
| |
| private static final NotNullFunction<PsiFile, Collection<? extends PsiElement>> CONVERTER = |
| new NotNullFunction<PsiFile, Collection<? extends PsiElement>>() { |
| @NotNull |
| @Override |
| public Collection<? extends PsiElement> fun(PsiFile psiFile) { |
| return ContainerUtil.createMaybeSingletonList(psiFile); |
| } |
| }; |
| |
| private static final NotNullFunction<PsiFile, Collection<? extends GotoRelatedItem>> RELATED_ITEM_PROVIDER = |
| new NotNullFunction<PsiFile, Collection<? extends GotoRelatedItem>>() { |
| @NotNull |
| @Override |
| public Collection<? extends GotoRelatedItem> fun(PsiFile psiFile) { |
| return GotoRelatedItem.createItems(Collections.singleton(psiFile), "DevKit"); |
| } |
| }; |
| |
| @Override |
| protected void collectNavigationMarkers(@NotNull PsiElement element, Collection<? super RelatedItemLineMarkerInfo> result) { |
| if (element instanceof PsiClass) { |
| process((PsiClass)element, result); |
| } |
| } |
| |
| private static void process(PsiClass psiClass, Collection<? super RelatedItemLineMarkerInfo> result) { |
| if (!PsiUtil.isInstantiable(psiClass)) return; |
| |
| Module module = ModuleUtilCore.findModuleForPsiElement(psiClass); |
| if (module == null) return; |
| |
| PsiElement highlightingElement = psiClass.getNameIdentifier(); |
| if (highlightingElement == null) return; |
| |
| for (DescriptionType type : DescriptionType.values()) { |
| if (!InheritanceUtil.isInheritor(psiClass, type.getClassName())) { |
| continue; |
| } |
| |
| String descriptionDirName = DescriptionCheckerUtil.getDescriptionDirName(psiClass); |
| if (StringUtil.isEmptyOrSpaces(descriptionDirName)) { |
| return; |
| } |
| |
| if (type == DescriptionType.INSPECTION) { |
| final InspectionDescriptionInfo info = InspectionDescriptionInfo.create(module, psiClass); |
| if (info.hasDescriptionFile()) { |
| addDescriptionFileGutterIcon(highlightingElement, info.getDescriptionFile(), result); |
| } |
| return; |
| } |
| |
| for (PsiDirectory descriptionDir : DescriptionCheckerUtil.getDescriptionsDirs(module, type)) { |
| PsiDirectory dir = descriptionDir.findSubdirectory(descriptionDirName); |
| if (dir == null) continue; |
| final PsiFile descriptionFile = dir.findFile("description.html"); |
| if (descriptionFile != null) { |
| addDescriptionFileGutterIcon(highlightingElement, descriptionFile, result); |
| |
| addBeforeAfterTemplateFilesGutterIcon(highlightingElement, dir, result); |
| return; |
| } |
| } |
| return; |
| } |
| } |
| |
| private static void addDescriptionFileGutterIcon(PsiElement highlightingElement, |
| PsiFile descriptionFile, |
| Collection<? super RelatedItemLineMarkerInfo> result) { |
| final RelatedItemLineMarkerInfo<PsiElement> info = NavigationGutterIconBuilder |
| .create(AllIcons.FileTypes.Html, CONVERTER, RELATED_ITEM_PROVIDER) |
| .setTarget(descriptionFile) |
| .setTooltipText("Description") |
| .setAlignment(GutterIconRenderer.Alignment.RIGHT) |
| .createLineMarkerInfo(highlightingElement); |
| result.add(info); |
| } |
| |
| private static void addBeforeAfterTemplateFilesGutterIcon(PsiElement highlightingElement, |
| PsiDirectory descriptionDirectory, |
| Collection<? super RelatedItemLineMarkerInfo> result) { |
| final List<PsiFile> templateFiles = new SortedList<PsiFile>(new Comparator<PsiFile>() { |
| @Override |
| public int compare(PsiFile o1, PsiFile o2) { |
| return o1.getName().compareTo(o2.getName()); |
| } |
| }); |
| for (PsiFile file : descriptionDirectory.getFiles()) { |
| final String fileName = file.getName(); |
| if (fileName.endsWith(".template")) { |
| if (fileName.startsWith("after.") || |
| fileName.startsWith("before.")) { |
| templateFiles.add(file); |
| } |
| } |
| } |
| if (templateFiles.isEmpty()) return; |
| |
| final RelatedItemLineMarkerInfo<PsiElement> info = NavigationGutterIconBuilder |
| .create(AllIcons.Actions.Diff, CONVERTER, RELATED_ITEM_PROVIDER) |
| .setTargets(templateFiles) |
| .setPopupTitle("Select Template") |
| .setTooltipText("Before/After Templates") |
| .setAlignment(GutterIconRenderer.Alignment.RIGHT) |
| .createLineMarkerInfo(highlightingElement); |
| result.add(info); |
| } |
| } |