X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=src%2Fcode%2Fdefstruct.lisp;h=ab9d722932bba91fedd6840f1a43aa627d39279d;hb=89eb73c035f05ae53b1148ef8a83e1d4030b2dd8;hp=ca7e4672c78c98a8b717a7ff01561625d4715b45;hpb=8fc5fda05f92d69c95b47e4ad7561d91dab18c3e;p=sbcl.git diff --git a/src/code/defstruct.lisp b/src/code/defstruct.lisp index ca7e467..ab9d722 100644 --- a/src/code/defstruct.lisp +++ b/src/code/defstruct.lisp @@ -12,12 +12,11 @@ (in-package "SB!KERNEL") -(file-comment - "$Header$") +(/show0 "code/defstruct.lisp 15") ;;;; 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))) @@ -55,15 +54,15 @@ ;; documentation on the structure (doc nil :type (or string null)) ;; prefix for slot names. If NIL, none. - (conc-name (concat-pnames name '-) :type (or symbol null)) + (conc-name (symbolicate name "-") :type (or symbol null)) ;; the name of the primary standard keyword constructor, or NIL if none (default-constructor nil :type (or symbol null)) ;; all the explicit :CONSTRUCTOR specs, with name defaulted (constructors () :type list) ;; name of copying function - (copier (concat-pnames 'copy- name) :type (or symbol null)) + (copier-name (symbolicate "COPY-" name) :type (or symbol null)) ;; name of type predicate - (predicate (concat-pnames name '-p) :type (or symbol null)) + (predicate-name (symbolicate name "-P") :type (or symbol null)) ;; the arguments to the :INCLUDE option, or NIL if no included ;; structure (include nil :type list) @@ -83,10 +82,10 @@ 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) + (element-type t) ;; T if :NAMED was explicitly specified, NIL otherwise (named nil :type boolean) ;; any INITIAL-OFFSET option on this direct type @@ -100,12 +99,14 @@ ;; 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) @@ -122,9 +123,13 @@ %name ;; its position in the implementation sequence (index (required-argument) :type fixnum) - ;; Name of accessor, or NIL if this accessor has the same name as an - ;; inherited accessor (which we don't want to shadow.) - (accessor nil) + ;; the name of the accessor function + ;; + ;; (CMU CL had extra complexity here ("..or NIL if this accessor has + ;; the same name as an inherited accessor (which we don't want to + ;; shadow)") but that behavior doesn't seem to be specified by (or + ;; even particularly consistent with) ANSI, so it's gone in SBCL.) + (accessor-name nil) default ; default value expression (type t) ; declared type specifier ;; If this object does not describe a raw slot, this value is T. @@ -144,16 +149,16 @@ (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 ;;; string to avoid creating lots of worthless symbols at load time. (defun dsd-name (dsd) (intern (string (dsd-%name dsd)) - (if (dsd-accessor dsd) - (symbol-package (dsd-accessor dsd)) - *package*))) + (if (dsd-accessor-name dsd) + (symbol-package (dsd-accessor-name dsd)) + (sane-package)))) ;;;; typed (non-class) structures @@ -166,8 +171,8 @@ ;;;; the legendary DEFSTRUCT macro itself (both CL:DEFSTRUCT and its ;;;; close personal friend SB!XC:DEFSTRUCT) -;;; Return a list of forms to install print and make-load-form funs, mentioning -;;; them in the expansion so that they can be compiled. +;;; Return a list of forms to install PRINT and MAKE-LOAD-FORM funs, +;;; mentioning them in the expansion so that they can be compiled. (defun class-method-definitions (defstruct) (let ((name (dd-name defstruct))) `((locally @@ -190,8 +195,8 @@ (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*)))) @@ -200,7 +205,7 @@ (funcall #',(farg po) ,x ,s)))) (t nil)))) ,@(let ((pure (dd-pure defstruct))) - (cond ((eq pure 't) + (cond ((eq pure t) `((setf (layout-pure (class-layout (sb!xc:find-class ',name))) t))) @@ -211,49 +216,30 @@ ,@(let ((def-con (dd-default-constructor defstruct))) (when (and def-con (not (dd-alternate-metaclass defstruct))) `((setf (structure-class-constructor (sb!xc:find-class ',name)) - #',def-con)))) - ;; FIXME: MAKE-LOAD-FORM is supposed to be handled here, too. - )))) -;;; FIXME: I really would like to make structure accessors less special, -;;; just ordinary inline functions. (Or perhaps inline functions with special -;;; compact implementations of their expansions, to avoid bloating the system.) + #',def-con)))))))) +;;; FIXME: I really would like to make structure accessors less +;;; special, just ordinary inline functions. (Or perhaps inline +;;; functions with special compact implementations of their +;;; expansions, to avoid bloating the system.) ;;; shared logic for CL:DEFSTRUCT and SB!XC:DEFSTRUCT -;;; -;;; FIXME: There should be some way to make this not be present in the -;;; target executable, with EVAL-WHEN (COMPILE EXECUTE) and all that good -;;; stuff, but for now I can't be bothered because of the messiness of -;;; using CL:DEFMACRO in one case and SB!XC:DEFMACRO in another case. -;;; Perhaps I could dodge this by defining it as an inline function instead? -;;; Or perhaps just use MACROLET? I tried MACROLET and got nowhere and thought -;;; I was tripping over either a compiler bug or ANSI weirdness, but this -;;; test case seems to work in Debian CMU CL 2.4.9: -;;; (macrolet ((emit-printer () ''(print "********"))) -;;; (defmacro fizz () (emit-printer))) -;;; giving -;;; * (fizz) -;;; "********" -;;; "********" -;;; * -(defmacro expander-for-defstruct (name-and-options - slot-descriptions - expanding-into-code-for-xc-host-p) +(defmacro !expander-for-defstruct (name-and-options + slot-descriptions + expanding-into-code-for-xc-host-p) `(let ((name-and-options ,name-and-options) (slot-descriptions ,slot-descriptions) (expanding-into-code-for-xc-host-p ,expanding-into-code-for-xc-host-p)) - (let* ((dd (parse-name-and-options-and-slot-descriptions + (let* ((dd (parse-defstruct-name-and-options-and-slot-descriptions 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-only-defstruct ',dd ',inherits)) + (%compiler-defstruct ',dd ',inherits)) (%defstruct ',dd ',inherits) - ,@(when (eq (dd-type dd) 'structure) - `((%compiler-defstruct ',dd))) ,@(unless expanding-into-code-for-xc-host-p (append (raw-accessor-definitions dd) (predicate-definitions dd) @@ -277,8 +263,8 @@ (sb!xc:defmacro defstruct (name-and-options &rest slot-descriptions) #!+sb-doc "DEFSTRUCT {Name | (Name Option*)} {Slot | (Slot [Default] {Key Value}*)} - Define the structure type Name. Instances are created by MAKE-, which - takes keyword arguments allowing initial slot values to the specified. + Define the structure type Name. Instances are created by MAKE-, + which takes &KEY arguments allowing initial slot values to the specified. A SETF'able function - is defined for each slot to read and write slot values. -p is a type predicate. @@ -303,15 +289,15 @@ :READ-ONLY {T | NIL} If true, no setter function is defined for this slot." - (expander-for-defstruct name-and-options slot-descriptions nil)) + (!expander-for-defstruct name-and-options slot-descriptions nil)) #+sb-xc-host (defmacro sb!xc:defstruct (name-and-options &rest slot-descriptions) #!+sb-doc "Cause information about a target structure to be built into the cross-compiler." - (expander-for-defstruct name-and-options slot-descriptions t)) + (!expander-for-defstruct name-and-options slot-descriptions t)) -;;;; functions to create various parts of DEFSTRUCT definitions +;;;; functions to generate code for various parts of DEFSTRUCT definitions ;;; Catch requests to mess up definitions in COMMON-LISP. #-sb-xc-host @@ -329,33 +315,42 @@ (let* ((name (dd-name dd))) (collect ((res)) (dolist (slot (dd-slots dd)) - (let ((stype (dsd-type slot)) - (accname (dsd-accessor slot)) + (let ((slot-type (dsd-type slot)) + (accessor-name (dsd-accessor-name slot)) (argname (gensym "ARG")) (nvname (gensym "NEW-VALUE-"))) (multiple-value-bind (accessor offset data) (slot-accessor-form dd slot argname) ;; When accessor exists and is raw - (when (and accname (not (eq accessor '%instance-ref))) - (res `(declaim (inline ,accname))) - (res `(declaim (ftype (function (,name) ,stype) ,accname))) - (res `(defun ,accname (,argname) - (truly-the ,stype (,accessor ,data ,offset)))) + (when (and accessor-name + (not (eq accessor-name '%instance-ref))) + (res `(declaim (inline ,accessor-name))) + (res `(declaim (ftype (function (,name) ,slot-type) + ,accessor-name))) + (res `(defun ,accessor-name (,argname) + ;; 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 ,accname)))) - (res `(declaim (ftype (function (,stype ,name) ,stype) - (setf ,accname)))) + (res `(declaim (inline (setf ,accessor-name)))) + (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 ,accname) (,nvname ,argname) + (res `(defun (setf ,accessor-name) (,nvname ,argname) + (declare (type ,name ,argname)) (setf (,accessor ,data ,offset) ,nvname) ,nvname))))))) (res)))) ;;; Return a list of forms which create a predicate for an untyped DEFSTRUCT. (defun predicate-definitions (dd) - (let ((pred (dd-predicate dd)) + (let ((pred (dd-predicate-name dd)) (argname (gensym))) (when pred (if (eq (dd-type dd) 'funcallable-structure) @@ -376,11 +371,11 @@ ;;; DEFSTRUCT. (defun typed-predicate-definitions (defstruct) (let ((name (dd-name defstruct)) - (pred (dd-predicate defstruct)) + (predicate-name (dd-predicate-name defstruct)) (argname (gensym))) - (when (and pred (dd-named defstruct)) + (when (and predicate-name (dd-named defstruct)) (let ((ltype (dd-lisp-type defstruct))) - `((defun ,pred (,argname) + `((defun ,predicate-name (,argname) (and (typep ,argname ',ltype) (eq (elt (the ,ltype ,argname) ,(cdr (car (last (find-name-indices defstruct))))) @@ -409,9 +404,9 @@ ;;; Return a list of forms to create a copier function of a typed DEFSTRUCT. (defun typed-copier-definitions (defstruct) - (when (dd-copier defstruct) - `((setf (fdefinition ',(dd-copier defstruct)) #'copy-seq) - (declaim (ftype function ,(dd-copier defstruct)))))) + (when (dd-copier-name defstruct) + `((setf (fdefinition ',(dd-copier-name defstruct)) #'copy-seq) + (declaim (ftype function ,(dd-copier-name defstruct)))))) ;;; Return a list of function definitions for accessing and setting the ;;; slots of a typed DEFSTRUCT. The functions are proclaimed to be inline, @@ -421,7 +416,7 @@ (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)))) @@ -444,117 +439,118 @@ (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 DEFSTRUCT. -(defun parse-1-option (option defstruct) +;;; Parse a single DEFSTRUCT option and store the results in DD. +(defun parse-1-dd-option (option dd) (let ((args (rest option)) - (name (dd-name defstruct))) + (name (dd-name dd))) (case (first option) (:conc-name (destructuring-bind (conc-name) args - (setf (dd-conc-name defstruct) + (setf (dd-conc-name dd) (if (symbolp conc-name) conc-name (make-symbol (string conc-name)))))) (:constructor - (destructuring-bind (&optional (cname (concat-pnames 'make- name)) + (destructuring-bind (&optional (cname (symbolicate "MAKE-" name)) &rest stuff) args - (push (cons cname stuff) (dd-constructors defstruct)))) + (push (cons cname stuff) (dd-constructors dd)))) (:copier - (destructuring-bind (&optional (copier (concat-pnames 'copy- name))) + (destructuring-bind (&optional (copier (symbolicate "COPY-" name))) args - (setf (dd-copier defstruct) copier))) + (setf (dd-copier-name dd) copier))) (:predicate - (destructuring-bind (&optional (pred (concat-pnames name '-p))) args - (setf (dd-predicate defstruct) pred))) + (destructuring-bind (&optional (predicate-name (symbolicate name "-P"))) + args + (setf (dd-predicate-name dd) predicate-name))) (:include - (when (dd-include defstruct) + (when (dd-include dd) (error "more than one :INCLUDE option")) - (setf (dd-include defstruct) args)) + (setf (dd-include dd) args)) (:alternate-metaclass - (setf (dd-alternate-metaclass defstruct) args)) + (setf (dd-alternate-metaclass dd) args)) (:print-function - (require-no-print-options-so-far defstruct) - (setf (dd-print-function defstruct) + (require-no-print-options-so-far dd) + (setf (dd-print-function dd) (the (or symbol cons) args))) (:print-object - (require-no-print-options-so-far defstruct) - (setf (dd-print-object defstruct) + (require-no-print-options-so-far dd) + (setf (dd-print-object dd) (the (or symbol cons) args))) (:type (destructuring-bind (type) args (cond ((eq type 'funcallable-structure) - (setf (dd-type defstruct) type)) + (setf (dd-type dd) type)) ((member type '(list vector)) - (setf (dd-element-type defstruct) 't) - (setf (dd-type defstruct) type)) + (setf (dd-element-type dd) t) + (setf (dd-type dd) type)) ((and (consp type) (eq (first type) 'vector)) (destructuring-bind (vector vtype) type (declare (ignore vector)) - (setf (dd-element-type defstruct) vtype) - (setf (dd-type defstruct) 'vector))) + (setf (dd-element-type dd) vtype) + (setf (dd-type dd) 'vector))) (t - (error "~S is a bad :TYPE for Defstruct." type))))) + (error "~S is a bad :TYPE for DEFSTRUCT." type))))) (:named (error "The DEFSTRUCT option :NAMED takes no arguments.")) (:initial-offset (destructuring-bind (offset) args - (setf (dd-offset defstruct) offset))) + (setf (dd-offset dd) offset))) (:pure (destructuring-bind (fun) args - (setf (dd-pure defstruct) fun))) + (setf (dd-pure dd) fun))) (t (error "unknown DEFSTRUCT option:~% ~S" option))))) ;;; Given name and options, return a DD holding that info. (eval-when (:compile-toplevel :load-toplevel :execute) -(defun parse-name-and-options (name-and-options) +(defun parse-defstruct-name-and-options (name-and-options) (destructuring-bind (name &rest options) name-and-options - (let ((defstruct (make-defstruct-description name))) + (aver name) ; A null name doesn't seem to make sense here. + (let ((dd (make-defstruct-description name))) (dolist (option options) (cond ((consp option) - (parse-1-option option defstruct)) + (parse-1-dd-option option dd)) ((eq option :named) - (setf (dd-named defstruct) t)) + (setf (dd-named dd) t)) ((member option '(:constructor :copier :predicate :named)) - (parse-1-option (list option) defstruct)) + (parse-1-dd-option (list option) dd)) (t (error "unrecognized DEFSTRUCT option: ~S" option)))) - (case (dd-type defstruct) + (case (dd-type dd) (structure - (when (dd-offset defstruct) + (when (dd-offset dd) (error ":OFFSET can't be specified unless :TYPE is specified.")) - (unless (dd-include defstruct) - (incf (dd-length defstruct)))) + (unless (dd-include dd) + (incf (dd-length dd)))) (funcallable-structure) (t - (require-no-print-options-so-far defstruct) - (when (dd-named defstruct) - (incf (dd-length defstruct))) - (let ((offset (dd-offset defstruct))) - (when offset (incf (dd-length defstruct) offset))))) + (require-no-print-options-so-far dd) + (when (dd-named dd) + (incf (dd-length dd))) + (let ((offset (dd-offset dd))) + (when offset (incf (dd-length dd) offset))))) - (when (dd-include defstruct) - (do-inclusion-stuff defstruct)) + (when (dd-include dd) + (do-dd-inclusion-stuff dd)) - defstruct))) + dd))) ;;; Given name and options and slot descriptions (and possibly doc ;;; string at the head of slot descriptions) return a DD holding that ;;; info. -(defun parse-name-and-options-and-slot-descriptions (name-and-options - slot-descriptions) - (/noshow "PARSE-NAME-AND-OPTIONS-AND-SLOT-DESCRIPTIONS" name-and-options) - (let ((result (parse-name-and-options (if (atom name-and-options) - (list name-and-options) - name-and-options)))) +(defun parse-defstruct-name-and-options-and-slot-descriptions + (name-and-options slot-descriptions) + (let ((result (parse-defstruct-name-and-options (if (atom name-and-options) + (list name-and-options) + name-and-options)))) (when (stringp (car slot-descriptions)) (setf (dd-doc result) (pop slot-descriptions))) - (dolist (slot slot-descriptions) - (allocate-1-slot result (parse-1-dsd result slot))) + (dolist (slot-description slot-descriptions) + (allocate-1-slot result (parse-1-dsd result slot-description))) result)) ) ; EVAL-WHEN @@ -562,16 +558,13 @@ ;;;; stuff to parse slot descriptions ;;; Parse a slot description for DEFSTRUCT, add it to the description -;;; and return it. If supplied, ISLOT is a pre-initialized DSD that we -;;; modify to get the new slot. This is supplied when handling -;;; included slots. If the new accessor name is already an accessor -;;; for same slot in some included structure, then set the -;;; DSD-ACCESSOR to NIL so that we don't clobber the more general -;;; accessor. +;;; and return it. If supplied, SLOT is a pre-initialized DSD +;;; that we modify to get the new slot. This is supplied when handling +;;; included slots. (defun parse-1-dsd (defstruct spec &optional - (islot (make-defstruct-slot-description :%name "" - :index 0 - :type t))) + (slot (make-defstruct-slot-description :%name "" + :index 0 + :type t))) (multiple-value-bind (name default default-p type type-p read-only ro-p) (cond ((listp spec) @@ -586,47 +579,52 @@ read-only ro-p))) (t (when (keywordp spec) - ;; FIXME: should be style warning - (warn "Keyword slot name indicates probable syntax ~ - error in DEFSTRUCT -- ~S." - spec)) + (style-warn "Keyword slot name indicates probable syntax ~ + error in DEFSTRUCT: ~S." + spec)) spec)) (when (find name (dd-slots defstruct) :test #'string= :key #'dsd-%name) - (error 'program-error + (error 'simple-program-error :format-control "duplicate slot name ~S" :format-arguments (list name))) - (setf (dsd-%name islot) (string name)) - (setf (dd-slots defstruct) (nconc (dd-slots defstruct) (list islot))) - - (let* ((accname (concat-pnames (dd-conc-name defstruct) name)) - (existing (info :function :accessor-for accname))) - (if (and (structure-class-p existing) - (not (eq (sb!xc:class-name existing) (dd-name defstruct))) - (string= (dsd-%name (find accname - (dd-slots - (layout-info - (class-layout existing))) - :key #'dsd-accessor)) - name)) - (setf (dsd-accessor islot) nil) - (setf (dsd-accessor islot) accname))) + (setf (dsd-%name slot) (string name)) + (setf (dd-slots defstruct) (nconc (dd-slots defstruct) (list slot))) + + (let ((accessor-name (symbolicate (or (dd-conc-name defstruct) "") name)) + (predicate-name (dd-predicate-name defstruct))) + (setf (dsd-accessor-name slot) accessor-name) + (when (eql accessor-name predicate-name) + ;; Some adventurous soul has named a slot so that its accessor + ;; collides with the structure type predicate. ANSI doesn't + ;; specify what to do in this case. As of 2001-09-04, Martin + ;; Atzmueller reports that CLISP and Lispworks both give + ;; priority to the slot accessor, so that the predicate is + ;; overwritten. We might as well do the same (as well as + ;; signalling a warning). + (style-warn + "~@" + accessor-name) + (setf (dd-predicate-name defstruct) nil))) (when default-p - (setf (dsd-default islot) default)) + (setf (dsd-default slot) default)) (when type-p - (setf (dsd-type islot) - (if (eq (dsd-type islot) 't) + (setf (dsd-type slot) + (if (eq (dsd-type slot) t) type - `(and ,(dsd-type islot) ,type)))) + `(and ,(dsd-type slot) ,type)))) (when ro-p (if read-only - (setf (dsd-read-only islot) t) - (when (dsd-read-only islot) + (setf (dsd-read-only slot) t) + (when (dsd-read-only slot) (error "Slot ~S is :READ-ONLY in parent and must be :READ-ONLY in subtype ~S." name - (dsd-name islot))))) - islot)) + (dsd-name slot))))) + slot)) ;;; When a value of type TYPE is stored in a structure, should it be ;;; stored in a raw slot? Return (VALUES RAW? RAW-TYPE WORDS), where @@ -669,29 +667,29 @@ (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) @@ -700,40 +698,42 @@ ;;; Process any included slots pretty much like they were specified. ;;; Also inherit various other attributes. -(defun do-inclusion-stuff (defstruct) - (destructuring-bind - (included-name &rest modified-slots) - (dd-include defstruct) - (let* ((type (dd-type defstruct)) +(defun do-dd-inclusion-stuff (dd) + (destructuring-bind (included-name &rest modified-slots) (dd-include dd) + (let* ((type (dd-type dd)) (included-structure - (if (class-structure-p defstruct) + (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 defstruct)))) - (error ":TYPE option mismatch between structures ~S and ~S." - (dd-name defstruct) included-name)) + (specifier-type (dd-element-type dd)))) + (error ":TYPE option mismatch between structures ~S and ~S" + (dd-name dd) included-name)) - (incf (dd-length defstruct) (dd-length included-structure)) - (when (class-structure-p defstruct) + (incf (dd-length dd) (dd-length included-structure)) + (when (dd-class-p dd) (let ((mc (rest (dd-alternate-metaclass included-structure)))) - (when (and mc (not (dd-alternate-metaclass defstruct))) - (setf (dd-alternate-metaclass defstruct) + (when (and mc (not (dd-alternate-metaclass dd))) + (setf (dd-alternate-metaclass dd) (cons included-name mc)))) - (when (eq (dd-pure defstruct) :unspecified) - (setf (dd-pure defstruct) (dd-pure included-structure))) - (setf (dd-raw-index defstruct) (dd-raw-index included-structure)) - (setf (dd-raw-length defstruct) (dd-raw-length included-structure))) - - (dolist (islot (dd-slots included-structure)) - (let* ((iname (dsd-name islot)) - (modified (or (find iname modified-slots + (when (eq (dd-pure dd) :unspecified) + (setf (dd-pure dd) (dd-pure included-structure))) + (setf (dd-raw-index dd) (dd-raw-index included-structure)) + (setf (dd-raw-length dd) (dd-raw-length included-structure))) + + (dolist (included-slot (dd-slots included-structure)) + (let* ((included-name (dsd-name included-slot)) + (modified (or (find included-name modified-slots :key #'(lambda (x) (if (atom x) x (car x))) :test #'string=) - `(,iname)))) - (parse-1-dsd defstruct modified (copy-structure islot))))))) + `(,included-name)))) + (parse-1-dsd dd + modified + (copy-structure included-slot))))))) +;;;; various helper functions for setting up DEFSTRUCTs + ;;; This function is called at macroexpand time to compute the INHERITS ;;; vector for a structure type definition. (defun inherits-for-structure (info) @@ -772,9 +772,9 @@ (let ((old-info (layout-info old-layout))) (when (defstruct-description-p old-info) (dolist (slot (dd-slots old-info)) - (fmakunbound (dsd-accessor slot)) + (fmakunbound (dsd-accessor-name slot)) (unless (dsd-read-only slot) - (fmakunbound `(setf ,(dsd-accessor slot))))))) + (fmakunbound `(setf ,(dsd-accessor-name slot))))))) (%redefine-defstruct class old-layout layout) (setq layout (class-layout class)))) @@ -787,16 +787,17 @@ (dolist (slot (dd-slots info)) (let ((dsd slot)) - (when (and (dsd-accessor slot) + (when (and (dsd-accessor-name slot) (eq (dsd-raw-type slot) t)) - (protect-cl (dsd-accessor slot)) - (setf (symbol-function (dsd-accessor slot)) + (protect-cl (dsd-accessor-name slot)) + (setf (symbol-function (dsd-accessor-name slot)) (structure-slot-getter layout dsd)) (unless (dsd-read-only slot) - (setf (fdefinition `(setf ,(dsd-accessor slot))) + (setf (fdefinition `(setf ,(dsd-accessor-name slot))) (structure-slot-setter layout dsd)))))) - ;; FIXME: See comment on corresponding code in %%COMPILER-DEFSTRUCT. + ;; FIXME: Someday it'd probably be good to go back to using + ;; closures for the out-of-line forms of structure accessors. #| (when (dd-predicate info) (protect-cl (dd-predicate info)) @@ -806,9 +807,9 @@ (typep-to-layout object layout)))) |# - (when (dd-copier info) - (protect-cl (dd-copier info)) - (setf (symbol-function (dd-copier info)) + (when (dd-copier-name info) + (protect-cl (dd-copier-name info)) + (setf (symbol-function (dd-copier-name info)) #'(lambda (structure) (declare (optimize (speed 3) (safety 0))) (flet ((layout-test (structure) @@ -829,44 +830,62 @@ (values)) -;;; This function is called at compile-time to do the -;;; compile-time-only actions for defining a structure type. It -;;; installs the class in the type system in a similar way to -;;; %DEFSTRUCT, but is quieter and safer in the case of redefinition. -;;; -;;; The comments for the classic CMU CL version of this function said -;;; that EVAL-WHEN doesn't do the right thing when nested or -;;; non-top-level, and so CMU CL had the function magically called by -;;; the compiler. Unfortunately, this doesn't do the right thing -;;; either: compiling a function (DEFUN FOO () (DEFSTRUCT FOO X Y)) -;;; causes the class FOO to become defined, even though FOO is never -;;; loaded or executed. Even more unfortunately, I've been unable to -;;; come up with any EVAL-WHEN tricks which work -- I finally gave up -;;; on this approach when trying to get the system to cross-compile -;;; error.lisp. (Just because I haven't found it doesn't mean that it -;;; doesn't exist, of course. Alas, I continue to have some trouble -;;; understanding compile/load semantics in Common Lisp.) So we -;;; continue to use the IR1 transformation approach, even though it's -;;; known to be buggy. -- WHN 19990507 -;;; -;;; Basically, this function avoids trashing the compiler by only -;;; actually defining the class if there is no current definition. -;;; Instead, we just set the INFO TYPE COMPILER-LAYOUT. This behavior -;;; is left over from classic CMU CL and may not be necessary in the -;;; new build system. -- WHN 19990507 -;;; -;;; FUNCTION-%COMPILER-ONLY-DEFSTRUCT is an ordinary function, called -;;; by both the IR1 transform version of %COMPILER-ONLY-DEFSTRUCT and -;;; by the ordinary function version of %COMPILER-ONLY-DEFSTRUCT. (The -;;; ordinary function version is there for the interpreter and for -;;; code walkers.) -(defun %compiler-only-defstruct (info inherits) - (function-%compiler-only-defstruct info inherits)) -(defun function-%compiler-only-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) + (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" @@ -881,64 +900,54 @@ (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 (sb!xc:find-class (dd-name dd)) class))) + + (setf (info :type :compiler-layout (dd-name dd)) layout)) + + (let* ((dd-name (dd-name dd)) + (class (sb!xc:find-class dd-name))) + + (let ((copier-name (dd-copier-name dd))) + (when copier-name + (sb!xc:proclaim `(ftype (function (,dd-name) ,dd-name) ,copier-name)))) + + (let ((predicate-name (dd-predicate-name dd))) + (when predicate-name + (sb!xc:proclaim `(ftype (function (t) t) ,predicate-name)))) + + (dolist (dsd (dd-slots dd)) + (let* ((accessor-name (dsd-accessor-name dsd)) + (dsd-type (dsd-type dsd))) + (when accessor-name + (multiple-value-bind (reader-designator writer-designator) + (accessor-inline-expansion-designators dd dsd) + (sb!xc:proclaim `(ftype (function (,dd-name) ,dsd-type) + ,accessor-name)) + (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))) + (sb!xc:proclaim + `(ftype (function (,dsd-type ,dd-name) ,dsd-type) + ,setf-accessor-name)) + (setf (info :function + :inline-expansion-designator + setf-accessor-name) + writer-designator + (info :function :inlinep setf-accessor-name) + :inline)))))))) - (setf (info :type :compiler-layout (dd-name info)) layout)) (values)) - -;;; This function does the (COMPILE LOAD EVAL) time actions for updating the -;;; compiler's global meta-information to represent the definition of the -;;; structure described by Info. This primarily amounts to setting up info -;;; about the accessor and other implicitly defined functions. The constructors -;;; are explicitly defined by top-level code. -(defun %%compiler-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 ((pred (dd-predicate info))) - (when pred - (proclaim-as-defstruct-function-name pred) - (setf (info :function :inlinep pred) :inline) - (setf (info :function :inline-expansion pred) - `(lambda (x) (typep x ',name))))) - |# - - (dolist (slot (dd-slots info)) - (let* ((fun (dsd-accessor 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)))))) - - (values)) - -;;; Ordinarily this is preempted by an IR1 transformation, but this -;;; definition is still useful for the interpreter and code walkers. -(defun %compiler-defstruct (info) - (%%compiler-defstruct info)) ;;;; redefinition stuff @@ -1085,13 +1094,13 @@ (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 info)) + (undefine-fun-name (dd-copier-name info)) + (undefine-fun-name (dd-predicate-name info)) (dolist (slot (dd-slots info)) - (let ((fun (dsd-accessor slot))) - (undefine-function-name fun) + (let ((fun (dsd-accessor-name slot))) + (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))) @@ -1122,9 +1131,9 @@ ;;;; 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) @@ -1163,7 +1172,7 @@ (t (dsd-index slot))) (cond - ((eq rtype 't) object) + ((eq rtype t) object) (data) (t `(truly-the (simple-array (unsigned-byte 32) (*)) @@ -1231,10 +1240,10 @@ (%delayed-get-compiler-layout ,(dd-name defstruct))) ,@(when n-raw-data `((setf (%instance-ref ,temp ,raw-index) ,n-raw-data))) - ,@(mapcar #'(lambda (dsd value) - (multiple-value-bind (accessor index data) - (slot-accessor-form defstruct dsd temp n-raw-data) - `(setf (,accessor ,data ,index) ,value))) + ,@(mapcar (lambda (dsd value) + (multiple-value-bind (accessor index data) + (slot-accessor-form defstruct dsd temp n-raw-data) + `(setf (,accessor ,data ,index) ,value))) (dd-slots defstruct) values) ,temp)))) @@ -1264,15 +1273,14 @@ (dolist (slot (dd-slots defstruct)) (let ((dum (gensym)) (name (dsd-name slot))) - (arglist `((,(intern (string name) "KEYWORD") ,dum) - ,(dsd-default slot))) + (arglist `((,(keywordicate name) ,dum) ,(dsd-default slot))) (types (dsd-type slot)) (vals dum))) (funcall creator defstruct (dd-default-constructor defstruct) (arglist) (vals) (types) (vals)))) -;;; Given a structure and a BOA constructor spec, call Creator with +;;; Given a structure and a BOA constructor spec, call CREATOR with ;;; the appropriate args to make a constructor. (defun create-boa-constructor (defstruct boa creator) (multiple-value-bind (req opt restp rest keyp keys allowp aux) @@ -1373,7 +1381,7 @@ (return-from constructor-definitions ())) (unless (or defaults boas) - (push (concat-pnames 'make- (dd-name defstruct)) defaults)) + (push (symbolicate "MAKE-" (dd-name defstruct)) defaults)) (collect ((res)) (when defaults @@ -1389,23 +1397,6 @@ (res)))) -;;;; compiler stuff - -;;; Like PROCLAIM-AS-FUNCTION-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) - (when name - (when (info :function :accessor-for name) - (setf (info :function :accessor-for name) nil)) - (proclaim-as-function-name name) - (note-name-defined name :function) - (setf (info :function :where-from name) :declared) - (when (info :function :assumed-type name) - (setf (info :function :assumed-type name) nil))) - (values)) - ;;;; finalizing bootstrapping ;;; early structure placeholder definitions: Set up layout and class @@ -1413,8 +1404,10 @@ (dolist (args '#.(sb-cold:read-from-file "src/code/early-defstruct-args.lisp-expr")) - (let* ((defstruct (parse-name-and-options-and-slot-descriptions - (first args) - (rest args))) - (inherits (inherits-for-structure defstruct))) - (function-%compiler-only-defstruct defstruct inherits))) + (let* ((dd (parse-defstruct-name-and-options-and-slot-descriptions + (first args) + (rest args))) + (inherits (inherits-for-structure dd))) + (%compiler-defstruct dd inherits))) + +(/show0 "code/defstruct.lisp end of file")