1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package com.puppycrawl.tools.checkstyle.checks.coding;
21
22 import java.util.ArrayDeque;
23 import java.util.Collections;
24 import java.util.Deque;
25 import java.util.HashSet;
26 import java.util.Set;
27
28 import com.puppycrawl.tools.checkstyle.FileStatefulCheck;
29 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
30 import com.puppycrawl.tools.checkstyle.api.DetailAST;
31 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
32 import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
33 import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
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 @FileStatefulCheck
62 public final class ParameterAssignmentCheck extends AbstractCheck {
63
64
65
66
67
68 public static final String MSG_KEY = "parameter.assignment";
69
70
71 private final Deque<Set<String>> parameterNamesStack = new ArrayDeque<>();
72
73 private Set<String> parameterNames;
74
75 @Override
76 public int[] getDefaultTokens() {
77 return getRequiredTokens();
78 }
79
80 @Override
81 public int[] getRequiredTokens() {
82 return new int[] {
83 TokenTypes.CTOR_DEF,
84 TokenTypes.METHOD_DEF,
85 TokenTypes.ASSIGN,
86 TokenTypes.PLUS_ASSIGN,
87 TokenTypes.MINUS_ASSIGN,
88 TokenTypes.STAR_ASSIGN,
89 TokenTypes.DIV_ASSIGN,
90 TokenTypes.MOD_ASSIGN,
91 TokenTypes.SR_ASSIGN,
92 TokenTypes.BSR_ASSIGN,
93 TokenTypes.SL_ASSIGN,
94 TokenTypes.BAND_ASSIGN,
95 TokenTypes.BXOR_ASSIGN,
96 TokenTypes.BOR_ASSIGN,
97 TokenTypes.INC,
98 TokenTypes.POST_INC,
99 TokenTypes.DEC,
100 TokenTypes.POST_DEC,
101 TokenTypes.LAMBDA,
102 };
103 }
104
105 @Override
106 public int[] getAcceptableTokens() {
107 return getRequiredTokens();
108 }
109
110 @Override
111 public void beginTree(DetailAST rootAST) {
112
113 parameterNamesStack.clear();
114 parameterNames = Collections.emptySet();
115 }
116
117 @Override
118 public void visitToken(DetailAST ast) {
119 final int type = ast.getType();
120 if (TokenUtil.isOfType(type, TokenTypes.CTOR_DEF, TokenTypes.METHOD_DEF)) {
121 visitMethodDef(ast);
122 }
123 else if (type == TokenTypes.LAMBDA) {
124 if (ast.getParent().getType() != TokenTypes.SWITCH_RULE) {
125 visitLambda(ast);
126 }
127 }
128 else {
129 checkNestedIdent(ast);
130 }
131 }
132
133 @Override
134 public void leaveToken(DetailAST ast) {
135 final int type = ast.getType();
136 if (TokenUtil.isOfType(type, TokenTypes.CTOR_DEF, TokenTypes.METHOD_DEF)
137 || type == TokenTypes.LAMBDA
138 && ast.getParent().getType() != TokenTypes.SWITCH_RULE) {
139 parameterNames = parameterNamesStack.pop();
140 }
141 }
142
143
144
145
146
147
148 private void checkNestedIdent(DetailAST ast) {
149 final DetailAST identAST = ast.getFirstChild();
150
151 if (identAST != null
152 && identAST.getType() == TokenTypes.IDENT
153 && parameterNames.contains(identAST.getText())) {
154 log(ast, MSG_KEY, identAST.getText());
155 }
156 }
157
158
159
160
161
162
163 private void visitMethodDef(DetailAST ast) {
164 parameterNamesStack.push(parameterNames);
165 parameterNames = new HashSet<>();
166
167 visitMethodParameters(ast.findFirstToken(TokenTypes.PARAMETERS));
168 }
169
170
171
172
173
174
175 private void visitLambda(DetailAST lambdaAst) {
176 parameterNamesStack.push(parameterNames);
177 parameterNames = new HashSet<>();
178
179 DetailAST parameterAst = lambdaAst.findFirstToken(TokenTypes.PARAMETERS);
180 if (parameterAst == null) {
181 parameterAst = lambdaAst.getFirstChild();
182 }
183 visitLambdaParameters(parameterAst);
184 }
185
186
187
188
189
190
191 private void visitMethodParameters(DetailAST ast) {
192 visitParameters(ast);
193 }
194
195
196
197
198
199
200 private void visitLambdaParameters(DetailAST ast) {
201 if (ast.getType() == TokenTypes.IDENT) {
202 parameterNames.add(ast.getText());
203 }
204 else {
205 visitParameters(ast);
206 }
207 }
208
209
210
211
212
213
214 private void visitParameters(DetailAST parametersAst) {
215 DetailAST parameterDefAST =
216 parametersAst.findFirstToken(TokenTypes.PARAMETER_DEF);
217
218 while (parameterDefAST != null) {
219 if (!CheckUtil.isReceiverParameter(parameterDefAST)) {
220 final DetailAST param =
221 parameterDefAST.findFirstToken(TokenTypes.IDENT);
222 parameterNames.add(param.getText());
223 }
224 parameterDefAST = parameterDefAST.getNextSibling();
225 }
226 }
227
228 }