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
156
157
158
159
160
161
162
163
164
|
/*
* 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 com.intellij.lang.properties;
import com.intellij.codeInsight.FileModificationService;
import com.intellij.codeInspection.CustomSuppressableInspectionTool;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.SuppressIntentionAction;
import com.intellij.lang.properties.psi.PropertiesFile;
import com.intellij.lang.properties.psi.PropertiesList;
import com.intellij.lang.properties.psi.Property;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.IncorrectOperationException;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
/**
* User: cdr
*/
public abstract class PropertySuppressableInspectionBase extends LocalInspectionTool implements CustomSuppressableInspectionTool {
private static final Logger LOG = Logger.getInstance("#com.intellij.lang.properties.PropertySuppressableInspectionBase");
@NotNull
public String getGroupDisplayName() {
return PropertiesBundle.message("properties.files.inspection.group.display.name");
}
public SuppressIntentionAction[] getSuppressActions(final PsiElement element) {
return new SuppressIntentionAction[] {new SuppressSinglePropertyFix(getShortName()), new SuppressForFile(getShortName())};
}
public boolean isSuppressedFor(@NotNull PsiElement element) {
Property property = PsiTreeUtil.getParentOfType(element, Property.class, false);
PropertiesFile file;
if (property == null) {
PsiFile containingFile = element.getContainingFile();
if (containingFile instanceof PropertiesFile) {
file = (PropertiesFile)containingFile;
}
else {
return false;
}
}
else {
PsiElement prev = property.getPrevSibling();
while (prev instanceof PsiWhiteSpace || prev instanceof PsiComment) {
if (prev instanceof PsiComment) {
@NonNls String text = prev.getText();
if (text.contains("suppress") && text.contains("\"" + getShortName() + "\"")) return true;
}
prev = prev.getPrevSibling();
}
file = property.getPropertiesFile();
}
PsiElement leaf = file.getContainingFile().findElementAt(0);
while (leaf instanceof PsiWhiteSpace) leaf = leaf.getNextSibling();
while (leaf instanceof PsiComment) {
@NonNls String text = leaf.getText();
if (text.contains("suppress") && text.contains("\"" + getShortName() + "\"") && text.contains("file")) {
return true;
}
leaf = leaf.getNextSibling();
if (leaf instanceof PsiWhiteSpace) leaf = leaf.getNextSibling();
// comment before first property get bound to the file, not property
if (leaf instanceof PropertiesList && leaf.getFirstChild() == property && text.contains("suppress") && text.contains("\"" + getShortName() + "\"")) {
return true;
}
}
return false;
}
private static class SuppressSinglePropertyFix extends SuppressIntentionAction {
private final String shortName;
public SuppressSinglePropertyFix(String shortName) {
this.shortName = shortName;
}
@NotNull
public String getText() {
return PropertiesBundle.message("unused.property.suppress.for.property");
}
@NotNull
public String getFamilyName() {
return PropertiesBundle.message("unused.property.suppress.for.property");
}
public boolean isAvailable(@NotNull final Project project, final Editor editor, @NotNull final PsiElement element) {
final Property property = PsiTreeUtil.getParentOfType(element, Property.class);
return property != null && property.isValid();
}
public void invoke(@NotNull final Project project, final Editor editor, @NotNull final PsiElement element) throws IncorrectOperationException {
final PsiFile file = element.getContainingFile();
if (!FileModificationService.getInstance().prepareFileForWrite(file)) return;
final Property property = PsiTreeUtil.getParentOfType(element, Property.class);
LOG.assertTrue(property != null);
final int start = property.getTextRange().getStartOffset();
@NonNls final Document doc = PsiDocumentManager.getInstance(project).getDocument(file);
LOG.assertTrue(doc != null);
final int line = doc.getLineNumber(start);
final int lineStart = doc.getLineStartOffset(line);
doc.insertString(lineStart, "# suppress inspection \"" + shortName +
"\"\n");
}
}
private static class SuppressForFile extends SuppressIntentionAction {
private final String shortName;
public SuppressForFile(String shortName) {
this.shortName = shortName;
}
@NotNull
public String getText() {
return PropertiesBundle.message("unused.property.suppress.for.file");
}
@NotNull
public String getFamilyName() {
return PropertiesBundle.message("unused.property.suppress.for.file");
}
public boolean isAvailable(@NotNull final Project project, final Editor editor, @NotNull final PsiElement element) {
return element.isValid() && element.getContainingFile() instanceof PropertiesFile;
}
public void invoke(@NotNull final Project project, final Editor editor, @NotNull final PsiElement element) throws IncorrectOperationException {
final PsiFile file = element.getContainingFile();
if (!FileModificationService.getInstance().prepareFileForWrite(file)) return;
@NonNls final Document doc = PsiDocumentManager.getInstance(project).getDocument(file);
LOG.assertTrue(doc != null, file);
doc.insertString(0, "# suppress inspection \"" +
shortName +
"\" for whole file\n");
}
}
}
|
