0.6.11.16:
[sbcl.git] / src / pcl / slots.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 ;;;; ANSI CL condition for unbound slots
27
28 (define-condition unbound-slot (cell-error)
29   ((instance :reader unbound-slot-instance :initarg :instance)
30    (slot :reader unbound-slot-slot :initarg :slot))
31   (:report (lambda(condition stream)
32              (format stream "The slot ~S is unbound in the object ~S."
33                      (unbound-slot-slot condition)
34                      (unbound-slot-instance condition)))))
35
36 (defmethod wrapper-fetcher ((class standard-class))
37   'std-instance-wrapper)
38
39 (defmethod slots-fetcher ((class standard-class))
40   'std-instance-slots)
41
42 (defmethod raw-instance-allocator ((class standard-class))
43   'allocate-standard-instance)
44
45 ;;; These four functions work on std-instances and fsc-instances. These are
46 ;;; instances for which it is possible to change the wrapper and the slots.
47 ;;;
48 ;;; For these kinds of instances, most specified methods from the instance
49 ;;; structure protocol are promoted to the implementation-specific class
50 ;;; std-class. Many of these methods call these four functions.
51
52 (defun set-wrapper (inst new)
53   (cond ((std-instance-p inst)
54          (setf (std-instance-wrapper inst) new))
55         ((fsc-instance-p inst)
56          (setf (fsc-instance-wrapper inst) new))
57         (t
58          (error "unrecognized instance type"))))
59
60 (defun swap-wrappers-and-slots (i1 i2)
61   (sb-sys:without-interrupts
62    (cond ((std-instance-p i1)
63           (let ((w1 (std-instance-wrapper i1))
64                 (s1 (std-instance-slots i1)))
65             (setf (std-instance-wrapper i1) (std-instance-wrapper i2))
66             (setf (std-instance-slots i1) (std-instance-slots i2))
67             (setf (std-instance-wrapper i2) w1)
68             (setf (std-instance-slots i2) s1)))
69          ((fsc-instance-p i1)
70           (let ((w1 (fsc-instance-wrapper i1))
71                 (s1 (fsc-instance-slots i1)))
72             (setf (fsc-instance-wrapper i1) (fsc-instance-wrapper i2))
73             (setf (fsc-instance-slots i1) (fsc-instance-slots i2))
74             (setf (fsc-instance-wrapper i2) w1)
75             (setf (fsc-instance-slots i2) s1)))
76          (t
77           (error "unrecognized instance type")))))
78 \f
79 (defun get-class-slot-value-1 (object wrapper slot-name)
80   (let ((entry (assoc slot-name (wrapper-class-slots wrapper))))
81     (if (null entry)
82         (slot-missing (wrapper-class wrapper) object slot-name 'slot-value)
83         (if (eq (cdr entry) +slot-unbound+)
84             (slot-unbound (wrapper-class wrapper) object slot-name)
85             (cdr entry)))))
86
87 (defun set-class-slot-value-1 (new-value object wrapper slot-name)
88   (let ((entry (assoc slot-name (wrapper-class-slots wrapper))))
89     (if (null entry)
90         (slot-missing (wrapper-class wrapper)
91                       object
92                       slot-name
93                       'setf
94                       new-value)
95         (setf (cdr entry) new-value))))
96
97 (defmethod class-slot-value ((class std-class) slot-name)
98   (let ((wrapper (class-wrapper class))
99         (prototype (class-prototype class)))
100     (get-class-slot-value-1 prototype wrapper slot-name)))
101
102 (defmethod (setf class-slot-value) (nv (class std-class) slot-name)
103   (let ((wrapper (class-wrapper class))
104         (prototype (class-prototype class)))
105     (set-class-slot-value-1 nv prototype wrapper slot-name)))
106 \f
107 (defun find-slot-definition (class slot-name)
108   (dolist (slot (class-slots class) nil)
109     (when (eql slot-name (slot-definition-name slot))
110       (return slot))))
111
112 (defun slot-value (object slot-name)
113   (let* ((class (class-of object))
114          (slot-definition (find-slot-definition class slot-name)))
115     (if (null slot-definition)
116         (slot-missing class object slot-name 'slot-value)
117         (slot-value-using-class class object slot-definition))))
118
119 (setf (gdefinition 'slot-value-normal) #'slot-value)
120
121 (define-compiler-macro slot-value (object-form slot-name-form)
122   (if (and (constantp slot-name-form)
123            (let ((slot-name (eval slot-name-form)))
124              (and (symbolp slot-name) (symbol-package slot-name))))
125       `(accessor-slot-value ,object-form ,slot-name-form)
126       `(slot-value-normal ,object-form ,slot-name-form)))
127
128 (defun set-slot-value (object slot-name new-value)
129   (let* ((class (class-of object))
130          (slot-definition (find-slot-definition class slot-name)))
131     (if (null slot-definition)
132         (slot-missing class object slot-name 'setf new-value)
133         (setf (slot-value-using-class class object slot-definition)
134               new-value))))
135
136 (setf (gdefinition 'set-slot-value-normal) #'set-slot-value)
137
138 (define-compiler-macro set-slot-value (object-form
139                                        slot-name-form
140                                        new-value-form)
141   (if (and (constantp slot-name-form)
142            (let ((slot-name (eval slot-name-form)))
143              (and (symbolp slot-name) (symbol-package slot-name))))
144       `(accessor-set-slot-value ,object-form ,slot-name-form ,new-value-form)
145       `(set-slot-value-normal ,object-form ,slot-name-form ,new-value-form)))
146
147 (defconstant +optimize-slot-boundp+ nil)
148
149 (defun slot-boundp (object slot-name)
150   (let* ((class (class-of object))
151          (slot-definition (find-slot-definition class slot-name)))
152     (if (null slot-definition)
153         (slot-missing class object slot-name 'slot-boundp)
154         (slot-boundp-using-class class object slot-definition))))
155
156 (setf (gdefinition 'slot-boundp-normal) #'slot-boundp)
157
158 (define-compiler-macro slot-boundp (object-form slot-name-form)
159   (if (and (constantp slot-name-form)
160            (let ((slot-name (eval slot-name-form)))
161              (and (symbolp slot-name) (symbol-package slot-name))))
162       `(accessor-slot-boundp ,object-form ,slot-name-form)
163       `(slot-boundp-normal ,object-form ,slot-name-form)))
164
165 (defun slot-makunbound (object slot-name)
166   (let* ((class (class-of object))
167          (slot-definition (find-slot-definition class slot-name)))
168     (if (null slot-definition)
169         (slot-missing class object slot-name 'slot-makunbound)
170         (slot-makunbound-using-class class object slot-definition))))
171
172 (defun slot-exists-p (object slot-name)
173   (let ((class (class-of object)))
174     (not (null (find-slot-definition class slot-name)))))
175
176 ;;; This isn't documented, but is used within PCL in a number of print
177 ;;; object methods. (See NAMED-OBJECT-PRINT-FUNCTION.)
178 (defun slot-value-or-default (object slot-name &optional (default "unbound"))
179   (if (slot-boundp object slot-name)
180       (slot-value object slot-name)
181       default))
182 \f
183 (defun standard-instance-access (instance location)
184   (clos-slots-ref (std-instance-slots instance) location))
185
186 (defun funcallable-standard-instance-access (instance location)
187   (clos-slots-ref (fsc-instance-slots instance) location))
188
189 (defmethod slot-value-using-class ((class std-class)
190                                    (object std-object)
191                                    (slotd standard-effective-slot-definition))
192   (let* ((location (slot-definition-location slotd))
193          (value (typecase location
194                   (fixnum
195                    (cond ((std-instance-p object)
196                           ;; FIXME: EQ T (WRAPPER-STATE ..) is better done
197                           ;; through INVALID-WRAPPER-P (here and below).
198                           (unless (eq t (wrapper-state (std-instance-wrapper
199                                                         object)))
200                             (check-wrapper-validity object))
201                           (clos-slots-ref (std-instance-slots object)
202                                           location))
203                          ((fsc-instance-p object)
204                           (unless (eq t (wrapper-state (fsc-instance-wrapper
205                                                         object)))
206                             (check-wrapper-validity object))
207                           (clos-slots-ref (fsc-instance-slots object)
208                                           location))
209                          (t (error "unrecognized instance type"))))
210                   (cons
211                    (cdr location))
212                   (t
213                    (error "~@<The slot ~S has neither :INSTANCE nor :CLASS ~
214                            allocation, so it can't be read by the default ~
215                            ~S method.~@:>"
216                           slotd 'slot-value-using-class)))))
217     (if (eq value +slot-unbound+)
218         (slot-unbound class object (slot-definition-name slotd))
219         value)))
220
221 (defmethod (setf slot-value-using-class)
222            (new-value (class std-class)
223                       (object std-object)
224                       (slotd standard-effective-slot-definition))
225   (let ((location (slot-definition-location slotd)))
226     (typecase location
227       (fixnum
228        (cond ((std-instance-p object)
229               (unless (eq t (wrapper-state (std-instance-wrapper object)))
230                 (check-wrapper-validity object))
231                (setf (clos-slots-ref (std-instance-slots object) location)
232                      new-value))
233              ((fsc-instance-p object)
234               (unless (eq t (wrapper-state (fsc-instance-wrapper object)))
235                 (check-wrapper-validity object))
236                (setf (clos-slots-ref (fsc-instance-slots object) location)
237                      new-value))
238              (t (error "unrecognized instance type"))))
239       (cons
240        (setf (cdr location) new-value))
241       (t
242        (error "~@<The slot ~S has neither :INSTANCE nor :CLASS allocation, ~
243                    so it can't be written by the default ~S method.~:@>"
244               slotd '(setf slot-value-using-class))))))
245
246 (defmethod slot-boundp-using-class
247            ((class std-class)
248             (object std-object)
249             (slotd standard-effective-slot-definition))
250   (let* ((location (slot-definition-location slotd))
251          (value (typecase location
252                   (fixnum
253                    (cond ((std-instance-p object)
254                           (unless (eq t (wrapper-state (std-instance-wrapper
255                                                         object)))
256                             (check-wrapper-validity object))
257                           (clos-slots-ref (std-instance-slots object)
258                                           location))
259                          ((fsc-instance-p object)
260                           (unless (eq t (wrapper-state (fsc-instance-wrapper
261                                                         object)))
262                             (check-wrapper-validity object))
263                           (clos-slots-ref (fsc-instance-slots object)
264                                           location))
265                          (t (error "unrecognized instance type"))))
266                   (cons
267                    (cdr location))
268                   (t
269                    (error "~@<The slot ~S has neither :INSTANCE nor :CLASS ~
270                            allocation, so it can't be read by the default ~S ~
271                            method.~@:>"
272                           slotd 'slot-boundp-using-class)))))
273     (not (eq value +slot-unbound+))))
274
275 (defmethod slot-makunbound-using-class
276            ((class std-class)
277             (object std-object)
278             (slotd standard-effective-slot-definition))
279   (let ((location (slot-definition-location slotd)))
280     (typecase location
281       (fixnum
282        (cond ((std-instance-p object)
283               (unless (eq t (wrapper-state (std-instance-wrapper object)))
284                 (check-wrapper-validity object))
285                (setf (clos-slots-ref (std-instance-slots object) location)
286                      +slot-unbound+))
287              ((fsc-instance-p object)
288               (unless (eq t (wrapper-state (fsc-instance-wrapper object)))
289                 (check-wrapper-validity object))
290                (setf (clos-slots-ref (fsc-instance-slots object) location)
291                      +slot-unbound+))
292              (t (error "unrecognized instance type"))))
293       (cons
294        (setf (cdr location) +slot-unbound+))
295       (t
296        (error "~@<The slot ~S has neither :INSTANCE nor :CLASS allocation, ~
297                so it can't be written by the default ~S method.~@:>"
298               slotd 'slot-makunbound-using-class))))
299   nil)
300
301 (defmethod slot-value-using-class
302     ((class structure-class)
303      (object structure-object)
304      (slotd structure-effective-slot-definition))
305   (let* ((function (slot-definition-internal-reader-function slotd))
306          (value (funcall function object)))
307     (declare (type function function))
308     (if (eq value +slot-unbound+)
309         (slot-unbound class object (slot-definition-name slotd))
310         value)))
311
312 (defmethod (setf slot-value-using-class)
313     (new-value (class structure-class)
314                (object structure-object)
315                (slotd structure-effective-slot-definition))
316   (let ((function (slot-definition-internal-writer-function slotd)))
317     (declare (type function function))
318     (funcall function new-value object)))
319
320 (defmethod slot-boundp-using-class
321            ((class structure-class)
322             (object structure-object)
323             (slotd structure-effective-slot-definition))
324   t)
325
326 (defmethod slot-makunbound-using-class
327            ((class structure-class)
328             (object structure-object)
329             (slotd structure-effective-slot-definition))
330   (error "Structure slots can't be unbound."))
331 \f
332 (defmethod slot-missing
333            ((class t) instance slot-name operation &optional new-value)
334   (error "~@<When attempting to ~A, the slot ~S is missing from the ~
335           object ~S.~@:>"
336          (ecase operation
337            (slot-value "read the slot's value (slot-value)")
338            (setf (format nil
339                          "set the slot's value to ~S (SETF of SLOT-VALUE)"
340                          new-value))
341            (slot-boundp "test to see whether slot is bound (SLOT-BOUNDP)")
342            (slot-makunbound "make the slot unbound (SLOT-MAKUNBOUND)"))
343          slot-name
344          instance))
345
346 (defmethod slot-unbound ((class t) instance slot-name)
347   (error 'unbound-slot :slot slot-name :instance instance))
348
349 (defun slot-unbound-internal (instance position)
350   (slot-unbound (class-of instance) instance
351                 (etypecase position
352                   (fixnum
353                    (nth position
354                         (wrapper-instance-slots-layout (wrapper-of instance))))
355                   (cons
356                    (car position)))))
357 \f
358 (defmethod allocate-instance ((class standard-class) &rest initargs)
359   (declare (ignore initargs))
360   (unless (class-finalized-p class) (finalize-inheritance class))
361   (allocate-standard-instance (class-wrapper class)))
362
363 (defmethod allocate-instance ((class structure-class) &rest initargs)
364   (declare (ignore initargs))
365   (let ((constructor (class-defstruct-constructor class)))
366     (if constructor
367         (funcall constructor)
368         (error "can't allocate an instance of class ~S" (class-name class)))))