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
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
|
package org.javacs;
import com.sun.source.tree.*;
import com.sun.source.util.*;
import java.io.IOException;
import java.net.URI;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.*;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.lang.model.element.*;
import javax.lang.model.type.ArrayType;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.*;
import javax.tools.*;
import org.javacs.lsp.Range;
public class CompileBatch implements AutoCloseable {
public static final int MAX_COMPLETION_ITEMS = 50;
private final JavaCompilerService parent;
private final TaskPool.Borrow borrow;
private final Trees trees;
private final Elements elements;
private final Types types;
private final List<CompilationUnitTree> roots;
CompileBatch(JavaCompilerService parent, Collection<? extends JavaFileObject> files) {
this.parent = parent;
this.borrow = batchTask(parent, files);
this.trees = Trees.instance(borrow.task);
this.elements = borrow.task.getElements();
this.types = borrow.task.getTypes();
this.roots = new ArrayList<CompilationUnitTree>();
// Print timing information for optimization
var profiler = new Profiler();
borrow.task.addTaskListener(profiler);
// Compile all roots
try {
for (var t : borrow.task.parse()) roots.add(t);
// The results of borrow.task.analyze() are unreliable when errors are present
// You can get at `Element` values using `Trees`
borrow.task.analyze();
} catch (IOException e) {
throw new RuntimeException(e);
}
profiler.print();
}
@Override
public void close() {
borrow.close();
}
private static TaskPool.Borrow batchTask(JavaCompilerService parent, Collection<? extends JavaFileObject> sources) {
parent.diags.clear();
return parent.compiler.getTask(
null,
parent.fileManager,
parent.diags::add,
JavaCompilerService.options(parent.classPath),
Collections.emptyList(),
sources);
}
public CompilationUnitTree root(URI uri) {
for (var root : roots) {
if (root.getSourceFile().toUri().equals(uri)) {
return root;
}
}
// Somehow, uri was not in batch
var names = new StringJoiner(", ");
for (var r : roots) {
names.add(Parser.fileName(r.getSourceFile().toUri()));
}
throw new RuntimeException("File " + uri + " isn't in batch " + names);
}
private String contents(CompilationUnitTree root) {
try {
return root.getSourceFile().getCharContent(true).toString();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
public Optional<Element> element(URI uri, int line, int character) {
var path = findPath(uri, line, character);
var el = trees.getElement(path);
return Optional.ofNullable(el);
}
public Optional<List<TreePath>> definitions(Element el) {
LOG.info(String.format("Search for definitions of `%s` in %d files...", el, roots.size()));
if (el.asType().getKind() == TypeKind.ERROR) {
LOG.info(String.format("...`%s` is an error type, giving up", el.asType()));
return Optional.empty();
}
var refs = new ArrayList<TreePath>();
class FindDefinitions extends TreePathScanner<Void, Void> {
boolean sameSymbol(Element found) {
return el.equals(found);
}
boolean isSubMethod(Element found) {
if (!(el instanceof ExecutableElement)) return false;
if (!(found instanceof ExecutableElement)) return false;
var superMethod = (ExecutableElement) el;
var subMethod = (ExecutableElement) found;
var subType = (TypeElement) subMethod.getEnclosingElement();
// TODO need to check if class is compatible as well
if (elements.overrides(subMethod, superMethod, subType)) {
// LOG.info(String.format("...`%s.%s` overrides `%s`", subType, subMethod, superMethod));
return true;
}
return false;
}
void check(TreePath from) {
var found = trees.getElement(from);
var match = sameSymbol(found) || isSubMethod(found);
if (match) refs.add(from);
}
@Override
public Void visitClass(ClassTree t, Void __) {
check(getCurrentPath());
return super.visitClass(t, null);
}
@Override
public Void visitMethod(MethodTree t, Void __) {
check(getCurrentPath());
return super.visitMethod(t, null);
}
@Override
public Void visitVariable(VariableTree t, Void __) {
check(getCurrentPath());
return super.visitVariable(t, null);
}
}
var finder = new FindDefinitions();
for (var r : roots) {
finder.scan(r, null);
}
return Optional.of(refs);
}
public Optional<List<TreePath>> references(Element to) {
LOG.info(String.format("Search for references to %s...", to));
// If to is an error, we won't be able to find anything
if (to.asType().getKind() == TypeKind.ERROR) {
LOG.info(String.format("...`%s` is an error type, giving up", to.asType()));
return Optional.empty();
}
// Otherwise, scan roots for references
List<TreePath> list = new ArrayList<TreePath>();
var map = Map.of(to, list);
var finder = new FindReferences(borrow.task);
for (var r : roots) {
finder.scan(r, map);
}
LOG.info(String.format("...found %d references", list.size()));
return Optional.of(list);
}
/**
* Find all elements in `file` that get turned into code-lenses. This needs to match the result of
* `ParseFile#declarations`
*/
public List<Element> declarations(URI file) {
for (var r : roots) {
if (!r.getSourceFile().toUri().equals(file)) continue;
var paths = ParseFile.declarations(r);
var els = new ArrayList<Element>();
for (var p : paths) {
var e = trees.getElement(p);
assert e != null;
els.add(e);
}
return els;
}
// Couldn't find file! Throw an error.
var message = new StringJoiner(", ");
for (var r : roots) {
message.add(Parser.fileName(r.getSourceFile().toUri()));
}
throw new RuntimeException(file + " is not in " + message);
}
public Index index(URI from, List<Element> declarations) {
for (var r : roots) {
if (r.getSourceFile().toUri().equals(from)) {
return new Index(borrow.task, r, parent.diags, declarations);
}
}
throw new RuntimeException(from + " is not in compiled batch");
}
public Optional<Range> range(TreePath path) {
var uri = path.getCompilationUnit().getSourceFile().toUri();
var contents = FileStore.contents(uri);
return ParseFile.range(borrow.task, contents, path);
}
public SourcePositions sourcePositions() {
return trees.getSourcePositions();
}
public LineMap lineMap(URI uri) {
return root(uri).getLineMap();
}
public List<? extends ImportTree> imports(URI uri) {
return root(uri).getImports();
}
private List<Element> overrides(ExecutableElement method) {
var elements = borrow.task.getElements();
var types = borrow.task.getTypes();
var results = new ArrayList<Element>();
var enclosingClass = (TypeElement) method.getEnclosingElement();
var enclosingType = enclosingClass.asType();
for (var superClass : types.directSupertypes(enclosingType)) {
var e = (TypeElement) types.asElement(superClass);
for (var other : e.getEnclosedElements()) {
if (!(other instanceof ExecutableElement)) continue;
if (elements.overrides(method, (ExecutableElement) other, enclosingClass)) {
results.add(other);
}
}
}
return results;
}
private boolean hasOverrideAnnotation(ExecutableElement method) {
for (var ann : method.getAnnotationMirrors()) {
var type = ann.getAnnotationType();
var el = type.asElement();
var name = el.toString();
if (name.equals("java.lang.Override")) {
return true;
}
}
return false;
}
/** Find methods that override a method from a superclass but don't have an @Override annotation. */
public List<TreePath> needsOverrideAnnotation(URI uri) {
LOG.info(String.format("Looking for methods that need an @Override annotation in %s ...", uri.getPath()));
var root = root(uri);
var results = new ArrayList<TreePath>();
class FindMissingOverride extends TreePathScanner<Void, Void> {
@Override
public Void visitMethod(MethodTree t, Void __) {
var method = (ExecutableElement) trees.getElement(getCurrentPath());
var supers = overrides(method);
if (!supers.isEmpty() && !hasOverrideAnnotation(method)) {
var overridesMethod = supers.get(0);
var overridesClass = overridesMethod.getEnclosingElement();
LOG.info(
String.format(
"...`%s` has no @Override annotation but overrides `%s.%s`",
method, overridesClass, overridesMethod));
results.add(getCurrentPath());
}
return super.visitMethod(t, null);
}
}
new FindMissingOverride().scan(root, null);
return results;
}
/**
* Figure out what imports this file should have. Star-imports like `import java.util.*` are converted to individual
* class imports. Missing imports are inferred by looking at imports in other source files.
*/
public List<String> fixImports(URI uri) {
var root = root(uri);
var contents = contents(root);
// Check diagnostics for missing imports
var unresolved = new HashSet<String>();
for (var d : parent.diags) {
if (d.getCode().equals("compiler.err.cant.resolve.location") && d.getSource().toUri().equals(uri)) {
long start = d.getStartPosition(), end = d.getEndPosition();
var id = contents.substring((int) start, (int) end);
if (id.matches("[A-Z]\\w+")) {
unresolved.add(id);
} else LOG.warning(id + " doesn't look like a class");
} else if (d.getMessage(null).contains("cannot find to")) {
var lines = d.getMessage(null).split("\n");
var firstLine = lines.length > 0 ? lines[0] : "";
LOG.warning(String.format("%s %s doesn't look like to-not-found", d.getCode(), firstLine));
}
}
// Look at imports in other classes to help us guess how to fix imports
// TODO cache parsed imports on a per-file basis
var sourcePathImports = Parser.existingImports(FileStore.all());
var classes = new HashSet<String>();
classes.addAll(parent.jdkClasses);
classes.addAll(parent.classPathClasses);
var fixes = Parser.resolveSymbols(unresolved, sourcePathImports, classes);
// Figure out which existing imports are actually used
var trees = Trees.instance(borrow.task);
var references = new HashSet<String>();
class FindUsedImports extends TreePathScanner<Void, Void> {
@Override
public Void visitIdentifier(IdentifierTree node, Void nothing) {
var e = trees.getElement(getCurrentPath());
if (e instanceof TypeElement) {
var t = (TypeElement) e;
var qualifiedName = t.getQualifiedName().toString();
var lastDot = qualifiedName.lastIndexOf('.');
var packageName = lastDot == -1 ? "" : qualifiedName.substring(0, lastDot);
var thisPackage = Objects.toString(root.getPackageName(), "");
// java.lang.* and current package are imported by default
if (!packageName.equals("java.lang")
&& !packageName.equals(thisPackage)
&& !packageName.equals("")) {
references.add(qualifiedName);
}
}
return null;
}
}
new FindUsedImports().scan(root, null);
// Take the intersection of existing imports ^ existing identifiers
var qualifiedNames = new HashSet<String>();
for (var i : root.getImports()) {
var imported = i.getQualifiedIdentifier().toString();
if (imported.endsWith(".*")) {
var packageName = Parser.mostName(imported);
var isUsed = references.stream().anyMatch(r -> r.startsWith(packageName));
if (isUsed) qualifiedNames.add(imported);
else LOG.warning("There are no references to package " + imported);
} else {
if (references.contains(imported)) qualifiedNames.add(imported);
else LOG.warning("There are no references to class " + imported);
}
}
// Add qualified names from fixes
qualifiedNames.addAll(fixes.values());
// Sort in alphabetical order
var sorted = new ArrayList<String>();
sorted.addAll(qualifiedNames);
Collections.sort(sorted);
return sorted;
}
/** Find all overloads for the smallest method call that includes the cursor */
public Optional<MethodInvocation> methodInvocation(URI file, int line, int character) {
LOG.info(String.format("Find method invocation around %s(%d,%d)...", file, line, character));
var cursor = findPath(file, line, character);
for (var path = cursor; path != null; path = path.getParentPath()) {
if (path.getLeaf() instanceof MethodInvocationTree) {
// Find all overloads of method
LOG.info(String.format("...`%s` is a method invocation", path.getLeaf()));
var invoke = (MethodInvocationTree) path.getLeaf();
var method = trees.getElement(trees.getPath(path.getCompilationUnit(), invoke.getMethodSelect()));
var results = new ArrayList<ExecutableElement>();
for (var m : method.getEnclosingElement().getEnclosedElements()) {
if (m.getKind() == ElementKind.METHOD && m.getSimpleName().equals(method.getSimpleName())) {
results.add((ExecutableElement) m);
}
}
// Figure out which parameter is active
var activeParameter = invoke.getArguments().indexOf(cursor.getLeaf());
LOG.info(String.format("...active parameter `%s` is %d", cursor.getLeaf(), activeParameter));
// Figure out which method is active, if possible
Optional<ExecutableElement> activeMethod =
method instanceof ExecutableElement
? Optional.of((ExecutableElement) method)
: Optional.empty();
return Optional.of(new MethodInvocation(invoke, activeMethod, activeParameter, results));
} else if (path.getLeaf() instanceof NewClassTree) {
// Find all overloads of method
LOG.info(String.format("...`%s` is a constructor invocation", path.getLeaf()));
var invoke = (NewClassTree) path.getLeaf();
var method = trees.getElement(path);
var results = new ArrayList<ExecutableElement>();
for (var m : method.getEnclosingElement().getEnclosedElements()) {
if (m.getKind() == ElementKind.CONSTRUCTOR) {
results.add((ExecutableElement) m);
}
}
// Figure out which parameter is active
var activeParameter = invoke.getArguments().indexOf(cursor.getLeaf());
LOG.info(String.format("...active parameter `%s` is %d", cursor.getLeaf(), activeParameter));
// Figure out which method is active, if possible
Optional<ExecutableElement> activeMethod =
method instanceof ExecutableElement
? Optional.of((ExecutableElement) method)
: Optional.empty();
return Optional.of(new MethodInvocation(invoke, activeMethod, activeParameter, results));
}
}
return Optional.empty();
}
public List<Completion> completeIdentifiers(
URI uri, int line, int character, boolean insideClass, boolean insideMethod, String partialName) {
LOG.info(String.format("Completing identifiers starting with `%s`...", partialName));
var root = root(uri);
var result = new ArrayList<Completion>();
// Add snippets
if (!insideClass) {
// If no package declaration is present, suggest package [inferred name];
if (root.getPackage() == null) {
var name = FileStore.suggestedPackageName(Paths.get(uri));
result.add(Completion.ofSnippet("package " + name, "package " + name + ";\n\n"));
}
// If no class declaration is present, suggest class [file name]
var hasClassDeclaration = false;
for (var t : root.getTypeDecls()) {
if (!(t instanceof ErroneousTree)) {
hasClassDeclaration = true;
}
}
if (!hasClassDeclaration) {
var name = Paths.get(uri).getFileName().toString();
name = name.substring(0, name.length() - ".java".length());
result.add(Completion.ofSnippet("class " + name, "class " + name + " {\n $0\n}"));
}
}
// Add identifiers
completeScopeIdentifiers(uri, line, character, partialName, result);
// Add keywords
if (!insideClass) {
addKeywords(TOP_LEVEL_KEYWORDS, partialName, result);
} else if (!insideMethod) {
addKeywords(CLASS_BODY_KEYWORDS, partialName, result);
} else {
addKeywords(METHOD_BODY_KEYWORDS, partialName, result);
}
return result;
}
public List<Completion> completeAnnotations(URI uri, int line, int character, String partialName) {
var result = new ArrayList<Completion>();
// Add @Override ... snippet
if ("Override".startsWith(partialName)) {
// TODO filter out already-implemented methods using thisMethods
var alreadyShown = new HashSet<String>();
for (var method : superMethods(uri, line, character)) {
var mods = method.getModifiers();
if (mods.contains(Modifier.STATIC) || mods.contains(Modifier.PRIVATE)) continue;
var label = "@Override " + ShortTypePrinter.printMethod(method);
var snippet = "Override\n" + new TemplatePrinter().printMethod(method) + " {\n $0\n}";
var override = Completion.ofSnippet(label, snippet);
if (!alreadyShown.contains(label)) {
result.add(override);
alreadyShown.add(label);
}
}
}
// Add @Override, @Test, other simple class names
completeScopeIdentifiers(uri, line, character, partialName, result);
return result;
}
/** Find all case options in the switch expression surrounding line:character */
public List<Completion> completeCases(URI uri, int line, int character) {
var cursor = findPath(uri, line, character);
LOG.info(String.format("Complete enum constants following `%s`...", cursor.getLeaf()));
// Find surrounding switch
var path = cursor;
while (!(path.getLeaf() instanceof SwitchTree)) path = path.getParentPath();
var leaf = (SwitchTree) path.getLeaf();
path = new TreePath(path, leaf.getExpression());
LOG.info(String.format("...found switch expression `%s`", leaf.getExpression()));
// Get members of switched type
var type = trees.getTypeMirror(path);
if (type == null) {
LOG.info("...no type at " + leaf.getExpression());
return Collections.emptyList();
}
LOG.info(String.format("...switched expression has type `%s`", type));
var types = borrow.task.getTypes();
var definition = types.asElement(type);
if (definition == null) {
LOG.info("...type has no definition, completing identifiers instead");
return completeIdentifiers(uri, line, character, true, true, ""); // TODO pass partial name
}
LOG.info(String.format("...switched expression has definition `%s`", definition));
var result = new ArrayList<Completion>();
for (var member : definition.getEnclosedElements()) {
if (member.getKind() == ElementKind.ENUM_CONSTANT) result.add(Completion.ofElement(member));
}
return result;
}
/** Find all members of expression ending at line:character */
public List<Completion> completeMembers(URI uri, int line, int character, boolean isReference) {
var path = findPath(uri, line, character);
var types = borrow.task.getTypes();
var scope = trees.getScope(path);
var element = trees.getElement(path);
if (element instanceof PackageElement) {
var result = new ArrayList<Completion>();
var p = (PackageElement) element;
LOG.info(String.format("...completing members of package %s", p.getQualifiedName()));
// Add class-names resolved as Element by javac
for (var member : p.getEnclosedElements()) {
// If the package member is a TypeElement, like a class or interface, check if it's accessible
if (member instanceof TypeElement) {
if (trees.isAccessible(scope, (TypeElement) member)) {
result.add(Completion.ofElement(member));
}
}
// Otherwise, just assume it's accessible and add it to the list
else result.add(Completion.ofElement(member));
}
// Add sub-package names resolved as String by guava ClassPath
var parent = p.getQualifiedName().toString();
var subs = subPackages(parent);
for (var sub : subs) {
result.add(Completion.ofPackagePart(sub, Parser.lastName(sub)));
}
return result;
} else if (element instanceof TypeElement && isReference) {
var result = new ArrayList<Completion>();
var t = (TypeElement) element;
LOG.info(String.format("...completing static methods of %s", t.getQualifiedName()));
// Add members
for (var member : t.getEnclosedElements()) {
if (member.getKind() == ElementKind.METHOD
&& trees.isAccessible(scope, member, (DeclaredType) t.asType())) {
result.add(Completion.ofElement(member));
}
}
// Add ::new
result.add(Completion.ofKeyword("new"));
return result;
} else if (element instanceof TypeElement && !isReference) {
var result = new ArrayList<Completion>();
var t = (TypeElement) element;
LOG.info(String.format("...completing static members of %s", t.getQualifiedName()));
// Add static members
for (var member : t.getEnclosedElements()) {
// TODO if this is a member reference :: then include non-statics
if (member.getModifiers().contains(Modifier.STATIC)
&& trees.isAccessible(scope, member, (DeclaredType) t.asType())) {
result.add(Completion.ofElement(member));
}
}
// Add .class
result.add(Completion.ofKeyword("class"));
result.add(Completion.ofKeyword("this"));
result.add(Completion.ofKeyword("super"));
return result;
} else {
var type = trees.getTypeMirror(path);
if (type == null) {
LOG.warning(String.format("`...%s` has not type", path.getLeaf()));
return List.of();
}
if (!hasMembers(type)) {
LOG.warning("...don't know how to complete members of type " + type);
return Collections.emptyList();
}
var result = new ArrayList<Completion>();
var ts = supersWithSelf(type);
var alreadyAdded = new HashSet<String>();
LOG.info(String.format("...completing virtual members of %s and %d supers", type, ts.size()));
for (var t : ts) {
var e = types.asElement(t);
if (e == null) {
LOG.warning(String.format("...can't convert supertype `%s` to element, skipping", t));
continue;
}
for (var member : e.getEnclosedElements()) {
// Don't add statics
if (member.getModifiers().contains(Modifier.STATIC)) continue;
// Don't add constructors
if (member.getSimpleName().contentEquals("<init>")) continue;
// Skip overridden members from superclass
if (alreadyAdded.contains(member.toString())) continue;
// If type is a DeclaredType, check accessibility of member
if (type instanceof DeclaredType) {
if (trees.isAccessible(scope, member, (DeclaredType) type)) {
result.add(Completion.ofElement(member));
alreadyAdded.add(member.toString());
}
}
// Otherwise, accessibility rules are very complicated
// Give up and just declare that everything is accessible
else {
result.add(Completion.ofElement(member));
alreadyAdded.add(member.toString());
}
}
}
if (type instanceof ArrayType) {
result.add(Completion.ofKeyword("length"));
}
return result;
}
}
public static String[] TOP_LEVEL_KEYWORDS = {
"package",
"import",
"public",
"private",
"protected",
"abstract",
"class",
"interface",
"extends",
"implements",
};
private static String[] CLASS_BODY_KEYWORDS = {
"public",
"private",
"protected",
"static",
"final",
"native",
"synchronized",
"abstract",
"default",
"class",
"interface",
"void",
"boolean",
"int",
"long",
"float",
"double",
};
private static String[] METHOD_BODY_KEYWORDS = {
"new",
"assert",
"try",
"catch",
"finally",
"throw",
"return",
"break",
"case",
"continue",
"default",
"do",
"while",
"for",
"switch",
"if",
"else",
"instanceof",
"var",
"final",
"class",
"void",
"boolean",
"int",
"long",
"float",
"double",
};
private List<ExecutableElement> virtualMethods(DeclaredType type) {
var result = new ArrayList<ExecutableElement>();
for (var member : type.asElement().getEnclosedElements()) {
if (member instanceof ExecutableElement) {
var method = (ExecutableElement) member;
if (!method.getSimpleName().contentEquals("<init>")
&& !method.getModifiers().contains(Modifier.STATIC)) {
result.add(method);
}
}
}
return result;
}
private TypeMirror enclosingClass(URI uri, int line, int character) {
var cursor = findPath(uri, line, character);
var path = cursor;
while (!(path.getLeaf() instanceof ClassTree)) path = path.getParentPath();
var enclosingClass = trees.getElement(path);
return enclosingClass.asType();
}
private void collectSuperMethods(TypeMirror thisType, List<ExecutableElement> result) {
var types = borrow.task.getTypes();
for (var superType : types.directSupertypes(thisType)) {
if (superType instanceof DeclaredType) {
var type = (DeclaredType) superType;
result.addAll(virtualMethods(type));
collectSuperMethods(type, result);
}
}
}
private List<ExecutableElement> superMethods(URI uri, int line, int character) {
var thisType = enclosingClass(uri, line, character);
var result = new ArrayList<ExecutableElement>();
collectSuperMethods(thisType, result);
return result;
}
static boolean matchesPartialName(CharSequence candidate, CharSequence partialName) {
if (candidate.length() < partialName.length()) return false;
for (int i = 0; i < partialName.length(); i++) {
if (candidate.charAt(i) != partialName.charAt(i)) return false;
}
return true;
}
private boolean isImported(URI uri, String qualifiedName) {
var root = root(uri);
var packageName = Parser.mostName(qualifiedName);
var className = Parser.lastName(qualifiedName);
for (var i : root.getImports()) {
var importName = i.getQualifiedIdentifier().toString();
var importPackage = Parser.mostName(importName);
var importClass = Parser.lastName(importName);
if (importClass.equals("*") && importPackage.equals(packageName)) return true;
if (importClass.equals(className) && importPackage.equals(packageName)) return true;
}
return false;
}
private Set<TypeMirror> supersWithSelf(TypeMirror t) {
var types = new HashSet<TypeMirror>();
collectSupers(t, types);
// Object type is not included by default
// We need to add it to get members like .equals(other) and .hashCode()
types.add(borrow.task.getElements().getTypeElement("java.lang.Object").asType());
return types;
}
private void collectSupers(TypeMirror t, Set<TypeMirror> supers) {
supers.add(t);
for (var s : types.directSupertypes(t)) {
collectSupers(s, supers);
}
}
private boolean hasMembers(TypeMirror type) {
switch (type.getKind()) {
case ARRAY:
case DECLARED:
case ERROR:
case TYPEVAR:
case WILDCARD:
case UNION:
case INTERSECTION:
return true;
case BOOLEAN:
case BYTE:
case SHORT:
case INT:
case LONG:
case CHAR:
case FLOAT:
case DOUBLE:
case VOID:
case NONE:
case NULL:
case PACKAGE:
case EXECUTABLE:
case OTHER:
default:
return false;
}
}
/** Find all identifiers in scope at line:character */
List<Element> scopeMembers(URI uri, int line, int character, String partialName) {
var path = findPath(uri, line, character);
var types = borrow.task.getTypes();
var start = trees.getScope(path);
class Walk {
List<Element> result = new ArrayList<>();
boolean isStatic(Scope s) {
var method = s.getEnclosingMethod();
if (method != null) {
return method.getModifiers().contains(Modifier.STATIC);
} else return false;
}
boolean isStatic(Element e) {
return e.getModifiers().contains(Modifier.STATIC);
}
boolean isThisOrSuper(Element e) {
var name = e.getSimpleName();
return name.contentEquals("this") || name.contentEquals("super");
}
// Place each member of `this` or `super` directly into `results`
void unwrapThisSuper(VariableElement ve) {
var thisType = ve.asType();
// `this` and `super` should always be instances of DeclaredType, which we'll use to check accessibility
if (!(thisType instanceof DeclaredType)) {
LOG.warning(String.format("%s is not a DeclaredType", thisType));
return;
}
var thisDeclaredType = (DeclaredType) thisType;
var thisElement = types.asElement(thisDeclaredType);
for (var thisMember : thisElement.getEnclosedElements()) {
if (isStatic(start) && !isStatic(thisMember)) continue;
if (thisMember.getSimpleName().contentEquals("<init>")) continue;
if (!matchesPartialName(thisMember.getSimpleName(), partialName)) continue;
// Check if member is accessible from original scope
if (trees.isAccessible(start, thisMember, thisDeclaredType)) {
result.add(thisMember);
}
}
}
// Place each member of `s` into results, and unwrap `this` and `super`
void walkLocals(Scope s) {
try {
for (var e : s.getLocalElements()) {
if (matchesPartialName(e.getSimpleName(), partialName)) {
if (e instanceof TypeElement) {
var te = (TypeElement) e;
if (trees.isAccessible(start, te)) result.add(te);
} else if (isThisOrSuper(e)) {
if (!isStatic(s)) result.add(e);
} else {
result.add(e);
}
}
if (isThisOrSuper(e)) {
unwrapThisSuper((VariableElement) e);
}
if (tooManyItems(result.size())) return;
}
} catch (Exception e) {
LOG.log(Level.WARNING, "error walking locals in scope", e);
}
}
// Walk each enclosing scope, placing its members into `results`
List<Element> walkScopes() {
var scopes = new ArrayList<Scope>();
for (var s = start; s != null; s = s.getEnclosingScope()) {
scopes.add(s);
}
// Scopes may be contained in an enclosing scope.
// The outermost scope contains those elements available via "star import" declarations;
// the scope within that contains the top level elements of the compilation unit, including any named
// imports.
// https://parent.docs.oracle.com/en/java/javase/11/docs/api/jdk.compiler/com/sun/source/tree/Scope.html
for (var i = 0; i < scopes.size() - 2; i++) {
var s = scopes.get(i);
walkLocals(s);
// Return early?
if (tooManyItems(result.size())) {
return result;
}
}
return result;
}
}
return new Walk().walkScopes();
}
private boolean tooManyItems(int count) {
var test = count >= MAX_COMPLETION_ITEMS;
if (test) LOG.warning(String.format("...# of items %d reached max %s", count, MAX_COMPLETION_ITEMS));
return test;
}
private Set<String> subPackages(String parentPackage) {
var result = new HashSet<String>();
Consumer<String> checkClassName =
name -> {
var packageName = Parser.mostName(name);
if (packageName.startsWith(parentPackage) && packageName.length() > parentPackage.length()) {
var start = parentPackage.length() + 1;
var end = packageName.indexOf('.', start);
if (end == -1) end = packageName.length();
var prefix = packageName.substring(0, end);
result.add(prefix);
}
};
for (var name : parent.jdkClasses) checkClassName.accept(name);
for (var name : parent.classPathClasses) checkClassName.accept(name);
return result;
}
private static void addKeywords(String[] keywords, String partialName, List<Completion> result) {
for (var k : keywords) {
if (matchesPartialName(k, partialName)) {
result.add(Completion.ofKeyword(k));
}
}
}
private void completeScopeIdentifiers(
URI uri, int line, int character, String partialName, List<Completion> result) {
var root = root(uri);
// Add locals
var locals = scopeMembers(uri, line, character, partialName);
for (var m : locals) {
result.add(Completion.ofElement(m));
}
LOG.info(String.format("...found %d locals", locals.size()));
// Add static imports
var staticImports = staticImports(uri, partialName);
for (var m : staticImports) {
result.add(Completion.ofElement(m));
}
LOG.info(String.format("...found %d static imports", staticImports.size()));
// Add classes
var startsWithUpperCase = partialName.length() > 0 && Character.isUpperCase(partialName.charAt(0));
if (startsWithUpperCase) {
var packageName = Objects.toString(root.getPackageName(), "");
Predicate<String> matchesPartialName =
qualifiedName -> {
var className = Parser.lastName(qualifiedName);
return matchesPartialName(className, partialName);
};
// Check JDK
LOG.info("...checking JDK");
for (var c : parent.jdkClasses) {
if (tooManyItems(result.size())) return;
if (!matchesPartialName.test(c)) continue;
if (isSamePackage(c, packageName) || isPublicClassFile(c)) {
result.add(Completion.ofClassName(c, isImported(uri, c)));
}
}
// Check classpath
LOG.info("...checking classpath");
var classPathNames = new HashSet<String>();
for (var c : parent.classPathClasses) {
if (tooManyItems(result.size())) return;
if (!matchesPartialName.test(c)) continue;
if (isSamePackage(c, packageName) || isPublicClassFile(c)) {
result.add(Completion.ofClassName(c, isImported(uri, c)));
classPathNames.add(c);
}
}
// Check sourcepath
LOG.info("...checking source path");
for (var file : FileStore.all()) {
if (tooManyItems(result.size())) return;
// If file is in the same package, any class defined in the file is accessible
var otherPackageName = FileStore.packageName(file);
var samePackage = otherPackageName.equals(packageName) || otherPackageName.isEmpty();
// If file is in a different package, only a public class with the same name as the file is accessible
var maybePublic = matchesPartialName(file.getFileName().toString(), partialName);
if (samePackage || maybePublic) {
result.addAll(accessibleClasses(uri, file, partialName, packageName, classPathNames));
}
}
}
}
private boolean isSamePackage(String className, String fromPackage) {
return Parser.mostName(className).equals(fromPackage);
}
private boolean isPublicClassFile(String className) {
try {
var platform =
parent.fileManager.getJavaFileForInput(
StandardLocation.PLATFORM_CLASS_PATH, className, JavaFileObject.Kind.CLASS);
if (platform != null) return isPublic(platform);
var classpath =
parent.fileManager.getJavaFileForInput(
StandardLocation.CLASS_PATH, className, JavaFileObject.Kind.CLASS);
if (classpath != null) return isPublic(classpath);
return false;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private boolean isPublic(JavaFileObject classFile) {
try (var in = classFile.openInputStream()) {
var header = ClassHeader.of(in);
return header.isPublic;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private List<Completion> accessibleClasses(
URI fromUri, Path toFile, String partialName, String fromPackage, Set<String> skip) {
var parse = Parser.parse(toFile);
var toPackage = Objects.toString(parse.getPackageName(), "");
var samePackage = fromPackage.equals(toPackage) || toPackage.isEmpty();
var result = new ArrayList<Completion>();
for (var t : parse.getTypeDecls()) {
if (!(t instanceof ClassTree)) continue;
var cls = (ClassTree) t;
// If class is not accessible, skip it
var isPublic = cls.getModifiers().getFlags().contains(Modifier.PUBLIC);
if (!samePackage && !isPublic) continue;
// If class doesn't match partialName, skip it
var name = cls.getSimpleName().toString();
if (!matchesPartialName(name, partialName)) continue;
if (parse.getPackageName() != null) {
name = parse.getPackageName() + "." + name;
}
// If class was already autocompleted using the classpath, skip it
if (skip.contains(name)) continue;
// Otherwise, add this name!
result.add(Completion.ofClassName(name, isImported(fromUri, name)));
}
return result;
}
private List<Element> staticImports(URI uri, String partialName) {
var root = root(uri);
var result = new ArrayList<Element>();
for (var i : root.getImports()) {
if (!i.isStatic()) continue;
var id = (MemberSelectTree) i.getQualifiedIdentifier();
var path = trees.getPath(root, id.getExpression());
var el = (TypeElement) trees.getElement(path);
if (id.getIdentifier().contentEquals("*")) {
for (var member : el.getEnclosedElements()) {
if (matchesPartialName(member.getSimpleName(), partialName)
&& member.getModifiers().contains(Modifier.STATIC)) {
result.add(member);
if (tooManyItems(result.size())) return result;
}
}
} else {
for (var member : el.getEnclosedElements()) {
if (matchesPartialName(member.getSimpleName(), partialName)
&& member.getModifiers().contains(Modifier.STATIC)) {
result.add(member);
if (tooManyItems(result.size())) return result;
}
}
}
}
return result;
}
/** Find the smallest tree that includes the cursor */
TreePath findPath(URI uri, int line, int character) {
var root = root(uri);
var trees = Trees.instance(borrow.task);
var pos = trees.getSourcePositions();
var cursor = root.getLineMap().getPosition(line, character);
// Search for the smallest element that encompasses line:column
class FindSmallest extends TreePathScanner<Void, Void> {
TreePath found = null;
boolean containsCursor(Tree tree) {
long start = pos.getStartPosition(root, tree), end = pos.getEndPosition(root, tree);
// If element has no position, give up
if (start == -1 || end == -1) return false;
// int x = 1, y = 2, ... requires special handling
if (tree instanceof VariableTree) {
var v = (VariableTree) tree;
// Get contents of source
String source;
try {
source = root.getSourceFile().getCharContent(true).toString();
} catch (IOException e) {
throw new RuntimeException(e);
}
// Find name in contents
var name = v.getName().toString();
start = source.indexOf(name, (int) start);
if (start == -1) {
LOG.warning(String.format("Can't find name `%s` in variable declaration `%s`", name, v));
return false;
}
end = start + name.length();
}
// Check if `tree` contains line:column
return start <= cursor && cursor <= end;
}
@Override
public Void scan(Tree tree, Void nothing) {
// This is pre-order traversal, so the deepest element will be the last one remaining in `found`
if (containsCursor(tree)) {
found = new TreePath(getCurrentPath(), tree);
}
super.scan(tree, nothing);
return null;
}
@Override
public Void visitErroneous(ErroneousTree node, Void nothing) {
for (var t : node.getErrorTrees()) {
scan(t, nothing);
}
return null;
}
}
var find = new FindSmallest();
find.scan(root, null);
if (find.found == null) {
var message = String.format("No TreePath to %s %d:%d", uri, line, character);
throw new RuntimeException(message);
}
return find.found;
}
private static final Logger LOG = Logger.getLogger("main");
}
|