1.0.18.16: many STYLE-WARNING changes.
[sbcl.git] / src / code / condition.lisp
index c17e2c3..59afa4a 100644 (file)
 
 (define-condition simple-error (simple-condition error) ())
 
-;;; not specified by ANSI, but too useful not to have around.
-(define-condition simple-style-warning (simple-condition style-warning) ())
-
 (define-condition storage-condition (serious-condition) ())
 
 (define-condition type-error (error)
              (type-error-datum condition)
              (type-error-expected-type condition)))))
 
+;;; not specified by ANSI, but too useful not to have around.
+(define-condition simple-style-warning (simple-condition style-warning) ())
 (define-condition simple-type-error (simple-condition type-error) ())
 
 (define-condition program-error (error) ())
            (*print-array* nil))
        (format stream "~S cannot be printed readably." obj)))))
 
-(define-condition reader-error (parse-error stream-error)
-  ((format-control
-    :reader reader-error-format-control
-    :initarg :format-control)
-   (format-arguments
-    :reader reader-error-format-arguments
-    :initarg :format-arguments
-    :initform '()))
-  (:report
-   (lambda (condition stream)
-     (let* ((error-stream (stream-error-stream condition))
-            (pos (file-position-or-nil-for-error error-stream)))
-       (let (lineno colno)
-         (when (and pos
-                    (< pos sb!xc:array-dimension-limit)
-                    ;; KLUDGE: lseek() (which is what FILE-POSITION
-                    ;; reduces to on file-streams) is undefined on
-                    ;; "some devices", which in practice means that it
-                    ;; can claim to succeed on /dev/stdin on Darwin
-                    ;; and Solaris.  This is obviously bad news,
-                    ;; because the READ-SEQUENCE below will then
-                    ;; block, not complete, and the report will never
-                    ;; be printed.  As a workaround, we exclude
-                    ;; interactive streams from this attempt to report
-                    ;; positions.  -- CSR, 2003-08-21
-                    (not (interactive-stream-p error-stream))
-                    (file-position error-stream :start))
-           (let ((string
-                  (make-string pos
-                               :element-type (stream-element-type
-                                              error-stream))))
-             (when (= pos (read-sequence string error-stream))
-               (setq lineno (1+ (count #\Newline string))
-                     colno (- pos
-                              (or (position #\Newline string :from-end t) -1)
-                              1))))
-           (file-position-or-nil-for-error error-stream pos))
-         (pprint-logical-block (stream nil)
-           (format stream
-                   "READER-ERROR ~@[at ~W ~]~
+(define-condition reader-error (parse-error stream-error) ()
+  (:report (lambda (condition stream)
+             (%report-reader-error condition stream))))
+
+;;; a READER-ERROR whose REPORTing is controlled by FORMAT-CONTROL and
+;;; FORMAT-ARGS (the usual case for READER-ERRORs signalled from
+;;; within SBCL itself)
+;;;
+;;; (Inheriting CL:SIMPLE-CONDITION here isn't quite consistent with
+;;; the letter of the ANSI spec: this is not a condition signalled by
+;;; SIGNAL when a format-control is supplied by the function's first
+;;; argument. It seems to me (WHN) to be basically in the spirit of
+;;; the spec, but if not, it'd be straightforward to do our own
+;;; DEFINE-CONDITION SB-INT:SIMPLISTIC-CONDITION with
+;;; FORMAT-CONTROL and FORMAT-ARGS slots, and use that condition in
+;;; place of CL:SIMPLE-CONDITION here.)
+(define-condition simple-reader-error (reader-error simple-condition)
+  ()
+  (:report (lambda (condition stream)
+             (%report-reader-error condition stream :simple t))))
+
+;;; base REPORTing of a READER-ERROR
+;;;
+;;; When SIMPLE, we expect and use SIMPLE-CONDITION-ish FORMAT-CONTROL
+;;; and FORMAT-ARGS slots.
+(defun %report-reader-error (condition stream &key simple)
+  (let* ((error-stream (stream-error-stream condition))
+         (pos (file-position-or-nil-for-error error-stream)))
+    (let (lineno colno)
+      (when (and pos
+                 (< pos sb!xc:array-dimension-limit)
+                 ;; KLUDGE: lseek() (which is what FILE-POSITION
+                 ;; reduces to on file-streams) is undefined on
+                 ;; "some devices", which in practice means that it
+                 ;; can claim to succeed on /dev/stdin on Darwin
+                 ;; and Solaris.  This is obviously bad news,
+                 ;; because the READ-SEQUENCE below will then
+                 ;; block, not complete, and the report will never
+                 ;; be printed.  As a workaround, we exclude
+                 ;; interactive streams from this attempt to report
+                 ;; positions.  -- CSR, 2003-08-21
+                 (not (interactive-stream-p error-stream))
+                 (file-position error-stream :start))
+        (let ((string
+               (make-string pos
+                            :element-type (stream-element-type
+                                           error-stream))))
+          (when (= pos (read-sequence string error-stream))
+            (setq lineno (1+ (count #\Newline string))
+                  colno (- pos
+                           (or (position #\Newline string :from-end t) -1)
+                           1))))
+        (file-position-or-nil-for-error error-stream pos))
+      (pprint-logical-block (stream nil)
+        (format stream
+                "~S ~@[at ~W ~]~
                     ~@[(line ~W~]~@[, column ~W) ~]~
-                    on ~S:~2I~_~?"
-                   pos lineno colno error-stream
-                   (reader-error-format-control condition)
-                   (reader-error-format-arguments condition))))))))
+                    on ~S"
+                (class-name (class-of condition))
+                pos lineno colno error-stream)
+        (when simple
+          (format stream ":~2I~_~?"
+                  (simple-condition-format-control condition)
+                  (simple-condition-format-arguments condition)))))))
 \f
 ;;;; special SBCL extension conditions
 
               <http://sbcl.sourceforge.net/>.~:@>"
              '((fmakunbound 'compile))))))
 
-(define-condition simple-storage-condition (storage-condition simple-condition) ())
+(define-condition simple-storage-condition (storage-condition simple-condition)
+  ())
 
 ;;; a condition for use in stubs for operations which aren't supported
 ;;; on some platforms
 ;;; unFBOUNDPness meant they were running on an system which didn't
 ;;; support the extension.)
 (define-condition unsupported-operator (simple-error) ())
-
 \f
 ;;; (:ansi-cl :function remove)
 ;;; (:ansi-cl :section (a b c))
           (unless (null (cdr rs))
             (terpri s)))))))
 
