source: branches/1.2/devel/source/level-1/l1-error-system.lisp @ 8130

Last change on this file since 8130 was 8130, checked in by gb, 12 years ago

Merge changes from working-0711 branch

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 51.3 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 1994-2001 Digitool, Inc
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17
18;;; This file contains the error/condition system.  Functions that
19;;; signal/handle errors are defined later.
20
21(in-package "CCL")
22
23;;;***********************************
24;;; Error System
25;;;***********************************
26
27(defclass condition () ())
28(defclass warning (condition) ())
29(defclass serious-condition (condition) ())
30(defclass error (serious-condition) ())
31
32(define-condition simple-condition (condition)
33  ((format-control :initarg :format-control
34                  :reader simple-condition-format-control)
35   (format-arguments :initarg :format-arguments
36                     :initform nil
37                     :reader simple-condition-format-arguments))
38  (:report (lambda (c stream)  ;; If this were a method, slot value might be faster someday.  Accessors always faster ?
39                               ;; And of course it's terribly important that this be as fast as humanly possible...
40            ;Use accessors because they're documented and users can specialize them.
41            (apply #'format stream (simple-condition-format-control c)
42                   (simple-condition-format-arguments c)))))
43
44
45(define-condition storage-condition (serious-condition) ())
46
47(define-condition thread-condition (serious-condition) ())
48
49(define-condition process-reset (thread-condition)
50  ((kill :initarg :kill :initform nil :reader process-reset-kill)))
51
52
53(define-condition print-not-readable (error)
54  ((object :initarg :object :reader print-not-readable-object)
55   (stream :initarg :stream :reader print-not-readable-stream))
56  (:report (lambda (c stream)
57             (let* ((*print-readably* nil))
58               (format stream "Attempt to print object ~S on stream ~S ."
59                       (print-not-readable-object c)
60                       (print-not-readable-stream c))))))
61
62(define-condition simple-warning (simple-condition warning))
63
64(define-condition compiler-warning (warning)
65  ((file-name :initarg :file-name :initform nil :accessor compiler-warning-file-name)
66   (stream-position :initform nil :accessor compiler-warning-stream-position)
67   (function-name :initarg :function-name :initform nil :accessor compiler-warning-function-name)
68   (warning-type :initarg :warning-type :reader compiler-warning-warning-type)
69   (args :initarg :args :reader compiler-warning-args)
70   (nrefs :initform 1 :accessor compiler-warning-nrefs))
71  (:report report-compiler-warning))
72
73(define-condition style-warning (compiler-warning))
74(define-condition undefined-function-reference (style-warning))
75(define-condition macro-used-before-definition (compiler-warning))
76(define-condition invalid-arguments (style-warning))
77(define-condition invalid-arguments-global (style-warning))
78
79(define-condition simple-error (simple-condition error))
80
81(define-condition simple-storage-condition (simple-condition storage-condition))
82(define-condition stack-overflow-condition (simple-storage-condition))
83
84(define-condition invalid-memory-access (storage-condition)
85  ((address :initarg :address)
86   (write-p :initform nil :initarg :write-p))
87  (:report (lambda (c s)
88             (with-slots (address write-p) c
89               (format s "Fault during ~a memory address #x~x" (if write-p "write to" "read of") address)))))
90 
91(define-condition type-error (error)
92  ((datum :initarg :datum)
93   (expected-type :initarg :expected-type :reader type-error-expected-type)
94   (format-control :initarg :format-control  :initform (%rsc-string  $xwrongtype) :reader type-error-format-control))
95  (:report (lambda (c s)
96             (format s (type-error-format-control c)
97                     (type-error-datum c) 
98                     (type-error-expected-type c)))))
99
100(define-condition bad-slot-type (type-error)
101  ((slot-definition :initform nil :initarg :slot-definition)
102   (instance :initform nil :initarg :instance))
103  (:report (lambda (c s)
104             (format s "The value ~s can not be used to set the value of the slot ~s in ~s, because it is not of type ~s. "
105                     (type-error-datum c)
106                     (slot-definition-name (slot-value c 'slot-definition))
107                     (slot-value c 'instance)
108                     (type-error-expected-type c)))))
109
110(define-condition bad-slot-type-from-initform (bad-slot-type)
111  ()
112  (:report (lambda (c s)
113             (let* ((slotd (slot-value c 'slot-definition)))
114               (format s "The value ~s, derived from the initform ~s, can not be used to set the value of the slot ~s in ~s, because it is not of type ~s. "
115                     (type-error-datum c)
116                     (slot-definition-initform slotd)
117                     (slot-definition-name slotd)
118                     (slot-value c 'instance)
119                     (type-error-expected-type c))))))
120
121(define-condition bad-slot-type-from-initarg (bad-slot-type)
122  ((initarg-name :initarg :initarg-name))
123  (:report (lambda (c s)
124             (let* ((slotd (slot-value c 'slot-definition)))
125               (format s "The value ~s, derived from the initarg ~s, can not be used to set the value of the slot ~s in ~s, because it is not of type ~s. "
126                     (type-error-datum c)
127                     (slot-value c 'initarg-name)
128                     (slot-definition-name slotd)
129                     (slot-value c 'instance)
130                     (type-error-expected-type c))))))
131 
132
133(define-condition improper-list (type-error)
134  ((expected-type :initform '(satisfies proper-list-p) :reader type-error-expected-type)))
135
136(define-condition cant-construct-arglist (improper-list)
137  ())
138
139
140
141(let* ((magic-token '("Unbound")))
142  (defmethod type-error-datum ((c type-error))
143    (let* ((datum-slot (slot-value c 'datum)))
144      (if (eq magic-token datum-slot)
145        (%unbound-marker-8)
146        datum-slot)))
147
148; do we need this
149  (defun signal-type-error (datum expected &optional (format-string (%rsc-string  $xwrongtype)))
150    (let ((error #'error))
151      (funcall error (make-condition 'type-error
152                                     :format-control format-string
153                                     :datum (if (eq datum (%unbound-marker-8)) magic-token datum)
154                                     :expected-type (%type-error-type expected)))))
155)
156
157
158(define-condition sequence-index-type-error (type-error)
159  ((sequence :initarg :sequence))
160  (:report (lambda (c s)
161             (format s "~s is not a valid sequence index for ~s"
162                     (type-error-datum c)
163                     (slot-value c 'sequence)))))
164
165
166;;; This is admittedly sleazy; ANSI CL requires TYPE-ERRORs to be
167;;; signalled in cases where a type-specifier is not of an appropriate
168;;; subtype.  The sleazy part is whether it's right to overload TYPE-ERROR
169;;; like this.
170
171(define-condition invalid-subtype-error (type-error)
172  ()
173  (:report (lambda (c s)
174             (format s "The type specifier ~S is not determinably a subtype of the type ~S"
175                     (type-error-datum c)
176                     (type-error-expected-type c)))))
177
178(define-condition simple-type-error (simple-condition type-error))
179
180
181
182(define-condition program-error (error))
183(define-condition simple-program-error (simple-condition program-error)
184  ((context :initarg :context :reader simple-program-error-context :initform nil)))
185
186(defun signal-program-error (string &rest args)
187  (let* ((e #'error))
188    (funcall e
189             (make-condition 'simple-program-error
190                             :format-control (if (fixnump string) (%rsc-string string) string)
191                             :format-arguments args))))
192
193(define-condition simple-destructuring-error (simple-program-error))
194
195(define-condition wrong-number-of-arguments (program-error)
196  ((nargs :initform nil
197          :initarg :nargs :reader wrong-number-of-arguments-nargs)
198   (fn :initform nil :initarg :fn :reader wrong-number-of-arguments-fn))
199  (:report report-argument-mismatch))
200       
201(define-condition too-many-arguments (wrong-number-of-arguments))
202
203(define-condition too-few-arguments (wrong-number-of-arguments))
204
205(defun report-argument-mismatch (c s)
206  (let* ((nargs-provided (wrong-number-of-arguments-nargs c))
207         (fn (wrong-number-of-arguments-fn c))
208         (too-many (typep c 'too-many-arguments)))
209    (multiple-value-bind (min max scaled-nargs)
210        (min-max-actual-args fn nargs-provided)
211      (if (not min)
212        (progn
213          (format s "Function ~s called with too ~a arguments. "
214                  fn
215                  (if too-many
216                    "many"
217                    "few")))
218        (if too-many
219          (format s "Too many arguments in call to ~s:~&~d arguments provided, at most ~d accepted. " fn scaled-nargs max)
220          (format s "Too few arguments in call to ~s:~&~d arguments provided, at least ~d required. " fn  scaled-nargs min))))))
221
222
223
224(define-condition compile-time-program-error (simple-program-error)
225  nil ;((context :initarg :context :reader compile-time-program-error-context))
226  (:report
227   (lambda (c s)
228     (format s "While compiling ~a :~%~a" 
229             (simple-program-error-context c)
230             (apply #'format nil (simple-condition-format-control c) (simple-condition-format-arguments c))))))
231
232
233
234;;; Miscellaneous error during compilation (caused by macroexpansion, transforms, compile-time evaluation, etc.)
235;;; NOT program-errors.
236(define-condition compile-time-error (simple-error)
237  ((context :initarg :context :reader compile-time-error-context))
238  (:report
239   (lambda (c s)
240     (format s "While compiling ~a :~%~a" 
241             (compile-time-error-context c)
242             (format nil "~a" c)))))
243
244(define-condition control-error (error))
245
246(define-condition cant-throw-error (control-error)
247  ((tag :initarg :tag))
248  (:report (lambda (c s)
249             (format s "Can't throw to tag ~s" (slot-value c 'tag)))))
250
251(define-condition inactive-restart (control-error)
252  ((restart-name :initarg :restart-name))
253  (:report (lambda (c s)
254             (format s "Restart ~s is not active" (slot-value c 'restart-name)))))
255
256(define-condition lock-protocol-error (control-error)
257  ((lock :initarg :lock)))
258
259(define-condition not-lock-owner (lock-protocol-error)
260  ()
261  (:report (lambda (c s)
262             (format s "Current process ~s does not own lock ~s"
263                     *current-process* (slot-value c 'lock)))))
264
265(define-condition not-locked (lock-protocol-error)
266  ()
267  (:report (lambda (c s)
268             (format s "Lock ~s isn't locked." (slot-value c 'lock)))))
269
270(define-condition deadlock (lock-protocol-error)
271  ()
272  (:report (lambda (c s)
273             (format s "Requested operation on ~s would cause deadlock." (slot-value c 'lock)))))
274
275(define-condition package-error (error)
276  ((package :initarg :package :reader package-error-package)))
277(define-condition no-such-package (package-error)
278  ()
279  (:report (lambda (c s) (format s (%rsc-string $xnopkg) (package-error-package c)))))
280(define-condition unintern-conflict-error (package-error)
281  ((sym-to-unintern :initarg :sym)
282   (conflicting-syms :initarg :conflicts))
283  (:report (lambda (c s)
284             (format s (%rsc-string $xunintc) (slot-value c 'sym-to-unintern) (package-error-package c) (slot-value c 'conflicting-syms)))))
285
286(define-condition import-conflict-error (package-error)
287  ((imported-sym :initarg :imported-sym)
288   (conflicting-sym :initarg :conflicting-sym)
289   (conflict-external-p :initarg :conflict-external))
290  (:report (lambda (c s)
291             (format s (%rsc-string (if (slot-value c 'conflict-external-p) $ximprtcx $ximprtc))
292                     (slot-value c 'imported-sym)
293                     (package-error-package c)
294                     (slot-value c 'conflicting-sym)))))
295
296(define-condition use-package-conflict-error (package-error)
297  ((package-to-use :initarg :package-to-use)
298   (conflicts :initarg :conflicts)
299   (external-p :initarg :external-p))
300  (:report (lambda (c s)
301             (format s (%rsc-string (if (slot-value c 'external-p) $xusecX $xusec))
302                     (slot-value c 'package-to-use)
303                     (package-error-package c)
304                     (slot-value c 'conflicts)))))
305
306(define-condition export-conflict-error (package-error)
307  ((conflicts :initarg :conflicts))
308  (:report 
309   (lambda (c s)
310     (format s "Name conflict~p detected by ~A :" (length (slot-value c 'conflicts)) 'export)
311     (let* ((package (package-error-package c)))
312       (dolist (conflict (slot-value c 'conflicts))
313         (destructuring-bind (inherited-p sym-to-export using-package conflicting-sym) conflict
314           (format s "~&~A'ing ~S from ~S would cause a name conflict with ~&~
315                      the ~a symbol ~S in the package ~s, which uses ~S."
316                   'export 
317                   sym-to-export 
318                   package 
319                   (if inherited-p "inherited" "present")
320                   conflicting-sym
321                   using-package
322                   package)))))))
323
324(define-condition export-requires-import (package-error)
325  ((to-be-imported :initarg :to-be-imported))
326  (:report
327   (lambda (c s)
328     (let* ((p (package-error-package c)))
329       (format s "The following symbols need to be imported to ~S before they can be exported ~& from that package:~%~s:" p (slot-value c 'to-be-imported) p)))))
330
331
332(define-condition package-name-conflict-error (package-error simple-error) ())
333
334(define-condition package-is-used-by (package-error)
335  ((using-packages :initarg :using-packages))
336  (:report (lambda (c s)
337             (format s "~S is used by ~S" (package-error-package c)
338                     (slot-value c 'using-packages)))))
339
340(define-condition symbol-name-not-accessible (package-error)
341  ((symbol-name :initarg :symbol-name))
342  (:report (lambda (c s)
343             (format s "No aymbol named ~S is accessible in package ~s"
344                     (slot-value c 'symbol-name)
345                     (package-error-package c)))))
346
347(define-condition stream-error (error)
348  ((stream :initarg :stream :reader stream-error-stream)))
349
350(defun stream-error-context (condition)
351  (let* ((stream (stream-error-stream condition)))
352    (with-output-to-string (s)
353       (format s "on ~s" stream)
354       (let* ((pos (ignore-errors (stream-position stream))))
355         (when pos
356           (format s ", near position ~d" pos)))
357       (let* ((surrounding (stream-surrounding-characters stream)))
358         (when surrounding
359           (format s ", within ~s" surrounding))))))
360
361(define-condition parse-error (error) ())
362(define-condition parse-integer-not-integer-string (parse-error)
363  ((string :initarg :string))
364  (:report (lambda (c s)
365             (format s "Not an integer string: ~s" (slot-value c 'string)))))
366
367(define-condition reader-error (parse-error stream-error) ())
368(define-condition end-of-file (stream-error) ()
369  (:report (lambda (c s)
370             (format s "Unexpected end of file ~a" (stream-error-context c)))))
371(define-condition impossible-number (reader-error)
372  ((token :initarg :token :reader impossible-number-token)
373   (condition :initarg :condition :reader impossible-number-condition))
374  (:report (lambda (c s)
375             (format s "Condition of type ~s raised ~&while trying to parse numeric token ~s ~&~s"
376                     (type-of (impossible-number-condition c))
377                     (impossible-number-token c)
378                     (stream-error-context c)))))
379
380
381   
382(define-condition simple-stream-error (stream-error simple-condition) () 
383  (:report (lambda (c s) 
384             (format s "~a : ~&~a" (stream-error-context c) 
385                     (apply #'format
386                            nil
387                            (simple-condition-format-control c)
388                            (simple-condition-format-arguments c))))))
389
390
391
392
393(define-condition file-error (error)
394  ((pathname :initarg :pathname :initform "<unspecified>" :reader file-error-pathname)
395   (error-type :initarg :error-type :initform "File error on file ~S"))
396  (:report (lambda (c s)
397              (format s (slot-value c 'error-type) 
398                     (file-error-pathname c)))))
399
400(define-condition simple-file-error (simple-condition file-error)
401  ()
402  (:report (lambda (c s)
403             (apply #'format s (slot-value c 'error-type) 
404                    (file-error-pathname c)
405                    (simple-condition-format-arguments c)))))
406
407
408(define-condition namestring-parse-error (error)
409  ((complaint :reader namestring-parse-error-complaint :initarg :complaint)
410   (arguments :reader namestring-parse-error-arguments :initarg :arguments
411              :initform nil)
412   (namestring :reader namestring-parse-error-namestring :initarg :namestring)
413   (offset :reader namestring-parse-error-offset :initarg :offset))
414  (:report (lambda (condition stream) 
415  (format stream "Parse error in namestring: ~?~%  ~A~%  ~V@T^"
416          (namestring-parse-error-complaint condition)
417          (namestring-parse-error-arguments condition)
418          (namestring-parse-error-namestring condition)
419          (namestring-parse-error-offset condition)))))
420
421(define-condition cell-error (error)
422  ((name :initarg :name :reader cell-error-name)
423   (error-type :initarg :error-type :initform "Cell error" :reader cell-error-type))
424  (:report (lambda (c s) (format s "~A: ~S" (cell-error-type c) (cell-error-name c)))))
425
426(define-condition unbound-variable (cell-error)
427  ((error-type :initform "Unbound variable")))
428
429(define-condition undefined-function (cell-error)
430  ((error-type :initform "Undefined function")))
431(define-condition undefined-function-call (control-error undefined-function)
432  ((function-arguments :initarg :function-arguments :reader undefined-function-call-arguments))
433  (:report (lambda (c s) (format s "Undefined function ~S called with arguments ~:S ."
434                                 (cell-error-name c)
435                                 (undefined-function-call-arguments c)))))
436
437(define-condition call-special-operator-or-macro (undefined-function-call)
438  ()
439  (:report (lambda (c s) (format s "Special operator or global macro-function ~s can't be FUNCALLed or APPLYed" (cell-error-name c)))))
440
441 
442(define-condition unbound-slot (cell-error)
443  ((instance :initarg :instance :accessor unbound-slot-instance))
444  (:report (lambda (c s) (format s "Slot ~s is unbound in ~s"
445                                 (cell-error-name c)
446                                 (unbound-slot-instance c)))))
447 
448
449(define-condition arithmetic-error (error) 
450  ((operation :initform nil :initarg :operation :reader arithmetic-error-operation)
451   (operands :initform nil :initarg :operands :reader arithmetic-error-operands)
452   (status :initform nil :initarg :status :reader arithmetic-error-status))
453  (:report (lambda (c s)
454             (format s "~S detected" (type-of c))
455             (let* ((operands (arithmetic-error-operands c)))
456               (when operands
457                 (format s "~&performing ~A on ~:S"
458                         (arithmetic-error-operation c) 
459                         operands))))))
460
461(define-condition division-by-zero (arithmetic-error))
462 
463(define-condition floating-point-underflow (arithmetic-error))
464(define-condition floating-point-overflow (arithmetic-error))
465(define-condition floating-point-inexact (arithmetic-error))
466(define-condition floating-point-invalid-operation (arithmetic-error))
467
468(define-condition compiler-bug (simple-error)
469  ()
470  (:report (lambda (c stream)
471                  (format stream "Compiler bug or inconsistency:~%")
472                  (apply #'format stream (simple-condition-format-control c)
473                         (simple-condition-format-arguments c)))))
474                         
475(defun restartp (thing) 
476  (istruct-typep thing 'restart))
477(setf (type-predicate 'restart) 'restartp)
478
479(defmethod print-object ((restart restart) stream)
480  (let ((report (%restart-report restart)))
481    (cond ((or *print-escape* (null report))
482           (print-unreadable-object (restart stream :identity t)
483             (format stream "~S ~S"
484                     'restart (%restart-name restart))))
485          ((stringp report)
486           (write-string report stream))
487          (t
488           (funcall report stream)))))
489
490(defun %make-restart (name action report interactive test)
491  (%cons-restart name action report interactive test))
492
493(defun make-restart (vector name action-function &key report-function interactive-function test-function)
494  (unless vector (setq vector (%cons-restart nil nil nil nil nil)))
495  (setf (%restart-name vector) name
496        (%restart-action vector) (require-type action-function 'function)
497        (%restart-report vector) (if report-function (require-type report-function 'function))
498        (%restart-interactive vector) (if interactive-function (require-type interactive-function 'function))
499        (%restart-test vector) (if test-function (require-type test-function 'function)))
500  vector)
501
502(defun restart-name (restart)
503  "Return the name of the given restart object."
504  (%restart-name (require-type restart 'restart)))
505
506(defun applicable-restart-p (restart condition)
507  (let* ((pair (if condition (assq restart *condition-restarts*)))
508         (test (%restart-test restart)))
509    (and (or (null pair) (eq (%cdr pair) condition))
510         (or (null test) (funcall test condition)))))
511
512(defun compute-restarts (&optional condition &aux restarts)
513  "Return a list of all the currently active restarts ordered from most
514   recently established to less recently established. If CONDITION is
515   specified, then only restarts associated with CONDITION (or with no
516   condition) will be returned."
517  (dolist (cluster %restarts% (nreverse restarts))
518    (dolist (restart cluster)
519      (when (applicable-restart-p restart condition)
520        (push restart restarts)))))
521
522(defun find-restart (name &optional condition)
523  "Return the first active restart named NAME. If NAME names a
524   restart, the restart is returned if it is currently active. If no such
525   restart is found, NIL is returned. It is an error to supply NIL as a
526   name. If CONDITION is specified and not NIL, then only restarts
527   associated with that condition (or with no condition) will be
528   returned."
529  (dolist (cluster %restarts%)
530    (dolist (restart cluster)
531      (when (and (or (eq restart name) (eq (restart-name restart) name))
532                 (applicable-restart-p restart condition))
533        (return-from find-restart restart)))))
534
535(defun %active-restart (name)
536  (dolist (cluster %restarts%)
537    (dolist (restart cluster)
538      (let* ((rname (%restart-name restart))
539             (rtest (%restart-test restart)))
540        (when (and (or (eq restart name) (eq rname name))
541                   (or (null rtest) (funcall rtest nil)))
542          (return-from %active-restart (values restart cluster))))))
543  (error 'inactive-restart :restart-name name))
544
545(defun invoke-restart (restart &rest values)
546  "Calls the function associated with the given restart, passing any given
547   arguments. If the argument restart is not a restart or a currently active
548   non-nil restart name, then a CONTROL-ERROR is signalled."
549  (multiple-value-bind (restart tag) (%active-restart restart)
550    (let ((fn (%restart-action restart)))
551      (cond ((null fn)                  ; simple restart
552             (unless (null values) (%err-disp $xtminps))
553             (throw tag nil))
554            ((fixnump fn)               ; restart case
555             (throw tag (cons fn values)))
556            ((functionp fn)             ; restart bind
557             (apply fn values))         
558            (t                          ; with-simple-restart
559             (throw tag (values nil t)))))))
560
561(defun invoke-restart-no-return (restart)
562  (invoke-restart restart)
563  (error 'restart-failure :restart restart))
564
565(defun invoke-restart-interactively (restart)
566  "Calls the function associated with the given restart, prompting for any
567   necessary arguments. If the argument restart is not a restart or a
568   currently active non-NIL restart name, then a CONTROL-ERROR is signalled."
569  (let* ((restart (find-restart restart)))
570    (format *error-output* "~&Invoking restart: ~a~&" restart)
571    (let* ((argfn (%restart-interactive restart))
572           (values (when argfn (funcall argfn))))
573      (apply #'invoke-restart restart values))))
574
575
576
577(defun maybe-invoke-restart (restart value condition)
578  (let ((restart (find-restart restart condition)))
579    (when restart (invoke-restart restart value))))
580
581(defun use-value (value &optional condition)
582  "Transfer control and VALUE to a restart named USE-VALUE, or return NIL if
583   none exists."
584  (maybe-invoke-restart 'use-value value condition))
585
586(defun store-value (value &optional condition)
587  "Transfer control and VALUE to a restart named STORE-VALUE, or return NIL if
588   none exists."
589  (maybe-invoke-restart 'store-value value condition))
590
591(defun condition-arg (thing args type)
592  (cond ((condition-p thing) (if args (%err-disp $xtminps) thing))
593        ((symbolp thing) (apply #'make-condition thing args))
594        (t (make-condition type :format-control thing :format-arguments args))))
595
596(defun make-condition (name &rest init-list)
597  "Make an instance of a condition object using the specified initargs."
598  (declare (dynamic-extent init-list))
599  (if (subtypep name 'condition)
600    (apply #'make-instance name init-list)
601    (error "~S is not a defined condition type name" name)))
602
603(defmethod print-object ((c condition) stream)
604  (if *print-escape* 
605    (call-next-method)
606    (report-condition c stream)))
607
608(defmethod report-condition ((c condition) stream)
609  (princ (cond ((typep c 'error) "Error ")
610               ((typep c 'warning) "Warning ")
611               (t "Condition "))
612         stream)
613  ;Here should dump all slots or something.  For now...
614  (let ((*print-escape* t))
615    (print-object c stream)))
616
617(defun signal-simple-condition (class-name format-string &rest args)
618  (let ((e #'error))  ; Never-tail-call.
619    (funcall e (make-condition class-name :format-control format-string :format-arguments args))))
620
621(defun signal-simple-program-error (format-string &rest args)
622  (apply #'signal-simple-condition 'simple-program-error format-string args))
623
624;;getting the function name for error functions.
625
626
627(defun %last-fn-on-stack (&optional (number 0) (s (%get-frame-ptr)))
628  (let* ((fn nil))
629    (let ((p s))
630      (dotimes (i number)
631        (declare (fixnum i))
632        (unless (setq p (parent-frame p nil))
633          (return)))
634      (do* ((i number (1+ i)))
635           ((null p))
636        (if (setq fn (cfp-lfun p))
637          (return (values fn i))
638          (setq p (parent-frame p nil)))))))
639 
640(defun %err-fn-name (lfun)
641  "given an lfun returns the name or the string \"Unknown\""
642  (if (lfunp lfun) (or (lfun-name lfun) lfun)
643     (or lfun "Unknown")))
644
645(defun %real-err-fn-name (error-pointer)
646  (multiple-value-bind (fn p) (%last-fn-on-stack 0 error-pointer)
647    (let ((name (%err-fn-name fn)))
648      (if (and (memq name '( call-check-regs)) p)
649        (%err-fn-name (%last-fn-on-stack (1+ p) error-pointer))
650        name))))
651
652
653;; Some simple restarts for simple error conditions.  Callable from the kernel.
654
655(defun find-unique-homonym (name &optional test)
656  (let ((pname (and name (symbolp name) (symbol-name name)))
657        (other-name nil))
658    (dolist (pkg (list-all-packages) other-name)
659      (let ((candidate (find-symbol pname pkg)))
660        (when (and candidate
661                   (not (eq candidate name))
662                   (or (null test) (funcall test candidate)))
663          (when (and other-name (neq other-name candidate))
664            (return nil)) ;; more than one, too complicated, give up
665          (setq other-name candidate))))))
666
667
668(def-kernel-restart $xvunbnd %default-unbound-variable-restarts (frame-ptr cell-name)
669  (unless *level-1-loaded*
670    (dbg cell-name))       ;  user should never see this.
671  (let ((condition (make-condition 'unbound-variable :name cell-name))
672        (other-variable (find-unique-homonym cell-name #'boundp)))
673    (flet ((new-value ()
674             (catch-cancel
675              (return-from new-value
676                           (list (read-from-string 
677                                  (get-string-from-user
678                                   (format nil "New value for ~s : " cell-name))))))
679             (continue condition))) ; force error again if cancelled, var still not set.
680      (restart-case (%error condition nil frame-ptr)
681        (continue ()
682                  :report (lambda (s) (format s "Retry getting the value of ~S." cell-name))
683                  (symbol-value cell-name))
684        (use-homonym ()
685                     :test (lambda (c) (and (or (null c) (eq c condition)) other-variable))
686                     :report (lambda (s) (format s "Use the value of ~s this time." other-variable))
687                     (symbol-value other-variable))
688        (use-value (value)
689                   :interactive new-value
690                   :report (lambda (s) (format s "Specify a value of ~S to use this time." cell-name))
691                   value)
692        (store-value (value)
693                     :interactive new-value
694                     :report (lambda (s) (format s "Specify a value of ~S to store and use." cell-name))
695                     (setf (symbol-value cell-name) value))))))
696
697(def-kernel-restart $xnopkg %default-no-package-restart (frame-ptr package-name)
698  (or (and *autoload-lisp-package*
699           (or (string-equal package-name "LISP") 
700               (string-equal package-name "USER"))
701           (progn
702             (require "LISP-PACKAGE")
703             (find-package package-name)))
704      (let* ((alias (or (%cdr (assoc package-name '(("LISP" . "COMMON-LISP")
705                                                    ("USER" . "CL-USER")) 
706                                     :test #'string-equal))
707                        (if (packagep *package*) (package-name *package*))))
708             (condition (make-condition 'no-such-package :package package-name)))
709        (flet ((try-again (p)
710                          (or (find-package p) (%kernel-restart $xnopkg p))))
711          (restart-case
712            (restart-case (%error condition nil frame-ptr)
713              (continue ()
714                        :report (lambda (s) (format s "Retry finding package with name ~S." package-name))
715                        (try-again package-name))
716              (use-value (value)
717                         :interactive (lambda () (block nil 
718                                                   (catch-cancel
719                                                    (return (list (get-string-from-user
720                                                                   "Find package named : "))))
721                                                   (continue condition)))
722                         :report (lambda (s) (format s "Find specified package instead of ~S ." package-name))
723                         (try-again value))
724              (make-nickname ()
725                             :report (lambda (s) (format s "Make ~S be a nickname for package ~S." package-name alias))
726                             (let ((p (try-again alias)))
727                               (push package-name (cdr (pkg.names p)))
728                               p)))
729            (require-lisp-package ()
730                                  :test (lambda (c)
731                                          (and (eq c condition)
732                                               (or (string-equal package-name "LISP") (string-equal package-name "USER"))))
733                                  :report (lambda (s) 
734                                            (format s "(require :lisp-package) and retry finding package ~s"
735                                                    package-name))
736                                  (require "LISP-PACKAGE")
737                                  (try-again package-name)))))))
738
739(def-kernel-restart $xunintc unintern-conflict-restarts (frame-ptr sym package conflicts)
740  (let ((condition (make-condition 'unintern-conflict-error :package package :sym sym :conflicts conflicts)))
741    (restart-case (%error condition nil frame-ptr)
742      (continue ()
743                :report (lambda (s) (format s "Try again to unintern ~s from ~s" sym package))
744                (unintern sym package))
745      (do-shadowing-import (ssym)
746                           :report (lambda (s) (format s "SHADOWING-IMPORT one of ~S in ~S." conflicts package))
747                           :interactive (lambda ()
748                                          (block nil
749                                            (catch-cancel
750                                             (return (select-item-from-list conflicts 
751                                                                            :window-title 
752                                                                            (format nil "Shadowing-import one of the following in ~s" package)
753                                                                            :table-print-function #'prin1)))
754                                            (continue condition)))
755                           (shadowing-import (list ssym) package)))))
756
757
758(def-kernel-restart $xusec blub (frame-ptr package-to-use using-package conflicts)
759  (resolve-use-package-conflict-error frame-ptr package-to-use using-package conflicts nil))
760
761(def-kernel-restart $xusecX blub (frame-ptr package-to-use using-package conflicts)
762  (resolve-use-package-conflict-error frame-ptr package-to-use using-package conflicts t))
763
764(defun resolve-use-package-conflict-error (frame-ptr package-to-use using-package conflicts external-p)
765  (let ((condition (make-condition 'use-package-conflict-error 
766                                   :package using-package
767                                   :package-to-use package-to-use
768                                   :conflicts conflicts
769                                   :external-p external-p)))
770    (flet ((external-test (&rest ignore) (declare (ignore ignore)) external-p)
771           (present-test (&rest ignore) (declare (ignore ignore)) (not external-p)))
772      (declare (dynamic-extent #'present-test #'external-test))
773      (restart-case (%error condition nil frame-ptr)
774        (continue ()
775                  :report (lambda (s) (format s "Try again to use ~s in ~s" package-to-use using-package)))
776        (resolve-by-shadowing-import (&rest shadowing-imports)
777                                     :test external-test
778                                     :interactive (lambda ()
779                                                    (mapcar #'(lambda (pair) 
780                                                                (block nil
781                                                                  (catch-cancel
782                                                                    (return (car (select-item-from-list pair
783                                                                                                        :window-title 
784                                                                                                        (format nil "Shadowing-import one of the following in ~s" using-package)
785                                                                                                        :table-print-function #'prin1))))
786                                                                  (continue condition)))
787                                                            conflicts))
788                                     :report (lambda (s) (format s "SHADOWING-IMPORT one of each pair of conflicting symbols."))
789                                     (shadowing-import shadowing-imports using-package))
790        (unintern-all ()
791                      :test present-test
792                      :report (lambda (s) (format s "UNINTERN all conflicting symbols from ~S" using-package))
793                      (dolist (c conflicts)
794                        (unintern (car c) using-package)))
795        (shadow-all ()
796                      :test present-test
797                      :report (lambda (s) (format s "SHADOW all conflicting symbols in ~S" using-package))
798                      (dolist (c conflicts)
799                        (shadow-1 using-package (car c))))
800        (resolve-by-unintern-or-shadow (&rest dispositions)
801                                       :test present-test
802                                       :interactive (lambda ()
803                                                      (mapcar #'(lambda (pair)
804                                                                  (let* ((present-sym (car pair)))
805                                                                    (block nil
806                                                                      (catch-cancel
807                                                                        (return (car (select-item-from-list (list 'shadow 'unintern) 
808                                                                                                            :window-title
809                                                                                                            (format nil "SHADOW ~S in, or UNINTERN ~S from ~S" 
810                                                                                                                    present-sym 
811                                                                                                                    present-sym
812                                                                                                                    using-package)
813                                                                                                            :table-print-function #'prin1)))
814                                                                        (continue condition)))))
815                                                              conflicts))
816                                       :report (lambda (s) (format s "SHADOW or UNINTERN the conflicting symbols in ~S." using-package))
817                                       (dolist (d dispositions)
818                                         (let* ((sym (car (pop conflicts))))
819                                           (if (eq d 'shadow)
820                                             (shadow-1 using-package sym)
821                                             (unintern sym using-package)))))))))
822
823
824(defun resolve-export-conflicts (conflicts package)
825  (let* ((first-inherited (caar conflicts))
826         (all-same (dolist (conflict (cdr conflicts) t)
827                     (unless (eq (car conflict) first-inherited) (return nil))))
828         (all-inherited (and all-same first-inherited))
829         (all-present (and all-same (not first-inherited)))
830         (condition (make-condition 'export-conflict-error
831                                    :conflicts conflicts
832                                    :package package)))
833    (flet ((check-again () 
834             (let* ((remaining-conflicts (check-export-conflicts (mapcar #'cadr conflicts) package)))
835               (if remaining-conflicts (resolve-export-conflicts remaining-conflicts package)))))
836      (restart-case (%error condition nil (%get-frame-ptr))
837        (resolve-all-by-shadowing-import-inherited 
838         ()
839         :test (lambda (&rest ignore) (declare (ignore ignore)) all-inherited)
840         :report (lambda (s) (format s "SHADOWING-IMPORT all conflicting inherited symbol(s) in using package(s)."))
841         (dolist (conflict conflicts (check-again))
842           (destructuring-bind (using-package inherited-sym) (cddr conflict)
843             (shadowing-import-1 using-package inherited-sym))))
844        (resolve-all-by-shadowing-import-exported 
845         ()
846         :test (lambda (&rest ignore) (declare (ignore ignore)) all-inherited)
847         :report (lambda (s) (format s "SHADOWING-IMPORT all conflicting symbol(s) to be exported in using package(s)."))
848         (dolist (conflict conflicts (check-again))
849           (destructuring-bind (exported-sym using-package ignore) (cdr conflict)
850             (declare (ignore ignore))
851             (shadowing-import-1 using-package exported-sym))))
852        (resolve-all-by-uninterning-present 
853         ()
854         :test (lambda (&rest ignore) (declare (ignore ignore)) all-present)
855         :report (lambda (s) (format s "UNINTERN all present conflicting symbol(s) in using package(s)."))
856         (dolist (conflict conflicts (check-again))
857           (destructuring-bind (using-package inherited-sym) (cddr conflict)
858             (unintern inherited-sym using-package))))
859        (resolve-all-by-shadowing-present 
860         ()
861         :test (lambda (&rest ignore) (declare (ignore ignore)) all-present)
862         :report (lambda (s) (format s "SHADOW all present conflicting symbol(s) in using package(s)."))
863         (dolist (conflict conflicts (check-again))
864           (destructuring-bind (using-package inherited-sym) (cddr conflict)
865             (shadow-1 using-package inherited-sym))))
866        (review-and-resolve 
867         (dispositions)
868         :report (lambda (s) (format s "Review each name conflict and resolve individually."))
869         :interactive (lambda ()
870                        (let* ((disp nil))
871                          (block b
872                            (catch-cancel
873                              (dolist (conflict conflicts (return-from b (list disp)))
874                                (destructuring-bind (inherited-p exported-sym using-package conflicting-sym) conflict
875                                  (let* ((syms (list exported-sym conflicting-sym)))
876                                    (if inherited-p
877                                      (push (list 'shadowing-import
878                                                  (select-item-from-list syms
879                                                                              :window-title 
880                                                                              (format nil "Shadowing-import one of the following in ~s" using-package)
881                                                                              :table-print-function #'prin1)
882                                                  using-package)
883                                            disp)
884                                      (let* ((selection (car (select-item-from-list syms
885                                                                                    :window-title 
886                                                                                    (format nil "Shadow ~S or unintern ~s in ~s"
887                                                                                            exported-sym 
888                                                                                            conflicting-sym using-package)
889                                                                                    :table-print-function #'prin1))))
890                                        (push (if (eq selection 'exported-sym)
891                                                (list 'shadow (list exported-sym) using-package)
892                                                (list 'unintern conflicting-sym using-package))
893                                              disp)))))))
894                            nil)))
895         (dolist (disp dispositions (check-again))
896           (apply (car disp) (cdr disp))))))))
897
898
899(def-kernel-restart $xwrongtype default-require-type-restarts (frame-ptr value typespec)
900  (setq typespec (%type-error-type typespec))
901  (let ((condition (make-condition 'type-error 
902                                   :datum value
903                                   :expected-type typespec)))
904    (restart-case (%error condition nil frame-ptr)
905      (use-value (newval)
906                 :report (lambda (s)
907                           (format s "Use a new value of type ~s instead of ~s." typespec value))
908                 :interactive (lambda ()
909                                (format *query-io* "~&New value of type ~S :" typespec)
910                                (list (read *query-io*)))
911                 (require-type newval typespec)))))
912
913(def-kernel-restart $xudfcall default-undefined-function-call-restarts (frame-ptr function-name args)
914  (unless *level-1-loaded*
915    (dbg function-name))   ; user should never see this
916  (let ((condition (make-condition 'undefined-function-call
917                                   :name function-name
918                                   :function-arguments args))
919        (other-function (find-unique-homonym function-name #'fboundp)))
920    (restart-case (%error condition nil frame-ptr)
921      (continue ()
922                :report (lambda (s) (format s "Retry applying ~S to ~S." function-name args))
923                (apply function-name args))
924      (use-homonym ()
925                   :test (lambda (c) (and (or (null c) (eq c condition)) other-function))
926                   :report (lambda (s) (format s "Apply ~s to ~S this time." other-function args))
927                   (apply other-function args))
928      (use-value (function)
929                 :interactive (lambda ()
930                                (format *query-io* "Function to apply instead of ~s :" function-name)
931                                (let ((f (read *query-io*)))
932                                  (unless (symbolp f) (setq f (eval f))) ; almost-the-right-thing (tm)
933                                  (list (coerce f 'function))))
934                 :report (lambda (s) (format s "Apply specified function to ~S this time." args))
935                 (apply function args))
936      (store-value (function)
937                   :interactive (lambda ()
938                                (format *query-io* "Function to apply as new definition of ~s :" function-name)
939                                (let ((f (read *query-io*)))
940                                  (unless (symbolp f) (setq f (eval f))) ; almost-the-right-thing (tm)
941                                  (list (coerce f 'function))))
942                   :report (lambda (s) (format s "Specify a function to use as the definition of ~S." function-name))
943                   (apply (setf (symbol-function function-name) function) args)))))
944
945
946
947
948; This has to be defined fairly early (assuming, of course, that it "has" to be defined at all ...
949
950(defun ensure-value-of-type (value typespec placename &optional typename)
951  (tagbody
952    again
953    (unless (typep value typespec)
954      (let ((condition (make-condition 'type-error 
955                                       :datum value
956                                       :expected-type typespec)))
957        (if typename
958            (setf (slot-value condition 'format-control)
959                  (format nil "value ~~S is not ~A (~~S)." typename)))
960        (restart-case (%error condition nil (%get-frame-ptr))
961          (store-value (newval)
962                       :report (lambda (s)
963                                 (format s "Assign a new value of type ~a to ~s" typespec placename))
964                       :interactive (lambda ()
965                                      (format *query-io* "~&New value for ~S :" placename)
966                                      (list (eval (read))))
967                       (setq value newval)
968                       (go again))))))
969  value)
970
971;;;The Error Function
972
973(defparameter *kernel-simple-error-classes*
974  (list (cons $xcalltoofew 'simple-destructuring-error)
975        (cons $xcalltoomany 'simple-destructuring-error)
976        (cons $xstkover 'stack-overflow-condition)
977        (cons $xmemfull 'simple-storage-condition)
978        (cons $xwrongtype 'type-error) ; this one needs 2 args
979        (cons $xdivzro 'division-by-zero)
980        (cons $xflovfl 'floating-point-overflow)
981        (cons $xfunbnd 'undefined-function)
982        (cons $xbadkeys 'simple-program-error)
983        (cons $xnotfun 'call-special-operator-or-macro)
984        (cons $xaccessnth 'sequence-index-type-error)
985        (cons $ximproperlist 'improper-list)
986        (cons $xnospread 'cant-construct-arglist)
987        ))
988
989
990(defparameter *simple-error-types*
991  (vector nil 'simple-program-error 'simple-file-error))
992
993(defconstant $pgm-err #x10000)
994
995
996
997
998(defparameter %type-error-typespecs%
999  #(array
1000    bignum
1001    fixnum
1002    character
1003    integer
1004    list
1005    number
1006    sequence
1007    simple-string
1008    simple-vector
1009    string
1010    symbol
1011    macptr
1012    real
1013    cons
1014    unsigned-byte
1015    (integer 2 36)
1016    float
1017    rational
1018    ratio
1019    short-float
1020    double-float
1021    complex
1022    vector
1023    simple-base-string
1024    function
1025    (unsigned-byte 16)
1026    (unsigned-byte 8)
1027    (unsigned-byte 32)
1028    (signed-byte 32)
1029    (signed-byte 16)
1030    (signed-byte 8)
1031    base-char
1032    bit
1033    (unsigned-byte 24)                  ; (integer 0 (array-total-size-limit))
1034    (unsigned-byte 64)
1035    (signed-byte 64)
1036    (unsigned-byte 56)
1037    (simple-array double-float (* *))
1038    (simple-array single-float (* *))
1039    (mod #x110000)
1040    (array * (* *))                     ;2d array
1041    (array * (* * *))                   ;3d array
1042    (array t)
1043    (array bit)
1044    (array (signed-byte 8))
1045    (array (unsigned-byte 8))
1046    (array (signed-byte 16))
1047    (array (unsigned-byte 16))
1048    (array (signed-byte 32))
1049    (array (unsigned-byte 32))
1050    (array (signed-byte 64))
1051    (array (unsigned-byte 64))
1052    (array fixnum)
1053    (array single-float)
1054    (array double-float)
1055    (array character)
1056    (array t (* *))
1057    (array bit (* *))
1058    (array (signed-byte 8) (* *))
1059    (array (unsigned-byte 8) (* *))
1060    (array (signed-byte 16) (* *))
1061    (array (unsigned-byte 16) (* *))
1062    (array (signed-byte 32) (* *))
1063    (array (unsigned-byte 32) (* *))
1064    (array (signed-byte 64) (* *))
1065    (array (unsigned-byte 64) (* *))
1066    (array fixnum (* *))
1067    (array single-float (* *))
1068    (array double-float (* *))
1069    (array character (* *))
1070    (simple-array t (* *))
1071    (simple-array bit (* *))
1072    (simple-array (signed-byte 8) (* *))
1073    (simple-array (unsigned-byte 8) (* *))
1074    (simple-array (signed-byte 16) (* *))
1075    (simple-array (unsigned-byte 16) (* *))
1076    (simple-array (signed-byte 32) (* *))
1077    (simple-array (unsigned-byte 32) (* *))
1078    (simple-array (signed-byte 64) (* *))
1079    (simple-array (unsigned-byte 64) (* *))
1080    (simple-array fixnum (* *))
1081    (simple-array character (* *))
1082    (array t (* * *))
1083    (array bit (* * *))
1084    (array (signed-byte 8) (* * *))
1085    (array (unsigned-byte 8) (* * *))
1086    (array (signed-byte 16) (* * *))
1087    (array (unsigned-byte 16) (* * *))
1088    (array (signed-byte 32) (* * *))
1089    (array (unsigned-byte 32) (* * *))
1090    (array (signed-byte 64) (* * *))
1091    (array (unsigned-byte 64) (* * *))
1092    (array fixnum (* * *))
1093    (array single-float (* * *))
1094    (array double-float (* * *))
1095    (array character (* * *))
1096    (simple-array t (* * *))
1097    (simple-array bit (* * *))
1098    (simple-array (signed-byte 8) (* * *))
1099    (simple-array (unsigned-byte 8) (* * *))
1100    (simple-array (signed-byte 16) (* * *))
1101    (simple-array (unsigned-byte 16) (* * *))
1102    (simple-array (signed-byte 32) (* * *))
1103    (simple-array (unsigned-byte 32) (* * *))
1104    (simple-array (signed-byte 64) (* * *))
1105    (simple-array (unsigned-byte 64) (* * *))
1106    (simple-array fixnum (* * *))
1107    (simple-array single-float (* * *))
1108    (simple-array double-float (* * *))
1109    (simple-array char (* * *))
1110   
1111    ))
1112
1113
1114(defun %type-error-type (type)
1115  (if (fixnump type) 
1116    (svref %type-error-typespecs% type)
1117    type))
1118
1119(defun %typespec-id (typespec)
1120  (flet ((type-equivalent (t1 t2) (ignore-errors (and (subtypep t1 t2) (subtypep t2 t1)))))
1121    (position typespec %type-error-typespecs% :test #'type-equivalent)))
1122
1123
1124(defmethod condition-p ((x t)) nil)
1125(defmethod condition-p ((x condition)) t)
1126
1127
1128
1129(let* ((globals ()))
1130
1131  (defun %check-error-globals ()
1132    (let ((vars ())
1133          (valfs ())
1134          (oldvals ()))
1135      (dolist (g globals (values vars valfs oldvals))
1136        (destructuring-bind (sym predicate newvalf) g
1137          (let* ((boundp (boundp sym))
1138                 (oldval (if boundp (symbol-value sym) (%unbound-marker-8))))
1139          (unless (and boundp (funcall predicate oldval))
1140            (push sym vars)
1141            (push oldval oldvals)
1142            (push newvalf valfs)))))))
1143
1144  (defun check-error-global (sym checkfn newvalfn)
1145    (setq sym (require-type sym 'symbol)
1146          checkfn (require-type checkfn 'function)
1147          newvalfn (require-type newvalfn 'function))
1148    (let ((found (assq sym globals)))
1149      (if found
1150        (setf (cadr found) checkfn (caddr found) newvalfn)
1151        (push (list sym checkfn newvalfn) globals))
1152      sym))
1153)
1154
1155(check-error-global '*package* #'packagep #'(lambda () (find-package "CL-USER")))
1156
1157
1158 
1159
Note: See TracBrowser for help on using the repository browser.