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 ;;; CMUCL (Gerd PCL 2003-04-25) comment:
  90 ;;;
  91 ;;; Compute an effective method for SLOT-VALUE-USING-CLASS, (SETF
  92 ;;; SLOT-VALUE-USING-CLASS) or SLOT-BOUNDP-USING-CLASS for reading/
  93 ;;; writing/testing effective slot SLOTD.
  94 ;;;
  95 ;;; TYPE is one of the symbols READER, WRITER or BOUNDP, depending on
  96 ;;; GF.  Store the effective method in the effective slot definition
  97 ;;; object itself; these GFs have special dispatch functions calling
  98 ;;; effective methods directly retrieved from effective slot
  99 ;;; definition objects, as an optimization.
 100 ;;;
 101 ;;; FIXME: Change the function name to COMPUTE-SVUC-SLOTD-FUNCTION,
 102 ;;; or some such.
 103 (defmethod compute-slot-accessor-info ((slotd effective-slot-definition)
 104                                        type gf)
 105   (let* ((name (slot-value slotd 'name))
 106          (class (slot-value slotd 'class))
 107          (old-slotd (find-slot-definition class name))
 108          (old-std-p (and old-slotd (slot-accessor-std-p old-slotd 'all))))
 109     (multiple-value-bind (function std-p)
 110         (if (eq *boot-state* 'complete)
 111             (get-accessor-method-function gf type class slotd)
 112             (get-optimized-std-accessor-method-function class slotd type))
 113       (setf (slot-accessor-std-p slotd type) std-p)
 114       (setf (slot-accessor-function slotd type) function))
 115     (when (and old-slotd (not (eq old-std-p (slot-accessor-std-p slotd 'all))))
 116       (push (cons class name) *pv-table-cache-update-info*))))
 117
 118 (defmethod slot-definition-allocation ((slotd structure-slot-definition))
 119   :instance)
 120 \f
 121 ;;;; various class accessors that are a little more complicated than can be
 122 ;;;; done with automatically generated reader methods
 123
 124 (defmethod class-prototype ((class std-class))
 125   (with-slots (prototype) class
 126     (or prototype (setq prototype (allocate-instance class)))))
 127
 128 (defmethod class-prototype ((class structure-class))
 129   (with-slots (prototype wrapper defstruct-constructor) class
 130     (or prototype
 131         (setq prototype
 132               (if defstruct-constructor
 133                   (allocate-instance class)
 134                   (allocate-standard-instance wrapper))))))
 135
 136 (defmethod class-direct-default-initargs ((class slot-class))
 137   (plist-value class 'direct-default-initargs))
 138
 139 (defmethod class-default-initargs ((class slot-class))
 140   (plist-value class 'default-initargs))
 141
 142 (defmethod class-slot-cells ((class std-class))
 143   (plist-value class 'class-slot-cells))
 144 \f
 145 ;;;; class accessors that are even a little bit more complicated than those
 146 ;;;; above. These have a protocol for updating them, we must implement that
 147 ;;;; protocol.
 148
 149 ;;; Maintaining the direct subclasses backpointers. The update methods are
 150 ;;; here, the values are read by an automatically generated reader method.
 151 (defmethod add-direct-subclass ((class class) (subclass class))
 152   (with-slots (direct-subclasses) class
 153     (pushnew subclass direct-subclasses)
 154     subclass))
 155 (defmethod remove-direct-subclass ((class class) (subclass class))
 156   (with-slots (direct-subclasses) class
 157     (setq direct-subclasses (remove subclass direct-subclasses))
 158     subclass))
 159
 160 ;;; Maintaining the direct-methods and direct-generic-functions backpointers.
 161 ;;;
 162 ;;; There are four generic functions involved, each has one method for the
 163 ;;; class case and another method for the damned EQL specializers. All of
 164 ;;; these are specified methods and appear in their specified place in the
 165 ;;; class graph.
 166 ;;;
 167 ;;;   ADD-DIRECT-METHOD
 168 ;;;   REMOVE-DIRECT-METHOD
 169 ;;;   SPECIALIZER-DIRECT-METHODS
 170 ;;;   SPECIALIZER-DIRECT-GENERIC-FUNCTIONS
 171 ;;;
 172 ;;; In each case, we maintain one value which is a cons. The car is the list
 173 ;;; methods. The cdr is a list of the generic functions. The cdr is always
 174 ;;; computed lazily.
 175 (defmethod add-direct-method ((specializer class) (method method))
 176   (with-slots (direct-methods) specializer
 177     (setf (car direct-methods) (adjoin method (car direct-methods))     ;PUSH
 178           (cdr direct-methods) ()))
 179   method)
 180 (defmethod remove-direct-method ((specializer class) (method method))
 181   (with-slots (direct-methods) specializer
 182     (setf (car direct-methods) (remove method (car direct-methods))
 183           (cdr direct-methods) ()))
 184   method)
 185
 186 (defmethod specializer-direct-methods ((specializer class))
 187   (with-slots (direct-methods) specializer
 188     (car direct-methods)))
 189
 190 (defmethod specializer-direct-generic-functions ((specializer class))
 191   (with-slots (direct-methods) specializer
 192     (or (cdr direct-methods)
 193         (setf (cdr direct-methods)
 194               (let (collect)
 195                 (dolist (m (car direct-methods))
 196                   ;; the old PCL code used COLLECTING-ONCE which used
 197                   ;; #'EQ to check for newness
 198                   (pushnew (method-generic-function m) collect :test #'eq))
 199                 (nreverse collect))))))
 200 \f
 201 ;;; This hash table is used to store the direct methods and direct generic
 202 ;;; functions of EQL specializers. Each value in the table is the cons.
 203 (defvar *eql-specializer-methods* (make-hash-table :test 'eql))
 204 (defvar *class-eq-specializer-methods* (make-hash-table :test 'eq))
 205
 206 (defmethod specializer-method-table ((specializer eql-specializer))
 207   *eql-specializer-methods*)
 208
 209 (defmethod specializer-method-table ((specializer class-eq-specializer))
 210   *class-eq-specializer-methods*)
 211
 212 (defmethod add-direct-method ((specializer specializer-with-object)
 213                               (method method))
 214   (let* ((object (specializer-object specializer))
 215          (table (specializer-method-table specializer))
 216          (entry (gethash object table)))
 217     (unless entry
 218       (setq entry
 219             (setf (gethash object table)
 220                   (cons nil nil))))
 221     (setf (car entry) (adjoin method (car entry))
 222           (cdr entry) ())
 223     method))
 224
 225 (defmethod remove-direct-method ((specializer specializer-with-object)
 226                                  (method method))
 227   (let* ((object (specializer-object specializer))
 228          (entry (gethash object (specializer-method-table specializer))))
 229     (when entry
 230       (setf (car entry) (remove method (car entry))
 231             (cdr entry) ()))
 232     method))
 233
 234 (defmethod specializer-direct-methods ((specializer specializer-with-object))
 235   (car (gethash (specializer-object specializer)
 236                 (specializer-method-table specializer))))
 237
 238 (defmethod specializer-direct-generic-functions ((specializer
 239                                                   specializer-with-object))
 240   (let* ((object (specializer-object specializer))
 241          (entry (gethash object (specializer-method-table specializer))))
 242     (when entry
 243       (or (cdr entry)
 244           (setf (cdr entry)
 245                 (let (collect)
 246                   (dolist (m (car entry))
 247                     (pushnew (method-generic-function m) collect :test #'eq))
 248                   (nreverse collect)))))))
 249
 250 (defun map-specializers (function)
 251   (map-all-classes (lambda (class)
 252                      (funcall function (class-eq-specializer class))
 253                      (funcall function class)))
 254   (maphash (lambda (object methods)
 255              (declare (ignore methods))
 256              (intern-eql-specializer object))
 257            *eql-specializer-methods*)
 258   (maphash (lambda (object specl)
 259              (declare (ignore object))
 260              (funcall function specl))
 261            *eql-specializer-table*)
 262   nil)
 263
 264 (defun map-all-generic-functions (function)
 265   (let ((all-generic-functions (make-hash-table :test 'eq)))
 266     (map-specializers (lambda (specl)
 267                         (dolist (gf (specializer-direct-generic-functions
 268                                      specl))
 269                           (unless (gethash gf all-generic-functions)
 270                             (setf (gethash gf all-generic-functions) t)
 271                             (funcall function gf))))))
 272   nil)
 273
 274 (defmethod shared-initialize :after ((specl class-eq-specializer)
 275                                      slot-names
 276                                      &key)
 277   (declare (ignore slot-names))
 278   (setf (slot-value specl 'type) `(class-eq ,(specializer-class specl))))
 279
 280 (defmethod shared-initialize :after ((specl eql-specializer) slot-names &key)
 281   (declare (ignore slot-names))
 282   (setf (slot-value specl 'type) `(eql ,(specializer-object specl))))
 283 \f
 284 (defun real-load-defclass (name metaclass-name supers slots other)
 285   (let ((res (apply #'ensure-class name :metaclass metaclass-name
 286                     :direct-superclasses supers
 287                     :direct-slots slots
 288                     :definition-source `((defclass ,name)
 289                                          ,*load-pathname*)
 290                     other)))
 291     res))
 292
 293 (setf (gdefinition 'load-defclass) #'real-load-defclass)
 294
 295 (defun ensure-class (name &rest args)
 296   (apply #'ensure-class-using-class
 297          (let ((class (find-class name nil)))
 298            (when (and class (eq name (class-name class)))
 299              ;; NAME is the proper name of CLASS, so redefine it
 300              class))
 301          name
 302          args))
 303
 304 (defmethod ensure-class-using-class ((class null) name &rest args &key)
 305   (without-package-locks
 306    (multiple-value-bind (meta initargs)
 307        (ensure-class-values class args)
 308      (set-class-type-translation (class-prototype meta) name)
 309      (setf class (apply #'make-instance meta :name name initargs)
 310            (find-class name) class)
 311      (set-class-type-translation class name)
 312      class)))
 313
 314 (defmethod ensure-class-using-class ((class pcl-class) name &rest args &key)
 315   (without-package-locks
 316    (multiple-value-bind (meta initargs)
 317        (ensure-class-values class args)
 318      (unless (eq (class-of class) meta)
 319        (apply #'change-class class meta initargs))
 320      (apply #'reinitialize-instance class initargs)
 321      (setf (find-class name) class)
 322      (set-class-type-translation class name)
 323      class)))
 324
 325 (defmethod class-predicate-name ((class t))
 326   'constantly-nil)
 327
 328 (defun fix-super (s)
 329   (cond ((classp s) s)
 330         ((not (legal-class-name-p s))
 331          (error "~S is not a class or a legal class name." s))
 332         (t
 333          (or (find-class s nil)
 334              (make-instance 'forward-referenced-class
 335                             :name s)))))
 336
 337 (defun ensure-class-values (class args)
 338   (let* ((initargs (copy-list args))
 339          (unsupplied (list 1))
 340          (supplied-meta   (getf initargs :metaclass unsupplied))
 341          (supplied-supers (getf initargs :direct-superclasses unsupplied))
 342          (supplied-slots  (getf initargs :direct-slots unsupplied))
 343          (meta
 344            (cond ((neq supplied-meta unsupplied)
 345                   (find-class supplied-meta))
 346                  ((or (null class)
 347                       (forward-referenced-class-p class))
 348                   *the-class-standard-class*)
 349                  (t
 350                   (class-of class)))))
 351     ;; KLUDGE: It seemed to me initially that there ought to be a way
 352     ;; of collecting all the erroneous problems in one go, rather than
 353     ;; this way of solving the problem of signalling the errors that
 354     ;; we are required to, which stops at the first bogus input.
 355     ;; However, after playing around a little, I couldn't find that
 356     ;; way, so I've left it as is, but if someone does come up with a
 357     ;; better way... -- CSR, 2002-09-08
 358     (do ((direct-slots (getf initargs :direct-slots) (cdr direct-slots)))
 359         ((endp direct-slots) nil)
 360       (destructuring-bind (slot &rest more) direct-slots
 361         (let ((slot-name (getf slot :name)))
 362           (when (some (lambda (s) (eq slot-name (getf s :name))) more)
 363             ;; FIXME: It's quite possible that we ought to define an
 364             ;; SB-INT:PROGRAM-ERROR function to signal these and other
 365             ;; errors throughout the codebase that are required to be
 366             ;; of type PROGRAM-ERROR.
 367             (error 'simple-program-error
 368                    :format-control "~@<There is more than one direct slot ~
 369                                    with name ~S.~:>"
 370                    :format-arguments (list slot-name)))
 371           (do ((stuff slot (cddr stuff)))
 372               ((endp stuff) nil)
 373             (destructuring-bind (option value &rest more) stuff
 374               (cond
 375                 ((and (member option '(:allocation :type
 376                                        :initform :documentation))
 377                       (not (eq unsupplied
 378                                (getf more option unsupplied))))
 379                  (error 'simple-program-error
 380                         :format-control "~@<Duplicate slot option ~S for ~
 381                                         slot named ~S.~:>"
 382                         :format-arguments (list option slot-name)))
 383                 ((and (eq option :readers)
 384                       (notevery #'symbolp value))
 385                  (error 'simple-program-error
 386                         :format-control "~@<Slot reader names for slot ~
 387                                         named ~S must be symbols.~:>"
 388                         :format-arguments (list slot-name)))
 389                 ((and (eq option :initargs)
 390                       (notevery #'symbolp value))
 391                  (error 'simple-program-error
 392                         :format-control "~@<Slot initarg names for slot ~
 393                                         named ~S must be symbols.~:>"
 394                         :format-arguments (list slot-name)))))))))
 395     (loop for (initarg . more) on (getf initargs :direct-default-initargs)
 396           for name = (car initarg)
 397           when (some (lambda (a) (eq (car a) name)) more)
 398           do (error 'simple-program-error
 399                     :format-control "~@<Duplicate initialization argument ~
 400                                     name ~S in :DEFAULT-INITARGS.~:>"
 401                     :format-arguments (list name class)))
 402     (let ((metaclass 0)
 403           (default-initargs 0))
 404       (do ((args initargs (cddr args)))
 405           ((endp args) nil)
 406         (case (car args)
 407           (:metaclass
 408            (when (> (incf metaclass) 1)
 409              (error 'simple-program-error
 410                     :format-control "~@<More than one :METACLASS ~
 411                                     option specified.~:>")))
 412           (:direct-default-initargs
 413            (when (> (incf default-initargs) 1)
 414              (error 'simple-program-error
 415                     :format-control "~@<More than one :DEFAULT-INITARGS ~
 416                                     option specified.~:>"))))))
 417     (remf initargs :metaclass)
 418     (loop (unless (remf initargs :direct-superclasses) (return)))
 419     (loop (unless (remf initargs :direct-slots) (return)))
 420     (values
 421      meta
 422      (nconc
 423       (when (neq supplied-supers unsupplied)
 424         (list :direct-superclasses (mapcar #'fix-super supplied-supers)))
 425       (when (neq supplied-slots unsupplied)
 426         (list :direct-slots supplied-slots))
 427       initargs))))
 428 \f
 429 (defmethod shared-initialize :after
 430            ((class std-class)
 431             slot-names
 432             &key (direct-superclasses nil direct-superclasses-p)
 433                  (direct-slots nil direct-slots-p)
 434                  (direct-default-initargs nil direct-default-initargs-p)
 435                  (predicate-name nil predicate-name-p))
 436   (cond (direct-superclasses-p
 437          (setq direct-superclasses
 438                (or direct-superclasses
 439                    (list (if (funcallable-standard-class-p class)
 440                              *the-class-funcallable-standard-object*
 441                              *the-class-standard-object*))))
 442          (dolist (superclass direct-superclasses)
 443            (unless (validate-superclass class superclass)
 444              (error "The class ~S was specified as a~%
 445                      super-class of the class ~S;~%~
 446                      but the meta-classes ~S and~%~S are incompatible.~@
 447                      Define a method for ~S to avoid this error."
 448                      superclass class (class-of superclass) (class-of class)
 449                      'validate-superclass)))
 450          (setf (slot-value class 'direct-superclasses) direct-superclasses))
 451         (t
 452          (setq direct-superclasses (slot-value class 'direct-superclasses))))
 453   (setq direct-slots
 454         (if direct-slots-p
 455             (setf (slot-value class 'direct-slots)
 456                   (mapcar (lambda (pl) (make-direct-slotd class pl))
 457                           direct-slots))
 458             (slot-value class 'direct-slots)))
 459   (if direct-default-initargs-p
 460       (setf (plist-value class 'direct-default-initargs)
 461             direct-default-initargs)
 462       (setq direct-default-initargs
 463             (plist-value class 'direct-default-initargs)))
 464   (setf (plist-value class 'class-slot-cells)
 465         (let ((old-class-slot-cells (plist-value class 'class-slot-cells))
 466               (collect '()))
 467           (dolist (dslotd direct-slots)
 468             (when (eq :class (slot-definition-allocation dslotd))
 469               ;; see CLHS 4.3.6
 470               (let* ((name (slot-definition-name dslotd))
 471                      (old (assoc name old-class-slot-cells)))
 472                 (if (or (not old)
 473                         (eq t slot-names)
 474                         (member name slot-names))
 475                     (let* ((initfunction (slot-definition-initfunction dslotd))
 476                            (value (if initfunction
 477                                       (funcall initfunction)
 478                                       +slot-unbound+)))
 479                       (push (cons name value) collect))
 480                     (push old collect)))))
 481           (nreverse collect)))
 482   (setq predicate-name (if predicate-name-p
 483                            (setf (slot-value class 'predicate-name)
 484                                  (car predicate-name))
 485                            (or (slot-value class 'predicate-name)
 486                                (setf (slot-value class 'predicate-name)
 487                                      (make-class-predicate-name (class-name
 488                                                                  class))))))
 489   (add-direct-subclasses class direct-superclasses)
 490   (make-class-predicate class predicate-name)
 491   (update-class class nil)
 492   (do* ((slots (slot-value class 'slots) (cdr slots))
 493         (dupes nil))
 494        ((null slots) (when dupes
 495                        (style-warn
 496                         ;; FIXME: the indentation request ("~4I")
 497                         ;; below appears not to do anything.  Finding
 498                         ;; out why would be nice.  -- CSR, 2003-04-24
 499                         "~@<slot names with the same SYMBOL-NAME but ~
 500                          different SYMBOL-PACKAGE (possible package problem) ~
 501                          for class ~S:~@:_~4I~<~@{~S~^~:@_~}~:>~@:>"
 502                         class
 503                         dupes)))
 504     (let* ((slot (car slots))
 505            (oslots (remove (slot-definition-name slot) (cdr slots)
 506                            :test #'string/= :key #'slot-definition-name)))
 507       (when oslots
 508         (pushnew (cons (slot-definition-name slot)
 509                        (mapcar #'slot-definition-name oslots))
 510                  dupes
 511                  :test #'string= :key #'car))))
 512   (add-slot-accessors class direct-slots)
 513   (make-preliminary-layout class))
 514
 515 (defmethod shared-initialize :after ((class forward-referenced-class)
 516                                      slot-names &key &allow-other-keys)
 517   (declare (ignore slot-names))
 518   (make-preliminary-layout class))
 519
 520 (defvar *allow-forward-referenced-classes-in-cpl-p* nil)
 521
 522 ;;; Give CLASS a preliminary layout if it doesn't have one already, to
 523 ;;; make it known to the type system.
 524 (defun make-preliminary-layout (class)
 525   (flet ((compute-preliminary-cpl (root)
 526            (let ((*allow-forward-referenced-classes-in-cpl-p* t))
 527              (compute-class-precedence-list root))))
 528     (without-package-locks
 529      (unless (class-finalized-p class)
 530        (let ((name (class-name class)))
 531          (setf (find-class name) class)
 532          ;; KLUDGE: This is fairly horrible.  We need to make a
 533          ;; full-fledged CLASSOID here, not just tell the compiler that
 534          ;; some class is forthcoming, because there are legitimate
 535          ;; questions one can ask of the type system, implemented in
 536          ;; terms of CLASSOIDs, involving forward-referenced classes. So.
 537          (when (and (eq *boot-state* 'complete)
 538                     (null (find-classoid name nil)))
 539            (setf (find-classoid name)
 540                  (make-standard-classoid :name name)))
 541          (set-class-type-translation class name)
 542          (let ((layout (make-wrapper 0 class))
 543                (classoid (find-classoid name)))
 544            (setf (layout-classoid layout) classoid)
 545            (setf (classoid-pcl-class classoid) class)
 546            (setf (slot-value class 'wrapper) layout)
 547            (let ((cpl (compute-preliminary-cpl class)))
 548              (setf (layout-inherits layout)
 549                    (order-layout-inherits
 550                     (map 'simple-vector #'class-wrapper
 551                          (reverse (rest cpl))))))
 552            (register-layout layout :invalidate t)
 553            (setf (classoid-layout classoid) layout)
 554            (mapc #'make-preliminary-layout (class-direct-subclasses class))))))))
 555
 556
 557 (defmethod shared-initialize :before ((class class) slot-names &key name)
 558   (declare (ignore slot-names name))
 559   ;; FIXME: Could this just be CLASS instead of `(CLASS ,CLASS)? If not,
 560   ;; why not? (See also similar expression in !BOOTSTRAP-INITIALIZE-CLASS.)
 561   (setf (slot-value class 'type) `(class ,class))
 562   (setf (slot-value class 'class-eq-specializer)
 563         (make-instance 'class-eq-specializer :class class)))
 564
 565 (defmethod reinitialize-instance :before ((class slot-class) &key)
 566   (remove-direct-subclasses class (class-direct-superclasses class))
 567   (remove-slot-accessors    class (class-direct-slots class)))
 568
 569 (defmethod reinitialize-instance :after ((class slot-class)
 570                                          &rest initargs
 571                                          &key)
 572   (map-dependents class
 573                   (lambda (dependent)
 574                     (apply #'update-dependent class dependent initargs))))
 575
 576 (defmethod shared-initialize :after ((class condition-class) slot-names
 577                                      &key direct-slots direct-superclasses)
 578   (declare (ignore slot-names))
 579   (let ((classoid (find-classoid (class-name class))))
 580     (with-slots (wrapper class-precedence-list prototype predicate-name
 581                          (direct-supers direct-superclasses))
 582         class
 583       (setf (slot-value class 'direct-slots)
 584             (mapcar (lambda (pl) (make-direct-slotd class pl))
 585                     direct-slots))
 586       (setf (slot-value class 'finalized-p) t)
 587       (setf (classoid-pcl-class classoid) class)
 588       (setq direct-supers direct-superclasses)
 589       (setq wrapper (classoid-layout classoid))
 590       (setq class-precedence-list (compute-class-precedence-list class))
 591       (setq prototype (make-condition (class-name class)))
 592       (add-direct-subclasses class direct-superclasses)
 593       (setq predicate-name (make-class-predicate-name (class-name class)))
 594       (make-class-predicate class predicate-name)
 595       (setf (slot-value class 'slots) (compute-slots class))))
 596   ;; Comment from Gerd's PCL, 2003-05-15:
 597   ;;
 598   ;; We don't ADD-SLOT-ACCESSORS here because we don't want to
 599   ;; override condition accessors with generic functions.  We do this
 600   ;; differently.
 601   (update-pv-table-cache-info class))
 602
 603 (defmethod direct-slot-definition-class ((class condition-class)
 604                                          &rest initargs)
 605   (declare (ignore initargs))
 606   (find-class 'condition-direct-slot-definition))
 607
 608 (defmethod effective-slot-definition-class ((class condition-class)
 609                                             &rest initargs)
 610   (declare (ignore initargs))
 611   (find-class 'condition-effective-slot-definition))
 612
 613 (defmethod finalize-inheritance ((class condition-class))
 614   (aver (slot-value class 'finalized-p))
 615   nil)
 616
 617 (defmethod compute-effective-slot-definition
 618     ((class condition-class) slot-name dslotds)
 619   (let ((slotd (call-next-method)))
 620     (setf (slot-definition-reader-function slotd)
 621           (lambda (x)
 622             (handler-case (condition-reader-function x slot-name)
 623               ;; FIXME: FIND-SLOT-DEFAULT throws an error if the slot
 624               ;; is unbound; maybe it should be a CELL-ERROR of some
 625               ;; sort?
 626               (error () (values (slot-unbound class x slot-name))))))
 627     (setf (slot-definition-writer-function slotd)
 628           (lambda (v x)
 629             (condition-writer-function x v slot-name)))
 630     (setf (slot-definition-boundp-function slotd)
 631           (lambda (x)
 632             (multiple-value-bind (v c)
 633                 (ignore-errors (condition-reader-function x slot-name))
 634               (declare (ignore v))
 635               (null c))))
 636     slotd))
 637
 638 (defmethod compute-slots ((class condition-class))
 639   (mapcan (lambda (superclass)
 640             (mapcar (lambda (dslotd)
 641                       (compute-effective-slot-definition
 642                        class (slot-definition-name dslotd) (list dslotd)))
 643                     (class-direct-slots superclass)))
 644           (reverse (slot-value class 'class-precedence-list))))
 645
 646 (defmethod compute-slots :around ((class condition-class))
 647   (let ((eslotds (call-next-method)))
 648     (mapc #'initialize-internal-slot-functions eslotds)
 649     eslotds))
 650
 651 (defmethod shared-initialize :after
 652     ((slotd structure-slot-definition) slot-names &key
 653      (allocation :instance) allocation-class)
 654   (declare (ignore slot-names allocation-class))
 655   (unless (eq allocation :instance)
 656     (error "Structure slots must have :INSTANCE allocation.")))
 657
 658 (defun make-structure-class-defstruct-form (name direct-slots include)
 659   (let* ((conc-name (format-symbol *package* "~S structure class " name))
 660          (constructor (format-symbol *package* "~Aconstructor" conc-name))
 661          (defstruct `(defstruct (,name
 662                                  ,@(when include
 663                                          `((:include ,(class-name include))))
 664                                  (:predicate nil)
 665                                  (:conc-name ,conc-name)
 666                                  (:constructor ,constructor ())
 667                                  (:copier nil))
 668                       ,@(mapcar (lambda (slot)
 669                                   `(,(slot-definition-name slot)
 670                                     +slot-unbound+))
 671                                 direct-slots)))
 672          (reader-names (mapcar (lambda (slotd)
 673                                  (list 'slot-accessor name
 674                                        (slot-definition-name slotd)
 675                                        'reader))
 676                                direct-slots))
 677          (writer-names (mapcar (lambda (slotd)
 678                                  (list 'slot-accessor name
 679                                        (slot-definition-name slotd)
 680                                        'writer))
 681                                direct-slots))
 682          (readers-init
 683            (mapcar (lambda (slotd reader-name)
 684                      (let ((accessor
 685                              (slot-definition-defstruct-accessor-symbol
 686                               slotd)))
 687                        `(defun ,reader-name (obj)
 688                          (declare (type ,name obj))
 689                          (,accessor obj))))
 690                    direct-slots reader-names))
 691          (writers-init
 692            (mapcar (lambda (slotd writer-name)
 693                      (let ((accessor
 694                              (slot-definition-defstruct-accessor-symbol
 695                               slotd)))
 696                        `(defun ,writer-name (nv obj)
 697                          (declare (type ,name obj))
 698                          (setf (,accessor obj) nv))))
 699                    direct-slots writer-names))
 700          (defstruct-form
 701              `(progn
 702                ,defstruct
 703                ,@readers-init ,@writers-init
 704                (cons nil nil))))
 705     (values defstruct-form constructor reader-names writer-names)))
 706
 707 (defun make-defstruct-allocation-function (class)
 708   (let ((dd (get-structure-dd (class-name class))))
 709     (lambda ()
 710       (let ((instance (%make-instance (dd-length dd)))
 711             (raw-index (dd-raw-index dd)))
 712         (setf (%instance-layout instance)
 713               (sb-kernel::compiler-layout-or-lose (dd-name dd)))
 714         (when raw-index
 715           (setf (%instance-ref instance raw-index)
 716                 (make-array (dd-raw-length dd)
 717                             :element-type '(unsigned-byte 32))))
 718         instance))))
 719
 720 (defmethod shared-initialize :after
 721       ((class structure-class)
 722        slot-names
 723        &key (direct-superclasses nil direct-superclasses-p)
 724             (direct-slots nil direct-slots-p)
 725             direct-default-initargs
 726             (predicate-name nil predicate-name-p))
 727   (declare (ignore slot-names direct-default-initargs))
 728   (if direct-superclasses-p
 729       (setf (slot-value class 'direct-superclasses)
 730             (or direct-superclasses
 731                 (setq direct-superclasses
 732                       (and (not (eq (class-name class) 'structure-object))
 733                            (list *the-class-structure-object*)))))
 734       (setq direct-superclasses (slot-value class 'direct-superclasses)))
 735   (let* ((name (class-name class))
 736          (from-defclass-p (slot-value class 'from-defclass-p))
 737          (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
 738     (if direct-slots-p
 739         (setf (slot-value class 'direct-slots)
 740               (setq direct-slots
 741                     (mapcar (lambda (pl)
 742                               (when defstruct-p
 743                                 (let* ((slot-name (getf pl :name))
 744                                        (accessor
 745                                         (format-symbol *package*
 746                                                        "~S structure class ~A"
 747                                                        name slot-name)))
 748                                   (setq pl (list* :defstruct-accessor-symbol
 749                                                   accessor pl))))
 750                               (make-direct-slotd class pl))
 751                             direct-slots)))
 752         (setq direct-slots (slot-value class 'direct-slots)))
 753     (if defstruct-p
 754         (let ((include (car (slot-value class 'direct-superclasses))))
 755           (multiple-value-bind (defstruct-form constructor reader-names writer-names)
 756               (make-structure-class-defstruct-form name direct-slots include)
 757             (unless (structure-type-p name) (eval defstruct-form))
 758             (mapc (lambda (dslotd reader-name writer-name)
 759                     (let* ((reader (gdefinition reader-name))
 760                            (writer (when (gboundp writer-name)
 761                                      (gdefinition writer-name))))
 762                       (setf (slot-value dslotd 'internal-reader-function)
 763                             reader)
 764                       (setf (slot-value dslotd 'internal-writer-function)
 765                             writer)))
 766                   direct-slots reader-names writer-names)
 767             (setf (slot-value class 'defstruct-form) defstruct-form)
 768             (setf (slot-value class 'defstruct-constructor) constructor)))
 769         (setf (slot-value class 'defstruct-constructor)
 770               (make-defstruct-allocation-function class)))
 771     (add-direct-subclasses class direct-superclasses)
 772     (setf (slot-value class 'class-precedence-list)
 773             (compute-class-precedence-list class))
 774     (setf (slot-value class 'slots) (compute-slots class))
 775     (let ((lclass (find-classoid (class-name class))))
 776       (setf (classoid-pcl-class lclass) class)
 777       (setf (slot-value class 'wrapper) (classoid-layout lclass)))
 778     (setf (slot-value class 'finalized-p) t)
 779     (update-pv-table-cache-info class)
 780     (setq predicate-name (if predicate-name-p
 781                            (setf (slot-value class 'predicate-name)
 782                                    (car predicate-name))
 783                            (or (slot-value class 'predicate-name)
 784                                (setf (slot-value class 'predicate-name)
 785                                        (make-class-predicate-name
 786                                         (class-name class))))))
 787     (make-class-predicate class predicate-name)
 788     (add-slot-accessors class direct-slots)))
 789
 790 (defmethod direct-slot-definition-class ((class structure-class) &rest initargs)
 791   (declare (ignore initargs))
 792   (find-class 'structure-direct-slot-definition))
 793
 794 (defmethod finalize-inheritance ((class structure-class))
 795   nil) ; always finalized
 796 \f
 797 (defun add-slot-accessors (class dslotds)
 798   (fix-slot-accessors class dslotds 'add))
 799
 800 (defun remove-slot-accessors (class dslotds)
 801   (fix-slot-accessors class dslotds 'remove))
 802
 803 (defun fix-slot-accessors (class dslotds add/remove)
 804   ;; We disable package locks here, since defining a class can trigger
 805   ;; the update of the accessors of another class -- which might lead
 806   ;; to package lock violations if we didn't.
 807   (without-package-locks
 808       (flet ((fix (gfspec name r/w)
 809                (let* ((ll (case r/w (r '(object)) (w '(new-value object))))
 810                       (gf (if (fboundp gfspec)
 811                               (ensure-generic-function gfspec)
 812                               (ensure-generic-function gfspec :lambda-list ll))))
 813                  (case r/w
 814                    (r (if (eq add/remove 'add)
 815                           (add-reader-method class gf name)
 816                           (remove-reader-method class gf)))
 817                    (w (if (eq add/remove 'add)
 818                           (add-writer-method class gf name)
 819                           (remove-writer-method class gf)))))))
 820         (dolist (dslotd dslotds)
 821           (let ((slot-name (slot-definition-name dslotd)))
 822             (dolist (r (slot-definition-readers dslotd))
 823               (fix r slot-name 'r))
 824             (dolist (w (slot-definition-writers dslotd))
 825               (fix w slot-name 'w)))))))
 826 \f
 827 (defun add-direct-subclasses (class supers)
 828   (dolist (super supers)
 829     (unless (memq class (class-direct-subclasses class))
 830       (add-direct-subclass super class))))
 831
 832 (defun remove-direct-subclasses (class supers)
 833   (let ((old (class-direct-superclasses class)))
 834     (dolist (o (set-difference old supers))
 835       (remove-direct-subclass o class))))
 836 \f
 837 (defmethod finalize-inheritance ((class std-class))
 838   (update-class class t))
 839
 840 (defmethod finalize-inheritance ((class forward-referenced-class))
 841   ;; FIXME: should we not be thinking a bit about what kinds of error
 842   ;; we're throwing?  Maybe we need a clos-error type to mix in?  Or
 843   ;; possibly a forward-referenced-class-error, though that's
 844   ;; difficult given e.g. class precedence list calculations...
 845   (error
 846    "~@<FINALIZE-INHERITANCE was called on a forward referenced class:~
 847        ~2I~_~S~:>"
 848    class))
 849
 850 \f
 851 (defun class-has-a-forward-referenced-superclass-p (class)
 852   (or (forward-referenced-class-p class)
 853       (some #'class-has-a-forward-referenced-superclass-p
 854             (class-direct-superclasses class))))
 855
 856 ;;; This is called by :after shared-initialize whenever a class is initialized
 857 ;;; or reinitialized. The class may or may not be finalized.
 858 (defun update-class (class finalizep)
 859   ;; Comment from Gerd Moellmann:
 860   ;;
 861   ;; Note that we can't simply delay the finalization when CLASS has
 862   ;; no forward referenced superclasses because that causes bootstrap
 863   ;; problems.
 864   (without-package-locks
 865    (when (and (not finalizep)
 866               (not (class-finalized-p class))
 867               (not (class-has-a-forward-referenced-superclass-p class)))
 868      (finalize-inheritance class)
 869      (return-from update-class))
 870    (when (or finalizep (class-finalized-p class)
 871              (not (class-has-a-forward-referenced-superclass-p class)))
 872      (setf (find-class (class-name class)) class)
 873      (update-cpl class (compute-class-precedence-list class))
 874      ;; This invocation of UPDATE-SLOTS, in practice, finalizes the
 875      ;; class.  The hoops above are to ensure that FINALIZE-INHERITANCE
 876     ;; is called at finalization, so that MOP programmers can hook
 877      ;; into the system as described in "Class Finalization Protocol"
 878      ;; (section 5.5.2 of AMOP).
 879      (update-slots class (compute-slots class))
 880      (update-gfs-of-class class)
 881      (update-initargs class (compute-default-initargs class))
 882      (update-ctors 'finalize-inheritance :class class))
 883    (unless finalizep
 884      (dolist (sub (class-direct-subclasses class)) (update-class sub nil)))))
 885
 886 (defun update-cpl (class cpl)
 887   (if (class-finalized-p class)
 888       (unless (and (equal (class-precedence-list class) cpl)
 889                    (dolist (c cpl t)
 890                      (when (position :class (class-direct-slots c)
 891                                      :key #'slot-definition-allocation)
 892                        (return nil))))
 893         ;; comment from the old CMU CL sources:
 894         ;;   Need to have the cpl setup before update-lisp-class-layout
 895         ;;   is called on CMU CL.
 896         (setf (slot-value class 'class-precedence-list) cpl)
 897         (force-cache-flushes class))
 898       (setf (slot-value class 'class-precedence-list) cpl))
 899   (update-class-can-precede-p cpl))
 900
 901 (defun update-class-can-precede-p (cpl)
 902   (when cpl
 903     (let ((first (car cpl)))
 904       (dolist (c (cdr cpl))
 905         (pushnew c (slot-value first 'can-precede-list))))
 906     (update-class-can-precede-p (cdr cpl))))
 907
 908 (defun class-can-precede-p (class1 class2)
 909   (member class2 (class-can-precede-list class1)))
 910
 911 (defun update-slots (class eslotds)
 912   (let ((instance-slots ())
 913         (class-slots    ()))
 914     (dolist (eslotd eslotds)
 915       (let ((alloc (slot-definition-allocation eslotd)))
 916         (case alloc
 917           (:instance (push eslotd instance-slots))
 918           (:class (push eslotd class-slots)))))
 919
 920     ;; If there is a change in the shape of the instances then the
 921     ;; old class is now obsolete.
 922     (let* ((nlayout (mapcar #'slot-definition-name
 923                             (sort instance-slots #'<
 924                                   :key #'slot-definition-location)))
 925            (nslots (length nlayout))
 926            (nwrapper-class-slots (compute-class-slots class-slots))
 927            (owrapper (when (class-finalized-p class)
 928                        (class-wrapper class)))
 929            (olayout (when owrapper
 930                       (wrapper-instance-slots-layout owrapper)))
 931            (owrapper-class-slots (and owrapper (wrapper-class-slots owrapper)))
 932            (nwrapper
 933             (cond ((null owrapper)
 934                    (make-wrapper nslots class))
 935                   ((and (equal nlayout olayout)
 936                         (not
 937                          (loop for o in owrapper-class-slots
 938                                for n in nwrapper-class-slots
 939                                do (unless (eq (car o) (car n)) (return t)))))
 940                    owrapper)
 941                   (t
 942                    ;; This will initialize the new wrapper to have the
 943                    ;; same state as the old wrapper. We will then have
 944                    ;; to change that. This may seem like wasted work
 945                    ;; (and it is), but the spec requires that we call
 946                    ;; MAKE-INSTANCES-OBSOLETE.
 947                    (make-instances-obsolete class)
 948                    (class-wrapper class)))))
 949
 950       (with-slots (wrapper slots) class
 951         (update-lisp-class-layout class nwrapper)
 952         (setf slots eslotds
 953               (wrapper-instance-slots-layout nwrapper) nlayout
 954               (wrapper-class-slots nwrapper) nwrapper-class-slots
 955               (wrapper-no-of-instance-slots nwrapper) nslots
 956               wrapper nwrapper))
 957       (setf (slot-value class 'finalized-p) t)
 958       (unless (eq owrapper nwrapper)
 959         (update-pv-table-cache-info class)
 960         (maybe-update-standard-class-locations class)))))
 961
 962 (defun compute-class-slots (eslotds)
 963   (let (collect)
 964     (dolist (eslotd eslotds)
 965       (push (assoc (slot-definition-name eslotd)
 966                    (class-slot-cells (slot-definition-class eslotd)))
 967             collect))
 968     (nreverse collect)))
 969
 970 (defun update-gfs-of-class (class)
 971   (when (and (class-finalized-p class)
 972              (let ((cpl (class-precedence-list class)))
 973                (or (member *the-class-slot-class* cpl)
 974                    (member *the-class-standard-effective-slot-definition*
 975                            cpl))))
 976     (let ((gf-table (make-hash-table :test 'eq)))
 977       (labels ((collect-gfs (class)
 978                  (dolist (gf (specializer-direct-generic-functions class))
 979                    (setf (gethash gf gf-table) t))
 980                  (mapc #'collect-gfs (class-direct-superclasses class))))
 981         (collect-gfs class)
 982         (maphash (lambda (gf ignore)
 983                    (declare (ignore ignore))
 984                    (update-gf-dfun class gf))
 985                  gf-table)))))
 986
 987 (defun update-initargs (class inits)
 988   (setf (plist-value class 'default-initargs) inits))
 989 \f
 990 (defmethod compute-default-initargs ((class slot-class))
 991   (let ((initargs (loop for c in (class-precedence-list class)
 992                         append (class-direct-default-initargs c))))
 993     (delete-duplicates initargs :test #'eq :key #'car :from-end t)))
 994 \f
 995 ;;;; protocols for constructing direct and effective slot definitions
 996
 997 (defmethod direct-slot-definition-class ((class std-class) &rest initargs)
 998   (declare (ignore initargs))
 999   (find-class 'standard-direct-slot-definition))
1000
1001 (defun make-direct-slotd (class initargs)
1002   (let ((initargs (list* :class class initargs)))
1003     (apply #'make-instance
1004            (apply #'direct-slot-definition-class class initargs)
1005            initargs)))
1006
1007 (defmethod compute-slots ((class std-class))
1008   ;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
1009   ;; for each different slot name we find in our superclasses. Each
1010   ;; call receives the class and a list of the dslotds with that name.
1011   ;; The list is in most-specific-first order.
1012   (let ((name-dslotds-alist ()))
1013     (dolist (c (class-precedence-list class))
1014       (dolist (slot (class-direct-slots c))
1015         (let* ((name (slot-definition-name slot))
1016                (entry (assq name name-dslotds-alist)))
1017           (if entry
1018               (push slot (cdr entry))
1019               (push (list name slot) name-dslotds-alist)))))
1020     (mapcar (lambda (direct)
1021               (compute-effective-slot-definition class
1022                                                  (car direct)
1023                                                  (nreverse (cdr direct))))
1024             name-dslotds-alist)))
1025
1026 (defmethod compute-slots ((class standard-class))
1027   (call-next-method))
1028
1029 (defmethod compute-slots :around ((class standard-class))
1030   (let ((eslotds (call-next-method))
1031         (location -1))
1032     (dolist (eslotd eslotds eslotds)
1033       (setf (slot-definition-location eslotd)
1034             (ecase (slot-definition-allocation eslotd)
1035               (:instance
1036                (incf location))
1037               (:class
1038                (let* ((name (slot-definition-name eslotd))
1039                       (from-class (slot-definition-allocation-class eslotd))
1040                       (cell (assq name (class-slot-cells from-class))))
1041                  (aver (consp cell))
1042                  (if (eq +slot-unbound+ (cdr cell))
1043                      ;; We may have inherited an initfunction
1044                      (let ((initfun (slot-definition-initfunction eslotd)))
1045                        (if initfun
1046                            (rplacd cell (funcall initfun))
1047                            cell))
1048                      cell)))))
1049       (initialize-internal-slot-functions eslotd))))
1050
1051 (defmethod compute-slots ((class funcallable-standard-class))
1052   (call-next-method))
1053
1054 (defmethod compute-slots :around ((class funcallable-standard-class))
1055   (labels ((instance-slot-names (slotds)
1056              (let (collect)
1057                (dolist (slotd slotds (nreverse collect))
1058                  (when (eq (slot-definition-allocation slotd) :instance)
1059                    (push (slot-definition-name slotd) collect)))))
1060            ;; This sorts slots so that slots of classes later in the CPL
1061            ;; come before slots of other classes.  This is crucial for
1062            ;; funcallable instances because it ensures that the slots of
1063            ;; FUNCALLABLE-STANDARD-OBJECT, which includes the slots of
1064            ;; KERNEL:FUNCALLABLE-INSTANCE, come first, which in turn
1065            ;; makes it possible to treat FUNCALLABLE-STANDARD-OBJECT as
1066            ;; a funcallable instance.
1067            (compute-layout (eslotds)
1068              (let ((first ())
1069                    (names (instance-slot-names eslotds)))
1070                (dolist (class
1071                         (reverse (class-precedence-list class))
1072                         (nreverse (nconc names first)))
1073                  (dolist (ss (class-slots class))
1074                    (let ((name (slot-definition-name ss)))
1075                      (when (member name names)
1076                        (push name first)
1077                        (setq names (delete name names)))))))))
1078     (let ((all-slotds (call-next-method))
1079           (instance-slots ())
1080           (class-slots ()))
1081       (dolist (slotd all-slotds)
1082         (ecase (slot-definition-allocation slotd)
1083           (:instance (push slotd instance-slots))
1084           (:class (push slotd class-slots))))
1085       (let ((layout (compute-layout instance-slots)))
1086         (dolist (slotd instance-slots)
1087           (setf (slot-definition-location slotd)
1088                 (position (slot-definition-name slotd) layout))
1089           (initialize-internal-slot-functions slotd)))
1090       (dolist (slotd class-slots)
1091         (let ((name (slot-definition-name slotd))
1092               (from-class (slot-definition-allocation-class slotd)))
1093           (setf (slot-definition-location slotd)
1094                 (assoc name (class-slot-cells from-class)))
1095           (aver (consp (slot-definition-location slotd)))
1096           (initialize-internal-slot-functions slotd)))
1097       all-slotds)))
1098
1099 (defmethod compute-slots ((class structure-class))
1100   (mapcan (lambda (superclass)
1101             (mapcar (lambda (dslotd)
1102                       (compute-effective-slot-definition
1103                        class
1104                        (slot-definition-name dslotd)
1105                        (list dslotd)))
1106                     (class-direct-slots superclass)))
1107           (reverse (slot-value class 'class-precedence-list))))
1108
1109 (defmethod compute-slots :around ((class structure-class))
1110   (let ((eslotds (call-next-method)))
1111     (mapc #'initialize-internal-slot-functions eslotds)
1112     eslotds))
1113
1114 (defmethod compute-effective-slot-definition ((class slot-class) name dslotds)
1115   (declare (ignore name))
1116   (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
1117          (class (apply #'effective-slot-definition-class class initargs)))
1118     (apply #'make-instance class initargs)))
1119
1120 (defmethod effective-slot-definition-class ((class std-class) &rest initargs)
1121   (declare (ignore initargs))
1122   (find-class 'standard-effective-slot-definition))
1123
1124 (defmethod effective-slot-definition-class ((class structure-class) &rest initargs)
1125   (declare (ignore initargs))
1126   (find-class 'structure-effective-slot-definition))
1127
1128 (defmethod compute-effective-slot-definition-initargs
1129     ((class slot-class) direct-slotds)
1130   (let* ((name nil)
1131          (initfunction nil)
1132          (initform nil)
1133          (initargs nil)
1134          (allocation nil)
1135          (allocation-class nil)
1136          (type t)
1137          (namep  nil)
1138          (initp  nil)
1139          (allocp nil))
1140
1141     (dolist (slotd direct-slotds)
1142       (when slotd
1143         (unless namep
1144           (setq name (slot-definition-name slotd)
1145                 namep t))
1146         (unless initp
1147           (when (slot-definition-initfunction slotd)
1148             (setq initform (slot-definition-initform slotd)
1149                   initfunction (slot-definition-initfunction slotd)
1150                   initp t)))
1151         (unless allocp
1152           (setq allocation (slot-definition-allocation slotd)
1153                 allocation-class (slot-definition-class slotd)
1154                 allocp t))
1155         (setq initargs (append (slot-definition-initargs slotd) initargs))
1156         (let ((slotd-type (slot-definition-type slotd)))
1157           (setq type (cond ((eq type t) slotd-type)
1158                            ((*subtypep type slotd-type) type)
1159                            (t `(and ,type ,slotd-type)))))))
1160     (list :name name
1161           :initform initform
1162           :initfunction initfunction
1163           :initargs initargs
1164           :allocation allocation
1165           :allocation-class allocation-class
1166           :type type
1167           :class class)))
1168
1169 (defmethod compute-effective-slot-definition-initargs :around
1170     ((class structure-class) direct-slotds)
1171   (let ((slotd (car direct-slotds)))
1172     (list* :defstruct-accessor-symbol
1173            (slot-definition-defstruct-accessor-symbol slotd)
1174            :internal-reader-function
1175            (slot-definition-internal-reader-function slotd)
1176            :internal-writer-function
1177            (slot-definition-internal-writer-function slotd)
1178            (call-next-method))))
1179 \f
1180 ;;; NOTE: For bootstrapping considerations, these can't use MAKE-INSTANCE
1181 ;;;       to make the method object. They have to use make-a-method which
1182 ;;;       is a specially bootstrapped mechanism for making standard methods.
1183 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
1184   (declare (ignore direct-slot initargs))
1185   (find-class 'standard-reader-method))
1186
1187 (defmethod add-reader-method ((class slot-class) generic-function slot-name)
1188   (add-method generic-function
1189               (make-a-method 'standard-reader-method
1190                              ()
1191                              (list (or (class-name class) 'object))
1192                              (list class)
1193                              (make-reader-method-function class slot-name)
1194                              "automatically generated reader method"
1195                              slot-name)))
1196
1197 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
1198   (declare (ignore direct-slot initargs))
1199   (find-class 'standard-writer-method))
1200
1201 (defmethod add-writer-method ((class slot-class) generic-function slot-name)
1202   (add-method generic-function
1203               (make-a-method 'standard-writer-method
1204                              ()
1205                              (list 'new-value (or (class-name class) 'object))
1206                              (list *the-class-t* class)
1207                              (make-writer-method-function class slot-name)
1208                              "automatically generated writer method"
1209                              slot-name)))
1210
1211 (defmethod add-boundp-method ((class slot-class) generic-function slot-name)
1212   (add-method generic-function
1213               (make-a-method 'standard-boundp-method
1214                              ()
1215                              (list (or (class-name class) 'object))
1216                              (list class)
1217                              (make-boundp-method-function class slot-name)
1218                              "automatically generated boundp method"
1219                              slot-name)))
1220
1221 (defmethod remove-reader-method ((class slot-class) generic-function)
1222   (let ((method (get-method generic-function () (list class) nil)))
1223     (when method (remove-method generic-function method))))
1224
1225 (defmethod remove-writer-method ((class slot-class) generic-function)
1226   (let ((method
1227           (get-method generic-function () (list *the-class-t* class) nil)))
1228     (when method (remove-method generic-function method))))
1229
1230 (defmethod remove-boundp-method ((class slot-class) generic-function)
1231   (let ((method (get-method generic-function () (list class) nil)))
1232     (when method (remove-method generic-function method))))
1233 \f
1234 ;;; MAKE-READER-METHOD-FUNCTION and MAKE-WRITE-METHOD function are NOT
1235 ;;; part of the standard protocol. They are however useful, PCL makes
1236 ;;; use of them internally and documents them for PCL users.
1237 ;;;
1238 ;;; *** This needs work to make type testing by the writer functions which
1239 ;;; *** do type testing faster. The idea would be to have one constructor
1240 ;;; *** for each possible type test.
1241 ;;;
1242 ;;; *** There is a subtle bug here which is going to have to be fixed.
1243 ;;; *** Namely, the simplistic use of the template has to be fixed. We
1244 ;;; *** have to give the OPTIMIZE-SLOT-VALUE method the user might have
1245 ;;; *** defined for this metaclass a chance to run.
1246
1247 (defmethod make-reader-method-function ((class slot-class) slot-name)
1248   (make-std-reader-method-function (class-name class) slot-name))
1249
1250 (defmethod make-writer-method-function ((class slot-class) slot-name)
1251   (make-std-writer-method-function (class-name class) slot-name))
1252
1253 (defmethod make-boundp-method-function ((class slot-class) slot-name)
1254   (make-std-boundp-method-function (class-name class) slot-name))
1255 \f
1256 (defmethod compatible-meta-class-change-p (class proto-new-class)
1257   (eq (class-of class) (class-of proto-new-class)))
1258
1259 (defmethod validate-superclass ((class class) (new-super class))
1260   (or (eq new-super *the-class-t*)
1261       (eq (class-of class) (class-of new-super))))
1262
1263 (defmethod validate-superclass ((class standard-class) (new-super std-class))
1264   (let ((new-super-meta-class (class-of new-super)))
1265     (or (eq new-super-meta-class *the-class-std-class*)
1266         (eq (class-of class) new-super-meta-class))))
1267 \f
1268 ;;; What this does depends on which of the four possible values of
1269 ;;; LAYOUT-INVALID the PCL wrapper has; the simplest case is when it
1270 ;;; is (:FLUSH <wrapper>) or (:OBSOLETE <wrapper>), when there is
1271 ;;; nothing to do, as the new wrapper has already been created.  If
1272 ;;; LAYOUT-INVALID returns NIL, then we invalidate it (setting it to
1273 ;;; (:FLUSH <wrapper>); UPDATE-SLOTS later gets to choose whether or
1274 ;;; not to "upgrade" this to (:OBSOLETE <wrapper>).
1275 ;;;
1276 ;;; This leaves the case where LAYOUT-INVALID returns T, which happens
1277 ;;; when REGISTER-LAYOUT has invalidated a superclass of CLASS (which
1278 ;;; invalidated all the subclasses in SB-KERNEL land).  Again, here we
1279 ;;; must flush the caches and allow UPDATE-SLOTS to decide whether to
1280 ;;; obsolete the wrapper.
1281 ;;;
1282 ;;; FIXME: either here or in INVALID-WRAPPER-P looks like a good place
1283 ;;; for (AVER (NOT (EQ (LAYOUT-INVALID OWRAPPER)
1284 ;;;                    :UNINITIALIZED)))
1285 ;;;
1286 ;;; Thanks to Gerd Moellmann for the explanation.  -- CSR, 2002-10-29
1287 (defun force-cache-flushes (class)
1288   (let* ((owrapper (class-wrapper class)))
1289     ;; We only need to do something if the wrapper is still valid. If
1290     ;; the wrapper isn't valid, state will be FLUSH or OBSOLETE, and
1291     ;; both of those will already be doing what we want. In
1292     ;; particular, we must be sure we never change an OBSOLETE into a
1293     ;; FLUSH since OBSOLETE means do what FLUSH does and then some.
1294     (when (or (not (invalid-wrapper-p owrapper))
1295               ;; KLUDGE: despite the observations above, this remains
1296               ;; a violation of locality or what might be considered
1297               ;; good style.  There has to be a better way!  -- CSR,
1298               ;; 2002-10-29
1299               (eq (layout-invalid owrapper) t))
1300       (let ((nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1301                                     class)))
1302         (setf (wrapper-instance-slots-layout nwrapper)
1303               (wrapper-instance-slots-layout owrapper))
1304         (setf (wrapper-class-slots nwrapper)
1305               (wrapper-class-slots owrapper))
1306         (with-pcl-lock
1307           (update-lisp-class-layout class nwrapper)
1308           (setf (slot-value class 'wrapper) nwrapper)
1309           ;; Use :OBSOLETE instead of :FLUSH if any superclass has
1310           ;; been obsoleted.
1311           (if (find-if (lambda (x)
1312                          (and (consp x) (eq :obsolete (car x))))
1313                        (layout-inherits owrapper)
1314                        :key #'layout-invalid)
1315               (invalidate-wrapper owrapper :obsolete nwrapper)
1316               (invalidate-wrapper owrapper :flush nwrapper)))))))
1317
1318 (defun flush-cache-trap (owrapper nwrapper instance)
1319   (declare (ignore owrapper))
1320   (set-wrapper instance nwrapper))
1321 \f
1322 ;;; MAKE-INSTANCES-OBSOLETE can be called by user code. It will cause
1323 ;;; the next access to the instance (as defined in 88-002R) to trap
1324 ;;; through the UPDATE-INSTANCE-FOR-REDEFINED-CLASS mechanism.
1325 (defmethod make-instances-obsolete ((class std-class))
1326   (let* ((owrapper (class-wrapper class))
1327          (nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1328                                  class)))
1329       (setf (wrapper-instance-slots-layout nwrapper)
1330             (wrapper-instance-slots-layout owrapper))
1331       (setf (wrapper-class-slots nwrapper)
1332             (wrapper-class-slots owrapper))
1333       (with-pcl-lock
1334         (update-lisp-class-layout class nwrapper)
1335         (setf (slot-value class 'wrapper) nwrapper)
1336         (invalidate-wrapper owrapper :obsolete nwrapper)
1337         class)))
1338
1339 (defmethod make-instances-obsolete ((class symbol))
1340   (make-instances-obsolete (find-class class))
1341   ;; ANSI wants the class name when called with a symbol.
1342   class)
1343
1344 ;;; OBSOLETE-INSTANCE-TRAP is the internal trap that is called when we
1345 ;;; see an obsolete instance. The times when it is called are:
1346 ;;;   - when the instance is involved in method lookup
1347 ;;;   - when attempting to access a slot of an instance
1348 ;;;
1349 ;;; It is not called by class-of, wrapper-of, or any of the low-level
1350 ;;; instance access macros.
1351 ;;;
1352 ;;; Of course these times when it is called are an internal
1353 ;;; implementation detail of PCL and are not part of the documented
1354 ;;; description of when the obsolete instance update happens. The
1355 ;;; documented description is as it appears in 88-002R.
1356 ;;;
1357 ;;; This has to return the new wrapper, so it counts on all the
1358 ;;; methods on obsolete-instance-trap-internal to return the new
1359 ;;; wrapper. It also does a little internal error checking to make
1360 ;;; sure that the traps are only happening when they should, and that
1361 ;;; the trap methods are computing appropriate new wrappers.
1362
1363 ;;; OBSOLETE-INSTANCE-TRAP might be called on structure instances
1364 ;;; after a structure is redefined. In most cases,
1365 ;;; OBSOLETE-INSTANCE-TRAP will not be able to fix the old instance,
1366 ;;; so it must signal an error. The hard part of this is that the
1367 ;;; error system and debugger might cause OBSOLETE-INSTANCE-TRAP to be
1368 ;;; called again, so in that case, we have to return some reasonable
1369 ;;; wrapper, instead.
1370
1371 (defvar *in-obsolete-instance-trap* nil)
1372 (defvar *the-wrapper-of-structure-object*
1373   (class-wrapper (find-class 'structure-object)))
1374
1375 (define-condition obsolete-structure (error)
1376   ((datum :reader obsolete-structure-datum :initarg :datum))
1377   (:report
1378    (lambda (condition stream)
1379      ;; Don't try to print the structure, since it probably won't work.
1380      (format stream
1381              "~@<obsolete structure error for a structure of type ~2I~_~S~:>"
1382              (type-of (obsolete-structure-datum condition))))))
1383
1384 (defun obsolete-instance-trap (owrapper nwrapper instance)
1385   (if (not (pcl-instance-p instance))
1386       (if *in-obsolete-instance-trap*
1387           *the-wrapper-of-structure-object*
1388            (let ((*in-obsolete-instance-trap* t))
1389              (error 'obsolete-structure :datum instance)))
1390       (let* ((class (wrapper-class* nwrapper))
1391              (copy (allocate-instance class)) ;??? allocate-instance ???
1392              (olayout (wrapper-instance-slots-layout owrapper))
1393              (nlayout (wrapper-instance-slots-layout nwrapper))
1394              (oslots (get-slots instance))
1395              (nslots (get-slots copy))
1396              (oclass-slots (wrapper-class-slots owrapper))
1397              (added ())
1398              (discarded ())
1399              (plist ()))
1400
1401         ;; local  --> local     transfer value
1402         ;; local  --> shared    discard value, discard slot
1403         ;; local  -->  --       discard slot
1404         ;; shared --> local     transfer value
1405         ;; shared --> shared    -- (cf SHARED-INITIALIZE :AFTER STD-CLASS)
1406         ;; shared -->  --       discard value
1407         ;;  --    --> local     add slot
1408         ;;  --    --> shared    --
1409
1410         ;; Collect class slots from inherited wrappers. Needed for
1411         ;; shared -> local transfers of inherited slots.
1412         (let ((inherited (layout-inherits owrapper)))
1413           (loop for i from (1- (length inherited)) downto 0
1414                 for layout = (aref inherited i)
1415                 when (typep layout 'wrapper)
1416                 do (dolist (slot (wrapper-class-slots layout))
1417                      (pushnew slot oclass-slots :key #'car))))
1418
1419         ;; Go through all the old local slots.
1420         (let ((opos 0))
1421           (dolist (name olayout)
1422             (let ((npos (posq name nlayout)))
1423               (if npos
1424                   (setf (clos-slots-ref nslots npos)
1425                         (clos-slots-ref oslots opos))
1426                   (progn
1427                     (push name discarded)
1428                     (unless (eq (clos-slots-ref oslots opos) +slot-unbound+)
1429                       (setf (getf plist name) (clos-slots-ref oslots opos))))))
1430             (incf opos)))
1431
1432         ;; Go through all the old shared slots.
1433         (dolist (oclass-slot-and-val oclass-slots)
1434           (let ((name (car oclass-slot-and-val))
1435                 (val (cdr oclass-slot-and-val)))
1436             (let ((npos (posq name nlayout)))
1437               (when npos
1438                 (setf (clos-slots-ref nslots npos) val)))))
1439
1440         ;; Go through all the new local slots to compute the added slots.
1441         (dolist (nlocal nlayout)
1442           (unless (or (memq nlocal olayout)
1443                       (assq nlocal oclass-slots))
1444             (push nlocal added)))
1445
1446         (swap-wrappers-and-slots instance copy)
1447
1448         (update-instance-for-redefined-class instance
1449                                              added
1450                                              discarded
1451                                              plist)
1452         nwrapper)))
1453 \f
1454 (defun change-class-internal (instance new-class initargs)
1455   (let* ((old-class (class-of instance))
1456          (copy (allocate-instance new-class))
1457          (new-wrapper (get-wrapper copy))
1458          (old-wrapper (class-wrapper old-class))
1459          (old-layout (wrapper-instance-slots-layout old-wrapper))
1460          (new-layout (wrapper-instance-slots-layout new-wrapper))
1461          (old-slots (get-slots instance))
1462          (new-slots (get-slots copy))
1463          (old-class-slots (wrapper-class-slots old-wrapper)))
1464
1465     ;; "The values of local slots specified by both the class CTO and
1466     ;; CFROM are retained. If such a local slot was unbound, it
1467     ;; remains unbound."
1468     (let ((new-position 0))
1469       (dolist (new-slot new-layout)
1470         (let ((old-position (posq new-slot old-layout)))
1471           (when old-position
1472             (setf (clos-slots-ref new-slots new-position)
1473                   (clos-slots-ref old-slots old-position))))
1474         (incf new-position)))
1475
1476     ;; "The values of slots specified as shared in the class CFROM and
1477     ;; as local in the class CTO are retained."
1478     (dolist (slot-and-val old-class-slots)
1479       (let ((position (posq (car slot-and-val) new-layout)))
1480         (when position
1481           (setf (clos-slots-ref new-slots position) (cdr slot-and-val)))))
1482
1483     ;; Make the copy point to the old instance's storage, and make the
1484     ;; old instance point to the new storage.
1485     (swap-wrappers-and-slots instance copy)
1486
1487     (apply #'update-instance-for-different-class copy instance initargs)
1488     instance))
1489
1490 (defmethod change-class ((instance standard-object)
1491                          (new-class standard-class)
1492                          &rest initargs)
1493   (change-class-internal instance new-class initargs))
1494
1495 (defmethod change-class ((instance funcallable-standard-object)
1496                          (new-class funcallable-standard-class)
1497                          &rest initargs)
1498   (change-class-internal instance new-class initargs))
1499
1500 (defmethod change-class ((instance standard-object)
1501                          (new-class funcallable-standard-class)
1502                          &rest initargs)
1503   (declare (ignore initargs))
1504   (error "You can't change the class of ~S to ~S~@
1505           because it isn't already an instance with metaclass ~S."
1506          instance new-class 'standard-class))
1507
1508 (defmethod change-class ((instance funcallable-standard-object)
1509                          (new-class standard-class)
1510                          &rest initargs)
1511   (declare (ignore initargs))
1512   (error "You can't change the class of ~S to ~S~@
1513           because it isn't already an instance with metaclass ~S."
1514          instance new-class 'funcallable-standard-class))
1515
1516 (defmethod change-class ((instance t) (new-class-name symbol) &rest initargs)
1517   (apply #'change-class instance (find-class new-class-name) initargs))
1518 \f
1519 ;;;; The metaclass BUILT-IN-CLASS
1520 ;;;;
1521 ;;;; This metaclass is something of a weird creature. By this point, all
1522 ;;;; instances of it which will exist have been created, and no instance
1523 ;;;; is ever created by calling MAKE-INSTANCE.
1524 ;;;;
1525 ;;;; But, there are other parts of the protocol we must follow and those
1526 ;;;; definitions appear here.
1527
1528 (defmethod shared-initialize :before
1529            ((class built-in-class) slot-names &rest initargs)
1530   (declare (ignore slot-names initargs))
1531   (error "attempt to initialize or reinitialize a built in class"))
1532
1533 (defmethod class-direct-slots       ((class built-in-class)) ())
1534 (defmethod class-slots             ((class built-in-class)) ())
1535 (defmethod class-direct-default-initargs ((class built-in-class)) ())
1536 (defmethod class-default-initargs       ((class built-in-class)) ())
1537
1538 (defmethod validate-superclass ((c class) (s built-in-class))
1539   (or (eq s *the-class-t*)
1540       (eq s *the-class-stream*)))
1541 \f
1542 ;;; Some necessary methods for FORWARD-REFERENCED-CLASS
1543 (defmethod class-direct-slots ((class forward-referenced-class)) ())
1544 (defmethod class-direct-default-initargs ((class forward-referenced-class)) ())
1545 (macrolet ((def (method)
1546              `(defmethod ,method ((class forward-referenced-class))
1547                 (error "~@<~I~S was called on a forward referenced class:~2I~_~S~:>"
1548                        ',method class))))
1549   (def class-default-initargs)
1550   (def class-precedence-list)
1551   (def class-slots))
1552
1553 (defmethod validate-superclass ((c slot-class)
1554                                 (f forward-referenced-class))
1555   t)
1556 \f
1557 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1558   (pushnew dependent (plist-value metaobject 'dependents)))
1559
1560 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1561   (setf (plist-value metaobject 'dependents)
1562         (delete dependent (plist-value metaobject 'dependents))))
1563
1564 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1565   (dolist (dependent (plist-value metaobject 'dependents))
1566     (funcall function dependent)))
1567