Simplify (and robustify) regular PACKing
[sbcl.git] / src / pcl / slots.lisp
index aade5b2..2ae32b0 100644 (file)
 (define-condition unbound-slot (cell-error)
   ((instance :reader unbound-slot-instance :initarg :instance))
   (:report (lambda (condition stream)
-             (format stream "The slot ~S is unbound in the object ~S."
-                     (cell-error-name condition)
-                     (unbound-slot-instance condition)))))
+             (handler-case
+                 (format stream "~@<The slot ~/sb-ext:print-symbol-with-prefix/ ~
+                         is unbound in the object ~A.~@:>"
+                         (cell-error-name condition)
+                         (unbound-slot-instance condition))
+               (serious-condition ()
+                 ;; In case of an error try again avoiding custom PRINT-OBJECT's.
+                 (format stream "~&Error during printing.~%~@<The slot ~
+                         ~/sb-ext:print-symbol-with-prefix/ ~
+                         is unbound in an instance of ~
+                         ~/sb-ext:print-symbol-with-prefix/.~@:>"
+                         (cell-error-name condition)
+                         (type-of (unbound-slot-instance condition))))))))
 
 (defmethod wrapper-fetcher ((class standard-class))
   'std-instance-wrapper)
 (defmethod raw-instance-allocator ((class standard-class))
   'allocate-standard-instance)
 
-;;; These four functions work on std-instances and fsc-instances. These are
+;;; These three functions work on std-instances and fsc-instances. These are
 ;;; instances for which it is possible to change the wrapper and the slots.
 ;;;
 ;;; For these kinds of instances, most specified methods from the instance
 ;;; structure protocol are promoted to the implementation-specific class
 ;;; std-class. Many of these methods call these four functions.
 
-(defun set-wrapper (inst new)
-  (cond ((std-instance-p inst)
-         (setf (std-instance-wrapper inst) new))
-        ((fsc-instance-p inst)
-         (setf (fsc-instance-wrapper inst) new))
+(defun %swap-wrappers-and-slots (i1 i2)
+  (cond ((std-instance-p i1)
+         (let ((w1 (std-instance-wrapper i1))
+               (s1 (std-instance-slots i1)))
+           (setf (std-instance-wrapper i1) (std-instance-wrapper i2))
+           (setf (std-instance-slots i1) (std-instance-slots i2))
+           (setf (std-instance-wrapper i2) w1)
+           (setf (std-instance-slots i2) s1)))
+        ((fsc-instance-p i1)
+         (let ((w1 (fsc-instance-wrapper i1))
+               (s1 (fsc-instance-slots i1)))
+           (setf (fsc-instance-wrapper i1) (fsc-instance-wrapper i2))
+           (setf (fsc-instance-slots i1) (fsc-instance-slots i2))
+           (setf (fsc-instance-wrapper i2) w1)
+           (setf (fsc-instance-slots i2) s1)))
         (t
          (error "unrecognized instance type"))))
+\f
+;;;; STANDARD-INSTANCE-ACCESS
+
+(declaim (inline standard-instance-access
+                 (setf standard-instance-access)
+                 (cas stadard-instance-access)
+                 funcallable-standard-instance-access
+                 (setf funcallable-standard-instance-access)
+                 (cas funcallable-standard-instance-access)))
+
+(defun standard-instance-access (instance location)
+  (clos-slots-ref (std-instance-slots instance) location))
+
+(defun (setf standard-instance-access) (new-value instance location)
+  (setf (clos-slots-ref (std-instance-slots instance) location) new-value))
+
+(defun (cas standard-instance-access) (old-value new-value instance location)
+  ;; FIXME: Maybe get rid of CLOS-SLOTS-REF entirely?
+  (cas (svref (std-instance-slots instance) location) old-value new-value))
+
+(defun funcallable-standard-instance-access (instance location)
+  (clos-slots-ref (fsc-instance-slots instance) location))
 
-(defun swap-wrappers-and-slots (i1 i2)
-  (with-pcl-lock                        ;FIXME is this sufficient?
-   (cond ((std-instance-p i1)
-          (let ((w1 (std-instance-wrapper i1))
-                (s1 (std-instance-slots i1)))
-            (setf (std-instance-wrapper i1) (std-instance-wrapper i2))
-            (setf (std-instance-slots i1) (std-instance-slots i2))
-            (setf (std-instance-wrapper i2) w1)
-            (setf (std-instance-slots i2) s1)))
-         ((fsc-instance-p i1)
-          (let ((w1 (fsc-instance-wrapper i1))
-                (s1 (fsc-instance-slots i1)))
-            (setf (fsc-instance-wrapper i1) (fsc-instance-wrapper i2))
-            (setf (fsc-instance-slots i1) (fsc-instance-slots i2))
-            (setf (fsc-instance-wrapper i2) w1)
-            (setf (fsc-instance-slots i2) s1)))
-         (t
-          (error "unrecognized instance type")))))
+(defun (setf funcallable-standard-instance-access) (new-value instance location)
+  (setf (clos-slots-ref (fsc-instance-slots instance) location) new-value))
+
+(defun (cas funcallable-standard-instance-access) (old-value new-value instance location)
+  ;; FIXME: Maybe get rid of CLOS-SLOTS-REF entirely?
+  (cas (svref (fsc-instance-slots instance) location) old-value new-value))
 \f
-(defun find-slot-definition (class slot-name)
-  (dolist (slot (class-slots class) nil)
-    (when (eql slot-name (slot-definition-name slot))
-      (return slot))))
+;;;; SLOT-VALUE, (SETF SLOT-VALUE), SLOT-BOUNDP, SLOT-MAKUNBOUND
 
 (declaim (ftype (sfunction (t symbol) t) slot-value))
 (defun slot-value (object slot-name)
-  (let* ((class (class-of object))
-         (slot-definition (find-slot-definition class slot-name)))
-    (if (null slot-definition)
-        (values (slot-missing class object slot-name 'slot-value))
-        (slot-value-using-class class object slot-definition))))
-
-(define-compiler-macro slot-value (&whole form object slot-name)
-  (if (and (constantp slot-name)
-           (interned-symbol-p (constant-form-value slot-name)))
+  (let* ((wrapper (valid-wrapper-of object))
+         (cell (or (find-slot-cell wrapper slot-name)
+                   (return-from slot-value
+                     (values (slot-missing (wrapper-class* wrapper) object slot-name
+                                           'slot-value)))))
+         (location (car cell))
+         (value
+          (cond ((fixnump location)
+                 (if (std-instance-p object)
+                     (standard-instance-access object location)
+                     (funcallable-standard-instance-access object location)))
+                ((consp location)
+                 (cdr location))
+                ((not location)
+                 (return-from slot-value
+                   (funcall (slot-info-reader (cdr cell)) object)))
+                (t
+                 (bug "Bogus slot cell in SLOT-VALUE: ~S" cell)))))
+    (if (eq +slot-unbound+ value)
+        (slot-unbound (wrapper-class* wrapper) object slot-name)
+        value)))
+
+;;; This is used during the PCL build, but gets replaced by a deftransform
+;;; in fixup.lisp.
+(define-compiler-macro slot-value (&whole form object slot-name
+                                   &environment env)
+  (if (and (constantp slot-name env)
+           (interned-symbol-p (constant-form-value slot-name env)))
       `(accessor-slot-value ,object ,slot-name)
       form))
 
 (defun set-slot-value (object slot-name new-value)
-  (let* ((class (class-of object))
-         (slot-definition (find-slot-definition class slot-name)))
-    (if (null slot-definition)
-        (progn (slot-missing class object slot-name 'setf new-value)
-               new-value)
-        (setf (slot-value-using-class class object slot-definition)
-              new-value))))
+  (let* ((wrapper (valid-wrapper-of object))
+         (cell (or (find-slot-cell wrapper slot-name)
+                   (return-from set-slot-value
+                     (values (slot-missing (wrapper-class* wrapper) object slot-name
+                                           'setf new-value)))))
+         (location (car cell))
+         (info (cdr cell))
+         (typecheck (slot-info-typecheck info)))
+    (when typecheck
+      (funcall typecheck new-value))
+    (cond ((fixnump location)
+           (if (std-instance-p object)
+               (setf (standard-instance-access object location) new-value)
+               (setf (funcallable-standard-instance-access object location)
+                     new-value)))
+          ((consp location)
+           (setf (cdr location) new-value))
+          ((not location)
+           (funcall (slot-info-writer info) new-value object))
+          (t
+           (bug "Bogus slot-cell in SET-SLOT-VALUE: ~S" cell))))
+  new-value)
 
 ;;; A version of SET-SLOT-VALUE for use in safe code, where we want to
 ;;; check types when writing to slots:
 (defun safe-set-slot-value (object slot-name new-value)
   (set-slot-value object slot-name new-value))
 
+;;; This is used during the PCL build, but gets replaced by a deftransform
+;;; in fixup.lisp.
 (define-compiler-macro set-slot-value (&whole form object slot-name new-value
-                                              &environment env)
-  (if (and (constantp slot-name)
-           (interned-symbol-p (constant-form-value slot-name))
+                                      &environment env)
+  (if (and (constantp slot-name env)
+           (interned-symbol-p (constant-form-value slot-name env))
            ;; We can't use the ACCESSOR-SET-SLOT-VALUE path in safe
            ;; code, since it'll use the global automatically generated
            ;; accessor, which won't do typechecking. (SLOT-OBJECT
       `(accessor-set-slot-value ,object ,slot-name ,new-value)
       form))
 
-(defun slot-boundp (object slot-name)
-  (let* ((class (class-of object))
-         (slot-definition (find-slot-definition class slot-name)))
-    (if (null slot-definition)
-        (not (not (slot-missing class object slot-name 'slot-boundp)))
-        (slot-boundp-using-class class object slot-definition))))
+(defun (cas slot-value) (old-value new-value object slot-name)
+  (let* ((wrapper (valid-wrapper-of object))
+         (cell (or (find-slot-cell wrapper slot-name)
+                   (return-from slot-value
+                     (values (slot-missing (wrapper-class* wrapper) object slot-name
+                                           'cas (list old-value new-value))))))
+         (location (car cell))
+         (info (cdr cell))
+         (typecheck (slot-info-typecheck info)))
+    (when typecheck
+      (funcall typecheck new-value))
+    (let ((old (cond ((fixnump location)
+                      (if (std-instance-p object)
+                          (cas (standard-instance-access object location) old-value new-value)
+                          (cas (funcallable-standard-instance-access object location)
+                               old-value new-value)))
+                     ((consp location)
+                      (cas (cdr location) old-value new-value))
+                     ((not location)
+                      ;; FIXME: (CAS SLOT-VALUE-USING-CLASS)...
+                      (error "Cannot compare-and-swap slot ~S on: ~S" slot-name object))
+                     (t
+                      (bug "Bogus slot-cell in (CAS SLOT-VALUE): ~S" cell)))))
+      (if (and (eq +slot-unbound+ old)
+               (neq old old-value))
+          (slot-unbound (wrapper-class* wrapper) object slot-name)
+          old))))
 
-(setf (gdefinition 'slot-boundp-normal) #'slot-boundp)
-
-(define-compiler-macro slot-boundp (&whole form object slot-name)
-  (if (and (constantp slot-name)
-           (interned-symbol-p (constant-form-value slot-name)))
+(defun slot-boundp (object slot-name)
+  (let* ((wrapper (valid-wrapper-of object))
+         (cell (or (find-slot-cell wrapper slot-name)
+                   (return-from slot-boundp
+                     (and (slot-missing (wrapper-class* wrapper) object slot-name
+                                        'slot-boundp)
+                          t))))
+         (location (car cell))
+         (value
+          (cond ((fixnump location)
+                 (if (std-instance-p object)
+                     (standard-instance-access object location)
+                     (funcallable-standard-instance-access object location)))
+                ((consp location)
+                 (cdr location))
+                ((not location)
+                 (return-from slot-boundp
+                   (funcall (slot-info-boundp (cdr cell)) object)))
+                (t
+                 (bug "Bogus slot cell in SLOT-VALUE: ~S" cell)))))
+    (not (eq +slot-unbound+ value))))
+
+(define-compiler-macro slot-boundp (&whole form object slot-name
+                                    &environment env)
+  (if (and (constantp slot-name env)
+           (interned-symbol-p (constant-form-value slot-name env)))
       `(accessor-slot-boundp ,object ,slot-name)
       form))
 
 (defun slot-makunbound (object slot-name)
-  (let* ((class (class-of object))
-         (slot-definition (find-slot-definition class slot-name)))
-    (if (null slot-definition)
-        (slot-missing class object slot-name 'slot-makunbound)
-        (slot-makunbound-using-class class object slot-definition))
-    object))
+  (let* ((wrapper (valid-wrapper-of object))
+         (cell (find-slot-cell wrapper slot-name))
+         (location (car cell)))
+    (cond ((fixnump location)
+           (if (std-instance-p object)
+               (setf (standard-instance-access object location) +slot-unbound+)
+               (setf (funcallable-standard-instance-access object location)
+                     +slot-unbound+)))
+          ((consp location)
+           (setf (cdr location) +slot-unbound+))
+          ((not cell)
+           (slot-missing (wrapper-class* wrapper) object slot-name 'slot-makunbound))
+          ((not location)
+           (let ((class (wrapper-class* wrapper)))
+             (slot-makunbound-using-class class object (find-slot-definition class slot-name))))
+          (t
+           (bug "Bogus slot-cell in SLOT-MAKUNBOUND: ~S" cell))))
+  object)
 
 (defun slot-exists-p (object slot-name)
   (let ((class (class-of object)))
   (if (slot-boundp object slot-name)
       (slot-value object slot-name)
       default))
-\f
-(defun standard-instance-access (instance location)
-  (clos-slots-ref (std-instance-slots instance) location))
-
-(defun funcallable-standard-instance-access (instance location)
-  (clos-slots-ref (fsc-instance-slots instance) location))
 
 (defmethod slot-value-using-class ((class std-class)
                                    (object standard-object)
                                    (slotd standard-effective-slot-definition))
+  ;; FIXME: Do we need this? SLOT-VALUE checks for obsolete
+  ;; instances. Are users allowed to call this directly?
   (check-obsolete-instance object)
   (let* ((location (slot-definition-location slotd))
          (value
            (new-value (class std-class)
                       (object standard-object)
                       (slotd standard-effective-slot-definition))
+  ;; FIXME: Do we need this? SET-SLOT-VALUE checks for obsolete
+  ;; instances. Are users allowed to call this directly?
   (check-obsolete-instance object)
-  (let ((location (slot-definition-location slotd))
-        (type-check-function
-         (when (safe-p class)
-           (slot-definition-type-check-function slotd))))
-    (flet ((check (new-value)
-             (when type-check-function
-               (funcall (the function type-check-function) new-value))
-             new-value))
-      (typecase location
-        (fixnum
-         (cond ((std-instance-p object)
-                (setf (clos-slots-ref (std-instance-slots object) location)
-                      (check new-value)))
-               ((fsc-instance-p object)
-                (setf (clos-slots-ref (fsc-instance-slots object) location)
-                      (check new-value)))
-                (t (bug "unrecognized instance type in ~S"
-                        '(setf slot-value-using-class)))))
-        (cons
-         (setf (cdr location) (check new-value)))
-        (t
-         (instance-structure-protocol-error
-          slotd '(setf slot-value-using-class)))))))
+  (let* ((info (slot-definition-info slotd))
+         (location (slot-definition-location slotd))
+         (typecheck (slot-info-typecheck info))
+         (new-value (if typecheck
+                        (funcall (the function typecheck) new-value)
+                        new-value)))
+    (typecase location
+      (fixnum
+       (cond ((std-instance-p object)
+              (setf (clos-slots-ref (std-instance-slots object) location)
+                    new-value))
+             ((fsc-instance-p object)
+              (setf (clos-slots-ref (fsc-instance-slots object) location)
+                    new-value))
+             (t (bug "unrecognized instance type in ~S"
+                     '(setf slot-value-using-class)))))
+      (cons
+       (setf (cdr location) new-value))
+      (t
+       (instance-structure-protocol-error
+        slotd '(setf slot-value-using-class))))))
 
 (defmethod slot-boundp-using-class
            ((class std-class)
             (object standard-object)
             (slotd standard-effective-slot-definition))
+  ;; FIXME: Do we need this? SLOT-BOUNDP checks for obsolete
+  ;; instances. Are users allowed to call this directly?
   (check-obsolete-instance object)
   (let* ((location (slot-definition-location slotd))
          (value
     ((class condition-class)
      (object condition)
      (slotd condition-effective-slot-definition))
-  (let ((fun (slot-definition-reader-function slotd)))
-    (declare (type function fun))
+  (let ((fun (slot-info-reader (slot-definition-info slotd))))
     (funcall fun object)))
 
 (defmethod (setf slot-value-using-class)
      (class condition-class)
      (object condition)
      (slotd condition-effective-slot-definition))
-  (let ((fun (slot-definition-writer-function slotd)))
-    (declare (type function fun))
+  (let ((fun (slot-info-writer (slot-definition-info slotd))))
     (funcall fun new-value object)))
 
 (defmethod slot-boundp-using-class
     ((class condition-class)
      (object condition)
      (slotd condition-effective-slot-definition))
-  (let ((fun (slot-definition-boundp-function slotd)))
-    (declare (type function fun))
+  (let ((fun (slot-info-boundp (slot-definition-info slotd))))
     (funcall fun object)))
 
 (defmethod slot-makunbound-using-class ((class condition-class) object slot)
   (let* ((function (slot-definition-internal-reader-function slotd))
          (value (funcall function object)))
     (declare (type function function))
+    ;; FIXME: Is this really necessary? Structure slots should surely
+    ;; never be unbound!
     (if (eq value +slot-unbound+)
         (values (slot-unbound class object (slot-definition-name slotd)))
         value)))
     instance
     (etypecase position
       (fixnum
-       (nth position (wrapper-instance-slots-layout (wrapper-of instance))))
+       ;; In the vast majority of cases location corresponds to the position
+       ;; in list. The only exceptions are when there are non-local slots
+       ;; before the one we want.
+       (let* ((slots (wrapper-slots (wrapper-of instance)))
+              (guess (nth position slots)))
+         (if (eql position (slot-definition-location guess))
+             (slot-definition-name guess)
+             (slot-definition-name
+              (car (member position (class-slots instance) :key #'slot-definition-location))))))
       (cons
        (car position))))))
 \f
 ;;; FIXME: AMOP says that allocate-instance imples finalize-inheritance
 ;;; if the class is not yet finalized, but we don't seem to be taking
-;;; care of this for non-standard-classes.x
+;;; care of this for non-standard-classes.
 (defmethod allocate-instance ((class standard-class) &rest initargs)
   (declare (ignore initargs))
   (unless (class-finalized-p class)
   (let ((constructor (class-defstruct-constructor class)))
     (if constructor
         (funcall constructor)
-        (allocate-standard-instance (class-wrapper class)))))
+        (error "Don't know how to allocate ~S" class))))
 
-;;; FIXME: It would be nicer to have allocate-instance return
-;;; uninitialized objects for conditions as well.
 (defmethod allocate-instance ((class condition-class) &rest initargs)
   (declare (ignore initargs))
-  (make-condition (class-name class)))
+  (allocate-condition (class-name class)))
 
 (defmethod allocate-instance ((class built-in-class) &rest initargs)
   (declare (ignore initargs))
   (error "Cannot allocate an instance of ~S." class)) ; So sayeth AMOP
+
+;;; AMOP says that CLASS-SLOTS signals an error for unfinalized classes.
+(defmethod class-slots :before ((class slot-class))
+  (unless (class-finalized-p class)
+    (error 'simple-reference-error
+           :format-control "~S called on ~S, which is not yet finalized."
+           :format-arguments (list 'class-slots class)
+           :references (list '(:amop :generic-function class-slots)))))