FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
codeql/java/ql/lib/semmle/code/java/PrintAst.qll at codeql-cli/v2.19.2 · github/codeql · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
github
/
codeql
Public
Notifications
You must be signed in to change notification settings
Fork
2.1k
Star
10k
Code
Issues
997
Pull requests
467
Discussions
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
codeql
/
java
/
ql
/
lib
/
semmle
/
code
/
java
/
PrintAst.qll
Copy path
More file actions
More file actions
Latest commit
History
History
History
940 lines (789 loc) · 27.2 KB
Breadcrumbs
codeql
/
java
/
ql
/
lib
/
semmle
/
code
/
java
/
PrintAst.qll
Copy path
File metadata and controls
940 lines (789 loc) · 27.2 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
/**
* Provides queries to pretty-print a Java AST as a graph.
*
* By default, this will print the AST for all elements in the database. To change this behavior,
* extend `PrintAstConfiguration` and override `shouldPrint` to hold for only the elements
* you wish to view the AST for.
*/
import
java
import
semmle.code.java.regex.RegexTreeView
as
RegexTreeView
private
newtype
TPrintAstConfiguration
=
MkPrintAstConfiguration
(
)
/**
* The query can extend this class to control which elements are printed.
*/
class
PrintAstConfiguration
extends
TPrintAstConfiguration
{
/**
* Gets a textual representation of this `PrintAstConfiguration`.
*/
string
toString
(
)
{
result
=
"PrintAstConfiguration"
}
/**
* Controls whether the `Element` should be considered for AST printing.
* By default it checks whether the `Element` `e` belongs to `Location` `l`.
*/
predicate
shouldPrint
(
Element
e
,
Location
l
)
{
e
.
fromSource
(
)
and
l
=
e
.
getLocation
(
)
}
}
private
predicate
shouldPrint
(
Element
e
,
Location
l
)
{
exists
(
PrintAstConfiguration
config
|
config
.
shouldPrint
(
e
,
l
)
)
}
private
class
ExprOrStmt
extends
Element
{
ExprOrStmt
(
)
{
this
instanceof
Expr
or
this
instanceof
Stmt
}
ExprOrStmt
getParent
(
)
{
result
=
this
.
(
Expr
)
.
getParent
(
)
or
result
=
this
.
(
Stmt
)
.
getParent
(
)
}
Callable
getEnclosingCallable
(
)
{
result
=
this
.
(
Expr
)
.
getEnclosingCallable
(
)
or
result
=
this
.
(
Stmt
)
.
getEnclosingCallable
(
)
}
}
/** Holds if the given element does not need to be rendered in the AST, due to being compiler-generated. */
private
predicate
isNotNeeded
(
Element
el
)
{
exists
(
InitializerMethod
im
|
el
=
im
or
exists
(
ExprOrStmt
e
|
e
=
el
|
e
.
getEnclosingCallable
(
)
=
im
and
not
e
.
getParent
*
(
)
=
any
(
Field
f
)
.
getInitializer
(
)
and
not
isInitBlock
(
im
.
getDeclaringType
(
)
,
e
.
getParent
*
(
)
)
)
)
or
exists
(
Constructor
c
|
c
.
isDefaultConstructor
(
)
|
el
=
c
or
el
.
(
ExprOrStmt
)
.
getEnclosingCallable
(
)
=
c
)
or
exists
(
Constructor
c
,
int
sline
,
int
eline
,
int
scol
,
int
ecol
|
el
.
(
ExprOrStmt
)
.
getEnclosingCallable
(
)
=
c
|
el
.
getLocation
(
)
.
hasLocationInfo
(
_
,
sline
,
eline
,
scol
,
ecol
)
and
c
.
getLocation
(
)
.
hasLocationInfo
(
_
,
sline
,
eline
,
scol
,
ecol
)
and
not
c
.
getFile
(
)
.
isKotlinSourceFile
(
)
// Kotlin constructor bodies have the same location as the constructor
// simply comparing their getLocation() doesn't work as they have distinct but equivalent locations
)
or
isNotNeeded
(
el
.
(
Expr
)
.
getParent
*
(
)
.
(
Annotation
)
.
getAnnotatedElement
(
)
)
or
isNotNeeded
(
el
.
(
Parameter
)
.
getCallable
(
)
)
}
/** Holds if the given field would have the same javadoc and annotations as another field declared in the same declaration */
private
predicate
duplicateMetadata
(
Field
f
)
{
exists
(
FieldDeclaration
fd
|
f
=
fd
.
getAField
(
)
and
not
f
=
fd
.
getField
(
0
)
)
}
/**
* Retrieves the canonical QL class(es) for entity `el`
*/
private
string
getQlClass
(
Top
el
)
{
result
=
"["
+
el
.
getPrimaryQlClasses
(
)
+
"] "
// Alternative implementation -- do not delete. It is useful for QL class discovery.
// result = "[" + concat(el.getAQlClass(), ",") + "] "
}
private
predicate
locationSortKeys
(
Element
ast
,
string
file
,
int
line
,
int
column
)
{
exists
(
Location
loc
|
loc
=
ast
.
getLocation
(
)
and
file
=
loc
.
getFile
(
)
.
toString
(
)
and
line
=
loc
.
getStartLine
(
)
and
column
=
loc
.
getStartColumn
(
)
)
or
not
exists
(
ast
.
getLocation
(
)
)
and
file
=
""
and
line
=
0
and
column
=
0
}
/**
* Printed AST nodes are mostly `Element`s of the underlying AST.
*/
private
newtype
TPrintAstNode
=
TElementNode
(
Element
el
)
{
shouldPrint
(
el
,
_
)
}
or
TForInitNode
(
ForStmt
fs
)
{
shouldPrint
(
fs
,
_
)
and
exists
(
fs
.
getAnInit
(
)
)
}
or
TLocalVarDeclNode
(
LocalVariableDeclExpr
lvde
)
{
shouldPrint
(
lvde
,
_
)
and
(
lvde
.
getParent
(
)
instanceof
SingleLocalVarDeclParent
or
lvde
.
getParent
(
)
instanceof
PatternCase
)
}
or
TAnnotationsNode
(
Annotatable
ann
)
{
shouldPrint
(
ann
,
_
)
and
ann
.
hasDeclaredAnnotation
(
)
and
not
partOfAnnotation
(
ann
)
and
// The Kotlin compiler might add annotations that are only present in byte code, although the annotatable element is
// present in source code.
exists
(
Annotation
a
|
a
.
getAnnotatedElement
(
)
=
ann
and
shouldPrint
(
a
,
_
)
)
}
or
TParametersNode
(
Callable
c
)
{
shouldPrint
(
c
,
_
)
and
not
c
.
hasNoParameters
(
)
}
or
TBaseTypesNode
(
ClassOrInterface
ty
)
{
shouldPrint
(
ty
,
_
)
}
or
TGenericTypeNode
(
GenericType
ty
)
{
shouldPrint
(
ty
,
_
)
}
or
TGenericCallableNode
(
GenericCallable
c
)
{
shouldPrint
(
c
,
_
)
}
or
TDocumentableNode
(
Documentable
d
)
{
shouldPrint
(
d
,
_
)
and
exists
(
d
.
getJavadoc
(
)
)
}
or
TJavadocNode
(
Javadoc
jd
,
Documentable
d
)
{
d
.
getJavadoc
(
)
=
jd
and
shouldPrint
(
d
,
_
)
}
or
TJavadocElementNode
(
JavadocElement
jd
,
Documentable
d
)
{
d
.
getJavadoc
(
)
=
jd
.
getParent
*
(
)
and
shouldPrint
(
d
,
_
)
}
or
TImportsNode
(
CompilationUnit
cu
)
{
shouldPrint
(
cu
,
_
)
and
exists
(
Import
i
|
i
.
getCompilationUnit
(
)
=
cu
)
}
or
TRegExpTermNode
(
RegexTreeView
::
RegExpTerm
term
)
{
exists
(
StringLiteral
str
|
term
.
getRootTerm
(
)
=
RegexTreeView
::
getParsedRegExp
(
str
)
and
shouldPrint
(
str
,
_
)
)
}
/**
* A node in the output tree.
*/
class
PrintAstNode
extends
TPrintAstNode
{
/**
* Gets a textual representation of this node in the PrintAst output tree.
*/
string
toString
(
)
{
none
(
)
}
/**
* Gets the child node at index `childIndex`. Child indices must be unique,
* but need not be contiguous.
*/
PrintAstNode
getChild
(
int
childIndex
)
{
none
(
)
}
/**
* Gets a child of this node.
*/
final
PrintAstNode
getAChild
(
)
{
result
=
this
.
getChild
(
_
)
}
/**
* Gets the parent of this node, if any.
*/
final
PrintAstNode
getParent
(
)
{
result
.
getAChild
(
)
=
this
}
/**
* Gets the location of this node in the source code.
*/
Location
getLocation
(
)
{
none
(
)
}
/**
* Holds if this node is at the specified location.
* The location spans column `startcolumn` of line `startline` to
* column `endcolumn` of line `endline` in file `filepath`.
* For more information, see
* [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
*/
predicate
hasLocationInfo
(
string
filepath
,
int
startline
,
int
startcolumn
,
int
endline
,
int
endcolumn
)
{
this
.
getLocation
(
)
.
hasLocationInfo
(
filepath
,
startline
,
startcolumn
,
endline
,
endcolumn
)
}
/**
* Gets the value of the property of this node, where the name of the property
* is `key`.
*/
string
getProperty
(
string
key
)
{
key
=
"semmle.label"
and
result
=
this
.
toString
(
)
}
/**
* Gets the label for the edge from this node to the specified child. By
* default, this is just the index of the child, but subclasses can override
* this.
*/
string
getChildEdgeLabel
(
int
childIndex
)
{
exists
(
this
.
getChild
(
childIndex
)
)
and
result
=
childIndex
.
toString
(
)
}
}
/** A top-level AST node. */
class
TopLevelPrintAstNode
extends
PrintAstNode
{
TopLevelPrintAstNode
(
)
{
not
exists
(
this
.
getParent
(
)
)
}
private
int
getOrder
(
)
{
this
=
rank
[
result
]
(
TopLevelPrintAstNode
n
,
Location
l
|
l
=
n
.
getLocation
(
)
|
n
order
by
l
.
getFile
(
)
.
getRelativePath
(
)
,
l
.
getStartLine
(
)
,
l
.
getStartColumn
(
)
,
l
.
getEndLine
(
)
,
l
.
getEndColumn
(
)
)
}
override
string
getProperty
(
string
key
)
{
result
=
super
.
getProperty
(
key
)
or
key
=
"semmle.order"
and
result
=
this
.
getOrder
(
)
.
toString
(
)
}
}
/**
* A node representing an AST node with an underlying `Element`.
*/
abstract
class
ElementNode
extends
PrintAstNode
,
TElementNode
{
Element
element
;
ElementNode
(
)
{
this
=
TElementNode
(
element
)
and
not
isNotNeeded
(
element
)
}
override
string
toString
(
)
{
result
=
getQlClass
(
element
)
+
element
.
toString
(
)
}
override
Location
getLocation
(
)
{
result
=
element
.
getLocation
(
)
}
/**
* Gets the `Element` represented by this node.
*/
final
Element
getElement
(
)
{
result
=
element
}
}
/**
* A node representing an `Expr` or a `Stmt`.
*/
class
ExprStmtNode
extends
ElementNode
{
ExprStmtNode
(
)
{
element
instanceof
ExprOrStmt
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
exists
(
Element
el
|
result
.
(
ElementNode
)
.
getElement
(
)
=
el
|
el
.
(
Expr
)
.
isNthChildOf
(
element
,
childIndex
)
or
el
.
(
Stmt
)
.
isNthChildOf
(
element
,
childIndex
)
)
}
}
/**
* A node representing a `KtInitializerAssignExpr`.
*/
class
KtInitializerNode
extends
ExprStmtNode
{
KtInitializerNode
(
)
{
element
instanceof
KtInitializerAssignExpr
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
// Remove the RHS of the initializer, because otherwise
// it appears as both the initializer's child and the
// initialize of the related field, producing a DAG not
// a tree and consequently unreadable output.
result
=
super
.
getChild
(
childIndex
)
and
childIndex
=
0
}
}
/**
* Holds if the given expression is part of an annotation.
*/
private
predicate
partOfAnnotation
(
Expr
e
)
{
e
instanceof
Annotation
or
e
instanceof
ArrayInit
and
partOfAnnotation
(
e
.
getParent
(
)
)
}
/**
* A node representing an `Expr` that is part of an annotation.
*/
final
class
AnnotationPartNode
extends
ExprStmtNode
{
AnnotationPartNode
(
)
{
partOfAnnotation
(
element
)
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
=
rank
[
childIndex
]
(
Element
ch
,
string
file
,
int
line
,
int
column
,
int
idx
|
ch
=
this
.
getAnnotationChild
(
idx
)
and
locationSortKeys
(
ch
,
file
,
line
,
column
)
|
ch
order
by
file
,
line
,
column
,
idx
)
}
private
Expr
getAnnotationChild
(
int
index
)
{
result
=
element
.
(
Annotation
)
.
getValue
(
_
)
and
index
>=
0
and
if
exists
(
int
x
|
x
>=
0
|
result
.
isNthChildOf
(
element
,
x
)
)
then
result
.
isNthChildOf
(
element
,
index
)
else
result
.
isNthChildOf
(
element
,
-
(
index
+
1
)
)
or
result
=
element
.
(
ArrayInit
)
.
getInit
(
index
)
}
}
/**
* A node representing a `StringLiteral`.
* If it is used as a regular expression, then it has a single child, the root of the parsed regular expression.
*/
final
class
StringLiteralNode
extends
ExprStmtNode
{
StringLiteralNode
(
)
{
element
instanceof
StringLiteral
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
childIndex
=
0
and
result
.
(
RegExpTermNode
)
.
getTerm
(
)
=
RegexTreeView
::
getParsedRegExp
(
element
)
}
}
/**
* A node representing a regular expression term.
*/
class
RegExpTermNode
extends
TRegExpTermNode
,
PrintAstNode
{
RegexTreeView
::
RegExpTerm
term
;
RegExpTermNode
(
)
{
this
=
TRegExpTermNode
(
term
)
}
/** Gets the `RegExpTerm` for this node. */
RegexTreeView
::
RegExpTerm
getTerm
(
)
{
result
=
term
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
result
.
(
RegExpTermNode
)
.
getTerm
(
)
=
term
.
getChild
(
childIndex
)
}
override
string
toString
(
)
{
result
=
"["
+
strictconcat
(
term
.
getPrimaryQLClass
(
)
,
" | "
)
+
"] "
+
term
.
toString
(
)
}
override
Location
getLocation
(
)
{
result
=
term
.
getLocation
(
)
}
override
predicate
hasLocationInfo
(
string
filepath
,
int
startline
,
int
startcolumn
,
int
endline
,
int
endcolumn
)
{
term
.
hasLocationInfo
(
filepath
,
startline
,
startcolumn
,
endline
,
endcolumn
)
}
}
/**
* A node representing a `LocalVariableDeclExpr`.
*/
final
class
LocalVarDeclExprNode
extends
ExprStmtNode
{
LocalVarDeclExprNode
(
)
{
element
instanceof
LocalVariableDeclExpr
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
result
=
super
.
getChild
(
childIndex
)
or
childIndex
=
-
2
and
result
.
(
AnnotationsNode
)
.
getAnnotated
(
)
=
element
.
(
LocalVariableDeclExpr
)
.
getVariable
(
)
}
}
/**
* A node representing a `ClassInstanceExpr`.
*/
final
class
ClassInstanceExprNode
extends
ExprStmtNode
{
ClassInstanceExprNode
(
)
{
element
instanceof
ClassInstanceExpr
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
=
super
.
getChild
(
childIndex
)
or
childIndex
=
-
4
and
result
.
getElement
(
)
=
element
.
(
ClassInstanceExpr
)
.
getAnonymousClass
(
)
and
not
result
.
getElement
(
)
instanceof
LocalClassOrInterface
// Kotlin anonymous classes are extracted as local classes too.
}
}
/**
* A node representing a `LocalTypeDeclStmt`.
*/
final
class
LocalTypeDeclStmtNode
extends
ExprStmtNode
{
LocalTypeDeclStmtNode
(
)
{
element
instanceof
LocalTypeDeclStmt
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
=
super
.
getChild
(
childIndex
)
or
childIndex
=
0
and
result
.
getElement
(
)
=
element
.
(
LocalTypeDeclStmt
)
.
getLocalType
(
)
}
}
/**
* A node representing a `ForStmt`.
*/
final
class
ForStmtNode
extends
ExprStmtNode
{
ForStmtNode
(
)
{
element
instanceof
ForStmt
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
childIndex
>=
1
and
result
=
super
.
getChild
(
childIndex
)
or
childIndex
=
0
and
result
.
(
ForInitNode
)
.
getForStmt
(
)
=
element
}
}
/**
* A node representing a `PatternCase`.
*/
final
class
PatternCaseNode
extends
ExprStmtNode
{
PatternCase
pc
;
PatternCaseNode
(
)
{
pc
=
element
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
result
=
super
.
getChild
(
childIndex
)
and
not
result
.
(
ElementNode
)
.
getElement
(
)
instanceof
LocalVariableDeclExpr
and
not
result
.
(
ElementNode
)
.
getElement
(
)
instanceof
TypeAccess
or
result
=
TLocalVarDeclNode
(
pc
.
getPattern
(
childIndex
)
)
}
}
/**
* An element that can be the parent of up to one `LocalVariableDeclExpr` for which we want
* to use a synthetic node to hold the variable declaration and its `TypeAccess`.
*/
private
class
SingleLocalVarDeclParent
extends
ExprOrStmt
{
SingleLocalVarDeclParent
(
)
{
this
instanceof
EnhancedForStmt
or
this
instanceof
CatchClause
or
this
.
(
InstanceOfExpr
)
.
isPattern
(
)
}
/** Gets the variable declaration that this element contains */
LocalVariableDeclExpr
getVariable
(
)
{
result
.
getParent
(
)
=
this
}
/** Gets the type access of the variable */
Expr
getTypeAccess
(
)
{
result
=
this
.
getVariable
(
)
.
getTypeAccess
(
)
}
}
/**
* A node representing an element that can be the parent of up to one `LocalVariableDeclExpr` for which we
* want to use a synthetic node to variable declaration and its type access.
*
* Excludes `LocalVariableDeclStmt` and `ForStmt`, as they can hold multiple declarations.
* For these cases, either a synthetic node is not necessary or a different synthetic node is used.
*/
final
class
SingleLocalVarDeclParentNode
extends
ExprStmtNode
{
SingleLocalVarDeclParent
lvdp
;
SingleLocalVarDeclParentNode
(
)
{
lvdp
=
element
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
result
=
super
.
getChild
(
childIndex
)
and
not
result
.
(
ElementNode
)
.
getElement
(
)
=
[
lvdp
.
getVariable
(
)
,
lvdp
.
getTypeAccess
(
)
]
or
childIndex
=
lvdp
.
getVariable
(
)
.
getIndex
(
)
and
result
.
(
LocalVarDeclSynthNode
)
.
getVariable
(
)
=
lvdp
.
getVariable
(
)
}
}
/**
* A node representing a `Callable`, such as method declaration.
*/
final
class
CallableNode
extends
ElementNode
{
Callable
callable
;
CallableNode
(
)
{
callable
=
element
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
childIndex
=
0
and
result
.
(
DocumentableNode
)
.
getDocumentable
(
)
=
callable
or
childIndex
=
1
and
result
.
(
AnnotationsNode
)
.
getAnnotated
(
)
=
callable
or
childIndex
=
2
and
result
.
(
GenericCallableNode
)
.
getCallable
(
)
=
callable
or
childIndex
=
3
and
result
.
(
ElementNode
)
.
getElement
(
)
.
(
Expr
)
.
isNthChildOf
(
callable
,
-
1
)
// return type
or
childIndex
=
4
and
result
.
(
ParametersNode
)
.
getCallable
(
)
=
callable
or
childIndex
=
5
and
result
.
(
ElementNode
)
.
getElement
(
)
=
callable
.
getBody
(
)
}
}
/**
* A node representing a `Parameter` of a `Callable`.
*/
final
class
ParameterNode
extends
ElementNode
{
Parameter
p
;
ParameterNode
(
)
{
p
=
element
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
childIndex
=
-
1
and
result
.
(
AnnotationsNode
)
.
getAnnotated
(
)
=
p
or
childIndex
=
0
and
result
.
(
ElementNode
)
.
getElement
(
)
.
(
Expr
)
.
isNthChildOf
(
p
,
-
1
)
// type
}
}
private
predicate
isInitBlock
(
Class
c
,
BlockStmt
b
)
{
exists
(
InitializerMethod
m
|
b
.
getParent
(
)
=
m
.
getBody
(
)
and
m
.
getDeclaringType
(
)
=
c
)
}
/**
* A node representing a `Class` or an `Interface`.
*/
final
class
ClassInterfaceNode
extends
ElementNode
{
ClassOrInterface
ty
;
ClassInterfaceNode
(
)
{
ty
=
element
}
private
Element
getADeclaration
(
)
{
result
.
(
Callable
)
.
getDeclaringType
(
)
=
ty
or
result
.
(
FieldDeclaration
)
.
getAField
(
)
.
getDeclaringType
(
)
=
ty
or
result
.
(
MemberType
)
.
getEnclosingType
(
)
.
getSourceDeclaration
(
)
=
ty
or
isInitBlock
(
ty
,
result
)
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
childIndex
=
-
4
and
result
.
(
DocumentableNode
)
.
getDocumentable
(
)
=
ty
or
childIndex
=
-
3
and
result
.
(
AnnotationsNode
)
.
getAnnotated
(
)
=
ty
or
childIndex
=
-
2
and
result
.
(
GenericTypeNode
)
.
getType
(
)
=
ty
or
childIndex
=
-
1
and
result
.
(
BaseTypesNode
)
.
getClassOrInterface
(
)
=
ty
or
childIndex
>=
0
and
result
.
(
ElementNode
)
.
getElement
(
)
=
rank
[
childIndex
]
(
Element
e
,
string
file
,
int
line
,
int
column
,
string
childStr
,
string
sig
|
e
=
this
.
getADeclaration
(
)
and
locationSortKeys
(
e
,
file
,
line
,
column
)
and
childStr
=
e
.
toString
(
)
and
(
if
e
instanceof
Callable
then
sig
=
e
.
(
Callable
)
.
getStringSignature
(
)
else
sig
=
""
)
|
e
order
by
file
,
line
,
column
,
childStr
,
sig
)
}
}
/**
* A node representing a `FieldDeclaration`.
*/
final
class
FieldDeclNode
extends
ElementNode
{
FieldDeclaration
decl
;
FieldDeclNode
(
)
{
decl
=
element
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
childIndex
=
-
3
and
result
.
(
DocumentableNode
)
.
getDocumentable
(
)
=
decl
.
getField
(
0
)
or
childIndex
=
-
2
and
result
.
(
AnnotationsNode
)
.
getAnnotated
(
)
=
decl
.
getField
(
0
)
or
childIndex
=
-
1
and
result
.
(
ElementNode
)
.
getElement
(
)
=
decl
.
getTypeAccess
(
)
or
childIndex
>=
0
and
result
.
(
ElementNode
)
.
getElement
(
)
=
decl
.
getField
(
childIndex
)
.
getInitializer
(
)
}
}
/**
* A node representing a `CompilationUnit`.
*/
final
class
CompilationUnitNode
extends
ElementNode
{
CompilationUnit
cu
;
CompilationUnitNode
(
)
{
cu
=
element
}
private
Element
getADeclaration
(
)
{
cu
.
hasChildElement
(
result
)
}
override
PrintAstNode
getChild
(
int
childIndex
)
{
childIndex
=
-
1
and
result
.
(
ImportsNode
)
.
getCompilationUnit
(
)
=
cu
or
childIndex
>=
0
and
result
.
(
ElementNode
)
.
getElement
(
)
=
rank
[
childIndex
]
(
Element
e
,
string
file
,
int
line
,
int
column
|
e
=
this
.
getADeclaration
(
)
and
locationSortKeys
(
e
,
file
,
line
,
column
)
|
e
order
by
file
,
line
,
column
)
}
}
/**
* A node representing an `Import`.
*/
final
class
ImportNode
extends
ElementNode
{
ImportNode
(
)
{
element
instanceof
Import
}
}
/**
* A node representing a `TypeVariable`.
*/
final
class
TypeVariableNode
extends
ElementNode
{
TypeVariableNode
(
)
{
element
instanceof
TypeVariable
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
.
(
Expr
)
.
isNthChildOf
(
element
,
childIndex
)
}
}
/**
* A node representing the initializers of a `ForStmt`.
*/
final
class
ForInitNode
extends
PrintAstNode
,
TForInitNode
{
ForStmt
fs
;
ForInitNode
(
)
{
this
=
TForInitNode
(
fs
)
}
override
string
toString
(
)
{
result
=
"(For Initializers) "
}
override
ElementNode
getChild
(
int
childIndex
)
{
childIndex
>=
0
and
result
.
getElement
(
)
.
(
Expr
)
.
isNthChildOf
(
fs
,
-
childIndex
)
}
/**
* Gets the underlying `ForStmt`.
*/
ForStmt
getForStmt
(
)
{
result
=
fs
}
}
/**
* A synthetic node holding a `LocalVariableDeclExpr` and its type access.
*/
final
class
LocalVarDeclSynthNode
extends
PrintAstNode
,
TLocalVarDeclNode
{
LocalVariableDeclExpr
lvde
;
LocalVarDeclSynthNode
(
)
{
this
=
TLocalVarDeclNode
(
lvde
)
}
override
string
toString
(
)
{
if
lvde
.
getParent
(
)
instanceof
PatternCase
then
result
=
"(Pattern case declaration)"
else
result
=
"(Single Local Variable Declaration)"
}
override
ElementNode
getChild
(
int
childIndex
)
{
childIndex
=
0
and
result
.
getElement
(
)
=
lvde
.
getTypeAccess
(
)
or
childIndex
=
1
and
result
.
getElement
(
)
=
lvde
}
/**
* Gets the underlying `LocalVariableDeclExpr`
*/
LocalVariableDeclExpr
getVariable
(
)
{
result
=
lvde
}
}
/**
* A node representing the annotations of an `Annotatable`.
* Only rendered if there is at least one annotation.
*/
final
class
AnnotationsNode
extends
PrintAstNode
,
TAnnotationsNode
{
Annotatable
ann
;
AnnotationsNode
(
)
{
this
=
TAnnotationsNode
(
ann
)
and
not
isNotNeeded
(
ann
)
and
not
duplicateMetadata
(
ann
)
}
override
string
toString
(
)
{
result
=
"(Annotations)"
}
override
Location
getLocation
(
)
{
none
(
)
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
=
rank
[
childIndex
]
(
Element
e
,
string
file
,
int
line
,
int
column
,
string
s
|
e
=
ann
.
getAnAnnotation
(
)
and
locationSortKeys
(
e
,
file
,
line
,
column
)
and
s
=
e
.
toString
(
)
|
e
order
by
file
,
line
,
column
,
s
)
}
/**
* Gets the underlying `Annotatable`.
*/
Annotatable
getAnnotated
(
)
{
result
=
ann
}
}
/**
* A node representing the parameters of a `Callable`.
* Only rendered if there is at least one parameter.
*/
final
class
ParametersNode
extends
PrintAstNode
,
TParametersNode
{
Callable
c
;
ParametersNode
(
)
{
this
=
TParametersNode
(
c
)
and
not
isNotNeeded
(
c
)
}
override
string
toString
(
)
{
result
=
"(Parameters)"
}
override
Location
getLocation
(
)
{
none
(
)
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
=
c
.
getParameter
(
childIndex
)
}
/**
* Gets the underlying `Callable`.
*/
Callable
getCallable
(
)
{
result
=
c
}
}
/**
* A node representing the base types of a `Class` or `Interface` that it extends or implements.
* Only redered if there is at least one such type.
*/
final
class
BaseTypesNode
extends
PrintAstNode
,
TBaseTypesNode
{
ClassOrInterface
ty
;
BaseTypesNode
(
)
{
this
=
TBaseTypesNode
(
ty
)
and
exists
(
TypeAccess
ta
|
ta
.
getParent
(
)
=
ty
)
}
override
string
toString
(
)
{
result
=
"(Base Types)"
}
override
Location
getLocation
(
)
{
none
(
)
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
.
(
TypeAccess
)
.
isNthChildOf
(
ty
,
-
2
-
childIndex
)
}
/**
* Gets the underlying `Class` or `Interface`.
*/
ClassOrInterface
getClassOrInterface
(
)
{
result
=
ty
}
}
/**
* A node representing the type parameters of a `Class` or `Interface`.
* Only rendered when the type in question is indeed generic.
*/
final
class
GenericTypeNode
extends
PrintAstNode
,
TGenericTypeNode
{
GenericType
ty
;
GenericTypeNode
(
)
{
this
=
TGenericTypeNode
(
ty
)
}
override
string
toString
(
)
{
result
=
"(Generic Parameters)"
}
override
Location
getLocation
(
)
{
none
(
)
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
=
ty
.
getTypeParameter
(
childIndex
)
}
/**
* Gets the underlying `GenericType`.
*/
GenericType
getType
(
)
{
result
=
ty
}
}
/**
* A node representing the type parameters of a `Callable`.
* Only rendered when the callable in question is indeed generic.
*/
final
class
GenericCallableNode
extends
PrintAstNode
,
TGenericCallableNode
{
GenericCallable
c
;
GenericCallableNode
(
)
{
this
=
TGenericCallableNode
(
c
)
}
override
string
toString
(
)
{
result
=
"(Generic Parameters)"
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
=
c
.
getTypeParameter
(
childIndex
)
}
/**
* Gets the underlying `GenericCallable`.
*/
GenericCallable
getCallable
(
)
{
result
=
c
}
}
/**
* A node representing the documentation of a `Documentable`.
* Only rendered if there is at least one `Javadoc` attatched to it.
*/
final
class
DocumentableNode
extends
PrintAstNode
,
TDocumentableNode
{
Documentable
d
;
DocumentableNode
(
)
{
this
=
TDocumentableNode
(
d
)
and
not
duplicateMetadata
(
d
)
}
override
string
toString
(
)
{
result
=
"(Javadoc)"
}
override
Location
getLocation
(
)
{
none
(
)
}
override
JavadocNode
getChild
(
int
childIndex
)
{
result
.
getDocumentable
(
)
=
d
and
result
.
getJavadoc
(
)
=
rank
[
childIndex
]
(
Javadoc
jd
,
string
file
,
int
line
,
int
column
|
jd
.
getCommentedElement
(
)
=
d
and
jd
.
getLocation
(
)
.
hasLocationInfo
(
file
,
line
,
column
,
_
,
_
)
|
jd
order
by
file
,
line
,
column
)
}
/**
* Gets the underlying `Documentable`.
*/
Documentable
getDocumentable
(
)
{
result
=
d
}
}
/**
* A node representing a `Javadoc`.
* Only rendered if it is the javadoc of some `Documentable`.
*/
final
class
JavadocNode
extends
PrintAstNode
,
TJavadocNode
{
Javadoc
jd
;
Documentable
d
;
JavadocNode
(
)
{
this
=
TJavadocNode
(
jd
,
d
)
and
not
duplicateMetadata
(
d
)
}
override
string
toString
(
)
{
result
=
getQlClass
(
jd
)
+
jd
.
toString
(
)
}
override
Location
getLocation
(
)
{
result
=
jd
.
getLocation
(
)
}
override
JavadocElementNode
getChild
(
int
childIndex
)
{
result
.
getDocumentable
(
)
=
d
and
result
.
getJavadocElement
(
)
=
jd
.
getChild
(
childIndex
)
}
/**
* Gets the `Javadoc` represented by this node.
*/
Javadoc
getJavadoc
(
)
{
result
=
jd
}
/**
* Gets the `Documentable` whose `Javadoc` is represented by this node.
*/
Documentable
getDocumentable
(
)
{
result
=
d
}
}
/**
* A node representing a `JavadocElement`.
* Only rendered if it is part of the javadoc of some `Documentable`.
*/
final
class
JavadocElementNode
extends
PrintAstNode
,
TJavadocElementNode
{
JavadocElement
jd
;
Documentable
d
;
JavadocElementNode
(
)
{
this
=
TJavadocElementNode
(
jd
,
d
)
and
not
duplicateMetadata
(
d
)
}
override
string
toString
(
)
{
result
=
getQlClass
(
jd
)
+
jd
.
toString
(
)
}
override
Location
getLocation
(
)
{
result
=
jd
.
getLocation
(
)
}
override
JavadocElementNode
getChild
(
int
childIndex
)
{
result
.
getDocumentable
(
)
=
d
and
result
.
getJavadocElement
(
)
=
jd
.
(
JavadocParent
)
.
getChild
(
childIndex
)
}
/**
* Gets the `JavadocElement` represented by this node.
*/
JavadocElement
getJavadocElement
(
)
{
result
=
jd
}
/**
* Gets the `Documentable` whose `JavadocElement` is represented by this node.
*/
Documentable
getDocumentable
(
)
{
result
=
d
}
}
/**
* A node representing the `Import`s of a `CompilationUnit`.
* Only rendered if there is at least one import.
*/
final
class
ImportsNode
extends
PrintAstNode
,
TImportsNode
{
CompilationUnit
cu
;
ImportsNode
(
)
{
this
=
TImportsNode
(
cu
)
}
override
string
toString
(
)
{
result
=
"(Imports)"
}
override
ElementNode
getChild
(
int
childIndex
)
{
result
.
getElement
(
)
=
rank
[
childIndex
]
(
Import
im
,
string
file
,
int
line
,
int
column
|
im
.
getCompilationUnit
(
)
=
cu
and
locationSortKeys
(
im
,
file
,
line
,
column
)
|
im
order
by
file
,
line
,
column
)
}
/**
* Gets the underlying CompilationUnit.
*/
CompilationUnit
getCompilationUnit
(
)
{
result
=
cu
}
}
/** Holds if `node` belongs to the output tree, and its property `key` has the given `value`. */
query
predicate
nodes
(
PrintAstNode
node
,
string
key
,
string
value
)
{
value
=
node
.
getProperty
(
key
)
}
/**
* Holds if `target` is a child of `source` in the AST, and property `key` of the edge has the
* given `value`.
*/
query
predicate
edges
(
PrintAstNode
source
,
PrintAstNode
target
,
string
key
,
string
value
)
{
exists
(
int
childIndex
|
target
=
source
.
getChild
(
childIndex
)
and
(
key
=
"semmle.label"
and
value
=
source
.
getChildEdgeLabel
(
childIndex
)
or
key
=
"semmle.order"
and
value
=
childIndex
.
toString
(
)
)
)
}
/** Holds if property `key` of the graph has the given `value`. */
query
predicate
graphProperties
(
string
key
,
string
value
)
{
key
=
"semmle.graphKind"
and
value
=
"tree"
}
Back
|
FazBrowse Home
|
New Git URL