1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*
* 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);
}
}
|
