Move the Report Checker

typetools · Dec 12, 2023 · 8b53131 · 8b53131
1 parent 1308bb3
commit 8b53131
Show file tree

Hide file tree

Showing 30 changed files with 88 additions and 87 deletions.
diff --git a/...k/common/util/report/qual/ReportCall.java → ...on/util/count/report/qual/ReportCall.java b/...k/common/util/report/qual/ReportCall.java → ...on/util/count/report/qual/ReportCall.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/...mmon/util/report/qual/ReportCreation.java → ...til/count/report/qual/ReportCreation.java b/...mmon/util/report/qual/ReportCreation.java → ...til/count/report/qual/ReportCreation.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/...ommon/util/report/qual/ReportInherit.java → ...util/count/report/qual/ReportInherit.java b/...ommon/util/report/qual/ReportInherit.java → ...util/count/report/qual/ReportInherit.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/...mmon/util/report/qual/ReportOverride.java → ...til/count/report/qual/ReportOverride.java b/...mmon/util/report/qual/ReportOverride.java → ...til/count/report/qual/ReportOverride.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/...mon/util/report/qual/ReportReadWrite.java → ...il/count/report/qual/ReportReadWrite.java b/...mon/util/report/qual/ReportReadWrite.java → ...il/count/report/qual/ReportReadWrite.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/...n/util/report/qual/ReportUnqualified.java → .../count/report/qual/ReportUnqualified.java b/...n/util/report/qual/ReportUnqualified.java → .../count/report/qual/ReportUnqualified.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
@@ -11,7 +11,7 @@
 
 /**
  * An annotation intended solely for representing an unqualified type in the qualifier hierarchy for
- * the Report Checker.
+ * the Report Checker. This is the only type qualifier in the type hierarchy.
  */
 @Documented
 @Retention(RetentionPolicy.SOURCE) // do not store in class file

diff --git a/...rk/common/util/report/qual/ReportUse.java → ...mon/util/count/report/qual/ReportUse.java b/...rk/common/util/report/qual/ReportUse.java → ...mon/util/count/report/qual/ReportUse.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/.../common/util/report/qual/ReportWrite.java → ...n/util/count/report/qual/ReportWrite.java b/.../common/util/report/qual/ReportWrite.java → ...n/util/count/report/qual/ReportWrite.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report.qual;
+package org.checkerframework.common.util.count.report.qual;
 
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -3,6 +3,11 @@ Version 3.41.1 (January 2, 2023)
 
 **User-visible changes:**
 
+In `org.checkerframework.common.util.debug`, renamed `EmptyProcessor` to `DoNothingProcessor`.
+Removed `org.checkerframework.common.util.report.DoNothingChecker`.
+Moved `ReportChecker` from `org.checkerframework.common.util.report` to `org.checkerframework.common.util.count.report`.
+
+
 **Implementation details:**
 
 **Closed issues:**

diff --git a/docs/developer/developer-manual.html b/docs/developer/developer-manual.html
@@ -531,7 +531,8 @@ <h2 id="Counting_annotations">Counting annotations</h2>
 <ul>
   <li><a href="https://checkerframework.org/api/org/checkerframework/common/util/count/AnnotationStatistics.html">AnnotationStatistics</a></li>
   <li><a href="https://checkerframework.org/api/org/checkerframework/common/util/count/JavaCodeStatistics.html">JavaCodeStatistics</a></li>
-  <li><a href="https://github.com/typetools/checker-framework/blob/master/checker/bin-devel/count-suppression-reasons">count-suppression-reasons"></a></li>
+  <li><a href="https://checkerframework.org/api/org/checkerframework/common/util/count/report/ReportChecker.html">ReportChecker</a></li>
+  <li><a href="https://github.com/typetools/checker-framework/blob/master/checker/bin-devel/count-suppression-reasons">count-suppression-reasons</a></li>
 </ul>
 
 

