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.puppycrawl.tools.checkstyle.api.Check; |
22 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
23 | |
import com.puppycrawl.tools.checkstyle.api.FastStack; |
24 | |
import com.puppycrawl.tools.checkstyle.api.ScopeUtils; |
25 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
26 | |
import java.util.HashMap; |
27 | |
import java.util.Map; |
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
|
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
|
41 | |
|
42 | |
|
43 | |
|
44 | 2 | public class FinalLocalVariableCheck extends Check |
45 | |
{ |
46 | |
|
47 | 2 | private final FastStack<Map<String, DetailAST>> mScopeStack = |
48 | |
FastStack.newInstance(); |
49 | |
|
50 | |
@Override |
51 | |
public int[] getDefaultTokens() |
52 | |
{ |
53 | 1 | return new int[] { |
54 | |
TokenTypes.IDENT, |
55 | |
TokenTypes.CTOR_DEF, |
56 | |
TokenTypes.METHOD_DEF, |
57 | |
TokenTypes.VARIABLE_DEF, |
58 | |
TokenTypes.INSTANCE_INIT, |
59 | |
TokenTypes.STATIC_INIT, |
60 | |
TokenTypes.LITERAL_FOR, |
61 | |
TokenTypes.SLIST, |
62 | |
TokenTypes.OBJBLOCK, |
63 | |
}; |
64 | |
} |
65 | |
|
66 | |
@Override |
67 | |
public int[] getAcceptableTokens() |
68 | |
{ |
69 | 1 | return new int[] { |
70 | |
TokenTypes.VARIABLE_DEF, |
71 | |
TokenTypes.PARAMETER_DEF, |
72 | |
}; |
73 | |
} |
74 | |
|
75 | |
@Override |
76 | |
public int[] getRequiredTokens() |
77 | |
{ |
78 | 1 | return new int[] { |
79 | |
TokenTypes.IDENT, |
80 | |
TokenTypes.CTOR_DEF, |
81 | |
TokenTypes.METHOD_DEF, |
82 | |
TokenTypes.INSTANCE_INIT, |
83 | |
TokenTypes.STATIC_INIT, |
84 | |
TokenTypes.LITERAL_FOR, |
85 | |
TokenTypes.SLIST, |
86 | |
TokenTypes.OBJBLOCK, |
87 | |
}; |
88 | |
} |
89 | |
|
90 | |
@Override |
91 | |
public void visitToken(DetailAST aAST) |
92 | |
{ |
93 | 346 | switch(aAST.getType()) { |
94 | |
case TokenTypes.OBJBLOCK: |
95 | |
case TokenTypes.SLIST: |
96 | |
case TokenTypes.LITERAL_FOR: |
97 | |
case TokenTypes.METHOD_DEF: |
98 | |
case TokenTypes.CTOR_DEF: |
99 | |
case TokenTypes.STATIC_INIT: |
100 | |
case TokenTypes.INSTANCE_INIT: |
101 | 88 | mScopeStack.push(new HashMap<String, DetailAST>()); |
102 | 88 | break; |
103 | |
|
104 | |
case TokenTypes.PARAMETER_DEF: |
105 | 7 | if (ScopeUtils.inInterfaceBlock(aAST) |
106 | |
|| inAbstractMethod(aAST)) |
107 | |
{ |
108 | 1 | break; |
109 | |
} |
110 | |
case TokenTypes.VARIABLE_DEF: |
111 | 40 | if ((aAST.getParent().getType() != TokenTypes.OBJBLOCK) |
112 | |
&& (aAST.getParent().getType() != TokenTypes.FOR_EACH_CLAUSE)) |
113 | |
{ |
114 | 35 | insertVariable(aAST); |
115 | |
} |
116 | |
break; |
117 | |
|
118 | |
case TokenTypes.IDENT: |
119 | 216 | final int parentType = aAST.getParent().getType(); |
120 | 216 | if ((TokenTypes.POST_DEC == parentType) |
121 | |
|| (TokenTypes.DEC == parentType) |
122 | |
|| (TokenTypes.POST_INC == parentType) |
123 | |
|| (TokenTypes.INC == parentType) |
124 | |
|| (TokenTypes.ASSIGN == parentType) |
125 | |
|| (TokenTypes.PLUS_ASSIGN == parentType) |
126 | |
|| (TokenTypes.MINUS_ASSIGN == parentType) |
127 | |
|| (TokenTypes.DIV_ASSIGN == parentType) |
128 | |
|| (TokenTypes.STAR_ASSIGN == parentType) |
129 | |
|| (TokenTypes.MOD_ASSIGN == parentType) |
130 | |
|| (TokenTypes.SR_ASSIGN == parentType) |
131 | |
|| (TokenTypes.BSR_ASSIGN == parentType) |
132 | |
|| (TokenTypes.SL_ASSIGN == parentType) |
133 | |
|| (TokenTypes.BXOR_ASSIGN == parentType) |
134 | |
|| (TokenTypes.BOR_ASSIGN == parentType) |
135 | |
|| (TokenTypes.BAND_ASSIGN == parentType)) |
136 | |
{ |
137 | |
|
138 | |
|
139 | 24 | if (aAST.getParent().getFirstChild() == aAST) { |
140 | 22 | removeVariable(aAST); |
141 | |
} |
142 | |
} |
143 | |
break; |
144 | |
|
145 | |
default: |
146 | |
} |
147 | 346 | } |
148 | |
|
149 | |
|
150 | |
|
151 | |
|
152 | |
|
153 | |
|
154 | |
private boolean inAbstractMethod(DetailAST aAST) |
155 | |
{ |
156 | 6 | DetailAST parent = aAST.getParent(); |
157 | 12 | while (parent != null) { |
158 | 12 | if (parent.getType() == TokenTypes.METHOD_DEF) { |
159 | 6 | final DetailAST modifiers = |
160 | |
parent.findFirstToken(TokenTypes.MODIFIERS); |
161 | 6 | return modifiers.branchContains(TokenTypes.ABSTRACT); |
162 | |
} |
163 | 6 | parent = parent.getParent(); |
164 | |
} |
165 | 0 | return false; |
166 | |
} |
167 | |
|
168 | |
|
169 | |
|
170 | |
|
171 | |
|
172 | |
private void insertVariable(DetailAST aAST) |
173 | |
{ |
174 | 35 | if (!aAST.branchContains(TokenTypes.FINAL)) { |
175 | 31 | final Map<String, DetailAST> state = mScopeStack.peek(); |
176 | 31 | final DetailAST ast = aAST.findFirstToken(TokenTypes.IDENT); |
177 | 31 | state.put(ast.getText(), ast); |
178 | |
} |
179 | 35 | } |
180 | |
|
181 | |
|
182 | |
|
183 | |
|
184 | |
|
185 | |
private void removeVariable(DetailAST aAST) |
186 | |
{ |
187 | 74 | for (int i = mScopeStack.size() - 1; i >= 0; i--) { |
188 | 61 | final Map<String, DetailAST> state = mScopeStack.peek(i); |
189 | 61 | final Object obj = state.remove(aAST.getText()); |
190 | 61 | if (obj != null) { |
191 | 9 | break; |
192 | |
} |
193 | |
} |
194 | 22 | } |
195 | |
|
196 | |
@Override |
197 | |
public void leaveToken(DetailAST aAST) |
198 | |
{ |
199 | 346 | super.leaveToken(aAST); |
200 | |
|
201 | 346 | switch(aAST.getType()) { |
202 | |
case TokenTypes.OBJBLOCK: |
203 | |
case TokenTypes.SLIST: |
204 | |
case TokenTypes.LITERAL_FOR: |
205 | |
case TokenTypes.CTOR_DEF: |
206 | |
case TokenTypes.STATIC_INIT: |
207 | |
case TokenTypes.INSTANCE_INIT: |
208 | |
case TokenTypes.METHOD_DEF: |
209 | 88 | final Map<String, DetailAST> state = mScopeStack.pop(); |
210 | 88 | for (DetailAST var : state.values()) { |
211 | 22 | log(var.getLineNo(), var.getColumnNo(), "final.variable", var |
212 | |
.getText()); |
213 | |
} |
214 | 88 | break; |
215 | |
|
216 | |
default: |
217 | |
} |
218 | 346 | } |
219 | |
} |