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)
341 (inform-type-system-about-class class name)
344 (defmethod ensure-class-using-class (name (class pcl-class) &rest args &key)
345 (multiple-value-bind (meta initargs)
346 (ensure-class-values class args)
347 (unless (eq (class-of class) meta) (change-class class meta))
348 (apply #'reinitialize-instance class initargs)
349 (setf (find-class name) class)
350 (inform-type-system-about-class class name)
353 (defmethod class-predicate-name ((class t))
358 ((not (legal-class-name-p s))
359 (error "~S is not a class or a legal class name." s))
361 (or (find-class s nil)
363 (make-instance 'forward-referenced-class
366 (defun ensure-class-values (class args)
367 (let* ((initargs (copy-list args))
368 (unsupplied (list 1))
369 (supplied-meta (getf initargs :metaclass unsupplied))
370 (supplied-supers (getf initargs :direct-superclasses unsupplied))
371 (supplied-slots (getf initargs :direct-slots unsupplied))
373 (cond ((neq supplied-meta unsupplied)
374 (find-class supplied-meta))
376 (forward-referenced-class-p class))
377 *the-class-standard-class*)
380 (loop (unless (remf initargs :metaclass) (return)))
381 (loop (unless (remf initargs :direct-superclasses) (return)))
382 (loop (unless (remf initargs :direct-slots) (return)))
384 (list* :direct-superclasses
385 (and (neq supplied-supers unsupplied)
386 (mapcar #'fix-super supplied-supers))
388 (and (neq supplied-slots unsupplied) supplied-slots)
392 (defmethod shared-initialize :after
395 &key (direct-superclasses nil direct-superclasses-p)
396 (direct-slots nil direct-slots-p)
397 (direct-default-initargs nil direct-default-initargs-p)
398 (predicate-name nil predicate-name-p))
399 (declare (ignore slot-names))
400 (cond (direct-superclasses-p
401 (setq direct-superclasses
402 (or direct-superclasses
403 (list (if (funcallable-standard-class-p class)
404 *the-class-funcallable-standard-object*
405 *the-class-standard-object*))))
406 (dolist (superclass direct-superclasses)
407 (unless (validate-superclass class superclass)
408 (error "The class ~S was specified as a~%
409 super-class of the class ~S;~%~
410 but the meta-classes ~S and~%~S are incompatible.~@
411 Define a method for ~S to avoid this error."
412 superclass class (class-of superclass) (class-of class)
413 'validate-superclass)))
414 (setf (slot-value class 'direct-superclasses) direct-superclasses))
416 (setq direct-superclasses (slot-value class 'direct-superclasses))))
419 (setf (slot-value class 'direct-slots)
420 (mapcar (lambda (pl) (make-direct-slotd class pl))
422 (slot-value class 'direct-slots)))
423 (if direct-default-initargs-p
424 (setf (plist-value class 'direct-default-initargs)
425 direct-default-initargs)
426 (setq direct-default-initargs
427 (plist-value class 'direct-default-initargs)))
428 (setf (plist-value class 'class-slot-cells)
430 (dolist (dslotd direct-slots)
431 (when (eq (slot-definition-allocation dslotd) class)
432 (let ((initfunction (slot-definition-initfunction dslotd)))
433 (push (cons (slot-definition-name dslotd)
435 (funcall initfunction)
439 (setq predicate-name (if predicate-name-p
440 (setf (slot-value class 'predicate-name)
441 (car predicate-name))
442 (or (slot-value class 'predicate-name)
443 (setf (slot-value class 'predicate-name)
444 (make-class-predicate-name (class-name
446 (add-direct-subclasses class direct-superclasses)
447 (update-class class nil)
448 (make-class-predicate class predicate-name)
449 (add-slot-accessors class direct-slots))
451 (defmethod shared-initialize :before ((class class) slot-names &key name)
452 (declare (ignore slot-names name))
453 ;; FIXME: Could this just be CLASS instead of `(CLASS ,CLASS)? If not,
454 ;; why not? (See also similar expression in !BOOTSTRAP-INITIALIZE-CLASS.)
455 (setf (slot-value class 'type) `(class ,class))
456 (setf (slot-value class 'class-eq-specializer)
457 (make-instance 'class-eq-specializer :class class)))
459 (defmethod reinitialize-instance :before ((class slot-class) &key)
460 (remove-direct-subclasses class (class-direct-superclasses class))
461 (remove-slot-accessors class (class-direct-slots class)))
463 (defmethod reinitialize-instance :after ((class slot-class)
466 (map-dependents class
467 #'(lambda (dependent)
468 (apply #'update-dependent class dependent initargs))))
470 (defmethod shared-initialize :after ((slotd standard-slot-definition)
472 (declare (ignore slot-names))
473 (with-slots (allocation class)
475 (setq allocation (if (eq allocation :class) class allocation))))
477 (defmethod shared-initialize :after ((slotd structure-slot-definition)
479 &key (allocation :instance))
480 (declare (ignore slot-names))
481 (unless (eq allocation :instance)
482 (error "Structure slots must have :INSTANCE allocation.")))
484 (defun make-structure-class-defstruct-form (name direct-slots include)
485 (let* ((conc-name (intern (format nil "~S structure class " name)))
486 (constructor (intern (format nil "~A constructor" conc-name)))
487 (defstruct `(defstruct (,name
489 `((:include ,(class-name include))))
490 (:print-function print-std-instance)
492 (:conc-name ,conc-name)
493 (:constructor ,constructor ())
495 ,@(mapcar (lambda (slot)
496 `(,(slot-definition-name slot)
499 (reader-names (mapcar (lambda (slotd)
503 (slot-definition-name
506 (writer-names (mapcar (lambda (slotd)
510 (slot-definition-name
514 (mapcar (lambda (slotd reader-name)
516 (slot-definition-defstruct-accessor-symbol
518 `(defun ,reader-name (obj)
519 (declare (type ,name obj))
521 direct-slots reader-names))
523 (mapcar (lambda (slotd writer-name)
525 (slot-definition-defstruct-accessor-symbol
527 `(defun ,writer-name (nv obj)
528 (declare (type ,name obj))
529 (setf (,accessor obj) nv))))
530 direct-slots writer-names))
534 ,@readers-init ,@writers-init
536 (values defstruct-form constructor reader-names writer-names)))
538 (defmethod shared-initialize :after
539 ((class structure-class)
541 &key (direct-superclasses nil direct-superclasses-p)
542 (direct-slots nil direct-slots-p)
543 direct-default-initargs
544 (predicate-name nil predicate-name-p))
545 (declare (ignore slot-names direct-default-initargs))
546 (if direct-superclasses-p
547 (setf (slot-value class 'direct-superclasses)
548 (or direct-superclasses
549 (setq direct-superclasses
550 (and (not (eq (class-name class) 'structure-object))
551 (list *the-class-structure-object*)))))
552 (setq direct-superclasses (slot-value class 'direct-superclasses)))
553 (let* ((name (class-name class))
554 (from-defclass-p (slot-value class 'from-defclass-p))
555 (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
557 (setf (slot-value class 'direct-slots)
559 (mapcar #'(lambda (pl)
561 (let* ((slot-name (getf pl :name))
564 "~S structure class ~A"
566 (accessor (intern acc-name)))
567 (setq pl (list* :defstruct-accessor-symbol
569 (make-direct-slotd class pl))
571 (setq direct-slots (slot-value class 'direct-slots)))
573 (let ((include (car (slot-value class 'direct-superclasses))))
574 (multiple-value-bind (defstruct-form constructor reader-names writer-names)
575 (make-structure-class-defstruct-form name direct-slots include)
576 (unless (structure-type-p name) (eval defstruct-form))
577 (mapc #'(lambda (dslotd reader-name writer-name)
578 (let* ((reader (gdefinition reader-name))
579 (writer (when (gboundp writer-name)
580 (gdefinition writer-name))))
581 (setf (slot-value dslotd 'internal-reader-function)
583 (setf (slot-value dslotd 'internal-writer-function)
585 direct-slots reader-names writer-names)
586 (setf (slot-value class 'defstruct-form) defstruct-form)
587 (setf (slot-value class 'defstruct-constructor) constructor))))
588 (add-direct-subclasses class direct-superclasses)
589 (setf (slot-value class 'class-precedence-list)
590 (compute-class-precedence-list class))
591 (setf (slot-value class 'slots) (compute-slots class))
592 (let ((lclass (cl:find-class (class-name class))))
593 (setf (sb-kernel:class-pcl-class lclass) class)
594 (setf (slot-value class 'wrapper) (sb-kernel:class-layout lclass)))
595 (update-pv-table-cache-info class)
596 (setq predicate-name (if predicate-name-p
597 (setf (slot-value class 'predicate-name)
598 (car predicate-name))
599 (or (slot-value class 'predicate-name)
600 (setf (slot-value class 'predicate-name)
601 (make-class-predicate-name
602 (class-name class))))))
603 (make-class-predicate class predicate-name)
604 (add-slot-accessors class direct-slots)))
606 (defmethod direct-slot-definition-class ((class structure-class) initargs)
607 (declare (ignore initargs))
608 (find-class 'structure-direct-slot-definition))
610 (defmethod finalize-inheritance ((class structure-class))
611 nil) ; always finalized
613 (defun add-slot-accessors (class dslotds)
614 (fix-slot-accessors class dslotds 'add))
616 (defun remove-slot-accessors (class dslotds)
617 (fix-slot-accessors class dslotds 'remove))
619 (defun fix-slot-accessors (class dslotds add/remove)
620 (flet ((fix (gfspec name r/w)
621 (let ((gf (ensure-generic-function gfspec)))
623 (r (if (eq add/remove 'add)
624 (add-reader-method class gf name)
625 (remove-reader-method class gf)))
626 (w (if (eq add/remove 'add)
627 (add-writer-method class gf name)
628 (remove-writer-method class gf)))))))
629 (dolist (dslotd dslotds)
630 (let ((slot-name (slot-definition-name dslotd)))
631 (dolist (r (slot-definition-readers dslotd)) (fix r slot-name 'r))
632 (dolist (w (slot-definition-writers dslotd)) (fix w slot-name 'w))))))
634 (defun add-direct-subclasses (class new)
636 (unless (memq class (class-direct-subclasses class))
637 (add-direct-subclass n class))))
639 (defun remove-direct-subclasses (class new)
640 (let ((old (class-direct-superclasses class)))
641 (dolist (o (set-difference old new))
642 (remove-direct-subclass o class))))
644 (defmethod finalize-inheritance ((class std-class))
645 (update-class class t))
647 (defun class-has-a-forward-referenced-superclass-p (class)
648 (or (forward-referenced-class-p class)
649 (some #'class-has-a-forward-referenced-superclass-p
650 (class-direct-superclasses class))))
652 ;;; This is called by :after shared-initialize whenever a class is initialized
653 ;;; or reinitialized. The class may or may not be finalized.
654 (defun update-class (class finalizep)
655 (when (or finalizep (class-finalized-p class)
656 (not (class-has-a-forward-referenced-superclass-p class)))
657 (update-cpl class (compute-class-precedence-list class))
658 (update-slots class (compute-slots class))
659 (update-gfs-of-class class)
660 (update-inits class (compute-default-initargs class))
661 (update-make-instance-function-table class))
663 (dolist (sub (class-direct-subclasses class)) (update-class sub nil))))
665 (defun update-cpl (class cpl)
666 (if (class-finalized-p class)
667 (unless (equal (class-precedence-list class) cpl)
668 ;; comment from the old CMU CL sources:
669 ;; Need to have the cpl setup before update-lisp-class-layout
670 ;; is called on CMU CL.
671 (setf (slot-value class 'class-precedence-list) cpl)
672 (force-cache-flushes class))
673 (setf (slot-value class 'class-precedence-list) cpl))
674 (update-class-can-precede-p cpl))
676 (defun update-class-can-precede-p (cpl)
678 (let ((first (car cpl)))
679 (dolist (c (cdr cpl))
680 (pushnew c (slot-value first 'can-precede-list))))
681 (update-class-can-precede-p (cdr cpl))))
683 (defun class-can-precede-p (class1 class2)
684 (member class2 (class-can-precede-list class1)))
686 (defun update-slots (class eslotds)
687 (let ((instance-slots ())
689 (dolist (eslotd eslotds)
690 (let ((alloc (slot-definition-allocation eslotd)))
691 (cond ((eq alloc :instance) (push eslotd instance-slots))
692 ((classp alloc) (push eslotd class-slots)))))
694 ;; If there is a change in the shape of the instances then the
695 ;; old class is now obsolete.
696 (let* ((nlayout (mapcar #'slot-definition-name
697 (sort instance-slots #'<
698 :key #'slot-definition-location)))
699 (nslots (length nlayout))
700 (nwrapper-class-slots (compute-class-slots class-slots))
701 (owrapper (class-wrapper class))
702 (olayout (and owrapper (wrapper-instance-slots-layout owrapper)))
703 (owrapper-class-slots (and owrapper (wrapper-class-slots owrapper)))
705 (cond ((null owrapper)
706 (make-wrapper nslots class))
707 ((and (equal nlayout olayout)
709 (loop for o in owrapper-class-slots
710 for n in nwrapper-class-slots
711 do (unless (eq (car o) (car n)) (return t)))))
714 ;; This will initialize the new wrapper to have the
715 ;; same state as the old wrapper. We will then have
716 ;; to change that. This may seem like wasted work
717 ;; (and it is), but the spec requires that we call
718 ;; MAKE-INSTANCES-OBSOLETE.
719 (make-instances-obsolete class)
720 (class-wrapper class)))))
722 (with-slots (wrapper slots) class
723 (update-lisp-class-layout class nwrapper)
725 (wrapper-instance-slots-layout nwrapper) nlayout
726 (wrapper-class-slots nwrapper) nwrapper-class-slots
727 (wrapper-no-of-instance-slots nwrapper) nslots
730 (unless (eq owrapper nwrapper)
731 (update-pv-table-cache-info class)))))
733 (defun compute-class-slots (eslotds)
735 (dolist (eslotd eslotds)
736 (push (assoc (slot-definition-name eslotd)
737 (class-slot-cells (slot-definition-allocation eslotd)))
741 (defun compute-layout (cpl instance-eslotds)
744 (dolist (eslotd instance-eslotds)
745 (when (eq (slot-definition-allocation eslotd) :instance)
746 (push (slot-definition-name eslotd) collect)))
749 (labels ((rwalk (tail)
752 (dolist (ss (class-slots (car tail)))
753 (let ((n (slot-definition-name ss)))
754 (when (member n names)
755 (setq order (cons n order)
756 names (remove n names))))))))
757 (rwalk (if (slot-boundp (car cpl) 'slots)
760 (reverse (append names order)))))
762 (defun update-gfs-of-class (class)
763 (when (and (class-finalized-p class)
764 (let ((cpl (class-precedence-list class)))
765 (or (member *the-class-slot-class* cpl)
766 (member *the-class-standard-effective-slot-definition*
768 (let ((gf-table (make-hash-table :test 'eq)))
769 (labels ((collect-gfs (class)
770 (dolist (gf (specializer-direct-generic-functions class))
771 (setf (gethash gf gf-table) t))
772 (mapc #'collect-gfs (class-direct-superclasses class))))
774 (maphash #'(lambda (gf ignore)
775 (declare (ignore ignore))
776 (update-gf-dfun class gf))
779 (defun update-inits (class inits)
780 (setf (plist-value class 'default-initargs) inits))
782 (defmethod compute-default-initargs ((class slot-class))
783 (let ((cpl (class-precedence-list class))
784 (direct (class-direct-default-initargs class)))
785 (labels ((walk (tail)
788 (let ((c (pop tail)))
789 (append (if (eq c class)
791 (class-direct-default-initargs c))
793 (let ((initargs (walk cpl)))
794 (delete-duplicates initargs :test #'eq :key #'car :from-end t)))))
796 ;;;; protocols for constructing direct and effective slot definitions
798 (defmethod direct-slot-definition-class ((class std-class) initargs)
799 (declare (ignore initargs))
800 (find-class 'standard-direct-slot-definition))
802 (defun make-direct-slotd (class initargs)
803 (let ((initargs (list* :class class initargs)))
804 (apply #'make-instance
805 (direct-slot-definition-class class initargs)
808 (defmethod compute-slots ((class std-class))
809 ;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
810 ;; for each different slot name we find in our superclasses. Each
811 ;; call receives the class and a list of the dslotds with that name.
812 ;; The list is in most-specific-first order.
813 (let ((name-dslotds-alist ()))
814 (dolist (c (class-precedence-list class))
815 (let ((dslotds (class-direct-slots c)))
817 (let* ((name (slot-definition-name d))
818 (entry (assq name name-dslotds-alist)))
821 (push (list name d) name-dslotds-alist))))))
822 (mapcar #'(lambda (direct)
823 (compute-effective-slot-definition class
824 (nreverse (cdr direct))))
825 name-dslotds-alist)))
827 (defmethod compute-slots :around ((class std-class))
828 (let ((eslotds (call-next-method))
829 (cpl (class-precedence-list class))
832 (dolist (eslotd eslotds)
833 (let ((alloc (slot-definition-allocation eslotd)))
834 (cond ((eq alloc :instance) (push eslotd instance-slots))
835 ((classp alloc) (push eslotd class-slots)))))
836 (let ((nlayout (compute-layout cpl instance-slots)))
837 (dolist (eslotd instance-slots)
838 (setf (slot-definition-location eslotd)
839 (position (slot-definition-name eslotd) nlayout))))
840 (dolist (eslotd class-slots)
841 (setf (slot-definition-location eslotd)
842 (assoc (slot-definition-name eslotd)
843 (class-slot-cells (slot-definition-allocation eslotd)))))
844 (mapc #'initialize-internal-slot-functions eslotds)
847 (defmethod compute-slots ((class structure-class))
848 (mapcan #'(lambda (superclass)
849 (mapcar #'(lambda (dslotd)
850 (compute-effective-slot-definition class
852 (class-direct-slots superclass)))
853 (reverse (slot-value class 'class-precedence-list))))
855 (defmethod compute-slots :around ((class structure-class))
856 (let ((eslotds (call-next-method)))
857 (mapc #'initialize-internal-slot-functions eslotds)
860 (defmethod compute-effective-slot-definition ((class slot-class) dslotds)
861 (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
862 (class (effective-slot-definition-class class initargs)))
863 (apply #'make-instance class initargs)))
865 (defmethod effective-slot-definition-class ((class std-class) initargs)
866 (declare (ignore initargs))
867 (find-class 'standard-effective-slot-definition))
869 (defmethod effective-slot-definition-class ((class structure-class) initargs)
870 (declare (ignore initargs))
871 (find-class 'structure-effective-slot-definition))
873 (defmethod compute-effective-slot-definition-initargs
874 ((class slot-class) direct-slotds)
885 (dolist (slotd direct-slotds)
888 (setq name (slot-definition-name slotd)
891 (when (slot-definition-initfunction slotd)
892 (setq initform (slot-definition-initform slotd)
893 initfunction (slot-definition-initfunction slotd)
896 (setq allocation (slot-definition-allocation slotd)
898 (setq initargs (append (slot-definition-initargs slotd) initargs))
899 (let ((slotd-type (slot-definition-type slotd)))
900 (setq type (cond ((eq type t) slotd-type)
901 ((*subtypep type slotd-type) type)
902 (t `(and ,type ,slotd-type)))))))
905 :initfunction initfunction
907 :allocation allocation
911 (defmethod compute-effective-slot-definition-initargs :around
912 ((class structure-class) direct-slotds)
913 (let ((slotd (car direct-slotds)))
914 (list* :defstruct-accessor-symbol
915 (slot-definition-defstruct-accessor-symbol slotd)
916 :internal-reader-function
917 (slot-definition-internal-reader-function slotd)
918 :internal-writer-function
919 (slot-definition-internal-writer-function slotd)
920 (call-next-method))))
922 ;;; NOTE: For bootstrapping considerations, these can't use MAKE-INSTANCE
923 ;;; to make the method object. They have to use make-a-method which
924 ;;; is a specially bootstrapped mechanism for making standard methods.
925 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
926 (declare (ignore direct-slot initargs))
927 (find-class 'standard-reader-method))
929 (defmethod add-reader-method ((class slot-class) generic-function slot-name)
930 (add-method generic-function
931 (make-a-method 'standard-reader-method
933 (list (or (class-name class) 'object))
935 (make-reader-method-function class slot-name)
936 "automatically generated reader method"
939 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
940 (declare (ignore direct-slot initargs))
941 (find-class 'standard-writer-method))
943 (defmethod add-writer-method ((class slot-class) generic-function slot-name)
944 (add-method generic-function
945 (make-a-method 'standard-writer-method
947 (list 'new-value (or (class-name class) 'object))
948 (list *the-class-t* class)
949 (make-writer-method-function class slot-name)
950 "automatically generated writer method"
953 (defmethod add-boundp-method ((class slot-class) generic-function slot-name)
954 (add-method generic-function
955 (make-a-method 'standard-boundp-method
957 (list (or (class-name class) 'object))
959 (make-boundp-method-function class slot-name)
960 "automatically generated boundp method"
963 (defmethod remove-reader-method ((class slot-class) generic-function)
964 (let ((method (get-method generic-function () (list class) nil)))
965 (when method (remove-method generic-function method))))
967 (defmethod remove-writer-method ((class slot-class) generic-function)
969 (get-method generic-function () (list *the-class-t* class) nil)))
970 (when method (remove-method generic-function method))))
972 (defmethod remove-boundp-method ((class slot-class) generic-function)
973 (let ((method (get-method generic-function () (list class) nil)))
974 (when method (remove-method generic-function method))))
976 ;;; make-reader-method-function and make-write-method function are NOT part of
977 ;;; the standard protocol. They are however useful, PCL makes uses makes use
978 ;;; of them internally and documents them for PCL users.
980 ;;; *** This needs work to make type testing by the writer functions which
981 ;;; *** do type testing faster. The idea would be to have one constructor
982 ;;; *** for each possible type test. In order to do this it would be nice
983 ;;; *** to have help from inform-type-system-about-class and friends.
985 ;;; *** There is a subtle bug here which is going to have to be fixed.
986 ;;; *** Namely, the simplistic use of the template has to be fixed. We
987 ;;; *** have to give the optimize-slot-value method the user might have
988 ;;; *** defined for this metaclass a chance to run.
990 (defmethod make-reader-method-function ((class slot-class) slot-name)
991 (make-std-reader-method-function (class-name class) slot-name))
993 (defmethod make-writer-method-function ((class slot-class) slot-name)
994 (make-std-writer-method-function (class-name class) slot-name))
996 (defmethod make-boundp-method-function ((class slot-class) slot-name)
997 (make-std-boundp-method-function (class-name class) slot-name))
999 ;;;; inform-type-system-about-class
1001 ;;; These are NOT part of the standard protocol. They are internal
1002 ;;; mechanism which PCL uses to *try* and tell the type system about
1003 ;;; class definitions. In a more fully integrated implementation of
1004 ;;; CLOS, the type system would know about class objects and class
1005 ;;; names in a more fundamental way and the mechanism used to inform
1006 ;;; the type system about new classes would be different.
1007 (defmethod inform-type-system-about-class ((class std-class) name)
1008 (inform-type-system-about-std-class name))
1010 (defmethod inform-type-system-about-class ((class structure-class) (name t))
1013 (defmethod compatible-meta-class-change-p (class proto-new-class)
1014 (eq (class-of class) (class-of proto-new-class)))
1016 (defmethod validate-superclass ((class class) (new-super class))
1017 (or (eq new-super *the-class-t*)
1018 (eq (class-of class) (class-of new-super))))
1020 (defmethod validate-superclass ((class standard-class) (new-super std-class))
1021 (let ((new-super-meta-class (class-of new-super)))
1022 (or (eq new-super-meta-class *the-class-std-class*)
1023 (eq (class-of class) new-super-meta-class))))
1025 (defun force-cache-flushes (class)
1026 (let* ((owrapper (class-wrapper class))
1027 (state (wrapper-state owrapper)))
1028 ;; We only need to do something if the state is still T. If the
1029 ;; state isn't T, it will be FLUSH or OBSOLETE, and both of those
1030 ;; will already be doing what we want. In particular, we must be
1031 ;; sure we never change an OBSOLETE into a FLUSH since OBSOLETE
1032 ;; means do what FLUSH does and then some.
1033 (when (eq state t) ; FIXME: should be done through INVALID-WRAPPER-P
1034 (let ((nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1036 (setf (wrapper-instance-slots-layout nwrapper)
1037 (wrapper-instance-slots-layout owrapper))
1038 (setf (wrapper-class-slots nwrapper)
1039 (wrapper-class-slots owrapper))
1040 (sb-sys:without-interrupts
1041 (update-lisp-class-layout class nwrapper)
1042 (setf (slot-value class 'wrapper) nwrapper)
1043 (invalidate-wrapper owrapper ':flush nwrapper))))))
1045 (defun flush-cache-trap (owrapper nwrapper instance)
1046 (declare (ignore owrapper))
1047 (set-wrapper instance nwrapper))
1049 ;;; make-instances-obsolete can be called by user code. It will cause the
1050 ;;; next access to the instance (as defined in 88-002R) to trap through the
1051 ;;; update-instance-for-redefined-class mechanism.
1052 (defmethod make-instances-obsolete ((class std-class))
1053 (let* ((owrapper (class-wrapper class))
1054 (nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1056 (setf (wrapper-instance-slots-layout nwrapper)
1057 (wrapper-instance-slots-layout owrapper))
1058 (setf (wrapper-class-slots nwrapper)
1059 (wrapper-class-slots owrapper))
1060 (sb-sys:without-interrupts
1061 (update-lisp-class-layout class nwrapper)
1062 (setf (slot-value class 'wrapper) nwrapper)
1063 (invalidate-wrapper owrapper ':obsolete nwrapper)
1066 (defmethod make-instances-obsolete ((class symbol))
1067 (make-instances-obsolete (find-class class)))
1069 ;;; obsolete-instance-trap is the internal trap that is called when we see
1070 ;;; an obsolete instance. The times when it is called are:
1071 ;;; - when the instance is involved in method lookup
1072 ;;; - when attempting to access a slot of an instance
1074 ;;; It is not called by class-of, wrapper-of, or any of the low-level
1075 ;;; instance access macros.
1077 ;;; Of course these times when it is called are an internal
1078 ;;; implementation detail of PCL and are not part of the documented
1079 ;;; description of when the obsolete instance update happens. The
1080 ;;; documented description is as it appears in 88-002R.
1082 ;;; This has to return the new wrapper, so it counts on all the
1083 ;;; methods on obsolete-instance-trap-internal to return the new
1084 ;;; wrapper. It also does a little internal error checking to make
1085 ;;; sure that the traps are only happening when they should, and that
1086 ;;; the trap methods are computing appropriate new wrappers.
1088 ;;; obsolete-instance-trap might be called on structure instances
1089 ;;; after a structure is redefined. In most cases, obsolete-instance-trap
1090 ;;; will not be able to fix the old instance, so it must signal an
1091 ;;; error. The hard part of this is that the error system and debugger
1092 ;;; might cause obsolete-instance-trap to be called again, so in that
1093 ;;; case, we have to return some reasonable wrapper, instead.
1095 (defvar *in-obsolete-instance-trap* nil)
1096 (defvar *the-wrapper-of-structure-object*
1097 (class-wrapper (find-class 'structure-object)))
1099 (define-condition obsolete-structure (error)
1100 ((datum :reader obsolete-structure-datum :initarg :datum))
1102 (lambda (condition stream)
1103 ;; Don't try to print the structure, since it probably won't work.
1105 "~@<obsolete structure error for a structure of type ~2I~_~S~:>"
1106 (type-of (obsolete-structure-datum condition))))))
1108 (defun obsolete-instance-trap (owrapper nwrapper instance)
1109 (if (not (pcl-instance-p instance))
1110 (if *in-obsolete-instance-trap*
1111 *the-wrapper-of-structure-object*
1112 (let ((*in-obsolete-instance-trap* t))
1113 (error 'obsolete-structure :datum instance)))
1114 (let* ((class (wrapper-class* nwrapper))
1115 (copy (allocate-instance class)) ;??? allocate-instance ???
1116 (olayout (wrapper-instance-slots-layout owrapper))
1117 (nlayout (wrapper-instance-slots-layout nwrapper))
1118 (oslots (get-slots instance))
1119 (nslots (get-slots copy))
1120 (oclass-slots (wrapper-class-slots owrapper))
1124 ;; local --> local transfer
1125 ;; local --> shared discard
1126 ;; local --> -- discard
1127 ;; shared --> local transfer
1128 ;; shared --> shared discard
1129 ;; shared --> -- discard
1133 ;; Go through all the old local slots.
1135 (dolist (name olayout)
1136 (let ((npos (posq name nlayout)))
1138 (setf (clos-slots-ref nslots npos)
1139 (clos-slots-ref oslots opos))
1141 (push name discarded)
1142 (unless (eq (clos-slots-ref oslots opos) +slot-unbound+)
1143 (setf (getf plist name) (clos-slots-ref oslots opos))))))
1146 ;; Go through all the old shared slots.
1147 (dolist (oclass-slot-and-val oclass-slots)
1148 (let ((name (car oclass-slot-and-val))
1149 (val (cdr oclass-slot-and-val)))
1150 (let ((npos (posq name nlayout)))
1152 (setf (clos-slots-ref nslots npos) (cdr oclass-slot-and-val))
1153 (progn (push name discarded)
1154 (unless (eq val +slot-unbound+)
1155 (setf (getf plist name) val)))))))
1157 ;; Go through all the new local slots to compute the added slots.
1158 (dolist (nlocal nlayout)
1159 (unless (or (memq nlocal olayout)
1160 (assq nlocal oclass-slots))
1161 (push nlocal added)))
1163 (swap-wrappers-and-slots instance copy)
1165 (update-instance-for-redefined-class instance
1171 (defmacro copy-instance-internal (instance)
1173 (let* ((class (class-of instance))
1174 (copy (allocate-instance class)))
1175 (if (std-instance-p ,instance)
1176 (setf (std-instance-slots ,instance)
1177 (std-instance-slots ,instance))
1178 (setf (fsc-instance-slots ,instance)
1179 (fsc-instance-slots ,instance)))
1182 (defun change-class-internal (instance new-class)
1183 (let* ((old-class (class-of instance))
1184 (copy (allocate-instance new-class))
1185 (new-wrapper (get-wrapper copy))
1186 (old-wrapper (class-wrapper old-class))
1187 (old-layout (wrapper-instance-slots-layout old-wrapper))
1188 (new-layout (wrapper-instance-slots-layout new-wrapper))
1189 (old-slots (get-slots instance))
1190 (new-slots (get-slots copy))
1191 (old-class-slots (wrapper-class-slots old-wrapper)))
1193 ;; "The values of local slots specified by both the class CTO and
1194 ;; CFROM are retained. If such a local slot was unbound, it
1195 ;; remains unbound."
1196 (let ((new-position 0))
1197 (dolist (new-slot new-layout)
1198 (let ((old-position (posq new-slot old-layout)))
1200 (setf (clos-slots-ref new-slots new-position)
1201 (clos-slots-ref old-slots old-position))))))
1203 ;; "The values of slots specified as shared in the class CFROM and
1204 ;; as local in the class CTO are retained."
1205 (dolist (slot-and-val old-class-slots)
1206 (let ((position (posq (car slot-and-val) new-layout)))
1208 (setf (clos-slots-ref new-slots position) (cdr slot-and-val)))))
1210 ;; Make the copy point to the old instance's storage, and make the
1211 ;; old instance point to the new storage.
1212 (swap-wrappers-and-slots instance copy)
1214 (update-instance-for-different-class copy instance)
1217 (defmethod change-class ((instance standard-object)
1218 (new-class standard-class))
1219 (change-class-internal instance new-class))
1221 (defmethod change-class ((instance funcallable-standard-object)
1222 (new-class funcallable-standard-class))
1223 (change-class-internal instance new-class))
1225 (defmethod change-class ((instance standard-object)
1226 (new-class funcallable-standard-class))
1227 (error "You can't change the class of ~S to ~S~@
1228 because it isn't already an instance with metaclass ~S."
1229 instance new-class 'standard-class))
1231 (defmethod change-class ((instance funcallable-standard-object)
1232 (new-class standard-class))
1233 (error "You can't change the class of ~S to ~S~@
1234 because it isn't already an instance with metaclass ~S."
1235 instance new-class 'funcallable-standard-class))
1237 (defmethod change-class ((instance t) (new-class-name symbol))
1238 (change-class instance (find-class new-class-name)))
1240 ;;;; The metaclass BUILT-IN-CLASS
1242 ;;;; This metaclass is something of a weird creature. By this point, all
1243 ;;;; instances of it which will exist have been created, and no instance
1244 ;;;; is ever created by calling MAKE-INSTANCE.
1246 ;;;; But, there are other parts of the protocol we must follow and those
1247 ;;;; definitions appear here.
1249 (defmethod shared-initialize :before
1250 ((class built-in-class) slot-names &rest initargs)
1251 (declare (ignore slot-names initargs))
1252 (error "attempt to initialize or reinitialize a built in class"))
1254 (defmethod class-direct-slots ((class built-in-class)) ())
1255 (defmethod class-slots ((class built-in-class)) ())
1256 (defmethod class-direct-default-initargs ((class built-in-class)) ())
1257 (defmethod class-default-initargs ((class built-in-class)) ())
1259 (defmethod validate-superclass ((c class) (s built-in-class))
1260 (or (eq s *the-class-t*)
1261 (eq s *the-class-stream*)))
1263 (defmethod validate-superclass ((c slot-class)
1264 (f forward-referenced-class))
1267 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1268 (pushnew dependent (plist-value metaobject 'dependents)))
1270 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1271 (setf (plist-value metaobject 'dependents)
1272 (delete dependent (plist-value metaobject 'dependents))))
1274 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1275 (dolist (dependent (plist-value metaobject 'dependents))
1276 (funcall function dependent)))