1 ;;;; This software is part of the SBCL system. See the README file for
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
10 ;;;; copyright information from original PCL sources:
12 ;;;; Copyright (c) 1985, 1986, 1987, 1988, 1989, 1990 Xerox Corporation.
13 ;;;; All rights reserved.
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
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
26 ;;;; ANSI CL condition for unbound slots
28 (define-condition unbound-slot (cell-error)
29 ((instance :reader unbound-slot-instance :initarg :instance))
30 (:report (lambda (condition stream)
31 (format stream "The slot ~S is unbound in the object ~S."
32 (cell-error-name condition)
33 (unbound-slot-instance condition)))))
35 (defmethod wrapper-fetcher ((class standard-class))
36 'std-instance-wrapper)
38 (defmethod slots-fetcher ((class standard-class))
41 (defmethod raw-instance-allocator ((class standard-class))
42 'allocate-standard-instance)
44 ;;; These four functions work on std-instances and fsc-instances. These are
45 ;;; instances for which it is possible to change the wrapper and the slots.
47 ;;; For these kinds of instances, most specified methods from the instance
48 ;;; structure protocol are promoted to the implementation-specific class
49 ;;; std-class. Many of these methods call these four functions.
51 (defun set-wrapper (inst new)
52 (cond ((std-instance-p inst)
53 (setf (std-instance-wrapper inst) new))
54 ((fsc-instance-p inst)
55 (setf (fsc-instance-wrapper inst) new))
57 (error "unrecognized instance type"))))
59 (defun swap-wrappers-and-slots (i1 i2)
60 (with-pcl-lock ;FIXME is this sufficient?
61 (cond ((std-instance-p i1)
62 (let ((w1 (std-instance-wrapper i1))
63 (s1 (std-instance-slots i1)))
64 (setf (std-instance-wrapper i1) (std-instance-wrapper i2))
65 (setf (std-instance-slots i1) (std-instance-slots i2))
66 (setf (std-instance-wrapper i2) w1)
67 (setf (std-instance-slots i2) s1)))
69 (let ((w1 (fsc-instance-wrapper i1))
70 (s1 (fsc-instance-slots i1)))
71 (setf (fsc-instance-wrapper i1) (fsc-instance-wrapper i2))
72 (setf (fsc-instance-slots i1) (fsc-instance-slots i2))
73 (setf (fsc-instance-wrapper i2) w1)
74 (setf (fsc-instance-slots i2) s1)))
76 (error "unrecognized instance type")))))
78 (defun find-slot-definition (class slot-name)
79 (dolist (slot (class-slots class) nil)
80 (when (eql slot-name (slot-definition-name slot))
83 (declaim (ftype (sfunction (t symbol) t) slot-value))
84 (defun slot-value (object slot-name)
85 (let* ((class (class-of object))
86 (slot-definition (find-slot-definition class slot-name)))
87 (if (null slot-definition)
88 (values (slot-missing class object slot-name 'slot-value))
89 (slot-value-using-class class object slot-definition))))
91 (define-compiler-macro slot-value (&whole form object slot-name)
92 (if (and (constantp slot-name)
93 (interned-symbol-p (constant-form-value slot-name)))
94 `(accessor-slot-value ,object ,slot-name)
97 (defun set-slot-value (object slot-name new-value)
98 (let* ((class (class-of object))
99 (slot-definition (find-slot-definition class slot-name)))
100 (if (null slot-definition)
101 (progn (slot-missing class object slot-name 'setf new-value)
103 (setf (slot-value-using-class class object slot-definition)
106 (define-compiler-macro set-slot-value (&whole form object slot-name new-value)
107 (if (and (constantp slot-name)
108 (interned-symbol-p (constant-form-value slot-name)))
109 `(accessor-set-slot-value ,object ,slot-name ,new-value)
112 (defun slot-boundp (object slot-name)
113 (let* ((class (class-of object))
114 (slot-definition (find-slot-definition class slot-name)))
115 (if (null slot-definition)
116 (not (not (slot-missing class object slot-name 'slot-boundp)))
117 (slot-boundp-using-class class object slot-definition))))
119 (setf (gdefinition 'slot-boundp-normal) #'slot-boundp)
121 (define-compiler-macro slot-boundp (&whole form object slot-name)
122 (if (and (constantp slot-name)
123 (interned-symbol-p (constant-form-value slot-name)))
124 `(accessor-slot-boundp ,object ,slot-name)
127 (defun slot-makunbound (object slot-name)
128 (let* ((class (class-of object))
129 (slot-definition (find-slot-definition class slot-name)))
130 (if (null slot-definition)
131 (slot-missing class object slot-name 'slot-makunbound)
132 (slot-makunbound-using-class class object slot-definition))
135 (defun slot-exists-p (object slot-name)
136 (let ((class (class-of object)))
137 (not (null (find-slot-definition class slot-name)))))
139 (defvar *unbound-slot-value-marker* (make-unprintable-object "unbound slot"))
141 ;;; This isn't documented, but is used within PCL in a number of print
142 ;;; object methods. (See NAMED-OBJECT-PRINT-FUNCTION.)
143 (defun slot-value-or-default (object slot-name &optional
144 (default *unbound-slot-value-marker*))
145 (if (slot-boundp object slot-name)
146 (slot-value object slot-name)
149 (defun standard-instance-access (instance location)
150 (clos-slots-ref (std-instance-slots instance) location))
152 (defun funcallable-standard-instance-access (instance location)
153 (clos-slots-ref (fsc-instance-slots instance) location))
155 (defmethod slot-value-using-class ((class std-class)
156 (object standard-object)
157 (slotd standard-effective-slot-definition))
158 (check-obsolete-instance object)
159 (let* ((location (slot-definition-location slotd))
163 (cond ((std-instance-p object)
164 (clos-slots-ref (std-instance-slots object)
166 ((fsc-instance-p object)
167 (clos-slots-ref (fsc-instance-slots object)
169 (t (bug "unrecognized instance type in ~S"
170 'slot-value-using-class))))
174 (instance-structure-protocol-error slotd
175 'slot-value-using-class)))))
176 (if (eq value +slot-unbound+)
177 (values (slot-unbound class object (slot-definition-name slotd)))
180 (defmethod (setf slot-value-using-class)
181 (new-value (class std-class)
182 (object standard-object)
183 (slotd standard-effective-slot-definition))
184 (check-obsolete-instance object)
185 (let ((location (slot-definition-location slotd)))
188 (cond ((std-instance-p object)
189 (setf (clos-slots-ref (std-instance-slots object) location)
191 ((fsc-instance-p object)
192 (setf (clos-slots-ref (fsc-instance-slots object) location)
194 (t (bug "unrecognized instance type in ~S"
195 '(setf slot-value-using-class)))))
197 (setf (cdr location) new-value))
199 (instance-structure-protocol-error slotd
200 '(setf slot-value-using-class))))))
202 (defmethod slot-boundp-using-class
204 (object standard-object)
205 (slotd standard-effective-slot-definition))
206 (check-obsolete-instance object)
207 (let* ((location (slot-definition-location slotd))
211 (cond ((std-instance-p object)
212 (clos-slots-ref (std-instance-slots object)
214 ((fsc-instance-p object)
215 (clos-slots-ref (fsc-instance-slots object)
217 (t (bug "unrecognized instance type in ~S"
218 'slot-boundp-using-class))))
222 (instance-structure-protocol-error slotd
223 'slot-boundp-using-class)))))
224 (not (eq value +slot-unbound+))))
226 (defmethod slot-makunbound-using-class
228 (object standard-object)
229 (slotd standard-effective-slot-definition))
230 (check-obsolete-instance object)
231 (let ((location (slot-definition-location slotd)))
234 (cond ((std-instance-p object)
235 (setf (clos-slots-ref (std-instance-slots object) location)
237 ((fsc-instance-p object)
238 (setf (clos-slots-ref (fsc-instance-slots object) location)
240 (t (bug "unrecognized instance type in ~S"
241 'slot-makunbound-using-class))))
243 (setf (cdr location) +slot-unbound+))
245 (instance-structure-protocol-error slotd
246 'slot-makunbound-using-class))))
249 (defmethod slot-value-using-class
250 ((class condition-class)
252 (slotd condition-effective-slot-definition))
253 (let ((fun (slot-definition-reader-function slotd)))
254 (declare (type function fun))
255 (funcall fun object)))
257 (defmethod (setf slot-value-using-class)
259 (class condition-class)
261 (slotd condition-effective-slot-definition))
262 (let ((fun (slot-definition-writer-function slotd)))
263 (declare (type function fun))
264 (funcall fun new-value object)))
266 (defmethod slot-boundp-using-class
267 ((class condition-class)
269 (slotd condition-effective-slot-definition))
270 (let ((fun (slot-definition-boundp-function slotd)))
271 (declare (type function fun))
272 (funcall fun object)))
274 (defmethod slot-makunbound-using-class ((class condition-class) object slot)
275 (error "attempt to unbind slot ~S in condition object ~S."
278 (defmethod slot-value-using-class
279 ((class structure-class)
280 (object structure-object)
281 (slotd structure-effective-slot-definition))
282 (let* ((function (slot-definition-internal-reader-function slotd))
283 (value (funcall function object)))
284 (declare (type function function))
285 (if (eq value +slot-unbound+)
286 (values (slot-unbound class object (slot-definition-name slotd)))
289 (defmethod (setf slot-value-using-class)
290 (new-value (class structure-class)
291 (object structure-object)
292 (slotd structure-effective-slot-definition))
293 (let ((function (slot-definition-internal-writer-function slotd)))
294 (declare (type function function))
295 (funcall function new-value object)))
297 (defmethod slot-boundp-using-class
298 ((class structure-class)
299 (object structure-object)
300 (slotd structure-effective-slot-definition))
303 (defmethod slot-makunbound-using-class
304 ((class structure-class)
305 (object structure-object)
306 (slotd structure-effective-slot-definition))
307 (error "Structure slots can't be unbound."))
309 (defmethod slot-missing
310 ((class t) instance slot-name operation &optional new-value)
311 (error "~@<When attempting to ~A, the slot ~S is missing from the ~
314 (slot-value "read the slot's value (slot-value)")
316 "set the slot's value to ~S (SETF of SLOT-VALUE)"
318 (slot-boundp "test to see whether slot is bound (SLOT-BOUNDP)")
319 (slot-makunbound "make the slot unbound (SLOT-MAKUNBOUND)"))
323 (defmethod slot-unbound ((class t) instance slot-name)
325 (error 'unbound-slot :name slot-name :instance instance)
327 :report "Return a value as the slot-value."
328 :interactive read-evaluated-form
331 :report "Store and return a value as the slot-value."
332 :interactive read-evaluated-form
333 (setf (slot-value instance slot-name) v))))
335 (defun slot-unbound-internal (instance position)
342 (nth position (wrapper-instance-slots-layout (wrapper-of instance))))
346 ;;; FIXME: AMOP says that allocate-instance imples finalize-inheritance
347 ;;; if the class is not yet finalized, but we don't seem to be taking
348 ;;; care of this for non-standard-classes.x
349 (defmethod allocate-instance ((class standard-class) &rest initargs)
350 (declare (ignore initargs))
351 (unless (class-finalized-p class)
352 (finalize-inheritance class))
353 (allocate-standard-instance (class-wrapper class)))
355 (defmethod allocate-instance ((class structure-class) &rest initargs)
356 (declare (ignore initargs))
357 (let ((constructor (class-defstruct-constructor class)))
359 (funcall constructor)
360 (allocate-standard-instance (class-wrapper class)))))
362 ;;; FIXME: It would be nicer to have allocate-instance return
363 ;;; uninitialized objects for conditions as well.
364 (defmethod allocate-instance ((class condition-class) &rest initargs)
365 (declare (ignore initargs))
366 (make-condition (class-name class)))
368 (defmethod allocate-instance ((class built-in-class) &rest initargs)
369 (declare (ignore initargs))
370 (error "Cannot allocate an instance of ~S." class)) ; So sayeth AMOP