X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Ftarget-error.lisp;h=d92a9785ad433831dc9f56cafd50c4606aa14945;hb=4ba392170e98744f0ef0b8e08a5d42b988f1d0c9;hp=f4093cc4ce09d15f3f612a965c51fa4f3c41a187;hpb=d49c71bf00d858efc5796900ca4954fb76ce6402;p=sbcl.git diff --git a/src/code/target-error.lisp b/src/code/target-error.lisp index f4093cc..d92a978 100644 --- a/src/code/target-error.lisp +++ b/src/code/target-error.lisp @@ -11,179 +11,280 @@ ;;;; files for more information. (in-package "SB!KERNEL") - -;;; a list of lists of restarts -(defvar *restart-clusters* '()) -;;; an ALIST (condition . restarts) which records the restarts currently -;;; associated with Condition -(defvar *condition-restarts* ()) +(defun muffle-warning-p (warning) + (declare (special *muffled-warnings*)) + (typep warning *muffled-warnings*)) -(defvar *handler-clusters* nil) +(defun initial-handler-clusters () + `(((warning . ,#'(lambda (warning) + (when (muffle-warning-p warning) + (muffle-warning warning))))))) -(defstruct (restart (:copier nil) (:predicate nil)) +;;; 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) - (report-function nil :type (or null function)) - (interactive-function nil :type (or null function)) - (test-function (lambda (cond) (declare (ignore cond)) t) :type function)) + (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)) + (prin1 (restart-name restart) stream)) (restart-report restart stream))) -(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." - (let ((associated ()) - (other ())) - (dolist (alist *condition-restarts*) - (if (eq (car alist) condition) - (setq associated (cdr alist)) - (setq other (append (cdr alist) other)))) - (collect ((res)) - (dolist (restart-cluster *restart-clusters*) - (dolist (restart restart-cluster) - (when (and (or (not condition) - (member restart associated) - (not (member restart other))) - (funcall (restart-test-function restart) - condition)) - (res restart)))) - (res)))) - #!+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) - (let ((name (restart-name restart))) - (lambda (stream) - (if name (format stream "~S" name) - (format stream "~S" restart))))) - stream)) + (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)) + ;; FIXME: if MAP-RESTARTS is internal, we could require the FUNCTION + ;; argument to be of type FUNCTION. + (let ((function (coerce function 'function)) + (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 &optional condition (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)))) + ;; TODO Question for reviewer: does the compiler infer this dx + ;; automatically? + (declare (truly-dynamic-extent #'eq-restart-p #'named-restart-p)) + (if (typep identifier 'restart) + ;; TODO Questions for reviewer: + ;; + ;; 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) -(defun find-restart (name &optional condition) + #+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 named NAME. If NAME names a restart, the restart - is returned if it is currently active. If no such restart is found, NIL is - returned. It is an error to supply NIL as a name. If CONDITION is specified - and not NIL, then only restarts associated with that condition (or with no - condition) will be returned." - (let ((restarts (compute-restarts condition))) - (declare (type list restarts)) - (find-if (lambda (x) - (or (eq x name) - (eq (restart-name x) name))) - restarts))) - -(defun find-restart-or-lose (restart-designator) - (let ((real-restart (find-restart restart-designator))) - (unless real-restart + "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 "Restart ~S is not active." - :format-arguments (list restart-designator))) - real-restart)) + :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." + non-nil restart name, then a CONTROL-ERROR is signalled." (/show "entering INVOKE-RESTART" restart) - (let ((real-restart (find-restart-or-lose 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) - '()))) + (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." - (let* ((real-restart (find-restart-or-lose restart)) - (args (interactive-restart-arguments real-restart))) + currently active non-NIL restart name, then a CONTROL-ERROR is signalled." + (let* ((real-restart (find-restart-or-control-error restart)) + (args (interactive-restart-arguments real-restart))) (apply (restart-function real-restart) args))) - - - - -;;;; helper functions for restartable error handling which couldn't be -;;;; defined 'til now 'cause they use the RESTART-CASE macro - -(defun assert-error (assertion places datum &rest arguments) +(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." - :format-arguments (list assertion))))) + (coerce-to-condition + datum arguments 'simple-error 'error) + (make-condition + 'simple-error + :format-control "~@" + :format-arguments (list assertion args-and-values))))) (restart-case - (error cond) + (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)))) + :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 () - (format *query-io* "~&Type a form to be evaluated:~%") +(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 ((cond (if type-string - (make-condition 'simple-type-error - :datum place - :expected-type type - :format-control - "The value of ~S is ~S, which is not ~A." - :format-arguments (list place - place-value - type-string)) - (make-condition 'simple-type-error - :datum place - :expected-type type - :format-control - "The value of ~S is ~S, which is not of type ~S." - :format-arguments (list place - place-value - type))))) - (restart-case (error cond) + (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)))) + :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) + :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)) + (format stream "Supply a new value for ~S." keyform)) :interactive read-evaluated-form value)))