forked from checkstyle/checkstyle
/
NoWhitespaceBeforeCheck.java
167 lines (154 loc) · 5.8 KB
/
NoWhitespaceBeforeCheck.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
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2020 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 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.CommonUtil;
/**
* <p>
* Checks that there is no whitespace before a token.
* More specifically, it checks that it is not preceded with whitespace,
* or (if linebreaks are allowed) all characters on the line before are
* whitespace. To allow linebreaks before a token, set property
* {@code allowLineBreaks} to {@code true}. No check occurs before semi-colons in empty
* for loop initializers or conditions.
* </p>
* <ul>
* <li>
* Property {@code allowLineBreaks} - Control whether whitespace is allowed
* if the token is at a linebreak.
* Default value is {@code false}.
* </li>
* <li>
* Property {@code tokens} - tokens to check
* Default value is:
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#COMMA">
* COMMA</a>,
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#SEMI">
* SEMI</a>,
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#POST_INC">
* POST_INC</a>,
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#POST_DEC">
* POST_DEC</a>,
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ELLIPSIS">
* ELLIPSIS</a>.
* </li>
* </ul>
* <p>
* To configure the check:
* </p>
* <pre>
* <module name="NoWhitespaceBefore"/>
* </pre>
* <p>
* To configure the check to allow linebreaks before a DOT token:
* </p>
* <pre>
* <module name="NoWhitespaceBefore">
* <property name="tokens" value="DOT"/>
* <property name="allowLineBreaks" value="true"/>
* </module>
* </pre>
*
* @since 3.0
*/
@StatelessCheck
public class NoWhitespaceBeforeCheck
extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "ws.preceded";
/** Control whether whitespace is allowed if the token is at a linebreak. */
private boolean allowLineBreaks;
@Override
public int[] getDefaultTokens() {
return new int[] {
TokenTypes.COMMA,
TokenTypes.SEMI,
TokenTypes.POST_INC,
TokenTypes.POST_DEC,
TokenTypes.ELLIPSIS,
};
}
@Override
public int[] getAcceptableTokens() {
return new int[] {
TokenTypes.COMMA,
TokenTypes.SEMI,
TokenTypes.POST_INC,
TokenTypes.POST_DEC,
TokenTypes.DOT,
TokenTypes.GENERIC_START,
TokenTypes.GENERIC_END,
TokenTypes.ELLIPSIS,
TokenTypes.METHOD_REF,
};
}
@Override
public int[] getRequiredTokens() {
return CommonUtil.EMPTY_INT_ARRAY;
}
@Override
public void visitToken(DetailAST ast) {
final String line = getLine(ast.getLineNo() - 1);
final int before = ast.getColumnNo() - 1;
if ((before == -1 || Character.isWhitespace(line.charAt(before)))
&& !isInEmptyForInitializerOrCondition(ast)) {
boolean flag = !allowLineBreaks;
// verify all characters before '.' are whitespace
for (int i = 0; i <= before - 1; i++) {
if (!Character.isWhitespace(line.charAt(i))) {
flag = true;
break;
}
}
if (flag) {
log(ast, MSG_KEY, ast.getText());
}
}
}
/**
* Checks that semicolon is in empty for initializer or condition.
* @param semicolonAst DetailAST of semicolon.
* @return true if semicolon is in empty for initializer or condition.
*/
private static boolean isInEmptyForInitializerOrCondition(DetailAST semicolonAst) {
boolean result = false;
final DetailAST sibling = semicolonAst.getPreviousSibling();
if (sibling != null
&& (sibling.getType() == TokenTypes.FOR_INIT
|| sibling.getType() == TokenTypes.FOR_CONDITION)
&& !sibling.hasChildren()) {
result = true;
}
return result;
}
/**
* Setter to control whether whitespace is allowed if the token is at a linebreak.
* @param allowLineBreaks whether whitespace should be
* flagged at line breaks.
*/
public void setAllowLineBreaks(boolean allowLineBreaks) {
this.allowLineBreaks = allowLineBreaks;
}
}