-
Notifications
You must be signed in to change notification settings - Fork 226
Expand file tree
/
Copy pathIndexer.java
More file actions
981 lines (870 loc) · 30.9 KB
/
Indexer.java
File metadata and controls
981 lines (870 loc) · 30.9 KB
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
/**
* Copyright 2009, Google Inc. All rights reserved.
* Licensed to PSF under a Contributor Agreement.
*/
package org.python.indexer;
import org.python.indexer.ast.NNode;
import org.python.indexer.ast.NModule;
import org.python.indexer.ast.NName;
import org.python.indexer.ast.NStr;
import org.python.indexer.ast.NUrl;
import org.python.indexer.types.NModuleType;
import org.python.indexer.types.NType;
import org.python.indexer.types.NUnknownType;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.TreeMap;
import java.util.Map.Entry;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Indexes a set of Python files and builds a code graph. <p>
* This class is not thread-safe.
*/
public class Indexer {
/**
* The global indexer instance. Provides convenient access to global
* resources, as well as easy cleanup of resources after the index is built.
*/
public static Indexer idx;
/**
* A scope containing bindings for all modules currently loaded by the indexer.
*/
public Scope moduleTable = new Scope(null, Scope.Type.GLOBAL);
/**
* The top-level (builtin) scope.
*/
public Scope globaltable = new Scope(null, Scope.Type.GLOBAL);
/**
* A map of all bindings created, keyed on their qnames.
*/
private Map<String, NBinding> allBindings = new HashMap<String, NBinding>();
/**
* A map of references to their referenced bindings. Most nodes will refer
* to a single binding, and few ever refer to more than two. One situation
* in which a multiple reference can occur is the an attribute of a union
* type. For instance:
*
* <pre>
* class A:
* def foo(self): pass
* class B:
* def foo(self): pass
* if some_condition:
* var = A()
* else
* var = B()
* var.foo() # foo here refers to both A.foo and B.foo
* <pre>
*/
private Map<Ref, List<NBinding>> locations = new HashMap<Ref, List<NBinding>>();
/**
* Diagnostics.
*/
public Map<String, List<Diagnostic>> problems = new HashMap<String, List<Diagnostic>>();
public Map<String, List<Diagnostic>> parseErrs = new HashMap<String, List<Diagnostic>>();
public String currentFile = null;
public String projDir = null;
public List<String> path = new ArrayList<String>();
/**
* Manages a store of serialized ASTs. ANTLR parsing is one of the slower and
* more expensive phases of indexing; reusing parse trees can help with resource
* utilization when indexing several projects (or re-indexing one project).
*/
private AstCache astCache;
/**
* When resolving imports we look in various possible locations.
* This set keeps track of modules we attempted but didn't find.
*/
public Set<String> failedModules = new HashSet<String>();
/**
* This set tracks module imports that could not be resolved.
*/
private Map<String, Set<String>> unresolvedModules = new TreeMap<String, Set<String>>();
/**
* Manages the built-in modules -- that is, modules from the standard Python
* library that are implemented in C and consequently have no Python source.
*/
public Builtins builtins;
private boolean aggressiveAssertions;
// stats counters
private int nloc = 0;
private int nunbound = 0;
private int nunknown = 0;
private int nprob = 0;
private int nparsing = 0;
private int loadedFiles = 0;
private Logger logger = Logger.getLogger(Indexer.class.getCanonicalName());
public Indexer() {
idx = this;
builtins = new Builtins(globaltable, moduleTable);
builtins.init();
}
public void setLogger(Logger logger) {
if (logger == null) {
throw new IllegalArgumentException("null logger param");
}
this.logger = logger;
}
public Logger getLogger() {
return logger;
}
public void setProjectDir(String cd) throws IOException {
projDir = Util.canonicalize(cd);
}
/**
* Configures whether the indexer should abort with an exception when it
* encounters an internal error or unexpected program state. Normally the
* indexer attempts to continue indexing, on the assumption that having an
* index with mostly good data is better than having no index at all.
* Enabling aggressive assertions is useful for debugging the indexer.
*/
public void enableAggressiveAssertions(boolean enable) {
aggressiveAssertions = enable;
}
public boolean aggressiveAssertionsEnabled() {
return aggressiveAssertions;
}
/**
* If aggressive assertions are enabled, propagates the passed
* {@link Throwable}, wrapped in an {@link IndexingException}.
* @param msg descriptive message; ok to be {@code null}
* @throws IndexingException
*/
public void handleException(String msg, Throwable cause) {
// Stack overflows are still fairly common due to cyclic
// types, and they take up an awful lot of log space, so we
// don't log the whole trace by default.
if (cause instanceof StackOverflowError) {
logger.log(Level.WARNING, msg, cause);
return;
}
if (aggressiveAssertionsEnabled()) {
if (msg != null) {
throw new IndexingException(msg, cause);
}
throw new IndexingException(cause);
}
if (msg == null) {
msg = "<null msg>";
}
if (cause == null) {
cause = new Exception();
}
logger.log(Level.WARNING, msg, cause);
}
/**
* Signals a failed assertion about the state of the indexer or index.
* If aggressive assertions are enabled, throws an {@code IndexingException}.
* Otherwise the message is logged as a warning, and indexing continues.
* @param msg a descriptive message about the problem
* @see #enableAggressiveAssertions(boolean)
* @throws IndexingException
*/
public void reportFailedAssertion(String msg) {
if (aggressiveAssertionsEnabled()) {
throw new IndexingException(msg, new Exception()); // capture stack
}
// Need more configuration control here.
// Currently getting a hillion jillion of these in large clients.
if (false) {
logger.log(Level.WARNING, msg);
}
}
/**
* Adds the specified absolute paths to the module search path.
*/
public void addPaths(List<String> p) throws IOException {
for (String s : p) {
addPath(s);
}
}
/**
* Adds the specified absolute path to the module search path.
*/
public void addPath(String p) throws IOException {
path.add(Util.canonicalize(p));
}
/**
* Sets the module search path to the specified list of absolute paths.
*/
public void setPath(List<String> path) throws IOException {
this.path = new ArrayList<String>(path.size());
addPaths(path);
}
/**
* Returns the module search path -- the project directory followed by any
* paths that were added by {@link #addPath(String)}.
*/
public List<String> getLoadPath() {
List<String> loadPath = new ArrayList<String>();
if (projDir != null) {
loadPath.add(projDir);
}
loadPath.addAll(path);
return loadPath;
}
public boolean isLibFile(String file) {
if (file.startsWith(File.separator)) {
return true;
}
if (path != null) {
for (String p : path) {
if (file.startsWith(p)) {
return true;
}
}
}
return false;
}
/**
* Returns the mutable set of all bindings collected, keyed on their qnames.
*/
public Map<String, NBinding> getBindings() {
return allBindings;
}
/**
* Return the binding for {@code qname}, or {@code null} if not known.
*/
public NBinding lookupQname(String qname) {
return allBindings.get(qname);
}
/**
* Return the type for {@code qname}, or {@code null} if not known.
* @throws IllegalStateException if {@link #ready} has not been called.
*/
public NType lookupQnameType(String qname) {
NBinding b = lookupQname(qname);
if (b != null) {
return b.followType();
}
return null;
}
NModuleType getCachedModule(String file) {
return (NModuleType)moduleTable.lookupType(file);
}
/**
* Returns (loading/resolving if necessary) the module for a given source path.
* @param file absolute file path
*/
public NModuleType getModuleForFile(String file) throws Exception {
if (failedModules.contains(file)) {
return null;
}
NModuleType m = getCachedModule(file);
if (m != null) {
return m;
}
return loadFile(file);
}
/**
* Returns the list, possibly empty but never {@code null}, of
* errors and warnings generated in the file.
*/
public List<Diagnostic> getDiagnosticsForFile(String file) {
List<Diagnostic> errs = problems.get(file);
if (errs != null) {
return errs;
}
return new ArrayList<Diagnostic>();
}
/**
* Create an outline for a file in the index.
* @param path the file for which to build the outline
* @return a list of entries constituting the file outline.
* Returns an empty list if the indexer hasn't indexed that path.
*/
public List<Outliner.Entry> generateOutline(String path) throws Exception {
return new Outliner().generate(this, path);
}
/**
* Add a reference to binding {@code b} at AST node {@code node}.
* @param node a node referring to a name binding. Typically a
* {@link NName}, {@link NStr} or {@link NUrl}.
*/
public void putLocation(NNode node, NBinding b) {
if (node == null) {
return;
}
putLocation(new Ref(node), b);
}
public void putLocation(Ref ref, NBinding b) {
if (ref == null) {
return;
}
List<NBinding> bindings = locations.get(ref);
if (bindings == null) {
// The indexer is heavily memory-constrained, so we need small overhead.
// Empirically using a capacity-1 ArrayList for the binding set
// uses about 1/2 the memory of a LinkedList, and 1/4 the memory
// of a default HashSet.
bindings = new ArrayList<NBinding>(1);
locations.put(ref, bindings);
}
if (!bindings.contains(b)) {
bindings.add(b);
// Having > 1 is often an indicator of an indexer bug:
// if (bindings.size() > 1) {
// info("now have " + bindings.size() + " bindings for " + ref + " in " +
// ref.getFile() + ": " + bindings);
// }
}
b.addRef(ref);
}
/**
* Add {@code node} as a reference to binding {@code b}, removing
* {@code node} from any other binding ref-lists that it may have occupied.
* Currently only used in retargeting attribute references from provisional
* bindings once the actual binding is determined.
*/
public void updateLocation(Ref node, NBinding b) {
if (node == null) {
return;
}
List<NBinding> bindings = locations.get(node);
if (bindings == null) {
bindings = new ArrayList<NBinding>(1);
locations.put(node, bindings);
} else {
for (NBinding oldb : bindings) {
oldb.removeRef(node);
}
bindings.clear();
}
if (!bindings.contains(b)) {
bindings.add(b);
}
b.addRef(node);
}
public void removeBinding(NBinding b) {
allBindings.remove(b);
}
public NBinding putBinding(NBinding b) {
if (b == null) {
throw new IllegalArgumentException("null binding arg");
}
String qname = b.getQname();
if (qname == null || qname.length() == 0) {
throw new IllegalArgumentException("Null/empty qname: " + b);
}
NBinding existing = allBindings.get(qname);
if (existing == b) {
return b;
}
if (existing != null) {
duplicateBindingFailure(b, existing);
// A bad edge case was triggered by an __init__.py that defined a
// "Parser" binding (type unknown), and there was a Parser.py in the
// same directory. Loading Parser.py resulted in infinite recursion.
//
// XXX: need to revisit this logic. It seems that bindings made in
// __init__.py probably (?) ought to have __init__ in their qnames
// to avoid dup-binding conflicts. The Indexer module table also
// probably ought not be a normal scope -- it's different enough that
// overloading it to handle modules is making the logic rather twisty.
if (b.getKind() == NBinding.Kind.MODULE) {
return b;
}
return existing;
}
allBindings.put(qname, b);
return b;
}
private void duplicateBindingFailure(NBinding newb, NBinding oldb) {
// XXX: this seems to happen only (and always) for duplicated
// class or function defs in the same scope. Need to figure out
// what the right thing is for this scenario.
if (true) {
return;
}
StringBuilder sb = new StringBuilder();
sb.append("Error creating binding ");
sb.append(newb);
sb.append(" in file ");
sb.append(newb.getFirstFile());
sb.append(": qname already bound to ");
sb.append(oldb);
sb.append(" in file ");
sb.append(oldb.getFirstFile());
reportFailedAssertion(sb.toString());
}
public void putProblem(NNode loc, String msg) {
String file;
if (loc != null && ((file = loc.getFile()) != null)) {
addFileErr(file, loc.start(), loc.end(), msg);
}
}
public void putProblem(String file, int beg, int end, String msg) {
if (file != null) {
addFileErr(file, beg, end, msg);
}
}
void addFileErr(String file, int beg, int end, String msg) {
List<Diagnostic> msgs = getFileErrs(file, problems);
msgs.add(new Diagnostic(file, Diagnostic.Type.ERROR, beg, end, msg));
}
List<Diagnostic> getParseErrs(String file) {
return getFileErrs(file, parseErrs);
}
List<Diagnostic> getFileErrs(String file, Map<String, List<Diagnostic>> map) {
List<Diagnostic> msgs = map.get(file);
if (msgs == null) {
msgs = new ArrayList<Diagnostic>();
map.put(file, msgs);
}
return msgs;
}
/**
* Loads a file and all its ancestor packages.
* @see #loadFile(String,boolean)
*/
public NModuleType loadFile(String path) throws Exception {
return loadFile(path, false);
}
/**
* Loads a module from a string containing the module contents.
* Idempotent: looks in the module cache first. Used for simple unit tests.
* @param path a path for reporting/caching purposes. The filename
* component is used to construct the module qualified name.
*/
public NModuleType loadString(String path, String contents) throws Exception {
NModuleType module = getCachedModule(path);
if (module != null) {
finer("\nusing cached module " + path + " [succeeded]");
return module;
}
return parseAndResolve(path, contents);
}
/**
* Load, parse and analyze a source file given its absolute path.
* By default, loads the entire ancestor package chain.
*
* @param path the absolute path to the file or directory.
* If it is a directory, it is suffixed with "__init__.py", and
* only that file is loaded from the directory.
*
* @param skipChain {@code true} to skip loading ancestor packages
*
* @return {@code null} if {@code path} could not be loaded
*/
public NModuleType loadFile(String path, boolean skipChain) throws Exception {
File f = new File(path);
if (f.isDirectory()) {
finer("\n loading init file from directory: " + path);
f = Util.joinPath(path, "__init__.py");
path = f.getAbsolutePath();
}
if (!f.canRead()) {
finer("\nfile not not found or cannot be read: " + path);
return null;
}
NModuleType module = getCachedModule(path);
if (module != null) {
finer("\nusing cached module " + path + " [succeeded]");
return module;
}
if (!skipChain) {
loadParentPackage(path);
}
try {
return parseAndResolve(path);
} catch (StackOverflowError soe) {
handleException("Error loading " + path, soe);
return null;
}
}
/**
* When we load a module, load all its parent packages, top-down.
* This is in part because Python does it anyway, and in part so that you
* can click on all parent package components in import statements.
* We load whole ancestor chain top-down, as does Python.
*/
private void loadParentPackage(String file) throws Exception {
File f = new File(file);
File parent = f.getParentFile();
if (parent == null || isInLoadPath(parent)) {
return;
}
// the parent package of an __init__.py file is the grandparent dir
if (f.isFile() && "__init__.py".equals(f.getName())) {
parent = parent.getParentFile();
}
if (parent == null || isInLoadPath(parent)) {
return;
}
File initpy = Util.joinPath(parent, "__init__.py");
if (!(initpy.isFile() && initpy.canRead())) {
return;
}
loadFile(initpy.getPath());
}
private boolean isInLoadPath(File dir) {
for (String s : getLoadPath()) {
if (new File(s).equals(dir)) {
return true;
}
}
return false;
}
private NModuleType parseAndResolve(String file) throws Exception {
return parseAndResolve(file, null);
}
/**
* Parse a file or string and return its module parse tree.
* @param file the filename
* @param contents optional file contents. If {@code null}, loads the
* file contents from disk.
*/
@SuppressWarnings("unchecked")
private NModuleType parseAndResolve(String file, String contents) throws Exception {
// Avoid infinite recursion if any caller forgets this check. (Has happened.)
NModuleType nmt = (NModuleType)moduleTable.lookupType(file);
if (nmt != null) {
return nmt;
}
// Put it in the cache now to prevent circular import from recursing.
NModuleType mod = new NModuleType(Util.moduleNameFor(file), file, globaltable);
moduleTable.put(file, new NUrl("file://" + file), mod, NBinding.Kind.MODULE);
try {
NModule ast = null;
if (contents != null) {
ast = getAstForFile(file, contents);
} else {
ast = getAstForFile(file);
}
if (ast == null) {
return null;
}
finer("resolving: " + file);
ast.resolve(globaltable);
finer("[success]");
loadedFiles++;
return mod;
} catch (OutOfMemoryError e) {
if (astCache != null) {
astCache.clear();
}
System.gc();
return null;
}
}
private AstCache getAstCache() throws Exception {
if (astCache == null) {
astCache = AstCache.get();
}
return astCache;
}
/**
* Returns the syntax tree for {@code file}. <p>
*/
public NModule getAstForFile(String file) throws Exception {
return getAstCache().getAST(file);
}
/**
* Returns the syntax tree for {@code file}. <p>
*/
public NModule getAstForFile(String file, String contents) throws Exception {
return getAstCache().getAST(file, contents);
}
public NModuleType getBuiltinModule(String qname) throws Exception {
return builtins.get(qname);
}
/**
* This method searches the module path for the module {@code modname}. If found, it is passed
* to {@link #loadFile}.
*
* <p>
* The mechanisms for importing modules are in general statically undecidable. We make a
* reasonable effort to follow the most common lookup rules.
*
* @param modname a module name. Can be a relative path to a directory or a file (without the
* extension) or a possibly-qualified module name. If it is a module name, cannot
* contain leading dots.
*
* @see <a href="http://docs.python.org/reference/simple_stmts.html#the-import-statement">The
* Import Statement</a>
*/
public NModuleType loadModule(String modname) throws Exception {
if (failedModules.contains(modname)) {
return null;
}
NModuleType cached = getCachedModule(modname); // builtin file-less modules
if (cached != null) {
finer("\nusing cached module " + modname);
return cached;
}
NModuleType mt = getBuiltinModule(modname);
if (mt != null) {
return mt;
}
finer("looking for module " + modname);
if (modname.endsWith(".py")) {
modname = modname.substring(0, modname.length() - 3);
}
String modpath = modname.replace('.', File.separatorChar);
// A nasty hack to avoid e.g. python2.5 becoming python2/5.
// Should generalize this for directory components containing '.'.
modpath = modpath.replaceFirst("(/python[23])/([0-9]/)", "$1.$2");
List<String> loadPath = getLoadPath();
for (String p : loadPath) {
String dirname = p + modpath;
String pyname = dirname + ".py";
String initname = Util.joinPath(dirname, "__init__.py").getAbsolutePath();
String name;
// foo/bar has priority over foo/bar.py
// http://www.python.org/doc/essays/packages.html
if (Util.isReadableFile(initname)) {
name = initname;
} else if (Util.isReadableFile(pyname)) {
name = pyname;
} else {
continue;
}
name = Util.canonicalize(name);
NModuleType m = loadFile(name);
if (m != null) {
finer("load of module " + modname + "[succeeded]");
return m;
}
}
finer("failed to find module " + modname + " in load path");
failedModules.add(modname);
return null;
}
/**
* Load all Python source files recursively if the given fullname is a
* directory; otherwise just load a file. Looks at file extension to
* determine whether to load a given file.
*/
public void loadFileRecursive(String fullname) throws Exception {
File file_or_dir = new File(fullname);
if (file_or_dir.isDirectory()) {
for (File file : file_or_dir.listFiles()) {
loadFileRecursive(file.getAbsolutePath());
}
} else {
if (file_or_dir.getAbsolutePath().endsWith(".py")) {
loadFile(file_or_dir.getAbsolutePath());
}
}
}
/**
* Performs final indexing-building passes, including marking references to
* undeclared variables. Caller should invoke this method after loading all
* files.
*/
public void ready() {
fine("Checking for undeclared variables");
for (Entry<Ref, List<NBinding>> ent : locations.entrySet()) {
Ref ref = ent.getKey();
List<NBinding> bindings = ent.getValue();
convertCallToNew(ref, bindings);
if (countDefs(bindings) == 0) {
// XXX: fix me:
// if (ref instanceof NName && ((NName)ref).isAttribute()) {
// nunknown++; // not so serious
// } else {
// nunbound++; // more serious
// putProblem(ref, "variable may not be bound: " + ref);
// }
} else {
nloc++;
}
}
nprob = problems.size();
nparsing = parseErrs.size();
Set<String> removals = new HashSet<String>();
for (Entry<String, NBinding> e : allBindings.entrySet()) {
NBinding nb = e.getValue();
if (nb.isProvisional() || nb.getNumDefs() == 0) {
removals.add(e.getKey());
}
}
for (String s : removals) {
allBindings.remove(s);
}
locations.clear();
}
private void convertCallToNew(Ref ref, List<NBinding> bindings) {
if (ref.isRef()) {
return;
}
if (bindings.isEmpty()) {
return;
}
NBinding nb = bindings.get(0);
NType t = nb.followType();
if (t.isUnionType()) {
t = t.asUnionType().firstKnownNonNullAlternate();
if (t == null) {
return;
}
}
NType tt = t.follow();
if (!tt.isUnknownType() && !tt.isFuncType()) {
ref.markAsNew();
}
}
/**
* Clears the AST cache (to free up memory). Subsequent calls to
* {@link #getAstForFile} will either fetch the serialized AST from a
* disk cache or re-parse the file from scratch.
*/
public void clearAstCache() {
if (astCache != null) {
astCache.clear();
}
}
/**
* Clears the module table, discarding all resolved ASTs (modules)
* and their scope information.
*/
public void clearModuleTable() {
moduleTable.clear();
moduleTable = new Scope(null, Scope.Type.GLOBAL);
clearAstCache();
}
private int countDefs(List<NBinding> bindings) {
int count = 0;
for (NBinding b : bindings) {
count += b.getNumDefs();
}
return count;
}
private String printBindings() {
StringBuilder sb = new StringBuilder();
Set<String> sorter = new TreeSet<String>();
sorter.addAll(allBindings.keySet());
for (String key : sorter) {
NBinding b = allBindings.get(key);
sb.append(b.toString()).append("\n");
}
return sb.toString();
}
/**
* Reports a failed module or submodule resolution.
* @param qname module qname, e.g. "org.foo.bar"
* @param file the file where the unresolved import occurred
*/
public void recordUnresolvedModule(String qname, String file) {
Set<String> importers = unresolvedModules.get(qname);
if (importers == null) {
importers = new TreeSet<String>();
unresolvedModules.put(qname, importers);
}
importers.add(file);
}
/**
* Report resolution rate and other statistics data.
*/
public String getStatusReport() {
int total = nloc + nunbound + nunknown;
if (total == 0) {
total = 1;
}
StringBuilder sb = new StringBuilder();
sb.append("Summary: \n")
.append("- modules loaded: ")
.append(loadedFiles)
.append("\n- unresolved modules: ")
.append(unresolvedModules.size())
.append("\n");
for (String s : unresolvedModules.keySet()) {
sb.append(s).append(": ");
Set<String> importers = unresolvedModules.get(s);
if (importers.size() > 5) {
sb.append(importers.iterator().next());
sb.append(" and " );
sb.append(importers.size());
sb.append(" more");
} else {
String files = importers.toString();
sb.append(files.substring(1, files.length() - 1));
}
sb.append("\n");
}
// XXX: these are no longer accurate, and need to be fixed.
// .append("\nnames resolved: " .append(percent(nloc, total)
// .append("\nunbound: " .append(percent(nunbound, total)
// .append("\nunknown: " .append(percent(nunknown, total)
sb.append("\nsemantics problems: ").append(nprob);
sb.append("\nparsing problems: ").append(nparsing);
return sb.toString();
}
private String percent(int num, int total) {
double pct = (num * 1.0) / total;
pct = Math.round(pct * 10000) / 100.0;
return num + "/" + total + " = " + pct + "%";
}
public int numFilesLoaded() {
return loadedFiles;
}
public List<String> getLoadedFiles() {
List<String> files = new ArrayList<String>();
for (String file : moduleTable.keySet()) {
if (file.startsWith(File.separator)) {
files.add(file);
}
}
return files;
}
public void log(Level level, String msg) {
if (logger.isLoggable(level)) {
logger.log(level, msg);
}
}
public void severe(String msg) {
log(Level.SEVERE, msg);
}
public void warn(String msg) {
log(Level.WARNING, msg);
}
public void info(String msg) {
log(Level.INFO, msg);
}
public void fine(String msg) {
log(Level.FINE, msg);
}
public void finer(String msg) {
log(Level.FINER, msg);
}
/**
* Releases all resources for the current indexer.
*/
public void release() {
// Null things out to catch anyone who might still be referencing them.
moduleTable = globaltable = null;
clearAstCache();
astCache = null;
locations = null;
problems.clear();
problems = null;
parseErrs.clear();
parseErrs = null;
path.clear();
path = null;
failedModules.clear();
failedModules = null;
unresolvedModules.clear();
unresolvedModules = null;
builtins = null;
allBindings.clear();
allBindings = null;
// Technically this is all that's needed for the garbage collector.
idx = null;
}
@Override
public String toString() {
return "<Indexer:locs=" + locations.size() + ":unbound=" + nunbound + ":probs="
+ problems.size() + ":files=" + loadedFiles + ">";
}
}