/[cmucl]/src/pcl/std-class.lisp
ViewVC logotype

Contents of /src/pcl/std-class.lisp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.59 - (show annotations)
Sat May 3 14:46:12 2003 UTC (10 years, 11 months ago) by gerd
Branch: MAIN
Changes since 1.58: +11 -14 lines
	Make slot locations more intuitive; preserve slot locations of
	inherited slots.  This partially a change from 2002-12-24 that
	made compute-slots compatible with SBCL.

	* src/pcl/std-class.lisp (compute-slots): Map over slots in
	reverse cpl order so that inherited slots are more likely to get
	the same locations as in superclasses.

	* src/pcl/rt/ctor.lisp: Tests changed accordingly.
1 ;;;-*-Mode:LISP; Package:PCL; Base:10; Syntax:Common-lisp -*-
2 ;;;
3 ;;; *************************************************************************
4 ;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
5 ;;; All rights reserved.
6 ;;;
7 ;;; Use and copying of this software and preparation of derivative works
8 ;;; based upon this software are permitted. Any distribution of this
9 ;;; software or derivative works must comply with all applicable United
10 ;;; States export control laws.
11 ;;;
12 ;;; This software is made available AS IS, and Xerox Corporation makes no
13 ;;; warranty about the software, its performance or its conformity to any
14 ;;; specification.
15 ;;;
16 ;;; Any person obtaining a copy of this software is requested to send their
17 ;;; name and post office or electronic mail address to:
18 ;;; CommonLoops Coordinator
19 ;;; Xerox PARC
20 ;;; 3333 Coyote Hill Rd.
21 ;;; Palo Alto, CA 94304
22 ;;; (or send Arpanet mail to CommonLoops-Coordinator.pa@Xerox.arpa)
23 ;;;
24 ;;; Suggestions, comments and requests for improvements are also welcome.
25 ;;; *************************************************************************
26 ;;;
27
28 (ext:file-comment
29 "$Header: /tiger/var/lib/cvsroots/cmucl/src/pcl/std-class.lisp,v 1.59 2003/05/03 14:46:12 gerd Exp $")
30
31 (in-package :pcl)
32
33 (defmethod slot-accessor-function ((slotd effective-slot-definition) type)
34 (ecase type
35 (reader (slot-definition-reader-function slotd))
36 (writer (slot-definition-writer-function slotd))
37 (boundp (slot-definition-boundp-function slotd))))
38
39 (defmethod (setf slot-accessor-function) (function
40 (slotd effective-slot-definition) type)
41 (ecase type
42 (reader (setf (slot-definition-reader-function slotd) function))
43 (writer (setf (slot-definition-writer-function slotd) function))
44 (boundp (setf (slot-definition-boundp-function slotd) function))))
45
46 (defconstant *slotd-reader-function-std-p* 1)
47 (defconstant *slotd-writer-function-std-p* 2)
48 (defconstant *slotd-boundp-function-std-p* 4)
49 (defconstant *slotd-all-function-std-p* 7)
50
51 (defmethod slot-accessor-std-p ((slotd effective-slot-definition) type)
52 (let ((flags (slot-value slotd 'accessor-flags)))
53 (declare (type fixnum flags))
54 (if (eq type 'all)
55 (eql *slotd-all-function-std-p* flags)
56 (let ((mask (ecase type
57 (reader *slotd-reader-function-std-p*)
58 (writer *slotd-writer-function-std-p*)
59 (boundp *slotd-boundp-function-std-p*))))
60 (declare (type fixnum mask))
61 (not (zerop (the fixnum (logand mask flags))))))))
62
63 (defmethod (setf slot-accessor-std-p) (value (slotd effective-slot-definition) type)
64 (let ((mask (ecase type
65 (reader *slotd-reader-function-std-p*)
66 (writer *slotd-writer-function-std-p*)
67 (boundp *slotd-boundp-function-std-p*)))
68 (flags (slot-value slotd 'accessor-flags)))
69 (declare (type fixnum mask flags))
70 (setf (slot-value slotd 'accessor-flags)
71 (if value
72 (the fixnum (logior mask flags))
73 (the fixnum (logand (the fixnum (lognot mask)) flags)))))
74 value)
75
76 (defmethod initialize-internal-slot-functions ((slotd effective-slot-definition))
77 (let* ((name (slot-value slotd 'name))
78 (class (slot-value slotd 'class)))
79 (let ((table (or (gethash name *name->class->slotd-table*)
80 (setf (gethash name *name->class->slotd-table*)
81 (make-hash-table :test 'eq :size 5)))))
82 (setf (gethash class table) slotd))
83 (dolist (type '(reader writer boundp))
84 (let* ((gf-name (ecase type
85 (reader 'slot-value-using-class)
86 (writer '(setf slot-value-using-class))
87 (boundp 'slot-boundp-using-class)))
88 (gf (gdefinition gf-name)))
89 (compute-slot-accessor-info slotd type gf)))
90 (initialize-internal-slot-gfs name)))
91
92 ;;;
93 ;;; Compute an effective method for SLOT-VALUE-USING-CLASS, (SETF
94 ;;; SLOT-VALUE-USING-CLASS) or SLOT-BOUNDP-USING-CLASS for reading/
95 ;;; writing/testing effective slot SLOTD.
96 ;;;
97 ;;; TYPE is one of the symbols READER, WRITER or BOUNDP, depending on
98 ;;; GF. Store the effective method in the effective slot definition
99 ;;; object itself; these GFs have special dispatch functions calling
100 ;;; effective methods directly retrieved from effective slot
101 ;;; definition objects, as an optimization.
102 ;;;
103 ;;; FIXME: Change the function name to COMPUTE-SVUC-SLOTD-FUNCTION,
104 ;;; or some such.
105 ;;;
106 (defmethod compute-slot-accessor-info ((slotd effective-slot-definition)
107 type gf)
108 (let* ((name (slot-value slotd 'name))
109 (class (slot-value slotd 'class))
110 (old-slotd (find-slot-definition class name))
111 (old-std-p (and old-slotd (slot-accessor-std-p old-slotd 'all))))
112 (multiple-value-bind (function std-p)
113 (if (eq *boot-state* 'complete)
114 (get-accessor-method-function gf type class slotd)
115 (get-optimized-std-accessor-method-function class slotd type))
116 (setf (slot-accessor-std-p slotd type) std-p)
117 (setf (slot-accessor-function slotd type) function))
118 (when (and old-slotd
119 (not (eq old-std-p (slot-accessor-std-p slotd 'all))))
120 (record-pv-update-info slotd))))
121
122 (defmethod slot-definition-allocation ((slotd structure-slot-definition))
123 :instance)
124
125
126
127 (defmethod shared-initialize :after ((object documentation-mixin)
128 slot-names
129 &key (documentation nil documentation-p))
130 (declare (ignore slot-names))
131 (when documentation-p
132 (setf (documentation object nil) documentation)))
133
134 (defmethod documentation (object doc-type)
135 (declare (ignore object doc-type))
136 nil)
137
138 (defmethod (setf documentation) (new-value object doc-type)
139 (declare (ignore new-value doc-type))
140 (error "~@<Can't change the documentation of ~S.~@:>" object))
141
142 (defmethod documentation ((object documentation-mixin) doc-type)
143 (declare (ignore doc-type))
144 (plist-value object 'documentation))
145
146 (defmethod (setf documentation) (new-value (object documentation-mixin) doc-type)
147 (declare (ignore doc-type))
148 (setf (plist-value object 'documentation) new-value))
149
150 (defmethod documentation ((slotd standard-slot-definition) doc-type)
151 (declare (ignore doc-type))
152 (slot-value slotd 'documentation))
153
154 (defmethod (setf documentation) (new-value (slotd standard-slot-definition) doc-type)
155 (declare (ignore doc-type))
156 (setf (slot-value slotd 'documentation) new-value))
157
158 (defmethod (setf documentation) (doc (gf generic-function) type)
159 (declare (ignore type))
160 (setf (ext:info function documentation (generic-function-name gf))
161 doc))
162
163
164 ;;;
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-constructors ((class slot-class))
187 (plist-value class 'constructors))
188
189 (defmethod class-slot-cells ((class std-class))
190 (plist-value class 'class-slot-cells))
191
192
193 ;;;
194 ;;; Class accessors that are even a little bit more complicated than those
195 ;;; above. These have a protocol for updating them, we must implement that
196 ;;; protocol.
197 ;;;
198
199 ;;;
200 ;;; Maintaining the direct subclasses backpointers. The update methods are
201 ;;; here, the values are read by an automatically generated reader method.
202 ;;;
203 (defmethod add-direct-subclass ((class class) (subclass class))
204 (check-seals class 'add-direct-subclass)
205 (with-slots (direct-subclasses) class
206 (pushnew subclass direct-subclasses)
207 subclass))
208
209 (defmethod remove-direct-subclass ((class class) (subclass class))
210 (check-seals class 'remove-direct-subclass)
211 (with-slots (direct-subclasses) class
212 (setq direct-subclasses (remove subclass direct-subclasses))
213 subclass))
214
215 ;;;
216 ;;; Maintaining the direct-methods and direct-generic-functions backpointers.
217 ;;;
218 ;;; There are four generic functions involved, each has one method for the
219 ;;; class case and another method for the damned EQL specializers. All of
220 ;;; these are specified methods and appear in their specified place in the
221 ;;; class graph.
222 ;;;
223 ;;; ADD-DIRECT-METHOD
224 ;;; REMOVE-DIRECT-METHOD
225 ;;; SPECIALIZER-DIRECT-METHODS
226 ;;; SPECIALIZER-DIRECT-GENERIC-FUNCTIONS
227 ;;;
228 ;;; In each case, we maintain one value which is a cons. The car is the list
229 ;;; methods. The cdr is a list of the generic functions. The cdr is always
230 ;;; computed lazily.
231 ;;;
232
233 (defmethod add-direct-method ((specializer class) (method method))
234 (with-slots (direct-methods) specializer
235 (setf (car direct-methods) (adjoin method (car direct-methods)) ;PUSH
236 (cdr direct-methods) ()))
237 method)
238
239 (defmethod remove-direct-method ((specializer class) (method method))
240 (with-slots (direct-methods) specializer
241 (setf (car direct-methods) (remove method (car direct-methods))
242 (cdr direct-methods) ()))
243 (remove-inline-access-method specializer method)
244 method)
245
246 (defmethod specializer-direct-methods ((specializer class))
247 (with-slots (direct-methods) specializer
248 (car direct-methods)))
249
250 (defmethod specializer-direct-generic-functions ((specializer class))
251 (with-slots (direct-methods) specializer
252 (or (cdr direct-methods)
253 (setf (cdr direct-methods)
254 (loop for method in (car direct-methods)
255 for generic-function = (method-generic-function method)
256 unless (member generic-function collected :test #'eq)
257 collect generic-function into collected
258 finally (return collected))))))
259
260
261 ;;;
262 ;;; This hash table is used to store the direct methods and direct generic
263 ;;; functions of EQL specializers. Each value in the table is the cons.
264 ;;;
265 (defvar *eql-specializer-methods* (make-hash-table :test 'eql))
266 (defvar *class-eq-specializer-methods* (make-hash-table :test 'eq))
267
268 (defmethod specializer-method-table ((specializer eql-specializer))
269 *eql-specializer-methods*)
270
271 (defmethod specializer-method-table ((specializer class-eq-specializer))
272 *class-eq-specializer-methods*)
273
274 (defmethod add-direct-method ((specializer specializer-with-object) (method method))
275 (let* ((object (specializer-object specializer))
276 (table (specializer-method-table specializer))
277 (entry (gethash object table)))
278 (unless entry
279 (setq entry
280 (setf (gethash object table)
281 (cons nil nil))))
282 (setf (car entry) (adjoin method (car entry))
283 (cdr entry) ())
284 method))
285
286 (defmethod remove-direct-method ((specializer specializer-with-object) (method method))
287 (let* ((object (specializer-object specializer))
288 (entry (gethash object (specializer-method-table specializer))))
289 (when entry
290 (setf (car entry) (remove method (car entry))
291 (cdr entry) ()))
292 method))
293
294 (defmethod specializer-direct-methods ((specializer specializer-with-object))
295 (car (gethash (specializer-object specializer)
296 (specializer-method-table specializer))))
297
298 (defmethod specializer-direct-generic-functions ((specializer specializer-with-object))
299 (let* ((object (specializer-object specializer))
300 (entry (gethash object (specializer-method-table specializer))))
301 (when entry
302 (or (cdr entry)
303 (setf (cdr entry)
304 (loop for method in (car entry)
305 for generic-function = (method-generic-function method)
306 unless (member generic-function collected :test #'eq)
307 collect generic-function into collected
308 finally (return collected)))))))
309
310 (defun map-specializers (function)
311 (map-all-classes (lambda (class)
312 (funcall function (class-eq-specializer class))
313 (funcall function class)))
314 (maphash (lambda (object methods)
315 (declare (ignore methods))
316 (intern-eql-specializer object))
317 *eql-specializer-methods*)
318 (maphash (lambda (object specl)
319 (declare (ignore object))
320 (funcall function specl))
321 *eql-specializer-table*)
322 nil)
323
324 (defun map-all-classes (function &optional (root t))
325 (let ((braid-p (memq *boot-state* '(braid complete)))
326 (root (if (symbolp root) (find-class root) root)))
327 (labels ((map-class (class)
328 (mapc #'map-class
329 (if braid-p
330 (class-direct-subclasses class)
331 (early-class-direct-subclasses class)))
332 (funcall function class)))
333 (map-class root))))
334
335 (defun map-all-generic-functions (function)
336 (let ((all-generic-functions (make-hash-table :test 'eq)))
337 (map-specializers (lambda (specl)
338 (dolist (gf (specializer-direct-generic-functions specl))
339 (unless (gethash gf all-generic-functions)
340 (setf (gethash gf all-generic-functions) t)
341 (funcall function gf))))))
342 nil)
343
344 (defmethod shared-initialize :after ((specl class-eq-specializer) slot-names &key)
345 (declare (ignore slot-names))
346 (setf (slot-value specl 'type) `(class-eq ,(specializer-class specl))))
347
348 (defmethod shared-initialize :after ((specl eql-specializer) slot-names &key)
349 (declare (ignore slot-names))
350 (setf (slot-value specl 'type) `(eql ,(specializer-object specl))))
351
352
353
354 (defun real-load-defclass (name metaclass-name supers slots other)
355 (apply #'ensure-class name :metaclass metaclass-name
356 :direct-superclasses supers
357 :direct-slots slots
358 :definition-source `((defclass ,name) ,*load-pathname*)
359 other))
360
361 (setf (gdefinition 'load-defclass) #'real-load-defclass)
362
363 (defun ensure-class (name &rest all)
364 (apply #'ensure-class-using-class (find-class name nil) name all))
365
366 (defmethod ensure-class-using-class ((class null) name &rest args &key)
367 (multiple-value-bind (meta initargs)
368 (ensure-class-values class args)
369 (inform-type-system-about-class (class-prototype meta) name)
370 (setf class (apply #'make-instance meta :name name initargs)
371 (find-class name) class)
372 (inform-type-system-about-class class name)
373 class))
374
375 (defmethod ensure-class-using-class ((class pcl-class) name &rest args &key)
376 (multiple-value-bind (meta initargs)
377 (ensure-class-values class args)
378 (unless (eq (class-of class) meta)
379 (apply #'change-class class meta initargs))
380 (apply #'reinitialize-instance class initargs)
381 (setf (find-class name) class)
382 (inform-type-system-about-class class name)
383 class))
384
385 (defmethod class-predicate-name ((class t))
386 'function-returning-nil)
387
388 (defun ensure-class-values (class args)
389 (let* ((initargs (copy-list args))
390 (unsupplied (list 1))
391 (supplied-meta (getf initargs :metaclass unsupplied))
392 (supplied-supers (getf initargs :direct-superclasses unsupplied))
393 (meta (cond ((neq supplied-meta unsupplied)
394 (find-class supplied-meta))
395 ((or (null class)
396 (forward-referenced-class-p class))
397 *the-class-standard-class*)
398 (t
399 (class-of class)))))
400 (flet ((fix-super (super)
401 (cond ((classp super)
402 super)
403 ((legal-class-name-p super)
404 (or (find-class super nil)
405 (make-instance 'forward-referenced-class
406 :name super)))
407 (t
408 (simple-program-error
409 "~@<~S is not a class or a legal class name.~@:>"
410 super)))))
411 ;;
412 ;; CLHS: signal PROGRAM-ERROR, if
413 ;; (a) there are any duplicate slot names
414 ;; (b) any of the slot options :ALLOCATION, :INITFORM, :TYPE, or
415 ;; :DOCUMENTATION appears more than one in a single slot description.
416 (loop for (slot . more) on (getf initargs :direct-slots)
417 for slot-name = (getf slot :name)
418 if (some (lambda (s) (eq slot-name (getf s :name))) more) do
419 (simple-program-error
420 "~@<More than one direct slot with name ~S.~@:>"
421 slot-name)
422 else do
423 (loop for (option value . more) on slot by #'cddr
424 if (and (member option '(:allocation :type :initform
425 :documentation))
426 (not (eq unsupplied
427 (getf more option unsupplied)))) do
428 (simple-program-error
429 "~@<Duplicate slot option ~S for slot ~S.~@:>"
430 option slot-name)
431 else if (and (eq option :readers)
432 (notevery #'symbolp value)) do
433 (simple-program-error
434 "~@<Slot ~S: slot reader names must be symbols.~@:>"
435 slot-name)
436 else if (and (eq option :initargs)
437 (notevery #'symbolp value)) do
438 (simple-program-error
439 "~@<Slot ~S: initarg names must be symbols.~@:>"
440 slot-name)))
441 ;;
442 ;; CLHS: signal PROGRAM-ERROR, if an initialization argument name
443 ;; appears more than once in :DEFAULT-INITARGS class option.
444 (loop for (initarg . more) on (getf initargs :direct-default-initargs)
445 for name = (car initarg)
446 when (some (lambda (a) (eq (car a) name)) more) do
447 (simple-program-error
448 "~@<Duplicate initialization argument ~
449 name ~S in ~s of class ~A.~@:>"
450 name :default-initargs class))
451 ;;
452 (loop for (arg value) on initargs by #'cddr
453 count (eq arg :metaclass) into metaclass
454 count (eq arg :direct-default-initargs) into default-initargs
455 when (or (> metaclass 1) (> default-initargs 1)) do
456 (simple-program-error
457 "~@<Class ~S: More than one ~S specified~@:>"
458 class (if (eq arg :direct-default-initargs)
459 :default-initargs arg)))
460 (remf initargs :metaclass)
461 (remf initargs :direct-superclasses)
462 ;;
463 (values meta
464 (nconc (when (neq supplied-supers unsupplied)
465 (list :direct-superclasses
466 (mapcar #'fix-super supplied-supers)))
467 initargs)))))
468
469
470 ;;;
471 ;;;
472 ;;;
473 (defmethod shared-initialize :after
474 ((class std-class)
475 slot-names
476 &key (direct-superclasses nil direct-superclasses-p)
477 (direct-slots nil direct-slots-p)
478 (direct-default-initargs nil direct-default-initargs-p)
479 (predicate-name nil predicate-name-p))
480 (declare (ignore slot-names))
481 (cond ((or direct-superclasses-p
482 (null (slot-value class 'direct-superclasses)))
483 (setq direct-superclasses
484 (or direct-superclasses
485 (list (if (funcallable-standard-class-p class)
486 *the-class-funcallable-standard-object*
487 *the-class-standard-object*))))
488 (dolist (superclass direct-superclasses)
489 (unless (validate-superclass class superclass)
490 (error "~@<The class ~S was specified as a ~
491 super-class of the class ~S, ~
492 but the meta-classes ~S and ~S are incompatible. ~
493 Define a method for ~S to avoid this error.~@:>"
494 superclass class (class-of superclass) (class-of class)
495 'validate-superclass)))
496 (setf (slot-value class 'direct-superclasses) direct-superclasses))
497 (t
498 (setq direct-superclasses (slot-value class 'direct-superclasses))))
499 (setq direct-slots
500 (if direct-slots-p
501 (setf (slot-value class 'direct-slots)
502 (mapcar (lambda (pl) (make-direct-slotd class pl))
503 direct-slots))
504 (slot-value class 'direct-slots)))
505 (if direct-default-initargs-p
506 (setf (plist-value class 'direct-default-initargs)
507 direct-default-initargs)
508 (setq direct-default-initargs
509 (plist-value class 'direct-default-initargs)))
510 ;;
511 ;; Initialize shared slots. A class may inherit initforms for
512 ;; shared slots from superclasses. Such initializations are
513 ;; done in UPDATE-CLASS-SLOT-VALUES.
514 (ext:collect ((cells))
515 (dolist (dslotd direct-slots)
516 (when (eq (slot-definition-allocation dslotd) :class)
517 (let ((initfn (slot-definition-initfunction dslotd)))
518 (cells (cons (slot-definition-name dslotd)
519 (if initfn
520 (funcall initfn)
521 +slot-unbound+))))))
522 (setf (plist-value class 'class-slot-cells) (cells)))
523 ;;
524 (setq predicate-name (if predicate-name-p
525 (setf (slot-value class 'predicate-name)
526 (car predicate-name))
527 (or (slot-value class 'predicate-name)
528 (setf (slot-value class 'predicate-name)
529 (make-class-predicate-name (class-name class))))))
530 (add-direct-subclasses class direct-superclasses)
531 (make-class-predicate class predicate-name)
532 (update-class class nil)
533 (add-slot-accessors class direct-slots)
534 (make-preliminary-layout class))
535
536 (defmethod shared-initialize :after ((class forward-referenced-class)
537 slot-names &key &allow-other-keys)
538 (declare (ignore slot-names))
539 (make-preliminary-layout class))
540
541 ;;;
542 ;;; Give CLASS a preliminary layout, if it doesn't have a layout
543 ;;; already. This is done to make CLASS known to the type system
544 ;;; before the class is finalized, and is a consequence of the class
545 ;;; schizophrenia we are suffering from.
546 ;;;
547 (defvar *allow-forward-referenced-classes-in-cpl-p* nil)
548
549 (defun make-preliminary-layout (class)
550 (flet ((compute-preliminary-cpl (root)
551 (let ((*allow-forward-referenced-classes-in-cpl-p* t))
552 (compute-class-precedence-list root))))
553 (unless (class-finalized-p class)
554 (let ((name (class-name class)))
555 (setf (find-class name) class)
556 (inform-type-system-about-class class name)
557 (let ((layout (make-wrapper 0 class))
558 (kernel-class (kernel::find-class name)))
559 (setf (kernel:layout-class layout) kernel-class)
560 (setf (kernel:%class-pcl-class kernel-class) class)
561 (setf (slot-value class 'wrapper) layout)
562 (let ((cpl (compute-preliminary-cpl class)))
563 (setf (kernel:layout-inherits layout)
564 (kernel:order-layout-inherits
565 (map 'simple-vector #'class-wrapper
566 (reverse (rest cpl))))))
567 (kernel:register-layout layout :invalidate t)
568 (setf (kernel:%class-layout kernel-class) layout)
569 (mapc #'make-preliminary-layout (class-direct-subclasses class)))))))
570
571 (defmethod shared-initialize :before ((class class) slot-names &key name)
572 (declare (ignore slot-names name))
573 (setf (slot-value class 'type) `(class ,class))
574 (setf (slot-value class 'class-eq-specializer)
575 (make-instance 'class-eq-specializer :class class)))
576
577 (defmethod reinitialize-instance :before ((class slot-class)
578 &key direct-superclasses)
579 (remove-direct-subclasses class direct-superclasses)
580 (remove-slot-accessors class (class-direct-slots class)))
581
582 (defmethod reinitialize-instance :after ((class slot-class)
583 &rest initargs
584 &key)
585 (map-dependents class
586 (lambda (dependent)
587 (apply #'update-dependent class dependent initargs))))
588
589 (defmethod shared-initialize :after
590 ((class structure-class)
591 slot-names
592 &key (direct-superclasses nil direct-superclasses-p)
593 (direct-slots nil direct-slots-p)
594 direct-default-initargs
595 (predicate-name nil predicate-name-p))
596 (declare (ignore slot-names direct-default-initargs))
597 (if direct-superclasses-p
598 (setf (slot-value class 'direct-superclasses)
599 (or direct-superclasses
600 (setq direct-superclasses
601 (and (not (eq (class-name class) 'structure-object))
602 (list *the-class-structure-object*)))))
603 (setq direct-superclasses (slot-value class 'direct-superclasses)))
604 (let* ((name (class-name class))
605 (from-defclass-p (slot-value class 'from-defclass-p))
606 (defstruct-p (or from-defclass-p (not (structure-type-p name)))))
607 (if direct-slots-p
608 (setf (slot-value class 'direct-slots)
609 (setq direct-slots
610 (mapcar (lambda (pl)
611 (when defstruct-p
612 (let* ((slot-name (getf pl :name))
613 (accessor
614 (symbolicate
615 *package*
616 (if (symbol-package name)
617 (package-name (symbol-package name))
618 "")
619 "::" name " structure class " slot-name)))
620 (setq pl (list* :defstruct-accessor-symbol accessor
621 pl))))
622 (make-direct-slotd class pl))
623 direct-slots)))
624 (setq direct-slots (slot-value class 'direct-slots)))
625 (if defstruct-p
626 (let* ((include (car (slot-value class 'direct-superclasses)))
627 (conc-name (symbolicate *package*
628 (if (symbol-package name)
629 (package-name (symbol-package name))
630 "")
631 "::" name " structure class "))
632 ;;
633 ;; It's not possible to use a generalized name for the
634 ;; constructor function. It shouldn't matter though, I think,
635 ;; like for the slot names above, because this stuff is not
636 ;; supposed to be used by users directly.
637 (constructor
638 (symbolicate *package* conc-name " constructor"))
639 (defstruct `(defstruct (,name
640 ,@(when include
641 `((:include ,(class-name include))))
642 (:predicate nil)
643 (:conc-name ,conc-name)
644 (:constructor ,constructor ()))
645 ;;
646 ;; Use a temporary unbound marker that lets
647 ;; SHARED-INITIALIZE recognize if a before-method
648 ;; has written to a slot.
649 ,@(mapcar (lambda (slot)
650 `(,(slot-definition-name slot)
651 '.unbound.))
652 direct-slots)))
653 (reader-names (mapcar (lambda (slotd)
654 (list 'slot-accessor name
655 (slot-definition-name slotd)
656 'reader))
657 direct-slots))
658 (writer-names (mapcar (lambda (slotd)
659 (list 'slot-accessor name
660 (slot-definition-name slotd)
661 'writer))
662 direct-slots))
663 (readers-init
664 (mapcar (lambda (slotd reader-name)
665 (let ((accessor
666 (slot-definition-defstruct-accessor-symbol slotd)))
667 `(defun ,reader-name (obj)
668 (declare (type ,name obj))
669 (,accessor obj))))
670 direct-slots reader-names))
671 (writers-init
672 (mapcar (lambda (slotd writer-name)
673 (let ((accessor
674 (slot-definition-defstruct-accessor-symbol slotd)))
675 `(defun ,writer-name (nv obj)
676 (declare (type ,name obj))
677 (setf (,accessor obj) nv))))
678 direct-slots writer-names))
679 (defstruct-form
680 `(progn
681 ,defstruct
682 ,@readers-init ,@writers-init)))
683 (unless (structure-type-p name) (eval defstruct-form))
684 (mapc (lambda (dslotd reader-name writer-name)
685 (let* ((reader (when (fboundp reader-name)
686 (gdefinition reader-name)))
687 (writer (when (fboundp writer-name)
688 (gdefinition writer-name))))
689 (setf (slot-value dslotd 'internal-reader-function) reader)
690 (setf (slot-value dslotd 'internal-writer-function) writer)))
691 direct-slots reader-names writer-names)
692 (setf (slot-value class 'defstruct-form) defstruct-form)
693 (setf (slot-value class 'defstruct-constructor) constructor))
694 ;;
695 ;; ALLOCATE-INSTANCE is supposed to work with structures
696 ;; defined with DEFSTRUCT.
697 (with-slots (defstruct-constructor) class
698 (setq defstruct-constructor
699 (make-defstruct-allocation-function class)))))
700 ;;
701 (add-direct-subclasses class direct-superclasses)
702 (setf (slot-value class 'class-precedence-list)
703 (compute-class-precedence-list class))
704 (setf (slot-value class 'slots) (compute-slots class))
705 (let ((lclass (kernel::find-class (class-name class))))
706 (setf (kernel:%class-pcl-class lclass) class)
707 (setf (slot-value class 'wrapper) (kernel:%class-layout lclass)))
708 (setf (slot-value class 'finalized-p) t)
709 (update-pv-table-cache-info class)
710 (setq predicate-name (if predicate-name-p
711 (setf (slot-value class 'predicate-name)
712 (car predicate-name))
713 (or (slot-value class 'predicate-name)
714 (setf (slot-value class 'predicate-name)
715 (make-class-predicate-name (class-name class))))))
716 (make-class-predicate class predicate-name)
717 (add-slot-accessors class direct-slots))
718
719 ;;;
720 ;;; Return a closure for allocating an uninitialized structure
721 ;;; instance of class CLASS.
722 ;;;
723 (defun make-defstruct-allocation-function (class)
724 (let ((dd (get-structure-dd (class-name class))))
725 (lambda ()
726 (let ((instance (kernel::%make-instance (kernel::dd-length dd)))
727 (raw-index (kernel::dd-raw-index dd)))
728 (setf (kernel::%instance-layout instance)
729 (kernel::compiler-layout-or-lose (kernel::dd-name dd)))
730 (when raw-index
731 (setf (kernel::%instance-ref
732 instance raw-index
733 (make-array (kernel::dd-raw-length dd)
734 :element-type '(unsigned-byte 32)))))
735 instance))))
736
737 (defmethod direct-slot-definition-class ((class structure-class)
738 &rest initargs)
739 (declare (ignore initargs))
740 (find-class 'structure-direct-slot-definition))
741
742 (defmethod finalize-inheritance ((class structure-class))
743 nil) ; always finalized
744
745 (defun add-slot-accessors (class dslotds)
746 (fix-slot-accessors class dslotds 'add))
747
748 (defun remove-slot-accessors (class dslotds)
749 (fix-slot-accessors class dslotds 'remove))
750
751 (defun fix-slot-accessors (class dslotds add/remove)
752 (flet ((fix (gfspec name r/w)
753 (let ((gf (ensure-generic-function gfspec)))
754 (case r/w
755 (r (if (eq add/remove 'add)
756 (add-reader-method class gf name)
757 (remove-reader-method class gf)))
758 (w (if (eq add/remove 'add)
759 (add-writer-method class gf name)
760 (remove-writer-method class gf)))))))
761 (dolist (dslotd dslotds)
762 (let ((slot-name (slot-definition-name dslotd)))
763 (dolist (r (slot-definition-readers dslotd))
764 (fix r slot-name 'r))
765 (dolist (w (slot-definition-writers dslotd))
766 (fix w slot-name 'w))))))
767
768
769 (defun add-direct-subclasses (class new)
770 (dolist (n new)
771 (unless (memq class (class-direct-subclasses class))
772 (add-direct-subclass n class))))
773
774 (defun remove-direct-subclasses (class new)
775 (let ((old (class-direct-superclasses class)))
776 (dolist (o (set-difference old new))
777 (remove-direct-subclass o class))))
778
779
780 ;;;
781 ;;;
782 ;;;
783 (defmethod finalize-inheritance ((class std-class))
784 (update-class class t))
785
786 (defmethod finalize-inheritance ((class forward-referenced-class))
787 (simple-program-error
788 "~@<Forward-referenced classes cannot be finalized: ~A.~@:>"
789 class))
790
791
792 ;;;
793 ;;; Called by :after shared-initialize whenever a class is initialized or
794 ;;; reinitialized. The class may or may not be finalized.
795 ;;;
796 (defun update-class (class finalizep)
797 ;;
798 ;; Calling UPDATE-SLOTS below sets the class wrapper of CLASS, which
799 ;; makes the class finalized. When UPDATE-CLASS isn't called from
800 ;; FINALIZE-INHERITANCE, make sure that this finalization invokes
801 ;; FINALIZE-INHERITANCE as per AMOP. Note that we can't simply
802 ;; delay the finalization when CLASS has no forward referenced
803 ;; superclasses because that causes bootstrap problems.
804 (when (and (not (or finalizep (class-finalized-p class)))
805 (not (class-has-a-forward-referenced-superclass-p class)))
806 (finalize-inheritance class)
807 (return-from update-class))
808 ;;
809 (when (or finalizep
810 (class-finalized-p class)
811 (not (class-has-a-forward-referenced-superclass-p class)))
812 (setf (find-class (class-name class)) class)
813 (update-cpl class (compute-class-precedence-list class))
814 (update-slots class (compute-slots class))
815 (update-gfs-of-class class)
816 (update-inits class (compute-default-initargs class))
817 (update-shared-slot-values class)
818 (update-ctors 'finalize-inheritance :class class))
819 ;;
820 (unless finalizep
821 (dolist (sub (class-direct-subclasses class))
822 (update-class sub nil))))
823
824 ;;;
825 ;;; Set values of shared slots from initforms inherited from
826 ;;; superclasses, which can't be done before the cpl is known.
827 ;;;
828 (defun update-shared-slot-values (class)
829 (dolist (slot (class-slots class))
830 (when (eq (slot-definition-allocation slot) :class)
831 (let ((cell (assq (slot-definition-name slot) (class-slot-cells class))))
832 (when cell
833 (let ((initfn (slot-definition-initfunction slot)))
834 (when initfn
835 (setf (cdr cell) (funcall initfn)))))))))
836
837 (defun update-cpl (class cpl)
838 (if (class-finalized-p class)
839 (unless (and (equal (class-precedence-list class) cpl)
840 (loop for c in cpl never
841 (loop for s in (class-direct-slots c) thereis
842 (eq (slot-definition-allocation s)
843 :class))))
844 ;; Need to have the cpl setup before update-lisp-class-layout
845 ;; is called on CMUCL.
846 (setf (slot-value class 'class-precedence-list) cpl)
847 (force-cache-flushes class))
848 (setf (slot-value class 'class-precedence-list) cpl))
849 (update-class-can-precede-p cpl))
850
851 (defun update-class-can-precede-p (cpl)
852 (loop for (class . rest) on cpl do
853 (with-slots (can-precede-list) class
854 (setq can-precede-list
855 (union rest can-precede-list :test #'eq)))))
856
857 (defun class-can-precede-p (class1 class2)
858 (member class2 (class-can-precede-list class1)))
859
860 (defun update-slots (class eslotds)
861 (ext:collect ((instance-slots) (class-slots))
862 (dolist (eslotd eslotds)
863 (ecase (slot-definition-allocation eslotd)
864 (:instance (instance-slots eslotd))
865 (:class (class-slots eslotd))))
866 ;;
867 ;; If there is a change in the shape of the instances then the
868 ;; old class is now obsolete.
869 (let* ((nlayout (mapcar #'slot-definition-name
870 (sort (instance-slots) #'<
871 :key #'slot-definition-location)))
872 (nslots (length nlayout))
873 (nwrapper-class-slots (compute-class-slots (class-slots)))
874 (owrapper (when (class-finalized-p class)
875 (class-wrapper class)))
876 (olayout (when owrapper
877 (wrapper-instance-slots-layout owrapper)))
878 (nwrapper
879 (cond ((null owrapper)
880 (make-wrapper nslots class))
881 ;;
882 ;; We cannot reuse the old wrapper easily when it
883 ;; has class slot cells, even if these cells are
884 ;; EQUAL to the ones used in the new wrapper. The
885 ;; class slot cells of OWRAPPER may be referenced
886 ;; from caches, and if we don't change the wrapper,
887 ;; the caches won't notice that something has
888 ;; changed. We could do something here manually,
889 ;; but I don't think it's worth it.
890 ((and (equal nlayout olayout)
891 (null (wrapper-class-slots owrapper)))
892 owrapper)
893 (t
894 ;;
895 ;; This will initialize the new wrapper to have the same
896 ;; state as the old wrapper. We will then have to change
897 ;; that. This may seem like wasted work (it is), but the
898 ;; spec requires that we call make-instances-obsolete.
899 (make-instances-obsolete class)
900 (class-wrapper class)))))
901
902 (with-slots (wrapper slots finalized-p) class
903 (update-lisp-class-layout class nwrapper)
904 (setf slots eslotds
905 (wrapper-instance-slots-layout nwrapper) nlayout
906 (wrapper-class-slots nwrapper) nwrapper-class-slots
907 (wrapper-no-of-instance-slots nwrapper) nslots
908 wrapper nwrapper
909 finalized-p t))
910
911 (unless (eq owrapper nwrapper)
912 (update-inline-access class)
913 (update-pv-table-cache-info class)
914 (maybe-update-standard-class-locations class)))))
915
916 (defun compute-class-slots (eslotds)
917 (loop for eslotd in eslotds
918 for name = (slot-definition-name eslotd)
919 and class = (slot-definition-class eslotd)
920 collect (assoc name (class-slot-cells class))))
921
922 (defun update-gfs-of-class (class)
923 (when (and (class-finalized-p class)
924 (let ((cpl (class-precedence-list class)))
925 (or (member *the-class-slot-class* cpl)
926 (member *the-class-standard-effective-slot-definition* cpl))))
927 (let ((gf-table (make-hash-table :test 'eq)))
928 (labels ((collect-gfs (class)
929 (dolist (gf (specializer-direct-generic-functions class))
930 (setf (gethash gf gf-table) t))
931 (mapc #'collect-gfs (class-direct-superclasses class))))
932 (collect-gfs class)
933 (maphash (lambda (gf ignore)
934 (declare (ignore ignore))
935 (update-gf-dfun class gf))
936 gf-table)))))
937
938 (defun update-inits (class inits)
939 (setf (plist-value class 'default-initargs) inits))
940
941
942 ;;;
943 ;;;
944 ;;;
945 (defmethod compute-default-initargs ((class slot-class))
946 (let ((initargs (loop for c in (class-precedence-list class)
947 append (class-direct-default-initargs c))))
948 (delete-duplicates initargs :test #'eq :key #'car :from-end t)))
949
950 ;;;
951 ;;; Protocols for constructing direct and effective slot definitions.
952 ;;;
953 ;;;
954 ;;;
955 ;;;
956 (defmethod direct-slot-definition-class ((class std-class) &rest initargs)
957 (declare (ignore initargs))
958 (find-class 'standard-direct-slot-definition))
959
960 (defun make-direct-slotd (class initargs)
961 (let ((initargs (list* :class class initargs)))
962 (apply #'make-instance
963 (apply #'direct-slot-definition-class class initargs)
964 initargs)))
965
966 ;;;
967 ;;; As specified, we must call COMPUTE-EFFECTIVE-SLOT-DEFINITION once
968 ;;; for each different slot name we find in our superclasses. Each
969 ;;; call receives the class and a list of the dslotds with that name.
970 ;;; The list is in most-specific-first order.
971 ;;;
972 (defmethod compute-slots ((class std-class))
973 (ext:collect ((names/slots) (effective))
974 (dolist (c (reverse (class-precedence-list class)))
975 (dolist (slot (class-direct-slots c))
976 (let* ((name (slot-definition-name slot))
977 (entry (assq name (names/slots))))
978 (if entry
979 (push slot (cdr entry))
980 (names/slots (list name slot))))))
981 (dolist (e (names/slots) (effective))
982 (effective (compute-effective-slot-definition class (car e) (cdr e))))))
983
984 ;;;
985 ;;; These are the specified AMOP methods.
986 ;;;
987
988 (defmethod compute-slots ((class standard-class))
989 (call-next-method))
990
991 (defmethod compute-slots :around ((class standard-class))
992 (loop with slotds = (call-next-method) and location = -1
993 for slot in slotds do
994 (setf (slot-definition-location slot)
995 (ecase (slot-definition-allocation slot)
996 (:instance
997 (incf location))
998 (:class
999 (let* ((name (slot-definition-name slot))
1000 (from-class (slot-definition-allocation-class slot))
1001 (cell (assq name (class-slot-cells from-class))))
1002 (assert (consp cell))
1003 cell))))
1004 (initialize-internal-slot-functions slot)
1005 finally
1006 (return slotds)))
1007
1008 (defmethod compute-slots ((class funcallable-standard-class))
1009 (call-next-method))
1010
1011 (defmethod compute-slots :around ((class funcallable-standard-class))
1012 (labels (;;
1013 ;; Return a list of the names of instance slots in SLOTDS.
1014 (instance-slot-names (slotds)
1015 (loop for e in slotds
1016 when (eq (slot-definition-allocation e) :instance)
1017 collect (slot-definition-name e)))
1018 ;;
1019 ;; This sorts slots so that slots of classes later in the CPL
1020 ;; come before slots of other classes. This is crucial for
1021 ;; funcallable instances because it ensures that the slots of
1022 ;; FUNCALLABLE-STANDARD-OBJECT, which includes the slots of
1023 ;; KERNEL:FUNCALLABLE-INSTANCE, come first, which in turn
1024 ;; makes it possible to treat FUNCALLABLE-STANDARD-OBJECT as
1025 ;; a funcallable instance.
1026 (compute-layout (eslotds)
1027 (loop with first = ()
1028 with names = (instance-slot-names eslotds)
1029 for class in (reverse (class-precedence-list class)) do
1030 (loop for ss in (class-slots class)
1031 as name = (slot-definition-name ss)
1032 when (member name names) do
1033 (push name first)
1034 (setq names (delete name names)))
1035 finally (return (nreverse (nconc names first))))))
1036 ;;
1037 (let ((all-slotds (call-next-method))
1038 (instance-slots ())
1039 (class-slots ()))
1040 (loop for slotd in all-slotds do
1041 (ecase (slot-definition-allocation slotd)
1042 (:instance (push slotd instance-slots))
1043 (:class (push slotd class-slots))))
1044 (loop with layout = (compute-layout instance-slots)
1045 for slotd in instance-slots do
1046 (setf (slot-definition-location slotd)
1047 (position (slot-definition-name slotd) layout))
1048 (initialize-internal-slot-functions slotd))
1049 (loop for slotd in class-slots
1050 as name = (slot-definition-name slotd)
1051 as from-class = (slot-definition-allocation-class slotd) do
1052 (setf (slot-definition-location slotd)
1053 (assoc name (class-slot-cells from-class)))
1054 (assert (consp (slot-definition-location slotd)))
1055 (initialize-internal-slot-functions slotd))
1056 all-slotds)))
1057
1058 (defmethod compute-slots ((class structure-class))
1059 (mapcan (lambda (superclass)
1060 (mapcar (lambda (dslotd)
1061 (compute-effective-slot-definition
1062 class (slot-definition-name dslotd) (list dslotd)))
1063 (class-direct-slots superclass)))
1064 (reverse (slot-value class 'class-precedence-list))))
1065
1066 (defmethod compute-slots :around ((class structure-class))
1067 (let ((eslotds (call-next-method)))
1068 (mapc #'initialize-internal-slot-functions eslotds)
1069 eslotds))
1070
1071 (defmethod compute-effective-slot-definition
1072 ((class slot-class) slot-name dslotds)
1073 (declare (ignore slot-name))
1074 (let* ((initargs (compute-effective-slot-definition-initargs class dslotds))
1075 (class (apply #'effective-slot-definition-class class initargs)))
1076 (apply #'make-instance class initargs)))
1077
1078 (defmethod effective-slot-definition-class ((class std-class) &rest initargs)
1079 (declare (ignore initargs))
1080 (find-class 'standard-effective-slot-definition))
1081
1082 (defmethod effective-slot-definition-class ((class structure-class)
1083 &rest initargs)
1084 (declare (ignore initargs))
1085 (find-class 'structure-effective-slot-definition))
1086
1087 (defmethod compute-effective-slot-definition-initargs
1088 ((class slot-class) direct-slotds)
1089 (let* ((name nil)
1090 (initfunction nil)
1091 (initform nil)
1092 (initargs nil)
1093 (allocation nil)
1094 (allocation-class nil)
1095 (type t)
1096 (namep nil)
1097 (initp nil)
1098 (allocp nil))
1099
1100 (dolist (slotd direct-slotds)
1101 (when slotd
1102 (unless namep
1103 (setq name (slot-definition-name slotd)
1104 namep t))
1105 (unless initp
1106 (when (slot-definition-initfunction slotd)
1107 (setq initform (slot-definition-initform slotd)
1108 initfunction (slot-definition-initfunction slotd)
1109 initp t)))
1110 (unless allocp
1111 (setq allocation (slot-definition-allocation slotd)
1112 allocation-class (slot-definition-class slotd)
1113 allocp t))
1114 (setq initargs (append (slot-definition-initargs slotd) initargs))
1115 (let ((slotd-type (slot-definition-type slotd)))
1116 (setq type (cond ((eq type t) slotd-type)
1117 ((*subtypep type slotd-type) type)
1118 (t `(and ,type ,slotd-type)))))))
1119 (list :name name
1120 :initform initform
1121 :initfunction initfunction
1122 :initargs initargs
1123 :allocation allocation
1124 :allocation-class allocation-class
1125 :type type
1126 :class class)))
1127
1128 (defmethod compute-effective-slot-definition-initargs :around
1129 ((class structure-class) direct-slotds)
1130 (let ((slotd (car direct-slotds)))
1131 (list* :defstruct-accessor-symbol (slot-definition-defstruct-accessor-symbol slotd)
1132 :internal-reader-function (slot-definition-internal-reader-function slotd)
1133 :internal-writer-function (slot-definition-internal-writer-function slotd)
1134 (call-next-method))))
1135
1136 ;;;
1137 ;;; NOTE: For bootstrapping considerations, these can't use make-instance
1138 ;;; to make the method object. They have to use make-a-method which
1139 ;;; is a specially bootstrapped mechanism for making standard methods.
1140 ;;;
1141 (defmethod reader-method-class ((class slot-class) direct-slot &rest initargs)
1142 (declare (ignore direct-slot initargs))
1143 (find-class 'standard-reader-method))
1144
1145 (defmethod add-reader-method ((class slot-class) generic-function slot-name)
1146 (add-method generic-function
1147 (make-a-method 'standard-reader-method
1148 ()
1149 (list (or (class-name class) 'object))
1150 (list class)
1151 (make-reader-method-function class slot-name)
1152 "automatically generated reader method"
1153 slot-name)))
1154
1155 (defmethod writer-method-class ((class slot-class) direct-slot &rest initargs)
1156 (declare (ignore direct-slot initargs))
1157 (find-class 'standard-writer-method))
1158
1159 (defmethod add-writer-method ((class slot-class) generic-function slot-name)
1160 (add-method generic-function
1161 (make-a-method 'standard-writer-method
1162 ()
1163 (list 'new-value (or (class-name class) 'object))
1164 (list *the-class-t* class)
1165 (make-writer-method-function class slot-name)
1166 "automatically generated writer method"
1167 slot-name)))
1168
1169 (defmethod add-boundp-method ((class slot-class) generic-function slot-name)
1170 (add-method generic-function
1171 (make-a-method 'standard-boundp-method
1172 ()
1173 (list (or (class-name class) 'object))
1174 (list class)
1175 (make-boundp-method-function class slot-name)
1176 "automatically generated boundp method"
1177 slot-name)))
1178
1179 (defmethod remove-reader-method ((class slot-class) generic-function)
1180 (let ((method (get-method generic-function () (list class) nil)))
1181 (when method
1182 (remove-method generic-function method))))
1183
1184 (defmethod remove-writer-method ((class slot-class) generic-function)
1185 (let ((method (get-method generic-function ()
1186 (list *the-class-t* class) nil)))
1187 (when method
1188 (remove-method generic-function method))))
1189
1190 (defmethod remove-boundp-method ((class slot-class) generic-function)
1191 (let ((method (get-method generic-function () (list class) nil)))
1192 (when method
1193 (remove-method generic-function method))))
1194
1195
1196 ;;;
1197 ;;; make-reader-method-function and make-write-method function are NOT part of
1198 ;;; the standard protocol. They are however useful, PCL makes uses makes use
1199 ;;; of them internally and documents them for PCL users.
1200 ;;;
1201 ;;; *** This needs work to make type testing by the writer functions which
1202 ;;; *** do type testing faster. The idea would be to have one constructor
1203 ;;; *** for each possible type test. In order to do this it would be nice
1204 ;;; *** to have help from inform-type-system-about-class and friends.
1205 ;;;
1206 ;;; *** There is a subtle bug here which is going to have to be fixed.
1207 ;;; *** Namely, the simplistic use of the template has to be fixed. We
1208 ;;; *** have to give the optimize-slot-value method the user might have
1209 ;;; *** defined for this metclass a chance to run.
1210 ;;;
1211 (defmethod make-reader-method-function ((class slot-class) slot-name)
1212 (make-std-reader-method-function (class-name class) slot-name))
1213
1214 (defmethod make-writer-method-function ((class slot-class) slot-name)
1215 (make-std-writer-method-function (class-name class) slot-name))
1216
1217 (defmethod make-boundp-method-function ((class slot-class) slot-name)
1218 (make-std-boundp-method-function (class-name class) slot-name))
1219
1220
1221 ;;;; inform-type-system-about-class
1222 ;;;
1223 ;;; This is NOT part of the standard protocol. It is an internal mechanism
1224 ;;; which PCL uses to *try* and tell the type system about class definitions.
1225 ;;; In a more fully integrated implementation of CLOS, the type system would
1226 ;;; know about class objects and class names in a more fundamental way and
1227 ;;; the mechanism used to inform the type system about new classes would be
1228 ;;; different.
1229 ;;;
1230 (defmethod inform-type-system-about-class ((class std-class) name)
1231 ;; Maybe add skeleton lisp:standard-class to avoid undefined-function
1232 ;; compiler warnings. Not otherwise needed in this implementation.
1233 (inform-type-system-about-std-class name)
1234 (set-class-translation class name))
1235
1236 (defmethod inform-type-system-about-class ((class funcallable-standard-class)
1237 name)
1238 (set-class-translation class name))
1239
1240 (defmethod inform-type-system-about-class ((class structure-class) name)
1241 (set-class-translation class name))
1242
1243 (defmethod inform-type-system-about-class ((class condition-class) name)
1244 (set-class-translation class name))
1245
1246 (defmethod inform-type-system-about-class ((class forward-referenced-class)
1247 name)
1248 (inform-type-system-about-std-class name)
1249 (set-class-translation class name))
1250
1251
1252 (defmethod compatible-meta-class-change-p (class proto-new-class)
1253 (eq (class-of class) (class-of proto-new-class)))
1254
1255 (defmethod validate-superclass ((class class) (new-super class))
1256 (or (eq new-super *the-class-t*)
1257 (eq (class-of class) (class-of new-super))))
1258
1259 (defmethod validate-superclass ((class standard-class) (new-super std-class))
1260 (let ((new-super-meta-class (class-of new-super)))
1261 (or (eq new-super-meta-class *the-class-std-class*)
1262 (eq (class-of class) new-super-meta-class))))
1263
1264
1265 ;;;
1266 ;;; Force the flushing of caches by creating a new wrapper for CLASS,
1267 ;;; if necessary.
1268 ;;;
1269 ;;; If the LAYOUT-INVALID slot of CLASS's wrapper is
1270 ;;;
1271 ;;; -- (:FLUSH <new wrapper>) or (:OBSOLETE <new wrapper>), there's
1272 ;;; nothing to do. The new wrapper has already been created.
1273 ;;;
1274 ;;; -- :INVALID, then it has been set to that value by a previous
1275 ;;; call to REGISTER-LAYOUT for a superclass S of CLASS; S's
1276 ;;; wrapper has been invalidated together with its subclasses. In
1277 ;;; this case, CLASS's caches must obviously be flushed, too, like
1278 ;;; S's. So, make a new wrapper for CLASS, and translate kernel's
1279 ;;; :INVALID to PCL (:FLUSH <new wrapper>). UPDATE-SLOTS can later
1280 ;;; decide if it wants to make this (:OBSOLETE ...).
1281 ;;;
1282 ;;; -- NIL, then the wrapper is still valid, in which case we do
1283 ;;; the same as for :INVALID, but for the obviously slightly
1284 ;;; different reason.
1285 ;;;
1286 (defun force-cache-flushes (class)
1287 (let* ((owrapper (class-wrapper class)))
1288 (when (or (not (invalid-wrapper-p owrapper))
1289 (eq :invalid (kernel:layout-invalid owrapper)))
1290 (let ((nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1291 class)))
1292 (setf (wrapper-instance-slots-layout nwrapper)
1293 (wrapper-instance-slots-layout owrapper))
1294 (setf (wrapper-class-slots nwrapper)
1295 (wrapper-class-slots owrapper))
1296 (with-pcl-lock
1297 (update-lisp-class-layout class nwrapper)
1298 (setf (slot-value class 'wrapper) nwrapper)
1299 (invalidate-wrapper owrapper :flush nwrapper))))))
1300
1301 (defun flush-cache-trap (owrapper nwrapper instance)
1302 (declare (ignore owrapper))
1303 (cond ((std-instance-p instance)
1304 (setf (std-instance-wrapper instance) nwrapper))
1305 ((fsc-instance-p instance)
1306 (setf (fsc-instance-wrapper instance) nwrapper))
1307 (t
1308 (internal-error "Internal error."))))
1309
1310
1311 ;;;
1312 ;;; make-instances-obsolete can be called by user code. It will cause the
1313 ;;; next access to the instance (as defined in 88-002R) to trap through the
1314 ;;; update-instance-for-redefined-class mechanism.
1315 ;;;
1316 (defmethod make-instances-obsolete ((class std-class))
1317 (let* ((owrapper (class-wrapper class))
1318 (nwrapper (make-wrapper (wrapper-no-of-instance-slots owrapper)
1319 class)))
1320 (setf (wrapper-instance-slots-layout nwrapper)
1321 (wrapper-instance-slots-layout owrapper))
1322 (setf (wrapper-class-slots nwrapper)
1323 (wrapper-class-slots owrapper))
1324 (with-pcl-lock
1325 (update-lisp-class-layout class nwrapper)
1326 (setf (slot-value class 'wrapper) nwrapper)
1327 (invalidate-wrapper owrapper :obsolete nwrapper)
1328 class)))
1329
1330 (defmethod make-instances-obsolete ((class symbol))
1331 (make-instances-obsolete (find-class class)))
1332
1333
1334 ;;;
1335 ;;; obsolete-instance-trap is the internal trap that is called when we see
1336 ;;; an obsolete instance. The times when it is called are:
1337 ;;; - when the instance is involved in method lookup
1338 ;;; - when attempting to access a slot of an instance
1339 ;;;
1340 ;;; It is not called by class-of, wrapper-of, or any of the low-level instance
1341 ;;; access macros.
1342 ;;;
1343 ;;; Of course these times when it is called are an internal implementation
1344 ;;; detail of PCL and are not part of the documented description of when the
1345 ;;; obsolete instance update happens. The documented description is as it
1346 ;;; appears in 88-002R.
1347 ;;;
1348 ;;; This has to return the new wrapper, so it counts on all the methods on
1349 ;;; obsolete-instance-trap-internal to return the new wrapper. It also does
1350 ;;; a little internal error checking to make sure that the traps are only
1351 ;;; happening when they should, and that the trap methods are computing
1352 ;;; apropriate new wrappers.
1353 ;;;
1354
1355 ;;; obsolete-instance-trap might be called on structure instances
1356 ;;; after a structure is redefined. In most cases, obsolete-instance-trap
1357 ;;; will not be able to fix the old instance, so it must signal an
1358 ;;; error. The hard part of this is that the error system and debugger
1359 ;;; might cause obsolete-instance-trap to be called again, so in that
1360 ;;; case, we have to return some reasonable wrapper, instead.
1361
1362 (defvar *in-obsolete-instance-trap* nil)
1363
1364 (defvar *the-wrapper-of-structure-object*
1365 (class-wrapper (find-class 'structure-object)))
1366
1367 (define-condition obsolete-structure (error)
1368 ((datum :reader obsolete-structure-datum :initarg :datum))
1369 (:report
1370 (lambda (condition stream)
1371 ;; Don't try to print the structure, since it probably
1372 ;; won't work.
1373 (format stream "~@<Obsolete structure error in ~S ~
1374 for a structure of type ~S.~@:>"
1375 (conditions::condition-function-name condition)
1376 (type-of (obsolete-structure-datum condition))))))
1377
1378 (defun obsolete-instance-trap (owrapper nwrapper instance)
1379 (if (not (pcl-instance-p instance))
1380 (if *in-obsolete-instance-trap*
1381 *the-wrapper-of-structure-object*
1382 (let ((*in-obsolete-instance-trap* t))
1383 (error 'obsolete-structure :datum instance)))
1384 (let* ((class (wrapper-class* nwrapper))
1385 (copy (allocate-instance class)) ;??? allocate-instance ???
1386 (olayout (wrapper-instance-slots-layout owrapper))
1387 (nlayout (wrapper-instance-slots-layout nwrapper))
1388 (oslots (get-slots instance))
1389 (nslots (get-slots copy))
1390 (oclass-slots (wrapper-class-slots owrapper))
1391 (added ())
1392 (discarded ())
1393 (plist ()))
1394 ;; local --> local transfer
1395 ;; local --> shared discard
1396 ;; local --> -- discard
1397 ;; shared --> local transfer
1398 ;; shared --> shared discard
1399 ;; shared --> -- discard
1400 ;; -- --> local add
1401 ;; -- --> shared --
1402 ;;
1403 ;; Go through all the old local slots.
1404 ;;
1405 (loop for name in olayout and opos from 0
1406 as npos = (posq name nlayout)
1407 if npos do
1408 (setf (slot-ref nslots npos)
1409 (slot-ref oslots opos))
1410 else do
1411 (push name discarded)
1412 (unless (eq (slot-ref oslots opos) +slot-unbound+)
1413 (setf (getf plist name)
1414 (slot-ref oslots opos))))
1415 ;;
1416 ;; Go through all the old shared slots.
1417 ;;
1418 (loop for (name . val) in oclass-slots
1419 for npos = (posq name nlayout)
1420 if npos do
1421 (setf (slot-ref nslots npos) val)
1422 else do
1423 (push name discarded)
1424 (unless (eq val +slot-unbound+)
1425 (setf (getf plist name) val)))
1426 ;;
1427 ;; Go through all the new local slots to compute the added slots.
1428 ;;
1429 (dolist (nlocal nlayout)
1430 (unless (or (memq nlocal olayout)
1431 (assq nlocal oclass-slots))
1432 (push nlocal added)))
1433
1434 (swap-wrappers-and-slots instance copy)
1435
1436 (update-instance-for-redefined-class instance
1437 added
1438 discarded
1439 plist)
1440 nwrapper)))
1441
1442
1443 ;;;
1444 ;;;
1445 ;;;
1446 (defun change-class-internal (instance new-class initargs)
1447 (let* ((old-class (class-of instance))
1448 (copy (allocate-instance new-class))
1449 (new-wrapper (get-wrapper copy))
1450 (old-wrapper (class-wrapper old-class))
1451 (old-layout (wrapper-instance-slots-layout old-wrapper))
1452 (new-layout (wrapper-instance-slots-layout new-wrapper))
1453 (old-slots (get-slots instance))
1454 (new-slots (get-slots copy))
1455 (old-class-slots (wrapper-class-slots old-wrapper)))
1456
1457 ;;
1458 ;; "The values of local slots specified by both the class Cto and
1459 ;; Cfrom are retained. If such a local slot was unbound, it remains
1460 ;; unbound."
1461 ;;
1462 (loop for new-slot in new-layout and new-position from 0
1463 for old-position = (posq new-slot old-layout)
1464 when old-position do
1465 (setf (slot-ref new-slots new-position)
1466 (slot-ref old-slots old-position)))
1467 ;;
1468 ;; "The values of slots specified as shared in the class Cfrom and
1469 ;; as local in the class Cto are retained."
1470 ;;
1471 (loop for (name . val) in old-class-slots
1472 for new-position = (posq name new-layout)
1473 when new-position do
1474 (setf (slot-ref new-slots new-position) val))
1475
1476 ;; Make the copy point to the old instance's storage, and make the
1477 ;; old instance point to the new storage.
1478 (swap-wrappers-and-slots instance copy)
1479
1480 (apply #'update-instance-for-different-class copy instance initargs)
1481 instance))
1482
1483 (defmethod change-class ((instance standard-object)
1484 (new-class standard-class)
1485 &rest initargs)
1486 (change-class-internal instance new-class initargs))
1487
1488 (defmethod change-class ((instance funcallable-standard-object)
1489 (new-class funcallable-standard-class)
1490 &rest initargs)
1491 (change-class-internal instance new-class initargs))
1492
1493 (defmethod change-class ((instance standard-object)
1494 (new-class funcallable-standard-class)
1495 &rest initargs)
1496 (declare (ignore initargs))
1497 (error "~@<Can't change the class of ~S to ~S ~
1498 because it isn't already an instance with metaclass ~S.~@:>"
1499 instance new-class 'standard-class))
1500
1501 (defmethod change-class ((instance funcallable-standard-object)
1502 (new-class standard-class)
1503 &rest initargs)
1504 (declare (ignore initargs))
1505 (error "~@<Can't change the class of ~S to ~S ~
1506 because it isn't already an instance with metaclass ~S.~@:>"
1507 instance new-class 'funcallable-standard-class))
1508
1509 (defmethod change-class ((instance t) (new-class-name symbol) &rest initargs)
1510 (apply #'change-class instance (find-class new-class-name) initargs))
1511
1512
1513
1514 ;;;
1515 ;;; The metaclass BUILT-IN-CLASS
1516 ;;;
1517 ;;; This metaclass is something of a weird creature. By this point, all
1518 ;;; instances of it which will exist have been created, and no instance
1519 ;;; is ever created by calling MAKE-INSTANCE.
1520 ;;;
1521 ;;; But, there are other parts of the protcol we must follow and those
1522 ;;; definitions appear here.
1523 ;;;
1524 (defmethod shared-initialize :before
1525 ((class built-in-class) slot-names &rest initargs)
1526 (declare (ignore slot-names initargs))
1527 (error "Attempt to initialize or reinitialize a built-in class."))
1528
1529 (defmethod class-direct-slots ((class built-in-class)) ())
1530 (defmethod class-slots ((class built-in-class)) ())
1531 (defmethod class-direct-default-initargs ((class built-in-class)) ())
1532 (defmethod class-default-initargs ((class built-in-class)) ())
1533
1534 (defmethod validate-superclass ((c class) (s built-in-class))
1535 (or (eq s *the-class-t*)
1536 (eq s *the-class-stream*)))
1537
1538
1539
1540 ;;;
1541 ;;;
1542 ;;;
1543
1544 (macrolet ((frob (method)
1545 `(defmethod ,method ((class forward-referenced-class))
1546 (declare (ignore class))
1547 ())))
1548 (frob class-direct-slots)
1549 (frob class-direct-default-initargs))
1550
1551 (macrolet ((frob (method)
1552 `(defmethod ,method ((class forward-referenced-class))
1553 (error "~@<~S called for forward referenced class ~S.~@:>"
1554 ',method class))))
1555 (frob class-default-initargs)
1556 (frob class-precedence-list)
1557 (frob class-slots))
1558
1559 (defmethod validate-superclass ((c slot-class)
1560 (f forward-referenced-class))
1561 t)
1562
1563
1564 ;;;
1565 ;;;
1566 ;;;
1567
1568 (defmethod add-dependent ((metaobject dependent-update-mixin) dependent)
1569 (pushnew dependent (plist-value metaobject 'dependents)))
1570
1571 (defmethod remove-dependent ((metaobject dependent-update-mixin) dependent)
1572 (setf (plist-value metaobject 'dependents)
1573 (delete dependent (plist-value metaobject 'dependents))))
1574
1575 (defmethod map-dependents ((metaobject dependent-update-mixin) function)
1576 (dolist (dependent (plist-value metaobject 'dependents))
1577 (funcall function dependent)))
1578
1579
1580 ;;;
1581 ;;; Conditions
1582 ;;;
1583 (defmethod class-direct-slots ((class condition-class)) ())
1584 (defmethod class-slots ((class condition-class)) ())
1585 (defmethod class-default-initargs ((class condition-class)) ())
1586 (defmethod class-direct-default-initargs ((class condition-class)) ())
1587
1588 (defmethod shared-initialize :after ((class condition-class) slot-names
1589 &key direct-superclasses)
1590 (declare (ignore slot-names))
1591 (let ((kernel-class (kernel::find-class (class-name class))))
1592 (with-slots (wrapper class-precedence-list prototype predicate-name
1593 (direct-supers direct-superclasses))
1594 class
1595 (setf (slot-value class 'finalized-p) t)
1596 (setf (kernel:%class-pcl-class kernel-class) class)
1597 (setq direct-supers direct-superclasses)
1598 (setq wrapper (kernel:%class-layout kernel-class))
1599 (setq class-precedence-list (compute-class-precedence-list class))
1600 (setq prototype (make-condition (class-name class)))
1601 (add-direct-subclasses class direct-superclasses)
1602 (setq predicate-name (make-class-predicate-name (class-name class)))
1603 (make-class-predicate class predicate-name))))
1604

  ViewVC Help
Powered by ViewVC 1.1.5