/
OuterTypeFilenameCheck.java
176 lines (157 loc) · 4.84 KB
/
OuterTypeFilenameCheck.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
////////////////////////////////////////////////////////////////////////////////
// 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;
import java.io.File;
import java.util.regex.Pattern;
import com.puppycrawl.tools.checkstyle.FileStatefulCheck;
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.TokenUtil;
/**
* <p>
* Checks that the outer type name and the file name match.
* For example, the class {@code Foo} must be in a file named {@code Foo.java}.
* </p>
* <p>
* To configure the check:
* </p>
* <pre>
* <module name="OuterTypeFilename"/>
* </pre>
* <p>Example of class Test in a file named Test.java</p>
* <pre>
* public class Test { // OK
*
* }
* </pre>
* <p>Example of class Foo in a file named Test.java</p>
* <pre>
* class Foo { // violation
*
* }
* </pre>
* <p>Example of interface Foo in a file named Test.java</p>
* <pre>
* interface Foo { // violation
*
* }
* </pre>
* <p>Example of enum Foo in a file named Test.java</p>
* <pre>
* enum Foo { // violation
*
* }
* </pre>
* <p>Example of record Foo in a file named Test.java</p>
* <pre>
* record Foo { // violation
*
* }
* </pre>
* <p>
* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
* </p>
* <p>
* Violation Message Keys:
* </p>
* <ul>
* <li>
* {@code type.file.mismatch}
* </li>
* </ul>
*
* @since 5.3
*/
@FileStatefulCheck
public class OuterTypeFilenameCheck extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "type.file.mismatch";
/** Pattern matching any file extension with dot included. */
private static final Pattern FILE_EXTENSION_PATTERN = Pattern.compile("\\.[^.]*$");
/** Indicates whether the first token has been seen in the file. */
private boolean seenFirstToken;
/** Current file name. */
private String fileName;
/** If file has public type. */
private boolean hasPublic;
/** Outer type with mismatched file name. */
private DetailAST wrongType;
@Override
public int[] getDefaultTokens() {
return getRequiredTokens();
}
@Override
public int[] getAcceptableTokens() {
return getRequiredTokens();
}
@Override
public int[] getRequiredTokens() {
return new int[] {
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.RECORD_DEF,
};
}
@Override
public void beginTree(DetailAST rootAST) {
fileName = getSourceFileName();
seenFirstToken = false;
hasPublic = false;
wrongType = null;
}
@Override
public void visitToken(DetailAST ast) {
if (seenFirstToken) {
final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
if (modifiers.findFirstToken(TokenTypes.LITERAL_PUBLIC) != null
&& TokenUtil.isRootNode(ast.getParent())) {
hasPublic = true;
}
}
else {
final String outerTypeName = ast.findFirstToken(TokenTypes.IDENT).getText();
if (!fileName.equals(outerTypeName)) {
wrongType = ast;
}
}
seenFirstToken = true;
}
@Override
public void finishTree(DetailAST rootAST) {
if (!hasPublic && wrongType != null) {
log(wrongType, MSG_KEY);
}
}
/**
* Get source file name.
*
* @return source file name.
*/
private String getSourceFileName() {
String name = getFilePath();
name = name.substring(name.lastIndexOf(File.separatorChar) + 1);
return FILE_EXTENSION_PATTERN.matcher(name).replaceAll("");
}
}