1 ;;;; stuff originally from CMU CL's error.lisp which can or should
2 ;;;; come late (mostly related to the CONDITION class itself)
5 ;;;; This software is part of the SBCL system. See the README file for
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.
14 (in-package "SB!KERNEL")
16 ;;;; the CONDITION class
18 (/show0 "condition.lisp 20")
20 (eval-when (:compile-toplevel :load-toplevel :execute)
22 (/show0 "condition.lisp 24")
24 (def!struct (condition-classoid (:include classoid)
25 (:constructor make-condition-classoid))
26 ;; list of CONDITION-SLOT structures for the direct slots of this
28 (slots nil :type list)
29 ;; list of CONDITION-SLOT structures for all of the effective class
30 ;; slots of this class
31 (class-slots nil :type list)
32 ;; report function or NIL
33 (report nil :type (or function null))
34 ;; list of specifications of the form
36 ;; (INITARG INITFORM THUNK)
38 ;; where THUNK, when called without arguments, returns the value for
40 (direct-default-initargs () :type list)
41 ;; class precedence list as a list of CLASS objects, with all
42 ;; non-CONDITION classes removed
44 ;; a list of all the effective instance allocation slots of this
45 ;; class that have a non-constant initform or default-initarg.
46 ;; Values for these slots must be computed in the dynamic
47 ;; environment of MAKE-CONDITION.
48 (hairy-slots nil :type list))
50 (/show0 "condition.lisp 49")
54 (!defstruct-with-alternate-metaclass condition
55 :slot-names (actual-initargs assigned-slots)
56 :boa-constructor %make-condition-object
58 :metaclass-name condition-classoid
59 :metaclass-constructor make-condition-classoid
62 (defstruct (condition-slot (:copier nil))
63 (name (missing-arg) :type symbol)
64 ;; list of all applicable initargs
65 (initargs (missing-arg) :type list)
66 ;; names of reader and writer functions
67 (readers (missing-arg) :type list)
68 (writers (missing-arg) :type list)
69 ;; true if :INITFORM was specified
70 (initform-p (missing-arg) :type (member t nil))
71 ;; If this is a function, call it with no args. Otherwise, it's the
73 (initform (missing-arg) :type t)
74 ;; allocation of this slot, or NIL until defaulted
75 (allocation nil :type (member :instance :class nil))
76 ;; If ALLOCATION is :CLASS, this is a cons whose car holds the value.
77 (cell nil :type (or cons null))
79 (documentation nil :type (or string null)))
81 ;;; KLUDGE: It's not clear to me why CONDITION-CLASS has itself listed
82 ;;; in its CPL, while other classes derived from CONDITION-CLASS don't
83 ;;; have themselves listed in their CPLs. This behavior is inherited
84 ;;; from CMU CL, and didn't seem to be explained there, and I haven't
85 ;;; figured out whether it's right. -- WHN 19990612
86 (eval-when (:compile-toplevel :load-toplevel :execute)
87 (/show0 "condition.lisp 103")
88 (let ((condition-class (locally
89 ;; KLUDGE: There's a DEFTRANSFORM
90 ;; FIND-CLASSOID for constant class names
91 ;; which creates fast but
92 ;; non-cold-loadable, non-compact code. In
93 ;; this context, we'd rather have compact,
94 ;; cold-loadable code. -- WHN 19990928
95 (declare (notinline find-classoid))
96 (find-classoid 'condition))))
97 (setf (condition-classoid-cpl condition-class)
98 (list condition-class)))
99 (/show0 "condition.lisp 103"))
101 (setf (condition-classoid-report (locally
102 ;; KLUDGE: There's a DEFTRANSFORM
103 ;; FIND-CLASSOID for constant class
104 ;; names which creates fast but
105 ;; non-cold-loadable, non-compact
106 ;; code. In this context, we'd
107 ;; rather have compact,
108 ;; cold-loadable code. -- WHN
110 (declare (notinline find-classoid))
111 (find-classoid 'condition)))
112 (lambda (cond stream)
113 (format stream "Condition ~S was signalled." (type-of cond))))
115 (eval-when (:compile-toplevel :load-toplevel :execute)
117 (defun find-condition-layout (name parent-types)
118 (let* ((cpl (remove-duplicates
122 (condition-classoid-cpl
125 (cond-layout (info :type :compiler-layout 'condition))
126 (olayout (info :type :compiler-layout name))
127 ;; FIXME: Does this do the right thing in case of multiple
128 ;; inheritance? A quick look at DEFINE-CONDITION didn't make
129 ;; it obvious what ANSI intends to be done in the case of
130 ;; multiple inheritance, so it's not actually clear what the
133 (order-layout-inherits (concatenate 'simple-vector
134 (layout-inherits cond-layout)
135 (mapcar #'classoid-layout cpl)))))
137 (not (mismatch (layout-inherits olayout) new-inherits)))
139 (make-layout :classoid (make-undefined-classoid name)
140 :inherits new-inherits
142 :length (layout-length cond-layout)))))
146 ;;; FIXME: ANSI's definition of DEFINE-CONDITION says
147 ;;; Condition reporting is mediated through the PRINT-OBJECT method
148 ;;; for the condition type in question, with *PRINT-ESCAPE* always
149 ;;; being nil. Specifying (:REPORT REPORT-NAME) in the definition of
150 ;;; a condition type C is equivalent to:
151 ;;; (defmethod print-object ((x c) stream)
152 ;;; (if *print-escape* (call-next-method) (report-name x stream)))
153 ;;; The current code doesn't seem to quite match that.
154 (def!method print-object ((x condition) stream)
156 (if (and (typep x 'simple-condition) (slot-value x 'format-control))
157 (print-unreadable-object (x stream :type t :identity t)
158 (write (simple-condition-format-control x)
161 (print-unreadable-object (x stream :type t :identity t)))
162 ;; KLUDGE: A comment from CMU CL here said
163 ;; 7/13/98 BUG? CPL is not sorted and results here depend on order of
164 ;; superclasses in define-condition call!
165 (dolist (class (condition-classoid-cpl (classoid-of x))
166 (error "no REPORT? shouldn't happen!"))
167 (let ((report (condition-classoid-report class)))
169 (return (funcall report x stream)))))))
171 ;;;; slots of CONDITION objects
173 (defvar *empty-condition-slot* '(empty))
175 (defun find-slot-default (class slot)
176 (let ((initargs (condition-slot-initargs slot))
177 (cpl (condition-classoid-cpl class)))
178 ;; When CLASS or a superclass has a default initarg for SLOT, use
181 (let ((direct-default-initargs
182 (condition-classoid-direct-default-initargs class)))
183 (dolist (initarg initargs)
184 (let ((initfunction (third (assoc initarg direct-default-initargs))))
186 (return-from find-slot-default (funcall initfunction)))))))
188 ;; Otherwise use the initform of SLOT, if there is one.
189 (if (condition-slot-initform-p slot)
190 (let ((initform (condition-slot-initform slot)))
191 (if (functionp initform)
194 (error "unbound condition slot: ~S" (condition-slot-name slot)))))
196 (defun find-condition-class-slot (condition-class slot-name)
198 (condition-classoid-cpl condition-class)
199 (error "There is no slot named ~S in ~S."
200 slot-name condition-class))
201 (dolist (slot (condition-classoid-slots sclass))
202 (when (eq (condition-slot-name slot) slot-name)
203 (return-from find-condition-class-slot slot)))))
205 (defun condition-writer-function (condition new-value name)
206 (dolist (cslot (condition-classoid-class-slots
207 (layout-classoid (%instance-layout condition)))
208 (setf (getf (condition-assigned-slots condition) name)
210 (when (eq (condition-slot-name cslot) name)
211 (return (setf (car (condition-slot-cell cslot)) new-value)))))
213 (defun condition-reader-function (condition name)
214 (let ((class (layout-classoid (%instance-layout condition))))
215 (dolist (cslot (condition-classoid-class-slots class))
216 (when (eq (condition-slot-name cslot) name)
217 (return-from condition-reader-function
218 (car (condition-slot-cell cslot)))))
219 (let ((val (getf (condition-assigned-slots condition) name
220 *empty-condition-slot*)))
221 (if (eq val *empty-condition-slot*)
222 (let ((actual-initargs (condition-actual-initargs condition))
223 (slot (find-condition-class-slot class name)))
225 (error "missing slot ~S of ~S" name condition))
226 (do ((initargs actual-initargs (cddr initargs)))
228 (setf (getf (condition-assigned-slots condition) name)
229 (find-slot-default class slot)))
230 (when (member (car initargs) (condition-slot-initargs slot))
231 (return-from condition-reader-function
232 (setf (getf (condition-assigned-slots condition)
239 (defun allocate-condition (type &rest initargs)
240 (let* ((type (if (symbolp type)
241 (find-classoid type nil)
243 (class (typecase type
244 (condition-classoid type)
246 (return-from allocate-condition
247 (apply #'allocate-condition (class-name type) initargs)))
249 (error 'simple-type-error
251 :expected-type 'condition-class
252 :format-control "~S is not a condition class."
253 :format-arguments (list type)))
255 (error 'simple-type-error
257 :expected-type 'condition-class
259 "~s does not designate a condition class."
260 :format-arguments (list type)))))
261 (condition (%make-condition-object initargs '())))
262 (setf (%instance-layout condition) (classoid-layout class))
263 (values condition class)))
265 (defun make-condition (type &rest initargs)
267 "Make an instance of a condition object using the specified initargs."
268 ;; Note: ANSI specifies no exceptional situations in this function.
269 ;; signalling simple-type-error would not be wrong.
270 (multiple-value-bind (condition class)
271 (apply #'allocate-condition type initargs)
273 ;; Set any class slots with initargs present in this call.
274 (dolist (cslot (condition-classoid-class-slots class))
275 (dolist (initarg (condition-slot-initargs cslot))
276 (let ((val (getf initargs initarg *empty-condition-slot*)))
277 (unless (eq val *empty-condition-slot*)
278 (setf (car (condition-slot-cell cslot)) val)))))
280 ;; Default any slots with non-constant defaults now.
281 (dolist (hslot (condition-classoid-hairy-slots class))
282 (when (dolist (initarg (condition-slot-initargs hslot) t)
283 (unless (eq (getf initargs initarg *empty-condition-slot*)
284 *empty-condition-slot*)
286 (setf (getf (condition-assigned-slots condition)
287 (condition-slot-name hslot))
288 (find-slot-default class hslot))))
293 ;;;; DEFINE-CONDITION
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"
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)))
327 (setf (layout-info layout)
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)))))
336 (setf (find-classoid name) class)
338 ;; Initialize CPL slot.
339 (setf (condition-classoid-cpl class)
340 (remove-if-not #'condition-classoid-p
341 (std-compute-class-precedence-list class)))))
345 ;;; Compute the effective slots of CLASS, copying inherited slots and
346 ;;; destructively modifying direct slots.
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)))
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))))
372 (res (copy-structure sslot)))))))
375 ;;; Early definitions of slot accessor creators.
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)
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))))
394 (defvar *define-condition-hooks* nil)
396 (defun %set-condition-report (name report)
397 (setf (condition-classoid-report (find-classoid name))
400 (defun %define-condition (name parent-types layout slots documentation
401 direct-default-initargs all-readers all-writers
403 (with-single-package-locked-error
404 (:symbol name "defining ~A as a condition")
405 (%compiler-define-condition name parent-types layout all-readers all-writers)
406 (sb!c:with-source-location (source-location)
407 (setf (layout-source-location layout)
409 (let ((class (find-classoid name)))
410 (setf (condition-classoid-slots class) slots
411 (condition-classoid-direct-default-initargs class) direct-default-initargs
412 (fdocumentation name 'type) documentation)
416 ;; Set up reader and writer functions.
417 (let ((slot-name (condition-slot-name slot)))
418 (dolist (reader (condition-slot-readers slot))
419 (install-condition-slot-reader reader name slot-name))
420 (dolist (writer (condition-slot-writers slot))
421 (install-condition-slot-writer writer name slot-name))))
423 ;; Compute effective slots and set up the class and hairy slots
424 ;; (subsets of the effective slots.)
425 (setf (condition-classoid-hairy-slots class) '())
426 (let ((eslots (compute-effective-slots class))
429 (mapcar #'condition-classoid-direct-default-initargs
430 (condition-classoid-cpl class)))))
431 (dolist (slot eslots)
432 (ecase (condition-slot-allocation slot)
434 (unless (condition-slot-cell slot)
435 (setf (condition-slot-cell slot)
436 (list (if (condition-slot-initform-p slot)
437 (let ((initform (condition-slot-initform slot)))
438 (if (functionp initform)
441 *empty-condition-slot*))))
442 (push slot (condition-classoid-class-slots class)))
444 (setf (condition-slot-allocation slot) :instance)
445 (when (or (functionp (condition-slot-initform slot))
446 (dolist (initarg (condition-slot-initargs slot) nil)
447 (when (functionp (third (assoc initarg e-def-initargs)))
449 (push slot (condition-classoid-hairy-slots class)))))))
450 (when (boundp '*define-condition-hooks*)
451 (dolist (fun *define-condition-hooks*)
452 (funcall fun class))))
455 (defmacro define-condition (name (&rest parent-types) (&rest slot-specs)
458 "DEFINE-CONDITION Name (Parent-Type*) (Slot-Spec*) Option*
459 Define NAME as a condition type. This new type inherits slots and its
460 report function from the specified PARENT-TYPEs. A slot spec is a list of:
461 (slot-name :reader <rname> :initarg <iname> {Option Value}*
463 The DEFINE-CLASS slot options :ALLOCATION, :INITFORM, [slot] :DOCUMENTATION
464 and :TYPE and the overall options :DEFAULT-INITARGS and
465 [type] :DOCUMENTATION are also allowed.
467 The :REPORT option is peculiar to DEFINE-CONDITION. Its argument is either
468 a string or a two-argument lambda or function name. If a function, the
469 function is called with the condition and stream to report the condition.
470 If a string, the string is printed.
472 Condition types are classes, but (as allowed by ANSI and not as described in
473 CLtL2) are neither STANDARD-OBJECTs nor STRUCTURE-OBJECTs. WITH-SLOTS and
474 SLOT-VALUE may not be used on condition objects."
475 (let* ((parent-types (or parent-types '(condition)))
476 (layout (find-condition-layout name parent-types))
479 (direct-default-initargs ()))
481 (all-readers nil append)
482 (all-writers nil append))
483 (dolist (spec slot-specs)
484 (when (keywordp spec)
485 (warn "Keyword slot name indicates probable syntax error:~% ~S"
487 (let* ((spec (if (consp spec) spec (list spec)))
488 (slot-name (first spec))
489 (allocation :instance)
496 (do ((options (rest spec) (cddr options)))
498 (unless (and (consp options) (consp (cdr options)))
499 (error "malformed condition slot spec:~% ~S." spec))
500 (let ((arg (second options)))
501 (case (first options)
502 (:reader (readers arg))
503 (:writer (writers arg))
506 (writers `(setf ,arg)))
509 (error "more than one :INITFORM in ~S" spec))
512 (:initarg (initargs arg))
514 (setq allocation arg))
517 (error "more than one :DOCUMENTATION in ~S" spec))
518 (unless (stringp arg)
519 (error "slot :DOCUMENTATION argument is not a string: ~S"
521 (setq documentation arg))
524 (error "unknown slot option:~% ~S" (first options))))))
526 (all-readers (readers))
527 (all-writers (writers))
528 (slots `(make-condition-slot
530 :initargs ',(initargs)
533 :initform-p ',initform-p
534 :documentation ',documentation
535 :initform ,(when initform-p
536 `#'(lambda () ,initform))
537 :allocation ',allocation)))))
539 (dolist (option options)
540 (unless (consp option)
541 (error "bad option:~% ~S" option))
543 (:documentation (setq documentation (second option)))
545 (let ((arg (second option)))
548 `#'(lambda (condition stream)
549 (declare (ignore condition))
550 (write-string ,arg stream))
551 `#'(lambda (condition stream)
552 (funcall #',arg condition stream))))))
554 (doplist (initarg initform) (rest option)
555 (push ``(,',initarg ,',initform ,#'(lambda () ,initform))
556 direct-default-initargs)))
558 (error "unknown option: ~S" (first option)))))
561 (eval-when (:compile-toplevel)
562 (%compiler-define-condition ',name ',parent-types ',layout
563 ',(all-readers) ',(all-writers)))
564 (eval-when (:load-toplevel :execute)
565 (%define-condition ',name
570 (list ,@direct-default-initargs)
573 (sb!c:source-location))
574 ;; This needs to be after %DEFINE-CONDITION in case :REPORT
575 ;; is a lambda referring to condition slot accessors:
576 ;; they're not proclaimed as functions before it has run if
577 ;; we're under EVAL or loaded as source.
578 (%set-condition-report ',name ,report)
581 ;;;; various CONDITIONs specified by ANSI
583 (define-condition serious-condition (condition) ())
585 (define-condition error (serious-condition) ())
587 (define-condition warning (condition) ())
588 (define-condition style-warning (warning) ())
590 (defun simple-condition-printer (condition stream)
591 (let ((control (simple-condition-format-control condition)))
593 (apply #'format stream
595 (simple-condition-format-arguments condition))
596 (error "No format-control for ~S" condition))))
598 (define-condition simple-condition ()
599 ((format-control :reader simple-condition-format-control
600 :initarg :format-control
602 :type format-control)
603 (format-arguments :reader simple-condition-format-arguments
604 :initarg :format-arguments
607 (:report simple-condition-printer))
609 (define-condition simple-warning (simple-condition warning) ())
611 (define-condition simple-error (simple-condition error) ())
613 (define-condition storage-condition (serious-condition) ())
615 (define-condition type-error (error)
616 ((datum :reader type-error-datum :initarg :datum)
617 (expected-type :reader type-error-expected-type :initarg :expected-type))
619 (lambda (condition stream)
621 "~@<The value ~2I~:_~S ~I~_is not of type ~2I~_~S.~:>"
622 (type-error-datum condition)
623 (type-error-expected-type condition)))))
625 (def!method print-object ((condition type-error) stream)
627 (flet ((maybe-string (thing)
629 (write-to-string thing :lines 1 :readably nil :array nil :pretty t))))
630 (let ((type (maybe-string (type-error-expected-type condition)))
631 (datum (maybe-string (type-error-datum condition))))
633 (print-unreadable-object (condition stream :type t)
634 (format stream "~@<expected-type: ~A ~_datum: ~A~:@>" type datum))
635 (call-next-method))))
638 ;;; not specified by ANSI, but too useful not to have around.
639 (define-condition simple-style-warning (simple-condition style-warning) ())
640 (define-condition simple-type-error (simple-condition type-error) ())
642 ;; Can't have a function called SIMPLE-TYPE-ERROR or TYPE-ERROR...
643 (declaim (ftype (sfunction (t t t &rest t) nil) bad-type))
644 (defun bad-type (datum type control &rest arguments)
645 (error 'simple-type-error
648 :format-control control
649 :format-arguments arguments))
651 (define-condition program-error (error) ())
652 (define-condition parse-error (error) ())
653 (define-condition control-error (error) ())
654 (define-condition stream-error (error)
655 ((stream :reader stream-error-stream :initarg :stream)))
657 (define-condition end-of-file (stream-error) ()
659 (lambda (condition stream)
662 (stream-error-stream condition)))))
664 (define-condition closed-stream-error (stream-error) ()
666 (lambda (condition stream)
667 (format stream "~S is closed" (stream-error-stream condition)))))
669 (define-condition file-error (error)
670 ((pathname :reader file-error-pathname :initarg :pathname))
672 (lambda (condition stream)
673 (format stream "error on file ~S" (file-error-pathname condition)))))
675 (define-condition package-error (error)
676 ((package :reader package-error-package :initarg :package)))
678 (define-condition cell-error (error)
679 ((name :reader cell-error-name :initarg :name)))
681 (def!method print-object ((condition cell-error) stream)
682 (if (and *print-escape* (slot-boundp condition 'name))
683 (print-unreadable-object (condition stream :type t :identity t)
684 (princ (cell-error-name condition) stream))
687 (define-condition unbound-variable (cell-error) ()
689 (lambda (condition stream)
691 "The variable ~S is unbound."
692 (cell-error-name condition)))))
694 (define-condition undefined-function (cell-error) ()
696 (lambda (condition stream)
698 "The function ~/sb-impl::print-symbol-with-prefix/ is undefined."
699 (cell-error-name condition)))))
701 (define-condition special-form-function (undefined-function) ()
703 (lambda (condition stream)
705 "Cannot FUNCALL the SYMBOL-FUNCTION of special operator ~S."
706 (cell-error-name condition)))))
708 (define-condition arithmetic-error (error)
709 ((operation :reader arithmetic-error-operation
712 (operands :reader arithmetic-error-operands
714 (:report (lambda (condition stream)
716 "arithmetic error ~S signalled"
718 (when (arithmetic-error-operation condition)
720 "~%Operation was ~S, operands ~S."
721 (arithmetic-error-operation condition)
722 (arithmetic-error-operands condition))))))
724 (define-condition division-by-zero (arithmetic-error) ())
725 (define-condition floating-point-overflow (arithmetic-error) ())
726 (define-condition floating-point-underflow (arithmetic-error) ())
727 (define-condition floating-point-inexact (arithmetic-error) ())
728 (define-condition floating-point-invalid-operation (arithmetic-error) ())
730 (define-condition print-not-readable (error)
731 ((object :reader print-not-readable-object :initarg :object))
733 (lambda (condition stream)
734 (let ((obj (print-not-readable-object condition))
736 (format stream "~S cannot be printed readably." obj)))))
738 (define-condition reader-error (parse-error stream-error) ()
739 (:report (lambda (condition stream)
740 (%report-reader-error condition stream))))
742 ;;; a READER-ERROR whose REPORTing is controlled by FORMAT-CONTROL and
743 ;;; FORMAT-ARGS (the usual case for READER-ERRORs signalled from
744 ;;; within SBCL itself)
746 ;;; (Inheriting CL:SIMPLE-CONDITION here isn't quite consistent with
747 ;;; the letter of the ANSI spec: this is not a condition signalled by
748 ;;; SIGNAL when a format-control is supplied by the function's first
749 ;;; argument. It seems to me (WHN) to be basically in the spirit of
750 ;;; the spec, but if not, it'd be straightforward to do our own
751 ;;; DEFINE-CONDITION SB-INT:SIMPLISTIC-CONDITION with
752 ;;; FORMAT-CONTROL and FORMAT-ARGS slots, and use that condition in
753 ;;; place of CL:SIMPLE-CONDITION here.)
754 (define-condition simple-reader-error (reader-error simple-condition)
756 (:report (lambda (condition stream)
757 (%report-reader-error condition stream :simple t))))
759 ;;; base REPORTing of a READER-ERROR
761 ;;; When SIMPLE, we expect and use SIMPLE-CONDITION-ish FORMAT-CONTROL
762 ;;; and FORMAT-ARGS slots.
763 (defun %report-reader-error (condition stream &key simple position)
764 (let ((error-stream (stream-error-stream condition)))
765 (pprint-logical-block (stream nil)
767 (apply #'format stream
768 (simple-condition-format-control condition)
769 (simple-condition-format-arguments condition))
770 (prin1 (class-name (class-of condition)) stream))
771 (format stream "~2I~@[~_~_~:{~:(~A~): ~S~:^, ~:_~}~]~_~_Stream: ~S"
772 (stream-error-position-info error-stream position)
775 ;;;; special SBCL extension conditions
777 ;;; an error apparently caused by a bug in SBCL itself
779 ;;; Note that we don't make any serious effort to use this condition
780 ;;; for *all* errors in SBCL itself. E.g. type errors and array
781 ;;; indexing errors can occur in functions called from SBCL code, and
782 ;;; will just end up as ordinary TYPE-ERROR or invalid index error,
783 ;;; because the signalling code has no good way to know that the
784 ;;; underlying problem is a bug in SBCL. But in the fairly common case
785 ;;; that the signalling code does know that it's found a bug in SBCL,
786 ;;; this condition is appropriate, reusing boilerplate and helping
787 ;;; users to recognize it as an SBCL bug.
788 (define-condition bug (simple-error)
791 (lambda (condition stream)
794 (simple-condition-format-control condition)
795 (simple-condition-format-arguments condition)
796 "~@<This is probably a bug in SBCL itself. (Alternatively, ~
797 SBCL might have been corrupted by bad user code, e.g. by an ~
798 undefined Lisp operation like ~S, or by stray pointers from ~
799 alien code or from unsafe Lisp code; or there might be a bug ~
800 in the OS or hardware that SBCL is running on.) If it seems to ~
801 be a bug in SBCL itself, the maintainers would like to know ~
802 about it. Bug reports are welcome on the SBCL ~
803 mailing lists, which you can find at ~
804 <http://sbcl.sourceforge.net/>.~:@>"
805 '((fmakunbound 'compile))))))
807 (define-condition simple-storage-condition (storage-condition simple-condition)
810 ;;; a condition for use in stubs for operations which aren't supported
811 ;;; on some platforms
813 ;;; E.g. in sbcl-0.7.0.5, it might be appropriate to do something like
814 ;;; #-(or freebsd linux)
815 ;;; (defun load-foreign (&rest rest)
816 ;;; (error 'unsupported-operator :name 'load-foreign))
817 ;;; #+(or freebsd linux)
818 ;;; (defun load-foreign ... actual definition ...)
819 ;;; By signalling a standard condition in this case, we make it
820 ;;; possible for test code to distinguish between (1) intentionally
821 ;;; unimplemented and (2) unintentionally just screwed up somehow.
822 ;;; (Before this condition was defined, test code tried to deal with
823 ;;; this by checking for FBOUNDP, but that didn't work reliably. In
824 ;;; sbcl-0.7.0, a package screwup left the definition of
825 ;;; LOAD-FOREIGN in the wrong package, so it was unFBOUNDP even on
826 ;;; architectures where it was supposed to be supported, and the
827 ;;; regression tests cheerfully passed because they assumed that
828 ;;; unFBOUNDPness meant they were running on an system which didn't
829 ;;; support the extension.)
830 (define-condition unsupported-operator (simple-error) ())
832 ;;; (:ansi-cl :function remove)
833 ;;; (:ansi-cl :section (a b c))
834 ;;; (:ansi-cl :glossary "similar")
836 ;;; (:sbcl :node "...")
837 ;;; (:sbcl :variable *ed-functions*)
839 ;;; FIXME: this is not the right place for this.
840 (defun print-reference (reference stream)
841 (ecase (car reference)
843 (format stream "AMOP")
845 (destructuring-bind (type data) (cdr reference)
847 (:readers "Readers for ~:(~A~) Metaobjects"
848 (substitute #\ #\- (symbol-name data)))
850 (format stream "Initialization of ~:(~A~) Metaobjects"
851 (substitute #\ #\- (symbol-name data))))
852 (:generic-function (format stream "Generic Function ~S" data))
853 (:function (format stream "Function ~S" data))
854 (:section (format stream "Section ~{~D~^.~}" data)))))
856 (format stream "The ANSI Standard")
858 (destructuring-bind (type data) (cdr reference)
860 (:function (format stream "Function ~S" data))
861 (:special-operator (format stream "Special Operator ~S" data))
862 (:macro (format stream "Macro ~S" data))
863 (:section (format stream "Section ~{~D~^.~}" data))
864 (:glossary (format stream "Glossary entry for ~S" data))
865 (:issue (format stream "writeup for Issue ~A" data)))))
867 (format stream "The SBCL Manual")
869 (destructuring-bind (type data) (cdr reference)
871 (:node (format stream "Node ~S" data))
872 (:variable (format stream "Variable ~S" data))
873 (:function (format stream "Function ~S" data)))))
874 ;; FIXME: other documents (e.g. CLIM, Franz documentation :-)
876 (define-condition reference-condition ()
877 ((references :initarg :references :reader reference-condition-references)))
878 (defvar *print-condition-references* t)
879 (def!method print-object :around ((o reference-condition) s)
881 (unless (or *print-escape* *print-readably*)
882 (when (and *print-condition-references*
883 (reference-condition-references o))
884 (format s "~&See also:~%")
885 (pprint-logical-block (s nil :per-line-prefix " ")
886 (do* ((rs (reference-condition-references o) (cdr rs))
887 (r (car rs) (car rs)))
889 (print-reference r s)
890 (unless (null (cdr rs))
893 (define-condition simple-reference-error (reference-condition simple-error)
896 (define-condition simple-reference-warning (reference-condition simple-warning)
899 (define-condition arguments-out-of-domain-error
900 (arithmetic-error reference-condition)
903 (define-condition duplicate-definition (reference-condition warning)
904 ((name :initarg :name :reader duplicate-definition-name))
905 (:report (lambda (c s)
906 (format s "~@<Duplicate definition for ~S found in ~
908 (duplicate-definition-name c))))
909 (:default-initargs :references (list '(:ansi-cl :section (3 2 2 3)))))
911 (define-condition constant-modified (reference-condition warning)
912 ((fun-name :initarg :fun-name :reader constant-modified-fun-name))
913 (:report (lambda (c s)
914 (format s "~@<Destructive function ~S called on ~
916 (constant-modified-fun-name c))))
917 (:default-initargs :references (list '(:ansi-cl :special-operator quote)
918 '(:ansi-cl :section (3 2 2 3)))))
920 (define-condition package-at-variance (reference-condition simple-warning)
922 (:default-initargs :references (list '(:ansi-cl :macro defpackage)
923 '(:sbcl :variable *on-package-variance*))))
925 (define-condition package-at-variance-error (reference-condition simple-condition
928 (:default-initargs :references (list '(:ansi-cl :macro defpackage))))
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))
935 (lambda (condition 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"))))
944 (define-condition array-initial-element-mismatch
945 (reference-condition simple-warning)
949 '(:ansi-cl :function make-array)
950 '(:ansi-cl :function sb!xc:upgraded-array-element-type))))
952 (define-condition type-warning (reference-condition simple-warning)
954 (:default-initargs :references (list '(:sbcl :node "Handling of Types"))))
955 (define-condition type-style-warning (reference-condition simple-style-warning)
957 (:default-initargs :references (list '(:sbcl :node "Handling of Types"))))
959 (define-condition local-argument-mismatch (reference-condition simple-warning)
961 (:default-initargs :references (list '(:ansi-cl :section (3 2 2 3)))))
963 (define-condition format-args-mismatch (reference-condition)
965 (:default-initargs :references (list '(:ansi-cl :section (22 3 10 2)))))
967 (define-condition format-too-few-args-warning
968 (format-args-mismatch simple-warning)
970 (define-condition format-too-many-args-warning
971 (format-args-mismatch simple-style-warning)
974 (define-condition implicit-generic-function-warning (style-warning)
975 ((name :initarg :name :reader implicit-generic-function-name))
977 (lambda (condition stream)
978 (let ((*package* (find-package :keyword)))
979 (format stream "~@<Implicitly creating new generic function ~S.~:@>"
980 (implicit-generic-function-name condition))))))
982 (define-condition extension-failure (reference-condition simple-error)
985 (define-condition structure-initarg-not-keyword
986 (reference-condition simple-style-warning)
988 (:default-initargs :references (list '(:ansi-cl :section (2 4 8 13)))))
993 (define-condition package-lock-violation (package-error
996 ((current-package :initform *package*
997 :reader package-lock-violation-in-package))
999 (lambda (condition stream)
1000 (let ((control (simple-condition-format-control condition))
1001 (error-package (package-name (package-error-package condition)))
1002 (current-package (package-name (package-lock-violation-in-package condition))))
1004 (apply #'format stream
1005 (format nil "~~@<Lock on package ~A violated when ~A while in package ~A.~~:@>"
1009 (simple-condition-format-arguments condition))
1010 (format stream "~@<Lock on package ~A violated while in package ~A.~:@>"
1012 current-package)))))
1013 ;; no :default-initargs -- reference-stuff provided by the
1014 ;; signalling form in target-package.lisp
1017 "Subtype of CL:PACKAGE-ERROR. A subtype of this error is signalled
1018 when a package-lock is violated."))
1020 (define-condition package-locked-error (package-lock-violation) ()
1023 "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
1024 signalled when an operation on a package violates a package lock."))
1026 (define-condition symbol-package-locked-error (package-lock-violation)
1027 ((symbol :initarg :symbol :reader package-locked-error-symbol))
1030 "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
1031 signalled when an operation on a symbol violates a package lock. The
1032 symbol that caused the violation is accessed by the function
1033 SB-EXT:PACKAGE-LOCKED-ERROR-SYMBOL."))
1037 (define-condition undefined-alien-error (cell-error) ()
1039 (lambda (condition stream)
1040 (if (slot-boundp condition 'name)
1041 (format stream "Undefined alien: ~S" (cell-error-name condition))
1042 (format stream "Undefined alien symbol.")))))
1044 (define-condition undefined-alien-variable-error (undefined-alien-error) ()
1046 (lambda (condition stream)
1047 (declare (ignore condition))
1048 (format stream "Attempt to access an undefined alien variable."))))
1050 (define-condition undefined-alien-function-error (undefined-alien-error) ()
1052 (lambda (condition stream)
1053 (declare (ignore condition))
1054 (format stream "Attempt to call an undefined alien function."))))
1057 ;;;; various other (not specified by ANSI) CONDITIONs
1059 ;;;; These might logically belong in other files; they're here, after
1060 ;;;; setup of CONDITION machinery, only because that makes it easier to
1061 ;;;; get cold init to work.
1063 ;;; OAOOM warning: see cross-condition.lisp
1064 (define-condition encapsulated-condition (condition)
1065 ((condition :initarg :condition :reader encapsulated-condition)))
1067 ;;; KLUDGE: a condition for floating point errors when we can't or
1068 ;;; won't figure out what type they are. (In FreeBSD and OpenBSD we
1069 ;;; don't know how, at least as of sbcl-0.6.7; in Linux we probably
1070 ;;; know how but the old code was broken by the conversion to POSIX
1071 ;;; signal handling and hasn't been fixed as of sbcl-0.6.7.)
1073 ;;; FIXME: Perhaps this should also be a base class for all
1074 ;;; floating point exceptions?
1075 (define-condition floating-point-exception (arithmetic-error)
1076 ((flags :initarg :traps
1078 :reader floating-point-exception-traps))
1079 (:report (lambda (condition stream)
1081 "An arithmetic error ~S was signalled.~%"
1082 (type-of condition))
1083 (let ((traps (floating-point-exception-traps condition)))
1086 "Trapping conditions are: ~%~{ ~S~^~}~%"
1089 "No traps are enabled? How can this be?"
1092 (define-condition invalid-array-index-error (type-error)
1093 ((array :initarg :array :reader invalid-array-index-error-array)
1094 (axis :initarg :axis :reader invalid-array-index-error-axis))
1096 (lambda (condition stream)
1097 (let ((array (invalid-array-index-error-array condition)))
1098 (format stream "Index ~W out of bounds for ~@[axis ~W of ~]~S, ~
1099 should be nonnegative and <~W."
1100 (type-error-datum condition)
1101 (when (> (array-rank array) 1)
1102 (invalid-array-index-error-axis condition))
1104 ;; Extract the bound from (INTEGER 0 (BOUND))
1105 (caaddr (type-error-expected-type condition)))))))
1107 (define-condition invalid-array-error (reference-condition type-error) ()
1109 (lambda (condition stream)
1110 (let ((*print-array* nil))
1112 "~@<Displaced array originally of type ~S has been invalidated ~
1113 due its displaced-to array ~S having become too small to hold ~
1114 it: the displaced array's dimensions have all been set to zero ~
1115 to trap accesses to it.~:@>"
1116 (type-error-expected-type condition)
1117 (array-displacement (type-error-datum condition))))))
1120 (list '(:ansi-cl :function adjust-array))))
1122 (define-condition index-too-large-error (type-error)
1125 (lambda (condition stream)
1127 "The index ~S is too large."
1128 (type-error-datum condition)))))
1130 (define-condition bounding-indices-bad-error (reference-condition type-error)
1131 ((object :reader bounding-indices-bad-object :initarg :object))
1133 (lambda (condition stream)
1134 (let* ((datum (type-error-datum condition))
1137 (object (bounding-indices-bad-object condition)))
1141 "The bounding indices ~S and ~S are bad ~
1142 for a sequence of length ~S."
1143 start end (length object)))
1145 ;; from WITH-ARRAY-DATA
1147 "The START and END parameters ~S and ~S are ~
1148 bad for an array of total size ~S."
1149 start end (array-total-size object)))))))
1152 (list '(:ansi-cl :glossary "bounding index designator")
1153 '(:ansi-cl :issue "SUBSEQ-OUT-OF-BOUNDS:IS-AN-ERROR"))))
1155 (define-condition nil-array-accessed-error (reference-condition type-error)
1157 (:report (lambda (condition stream)
1158 (declare (ignore condition))
1160 "An attempt to access an array of element-type ~
1161 NIL was made. Congratulations!")))
1163 :references (list '(:ansi-cl :function sb!xc:upgraded-array-element-type)
1164 '(:ansi-cl :section (15 1 2 1))
1165 '(:ansi-cl :section (15 1 2 2)))))
1167 (define-condition namestring-parse-error (parse-error)
1168 ((complaint :reader namestring-parse-error-complaint :initarg :complaint)
1169 (args :reader namestring-parse-error-args :initarg :args :initform nil)
1170 (namestring :reader namestring-parse-error-namestring :initarg :namestring)
1171 (offset :reader namestring-parse-error-offset :initarg :offset))
1173 (lambda (condition stream)
1175 "parse error in namestring: ~?~% ~A~% ~V@T^"
1176 (namestring-parse-error-complaint condition)
1177 (namestring-parse-error-args condition)
1178 (namestring-parse-error-namestring condition)
1179 (namestring-parse-error-offset condition)))))
1181 (define-condition simple-package-error (simple-condition package-error) ())
1183 (define-condition simple-reader-package-error (simple-reader-error package-error) ())
1185 (define-condition reader-eof-error (end-of-file)
1186 ((context :reader reader-eof-error-context :initarg :context))
1188 (lambda (condition stream)
1190 "unexpected end of file on ~S ~A"
1191 (stream-error-stream condition)
1192 (reader-eof-error-context condition)))))
1194 (define-condition reader-impossible-number-error (simple-reader-error)
1195 ((error :reader reader-impossible-number-error-error :initarg :error))
1197 (lambda (condition stream)
1198 (let ((error-stream (stream-error-stream condition)))
1200 "READER-ERROR ~@[at ~W ~]on ~S:~%~?~%Original error: ~A"
1201 (file-position-or-nil-for-error error-stream) error-stream
1202 (simple-condition-format-control condition)
1203 (simple-condition-format-arguments condition)
1204 (reader-impossible-number-error-error condition))))))
1206 (define-condition standard-readtable-modified-error (reference-condition error)
1207 ((operation :initarg :operation :reader standard-readtable-modified-operation))
1208 (:report (lambda (condition stream)
1209 (format stream "~S would modify the standard readtable."
1210 (standard-readtable-modified-operation condition))))
1211 (:default-initargs :references `((:ansi-cl :section (2 1 1 2))
1212 (:ansi-cl :glossary "standard readtable"))))
1214 (define-condition standard-pprint-dispatch-table-modified-error
1215 (reference-condition error)
1216 ((operation :initarg :operation
1217 :reader standard-pprint-dispatch-table-modified-operation))
1218 (:report (lambda (condition stream)
1219 (format stream "~S would modify the standard pprint dispatch table."
1220 (standard-pprint-dispatch-table-modified-operation
1223 :references `((:ansi-cl :glossary "standard pprint dispatch table"))))
1225 (define-condition timeout (serious-condition)
1226 ((seconds :initarg :seconds :initform nil :reader timeout-seconds))
1227 (:report (lambda (condition stream)
1228 (format stream "Timeout occurred~@[ after ~A seconds~]."
1229 (timeout-seconds condition)))))
1231 (define-condition io-timeout (stream-error timeout)
1232 ((direction :reader io-timeout-direction :initarg :direction))
1234 (lambda (condition stream)
1235 (declare (type stream stream))
1237 "I/O timeout while doing ~(~A~) on ~S."
1238 (io-timeout-direction condition)
1239 (stream-error-stream condition)))))
1241 (define-condition deadline-timeout (timeout) ()
1242 (:report (lambda (condition stream)
1243 (format stream "A deadline was reached after ~A seconds."
1244 (timeout-seconds condition)))))
1246 (define-condition declaration-type-conflict-error (reference-condition
1250 :format-control "symbol ~S cannot be both the name of a type and the name of a declaration"
1251 :references (list '(:ansi-cl :section (3 8 21)))))
1253 ;;; Single stepping conditions
1255 (define-condition step-condition ()
1256 ((form :initarg :form :reader step-condition-form))
1259 (:documentation "Common base class of single-stepping conditions.
1260 STEP-CONDITION-FORM holds a string representation of the form being
1264 (setf (fdocumentation 'step-condition-form 'function)
1265 "Form associated with the STEP-CONDITION.")
1267 (define-condition step-form-condition (step-condition)
1268 ((args :initarg :args :reader step-condition-args))
1270 (lambda (condition stream)
1271 (let ((*print-circle* t)
1273 (*print-readably* nil))
1275 "Evaluating call:~%~< ~@;~A~:>~%~
1276 ~:[With arguments:~%~{ ~S~%~}~;With unknown arguments~]~%"
1277 (list (step-condition-form condition))
1278 (eq (step-condition-args condition) :unknown)
1279 (step-condition-args condition)))))
1281 (:documentation "Condition signalled by code compiled with
1282 single-stepping information when about to execute a form.
1283 STEP-CONDITION-FORM holds the form, STEP-CONDITION-PATHNAME holds the
1284 pathname of the original file or NIL, and STEP-CONDITION-SOURCE-PATH
1285 holds the source-path to the original form within that file or NIL.
1286 Associated with this condition are always the restarts STEP-INTO,
1287 STEP-NEXT, and STEP-CONTINUE."))
1289 (define-condition step-result-condition (step-condition)
1290 ((result :initarg :result :reader step-condition-result)))
1293 (setf (fdocumentation 'step-condition-result 'function)
1294 "Return values associated with STEP-VALUES-CONDITION as a list,
1295 or the variable value associated with STEP-VARIABLE-CONDITION.")
1297 (define-condition step-values-condition (step-result-condition)
1300 (:documentation "Condition signalled by code compiled with
1301 single-stepping information after executing a form.
1302 STEP-CONDITION-FORM holds the form, and STEP-CONDITION-RESULT holds
1303 the values returned by the form as a list. No associated restarts."))
1305 (define-condition step-finished-condition (step-condition)
1308 (lambda (condition stream)
1309 (declare (ignore condition))
1310 (format stream "Returning from STEP")))
1312 (:documentation "Condition signaled when STEP returns."))
1314 ;;; A knob for muffling warnings, mostly for use while loading files.
1315 (defvar *muffled-warnings* 'uninteresting-redefinition
1316 "A type that ought to specify a subtype of WARNING. Whenever a
1317 warning is signaled, if the warning if of this type and is not
1318 handled by any other handler, it will be muffled.")
1320 ;;; Various STYLE-WARNING signaled in the system.
1321 ;; For the moment, we're only getting into the details for function
1322 ;; redefinitions, but other redefinitions could be done later
1324 (define-condition redefinition-warning (style-warning)
1327 :reader redefinition-warning-name)
1329 :initarg :new-location
1330 :reader redefinition-warning-new-location)))
1332 (define-condition function-redefinition-warning (redefinition-warning)
1334 :initarg :new-function
1335 :reader function-redefinition-warning-new-function)))
1337 (define-condition redefinition-with-defun (function-redefinition-warning)
1339 (:report (lambda (warning stream)
1340 (format stream "redefining ~/sb-impl::print-symbol-with-prefix/ ~
1342 (redefinition-warning-name warning)))))
1344 (define-condition redefinition-with-defmacro (function-redefinition-warning)
1346 (:report (lambda (warning stream)
1347 (format stream "redefining ~/sb-impl::print-symbol-with-prefix/ ~
1349 (redefinition-warning-name warning)))))
1351 (define-condition redefinition-with-defgeneric (redefinition-warning)
1353 (:report (lambda (warning stream)
1354 (format stream "redefining ~/sb-impl::print-symbol-with-prefix/ ~
1356 (redefinition-warning-name warning)))))
1358 (define-condition redefinition-with-defmethod (redefinition-warning)
1359 ((qualifiers :initarg :qualifiers
1360 :reader redefinition-with-defmethod-qualifiers)
1361 (specializers :initarg :specializers
1362 :reader redefinition-with-defmethod-specializers)
1363 (new-location :initarg :new-location
1364 :reader redefinition-with-defmethod-new-location)
1365 (old-method :initarg :old-method
1366 :reader redefinition-with-defmethod-old-method))
1367 (:report (lambda (warning stream)
1368 (format stream "redefining ~S~{ ~S~} ~S in DEFMETHOD"
1369 (redefinition-warning-name warning)
1370 (redefinition-with-defmethod-qualifiers warning)
1371 (redefinition-with-defmethod-specializers warning)))))
1373 ;;;; Deciding which redefinitions are "interesting".
1375 (defun function-file-namestring (function)
1377 (when (typep function 'sb!eval:interpreted-function)
1378 (return-from function-file-namestring
1379 (sb!c:definition-source-location-namestring
1380 (sb!eval:interpreted-function-source-location function))))
1381 (let* ((fun (sb!kernel:%fun-fun function))
1382 (code (sb!kernel:fun-code-header fun))
1383 (debug-info (sb!kernel:%code-debug-info code))
1384 (debug-source (when debug-info
1385 (sb!c::debug-info-source debug-info)))
1386 (namestring (when debug-source
1387 (sb!c::debug-source-namestring debug-source))))
1390 (defun interesting-function-redefinition-warning-p (warning old)
1391 (let ((new (function-redefinition-warning-new-function warning))
1392 (source-location (redefinition-warning-new-location warning)))
1394 ;; Compiled->Interpreted is interesting.
1395 (and (typep old 'compiled-function)
1396 (typep new '(not compiled-function)))
1397 ;; FIN->Regular is interesting.
1398 (and (typep old 'funcallable-instance)
1399 (typep new '(not funcallable-instance)))
1400 ;; Different file or unknown location is interesting.
1401 (let* ((old-namestring (function-file-namestring old))
1403 (or (function-file-namestring new)
1404 (when source-location
1405 (sb!c::definition-source-location-namestring source-location)))))
1406 (and (or (not old-namestring)
1407 (not new-namestring)
1408 (not (string= old-namestring new-namestring))))))))
1410 (defun uninteresting-ordinary-function-redefinition-p (warning)
1412 ;; There's garbage in various places when the first DEFUN runs in
1414 sb!kernel::*cold-init-complete-p*
1415 (typep warning 'redefinition-with-defun)
1417 (let ((name (redefinition-warning-name warning)))
1418 (not (interesting-function-redefinition-warning-p
1419 warning (or (fdefinition name) (macro-function name)))))))
1421 (defun uninteresting-macro-redefinition-p (warning)
1423 (typep warning 'redefinition-with-defmacro)
1425 (let ((name (redefinition-warning-name warning)))
1426 (not (interesting-function-redefinition-warning-p
1427 warning (or (macro-function name) (fdefinition name)))))))
1429 (defun uninteresting-generic-function-redefinition-p (warning)
1431 (typep warning 'redefinition-with-defgeneric)
1432 ;; Can't use the shared logic above, since GF's don't get a "new"
1433 ;; definition -- rather the FIN-FUNCTION is set.
1434 (let* ((name (redefinition-warning-name warning))
1435 (old (fdefinition name))
1436 (old-location (when (typep old 'generic-function)
1437 (sb!pcl::definition-source old)))
1438 (old-namestring (when old-location
1439 (sb!c:definition-source-location-namestring old-location)))
1440 (new-location (redefinition-warning-new-location warning))
1441 (new-namestring (when new-location
1442 (sb!c:definition-source-location-namestring new-location))))
1445 (string= old-namestring new-namestring)))))
1447 (defun uninteresting-method-redefinition-p (warning)
1449 (typep warning 'redefinition-with-defmethod)
1450 ;; Can't use the shared logic above, since GF's don't get a "new"
1451 ;; definition -- rather the FIN-FUNCTION is set.
1452 (let* ((old-method (redefinition-with-defmethod-old-method warning))
1453 (old-location (sb!pcl::definition-source old-method))
1454 (old-namestring (when old-location
1455 (sb!c:definition-source-location-namestring old-location)))
1456 (new-location (redefinition-warning-new-location warning))
1457 (new-namestring (when new-location
1458 (sb!c:definition-source-location-namestring new-location))))
1461 (string= new-namestring old-namestring)))))
1463 (deftype uninteresting-redefinition ()
1464 '(or (satisfies uninteresting-ordinary-function-redefinition-p)
1465 (satisfies uninteresting-macro-redefinition-p)
1466 (satisfies uninteresting-generic-function-redefinition-p)
1467 (satisfies uninteresting-method-redefinition-p)))
1469 (define-condition redefinition-with-deftransform (redefinition-warning)
1470 ((transform :initarg :transform
1471 :reader redefinition-with-deftransform-transform))
1472 (:report (lambda (warning stream)
1473 (format stream "Overwriting ~S"
1474 (redefinition-with-deftransform-transform warning)))))
1476 ;;; Various other STYLE-WARNINGS
1477 (define-condition dubious-asterisks-around-variable-name
1478 (style-warning simple-condition)
1480 (:report (lambda (warning stream)
1481 (format stream "~@?, even though the name follows~@
1482 the usual naming convention (names like *FOO*) for special variables"
1483 (simple-condition-format-control warning)
1484 (simple-condition-format-arguments warning)))))
1486 (define-condition asterisks-around-lexical-variable-name
1487 (dubious-asterisks-around-variable-name)
1490 (define-condition asterisks-around-constant-variable-name
1491 (dubious-asterisks-around-variable-name)
1494 ;; We call this UNDEFINED-ALIEN-STYLE-WARNING because there are some
1495 ;; subclasses of ERROR above having to do with undefined aliens.
1496 (define-condition undefined-alien-style-warning (style-warning)
1497 ((symbol :initarg :symbol :reader undefined-alien-symbol))
1498 (:report (lambda (warning stream)
1499 (format stream "Undefined alien: ~S"
1500 (undefined-alien-symbol warning)))))
1503 (define-condition lexical-environment-too-complex (style-warning)
1504 ((form :initarg :form :reader lexical-environment-too-complex-form)
1505 (lexenv :initarg :lexenv :reader lexical-environment-too-complex-lexenv))
1506 (:report (lambda (warning stream)
1508 "~@<Native lexical environment too complex for ~
1509 SB-EVAL to evaluate ~S, falling back to ~
1510 SIMPLE-EVAL-IN-LEXENV. Lexenv: ~S~:@>"
1511 (lexical-environment-too-complex-form warning)
1512 (lexical-environment-too-complex-lexenv warning)))))
1514 ;; Although this has -ERROR- in the name, it's just a STYLE-WARNING.
1515 (define-condition character-decoding-error-in-comment (style-warning)
1516 ((stream :initarg :stream :reader decoding-error-in-comment-stream)
1517 (position :initarg :position :reader decoding-error-in-comment-position))
1518 (:report (lambda (warning stream)
1520 "Character decoding error in a ~A-comment at ~
1521 position ~A reading source stream ~A, ~
1523 (decoding-error-in-comment-macro warning)
1524 (decoding-error-in-comment-position warning)
1525 (decoding-error-in-comment-stream warning)))))
1527 (define-condition character-decoding-error-in-macro-char-comment
1528 (character-decoding-error-in-comment)
1529 ((char :initform #\; :initarg :char
1530 :reader character-decoding-error-in-macro-char-comment-char)))
1532 (define-condition character-decoding-error-in-dispatch-macro-char-comment
1533 (character-decoding-error-in-comment)
1534 ;; ANSI doesn't give a way for a reader function invoked by a
1535 ;; dispatch macro character to determine which dispatch character
1536 ;; was used, so if a user wants to signal one of these from a custom
1537 ;; comment reader, he'll have to supply the :DISP-CHAR himself.
1538 ((disp-char :initform #\# :initarg :disp-char
1539 :reader character-decoding-error-in-macro-char-comment-disp-char)
1540 (sub-char :initarg :sub-char
1541 :reader character-decoding-error-in-macro-char-comment-sub-char)))
1543 (defun decoding-error-in-comment-macro (warning)
1545 (character-decoding-error-in-macro-char-comment
1546 (character-decoding-error-in-macro-char-comment-char warning))
1547 (character-decoding-error-in-dispatch-macro-char-comment
1550 (character-decoding-error-in-macro-char-comment-disp-char warning)
1551 (character-decoding-error-in-macro-char-comment-sub-char warning)))))
1553 (define-condition deprecated-eval-when-situations (style-warning)
1554 ((situations :initarg :situations
1555 :reader deprecated-eval-when-situations-situations))
1556 (:report (lambda (warning stream)
1557 (format stream "using deprecated EVAL-WHEN situation names~{ ~S~}"
1558 (deprecated-eval-when-situations-situations warning)))))
1560 (define-condition proclamation-mismatch (style-warning)
1561 ((name :initarg :name :reader proclamation-mismatch-name)
1562 (old :initarg :old :reader proclamation-mismatch-old)
1563 (new :initarg :new :reader proclamation-mismatch-new)))
1565 (define-condition type-proclamation-mismatch (proclamation-mismatch)
1567 (:report (lambda (warning stream)
1569 "The new TYPE proclamation~% ~S for ~S does not ~
1570 match the old TYPE proclamation ~S"
1571 (proclamation-mismatch-new warning)
1572 (proclamation-mismatch-name warning)
1573 (proclamation-mismatch-old warning)))))
1575 (define-condition ftype-proclamation-mismatch (proclamation-mismatch)
1577 (:report (lambda (warning stream)
1579 "The new FTYPE proclamation~% ~S for ~S does not ~
1580 match the old FTYPE proclamation ~S"
1581 (proclamation-mismatch-new warning)
1582 (proclamation-mismatch-name warning)
1583 (proclamation-mismatch-old warning)))))
1585 ;;;; deprecation conditions
1587 (define-condition deprecation-condition ()
1588 ((name :initarg :name :reader deprecated-name)
1589 (replacements :initarg :replacements :reader deprecated-name-replacements)
1590 (since :initarg :since :reader deprecated-since)
1591 (runtime-error :initarg :runtime-error :reader deprecated-name-runtime-error)))
1593 (def!method print-object ((condition deprecation-condition) stream)
1594 (let ((*package* (find-package :keyword)))
1596 (print-unreadable-object (condition stream :type t)
1598 stream "~S is deprecated.~
1599 ~#[~; Use ~S instead.~; ~
1600 Use ~S or ~S instead.~:; ~
1601 Use~@{~#[~; or~] ~S~^,~} instead.~]"
1602 (deprecated-name condition)
1603 (deprecated-name-replacements condition)))
1605 stream "~@<~S has been deprecated as of SBCL ~A.~
1606 ~#[~; Use ~S instead.~; ~
1607 Use ~S or ~S instead.~:; ~
1608 Use~@{~#[~; or~] ~S~^,~:_~} instead.~]~:@>"
1609 (deprecated-name condition)
1610 (deprecated-since condition)
1611 (deprecated-name-replacements condition)))))
1613 (define-condition early-deprecation-warning (style-warning deprecation-condition)
1616 (def!method print-object :after ((warning early-deprecation-warning) stream)
1617 (unless *print-escape*
1618 (let ((*package* (find-package :keyword)))
1619 (format stream "~%~@<~:@_In future SBCL versions ~S will signal a full warning ~
1620 at compile-time.~:@>"
1621 (deprecated-name warning)))))
1623 (define-condition late-deprecation-warning (warning deprecation-condition)
1626 (def!method print-object :after ((warning late-deprecation-warning) stream)
1627 (unless *print-escape*
1628 (when (deprecated-name-runtime-error warning)
1629 (let ((*package* (find-package :keyword)))
1630 (format stream "~%~@<~:@_In future SBCL versions ~S will signal a runtime error.~:@>"
1631 (deprecated-name warning))))))
1633 (define-condition final-deprecation-warning (warning deprecation-condition)
1636 (def!method print-object :after ((warning final-deprecation-warning) stream)
1637 (unless *print-escape*
1638 (when (deprecated-name-runtime-error warning)
1639 (let ((*package* (find-package :keyword)))
1640 (format stream "~%~@<~:@_An error will be signaled at runtime for ~S.~:@>"
1641 (deprecated-name warning))))))
1643 (define-condition deprecation-error (error deprecation-condition)
1646 ;;;; restart definitions
1648 (define-condition abort-failure (control-error) ()
1650 "An ABORT restart was found that failed to transfer control dynamically."))
1652 (defun abort (&optional condition)
1654 "Transfer control to a restart named ABORT, signalling a CONTROL-ERROR if
1656 (invoke-restart (find-restart-or-control-error 'abort condition))
1657 ;; ABORT signals an error in case there was a restart named ABORT
1658 ;; that did not transfer control dynamically. This could happen with
1660 (error 'abort-failure))
1662 (defun muffle-warning (&optional condition)
1664 "Transfer control to a restart named MUFFLE-WARNING, signalling a
1665 CONTROL-ERROR if none exists."
1666 (invoke-restart (find-restart-or-control-error 'muffle-warning condition)))
1668 (defun try-restart (name condition &rest arguments)
1669 (let ((restart (find-restart name condition)))
1671 (apply #'invoke-restart restart arguments))))
1673 (macrolet ((define-nil-returning-restart (name args doc)
1674 #!-sb-doc (declare (ignore doc))
1675 `(defun ,name (,@args &optional condition)
1677 (try-restart ',name condition ,@args))))
1678 (define-nil-returning-restart continue ()
1679 "Transfer control to a restart named CONTINUE, or return NIL if none exists.")
1680 (define-nil-returning-restart store-value (value)
1681 "Transfer control and VALUE to a restart named STORE-VALUE, or
1682 return NIL if none exists.")
1683 (define-nil-returning-restart use-value (value)
1684 "Transfer control and VALUE to a restart named USE-VALUE, or
1685 return NIL if none exists.")
1686 (define-nil-returning-restart print-unreadably ()
1687 "Transfer control to a restart named SB-EXT:PRINT-UNREADABLY, or
1688 return NIL if none exists."))
1690 ;;; single-stepping restarts
1692 (macrolet ((def (name doc)
1693 #!-sb-doc (declare (ignore doc))
1694 `(defun ,name (condition)
1696 (invoke-restart (find-restart-or-control-error ',name condition)))))
1698 "Transfers control to the STEP-CONTINUE restart associated with
1699 the condition, continuing execution without stepping. Signals a
1700 CONTROL-ERROR if the restart does not exist.")
1702 "Transfers control to the STEP-NEXT restart associated with the
1703 condition, executing the current form without stepping and continuing
1704 stepping with the next form. Signals CONTROL-ERROR is the restart does
1707 "Transfers control to the STEP-INTO restart associated with the
1708 condition, stepping into the current form. Signals a CONTROL-ERROR is
1709 the restart does not exist."))
1711 ;;; Compiler macro magic
1713 (define-condition compiler-macro-keyword-problem ()
1714 ((argument :initarg :argument :reader compiler-macro-keyword-argument))
1715 (:report (lambda (condition stream)
1716 (format stream "~@<Argument ~S in keyword position is not ~
1717 a self-evaluating symbol, preventing compiler-macro ~
1719 (compiler-macro-keyword-argument condition)))))
1721 (/show0 "condition.lisp end of file")