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     res))
 326
 327 (setf (gdefinition 'load-defclass) #'real-load-defclass)
 328
 329 (defun ensure-class (name &rest all)
 330   (apply #'ensure-class-using-class (find-class name nil) name all))
 331
 332 (defmethod ensure-class-using-class ((class null) name &rest args &key)
 333   (multiple-value-bind (meta initargs)
 334       (ensure-class-values class args)
 335     (set-class-type-translation (class-prototype meta) name)
 336     (setf class (apply #'make-instance meta :name name initargs)
 337           (find-class name) class)
 338     (set-class-type-translation class name)
 339     class))
 340
 341 (defmethod ensure-class-using-class ((class pcl-class) name &rest args &key)
 342   (multiple-value-bind (meta initargs)
 343       (ensure-class-values class args)
 344     (unless (eq (class-of class) meta)
 345       (apply #'change-class class meta initargs))
 346     (apply #'reinitialize-instance class initargs)
 347     (setf (find-class name) class)
 348     (set-class-type-translation class name)
 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     (do ((direct-slots (getf initargs :direct-slots) (cdr direct-slots)))
 386         ((endp direct-slots) nil)
 387       (destructuring-bind (slot &rest more) direct-slots
 388         (let ((slot-name (getf slot :name)))
 389           (when (some (lambda (s) (eq slot-name (getf s :name))) more)
 390             ;; FIXME: It's quite possible that we ought to define an
 391             ;; SB-INT:PROGRAM-ERROR function to signal these and other
 392             ;; errors throughout the codebase that are required to be
 393             ;; of type PROGRAM-ERROR.
 394             (error 'simple-program-error
 395                    :format-control "~@<There is more than one direct slot ~
 396                                    with name ~S.~:>"
 397                    :format-arguments (list slot-name)))
 398           (do ((stuff slot (cddr stuff)))
 399               ((endp stuff) nil)
 400             (destructuring-bind (option value &rest more) stuff
 401               (cond
 402                 ((and (member option '(:allocation :type
 403                                        :initform :documentation))
 404                       (not (eq unsupplied
 405                                (getf more option unsupplied))))
 406                  (error 'simple-program-error
 407                         :format-control "~@<Duplicate slot option ~S for ~
 408                                         slot named ~S.~:>"
 409                         :format-arguments (list option slot-name)))
 410                 ((and (eq option :readers)
 411                       (notevery #'symbolp value))
 412                  (error 'simple-program-error
 413                         :format-control "~@<Slot reader names for slot ~
 414                                         named ~S must be symbols.~:>"
 415                         :format-arguments (list slot-name)))
 416                 ((and (eq option :initargs)
 417                       (notevery #'symbolp value))
 418                  (error 'simple-program-error
 419                         :format-control "~@<Slot initarg names for slot ~
 420                                         named ~S must be symbols.~:>"
 421                         :format-arguments (list slot-name)))))))))
 422     (loop for (initarg . more) on (getf initargs :direct-default-initargs)
 423           for name = (car initarg)
 424           when (some (lambda (a) (eq (car a) name)) more)
 425           do (error 'simple-program-error
 426                     :format-control "~@<Duplicate initialization argument ~
 427                                     name ~S in :DEFAULT-INITARGS.~:>"
 428                     :format-arguments (list name class)))
 429     (let ((metaclass 0)
 430           (default-initargs 0))
 431       (do ((args initargs (cddr args)))
 432           ((endp args) nil)
 433         (case (car args)
 434           (:metaclass
 435            (when (> (incf metaclass) 1)
 436              (error 'simple-program-error
 437                     :format-control "~@<More than one :METACLASS ~
 438                                     option specified.~:>")))
 439           (:direct-default-initargs
 440            (when (> (incf default-initargs) 1)
 441              (error 'simple-program-error
 442                     :format-control "~@<More than one :DEFAULT-INITARGS ~
 443                                     option specified.~:>"))))))
 444     (remf initargs :metaclass)
 445     (loop (unless (remf initargs :direct-superclasses) (return)))
 446     (loop (unless (remf initargs :direct-slots) (return)))
 447     (values
 448      meta
 449      (nconc
 450       (when (neq supplied-supers unsupplied)
 451         (list :direct-superclasses (mapcar #'fix-super supplied-supers)))
 452       (when (neq supplied-slots unsupplied)
 453         (list :direct-slots supplied-slots))
 454       initargs))))
 455 \f
 456 (defmethod shared-initialize :after
 457            ((class std-class)
 458             slot-names
 459             &key (direct-superclasses nil direct-superclasses-p)
 460                  (direct-slots nil direct-slots-p)
 461                  (direct-default-initargs nil direct-default-initargs-p)
 462                  (predicate-name nil predicate-name-p))
 463   (declare (ignore slot-names))
 464   (cond (direct-superclasses-p
 465          (setq direct-superclasses
 466                (or direct-superclasses
 467                    (list (if (funcallable-standard-class-p class)
 468                              *the-class-funcallable-standard-object*
 469                              *the-class-standard-object*))))
 470          (dolist (superclass direct-superclasses)
 471            (unless (validate-superclass class superclass)
 472              (error "The class ~S was specified as a~%
 473                      super-class of the class ~S;~%~
 474                      but the meta-classes ~S and~%~S are incompatible.~@
 475                      Define a method for ~S to avoid this error."
 476                      superclass class (class-of superclass) (class-of class)
 477                      'validate-superclass)))
 478          (setf (slot-value class 'direct-superclasses) direct-superclasses))
 479         (t
 480          (setq direct-superclasses (slot-value class 'direct-superclasses))))
 481   (setq direct-slots
 482         (if direct-slots-p
 483             (setf (slot-value class 'direct-slots)
 484                   (mapcar (lambda (pl) (make-direct-slotd class pl))
 485                           direct-slots))
 486             (slot-value class 'direct-slots)))
 487   (if direct-default-initargs-p
 488       (setf (plist-value class 'direct-default-initargs)
 489             direct-default-initargs)
 490       (setq direct-default-initargs
 491             (plist-value class 'direct-default-initargs)))
 492   (setf (plist-value class 'class-slot-cells)
 493         (let (collect)
 494           (dolist (dslotd direct-slots)
 495             (when (eq :class (slot-definition-allocation dslotd))
 496               (let ((initfunction (slot-definition-initfunction dslotd)))
 497                 (push (cons (slot-definition-name dslotd)
 498                                (if initfunction
 499                                    (funcall initfunction)
 500                                    +slot-unbound+))
 501                       collect))))
 502           (nreverse collect)))
 503   (setq predicate-name (if predicate-name-p
 504                            (setf (slot-value class 'predicate-name)
 505                                  (car predicate-name))
 506                            (or (slot-value class 'predicate-name)
 507                                (setf (slot-value class 'predicate-name)
 508                                      (make-class-predicate-name (class-name
 509                                                                  class))))))
 510   (add-direct-subclasses class direct-superclasses)
 511   (make-class-predicate class predicate-name)
 512   (update-class class nil)
 513   (add-slot-accessors class direct-slots))
 514
 515 (defmethod shared-initialize :before ((class class) slot-names &key name)
 516   (declare (ignore slot-names name))
 517   ;; FIXME: Could this just be CLASS instead of `(CLASS ,CLASS)? If not,
 518   ;; why not? (See also similar expression in !BOOTSTRAP-INITIALIZE-CLASS.)
 519   (setf (slot-value class 'type) `(class ,class))
 520   (setf (slot-value class 'class-eq-specializer)
 521         (make-instance 'class-eq-specializer :class class)))
 522
 523 (defmethod reinitialize-instance :before ((class slot-class) &key)
 524   (remove-direct-subclasses class (class-direct-superclasses class))
 525   (remove-slot-accessors    class (class-direct-slots class)))
 526
 527 (defmethod reinitialize-instance :after ((class slot-class)
 528                                          &rest initargs
 529                                          &key)
 530   (map-dependents class
 531                   (lambda (dependent)
 532                     (apply #'update-dependent class dependent initargs))))
 533
 534 (defmethod shared-initialize :after ((class condition-class) slot-names
 535                                      &key direct-superclasses)
 536   (declare (ignore slot-names))
 537   (let ((classoid (find-classoid (class-name class))))
 538     (with-slots (wrapper class-precedence-list prototype predicate-name
 539                          (direct-supers direct-superclasses))
 540         class
 541       (setf (classoid-pcl-class classoid) class)
 542       (setq direct-supers direct-superclasses)
 543       (setq wrapper (classoid-layout classoid))
 544       (setq class-precedence-list (compute-class-precedence-list class))
 545       (setq prototype (make-condition (class-name class)))
 546       (add-direct-subclasses class direct-superclasses)
 547       (setq predicate-name (make-class-predicate-name (class-name class)))
 548       (make-class-predicate class predicate-name))))
 549
 550 (defmethod shared-initialize :after
 551     ((slotd structure-slot-definition) slot-names &key
 552      (allocation :instance) allocation-class)
 553   (declare (ignore slot-names allocation-class))
 554   (unless (eq allocation :instance)
 555     (error "Structure slots must have :INSTANCE allocation.")))
 556
 557 (defun make-structure-class-defstruct-form (name direct-slots include)
 558   (let* ((conc-name (intern (format nil "~S structure class " name)))
 559          (constructor (intern (format nil "~Aconstructor" conc-name)))
 560          (defstruct `(defstruct (,name
 561                                  ,@(when include
 562                                          `((:include ,(class-name include))))
 563                                  (:predicate nil)
 564                                  (:conc-name ,conc-name)
 565                                  (:constructor ,constructor ())
 566                                  (:copier nil))
 567                       ,@(mapcar (lambda (slot)
 568                                   `(,(slot-definition-name slot)
 569                                     +slot-unbound+))
 570                                 direct-slots)))
 571          (reader-names (mapcar (lambda (slotd)
 572                                  (list 'slot-accessor name
 573                                        (slot-definition-name slotd)
 574                                        'reader))
 575                                direct-slots))
 576          (writer-names (mapcar (lambda (slotd)
 577                                  (list 'slot-accessor name
 578                                        (slot-definition-name slotd)
 579                                        'writer))
 580                                direct-slots))
 581          (readers-init
 582            (mapcar (lambda (slotd reader-name)
 583                      (let ((accessor
 584                              (slot-definition-defstruct-accessor-symbol
 585                               slotd)))
 586                        `(defun ,reader-name (obj)
 587                          (declare (type ,name obj))
 588                          (,accessor obj))))
 589                    direct-slots reader-names))
 590          (writers-init
 591            (mapcar (lambda (slotd writer-name)
 592                      (let ((accessor
 593                              (slot-definition-defstruct-accessor-symbol
 594                               slotd)))
 595                        `(defun ,writer-name (nv obj)
 596                          (declare (type ,name obj))
 597                          (setf (,accessor obj) nv))))
 598                    direct-slots writer-names))
 599          (defstruct-form
 600              `(progn
 601                ,defstruct
 602                ,@readers-init ,@writers-init
 603                (cons nil nil))))
 604     (values defstruct-form constructor reader-names writer-names)))
 605
 606 (defmethod shared-initialize :after
 607       ((class structure-class)
 608        slot-names
 609        &key (direct-superclasses nil direct-superclasses-p)
 610             (direct-slots nil direct-slots-p)
 611             direct-default-initargs
 612             (predicate-name nil predicate-name-p))
 613   (declare (ignore slot-names direct-default-initargs))
 614   (if direct-superclasses-p
 615       (setf (slot-value class 'direct-superclasses)
 616             (or direct-superclasses
 617                 (setq direct-superclasses
 618                       (and (not (eq (class-name class) 'structure-object))
 619                            (list *the-class-structure-object*)))))
 620       (setq direct-superclasses (slot-value class 'direct-superclasses)))
 621   (let* ((name (class-name class))
 622          (from-defclass-p (slot-value class 'from-defclass-p))
 623          (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
 624     (if direct-slots-p
 625         (setf (slot-value class 'direct-slots)
 626               (setq direct-slots
 627                     (mapcar (lambda (pl)
 628                               (when defstruct-p
 629                                 (let* ((slot-name (getf pl :name))
 630                                        (acc-name
 631                                         (format nil
 632                                                 "~S structure class ~A"
 633                                                 name slot-name))
 634                                        (accessor (intern acc-name)))
 635                                   (setq pl (list* :defstruct-accessor-symbol
 636                                                   accessor pl))))
 637                               (make-direct-slotd class pl))
 638                             direct-slots)))
 639         (setq direct-slots (slot-value class 'direct-slots)))
 640     (when defstruct-p
 641       (let ((include (car (slot-value class 'direct-superclasses))))
 642         (multiple-value-bind (defstruct-form constructor reader-names writer-names)
 643             (make-structure-class-defstruct-form name direct-slots include)
 644           (unless (structure-type-p name) (eval defstruct-form))
 645           (mapc (lambda (dslotd reader-name writer-name)
 646                   (let* ((reader (gdefinition reader-name))
 647                          (writer (when (gboundp writer-name)
 648                                    (gdefinition writer-name))))
 649                     (setf (slot-value dslotd 'internal-reader-function)
 650                           reader)
 651                     (setf (slot-value dslotd 'internal-writer-function)
 652                           writer)))
 653                 direct-slots reader-names writer-names)
 654           (setf (slot-value class 'defstruct-form) defstruct-form)
 655           (setf (slot-value class 'defstruct-constructor) constructor))))
 656     (add-direct-subclasses class direct-superclasses)
 657     (setf (slot-value class 'class-precedence-list)
 658             (compute-class-precedence-list class))
 659     (setf (slot-value class 'slots) (compute-slots class))
 660     (let ((lclass (find-classoid (class-name class))))
 661       (setf (classoid-pcl-class lclass) class)
 662       (setf (slot-value class 'wrapper) (classoid-layout lclass)))
 663     (update-pv-table-cache-info class)
 664     (setq predicate-name (if predicate-name-p
 665                            (setf (slot-value class 'predicate-name)
 666                                    (car predicate-name))
 667                            (or (slot-value class 'predicate-name)
 668                                (setf (slot-value class 'predicate-name)
 669                                        (make-class-predicate-name
 670                                         (class-name class))))))
 671     (make-class-predicate class predicate-name)
 672     (add-slot-accessors class direct-slots)))
 673
 674 (defmethod direct-slot-definition-class ((class structure-class) initargs)
 675   (declare (ignore initargs))
 676   (find-class 'structure-direct-slot-definition))
 677
 678 (defmethod finalize-inheritance ((class structure-class))
 679   nil) ; always finalized
 680 \f
 681 (defun add-slot-accessors (class dslotds)
 682   (fix-slot-accessors class dslotds 'add))
 683
 684 (defun remove-slot-accessors (class dslotds)
 685   (fix-slot-accessors class dslotds 'remove))
 686
 687 (defun fix-slot-accessors (class dslotds add/remove)
 688   (flet ((fix (gfspec name r/w)
 689            (let ((gf (ensure-generic-function gfspec)))
 690              (case r/w
 691                (r (if (eq add/remove 'add)
 692                       (add-reader-method class gf name)
 693                       (remove-reader-method class gf)))
 694                (w (if (eq add/remove 'add)
 695                       (add-writer-method class gf name)
 696                       (remove-writer-method class gf)))))))
 697     (dolist (dslotd dslotds)
 698       (let ((slot-name (slot-definition-name dslotd)))
 699         (dolist (r (slot-definition-readers dslotd)) (fix r slot-name 'r))
 700         (dolist (w (slot-definition-writers dslotd)) (fix w slot-name 'w))))))
 701 \f
 702 (defun add-direct-subclasses (class supers)
 703   (dolist (super supers)
 704     (unless (memq class (class-direct-subclasses class))
 705       (add-direct-subclass super class))))
 706
 707 (defun remove-direct-subclasses (class supers)
 708   (let ((old (class-direct-superclasses class)))
 709     (dolist (o (set-difference old supers))
 710       (remove-direct-subclass o class))))
 711 \f
 712 (defmethod finalize-inheritance ((class std-class))
 713   (update-class class t))
 714
 715 (defmethod finalize-inheritance ((class forward-referenced-class))
 716   ;; FIXME: should we not be thinking a bit about what kinds of error
 717   ;; we're throwing?  Maybe we need a clos-error type to mix in?  Or
 718   ;; possibly a forward-referenced-class-error, though that's
 719   ;; difficult given e.g. class precedence list calculations...
 720   (error
 721    "~@<FINALIZE-INHERITANCE was called on a forward referenced class:~
 722        ~2I~_~S~:>"
 723    class))
 724
 725 \f
 726 (defun class-has-a-forward-referenced-superclass-p (class)
 727   (or (forward-referenced-class-p class)
 728       (some #'class-has-a-forward-referenced-superclass-p
 729             (class-direct-superclasses class))))
 730
 731 ;;; This is called by :after shared-initialize whenever a class is initialized
 732 ;;; or reinitialized. The class may or may not be finalized.
 733 (defun update-class (class finalizep)
 734   ;; Comment from Gerd Moellmann:
 735   ;;
 736   ;; Note that we can't simply delay the finalization when CLASS has
 737   ;; no forward referenced superclasses because that causes bootstrap
 738   ;; problems.
 739   (when (and (not finalizep)
 740              (not (class-finalized-p class))
 741              (not (class-has-a-forward-referenced-superclass-p class)))
 742     (finalize-inheritance class)
 743     (return-from update-class))
 744   (when (or finalizep (class-finalized-p class)
 745             (not (class-has-a-forward-referenced-superclass-p class)))
 746     (setf (find-class (class-name class)) class)
 747     (update-cpl class (compute-class-precedence-list class))
 748     ;; This invocation of UPDATE-SLOTS, in practice, finalizes the
 749     ;; class.  The hoops above are to ensure that FINALIZE-INHERITANCE
 750     ;; is called at finalization, so that MOP programmers can hook
 751     ;; into the system as described in "Class Finalization Protocol"
 752     ;; (section 5.5.2 of AMOP).
 753     (update-slots class (compute-slots class))
 754     (update-gfs-of-class class)
 755     (update-inits class (compute-default-initargs class))
 756     (update-ctors 'finalize-inheritance :class class))
 757   (unless finalizep
 758     (dolist (sub (class-direct-subclasses class)) (update-class sub nil))))
 759
 760 (defun update-cpl (class cpl)
 761   (if (class-finalized-p class)
 762       (unless (equal (class-precedence-list class) cpl)
 763         ;; comment from the old CMU CL sources:
 764         ;;   Need to have the cpl setup before update-lisp-class-layout
 765         ;;   is called on CMU CL.
 766         (setf (slot-value class 'class-precedence-list) cpl)
 767         (force-cache-flushes class))
 768       (setf (slot-value class 'class-precedence-list) cpl))
 769   (update-class-can-precede-p cpl))
 770
 771 (defun update-class-can-precede-p (cpl)
 772   (when cpl
 773     (let ((first (car cpl)))
 774       (dolist (c (cdr cpl))
 775         (pushnew c (slot-value first 'can-precede-list))))
 776     (update-class-can-precede-p (cdr cpl))))
 777
 778 (defun class-can-precede-p (class1 class2)
 779   (member class2 (class-can-precede-list class1)))
 780
 781 (defun update-slots (class eslotds)
 782   (let ((instance-slots ())
 783         (class-slots    ()))
 784     (dolist (eslotd eslotds)
 785       (let ((alloc (slot-definition-allocation eslotd)))
 786         (case alloc
 787           (:instance (push eslotd instance-slots))
 788           (:class (push eslotd class-slots)))))
 789
 790     ;; If there is a change in the shape of the instances then the
 791     ;; old class is now obsolete.
 792     (let* ((nlayout (mapcar #'slot-definition-name
 793                             (sort instance-slots #'<
 794                                   :key #'slot-definition-location)))
 795            (nslots (length nlayout))
 796            (nwrapper-class-slots (compute-class-slots class-slots))
 797            (owrapper (class-wrapper class))
 798            (olayout (and owrapper (wrapper-instance-slots-layout owrapper)))
 799            (owrapper-class-slots (and owrapper (wrapper-class-slots owrapper)))
 800            (nwrapper
 801             (cond ((null owrapper)
 802                    (make-wrapper nslots class))
 803                   ((and (equal nlayout olayout)
 804                         (not
 805                          (loop for o in owrapper-class-slots
 806                                for n in nwrapper-class-slots
 807                                do (unless (eq (car o) (car n)) (return t)))))
 808                    owrapper)
 809                   (t
 810                    ;; This will initialize the new wrapper to have the
 811                    ;; same state as the old wrapper. We will then have
 812                    ;; to change that. This may seem like wasted work
 813                    ;; (and it is), but the spec requires that we call
 814                    ;; MAKE-INSTANCES-OBSOLETE.
 815                    (make-instances-obsolete class)
 816                    (class-wrapper class)))))
 817
 818       (with-slots (wrapper slots) class
 819         (update-lisp-class-layout class nwrapper)
 820         (setf slots eslotds
 821               (wrapper-instance-slots-layout nwrapper) nlayout
 822               (wrapper-class-slots nwrapper) nwrapper-class-slots
 823               (wrapper-no-of-instance-slots nwrapper) nslots
 824               wrapper nwrapper))
 825
 826       (unless (eq owrapper nwrapper)
 827         (update-pv-table-cache-info class)))))
 828
 829 (defun compute-class-slots (eslotds)
 830   (let (collect)
 831     (dolist (eslotd eslotds)
 832       (push (assoc (slot-definition-name eslotd)
 833                    (class-slot-cells (slot-definition-class eslotd)))
 834             collect))
 835     (nreverse collect)))
 836
 837 (defun update-gfs-of-class (class)
 838   (when (and (class-finalized-p class)
 839              (let ((cpl (class-precedence-list class)))
 840                (or (member *the-class-slot-class* cpl)
 841                    (member *the-class-standard-effective-slot-definition*
 842                            cpl))))
 843     (let ((gf-table (make-hash-table :test 'eq)))
 844       (labels ((collect-gfs (class)
 845                  (dolist (gf (specializer-direct-generic-functions class))
 846                    (setf (gethash gf gf-table) t))
 847                  (mapc #'collect-gfs (class-direct-superclasses class))))
 848         (collect-gfs class)
 849         (maphash (lambda (gf ignore)
 850                    (declare (ignore ignore))
 851                    (update-gf-dfun class gf))
 852                  gf-table)))))
 853
 854 (defun update-inits (class inits)
 855   (setf (plist-value class 'default-initargs) inits))
 856 \f
 857 (defmethod compute-default-initargs ((class slot-class))
 858   (let ((cpl (class-precedence-list class))
 859         (direct (class-direct-default-initargs class)))
 860     (labels ((walk (tail)
 861                (if (null tail)
 862                    nil
 863                    (let ((c (pop tail)))
 864                      (append (if (eq c class)
 865                                  direct
 866                                  (class-direct-default-initargs c))
 867                              (walk tail))))))
 868       (let ((initargs (walk cpl)))
 869         (delete-duplicates initargs :test #'eq :key #'car :from-end t)))))
 870 \f
 871 ;;;; protocols for constructing direct and effective slot definitions
 872
 873 (defmethod direct-slot-definition-class ((class std-class) initargs)
 874   (declare (ignore initargs))
 875   (find-class 'standard-direct-slot-definition))
 876
 877 (defun make-direct-slotd (class initargs)
 878   (let ((initargs (list* :class class initargs)))
 879     (apply #'make-instance
 880            (direct-slot-definition-class class initargs)
 881            initargs)))
 882
 883 (defmethod compute-slots ((class std-class))
 884   ;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
 885   ;; for each different slot name we find in our superclasses. Each
 886   ;; call receives the class and a list of the dslotds with that name.
 887   ;; The list is in most-specific-first order.
 888   (let ((name-dslotds-alist ()))
 889     (dolist (c (class-precedence-list class))
 890       (dolist (slot (class-direct-slots c))
 891         (let* ((name (slot-definition-name slot))
 892                (entry (assq name name-dslotds-alist)))
 893           (if entry
 894               (push slot (cdr entry))
 895               (push (list name slot) name-dslotds-alist)))))
 896     (mapcar (lambda (direct)
 897               (compute-effective-slot-definition class
 898                                                  (nreverse (cdr direct))))
 899             name-dslotds-alist)))
 900
 901 (defmethod compute-slots ((class standard-class))
 902   (call-next-method))
 903
 904 (defmethod compute-slots :around ((class standard-class))
 905   (let ((eslotds (call-next-method))
 906         (location -1))
 907     (dolist (eslotd eslotds eslotds)
 908       (setf (slot-definition-location eslotd)
 909             (ecase (slot-definition-allocation eslotd)
 910               (:instance
 911                (incf location))
 912               (:class
 913                (let* ((name (slot-definition-name eslotd))
 914                       (from-class (slot-definition-allocation-class eslotd))
 915                       (cell (assq name (class-slot-cells from-class))))
 916                  (aver (consp cell))
 917                  cell))))
 918       (initialize-internal-slot-functions eslotd))))
 919
 920 (defmethod compute-slots ((class funcallable-standard-class))
 921   (call-next-method))
 922
 923 (defmethod compute-slots :around ((class funcallable-standard-class))
 924   (labels ((instance-slot-names (slotds)
 925              (let (collect)
 926                (dolist (slotd slotds (nreverse collect))
 927                  (when (eq (slot-definition-allocation slotd) :instance)
 928                    (push (slot-definition-name slotd) collect)))))
 929            ;; This sorts slots so that slots of classes later in the CPL
 930            ;; come before slots of other classes.  This is crucial for
 931            ;; funcallable instances because it ensures that the slots of
 932            ;; FUNCALLABLE-STANDARD-OBJECT, which includes the slots of
 933            ;; KERNEL:FUNCALLABLE-INSTANCE, come first, which in turn
 934            ;; makes it possible to treat FUNCALLABLE-STANDARD-OBJECT as
 935            ;; a funcallable instance.
 936            (compute-layout (eslotds)
 937              (let ((first ())
 938                    (names (instance-slot-names eslotds)))
 939                (dolist (class
 940                         (reverse (class-precedence-list class))
 941                         (nreverse (nconc names first)))
 942                  (dolist (ss (class-slots class))
 943                    (let ((name (slot-definition-name ss)))
 944                      (when (member name names)
 945                        (push name first)
 946                        (setq names (delete name names)))))))))
 947     (let ((all-slotds (call-next-method))
 948           (instance-slots ())
 949           (class-slots ()))
 950       (dolist (slotd all-slotds)
 951         (ecase (slot-definition-allocation slotd)
 952           (:instance (push slotd instance-slots))
 953           (:class (push slotd class-slots))))
 954       (let ((layout (compute-layout instance-slots)))
 955         (dolist (slotd instance-slots)
 956           (setf (slot-definition-location slotd)
 957                 (position (slot-definition-name slotd) layout))
 958           (initialize-internal-slot-functions slotd)))
 959       (dolist (slotd class-slots)
 960         (let ((name (slot-definition-name slotd))
 961               (from-class (slot-definition-allocation-class slotd)))
 962           (setf (slot-definition-location slotd)
 963                 (assoc name (class-slot-cells from-class)))
 964           (aver (consp (slot-definition-location slotd)))
 965           (initialize-internal-slot-functions slotd)))
 966       all-slotds)))
 967
 968 (defmethod compute-slots ((class structure-class))
 969   (mapcan (lambda (superclass)
 970             (mapcar (lambda (dslotd)
 971                       (compute-effective-slot-definition class
 972                                                          (list dslotd)))
 973                     (class-direct-slots superclass)))
 974           (reverse (slot-value class 'class-precedence-list))))
 975
 976 (defmethod compute-slots :around ((class structure-class))
 977   (let ((eslotds (call-next-method)))
 978     (mapc #'initialize-internal-slot-functions eslotds)
 979     eslotds))
 980
 981 (defmethod compute-effective-slot-definition ((class slot-class) dslotds)
 982   (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
 983          (class (effective-slot-definition-class class initargs)))
 984     (apply #'make-instance class initargs)))
 985
 986 (defmethod effective-slot-definition-class ((class std-class) initargs)
 987   (declare (ignore initargs))
 988   (find-class 'standard-effective-slot-definition))
 989
 990 (defmethod effective-slot-definition-class ((class structure-class) initargs)
 991   (declare (ignore initargs))
 992   (find-class 'structure-effective-slot-definition))
 993
 994 (defmethod compute-effective-slot-definition-initargs
 995     ((class slot-class) direct-slotds)
 996   (let* ((name nil)
 997          (initfunction nil)
 998          (initform nil)
 999          (initargs nil)
1000          (allocation nil)
1001          (allocation-class nil)
1002          (type t)
1003          (namep  nil)
1004          (initp  nil)
1005          (allocp nil))
1006
1007     (dolist (slotd direct-slotds)
1008       (when slotd
1009         (unless namep
1010           (setq name (slot-definition-name slotd)
1011                 namep t))
1012         (unless initp
1013           (when (slot-definition-initfunction slotd)
1014             (setq initform (slot-definition-initform slotd)
1015                   initfunction (slot-definition-initfunction slotd)
1016                   initp t)))
1017         (unless allocp
1018           (setq allocation (slot-definition-allocation slotd)
1019                 allocation-class (slot-definition-class slotd)
1020                 allocp t))
1021         (setq initargs (append (slot-definition-initargs slotd) initargs))
1022         (let ((slotd-type (slot-definition-type slotd)))
1023           (setq type (cond ((eq type t) slotd-type)
1024                            ((*subtypep type slotd-type) type)
1025                            (t `(and ,type ,slotd-type)))))))
1026     (list :name name
1027           :initform initform
1028           :initfunction initfunction
1029           :initargs initargs
1030           :allocation allocation
1031           :allocation-class allocation-class
1032           :type type
1033           :class class)))
1034
1035 (defmethod compute-effective-slot-definition-initargs :around
1036     ((class structure-class) direct-slotds)
1037   (let ((slotd (car direct-slotds)))
1038     (list* :defstruct-accessor-symbol
1039            (slot-definition-defstruct-accessor-symbol slotd)
1040            :internal-reader-function
1041            (slot-definition-internal-reader-function slotd)
1042            :internal-writer-function
1043            (slot-definition-internal-writer-function slotd)
1044            (call-next-method))))
1045 \f
1046 ;;; NOTE: For bootstrapping considerations, these can't use MAKE-INSTANCE
1047 ;;;       to make the method object. They have to use make-a-method which
1048 ;;;       is a specially bootstrapped mechanism for making standard methods.
1049 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
1050   (declare (ignore direct-slot initargs))
1051   (find-class 'standard-reader-method))
1052
1053 (defmethod add-reader-method ((class slot-class) generic-function slot-name)
1054   (add-method generic-function
1055               (make-a-method 'standard-reader-method
1056                              ()
1057                              (list (or (class-name class) 'object))
1058                              (list class)
1059                              (make-reader-method-function class slot-name)
1060                              "automatically generated reader method"
1061                              slot-name)))
1062
1063 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
1064   (declare (ignore direct-slot initargs))
1065   (find-class 'standard-writer-method))
1066
1067 (defmethod add-writer-method ((class slot-class) generic-function slot-name)
1068   (add-method generic-function
1069               (make-a-method 'standard-writer-method
1070                              ()
1071                              (list 'new-value (or (class-name class) 'object))
1072                              (list *the-class-t* class)
1073                              (make-writer-method-function class slot-name)
1074                              "automatically generated writer method"
1075                              slot-name)))
1076
1077 (defmethod add-boundp-method ((class slot-class) generic-function slot-name)
1078   (add-method generic-function
1079               (make-a-method 'standard-boundp-method
1080                              ()
1081                              (list (or (class-name class) 'object))
1082                              (list class)
1083                              (make-boundp-method-function class slot-name)
1084                              "automatically generated boundp method"
1085                              slot-name)))
1086
1087 (defmethod remove-reader-method ((class slot-class) generic-function)
1088   (let ((method (get-method generic-function () (list class) nil)))
1089     (when method (remove-method generic-function method))))
1090
1091 (defmethod remove-writer-method ((class slot-class) generic-function)
1092   (let ((method
1093           (get-method generic-function () (list *the-class-t* class) nil)))
1094     (when method (remove-method generic-function method))))
1095
1096 (defmethod remove-boundp-method ((class slot-class) generic-function)
1097   (let ((method (get-method generic-function () (list class) nil)))
1098     (when method (remove-method generic-function method))))
1099 \f
1100 ;;; MAKE-READER-METHOD-FUNCTION and MAKE-WRITE-METHOD function are NOT
1101 ;;; part of the standard protocol. They are however useful, PCL makes
1102 ;;; use of them internally and documents them for PCL users.
1103 ;;;
1104 ;;; *** This needs work to make type testing by the writer functions which
1105 ;;; *** do type testing faster. The idea would be to have one constructor
1106 ;;; *** for each possible type test.
1107 ;;;
1108 ;;; *** There is a subtle bug here which is going to have to be fixed.
1109 ;;; *** Namely, the simplistic use of the template has to be fixed. We
1110 ;;; *** have to give the OPTIMIZE-SLOT-VALUE method the user might have
1111 ;;; *** defined for this metaclass a chance to run.
1112
1113 (defmethod make-reader-method-function ((class slot-class) slot-name)
1114   (make-std-reader-method-function (class-name class) slot-name))
1115
1116 (defmethod make-writer-method-function ((class slot-class) slot-name)
1117   (make-std-writer-method-function (class-name class) slot-name))
1118
1119 (defmethod make-boundp-method-function ((class slot-class) slot-name)
1120   (make-std-boundp-method-function (class-name class) slot-name))
1121 \f
1122 (defmethod compatible-meta-class-change-p (class proto-new-class)
1123   (eq (class-of class) (class-of proto-new-class)))
1124
1125 (defmethod validate-superclass ((class class) (new-super class))
1126   (or (eq new-super *the-class-t*)
1127       (eq (class-of class) (class-of new-super))))
1128
1129 (defmethod validate-superclass ((class standard-class) (new-super std-class))
1130   (let ((new-super-meta-class (class-of new-super)))
1131     (or (eq new-super-meta-class *the-class-std-class*)
1132         (eq (class-of class) new-super-meta-class))))
1133 \f
1134 ;;; What this does depends on which of the four possible values of
1135 ;;; LAYOUT-INVALID the PCL wrapper has; the simplest case is when it
1136 ;;; is (:FLUSH <wrapper>) or (:OBSOLETE <wrapper>), when there is
1137 ;;; nothing to do, as the new wrapper has already been created.  If
1138 ;;; LAYOUT-INVALID returns NIL, then we invalidate it (setting it to
1139 ;;; (:FLUSH <wrapper>); UPDATE-SLOTS later gets to choose whether or
1140 ;;; not to "upgrade" this to (:OBSOLETE <wrapper>).
1141 ;;;
1142 ;;; This leaves the case where LAYOUT-INVALID returns T, which happens
1143 ;;; when REGISTER-LAYOUT has invalidated a superclass of CLASS (which
1144 ;;; invalidated all the subclasses in SB-KERNEL land).  Again, here we
1145 ;;; must flush the caches and allow UPDATE-SLOTS to decide whether to
1146 ;;; obsolete the wrapper.
1147 ;;;
1148 ;;; FIXME: either here or in INVALID-WRAPPER-P looks like a good place
1149 ;;; for (AVER (NOT (EQ (LAYOUT-INVALID OWRAPPER)
1150 ;;;                    :UNINITIALIZED)))
1151 ;;;
1152 ;;; Thanks to Gerd Moellmann for the explanation.  -- CSR, 2002-10-29
1153 (defun force-cache-flushes (class)
1154   (let* ((owrapper (class-wrapper class)))
1155     ;; We only need to do something if the wrapper is still valid. If
1156     ;; the wrapper isn't valid, state will be FLUSH or OBSOLETE, and
1157     ;; both of those will already be doing what we want. In
1158     ;; particular, we must be sure we never change an OBSOLETE into a
1159     ;; FLUSH since OBSOLETE means do what FLUSH does and then some.
1160     (when (or (not (invalid-wrapper-p owrapper))
1161               ;; KLUDGE: despite the observations above, this remains
1162               ;; a violation of locality or what might be considered
1163               ;; good style.  There has to be a better way!  -- CSR,
1164               ;; 2002-10-29
1165               (eq (layout-invalid owrapper) t))
1166       (let ((nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1167                                     class)))
1168         (setf (wrapper-instance-slots-layout nwrapper)
1169               (wrapper-instance-slots-layout owrapper))
1170         (setf (wrapper-class-slots nwrapper)
1171               (wrapper-class-slots owrapper))
1172         (with-pcl-lock
1173           (update-lisp-class-layout class nwrapper)
1174           (setf (slot-value class 'wrapper) nwrapper)
1175           (invalidate-wrapper owrapper :flush nwrapper))))))
1176
1177 (defun flush-cache-trap (owrapper nwrapper instance)
1178   (declare (ignore owrapper))
1179   (set-wrapper instance nwrapper))
1180 \f
1181 ;;; MAKE-INSTANCES-OBSOLETE can be called by user code. It will cause
1182 ;;; the next access to the instance (as defined in 88-002R) to trap
1183 ;;; through the UPDATE-INSTANCE-FOR-REDEFINED-CLASS mechanism.
1184 (defmethod make-instances-obsolete ((class std-class))
1185   (let* ((owrapper (class-wrapper class))
1186          (nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1187                                  class)))
1188       (setf (wrapper-instance-slots-layout nwrapper)
1189             (wrapper-instance-slots-layout owrapper))
1190       (setf (wrapper-class-slots nwrapper)
1191             (wrapper-class-slots owrapper))
1192       (with-pcl-lock
1193         (update-lisp-class-layout class nwrapper)
1194         (setf (slot-value class 'wrapper) nwrapper)
1195         (invalidate-wrapper owrapper :obsolete nwrapper)
1196         class)))
1197
1198 (defmethod make-instances-obsolete ((class symbol))
1199   (make-instances-obsolete (find-class class)))
1200
1201 ;;; OBSOLETE-INSTANCE-TRAP is the internal trap that is called when we
1202 ;;; see an obsolete instance. The times when it is called are:
1203 ;;;   - when the instance is involved in method lookup
1204 ;;;   - when attempting to access a slot of an instance
1205 ;;;
1206 ;;; It is not called by class-of, wrapper-of, or any of the low-level
1207 ;;; instance access macros.
1208 ;;;
1209 ;;; Of course these times when it is called are an internal
1210 ;;; implementation detail of PCL and are not part of the documented
1211 ;;; description of when the obsolete instance update happens. The
1212 ;;; documented description is as it appears in 88-002R.
1213 ;;;
1214 ;;; This has to return the new wrapper, so it counts on all the
1215 ;;; methods on obsolete-instance-trap-internal to return the new
1216 ;;; wrapper. It also does a little internal error checking to make
1217 ;;; sure that the traps are only happening when they should, and that
1218 ;;; the trap methods are computing appropriate new wrappers.
1219
1220 ;;; OBSOLETE-INSTANCE-TRAP might be called on structure instances
1221 ;;; after a structure is redefined. In most cases,
1222 ;;; OBSOLETE-INSTANCE-TRAP will not be able to fix the old instance,
1223 ;;; so it must signal an error. The hard part of this is that the
1224 ;;; error system and debugger might cause OBSOLETE-INSTANCE-TRAP to be
1225 ;;; called again, so in that case, we have to return some reasonable
1226 ;;; wrapper, instead.
1227
1228 (defvar *in-obsolete-instance-trap* nil)
1229 (defvar *the-wrapper-of-structure-object*
1230   (class-wrapper (find-class 'structure-object)))
1231
1232 (define-condition obsolete-structure (error)
1233   ((datum :reader obsolete-structure-datum :initarg :datum))
1234   (:report
1235    (lambda (condition stream)
1236      ;; Don't try to print the structure, since it probably won't work.
1237      (format stream
1238              "~@<obsolete structure error for a structure of type ~2I~_~S~:>"
1239              (type-of (obsolete-structure-datum condition))))))
1240
1241 (defun obsolete-instance-trap (owrapper nwrapper instance)
1242   (if (not (pcl-instance-p instance))
1243       (if *in-obsolete-instance-trap*
1244           *the-wrapper-of-structure-object*
1245            (let ((*in-obsolete-instance-trap* t))
1246              (error 'obsolete-structure :datum instance)))
1247       (let* ((class (wrapper-class* nwrapper))
1248              (copy (allocate-instance class)) ;??? allocate-instance ???
1249              (olayout (wrapper-instance-slots-layout owrapper))
1250              (nlayout (wrapper-instance-slots-layout nwrapper))
1251              (oslots (get-slots instance))
1252              (nslots (get-slots copy))
1253              (oclass-slots (wrapper-class-slots owrapper))
1254              (added ())
1255              (discarded ())
1256              (plist ()))
1257         ;; local  --> local     transfer
1258         ;; local  --> shared       discard
1259         ;; local  -->  --         discard
1260         ;; shared --> local     transfer
1261         ;; shared --> shared       discard
1262         ;; shared -->  --         discard
1263         ;;  --    --> local     add
1264         ;;  --    --> shared    --
1265
1266         ;; Go through all the old local slots.
1267         (let ((opos 0))
1268           (dolist (name olayout)
1269             (let ((npos (posq name nlayout)))
1270               (if npos
1271                   (setf (clos-slots-ref nslots npos)
1272                         (clos-slots-ref oslots opos))
1273                   (progn
1274                     (push name discarded)
1275                     (unless (eq (clos-slots-ref oslots opos) +slot-unbound+)
1276                       (setf (getf plist name) (clos-slots-ref oslots opos))))))
1277             (incf opos)))
1278
1279         ;; Go through all the old shared slots.
1280         (dolist (oclass-slot-and-val oclass-slots)
1281           (let ((name (car oclass-slot-and-val))
1282                 (val (cdr oclass-slot-and-val)))
1283             (let ((npos (posq name nlayout)))
1284               (if npos
1285                   (setf (clos-slots-ref nslots npos) (cdr oclass-slot-and-val))
1286                   (progn (push name discarded)
1287                          (unless (eq val +slot-unbound+)
1288                            (setf (getf plist name) val)))))))
1289
1290         ;; Go through all the new local slots to compute the added slots.
1291         (dolist (nlocal nlayout)
1292           (unless (or (memq nlocal olayout)
1293                       (assq nlocal oclass-slots))
1294             (push nlocal added)))
1295
1296         (swap-wrappers-and-slots instance copy)
1297
1298         (update-instance-for-redefined-class instance
1299                                              added
1300                                              discarded
1301                                              plist)
1302         nwrapper)))
1303 \f
1304 (defun change-class-internal (instance new-class initargs)
1305   (let* ((old-class (class-of instance))
1306          (copy (allocate-instance new-class))
1307          (new-wrapper (get-wrapper copy))
1308          (old-wrapper (class-wrapper old-class))
1309          (old-layout (wrapper-instance-slots-layout old-wrapper))
1310          (new-layout (wrapper-instance-slots-layout new-wrapper))
1311          (old-slots (get-slots instance))
1312          (new-slots (get-slots copy))
1313          (old-class-slots (wrapper-class-slots old-wrapper)))
1314
1315     ;; "The values of local slots specified by both the class CTO and
1316     ;; CFROM are retained. If such a local slot was unbound, it
1317     ;; remains unbound."
1318     (let ((new-position 0))
1319       (dolist (new-slot new-layout)
1320         (let ((old-position (posq new-slot old-layout)))
1321           (when old-position
1322             (setf (clos-slots-ref new-slots new-position)
1323                   (clos-slots-ref old-slots old-position))))
1324         (incf new-position)))
1325
1326     ;; "The values of slots specified as shared in the class CFROM and
1327     ;; as local in the class CTO are retained."
1328     (dolist (slot-and-val old-class-slots)
1329       (let ((position (posq (car slot-and-val) new-layout)))
1330         (when position
1331           (setf (clos-slots-ref new-slots position) (cdr slot-and-val)))))
1332
1333     ;; Make the copy point to the old instance's storage, and make the
1334     ;; old instance point to the new storage.
1335     (swap-wrappers-and-slots instance copy)
1336
1337     (apply #'update-instance-for-different-class copy instance initargs)
1338     instance))
1339
1340 (defmethod change-class ((instance standard-object)
1341                          (new-class standard-class)
1342                          &rest initargs)
1343   (change-class-internal instance new-class initargs))
1344
1345 (defmethod change-class ((instance funcallable-standard-object)
1346                          (new-class funcallable-standard-class)
1347                          &rest initargs)
1348   (change-class-internal instance new-class initargs))
1349
1350 (defmethod change-class ((instance standard-object)
1351                          (new-class funcallable-standard-class)
1352                          &rest initargs)
1353   (declare (ignore initargs))
1354   (error "You can't change the class of ~S to ~S~@
1355           because it isn't already an instance with metaclass ~S."
1356          instance new-class 'standard-class))
1357
1358 (defmethod change-class ((instance funcallable-standard-object)
1359                          (new-class standard-class)
1360                          &rest initargs)
1361   (declare (ignore initargs))
1362   (error "You can't change the class of ~S to ~S~@
1363           because it isn't already an instance with metaclass ~S."
1364          instance new-class 'funcallable-standard-class))
1365
1366 (defmethod change-class ((instance t) (new-class-name symbol) &rest initargs)
1367   (apply #'change-class instance (find-class new-class-name) initargs))
1368 \f
1369 ;;;; The metaclass BUILT-IN-CLASS
1370 ;;;;
1371 ;;;; This metaclass is something of a weird creature. By this point, all
1372 ;;;; instances of it which will exist have been created, and no instance
1373 ;;;; is ever created by calling MAKE-INSTANCE.
1374 ;;;;
1375 ;;;; But, there are other parts of the protocol we must follow and those
1376 ;;;; definitions appear here.
1377
1378 (defmethod shared-initialize :before
1379            ((class built-in-class) slot-names &rest initargs)
1380   (declare (ignore slot-names initargs))
1381   (error "attempt to initialize or reinitialize a built in class"))
1382
1383 (defmethod class-direct-slots       ((class built-in-class)) ())
1384 (defmethod class-slots             ((class built-in-class)) ())
1385 (defmethod class-direct-default-initargs ((class built-in-class)) ())
1386 (defmethod class-default-initargs       ((class built-in-class)) ())
1387
1388 (defmethod validate-superclass ((c class) (s built-in-class))
1389   (or (eq s *the-class-t*)
1390       (eq s *the-class-stream*)))
1391 \f
1392 ;;; Some necessary methods for FORWARD-REFERENCED-CLASS
1393 (defmethod class-direct-slots ((class forward-referenced-class)) ())
1394 (defmethod class-direct-default-initargs ((class forward-referenced-class)) ())
1395 (macrolet ((def (method)
1396              `(defmethod ,method ((class forward-referenced-class))
1397                 (error "~@<~I~S was called on a forward referenced class:~2I~_~S~:>"
1398                        ',method class))))
1399   (def class-default-initargs)
1400   (def class-precedence-list)
1401   (def class-slots))
1402
1403 (defmethod validate-superclass ((c slot-class)
1404                                 (f forward-referenced-class))
1405   t)
1406 \f
1407 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1408   (pushnew dependent (plist-value metaobject 'dependents)))
1409
1410 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1411   (setf (plist-value metaobject 'dependents)
1412         (delete dependent (plist-value metaobject 'dependents))))
1413
1414 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1415   (dolist (dependent (plist-value metaobject 'dependents))
1416     (funcall function dependent)))
1417