1.0.6.22: fix occasional UNBOUND-VARIABLE errors in MAP-REFERENCING-OBJECTS
[sbcl.git] / src / code / defstruct.lisp
1 ;;;; that part of DEFSTRUCT implementation which is needed not just
2 ;;;; in the target Lisp but also in the cross-compilation host
3
4 ;;;; This software is part of the SBCL system. See the README file for
5 ;;;; more information.
6 ;;;;
7 ;;;; This software is derived from the CMU CL system, which was
8 ;;;; written at Carnegie Mellon University and released into the
9 ;;;; public domain. The software is in the public domain and is
10 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
11 ;;;; files for more information.
12
13 (in-package "SB!KERNEL")
14
15 (/show0 "code/defstruct.lisp 15")
16 \f
17 ;;;; getting LAYOUTs
18
19 ;;; Return the compiler layout for NAME. (The class referred to by
20 ;;; NAME must be a structure-like class.)
21 (defun compiler-layout-or-lose (name)
22   (let ((res (info :type :compiler-layout name)))
23     (cond ((not res)
24            (error "Class is not yet defined or was undefined: ~S" name))
25           ((not (typep (layout-info res) 'defstruct-description))
26            (error "Class is not a structure class: ~S" name))
27           (t res))))
28
29 ;;; Delay looking for compiler-layout until the constructor is being
30 ;;; compiled, since it doesn't exist until after the EVAL-WHEN
31 ;;; (COMPILE) stuff is compiled. (Or, in the oddball case when
32 ;;; DEFSTRUCT is executing in a non-toplevel context, the
33 ;;; compiler-layout still doesn't exist at compilation time, and we
34 ;;; delay still further.)
35 (sb!xc:defmacro %delayed-get-compiler-layout (name)
36   (let ((layout (info :type :compiler-layout name)))
37     (cond (layout
38            ;; ordinary case: When the DEFSTRUCT is at top level,
39            ;; then EVAL-WHEN (COMPILE) stuff will have set up the
40            ;; layout for us to use.
41            (unless (typep (layout-info layout) 'defstruct-description)
42              (error "Class is not a structure class: ~S" name))
43            `,layout)
44           (t
45            ;; KLUDGE: In the case that DEFSTRUCT is not at top-level
46            ;; the layout doesn't exist at compile time. In that case
47            ;; we laboriously look it up at run time. This code will
48            ;; run on every constructor call and will likely be quite
49            ;; slow, so if anyone cares about performance of
50            ;; non-toplevel DEFSTRUCTs, it should be rewritten to be
51            ;; cleverer. -- WHN 2002-10-23
52            (sb!c:compiler-notify
53             "implementation limitation: ~
54              Non-toplevel DEFSTRUCT constructors are slow.")
55            (with-unique-names (layout)
56              `(let ((,layout (info :type :compiler-layout ',name)))
57                 (unless (typep (layout-info ,layout) 'defstruct-description)
58                   (error "Class is not a structure class: ~S" ',name))
59                 ,layout))))))
60
61 ;;; Get layout right away.
62 (sb!xc:defmacro compile-time-find-layout (name)
63   (find-layout name))
64
65 ;;; re. %DELAYED-GET-COMPILER-LAYOUT and COMPILE-TIME-FIND-LAYOUT, above..
66 ;;;
67 ;;; FIXME: Perhaps both should be defined with DEFMACRO-MUNDANELY?
68 ;;; FIXME: Do we really need both? If so, their names and implementations
69 ;;; should probably be tweaked to be more parallel.
70 \f
71 ;;;; DEFSTRUCT-DESCRIPTION
72
73 ;;; The DEFSTRUCT-DESCRIPTION structure holds compile-time information
74 ;;; about a structure type.
75 (def!struct (defstruct-description
76              (:conc-name dd-)
77              (:make-load-form-fun just-dump-it-normally)
78              #-sb-xc-host (:pure t)
79              (:constructor make-defstruct-description
80                            (name &aux
81                                  (conc-name (symbolicate name "-"))
82                                  (copier-name (symbolicate "COPY-" name))
83                                  (predicate-name (symbolicate name "-P")))))
84   ;; name of the structure
85   (name (missing-arg) :type symbol :read-only t)
86   ;; documentation on the structure
87   (doc nil :type (or string null))
88   ;; prefix for slot names. If NIL, none.
89   (conc-name nil :type (or symbol null))
90   ;; the name of the primary standard keyword constructor, or NIL if none
91   (default-constructor nil :type (or symbol null))
92   ;; all the explicit :CONSTRUCTOR specs, with name defaulted
93   (constructors () :type list)
94   ;; name of copying function
95   (copier-name nil :type (or symbol null))
96   ;; name of type predicate
97   (predicate-name nil :type (or symbol null))
98   ;; the arguments to the :INCLUDE option, or NIL if no included
99   ;; structure
100   (include nil :type list)
101   ;; properties used to define structure-like classes with an
102   ;; arbitrary superclass and that may not have STRUCTURE-CLASS as the
103   ;; metaclass. Syntax is:
104   ;;    (superclass-name metaclass-name metaclass-constructor)
105   (alternate-metaclass nil :type list)
106   ;; a list of DEFSTRUCT-SLOT-DESCRIPTION objects for all slots
107   ;; (including included ones)
108   (slots () :type list)
109   ;; a list of (NAME . INDEX) pairs for accessors of included structures
110   (inherited-accessor-alist () :type list)
111   ;; number of elements we've allocated (See also RAW-LENGTH, which is not
112   ;; included in LENGTH.)
113   (length 0 :type index)
114   ;; General kind of implementation.
115   (type 'structure :type (member structure vector list
116                                  funcallable-structure))
117
118   ;; The next three slots are for :TYPE'd structures (which aren't
119   ;; classes, DD-CLASS-P = NIL)
120   ;;
121   ;; vector element type
122   (element-type t)
123   ;; T if :NAMED was explicitly specified, NIL otherwise
124   (named nil :type boolean)
125   ;; any INITIAL-OFFSET option on this direct type
126   (offset nil :type (or index null))
127
128   ;; the argument to the PRINT-FUNCTION option, or NIL if a
129   ;; PRINT-FUNCTION option was given with no argument, or 0 if no
130   ;; PRINT-FUNCTION option was given
131   (print-function 0 :type (or cons symbol (member 0)))
132   ;; the argument to the PRINT-OBJECT option, or NIL if a PRINT-OBJECT
133   ;; option was given with no argument, or 0 if no PRINT-OBJECT option
134   ;; was given
135   (print-object 0 :type (or cons symbol (member 0)))
136   ;; The number of untagged slots at the end.
137   (raw-length 0 :type index)
138   ;; the value of the :PURE option, or :UNSPECIFIED. This is only
139   ;; meaningful if DD-CLASS-P = T.
140   (pure :unspecified :type (member t nil :substructure :unspecified)))
141 (def!method print-object ((x defstruct-description) stream)
142   (print-unreadable-object (x stream :type t)
143     (prin1 (dd-name x) stream)))
144
145 ;;; Does DD describe a structure with a class?
146 (defun dd-class-p (dd)
147   (member (dd-type dd)
148           '(structure funcallable-structure)))
149
150 ;;; a type name which can be used when declaring things which operate
151 ;;; on structure instances
152 (defun dd-declarable-type (dd)
153   (if (dd-class-p dd)
154       ;; Native classes are known to the type system, and we can
155       ;; declare them as types.
156       (dd-name dd)
157       ;; Structures layered on :TYPE LIST or :TYPE VECTOR aren't part
158       ;; of the type system, so all we can declare is the underlying
159       ;; LIST or VECTOR type.
160       (dd-type dd)))
161
162 (defun dd-layout-or-lose (dd)
163   (compiler-layout-or-lose (dd-name dd)))
164 \f
165 ;;;; DEFSTRUCT-SLOT-DESCRIPTION
166
167 ;;; A DEFSTRUCT-SLOT-DESCRIPTION holds compile-time information about
168 ;;; a structure slot.
169 (def!struct (defstruct-slot-description
170              (:make-load-form-fun just-dump-it-normally)
171              (:conc-name dsd-)
172              (:copier nil)
173              #-sb-xc-host (:pure t))
174   ;; name of slot
175   name
176   ;; its position in the implementation sequence
177   (index (missing-arg) :type fixnum)
178   ;; the name of the accessor function
179   ;;
180   ;; (CMU CL had extra complexity here ("..or NIL if this accessor has
181   ;; the same name as an inherited accessor (which we don't want to
182   ;; shadow)") but that behavior doesn't seem to be specified by (or
183   ;; even particularly consistent with) ANSI, so it's gone in SBCL.)
184   (accessor-name nil)
185   default                       ; default value expression
186   (type t)                      ; declared type specifier
187   (safe-p t :type boolean)      ; whether the slot is known to be
188                                 ; always of the specified type
189   ;; If this object does not describe a raw slot, this value is T.
190   ;;
191   ;; If this object describes a raw slot, this value is the type of the
192   ;; value that the raw slot holds.
193   (raw-type t :type (member t single-float double-float
194                             #!+long-float long-float
195                             complex-single-float complex-double-float
196                             #!+long-float complex-long-float
197                             sb!vm:word))
198   (read-only nil :type (member t nil)))
199 (def!method print-object ((x defstruct-slot-description) stream)
200   (print-unreadable-object (x stream :type t)
201     (prin1 (dsd-name x) stream)))
202 \f
203 ;;;; typed (non-class) structures
204
205 ;;; Return a type specifier we can use for testing :TYPE'd structures.
206 (defun dd-lisp-type (defstruct)
207   (ecase (dd-type defstruct)
208     (list 'list)
209     (vector `(simple-array ,(dd-element-type defstruct) (*)))))
210 \f
211 ;;;; shared machinery for inline and out-of-line slot accessor functions
212
213 ;;; Classic comment preserved for entertainment value:
214 ;;;
215 ;;; "A lie can travel halfway round the world while the truth is
216 ;;; putting on its shoes." -- Mark Twain
217
218 (eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
219
220   ;; information about how a slot of a given DSD-RAW-TYPE is to be accessed
221   (defstruct raw-slot-data
222     ;; the raw slot type, or T for a non-raw slot
223     ;;
224     ;; (Non-raw slots are in the ordinary place you'd expect, directly
225     ;; indexed off the instance pointer.  Raw slots are indexed from the end
226     ;; of the instance and skipped by GC.)
227     (raw-type (missing-arg) :type (or symbol cons) :read-only t)
228     ;; What operator is used to access a slot of this type?
229     (accessor-name (missing-arg) :type symbol :read-only t)
230     ;; How many words are each value of this type?
231     (n-words (missing-arg) :type (and index (integer 1)) :read-only t)
232     ;; Necessary alignment in units of words.  Note that instances
233     ;; themselves are aligned by exactly two words, so specifying more
234     ;; than two words here would not work.
235     (alignment 1 :type (integer 1 2) :read-only t))
236
237   (defvar *raw-slot-data-list*
238     #!+hppa
239     nil
240     #!-hppa
241     (let ((double-float-alignment
242            ;; white list of architectures that can load unaligned doubles:
243            #!+(or x86 x86-64 ppc) 1
244            ;; at least sparc, mips and alpha can't:
245            #!-(or x86 x86-64 ppc) 2))
246       (list
247        (make-raw-slot-data :raw-type 'sb!vm:word
248                            :accessor-name '%raw-instance-ref/word
249                            :n-words 1)
250        (make-raw-slot-data :raw-type 'single-float
251                            :accessor-name '%raw-instance-ref/single
252                            ;; KLUDGE: On 64 bit architectures, we
253                            ;; could pack two SINGLE-FLOATs into the
254                            ;; same word if raw slots were indexed
255                            ;; using bytes instead of words.  However,
256                            ;; I don't personally find optimizing
257                            ;; SINGLE-FLOAT memory usage worthwile
258                            ;; enough.  And the other datatype that
259                            ;; would really benefit is (UNSIGNED-BYTE
260                            ;; 32), but that is a subtype of FIXNUM, so
261                            ;; we store it unraw anyway.  :-( -- DFL
262                            :n-words 1)
263        (make-raw-slot-data :raw-type 'double-float
264                            :accessor-name '%raw-instance-ref/double
265                            :alignment double-float-alignment
266                            :n-words (/ 8 sb!vm:n-word-bytes))
267        (make-raw-slot-data :raw-type 'complex-single-float
268                            :accessor-name '%raw-instance-ref/complex-single
269                            :n-words (/ 8 sb!vm:n-word-bytes))
270        (make-raw-slot-data :raw-type 'complex-double-float
271                            :accessor-name '%raw-instance-ref/complex-double
272                            :alignment double-float-alignment
273                            :n-words (/ 16 sb!vm:n-word-bytes))
274        #!+long-float
275        (make-raw-slot-data :raw-type long-float
276                            :accessor-name '%raw-instance-ref/long
277                            :n-words #!+x86 3 #!+sparc 4)
278        #!+long-float
279        (make-raw-slot-data :raw-type complex-long-float
280                            :accessor-name '%raw-instance-ref/complex-long
281                            :n-words #!+x86 6 #!+sparc 8)))))
282 \f
283 ;;;; the legendary DEFSTRUCT macro itself (both CL:DEFSTRUCT and its
284 ;;;; close personal friend SB!XC:DEFSTRUCT)
285
286 ;;; Return a list of forms to install PRINT and MAKE-LOAD-FORM funs,
287 ;;; mentioning them in the expansion so that they can be compiled.
288 (defun class-method-definitions (defstruct)
289   (let ((name (dd-name defstruct)))
290     `((locally
291         ;; KLUDGE: There's a FIND-CLASS DEFTRANSFORM for constant
292         ;; class names which creates fast but non-cold-loadable,
293         ;; non-compact code. In this context, we'd rather have
294         ;; compact, cold-loadable code. -- WHN 19990928
295         (declare (notinline find-classoid))
296         ,@(let ((pf (dd-print-function defstruct))
297                 (po (dd-print-object defstruct))
298                 (x (gensym))
299                 (s (gensym)))
300             ;; Giving empty :PRINT-OBJECT or :PRINT-FUNCTION options
301             ;; leaves PO or PF equal to NIL. The user-level effect is
302             ;; to generate a PRINT-OBJECT method specialized for the type,
303             ;; implementing the default #S structure-printing behavior.
304             (when (or (eq pf nil) (eq po nil))
305               (setf pf '(default-structure-print)
306                     po 0))
307             (flet (;; Given an arg from a :PRINT-OBJECT or :PRINT-FUNCTION
308                    ;; option, return the value to pass as an arg to FUNCTION.
309                    (farg (oarg)
310                      (destructuring-bind (fun-name) oarg
311                        fun-name)))
312               (cond ((not (eql pf 0))
313                      `((def!method print-object ((,x ,name) ,s)
314                          (funcall #',(farg pf)
315                                   ,x
316                                   ,s
317                                   *current-level-in-print*))))
318                     ((not (eql po 0))
319                      `((def!method print-object ((,x ,name) ,s)
320                          (funcall #',(farg po) ,x ,s))))
321                     (t nil))))
322         ,@(let ((pure (dd-pure defstruct)))
323             (cond ((eq pure t)
324                    `((setf (layout-pure (classoid-layout
325                                          (find-classoid ',name)))
326                            t)))
327                   ((eq pure :substructure)
328                    `((setf (layout-pure (classoid-layout
329                                          (find-classoid ',name)))
330                            0)))))
331         ,@(let ((def-con (dd-default-constructor defstruct)))
332             (when (and def-con (not (dd-alternate-metaclass defstruct)))
333               `((setf (structure-classoid-constructor (find-classoid ',name))
334                       #',def-con))))))))
335
336 ;;; shared logic for host macroexpansion for SB!XC:DEFSTRUCT and
337 ;;; cross-compiler macroexpansion for CL:DEFSTRUCT
338 (defmacro !expander-for-defstruct (name-and-options
339                                    slot-descriptions
340                                    expanding-into-code-for-xc-host-p)
341   `(let ((name-and-options ,name-and-options)
342          (slot-descriptions ,slot-descriptions)
343          (expanding-into-code-for-xc-host-p
344           ,expanding-into-code-for-xc-host-p))
345      (let* ((dd (parse-defstruct-name-and-options-and-slot-descriptions
346                  name-and-options
347                  slot-descriptions))
348             (name (dd-name dd)))
349        (if (dd-class-p dd)
350            (let ((inherits (inherits-for-structure dd)))
351              `(progn
352                 ;; Note we intentionally enforce package locks and
353                 ;; call %DEFSTRUCT first, and especially before
354                 ;; %COMPILER-DEFSTRUCT. %DEFSTRUCT has the tests (and
355                 ;; resulting CERROR) for collisions with LAYOUTs which
356                 ;; already exist in the runtime. If there are any
357                 ;; collisions, we want the user's response to CERROR
358                 ;; to control what happens. Especially, if the user
359                 ;; responds to the collision with ABORT, we don't want
360                 ;; %COMPILER-DEFSTRUCT to modify the definition of the
361                 ;; class.
362                 (with-single-package-locked-error
363                     (:symbol ',name "defining ~A as a structure"))
364                 (%defstruct ',dd ',inherits (sb!c:source-location))
365                 (eval-when (:compile-toplevel :load-toplevel :execute)
366                   (%compiler-defstruct ',dd ',inherits))
367                 ,@(unless expanding-into-code-for-xc-host-p
368                     (append ;; FIXME: We've inherited from CMU CL nonparallel
369                             ;; code for creating copiers for typed and untyped
370                             ;; structures. This should be fixed.
371                             ;(copier-definition dd)
372                             (constructor-definitions dd)
373                             (class-method-definitions dd)))
374                 ',name))
375            `(progn
376               (with-single-package-locked-error
377                   (:symbol ',name "defining ~A as a structure"))
378               (eval-when (:compile-toplevel :load-toplevel :execute)
379                 (setf (info :typed-structure :info ',name) ',dd))
380               (eval-when (:load-toplevel :execute)
381                 (setf (info :source-location :typed-structure ',name)
382                       (sb!c:source-location)))
383               ,@(unless expanding-into-code-for-xc-host-p
384                   (append (typed-accessor-definitions dd)
385                           (typed-predicate-definitions dd)
386                           (typed-copier-definitions dd)
387                           (constructor-definitions dd)
388                           (when (dd-doc dd)
389                             `((setf (fdocumentation ',(dd-name dd) 'structure)
390                                ',(dd-doc dd))))))
391               ',name)))))
392
393 (sb!xc:defmacro defstruct (name-and-options &rest slot-descriptions)
394   #!+sb-doc
395   "DEFSTRUCT {Name | (Name Option*)} {Slot | (Slot [Default] {Key Value}*)}
396    Define the structure type Name. Instances are created by MAKE-<name>,
397    which takes &KEY arguments allowing initial slot values to the specified.
398    A SETF'able function <name>-<slot> is defined for each slot to read and
399    write slot values. <name>-p is a type predicate.
400
401    Popular DEFSTRUCT options (see manual for others):
402
403    (:CONSTRUCTOR Name)
404    (:PREDICATE Name)
405        Specify the name for the constructor or predicate.
406
407    (:CONSTRUCTOR Name Lambda-List)
408        Specify the name and arguments for a BOA constructor
409        (which is more efficient when keyword syntax isn't necessary.)
410
411    (:INCLUDE Supertype Slot-Spec*)
412        Make this type a subtype of the structure type Supertype. The optional
413        Slot-Specs override inherited slot options.
414
415    Slot options:
416
417    :TYPE Type-Spec
418        Asserts that the value of this slot is always of the specified type.
419
420    :READ-ONLY {T | NIL}
421        If true, no setter function is defined for this slot."
422     (!expander-for-defstruct name-and-options slot-descriptions nil))
423 #+sb-xc-host
424 (defmacro sb!xc:defstruct (name-and-options &rest slot-descriptions)
425   #!+sb-doc
426   "Cause information about a target structure to be built into the
427   cross-compiler."
428   (!expander-for-defstruct name-and-options slot-descriptions t))
429 \f
430 ;;;; functions to generate code for various parts of DEFSTRUCT definitions
431
432 ;;; First, a helper to determine whether a name names an inherited
433 ;;; accessor.
434 (defun accessor-inherited-data (name defstruct)
435   (assoc name (dd-inherited-accessor-alist defstruct) :test #'eq))
436
437 ;;; Return a list of forms which create a predicate function for a
438 ;;; typed DEFSTRUCT.
439 (defun typed-predicate-definitions (defstruct)
440   (let ((name (dd-name defstruct))
441         (predicate-name (dd-predicate-name defstruct))
442         (argname (gensym)))
443     (when (and predicate-name (dd-named defstruct))
444       (let ((ltype (dd-lisp-type defstruct))
445             (name-index (cdr (car (last (find-name-indices defstruct))))))
446         `((defun ,predicate-name (,argname)
447             (and (typep ,argname ',ltype)
448                  ,(cond
449                    ((subtypep ltype 'list)
450                      `(do ((head (the ,ltype ,argname) (cdr head))
451                            (i 0 (1+ i)))
452                           ((or (not (consp head)) (= i ,name-index))
453                            (and (consp head) (eq ',name (car head))))))
454                    ((subtypep ltype 'vector)
455                     `(and (= (length (the ,ltype ,argname))
456                            ,(dd-length defstruct))
457                           (eq ',name (aref (the ,ltype ,argname) ,name-index))))
458                    (t (bug "Uncatered-for lisp type in typed DEFSTRUCT: ~S."
459                            ltype))))))))))
460
461 ;;; Return a list of forms to create a copier function of a typed DEFSTRUCT.
462 (defun typed-copier-definitions (defstruct)
463   (when (dd-copier-name defstruct)
464     `((setf (fdefinition ',(dd-copier-name defstruct)) #'copy-seq)
465       (declaim (ftype function ,(dd-copier-name defstruct))))))
466
467 ;;; Return a list of function definitions for accessing and setting
468 ;;; the slots of a typed DEFSTRUCT. The functions are proclaimed to be
469 ;;; inline, and the types of their arguments and results are declared
470 ;;; as well. We count on the compiler to do clever things with ELT.
471 (defun typed-accessor-definitions (defstruct)
472   (collect ((stuff))
473     (let ((ltype (dd-lisp-type defstruct)))
474       (dolist (slot (dd-slots defstruct))
475         (let ((name (dsd-accessor-name slot))
476               (index (dsd-index slot))
477               (slot-type `(and ,(dsd-type slot)
478                                ,(dd-element-type defstruct))))
479           (let ((inherited (accessor-inherited-data name defstruct)))
480             (cond
481               ((not inherited)
482                (stuff `(declaim (inline ,name (setf ,name))))
483                ;; FIXME: The arguments in the next two DEFUNs should
484                ;; be gensyms. (Otherwise e.g. if NEW-VALUE happened to
485                ;; be the name of a special variable, things could get
486                ;; weird.)
487                (stuff `(defun ,name (structure)
488                         (declare (type ,ltype structure))
489                         (the ,slot-type (elt structure ,index))))
490                (unless (dsd-read-only slot)
491                  (stuff
492                   `(defun (setf ,name) (new-value structure)
493                     (declare (type ,ltype structure) (type ,slot-type new-value))
494                     (setf (elt structure ,index) new-value)))))
495               ((not (= (cdr inherited) index))
496                (style-warn "~@<Non-overwritten accessor ~S does not access ~
497                             slot with name ~S (accessing an inherited slot ~
498                             instead).~:@>" name (dsd-name slot))))))))
499     (stuff)))
500 \f
501 ;;;; parsing
502
503 (defun require-no-print-options-so-far (defstruct)
504   (unless (and (eql (dd-print-function defstruct) 0)
505                (eql (dd-print-object defstruct) 0))
506     (error "No more than one of the following options may be specified:
507   :PRINT-FUNCTION, :PRINT-OBJECT, :TYPE")))
508
509 ;;; Parse a single DEFSTRUCT option and store the results in DD.
510 (defun parse-1-dd-option (option dd)
511   (let ((args (rest option))
512         (name (dd-name dd)))
513     (case (first option)
514       (:conc-name
515        (destructuring-bind (&optional conc-name) args
516          (setf (dd-conc-name dd)
517                (if (symbolp conc-name)
518                    conc-name
519                    (make-symbol (string conc-name))))))
520       (:constructor
521        (destructuring-bind (&optional (cname (symbolicate "MAKE-" name))
522                                       &rest stuff)
523            args
524          (push (cons cname stuff) (dd-constructors dd))))
525       (:copier
526        (destructuring-bind (&optional (copier (symbolicate "COPY-" name)))
527            args
528          (setf (dd-copier-name dd) copier)))
529       (:predicate
530        (destructuring-bind (&optional (predicate-name (symbolicate name "-P")))
531            args
532          (setf (dd-predicate-name dd) predicate-name)))
533       (:include
534        (when (dd-include dd)
535          (error "more than one :INCLUDE option"))
536        (setf (dd-include dd) args))
537       (:print-function
538        (require-no-print-options-so-far dd)
539        (setf (dd-print-function dd)
540              (the (or symbol cons) args)))
541       (:print-object
542        (require-no-print-options-so-far dd)
543        (setf (dd-print-object dd)
544              (the (or symbol cons) args)))
545       (:type
546        (destructuring-bind (type) args
547          (cond ((member type '(list vector))
548                 (setf (dd-element-type dd) t)
549                 (setf (dd-type dd) type))
550                ((and (consp type) (eq (first type) 'vector))
551                 (destructuring-bind (vector vtype) type
552                   (declare (ignore vector))
553                   (setf (dd-element-type dd) vtype)
554                   (setf (dd-type dd) 'vector)))
555                (t
556                 (error "~S is a bad :TYPE for DEFSTRUCT." type)))))
557       (:named
558        (error "The DEFSTRUCT option :NAMED takes no arguments."))
559       (:initial-offset
560        (destructuring-bind (offset) args
561          (setf (dd-offset dd) offset)))
562       (:pure
563        (destructuring-bind (fun) args
564          (setf (dd-pure dd) fun)))
565       (t (error "unknown DEFSTRUCT option:~%  ~S" option)))))
566
567 ;;; Given name and options, return a DD holding that info.
568 (defun parse-defstruct-name-and-options (name-and-options)
569   (destructuring-bind (name &rest options) name-and-options
570     (aver name) ; A null name doesn't seem to make sense here.
571     (let ((dd (make-defstruct-description name)))
572       (dolist (option options)
573         (cond ((eq option :named)
574                (setf (dd-named dd) t))
575               ((consp option)
576                (parse-1-dd-option option dd))
577               ((member option '(:conc-name :constructor :copier :predicate))
578                (parse-1-dd-option (list option) dd))
579               (t
580                (error "unrecognized DEFSTRUCT option: ~S" option))))
581
582       (case (dd-type dd)
583         (structure
584          (when (dd-offset dd)
585            (error ":OFFSET can't be specified unless :TYPE is specified."))
586          (unless (dd-include dd)
587            ;; FIXME: It'd be cleaner to treat no-:INCLUDE as defaulting
588            ;; to :INCLUDE STRUCTURE-OBJECT, and then let the general-case
589            ;; (INCF (DD-LENGTH DD) (DD-LENGTH included-DD)) logic take
590            ;; care of this. (Except that the :TYPE VECTOR and :TYPE
591            ;; LIST cases, with their :NAMED and un-:NAMED flavors,
592            ;; make that messy, alas.)
593            (incf (dd-length dd))))
594         (t
595          (require-no-print-options-so-far dd)
596          (when (dd-named dd)
597            (incf (dd-length dd)))
598          (let ((offset (dd-offset dd)))
599            (when offset (incf (dd-length dd) offset)))))
600
601       (when (dd-include dd)
602         (frob-dd-inclusion-stuff dd))
603
604       dd)))
605
606 ;;; Given name and options and slot descriptions (and possibly doc
607 ;;; string at the head of slot descriptions) return a DD holding that
608 ;;; info.
609 (defun parse-defstruct-name-and-options-and-slot-descriptions
610     (name-and-options slot-descriptions)
611   (let ((result (parse-defstruct-name-and-options (if (atom name-and-options)
612                                                       (list name-and-options)
613                                                       name-and-options))))
614     (when (stringp (car slot-descriptions))
615       (setf (dd-doc result) (pop slot-descriptions)))
616     (dolist (slot-description slot-descriptions)
617       (allocate-1-slot result (parse-1-dsd result slot-description)))
618     result))
619 \f
620 ;;;; stuff to parse slot descriptions
621
622 ;;; Parse a slot description for DEFSTRUCT, add it to the description
623 ;;; and return it. If supplied, SLOT is a pre-initialized DSD
624 ;;; that we modify to get the new slot. This is supplied when handling
625 ;;; included slots.
626 (defun parse-1-dsd (defstruct spec &optional
627                     (slot (make-defstruct-slot-description :name ""
628                                                            :index 0
629                                                            :type t)))
630   (multiple-value-bind (name default default-p type type-p read-only ro-p)
631       (typecase spec
632         (symbol
633          (when (keywordp spec)
634            (style-warn "Keyword slot name indicates probable syntax ~
635                         error in DEFSTRUCT: ~S."
636                        spec))
637          spec)
638         (cons
639          (destructuring-bind
640                (name
641                 &optional (default nil default-p)
642                 &key (type nil type-p) (read-only nil ro-p))
643              spec
644            (values name
645                    default default-p
646                    (uncross type) type-p
647                    read-only ro-p)))
648         (t (error 'simple-program-error
649                   :format-control "in DEFSTRUCT, ~S is not a legal slot ~
650                                    description."
651                   :format-arguments (list spec))))
652
653     (when (find name (dd-slots defstruct)
654                 :test #'string=
655                 :key (lambda (x) (symbol-name (dsd-name x))))
656       (error 'simple-program-error
657              :format-control "duplicate slot name ~S"
658              :format-arguments (list name)))
659     (setf (dsd-name slot) name)
660     (setf (dd-slots defstruct) (nconc (dd-slots defstruct) (list slot)))
661
662     (let ((accessor-name (if (dd-conc-name defstruct)
663                              (symbolicate (dd-conc-name defstruct) name)
664                              name))
665           (predicate-name (dd-predicate-name defstruct)))
666       (setf (dsd-accessor-name slot) accessor-name)
667       (when (eql accessor-name predicate-name)
668         ;; Some adventurous soul has named a slot so that its accessor
669         ;; collides with the structure type predicate. ANSI doesn't
670         ;; specify what to do in this case. As of 2001-09-04, Martin
671         ;; Atzmueller reports that CLISP and Lispworks both give
672         ;; priority to the slot accessor, so that the predicate is
673         ;; overwritten. We might as well do the same (as well as
674         ;; signalling a warning).
675         (style-warn
676          "~@<The structure accessor name ~S is the same as the name of the ~
677           structure type predicate. ANSI doesn't specify what to do in ~
678           this case. We'll overwrite the type predicate with the slot ~
679           accessor, but you can't rely on this behavior, so it'd be wise to ~
680           remove the ambiguity in your code.~@:>"
681          accessor-name)
682         (setf (dd-predicate-name defstruct) nil))
683       ;; FIXME: It would be good to check for name collisions here, but
684       ;; the easy check,
685       ;;x#-sb-xc-host
686       ;;x(when (and (fboundp accessor-name)
687       ;;x           (not (accessor-inherited-data accessor-name defstruct)))
688       ;;x  (style-warn "redefining ~S in DEFSTRUCT" accessor-name)))
689       ;; which was done until sbcl-0.8.11.18 or so, is wrong: it causes
690       ;; a warning at MACROEXPAND time, when instead the warning should
691       ;; occur not just because the code was constructed, but because it
692       ;; is actually compiled or loaded.
693       )
694
695     (when default-p
696       (setf (dsd-default slot) default))
697     (when type-p
698       (setf (dsd-type slot)
699             (if (eq (dsd-type slot) t)
700                 type
701                 `(and ,(dsd-type slot) ,type))))
702     (when ro-p
703       (if read-only
704           (setf (dsd-read-only slot) t)
705           (when (dsd-read-only slot)
706             (error "~@<The slot ~S is :READ-ONLY in superclass, and so must ~
707                        be :READ-ONLY in subclass.~:@>"
708                    (dsd-name slot)))))
709     slot))
710
711 ;;; When a value of type TYPE is stored in a structure, should it be
712 ;;; stored in a raw slot?  Return the matching RAW-SLOT-DATA structure
713 ;; if TYPE should be stored in a raw slot, or NIL if not.
714 (defun structure-raw-slot-data (type)
715   (multiple-value-bind (fixnum? fixnum-certain?)
716       (sb!xc:subtypep type 'fixnum)
717     ;; (The extra test for FIXNUM-CERTAIN? here is intended for
718     ;; bootstrapping the system. In particular, in sbcl-0.6.2, we set up
719     ;; LAYOUT before FIXNUM is defined, and so could bogusly end up
720     ;; putting INDEX-typed values into raw slots if we didn't test
721     ;; FIXNUM-CERTAIN?.)
722     (if (or fixnum? (not fixnum-certain?))
723         nil
724         (dolist (data *raw-slot-data-list*)
725           (when (sb!xc:subtypep type (raw-slot-data-raw-type data))
726             (return data))))))
727
728 ;;; Allocate storage for a DSD in DD. This is where we decide whether
729 ;;; a slot is raw or not. Raw objects are aligned on the unit of their size.
730 (defun allocate-1-slot (dd dsd)
731   (let ((rsd
732          (if (eq (dd-type dd) 'structure)
733              (structure-raw-slot-data (dsd-type dsd))
734              nil)))
735     (cond
736       ((null rsd)
737         (setf (dsd-index dsd) (dd-length dd))
738         (incf (dd-length dd)))
739       (t
740         (let* ((words (raw-slot-data-n-words rsd))
741                (alignment (raw-slot-data-alignment rsd))
742                (off (rem (dd-raw-length dd) alignment)))
743           (unless (zerop off)
744             (incf (dd-raw-length dd) (- alignment off)))
745           (setf (dsd-raw-type dsd) (raw-slot-data-raw-type rsd))
746           (setf (dsd-index dsd) (dd-raw-length dd))
747           (incf (dd-raw-length dd) words)))))
748   (values))
749
750 (defun typed-structure-info-or-lose (name)
751   (or (info :typed-structure :info name)
752       (error ":TYPE'd DEFSTRUCT ~S not found for inclusion." name)))
753
754 ;;; Process any included slots pretty much like they were specified.
755 ;;; Also inherit various other attributes.
756 (defun frob-dd-inclusion-stuff (dd)
757   (destructuring-bind (included-name &rest modified-slots) (dd-include dd)
758     (let* ((type (dd-type dd))
759            (included-structure
760             (if (dd-class-p dd)
761                 (layout-info (compiler-layout-or-lose included-name))
762                 (typed-structure-info-or-lose included-name))))
763
764       ;; checks on legality
765       (unless (and (eq type (dd-type included-structure))
766                    (type= (specifier-type (dd-element-type included-structure))
767                           (specifier-type (dd-element-type dd))))
768         (error ":TYPE option mismatch between structures ~S and ~S"
769                (dd-name dd) included-name))
770       (let ((included-classoid (find-classoid included-name nil)))
771         (when included-classoid
772           ;; It's not particularly well-defined to :INCLUDE any of the
773           ;; CMU CL INSTANCE weirdosities like CONDITION or
774           ;; GENERIC-FUNCTION, and it's certainly not ANSI-compliant.
775           (let* ((included-layout (classoid-layout included-classoid))
776                  (included-dd (layout-info included-layout)))
777             (when (and (dd-alternate-metaclass included-dd)
778                        ;; As of sbcl-0.pre7.73, anyway, STRUCTURE-OBJECT
779                        ;; is represented with an ALTERNATE-METACLASS. But
780                        ;; it's specifically OK to :INCLUDE (and PCL does)
781                        ;; so in this one case, it's OK to include
782                        ;; something with :ALTERNATE-METACLASS after all.
783                        (not (eql included-name 'structure-object)))
784               (error "can't :INCLUDE class ~S (has alternate metaclass)"
785                      included-name)))))
786
787       (incf (dd-length dd) (dd-length included-structure))
788       (when (dd-class-p dd)
789         (let ((mc (rest (dd-alternate-metaclass included-structure))))
790           (when (and mc (not (dd-alternate-metaclass dd)))
791             (setf (dd-alternate-metaclass dd)
792                   (cons included-name mc))))
793         (when (eq (dd-pure dd) :unspecified)
794           (setf (dd-pure dd) (dd-pure included-structure)))
795         (setf (dd-raw-length dd) (dd-raw-length included-structure)))
796
797       (setf (dd-inherited-accessor-alist dd)
798             (dd-inherited-accessor-alist included-structure))
799       (dolist (included-slot (dd-slots included-structure))
800         (let* ((included-name (dsd-name included-slot))
801                (modified (or (find included-name modified-slots
802                                    :key (lambda (x) (if (atom x) x (car x)))
803                                    :test #'string=)
804                              `(,included-name))))
805           ;; We stash away an alist of accessors to parents' slots
806           ;; that have already been created to avoid conflicts later
807           ;; so that structures with :INCLUDE and :CONC-NAME (and
808           ;; other edge cases) can work as specified.
809           (when (dsd-accessor-name included-slot)
810             ;; the "oldest" (i.e. highest up the tree of inheritance)
811             ;; will prevail, so don't push new ones on if they
812             ;; conflict.
813             (pushnew (cons (dsd-accessor-name included-slot)
814                            (dsd-index included-slot))
815                      (dd-inherited-accessor-alist dd)
816                      :test #'eq :key #'car))
817           (let ((new-slot (parse-1-dsd dd
818                                        modified
819                                        (copy-structure included-slot))))
820             (when (and (neq (dsd-type new-slot) (dsd-type included-slot))
821                        (not (sb!xc:subtypep (dsd-type included-slot)
822                                             (dsd-type new-slot)))
823                        (dsd-safe-p included-slot))
824               (setf (dsd-safe-p new-slot) nil)
825               ;; XXX: notify?
826               )))))))
827 \f
828 ;;;; various helper functions for setting up DEFSTRUCTs
829
830 ;;; This function is called at macroexpand time to compute the INHERITS
831 ;;; vector for a structure type definition.
832 (defun inherits-for-structure (info)
833   (declare (type defstruct-description info))
834   (let* ((include (dd-include info))
835          (superclass-opt (dd-alternate-metaclass info))
836          (super
837           (if include
838               (compiler-layout-or-lose (first include))
839               (classoid-layout (find-classoid
840                                 (or (first superclass-opt)
841                                     'structure-object))))))
842     (case (dd-name info)
843       ((ansi-stream)
844        (concatenate 'simple-vector
845                     (layout-inherits super)
846                     (vector super (classoid-layout (find-classoid 'stream)))))
847       ((fd-stream)
848        (concatenate 'simple-vector
849                     (layout-inherits super)
850                     (vector super
851                             (classoid-layout (find-classoid 'file-stream)))))
852       ((sb!impl::string-input-stream
853         sb!impl::string-output-stream
854         sb!impl::fill-pointer-output-stream)
855        (concatenate 'simple-vector
856                     (layout-inherits super)
857                     (vector super
858                             (classoid-layout (find-classoid 'string-stream)))))
859       (t (concatenate 'simple-vector
860                       (layout-inherits super)
861                       (vector super))))))
862
863 ;;; Do miscellaneous (LOAD EVAL) time actions for the structure
864 ;;; described by DD. Create the class and LAYOUT, checking for
865 ;;; incompatible redefinition. Define those functions which are
866 ;;; sufficiently stereotyped that we can implement them as standard
867 ;;; closures.
868 (defun %defstruct (dd inherits source-location)
869   (declare (type defstruct-description dd))
870
871   ;; We set up LAYOUTs even in the cross-compilation host.
872   (multiple-value-bind (classoid layout old-layout)
873       (ensure-structure-class dd inherits "current" "new")
874     (cond ((not old-layout)
875            (unless (eq (classoid-layout classoid) layout)
876              (register-layout layout)))
877           (t
878            (let ((old-dd (layout-info old-layout)))
879              (when (defstruct-description-p old-dd)
880                (dolist (slot (dd-slots old-dd))
881                  (fmakunbound (dsd-accessor-name slot))
882                  (unless (dsd-read-only slot)
883                    (fmakunbound `(setf ,(dsd-accessor-name slot)))))))
884            (%redefine-defstruct classoid old-layout layout)
885            (setq layout (classoid-layout classoid))))
886     (setf (find-classoid (dd-name dd)) classoid)
887
888     (sb!c:with-source-location (source-location)
889       (setf (layout-source-location layout) source-location))
890
891     ;; Various other operations only make sense on the target SBCL.
892     #-sb-xc-host
893     (%target-defstruct dd layout))
894
895   (values))
896 \f
897 ;;; Return a form describing the writable place used for this slot
898 ;;; in the instance named INSTANCE-NAME.
899 (defun %accessor-place-form (dd dsd instance-name)
900   (let (;; the operator that we'll use to access a typed slot
901         (ref (ecase (dd-type dd)
902                (structure '%instance-ref)
903                (list 'nth-but-with-sane-arg-order)
904                (vector 'aref)))
905         (raw-type (dsd-raw-type dsd)))
906     (if (eq raw-type t) ; if not raw slot
907         `(,ref ,instance-name ,(dsd-index dsd))
908         (let* ((raw-slot-data (find raw-type *raw-slot-data-list*
909                                     :key #'raw-slot-data-raw-type
910                                     :test #'equal))
911                (raw-slot-accessor (raw-slot-data-accessor-name raw-slot-data)))
912           `(,raw-slot-accessor ,instance-name ,(dsd-index dsd))))))
913
914 ;;; Return source transforms for the reader and writer functions of
915 ;;; the slot described by DSD. They should be inline expanded, but
916 ;;; source transforms work faster.
917 (defun slot-accessor-transforms (dd dsd)
918   (let ((accessor-place-form (%accessor-place-form dd dsd
919                                                    `(the ,(dd-name dd) instance)))
920         (dsd-type (dsd-type dsd))
921         (value-the (if (dsd-safe-p dsd) 'truly-the 'the)))
922     (values (sb!c:source-transform-lambda (instance)
923               `(,value-the ,dsd-type ,(subst instance 'instance
924                                              accessor-place-form)))
925             (sb!c:source-transform-lambda (new-value instance)
926               (destructuring-bind (accessor-name &rest accessor-args)
927                   accessor-place-form
928                 (once-only ((new-value new-value)
929                             (instance instance))
930                   `(,(info :setf :inverse accessor-name)
931                      ,@(subst instance 'instance accessor-args)
932                      (the ,dsd-type ,new-value))))))))
933
934 ;;; Return a LAMBDA form which can be used to set a slot.
935 (defun slot-setter-lambda-form (dd dsd)
936   ;; KLUDGE: Evaluating the results of SLOT-ACCESSOR-TRANSFORMS needs
937   ;; a lexenv.
938   (let ((sb!c:*lexenv* (if (boundp 'sb!c:*lexenv*)
939                            sb!c:*lexenv*
940                            (sb!c::make-null-lexenv))))
941     `(lambda (new-value instance)
942        ,(funcall (nth-value 1 (slot-accessor-transforms dd dsd))
943                  '(dummy new-value instance)))))
944
945 ;;; core compile-time setup of any class with a LAYOUT, used even by
946 ;;; !DEFSTRUCT-WITH-ALTERNATE-METACLASS weirdosities
947 (defun %compiler-set-up-layout (dd
948                                 &optional
949                                 ;; Several special cases
950                                 ;; (STRUCTURE-OBJECT itself, and
951                                 ;; structures with alternate
952                                 ;; metaclasses) call this function
953                                 ;; directly, and they're all at the
954                                 ;; base of the instance class
955                                 ;; structure, so this is a handy
956                                 ;; default.  (But note
957                                 ;; FUNCALLABLE-STRUCTUREs need
958                                 ;; assistance here)
959                                 (inherits (vector (find-layout t))))
960
961   (multiple-value-bind (classoid layout old-layout)
962       (multiple-value-bind (clayout clayout-p)
963           (info :type :compiler-layout (dd-name dd))
964         (ensure-structure-class dd
965                                 inherits
966                                 (if clayout-p "previously compiled" "current")
967                                 "compiled"
968                                 :compiler-layout clayout))
969     (cond (old-layout
970            (undefine-structure (layout-classoid old-layout))
971            (when (and (classoid-subclasses classoid)
972                       (not (eq layout old-layout)))
973              (collect ((subs))
974                       (dohash (classoid layout (classoid-subclasses classoid))
975                         (declare (ignore layout))
976                         (undefine-structure classoid)
977                         (subs (classoid-proper-name classoid)))
978                       (when (subs)
979                         (warn "removing old subclasses of ~S:~%  ~S"
980                               (classoid-name classoid)
981                               (subs))))))
982           (t
983            (unless (eq (classoid-layout classoid) layout)
984              (register-layout layout :invalidate nil))
985            (setf (find-classoid (dd-name dd)) classoid)))
986
987     ;; At this point the class should be set up in the INFO database.
988     ;; But the logic that enforces this is a little tangled and
989     ;; scattered, so it's not obvious, so let's check.
990     (aver (find-classoid (dd-name dd) nil))
991
992     (setf (info :type :compiler-layout (dd-name dd)) layout))
993
994   (values))
995
996 ;;; Do (COMPILE LOAD EVAL)-time actions for the normal (not
997 ;;; ALTERNATE-LAYOUT) DEFSTRUCT described by DD.
998 (defun %compiler-defstruct (dd inherits)
999   (declare (type defstruct-description dd))
1000
1001   (%compiler-set-up-layout dd inherits)
1002
1003   (let* ((dtype (dd-declarable-type dd)))
1004
1005     (let ((copier-name (dd-copier-name dd)))
1006       (when copier-name
1007         (sb!xc:proclaim `(ftype (sfunction (,dtype) ,dtype) ,copier-name))))
1008
1009     (let ((predicate-name (dd-predicate-name dd)))
1010       (when predicate-name
1011         (sb!xc:proclaim `(ftype (sfunction (t) boolean) ,predicate-name))
1012         ;; Provide inline expansion (or not).
1013         (ecase (dd-type dd)
1014           ((structure funcallable-structure)
1015            ;; Let the predicate be inlined.
1016            (setf (info :function :inline-expansion-designator predicate-name)
1017                  (lambda ()
1018                    `(lambda (x)
1019                       ;; This dead simple definition works because the
1020                       ;; type system knows how to generate inline type
1021                       ;; tests for instances.
1022                       (typep x ',(dd-name dd))))
1023                  (info :function :inlinep predicate-name)
1024                  :inline))
1025           ((list vector)
1026            ;; Just punt. We could provide inline expansions for :TYPE
1027            ;; LIST and :TYPE VECTOR predicates too, but it'd be a
1028            ;; little messier and we don't bother. (Does anyway use
1029            ;; typed DEFSTRUCTs at all, let alone for high
1030            ;; performance?)
1031            ))))
1032
1033     (dolist (dsd (dd-slots dd))
1034       (let* ((accessor-name (dsd-accessor-name dsd))
1035              (dsd-type (dsd-type dsd)))
1036         (when accessor-name
1037           (let ((inherited (accessor-inherited-data accessor-name dd)))
1038             (cond
1039               ((not inherited)
1040                (multiple-value-bind (reader-designator writer-designator)
1041                    (slot-accessor-transforms dd dsd)
1042                  (sb!xc:proclaim `(ftype (sfunction (,dtype) ,dsd-type)
1043                                    ,accessor-name))
1044                  (setf (info :function :source-transform accessor-name)
1045                        reader-designator)
1046                  (unless (dsd-read-only dsd)
1047                    (let ((setf-accessor-name `(setf ,accessor-name)))
1048                      (sb!xc:proclaim
1049                       `(ftype (sfunction (,dsd-type ,dtype) ,dsd-type)
1050                         ,setf-accessor-name))
1051                      (setf (info :function :source-transform setf-accessor-name)
1052                            writer-designator)))))
1053               ((not (= (cdr inherited) (dsd-index dsd)))
1054                (style-warn "~@<Non-overwritten accessor ~S does not access ~
1055                             slot with name ~S (accessing an inherited slot ~
1056                             instead).~:@>"
1057                            accessor-name
1058                            (dsd-name dsd)))))))))
1059   (values))
1060 \f
1061 ;;;; redefinition stuff
1062
1063 ;;; Compare the slots of OLD and NEW, returning 3 lists of slot names:
1064 ;;;   1. Slots which have moved,
1065 ;;;   2. Slots whose type has changed,
1066 ;;;   3. Deleted slots.
1067 (defun compare-slots (old new)
1068   (let* ((oslots (dd-slots old))
1069          (nslots (dd-slots new))
1070          (onames (mapcar #'dsd-name oslots))
1071          (nnames (mapcar #'dsd-name nslots)))
1072     (collect ((moved)
1073               (retyped))
1074       (dolist (name (intersection onames nnames))
1075         (let ((os (find name oslots :key #'dsd-name :test #'string=))
1076               (ns (find name nslots :key #'dsd-name :test #'string=)))
1077           (unless (sb!xc:subtypep (dsd-type ns) (dsd-type os))
1078             (retyped name))
1079           (unless (and (= (dsd-index os) (dsd-index ns))
1080                        (eq (dsd-raw-type os) (dsd-raw-type ns)))
1081             (moved name))))
1082       (values (moved)
1083               (retyped)
1084               (set-difference onames nnames :test #'string=)))))
1085
1086 ;;; If we are redefining a structure with different slots than in the
1087 ;;; currently loaded version, give a warning and return true.
1088 (defun redefine-structure-warning (classoid old new)
1089   (declare (type defstruct-description old new)
1090            (type classoid classoid)
1091            (ignore classoid))
1092   (let ((name (dd-name new)))
1093     (multiple-value-bind (moved retyped deleted) (compare-slots old new)
1094       (when (or moved retyped deleted)
1095         (warn
1096          "incompatibly redefining slots of structure class ~S~@
1097           Make sure any uses of affected accessors are recompiled:~@
1098           ~@[  These slots were moved to new positions:~%    ~S~%~]~
1099           ~@[  These slots have new incompatible types:~%    ~S~%~]~
1100           ~@[  These slots were deleted:~%    ~S~%~]"
1101          name moved retyped deleted)
1102         t))))
1103
1104 ;;; This function is called when we are incompatibly redefining a
1105 ;;; structure CLASS to have the specified NEW-LAYOUT. We signal an
1106 ;;; error with some proceed options and return the layout that should
1107 ;;; be used.
1108 (defun %redefine-defstruct (classoid old-layout new-layout)
1109   (declare (type classoid classoid)
1110            (type layout old-layout new-layout))
1111   (let ((name (classoid-proper-name classoid)))
1112     (restart-case
1113         (error "~@<attempt to redefine the ~S class ~S incompatibly with the current definition~:@>"
1114                'structure-object
1115                name)
1116       (continue ()
1117        :report (lambda (s)
1118                  (format s
1119                          "~@<Use the new definition of ~S, invalidating ~
1120                           already-loaded code and instances.~@:>"
1121                          name))
1122        (register-layout new-layout))
1123       (recklessly-continue ()
1124        :report (lambda (s)
1125                  (format s
1126                          "~@<Use the new definition of ~S as if it were ~
1127                           compatible, allowing old accessors to use new ~
1128                           instances and allowing new accessors to use old ~
1129                           instances.~@:>"
1130                          name))
1131        ;; classic CMU CL warning: "Any old ~S instances will be in a bad way.
1132        ;; I hope you know what you're doing..."
1133        (register-layout new-layout
1134                         :invalidate nil
1135                         :destruct-layout old-layout))
1136       (clobber-it ()
1137        ;; FIXME: deprecated 2002-10-16, and since it's only interactive
1138        ;; hackery instead of a supported feature, can probably be deleted
1139        ;; in early 2003
1140        :report "(deprecated synonym for RECKLESSLY-CONTINUE)"
1141        (register-layout new-layout
1142                         :invalidate nil
1143                         :destruct-layout old-layout))))
1144   (values))
1145
1146 ;;; This is called when we are about to define a structure class. It
1147 ;;; returns a (possibly new) class object and the layout which should
1148 ;;; be used for the new definition (may be the current layout, and
1149 ;;; also might be an uninstalled forward referenced layout.) The third
1150 ;;; value is true if this is an incompatible redefinition, in which
1151 ;;; case it is the old layout.
1152 (defun ensure-structure-class (info inherits old-context new-context
1153                                     &key compiler-layout)
1154   (multiple-value-bind (class old-layout)
1155       (destructuring-bind
1156           (&optional
1157            name
1158            (class 'structure-classoid)
1159            (constructor 'make-structure-classoid))
1160           (dd-alternate-metaclass info)
1161         (declare (ignore name))
1162         (insured-find-classoid (dd-name info)
1163                                (if (eq class 'structure-classoid)
1164                                    (lambda (x)
1165                                      (sb!xc:typep x 'structure-classoid))
1166                                    (lambda (x)
1167                                      (sb!xc:typep x (classoid-name (find-classoid class)))))
1168                                (fdefinition constructor)))
1169     (setf (classoid-direct-superclasses class)
1170           (case (dd-name info)
1171             ((ansi-stream
1172               fd-stream
1173               sb!impl::string-input-stream sb!impl::string-output-stream
1174               sb!impl::fill-pointer-output-stream)
1175              (list (layout-classoid (svref inherits (1- (length inherits))))
1176                    (layout-classoid (svref inherits (- (length inherits) 2)))))
1177             (t
1178              (list (layout-classoid
1179                     (svref inherits (1- (length inherits))))))))
1180     (let ((new-layout (make-layout :classoid class
1181                                    :inherits inherits
1182                                    :depthoid (length inherits)
1183                                    :length (+ (dd-length info)
1184                                               (dd-raw-length info))
1185                                    :n-untagged-slots (dd-raw-length info)
1186                                    :info info))
1187           (old-layout (or compiler-layout old-layout)))
1188       (cond
1189        ((not old-layout)
1190         (values class new-layout nil))
1191        (;; This clause corresponds to an assertion in REDEFINE-LAYOUT-WARNING
1192         ;; of classic CMU CL. I moved it out to here because it was only
1193         ;; exercised in this code path anyway. -- WHN 19990510
1194         (not (eq (layout-classoid new-layout) (layout-classoid old-layout)))
1195         (error "shouldn't happen: weird state of OLD-LAYOUT?"))
1196        ((not *type-system-initialized*)
1197         (setf (layout-info old-layout) info)
1198         (values class old-layout nil))
1199        ((redefine-layout-warning old-context
1200                                  old-layout
1201                                  new-context
1202                                  (layout-length new-layout)
1203                                  (layout-inherits new-layout)
1204                                  (layout-depthoid new-layout)
1205                                  (layout-n-untagged-slots new-layout))
1206         (values class new-layout old-layout))
1207        (t
1208         (let ((old-info (layout-info old-layout)))
1209           (typecase old-info
1210             ((or defstruct-description)
1211              (cond ((redefine-structure-warning class old-info info)
1212                     (values class new-layout old-layout))
1213                    (t
1214                     (setf (layout-info old-layout) info)
1215                     (values class old-layout nil))))
1216             (null
1217              (setf (layout-info old-layout) info)
1218              (values class old-layout nil))
1219             (t
1220              (error "shouldn't happen! strange thing in LAYOUT-INFO:~%  ~S"
1221                     old-layout)
1222              (values class new-layout old-layout)))))))))
1223
1224 ;;; Blow away all the compiler info for the structure CLASS. Iterate
1225 ;;; over this type, clearing the compiler structure type info, and
1226 ;;; undefining all the associated functions.
1227 (defun undefine-structure (class)
1228   (let ((info (layout-info (classoid-layout class))))
1229     (when (defstruct-description-p info)
1230       (let ((type (dd-name info)))
1231         (remhash type *typecheckfuns*)
1232         (setf (info :type :compiler-layout type) nil)
1233         (undefine-fun-name (dd-copier-name info))
1234         (undefine-fun-name (dd-predicate-name info))
1235         (dolist (slot (dd-slots info))
1236           (let ((fun (dsd-accessor-name slot)))
1237             (unless (accessor-inherited-data fun info)
1238               (undefine-fun-name fun)
1239               (unless (dsd-read-only slot)
1240                 (undefine-fun-name `(setf ,fun)))))))
1241       ;; Clear out the SPECIFIER-TYPE cache so that subsequent
1242       ;; references are unknown types.
1243       (values-specifier-type-cache-clear)))
1244   (values))
1245 \f
1246 ;;; Return a list of pairs (name . index). Used for :TYPE'd
1247 ;;; constructors to find all the names that we have to splice in &
1248 ;;; where. Note that these types don't have a layout, so we can't look
1249 ;;; at LAYOUT-INHERITS.
1250 (defun find-name-indices (defstruct)
1251   (collect ((res))
1252     (let ((infos ()))
1253       (do ((info defstruct
1254                  (typed-structure-info-or-lose (first (dd-include info)))))
1255           ((not (dd-include info))
1256            (push info infos))
1257         (push info infos))
1258
1259       (let ((i 0))
1260         (dolist (info infos)
1261           (incf i (or (dd-offset info) 0))
1262           (when (dd-named info)
1263             (res (cons (dd-name info) i)))
1264           (setq i (dd-length info)))))
1265
1266     (res)))
1267 \f
1268 ;;; These functions are called to actually make a constructor after we
1269 ;;; have processed the arglist. The correct variant (according to the
1270 ;;; DD-TYPE) should be called. The function is defined with the
1271 ;;; specified name and arglist. VARS and TYPES are used for argument
1272 ;;; type declarations. VALUES are the values for the slots (in order.)
1273 ;;;
1274 ;;; This is split three ways because:
1275 ;;;   * LIST & VECTOR structures need "name" symbols stuck in at
1276 ;;;     various weird places, whereas STRUCTURE structures have
1277 ;;;     a LAYOUT slot.
1278 ;;;   * We really want to use LIST to make list structures, instead of
1279 ;;;     MAKE-LIST/(SETF ELT). (We can't in general use VECTOR in an
1280 ;;;     analogous way, since VECTOR makes a SIMPLE-VECTOR and vector-typed
1281 ;;;     structures can have arbitrary subtypes of VECTOR, not necessarily
1282 ;;;     SIMPLE-VECTOR.)
1283 ;;;   * STRUCTURE structures can have raw slots that must also be
1284 ;;;     allocated and indirectly referenced.
1285 (defun create-vector-constructor (dd cons-name arglist vars types values)
1286   (let ((temp (gensym))
1287         (etype (dd-element-type dd)))
1288     `(defun ,cons-name ,arglist
1289        (declare ,@(mapcar (lambda (var type) `(type (and ,type ,etype) ,var))
1290                           vars types))
1291        (let ((,temp (make-array ,(dd-length dd)
1292                                 :element-type ',(dd-element-type dd))))
1293          ,@(mapcar (lambda (x)
1294                      `(setf (aref ,temp ,(cdr x))  ',(car x)))
1295                    (find-name-indices dd))
1296          ,@(mapcar (lambda (dsd value)
1297                      (unless (eq value '.do-not-initialize-slot.)
1298                          `(setf (aref ,temp ,(dsd-index dsd)) ,value)))
1299                    (dd-slots dd) values)
1300          ,temp))))
1301 (defun create-list-constructor (dd cons-name arglist vars types values)
1302   (let ((vals (make-list (dd-length dd) :initial-element nil)))
1303     (dolist (x (find-name-indices dd))
1304       (setf (elt vals (cdr x)) `',(car x)))
1305     (loop for dsd in (dd-slots dd) and val in values do
1306       (setf (elt vals (dsd-index dsd))
1307             (if (eq val '.do-not-initialize-slot.) 0 val)))
1308
1309     `(defun ,cons-name ,arglist
1310        (declare ,@(mapcar (lambda (var type) `(type ,type ,var)) vars types))
1311        (list ,@vals))))
1312 (defun create-structure-constructor (dd cons-name arglist vars types values)
1313   (let* ((instance (gensym "INSTANCE")))
1314     `(defun ,cons-name ,arglist
1315        (declare ,@(mapcar (lambda (var type) `(type ,type ,var))
1316                           vars types))
1317        (let ((,instance (truly-the ,(dd-name dd)
1318                           (%make-instance-with-layout
1319                            (%delayed-get-compiler-layout ,(dd-name dd))))))
1320          ,@(mapcar (lambda (dsd value)
1321                      ;; (Note that we can't in general use the
1322                      ;; ordinary named slot setter function here
1323                      ;; because the slot might be :READ-ONLY, so we
1324                      ;; whip up new LAMBDA representations of slot
1325                      ;; setters for the occasion.)
1326                      (unless (eq value '.do-not-initialize-slot.)
1327                        `(,(slot-setter-lambda-form dd dsd) ,value ,instance)))
1328                    (dd-slots dd)
1329                    values)
1330          ,instance))))
1331
1332 ;;; Create a default (non-BOA) keyword constructor.
1333 (defun create-keyword-constructor (defstruct creator)
1334   (declare (type function creator))
1335   (collect ((arglist (list '&key))
1336             (types)
1337             (vals))
1338     (dolist (slot (dd-slots defstruct))
1339       (let ((dum (gensym))
1340             (name (dsd-name slot)))
1341         (arglist `((,(keywordicate name) ,dum) ,(dsd-default slot)))
1342         (types (dsd-type slot))
1343         (vals dum)))
1344     (funcall creator
1345              defstruct (dd-default-constructor defstruct)
1346              (arglist) (vals) (types) (vals))))
1347
1348 ;;; Given a structure and a BOA constructor spec, call CREATOR with
1349 ;;; the appropriate args to make a constructor.
1350 (defun create-boa-constructor (defstruct boa creator)
1351   (declare (type function creator))
1352   (multiple-value-bind (req opt restp rest keyp keys allowp auxp aux)
1353       (parse-lambda-list (second boa))
1354     (collect ((arglist)
1355               (vars)
1356               (types)
1357               (skipped-vars))
1358       (labels ((get-slot (name)
1359                  (let ((res (find name (dd-slots defstruct)
1360                                   :test #'string=
1361                                   :key #'dsd-name)))
1362                    (if res
1363                        (values (dsd-type res) (dsd-default res))
1364                        (values t nil))))
1365                (do-default (arg)
1366                  (multiple-value-bind (type default) (get-slot arg)
1367                    (arglist `(,arg ,default))
1368                    (vars arg)
1369                    (types type))))
1370         (dolist (arg req)
1371           (arglist arg)
1372           (vars arg)
1373           (types (get-slot arg)))
1374
1375         (when opt
1376           (arglist '&optional)
1377           (dolist (arg opt)
1378             (cond ((consp arg)
1379                    (destructuring-bind
1380                          ;; FIXME: this shares some logic (though not
1381                          ;; code) with the &key case below (and it
1382                          ;; looks confusing) -- factor out the logic
1383                          ;; if possible. - CSR, 2002-04-19
1384                          (name
1385                           &optional
1386                           (def (nth-value 1 (get-slot name)))
1387                           (supplied-test nil supplied-test-p))
1388                        arg
1389                      (arglist `(,name ,def ,@(if supplied-test-p `(,supplied-test) nil)))
1390                      (vars name)
1391                      (types (get-slot name))))
1392                   (t
1393                    (do-default arg)))))
1394
1395         (when restp
1396           (arglist '&rest rest)
1397           (vars rest)
1398           (types 'list))
1399
1400         (when keyp
1401           (arglist '&key)
1402           (dolist (key keys)
1403             (if (consp key)
1404                 (destructuring-bind (wot
1405                                      &optional
1406                                      (def nil def-p)
1407                                      (supplied-test nil supplied-test-p))
1408                     key
1409                   (let ((name (if (consp wot)
1410                                   (destructuring-bind (key var) wot
1411                                     (declare (ignore key))
1412                                     var)
1413                                   wot)))
1414                     (multiple-value-bind (type slot-def)
1415                         (get-slot name)
1416                       (arglist `(,wot ,(if def-p def slot-def)
1417                                  ,@(if supplied-test-p `(,supplied-test) nil)))
1418                       (vars name)
1419                       (types type))))
1420                 (do-default key))))
1421
1422         (when allowp (arglist '&allow-other-keys))
1423
1424         (when auxp
1425           (arglist '&aux)
1426           (dolist (arg aux)
1427             (arglist arg)
1428             (if (proper-list-of-length-p arg 2)
1429               (let ((var (first arg)))
1430                 (vars var)
1431                 (types (get-slot var)))
1432               (skipped-vars (if (consp arg) (first arg) arg))))))
1433
1434       (funcall creator defstruct (first boa)
1435                (arglist) (vars) (types)
1436                (loop for slot in (dd-slots defstruct)
1437                      for name = (dsd-name slot)
1438                      collect (cond ((find name (skipped-vars) :test #'string=)
1439                                     (setf (dsd-safe-p slot) nil)
1440                                     '.do-not-initialize-slot.)
1441                                    ((or (find (dsd-name slot) (vars) :test #'string=)
1442                                         (dsd-default slot)))))))))
1443
1444 ;;; Grovel the constructor options, and decide what constructors (if
1445 ;;; any) to create.
1446 (defun constructor-definitions (defstruct)
1447   (let ((no-constructors nil)
1448         (boas ())
1449         (defaults ())
1450         (creator (ecase (dd-type defstruct)
1451                    (structure #'create-structure-constructor)
1452                    (vector #'create-vector-constructor)
1453                    (list #'create-list-constructor))))
1454     (dolist (constructor (dd-constructors defstruct))
1455       (destructuring-bind (name &optional (boa-ll nil boa-p)) constructor
1456         (declare (ignore boa-ll))
1457         (cond ((not name) (setq no-constructors t))
1458               (boa-p (push constructor boas))
1459               (t (push name defaults)))))
1460
1461     (when no-constructors
1462       (when (or defaults boas)
1463         (error "(:CONSTRUCTOR NIL) combined with other :CONSTRUCTORs"))
1464       (return-from constructor-definitions ()))
1465
1466     (unless (or defaults boas)
1467       (push (symbolicate "MAKE-" (dd-name defstruct)) defaults))
1468
1469     (collect ((res) (names))
1470       (when defaults
1471         (let ((cname (first defaults)))
1472           (setf (dd-default-constructor defstruct) cname)
1473           (res (create-keyword-constructor defstruct creator))
1474           (names cname)
1475           (dolist (other-name (rest defaults))
1476             (res `(setf (fdefinition ',other-name) (fdefinition ',cname)))
1477             (names other-name))))
1478
1479       (dolist (boa boas)
1480         (res (create-boa-constructor defstruct boa creator))
1481         (names (first boa)))
1482
1483       (res `(declaim (ftype
1484                       (sfunction *
1485                                  ,(if (eq (dd-type defstruct) 'structure)
1486                                       (dd-name defstruct)
1487                                       '*))
1488                       ,@(names))))
1489
1490       (res))))
1491 \f
1492 ;;;; instances with ALTERNATE-METACLASS
1493 ;;;;
1494 ;;;; The CMU CL support for structures with ALTERNATE-METACLASS was a
1495 ;;;; fairly general extension embedded in the main DEFSTRUCT code, and
1496 ;;;; the result was an fairly impressive mess as ALTERNATE-METACLASS
1497 ;;;; extension mixed with ANSI CL generality (e.g. :TYPE and :INCLUDE)
1498 ;;;; and CMU CL implementation hairiness (esp. raw slots). This SBCL
1499 ;;;; version is much less ambitious, noticing that ALTERNATE-METACLASS
1500 ;;;; is only used to implement CONDITION, STANDARD-INSTANCE, and
1501 ;;;; GENERIC-FUNCTION, and defining a simple specialized
1502 ;;;; separate-from-DEFSTRUCT macro to provide only enough
1503 ;;;; functionality to support those.
1504 ;;;;
1505 ;;;; KLUDGE: The defining macro here is so specialized that it's ugly
1506 ;;;; in its own way. It also violates once-and-only-once by knowing
1507 ;;;; much about structures and layouts that is already known by the
1508 ;;;; main DEFSTRUCT macro. Hopefully it will go away presently
1509 ;;;; (perhaps when CL:CLASS and SB-PCL:CLASS meet) as per FIXME below.
1510 ;;;; -- WHN 2001-10-28
1511 ;;;;
1512 ;;;; FIXME: There seems to be no good reason to shoehorn CONDITION,
1513 ;;;; STANDARD-INSTANCE, and GENERIC-FUNCTION into mutated structures
1514 ;;;; instead of just implementing them as primitive objects. (This
1515 ;;;; reduced-functionality macro seems pretty close to the
1516 ;;;; functionality of DEFINE-PRIMITIVE-OBJECT..)
1517
1518 (defun make-dd-with-alternate-metaclass (&key (class-name (missing-arg))
1519                                               (superclass-name (missing-arg))
1520                                               (metaclass-name (missing-arg))
1521                                               (dd-type (missing-arg))
1522                                               metaclass-constructor
1523                                               slot-names)
1524   (let* ((dd (make-defstruct-description class-name))
1525          (conc-name (concatenate 'string (symbol-name class-name) "-"))
1526          (dd-slots (let ((reversed-result nil)
1527                          ;; The index starts at 1 for ordinary named
1528                          ;; slots because slot 0 is magical, used for
1529                          ;; the LAYOUT in CONDITIONs and
1530                          ;; FUNCALLABLE-INSTANCEs.  (This is the same
1531                          ;; in ordinary structures too: see (INCF
1532                          ;; DD-LENGTH) in
1533                          ;; PARSE-DEFSTRUCT-NAME-AND-OPTIONS).
1534                          (index 1))
1535                      (dolist (slot-name slot-names)
1536                        (push (make-defstruct-slot-description
1537                               :name slot-name
1538                               :index index
1539                               :accessor-name (symbolicate conc-name slot-name))
1540                              reversed-result)
1541                        (incf index))
1542                      (nreverse reversed-result))))
1543     (case dd-type
1544       ;; We don't support inheritance of alternate metaclass stuff,
1545       ;; and it's not a general-purpose facility, so sanity check our
1546       ;; own code.
1547       (structure
1548        (aver (eq superclass-name 't)))
1549       (funcallable-structure
1550        (aver (eq superclass-name 'function)))
1551       (t (bug "Unknown DD-TYPE in ALTERNATE-METACLASS: ~S" dd-type)))
1552     (setf (dd-alternate-metaclass dd) (list superclass-name
1553                                             metaclass-name
1554                                             metaclass-constructor)
1555           (dd-slots dd) dd-slots
1556           (dd-length dd) (1+ (length slot-names))
1557           (dd-type dd) dd-type)
1558     dd))
1559
1560 ;;; make !DEFSTRUCT-WITH-ALTERNATE-METACLASS compilable by the host
1561 ;;; lisp, installing the information we need to reason about the
1562 ;;; structures (layouts and classoids).
1563 ;;;
1564 ;;; FIXME: we should share the parsing and the DD construction between
1565 ;;; this and the cross-compiler version, but my brain was too small to
1566 ;;; get that right.  -- CSR, 2006-09-14
1567 #+sb-xc-host
1568 (defmacro !defstruct-with-alternate-metaclass
1569     (class-name &key
1570                 (slot-names (missing-arg))
1571                 (boa-constructor (missing-arg))
1572                 (superclass-name (missing-arg))
1573                 (metaclass-name (missing-arg))
1574                 (metaclass-constructor (missing-arg))
1575                 (dd-type (missing-arg))
1576                 predicate
1577                 (runtime-type-checks-p t))
1578
1579   (declare (type (and list (not null)) slot-names))
1580   (declare (type (and symbol (not null))
1581                  boa-constructor
1582                  superclass-name
1583                  metaclass-name
1584                  metaclass-constructor))
1585   (declare (type symbol predicate))
1586   (declare (type (member structure funcallable-structure) dd-type))
1587   (declare (ignore boa-constructor predicate runtime-type-checks-p))
1588
1589   (let* ((dd (make-dd-with-alternate-metaclass
1590               :class-name class-name
1591               :slot-names slot-names
1592               :superclass-name superclass-name
1593               :metaclass-name metaclass-name
1594               :metaclass-constructor metaclass-constructor
1595               :dd-type dd-type)))
1596     `(progn
1597
1598       (eval-when (:compile-toplevel :load-toplevel :execute)
1599         (%compiler-set-up-layout ',dd ',(inherits-for-structure dd))))))
1600
1601 (sb!xc:defmacro !defstruct-with-alternate-metaclass
1602     (class-name &key
1603                 (slot-names (missing-arg))
1604                 (boa-constructor (missing-arg))
1605                 (superclass-name (missing-arg))
1606                 (metaclass-name (missing-arg))
1607                 (metaclass-constructor (missing-arg))
1608                 (dd-type (missing-arg))
1609                 predicate
1610                 (runtime-type-checks-p t))
1611
1612   (declare (type (and list (not null)) slot-names))
1613   (declare (type (and symbol (not null))
1614                  boa-constructor
1615                  superclass-name
1616                  metaclass-name
1617                  metaclass-constructor))
1618   (declare (type symbol predicate))
1619   (declare (type (member structure funcallable-structure) dd-type))
1620
1621   (let* ((dd (make-dd-with-alternate-metaclass
1622               :class-name class-name
1623               :slot-names slot-names
1624               :superclass-name superclass-name
1625               :metaclass-name metaclass-name
1626               :metaclass-constructor metaclass-constructor
1627               :dd-type dd-type))
1628          (dd-slots (dd-slots dd))
1629          (dd-length (1+ (length slot-names)))
1630          (object-gensym (gensym "OBJECT"))
1631          (new-value-gensym (gensym "NEW-VALUE-"))
1632          (delayed-layout-form `(%delayed-get-compiler-layout ,class-name)))
1633     (multiple-value-bind (raw-maker-form raw-reffer-operator)
1634         (ecase dd-type
1635           (structure
1636            (values `(let ((,object-gensym (%make-instance ,dd-length)))
1637                       (setf (%instance-layout ,object-gensym)
1638                             ,delayed-layout-form)
1639                       ,object-gensym)
1640                    '%instance-ref))
1641           (funcallable-structure
1642            (values `(let ((,object-gensym
1643                            (%make-funcallable-instance ,dd-length)))
1644                       (setf (%funcallable-instance-layout ,object-gensym)
1645                             ,delayed-layout-form)
1646                       ,object-gensym)
1647                    '%funcallable-instance-info)))
1648       `(progn
1649
1650          (eval-when (:compile-toplevel :load-toplevel :execute)
1651            (%compiler-set-up-layout ',dd ',(inherits-for-structure dd)))
1652
1653          ;; slot readers and writers
1654          (declaim (inline ,@(mapcar #'dsd-accessor-name dd-slots)))
1655          ,@(mapcar (lambda (dsd)
1656                      `(defun ,(dsd-accessor-name dsd) (,object-gensym)
1657                         ,@(when runtime-type-checks-p
1658                             `((declare (type ,class-name ,object-gensym))))
1659                         (,raw-reffer-operator ,object-gensym
1660                                               ,(dsd-index dsd))))
1661                    dd-slots)
1662          (declaim (inline ,@(mapcar (lambda (dsd)
1663                                       `(setf ,(dsd-accessor-name dsd)))
1664                                     dd-slots)))
1665          ,@(mapcar (lambda (dsd)
1666                      `(defun (setf ,(dsd-accessor-name dsd)) (,new-value-gensym
1667                                                               ,object-gensym)
1668                         ,@(when runtime-type-checks-p
1669                             `((declare (type ,class-name ,object-gensym))))
1670                         (setf (,raw-reffer-operator ,object-gensym
1671                                                     ,(dsd-index dsd))
1672                               ,new-value-gensym)))
1673                    dd-slots)
1674
1675          ;; constructor
1676          (defun ,boa-constructor ,slot-names
1677            (let ((,object-gensym ,raw-maker-form))
1678              ,@(mapcar (lambda (slot-name)
1679                          (let ((dsd (find (symbol-name slot-name) dd-slots
1680                                           :key (lambda (x)
1681                                                  (symbol-name (dsd-name x)))
1682                                           :test #'string=)))
1683                            ;; KLUDGE: bug 117 bogowarning.  Neither
1684                            ;; DECLAREing the type nor TRULY-THE cut
1685                            ;; the mustard -- it still gives warnings.
1686                            (enforce-type dsd defstruct-slot-description)
1687                            `(setf (,(dsd-accessor-name dsd) ,object-gensym)
1688                                   ,slot-name)))
1689                        slot-names)
1690              ,object-gensym))
1691
1692          ;; predicate
1693          ,@(when predicate
1694              ;; Just delegate to the compiler's type optimization
1695              ;; code, which knows how to generate inline type tests
1696              ;; for the whole CMU CL INSTANCE menagerie.
1697              `(defun ,predicate (,object-gensym)
1698                 (typep ,object-gensym ',class-name)))))))
1699 \f
1700 ;;;; finalizing bootstrapping
1701
1702 ;;; Set up DD and LAYOUT for STRUCTURE-OBJECT class itself.
1703 ;;;
1704 ;;; Ordinary structure classes effectively :INCLUDE STRUCTURE-OBJECT
1705 ;;; when they have no explicit :INCLUDEs, so (1) it needs to be set up
1706 ;;; before we can define ordinary structure classes, and (2) it's
1707 ;;; special enough (and simple enough) that we just build it by hand
1708 ;;; instead of trying to generalize the ordinary DEFSTRUCT code.
1709 (defun !set-up-structure-object-class ()
1710   (let ((dd (make-defstruct-description 'structure-object)))
1711     (setf
1712      ;; Note: This has an ALTERNATE-METACLASS only because of blind
1713      ;; clueless imitation of the CMU CL code -- dunno if or why it's
1714      ;; needed. -- WHN
1715      (dd-alternate-metaclass dd) '(t)
1716      (dd-slots dd) nil
1717      (dd-length dd) 1
1718      (dd-type dd) 'structure)
1719     (%compiler-set-up-layout dd)))
1720 (!set-up-structure-object-class)
1721
1722 ;;; early structure predeclarations: Set up DD and LAYOUT for ordinary
1723 ;;; (non-ALTERNATE-METACLASS) structures which are needed early.
1724 (dolist (args
1725          '#.(sb-cold:read-from-file
1726              "src/code/early-defstruct-args.lisp-expr"))
1727   (let* ((dd (parse-defstruct-name-and-options-and-slot-descriptions
1728               (first args)
1729               (rest args)))
1730          (inherits (inherits-for-structure dd)))
1731     (%compiler-defstruct dd inherits)))
1732
1733 ;;; finding these beasts
1734 (defun find-defstruct-description (name &optional (errorp t))
1735   (let ((info (layout-info (classoid-layout (find-classoid name errorp)))))
1736     (if (defstruct-description-p info)
1737         info
1738         (when errorp
1739           (error "No DEFSTRUCT-DESCRIPTION for ~S." name)))))
1740
1741 (/show0 "code/defstruct.lisp end of file")