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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/*
* Copyright 2003-2013 Dave Griffith, Bas Leijdekkers
*
* 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.siyeh.ig;
import com.intellij.codeInspection.ProblemHighlightType;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.*;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
public abstract class BaseInspectionVisitor extends JavaElementVisitor {
private BaseInspection inspection = null;
private boolean onTheFly = false;
private ProblemsHolder holder = null;
final void setInspection(BaseInspection inspection) {
this.inspection = inspection;
}
final void setOnTheFly(boolean onTheFly) {
this.onTheFly = onTheFly;
}
public final boolean isOnTheFly() {
return onTheFly;
}
protected final void registerNewExpressionError(
@NotNull PsiNewExpression expression, Object... infos) {
final PsiJavaCodeReferenceElement classReference =
expression.getClassOrAnonymousClassReference();
if (classReference == null) {
registerError(expression, infos);
}
else {
registerError(classReference, infos);
}
}
protected final void registerMethodCallError(
@NotNull PsiMethodCallExpression expression,
@NonNls Object... infos) {
final PsiReferenceExpression methodExpression =
expression.getMethodExpression();
final PsiElement nameToken = methodExpression.getReferenceNameElement();
if (nameToken == null) {
registerError(expression, infos);
}
else {
registerError(nameToken, infos);
}
}
protected final void registerStatementError(@NotNull PsiStatement statement,
Object... infos) {
final PsiElement statementToken = statement.getFirstChild();
if (statementToken == null) {
registerError(statement, infos);
}
else {
registerError(statementToken, infos);
}
}
protected final void registerClassError(@NotNull PsiClass aClass,
Object... infos) {
PsiElement nameIdentifier;
if (aClass instanceof PsiEnumConstantInitializer) {
final PsiEnumConstantInitializer enumConstantInitializer =
(PsiEnumConstantInitializer)aClass;
final PsiEnumConstant enumConstant =
enumConstantInitializer.getEnumConstant();
nameIdentifier = enumConstant.getNameIdentifier();
}
else if (aClass instanceof PsiAnonymousClass) {
final PsiAnonymousClass anonymousClass = (PsiAnonymousClass)aClass;
nameIdentifier = anonymousClass.getBaseClassReference();
}
else {
nameIdentifier = aClass.getNameIdentifier();
}
if (nameIdentifier != null && !nameIdentifier.isPhysical()) {
nameIdentifier = nameIdentifier.getNavigationElement();
}
if (nameIdentifier == null || !nameIdentifier.isPhysical()) {
registerError(aClass.getContainingFile(), infos);
}
else {
registerError(nameIdentifier, infos);
}
}
protected final void registerMethodError(@NotNull PsiMethod method,
Object... infos) {
final PsiElement nameIdentifier = method.getNameIdentifier();
if (nameIdentifier == null) {
registerError(method.getContainingFile(), infos);
}
else {
registerError(nameIdentifier, infos);
}
}
protected final void registerVariableError(@NotNull PsiVariable variable,
Object... infos) {
final PsiElement nameIdentifier = variable.getNameIdentifier();
if (nameIdentifier == null) {
registerError(variable, infos);
}
else {
registerError(nameIdentifier, infos);
}
}
protected final void registerTypeParameterError(
@NotNull PsiTypeParameter typeParameter, Object... infos) {
final PsiElement nameIdentifier = typeParameter.getNameIdentifier();
if (nameIdentifier == null) {
registerError(typeParameter, infos);
}
else {
registerError(nameIdentifier, infos);
}
}
protected final void registerFieldError(@NotNull PsiField field,
Object... infos) {
final PsiElement nameIdentifier = field.getNameIdentifier();
registerError(nameIdentifier, infos);
}
protected final void registerModifierError(
@NotNull String modifier, @NotNull PsiModifierListOwner parameter,
Object... infos) {
final PsiModifierList modifiers = parameter.getModifierList();
if (modifiers == null) {
return;
}
final PsiElement[] children = modifiers.getChildren();
for (final PsiElement child : children) {
final String text = child.getText();
if (modifier.equals(text)) {
registerError(child, infos);
}
}
}
protected final void registerClassInitializerError(
@NotNull PsiClassInitializer initializer, Object... infos) {
final PsiCodeBlock body = initializer.getBody();
final PsiJavaToken lBrace = body.getLBrace();
if (lBrace == null) {
registerError(initializer, infos);
}
else {
registerError(lBrace, infos);
}
}
protected final void registerError(@NotNull PsiElement location,
Object... infos) {
registerError(location, ProblemHighlightType.GENERIC_ERROR_OR_WARNING, infos);
}
protected final void registerError(@NotNull PsiElement location,
final ProblemHighlightType highlightType,
Object... infos) {
if (location.getTextLength() == 0 && !(location instanceof PsiFile)) {
return;
}
final InspectionGadgetsFix[] fixes = createFixes(infos);
for (InspectionGadgetsFix fix : fixes) {
fix.setOnTheFly(onTheFly);
}
final String description = inspection.buildErrorString(infos);
holder.registerProblem(location, description, highlightType, fixes);
}
protected final void registerErrorAtOffset(@NotNull PsiElement location,
int offset, int length, Object... infos) {
if (location.getTextLength() == 0 || length == 0) {
return;
}
final InspectionGadgetsFix[] fixes = createFixes(infos);
for (InspectionGadgetsFix fix : fixes) {
fix.setOnTheFly(onTheFly);
}
final String description = inspection.buildErrorString(infos);
final TextRange range = new TextRange(offset, offset + length);
holder.registerProblem(location, range, description, fixes);
}
@NotNull
private InspectionGadgetsFix[] createFixes(Object... infos) {
if (!onTheFly && inspection.buildQuickFixesOnlyForOnTheFlyErrors()) {
return InspectionGadgetsFix.EMPTY_ARRAY;
}
final InspectionGadgetsFix[] fixes = inspection.buildFixes(infos);
if (fixes.length > 0) {
return fixes;
}
final InspectionGadgetsFix fix = inspection.buildFix(infos);
if (fix == null) {
return InspectionGadgetsFix.EMPTY_ARRAY;
}
return new InspectionGadgetsFix[]{fix};
}
@Override
public void visitReferenceExpression(PsiReferenceExpression expression) {
visitExpression(expression);
}
public final void setProblemsHolder(ProblemsHolder holder) {
this.holder = holder;
}
}
|
