src/pcl/std-class.lisp

   1 ;;;; This software is part of the SBCL system. See the README file for
   2 ;;;; more information.
   3
   4 ;;;; This software is derived from software originally released by Xerox
   5 ;;;; Corporation. Copyright and release statements follow. Later modifications
   6 ;;;; to the software are in the public domain and are provided with
   7 ;;;; absolutely no warranty. See the COPYING and CREDITS files for more
   8 ;;;; information.
   9
  10 ;;;; copyright information from original PCL sources:
  11 ;;;;
  12 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
  13 ;;;; All rights reserved.
  14 ;;;;
  15 ;;;; Use and copying of this software and preparation of derivative works based
  16 ;;;; upon this software are permitted. Any distribution of this software or
  17 ;;;; derivative works must comply with all applicable United States export
  18 ;;;; control laws.
  19 ;;;;
  20 ;;;; This software is made available AS IS, and Xerox Corporation makes no
  21 ;;;; warranty about the software, its performance or its conformity to any
  22 ;;;; specification.
  23
  24 (in-package "SB-PCL")
  25 \f
  26 (defmethod slot-accessor-function ((slotd effective-slot-definition) type)
  27   (ecase type
  28     (reader (slot-definition-reader-function slotd))
  29     (writer (slot-definition-writer-function slotd))
  30     (boundp (slot-definition-boundp-function slotd))))
  31
  32 (defmethod (setf slot-accessor-function) (function
  33                                           (slotd effective-slot-definition)
  34                                           type)
  35   (ecase type
  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))))
  39
  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)
  44
  45 (defmethod slot-accessor-std-p ((slotd effective-slot-definition) type)
  46   (let ((flags (slot-value slotd 'accessor-flags)))
  47     (declare (type fixnum flags))
  48     (if (eq type 'all)
  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))))))))
  56
  57 (defmethod (setf slot-accessor-std-p) (value
  58                                        (slotd effective-slot-definition)
  59                                        type)
  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)
  67           (if value
  68               (the fixnum (logior mask flags))
  69               (the fixnum (logand (the fixnum (lognot mask)) flags)))))
  70   value)
  71
  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)))
  88
  89 (defmethod compute-slot-accessor-info ((slotd effective-slot-definition)
  90                                        type gf)
  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*))))
 103
 104 (defmethod slot-definition-allocation ((slotd structure-slot-definition))
 105   :instance)
 106 \f
 107 (defmethod shared-initialize :after ((object documentation-mixin)
 108                                      slot-names
 109                                      &key (documentation nil documentation-p))
 110   (declare (ignore slot-names))
 111   (when documentation-p
 112     (setf (plist-value object 'documentation) documentation)))
 113
 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"
 117         doc-type
 118         (type-of object))
 119   nil)
 120
 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"
 127         doc-type
 128         (type-of object))
 129   new-value)
 130
 131 (defmethod documentation ((object documentation-mixin) doc-type)
 132   (declare (ignore doc-type))
 133   (plist-value object 'documentation))
 134
 135 (defmethod (setf documentation) (new-value
 136                                  (object documentation-mixin)
 137                                  doc-type)
 138   (declare (ignore doc-type))
 139   (setf (plist-value object 'documentation) new-value))
 140
 141 (defmethod documentation ((slotd standard-slot-definition) doc-type)
 142   (declare (ignore doc-type))
 143   (slot-value slotd 'documentation))
 144
 145 (defmethod (setf documentation) (new-value
 146                                  (slotd standard-slot-definition)
 147                                  doc-type)
 148   (declare (ignore doc-type))
 149   (setf (slot-value slotd 'documentation) new-value))
 150 \f
 151 ;;;; various class accessors that are a little more complicated than can be
 152 ;;;; done with automatically generated reader methods
 153
 154 (defmethod class-finalized-p ((class pcl-class))
 155   (with-slots (wrapper) class
 156     (not (null wrapper))))
 157
 158 (defmethod class-prototype ((class std-class))
 159   (with-slots (prototype) class
 160     (or prototype (setq prototype (allocate-instance class)))))
 161
 162 (defmethod class-prototype ((class structure-class))
 163   (with-slots (prototype wrapper defstruct-constructor) class
 164     (or prototype
 165         (setq prototype
 166               (if defstruct-constructor
 167                   (allocate-instance class)
 168                   (allocate-standard-instance wrapper))))))
 169
 170 (defmethod class-direct-default-initargs ((class slot-class))
 171   (plist-value class 'direct-default-initargs))
 172
 173 (defmethod class-default-initargs ((class slot-class))
 174   (plist-value class 'default-initargs))
 175
 176 (defmethod class-slot-cells ((class std-class))
 177   (plist-value class 'class-slot-cells))
 178 \f
 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
 181 ;;;; protocol.
 182
 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)
 188     subclass))
 189 (defmethod remove-direct-subclass ((class class) (subclass class))
 190   (with-slots (direct-subclasses) class
 191     (setq direct-subclasses (remove subclass direct-subclasses))
 192     subclass))
 193
 194 ;;; Maintaining the direct-methods and direct-generic-functions backpointers.
 195 ;;;
 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
 199 ;;; class graph.
 200 ;;;
 201 ;;;   ADD-DIRECT-METHOD
 202 ;;;   REMOVE-DIRECT-METHOD
 203 ;;;   SPECIALIZER-DIRECT-METHODS
 204 ;;;   SPECIALIZER-DIRECT-GENERIC-FUNCTIONS
 205 ;;;
 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
 208 ;;; computed lazily.
 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) ()))
 213   method)
 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) ()))
 218   method)
 219
 220 (defmethod specializer-direct-methods ((specializer class))
 221   (with-slots (direct-methods) specializer
 222     (car direct-methods)))
 223
 224 (defmethod specializer-direct-generic-functions ((specializer class))
 225   (with-slots (direct-methods) specializer
 226     (or (cdr direct-methods)
 227         (setf (cdr direct-methods)
 228               (let (collect)
 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))))))
 234 \f
 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))
 239
 240 (defmethod specializer-method-table ((specializer eql-specializer))
 241   *eql-specializer-methods*)
 242
 243 (defmethod specializer-method-table ((specializer class-eq-specializer))
 244   *class-eq-specializer-methods*)
 245
 246 (defmethod add-direct-method ((specializer specializer-with-object)
 247                               (method method))
 248   (let* ((object (specializer-object specializer))
 249          (table (specializer-method-table specializer))
 250          (entry (gethash object table)))
 251     (unless entry
 252       (setq entry
 253             (setf (gethash object table)
 254                   (cons nil nil))))
 255     (setf (car entry) (adjoin method (car entry))
 256           (cdr entry) ())
 257     method))
 258
 259 (defmethod remove-direct-method ((specializer specializer-with-object)
 260                                  (method method))
 261   (let* ((object (specializer-object specializer))
 262          (entry (gethash object (specializer-method-table specializer))))
 263     (when entry
 264       (setf (car entry) (remove method (car entry))
 265             (cdr entry) ()))
 266     method))
 267
 268 (defmethod specializer-direct-methods ((specializer specializer-with-object))
 269   (car (gethash (specializer-object specializer)
 270                 (specializer-method-table specializer))))
 271
 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))))
 276     (when entry
 277       (or (cdr entry)
 278           (setf (cdr entry)
 279                 (let (collect)
 280                   (dolist (m (car entry))
 281                     (pushnew (method-generic-function m) collect :test #'eq))
 282                   (nreverse collect)))))))
 283
 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*)
 296   nil)
 297
 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
 302                                      specl))
 303                           (unless (gethash gf all-generic-functions)
 304                             (setf (gethash gf all-generic-functions) t)
 305                             (funcall function gf))))))
 306   nil)
 307
 308 (defmethod shared-initialize :after ((specl class-eq-specializer)
 309                                      slot-names
 310                                      &key)
 311   (declare (ignore slot-names))
 312   (setf (slot-value specl 'type) `(class-eq ,(specializer-class specl))))
 313
 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))))
 317 \f
 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
 321                     :direct-slots slots
 322                     :definition-source `((defclass ,name)
 323                                          ,*load-pathname*)
 324                     other)))
 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)))))
 330
 331 (setf (gdefinition 'load-defclass) #'real-load-defclass)
 332
 333 (defun ensure-class (name &rest all)
 334   (apply #'ensure-class-using-class name (find-class name nil) all))
 335
 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     class))
 342
 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)
 349     class))
 350
 351 (defmethod class-predicate-name ((class t))
 352   'constantly-nil)
 353
 354 (defun fix-super (s)
 355   (cond ((classp s) s)
 356         ((not (legal-class-name-p s))
 357           (error "~S is not a class or a legal class name." s))
 358         (t
 359           (or (find-class s nil)
 360               (setf (find-class s)
 361                       (make-instance 'forward-referenced-class
 362                                      :name s))))))
 363
 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))
 370          (meta
 371            (cond ((neq supplied-meta unsupplied)
 372                   (find-class supplied-meta))
 373                  ((or (null class)
 374                       (forward-referenced-class-p class))
 375                   *the-class-standard-class*)
 376                  (t
 377                   (class-of class)))))
 378     ;; KLUDGE: It seemed to me initially that there ought to be a way
 379     ;; of collecting all the erroneous problems in one go, rather than
 380     ;; this way of solving the problem of signalling the errors that
 381     ;; we are required to, which stops at the first bogus input.
 382     ;; However, after playing around a little, I couldn't find that
 383     ;; way, so I've left it as is, but if someone does come up with a
 384     ;; better way... -- CSR, 2002-09-08
 385     (loop for (slot . more) on (getf initargs :direct-slots)
 386           for slot-name = (getf slot :name)
 387           if (some (lambda (s) (eq slot-name (getf s :name))) more)
 388           ;; FIXME: It's quite possible that we ought to define an
 389           ;; SB-INT:PROGRAM-ERROR function to signal these and other
 390           ;; errors throughout the code base that are required to be
 391           ;; of type PROGRAM-ERROR.
 392           do (error 'simple-program-error
 393                     :format-control "More than one direct slot with name ~S."
 394                     :format-arguments (list slot-name))
 395           else
 396           do (loop for (option value . more) on slot by #'cddr
 397                    when (and (member option
 398                                      '(:allocation :type
 399                                        :initform :documentation))
 400                              (not (eq unsupplied
 401                                       (getf more option unsupplied))))
 402                    do (error 'simple-program-error
 403                              :format-control "Duplicate slot option ~S for slot ~S."
 404                              :format-arguments (list option slot-name))))
 405     (loop for (initarg . more) on (getf initargs :direct-default-initargs)
 406           for name = (car initarg)
 407           when (some (lambda (a) (eq (car a) name)) more)
 408           do (error 'simple-program-error
 409                     :format-control "Duplicate initialization argument ~
 410                                      name ~S in :default-initargs of class ~A."
 411                     :format-arguments (list name class)))
 412     (loop (unless (remf initargs :metaclass) (return)))
 413     (loop (unless (remf initargs :direct-superclasses) (return)))
 414     (loop (unless (remf initargs :direct-slots) (return)))
 415     (values meta
 416             (list* :direct-superclasses
 417                    (and (neq supplied-supers unsupplied)
 418                         (mapcar #'fix-super supplied-supers))
 419                    :direct-slots
 420                    (and (neq supplied-slots unsupplied) supplied-slots)
 421                    initargs))))
 422 \f
 423
 424 (defmethod shared-initialize :after
 425            ((class std-class)
 426             slot-names
 427             &key (direct-superclasses nil direct-superclasses-p)
 428                  (direct-slots nil direct-slots-p)
 429                  (direct-default-initargs nil direct-default-initargs-p)
 430                  (predicate-name nil predicate-name-p))
 431   (declare (ignore slot-names))
 432   (cond (direct-superclasses-p
 433          (setq direct-superclasses
 434                (or direct-superclasses
 435                    (list (if (funcallable-standard-class-p class)
 436                              *the-class-funcallable-standard-object*
 437                              *the-class-standard-object*))))
 438          (dolist (superclass direct-superclasses)
 439            (unless (validate-superclass class superclass)
 440              (error "The class ~S was specified as a~%
 441                      super-class of the class ~S;~%~
 442                      but the meta-classes ~S and~%~S are incompatible.~@
 443                      Define a method for ~S to avoid this error."
 444                      superclass class (class-of superclass) (class-of class)
 445                      'validate-superclass)))
 446          (setf (slot-value class 'direct-superclasses) direct-superclasses))
 447         (t
 448          (setq direct-superclasses (slot-value class 'direct-superclasses))))
 449   (setq direct-slots
 450         (if direct-slots-p
 451             (setf (slot-value class 'direct-slots)
 452                   (mapcar (lambda (pl) (make-direct-slotd class pl))
 453                           direct-slots))
 454             (slot-value class 'direct-slots)))
 455   (if direct-default-initargs-p
 456       (setf (plist-value class 'direct-default-initargs)
 457             direct-default-initargs)
 458       (setq direct-default-initargs
 459             (plist-value class 'direct-default-initargs)))
 460   (setf (plist-value class 'class-slot-cells)
 461         (let (collect)
 462           (dolist (dslotd direct-slots)
 463             (when (eq :class (slot-definition-allocation dslotd))
 464               (let ((initfunction (slot-definition-initfunction dslotd)))
 465                 (push (cons (slot-definition-name dslotd)
 466                                (if initfunction
 467                                    (funcall initfunction)
 468                                    +slot-unbound+))
 469                       collect))))
 470           (nreverse collect)))
 471   (setq predicate-name (if predicate-name-p
 472                            (setf (slot-value class 'predicate-name)
 473                                  (car predicate-name))
 474                            (or (slot-value class 'predicate-name)
 475                                (setf (slot-value class 'predicate-name)
 476                                      (make-class-predicate-name (class-name
 477                                                                  class))))))
 478   (add-direct-subclasses class direct-superclasses)
 479   (update-class class nil)
 480   (make-class-predicate class predicate-name)
 481   (add-slot-accessors class direct-slots))
 482
 483 (defmethod shared-initialize :before ((class class) slot-names &key name)
 484   (declare (ignore slot-names name))
 485   ;; FIXME: Could this just be CLASS instead of `(CLASS ,CLASS)? If not,
 486   ;; why not? (See also similar expression in !BOOTSTRAP-INITIALIZE-CLASS.)
 487   (setf (slot-value class 'type) `(class ,class))
 488   (setf (slot-value class 'class-eq-specializer)
 489         (make-instance 'class-eq-specializer :class class)))
 490
 491 (defmethod reinitialize-instance :before ((class slot-class) &key)
 492   (remove-direct-subclasses class (class-direct-superclasses class))
 493   (remove-slot-accessors    class (class-direct-slots class)))
 494
 495 (defmethod reinitialize-instance :after ((class slot-class)
 496                                          &rest initargs
 497                                          &key)
 498   (map-dependents class
 499                   (lambda (dependent)
 500                     (apply #'update-dependent class dependent initargs))))
 501
 502 (defmethod shared-initialize :after ((slotd structure-slot-definition)
 503                                      slot-names
 504                                      &key (allocation :instance))
 505   (declare (ignore slot-names))
 506   (unless (eq allocation :instance)
 507     (error "Structure slots must have :INSTANCE allocation.")))
 508
 509 (defun make-structure-class-defstruct-form (name direct-slots include)
 510   (let* ((conc-name (intern (format nil "~S structure class " name)))
 511          (constructor (intern (format nil "~Aconstructor" conc-name)))
 512          (defstruct `(defstruct (,name
 513                                  ,@(when include
 514                                          `((:include ,(class-name include))))
 515                                  (:predicate nil)
 516                                  (:conc-name ,conc-name)
 517                                  (:constructor ,constructor ())
 518                                  (:copier nil))
 519                       ,@(mapcar (lambda (slot)
 520                                   `(,(slot-definition-name slot)
 521                                     +slot-unbound+))
 522                                 direct-slots)))
 523          (reader-names (mapcar (lambda (slotd)
 524                                  (intern (format nil
 525                                                  "~A~A reader"
 526                                                  conc-name
 527                                                  (slot-definition-name
 528                                                   slotd))))
 529                                direct-slots))
 530          (writer-names (mapcar (lambda (slotd)
 531                                  (intern (format nil
 532                                                  "~A~A writer"
 533                                                  conc-name
 534                                                  (slot-definition-name
 535                                                   slotd))))
 536                                direct-slots))
 537          (readers-init
 538            (mapcar (lambda (slotd reader-name)
 539                      (let ((accessor
 540                              (slot-definition-defstruct-accessor-symbol
 541                               slotd)))
 542                        `(defun ,reader-name (obj)
 543                          (declare (type ,name obj))
 544                          (,accessor obj))))
 545                    direct-slots reader-names))
 546          (writers-init
 547            (mapcar (lambda (slotd writer-name)
 548                      (let ((accessor
 549                              (slot-definition-defstruct-accessor-symbol
 550                               slotd)))
 551                        `(defun ,writer-name (nv obj)
 552                          (declare (type ,name obj))
 553                          (setf (,accessor obj) nv))))
 554                    direct-slots writer-names))
 555          (defstruct-form
 556              `(progn
 557                ,defstruct
 558                ,@readers-init ,@writers-init
 559                (cons nil nil))))
 560     (values defstruct-form constructor reader-names writer-names)))
 561
 562 (defmethod shared-initialize :after
 563       ((class structure-class)
 564        slot-names
 565        &key (direct-superclasses nil direct-superclasses-p)
 566             (direct-slots nil direct-slots-p)
 567             direct-default-initargs
 568             (predicate-name nil predicate-name-p))
 569   (declare (ignore slot-names direct-default-initargs))
 570   (if direct-superclasses-p
 571       (setf (slot-value class 'direct-superclasses)
 572             (or direct-superclasses
 573                 (setq direct-superclasses
 574                       (and (not (eq (class-name class) 'structure-object))
 575                            (list *the-class-structure-object*)))))
 576       (setq direct-superclasses (slot-value class 'direct-superclasses)))
 577   (let* ((name (class-name class))
 578          (from-defclass-p (slot-value class 'from-defclass-p))
 579          (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
 580     (if direct-slots-p
 581         (setf (slot-value class 'direct-slots)
 582               (setq direct-slots
 583                     (mapcar (lambda (pl)
 584                               (when defstruct-p
 585                                 (let* ((slot-name (getf pl :name))
 586                                        (acc-name
 587                                         (format nil
 588                                                 "~S structure class ~A"
 589                                                 name slot-name))
 590                                        (accessor (intern acc-name)))
 591                                   (setq pl (list* :defstruct-accessor-symbol
 592                                                   accessor pl))))
 593                               (make-direct-slotd class pl))
 594                             direct-slots)))
 595         (setq direct-slots (slot-value class 'direct-slots)))
 596     (when defstruct-p
 597       (let ((include (car (slot-value class 'direct-superclasses))))
 598         (multiple-value-bind (defstruct-form constructor reader-names writer-names)
 599             (make-structure-class-defstruct-form name direct-slots include)
 600           (unless (structure-type-p name) (eval defstruct-form))
 601           (mapc (lambda (dslotd reader-name writer-name)
 602                   (let* ((reader (gdefinition reader-name))
 603                          (writer (when (gboundp writer-name)
 604                                    (gdefinition writer-name))))
 605                     (setf (slot-value dslotd 'internal-reader-function)
 606                           reader)
 607                     (setf (slot-value dslotd 'internal-writer-function)
 608                           writer)))
 609                 direct-slots reader-names writer-names)
 610           (setf (slot-value class 'defstruct-form) defstruct-form)
 611           (setf (slot-value class 'defstruct-constructor) constructor))))
 612     (add-direct-subclasses class direct-superclasses)
 613     (setf (slot-value class 'class-precedence-list)
 614             (compute-class-precedence-list class))
 615     (setf (slot-value class 'slots) (compute-slots class))
 616     (let ((lclass (cl:find-class (class-name class))))
 617       (setf (sb-kernel:class-pcl-class lclass) class)
 618       (setf (slot-value class 'wrapper) (sb-kernel:class-layout lclass)))
 619     (update-pv-table-cache-info class)
 620     (setq predicate-name (if predicate-name-p
 621                            (setf (slot-value class 'predicate-name)
 622                                    (car predicate-name))
 623                            (or (slot-value class 'predicate-name)
 624                                (setf (slot-value class 'predicate-name)
 625                                        (make-class-predicate-name
 626                                         (class-name class))))))
 627     (make-class-predicate class predicate-name)
 628     (add-slot-accessors class direct-slots)))
 629
 630 (defmethod direct-slot-definition-class ((class structure-class) initargs)
 631   (declare (ignore initargs))
 632   (find-class 'structure-direct-slot-definition))
 633
 634 (defmethod finalize-inheritance ((class structure-class))
 635   nil) ; always finalized
 636 \f
 637 (defun add-slot-accessors (class dslotds)
 638   (fix-slot-accessors class dslotds 'add))
 639
 640 (defun remove-slot-accessors (class dslotds)
 641   (fix-slot-accessors class dslotds 'remove))
 642
 643 (defun fix-slot-accessors (class dslotds add/remove)
 644   (flet ((fix (gfspec name r/w)
 645            (let ((gf (ensure-generic-function gfspec)))
 646              (case r/w
 647                (r (if (eq add/remove 'add)
 648                       (add-reader-method class gf name)
 649                       (remove-reader-method class gf)))
 650                (w (if (eq add/remove 'add)
 651                       (add-writer-method class gf name)
 652                       (remove-writer-method class gf)))))))
 653     (dolist (dslotd dslotds)
 654       (let ((slot-name (slot-definition-name dslotd)))
 655         (dolist (r (slot-definition-readers dslotd)) (fix r slot-name 'r))
 656         (dolist (w (slot-definition-writers dslotd)) (fix w slot-name 'w))))))
 657 \f
 658 (defun add-direct-subclasses (class supers)
 659   (dolist (super supers)
 660     (unless (memq class (class-direct-subclasses class))
 661       (add-direct-subclass super class))))
 662
 663 (defun remove-direct-subclasses (class supers)
 664   (let ((old (class-direct-superclasses class)))
 665     (dolist (o (set-difference old supers))
 666       (remove-direct-subclass o class))))
 667 \f
 668 (defmethod finalize-inheritance ((class std-class))
 669   (update-class class t))
 670 \f
 671 (defun class-has-a-forward-referenced-superclass-p (class)
 672   (or (forward-referenced-class-p class)
 673       (some #'class-has-a-forward-referenced-superclass-p
 674             (class-direct-superclasses class))))
 675
 676 ;;; This is called by :after shared-initialize whenever a class is initialized
 677 ;;; or reinitialized. The class may or may not be finalized.
 678 (defun update-class (class finalizep)
 679   ;; Comment from Gerd Moellmann:
 680   ;;
 681   ;; Note that we can't simply delay the finalization when CLASS has
 682   ;; no forward referenced superclasses because that causes bootstrap
 683   ;; problems.
 684   (when (and (not finalizep)
 685              (not (class-finalized-p class))
 686              (not (class-has-a-forward-referenced-superclass-p class)))
 687     (finalize-inheritance class)
 688     (return-from update-class))
 689   (when (or finalizep (class-finalized-p class)
 690             (not (class-has-a-forward-referenced-superclass-p class)))
 691     (update-cpl class (compute-class-precedence-list class))
 692     ;; This invocation of UPDATE-SLOTS, in practice, finalizes the
 693     ;; class.  The hoops above are to ensure that FINALIZE-INHERITANCE
 694     ;; is called at finalization, so that MOP programmers can hook
 695     ;; into the system as described in "Class Finalization Protocol"
 696     ;; (section 5.5.2 of AMOP).
 697     (update-slots class (compute-slots class))
 698     (update-gfs-of-class class)
 699     (update-inits class (compute-default-initargs class))
 700     (update-make-instance-function-table class))
 701   (unless finalizep
 702     (dolist (sub (class-direct-subclasses class)) (update-class sub nil))))
 703
 704 (defun update-cpl (class cpl)
 705   (if (class-finalized-p class)
 706       (unless (equal (class-precedence-list class) cpl)
 707         ;; comment from the old CMU CL sources:
 708         ;;   Need to have the cpl setup before update-lisp-class-layout
 709         ;;   is called on CMU CL.
 710         (setf (slot-value class 'class-precedence-list) cpl)
 711         (force-cache-flushes class))
 712       (setf (slot-value class 'class-precedence-list) cpl))
 713   (update-class-can-precede-p cpl))
 714
 715 (defun update-class-can-precede-p (cpl)
 716   (when cpl
 717     (let ((first (car cpl)))
 718       (dolist (c (cdr cpl))
 719         (pushnew c (slot-value first 'can-precede-list))))
 720     (update-class-can-precede-p (cdr cpl))))
 721
 722 (defun class-can-precede-p (class1 class2)
 723   (member class2 (class-can-precede-list class1)))
 724
 725 (defun update-slots (class eslotds)
 726   (let ((instance-slots ())
 727         (class-slots    ()))
 728     (dolist (eslotd eslotds)
 729       (let ((alloc (slot-definition-allocation eslotd)))
 730         (case alloc
 731           (:instance (push eslotd instance-slots))
 732           (:class (push eslotd class-slots)))))
 733
 734     ;; If there is a change in the shape of the instances then the
 735     ;; old class is now obsolete.
 736     (let* ((nlayout (mapcar #'slot-definition-name
 737                             (sort instance-slots #'<
 738                                   :key #'slot-definition-location)))
 739            (nslots (length nlayout))
 740            (nwrapper-class-slots (compute-class-slots class-slots))
 741            (owrapper (class-wrapper class))
 742            (olayout (and owrapper (wrapper-instance-slots-layout owrapper)))
 743            (owrapper-class-slots (and owrapper (wrapper-class-slots owrapper)))
 744            (nwrapper
 745             (cond ((null owrapper)
 746                    (make-wrapper nslots class))
 747                   ((and (equal nlayout olayout)
 748                         (not
 749                          (loop for o in owrapper-class-slots
 750                                for n in nwrapper-class-slots
 751                                do (unless (eq (car o) (car n)) (return t)))))
 752                    owrapper)
 753                   (t
 754                    ;; This will initialize the new wrapper to have the
 755                    ;; same state as the old wrapper. We will then have
 756                    ;; to change that. This may seem like wasted work
 757                    ;; (and it is), but the spec requires that we call
 758                    ;; MAKE-INSTANCES-OBSOLETE.
 759                    (make-instances-obsolete class)
 760                    (class-wrapper class)))))
 761
 762       (with-slots (wrapper slots) class
 763         (update-lisp-class-layout class nwrapper)
 764         (setf slots eslotds
 765               (wrapper-instance-slots-layout nwrapper) nlayout
 766               (wrapper-class-slots nwrapper) nwrapper-class-slots
 767               (wrapper-no-of-instance-slots nwrapper) nslots
 768               wrapper nwrapper))
 769
 770       (unless (eq owrapper nwrapper)
 771         (update-pv-table-cache-info class)))))
 772
 773 (defun compute-class-slots (eslotds)
 774   (let (collect)
 775     (dolist (eslotd eslotds)
 776       (push (assoc (slot-definition-name eslotd)
 777                    (class-slot-cells (slot-definition-class eslotd)))
 778             collect))
 779     (nreverse collect)))
 780
 781 (defun compute-layout (cpl instance-eslotds)
 782   (let* ((names
 783            (let (collect)
 784              (dolist (eslotd instance-eslotds)
 785                (when (eq (slot-definition-allocation eslotd) :instance)
 786                  (push (slot-definition-name eslotd) collect)))
 787              (nreverse collect)))
 788          (order ()))
 789     (labels ((rwalk (tail)
 790                (when tail
 791                  (rwalk (cdr tail))
 792                  (dolist (ss (class-slots (car tail)))
 793                    (let ((n (slot-definition-name ss)))
 794                      (when (member n names)
 795                        (setq order (cons n order)
 796                              names (remove n names))))))))
 797       (rwalk (if (slot-boundp (car cpl) 'slots)
 798                  cpl
 799                  (cdr cpl)))
 800       (reverse (append names order)))))
 801
 802 (defun update-gfs-of-class (class)
 803   (when (and (class-finalized-p class)
 804              (let ((cpl (class-precedence-list class)))
 805                (or (member *the-class-slot-class* cpl)
 806                    (member *the-class-standard-effective-slot-definition*
 807                            cpl))))
 808     (let ((gf-table (make-hash-table :test 'eq)))
 809       (labels ((collect-gfs (class)
 810                  (dolist (gf (specializer-direct-generic-functions class))
 811                    (setf (gethash gf gf-table) t))
 812                  (mapc #'collect-gfs (class-direct-superclasses class))))
 813         (collect-gfs class)
 814         (maphash (lambda (gf ignore)
 815                    (declare (ignore ignore))
 816                    (update-gf-dfun class gf))
 817                  gf-table)))))
 818
 819 (defun update-inits (class inits)
 820   (setf (plist-value class 'default-initargs) inits))
 821 \f
 822 (defmethod compute-default-initargs ((class slot-class))
 823   (let ((cpl (class-precedence-list class))
 824         (direct (class-direct-default-initargs class)))
 825     (labels ((walk (tail)
 826                (if (null tail)
 827                    nil
 828                    (let ((c (pop tail)))
 829                      (append (if (eq c class)
 830                                  direct
 831                                  (class-direct-default-initargs c))
 832                              (walk tail))))))
 833       (let ((initargs (walk cpl)))
 834         (delete-duplicates initargs :test #'eq :key #'car :from-end t)))))
 835 \f
 836 ;;;; protocols for constructing direct and effective slot definitions
 837
 838 (defmethod direct-slot-definition-class ((class std-class) initargs)
 839   (declare (ignore initargs))
 840   (find-class 'standard-direct-slot-definition))
 841
 842 (defun make-direct-slotd (class initargs)
 843   (let ((initargs (list* :class class initargs)))
 844     (apply #'make-instance
 845            (direct-slot-definition-class class initargs)
 846            initargs)))
 847
 848 (defmethod compute-slots ((class std-class))
 849   ;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
 850   ;; for each different slot name we find in our superclasses. Each
 851   ;; call receives the class and a list of the dslotds with that name.
 852   ;; The list is in most-specific-first order.
 853   (let ((name-dslotds-alist ()))
 854     (dolist (c (class-precedence-list class))
 855       (let ((dslotds (class-direct-slots c)))
 856         (dolist (d dslotds)
 857           (let* ((name (slot-definition-name d))
 858                  (entry (assq name name-dslotds-alist)))
 859             (if entry
 860                 (push d (cdr entry))
 861                 (push (list name d) name-dslotds-alist))))))
 862     (mapcar (lambda (direct)
 863               (compute-effective-slot-definition class
 864                                                  (nreverse (cdr direct))))
 865             name-dslotds-alist)))
 866
 867 (defmethod compute-slots :around ((class std-class))
 868   (let ((eslotds (call-next-method))
 869         (cpl (class-precedence-list class))
 870         (instance-slots ())
 871         (class-slots    ()))
 872     (dolist (eslotd eslotds)
 873       (let ((alloc (slot-definition-allocation eslotd)))
 874         (case alloc
 875           (:instance (push eslotd instance-slots))
 876           (:class (push eslotd class-slots)))))
 877     (let ((nlayout (compute-layout cpl instance-slots)))
 878       (dolist (eslotd instance-slots)
 879         (setf (slot-definition-location eslotd)
 880               (position (slot-definition-name eslotd) nlayout))))
 881     (dolist (eslotd class-slots)
 882       (setf (slot-definition-location eslotd)
 883             (assoc (slot-definition-name eslotd)
 884                    (class-slot-cells (slot-definition-class eslotd)))))
 885     (mapc #'initialize-internal-slot-functions eslotds)
 886     eslotds))
 887
 888 (defmethod compute-slots ((class structure-class))
 889   (mapcan (lambda (superclass)
 890             (mapcar (lambda (dslotd)
 891                       (compute-effective-slot-definition class
 892                                                          (list dslotd)))
 893                     (class-direct-slots superclass)))
 894           (reverse (slot-value class 'class-precedence-list))))
 895
 896 (defmethod compute-slots :around ((class structure-class))
 897   (let ((eslotds (call-next-method)))
 898     (mapc #'initialize-internal-slot-functions eslotds)
 899     eslotds))
 900
 901 (defmethod compute-effective-slot-definition ((class slot-class) dslotds)
 902   (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
 903          (class (effective-slot-definition-class class initargs)))
 904     (apply #'make-instance class initargs)))
 905
 906 (defmethod effective-slot-definition-class ((class std-class) initargs)
 907   (declare (ignore initargs))
 908   (find-class 'standard-effective-slot-definition))
 909
 910 (defmethod effective-slot-definition-class ((class structure-class) initargs)
 911   (declare (ignore initargs))
 912   (find-class 'structure-effective-slot-definition))
 913
 914 (defmethod compute-effective-slot-definition-initargs
 915     ((class slot-class) direct-slotds)
 916   (let* ((name nil)
 917          (initfunction nil)
 918          (initform nil)
 919          (initargs nil)
 920          (allocation nil)
 921          (type t)
 922          (namep  nil)
 923          (initp  nil)
 924          (allocp nil))
 925
 926     (dolist (slotd direct-slotds)
 927       (when slotd
 928         (unless namep
 929           (setq name (slot-definition-name slotd)
 930                 namep t))
 931         (unless initp
 932           (when (slot-definition-initfunction slotd)
 933             (setq initform (slot-definition-initform slotd)
 934                   initfunction (slot-definition-initfunction slotd)
 935                   initp t)))
 936         (unless allocp
 937           (setq allocation (slot-definition-allocation slotd)
 938                 allocp t))
 939         (setq initargs (append (slot-definition-initargs slotd) initargs))
 940         (let ((slotd-type (slot-definition-type slotd)))
 941           (setq type (cond ((eq type t) slotd-type)
 942                            ((*subtypep type slotd-type) type)
 943                            (t `(and ,type ,slotd-type)))))))
 944     (list :name name
 945           :initform initform
 946           :initfunction initfunction
 947           :initargs initargs
 948           :allocation allocation
 949           :type type
 950           :class class)))
 951
 952 (defmethod compute-effective-slot-definition-initargs :around
 953     ((class structure-class) direct-slotds)
 954   (let ((slotd (car direct-slotds)))
 955     (list* :defstruct-accessor-symbol
 956            (slot-definition-defstruct-accessor-symbol slotd)
 957            :internal-reader-function
 958            (slot-definition-internal-reader-function slotd)
 959            :internal-writer-function
 960            (slot-definition-internal-writer-function slotd)
 961            (call-next-method))))
 962 \f
 963 ;;; NOTE: For bootstrapping considerations, these can't use MAKE-INSTANCE
 964 ;;;       to make the method object. They have to use make-a-method which
 965 ;;;       is a specially bootstrapped mechanism for making standard methods.
 966 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
 967   (declare (ignore direct-slot initargs))
 968   (find-class 'standard-reader-method))
 969
 970 (defmethod add-reader-method ((class slot-class) generic-function slot-name)
 971   (add-method generic-function
 972               (make-a-method 'standard-reader-method
 973                              ()
 974                              (list (or (class-name class) 'object))
 975                              (list class)
 976                              (make-reader-method-function class slot-name)
 977                              "automatically generated reader method"
 978                              slot-name)))
 979
 980 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
 981   (declare (ignore direct-slot initargs))
 982   (find-class 'standard-writer-method))
 983
 984 (defmethod add-writer-method ((class slot-class) generic-function slot-name)
 985   (add-method generic-function
 986               (make-a-method 'standard-writer-method
 987                              ()
 988                              (list 'new-value (or (class-name class) 'object))
 989                              (list *the-class-t* class)
 990                              (make-writer-method-function class slot-name)
 991                              "automatically generated writer method"
 992                              slot-name)))
 993
 994 (defmethod add-boundp-method ((class slot-class) generic-function slot-name)
 995   (add-method generic-function
 996               (make-a-method 'standard-boundp-method
 997                              ()
 998                              (list (or (class-name class) 'object))
 999                              (list class)
1000                              (make-boundp-method-function class slot-name)
1001                              "automatically generated boundp method"
1002                              slot-name)))
1003
1004 (defmethod remove-reader-method ((class slot-class) generic-function)
1005   (let ((method (get-method generic-function () (list class) nil)))
1006     (when method (remove-method generic-function method))))
1007
1008 (defmethod remove-writer-method ((class slot-class) generic-function)
1009   (let ((method
1010           (get-method generic-function () (list *the-class-t* class) nil)))
1011     (when method (remove-method generic-function method))))
1012
1013 (defmethod remove-boundp-method ((class slot-class) generic-function)
1014   (let ((method (get-method generic-function () (list class) nil)))
1015     (when method (remove-method generic-function method))))
1016 \f
1017 ;;; MAKE-READER-METHOD-FUNCTION and MAKE-WRITE-METHOD function are NOT
1018 ;;; part of the standard protocol. They are however useful, PCL makes
1019 ;;; use of them internally and documents them for PCL users.
1020 ;;;
1021 ;;; *** This needs work to make type testing by the writer functions which
1022 ;;; *** do type testing faster. The idea would be to have one constructor
1023 ;;; *** for each possible type test.
1024 ;;;
1025 ;;; *** There is a subtle bug here which is going to have to be fixed.
1026 ;;; *** Namely, the simplistic use of the template has to be fixed. We
1027 ;;; *** have to give the OPTIMIZE-SLOT-VALUE method the user might have
1028 ;;; *** defined for this metaclass a chance to run.
1029
1030 (defmethod make-reader-method-function ((class slot-class) slot-name)
1031   (make-std-reader-method-function (class-name class) slot-name))
1032
1033 (defmethod make-writer-method-function ((class slot-class) slot-name)
1034   (make-std-writer-method-function (class-name class) slot-name))
1035
1036 (defmethod make-boundp-method-function ((class slot-class) slot-name)
1037   (make-std-boundp-method-function (class-name class) slot-name))
1038 \f
1039 (defmethod compatible-meta-class-change-p (class proto-new-class)
1040   (eq (class-of class) (class-of proto-new-class)))
1041
1042 (defmethod validate-superclass ((class class) (new-super class))
1043   (or (eq new-super *the-class-t*)
1044       (eq (class-of class) (class-of new-super))))
1045
1046 (defmethod validate-superclass ((class standard-class) (new-super std-class))
1047   (let ((new-super-meta-class (class-of new-super)))
1048     (or (eq new-super-meta-class *the-class-std-class*)
1049         (eq (class-of class) new-super-meta-class))))
1050 \f
1051 ;;; What this does depends on which of the four possible values of
1052 ;;; LAYOUT-INVALID the PCL wrapper has; the simplest case is when it
1053 ;;; is (:FLUSH <wrapper>) or (:OBSOLETE <wrapper>), when there is
1054 ;;; nothing to do, as the new wrapper has already been created.  If
1055 ;;; LAYOUT-INVALID returns NIL, then we invalidate it (setting it to
1056 ;;; (:FLUSH <wrapper>); UPDATE-SLOTS later gets to choose whether or
1057 ;;; not to "upgrade" this to (:OBSOLETE <wrapper>).
1058 ;;;
1059 ;;; This leaves the case where LAYOUT-INVALID returns T, which happens
1060 ;;; when REGISTER-LAYOUT has invalidated a superclass of CLASS (which
1061 ;;; invalidated all the subclasses in SB-KERNEL land).  Again, here we
1062 ;;; must flush the caches and allow UPDATE-SLOTS to decide whether to
1063 ;;; obsolete the wrapper.
1064 ;;;
1065 ;;; FIXME: either here or in INVALID-WRAPPER-P looks like a good place
1066 ;;; for (AVER (NOT (EQ (SB-KERNEL:LAYOUT-INVALID OWRAPPER)
1067 ;;;                    :UNINITIALIZED)))
1068 ;;;
1069 ;;; Thanks to Gerd Moellmann for the explanation.  -- CSR, 2002-10-29
1070 (defun force-cache-flushes (class)
1071   (let* ((owrapper (class-wrapper class)))
1072     ;; We only need to do something if the wrapper is still valid. If
1073     ;; the wrapper isn't valid, state will be FLUSH or OBSOLETE, and
1074     ;; both of those will already be doing what we want. In
1075     ;; particular, we must be sure we never change an OBSOLETE into a
1076     ;; FLUSH since OBSOLETE means do what FLUSH does and then some.
1077     (when (or (not (invalid-wrapper-p owrapper))
1078               ;; KLUDGE: despite the observations above, this remains
1079               ;; a violation of locality or what might be considered
1080               ;; good style.  There has to be a better way!  -- CSR,
1081               ;; 2002-10-29
1082               (eq (sb-kernel:layout-invalid owrapper) t))
1083       (let ((nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1084                                     class)))
1085         (setf (wrapper-instance-slots-layout nwrapper)
1086               (wrapper-instance-slots-layout owrapper))
1087         (setf (wrapper-class-slots nwrapper)
1088               (wrapper-class-slots owrapper))
1089         (sb-sys:without-interrupts
1090           (update-lisp-class-layout class nwrapper)
1091           (setf (slot-value class 'wrapper) nwrapper)
1092           (invalidate-wrapper owrapper :flush nwrapper))))))
1093
1094 (defun flush-cache-trap (owrapper nwrapper instance)
1095   (declare (ignore owrapper))
1096   (set-wrapper instance nwrapper))
1097 \f
1098 ;;; MAKE-INSTANCES-OBSOLETE can be called by user code. It will cause
1099 ;;; the next access to the instance (as defined in 88-002R) to trap
1100 ;;; through the UPDATE-INSTANCE-FOR-REDEFINED-CLASS mechanism.
1101 (defmethod make-instances-obsolete ((class std-class))
1102   (let* ((owrapper (class-wrapper class))
1103          (nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1104                                  class)))
1105       (setf (wrapper-instance-slots-layout nwrapper)
1106             (wrapper-instance-slots-layout owrapper))
1107       (setf (wrapper-class-slots nwrapper)
1108             (wrapper-class-slots owrapper))
1109       (sb-sys:without-interrupts
1110         (update-lisp-class-layout class nwrapper)
1111         (setf (slot-value class 'wrapper) nwrapper)
1112         (invalidate-wrapper owrapper :obsolete nwrapper)
1113         class)))
1114
1115 (defmethod make-instances-obsolete ((class symbol))
1116   (make-instances-obsolete (find-class class)))
1117
1118 ;;; OBSOLETE-INSTANCE-TRAP is the internal trap that is called when we
1119 ;;; see an obsolete instance. The times when it is called are:
1120 ;;;   - when the instance is involved in method lookup
1121 ;;;   - when attempting to access a slot of an instance
1122 ;;;
1123 ;;; It is not called by class-of, wrapper-of, or any of the low-level
1124 ;;; instance access macros.
1125 ;;;
1126 ;;; Of course these times when it is called are an internal
1127 ;;; implementation detail of PCL and are not part of the documented
1128 ;;; description of when the obsolete instance update happens. The
1129 ;;; documented description is as it appears in 88-002R.
1130 ;;;
1131 ;;; This has to return the new wrapper, so it counts on all the
1132 ;;; methods on obsolete-instance-trap-internal to return the new
1133 ;;; wrapper. It also does a little internal error checking to make
1134 ;;; sure that the traps are only happening when they should, and that
1135 ;;; the trap methods are computing appropriate new wrappers.
1136
1137 ;;; OBSOLETE-INSTANCE-TRAP might be called on structure instances
1138 ;;; after a structure is redefined. In most cases,
1139 ;;; OBSOLETE-INSTANCE-TRAP will not be able to fix the old instance,
1140 ;;; so it must signal an error. The hard part of this is that the
1141 ;;; error system and debugger might cause OBSOLETE-INSTANCE-TRAP to be
1142 ;;; called again, so in that case, we have to return some reasonable
1143 ;;; wrapper, instead.
1144
1145 (defvar *in-obsolete-instance-trap* nil)
1146 (defvar *the-wrapper-of-structure-object*
1147   (class-wrapper (find-class 'structure-object)))
1148
1149 (define-condition obsolete-structure (error)
1150   ((datum :reader obsolete-structure-datum :initarg :datum))
1151   (:report
1152    (lambda (condition stream)
1153      ;; Don't try to print the structure, since it probably won't work.
1154      (format stream
1155              "~@<obsolete structure error for a structure of type ~2I~_~S~:>"
1156              (type-of (obsolete-structure-datum condition))))))
1157
1158 (defun obsolete-instance-trap (owrapper nwrapper instance)
1159   (if (not (pcl-instance-p instance))
1160       (if *in-obsolete-instance-trap*
1161           *the-wrapper-of-structure-object*
1162            (let ((*in-obsolete-instance-trap* t))
1163              (error 'obsolete-structure :datum instance)))
1164       (let* ((class (wrapper-class* nwrapper))
1165              (copy (allocate-instance class)) ;??? allocate-instance ???
1166              (olayout (wrapper-instance-slots-layout owrapper))
1167              (nlayout (wrapper-instance-slots-layout nwrapper))
1168              (oslots (get-slots instance))
1169              (nslots (get-slots copy))
1170              (oclass-slots (wrapper-class-slots owrapper))
1171              (added ())
1172              (discarded ())
1173              (plist ()))
1174         ;; local  --> local     transfer
1175         ;; local  --> shared       discard
1176         ;; local  -->  --         discard
1177         ;; shared --> local     transfer
1178         ;; shared --> shared       discard
1179         ;; shared -->  --         discard
1180         ;;  --    --> local     add
1181         ;;  --    --> shared    --
1182
1183         ;; Go through all the old local slots.
1184         (let ((opos 0))
1185           (dolist (name olayout)
1186             (let ((npos (posq name nlayout)))
1187               (if npos
1188                   (setf (clos-slots-ref nslots npos)
1189                         (clos-slots-ref oslots opos))
1190                   (progn
1191                     (push name discarded)
1192                     (unless (eq (clos-slots-ref oslots opos) +slot-unbound+)
1193                       (setf (getf plist name) (clos-slots-ref oslots opos))))))
1194             (incf opos)))
1195
1196         ;; Go through all the old shared slots.
1197         (dolist (oclass-slot-and-val oclass-slots)
1198           (let ((name (car oclass-slot-and-val))
1199                 (val (cdr oclass-slot-and-val)))
1200             (let ((npos (posq name nlayout)))
1201               (if npos
1202                   (setf (clos-slots-ref nslots npos) (cdr oclass-slot-and-val))
1203                   (progn (push name discarded)
1204                          (unless (eq val +slot-unbound+)
1205                            (setf (getf plist name) val)))))))
1206
1207         ;; Go through all the new local slots to compute the added slots.
1208         (dolist (nlocal nlayout)
1209           (unless (or (memq nlocal olayout)
1210                       (assq nlocal oclass-slots))
1211             (push nlocal added)))
1212
1213         (swap-wrappers-and-slots instance copy)
1214
1215         (update-instance-for-redefined-class instance
1216                                              added
1217                                              discarded
1218                                              plist)
1219         nwrapper)))
1220 \f
1221 (defun change-class-internal (instance new-class initargs)
1222   (let* ((old-class (class-of instance))
1223          (copy (allocate-instance new-class))
1224          (new-wrapper (get-wrapper copy))
1225          (old-wrapper (class-wrapper old-class))
1226          (old-layout (wrapper-instance-slots-layout old-wrapper))
1227          (new-layout (wrapper-instance-slots-layout new-wrapper))
1228          (old-slots (get-slots instance))
1229          (new-slots (get-slots copy))
1230          (old-class-slots (wrapper-class-slots old-wrapper)))
1231
1232     ;; "The values of local slots specified by both the class CTO and
1233     ;; CFROM are retained. If such a local slot was unbound, it
1234     ;; remains unbound."
1235     (let ((new-position 0))
1236       (dolist (new-slot new-layout)
1237         (let ((old-position (posq new-slot old-layout)))
1238           (when old-position
1239             (setf (clos-slots-ref new-slots new-position)
1240                   (clos-slots-ref old-slots old-position))))
1241         (incf new-position)))
1242
1243     ;; "The values of slots specified as shared in the class CFROM and
1244     ;; as local in the class CTO are retained."
1245     (dolist (slot-and-val old-class-slots)
1246       (let ((position (posq (car slot-and-val) new-layout)))
1247         (when position
1248           (setf (clos-slots-ref new-slots position) (cdr slot-and-val)))))
1249
1250     ;; Make the copy point to the old instance's storage, and make the
1251     ;; old instance point to the new storage.
1252     (swap-wrappers-and-slots instance copy)
1253
1254     (apply #'update-instance-for-different-class copy instance initargs)
1255     instance))
1256
1257 (defmethod change-class ((instance standard-object)
1258                          (new-class standard-class)
1259                          &rest initargs)
1260   (change-class-internal instance new-class initargs))
1261
1262 (defmethod change-class ((instance funcallable-standard-object)
1263                          (new-class funcallable-standard-class)
1264                          &rest initargs)
1265   (change-class-internal instance new-class initargs))
1266
1267 (defmethod change-class ((instance standard-object)
1268                          (new-class funcallable-standard-class)
1269                          &rest initargs)
1270   (declare (ignore initargs))
1271   (error "You can't change the class of ~S to ~S~@
1272           because it isn't already an instance with metaclass ~S."
1273          instance new-class 'standard-class))
1274
1275 (defmethod change-class ((instance funcallable-standard-object)
1276                          (new-class standard-class)
1277                          &rest initargs)
1278   (declare (ignore initargs))
1279   (error "You can't change the class of ~S to ~S~@
1280           because it isn't already an instance with metaclass ~S."
1281          instance new-class 'funcallable-standard-class))
1282
1283 (defmethod change-class ((instance t) (new-class-name symbol) &rest initargs)
1284   (apply #'change-class instance (find-class new-class-name) initargs))
1285 \f
1286 ;;;; The metaclass BUILT-IN-CLASS
1287 ;;;;
1288 ;;;; This metaclass is something of a weird creature. By this point, all
1289 ;;;; instances of it which will exist have been created, and no instance
1290 ;;;; is ever created by calling MAKE-INSTANCE.
1291 ;;;;
1292 ;;;; But, there are other parts of the protocol we must follow and those
1293 ;;;; definitions appear here.
1294
1295 (defmethod shared-initialize :before
1296            ((class built-in-class) slot-names &rest initargs)
1297   (declare (ignore slot-names initargs))
1298   (error "attempt to initialize or reinitialize a built in class"))
1299
1300 (defmethod class-direct-slots       ((class built-in-class)) ())
1301 (defmethod class-slots             ((class built-in-class)) ())
1302 (defmethod class-direct-default-initargs ((class built-in-class)) ())
1303 (defmethod class-default-initargs       ((class built-in-class)) ())
1304
1305 (defmethod validate-superclass ((c class) (s built-in-class))
1306   (or (eq s *the-class-t*)
1307       (eq s *the-class-stream*)))
1308 \f
1309 (defmethod validate-superclass ((c slot-class)
1310                                 (f forward-referenced-class))
1311   t)
1312 \f
1313 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1314   (pushnew dependent (plist-value metaobject 'dependents)))
1315
1316 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1317   (setf (plist-value metaobject 'dependents)
1318         (delete dependent (plist-value metaobject 'dependents))))
1319
1320 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1321   (dolist (dependent (plist-value metaobject 'dependents))
1322     (funcall function dependent)))
1323