source: trunk/source/level-1/l1-error-system.lisp @ 8484

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

Define IO-TIMEOUT, READ-TIMEOUT, WRITE-TIMEOUT.

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