forked from checkstyle/checkstyle
-
Notifications
You must be signed in to change notification settings - Fork 1
/
EmptyForInitializerPadCheck.java
168 lines (154 loc) · 5.3 KB
/
EmptyForInitializerPadCheck.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
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files 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.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 the padding of an empty for initializer; that is whether a white
* space is required at an empty for initializer, or such white space is
* forbidden. No check occurs if there is a line wrap at the initializer, as in
* </p>
* <pre>
* for (
* ; i < j; i++, j--)
* </pre>
* <ul>
* <li>
* Property {@code option} - Specify policy on how to pad an empty for iterator.
* Type is {@code com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption}.
* Default value is {@code nospace}.
* </li>
* </ul>
* <p>
* To configure the check:
* </p>
* <pre>
* <module name="EmptyForInitializerPad"/>
* </pre>
* <p>
* Example:
* </p>
* <pre>
* for ( ; i < 1; i++ ); // violation semicolon is preceded with whitespace
* for (; i < 2; i++ ); // ok
* for (;i<2;i++); // ok
* for ( ;i<2;i++); // violation semicolon is preceded with whitespace
* for (
* ; i < 2; i++ ); // ok
* </pre>
* <p>
* To configure the check to require white space at an empty for iterator:
* </p>
* <pre>
* <module name="EmptyForInitializerPad">
* <property name="option" value="space"/>
* </module>
* </pre>
* <p>
* Example:
* </p>
* <pre>
* for ( ; i < 2; i++ ); // ok
* for (; i < 2; i++ ); // violation semicolon is not preceded with whitespace
* for (;i<2;i++); // violation semicolon is not preceded with whitespace
* for ( ;i<2;i++); // ok
* for (
* ; i < 2; i++ ); // ok
* </pre>
* <p>
* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
* </p>
* <p>
* Violation Message Keys:
* </p>
* <ul>
* <li>
* {@code ws.notPreceded}
* </li>
* <li>
* {@code ws.preceded}
* </li>
* </ul>
*
* @since 3.4
*/
@StatelessCheck
public class EmptyForInitializerPadCheck
extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_PRECEDED = "ws.preceded";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_NOT_PRECEDED = "ws.notPreceded";
/** Semicolon literal. */
private static final String SEMICOLON = ";";
/** Specify policy on how to pad an empty for iterator. */
private PadOption option = PadOption.NOSPACE;
/**
* Setter to specify policy on how to pad an empty for iterator.
*
* @param optionStr string to decode option from
* @throws IllegalArgumentException if unable to decode
*/
public void setOption(String optionStr) {
option = PadOption.valueOf(optionStr.trim().toUpperCase(Locale.ENGLISH));
}
@Override
public int[] getDefaultTokens() {
return getRequiredTokens();
}
@Override
public int[] getAcceptableTokens() {
return getRequiredTokens();
}
@Override
public int[] getRequiredTokens() {
return new int[] {TokenTypes.FOR_INIT};
}
@Override
public void visitToken(DetailAST ast) {
if (!ast.hasChildren()) {
final int lineIdx = ast.getLineNo() - 1;
final int[] line = getLineCodePoints(lineIdx);
final int before = ast.getColumnNo() - 1;
// don't check if semi at beginning of line
if (ast.getColumnNo() > 0 && !CodePointUtil.hasWhitespaceBefore(before, line)) {
if (option == PadOption.NOSPACE
&& CommonUtil.isCodePointWhitespace(line, before)) {
log(ast, MSG_PRECEDED, SEMICOLON);
}
else if (option == PadOption.SPACE
&& !CommonUtil.isCodePointWhitespace(line, before)) {
log(ast, MSG_NOT_PRECEDED, SEMICOLON);
}
}
}
}
}