+(define-condition simple-reference-error (reference-condition simple-error)
+  ())
+
 (define-condition duplicate-definition (reference-condition warning)
   ((name :initarg :name :reader duplicate-definition-name))
   (:report (lambda (c s)
     (format-args-mismatch simple-style-warning)
   ())
 
+(define-condition implicit-generic-function-warning (style-warning)
+  ((name :initarg :name :reader implicit-generic-function-name))
+  (:report
+   (lambda (condition stream)
+     (format stream "~@<Implicitly creating new generic function ~S.~:@>"
+             (implicit-generic-function-name condition)))))
+
 (define-condition extension-failure (reference-condition simple-error)
   ())
 
@@ -1126,7 +1154,7 @@ SB-EXT:PACKAGE-LOCKED-ERROR-SYMBOL."))
 
 (define-condition simple-package-error (simple-condition package-error) ())
 
-(define-condition reader-package-error (reader-error) ())
+(define-condition simple-reader-package-error (simple-reader-error) ())
 
 (define-condition reader-eof-error (end-of-file)
   ((context :reader reader-eof-error-context :initarg :context))
@@ -1137,15 +1165,16 @@ SB-EXT:PACKAGE-LOCKED-ERROR-SYMBOL."))
              (stream-error-stream condition)
              (reader-eof-error-context condition)))))
 
