Add -AparseAllJdk option (#3279)

Also, add a tests that used that option.
typetools · May 1, 2020 · ccdcaf8 · ccdcaf8
1 parent e38f895
commit ccdcaf8
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 7 deletions.
diff --git a/checker/src/test/java/tests/ParseAllJdkTest.java b/checker/src/test/java/tests/ParseAllJdkTest.java
@@ -0,0 +1,21 @@
+package tests;
+
+import java.io.File;
+import java.util.List;
+import org.checkerframework.checker.nullness.NullnessChecker;
+import org.checkerframework.framework.test.CheckerFrameworkPerDirectoryTest;
+import org.junit.runners.Parameterized.Parameters;
+
+/** Tests -AparseAllJdk option. */
+public class ParseAllJdkTest extends CheckerFrameworkPerDirectoryTest {
+
+    /** @param testFiles the files containing test code, which will be type-checked */
+    public ParseAllJdkTest(List<File> testFiles) {
+        super(testFiles, NullnessChecker.class, "parse-all-jdk", "-AparseAllJdk");
+    }
+
+    @Parameters
+    public static String[] getTestDirs() {
+        return new String[] {"parse-all-jdk"};
+    }
+}
diff --git a/checker/tests/parse-all-jdk/Test.java b/checker/tests/parse-all-jdk/Test.java
@@ -0,0 +1,2 @@
+/** This class doesn't need a body because it is only used to test parsing all the JDK files. */
+public class Test {}
diff --git a/docs/manual/creating-a-checker.tex b/docs/manual/creating-a-checker.tex
@@ -1794,6 +1794,9 @@
 \item \code{-ApermitMissingJdk}:
   don't issue an error if no annotated JDK can be found.
 
+\item \code{-AparseAllJdk}:
+  parse all JDK files at startup rather than as needed.
+
 \item \code{-AstubDebug}:
   Print debugging messages while processing stub files.
 

diff --git a/docs/manual/introduction.tex b/docs/manual/introduction.tex
@@ -753,6 +753,7 @@
 \item
  \<-Aignorejdkastub>,
  \<-ApermitMissingJdk>,
+ \<-AparseAllJdk>,
  \<-AstubDebug>
 Stub and JDK libraries; see Section~\ref{creating-debugging-options-libraries}.
 

diff --git a/framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java b/framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java
@@ -294,6 +294,10 @@
     "permitMissingJdk",
     "nocheckjdk", // temporary, for backward compatibility
 
+    // Parse all JDK files at startup rather than as needed.
+    // org.checkerframework.framework.stub.StubTypes.StubTypes
+    "parseAllJdk",
+
     // Whether to print debugging messages while processing the stub files
     // org.checkerframework.framework.stub.StubParser.debugStubParser
     "stubDebug",

diff --git a/framework/src/main/java/org/checkerframework/framework/stub/StubParser.java b/framework/src/main/java/org/checkerframework/framework/stub/StubParser.java
@@ -2034,7 +2034,7 @@ private void stubWarnOverwritesBytecode(String warning) {
      */
     private void stubWarn(String warning, Object... args) {
         warning = String.format(warning, args);
-        if (warnings.add(warning)) {
+        if (warnings.add(warning) && !isJdkAsStub) {
             processingEnv
                     .getMessager()
                     .printMessage(javax.tools.Diagnostic.Kind.WARNING, "StubParser: " + warning);

diff --git a/framework/src/main/java/org/checkerframework/framework/stub/StubTypes.java b/framework/src/main/java/org/checkerframework/framework/stub/StubTypes.java
@@ -72,7 +72,14 @@ public class StubTypes {
     /** Should the JDK be parsed? */
     private final boolean shouldParseJdk;
 
-    /** Creates a stub type. */
+    /** Parse all JDK files at startup rather than as needed. */
+    private final boolean parseAllJdkFiles;
+
+    /**
+     * Creates a stub type.
+     *
+     * @param factory AnnotatedTypeFactory
+     */
     public StubTypes(AnnotatedTypeFactory factory) {
         this.factory = factory;
         this.typesFromStubFiles = new HashMap<>();
@@ -86,6 +93,7 @@ public StubTypes(AnnotatedTypeFactory factory) {
                 !factory.getContext().getChecker().hasOption("ignorejdkastub")
                         && SystemUtil.getJreVersion() != 8
                         && annotatedJdkVersion.equals("11");
+        this.parseAllJdkFiles = factory.getContext().getChecker().hasOption("parseAllJdk");
     }
 
     /** @return true if stub files are currently being parsed; otherwise, false. */
@@ -480,6 +488,10 @@ private void prepJdkFromFile(URL resourceURL) {
                     parseStubFile(path);
                     continue;
                 }
+                if (parseAllJdkFiles) {
+                    parseStubFile(path);
+                    continue;
+                }
                 Path relativePath = root.relativize(path);
                 // 4: /src/<module>/share/classes
                 Path savepath = relativePath.subpath(4, relativePath.getNameCount());
@@ -507,15 +519,20 @@ private void prepJdkFromJar(URL resourceURL) {
                 if (!jarEntry.isDirectory()
                         && jarEntry.getName().endsWith(".java")
                         && jarEntry.getName().startsWith("annotated-jdk")) {
-                    String jeNAme = jarEntry.getName();
+                    String jarEntryName = jarEntry.getName();
                     int index = jarEntry.getName().indexOf("/share/classes/");
                     String shortName =
-                            jeNAme.substring(index + "/share/classes/".length())
+                            jarEntryName
+                                    .substring(index + "/share/classes/".length())
                                     .replace(".java", "")
                                     .replace('/', '.');
-                    jdkStubFilesJar.put(shortName, jeNAme);
-                    if (jeNAme.endsWith("package-info.java")) {
-                        parseJarEntry(jeNAme);
+                    jdkStubFilesJar.put(shortName, jarEntryName);
+                    if (jarEntryName.endsWith("package-info.java")) {
+                        parseJarEntry(jarEntryName);
+                    }
+                    if (parseAllJdkFiles) {
+                        parseJarEntry(jarEntryName);
+                        continue;
                     }
                 }
             }