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 slot-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 alternating initargs and initforms
35 (default-initargs () :type list)
36 ;; class precedence list as a list of CLASS objects, with all
37 ;; non-CONDITION classes removed
39 ;; a list of all the effective instance allocation slots of this
40 ;; class that have a non-constant initform or default-initarg.
41 ;; Values for these slots must be computed in the dynamic
42 ;; environment of MAKE-CONDITION.
43 (hairy-slots nil :type list))
45 (/show0 "condition.lisp 49")
49 (!defstruct-with-alternate-metaclass condition
50 :slot-names (actual-initargs assigned-slots)
51 :boa-constructor %make-condition-object
52 :superclass-name instance
53 :metaclass-name condition-classoid
54 :metaclass-constructor make-condition-classoid
57 (defun make-condition-object (actual-initargs)
58 (%make-condition-object actual-initargs nil))
60 (defstruct (condition-slot (:copier nil))
61 (name (missing-arg) :type symbol)
62 ;; list of all applicable initargs
63 (initargs (missing-arg) :type list)
64 ;; names of reader and writer functions
65 (readers (missing-arg) :type list)
66 (writers (missing-arg) :type list)
67 ;; true if :INITFORM was specified
68 (initform-p (missing-arg) :type (member t nil))
69 ;; If this is a function, call it with no args. Otherwise, it's the
71 (initform (missing-arg) :type t)
72 ;; allocation of this slot, or NIL until defaulted
73 (allocation nil :type (member :instance :class nil))
74 ;; If ALLOCATION is :CLASS, this is a cons whose car holds the value.
75 (cell nil :type (or cons null))
77 (documentation nil :type (or string null)))
79 ;;; KLUDGE: It's not clear to me why CONDITION-CLASS has itself listed
80 ;;; in its CPL, while other classes derived from CONDITION-CLASS don't
81 ;;; have themselves listed in their CPLs. This behavior is inherited
82 ;;; from CMU CL, and didn't seem to be explained there, and I haven't
83 ;;; figured out whether it's right. -- WHN 19990612
84 (eval-when (:compile-toplevel :load-toplevel :execute)
85 (/show0 "condition.lisp 103")
86 (let ((condition-class (locally
87 ;; KLUDGE: There's a DEFTRANSFORM
88 ;; FIND-CLASSOID for constant class names
89 ;; which creates fast but
90 ;; non-cold-loadable, non-compact code. In
91 ;; this context, we'd rather have compact,
92 ;; cold-loadable code. -- WHN 19990928
93 (declare (notinline find-classoid))
94 (find-classoid 'condition))))
95 (setf (condition-classoid-cpl condition-class)
96 (list condition-class)))
97 (/show0 "condition.lisp 103"))
99 (setf (condition-classoid-report (locally
100 ;; KLUDGE: There's a DEFTRANSFORM
101 ;; FIND-CLASSOID for constant class
102 ;; names which creates fast but
103 ;; non-cold-loadable, non-compact
104 ;; code. In this context, we'd
105 ;; rather have compact,
106 ;; cold-loadable code. -- WHN
108 (declare (notinline find-classoid))
109 (find-classoid 'condition)))
110 (lambda (cond stream)
111 (format stream "Condition ~S was signalled." (type-of cond))))
113 (eval-when (:compile-toplevel :load-toplevel :execute)
115 (defun find-condition-layout (name parent-types)
116 (let* ((cpl (remove-duplicates
120 (condition-classoid-cpl
123 (cond-layout (info :type :compiler-layout 'condition))
124 (olayout (info :type :compiler-layout name))
125 ;; FIXME: Does this do the right thing in case of multiple
126 ;; inheritance? A quick look at DEFINE-CONDITION didn't make
127 ;; it obvious what ANSI intends to be done in the case of
128 ;; multiple inheritance, so it's not actually clear what the
131 (order-layout-inherits (concatenate 'simple-vector
132 (layout-inherits cond-layout)
133 (mapcar #'classoid-layout cpl)))))
135 (not (mismatch (layout-inherits olayout) new-inherits)))
137 (make-layout :classoid (make-undefined-classoid name)
138 :inherits new-inherits
140 :length (layout-length cond-layout)))))
144 ;;; FIXME: ANSI's definition of DEFINE-CONDITION says
145 ;;; Condition reporting is mediated through the PRINT-OBJECT method
146 ;;; for the condition type in question, with *PRINT-ESCAPE* always
147 ;;; being nil. Specifying (:REPORT REPORT-NAME) in the definition of
148 ;;; a condition type C is equivalent to:
149 ;;; (defmethod print-object ((x c) stream)
150 ;;; (if *print-escape* (call-next-method) (report-name x stream)))
151 ;;; The current code doesn't seem to quite match that.
152 (def!method print-object ((x condition) stream)
154 (print-unreadable-object (x stream :type t :identity t))
155 ;; KLUDGE: A comment from CMU CL here said
156 ;; 7/13/98 BUG? CPL is not sorted and results here depend on order of
157 ;; superclasses in define-condition call!
158 (dolist (class (condition-classoid-cpl (classoid-of x))
159 (error "no REPORT? shouldn't happen!"))
160 (let ((report (condition-classoid-report class)))
162 (return (funcall report x stream)))))))
164 ;;;; slots of CONDITION objects
166 (defvar *empty-condition-slot* '(empty))
168 (defun find-slot-default (class slot)
169 (let ((initargs (condition-slot-initargs slot))
170 (cpl (condition-classoid-cpl class)))
172 (let ((default-initargs (condition-classoid-default-initargs class)))
173 (dolist (initarg initargs)
174 (let ((val (getf default-initargs initarg *empty-condition-slot*)))
175 (unless (eq val *empty-condition-slot*)
176 (return-from find-slot-default
181 (if (condition-slot-initform-p slot)
182 (let ((initform (condition-slot-initform slot)))
183 (if (functionp initform)
186 (error "unbound condition slot: ~S" (condition-slot-name slot)))))
188 (defun find-condition-class-slot (condition-class slot-name)
190 (condition-classoid-cpl condition-class)
191 (error "There is no slot named ~S in ~S."
192 slot-name condition-class))
193 (dolist (slot (condition-classoid-slots sclass))
194 (when (eq (condition-slot-name slot) slot-name)
195 (return-from find-condition-class-slot slot)))))
197 (defun condition-writer-function (condition new-value name)
198 (dolist (cslot (condition-classoid-class-slots
199 (layout-classoid (%instance-layout condition)))
200 (setf (getf (condition-assigned-slots condition) name)
202 (when (eq (condition-slot-name cslot) name)
203 (return (setf (car (condition-slot-cell cslot)) new-value)))))
205 (defun condition-reader-function (condition name)
206 (let ((class (layout-classoid (%instance-layout condition))))
207 (dolist (cslot (condition-classoid-class-slots class))
208 (when (eq (condition-slot-name cslot) name)
209 (return-from condition-reader-function
210 (car (condition-slot-cell cslot)))))
211 (let ((val (getf (condition-assigned-slots condition) name
212 *empty-condition-slot*)))
213 (if (eq val *empty-condition-slot*)
214 (let ((actual-initargs (condition-actual-initargs condition))
215 (slot (find-condition-class-slot class name)))
217 (error "missing slot ~S of ~S" name condition))
218 (do ((initargs actual-initargs (cddr initargs)))
220 (setf (getf (condition-assigned-slots condition) name)
221 (find-slot-default class slot)))
222 (when (member (car initargs) (condition-slot-initargs slot))
223 (return-from condition-reader-function
224 (setf (getf (condition-assigned-slots condition)
231 (defun make-condition (thing &rest args)
233 "Make an instance of a condition object using the specified initargs."
234 ;; Note: ANSI specifies no exceptional situations in this function.
235 ;; signalling simple-type-error would not be wrong.
236 (let* ((thing (or (and (symbolp thing) (find-classoid thing nil))
238 (class (typecase thing
239 (condition-classoid thing)
241 (error 'simple-type-error
243 :expected-type 'condition-class
244 :format-control "~S is not a condition class."
245 :format-arguments (list thing)))
247 (error 'simple-type-error
249 :expected-type 'condition-class
250 :format-control "bad thing for class argument:~% ~S"
251 :format-arguments (list thing)))))
252 (res (make-condition-object args)))
253 (setf (%instance-layout res) (classoid-layout class))
254 ;; Set any class slots with initargs present in this call.
255 (dolist (cslot (condition-classoid-class-slots class))
256 (dolist (initarg (condition-slot-initargs cslot))
257 (let ((val (getf args initarg *empty-condition-slot*)))
258 (unless (eq val *empty-condition-slot*)
259 (setf (car (condition-slot-cell cslot)) val)))))
260 ;; Default any slots with non-constant defaults now.
261 (dolist (hslot (condition-classoid-hairy-slots class))
262 (when (dolist (initarg (condition-slot-initargs hslot) t)
263 (unless (eq (getf args initarg *empty-condition-slot*)
264 *empty-condition-slot*)
266 (setf (getf (condition-assigned-slots res) (condition-slot-name hslot))
267 (find-slot-default class hslot))))
270 ;;;; DEFINE-CONDITION
272 (eval-when (:compile-toplevel :load-toplevel :execute)
273 (defun %compiler-define-condition (name direct-supers layout
274 all-readers all-writers)
275 (with-single-package-locked-error
276 (:symbol name "defining ~A as a condition")
277 (sb!xc:proclaim `(ftype (function (t) t) ,@all-readers))
278 (sb!xc:proclaim `(ftype (function (t t) t) ,@all-writers))
279 (multiple-value-bind (class old-layout)
280 (insured-find-classoid name
281 #'condition-classoid-p
282 #'make-condition-classoid)
283 (setf (layout-classoid layout) class)
284 (setf (classoid-direct-superclasses class)
285 (mapcar #'find-classoid direct-supers))
286 (cond ((not old-layout)
287 (register-layout layout))
288 ((not *type-system-initialized*)
289 (setf (layout-classoid old-layout) class)
290 (setq layout old-layout)
291 (unless (eq (classoid-layout class) layout)
292 (register-layout layout)))
293 ((redefine-layout-warning "current"
296 (layout-length layout)
297 (layout-inherits layout)
298 (layout-depthoid layout))
299 (register-layout layout :invalidate t))
300 ((not (classoid-layout class))
301 (register-layout layout)))
303 (setf (layout-info layout)
305 ;; KLUDGE: There's a FIND-CLASS DEFTRANSFORM for constant class
306 ;; names which creates fast but non-cold-loadable, non-compact
307 ;; code. In this context, we'd rather have compact, cold-loadable
308 ;; code. -- WHN 19990928
309 (declare (notinline find-classoid))
310 (layout-info (classoid-layout (find-classoid 'condition)))))
312 (setf (find-classoid name) class)
314 ;; Initialize CPL slot.
315 (setf (condition-classoid-cpl class)
316 (remove-if-not #'condition-classoid-p
317 (std-compute-class-precedence-list class)))))
321 ;;; Compute the effective slots of CLASS, copying inherited slots and
322 ;;; destructively modifying direct slots.
324 ;;; FIXME: It'd be nice to explain why it's OK to destructively modify
325 ;;; direct slots. Presumably it follows from the semantics of
326 ;;; inheritance and redefinition of conditions, but finding the cite
327 ;;; and documenting it here would be good. (Or, if this is not in fact
328 ;;; ANSI-compliant, fixing it would also be good.:-)
329 (defun compute-effective-slots (class)
330 (collect ((res (copy-list (condition-classoid-slots class))))
331 (dolist (sclass (cdr (condition-classoid-cpl class)))
332 (dolist (sslot (condition-classoid-slots sclass))
333 (let ((found (find (condition-slot-name sslot) (res)
334 :key #'condition-slot-name)))
336 (setf (condition-slot-initargs found)
337 (union (condition-slot-initargs found)
338 (condition-slot-initargs sslot)))
339 (unless (condition-slot-initform-p found)
340 (setf (condition-slot-initform-p found)
341 (condition-slot-initform-p sslot))
342 (setf (condition-slot-initform found)
343 (condition-slot-initform sslot)))
344 (unless (condition-slot-allocation found)
345 (setf (condition-slot-allocation found)
346 (condition-slot-allocation sslot))))
348 (res (copy-structure sslot)))))))
351 ;;; Early definitions of slot accessor creators.
353 ;;; Slot accessors must be generic functions, but ANSI does not seem
354 ;;; to specify any of them, and we cannot support it before end of
355 ;;; warm init. So we use ordinary functions inside SBCL, and switch to
356 ;;; GFs only at the end of building.
357 (declaim (notinline install-condition-slot-reader
358 install-condition-slot-writer))
359 (defun install-condition-slot-reader (name condition slot-name)
360 (declare (ignore condition))
361 (setf (fdefinition name)
363 (condition-reader-function condition slot-name))))
364 (defun install-condition-slot-writer (name condition slot-name)
365 (declare (ignore condition))
366 (setf (fdefinition name)
367 (lambda (new-value condition)
368 (condition-writer-function condition new-value slot-name))))
370 (defun %define-condition (name parent-types layout slots documentation
371 report default-initargs all-readers all-writers)
372 (with-single-package-locked-error
373 (:symbol name "defining ~A as a condition")
374 (%compiler-define-condition name parent-types layout all-readers all-writers)
375 (let ((class (find-classoid name)))
376 (setf (condition-classoid-slots class) slots)
377 (setf (condition-classoid-report class) report)
378 (setf (condition-classoid-default-initargs class) default-initargs)
379 (setf (fdocumentation name 'type) documentation)
383 ;; Set up reader and writer functions.
384 (let ((slot-name (condition-slot-name slot)))
385 (dolist (reader (condition-slot-readers slot))
386 (install-condition-slot-reader reader name slot-name))
387 (dolist (writer (condition-slot-writers slot))
388 (install-condition-slot-writer writer name slot-name))))
390 ;; Compute effective slots and set up the class and hairy slots
391 ;; (subsets of the effective slots.)
392 (let ((eslots (compute-effective-slots class))
395 (mapcar #'condition-classoid-default-initargs
396 (condition-classoid-cpl class)))))
397 (dolist (slot eslots)
398 (ecase (condition-slot-allocation slot)
400 (unless (condition-slot-cell slot)
401 (setf (condition-slot-cell slot)
402 (list (if (condition-slot-initform-p slot)
403 (let ((initform (condition-slot-initform slot)))
404 (if (functionp initform)
407 *empty-condition-slot*))))
408 (push slot (condition-classoid-class-slots class)))
410 (setf (condition-slot-allocation slot) :instance)
411 (when (or (functionp (condition-slot-initform slot))
412 (dolist (initarg (condition-slot-initargs slot) nil)
413 (when (functionp (getf e-def-initargs initarg))
415 (push slot (condition-classoid-hairy-slots class))))))))
418 (defmacro define-condition (name (&rest parent-types) (&rest slot-specs)
421 "DEFINE-CONDITION Name (Parent-Type*) (Slot-Spec*) Option*
422 Define NAME as a condition type. This new type inherits slots and its
423 report function from the specified PARENT-TYPEs. A slot spec is a list of:
424 (slot-name :reader <rname> :initarg <iname> {Option Value}*
426 The DEFINE-CLASS slot options :ALLOCATION, :INITFORM, [slot] :DOCUMENTATION
427 and :TYPE and the overall options :DEFAULT-INITARGS and
428 [type] :DOCUMENTATION are also allowed.
430 The :REPORT option is peculiar to DEFINE-CONDITION. Its argument is either
431 a string or a two-argument lambda or function name. If a function, the
432 function is called with the condition and stream to report the condition.
433 If a string, the string is printed.
435 Condition types are classes, but (as allowed by ANSI and not as described in
436 CLtL2) are neither STANDARD-OBJECTs nor STRUCTURE-OBJECTs. WITH-SLOTS and
437 SLOT-VALUE may not be used on condition objects."
438 (let* ((parent-types (or parent-types '(condition)))
439 (layout (find-condition-layout name parent-types))
442 (default-initargs ()))
444 (all-readers nil append)
445 (all-writers nil append))
446 (dolist (spec slot-specs)
447 (when (keywordp spec)
448 (warn "Keyword slot name indicates probable syntax error:~% ~S"
450 (let* ((spec (if (consp spec) spec (list spec)))
451 (slot-name (first spec))
452 (allocation :instance)
459 (do ((options (rest spec) (cddr options)))
461 (unless (and (consp options) (consp (cdr options)))
462 (error "malformed condition slot spec:~% ~S." spec))
463 (let ((arg (second options)))
464 (case (first options)
465 (:reader (readers arg))
466 (:writer (writers arg))
469 (writers `(setf ,arg)))
472 (error "more than one :INITFORM in ~S" spec))
475 (:initarg (initargs arg))
477 (setq allocation arg))
480 (error "more than one :DOCUMENTATION in ~S" spec))
481 (unless (stringp arg)
482 (error "slot :DOCUMENTATION argument is not a string: ~S"
484 (setq documentation arg))
487 (error "unknown slot option:~% ~S" (first options))))))
489 (all-readers (readers))
490 (all-writers (writers))
491 (slots `(make-condition-slot
493 :initargs ',(initargs)
496 :initform-p ',initform-p
497 :documentation ',documentation
499 ,(if (constantp initform)
501 `#'(lambda () ,initform)))))))
503 (dolist (option options)
504 (unless (consp option)
505 (error "bad option:~% ~S" option))
507 (:documentation (setq documentation (second option)))
509 (let ((arg (second option)))
512 `#'(lambda (condition stream)
513 (declare (ignore condition))
514 (write-string ,arg stream))
515 `#'(lambda (condition stream)
516 (funcall #',arg condition stream))))))
518 (do ((initargs (rest option) (cddr initargs)))
520 (let ((val (second initargs)))
521 (setq default-initargs
522 (list* `',(first initargs)
526 default-initargs)))))
528 (error "unknown option: ~S" (first option)))))
531 (eval-when (:compile-toplevel)
532 (%compiler-define-condition ',name ',parent-types ',layout
533 ',(all-readers) ',(all-writers)))
534 (eval-when (:load-toplevel :execute)
535 (%define-condition ',name
541 (list ,@default-initargs)
543 ',(all-writers)))))))
545 ;;;; DESCRIBE on CONDITIONs
547 ;;; a function to be used as the guts of DESCRIBE-OBJECT (CONDITION T)
548 ;;; eventually (once we get CLOS up and running so that we can define
550 (defun describe-condition (condition stream)
552 "~&~@<~S ~_is a ~S. ~_Its slot values are ~_~S.~:>~%"
556 (condition-actual-initargs condition)
557 (condition-assigned-slots condition))))
559 ;;;; various CONDITIONs specified by ANSI
561 (define-condition serious-condition (condition) ())
563 (define-condition error (serious-condition) ())
565 (define-condition warning (condition) ())
566 (define-condition style-warning (warning) ())
568 (defun simple-condition-printer (condition stream)
571 (simple-condition-format-control condition)
572 (simple-condition-format-arguments condition)))
574 (define-condition simple-condition ()
575 ((format-control :reader simple-condition-format-control
576 :initarg :format-control
577 :type format-control)
578 (format-arguments :reader simple-condition-format-arguments
579 :initarg :format-arguments
582 (:report simple-condition-printer))
584 (define-condition simple-warning (simple-condition warning) ())
586 (define-condition simple-error (simple-condition error) ())
588 ;;; not specified by ANSI, but too useful not to have around.
589 (define-condition simple-style-warning (simple-condition style-warning) ())
591 (define-condition storage-condition (serious-condition) ())
593 (define-condition type-error (error)
594 ((datum :reader type-error-datum :initarg :datum)
595 (expected-type :reader type-error-expected-type :initarg :expected-type))
597 (lambda (condition stream)
599 "~@<The value ~2I~:_~S ~I~_is not of type ~2I~_~S.~:>"
600 (type-error-datum condition)
601 (type-error-expected-type condition)))))
603 (define-condition simple-type-error (simple-condition type-error) ())
605 (define-condition program-error (error) ())
606 (define-condition parse-error (error) ())
607 (define-condition control-error (error) ())
608 (define-condition stream-error (error)
609 ((stream :reader stream-error-stream :initarg :stream)))
611 (define-condition end-of-file (stream-error) ()
613 (lambda (condition stream)
616 (stream-error-stream condition)))))
618 (define-condition file-error (error)
619 ((pathname :reader file-error-pathname :initarg :pathname))
621 (lambda (condition stream)
622 (format stream "error on file ~S" (file-error-pathname condition)))))
624 (define-condition package-error (error)
625 ((package :reader package-error-package :initarg :package)))
627 (define-condition cell-error (error)
628 ((name :reader cell-error-name :initarg :name)))
630 (define-condition unbound-variable (cell-error) ()
632 (lambda (condition stream)
634 "The variable ~S is unbound."
635 (cell-error-name condition)))))
637 (define-condition undefined-function (cell-error) ()
639 (lambda (condition stream)
641 "The function ~S is undefined."
642 (cell-error-name condition)))))
644 (define-condition special-form-function (undefined-function) ()
646 (lambda (condition stream)
648 "Cannot FUNCALL the SYMBOL-FUNCTION of special operator ~S."
649 (cell-error-name condition)))))
651 (define-condition arithmetic-error (error)
652 ((operation :reader arithmetic-error-operation
655 (operands :reader arithmetic-error-operands
657 (:report (lambda (condition stream)
659 "arithmetic error ~S signalled"
661 (when (arithmetic-error-operation condition)
663 "~%Operation was ~S, operands ~S."
664 (arithmetic-error-operation condition)
665 (arithmetic-error-operands condition))))))
667 (define-condition division-by-zero (arithmetic-error) ())
668 (define-condition floating-point-overflow (arithmetic-error) ())
669 (define-condition floating-point-underflow (arithmetic-error) ())
670 (define-condition floating-point-inexact (arithmetic-error) ())
671 (define-condition floating-point-invalid-operation (arithmetic-error) ())
673 (define-condition print-not-readable (error)
674 ((object :reader print-not-readable-object :initarg :object))
676 (lambda (condition stream)
677 (let ((obj (print-not-readable-object condition))
679 (format stream "~S cannot be printed readably." obj)))))
681 (define-condition reader-error (parse-error stream-error)
683 :reader reader-error-format-control
684 :initarg :format-control)
686 :reader reader-error-format-arguments
687 :initarg :format-arguments
690 (lambda (condition stream)
691 (let* ((error-stream (stream-error-stream condition))
692 (pos (file-position error-stream)))
695 (< pos sb!xc:array-dimension-limit)
696 ;; KLUDGE: lseek() (which is what FILE-POSITION
697 ;; reduces to on file-streams) is undefined on
698 ;; "some devices", which in practice means that it
699 ;; can claim to succeed on /dev/stdin on Darwin
700 ;; and Solaris. This is obviously bad news,
701 ;; because the READ-SEQUENCE below will then
702 ;; block, not complete, and the report will never
703 ;; be printed. As a workaround, we exclude
704 ;; interactive streams from this attempt to report
705 ;; positions. -- CSR, 2003-08-21
706 (not (interactive-stream-p error-stream))
707 (file-position error-stream :start))
710 :element-type (stream-element-type error-stream))))
711 (when (= pos (read-sequence string error-stream))
712 (setq lineno (1+ (count #\Newline string))
714 (or (position #\Newline string :from-end t) -1)
716 (file-position error-stream pos))
718 "READER-ERROR ~@[at ~W ~]~
719 ~@[(line ~W~]~@[, column ~W) ~]~
721 pos lineno colno error-stream
722 (reader-error-format-control condition)
723 (reader-error-format-arguments condition)))))))
725 ;;;; special SBCL extension conditions
727 ;;; an error apparently caused by a bug in SBCL itself
729 ;;; Note that we don't make any serious effort to use this condition
730 ;;; for *all* errors in SBCL itself. E.g. type errors and array
731 ;;; indexing errors can occur in functions called from SBCL code, and
732 ;;; will just end up as ordinary TYPE-ERROR or invalid index error,
733 ;;; because the signalling code has no good way to know that the
734 ;;; underlying problem is a bug in SBCL. But in the fairly common case
735 ;;; that the signalling code does know that it's found a bug in SBCL,
736 ;;; this condition is appropriate, reusing boilerplate and helping
737 ;;; users to recognize it as an SBCL bug.
738 (define-condition bug (simple-error)
741 (lambda (condition stream)
744 (simple-condition-format-control condition)
745 (simple-condition-format-arguments condition)
746 "~@<This is probably a bug in SBCL itself. (Alternatively, ~
747 SBCL might have been corrupted by bad user code, e.g. by an ~
748 undefined Lisp operation like ~S, or by stray pointers from ~
749 alien code or from unsafe Lisp code; or there might be a bug ~
750 in the OS or hardware that SBCL is running on.) If it seems to ~
751 be a bug in SBCL itself, the maintainers would like to know ~
752 about it. Bug reports are welcome on the SBCL ~
753 mailing lists, which you can find at ~
754 <http://sbcl.sourceforge.net/>.~:@>"
755 '((fmakunbound 'compile))))))
757 ;;; a condition for use in stubs for operations which aren't supported
758 ;;; on some platforms
760 ;;; E.g. in sbcl-0.7.0.5, it might be appropriate to do something like
761 ;;; #-(or freebsd linux)
762 ;;; (defun load-foreign (&rest rest)
763 ;;; (error 'unsupported-operator :name 'load-foreign))
764 ;;; #+(or freebsd linux)
765 ;;; (defun load-foreign ... actual definition ...)
766 ;;; By signalling a standard condition in this case, we make it
767 ;;; possible for test code to distinguish between (1) intentionally
768 ;;; unimplemented and (2) unintentionally just screwed up somehow.
769 ;;; (Before this condition was defined, test code tried to deal with
770 ;;; this by checking for FBOUNDP, but that didn't work reliably. In
771 ;;; sbcl-0.7.0, a a package screwup left the definition of
772 ;;; LOAD-FOREIGN in the wrong package, so it was unFBOUNDP even on
773 ;;; architectures where it was supposed to be supported, and the
774 ;;; regression tests cheerfully passed because they assumed that
775 ;;; unFBOUNDPness meant they were running on an system which didn't
776 ;;; support the extension.)
777 (define-condition unsupported-operator (simple-error) ())
780 ;;; (:ansi-cl :function remove)
781 ;;; (:ansi-cl :section (a b c))
782 ;;; (:ansi-cl :glossary "similar")
784 ;;; (:sbcl :node "...")
785 ;;; (:sbcl :variable *ed-functions*)
787 ;;; FIXME: this is not the right place for this.
788 (defun print-reference (reference stream)
789 (ecase (car reference)
791 (format stream "AMOP")
793 (destructuring-bind (type data) (cdr reference)
795 (:generic-function (format stream "Generic Function ~S" data))
796 (:section (format stream "Section ~{~D~^.~}" data)))))
798 (format stream "The ANSI Standard")
800 (destructuring-bind (type data) (cdr reference)
802 (:function (format stream "Function ~S" data))
803 (:special-operator (format stream "Special Operator ~S" data))
804 (:macro (format stream "Macro ~S" data))
805 (:section (format stream "Section ~{~D~^.~}" data))
806 (:glossary (format stream "Glossary entry for ~S" data))
807 (:issue (format stream "writeup for Issue ~A" data)))))
809 (format stream "The SBCL Manual")
811 (destructuring-bind (type data) (cdr reference)
813 (:node (format stream "Node ~S" data))
814 (:variable (format stream "Variable ~S" data))
815 (:function (format stream "Function ~S" data)))))
816 ;; FIXME: other documents (e.g. CLIM, Franz documentation :-)
818 (define-condition reference-condition ()
819 ((references :initarg :references :reader reference-condition-references)))
820 (defvar *print-condition-references* t)
821 (def!method print-object :around ((o reference-condition) s)
823 (unless (or *print-escape* *print-readably*)
824 (when (and *print-condition-references*
825 (reference-condition-references o))
826 (format s "~&See also:~%")
827 (pprint-logical-block (s nil :per-line-prefix " ")
828 (do* ((rs (reference-condition-references o) (cdr rs))
829 (r (car rs) (car rs)))
831 (print-reference r s)
832 (unless (null (cdr rs))
835 (define-condition duplicate-definition (reference-condition warning)
836 ((name :initarg :name :reader duplicate-definition-name))
837 (:report (lambda (c s)
838 (format s "~@<Duplicate definition for ~S found in ~
840 (duplicate-definition-name c))))
841 (:default-initargs :references (list '(:ansi-cl :section (3 2 2 3)))))
843 (define-condition package-at-variance (reference-condition simple-warning)
845 (:default-initargs :references (list '(:ansi-cl :macro defpackage))))
847 (define-condition defconstant-uneql (reference-condition error)
848 ((name :initarg :name :reader defconstant-uneql-name)
849 (old-value :initarg :old-value :reader defconstant-uneql-old-value)
850 (new-value :initarg :new-value :reader defconstant-uneql-new-value))
852 (lambda (condition stream)
854 "~@<The constant ~S is being redefined (from ~S to ~S)~@:>"
855 (defconstant-uneql-name condition)
856 (defconstant-uneql-old-value condition)
857 (defconstant-uneql-new-value condition))))
858 (:default-initargs :references (list '(:ansi-cl :macro defconstant)
859 '(:sbcl :node "Idiosyncrasies"))))
861 (define-condition array-initial-element-mismatch
862 (reference-condition simple-warning)
866 '(:ansi-cl :function make-array)
867 '(:ansi-cl :function sb!xc:upgraded-array-element-type))))
869 (define-condition displaced-to-array-too-small-error
870 (reference-condition simple-error)
873 :references (list '(:ansi-cl :function adjust-array))))
875 (define-condition type-warning (reference-condition simple-warning)
877 (:default-initargs :references (list '(:sbcl :node "Handling of Types"))))
879 (define-condition local-argument-mismatch (reference-condition simple-warning)
881 (:default-initargs :references (list '(:ansi-cl :section (3 2 2 3)))))
883 (define-condition format-args-mismatch (reference-condition)
885 (:default-initargs :references (list '(:ansi-cl :section (22 3 10 2)))))
887 (define-condition format-too-few-args-warning
888 (format-args-mismatch simple-warning)
890 (define-condition format-too-many-args-warning
891 (format-args-mismatch simple-style-warning)
894 (define-condition extension-failure (reference-condition simple-error)
900 (define-condition package-lock-violation (reference-condition package-error)
901 ((format-control :initform nil :initarg :format-control
902 :reader package-error-format-control)
903 (format-arguments :initform nil :initarg :format-arguments
904 :reader package-error-format-arguments))
906 (lambda (condition stream)
907 (let ((control (package-error-format-control condition)))
909 (apply #'format stream
910 (format nil "~~@<Lock on package ~A violated when ~A.~~:@>"
911 (package-name (package-error-package condition))
913 (package-error-format-arguments condition))
914 (format stream "~@<Lock on package ~A violated.~:@>"
915 (package-name (package-error-package condition)))))))
916 ;; no :default-initargs -- reference-stuff provided by the
917 ;; signalling form in target-package.lisp
920 "Subtype of CL:PACKAGE-ERROR. A subtype of this error is signalled
921 when a package-lock is violated."))
923 (define-condition package-locked-error (package-lock-violation) ()
926 "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
927 signalled when an operation on a package violates a package lock."))
929 (define-condition symbol-package-locked-error (package-lock-violation)
930 ((symbol :initarg :symbol :reader package-locked-error-symbol))
933 "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
934 signalled when an operation on a symbol violates a package lock. The
935 symbol that caused the violation is accessed by the function
936 SB-EXT:PACKAGE-LOCKED-ERROR-SYMBOL."))
940 (define-condition undefined-alien-error (error) ()
942 (lambda (condition stream)
943 (declare (ignore condition))
944 (format stream "Attempt to access an undefined alien value."))))
946 ;;;; various other (not specified by ANSI) CONDITIONs
948 ;;;; These might logically belong in other files; they're here, after
949 ;;;; setup of CONDITION machinery, only because that makes it easier to
950 ;;;; get cold init to work.
952 ;;; OAOOM warning: see cross-condition.lisp
953 (define-condition encapsulated-condition (condition)
954 ((condition :initarg :condition :reader encapsulated-condition)))
956 (define-condition values-type-error (type-error)
959 (lambda (condition stream)
961 "~@<The values set ~2I~:_[~{~S~^ ~}] ~I~_is not of type ~2I~_~S.~:>"
962 (type-error-datum condition)
963 (type-error-expected-type condition)))))
965 ;;; KLUDGE: a condition for floating point errors when we can't or
966 ;;; won't figure out what type they are. (In FreeBSD and OpenBSD we
967 ;;; don't know how, at least as of sbcl-0.6.7; in Linux we probably
968 ;;; know how but the old code was broken by the conversion to POSIX
969 ;;; signal handling and hasn't been fixed as of sbcl-0.6.7.)
971 ;;; FIXME: Perhaps this should also be a base class for all
972 ;;; floating point exceptions?
973 (define-condition floating-point-exception (arithmetic-error)
974 ((flags :initarg :traps
976 :reader floating-point-exception-traps))
977 (:report (lambda (condition stream)
979 "An arithmetic error ~S was signalled.~%"
981 (let ((traps (floating-point-exception-traps condition)))
984 "Trapping conditions are: ~%~{ ~S~^~}~%"
987 "No traps are enabled? How can this be?"
990 (define-condition index-too-large-error (type-error)
993 (lambda (condition stream)
995 "The index ~S is too large."
996 (type-error-datum condition)))))
998 (define-condition bounding-indices-bad-error (reference-condition type-error)
999 ((object :reader bounding-indices-bad-object :initarg :object))
1001 (lambda (condition stream)
1002 (let* ((datum (type-error-datum condition))
1005 (object (bounding-indices-bad-object condition)))
1009 "The bounding indices ~S and ~S are bad ~
1010 for a sequence of length ~S."
1011 start end (length object)))
1013 ;; from WITH-ARRAY-DATA
1015 "The START and END parameters ~S and ~S are ~
1016 bad for an array of total size ~S."
1017 start end (array-total-size object)))))))
1020 (list '(:ansi-cl :glossary "bounding index designator")
1021 '(:ansi-cl :issue "SUBSEQ-OUT-OF-BOUNDS:IS-AN-ERROR"))))
1023 (define-condition nil-array-accessed-error (reference-condition type-error)
1025 (:report (lambda (condition stream)
1026 (declare (ignore condition))
1028 "An attempt to access an array of element-type ~
1029 NIL was made. Congratulations!")))
1031 :references (list '(:ansi-cl :function sb!xc:upgraded-array-element-type)
1032 '(:ansi-cl :section (15 1 2 1))
1033 '(:ansi-cl :section (15 1 2 2)))))
1035 (define-condition io-timeout (stream-error)
1036 ((direction :reader io-timeout-direction :initarg :direction))
1038 (lambda (condition stream)
1039 (declare (type stream stream))
1041 "I/O timeout ~(~A~)ing ~S"
1042 (io-timeout-direction condition)
1043 (stream-error-stream condition)))))
1045 (define-condition namestring-parse-error (parse-error)
1046 ((complaint :reader namestring-parse-error-complaint :initarg :complaint)
1047 (args :reader namestring-parse-error-args :initarg :args :initform nil)
1048 (namestring :reader namestring-parse-error-namestring :initarg :namestring)
1049 (offset :reader namestring-parse-error-offset :initarg :offset))
1051 (lambda (condition stream)
1053 "parse error in namestring: ~?~% ~A~% ~V@T^"
1054 (namestring-parse-error-complaint condition)
1055 (namestring-parse-error-args condition)
1056 (namestring-parse-error-namestring condition)
1057 (namestring-parse-error-offset condition)))))
1059 (define-condition simple-package-error (simple-condition package-error) ())
1061 (define-condition reader-package-error (reader-error) ())
1063 (define-condition reader-eof-error (end-of-file)
1064 ((context :reader reader-eof-error-context :initarg :context))
1066 (lambda (condition stream)
1068 "unexpected end of file on ~S ~A"
1069 (stream-error-stream condition)
1070 (reader-eof-error-context condition)))))
1072 (define-condition reader-impossible-number-error (reader-error)
1073 ((error :reader reader-impossible-number-error-error :initarg :error))
1075 (lambda (condition stream)
1076 (let ((error-stream (stream-error-stream condition)))
1077 (format stream "READER-ERROR ~@[at ~W ~]on ~S:~%~?~%Original error: ~A"
1078 (file-position error-stream) error-stream
1079 (reader-error-format-control condition)
1080 (reader-error-format-arguments condition)
1081 (reader-impossible-number-error-error condition))))))
1083 (define-condition timeout (serious-condition) ())
1085 ;;; Single stepping conditions
1087 (define-condition step-condition ()
1088 ((form :initarg :form :reader step-condition-form))
1090 (:documentation "Common base class of single-stepping conditions.
1091 STEP-CONDITION-FORM holds a string representation of the form being
1095 (setf (fdocumentation 'step-condition-form 'function)
1096 "Form associated with the STEP-CONDITION.")
1098 (define-condition step-form-condition (step-condition)
1099 ((source-path :initarg :source-path :reader step-condition-source-path)
1100 (pathname :initarg :pathname :reader step-condition-pathname))
1102 (:documentation "Condition signalled by code compiled with
1103 single-stepping information when about to execute a form.
1104 STEP-CONDITION-FORM holds the form, STEP-CONDITION-PATHNAME holds the
1105 pathname of the original file or NIL, and STEP-CONDITION-SOURCE-PATH
1106 holds the source-path to the original form within that file or NIL.
1107 Associated with this condition are always the restarts STEP-INTO,
1108 STEP-NEXT, and STEP-CONTINUE."))
1111 (setf (fdocumentation 'step-condition-source-path 'function)
1112 "Source-path of the original form associated with the
1113 STEP-FORM-CONDITION or NIL."
1114 (fdocumentation 'step-condition-pathname 'function)
1115 "Pathname of the original source-file associated with the
1116 STEP-FORM-CONDITION or NIL.")
1118 (define-condition step-result-condition (step-condition)
1119 ((result :initarg :result :reader step-condition-result)))
1122 (setf (fdocumentation 'step-condition-result 'function)
1123 "Return values associated with STEP-VALUES-CONDITION as a list,
1124 or the variable value associated with STEP-VARIABLE-CONDITION.")
1126 (define-condition step-values-condition (step-result-condition)
1129 (:documentation "Condition signalled by code compiled with
1130 single-stepping information after executing a form.
1131 STEP-CONDITION-FORM holds the form, and STEP-CONDITION-RESULT holds
1132 the values returned by the form as a list. No associated restarts."))
1134 (define-condition step-variable-condition (step-result-condition)
1137 (:documentation "Condition signalled by code compiled with
1138 single-stepping information when referencing a variable.
1139 STEP-CONDITION-FORM hold the symbol, and STEP-CONDITION-RESULT holds
1140 the value of the variable. No associated restarts."))
1143 ;;;; restart definitions
1145 (define-condition abort-failure (control-error) ()
1147 "An ABORT restart was found that failed to transfer control dynamically."))
1149 (defun abort (&optional condition)
1151 "Transfer control to a restart named ABORT, signalling a CONTROL-ERROR if
1153 (invoke-restart (find-restart-or-control-error 'abort condition))
1154 ;; ABORT signals an error in case there was a restart named ABORT
1155 ;; that did not transfer control dynamically. This could happen with
1157 (error 'abort-failure))
1159 (defun muffle-warning (&optional condition)
1161 "Transfer control to a restart named MUFFLE-WARNING, signalling a
1162 CONTROL-ERROR if none exists."
1163 (invoke-restart (find-restart-or-control-error 'muffle-warning condition)))
1165 (macrolet ((define-nil-returning-restart (name args doc)
1166 #!-sb-doc (declare (ignore doc))
1167 `(defun ,name (,@args &optional condition)
1169 ;; FIXME: Perhaps this shared logic should be pulled out into
1170 ;; FLET MAYBE-INVOKE-RESTART? See whether it shrinks code..
1171 (let ((restart (find-restart ',name condition)))
1173 (invoke-restart restart ,@args))))))
1174 (define-nil-returning-restart continue ()
1175 "Transfer control to a restart named CONTINUE, or return NIL if none exists.")
1176 (define-nil-returning-restart store-value (value)
1177 "Transfer control and VALUE to a restart named STORE-VALUE, or return NIL if
1179 (define-nil-returning-restart use-value (value)
1180 "Transfer control and VALUE to a restart named USE-VALUE, or return NIL if
1183 ;;; single-stepping restarts
1185 (macrolet ((def (name doc)
1186 #!-sb-doc (declare (ignore doc))
1187 `(defun ,name (condition)
1189 (invoke-restart (find-restart-or-control-error ',name condition)))))
1191 "Transfers control to the STEP-CONTINUE restart associated with
1192 the condition, continuing execution without stepping. Signals a
1193 CONTROL-ERROR if the restart does not exist.")
1195 "Transfers control to the STEP-NEXT restart associated with the
1196 condition, executing the current form without stepping and continuing
1197 stepping with the next form. Signals CONTROL-ERROR is the restart does
1200 "Transfers control to the STEP-INTO restart associated with the
1201 condition, stepping into the current form. Signals a CONTROL-ERROR is
1202 the restart does not exist."))
1204 (/show0 "condition.lisp end of file")