forked from checkstyle/checkstyle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DetailAST.java
431 lines (383 loc) · 12.2 KB
/
DetailAST.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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 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.api;
import java.util.BitSet;
import antlr.CommonASTWithHiddenTokens;
import antlr.Token;
import antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.utils.TokenUtils;
/**
* An extension of the CommonAST that records the line and column number.
*
* @author Oliver Burn
* @author lkuehne
* @see <a href="http://www.antlr.org/">ANTLR Website</a>
* @noinspection FieldNotUsedInToString, SerializableHasSerializationMethods
*/
public final class DetailAST extends CommonASTWithHiddenTokens {
private static final long serialVersionUID = -2580884815577559874L;
/** Constant to indicate if not calculated the child count. */
private static final int NOT_INITIALIZED = Integer.MIN_VALUE;
/** The line number. **/
private int lineNo = NOT_INITIALIZED;
/** The column number. **/
private int columnNo = NOT_INITIALIZED;
/** Number of children. */
private int childCount = NOT_INITIALIZED;
/** The parent token. */
private DetailAST parent;
/** Previous sibling. */
private DetailAST previousSibling;
/**
* All token types in this branch.
* Token 'x' (where x is an int) is in this branch
* if branchTokenTypes.get(x) is true.
*/
private BitSet branchTokenTypes;
@Override
public void initialize(Token tok) {
super.initialize(tok);
lineNo = tok.getLine();
// expect columns to start @ 0
columnNo = tok.getColumn() - 1;
}
@Override
public void initialize(AST ast) {
final DetailAST detailAst = (DetailAST) ast;
setText(detailAst.getText());
setType(detailAst.getType());
lineNo = detailAst.getLineNo();
columnNo = detailAst.getColumnNo();
hiddenAfter = detailAst.getHiddenAfter();
hiddenBefore = detailAst.getHiddenBefore();
}
@Override
public void setFirstChild(AST ast) {
clearBranchTokenTypes();
clearChildCountCache(this);
super.setFirstChild(ast);
if (ast != null) {
((DetailAST) ast).setParent(this);
}
}
@Override
public void setNextSibling(AST ast) {
clearBranchTokenTypes();
clearChildCountCache(parent);
super.setNextSibling(ast);
if (ast != null && parent != null) {
((DetailAST) ast).setParent(parent);
}
if (ast != null) {
((DetailAST) ast).previousSibling = this;
}
}
/**
* Add previous sibling.
* @param ast
* DetailAST object.
*/
public void addPreviousSibling(DetailAST ast) {
clearBranchTokenTypes();
clearChildCountCache(parent);
if (ast != null) {
//parent is set in setNextSibling or parent.setFirstChild
final DetailAST previousSiblingNode = previousSibling;
if (previousSiblingNode != null) {
ast.previousSibling = previousSiblingNode;
previousSiblingNode.setNextSibling(ast);
}
else if (parent != null) {
parent.setFirstChild(ast);
}
ast.setNextSibling(this);
previousSibling = ast;
}
}
/**
* Add next sibling.
* @param ast
* DetailAST object.
*/
public void addNextSibling(DetailAST ast) {
clearBranchTokenTypes();
clearChildCountCache(parent);
if (ast != null) {
//parent is set in setNextSibling
final DetailAST nextSibling = getNextSibling();
if (nextSibling != null) {
ast.setNextSibling(nextSibling);
nextSibling.previousSibling = ast;
}
ast.previousSibling = this;
setNextSibling(ast);
}
}
@Override
public void addChild(AST ast) {
clearBranchTokenTypes();
clearChildCountCache(this);
if (ast != null) {
((DetailAST) ast).setParent(this);
((DetailAST) ast).previousSibling = getLastChild();
}
super.addChild(ast);
}
/**
* Returns the number of child nodes one level below this node. That is is
* does not recurse down the tree.
* @return the number of child nodes
*/
public int getChildCount() {
// lazy init
if (childCount == NOT_INITIALIZED) {
childCount = 0;
AST child = getFirstChild();
while (child != null) {
childCount += 1;
child = child.getNextSibling();
}
}
return childCount;
}
/**
* Returns the number of direct child tokens that have the specified type.
* @param type the token type to match
* @return the number of matching token
*/
public int getChildCount(int type) {
int count = 0;
for (AST ast = getFirstChild(); ast != null; ast = ast.getNextSibling()) {
if (ast.getType() == type) {
count++;
}
}
return count;
}
/**
* Set the parent token.
* @param parent the parent token
*/
private void setParent(DetailAST parent) {
clearBranchTokenTypes();
this.parent = parent;
final DetailAST nextSibling = getNextSibling();
if (nextSibling != null) {
nextSibling.setParent(parent);
nextSibling.previousSibling = this;
}
}
/**
* Returns the parent token.
* @return the parent token
*/
public DetailAST getParent() {
return parent;
}
/**
* Gets line number.
* @return the line number
*/
public int getLineNo() {
int resultNo = -1;
if (lineNo == NOT_INITIALIZED) {
// an inner AST that has been initialized
// with initialize(String text)
resultNo = findLineNo(getFirstChild());
if (resultNo == -1) {
resultNo = findLineNo(getNextSibling());
}
}
if (resultNo == -1) {
resultNo = lineNo;
}
return resultNo;
}
/**
* Set line number.
* @param lineNo
* line number.
*/
public void setLineNo(int lineNo) {
this.lineNo = lineNo;
}
/**
* Gets column number.
* @return the column number
*/
public int getColumnNo() {
int resultNo = -1;
if (columnNo == NOT_INITIALIZED) {
// an inner AST that has been initialized
// with initialize(String text)
resultNo = findColumnNo(getFirstChild());
if (resultNo == -1) {
resultNo = findColumnNo(getNextSibling());
}
}
if (resultNo == -1) {
resultNo = columnNo;
}
return resultNo;
}
/**
* Set column number.
* @param columnNo
* column number.
*/
public void setColumnNo(int columnNo) {
this.columnNo = columnNo;
}
/**
* Gets the last child node.
* @return the last child node
*/
public DetailAST getLastChild() {
DetailAST ast = getFirstChild();
while (ast != null && ast.getNextSibling() != null) {
ast = ast.getNextSibling();
}
return ast;
}
/**
* Finds column number in the first non-comment node.
*
* @param ast DetailAST node.
* @return Column number if non-comment node exists, -1 otherwise.
*/
private static int findColumnNo(DetailAST ast) {
int resultNo = -1;
DetailAST node = ast;
while (node != null) {
// comment node can't be start of any java statement/definition
if (TokenUtils.isCommentType(node.getType())) {
node = node.getNextSibling();
}
else {
resultNo = node.getColumnNo();
break;
}
}
return resultNo;
}
/**
* Finds line number in the first non-comment node.
*
* @param ast DetailAST node.
* @return Line number if non-comment node exists, -1 otherwise.
*/
private static int findLineNo(DetailAST ast) {
int resultNo = -1;
DetailAST node = ast;
while (node != null) {
// comment node can't be start of any java statement/definition
if (TokenUtils.isCommentType(node.getType())) {
node = node.getNextSibling();
}
else {
resultNo = node.getLineNo();
break;
}
}
return resultNo;
}
/**
* Returns token type with branch.
* @return the token types that occur in the branch as a sorted set.
*/
private BitSet getBranchTokenTypes() {
// lazy init
if (branchTokenTypes == null) {
branchTokenTypes = new BitSet();
branchTokenTypes.set(getType());
// add union of all children
DetailAST child = getFirstChild();
while (child != null) {
final BitSet childTypes = child.getBranchTokenTypes();
branchTokenTypes.or(childTypes);
child = child.getNextSibling();
}
}
return branchTokenTypes;
}
/**
* Checks if this branch of the parse tree contains a token
* of the provided type.
* @param type a TokenType
* @return true if and only if this branch (including this node)
* contains a token of type {@code type}.
*/
public boolean branchContains(int type) {
return getBranchTokenTypes().get(type);
}
/**
* Returns the previous sibling or null if no such sibling exists.
* @return the previous sibling or null if no such sibling exists.
*/
public DetailAST getPreviousSibling() {
return previousSibling;
}
/**
* Returns the first child token that makes a specified type.
* @param type the token type to match
* @return the matching token, or null if no match
*/
public DetailAST findFirstToken(int type) {
DetailAST returnValue = null;
for (DetailAST ast = getFirstChild(); ast != null; ast = ast.getNextSibling()) {
if (ast.getType() == type) {
returnValue = ast;
break;
}
}
return returnValue;
}
@Override
public String toString() {
return super.toString() + "[" + getLineNo() + "x" + getColumnNo() + "]";
}
@Override
public DetailAST getNextSibling() {
return (DetailAST) super.getNextSibling();
}
@Override
public DetailAST getFirstChild() {
return (DetailAST) super.getFirstChild();
}
/**
* Clears the child count for the ast instance.
* @param ast The ast to clear.
*/
private static void clearChildCountCache(DetailAST ast) {
if (ast != null) {
ast.childCount = NOT_INITIALIZED;
}
}
/**
* Clears branchTokenTypes cache for all parents of the current DetailAST instance, and the
* child count for the current DetailAST instance.
*/
private void clearBranchTokenTypes() {
DetailAST prevParent = parent;
while (prevParent != null) {
prevParent.branchTokenTypes = null;
prevParent = prevParent.parent;
}
}
}