0.7.5.15:
[sbcl.git] / src / code / condition.lisp
1 ;;;; stuff originally from CMU CL's error.lisp which can or should
2 ;;;; come late (mostly related to the CONDITION class itself)
3 ;;;;
4
5 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; more information.
7 ;;;;
8 ;;;; This software is derived from the CMU CL system, which was
9 ;;;; written at Carnegie Mellon University and released into the
10 ;;;; public domain. The software is in the public domain and is
11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
12 ;;;; files for more information.
13
14 (in-package "SB!KERNEL")
15 \f
16 ;;;; the CONDITION class
17
18 (/show0 "condition.lisp 20")
19
20 (eval-when (:compile-toplevel :load-toplevel :execute)
21
22 (/show0 "condition.lisp 24")
23
24 (def!struct (condition-class (:include slot-class)
25                              (:constructor bare-make-condition-class))
26   ;; list of CONDITION-SLOT structures for the direct slots of this
27   ;; class
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
38   (cpl () :type list)
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))
44
45 (/show0 "condition.lisp 49")
46
47 (defun make-condition-class (&rest rest)
48   (apply #'bare-make-condition-class
49          (rename-key-args '((:name :%name)) rest)))
50
51 (/show0 "condition.lisp 53")
52
53 ) ; EVAL-WHEN
54
55 (!defstruct-with-alternate-metaclass condition
56   :slot-names (actual-initargs assigned-slots)
57   :boa-constructor %make-condition-object
58   :superclass-name instance
59   :metaclass-name condition-class
60   :metaclass-constructor make-condition-class
61   :dd-type structure)
62
63 (defun make-condition-object (actual-initargs)
64   (%make-condition-object actual-initargs nil))
65
66 (defstruct (condition-slot (:copier nil))
67   (name (missing-arg) :type symbol)
68   ;; list of all applicable initargs
69   (initargs (missing-arg) :type list)
70   ;; names of reader and writer functions
71   (readers (missing-arg) :type list)
72   (writers (missing-arg) :type list)
73   ;; true if :INITFORM was specified
74   (initform-p (missing-arg) :type (member t nil))
75   ;; If this is a function, call it with no args. Otherwise, it's the
76   ;; actual value.
77   (initform (missing-arg) :type t)
78   ;; allocation of this slot, or NIL until defaulted
79   (allocation nil :type (member :instance :class nil))
80   ;; If ALLOCATION is :CLASS, this is a cons whose car holds the value.
81   (cell nil :type (or cons null)))
82
83 ;;; KLUDGE: It's not clear to me why CONDITION-CLASS has itself listed
84 ;;; in its CPL, while other classes derived from CONDITION-CLASS don't
85 ;;; have themselves listed in their CPLs. This behavior is inherited
86 ;;; from CMU CL, and didn't seem to be explained there, and I haven't
87 ;;; figured out whether it's right. -- WHN 19990612
88 (eval-when (:compile-toplevel :load-toplevel :execute)
89   (/show0 "condition.lisp 103")
90   (let ((condition-class (locally
91                            ;; KLUDGE: There's a DEFTRANSFORM FIND-CLASS for
92                            ;; constant class names which creates fast but
93                            ;; non-cold-loadable, non-compact code. In this
94                            ;; context, we'd rather have compact, cold-loadable
95                            ;; code. -- WHN 19990928
96                            (declare (notinline sb!xc:find-class))
97                            (sb!xc:find-class 'condition))))
98     (setf (condition-class-cpl condition-class)
99           (list condition-class)))
100   (/show0 "condition.lisp 103"))
101
102 (setf (condition-class-report (locally
103                                 ;; KLUDGE: There's a DEFTRANSFORM FIND-CLASS 
104                                 ;; for constant class names which creates fast
105                                 ;; but non-cold-loadable, non-compact code. In
106                                 ;; this context, we'd rather have compact,
107                                 ;; cold-loadable code. -- WHN 19990928
108                                 (declare (notinline sb!xc:find-class))
109                                 (find-class 'condition)))
110       (lambda (cond stream)
111         (format stream "Condition ~S was signalled." (type-of cond))))
112
113 (eval-when (:compile-toplevel :load-toplevel :execute)
114
115 (defun find-condition-layout (name parent-types)
116   (let* ((cpl (remove-duplicates
117                (reverse
118                 (reduce #'append
119                         (mapcar (lambda (x)
120                                   (condition-class-cpl
121                                    (sb!xc:find-class x)))
122                                 parent-types)))))
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
129          ;; right thing is..
130          (new-inherits
131           (order-layout-inherits (concatenate 'simple-vector
132                                               (layout-inherits cond-layout)
133                                               (mapcar #'class-layout cpl)))))
134     (if (and olayout
135              (not (mismatch (layout-inherits olayout) new-inherits)))
136         olayout
137         (make-layout :class (make-undefined-class name)
138                      :inherits new-inherits
139                      :depthoid -1
140                      :length (layout-length cond-layout)))))
141
142 ) ; EVAL-WHEN
143
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)
153   (if *print-escape*
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-class-cpl (sb!xc:class-of x))
159                      (error "no REPORT? shouldn't happen!"))
160         (let ((report (condition-class-report class)))
161           (when report
162             (return (funcall report x stream)))))))
163 \f
164 ;;;; slots of CONDITION objects
165
166 (defvar *empty-condition-slot* '(empty))
167
168 (defun find-slot-default (class slot)
169   (let ((initargs (condition-slot-initargs slot))
170         (cpl (condition-class-cpl class)))
171     (dolist (class cpl)
172       (let ((default-initargs (condition-class-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
177                            (if (functionp val)
178                                (funcall val)
179                                val)))))))
180
181     (if (condition-slot-initform-p slot)
182         (let ((initform (condition-slot-initform slot)))
183           (if (functionp initform)
184               (funcall initform)
185               initform))
186         (error "unbound condition slot: ~S" (condition-slot-name slot)))))
187
188 (defun find-condition-class-slot (condition-class slot-name)
189   (dolist (sclass
190            (condition-class-cpl condition-class)
191            (error "There is no slot named ~S in ~S."
192                   slot-name condition-class))
193     (dolist (slot (condition-class-slots sclass))
194       (when (eq (condition-slot-name slot) slot-name)
195         (return-from find-condition-class-slot slot)))))
196
197 (defun condition-writer-function (condition new-value name)
198   (dolist (cslot (condition-class-class-slots
199                   (layout-class (%instance-layout condition)))
200                  (setf (getf (condition-assigned-slots condition) name)
201                        new-value))
202     (when (eq (condition-slot-name cslot) name)
203       (return (setf (car (condition-slot-cell cslot)) new-value)))))
204
205 (defun condition-reader-function (condition name)
206   (let ((class (layout-class (%instance-layout condition))))
207     (dolist (cslot (condition-class-class-slots class))
208       (when (eq (condition-slot-name cslot) name)
209         (return-from condition-reader-function
210                      (car (condition-slot-cell cslot)))))
211
212     (let ((val (getf (condition-assigned-slots condition) name
213                      *empty-condition-slot*)))
214       (if (eq val *empty-condition-slot*)
215           (let ((actual-initargs (condition-actual-initargs condition))
216                 (slot (find-condition-class-slot class name)))
217             (unless slot
218               (error "missing slot ~S of ~S" name condition))
219             (dolist (initarg (condition-slot-initargs slot))
220               (let ((val (getf actual-initargs
221                                initarg
222                                *empty-condition-slot*)))
223                 (unless (eq val *empty-condition-slot*)
224                   (return-from condition-reader-function
225                                (setf (getf (condition-assigned-slots condition)
226                                            name)
227                                      val)))))
228             (setf (getf (condition-assigned-slots condition) name)
229                   (find-slot-default class slot)))
230           val))))
231 \f
232 ;;;; MAKE-CONDITION
233
234 (defun make-condition (thing &rest args)
235   #!+sb-doc
236   "Make an instance of a condition object using the specified initargs."
237   ;; Note: ANSI specifies no exceptional situations in this function.
238   ;; signalling simple-type-error would not be wrong.
239   (let* ((thing (if (symbolp thing)
240                     (sb!xc:find-class thing)
241                     thing))
242          (class (typecase thing
243                   (condition-class thing)
244                   (class
245                    (error 'simple-type-error
246                           :datum thing
247                           :expected-type 'condition-class
248                           :format-control "~S is not a condition class."
249                           :format-arguments (list thing)))
250                   (t
251                    (error 'simple-type-error
252                           :datum thing
253                           :expected-type 'condition-class
254                           :format-control "bad thing for class argument:~%  ~S"
255                           :format-arguments (list thing)))))
256          (res (make-condition-object args)))
257     (setf (%instance-layout res) (class-layout class))
258     ;; Set any class slots with initargs present in this call.
259     (dolist (cslot (condition-class-class-slots class))
260       (dolist (initarg (condition-slot-initargs cslot))
261         (let ((val (getf args initarg *empty-condition-slot*)))
262           (unless (eq val *empty-condition-slot*)
263             (setf (car (condition-slot-cell cslot)) val)))))
264     ;; Default any slots with non-constant defaults now.
265     (dolist (hslot (condition-class-hairy-slots class))
266       (when (dolist (initarg (condition-slot-initargs hslot) t)
267               (unless (eq (getf args initarg *empty-condition-slot*)
268                           *empty-condition-slot*)
269                 (return nil)))
270         (setf (getf (condition-assigned-slots res) (condition-slot-name hslot))
271               (find-slot-default class hslot))))
272
273     res))
274 \f
275 ;;;; DEFINE-CONDITION
276
277 (eval-when (:compile-toplevel :load-toplevel :execute)
278 (defun %compiler-define-condition (name direct-supers layout)
279   (multiple-value-bind (class old-layout)
280       (insured-find-class name #'condition-class-p #'make-condition-class)
281     (setf (layout-class layout) class)
282     (setf (class-direct-superclasses class)
283           (mapcar #'sb!xc:find-class direct-supers))
284     (cond ((not old-layout)
285            (register-layout layout))
286           ((not *type-system-initialized*)
287            (setf (layout-class old-layout) class)
288            (setq layout old-layout)
289            (unless (eq (class-layout class) layout)
290              (register-layout layout)))
291           ((redefine-layout-warning "current"
292                                     old-layout
293                                     "new"
294                                     (layout-length layout)
295                                     (layout-inherits layout)
296                                     (layout-depthoid layout))
297            (register-layout layout :invalidate t))
298           ((not (class-layout class))
299            (register-layout layout)))
300
301     (setf (layout-info layout)
302           (locally
303             ;; KLUDGE: There's a FIND-CLASS DEFTRANSFORM for constant class
304             ;; names which creates fast but non-cold-loadable, non-compact
305             ;; code. In this context, we'd rather have compact, cold-loadable
306             ;; code. -- WHN 19990928
307             (declare (notinline sb!xc:find-class))
308             (layout-info (class-layout (sb!xc:find-class 'condition)))))
309
310     (setf (sb!xc:find-class name) class)
311
312     ;; Initialize CPL slot.
313     (setf (condition-class-cpl class)
314           (remove-if-not #'condition-class-p 
315                          (std-compute-class-precedence-list class))))
316   (values))
317
318 ) ; EVAL-WHEN
319
320 ;;; Compute the effective slots of CLASS, copying inherited slots and
321 ;;; destructively modifying direct slots.
322 ;;;
323 ;;; FIXME: It'd be nice to explain why it's OK to destructively modify
324 ;;; direct slots. Presumably it follows from the semantics of
325 ;;; inheritance and redefinition of conditions, but finding the cite
326 ;;; and documenting it here would be good. (Or, if this is not in fact
327 ;;; ANSI-compliant, fixing it would also be good.:-)
328 (defun compute-effective-slots (class)
329   (collect ((res (copy-list (condition-class-slots class))))
330     (dolist (sclass (condition-class-cpl class))
331       (dolist (sslot (condition-class-slots sclass))
332         (let ((found (find (condition-slot-name sslot) (res))))
333           (cond (found
334                  (setf (condition-slot-initargs found)
335                        (union (condition-slot-initargs found)
336                               (condition-slot-initargs sslot)))
337                  (unless (condition-slot-initform-p found)
338                    (setf (condition-slot-initform-p found)
339                          (condition-slot-initform-p sslot))
340                    (setf (condition-slot-initform found)
341                          (condition-slot-initform sslot)))
342                  (unless (condition-slot-allocation found)
343                    (setf (condition-slot-allocation found)
344                          (condition-slot-allocation sslot))))
345                 (t
346                  (res (copy-structure sslot)))))))
347     (res)))
348
349 (defun %define-condition (name slots documentation report default-initargs)
350   (let ((class (sb!xc:find-class name)))
351     (setf (condition-class-slots class) slots)
352     (setf (condition-class-report class) report)
353     (setf (condition-class-default-initargs class) default-initargs)
354     (setf (fdocumentation name 'type) documentation)
355
356     (dolist (slot slots)
357
358       ;; Set up reader and writer functions.
359       (let ((name (condition-slot-name slot)))
360         (dolist (reader (condition-slot-readers slot))
361           (setf (fdefinition reader)
362                 (lambda (condition)
363                   (condition-reader-function condition name))))
364         (dolist (writer (condition-slot-writers slot))
365           (setf (fdefinition writer)
366                 (lambda (new-value condition)
367                   (condition-writer-function condition new-value name))))))
368
369     ;; Compute effective slots and set up the class and hairy slots
370     ;; (subsets of the effective slots.)
371     (let ((eslots (compute-effective-slots class))
372           (e-def-initargs
373            (reduce #'append
374                    (mapcar #'condition-class-default-initargs
375                            (condition-class-cpl class)))))
376       (dolist (slot eslots)
377         (ecase (condition-slot-allocation slot)
378           (:class
379            (unless (condition-slot-cell slot)
380              (setf (condition-slot-cell slot)
381                    (list (if (condition-slot-initform-p slot)
382                              (let ((initform (condition-slot-initform slot)))
383                                (if (functionp initform)
384                                    (funcall initform)
385                                    initform))
386                              *empty-condition-slot*))))
387            (push slot (condition-class-class-slots class)))
388           ((:instance nil)
389            (setf (condition-slot-allocation slot) :instance)
390            (when (or (functionp (condition-slot-initform slot))
391                      (dolist (initarg (condition-slot-initargs slot) nil)
392                        (when (functionp (getf e-def-initargs initarg))
393                          (return t))))
394              (push slot (condition-class-hairy-slots class))))))))
395   name)
396
397 (defmacro define-condition (name (&rest parent-types) (&rest slot-specs)
398                                  &body options)
399   #!+sb-doc
400   "DEFINE-CONDITION Name (Parent-Type*) (Slot-Spec*) Option*
401    Define NAME as a condition type. This new type inherits slots and its
402    report function from the specified PARENT-TYPEs. A slot spec is a list of:
403      (slot-name :reader <rname> :initarg <iname> {Option Value}*
404
405    The DEFINE-CLASS slot options :ALLOCATION, :INITFORM, [slot] :DOCUMENTATION
406    and :TYPE and the overall options :DEFAULT-INITARGS and
407    [type] :DOCUMENTATION are also allowed.
408
409    The :REPORT option is peculiar to DEFINE-CONDITION. Its argument is either
410    a string or a two-argument lambda or function name. If a function, the
411    function is called with the condition and stream to report the condition.
412    If a string, the string is printed.
413
414    Condition types are classes, but (as allowed by ANSI and not as described in
415    CLtL2) are neither STANDARD-OBJECTs nor STRUCTURE-OBJECTs. WITH-SLOTS and
416    SLOT-VALUE may not be used on condition objects."
417   (let* ((parent-types (or parent-types '(condition)))
418          (layout (find-condition-layout name parent-types))
419          (documentation nil)
420          (report nil)
421          (default-initargs ()))
422     (collect ((slots)
423               (all-readers nil append)
424               (all-writers nil append))
425       (dolist (spec slot-specs)
426         (when (keywordp spec)
427           (warn "Keyword slot name indicates probable syntax error:~%  ~S"
428                 spec))
429         (let* ((spec (if (consp spec) spec (list spec)))
430                (slot-name (first spec))
431                (allocation :instance)
432                (initform-p nil)
433                initform)
434           (collect ((initargs)
435                     (readers)
436                     (writers))
437             (do ((options (rest spec) (cddr options)))
438                 ((null options))
439               (unless (and (consp options) (consp (cdr options)))
440                 (error "malformed condition slot spec:~%  ~S." spec))
441               (let ((arg (second options)))
442                 (case (first options)
443                   (:reader (readers arg))
444                   (:writer (writers arg))
445                   (:accessor
446                    (readers arg)
447                    (writers `(setf ,arg)))
448                   (:initform
449                    (when initform-p
450                      (error "more than one :INITFORM in ~S" spec))
451                    (setq initform-p t)
452                    (setq initform arg))
453                   (:initarg (initargs arg))
454                   (:allocation
455                    (setq allocation arg))
456                   (:type)
457                   (t
458                    (error "unknown slot option:~%  ~S" (first options))))))
459
460             (all-readers (readers))
461             (all-writers (writers))
462             (slots `(make-condition-slot
463                      :name ',slot-name
464                      :initargs ',(initargs)
465                      :readers ',(readers)
466                      :writers ',(writers)
467                      :initform-p ',initform-p
468                      :initform
469                      ,(if (constantp initform)
470                           `',(eval initform)
471                           `#'(lambda () ,initform)))))))
472
473       (dolist (option options)
474         (unless (consp option)
475           (error "bad option:~%  ~S" option))
476         (case (first option)
477           (:documentation (setq documentation (second option)))
478           (:report
479            (let ((arg (second option)))
480              (setq report
481                    (if (stringp arg)
482                        `#'(lambda (condition stream)
483                           (declare (ignore condition))
484                           (write-string ,arg stream))
485                        `#'(lambda (condition stream)
486                           (funcall #',arg condition stream))))))
487           (:default-initargs
488            (do ((initargs (rest option) (cddr initargs)))
489                ((endp initargs))
490              (let ((val (second initargs)))
491                (setq default-initargs
492                      (list* `',(first initargs)
493                             (if (constantp val)
494                                 `',(eval val)
495                                 `#'(lambda () ,val))
496                             default-initargs)))))
497           (t
498            (error "unknown option: ~S" (first option)))))
499
500       (when (all-writers)
501         (warn "Condition slot setters probably not allowed in ANSI CL:~%  ~S"
502               (all-writers)))
503
504       `(progn
505          (eval-when (:compile-toplevel :load-toplevel :execute)
506            (%compiler-define-condition ',name ',parent-types ',layout))
507
508          (declaim (ftype (function (t) t) ,@(all-readers)))
509          (declaim (ftype (function (t t) t) ,@(all-writers)))
510
511          (%define-condition ',name
512                             (list ,@(slots))
513                             ,documentation
514                             ,report
515                             (list ,@default-initargs))))))
516 \f
517 ;;;; DESCRIBE on CONDITIONs
518
519 ;;; a function to be used as the guts of DESCRIBE-OBJECT (CONDITION T)
520 ;;; eventually (once we get CLOS up and running so that we can define
521 ;;; methods)
522 (defun describe-condition (condition stream)
523   (format stream
524           "~@<~S ~_is a ~S. ~_Its slot values are ~_~S.~:>"
525           condition
526           (type-of condition)
527           (concatenate 'list
528                        (condition-actual-initargs condition)
529                        (condition-assigned-slots condition))))
530 \f
531 ;;;; various CONDITIONs specified by ANSI
532
533 (define-condition serious-condition (condition) ())
534
535 (define-condition error (serious-condition) ())
536
537 (define-condition warning (condition) ())
538 (define-condition style-warning (warning) ())
539
540 (defun simple-condition-printer (condition stream)
541   (apply #'format
542          stream
543          (simple-condition-format-control condition)
544          (simple-condition-format-arguments condition)))
545
546 (define-condition simple-condition ()
547   ((format-control :reader simple-condition-format-control
548                    :initarg :format-control)
549    (format-arguments :reader simple-condition-format-arguments
550                      :initarg :format-arguments
551                      :initform '()))
552   (:report simple-condition-printer))
553
554 (define-condition simple-warning (simple-condition warning) ())
555
556 (define-condition simple-error (simple-condition error) ())
557
558 (define-condition storage-condition (serious-condition) ())
559
560 (define-condition type-error (error)
561   ((datum :reader type-error-datum :initarg :datum)
562    (expected-type :reader type-error-expected-type :initarg :expected-type))
563   (:report
564    (lambda (condition stream)
565      (format stream
566              "~@<The value ~2I~:_~S ~I~_is not of type ~2I~_~S.~:>"
567              (type-error-datum condition)
568              (type-error-expected-type condition)))))
569
570 (define-condition simple-type-error (simple-condition type-error) ())
571
572 (define-condition program-error (error) ())
573 (define-condition parse-error   (error) ())
574 (define-condition control-error (error) ())
575 (define-condition stream-error  (error)
576   ((stream :reader stream-error-stream :initarg :stream)))
577
578 (define-condition end-of-file (stream-error) ()
579   (:report
580    (lambda (condition stream)
581      (format stream
582              "end of file on ~S"
583              (stream-error-stream condition)))))
584
585 (define-condition file-error (error)
586   ((pathname :reader file-error-pathname :initarg :pathname))
587   (:report
588    (lambda (condition stream)
589      (format stream
590              "~@<error on file ~_~S: ~2I~:_~?~:>"
591              (file-error-pathname condition)
592              ;; FIXME: ANSI's FILE-ERROR doesn't have FORMAT-CONTROL and 
593              ;; FORMAT-ARGUMENTS, and the inheritance here doesn't seem
594              ;; to give us FORMAT-CONTROL or FORMAT-ARGUMENTS either.
595              ;; So how does this work?
596              (serious-condition-format-control condition)
597              (serious-condition-format-arguments condition)))))
598
599 (define-condition package-error (error)
600   ((package :reader package-error-package :initarg :package)))
601
602 (define-condition cell-error (error)
603   ((name :reader cell-error-name :initarg :name)))
604
605 (define-condition unbound-variable (cell-error) ()
606   (:report
607    (lambda (condition stream)
608      (format stream
609              "The variable ~S is unbound."
610              (cell-error-name condition)))))
611
612 (define-condition undefined-function (cell-error) ()
613   (:report
614    (lambda (condition stream)
615      (format stream
616              "The function ~S is undefined."
617              (cell-error-name condition)))))
618
619 (define-condition arithmetic-error (error)
620   ((operation :reader arithmetic-error-operation
621               :initarg :operation
622               :initform nil)
623    (operands :reader arithmetic-error-operands
624              :initarg :operands))
625   (:report (lambda (condition stream)
626              (format stream
627                      "arithmetic error ~S signalled"
628                      (type-of condition))
629              (when (arithmetic-error-operation condition)
630                (format stream
631                        "~%Operation was ~S, operands ~S."
632                        (arithmetic-error-operation condition)
633                        (arithmetic-error-operands condition))))))
634
635 (define-condition division-by-zero         (arithmetic-error) ())
636 (define-condition floating-point-overflow  (arithmetic-error) ())
637 (define-condition floating-point-underflow (arithmetic-error) ())
638 (define-condition floating-point-inexact   (arithmetic-error) ())
639 (define-condition floating-point-invalid-operation (arithmetic-error) ())
640
641 (define-condition print-not-readable (error)
642   ((object :reader print-not-readable-object :initarg :object))
643   (:report
644    (lambda (condition stream)
645      (let ((obj (print-not-readable-object condition))
646            (*print-array* nil))
647        (format stream "~S cannot be printed readably." obj)))))
648
649 (define-condition reader-error (parse-error stream-error)
650   ((format-control
651     :reader reader-error-format-control
652     :initarg :format-control)
653    (format-arguments
654     :reader reader-error-format-arguments
655     :initarg :format-arguments
656     :initform '()))
657   (:report
658    (lambda (condition stream)
659      (let ((error-stream (stream-error-stream condition)))
660        (format stream "READER-ERROR ~@[at ~W ~]on ~S:~%~?"
661                (file-position error-stream) error-stream
662                (reader-error-format-control condition)
663                (reader-error-format-arguments condition))))))
664 \f
665 ;;;; various other (not specified by ANSI) CONDITIONs
666 ;;;;
667 ;;;; These might logically belong in other files; they're here, after
668 ;;;; setup of CONDITION machinery, only because that makes it easier to
669 ;;;; get cold init to work.
670
671 ;;; KLUDGE: a condition for floating point errors when we can't or
672 ;;; won't figure out what type they are. (In FreeBSD and OpenBSD we
673 ;;; don't know how, at least as of sbcl-0.6.7; in Linux we probably
674 ;;; know how but the old code was broken by the conversion to POSIX
675 ;;; signal handling and hasn't been fixed as of sbcl-0.6.7.)
676 ;;;
677 ;;; FIXME: Perhaps this should also be a base class for all
678 ;;; floating point exceptions?
679 (define-condition floating-point-exception (arithmetic-error)
680   ((flags :initarg :traps
681           :initform nil
682           :reader floating-point-exception-traps))
683   (:report (lambda (condition stream)
684              (format stream
685                      "An arithmetic error ~S was signalled.~%"
686                      (type-of condition))
687              (let ((traps (floating-point-exception-traps condition)))
688                (if traps
689                    (format stream
690                            "Trapping conditions are: ~%~{ ~S~^~}~%"
691                            traps)
692                    (write-line
693                     "No traps are enabled? How can this be?"
694                     stream))))))
695
696 (define-condition index-too-large-error (type-error)
697   ()
698   (:report
699    (lambda (condition stream)
700      (format stream
701              "The index ~S is too large."
702              (type-error-datum condition)))))
703
704 ;;; Out-of-range &KEY END arguments are similar to, but off by one
705 ;;; from out-of-range indices into the sequence.
706 (define-condition index-too-large-error (type-error)
707   ()
708   (:report
709    (lambda (condition stream)
710      (format stream
711              "The end-of-sequence specifier ~S is too large."
712              (type-error-datum condition)))))
713
714 (define-condition io-timeout (stream-error)
715   ((direction :reader io-timeout-direction :initarg :direction))
716   (:report
717    (lambda (condition stream)
718      (declare (type stream stream))
719      (format stream
720              "I/O timeout ~(~A~)ing ~S"
721              (io-timeout-direction condition)
722              (stream-error-stream condition)))))
723
724 (define-condition namestring-parse-error (parse-error)
725   ((complaint :reader namestring-parse-error-complaint :initarg :complaint)
726    (args :reader namestring-parse-error-args :initarg :args :initform nil)
727    (namestring :reader namestring-parse-error-namestring :initarg :namestring)
728    (offset :reader namestring-parse-error-offset :initarg :offset))
729   (:report
730    (lambda (condition stream)
731      (format stream
732              "parse error in namestring: ~?~%  ~A~%  ~V@T^"
733              (namestring-parse-error-complaint condition)
734              (namestring-parse-error-args condition)
735              (namestring-parse-error-namestring condition)
736              (namestring-parse-error-offset condition)))))
737
738 (define-condition simple-package-error (simple-condition package-error) ())
739
740 (define-condition reader-package-error (reader-error) ())
741
742 (define-condition reader-eof-error (end-of-file)
743   ((context :reader reader-eof-error-context :initarg :context))
744   (:report
745    (lambda (condition stream)
746      (format stream
747              "unexpected end of file on ~S ~A"
748              (stream-error-stream condition)
749              (reader-eof-error-context condition)))))
750 \f
751 ;;;; special SBCL extension conditions
752
753 ;;; an error apparently caused by a bug in SBCL itself
754 ;;;
755 ;;; Note that we don't make any serious effort to use this condition
756 ;;; for *all* errors in SBCL itself. E.g. type errors and array
757 ;;; indexing errors can occur in functions called from SBCL code, and
758 ;;; will just end up as ordinary TYPE-ERROR or invalid index error,
759 ;;; because the signalling code has no good way to know that the
760 ;;; underlying problem is a bug in SBCL. But in the fairly common case
761 ;;; that the signalling code does know that it's found a bug in SBCL,
762 ;;; this condition is appropriate, reusing boilerplate and helping
763 ;;; users to recognize it as an SBCL bug.
764 (define-condition bug (simple-error)
765   ()
766   (:report
767    (lambda (condition stream)
768      (format stream
769              "~@<  ~? ~:@_~?~:>"
770              (simple-condition-format-control condition)
771              (simple-condition-format-arguments condition)
772              "~@<This is probably a bug in SBCL itself. (Alternatively, ~
773               SBCL might have been corrupted by bad user code, e.g. by an ~
774               undefined Lisp operation like ~S, or by stray pointers from ~
775               alien code or from unsafe Lisp code; or there might be a bug ~
776               in the OS or hardware that SBCL is running on.) If it seems to ~
777               be a bug in SBCL itself, the maintainers would like to know ~
778               about it. Bug reports are welcome on the SBCL ~
779               mailing lists, which you can find at ~
780               <http://sbcl.sourceforge.net/>.~:@>"
781              '((fmakunbound 'compile))))))
782 (defun bug (format-control &rest format-arguments)
783   (error 'bug
784          :format-control format-control
785          :format-arguments format-arguments))
786
787 ;;; a condition for use in stubs for operations which aren't supported
788 ;;; on some platforms
789 ;;;
790 ;;; E.g. in sbcl-0.7.0.5, it might be appropriate to do something like
791 ;;;   #-(or freebsd linux)
792 ;;;   (defun load-foreign (&rest rest)
793 ;;;     (error 'unsupported-operator :name 'load-foreign))
794 ;;;   #+(or freebsd linux)
795 ;;;   (defun load-foreign ... actual definition ...)
796 ;;; By signalling a standard condition in this case, we make it
797 ;;; possible for test code to distinguish between (1) intentionally
798 ;;; unimplemented and (2) unintentionally just screwed up somehow.
799 ;;; (Before this condition was defined, test code tried to deal with 
800 ;;; this by checking for FBOUNDP, but that didn't work reliably. In
801 ;;; sbcl-0.7.0, a a package screwup left the definition of
802 ;;; LOAD-FOREIGN in the wrong package, so it was unFBOUNDP even on
803 ;;; architectures where it was supposed to be supported, and the
804 ;;; regression tests cheerfully passed because they assumed that
805 ;;; unFBOUNDPness meant they were running on an system which didn't
806 ;;; support the extension.)
807 (define-condition unsupported-operator (cell-error) ()
808   (:report
809    (lambda (condition stream)
810      (format stream
811              "unsupported on this platform (OS, CPU, whatever): ~S"
812              (cell-error-name condition)))))
813 \f
814 ;;;; restart definitions
815
816 (define-condition abort-failure (control-error) ()
817   (:report
818    "An ABORT restart was found that failed to transfer control dynamically."))
819
820 (defun abort (&optional condition)
821   #!+sb-doc
822   "Transfer control to a restart named ABORT, signalling a CONTROL-ERROR if
823    none exists."
824   (invoke-restart (find-restart 'abort condition))
825   ;; ABORT signals an error in case there was a restart named ABORT
826   ;; that did not transfer control dynamically. This could happen with
827   ;; RESTART-BIND.
828   (error 'abort-failure))
829
830 (defun muffle-warning (&optional condition)
831   #!+sb-doc
832   "Transfer control to a restart named MUFFLE-WARNING, signalling a
833    CONTROL-ERROR if none exists."
834   (invoke-restart (find-restart 'muffle-warning condition)))
835
836 (macrolet ((define-nil-returning-restart (name args doc)
837              #!-sb-doc (declare (ignore doc))
838              `(defun ,name (,@args &optional condition)
839                 #!+sb-doc ,doc
840                 ;; FIXME: Perhaps this shared logic should be pulled out into
841                 ;; FLET MAYBE-INVOKE-RESTART? See whether it shrinks code..
842                 (when (find-restart ',name condition)
843                   (invoke-restart ',name ,@args)))))
844   (define-nil-returning-restart continue ()
845     "Transfer control to a restart named CONTINUE, or return NIL if none exists.")
846   (define-nil-returning-restart store-value (value)
847     "Transfer control and VALUE to a restart named STORE-VALUE, or return NIL if
848    none exists.")
849   (define-nil-returning-restart use-value (value)
850     "Transfer control and VALUE to a restart named USE-VALUE, or return NIL if
851    none exists."))
852
853 (/show0 "condition.lisp end of file")
854