Issue#1395 : Dump on error fix

docs/manual/creating-a-checker.tex

@@ -1783,6 +1783,10 @@
 already reported the bug, and you want to continue using the checker on a
 large codebase without being inundated in stack traces.
 
+\item \code{-AdumpOnErrors}: Outputs the stack trace of the program when the
+Checker Framework encounters an error or warning. The option also requires a
+boolean parameter to enables its functionality (e.g. \code{-AdumpOnErrors=true}).
+
 \end{itemize}
 
 

docs/manual/introduction.tex

@@ -745,6 +745,7 @@
  \<-AprintAllQualifiers>,
  \<-AprintVerboseGenerics>,
  \<-Anomsgtext>
+ \<-AdumpOnErrors>
 Amount of detail in messages; see Section~\ref{creating-debugging-options-detail}.
 
 \item

framework/src/main/java/org/checkerframework/common/basetype/BaseTypeChecker.java

@@ -565,10 +565,12 @@ protected void warnUnneededSuppressions() {
     protected void printOrStoreMessage(
             Diagnostic.Kind kind, String message, Tree source, CompilationUnitTree root) {
         assert this.currentRoot == root;
+        StackTraceElement[] trace = Thread.currentThread().getStackTrace();
         if (messageStore == null) {
             super.printOrStoreMessage(kind, message, source, root);
+            printStackTrace(trace);
         } else {
-            CheckerMessage checkerMessage = new CheckerMessage(kind, message, source, this);
+            CheckerMessage checkerMessage = new CheckerMessage(kind, message, source, this, trace);
             messageStore.add(checkerMessage);
         }
     }
@@ -584,6 +586,22 @@ private void printStoredMessages(CompilationUnitTree unit) {
         if (messageStore != null) {
             for (CheckerMessage msg : messageStore) {
                 super.printOrStoreMessage(msg.kind, msg.message, msg.source, unit);
+                printStackTrace(msg.trace);
+            }
+        }
+    }
+
+    /**
+     * Output the given stack trace if the "dumpOnErrors" option is enabled.
+     *
+     * @param trace stack trace when the checker encountered a warning/error
+     */
+    private void printStackTrace(StackTraceElement[] trace) {
+        boolean dumpOnErrors = getBooleanOption("dumpOnErrors", false);
+        if (dumpOnErrors) {
+            for (StackTraceElement elem : trace) {
+                String msg = "\tat " + elem;
+                message(Diagnostic.Kind.NOTE, msg);
             }
         }
     }
@@ -600,12 +618,42 @@ private static class CheckerMessage {
          */
         final BaseTypeChecker checker;
 
+        /** Stores the stack trace till the point the checker encounters an error. */
+        final StackTraceElement @Nullable [] trace;
+
+        /**
+         * Constructor method for checker message without stack trace storage.
+         *
+         * @param kind kind of diagnostic
+         * @param message error message that needs to be printed
+         * @param source tree element causing the error
+         * @param checker the type-checker in use
+         */
         private CheckerMessage(
                 Diagnostic.Kind kind, String message, Tree source, BaseTypeChecker checker) {
+            this(kind, message, source, checker, null);
+        }
+
+        /**
+         * Constructor method for checker message if stack trace needs to be stored.
+         *
+         * @param kind kind of diagnostic, for example, error or warning
+         * @param message error message that needs to be printed
+         * @param source tree element causing the error
+         * @param checker the type-checker in use
+         * @param trace the stack trace when the checker encounters an error
+         */
+        private CheckerMessage(
+                Diagnostic.Kind kind,
+                String message,
+                Tree source,
+                BaseTypeChecker checker,
+                StackTraceElement @Nullable [] trace) {
             this.kind = kind;
             this.message = message;
             this.source = source;
             this.checker = checker;
+            this.trace = trace;
         }
 
         @Override

framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java

@@ -313,6 +313,10 @@
     // org.checkerframework.framework.util.typeinference.DefaultTypeArgumentInference
     "showInferenceSteps",
 
+    // Output stack trace when checker encounters errors
+    // org.checkerframework.common.basetype.BaseTypeChecker.printStackTrace()
+    "dumpOnErrors",
+
     /// Visualizing the CFG
 
     // Implemented in the wrapper rather than this file, but worth noting here.