0.pre7.65:
[sbcl.git] / src / code / defstruct.lisp
index ce09578..9d0dd52 100644 (file)
@@ -16,7 +16,7 @@
 \f
 ;;;; getting LAYOUTs
 
-;;; Return the compiler layout for Name. (The class referred to by
+;;; Return the compiler layout for NAME. (The class referred to by
 ;;; NAME must be a structure-like class.)
 (defun compiler-layout-or-lose (name)
   (let ((res (info :type :compiler-layout name)))
@@ -82,7 +82,7 @@
                                 funcallable-structure))
 
   ;; The next three slots are for :TYPE'd structures (which aren't
-  ;; classes, CLASS-STRUCTURE-P = NIL)
+  ;; classes, DD-CLASS-P = NIL)
   ;;
   ;; vector element type
   (element-type t)
   ;; option was given with no argument, or 0 if no PRINT-OBJECT option
   ;; was given
   (print-object 0 :type (or cons symbol (member 0)))
-  ;; the index of the raw data vector and the number of words in it.
-  ;; NIL and 0 if not allocated yet.
+  ;; the index of the raw data vector and the number of words in it,
+  ;; or NIL and 0 if not allocated (either because this structure
+  ;; has no raw slots, or because we're still parsing it and haven't
+  ;; run across any raw slots yet)
   (raw-index nil :type (or index null))
   (raw-length 0 :type index)
   ;; the value of the :PURE option, or :UNSPECIFIED. This is only
-  ;; meaningful if CLASS-STRUCTURE-P = T.
+  ;; meaningful if DD-CLASS-P = T.
   (pure :unspecified :type (member t nil :substructure :unspecified)))
 (def!method print-object ((x defstruct-description) stream)
   (print-unreadable-object (x stream :type t)
     (prin1 (dsd-name x) stream)))
 
 ;;; Is DEFSTRUCT a structure with a class?
