1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
package com.puppycrawl.tools.checkstyle.checks; |
20 | |
|
21 | |
import com.google.common.collect.ImmutableList; |
22 | |
import com.google.common.collect.Lists; |
23 | |
|
24 | |
import com.puppycrawl.tools.checkstyle.api.Check; |
25 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
26 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
27 | |
|
28 | |
import org.apache.commons.beanutils.ConversionException; |
29 | |
|
30 | |
import java.util.HashMap; |
31 | |
import java.util.LinkedList; |
32 | |
import java.util.List; |
33 | |
import java.util.Map; |
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | 2 | public class SuppressWarningsHolder |
41 | |
extends Check |
42 | |
{ |
43 | |
|
44 | |
|
45 | |
|
46 | |
|
47 | |
|
48 | |
|
49 | |
|
50 | |
public static final String CHECKSTYLE_PREFIX = "checkstyle:"; |
51 | |
|
52 | |
|
53 | |
private static final String JAVA_LANG_PREFIX = "java.lang."; |
54 | |
|
55 | |
|
56 | |
private static final String CHECK_SUFFIX = "Check"; |
57 | |
|
58 | |
|
59 | 1 | private static final Map<String, String> CHECK_ALIAS_MAP = |
60 | |
new HashMap<String, String>(); |
61 | |
|
62 | |
|
63 | |
|
64 | |
|
65 | |
|
66 | 1 | private static final ThreadLocal<List<Entry>> ENTRIES = |
67 | |
new ThreadLocal<List<Entry>>(); |
68 | |
|
69 | |
|
70 | 2 | private static class Entry |
71 | |
{ |
72 | |
|
73 | |
private final String mCheckName; |
74 | |
|
75 | |
private final int mFirstLine, mFirstColumn, mLastLine, mLastColumn; |
76 | |
|
77 | |
|
78 | |
|
79 | |
|
80 | |
|
81 | |
|
82 | |
|
83 | |
|
84 | |
|
85 | |
public Entry(String aCheckName, int aFirstLine, int aFirstColumn, |
86 | |
int aLastLine, int aLastColumn) |
87 | 24 | { |
88 | 24 | mCheckName = aCheckName; |
89 | 24 | mFirstLine = aFirstLine; |
90 | 24 | mFirstColumn = aFirstColumn; |
91 | 24 | mLastLine = aLastLine; |
92 | 24 | mLastColumn = aLastColumn; |
93 | 24 | } |
94 | |
|
95 | |
|
96 | |
public String getCheckName() |
97 | |
{ |
98 | 102 | return mCheckName; |
99 | |
} |
100 | |
|
101 | |
|
102 | |
public int getFirstLine() |
103 | |
{ |
104 | 126 | return mFirstLine; |
105 | |
} |
106 | |
|
107 | |
|
108 | |
public int getFirstColumn() |
109 | |
{ |
110 | 1 | return mFirstColumn; |
111 | |
} |
112 | |
|
113 | |
|
114 | |
public int getLastLine() |
115 | |
{ |
116 | 165 | return mLastLine; |
117 | |
} |
118 | |
|
119 | |
|
120 | |
public int getLastColumn() |
121 | |
{ |
122 | 5 | return mLastColumn; |
123 | |
} |
124 | |
} |
125 | |
|
126 | |
|
127 | |
|
128 | |
|
129 | |
|
130 | |
|
131 | |
|
132 | |
|
133 | |
|
134 | |
public static String getDefaultAlias(String aSourceName) |
135 | |
{ |
136 | 9 | final int startIndex = aSourceName.lastIndexOf('.') + 1; |
137 | 9 | int endIndex = aSourceName.length(); |
138 | 9 | if (aSourceName.endsWith(CHECK_SUFFIX)) { |
139 | 9 | endIndex -= CHECK_SUFFIX.length(); |
140 | |
} |
141 | 9 | return aSourceName.substring(startIndex, endIndex).toLowerCase(); |
142 | |
} |
143 | |
|
144 | |
|
145 | |
|
146 | |
|
147 | |
|
148 | |
|
149 | |
|
150 | |
|
151 | |
|
152 | |
public static String getAlias(String aSourceName) |
153 | |
{ |
154 | 10 | String checkAlias = CHECK_ALIAS_MAP.get(aSourceName); |
155 | 10 | if (checkAlias == null) { |
156 | 9 | checkAlias = getDefaultAlias(aSourceName); |
157 | |
} |
158 | 10 | return checkAlias; |
159 | |
} |
160 | |
|
161 | |
|
162 | |
|
163 | |
|
164 | |
|
165 | |
|
166 | |
|
167 | |
public static void registerAlias(String aSourceName, String aCheckAlias) |
168 | |
{ |
169 | 2 | CHECK_ALIAS_MAP.put(aSourceName, aCheckAlias); |
170 | 2 | } |
171 | |
|
172 | |
|
173 | |
|
174 | |
|
175 | |
|
176 | |
|
177 | |
|
178 | |
|
179 | |
public void setAliasList(String aAliasList) |
180 | |
{ |
181 | 4 | for (String sourceAlias : aAliasList.split(",")) { |
182 | 2 | final int index = sourceAlias.indexOf("="); |
183 | 2 | if (index > 0) { |
184 | 2 | registerAlias(sourceAlias.substring(0, index), sourceAlias |
185 | |
.substring(index + 1)); |
186 | |
} |
187 | 0 | else if (sourceAlias.length() > 0) { |
188 | 0 | throw new ConversionException( |
189 | |
"'=' expected in alias list item: " + sourceAlias); |
190 | |
} |
191 | |
} |
192 | 2 | } |
193 | |
|
194 | |
|
195 | |
|
196 | |
|
197 | |
|
198 | |
|
199 | |
|
200 | |
|
201 | |
|
202 | |
|
203 | |
public static boolean isSuppressed(String aSourceName, int aLine, |
204 | |
int aColumn) |
205 | |
{ |
206 | 10 | final List<Entry> entries = ENTRIES.get(); |
207 | 10 | final String checkAlias = getAlias(aSourceName); |
208 | 10 | if (entries != null && checkAlias != null) { |
209 | 10 | for (Entry entry : entries) { |
210 | 102 | final boolean afterStart = |
211 | |
entry.getFirstLine() < aLine |
212 | |
|| (entry.getFirstLine() == aLine && entry |
213 | |
.getFirstColumn() <= aColumn); |
214 | 102 | final boolean beforeEnd = |
215 | |
entry.getLastLine() > aLine |
216 | |
|| (entry.getLastLine() == aLine && entry |
217 | |
.getLastColumn() >= aColumn); |
218 | 102 | final boolean nameMatches = |
219 | |
entry.getCheckName().equals(checkAlias); |
220 | 102 | if (afterStart && beforeEnd && nameMatches) { |
221 | 5 | return true; |
222 | |
} |
223 | 97 | } |
224 | |
} |
225 | 5 | return false; |
226 | |
} |
227 | |
|
228 | |
@Override |
229 | |
public int[] getDefaultTokens() |
230 | |
{ |
231 | 2 | return new int[] {TokenTypes.ANNOTATION}; |
232 | |
} |
233 | |
|
234 | |
@Override |
235 | |
public void beginTree(DetailAST aRootAST) |
236 | |
{ |
237 | 2 | ENTRIES.set(new LinkedList<Entry>()); |
238 | 2 | } |
239 | |
|
240 | |
@Override |
241 | |
public void visitToken(DetailAST aAST) |
242 | |
{ |
243 | |
|
244 | |
|
245 | 24 | String identifier = getIdentifier(getNthChild(aAST, 1)); |
246 | 24 | if (identifier.startsWith(JAVA_LANG_PREFIX)) { |
247 | 2 | identifier = identifier.substring(JAVA_LANG_PREFIX.length()); |
248 | |
} |
249 | 24 | if ("SuppressWarnings".equals(identifier)) { |
250 | |
|
251 | |
|
252 | 24 | List<String> values = null; |
253 | 24 | final DetailAST lparenAST = aAST.findFirstToken(TokenTypes.LPAREN); |
254 | 24 | if (lparenAST != null) { |
255 | 24 | final DetailAST nextAST = lparenAST.getNextSibling(); |
256 | 24 | if (nextAST != null) { |
257 | 24 | final int nextType = nextAST.getType(); |
258 | 24 | switch (nextType) { |
259 | |
case TokenTypes.EXPR: |
260 | |
case TokenTypes.ANNOTATION_ARRAY_INIT: |
261 | 22 | values = getAnnotationValues(nextAST); |
262 | 22 | break; |
263 | |
|
264 | |
case TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR: |
265 | |
|
266 | |
|
267 | 2 | values = getAnnotationValues(getNthChild(nextAST, 2)); |
268 | 2 | break; |
269 | |
|
270 | |
case TokenTypes.RPAREN: |
271 | |
|
272 | 0 | break; |
273 | |
|
274 | |
default: |
275 | |
|
276 | |
} |
277 | |
} |
278 | |
} |
279 | 24 | if (values == null) { |
280 | 0 | log(aAST, "suppress.warnings.missing.value"); |
281 | 0 | return; |
282 | |
} |
283 | |
|
284 | |
|
285 | 24 | DetailAST targetAST = null; |
286 | 24 | DetailAST parentAST = aAST.getParent(); |
287 | 24 | if (parentAST != null) { |
288 | 24 | switch (parentAST.getType()) { |
289 | |
case TokenTypes.MODIFIERS: |
290 | |
case TokenTypes.ANNOTATIONS: |
291 | 24 | parentAST = parentAST.getParent(); |
292 | 24 | if (parentAST != null) { |
293 | 24 | switch (parentAST.getType()) { |
294 | |
case TokenTypes.PACKAGE_DEF: |
295 | |
case TokenTypes.CLASS_DEF: |
296 | |
case TokenTypes.INTERFACE_DEF: |
297 | |
case TokenTypes.ENUM_DEF: |
298 | |
case TokenTypes.CTOR_DEF: |
299 | |
case TokenTypes.METHOD_DEF: |
300 | |
case TokenTypes.PARAMETER_DEF: |
301 | |
case TokenTypes.VARIABLE_DEF: |
302 | 24 | targetAST = parentAST; |
303 | 24 | break; |
304 | |
|
305 | |
default: |
306 | |
|
307 | |
} |
308 | |
} |
309 | |
break; |
310 | |
|
311 | |
default: |
312 | |
|
313 | |
} |
314 | |
} |
315 | 24 | if (targetAST == null) { |
316 | 0 | log(aAST, "suppress.warnings.invalid.target"); |
317 | |
} |
318 | |
|
319 | |
|
320 | 24 | final int firstLine = targetAST.getLineNo(); |
321 | 24 | final int firstColumn = targetAST.getColumnNo(); |
322 | 24 | final DetailAST nextAST = targetAST.getNextSibling(); |
323 | |
final int lastLine, lastColumn; |
324 | 24 | if (nextAST != null) { |
325 | 22 | lastLine = nextAST.getLineNo(); |
326 | 22 | lastColumn = nextAST.getColumnNo() - 1; |
327 | |
} |
328 | |
else { |
329 | 2 | lastLine = Integer.MAX_VALUE; |
330 | 2 | lastColumn = Integer.MAX_VALUE; |
331 | |
} |
332 | |
|
333 | |
|
334 | 24 | final List<Entry> entries = ENTRIES.get(); |
335 | 24 | if (entries != null) { |
336 | 24 | for (String value : values) { |
337 | |
|
338 | 24 | if (value.startsWith(CHECKSTYLE_PREFIX)) { |
339 | 2 | value = value.substring(CHECKSTYLE_PREFIX.length()); |
340 | |
} |
341 | 24 | entries.add(new Entry(value, firstLine, firstColumn, |
342 | |
lastLine, lastColumn)); |
343 | |
} |
344 | |
} |
345 | |
} |
346 | 24 | } |
347 | |
|
348 | |
|
349 | |
|
350 | |
|
351 | |
|
352 | |
|
353 | |
|
354 | |
private static DetailAST getNthChild(DetailAST aAST, int aIndex) |
355 | |
{ |
356 | 26 | DetailAST child = aAST.getFirstChild(); |
357 | 26 | if (child != null) { |
358 | 54 | for (int i = 0; i < aIndex && child != null; ++i) { |
359 | 28 | child = child.getNextSibling(); |
360 | |
} |
361 | |
} |
362 | 26 | return child; |
363 | |
} |
364 | |
|
365 | |
|
366 | |
|
367 | |
|
368 | |
|
369 | |
|
370 | |
|
371 | |
private static String getIdentifier(DetailAST aAST) |
372 | |
{ |
373 | 32 | if (aAST != null) { |
374 | 32 | if (aAST.getType() == TokenTypes.IDENT) { |
375 | 28 | return aAST.getText(); |
376 | |
} |
377 | 4 | else if (aAST.getType() == TokenTypes.DOT) { |
378 | 4 | return getIdentifier(aAST.getFirstChild()) + "." |
379 | |
+ getIdentifier(aAST.getLastChild()); |
380 | |
} |
381 | |
} |
382 | 0 | throw new IllegalArgumentException("Identifier AST expected: " + aAST); |
383 | |
} |
384 | |
|
385 | |
|
386 | |
|
387 | |
|
388 | |
|
389 | |
|
390 | |
|
391 | |
private static String getStringExpr(DetailAST aAST) |
392 | |
{ |
393 | 24 | if (aAST != null && aAST.getType() == TokenTypes.EXPR) { |
394 | 24 | final DetailAST firstChild = aAST.getFirstChild(); |
395 | 24 | if (firstChild.getType() == TokenTypes.STRING_LITERAL) { |
396 | |
|
397 | 24 | final String quotedText = firstChild.getText(); |
398 | 24 | return quotedText.substring(1, quotedText.length() - 1); |
399 | |
} |
400 | 0 | throw new IllegalArgumentException("String literal AST expected: " |
401 | |
+ firstChild); |
402 | |
} |
403 | 0 | throw new IllegalArgumentException("Expression AST expected: " + aAST); |
404 | |
} |
405 | |
|
406 | |
|
407 | |
|
408 | |
|
409 | |
|
410 | |
|
411 | |
|
412 | |
|
413 | |
private static List<String> getAnnotationValues(DetailAST aAST) |
414 | |
{ |
415 | 24 | switch (aAST.getType()) { |
416 | |
case TokenTypes.EXPR: |
417 | 22 | return ImmutableList.of(getStringExpr(aAST)); |
418 | |
|
419 | |
case TokenTypes.ANNOTATION_ARRAY_INIT: |
420 | 2 | final List<String> valueList = Lists.newLinkedList(); |
421 | 2 | DetailAST childAST = aAST.getFirstChild(); |
422 | 6 | while (childAST != null) { |
423 | 4 | if (childAST.getType() == TokenTypes.EXPR) { |
424 | 2 | valueList.add(getStringExpr(childAST)); |
425 | |
} |
426 | 4 | childAST = childAST.getNextSibling(); |
427 | |
} |
428 | 2 | return valueList; |
429 | |
|
430 | |
default: |
431 | |
} |
432 | 0 | throw new IllegalArgumentException( |
433 | |
"Expression or annotation array initializer AST expected: " + aAST); |
434 | |
} |
435 | |
} |