-(define-condition reader-impossible-number-error (reader-error)
+(define-condition reader-impossible-number-error (simple-reader-error)
   ((error :reader reader-impossible-number-error-error :initarg :error))
   (:report
    (lambda (condition stream)
      (let ((error-stream (stream-error-stream condition)))
-       (format stream "READER-ERROR ~@[at ~W ~]on ~S:~%~?~%Original error: ~A"
+       (format stream
+               "READER-ERROR ~@[at ~W ~]on ~S:~%~?~%Original error: ~A"
                (file-position-or-nil-for-error error-stream) error-stream
-               (reader-error-format-control condition)
-               (reader-error-format-arguments condition)
+               (simple-condition-format-control condition)
+               (simple-condition-format-arguments condition)
                (reader-impossible-number-error-error condition))))))
 
 (define-condition timeout (serious-condition)
@@ -1244,7 +1273,306 @@ the values returned by the form as a list. No associated restarts."))
      (format stream "Returning from STEP")))
   #!+sb-doc
   (:documentation "Condition signaled when STEP returns."))
+\f
+;;; A knob for muffling warnings, mostly for use while loading files.
+(defvar *muffled-warnings* 'uninteresting-redefinition
+  "A type that ought to specify a subtype of WARNING.  Whenever a warning
+is signaled, if the warning if of this type, it will be muffled.")
+\f
+;;; Various STYLE-WARNING signaled in the system.
+;; For the moment, we're only getting into the details for function
+;; redefinitions, but other redefinitions could be done later
+;; (e.g. methods).
+(define-condition redefinition-warning (style-warning)
+  ())
+
+(define-condition function-redefinition-warning (redefinition-warning)
+  ((name :initarg :name :reader function-redefinition-warning-name)
+   (old :initarg :old :reader function-redefinition-warning-old-fdefinition)
+   ;; For DEFGENERIC and perhaps others, the redefinition
+   ;; destructively modifies the original, rather than storing a new
+   ;; object, so there's no NEW here, but only in subclasses.
+   ))
+
+(define-condition redefinition-with-defun (function-redefinition-warning)
+  ((new :initarg :new :reader redefinition-with-defun-new-fdefinition)
+   ;; KLUDGE: it would be nice to fix the unreasonably late
+   ;; back-patching of DEBUG-SOURCEs in the DEBUG-INFO during
+   ;; fasloading and just use the new fdefinition, but for the moment
+   ;; we'll compare the SOURCE-LOCATION created during DEFUN with the
+   ;; previous DEBUG-SOURCE.
+   (new-location :initarg :new-location
+              :reader redefinition-with-defun-new-location))
+  (:report (lambda (warning stream)
+             (format stream "redefining ~S in DEFUN"
+                     (function-redefinition-warning-name warning)))))
+
+(define-condition redefinition-with-defgeneric (function-redefinition-warning)
+  ((new-location :initarg :new-location
+                 :reader redefinition-with-defgeneric-new-location))
+  (:report (lambda (warning stream)
+             (format stream "redefining ~S in DEFGENERIC"
+                     (function-redefinition-warning-name warning)))))
+
+(define-condition redefinition-with-defmethod (redefinition-warning)
+  ((gf :initarg :generic-function
+       :reader redefinition-with-defmethod-generic-function)
+   (qualifiers :initarg :qualifiers
+               :reader redefinition-with-defmethod-qualifiers)
+   (specializers :initarg :specializers
+                 :reader redefinition-with-defmethod-specializers)
+   (new-location :initarg :new-location
+                 :reader redefinition-with-defmethod-new-location)
+   (old-method :initarg :old-method
+               :reader redefinition-with-defmethod-old-method))
+  (:report (lambda (warning stream)
+             (format stream "redefining ~S~{ ~S~} ~S in DEFMETHOD"
+                     (redefinition-with-defmethod-generic-function warning)
+                     (redefinition-with-defmethod-qualifiers warning)
+                     (redefinition-with-defmethod-specializers warning)))))
+
+;; FIXME: see the FIXMEs in defmacro.lisp, then maybe instantiate this.
+(define-condition redefinition-with-defmacro (function-redefinition-warning)
+  ())
+
+;; Here are a few predicates for what people might find interesting
+;; about redefinitions.
+
+;; DEFUN can replace a generic function with an ordinary function.
+;; (Attempting to replace an ordinary function with a generic one
+;; causes an error, though.)
+(defun redefinition-replaces-generic-function-p (warning)
+  (and (typep warning 'redefinition-with-defun)
+       (typep (function-redefinition-warning-old-fdefinition warning)
+              'generic-function)))
+
+(defun redefinition-replaces-compiled-function-with-interpreted-p (warning)
+  (and (typep warning 'redefinition-with-defun)
+       (compiled-function-p
+        (function-redefinition-warning-old-fdefinition warning))
+       (not (compiled-function-p
+             (redefinition-with-defun-new-fdefinition warning)))))
+
+;; Most people seem to agree that re-running a DEFUN in a file is
+;; completely uninteresting.
+(defun uninteresting-ordinary-function-redefinition-p (warning)
+  ;; OAOO violation: this duplicates code in SB-INTROSPECT.
+  ;; Additionally, there are some functions that aren't
+  ;; funcallable-instances for which finding the source location is
+  ;; complicated (e.g. DEFSTRUCT-defined predicates and accessors),
+  ;; but I don't think they're defined with %DEFUN, so the warning
+  ;; isn't raised.
+  (flet ((fdefinition-file-namestring (fdefn)
+           #!+sb-eval
+           (when (typep fdefn 'sb!eval:interpreted-function)
+             (return-from fdefinition-file-namestring
+               (sb!c:definition-source-location-namestring
+                   (sb!eval:interpreted-function-source-location fdefn))))
+           ;; All the following accesses are guarded with conditionals
+           ;; because it's not clear whether any of the slots we're
+           ;; chasing down are guaranteed to be filled in.
+           (let* ((fdefn
+                   ;; KLUDGE: although this looks like it only works
+                   ;; for %SIMPLE-FUNs, in fact there's a pun such
+                   ;; that %SIMPLE-FUN-SELF returns the simple-fun
+                   ;; object for closures and
+                   ;; funcallable-instances. -- CSR, circa 2005
+                   (sb!kernel:%simple-fun-self fdefn))
+                  (code (if fdefn (sb!kernel:fun-code-header fdefn)))
+                  (debug-info (if code (sb!kernel:%code-debug-info code)))
+                  (debug-source (if debug-info
+                                    (sb!c::debug-info-source debug-info)))
+                  (namestring (if debug-source
+                                  (sb!c::debug-source-namestring debug-source))))
+             namestring)))
+    (and
+     ;; There's garbage in various places when the first DEFUN runs in
+     ;; cold-init.
+     sb!kernel::*cold-init-complete-p*
+     (typep warning 'redefinition-with-defun)
+     (let ((old-fdefn
+            (function-redefinition-warning-old-fdefinition warning))
+           (new-fdefn
+            (redefinition-with-defun-new-fdefinition warning)))
+       ;; Replacing a compiled function with a compiled function is
+       ;; clearly uninteresting, and we'll say arbitrarily that
+       ;; replacing an interpreted function with an interpreted
+       ;; function is uninteresting, too, but leave out the
+       ;; compiled-to-interpreted and interpreted-to-compiled cases.
+       (when (or (and (typep old-fdefn
+                             '(or #!+sb-eval sb!eval:interpreted-function))
+                      (typep new-fdefn
+                             '(or #!+sb-eval sb!eval:interpreted-function)))
+                 (and (typep old-fdefn
+                             '(and compiled-function
+                               (not funcallable-instance)))
+                      ;; Since this is a REDEFINITION-WITH-DEFUN,
+                      ;; NEW-FDEFN can't be a FUNCALLABLE-INSTANCE.
+                      (typep new-fdefn 'compiled-function)))
+         (let* ((old-namestring (fdefinition-file-namestring old-fdefn))
+                (new-namestring
+                 (or (fdefinition-file-namestring new-fdefn)
+                     (let ((srcloc
+                            (redefinition-with-defun-new-location warning)))
+                       (if srcloc
+                            (sb!c::definition-source-location-namestring
+                                srcloc))))))
+           (and old-namestring
+                new-namestring
+                (equal old-namestring new-namestring))))))))
+
+(defun uninteresting-generic-function-redefinition-p (warning)
+  (and (typep warning 'redefinition-with-defgeneric)
+       (let* ((old-fdefn
+               (function-redefinition-warning-old-fdefinition warning))
+              (old-location
+               (if (typep old-fdefn 'generic-function)
+                   (sb!pcl::definition-source old-fdefn)))
+              (old-namestring
+               (if old-location
+                   (sb!c:definition-source-location-namestring old-location)))
+              (new-location
+               (redefinition-with-defgeneric-new-location warning))
+              (new-namestring
+               (if new-location
+                   (sb!c:definition-source-location-namestring new-location))))
+         (and old-namestring
+              new-namestring
+              (equal old-namestring new-namestring)))))
+
+(defun uninteresting-method-redefinition-p (warning)
+  (and (typep warning 'redefinition-with-defmethod)
+       (let* ((old-method (redefinition-with-defmethod-old-method warning))
+              (old-location (sb!pcl::definition-source old-method))
+              (old-namestring (if old-location
+                                  (sb!c:definition-source-location-namestring
+                                      old-location)))
+              (new-location (redefinition-with-defmethod-new-location warning))
+              (new-namestring (if new-location
+                                  (sb!c:definition-source-location-namestring
+                                      new-location))))
+         (and new-namestring
+              old-namestring
+              (equal new-namestring old-namestring)))))
+
+(deftype uninteresting-redefinition ()
+  '(or (satisfies uninteresting-ordinary-function-redefinition-p)
+       (satisfies uninteresting-generic-function-redefinition-p)
+       (satisfies uninteresting-method-redefinition-p)))
+
+(define-condition redefinition-with-deftransform (redefinition-warning)
+  ((transform :initarg :transform
+              :reader redefinition-with-deftransform-transform))
+  (:report (lambda (warning stream)
+             (format stream "Overwriting ~S"
+                     (redefinition-with-deftransform-transform warning)))))
+\f
+;;; Various other STYLE-WARNINGS
+(define-condition ignoring-asterisks-in-variable-name
+    (style-warning simple-condition)
+  ()
+  (:report (lambda (warning stream)
+             (format stream "~@?, even though the name follows~@
+the usual naming convention (names like *FOO*) for special variables"
+                     (simple-condition-format-control warning)
+                     (simple-condition-format-arguments warning)))))
+
+(define-condition ignoring-asterisks-in-lexical-variable-name
+    (ignoring-asterisks-in-variable-name)
+  ())
 
+(define-condition ignoring-asterisks-in-constant-variable-name
+    (ignoring-asterisks-in-variable-name)
+  ())
+
+(define-condition undefined-alien (style-warning)
+  ((symbol :initarg :symbol :reader undefined-alien-symbol))
+  (:report (lambda (warning stream)
+             (format stream "Undefined alien: ~S"
+                     (undefined-alien-symbol warning)))))
+
+#!+sb-eval
+(define-condition lexical-environment-too-complex (style-warning)
+  ((form :initarg :form :reader lexical-environment-too-complex-form)
+   (lexenv :initarg :lexenv :reader lexical-environment-too-complex-lexenv))
+  (:report (lambda (warning stream)
+             (format stream
+                     "~@<Native lexical environment too complex for ~
+                         SB-EVAL to evaluate ~S, falling back to ~
+                         SIMPLE-EVAL-IN-LEXENV.  Lexenv: ~S~:@>"
+                     (lexical-environment-too-complex-form warning)
+                     (lexical-environment-too-complex-lexenv warning)))))
+
+;; Although this has -ERROR- in the name, it's just a STYLE-WARNING.
+(define-condition character-decoding-error-in-comment (style-warning)
+  ((stream :initarg :stream :reader decoding-error-in-comment-stream)
+   (position :initarg :position :reader decoding-error-in-comment-position))
+  (:report (lambda (warning stream)
+             (format stream
+                      "Character decoding error in a ~A-comment at ~
+                      position ~A reading source stream ~A, ~
+                      resyncing."
+                      (decoding-error-in-comment-macro warning)
+                      (decoding-error-in-comment-position warning)
+                      (decoding-error-in-comment-stream warning)))))
+
+(define-condition character-decoding-error-in-macro-char-comment
+    (character-decoding-error-in-comment)
+  ((char :initform #\; :initarg :char
+         :reader character-decoding-error-in-macro-char-comment-char)))
+
+(define-condition character-decoding-error-in-dispatch-macro-char-comment
+    (character-decoding-error-in-comment)
+  ;; ANSI doesn't give a way for a reader function invoked by a
+  ;; dispatch macro character to determine which dispatch character
+  ;; was used, so if a user wants to signal one of these from a custom
+  ;; comment reader, he'll have to supply the :DISP-CHAR himself.
+  ((disp-char :initform #\# :initarg :disp-char
+              :reader character-decoding-error-in-macro-char-comment-disp-char)
+   (sub-char :initarg :sub-char
+             :reader character-decoding-error-in-macro-char-comment-sub-char)))
+
+(defun decoding-error-in-comment-macro (warning)
+  (etypecase warning
+    (character-decoding-error-in-macro-char-comment
+     (character-decoding-error-in-macro-char-comment-char warning))
+    (character-decoding-error-in-dispatch-macro-char-comment
+     (format
+      nil "~C~C"
+      (character-decoding-error-in-macro-char-comment-disp-char warning)
+      (character-decoding-error-in-macro-char-comment-sub-char warning)))))
+
+(define-condition deprecated-eval-when-situations (style-warning)
+  ((situations :initarg :situations
+               :reader deprecated-eval-when-situations-situations))
+  (:report (lambda (warning stream)
+             (format stream "using deprecated EVAL-WHEN situation names~{ ~S~}"
+                     (deprecated-eval-when-situations-situations warning)))))
+
+(define-condition proclamation-mismatch (style-warning)
+  ((name :initarg :name :reader proclamation-mismatch-name)
+   (old :initarg :old :reader proclamation-mismatch-old)
+   (new :initarg :new :reader proclamation-mismatch-new)))
+
+(define-condition type-proclamation-mismatch (proclamation-mismatch)
+  ()
+  (:report (lambda (warning stream)
+             (format stream
+                     "The new TYPE proclamation~% ~S for ~S does not ~
+                     match the old TYPE proclamation ~S"
+                     (proclamation-mismatch-new warning)
+                     (proclamation-mismatch-name warning)
+                     (proclamation-mismatch-old warning)))))
+
+(define-condition ftype-proclamation-mismatch (proclamation-mismatch)
+  ()
+  (:report (lambda (warning stream)
+             (format stream
+                     "The new FTYPE proclamation~% ~S for ~S does not ~
+                     match the old FTYPE proclamation ~S"
+                     (proclamation-mismatch-new warning)
+                     (proclamation-mismatch-name warning)
+                     (proclamation-mismatch-old warning)))))
 \f
 ;;;; restart definitions
 
@@ -1268,15 +1596,16 @@ the values returned by the form as a list. No associated restarts."))
    CONTROL-ERROR if none exists."
   (invoke-restart (find-restart-or-control-error 'muffle-warning condition)))
 
+(defun try-restart (name condition &rest arguments)
+  (let ((restart (find-restart name condition)))
+    (when restart
+      (apply #'invoke-restart restart arguments))))
+
 (macrolet ((define-nil-returning-restart (name args doc)
              #!-sb-doc (declare (ignore doc))
              `(defun ,name (,@args &optional condition)
                 #!+sb-doc ,doc
-                ;; FIXME: Perhaps this shared logic should be pulled out into
-                ;; FLET MAYBE-INVOKE-RESTART? See whether it shrinks code..
-                (let ((restart (find-restart ',name condition)))
-                  (when restart
-                    (invoke-restart restart ,@args))))))
+                (try-restart ',name condition ,@args))))
   (define-nil-returning-restart continue ()
     "Transfer control to a restart named CONTINUE, or return NIL if none exists.")
   (define-nil-returning-restart store-value (value)