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