-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
SeparatorWrapCheck.java
243 lines (229 loc) · 6.62 KB
/
SeparatorWrapCheck.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2022 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.whitespace;
import java.util.Arrays;
import java.util.Locale;
import com.puppycrawl.tools.checkstyle.StatelessCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.CodePointUtil;
import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
/**
* <p>
* Checks line wrapping with separators.
* </p>
* <ul>
* <li>
* Property {@code option} - Specify policy on how to wrap lines.
* Type is {@code com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption}.
* Default value is {@code eol}.
* </li>
* <li>
* Property {@code tokens} - tokens to check
* Type is {@code java.lang.String[]}.
* Validation type is {@code tokenSet}.
* Default value is:
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#DOT">
* DOT</a>,
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#COMMA">
* COMMA</a>.
* </li>
* </ul>
* <p>
* To configure the check:
* </p>
* <pre>
* <module name="SeparatorWrap"/>
* </pre>
* <p>
* Example:
* </p>
* <pre>
* import java.io.
* IOException; // OK
*
* class Test {
*
* String s;
*
* public void foo(int a,
* int b) { // OK
* }
*
* public void bar(int p
* , int q) { // violation, separator comma on new line
* if (s
* .isEmpty()) { // violation, separator dot on new line
* }
* }
*
* }
* </pre>
* <p>
* To configure the check for
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_REF">
* METHOD_REF</a> at new line:
* </p>
* <pre>
* <module name="SeparatorWrap">
* <property name="tokens" value="METHOD_REF"/>
* <property name="option" value="nl"/>
* </module>
* </pre>
* <p>
* Example:
* </p>
* <pre>
* import java.util.Arrays;
*
* class Test2 {
*
* String[] stringArray = {"foo", "bar"};
*
* void fun() {
* Arrays.sort(stringArray, String::
* compareToIgnoreCase); // violation, separator method reference on same line
* Arrays.sort(stringArray, String
* ::compareTo); // OK
* }
*
* }
* </pre>
* <p>
* To configure the check for comma at the new line:
* </p>
* <pre>
* <module name="SeparatorWrap">
* <property name="tokens" value="COMMA"/>
* <property name="option" value="nl"/>
* </module>
* </pre>
* <p>
* Example:
* </p>
* <pre>
* class Test3 {
*
* String s;
*
* int a,
* b; // violation, separator comma on same line
*
* public void foo(int a,
* int b) { // violation, separator comma on the same line
* int r
* , t; // OK
* }
*
* public void bar(int p
* , int q) { // OK
* }
*
* }
* </pre>
* <p>
* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
* </p>
* <p>
* Violation Message Keys:
* </p>
* <ul>
* <li>
* {@code line.new}
* </li>
* <li>
* {@code line.previous}
* </li>
* </ul>
*
* @since 5.8
*/
@StatelessCheck
public class SeparatorWrapCheck
extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_LINE_PREVIOUS = "line.previous";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_LINE_NEW = "line.new";
/** Specify policy on how to wrap lines. */
private WrapOption option = WrapOption.EOL;
/**
* Setter to specify policy on how to wrap lines.
*
* @param optionStr string to decode option from
* @throws IllegalArgumentException if unable to decode
*/
public void setOption(String optionStr) {
option = WrapOption.valueOf(optionStr.trim().toUpperCase(Locale.ENGLISH));
}
@Override
public int[] getDefaultTokens() {
return new int[] {
TokenTypes.DOT,
TokenTypes.COMMA,
};
}
@Override
public int[] getAcceptableTokens() {
return new int[] {
TokenTypes.DOT,
TokenTypes.COMMA,
TokenTypes.SEMI,
TokenTypes.ELLIPSIS,
TokenTypes.AT,
TokenTypes.LPAREN,
TokenTypes.RPAREN,
TokenTypes.ARRAY_DECLARATOR,
TokenTypes.RBRACK,
TokenTypes.METHOD_REF,
};
}
@Override
public int[] getRequiredTokens() {
return CommonUtil.EMPTY_INT_ARRAY;
}
@Override
public void visitToken(DetailAST ast) {
final String text = ast.getText();
final int colNo = ast.getColumnNo();
final int lineNo = ast.getLineNo();
final int[] currentLine = getLineCodePoints(lineNo - 1);
final int[] substringAfterToken = CodePointUtil.trim(
Arrays.copyOfRange(currentLine, colNo + text.length(), currentLine.length)
);
final int[] substringBeforeToken = CodePointUtil.trim(
Arrays.copyOfRange(currentLine, 0, colNo)
);
if (option == WrapOption.EOL
&& substringBeforeToken.length == 0) {
log(ast, MSG_LINE_PREVIOUS, text);
}
else if (option == WrapOption.NL
&& substringAfterToken.length == 0) {
log(ast, MSG_LINE_NEW, text);
}
}
}