src/code/condition.lisp

   1 ;;;; stuff originally from CMU CL's error.lisp which can or should
   2 ;;;; come late (mostly related to the CONDITION class itself)
   3 ;;;;
   4
   5 ;;;; This software is part of the SBCL system. See the README file for
   6 ;;;; more information.
   7 ;;;;
   8 ;;;; This software is derived from the CMU CL system, which was
   9 ;;;; written at Carnegie Mellon University and released into the
  10 ;;;; public domain. The software is in the public domain and is
  11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  12 ;;;; files for more information.
  13
  14 (in-package "SB!KERNEL")
  15 \f
  16 ;;;; miscellaneous support utilities
  17
  18 ;;; Signalling an error when trying to print an error condition is
  19 ;;; generally a PITA, so whatever the failure encountered when
  20 ;;; wondering about FILE-POSITION within a condition printer, 'tis
  21 ;;; better silently to give up than to try to complain.
  22 (defun file-position-or-nil-for-error (stream &optional (pos nil posp))
  23   ;; Arguably FILE-POSITION shouldn't be signalling errors at all; but
  24   ;; "NIL if this cannot be determined" in the ANSI spec doesn't seem
  25   ;; absolutely unambiguously to prohibit errors when, e.g., STREAM
  26   ;; has been closed so that FILE-POSITION is a nonsense question. So
  27   ;; my (WHN) impression is that the conservative approach is to
  28   ;; IGNORE-ERRORS. (I encountered this failure from within a homebrew
  29   ;; defsystemish operation where the ERROR-STREAM had been CL:CLOSEd,
  30   ;; I think by nonlocally exiting through a WITH-OPEN-FILE, by the
  31   ;; time an error was reported.)
  32   (if posp
  33       (ignore-errors (file-position stream pos))
  34       (ignore-errors (file-position stream))))
  35 \f
  36 ;;;; the CONDITION class
  37
  38 (/show0 "condition.lisp 20")
  39
  40 (eval-when (:compile-toplevel :load-toplevel :execute)
  41
  42 (/show0 "condition.lisp 24")
  43
  44 (def!struct (condition-classoid (:include classoid)
  45                                 (:constructor make-condition-classoid))
  46   ;; list of CONDITION-SLOT structures for the direct slots of this
  47   ;; class
  48   (slots nil :type list)
  49   ;; list of CONDITION-SLOT structures for all of the effective class
  50   ;; slots of this class
  51   (class-slots nil :type list)
  52   ;; report function or NIL
  53   (report nil :type (or function null))
  54   ;; list of alternating initargs and initforms
  55   (default-initargs () :type list)
  56   ;; class precedence list as a list of CLASS objects, with all
  57   ;; non-CONDITION classes removed
  58   (cpl () :type list)
  59   ;; a list of all the effective instance allocation slots of this
  60   ;; class that have a non-constant initform or default-initarg.
  61   ;; Values for these slots must be computed in the dynamic
  62   ;; environment of MAKE-CONDITION.
  63   (hairy-slots nil :type list))
  64
  65 (/show0 "condition.lisp 49")
  66
  67 ) ; EVAL-WHEN
  68
  69 (!defstruct-with-alternate-metaclass condition
  70   :slot-names (actual-initargs assigned-slots)
  71   :boa-constructor %make-condition-object
  72   :superclass-name t
  73   :metaclass-name condition-classoid
  74   :metaclass-constructor make-condition-classoid
  75   :dd-type structure)
  76
  77 (defun make-condition-object (actual-initargs)
  78   (%make-condition-object actual-initargs nil))
  79
  80 (defstruct (condition-slot (:copier nil))
  81   (name (missing-arg) :type symbol)
  82   ;; list of all applicable initargs
  83   (initargs (missing-arg) :type list)
  84   ;; names of reader and writer functions
  85   (readers (missing-arg) :type list)
  86   (writers (missing-arg) :type list)
  87   ;; true if :INITFORM was specified
  88   (initform-p (missing-arg) :type (member t nil))
  89   ;; If this is a function, call it with no args. Otherwise, it's the
  90   ;; actual value.
  91   (initform (missing-arg) :type t)
  92   ;; allocation of this slot, or NIL until defaulted
  93   (allocation nil :type (member :instance :class nil))
  94   ;; If ALLOCATION is :CLASS, this is a cons whose car holds the value.
  95   (cell nil :type (or cons null))
  96   ;; slot documentation
  97   (documentation nil :type (or string null)))
  98
  99 ;;; KLUDGE: It's not clear to me why CONDITION-CLASS has itself listed
 100 ;;; in its CPL, while other classes derived from CONDITION-CLASS don't
 101 ;;; have themselves listed in their CPLs. This behavior is inherited
 102 ;;; from CMU CL, and didn't seem to be explained there, and I haven't
 103 ;;; figured out whether it's right. -- WHN 19990612
 104 (eval-when (:compile-toplevel :load-toplevel :execute)
 105   (/show0 "condition.lisp 103")
 106   (let ((condition-class (locally
 107                            ;; KLUDGE: There's a DEFTRANSFORM
 108                            ;; FIND-CLASSOID for constant class names
 109                            ;; which creates fast but
 110                            ;; non-cold-loadable, non-compact code. In
 111                            ;; this context, we'd rather have compact,
 112                            ;; cold-loadable code. -- WHN 19990928
 113                            (declare (notinline find-classoid))
 114                            (find-classoid 'condition))))
 115     (setf (condition-classoid-cpl condition-class)
 116           (list condition-class)))
 117   (/show0 "condition.lisp 103"))
 118
 119 (setf (condition-classoid-report (locally
 120                                    ;; KLUDGE: There's a DEFTRANSFORM
 121                                    ;; FIND-CLASSOID for constant class
 122                                    ;; names which creates fast but
 123                                    ;; non-cold-loadable, non-compact
 124                                    ;; code. In this context, we'd
 125                                    ;; rather have compact,
 126                                    ;; cold-loadable code. -- WHN
 127                                    ;; 19990928
 128                                    (declare (notinline find-classoid))
 129                                    (find-classoid 'condition)))
 130       (lambda (cond stream)
 131         (format stream "Condition ~S was signalled." (type-of cond))))
 132
 133 (eval-when (:compile-toplevel :load-toplevel :execute)
 134
 135 (defun find-condition-layout (name parent-types)
 136   (let* ((cpl (remove-duplicates
 137                (reverse
 138                 (reduce #'append
 139                         (mapcar (lambda (x)
 140                                   (condition-classoid-cpl
 141                                    (find-classoid x)))
 142                                 parent-types)))))
 143          (cond-layout (info :type :compiler-layout 'condition))
 144          (olayout (info :type :compiler-layout name))
 145          ;; FIXME: Does this do the right thing in case of multiple
 146          ;; inheritance? A quick look at DEFINE-CONDITION didn't make
 147          ;; it obvious what ANSI intends to be done in the case of
 148          ;; multiple inheritance, so it's not actually clear what the
 149          ;; right thing is..
 150          (new-inherits
 151           (order-layout-inherits (concatenate 'simple-vector
 152                                               (layout-inherits cond-layout)
 153                                               (mapcar #'classoid-layout cpl)))))
 154     (if (and olayout
 155              (not (mismatch (layout-inherits olayout) new-inherits)))
 156         olayout
 157         (make-layout :classoid (make-undefined-classoid name)
 158                      :inherits new-inherits
 159                      :depthoid -1
 160                      :length (layout-length cond-layout)))))
 161
 162 ) ; EVAL-WHEN
 163
 164 ;;; FIXME: ANSI's definition of DEFINE-CONDITION says
 165 ;;;   Condition reporting is mediated through the PRINT-OBJECT method
 166 ;;;   for the condition type in question, with *PRINT-ESCAPE* always
 167 ;;;   being nil. Specifying (:REPORT REPORT-NAME) in the definition of
 168 ;;;   a condition type C is equivalent to:
 169 ;;;     (defmethod print-object ((x c) stream)
 170 ;;;       (if *print-escape* (call-next-method) (report-name x stream)))
 171 ;;; The current code doesn't seem to quite match that.
 172 (def!method print-object ((x condition) stream)
 173   (if *print-escape*
 174       (print-unreadable-object (x stream :type t :identity t))
 175       ;; KLUDGE: A comment from CMU CL here said
 176       ;;   7/13/98 BUG? CPL is not sorted and results here depend on order of
 177       ;;   superclasses in define-condition call!
 178       (dolist (class (condition-classoid-cpl (classoid-of x))
 179                      (error "no REPORT? shouldn't happen!"))
 180         (let ((report (condition-classoid-report class)))
 181           (when report
 182             (return (funcall report x stream)))))))
 183 \f
 184 ;;;; slots of CONDITION objects
 185
 186 (defvar *empty-condition-slot* '(empty))
 187
 188 (defun find-slot-default (class slot)
 189   (let ((initargs (condition-slot-initargs slot))
 190         (cpl (condition-classoid-cpl class)))
 191     (dolist (class cpl)
 192       (let ((default-initargs (condition-classoid-default-initargs class)))
 193         (dolist (initarg initargs)
 194           (let ((val (getf default-initargs initarg *empty-condition-slot*)))
 195             (unless (eq val *empty-condition-slot*)
 196               (return-from find-slot-default
 197                            (if (functionp val)
 198                                (funcall val)
 199                                val)))))))
 200
 201     (if (condition-slot-initform-p slot)
 202         (let ((initform (condition-slot-initform slot)))
 203           (if (functionp initform)
 204               (funcall initform)
 205               initform))
 206         (error "unbound condition slot: ~S" (condition-slot-name slot)))))
 207
 208 (defun find-condition-class-slot (condition-class slot-name)
 209   (dolist (sclass
 210            (condition-classoid-cpl condition-class)
 211            (error "There is no slot named ~S in ~S."
 212                   slot-name condition-class))
 213     (dolist (slot (condition-classoid-slots sclass))
 214       (when (eq (condition-slot-name slot) slot-name)
 215         (return-from find-condition-class-slot slot)))))
 216
 217 (defun condition-writer-function (condition new-value name)
 218   (dolist (cslot (condition-classoid-class-slots
 219                   (layout-classoid (%instance-layout condition)))
 220                  (setf (getf (condition-assigned-slots condition) name)
 221                        new-value))
 222     (when (eq (condition-slot-name cslot) name)
 223       (return (setf (car (condition-slot-cell cslot)) new-value)))))
 224
 225 (defun condition-reader-function (condition name)
 226   (let ((class (layout-classoid (%instance-layout condition))))
 227     (dolist (cslot (condition-classoid-class-slots class))
 228       (when (eq (condition-slot-name cslot) name)
 229         (return-from condition-reader-function
 230                      (car (condition-slot-cell cslot)))))
 231     (let ((val (getf (condition-assigned-slots condition) name
 232                      *empty-condition-slot*)))
 233       (if (eq val *empty-condition-slot*)
 234           (let ((actual-initargs (condition-actual-initargs condition))
 235                 (slot (find-condition-class-slot class name)))
 236             (unless slot
 237               (error "missing slot ~S of ~S" name condition))
 238             (do ((initargs actual-initargs (cddr initargs)))
 239                 ((endp initargs)
 240                  (setf (getf (condition-assigned-slots condition) name)
 241                        (find-slot-default class slot)))
 242               (when (member (car initargs) (condition-slot-initargs slot))
 243                 (return-from condition-reader-function
 244                   (setf (getf (condition-assigned-slots condition)
 245                               name)
 246                         (cadr initargs))))))
 247           val))))
 248 \f
 249 ;;;; MAKE-CONDITION
 250
 251 (defun make-condition (type &rest args)
 252   #!+sb-doc
 253   "Make an instance of a condition object using the specified initargs."
 254   ;; Note: ANSI specifies no exceptional situations in this function.
 255   ;; signalling simple-type-error would not be wrong.
 256   (let* ((type (or (and (symbolp type) (find-classoid type nil))
 257                     type))
 258          (class (typecase type
 259                   (condition-classoid type)
 260                   (class
 261                    ;; Punt to CLOS.
 262                    (return-from make-condition (apply #'make-instance type args)))
 263                   (classoid
 264                    (error 'simple-type-error
 265                           :datum type
 266                           :expected-type 'condition-class
 267                           :format-control "~S is not a condition class."
 268                           :format-arguments (list type)))
 269                   (t
 270                    (error 'simple-type-error
 271                           :datum type
 272                           :expected-type 'condition-class
 273                           :format-control "Bad type argument:~%  ~S"
 274                           :format-arguments (list type)))))
 275          (res (make-condition-object args)))
 276     (setf (%instance-layout res) (classoid-layout class))
 277     ;; Set any class slots with initargs present in this call.
 278     (dolist (cslot (condition-classoid-class-slots class))
 279       (dolist (initarg (condition-slot-initargs cslot))
 280         (let ((val (getf args initarg *empty-condition-slot*)))
 281           (unless (eq val *empty-condition-slot*)
 282             (setf (car (condition-slot-cell cslot)) val)))))
 283     ;; Default any slots with non-constant defaults now.
 284     (dolist (hslot (condition-classoid-hairy-slots class))
 285       (when (dolist (initarg (condition-slot-initargs hslot) t)
 286               (unless (eq (getf args initarg *empty-condition-slot*)
 287                           *empty-condition-slot*)
 288                 (return nil)))
 289         (setf (getf (condition-assigned-slots res) (condition-slot-name hslot))
 290               (find-slot-default class hslot))))
 291     res))
 292 \f
 293 ;;;; DEFINE-CONDITION
 294
 295 (eval-when (:compile-toplevel :load-toplevel :execute)
 296 (defun %compiler-define-condition (name direct-supers layout
 297                                    all-readers all-writers)
 298   (with-single-package-locked-error
 299       (:symbol name "defining ~A as a condition")
 300     (sb!xc:proclaim `(ftype (function (t) t) ,@all-readers))
 301     (sb!xc:proclaim `(ftype (function (t t) t) ,@all-writers))
 302     (multiple-value-bind (class old-layout)
 303         (insured-find-classoid name
 304                                #'condition-classoid-p
 305                                #'make-condition-classoid)
 306       (setf (layout-classoid layout) class)
 307       (setf (classoid-direct-superclasses class)
 308             (mapcar #'find-classoid direct-supers))
 309       (cond ((not old-layout)
 310              (register-layout layout))
 311             ((not *type-system-initialized*)
 312              (setf (layout-classoid old-layout) class)
 313              (setq layout old-layout)
 314              (unless (eq (classoid-layout class) layout)
 315                (register-layout layout)))
 316             ((redefine-layout-warning "current"
 317                                       old-layout
 318                                       "new"
 319                                       (layout-length layout)
 320                                       (layout-inherits layout)
 321                                       (layout-depthoid layout)
 322                                       (layout-n-untagged-slots layout))
 323              (register-layout layout :invalidate t))
 324             ((not (classoid-layout class))
 325              (register-layout layout)))
 326
 327       (setf (layout-info layout)
 328             (locally
 329                 ;; KLUDGE: There's a FIND-CLASS DEFTRANSFORM for constant class
 330                 ;; names which creates fast but non-cold-loadable, non-compact
 331                 ;; code. In this context, we'd rather have compact, cold-loadable
 332                 ;; code. -- WHN 19990928
 333                 (declare (notinline find-classoid))
 334               (layout-info (classoid-layout (find-classoid 'condition)))))
 335
 336       (setf (find-classoid name) class)
 337
 338       ;; Initialize CPL slot.
 339       (setf (condition-classoid-cpl class)
 340             (remove-if-not #'condition-classoid-p
 341                            (std-compute-class-precedence-list class)))))
 342   (values))
 343 ) ; EVAL-WHEN
 344
 345 ;;; Compute the effective slots of CLASS, copying inherited slots and
 346 ;;; destructively modifying direct slots.
 347 ;;;
 348 ;;; FIXME: It'd be nice to explain why it's OK to destructively modify
 349 ;;; direct slots. Presumably it follows from the semantics of
 350 ;;; inheritance and redefinition of conditions, but finding the cite
 351 ;;; and documenting it here would be good. (Or, if this is not in fact
 352 ;;; ANSI-compliant, fixing it would also be good.:-)
 353 (defun compute-effective-slots (class)
 354   (collect ((res (copy-list (condition-classoid-slots class))))
 355     (dolist (sclass (cdr (condition-classoid-cpl class)))
 356       (dolist (sslot (condition-classoid-slots sclass))
 357         (let ((found (find (condition-slot-name sslot) (res)
 358                            :key #'condition-slot-name)))
 359           (cond (found
 360                  (setf (condition-slot-initargs found)
 361                        (union (condition-slot-initargs found)
 362                               (condition-slot-initargs sslot)))
 363                  (unless (condition-slot-initform-p found)
 364                    (setf (condition-slot-initform-p found)
 365                          (condition-slot-initform-p sslot))
 366                    (setf (condition-slot-initform found)
 367                          (condition-slot-initform sslot)))
 368                  (unless (condition-slot-allocation found)
 369                    (setf (condition-slot-allocation found)
 370                          (condition-slot-allocation sslot))))
 371                 (t
 372                  (res (copy-structure sslot)))))))
 373     (res)))
 374
 375 ;;; Early definitions of slot accessor creators.
 376 ;;;
 377 ;;; Slot accessors must be generic functions, but ANSI does not seem
 378 ;;; to specify any of them, and we cannot support it before end of
 379 ;;; warm init. So we use ordinary functions inside SBCL, and switch to
 380 ;;; GFs only at the end of building.
 381 (declaim (notinline install-condition-slot-reader
 382                     install-condition-slot-writer))
 383 (defun install-condition-slot-reader (name condition slot-name)
 384   (declare (ignore condition))
 385   (setf (fdefinition name)
 386         (lambda (condition)
 387           (condition-reader-function condition slot-name))))
 388 (defun install-condition-slot-writer (name condition slot-name)
 389   (declare (ignore condition))
 390   (setf (fdefinition name)
 391         (lambda (new-value condition)
 392           (condition-writer-function condition new-value slot-name))))
 393
 394 (defvar *define-condition-hooks* nil)
 395
 396 (defun %define-condition (name parent-types layout slots documentation
 397                           report default-initargs all-readers all-writers
 398                           source-location)
 399   (with-single-package-locked-error
 400       (:symbol name "defining ~A as a condition")
 401     (%compiler-define-condition name parent-types layout all-readers all-writers)
 402     (sb!c:with-source-location (source-location)
 403       (setf (layout-source-location layout)
 404             source-location))
 405     (let ((class (find-classoid name)))
 406       (setf (condition-classoid-slots class) slots)
 407       (setf (condition-classoid-report class) report)
 408       (setf (condition-classoid-default-initargs class) default-initargs)
 409       (setf (fdocumentation name 'type) documentation)
 410
 411       (dolist (slot slots)
 412
 413         ;; Set up reader and writer functions.
 414         (let ((slot-name (condition-slot-name slot)))
 415           (dolist (reader (condition-slot-readers slot))
 416             (install-condition-slot-reader reader name slot-name))
 417           (dolist (writer (condition-slot-writers slot))
 418             (install-condition-slot-writer writer name slot-name))))
 419
 420       ;; Compute effective slots and set up the class and hairy slots
 421       ;; (subsets of the effective slots.)
 422       (let ((eslots (compute-effective-slots class))
 423             (e-def-initargs
 424              (reduce #'append
 425                      (mapcar #'condition-classoid-default-initargs
 426                            (condition-classoid-cpl class)))))
 427         (dolist (slot eslots)
 428           (ecase (condition-slot-allocation slot)
 429             (:class
 430              (unless (condition-slot-cell slot)
 431                (setf (condition-slot-cell slot)
 432                      (list (if (condition-slot-initform-p slot)
 433                                (let ((initform (condition-slot-initform slot)))
 434                                  (if (functionp initform)
 435                                      (funcall initform)
 436                                      initform))
 437                                *empty-condition-slot*))))
 438              (push slot (condition-classoid-class-slots class)))
 439             ((:instance nil)
 440              (setf (condition-slot-allocation slot) :instance)
 441              (when (or (functionp (condition-slot-initform slot))
 442                        (dolist (initarg (condition-slot-initargs slot) nil)
 443                          (when (functionp (getf e-def-initargs initarg))
 444                            (return t))))
 445                (push slot (condition-classoid-hairy-slots class)))))))
 446       (when (boundp '*define-condition-hooks*)
 447         (dolist (fun *define-condition-hooks*)
 448           (funcall fun class))))
 449     name))
 450
 451 (defmacro define-condition (name (&rest parent-types) (&rest slot-specs)
 452                                  &body options)
 453   #!+sb-doc
 454   "DEFINE-CONDITION Name (Parent-Type*) (Slot-Spec*) Option*
 455    Define NAME as a condition type. This new type inherits slots and its
 456    report function from the specified PARENT-TYPEs. A slot spec is a list of:
 457      (slot-name :reader <rname> :initarg <iname> {Option Value}*
 458
 459    The DEFINE-CLASS slot options :ALLOCATION, :INITFORM, [slot] :DOCUMENTATION
 460    and :TYPE and the overall options :DEFAULT-INITARGS and
 461    [type] :DOCUMENTATION are also allowed.
 462
 463    The :REPORT option is peculiar to DEFINE-CONDITION. Its argument is either
 464    a string or a two-argument lambda or function name. If a function, the
 465    function is called with the condition and stream to report the condition.
 466    If a string, the string is printed.
 467
 468    Condition types are classes, but (as allowed by ANSI and not as described in
 469    CLtL2) are neither STANDARD-OBJECTs nor STRUCTURE-OBJECTs. WITH-SLOTS and
 470    SLOT-VALUE may not be used on condition objects."
 471   (let* ((parent-types (or parent-types '(condition)))
 472          (layout (find-condition-layout name parent-types))
 473          (documentation nil)
 474          (report nil)
 475          (default-initargs ()))
 476     (collect ((slots)
 477               (all-readers nil append)
 478               (all-writers nil append))
 479       (dolist (spec slot-specs)
 480         (when (keywordp spec)
 481           (warn "Keyword slot name indicates probable syntax error:~%  ~S"
 482                 spec))
 483         (let* ((spec (if (consp spec) spec (list spec)))
 484                (slot-name (first spec))
 485                (allocation :instance)
 486                (initform-p nil)
 487                documentation
 488                initform)
 489           (collect ((initargs)
 490                     (readers)
 491                     (writers))
 492             (do ((options (rest spec) (cddr options)))
 493                 ((null options))
 494               (unless (and (consp options) (consp (cdr options)))
 495                 (error "malformed condition slot spec:~%  ~S." spec))
 496               (let ((arg (second options)))
 497                 (case (first options)
 498                   (:reader (readers arg))
 499                   (:writer (writers arg))
 500                   (:accessor
 501                    (readers arg)
 502                    (writers `(setf ,arg)))
 503                   (:initform
 504                    (when initform-p
 505                      (error "more than one :INITFORM in ~S" spec))
 506                    (setq initform-p t)
 507                    (setq initform arg))
 508                   (:initarg (initargs arg))
 509                   (:allocation
 510                    (setq allocation arg))
 511                   (:documentation
 512                    (when documentation
 513                      (error "more than one :DOCUMENTATION in ~S" spec))
 514                    (unless (stringp arg)
 515                      (error "slot :DOCUMENTATION argument is not a string: ~S"
 516                             arg))
 517                    (setq documentation arg))
 518                   (:type)
 519                   (t
 520                    (error "unknown slot option:~%  ~S" (first options))))))
 521
 522             (all-readers (readers))
 523             (all-writers (writers))
 524             (slots `(make-condition-slot
 525                      :name ',slot-name
 526                      :initargs ',(initargs)
 527                      :readers ',(readers)
 528                      :writers ',(writers)
 529                      :initform-p ',initform-p
 530                      :documentation ',documentation
 531                      :initform
 532                      ,(if (sb!xc:constantp initform)
 533                           `',(constant-form-value initform)
 534                           `#'(lambda () ,initform)))))))
 535
 536       (dolist (option options)
 537         (unless (consp option)
 538           (error "bad option:~%  ~S" option))
 539         (case (first option)
 540           (:documentation (setq documentation (second option)))
 541           (:report
 542            (let ((arg (second option)))
 543              (setq report
 544                    (if (stringp arg)
 545                        `#'(lambda (condition stream)
 546                           (declare (ignore condition))
 547                           (write-string ,arg stream))
 548                        `#'(lambda (condition stream)
 549                           (funcall #',arg condition stream))))))
 550           (:default-initargs
 551            (do ((initargs (rest option) (cddr initargs)))
 552                ((endp initargs))
 553              (let ((val (second initargs)))
 554                (setq default-initargs
 555                      (list* `',(first initargs)
 556                             (if (sb!xc:constantp val)
 557                                 `',(constant-form-value val)
 558                                 `#'(lambda () ,val))
 559                             default-initargs)))))
 560           (t
 561            (error "unknown option: ~S" (first option)))))
 562
 563       `(progn
 564          (eval-when (:compile-toplevel)
 565            (%compiler-define-condition ',name ',parent-types ',layout
 566                                        ',(all-readers) ',(all-writers)))
 567          (eval-when (:load-toplevel :execute)
 568            (%define-condition ',name
 569                               ',parent-types
 570                               ',layout
 571                               (list ,@(slots))
 572                               ,documentation
 573                               ,report
 574                               (list ,@default-initargs)
 575                               ',(all-readers)
 576                               ',(all-writers)
 577                               (sb!c:source-location)))))))
 578 \f
 579 ;;;; DESCRIBE on CONDITIONs
 580
 581 ;;; a function to be used as the guts of DESCRIBE-OBJECT (CONDITION T)
 582 ;;; eventually (once we get CLOS up and running so that we can define
 583 ;;; methods)
 584 (defun describe-condition (condition stream)
 585   (format stream
 586           "~&~@<~S ~_is a ~S. ~_Its slot values are ~_~S.~:>~%"
 587           condition
 588           (type-of condition)
 589           (concatenate 'list
 590                        (condition-actual-initargs condition)
 591                        (condition-assigned-slots condition))))
 592 \f
 593 ;;;; various CONDITIONs specified by ANSI
 594
 595 (define-condition serious-condition (condition) ())
 596
 597 (define-condition error (serious-condition) ())
 598
 599 (define-condition warning (condition) ())
 600 (define-condition style-warning (warning) ())
 601
 602 (defun simple-condition-printer (condition stream)
 603   (apply #'format
 604          stream
 605          (simple-condition-format-control condition)
 606          (simple-condition-format-arguments condition)))
 607
 608 (define-condition simple-condition ()
 609   ((format-control :reader simple-condition-format-control
 610                    :initarg :format-control
 611                    :type format-control)
 612    (format-arguments :reader simple-condition-format-arguments
 613                      :initarg :format-arguments
 614                      :initform '()
 615                      :type list))
 616   (:report simple-condition-printer))
 617
 618 (define-condition simple-warning (simple-condition warning) ())
 619
 620 (define-condition simple-error (simple-condition error) ())
 621
 622 (define-condition storage-condition (serious-condition) ())
 623
 624 (define-condition type-error (error)
 625   ((datum :reader type-error-datum :initarg :datum)
 626    (expected-type :reader type-error-expected-type :initarg :expected-type))
 627   (:report
 628    (lambda (condition stream)
 629      (format stream
 630              "~@<The value ~2I~:_~S ~I~_is not of type ~2I~_~S.~:>"
 631              (type-error-datum condition)
 632              (type-error-expected-type condition)))))
 633
 634 ;;; not specified by ANSI, but too useful not to have around.
 635 (define-condition simple-style-warning (simple-condition style-warning) ())
 636 (define-condition simple-type-error (simple-condition type-error) ())
 637
 638 (define-condition program-error (error) ())
 639 (define-condition parse-error   (error) ())
 640 (define-condition control-error (error) ())
 641 (define-condition stream-error  (error)
 642   ((stream :reader stream-error-stream :initarg :stream)))
 643
 644 (define-condition end-of-file (stream-error) ()
 645   (:report
 646    (lambda (condition stream)
 647      (format stream
 648              "end of file on ~S"
 649              (stream-error-stream condition)))))
 650
 651 (define-condition file-error (error)
 652   ((pathname :reader file-error-pathname :initarg :pathname))
 653   (:report
 654    (lambda (condition stream)
 655      (format stream "error on file ~S" (file-error-pathname condition)))))
 656
 657 (define-condition package-error (error)
 658   ((package :reader package-error-package :initarg :package)))
 659
 660 (define-condition cell-error (error)
 661   ((name :reader cell-error-name :initarg :name)))
 662
 663 (def!method print-object ((condition cell-error) stream)
 664   (if (and *print-escape* (slot-boundp condition 'name))
 665       (print-unreadable-object (condition stream :type t :identity t)
 666         (princ (cell-error-name condition) stream))
 667       (call-next-method)))
 668
 669 (define-condition unbound-variable (cell-error) ()
 670   (:report
 671    (lambda (condition stream)
 672      (format stream
 673              "The variable ~S is unbound."
 674              (cell-error-name condition)))))
 675
 676 (define-condition undefined-function (cell-error) ()
 677   (:report
 678    (lambda (condition stream)
 679      (format stream
 680              "The function ~S is undefined."
 681              (cell-error-name condition)))))
 682
 683 (define-condition special-form-function (undefined-function) ()
 684   (:report
 685    (lambda (condition stream)
 686      (format stream
 687              "Cannot FUNCALL the SYMBOL-FUNCTION of special operator ~S."
 688              (cell-error-name condition)))))
 689
 690 (define-condition arithmetic-error (error)
 691   ((operation :reader arithmetic-error-operation
 692               :initarg :operation
 693               :initform nil)
 694    (operands :reader arithmetic-error-operands
 695              :initarg :operands))
 696   (:report (lambda (condition stream)
 697              (format stream
 698                      "arithmetic error ~S signalled"
 699                      (type-of condition))
 700              (when (arithmetic-error-operation condition)
 701                (format stream
 702                        "~%Operation was ~S, operands ~S."
 703                        (arithmetic-error-operation condition)
 704                        (arithmetic-error-operands condition))))))
 705
 706 (define-condition division-by-zero         (arithmetic-error) ())
 707 (define-condition floating-point-overflow  (arithmetic-error) ())
 708 (define-condition floating-point-underflow (arithmetic-error) ())
 709 (define-condition floating-point-inexact   (arithmetic-error) ())
 710 (define-condition floating-point-invalid-operation (arithmetic-error) ())
 711
 712 (define-condition print-not-readable (error)
 713   ((object :reader print-not-readable-object :initarg :object))
 714   (:report
 715    (lambda (condition stream)
 716      (let ((obj (print-not-readable-object condition))
 717            (*print-array* nil))
 718        (format stream "~S cannot be printed readably." obj)))))
 719
 720 (define-condition reader-error (parse-error stream-error) ()
 721   (:report (lambda (condition stream)
 722              (%report-reader-error condition stream))))
 723
 724 ;;; a READER-ERROR whose REPORTing is controlled by FORMAT-CONTROL and
 725 ;;; FORMAT-ARGS (the usual case for READER-ERRORs signalled from
 726 ;;; within SBCL itself)
 727 ;;;
 728 ;;; (Inheriting CL:SIMPLE-CONDITION here isn't quite consistent with
 729 ;;; the letter of the ANSI spec: this is not a condition signalled by
 730 ;;; SIGNAL when a format-control is supplied by the function's first
 731 ;;; argument. It seems to me (WHN) to be basically in the spirit of
 732 ;;; the spec, but if not, it'd be straightforward to do our own
 733 ;;; DEFINE-CONDITION SB-INT:SIMPLISTIC-CONDITION with
 734 ;;; FORMAT-CONTROL and FORMAT-ARGS slots, and use that condition in
 735 ;;; place of CL:SIMPLE-CONDITION here.)
 736 (define-condition simple-reader-error (reader-error simple-condition)
 737   ()
 738   (:report (lambda (condition stream)
 739              (%report-reader-error condition stream :simple t))))
 740
 741 ;;; base REPORTing of a READER-ERROR
 742 ;;;
 743 ;;; When SIMPLE, we expect and use SIMPLE-CONDITION-ish FORMAT-CONTROL
 744 ;;; and FORMAT-ARGS slots.
 745 (defun %report-reader-error (condition stream &key simple)
 746   (let* ((error-stream (stream-error-stream condition))
 747          (pos (file-position-or-nil-for-error error-stream)))
 748     (let (lineno colno)
 749       (when (and pos
 750                  (< pos sb!xc:array-dimension-limit)
 751                  ;; KLUDGE: lseek() (which is what FILE-POSITION
 752                  ;; reduces to on file-streams) is undefined on
 753                  ;; "some devices", which in practice means that it
 754                  ;; can claim to succeed on /dev/stdin on Darwin
 755                  ;; and Solaris.  This is obviously bad news,
 756                  ;; because the READ-SEQUENCE below will then
 757                  ;; block, not complete, and the report will never
 758                  ;; be printed.  As a workaround, we exclude
 759                  ;; interactive streams from this attempt to report
 760                  ;; positions.  -- CSR, 2003-08-21
 761                  (not (interactive-stream-p error-stream))
 762                  (file-position error-stream :start))
 763         (let ((string
 764                (make-string pos
 765                             :element-type (stream-element-type
 766                                            error-stream))))
 767           (when (= pos (read-sequence string error-stream))
 768             (setq lineno (1+ (count #\Newline string))
 769                   colno (- pos
 770                            (or (position #\Newline string :from-end t) -1)
 771                            1))))
 772         (file-position-or-nil-for-error error-stream pos))
 773       (pprint-logical-block (stream nil)
 774         (format stream
 775                 "~S ~@[at ~W ~]~
 776                     ~@[(line ~W~]~@[, column ~W) ~]~
 777                     on ~S"
 778                 (class-name (class-of condition))
 779                 pos lineno colno error-stream)
 780         (when simple
 781           (format stream ":~2I~_~?"
 782                   (simple-condition-format-control condition)
 783                   (simple-condition-format-arguments condition)))))))
 784 \f
 785 ;;;; special SBCL extension conditions
 786
 787 ;;; an error apparently caused by a bug in SBCL itself
 788 ;;;
 789 ;;; Note that we don't make any serious effort to use this condition
 790 ;;; for *all* errors in SBCL itself. E.g. type errors and array
 791 ;;; indexing errors can occur in functions called from SBCL code, and
 792 ;;; will just end up as ordinary TYPE-ERROR or invalid index error,
 793 ;;; because the signalling code has no good way to know that the
 794 ;;; underlying problem is a bug in SBCL. But in the fairly common case
 795 ;;; that the signalling code does know that it's found a bug in SBCL,
 796 ;;; this condition is appropriate, reusing boilerplate and helping
 797 ;;; users to recognize it as an SBCL bug.
 798 (define-condition bug (simple-error)
 799   ()
 800   (:report
 801    (lambda (condition stream)
 802      (format stream
 803              "~@<  ~? ~:@_~?~:>"
 804              (simple-condition-format-control condition)
 805              (simple-condition-format-arguments condition)
 806              "~@<This is probably a bug in SBCL itself. (Alternatively, ~
 807               SBCL might have been corrupted by bad user code, e.g. by an ~
 808               undefined Lisp operation like ~S, or by stray pointers from ~
 809               alien code or from unsafe Lisp code; or there might be a bug ~
 810               in the OS or hardware that SBCL is running on.) If it seems to ~
 811               be a bug in SBCL itself, the maintainers would like to know ~
 812               about it. Bug reports are welcome on the SBCL ~
 813               mailing lists, which you can find at ~
 814               <http://sbcl.sourceforge.net/>.~:@>"
 815              '((fmakunbound 'compile))))))
 816
 817 (define-condition simple-storage-condition (storage-condition simple-condition)
 818   ())
 819
 820 ;;; a condition for use in stubs for operations which aren't supported
 821 ;;; on some platforms
 822 ;;;
 823 ;;; E.g. in sbcl-0.7.0.5, it might be appropriate to do something like
 824 ;;;   #-(or freebsd linux)
 825 ;;;   (defun load-foreign (&rest rest)
 826 ;;;     (error 'unsupported-operator :name 'load-foreign))
 827 ;;;   #+(or freebsd linux)
 828 ;;;   (defun load-foreign ... actual definition ...)
 829 ;;; By signalling a standard condition in this case, we make it
 830 ;;; possible for test code to distinguish between (1) intentionally
 831 ;;; unimplemented and (2) unintentionally just screwed up somehow.
 832 ;;; (Before this condition was defined, test code tried to deal with
 833 ;;; this by checking for FBOUNDP, but that didn't work reliably. In
 834 ;;; sbcl-0.7.0, a package screwup left the definition of
 835 ;;; LOAD-FOREIGN in the wrong package, so it was unFBOUNDP even on
 836 ;;; architectures where it was supposed to be supported, and the
 837 ;;; regression tests cheerfully passed because they assumed that
 838 ;;; unFBOUNDPness meant they were running on an system which didn't
 839 ;;; support the extension.)
 840 (define-condition unsupported-operator (simple-error) ())
 841 \f
 842 ;;; (:ansi-cl :function remove)
 843 ;;; (:ansi-cl :section (a b c))
 844 ;;; (:ansi-cl :glossary "similar")
 845 ;;;
 846 ;;; (:sbcl :node "...")
 847 ;;; (:sbcl :variable *ed-functions*)
 848 ;;;
 849 ;;; FIXME: this is not the right place for this.
 850 (defun print-reference (reference stream)
 851   (ecase (car reference)
 852     (:amop
 853      (format stream "AMOP")
 854      (format stream ", ")
 855      (destructuring-bind (type data) (cdr reference)
 856        (ecase type
 857          (:readers "Readers for ~:(~A~) Metaobjects"
 858                    (substitute #\  #\- (symbol-name data)))
 859          (:initialization
 860           (format stream "Initialization of ~:(~A~) Metaobjects"
 861                   (substitute #\  #\- (symbol-name data))))
 862          (:generic-function (format stream "Generic Function ~S" data))
 863          (:function (format stream "Function ~S" data))
 864          (:section (format stream "Section ~{~D~^.~}" data)))))
 865     (:ansi-cl
 866      (format stream "The ANSI Standard")
 867      (format stream ", ")
 868      (destructuring-bind (type data) (cdr reference)
 869        (ecase type
 870          (:function (format stream "Function ~S" data))
 871          (:special-operator (format stream "Special Operator ~S" data))
 872          (:macro (format stream "Macro ~S" data))
 873          (:section (format stream "Section ~{~D~^.~}" data))
 874          (:glossary (format stream "Glossary entry for ~S" data))
 875          (:issue (format stream "writeup for Issue ~A" data)))))
 876     (:sbcl
 877      (format stream "The SBCL Manual")
 878      (format stream ", ")
 879      (destructuring-bind (type data) (cdr reference)
 880        (ecase type
 881          (:node (format stream "Node ~S" data))
 882          (:variable (format stream "Variable ~S" data))
 883          (:function (format stream "Function ~S" data)))))
 884     ;; FIXME: other documents (e.g. CLIM, Franz documentation :-)
 885     ))
 886 (define-condition reference-condition ()
 887   ((references :initarg :references :reader reference-condition-references)))
 888 (defvar *print-condition-references* t)
 889 (def!method print-object :around ((o reference-condition) s)
 890   (call-next-method)
 891   (unless (or *print-escape* *print-readably*)
 892     (when (and *print-condition-references*
 893                (reference-condition-references o))
 894       (format s "~&See also:~%")
 895       (pprint-logical-block (s nil :per-line-prefix "  ")
 896         (do* ((rs (reference-condition-references o) (cdr rs))
 897               (r (car rs) (car rs)))
 898              ((null rs))
 899           (print-reference r s)
 900           (unless (null (cdr rs))
 901             (terpri s)))))))
 902
 903 (define-condition simple-reference-error (reference-condition simple-error)
 904   ())
 905
 906 (define-condition simple-reference-warning (reference-condition simple-warning)
 907   ())
 908
 909 (define-condition duplicate-definition (reference-condition warning)
 910   ((name :initarg :name :reader duplicate-definition-name))
 911   (:report (lambda (c s)
 912              (format s "~@<Duplicate definition for ~S found in ~
 913                         one file.~@:>"
 914                      (duplicate-definition-name c))))
 915   (:default-initargs :references (list '(:ansi-cl :section (3 2 2 3)))))
 916
 917 (define-condition constant-modified (reference-condition warning)
 918   ((fun-name :initarg :fun-name :reader constant-modified-fun-name))
 919   (:report (lambda (c s)
 920              (format s "~@<Destructive function ~S called on ~
 921                         constant data.~@:>"
 922                      (constant-modified-fun-name c))))
 923   (:default-initargs :references (list '(:ansi-cl :special-operator quote)
 924                                        '(:ansi-cl :section (3 2 2 3)))))
 925
 926 (define-condition package-at-variance (reference-condition simple-warning)
 927   ()
 928   (:default-initargs :references (list '(:ansi-cl :macro defpackage))))
 929
 930 (define-condition defconstant-uneql (reference-condition error)
 931   ((name :initarg :name :reader defconstant-uneql-name)
 932    (old-value :initarg :old-value :reader defconstant-uneql-old-value)
 933    (new-value :initarg :new-value :reader defconstant-uneql-new-value))
 934   (:report
 935    (lambda (condition stream)
 936      (format stream
 937              "~@<The constant ~S is being redefined (from ~S to ~S)~@:>"
 938              (defconstant-uneql-name condition)
 939              (defconstant-uneql-old-value condition)
 940              (defconstant-uneql-new-value condition))))
 941   (:default-initargs :references (list '(:ansi-cl :macro defconstant)
 942                                        '(:sbcl :node "Idiosyncrasies"))))
 943
 944 (define-condition array-initial-element-mismatch
 945     (reference-condition simple-warning)
 946   ()
 947   (:default-initargs
 948       :references (list
 949                    '(:ansi-cl :function make-array)
 950                    '(:ansi-cl :function sb!xc:upgraded-array-element-type))))
 951
 952 (define-condition displaced-to-array-too-small-error
 953     (reference-condition simple-error)
 954   ()
 955   (:default-initargs
 956       :references (list '(:ansi-cl :function adjust-array))))
 957
 958 (define-condition type-warning (reference-condition simple-warning)
 959   ()
 960   (:default-initargs :references (list '(:sbcl :node "Handling of Types"))))
 961
 962 (define-condition local-argument-mismatch (reference-condition simple-warning)
 963   ()
 964   (:default-initargs :references (list '(:ansi-cl :section (3 2 2 3)))))
 965
 966 (define-condition format-args-mismatch (reference-condition)
 967   ()
 968   (:default-initargs :references (list '(:ansi-cl :section (22 3 10 2)))))
 969
 970 (define-condition format-too-few-args-warning
 971     (format-args-mismatch simple-warning)
 972   ())
 973 (define-condition format-too-many-args-warning
 974     (format-args-mismatch simple-style-warning)
 975   ())
 976
 977 (define-condition implicit-generic-function-warning (style-warning)
 978   ((name :initarg :name :reader implicit-generic-function-name))
 979   (:report
 980    (lambda (condition stream)
 981      (format stream "~@<Implicitly creating new generic function ~S.~:@>"
 982              (implicit-generic-function-name condition)))))
 983
 984 (define-condition extension-failure (reference-condition simple-error)
 985   ())
 986
 987 (define-condition structure-initarg-not-keyword
 988     (reference-condition simple-style-warning)
 989   ()
 990   (:default-initargs :references (list '(:ansi-cl :section (2 4 8 13)))))
 991
 992 #!+sb-package-locks
 993 (progn
 994
 995 (define-condition package-lock-violation (reference-condition package-error)
 996   ((format-control :initform nil :initarg :format-control
 997                    :reader package-error-format-control)
 998    (format-arguments :initform nil :initarg :format-arguments
 999                      :reader package-error-format-arguments))
1000   (:report
1001    (lambda (condition stream)
1002      (let ((control (package-error-format-control condition)))
1003        (if control
1004            (apply #'format stream
1005                   (format nil "~~@<Lock on package ~A violated when ~A.~~:@>"
1006                           (package-name (package-error-package condition))
1007                           control)
1008                   (package-error-format-arguments condition))
1009            (format stream "~@<Lock on package ~A violated.~:@>"
1010                    (package-name (package-error-package condition)))))))
1011   ;; no :default-initargs -- reference-stuff provided by the
1012   ;; signalling form in target-package.lisp
1013   #!+sb-doc
1014   (:documentation
1015    "Subtype of CL:PACKAGE-ERROR. A subtype of this error is signalled
1016 when a package-lock is violated."))
1017
1018 (define-condition package-locked-error (package-lock-violation) ()
1019   #!+sb-doc
1020   (:documentation
1021    "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
1022 signalled when an operation on a package violates a package lock."))
1023
1024 (define-condition symbol-package-locked-error (package-lock-violation)
1025   ((symbol :initarg :symbol :reader package-locked-error-symbol))
1026   #!+sb-doc
1027   (:documentation
1028    "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
1029 signalled when an operation on a symbol violates a package lock. The
1030 symbol that caused the violation is accessed by the function
1031 SB-EXT:PACKAGE-LOCKED-ERROR-SYMBOL."))
1032
1033 ) ; progn
1034
1035 (define-condition undefined-alien-error (cell-error) ()
1036   (:report
1037    (lambda (condition stream)
1038      (if (slot-boundp condition 'name)
1039          (format stream "Undefined alien: ~S" (cell-error-name condition))
1040          (format stream "Undefined alien symbol.")))))
1041
1042 (define-condition undefined-alien-variable-error (undefined-alien-error) ()
1043   (:report
1044    (lambda (condition stream)
1045      (declare (ignore condition))
1046      (format stream "Attempt to access an undefined alien variable."))))
1047
1048 (define-condition undefined-alien-function-error (undefined-alien-error) ()
1049   (:report
1050    (lambda (condition stream)
1051      (declare (ignore condition))
1052      (format stream "Attempt to call an undefined alien function."))))
1053
1054 \f
1055 ;;;; various other (not specified by ANSI) CONDITIONs
1056 ;;;;
1057 ;;;; These might logically belong in other files; they're here, after
1058 ;;;; setup of CONDITION machinery, only because that makes it easier to
1059 ;;;; get cold init to work.
1060
1061 ;;; OAOOM warning: see cross-condition.lisp
1062 (define-condition encapsulated-condition (condition)
1063   ((condition :initarg :condition :reader encapsulated-condition)))
1064
1065 (define-condition values-type-error (type-error)
1066   ()
1067   (:report
1068    (lambda (condition stream)
1069      (format stream
1070              "~@<The values set ~2I~:_[~{~S~^ ~}] ~I~_is not of type ~2I~_~S.~:>"
1071              (type-error-datum condition)
1072              (type-error-expected-type condition)))))
1073
1074 ;;; KLUDGE: a condition for floating point errors when we can't or
1075 ;;; won't figure out what type they are. (In FreeBSD and OpenBSD we
1076 ;;; don't know how, at least as of sbcl-0.6.7; in Linux we probably
1077 ;;; know how but the old code was broken by the conversion to POSIX
1078 ;;; signal handling and hasn't been fixed as of sbcl-0.6.7.)
1079 ;;;
1080 ;;; FIXME: Perhaps this should also be a base class for all
1081 ;;; floating point exceptions?
1082 (define-condition floating-point-exception (arithmetic-error)
1083   ((flags :initarg :traps
1084           :initform nil
1085           :reader floating-point-exception-traps))
1086   (:report (lambda (condition stream)
1087              (format stream
1088                      "An arithmetic error ~S was signalled.~%"
1089                      (type-of condition))
1090              (let ((traps (floating-point-exception-traps condition)))
1091                (if traps
1092                    (format stream
1093                            "Trapping conditions are: ~%~{ ~S~^~}~%"
1094                            traps)
1095                    (write-line
1096                     "No traps are enabled? How can this be?"
1097                     stream))))))
1098
1099 (define-condition index-too-large-error (type-error)
1100   ()
1101   (:report
1102    (lambda (condition stream)
1103      (format stream
1104              "The index ~S is too large."
1105              (type-error-datum condition)))))
1106
1107 (define-condition bounding-indices-bad-error (reference-condition type-error)
1108   ((object :reader bounding-indices-bad-object :initarg :object))
1109   (:report
1110    (lambda (condition stream)
1111      (let* ((datum (type-error-datum condition))
1112             (start (car datum))
1113             (end (cdr datum))
1114             (object (bounding-indices-bad-object condition)))
1115        (etypecase object
1116          (sequence
1117           (format stream
1118                   "The bounding indices ~S and ~S are bad ~
1119                    for a sequence of length ~S."
1120                   start end (length object)))
1121          (array
1122           ;; from WITH-ARRAY-DATA
1123           (format stream
1124                   "The START and END parameters ~S and ~S are ~
1125                    bad for an array of total size ~S."
1126                   start end (array-total-size object)))))))
1127   (:default-initargs
1128       :references
1129       (list '(:ansi-cl :glossary "bounding index designator")
1130             '(:ansi-cl :issue "SUBSEQ-OUT-OF-BOUNDS:IS-AN-ERROR"))))
1131
1132 (define-condition nil-array-accessed-error (reference-condition type-error)
1133   ()
1134   (:report (lambda (condition stream)
1135              (declare (ignore condition))
1136              (format stream
1137                      "An attempt to access an array of element-type ~
1138                       NIL was made.  Congratulations!")))
1139   (:default-initargs
1140       :references (list '(:ansi-cl :function sb!xc:upgraded-array-element-type)
1141                         '(:ansi-cl :section (15 1 2 1))
1142                         '(:ansi-cl :section (15 1 2 2)))))
1143
1144 (define-condition namestring-parse-error (parse-error)
1145   ((complaint :reader namestring-parse-error-complaint :initarg :complaint)
1146    (args :reader namestring-parse-error-args :initarg :args :initform nil)
1147    (namestring :reader namestring-parse-error-namestring :initarg :namestring)
1148    (offset :reader namestring-parse-error-offset :initarg :offset))
1149   (:report
1150    (lambda (condition stream)
1151      (format stream
1152              "parse error in namestring: ~?~%  ~A~%  ~V@T^"
1153              (namestring-parse-error-complaint condition)
1154              (namestring-parse-error-args condition)
1155              (namestring-parse-error-namestring condition)
1156              (namestring-parse-error-offset condition)))))
1157
1158 (define-condition simple-package-error (simple-condition package-error) ())
1159
1160 (define-condition simple-reader-package-error (simple-reader-error) ())
1161
1162 (define-condition reader-eof-error (end-of-file)
1163   ((context :reader reader-eof-error-context :initarg :context))
1164   (:report
1165    (lambda (condition stream)
1166      (format stream
1167              "unexpected end of file on ~S ~A"
1168              (stream-error-stream condition)
1169              (reader-eof-error-context condition)))))
1170
1171 (define-condition reader-impossible-number-error (simple-reader-error)
1172   ((error :reader reader-impossible-number-error-error :initarg :error))
1173   (:report
1174    (lambda (condition stream)
1175      (let ((error-stream (stream-error-stream condition)))
1176        (format stream
1177                "READER-ERROR ~@[at ~W ~]on ~S:~%~?~%Original error: ~A"
1178                (file-position-or-nil-for-error error-stream) error-stream
1179                (simple-condition-format-control condition)
1180                (simple-condition-format-arguments condition)
1181                (reader-impossible-number-error-error condition))))))
1182
1183 (define-condition timeout (serious-condition)
1184   ((seconds :initarg :seconds :initform nil :reader timeout-seconds))
1185   (:report (lambda (condition stream)
1186              (format stream "Timeout occurred~@[ after ~A seconds~]."
1187                      (timeout-seconds condition)))))
1188
1189 (define-condition io-timeout (stream-error timeout)
1190   ((direction :reader io-timeout-direction :initarg :direction))
1191   (:report
1192    (lambda (condition stream)
1193      (declare (type stream stream))
1194      (format stream
1195              "I/O timeout ~(~A~)ing ~S."
1196              (io-timeout-direction condition)
1197              (stream-error-stream condition)))))
1198
1199 (define-condition deadline-timeout (timeout) ()
1200   (:report (lambda (condition stream)
1201              (format stream "A deadline was reached after ~A seconds."
1202                      (timeout-seconds condition)))))
1203
1204 (define-condition declaration-type-conflict-error (reference-condition
1205                                                    simple-error)
1206   ()
1207   (:default-initargs
1208       :format-control "symbol ~S cannot be both the name of a type and the name of a declaration"
1209     :references (list '(:ansi-cl :section (3 8 21)))))
1210
1211 ;;; Single stepping conditions
1212
1213 (define-condition step-condition ()
1214   ((form :initarg :form :reader step-condition-form))
1215
1216   #!+sb-doc
1217   (:documentation "Common base class of single-stepping conditions.
1218 STEP-CONDITION-FORM holds a string representation of the form being
1219 stepped."))
1220
1221 #!+sb-doc
1222 (setf (fdocumentation 'step-condition-form 'function)
1223       "Form associated with the STEP-CONDITION.")
1224
1225 (define-condition step-form-condition (step-condition)
1226   ((args :initarg :args :reader step-condition-args))
1227   (:report
1228    (lambda (condition stream)
1229      (let ((*print-circle* t)
1230            (*print-pretty* t)
1231            (*print-readably* nil))
1232        (format stream
1233                  "Evaluating call:~%~<  ~@;~A~:>~%~
1234                   ~:[With arguments:~%~{  ~S~%~}~;With unknown arguments~]~%"
1235                (list (step-condition-form condition))
1236                (eq (step-condition-args condition) :unknown)
1237                (step-condition-args condition)))))
1238   #!+sb-doc
1239   (:documentation "Condition signalled by code compiled with
1240 single-stepping information when about to execute a form.
1241 STEP-CONDITION-FORM holds the form, STEP-CONDITION-PATHNAME holds the
1242 pathname of the original file or NIL, and STEP-CONDITION-SOURCE-PATH
1243 holds the source-path to the original form within that file or NIL.
1244 Associated with this condition are always the restarts STEP-INTO,
1245 STEP-NEXT, and STEP-CONTINUE."))
1246
1247 #!+sb-doc
1248 (setf (fdocumentation 'step-condition-source-path 'function)
1249       "Source-path of the original form associated with the
1250 STEP-FORM-CONDITION or NIL."
1251       (fdocumentation 'step-condition-pathname 'function)
1252       "Pathname of the original source-file associated with the
1253 STEP-FORM-CONDITION or NIL.")
1254
1255 (define-condition step-result-condition (step-condition)
1256   ((result :initarg :result :reader step-condition-result)))
1257
1258 #!+sb-doc
1259 (setf (fdocumentation 'step-condition-result 'function)
1260       "Return values associated with STEP-VALUES-CONDITION as a list,
1261 or the variable value associated with STEP-VARIABLE-CONDITION.")
1262
1263 (define-condition step-values-condition (step-result-condition)
1264   ()
1265   #!+sb-doc
1266   (:documentation "Condition signalled by code compiled with
1267 single-stepping information after executing a form.
1268 STEP-CONDITION-FORM holds the form, and STEP-CONDITION-RESULT holds
1269 the values returned by the form as a list. No associated restarts."))
1270
1271 (define-condition step-finished-condition (step-condition)
1272   ()
1273   (:report
1274    (lambda (condition stream)
1275      (declare (ignore condition))
1276      (format stream "Returning from STEP")))
1277   #!+sb-doc
1278   (:documentation "Condition signaled when STEP returns."))
1279 \f
1280 ;;; A knob for muffling warnings, mostly for use while loading files.
1281 (defvar *muffled-warnings* 'uninteresting-redefinition
1282   "A type that ought to specify a subtype of WARNING.  Whenever a
1283 warning is signaled, if the warning if of this type and is not
1284 handled by any other handler, it will be muffled.")
1285 \f
1286 ;;; Various STYLE-WARNING signaled in the system.
1287 ;; For the moment, we're only getting into the details for function
1288 ;; redefinitions, but other redefinitions could be done later
1289 ;; (e.g. methods).
1290 (define-condition redefinition-warning (style-warning)
1291   ())
1292
1293 (define-condition function-redefinition-warning (redefinition-warning)
1294   ((name :initarg :name :reader function-redefinition-warning-name)
1295    (old :initarg :old :reader function-redefinition-warning-old-fdefinition)
1296    ;; For DEFGENERIC and perhaps others, the redefinition
1297    ;; destructively modifies the original, rather than storing a new
1298    ;; object, so there's no NEW here, but only in subclasses.
1299    ))
1300
1301 (define-condition redefinition-with-defun (function-redefinition-warning)
1302   ((new :initarg :new :reader redefinition-with-defun-new-fdefinition)
1303    ;; KLUDGE: it would be nice to fix the unreasonably late
1304    ;; back-patching of DEBUG-SOURCEs in the DEBUG-INFO during
1305    ;; fasloading and just use the new fdefinition, but for the moment
1306    ;; we'll compare the SOURCE-LOCATION created during DEFUN with the
1307    ;; previous DEBUG-SOURCE.
1308    (new-location :initarg :new-location
1309               :reader redefinition-with-defun-new-location))
1310   (:report (lambda (warning stream)
1311              (format stream "redefining ~S in DEFUN"
1312                      (function-redefinition-warning-name warning)))))
1313
1314 (define-condition redefinition-with-defgeneric (function-redefinition-warning)
1315   ((new-location :initarg :new-location
1316                  :reader redefinition-with-defgeneric-new-location))
1317   (:report (lambda (warning stream)
1318              (format stream "redefining ~S in DEFGENERIC"
1319                      (function-redefinition-warning-name warning)))))
1320
1321 (define-condition redefinition-with-defmethod (redefinition-warning)
1322   ((gf :initarg :generic-function
1323        :reader redefinition-with-defmethod-generic-function)
1324    (qualifiers :initarg :qualifiers
1325                :reader redefinition-with-defmethod-qualifiers)
1326    (specializers :initarg :specializers
1327                  :reader redefinition-with-defmethod-specializers)
1328    (new-location :initarg :new-location
1329                  :reader redefinition-with-defmethod-new-location)
1330    (old-method :initarg :old-method
1331                :reader redefinition-with-defmethod-old-method))
1332   (:report (lambda (warning stream)
1333              (format stream "redefining ~S~{ ~S~} ~S in DEFMETHOD"
1334                      (redefinition-with-defmethod-generic-function warning)
1335                      (redefinition-with-defmethod-qualifiers warning)
1336                      (redefinition-with-defmethod-specializers warning)))))
1337
1338 ;; FIXME: see the FIXMEs in defmacro.lisp, then maybe instantiate this.
1339 (define-condition redefinition-with-defmacro (function-redefinition-warning)
1340   ())
1341
1342 ;; Here are a few predicates for what people might find interesting
1343 ;; about redefinitions.
1344
1345 ;; DEFUN can replace a generic function with an ordinary function.
1346 ;; (Attempting to replace an ordinary function with a generic one
1347 ;; causes an error, though.)
1348 (defun redefinition-replaces-generic-function-p (warning)
1349   (and (typep warning 'redefinition-with-defun)
1350        (typep (function-redefinition-warning-old-fdefinition warning)
1351               'generic-function)))
1352
1353 (defun redefinition-replaces-compiled-function-with-interpreted-p (warning)
1354   (and (typep warning 'redefinition-with-defun)
1355        (compiled-function-p
1356         (function-redefinition-warning-old-fdefinition warning))
1357        (not (compiled-function-p
1358              (redefinition-with-defun-new-fdefinition warning)))))
1359
1360 ;; Most people seem to agree that re-running a DEFUN in a file is
1361 ;; completely uninteresting.
1362 (defun uninteresting-ordinary-function-redefinition-p (warning)
1363   ;; OAOO violation: this duplicates code in SB-INTROSPECT.
1364   ;; Additionally, there are some functions that aren't
1365   ;; funcallable-instances for which finding the source location is
1366   ;; complicated (e.g. DEFSTRUCT-defined predicates and accessors),
1367   ;; but I don't think they're defined with %DEFUN, so the warning
1368   ;; isn't raised.
1369   (flet ((fdefinition-file-namestring (fdefn)
1370            #!+sb-eval
1371            (when (typep fdefn 'sb!eval:interpreted-function)
1372              (return-from fdefinition-file-namestring
1373                (sb!c:definition-source-location-namestring
1374                    (sb!eval:interpreted-function-source-location fdefn))))
1375            ;; All the following accesses are guarded with conditionals
1376            ;; because it's not clear whether any of the slots we're
1377            ;; chasing down are guaranteed to be filled in.
1378            (let* ((fdefn
1379                    ;; KLUDGE: although this looks like it only works
1380                    ;; for %SIMPLE-FUNs, in fact there's a pun such
1381                    ;; that %SIMPLE-FUN-SELF returns the simple-fun
1382                    ;; object for closures and
1383                    ;; funcallable-instances. -- CSR, circa 2005
1384                    (sb!kernel:%simple-fun-self fdefn))
1385                   (code (if fdefn (sb!kernel:fun-code-header fdefn)))
1386                   (debug-info (if code (sb!kernel:%code-debug-info code)))
1387                   (debug-source (if debug-info
1388                                     (sb!c::debug-info-source debug-info)))
1389                   (namestring (if debug-source
1390                                   (sb!c::debug-source-namestring debug-source))))
1391              namestring)))
1392     (and
1393      ;; There's garbage in various places when the first DEFUN runs in
1394      ;; cold-init.
1395      sb!kernel::*cold-init-complete-p*
1396      (typep warning 'redefinition-with-defun)
1397      (let ((old-fdefn
1398             (function-redefinition-warning-old-fdefinition warning))
1399            (new-fdefn
1400             (redefinition-with-defun-new-fdefinition warning)))
1401        ;; Replacing a compiled function with a compiled function is
1402        ;; clearly uninteresting, and we'll say arbitrarily that
1403        ;; replacing an interpreted function with an interpreted
1404        ;; function is uninteresting, too, but leave out the
1405        ;; compiled-to-interpreted case.
1406        (when (or (typep
1407                   old-fdefn
1408                   '(or #!+sb-eval sb!eval:interpreted-function))
1409                  (and (typep old-fdefn
1410                              '(and compiled-function
1411                                (not funcallable-instance)))
1412                       ;; Since this is a REDEFINITION-WITH-DEFUN,
1413                       ;; NEW-FDEFN can't be a FUNCALLABLE-INSTANCE.
1414                       (typep new-fdefn 'compiled-function)))
1415          (let* ((old-namestring (fdefinition-file-namestring old-fdefn))
1416                 (new-namestring
1417                  (or (fdefinition-file-namestring new-fdefn)
1418                      (let ((srcloc
1419                             (redefinition-with-defun-new-location warning)))
1420                        (if srcloc
1421                             (sb!c::definition-source-location-namestring
1422                                 srcloc))))))
1423            (and old-namestring
1424                 new-namestring
1425                 (equal old-namestring new-namestring))))))))
1426
1427 (defun uninteresting-generic-function-redefinition-p (warning)
1428   (and (typep warning 'redefinition-with-defgeneric)
1429        (let* ((old-fdefn
1430                (function-redefinition-warning-old-fdefinition warning))
1431               (old-location
1432                (if (typep old-fdefn 'generic-function)
1433                    (sb!pcl::definition-source old-fdefn)))
1434               (old-namestring
1435                (if old-location
1436                    (sb!c:definition-source-location-namestring old-location)))
1437               (new-location
1438                (redefinition-with-defgeneric-new-location warning))
1439               (new-namestring
1440                (if new-location
1441                    (sb!c:definition-source-location-namestring new-location))))
1442          (and old-namestring
1443               new-namestring
1444               (equal old-namestring new-namestring)))))
1445
1446 (defun uninteresting-method-redefinition-p (warning)
1447   (and (typep warning 'redefinition-with-defmethod)
1448        (let* ((old-method (redefinition-with-defmethod-old-method warning))
1449               (old-location (sb!pcl::definition-source old-method))
1450               (old-namestring (if old-location
1451                                   (sb!c:definition-source-location-namestring
1452                                       old-location)))
1453               (new-location (redefinition-with-defmethod-new-location warning))
1454               (new-namestring (if new-location
1455                                   (sb!c:definition-source-location-namestring
1456                                       new-location))))
1457          (and new-namestring
1458               old-namestring
1459               (equal new-namestring old-namestring)))))
1460
1461 (deftype uninteresting-redefinition ()
1462   '(or (satisfies uninteresting-ordinary-function-redefinition-p)
1463        (satisfies uninteresting-generic-function-redefinition-p)
1464        (satisfies uninteresting-method-redefinition-p)))
1465
1466 (define-condition redefinition-with-deftransform (redefinition-warning)
1467   ((transform :initarg :transform
1468               :reader redefinition-with-deftransform-transform))
1469   (:report (lambda (warning stream)
1470              (format stream "Overwriting ~S"
1471                      (redefinition-with-deftransform-transform warning)))))
1472 \f
1473 ;;; Various other STYLE-WARNINGS
1474 (define-condition dubious-asterisks-around-variable-name
1475     (style-warning simple-condition)
1476   ()
1477   (:report (lambda (warning stream)
1478              (format stream "~@?, even though the name follows~@
1479 the usual naming convention (names like *FOO*) for special variables"
1480                      (simple-condition-format-control warning)
1481                      (simple-condition-format-arguments warning)))))
1482
1483 (define-condition asterisks-around-lexical-variable-name
1484     (dubious-asterisks-around-variable-name)
1485   ())
1486
1487 (define-condition asterisks-around-constant-variable-name
1488     (dubious-asterisks-around-variable-name)
1489   ())
1490
1491 ;; We call this UNDEFINED-ALIEN-STYLE-WARNING because there are some
1492 ;; subclasses of ERROR above having to do with undefined aliens.
1493 (define-condition undefined-alien-style-warning (style-warning)
1494   ((symbol :initarg :symbol :reader undefined-alien-symbol))
1495   (:report (lambda (warning stream)
1496              (format stream "Undefined alien: ~S"
1497                      (undefined-alien-symbol warning)))))
1498
1499 #!+sb-eval
1500 (define-condition lexical-environment-too-complex (style-warning)
1501   ((form :initarg :form :reader lexical-environment-too-complex-form)
1502    (lexenv :initarg :lexenv :reader lexical-environment-too-complex-lexenv))
1503   (:report (lambda (warning stream)
1504              (format stream
1505                      "~@<Native lexical environment too complex for ~
1506                          SB-EVAL to evaluate ~S, falling back to ~
1507                          SIMPLE-EVAL-IN-LEXENV.  Lexenv: ~S~:@>"
1508                      (lexical-environment-too-complex-form warning)
1509                      (lexical-environment-too-complex-lexenv warning)))))
1510
1511 ;; Although this has -ERROR- in the name, it's just a STYLE-WARNING.
1512 (define-condition character-decoding-error-in-comment (style-warning)
1513   ((stream :initarg :stream :reader decoding-error-in-comment-stream)
1514    (position :initarg :position :reader decoding-error-in-comment-position))
1515   (:report (lambda (warning stream)
1516              (format stream
1517                       "Character decoding error in a ~A-comment at ~
1518                       position ~A reading source stream ~A, ~
1519                       resyncing."
1520                       (decoding-error-in-comment-macro warning)
1521                       (decoding-error-in-comment-position warning)
1522                       (decoding-error-in-comment-stream warning)))))
1523
1524 (define-condition character-decoding-error-in-macro-char-comment
1525     (character-decoding-error-in-comment)
1526   ((char :initform #\; :initarg :char
1527          :reader character-decoding-error-in-macro-char-comment-char)))
1528
1529 (define-condition character-decoding-error-in-dispatch-macro-char-comment
1530     (character-decoding-error-in-comment)
1531   ;; ANSI doesn't give a way for a reader function invoked by a
1532   ;; dispatch macro character to determine which dispatch character
1533   ;; was used, so if a user wants to signal one of these from a custom
1534   ;; comment reader, he'll have to supply the :DISP-CHAR himself.
1535   ((disp-char :initform #\# :initarg :disp-char
1536               :reader character-decoding-error-in-macro-char-comment-disp-char)
1537    (sub-char :initarg :sub-char
1538              :reader character-decoding-error-in-macro-char-comment-sub-char)))
1539
1540 (defun decoding-error-in-comment-macro (warning)
1541   (etypecase warning
1542     (character-decoding-error-in-macro-char-comment
1543      (character-decoding-error-in-macro-char-comment-char warning))
1544     (character-decoding-error-in-dispatch-macro-char-comment
1545      (format
1546       nil "~C~C"
1547       (character-decoding-error-in-macro-char-comment-disp-char warning)
1548       (character-decoding-error-in-macro-char-comment-sub-char warning)))))
1549
1550 (define-condition deprecated-eval-when-situations (style-warning)
1551   ((situations :initarg :situations
1552                :reader deprecated-eval-when-situations-situations))
1553   (:report (lambda (warning stream)
1554              (format stream "using deprecated EVAL-WHEN situation names~{ ~S~}"
1555                      (deprecated-eval-when-situations-situations warning)))))
1556
1557 (define-condition proclamation-mismatch (style-warning)
1558   ((name :initarg :name :reader proclamation-mismatch-name)
1559    (old :initarg :old :reader proclamation-mismatch-old)
1560    (new :initarg :new :reader proclamation-mismatch-new)))
1561
1562 (define-condition type-proclamation-mismatch (proclamation-mismatch)
1563   ()
1564   (:report (lambda (warning stream)
1565              (format stream
1566                      "The new TYPE proclamation~% ~S for ~S does not ~
1567                      match the old TYPE proclamation ~S"
1568                      (proclamation-mismatch-new warning)
1569                      (proclamation-mismatch-name warning)
1570                      (proclamation-mismatch-old warning)))))
1571
1572 (define-condition ftype-proclamation-mismatch (proclamation-mismatch)
1573   ()
1574   (:report (lambda (warning stream)
1575              (format stream
1576                      "The new FTYPE proclamation~% ~S for ~S does not ~
1577                      match the old FTYPE proclamation ~S"
1578                      (proclamation-mismatch-new warning)
1579                      (proclamation-mismatch-name warning)
1580                      (proclamation-mismatch-old warning)))))
1581 \f
1582 ;;;; restart definitions
1583
1584 (define-condition abort-failure (control-error) ()
1585   (:report
1586    "An ABORT restart was found that failed to transfer control dynamically."))
1587
1588 (defun abort (&optional condition)
1589   #!+sb-doc
1590   "Transfer control to a restart named ABORT, signalling a CONTROL-ERROR if
1591    none exists."
1592   (invoke-restart (find-restart-or-control-error 'abort condition))
1593   ;; ABORT signals an error in case there was a restart named ABORT
1594   ;; that did not transfer control dynamically. This could happen with
1595   ;; RESTART-BIND.
1596   (error 'abort-failure))
1597
1598 (defun muffle-warning (&optional condition)
1599   #!+sb-doc
1600   "Transfer control to a restart named MUFFLE-WARNING, signalling a
1601    CONTROL-ERROR if none exists."
1602   (invoke-restart (find-restart-or-control-error 'muffle-warning condition)))
1603
1604 (defun try-restart (name condition &rest arguments)
1605   (let ((restart (find-restart name condition)))
1606     (when restart
1607       (apply #'invoke-restart restart arguments))))
1608
1609 (macrolet ((define-nil-returning-restart (name args doc)
1610              #!-sb-doc (declare (ignore doc))
1611              `(defun ,name (,@args &optional condition)
1612                 #!+sb-doc ,doc
1613                 (try-restart ',name condition ,@args))))
1614   (define-nil-returning-restart continue ()
1615     "Transfer control to a restart named CONTINUE, or return NIL if none exists.")
1616   (define-nil-returning-restart store-value (value)
1617     "Transfer control and VALUE to a restart named STORE-VALUE, or return NIL if
1618    none exists.")
1619   (define-nil-returning-restart use-value (value)
1620     "Transfer control and VALUE to a restart named USE-VALUE, or return NIL if
1621    none exists."))
1622
1623 ;;; single-stepping restarts
1624
1625 (macrolet ((def (name doc)
1626                #!-sb-doc (declare (ignore doc))
1627                `(defun ,name (condition)
1628                  #!+sb-doc ,doc
1629                  (invoke-restart (find-restart-or-control-error ',name condition)))))
1630   (def step-continue
1631       "Transfers control to the STEP-CONTINUE restart associated with
1632 the condition, continuing execution without stepping. Signals a
1633 CONTROL-ERROR if the restart does not exist.")
1634   (def step-next
1635       "Transfers control to the STEP-NEXT restart associated with the
1636 condition, executing the current form without stepping and continuing
1637 stepping with the next form. Signals CONTROL-ERROR is the restart does
1638 not exists.")
1639   (def step-into
1640       "Transfers control to the STEP-INTO restart associated with the
1641 condition, stepping into the current form. Signals a CONTROL-ERROR is
1642 the restart does not exist."))
1643
1644 (/show0 "condition.lisp end of file")
1645