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.coding; |
20 | |
|
21 | |
import com.google.common.collect.Sets; |
22 | |
import com.puppycrawl.tools.checkstyle.api.Check; |
23 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
24 | |
import com.puppycrawl.tools.checkstyle.api.ScopeUtils; |
25 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
26 | |
import com.puppycrawl.tools.checkstyle.api.Utils; |
27 | |
|
28 | |
import java.util.Set; |
29 | |
import java.util.regex.Pattern; |
30 | |
import java.util.regex.PatternSyntaxException; |
31 | |
import org.apache.commons.beanutils.ConversionException; |
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 | 7 | public class HiddenFieldCheck |
74 | |
extends Check |
75 | |
{ |
76 | |
|
77 | |
|
78 | |
|
79 | |
private FieldFrame mCurrentFrame; |
80 | |
|
81 | |
|
82 | |
private Pattern mRegexp; |
83 | |
|
84 | |
|
85 | |
private boolean mIgnoreSetter; |
86 | |
|
87 | |
|
88 | |
private boolean mIgnoreConstructorParameter; |
89 | |
|
90 | |
|
91 | |
private boolean mIgnoreAbstractMethods; |
92 | |
|
93 | |
@Override |
94 | |
public int[] getDefaultTokens() |
95 | |
{ |
96 | 6 | return new int[] { |
97 | |
TokenTypes.VARIABLE_DEF, |
98 | |
TokenTypes.PARAMETER_DEF, |
99 | |
TokenTypes.CLASS_DEF, |
100 | |
TokenTypes.ENUM_DEF, |
101 | |
TokenTypes.ENUM_CONSTANT_DEF, |
102 | |
}; |
103 | |
} |
104 | |
|
105 | |
@Override |
106 | |
public int[] getAcceptableTokens() |
107 | |
{ |
108 | 1 | return new int[] { |
109 | |
TokenTypes.VARIABLE_DEF, |
110 | |
TokenTypes.PARAMETER_DEF, |
111 | |
}; |
112 | |
} |
113 | |
|
114 | |
@Override |
115 | |
public int[] getRequiredTokens() |
116 | |
{ |
117 | 1 | return new int[] { |
118 | |
TokenTypes.CLASS_DEF, |
119 | |
TokenTypes.ENUM_DEF, |
120 | |
TokenTypes.ENUM_CONSTANT_DEF, |
121 | |
}; |
122 | |
} |
123 | |
|
124 | |
@Override |
125 | |
public void beginTree(DetailAST aRootAST) |
126 | |
{ |
127 | 7 | mCurrentFrame = new FieldFrame(null, true); |
128 | 7 | } |
129 | |
|
130 | |
@Override |
131 | |
public void visitToken(DetailAST aAST) |
132 | |
{ |
133 | 395 | if ((aAST.getType() == TokenTypes.VARIABLE_DEF) |
134 | |
|| (aAST.getType() == TokenTypes.PARAMETER_DEF)) |
135 | |
{ |
136 | 311 | processVariable(aAST); |
137 | 311 | return; |
138 | |
} |
139 | |
|
140 | |
|
141 | |
|
142 | |
|
143 | |
|
144 | |
|
145 | 84 | final DetailAST typeMods = aAST.findFirstToken(TokenTypes.MODIFIERS); |
146 | 84 | final boolean isStaticInnerType = |
147 | |
(typeMods != null) |
148 | |
&& typeMods.branchContains(TokenTypes.LITERAL_STATIC); |
149 | 84 | final FieldFrame frame = |
150 | |
new FieldFrame(mCurrentFrame, isStaticInnerType); |
151 | |
|
152 | |
|
153 | 84 | final DetailAST objBlock = aAST.findFirstToken(TokenTypes.OBJBLOCK); |
154 | |
|
155 | 84 | if (objBlock != null) { |
156 | 70 | DetailAST child = objBlock.getFirstChild(); |
157 | 544 | while (child != null) { |
158 | 474 | if (child.getType() == TokenTypes.VARIABLE_DEF) { |
159 | 83 | final String name = |
160 | |
child.findFirstToken(TokenTypes.IDENT).getText(); |
161 | 83 | final DetailAST mods = |
162 | |
child.findFirstToken(TokenTypes.MODIFIERS); |
163 | 83 | if (mods.branchContains(TokenTypes.LITERAL_STATIC)) { |
164 | 19 | frame.addStaticField(name); |
165 | |
} |
166 | |
else { |
167 | 64 | frame.addInstanceField(name); |
168 | |
} |
169 | |
} |
170 | 474 | child = child.getNextSibling(); |
171 | |
} |
172 | |
} |
173 | |
|
174 | 84 | mCurrentFrame = frame; |
175 | 84 | } |
176 | |
|
177 | |
@Override |
178 | |
public void leaveToken(DetailAST aAST) |
179 | |
{ |
180 | 395 | if ((aAST.getType() == TokenTypes.CLASS_DEF) |
181 | |
|| (aAST.getType() == TokenTypes.ENUM_DEF) |
182 | |
|| (aAST.getType() == TokenTypes.ENUM_CONSTANT_DEF)) |
183 | |
{ |
184 | |
|
185 | 84 | mCurrentFrame = mCurrentFrame.getParent(); |
186 | |
} |
187 | 395 | } |
188 | |
|
189 | |
|
190 | |
|
191 | |
|
192 | |
|
193 | |
|
194 | |
|
195 | |
private void processVariable(DetailAST aAST) |
196 | |
{ |
197 | 311 | if (ScopeUtils.inInterfaceOrAnnotationBlock(aAST) |
198 | |
|| (!ScopeUtils.isLocalVariableDef(aAST) |
199 | |
&& (aAST.getType() != TokenTypes.PARAMETER_DEF))) |
200 | |
{ |
201 | |
|
202 | 96 | return; |
203 | |
} |
204 | |
|
205 | 215 | final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT); |
206 | 215 | final String name = nameAST.getText(); |
207 | 215 | if ((mCurrentFrame.containsStaticField(name) |
208 | |
|| (!inStatic(aAST) && mCurrentFrame.containsInstanceField(name))) |
209 | |
&& ((mRegexp == null) || (!getRegexp().matcher(name).find())) |
210 | |
&& !isIgnoredSetterParam(aAST, name) |
211 | |
&& !isIgnoredConstructorParam(aAST) |
212 | |
&& !isIgnoredParamOfAbstractMethod(aAST)) |
213 | |
{ |
214 | 181 | log(nameAST, "hidden.field", name); |
215 | |
} |
216 | 215 | } |
217 | |
|
218 | |
|
219 | |
|
220 | |
|
221 | |
|
222 | |
|
223 | |
|
224 | |
private static boolean inStatic(DetailAST aAST) |
225 | |
{ |
226 | 179 | DetailAST parent = aAST.getParent(); |
227 | 613 | while (parent != null) { |
228 | 560 | switch (parent.getType()) { |
229 | |
case TokenTypes.STATIC_INIT: |
230 | 6 | return true; |
231 | |
case TokenTypes.METHOD_DEF: |
232 | 120 | final DetailAST mods = |
233 | |
parent.findFirstToken(TokenTypes.MODIFIERS); |
234 | 120 | return mods.branchContains(TokenTypes.LITERAL_STATIC); |
235 | |
default: |
236 | 434 | parent = parent.getParent(); |
237 | |
} |
238 | |
} |
239 | 53 | return false; |
240 | |
} |
241 | |
|
242 | |
|
243 | |
|
244 | |
|
245 | |
|
246 | |
|
247 | |
|
248 | |
|
249 | |
|
250 | |
|
251 | |
private boolean isIgnoredSetterParam(DetailAST aAST, String aName) |
252 | |
{ |
253 | 187 | if (aAST.getType() != TokenTypes.PARAMETER_DEF |
254 | |
|| !mIgnoreSetter) |
255 | |
{ |
256 | 174 | return false; |
257 | |
} |
258 | |
|
259 | 13 | final DetailAST parametersAST = aAST.getParent(); |
260 | 13 | if (parametersAST.getChildCount() != 1) { |
261 | 3 | return false; |
262 | |
} |
263 | |
|
264 | 10 | final DetailAST methodAST = parametersAST.getParent(); |
265 | 10 | if (methodAST.getType() != TokenTypes.METHOD_DEF) { |
266 | 3 | return false; |
267 | |
} |
268 | |
|
269 | 7 | final DetailAST typeAST = methodAST.findFirstToken(TokenTypes.TYPE); |
270 | 7 | if (!typeAST.branchContains(TokenTypes.LITERAL_VOID)) { |
271 | 1 | return false; |
272 | |
} |
273 | |
|
274 | |
|
275 | 6 | final String methodName = |
276 | |
methodAST.findFirstToken(TokenTypes.IDENT).getText(); |
277 | 6 | final String expectedName = "set" + capitalize(aName); |
278 | 6 | return methodName.equals(expectedName); |
279 | |
} |
280 | |
|
281 | |
|
282 | |
|
283 | |
|
284 | |
|
285 | |
|
286 | |
|
287 | |
private static String capitalize(final String aName) |
288 | |
{ |
289 | 6 | if (aName == null || aName.length() == 0) { |
290 | 0 | return aName; |
291 | |
} |
292 | |
|
293 | |
|
294 | |
|
295 | 6 | if (aName.length() > 1 && Character.isUpperCase(aName.charAt(1))) { |
296 | 1 | return aName; |
297 | |
} |
298 | 5 | return aName.substring(0, 1).toUpperCase() + aName.substring(1); |
299 | |
} |
300 | |
|
301 | |
|
302 | |
|
303 | |
|
304 | |
|
305 | |
|
306 | |
|
307 | |
|
308 | |
private boolean isIgnoredConstructorParam(DetailAST aAST) |
309 | |
{ |
310 | 185 | if ((aAST.getType() != TokenTypes.PARAMETER_DEF) |
311 | |
|| !mIgnoreConstructorParameter) |
312 | |
{ |
313 | 172 | return false; |
314 | |
} |
315 | 13 | final DetailAST parametersAST = aAST.getParent(); |
316 | 13 | final DetailAST constructorAST = parametersAST.getParent(); |
317 | 13 | return (constructorAST.getType() == TokenTypes.CTOR_DEF); |
318 | |
} |
319 | |
|
320 | |
|
321 | |
|
322 | |
|
323 | |
|
324 | |
|
325 | |
|
326 | |
|
327 | |
|
328 | |
private boolean isIgnoredParamOfAbstractMethod(DetailAST aAST) |
329 | |
{ |
330 | 182 | if ((aAST.getType() != TokenTypes.PARAMETER_DEF) |
331 | |
|| !mIgnoreAbstractMethods) |
332 | |
{ |
333 | 169 | return false; |
334 | |
} |
335 | 13 | final DetailAST method = aAST.getParent().getParent(); |
336 | 13 | if (method.getType() != TokenTypes.METHOD_DEF) { |
337 | 3 | return false; |
338 | |
} |
339 | 10 | final DetailAST mods = method.findFirstToken(TokenTypes.MODIFIERS); |
340 | 10 | return ((mods != null) && mods.branchContains(TokenTypes.ABSTRACT)); |
341 | |
} |
342 | |
|
343 | |
|
344 | |
|
345 | |
|
346 | |
|
347 | |
|
348 | |
public void setIgnoreFormat(String aFormat) |
349 | |
throws ConversionException |
350 | |
{ |
351 | |
try { |
352 | 1 | mRegexp = Utils.getPattern(aFormat); |
353 | |
} |
354 | 0 | catch (final PatternSyntaxException e) { |
355 | 0 | throw new ConversionException("unable to parse " + aFormat, e); |
356 | 1 | } |
357 | 1 | } |
358 | |
|
359 | |
|
360 | |
|
361 | |
|
362 | |
|
363 | |
|
364 | |
public void setIgnoreSetter(boolean aIgnoreSetter) |
365 | |
{ |
366 | 1 | mIgnoreSetter = aIgnoreSetter; |
367 | 1 | } |
368 | |
|
369 | |
|
370 | |
|
371 | |
|
372 | |
|
373 | |
|
374 | |
public void setIgnoreConstructorParameter( |
375 | |
boolean aIgnoreConstructorParameter) |
376 | |
{ |
377 | 1 | mIgnoreConstructorParameter = aIgnoreConstructorParameter; |
378 | 1 | } |
379 | |
|
380 | |
|
381 | |
|
382 | |
|
383 | |
|
384 | |
|
385 | |
public void setIgnoreAbstractMethods( |
386 | |
boolean aIgnoreAbstractMethods) |
387 | |
{ |
388 | 1 | mIgnoreAbstractMethods = aIgnoreAbstractMethods; |
389 | 1 | } |
390 | |
|
391 | |
|
392 | |
public Pattern getRegexp() |
393 | |
{ |
394 | 31 | return mRegexp; |
395 | |
} |
396 | |
|
397 | |
|
398 | |
|
399 | |
|
400 | |
|
401 | |
|
402 | |
|
403 | |
|
404 | 7 | private static class FieldFrame |
405 | |
{ |
406 | |
|
407 | |
private final boolean mStaticType; |
408 | |
|
409 | |
|
410 | |
private final FieldFrame mParent; |
411 | |
|
412 | |
|
413 | 91 | private final Set<String> mInstanceFields = Sets.newHashSet(); |
414 | |
|
415 | |
|
416 | 91 | private final Set<String> mStaticFields = Sets.newHashSet(); |
417 | |
|
418 | |
|
419 | |
|
420 | |
|
421 | |
|
422 | |
public FieldFrame(FieldFrame aParent, boolean aStaticType) |
423 | 91 | { |
424 | 91 | mParent = aParent; |
425 | 91 | mStaticType = aStaticType; |
426 | 91 | } |
427 | |
|
428 | |
|
429 | |
|
430 | |
|
431 | |
boolean isStaticType() |
432 | |
{ |
433 | 42 | return mStaticType; |
434 | |
} |
435 | |
|
436 | |
|
437 | |
|
438 | |
|
439 | |
|
440 | |
public void addInstanceField(String aField) |
441 | |
{ |
442 | 64 | mInstanceFields.add(aField); |
443 | 64 | } |
444 | |
|
445 | |
|
446 | |
|
447 | |
|
448 | |
|
449 | |
public void addStaticField(String aField) |
450 | |
{ |
451 | 19 | mStaticFields.add(aField); |
452 | 19 | } |
453 | |
|
454 | |
|
455 | |
|
456 | |
|
457 | |
|
458 | |
|
459 | |
public boolean containsInstanceField(String aField) |
460 | |
{ |
461 | 199 | return mInstanceFields.contains(aField) |
462 | |
|| !isStaticType() |
463 | |
&& (mParent != null) |
464 | |
&& mParent.containsInstanceField(aField); |
465 | |
|
466 | |
} |
467 | |
|
468 | |
|
469 | |
|
470 | |
|
471 | |
|
472 | |
|
473 | |
public boolean containsStaticField(String aField) |
474 | |
{ |
475 | 478 | return mStaticFields.contains(aField) |
476 | |
|| (mParent != null) |
477 | |
&& mParent.containsStaticField(aField); |
478 | |
|
479 | |
} |
480 | |
|
481 | |
|
482 | |
|
483 | |
|
484 | |
|
485 | |
public FieldFrame getParent() |
486 | |
{ |
487 | 84 | return mParent; |
488 | |
} |
489 | |
} |
490 | |
} |