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

Last change on this file since 13701 was 13701, checked in by Mark Evenson, 10 years ago

mop: implement mop:extract-specializer-names as specified in AMOP page 189.

Patch by Rudolf Schlatte.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 138.2 KB
Line 
1;;; clos.lisp
2;;;
3;;; Copyright (C) 2003-2007 Peter Graves
4;;; Copyright (C) 2010 Mark Evenson
5;;; $Id: clos.lisp 13701 2011-12-05 11:10:17Z mevenson $
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(defstruct eql-specializer
1182  object)
1183
1184(defparameter *eql-specializer-table* (make-hash-table :test 'eql))
1185
1186(defun intern-eql-specializer (object)
1187  (or (gethash object *eql-specializer-table*)
1188      (setf (gethash object *eql-specializer-table*)
1189            (make-eql-specializer :object object))))
1190
1191;; MOP (p. 216) specifies the following reader generic functions:
1192;;   generic-function-argument-precedence-order
1193;;   generic-function-declarations
1194;;   generic-function-lambda-list
1195;;   generic-function-method-class
1196;;   generic-function-method-combination
1197;;   generic-function-methods
1198;;   generic-function-name
1199
1200(defun generic-function-lambda-list (gf)
1201  (%generic-function-lambda-list gf))
1202(defsetf generic-function-lambda-list %set-generic-function-lambda-list)
1203
1204(defun (setf generic-function-documentation) (new-value gf)
1205  (set-generic-function-documentation gf new-value))
1206
1207(defun (setf generic-function-initial-methods) (new-value gf)
1208  (set-generic-function-initial-methods gf new-value))
1209
1210(defun (setf generic-function-methods) (new-value gf)
1211  (set-generic-function-methods gf new-value))
1212
1213(defun (setf generic-function-method-class) (new-value gf)
1214  (set-generic-function-method-class gf new-value))
1215
1216(defun (setf generic-function-method-combination) (new-value gf)
1217  (set-generic-function-method-combination gf new-value))
1218
1219(defun (setf generic-function-argument-precedence-order) (new-value gf)
1220  (set-generic-function-argument-precedence-order gf new-value))
1221
1222(declaim (ftype (function * t) classes-to-emf-table))
1223(defun classes-to-emf-table (gf)
1224  (generic-function-classes-to-emf-table gf))
1225
1226(defun (setf classes-to-emf-table) (new-value gf)
1227  (set-generic-function-classes-to-emf-table gf new-value))
1228
1229(defun (setf method-lambda-list) (new-value method)
1230  (set-method-lambda-list method new-value))
1231
1232(defun (setf method-qualifiers) (new-value method)
1233  (set-method-qualifiers method new-value))
1234
1235(defun (setf method-documentation) (new-value method)
1236  (set-method-documentation method new-value))
1237
1238;;; defgeneric
1239
1240(defmacro defgeneric (function-name lambda-list
1241                                    &rest options-and-method-descriptions)
1242  (let ((options ())
1243        (methods ())
1244        (documentation nil))
1245    (dolist (item options-and-method-descriptions)
1246      (case (car item)
1247        (declare) ; FIXME
1248        (:documentation
1249         (when documentation
1250           (error 'program-error
1251                  :format-control "Documentation option was specified twice for generic function ~S."
1252                  :format-arguments (list function-name)))
1253         (setf documentation t)
1254         (push item options))
1255        (:method
1256         (push
1257          `(push (defmethod ,function-name ,@(cdr item))
1258                 (generic-function-initial-methods (fdefinition ',function-name)))
1259          methods))
1260        (t
1261         (push item options))))
1262    (setf options (nreverse options)
1263          methods (nreverse methods))
1264    `(prog1
1265       (%defgeneric
1266        ',function-name
1267        :lambda-list ',lambda-list
1268        ,@(canonicalize-defgeneric-options options))
1269       ,@methods)))
1270
1271(defun canonicalize-defgeneric-options (options)
1272  (mapappend #'canonicalize-defgeneric-option options))
1273
1274(defun canonicalize-defgeneric-option (option)
1275  (case (car option)
1276    (:generic-function-class
1277     (list :generic-function-class `(find-class ',(cadr option))))
1278    (:method-class
1279     (list :method-class `(find-class ',(cadr option))))
1280    (:method-combination
1281     (list :method-combination `',(cdr option)))
1282    (:argument-precedence-order
1283     (list :argument-precedence-order `',(cdr option)))
1284    (t
1285     (list `',(car option) `',(cadr option)))))
1286
1287;; From OpenMCL.
1288(defun canonicalize-argument-precedence-order (apo req)
1289  (cond ((equal apo req) nil)
1290        ((not (eql (length apo) (length req)))
1291         (error 'program-error
1292                :format-control "Specified argument precedence order ~S does not match lambda list."
1293                :format-arguments (list apo)))
1294        (t (let ((res nil))
1295             (dolist (arg apo (nreverse res))
1296               (let ((index (position arg req)))
1297                 (if (or (null index) (memq index res))
1298                     (error 'program-error
1299                            :format-control "Specified argument precedence order ~S does not match lambda list."
1300                            :format-arguments (list apo)))
1301                 (push index res)))))))
1302
1303(defun find-generic-function (name &optional (errorp t))
1304  (let ((function (and (fboundp name) (fdefinition name))))
1305    (when function
1306      (when (typep function 'generic-function)
1307        (return-from find-generic-function function))
1308      (when (and *traced-names* (find name *traced-names* :test #'equal))
1309        (setf function (untraced-function name))
1310        (when (typep function 'generic-function)
1311          (return-from find-generic-function function)))))
1312  (if errorp
1313      (error "There is no generic function named ~S." name)
1314      nil))
1315
1316(defun lambda-lists-congruent-p (lambda-list1 lambda-list2)
1317  (let* ((plist1 (analyze-lambda-list lambda-list1))
1318         (args1 (getf plist1 :required-args))
1319         (plist2 (analyze-lambda-list lambda-list2))
1320         (args2 (getf plist2 :required-args)))
1321    (= (length args1) (length args2))))
1322
1323(defun %defgeneric (function-name &rest all-keys)
1324  (when (fboundp function-name)
1325    (let ((gf (fdefinition function-name)))
1326      (when (typep gf 'generic-function)
1327        ;; Remove methods defined by previous DEFGENERIC forms.
1328        (dolist (method (generic-function-initial-methods gf))
1329          (%remove-method gf method))
1330        (setf (generic-function-initial-methods gf) '()))))
1331  (apply 'ensure-generic-function function-name all-keys))
1332
1333(defun ensure-generic-function (function-name
1334                                &rest all-keys
1335                                &key
1336                                lambda-list
1337                                (generic-function-class +the-standard-generic-function-class+)
1338                                (method-class +the-standard-method-class+)
1339                                (method-combination 'standard)
1340                                (argument-precedence-order nil apo-p)
1341                                documentation
1342                                &allow-other-keys)
1343  (when (autoloadp function-name)
1344    (resolve function-name))
1345  (let ((gf (find-generic-function function-name nil)))
1346    (if gf
1347        (progn
1348          (unless (or (null (generic-function-methods gf))
1349                      (lambda-lists-congruent-p lambda-list (generic-function-lambda-list gf)))
1350            (error 'simple-error
1351                   :format-control "The lambda list ~S is incompatible with the existing methods of ~S."
1352                   :format-arguments (list lambda-list gf)))
1353          (setf (generic-function-lambda-list gf) lambda-list)
1354          (setf (generic-function-documentation gf) documentation)
1355          (let* ((plist (analyze-lambda-list lambda-list))
1356                 (required-args (getf plist ':required-args)))
1357            (%set-gf-required-args gf required-args)
1358            (when apo-p
1359              (setf (generic-function-argument-precedence-order gf)
1360                    (if argument-precedence-order
1361                        (canonicalize-argument-precedence-order argument-precedence-order
1362                                                                required-args)
1363                        nil)))
1364            (finalize-generic-function gf))
1365          gf)
1366        (progn
1367          (when (and (null *clos-booting*)
1368                     (fboundp function-name))
1369            (error 'program-error
1370                   :format-control "~A already names an ordinary function, macro, or special operator."
1371                   :format-arguments (list function-name)))
1372          (setf gf (apply (if (eq generic-function-class +the-standard-generic-function-class+)
1373                              #'make-instance-standard-generic-function
1374                              #'make-instance)
1375                          generic-function-class
1376                          :name function-name
1377                          :method-class method-class
1378                          :method-combination method-combination
1379                          all-keys))
1380          gf))))
1381
1382(defun initial-discriminating-function (gf args)
1383  (set-funcallable-instance-function
1384   gf
1385   (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
1386                #'std-compute-discriminating-function
1387                #'compute-discriminating-function)
1388            gf))
1389  (apply gf args))
1390
1391(defun collect-eql-specializer-objects (generic-function)
1392  (let ((result nil))
1393    (dolist (method (generic-function-methods generic-function))
1394      (dolist (specializer (%method-specializers method))
1395        (when (typep specializer 'eql-specializer)
1396          (pushnew (eql-specializer-object specializer)
1397                   result
1398                   :test 'eql))))
1399    result))
1400
1401(defun finalize-generic-function (gf)
1402  (%finalize-generic-function gf)
1403  (setf (classes-to-emf-table gf) (make-hash-table :test #'equal))
1404  (%init-eql-specializations gf (collect-eql-specializer-objects gf))
1405  (set-funcallable-instance-function
1406   gf #'(lambda (&rest args)
1407          (initial-discriminating-function gf args)))
1408  ;; FIXME Do we need to warn on redefinition somewhere else?
1409  (let ((*warn-on-redefinition* nil))
1410    (setf (fdefinition (%generic-function-name gf)) gf))
1411  (values))
1412
1413(defun make-instance-standard-generic-function (generic-function-class
1414                                                &key name lambda-list
1415                                                method-class
1416                                                method-combination
1417                                                argument-precedence-order
1418                                                documentation)
1419  (declare (ignore generic-function-class))
1420  (let ((gf (std-allocate-instance +the-standard-generic-function-class+)))
1421    (%set-generic-function-name gf name)
1422    (setf (generic-function-lambda-list gf) lambda-list)
1423    (setf (generic-function-initial-methods gf) ())
1424    (setf (generic-function-methods gf) ())
1425    (setf (generic-function-method-class gf) method-class)
1426    (setf (generic-function-method-combination gf) method-combination)
1427    (setf (generic-function-documentation gf) documentation)
1428    (setf (classes-to-emf-table gf) nil)
1429    (let* ((plist (analyze-lambda-list (generic-function-lambda-list gf)))
1430           (required-args (getf plist ':required-args)))
1431      (%set-gf-required-args gf required-args)
1432      (setf (generic-function-argument-precedence-order gf)
1433            (if argument-precedence-order
1434                (canonicalize-argument-precedence-order argument-precedence-order
1435                                                        required-args)
1436                nil)))
1437    (finalize-generic-function gf)
1438    gf))
1439
1440(defun canonicalize-specializers (specializers)
1441  (mapcar #'canonicalize-specializer specializers))
1442
1443(defun canonicalize-specializer (specializer)
1444  (cond ((classp specializer)
1445         specializer)
1446        ((eql-specializer-p specializer)
1447         specializer)
1448        ((symbolp specializer)
1449         (find-class specializer))
1450        ((and (consp specializer)
1451              (eq (car specializer) 'eql))
1452         (let ((object (cadr specializer)))
1453           (when (and (consp object)
1454                      (eq (car object) 'quote))
1455             (setf object (cadr object)))
1456           (intern-eql-specializer object)))
1457        ((and (consp specializer)
1458              (eq (car specializer) 'java:jclass))
1459         (let ((jclass (eval specializer)))
1460           (java::ensure-java-class jclass)))
1461        (t
1462         (error "Unknown specializer: ~S" specializer))))
1463
1464(defun parse-defmethod (args)
1465  (let ((function-name (car args))
1466        (qualifiers ())
1467        (specialized-lambda-list ())
1468        (body ())
1469        (parse-state :qualifiers))
1470    (dolist (arg (cdr args))
1471      (ecase parse-state
1472        (:qualifiers
1473         (if (and (atom arg) (not (null arg)))
1474             (push arg qualifiers)
1475             (progn
1476               (setf specialized-lambda-list arg)
1477               (setf parse-state :body))))
1478        (:body (push arg body))))
1479    (setf qualifiers (nreverse qualifiers)
1480          body (nreverse body))
1481    (multiple-value-bind (real-body declarations documentation)
1482        (parse-body body)
1483      (values function-name
1484              qualifiers
1485              (extract-lambda-list specialized-lambda-list)
1486              (extract-specializer-names specialized-lambda-list)
1487              documentation
1488              declarations
1489              (list* 'block
1490                     (fdefinition-block-name function-name)
1491                     real-body)))))
1492
1493(defun required-portion (gf args)
1494  (let ((number-required (length (gf-required-args gf))))
1495    (when (< (length args) number-required)
1496      (error 'program-error
1497             :format-control "Not enough arguments for generic function ~S."
1498             :format-arguments (list (%generic-function-name gf))))
1499    (subseq args 0 number-required)))
1500
1501(defun extract-lambda-list (specialized-lambda-list)
1502  (let* ((plist (analyze-lambda-list specialized-lambda-list))
1503         (requireds (getf plist :required-names))
1504         (rv (getf plist :rest-var))
1505         (ks (getf plist :key-args))
1506         (keysp (getf plist :keysp))
1507         (aok (getf plist :allow-other-keys))
1508         (opts (getf plist :optional-args))
1509         (auxs (getf plist :auxiliary-args)))
1510    `(,@requireds
1511      ,@(if rv `(&rest ,rv) ())
1512      ,@(if (or ks keysp aok) `(&key ,@ks) ())
1513      ,@(if aok '(&allow-other-keys) ())
1514      ,@(if opts `(&optional ,@opts) ())
1515      ,@(if auxs `(&aux ,@auxs) ()))))
1516
1517(defun extract-specializer-names (specialized-lambda-list)
1518  (let ((plist (analyze-lambda-list specialized-lambda-list)))
1519    (getf plist ':specializers)))
1520
1521(defun get-keyword-from-arg (arg)
1522  (if (listp arg)
1523      (if (listp (car arg))
1524          (caar arg)
1525          (make-keyword (car arg)))
1526      (make-keyword arg)))
1527
1528(defun analyze-lambda-list (lambda-list)
1529  (let ((keys ())           ; Just the keywords
1530        (key-args ())       ; Keywords argument specs
1531        (keysp nil)         ;
1532        (required-names ()) ; Just the variable names
1533        (required-args ())  ; Variable names & specializers
1534        (specializers ())   ; Just the specializers
1535        (rest-var nil)
1536        (optionals ())
1537        (auxs ())
1538        (allow-other-keys nil)
1539        (state :parsing-required))
1540    (dolist (arg lambda-list)
1541      (if (member arg lambda-list-keywords)
1542          (ecase arg
1543            (&optional
1544             (setq state :parsing-optional))
1545            (&rest
1546             (setq state :parsing-rest))
1547            (&key
1548             (setq keysp t)
1549             (setq state :parsing-key))
1550            (&allow-other-keys
1551             (setq allow-other-keys 't))
1552            (&aux
1553             (setq state :parsing-aux)))
1554          (case state
1555            (:parsing-required
1556             (push-on-end arg required-args)
1557             (if (listp arg)
1558                 (progn (push-on-end (car arg) required-names)
1559                   (push-on-end (cadr arg) specializers))
1560                 (progn (push-on-end arg required-names)
1561                   (push-on-end 't specializers))))
1562            (:parsing-optional (push-on-end arg optionals))
1563            (:parsing-rest (setq rest-var arg))
1564            (:parsing-key
1565             (push-on-end (get-keyword-from-arg arg) keys)
1566             (push-on-end arg key-args))
1567            (:parsing-aux (push-on-end arg auxs)))))
1568    (list  :required-names required-names
1569           :required-args required-args
1570           :specializers specializers
1571           :rest-var rest-var
1572           :keywords keys
1573           :key-args key-args
1574           :keysp keysp
1575           :auxiliary-args auxs
1576           :optional-args optionals
1577           :allow-other-keys allow-other-keys)))
1578
1579#+nil
1580(defun check-method-arg-info (gf arg-info method)
1581  (multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
1582      (analyze-lambda-list (if (consp method)
1583                               (early-method-lambda-list method)
1584                               (method-lambda-list method)))
1585    (flet ((lose (string &rest args)
1586                 (error 'simple-program-error
1587                        :format-control "~@<attempt to add the method~2I~_~S~I~_~
1588                        to the generic function~2I~_~S;~I~_~
1589                        but ~?~:>"
1590                        :format-arguments (list method gf string args)))
1591           (comparison-description (x y)
1592                                   (if (> x y) "more" "fewer")))
1593      (let ((gf-nreq (arg-info-number-required arg-info))
1594            (gf-nopt (arg-info-number-optional arg-info))
1595            (gf-key/rest-p (arg-info-key/rest-p arg-info))
1596            (gf-keywords (arg-info-keys arg-info)))
1597        (unless (= nreq gf-nreq)
1598          (lose
1599           "the method has ~A required arguments than the generic function."
1600           (comparison-description nreq gf-nreq)))
1601        (unless (= nopt gf-nopt)
1602          (lose
1603           "the method has ~A optional arguments than the generic function."
1604           (comparison-description nopt gf-nopt)))
1605        (unless (eq (or keysp restp) gf-key/rest-p)
1606          (lose
1607           "the method and generic function differ in whether they accept~_~
1608            &REST or &KEY arguments."))
1609        (when (consp gf-keywords)
1610          (unless (or (and restp (not keysp))
1611                      allow-other-keys-p
1612                      (every (lambda (k) (memq k keywords)) gf-keywords))
1613            (lose "the method does not accept each of the &KEY arguments~2I~_~
1614            ~S."
1615                  gf-keywords)))))))
1616
1617(defun check-method-lambda-list (name method-lambda-list gf-lambda-list)
1618  (let* ((gf-restp (not (null (memq '&rest gf-lambda-list))))
1619         (gf-plist (analyze-lambda-list gf-lambda-list))
1620         (gf-keysp (getf gf-plist :keysp))
1621         (gf-keywords (getf gf-plist :keywords))
1622         (method-plist (analyze-lambda-list method-lambda-list))
1623         (method-restp (not (null (memq '&rest method-lambda-list))))
1624         (method-keysp (getf method-plist :keysp))
1625         (method-keywords (getf method-plist :keywords))
1626         (method-allow-other-keys-p (getf method-plist :allow-other-keys)))
1627    (unless (= (length (getf gf-plist :required-args))
1628               (length (getf method-plist :required-args)))
1629      (error "The method-lambda-list ~S ~
1630              has the wrong number of required arguments ~
1631              for the generic function ~S." method-lambda-list name))
1632    (unless (= (length (getf gf-plist :optional-args))
1633               (length (getf method-plist :optional-args)))
1634      (error "The method-lambda-list ~S ~
1635              has the wrong number of optional arguments ~
1636              for the generic function ~S." method-lambda-list name))
1637    (unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
1638      (error "The method-lambda-list ~S ~
1639              and the generic function ~S ~
1640              differ in whether they accept &REST or &KEY arguments."
1641             method-lambda-list name))
1642    (when (consp gf-keywords)
1643      (unless (or (and method-restp (not method-keysp))
1644                  method-allow-other-keys-p
1645                  (every (lambda (k) (memq k method-keywords)) gf-keywords))
1646        (error "The method-lambda-list ~S does not accept ~
1647                all of the keyword arguments defined for the ~
1648                generic function." method-lambda-list name)))))
1649
1650(defvar *gf-initialize-instance* nil
1651  "Cached value of the INITIALIZE-INSTANCE generic function.
1652Initialized with the true value near the end of the file.")
1653(defvar *gf-allocate-instance* nil
1654  "Cached value of the ALLOCATE-INSTANCE generic function.
1655Initialized with the true value near the end of the file.")
1656(defvar *gf-shared-initialize* nil
1657  "Cached value of the SHARED-INITIALIZE generic function.
1658Initialized with the true value near the end of the file.")
1659(defvar *gf-reinitialize-instance* nil
1660  "Cached value of the REINITIALIZE-INSTANCE generic function.
1661Initialized with the true value near the end of the file.")
1662
1663(declaim (ftype (function * method) ensure-method))
1664(defun ensure-method (name &rest all-keys)
1665  (let ((method-lambda-list (getf all-keys :lambda-list))
1666        (gf (find-generic-function name nil)))
1667    (when (or (eq gf *gf-initialize-instance*)
1668              (eq gf *gf-allocate-instance*)
1669              (eq gf *gf-shared-initialize*)
1670              (eq gf *gf-reinitialize-instance*))
1671      ;; ### Clearly, this can be targeted much more exact
1672      ;; as we only need to remove the specializing class and all
1673      ;; its subclasses from the hash.
1674      (clrhash *make-instance-initargs-cache*)
1675      (clrhash *reinitialize-instance-initargs-cache*))
1676    (if gf
1677        (check-method-lambda-list name method-lambda-list
1678                                  (generic-function-lambda-list gf))
1679        (setf gf (ensure-generic-function name :lambda-list method-lambda-list)))
1680    (let ((method
1681           (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1682               (apply #'make-instance-standard-method gf all-keys)
1683               (apply #'make-instance (generic-function-method-class gf) all-keys))))
1684      (%add-method gf method)
1685      method)))
1686
1687(defun make-instance-standard-method (gf
1688                                      &key
1689                                      lambda-list
1690                                      qualifiers
1691                                      specializers
1692                                      documentation
1693                                      function
1694                                      fast-function)
1695  (declare (ignore gf))
1696  (let ((method (std-allocate-instance +the-standard-method-class+)))
1697    (setf (method-lambda-list method) lambda-list)
1698    (setf (method-qualifiers method) qualifiers)
1699    (%set-method-specializers method (canonicalize-specializers specializers))
1700    (setf (method-documentation method) documentation)
1701    (%set-method-generic-function method nil)
1702    (%set-method-function method function)
1703    (%set-method-fast-function method fast-function)
1704    method))
1705
1706(defun %add-method (gf method)
1707  (when (%method-generic-function method)
1708    (error 'simple-error
1709           :format-control "ADD-METHOD: ~S is a method of ~S."
1710           :format-arguments (list method (%method-generic-function method))))
1711  ;; Remove existing method with same qualifiers and specializers (if any).
1712  (let ((old-method (%find-method gf (method-qualifiers method)
1713                                 (%method-specializers method) nil)))
1714    (when old-method
1715      (%remove-method gf old-method)))
1716  (%set-method-generic-function method gf)
1717  (push method (generic-function-methods gf))
1718  (dolist (specializer (%method-specializers method))
1719    (when (typep specializer 'class) ;; FIXME What about EQL specializer objects?
1720      (pushnew method (class-direct-methods specializer))))
1721  (finalize-generic-function gf)
1722  gf)
1723
1724(defun %remove-method (gf method)
1725  (setf (generic-function-methods gf)
1726        (remove method (generic-function-methods gf)))
1727  (%set-method-generic-function method nil)
1728  (dolist (specializer (%method-specializers method))
1729    (when (typep specializer 'class) ;; FIXME What about EQL specializer objects?
1730      (setf (class-direct-methods specializer)
1731            (remove method (class-direct-methods specializer)))))
1732  (finalize-generic-function gf)
1733  gf)
1734
1735(defun %find-method (gf qualifiers specializers &optional (errorp t))
1736  ;; "If the specializers argument does not correspond in length to the number
1737  ;; of required arguments of the generic-function, an an error of type ERROR
1738  ;; is signaled."
1739  (unless (= (length specializers) (length (gf-required-args gf)))
1740    (error "The specializers argument has length ~S, but ~S has ~S required parameters."
1741           (length specializers)
1742           gf
1743           (length (gf-required-args gf))))
1744  (let* ((canonical-specializers (canonicalize-specializers specializers))
1745         (method
1746          (find-if #'(lambda (method)
1747                      (and (equal qualifiers
1748                                  (method-qualifiers method))
1749                           (equal canonical-specializers
1750                                  (%method-specializers method))))
1751                   (generic-function-methods gf))))
1752    (if (and (null method) errorp)
1753        (error "No such method for ~S." (%generic-function-name gf))
1754        method)))
1755
1756(defun fast-callable-p (gf)
1757  (and (eq (generic-function-method-combination gf) 'standard)
1758       (null (intersection (%generic-function-lambda-list gf)
1759                           '(&rest &optional &key &allow-other-keys &aux)))))
1760
1761(declaim (ftype (function * t) slow-method-lookup-1))
1762
1763(declaim (ftype (function (t t t) t) slow-reader-lookup))
1764(defun slow-reader-lookup (gf layout slot-name)
1765  (let ((location (layout-slot-location layout slot-name)))
1766    (cache-slot-location gf layout location)
1767    location))
1768
1769(defun std-compute-discriminating-function (gf)
1770  (let ((code
1771         (cond
1772           ((and (= (length (generic-function-methods gf)) 1)
1773                 (typep (car (generic-function-methods gf)) 'standard-reader-method))
1774            ;;                 (sys::%format t "standard reader function ~S~%" (generic-function-name gf))
1775
1776            (let* ((method (%car (generic-function-methods gf)))
1777                   (class (car (%method-specializers method)))
1778                   (slot-name (reader-method-slot-name method)))
1779              #'(lambda (arg)
1780                  (declare (optimize speed))
1781                  (let* ((layout (std-instance-layout arg))
1782                         (location (get-cached-slot-location gf layout)))
1783                    (unless location
1784                      (unless (simple-typep arg class)
1785                        ;; FIXME no applicable method
1786                        (error 'simple-type-error
1787                               :datum arg
1788                               :expected-type class))
1789                      (setf location (slow-reader-lookup gf layout slot-name)))
1790                    (if (consp location)
1791                        ;; Shared slot.
1792                        (cdr location)
1793                        (standard-instance-access arg location))))))
1794
1795           (t
1796            (let* ((emf-table (classes-to-emf-table gf))
1797                   (number-required (length (gf-required-args gf)))
1798                   (lambda-list (%generic-function-lambda-list gf))
1799                   (exact (null (intersection lambda-list
1800                                              '(&rest &optional &key
1801                                                &allow-other-keys &aux)))))
1802              (if exact
1803                  (cond
1804                    ((= number-required 1)
1805                     (cond
1806                       ((and (eq (generic-function-method-combination gf) 'standard)
1807                             (= (length (generic-function-methods gf)) 1))
1808                        (let* ((method (%car (generic-function-methods gf)))
1809                               (specializer (car (%method-specializers method)))
1810                               (function (or (%method-fast-function method)
1811                                             (%method-function method))))
1812                          (if (eql-specializer-p specializer)
1813                              (let ((specializer-object (eql-specializer-object specializer)))
1814                                #'(lambda (arg)
1815                                    (declare (optimize speed))
1816                                    (if (eql arg specializer-object)
1817                                        (funcall function arg)
1818                                        (no-applicable-method gf (list arg)))))
1819                              #'(lambda (arg)
1820                                  (declare (optimize speed))
1821                                  (unless (simple-typep arg specializer)
1822                                    ;; FIXME no applicable method
1823                                    (error 'simple-type-error
1824                                           :datum arg
1825                                           :expected-type specializer))
1826                                  (funcall function arg)))))
1827                       (t
1828                        #'(lambda (arg)
1829                            (declare (optimize speed))
1830                            (let* ((specialization
1831                                    (%get-arg-specialization gf arg))
1832                                   (emfun (or (gethash1 specialization
1833                                                        emf-table)
1834                                              (slow-method-lookup-1
1835                                               gf arg specialization))))
1836                              (if emfun
1837                                  (funcall emfun (list arg))
1838                                  (apply #'no-applicable-method gf (list arg))))))))
1839                    ((= number-required 2)
1840                     #'(lambda (arg1 arg2)
1841                         (declare (optimize speed))
1842                         (let* ((args (list arg1 arg2))
1843                                (emfun (get-cached-emf gf args)))
1844                           (if emfun
1845                               (funcall emfun args)
1846                               (slow-method-lookup gf args)))))
1847                    ((= number-required 3)
1848                     #'(lambda (arg1 arg2 arg3)
1849                         (declare (optimize speed))
1850                         (let* ((args (list arg1 arg2 arg3))
1851                                (emfun (get-cached-emf gf args)))
1852                           (if emfun
1853                               (funcall emfun args)
1854                               (slow-method-lookup gf args)))))
1855                    (t
1856                     #'(lambda (&rest args)
1857                         (declare (optimize speed))
1858                         (let ((len (length args)))
1859                           (unless (= len number-required)
1860                             (error 'program-error
1861                                    :format-control "Not enough arguments for generic function ~S."
1862                                    :format-arguments (list (%generic-function-name gf)))))
1863                         (let ((emfun (get-cached-emf gf args)))
1864                           (if emfun
1865                               (funcall emfun args)
1866                               (slow-method-lookup gf args))))))
1867                  #'(lambda (&rest args)
1868                      (declare (optimize speed))
1869                      (let ((len (length args)))
1870                        (unless (>= len number-required)
1871                          (error 'program-error
1872                                 :format-control "Not enough arguments for generic function ~S."
1873                                 :format-arguments (list (%generic-function-name gf)))))
1874                      (let ((emfun (get-cached-emf gf args)))
1875                        (if emfun
1876                            (funcall emfun args)
1877                            (slow-method-lookup gf args))))))))))
1878
1879    code))
1880
1881(defun sort-methods (methods gf required-classes)
1882  (if (or (null methods) (null (%cdr methods)))
1883      methods
1884      (sort methods
1885      (if (eq (class-of gf) +the-standard-generic-function-class+)
1886    #'(lambda (m1 m2)
1887        (std-method-more-specific-p m1 m2 required-classes
1888            (generic-function-argument-precedence-order gf)))
1889    #'(lambda (m1 m2)
1890        (method-more-specific-p gf m1 m2 required-classes))))))
1891
1892(defun method-applicable-p (method args)
1893  (do* ((specializers (%method-specializers method) (cdr specializers))
1894        (args args (cdr args)))
1895       ((null specializers) t)
1896    (let ((specializer (car specializers)))
1897      (if (typep specializer 'eql-specializer)
1898          (unless (eql (car args) (eql-specializer-object specializer))
1899            (return nil))
1900          (unless (subclassp (class-of (car args)) specializer)
1901            (return nil))))))
1902
1903(defun %compute-applicable-methods (gf args)
1904  (let ((required-classes (mapcar #'class-of (required-portion gf args)))
1905        (methods '()))
1906    (dolist (method (generic-function-methods gf))
1907      (when (method-applicable-p method args)
1908        (push method methods)))
1909    (sort-methods methods gf required-classes)))
1910
1911;;; METHOD-APPLICABLE-USING-CLASSES-P
1912;;;
1913;;; If the first return value is T, METHOD is definitely applicable to
1914;;; arguments that are instances of CLASSES.  If the first value is
1915;;; NIL and the second value is T, METHOD is definitely not applicable
1916;;; to arguments that are instances of CLASSES; if the second value is
1917;;; NIL the applicability of METHOD cannot be determined by inspecting
1918;;; the classes of its arguments only.
1919;;;
1920(defun method-applicable-using-classes-p (method classes)
1921  (do* ((specializers (%method-specializers method) (cdr specializers))
1922  (classes classes (cdr classes))
1923  (knownp t))
1924       ((null specializers)
1925  (if knownp (values t t) (values nil nil)))
1926    (let ((specializer (car specializers)))
1927      (if (typep specializer 'eql-specializer)
1928    (if (eql (class-of (eql-specializer-object specializer)) 
1929       (car classes))
1930        (setf knownp nil)
1931        (return (values nil t)))
1932    (unless (subclassp (car classes) specializer)
1933      (return (values nil t)))))))
1934
1935(defun slow-method-lookup (gf args)
1936  (let ((applicable-methods (%compute-applicable-methods gf args)))
1937    (if applicable-methods
1938        (let ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
1939                                  #'std-compute-effective-method-function
1940                                  #'compute-effective-method-function)
1941                              gf applicable-methods)))
1942          (cache-emf gf args emfun)
1943          (funcall emfun args))
1944        (apply #'no-applicable-method gf args))))
1945
1946(defun slow-method-lookup-1 (gf arg arg-specialization)
1947  (let ((applicable-methods (%compute-applicable-methods gf (list arg))))
1948    (if applicable-methods
1949        (let ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
1950                                  #'std-compute-effective-method-function
1951                                  #'compute-effective-method-function)
1952                              gf applicable-methods)))
1953          (when emfun
1954            (setf (gethash arg-specialization (classes-to-emf-table gf)) emfun))
1955          emfun))))
1956
1957(defun sub-specializer-p (c1 c2 c-arg)
1958  (find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
1959
1960(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
1961  (if argument-precedence-order
1962      (let ((specializers-1 (%method-specializers method1))
1963            (specializers-2 (%method-specializers method2)))
1964        (dolist (index argument-precedence-order)
1965          (let ((spec1 (nth index specializers-1))
1966                (spec2 (nth index specializers-2)))
1967            (unless (eq spec1 spec2)
1968              (cond ((eql-specializer-p spec1)
1969                     (return t))
1970                    ((eql-specializer-p spec2)
1971                     (return nil))
1972                    (t
1973                     (return (sub-specializer-p spec1 spec2
1974                                                (nth index required-classes)))))))))
1975      (do ((specializers-1 (%method-specializers method1) (cdr specializers-1))
1976           (specializers-2 (%method-specializers method2) (cdr specializers-2))
1977           (classes required-classes (cdr classes)))
1978          ((null specializers-1) nil)
1979        (let ((spec1 (car specializers-1))
1980              (spec2 (car specializers-2)))
1981          (unless (eq spec1 spec2)
1982            (cond ((eql-specializer-p spec1)
1983                   (return t))
1984                  ((eql-specializer-p spec2)
1985                   (return nil))
1986                  (t
1987                   (return (sub-specializer-p spec1 spec2 (car classes))))))))))
1988
1989(defun primary-method-p (method)
1990  (null (intersection '(:before :after :around) (method-qualifiers method))))
1991
1992(defun before-method-p (method)
1993  (equal '(:before) (method-qualifiers method)))
1994
1995(defun after-method-p (method)
1996  (equal '(:after) (method-qualifiers method)))
1997
1998(defun around-method-p (method)
1999  (equal '(:around) (method-qualifiers method)))
2000
2001(defun process-next-method-list (next-method-list)
2002  (mapcar #'(lambda (next-method-form)
2003              (cond
2004                ((listp next-method-form)
2005                 (assert (eq (first next-method-form) 'make-method))
2006                 (let* ((rest-sym (gensym)))
2007                   (make-instance-standard-method
2008                    nil ;; ignored
2009                    :lambda-list (list '&rest rest-sym)
2010                    :function (compute-method-function `(lambda (&rest ,rest-sym)
2011                                                          ,(second next-method-form))))))
2012                (t
2013                 (assert (typep next-method-form 'method))
2014                 next-method-form)))
2015          next-method-list))
2016
2017(defun std-compute-effective-method-function (gf methods)
2018  (let* ((mc (generic-function-method-combination gf))
2019         (mc-name (if (atom mc) mc (%car mc)))
2020         (options (if (atom mc) '() (%cdr mc)))
2021         (order (car options))
2022         (primaries '())
2023         (arounds '())
2024         around
2025         emf-form
2026         (long-method-combination-p
2027          (typep (get mc-name 'method-combination-object) 'long-method-combination)))
2028    (unless long-method-combination-p
2029      (dolist (m methods)
2030        (let ((qualifiers (method-qualifiers m)))
2031          (cond ((null qualifiers)
2032                 (if (eq mc-name 'standard)
2033                     (push m primaries)
2034                     (error "Method combination type mismatch.")))
2035                ((cdr qualifiers)
2036                 (error "Invalid method qualifiers."))
2037                ((eq (car qualifiers) :around)
2038                 (push m arounds))
2039                ((eq (car qualifiers) mc-name)
2040                 (push m primaries))
2041                ((memq (car qualifiers) '(:before :after)))
2042                (t
2043                 (error "Invalid method qualifiers."))))))
2044    (unless (eq order :most-specific-last)
2045      (setf primaries (nreverse primaries)))
2046    (setf arounds (nreverse arounds))
2047    (setf around (car arounds))
2048    (when (and (null primaries) (not long-method-combination-p))
2049      (error "No primary methods for the generic function ~S." gf))
2050    (cond
2051      (around
2052       (let ((next-emfun
2053              (funcall
2054               (if (eq (class-of gf) +the-standard-generic-function-class+)
2055                   #'std-compute-effective-method-function
2056                   #'compute-effective-method-function)
2057               gf (remove around methods))))
2058         (setf emf-form
2059               (generate-emf-lambda (%method-function around) next-emfun))))
2060      ((eq mc-name 'standard)
2061       (let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2062              (befores (remove-if-not #'before-method-p methods))
2063              (reverse-afters
2064               (reverse (remove-if-not #'after-method-p methods))))
2065         (setf emf-form
2066               (cond
2067                 ((and (null befores) (null reverse-afters))
2068                  (let ((fast-function (%method-fast-function (car primaries))))
2069                    (if fast-function
2070                        (ecase (length (gf-required-args gf))
2071                          (1
2072                           #'(lambda (args)
2073                               (declare (optimize speed))
2074                               (funcall fast-function (car args))))
2075                          (2
2076                           #'(lambda (args)
2077                               (declare (optimize speed))
2078                               (funcall fast-function (car args) (cadr args)))))
2079                        (generate-emf-lambda (%method-function (car primaries))
2080                                             next-emfun))))
2081                 (t
2082                  (let ((method-function (%method-function (car primaries))))
2083                    #'(lambda (args)
2084                        (declare (optimize speed))
2085                        (dolist (before befores)
2086                          (funcall (%method-function before) args nil))
2087                        (multiple-value-prog1
2088                            (funcall method-function args next-emfun)
2089                          (dolist (after reverse-afters)
2090                            (funcall (%method-function after) args nil))))))))))
2091      (long-method-combination-p
2092       (let* ((mc-obj (get mc-name 'method-combination-object))
2093              (function (long-method-combination-function mc-obj))
2094              (arguments (rest (slot-value gf 'method-combination))))
2095         (assert (typep mc-obj 'long-method-combination))
2096         (assert function)
2097         (setf emf-form
2098               (if arguments
2099                   (apply function gf methods arguments)
2100                   (funcall function gf methods)))))
2101      (t
2102       (let ((mc-obj (get mc-name 'method-combination-object)))
2103         (unless (typep mc-obj 'short-method-combination)
2104           (error "Unsupported method combination type ~A."
2105                  mc-name))
2106         (let* ((operator (short-method-combination-operator mc-obj))
2107                (ioa (short-method-combination-identity-with-one-argument mc-obj)))
2108           (setf emf-form
2109                 (if (and (null (cdr primaries))
2110                          (not (null ioa)))
2111                     (generate-emf-lambda (%method-function (car primaries)) nil)
2112                     `(lambda (args)
2113                        (,operator ,@(mapcar
2114                                      (lambda (primary)
2115                                        `(funcall ,(%method-function primary) args nil))
2116                                      primaries)))))))))
2117    (assert (not (null emf-form)))
2118    (or #+nil (ignore-errors (autocompile emf-form))
2119        (coerce-to-function emf-form))))
2120
2121(defun generate-emf-lambda (method-function next-emfun)
2122  #'(lambda (args)
2123      (declare (optimize speed))
2124      (funcall method-function args next-emfun)))
2125
2126;;; compute an effective method function from a list of primary methods:
2127
2128(defun compute-primary-emfun (methods)
2129  (if (null methods)
2130      nil
2131      (let ((next-emfun (compute-primary-emfun (cdr methods))))
2132        #'(lambda (args)
2133           (funcall (%method-function (car methods)) args next-emfun)))))
2134
2135(defvar *call-next-method-p*)
2136(defvar *next-method-p-p*)
2137
2138(defun walk-form (form)
2139  (cond ((atom form)
2140         (cond ((eq form 'call-next-method)
2141                (setf *call-next-method-p* t))
2142               ((eq form 'next-method-p)
2143                (setf *next-method-p-p* t))))
2144        (t
2145         (walk-form (%car form))
2146         (walk-form (%cdr form)))))
2147
2148(defun compute-method-function (lambda-expression)
2149  (let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2150        (body (cddr lambda-expression))
2151        (*call-next-method-p* nil)
2152        (*next-method-p-p* nil))
2153    (multiple-value-bind (body declarations) (parse-body body)
2154      (let ((ignorable-vars '()))
2155        (dolist (var lambda-list)
2156          (if (memq var lambda-list-keywords)
2157              (return)
2158              (push var ignorable-vars)))
2159        (push `(declare (ignorable ,@ignorable-vars)) declarations))
2160      (walk-form body)
2161      (cond ((or *call-next-method-p* *next-method-p-p*)
2162             `(lambda (args next-emfun)
2163                (flet ((call-next-method (&rest cnm-args)
2164                         (if (null next-emfun)
2165                             (error "No next method for generic function.")
2166                             (funcall next-emfun (or cnm-args args))))
2167                       (next-method-p ()
2168                         (not (null next-emfun))))
2169                  (declare (ignorable (function call-next-method)
2170                                      (function next-method-p)))
2171                  (apply #'(lambda ,lambda-list ,@declarations ,@body) args))))
2172            ((null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2173             ;; Required parameters only.
2174             (case (length lambda-list)
2175               (1
2176                `(lambda (args next-emfun)
2177                   (declare (ignore next-emfun))
2178                   (let ((,(%car lambda-list) (%car args)))
2179                     (declare (ignorable ,(%car lambda-list)))
2180                     ,@declarations ,@body)))
2181               (2
2182                `(lambda (args next-emfun)
2183                   (declare (ignore next-emfun))
2184                   (let ((,(%car lambda-list) (%car args))
2185                         (,(%cadr lambda-list) (%cadr args)))
2186                     (declare (ignorable ,(%car lambda-list)
2187                                         ,(%cadr lambda-list)))
2188                     ,@declarations ,@body)))
2189               (3
2190                `(lambda (args next-emfun)
2191                   (declare (ignore next-emfun))
2192                   (let ((,(%car lambda-list) (%car args))
2193                         (,(%cadr lambda-list) (%cadr args))
2194                         (,(%caddr lambda-list) (%caddr args)))
2195                     (declare (ignorable ,(%car lambda-list)
2196                                         ,(%cadr lambda-list)
2197                                         ,(%caddr lambda-list)))
2198                     ,@declarations ,@body)))
2199               (t
2200                `(lambda (args next-emfun)
2201                   (declare (ignore next-emfun))
2202                   (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))
2203            (t
2204             `(lambda (args next-emfun)
2205                (declare (ignore next-emfun))
2206                (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))))
2207
2208(defun compute-method-fast-function (lambda-expression)
2209  (let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2210    (when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2211      (return-from compute-method-fast-function nil))
2212    ;; Only required args.
2213    (let ((body (cddr lambda-expression))
2214          (*call-next-method-p* nil)
2215          (*next-method-p-p* nil))
2216      (multiple-value-bind (body declarations) (parse-body body)
2217        (walk-form body)
2218        (when (or *call-next-method-p* *next-method-p-p*)
2219          (return-from compute-method-fast-function nil))
2220        (let ((decls `(declare (ignorable ,@lambda-list))))
2221          (setf lambda-expression
2222                (list* (car lambda-expression)
2223                       (cadr lambda-expression)
2224                       decls
2225                       (cddr lambda-expression))))
2226        (case (length lambda-list)
2227          (1
2228;;            `(lambda (args next-emfun)
2229;;               (let ((,(%car lambda-list) (%car args)))
2230;;                 (declare (ignorable ,(%car lambda-list)))
2231;;                 ,@declarations ,@body)))
2232           lambda-expression)
2233          (2
2234;;            `(lambda (args next-emfun)
2235;;               (let ((,(%car lambda-list) (%car args))
2236;;                     (,(%cadr lambda-list) (%cadr args)))
2237;;                 (declare (ignorable ,(%car lambda-list)
2238;;                                     ,(%cadr lambda-list)))
2239;;                 ,@declarations ,@body)))
2240           lambda-expression)
2241;;           (3
2242;;            `(lambda (args next-emfun)
2243;;               (let ((,(%car lambda-list) (%car args))
2244;;                     (,(%cadr lambda-list) (%cadr args))
2245;;                     (,(%caddr lambda-list) (%caddr args)))
2246;;                 (declare (ignorable ,(%car lambda-list)
2247;;                                     ,(%cadr lambda-list)
2248;;                                     ,(%caddr lambda-list)))
2249;;                 ,@declarations ,@body)))
2250          (t
2251           nil))))))
2252
2253;; From CLHS section 7.6.5:
2254;; "When a generic function or any of its methods mentions &key in a lambda
2255;; list, the specific set of keyword arguments accepted by the generic function
2256;; varies according to the applicable methods. The set of keyword arguments
2257;; accepted by the generic function for a particular call is the union of the
2258;; keyword arguments accepted by all applicable methods and the keyword
2259;; arguments mentioned after &key in the generic function definition, if any."
2260;; Adapted from Sacla.
2261(defun allow-other-keys (lambda-list)
2262  (if (and (member '&key lambda-list)
2263           (not (member '&allow-other-keys lambda-list)))
2264      (let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2265             (aux-part (subseq lambda-list key-end)))
2266        `(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2267      lambda-list))
2268
2269(defmacro defmethod (&rest args)
2270  (multiple-value-bind
2271      (function-name qualifiers lambda-list specializers documentation declarations body)
2272      (parse-defmethod args)
2273    (let* ((specializers-form '())
2274           (lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2275           (method-function (compute-method-function lambda-expression))
2276           (fast-function (compute-method-fast-function lambda-expression))
2277           )
2278      (dolist (specializer specializers)
2279        (cond ((and (consp specializer) (eq (car specializer) 'eql))
2280               (push `(list 'eql ,(cadr specializer)) specializers-form))
2281              (t
2282               (push `',specializer specializers-form))))
2283      (setf specializers-form `(list ,@(nreverse specializers-form)))
2284      `(progn
2285         (ensure-method ',function-name
2286                        :lambda-list ',lambda-list
2287                        :qualifiers ',qualifiers
2288                        :specializers ,specializers-form
2289                        ,@(if documentation `(:documentation ,documentation))
2290                        :function (function ,method-function)
2291                        ,@(if fast-function `(:fast-function (function ,fast-function)))
2292                        )))))
2293
2294;;; Reader and writer methods
2295
2296(defun make-instance-standard-reader-method (gf
2297                                             &key
2298                                             lambda-list
2299                                             qualifiers
2300                                             specializers
2301                                             documentation
2302                                             function
2303                                             fast-function
2304                                             slot-name)
2305  (declare (ignore gf))
2306  (let ((method (std-allocate-instance +the-standard-reader-method-class+)))
2307    (setf (method-lambda-list method) lambda-list)
2308    (setf (method-qualifiers method) qualifiers)
2309    (%set-method-specializers method (canonicalize-specializers specializers))
2310    (setf (method-documentation method) documentation)
2311    (%set-method-generic-function method nil)
2312    (%set-method-function method function)
2313    (%set-method-fast-function method fast-function)
2314    (set-reader-method-slot-name method slot-name)
2315    method))
2316
2317(defun add-reader-method (class function-name slot-name)
2318  (let* ((lambda-expression
2319          (if (eq (class-of class) +the-standard-class+)
2320              `(lambda (object) (std-slot-value object ',slot-name))
2321              `(lambda (object) (slot-value object ',slot-name))))
2322         (method-function (compute-method-function lambda-expression))
2323         (fast-function (compute-method-fast-function lambda-expression)))
2324    (let ((method-lambda-list '(object))
2325          (gf (find-generic-function function-name nil)))
2326      (if gf
2327          (check-method-lambda-list function-name
2328                                    method-lambda-list
2329                                    (generic-function-lambda-list gf))
2330        (setf gf (ensure-generic-function function-name :lambda-list method-lambda-list)))
2331      (let ((method
2332             (make-instance-standard-reader-method gf
2333                                                   :lambda-list '(object)
2334                                                   :qualifiers ()
2335                                                   :specializers (list class)
2336                                                   :function (if (autoloadp 'compile)
2337                                                                 method-function
2338                                                                 (autocompile method-function))
2339                                                   :fast-function (if (autoloadp 'compile)
2340                                                                      fast-function
2341                                                                      (autocompile fast-function))
2342                                                   :slot-name slot-name)))
2343        (%add-method gf method)
2344        method))))
2345
2346(defun add-writer-method (class function-name slot-name)
2347  (let* ((lambda-expression
2348          (if (eq (class-of class) +the-standard-class+)
2349              `(lambda (new-value object)
2350                 (setf (std-slot-value object ',slot-name) new-value))
2351              `(lambda (new-value object)
2352                 (setf (slot-value object ',slot-name) new-value))))
2353         (method-function (compute-method-function lambda-expression))
2354         (fast-function (compute-method-fast-function lambda-expression))
2355         )
2356    (ensure-method function-name
2357                   :lambda-list '(new-value object)
2358                   :qualifiers ()
2359                   :specializers (list +the-T-class+ class)
2360;;                    :function `(function ,method-function)
2361                   :function (if (autoloadp 'compile)
2362                                 method-function
2363                                 (autocompile method-function))
2364                   :fast-function (if (autoloadp 'compile)
2365                                      fast-function
2366                                      (autocompile fast-function))
2367                   )))
2368
2369(defmacro atomic-defgeneric (function-name &rest rest)
2370  "Macro to define a generic function and 'swap it into place' after
2371it's been fully defined with all its methods.
2372
2373Note: the user should really use the (:method ..) method description
2374way of defining methods; there's not much use in atomically defining
2375generic functions without providing sensible behaviour..."
2376  (let ((temp-sym (gensym)))
2377    `(progn
2378       (defgeneric ,temp-sym ,@rest)
2379       (let ((gf (symbol-function ',temp-sym)))
2380         (setf ,(if (and (consp function-name)
2381                         (eq (car function-name) 'setf))
2382                    `(get ',(second function-name) 'setf-function)
2383                  `(symbol-function ',function-name)) gf)
2384         (%set-generic-function-name gf ',function-name)
2385         gf))))
2386
2387(defmacro redefine-class-forwarder (name slot)
2388  "Define a generic function on a temporary symbol as an accessor
2389for the slot `slot'. Then, when definition is complete (including
2390allocation of methods), swap the definition in place.
2391
2392Without this approach, we can't depend the old forwarders to be
2393in place, while we still need them to "
2394  (let* (($name (if (consp name) (cadr name) name))
2395         (%name (intern (concatenate 'string
2396                                     "%"
2397                                     (if (consp name)
2398                                         (symbol-name 'set-) "")
2399                                     (symbol-name $name))
2400                        (find-package "SYS"))))
2401    `(atomic-defgeneric ,name (;; splice a new-value parameter for setters
2402                               ,@(when (consp name) (list 'new-value))
2403                               class)
2404         ,@(mapcar (if (consp name)
2405                       #'(lambda (class-name)
2406                           `(:method (new-value (class ,class-name))
2407                                     (,%name new-value class)))
2408                     #'(lambda (class-name)
2409                         `(:method ((class ,class-name))
2410                                   (,%name class))))
2411                   '(built-in-class
2412                     forward-referenced-class
2413                     structure-class))
2414         (:method (,@(when (consp name) (list 'new-value))
2415                   (class standard-class))
2416             ,(if (consp name)
2417                  `(setf (slot-value class ',slot) new-value)
2418                `(slot-value class ',slot))))))
2419
2420
2421(redefine-class-forwarder class-name name)
2422(redefine-class-forwarder (setf class-name) name)
2423(redefine-class-forwarder class-slots slots)
2424(redefine-class-forwarder (setf class-slots) slots)
2425(redefine-class-forwarder class-direct-slots direct-slots)
2426(redefine-class-forwarder (setf class-direct-slots) direct-slots)
2427(redefine-class-forwarder class-layout layout)
2428(redefine-class-forwarder (setf class-layout) layout)
2429(redefine-class-forwarder class-direct-superclasses direct-superclasses)
2430(redefine-class-forwarder (setf class-direct-superclasses) direct-superclasses)
2431(redefine-class-forwarder class-direct-subclasses direct-subclasses)
2432(redefine-class-forwarder (setf class-direct-subclasses) direct-subclasses)
2433(redefine-class-forwarder class-direct-methods direct-methods)
2434(redefine-class-forwarder (setf class-direct-methods) direct-methods)
2435(redefine-class-forwarder class-precedence-list precedence-list)
2436(redefine-class-forwarder (setf class-precedence-list) precedence-list)
2437(redefine-class-forwarder class-finalized-p finalized-p)
2438(redefine-class-forwarder (setf class-finalized-p) finalized-p)
2439(redefine-class-forwarder class-default-initargs default-initargs)
2440(redefine-class-forwarder (setf class-default-initargs) default-initargs)
2441(redefine-class-forwarder class-direct-default-initargs direct-default-initargs)
2442(redefine-class-forwarder (setf class-direct-default-initargs) direct-default-initargs)
2443
2444(defgeneric direct-slot-definition-class (class &rest initargs))
2445
2446(defmethod direct-slot-definition-class ((class class) &rest initargs)
2447  (declare (ignore initargs))
2448  +the-standard-direct-slot-definition-class+)
2449
2450(defgeneric effective-slot-definition-class (class &rest initargs))
2451
2452(defmethod effective-slot-definition-class ((class class) &rest initargs)
2453  (declare (ignore initargs))
2454  +the-standard-effective-slot-definition-class+)
2455
2456(atomic-defgeneric documentation (x doc-type)
2457    (:method ((x symbol) doc-type)
2458        (%documentation x doc-type))
2459    (:method ((x function) doc-type)
2460        (%documentation x doc-type)))
2461
2462(atomic-defgeneric (setf documentation) (new-value x doc-type)
2463    (:method (new-value (x symbol) doc-type)
2464        (%set-documentation x doc-type new-value))
2465    (:method (new-value (x function) doc-type)
2466        (%set-documentation x doc-type new-value)))
2467
2468
2469;; FIXME This should be a weak hashtable!
2470(defvar *list-documentation-hashtable* (make-hash-table :test #'equal))
2471
2472(defmethod documentation ((x list) (doc-type (eql 'function)))
2473  (let ((alist (gethash x *list-documentation-hashtable*)))
2474    (and alist (cdr (assoc doc-type alist)))))
2475
2476(defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
2477  (let ((alist (gethash x *list-documentation-hashtable*)))
2478    (and alist (cdr (assoc doc-type alist)))))
2479
2480(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
2481  (let* ((alist (gethash x *list-documentation-hashtable*))
2482         (entry (and alist (assoc doc-type alist))))
2483    (cond (entry
2484           (setf (cdr entry) new-value))
2485          (t
2486           (setf (gethash x *list-documentation-hashtable*)
2487                 (push (cons doc-type new-value) alist)))))
2488  new-value)
2489
2490(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro)))
2491  (let* ((alist (gethash x *list-documentation-hashtable*))
2492         (entry (and alist (assoc doc-type alist))))
2493    (cond (entry
2494           (setf (cdr entry) new-value))
2495          (t
2496           (setf (gethash x *list-documentation-hashtable*)
2497                 (push (cons doc-type new-value) alist)))))
2498  new-value)
2499
2500(defmethod documentation ((x standard-class) (doc-type (eql 't)))
2501  (class-documentation x))
2502
2503(defmethod documentation ((x standard-class) (doc-type (eql 'type)))
2504  (class-documentation x))
2505
2506(defmethod (setf documentation) (new-value (x standard-class) (doc-type (eql 't)))
2507  (%set-class-documentation x new-value))
2508
2509(defmethod (setf documentation) (new-value (x standard-class) (doc-type (eql 'type)))
2510  (%set-class-documentation x new-value))
2511
2512(defmethod documentation ((x structure-class) (doc-type (eql 't)))
2513  (%documentation x doc-type))
2514
2515(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
2516  (%documentation x doc-type))
2517
2518(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 't)))
2519  (%set-documentation x doc-type new-value))
2520
2521(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 'type)))
2522  (%set-documentation x doc-type new-value))
2523
2524(defmethod documentation ((x standard-generic-function) (doc-type (eql 't)))
2525  (generic-function-documentation x))
2526
2527(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 't)))
2528  (setf (generic-function-documentation x) new-value))
2529
2530(defmethod documentation ((x standard-generic-function) (doc-type (eql 'function)))
2531  (generic-function-documentation x))
2532
2533(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 'function)))
2534  (setf (generic-function-documentation x) new-value))
2535
2536(defmethod documentation ((x standard-method) (doc-type (eql 't)))
2537  (method-documentation x))
2538
2539(defmethod (setf documentation) (new-value (x standard-method) (doc-type (eql 't)))
2540  (setf (method-documentation x) new-value))
2541
2542(defmethod documentation ((x package) (doc-type (eql 't)))
2543  (%documentation x doc-type))
2544
2545(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
2546  (%set-documentation x doc-type new-value))
2547
2548(defmethod documentation ((x symbol) (doc-type (eql 'function)))
2549  (%documentation x doc-type))
2550
2551;;; Applicable methods
2552
2553(defgeneric compute-applicable-methods (gf args)
2554  (:method ((gf standard-generic-function) args)
2555    (%compute-applicable-methods gf args)))
2556
2557(defgeneric compute-applicable-methods-using-classes (gf classes)
2558  (:method ((gf standard-generic-function) classes)
2559    (let ((methods '()))
2560      (dolist (method (generic-function-methods gf))
2561  (multiple-value-bind (applicable knownp)
2562      (method-applicable-using-classes-p method classes)
2563    (cond (applicable
2564     (push method methods))
2565    ((not knownp)
2566     (return-from compute-applicable-methods-using-classes
2567       (values nil nil))))))
2568      (values (sort-methods methods gf classes)
2569        t))))
2570
2571(export '(compute-applicable-methods
2572    compute-applicable-methods-using-classes))
2573
2574
2575;;; Slot access
2576
2577(defun set-slot-value-using-class (new-value class instance slot-name)
2578  (declare (ignore class)) ; FIXME
2579  (setf (std-slot-value instance slot-name) new-value))
2580
2581(defgeneric slot-value-using-class (class instance slot-name))
2582
2583(defmethod slot-value-using-class ((class standard-class) instance slot-name)
2584  (std-slot-value instance slot-name))
2585
2586(defmethod slot-value-using-class ((class structure-class) instance slot-name)
2587  (std-slot-value instance slot-name))
2588
2589(defgeneric (setf slot-value-using-class) (new-value class instance slot-name))
2590
2591(defmethod (setf slot-value-using-class) (new-value
2592                                          (class standard-class)
2593                                          instance
2594                                          slot-name)
2595  (setf (std-slot-value instance slot-name) new-value))
2596
2597(defmethod (setf slot-value-using-class) (new-value
2598                                          (class structure-class)
2599                                          instance
2600                                          slot-name)
2601  (setf (std-slot-value instance slot-name) new-value))
2602
2603(defgeneric slot-exists-p-using-class (class instance slot-name))
2604
2605(defmethod slot-exists-p-using-class (class instance slot-name)
2606  nil)
2607
2608(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
2609  (std-slot-exists-p instance slot-name))
2610
2611(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
2612  (dolist (dsd (class-slots class))
2613    (when (eq (sys::dsd-name dsd) slot-name)
2614      (return-from slot-exists-p-using-class t)))
2615  nil)
2616
2617(defgeneric slot-boundp-using-class (class instance slot-name))
2618(defmethod slot-boundp-using-class ((class standard-class) instance slot-name)
2619  (std-slot-boundp instance slot-name))
2620(defmethod slot-boundp-using-class ((class structure-class) instance slot-name)
2621  "Structure slots can't be unbound, so this method always returns T."
2622  (declare (ignore class instance slot-name))
2623  t)
2624
2625(defgeneric slot-makunbound-using-class (class instance slot-name))
2626(defmethod slot-makunbound-using-class ((class standard-class)
2627                                        instance
2628                                        slot-name)
2629  (std-slot-makunbound instance slot-name))
2630(defmethod slot-makunbound-using-class ((class structure-class)
2631                                        instance
2632                                        slot-name)
2633  (declare (ignore class instance slot-name))
2634  (error "Structure slots can't be unbound"))
2635
2636(defgeneric slot-missing (class instance slot-name operation &optional new-value))
2637
2638(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
2639  (declare (ignore new-value))
2640  (error "The slot ~S is missing from the class ~S." slot-name class))
2641
2642(defgeneric slot-unbound (class instance slot-name))
2643
2644(defmethod slot-unbound ((class t) instance slot-name)
2645  (error 'unbound-slot :instance instance :name slot-name))
2646
2647;;; Instance creation and initialization
2648
2649(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
2650
2651(defmethod allocate-instance ((class standard-class) &rest initargs)
2652  (declare (ignore initargs))
2653  (std-allocate-instance class))
2654
2655(defmethod allocate-instance ((class structure-class) &rest initargs)
2656  (declare (ignore initargs))
2657  (%make-structure (class-name class)
2658                   (make-list (length (class-slots class))
2659                              :initial-element +slot-unbound+)))
2660
2661;; "The set of valid initialization arguments for a class is the set of valid
2662;; initialization arguments that either fill slots or supply arguments to
2663;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
2664;; 7.1.2
2665
2666(defun calculate-allowable-initargs (gf-list args instance
2667                                             shared-initialize-param
2668                                             initargs)
2669  (let* ((methods
2670          (nconc
2671             (compute-applicable-methods #'shared-initialize
2672                                         (list* instance
2673                                                shared-initialize-param
2674                                                initargs))
2675             (mapcan #'(lambda (gf)
2676                         (compute-applicable-methods gf args))
2677                     gf-list)))
2678         (method-keyword-args
2679          (reduce #'merge-initargs-sets
2680                  (mapcar #'method-lambda-list methods)
2681                  :key #'extract-lambda-list-keywords
2682                  :initial-value nil))
2683         (slots-initargs
2684          (mapappend #'slot-definition-initargs
2685                     (class-slots (class-of instance)))))
2686    (merge-initargs-sets
2687     (merge-initargs-sets slots-initargs method-keyword-args)
2688     '(:allow-other-keys))))  ;; allow-other-keys is always allowed
2689
2690(defun check-initargs (gf-list args instance
2691                       shared-initialize-param initargs
2692                       cache)
2693  "Checks the validity of `initargs' for the generic functions in `gf-list'
2694when called with `args' by calculating the applicable methods for each gf.
2695The applicable methods for SHARED-INITIALIZE based on `instance',
2696`shared-initialize-param' and `initargs' are added to the list of
2697applicable methods."
2698  (when (oddp (length initargs))
2699    (error 'program-error
2700           :format-control "Odd number of keyword arguments."))
2701  (unless (getf initargs :allow-other-keys)
2702    (multiple-value-bind (allowable-initargs present-p)
2703                         (when cache
2704                           (gethash (class-of instance) cache))
2705       (unless present-p
2706         (setf allowable-initargs
2707               (calculate-allowable-initargs gf-list args instance
2708                                             shared-initialize-param initargs))
2709         (when cache
2710           (setf (gethash (class-of instance) cache)
2711                 allowable-initargs)))
2712       (unless (eq t allowable-initargs)
2713         (do* ((tail initargs (cddr tail))
2714               (initarg (car tail) (car tail)))
2715              ((null tail))
2716              (unless (memq initarg allowable-initargs)
2717                (error 'program-error
2718                       :format-control "Invalid initarg ~S."
2719                       :format-arguments (list initarg))))))))
2720
2721(defun merge-initargs-sets (list1 list2)
2722  (cond
2723   ((eq list1 t)  t)
2724   ((eq list2 t)  t)
2725   (t             (union list1 list2))))
2726
2727(defun extract-lambda-list-keywords (lambda-list)
2728  "Returns a list of keywords acceptable as keyword arguments,
2729or T when any keyword is acceptable due to presence of
2730&allow-other-keys."
2731  (when (member '&allow-other-keys lambda-list)
2732    (return-from extract-lambda-list-keywords t))
2733  (loop with keyword-args = (cdr (memq '&key lambda-list))
2734        for key in keyword-args
2735        when (eq key '&aux) do (loop-finish)
2736        when (eq key '&allow-other-keys) do (return t)
2737        when (listp key) do (setq key (car key))
2738        collect (if (symbolp key)
2739                    (make-keyword key)
2740                  (car key))))
2741
2742
2743(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
2744
2745(defmethod make-instance ((class standard-class) &rest initargs)
2746  (when (oddp (length initargs))
2747    (error 'program-error :format-control "Odd number of keyword arguments."))
2748  (unless (class-finalized-p class)
2749    (std-finalize-inheritance class))
2750  (let ((class-default-initargs (class-default-initargs class)))
2751    (when class-default-initargs
2752      (let ((default-initargs '()))
2753        (do* ((list class-default-initargs (cddr list))
2754              (key (car list) (car list))
2755              (fn (cadr list) (cadr list)))
2756             ((null list))
2757          (when (eq (getf initargs key 'not-found) 'not-found)
2758            (setf default-initargs (append default-initargs (list key (funcall fn))))))
2759        (setf initargs (append initargs default-initargs)))))
2760
2761  (let ((instance (std-allocate-instance class)))
2762    (check-initargs (list #'allocate-instance #'initialize-instance)
2763                    (list* instance initargs)
2764                    instance t initargs
2765                    *make-instance-initargs-cache*)
2766    (apply #'initialize-instance instance initargs)
2767    instance))
2768
2769(defmethod make-instance ((class symbol) &rest initargs)
2770  (apply #'make-instance (find-class class) initargs))
2771
2772(defgeneric initialize-instance (instance &key))
2773
2774(defmethod initialize-instance ((instance standard-object) &rest initargs)
2775  (apply #'shared-initialize instance t initargs))
2776
2777(defgeneric reinitialize-instance (instance &key))
2778
2779;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
2780;; validity of initargs and signals an error if an initarg is supplied that is
2781;; not declared as valid. The method then calls the generic function SHARED-
2782;; INITIALIZE with the following arguments: the instance, nil (which means no
2783;; slots should be initialized according to their initforms), and the initargs
2784;; it received."
2785(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
2786  (check-initargs (list #'reinitialize-instance) (list* instance initargs)
2787                  instance () initargs
2788                  *reinitialize-instance-initargs-cache*)
2789  (apply #'shared-initialize instance () initargs))
2790
2791(defun std-shared-initialize (instance slot-names all-keys)
2792  (when (oddp (length all-keys))
2793    (error 'program-error :format-control "Odd number of keyword arguments."))
2794  ;; do a quick scan of the arguments list to see if it's a real
2795  ;; 'initialization argument list' (which is not the same as
2796  ;; checking initarg validity
2797  (do* ((tail all-keys (cddr tail))
2798        (initarg (car tail) (car tail)))
2799      ((null tail))
2800    (unless (symbolp initarg)
2801      (error 'program-error
2802             :format-control "Invalid initarg ~S."
2803             :format-arguments (list initarg))))
2804  (dolist (slot (class-slots (class-of instance)))
2805    (let ((slot-name (slot-definition-name slot)))
2806      (multiple-value-bind (init-key init-value foundp)
2807          (get-properties all-keys (slot-definition-initargs slot))
2808        (if foundp
2809            (setf (std-slot-value instance slot-name) init-value)
2810            (unless (std-slot-boundp instance slot-name)
2811              (let ((initfunction (slot-definition-initfunction slot)))
2812                (when (and initfunction (or (eq slot-names t)
2813                                            (memq slot-name slot-names)))
2814                  (setf (std-slot-value instance slot-name)
2815                        (funcall initfunction)))))))))
2816  instance)
2817
2818(defgeneric shared-initialize (instance slot-names &key))
2819
2820(defmethod shared-initialize ((instance standard-object) slot-names &rest initargs)
2821  (std-shared-initialize instance slot-names initargs))
2822
2823(defmethod shared-initialize ((slot slot-definition) slot-names
2824                              &rest args
2825                              &key name initargs initform initfunction
2826                              readers writers allocation
2827                              &allow-other-keys)
2828  ;;Keyword args are duplicated from init-slot-definition only to have
2829  ;;them checked.
2830  (declare (ignore slot-names)) ;;TODO?
2831  (declare (ignore name initargs initform initfunction readers writers allocation))
2832  ;;For built-in slots
2833  (apply #'init-slot-definition slot :allow-other-keys t args)
2834  ;;For user-defined slots
2835  (call-next-method))
2836
2837;;; change-class
2838
2839(defgeneric change-class (instance new-class &key))
2840
2841(defmethod change-class ((old-instance standard-object) (new-class standard-class)
2842                         &rest initargs)
2843  (let ((old-slots (class-slots (class-of old-instance)))
2844        (new-slots (class-slots new-class))
2845        (new-instance (allocate-instance new-class)))
2846    ;; "The values of local slots specified by both the class CTO and the class
2847    ;; CFROM are retained. If such a local slot was unbound, it remains
2848    ;; unbound."
2849    (dolist (new-slot new-slots)
2850      (when (instance-slot-p new-slot)
2851        (let* ((slot-name (slot-definition-name new-slot))
2852               (old-slot (find slot-name old-slots :key 'slot-definition-name)))
2853          ;; "The values of slots specified as shared in the class CFROM and as
2854          ;; local in the class CTO are retained."
2855          (when (and old-slot (slot-boundp old-instance slot-name))
2856            (setf (slot-value new-instance slot-name)
2857                  (slot-value old-instance slot-name))))))
2858    (swap-slots old-instance new-instance)
2859    (rotatef (std-instance-layout new-instance)
2860             (std-instance-layout old-instance))
2861    (apply #'update-instance-for-different-class
2862           new-instance old-instance initargs)
2863    old-instance))
2864
2865(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
2866  (apply #'change-class instance (find-class new-class) initargs))
2867
2868(defgeneric update-instance-for-different-class (old new &key))
2869
2870(defmethod update-instance-for-different-class
2871  ((old standard-object) (new standard-object) &rest initargs)
2872  (let ((added-slots
2873         (remove-if #'(lambda (slot-name)
2874                       (slot-exists-p old slot-name))
2875                    (mapcar 'slot-definition-name
2876                            (class-slots (class-of new))))))
2877    (check-initargs (list #'update-instance-for-different-class)
2878                    (list old new initargs)
2879                    new added-slots initargs
2880                    nil)
2881    (apply #'shared-initialize new added-slots initargs)))
2882
2883;;; make-instances-obsolete
2884
2885(defgeneric make-instances-obsolete (class))
2886
2887(defmethod make-instances-obsolete ((class standard-class))
2888  (%make-instances-obsolete class))
2889
2890(defmethod make-instances-obsolete ((class symbol))
2891  (make-instances-obsolete (find-class class))
2892  class)
2893
2894;;; update-instance-for-redefined-class
2895
2896(defgeneric update-instance-for-redefined-class (instance
2897                                                 added-slots
2898                                                 discarded-slots
2899                                                 property-list
2900                                                 &rest initargs
2901                                                 &key
2902                                                 &allow-other-keys))
2903
2904(defmethod update-instance-for-redefined-class ((instance standard-object)
2905            added-slots
2906            discarded-slots
2907            property-list
2908            &rest initargs)
2909  (check-initargs (list #'update-instance-for-redefined-class)
2910                  (list* instance added-slots discarded-slots
2911                         property-list initargs)
2912                  instance added-slots initargs
2913                  nil)
2914  (apply #'shared-initialize instance added-slots initargs))
2915
2916;;;  Methods having to do with class metaobjects.
2917
2918(defmethod initialize-instance :after ((class standard-class) &rest args)
2919  (apply #'std-after-initialization-for-classes class args))
2920
2921(defmethod reinitialize-instance :after ((class standard-class) &rest all-keys)
2922  (remhash class *make-instance-initargs-cache*)
2923  (remhash class *reinitialize-instance-initargs-cache*)
2924  (%make-instances-obsolete class)
2925  (setf (class-finalized-p class) nil)
2926  (check-initargs (list #'allocate-instance
2927                        #'initialize-instance)
2928                  (list* class all-keys)
2929                  class t all-keys
2930                  nil)
2931  (apply #'std-after-initialization-for-classes class all-keys))
2932
2933;;; Finalize inheritance
2934
2935(atomic-defgeneric finalize-inheritance (class)
2936    (:method ((class standard-class))
2937       (std-finalize-inheritance class)))
2938
2939;;; Class precedence lists
2940
2941(defgeneric compute-class-precedence-list (class))
2942(defmethod compute-class-precedence-list ((class standard-class))
2943  (std-compute-class-precedence-list class))
2944
2945;;; Slot inheritance
2946
2947(defgeneric compute-slots (class))
2948(defmethod compute-slots ((class standard-class))
2949  (std-compute-slots class))
2950
2951(defgeneric compute-effective-slot-definition (class name direct-slots))
2952(defmethod compute-effective-slot-definition
2953  ((class standard-class) name direct-slots)
2954  (std-compute-effective-slot-definition class name direct-slots))
2955
2956;;; Methods having to do with generic function metaobjects.
2957
2958(defmethod initialize-instance :after ((gf standard-generic-function) &key)
2959  (finalize-generic-function gf))
2960
2961;;; Methods having to do with generic function invocation.
2962
2963(defgeneric compute-discriminating-function (gf))
2964(defmethod compute-discriminating-function ((gf standard-generic-function))
2965  (std-compute-discriminating-function gf))
2966
2967(defgeneric method-more-specific-p (gf method1 method2 required-classes))
2968
2969(defmethod method-more-specific-p ((gf standard-generic-function)
2970                                   method1 method2 required-classes)
2971  (std-method-more-specific-p method1 method2 required-classes
2972                              (generic-function-argument-precedence-order gf)))
2973
2974;;; XXX AMOP has COMPUTE-EFFECTIVE-METHOD
2975(defgeneric compute-effective-method-function (gf methods))
2976(defmethod compute-effective-method-function ((gf standard-generic-function) methods)
2977  (std-compute-effective-method-function gf methods))
2978
2979(defgeneric compute-applicable-methods (gf args))
2980(defmethod compute-applicable-methods ((gf standard-generic-function) args)
2981  (%compute-applicable-methods gf args))
2982
2983;;; Slot definition accessors
2984
2985(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
2986  `(let (($cl (class-of ,slot-definition)))
2987     (case $cl
2988       ((+the-standard-slot-definition-class+
2989         +the-standard-direct-slot-definition-class+
2990         +the-standard-effective-slot-definition-class+)
2991        ,std-form)
2992       (t ,generic-form))))
2993
2994(atomic-defgeneric slot-definition-allocation (slot-definition)
2995  (:method ((slot-definition slot-definition))
2996    (slot-definition-dispatch slot-definition
2997      (%slot-definition-allocation slot-definition)
2998      (slot-value slot-definition 'sys::allocation))))
2999
3000(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
3001  (:method (value (slot-definition slot-definition))
3002    (slot-definition-dispatch slot-definition
3003      (set-slot-definition-allocation slot-definition value)
3004      (setf (slot-value slot-definition 'sys::allocation) value))))
3005
3006(atomic-defgeneric slot-definition-initargs (slot-definition)
3007  (:method ((slot-definition slot-definition))
3008    (slot-definition-dispatch slot-definition
3009      (%slot-definition-initargs slot-definition)
3010      (slot-value slot-definition 'sys::initargs))))
3011
3012(atomic-defgeneric slot-definition-initform (slot-definition)
3013  (:method ((slot-definition slot-definition))
3014    (slot-definition-dispatch slot-definition
3015      (%slot-definition-initform slot-definition)
3016      (slot-value slot-definition 'sys::initform))))
3017
3018(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
3019  (:method (value (slot-definition slot-definition))
3020    (slot-definition-dispatch slot-definition
3021      (set-slot-definition-initform slot-definition value)
3022      (setf (slot-value slot-definition 'sys::initform) value))))
3023
3024(atomic-defgeneric slot-definition-initfunction (slot-definition)
3025  (:method ((slot-definition slot-definition))
3026    (slot-definition-dispatch slot-definition
3027      (%slot-definition-initfunction slot-definition)
3028      (slot-value slot-definition 'sys::initfunction))))
3029
3030(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
3031  (:method (value (slot-definition slot-definition))
3032    (slot-definition-dispatch slot-definition
3033      (set-slot-definition-initfunction slot-definition value)
3034      (setf (slot-value slot-definition 'sys::initfunction) value))))
3035
3036(atomic-defgeneric slot-definition-name (slot-definition)
3037  (:method ((slot-definition slot-definition))
3038    (slot-definition-dispatch slot-definition
3039      (%slot-definition-name slot-definition)
3040      (slot-value slot-definition 'sys::name))))
3041
3042(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
3043  (:method (value (slot-definition slot-definition))
3044    (slot-definition-dispatch slot-definition
3045      (set-slot-definition-name slot-definition value)
3046      (setf (slot-value slot-definition 'sys::name) value))))
3047
3048(atomic-defgeneric slot-definition-readers (slot-definition)
3049  (:method ((slot-definition slot-definition))
3050    (slot-definition-dispatch slot-definition
3051      (%slot-definition-readers slot-definition)
3052      (slot-value slot-definition 'sys::readers))))
3053
3054(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
3055  (:method (value (slot-definition slot-definition))
3056    (slot-definition-dispatch slot-definition
3057      (set-slot-definition-readers slot-definition value)
3058      (setf (slot-value slot-definition 'sys::readers) value))))
3059
3060(atomic-defgeneric slot-definition-writers (slot-definition)
3061  (:method ((slot-definition slot-definition))
3062    (slot-definition-dispatch slot-definition
3063      (%slot-definition-writers slot-definition)
3064      (slot-value slot-definition 'sys::writers))))
3065
3066(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
3067  (:method (value (slot-definition slot-definition))
3068    (slot-definition-dispatch slot-definition
3069      (set-slot-definition-writers slot-definition value)
3070      (setf (slot-value slot-definition 'sys::writers) value))))
3071
3072(atomic-defgeneric slot-definition-allocation-class (slot-definition)
3073  (:method ((slot-definition slot-definition))
3074    (slot-definition-dispatch slot-definition
3075      (%slot-definition-allocation-class slot-definition)
3076      (slot-value slot-definition 'sys::allocation-class))))
3077
3078(atomic-defgeneric (setf slot-definition-allocation-class)
3079                       (value slot-definition)
3080  (:method (value (slot-definition slot-definition))
3081    (slot-definition-dispatch slot-definition
3082      (set-slot-definition-allocation-class slot-definition value)
3083      (setf (slot-value slot-definition 'sys::allocation-class) value))))
3084
3085(atomic-defgeneric slot-definition-location (slot-definition)
3086  (:method ((slot-definition slot-definition))
3087    (slot-definition-dispatch slot-definition
3088      (%slot-definition-location slot-definition)
3089      (slot-value slot-definition 'sys::location))))
3090
3091(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
3092  (:method (value (slot-definition slot-definition))
3093    (slot-definition-dispatch slot-definition
3094      (set-slot-definition-location slot-definition value)
3095      (setf (slot-value slot-definition 'sys::location) value))))
3096
3097;;; No %slot-definition-type.
3098
3099
3100;;; Conditions.
3101
3102(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
3103  (let ((parent-types (or parent-types '(condition)))
3104        (report nil))
3105    (dolist (option options)
3106      (when (eq (car option) :report)
3107        (setf report (cadr option))
3108  (setf options (delete option options :test #'equal))
3109        (return)))
3110    (typecase report
3111      (null
3112       `(progn
3113          (defclass ,name ,parent-types ,slot-specs ,@options)
3114          ',name))
3115      (string
3116       `(progn
3117          (defclass ,name ,parent-types ,slot-specs ,@options)
3118          (defmethod print-object ((condition ,name) stream)
3119            (if *print-escape*
3120                (call-next-method)
3121                (progn (write-string ,report stream) condition)))
3122          ',name))
3123      (t
3124       `(progn
3125          (defclass ,name ,parent-types ,slot-specs ,@options)
3126          (defmethod print-object ((condition ,name) stream)
3127            (if *print-escape*
3128                (call-next-method)
3129                (funcall #',report condition stream)))
3130          ',name)))))
3131
3132(defun make-condition (type &rest initargs)
3133  (or (%make-condition type initargs)
3134      (let ((class (if (symbolp type) (find-class type) type)))
3135        (apply #'make-instance class initargs))))
3136
3137;; Adapted from SBCL.
3138;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
3139(defun coerce-to-condition (datum arguments default-type fun-name)
3140  (cond ((typep datum 'condition)
3141         (when arguments
3142           (error 'simple-type-error
3143                  :datum arguments
3144                  :expected-type 'null
3145                  :format-control "You may not supply additional arguments when giving ~S to ~S."
3146                  :format-arguments (list datum fun-name)))
3147         datum)
3148        ((symbolp datum)
3149         (apply #'make-condition datum arguments))
3150        ((or (stringp datum) (functionp datum))
3151         (make-condition default-type
3152                         :format-control datum
3153                         :format-arguments arguments))
3154        (t
3155         (error 'simple-type-error
3156                :datum datum
3157                :expected-type '(or symbol string)
3158                :format-control "Bad argument to ~S: ~S."
3159                :format-arguments (list fun-name datum)))))
3160
3161(defgeneric make-load-form (object &optional environment))
3162
3163(defmethod make-load-form ((object t) &optional environment)
3164  (declare (ignore environment))
3165  (apply #'no-applicable-method #'make-load-form (list object)))
3166
3167(defmethod make-load-form ((class class) &optional environment)
3168  (declare (ignore environment))
3169  (let ((name (class-name class)))
3170    (unless (and name (eq (find-class name nil) class))
3171      (error 'simple-type-error
3172             :format-control "Can't use anonymous or undefined class as a constant: ~S."
3173             :format-arguments (list class)))
3174    `(find-class ',name)))
3175
3176(defun invalid-method-error (method format-control &rest args)
3177  (let ((message (apply #'format nil format-control args)))
3178    (error "Invalid method error for ~S:~%    ~A" method message)))
3179
3180(defun method-combination-error (format-control &rest args)
3181  (let ((message (apply #'format nil format-control args)))
3182    (error "Method combination error in CLOS dispatch:~%    ~A" message)))
3183
3184
3185(atomic-defgeneric no-applicable-method (generic-function &rest args)
3186  (:method (generic-function &rest args)
3187      (error "There is no applicable method for the generic function ~S ~
3188              when called with arguments ~S."
3189             generic-function
3190             args)))
3191
3192
3193
3194(defgeneric find-method (generic-function
3195                         qualifiers
3196                         specializers
3197                         &optional errorp))
3198
3199(defmethod find-method ((generic-function standard-generic-function)
3200                        qualifiers specializers &optional (errorp t))
3201  (%find-method generic-function qualifiers specializers errorp))
3202
3203(defgeneric add-method (generic-function method))
3204
3205(defmethod add-method ((generic-function standard-generic-function)
3206                       (method method))
3207  (let ((method-lambda-list (method-lambda-list method))
3208        (gf-lambda-list (generic-function-lambda-list generic-function)))
3209    (check-method-lambda-list (%generic-function-name generic-function)
3210                              method-lambda-list gf-lambda-list))
3211  (%add-method generic-function method))
3212
3213(defgeneric remove-method (generic-function method))
3214
3215(defmethod remove-method ((generic-function standard-generic-function) method)
3216  (%remove-method generic-function method))
3217
3218;; See describe.lisp.
3219(defgeneric describe-object (object stream))
3220
3221;; FIXME
3222(defgeneric no-next-method (generic-function method &rest args))
3223
3224;; FIXME
3225(defgeneric function-keywords (method))
3226
3227
3228(setf *gf-initialize-instance* (symbol-function 'initialize-instance))
3229(setf *gf-allocate-instance* (symbol-function 'allocate-instance))
3230(setf *gf-shared-initialize* (symbol-function 'shared-initialize))
3231(setf *gf-reinitialize-instance* (symbol-function 'reinitialize-instance))
3232(setf *clos-booting* nil)
3233
3234(defgeneric class-prototype (class))
3235
3236(defmethod class-prototype :before (class)
3237  (unless (class-finalized-p class)
3238    (error "~@<~S is not finalized.~:@>" class)))
3239
3240(defmethod class-prototype ((class standard-class))
3241  (allocate-instance class))
3242
3243(defmethod class-prototype ((class structure-class))
3244  (allocate-instance class))
3245
3246(eval-when (:compile-toplevel :load-toplevel :execute)
3247  (require "MOP"))
3248
3249(provide 'clos)
3250
Note: See TracBrowser for help on using the repository browser.