source: trunk/abcl/src/org/armedbear/lisp/clos.lisp @ 13725

Last change on this file since 13725 was 13725, checked in by ehuelsmann, 9 years ago

Patch by Rudi Schlatte: Move EqualSpecializerObject? to clos.lisp.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 138.6 KB
Line 
1;;; clos.lisp
2;;;
3;;; Copyright (C) 2003-2007 Peter Graves
4;;; Copyright (C) 2010 Mark Evenson
5;;; $Id: clos.lisp 13725 2012-01-06 22:14:08Z ehuelsmann $
6;;;
7;;; This program is free software; you can redistribute it and/or
8;;; modify it under the terms of the GNU General Public License
9;;; as published by the Free Software Foundation; either version 2
10;;; of the License, or (at your option) any later version.
11;;;
12;;; This program is distributed in the hope that it will be useful,
13;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15;;; GNU General Public License for more details.
16;;;
17;;; You should have received a copy of the GNU General Public License
18;;; along with this program; if not, write to the Free Software
19;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20;;;
21;;; As a special exception, the copyright holders of this library give you
22;;; permission to link this library with independent modules to produce an
23;;; executable, regardless of the license terms of these independent
24;;; modules, and to copy and distribute the resulting executable under
25;;; terms of your choice, provided that you also meet, for each linked
26;;; independent module, the terms and conditions of the license of that
27;;; module.  An independent module is a module which is not derived from
28;;; or based on this library.  If you modify this library, you may extend
29;;; this exception to your version of the library, but you are not
30;;; obligated to do so.  If you do not wish to do so, delete this
31;;; exception statement from your version.
32
33;;; Originally based on Closette.
34
35;;; Closette Version 1.0 (February 10, 1991)
36;;;
37;;; Copyright (c) 1990, 1991 Xerox Corporation.
38;;; All rights reserved.
39;;;
40;;; Use and copying of this software and preparation of derivative works
41;;; based upon this software are permitted.  Any distribution of this
42;;; software or derivative works must comply with all applicable United
43;;; States export control laws.
44;;;
45;;; This software is made available AS IS, and Xerox Corporation makes no
46;;; warranty about the software, its performance or its conformity to any
47;;; specification.
48;;;
49;;; Closette is an implementation of a subset of CLOS with a metaobject
50;;; protocol as described in "The Art of The Metaobject Protocol",
51;;; MIT Press, 1991.
52
53(in-package #:mop)
54
55;;
56;;
57;;
58;; In order to bootstrap CLOS, first implement the required API as
59;; normal functions which only apply to the "root" metaclass
60;; STANDARD-CLASS.
61;;
62;; After putting the normal functions in place, the building blocks
63;; are in place to gradually swap the normal functions with
64;; generic functions and methods.
65;;
66;; Some functionality implemented in the temporary regular functions
67;; needs to be available later as a method definition to be dispatched
68;; to for the STANDARD-CLASS case.  To prevent repeated code, the
69;; functions are implemented in functions by the same name as the
70;; API functions, but with the STD- prefix.
71;;
72;; When hacking this file, note that some important parts are implemented
73;; in the Java world. These Java bits can be found in the files
74;;
75;; * LispClass.java
76;; * SlotClass.java
77;; * StandardClass.java
78;; * BuiltInClass.java
79;; * StandardObject.java
80;; * StandardObjectFunctions.java
81;; * Layout.java
82;;
83;; In case of function names, those defined on the Java side can be
84;; recognized by their prefixed percent sign.
85;;
86;; The API functions need to be declaimed NOTINLINE explicitly, because
87;; that prevents inlining in the current FASL (which is allowed by the
88;; CLHS without the declaration); this is a hard requirement to in order
89;; to be able to swap the symbol's function slot with a generic function
90;; later on - with it actually being used.
91;;
92;;
93;;
94;; ### Note that the "declares all API functions as regular functions"
95;; isn't true when I write the above, but it's definitely the target.
96;;
97;;
98
99(export '(class-precedence-list class-slots
100          slot-definition-name))
101(defconstant +the-standard-class+ (find-class 'standard-class))
102(defconstant +the-structure-class+ (find-class 'structure-class))
103(defconstant +the-standard-object-class+ (find-class 'standard-object))
104(defconstant +the-standard-method-class+ (find-class 'standard-method))
105(defconstant +the-standard-reader-method-class+
106  (find-class 'standard-reader-method))
107(defconstant +the-standard-generic-function-class+
108  (find-class 'standard-generic-function))
109(defconstant +the-T-class+ (find-class 'T))
110(defconstant +the-standard-slot-definition-class+ (find-class 'standard-slot-definition))
111(defconstant +the-standard-direct-slot-definition-class+ (find-class 'standard-direct-slot-definition))
112(defconstant +the-standard-effective-slot-definition-class+ (find-class 'standard-effective-slot-definition))
113
114;; Don't use DEFVAR, because that disallows loading clos.lisp
115;; after compiling it: the binding won't get assigned to T anymore
116(defparameter *clos-booting* t)
117
118(defmacro define-class->%class-forwarder (name)
119  (let* (($name (if (consp name) (cadr name) name))
120         (%name (intern (concatenate 'string
121                                     "%"
122                                     (if (consp name)
123                                         (symbol-name 'set-) "")
124                                     (symbol-name $name))
125                        (symbol-package $name))))
126    `(progn
127       (declaim (notinline ,name))
128       (defun ,name (&rest args)
129         (apply #',%name args)))))
130
131(define-class->%class-forwarder class-name)
132(define-class->%class-forwarder (setf class-name))
133(define-class->%class-forwarder class-slots)
134(define-class->%class-forwarder (setf class-slots))
135(define-class->%class-forwarder class-direct-slots)
136(define-class->%class-forwarder (setf class-direct-slots))
137(define-class->%class-forwarder class-layout)
138(define-class->%class-forwarder (setf class-layout))
139(define-class->%class-forwarder class-direct-superclasses)
140(define-class->%class-forwarder (setf class-direct-superclasses))
141(define-class->%class-forwarder class-direct-subclasses)
142(define-class->%class-forwarder (setf class-direct-subclasses))
143(define-class->%class-forwarder class-direct-methods)
144(define-class->%class-forwarder (setf class-direct-methods))
145(define-class->%class-forwarder class-precedence-list)
146(define-class->%class-forwarder (setf class-precedence-list))
147(define-class->%class-forwarder class-finalized-p)
148(define-class->%class-forwarder (setf class-finalized-p))
149(define-class->%class-forwarder class-default-initargs)
150(define-class->%class-forwarder (setf class-default-initargs))
151(define-class->%class-forwarder class-direct-default-initargs)
152(define-class->%class-forwarder (setf class-direct-default-initargs))
153
154(defun no-applicable-method (generic-function &rest args)
155  (error "There is no applicable method for the generic function ~S when called with arguments ~S."
156         generic-function
157         args))
158
159
160
161(defmacro push-on-end (value location)
162  `(setf ,location (nconc ,location (list ,value))))
163
164;;; (SETF GETF*) is like (SETF GETF) except that it always changes the list,
165;;; which must be non-nil.
166
167(defun (setf getf*) (new-value plist key)
168  (block body
169    (do ((x plist (cddr x)))
170        ((null x))
171      (when (eq (car x) key)
172        (setf (car (cdr x)) new-value)
173        (return-from body new-value)))
174    (push-on-end key plist)
175    (push-on-end new-value plist)
176    new-value))
177
178(defun mapappend (fun &rest args)
179  (if (some #'null args)
180      ()
181      (append (apply fun (mapcar #'car args))
182              (apply #'mapappend fun (mapcar #'cdr args)))))
183
184(defun mapplist (fun x)
185  (if (null x)
186      ()
187      (cons (funcall fun (car x) (cadr x))
188            (mapplist fun (cddr x)))))
189
190(defsetf std-instance-layout %set-std-instance-layout)
191(defsetf standard-instance-access %set-standard-instance-access)
192
193(defun (setf find-class) (new-value symbol &optional errorp environment)
194  (declare (ignore errorp environment))
195  (%set-find-class symbol new-value))
196
197(defun canonicalize-direct-slots (direct-slots)
198  `(list ,@(mapcar #'canonicalize-direct-slot direct-slots)))
199
200(defun canonicalize-direct-slot (spec)
201  (if (symbolp spec)
202      `(list :name ',spec)
203      (let ((name (car spec))
204            (initfunction nil)
205            (initform nil)
206            (initargs ())
207            (type nil)
208            (allocation nil)
209            (documentation nil)
210            (readers ())
211            (writers ())
212            (other-options ())
213            (non-std-options ()))
214        (do ((olist (cdr spec) (cddr olist)))
215            ((null olist))
216          (case (car olist)
217            (:initform
218             (when initform
219               (error 'program-error
220                      "duplicate slot option :INITFORM for slot named ~S"
221                      name))
222             (setq initfunction t)
223             (setq initform (cadr olist)))
224            (:initarg
225             (push-on-end (cadr olist) initargs))
226            (:allocation
227             (when allocation
228               (error 'program-error
229                      "duplicate slot option :ALLOCATION for slot named ~S"
230                      name))
231             (setf allocation (cadr olist))
232             (push-on-end (car olist) other-options)
233             (push-on-end (cadr olist) other-options))
234            (:type
235             (when type
236               (error 'program-error
237                      "duplicate slot option :TYPE for slot named ~S"
238                      name))
239             (setf type (cadr olist))) ;; FIXME type is ignored
240            (:documentation
241             (when documentation
242               (error 'program-error
243                      "duplicate slot option :DOCUMENTATION for slot named ~S"
244                      name))
245             (setf documentation (cadr olist))) ;; FIXME documentation is ignored
246            (:reader
247             (maybe-note-name-defined (cadr olist))
248             (push-on-end (cadr olist) readers))
249            (:writer
250             (maybe-note-name-defined (cadr olist))
251             (push-on-end (cadr olist) writers))
252            (:accessor
253             (maybe-note-name-defined (cadr olist))
254             (push-on-end (cadr olist) readers)
255             (push-on-end `(setf ,(cadr olist)) writers))
256            (t
257             (push-on-end `(quote ,(car olist)) non-std-options)
258             (push-on-end `(quote ,(cadr olist)) non-std-options))))
259        `(list
260          :name ',name
261          ,@(when initfunction
262              `(:initform ',initform
263                :initfunction ,(if (eq allocation :class)
264                                   ;; CLHS specifies the initform for a
265                                   ;; class allocation level slot needs
266                                   ;; to be evaluated in the dynamic
267                                   ;; extent of the DEFCLASS form
268                                   (let ((var (gensym)))
269                                     `(let ((,var ,initform))
270                                        (lambda () ,var)))
271                                 `(lambda () ,initform))))
272          ,@(when initargs `(:initargs ',initargs))
273          ,@(when readers `(:readers ',readers))
274          ,@(when writers `(:writers ',writers))
275          ,@other-options
276    ,@non-std-options))))
277
278(defun maybe-note-name-defined (name)
279  (when (fboundp 'note-name-defined)
280    (note-name-defined name)))
281
282(defun canonicalize-direct-superclasses (direct-superclasses)
283  (let ((classes '()))
284    (dolist (class-specifier direct-superclasses)
285      (if (classp class-specifier)
286          (push class-specifier classes)
287          (let ((class (find-class class-specifier nil)))
288            (unless class
289              (setf class (make-forward-referenced-class class-specifier)))
290            (push class classes))))
291    (nreverse classes)))
292
293(defun canonicalize-defclass-options (options)
294  (mapappend #'canonicalize-defclass-option options))
295
296(defun canonicalize-defclass-option (option)
297  (case (car option)
298    (:metaclass
299     (list ':metaclass
300           `(find-class ',(cadr option))))
301    (:default-initargs
302     (list
303      ':direct-default-initargs
304      `(list ,@(mapappend
305                #'(lambda (x) x)
306                (mapplist
307                 #'(lambda (key value)
308                    `(',key ,(make-initfunction value)))
309                 (cdr option))))))
310    ((:documentation :report)
311     (list (car option) `',(cadr option)))
312    (t (list `(quote ,(car option)) `(quote ,(cdr option))))))
313
314(defun make-initfunction (initform)
315  `(function (lambda () ,initform)))
316
317(defun slot-definition-allocation (slot-definition)
318  (%slot-definition-allocation slot-definition))
319
320(declaim (notinline (setf slot-definition-allocation)))
321(defun (setf slot-definition-allocation) (value slot-definition)
322  (set-slot-definition-allocation slot-definition value))
323
324(defun slot-definition-initargs (slot-definition)
325  (%slot-definition-initargs slot-definition))
326
327(declaim (notinline (setf slot-definition-initargs)))
328(defun (setf slot-definition-initargs) (value slot-definition)
329  (set-slot-definition-initargs slot-definition value))
330
331(defun slot-definition-initform (slot-definition)
332  (%slot-definition-initform slot-definition))
333
334(declaim (notinline (setf slot-definition-initform)))
335(defun (setf slot-definition-initform) (value slot-definition)
336  (set-slot-definition-initform slot-definition value))
337
338(defun slot-definition-initfunction (slot-definition)
339  (%slot-definition-initfunction slot-definition))
340
341(declaim (notinline (setf slot-definition-initfunction)))
342(defun (setf slot-definition-initfunction) (value slot-definition)
343  (set-slot-definition-initfunction slot-definition value))
344
345(defun slot-definition-name (slot-definition)
346  (%slot-definition-name slot-definition))
347
348(declaim (notinline (setf slot-definition-name)))
349(defun (setf slot-definition-name) (value slot-definition)
350  (set-slot-definition-name slot-definition value))
351
352(defun slot-definition-readers (slot-definition)
353  (%slot-definition-readers slot-definition))
354
355(declaim (notinline (setf slot-definition-readers)))
356(defun (setf slot-definition-readers) (value slot-definition)
357  (set-slot-definition-readers slot-definition value))
358
359(defun slot-definition-writers (slot-definition)
360  (%slot-definition-writers slot-definition))
361
362(declaim (notinline (setf slot-definition-writers)))
363(defun (setf slot-definition-writers) (value slot-definition)
364  (set-slot-definition-writers slot-definition value))
365
366(defun slot-definition-allocation-class (slot-definition)
367  (%slot-definition-allocation-class slot-definition))
368
369(declaim (notinline (setf slot-definition-allocation-class)))
370(defun (setf slot-definition-allocation-class) (value slot-definition)
371  (set-slot-definition-allocation-class slot-definition value))
372
373(defun slot-definition-location (slot-definition)
374  (%slot-definition-location slot-definition))
375
376(declaim (notinline (setf slot-definition-location-class)))
377(defun (setf slot-definition-location) (value slot-definition)
378  (set-slot-definition-location slot-definition value))
379
380(defun init-slot-definition (slot &key name
381                             (initargs ())
382                             (initform nil)
383                             (initfunction nil)
384                             (readers ())
385                             (writers ())
386                             (allocation :instance)
387                             (allocation-class nil))
388  (setf (slot-definition-name slot) name)
389  (setf (slot-definition-initargs slot) initargs)
390  (setf (slot-definition-initform slot) initform)
391  (setf (slot-definition-initfunction slot) initfunction)
392  (setf (slot-definition-readers slot) readers)
393  (setf (slot-definition-writers slot) writers)
394  (setf (slot-definition-allocation slot) allocation)
395  (setf (slot-definition-allocation-class slot) allocation-class)
396  slot)
397
398(defun make-direct-slot-definition (class &rest args)
399  (let ((slot-class (direct-slot-definition-class class)))
400    (if (eq slot-class +the-standard-direct-slot-definition-class+)
401  (let ((slot (make-slot-definition +the-standard-direct-slot-definition-class+)))
402    (apply #'init-slot-definition slot :allocation-class class args)
403    slot)
404  (progn
405    (let ((slot (apply #'make-instance slot-class :allocation-class class
406           args)))
407      slot)))))
408
409(defun make-effective-slot-definition (class &rest args)
410  (let ((slot-class (effective-slot-definition-class class)))
411    (if (eq slot-class +the-standard-effective-slot-definition-class+)
412  (let ((slot (make-slot-definition +the-standard-effective-slot-definition-class+)))
413    (apply #'init-slot-definition slot args)
414    slot)
415  (progn
416    (let ((slot (apply #'make-instance slot-class args)))
417      slot)))))
418
419;;; finalize-inheritance
420
421(defun std-compute-class-default-initargs (class)
422  (mapcan #'(lambda (c)
423              (copy-list
424               (class-direct-default-initargs c)))
425          (class-precedence-list class)))
426
427(defun std-finalize-inheritance (class)
428  ;; In case the class is already finalized, return
429  ;; immediately, as per AMOP.
430  (when (class-finalized-p class)
431    (return-from std-finalize-inheritance))
432  (setf (class-precedence-list class)
433   (funcall (if (eq (class-of class) +the-standard-class+)
434                #'std-compute-class-precedence-list
435                #'compute-class-precedence-list)
436            class))
437  (setf (class-slots class)
438                   (funcall (if (eq (class-of class) +the-standard-class+)
439                                #'std-compute-slots
440                     #'compute-slots) class))
441  (let ((old-layout (class-layout class))
442        (length 0)
443        (instance-slots '())
444        (shared-slots '()))
445    (dolist (slot (class-slots class))
446      (case (slot-definition-allocation slot)
447        (:instance
448         (setf (slot-definition-location slot) length)
449         (incf length)
450         (push (slot-definition-name slot) instance-slots))
451        (:class
452         (unless (slot-definition-location slot)
453           (let ((allocation-class (slot-definition-allocation-class slot)))
454             (setf (slot-definition-location slot)
455       (if (eq allocation-class class)
456           (cons (slot-definition-name slot) +slot-unbound+)
457           (slot-location allocation-class (slot-definition-name slot))))))
458         (push (slot-definition-location slot) shared-slots))))
459    (when old-layout
460      ;; Redefined class: initialize added shared slots.
461      (dolist (location shared-slots)
462        (let* ((slot-name (car location))
463               (old-location (layout-slot-location old-layout slot-name)))
464          (unless old-location
465            (let* ((slot-definition (find slot-name (class-slots class) :key 'slot-definition-name))
466                   (initfunction (slot-definition-initfunction slot-definition)))
467              (when initfunction
468                (setf (cdr location) (funcall initfunction))))))))
469    (setf (class-layout class)
470          (make-layout class (nreverse instance-slots) (nreverse shared-slots))))
471  (setf (class-default-initargs class)
472        (std-compute-class-default-initargs class))
473  (setf (class-finalized-p class) t))
474
475(declaim (notinline finalize-inheritance))
476(defun finalize-inheritance (class)
477  (std-finalize-inheritance class))
478
479
480;;; Class precedence lists
481
482(defun std-compute-class-precedence-list (class)
483  (let ((classes-to-order (collect-superclasses* class)))
484    (dolist (super classes-to-order)
485      (when (typep super 'forward-referenced-class)
486        (error "Can't compute class precedence list for class ~A ~
487                which depends on forward referenced class ~A." class super)))
488    (topological-sort classes-to-order
489                      (remove-duplicates
490                       (mapappend #'local-precedence-ordering
491                                  classes-to-order))
492                      #'std-tie-breaker-rule)))
493
494;;; topological-sort implements the standard algorithm for topologically
495;;; sorting an arbitrary set of elements while honoring the precedence
496;;; constraints given by a set of (X,Y) pairs that indicate that element
497;;; X must precede element Y.  The tie-breaker procedure is called when it
498;;; is necessary to choose from multiple minimal elements; both a list of
499;;; candidates and the ordering so far are provided as arguments.
500
501(defun topological-sort (elements constraints tie-breaker)
502  (let ((remaining-constraints constraints)
503        (remaining-elements elements)
504        (result ()))
505    (loop
506      (let ((minimal-elements
507             (remove-if
508              #'(lambda (class)
509                 (member class remaining-constraints
510                         :key #'cadr))
511              remaining-elements)))
512        (when (null minimal-elements)
513          (if (null remaining-elements)
514              (return-from topological-sort result)
515              (error "Inconsistent precedence graph.")))
516        (let ((choice (if (null (cdr minimal-elements))
517                          (car minimal-elements)
518                          (funcall tie-breaker
519                                   minimal-elements
520                                   result))))
521          (setq result (append result (list choice)))
522          (setq remaining-elements
523                (remove choice remaining-elements))
524          (setq remaining-constraints
525                (remove choice
526                        remaining-constraints
527                        :test #'member)))))))
528
529;;; In the event of a tie while topologically sorting class precedence lists,
530;;; the CLOS Specification says to "select the one that has a direct subclass
531;;; rightmost in the class precedence list computed so far."  The same result
532;;; is obtained by inspecting the partially constructed class precedence list
533;;; from right to left, looking for the first minimal element to show up among
534;;; the direct superclasses of the class precedence list constituent.
535;;; (There's a lemma that shows that this rule yields a unique result.)
536
537(defun std-tie-breaker-rule (minimal-elements cpl-so-far)
538  (dolist (cpl-constituent (reverse cpl-so-far))
539    (let* ((supers (class-direct-superclasses cpl-constituent))
540           (common (intersection minimal-elements supers)))
541      (when (not (null common))
542        (return-from std-tie-breaker-rule (car common))))))
543
544;;; This version of collect-superclasses* isn't bothered by cycles in the class
545;;; hierarchy, which sometimes happen by accident.
546
547(defun collect-superclasses* (class)
548  (labels ((all-superclasses-loop (seen superclasses)
549                                  (let ((to-be-processed
550                                         (set-difference superclasses seen)))
551                                    (if (null to-be-processed)
552                                        superclasses
553                                        (let ((class-to-process
554                                               (car to-be-processed)))
555                                          (all-superclasses-loop
556                                           (cons class-to-process seen)
557                                           (union (class-direct-superclasses
558                                                   class-to-process)
559                                                  superclasses)))))))
560          (all-superclasses-loop () (list class))))
561
562;;; The local precedence ordering of a class C with direct superclasses C_1,
563;;; C_2, ..., C_n is the set ((C C_1) (C_1 C_2) ...(C_n-1 C_n)).
564
565(defun local-precedence-ordering (class)
566  (mapcar #'list
567          (cons class
568                (butlast (class-direct-superclasses class)))
569          (class-direct-superclasses class)))
570
571;;; Slot inheritance
572
573(defun std-compute-slots (class)
574  (let* ((all-slots (mapappend #'class-direct-slots
575                               (class-precedence-list class)))
576         (all-names (remove-duplicates
577                     (mapcar 'slot-definition-name all-slots))))
578    (mapcar #'(lambda (name)
579               (funcall
580                (if (eq (class-of class) +the-standard-class+)
581                    #'std-compute-effective-slot-definition
582                    #'compute-effective-slot-definition)
583                class
584                name
585                (remove name all-slots
586                        :key 'slot-definition-name
587                        :test-not #'eq)))
588            all-names)))
589
590(defun std-compute-effective-slot-definition (class name direct-slots)
591  (let ((initer (find-if-not #'null direct-slots
592                             :key 'slot-definition-initfunction)))
593    (make-effective-slot-definition
594     class
595     :name name
596     :initform (if initer
597                   (slot-definition-initform initer)
598                   nil)
599     :initfunction (if initer
600                       (slot-definition-initfunction initer)
601                       nil)
602     :initargs (remove-duplicates
603                (mapappend 'slot-definition-initargs
604                           direct-slots))
605     :allocation (slot-definition-allocation (car direct-slots))
606     :allocation-class (when (slot-boundp (car direct-slots)
607            'sys::allocation-class)
608       ;;for some classes created in Java
609       ;;(e.g. SimpleCondition) this slot is unbound
610       (slot-definition-allocation-class (car direct-slots))))))
611
612;;; Standard instance slot access
613
614;;; N.B. The location of the effective-slots slots in the class metaobject for
615;;; standard-class must be determined without making any further slot
616;;; references.
617
618(defun find-slot-definition (class slot-name)
619  (dolist (slot (class-slots class) nil)
620    (when (eq slot-name (slot-definition-name slot))
621      (return slot))))
622
623(defun slot-location (class slot-name)
624  (let ((slot (find-slot-definition class slot-name)))
625    (if slot
626        (slot-definition-location slot)
627        nil)))
628
629(defun instance-slot-location (instance slot-name)
630  (let ((layout (std-instance-layout instance)))
631    (and layout (layout-slot-location layout slot-name))))
632
633(defun slot-value (object slot-name)
634  (if (or (eq (class-of (class-of object)) +the-standard-class+)
635    (eq (class-of (class-of object)) +the-structure-class+))
636      (std-slot-value object slot-name)
637      (slot-value-using-class (class-of object) object slot-name)))
638
639(defsetf std-slot-value set-std-slot-value)
640
641(defun %set-slot-value (object slot-name new-value)
642  (if (or (eq (class-of (class-of object)) +the-standard-class+)
643    (eq (class-of (class-of object)) +the-structure-class+))
644      (setf (std-slot-value object slot-name) new-value)
645      (set-slot-value-using-class new-value (class-of object)
646                                  object slot-name)))
647
648(defsetf slot-value %set-slot-value)
649
650(defun slot-boundp (object slot-name)
651  (if (eq (class-of (class-of object)) +the-standard-class+)
652      (std-slot-boundp object slot-name)
653      (slot-boundp-using-class (class-of object) object slot-name)))
654
655(defun std-slot-makunbound (instance slot-name)
656  (let ((location (instance-slot-location instance slot-name)))
657    (cond ((fixnump location)
658           (setf (standard-instance-access instance location) +slot-unbound+))
659          ((consp location)
660           (setf (cdr location) +slot-unbound+))
661          (t
662           (slot-missing (class-of instance) instance slot-name 'slot-makunbound))))
663  instance)
664
665(defun slot-makunbound (object slot-name)
666  (if (eq (class-of (class-of object)) +the-standard-class+)
667      (std-slot-makunbound object slot-name)
668      (slot-makunbound-using-class (class-of object) object slot-name)))
669
670(defun std-slot-exists-p (instance slot-name)
671  (not (null (find slot-name (class-slots (class-of instance))
672                   :key 'slot-definition-name))))
673
674(defun slot-exists-p (object slot-name)
675  (if (eq (class-of (class-of object)) +the-standard-class+)
676      (std-slot-exists-p object slot-name)
677      (slot-exists-p-using-class (class-of object) object slot-name)))
678
679(defun instance-slot-p (slot)
680  (eq (slot-definition-allocation slot) :instance))
681
682(defun std-allocate-instance (class)
683  ;; AMOP says ALLOCATE-INSTANCE checks if the class is finalized
684  ;; and if not, tries to finalize it.
685  (unless (class-finalized-p class)
686    (std-finalize-inheritance class))
687  (sys::%std-allocate-instance class))
688
689(defun make-instance-standard-class (metaclass
690             &rest initargs
691                                     &key name direct-superclasses direct-slots
692                                     direct-default-initargs
693                                     documentation)
694  (declare (ignore metaclass))
695  (let ((class (std-allocate-instance +the-standard-class+)))
696    (check-initargs (list #'allocate-instance #'initialize-instance)
697                    (list* class initargs)
698                    class t initargs
699                    *make-instance-initargs-cache*)
700    (%set-class-name name class)
701    (%set-class-layout nil class)
702    (%set-class-direct-subclasses ()  class)
703    (%set-class-direct-methods ()  class)
704    (%set-class-documentation class documentation)
705    (std-after-initialization-for-classes class
706                                          :direct-superclasses direct-superclasses
707                                          :direct-slots direct-slots
708                                          :direct-default-initargs direct-default-initargs)
709    class))
710
711;(defun convert-to-direct-slot-definition (class canonicalized-slot)
712;  (apply #'make-instance
713;         (apply #'direct-slot-definition-class
714;                class canonicalized-slot)
715;         canonicalized-slot))
716
717(defun std-after-initialization-for-classes (class
718                                             &key direct-superclasses direct-slots
719                                             direct-default-initargs
720                                             &allow-other-keys)
721  (let ((supers (or direct-superclasses
722                    (list +the-standard-object-class+))))
723    (setf (class-direct-superclasses class) supers)
724    (dolist (superclass supers)
725      (pushnew class (class-direct-subclasses superclass))))
726  (let ((slots (mapcar #'(lambda (slot-properties)
727                          (apply #'make-direct-slot-definition class slot-properties))
728                       direct-slots)))
729    (setf (class-direct-slots class) slots)
730    (dolist (direct-slot slots)
731      (dolist (reader (slot-definition-readers direct-slot))
732        (add-reader-method class reader (slot-definition-name direct-slot)))
733      (dolist (writer (slot-definition-writers direct-slot))
734        (add-writer-method class writer (slot-definition-name direct-slot)))))
735  (setf (class-direct-default-initargs class) direct-default-initargs)
736  (maybe-finalize-class-subtree class)
737  (values))
738
739(defun canonical-slot-name (canonical-slot)
740  (getf canonical-slot :name))
741
742(defvar *extensible-built-in-classes*
743  (list (find-class 'sequence)
744        (find-class 'java:java-object)))
745
746(defvar *make-instance-initargs-cache*
747  (make-hash-table :test #'eq)
748  "Cached sets of allowable initargs, keyed on the class they belong to.")
749(defvar *reinitialize-instance-initargs-cache*
750  (make-hash-table :test #'eq)
751  "Cached sets of allowable initargs, keyed on the class they belong to.")
752
753(defun ensure-class (name &rest all-keys &key metaclass &allow-other-keys)
754  ;; Check for duplicate slots.
755  (remf all-keys :metaclass)
756  (let ((slots (getf all-keys :direct-slots)))
757    (dolist (s1 slots)
758      (let ((name1 (canonical-slot-name s1)))
759        (dolist (s2 (cdr (memq s1 slots)))
760          (when (eq name1 (canonical-slot-name s2))
761            (error 'program-error "Duplicate slot ~S" name1))))))
762  ;; Check for duplicate argument names in :DEFAULT-INITARGS.
763  (let ((names ()))
764    (do* ((initargs (getf all-keys :direct-default-initargs) (cddr initargs))
765          (name (car initargs) (car initargs)))
766         ((null initargs))
767      (push name names))
768    (do* ((names names (cdr names))
769          (name (car names) (car names)))
770         ((null names))
771      (when (memq name (cdr names))
772        (error 'program-error
773               :format-control "Duplicate initialization argument name ~S in :DEFAULT-INITARGS."
774               :format-arguments (list name)))))
775  (let ((direct-superclasses (getf all-keys :direct-superclasses)))
776    (dolist (class direct-superclasses)
777      (when (and (typep class 'built-in-class)
778                 (not (member class *extensible-built-in-classes*)))
779        (error "Attempt to define a subclass of a built-in-class: ~S" class))))
780  (let ((old-class (find-class name nil)))
781    (cond ((and old-class (eq name (class-name old-class)))
782           (cond ((typep old-class 'built-in-class)
783                  (error "The symbol ~S names a built-in class." name))
784                 ((typep old-class 'forward-referenced-class)
785                  (let ((new-class (apply #'make-instance-standard-class
786                                          +the-standard-class+
787                                          :name name all-keys)))
788                    (%set-find-class name new-class)
789                    (setf (class-direct-subclasses new-class)
790                          (class-direct-subclasses old-class))
791                    (dolist (subclass (class-direct-subclasses old-class))
792                      (setf (class-direct-superclasses subclass)
793                            (substitute new-class old-class
794                                        (class-direct-superclasses subclass))))
795                    (maybe-finalize-class-subtree new-class)
796                    new-class))
797                 (t
798                  ;; We're redefining the class.
799                  (apply #'reinitialize-instance old-class all-keys)
800                  old-class)))
801          (t
802           (let ((class (apply (if metaclass
803                                   #'make-instance
804                                   #'make-instance-standard-class)
805                               (or metaclass
806                                   +the-standard-class+)
807                               :name name all-keys)))
808             (%set-find-class name class)
809             class)))))
810
811
812(defun maybe-finalize-class-subtree (class)
813  (when (every #'class-finalized-p (class-direct-superclasses class))
814    (finalize-inheritance class)
815    (dolist (subclass (class-direct-subclasses class))
816       (maybe-finalize-class-subtree subclass))))
817
818(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
819  (unless (>= (length form) 3)
820    (error 'program-error "Wrong number of arguments for DEFCLASS."))
821  (check-declaration-type name)
822  `(ensure-class ',name
823                 :direct-superclasses
824                 (canonicalize-direct-superclasses ',direct-superclasses)
825                 :direct-slots
826                 ,(canonicalize-direct-slots direct-slots)
827                 ,@(canonicalize-defclass-options options)))
828
829(defstruct method-combination
830  name
831  documentation)
832
833(defstruct (short-method-combination 
834             (:include method-combination))
835  operator
836  identity-with-one-argument)
837
838(defstruct (long-method-combination
839             (:include method-combination))
840  lambda-list
841  method-group-specs
842  args-lambda-list
843  generic-function-symbol
844  function
845  arguments
846  declarations
847  forms)
848
849(defun expand-long-defcombin (name args)
850  (destructuring-bind (lambda-list method-groups &rest body) args
851    `(apply #'define-long-form-method-combination
852            ',name
853            ',lambda-list
854            (list ,@(mapcar #'canonicalize-method-group-spec method-groups))
855            ',body)))
856
857(defun expand-short-defcombin (whole)
858  (let* ((name (cadr whole))
859         (documentation
860          (getf (cddr whole) :documentation ""))
861         (identity-with-one-arg
862          (getf (cddr whole) :identity-with-one-argument nil))
863         (operator
864          (getf (cddr whole) :operator name)))
865    `(progn
866       (setf (get ',name 'method-combination-object)
867             (make-short-method-combination
868              :name ',name
869              :operator ',operator
870              :identity-with-one-argument ',identity-with-one-arg
871              :documentation ',documentation))
872       ',name)))
873
874(defmacro define-method-combination (&whole form name &rest args)
875  (if (and (cddr form)
876           (listp (caddr form)))
877      (expand-long-defcombin name args)
878      (expand-short-defcombin form)))
879
880(define-method-combination +      :identity-with-one-argument t)
881(define-method-combination and    :identity-with-one-argument t)
882(define-method-combination append :identity-with-one-argument nil)
883(define-method-combination list   :identity-with-one-argument nil)
884(define-method-combination max    :identity-with-one-argument t)
885(define-method-combination min    :identity-with-one-argument t)
886(define-method-combination nconc  :identity-with-one-argument t)
887(define-method-combination or     :identity-with-one-argument t)
888(define-method-combination progn  :identity-with-one-argument t)
889
890;;;
891;;; long form of define-method-combination (from Sacla and XCL)
892;;;
893(defun define-method-combination-type (name &rest initargs)
894    (setf (get name 'method-combination-object)
895          (apply 'make-long-method-combination initargs)))
896
897(defun method-group-p (selecter qualifiers)
898  ;; selecter::= qualifier-pattern | predicate
899  (etypecase selecter
900    (list (or (equal selecter qualifiers)
901              (let ((last (last selecter)))
902                (when (eq '* (cdr last))
903                  (let* ((prefix `(,@(butlast selecter) ,(car last)))
904                         (pos (mismatch prefix qualifiers)))
905                    (or (null pos) (= pos (length prefix))))))))
906    ((eql *) t)
907    (symbol (funcall (symbol-function selecter) qualifiers))))
908
909(defun check-variable-name (name)
910  (flet ((valid-variable-name-p (name)
911                                (and (symbolp name) (not (constantp name)))))
912    (assert (valid-variable-name-p name))))
913
914(defun canonicalize-method-group-spec (spec)
915  ;; spec ::= (name {qualifier-pattern+ | predicate} [[long-form-option]])
916  ;; long-form-option::= :description description | :order order |
917  ;;                     :required required-p
918  ;; a canonicalized-spec is a simple plist.
919  (let* ((rest spec)
920         (name (prog2 (check-variable-name (car rest))
921                 (car rest)
922                 (setq rest (cdr rest))))
923         (option-names '(:description :order :required))
924         (selecters (let ((end (or (position-if #'(lambda (it)
925                                                   (member it option-names))
926                                                rest)
927                                   (length rest))))
928                      (prog1 (subseq rest 0 end)
929                        (setq rest (subseq rest end)))))
930         (description (getf rest :description ""))
931         (order (getf rest :order :most-specific-first))
932         (required-p (getf rest :required)))
933    `(list :name ',name
934           :predicate (lambda (qualifiers)
935                        (loop for item in ',selecters
936                          thereis (method-group-p item qualifiers)))
937           :description ',description
938           :order ',order
939           :required ',required-p
940           :*-selecter ,(equal selecters '(*)))))
941
942(defun extract-required-part (lambda-list)
943  (flet ((skip (key lambda-list)
944               (if (eq (first lambda-list) key)
945                   (cddr lambda-list)
946                   lambda-list)))
947    (ldiff (skip '&environment (skip '&whole lambda-list))
948           (member-if #'(lambda (it) (member it lambda-list-keywords))
949                      lambda-list))))
950
951(defun extract-specified-part (key lambda-list)
952  (case key
953    ((&eval &whole)
954     (list (second (member key lambda-list))))
955    (t
956     (let ((here (cdr (member key lambda-list))))
957       (ldiff here
958              (member-if #'(lambda (it) (member it lambda-list-keywords))
959                         here))))))
960
961(defun extract-optional-part (lambda-list)
962  (extract-specified-part '&optional lambda-list))
963
964(defun parse-define-method-combination-arguments-lambda-list (lambda-list)
965  ;; Define-method-combination Arguments Lambda Lists
966  ;; http://www.lispworks.com/reference/HyperSpec/Body/03_dj.htm
967  (let ((required (extract-required-part lambda-list))
968        (whole    (extract-specified-part '&whole    lambda-list))
969        (optional (extract-specified-part '&optional lambda-list))
970        (rest     (extract-specified-part '&rest     lambda-list))
971        (keys     (extract-specified-part '&key      lambda-list))
972        (aux      (extract-specified-part '&aux      lambda-list)))
973    (values (first whole)
974            required
975            (mapcar #'(lambda (spec)
976                       (if (consp spec)
977                           `(,(first spec) ,(second spec) ,@(cddr spec))
978                           `(,spec nil)))
979                    optional)
980            (first rest)
981            (mapcar #'(lambda (spec)
982                       (let ((key (if (consp spec) (car spec) spec))
983                             (rest (when (consp spec) (rest spec))))
984                         `(,(if (consp key) key `(,(make-keyword key) ,key))
985                           ,(car rest)
986                           ,@(cdr rest))))
987                    keys)
988            (mapcar #'(lambda (spec)
989                       (if (consp spec)
990                           `(,(first spec) ,(second spec))
991                           `(,spec nil)))
992                    aux))))
993
994(defmacro getk (plist key init-form)
995  "Similar to getf except eval and return INIT-FORM if KEY has no value in PLIST."
996  (let ((not-exist (gensym))
997        (value (gensym)))
998    `(let ((,value (getf ,plist ,key ,not-exist)))
999       (if (eq ,not-exist ,value) ,init-form ,value))))
1000
1001(defun wrap-with-call-method-macro (gf args-var forms)
1002  `(macrolet
1003       ((call-method (method &optional next-method-list)
1004          `(funcall
1005            ,(cond
1006              ((listp method)
1007               (assert (eq (first method) 'make-method))
1008               ;; by generating an inline expansion we prevent allocation
1009               ;; of a method instance which will be discarded immediately
1010               ;; after reading the METHOD-FUNCTION slot
1011               (compute-method-function
1012                    `(lambda (&rest ,(gensym))
1013                       ;; the MAKE-METHOD body form gets evaluated in
1014                       ;; the null lexical environment augmented
1015                       ;; with a binding for CALL-METHOD
1016                       ,(wrap-with-call-method-macro ,gf
1017                                                     ',args-var
1018                                                     (second method)))))
1019              (t (%method-function method)))
1020            ,',args-var
1021            ,(unless (null next-method-list)
1022                     ;; by not generating an emf when there are no next methods,
1023                     ;; we ensure next-method-p returns NIL
1024                     (compute-effective-method-function
1025                        ,gf (process-next-method-list next-method-list))))))
1026     ,@forms))
1027
1028(defmacro with-args-lambda-list (args-lambda-list
1029                                 generic-function-symbol
1030                                 gf-args-symbol
1031                                 &body forms)
1032  (let ((gf-lambda-list (gensym))
1033        (nrequired (gensym))
1034        (noptional (gensym))
1035        (rest-args (gensym)))
1036    (multiple-value-bind (whole required optional rest keys aux)
1037        (parse-define-method-combination-arguments-lambda-list args-lambda-list)
1038      `(let* ((,gf-lambda-list (slot-value ,generic-function-symbol 'sys::lambda-list))
1039              (,nrequired (length (extract-required-part ,gf-lambda-list)))
1040              (,noptional (length (extract-optional-part ,gf-lambda-list)))
1041              (,rest-args (subseq ,gf-args-symbol (+ ,nrequired ,noptional)))
1042              ,@(when whole `((,whole ,gf-args-symbol)))
1043              ,@(loop for var in required and i upfrom 0
1044                  collect `(,var (when (< ,i ,nrequired)
1045                                   (nth ,i ,gf-args-symbol))))
1046              ,@(loop for (var init-form) in optional and i upfrom 0
1047                  collect
1048                  `(,var (if (< ,i ,noptional)
1049                             (nth (+ ,nrequired ,i) ,gf-args-symbol)
1050                             ,init-form)))
1051              ,@(when rest `((,rest ,rest-args)))
1052              ,@(loop for ((key var) init-form) in keys and i upfrom 0
1053                  collect `(,var (getk ,rest-args ',key ,init-form)))
1054              ,@(loop for (var init-form) in aux and i upfrom 0
1055                  collect `(,var ,init-form)))
1056         ,@forms))))
1057
1058(defun assert-unambiguous-method-sorting (group-name methods)
1059  (let ((specializers (make-hash-table :test 'equal)))
1060    (dolist (method methods)
1061      (push method (gethash (method-specializers method) specializers)))
1062    (loop for specializer-methods being each hash-value of specializers
1063       using (hash-key method-specializers)
1064       unless (= 1 (length specializer-methods))
1065       do (error "Ambiguous method sorting in method group ~A due to multiple ~
1066                  methods with specializers ~S: ~S"
1067                 group-name method-specializers specializer-methods))))
1068
1069(defmacro with-method-groups (method-group-specs methods-form &body forms)
1070  (flet ((grouping-form (spec methods-var)
1071           (let ((predicate (coerce-to-function (getf spec :predicate)))
1072                 (group (gensym))
1073                 (leftovers (gensym))
1074                 (method (gensym)))
1075             `(let ((,group '())
1076                    (,leftovers '()))
1077                (dolist (,method ,methods-var)
1078                  (if (funcall ,predicate (method-qualifiers ,method))
1079                      (push ,method ,group)
1080                      (push ,method ,leftovers)))
1081                (ecase ,(getf spec :order)
1082                  (:most-specific-last )
1083                  (:most-specific-first (setq ,group (nreverse ,group))))
1084                ,@(when (getf spec :required)
1085                        `((when (null ,group)
1086                            (error "Method group ~S must not be empty."
1087                                   ',(getf spec :name)))))
1088                (setq ,methods-var (nreverse ,leftovers))
1089                ,group))))
1090    (let ((rest (gensym))
1091          (method (gensym)))
1092      `(let* ((,rest ,methods-form)
1093              ,@(mapcar #'(lambda (spec)
1094                           `(,(getf spec :name) ,(grouping-form spec rest)))
1095                        method-group-specs))
1096         (dolist (,method ,rest)
1097           (invalid-method-error ,method
1098                                 "Method ~S with qualifiers ~S does not belong to any method group."
1099                                 ,method (method-qualifiers ,method)))
1100         ,@(unless (and (= 1 (length method-group-specs))
1101                        (getf (car method-group-specs) :*-selecter))
1102             (mapcar #'(lambda (spec)
1103                         `(assert-unambiguous-method-sorting ',(getf spec :name) ,(getf spec :name)))
1104                     method-group-specs))
1105         ,@forms))))
1106
1107(defun method-combination-type-lambda
1108  (&key name lambda-list args-lambda-list generic-function-symbol
1109        method-group-specs declarations forms &allow-other-keys)
1110  (declare (ignore name))
1111  (let ((methods (gensym))
1112        (args-var (gensym)))
1113    `(lambda (,generic-function-symbol ,methods ,@lambda-list)
1114       ,@declarations
1115       (with-method-groups ,method-group-specs
1116           ,methods
1117         ,(if (null args-lambda-list)
1118              `(let ((result (progn ,@forms)))
1119                 `(lambda (,',args-var)
1120                    ,(wrap-with-call-method-macro ,generic-function-symbol
1121                                                  ',args-var (list result))))
1122              `(lambda (,args-var)
1123                 (let* ((result
1124                         (with-args-lambda-list ,args-lambda-list
1125                             ,generic-function-symbol ,args-var
1126                           ,@forms))
1127                        (function
1128                         `(lambda (,',args-var) ;; ugly: we're reusing it
1129                          ;; to prevent calling gensym on every EMF invocation
1130                          ,(wrap-with-call-method-macro ,generic-function-symbol
1131                                                        ',args-var
1132                                                        (list result)))))
1133                   (funcall function ,args-var))))))))
1134
1135(defun declarationp (expr)
1136  (and (consp expr) (eq (car expr) 'DECLARE)))
1137
1138(defun long-form-method-combination-args (args)
1139  ;; define-method-combination name lambda-list (method-group-specifier*) args
1140  ;; args ::= [(:arguments . args-lambda-list)]
1141  ;;          [(:generic-function generic-function-symbol)]
1142  ;;          [[declaration* | documentation]] form*
1143  (let ((rest args))
1144    (labels ((nextp (key) (and (consp (car rest)) (eq key (caar rest))))
1145             (args-lambda-list ()
1146               (when (nextp :arguments)
1147                 (prog1 (cdr (car rest)) (setq rest (cdr rest)))))
1148             (generic-function-symbol ()
1149                (if (nextp :generic-function)
1150                    (prog1 (second (car rest)) (setq rest (cdr rest)))
1151                    (gensym)))
1152             (declaration* ()
1153               (let ((end (position-if-not #'declarationp rest)))
1154                 (when end
1155                   (prog1 (subseq rest 0 end) (setq rest (nthcdr end rest))))))
1156             (documentation? ()
1157               (when (stringp (car rest))
1158                 (prog1 (car rest) (setq rest (cdr rest)))))
1159             (form* () rest))
1160      (let ((declarations '()))
1161        `(:args-lambda-list ,(args-lambda-list)
1162                            :generic-function-symbol ,(generic-function-symbol)
1163                            :documentation ,(prog2 (setq declarations (declaration*))
1164                                              (documentation?))
1165                            :declarations (,@declarations ,@(declaration*))
1166                            :forms ,(form*))))))
1167
1168(defun define-long-form-method-combination (name lambda-list method-group-specs
1169                                                 &rest args)
1170  (let* ((initargs `(:name ,name
1171                     :lambda-list ,lambda-list
1172                     :method-group-specs ,method-group-specs
1173                     ,@(long-form-method-combination-args args)))
1174         (lambda-expression (apply #'method-combination-type-lambda initargs)))
1175    (apply #'define-method-combination-type name
1176           `(,@initargs
1177;;              :function ,(compile nil lambda-expression)
1178             :function ,(coerce-to-function lambda-expression)))
1179    name))
1180
1181(defparameter *eql-specializer-table* (make-hash-table :test 'eql))
1182
1183(defun intern-eql-specializer (object)
1184  (or (gethash object *eql-specializer-table*)
1185      (setf (gethash object *eql-specializer-table*)
1186            ;; we will be called during generic function invocation
1187            ;; setup, so have to rely on plain functions here.
1188            (let ((instance (std-allocate-instance (find-class 'eql-specializer))))
1189              (setf (std-slot-value instance 'sys::object) object)
1190              instance))))
1191
1192(defun eql-specializer-object (eql-specializer)
1193  (check-type eql-specializer eql-specializer)
1194  (std-slot-value eql-specializer 'sys::object))
1195
1196;; MOP (p. 216) specifies the following reader generic functions:
1197;;   generic-function-argument-precedence-order
1198;;   generic-function-declarations
1199;;   generic-function-lambda-list
1200;;   generic-function-method-class
1201;;   generic-function-method-combination
1202;;   generic-function-methods
1203;;   generic-function-name
1204
1205(defun generic-function-lambda-list (gf)
1206  (%generic-function-lambda-list gf))
1207(defsetf generic-function-lambda-list %set-generic-function-lambda-list)
1208
1209(defun (setf generic-function-documentation) (new-value gf)
1210  (set-generic-function-documentation gf new-value))
1211
1212(defun (setf generic-function-initial-methods) (new-value gf)
1213  (set-generic-function-initial-methods gf new-value))
1214
1215(defun (setf generic-function-methods) (new-value gf)
1216  (set-generic-function-methods gf new-value))
1217
1218(defun (setf generic-function-method-class) (new-value gf)
1219  (set-generic-function-method-class gf new-value))
1220
1221(defun (setf generic-function-method-combination) (new-value gf)
1222  (set-generic-function-method-combination gf new-value))
1223
1224(defun (setf generic-function-argument-precedence-order) (new-value gf)
1225  (set-generic-function-argument-precedence-order gf new-value))
1226
1227(declaim (ftype (function * t) classes-to-emf-table))
1228(defun classes-to-emf-table (gf)
1229  (generic-function-classes-to-emf-table gf))
1230
1231(defun (setf classes-to-emf-table) (new-value gf)
1232  (set-generic-function-classes-to-emf-table gf new-value))
1233
1234(defun (setf method-lambda-list) (new-value method)
1235  (set-method-lambda-list method new-value))
1236
1237(defun (setf method-qualifiers) (new-value method)
1238  (set-method-qualifiers method new-value))
1239
1240(defun (setf method-documentation) (new-value method)
1241  (set-method-documentation method new-value))
1242
1243;;; defgeneric
1244
1245(defmacro defgeneric (function-name lambda-list
1246                                    &rest options-and-method-descriptions)
1247  (let ((options ())
1248        (methods ())
1249        (documentation nil))
1250    (dolist (item options-and-method-descriptions)
1251      (case (car item)
1252        (declare) ; FIXME
1253        (:documentation
1254         (when documentation
1255           (error 'program-error
1256                  :format-control "Documentation option was specified twice for generic function ~S."
1257                  :format-arguments (list function-name)))
1258         (setf documentation t)
1259         (push item options))
1260        (:method
1261         (push
1262          `(push (defmethod ,function-name ,@(cdr item))
1263                 (generic-function-initial-methods (fdefinition ',function-name)))
1264          methods))
1265        (t
1266         (push item options))))
1267    (setf options (nreverse options)
1268          methods (nreverse methods))
1269    `(prog1
1270       (%defgeneric
1271        ',function-name
1272        :lambda-list ',lambda-list
1273        ,@(canonicalize-defgeneric-options options))
1274       ,@methods)))
1275
1276(defun canonicalize-defgeneric-options (options)
1277  (mapappend #'canonicalize-defgeneric-option options))
1278
1279(defun canonicalize-defgeneric-option (option)
1280  (case (car option)
1281    (:generic-function-class
1282     (list :generic-function-class `(find-class ',(cadr option))))
1283    (:method-class
1284     (list :method-class `(find-class ',(cadr option))))
1285    (:method-combination
1286     (list :method-combination `',(cdr option)))
1287    (:argument-precedence-order
1288     (list :argument-precedence-order `',(cdr option)))
1289    (t
1290     (list `',(car option) `',(cadr option)))))
1291
1292;; From OpenMCL.
1293(defun canonicalize-argument-precedence-order (apo req)
1294  (cond ((equal apo req) nil)
1295        ((not (eql (length apo) (length req)))
1296         (error 'program-error
1297                :format-control "Specified argument precedence order ~S does not match lambda list."
1298                :format-arguments (list apo)))
1299        (t (let ((res nil))
1300             (dolist (arg apo (nreverse res))
1301               (let ((index (position arg req)))
1302                 (if (or (null index) (memq index res))
1303                     (error 'program-error
1304                            :format-control "Specified argument precedence order ~S does not match lambda list."
1305                            :format-arguments (list apo)))
1306                 (push index res)))))))
1307
1308(defun find-generic-function (name &optional (errorp t))
1309  (let ((function (and (fboundp name) (fdefinition name))))
1310    (when function
1311      (when (typep function 'generic-function)
1312        (return-from find-generic-function function))
1313      (when (and *traced-names* (find name *traced-names* :test #'equal))
1314        (setf function (untraced-function name))
1315        (when (typep function 'generic-function)
1316          (return-from find-generic-function function)))))
1317  (if errorp
1318      (error "There is no generic function named ~S." name)
1319      nil))
1320
1321(defun lambda-lists-congruent-p (lambda-list1 lambda-list2)
1322  (let* ((plist1 (analyze-lambda-list lambda-list1))
1323         (args1 (getf plist1 :required-args))
1324         (plist2 (analyze-lambda-list lambda-list2))
1325         (args2 (getf plist2 :required-args)))
1326    (= (length args1) (length args2))))
1327
1328(defun %defgeneric (function-name &rest all-keys)
1329  (when (fboundp function-name)
1330    (let ((gf (fdefinition function-name)))
1331      (when (typep gf 'generic-function)
1332        ;; Remove methods defined by previous DEFGENERIC forms.
1333        (dolist (method (generic-function-initial-methods gf))
1334          (%remove-method gf method))
1335        (setf (generic-function-initial-methods gf) '()))))
1336  (apply 'ensure-generic-function function-name all-keys))
1337
1338(defun ensure-generic-function (function-name
1339                                &rest all-keys
1340                                &key
1341                                lambda-list
1342                                (generic-function-class +the-standard-generic-function-class+)
1343                                (method-class +the-standard-method-class+)
1344                                (method-combination 'standard)
1345                                (argument-precedence-order nil apo-p)
1346                                documentation
1347                                &allow-other-keys)
1348  (when (autoloadp function-name)
1349    (resolve function-name))
1350  (let ((gf (find-generic-function function-name nil)))
1351    (if gf
1352        (progn
1353          (unless (or (null (generic-function-methods gf))
1354                      (lambda-lists-congruent-p lambda-list (generic-function-lambda-list gf)))
1355            (error 'simple-error
1356                   :format-control "The lambda list ~S is incompatible with the existing methods of ~S."
1357                   :format-arguments (list lambda-list gf)))
1358          (setf (generic-function-lambda-list gf) lambda-list)
1359          (setf (generic-function-documentation gf) documentation)
1360          (let* ((plist (analyze-lambda-list lambda-list))
1361                 (required-args (getf plist ':required-args)))
1362            (%set-gf-required-args gf required-args)
1363            (when apo-p
1364              (setf (generic-function-argument-precedence-order gf)
1365                    (if argument-precedence-order
1366                        (canonicalize-argument-precedence-order argument-precedence-order
1367                                                                required-args)
1368                        nil)))
1369            (finalize-generic-function gf))
1370          gf)
1371        (progn
1372          (when (and (null *clos-booting*)
1373                     (fboundp function-name))
1374            (error 'program-error
1375                   :format-control "~A already names an ordinary function, macro, or special operator."
1376                   :format-arguments (list function-name)))
1377          (setf gf (apply (if (eq generic-function-class +the-standard-generic-function-class+)
1378                              #'make-instance-standard-generic-function
1379                              #'make-instance)
1380                          generic-function-class
1381                          :name function-name
1382                          :method-class method-class
1383                          :method-combination method-combination
1384                          all-keys))
1385          gf))))
1386
1387(defun initial-discriminating-function (gf args)
1388  (set-funcallable-instance-function
1389   gf
1390   (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
1391                #'std-compute-discriminating-function
1392                #'compute-discriminating-function)
1393            gf))
1394  (apply gf args))
1395
1396(defun collect-eql-specializer-objects (generic-function)
1397  (let ((result nil))
1398    (dolist (method (generic-function-methods generic-function))
1399      (dolist (specializer (%method-specializers method))
1400        (when (typep specializer 'eql-specializer)
1401          (pushnew (eql-specializer-object specializer)
1402                   result
1403                   :test 'eql))))
1404    result))
1405
1406(defun finalize-generic-function (gf)
1407  (%finalize-generic-function gf)
1408  (setf (classes-to-emf-table gf) (make-hash-table :test #'equal))
1409  (%init-eql-specializations gf (collect-eql-specializer-objects gf))
1410  (set-funcallable-instance-function
1411   gf #'(lambda (&rest args)
1412          (initial-discriminating-function gf args)))
1413  ;; FIXME Do we need to warn on redefinition somewhere else?
1414  (let ((*warn-on-redefinition* nil))
1415    (setf (fdefinition (%generic-function-name gf)) gf))
1416  (values))
1417
1418(defun make-instance-standard-generic-function (generic-function-class
1419                                                &key name lambda-list
1420                                                method-class
1421                                                method-combination
1422                                                argument-precedence-order
1423                                                documentation)
1424  (declare (ignore generic-function-class))
1425  (let ((gf (std-allocate-instance +the-standard-generic-function-class+)))
1426    (%set-generic-function-name gf name)
1427    (setf (generic-function-lambda-list gf) lambda-list)
1428    (setf (generic-function-initial-methods gf) ())
1429    (setf (generic-function-methods gf) ())
1430    (setf (generic-function-method-class gf) method-class)
1431    (setf (generic-function-method-combination gf) method-combination)
1432    (setf (generic-function-documentation gf) documentation)
1433    (setf (classes-to-emf-table gf) nil)
1434    (let* ((plist (analyze-lambda-list (generic-function-lambda-list gf)))
1435           (required-args (getf plist ':required-args)))
1436      (%set-gf-required-args gf required-args)
1437      (setf (generic-function-argument-precedence-order gf)
1438            (if argument-precedence-order
1439                (canonicalize-argument-precedence-order argument-precedence-order
1440                                                        required-args)
1441                nil)))
1442    (finalize-generic-function gf)
1443    gf))
1444
1445(defun canonicalize-specializers (specializers)
1446  (mapcar #'canonicalize-specializer specializers))
1447
1448(defun canonicalize-specializer (specializer)
1449  (cond ((classp specializer)
1450         specializer)
1451        ((typep specializer 'eql-specializer)
1452         specializer)
1453        ((symbolp specializer)
1454         (find-class specializer))
1455        ((and (consp specializer)
1456              (eq (car specializer) 'eql))
1457         (let ((object (cadr specializer)))
1458           (when (and (consp object)
1459                      (eq (car object) 'quote))
1460             (setf object (cadr object)))
1461           (intern-eql-specializer object)))
1462        ((and (consp specializer)
1463              (eq (car specializer) 'java:jclass))
1464         (let ((jclass (eval specializer)))
1465           (java::ensure-java-class jclass)))
1466        (t
1467         (error "Unknown specializer: ~S" specializer))))
1468
1469(defun parse-defmethod (args)
1470  (let ((function-name (car args))
1471        (qualifiers ())
1472        (specialized-lambda-list ())
1473        (body ())
1474        (parse-state :qualifiers))
1475    (dolist (arg (cdr args))
1476      (ecase parse-state
1477        (:qualifiers
1478         (if (and (atom arg) (not (null arg)))
1479             (push arg qualifiers)
1480             (progn
1481               (setf specialized-lambda-list arg)
1482               (setf parse-state :body))))
1483        (:body (push arg body))))
1484    (setf qualifiers (nreverse qualifiers)
1485          body (nreverse body))
1486    (multiple-value-bind (real-body declarations documentation)
1487        (parse-body body)
1488      (values function-name
1489              qualifiers
1490              (extract-lambda-list specialized-lambda-list)
1491              (extract-specializer-names specialized-lambda-list)
1492              documentation
1493              declarations
1494              (list* 'block
1495                     (fdefinition-block-name function-name)
1496                     real-body)))))
1497
1498(defun required-portion (gf args)
1499  (let ((number-required (length (gf-required-args gf))))
1500    (when (< (length args) number-required)
1501      (error 'program-error
1502             :format-control "Not enough arguments for generic function ~S."
1503             :format-arguments (list (%generic-function-name gf))))
1504    (subseq args 0 number-required)))
1505
1506(defun extract-lambda-list (specialized-lambda-list)
1507  (let* ((plist (analyze-lambda-list specialized-lambda-list))
1508         (requireds (getf plist :required-names))
1509         (rv (getf plist :rest-var))
1510         (ks (getf plist :key-args))
1511         (keysp (getf plist :keysp))
1512         (aok (getf plist :allow-other-keys))
1513         (opts (getf plist :optional-args))
1514         (auxs (getf plist :auxiliary-args)))
1515    `(,@requireds
1516      ,@(if rv `(&rest ,rv) ())
1517      ,@(if (or ks keysp aok) `(&key ,@ks) ())
1518      ,@(if aok '(&allow-other-keys) ())
1519      ,@(if opts `(&optional ,@opts) ())
1520      ,@(if auxs `(&aux ,@auxs) ()))))
1521
1522(defun extract-specializer-names (specialized-lambda-list)
1523  (let ((plist (analyze-lambda-list specialized-lambda-list)))
1524    (getf plist ':specializers)))
1525
1526(defun get-keyword-from-arg (arg)
1527  (if (listp arg)
1528      (if (listp (car arg))
1529          (caar arg)
1530          (make-keyword (car arg)))
1531      (make-keyword arg)))
1532
1533(defun analyze-lambda-list (lambda-list)
1534  (let ((keys ())           ; Just the keywords
1535        (key-args ())       ; Keywords argument specs
1536        (keysp nil)         ;
1537        (required-names ()) ; Just the variable names
1538        (required-args ())  ; Variable names & specializers
1539        (specializers ())   ; Just the specializers
1540        (rest-var nil)
1541        (optionals ())
1542        (auxs ())
1543        (allow-other-keys nil)
1544        (state :parsing-required))
1545    (dolist (arg lambda-list)
1546      (if (member arg lambda-list-keywords)
1547          (ecase arg
1548            (&optional
1549             (setq state :parsing-optional))
1550            (&rest
1551             (setq state :parsing-rest))
1552            (&key
1553             (setq keysp t)
1554             (setq state :parsing-key))
1555            (&allow-other-keys
1556             (setq allow-other-keys 't))
1557            (&aux
1558             (setq state :parsing-aux)))
1559          (case state
1560            (:parsing-required
1561             (push-on-end arg required-args)
1562             (if (listp arg)
1563                 (progn (push-on-end (car arg) required-names)
1564                   (push-on-end (cadr arg) specializers))
1565                 (progn (push-on-end arg required-names)
1566                   (push-on-end 't specializers))))
1567            (:parsing-optional (push-on-end arg optionals))
1568            (:parsing-rest (setq rest-var arg))
1569            (:parsing-key
1570             (push-on-end (get-keyword-from-arg arg) keys)
1571             (push-on-end arg key-args))
1572            (:parsing-aux (push-on-end arg auxs)))))
1573    (list  :required-names required-names
1574           :required-args required-args
1575           :specializers specializers
1576           :rest-var rest-var
1577           :keywords keys
1578           :key-args key-args
1579           :keysp keysp
1580           :auxiliary-args auxs
1581           :optional-args optionals
1582           :allow-other-keys allow-other-keys)))
1583
1584#+nil
1585(defun check-method-arg-info (gf arg-info method)
1586  (multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
1587      (analyze-lambda-list (if (consp method)
1588                               (early-method-lambda-list method)
1589                               (method-lambda-list method)))
1590    (flet ((lose (string &rest args)
1591                 (error 'simple-program-error
1592                        :format-control "~@<attempt to add the method~2I~_~S~I~_~
1593                        to the generic function~2I~_~S;~I~_~
1594                        but ~?~:>"
1595                        :format-arguments (list method gf string args)))
1596           (comparison-description (x y)
1597                                   (if (> x y) "more" "fewer")))
1598      (let ((gf-nreq (arg-info-number-required arg-info))
1599            (gf-nopt (arg-info-number-optional arg-info))
1600            (gf-key/rest-p (arg-info-key/rest-p arg-info))
1601            (gf-keywords (arg-info-keys arg-info)))
1602        (unless (= nreq gf-nreq)
1603          (lose
1604           "the method has ~A required arguments than the generic function."
1605           (comparison-description nreq gf-nreq)))
1606        (unless (= nopt gf-nopt)
1607          (lose
1608           "the method has ~A optional arguments than the generic function."
1609           (comparison-description nopt gf-nopt)))
1610        (unless (eq (or keysp restp) gf-key/rest-p)
1611          (lose
1612           "the method and generic function differ in whether they accept~_~
1613            &REST or &KEY arguments."))
1614        (when (consp gf-keywords)
1615          (unless (or (and restp (not keysp))
1616                      allow-other-keys-p
1617                      (every (lambda (k) (memq k keywords)) gf-keywords))
1618            (lose "the method does not accept each of the &KEY arguments~2I~_~
1619            ~S."
1620                  gf-keywords)))))))
1621
1622(defun check-method-lambda-list (name method-lambda-list gf-lambda-list)
1623  (let* ((gf-restp (not (null (memq '&rest gf-lambda-list))))
1624         (gf-plist (analyze-lambda-list gf-lambda-list))
1625         (gf-keysp (getf gf-plist :keysp))
1626         (gf-keywords (getf gf-plist :keywords))
1627         (method-plist (analyze-lambda-list method-lambda-list))
1628         (method-restp (not (null (memq '&rest method-lambda-list))))
1629         (method-keysp (getf method-plist :keysp))
1630         (method-keywords (getf method-plist :keywords))
1631         (method-allow-other-keys-p (getf method-plist :allow-other-keys)))
1632    (unless (= (length (getf gf-plist :required-args))
1633               (length (getf method-plist :required-args)))
1634      (error "The method-lambda-list ~S ~
1635              has the wrong number of required arguments ~
1636              for the generic function ~S." method-lambda-list name))
1637    (unless (= (length (getf gf-plist :optional-args))
1638               (length (getf method-plist :optional-args)))
1639      (error "The method-lambda-list ~S ~
1640              has the wrong number of optional arguments ~
1641              for the generic function ~S." method-lambda-list name))
1642    (unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
1643      (error "The method-lambda-list ~S ~
1644              and the generic function ~S ~
1645              differ in whether they accept &REST or &KEY arguments."
1646             method-lambda-list name))
1647    (when (consp gf-keywords)
1648      (unless (or (and method-restp (not method-keysp))
1649                  method-allow-other-keys-p
1650                  (every (lambda (k) (memq k method-keywords)) gf-keywords))
1651        (error "The method-lambda-list ~S does not accept ~
1652                all of the keyword arguments defined for the ~
1653                generic function." method-lambda-list name)))))
1654
1655(defvar *gf-initialize-instance* nil
1656  "Cached value of the INITIALIZE-INSTANCE generic function.
1657Initialized with the true value near the end of the file.")
1658(defvar *gf-allocate-instance* nil
1659  "Cached value of the ALLOCATE-INSTANCE generic function.
1660Initialized with the true value near the end of the file.")
1661(defvar *gf-shared-initialize* nil
1662  "Cached value of the SHARED-INITIALIZE generic function.
1663Initialized with the true value near the end of the file.")
1664(defvar *gf-reinitialize-instance* nil
1665  "Cached value of the REINITIALIZE-INSTANCE generic function.
1666Initialized with the true value near the end of the file.")
1667
1668(declaim (ftype (function * method) ensure-method))
1669(defun ensure-method (name &rest all-keys)
1670  (let ((method-lambda-list (getf all-keys :lambda-list))
1671        (gf (find-generic-function name nil)))
1672    (when (or (eq gf *gf-initialize-instance*)
1673              (eq gf *gf-allocate-instance*)
1674              (eq gf *gf-shared-initialize*)
1675              (eq gf *gf-reinitialize-instance*))
1676      ;; ### Clearly, this can be targeted much more exact
1677      ;; as we only need to remove the specializing class and all
1678      ;; its subclasses from the hash.
1679      (clrhash *make-instance-initargs-cache*)
1680      (clrhash *reinitialize-instance-initargs-cache*))
1681    (if gf
1682        (check-method-lambda-list name method-lambda-list
1683                                  (generic-function-lambda-list gf))
1684        (setf gf (ensure-generic-function name :lambda-list method-lambda-list)))
1685    (let ((method
1686           (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1687               (apply #'make-instance-standard-method gf all-keys)
1688               (apply #'make-instance (generic-function-method-class gf) all-keys))))
1689      (%add-method gf method)
1690      method)))
1691
1692(defun make-instance-standard-method (gf
1693                                      &key
1694                                      lambda-list
1695                                      qualifiers
1696                                      specializers
1697                                      documentation
1698                                      function
1699                                      fast-function)
1700  (declare (ignore gf))
1701  (let ((method (std-allocate-instance +the-standard-method-class+)))
1702    (setf (method-lambda-list method) lambda-list)
1703    (setf (method-qualifiers method) qualifiers)
1704    (%set-method-specializers method (canonicalize-specializers specializers))
1705    (setf (method-documentation method) documentation)
1706    (%set-method-generic-function method nil)
1707    (%set-method-function method function)
1708    (%set-method-fast-function method fast-function)
1709    method))
1710
1711(defun %add-method (gf method)
1712  (when (%method-generic-function method)
1713    (error 'simple-error
1714           :format-control "ADD-METHOD: ~S is a method of ~S."
1715           :format-arguments (list method (%method-generic-function method))))
1716  ;; Remove existing method with same qualifiers and specializers (if any).
1717  (let ((old-method (%find-method gf (method-qualifiers method)
1718                                 (%method-specializers method) nil)))
1719    (when old-method
1720      (%remove-method gf old-method)))
1721  (%set-method-generic-function method gf)
1722  (push method (generic-function-methods gf))
1723  (dolist (specializer (%method-specializers method))
1724    (when (typep specializer 'class) ;; FIXME What about EQL specializer objects?
1725      (pushnew method (class-direct-methods specializer))))
1726  (finalize-generic-function gf)
1727  gf)
1728
1729(defun %remove-method (gf method)
1730  (setf (generic-function-methods gf)
1731        (remove method (generic-function-methods gf)))
1732  (%set-method-generic-function method nil)
1733  (dolist (specializer (%method-specializers method))
1734    (when (typep specializer 'class) ;; FIXME What about EQL specializer objects?
1735      (setf (class-direct-methods specializer)
1736            (remove method (class-direct-methods specializer)))))
1737  (finalize-generic-function gf)
1738  gf)
1739
1740(defun %find-method (gf qualifiers specializers &optional (errorp t))
1741  ;; "If the specializers argument does not correspond in length to the number
1742  ;; of required arguments of the generic-function, an an error of type ERROR
1743  ;; is signaled."
1744  (unless (= (length specializers) (length (gf-required-args gf)))
1745    (error "The specializers argument has length ~S, but ~S has ~S required parameters."
1746           (length specializers)
1747           gf
1748           (length (gf-required-args gf))))
1749  (let* ((canonical-specializers (canonicalize-specializers specializers))
1750         (method
1751          (find-if #'(lambda (method)
1752                      (and (equal qualifiers
1753                                  (method-qualifiers method))
1754                           (equal canonical-specializers
1755                                  (%method-specializers method))))
1756                   (generic-function-methods gf))))
1757    (if (and (null method) errorp)
1758        (error "No such method for ~S." (%generic-function-name gf))
1759        method)))
1760
1761(defun fast-callable-p (gf)
1762  (and (eq (generic-function-method-combination gf) 'standard)
1763       (null (intersection (%generic-function-lambda-list gf)
1764                           '(&rest &optional &key &allow-other-keys &aux)))))
1765
1766(declaim (ftype (function * t) slow-method-lookup-1))
1767
1768(declaim (ftype (function (t t t) t) slow-reader-lookup))
1769(defun slow-reader-lookup (gf layout slot-name)
1770  (let ((location (layout-slot-location layout slot-name)))
1771    (cache-slot-location gf layout location)
1772    location))
1773
1774(defun std-compute-discriminating-function (gf)
1775  (let ((code
1776         (cond
1777           ((and (= (length (generic-function-methods gf)) 1)
1778                 (typep (car (generic-function-methods gf)) 'standard-reader-method))
1779            ;;                 (sys::%format t "standard reader function ~S~%" (generic-function-name gf))
1780
1781            (let* ((method (%car (generic-function-methods gf)))
1782                   (class (car (%method-specializers method)))
1783                   (slot-name (reader-method-slot-name method)))
1784              #'(lambda (arg)
1785                  (declare (optimize speed))
1786                  (let* ((layout (std-instance-layout arg))
1787                         (location (get-cached-slot-location gf layout)))
1788                    (unless location
1789                      (unless (simple-typep arg class)
1790                        ;; FIXME no applicable method
1791                        (error 'simple-type-error
1792                               :datum arg
1793                               :expected-type class))
1794                      (setf location (slow-reader-lookup gf layout slot-name)))
1795                    (if (consp location)
1796                        ;; Shared slot.
1797                        (cdr location)
1798                        (standard-instance-access arg location))))))
1799
1800           (t
1801            (let* ((emf-table (classes-to-emf-table gf))
1802                   (number-required (length (gf-required-args gf)))
1803                   (lambda-list (%generic-function-lambda-list gf))
1804                   (exact (null (intersection lambda-list
1805                                              '(&rest &optional &key
1806                                                &allow-other-keys &aux)))))
1807              (if exact
1808                  (cond
1809                    ((= number-required 1)
1810                     (cond
1811                       ((and (eq (generic-function-method-combination gf) 'standard)
1812                             (= (length (generic-function-methods gf)) 1))
1813                        (let* ((method (%car (generic-function-methods gf)))
1814                               (specializer (car (%method-specializers method)))
1815                               (function (or (%method-fast-function method)
1816                                             (%method-function method))))
1817                          (if (typep specializer 'eql-specializer)
1818                              (let ((specializer-object (eql-specializer-object specializer)))
1819                                #'(lambda (arg)
1820                                    (declare (optimize speed))
1821                                    (if (eql arg specializer-object)
1822                                        (funcall function arg)
1823                                        (no-applicable-method gf (list arg)))))
1824                              #'(lambda (arg)
1825                                  (declare (optimize speed))
1826                                  (unless (simple-typep arg specializer)
1827                                    ;; FIXME no applicable method
1828                                    (error 'simple-type-error
1829                                           :datum arg
1830                                           :expected-type specializer))
1831                                  (funcall function arg)))))
1832                       (t
1833                        #'(lambda (arg)
1834                            (declare (optimize speed))
1835                            (let* ((specialization
1836                                    (%get-arg-specialization gf arg))
1837                                   (emfun (or (gethash1 specialization
1838                                                        emf-table)
1839                                              (slow-method-lookup-1
1840                                               gf arg specialization))))
1841                              (if emfun
1842                                  (funcall emfun (list arg))
1843                                  (apply #'no-applicable-method gf (list arg))))))))
1844                    ((= number-required 2)
1845                     #'(lambda (arg1 arg2)
1846                         (declare (optimize speed))
1847                         (let* ((args (list arg1 arg2))
1848                                (emfun (get-cached-emf gf args)))
1849                           (if emfun
1850                               (funcall emfun args)
1851                               (slow-method-lookup gf args)))))
1852                    ((= number-required 3)
1853                     #'(lambda (arg1 arg2 arg3)
1854                         (declare (optimize speed))
1855                         (let* ((args (list arg1 arg2 arg3))
1856                                (emfun (get-cached-emf gf args)))
1857                           (if emfun
1858                               (funcall emfun args)
1859                               (slow-method-lookup gf args)))))
1860                    (t
1861                     #'(lambda (&rest args)
1862                         (declare (optimize speed))
1863                         (let ((len (length args)))
1864                           (unless (= len number-required)
1865                             (error 'program-error
1866                                    :format-control "Not enough arguments for generic function ~S."
1867                                    :format-arguments (list (%generic-function-name gf)))))
1868                         (let ((emfun (get-cached-emf gf args)))
1869                           (if emfun
1870                               (funcall emfun args)
1871                               (slow-method-lookup gf args))))))
1872                  #'(lambda (&rest args)
1873                      (declare (optimize speed))
1874                      (let ((len (length args)))
1875                        (unless (>= len number-required)
1876                          (error 'program-error
1877                                 :format-control "Not enough arguments for generic function ~S."
1878                                 :format-arguments (list (%generic-function-name gf)))))
1879                      (let ((emfun (get-cached-emf gf args)))
1880                        (if emfun
1881                            (funcall emfun args)
1882                            (slow-method-lookup gf args))))))))))
1883
1884    code))
1885
1886(defun sort-methods (methods gf required-classes)
1887  (if (or (null methods) (null (%cdr methods)))
1888      methods
1889      (sort methods
1890      (if (eq (class-of gf) +the-standard-generic-function-class+)
1891    #'(lambda (m1 m2)
1892        (std-method-more-specific-p m1 m2 required-classes
1893            (generic-function-argument-precedence-order gf)))
1894    #'(lambda (m1 m2)
1895        (method-more-specific-p gf m1 m2 required-classes))))))
1896
1897(defun method-applicable-p (method args)
1898  (do* ((specializers (%method-specializers method) (cdr specializers))
1899        (args args (cdr args)))
1900       ((null specializers) t)
1901    (let ((specializer (car specializers)))
1902      (if (typep specializer 'eql-specializer)
1903          (unless (eql (car args) (eql-specializer-object specializer))
1904            (return nil))
1905          (unless (subclassp (class-of (car args)) specializer)
1906            (return nil))))))
1907
1908(defun %compute-applicable-methods (gf args)
1909  (let ((required-classes (mapcar #'class-of (required-portion gf args)))
1910        (methods '()))
1911    (dolist (method (generic-function-methods gf))
1912      (when (method-applicable-p method args)
1913        (push method methods)))
1914    (sort-methods methods gf required-classes)))
1915
1916;;; METHOD-APPLICABLE-USING-CLASSES-P
1917;;;
1918;;; If the first return value is T, METHOD is definitely applicable to
1919;;; arguments that are instances of CLASSES.  If the first value is
1920;;; NIL and the second value is T, METHOD is definitely not applicable
1921;;; to arguments that are instances of CLASSES; if the second value is
1922;;; NIL the applicability of METHOD cannot be determined by inspecting
1923;;; the classes of its arguments only.
1924;;;
1925(defun method-applicable-using-classes-p (method classes)
1926  (do* ((specializers (%method-specializers method) (cdr specializers))
1927  (classes classes (cdr classes))
1928  (knownp t))
1929       ((null specializers)
1930  (if knownp (values t t) (values nil nil)))
1931    (let ((specializer (car specializers)))
1932      (if (typep specializer 'eql-specializer)
1933    (if (eql (class-of (eql-specializer-object specializer)) 
1934       (car classes))
1935        (setf knownp nil)
1936        (return (values nil t)))
1937    (unless (subclassp (car classes) specializer)
1938      (return (values nil t)))))))
1939
1940(defun slow-method-lookup (gf args)
1941  (let ((applicable-methods (%compute-applicable-methods gf args)))
1942    (if applicable-methods
1943        (let ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
1944                                  #'std-compute-effective-method-function
1945                                  #'compute-effective-method-function)
1946                              gf applicable-methods)))
1947          (cache-emf gf args emfun)
1948          (funcall emfun args))
1949        (apply #'no-applicable-method gf args))))
1950
1951(defun slow-method-lookup-1 (gf arg arg-specialization)
1952  (let ((applicable-methods (%compute-applicable-methods gf (list arg))))
1953    (if applicable-methods
1954        (let ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
1955                                  #'std-compute-effective-method-function
1956                                  #'compute-effective-method-function)
1957                              gf applicable-methods)))
1958          (when emfun
1959            (setf (gethash arg-specialization (classes-to-emf-table gf)) emfun))
1960          emfun))))
1961
1962(defun sub-specializer-p (c1 c2 c-arg)
1963  (find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
1964
1965(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
1966  (if argument-precedence-order
1967      (let ((specializers-1 (%method-specializers method1))
1968            (specializers-2 (%method-specializers method2)))
1969        (dolist (index argument-precedence-order)
1970          (let ((spec1 (nth index specializers-1))
1971                (spec2 (nth index specializers-2)))
1972            (unless (eq spec1 spec2)
1973              (cond ((typep spec1 'eql-specializer)
1974                     (return t))
1975                    ((typep spec2 'eql-specializer)
1976                     (return nil))
1977                    (t
1978                     (return (sub-specializer-p spec1 spec2
1979                                                (nth index required-classes)))))))))
1980      (do ((specializers-1 (%method-specializers method1) (cdr specializers-1))
1981           (specializers-2 (%method-specializers method2) (cdr specializers-2))
1982           (classes required-classes (cdr classes)))
1983          ((null specializers-1) nil)
1984        (let ((spec1 (car specializers-1))
1985              (spec2 (car specializers-2)))
1986          (unless (eq spec1 spec2)
1987            (cond ((typep spec1 'eql-specializer)
1988                   (return t))
1989                  ((typep spec2 'eql-specializer)
1990                   (return nil))
1991                  (t
1992                   (return (sub-specializer-p spec1 spec2 (car classes))))))))))
1993
1994(defun primary-method-p (method)
1995  (null (intersection '(:before :after :around) (method-qualifiers method))))
1996
1997(defun before-method-p (method)
1998  (equal '(:before) (method-qualifiers method)))
1999
2000(defun after-method-p (method)
2001  (equal '(:after) (method-qualifiers method)))
2002
2003(defun around-method-p (method)
2004  (equal '(:around) (method-qualifiers method)))
2005
2006(defun process-next-method-list (next-method-list)
2007  (mapcar #'(lambda (next-method-form)
2008              (cond
2009                ((listp next-method-form)
2010                 (assert (eq (first next-method-form) 'make-method))
2011                 (let* ((rest-sym (gensym)))
2012                   (make-instance-standard-method
2013                    nil ;; ignored
2014                    :lambda-list (list '&rest rest-sym)
2015                    :function (compute-method-function `(lambda (&rest ,rest-sym)
2016                                                          ,(second next-method-form))))))
2017                (t
2018                 (assert (typep next-method-form 'method))
2019                 next-method-form)))
2020          next-method-list))
2021
2022(defun std-compute-effective-method-function (gf methods)
2023  (let* ((mc (generic-function-method-combination gf))
2024         (mc-name (if (atom mc) mc (%car mc)))
2025         (options (if (atom mc) '() (%cdr mc)))
2026         (order (car options))
2027         (primaries '())
2028         (arounds '())
2029         around
2030         emf-form
2031         (long-method-combination-p
2032          (typep (get mc-name 'method-combination-object) 'long-method-combination)))
2033    (unless long-method-combination-p
2034      (dolist (m methods)
2035        (let ((qualifiers (method-qualifiers m)))
2036          (cond ((null qualifiers)
2037                 (if (eq mc-name 'standard)
2038                     (push m primaries)
2039                     (error "Method combination type mismatch.")))
2040                ((cdr qualifiers)
2041                 (error "Invalid method qualifiers."))
2042                ((eq (car qualifiers) :around)
2043                 (push m arounds))
2044                ((eq (car qualifiers) mc-name)
2045                 (push m primaries))
2046                ((memq (car qualifiers) '(:before :after)))
2047                (t
2048                 (error "Invalid method qualifiers."))))))
2049    (unless (eq order :most-specific-last)
2050      (setf primaries (nreverse primaries)))
2051    (setf arounds (nreverse arounds))
2052    (setf around (car arounds))
2053    (when (and (null primaries) (not long-method-combination-p))
2054      (error "No primary methods for the generic function ~S." gf))
2055    (cond
2056      (around
2057       (let ((next-emfun
2058              (funcall
2059               (if (eq (class-of gf) +the-standard-generic-function-class+)
2060                   #'std-compute-effective-method-function
2061                   #'compute-effective-method-function)
2062               gf (remove around methods))))
2063         (setf emf-form
2064               (generate-emf-lambda (%method-function around) next-emfun))))
2065      ((eq mc-name 'standard)
2066       (let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2067              (befores (remove-if-not #'before-method-p methods))
2068              (reverse-afters
2069               (reverse (remove-if-not #'after-method-p methods))))
2070         (setf emf-form
2071               (cond
2072                 ((and (null befores) (null reverse-afters))
2073                  (let ((fast-function (%method-fast-function (car primaries))))
2074                    (if fast-function
2075                        (ecase (length (gf-required-args gf))
2076                          (1
2077                           #'(lambda (args)
2078                               (declare (optimize speed))
2079                               (funcall fast-function (car args))))
2080                          (2
2081                           #'(lambda (args)
2082                               (declare (optimize speed))
2083                               (funcall fast-function (car args) (cadr args)))))
2084                        (generate-emf-lambda (%method-function (car primaries))
2085                                             next-emfun))))
2086                 (t
2087                  (let ((method-function (%method-function (car primaries))))
2088                    #'(lambda (args)
2089                        (declare (optimize speed))
2090                        (dolist (before befores)
2091                          (funcall (%method-function before) args nil))
2092                        (multiple-value-prog1
2093                            (funcall method-function args next-emfun)
2094                          (dolist (after reverse-afters)
2095                            (funcall (%method-function after) args nil))))))))))
2096      (long-method-combination-p
2097       (let* ((mc-obj (get mc-name 'method-combination-object))
2098              (function (long-method-combination-function mc-obj))
2099              (arguments (rest (slot-value gf 'method-combination))))
2100         (assert (typep mc-obj 'long-method-combination))
2101         (assert function)
2102         (setf emf-form
2103               (if arguments
2104                   (apply function gf methods arguments)
2105                   (funcall function gf methods)))))
2106      (t
2107       (let ((mc-obj (get mc-name 'method-combination-object)))
2108         (unless (typep mc-obj 'short-method-combination)
2109           (error "Unsupported method combination type ~A."
2110                  mc-name))
2111         (let* ((operator (short-method-combination-operator mc-obj))
2112                (ioa (short-method-combination-identity-with-one-argument mc-obj)))
2113           (setf emf-form
2114                 (if (and (null (cdr primaries))
2115                          (not (null ioa)))
2116                     (generate-emf-lambda (%method-function (car primaries)) nil)
2117                     `(lambda (args)
2118                        (,operator ,@(mapcar
2119                                      (lambda (primary)
2120                                        `(funcall ,(%method-function primary) args nil))
2121                                      primaries)))))))))
2122    (assert (not (null emf-form)))
2123    (or #+nil (ignore-errors (autocompile emf-form))
2124        (coerce-to-function emf-form))))
2125
2126(defun generate-emf-lambda (method-function next-emfun)
2127  #'(lambda (args)
2128      (declare (optimize speed))
2129      (funcall method-function args next-emfun)))
2130
2131;;; compute an effective method function from a list of primary methods:
2132
2133(defun compute-primary-emfun (methods)
2134  (if (null methods)
2135      nil
2136      (let ((next-emfun (compute-primary-emfun (cdr methods))))
2137        #'(lambda (args)
2138           (funcall (%method-function (car methods)) args next-emfun)))))
2139
2140(defvar *call-next-method-p*)
2141(defvar *next-method-p-p*)
2142
2143(defun walk-form (form)
2144  (cond ((atom form)
2145         (cond ((eq form 'call-next-method)
2146                (setf *call-next-method-p* t))
2147               ((eq form 'next-method-p)
2148                (setf *next-method-p-p* t))))
2149        (t
2150         (walk-form (%car form))
2151         (walk-form (%cdr form)))))
2152
2153(defun compute-method-function (lambda-expression)
2154  (let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2155        (body (cddr lambda-expression))
2156        (*call-next-method-p* nil)
2157        (*next-method-p-p* nil))
2158    (multiple-value-bind (body declarations) (parse-body body)
2159      (let ((ignorable-vars '()))
2160        (dolist (var lambda-list)
2161          (if (memq var lambda-list-keywords)
2162              (return)
2163              (push var ignorable-vars)))
2164        (push `(declare (ignorable ,@ignorable-vars)) declarations))
2165      (walk-form body)
2166      (cond ((or *call-next-method-p* *next-method-p-p*)
2167             `(lambda (args next-emfun)
2168                (flet ((call-next-method (&rest cnm-args)
2169                         (if (null next-emfun)
2170                             (error "No next method for generic function.")
2171                             (funcall next-emfun (or cnm-args args))))
2172                       (next-method-p ()
2173                         (not (null next-emfun))))
2174                  (declare (ignorable (function call-next-method)
2175                                      (function next-method-p)))
2176                  (apply #'(lambda ,lambda-list ,@declarations ,@body) args))))
2177            ((null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2178             ;; Required parameters only.
2179             (case (length lambda-list)
2180               (1
2181                `(lambda (args next-emfun)
2182                   (declare (ignore next-emfun))
2183                   (let ((,(%car lambda-list) (%car args)))
2184                     (declare (ignorable ,(%car lambda-list)))
2185                     ,@declarations ,@body)))
2186               (2
2187                `(lambda (args next-emfun)
2188                   (declare (ignore next-emfun))
2189                   (let ((,(%car lambda-list) (%car args))
2190                         (,(%cadr lambda-list) (%cadr args)))
2191                     (declare (ignorable ,(%car lambda-list)
2192                                         ,(%cadr lambda-list)))
2193                     ,@declarations ,@body)))
2194               (3
2195                `(lambda (args next-emfun)
2196                   (declare (ignore next-emfun))
2197                   (let ((,(%car lambda-list) (%car args))
2198                         (,(%cadr lambda-list) (%cadr args))
2199                         (,(%caddr lambda-list) (%caddr args)))
2200                     (declare (ignorable ,(%car lambda-list)
2201                                         ,(%cadr lambda-list)
2202                                         ,(%caddr lambda-list)))
2203                     ,@declarations ,@body)))
2204               (t
2205                `(lambda (args next-emfun)
2206                   (declare (ignore next-emfun))
2207                   (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))
2208            (t
2209             `(lambda (args next-emfun)
2210                (declare (ignore next-emfun))
2211                (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))))
2212
2213(defun compute-method-fast-function (lambda-expression)
2214  (let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2215    (when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2216      (return-from compute-method-fast-function nil))
2217    ;; Only required args.
2218    (let ((body (cddr lambda-expression))
2219          (*call-next-method-p* nil)
2220          (*next-method-p-p* nil))
2221      (multiple-value-bind (body declarations) (parse-body body)
2222        (walk-form body)
2223        (when (or *call-next-method-p* *next-method-p-p*)
2224          (return-from compute-method-fast-function nil))
2225        (let ((decls `(declare (ignorable ,@lambda-list))))
2226          (setf lambda-expression
2227                (list* (car lambda-expression)
2228                       (cadr lambda-expression)
2229                       decls
2230                       (cddr lambda-expression))))
2231        (case (length lambda-list)
2232          (1
2233;;            `(lambda (args next-emfun)
2234;;               (let ((,(%car lambda-list) (%car args)))
2235;;                 (declare (ignorable ,(%car lambda-list)))
2236;;                 ,@declarations ,@body)))
2237           lambda-expression)
2238          (2
2239;;            `(lambda (args next-emfun)
2240;;               (let ((,(%car lambda-list) (%car args))
2241;;                     (,(%cadr lambda-list) (%cadr args)))
2242;;                 (declare (ignorable ,(%car lambda-list)
2243;;                                     ,(%cadr lambda-list)))
2244;;                 ,@declarations ,@body)))
2245           lambda-expression)
2246;;           (3
2247;;            `(lambda (args next-emfun)
2248;;               (let ((,(%car lambda-list) (%car args))
2249;;                     (,(%cadr lambda-list) (%cadr args))
2250;;                     (,(%caddr lambda-list) (%caddr args)))
2251;;                 (declare (ignorable ,(%car lambda-list)
2252;;                                     ,(%cadr lambda-list)
2253;;                                     ,(%caddr lambda-list)))
2254;;                 ,@declarations ,@body)))
2255          (t
2256           nil))))))
2257
2258;; From CLHS section 7.6.5:
2259;; "When a generic function or any of its methods mentions &key in a lambda
2260;; list, the specific set of keyword arguments accepted by the generic function
2261;; varies according to the applicable methods. The set of keyword arguments
2262;; accepted by the generic function for a particular call is the union of the
2263;; keyword arguments accepted by all applicable methods and the keyword
2264;; arguments mentioned after &key in the generic function definition, if any."
2265;; Adapted from Sacla.
2266(defun allow-other-keys (lambda-list)
2267  (if (and (member '&key lambda-list)
2268           (not (member '&allow-other-keys lambda-list)))
2269      (let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2270             (aux-part (subseq lambda-list key-end)))
2271        `(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2272      lambda-list))
2273
2274(defmacro defmethod (&rest args)
2275  (multiple-value-bind
2276      (function-name qualifiers lambda-list specializers documentation declarations body)
2277      (parse-defmethod args)
2278    (let* ((specializers-form '())
2279           (lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2280           (method-function (compute-method-function lambda-expression))
2281           (fast-function (compute-method-fast-function lambda-expression))
2282           )
2283      (dolist (specializer specializers)
2284        (cond ((and (consp specializer) (eq (car specializer) 'eql))
2285               (push `(list 'eql ,(cadr specializer)) specializers-form))
2286              (t
2287               (push `',specializer specializers-form))))
2288      (setf specializers-form `(list ,@(nreverse specializers-form)))
2289      `(progn
2290         (ensure-method ',function-name
2291                        :lambda-list ',lambda-list
2292                        :qualifiers ',qualifiers
2293                        :specializers ,specializers-form
2294                        ,@(if documentation `(:documentation ,documentation))
2295                        :function (function ,method-function)
2296                        ,@(if fast-function `(:fast-function (function ,fast-function)))
2297                        )))))
2298
2299;;; Reader and writer methods
2300
2301(defun make-instance-standard-reader-method (gf
2302                                             &key
2303                                             lambda-list
2304                                             qualifiers
2305                                             specializers
2306                                             documentation
2307                                             function
2308                                             fast-function
2309                                             slot-name)
2310  (declare (ignore gf))
2311  (let ((method (std-allocate-instance +the-standard-reader-method-class+)))
2312    (setf (method-lambda-list method) lambda-list)
2313    (setf (method-qualifiers method) qualifiers)
2314    (%set-method-specializers method (canonicalize-specializers specializers))
2315    (setf (method-documentation method) documentation)
2316    (%set-method-generic-function method nil)
2317    (%set-method-function method function)
2318    (%set-method-fast-function method fast-function)
2319    (set-reader-method-slot-name method slot-name)
2320    method))
2321
2322(defun add-reader-method (class function-name slot-name)
2323  (let* ((lambda-expression
2324          (if (eq (class-of class) +the-standard-class+)
2325              `(lambda (object) (std-slot-value object ',slot-name))
2326              `(lambda (object) (slot-value object ',slot-name))))
2327         (method-function (compute-method-function lambda-expression))
2328         (fast-function (compute-method-fast-function lambda-expression)))
2329    (let ((method-lambda-list '(object))
2330          (gf (find-generic-function function-name nil)))
2331      (if gf
2332          (check-method-lambda-list function-name
2333                                    method-lambda-list
2334                                    (generic-function-lambda-list gf))
2335        (setf gf (ensure-generic-function function-name :lambda-list method-lambda-list)))
2336      (let ((method
2337             (make-instance-standard-reader-method gf
2338                                                   :lambda-list '(object)
2339                                                   :qualifiers ()
2340                                                   :specializers (list class)
2341                                                   :function (if (autoloadp 'compile)
2342                                                                 method-function
2343                                                                 (autocompile method-function))
2344                                                   :fast-function (if (autoloadp 'compile)
2345                                                                      fast-function
2346                                                                      (autocompile fast-function))
2347                                                   :slot-name slot-name)))
2348        (%add-method gf method)
2349        method))))
2350
2351(defun add-writer-method (class function-name slot-name)
2352  (let* ((lambda-expression
2353          (if (eq (class-of class) +the-standard-class+)
2354              `(lambda (new-value object)
2355                 (setf (std-slot-value object ',slot-name) new-value))
2356              `(lambda (new-value object)
2357                 (setf (slot-value object ',slot-name) new-value))))
2358         (method-function (compute-method-function lambda-expression))
2359         (fast-function (compute-method-fast-function lambda-expression))
2360         )
2361    (ensure-method function-name
2362                   :lambda-list '(new-value object)
2363                   :qualifiers ()
2364                   :specializers (list +the-T-class+ class)
2365;;                    :function `(function ,method-function)
2366                   :function (if (autoloadp 'compile)
2367                                 method-function
2368                                 (autocompile method-function))
2369                   :fast-function (if (autoloadp 'compile)
2370                                      fast-function
2371                                      (autocompile fast-function))
2372                   )))
2373
2374(defmacro atomic-defgeneric (function-name &rest rest)
2375  "Macro to define a generic function and 'swap it into place' after
2376it's been fully defined with all its methods.
2377
2378Note: the user should really use the (:method ..) method description
2379way of defining methods; there's not much use in atomically defining
2380generic functions without providing sensible behaviour..."
2381  (let ((temp-sym (gensym)))
2382    `(progn
2383       (defgeneric ,temp-sym ,@rest)
2384       (let ((gf (symbol-function ',temp-sym)))
2385         (setf ,(if (and (consp function-name)
2386                         (eq (car function-name) 'setf))
2387                    `(get ',(second function-name) 'setf-function)
2388                  `(symbol-function ',function-name)) gf)
2389         (%set-generic-function-name gf ',function-name)
2390         gf))))
2391
2392(defmacro redefine-class-forwarder (name slot)
2393  "Define a generic function on a temporary symbol as an accessor
2394for the slot `slot'. Then, when definition is complete (including
2395allocation of methods), swap the definition in place.
2396
2397Without this approach, we can't depend the old forwarders to be
2398in place, while we still need them to "
2399  (let* (($name (if (consp name) (cadr name) name))
2400         (%name (intern (concatenate 'string
2401                                     "%"
2402                                     (if (consp name)
2403                                         (symbol-name 'set-) "")
2404                                     (symbol-name $name))
2405                        (find-package "SYS"))))
2406    `(atomic-defgeneric ,name (;; splice a new-value parameter for setters
2407                               ,@(when (consp name) (list 'new-value))
2408                               class)
2409         ,@(mapcar (if (consp name)
2410                       #'(lambda (class-name)
2411                           `(:method (new-value (class ,class-name))
2412                                     (,%name new-value class)))
2413                     #'(lambda (class-name)
2414                         `(:method ((class ,class-name))
2415                                   (,%name class))))
2416                   '(built-in-class
2417                     forward-referenced-class
2418                     structure-class))
2419         (:method (,@(when (consp name) (list 'new-value))
2420                   (class standard-class))
2421             ,(if (consp name)
2422                  `(setf (slot-value class ',slot) new-value)
2423                `(slot-value class ',slot))))))
2424
2425
2426(redefine-class-forwarder class-name name)
2427(redefine-class-forwarder (setf class-name) name)
2428(redefine-class-forwarder class-slots slots)
2429(redefine-class-forwarder (setf class-slots) slots)
2430(redefine-class-forwarder class-direct-slots direct-slots)
2431(redefine-class-forwarder (setf class-direct-slots) direct-slots)
2432(redefine-class-forwarder class-layout layout)
2433(redefine-class-forwarder (setf class-layout) layout)
2434(redefine-class-forwarder class-direct-superclasses direct-superclasses)
2435(redefine-class-forwarder (setf class-direct-superclasses) direct-superclasses)
2436(redefine-class-forwarder class-direct-subclasses direct-subclasses)
2437(redefine-class-forwarder (setf class-direct-subclasses) direct-subclasses)
2438(redefine-class-forwarder class-direct-methods direct-methods)
2439(redefine-class-forwarder (setf class-direct-methods) direct-methods)
2440(redefine-class-forwarder class-precedence-list precedence-list)
2441(redefine-class-forwarder (setf class-precedence-list) precedence-list)
2442(redefine-class-forwarder class-finalized-p finalized-p)
2443(redefine-class-forwarder (setf class-finalized-p) finalized-p)
2444(redefine-class-forwarder class-default-initargs default-initargs)
2445(redefine-class-forwarder (setf class-default-initargs) default-initargs)
2446(redefine-class-forwarder class-direct-default-initargs direct-default-initargs)
2447(redefine-class-forwarder (setf class-direct-default-initargs) direct-default-initargs)
2448
2449(defgeneric direct-slot-definition-class (class &rest initargs))
2450
2451(defmethod direct-slot-definition-class ((class class) &rest initargs)
2452  (declare (ignore initargs))
2453  +the-standard-direct-slot-definition-class+)
2454
2455(defgeneric effective-slot-definition-class (class &rest initargs))
2456
2457(defmethod effective-slot-definition-class ((class class) &rest initargs)
2458  (declare (ignore initargs))
2459  +the-standard-effective-slot-definition-class+)
2460
2461(atomic-defgeneric documentation (x doc-type)
2462    (:method ((x symbol) doc-type)
2463        (%documentation x doc-type))
2464    (:method ((x function) doc-type)
2465        (%documentation x doc-type)))
2466
2467(atomic-defgeneric (setf documentation) (new-value x doc-type)
2468    (:method (new-value (x symbol) doc-type)
2469        (%set-documentation x doc-type new-value))
2470    (:method (new-value (x function) doc-type)
2471        (%set-documentation x doc-type new-value)))
2472
2473
2474;; FIXME This should be a weak hashtable!
2475(defvar *list-documentation-hashtable* (make-hash-table :test #'equal))
2476
2477(defmethod documentation ((x list) (doc-type (eql 'function)))
2478  (let ((alist (gethash x *list-documentation-hashtable*)))
2479    (and alist (cdr (assoc doc-type alist)))))
2480
2481(defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
2482  (let ((alist (gethash x *list-documentation-hashtable*)))
2483    (and alist (cdr (assoc doc-type alist)))))
2484
2485(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
2486  (let* ((alist (gethash x *list-documentation-hashtable*))
2487         (entry (and alist (assoc doc-type alist))))
2488    (cond (entry
2489           (setf (cdr entry) new-value))
2490          (t
2491           (setf (gethash x *list-documentation-hashtable*)
2492                 (push (cons doc-type new-value) alist)))))
2493  new-value)
2494
2495(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro)))
2496  (let* ((alist (gethash x *list-documentation-hashtable*))
2497         (entry (and alist (assoc doc-type alist))))
2498    (cond (entry
2499           (setf (cdr entry) new-value))
2500          (t
2501           (setf (gethash x *list-documentation-hashtable*)
2502                 (push (cons doc-type new-value) alist)))))
2503  new-value)
2504
2505(defmethod documentation ((x standard-class) (doc-type (eql 't)))
2506  (class-documentation x))
2507
2508(defmethod documentation ((x standard-class) (doc-type (eql 'type)))
2509  (class-documentation x))
2510
2511(defmethod (setf documentation) (new-value (x standard-class) (doc-type (eql 't)))
2512  (%set-class-documentation x new-value))
2513
2514(defmethod (setf documentation) (new-value (x standard-class) (doc-type (eql 'type)))
2515  (%set-class-documentation x new-value))
2516
2517(defmethod documentation ((x structure-class) (doc-type (eql 't)))
2518  (%documentation x doc-type))
2519
2520(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
2521  (%documentation x doc-type))
2522
2523(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 't)))
2524  (%set-documentation x doc-type new-value))
2525
2526(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 'type)))
2527  (%set-documentation x doc-type new-value))
2528
2529(defmethod documentation ((x standard-generic-function) (doc-type (eql 't)))
2530  (generic-function-documentation x))
2531
2532(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 't)))
2533  (setf (generic-function-documentation x) new-value))
2534
2535(defmethod documentation ((x standard-generic-function) (doc-type (eql 'function)))
2536  (generic-function-documentation x))
2537
2538(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 'function)))
2539  (setf (generic-function-documentation x) new-value))
2540
2541(defmethod documentation ((x standard-method) (doc-type (eql 't)))
2542  (method-documentation x))
2543
2544(defmethod (setf documentation) (new-value (x standard-method) (doc-type (eql 't)))
2545  (setf (method-documentation x) new-value))
2546
2547(defmethod documentation ((x package) (doc-type (eql 't)))
2548  (%documentation x doc-type))
2549
2550(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
2551  (%set-documentation x doc-type new-value))
2552
2553(defmethod documentation ((x symbol) (doc-type (eql 'function)))
2554  (%documentation x doc-type))
2555
2556;;; Applicable methods
2557
2558(defgeneric compute-applicable-methods (gf args)
2559  (:method ((gf standard-generic-function) args)
2560    (%compute-applicable-methods gf args)))
2561
2562(defgeneric compute-applicable-methods-using-classes (gf classes)
2563  (:method ((gf standard-generic-function) classes)
2564    (let ((methods '()))
2565      (dolist (method (generic-function-methods gf))
2566  (multiple-value-bind (applicable knownp)
2567      (method-applicable-using-classes-p method classes)
2568    (cond (applicable
2569     (push method methods))
2570    ((not knownp)
2571     (return-from compute-applicable-methods-using-classes
2572       (values nil nil))))))
2573      (values (sort-methods methods gf classes)
2574        t))))
2575
2576(export '(compute-applicable-methods
2577    compute-applicable-methods-using-classes))
2578
2579
2580;;; Slot access
2581
2582(defun set-slot-value-using-class (new-value class instance slot-name)
2583  (declare (ignore class)) ; FIXME
2584  (setf (std-slot-value instance slot-name) new-value))
2585
2586(defgeneric slot-value-using-class (class instance slot-name))
2587
2588(defmethod slot-value-using-class ((class standard-class) instance slot-name)
2589  (std-slot-value instance slot-name))
2590
2591(defmethod slot-value-using-class ((class structure-class) instance slot-name)
2592  (std-slot-value instance slot-name))
2593
2594(defgeneric (setf slot-value-using-class) (new-value class instance slot-name))
2595
2596(defmethod (setf slot-value-using-class) (new-value
2597                                          (class standard-class)
2598                                          instance
2599                                          slot-name)
2600  (setf (std-slot-value instance slot-name) new-value))
2601
2602(defmethod (setf slot-value-using-class) (new-value
2603                                          (class structure-class)
2604                                          instance
2605                                          slot-name)
2606  (setf (std-slot-value instance slot-name) new-value))
2607
2608(defgeneric slot-exists-p-using-class (class instance slot-name))
2609
2610(defmethod slot-exists-p-using-class (class instance slot-name)
2611  nil)
2612
2613(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
2614  (std-slot-exists-p instance slot-name))
2615
2616(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
2617  (dolist (dsd (class-slots class))
2618    (when (eq (sys::dsd-name dsd) slot-name)
2619      (return-from slot-exists-p-using-class t)))
2620  nil)
2621
2622(defgeneric slot-boundp-using-class (class instance slot-name))
2623(defmethod slot-boundp-using-class ((class standard-class) instance slot-name)
2624  (std-slot-boundp instance slot-name))
2625(defmethod slot-boundp-using-class ((class structure-class) instance slot-name)
2626  "Structure slots can't be unbound, so this method always returns T."
2627  (declare (ignore class instance slot-name))
2628  t)
2629
2630(defgeneric slot-makunbound-using-class (class instance slot-name))
2631(defmethod slot-makunbound-using-class ((class standard-class)
2632                                        instance
2633                                        slot-name)
2634  (std-slot-makunbound instance slot-name))
2635(defmethod slot-makunbound-using-class ((class structure-class)
2636                                        instance
2637                                        slot-name)
2638  (declare (ignore class instance slot-name))
2639  (error "Structure slots can't be unbound"))
2640
2641(defgeneric slot-missing (class instance slot-name operation &optional new-value))
2642
2643(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
2644  (declare (ignore new-value))
2645  (error "The slot ~S is missing from the class ~S." slot-name class))
2646
2647(defgeneric slot-unbound (class instance slot-name))
2648
2649(defmethod slot-unbound ((class t) instance slot-name)
2650  (error 'unbound-slot :instance instance :name slot-name))
2651
2652;;; Instance creation and initialization
2653
2654(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
2655
2656(defmethod allocate-instance ((class standard-class) &rest initargs)
2657  (declare (ignore initargs))
2658  (std-allocate-instance class))
2659
2660(defmethod allocate-instance ((class structure-class) &rest initargs)
2661  (declare (ignore initargs))
2662  (%make-structure (class-name class)
2663                   (make-list (length (class-slots class))
2664                              :initial-element +slot-unbound+)))
2665
2666;; "The set of valid initialization arguments for a class is the set of valid
2667;; initialization arguments that either fill slots or supply arguments to
2668;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
2669;; 7.1.2
2670
2671(defun calculate-allowable-initargs (gf-list args instance
2672                                             shared-initialize-param
2673                                             initargs)
2674  (let* ((methods
2675          (nconc
2676             (compute-applicable-methods #'shared-initialize
2677                                         (list* instance
2678                                                shared-initialize-param
2679                                                initargs))
2680             (mapcan #'(lambda (gf)
2681                         (compute-applicable-methods gf args))
2682                     gf-list)))
2683         (method-keyword-args
2684          (reduce #'merge-initargs-sets
2685                  (mapcar #'method-lambda-list methods)
2686                  :key #'extract-lambda-list-keywords
2687                  :initial-value nil))
2688         (slots-initargs
2689          (mapappend #'slot-definition-initargs
2690                     (class-slots (class-of instance)))))
2691    (merge-initargs-sets
2692     (merge-initargs-sets slots-initargs method-keyword-args)
2693     '(:allow-other-keys))))  ;; allow-other-keys is always allowed
2694
2695(defun check-initargs (gf-list args instance
2696                       shared-initialize-param initargs
2697                       cache)
2698  "Checks the validity of `initargs' for the generic functions in `gf-list'
2699when called with `args' by calculating the applicable methods for each gf.
2700The applicable methods for SHARED-INITIALIZE based on `instance',
2701`shared-initialize-param' and `initargs' are added to the list of
2702applicable methods."
2703  (when (oddp (length initargs))
2704    (error 'program-error
2705           :format-control "Odd number of keyword arguments."))
2706  (unless (getf initargs :allow-other-keys)
2707    (multiple-value-bind (allowable-initargs present-p)
2708                         (when cache
2709                           (gethash (class-of instance) cache))
2710       (unless present-p
2711         (setf allowable-initargs
2712               (calculate-allowable-initargs gf-list args instance
2713                                             shared-initialize-param initargs))
2714         (when cache
2715           (setf (gethash (class-of instance) cache)
2716                 allowable-initargs)))
2717       (unless (eq t allowable-initargs)
2718         (do* ((tail initargs (cddr tail))
2719               (initarg (car tail) (car tail)))
2720              ((null tail))
2721              (unless (memq initarg allowable-initargs)
2722                (error 'program-error
2723                       :format-control "Invalid initarg ~S."
2724                       :format-arguments (list initarg))))))))
2725
2726(defun merge-initargs-sets (list1 list2)
2727  (cond
2728   ((eq list1 t)  t)
2729   ((eq list2 t)  t)
2730   (t             (union list1 list2))))
2731
2732(defun extract-lambda-list-keywords (lambda-list)
2733  "Returns a list of keywords acceptable as keyword arguments,
2734or T when any keyword is acceptable due to presence of
2735&allow-other-keys."
2736  (when (member '&allow-other-keys lambda-list)
2737    (return-from extract-lambda-list-keywords t))
2738  (loop with keyword-args = (cdr (memq '&key lambda-list))
2739        for key in keyword-args
2740        when (eq key '&aux) do (loop-finish)
2741        when (eq key '&allow-other-keys) do (return t)
2742        when (listp key) do (setq key (car key))
2743        collect (if (symbolp key)
2744                    (make-keyword key)
2745                  (car key))))
2746
2747
2748(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
2749
2750(defmethod make-instance ((class standard-class) &rest initargs)
2751  (when (oddp (length initargs))
2752    (error 'program-error :format-control "Odd number of keyword arguments."))
2753  (unless (class-finalized-p class)
2754    (std-finalize-inheritance class))
2755  (let ((class-default-initargs (class-default-initargs class)))
2756    (when class-default-initargs
2757      (let ((default-initargs '()))
2758        (do* ((list class-default-initargs (cddr list))
2759              (key (car list) (car list))
2760              (fn (cadr list) (cadr list)))
2761             ((null list))
2762          (when (eq (getf initargs key 'not-found) 'not-found)
2763            (setf default-initargs (append default-initargs (list key (funcall fn))))))
2764        (setf initargs (append initargs default-initargs)))))
2765
2766  (let ((instance (std-allocate-instance class)))
2767    (check-initargs (list #'allocate-instance #'initialize-instance)
2768                    (list* instance initargs)
2769                    instance t initargs
2770                    *make-instance-initargs-cache*)
2771    (apply #'initialize-instance instance initargs)
2772    instance))
2773
2774(defmethod make-instance ((class symbol) &rest initargs)
2775  (apply #'make-instance (find-class class) initargs))
2776
2777(defgeneric initialize-instance (instance &key))
2778
2779(defmethod initialize-instance ((instance standard-object) &rest initargs)
2780  (apply #'shared-initialize instance t initargs))
2781
2782(defgeneric reinitialize-instance (instance &key))
2783
2784;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
2785;; validity of initargs and signals an error if an initarg is supplied that is
2786;; not declared as valid. The method then calls the generic function SHARED-
2787;; INITIALIZE with the following arguments: the instance, nil (which means no
2788;; slots should be initialized according to their initforms), and the initargs
2789;; it received."
2790(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
2791  (check-initargs (list #'reinitialize-instance) (list* instance initargs)
2792                  instance () initargs
2793                  *reinitialize-instance-initargs-cache*)
2794  (apply #'shared-initialize instance () initargs))
2795
2796(defun std-shared-initialize (instance slot-names all-keys)
2797  (when (oddp (length all-keys))
2798    (error 'program-error :format-control "Odd number of keyword arguments."))
2799  ;; do a quick scan of the arguments list to see if it's a real
2800  ;; 'initialization argument list' (which is not the same as
2801  ;; checking initarg validity
2802  (do* ((tail all-keys (cddr tail))
2803        (initarg (car tail) (car tail)))
2804      ((null tail))
2805    (unless (symbolp initarg)
2806      (error 'program-error
2807             :format-control "Invalid initarg ~S."
2808             :format-arguments (list initarg))))
2809  (dolist (slot (class-slots (class-of instance)))
2810    (let ((slot-name (slot-definition-name slot)))
2811      (multiple-value-bind (init-key init-value foundp)
2812          (get-properties all-keys (slot-definition-initargs slot))
2813        (if foundp
2814            (setf (std-slot-value instance slot-name) init-value)
2815            (unless (std-slot-boundp instance slot-name)
2816              (let ((initfunction (slot-definition-initfunction slot)))
2817                (when (and initfunction (or (eq slot-names t)
2818                                            (memq slot-name slot-names)))
2819                  (setf (std-slot-value instance slot-name)
2820                        (funcall initfunction)))))))))
2821  instance)
2822
2823(defgeneric shared-initialize (instance slot-names &key))
2824
2825(defmethod shared-initialize ((instance standard-object) slot-names &rest initargs)
2826  (std-shared-initialize instance slot-names initargs))
2827
2828(defmethod shared-initialize ((slot slot-definition) slot-names
2829                              &rest args
2830                              &key name initargs initform initfunction
2831                              readers writers allocation
2832                              &allow-other-keys)
2833  ;;Keyword args are duplicated from init-slot-definition only to have
2834  ;;them checked.
2835  (declare (ignore slot-names)) ;;TODO?
2836  (declare (ignore name initargs initform initfunction readers writers allocation))
2837  ;;For built-in slots
2838  (apply #'init-slot-definition slot :allow-other-keys t args)
2839  ;;For user-defined slots
2840  (call-next-method))
2841
2842;;; change-class
2843
2844(defgeneric change-class (instance new-class &key))
2845
2846(defmethod change-class ((old-instance standard-object) (new-class standard-class)
2847                         &rest initargs)
2848  (let ((old-slots (class-slots (class-of old-instance)))
2849        (new-slots (class-slots new-class))
2850        (new-instance (allocate-instance new-class)))
2851    ;; "The values of local slots specified by both the class CTO and the class
2852    ;; CFROM are retained. If such a local slot was unbound, it remains
2853    ;; unbound."
2854    (dolist (new-slot new-slots)
2855      (when (instance-slot-p new-slot)
2856        (let* ((slot-name (slot-definition-name new-slot))
2857               (old-slot (find slot-name old-slots :key 'slot-definition-name)))
2858          ;; "The values of slots specified as shared in the class CFROM and as
2859          ;; local in the class CTO are retained."
2860          (when (and old-slot (slot-boundp old-instance slot-name))
2861            (setf (slot-value new-instance slot-name)
2862                  (slot-value old-instance slot-name))))))
2863    (swap-slots old-instance new-instance)
2864    (rotatef (std-instance-layout new-instance)
2865             (std-instance-layout old-instance))
2866    (apply #'update-instance-for-different-class
2867           new-instance old-instance initargs)
2868    old-instance))
2869
2870(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
2871  (apply #'change-class instance (find-class new-class) initargs))
2872
2873(defgeneric update-instance-for-different-class (old new &key))
2874
2875(defmethod update-instance-for-different-class
2876  ((old standard-object) (new standard-object) &rest initargs)
2877  (let ((added-slots
2878         (remove-if #'(lambda (slot-name)
2879                       (slot-exists-p old slot-name))
2880                    (mapcar 'slot-definition-name
2881                            (class-slots (class-of new))))))
2882    (check-initargs (list #'update-instance-for-different-class)
2883                    (list old new initargs)
2884                    new added-slots initargs
2885                    nil)
2886    (apply #'shared-initialize new added-slots initargs)))
2887
2888;;; make-instances-obsolete
2889
2890(defgeneric make-instances-obsolete (class))
2891
2892(defmethod make-instances-obsolete ((class standard-class))
2893  (%make-instances-obsolete class))
2894
2895(defmethod make-instances-obsolete ((class symbol))
2896  (make-instances-obsolete (find-class class))
2897  class)
2898
2899;;; update-instance-for-redefined-class
2900
2901(defgeneric update-instance-for-redefined-class (instance
2902                                                 added-slots
2903                                                 discarded-slots
2904                                                 property-list
2905                                                 &rest initargs
2906                                                 &key
2907                                                 &allow-other-keys))
2908
2909(defmethod update-instance-for-redefined-class ((instance standard-object)
2910            added-slots
2911            discarded-slots
2912            property-list
2913            &rest initargs)
2914  (check-initargs (list #'update-instance-for-redefined-class)
2915                  (list* instance added-slots discarded-slots
2916                         property-list initargs)
2917                  instance added-slots initargs
2918                  nil)
2919  (apply #'shared-initialize instance added-slots initargs))
2920
2921;;;  Methods having to do with class metaobjects.
2922
2923(defmethod initialize-instance :after ((class standard-class) &rest args)
2924  (apply #'std-after-initialization-for-classes class args))
2925
2926(defmethod reinitialize-instance :after ((class standard-class) &rest all-keys)
2927  (remhash class *make-instance-initargs-cache*)
2928  (remhash class *reinitialize-instance-initargs-cache*)
2929  (%make-instances-obsolete class)
2930  (setf (class-finalized-p class) nil)
2931  (check-initargs (list #'allocate-instance
2932                        #'initialize-instance)
2933                  (list* class all-keys)
2934                  class t all-keys
2935                  nil)
2936  (apply #'std-after-initialization-for-classes class all-keys))
2937
2938;;; Finalize inheritance
2939
2940(atomic-defgeneric finalize-inheritance (class)
2941    (:method ((class standard-class))
2942       (std-finalize-inheritance class)))
2943
2944;;; Class precedence lists
2945
2946(defgeneric compute-class-precedence-list (class))
2947(defmethod compute-class-precedence-list ((class standard-class))
2948  (std-compute-class-precedence-list class))
2949
2950;;; Slot inheritance
2951
2952(defgeneric compute-slots (class))
2953(defmethod compute-slots ((class standard-class))
2954  (std-compute-slots class))
2955
2956(defgeneric compute-effective-slot-definition (class name direct-slots))
2957(defmethod compute-effective-slot-definition
2958  ((class standard-class) name direct-slots)
2959  (std-compute-effective-slot-definition class name direct-slots))
2960
2961;;; Methods having to do with generic function metaobjects.
2962
2963(defmethod initialize-instance :after ((gf standard-generic-function) &key)
2964  (finalize-generic-function gf))
2965
2966;;; Methods having to do with generic function invocation.
2967
2968(defgeneric compute-discriminating-function (gf))
2969(defmethod compute-discriminating-function ((gf standard-generic-function))
2970  (std-compute-discriminating-function gf))
2971
2972(defgeneric method-more-specific-p (gf method1 method2 required-classes))
2973
2974(defmethod method-more-specific-p ((gf standard-generic-function)
2975                                   method1 method2 required-classes)
2976  (std-method-more-specific-p method1 method2 required-classes
2977                              (generic-function-argument-precedence-order gf)))
2978
2979;;; XXX AMOP has COMPUTE-EFFECTIVE-METHOD
2980(defgeneric compute-effective-method-function (gf methods))
2981(defmethod compute-effective-method-function ((gf standard-generic-function) methods)
2982  (std-compute-effective-method-function gf methods))
2983
2984(defgeneric compute-applicable-methods (gf args))
2985(defmethod compute-applicable-methods ((gf standard-generic-function) args)
2986  (%compute-applicable-methods gf args))
2987
2988;;; Slot definition accessors
2989
2990(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
2991  `(let (($cl (class-of ,slot-definition)))
2992     (case $cl
2993       ((+the-standard-slot-definition-class+
2994         +the-standard-direct-slot-definition-class+
2995         +the-standard-effective-slot-definition-class+)
2996        ,std-form)
2997       (t ,generic-form))))
2998
2999(atomic-defgeneric slot-definition-allocation (slot-definition)
3000  (:method ((slot-definition slot-definition))
3001    (slot-definition-dispatch slot-definition
3002      (%slot-definition-allocation slot-definition)
3003      (slot-value slot-definition 'sys::allocation))))
3004
3005(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
3006  (:method (value (slot-definition slot-definition))
3007    (slot-definition-dispatch slot-definition
3008      (set-slot-definition-allocation slot-definition value)
3009      (setf (slot-value slot-definition 'sys::allocation) value))))
3010
3011(atomic-defgeneric slot-definition-initargs (slot-definition)
3012  (:method ((slot-definition slot-definition))
3013    (slot-definition-dispatch slot-definition
3014      (%slot-definition-initargs slot-definition)
3015      (slot-value slot-definition 'sys::initargs))))
3016
3017(atomic-defgeneric slot-definition-initform (slot-definition)
3018  (:method ((slot-definition slot-definition))
3019    (slot-definition-dispatch slot-definition
3020      (%slot-definition-initform slot-definition)
3021      (slot-value slot-definition 'sys::initform))))
3022
3023(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
3024  (:method (value (slot-definition slot-definition))
3025    (slot-definition-dispatch slot-definition
3026      (set-slot-definition-initform slot-definition value)
3027      (setf (slot-value slot-definition 'sys::initform) value))))
3028
3029(atomic-defgeneric slot-definition-initfunction (slot-definition)
3030  (:method ((slot-definition slot-definition))
3031    (slot-definition-dispatch slot-definition
3032      (%slot-definition-initfunction slot-definition)
3033      (slot-value slot-definition 'sys::initfunction))))
3034
3035(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
3036  (:method (value (slot-definition slot-definition))
3037    (slot-definition-dispatch slot-definition
3038      (set-slot-definition-initfunction slot-definition value)
3039      (setf (slot-value slot-definition 'sys::initfunction) value))))
3040
3041(atomic-defgeneric slot-definition-name (slot-definition)
3042  (:method ((slot-definition slot-definition))
3043    (slot-definition-dispatch slot-definition
3044      (%slot-definition-name slot-definition)
3045      (slot-value slot-definition 'sys::name))))
3046
3047(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
3048  (:method (value (slot-definition slot-definition))
3049    (slot-definition-dispatch slot-definition
3050      (set-slot-definition-name slot-definition value)
3051      (setf (slot-value slot-definition 'sys::name) value))))
3052
3053(atomic-defgeneric slot-definition-readers (slot-definition)
3054  (:method ((slot-definition slot-definition))
3055    (slot-definition-dispatch slot-definition
3056      (%slot-definition-readers slot-definition)
3057      (slot-value slot-definition 'sys::readers))))
3058
3059(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
3060  (:method (value (slot-definition slot-definition))
3061    (slot-definition-dispatch slot-definition
3062      (set-slot-definition-readers slot-definition value)
3063      (setf (slot-value slot-definition 'sys::readers) value))))
3064
3065(atomic-defgeneric slot-definition-writers (slot-definition)
3066  (:method ((slot-definition slot-definition))
3067    (slot-definition-dispatch slot-definition
3068      (%slot-definition-writers slot-definition)
3069      (slot-value slot-definition 'sys::writers))))
3070
3071(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
3072  (:method (value (slot-definition slot-definition))
3073    (slot-definition-dispatch slot-definition
3074      (set-slot-definition-writers slot-definition value)
3075      (setf (slot-value slot-definition 'sys::writers) value))))
3076
3077(atomic-defgeneric slot-definition-allocation-class (slot-definition)
3078  (:method ((slot-definition slot-definition))
3079    (slot-definition-dispatch slot-definition
3080      (%slot-definition-allocation-class slot-definition)
3081      (slot-value slot-definition 'sys::allocation-class))))
3082
3083(atomic-defgeneric (setf slot-definition-allocation-class)
3084                       (value slot-definition)
3085  (:method (value (slot-definition slot-definition))
3086    (slot-definition-dispatch slot-definition
3087      (set-slot-definition-allocation-class slot-definition value)
3088      (setf (slot-value slot-definition 'sys::allocation-class) value))))
3089
3090(atomic-defgeneric slot-definition-location (slot-definition)
3091  (:method ((slot-definition slot-definition))
3092    (slot-definition-dispatch slot-definition
3093      (%slot-definition-location slot-definition)
3094      (slot-value slot-definition 'sys::location))))
3095
3096(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
3097  (:method (value (slot-definition slot-definition))
3098    (slot-definition-dispatch slot-definition
3099      (set-slot-definition-location slot-definition value)
3100      (setf (slot-value slot-definition 'sys::location) value))))
3101
3102;;; No %slot-definition-type.
3103
3104
3105;;; Conditions.
3106
3107(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
3108  (let ((parent-types (or parent-types '(condition)))
3109        (report nil))
3110    (dolist (option options)
3111      (when (eq (car option) :report)
3112        (setf report (cadr option))
3113  (setf options (delete option options :test #'equal))
3114        (return)))
3115    (typecase report
3116      (null
3117       `(progn
3118          (defclass ,name ,parent-types ,slot-specs ,@options)
3119          ',name))
3120      (string
3121       `(progn
3122          (defclass ,name ,parent-types ,slot-specs ,@options)
3123          (defmethod print-object ((condition ,name) stream)
3124            (if *print-escape*
3125                (call-next-method)
3126                (progn (write-string ,report stream) condition)))
3127          ',name))
3128      (t
3129       `(progn
3130          (defclass ,name ,parent-types ,slot-specs ,@options)
3131          (defmethod print-object ((condition ,name) stream)
3132            (if *print-escape*
3133                (call-next-method)
3134                (funcall #',report condition stream)))
3135          ',name)))))
3136
3137(defun make-condition (type &rest initargs)
3138  (or (%make-condition type initargs)
3139      (let ((class (if (symbolp type) (find-class type) type)))
3140        (apply #'make-instance class initargs))))
3141
3142;; Adapted from SBCL.
3143;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
3144(defun coerce-to-condition (datum arguments default-type fun-name)
3145  (cond ((typep datum 'condition)
3146         (when arguments
3147           (error 'simple-type-error
3148                  :datum arguments
3149                  :expected-type 'null
3150                  :format-control "You may not supply additional arguments when giving ~S to ~S."
3151                  :format-arguments (list datum fun-name)))
3152         datum)
3153        ((symbolp datum)
3154         (apply #'make-condition datum arguments))
3155        ((or (stringp datum) (functionp datum))
3156         (make-condition default-type
3157                         :format-control datum
3158                         :format-arguments arguments))
3159        (t
3160         (error 'simple-type-error
3161                :datum datum
3162                :expected-type '(or symbol string)
3163                :format-control "Bad argument to ~S: ~S."
3164                :format-arguments (list fun-name datum)))))
3165
3166(defgeneric make-load-form (object &optional environment))
3167
3168(defmethod make-load-form ((object t) &optional environment)
3169  (declare (ignore environment))
3170  (apply #'no-applicable-method #'make-load-form (list object)))
3171
3172(defmethod make-load-form ((class class) &optional environment)
3173  (declare (ignore environment))
3174  (let ((name (class-name class)))
3175    (unless (and name (eq (find-class name nil) class))
3176      (error 'simple-type-error
3177             :format-control "Can't use anonymous or undefined class as a constant: ~S."
3178             :format-arguments (list class)))
3179    `(find-class ',name)))
3180
3181(defun invalid-method-error (method format-control &rest args)
3182  (let ((message (apply #'format nil format-control args)))
3183    (error "Invalid method error for ~S:~%    ~A" method message)))
3184
3185(defun method-combination-error (format-control &rest args)
3186  (let ((message (apply #'format nil format-control args)))
3187    (error "Method combination error in CLOS dispatch:~%    ~A" message)))
3188
3189
3190(atomic-defgeneric no-applicable-method (generic-function &rest args)
3191  (:method (generic-function &rest args)
3192      (error "There is no applicable method for the generic function ~S ~
3193              when called with arguments ~S."
3194             generic-function
3195             args)))
3196
3197
3198
3199(defgeneric find-method (generic-function
3200                         qualifiers
3201                         specializers
3202                         &optional errorp))
3203
3204(defmethod find-method ((generic-function standard-generic-function)
3205                        qualifiers specializers &optional (errorp t))
3206  (%find-method generic-function qualifiers specializers errorp))
3207
3208(defgeneric add-method (generic-function method))
3209
3210(defmethod add-method ((generic-function standard-generic-function)
3211                       (method method))
3212  (let ((method-lambda-list (method-lambda-list method))
3213        (gf-lambda-list (generic-function-lambda-list generic-function)))
3214    (check-method-lambda-list (%generic-function-name generic-function)
3215                              method-lambda-list gf-lambda-list))
3216  (%add-method generic-function method))
3217
3218(defgeneric remove-method (generic-function method))
3219
3220(defmethod remove-method ((generic-function standard-generic-function) method)
3221  (%remove-method generic-function method))
3222
3223;; See describe.lisp.
3224(defgeneric describe-object (object stream))
3225
3226;; FIXME
3227(defgeneric no-next-method (generic-function method &rest args))
3228
3229;; FIXME
3230(defgeneric function-keywords (method))
3231
3232
3233(setf *gf-initialize-instance* (symbol-function 'initialize-instance))
3234(setf *gf-allocate-instance* (symbol-function 'allocate-instance))
3235(setf *gf-shared-initialize* (symbol-function 'shared-initialize))
3236(setf *gf-reinitialize-instance* (symbol-function 'reinitialize-instance))
3237(setf *clos-booting* nil)
3238
3239(defgeneric class-prototype (class))
3240
3241(defmethod class-prototype :before (class)
3242  (unless (class-finalized-p class)
3243    (error "~@<~S is not finalized.~:@>" class)))
3244
3245(defmethod class-prototype ((class standard-class))
3246  (allocate-instance class))
3247
3248(defmethod class-prototype ((class structure-class))
3249  (allocate-instance class))
3250
3251(eval-when (:compile-toplevel :load-toplevel :execute)
3252  (require "MOP"))
3253
3254(provide 'clos)
3255
Note: See TracBrowser for help on using the repository browser.