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.blocks; |
20 | |
|
21 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
22 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
23 | |
import com.puppycrawl.tools.checkstyle.api.Utils; |
24 | |
import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck; |
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 | |
public class LeftCurlyCheck |
68 | |
extends AbstractOptionCheck<LeftCurlyOption> |
69 | |
{ |
70 | |
|
71 | |
private static final int DEFAULT_MAX_LINE_LENGTH = 80; |
72 | |
|
73 | |
|
74 | 10 | private int mMaxLineLength = DEFAULT_MAX_LINE_LENGTH; |
75 | |
|
76 | |
|
77 | |
|
78 | |
|
79 | |
public LeftCurlyCheck() |
80 | |
{ |
81 | 10 | super(LeftCurlyOption.EOL, LeftCurlyOption.class); |
82 | 10 | } |
83 | |
|
84 | |
|
85 | |
|
86 | |
|
87 | |
|
88 | |
|
89 | |
public void setMaxLineLength(int aMaxLineLength) |
90 | |
{ |
91 | 0 | mMaxLineLength = aMaxLineLength; |
92 | 0 | } |
93 | |
|
94 | |
@Override |
95 | |
public int[] getDefaultTokens() |
96 | |
{ |
97 | 10 | return new int[] { |
98 | |
TokenTypes.INTERFACE_DEF, |
99 | |
TokenTypes.CLASS_DEF, |
100 | |
TokenTypes.ANNOTATION_DEF, |
101 | |
TokenTypes.ENUM_DEF, |
102 | |
TokenTypes.CTOR_DEF, |
103 | |
TokenTypes.METHOD_DEF, |
104 | |
TokenTypes.ENUM_CONSTANT_DEF, |
105 | |
TokenTypes.LITERAL_WHILE, |
106 | |
TokenTypes.LITERAL_TRY, |
107 | |
TokenTypes.LITERAL_CATCH, |
108 | |
TokenTypes.LITERAL_FINALLY, |
109 | |
TokenTypes.LITERAL_SYNCHRONIZED, |
110 | |
TokenTypes.LITERAL_SWITCH, |
111 | |
TokenTypes.LITERAL_DO, |
112 | |
TokenTypes.LITERAL_IF, |
113 | |
TokenTypes.LITERAL_ELSE, |
114 | |
TokenTypes.LITERAL_FOR, |
115 | |
|
116 | |
|
117 | |
}; |
118 | |
} |
119 | |
|
120 | |
@Override |
121 | |
public void visitToken(DetailAST aAST) |
122 | |
{ |
123 | |
final DetailAST startToken; |
124 | |
final DetailAST brace; |
125 | |
|
126 | 209 | switch (aAST.getType()) { |
127 | |
case TokenTypes.CTOR_DEF : |
128 | |
case TokenTypes.METHOD_DEF : |
129 | 92 | startToken = skipAnnotationOnlyLines(aAST); |
130 | 92 | brace = aAST.findFirstToken(TokenTypes.SLIST); |
131 | 92 | break; |
132 | |
|
133 | |
case TokenTypes.INTERFACE_DEF : |
134 | |
case TokenTypes.CLASS_DEF : |
135 | |
case TokenTypes.ANNOTATION_DEF : |
136 | |
case TokenTypes.ENUM_DEF : |
137 | |
case TokenTypes.ENUM_CONSTANT_DEF : |
138 | 58 | startToken = skipAnnotationOnlyLines(aAST); |
139 | 58 | final DetailAST objBlock = aAST.findFirstToken(TokenTypes.OBJBLOCK); |
140 | 58 | brace = (objBlock == null) |
141 | |
? null |
142 | |
: (DetailAST) objBlock.getFirstChild(); |
143 | 58 | break; |
144 | |
|
145 | |
case TokenTypes.LITERAL_WHILE: |
146 | |
case TokenTypes.LITERAL_CATCH: |
147 | |
case TokenTypes.LITERAL_SYNCHRONIZED: |
148 | |
case TokenTypes.LITERAL_FOR: |
149 | |
case TokenTypes.LITERAL_TRY: |
150 | |
case TokenTypes.LITERAL_FINALLY: |
151 | |
case TokenTypes.LITERAL_DO: |
152 | |
case TokenTypes.LITERAL_IF : |
153 | 46 | startToken = aAST; |
154 | 46 | brace = aAST.findFirstToken(TokenTypes.SLIST); |
155 | 46 | break; |
156 | |
|
157 | |
case TokenTypes.LITERAL_ELSE : |
158 | 11 | startToken = aAST; |
159 | 11 | final DetailAST candidate = aAST.getFirstChild(); |
160 | 11 | brace = |
161 | |
(candidate.getType() == TokenTypes.SLIST) |
162 | |
? candidate |
163 | |
: null; |
164 | 11 | break; |
165 | |
|
166 | |
case TokenTypes.LITERAL_SWITCH : |
167 | 2 | startToken = aAST; |
168 | 2 | brace = aAST.findFirstToken(TokenTypes.LCURLY); |
169 | 2 | break; |
170 | |
|
171 | |
default : |
172 | 0 | startToken = null; |
173 | 0 | brace = null; |
174 | |
} |
175 | |
|
176 | 209 | if ((brace != null) && (startToken != null)) { |
177 | 157 | verifyBrace(brace, startToken); |
178 | |
} |
179 | 209 | } |
180 | |
|
181 | |
|
182 | |
|
183 | |
|
184 | |
|
185 | |
|
186 | |
|
187 | |
|
188 | |
|
189 | |
|
190 | |
|
191 | |
private DetailAST skipAnnotationOnlyLines(DetailAST aAST) |
192 | |
{ |
193 | 150 | final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS); |
194 | 150 | if (modifiers == null) { |
195 | 10 | return aAST; |
196 | |
} |
197 | 140 | DetailAST lastAnnot = findLastAnnotation(modifiers); |
198 | 140 | if (lastAnnot == null) { |
199 | |
|
200 | 122 | return aAST; |
201 | |
} |
202 | 18 | final DetailAST tokenAfterLast = lastAnnot.getNextSibling() != null |
203 | |
? lastAnnot.getNextSibling() |
204 | |
: modifiers.getNextSibling(); |
205 | 18 | if (tokenAfterLast.getLineNo() > lastAnnot.getLineNo()) { |
206 | 14 | return tokenAfterLast; |
207 | |
} |
208 | 4 | final int lastAnnotLineNumber = lastAnnot.getLineNo(); |
209 | |
while (lastAnnot.getPreviousSibling() != null |
210 | 8 | && (lastAnnot.getPreviousSibling().getLineNo() |
211 | |
== lastAnnotLineNumber)) |
212 | |
{ |
213 | 4 | lastAnnot = lastAnnot.getPreviousSibling(); |
214 | |
} |
215 | 4 | return lastAnnot; |
216 | |
} |
217 | |
|
218 | |
|
219 | |
|
220 | |
|
221 | |
|
222 | |
|
223 | |
|
224 | |
private DetailAST findLastAnnotation(DetailAST aModifiers) |
225 | |
{ |
226 | 140 | DetailAST aAnnot = aModifiers.findFirstToken(TokenTypes.ANNOTATION); |
227 | |
while (aAnnot != null && aAnnot.getNextSibling() != null |
228 | 148 | && aAnnot.getNextSibling().getType() == TokenTypes.ANNOTATION) |
229 | |
{ |
230 | 8 | aAnnot = aAnnot.getNextSibling(); |
231 | |
} |
232 | 140 | return aAnnot; |
233 | |
} |
234 | |
|
235 | |
|
236 | |
|
237 | |
|
238 | |
|
239 | |
|
240 | |
|
241 | |
private void verifyBrace(final DetailAST aBrace, |
242 | |
final DetailAST aStartToken) |
243 | |
{ |
244 | 157 | final String braceLine = getLines()[aBrace.getLineNo() - 1]; |
245 | |
|
246 | |
|
247 | |
|
248 | |
|
249 | 157 | final int prevLineLen = (aBrace.getLineNo() == 1) |
250 | |
? mMaxLineLength |
251 | |
: Utils.lengthMinusTrailingWhitespace( |
252 | |
getLines()[aBrace.getLineNo() - 2]); |
253 | |
|
254 | |
|
255 | 157 | if ((braceLine.length() > (aBrace.getColumnNo() + 1)) |
256 | |
&& (braceLine.charAt(aBrace.getColumnNo() + 1) == '}')) |
257 | |
{ |
258 | |
; |
259 | |
} |
260 | 147 | else if (getAbstractOption() == LeftCurlyOption.NL) { |
261 | 60 | if (!Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine)) { |
262 | 21 | log(aBrace.getLineNo(), aBrace.getColumnNo(), |
263 | |
"line.new", "{"); |
264 | |
} |
265 | |
} |
266 | 87 | else if (getAbstractOption() == LeftCurlyOption.EOL) { |
267 | 76 | if (Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine) |
268 | |
&& ((prevLineLen + 2) <= mMaxLineLength)) |
269 | |
{ |
270 | 40 | log(aBrace.getLineNo(), aBrace.getColumnNo(), |
271 | |
"line.previous", "{"); |
272 | |
} |
273 | |
} |
274 | 11 | else if (getAbstractOption() == LeftCurlyOption.NLOW) { |
275 | 11 | if (aStartToken.getLineNo() == aBrace.getLineNo()) { |
276 | |
; |
277 | |
} |
278 | 11 | else if ((aStartToken.getLineNo() + 1) == aBrace.getLineNo()) { |
279 | 7 | if (!Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine)) { |
280 | 2 | log(aBrace.getLineNo(), aBrace.getColumnNo(), |
281 | |
"line.new", "{"); |
282 | |
} |
283 | 5 | else if ((prevLineLen + 2) <= mMaxLineLength) { |
284 | 5 | log(aBrace.getLineNo(), aBrace.getColumnNo(), |
285 | |
"line.previous", "{"); |
286 | |
} |
287 | |
} |
288 | 4 | else if (!Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine)) { |
289 | 4 | log(aBrace.getLineNo(), aBrace.getColumnNo(), |
290 | |
"line.new", "{"); |
291 | |
} |
292 | |
} |
293 | 157 | } |
294 | |
} |