-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
ArrayTypeStyleCheck.java
97 lines (84 loc) · 3.48 KB
/
ArrayTypeStyleCheck.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
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2019 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;
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;
/**
* Checks the style of array type definitions.
* Some like Java-style: {@code public static void main(String[] args)}
* and some like C-style: {@code public static void main(String args[])}.
*
* <p>By default the Check enforces Java style.</p>
*
* <p>This check also enforces the style of method return types:</p>
* <pre>
* public byte getData()[] // violation (for both Java and C style)
*
* public char[] toCharArray() // ok
* </pre>
*/
@StatelessCheck
public class ArrayTypeStyleCheck extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "array.type.style";
/** Controls whether to use Java or C style. */
private boolean javaStyle = true;
@Override
public int[] getDefaultTokens() {
return getRequiredTokens();
}
@Override
public int[] getAcceptableTokens() {
return getRequiredTokens();
}
@Override
public int[] getRequiredTokens() {
return new int[] {TokenTypes.ARRAY_DECLARATOR};
}
@Override
public void visitToken(DetailAST ast) {
final DetailAST typeAST = ast.getParent();
if (typeAST.getType() == TokenTypes.TYPE) {
final DetailAST variableAST = typeAST.getNextSibling();
if (variableAST != null) {
final boolean isMethod = typeAST.getParent().getType() == TokenTypes.METHOD_DEF;
final boolean isJavaStyle = variableAST.getLineNo() > ast.getLineNo()
|| variableAST.getColumnNo() - ast.getColumnNo() > -1;
// force all methods to be Java style (C functions can't return arrays)
final boolean isMethodViolation = isMethod && !isJavaStyle;
final boolean isVariableViolation = !isMethod && isJavaStyle != javaStyle;
if (isMethodViolation || isVariableViolation) {
log(ast, MSG_KEY);
}
}
}
}
/**
* Controls whether to check for Java or C style.
* @param javaStyle true if Java style should be used.
*/
public void setJavaStyle(boolean javaStyle) {
this.javaStyle = javaStyle;
}
}