0.8.19.38:
[sbcl.git] / src / compiler / ir1report.lisp
index 697e7c4..6dbedfb 100644 (file)
 
 (declaim (special *current-path*))
 
-;;; We bind print level and length when printing out messages so that
-;;; we don't dump huge amounts of garbage.
-;;;
-;;; FIXME: It's not possible to get the defaults right for everyone.
-;;; So: Should these variables be in the SB-EXT package? Or should we
-;;; just get rid of them completely and just use the bare
-;;; CL:*PRINT-FOO* variables instead?
-(declaim (type (or unsigned-byte null)
-              *compiler-error-print-level*
-              *compiler-error-print-length*
-              *compiler-error-print-lines*))
-(defvar *compiler-error-print-level* 5
-  #!+sb-doc
-  "the value for *PRINT-LEVEL* when printing compiler error messages")
-(defvar *compiler-error-print-length* 10
-  #!+sb-doc
-  "the value for *PRINT-LENGTH* when printing compiler error messages")
-(defvar *compiler-error-print-lines* 12
-  #!+sb-doc
-  "the value for *PRINT-LINES* when printing compiler error messages")
-
 (defvar *enclosing-source-cutoff* 1
   #!+sb-doc
   "The maximum number of enclosing non-original source forms (i.e. from
@@ -72,7 +51,9 @@
   ;; the file position at which the top level form starts, if applicable
   (file-position nil :type (or index null))
   ;; the original source part of the source path
-  (original-source-path nil :type list))
+  (original-source-path nil :type list)
+  ;; the lexenv active at the time
+  (lexenv nil :type (or null lexenv)))
 
 ;;; If true, this is the node which is used as context in compiler warning
 ;;; messages.
 (defun source-form-context (form)
   (cond ((atom form) nil)
        ((>= (length form) 2)
-        (funcall (gethash (first form) *source-context-methods*
-                          (lambda (x)
-                            (declare (ignore x))
-                            (list (first form) (second form))))
-                 (rest form)))
+         (let* ((context-fun-default (lambda (x)
+                                      (declare (ignore x))
+                                      (list (first form) (second form))))
+               (context-fun (gethash (first form)
+                                     *source-context-methods*
+                                     context-fun-default)))
+           (declare (type function context-fun))
+           (funcall context-fun (rest form))))
        (t
         form)))
 
 ;;; compiler warnings.
 (defun stringify-form (form &optional (pretty t))
   (with-standard-io-syntax
-   (let ((*print-readably* nil)
-         (*print-pretty* pretty)
-         (*print-level* *compiler-error-print-level*)
-         (*print-length* *compiler-error-print-length*)
-         (*print-lines* *compiler-error-print-lines*))
-     (if pretty
-         (format nil "~<~@;  ~S~:>" (list form))
-         (prin1-to-string form)))))
-
-;;; shorthand for creating debug names from source names or other
-;;; stems, e.g.
-;;;   (DEBUG-NAMIFY "FLET ~S" SOURCE-NAME)
-;;;   (DEBUG-NAMIFY "top level form ~S" FORM)
-;;;
-;;; FIXME: This function seems to have a lot in common with
-;;; STRINGIFY-FORM, and perhaps there's some way to merge the two
-;;; functions.
-(defun debug-namify (format-string &rest format-arguments)
-  (with-standard-io-syntax
-   (let ((*print-readably* nil)
-         (*package* *cl-package*)
-         (*print-length* 3)
-         (*print-level* 2))
-     (apply #'format nil format-string format-arguments))))
-
-;;; shorthand for a repeated idiom in creating debug names
-;;;
-;;; the problem, part I: We want to create debug names that look like
-;;; "&MORE processor for <something>" where <something> might be
-;;; either a source-name value (typically a symbol) or a non-symbol
-;;; debug-name value (typically a string). It's awkward to handle this
-;;; with FORMAT because we'd like to splice a source-name value using
-;;; "~S" (to get package qualifiers) but a debug-name value using "~A"
-;;; (to avoid irrelevant quotes at string splice boundaries).
-;;;
-;;; the problem, part II: The <something> is represented as a pair
-;;; of values, SOURCE-NAME and DEBUG-NAME, where SOURCE-NAME is used
-;;; if it's not null.
-;;;
-;;; the solution: Use this function to convert whatever it is to a
-;;; string, which FORMAT can then splice using "~A".
-(defun as-debug-name (source-name debug-name)
-  (if source-name
-      (debug-namify "~S" source-name)
-      debug-name))
+    (with-compiler-io-syntax
+        (let ((*print-pretty* pretty))
+          (if pretty
+              (format nil "~<~@;  ~S~:>" (list form))
+              (prin1-to-string form))))))
 
 ;;; Return a COMPILER-ERROR-CONTEXT structure describing the current
 ;;; error context, or NIL if we can't figure anything out. ARGS is a
                     (declare (ignore ignore))
                     pos)
                   :original-source-path
-                  (source-path-original-source path))))))))))
+                  (source-path-original-source path)
+                  :lexenv (if context
+                              (node-lexenv context)
+                              (if (boundp '*lexenv*) *lexenv* nil)))))))))))
 \f
 ;;;; printing error messages
 
 ;;; count when we are done.
 (defun note-message-repeats (&optional (terpri t))
   (cond ((= *last-message-count* 1)
-        (when terpri (terpri *error-output*)))
+        (when terpri (terpri *standard-output*)))
        ((> *last-message-count* 1)
-          (format *error-output* "~&; [Last message occurs ~W times.]~2%"
+          (format *standard-output* "~&; [Last message occurs ~W times.]~2%"
                 *last-message-count*)))
   (setq *last-message-count* 0))
 
 ;;;
 ;;; We suppress printing of messages identical to the previous, but
 ;;; record the number of times that the message is repeated.
-(defun print-compiler-message (format-string format-args)
+(defmacro print-compiler-message (format-string format-args)
+  `(with-compiler-io-syntax
+     (%print-compiler-message ,format-string ,format-args)))
 
+(defun %print-compiler-message (format-string format-args)
   (declare (type simple-string format-string))
-  (declare (type list format-args))
-  
-  (let ((stream *error-output*)
+  (declare (type list format-args))  
+  (let ((stream *standard-output*)
        (context (find-error-context format-args)))
     (cond
      (context
             (format stream "in:~{~<~%    ~4:;~{ ~S~}~>~^ =>~}" in))
           (format stream "~%"))
 
-
        (unless (and last
                     (string= form
                              (compiler-error-context-original-source last)))
 
     (setq *last-error-context* context)
 
+    ;; FIXME: this testing for effective equality of compiler messages
+    ;; is ugly, and really ought to be done at a higher level.
     (unless (and (equal format-string *last-format-string*)
                 (tree-equal format-args *last-format-args*))
       (note-message-repeats nil)
       (setq *last-format-string* format-string)
       (setq *last-format-args* format-args)
-      (let ((*print-level*  *compiler-error-print-level*)
-           (*print-length* *compiler-error-print-length*)
-           (*print-lines*  *compiler-error-print-lines*))
-        (format stream "~&")
-        (pprint-logical-block (stream nil :per-line-prefix "; ")
-          (format stream "~&~?" format-string format-args))
-        (format stream "~&"))))
-
+      (format stream "~&")
+      (pprint-logical-block (stream nil :per-line-prefix "; ")
+        (format stream "~&~?" format-string format-args))
+      (format stream "~&")))
+  
   (incf *last-message-count*)
   (values))
 
        (what (etypecase condition
                (style-warning 'style-warning)
                (warning 'warning)
-               (error 'error))))
-    (multiple-value-bind (format-string format-args)
-       (if (typep condition 'simple-condition)
-           (values (simple-condition-format-control condition)
-                   (simple-condition-format-arguments condition))
-           (values "~A"
-                   (list (with-output-to-string (s)
-                           (princ condition s)))))
-      (print-compiler-message (format nil
-                                     "caught ~S:~%  ~A"
-                                     what
-                                     format-string)
-                             format-args)))
+               ((or error compiler-error) 'error))))
+    (print-compiler-message
+     (format nil "caught ~S:~%~~@<  ~~@;~~A~~:>" what)
+     (list (with-output-to-string (s) (princ condition s)))))
   (values))
 
-;;; COMPILER-NOTE is vaguely like COMPILER-ERROR and the other
-;;; condition-signalling functions, but it just writes some output
-;;; instead of signalling. (In CMU CL, it did signal a condition, but
-;;; this didn't seem to work all that well; it was weird to have
-;;; COMPILE-FILE return with WARNINGS-P set when the only problem was
-;;; that the compiler couldn't figure out how to compile something as
-;;; efficiently as it liked.)
-(defun compiler-note (format-string &rest format-args)
+;;; The act of signalling one of these beasts must not cause WARNINGSP
+;;; (or FAILUREP) to be set from COMPILE or COMPILE-FILE, so we can't
+;;; inherit from WARNING or STYLE-WARNING.
+;;;
+;;; FIXME: the handling of compiler-notes could be unified with
+;;; warnings and style-warnings (see the various handler functions
+;;; below).
+(define-condition compiler-note (condition) ()
+  (:documentation
+   "Root of the hierarchy of conditions representing information discovered
+by the compiler that the user might wish to know, but which does not merit
+a STYLE-WARNING (or any more serious condition)."))
+(define-condition simple-compiler-note (simple-condition compiler-note) ())
+(define-condition code-deletion-note (simple-compiler-note) ()
+  (:documentation
+   "A condition type signalled when the compiler deletes code that the user
+has written, having proved that it is unreachable."))
+
+(defun compiler-notify (datum &rest args)
   (unless (if *compiler-error-context*
              (policy *compiler-error-context* (= inhibit-warnings 3))
              (policy *lexenv* (= inhibit-warnings 3)))
-    (incf *compiler-note-count*)
-    (print-compiler-message (format nil "note: ~A" format-string)
-                           format-args))
+    (let ((condition
+          (coerce-to-condition datum args
+                               'simple-compiler-note 'compiler-notify)))
+      (restart-case
+         (signal condition)
+       (muffle-warning ()
+         (return-from compiler-notify (values))))
+      (incf *compiler-note-count*)
+      (print-compiler-message 
+       (format nil "note: ~~A")
+       (list (with-output-to-string (s) (princ condition s))))))
   (values))
 
 ;;; Issue a note when we might or might not be in the compiler.
-(defun maybe-compiler-note (&rest rest)
+(defun maybe-compiler-notify (&rest rest)
   (if (boundp '*lexenv*) ; if we're in the compiler
-      (apply #'compiler-note rest)
-      (let ((stream *error-output*))
-       (pprint-logical-block (stream nil :per-line-prefix ";")
-         
-         (format stream " note: ~3I~_")
-         (pprint-logical-block (stream nil)
-           (apply #'format stream rest)))
-       (fresh-line stream)))) ; (outside logical block, no per-line-prefix)
+      (apply #'compiler-notify rest)
+      (progn
+       (let ((condition
+              (coerce-to-condition (car rest) (cdr rest)
+                                   'simple-compiler-note
+                                   'maybe-compiler-notify)))
+         (restart-case
+             (signal condition)
+           (muffle-warning ()
+             (return-from maybe-compiler-notify (values))))
+         (let ((stream *standard-output*))
+           (pprint-logical-block (stream nil :per-line-prefix ";")
+             (format stream " note: ~3I~_")
+             (pprint-logical-block (stream nil)
+               (format stream "~A" condition)))
+           ;; (outside logical block, no per-line-prefix)
+           (fresh-line stream)))
+       (values))))
 
 ;;; The politically correct way to print out progress messages and
 ;;; such like. We clear the current error context so that we know that
 (defun compiler-mumble (format-string &rest format-args)
   (note-message-repeats)
   (setq *last-error-context* nil)
-  (apply #'format *error-output* format-string format-args)
-  (force-output *error-output*)
+  (apply #'format *standard-output* format-string format-args)
+  (force-output *standard-output*)
   (values))
 
 ;;; Return a string that somehow names the code in COMPONENT. We use
     (aver ep) ; else no entry points??
     (multiple-value-bind (form context)
        (find-original-source
-        (node-source-path (continuation-next (block-start ep))))
+        (node-source-path (block-start-node ep)))
       (declare (ignore form))
       (let ((*print-level* 2)
            (*print-pretty* nil))
           ;; Check for boundness so we don't blow up if we're called
           ;; when IR1 conversion isn't going on.
           (boundp '*lexenv*)
-          ;; FIXME: I'm pretty sure the INHIBIT-WARNINGS test below
-          ;; isn't a good idea; we should have INHIBIT-WARNINGS
-          ;; affect compiler notes, not STYLE-WARNINGs. And I'm not
-          ;; sure what the BOUNDP '*LEXENV* test above is for; it's
-          ;; likely a good idea, but it probably deserves an
-          ;; explanatory comment.
-          (policy *lexenv* (= inhibit-warnings 3)))
+          (or
+           ;; FIXME: I'm pretty sure the INHIBIT-WARNINGS test below
+           ;; isn't a good idea; we should have INHIBIT-WARNINGS
+           ;; affect compiler notes, not STYLE-WARNINGs. And I'm not
+           ;; sure what the BOUNDP '*LEXENV* test above is for; it's
+           ;; likely a good idea, but it probably deserves an
+           ;; explanatory comment.
+           (policy *lexenv* (= inhibit-warnings 3))
+           ;; KLUDGE: weird decoupling between here and where we're
+           ;; going to signal the condition.  I don't think we can
+           ;; rewrite this using SIGNAL and RESTART-CASE (to take
+           ;; advantage of the (SATISFIES HANDLE-CONDITION-P)
+           ;; handler, because if that doesn't handle it the ordinary
+           ;; compiler handlers will trigger.
+           (typep
+            (ecase kind
+              (:variable (make-condition 'warning))
+              ((:function :type) (make-condition 'style-warning)))
+            (car
+             (rassoc 'muffle-warning
+                     (lexenv-handled-conditions *lexenv*))))))
     (let* ((found (dolist (warning *undefined-warnings* nil)
                    (when (and (equal (undefined-warning-name warning) name)
                               (eq (undefined-warning-kind warning) kind))