1 ;;;; This software is part of the SBCL system. See the README file for
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
10 ;;;; copyright information from original PCL sources:
12 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
13 ;;;; All rights reserved.
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
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
26 (defmethod slot-accessor-function ((slotd effective-slot-definition) type)
28 (reader (slot-definition-reader-function slotd))
29 (writer (slot-definition-writer-function slotd))
30 (boundp (slot-definition-boundp-function slotd))))
32 (defmethod (setf slot-accessor-function) (function
33 (slotd effective-slot-definition)
36 (reader (setf (slot-definition-reader-function slotd) function))
37 (writer (setf (slot-definition-writer-function slotd) function))
38 (boundp (setf (slot-definition-boundp-function slotd) function))))
40 (defconstant +slotd-reader-function-std-p+ 1)
41 (defconstant +slotd-writer-function-std-p+ 2)
42 (defconstant +slotd-boundp-function-std-p+ 4)
43 (defconstant +slotd-all-function-std-p+ 7)
45 (defmethod slot-accessor-std-p ((slotd effective-slot-definition) type)
46 (let ((flags (slot-value slotd 'accessor-flags)))
47 (declare (type fixnum flags))
49 (eql +slotd-all-function-std-p+ flags)
50 (let ((mask (ecase type
51 (reader +slotd-reader-function-std-p+)
52 (writer +slotd-writer-function-std-p+)
53 (boundp +slotd-boundp-function-std-p+))))
54 (declare (type fixnum mask))
55 (not (zerop (the fixnum (logand mask flags))))))))
57 (defmethod (setf slot-accessor-std-p) (value
58 (slotd effective-slot-definition)
60 (let ((mask (ecase type
61 (reader +slotd-reader-function-std-p+)
62 (writer +slotd-writer-function-std-p+)
63 (boundp +slotd-boundp-function-std-p+)))
64 (flags (slot-value slotd 'accessor-flags)))
65 (declare (type fixnum mask flags))
66 (setf (slot-value slotd 'accessor-flags)
68 (the fixnum (logior mask flags))
69 (the fixnum (logand (the fixnum (lognot mask)) flags)))))
72 (defmethod initialize-internal-slot-functions ((slotd
73 effective-slot-definition))
74 (let* ((name (slot-value slotd 'name))
75 (class (slot-value slotd 'class)))
76 (let ((table (or (gethash name *name->class->slotd-table*)
77 (setf (gethash name *name->class->slotd-table*)
78 (make-hash-table :test 'eq :size 5)))))
79 (setf (gethash class table) slotd))
80 (dolist (type '(reader writer boundp))
81 (let* ((gf-name (ecase type
82 (reader 'slot-value-using-class)
83 (writer '(setf slot-value-using-class))
84 (boundp 'slot-boundp-using-class)))
85 (gf (gdefinition gf-name)))
86 (compute-slot-accessor-info slotd type gf)))
87 (initialize-internal-slot-gfs name)))
89 (defmethod compute-slot-accessor-info ((slotd effective-slot-definition)
91 (let* ((name (slot-value slotd 'name))
92 (class (slot-value slotd 'class))
93 (old-slotd (find-slot-definition class name))
94 (old-std-p (and old-slotd (slot-accessor-std-p old-slotd 'all))))
95 (multiple-value-bind (function std-p)
96 (if (eq *boot-state* 'complete)
97 (get-accessor-method-function gf type class slotd)
98 (get-optimized-std-accessor-method-function class slotd type))
99 (setf (slot-accessor-std-p slotd type) std-p)
100 (setf (slot-accessor-function slotd type) function))
101 (when (and old-slotd (not (eq old-std-p (slot-accessor-std-p slotd 'all))))
102 (push (cons class name) *pv-table-cache-update-info*))))
104 (defmethod slot-definition-allocation ((slotd structure-slot-definition))
107 (defmethod shared-initialize :after ((object documentation-mixin)
109 &key (documentation nil documentation-p))
110 (declare (ignore slot-names))
111 (when documentation-p
112 (setf (plist-value object 'documentation) documentation)))
114 ;;; default if DOC-TYPE doesn't match one of the specified types
115 (defmethod documentation (object doc-type)
116 (warn "unsupported DOCUMENTATION: type ~S for object ~S"
121 ;;; default if DOC-TYPE doesn't match one of the specified types
122 (defmethod (setf documentation) (new-value object doc-type)
123 ;; CMU CL made this an error, but since ANSI says that even for supported
124 ;; doc types an implementation is permitted to discard docs at any time
125 ;; for any reason, this feels to me more like a warning. -- WHN 19991214
126 (warn "discarding unsupported DOCUMENTATION of type ~S for object ~S"
131 (defmethod documentation ((object documentation-mixin) doc-type)
132 (declare (ignore doc-type))
133 (plist-value object 'documentation))
135 (defmethod (setf documentation) (new-value
136 (object documentation-mixin)
138 (declare (ignore doc-type))
139 (setf (plist-value object 'documentation) new-value))
141 (defmethod documentation ((slotd standard-slot-definition) doc-type)
142 (declare (ignore doc-type))
143 (slot-value slotd 'documentation))
145 (defmethod (setf documentation) (new-value
146 (slotd standard-slot-definition)
148 (declare (ignore doc-type))
149 (setf (slot-value slotd 'documentation) new-value))
151 ;;;; various class accessors that are a little more complicated than can be
152 ;;;; done with automatically generated reader methods
154 (defmethod class-finalized-p ((class pcl-class))
155 (with-slots (wrapper) class
156 (not (null wrapper))))
158 (defmethod class-prototype ((class std-class))
159 (with-slots (prototype) class
160 (or prototype (setq prototype (allocate-instance class)))))
162 (defmethod class-prototype ((class structure-class))
163 (with-slots (prototype wrapper defstruct-constructor) class
166 (if defstruct-constructor
167 (allocate-instance class)
168 (allocate-standard-instance wrapper))))))
170 (defmethod class-direct-default-initargs ((class slot-class))
171 (plist-value class 'direct-default-initargs))
173 (defmethod class-default-initargs ((class slot-class))
174 (plist-value class 'default-initargs))
176 (defmethod class-slot-cells ((class std-class))
177 (plist-value class 'class-slot-cells))
179 ;;;; class accessors that are even a little bit more complicated than those
180 ;;;; above. These have a protocol for updating them, we must implement that
183 ;;; Maintaining the direct subclasses backpointers. The update methods are
184 ;;; here, the values are read by an automatically generated reader method.
185 (defmethod add-direct-subclass ((class class) (subclass class))
186 (with-slots (direct-subclasses) class
187 (pushnew subclass direct-subclasses)
189 (defmethod remove-direct-subclass ((class class) (subclass class))
190 (with-slots (direct-subclasses) class
191 (setq direct-subclasses (remove subclass direct-subclasses))
194 ;;; Maintaining the direct-methods and direct-generic-functions backpointers.
196 ;;; There are four generic functions involved, each has one method for the
197 ;;; class case and another method for the damned EQL specializers. All of
198 ;;; these are specified methods and appear in their specified place in the
201 ;;; ADD-DIRECT-METHOD
202 ;;; REMOVE-DIRECT-METHOD
203 ;;; SPECIALIZER-DIRECT-METHODS
204 ;;; SPECIALIZER-DIRECT-GENERIC-FUNCTIONS
206 ;;; In each case, we maintain one value which is a cons. The car is the list
207 ;;; methods. The cdr is a list of the generic functions. The cdr is always
209 (defmethod add-direct-method ((specializer class) (method method))
210 (with-slots (direct-methods) specializer
211 (setf (car direct-methods) (adjoin method (car direct-methods)) ;PUSH
212 (cdr direct-methods) ()))
214 (defmethod remove-direct-method ((specializer class) (method method))
215 (with-slots (direct-methods) specializer
216 (setf (car direct-methods) (remove method (car direct-methods))
217 (cdr direct-methods) ()))
220 (defmethod specializer-direct-methods ((specializer class))
221 (with-slots (direct-methods) specializer
222 (car direct-methods)))
224 (defmethod specializer-direct-generic-functions ((specializer class))
225 (with-slots (direct-methods) specializer
226 (or (cdr direct-methods)
227 (setf (cdr direct-methods)
229 (dolist (m (car direct-methods))
230 ;; the old PCL code used COLLECTING-ONCE which used
231 ;; #'EQ to check for newness
232 (pushnew (method-generic-function m) collect :test #'eq))
233 (nreverse collect))))))
235 ;;; This hash table is used to store the direct methods and direct generic
236 ;;; functions of EQL specializers. Each value in the table is the cons.
237 (defvar *eql-specializer-methods* (make-hash-table :test 'eql))
238 (defvar *class-eq-specializer-methods* (make-hash-table :test 'eq))
240 (defmethod specializer-method-table ((specializer eql-specializer))
241 *eql-specializer-methods*)
243 (defmethod specializer-method-table ((specializer class-eq-specializer))
244 *class-eq-specializer-methods*)
246 (defmethod add-direct-method ((specializer specializer-with-object)
248 (let* ((object (specializer-object specializer))
249 (table (specializer-method-table specializer))
250 (entry (gethash object table)))
253 (setf (gethash object table)
255 (setf (car entry) (adjoin method (car entry))
259 (defmethod remove-direct-method ((specializer specializer-with-object)
261 (let* ((object (specializer-object specializer))
262 (entry (gethash object (specializer-method-table specializer))))
264 (setf (car entry) (remove method (car entry))
268 (defmethod specializer-direct-methods ((specializer specializer-with-object))
269 (car (gethash (specializer-object specializer)
270 (specializer-method-table specializer))))
272 (defmethod specializer-direct-generic-functions ((specializer
273 specializer-with-object))
274 (let* ((object (specializer-object specializer))
275 (entry (gethash object (specializer-method-table specializer))))
280 (dolist (m (car entry))
281 (pushnew (method-generic-function m) collect :test #'eq))
282 (nreverse collect)))))))
284 (defun map-specializers (function)
285 (map-all-classes (lambda (class)
286 (funcall function (class-eq-specializer class))
287 (funcall function class)))
288 (maphash (lambda (object methods)
289 (declare (ignore methods))
290 (intern-eql-specializer object))
291 *eql-specializer-methods*)
292 (maphash (lambda (object specl)
293 (declare (ignore object))
294 (funcall function specl))
295 *eql-specializer-table*)
298 (defun map-all-generic-functions (function)
299 (let ((all-generic-functions (make-hash-table :test 'eq)))
300 (map-specializers (lambda (specl)
301 (dolist (gf (specializer-direct-generic-functions
303 (unless (gethash gf all-generic-functions)
304 (setf (gethash gf all-generic-functions) t)
305 (funcall function gf))))))
308 (defmethod shared-initialize :after ((specl class-eq-specializer)
311 (declare (ignore slot-names))
312 (setf (slot-value specl 'type) `(class-eq ,(specializer-class specl))))
314 (defmethod shared-initialize :after ((specl eql-specializer) slot-names &key)
315 (declare (ignore slot-names))
316 (setf (slot-value specl 'type) `(eql ,(specializer-object specl))))
318 (defun real-load-defclass (name metaclass-name supers slots other)
319 (let ((res (apply #'ensure-class name :metaclass metaclass-name
320 :direct-superclasses supers
322 :definition-source `((defclass ,name)
325 ;; Defclass of a class with a forward-referenced superclass does not
326 ;; have a wrapper. RES is the incomplete PCL class. The Lisp class
327 ;; does not yet exist. Maybe should return NIL in that case as RES
328 ;; is not useful to the user?
329 (and (class-wrapper res) (sb-kernel:layout-class (class-wrapper res)))))
331 (setf (gdefinition 'load-defclass) #'real-load-defclass)
333 (defun ensure-class (name &rest all)
334 (apply #'ensure-class-using-class name (find-class name nil) all))
336 (defmethod ensure-class-using-class (name (class null) &rest args &key)
337 (multiple-value-bind (meta initargs)
338 (ensure-class-values class args)
339 (setf class (apply #'make-instance meta :name name initargs)
340 (find-class name) class)
343 (defmethod ensure-class-using-class (name (class pcl-class) &rest args &key)
344 (multiple-value-bind (meta initargs)
345 (ensure-class-values class args)
346 (unless (eq (class-of class) meta) (change-class class meta))
347 (apply #'reinitialize-instance class initargs)
348 (setf (find-class name) class)
351 (defmethod class-predicate-name ((class t))
356 ((not (legal-class-name-p s))
357 (error "~S is not a class or a legal class name." s))
359 (or (find-class s nil)
361 (make-instance 'forward-referenced-class
364 (defun ensure-class-values (class args)
365 (let* ((initargs (copy-list args))
366 (unsupplied (list 1))
367 (supplied-meta (getf initargs :metaclass unsupplied))
368 (supplied-supers (getf initargs :direct-superclasses unsupplied))
369 (supplied-slots (getf initargs :direct-slots unsupplied))
371 (cond ((neq supplied-meta unsupplied)
372 (find-class supplied-meta))
374 (forward-referenced-class-p class))
375 *the-class-standard-class*)
378 (loop (unless (remf initargs :metaclass) (return)))
379 (loop (unless (remf initargs :direct-superclasses) (return)))
380 (loop (unless (remf initargs :direct-slots) (return)))
382 (list* :direct-superclasses
383 (and (neq supplied-supers unsupplied)
384 (mapcar #'fix-super supplied-supers))
386 (and (neq supplied-slots unsupplied) supplied-slots)
390 (defmethod shared-initialize :after
393 &key (direct-superclasses nil direct-superclasses-p)
394 (direct-slots nil direct-slots-p)
395 (direct-default-initargs nil direct-default-initargs-p)
396 (predicate-name nil predicate-name-p))
397 (declare (ignore slot-names))
398 (cond (direct-superclasses-p
399 (setq direct-superclasses
400 (or direct-superclasses
401 (list (if (funcallable-standard-class-p class)
402 *the-class-funcallable-standard-object*
403 *the-class-standard-object*))))
404 (dolist (superclass direct-superclasses)
405 (unless (validate-superclass class superclass)
406 (error "The class ~S was specified as a~%
407 super-class of the class ~S;~%~
408 but the meta-classes ~S and~%~S are incompatible.~@
409 Define a method for ~S to avoid this error."
410 superclass class (class-of superclass) (class-of class)
411 'validate-superclass)))
412 (setf (slot-value class 'direct-superclasses) direct-superclasses))
414 (setq direct-superclasses (slot-value class 'direct-superclasses))))
417 (setf (slot-value class 'direct-slots)
418 (mapcar (lambda (pl) (make-direct-slotd class pl))
420 (slot-value class 'direct-slots)))
421 (if direct-default-initargs-p
422 (setf (plist-value class 'direct-default-initargs)
423 direct-default-initargs)
424 (setq direct-default-initargs
425 (plist-value class 'direct-default-initargs)))
426 (setf (plist-value class 'class-slot-cells)
428 (dolist (dslotd direct-slots)
429 (when (eq (slot-definition-allocation dslotd) class)
430 (let ((initfunction (slot-definition-initfunction dslotd)))
431 (push (cons (slot-definition-name dslotd)
433 (funcall initfunction)
437 (setq predicate-name (if predicate-name-p
438 (setf (slot-value class 'predicate-name)
439 (car predicate-name))
440 (or (slot-value class 'predicate-name)
441 (setf (slot-value class 'predicate-name)
442 (make-class-predicate-name (class-name
444 (add-direct-subclasses class direct-superclasses)
445 (update-class class nil)
446 (make-class-predicate class predicate-name)
447 (add-slot-accessors class direct-slots))
449 (defmethod shared-initialize :before ((class class) slot-names &key name)
450 (declare (ignore slot-names name))
451 ;; FIXME: Could this just be CLASS instead of `(CLASS ,CLASS)? If not,
452 ;; why not? (See also similar expression in !BOOTSTRAP-INITIALIZE-CLASS.)
453 (setf (slot-value class 'type) `(class ,class))
454 (setf (slot-value class 'class-eq-specializer)
455 (make-instance 'class-eq-specializer :class class)))
457 (defmethod reinitialize-instance :before ((class slot-class) &key)
458 (remove-direct-subclasses class (class-direct-superclasses class))
459 (remove-slot-accessors class (class-direct-slots class)))
461 (defmethod reinitialize-instance :after ((class slot-class)
464 (map-dependents class
466 (apply #'update-dependent class dependent initargs))))
468 (defmethod shared-initialize :after ((slotd standard-slot-definition)
470 (declare (ignore slot-names))
471 (with-slots (allocation class)
473 (setq allocation (if (eq allocation :class) class allocation))))
475 (defmethod shared-initialize :after ((slotd structure-slot-definition)
477 &key (allocation :instance))
478 (declare (ignore slot-names))
479 (unless (eq allocation :instance)
480 (error "Structure slots must have :INSTANCE allocation.")))
482 (defun make-structure-class-defstruct-form (name direct-slots include)
483 (let* ((conc-name (intern (format nil "~S structure class " name)))
484 (constructor (intern (format nil "~Aconstructor" conc-name)))
485 (defstruct `(defstruct (,name
487 `((:include ,(class-name include))))
489 (:conc-name ,conc-name)
490 (:constructor ,constructor ())
492 ,@(mapcar (lambda (slot)
493 `(,(slot-definition-name slot)
496 (reader-names (mapcar (lambda (slotd)
500 (slot-definition-name
503 (writer-names (mapcar (lambda (slotd)
507 (slot-definition-name
511 (mapcar (lambda (slotd reader-name)
513 (slot-definition-defstruct-accessor-symbol
515 `(defun ,reader-name (obj)
516 (declare (type ,name obj))
518 direct-slots reader-names))
520 (mapcar (lambda (slotd writer-name)
522 (slot-definition-defstruct-accessor-symbol
524 `(defun ,writer-name (nv obj)
525 (declare (type ,name obj))
526 (setf (,accessor obj) nv))))
527 direct-slots writer-names))
531 ,@readers-init ,@writers-init
533 (values defstruct-form constructor reader-names writer-names)))
535 (defmethod shared-initialize :after
536 ((class structure-class)
538 &key (direct-superclasses nil direct-superclasses-p)
539 (direct-slots nil direct-slots-p)
540 direct-default-initargs
541 (predicate-name nil predicate-name-p))
542 (declare (ignore slot-names direct-default-initargs))
543 (if direct-superclasses-p
544 (setf (slot-value class 'direct-superclasses)
545 (or direct-superclasses
546 (setq direct-superclasses
547 (and (not (eq (class-name class) 'structure-object))
548 (list *the-class-structure-object*)))))
549 (setq direct-superclasses (slot-value class 'direct-superclasses)))
550 (let* ((name (class-name class))
551 (from-defclass-p (slot-value class 'from-defclass-p))
552 (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
554 (setf (slot-value class 'direct-slots)
558 (let* ((slot-name (getf pl :name))
561 "~S structure class ~A"
563 (accessor (intern acc-name)))
564 (setq pl (list* :defstruct-accessor-symbol
566 (make-direct-slotd class pl))
568 (setq direct-slots (slot-value class 'direct-slots)))
570 (let ((include (car (slot-value class 'direct-superclasses))))
571 (multiple-value-bind (defstruct-form constructor reader-names writer-names)
572 (make-structure-class-defstruct-form name direct-slots include)
573 (unless (structure-type-p name) (eval defstruct-form))
574 (mapc (lambda (dslotd reader-name writer-name)
575 (let* ((reader (gdefinition reader-name))
576 (writer (when (gboundp writer-name)
577 (gdefinition writer-name))))
578 (setf (slot-value dslotd 'internal-reader-function)
580 (setf (slot-value dslotd 'internal-writer-function)
582 direct-slots reader-names writer-names)
583 (setf (slot-value class 'defstruct-form) defstruct-form)
584 (setf (slot-value class 'defstruct-constructor) constructor))))
585 (add-direct-subclasses class direct-superclasses)
586 (setf (slot-value class 'class-precedence-list)
587 (compute-class-precedence-list class))
588 (setf (slot-value class 'slots) (compute-slots class))
589 (let ((lclass (cl:find-class (class-name class))))
590 (setf (sb-kernel:class-pcl-class lclass) class)
591 (setf (slot-value class 'wrapper) (sb-kernel:class-layout lclass)))
592 (update-pv-table-cache-info class)
593 (setq predicate-name (if predicate-name-p
594 (setf (slot-value class 'predicate-name)
595 (car predicate-name))
596 (or (slot-value class 'predicate-name)
597 (setf (slot-value class 'predicate-name)
598 (make-class-predicate-name
599 (class-name class))))))
600 (make-class-predicate class predicate-name)
601 (add-slot-accessors class direct-slots)))
603 (defmethod direct-slot-definition-class ((class structure-class) initargs)
604 (declare (ignore initargs))
605 (find-class 'structure-direct-slot-definition))
607 (defmethod finalize-inheritance ((class structure-class))
608 nil) ; always finalized
610 (defun add-slot-accessors (class dslotds)
611 (fix-slot-accessors class dslotds 'add))
613 (defun remove-slot-accessors (class dslotds)
614 (fix-slot-accessors class dslotds 'remove))
616 (defun fix-slot-accessors (class dslotds add/remove)
617 (flet ((fix (gfspec name r/w)
618 (let ((gf (ensure-generic-function gfspec)))
620 (r (if (eq add/remove 'add)
621 (add-reader-method class gf name)
622 (remove-reader-method class gf)))
623 (w (if (eq add/remove 'add)
624 (add-writer-method class gf name)
625 (remove-writer-method class gf)))))))
626 (dolist (dslotd dslotds)
627 (let ((slot-name (slot-definition-name dslotd)))
628 (dolist (r (slot-definition-readers dslotd)) (fix r slot-name 'r))
629 (dolist (w (slot-definition-writers dslotd)) (fix w slot-name 'w))))))
631 (defun add-direct-subclasses (class supers)
632 (dolist (super supers)
633 (unless (memq class (class-direct-subclasses class))
634 (add-direct-subclass super class))))
636 (defun remove-direct-subclasses (class supers)
637 (let ((old (class-direct-superclasses class)))
638 (dolist (o (set-difference old supers))
639 (remove-direct-subclass o class))))
641 (defmethod finalize-inheritance ((class std-class))
642 (update-class class t))
644 (defun class-has-a-forward-referenced-superclass-p (class)
645 (or (forward-referenced-class-p class)
646 (some #'class-has-a-forward-referenced-superclass-p
647 (class-direct-superclasses class))))
649 ;;; This is called by :after shared-initialize whenever a class is initialized
650 ;;; or reinitialized. The class may or may not be finalized.
651 (defun update-class (class finalizep)
652 (when (or finalizep (class-finalized-p class)
653 (not (class-has-a-forward-referenced-superclass-p class)))
654 (update-cpl class (compute-class-precedence-list class))
655 (update-slots class (compute-slots class))
656 (update-gfs-of-class class)
657 (update-inits class (compute-default-initargs class))
658 (update-make-instance-function-table class))
660 (dolist (sub (class-direct-subclasses class)) (update-class sub nil))))
662 (defun update-cpl (class cpl)
663 (if (class-finalized-p class)
664 (unless (equal (class-precedence-list class) cpl)
665 ;; comment from the old CMU CL sources:
666 ;; Need to have the cpl setup before update-lisp-class-layout
667 ;; is called on CMU CL.
668 (setf (slot-value class 'class-precedence-list) cpl)
669 (force-cache-flushes class))
670 (setf (slot-value class 'class-precedence-list) cpl))
671 (update-class-can-precede-p cpl))
673 (defun update-class-can-precede-p (cpl)
675 (let ((first (car cpl)))
676 (dolist (c (cdr cpl))
677 (pushnew c (slot-value first 'can-precede-list))))
678 (update-class-can-precede-p (cdr cpl))))
680 (defun class-can-precede-p (class1 class2)
681 (member class2 (class-can-precede-list class1)))
683 (defun update-slots (class eslotds)
684 (let ((instance-slots ())
686 (dolist (eslotd eslotds)
687 (let ((alloc (slot-definition-allocation eslotd)))
688 (cond ((eq alloc :instance) (push eslotd instance-slots))
689 ((classp alloc) (push eslotd class-slots)))))
691 ;; If there is a change in the shape of the instances then the
692 ;; old class is now obsolete.
693 (let* ((nlayout (mapcar #'slot-definition-name
694 (sort instance-slots #'<
695 :key #'slot-definition-location)))
696 (nslots (length nlayout))
697 (nwrapper-class-slots (compute-class-slots class-slots))
698 (owrapper (class-wrapper class))
699 (olayout (and owrapper (wrapper-instance-slots-layout owrapper)))
700 (owrapper-class-slots (and owrapper (wrapper-class-slots owrapper)))
702 (cond ((null owrapper)
703 (make-wrapper nslots class))
704 ((and (equal nlayout olayout)
706 (loop for o in owrapper-class-slots
707 for n in nwrapper-class-slots
708 do (unless (eq (car o) (car n)) (return t)))))
711 ;; This will initialize the new wrapper to have the
712 ;; same state as the old wrapper. We will then have
713 ;; to change that. This may seem like wasted work
714 ;; (and it is), but the spec requires that we call
715 ;; MAKE-INSTANCES-OBSOLETE.
716 (make-instances-obsolete class)
717 (class-wrapper class)))))
719 (with-slots (wrapper slots) class
720 (update-lisp-class-layout class nwrapper)
722 (wrapper-instance-slots-layout nwrapper) nlayout
723 (wrapper-class-slots nwrapper) nwrapper-class-slots
724 (wrapper-no-of-instance-slots nwrapper) nslots
727 (unless (eq owrapper nwrapper)
728 (update-pv-table-cache-info class)))))
730 (defun compute-class-slots (eslotds)
732 (dolist (eslotd eslotds)
733 (push (assoc (slot-definition-name eslotd)
734 (class-slot-cells (slot-definition-allocation eslotd)))
738 (defun compute-layout (cpl instance-eslotds)
741 (dolist (eslotd instance-eslotds)
742 (when (eq (slot-definition-allocation eslotd) :instance)
743 (push (slot-definition-name eslotd) collect)))
746 (labels ((rwalk (tail)
749 (dolist (ss (class-slots (car tail)))
750 (let ((n (slot-definition-name ss)))
751 (when (member n names)
752 (setq order (cons n order)
753 names (remove n names))))))))
754 (rwalk (if (slot-boundp (car cpl) 'slots)
757 (reverse (append names order)))))
759 (defun update-gfs-of-class (class)
760 (when (and (class-finalized-p class)
761 (let ((cpl (class-precedence-list class)))
762 (or (member *the-class-slot-class* cpl)
763 (member *the-class-standard-effective-slot-definition*
765 (let ((gf-table (make-hash-table :test 'eq)))
766 (labels ((collect-gfs (class)
767 (dolist (gf (specializer-direct-generic-functions class))
768 (setf (gethash gf gf-table) t))
769 (mapc #'collect-gfs (class-direct-superclasses class))))
771 (maphash (lambda (gf ignore)
772 (declare (ignore ignore))
773 (update-gf-dfun class gf))
776 (defun update-inits (class inits)
777 (setf (plist-value class 'default-initargs) inits))
779 (defmethod compute-default-initargs ((class slot-class))
780 (let ((cpl (class-precedence-list class))
781 (direct (class-direct-default-initargs class)))
782 (labels ((walk (tail)
785 (let ((c (pop tail)))
786 (append (if (eq c class)
788 (class-direct-default-initargs c))
790 (let ((initargs (walk cpl)))
791 (delete-duplicates initargs :test #'eq :key #'car :from-end t)))))
793 ;;;; protocols for constructing direct and effective slot definitions
795 (defmethod direct-slot-definition-class ((class std-class) initargs)
796 (declare (ignore initargs))
797 (find-class 'standard-direct-slot-definition))
799 (defun make-direct-slotd (class initargs)
800 (let ((initargs (list* :class class initargs)))
801 (apply #'make-instance
802 (direct-slot-definition-class class initargs)
805 (defmethod compute-slots ((class std-class))
806 ;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
807 ;; for each different slot name we find in our superclasses. Each
808 ;; call receives the class and a list of the dslotds with that name.
809 ;; The list is in most-specific-first order.
810 (let ((name-dslotds-alist ()))
811 (dolist (c (class-precedence-list class))
812 (let ((dslotds (class-direct-slots c)))
814 (let* ((name (slot-definition-name d))
815 (entry (assq name name-dslotds-alist)))
818 (push (list name d) name-dslotds-alist))))))
819 (mapcar (lambda (direct)
820 (compute-effective-slot-definition class
821 (nreverse (cdr direct))))
822 name-dslotds-alist)))
824 (defmethod compute-slots :around ((class std-class))
825 (let ((eslotds (call-next-method))
826 (cpl (class-precedence-list class))
829 (dolist (eslotd eslotds)
830 (let ((alloc (slot-definition-allocation eslotd)))
831 (cond ((eq alloc :instance) (push eslotd instance-slots))
832 ((classp alloc) (push eslotd class-slots)))))
833 (let ((nlayout (compute-layout cpl instance-slots)))
834 (dolist (eslotd instance-slots)
835 (setf (slot-definition-location eslotd)
836 (position (slot-definition-name eslotd) nlayout))))
837 (dolist (eslotd class-slots)
838 (setf (slot-definition-location eslotd)
839 (assoc (slot-definition-name eslotd)
840 (class-slot-cells (slot-definition-allocation eslotd)))))
841 (mapc #'initialize-internal-slot-functions eslotds)
844 (defmethod compute-slots ((class structure-class))
845 (mapcan (lambda (superclass)
846 (mapcar (lambda (dslotd)
847 (compute-effective-slot-definition class
849 (class-direct-slots superclass)))
850 (reverse (slot-value class 'class-precedence-list))))
852 (defmethod compute-slots :around ((class structure-class))
853 (let ((eslotds (call-next-method)))
854 (mapc #'initialize-internal-slot-functions eslotds)
857 (defmethod compute-effective-slot-definition ((class slot-class) dslotds)
858 (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
859 (class (effective-slot-definition-class class initargs)))
860 (apply #'make-instance class initargs)))
862 (defmethod effective-slot-definition-class ((class std-class) initargs)
863 (declare (ignore initargs))
864 (find-class 'standard-effective-slot-definition))
866 (defmethod effective-slot-definition-class ((class structure-class) initargs)
867 (declare (ignore initargs))
868 (find-class 'structure-effective-slot-definition))
870 (defmethod compute-effective-slot-definition-initargs
871 ((class slot-class) direct-slotds)
882 (dolist (slotd direct-slotds)
885 (setq name (slot-definition-name slotd)
888 (when (slot-definition-initfunction slotd)
889 (setq initform (slot-definition-initform slotd)
890 initfunction (slot-definition-initfunction slotd)
893 (setq allocation (slot-definition-allocation slotd)
895 (setq initargs (append (slot-definition-initargs slotd) initargs))
896 (let ((slotd-type (slot-definition-type slotd)))
897 (setq type (cond ((eq type t) slotd-type)
898 ((*subtypep type slotd-type) type)
899 (t `(and ,type ,slotd-type)))))))
902 :initfunction initfunction
904 :allocation allocation
908 (defmethod compute-effective-slot-definition-initargs :around
909 ((class structure-class) direct-slotds)
910 (let ((slotd (car direct-slotds)))
911 (list* :defstruct-accessor-symbol
912 (slot-definition-defstruct-accessor-symbol slotd)
913 :internal-reader-function
914 (slot-definition-internal-reader-function slotd)
915 :internal-writer-function
916 (slot-definition-internal-writer-function slotd)
917 (call-next-method))))
919 ;;; NOTE: For bootstrapping considerations, these can't use MAKE-INSTANCE
920 ;;; to make the method object. They have to use make-a-method which
921 ;;; is a specially bootstrapped mechanism for making standard methods.
922 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
923 (declare (ignore direct-slot initargs))
924 (find-class 'standard-reader-method))
926 (defmethod add-reader-method ((class slot-class) generic-function slot-name)
927 (add-method generic-function
928 (make-a-method 'standard-reader-method
930 (list (or (class-name class) 'object))
932 (make-reader-method-function class slot-name)
933 "automatically generated reader method"
936 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
937 (declare (ignore direct-slot initargs))
938 (find-class 'standard-writer-method))
940 (defmethod add-writer-method ((class slot-class) generic-function slot-name)
941 (add-method generic-function
942 (make-a-method 'standard-writer-method
944 (list 'new-value (or (class-name class) 'object))
945 (list *the-class-t* class)
946 (make-writer-method-function class slot-name)
947 "automatically generated writer method"
950 (defmethod add-boundp-method ((class slot-class) generic-function slot-name)
951 (add-method generic-function
952 (make-a-method 'standard-boundp-method
954 (list (or (class-name class) 'object))
956 (make-boundp-method-function class slot-name)
957 "automatically generated boundp method"
960 (defmethod remove-reader-method ((class slot-class) generic-function)
961 (let ((method (get-method generic-function () (list class) nil)))
962 (when method (remove-method generic-function method))))
964 (defmethod remove-writer-method ((class slot-class) generic-function)
966 (get-method generic-function () (list *the-class-t* class) nil)))
967 (when method (remove-method generic-function method))))
969 (defmethod remove-boundp-method ((class slot-class) generic-function)
970 (let ((method (get-method generic-function () (list class) nil)))
971 (when method (remove-method generic-function method))))
973 ;;; MAKE-READER-METHOD-FUNCTION and MAKE-WRITE-METHOD function are NOT
974 ;;; part of the standard protocol. They are however useful, PCL makes
975 ;;; use of them internally and documents them for PCL users.
977 ;;; *** This needs work to make type testing by the writer functions which
978 ;;; *** do type testing faster. The idea would be to have one constructor
979 ;;; *** for each possible type test.
981 ;;; *** There is a subtle bug here which is going to have to be fixed.
982 ;;; *** Namely, the simplistic use of the template has to be fixed. We
983 ;;; *** have to give the OPTIMIZE-SLOT-VALUE method the user might have
984 ;;; *** defined for this metaclass a chance to run.
986 (defmethod make-reader-method-function ((class slot-class) slot-name)
987 (make-std-reader-method-function (class-name class) slot-name))
989 (defmethod make-writer-method-function ((class slot-class) slot-name)
990 (make-std-writer-method-function (class-name class) slot-name))
992 (defmethod make-boundp-method-function ((class slot-class) slot-name)
993 (make-std-boundp-method-function (class-name class) slot-name))
995 (defmethod compatible-meta-class-change-p (class proto-new-class)
996 (eq (class-of class) (class-of proto-new-class)))
998 (defmethod validate-superclass ((class class) (new-super class))
999 (or (eq new-super *the-class-t*)
1000 (eq (class-of class) (class-of new-super))))
1002 (defmethod validate-superclass ((class standard-class) (new-super std-class))
1003 (let ((new-super-meta-class (class-of new-super)))
1004 (or (eq new-super-meta-class *the-class-std-class*)
1005 (eq (class-of class) new-super-meta-class))))
1007 (defun force-cache-flushes (class)
1008 (let* ((owrapper (class-wrapper class)))
1009 ;; We only need to do something if the state is still T. If the
1010 ;; state isn't T, it will be FLUSH or OBSOLETE, and both of those
1011 ;; will already be doing what we want. In particular, we must be
1012 ;; sure we never change an OBSOLETE into a FLUSH since OBSOLETE
1013 ;; means do what FLUSH does and then some.
1014 (unless (invalid-wrapper-p owrapper)
1015 (let ((nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1017 (setf (wrapper-instance-slots-layout nwrapper)
1018 (wrapper-instance-slots-layout owrapper))
1019 (setf (wrapper-class-slots nwrapper)
1020 (wrapper-class-slots owrapper))
1021 (sb-sys:without-interrupts
1022 (update-lisp-class-layout class nwrapper)
1023 (setf (slot-value class 'wrapper) nwrapper)
1024 (invalidate-wrapper owrapper :flush nwrapper))))))
1026 (defun flush-cache-trap (owrapper nwrapper instance)
1027 (declare (ignore owrapper))
1028 (set-wrapper instance nwrapper))
1030 ;;; MAKE-INSTANCES-OBSOLETE can be called by user code. It will cause
1031 ;;; the next access to the instance (as defined in 88-002R) to trap
1032 ;;; through the UPDATE-INSTANCE-FOR-REDEFINED-CLASS mechanism.
1033 (defmethod make-instances-obsolete ((class std-class))
1034 (let* ((owrapper (class-wrapper class))
1035 (nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1037 (setf (wrapper-instance-slots-layout nwrapper)
1038 (wrapper-instance-slots-layout owrapper))
1039 (setf (wrapper-class-slots nwrapper)
1040 (wrapper-class-slots owrapper))
1041 (sb-sys:without-interrupts
1042 (update-lisp-class-layout class nwrapper)
1043 (setf (slot-value class 'wrapper) nwrapper)
1044 (invalidate-wrapper owrapper :obsolete nwrapper)
1047 (defmethod make-instances-obsolete ((class symbol))
1048 (make-instances-obsolete (find-class class)))
1050 ;;; OBSOLETE-INSTANCE-TRAP is the internal trap that is called when we
1051 ;;; see an obsolete instance. The times when it is called are:
1052 ;;; - when the instance is involved in method lookup
1053 ;;; - when attempting to access a slot of an instance
1055 ;;; It is not called by class-of, wrapper-of, or any of the low-level
1056 ;;; instance access macros.
1058 ;;; Of course these times when it is called are an internal
1059 ;;; implementation detail of PCL and are not part of the documented
1060 ;;; description of when the obsolete instance update happens. The
1061 ;;; documented description is as it appears in 88-002R.
1063 ;;; This has to return the new wrapper, so it counts on all the
1064 ;;; methods on obsolete-instance-trap-internal to return the new
1065 ;;; wrapper. It also does a little internal error checking to make
1066 ;;; sure that the traps are only happening when they should, and that
1067 ;;; the trap methods are computing appropriate new wrappers.
1069 ;;; OBSOLETE-INSTANCE-TRAP might be called on structure instances
1070 ;;; after a structure is redefined. In most cases,
1071 ;;; OBSOLETE-INSTANCE-TRAP will not be able to fix the old instance,
1072 ;;; so it must signal an error. The hard part of this is that the
1073 ;;; error system and debugger might cause OBSOLETE-INSTANCE-TRAP to be
1074 ;;; called again, so in that case, we have to return some reasonable
1075 ;;; wrapper, instead.
1077 (defvar *in-obsolete-instance-trap* nil)
1078 (defvar *the-wrapper-of-structure-object*
1079 (class-wrapper (find-class 'structure-object)))
1081 (define-condition obsolete-structure (error)
1082 ((datum :reader obsolete-structure-datum :initarg :datum))
1084 (lambda (condition stream)
1085 ;; Don't try to print the structure, since it probably won't work.
1087 "~@<obsolete structure error for a structure of type ~2I~_~S~:>"
1088 (type-of (obsolete-structure-datum condition))))))
1090 (defun obsolete-instance-trap (owrapper nwrapper instance)
1091 (if (not (pcl-instance-p instance))
1092 (if *in-obsolete-instance-trap*
1093 *the-wrapper-of-structure-object*
1094 (let ((*in-obsolete-instance-trap* t))
1095 (error 'obsolete-structure :datum instance)))
1096 (let* ((class (wrapper-class* nwrapper))
1097 (copy (allocate-instance class)) ;??? allocate-instance ???
1098 (olayout (wrapper-instance-slots-layout owrapper))
1099 (nlayout (wrapper-instance-slots-layout nwrapper))
1100 (oslots (get-slots instance))
1101 (nslots (get-slots copy))
1102 (oclass-slots (wrapper-class-slots owrapper))
1106 ;; local --> local transfer
1107 ;; local --> shared discard
1108 ;; local --> -- discard
1109 ;; shared --> local transfer
1110 ;; shared --> shared discard
1111 ;; shared --> -- discard
1115 ;; Go through all the old local slots.
1117 (dolist (name olayout)
1118 (let ((npos (posq name nlayout)))
1120 (setf (clos-slots-ref nslots npos)
1121 (clos-slots-ref oslots opos))
1123 (push name discarded)
1124 (unless (eq (clos-slots-ref oslots opos) +slot-unbound+)
1125 (setf (getf plist name) (clos-slots-ref oslots opos))))))
1128 ;; Go through all the old shared slots.
1129 (dolist (oclass-slot-and-val oclass-slots)
1130 (let ((name (car oclass-slot-and-val))
1131 (val (cdr oclass-slot-and-val)))
1132 (let ((npos (posq name nlayout)))
1134 (setf (clos-slots-ref nslots npos) (cdr oclass-slot-and-val))
1135 (progn (push name discarded)
1136 (unless (eq val +slot-unbound+)
1137 (setf (getf plist name) val)))))))
1139 ;; Go through all the new local slots to compute the added slots.
1140 (dolist (nlocal nlayout)
1141 (unless (or (memq nlocal olayout)
1142 (assq nlocal oclass-slots))
1143 (push nlocal added)))
1145 (swap-wrappers-and-slots instance copy)
1147 (update-instance-for-redefined-class instance
1153 (defun change-class-internal (instance new-class initargs)
1154 (let* ((old-class (class-of instance))
1155 (copy (allocate-instance new-class))
1156 (new-wrapper (get-wrapper copy))
1157 (old-wrapper (class-wrapper old-class))
1158 (old-layout (wrapper-instance-slots-layout old-wrapper))
1159 (new-layout (wrapper-instance-slots-layout new-wrapper))
1160 (old-slots (get-slots instance))
1161 (new-slots (get-slots copy))
1162 (old-class-slots (wrapper-class-slots old-wrapper)))
1164 ;; "The values of local slots specified by both the class CTO and
1165 ;; CFROM are retained. If such a local slot was unbound, it
1166 ;; remains unbound."
1167 (let ((new-position 0))
1168 (dolist (new-slot new-layout)
1169 (let ((old-position (posq new-slot old-layout)))
1171 (setf (clos-slots-ref new-slots new-position)
1172 (clos-slots-ref old-slots old-position))))
1173 (incf new-position)))
1175 ;; "The values of slots specified as shared in the class CFROM and
1176 ;; as local in the class CTO are retained."
1177 (dolist (slot-and-val old-class-slots)
1178 (let ((position (posq (car slot-and-val) new-layout)))
1180 (setf (clos-slots-ref new-slots position) (cdr slot-and-val)))))
1182 ;; Make the copy point to the old instance's storage, and make the
1183 ;; old instance point to the new storage.
1184 (swap-wrappers-and-slots instance copy)
1186 (apply #'update-instance-for-different-class copy instance initargs)
1189 (defmethod change-class ((instance standard-object)
1190 (new-class standard-class)
1192 (change-class-internal instance new-class initargs))
1194 (defmethod change-class ((instance funcallable-standard-object)
1195 (new-class funcallable-standard-class)
1197 (change-class-internal instance new-class initargs))
1199 (defmethod change-class ((instance standard-object)
1200 (new-class funcallable-standard-class)
1202 (declare (ignore initargs))
1203 (error "You can't change the class of ~S to ~S~@
1204 because it isn't already an instance with metaclass ~S."
1205 instance new-class 'standard-class))
1207 (defmethod change-class ((instance funcallable-standard-object)
1208 (new-class standard-class)
1210 (declare (ignore initargs))
1211 (error "You can't change the class of ~S to ~S~@
1212 because it isn't already an instance with metaclass ~S."
1213 instance new-class 'funcallable-standard-class))
1215 (defmethod change-class ((instance t) (new-class-name symbol) &rest initargs)
1216 (apply #'change-class instance (find-class new-class-name) initargs))
1218 ;;;; The metaclass BUILT-IN-CLASS
1220 ;;;; This metaclass is something of a weird creature. By this point, all
1221 ;;;; instances of it which will exist have been created, and no instance
1222 ;;;; is ever created by calling MAKE-INSTANCE.
1224 ;;;; But, there are other parts of the protocol we must follow and those
1225 ;;;; definitions appear here.
1227 (defmethod shared-initialize :before
1228 ((class built-in-class) slot-names &rest initargs)
1229 (declare (ignore slot-names initargs))
1230 (error "attempt to initialize or reinitialize a built in class"))
1232 (defmethod class-direct-slots ((class built-in-class)) ())
1233 (defmethod class-slots ((class built-in-class)) ())
1234 (defmethod class-direct-default-initargs ((class built-in-class)) ())
1235 (defmethod class-default-initargs ((class built-in-class)) ())
1237 (defmethod validate-superclass ((c class) (s built-in-class))
1238 (or (eq s *the-class-t*)
1239 (eq s *the-class-stream*)))
1241 (defmethod validate-superclass ((c slot-class)
1242 (f forward-referenced-class))
1245 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1246 (pushnew dependent (plist-value metaobject 'dependents)))
1248 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1249 (setf (plist-value metaobject 'dependents)
1250 (delete dependent (plist-value metaobject 'dependents))))
1252 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1253 (dolist (dependent (plist-value metaobject 'dependents))
1254 (funcall function dependent)))