\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)))
(t res))))
;;; Delay looking for compiler-layout until the constructor is being
-;;; compiled, since it doesn't exist until after the eval-when
-;;; (compile) is compiled.
+;;; compiled, since it doesn't exist until after the EVAL-WHEN
+;;; (COMPILE) stuff is compiled. (Or, in the oddball case when
+;;; DEFSTRUCT is executing in a non-toplevel context, the
+;;; compiler-layout still doesn't exist at compilation time, and we
+;;; delay still further.)
(sb!xc:defmacro %delayed-get-compiler-layout (name)
- `',(compiler-layout-or-lose name))
+ (let ((layout (info :type :compiler-layout name)))
+ (cond (layout
+ ;; ordinary case: When the DEFSTRUCT is at top level,
+ ;; then EVAL-WHEN (COMPILE) stuff will have set up the
+ ;; layout for us to use.
+ (unless (typep (layout-info layout) 'defstruct-description)
+ (error "Class is not a structure class: ~S" name))
+ `,layout)
+ (t
+ ;; KLUDGE: In the case that DEFSTRUCT is not at top-level
+ ;; the layout doesn't exist at compile time. In that case
+ ;; we laboriously look it up at run time. This code will
+ ;; run on every constructor call and will likely be quite
+ ;; slow, so if anyone cares about performance of
+ ;; non-toplevel DEFSTRUCTs, it should be rewritten to be
+ ;; cleverer. -- WHN 2002-10-23
+ (sb!c::compiler-note
+ "implementation limitation: ~
+ Non-toplevel DEFSTRUCT constructors are slow.")
+ (let ((layout (gensym "LAYOUT")))
+ `(let ((,layout (info :type :compiler-layout ',name)))
+ (unless (typep (layout-info ,layout) 'defstruct-description)
+ (error "Class is not a structure class: ~S" ',name))
+ ,layout))))))
;;; Get layout right away.
(sb!xc:defmacro compile-time-find-layout (name)
;;; FIXME: Do we really need both? If so, their names and implementations
;;; should probably be tweaked to be more parallel.
\f
-;;; The DEFSTRUCT-DESCRIPTION structure holds compile-time information about a
-;;; structure type.
+;;;; DEFSTRUCT-DESCRIPTION
+
+;;; The DEFSTRUCT-DESCRIPTION structure holds compile-time information
+;;; about a structure type.
(def!struct (defstruct-description
(:conc-name dd-)
(:make-load-form-fun just-dump-it-normally)
#-sb-xc-host (:pure t)
- (:constructor make-defstruct-description (name)))
+ (:constructor make-defstruct-description
+ (name &aux
+ (conc-name (symbolicate name "-"))
+ (copier-name (symbolicate "COPY-" name))
+ (predicate-name (symbolicate name "-P")))))
;; name of the structure
- (name (required-argument) :type symbol)
+ (name (missing-arg) :type symbol :read-only t)
;; documentation on the structure
(doc nil :type (or string null))
;; prefix for slot names. If NIL, none.
- (conc-name (symbolicate name "-") :type (or symbol null))
+ (conc-name nil :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 (symbolicate "COPY-" name) :type (or symbol null))
+ (copier-name nil :type (or symbol null))
;; name of type predicate
- (predicate (symbolicate name "-P") :type (or symbol null))
+ (predicate-name nil :type (or symbol null))
;; the arguments to the :INCLUDE option, or NIL if no included
;; structure
(include nil :type list)
- ;; The arguments to the :ALTERNATE-METACLASS option (an extension
- ;; used to define structure-like objects with an arbitrary
- ;; superclass and that may not have STRUCTURE-CLASS as the
- ;; metaclass.) Syntax is:
+ ;; properties used to define structure-like classes with an
+ ;; arbitrary superclass and that may not have STRUCTURE-CLASS as the
+ ;; metaclass. Syntax is:
;; (superclass-name metaclass-name metaclass-constructor)
(alternate-metaclass nil :type list)
;; a list of DEFSTRUCT-SLOT-DESCRIPTION objects for all slots
;; (including included ones)
(slots () :type list)
+ ;; a list of (NAME . INDEX) pairs for accessors of included structures
+ (inherited-accessor-alist () :type list)
;; number of elements we've allocated (See also RAW-LENGTH.)
(length 0 :type index)
;; General kind of implementation.
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
;; 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 (dd-name x) stream)))
+;;; Does DD describe a structure with a class?
+(defun dd-class-p (dd)
+ (member (dd-type dd)
+ '(structure funcallable-structure)))
+
+;;; a type name which can be used when declaring things which operate
+;;; on structure instances
+(defun dd-declarable-type (dd)
+ (if (dd-class-p dd)
+ ;; Native classes are known to the type system, and we can
+ ;; declare them as types.
+ (dd-name dd)
+ ;; Structures layered on :TYPE LIST or :TYPE VECTOR aren't part
+ ;; of the type system, so all we can declare is the underlying
+ ;; LIST or VECTOR type.
+ (dd-type dd)))
+
+(defun dd-layout-or-lose (dd)
+ (compiler-layout-or-lose (dd-name dd)))
+\f
+;;;; DEFSTRUCT-SLOT-DESCRIPTION
+
;;; A DEFSTRUCT-SLOT-DESCRIPTION holds compile-time information about
;;; a structure slot.
(def!struct (defstruct-slot-description
;; string name of slot
%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)
+ (index (missing-arg) :type fixnum)
+ ;; 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.
(print-unreadable-object (x stream :type t)
(prin1 (dsd-name x) stream)))
-;;; Is DEFSTRUCT a structure with a class?
-(defun class-structure-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))
+ (if (dsd-accessor-name dsd)
+ (symbol-package (dsd-accessor-name dsd))
(sane-package))))
\f
;;;; typed (non-class) structures
(list 'list)
(vector `(simple-array ,(dd-element-type defstruct) (*)))))
\f
+;;;; shared machinery for inline and out-of-line slot accessor functions
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+
+ ;; information about how a slot of a given DSD-RAW-TYPE is to be accessed
+ (defstruct raw-slot-data
+ ;; the raw slot type, or T for a non-raw slot
+ ;;
+ ;; (Raw slots are allocated in the raw slots array in a vector which
+ ;; the GC doesn't need to scavenge. Non-raw slots are in the
+ ;; ordinary place you'd expect, directly indexed off the instance
+ ;; pointer.)
+ (raw-type (missing-arg) :type (or symbol cons) :read-only t)
+ ;; What operator is used (on the raw data vector) to access a slot
+ ;; of this type?
+ (accessor-name (missing-arg) :type symbol :read-only t)
+ ;; How many words are each value of this type? (This is used to
+ ;; rescale the offset into the raw data vector.)
+ (n-words (missing-arg) :type (and index (integer 1)) :read-only t))
+
+ (defvar *raw-slot-data-list*
+ (list
+ ;; The compiler thinks that the raw data vector is a vector of
+ ;; word-sized 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, just let it use normal AREF.
+ (make-raw-slot-data :raw-type 'unsigned-byte
+ :accessor-name 'aref
+ :n-words 1)
+ ;; In the other cases, we lie to the compiler, making it use
+ ;; some low-level AREFish access in order to pun the hapless
+ ;; bits into some other-than-unsigned-byte meaning.
+ ;;
+ ;; "A lie can travel halfway round the world while the truth is
+ ;; putting on its shoes." -- Mark Twain
+ (make-raw-slot-data :raw-type 'single-float
+ :accessor-name '%raw-ref-single
+ :n-words 1)
+ (make-raw-slot-data :raw-type 'double-float
+ :accessor-name '%raw-ref-double
+ :n-words 2)
+ (make-raw-slot-data :raw-type 'complex-single-float
+ :accessor-name '%raw-ref-complex-single
+ :n-words 2)
+ (make-raw-slot-data :raw-type 'complex-double-float
+ :accessor-name '%raw-ref-complex-double
+ :n-words 4)
+ #!+long-float
+ (make-raw-slot-data :raw-type long-float
+ :accessor-name '%raw-ref-long
+ :n-words #!+x86 3 #!+sparc 4)
+ #!+long-float
+ (make-raw-slot-data :raw-type complex-long-float
+ :accessor-name '%raw-ref-complex-long
+ :n-words #!+x86 6 #!+sparc 8))))
+\f
;;;; the legendary DEFSTRUCT macro itself (both CL:DEFSTRUCT and its
;;;; close personal friend SB!XC:DEFSTRUCT)
(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*))))
+ (funcall #',(farg pf)
+ ,x
+ ,s
+ *current-level-in-print*))))
((not (eql po 0))
`((def!method print-object ((,x ,name) ,s)
(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)))
,@(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))))))))
;;; 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
- (/noshow0 "doing CLASS-STRUCTURE-P case for DEFSTRUCT " ,name)
- (eval-when (:compile-toplevel :load-toplevel :execute)
- (%compiler-only-defstruct ',dd ',inherits))
+ ;; Note we intentionally call %DEFSTRUCT first, and
+ ;; especially before %COMPILER-DEFSTRUCT. %DEFSTRUCT
+ ;; has the tests (and resulting CERROR) for collisions
+ ;; with LAYOUTs which already exist in the runtime. If
+ ;; there are any collisions, we want the user's
+ ;; response to CERROR to control what happens.
+ ;; Especially, if the user responds to the collision
+ ;; with ABORT, we don't want %COMPILER-DEFSTRUCT to
+ ;; modify the definition of the class.
(%defstruct ',dd ',inherits)
- ,@(when (eq (dd-type dd) 'structure)
- `((%compiler-defstruct ',dd)))
- (/noshow0 "starting not-for-the-xc-host section in DEFSTRUCT")
+ (eval-when (:compile-toplevel :load-toplevel :execute)
+ (%compiler-defstruct ',dd ',inherits))
,@(unless expanding-into-code-for-xc-host-p
- (append (raw-accessor-definitions dd)
- (predicate-definitions dd)
- ;; FIXME: We've inherited from CMU CL nonparallel
+ (append ;; FIXME: We've inherited from CMU CL nonparallel
;; code for creating copiers for typed and untyped
;; structures. This should be fixed.
- ;(copier-definition dd)
+ ;(copier-definition dd)
(constructor-definitions dd)
(class-method-definitions dd)))
- (/noshow0 "done with DEFSTRUCT " ,name)
',name))
`(progn
- (/show0 "doing NOT CLASS-STRUCTURE-P case for DEFSTRUCT " ,name)
(eval-when (:compile-toplevel :load-toplevel :execute)
(setf (info :typed-structure :info ',name) ',dd))
,@(unless expanding-into-code-for-xc-host-p
(typed-predicate-definitions dd)
(typed-copier-definitions dd)
(constructor-definitions dd)))
- (/noshow0 "done with DEFSTRUCT " ,name)
',name)))))
(sb!xc:defmacro defstruct (name-and-options &rest slot-descriptions)
: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))
\f
-;;;; 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
-(eval-when (:compile-toplevel :load-toplevel :execute)
- (defun protect-cl (symbol)
- (when (and *cold-init-complete-p*
- (eq (symbol-package symbol) *cl-package*))
- (cerror "Go ahead and patch the system."
- "attempting to modify a symbol in the COMMON-LISP package: ~S"
- symbol))))
-
-;;; Return forms to define readers and writers for raw slots as inline
-;;; functions.
-(defun raw-accessor-definitions (dd)
- (let* ((name (dd-name dd)))
- (collect ((res))
- (dolist (slot (dd-slots dd))
- (let ((stype (dsd-type slot))
- (accname (dsd-accessor 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))))
- (unless (dsd-read-only slot)
- (res `(declaim (inline (setf ,accname))))
- (res `(declaim (ftype (function (,stype ,name) ,stype)
- (setf ,accname))))
- ;; 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)
- (setf (,accessor ,data ,offset) ,nvname)
- ,nvname)))))))
- (res))))
+;;; First, a helper to determine whether a name names an inherited
+;;; accessor.
+(defun accessor-inherited-data (name defstruct)
+ (assoc name (dd-inherited-accessor-alist defstruct) :test #'eq))
-;;; Return a list of forms which create a predicate for an untyped DEFSTRUCT.
-(defun predicate-definitions (dd)
- (let ((pred (dd-predicate dd))
- (argname (gensym)))
- (when pred
- (if (eq (dd-type dd) 'funcallable-structure)
- ;; FIXME: Why does this need to be special-cased for
- ;; FUNCALLABLE-STRUCTURE? CMU CL did it, but without explanation.
- ;; Could we do without it? What breaks if we do? Or could we
- ;; perhaps get by with no predicates for funcallable structures?
- `((declaim (inline ,pred))
- (defun ,pred (,argname) (typep ,argname ',(dd-name dd))))
- `((protect-cl ',pred)
- (declaim (inline ,pred))
- (defun ,pred (,argname)
- (declare (optimize (speed 3) (safety 0)))
- (typep-to-layout ,argname
- (compile-time-find-layout ,(dd-name dd)))))))))
-
-;;; Return a list of forms which create a predicate function for a typed
-;;; DEFSTRUCT.
+;;; Return a list of forms which create a predicate function for a
+;;; typed 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)))))
',name))))))))
-;;; FIXME: We've inherited from CMU CL code to do typed structure copiers
-;;; in a completely different way than untyped structure copiers. Fix this.
-;;; (This function was my first attempt to fix this, but I stopped before
-;;; figuring out how to install it completely and remove the parallel
-;;; code which simply SETF's the FDEFINITION of the DD-COPIER name.
-#|
-;;; Return the copier definition for an untyped DEFSTRUCT.
-(defun copier-definition (dd)
- (when (and (dd-copier dd)
- ;; FUNCALLABLE-STRUCTUREs don't need copiers, and this
- ;; implementation wouldn't work for them anyway, since
- ;; COPY-STRUCTURE returns a STRUCTURE-OBJECT and they're not.
- (not (eq (dd-type info) 'funcallable-structure)))
- (let ((argname (gensym)))
- `(progn
- (protect-cl ',(dd-copier dd))
- (defun ,(dd-copier dd) (,argname)
- (declare (type ,(dd-name dd) ,argname))
- (copy-structure ,argname))))))
-|#
-
;;; 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))))))
-
-;;; Return a list of function definitions for accessing and setting the
-;;; slots of a typed DEFSTRUCT. The functions are proclaimed to be inline,
-;;; and the types of their arguments and results are declared as well. We
-;;; count on the compiler to do clever things with ELT.
+ (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, and the types of their arguments and results are declared
+;;; as well. We count on the compiler to do clever things with ELT.
(defun typed-accessor-definitions (defstruct)
(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))))
- (stuff `(proclaim '(inline ,name (setf ,name))))
- ;; FIXME: The arguments in the next two DEFUNs should be
- ;; gensyms. (Otherwise e.g. if NEW-VALUE happened to be the
- ;; name of a special variable, things could get weird.)
- (stuff `(defun ,name (structure)
- (declare (type ,ltype structure))
- (the ,slot-type (elt structure ,index))))
- (unless (dsd-read-only slot)
- (stuff
- `(defun (setf ,name) (new-value structure)
- (declare (type ,ltype structure) (type ,slot-type new-value))
- (setf (elt structure ,index) new-value)))))))
+ (let ((inherited (accessor-inherited-data name defstruct)))
+ (cond
+ ((not inherited)
+ (stuff `(proclaim '(inline ,name (setf ,name))))
+ ;; FIXME: The arguments in the next two DEFUNs should
+ ;; be gensyms. (Otherwise e.g. if NEW-VALUE happened to
+ ;; be the name of a special variable, things could get
+ ;; weird.)
+ (stuff `(defun ,name (structure)
+ (declare (type ,ltype structure))
+ (the ,slot-type (elt structure ,index))))
+ (unless (dsd-read-only slot)
+ (stuff
+ `(defun (setf ,name) (new-value structure)
+ (declare (type ,ltype structure) (type ,slot-type new-value))
+ (setf (elt structure ,index) new-value)))))
+ ((not (= (cdr inherited) index))
+ (style-warn "~@<Non-overwritten accessor ~S does not access ~
+ slot with name ~S (accessing an inherited slot ~
+ instead).~:@>" name (dsd-%name slot))))))))
(stuff)))
\f
;;;; parsing
(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)
+ (destructuring-bind (&optional conc-name) args
+ (setf (dd-conc-name dd)
(if (symbolp conc-name)
conc-name
(make-symbol (string conc-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 (symbolicate "COPY-" name)))
args
- (setf (dd-copier defstruct) copier)))
+ (setf (dd-copier-name dd) copier)))
(:predicate
- (destructuring-bind (&optional (pred (symbolicate 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))
- (:alternate-metaclass
- (setf (dd-alternate-metaclass defstruct) args))
+ (setf (dd-include 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))
- ((member type '(list vector))
- (setf (dd-element-type defstruct) 't)
- (setf (dd-type defstruct) type))
+ (cond ((member type '(list vector))
+ (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
(aver name) ; A null name doesn't seem to make sense here.
- (let ((defstruct (make-defstruct-description name)))
+ (let ((dd (make-defstruct-description name)))
(dolist (option options)
- (cond ((consp option)
- (parse-1-option option defstruct))
- ((eq option :named)
- (setf (dd-named defstruct) t))
- ((member option '(:constructor :copier :predicate :named))
- (parse-1-option (list option) defstruct))
+ (cond ((eq option :named)
+ (setf (dd-named dd) t))
+ ((consp option)
+ (parse-1-dd-option option dd))
+ ((member option '(:conc-name :constructor :copier :predicate))
+ (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))))
- (funcallable-structure)
+ (unless (dd-include dd)
+ ;; FIXME: It'd be cleaner to treat no-:INCLUDE as defaulting
+ ;; to :INCLUDE STRUCTURE-OBJECT, and then let the general-case
+ ;; (INCF (DD-LENGTH DD) (DD-LENGTH included-DD)) logic take
+ ;; care of this. (Except that the :TYPE VECTOR and :TYPE
+ ;; LIST cases, with their :NAMED and un-:NAMED flavors,
+ ;; make that messy, alas.)
+ (incf (dd-length dd))))
(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)
+ (frob-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
\f
;;;; 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)
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 '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 (symbolicate (or (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
+ "~@<The structure accessor name ~S is the same as the name of the ~
+ structure type predicate. ANSI doesn't specify what to do in ~
+ this case. We'll overwrite the type predicate with the slot ~
+ accessor, but you can't rely on this behavior, so it'd be wise to ~
+ remove the ambiguity in your code.~@:>"
+ accessor-name)
+ (setf (dd-predicate-name defstruct) nil))
+ #-sb-xc-host
+ (when (and (fboundp accessor-name)
+ (not (accessor-inherited-data accessor-name defstruct)))
+ (style-warn "redefining ~S in DEFSTRUCT" accessor-name)))
(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
;;; RAW? is true if TYPE should be stored in a raw slot.
;;; RAW-TYPE is the raw slot type, or NIL if no raw slot.
;;; WORDS is the number of words in the raw slot, or NIL if no raw slot.
+;;;
+;;; FIXME: This should use the data in *RAW-SLOT-DATA-LIST*.
(defun structure-raw-slot-type-and-size (type)
- (/noshow "in STRUCTURE-RAW-SLOT-TYPE-AND-SIZE" type (sb!xc:subtypep type 'fixnum))
(cond #+nil
(;; FIXME: For now we suppress raw slots, since there are various
;; issues about the way that the cross-compiler handles them.
((and (sb!xc:subtypep type '(unsigned-byte 32))
(multiple-value-bind (fixnum? fixnum-certain?)
(sb!xc:subtypep type 'fixnum)
- (/noshow fixnum? fixnum-certain?)
;; (The extra test for FIXNUM-CERTAIN? here is
;; intended for bootstrapping the system. In
;; particular, in sbcl-0.6.2, we set up LAYOUT before
(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)
;;; 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 frob-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))))
+
+ ;; checks on legality
(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))
-
- (incf (dd-length defstruct) (dd-length included-structure))
- (when (class-structure-p defstruct)
+ (specifier-type (dd-element-type dd))))
+ (error ":TYPE option mismatch between structures ~S and ~S"
+ (dd-name dd) included-name))
+ (let ((included-class (sb!xc:find-class included-name nil)))
+ (when included-class
+ ;; It's not particularly well-defined to :INCLUDE any of the
+ ;; CMU CL INSTANCE weirdosities like CONDITION or
+ ;; GENERIC-FUNCTION, and it's certainly not ANSI-compliant.
+ (let* ((included-layout (class-layout included-class))
+ (included-dd (layout-info included-layout)))
+ (when (and (dd-alternate-metaclass included-dd)
+ ;; As of sbcl-0.pre7.73, anyway, STRUCTURE-OBJECT
+ ;; is represented with an ALTERNATE-METACLASS. But
+ ;; it's specifically OK to :INCLUDE (and PCL does)
+ ;; so in this one case, it's OK to include
+ ;; something with :ALTERNATE-METACLASS after all.
+ (not (eql included-name 'structure-object)))
+ (error "can't :INCLUDE class ~S (has alternate metaclass)"
+ included-name)))))
+
+ (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
- :key #'(lambda (x) (if (atom x) x (car x)))
+ (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)))
+
+ (setf (dd-inherited-accessor-alist dd)
+ (dd-inherited-accessor-alist 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))))
+ ;; We stash away an alist of accessors to parents' slots
+ ;; that have already been created to avoid conflicts later
+ ;; so that structures with :INCLUDE and :CONC-NAME (and
+ ;; other edge cases) can work as specified.
+ (when (dsd-accessor-name included-slot)
+ ;; the "oldest" (i.e. highest up the tree of inheritance)
+ ;; will prevail, so don't push new ones on if they
+ ;; conflict.
+ (pushnew (cons (dsd-accessor-name included-slot)
+ (dsd-index included-slot))
+ (dd-inherited-accessor-alist dd)
+ :test #'eq :key #'car))
+ (parse-1-dsd dd
+ modified
+ (copy-structure included-slot)))))))
\f
+;;;; 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)
(class-layout (sb!xc:find-class
(or (first superclass-opt)
'structure-object))))))
- (if (eq (dd-name info) 'lisp-stream)
- ;; a hack to added the stream class as a mixin for LISP-STREAMs
+ (if (eq (dd-name info) 'ansi-stream)
+ ;; a hack to add the CL:STREAM class as a mixin for ANSI-STREAMs
(concatenate 'simple-vector
(layout-inherits super)
(vector super
(vector super)))))
;;; Do miscellaneous (LOAD EVAL) time actions for the structure
-;;; described by INFO. Create the class & layout, checking for
-;;; incompatible redefinition. Define setters, accessors, copier,
-;;; predicate, documentation, instantiate definition in load-time env.
-;;; This is only called for default structures.
-(defun %defstruct (info inherits)
- (declare (type defstruct-description info))
+;;; described by DD. Create the class and LAYOUT, checking for
+;;; incompatible redefinition. Define those functions which are
+;;; sufficiently stereotyped that we can implement them as standard
+;;; closures.
+(defun %defstruct (dd inherits)
+ (declare (type defstruct-description dd))
+
+ ;; We set up LAYOUTs even in the cross-compilation host.
(multiple-value-bind (class layout old-layout)
- (ensure-structure-class info inherits "current" "new")
+ (ensure-structure-class dd inherits "current" "new")
(cond ((not old-layout)
(unless (eq (class-layout class) layout)
(register-layout layout)))
(t
- (let ((old-info (layout-info old-layout)))
- (when (defstruct-description-p old-info)
- (dolist (slot (dd-slots old-info))
- (fmakunbound (dsd-accessor slot))
+ (let ((old-dd (layout-info old-layout)))
+ (when (defstruct-description-p old-dd)
+ (dolist (slot (dd-slots old-dd))
+ (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))))
+ (setf (sb!xc:find-class (dd-name dd)) class)
- (setf (sb!xc:find-class (dd-name info)) class)
-
- ;; Set FDEFINITIONs for structure accessors, setters, predicates,
- ;; and copiers.
+ ;; Various other operations only make sense on the target SBCL.
#-sb-xc-host
- (unless (eq (dd-type info) 'funcallable-structure)
-
- (dolist (slot (dd-slots info))
- (let ((dsd slot))
- (when (and (dsd-accessor slot)
- (eq (dsd-raw-type slot) t))
- (protect-cl (dsd-accessor slot))
- (setf (symbol-function (dsd-accessor slot))
- (structure-slot-getter layout dsd))
- (unless (dsd-read-only slot)
- (setf (fdefinition `(setf ,(dsd-accessor slot)))
- (structure-slot-setter layout dsd))))))
-
- ;; FIXME: See comment on corresponding code in %%COMPILER-DEFSTRUCT.
- #|
- (when (dd-predicate info)
- (protect-cl (dd-predicate info))
- (setf (symbol-function (dd-predicate info))
- #'(lambda (object)
- (declare (optimize (speed 3) (safety 0)))
- (typep-to-layout object layout))))
- |#
-
- (when (dd-copier info)
- (protect-cl (dd-copier info))
- (setf (symbol-function (dd-copier info))
- #'(lambda (structure)
- (declare (optimize (speed 3) (safety 0)))
- (flet ((layout-test (structure)
- (typep-to-layout structure layout)))
- (unless (layout-test structure)
- (error 'simple-type-error
- :datum structure
- :expected-type '(satisfies layout-test)
- :format-control
- "Structure for copier is not a ~S:~% ~S"
- :format-arguments
- (list (sb!xc:class-name (layout-class layout))
- structure))))
- (copy-structure structure))))))
-
- (when (dd-doc info)
- (setf (fdocumentation (dd-name info) 'type) (dd-doc info)))
+ (%target-defstruct dd layout))
(values))
+\f
+;;; 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)
+ (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* ((raw-slot-data (find raw-type *raw-slot-data-list*
+ :key #'raw-slot-data-raw-type
+ :test #'equal))
+ (raw-slot-accessor (raw-slot-data-accessor-name raw-slot-data))
+ (raw-n-words (raw-slot-data-n-words raw-slot-data)))
+ (multiple-value-bind (scaled-dsd-index misalignment)
+ (floor (dsd-index dsd) raw-n-words)
+ (aver (zerop misalignment))
+ `(,raw-slot-accessor (,ref ,instance-name ,(dd-raw-index dd))
+ ,scaled-dsd-index))))))
+
+;;; Return inline expansion designators (i.e. values suitable for
+;;; (INFO :FUNCTION :INLINE-EXPANSION-DESIGNATOR ..)) for the reader
+;;; and writer functions of the slot described by DSD.
+(defun slot-accessor-inline-expansion-designators (dd dsd)
+ (let ((instance-type-decl `(declare (type ,(dd-name dd) instance)))
+ (accessor-place-form (%accessor-place-form dd dsd 'instance))
+ (dsd-type (dsd-type dsd)))
+ (values (lambda ()
+ `(lambda (instance)
+ ,instance-type-decl
+ (truly-the ,dsd-type ,accessor-place-form)))
+ (lambda ()
+ `(lambda (new-value instance)
+ (declare (type ,dsd-type new-value))
+ ,instance-type-decl
+ (setf ,accessor-place-form new-value))))))
+
+;;; Return a LAMBDA form which can be used to set a slot.
+(defun slot-setter-lambda-form (dd dsd)
+ (funcall (nth-value 1
+ (slot-accessor-inline-expansion-designators dd dsd))))
+
+;;; core compile-time setup of any class with a LAYOUT, used even by
+;;; !DEFSTRUCT-WITH-ALTERNATE-METACLASS weirdosities
+(defun %compiler-set-up-layout (dd
+ &optional
+ ;; Several special cases (STRUCTURE-OBJECT
+ ;; itself, and structures with alternate
+ ;; metaclasses) call this function directly,
+ ;; and they're all at the base of the
+ ;; instance class structure, so this is
+ ;; a handy default.
+ (inherits (vector (find-layout t)
+ (find-layout 'instance))))
-;;; 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)
(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 (sb!xc:find-class (dd-name dd)) class)))
- (setf (info :type :compiler-layout (dd-name info)) layout))
- (values))
+ ;; At this point the class should be set up in the INFO database.
+ ;; But the logic that enforces this is a little tangled and
+ ;; scattered, so it's not obvious, so let's check.
+ (aver (sb!xc:find-class (dd-name dd) nil))
-;;; 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))))))
+ (setf (info :type :compiler-layout (dd-name dd)) layout))
(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))
+;;; Do (COMPILE LOAD EVAL)-time actions for the normal (not
+;;; ALTERNATE-LAYOUT) DEFSTRUCT described by DD.
+(defun %compiler-defstruct (dd inherits)
+ (declare (type defstruct-description dd))
+
+ (%compiler-set-up-layout dd inherits)
+
+ (let* ((dtype (dd-declarable-type dd)))
+
+ (let ((copier-name (dd-copier-name dd)))
+ (when copier-name
+ (sb!xc:proclaim `(ftype (function (,dtype) ,dtype) ,copier-name))))
+
+ (let ((predicate-name (dd-predicate-name dd)))
+ (when predicate-name
+ (sb!xc:proclaim `(ftype (function (t) t) ,predicate-name))
+ ;; Provide inline expansion (or not).
+ (ecase (dd-type dd)
+ ((structure funcallable-structure)
+ ;; Let the predicate be inlined.
+ (setf (info :function :inline-expansion-designator predicate-name)
+ (lambda ()
+ `(lambda (x)
+ ;; This dead simple definition works because the
+ ;; type system knows how to generate inline type
+ ;; tests for instances.
+ (typep x ',(dd-name dd))))
+ (info :function :inlinep predicate-name)
+ :inline))
+ ((list vector)
+ ;; Just punt. We could provide inline expansions for :TYPE
+ ;; LIST and :TYPE VECTOR predicates too, but it'd be a
+ ;; little messier and we don't bother. (Does anyway use
+ ;; typed DEFSTRUCTs at all, let alone for high
+ ;; performance?)
+ ))))
+
+ (dolist (dsd (dd-slots dd))
+ (let* ((accessor-name (dsd-accessor-name dsd))
+ (dsd-type (dsd-type dsd)))
+ (when accessor-name
+ (let ((inherited (accessor-inherited-data accessor-name dd)))
+ (cond
+ ((not inherited)
+ (multiple-value-bind (reader-designator writer-designator)
+ (slot-accessor-inline-expansion-designators dd dsd)
+ (sb!xc:proclaim `(ftype (function (,dtype) ,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 ,dtype) ,dsd-type)
+ ,setf-accessor-name))
+ (setf (info :function
+ :inline-expansion-designator
+ setf-accessor-name)
+ writer-designator
+ (info :function :inlinep setf-accessor-name)
+ :inline)))))
+ ((not (= (cdr inherited) (dsd-index dsd)))
+ (style-warn "~@<Non-overwritten accessor ~S does not access ~
+ slot with name ~S (accessing an inherited slot ~
+ instead).~:@>"
+ accessor-name
+ (dsd-%name dsd)))))))))
+ (values))
\f
;;;; redefinition stuff
(let ((os (find name oslots :key #'dsd-name))
(ns (find name nslots :key #'dsd-name)))
(unless (subtypep (dsd-type ns) (dsd-type os))
- (/noshow "found retyped slots" ns os (dsd-type ns) (dsd-type os))
(retyped name))
(unless (and (= (dsd-index os) (dsd-index ns))
(eq (dsd-raw-type os) (dsd-raw-type ns)))
t))))
;;; This function is called when we are incompatibly redefining a
-;;; structure Class to have the specified New-Layout. We signal an
+;;; structure CLASS to have the specified NEW-LAYOUT. We signal an
;;; error with some proceed options and return the layout that should
;;; be used.
(defun %redefine-defstruct (class old-layout new-layout)
(declare (type sb!xc:class class) (type layout old-layout new-layout))
(let ((name (class-proper-name class)))
(restart-case
- (error "redefining class ~S incompatibly with the current definition"
+ (error "~@<attempt to redefine the ~S class ~S incompatibly with the current definition~:@>"
+ 'structure-object
name)
(continue ()
- :report "Invalidate current definition."
- (warn "Previously loaded ~S accessors will no longer work." name)
- (register-layout new-layout))
+ :report (lambda (s)
+ (format s
+ "~@<Use the new definition of ~S, invalidating ~
+ already-loaded code and instances.~@:>"
+ name))
+ (register-layout new-layout))
+ (recklessly-continue ()
+ :report (lambda (s)
+ (format s
+ "~@<Use the new definition of ~S as if it were ~
+ compatible, allowing old accessors to use new ~
+ instances and allowing new accessors to use old ~
+ instances.~@:>"
+ name))
+ ;; classic CMU CL warning: "Any old ~S instances will be in a bad way.
+ ;; I hope you know what you're doing..."
+ (register-layout new-layout
+ :invalidate nil
+ :destruct-layout old-layout))
(clobber-it ()
- :report "Smash current layout, preserving old code."
- (warn "Any old ~S instances will be in a bad way.~@
- I hope you know what you're doing..."
- name)
- (register-layout new-layout :invalidate nil
- :destruct-layout old-layout))))
+ ;; FIXME: deprecated 2002-10-16, and since it's only interactive
+ ;; hackery instead of a supported feature, can probably be deleted
+ ;; in early 2003
+ :report "(deprecated synonym for RECKLESSLY-CONTINUE)"
+ (register-layout new-layout
+ :invalidate nil
+ :destruct-layout old-layout))))
(values))
;;; This is called when we are about to define a structure class. It
(sb!xc:typep x (sb!xc:find-class class))))
(fdefinition constructor)))
(setf (class-direct-superclasses class)
- (if (eq (dd-name info) 'lisp-stream)
- ;; a hack to add STREAM as a superclass mixin to LISP-STREAMs
+ (if (eq (dd-name info) 'ansi-stream)
+ ;; a hack to add CL:STREAM as a superclass mixin to ANSI-STREAMs
(list (layout-class (svref inherits (1- (length inherits))))
(layout-class (svref inherits (- (length inherits) 2))))
(list (layout-class (svref inherits (1- (length inherits)))))))
(let ((info (layout-info (class-layout class))))
(when (defstruct-description-p info)
(let ((type (dd-name info)))
+ (remhash type *typecheckfuns*)
(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)
- (unless (dsd-read-only slot)
- (undefine-function-name `(setf ,fun))))))
+ (let ((fun (dsd-accessor-name slot)))
+ (unless (accessor-inherited-data fun info)
+ (undefine-fun-name fun)
+ (unless (dsd-read-only slot)
+ (undefine-fun-name `(setf ,fun)))))))
;; Clear out the SPECIFIER-TYPE cache so that subsequent
;; references are unknown types.
(values-specifier-type-cache-clear)))
(res)))
\f
-;;;; 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.
-;;;
-;;; returned values:
-;;; 1. accessor function name (SETFable)
-;;; 2. index to pass to accessor.
-;;; 3. object form to pass to accessor
-(defun slot-accessor-form (defstruct slot object &optional data)
- (let ((rtype (dsd-raw-type slot)))
- (values
- (ecase rtype
- (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)
- (unsigned-byte 'aref)
- ((t)
- (if (eq (dd-type defstruct) 'funcallable-structure)
- '%funcallable-instance-info
- '%instance-ref)))
- (case rtype
- #!+long-float
- (complex-long-float
- (truncate (dsd-index slot) #!+x86 6 #!+sparc 8))
- #!+long-float
- (long-float
- (truncate (dsd-index slot) #!+x86 3 #!+sparc 4))
- (double-float
- (ash (dsd-index slot) -1))
- (complex-double-float
- (ash (dsd-index slot) -2))
- (complex-single-float
- (ash (dsd-index slot) -1))
- (t
- (dsd-index slot)))
- (cond
- ((eq rtype 't) object)
- (data)
- (t
- `(truly-the (simple-array (unsigned-byte 32) (*))
- (%instance-ref ,object ,(dd-raw-index defstruct))))))))
-\f
;;; These functions are called to actually make a constructor after we
;;; have processed the arglist. The correct variant (according to the
;;; DD-TYPE) should be called. The function is defined with the
-;;; specified name and arglist. Vars and Types are used for argument
-;;; type declarations. Values are the values for the slots (in order.)
+;;; specified name and arglist. VARS and TYPES are used for argument
+;;; type declarations. VALUES are the values for the slots (in order.)
;;;
-;;; This is split four ways because:
-;;; 1] list & vector structures need "name" symbols stuck in at
-;;; various weird places, whereas STRUCTURE structures have
-;;; a LAYOUT slot.
-;;; 2] We really want to use LIST to make list structures, instead of
-;;; MAKE-LIST/(SETF ELT).
-;;; 3] STRUCTURE structures can have raw slots that must also be
-;;; allocated and indirectly referenced. We use SLOT-ACCESSOR-FORM
-;;; to compute how to set the slots, which deals with raw slots.
-;;; 4] Funcallable structures are weird.
-(defun create-vector-constructor
- (defstruct cons-name arglist vars types values)
+;;; This is split three ways because:
+;;; * LIST & VECTOR structures need "name" symbols stuck in at
+;;; various weird places, whereas STRUCTURE structures have
+;;; a LAYOUT slot.
+;;; * We really want to use LIST to make list structures, instead of
+;;; MAKE-LIST/(SETF ELT). (We can't in general use VECTOR in an
+;;; analogous way, since VECTOR makes a SIMPLE-VECTOR and vector-typed
+;;; structures can have arbitrary subtypes of VECTOR, not necessarily
+;;; SIMPLE-VECTOR.)
+;;; * STRUCTURE structures can have raw slots that must also be
+;;; allocated and indirectly referenced.
+(defun create-vector-constructor (dd cons-name arglist vars types values)
(let ((temp (gensym))
- (etype (dd-element-type defstruct)))
+ (etype (dd-element-type dd)))
`(defun ,cons-name ,arglist
- (declare ,@(mapcar #'(lambda (var type) `(type (and ,type ,etype) ,var))
+ (declare ,@(mapcar (lambda (var type) `(type (and ,type ,etype) ,var))
vars types))
- (let ((,temp (make-array ,(dd-length defstruct)
- :element-type ',(dd-element-type defstruct))))
- ,@(mapcar #'(lambda (x)
- `(setf (aref ,temp ,(cdr x)) ',(car x)))
- (find-name-indices defstruct))
- ,@(mapcar #'(lambda (dsd value)
- `(setf (aref ,temp ,(dsd-index dsd)) ,value))
- (dd-slots defstruct) values)
+ (let ((,temp (make-array ,(dd-length dd)
+ :element-type ',(dd-element-type dd))))
+ ,@(mapcar (lambda (x)
+ `(setf (aref ,temp ,(cdr x)) ',(car x)))
+ (find-name-indices dd))
+ ,@(mapcar (lambda (dsd value)
+ `(setf (aref ,temp ,(dsd-index dsd)) ,value))
+ (dd-slots dd) values)
,temp))))
-(defun create-list-constructor
- (defstruct cons-name arglist vars types values)
- (let ((vals (make-list (dd-length defstruct) :initial-element nil)))
- (dolist (x (find-name-indices defstruct))
+(defun create-list-constructor (dd cons-name arglist vars types values)
+ (let ((vals (make-list (dd-length dd) :initial-element nil)))
+ (dolist (x (find-name-indices dd))
(setf (elt vals (cdr x)) `',(car x)))
- (loop for dsd in (dd-slots defstruct) and val in values do
+ (loop for dsd in (dd-slots dd) and val in values do
(setf (elt vals (dsd-index dsd)) val))
`(defun ,cons-name ,arglist
- (declare ,@(mapcar #'(lambda (var type) `(type ,type ,var))
- vars types))
+ (declare ,@(mapcar (lambda (var type) `(type ,type ,var)) vars types))
(list ,@vals))))
-(defun create-structure-constructor
- (defstruct cons-name arglist vars types values)
- (let* ((temp (gensym))
- (raw-index (dd-raw-index defstruct))
- (n-raw-data (when raw-index (gensym))))
+(defun create-structure-constructor (dd cons-name arglist vars types values)
+ (let* ((instance (gensym "INSTANCE"))
+ (raw-index (dd-raw-index dd)))
`(defun ,cons-name ,arglist
- (declare ,@(mapcar #'(lambda (var type) `(type ,type ,var))
+ (declare ,@(mapcar (lambda (var type) `(type ,type ,var))
vars types))
- (let ((,temp (truly-the ,(dd-name defstruct)
- (%make-instance ,(dd-length defstruct))))
- ,@(when n-raw-data
- `((,n-raw-data
- (make-array ,(dd-raw-length defstruct)
- :element-type '(unsigned-byte 32))))))
- (setf (%instance-layout ,temp)
- (%delayed-get-compiler-layout ,(dd-name defstruct)))
- ,@(when n-raw-data
- `((setf (%instance-ref ,temp ,raw-index) ,n-raw-data)))
+ (let ((,instance (truly-the ,(dd-name dd)
+ (%make-instance-with-layout
+ (%delayed-get-compiler-layout ,(dd-name dd))))))
+ ,@(when raw-index
+ `((setf (%instance-ref ,instance ,raw-index)
+ (make-array ,(dd-raw-length dd)
+ :element-type '(unsigned-byte 32)))))
,@(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)
+ ;; (Note that we can't in general use the
+ ;; ordinary named slot setter function here
+ ;; because the slot might be :READ-ONLY, so we
+ ;; whip up new LAMBDA representations of slot
+ ;; setters for the occasion.)
+ `(,(slot-setter-lambda-form dd dsd) ,value ,instance))
+ (dd-slots dd)
values)
- ,temp))))
-(defun create-fin-constructor
- (defstruct cons-name arglist vars types values)
- (let ((temp (gensym)))
- `(defun ,cons-name ,arglist
- (declare ,@(mapcar #'(lambda (var type) `(type ,type ,var))
- vars types))
- (let ((,temp (truly-the
- ,(dd-name defstruct)
- (%make-funcallable-instance
- ,(dd-length defstruct)
- (%delayed-get-compiler-layout ,(dd-name defstruct))))))
- ,@(mapcar #'(lambda (dsd value)
- `(setf (%funcallable-instance-info
- ,temp ,(dsd-index dsd))
- ,value))
- (dd-slots defstruct) values)
- ,temp))))
+ ,instance))))
;;; Create a default (non-BOA) keyword constructor.
(defun create-keyword-constructor (defstruct creator)
(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
;;; 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)
- (sb!kernel:parse-lambda-list (second boa))
+ (multiple-value-bind (req opt restp rest keyp keys allowp auxp aux)
+ (parse-lambda-list (second boa))
(collect ((arglist)
(vars)
(types))
(dolist (arg opt)
(cond ((consp arg)
(destructuring-bind
- (name &optional (def (nth-value 1 (get-slot name))))
+ ;; FIXME: this shares some logic (though not
+ ;; code) with the &key case below (and it
+ ;; looks confusing) -- factor out the logic
+ ;; if possible. - CSR, 2002-04-19
+ (name
+ &optional
+ (def (nth-value 1 (get-slot name)))
+ (supplied-test nil supplied-test-p))
arg
- (arglist `(,name ,def))
+ (arglist `(,name ,def ,@(if supplied-test-p `(,supplied-test) nil)))
(vars name)
(types (get-slot name))))
(t
(arglist '&key)
(dolist (key keys)
(if (consp key)
- (destructuring-bind (wot &optional (def nil def-p)) key
+ (destructuring-bind (wot
+ &optional
+ (def nil def-p)
+ (supplied-test nil supplied-test-p))
+ key
(let ((name (if (consp wot)
(destructuring-bind (key var) wot
(declare (ignore key))
var)
wot)))
- (multiple-value-bind (type slot-def) (get-slot name)
- (arglist `(,wot ,(if def-p def slot-def)))
+ (multiple-value-bind (type slot-def)
+ (get-slot name)
+ (arglist `(,wot ,(if def-p def slot-def)
+ ,@(if supplied-test-p `(,supplied-test) nil)))
(vars name)
(types type))))
(do-default key))))
(when allowp (arglist '&allow-other-keys))
- (when aux
+ (when auxp
(arglist '&aux)
(dolist (arg aux)
(let* ((arg (if (consp arg) arg (list arg)))
(funcall creator defstruct (first boa)
(arglist) (vars) (types)
- (mapcar #'(lambda (slot)
- (or (find (dsd-name slot) (vars) :test #'string=)
- (dsd-default slot)))
+ (mapcar (lambda (slot)
+ (or (find (dsd-name slot) (vars) :test #'string=)
+ (dsd-default slot)))
(dd-slots defstruct))))))
;;; Grovel the constructor options, and decide what constructors (if
(defaults ())
(creator (ecase (dd-type defstruct)
(structure #'create-structure-constructor)
- (funcallable-structure #'create-fin-constructor)
(vector #'create-vector-constructor)
(list #'create-list-constructor))))
(dolist (constructor (dd-constructors defstruct))
(res))))
\f
-;;;; 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))
+;;;; instances with ALTERNATE-METACLASS
+;;;;
+;;;; The CMU CL support for structures with ALTERNATE-METACLASS was a
+;;;; fairly general extension embedded in the main DEFSTRUCT code, and
+;;;; the result was an fairly impressive mess as ALTERNATE-METACLASS
+;;;; extension mixed with ANSI CL generality (e.g. :TYPE and :INCLUDE)
+;;;; and CMU CL implementation hairiness (esp. raw slots). This SBCL
+;;;; version is much less ambitious, noticing that ALTERNATE-METACLASS
+;;;; is only used to implement CONDITION, STANDARD-INSTANCE, and
+;;;; GENERIC-FUNCTION, and defining a simple specialized
+;;;; separate-from-DEFSTRUCT macro to provide only enough
+;;;; functionality to support those.
+;;;;
+;;;; KLUDGE: The defining macro here is so specialized that it's ugly
+;;;; in its own way. It also violates once-and-only-once by knowing
+;;;; much about structures and layouts that is already known by the
+;;;; main DEFSTRUCT macro. Hopefully it will go away presently
+;;;; (perhaps when CL:CLASS and SB-PCL:CLASS meet) as per FIXME below.
+;;;; -- WHN 2001-10-28
+;;;;
+;;;; FIXME: There seems to be no good reason to shoehorn CONDITION,
+;;;; STANDARD-INSTANCE, and GENERIC-FUNCTION into mutated structures
+;;;; instead of just implementing them as primitive objects. (This
+;;;; reduced-functionality macro seems pretty close to the
+;;;; functionality of DEFINE-PRIMITIVE-OBJECT..)
+
+(defun make-dd-with-alternate-metaclass (&key (class-name (missing-arg))
+ (superclass-name (missing-arg))
+ (metaclass-name (missing-arg))
+ (dd-type (missing-arg))
+ metaclass-constructor
+ slot-names)
+ (let* ((dd (make-defstruct-description class-name))
+ (conc-name (concatenate 'string (symbol-name class-name) "-"))
+ (dd-slots (let ((reversed-result nil)
+ ;; The index starts at 1 for ordinary
+ ;; named slots because slot 0 is
+ ;; magical, used for LAYOUT in
+ ;; CONDITIONs or for something (?) in
+ ;; funcallable instances.
+ (index 1))
+ (dolist (slot-name slot-names)
+ (push (make-defstruct-slot-description
+ :%name (symbol-name slot-name)
+ :index index
+ :accessor-name (symbolicate conc-name slot-name))
+ reversed-result)
+ (incf index))
+ (nreverse reversed-result))))
+ (setf (dd-alternate-metaclass dd) (list superclass-name
+ metaclass-name
+ metaclass-constructor)
+ (dd-slots dd) dd-slots
+ (dd-length dd) (1+ (length slot-names))
+ (dd-type dd) dd-type)
+ dd))
+
+(sb!xc:defmacro !defstruct-with-alternate-metaclass
+ (class-name &key
+ (slot-names (missing-arg))
+ (boa-constructor (missing-arg))
+ (superclass-name (missing-arg))
+ (metaclass-name (missing-arg))
+ (metaclass-constructor (missing-arg))
+ (dd-type (missing-arg))
+ predicate
+ (runtime-type-checks-p t))
+
+ (declare (type (and list (not null)) slot-names))
+ (declare (type (and symbol (not null))
+ boa-constructor
+ superclass-name
+ metaclass-name
+ metaclass-constructor))
+ (declare (type symbol predicate))
+ (declare (type (member structure funcallable-structure) dd-type))
+
+ (let* ((dd (make-dd-with-alternate-metaclass
+ :class-name class-name
+ :slot-names slot-names
+ :superclass-name superclass-name
+ :metaclass-name metaclass-name
+ :metaclass-constructor metaclass-constructor
+ :dd-type dd-type))
+ (dd-slots (dd-slots dd))
+ (dd-length (1+ (length slot-names)))
+ (object-gensym (gensym "OBJECT"))
+ (new-value-gensym (gensym "NEW-VALUE-"))
+ (delayed-layout-form `(%delayed-get-compiler-layout ,class-name)))
+ (multiple-value-bind (raw-maker-form raw-reffer-operator)
+ (ecase dd-type
+ (structure
+ (values `(let ((,object-gensym (%make-instance ,dd-length)))
+ (setf (%instance-layout ,object-gensym)
+ ,delayed-layout-form)
+ ,object-gensym)
+ '%instance-ref))
+ (funcallable-structure
+ (values `(%make-funcallable-instance ,dd-length
+ ,delayed-layout-form)
+ '%funcallable-instance-info)))
+ `(progn
+
+ (eval-when (:compile-toplevel :load-toplevel :execute)
+ (%compiler-set-up-layout ',dd))
+
+ ;; slot readers and writers
+ (declaim (inline ,@(mapcar #'dsd-accessor-name dd-slots)))
+ ,@(mapcar (lambda (dsd)
+ `(defun ,(dsd-accessor-name dsd) (,object-gensym)
+ ,@(when runtime-type-checks-p
+ `((declare (type ,class-name ,object-gensym))))
+ (,raw-reffer-operator ,object-gensym
+ ,(dsd-index dsd))))
+ dd-slots)
+ (declaim (inline ,@(mapcar (lambda (dsd)
+ `(setf ,(dsd-accessor-name dsd)))
+ dd-slots)))
+ ,@(mapcar (lambda (dsd)
+ `(defun (setf ,(dsd-accessor-name dsd)) (,new-value-gensym
+ ,object-gensym)
+ ,@(when runtime-type-checks-p
+ `((declare (type ,class-name ,object-gensym))))
+ (setf (,raw-reffer-operator ,object-gensym
+ ,(dsd-index dsd))
+ ,new-value-gensym)))
+ dd-slots)
+
+ ;; constructor
+ (defun ,boa-constructor ,slot-names
+ (let ((,object-gensym ,raw-maker-form))
+ ,@(mapcar (lambda (slot-name)
+ (let ((dsd (find (symbol-name slot-name) dd-slots
+ :key #'dsd-%name
+ :test #'string=)))
+ ;; KLUDGE: bug 117 bogowarning. Neither
+ ;; DECLAREing the type nor TRULY-THE cut
+ ;; the mustard -- it still gives warnings.
+ (enforce-type dsd defstruct-slot-description)
+ `(setf (,(dsd-accessor-name dsd) ,object-gensym)
+ ,slot-name)))
+ slot-names)
+ ,object-gensym))
+
+ ;; predicate
+ ,@(when predicate
+ ;; Just delegate to the compiler's type optimization
+ ;; code, which knows how to generate inline type tests
+ ;; for the whole CMU CL INSTANCE menagerie.
+ `(defun ,predicate (,object-gensym)
+ (typep ,object-gensym ',class-name)))))))
\f
;;;; finalizing bootstrapping
-;;; early structure placeholder definitions: Set up layout and class
-;;; data for structures which are needed early.
+;;; Set up DD and LAYOUT for STRUCTURE-OBJECT class itself.
+;;;
+;;; Ordinary structure classes effectively :INCLUDE STRUCTURE-OBJECT
+;;; when they have no explicit :INCLUDEs, so (1) it needs to be set up
+;;; before we can define ordinary structure classes, and (2) it's
+;;; special enough (and simple enough) that we just build it by hand
+;;; instead of trying to generalize the ordinary DEFSTRUCT code.
+(defun !set-up-structure-object-class ()
+ (let ((dd (make-defstruct-description 'structure-object)))
+ (setf
+ ;; Note: This has an ALTERNATE-METACLASS only because of blind
+ ;; clueless imitation of the CMU CL code -- dunno if or why it's
+ ;; needed. -- WHN
+ (dd-alternate-metaclass dd) '(instance)
+ (dd-slots dd) nil
+ (dd-length dd) 1
+ (dd-type dd) 'structure)
+ (%compiler-set-up-layout dd)))
+(!set-up-structure-object-class)
+
+;;; early structure predeclarations: Set up DD and LAYOUT for ordinary
+;;; (non-ALTERNATE-METACLASS) structures which are needed early.
(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")