diff --git a/framework/jtreg/StubParserEnum/AnnotationFileParserEnum.astub b/framework/jtreg/StubParserEnum/AnnotationFileParserEnum.astub
@@ -1,4 +1,4 @@
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 package java.util.concurrent;
 

diff --git a/framework/jtreg/StubParserEnum/AnnotationFileParserEnumTest.java b/framework/jtreg/StubParserEnum/AnnotationFileParserEnumTest.java
@@ -3,14 +3,14 @@
  * @summary Adapted test case for Issue 2147
  * https://github.com/typetools/checker-framework/issues/2147 using framework package quals
  *
- * @compile/fail/ref=WithoutStub.out -XDrawDiagnostics -processor org.checkerframework.common.util.report.ReportChecker -AstubWarnIfNotFound AnnotationFileParserEnumTest.java
- * @compile/fail/ref=WithStub.out -XDrawDiagnostics -processor org.checkerframework.common.util.report.ReportChecker -AstubWarnIfNotFound -Astubs=AnnotationFileParserEnum.astub AnnotationFileParserEnumTest.java
+ * @compile/fail/ref=WithoutStub.out -XDrawDiagnostics -processor org.checkerframework.common.util.count.report.ReportChecker -AstubWarnIfNotFound AnnotationFileParserEnumTest.java
+ * @compile/fail/ref=WithStub.out -XDrawDiagnostics -processor org.checkerframework.common.util.count.report.ReportChecker -AstubWarnIfNotFound -Astubs=AnnotationFileParserEnum.astub AnnotationFileParserEnumTest.java
  */
 
 import static java.util.concurrent.TimeUnit.*;
 
 import java.util.concurrent.TimeUnit;
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 public class AnnotationFileParserEnumTest {
 

diff --git a/framework/src/main/java/org/checkerframework/common/util/count/AnnotationStatistics.java b/framework/src/main/java/org/checkerframework/common/util/count/AnnotationStatistics.java
@@ -59,6 +59,7 @@
  * </ul>
  *
  * @see JavaCodeStatistics
+ * @see org.checkerframework.common.util.count.report.ReportChecker
  */
 /*
  * TODO: add an option to only list declaration or type annotations.

diff --git a/framework/src/main/java/org/checkerframework/common/util/count/JavaCodeStatistics.java b/framework/src/main/java/org/checkerframework/common/util/count/JavaCodeStatistics.java
@@ -24,7 +24,7 @@
 import org.checkerframework.javacutil.TreeUtils;
 
 /**
- * An annotation processor for counting the size of Java code:
+ * An annotation processor for counting a few specific aspects about the size of Java code:
  *
  * <ul>
  *   <li>The number of type parameter declarations and uses.
@@ -39,6 +39,7 @@
  * </pre>
  *
  * @see AnnotationStatistics
+ * @see org.checkerframework.common.util.count.report.ReportChecker
  */
 @SupportedSourceVersion(SourceVersion.RELEASE_8)
 public class JavaCodeStatistics extends SourceChecker {

diff --git a/framework/src/main/java/org/checkerframework/common/util/count/report/ReportChecker.java b/framework/src/main/java/org/checkerframework/common/util/count/report/ReportChecker.java
@@ -0,0 +1,40 @@
+package org.checkerframework.common.util.count.report;
+
+import javax.annotation.processing.SupportedOptions;
+import org.checkerframework.common.basetype.BaseTypeChecker;
+
+/**
+ * The Report Checker performs semantic searches over a program, for example, to find all methods
+ * that override a specific method, all classes that inherit from a specific class, or all uses of
+ * do-while-loops (and not also while loops!).
+ *
+ * <p>The search is specified in two different ways.
+ *
+ * <p>The first way is to write a stub specification file using the annotations in {@code
+ * org.checkerframework.common.util.count.report.qual.*}. You can see examples in the Checker
+ * Framework repository at {@code framework/tests/report/reporttest.astub} and {@code
+ * framework/jtreg/StubParserEnum/AnnotationFileParserEnum.astub}.
+ *
+ * <p>The second way is the {@code -AreportTreeKinds} and {@code -AreportModifiers} options, which
+ * search for specific tree kinds or modifiers.
+ *
+ * <p>Some similar features are available from IDEs (e.g., show references), but this tool provides
+ * much more flexibility and a command-line tool.
+ *
+ * <p>Options:
+ *
+ * <ul>
+ *   <li><code>-AreportTreeKinds</code>: comma-separated list of <code>Tree.Kind</code>s that should
+ *       be reported
+ *   <li><code>-AreportModifiers</code>: comma-separated list of modifiers that should be reported
+ * </ul>
+ *
+ * @see org.checkerframework.common.util.count.AnnotationStatistics
+ * @see org.checkerframework.common.util.count.JavaCodeStatistics
+ */
+@SupportedOptions({"reportTreeKinds", "reportModifiers"})
+public class ReportChecker extends BaseTypeChecker {
+
+  /** Creates a ReportChecker. */
+  public ReportChecker() {}
+}
diff --git a/...ork/common/util/report/ReportVisitor.java → ...mmon/util/count/report/ReportVisitor.java b/...ork/common/util/report/ReportVisitor.java → ...mmon/util/count/report/ReportVisitor.java
@@ -1,4 +1,4 @@
-package org.checkerframework.common.util.report;
+package org.checkerframework.common.util.count.report;
 
 import com.sun.source.tree.ArrayAccessTree;
 import com.sun.source.tree.AssignmentTree;
@@ -29,13 +29,13 @@
 import org.checkerframework.common.basetype.BaseTypeChecker;
 import org.checkerframework.common.basetype.BaseTypeValidator;
 import org.checkerframework.common.basetype.BaseTypeVisitor;
-import org.checkerframework.common.util.report.qual.ReportCall;
-import org.checkerframework.common.util.report.qual.ReportCreation;
-import org.checkerframework.common.util.report.qual.ReportInherit;
-import org.checkerframework.common.util.report.qual.ReportOverride;
-import org.checkerframework.common.util.report.qual.ReportReadWrite;
-import org.checkerframework.common.util.report.qual.ReportUse;
-import org.checkerframework.common.util.report.qual.ReportWrite;
+import org.checkerframework.common.util.count.report.qual.ReportCall;
+import org.checkerframework.common.util.count.report.qual.ReportCreation;
+import org.checkerframework.common.util.count.report.qual.ReportInherit;
+import org.checkerframework.common.util.count.report.qual.ReportOverride;
+import org.checkerframework.common.util.count.report.qual.ReportReadWrite;
+import org.checkerframework.common.util.count.report.qual.ReportUse;
+import org.checkerframework.common.util.count.report.qual.ReportWrite;
 import org.checkerframework.framework.type.AnnotatedTypeFactory;
 import org.checkerframework.framework.type.AnnotatedTypeMirror.AnnotatedDeclaredType;
 import org.checkerframework.framework.util.AnnotatedTypes;

diff --git a/...rk/common/util/report/messages.properties → ...mon/util/count/report/messages.properties b/...rk/common/util/report/messages.properties → ...mon/util/count/report/messages.properties
diff --git a/...ork/common/util/debug/EmptyProcessor.java → ...common/util/debug/DoNothingProcessor.java b/...ork/common/util/debug/EmptyProcessor.java → ...common/util/debug/DoNothingProcessor.java
@@ -8,16 +8,19 @@
 import javax.lang.model.element.TypeElement;
 
 /**
- * Empty simple processor.
+ * This is an annotation processor that does nothing.
  *
- * <p>It is useful in debugging compiler behavior with an annotation processor present.
+ * <p>Use it when you are required to provide an annotation processor, or when you want to debug
+ * compiler behavior with an annotation processor present.
  */
 @SupportedAnnotationTypes("*")
-public class EmptyProcessor extends AbstractProcessor {
+public class DoNothingProcessor extends AbstractProcessor {
+
+  /** Creates a DoNothingProcessor. */
+  public DoNothingProcessor() {}
 
   @Override
   public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
-    System.out.println("Empty Processor run!");
     return false;
   }
 

diff --git a/framework/src/main/java/org/checkerframework/common/util/report/DoNothingChecker.java b/framework/src/main/java/org/checkerframework/common/util/report/DoNothingChecker.java
diff --git a/framework/src/main/java/org/checkerframework/common/util/report/ReportChecker.java b/framework/src/main/java/org/checkerframework/common/util/report/ReportChecker.java
diff --git a/framework/src/test/java/org/checkerframework/framework/test/junit/ReportModifiersTest.java b/framework/src/test/java/org/checkerframework/framework/test/junit/ReportModifiersTest.java
@@ -13,7 +13,7 @@ public class ReportModifiersTest extends CheckerFrameworkPerDirectoryTest {
   public ReportModifiersTest(List<File> testFiles) {
     super(
         testFiles,
-        org.checkerframework.common.util.report.ReportChecker.class,
+        org.checkerframework.common.util.count.report.ReportChecker.class,
         "report",
         "-AreportModifiers=native");
   }

diff --git a/framework/src/test/java/org/checkerframework/framework/test/junit/ReportTest.java b/framework/src/test/java/org/checkerframework/framework/test/junit/ReportTest.java
@@ -13,7 +13,7 @@ public class ReportTest extends CheckerFrameworkPerDirectoryTest {
   public ReportTest(List<File> testFiles) {
     super(
         testFiles,
-        org.checkerframework.common.util.report.ReportChecker.class,
+        org.checkerframework.common.util.count.report.ReportChecker.class,
         "report",
         "-Astubs=tests/report/reporttest.astub");
   }

diff --git a/framework/src/test/java/org/checkerframework/framework/test/junit/ReportTreeKindsTest.java b/framework/src/test/java/org/checkerframework/framework/test/junit/ReportTreeKindsTest.java
@@ -13,7 +13,7 @@ public class ReportTreeKindsTest extends CheckerFrameworkPerDirectoryTest {
   public ReportTreeKindsTest(List<File> testFiles) {
     super(
         testFiles,
-        org.checkerframework.common.util.report.ReportChecker.class,
+        org.checkerframework.common.util.count.report.ReportChecker.class,
         "report",
         "-AreportTreeKinds=WHILE_LOOP,CONDITIONAL_AND");
   }

diff --git a/framework/tests/report/Accesses.java b/framework/tests/report/Accesses.java
@@ -1,4 +1,4 @@
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 public class Accesses {
   class Demo {

diff --git a/framework/tests/report/CallOverrides.java b/framework/tests/report/CallOverrides.java
@@ -1,4 +1,4 @@
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 public class CallOverrides {
   class A {

diff --git a/framework/tests/report/Creation.java b/framework/tests/report/Creation.java
@@ -1,4 +1,4 @@
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 public class Creation {
   class TestOne {

diff --git a/framework/tests/report/Inherit.java b/framework/tests/report/Inherit.java
@@ -1,4 +1,4 @@
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 public class Inherit {
   @ReportInherit

diff --git a/framework/tests/report/Interface.java b/framework/tests/report/Interface.java
@@ -2,7 +2,7 @@
 // https://github.com/typetools/checker-framework/issues/658
 // @skip-test
 
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 public class Interface {
   interface A {

diff --git a/framework/tests/report/Overrides.java b/framework/tests/report/Overrides.java
@@ -1,4 +1,4 @@
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 public class Overrides {
   class A {

diff --git a/framework/tests/report/reporttest.astub b/framework/tests/report/reporttest.astub
@@ -1,4 +1,4 @@
-import org.checkerframework.common.util.report.qual.*;
+import org.checkerframework.common.util.count.report.qual.*;
 
 package java.lang;