0.8.14.26:
[sbcl.git] / src / code / condition.lisp
index 5345544..618db15 100644 (file)
                (return nil)))
        (setf (getf (condition-assigned-slots res) (condition-slot-name hslot))
              (find-slot-default class hslot))))
-
     res))
 \f
 ;;;; DEFINE-CONDITION
 (eval-when (:compile-toplevel :load-toplevel :execute)
 (defun %compiler-define-condition (name direct-supers layout
                                   all-readers all-writers)
-  (sb!xc:proclaim `(ftype (function (t) t) ,@all-readers))
-  (sb!xc:proclaim `(ftype (function (t t) t) ,@all-writers))
-  (multiple-value-bind (class old-layout)
-      (insured-find-classoid name
-                            #'condition-classoid-p
-                            #'make-condition-classoid)
-    (setf (layout-classoid layout) class)
-    (setf (classoid-direct-superclasses class)
-         (mapcar #'find-classoid direct-supers))
-    (cond ((not old-layout)
-          (register-layout layout))
-         ((not *type-system-initialized*)
-          (setf (layout-classoid old-layout) class)
-          (setq layout old-layout)
-          (unless (eq (classoid-layout class) layout)
+  (with-single-package-locked-error 
+      (:symbol name "defining ~A as a condition")
+    (sb!xc:proclaim `(ftype (function (t) t) ,@all-readers))
+    (sb!xc:proclaim `(ftype (function (t t) t) ,@all-writers))
+    (multiple-value-bind (class old-layout)
+       (insured-find-classoid name
+                              #'condition-classoid-p
+                              #'make-condition-classoid)
+      (setf (layout-classoid layout) class)
+      (setf (classoid-direct-superclasses class)
+           (mapcar #'find-classoid direct-supers))
+      (cond ((not old-layout)
+            (register-layout layout))
+           ((not *type-system-initialized*)
+            (setf (layout-classoid old-layout) class)
+            (setq layout old-layout)
+            (unless (eq (classoid-layout class) layout)
+              (register-layout layout)))
+           ((redefine-layout-warning "current"
+                                     old-layout
+                                     "new"
+                                     (layout-length layout)
+                                     (layout-inherits layout)
+                                     (layout-depthoid layout))
+            (register-layout layout :invalidate t))
+           ((not (classoid-layout class))
             (register-layout layout)))
-         ((redefine-layout-warning "current"
-                                   old-layout
-                                   "new"
-                                   (layout-length layout)
-                                   (layout-inherits layout)
-                                   (layout-depthoid layout))
-          (register-layout layout :invalidate t))
-         ((not (classoid-layout class))
-          (register-layout layout)))
-
-    (setf (layout-info layout)
-         (locally
-           ;; KLUDGE: There's a FIND-CLASS DEFTRANSFORM for constant class
-           ;; names which creates fast but non-cold-loadable, non-compact
-           ;; code. In this context, we'd rather have compact, cold-loadable
-           ;; code. -- WHN 19990928
-           (declare (notinline find-classoid))
-           (layout-info (classoid-layout (find-classoid 'condition)))))
-
-    (setf (find-classoid name) class)
-
-    ;; Initialize CPL slot.
-    (setf (condition-classoid-cpl class)
-         (remove-if-not #'condition-classoid-p 
-                        (std-compute-class-precedence-list class))))
+      
+      (setf (layout-info layout)
+           (locally
+               ;; KLUDGE: There's a FIND-CLASS DEFTRANSFORM for constant class
+               ;; names which creates fast but non-cold-loadable, non-compact
+               ;; code. In this context, we'd rather have compact, cold-loadable
+               ;; code. -- WHN 19990928
+               (declare (notinline find-classoid))
+             (layout-info (classoid-layout (find-classoid 'condition)))))
+      
+      (setf (find-classoid name) class)
+      
+      ;; Initialize CPL slot.
+      (setf (condition-classoid-cpl class)
+           (remove-if-not #'condition-classoid-p 
+                          (std-compute-class-precedence-list class)))))
   (values))
 ) ; EVAL-WHEN
 
 
 (defun %define-condition (name parent-types layout slots documentation
                          report default-initargs all-readers all-writers)
-  (%compiler-define-condition name parent-types layout all-readers all-writers)
-  (let ((class (find-classoid name)))
-    (setf (condition-classoid-slots class) slots)
-    (setf (condition-classoid-report class) report)
-    (setf (condition-classoid-default-initargs class) default-initargs)
-    (setf (fdocumentation name 'type) documentation)
-
-    (dolist (slot slots)
-
-      ;; Set up reader and writer functions.
-      (let ((slot-name (condition-slot-name slot)))
-       (dolist (reader (condition-slot-readers slot))
-          (install-condition-slot-reader reader name slot-name))
-       (dolist (writer (condition-slot-writers slot))
-         (install-condition-slot-writer writer name slot-name))))
-
-    ;; Compute effective slots and set up the class and hairy slots
-    ;; (subsets of the effective slots.)
-    (let ((eslots (compute-effective-slots class))
-         (e-def-initargs
-          (reduce #'append
-                  (mapcar #'condition-classoid-default-initargs
+  (with-single-package-locked-error 
+      (:symbol name "defining ~A as a condition")
+    (%compiler-define-condition name parent-types layout all-readers all-writers)
+    (let ((class (find-classoid name)))
+      (setf (condition-classoid-slots class) slots)
+      (setf (condition-classoid-report class) report)
+      (setf (condition-classoid-default-initargs class) default-initargs)
+      (setf (fdocumentation name 'type) documentation)
+      
+      (dolist (slot slots)
+       
+       ;; Set up reader and writer functions.
+       (let ((slot-name (condition-slot-name slot)))
+         (dolist (reader (condition-slot-readers slot))
+           (install-condition-slot-reader reader name slot-name))
+         (dolist (writer (condition-slot-writers slot))
+           (install-condition-slot-writer writer name slot-name))))
+      
+      ;; Compute effective slots and set up the class and hairy slots
+      ;; (subsets of the effective slots.)
+      (let ((eslots (compute-effective-slots class))
+           (e-def-initargs
+            (reduce #'append
+                    (mapcar #'condition-classoid-default-initargs
                           (condition-classoid-cpl class)))))
-      (dolist (slot eslots)
-       (ecase (condition-slot-allocation slot)
-         (:class
-          (unless (condition-slot-cell slot)
-            (setf (condition-slot-cell slot)
-                  (list (if (condition-slot-initform-p slot)
-                            (let ((initform (condition-slot-initform slot)))
-                              (if (functionp initform)
-                                  (funcall initform)
-                                  initform))
-                            *empty-condition-slot*))))
-          (push slot (condition-classoid-class-slots class)))
-         ((:instance nil)
-          (setf (condition-slot-allocation slot) :instance)
-          (when (or (functionp (condition-slot-initform slot))
-                    (dolist (initarg (condition-slot-initargs slot) nil)
-                      (when (functionp (getf e-def-initargs initarg))
-                        (return t))))
-            (push slot (condition-classoid-hairy-slots class))))))))
-  name)
+       (dolist (slot eslots)
+         (ecase (condition-slot-allocation slot)
+           (:class
+            (unless (condition-slot-cell slot)
+              (setf (condition-slot-cell slot)
+                    (list (if (condition-slot-initform-p slot)
+                              (let ((initform (condition-slot-initform slot)))
+                                (if (functionp initform)
+                                    (funcall initform)
+                                    initform))
+                              *empty-condition-slot*))))
+            (push slot (condition-classoid-class-slots class)))
+           ((:instance nil)
+            (setf (condition-slot-allocation slot) :instance)
+            (when (or (functionp (condition-slot-initform slot))
+                      (dolist (initarg (condition-slot-initargs slot) nil)
+                        (when (functionp (getf e-def-initargs initarg))
+                          (return t))))
+              (push slot (condition-classoid-hairy-slots class))))))))
+    name))
 
 (defmacro define-condition (name (&rest parent-types) (&rest slot-specs)
                                 &body options)
 ;;; regression tests cheerfully passed because they assumed that
 ;;; unFBOUNDPness meant they were running on an system which didn't
 ;;; support the extension.)
-(define-condition unsupported-operator (cell-error) ()
-  (:report
-   (lambda (condition stream)
-     (format stream
-            "unsupported on this platform (OS, CPU, whatever): ~S"
-            (cell-error-name condition)))))
+(define-condition unsupported-operator (simple-error) ())
+
 \f
 ;;; (:ansi-cl :function remove)
 ;;; (:ansi-cl :section (a b c))
 ;;; FIXME: this is not the right place for this.
 (defun print-reference (reference stream)
   (ecase (car reference)
+    (:amop
+     (format stream "AMOP")
+     (format stream ", ")
+     (destructuring-bind (type data) (cdr reference)
+       (ecase type
+        (:generic-function (format stream "Generic Function ~S" data))
+        (:section (format stream "Section ~{~D~^.~}" data)))))
     (:ansi-cl
      (format stream "The ANSI Standard")
      (format stream ", ")
      (destructuring-bind (type data) (cdr reference)
        (ecase type
         (:node (format stream "Node ~S" data))
-        (:variable (format stream "Variable ~S" data)))))
-    ;; FIXME: other documents (e.g. AMOP, Franz documentation :-)
+        (:variable (format stream "Variable ~S" data))
+        (:function (format stream "Function ~S" data)))))
+    ;; FIXME: other documents (e.g. CLIM, Franz documentation :-)
     ))
 (define-condition reference-condition ()
   ((references :initarg :references :reader reference-condition-references)))
 (def!method print-object :around ((o reference-condition) s)
   (call-next-method)
   (unless (or *print-escape* *print-readably*)
-    (when *print-condition-references*
+    (when (and *print-condition-references*
+               (reference-condition-references o))
       (format s "~&See also:~%")
       (pprint-logical-block (s nil :per-line-prefix "  ")
        (do* ((rs (reference-condition-references o) (cdr rs))
          (print-reference r s)
          (unless (null (cdr rs))
            (terpri s)))))))
-    
+
 (define-condition duplicate-definition (reference-condition warning)
   ((name :initarg :name :reader duplicate-definition-name))
   (:report (lambda (c s)
 
 (define-condition extension-failure (reference-condition simple-error)
   ())
+
+#!+sb-package-locks
+(progn
+
+(define-condition package-lock-violation (reference-condition package-error)
+  ((format-control :initform nil :initarg :format-control 
+                  :reader package-error-format-control)
+   (format-arguments :initform nil :initarg :format-arguments
+                    :reader package-error-format-arguments))
+  (:report 
+   (lambda (condition stream)
+     (let ((control (package-error-format-control condition)))
+       (if control
+          (apply #'format stream
+                  (format nil "~~@<Lock on package ~A violated when ~A.~~:@>"
+                          (package-name (package-error-package condition))
+                          control)
+                  (package-error-format-arguments condition))
+          (format stream "~@<Lock on package ~A violated.~:@>"
+                  (package-name (package-error-package condition)))))))
+  ;; no :default-initargs -- reference-stuff provided by the
+  ;; signalling form in target-package.lisp
+  #!+sb-doc
+  (:documentation
+   "Subtype of CL:PACKAGE-ERROR. A subtype of this error is signalled
+when a package-lock is violated."))
+
+(define-condition package-locked-error (package-lock-violation) ()
+  #!+sb-doc
+  (:documentation
+   "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
+signalled when an operation on a package violates a package lock."))
+
+(define-condition symbol-package-locked-error (package-lock-violation)
+  ((symbol :initarg :symbol :reader package-locked-error-symbol))
+  #!+sb-doc
+  (:documentation
+   "Subtype of SB-EXT:PACKAGE-LOCK-VIOLATION. An error of this type is
+signalled when an operation on a symbol violates a package lock. The
+symbol that caused the violation is accessed by the function
+SB-EXT:PACKAGE-LOCKED-ERROR-SYMBOL."))
+
+) ; progn
 \f
 ;;;; various other (not specified by ANSI) CONDITIONs
 ;;;;
 ;;;; setup of CONDITION machinery, only because that makes it easier to
 ;;;; get cold init to work.
 
+;;; OAOOM warning: see cross-condition.lisp
+(define-condition encapsulated-condition (condition)
+  ((condition :initarg :condition :reader encapsulated-condition)))
+
 (define-condition values-type-error (type-error)
   ()
   (:report
               (reader-impossible-number-error-error condition))))))
 
 (define-condition timeout (serious-condition) ())
+
+;;; Single stepping conditions
+
+(define-condition step-condition ()
+  ((form :initarg :form :reader step-condition-form))
+  #!+sb-doc
+  (:documentation "Common base class of single-stepping conditions.
+STEP-CONDITION-FORM holds a string representation of the form being
+stepped."))
+
+#!+sb-doc
+(setf (fdocumentation 'step-condition-form 'function)
+      "Form associated with the STEP-CONDITION.")
+
+(define-condition step-form-condition (step-condition)
+  ((source-path :initarg :source-path :reader step-condition-source-path)
+   (pathname :initarg :pathname :reader step-condition-pathname))
+  #!+sb-doc
+  (:documentation "Condition signalled by code compiled with
+single-stepping information when about to execute a form.
+STEP-CONDITION-FORM holds the form, STEP-CONDITION-PATHNAME holds the
+pathname of the original file or NIL, and STEP-CONDITION-SOURCE-PATH
+holds the source-path to the original form within that file or NIL.
+Associated with this condition are always the restarts STEP-INTO,
+STEP-NEXT, and STEP-CONTINUE."))
+
+#!+sb-doc
+(setf (fdocumentation 'step-condition-source-path 'function)
+      "Source-path of the original form associated with the
+STEP-FORM-CONDITION or NIL."
+      (fdocumentation 'step-condition-pathname 'function)
+      "Pathname of the original source-file associated with the
+STEP-FORM-CONDITION or NIL.")
+
+(define-condition step-result-condition (step-condition)
+  ((result :initarg :result :reader step-condition-result)))
+
+#!+sb-doc
+(setf (fdocumentation 'step-condition-result 'function)
+      "Return values associated with STEP-VALUES-CONDITION as a list,
+or the variable value associated with STEP-VARIABLE-CONDITION.")
+
+(define-condition step-values-condition (step-result-condition)
+  ()
+  #!+sb-doc
+  (:documentation "Condition signalled by code compiled with
+single-stepping information after executing a form.
+STEP-CONDITION-FORM holds the form, and STEP-CONDITION-RESULT holds
+the values returned by the form as a list. No associated restarts."))
+
+(define-condition step-variable-condition (step-result-condition)
+  ()
+  #!+sb-doc
+  (:documentation "Condition signalled by code compiled with
+single-stepping information when referencing a variable.
+STEP-CONDITION-FORM hold the symbol, and STEP-CONDITION-RESULT holds
+the value of the variable. No associated restarts."))
+
 \f
 ;;;; restart definitions
 
     "Transfer control and VALUE to a restart named USE-VALUE, or return NIL if
    none exists."))
 
+;;; single-stepping restarts
+
+(macrolet ((def (name doc)
+              #!-sb-doc (declare (ignore doc))
+              `(defun ,name (condition)
+                #!+sb-doc ,doc
+                (invoke-restart (find-restart-or-control-error ',name condition)))))
+  (def step-continue
+      "Transfers control to the STEP-CONTINUE restart associated with
+the condition, continuing execution without stepping. Signals a
+CONTROL-ERROR if the restart does not exist.")
+  (def step-next
+      "Transfers control to the STEP-NEXT restart associated with the
+condition, executing the current form without stepping and continuing
+stepping with the next form. Signals CONTROL-ERROR is the restart does
+not exists.")
+  (def step-into
+      "Transfers control to the STEP-INTO restart associated with the
+condition, stepping into the current form. Signals a CONTROL-ERROR is
+the restart does not exist."))
+
 (/show0 "condition.lisp end of file")