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 ;;; (These are left over from the days when PCL was an add-on package
27 ;;; for a pre-CLOS Common Lisp. They shouldn't happen in a normal
28 ;;; build, of course, but they might happen if someone is experimenting
29 ;;; and debugging, and it's probably worth complaining if they do,
30 ;;; so we've left 'em in.)
31 (when (eq **boot-state** 'complete)
32 (error "Trying to load (or compile) PCL in an environment in which it~%~
33 has already been loaded. This doesn't work, you will have to~%~
34 get a fresh lisp (reboot) and then load PCL."))
36 (cerror "Try loading (or compiling) PCL anyways."
37 "Trying to load (or compile) PCL in an environment in which it~%~
38 has already been partially loaded. This may not work, you may~%~
39 need to get a fresh lisp (reboot) and then load PCL."))
41 #-sb-fluid (declaim (inline gdefinition))
42 (defun gdefinition (spec)
43 ;; This is null layer right now, but once FDEFINITION stops bypasssing
44 ;; fwrappers/encapsulations we can do that here.
47 (defun (setf gdefinition) (new-value spec)
48 ;; This is almost a null layer right now, but once (SETF
49 ;; FDEFINITION) stops bypasssing fwrappers/encapsulations we can do
51 (sb-c::note-name-defined spec :function) ; FIXME: do we need this? Why?
52 (setf (fdefinition spec) new-value))
54 ;;;; type specifier hackery
56 ;;; internal to this file
57 (defun coerce-to-class (class &optional make-forward-referenced-class-p)
59 (or (find-class class (not make-forward-referenced-class-p))
64 (defun specializer-from-type (type &aux args)
66 (return-from specializer-from-type (find-class type)))
68 (setq args (cdr type) type (car type)))
71 (class (coerce-to-class (car args)))
72 (prototype (make-instance 'class-prototype-specializer
73 :object (coerce-to-class (car args))))
74 (class-eq (class-eq-specializer (coerce-to-class (car args))))
75 (eql (intern-eql-specializer (car args))))))
76 ;; FIXME: do we still need this?
77 ((and (null args) (typep type 'classoid))
78 (or (classoid-pcl-class type)
79 (ensure-non-standard-class (classoid-name type) type)))
80 ((specializerp type) type)))
83 (defun type-from-specializer (specl)
87 (unless (member (car specl) '(class prototype class-eq eql))
88 (error "~S is not a legal specializer type." specl))
92 ;;maybe (or (find-class specl nil) (ensure-class specl)) instead?
93 (setq specl (find-class specl)))
94 (or (not (eq **boot-state** 'complete))
95 (specializerp specl)))
96 (specializer-type specl))
98 (error "~S is neither a type nor a specializer." specl))))
100 (defun type-class (type)
101 (declare (special *the-class-t*))
102 (setq type (type-from-specializer type))
106 (error "bad argument to TYPE-CLASS"))
108 (eql (class-of (cadr type)))
109 (prototype (class-of (cadr type))) ;?
110 (class-eq (cadr type))
111 (class (cadr type)))))
113 (defun class-eq-type (class)
114 (specializer-type (class-eq-specializer class)))
116 ;;; internal to this file..
118 ;;; These functions are a pale imitation of their namesake. They accept
119 ;;; class objects or types where they should.
120 (defun *normalize-type (type)
122 (if (member (car type) '(not and or))
123 `(,(car type) ,@(mapcar #'*normalize-type (cdr type)))
124 (if (null (cdr type))
125 (*normalize-type (car type))
128 (let ((class (find-class type nil)))
130 (let ((type (specializer-type class)))
131 (if (listp type) type `(,type)))
133 ((or (not (eq **boot-state** 'complete))
135 (specializer-type type))
137 (error "~S is not a type." type))))
139 ;;; internal to this file...
140 (defun convert-to-system-type (type)
142 ((not and or) `(,(car type) ,@(mapcar #'convert-to-system-type
144 ((class class-eq) ; class-eq is impossible to do right
145 (layout-classoid (class-wrapper (cadr type))))
147 (t (if (null (cdr type))
151 ;;; Writing the missing NOT and AND clauses will improve the quality
152 ;;; of code generated by GENERATE-DISCRIMINATION-NET, but calling
153 ;;; SUBTYPEP in place of just returning (VALUES NIL NIL) can be very
154 ;;; slow. *SUBTYPEP is used by PCL itself, and must be fast.
156 ;;; FIXME: SB-KERNEL has fast-and-not-quite-precise type code for use
157 ;;; in the compiler. Could we share some of it here?
158 (defun *subtypep (type1 type2)
159 (if (equal type1 type2)
161 (if (eq **boot-state** 'early)
162 (values (eq type1 type2) t)
163 (let ((*in-precompute-effective-methods-p* t))
164 (declare (special *in-precompute-effective-methods-p*))
165 ;; FIXME: *IN-PRECOMPUTE-EFFECTIVE-METHODS-P* is not a
166 ;; good name. It changes the way
167 ;; CLASS-APPLICABLE-USING-CLASS-P works.
168 (setq type1 (*normalize-type type1))
169 (setq type2 (*normalize-type type2))
172 (values nil nil)) ; XXX We should improve this.
174 (values nil nil)) ; XXX We should improve this.
175 ((eql wrapper-eq class-eq class)
176 (multiple-value-bind (app-p maybe-app-p)
177 (specializer-applicable-using-type-p type2 type1)
178 (values app-p (or app-p (not maybe-app-p)))))
180 (subtypep (convert-to-system-type type1)
181 (convert-to-system-type type2))))))))
183 (defvar *built-in-class-symbols* ())
184 (defvar *built-in-wrapper-symbols* ())
186 (defun get-built-in-class-symbol (class-name)
187 (or (cadr (assq class-name *built-in-class-symbols*))
188 (let ((symbol (make-class-symbol class-name)))
189 (push (list class-name symbol) *built-in-class-symbols*)
192 (defun get-built-in-wrapper-symbol (class-name)
193 (or (cadr (assq class-name *built-in-wrapper-symbols*))
194 (let ((symbol (make-wrapper-symbol class-name)))
195 (push (list class-name symbol) *built-in-wrapper-symbols*)
198 (defvar *standard-method-combination*)
200 (defun plist-value (object name)
201 (getf (object-plist object) name))
203 (defun (setf plist-value) (new-value object name)
205 (setf (getf (object-plist object) name) new-value)
207 (remf (object-plist object) name)
210 ;;;; built-in classes
212 ;;; Grovel over SB-KERNEL::*BUILT-IN-CLASSES* in order to set
213 ;;; SB-PCL:*BUILT-IN-CLASSES*.
214 (/show "about to set up SB-PCL::*BUILT-IN-CLASSES*")
215 (defvar *built-in-classes*
216 (labels ((direct-supers (class)
217 (/noshow "entering DIRECT-SUPERS" (classoid-name class))
218 (if (typep class 'built-in-classoid)
219 (built-in-classoid-direct-superclasses class)
220 (let ((inherits (layout-inherits
221 (classoid-layout class))))
223 (list (svref inherits (1- (length inherits)))))))
225 (/noshow "entering DIRECT-SUBS" (classoid-name class))
227 (let ((subs (classoid-subclasses class)))
230 (dohash ((sub v) subs)
233 (when (member class (direct-supers sub) :test #'eq)
236 (mapcar (lambda (kernel-bic-entry)
237 (/noshow "setting up" kernel-bic-entry)
238 (let* ((name (car kernel-bic-entry))
239 (class (find-classoid name))
241 (getf (cdr kernel-bic-entry) :prototype-form)))
244 ,(mapcar #'classoid-name (direct-supers class))
245 ,(mapcar #'classoid-name (direct-subs class))
249 (layout-classoid x)))
252 (classoid-layout class))))
254 (eval prototype-form)
255 ;; This is the default prototype value which
256 ;; was used, without explanation, by the CMU CL
257 ;; code we're derived from. Evidently it's safe
258 ;; in all relevant cases.
260 (remove-if (lambda (kernel-bic-entry)
261 (member (first kernel-bic-entry)
262 ;; I'm not sure why these are removed from
263 ;; the list, but that's what the original
264 ;; CMU CL code did. -- WHN 20000715
266 file-stream string-stream)))
267 sb-kernel::*built-in-classes*))))
268 (/noshow "done setting up SB-PCL::*BUILT-IN-CLASSES*")
270 ;;;; the classes that define the kernel of the metabraid
273 (:metaclass built-in-class))
275 (defclass function (t) ()
276 (:metaclass built-in-class))
278 (defclass stream (t) ()
279 (:metaclass built-in-class))
281 (defclass file-stream (stream) ()
282 (:metaclass built-in-class))
284 (defclass string-stream (stream) ()
285 (:metaclass built-in-class))
287 (defclass slot-object (t) ()
288 (:metaclass slot-class))
290 (defclass condition (slot-object) ()
291 (:metaclass condition-class))
293 (defclass structure-object (slot-object) ()
294 (:metaclass structure-class))
296 (defstruct (dead-beef-structure-object
297 (:constructor |STRUCTURE-OBJECT class constructor|)
300 (defclass standard-object (slot-object) ())
302 (defclass funcallable-standard-object (function standard-object)
304 (:metaclass funcallable-standard-class))
306 (defclass metaobject (standard-object) ())
308 (defclass generic-function (dependent-update-mixin
309 definition-source-mixin
311 funcallable-standard-object)
314 :initarg :documentation)
315 ;; We need to make a distinction between the methods initially set
316 ;; up by :METHOD options to DEFGENERIC and the ones set up later by
317 ;; DEFMETHOD, because ANSI specifies that executing DEFGENERIC on
318 ;; an already-DEFGENERICed function clears the methods set by the
319 ;; previous DEFGENERIC, but not methods set by DEFMETHOD. (Making
320 ;; this distinction seems a little kludgy, but it has the positive
321 ;; effect of making it so that loading a file a.lisp containing
322 ;; DEFGENERIC, then loading a second file b.lisp containing
323 ;; DEFMETHOD, then modifying and reloading a.lisp and/or b.lisp
324 ;; tends to leave the generic function in a state consistent with
325 ;; the most-recently-loaded state of a.lisp and b.lisp.)
328 :accessor generic-function-initial-methods))
329 (:metaclass funcallable-standard-class))
331 (defclass standard-generic-function (generic-function)
335 :reader generic-function-name)
338 :accessor generic-function-methods
341 :initarg :method-class
342 :accessor generic-function-method-class)
344 :initarg :method-combination
345 :accessor generic-function-method-combination)
347 ;; KLUDGE: AMOP specifies :DECLARATIONS, while ANSI specifies
348 ;; :DECLARE. Allow either (but FIXME: maybe a note or a warning
349 ;; might be appropriate).
350 :initarg :declarations
353 :accessor generic-function-declarations)
355 :initform (make-arg-info)
359 :accessor gf-dfun-state)
360 ;; Used to make DFUN-STATE & FIN-FUNCTION updates atomic.
362 :initform (sb-thread::make-spinlock :name "GF lock")
364 ;; Set to true by ADD-METHOD, REMOVE-METHOD; to false by
365 ;; MAYBE-UPDATE-INFO-FOR-GF.
368 :accessor gf-info-needs-update))
369 (:metaclass funcallable-standard-class)
370 (:default-initargs :method-class *the-class-standard-method*
371 :method-combination *standard-method-combination*))
373 (defclass method (metaobject) ())
375 (defclass standard-method (plist-mixin definition-source-mixin method)
376 ((%generic-function :initform nil :accessor method-generic-function)
377 (qualifiers :initform () :initarg :qualifiers :reader method-qualifiers)
378 (specializers :initform () :initarg :specializers
379 :reader method-specializers)
380 (lambda-list :initform () :initarg :lambda-list :reader method-lambda-list)
381 (%function :initform nil :initarg :function :reader method-function)
382 (%documentation :initform nil :initarg :documentation)))
384 (defclass accessor-method (standard-method)
385 ((slot-name :initform nil :initarg :slot-name
386 :reader accessor-method-slot-name)))
388 (defclass standard-accessor-method (accessor-method)
389 ((%slot-definition :initform nil :initarg :slot-definition
390 :reader accessor-method-slot-definition)))
392 (defclass standard-reader-method (standard-accessor-method) ())
393 (defclass standard-writer-method (standard-accessor-method) ())
394 ;;; an extension, apparently.
395 (defclass standard-boundp-method (standard-accessor-method) ())
397 ;;; for (SLOT-VALUE X 'FOO) / ACCESSOR-SLOT-VALUE optimization, which
398 ;;; can't be STANDARD-READER-METHOD because there is no associated
400 (defclass global-reader-method (accessor-method) ())
401 (defclass global-writer-method (accessor-method) ())
402 (defclass global-boundp-method (accessor-method) ())
404 (defclass method-combination (metaobject)
405 ((%documentation :initform nil :initarg :documentation)))
407 (defclass standard-method-combination (definition-source-mixin
410 :reader method-combination-type-name
413 :reader method-combination-options
416 (defclass long-method-combination (standard-method-combination)
419 :reader long-method-combination-function)
421 :initarg :args-lambda-list
422 :reader long-method-combination-args-lambda-list)))
424 (defclass short-method-combination (standard-method-combination)
426 :reader short-combination-operator
428 (identity-with-one-argument
429 :reader short-combination-identity-with-one-argument
430 :initarg :identity-with-one-argument)))
432 (defclass slot-definition (metaobject)
436 :accessor slot-definition-name)
440 :accessor slot-definition-initform)
443 :initarg :initfunction
444 :accessor slot-definition-initfunction)
448 :accessor slot-definition-readers)
452 :accessor slot-definition-writers)
456 :accessor slot-definition-initargs)
457 (%type :initform t :initarg :type :accessor slot-definition-type)
458 (%type-check-function :initform nil
459 :initarg type-check-function
460 :accessor slot-definition-type-check-function)
462 :initform nil :initarg :documentation
463 ;; KLUDGE: we need a reader for bootstrapping purposes, in
464 ;; COMPUTE-EFFECTIVE-SLOT-DEFINITION-INITARGS.
465 :reader %slot-definition-documentation)
466 (%class :initform nil :initarg :class :accessor slot-definition-class)))
468 (defclass standard-slot-definition (slot-definition)
472 :accessor slot-definition-allocation)
475 :initarg :allocation-class
476 :accessor slot-definition-allocation-class)))
478 (defclass condition-slot-definition (slot-definition)
482 :accessor slot-definition-allocation)
485 :initarg :allocation-class
486 :accessor slot-definition-allocation-class)))
488 (defclass structure-slot-definition (slot-definition)
489 ((defstruct-accessor-symbol
491 :initarg :defstruct-accessor-symbol
492 :accessor slot-definition-defstruct-accessor-symbol)
493 (internal-reader-function
495 :initarg :internal-reader-function
496 :accessor slot-definition-internal-reader-function)
497 (internal-writer-function
499 :initarg :internal-writer-function
500 :accessor slot-definition-internal-writer-function)))
502 (defclass direct-slot-definition (slot-definition)
505 (defclass effective-slot-definition (slot-definition)
506 ((reader-function ; (lambda (object) ...)
507 :accessor slot-definition-reader-function)
508 (writer-function ; (lambda (new-value object) ...)
509 :accessor slot-definition-writer-function)
510 (boundp-function ; (lambda (object) ...)
511 :accessor slot-definition-boundp-function)
515 (defclass standard-direct-slot-definition (standard-slot-definition
516 direct-slot-definition)
519 (defclass standard-effective-slot-definition (standard-slot-definition
520 effective-slot-definition)
521 ((location ; nil, a fixnum, a cons: (slot-name . value)
523 :accessor slot-definition-location)))
525 (defclass condition-direct-slot-definition (condition-slot-definition
526 direct-slot-definition)
529 (defclass condition-effective-slot-definition (condition-slot-definition
530 effective-slot-definition)
533 (defclass structure-direct-slot-definition (structure-slot-definition
534 direct-slot-definition)
537 (defclass structure-effective-slot-definition (structure-slot-definition
538 effective-slot-definition)
541 (defclass specializer (metaobject)
542 ;; KLUDGE: in sbcl-0.9.10.2 this was renamed from TYPE, which was an
543 ;; external symbol of the CL package and hence potentially collides
544 ;; with user code. Renaming this to %TYPE, however, is the coward's
545 ;; way out, because the objects that PCL puts in this slot aren't
546 ;; (quite) types: they are closer to kinds of specializer. However,
547 ;; the wholesale renaming and disentangling of specializers didn't
548 ;; appeal. (See also message <sqd5hrclb2.fsf@cam.ac.uk> and
549 ;; responses in comp.lang.lisp). -- CSR, 2006-02-27
550 ((%type :initform nil :reader specializer-type)))
552 ;;; STANDARD in this name doesn't mean "blessed by a standard" but
553 ;;; "comes as standard with PCL"; that is, it includes CLASS-EQ
554 ;;; and vestiges of PROTOTYPE specializers
555 (defclass standard-specializer (specializer) ())
557 (defclass specializer-with-object (specializer) ())
559 (defclass exact-class-specializer (specializer) ())
561 (defclass class-eq-specializer (standard-specializer
562 exact-class-specializer
563 specializer-with-object)
564 ((object :initarg :class
565 :reader specializer-class
566 :reader specializer-object)))
568 (defclass class-prototype-specializer (standard-specializer specializer-with-object)
569 ((object :initarg :class
570 :reader specializer-class
571 :reader specializer-object)))
573 (defclass eql-specializer (standard-specializer exact-class-specializer specializer-with-object)
574 ((object :initarg :object :reader specializer-object
575 :reader eql-specializer-object)))
577 (defvar *eql-specializer-table* (make-hash-table :test 'eql))
579 (defvar *eql-specializer-table-lock*
580 (sb-thread::make-spinlock :name "EQL-specializer table lock"))
582 (defun intern-eql-specializer (object)
583 ;; Need to lock, so that two threads don't get non-EQ specializers
584 ;; for an EQL object.
585 (sb-thread::with-spinlock (*eql-specializer-table-lock*)
586 (or (gethash object *eql-specializer-table*)
587 (setf (gethash object *eql-specializer-table*)
588 (make-instance 'eql-specializer :object object)))))
590 (defclass class (dependent-update-mixin
591 definition-source-mixin
592 standard-specializer)
597 (class-eq-specializer
599 :reader class-eq-specializer)
602 :reader class-direct-superclasses)
603 ;; Note: The (CLASS-)DIRECT-SUBCLASSES for STRUCTURE-CLASSes and
604 ;; CONDITION-CLASSes are lazily computed whenever the subclass info
605 ;; becomes available, i.e. when the PCL class is created.
608 :reader class-direct-subclasses)
610 :initform (cons nil nil))
613 :initarg :documentation)
614 ;; True if the class definition was compiled with a (SAFETY 3)
615 ;; optimization policy.
622 :reader class-finalized-p)))
624 (def!method make-load-form ((class class) &optional env)
625 ;; FIXME: should we not instead pass ENV to FIND-CLASS? Probably
626 ;; doesn't matter while all our environments are the same...
627 (declare (ignore env))
628 (let ((name (class-name class)))
629 (unless (and name (eq (find-class name nil) class))
630 (error "~@<Can't use anonymous or undefined class as constant: ~S~:@>"
632 `(find-class ',name)))
634 ;;; The class PCL-CLASS is an implementation-specific common
635 ;;; superclass of all specified subclasses of the class CLASS.
636 (defclass pcl-class (class)
637 ((%class-precedence-list
638 :reader class-precedence-list)
639 ;; KLUDGE: see note in CPL-OR-NIL
641 :reader cpl-available-p
645 :reader class-can-precede-list)
646 (incompatible-superclass-list
648 :accessor class-incompatible-superclass-list)
651 :reader class-wrapper)
654 :reader class-prototype)))
656 (defclass slot-class (pcl-class)
659 :reader class-direct-slots)
662 :reader class-slots)))
664 ;;; The class STD-CLASS is an implementation-specific common
665 ;;; superclass of the classes STANDARD-CLASS and
666 ;;; FUNCALLABLE-STANDARD-CLASS.
667 (defclass std-class (slot-class)
670 (defclass standard-class (std-class)
673 :direct-superclasses (list *the-class-standard-object*)))
675 (defclass funcallable-standard-class (std-class)
678 :direct-superclasses (list *the-class-funcallable-standard-object*)))
680 (defclass forward-referenced-class (pcl-class) ())
682 (defclass built-in-class (pcl-class) ())
684 (defclass condition-class (slot-class) ())
686 (defclass structure-class (slot-class)
687 ((defstruct-form :initform () :accessor class-defstruct-form)
688 (defstruct-constructor :initform nil :accessor class-defstruct-constructor)
689 (from-defclass-p :initform nil :initarg :from-defclass-p)))
691 (defclass definition-source-mixin (standard-object)
694 :reader definition-source
695 :initarg :definition-source)))
697 (defclass plist-mixin (standard-object)
698 ((plist :initform () :accessor object-plist :initarg plist)))
700 (defclass dependent-update-mixin (plist-mixin) ())
702 (defparameter *early-class-predicates*
703 '((specializer specializerp)
704 (standard-specializer standard-specializer-p)
705 (exact-class-specializer exact-class-specializer-p)
706 (class-eq-specializer class-eq-specializer-p)
707 (eql-specializer eql-specializer-p)
709 (slot-class slot-class-p)
710 (std-class std-class-p)
711 (standard-class standard-class-p)
712 (funcallable-standard-class funcallable-standard-class-p)
713 (condition-class condition-class-p)
714 (structure-class structure-class-p)
715 (forward-referenced-class forward-referenced-class-p)
717 (standard-method standard-method-p)
718 (accessor-method accessor-method-p)
719 (standard-accessor-method standard-accessor-method-p)
720 (standard-reader-method standard-reader-method-p)
721 (standard-writer-method standard-writer-method-p)
722 (standard-boundp-method standard-boundp-method-p)
723 (global-reader-method global-reader-method-p)
724 (global-writer-method global-writer-method-p)
725 (global-boundp-method global-boundp-method-p)
726 (generic-function generic-function-p)
727 (standard-generic-function standard-generic-function-p)
728 (method-combination method-combination-p)
729 (long-method-combination long-method-combination-p)
730 (short-method-combination short-method-combination-p)))