-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
ScopeUtils.java
297 lines (276 loc) · 9.34 KB
/
ScopeUtils.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2004 Oliver Burn
//
// 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.api;
import antlr.collections.AST;
/**
* Contains utility methods for working on scope.
*
* @author Oliver Burn
* @version 1.0
*/
public final class ScopeUtils
{
///CLOVER:OFF
/** prevent instantiation */
private ScopeUtils()
{
}
///CLOVER:ON
/**
* Returns the Scope specified by the modifier set.
*
* @param aMods root node of a modifier set
* @return a <code>Scope</code> value
*/
public static Scope getScopeFromMods(DetailAST aMods)
{
Scope retVal = Scope.PACKAGE; // default scope
for (AST token = aMods.getFirstChild();
token != null;
token = token.getNextSibling())
{
if ("public".equals(token.getText())) {
retVal = Scope.PUBLIC;
break;
}
else if ("protected".equals(token.getText())) {
retVal = Scope.PROTECTED;
break;
}
else if ("private".equals(token.getText())) {
retVal = Scope.PRIVATE;
break;
}
}
return retVal;
}
/**
* Returns the scope of the surrounding "block".
* @param aAST the node to return the scope for
* @return the Scope of the surrounding block
*/
public static Scope getSurroundingScope(DetailAST aAST)
{
Scope retVal = null;
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if ((type == TokenTypes.CLASS_DEF)
|| (type == TokenTypes.INTERFACE_DEF)
|| (type == TokenTypes.ANNOTATION_DEF)
|| (type == TokenTypes.ENUM_DEF))
{
final DetailAST mods =
token.findFirstToken(TokenTypes.MODIFIERS);
final Scope modScope = ScopeUtils.getScopeFromMods(mods);
if ((retVal == null) || (retVal.isIn(modScope))) {
retVal = modScope;
}
}
else if (type == TokenTypes.LITERAL_NEW) {
retVal = Scope.ANONINNER;
break; //because Scope.ANONINNER is not in any other Scope
}
}
return retVal;
}
/**
* Returns whether a node is directly contained within an interface block.
*
* @param aAST the node to check if directly contained within an interface
* block
* @return a <code>boolean</code> value
*/
public static boolean inInterfaceBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing interface block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if (type == TokenTypes.CLASS_DEF) {
break; // in a class
}
else if (type == TokenTypes.LITERAL_NEW) {
break; // inner implementation
}
else if (type == TokenTypes.INTERFACE_DEF) {
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether a node is directly contained within an annotation block.
*
* @param aAST the node to check if directly contained within an annotation
* block
* @return a <code>boolean</code> value
*/
public static boolean inAnnotationBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing interface block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if (type == TokenTypes.CLASS_DEF) {
break; // in a class
}
else if (type == TokenTypes.LITERAL_NEW) {
break; // inner implementation
}
else if (type == TokenTypes.ANNOTATION_DEF) {
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether a node is directly contained within an interface or
* annotation block.
*
* @param aAST the node to check if directly contained within an interface
* or annotation block
* @return a <code>boolean</code> value
*/
public static boolean inInterfaceOrAnnotationBlock(DetailAST aAST)
{
return inInterfaceBlock(aAST) || inAnnotationBlock(aAST);
}
/**
* Returns whether a node is directly contained within an enum block.
*
* @param aAST the node to check if directly contained within an enum
* block
* @return a <code>boolean</code> value
*/
public static boolean inEnumBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing interface block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if (type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.CLASS_DEF)
{
break; // in an interface, annotation or class
}
else if (type == TokenTypes.LITERAL_NEW) {
break; // inner implementation, enums can't be inner classes
}
else if (type == TokenTypes.ENUM_DEF) {
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether the scope of a node is restricted to a code block.
* A code block is a method or constructor body, or a initialiser block.
*
* @param aAST the node to check
* @return a <code>boolean</code> value
*/
public static boolean inCodeBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing code block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if ((type == TokenTypes.METHOD_DEF)
|| (type == TokenTypes.CTOR_DEF)
|| (type == TokenTypes.INSTANCE_INIT)
|| (type == TokenTypes.STATIC_INIT))
{
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether a node is contained in the outer most type block.
*
* @param aAST the node to check
* @return a <code>boolean</code> value
*/
public static boolean isOuterMostType(DetailAST aAST)
{
boolean retVal = true;
for (DetailAST parent = aAST.getParent();
parent != null;
parent = parent.getParent())
{
if ((parent.getType() == TokenTypes.CLASS_DEF)
|| (parent.getType() == TokenTypes.INTERFACE_DEF)
|| (parent.getType() == TokenTypes.ANNOTATION_DEF)
|| (parent.getType() == TokenTypes.ENUM_DEF))
{
retVal = false;
break;
}
}
return retVal;
}
/**
* Determines whether a node is a local variable definition.
* I.e. if it is declared in a code block, a for initializer,
* or a catch parameter.
* @param aAST the node to check.
* @return whether aAST is a local variable definition.
*/
public static boolean isLocalVariableDef(DetailAST aAST)
{
// variable declaration?
if (aAST.getType() == TokenTypes.VARIABLE_DEF) {
final DetailAST parent = aAST.getParent();
if (parent != null) {
final int type = parent.getType();
return (type == TokenTypes.SLIST)
|| (type == TokenTypes.FOR_INIT)
|| (type == TokenTypes.FOR_EACH_CLAUSE);
}
}
// catch parameter?
else if (aAST.getType() == TokenTypes.PARAMETER_DEF) {
final DetailAST parent = aAST.getParent();
if (parent != null) {
return (parent.getType() == TokenTypes.LITERAL_CATCH);
}
}
return false;
}
}