source: branches/working-0710/ccl/level-1/l1-error-system.lisp @ 7404

Last change on this file since 7404 was 7404, checked in by gb, 14 years ago

NOT-LOCKED, DEADLOCK lock-related conditions.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 50.8 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 ~s" (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 "Error ~s : ~&~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  (:report (lambda (c s) (format s "~S detected ~&performing ~S on ~:S"
453                                 (type-of c) 
454                                 (arithmetic-error-operation c) 
455                                 (arithmetic-error-operands c)))))
456
457(define-condition division-by-zero (arithmetic-error))
458 
459(define-condition floating-point-underflow (arithmetic-error))
460(define-condition floating-point-overflow (arithmetic-error))
461(define-condition floating-point-inexact (arithmetic-error))
462(define-condition floating-point-invalid-operation (arithmetic-error))
463
464(defun restartp (thing) 
465  (istruct-typep thing 'restart))
466(setf (type-predicate 'restart) 'restartp)
467
468(defmethod print-object ((restart restart) stream)
469  (let ((report (%restart-report restart)))
470    (cond ((or *print-escape* (null report))
471           (print-unreadable-object (restart stream :identity t)
472             (format stream "~S ~S"
473                     'restart (%restart-name restart))))
474          ((stringp report)
475           (write-string report stream))
476          (t
477           (funcall report stream)))))
478
479(defun %make-restart (name action report interactive test)
480  (%cons-restart name action report interactive test))
481
482(defun make-restart (vector name action-function &key report-function interactive-function test-function)
483  (unless vector (setq vector (%cons-restart nil nil nil nil nil)))
484  (setf (%restart-name vector) name
485        (%restart-action vector) (require-type action-function 'function)
486        (%restart-report vector) (if report-function (require-type report-function 'function))
487        (%restart-interactive vector) (if interactive-function (require-type interactive-function 'function))
488        (%restart-test vector) (if test-function (require-type test-function 'function)))
489  vector)
490
491(defun restart-name (restart)
492  "Return the name of the given restart object."
493  (%restart-name (require-type restart 'restart)))
494
495(defun applicable-restart-p (restart condition)
496  (let* ((pair (if condition (assq restart *condition-restarts*)))
497         (test (%restart-test restart)))
498    (and (or (null pair) (eq (%cdr pair) condition))
499         (or (null test) (funcall test condition)))))
500
501(defun compute-restarts (&optional condition &aux restarts)
502  "Return a list of all the currently active restarts ordered from most
503   recently established to less recently established. If CONDITION is
504   specified, then only restarts associated with CONDITION (or with no
505   condition) will be returned."
506  (dolist (cluster %restarts% (nreverse restarts))
507    (dolist (restart cluster)
508      (when (applicable-restart-p restart condition)
509        (push restart restarts)))))
510
511(defun find-restart (name &optional condition)
512  "Return the first active restart named NAME. If NAME names a
513   restart, the restart is returned if it is currently active. If no such
514   restart is found, NIL is returned. It is an error to supply NIL as a
515   name. If CONDITION is specified and not NIL, then only restarts
516   associated with that condition (or with no condition) will be
517   returned."
518  (dolist (cluster %restarts%)
519    (dolist (restart cluster)
520      (when (and (or (eq restart name) (eq (restart-name restart) name))
521                 (applicable-restart-p restart condition))
522        (return-from find-restart restart)))))
523
524(defun %active-restart (name)
525  (dolist (cluster %restarts%)
526    (dolist (restart cluster)
527      (let* ((rname (%restart-name restart))
528             (rtest (%restart-test restart)))
529        (when (and (or (eq restart name) (eq rname name))
530                   (or (null rtest) (funcall rtest nil)))
531          (return-from %active-restart (values restart cluster))))))
532  (error 'inactive-restart :restart-name name))
533
534(defun invoke-restart (restart &rest values)
535  "Calls the function associated with the given restart, passing any given
536   arguments. If the argument restart is not a restart or a currently active
537   non-nil restart name, then a CONTROL-ERROR is signalled."
538  (multiple-value-bind (restart tag) (%active-restart restart)
539    (let ((fn (%restart-action restart)))
540      (cond ((null fn)                  ; simple restart
541             (unless (null values) (%err-disp $xtminps))
542             (throw tag nil))
543            ((fixnump fn)               ; restart case
544             (throw tag (cons fn values)))
545            ((functionp fn)             ; restart bind
546             (apply fn values))         
547            (t                          ; with-simple-restart
548             (throw tag (values nil t)))))))
549
550(defun invoke-restart-no-return (restart)
551  (invoke-restart restart)
552  (error 'restart-failure :restart restart))
553
554(defun invoke-restart-interactively (restart)
555  "Calls the function associated with the given restart, prompting for any
556   necessary arguments. If the argument restart is not a restart or a
557   currently active non-NIL restart name, then a CONTROL-ERROR is signalled."
558  (let* ((restart (find-restart restart)))
559    (format *error-output* "~&Invoking restart: ~a~&" restart)
560    (let* ((argfn (%restart-interactive restart))
561           (values (when argfn (funcall argfn))))
562      (apply #'invoke-restart restart values))))
563
564
565
566(defun maybe-invoke-restart (restart value condition)
567  (let ((restart (find-restart restart condition)))
568    (when restart (invoke-restart restart value))))
569
570(defun use-value (value &optional condition)
571  "Transfer control and VALUE to a restart named USE-VALUE, or return NIL if
572   none exists."
573  (maybe-invoke-restart 'use-value value condition))
574
575(defun store-value (value &optional condition)
576  "Transfer control and VALUE to a restart named STORE-VALUE, or return NIL if
577   none exists."
578  (maybe-invoke-restart 'store-value value condition))
579
580(defun condition-arg (thing args type)
581  (cond ((condition-p thing) (if args (%err-disp $xtminps) thing))
582        ((symbolp thing) (apply #'make-condition thing args))
583        (t (make-condition type :format-control thing :format-arguments args))))
584
585(defun make-condition (name &rest init-list)
586  "Make an instance of a condition object using the specified initargs."
587  (declare (dynamic-extent init-list))
588  (if (subtypep name 'condition)
589    (apply #'make-instance name init-list)
590    (error "~S is not a defined condition type name" name)))
591
592(defmethod print-object ((c condition) stream)
593  (if *print-escape* 
594    (call-next-method)
595    (report-condition c stream)))
596
597(defmethod report-condition ((c condition) stream)
598  (princ (cond ((typep c 'error) "Error ")
599               ((typep c 'warning) "Warning ")
600               (t "Condition "))
601         stream)
602  ;Here should dump all slots or something.  For now...
603  (let ((*print-escape* t))
604    (print-object c stream)))
605
606(defun signal-simple-condition (class-name format-string &rest args)
607  (let ((e #'error))  ; Never-tail-call.
608    (funcall e (make-condition class-name :format-control format-string :format-arguments args))))
609
610(defun signal-simple-program-error (format-string &rest args)
611  (apply #'signal-simple-condition 'simple-program-error format-string args))
612
613;;getting the function name for error functions.
614
615
616(defun %last-fn-on-stack (&optional (number 0) (s (%get-frame-ptr)))
617  (let* ((fn nil))
618    (let ((p s))
619      (dotimes (i number)
620        (declare (fixnum i))
621        (unless (setq p (parent-frame p nil))
622          (return)))
623      (do* ((i number (1+ i)))
624           ((null p))
625        (if (setq fn (cfp-lfun p))
626          (return (values fn i))
627          (setq p (parent-frame p nil)))))))
628 
629(defun %err-fn-name (lfun)
630  "given an lfun returns the name or the string \"Unknown\""
631  (if (lfunp lfun) (or (lfun-name lfun) lfun)
632     (or lfun "Unknown")))
633
634(defun %real-err-fn-name (error-pointer)
635  (multiple-value-bind (fn p) (%last-fn-on-stack 0 error-pointer)
636    (let ((name (%err-fn-name fn)))
637      (if (and (memq name '( call-check-regs)) p)
638        (%err-fn-name (%last-fn-on-stack (1+ p) error-pointer))
639        name))))
640
641
642;; Some simple restarts for simple error conditions.  Callable from the kernel.
643
644(defun find-unique-homonym (name &optional test)
645  (let ((pname (and name (symbolp name) (symbol-name name)))
646        (other-name nil))
647    (dolist (pkg (list-all-packages) other-name)
648      (let ((candidate (find-symbol pname pkg)))
649        (when (and candidate
650                   (not (eq candidate name))
651                   (or (null test) (funcall test candidate)))
652          (when (and other-name (neq other-name candidate))
653            (return nil)) ;; more than one, too complicated, give up
654          (setq other-name candidate))))))
655
656
657(def-kernel-restart $xvunbnd %default-unbound-variable-restarts (frame-ptr cell-name)
658  (unless *level-1-loaded*
659    (dbg cell-name))       ;  user should never see this.
660  (let ((condition (make-condition 'unbound-variable :name cell-name))
661        (other-variable (find-unique-homonym cell-name #'boundp)))
662    (flet ((new-value ()
663             (catch-cancel
664              (return-from new-value
665                           (list (read-from-string 
666                                  (get-string-from-user
667                                   (format nil "New value for ~s : " cell-name))))))
668             (continue condition))) ; force error again if cancelled, var still not set.
669      (restart-case (%error condition nil frame-ptr)
670        (continue ()
671                  :report (lambda (s) (format s "Retry getting the value of ~S." cell-name))
672                  (symbol-value cell-name))
673        (use-homonym ()
674                     :test (lambda (c) (and (or (null c) (eq c condition)) other-variable))
675                     :report (lambda (s) (format s "Use the value of ~s this time." other-variable))
676                     (symbol-value other-variable))
677        (use-value (value)
678                   :interactive new-value
679                   :report (lambda (s) (format s "Specify a value of ~S to use this time." cell-name))
680                   value)
681        (store-value (value)
682                     :interactive new-value
683                     :report (lambda (s) (format s "Specify a value of ~S to store and use." cell-name))
684                     (setf (symbol-value cell-name) value))))))
685
686(def-kernel-restart $xnopkg %default-no-package-restart (frame-ptr package-name)
687  (or (and *autoload-lisp-package*
688           (or (string-equal package-name "LISP") 
689               (string-equal package-name "USER"))
690           (progn
691             (require "LISP-PACKAGE")
692             (find-package package-name)))
693      (let* ((alias (or (%cdr (assoc package-name '(("LISP" . "COMMON-LISP")
694                                                    ("USER" . "CL-USER")) 
695                                     :test #'string-equal))
696                        (if (packagep *package*) (package-name *package*))))
697             (condition (make-condition 'no-such-package :package package-name)))
698        (flet ((try-again (p)
699                          (or (find-package p) (%kernel-restart $xnopkg p))))
700          (restart-case
701            (restart-case (%error condition nil frame-ptr)
702              (continue ()
703                        :report (lambda (s) (format s "Retry finding package with name ~S." package-name))
704                        (try-again package-name))
705              (use-value (value)
706                         :interactive (lambda () (block nil 
707                                                   (catch-cancel
708                                                    (return (list (get-string-from-user
709                                                                   "Find package named : "))))
710                                                   (continue condition)))
711                         :report (lambda (s) (format s "Find specified package instead of ~S ." package-name))
712                         (try-again value))
713              (make-nickname ()
714                             :report (lambda (s) (format s "Make ~S be a nickname for package ~S." package-name alias))
715                             (let ((p (try-again alias)))
716                               (push package-name (cdr (pkg.names p)))
717                               p)))
718            (require-lisp-package ()
719                                  :test (lambda (c)
720                                          (and (eq c condition)
721                                               (or (string-equal package-name "LISP") (string-equal package-name "USER"))))
722                                  :report (lambda (s) 
723                                            (format s "(require :lisp-package) and retry finding package ~s"
724                                                    package-name))
725                                  (require "LISP-PACKAGE")
726                                  (try-again package-name)))))))
727
728(def-kernel-restart $xunintc unintern-conflict-restarts (frame-ptr sym package conflicts)
729  (let ((condition (make-condition 'unintern-conflict-error :package package :sym sym :conflicts conflicts)))
730    (restart-case (%error condition nil frame-ptr)
731      (continue ()
732                :report (lambda (s) (format s "Try again to unintern ~s from ~s" sym package))
733                (unintern sym package))
734      (do-shadowing-import (ssym)
735                           :report (lambda (s) (format s "SHADOWING-IMPORT one of ~S in ~S." conflicts package))
736                           :interactive (lambda ()
737                                          (block nil
738                                            (catch-cancel
739                                             (return (select-item-from-list conflicts 
740                                                                            :window-title 
741                                                                            (format nil "Shadowing-import one of the following in ~s" package)
742                                                                            :table-print-function #'prin1)))
743                                            (continue condition)))
744                           (shadowing-import (list ssym) package)))))
745
746
747(def-kernel-restart $xusec blub (frame-ptr package-to-use using-package conflicts)
748  (resolve-use-package-conflict-error frame-ptr package-to-use using-package conflicts nil))
749
750(def-kernel-restart $xusecX blub (frame-ptr package-to-use using-package conflicts)
751  (resolve-use-package-conflict-error frame-ptr package-to-use using-package conflicts t))
752
753(defun resolve-use-package-conflict-error (frame-ptr package-to-use using-package conflicts external-p)
754  (let ((condition (make-condition 'use-package-conflict-error 
755                                   :package using-package
756                                   :package-to-use package-to-use
757                                   :conflicts conflicts
758                                   :external-p external-p)))
759    (flet ((external-test (&rest ignore) (declare (ignore ignore)) external-p)
760           (present-test (&rest ignore) (declare (ignore ignore)) (not external-p)))
761      (declare (dynamic-extent #'present-test #'external-test))
762      (restart-case (%error condition nil frame-ptr)
763        (continue ()
764                  :report (lambda (s) (format s "Try again to use ~s in ~s" package-to-use using-package)))
765        (resolve-by-shadowing-import (&rest shadowing-imports)
766                                     :test external-test
767                                     :interactive (lambda ()
768                                                    (mapcar #'(lambda (pair) 
769                                                                (block nil
770                                                                  (catch-cancel
771                                                                    (return (car (select-item-from-list pair
772                                                                                                        :window-title 
773                                                                                                        (format nil "Shadowing-import one of the following in ~s" using-package)
774                                                                                                        :table-print-function #'prin1))))
775                                                                  (continue condition)))
776                                                            conflicts))
777                                     :report (lambda (s) (format s "SHADOWING-IMPORT one of each pair of conflicting symbols."))
778                                     (shadowing-import shadowing-imports using-package))
779        (unintern-all ()
780                      :test present-test
781                      :report (lambda (s) (format s "UNINTERN all conflicting symbols from ~S" using-package))
782                      (dolist (c conflicts)
783                        (unintern (car c) using-package)))
784        (shadow-all ()
785                      :test present-test
786                      :report (lambda (s) (format s "SHADOW all conflicting symbols in ~S" using-package))
787                      (dolist (c conflicts)
788                        (shadow-1 using-package (car c))))
789        (resolve-by-unintern-or-shadow (&rest dispositions)
790                                       :test present-test
791                                       :interactive (lambda ()
792                                                      (mapcar #'(lambda (pair)
793                                                                  (let* ((present-sym (car pair)))
794                                                                    (block nil
795                                                                      (catch-cancel
796                                                                        (return (car (select-item-from-list (list 'shadow 'unintern) 
797                                                                                                            :window-title
798                                                                                                            (format nil "SHADOW ~S in, or UNINTERN ~S from ~S" 
799                                                                                                                    present-sym 
800                                                                                                                    present-sym
801                                                                                                                    using-package)
802                                                                                                            :table-print-function #'prin1)))
803                                                                        (continue condition)))))
804                                                              conflicts))
805                                       :report (lambda (s) (format s "SHADOW or UNINTERN the conflicting symbols in ~S." using-package))
806                                       (dolist (d dispositions)
807                                         (let* ((sym (car (pop conflicts))))
808                                           (if (eq d 'shadow)
809                                             (shadow-1 using-package sym)
810                                             (unintern sym using-package)))))))))
811
812
813(defun resolve-export-conflicts (conflicts package)
814  (let* ((first-inherited (caar conflicts))
815         (all-same (dolist (conflict (cdr conflicts) t)
816                     (unless (eq (car conflict) first-inherited) (return nil))))
817         (all-inherited (and all-same first-inherited))
818         (all-present (and all-same (not first-inherited)))
819         (condition (make-condition 'export-conflict-error
820                                    :conflicts conflicts
821                                    :package package)))
822    (flet ((check-again () 
823             (let* ((remaining-conflicts (check-export-conflicts (mapcar #'cadr conflicts) package)))
824               (if remaining-conflicts (resolve-export-conflicts remaining-conflicts package)))))
825      (restart-case (%error condition nil (%get-frame-ptr))
826        (resolve-all-by-shadowing-import-inherited 
827         ()
828         :test (lambda (&rest ignore) (declare (ignore ignore)) all-inherited)
829         :report (lambda (s) (format s "SHADOWING-IMPORT all conflicting inherited symbol(s) in using package(s)."))
830         (dolist (conflict conflicts (check-again))
831           (destructuring-bind (using-package inherited-sym) (cddr conflict)
832             (shadowing-import-1 using-package inherited-sym))))
833        (resolve-all-by-shadowing-import-exported 
834         ()
835         :test (lambda (&rest ignore) (declare (ignore ignore)) all-inherited)
836         :report (lambda (s) (format s "SHADOWING-IMPORT all conflicting symbol(s) to be exported in using package(s)."))
837         (dolist (conflict conflicts (check-again))
838           (destructuring-bind (exported-sym using-package ignore) (cdr conflict)
839             (declare (ignore ignore))
840             (shadowing-import-1 using-package exported-sym))))
841        (resolve-all-by-uninterning-present 
842         ()
843         :test (lambda (&rest ignore) (declare (ignore ignore)) all-present)
844         :report (lambda (s) (format s "UNINTERN all present conflicting symbol(s) in using package(s)."))
845         (dolist (conflict conflicts (check-again))
846           (destructuring-bind (using-package inherited-sym) (cddr conflict)
847             (unintern inherited-sym using-package))))
848        (resolve-all-by-shadowing-present 
849         ()
850         :test (lambda (&rest ignore) (declare (ignore ignore)) all-present)
851         :report (lambda (s) (format s "SHADOW all present conflicting symbol(s) in using package(s)."))
852         (dolist (conflict conflicts (check-again))
853           (destructuring-bind (using-package inherited-sym) (cddr conflict)
854             (shadow-1 using-package inherited-sym))))
855        (review-and-resolve 
856         (dispositions)
857         :report (lambda (s) (format s "Review each name conflict and resolve individually."))
858         :interactive (lambda ()
859                        (let* ((disp nil))
860                          (block b
861                            (catch-cancel
862                              (dolist (conflict conflicts (return-from b (list disp)))
863                                (destructuring-bind (inherited-p exported-sym using-package conflicting-sym) conflict
864                                  (let* ((syms (list exported-sym conflicting-sym)))
865                                    (if inherited-p
866                                      (push (list 'shadowing-import
867                                                  (select-item-from-list syms
868                                                                              :window-title 
869                                                                              (format nil "Shadowing-import one of the following in ~s" using-package)
870                                                                              :table-print-function #'prin1)
871                                                  using-package)
872                                            disp)
873                                      (let* ((selection (car (select-item-from-list syms
874                                                                                    :window-title 
875                                                                                    (format nil "Shadow ~S or unintern ~s in ~s"
876                                                                                            exported-sym 
877                                                                                            conflicting-sym using-package)
878                                                                                    :table-print-function #'prin1))))
879                                        (push (if (eq selection 'exported-sym)
880                                                (list 'shadow (list exported-sym) using-package)
881                                                (list 'unintern conflicting-sym using-package))
882                                              disp)))))))
883                            nil)))
884         (dolist (disp dispositions (check-again))
885           (apply (car disp) (cdr disp))))))))
886
887
888(def-kernel-restart $xwrongtype default-require-type-restarts (frame-ptr value typespec)
889  (setq typespec (%type-error-type typespec))
890  (let ((condition (make-condition 'type-error 
891                                   :datum value
892                                   :expected-type typespec)))
893    (restart-case (%error condition nil frame-ptr)
894      (use-value (newval)
895                 :report (lambda (s)
896                           (format s "Use a new value of type ~s instead of ~s." typespec value))
897                 :interactive (lambda ()
898                                (format *query-io* "~&New value of type ~S :" typespec)
899                                (list (read *query-io*)))
900                 (require-type newval typespec)))))
901
902(def-kernel-restart $xudfcall default-undefined-function-call-restarts (frame-ptr function-name args)
903  (unless *level-1-loaded*
904    (dbg function-name))   ; user should never see this
905  (let ((condition (make-condition 'undefined-function-call
906                                   :name function-name
907                                   :function-arguments args))
908        (other-function (find-unique-homonym function-name #'fboundp)))
909    (restart-case (%error condition nil frame-ptr)
910      (continue ()
911                :report (lambda (s) (format s "Retry applying ~S to ~S." function-name args))
912                (apply function-name args))
913      (use-homonym ()
914                   :test (lambda (c) (and (or (null c) (eq c condition)) other-function))
915                   :report (lambda (s) (format s "Apply ~s to ~S this time." other-function args))
916                   (apply other-function args))
917      (use-value (function)
918                 :interactive (lambda ()
919                                (format *query-io* "Function to apply instead of ~s :" function-name)
920                                (let ((f (read *query-io*)))
921                                  (unless (symbolp f) (setq f (eval f))) ; almost-the-right-thing (tm)
922                                  (list (coerce f 'function))))
923                 :report (lambda (s) (format s "Apply specified function to ~S this time." args))
924                 (apply function args))
925      (store-value (function)
926                   :interactive (lambda ()
927                                (format *query-io* "Function to apply as new definition of ~s :" function-name)
928                                (let ((f (read *query-io*)))
929                                  (unless (symbolp f) (setq f (eval f))) ; almost-the-right-thing (tm)
930                                  (list (coerce f 'function))))
931                   :report (lambda (s) (format s "Specify a function to use as the definition of ~S." function-name))
932                   (apply (setf (symbol-function function-name) function) args)))))
933
934
935
936
937; This has to be defined fairly early (assuming, of course, that it "has" to be defined at all ...
938
939(defun ensure-value-of-type (value typespec placename &optional typename)
940  (tagbody
941    again
942    (unless (typep value typespec)
943      (let ((condition (make-condition 'type-error 
944                                       :datum value
945                                       :expected-type typespec)))
946        (if typename
947            (setf (slot-value condition 'format-control)
948                  (format nil "value ~~S is not ~A (~~S)." typename)))
949        (restart-case (%error condition nil (%get-frame-ptr))
950          (store-value (newval)
951                       :report (lambda (s)
952                                 (format s "Assign a new value of type ~a to ~s" typespec placename))
953                       :interactive (lambda ()
954                                      (format *query-io* "~&New value for ~S :" placename)
955                                      (list (eval (read))))
956                       (setq value newval)
957                       (go again))))))
958  value)
959
960;;;The Error Function
961
962(defparameter *kernel-simple-error-classes*
963  (list (cons $xcalltoofew 'simple-destructuring-error)
964        (cons $xcalltoomany 'simple-destructuring-error)
965        (cons $xstkover 'stack-overflow-condition)
966        (cons $xmemfull 'simple-storage-condition)
967        (cons $xwrongtype 'type-error) ; this one needs 2 args
968        (cons $xdivzro 'division-by-zero)
969        (cons $xflovfl 'floating-point-overflow)
970        (cons $xfunbnd 'undefined-function)
971        (cons $xbadkeys 'simple-program-error)
972        (cons $xnotfun 'call-special-operator-or-macro)
973        (cons $xaccessnth 'sequence-index-type-error)
974        (cons $ximproperlist 'improper-list)
975        (cons $xnospread 'cant-construct-arglist)
976        ))
977
978
979(defparameter *simple-error-types*
980  (vector nil 'simple-program-error 'simple-file-error))
981
982(defconstant $pgm-err #x10000)
983
984
985
986
987(defparameter %type-error-typespecs%
988  #(array
989    bignum
990    fixnum
991    character
992    integer
993    list
994    number
995    sequence
996    simple-string
997    simple-vector
998    string
999    symbol
1000    macptr
1001    real
1002    cons
1003    unsigned-byte
1004    (integer 2 36)
1005    float
1006    rational
1007    ratio
1008    short-float
1009    double-float
1010    complex
1011    vector
1012    simple-base-string
1013    function
1014    (unsigned-byte 16)
1015    (unsigned-byte 8)
1016    (unsigned-byte 32)
1017    (signed-byte 32)
1018    (signed-byte 16)
1019    (signed-byte 8)
1020    base-char
1021    bit
1022    (unsigned-byte 24)                  ; (integer 0 (array-total-size-limit))
1023    (unsigned-byte 64)
1024    (signed-byte 64)
1025    (unsigned-byte 56)
1026    (simple-array double-float (* *))
1027    (simple-array single-float (* *))
1028    (mod #x110000)
1029    (array * (* *))                     ;2d array
1030    (array * (* *))                     ;3d array
1031    (array t)
1032    (array bit)
1033    (array (signed-byte 8))
1034    (array (unsigned-byte 8))
1035    (array (signed-byte 16))
1036    (array (unsigned-byte 16))
1037    (array (signed-byte 32))
1038    (array (unsigned-byte 32))
1039    (array (signed-byte 64))
1040    (array (unsigned-byte 64))
1041    (array fixnum)
1042    (array single-float)
1043    (array double-float)
1044    (array character)
1045    (array t (* *))
1046    (array bit (* *))
1047    (array (signed-byte 8) (* *))
1048    (array (unsigned-byte 8) (* *))
1049    (array (signed-byte 16) (* *))
1050    (array (unsigned-byte 16) (* *))
1051    (array (signed-byte 32) (* *))
1052    (array (unsigned-byte 32) (* *))
1053    (array (signed-byte 64) (* *))
1054    (array (unsigned-byte 64) (* *))
1055    (array fixnum (* *))
1056    (array single-float (* *))
1057    (array double-float (* *))
1058    (array character (* *))
1059    (simple-array t (* *))
1060    (simple-array bit (* *))
1061    (simple-array (signed-byte 8) (* *))
1062    (simple-array (unsigned-byte 8) (* *))
1063    (simple-array (signed-byte 16) (* *))
1064    (simple-array (unsigned-byte 16) (* *))
1065    (simple-array (signed-byte 32) (* *))
1066    (simple-array (unsigned-byte 32) (* *))
1067    (simple-array (signed-byte 64) (* *))
1068    (simple-array (unsigned-byte 64) (* *))
1069    (simple-array fixnum (* *))
1070    (simple-array character (* *))
1071    (array t (* * *))
1072    (array bit (* * *))
1073    (array (signed-byte 8) (* * *))
1074    (array (unsigned-byte 8) (* * *))
1075    (array (signed-byte 16) (* * *))
1076    (array (unsigned-byte 16) (* * *))
1077    (array (signed-byte 32) (* * *))
1078    (array (unsigned-byte 32) (* * *))
1079    (array (signed-byte 64) (* * *))
1080    (array (unsigned-byte 64) (* * *))
1081    (array fixnum (* * *))
1082    (array single-float (* * *))
1083    (array double-float (* * *))
1084    (array character (* * *))
1085    (simple-array t (* * *))
1086    (simple-array bit (* * *))
1087    (simple-array (signed-byte 8) (* * *))
1088    (simple-array (unsigned-byte 8) (* * *))
1089    (simple-array (signed-byte 16) (* * *))
1090    (simple-array (unsigned-byte 16) (* * *))
1091    (simple-array (signed-byte 32) (* * *))
1092    (simple-array (unsigned-byte 32) (* * *))
1093    (simple-array (signed-byte 64) (* * *))
1094    (simple-array (unsigned-byte 64) (* * *))
1095    (simple-array fixnum (* * *))
1096    (simple-array single-float (* * *))
1097    (simple-array double-float (* * *))
1098    (simple-array char (* * *))
1099   
1100    ))
1101
1102
1103(defun %type-error-type (type)
1104  (if (fixnump type) 
1105    (svref %type-error-typespecs% type)
1106    type))
1107
1108(defun %typespec-id (typespec)
1109  (flet ((type-equivalent (t1 t2) (ignore-errors (and (subtypep t1 t2) (subtypep t2 t1)))))
1110    (position typespec %type-error-typespecs% :test #'type-equivalent)))
1111
1112
1113(defmethod condition-p ((x t)) nil)
1114(defmethod condition-p ((x condition)) t)
1115
1116
1117
1118(let* ((globals ()))
1119
1120  (defun %check-error-globals ()
1121    (let ((vars ())
1122          (valfs ())
1123          (oldvals ()))
1124      (dolist (g globals (values vars valfs oldvals))
1125        (destructuring-bind (sym predicate newvalf) g
1126          (let* ((boundp (boundp sym))
1127                 (oldval (if boundp (symbol-value sym) (%unbound-marker-8))))
1128          (unless (and boundp (funcall predicate oldval))
1129            (push sym vars)
1130            (push oldval oldvals)
1131            (push newvalf valfs)))))))
1132
1133  (defun check-error-global (sym checkfn newvalfn)
1134    (setq sym (require-type sym 'symbol)
1135          checkfn (require-type checkfn 'function)
1136          newvalfn (require-type newvalfn 'function))
1137    (let ((found (assq sym globals)))
1138      (if found
1139        (setf (cadr found) checkfn (caddr found) newvalfn)
1140        (push (list sym checkfn newvalfn) globals))
1141      sym))
1142)
1143
1144(check-error-global '*package* #'packagep #'(lambda () (find-package "CL-USER")))
1145
1146
1147 
1148
Note: See TracBrowser for help on using the repository browser.