-
Notifications
You must be signed in to change notification settings - Fork 111
/
QualifyInnerClassCheck.java
167 lines (155 loc) · 5.8 KB
/
QualifyInnerClassCheck.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
/*
* Copyright (c) 2011-2024 Qulice.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the Qulice.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.qulice.checkstyle;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.HashSet;
import java.util.Set;
/**
* Checks if inner classes are properly accessed using their qualified name
* with the outer class.
*
* @since 0.18
* @todo #738:30min Static inner classes should be qualified with outer class
* Implement QualifyInnerClassCheck so it follows what defined in
* QualifyInnerClassCheck test and add this check to checks.xml and CheckTest.
*/
public final class QualifyInnerClassCheck extends AbstractCheck {
// FIXME: do we need to clear these fields in the end?
/**
* Set of all nested classes.
*/
private Set<String> nested = new HashSet<>();
/**
* Whether we already visited root class of the .java file.
*/
private boolean root;
@Override
public int[] getDefaultTokens() {
return new int[]{
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.LITERAL_NEW,
};
}
@Override
public int[] getAcceptableTokens() {
return this.getDefaultTokens();
}
@Override
public int[] getRequiredTokens() {
return this.getDefaultTokens();
}
@Override
public void visitToken(final DetailAST ast) {
if (ast.getType() == TokenTypes.CLASS_DEF
|| ast.getType() == TokenTypes.ENUM_DEF
|| ast.getType() == TokenTypes.INTERFACE_DEF) {
this.scanForNestedClassesIfNecessary(ast);
}
if (ast.getType() == TokenTypes.LITERAL_NEW) {
this.visitNewExpression(ast);
}
}
/**
* Checks if class to be instantiated is nested and unqualified.
*
* FIXME: currently only simple paths are detected
* (i.e. `new Foo`, but not `new Foo.Bar`)
* @param expr EXPR LITERAL_NEW node that needs to be checked
*/
private void visitNewExpression(final DetailAST expr) {
final DetailAST child = expr.getFirstChild();
if (child.getType() == TokenTypes.IDENT) {
if (this.nested.contains(child.getText())) {
this.log(child, "Static inner class should be qualified with outer class");
}
} else if (child.getType() != TokenTypes.DOT) {
final String message = String.format("unsupported input %d", child.getType());
throw new IllegalStateException(message);
}
}
/**
* If provided class is top-level, scans it for nested classes.
* FIXME: currently it assumes there can be only one top-level class
*
* @param node Class-like AST node
*/
private void scanForNestedClassesIfNecessary(final DetailAST node) {
if (!this.root) {
this.root = true;
this.scanClass(node);
}
}
/**
* Scans class for all nested sub-classes.
*
* FIXME: checkstyle discourages manual traversing of AST,
* but exactly this is happening here.
* @param node Class-like AST node that needs to be checked
*/
private void scanClass(final DetailAST node) {
this.nested.add(getClassName(node));
final DetailAST content = node.findFirstToken(TokenTypes.OBJBLOCK);
if (content == null) {
return;
}
for (
DetailAST child = content.getFirstChild();
child != null;
child = child.getNextSibling()
) {
if (child.getType() == TokenTypes.CLASS_DEF
|| child.getType() == TokenTypes.ENUM_DEF
|| child.getType() == TokenTypes.INTERFACE_DEF) {
this.scanClass(child);
}
}
}
/**
* Returns class name.
* @param clazz Class-like AST node
* @return Class name
*/
private static String getClassName(final DetailAST clazz) {
for (
DetailAST child = clazz.getFirstChild();
child != null;
child = child.getNextSibling()
) {
if (child.getType() == TokenTypes.IDENT) {
return child.getText();
}
}
throw new IllegalStateException("unexpected input: can not find class name");
}
}