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-constructors ((class slot-class))
177 (plist-value class 'constructors))
179 (defmethod class-slot-cells ((class std-class))
180 (plist-value class 'class-slot-cells))
182 ;;;; class accessors that are even a little bit more complicated than those
183 ;;;; above. These have a protocol for updating them, we must implement that
186 ;;; Maintaining the direct subclasses backpointers. The update methods are
187 ;;; here, the values are read by an automatically generated reader method.
188 (defmethod add-direct-subclass ((class class) (subclass class))
189 (with-slots (direct-subclasses) class
190 (pushnew subclass direct-subclasses)
192 (defmethod remove-direct-subclass ((class class) (subclass class))
193 (with-slots (direct-subclasses) class
194 (setq direct-subclasses (remove subclass direct-subclasses))
197 ;;; Maintaining the direct-methods and direct-generic-functions backpointers.
199 ;;; There are four generic functions involved, each has one method for the
200 ;;; class case and another method for the damned EQL specializers. All of
201 ;;; these are specified methods and appear in their specified place in the
204 ;;; ADD-DIRECT-METHOD
205 ;;; REMOVE-DIRECT-METHOD
206 ;;; SPECIALIZER-DIRECT-METHODS
207 ;;; SPECIALIZER-DIRECT-GENERIC-FUNCTIONS
209 ;;; In each case, we maintain one value which is a cons. The car is the list
210 ;;; methods. The cdr is a list of the generic functions. The cdr is always
212 (defmethod add-direct-method ((specializer class) (method method))
213 (with-slots (direct-methods) specializer
214 (setf (car direct-methods) (adjoin method (car direct-methods)) ;PUSH
215 (cdr direct-methods) ()))
217 (defmethod remove-direct-method ((specializer class) (method method))
218 (with-slots (direct-methods) specializer
219 (setf (car direct-methods) (remove method (car direct-methods))
220 (cdr direct-methods) ()))
223 (defmethod specializer-direct-methods ((specializer class))
224 (with-slots (direct-methods) specializer
225 (car direct-methods)))
227 (defmethod specializer-direct-generic-functions ((specializer class))
228 (with-slots (direct-methods) specializer
229 (or (cdr direct-methods)
230 (setf (cdr direct-methods)
231 (gathering1 (collecting-once)
232 (dolist (m (car direct-methods))
233 (gather1 (method-generic-function m))))))))
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) (method method))
247 (let* ((object (specializer-object specializer))
248 (table (specializer-method-table specializer))
249 (entry (gethash object table)))
252 (setf (gethash object table)
254 (setf (car entry) (adjoin method (car entry))
258 (defmethod remove-direct-method ((specializer specializer-with-object) (method method))
259 (let* ((object (specializer-object specializer))
260 (entry (gethash object (specializer-method-table specializer))))
262 (setf (car entry) (remove method (car entry))
266 (defmethod specializer-direct-methods ((specializer specializer-with-object))
267 (car (gethash (specializer-object specializer)
268 (specializer-method-table specializer))))
270 (defmethod specializer-direct-generic-functions ((specializer specializer-with-object))
271 (let* ((object (specializer-object specializer))
272 (entry (gethash object (specializer-method-table specializer))))
276 (gathering1 (collecting-once)
277 (dolist (m (car entry))
278 (gather1 (method-generic-function m)))))))))
280 (defun map-specializers (function)
281 (map-all-classes #'(lambda (class)
282 (funcall function (class-eq-specializer class))
283 (funcall function class)))
284 (maphash #'(lambda (object methods)
285 (declare (ignore methods))
286 (intern-eql-specializer object))
287 *eql-specializer-methods*)
288 (maphash #'(lambda (object specl)
289 (declare (ignore object))
290 (funcall function specl))
291 *eql-specializer-table*)
294 (defun map-all-generic-functions (function)
295 (let ((all-generic-functions (make-hash-table :test 'eq)))
296 (map-specializers #'(lambda (specl)
297 (dolist (gf (specializer-direct-generic-functions specl))
298 (unless (gethash gf all-generic-functions)
299 (setf (gethash gf all-generic-functions) t)
300 (funcall function gf))))))
303 (defmethod shared-initialize :after ((specl class-eq-specializer) slot-names &key)
304 (declare (ignore slot-names))
305 (setf (slot-value specl 'type) `(class-eq ,(specializer-class specl))))
307 (defmethod shared-initialize :after ((specl eql-specializer) slot-names &key)
308 (declare (ignore slot-names))
309 (setf (slot-value specl 'type) `(eql ,(specializer-object specl))))
311 (defun real-load-defclass (name metaclass-name supers slots other accessors)
312 (do-standard-defsetfs-for-defclass accessors) ;***
313 (let ((res (apply #'ensure-class name :metaclass metaclass-name
314 :direct-superclasses supers
316 :definition-source `((defclass ,name)
319 ;; Defclass of a class with a forward-referenced superclass does not
320 ;; have a wrapper. RES is the incomplete PCL class. The Lisp class
321 ;; does not yet exist. Maybe should return NIL in that case as RES
322 ;; is not useful to the user?
323 (and (class-wrapper res) (sb-kernel:layout-class (class-wrapper res)))))
325 (setf (gdefinition 'load-defclass) #'real-load-defclass)
327 (defun ensure-class (name &rest all)
328 (apply #'ensure-class-using-class name (find-class name nil) all))
330 (defmethod ensure-class-using-class (name (class null) &rest args &key)
331 (multiple-value-bind (meta initargs)
332 (ensure-class-values class args)
333 (inform-type-system-about-class (class-prototype meta) name);***
334 (setf class (apply #'make-instance meta :name name initargs)
335 (find-class name) class)
336 (inform-type-system-about-class class name) ;***
339 (defmethod ensure-class-using-class (name (class pcl-class) &rest args &key)
340 (multiple-value-bind (meta initargs)
341 (ensure-class-values class args)
342 (unless (eq (class-of class) meta) (change-class class meta))
343 (apply #'reinitialize-instance class initargs)
344 (setf (find-class name) class)
345 (inform-type-system-about-class class name) ;***
348 (defmethod class-predicate-name ((class t))
351 (defun ensure-class-values (class args)
352 (let* ((initargs (copy-list args))
353 (unsupplied (list 1))
354 (supplied-meta (getf initargs :metaclass unsupplied))
355 (supplied-supers (getf initargs :direct-superclasses unsupplied))
356 (supplied-slots (getf initargs :direct-slots unsupplied))
358 (cond ((neq supplied-meta unsupplied)
359 (find-class supplied-meta))
361 (forward-referenced-class-p class))
362 *the-class-standard-class*)
365 (flet ((fix-super (s)
367 ((not (legal-class-name-p s))
368 (error "~S is not a class or a legal class name." s))
370 (or (find-class s nil)
372 (make-instance 'forward-referenced-class
374 (loop (unless (remf initargs :metaclass) (return)))
375 (loop (unless (remf initargs :direct-superclasses) (return)))
376 (loop (unless (remf initargs :direct-slots) (return)))
378 (list* :direct-superclasses
379 (and (neq supplied-supers unsupplied)
380 (mapcar #'fix-super supplied-supers))
382 (and (neq supplied-slots unsupplied) supplied-slots)
385 #|| ; since it doesn't do anything
386 (defmethod shared-initialize :before ((class std-class)
388 &key direct-superclasses)
389 (declare (ignore slot-names))
390 ;; *** error checking
394 (defmethod shared-initialize :after
397 &key (direct-superclasses nil direct-superclasses-p)
398 (direct-slots nil direct-slots-p)
399 (direct-default-initargs nil direct-default-initargs-p)
400 (predicate-name nil predicate-name-p))
401 (declare (ignore slot-names))
402 (cond (direct-superclasses-p
403 (setq direct-superclasses
404 (or direct-superclasses
405 (list (if (funcallable-standard-class-p class)
406 *the-class-funcallable-standard-object*
407 *the-class-standard-object*))))
408 (dolist (superclass direct-superclasses)
409 (unless (validate-superclass class superclass)
410 (error "The class ~S was specified as a~%
411 super-class of the class ~S;~%~
412 but the meta-classes ~S and~%~S are incompatible.~@
413 Define a method for ~S to avoid this error."
414 superclass class (class-of superclass) (class-of class)
415 'validate-superclass)))
416 (setf (slot-value class 'direct-superclasses) direct-superclasses))
418 (setq direct-superclasses (slot-value class 'direct-superclasses))))
421 (setf (slot-value class 'direct-slots)
422 (mapcar #'(lambda (pl) (make-direct-slotd class pl)) direct-slots))
423 (slot-value class 'direct-slots)))
424 (if direct-default-initargs-p
425 (setf (plist-value class 'direct-default-initargs) direct-default-initargs)
426 (setq direct-default-initargs (plist-value class 'direct-default-initargs)))
427 (setf (plist-value class 'class-slot-cells)
428 (gathering1 (collecting)
429 (dolist (dslotd direct-slots)
430 (when (eq (slot-definition-allocation dslotd) class)
431 (let ((initfunction (slot-definition-initfunction dslotd)))
432 (gather1 (cons (slot-definition-name dslotd)
434 (funcall initfunction)
435 +slot-unbound+))))))))
436 (setq predicate-name (if predicate-name-p
437 (setf (slot-value class 'predicate-name)
438 (car predicate-name))
439 (or (slot-value class 'predicate-name)
440 (setf (slot-value class 'predicate-name)
441 (make-class-predicate-name (class-name class))))))
442 (add-direct-subclasses class direct-superclasses)
443 (update-class class nil)
444 (make-class-predicate class predicate-name)
445 (add-slot-accessors class direct-slots))
447 (defmethod shared-initialize :before ((class class) slot-names &key name)
448 (declare (ignore slot-names name))
449 ;; FIXME: Could this just be CLASS instead of `(CLASS ,CLASS)? If not,
450 ;; why not? (See also similar expression in !BOOTSTRAP-INITIALIZE-CLASS.)
451 (setf (slot-value class 'type) `(class ,class))
452 (setf (slot-value class 'class-eq-specializer)
453 (make-instance 'class-eq-specializer :class class)))
455 (defmethod reinitialize-instance :before ((class slot-class) &key)
456 (remove-direct-subclasses class (class-direct-superclasses class))
457 (remove-slot-accessors class (class-direct-slots class)))
459 (defmethod reinitialize-instance :after ((class slot-class)
462 (map-dependents class
463 #'(lambda (dependent)
464 (apply #'update-dependent class dependent initargs))))
466 (defmethod shared-initialize :after
467 ((class structure-class)
469 &key (direct-superclasses nil direct-superclasses-p)
470 (direct-slots nil direct-slots-p)
471 direct-default-initargs
472 (predicate-name nil predicate-name-p))
473 (declare (ignore slot-names direct-default-initargs))
474 (if direct-superclasses-p
475 (setf (slot-value class 'direct-superclasses)
476 (or direct-superclasses
477 (setq direct-superclasses
478 (and (not (eq (class-name class) 'structure-object))
479 (list *the-class-structure-object*)))))
480 (setq direct-superclasses (slot-value class 'direct-superclasses)))
481 (let* ((name (class-name class))
482 (from-defclass-p (slot-value class 'from-defclass-p))
483 (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
485 (setf (slot-value class 'direct-slots)
487 (mapcar #'(lambda (pl)
489 (let* ((slot-name (getf pl :name))
490 (acc-name (format nil "~S structure class ~A"
492 (accessor (intern acc-name)))
493 (setq pl (list* :defstruct-accessor-symbol accessor
495 (make-direct-slotd class pl))
497 (setq direct-slots (slot-value class 'direct-slots)))
499 (let* ((include (car (slot-value class 'direct-superclasses)))
500 (conc-name (intern (format nil "~S structure class " name)))
501 (constructor (intern (format nil "~A constructor" conc-name)))
502 (defstruct `(defstruct (,name
504 `((:include ,(class-name include))))
505 (:print-function print-std-instance)
507 (:conc-name ,conc-name)
508 (:constructor ,constructor ()))
509 ,@(mapcar #'(lambda (slot)
510 `(,(slot-definition-name slot)
513 (reader-names (mapcar (lambda (slotd)
517 (slot-definition-name
520 (writer-names (mapcar (lambda (slotd)
524 (slot-definition-name
528 (mapcar (lambda (slotd reader-name)
530 (slot-definition-defstruct-accessor-symbol
532 `(defun ,reader-name (obj)
533 (declare (type ,name obj))
535 direct-slots reader-names))
537 (mapcar (lambda (slotd writer-name)
539 (slot-definition-defstruct-accessor-symbol
541 `(defun ,writer-name (nv obj)
542 (declare (type ,name obj))
543 (setf (,accessor obj) nv))))
544 direct-slots writer-names))
548 ,@readers-init ,@writers-init
549 (declare-structure ',name nil nil))))
550 (unless (structure-type-p name) (eval defstruct-form))
551 (mapc #'(lambda (dslotd reader-name writer-name)
552 (let* ((reader (gdefinition reader-name))
553 (writer (when (gboundp writer-name)
554 (gdefinition writer-name))))
555 (setf (slot-value dslotd 'internal-reader-function)
557 (setf (slot-value dslotd 'internal-writer-function)
559 direct-slots reader-names writer-names)
560 (setf (slot-value class 'defstruct-form) defstruct-form)
561 (setf (slot-value class 'defstruct-constructor) constructor))))
562 (add-direct-subclasses class direct-superclasses)
563 (setf (slot-value class 'class-precedence-list)
564 (compute-class-precedence-list class))
565 (setf (slot-value class 'slots) (compute-slots class))
566 (let ((lclass (cl:find-class (class-name class))))
567 (setf (sb-kernel:class-pcl-class lclass) class)
568 (setf (slot-value class 'wrapper) (sb-kernel:class-layout lclass)))
569 (update-pv-table-cache-info class)
570 (setq predicate-name (if predicate-name-p
571 (setf (slot-value class 'predicate-name)
572 (car predicate-name))
573 (or (slot-value class 'predicate-name)
574 (setf (slot-value class 'predicate-name)
575 (make-class-predicate-name (class-name class))))))
576 (make-class-predicate class predicate-name)
577 (add-slot-accessors class direct-slots))
579 (defmethod direct-slot-definition-class ((class structure-class) initargs)
580 (declare (ignore initargs))
581 (find-class 'structure-direct-slot-definition))
583 (defmethod finalize-inheritance ((class structure-class))
584 nil) ; always finalized
586 (defun add-slot-accessors (class dslotds)
587 (fix-slot-accessors class dslotds 'add))
589 (defun remove-slot-accessors (class dslotds)
590 (fix-slot-accessors class dslotds 'remove))
592 (defun fix-slot-accessors (class dslotds add/remove)
593 (flet ((fix (gfspec name r/w)
594 (let ((gf (ensure-generic-function gfspec)))
596 (r (if (eq add/remove 'add)
597 (add-reader-method class gf name)
598 (remove-reader-method class gf)))
599 (w (if (eq add/remove 'add)
600 (add-writer-method class gf name)
601 (remove-writer-method class gf)))))))
602 (dolist (dslotd dslotds)
603 (let ((slot-name (slot-definition-name dslotd)))
604 (dolist (r (slot-definition-readers dslotd)) (fix r slot-name 'r))
605 (dolist (w (slot-definition-writers dslotd)) (fix w slot-name 'w))))))
607 (defun add-direct-subclasses (class new)
609 (unless (memq class (class-direct-subclasses class))
610 (add-direct-subclass n class))))
612 (defun remove-direct-subclasses (class new)
613 (let ((old (class-direct-superclasses class)))
614 (dolist (o (set-difference old new))
615 (remove-direct-subclass o class))))
617 (defmethod finalize-inheritance ((class std-class))
618 (update-class class t))
620 (defun class-has-a-forward-referenced-superclass-p (class)
621 (or (forward-referenced-class-p class)
622 (some #'class-has-a-forward-referenced-superclass-p
623 (class-direct-superclasses class))))
625 ;;; This is called by :after shared-initialize whenever a class is initialized
626 ;;; or reinitialized. The class may or may not be finalized.
627 (defun update-class (class finalizep)
628 (when (or finalizep (class-finalized-p class)
629 (not (class-has-a-forward-referenced-superclass-p class)))
630 (update-cpl class (compute-class-precedence-list class))
631 (update-slots class (compute-slots class))
632 (update-gfs-of-class class)
633 (update-inits class (compute-default-initargs class))
634 (update-make-instance-function-table class))
636 (dolist (sub (class-direct-subclasses class)) (update-class sub nil))))
638 (defun update-cpl (class cpl)
639 (if (class-finalized-p class)
640 (unless (equal (class-precedence-list class) cpl)
641 ;; comment from the old CMU CL sources:
642 ;; Need to have the cpl setup before update-lisp-class-layout
643 ;; is called on CMU CL.
644 (setf (slot-value class 'class-precedence-list) cpl)
645 (force-cache-flushes class))
646 (setf (slot-value class 'class-precedence-list) cpl))
647 (update-class-can-precede-p cpl))
649 (defun update-class-can-precede-p (cpl)
651 (let ((first (car cpl)))
652 (dolist (c (cdr cpl))
653 (pushnew c (slot-value first 'can-precede-list))))
654 (update-class-can-precede-p (cdr cpl))))
656 (defun class-can-precede-p (class1 class2)
657 (member class2 (class-can-precede-list class1)))
659 (defun update-slots (class eslotds)
660 (let ((instance-slots ())
662 (dolist (eslotd eslotds)
663 (let ((alloc (slot-definition-allocation eslotd)))
664 (cond ((eq alloc :instance) (push eslotd instance-slots))
665 ((classp alloc) (push eslotd class-slots)))))
667 ;; If there is a change in the shape of the instances then the
668 ;; old class is now obsolete.
669 (let* ((nlayout (mapcar #'slot-definition-name
670 (sort instance-slots #'< :key #'slot-definition-location)))
671 (nslots (length nlayout))
672 (nwrapper-class-slots (compute-class-slots class-slots))
673 (owrapper (class-wrapper class))
674 (olayout (and owrapper (wrapper-instance-slots-layout owrapper)))
675 (owrapper-class-slots (and owrapper (wrapper-class-slots owrapper)))
677 (cond ((null owrapper)
678 (make-wrapper nslots class))
679 ((and (equal nlayout olayout)
681 (iterate ((o (list-elements owrapper-class-slots))
682 (n (list-elements nwrapper-class-slots)))
683 (unless (eq (car o) (car n)) (return t)))))
686 ;; This will initialize the new wrapper to have the same
687 ;; state as the old wrapper. We will then have to change
688 ;; that. This may seem like wasted work (it is), but the
689 ;; spec requires that we call make-instances-obsolete.
690 (make-instances-obsolete class)
691 (class-wrapper class)))))
693 (with-slots (wrapper slots) class
694 (update-lisp-class-layout class nwrapper)
696 (wrapper-instance-slots-layout nwrapper) nlayout
697 (wrapper-class-slots nwrapper) nwrapper-class-slots
698 (wrapper-no-of-instance-slots nwrapper) nslots
701 (unless (eq owrapper nwrapper)
702 (update-pv-table-cache-info class)))))
704 (defun compute-class-slots (eslotds)
705 (gathering1 (collecting)
706 (dolist (eslotd eslotds)
708 (assoc (slot-definition-name eslotd)
709 (class-slot-cells (slot-definition-allocation eslotd)))))))
711 (defun compute-layout (cpl instance-eslotds)
713 (gathering1 (collecting)
714 (dolist (eslotd instance-eslotds)
715 (when (eq (slot-definition-allocation eslotd) :instance)
716 (gather1 (slot-definition-name eslotd))))))
718 (labels ((rwalk (tail)
721 (dolist (ss (class-slots (car tail)))
722 (let ((n (slot-definition-name ss)))
723 (when (member n names)
724 (setq order (cons n order)
725 names (remove n names))))))))
726 (rwalk (if (slot-boundp (car cpl) 'slots)
729 (reverse (append names order)))))
731 (defun update-gfs-of-class (class)
732 (when (and (class-finalized-p class)
733 (let ((cpl (class-precedence-list class)))
734 (or (member *the-class-slot-class* cpl)
735 (member *the-class-standard-effective-slot-definition* cpl))))
736 (let ((gf-table (make-hash-table :test 'eq)))
737 (labels ((collect-gfs (class)
738 (dolist (gf (specializer-direct-generic-functions class))
739 (setf (gethash gf gf-table) t))
740 (mapc #'collect-gfs (class-direct-superclasses class))))
742 (maphash #'(lambda (gf ignore)
743 (declare (ignore ignore))
744 (update-gf-dfun class gf))
747 (defun update-inits (class inits)
748 (setf (plist-value class 'default-initargs) inits))
750 (defmethod compute-default-initargs ((class slot-class))
751 (let ((cpl (class-precedence-list class))
752 (direct (class-direct-default-initargs class)))
753 (labels ((walk (tail)
756 (let ((c (pop tail)))
757 (append (if (eq c class)
759 (class-direct-default-initargs c))
761 (let ((initargs (walk cpl)))
762 (delete-duplicates initargs :test #'eq :key #'car :from-end t)))))
764 ;;;; protocols for constructing direct and effective slot definitions
766 (defmethod direct-slot-definition-class ((class std-class) initargs)
767 (declare (ignore initargs))
768 (find-class 'standard-direct-slot-definition))
770 (defun make-direct-slotd (class initargs)
771 (let ((initargs (list* :class class initargs)))
772 (apply #'make-instance
773 (direct-slot-definition-class class initargs)
776 (defmethod compute-slots ((class std-class))
777 ;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
778 ;; for each different slot name we find in our superclasses. Each
779 ;; call receives the class and a list of the dslotds with that name.
780 ;; The list is in most-specific-first order.
781 (let ((name-dslotds-alist ()))
782 (dolist (c (class-precedence-list class))
783 (let ((dslotds (class-direct-slots c)))
785 (let* ((name (slot-definition-name d))
786 (entry (assq name name-dslotds-alist)))
789 (push (list name d) name-dslotds-alist))))))
790 (mapcar #'(lambda (direct)
791 (compute-effective-slot-definition class
792 (nreverse (cdr direct))))
793 name-dslotds-alist)))
795 (defmethod compute-slots :around ((class std-class))
796 (let ((eslotds (call-next-method))
797 (cpl (class-precedence-list class))
800 (dolist (eslotd eslotds)
801 (let ((alloc (slot-definition-allocation eslotd)))
802 (cond ((eq alloc :instance) (push eslotd instance-slots))
803 ((classp alloc) (push eslotd class-slots)))))
804 (let ((nlayout (compute-layout cpl instance-slots)))
805 (dolist (eslotd instance-slots)
806 (setf (slot-definition-location eslotd)
807 (position (slot-definition-name eslotd) nlayout))))
808 (dolist (eslotd class-slots)
809 (setf (slot-definition-location eslotd)
810 (assoc (slot-definition-name eslotd)
811 (class-slot-cells (slot-definition-allocation eslotd)))))
812 (mapc #'initialize-internal-slot-functions eslotds)
815 (defmethod compute-slots ((class structure-class))
816 (mapcan #'(lambda (superclass)
817 (mapcar #'(lambda (dslotd)
818 (compute-effective-slot-definition class
820 (class-direct-slots superclass)))
821 (reverse (slot-value class 'class-precedence-list))))
823 (defmethod compute-slots :around ((class structure-class))
824 (let ((eslotds (call-next-method)))
825 (mapc #'initialize-internal-slot-functions eslotds)
828 (defmethod compute-effective-slot-definition ((class slot-class) dslotds)
829 (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
830 (class (effective-slot-definition-class class initargs)))
831 (apply #'make-instance class initargs)))
833 (defmethod effective-slot-definition-class ((class std-class) initargs)
834 (declare (ignore initargs))
835 (find-class 'standard-effective-slot-definition))
837 (defmethod effective-slot-definition-class ((class structure-class) initargs)
838 (declare (ignore initargs))
839 (find-class 'structure-effective-slot-definition))
841 (defmethod compute-effective-slot-definition-initargs
842 ((class slot-class) direct-slotds)
853 (dolist (slotd direct-slotds)
856 (setq name (slot-definition-name slotd)
859 (when (slot-definition-initfunction slotd)
860 (setq initform (slot-definition-initform slotd)
861 initfunction (slot-definition-initfunction slotd)
864 (setq allocation (slot-definition-allocation slotd)
866 (setq initargs (append (slot-definition-initargs slotd) initargs))
867 (let ((slotd-type (slot-definition-type slotd)))
868 (setq type (cond ((eq type 't) slotd-type)
869 ((*subtypep type slotd-type) type)
870 (t `(and ,type ,slotd-type)))))))
873 :initfunction initfunction
875 :allocation allocation
879 (defmethod compute-effective-slot-definition-initargs :around
880 ((class structure-class) direct-slotds)
881 (let ((slotd (car direct-slotds)))
882 (list* :defstruct-accessor-symbol (slot-definition-defstruct-accessor-symbol slotd)
883 :internal-reader-function (slot-definition-internal-reader-function slotd)
884 :internal-writer-function (slot-definition-internal-writer-function slotd)
885 (call-next-method))))
887 ;;; NOTE: For bootstrapping considerations, these can't use make-instance
888 ;;; to make the method object. They have to use make-a-method which
889 ;;; is a specially bootstrapped mechanism for making standard methods.
890 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
891 (declare (ignore direct-slot initargs))
892 (find-class 'standard-reader-method))
894 (defmethod add-reader-method ((class slot-class) generic-function slot-name)
895 (add-method generic-function
896 (make-a-method 'standard-reader-method
898 (list (or (class-name class) 'object))
900 (make-reader-method-function class slot-name)
901 "automatically generated reader method"
904 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
905 (declare (ignore direct-slot initargs))
906 (find-class 'standard-writer-method))
908 (defmethod add-writer-method ((class slot-class) generic-function slot-name)
909 (add-method generic-function
910 (make-a-method 'standard-writer-method
912 (list 'new-value (or (class-name class) 'object))
913 (list *the-class-t* class)
914 (make-writer-method-function class slot-name)
915 "automatically generated writer method"
918 (defmethod add-boundp-method ((class slot-class) generic-function slot-name)
919 (add-method generic-function
920 (make-a-method 'standard-boundp-method
922 (list (or (class-name class) 'object))
924 (make-boundp-method-function class slot-name)
925 "automatically generated boundp method"
928 (defmethod remove-reader-method ((class slot-class) generic-function)
929 (let ((method (get-method generic-function () (list class) nil)))
930 (when method (remove-method generic-function method))))
932 (defmethod remove-writer-method ((class slot-class) generic-function)
934 (get-method generic-function () (list *the-class-t* class) nil)))
935 (when method (remove-method generic-function method))))
937 (defmethod remove-boundp-method ((class slot-class) generic-function)
938 (let ((method (get-method generic-function () (list class) nil)))
939 (when method (remove-method generic-function method))))
941 ;;; make-reader-method-function and make-write-method function are NOT part of
942 ;;; the standard protocol. They are however useful, PCL makes uses makes use
943 ;;; of them internally and documents them for PCL users.
945 ;;; *** This needs work to make type testing by the writer functions which
946 ;;; *** do type testing faster. The idea would be to have one constructor
947 ;;; *** for each possible type test. In order to do this it would be nice
948 ;;; *** to have help from inform-type-system-about-class and friends.
950 ;;; *** There is a subtle bug here which is going to have to be fixed.
951 ;;; *** Namely, the simplistic use of the template has to be fixed. We
952 ;;; *** have to give the optimize-slot-value method the user might have
953 ;;; *** defined for this metclass a chance to run.
955 (defmethod make-reader-method-function ((class slot-class) slot-name)
956 (make-std-reader-method-function (class-name class) slot-name))
958 (defmethod make-writer-method-function ((class slot-class) slot-name)
959 (make-std-writer-method-function (class-name class) slot-name))
961 (defmethod make-boundp-method-function ((class slot-class) slot-name)
962 (make-std-boundp-method-function (class-name class) slot-name))
964 ;;;; inform-type-system-about-class
965 ;;;; make-type-predicate
967 ;;; These are NOT part of the standard protocol. They are internal mechanism
968 ;;; which PCL uses to *try* and tell the type system about class definitions.
969 ;;; In a more fully integrated implementation of CLOS, the type system would
970 ;;; know about class objects and class names in a more fundamental way and
971 ;;; the mechanism used to inform the type system about new classes would be
973 (defmethod inform-type-system-about-class ((class std-class) name)
974 (inform-type-system-about-std-class name))
976 (defmethod compatible-meta-class-change-p (class proto-new-class)
977 (eq (class-of class) (class-of proto-new-class)))
979 (defmethod validate-superclass ((class class) (new-super class))
980 (or (eq new-super *the-class-t*)
981 (eq (class-of class) (class-of new-super))))
983 (defmethod validate-superclass ((class standard-class) (new-super std-class))
984 (let ((new-super-meta-class (class-of new-super)))
985 (or (eq new-super-meta-class *the-class-std-class*)
986 (eq (class-of class) new-super-meta-class))))
988 (defun force-cache-flushes (class)
989 (let* ((owrapper (class-wrapper class))
990 (state (wrapper-state owrapper)))
991 ;; We only need to do something if the state is still T. If the
992 ;; state isn't T, it will be FLUSH or OBSOLETE, and both of those
993 ;; will already be doing what we want. In particular, we must be
994 ;; sure we never change an OBSOLETE into a FLUSH since OBSOLETE
995 ;; means do what FLUSH does and then some.
996 (when (eq state 't) ; FIXME: should be done through INVALID-WRAPPER-P
997 (let ((nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
999 (setf (wrapper-instance-slots-layout nwrapper)
1000 (wrapper-instance-slots-layout owrapper))
1001 (setf (wrapper-class-slots nwrapper)
1002 (wrapper-class-slots owrapper))
1004 (update-lisp-class-layout class nwrapper)
1005 (setf (slot-value class 'wrapper) nwrapper)
1006 (invalidate-wrapper owrapper ':flush nwrapper))))))
1008 (defun flush-cache-trap (owrapper nwrapper instance)
1009 (declare (ignore owrapper))
1010 (set-wrapper instance nwrapper))
1012 ;;; make-instances-obsolete can be called by user code. It will cause the
1013 ;;; next access to the instance (as defined in 88-002R) to trap through the
1014 ;;; update-instance-for-redefined-class mechanism.
1015 (defmethod make-instances-obsolete ((class std-class))
1016 (let* ((owrapper (class-wrapper class))
1017 (nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1019 (setf (wrapper-instance-slots-layout nwrapper)
1020 (wrapper-instance-slots-layout owrapper))
1021 (setf (wrapper-class-slots nwrapper)
1022 (wrapper-class-slots owrapper))
1024 (update-lisp-class-layout class nwrapper)
1025 (setf (slot-value class 'wrapper) nwrapper)
1026 (invalidate-wrapper owrapper ':obsolete nwrapper)
1029 (defmethod make-instances-obsolete ((class symbol))
1030 (make-instances-obsolete (find-class class)))
1032 ;;; obsolete-instance-trap is the internal trap that is called when we see
1033 ;;; an obsolete instance. The times when it is called are:
1034 ;;; - when the instance is involved in method lookup
1035 ;;; - when attempting to access a slot of an instance
1037 ;;; It is not called by class-of, wrapper-of, or any of the low-level instance
1040 ;;; Of course these times when it is called are an internal implementation
1041 ;;; detail of PCL and are not part of the documented description of when the
1042 ;;; obsolete instance update happens. The documented description is as it
1043 ;;; appears in 88-002R.
1045 ;;; This has to return the new wrapper, so it counts on all the methods on
1046 ;;; obsolete-instance-trap-internal to return the new wrapper. It also does
1047 ;;; a little internal error checking to make sure that the traps are only
1048 ;;; happening when they should, and that the trap methods are computing
1049 ;;; appropriate new wrappers.
1051 ;;; obsolete-instance-trap might be called on structure instances
1052 ;;; after a structure is redefined. In most cases, obsolete-instance-trap
1053 ;;; will not be able to fix the old instance, so it must signal an
1054 ;;; error. The hard part of this is that the error system and debugger
1055 ;;; might cause obsolete-instance-trap to be called again, so in that
1056 ;;; case, we have to return some reasonable wrapper, instead.
1058 (defvar *in-obsolete-instance-trap* nil)
1059 (defvar *the-wrapper-of-structure-object*
1060 (class-wrapper (find-class 'structure-object)))
1062 (define-condition obsolete-structure (error)
1063 ((datum :reader obsolete-structure-datum :initarg :datum))
1065 (lambda (condition stream)
1066 ;; Don't try to print the structure, since it probably won't work.
1068 "obsolete structure error in ~S:~@
1069 for a structure of type: ~S"
1070 (sb-kernel::condition-function-name condition)
1071 (type-of (obsolete-structure-datum condition))))))
1073 (defun obsolete-instance-trap (owrapper nwrapper instance)
1074 (if (not (pcl-instance-p instance))
1075 (if *in-obsolete-instance-trap*
1076 *the-wrapper-of-structure-object*
1077 (let ((*in-obsolete-instance-trap* t))
1078 (error 'obsolete-structure :datum instance)))
1079 (let* ((class (wrapper-class* nwrapper))
1080 (copy (allocate-instance class)) ;??? allocate-instance ???
1081 (olayout (wrapper-instance-slots-layout owrapper))
1082 (nlayout (wrapper-instance-slots-layout nwrapper))
1083 (oslots (get-slots instance))
1084 (nslots (get-slots copy))
1085 (oclass-slots (wrapper-class-slots owrapper))
1089 ;; local --> local transfer
1090 ;; local --> shared discard
1091 ;; local --> -- discard
1092 ;; shared --> local transfer
1093 ;; shared --> shared discard
1094 ;; shared --> -- discard
1098 ;; Go through all the old local slots.
1099 (iterate ((name (list-elements olayout))
1100 (opos (interval :from 0)))
1101 (let ((npos (posq name nlayout)))
1103 (setf (instance-ref nslots npos) (instance-ref oslots opos))
1105 (push name discarded)
1106 (unless (eq (instance-ref oslots opos) +slot-unbound+)
1107 (setf (getf plist name) (instance-ref oslots opos)))))))
1109 ;; Go through all the old shared slots.
1110 (iterate ((oclass-slot-and-val (list-elements oclass-slots)))
1111 (let ((name (car oclass-slot-and-val))
1112 (val (cdr oclass-slot-and-val)))
1113 (let ((npos (posq name nlayout)))
1115 (setf (instance-ref nslots npos) (cdr oclass-slot-and-val))
1116 (progn (push name discarded)
1117 (unless (eq val +slot-unbound+)
1118 (setf (getf plist name) val)))))))
1120 ;; Go through all the new local slots to compute the added slots.
1121 (dolist (nlocal nlayout)
1122 (unless (or (memq nlocal olayout)
1123 (assq nlocal oclass-slots))
1124 (push nlocal added)))
1126 (swap-wrappers-and-slots instance copy)
1128 (update-instance-for-redefined-class instance
1134 (defmacro copy-instance-internal (instance)
1136 (let* ((class (class-of instance))
1137 (copy (allocate-instance class)))
1138 (if (std-instance-p ,instance)
1139 (setf (std-instance-slots ,instance)
1140 (std-instance-slots ,instance))
1141 (setf (fsc-instance-slots ,instance)
1142 (fsc-instance-slots ,instance)))
1145 (defun change-class-internal (instance new-class)
1146 (let* ((old-class (class-of instance))
1147 (copy (allocate-instance new-class))
1148 (new-wrapper (get-wrapper copy))
1149 (old-wrapper (class-wrapper old-class))
1150 (old-layout (wrapper-instance-slots-layout old-wrapper))
1151 (new-layout (wrapper-instance-slots-layout new-wrapper))
1152 (old-slots (get-slots instance))
1153 (new-slots (get-slots copy))
1154 (old-class-slots (wrapper-class-slots old-wrapper)))
1156 ;; "The values of local slots specified by both the class CTO and
1157 ;; CFROM are retained. If such a local slot was unbound, it remains
1159 (iterate ((new-slot (list-elements new-layout))
1160 (new-position (interval :from 0)))
1161 (let ((old-position (posq new-slot old-layout)))
1163 (setf (instance-ref new-slots new-position)
1164 (instance-ref old-slots old-position)))))
1166 ;; "The values of slots specified as shared in the class CFROM and
1167 ;; as local in the class CTO are retained."
1168 (iterate ((slot-and-val (list-elements old-class-slots)))
1169 (let ((position (posq (car slot-and-val) new-layout)))
1171 (setf (instance-ref new-slots position) (cdr slot-and-val)))))
1173 ;; Make the copy point to the old instance's storage, and make the
1174 ;; old instance point to the new storage.
1175 (swap-wrappers-and-slots instance copy)
1177 (update-instance-for-different-class copy instance)
1180 (defmethod change-class ((instance standard-object)
1181 (new-class standard-class))
1182 (change-class-internal instance new-class))
1184 (defmethod change-class ((instance funcallable-standard-object)
1185 (new-class funcallable-standard-class))
1186 (change-class-internal instance new-class))
1188 (defmethod change-class ((instance standard-object)
1189 (new-class funcallable-standard-class))
1190 (error "You can't change the class of ~S to ~S~@
1191 because it isn't already an instance with metaclass ~S."
1192 instance new-class 'standard-class))
1194 (defmethod change-class ((instance funcallable-standard-object)
1195 (new-class standard-class))
1196 (error "You can't change the class of ~S to ~S~@
1197 because it isn't already an instance with metaclass ~S."
1198 instance new-class 'funcallable-standard-class))
1200 (defmethod change-class ((instance t) (new-class-name symbol))
1201 (change-class instance (find-class new-class-name)))
1203 ;;;; The metaclass BUILT-IN-CLASS
1205 ;;;; This metaclass is something of a weird creature. By this point, all
1206 ;;;; instances of it which will exist have been created, and no instance
1207 ;;;; is ever created by calling MAKE-INSTANCE.
1209 ;;;; But, there are other parts of the protocol we must follow and those
1210 ;;;; definitions appear here.
1212 (defmethod shared-initialize :before
1213 ((class built-in-class) slot-names &rest initargs)
1214 (declare (ignore slot-names initargs))
1215 (error "attempt to initialize or reinitialize a built in class"))
1217 (defmethod class-direct-slots ((class built-in-class)) ())
1218 (defmethod class-slots ((class built-in-class)) ())
1219 (defmethod class-direct-default-initargs ((class built-in-class)) ())
1220 (defmethod class-default-initargs ((class built-in-class)) ())
1222 (defmethod validate-superclass ((c class) (s built-in-class))
1223 (or (eq s *the-class-t*)
1224 (eq s *the-class-stream*)))
1226 (defmethod validate-superclass ((c slot-class)
1227 (f forward-referenced-class))
1230 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1231 (pushnew dependent (plist-value metaobject 'dependents)))
1233 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1234 (setf (plist-value metaobject 'dependents)
1235 (delete dependent (plist-value metaobject 'dependents))))
1237 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1238 (dolist (dependent (plist-value metaobject 'dependents))
1239 (funcall function dependent)))