9c077f957eb941dc369965068adc945a88a0e24f
[sbcl.git] / src / pcl / std-class.lisp
1 ;;;; This software is part of the SBCL system. See the README file for
2 ;;;; more information.
3
4 ;;;; This software is derived from software originally released by Xerox
5 ;;;; Corporation. Copyright and release statements follow. Later modifications
6 ;;;; to the software are in the public domain and are provided with
7 ;;;; absolutely no warranty. See the COPYING and CREDITS files for more
8 ;;;; information.
9
10 ;;;; copyright information from original PCL sources:
11 ;;;;
12 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
13 ;;;; All rights reserved.
14 ;;;;
15 ;;;; Use and copying of this software and preparation of derivative works based
16 ;;;; upon this software are permitted. Any distribution of this software or
17 ;;;; derivative works must comply with all applicable United States export
18 ;;;; control laws.
19 ;;;;
20 ;;;; This software is made available AS IS, and Xerox Corporation makes no
21 ;;;; warranty about the software, its performance or its conformity to any
22 ;;;; specification.
23
24 (in-package "SB-PCL")
25 \f
26 (defmethod slot-accessor-function ((slotd effective-slot-definition) type)
27   (let ((info (slot-definition-info slotd)))
28     (ecase type
29       (reader (slot-info-reader info))
30       (writer (slot-info-writer info))
31       (boundp (slot-info-boundp info)))))
32
33 (defmethod (setf slot-accessor-function) (function
34                                           (slotd effective-slot-definition)
35                                           type)
36   (let ((info (slot-definition-info slotd)))
37     (ecase type
38       (reader (setf (slot-info-reader info) function))
39       (writer (setf (slot-info-writer info) function))
40       (boundp (setf (slot-info-boundp info) function)))))
41
42 (defconstant +slotd-reader-function-std-p+ 1)
43 (defconstant +slotd-writer-function-std-p+ 2)
44 (defconstant +slotd-boundp-function-std-p+ 4)
45 (defconstant +slotd-all-function-std-p+ 7)
46
47 (defmethod slot-accessor-std-p ((slotd effective-slot-definition) type)
48   (let ((flags (slot-value slotd 'accessor-flags)))
49     (declare (type fixnum flags))
50     (if (eq type 'all)
51         (eql +slotd-all-function-std-p+ flags)
52         (let ((mask (ecase type
53                       (reader +slotd-reader-function-std-p+)
54                       (writer +slotd-writer-function-std-p+)
55                       (boundp +slotd-boundp-function-std-p+))))
56           (declare (type fixnum mask))
57           (not (zerop (the fixnum (logand mask flags))))))))
58
59 (defmethod (setf slot-accessor-std-p) (value
60                                        (slotd effective-slot-definition)
61                                        type)
62   (let ((mask (ecase type
63                 (reader +slotd-reader-function-std-p+)
64                 (writer +slotd-writer-function-std-p+)
65                 (boundp +slotd-boundp-function-std-p+)))
66         (flags (slot-value slotd 'accessor-flags)))
67     (declare (type fixnum mask flags))
68     (setf (slot-value slotd 'accessor-flags)
69           (if value
70               (the fixnum (logior mask flags))
71               (the fixnum (logand (the fixnum (lognot mask)) flags)))))
72   value)
73
74 (defmethod initialize-internal-slot-functions
75     ((slotd effective-slot-definition))
76   (let* ((name (slot-value slotd 'name))
77          (class (slot-value slotd '%class)))
78     (dolist (type '(reader writer boundp))
79       (let* ((gf-name (ecase type
80                               (reader 'slot-value-using-class)
81                               (writer '(setf slot-value-using-class))
82                               (boundp 'slot-boundp-using-class)))
83              (gf (gdefinition gf-name)))
84         ;; KLUDGE: this logic is cut'n'pasted from
85         ;; GET-ACCESSOR-METHOD-FUNCTION, which (for STD-CLASSes) is
86         ;; only called later, because it does things that can't be
87         ;; computed this early in class finalization; however, we need
88         ;; this bit as early as possible.  -- CSR, 2009-11-05
89         (setf (slot-accessor-std-p slotd type)
90               (let* ((std-method (standard-svuc-method type))
91                      (str-method (structure-svuc-method type))
92                      (types1 `((eql ,class) (class-eq ,class) (eql ,slotd)))
93                      (types (if (eq type 'writer) `(t ,@types1) types1))
94                      (methods (compute-applicable-methods-using-types gf types)))
95                 (null (cdr methods))))
96         (setf (slot-accessor-function slotd type)
97               (lambda (&rest args)
98                 (declare (dynamic-extent args))
99                 ;; FIXME: a tiny amount of wasted SLOT-ACCESSOR-STD-P
100                 ;; work here (see KLUDGE comment above).
101                 (let ((fun (compute-slot-accessor-info slotd type gf)))
102                   (apply fun args))))))))
103
104 (defmethod finalize-internal-slot-functions ((slotd effective-slot-definition))
105   (dolist (type '(reader writer boundp))
106     (let* ((gf-name (ecase type
107                       (reader 'slot-value-using-class)
108                       (writer '(setf slot-value-using-class))
109                       (boundp 'slot-boundp-using-class)))
110            (gf (gdefinition gf-name)))
111       (compute-slot-accessor-info slotd type gf))))
112
113 ;;; CMUCL (Gerd PCL 2003-04-25) comment:
114 ;;;
115 ;;; Compute an effective method for SLOT-VALUE-USING-CLASS, (SETF
116 ;;; SLOT-VALUE-USING-CLASS) or SLOT-BOUNDP-USING-CLASS for reading/
117 ;;; writing/testing effective slot SLOTD.
118 ;;;
119 ;;; TYPE is one of the symbols READER, WRITER or BOUNDP, depending on
120 ;;; GF.  Store the effective method in the effective slot definition
121 ;;; object itself; these GFs have special dispatch functions calling
122 ;;; effective methods directly retrieved from effective slot
123 ;;; definition objects, as an optimization.
124 ;;;
125 ;;; FIXME: Change the function name to COMPUTE-SVUC-SLOTD-FUNCTION,
126 ;;; or some such.
127 (defmethod compute-slot-accessor-info ((slotd effective-slot-definition)
128                                        type gf)
129   (let* ((name (slot-value slotd 'name))
130          (class (slot-value slotd '%class)))
131     (multiple-value-bind (function std-p)
132         (if (eq **boot-state** 'complete)
133             (get-accessor-method-function gf type class slotd)
134             (get-optimized-std-accessor-method-function class slotd type))
135       (setf (slot-accessor-std-p slotd type) std-p)
136       (setf (slot-accessor-function slotd type) function))))
137
138 (defmethod slot-definition-allocation ((slotd structure-slot-definition))
139   :instance)
140 \f
141 ;;;; various class accessors that are a little more complicated than can be
142 ;;;; done with automatically generated reader methods
143
144 (defmethod class-prototype :before (class)
145   (unless (class-finalized-p class)
146     (error "~@<~S is not finalized.~:@>" class)))
147
148 ;;; KLUDGE: For some reason factoring the common body into a function
149 ;;; breaks PCL bootstrapping, so just generate it with a macrolet for
150 ;;; all.
151 (macrolet ((def (class)
152              `(defmethod class-prototype ((class ,class))
153                 (with-slots (prototype) class
154                   (or prototype
155                       (setf prototype (allocate-instance class)))))))
156   (def std-class)
157   (def condition-class)
158   (def structure-class))
159
160 (defmethod class-direct-default-initargs ((class slot-class))
161   (plist-value class 'direct-default-initargs))
162
163 (defmethod class-default-initargs ((class slot-class))
164   (plist-value class 'default-initargs))
165
166 (defmethod class-slot-cells ((class std-class))
167   (plist-value class 'class-slot-cells))
168 (defmethod (setf class-slot-cells) (new-value (class std-class))
169   (setf (plist-value class 'class-slot-cells) new-value))
170 \f
171 ;;;; class accessors that are even a little bit more complicated than those
172 ;;;; above. These have a protocol for updating them, we must implement that
173 ;;;; protocol.
174
175 ;;; Maintaining the direct subclasses backpointers. The update methods are
176 ;;; here, the values are read by an automatically generated reader method.
177 (defmethod add-direct-subclass ((class class) (subclass class))
178   (with-slots (direct-subclasses) class
179     (pushnew subclass direct-subclasses :test #'eq)
180     subclass))
181 (defmethod remove-direct-subclass ((class class) (subclass class))
182   (with-slots (direct-subclasses) class
183     (setq direct-subclasses (remove subclass direct-subclasses))
184     subclass))
185
186 ;;; Maintaining the direct-methods and direct-generic-functions backpointers.
187 ;;;
188 ;;; There are four generic functions involved, each has one method for the
189 ;;; class case and another method for the damned EQL specializers. All of
190 ;;; these are specified methods and appear in their specified place in the
191 ;;; class graph.
192 ;;;
193 ;;;   ADD-DIRECT-METHOD
194 ;;;   REMOVE-DIRECT-METHOD
195 ;;;   SPECIALIZER-DIRECT-METHODS
196 ;;;   SPECIALIZER-DIRECT-GENERIC-FUNCTIONS
197 ;;;
198 ;;; In each case, we maintain one value which is a cons. The car is the list
199 ;;; methods. The cdr is a list of the generic functions. The cdr is always
200 ;;; computed lazily.
201
202 ;;; This needs to be used recursively, in case a non-trivial user
203 ;;; defined ADD/REMOVE-DIRECT-METHOD method ends up calling another
204 ;;; function using the same lock.
205 (defvar *specializer-lock* (sb-thread:make-mutex :name "Specializer lock"))
206
207 (defmethod add-direct-method :around ((specializer specializer) method)
208   ;; All the actions done under this lock are done in an order
209   ;; that is safe to unwind at any point.
210   (sb-thread::with-recursive-system-lock (*specializer-lock*)
211     (call-next-method)))
212
213 (defmethod remove-direct-method :around ((specializer specializer) method)
214   ;; All the actions done under this lock are done in an order
215   ;; that is safe to unwind at any point.
216   (sb-thread::with-recursive-system-lock (*specializer-lock*)
217     (call-next-method)))
218
219 (defmethod add-direct-method ((specializer class) (method method))
220   (let ((cell (slot-value specializer 'direct-methods)))
221     ;; We need to first smash the CDR, because a parallel read may
222     ;; be in progress, and because if an interrupt catches us we
223     ;; need to have a consistent state.
224     (setf (cdr cell) ()
225           (car cell) (adjoin method (car cell) :test #'eq)))
226   method)
227
228 (defmethod remove-direct-method ((specializer class) (method method))
229   (let ((cell (slot-value specializer 'direct-methods)))
230     ;; We need to first smash the CDR, because a parallel read may
231     ;; be in progress, and because if an interrupt catches us we
232     ;; need to have a consistent state.
233     (setf (cdr cell) ()
234           (car cell) (remove method (car cell))))
235   method)
236
237 (defmethod specializer-direct-methods ((specializer class))
238   (with-slots (direct-methods) specializer
239     (car direct-methods)))
240
241 (defmethod specializer-direct-generic-functions ((specializer class))
242   (let ((cell (slot-value specializer 'direct-methods)))
243     ;; If an ADD/REMOVE-METHOD is in progress, no matter: either
244     ;; we behave as if we got just first or just after -- it's just
245     ;; for update that we need to lock.
246     (or (cdr cell)
247         (sb-thread:with-mutex (*specializer-lock*)
248           (setf (cdr cell)
249                 (let (collect)
250                   (dolist (m (car cell))
251                     ;; the old PCL code used COLLECTING-ONCE which used
252                     ;; #'EQ to check for newness
253                     (pushnew (method-generic-function m) collect :test #'eq))
254                   (nreverse collect)))))))
255 \f
256 ;;; This hash table is used to store the direct methods and direct generic
257 ;;; functions of EQL specializers. Each value in the table is the cons.
258 ;;;
259 ;;; These tables are shared between threads, so they need to be synchronized.
260 (defvar *eql-specializer-methods* (make-hash-table :test 'eql :synchronized t))
261 (defvar *class-eq-specializer-methods* (make-hash-table :test 'eq :synchronized t))
262
263 (defmethod specializer-method-table ((specializer eql-specializer))
264   *eql-specializer-methods*)
265
266 (defmethod specializer-method-table ((specializer class-eq-specializer))
267   *class-eq-specializer-methods*)
268
269 (defmethod add-direct-method ((specializer specializer-with-object)
270                               (method method))
271   (let* ((object (specializer-object specializer))
272          (table (specializer-method-table specializer))
273          (entry (gethash object table)))
274     (unless entry
275       (setf entry
276             (setf (gethash object table) (cons nil nil))))
277     ;; We need to first smash the CDR, because a parallel read may
278     ;; be in progress, and because if an interrupt catches us we
279     ;; need to have a consistent state.
280     (setf (cdr entry) ()
281           (car entry) (adjoin method (car entry) :test #'eq))
282     method))
283
284 (defmethod remove-direct-method ((specializer specializer-with-object)
285                                  (method method))
286   (let* ((object (specializer-object specializer))
287          (entry (gethash object (specializer-method-table specializer))))
288     (when entry
289       ;; We need to first smash the CDR, because a parallel read may
290       ;; be in progress, and because if an interrupt catches us we
291       ;; need to have a consistent state.
292       (setf (cdr entry) ()
293             (car entry) (remove method (car entry))))
294     method))
295
296 (defmethod specializer-direct-methods ((specializer specializer-with-object))
297   (car (gethash (specializer-object specializer)
298                 (specializer-method-table specializer))))
299
300 (defmethod specializer-direct-generic-functions ((specializer
301                                                   specializer-with-object))
302   (let* ((object (specializer-object specializer))
303          (entry (gethash object (specializer-method-table specializer))))
304     (when entry
305       (or (cdr entry)
306           (sb-thread:with-mutex (*specializer-lock*)
307             (setf (cdr entry)
308                   (let (collect)
309                     (dolist (m (car entry))
310                       (pushnew (method-generic-function m) collect :test #'eq))
311                     (nreverse collect))))))))
312
313 (defun map-specializers (function)
314   (map-all-classes (lambda (class)
315                      (funcall function (class-eq-specializer class))
316                      (funcall function class)))
317   (maphash (lambda (object methods)
318              (declare (ignore methods))
319              (intern-eql-specializer object))
320            *eql-specializer-methods*)
321   (maphash (lambda (object specl)
322              (declare (ignore object))
323              (funcall function specl))
324            *eql-specializer-table*)
325   nil)
326
327 (defun map-all-generic-functions (function)
328   (let ((all-generic-functions (make-hash-table :test 'eq)))
329     (map-specializers (lambda (specl)
330                         (dolist (gf (specializer-direct-generic-functions
331                                      specl))
332                           (unless (gethash gf all-generic-functions)
333                             (setf (gethash gf all-generic-functions) t)
334                             (funcall function gf))))))
335   nil)
336
337 (defmethod shared-initialize :after ((specl class-eq-specializer)
338                                      slot-names
339                                      &key)
340   (declare (ignore slot-names))
341   (setf (slot-value specl '%type) `(class-eq ,(specializer-class specl))))
342
343 (defmethod shared-initialize :after ((specl eql-specializer) slot-names &key)
344   (declare (ignore slot-names))
345   (setf (slot-value specl '%type)
346         `(eql ,(specializer-object specl)))
347   (setf (info :type :translator specl)
348         (constantly (make-member-type :members (list (specializer-object specl))))))
349
350 (defun real-load-defclass (name metaclass-name supers slots other
351                            readers writers slot-names source-location safe-p)
352   (with-single-package-locked-error (:symbol name "defining ~S as a class")
353     (%compiler-defclass name readers writers slot-names)
354     (let ((res (apply #'ensure-class name :metaclass metaclass-name
355                       :direct-superclasses supers
356                       :direct-slots slots
357                       :definition-source source-location
358                       'safe-p safe-p
359                       other)))
360       res)))
361
362 (setf (gdefinition 'load-defclass) #'real-load-defclass)
363
364 (defun ensure-class (name &rest args)
365   (with-world-lock ()
366     (apply #'ensure-class-using-class
367            (let ((class (find-class name nil)))
368              (when (and class (eq name (class-name class)))
369                ;; NAME is the proper name of CLASS, so redefine it
370                class))
371            name
372            args)))
373
374 (defmethod ensure-class-using-class ((class null) name &rest args &key)
375   (with-world-lock ()
376     (multiple-value-bind (meta initargs)
377         (frob-ensure-class-args args)
378       (setf class (apply #'make-instance meta :name name initargs))
379       (without-package-locks
380         (setf (find-class name) class))))
381   ;; After boot (SETF FIND-CLASS) does this.
382   (unless (eq **boot-state** 'complete)
383     (%set-class-type-translation class name))
384   class)
385
386 (defmethod ensure-class-using-class ((class pcl-class) name &rest args &key)
387   (with-world-lock ()
388     (multiple-value-bind (meta initargs)
389         (frob-ensure-class-args args)
390       (unless (eq (class-of class) meta)
391         (apply #'change-class class meta initargs))
392       (apply #'reinitialize-instance class initargs)
393       (without-package-locks
394         (setf (find-class name) class))))
395   ;; After boot (SETF FIND-CLASS) does this.
396   (unless (eq **boot-state** 'complete)
397     (%set-class-type-translation class name))
398   class)
399
400 (defun frob-ensure-class-args (args)
401   (let (metaclass metaclassp reversed-plist)
402     (flet ((frob-superclass (s)
403              (cond
404                ((classp s) s)
405                ((legal-class-name-p s)
406                 (or (find-class s nil)
407                     (ensure-class s :metaclass 'forward-referenced-class)))
408                (t (error "Not a class or a legal class name: ~S." s)))))
409       (doplist (key val) args
410         (cond ((eq key :metaclass)
411                (unless metaclassp
412                  (setf metaclass val metaclassp key)))
413               (t
414                (when (eq key :direct-superclasses)
415                  (setf val (mapcar #'frob-superclass val)))
416                (setf reversed-plist (list* val key reversed-plist)))))
417       (values (cond (metaclassp
418                      (if (classp metaclass)
419                          metaclass
420                          (find-class metaclass)))
421                     (t *the-class-standard-class*))
422               (nreverse reversed-plist)))))
423
424 ;;; This is used to call initfunctions of :allocation :class slots.
425 (defun call-initfun (fun slotd safe)
426   (declare (function fun))
427   (let ((value (funcall fun)))
428     (when safe
429       (let ((type (slot-definition-type slotd)))
430         (unless (or (eq t type)
431                     (typep value type))
432           (error 'type-error :expected-type type :datum value))))
433     value))
434 \f
435 (defmethod shared-initialize :after
436     ((class std-class) slot-names &key
437      (direct-superclasses nil direct-superclasses-p)
438      (direct-slots nil direct-slots-p)
439      (direct-default-initargs nil direct-default-initargs-p)
440      definition-source)
441   (cond (direct-superclasses-p
442          (setq direct-superclasses
443                (or direct-superclasses
444                    (list (if (funcallable-standard-class-p class)
445                              *the-class-funcallable-standard-object*
446                              *the-class-standard-object*))))
447          (dolist (superclass direct-superclasses)
448            (unless (validate-superclass class superclass)
449              (error "~@<The class ~S was specified as a ~
450                      super-class of the class ~S, ~
451                      but the meta-classes ~S and ~S are incompatible.  ~
452                      Define a method for ~S to avoid this error.~@:>"
453                     superclass class (class-of superclass) (class-of class)
454                     'validate-superclass)))
455          (setf (slot-value class 'direct-superclasses) direct-superclasses))
456         (t
457          (setq direct-superclasses (slot-value class 'direct-superclasses))))
458   (setq direct-slots
459         (if direct-slots-p
460             (setf (slot-value class 'direct-slots)
461                   (mapcar (lambda (pl) (make-direct-slotd class pl))
462                           direct-slots))
463             (slot-value class 'direct-slots)))
464   (if direct-default-initargs-p
465       (setf (plist-value class 'direct-default-initargs)
466             direct-default-initargs)
467       (setq direct-default-initargs
468             (plist-value class 'direct-default-initargs)))
469   (setf (plist-value class 'class-slot-cells)
470         (let ((old-class-slot-cells (plist-value class 'class-slot-cells))
471               (safe (safe-p class))
472               (collect '()))
473           (dolist (dslotd direct-slots)
474             (when (eq :class (slot-definition-allocation dslotd))
475               ;; see CLHS 4.3.6
476               (let* ((name (slot-definition-name dslotd))
477                      (old (assoc name old-class-slot-cells)))
478                 (if (or (not old)
479                         (eq t slot-names)
480                         (member name slot-names :test #'eq))
481                     (let* ((initfunction (slot-definition-initfunction dslotd))
482                            (value
483                             (if initfunction
484                                 (call-initfun initfunction dslotd safe)
485                                 +slot-unbound+)))
486                       (push (cons name value) collect))
487                     (push old collect)))))
488           (nreverse collect)))
489   (add-direct-subclasses class direct-superclasses)
490   (if (class-finalized-p class)
491       ;; required by AMOP, "Reinitialization of Class Metaobjects"
492       (finalize-inheritance class)
493       (update-class class nil))
494   (add-slot-accessors class direct-slots definition-source)
495   (make-preliminary-layout class))
496
497 (defmethod shared-initialize :after ((class forward-referenced-class)
498                                      slot-names &key &allow-other-keys)
499   (declare (ignore slot-names))
500   (make-preliminary-layout class))
501
502 (defvar *allow-forward-referenced-classes-in-cpl-p* nil)
503
504 ;;; Give CLASS a preliminary layout if it doesn't have one already, to
505 ;;; make it known to the type system.
506 (defun make-preliminary-layout (class)
507   (flet ((compute-preliminary-cpl (root)
508            (let ((*allow-forward-referenced-classes-in-cpl-p* t))
509              (compute-class-precedence-list root))))
510     (with-world-lock ()
511       (without-package-locks
512         (unless (class-finalized-p class)
513           (let ((name (class-name class)))
514             ;; KLUDGE: This is fairly horrible.  We need to make a
515             ;; full-fledged CLASSOID here, not just tell the compiler that
516             ;; some class is forthcoming, because there are legitimate
517             ;; questions one can ask of the type system, implemented in
518             ;; terms of CLASSOIDs, involving forward-referenced classes. So.
519             (let ((layout (make-wrapper 0 class)))
520               (setf (slot-value class 'wrapper) layout)
521               (let ((cpl (compute-preliminary-cpl class)))
522                 (setf (layout-inherits layout)
523                       (order-layout-inherits
524                        (map 'simple-vector #'class-wrapper
525                             (reverse (rest cpl))))))
526               (register-layout layout :invalidate t)
527               (%set-class-type-translation class (layout-classoid layout)))))
528         (mapc #'make-preliminary-layout (class-direct-subclasses class))))))
529
530
531 (defmethod shared-initialize :before ((class class) slot-names &key name)
532   (declare (ignore slot-names name))
533   ;; FIXME: Could this just be CLASS instead of `(CLASS ,CLASS)? If not,
534   ;; why not? (See also similar expression in !BOOTSTRAP-INITIALIZE-CLASS.)
535   (setf (slot-value class '%type) `(class ,class))
536   (setf (slot-value class 'class-eq-specializer)
537         (make-instance 'class-eq-specializer :class class)))
538
539 (defmethod reinitialize-instance :before ((class slot-class) &key direct-superclasses)
540   (dolist (old-super (set-difference (class-direct-superclasses class) direct-superclasses))
541     (remove-direct-subclass old-super class))
542   (remove-slot-accessors class (class-direct-slots class)))
543
544 (defmethod reinitialize-instance :after ((class slot-class)
545                                          &rest initargs
546                                          &key)
547   (map-dependents class
548                   (lambda (dependent)
549                     (apply #'update-dependent class dependent initargs))))
550
551 (defmethod reinitialize-instance :after ((class condition-class) &key)
552   (let* ((name (class-name class))
553          (classoid (find-classoid name))
554          (slots (condition-classoid-slots classoid)))
555     ;; to balance the REMOVE-SLOT-ACCESSORS call in
556     ;; REINITIALIZE-INSTANCE :BEFORE (SLOT-CLASS).
557     (dolist (slot slots)
558       (let ((slot-name (condition-slot-name slot)))
559         (dolist (reader (condition-slot-readers slot))
560           ;; FIXME: see comment in SHARED-INITIALIZE :AFTER
561           ;; (CONDITION-CLASS T), below.  -- CSR, 2005-11-18
562           (sb-kernel::install-condition-slot-reader reader name slot-name))
563         (dolist (writer (condition-slot-writers slot))
564           (sb-kernel::install-condition-slot-writer writer name slot-name))))))
565
566 (defmethod shared-initialize :after ((class condition-class) slot-names
567                                      &key direct-slots direct-superclasses)
568   (declare (ignore slot-names))
569   (let ((classoid (find-classoid (slot-value class 'name))))
570     (with-slots (wrapper %class-precedence-list cpl-available-p
571                          prototype (direct-supers direct-superclasses))
572         class
573       (setf (slot-value class 'direct-slots)
574             (mapcar (lambda (pl) (make-direct-slotd class pl))
575                     direct-slots))
576       (setf (slot-value class 'finalized-p) t)
577       (setf (classoid-pcl-class classoid) class)
578       (setq direct-supers direct-superclasses)
579       (setq wrapper (classoid-layout classoid))
580       (setq %class-precedence-list (compute-class-precedence-list class))
581       (setq cpl-available-p t)
582       (add-direct-subclasses class direct-superclasses)
583       (let ((slots (compute-slots class)))
584         (setf (slot-value class 'slots) slots)
585         (setf (layout-slot-table wrapper) (make-slot-table class slots)))))
586   ;; Comment from Gerd's PCL, 2003-05-15:
587   ;;
588   ;; We don't ADD-SLOT-ACCESSORS here because we don't want to
589   ;; override condition accessors with generic functions.  We do this
590   ;; differently.
591   ;;
592   ;; ??? What does the above comment mean and why is it a good idea?
593   ;; CMUCL (which still as of 2005-11-18 uses this code and has this
594   ;; comment) loses slot information in its condition classes:
595   ;; DIRECT-SLOTS is always NIL.  We have the right information, so we
596   ;; remove slot accessors but never put them back.  I've added a
597   ;; REINITIALIZE-INSTANCE :AFTER (CONDITION-CLASS) method, but what
598   ;; was meant to happen?  -- CSR, 2005-11-18
599   )
600
601 (defmethod direct-slot-definition-class ((class condition-class)
602                                          &rest initargs)
603   (declare (ignore initargs))
604   (find-class 'condition-direct-slot-definition))
605
606 (defmethod effective-slot-definition-class ((class condition-class)
607                                             &rest initargs)
608   (declare (ignore initargs))
609   (find-class 'condition-effective-slot-definition))
610
611 (defmethod finalize-inheritance ((class condition-class))
612   (aver (slot-value class 'finalized-p))
613   nil)
614
615 (defmethod compute-effective-slot-definition
616     ((class condition-class) slot-name dslotds)
617   (let* ((slotd (call-next-method))
618          (info (slot-definition-info slotd)))
619     (setf (slot-info-reader info)
620           (lambda (x)
621             (handler-case (condition-reader-function x slot-name)
622               ;; FIXME: FIND-SLOT-DEFAULT throws an error if the slot
623               ;; is unbound; maybe it should be a CELL-ERROR of some
624               ;; sort?
625               (error () (values (slot-unbound class x slot-name))))))
626     (setf (slot-info-writer info)
627           (lambda (v x)
628             (condition-writer-function x v slot-name)))
629     (setf (slot-info-boundp info)
630           (lambda (x)
631             (multiple-value-bind (v c)
632                 (ignore-errors (condition-reader-function x slot-name))
633               (declare (ignore v))
634               (null c))))
635     slotd))
636
637 (defmethod compute-slots ((class condition-class))
638   (mapcan (lambda (superclass)
639             (mapcar (lambda (dslotd)
640                       (compute-effective-slot-definition
641                        class (slot-definition-name dslotd) (list dslotd)))
642                     (class-direct-slots superclass)))
643           (reverse (slot-value class '%class-precedence-list))))
644
645 (defmethod compute-slots :around ((class condition-class))
646   (let ((eslotds (call-next-method)))
647     (mapc #'finalize-internal-slot-functions eslotds)
648     eslotds))
649
650 (defmethod shared-initialize :after
651     ((slotd structure-slot-definition) slot-names &key
652      (allocation :instance) allocation-class)
653   (declare (ignore slot-names allocation-class))
654   (unless (eq allocation :instance)
655     (error "Structure slots must have :INSTANCE allocation.")))
656
657 (defun make-structure-class-defstruct-form (name direct-slots include)
658   (let* ((conc-name (format-symbol *package* "~S structure class " name))
659          (constructor (format-symbol *package* "~Aconstructor" conc-name))
660          (included-name (class-name include))
661          (included-slots
662           (when include
663             (mapcar #'dsd-name (dd-slots (find-defstruct-description included-name)))))
664          (old-slots nil)
665          (new-slots nil)
666          (reader-names nil)
667          (writer-names nil))
668     (dolist (slotd (reverse direct-slots))
669       (let* ((slot-name (slot-definition-name slotd))
670              (initform (slot-definition-initform slotd))
671              (type (slot-definition-type slotd))
672              (desc `(,slot-name ,initform :type ,type)))
673         (push `(slot-accessor ,name ,slot-name reader)
674               reader-names)
675         (push `(slot-accessor ,name ,slot-name writer)
676               writer-names)
677         (if (member slot-name included-slots :test #'eq)
678             (push desc old-slots)
679             (push desc new-slots))))
680     (let* ((defstruct `(defstruct (,name
681                                     ,@(when include
682                                             `((:include ,included-name
683                                                         ,@old-slots)))
684                                     (:constructor ,constructor ())
685                                     (:predicate nil)
686                                     (:conc-name ,conc-name)
687                                     (:copier nil))
688                          ,@new-slots))
689            (readers-init
690             (mapcar (lambda (slotd reader-name)
691                       (let ((accessor
692                              (slot-definition-defstruct-accessor-symbol
693                               slotd)))
694                         `(defun ,reader-name (obj)
695                            (declare (type ,name obj))
696                            (,accessor obj))))
697                     direct-slots reader-names))
698            (writers-init
699             (mapcar (lambda (slotd writer-name)
700                       (let ((accessor
701                              (slot-definition-defstruct-accessor-symbol
702                               slotd)))
703                         `(defun ,writer-name (nv obj)
704                            (declare (type ,name obj))
705                            (setf (,accessor obj) nv))))
706                     direct-slots writer-names))
707            (defstruct-form
708             `(progn
709                ,defstruct
710                ,@readers-init ,@writers-init
711                (cons nil nil))))
712       (values defstruct-form constructor reader-names writer-names))))
713
714 (defun make-defstruct-allocation-function (name)
715   ;; FIXME: Why don't we go class->layout->info == dd
716   (let ((dd (find-defstruct-description name)))
717     (ecase (dd-type dd)
718       (structure
719        (%make-structure-instance-allocator dd nil))
720       (funcallable-structure
721        (%make-funcallable-structure-instance-allocator dd nil)))))
722
723 (defmethod shared-initialize :after
724     ((class structure-class) slot-names &key
725      (direct-superclasses nil direct-superclasses-p)
726      (direct-slots nil direct-slots-p)
727      direct-default-initargs
728      definition-source)
729   (declare (ignore slot-names direct-default-initargs))
730   (if direct-superclasses-p
731       (setf (slot-value class 'direct-superclasses)
732             (or direct-superclasses
733                 (setq direct-superclasses
734                       (and (not (eq (slot-value class 'name) 'structure-object))
735                            (list *the-class-structure-object*)))))
736       (setq direct-superclasses (slot-value class 'direct-superclasses)))
737   (let* ((name (slot-value class 'name))
738          (from-defclass-p (slot-value class 'from-defclass-p))
739          (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
740     (if direct-slots-p
741         (setf (slot-value class 'direct-slots)
742               (setq direct-slots
743                     (mapcar (lambda (pl)
744                               (when defstruct-p
745                                 (let* ((slot-name (getf pl :name))
746                                        (accessor
747                                         (format-symbol *package*
748                                                        "~S structure class ~A"
749                                                        name slot-name)))
750                                   (setq pl (list* :defstruct-accessor-symbol
751                                                   accessor pl))))
752                               (make-direct-slotd class pl))
753                             direct-slots)))
754         (setq direct-slots (slot-value class 'direct-slots)))
755     (if defstruct-p
756         (let ((include (car (slot-value class 'direct-superclasses))))
757           (multiple-value-bind (defstruct-form constructor reader-names writer-names)
758               (make-structure-class-defstruct-form name direct-slots include)
759             (unless (structure-type-p name) (eval defstruct-form))
760             (mapc (lambda (dslotd reader-name writer-name)
761                     (let* ((reader (gdefinition reader-name))
762                            (writer (when (fboundp writer-name)
763                                      (gdefinition writer-name))))
764                       (setf (slot-value dslotd 'internal-reader-function)
765                             reader)
766                       (setf (slot-value dslotd 'internal-writer-function)
767                             writer)))
768                   direct-slots reader-names writer-names)
769             (setf (slot-value class 'defstruct-form) defstruct-form)
770             (setf (slot-value class 'defstruct-constructor) constructor)))
771         (setf (slot-value class 'defstruct-constructor)
772               ;; KLUDGE: not class; in fixup.lisp, can't access slots
773               ;; outside methods yet.
774               (make-defstruct-allocation-function name)))
775     (add-direct-subclasses class direct-superclasses)
776     (setf (slot-value class '%class-precedence-list)
777           (compute-class-precedence-list class))
778     (setf (slot-value class 'cpl-available-p) t)
779     (let ((slots (compute-slots class)))
780       (setf (slot-value class 'slots) slots)
781       (let* ((lclass (find-classoid (slot-value class 'name)))
782              (layout (classoid-layout lclass)))
783         (setf (classoid-pcl-class lclass) class)
784         (setf (slot-value class 'wrapper) layout)
785         (setf (layout-slot-table layout) (make-slot-table class slots))))
786     (setf (slot-value class 'finalized-p) t)
787     (add-slot-accessors class direct-slots definition-source)))
788
789 (defmethod direct-slot-definition-class ((class structure-class) &rest initargs)
790   (declare (ignore initargs))
791   (find-class 'structure-direct-slot-definition))
792
793 (defmethod finalize-inheritance ((class structure-class))
794   nil) ; always finalized
795 \f
796 (defun add-slot-accessors (class dslotds &optional source-location)
797   (fix-slot-accessors class dslotds 'add source-location))
798
799 (defun remove-slot-accessors (class dslotds)
800   (fix-slot-accessors class dslotds 'remove))
801
802 (defun fix-slot-accessors (class dslotds add/remove &optional source-location)
803   (flet ((fix (gfspec name r/w doc)
804            (let ((gf (cond ((eq add/remove 'add)
805                             (or (find-generic-function gfspec nil)
806                                 (ensure-generic-function
807                                  gfspec :lambda-list (case r/w
808                                                        (r '(object))
809                                                        (w '(new-value object))))))
810                            (t
811                             (find-generic-function gfspec nil)))))
812              (when gf
813                (case r/w
814                  (r (if (eq add/remove 'add)
815                         (add-reader-method class gf name doc source-location)
816                         (remove-reader-method class gf)))
817                  (w (if (eq add/remove 'add)
818                         (add-writer-method class gf name doc source-location)
819                         (remove-writer-method class gf))))))))
820     (dolist (dslotd dslotds)
821       (let ((slot-name (slot-definition-name dslotd))
822             (slot-doc (%slot-definition-documentation dslotd)))
823         (dolist (r (slot-definition-readers dslotd))
824           (fix r slot-name 'r slot-doc))
825         (dolist (w (slot-definition-writers dslotd))
826           (fix w slot-name 'w slot-doc))))))
827 \f
828 (defun add-direct-subclasses (class supers)
829   (dolist (super supers)
830     (unless (memq class (class-direct-subclasses class))
831       (add-direct-subclass super class))))
832
833 (defmethod finalize-inheritance ((class std-class))
834   (update-class class t))
835
836 (defmethod finalize-inheritance ((class forward-referenced-class))
837   ;; FIXME: should we not be thinking a bit about what kinds of error
838   ;; we're throwing?  Maybe we need a clos-error type to mix in?  Or
839   ;; possibly a forward-referenced-class-error, though that's
840   ;; difficult given e.g. class precedence list calculations...
841   (error
842    "~@<FINALIZE-INHERITANCE was called on a forward referenced class:~
843        ~2I~_~S~:>"
844    class))
845
846 \f
847 (defun class-has-a-forward-referenced-superclass-p (class)
848   (or (when (forward-referenced-class-p class)
849         class)
850       (some #'class-has-a-forward-referenced-superclass-p
851             (class-direct-superclasses class))))
852
853 ;;; This is called by :after shared-initialize whenever a class is initialized
854 ;;; or reinitialized. The class may or may not be finalized.
855 (defun update-class (class finalizep)
856   (without-package-locks
857     (with-world-lock ()
858       (when (or finalizep (class-finalized-p class))
859         (%update-cpl class (compute-class-precedence-list class))
860         ;; This invocation of UPDATE-SLOTS, in practice, finalizes the
861         ;; class.
862         (%update-slots class (compute-slots class))
863         (update-gfs-of-class class)
864         (setf (plist-value class 'default-initargs) (compute-default-initargs class))
865         (update-ctors 'finalize-inheritance :class class))
866       (dolist (sub (class-direct-subclasses class))
867         (update-class sub nil)))))
868
869 (define-condition cpl-protocol-violation (reference-condition error)
870   ((class :initarg :class :reader cpl-protocol-violation-class)
871    (cpl :initarg :cpl :reader cpl-protocol-violation-cpl))
872   (:default-initargs :references (list '(:sbcl :node "Metaobject Protocol")))
873   (:report
874    (lambda (c s)
875      (format s "~@<Protocol violation: the ~S class ~S ~
876                 ~:[has~;does not have~] the class ~S in its ~
877                 class precedence list: ~S.~@:>"
878              (class-name (class-of (cpl-protocol-violation-class c)))
879              (cpl-protocol-violation-class c)
880              (eq (class-of (cpl-protocol-violation-class c))
881                  *the-class-funcallable-standard-class*)
882              (find-class 'function)
883              (cpl-protocol-violation-cpl c)))))
884
885 (defun %update-cpl (class cpl)
886   (when (eq (class-of class) *the-class-standard-class*)
887     (when (find (find-class 'function) cpl)
888       (error 'cpl-protocol-violation :class class :cpl cpl)))
889   (when (eq (class-of class) *the-class-funcallable-standard-class*)
890     (unless (find (find-class 'function) cpl)
891       (error 'cpl-protocol-violation :class class :cpl cpl)))
892   (if (class-finalized-p class)
893       (unless (and (equal (class-precedence-list class) cpl)
894                    (dolist (c cpl t)
895                      (when (position :class (class-direct-slots c)
896                                      :key #'slot-definition-allocation)
897                        (return nil))))
898         ;; comment from the old CMU CL sources:
899         ;;   Need to have the cpl setup before %update-lisp-class-layout
900         ;;   is called on CMU CL.
901         (setf (slot-value class '%class-precedence-list) cpl)
902         (setf (slot-value class 'cpl-available-p) t)
903         (%force-cache-flushes class))
904       (progn
905         (setf (slot-value class '%class-precedence-list) cpl)
906         (setf (slot-value class 'cpl-available-p) t)))
907   (update-class-can-precede-p cpl))
908
909 (defun update-class-can-precede-p (cpl)
910   (when cpl
911     (let ((first (car cpl)))
912       (dolist (c (cdr cpl))
913         (pushnew c (slot-value first 'can-precede-list) :test #'eq)))
914     (update-class-can-precede-p (cdr cpl))))
915
916 (defun class-can-precede-p (class1 class2)
917   (member class2 (class-can-precede-list class1) :test #'eq))
918
919 ;;; This is called from %UPDATE-SLOTS to check if slot layouts are compatible.
920 ;;;
921 ;;; In addition to slot locations (implicit in the ordering of the slots), we
922 ;;; must check classes: SLOT-INFO structures from old slotds may have been
923 ;;; cached in permutation vectors, but new slotds have had new ones allocated
924 ;;; to them. This is non-problematic for standard slotds, because we know the
925 ;;; structure is compatible, but if a slot definition class changes, this can
926 ;;; change the way SLOT-VALUE-USING-CLASS should dispatch.
927 ;;;
928 ;;; Also, if the slot has a non-standard allocation, we need to check that it
929 ;;; doesn't change.
930 (defun slot-layouts-compatible-p
931     (oslotds new-instance-slotds new-class-slotds new-custom-slotds)
932   (multiple-value-bind (old-instance-slotds old-class-slotds old-custom-slotds)
933       (classify-slotds oslotds)
934     (and
935      ;; Instance slots: name, type, and class.
936      (dolist (o old-instance-slotds (not new-instance-slotds))
937        (let ((n (pop new-instance-slotds)))
938          (unless (and n
939                       (eq (slot-definition-name o) (slot-definition-name n))
940                       (eq (slot-definition-type o) (slot-definition-type n))
941                       (eq (class-of o) (class-of n)))
942            (return nil))))
943      ;; Class slots: name and class. (FIXME: class slots not typechecked?)
944      (dolist (o old-class-slotds (not new-class-slotds))
945        (let ((n (pop new-class-slotds)))
946          (unless (and n
947                       (eq (slot-definition-name o) (slot-definition-name n))
948                       (eq (class-of n) (class-of o)))
949            (return nil))))
950      ;; Custom slots: check name, type, allocation, and class. (FIXME: should we just punt?)
951      (dolist (o old-custom-slotds (not new-custom-slotds))
952        (let ((n (pop new-custom-slotds)))
953          (unless (and n
954                       (eq (slot-definition-name o) (slot-definition-name n))
955                       (eq (slot-definition-type o) (slot-definition-type n))
956                       (eq (slot-definition-allocation o) (slot-definition-allocation n))
957                       (eq (class-of o) (class-of n)))
958            (return nil)))))))
959
960 (defun %update-slots (class eslotds)
961   (multiple-value-bind (instance-slots class-slots custom-slots)
962       (classify-slotds eslotds)
963     (let* ((nslots (length instance-slots))
964            (owrapper (when (class-finalized-p class) (class-wrapper class)))
965            (nwrapper
966              (cond ((null owrapper)
967                     (make-wrapper nslots class))
968                    ((slot-layouts-compatible-p (wrapper-slots owrapper)
969                                                instance-slots class-slots custom-slots)
970                     owrapper)
971                    (t
972                     ;; This will initialize the new wrapper to have the
973                     ;; same state as the old wrapper. We will then have
974                     ;; to change that. This may seem like wasted work
975                     ;; (and it is), but the spec requires that we call
976                     ;; MAKE-INSTANCES-OBSOLETE.
977                     (make-instances-obsolete class)
978                     (class-wrapper class)))))
979       (%update-lisp-class-layout class nwrapper)
980       (setf (slot-value class 'slots) eslotds
981             (wrapper-slots nwrapper) eslotds
982             (wrapper-slot-table nwrapper) (make-slot-table class eslotds)
983             (wrapper-length nwrapper) nslots
984             (slot-value class 'wrapper) nwrapper)
985       (do* ((slots (slot-value class 'slots) (cdr slots))
986             (dupes nil))
987            ((null slots)
988             (when dupes
989               (style-warn
990                "~@<slot names with the same SYMBOL-NAME but ~
991                   different SYMBOL-PACKAGE (possible package problem) ~
992                   for class ~S:~4I~@:_~<~@{~/sb-impl::print-symbol-with-prefix/~^~:@_~}~:>~@:>"
993                class dupes)))
994         (let* ((slot (car slots))
995                (oslots (remove (slot-definition-name slot) (cdr slots)
996                                :test #'string/=
997                                :key #'slot-definition-name)))
998           (when oslots
999             (pushnew (cons (slot-definition-name slot)
1000                            (mapcar #'slot-definition-name oslots))
1001                      dupes
1002                      :test #'string= :key #'car))))
1003       (setf (slot-value class 'finalized-p) t)
1004       (unless (eq owrapper nwrapper)
1005         (maybe-update-standard-slot-locations class)))))
1006
1007 (defun update-gf-dfun (class gf)
1008   (let ((*new-class* class)
1009         (arg-info (gf-arg-info gf)))
1010     (cond
1011       ((special-case-for-compute-discriminating-function-p gf))
1012       ((gf-precompute-dfun-and-emf-p arg-info)
1013        (multiple-value-bind (dfun cache info) (make-final-dfun-internal gf)
1014          (update-dfun gf dfun cache info))))))
1015
1016 (defun update-gfs-of-class (class)
1017   (when (and (class-finalized-p class)
1018              (let ((cpl (class-precedence-list class)))
1019                (or (member *the-class-slot-class* cpl :test #'eq)
1020                    (member *the-class-standard-effective-slot-definition*
1021                            cpl :test #'eq))))
1022     (let ((gf-table (make-hash-table :test 'eq)))
1023       (labels ((collect-gfs (class)
1024                  (dolist (gf (specializer-direct-generic-functions class))
1025                    (setf (gethash gf gf-table) t))
1026                  (mapc #'collect-gfs (class-direct-superclasses class))))
1027         (collect-gfs class)
1028         (maphash (lambda (gf ignore)
1029                    (declare (ignore ignore))
1030                    (update-gf-dfun class gf))
1031                  gf-table)))))
1032 \f
1033 (defmethod compute-default-initargs ((class slot-class))
1034   (let ((initargs (loop for c in (class-precedence-list class)
1035                         append (class-direct-default-initargs c))))
1036     (delete-duplicates initargs :test #'eq :key #'car :from-end t)))
1037 \f
1038 ;;;; protocols for constructing direct and effective slot definitions
1039
1040 (defmethod direct-slot-definition-class ((class std-class) &rest initargs)
1041   (declare (ignore initargs))
1042   (find-class 'standard-direct-slot-definition))
1043
1044 (defun make-direct-slotd (class initargs)
1045   (apply #'make-instance
1046          (apply #'direct-slot-definition-class class initargs)
1047          :class class
1048          initargs))
1049
1050 ;;; I (CSR) am not sure, but I believe that the particular order of
1051 ;;; slots is quite important: it is ideal to attempt to have a
1052 ;;; constant slot location for the same notional slots as much as
1053 ;;; possible, so that clever discriminating functions (ONE-INDEX et
1054 ;;; al.) have a chance of working.  The below at least walks through
1055 ;;; the slots predictably, but maybe it would be good to compute some
1056 ;;; kind of optimal slot layout by looking at locations of slots in
1057 ;;; superclasses?
1058 (defun std-compute-slots (class)
1059   ;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
1060   ;; for each different slot name we find in our superclasses. Each
1061   ;; call receives the class and a list of the dslotds with that name.
1062   ;; The list is in most-specific-first order.
1063   (let ((name-dslotds-alist ()))
1064     (dolist (c (reverse (class-precedence-list class)))
1065       (dolist (slot (class-direct-slots c))
1066         (let* ((name (slot-definition-name slot))
1067                (entry (assq name name-dslotds-alist)))
1068           (if entry
1069               (push slot (cdr entry))
1070               (push (list name slot) name-dslotds-alist)))))
1071     (mapcar (lambda (direct)
1072               (compute-effective-slot-definition class
1073                                                  (car direct)
1074                                                  (cdr direct)))
1075             (nreverse name-dslotds-alist))))
1076
1077 (defmethod compute-slots ((class standard-class))
1078   (std-compute-slots class))
1079 (defmethod compute-slots ((class funcallable-standard-class))
1080   (std-compute-slots class))
1081
1082 (defun std-compute-slots-around (class eslotds)
1083   (let ((location -1)
1084         (safe (safe-p class)))
1085     (dolist (eslotd eslotds eslotds)
1086       (setf (slot-definition-location eslotd)
1087             (case (slot-definition-allocation eslotd)
1088               (:instance
1089                (incf location))
1090               (:class
1091                (let* ((name (slot-definition-name eslotd))
1092                       (from-class
1093                        (or
1094                         (slot-definition-allocation-class eslotd)
1095                         ;; we get here if the user adds an extra slot
1096                         ;; himself...
1097                         (setf (slot-definition-allocation-class eslotd)
1098                               class)))
1099                       ;; which raises the question of what we should
1100                       ;; do if we find that said user has added a slot
1101                       ;; with the same name as another slot...
1102                       (cell (or (assq name (class-slot-cells from-class))
1103                                 (let ((c (cons name +slot-unbound+)))
1104                                   (push c (class-slot-cells from-class))
1105                                   c))))
1106                  (aver (consp cell))
1107                  (if (eq +slot-unbound+ (cdr cell))
1108                      ;; We may have inherited an initfunction FIXME: Is this
1109                      ;; really right? Is the initialization in
1110                      ;; SHARED-INITIALIZE (STD-CLASS) not enough?
1111                      (let ((initfun (slot-definition-initfunction eslotd)))
1112                        (if initfun
1113                            (rplacd cell (call-initfun initfun eslotd safe))
1114                            cell))
1115                      cell)))))
1116       (unless (slot-definition-class eslotd)
1117         (setf (slot-definition-class eslotd) class))
1118       (initialize-internal-slot-functions eslotd))))
1119
1120 (defmethod compute-slots :around ((class standard-class))
1121   (let ((eslotds (call-next-method)))
1122     (std-compute-slots-around class eslotds)))
1123 (defmethod compute-slots :around ((class funcallable-standard-class))
1124   (let ((eslotds (call-next-method)))
1125     (std-compute-slots-around class eslotds)))
1126
1127 (defmethod compute-slots ((class structure-class))
1128   (mapcan (lambda (superclass)
1129             (mapcar (lambda (dslotd)
1130                       (compute-effective-slot-definition
1131                        class
1132                        (slot-definition-name dslotd)
1133                        (list dslotd)))
1134                     (class-direct-slots superclass)))
1135           (reverse (slot-value class '%class-precedence-list))))
1136
1137 (defmethod compute-slots :around ((class structure-class))
1138   (let ((eslotds (call-next-method)))
1139     (mapc #'finalize-internal-slot-functions eslotds)
1140     eslotds))
1141
1142 (defmethod compute-effective-slot-definition ((class slot-class) name dslotds)
1143   (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
1144          (class (apply #'effective-slot-definition-class class initargs))
1145          (slotd (apply #'make-instance class initargs)))
1146     slotd))
1147
1148 (defmethod effective-slot-definition-class ((class std-class) &rest initargs)
1149   (declare (ignore initargs))
1150   (find-class 'standard-effective-slot-definition))
1151
1152 (defmethod effective-slot-definition-class ((class structure-class) &rest initargs)
1153   (declare (ignore initargs))
1154   (find-class 'structure-effective-slot-definition))
1155
1156 (defmethod compute-effective-slot-definition-initargs
1157     ((class slot-class) direct-slotds)
1158   (let* ((name nil)
1159          (initfunction nil)
1160          (initform nil)
1161          (initargs nil)
1162          (allocation nil)
1163          (allocation-class nil)
1164          (type t)
1165          (documentation nil)
1166          (documentationp nil)
1167          (namep  nil)
1168          (initp  nil)
1169          (allocp nil))
1170
1171     (dolist (slotd direct-slotds)
1172       (when slotd
1173         (unless namep
1174           (setq name (slot-definition-name slotd)
1175                 namep t))
1176         (unless initp
1177           (awhen (slot-definition-initfunction slotd)
1178             (setq initform (slot-definition-initform slotd)
1179                   initfunction it
1180                   initp t)))
1181         (unless documentationp
1182           (awhen (%slot-definition-documentation slotd)
1183             (setq documentation it
1184                   documentationp t)))
1185         (unless allocp
1186           (setq allocation (slot-definition-allocation slotd)
1187                 allocation-class (slot-definition-class slotd)
1188                 allocp t))
1189         (setq initargs (append (slot-definition-initargs slotd) initargs))
1190         (let ((slotd-type (slot-definition-type slotd)))
1191           (setq type (cond
1192                        ((eq type t) slotd-type)
1193                        ;; This pairwise type intersection is perhaps a
1194                        ;; little inefficient and inelegant, but it's
1195                        ;; unlikely to lie on the critical path.  Shout
1196                        ;; if I'm wrong.  -- CSR, 2005-11-24
1197                        (t (type-specifier
1198                            (specifier-type `(and ,type ,slotd-type)))))))))
1199     (list :name name
1200           :initform initform
1201           :initfunction initfunction
1202           :initargs initargs
1203           :allocation allocation
1204           :allocation-class allocation-class
1205           :type type
1206           :class class
1207           :documentation documentation)))
1208
1209 (defmethod compute-effective-slot-definition-initargs :around
1210     ((class structure-class) direct-slotds)
1211   (let* ((slotd (car direct-slotds))
1212          (accessor (slot-definition-defstruct-accessor-symbol slotd)))
1213     (list* :defstruct-accessor-symbol accessor
1214            :internal-reader-function
1215            (slot-definition-internal-reader-function slotd)
1216            :internal-writer-function
1217            (slot-definition-internal-writer-function slotd)
1218            (call-next-method))))
1219 \f
1220 ;;; NOTE: For bootstrapping considerations, these can't use MAKE-INSTANCE
1221 ;;;       to make the method object. They have to use make-a-method which
1222 ;;;       is a specially bootstrapped mechanism for making standard methods.
1223 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
1224   (declare (ignore direct-slot initargs))
1225   (find-class 'standard-reader-method))
1226
1227 (defmethod add-reader-method ((class slot-class) generic-function slot-name slot-documentation source-location)
1228   (add-method generic-function
1229               (make-a-method 'standard-reader-method
1230                              ()
1231                              (list (or (class-name class) 'object))
1232                              (list class)
1233                              (make-reader-method-function class slot-name)
1234                              (or slot-documentation "automatically generated reader method")
1235                              :slot-name slot-name
1236                              :object-class class
1237                              :method-class-function #'reader-method-class
1238                              :definition-source source-location)))
1239
1240 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
1241   (declare (ignore direct-slot initargs))
1242   (find-class 'standard-writer-method))
1243
1244 (defmethod add-writer-method ((class slot-class) generic-function slot-name slot-documentation source-location)
1245   (add-method generic-function
1246               (make-a-method 'standard-writer-method
1247                              ()
1248                              (list 'new-value (or (class-name class) 'object))
1249                              (list *the-class-t* class)
1250                              (make-writer-method-function class slot-name)
1251                              (or slot-documentation "automatically generated writer method")
1252                              :slot-name slot-name
1253                              :object-class class
1254                              :method-class-function #'writer-method-class
1255                              :definition-source source-location)))
1256
1257 (defmethod add-boundp-method ((class slot-class) generic-function slot-name slot-documentation source-location)
1258   (add-method generic-function
1259               (make-a-method (constantly (find-class 'standard-boundp-method))
1260                              class
1261                              ()
1262                              (list (or (class-name class) 'object))
1263                              (list class)
1264                              (make-boundp-method-function class slot-name)
1265                              (or slot-documentation "automatically generated boundp method")
1266                              :slot-name slot-name
1267                              :definition-source source-location)))
1268
1269 (defmethod remove-reader-method ((class slot-class) generic-function)
1270   (let ((method (get-method generic-function () (list class) nil)))
1271     (when method (remove-method generic-function method))))
1272
1273 (defmethod remove-writer-method ((class slot-class) generic-function)
1274   (let ((method
1275           (get-method generic-function () (list *the-class-t* class) nil)))
1276     (when method (remove-method generic-function method))))
1277
1278 (defmethod remove-boundp-method ((class slot-class) generic-function)
1279   (let ((method (get-method generic-function () (list class) nil)))
1280     (when method (remove-method generic-function method))))
1281 \f
1282 ;;; MAKE-READER-METHOD-FUNCTION and MAKE-WRITER-METHOD-FUNCTION
1283 ;;; function are NOT part of the standard protocol. They are however
1284 ;;; useful; PCL makes use of them internally and documents them for
1285 ;;; PCL users.  (FIXME: but SBCL certainly doesn't)
1286 ;;;
1287 ;;; *** This needs work to make type testing by the writer functions which
1288 ;;; *** do type testing faster. The idea would be to have one constructor
1289 ;;; *** for each possible type test.
1290 ;;;
1291 ;;; *** There is a subtle bug here which is going to have to be fixed.
1292 ;;; *** Namely, the simplistic use of the template has to be fixed. We
1293 ;;; *** have to give the OPTIMIZE-SLOT-VALUE method the user might have
1294 ;;; *** defined for this metaclass a chance to run.
1295
1296 (defmethod make-reader-method-function ((class slot-class) slot-name)
1297   (make-std-reader-method-function class slot-name))
1298
1299 (defmethod make-writer-method-function ((class slot-class) slot-name)
1300   (make-std-writer-method-function class slot-name))
1301
1302 (defmethod make-boundp-method-function ((class slot-class) slot-name)
1303   (make-std-boundp-method-function class slot-name))
1304 \f
1305 (defmethod compatible-meta-class-change-p (class proto-new-class)
1306   (eq (class-of class) (class-of proto-new-class)))
1307
1308 (defmethod validate-superclass ((class class) (superclass class))
1309   (or (eq superclass *the-class-t*)
1310       (eq (class-of class) (class-of superclass))
1311       (and (eq (class-of superclass) *the-class-standard-class*)
1312            (eq (class-of class) *the-class-funcallable-standard-class*))
1313       (and (eq (class-of superclass) *the-class-funcallable-standard-class*)
1314            (eq (class-of class) *the-class-standard-class*))))
1315 \f
1316 ;;; What this does depends on which of the four possible values of
1317 ;;; LAYOUT-INVALID the PCL wrapper has; the simplest case is when it
1318 ;;; is (:FLUSH <wrapper>) or (:OBSOLETE <wrapper>), when there is
1319 ;;; nothing to do, as the new wrapper has already been created.  If
1320 ;;; LAYOUT-INVALID returns NIL, then we invalidate it (setting it to
1321 ;;; (:FLUSH <wrapper>); UPDATE-SLOTS later gets to choose whether or
1322 ;;; not to "upgrade" this to (:OBSOLETE <wrapper>).
1323 ;;;
1324 ;;; This leaves the case where LAYOUT-INVALID returns T, which happens
1325 ;;; when REGISTER-LAYOUT has invalidated a superclass of CLASS (which
1326 ;;; invalidated all the subclasses in SB-KERNEL land).  Again, here we
1327 ;;; must flush the caches and allow UPDATE-SLOTS to decide whether to
1328 ;;; obsolete the wrapper.
1329 ;;;
1330 ;;; FIXME: either here or in INVALID-WRAPPER-P looks like a good place
1331 ;;; for (AVER (NOT (EQ (LAYOUT-INVALID OWRAPPER)
1332 ;;;                    :UNINITIALIZED)))
1333 ;;;
1334 ;;; Thanks to Gerd Moellmann for the explanation.  -- CSR, 2002-10-29
1335 (defun %force-cache-flushes (class)
1336   (let* ((owrapper (class-wrapper class)))
1337     ;; We only need to do something if the wrapper is still valid. If
1338     ;; the wrapper isn't valid, state will be FLUSH or OBSOLETE, and
1339     ;; both of those will already be doing what we want. In
1340     ;; particular, we must be sure we never change an OBSOLETE into a
1341     ;; FLUSH since OBSOLETE means do what FLUSH does and then some.
1342     (when (or (not (invalid-wrapper-p owrapper))
1343               ;; KLUDGE: despite the observations above, this remains
1344               ;; a violation of locality or what might be considered
1345               ;; good style.  There has to be a better way!  -- CSR,
1346               ;; 2002-10-29
1347               (eq (layout-invalid owrapper) t))
1348       (let ((nwrapper (make-wrapper (layout-length owrapper)
1349                                     class)))
1350         (setf (wrapper-slots nwrapper)
1351               (wrapper-slots owrapper))
1352         (setf (wrapper-slot-table nwrapper)
1353               (wrapper-slot-table owrapper))
1354         (%update-lisp-class-layout class nwrapper)
1355         (setf (slot-value class 'wrapper) nwrapper)
1356         ;; Use :OBSOLETE instead of :FLUSH if any superclass has
1357         ;; been obsoleted.
1358         (if (find-if (lambda (x)
1359                        (and (consp x) (eq :obsolete (car x))))
1360                      (layout-inherits owrapper)
1361                      :key #'layout-invalid)
1362             (%invalidate-wrapper owrapper :obsolete nwrapper)
1363             (%invalidate-wrapper owrapper :flush nwrapper))))))
1364 \f
1365 ;;; MAKE-INSTANCES-OBSOLETE can be called by user code. It will cause
1366 ;;; the next access to the instance (as defined in 88-002R) to trap
1367 ;;; through the UPDATE-INSTANCE-FOR-REDEFINED-CLASS mechanism.
1368 (defmethod make-instances-obsolete ((class std-class))
1369   (with-world-lock ()
1370     (let* ((owrapper (class-wrapper class))
1371            (nwrapper (make-wrapper (layout-length owrapper)
1372                                    class)))
1373       (unless (class-finalized-p class)
1374         (if (class-has-a-forward-referenced-superclass-p class)
1375             (return-from make-instances-obsolete class)
1376             (%update-cpl class (compute-class-precedence-list class))))
1377       (setf (wrapper-slots nwrapper)
1378             (wrapper-slots owrapper))
1379       (setf (wrapper-slot-table nwrapper)
1380             (wrapper-slot-table owrapper))
1381       (%update-lisp-class-layout class nwrapper)
1382       (setf (slot-value class 'wrapper) nwrapper)
1383       (%invalidate-wrapper owrapper :obsolete nwrapper)
1384       class)))
1385
1386 (defmethod make-instances-obsolete ((class symbol))
1387   (make-instances-obsolete (find-class class))
1388   ;; ANSI wants the class name when called with a symbol.
1389   class)
1390
1391 ;;; OBSOLETE-INSTANCE-TRAP is the internal trap that is called when we
1392 ;;; see an obsolete instance. The times when it is called are:
1393 ;;;   - when the instance is involved in method lookup
1394 ;;;   - when attempting to access a slot of an instance
1395 ;;;
1396 ;;; It is not called by class-of, wrapper-of, or any of the low-level
1397 ;;; instance access macros.
1398 ;;;
1399 ;;; Of course these times when it is called are an internal
1400 ;;; implementation detail of PCL and are not part of the documented
1401 ;;; description of when the obsolete instance update happens. The
1402 ;;; documented description is as it appears in 88-002R.
1403 ;;;
1404 ;;; This has to return the new wrapper, so it counts on all the
1405 ;;; methods on obsolete-instance-trap-internal to return the new
1406 ;;; wrapper. It also does a little internal error checking to make
1407 ;;; sure that the traps are only happening when they should, and that
1408 ;;; the trap methods are computing appropriate new wrappers.
1409
1410 ;;; OBSOLETE-INSTANCE-TRAP might be called on structure instances
1411 ;;; after a structure is redefined. In most cases,
1412 ;;; OBSOLETE-INSTANCE-TRAP will not be able to fix the old instance,
1413 ;;; so it must signal an error. The hard part of this is that the
1414 ;;; error system and debugger might cause OBSOLETE-INSTANCE-TRAP to be
1415 ;;; called again, so in that case, we have to return some reasonable
1416 ;;; wrapper, instead.
1417
1418 (defvar *in-obsolete-instance-trap* nil)
1419 (defvar *the-wrapper-of-structure-object*
1420   (class-wrapper (find-class 'structure-object)))
1421
1422 (define-condition obsolete-structure (error)
1423   ((datum :reader obsolete-structure-datum :initarg :datum))
1424   (:report
1425    (lambda (condition stream)
1426      ;; Don't try to print the structure, since it probably won't work.
1427      (format stream
1428              "~@<obsolete structure error for a structure of type ~2I~_~S~:>"
1429              (type-of (obsolete-structure-datum condition))))))
1430
1431 (defun %obsolete-instance-trap (owrapper nwrapper instance)
1432   (if (not (layout-for-std-class-p owrapper))
1433       (if *in-obsolete-instance-trap*
1434           *the-wrapper-of-structure-object*
1435           (let ((*in-obsolete-instance-trap* t))
1436             (error 'obsolete-structure :datum instance)))
1437       (let* ((class (wrapper-class* nwrapper))
1438              (copy (allocate-instance class)) ;??? allocate-instance ???
1439              (oslots (get-slots instance))
1440              (nslots (get-slots copy))
1441              (added ())
1442              (discarded ())
1443              (plist ())
1444              (safe (safe-p class)))
1445
1446         ;; local  --> local     transfer value, check type
1447         ;; local  --> shared    discard value, discard slot
1448         ;; local  -->  --       discard slot
1449         ;; local  --> custom    XXX
1450
1451         ;; shared --> local     transfer value, check type
1452         ;; shared --> shared    -- (cf SHARED-INITIALIZE :AFTER STD-CLASS)
1453         ;; shared -->  --       discard value
1454         ;; shared --> custom    XXX
1455
1456         ;;  --    --> local     add slot
1457         ;;  --    --> shared    --
1458         ;;  --    --> custom    XXX
1459
1460         (multiple-value-bind (new-instance-slots new-class-slots new-custom-slots)
1461             (classify-slotds (wrapper-slots nwrapper))
1462           (declare (ignore new-class-slots))
1463           (multiple-value-bind (old-instance-slots old-class-slots old-custom-slots)
1464               (classify-slotds (wrapper-slots owrapper))
1465
1466             (let ((layout (mapcar (lambda (slotd)
1467                                     ;; Get the names only once.
1468                                     (cons (slot-definition-name slotd) slotd))
1469                                   new-instance-slots)))
1470
1471               (flet ((set-value (value cell)
1472                        (let ((name (car cell))
1473                              (slotd (cdr cell)))
1474                          (when (and safe (neq value +slot-unbound+))
1475                            (let ((type (slot-definition-type slotd)))
1476                              (assert
1477                               (typep value type) (value)
1478                               "~@<Error updating obsolete instance. Current value in slot ~
1479                                ~S of an instance of ~S is ~S, which does not match the new ~
1480                                slot type ~S.~:@>"
1481                               name class value type)))
1482                          (setf (clos-slots-ref nslots (slot-definition-location slotd)) value
1483                                ;; Prune from the list now that it's been dealt with.
1484                                layout (remove cell layout)))))
1485
1486                 ;; Go through all the old local slots.
1487                 (dolist (old old-instance-slots)
1488                   (let* ((name (slot-definition-name old))
1489                          (value (clos-slots-ref oslots (slot-definition-location old))))
1490                     (unless (eq value +slot-unbound+)
1491                       (let ((new (assq name layout)))
1492                         (cond (new
1493                                (set-value value new))
1494                               (t
1495                                (push name discarded)
1496                                (setf (getf plist name) value)))))))
1497
1498                 ;; Go through all the old shared slots.
1499                 (dolist (old old-class-slots)
1500                   (let* ((cell (slot-definition-location old))
1501                          (name (car cell))
1502                          (new (assq name layout)))
1503                     (when new
1504                       (set-value (cdr cell) new))))
1505
1506                 ;; Go through all custom slots to find added ones. CLHS
1507                 ;; doesn't specify what to do about them, and neither does
1508                 ;; AMOP. We do want them to get initialized, though, so we
1509                 ;; list them in ADDED for the benefit of SHARED-INITIALIZE.
1510                 (dolist (new new-custom-slots)
1511                   (let* ((name (slot-definition-name new))
1512                          (old (find name old-custom-slots :key #'slot-definition-name)))
1513                     (unless old
1514                       (push name added))))
1515
1516                 ;; Go through all the remaining new local slots to compute the added slots.
1517                 (dolist (cell layout)
1518                   (push (car cell) added))))))
1519
1520         (%swap-wrappers-and-slots instance copy)
1521
1522         (update-instance-for-redefined-class instance
1523                                              added
1524                                              discarded
1525                                              plist)
1526         nwrapper)))
1527 \f
1528 (defun %change-class (instance new-class initargs)
1529   (let* ((old-class (class-of instance))
1530          (copy (allocate-instance new-class))
1531          (new-wrapper (get-wrapper copy))
1532          (old-wrapper (class-wrapper old-class))
1533          (old-slots (get-slots instance))
1534          (new-slots (get-slots copy))
1535          (safe (safe-p new-class)))
1536     (multiple-value-bind (new-instance-slots new-class-slots)
1537         (classify-slotds (wrapper-slots new-wrapper))
1538       (multiple-value-bind (old-instance-slots old-class-slots)
1539           (classify-slotds (wrapper-slots old-wrapper))
1540
1541         (flet ((set-value (value slotd)
1542                  (when safe
1543                    (assert (typep value (slot-definition-type slotd)) (value)
1544                            "~@<Error changing class. Current value in slot ~S ~
1545                             of an instance of ~S is ~S, which does not match the new ~
1546                             slot type ~S in class ~S.~:@>"
1547                            (slot-definition-name slotd) old-class value
1548                            (slot-definition-type slotd) new-class))
1549                  (setf (clos-slots-ref new-slots (slot-definition-location slotd)) value)))
1550
1551           ;; "The values of local slots specified by both the class CTO and
1552           ;; CFROM are retained. If such a local slot was unbound, it
1553           ;; remains unbound."
1554           (dolist (new new-instance-slots)
1555             (let* ((name (slot-definition-name new))
1556                    (old (find name old-instance-slots :key #'slot-definition-name)))
1557               (when old
1558                 (set-value (clos-slots-ref old-slots (slot-definition-location old))
1559                            new))))
1560
1561           ;; "The values of slots specified as shared in the class CFROM and
1562           ;; as local in the class CTO are retained."
1563           (dolist (old old-class-slots)
1564             (let* ((slot-and-val (slot-definition-location old))
1565                    (new (find (car slot-and-val) new-instance-slots
1566                               :key #'slot-definition-name)))
1567               (when new
1568                 (set-value (cdr slot-and-val) new)))))))
1569
1570     ;; Make the copy point to the old instance's storage, and make the
1571     ;; old instance point to the new storage.
1572     (%swap-wrappers-and-slots instance copy)
1573
1574     (apply #'update-instance-for-different-class copy instance initargs)
1575
1576     instance))
1577
1578 (defmethod change-class ((instance standard-object) (new-class standard-class)
1579                          &rest initargs)
1580   (with-world-lock ()
1581     (unless (class-finalized-p new-class)
1582       (finalize-inheritance new-class))
1583     (let ((cpl (class-precedence-list new-class)))
1584       (dolist (class cpl)
1585         (macrolet
1586             ((frob (class-name)
1587                `(when (eq class (find-class ',class-name))
1588                   (error 'metaobject-initialization-violation
1589                          :format-control "~@<Cannot ~S objects into ~S metaobjects.~@:>"
1590                          :format-arguments (list 'change-class ',class-name)
1591                          :references (list '(:amop :initialization ,class-name))))))
1592           (frob class)
1593           (frob generic-function)
1594           (frob method)
1595           (frob slot-definition))))
1596     (%change-class instance new-class initargs)))
1597
1598 (defmethod change-class ((instance forward-referenced-class)
1599                          (new-class standard-class) &rest initargs)
1600   (with-world-lock ()
1601     (let ((cpl (class-precedence-list new-class)))
1602       (dolist (class cpl
1603                (error 'metaobject-initialization-violation
1604                       :format-control
1605                       "~@<Cannot ~S ~S objects into non-~S objects.~@:>"
1606                       :format-arguments
1607                       (list 'change-class 'forward-referenced-class 'class)
1608                       :references
1609                       (list '(:amop :generic-function ensure-class-using-class)
1610                             '(:amop :initialization class))))
1611         (when (eq class (find-class 'class))
1612           (return nil))))
1613     (%change-class instance new-class initargs)))
1614
1615 (defmethod change-class ((instance funcallable-standard-object)
1616                          (new-class funcallable-standard-class)
1617                          &rest initargs)
1618   (with-world-lock ()
1619     (let ((cpl (class-precedence-list new-class)))
1620       (dolist (class cpl)
1621         (macrolet
1622             ((frob (class-name)
1623                `(when (eq class (find-class ',class-name))
1624                   (error 'metaobject-initialization-violation
1625                          :format-control "~@<Cannot ~S objects into ~S metaobjects.~@:>"
1626                          :format-arguments (list 'change-class ',class-name)
1627                          :references (list '(:amop :initialization ,class-name))))))
1628           (frob class)
1629           (frob generic-function)
1630           (frob method)
1631           (frob slot-definition))))
1632     (%change-class instance new-class initargs)))
1633
1634 (defmethod change-class ((instance standard-object)
1635                          (new-class funcallable-standard-class)
1636                          &rest initargs)
1637   (declare (ignore initargs))
1638   (error "You can't change the class of ~S to ~S~@
1639           because it isn't already an instance with metaclass ~S."
1640          instance new-class 'standard-class))
1641
1642 (defmethod change-class ((instance funcallable-standard-object)
1643                          (new-class standard-class)
1644                          &rest initargs)
1645   (declare (ignore initargs))
1646   (error "You can't change the class of ~S to ~S~@
1647           because it isn't already an instance with metaclass ~S."
1648          instance new-class 'funcallable-standard-class))
1649
1650 (defmethod change-class ((instance t) (new-class-name symbol) &rest initargs)
1651   (apply #'change-class instance (find-class new-class-name) initargs))
1652 \f
1653 ;;;; The metaclass BUILT-IN-CLASS
1654 ;;;;
1655 ;;;; This metaclass is something of a weird creature. By this point, all
1656 ;;;; instances of it which will exist have been created, and no instance
1657 ;;;; is ever created by calling MAKE-INSTANCE.
1658 ;;;;
1659 ;;;; But, there are other parts of the protocol we must follow and those
1660 ;;;; definitions appear here.
1661
1662 (macrolet ((def (name args control)
1663                `(defmethod ,name ,args
1664                  (declare (ignore initargs))
1665                  (error 'metaobject-initialization-violation
1666                   :format-control ,(format nil "~@<~A~@:>" control)
1667                   :format-arguments (list ',name)
1668                   :references (list '(:amop :initialization "Class"))))))
1669   (def initialize-instance ((class built-in-class) &rest initargs)
1670     "Cannot ~S an instance of BUILT-IN-CLASS.")
1671   (def reinitialize-instance ((class built-in-class) &rest initargs)
1672     "Cannot ~S an instance of BUILT-IN-CLASS."))
1673
1674 (macrolet ((def (name)
1675                `(defmethod ,name ((class built-in-class)) nil)))
1676   (def class-direct-slots)
1677   (def class-slots)
1678   (def class-direct-default-initargs)
1679   (def class-default-initargs))
1680
1681 (defmethod validate-superclass ((c class) (s built-in-class))
1682   (or (eq s *the-class-t*) (eq s *the-class-stream*)
1683       ;; FIXME: bad things happen if someone tries to mix in both
1684       ;; FILE-STREAM and STRING-STREAM (as they have the same
1685       ;; layout-depthoid).  Is there any way we can provide a useful
1686       ;; error message?  -- CSR, 2005-05-03
1687       (eq s *the-class-file-stream*) (eq s *the-class-string-stream*)
1688       ;; This probably shouldn't be mixed in with certain other
1689       ;; classes, too, but it seems to work both with STANDARD-OBJECT
1690       ;; and FUNCALLABLE-STANDARD-OBJECT
1691       (eq s *the-class-sequence*)))
1692 \f
1693 ;;; Some necessary methods for FORWARD-REFERENCED-CLASS
1694 (defmethod class-direct-slots ((class forward-referenced-class)) ())
1695 (defmethod class-direct-default-initargs ((class forward-referenced-class)) ())
1696 (macrolet ((def (method)
1697              `(defmethod ,method ((class forward-referenced-class))
1698                 (error "~@<~I~S was called on a forward referenced class:~2I~_~S~:>"
1699                        ',method class))))
1700   (def class-default-initargs)
1701   (def class-precedence-list)
1702   (def class-slots))
1703
1704 (defmethod validate-superclass ((c slot-class)
1705                                 (f forward-referenced-class))
1706   t)
1707 \f
1708 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1709   (pushnew dependent (plist-value metaobject 'dependents) :test #'eq))
1710
1711 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1712   (setf (plist-value metaobject 'dependents)
1713         (delete dependent (plist-value metaobject 'dependents))))
1714
1715 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1716   (dolist (dependent (plist-value metaobject 'dependents))
1717     (funcall function dependent)))
1718