-(defun class-structure-p (defstruct)
+(defun dd-class-p (defstruct)
   (member (dd-type defstruct) '(structure funcallable-structure)))
 
 ;;; Return the name of a defstruct slot as a symbol. We store it as a
            (flet (;; Given an arg from a :PRINT-OBJECT or :PRINT-FUNCTION
                   ;; option, return the value to pass as an arg to FUNCTION.
                   (farg (oarg)
-                    (destructuring-bind (function-name) oarg
-                      function-name)))
+                    (destructuring-bind (fun-name) oarg
+                      fun-name)))
              (cond ((not (eql pf 0))
                     `((def!method print-object ((,x ,name) ,s)
                         (funcall #',(farg pf) ,x ,s *current-level*))))
                 name-and-options
                 slot-descriptions))
            (name (dd-name dd)))
-       (if (class-structure-p dd)
+       (if (dd-class-p dd)
           (let ((inherits (inherits-for-structure dd)))
             `(progn
                (eval-when (:compile-toplevel :load-toplevel :execute)
-                 (%compiler-defstruct ',dd ',inherits)
-                 ,@(when (eq (dd-type dd) 'structure)
-                     `((%compiler-truly-defstruct ',dd))))
+                 (%compiler-defstruct ',dd ',inherits))
                (%defstruct ',dd ',inherits)
                ,@(unless expanding-into-code-for-xc-host-p
                    (append (raw-accessor-definitions dd)
   (let* ((name (dd-name dd)))
     (collect ((res))
       (dolist (slot (dd-slots dd))
-       (let ((stype (dsd-type slot))
+       (let ((slot-type (dsd-type slot))
              (accessor-name (dsd-accessor-name slot))
              (argname (gensym "ARG"))
              (nvname (gensym "NEW-VALUE-")))
            (when (and accessor-name
                       (not (eq accessor-name '%instance-ref)))
              (res `(declaim (inline ,accessor-name)))
-             (res `(declaim (ftype (function (,name) ,stype) ,accessor-name)))
+             (res `(declaim (ftype (function (,name) ,slot-type)
+                                   ,accessor-name)))
              (res `(defun ,accessor-name (,argname)
-                     (truly-the ,stype (,accessor ,data ,offset))))
+                     ;; Note: The DECLARE here might seem redundant
+                     ;; with the DECLAIM FTYPE above, but it's not:
+                     ;; If we're not at toplevel, the PROCLAIM inside
+                     ;; the DECLAIM doesn't get executed until after
+                     ;; this function is compiled.
+                     (declare (type ,name ,argname))
+                     (truly-the ,slot-type (,accessor ,data ,offset))))
              (unless (dsd-read-only slot)
                (res `(declaim (inline (setf ,accessor-name))))
-               (res `(declaim (ftype (function (,stype ,name) ,stype)
+               (res `(declaim (ftype (function (,slot-type ,name) ,slot-type)
                                      (setf ,accessor-name))))
                ;; FIXME: I rewrote this somewhat from the CMU CL definition.
                ;; Do some basic tests to make sure that reading and writing
                ;; raw slots still works correctly.
                (res `(defun (setf ,accessor-name) (,nvname ,argname)
+                       (declare (type ,name ,argname))
                        (setf (,accessor ,data ,offset) ,nvname)
                        ,nvname)))))))
       (res))))
   (collect ((stuff))
     (let ((ltype (dd-lisp-type defstruct)))
       (dolist (slot (dd-slots defstruct))
-       (let ((name (dsd-accessor slot))
+       (let ((name (dsd-accessor-name slot))
              (index (dsd-index slot))
              (slot-type `(and ,(dsd-type slot)
                               ,(dd-element-type defstruct))))
 (defun require-no-print-options-so-far (defstruct)
   (unless (and (eql (dd-print-function defstruct) 0)
               (eql (dd-print-object defstruct) 0))
-    (error "no more than one of the following options may be specified:
+    (error "No more than one of the following options may be specified:
   :PRINT-FUNCTION, :PRINT-OBJECT, :TYPE")))
 
 ;;; Parse a single DEFSTRUCT option and store the results in DD.
        (t
         (values nil nil nil))))
 
-;;; Allocate storage for a DSD in DEFSTRUCT. This is where we decide
-;;; whether a slot is raw or not. If raw, and we haven't allocated a
-;;; raw-index yet for the raw data vector, then do it. Raw objects are
-;;; aligned on the unit of their size.
-(defun allocate-1-slot (defstruct dsd)
+;;; Allocate storage for a DSD in DD. This is where we decide whether
+;;; a slot is raw or not. If raw, and we haven't allocated a raw-index
+;;; yet for the raw data vector, then do it. Raw objects are aligned
+;;; on the unit of their size.
+(defun allocate-1-slot (dd dsd)
   (multiple-value-bind (raw? raw-type words)
-      (if (eq (dd-type defstruct) 'structure)
+      (if (eq (dd-type dd) 'structure)
          (structure-raw-slot-type-and-size (dsd-type dsd))
          (values nil nil nil))
     (/noshow "ALLOCATE-1-SLOT" dsd raw? raw-type words)
     (cond ((not raw?)
-          (setf (dsd-index dsd) (dd-length defstruct))
-          (incf (dd-length defstruct)))
+          (setf (dsd-index dsd) (dd-length dd))
+          (incf (dd-length dd)))
          (t
-          (unless (dd-raw-index defstruct)
-            (setf (dd-raw-index defstruct) (dd-length defstruct))
-            (incf (dd-length defstruct)))
-          (let ((off (rem (dd-raw-length defstruct) words)))
+          (unless (dd-raw-index dd)
+            (setf (dd-raw-index dd) (dd-length dd))
+            (incf (dd-length dd)))
+          (let ((off (rem (dd-raw-length dd) words)))
             (unless (zerop off)
-              (incf (dd-raw-length defstruct) (- words off))))
+              (incf (dd-raw-length dd) (- words off))))
           (setf (dsd-raw-type dsd) raw-type)
-          (setf (dsd-index dsd) (dd-raw-length defstruct))
-          (incf (dd-raw-length defstruct) words))))
+          (setf (dsd-index dsd) (dd-raw-length dd))
+          (incf (dd-raw-length dd) words))))
   (values))
 
 (defun typed-structure-info-or-lose (name)
   (destructuring-bind (included-name &rest modified-slots) (dd-include dd)
     (let* ((type (dd-type dd))
           (included-structure
-           (if (class-structure-p dd)
+           (if (dd-class-p dd)
                (layout-info (compiler-layout-or-lose included-name))
                (typed-structure-info-or-lose included-name))))
       (unless (and (eq type (dd-type included-structure))
                   (type= (specifier-type (dd-element-type included-structure))
                          (specifier-type (dd-element-type dd))))
-       (error ":TYPE option mismatch between structures ~S and ~S."
+       (error ":TYPE option mismatch between structures ~S and ~S"
               (dd-name dd) included-name))
 
       (incf (dd-length dd) (dd-length included-structure))
-      (when (class-structure-p dd)
+      (when (dd-class-p dd)
        (let ((mc (rest (dd-alternate-metaclass included-structure))))
          (when (and mc (not (dd-alternate-metaclass dd)))
            (setf (dd-alternate-metaclass dd)
 
       ;; FIXME: Someday it'd probably be good to go back to using
       ;; closures for the out-of-line forms of structure accessors.
-      ;; See comment on corresponding code in %%COMPILER-TRULY-DEFSTRUCT.
       #|
       (when (dd-predicate info)
        (protect-cl (dd-predicate info))
 
   (values))
 
-;;; Do compile-time actions for DEFSTRUCT.
-(defun %compiler-defstruct (info inherits)
+;;; Return a form describing the writable place used for this slot
+;;; in the instance named INSTANCE-NAME.
+(defun %accessor-place-form (dd dsd instance-name)
+  (let (;; the operator that we'll use to access a typed slot or, in
+       ;; the case of a raw slot, to read the vector of raw slots
+       (ref (ecase (dd-type dd)
+              (structure '%instance-ref)
+              (funcallable-structure '%funcallable-instance-info)
+              (list 'nth-but-with-sane-arg-order)
+              (vector 'aref)))
+       (raw-type (dsd-raw-type dsd)))
+    (if (eq raw-type t) ; if not raw slot
+       `(,ref ,instance-name ,(dsd-index dsd))
+       (let (;; the operator that we'll use to access one value in
+             ;; the raw data vector
+             (rawref (ecase raw-type
+                       ;; The compiler thinks that the raw data
+                       ;; vector is a vector of unsigned bytes, so if
+                       ;; the slot we want to access actually *is* an
+                       ;; unsigned byte, it'll access the slot for
+                       ;; us even if we don't lie to it at all.
+                       (unsigned-byte 'aref)
+                       ;; "A lie can travel halfway round the world while
+                       ;; the truth is putting on its shoes." -- Mark Twain
+                       (single-float '%raw-ref-single)
+                       (double-float '%raw-ref-double)
+                       #!+long-float (long-float '%raw-ref-long)
+                       (complex-single-float '%raw-ref-complex-single)
+                       (complex-double-float '%raw-ref-complex-double)
+                       #!+long-float (complex-long-float
+                                      '%raw-ref-complex-long))))
+         `(,rawref (,ref ,instance-name ,(dd-raw-index dd))
+                   ,(dsd-index dsd))))))
+
+;;; Return inline expansion designators (i.e. values suitable for
+;;; (INFO :FUNCTION :INLINE-EXPANSSION-DESIGNATOR ..)) for the reader
+;;; and writer functions of the slot described by DSD.
+(defun accessor-inline-expansion-designators (dd dsd)
+  ;; ordinary tagged non-raw slot case
+  (values (lambda ()
+           `(lambda (instance)
+              (declare (type ,(dd-name dd) instance))
+              (truly-the ,(dsd-type dsd)
+                         ,(%accessor-place-form dd dsd 'instance))))
+         (lambda ()
+           `(lambda (new-value instance)
+              (declare (type ,(dsd-type dsd) new-value))
+              (declare (type ,(dd-name dd) structure-object))
+              (setf ,(%accessor-place-form dd dsd 'instance) new-value)))))
+
+;;; Do (COMPILE LOAD EVAL)-time actions for the defstruct described by DD.
+(defun %compiler-defstruct (dd inherits)
+  (declare (type defstruct-description dd))
   (multiple-value-bind (class layout old-layout)
       (multiple-value-bind (clayout clayout-p)
-         (info :type :compiler-layout (dd-name info))
-       (ensure-structure-class info
+         (info :type :compiler-layout (dd-name dd))
+       (ensure-structure-class dd
                                inherits
                                (if clayout-p "previously compiled" "current")
                                "compiled"
                        (undefine-structure class)
                        (subs (class-proper-name class)))
                      (when (subs)
-                       (warn "Removing old subclasses of ~S:~%  ~S"
+                       (warn "removing old subclasses of ~S:~%  ~S"
                              (sb!xc:class-name class)
                              (subs))))))
          (t
           (unless (eq (class-layout class) layout)
             (register-layout layout :invalidate nil))
-          (setf (sb!xc:find-class (dd-name info)) class)))
-
-    (setf (info :type :compiler-layout (dd-name info)) layout))
-  (values))
-
-;;; Do (COMPILE LOAD EVAL) time actions for updating the compiler's
-;;; global meta-information to represent the definition of a structure
-;;; (truly a structure, not just DEFSTRUCT :TYPE VECTOR or DEFSTRUCT
-;;; :TYPE LIST) described by INFO.
-(defun %compiler-truly-defstruct (info)
-  (declare (type defstruct-description info))
-  (let* ((name (dd-name info))
-        (class (sb!xc:find-class name)))
-
-    (let ((copier (dd-copier info)))
-      (when copier
-       (proclaim `(ftype (function (,name) ,name) ,copier))))
-
-    ;; FIXME: This (and corresponding code in %DEFSTRUCT) are the way
-    ;; that CMU CL defined the predicate, instead of using DEFUN.
-    ;; Perhaps it would be better to go back to to the CMU CL way, or
-    ;; something similar. I want to reduce the amount of magic in
-    ;; DEFSTRUCT functions, but making the predicate be a closure
-    ;; looks like a good thing, and can even be done without magic.
-    ;; (OTOH, there are some bootstrapping issues involved, since
-    ;; GENESIS understands DEFUN but doesn't understand a
-    ;; (SETF SYMBOL-FUNCTION) call inside %DEFSTRUCT.)
-    #|
-    (let ((predicate-name (dd-predicate-name info)))
-      (when predicate-name
-       (proclaim-as-defstruct-function-name predicate-name)
-       (setf (info :function :inlinep pred) :inline)
-       (setf (info :function :inline-expansion predicate-name)
-             `(lambda (x) (typep x ',name)))))
-    |#
-
-    (dolist (slot (dd-slots info))
-      (let* ((fun (dsd-accessor-name slot))
-            (setf-fun `(setf ,fun)))
-       (when (and fun (eq (dsd-raw-type slot) t))
-         (proclaim-as-defstruct-function-name fun)
-         (setf (info :function :accessor-for fun) class)
-         (unless (dsd-read-only slot)
-           (proclaim-as-defstruct-function-name setf-fun)
-           (setf (info :function :accessor-for setf-fun) class)))))
-
-    ;; FIXME: Couldn't this logic be merged into
-    ;; PROCLAIM-AS-DEFSTRUCT-FUNCTION?
-    (when (boundp 'sb!c:*free-functions*) ; when compiling
-      (let ((free-functions sb!c:*free-functions*))
-       (dolist (slot (dd-slots info))
-         (let ((accessor-name (dsd-accessor-name slot)))
-           (remhash accessor-name free-functions)
-           (unless (dsd-read-only slot)
-             (remhash `(setf ,accessor-name) free-functions))))
-       (remhash (dd-predicate-name info) free-functions)
-       (remhash (dd-copier info) free-functions))))
+          (setf (sb!xc:find-class (dd-name dd)) class)))
+
+    (setf (info :type :compiler-layout (dd-name dd)) layout))
+
+  (ecase (dd-type dd)
+    ((vector list funcallable-structure)
+     ;; nothing extra to do in this case
+     )
+    ((structure)
+     (let* ((name (dd-name dd))
+           (class (sb!xc:find-class name)))
+
+       (let ((copier (dd-copier dd)))
+        (when copier
+          (proclaim `(ftype (function (,name) ,name) ,copier))))
+
+       (dolist (dsd (dd-slots dd))
+        (let* ((accessor-name (dsd-accessor-name dsd)))
+          (when accessor-name
+
+            ;; new implementation sbcl-0.pre7.64
+            (multiple-value-bind (reader-designator writer-designator)
+                (accessor-inline-expansion-designators dd dsd)
+              (setf (info :function
+                          :inline-expansion-designator
+                          accessor-name)
+                    reader-designator
+                    (info :function :inlinep accessor-name)
+                    :inline)
+              (unless (dsd-read-only dsd)
+                (let ((setf-accessor-name `(setf ,accessor-name)))
+                  (setf (info :function
+                              :inline-expansion-designator
+                              setf-accessor-name)
+                        writer-designator
+                        (info :function :inlinep setf-accessor-name)
+                        :inline))))
+
+            ;; old code from before sbcl-0.pre7.64, will hopefully
+            ;; fade away and/or merge into new code above
+            (when (eq (dsd-raw-type dsd) t) ; when not raw slot
+              (proclaim-as-defstruct-fun-name accessor-name)
+              (setf (info :function :accessor-for accessor-name) class)
+              (unless (dsd-read-only dsd)
+                (proclaim-as-defstruct-fun-name `(setf ,accessor-name))
+                (setf (info :function :accessor-for `(setf ,accessor-name))
+                      class))))))
+
+       ;; FIXME: Couldn't this logic be merged into
+       ;; PROCLAIM-AS-DEFSTRUCT-FUN-NAME?
+       (when (boundp 'sb!c:*free-functions*) ; when compiling
+        (let ((free-functions sb!c:*free-functions*))
+          (dolist (slot (dd-slots dd))
+            (let ((accessor-name (dsd-accessor-name slot)))
+              (remhash accessor-name free-functions)
+              (unless (dsd-read-only slot)
+                (remhash `(setf ,accessor-name) free-functions))))
+          (remhash (dd-predicate-name dd) free-functions)
+          (remhash (dd-copier dd) free-functions))))))
 
   (values))
 \f
     (when (defstruct-description-p info)
       (let ((type (dd-name info)))
        (setf (info :type :compiler-layout type) nil)
-       (undefine-function-name (dd-copier info))
-       (undefine-function-name (dd-predicate-name info))
+       (undefine-fun-name (dd-copier info))
+       (undefine-fun-name (dd-predicate-name info))
        (dolist (slot (dd-slots info))
          (let ((fun (dsd-accessor-name slot)))
-           (undefine-function-name fun)
+           (undefine-fun-name fun)
            (unless (dsd-read-only slot)
-             (undefine-function-name `(setf ,fun))))))
+             (undefine-fun-name `(setf ,fun))))))
       ;; Clear out the SPECIFIER-TYPE cache so that subsequent
       ;; references are unknown types.
       (values-specifier-type-cache-clear)))
 ;;;; slot accessors for raw slots
 
 ;;; Return info about how to read/write a slot in the value stored in
-;;; OBJECT. This is also used by constructors (we can't use the
-;;; accessor function, since some slots are read-only.) If supplied,
-;;; DATA is a variable holding the raw-data vector.
+;;; OBJECT. This is also used by constructors (since we can't safely
+;;; use the accessor function, since some slots are read-only). If
+;;; supplied, DATA is a variable holding the raw-data vector.
 ;;;
 ;;; returned values:
 ;;; 1. accessor function name (SETFable)
 \f
 ;;;; compiler stuff
 
-;;; This is like PROCLAIM-AS-FUNCTION-NAME, but we also set the kind to
+;;; This is like PROCLAIM-AS-FUN-NAME, but we also set the kind to
 ;;; :DECLARED and blow away any ASSUMED-TYPE. Also, if the thing is a
 ;;; slot accessor currently, quietly unaccessorize it. And if there
 ;;; are any undefined warnings, we nuke them.
-(defun proclaim-as-defstruct-function-name (name)
+(defun proclaim-as-defstruct-fun-name (name)
   (when name
     (when (info :function :accessor-for name)
       (setf (info :function :accessor-for name) nil))
-    (proclaim-as-function-name name)
+    (proclaim-as-fun-name name)
     (note-name-defined name :function)
     (setf (info :function :where-from name) :declared)
     (when (info :function :assumed-type name)