[4859ff]: src / code / target-error.lisp Maximize Restore History

Download this file

target-error.lisp    290 lines (260 with data), 12.5 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
;;;; that part of the condition system which can or should come early
;;;; (mostly macro-related)
;;;; This software is part of the SBCL system. See the README file for
;;;; more information.
;;;;
;;;; This software is derived from the CMU CL system, which was
;;;; written at Carnegie Mellon University and released into the
;;;; public domain. The software is in the public domain and is
;;;; provided with absolutely no warranty. See the COPYING and CREDITS
;;;; files for more information.
(in-package "SB!KERNEL")
(defun muffle-warning-p (warning)
(declare (special *muffled-warnings*))
(typep warning *muffled-warnings*))
(defun initial-handler-clusters ()
`(((warning . ,#'(lambda (warning)
(when (muffle-warning-p warning)
(muffle-warning warning)))))))
;;; an alist with elements of the form
;;;
;;; (CONDITION . (HANDLER1 HANDLER2 ...))
;;;
;;; Recently established handlers are added at the beginning of the
;;; list. Elements to the left of the alist take precedence over
;;; elements to the right.
(defvar *handler-clusters* (initial-handler-clusters))
;;; a list of lists of currently active RESTART instances. maintained
;;; by RESTART-BIND.
(defvar *restart-clusters* '())
(declaim (inline restart-test-function
restart-associated-conditions
(setf restart-associated-conditions)))
(defstruct (restart (:constructor make-restart
;; Having TEST-FUNCTION at the end allows
;; to not replicate its default value in RESTART-BIND.
(name function
&optional report-function
interactive-function
test-function))
(:copier nil) (:predicate nil))
(name (missing-arg) :type symbol :read-only t)
(function (missing-arg) :type function :read-only t)
(report-function nil :type (or null function) :read-only t)
(interactive-function nil :type (or null function) :read-only t)
(test-function (lambda (cond) (declare (ignore cond)) t) :type function :read-only t)
;; the list of conditions which are currently associated to the
;; restart. maintained by WITH-CONDITION-RESTARTS in a neither
;; thread- nor interrupt-safe way. This should not be a problem
;; however, since safe uses of restarts have to assume dynamic
;; extent.
(associated-conditions '() :type list))
#!-sb-fluid (declaim (freeze-type restart))
(def!method print-object ((restart restart) stream)
(if *print-escape*
(print-unreadable-object (restart stream :type t :identity t)
(prin1 (restart-name restart) stream))
(restart-report restart stream)))
#!+sb-doc
(setf (fdocumentation 'restart-name 'function)
"Return the name of the given restart object.")
(defun restart-report (restart stream)
(funcall (or (restart-report-function restart)
(lambda (stream)
(format stream "~S" (or (restart-name restart)
restart))))
stream))
(defvar *restart-test-stack* nil)
;; Call FUNCTION with all restarts in the current dynamic environment,
;; 1) that are associated to CONDITION (when CONDITION is NIL, all
;; restarts are processed)
;; 2) and for which the restart test returns non-NIL for CONDITION.
;; When CALL-TEST-P is non-NIL, all restarts are processed.
(defun map-restarts (function &optional condition (call-test-p t))
(declare (function function))
(let ((stack *restart-test-stack*))
(dolist (restart-cluster *restart-clusters*)
(dolist (restart restart-cluster)
(when (and (or (not condition)
(null (restart-associated-conditions restart))
(memq condition (restart-associated-conditions restart)))
;; A call to COMPUTE-RESTARTS -- from an error,
;; from user code, whatever -- inside the test
;; function would cause infinite recursion here, so
;; we disable each restart using
;; *restart-test-stack* for the duration of the
;; test call.
(not (memq restart stack))
(or (not call-test-p)
(let ((*restart-test-stack* (cons restart stack)))
(declare (truly-dynamic-extent *restart-test-stack*))
(funcall (restart-test-function restart) condition))))
(funcall function restart))))))
(defun compute-restarts (&optional condition)
#!+sb-doc
"Return a list of all the currently active restarts ordered from most recently
established to less recently established. If CONDITION is specified, then only
restarts associated with CONDITION (or with no condition) will be returned."
(collect ((result))
(map-restarts (lambda (restart) (result restart)) condition)
(result)))
(defun %find-restart (identifier condition &optional (call-test-p t))
(flet ((eq-restart-p (restart)
(when (eq identifier restart)
(return-from %find-restart restart)))
(named-restart-p (restart)
(when (eq identifier (restart-name restart))
(return-from %find-restart restart))))
;; KLUDGE: can the compiler infer this dx automatically?
(declare (truly-dynamic-extent #'eq-restart-p #'named-restart-p))
(if (typep identifier 'restart)
;; The code under #+previous-... below breaks the abstraction
;; introduced by MAP-RESTARTS, but is about twice as
;; fast as #+equivalent-... . Also, it is a common case due to
;;
;; (INVOKE-RESTART RESTART)
;; -> (FIND-RESTART-OR-CONTROL-ERROR RESTART)
;; -> (FIND-RESTART RESTART)
;;
;; However, both #+previous-... and #+equivalent-... may be
;; wrong altogether because of
;; https://bugs.launchpad.net/sbcl/+bug/774410:
;; The behavior expected in that report can be achieved by the
;; following line (which is, of course, the slowest of all
;; possibilities):
(map-restarts #'eq-restart-p condition call-test-p)
#+equivalent-to-previous-sbcl-behavior--faster-but-see-bug-774410
(map-restarts #'eq-restart-p nil nil)
#+previous-behavior--fastest-but-see-bug-774410
(and (find-if (lambda (cluster) (find identifier cluster)) *restart-clusters*)
identifier)
(map-restarts #'named-restart-p condition call-test-p))))
(defun find-restart (identifier &optional condition)
#!+sb-doc
"Return the first restart identified by IDENTIFIER. If IDENTIFIER is a symbol,
then the innermost applicable restart with that name is returned. If IDENTIFIER
is a restart, it is returned if it is currently active. Otherwise NIL is
returned. If CONDITION is specified and not NIL, then only restarts associated
with that condition (or with no condition) will be returned."
;; Calls MAP-RESTARTS such that restart test functions are
;; respected.
(%find-restart identifier condition))
;;; helper for the various functions which are ANSI-spec'ed to do
;;; something with a restart or signal CONTROL-ERROR if there is none
(defun find-restart-or-control-error (identifier &optional condition (call-test-p t))
(or (%find-restart identifier condition call-test-p)
(error 'simple-control-error
:format-control "No restart ~S is active~@[ for ~S~]."
:format-arguments (list identifier condition))))
(defun invoke-restart (restart &rest values)
#!+sb-doc
"Calls the function associated with the given restart, passing any given
arguments. If the argument restart is not a restart or a currently active
non-nil restart name, then a CONTROL-ERROR is signalled."
(/show "entering INVOKE-RESTART" restart)
;; The following code calls MAP-RESTARTS (through
;; FIND-RESTART-OR-CONTROL-ERROR -> %FIND-RESTART) such that restart
;; test functions are respected when RESTART is a symbol, but not
;; when RESTART is a RESTART instance.
;;
;; Without disabling test functions for the RESTART instance case,
;; the following problem would arise:
;;
;; (restart-case
;; (handler-bind
;; ((some-condition (lambda (c)
;; (invoke-restart (find-restart 'foo c)) ; a)
;; (invoke-restart 'foo) ; b)
;; )))
;; (signal 'some-condition))
;; (foo ()
;; :test (lambda (c) (typep c 'some-condition))))
;;
;; In case a), INVOKE-RESTART receives the RESTART instance, but
;; cannot supply the condition instance needed by the test. In case
;; b) INVOKE-RESTART calls FIND-RESTART, but again cannot supply the
;; condition instance. As a result, the restart would be impossible
;; the invoke.
(let ((real-restart (find-restart-or-control-error
restart nil (symbolp restart))))
(apply (restart-function real-restart) values)))
(defun interactive-restart-arguments (real-restart)
(let ((interactive-function (restart-interactive-function real-restart)))
(if interactive-function
(funcall interactive-function)
'())))
(defun invoke-restart-interactively (restart)
#!+sb-doc
"Calls the function associated with the given restart, prompting for any
necessary arguments. If the argument restart is not a restart or a
currently active non-NIL restart name, then a CONTROL-ERROR is signalled."
;; For an explanation of the call to FIND-RESTART-OR-CONTROL-ERROR,
;; see comment in INVOKE-RESTART.
(let* ((real-restart (find-restart-or-control-error
restart nil (symbolp restart)))
(args (interactive-restart-arguments real-restart)))
(apply (restart-function real-restart) args)))
(defun assert-error (assertion args-and-values places datum &rest arguments)
(let ((cond (if datum
(coerce-to-condition
datum arguments 'simple-error 'error)
(make-condition
'simple-error
:format-control "~@<The assertion ~S failed~:[.~:; ~
with ~:*~{~{~S = ~S~}~^, ~}.~]~:@>"
:format-arguments (list assertion args-and-values)))))
(restart-case
(error cond)
(continue ()
:report (lambda (stream)
(format stream "Retry assertion")
(if places
(format stream " with new value~P for ~{~S~^, ~}."
(length places) places)
(format stream ".")))
nil))))
;;; READ-EVALUATED-FORM is used as the interactive method for restart cases
;;; setup by the Common Lisp "casing" (e.g., CCASE and CTYPECASE) macros
;;; and by CHECK-TYPE.
(defun read-evaluated-form (&optional (prompt-control nil promptp)
&rest prompt-args)
(apply #'format *query-io*
(if promptp prompt-control "~&Type a form to be evaluated: ")
prompt-args)
(finish-output *query-io*)
(list (eval (read *query-io*))))
(defun check-type-error (place place-value type type-string)
(let ((condition
(make-condition
'simple-type-error
:datum place-value
:expected-type type
:format-control
"The value of ~S is ~S, which is not ~:[of type ~S~;~:*~A~]."
:format-arguments (list place place-value type-string type))))
(restart-case (error condition)
(store-value (value)
:report (lambda (stream)
(format stream "Supply a new value for ~S." place))
:interactive read-evaluated-form
value))))
(defun case-failure (name value keys)
(error 'case-failure
:name name
:datum value
:expected-type (if (eq name 'ecase)
`(member ,@keys)
`(or ,@keys))
:possibilities keys))
(defun case-body-error (name keyform keyform-value expected-type keys)
(restart-case
(error 'case-failure
:name name
:datum keyform-value
:expected-type expected-type
:possibilities keys)
(store-value (value)
:report (lambda (stream)
(format stream "Supply a new value for ~S." keyform))
:interactive read-evaluated-form
value)))