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

Last change on this file since 13990 was 13990, checked in by rschlatte, 9 years ago

Implement make-method-lambda

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 193.1 KB
Line 
1;;; clos.lisp
2;;;
3;;; Copyright (C) 2003-2007 Peter Graves
4;;; Copyright (C) 2010 Mark Evenson
5;;; $Id: clos.lisp 13990 2012-07-02 16:33:36Z rschlatte $
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 case, e.g. with arguments of type STANDARD-CLASS
69;; or STANDARD-GENERIC-FUNCTION.  To prevent repeated code, the
70;; functions are implemented in functions by the same name as the API
71;; functions, but with the STD- prefix.  These functions are sometimes
72;; used in regular code as well, either in a "fast path" or to break a
73;; circularity (e.g., within compute-discriminating-function when the
74;; user adds a method to compute-discriminating-function).
75;;
76;; When hacking this file, note that some important parts are implemented
77;; in the Java world. These Java bits can be found in the files
78;;
79;; * LispClass.java
80;; * SlotClass.java
81;; * StandardClass.java
82;; * BuiltInClass.java
83;; * StandardObject.java
84;; * StandardObjectFunctions.java
85;; * FuncallableStandardObject.java
86;; * Layout.java
87;;
88;; In case of function names, those defined on the Java side can be
89;; recognized by their prefixed percent (%) sign.
90;;
91;; The API functions need to be declaimed NOTINLINE explicitly, because
92;; that prevents inlining in the current FASL (which is allowed by the
93;; CLHS without the declaration); this is a hard requirement to in order
94;; to be able to swap the symbol's function slot with a generic function
95;; later on - with it actually being used.
96;;
97;;
98;;
99;; ### Note that the "declares all API functions as regular functions"
100;; isn't true when I write the above, but it's definitely the target.
101;;
102;; A note about AMOP: the first chapters (and the sample Closette
103;; implementation) of the book sometimes deviate from the specification.
104;; For example, in the examples slot-value-using-class has the slot name
105;; as third argument where in the specification it is the effective slot
106;; definition.  When in doubt, we aim to follow the specification, the
107;; MOP test suite at http://common-lisp.net/project/closer/features.html
108;; and the behavior of other CL implementations in preference to
109;; chapters 1-4 and appendix D.
110
111(defconstant +the-standard-class+ (find-class 'standard-class))
112(defconstant +the-funcallable-standard-class+
113  (find-class 'funcallable-standard-class))
114(defconstant +the-structure-class+ (find-class 'structure-class))
115(defconstant +the-standard-object-class+ (find-class 'standard-object))
116(defconstant +the-funcallable-standard-object-class+
117  (find-class 'funcallable-standard-object))
118(defconstant +the-standard-method-class+ (find-class 'standard-method))
119(defconstant +the-forward-referenced-class+
120  (find-class 'forward-referenced-class))
121(defconstant +the-standard-reader-method-class+
122  (find-class 'standard-reader-method))
123(defconstant +the-standard-writer-method-class+
124  (find-class 'standard-writer-method))
125(defconstant +the-standard-generic-function-class+
126  (find-class 'standard-generic-function))
127(defconstant +the-T-class+ (find-class 'T))
128(defconstant +the-standard-slot-definition-class+ (find-class 'standard-slot-definition))
129(defconstant +the-standard-direct-slot-definition-class+ (find-class 'standard-direct-slot-definition))
130(defconstant +the-standard-effective-slot-definition-class+ (find-class 'standard-effective-slot-definition))
131
132;; Don't use DEFVAR, because that disallows loading clos.lisp
133;; after compiling it: the binding won't get assigned to T anymore
134(defparameter *clos-booting* t)
135
136(defmacro define-class->%class-forwarder (name)
137  (let* (($name (if (consp name) (cadr name) name))
138         (%name (intern (concatenate 'string
139                                     "%"
140                                     (if (consp name)
141                                         (symbol-name 'set-) "")
142                                     (symbol-name $name))
143                        (symbol-package $name))))
144    `(progn
145       (declaim (notinline ,name))
146       (defun ,name (&rest args)
147         (apply #',%name args)))))
148
149;;
150;;  DEFINE PLACE HOLDER FUNCTIONS
151;;
152
153(define-class->%class-forwarder class-name)
154(define-class->%class-forwarder (setf class-name))
155(define-class->%class-forwarder class-slots)
156(define-class->%class-forwarder (setf class-slots))
157(define-class->%class-forwarder class-direct-slots)
158(define-class->%class-forwarder (setf class-direct-slots))
159(define-class->%class-forwarder class-layout)
160(define-class->%class-forwarder (setf class-layout))
161(define-class->%class-forwarder class-direct-superclasses)
162(define-class->%class-forwarder (setf class-direct-superclasses))
163(define-class->%class-forwarder class-direct-subclasses)
164(define-class->%class-forwarder (setf class-direct-subclasses))
165(define-class->%class-forwarder class-direct-methods)
166(define-class->%class-forwarder (setf class-direct-methods))
167(define-class->%class-forwarder class-precedence-list)
168(define-class->%class-forwarder (setf class-precedence-list))
169(define-class->%class-forwarder class-finalized-p)
170(define-class->%class-forwarder (setf class-finalized-p))
171(define-class->%class-forwarder class-default-initargs)
172(define-class->%class-forwarder (setf class-default-initargs))
173(define-class->%class-forwarder class-direct-default-initargs)
174(define-class->%class-forwarder (setf class-direct-default-initargs))
175
176(declaim (notinline add-direct-subclass remove-direct-subclass))
177(defun add-direct-subclass (superclass subclass)
178  (setf (class-direct-subclasses superclass)
179        (adjoin subclass (class-direct-subclasses superclass))))
180(defun remove-direct-subclass (superclass subclass)
181  (setf (class-direct-subclasses superclass)
182        (remove subclass (class-direct-subclasses superclass))))
183
184(defun fixup-standard-class-hierarchy ()
185  ;; Make the result of class-direct-subclasses for the pre-built
186  ;; classes agree with AMOP Table 5.1 (pg. 141).  This could be done in
187  ;; StandardClass.java where these classes are defined, but it's less
188  ;; painful to do it Lisp-side.
189  (flet ((add-subclasses (class subclasses)
190           (when (atom subclasses) (setf subclasses (list subclasses)))
191           (setf (class-direct-subclasses (find-class class))
192                 (union (class-direct-subclasses (find-class class))
193                        (mapcar #'find-class subclasses)))))
194    (add-subclasses t 'standard-object)
195    (add-subclasses 'function 'funcallable-standard-object)
196    (add-subclasses 'standard-object '(funcallable-standard-object metaobject))
197    (add-subclasses 'metaobject
198                    '(generic-function method method-combination
199                      slot-definition specializer))
200    (add-subclasses 'method-combination
201                    '(long-method-combination short-method-combination))
202    (add-subclasses 'funcallable-standard-object 'generic-function)
203    (add-subclasses 'generic-function 'standard-generic-function)
204    (add-subclasses 'method 'standard-method)
205    (add-subclasses 'standard-method 'standard-accessor-method)
206    (add-subclasses 'standard-accessor-method
207                    '(standard-reader-method standard-writer-method))
208    (add-subclasses 'slot-definition
209                    '(direct-slot-definition effective-slot-definition
210                      standard-slot-definition))
211    (add-subclasses 'standard-slot-definition
212                    '(standard-direct-slot-definition
213                      standard-effective-slot-definition))
214    (add-subclasses 'direct-slot-definition 'standard-direct-slot-definition)
215    (add-subclasses 'effective-slot-definition
216                    'standard-effective-slot-definition)
217    (add-subclasses 'specializer '(eql-specializer class))
218    (add-subclasses 'class
219                    '(built-in-class forward-referenced-class standard-class
220                      funcallable-standard-class))))
221(fixup-standard-class-hierarchy)
222
223(defun no-applicable-method (generic-function &rest args)
224  (error "There is no applicable method for the generic function ~S when called with arguments ~S."
225         generic-function
226         args))
227
228(defun function-keywords (method)
229  (std-function-keywords method))
230
231(declaim (notinline map-dependents))
232(defun map-dependents (metaobject function)
233  ;; stub, will be redefined later
234  (declare (ignore metaobject function))
235  nil)
236
237(defmacro push-on-end (value location)
238  `(setf ,location (nconc ,location (list ,value))))
239
240;;; (SETF GETF*) is like (SETF GETF) except that it always changes the list,
241;;; which must be non-nil.
242
243(defun (setf getf*) (new-value plist key)
244  (block body
245    (do ((x plist (cddr x)))
246        ((null x))
247      (when (eq (car x) key)
248        (setf (car (cdr x)) new-value)
249        (return-from body new-value)))
250    (push-on-end key plist)
251    (push-on-end new-value plist)
252    new-value))
253
254(defun mapappend (fun &rest args)
255  (if (some #'null args)
256      ()
257      (append (apply fun (mapcar #'car args))
258              (apply #'mapappend fun (mapcar #'cdr args)))))
259
260(defun mapplist (fun x)
261  (if (null x)
262      ()
263      (cons (funcall fun (car x) (cadr x))
264            (mapplist fun (cddr x)))))
265
266(defsetf std-instance-layout %set-std-instance-layout)
267(defsetf standard-instance-access %set-standard-instance-access)
268(defun funcallable-standard-instance-access (instance location)
269  (standard-instance-access instance location))
270(defsetf funcallable-standard-instance-access %set-standard-instance-access)
271
272(defun (setf find-class) (new-value symbol &optional errorp environment)
273  (declare (ignore errorp environment))
274  (%set-find-class symbol new-value))
275
276(defun canonicalize-direct-slots (direct-slots)
277  `(list ,@(mapcar #'canonicalize-direct-slot direct-slots)))
278
279(defun canonicalize-direct-slot (spec)
280  (if (symbolp spec)
281      `(list :name ',spec)
282      (let ((name (car spec))
283            (initfunction nil)
284            (initform nil)
285            (initargs ())
286            (type nil)
287            (allocation nil)
288            (documentation nil)
289            (readers ())
290            (writers ())
291            (other-options ())
292            (non-std-options ()))
293        (do ((olist (cdr spec) (cddr olist)))
294            ((null olist))
295          (case (car olist)
296            (:initform
297             (when initform
298               (error 'program-error
299                      "duplicate slot option :INITFORM for slot named ~S"
300                      name))
301             (setq initfunction t)
302             (setq initform (cadr olist)))
303            (:initarg
304             (push-on-end (cadr olist) initargs))
305            (:allocation
306             (when allocation
307               (error 'program-error
308                      "duplicate slot option :ALLOCATION for slot named ~S"
309                      name))
310             (setf allocation (cadr olist))
311             (push-on-end (car olist) other-options)
312             (push-on-end (cadr olist) other-options))
313            (:type
314             (when type
315               (error 'program-error
316                      "duplicate slot option :TYPE for slot named ~S"
317                      name))
318             (setf type (cadr olist)))
319            (:documentation
320             (when documentation
321               (error 'program-error
322                      "duplicate slot option :DOCUMENTATION for slot named ~S"
323                      name))
324             (setf documentation (cadr olist)))
325            (:reader
326             (maybe-note-name-defined (cadr olist))
327             (push-on-end (cadr olist) readers))
328            (:writer
329             (maybe-note-name-defined (cadr olist))
330             (push-on-end (cadr olist) writers))
331            (:accessor
332             (maybe-note-name-defined (cadr olist))
333             (push-on-end (cadr olist) readers)
334             (push-on-end `(setf ,(cadr olist)) writers))
335            (t
336             (push-on-end (cadr olist) (getf non-std-options (car olist))))))
337        `(list
338          :name ',name
339          ,@(when initfunction
340              `(:initform ',initform
341                :initfunction ,(if (eq allocation :class)
342                                   ;; CLHS specifies the initform for a
343                                   ;; class allocation level slot needs
344                                   ;; to be evaluated in the dynamic
345                                   ;; extent of the DEFCLASS form
346                                   (let ((var (gensym)))
347                                     `(let ((,var ,initform))
348                                        (lambda () ,var)))
349                                 `(lambda () ,initform))))
350          ,@(when initargs `(:initargs ',initargs))
351          ,@(when readers `(:readers ',readers))
352          ,@(when writers `(:writers ',writers))
353          ,@(when type `(:type ',type))
354          ,@(when documentation `(:documentation ',documentation))
355          ,@other-options
356          ,@(mapcar #'(lambda (opt) (if (or (atom opt) (/= 1 (length opt)))
357                                        `',opt
358                                        `',(car opt)))
359                    non-std-options)))))
360
361(defun maybe-note-name-defined (name)
362  (when (fboundp 'note-name-defined)
363    (note-name-defined name)))
364
365(defun canonicalize-defclass-options (options)
366  (mapappend #'canonicalize-defclass-option options))
367
368(defun canonicalize-defclass-option (option)
369  (case (car option)
370    (:metaclass
371     (list ':metaclass
372           `(find-class ',(cadr option))))
373    (:default-initargs
374     (list
375      ':direct-default-initargs
376      `(list ,@(mapplist
377                #'(lambda (key value)
378                    `(list ',key ',value ,(make-initfunction value)))
379                (cdr option)))))
380    ((:documentation :report)
381     (list (car option) `',(cadr option)))
382    (t (list `(quote ,(car option)) `(quote ,(cdr option))))))
383
384(defun make-initfunction (initform)
385  `(function (lambda () ,initform)))
386
387(defun slot-definition-allocation (slot-definition)
388  (%slot-definition-allocation slot-definition))
389
390(declaim (notinline (setf slot-definition-allocation)))
391(defun (setf slot-definition-allocation) (value slot-definition)
392  (set-slot-definition-allocation slot-definition value))
393
394(defun slot-definition-initargs (slot-definition)
395  (%slot-definition-initargs slot-definition))
396
397(declaim (notinline (setf slot-definition-initargs)))
398(defun (setf slot-definition-initargs) (value slot-definition)
399  (set-slot-definition-initargs slot-definition value))
400
401(defun slot-definition-initform (slot-definition)
402  (%slot-definition-initform slot-definition))
403
404(declaim (notinline (setf slot-definition-initform)))
405(defun (setf slot-definition-initform) (value slot-definition)
406  (set-slot-definition-initform slot-definition value))
407
408(defun slot-definition-initfunction (slot-definition)
409  (%slot-definition-initfunction slot-definition))
410
411(declaim (notinline (setf slot-definition-initfunction)))
412(defun (setf slot-definition-initfunction) (value slot-definition)
413  (set-slot-definition-initfunction slot-definition value))
414
415(defun slot-definition-name (slot-definition)
416  (%slot-definition-name slot-definition))
417
418(declaim (notinline (setf slot-definition-name)))
419(defun (setf slot-definition-name) (value slot-definition)
420  (set-slot-definition-name slot-definition value))
421
422(defun slot-definition-readers (slot-definition)
423  (%slot-definition-readers slot-definition))
424
425(declaim (notinline (setf slot-definition-readers)))
426(defun (setf slot-definition-readers) (value slot-definition)
427  (set-slot-definition-readers slot-definition value))
428
429(defun slot-definition-writers (slot-definition)
430  (%slot-definition-writers slot-definition))
431
432(declaim (notinline (setf slot-definition-writers)))
433(defun (setf slot-definition-writers) (value slot-definition)
434  (set-slot-definition-writers slot-definition value))
435
436(defun slot-definition-allocation-class (slot-definition)
437  (%slot-definition-allocation-class slot-definition))
438
439(declaim (notinline (setf slot-definition-allocation-class)))
440(defun (setf slot-definition-allocation-class) (value slot-definition)
441  (set-slot-definition-allocation-class slot-definition value))
442
443(defun slot-definition-location (slot-definition)
444  (%slot-definition-location slot-definition))
445
446(declaim (notinline (setf slot-definition-location-class)))
447(defun (setf slot-definition-location) (value slot-definition)
448  (set-slot-definition-location slot-definition value))
449
450(defun slot-definition-type (slot-definition)
451  (%slot-definition-type slot-definition))
452
453(declaim (notinline (setf slot-definition-type)))
454(defun (setf slot-definition-type) (value slot-definition)
455  (set-slot-definition-type slot-definition value))
456
457(defun slot-definition-documentation (slot-definition)
458  (%slot-definition-documentation slot-definition))
459
460(declaim (notinline (setf slot-definition-documentation)))
461(defun (setf slot-definition-documentation) (value slot-definition)
462  (set-slot-definition-documentation slot-definition value))
463
464(defun init-slot-definition (slot &key name
465                                    (initargs ())
466                                    (initform nil)
467                                    (initfunction nil)
468                                    (readers ())
469                                    (writers ())
470                                    (allocation :instance)
471                                    (allocation-class nil)
472                                    (type t)
473                                    (documentation nil))
474  (setf (slot-definition-name slot) name)
475  (setf (slot-definition-initargs slot) initargs)
476  (setf (slot-definition-initform slot) initform)
477  (setf (slot-definition-initfunction slot) initfunction)
478  (setf (slot-definition-readers slot) readers)
479  (setf (slot-definition-writers slot) writers)
480  (setf (slot-definition-allocation slot) allocation)
481  (setf (slot-definition-allocation-class slot) allocation-class)
482  (setf (slot-definition-type slot) type)
483  (setf (slot-definition-documentation slot) documentation)
484  slot)
485
486(defun make-direct-slot-definition (class &rest args)
487  (let ((slot-class (apply #'direct-slot-definition-class class args)))
488    (if (eq slot-class +the-standard-direct-slot-definition-class+)
489  (let ((slot (make-slot-definition +the-standard-direct-slot-definition-class+)))
490    (apply #'init-slot-definition slot :allocation-class class args)
491    slot)
492  (progn
493    (let ((slot (apply #'make-instance slot-class :allocation-class class
494           args)))
495      slot)))))
496
497(defun make-effective-slot-definition (class &rest args)
498  (let ((slot-class (apply #'effective-slot-definition-class class args)))
499    (if (eq slot-class +the-standard-effective-slot-definition-class+)
500  (let ((slot (make-slot-definition +the-standard-effective-slot-definition-class+)))
501    (apply #'init-slot-definition slot args)
502    slot)
503  (progn
504    (let ((slot (apply #'make-instance slot-class args)))
505      slot)))))
506
507;;; finalize-inheritance
508
509(declaim (notinline compute-default-initargs))
510(defun compute-default-initargs (class)
511  (std-compute-default-initargs class))
512
513(defun std-compute-default-initargs (class)
514  (delete-duplicates
515   (mapcan #'(lambda (c)
516               (copy-list
517                (class-direct-default-initargs c)))
518           (class-precedence-list class))
519   :key #'car :from-end t))
520
521(defun std-finalize-inheritance (class)
522  ;; In case the class is already finalized, return
523  ;; immediately, as per AMOP.
524  (when (class-finalized-p class)
525    (return-from std-finalize-inheritance))
526  (setf (class-precedence-list class)
527   (funcall (if (eq (class-of class) +the-standard-class+)
528                #'std-compute-class-precedence-list
529                #'compute-class-precedence-list)
530            class))
531  (setf (class-slots class)
532                   (funcall (if (eq (class-of class) +the-standard-class+)
533                                #'std-compute-slots
534                     #'compute-slots) class))
535  (let ((old-layout (class-layout class))
536        (length 0)
537        (instance-slots '())
538        (shared-slots '()))
539    (dolist (slot (class-slots class))
540      (case (slot-definition-allocation slot)
541        (:instance
542         (setf (slot-definition-location slot) length)
543         (incf length)
544         (push (slot-definition-name slot) instance-slots))
545        (:class
546         (unless (slot-definition-location slot)
547           (let ((allocation-class (slot-definition-allocation-class slot)))
548             (setf (slot-definition-location slot)
549                   (if (eq allocation-class class)
550                       (cons (slot-definition-name slot) +slot-unbound+)
551                       (slot-location allocation-class (slot-definition-name slot))))))
552         (push (slot-definition-location slot) shared-slots))))
553    (when old-layout
554      ;; Redefined class: initialize added shared slots.
555      (dolist (location shared-slots)
556        (let* ((slot-name (car location))
557               (old-location (layout-slot-location old-layout slot-name)))
558          (unless old-location
559            (let* ((slot-definition (find slot-name (class-slots class) :key 'slot-definition-name))
560                   (initfunction (slot-definition-initfunction slot-definition)))
561              (when initfunction
562                (setf (cdr location) (funcall initfunction))))))))
563    (setf (class-layout class)
564          (make-layout class (nreverse instance-slots) (nreverse shared-slots))))
565  (setf (class-default-initargs class)
566        (compute-default-initargs class))
567  (setf (class-finalized-p class) t))
568
569(declaim (notinline finalize-inheritance))
570(defun finalize-inheritance (class)
571  (std-finalize-inheritance class))
572
573
574;;; Class precedence lists
575
576(defun std-compute-class-precedence-list (class)
577  (let ((classes-to-order (collect-superclasses* class)))
578    (dolist (super classes-to-order)
579      (when (typep super 'forward-referenced-class)
580        (error "Can't compute class precedence list for class ~A ~
581                which depends on forward referenced class ~A." class super)))
582    (topological-sort classes-to-order
583                      (remove-duplicates
584                       (mapappend #'local-precedence-ordering
585                                  classes-to-order))
586                      #'std-tie-breaker-rule)))
587
588;;; topological-sort implements the standard algorithm for topologically
589;;; sorting an arbitrary set of elements while honoring the precedence
590;;; constraints given by a set of (X,Y) pairs that indicate that element
591;;; X must precede element Y.  The tie-breaker procedure is called when it
592;;; is necessary to choose from multiple minimal elements; both a list of
593;;; candidates and the ordering so far are provided as arguments.
594
595(defun topological-sort (elements constraints tie-breaker)
596  (let ((remaining-constraints constraints)
597        (remaining-elements elements)
598        (result ()))
599    (loop
600      (let ((minimal-elements
601             (remove-if
602              #'(lambda (class)
603                 (member class remaining-constraints
604                         :key #'cadr))
605              remaining-elements)))
606        (when (null minimal-elements)
607          (if (null remaining-elements)
608              (return-from topological-sort result)
609              (error "Inconsistent precedence graph.")))
610        (let ((choice (if (null (cdr minimal-elements))
611                          (car minimal-elements)
612                          (funcall tie-breaker
613                                   minimal-elements
614                                   result))))
615          (setq result (append result (list choice)))
616          (setq remaining-elements
617                (remove choice remaining-elements))
618          (setq remaining-constraints
619                (remove choice
620                        remaining-constraints
621                        :test #'member)))))))
622
623;;; In the event of a tie while topologically sorting class precedence lists,
624;;; the CLOS Specification says to "select the one that has a direct subclass
625;;; rightmost in the class precedence list computed so far."  The same result
626;;; is obtained by inspecting the partially constructed class precedence list
627;;; from right to left, looking for the first minimal element to show up among
628;;; the direct superclasses of the class precedence list constituent.
629;;; (There's a lemma that shows that this rule yields a unique result.)
630
631(defun std-tie-breaker-rule (minimal-elements cpl-so-far)
632  (dolist (cpl-constituent (reverse cpl-so-far))
633    (let* ((supers (class-direct-superclasses cpl-constituent))
634           (common (intersection minimal-elements supers)))
635      (when (not (null common))
636        (return-from std-tie-breaker-rule (car common))))))
637
638;;; This version of collect-superclasses* isn't bothered by cycles in the class
639;;; hierarchy, which sometimes happen by accident.
640
641(defun collect-superclasses* (class)
642  (labels ((all-superclasses-loop (seen superclasses)
643                                  (let ((to-be-processed
644                                         (set-difference superclasses seen)))
645                                    (if (null to-be-processed)
646                                        superclasses
647                                        (let ((class-to-process
648                                               (car to-be-processed)))
649                                          (all-superclasses-loop
650                                           (cons class-to-process seen)
651                                           (union (class-direct-superclasses
652                                                   class-to-process)
653                                                  superclasses)))))))
654          (all-superclasses-loop () (list class))))
655
656;;; The local precedence ordering of a class C with direct superclasses C_1,
657;;; C_2, ..., C_n is the set ((C C_1) (C_1 C_2) ...(C_n-1 C_n)).
658
659(defun local-precedence-ordering (class)
660  (mapcar #'list
661          (cons class
662                (butlast (class-direct-superclasses class)))
663          (class-direct-superclasses class)))
664
665;;; Slot inheritance
666
667(defun std-compute-slots (class)
668  (let* ((all-slots (mapappend #'class-direct-slots
669                               (class-precedence-list class)))
670         (all-names (remove-duplicates
671                     (mapcar 'slot-definition-name all-slots))))
672    (mapcar #'(lambda (name)
673               (funcall
674                (if (eq (class-of class) +the-standard-class+)
675                    #'std-compute-effective-slot-definition
676                    #'compute-effective-slot-definition)
677                class
678                name
679                (remove name all-slots
680                        :key 'slot-definition-name
681                        :test-not #'eq)))
682            all-names)))
683
684(defun std-compute-effective-slot-definition (class name direct-slots)
685  (let ((initer (find-if-not #'null direct-slots
686                             :key 'slot-definition-initfunction))
687        (documentation-slot (find-if-not #'null direct-slots
688                                         :key 'slot-definition-documentation))
689        (types (delete-duplicates
690                (delete t (mapcar #'slot-definition-type direct-slots))
691                :test #'equal))
692        )
693    (make-effective-slot-definition
694     class
695     :name name
696     :initform (if initer
697                   (slot-definition-initform initer)
698                   nil)
699     :initfunction (if initer
700                       (slot-definition-initfunction initer)
701                       nil)
702     :initargs (remove-duplicates
703                (mapappend 'slot-definition-initargs
704                           direct-slots))
705     :allocation (slot-definition-allocation (car direct-slots))
706     :allocation-class (when (slot-boundp (car direct-slots)
707                                          'sys::allocation-class)
708                         ;;for some classes created in Java
709                         ;;(e.g. SimpleCondition) this slot is unbound
710                         (slot-definition-allocation-class (car direct-slots)))
711     :type (cond ((null types) t)
712                 ((= 1 (length types)) types)
713                 (t (list* 'and types)))
714     :documentation (documentation documentation-slot t))))
715
716;;; Standard instance slot access
717
718;;; N.B. The location of the effective-slots slots in the class metaobject for
719;;; standard-class must be determined without making any further slot
720;;; references.
721
722(defun find-slot-definition (class slot-name)
723  (dolist (slot (class-slots class) nil)
724    (when (eq slot-name (slot-definition-name slot))
725      (return slot))))
726
727(defun slot-location (class slot-name)
728  (let ((slot (find-slot-definition class slot-name)))
729    (if slot
730        (slot-definition-location slot)
731        nil)))
732
733(defun instance-slot-location (instance slot-name)
734  (let ((layout (std-instance-layout instance)))
735    (and layout (layout-slot-location layout slot-name))))
736
737(defun slot-value (object slot-name)
738  (let* ((class (class-of object))
739         (metaclass (class-of class)))
740    (if (or (eq metaclass +the-standard-class+)
741            (eq metaclass +the-structure-class+)
742            (eq metaclass +the-funcallable-standard-class+))
743        (std-slot-value object slot-name)
744        (slot-value-using-class class object
745                                (find-slot-definition class slot-name)))))
746
747(defsetf std-slot-value set-std-slot-value)
748
749(defun %set-slot-value (object slot-name new-value)
750  (let* ((class (class-of object))
751         (metaclass (class-of class)))
752    (if (or (eq metaclass +the-standard-class+)
753            (eq metaclass +the-structure-class+)
754            (eq metaclass +the-funcallable-standard-class+))
755        (setf (std-slot-value object slot-name) new-value)
756        (setf (slot-value-using-class class object
757                                      (find-slot-definition class slot-name))
758              new-value))))
759
760(defsetf slot-value %set-slot-value)
761
762(defun slot-boundp (object slot-name)
763  (let* ((class (class-of object))
764         (metaclass (class-of class)))
765    (if (or (eq metaclass +the-standard-class+) 
766            (eq metaclass +the-funcallable-standard-class+))
767        (std-slot-boundp object slot-name)
768        (slot-boundp-using-class class object
769                                 (find-slot-definition class slot-name)))))
770
771(defun std-slot-makunbound (instance slot-name)
772  (let ((location (instance-slot-location instance slot-name)))
773    (cond ((fixnump location)
774           (setf (standard-instance-access instance location) +slot-unbound+))
775          ((consp location)
776           (setf (cdr location) +slot-unbound+))
777          (t
778           (slot-missing (class-of instance) instance slot-name 'slot-makunbound))))
779  instance)
780
781(defun slot-makunbound (object slot-name)
782  (let* ((class (class-of object))
783         (metaclass (class-of class)))
784    (if (or (eq metaclass +the-standard-class+)
785            (eq metaclass +the-funcallable-standard-class+))
786        (std-slot-makunbound object slot-name)
787        (slot-makunbound-using-class class object
788                                     (find-slot-definition class slot-name)))))
789
790(defun std-slot-exists-p (instance slot-name)
791  (not (null (find slot-name (class-slots (class-of instance))
792                   :key 'slot-definition-name))))
793
794(defun slot-exists-p (object slot-name)
795  (if (eq (class-of (class-of object)) +the-standard-class+)
796      (std-slot-exists-p object slot-name)
797      (slot-exists-p-using-class (class-of object) object slot-name)))
798
799(defun instance-slot-p (slot)
800  (eq (slot-definition-allocation slot) :instance))
801
802(defun std-allocate-instance (class)
803  (sys::%std-allocate-instance class))
804
805(defun allocate-funcallable-instance (class)
806  (let ((instance (sys::%allocate-funcallable-instance class)))
807    (set-funcallable-instance-function
808     instance
809     #'(lambda (&rest args)
810         (declare (ignore args))
811         (error 'program-error "Called a funcallable-instance with unset function.")))
812    instance))
813
814(declaim (notinline class-prototype))
815(defun class-prototype (class)
816  (unless (class-finalized-p class) (error "Class ~A not finalized" (class-name class)))
817  (std-allocate-instance class))
818
819(defun make-instance-standard-class (metaclass
820                                     &rest initargs
821                                     &key name direct-superclasses direct-slots
822                                       direct-default-initargs
823                                       documentation)
824  (declare (ignore metaclass))
825  (let ((class (std-allocate-instance +the-standard-class+)))
826    (check-initargs (list #'allocate-instance #'initialize-instance)
827                    (list* class initargs)
828                    class t initargs
829                    *make-instance-initargs-cache* 'make-instance)
830    (%set-class-name name class)
831    (%set-class-layout nil class)
832    (%set-class-direct-subclasses ()  class)
833    (%set-class-direct-methods ()  class)
834    (%set-class-documentation class documentation)
835    (std-after-initialization-for-classes class
836                                          :direct-superclasses direct-superclasses
837                                          :direct-slots direct-slots
838                                          :direct-default-initargs direct-default-initargs)
839    class))
840
841;(defun convert-to-direct-slot-definition (class canonicalized-slot)
842;  (apply #'make-instance
843;         (apply #'direct-slot-definition-class
844;                class canonicalized-slot)
845;         canonicalized-slot))
846
847(defun std-after-initialization-for-classes (class
848                                             &key direct-superclasses direct-slots
849                                             direct-default-initargs
850                                             &allow-other-keys)
851  (let ((supers (cond (direct-superclasses)
852                      ((subtypep (class-of class)
853                                 +the-funcallable-standard-class+)
854                       (list +the-funcallable-standard-object-class+))
855                      ((subtypep (class-of class) +the-standard-class+)
856                       (list +the-standard-object-class+)))))
857    (setf (class-direct-superclasses class) supers)
858    (dolist (superclass supers)
859      (add-direct-subclass superclass class)))
860  (let ((slots (mapcar #'(lambda (slot-properties)
861                          (apply #'make-direct-slot-definition class slot-properties))
862                       direct-slots)))
863    (setf (class-direct-slots class) slots)
864    (dolist (direct-slot slots)
865      (dolist (reader (slot-definition-readers direct-slot))
866        (add-reader-method class reader direct-slot))
867      (dolist (writer (slot-definition-writers direct-slot))
868        (add-writer-method class writer direct-slot))))
869  (setf (class-direct-default-initargs class) direct-default-initargs)
870  (maybe-finalize-class-subtree class)
871  (values))
872
873(defun canonical-slot-name (canonical-slot)
874  (getf canonical-slot :name))
875
876(defvar *extensible-built-in-classes*
877  (list (find-class 'sequence)
878        (find-class 'java:java-object)))
879
880(defvar *make-instance-initargs-cache*
881  (make-hash-table :test #'eq)
882  "Cached sets of allowable initargs, keyed on the class they belong to.")
883(defvar *reinitialize-instance-initargs-cache*
884  (make-hash-table :test #'eq)
885  "Cached sets of allowable initargs, keyed on the class they belong to.")
886
887(defun expand-long-defcombin (name args)
888  (destructuring-bind (lambda-list method-groups &rest body) args
889    `(apply #'define-long-form-method-combination
890            ',name
891            ',lambda-list
892            (list ,@(mapcar #'canonicalize-method-group-spec method-groups))
893            ',body)))
894
895;;; The class method-combination and its subclasses are defined in
896;;; StandardClass.java, but we cannot use make-instance and slot-value
897;;; yet.
898
899(defun %make-long-method-combination (&key name documentation lambda-list
900                                       method-group-specs args-lambda-list
901                                       generic-function-symbol function
902                                       arguments declarations forms)
903  (let ((instance (std-allocate-instance (find-class 'long-method-combination))))
904    (setf (std-slot-value instance 'sys::name) name)
905    (setf (std-slot-value instance 'sys:%documentation) documentation)
906    (setf (std-slot-value instance 'sys::lambda-list) lambda-list)
907    (setf (std-slot-value instance 'method-group-specs) method-group-specs)
908    (setf (std-slot-value instance 'args-lambda-list) args-lambda-list)
909    (setf (std-slot-value instance 'generic-function-symbol)
910          generic-function-symbol)
911    (setf (std-slot-value instance 'function) function)
912    (setf (std-slot-value instance 'arguments) arguments)
913    (setf (std-slot-value instance 'declarations) declarations)
914    (setf (std-slot-value instance 'forms) forms)
915    (setf (std-slot-value instance 'options) nil)
916    instance))
917
918(defun method-combination-name (method-combination)
919  (check-type method-combination method-combination)
920  (std-slot-value method-combination 'sys::name))
921
922(defun method-combination-documentation (method-combination)
923  (check-type method-combination method-combination)
924  (std-slot-value method-combination 'sys:%documentation))
925
926(defun short-method-combination-operator (method-combination)
927  (check-type method-combination short-method-combination)
928  (std-slot-value method-combination 'operator))
929
930(defun short-method-combination-identity-with-one-argument (method-combination)
931  (check-type method-combination short-method-combination)
932  (std-slot-value method-combination 'identity-with-one-argument))
933
934(defun long-method-combination-lambda-list (method-combination)
935  (check-type method-combination long-method-combination)
936  (std-slot-value method-combination 'sys::lambda-list))
937
938(defun long-method-combination-method-group-specs (method-combination)
939  (check-type method-combination long-method-combination)
940  (std-slot-value method-combination 'method-group-specs))
941
942(defun long-method-combination-args-lambda-list (method-combination)
943  (check-type method-combination long-method-combination)
944  (std-slot-value method-combination 'args-lambda-list))
945
946(defun long-method-combination-generic-function-symbol (method-combination)
947  (check-type method-combination long-method-combination)
948  (std-slot-value method-combination 'generic-function-symbol))
949
950(defun long-method-combination-function (method-combination)
951  (check-type method-combination long-method-combination)
952  (std-slot-value method-combination 'function))
953
954(defun long-method-combination-arguments (method-combination)
955  (check-type method-combination long-method-combination)
956  (std-slot-value method-combination 'arguments))
957
958(defun long-method-combination-declarations (method-combination)
959  (check-type method-combination long-method-combination)
960  (std-slot-value method-combination 'declarations))
961
962(defun long-method-combination-forms (method-combination)
963  (check-type method-combination long-method-combination)
964  (std-slot-value method-combination 'forms))
965
966
967(defun expand-short-defcombin (whole)
968  (let* ((name (cadr whole))
969         (documentation
970          (getf (cddr whole) :documentation ""))
971         (identity-with-one-arg
972          (getf (cddr whole) :identity-with-one-argument nil))
973         (operator
974          (getf (cddr whole) :operator name)))
975    `(progn
976       ;; Class short-method-combination is defined in StandardClass.java.
977       (let ((instance (std-allocate-instance
978                        (find-class 'short-method-combination))))
979         (setf (std-slot-value instance 'sys::name) ',name)
980         (setf (std-slot-value instance 'sys:%documentation) ',documentation)
981         (setf (std-slot-value instance 'operator) ',operator)
982         (setf (std-slot-value instance 'identity-with-one-argument)
983               ',identity-with-one-arg)
984         (setf (std-slot-value instance 'options) nil)
985         (setf (get ',name 'method-combination-object) instance)
986         ',name))))
987
988(defmacro define-method-combination (&whole form name &rest args)
989  (if (and (cddr form)
990           (listp (caddr form)))
991      (expand-long-defcombin name args)
992      (expand-short-defcombin form)))
993
994(define-method-combination +      :identity-with-one-argument t)
995(define-method-combination and    :identity-with-one-argument t)
996(define-method-combination append :identity-with-one-argument nil)
997(define-method-combination list   :identity-with-one-argument nil)
998(define-method-combination max    :identity-with-one-argument t)
999(define-method-combination min    :identity-with-one-argument t)
1000(define-method-combination nconc  :identity-with-one-argument t)
1001(define-method-combination or     :identity-with-one-argument t)
1002(define-method-combination progn  :identity-with-one-argument t)
1003
1004;;;
1005;;; long form of define-method-combination (from Sacla and XCL)
1006;;;
1007(defun method-group-p (selecter qualifiers)
1008  ;; selecter::= qualifier-pattern | predicate
1009  (etypecase selecter
1010    (list (or (equal selecter qualifiers)
1011              (let ((last (last selecter)))
1012                (when (eq '* (cdr last))
1013                  (let* ((prefix `(,@(butlast selecter) ,(car last)))
1014                         (pos (mismatch prefix qualifiers)))
1015                    (or (null pos) (= pos (length prefix))))))))
1016    ((eql *) t)
1017    (symbol (funcall (symbol-function selecter) qualifiers))))
1018
1019(defun check-variable-name (name)
1020  (flet ((valid-variable-name-p (name)
1021                                (and (symbolp name) (not (constantp name)))))
1022    (assert (valid-variable-name-p name))))
1023
1024(defun canonicalize-method-group-spec (spec)
1025  ;; spec ::= (name {qualifier-pattern+ | predicate} [[long-form-option]])
1026  ;; long-form-option::= :description description | :order order |
1027  ;;                     :required required-p
1028  ;; a canonicalized-spec is a simple plist.
1029  (let* ((rest spec)
1030         (name (prog2 (check-variable-name (car rest))
1031                 (car rest)
1032                 (setq rest (cdr rest))))
1033         (option-names '(:description :order :required))
1034         (selecters (let ((end (or (position-if #'(lambda (it)
1035                                                   (member it option-names))
1036                                                rest)
1037                                   (length rest))))
1038                      (prog1 (subseq rest 0 end)
1039                        (setq rest (subseq rest end)))))
1040         (description (getf rest :description ""))
1041         (order (getf rest :order :most-specific-first))
1042         (required-p (getf rest :required)))
1043    `(list :name ',name
1044           :predicate (lambda (qualifiers)
1045                        (loop for item in ',selecters
1046                          thereis (method-group-p item qualifiers)))
1047           :description ',description
1048           :order ',order
1049           :required ',required-p
1050           :*-selecter ,(equal selecters '(*)))))
1051
1052(defun extract-required-part (lambda-list)
1053  (flet ((skip (key lambda-list)
1054               (if (eq (first lambda-list) key)
1055                   (cddr lambda-list)
1056                   lambda-list)))
1057    (ldiff (skip '&environment (skip '&whole lambda-list))
1058           (member-if #'(lambda (it) (member it lambda-list-keywords))
1059                      lambda-list))))
1060
1061(defun extract-specified-part (key lambda-list)
1062  (case key
1063    ((&eval &whole)
1064     (list (second (member key lambda-list))))
1065    (t
1066     (let ((here (cdr (member key lambda-list))))
1067       (ldiff here
1068              (member-if #'(lambda (it) (member it lambda-list-keywords))
1069                         here))))))
1070
1071(defun extract-optional-part (lambda-list)
1072  (extract-specified-part '&optional lambda-list))
1073
1074(defun parse-define-method-combination-arguments-lambda-list (lambda-list)
1075  ;; Define-method-combination Arguments Lambda Lists
1076  ;; http://www.lispworks.com/reference/HyperSpec/Body/03_dj.htm
1077  (let ((required (extract-required-part lambda-list))
1078        (whole    (extract-specified-part '&whole    lambda-list))
1079        (optional (extract-specified-part '&optional lambda-list))
1080        (rest     (extract-specified-part '&rest     lambda-list))
1081        (keys     (extract-specified-part '&key      lambda-list))
1082        (aux      (extract-specified-part '&aux      lambda-list)))
1083    (values (first whole)
1084            required
1085            (mapcar #'(lambda (spec)
1086                       (if (consp spec)
1087                           `(,(first spec) ,(second spec) ,@(cddr spec))
1088                           `(,spec nil)))
1089                    optional)
1090            (first rest)
1091            (mapcar #'(lambda (spec)
1092                       (let ((key (if (consp spec) (car spec) spec))
1093                             (rest (when (consp spec) (rest spec))))
1094                         `(,(if (consp key) key `(,(make-keyword key) ,key))
1095                           ,(car rest)
1096                           ,@(cdr rest))))
1097                    keys)
1098            (mapcar #'(lambda (spec)
1099                       (if (consp spec)
1100                           `(,(first spec) ,(second spec))
1101                           `(,spec nil)))
1102                    aux))))
1103
1104(defmacro getk (plist key init-form)
1105  "Similar to getf except eval and return INIT-FORM if KEY has no value in PLIST."
1106  (let ((not-exist (gensym))
1107        (value (gensym)))
1108    `(let ((,value (getf ,plist ,key ,not-exist)))
1109       (if (eq ,not-exist ,value) ,init-form ,value))))
1110
1111(defun wrap-with-call-method-macro (gf args-var forms)
1112  `(macrolet
1113       ((call-method (method &optional next-method-list)
1114          `(funcall
1115            ,(cond
1116              ((listp method)
1117               (assert (eq (first method) 'make-method))
1118               ;; by generating an inline expansion we prevent allocation
1119               ;; of a method instance which will be discarded immediately
1120               ;; after reading the METHOD-FUNCTION slot
1121               (compute-method-function
1122                    `(lambda (&rest ,(gensym))
1123                       ;; the MAKE-METHOD body form gets evaluated in
1124                       ;; the null lexical environment augmented
1125                       ;; with a binding for CALL-METHOD
1126                       ,(wrap-with-call-method-macro ,gf
1127                                                     ',args-var
1128                                                     (second method)))))
1129              (t (method-function method)))
1130            ,',args-var
1131            ,(unless (null next-method-list)
1132                     ;; by not generating an emf when there are no next methods,
1133                     ;; we ensure next-method-p returns NIL
1134                     (compute-effective-method
1135                      ,gf (generic-function-method-combination ,gf)
1136                      (process-next-method-list next-method-list))))))
1137     ,@forms))
1138
1139(defmacro with-args-lambda-list (args-lambda-list
1140                                 generic-function-symbol
1141                                 gf-args-symbol
1142                                 &body forms)
1143  (let ((gf-lambda-list (gensym))
1144        (nrequired (gensym))
1145        (noptional (gensym))
1146        (rest-args (gensym)))
1147    (multiple-value-bind (whole required optional rest keys aux)
1148        (parse-define-method-combination-arguments-lambda-list args-lambda-list)
1149      `(let* ((,gf-lambda-list (slot-value ,generic-function-symbol 'sys::lambda-list))
1150              (,nrequired (length (extract-required-part ,gf-lambda-list)))
1151              (,noptional (length (extract-optional-part ,gf-lambda-list)))
1152              (,rest-args (subseq ,gf-args-symbol (+ ,nrequired ,noptional)))
1153              ,@(when whole `((,whole ,gf-args-symbol)))
1154              ,@(loop for var in required and i upfrom 0
1155                  collect `(,var (when (< ,i ,nrequired)
1156                                   (nth ,i ,gf-args-symbol))))
1157              ,@(loop for (var init-form) in optional and i upfrom 0
1158                  collect
1159                  `(,var (if (< ,i ,noptional)
1160                             (nth (+ ,nrequired ,i) ,gf-args-symbol)
1161                             ,init-form)))
1162              ,@(when rest `((,rest ,rest-args)))
1163              ,@(loop for ((key var) init-form) in keys and i upfrom 0
1164                  collect `(,var (getk ,rest-args ',key ,init-form)))
1165              ,@(loop for (var init-form) in aux and i upfrom 0
1166                  collect `(,var ,init-form)))
1167         ,@forms))))
1168
1169(defun assert-unambiguous-method-sorting (group-name methods)
1170  (let ((specializers (make-hash-table :test 'equal)))
1171    (dolist (method methods)
1172      (push method (gethash (method-specializers method) specializers)))
1173    (loop for specializer-methods being each hash-value of specializers
1174       using (hash-key method-specializers)
1175       unless (= 1 (length specializer-methods))
1176       do (error "Ambiguous method sorting in method group ~A due to multiple ~
1177                  methods with specializers ~S: ~S"
1178                 group-name method-specializers specializer-methods))))
1179
1180(defmacro with-method-groups (method-group-specs methods-form &body forms)
1181  (flet ((grouping-form (spec methods-var)
1182           (let ((predicate (coerce-to-function (getf spec :predicate)))
1183                 (group (gensym))
1184                 (leftovers (gensym))
1185                 (method (gensym)))
1186             `(let ((,group '())
1187                    (,leftovers '()))
1188                (dolist (,method ,methods-var)
1189                  (if (funcall ,predicate (method-qualifiers ,method))
1190                      (push ,method ,group)
1191                      (push ,method ,leftovers)))
1192                (ecase ,(getf spec :order)
1193                  (:most-specific-last )
1194                  (:most-specific-first (setq ,group (nreverse ,group))))
1195                ,@(when (getf spec :required)
1196                        `((when (null ,group)
1197                            (error "Method group ~S must not be empty."
1198                                   ',(getf spec :name)))))
1199                (setq ,methods-var (nreverse ,leftovers))
1200                ,group))))
1201    (let ((rest (gensym))
1202          (method (gensym)))
1203      `(let* ((,rest ,methods-form)
1204              ,@(mapcar #'(lambda (spec)
1205                           `(,(getf spec :name) ,(grouping-form spec rest)))
1206                        method-group-specs))
1207         (dolist (,method ,rest)
1208           (invalid-method-error ,method
1209                                 "Method ~S with qualifiers ~S does not belong to any method group."
1210                                 ,method (method-qualifiers ,method)))
1211         ,@(unless (and (= 1 (length method-group-specs))
1212                        (getf (car method-group-specs) :*-selecter))
1213             (mapcar #'(lambda (spec)
1214                         `(assert-unambiguous-method-sorting ',(getf spec :name) ,(getf spec :name)))
1215                     method-group-specs))
1216         ,@forms))))
1217
1218(defun method-combination-type-lambda
1219  (&key name lambda-list args-lambda-list generic-function-symbol
1220        method-group-specs declarations forms &allow-other-keys)
1221  (declare (ignore name))
1222  (let ((methods (gensym))
1223        (args-var (gensym)))
1224    `(lambda (,generic-function-symbol ,methods ,@lambda-list)
1225       ,@declarations
1226       (with-method-groups ,method-group-specs
1227           ,methods
1228         ,(if (null args-lambda-list)
1229              `(let ((result (progn ,@forms)))
1230                 `(lambda (,',args-var)
1231                    ,(wrap-with-call-method-macro ,generic-function-symbol
1232                                                  ',args-var (list result))))
1233              `(lambda (,args-var)
1234                 (let* ((result
1235                         (with-args-lambda-list ,args-lambda-list
1236                             ,generic-function-symbol ,args-var
1237                           ,@forms))
1238                        (function
1239                         `(lambda (,',args-var) ;; ugly: we're reusing it
1240                          ;; to prevent calling gensym on every EMF invocation
1241                          ,(wrap-with-call-method-macro ,generic-function-symbol
1242                                                        ',args-var
1243                                                        (list result)))))
1244                   (funcall function ,args-var))))))))
1245
1246(defun declarationp (expr)
1247  (and (consp expr) (eq (car expr) 'DECLARE)))
1248
1249(defun long-form-method-combination-args (args)
1250  ;; define-method-combination name lambda-list (method-group-specifier*) args
1251  ;; args ::= [(:arguments . args-lambda-list)]
1252  ;;          [(:generic-function generic-function-symbol)]
1253  ;;          [[declaration* | documentation]] form*
1254  (let ((rest args))
1255    (labels ((nextp (key) (and (consp (car rest)) (eq key (caar rest))))
1256             (args-lambda-list ()
1257               (when (nextp :arguments)
1258                 (prog1 (cdr (car rest)) (setq rest (cdr rest)))))
1259             (generic-function-symbol ()
1260                (if (nextp :generic-function)
1261                    (prog1 (second (car rest)) (setq rest (cdr rest)))
1262                    (gensym)))
1263             (declaration* ()
1264               (let ((end (position-if-not #'declarationp rest)))
1265                 (when end
1266                   (prog1 (subseq rest 0 end) (setq rest (nthcdr end rest))))))
1267             (documentation? ()
1268               (when (stringp (car rest))
1269                 (prog1 (car rest) (setq rest (cdr rest)))))
1270             (form* () rest))
1271      (let ((declarations '()))
1272        `(:args-lambda-list ,(args-lambda-list)
1273                            :generic-function-symbol ,(generic-function-symbol)
1274                            :documentation ,(prog2 (setq declarations (declaration*))
1275                                              (documentation?))
1276                            :declarations (,@declarations ,@(declaration*))
1277                            :forms ,(form*))))))
1278
1279(defun define-long-form-method-combination (name lambda-list method-group-specs
1280                                                 &rest args)
1281  (let* ((initargs `(:name ,name
1282                     :lambda-list ,lambda-list
1283                     :method-group-specs ,method-group-specs
1284                     ,@(long-form-method-combination-args args)))
1285         (lambda-expression (apply #'method-combination-type-lambda initargs)))
1286    (setf (get name 'method-combination-object)
1287          (apply '%make-long-method-combination
1288                 :function (coerce-to-function lambda-expression) initargs))
1289    name))
1290
1291(defun std-find-method-combination (gf name options)
1292  (declare (ignore gf))
1293  (when (and (eql name 'standard) options)
1294    ;; CLHS DEFGENERIC
1295    (error "The standard method combination does not accept any arguments."))
1296  (let ((mc (get name 'method-combination-object)))
1297    (cond
1298      ((null mc) (error "Method combination ~S not found" name))
1299      ((null options) mc)
1300      ((typep mc 'short-method-combination)
1301       (make-instance
1302        'short-method-combination
1303        :name name
1304        :documentation (method-combination-documentation mc)
1305        :operator (short-method-combination-operator mc)
1306        :identity-with-one-argument
1307        (short-method-combination-identity-with-one-argument mc)
1308        :options options))
1309      ((typep mc 'long-method-combination)
1310       (make-instance
1311        'long-method-combination
1312        :name name
1313        :documentation (method-combination-documentation mc)
1314        :lambda-list (long-method-combination-lambda-list mc)
1315        :method-group-specs (long-method-combination-method-group-specs mc)
1316        :args-lambda-list (long-method-combination-args-lambda-list mc)
1317        :generic-function-symbol (long-method-combination-generic-function-symbol mc)
1318        :function (long-method-combination-function mc)
1319        :arguments (long-method-combination-arguments mc)
1320        :declarations (long-method-combination-declarations mc)
1321        :forms (long-method-combination-forms mc)
1322        :options options)))))
1323
1324(declaim (notinline find-method-combination))
1325(defun find-method-combination (gf name options)
1326  (std-find-method-combination gf name options))
1327
1328(defconstant +the-standard-method-combination+
1329  (let ((instance (std-allocate-instance (find-class 'method-combination))))
1330    (setf (std-slot-value instance 'sys::name) 'standard)
1331    (setf (std-slot-value instance 'sys:%documentation)
1332          "The standard method combination.")
1333    (setf (std-slot-value instance 'options) nil)
1334    instance)
1335  "The standard method combination.
1336Do not use this object for identity since it changes between
1337compile-time and run-time.  To detect the standard method combination,
1338compare the method combination name to the symbol 'standard.")
1339(setf (get 'standard 'method-combination-object) +the-standard-method-combination+)
1340
1341(defparameter *eql-specializer-table* (make-hash-table :test 'eql))
1342
1343(defun intern-eql-specializer (object)
1344  (or (gethash object *eql-specializer-table*)
1345      (setf (gethash object *eql-specializer-table*)
1346            ;; we will be called during generic function invocation
1347            ;; setup, so have to rely on plain functions here.
1348            (let ((instance (std-allocate-instance (find-class 'eql-specializer))))
1349              (setf (std-slot-value instance 'sys::object) object)
1350              (setf (std-slot-value instance 'direct-methods) nil)
1351              instance))))
1352
1353(defun eql-specializer-object (eql-specializer)
1354  (check-type eql-specializer eql-specializer)
1355  (std-slot-value eql-specializer 'sys::object))
1356
1357;;; Initial versions of some method metaobject readers.  Defined on
1358;;; AMOP pg. 218ff, will be redefined when generic functions are set up.
1359
1360(defun std-method-function (method)
1361  (std-slot-value method 'sys::%function))
1362
1363(defun std-method-generic-function (method)
1364  (std-slot-value method 'sys::%generic-function))
1365
1366(defun std-method-specializers (method)
1367  (std-slot-value method 'sys::specializers))
1368
1369(defun std-method-qualifiers (method)
1370  (std-slot-value method 'sys::qualifiers))
1371
1372(defun std-accessor-method-slot-definition (accessor-method)
1373  (std-slot-value accessor-method 'sys::%slot-definition))
1374
1375;;; Additional method readers
1376(defun std-method-fast-function (method)
1377  (std-slot-value method 'sys::fast-function))
1378
1379(defun std-function-keywords (method)
1380  (values (std-slot-value method 'sys::keywords)
1381          (std-slot-value method 'sys::other-keywords-p)))
1382
1383;;; Preliminary accessor definitions, will be redefined as generic
1384;;; functions later in this file
1385
1386(declaim (notinline method-generic-function))
1387(defun method-generic-function (method)
1388  (std-method-generic-function method))
1389
1390(declaim (notinline method-function))
1391(defun method-function (method)
1392  (std-method-function method))
1393
1394(declaim (notinline method-specializers))
1395(defun method-specializers (method)
1396  (std-method-specializers method))
1397
1398(declaim (notinline method-qualifiers))
1399(defun method-qualifiers (method)
1400  (std-method-qualifiers method))
1401
1402
1403
1404;; MOP (p. 216) specifies the following reader generic functions:
1405;;   generic-function-argument-precedence-order
1406;;   generic-function-declarations
1407;;   generic-function-lambda-list
1408;;   generic-function-method-class
1409;;   generic-function-method-combination
1410;;   generic-function-methods
1411;;   generic-function-name
1412
1413;;; These are defined with % in package SYS, defined as functions here
1414;;; and redefined as generic functions once we're all set up.
1415
1416(defun generic-function-lambda-list (gf)
1417  (%generic-function-lambda-list gf))
1418(defsetf generic-function-lambda-list %set-generic-function-lambda-list)
1419
1420(defun (setf generic-function-documentation) (new-value gf)
1421  (set-generic-function-documentation gf new-value))
1422
1423(defun (setf generic-function-initial-methods) (new-value gf)
1424  (set-generic-function-initial-methods gf new-value))
1425
1426(defun generic-function-methods (gf)
1427  (sys:%generic-function-methods gf))
1428(defun (setf generic-function-methods) (new-value gf)
1429  (set-generic-function-methods gf new-value))
1430
1431(defun generic-function-method-class (gf)
1432  (sys:%generic-function-method-class gf))
1433(defun (setf generic-function-method-class) (new-value gf)
1434  (set-generic-function-method-class gf new-value))
1435
1436(defun generic-function-method-combination (gf)
1437  (sys:%generic-function-method-combination gf))
1438(defun (setf generic-function-method-combination) (new-value gf)
1439  (assert (typep new-value 'method-combination))
1440  (set-generic-function-method-combination gf new-value))
1441
1442(defun generic-function-argument-precedence-order (gf)
1443  (sys:%generic-function-argument-precedence-order gf))
1444(defun (setf generic-function-argument-precedence-order) (new-value gf)
1445  (set-generic-function-argument-precedence-order gf new-value))
1446
1447(declaim (ftype (function * t) classes-to-emf-table))
1448(defun classes-to-emf-table (gf)
1449  (generic-function-classes-to-emf-table gf))
1450
1451(defun (setf classes-to-emf-table) (new-value gf)
1452  (set-generic-function-classes-to-emf-table gf new-value))
1453
1454(defun (setf method-lambda-list) (new-value method)
1455  (setf (std-slot-value method 'sys::lambda-list) new-value))
1456
1457(defun (setf method-qualifiers) (new-value method)
1458  (setf (std-slot-value method 'sys::qualifiers) new-value))
1459
1460(defun method-documentation (method)
1461  (std-slot-value method 'sys:%documentation))
1462
1463(defun (setf method-documentation) (new-value method)
1464  (setf (std-slot-value method 'sys:%documentation) new-value))
1465
1466;;; defgeneric
1467
1468(defmacro defgeneric (function-name lambda-list
1469                                    &rest options-and-method-descriptions)
1470  (let ((options ())
1471        (methods ())
1472        (declarations ())
1473        (documentation nil))
1474    (dolist (item options-and-method-descriptions)
1475      (case (car item)
1476        (declare
1477         (setf declarations (append declarations (cdr item))))
1478        (:documentation
1479         (when documentation
1480           (error 'program-error
1481                  :format-control "Documentation option was specified twice for generic function ~S."
1482                  :format-arguments (list function-name)))
1483         (setf documentation t)
1484         (push item options))
1485        (:method
1486         (push
1487          `(push (defmethod ,function-name ,@(cdr item))
1488                 (generic-function-initial-methods (fdefinition ',function-name)))
1489          methods))
1490        (t
1491         (push item options))))
1492    (when declarations (push (list :declarations declarations) options))
1493    (setf options (nreverse options)
1494          methods (nreverse methods))
1495    ;;; Since DEFGENERIC currently shares its argument parsing with
1496    ;;; DEFMETHOD, we perform this check here.
1497    (when (find '&aux lambda-list)
1498      (error 'program-error
1499             :format-control "&AUX is not allowed in a generic function lambda list: ~S"
1500             :format-arguments (list lambda-list)))
1501    `(prog1
1502       (%defgeneric
1503        ',function-name
1504        :lambda-list ',lambda-list
1505        ,@(canonicalize-defgeneric-options options))
1506       ,@methods)))
1507
1508(defun canonicalize-defgeneric-options (options)
1509  (mapappend #'canonicalize-defgeneric-option options))
1510
1511(defun canonicalize-defgeneric-option (option)
1512  (case (car option)
1513    (:generic-function-class
1514     (list :generic-function-class `(find-class ',(cadr option))))
1515    (:method-class
1516     (list :method-class `(find-class ',(cadr option))))
1517    (:method-combination
1518     (list :method-combination `',(cdr option)))
1519    (:argument-precedence-order
1520     (list :argument-precedence-order `',(cdr option)))
1521    (t
1522     (list `',(car option) `',(cadr option)))))
1523
1524;; From OpenMCL (called canonicalize-argument-precedence-order there,
1525;; but AMOP specifies argument-precedence-order to return a permutation
1526;; of the required arguments, not a list of indices, so we calculate
1527;; them on demand).
1528(defun argument-precedence-order-indices (apo req)
1529  (cond ((equal apo req) nil)
1530        ((not (eql (length apo) (length req)))
1531         (error 'program-error
1532                :format-control "Specified argument precedence order ~S does not match lambda list."
1533                :format-arguments (list apo)))
1534        (t (let ((res nil))
1535             (dolist (arg apo (nreverse res))
1536               (let ((index (position arg req)))
1537                 (if (or (null index) (memq index res))
1538                     (error 'program-error
1539                            :format-control "Specified argument precedence order ~S does not match lambda list."
1540                            :format-arguments (list apo)))
1541                 (push index res)))))))
1542
1543(defun find-generic-function (name &optional (errorp t))
1544  (let ((function (and (fboundp name) (fdefinition name))))
1545    (when function
1546      (when (typep function 'generic-function)
1547        (return-from find-generic-function function))
1548      (when (and *traced-names* (find name *traced-names* :test #'equal))
1549        (setf function (untraced-function name))
1550        (when (typep function 'generic-function)
1551          (return-from find-generic-function function)))))
1552  (if errorp
1553      (error "There is no generic function named ~S." name)
1554      nil))
1555
1556(defun lambda-lists-congruent-p (lambda-list1 lambda-list2)
1557  (let* ((plist1 (analyze-lambda-list lambda-list1))
1558         (args1 (getf plist1 :required-args))
1559         (plist2 (analyze-lambda-list lambda-list2))
1560         (args2 (getf plist2 :required-args)))
1561    (= (length args1) (length args2))))
1562
1563(defun %defgeneric (function-name &rest all-keys)
1564  (when (fboundp function-name)
1565    (let ((gf (fdefinition function-name)))
1566      (when (typep gf 'generic-function)
1567        ;; Remove methods defined by previous DEFGENERIC forms, as
1568        ;; specified by CLHS, 7.7 (Macro DEFGENERIC).
1569        (dolist (method (generic-function-initial-methods gf))
1570          (if (typep gf 'standard-generic-function)
1571              (progn
1572                (std-remove-method gf method)
1573                (map-dependents gf
1574                                #'(lambda (dep)
1575                                    (update-dependent gf dep
1576                                                      'remove-method method))))
1577              (remove-method gf method)))
1578        (setf (generic-function-initial-methods gf) '()))))
1579  (apply 'ensure-generic-function function-name all-keys))
1580
1581;;; Bootstrap version of ensure-generic-function, handling only
1582;;; standard-generic-function.  This function is replaced later.
1583(declaim (notinline ensure-generic-function))
1584(defun ensure-generic-function (function-name
1585                                &rest all-keys
1586                                &key
1587                                lambda-list
1588                                (generic-function-class +the-standard-generic-function-class+)
1589                                (method-class +the-standard-method-class+)
1590                                (method-combination +the-standard-method-combination+ mc-p)
1591                                argument-precedence-order
1592                                documentation
1593                                &allow-other-keys)
1594  (when (autoloadp function-name)
1595    (resolve function-name))
1596  (setf all-keys (copy-list all-keys))  ; since we modify it
1597  (remf all-keys :generic-function-class)
1598  (let ((gf (find-generic-function function-name nil)))
1599    (if gf
1600        (progn
1601          (unless (or (null (generic-function-methods gf))
1602                      (lambda-lists-congruent-p lambda-list (generic-function-lambda-list gf)))
1603            (error 'simple-error
1604                   :format-control "The lambda list ~S is incompatible with the existing methods of ~S."
1605                   :format-arguments (list lambda-list gf)))
1606          (setf (generic-function-lambda-list gf) lambda-list)
1607          (setf (generic-function-documentation gf) documentation)
1608          (let* ((plist (analyze-lambda-list lambda-list))
1609                 (required-args (getf plist ':required-args)))
1610            (%set-gf-required-args gf required-args)
1611            (%set-gf-optional-args gf (getf plist :optional-args))
1612            (setf (generic-function-argument-precedence-order gf)
1613                  (or argument-precedence-order required-args))
1614            (finalize-standard-generic-function gf))
1615          gf)
1616        (progn
1617          (when (and (null *clos-booting*)
1618                     (fboundp function-name))
1619            (error 'program-error
1620                   :format-control "~A already names an ordinary function, macro, or special operator."
1621                   :format-arguments (list function-name)))
1622          (when mc-p
1623            (error "Preliminary ensure-method does not support :method-combination argument."))
1624          (setf gf (apply (if (eq generic-function-class +the-standard-generic-function-class+)
1625                              #'make-instance-standard-generic-function
1626                              #'make-instance)
1627                          generic-function-class
1628                          :name function-name
1629                          :method-class method-class
1630                          :method-combination method-combination
1631                          all-keys))
1632          gf))))
1633
1634(defun collect-eql-specializer-objects (generic-function)
1635  (let ((result nil))
1636    (dolist (method (generic-function-methods generic-function))
1637      (dolist (specializer (method-specializers method))
1638        (when (typep specializer 'eql-specializer)
1639          (pushnew (eql-specializer-object specializer)
1640                   result
1641                   :test 'eql))))
1642    result))
1643
1644(defun finalize-standard-generic-function (gf)
1645  (%finalize-generic-function gf)
1646  (unless (generic-function-classes-to-emf-table gf)
1647    (set-generic-function-classes-to-emf-table gf (make-hash-table :test #'equal)))
1648  (clrhash (generic-function-classes-to-emf-table gf))
1649  (%init-eql-specializations gf (collect-eql-specializer-objects gf))
1650  (set-funcallable-instance-function
1651   gf
1652   (if (eq (class-of gf) +the-standard-generic-function-class+)
1653       (std-compute-discriminating-function gf)
1654       (compute-discriminating-function gf)))
1655  ;; FIXME Do we need to warn on redefinition somewhere else?
1656  (let ((*warn-on-redefinition* nil))
1657    (setf (fdefinition (%generic-function-name gf)) gf))
1658  (values))
1659
1660(defun make-instance-standard-generic-function (generic-function-class
1661                                                &key name lambda-list
1662                                                method-class
1663                                                method-combination
1664                                                argument-precedence-order
1665                                                declarations
1666                                                documentation)
1667  ;; to avoid circularities, we do not call generic functions in here.
1668  (declare (ignore generic-function-class))
1669  (check-argument-precedence-order lambda-list argument-precedence-order)
1670  (let ((gf (std-allocate-instance +the-standard-generic-function-class+)))
1671    (%set-generic-function-name gf name)
1672    (%set-generic-function-lambda-list gf lambda-list)
1673    (set-generic-function-initial-methods gf ())
1674    (set-generic-function-methods gf ())
1675    (set-generic-function-method-class gf method-class)
1676    (set-generic-function-method-combination gf method-combination)
1677    (set-generic-function-declarations gf declarations)
1678    (set-generic-function-documentation gf documentation)
1679    (set-generic-function-classes-to-emf-table gf nil)
1680    (let* ((plist (analyze-lambda-list (generic-function-lambda-list gf)))
1681           (required-args (getf plist ':required-args)))
1682      (%set-gf-required-args gf required-args)
1683      (%set-gf-optional-args gf (getf plist :optional-args))
1684      (set-generic-function-argument-precedence-order
1685       gf (or argument-precedence-order required-args)))
1686    (finalize-standard-generic-function gf)
1687    gf))
1688
1689(defun canonicalize-specializers (specializers)
1690  (mapcar #'canonicalize-specializer specializers))
1691
1692(defun canonicalize-specializer (specializer)
1693  (cond ((classp specializer)
1694         specializer)
1695        ((typep specializer 'eql-specializer)
1696         specializer)
1697        ((symbolp specializer)
1698         (find-class specializer))
1699        ((and (consp specializer)
1700              (eq (car specializer) 'eql))
1701         (let ((object (cadr specializer)))
1702           (when (and (consp object)
1703                      (eq (car object) 'quote))
1704             (setf object (cadr object)))
1705           (intern-eql-specializer object)))
1706        ((and (consp specializer)
1707              (eq (car specializer) 'java:jclass))
1708         (let ((jclass (eval specializer)))
1709           (java::ensure-java-class jclass)))
1710        (t
1711         (error "Unknown specializer: ~S" specializer))))
1712
1713(defun parse-defmethod (args)
1714  (let ((function-name (car args))
1715        (qualifiers ())
1716        (specialized-lambda-list ())
1717        (body ())
1718        (parse-state :qualifiers))
1719    (dolist (arg (cdr args))
1720      (ecase parse-state
1721        (:qualifiers
1722         (if (and (atom arg) (not (null arg)))
1723             (push arg qualifiers)
1724             (progn
1725               (setf specialized-lambda-list arg)
1726               (setf parse-state :body))))
1727        (:body (push arg body))))
1728    (setf qualifiers (nreverse qualifiers)
1729          body (nreverse body))
1730    (multiple-value-bind (real-body declarations documentation)
1731        (parse-body body)
1732      (values function-name
1733              qualifiers
1734              (extract-lambda-list specialized-lambda-list)
1735              (extract-specializer-names specialized-lambda-list)
1736              documentation
1737              declarations
1738              (list* 'block
1739                     (fdefinition-block-name function-name)
1740                     real-body)))))
1741
1742(defun required-portion (gf args)
1743  (let ((number-required (length (gf-required-args gf))))
1744    (when (< (length args) number-required)
1745      (error 'program-error
1746             :format-control "Not enough arguments for generic function ~S."
1747             :format-arguments (list (%generic-function-name gf))))
1748    (subseq args 0 number-required)))
1749
1750(defun extract-lambda-list (specialized-lambda-list)
1751  (let* ((plist (analyze-lambda-list specialized-lambda-list))
1752         (requireds (getf plist :required-names))
1753         (rv (getf plist :rest-var))
1754         (ks (getf plist :key-args))
1755         (keysp (getf plist :keysp))
1756         (aok (getf plist :allow-other-keys))
1757         (opts (getf plist :optional-args))
1758         (auxs (getf plist :auxiliary-args)))
1759    `(,@requireds
1760      ,@(if rv `(&rest ,rv) ())
1761      ,@(if (or ks keysp aok) `(&key ,@ks) ())
1762      ,@(if aok '(&allow-other-keys) ())
1763      ,@(if opts `(&optional ,@opts) ())
1764      ,@(if auxs `(&aux ,@auxs) ()))))
1765
1766(defun extract-specializer-names (specialized-lambda-list)
1767  (let ((plist (analyze-lambda-list specialized-lambda-list)))
1768    (getf plist ':specializers)))
1769
1770(defun get-keyword-from-arg (arg)
1771  (if (listp arg)
1772      (if (listp (car arg))
1773          (caar arg)
1774          (make-keyword (car arg)))
1775      (make-keyword arg)))
1776
1777(defun analyze-lambda-list (lambda-list)
1778  (let ((keys ())           ; Just the keywords
1779        (key-args ())       ; Keywords argument specs
1780        (keysp nil)         ;
1781        (required-names ()) ; Just the variable names
1782        (required-args ())  ; Variable names & specializers
1783        (specializers ())   ; Just the specializers
1784        (rest-var nil)
1785        (optionals ())
1786        (auxs ())
1787        (allow-other-keys nil)
1788        (state :parsing-required))
1789    (dolist (arg lambda-list)
1790      (if (member arg lambda-list-keywords)
1791          (ecase arg
1792            (&optional
1793             (setq state :parsing-optional))
1794            (&rest
1795             (setq state :parsing-rest))
1796            (&key
1797             (setq keysp t)
1798             (setq state :parsing-key))
1799            (&allow-other-keys
1800             (setq allow-other-keys 't))
1801            (&aux
1802             (setq state :parsing-aux)))
1803          (case state
1804            (:parsing-required
1805             (push-on-end arg required-args)
1806             (if (listp arg)
1807                 (progn (push-on-end (car arg) required-names)
1808                   (push-on-end (cadr arg) specializers))
1809                 (progn (push-on-end arg required-names)
1810                   (push-on-end 't specializers))))
1811            (:parsing-optional (push-on-end arg optionals))
1812            (:parsing-rest (setq rest-var arg))
1813            (:parsing-key
1814             (push-on-end (get-keyword-from-arg arg) keys)
1815             (push-on-end arg key-args))
1816            (:parsing-aux (push-on-end arg auxs)))))
1817    (list  :required-names required-names
1818           :required-args required-args
1819           :specializers specializers
1820           :rest-var rest-var
1821           :keywords keys
1822           :key-args key-args
1823           :keysp keysp
1824           :auxiliary-args auxs
1825           :optional-args optionals
1826           :allow-other-keys allow-other-keys)))
1827
1828#+nil
1829(defun check-method-arg-info (gf arg-info method)
1830  (multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
1831      (analyze-lambda-list (if (consp method)
1832                               (early-method-lambda-list method)
1833                               (method-lambda-list method)))
1834    (flet ((lose (string &rest args)
1835                 (error 'simple-program-error
1836                        :format-control "~@<attempt to add the method~2I~_~S~I~_~
1837                        to the generic function~2I~_~S;~I~_~
1838                        but ~?~:>"
1839                        :format-arguments (list method gf string args)))
1840           (comparison-description (x y)
1841                                   (if (> x y) "more" "fewer")))
1842      (let ((gf-nreq (arg-info-number-required arg-info))
1843            (gf-nopt (arg-info-number-optional arg-info))
1844            (gf-key/rest-p (arg-info-key/rest-p arg-info))
1845            (gf-keywords (arg-info-keys arg-info)))
1846        (unless (= nreq gf-nreq)
1847          (lose
1848           "the method has ~A required arguments than the generic function."
1849           (comparison-description nreq gf-nreq)))
1850        (unless (= nopt gf-nopt)
1851          (lose
1852           "the method has ~A optional arguments than the generic function."
1853           (comparison-description nopt gf-nopt)))
1854        (unless (eq (or keysp restp) gf-key/rest-p)
1855          (lose
1856           "the method and generic function differ in whether they accept~_~
1857            &REST or &KEY arguments."))
1858        (when (consp gf-keywords)
1859          (unless (or (and restp (not keysp))
1860                      allow-other-keys-p
1861                      (every (lambda (k) (memq k keywords)) gf-keywords))
1862            (lose "the method does not accept each of the &KEY arguments~2I~_~
1863            ~S."
1864                  gf-keywords)))))))
1865
1866(defun check-method-lambda-list (name method-lambda-list gf-lambda-list)
1867  (let* ((gf-restp (not (null (memq '&rest gf-lambda-list))))
1868         (gf-plist (analyze-lambda-list gf-lambda-list))
1869         (gf-keysp (getf gf-plist :keysp))
1870         (gf-keywords (getf gf-plist :keywords))
1871         (method-plist (analyze-lambda-list method-lambda-list))
1872         (method-restp (not (null (memq '&rest method-lambda-list))))
1873         (method-keysp (getf method-plist :keysp))
1874         (method-keywords (getf method-plist :keywords))
1875         (method-allow-other-keys-p (getf method-plist :allow-other-keys)))
1876    (unless (= (length (getf gf-plist :required-args))
1877               (length (getf method-plist :required-args)))
1878      (error "The method-lambda-list ~S ~
1879              has the wrong number of required arguments ~
1880              for the generic function ~S." method-lambda-list name))
1881    (unless (= (length (getf gf-plist :optional-args))
1882               (length (getf method-plist :optional-args)))
1883      (error "The method-lambda-list ~S ~
1884              has the wrong number of optional arguments ~
1885              for the generic function ~S." method-lambda-list name))
1886    (unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
1887      (error "The method-lambda-list ~S ~
1888              and the generic function ~S ~
1889              differ in whether they accept &REST or &KEY arguments."
1890             method-lambda-list name))
1891    (when (consp gf-keywords)
1892      (unless (or (and method-restp (not method-keysp))
1893                  method-allow-other-keys-p
1894                  (every (lambda (k) (memq k method-keywords)) gf-keywords))
1895        (error "The method-lambda-list ~S does not accept ~
1896                all of the keyword arguments defined for the ~
1897                generic function." method-lambda-list name)))))
1898
1899(defun check-argument-precedence-order (lambda-list argument-precedence-order)
1900  (when argument-precedence-order
1901    (if lambda-list
1902        ;; raising the required program-errors is a side-effect of
1903        ;; calculating the given permutation of apo vs req
1904        (argument-precedence-order-indices
1905         argument-precedence-order
1906         (getf (analyze-lambda-list lambda-list) :required-args))
1907        ;; AMOP pg. 198
1908        (error 'program-error "argument precedence order specified without lambda list"))))
1909
1910(defvar *gf-initialize-instance* nil
1911  "Cached value of the INITIALIZE-INSTANCE generic function.
1912Initialized with the true value near the end of the file.")
1913(defvar *gf-allocate-instance* nil
1914  "Cached value of the ALLOCATE-INSTANCE generic function.
1915Initialized with the true value near the end of the file.")
1916(defvar *gf-shared-initialize* nil
1917  "Cached value of the SHARED-INITIALIZE generic function.
1918Initialized with the true value near the end of the file.")
1919(defvar *gf-reinitialize-instance* nil
1920  "Cached value of the REINITIALIZE-INSTANCE generic function.
1921Initialized with the true value near the end of the file.")
1922
1923(declaim (ftype (function * method) ensure-method))
1924(defun ensure-method (name &rest all-keys)
1925  (let ((method-lambda-list (getf all-keys :lambda-list))
1926        (gf (find-generic-function name nil)))
1927    (when (or (eq gf *gf-initialize-instance*)
1928              (eq gf *gf-allocate-instance*)
1929              (eq gf *gf-shared-initialize*)
1930              (eq gf *gf-reinitialize-instance*))
1931      ;; ### Clearly, this can be targeted much more exact
1932      ;; as we only need to remove the specializing class and all
1933      ;; its subclasses from the hash.
1934      (clrhash *make-instance-initargs-cache*)
1935      (clrhash *reinitialize-instance-initargs-cache*))
1936    (if gf
1937        (check-method-lambda-list name method-lambda-list
1938                                  (generic-function-lambda-list gf))
1939        (setf gf (ensure-generic-function name :lambda-list method-lambda-list)))
1940    (let ((method
1941           (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1942               (apply #'make-instance-standard-method gf all-keys)
1943               (apply #'make-instance (generic-function-method-class gf) all-keys))))
1944      (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1945          (progn
1946            (std-add-method gf method)
1947            (map-dependents gf
1948                            #'(lambda (dep)
1949                                (update-dependent gf dep 'add-method method))))
1950          (add-method gf method))
1951      method)))
1952
1953(defun make-instance-standard-method (gf
1954                                      &key
1955                                      lambda-list
1956                                      qualifiers
1957                                      specializers
1958                                      documentation
1959                                      function
1960                                      fast-function)
1961  (declare (ignore gf))
1962  (let ((method (std-allocate-instance +the-standard-method-class+))
1963        (analyzed-args (analyze-lambda-list lambda-list)))
1964    (setf (method-lambda-list method) lambda-list)
1965    (setf (method-qualifiers method) qualifiers)
1966    (setf (std-slot-value method 'sys::specializers)
1967          (canonicalize-specializers specializers))
1968    (setf (method-documentation method) documentation)
1969    (setf (std-slot-value method 'sys::%generic-function) nil) ; set by add-method
1970    (setf (std-slot-value method 'sys::%function) function)
1971    (setf (std-slot-value method 'sys::fast-function) fast-function)
1972    (setf (std-slot-value method 'sys::keywords) (getf analyzed-args :keywords))
1973    (setf (std-slot-value method 'sys::other-keywords-p)
1974          (getf analyzed-args :allow-other-keys))
1975    method))
1976
1977;;; To be redefined as generic functions later
1978(declaim (notinline add-direct-method))
1979(defun add-direct-method (specializer method)
1980  (if (typep specializer 'eql-specializer)
1981      (pushnew method (std-slot-value specializer 'direct-methods))
1982      (pushnew method (class-direct-methods specializer))))
1983
1984(declaim (notinline remove-direct-method))
1985(defun remove-direct-method (specializer method)
1986  (if (typep specializer 'eql-specializer)
1987      (setf (std-slot-value specializer 'direct-methods)
1988            (remove method (std-slot-value specializer 'direct-methods)))
1989      (setf (class-direct-methods specializer)
1990            (remove method (class-direct-methods specializer)))))
1991
1992(defun std-add-method (gf method)
1993  ;; calls sites need to make sure that method is either a method of the
1994  ;; given gf or does not have a gf.
1995  (let ((old-method (%find-method gf (std-method-qualifiers method)
1996                                 (method-specializers method) nil)))
1997    (when old-method
1998      (if (and (eq (class-of gf) +the-standard-generic-function-class+)
1999               (eq (class-of old-method) +the-standard-method-class+))
2000          (std-remove-method gf old-method)
2001          (remove-method gf old-method))))
2002  (setf (std-slot-value method 'sys::%generic-function) gf)
2003  (push method (generic-function-methods gf))
2004  (dolist (specializer (method-specializers method))
2005    (add-direct-method specializer method))
2006  (finalize-standard-generic-function gf)
2007  gf)
2008
2009(defun std-remove-method (gf method)
2010  (setf (generic-function-methods gf)
2011        (remove method (generic-function-methods gf)))
2012  (setf (std-slot-value method 'sys::%generic-function) nil)
2013  (dolist (specializer (method-specializers method))
2014    (remove-direct-method specializer method))
2015  (finalize-standard-generic-function gf)
2016  gf)
2017
2018(defun %find-method (gf qualifiers specializers &optional (errorp t))
2019  ;; "If the specializers argument does not correspond in length to the number
2020  ;; of required arguments of the generic-function, an an error of type ERROR
2021  ;; is signaled."
2022  (unless (= (length specializers) (length (gf-required-args gf)))
2023    (error "The specializers argument has length ~S, but ~S has ~S required parameters."
2024           (length specializers)
2025           gf
2026           (length (gf-required-args gf))))
2027  (let* ((canonical-specializers (canonicalize-specializers specializers))
2028         (method
2029          (find-if #'(lambda (method)
2030                      (and (equal qualifiers
2031                                  (method-qualifiers method))
2032                           (equal canonical-specializers
2033                                  (method-specializers method))))
2034                   (generic-function-methods gf))))
2035    (if (and (null method) errorp)
2036        (error "No such method for ~S." (%generic-function-name gf))
2037        method)))
2038
2039(defun fast-callable-p (gf)
2040  (and (eq (method-combination-name (generic-function-method-combination gf))
2041           'standard)
2042       (null (intersection (%generic-function-lambda-list gf)
2043                           '(&rest &optional &key &allow-other-keys &aux)))))
2044
2045(declaim (ftype (function * t) slow-method-lookup-1))
2046
2047(declaim (ftype (function (t t t) t) slow-reader-lookup))
2048(defun slow-reader-lookup (gf layout slot-name)
2049  (let ((location (layout-slot-location layout slot-name)))
2050    (cache-slot-location gf layout location)
2051    location))
2052
2053(defun std-compute-discriminating-function (gf)
2054  ;; In this function, we know that gf is of class
2055  ;; standard-generic-function, so we call various
2056  ;; sys:%generic-function-foo readers to break circularities.
2057  (cond
2058    ((and (= (length (sys:%generic-function-methods gf)) 1)
2059          (eq (type-of (car (sys:%generic-function-methods gf))) 'standard-reader-method)
2060          (eq (type-of (car (std-method-specializers (%car (sys:%generic-function-methods gf))))) 'standard-class))
2061     ;; we are standard and can elide slot-value(-using-class)
2062     (let* ((method (%car (sys:%generic-function-methods gf)))
2063            (class (car (std-method-specializers method)))
2064            (slot-name (slot-definition-name (accessor-method-slot-definition method))))
2065       #'(lambda (arg)
2066           (declare (optimize speed))
2067           (let* ((layout (std-instance-layout arg))
2068                  (location (get-cached-slot-location gf layout)))
2069             (unless location
2070               (unless (simple-typep arg class)
2071                 ;; FIXME no applicable method
2072                 (error 'simple-type-error
2073                        :datum arg
2074                        :expected-type class))
2075               (setf location (slow-reader-lookup gf layout slot-name)))
2076             (let ((value (if (consp location)
2077                              (cdr location) ; :allocation :class
2078                              (funcallable-standard-instance-access arg location))))
2079               (if (eq value +slot-unbound+)
2080                   ;; fix SLOT-UNBOUND.5 from ansi test suite
2081                   (nth-value 0 (slot-unbound class arg slot-name))
2082                   value))))))
2083
2084    (t
2085     (let* ((emf-table (classes-to-emf-table gf))
2086            (number-required (length (gf-required-args gf)))
2087            (lambda-list (%generic-function-lambda-list gf))
2088            (exact (null (intersection lambda-list
2089                                       '(&rest &optional &key
2090                                         &allow-other-keys))))
2091            (no-aux (null (some 
2092                           (lambda (method) 
2093                             (find '&aux (std-slot-value method 'sys::lambda-list)))
2094                           (sys:%generic-function-methods gf)))))
2095       (if (and exact
2096                no-aux)
2097           (cond
2098             ((= number-required 1)
2099              (cond
2100                ((and (eq (method-combination-name (sys:%generic-function-method-combination gf)) 'standard)
2101                      (= (length (sys:%generic-function-methods gf)) 1))
2102                 (let* ((method (%car (sys:%generic-function-methods gf)))
2103                        (specializer (car (std-method-specializers method)))
2104                        (function (or (std-method-fast-function method)
2105                                      (std-method-function method))))
2106                   (if (typep specializer 'eql-specializer)
2107                       (let ((specializer-object (eql-specializer-object specializer)))
2108                         #'(lambda (arg)
2109                             (declare (optimize speed))
2110                             (if (eql arg specializer-object)
2111                                 (funcall function arg)
2112                                 (no-applicable-method gf (list arg)))))
2113                       #'(lambda (arg)
2114                           (declare (optimize speed))
2115                           (unless (simple-typep arg specializer)
2116                             ;; FIXME no applicable method
2117                             (error 'simple-type-error
2118                                    :datum arg
2119                                    :expected-type specializer))
2120                           (funcall function arg)))))
2121                (t
2122                 #'(lambda (arg)
2123                     (declare (optimize speed))
2124                     (let* ((specialization
2125                             (%get-arg-specialization gf arg))
2126                            (emfun (or (gethash1 specialization
2127                                                 emf-table)
2128                                       (slow-method-lookup-1
2129                                        gf arg specialization))))
2130                       (if emfun
2131                           (funcall emfun (list arg))
2132                           (apply #'no-applicable-method gf (list arg))))))))
2133             ((= number-required 2)
2134              #'(lambda (arg1 arg2)
2135                  (declare (optimize speed))
2136                  (let* ((args (list arg1 arg2))
2137                         (emfun (get-cached-emf gf args)))
2138                    (if emfun
2139                        (funcall emfun args)
2140                        (slow-method-lookup gf args)))))
2141             ((= number-required 3)
2142              #'(lambda (arg1 arg2 arg3)
2143                  (declare (optimize speed))
2144                  (let* ((args (list arg1 arg2 arg3))
2145                         (emfun (get-cached-emf gf args)))
2146                    (if emfun
2147                        (funcall emfun args)
2148                        (slow-method-lookup gf args)))))
2149             (t
2150              #'(lambda (&rest args)
2151                  (declare (optimize speed))
2152                  (let ((len (length args)))
2153                    (unless (= len number-required)
2154                      (error 'program-error
2155                             :format-control "Not enough arguments for generic function ~S."
2156                             :format-arguments (list (%generic-function-name gf)))))
2157                  (let ((emfun (get-cached-emf gf args)))
2158                    (if emfun
2159                        (funcall emfun args)
2160                        (slow-method-lookup gf args))))))
2161           ;;           (let ((non-key-args (+ number-required
2162           ;;                                  (length (gf-optional-args gf))))))
2163           #'(lambda (&rest args)
2164               (declare (optimize speed))
2165               (let ((len (length args)))
2166                 (unless (>= len number-required)
2167                   (error 'program-error
2168                          :format-control "Not enough arguments for generic function ~S."
2169                          :format-arguments (list (%generic-function-name gf)))))
2170               (let ((emfun (get-cached-emf gf args)))
2171                 (if emfun
2172                     (funcall emfun args)
2173                     (slow-method-lookup gf args)))))))))
2174
2175(defun sort-methods (methods gf required-classes)
2176  (if (or (null methods) (null (%cdr methods)))
2177      methods
2178      (sort methods
2179            (if (eq (class-of gf) +the-standard-generic-function-class+)
2180                (let ((method-indices
2181                       (argument-precedence-order-indices
2182                        (generic-function-argument-precedence-order gf)
2183                        (getf (analyze-lambda-list (generic-function-lambda-list gf))
2184                              ':required-args))))
2185                  #'(lambda (m1 m2)
2186                      (std-method-more-specific-p
2187                       m1 m2 required-classes method-indices)))
2188                #'(lambda (m1 m2)
2189                    (method-more-specific-p gf m1 m2 required-classes))))))
2190
2191(defun method-applicable-p (method args)
2192  (do* ((specializers (method-specializers method) (cdr specializers))
2193        (args args (cdr args)))
2194       ((null specializers) t)
2195    (let ((specializer (car specializers)))
2196      (if (typep specializer 'eql-specializer)
2197          (unless (eql (car args) (eql-specializer-object specializer))
2198            (return nil))
2199          (unless (subclassp (class-of (car args)) specializer)
2200            (return nil))))))
2201
2202(defun %compute-applicable-methods (gf args)
2203  (let ((required-classes (mapcar #'class-of (required-portion gf args)))
2204        (methods '()))
2205    (dolist (method (generic-function-methods gf))
2206      (when (method-applicable-p method args)
2207        (push method methods)))
2208    (sort-methods methods gf required-classes)))
2209
2210;;; METHOD-APPLICABLE-USING-CLASSES-P
2211;;;
2212;;; If the first return value is T, METHOD is definitely applicable to
2213;;; arguments that are instances of CLASSES.  If the first value is
2214;;; NIL and the second value is T, METHOD is definitely not applicable
2215;;; to arguments that are instances of CLASSES; if the second value is
2216;;; NIL the applicability of METHOD cannot be determined by inspecting
2217;;; the classes of its arguments only.
2218;;;
2219(defun method-applicable-using-classes-p (method classes)
2220  (do* ((specializers (method-specializers method) (cdr specializers))
2221  (classes classes (cdr classes))
2222  (knownp t))
2223       ((null specializers)
2224  (if knownp (values t t) (values nil nil)))
2225    (let ((specializer (car specializers)))
2226      (if (typep specializer 'eql-specializer)
2227    (if (eql (class-of (eql-specializer-object specializer)) 
2228       (car classes))
2229        (setf knownp nil)
2230        (return (values nil t)))
2231    (unless (subclassp (car classes) specializer)
2232      (return (values nil t)))))))
2233
2234(defun check-applicable-method-keyword-args (gf args
2235                                             keyword-args
2236                                             applicable-keywords)
2237  (when (oddp (length keyword-args))
2238    (error 'program-error
2239           :format-control "Odd number of keyword arguments in call to ~S ~
2240with arguments list ~S"
2241           :format-arguments (list gf args)))
2242  (unless (getf keyword-args :allow-other-keys)
2243    (loop for key in keyword-args by #'cddr
2244       unless (or (member key applicable-keywords)
2245                  (eq key :allow-other-keys))
2246       do (error 'program-error
2247                 :format-control "Invalid keyword argument ~S in call ~
2248to ~S with argument list ~S."
2249                 :format-arguments (list key gf args)))))
2250
2251(defun compute-applicable-keywords (gf applicable-methods)
2252  (let ((applicable-keywords
2253         (getf (analyze-lambda-list (generic-function-lambda-list gf))
2254               :keywords)))
2255    (loop for method in applicable-methods
2256       do (multiple-value-bind
2257                (keywords allow-other-keys)
2258              (function-keywords method)
2259            (when allow-other-keys
2260              (setf applicable-keywords :any)
2261              (return))
2262            (setf applicable-keywords
2263                  (union applicable-keywords keywords))))
2264    applicable-keywords))
2265
2266(defun wrap-emfun-for-keyword-args-check (gf emfun non-keyword-args
2267                                          applicable-keywords)
2268  #'(lambda (args)
2269      (check-applicable-method-keyword-args
2270         gf args
2271         (nthcdr non-keyword-args args) applicable-keywords)
2272      (funcall emfun args)))
2273
2274(defun slow-method-lookup (gf args)
2275  (let ((applicable-methods (%compute-applicable-methods gf args)))
2276    (if applicable-methods
2277        (let* ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
2278                                   #'std-compute-effective-method
2279                                   #'compute-effective-method)
2280                               gf (generic-function-method-combination gf)
2281                               applicable-methods))
2282               (non-keyword-args
2283                (+ (length (gf-required-args gf))
2284                   (length (gf-optional-args gf))))
2285               (gf-lambda-list (generic-function-lambda-list gf))
2286               (checks-required (and (member '&key gf-lambda-list)
2287                                     (not (member '&allow-other-keys
2288                                                  gf-lambda-list)))
2289                 )
2290              (applicable-keywords
2291               (when checks-required
2292                 ;; Don't do applicable keyword checks when this is
2293                 ;; one of the 'exceptional four' or when the gf allows
2294                 ;; other keywords.
2295                 (compute-applicable-keywords gf applicable-methods))))
2296          (when (and checks-required
2297                     (not (eq applicable-keywords :any)))
2298            (setf emfun
2299                  (wrap-emfun-for-keyword-args-check gf emfun non-keyword-args
2300                                                     applicable-keywords)))
2301          (cache-emf gf args emfun)
2302          (funcall emfun args))
2303        (apply #'no-applicable-method gf args))))
2304
2305(defun slow-method-lookup-1 (gf arg arg-specialization)
2306  (let ((applicable-methods (%compute-applicable-methods gf (list arg))))
2307    (if applicable-methods
2308        (let ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
2309                                  #'std-compute-effective-method
2310                                  #'compute-effective-method)
2311                              gf (generic-function-method-combination gf)
2312                              applicable-methods)))
2313          (when emfun
2314            (setf (gethash arg-specialization (classes-to-emf-table gf)) emfun))
2315          emfun))))
2316
2317(defun sub-specializer-p (c1 c2 c-arg)
2318  (find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
2319
2320(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
2321  (if argument-precedence-order
2322      (let ((specializers-1 (std-method-specializers method1))
2323            (specializers-2 (std-method-specializers method2)))
2324        (dolist (index argument-precedence-order)
2325          (let ((spec1 (nth index specializers-1))
2326                (spec2 (nth index specializers-2)))
2327            (unless (eq spec1 spec2)
2328              (cond ((typep spec1 'eql-specializer)
2329                     (return t))
2330                    ((typep spec2 'eql-specializer)
2331                     (return nil))
2332                    (t
2333                     (return (sub-specializer-p spec1 spec2
2334                                                (nth index required-classes)))))))))
2335      (do ((specializers-1 (std-method-specializers method1) (cdr specializers-1))
2336           (specializers-2 (std-method-specializers method2) (cdr specializers-2))
2337           (classes required-classes (cdr classes)))
2338          ((null specializers-1) nil)
2339        (let ((spec1 (car specializers-1))
2340              (spec2 (car specializers-2)))
2341          (unless (eq spec1 spec2)
2342            (cond ((typep spec1 'eql-specializer)
2343                   (return t))
2344                  ((typep spec2 'eql-specializer)
2345                   (return nil))
2346                  (t
2347                   (return (sub-specializer-p spec1 spec2 (car classes))))))))))
2348
2349(defun primary-method-p (method)
2350  (null (intersection '(:before :after :around) (method-qualifiers method))))
2351
2352(defun before-method-p (method)
2353  (equal '(:before) (method-qualifiers method)))
2354
2355(defun after-method-p (method)
2356  (equal '(:after) (method-qualifiers method)))
2357
2358(defun around-method-p (method)
2359  (equal '(:around) (method-qualifiers method)))
2360
2361(defun process-next-method-list (next-method-list)
2362  (mapcar #'(lambda (next-method-form)
2363              (cond
2364                ((listp next-method-form)
2365                 (assert (eq (first next-method-form) 'make-method))
2366                 (let* ((rest-sym (gensym)))
2367                   (make-instance-standard-method
2368                    nil ;; ignored
2369                    :lambda-list (list '&rest rest-sym)
2370                    :function (compute-method-function `(lambda (&rest ,rest-sym)
2371                                                          ,(second next-method-form))))))
2372                (t
2373                 (assert (typep next-method-form 'method))
2374                 next-method-form)))
2375          next-method-list))
2376
2377(defun std-compute-effective-method (gf method-combination methods)
2378  (assert (typep method-combination 'method-combination))
2379  (let* ((mc-name (method-combination-name method-combination))
2380         (options (slot-value method-combination 'options))
2381         (order (car options))
2382         (primaries '())
2383         (arounds '())
2384         around
2385         emf-form
2386         (long-method-combination-p
2387          (typep method-combination 'long-method-combination)))
2388    (unless long-method-combination-p
2389      (dolist (m methods)
2390        (let ((qualifiers (method-qualifiers m)))
2391          (cond ((null qualifiers)
2392                 (if (eq mc-name 'standard)
2393                     (push m primaries)
2394                     (error "Method combination type mismatch: missing qualifier for method combination ~S." method-combination)))
2395                ((cdr qualifiers)
2396                 (error "Invalid method qualifiers."))
2397                ((eq (car qualifiers) :around)
2398                 (push m arounds))
2399                ((eq (car qualifiers) mc-name)
2400                 (push m primaries))
2401                ((memq (car qualifiers) '(:before :after)))
2402                (t
2403                 (error "Invalid method qualifiers."))))))
2404    (unless (eq order :most-specific-last)
2405      (setf primaries (nreverse primaries)))
2406    (setf arounds (nreverse arounds))
2407    (setf around (car arounds))
2408    (when (and (null primaries) (not long-method-combination-p))
2409      (error "No primary methods for the generic function ~S." gf))
2410    (cond
2411      (around
2412       (let ((next-emfun
2413              (funcall
2414               (if (eq (class-of gf) +the-standard-generic-function-class+)
2415                   #'std-compute-effective-method
2416                   #'compute-effective-method)
2417               gf method-combination (remove around methods))))
2418         (setf emf-form
2419               (generate-emf-lambda (method-function around) next-emfun))))
2420      ((eq mc-name 'standard)
2421       (let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2422              (befores (remove-if-not #'before-method-p methods))
2423              (reverse-afters
2424               (reverse (remove-if-not #'after-method-p methods))))
2425         (setf emf-form
2426               (cond
2427                 ((and (null befores) (null reverse-afters))
2428                  (let ((fast-function (std-method-fast-function (car primaries))))
2429                    (if fast-function
2430                        (ecase (length (gf-required-args gf))
2431                          (1
2432                           #'(lambda (args)
2433                               (declare (optimize speed))
2434                               (funcall fast-function (car args))))
2435                          (2
2436                           #'(lambda (args)
2437                               (declare (optimize speed))
2438                               (funcall fast-function (car args) (cadr args)))))
2439                        (generate-emf-lambda (std-method-function (car primaries))
2440                                             next-emfun))))
2441                 (t
2442                  (let ((method-function (method-function (car primaries))))
2443                    #'(lambda (args)
2444                        (declare (optimize speed))
2445                        (dolist (before befores)
2446                          (funcall (method-function before) args nil))
2447                        (multiple-value-prog1
2448                            (funcall method-function args next-emfun)
2449                          (dolist (after reverse-afters)
2450                            (funcall (method-function after) args nil))))))))))
2451      (long-method-combination-p
2452       (let ((function (long-method-combination-function method-combination))
2453             (arguments (slot-value method-combination 'options)))
2454         (assert function)
2455         (setf emf-form
2456               (if arguments
2457                   (apply function gf methods arguments)
2458                   (funcall function gf methods)))))
2459      (t
2460       (unless (typep method-combination 'short-method-combination)
2461         (error "Unsupported method combination type ~A." mc-name))
2462       (let ((operator (short-method-combination-operator method-combination))
2463             (ioa (short-method-combination-identity-with-one-argument method-combination)))
2464         (setf emf-form
2465               (if (and ioa (null (cdr primaries)))
2466                   (generate-emf-lambda (method-function (car primaries)) nil)
2467                   `(lambda (args)
2468                      (,operator ,@(mapcar
2469                                    (lambda (primary)
2470                                      `(funcall ,(method-function primary) args nil))
2471                                    primaries))))))))
2472    (assert (not (null emf-form)))
2473    (or #+nil (ignore-errors (autocompile emf-form))
2474        (coerce-to-function emf-form))))
2475
2476(defun generate-emf-lambda (method-function next-emfun)
2477  #'(lambda (args)
2478      (declare (optimize speed))
2479      (funcall method-function args next-emfun)))
2480
2481;;; compute an effective method function from a list of primary methods:
2482
2483(defun compute-primary-emfun (methods)
2484  (if (null methods)
2485      nil
2486      (let ((next-emfun (compute-primary-emfun (cdr methods))))
2487        #'(lambda (args)
2488           (funcall (std-method-function (car methods)) args next-emfun)))))
2489
2490(defvar *call-next-method-p*)
2491(defvar *next-method-p-p*)
2492
2493(defun walk-form (form)
2494  (cond ((atom form)
2495         (cond ((eq form 'call-next-method)
2496                (setf *call-next-method-p* t))
2497               ((eq form 'next-method-p)
2498                (setf *next-method-p-p* t))))
2499        (t
2500         (walk-form (%car form))
2501         (walk-form (%cdr form)))))
2502
2503(defun compute-method-function (lambda-expression)
2504  (let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2505        (body (cddr lambda-expression))
2506        (*call-next-method-p* nil)
2507        (*next-method-p-p* nil))
2508    (multiple-value-bind (body declarations) (parse-body body)
2509      (let ((ignorable-vars '()))
2510        (dolist (var lambda-list)
2511          (if (memq var lambda-list-keywords)
2512              (return)
2513              (push var ignorable-vars)))
2514        (push `(declare (ignorable ,@ignorable-vars)) declarations))
2515      (walk-form body)
2516      (cond ((or *call-next-method-p* *next-method-p-p*)
2517             `(lambda (args next-emfun)
2518                (flet ((call-next-method (&rest cnm-args)
2519                         (if (null next-emfun)
2520                             (error "No next method for generic function.")
2521                             (funcall next-emfun (or cnm-args args))))
2522                       (next-method-p ()
2523                         (not (null next-emfun))))
2524                  (declare (ignorable (function call-next-method)
2525                                      (function next-method-p)))
2526                  (apply #'(lambda ,lambda-list ,@declarations ,@body) args))))
2527            ((null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2528             ;; Required parameters only.
2529             (case (length lambda-list)
2530               (1
2531                `(lambda (args next-emfun)
2532                   (declare (ignore next-emfun))
2533                   (let ((,(%car lambda-list) (%car args)))
2534                     (declare (ignorable ,(%car lambda-list)))
2535                     ,@declarations ,@body)))
2536               (2
2537                `(lambda (args next-emfun)
2538                   (declare (ignore next-emfun))
2539                   (let ((,(%car lambda-list) (%car args))
2540                         (,(%cadr lambda-list) (%cadr args)))
2541                     (declare (ignorable ,(%car lambda-list)
2542                                         ,(%cadr lambda-list)))
2543                     ,@declarations ,@body)))
2544               (3
2545                `(lambda (args next-emfun)
2546                   (declare (ignore next-emfun))
2547                   (let ((,(%car lambda-list) (%car args))
2548                         (,(%cadr lambda-list) (%cadr args))
2549                         (,(%caddr lambda-list) (%caddr args)))
2550                     (declare (ignorable ,(%car lambda-list)
2551                                         ,(%cadr lambda-list)
2552                                         ,(%caddr lambda-list)))
2553                     ,@declarations ,@body)))
2554               (t
2555                `(lambda (args next-emfun)
2556                   (declare (ignore next-emfun))
2557                   (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))
2558            (t
2559             `(lambda (args next-emfun)
2560                (declare (ignore next-emfun))
2561                (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))))
2562
2563(defun compute-method-fast-function (lambda-expression)
2564  (let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2565    (when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2566      (return-from compute-method-fast-function nil))
2567    ;; Only required args.
2568    (let ((body (cddr lambda-expression))
2569          (*call-next-method-p* nil)
2570          (*next-method-p-p* nil))
2571      (multiple-value-bind (body declarations) (parse-body body)
2572        (walk-form body)
2573        (when (or *call-next-method-p* *next-method-p-p*)
2574          (return-from compute-method-fast-function nil))
2575        (let ((decls `(declare (ignorable ,@lambda-list))))
2576          (setf lambda-expression
2577                (list* (car lambda-expression)
2578                       (cadr lambda-expression)
2579                       decls
2580                       (cddr lambda-expression))))
2581        (case (length lambda-list)
2582          (1
2583;;            `(lambda (args next-emfun)
2584;;               (let ((,(%car lambda-list) (%car args)))
2585;;                 (declare (ignorable ,(%car lambda-list)))
2586;;                 ,@declarations ,@body)))
2587           lambda-expression)
2588          (2
2589;;            `(lambda (args next-emfun)
2590;;               (let ((,(%car lambda-list) (%car args))
2591;;                     (,(%cadr lambda-list) (%cadr args)))
2592;;                 (declare (ignorable ,(%car lambda-list)
2593;;                                     ,(%cadr lambda-list)))
2594;;                 ,@declarations ,@body)))
2595           lambda-expression)
2596;;           (3
2597;;            `(lambda (args next-emfun)
2598;;               (let ((,(%car lambda-list) (%car args))
2599;;                     (,(%cadr lambda-list) (%cadr args))
2600;;                     (,(%caddr lambda-list) (%caddr args)))
2601;;                 (declare (ignorable ,(%car lambda-list)
2602;;                                     ,(%cadr lambda-list)
2603;;                                     ,(%caddr lambda-list)))
2604;;                 ,@declarations ,@body)))
2605          (t
2606           nil))))))
2607
2608(declaim (notinline make-method-lambda))
2609(defun make-method-lambda (generic-function method lambda-expression env)
2610  (declare (ignore generic-function method env))
2611  (values (compute-method-function lambda-expression) nil))
2612
2613
2614;; From CLHS section 7.6.5:
2615;; "When a generic function or any of its methods mentions &key in a lambda
2616;; list, the specific set of keyword arguments accepted by the generic function
2617;; varies according to the applicable methods. The set of keyword arguments
2618;; accepted by the generic function for a particular call is the union of the
2619;; keyword arguments accepted by all applicable methods and the keyword
2620;; arguments mentioned after &key in the generic function definition, if any."
2621;; Adapted from Sacla.
2622(defun allow-other-keys (lambda-list)
2623  (if (and (member '&key lambda-list)
2624           (not (member '&allow-other-keys lambda-list)))
2625      (let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2626             (aux-part (subseq lambda-list key-end)))
2627        `(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2628      lambda-list))
2629
2630(defmacro defmethod (&rest args &environment env)
2631  (multiple-value-bind
2632      (function-name qualifiers lambda-list specializers documentation declarations body)
2633      (parse-defmethod args)
2634    (let* ((specializers-form '())
2635           (lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2636           (gf (or (find-generic-function function-name nil)
2637                   (ensure-generic-function function-name :lambda-list lambda-list)))
2638           (method-function
2639             (make-method-lambda gf (class-prototype (generic-function-method-class gf))
2640                                 lambda-expression env))
2641           (fast-function (compute-method-fast-function lambda-expression))
2642           )
2643      (dolist (specializer specializers)
2644        (cond ((and (consp specializer) (eq (car specializer) 'eql))
2645               (push `(list 'eql ,(cadr specializer)) specializers-form))
2646              (t
2647               (push `',specializer specializers-form))))
2648      (setf specializers-form `(list ,@(nreverse specializers-form)))
2649      `(progn
2650         (ensure-method ',function-name
2651                        :lambda-list ',lambda-list
2652                        :qualifiers ',qualifiers
2653                        :specializers (canonicalize-specializers ,specializers-form)
2654                        ,@(if documentation `(:documentation ,documentation))
2655                        :function (function ,method-function)
2656                        ,@(if fast-function `(:fast-function (function ,fast-function)))
2657                        )))))
2658
2659;;; Reader and writer methods
2660
2661(defun make-instance-standard-accessor-method (method-class
2662                                               &key
2663                                               lambda-list
2664                                               qualifiers
2665                                               specializers
2666                                               documentation
2667                                               function
2668                                               fast-function
2669                                               slot-definition)
2670  (let ((method (std-allocate-instance method-class)))
2671    (setf (method-lambda-list method) lambda-list)
2672    (setf (method-qualifiers method) qualifiers)
2673    (setf (std-slot-value method 'sys::specializers)
2674          (canonicalize-specializers specializers))
2675    (setf (method-documentation method) documentation)
2676    (setf (std-slot-value method 'sys::%generic-function) nil)
2677    (setf (std-slot-value method 'sys::%function) function)
2678    (setf (std-slot-value method 'sys::fast-function) fast-function)
2679    (setf (std-slot-value method 'sys::%slot-definition) slot-definition)
2680    (setf (std-slot-value method 'sys::keywords) nil)
2681    (setf (std-slot-value method 'sys::other-keywords-p) nil)
2682    method))
2683
2684(defun add-reader-method (class function-name slot-definition)
2685  (let* ((slot-name (slot-definition-name slot-definition))
2686         (lambda-expression
2687          (if (eq (class-of class) +the-standard-class+)
2688              `(lambda (object) (std-slot-value object ',slot-name))
2689              `(lambda (object) (slot-value object ',slot-name))))
2690         (method-function (compute-method-function lambda-expression))
2691         (fast-function (compute-method-fast-function lambda-expression))
2692         (method-lambda-list '(object))
2693         (gf (find-generic-function function-name nil))
2694         (initargs `(:lambda-list ,method-lambda-list
2695                     :qualifiers ()
2696                     :specializers (,class)
2697                     :function ,(if (autoloadp 'compile)
2698                                    method-function
2699                                    (autocompile method-function))
2700                     :fast-function ,(if (autoloadp 'compile)
2701                                         fast-function
2702                                         (autocompile fast-function))
2703                     :slot-definition ,slot-definition))
2704         (method-class (if (eq class +the-standard-class+)
2705                           +the-standard-reader-method-class+
2706                           (apply #'reader-method-class class slot-definition
2707                                  initargs))))
2708    ;; required by AMOP pg. 225
2709    (assert (subtypep method-class +the-standard-reader-method-class+))
2710    (if gf
2711        (check-method-lambda-list function-name
2712                                  method-lambda-list
2713                                  (generic-function-lambda-list gf))
2714        (setf gf (ensure-generic-function function-name
2715                                          :lambda-list method-lambda-list)))
2716    (let ((method
2717           (if (eq method-class +the-standard-reader-method-class+)
2718               (apply #'make-instance-standard-accessor-method method-class
2719                      initargs)
2720               (apply #'make-instance method-class
2721                      :generic-function nil ; handled by add-method
2722                      initargs))))
2723      (if (eq (class-of gf) +the-standard-generic-function-class+)
2724          (progn
2725            (std-add-method gf method)
2726            (map-dependents gf
2727                            #'(lambda (dep)
2728                                (update-dependent gf dep 'add-method method))))
2729          (add-method gf method))
2730      method)))
2731
2732(defun add-writer-method (class function-name slot-definition)
2733  (let* ((slot-name (slot-definition-name slot-definition))
2734         (lambda-expression
2735          (if (eq (class-of class) +the-standard-class+)
2736              `(lambda (new-value object)
2737                 (setf (std-slot-value object ',slot-name) new-value))
2738              `(lambda (new-value object)
2739                 (setf (slot-value object ',slot-name) new-value))))
2740         (method-function (compute-method-function lambda-expression))
2741         (fast-function (compute-method-fast-function lambda-expression))
2742         (method-lambda-list '(new-value object))
2743         (gf (find-generic-function function-name nil))
2744         (initargs `(:lambda-list ,method-lambda-list
2745                     :qualifiers ()
2746                     :specializers (,+the-T-class+ ,class)
2747                     :function ,(if (autoloadp 'compile)
2748                                    method-function
2749                                    (autocompile method-function))
2750                     :fast-function ,(if (autoloadp 'compile)
2751                                         fast-function
2752                                         (autocompile fast-function))
2753                     :slot-definition ,slot-definition))
2754         (method-class (if (eq class +the-standard-class+)
2755                           +the-standard-writer-method-class+
2756                           (apply #'writer-method-class class slot-definition
2757                                  initargs))))
2758    ;; required by AMOP pg. 242
2759    (assert (subtypep method-class +the-standard-writer-method-class+))
2760    (if gf
2761        (check-method-lambda-list function-name
2762                                  method-lambda-list
2763                                  (generic-function-lambda-list gf))
2764        (setf gf (ensure-generic-function function-name
2765                                          :lambda-list method-lambda-list)))
2766    (let ((method
2767           (if (eq method-class +the-standard-writer-method-class+)
2768               (apply #'make-instance-standard-accessor-method method-class
2769                      initargs)
2770               (apply #'make-instance method-class
2771                      :generic-function nil ; handled by add-method
2772                      initargs))))
2773      (if (eq (class-of gf) +the-standard-generic-function-class+)
2774          (progn
2775            (std-add-method gf method)
2776            (map-dependents gf
2777                            #'(lambda (dep)
2778                                (update-dependent gf dep 'add-method method))))
2779          (add-method gf method))
2780      method)))
2781
2782(defmacro atomic-defgeneric (function-name &rest rest)
2783  "Macro to define a generic function and 'swap it into place' after
2784it's been fully defined with all its methods.
2785
2786Note: the user should really use the (:method ..) method description
2787way of defining methods; there's not much use in atomically defining
2788generic functions without providing sensible behaviour..."
2789  (let ((temp-sym (gensym)))
2790    `(progn
2791       (defgeneric ,temp-sym ,@rest)
2792       (let ((gf (symbol-function ',temp-sym)))
2793         (setf ,(if (and (consp function-name)
2794                         (eq (car function-name) 'setf))
2795                    `(get ',(second function-name) 'setf-function)
2796                  `(symbol-function ',function-name)) gf)
2797         (%set-generic-function-name gf ',function-name)
2798         gf))))
2799
2800(defmacro redefine-class-forwarder (name slot &optional body-alist)
2801  "Define a generic function on a temporary symbol as an accessor
2802for the slot `slot'. Then, when definition is complete (including
2803allocation of methods), swap the definition in place.
2804
2805`body-alist' can be used to override the default method bodies for given
2806metaclasses.  In substitute method bodies, `class' names the class
2807instance and, for setters, `new-value' the new value."
2808  (let* ((setterp (consp name))
2809         (%name
2810          (intern (concatenate 'string
2811                               "%"
2812                               (if setterp (symbol-name 'set-) "")
2813                               (symbol-name (if setterp (cadr name) name)))
2814                  (find-package "SYS")))
2815         (bodies
2816          (append body-alist
2817                  (if setterp
2818                      `((built-in-class . (,%name new-value class))
2819                        (forward-referenced-class . (,%name new-value class))
2820                        (structure-class . (,%name new-value class))
2821                        (standard-class . (setf (slot-value class ',slot)
2822                                                new-value))
2823                        (funcallable-standard-class . (setf (slot-value class ',slot)
2824                                                            new-value)))
2825                      `((built-in-class . (,%name class))
2826                        (forward-referenced-class . (,%name class))
2827                        (structure-class . (,%name class))
2828                        (standard-class . (slot-value class ',slot))
2829                        (funcallable-standard-class . (slot-value class ',slot)))))))
2830    `(atomic-defgeneric ,name (,@(when setterp (list 'new-value)) class)
2831        ,@(mapcar #'(lambda (class-name)
2832                      `(:method (,@(when setterp (list 'new-value))
2833                                 (class ,class-name))
2834                         ,(cdr (assoc class-name bodies))))
2835                  '(built-in-class forward-referenced-class structure-class
2836                    standard-class funcallable-standard-class)))))
2837
2838
2839(redefine-class-forwarder class-name name)
2840;;; AMOP pg. 230
2841(redefine-class-forwarder (setf class-name) name
2842   ((standard-class . (progn (reinitialize-instance class :name new-value) new-value))
2843    (funcallable-standard-class . (progn (reinitialize-instance class :name new-value) new-value))))
2844(redefine-class-forwarder class-slots slots)
2845(redefine-class-forwarder (setf class-slots) slots)
2846(redefine-class-forwarder class-direct-slots direct-slots)
2847(redefine-class-forwarder (setf class-direct-slots) direct-slots)
2848(redefine-class-forwarder class-layout layout)
2849(redefine-class-forwarder (setf class-layout) layout)
2850(redefine-class-forwarder class-direct-superclasses direct-superclasses)
2851(redefine-class-forwarder (setf class-direct-superclasses) direct-superclasses)
2852(redefine-class-forwarder class-direct-subclasses direct-subclasses)
2853(redefine-class-forwarder (setf class-direct-subclasses) direct-subclasses)
2854(redefine-class-forwarder class-direct-methods direct-methods)
2855(redefine-class-forwarder (setf class-direct-methods) direct-methods)
2856(redefine-class-forwarder class-precedence-list precedence-list)
2857(redefine-class-forwarder (setf class-precedence-list) precedence-list)
2858(redefine-class-forwarder class-finalized-p finalized-p)
2859(redefine-class-forwarder (setf class-finalized-p) finalized-p)
2860(redefine-class-forwarder class-default-initargs default-initargs)
2861(redefine-class-forwarder (setf class-default-initargs) default-initargs)
2862(redefine-class-forwarder class-direct-default-initargs direct-default-initargs)
2863(redefine-class-forwarder (setf class-direct-default-initargs) direct-default-initargs)
2864
2865;;; Class definition
2866
2867(defun check-duplicate-slots (slots)
2868  (dolist (s1 slots)
2869    (let ((name1 (canonical-slot-name s1)))
2870      (dolist (s2 (cdr (memq s1 slots)))
2871        (when (eq name1 (canonical-slot-name s2))
2872          (error 'program-error "Duplicate slot ~S" name1))))))
2873
2874(defun check-duplicate-default-initargs (initargs)
2875  (let ((names ()))
2876    (dolist (initarg initargs)
2877      (push (car initarg) names))
2878    (do* ((names names (cdr names))
2879          (name (car names) (car names)))
2880         ((null names))
2881      (when (memq name (cdr names))
2882        (error 'program-error
2883               :format-control "Duplicate initialization argument name ~S in :DEFAULT-INITARGS."
2884               :format-arguments (list name))))))
2885
2886(defun canonicalize-direct-superclasses (direct-superclasses)
2887  (let ((classes '()))
2888    (dolist (class-specifier direct-superclasses)
2889      (let ((class (if (classp class-specifier)
2890                       class-specifier
2891                       (find-class class-specifier nil))))
2892        (unless class
2893          (setf class (make-instance +the-forward-referenced-class+
2894                                     :name class-specifier))
2895          (setf (find-class class-specifier) class))
2896        (when (and (typep class 'built-in-class)
2897                   (not (member class *extensible-built-in-classes*)))
2898          (error "Attempt to define a subclass of built-in-class ~S."
2899                 class-specifier))
2900        (push class classes)))
2901    (nreverse classes)))
2902
2903(atomic-defgeneric add-direct-subclass (superclass subclass)
2904  (:method ((superclass class) (subclass class))
2905    (setf (class-direct-subclasses superclass)
2906          (adjoin subclass (class-direct-subclasses superclass)))))
2907
2908(atomic-defgeneric remove-direct-subclass (superclass subclass)
2909  (:method ((superclass class) (subclass class))
2910    (setf (class-direct-subclasses superclass)
2911          (remove subclass (class-direct-subclasses superclass)))))
2912
2913 ;;; AMOP pg. 182
2914(defun ensure-class (name &rest all-keys &key &allow-other-keys)
2915  (let ((class (find-class name nil)))
2916    ;; CLHS DEFCLASS: "If a class with the same proper name already
2917    ;; exists [...] the existing class is redefined."  Ansi-tests
2918    ;; CLASS-0309 and CLASS-0310.1 demand this behavior.
2919    (if (and class (eql (class-name class) name))
2920        (apply #'ensure-class-using-class class name all-keys)
2921        (apply #'ensure-class-using-class nil name all-keys))))
2922
2923;;; AMOP pg. 183ff.
2924(defgeneric ensure-class-using-class (class name &key direct-default-initargs
2925                                      direct-slots direct-superclasses
2926                                      metaclass &allow-other-keys))
2927
2928(defmethod ensure-class-using-class :before (class name  &key direct-slots
2929                                             direct-default-initargs 
2930                                             &allow-other-keys)
2931  (check-duplicate-slots direct-slots)
2932  (check-duplicate-default-initargs direct-default-initargs))
2933
2934(defmethod ensure-class-using-class ((class null) name &rest all-keys
2935                                     &key (metaclass +the-standard-class+)
2936                                     direct-superclasses
2937                                     &allow-other-keys)
2938  (setf all-keys (copy-list all-keys))  ; since we modify it
2939  (remf all-keys :metaclass)
2940  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2941  (let ((class (apply (if (eq metaclass +the-standard-class+)
2942                          #'make-instance-standard-class
2943                          #'make-instance)
2944                      metaclass :name name
2945                      :direct-superclasses (canonicalize-direct-superclasses
2946                                            direct-superclasses)
2947                      all-keys)))
2948    (%set-find-class name class)
2949    class))
2950
2951(defmethod ensure-class-using-class ((class built-in-class) name &rest all-keys
2952                                     &key &allow-other-keys)
2953  (declare (ignore all-keys))
2954  (error "The symbol ~S names a built-in class." name))
2955
2956(defmethod ensure-class-using-class ((class forward-referenced-class) name
2957                                     &rest all-keys
2958                                     &key (metaclass +the-standard-class+)
2959                                     direct-superclasses &allow-other-keys)
2960  (setf all-keys (copy-list all-keys))  ; since we modify it
2961  (remf all-keys :metaclass)
2962  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2963  (change-class class metaclass)
2964  (apply #'reinitialize-instance class
2965         :name name
2966         :direct-superclasses (canonicalize-direct-superclasses
2967                               direct-superclasses)
2968         all-keys)
2969  class)
2970
2971(defmethod ensure-class-using-class ((class class) name
2972                                     &key (metaclass +the-standard-class+ metaclassp)
2973                                     direct-superclasses &rest all-keys
2974                                     &allow-other-keys)
2975  (declare (ignore name))
2976  (setf all-keys (copy-list all-keys))  ; since we modify it
2977  (remf all-keys :metaclass)
2978  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2979  (when (and metaclassp (not (eq (class-of class) metaclass)))
2980    (error 'program-error
2981           "Trying to redefine class ~S with different metaclass."
2982           (class-name class)))
2983  (apply #'reinitialize-instance class
2984         :direct-superclasses (canonicalize-direct-superclasses direct-superclasses)
2985         all-keys)
2986  class)
2987
2988(defun maybe-finalize-class-subtree (class)
2989  (when (every #'class-finalized-p (class-direct-superclasses class))
2990    (finalize-inheritance class)
2991    (dolist (subclass (class-direct-subclasses class))
2992      (maybe-finalize-class-subtree subclass))))
2993
2994(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
2995  (unless (>= (length form) 3)
2996    (error 'program-error "Wrong number of arguments for DEFCLASS."))
2997  (check-declaration-type name)
2998  `(ensure-class ',name
2999                 :direct-superclasses
3000                 (canonicalize-direct-superclasses ',direct-superclasses)
3001                 :direct-slots
3002                 ,(canonicalize-direct-slots direct-slots)
3003                 ,@(canonicalize-defclass-options options)))
3004
3005
3006;;; AMOP pg. 180
3007(defgeneric direct-slot-definition-class (class &rest initargs))
3008
3009(defmethod direct-slot-definition-class ((class class) &rest initargs)
3010  (declare (ignore initargs))
3011  +the-standard-direct-slot-definition-class+)
3012
3013;;; AMOP pg. 181
3014(defgeneric effective-slot-definition-class (class &rest initargs))
3015
3016(defmethod effective-slot-definition-class ((class class) &rest initargs)
3017  (declare (ignore initargs))
3018  +the-standard-effective-slot-definition-class+)
3019
3020;;; AMOP pg. 224
3021(defgeneric reader-method-class (class direct-slot &rest initargs))
3022
3023(defmethod reader-method-class ((class standard-class)
3024                                (direct-slot standard-direct-slot-definition)
3025                                &rest initargs)
3026  (declare (ignore initargs))
3027  +the-standard-reader-method-class+)
3028
3029(defmethod reader-method-class ((class funcallable-standard-class)
3030                                (direct-slot standard-direct-slot-definition)
3031                                &rest initargs)
3032  (declare (ignore initargs))
3033  +the-standard-reader-method-class+)
3034
3035;;; AMOP pg. 242
3036(defgeneric writer-method-class (class direct-slot &rest initargs))
3037
3038(defmethod writer-method-class ((class standard-class)
3039                                (direct-slot standard-direct-slot-definition)
3040                                &rest initargs)
3041  (declare (ignore initargs))
3042  +the-standard-writer-method-class+)
3043
3044(defmethod writer-method-class ((class funcallable-standard-class)
3045                                (direct-slot standard-direct-slot-definition)
3046                                &rest initargs)
3047  (declare (ignore initargs))
3048  +the-standard-writer-method-class+)
3049
3050(atomic-defgeneric documentation (x doc-type)
3051    (:method ((x symbol) doc-type)
3052        (%documentation x doc-type))
3053    (:method ((x function) doc-type)
3054        (%documentation x doc-type)))
3055
3056(atomic-defgeneric (setf documentation) (new-value x doc-type)
3057    (:method (new-value (x symbol) doc-type)
3058        (%set-documentation x doc-type new-value))
3059    (:method (new-value (x function) doc-type)
3060        (%set-documentation x doc-type new-value)))
3061
3062
3063;; FIXME This should be a weak hashtable!
3064(defvar *list-documentation-hashtable* (make-hash-table :test #'equal))
3065
3066(defmethod documentation ((x list) (doc-type (eql 'function)))
3067  (let ((alist (gethash x *list-documentation-hashtable*)))
3068    (and alist (cdr (assoc doc-type alist)))))
3069
3070(defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
3071  (let ((alist (gethash x *list-documentation-hashtable*)))
3072    (and alist (cdr (assoc doc-type alist)))))
3073
3074(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
3075  (let* ((alist (gethash x *list-documentation-hashtable*))
3076         (entry (and alist (assoc doc-type alist))))
3077    (cond (entry
3078           (setf (cdr entry) new-value))
3079          (t
3080           (setf (gethash x *list-documentation-hashtable*)
3081                 (push (cons doc-type new-value) alist)))))
3082  new-value)
3083
3084(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro)))
3085  (let* ((alist (gethash x *list-documentation-hashtable*))
3086         (entry (and alist (assoc doc-type alist))))
3087    (cond (entry
3088           (setf (cdr entry) new-value))
3089          (t
3090           (setf (gethash x *list-documentation-hashtable*)
3091                 (push (cons doc-type new-value) alist)))))
3092  new-value)
3093
3094(defmethod documentation ((x class) (doc-type (eql 't)))
3095  (class-documentation x))
3096
3097(defmethod documentation ((x class) (doc-type (eql 'type)))
3098  (class-documentation x))
3099
3100(defmethod (setf documentation) (new-value (x class) (doc-type (eql 't)))
3101  (%set-class-documentation x new-value))
3102
3103(defmethod (setf documentation) (new-value (x class) (doc-type (eql 'type)))
3104  (%set-class-documentation x new-value))
3105
3106(defmethod documentation ((x structure-class) (doc-type (eql 't)))
3107  (%documentation x doc-type))
3108
3109(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
3110  (%documentation x doc-type))
3111
3112(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 't)))
3113  (%set-documentation x doc-type new-value))
3114
3115(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 'type)))
3116  (%set-documentation x doc-type new-value))
3117
3118(defmethod documentation ((x standard-generic-function) (doc-type (eql 't)))
3119  (generic-function-documentation x))
3120
3121(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 't)))
3122  (setf (generic-function-documentation x) new-value))
3123
3124(defmethod documentation ((x standard-generic-function) (doc-type (eql 'function)))
3125  (generic-function-documentation x))
3126
3127(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 'function)))
3128  (setf (generic-function-documentation x) new-value))
3129
3130(defmethod documentation ((x standard-method) (doc-type (eql 't)))
3131  (method-documentation x))
3132
3133(defmethod (setf documentation) (new-value (x standard-method) (doc-type (eql 't)))
3134  (setf (method-documentation x) new-value))
3135
3136(defmethod documentation ((x standard-slot-definition) (doc-type (eql 't)))
3137  (slot-definition-documentation x))
3138
3139(defmethod (setf documentation) (new-value (x standard-slot-definition) (doc-type (eql 't)))
3140  (setf (slot-definition-documentation x) new-value))
3141
3142(defmethod documentation ((x package) (doc-type (eql 't)))
3143  (%documentation x doc-type))
3144
3145(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
3146  (%set-documentation x doc-type new-value))
3147
3148(defmethod documentation ((x symbol) (doc-type (eql 'function)))
3149  (%documentation x doc-type))
3150
3151;;; Applicable methods
3152
3153(defgeneric compute-applicable-methods (gf args)
3154  (:method ((gf standard-generic-function) args)
3155    (%compute-applicable-methods gf args)))
3156
3157(defgeneric compute-applicable-methods-using-classes (gf classes)
3158  (:method ((gf standard-generic-function) classes)
3159    (let ((methods '()))
3160      (dolist (method (generic-function-methods gf))
3161  (multiple-value-bind (applicable knownp)
3162      (method-applicable-using-classes-p method classes)
3163    (cond (applicable
3164     (push method methods))
3165    ((not knownp)
3166     (return-from compute-applicable-methods-using-classes
3167       (values nil nil))))))
3168      (values (sort-methods methods gf classes)
3169        t))))
3170
3171
3172;;; Slot access
3173;;;
3174;;; See AMOP pg. 156ff. for an overview.
3175;;;
3176;;; AMOP specifies these generic functions to dispatch on slot objects
3177;;; (with the exception of slot-exists-p-using-class), although its
3178;;; sample implementation Closette dispatches on slot names.  We let
3179;;; slot-value and friends call their gf counterparts with the effective
3180;;; slot definition, but leave the definitions dispatching on slot name
3181;;; in place for user convenience.
3182
3183;;; AMOP pg. 235
3184(defgeneric slot-value-using-class (class instance slot))
3185
3186(defmethod slot-value-using-class ((class standard-class) instance (slot symbol))
3187  (std-slot-value instance slot))
3188(defmethod slot-value-using-class ((class standard-class) instance
3189                                   (slot standard-effective-slot-definition))
3190  (let* ((location (slot-definition-location slot))
3191         (value (if (consp location)
3192                    (cdr location)      ; :allocation :class
3193                    (standard-instance-access instance location))))
3194    (if (eq value +slot-unbound+)
3195        ;; fix SLOT-UNBOUND.5 from ansi test suite
3196        (nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3197        value)))
3198
3199(defmethod slot-value-using-class ((class funcallable-standard-class)
3200                                   instance (slot symbol))
3201  (std-slot-value instance slot))
3202(defmethod slot-value-using-class ((class funcallable-standard-class) instance
3203                                   (slot standard-effective-slot-definition))
3204  (let* ((location (slot-definition-location slot))
3205         (value (if (consp location)
3206                    (cdr location)      ; :allocation :class
3207                    (funcallable-standard-instance-access instance location))))
3208    (if (eq value +slot-unbound+)
3209        ;; fix SLOT-UNBOUND.5 from ansi test suite
3210        (nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3211        value)))
3212
3213(defmethod slot-value-using-class ((class structure-class) instance
3214                                   (slot symbol))
3215  (std-slot-value instance slot))
3216(defmethod slot-value-using-class ((class structure-class) instance
3217                                   (slot standard-effective-slot-definition))
3218  (std-slot-value instance (slot-definition-name slot)))
3219
3220;;; AMOP pg. 231
3221(defgeneric (setf slot-value-using-class) (new-value class instance slot))
3222
3223(defmethod (setf slot-value-using-class) (new-value
3224                                          (class standard-class)
3225                                          instance
3226                                          (slot symbol))
3227  (setf (std-slot-value instance slot) new-value))
3228(defmethod (setf slot-value-using-class) (new-value
3229                                          (class standard-class)
3230                                          instance
3231                                          (slot standard-effective-slot-definition))
3232  (let ((location (slot-definition-location slot)))
3233    (if (consp location)                ; :allocation :class
3234        (setf (cdr location) new-value)
3235        (setf (standard-instance-access instance location) new-value))))
3236
3237(defmethod (setf slot-value-using-class) (new-value
3238                                          (class funcallable-standard-class)
3239                                          instance
3240                                          (slot symbol))
3241  (setf (std-slot-value instance slot) new-value))
3242(defmethod (setf slot-value-using-class) (new-value
3243                                          (class funcallable-standard-class)
3244                                          instance
3245                                          (slot standard-effective-slot-definition))
3246  (let ((location (slot-definition-location slot)))
3247    (if (consp location)                ; :allocation :class
3248        (setf (cdr location) new-value)
3249        (setf (funcallable-standard-instance-access instance location)
3250              new-value))))
3251
3252(defmethod (setf slot-value-using-class) (new-value
3253                                          (class structure-class)
3254                                          instance
3255                                          (slot symbol))
3256  (setf (std-slot-value instance slot) new-value))
3257(defmethod (setf slot-value-using-class) (new-value
3258                                          (class structure-class)
3259                                          instance
3260                                          (slot standard-effective-slot-definition))
3261  (setf (std-slot-value instance (slot-definition-name slot)) new-value))
3262
3263;;; slot-exists-p-using-class is not specified by AMOP, and obviously
3264;;; cannot be specialized on the slot type.  Hence, its implementation
3265;;; differs from slot-(boundp|makunbound|value)-using-class
3266(defgeneric slot-exists-p-using-class (class instance slot-name))
3267
3268(defmethod slot-exists-p-using-class (class instance slot-name)
3269  nil)
3270
3271(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
3272  (std-slot-exists-p instance slot-name))
3273(defmethod slot-exists-p-using-class ((class funcallable-standard-class) instance slot-name)
3274  (std-slot-exists-p instance slot-name))
3275
3276(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
3277  (dolist (dsd (class-slots class))
3278    (when (eq (sys::dsd-name dsd) slot-name)
3279      (return-from slot-exists-p-using-class t)))
3280  nil)
3281
3282
3283(defgeneric slot-boundp-using-class (class instance slot))
3284(defmethod slot-boundp-using-class ((class standard-class) instance (slot symbol))
3285  (std-slot-boundp instance slot))
3286(defmethod slot-boundp-using-class ((class standard-class) instance
3287                                    (slot standard-effective-slot-definition))
3288  (let ((location (slot-definition-location slot)))
3289    (if (consp location)
3290        (eq (cdr location) +slot-unbound+) ; :allocation :class
3291        (eq (standard-instance-access instance location) +slot-unbound+))))
3292
3293(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3294                                    (slot symbol))
3295  (std-slot-boundp instance slot))
3296(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3297                                    (slot standard-effective-slot-definition))
3298  (let ((location (slot-definition-location slot)))
3299    (if (consp location)
3300        (eq (cdr location) +slot-unbound+) ; :allocation :class
3301        (eq (funcallable-standard-instance-access instance location)
3302            +slot-unbound+))))
3303
3304(defmethod slot-boundp-using-class ((class structure-class) instance slot)
3305  "Structure slots can't be unbound, so this method always returns T."
3306  (declare (ignore class instance slot))
3307  t)
3308
3309(defgeneric slot-makunbound-using-class (class instance slot))
3310(defmethod slot-makunbound-using-class ((class standard-class)
3311                                        instance
3312                                        (slot symbol))
3313  (std-slot-makunbound instance slot))
3314(defmethod slot-makunbound-using-class ((class standard-class)
3315                                        instance
3316                                        (slot standard-effective-slot-definition))
3317  (let ((location (slot-definition-location slot)))
3318    (if (consp location)
3319        (setf (cdr location) +slot-unbound+)
3320        (setf (standard-instance-access instance location) +slot-unbound+))))
3321
3322(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3323                                        instance
3324                                        (slot symbol))
3325  (std-slot-makunbound instance slot))
3326(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3327                                        instance
3328                                        (slot symbol))
3329  (let ((location (slot-definition-location slot)))
3330    (if (consp location)
3331        (setf (cdr location) +slot-unbound+)
3332        (setf (funcallable-standard-instance-access instance location)
3333              +slot-unbound+))))
3334
3335(defmethod slot-makunbound-using-class ((class structure-class)
3336                                        instance
3337                                        slot)
3338  (declare (ignore class instance slot))
3339  (error "Structure slots can't be unbound"))
3340
3341(defgeneric slot-missing (class instance slot-name operation &optional new-value))
3342
3343(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
3344  (declare (ignore new-value))
3345  (error "The slot ~S is missing from the class ~S." slot-name class))
3346
3347(defgeneric slot-unbound (class instance slot-name))
3348
3349(defmethod slot-unbound ((class t) instance slot-name)
3350  (error 'unbound-slot :instance instance :name slot-name))
3351
3352;;; Instance creation and initialization
3353
3354;;; AMOP pg. 168ff.
3355(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
3356
3357(defmethod allocate-instance ((class standard-class) &rest initargs)
3358  (declare (ignore initargs))
3359  (std-allocate-instance class))
3360
3361(defmethod allocate-instance ((class funcallable-standard-class) &rest initargs)
3362  (declare (ignore initargs))
3363  (allocate-funcallable-instance class))
3364
3365(defmethod allocate-instance ((class structure-class) &rest initargs)
3366  (declare (ignore initargs))
3367  (%make-structure (class-name class)
3368                   (make-list (length (class-slots class))
3369                              :initial-element +slot-unbound+)))
3370
3371(defmethod allocate-instance ((class built-in-class) &rest initargs)
3372  (declare (ignore initargs))
3373  (error "Cannot allocate instances of a built-in class: ~S" class))
3374
3375(defmethod allocate-instance :before ((class class) &rest initargs)
3376  (declare (ignore initargs))
3377  (unless (class-finalized-p class)
3378    (finalize-inheritance class)))
3379
3380;; "The set of valid initialization arguments for a class is the set of valid
3381;; initialization arguments that either fill slots or supply arguments to
3382;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
3383;; 7.1.2
3384
3385(defun calculate-allowable-initargs (gf-list args instance
3386                                             shared-initialize-param
3387                                             initargs)
3388  (let* ((methods
3389          (nconc
3390             (compute-applicable-methods #'shared-initialize
3391                                         (list* instance
3392                                                shared-initialize-param
3393                                                initargs))
3394             (mapcan #'(lambda (gf)
3395                         (compute-applicable-methods gf args))
3396                     gf-list)))
3397         (method-keyword-args
3398          (reduce #'merge-initargs-sets
3399                  (mapcar #'method-lambda-list methods)
3400                  :key #'extract-lambda-list-keywords
3401                  :initial-value nil))
3402         (slots-initargs
3403          (mapappend #'slot-definition-initargs
3404                     (class-slots (class-of instance)))))
3405    (merge-initargs-sets
3406     (merge-initargs-sets slots-initargs method-keyword-args)
3407     '(:allow-other-keys))))  ;; allow-other-keys is always allowed
3408
3409(defun check-initargs (gf-list args instance
3410                       shared-initialize-param initargs
3411                       cache call-site)
3412  "Checks the validity of `initargs' for the generic functions in `gf-list'
3413when called with `args' by calculating the applicable methods for each gf.
3414The applicable methods for SHARED-INITIALIZE based on `instance',
3415`shared-initialize-param' and `initargs' are added to the list of
3416applicable methods."
3417  (when (oddp (length initargs))
3418    (error 'program-error
3419           :format-control "Odd number of keyword arguments."))
3420  (unless (getf initargs :allow-other-keys)
3421    (multiple-value-bind (allowable-initargs present-p)
3422                         (when cache
3423                           (gethash (class-of instance) cache))
3424       (unless present-p
3425         (setf allowable-initargs
3426               (calculate-allowable-initargs gf-list args instance
3427                                             shared-initialize-param initargs))
3428         (when cache
3429           (setf (gethash (class-of instance) cache)
3430                 allowable-initargs)))
3431       (unless (eq t allowable-initargs)
3432         (do* ((tail initargs (cddr tail))
3433               (initarg (car tail) (car tail)))
3434              ((null tail))
3435              (unless (memq initarg allowable-initargs)
3436                (error 'program-error
3437                       :format-control "Invalid initarg ~S in call to ~S with arglist ~S."
3438                       :format-arguments (list initarg call-site args))))))))
3439
3440(defun merge-initargs-sets (list1 list2)
3441  (cond
3442   ((eq list1 t)  t)
3443   ((eq list2 t)  t)
3444   (t             (union list1 list2))))
3445
3446(defun extract-lambda-list-keywords (lambda-list)
3447  "Returns a list of keywords acceptable as keyword arguments,
3448or T when any keyword is acceptable due to presence of
3449&allow-other-keys."
3450  (when (member '&allow-other-keys lambda-list)
3451    (return-from extract-lambda-list-keywords t))
3452  (loop with keyword-args = (cdr (memq '&key lambda-list))
3453        for key in keyword-args
3454        when (eq key '&aux) do (loop-finish)
3455        when (eq key '&allow-other-keys) do (return t)
3456        when (listp key) do (setq key (car key))
3457        collect (if (symbolp key)
3458                    (make-keyword key)
3459                  (car key))))
3460
3461
3462(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
3463
3464(defmethod make-instance :before ((class class) &rest initargs)
3465  (when (oddp (length initargs))
3466    (error 'program-error :format-control "Odd number of keyword arguments."))
3467  (unless (class-finalized-p class)
3468    (finalize-inheritance class)))
3469
3470(defun augment-initargs-with-defaults (class initargs)
3471  (let ((default-initargs '()))
3472    (dolist (initarg (class-default-initargs class))
3473      (let ((key (first initarg))
3474            (fn (third initarg)))
3475        (when (eq (getf initargs key +slot-unbound+) +slot-unbound+)
3476          (push key default-initargs)
3477          (push (funcall fn) default-initargs))))
3478    (append initargs (nreverse default-initargs))))
3479
3480(defmethod make-instance ((class standard-class) &rest initargs)
3481  (setf initargs (augment-initargs-with-defaults class initargs))
3482  (let ((instance (std-allocate-instance class)))
3483    (check-initargs (list #'allocate-instance #'initialize-instance)
3484                    (list* instance initargs)
3485                    instance t initargs
3486                    *make-instance-initargs-cache* 'make-instance)
3487    (apply #'initialize-instance instance initargs)
3488    instance))
3489
3490(defmethod make-instance ((class funcallable-standard-class) &rest initargs)
3491  (setf initargs (augment-initargs-with-defaults class initargs))
3492  (let ((instance (allocate-funcallable-instance class)))
3493    (check-initargs (list #'allocate-instance #'initialize-instance)
3494                    (list* instance initargs)
3495                    instance t initargs
3496                    *make-instance-initargs-cache* 'make-instance)
3497    (apply #'initialize-instance instance initargs)
3498    instance))
3499
3500(defmethod make-instance ((class symbol) &rest initargs)
3501  (apply #'make-instance (find-class class) initargs))
3502
3503(defgeneric initialize-instance (instance &rest initargs
3504                                          &key &allow-other-keys))
3505
3506(defmethod initialize-instance ((instance standard-object) &rest initargs)
3507  (apply #'shared-initialize instance t initargs))
3508
3509(defgeneric reinitialize-instance (instance &rest initargs
3510                                            &key &allow-other-keys))
3511
3512;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
3513;; validity of initargs and signals an error if an initarg is supplied that is
3514;; not declared as valid. The method then calls the generic function SHARED-
3515;; INITIALIZE with the following arguments: the instance, nil (which means no
3516;; slots should be initialized according to their initforms), and the initargs
3517;; it received."
3518(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
3519  (check-initargs (list #'reinitialize-instance) (list* instance initargs)
3520                  instance () initargs
3521                  *reinitialize-instance-initargs-cache* 'reinitialize-instance)
3522  (apply #'shared-initialize instance () initargs))
3523
3524(defun std-shared-initialize (instance slot-names all-keys)
3525  (when (oddp (length all-keys))
3526    (error 'program-error :format-control "Odd number of keyword arguments."))
3527  ;; do a quick scan of the arguments list to see if it's a real
3528  ;; 'initialization argument list' (which is not the same as
3529  ;; checking initarg validity
3530  (do* ((tail all-keys (cddr tail))
3531        (initarg (car tail) (car tail)))
3532      ((null tail))
3533    (unless (symbolp initarg)
3534      (error 'program-error
3535             :format-control "Initarg ~S not a symbol."
3536             :format-arguments (list initarg))))
3537  (dolist (slot (class-slots (class-of instance)))
3538    (let ((slot-name (slot-definition-name slot)))
3539      (multiple-value-bind (init-key init-value foundp)
3540          (get-properties all-keys (slot-definition-initargs slot))
3541        (if foundp
3542            (setf (std-slot-value instance slot-name) init-value)
3543            (unless (std-slot-boundp instance slot-name)
3544              (let ((initfunction (slot-definition-initfunction slot)))
3545                (when (and initfunction (or (eq slot-names t)
3546                                            (memq slot-name slot-names)))
3547                  (setf (std-slot-value instance slot-name)
3548                        (funcall initfunction)))))))))
3549  instance)
3550
3551(defgeneric shared-initialize (instance slot-names
3552                                        &rest initargs
3553                                        &key &allow-other-keys))
3554
3555(defmethod shared-initialize ((instance standard-object) slot-names
3556                              &rest initargs)
3557  (std-shared-initialize instance slot-names initargs))
3558
3559(defmethod shared-initialize :after ((instance standard-class) slot-names
3560                                     &key direct-superclasses
3561                                     direct-slots direct-default-initargs
3562                                     &allow-other-keys)
3563  (std-after-initialization-for-classes
3564   instance :direct-superclasses direct-superclasses
3565   :direct-slots direct-slots
3566   :direct-default-initargs direct-default-initargs))
3567
3568(defmethod shared-initialize :after ((instance funcallable-standard-class)
3569                                     slot-names &key direct-superclasses
3570                                     direct-slots direct-default-initargs
3571                                     &allow-other-keys)
3572  (std-after-initialization-for-classes
3573   instance :direct-superclasses direct-superclasses
3574   :direct-slots direct-slots
3575   :direct-default-initargs direct-default-initargs))
3576
3577(defmethod shared-initialize ((slot slot-definition) slot-names
3578                              &rest args
3579                              &key name initargs initform initfunction
3580                              readers writers allocation
3581                              &allow-other-keys)
3582  ;;Keyword args are duplicated from init-slot-definition only to have
3583  ;;them checked.
3584  (declare (ignore slot-names)) ;;TODO?
3585  (declare (ignore name initargs initform initfunction readers writers allocation))
3586  ;;For built-in slots
3587  (apply #'init-slot-definition slot :allow-other-keys t args)
3588  ;;For user-defined slots
3589  (call-next-method))
3590
3591;;; change-class
3592
3593(defgeneric change-class (instance new-class &key &allow-other-keys))
3594
3595(defmethod change-class ((old-instance standard-object) (new-class standard-class)
3596                         &rest initargs)
3597  (let ((old-slots (class-slots (class-of old-instance)))
3598        (new-slots (class-slots new-class))
3599        (new-instance (allocate-instance new-class)))
3600    ;; "The values of local slots specified by both the class CTO and the class
3601    ;; CFROM are retained. If such a local slot was unbound, it remains
3602    ;; unbound."
3603    (dolist (new-slot new-slots)
3604      (when (instance-slot-p new-slot)
3605        (let* ((slot-name (slot-definition-name new-slot))
3606               (old-slot (find slot-name old-slots :key 'slot-definition-name)))
3607          ;; "The values of slots specified as shared in the class CFROM and as
3608          ;; local in the class CTO are retained."
3609          (when (and old-slot (slot-boundp old-instance slot-name))
3610            (setf (slot-value new-instance slot-name)
3611                  (slot-value old-instance slot-name))))))
3612    (swap-slots old-instance new-instance)
3613    (rotatef (std-instance-layout new-instance)
3614             (std-instance-layout old-instance))
3615    (apply #'update-instance-for-different-class
3616           new-instance old-instance initargs)
3617    old-instance))
3618
3619(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
3620  (apply #'change-class instance (find-class new-class) initargs))
3621
3622(defgeneric update-instance-for-different-class (old new
3623                                                     &rest initargs
3624                                                     &key &allow-other-keys))
3625
3626(defmethod update-instance-for-different-class
3627  ((old standard-object) (new standard-object) &rest initargs)
3628  (let ((added-slots
3629         (remove-if #'(lambda (slot-name)
3630                       (slot-exists-p old slot-name))
3631                    (mapcar 'slot-definition-name
3632                            (class-slots (class-of new))))))
3633    (check-initargs (list #'update-instance-for-different-class)
3634                    (list old new initargs)
3635                    new added-slots initargs
3636                    nil 'update-instance-for-different-class)
3637    (apply #'shared-initialize new added-slots initargs)))
3638
3639;;; make-instances-obsolete
3640
3641(defgeneric make-instances-obsolete (class))
3642
3643(defmethod make-instances-obsolete ((class standard-class))
3644  (%make-instances-obsolete class))
3645(defmethod make-instances-obsolete ((class funcallable-standard-class))
3646  (%make-instances-obsolete class))
3647(defmethod make-instances-obsolete ((class symbol))
3648  (make-instances-obsolete (find-class class))
3649  class)
3650
3651;;; update-instance-for-redefined-class
3652
3653(defgeneric update-instance-for-redefined-class (instance
3654                                                 added-slots
3655                                                 discarded-slots
3656                                                 property-list
3657                                                 &rest initargs
3658                                                 &key
3659                                                 &allow-other-keys))
3660
3661(defmethod update-instance-for-redefined-class ((instance standard-object)
3662            added-slots
3663            discarded-slots
3664            property-list
3665            &rest initargs)
3666  (check-initargs (list #'update-instance-for-redefined-class)
3667                  (list* instance added-slots discarded-slots
3668                         property-list initargs)
3669                  instance added-slots initargs
3670                  nil 'update-instance-for-redefined-class)
3671  (apply #'shared-initialize instance added-slots initargs))
3672
3673;;;  Methods having to do with class metaobjects.
3674
3675(defmethod initialize-instance :after ((class standard-class) &rest args)
3676  (apply #'std-after-initialization-for-classes class args))
3677
3678(defmethod initialize-instance :after ((class funcallable-standard-class)
3679                                       &rest args)
3680  (apply #'std-after-initialization-for-classes class args))
3681
3682(defmethod reinitialize-instance :before ((class standard-class)
3683                                          &key direct-superclasses
3684                                          &rest all-keys)
3685  (check-initargs (list #'allocate-instance
3686                        #'initialize-instance)
3687                  (list* class all-keys)
3688                  class t all-keys
3689                  nil 'reinitialize-instance)
3690  (dolist (superclass (set-difference (class-direct-superclasses class)
3691                                      direct-superclasses))
3692    (remove-direct-subclass superclass class))
3693  (dolist (superclass (set-difference direct-superclasses
3694                                      (class-direct-superclasses class)))
3695    (add-direct-subclass superclass class)))
3696
3697(defmethod reinitialize-instance :before ((class funcallable-standard-class)
3698                                          &key direct-superclasses
3699                                          &rest all-keys)
3700  (check-initargs (list #'allocate-instance
3701                        #'initialize-instance)
3702                  (list* class all-keys)
3703                  class t all-keys
3704                  nil 'reinitialize-instance)
3705  (dolist (superclass (set-difference (class-direct-superclasses class)
3706                                      direct-superclasses))
3707    (remove-direct-subclass superclass class))
3708  (dolist (superclass (set-difference direct-superclasses
3709                                      (class-direct-superclasses class)))
3710    (add-direct-subclass superclass class)))
3711
3712(defmethod reinitialize-instance :after ((class standard-class) &rest all-keys)
3713  (remhash class *make-instance-initargs-cache*)
3714  (remhash class *reinitialize-instance-initargs-cache*)
3715  (%make-instances-obsolete class)
3716  (setf (class-finalized-p class) nil)
3717  ;; KLUDGE (rudi 2012-06-17) this calls add-direct-subclass again
3718  (apply #'std-after-initialization-for-classes class all-keys)
3719  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3720
3721(defmethod reinitialize-instance :after ((class funcallable-standard-class)
3722                                         &rest all-keys)
3723  (remhash class *make-instance-initargs-cache*)
3724  (remhash class *reinitialize-instance-initargs-cache*)
3725  (%make-instances-obsolete class)
3726  (setf (class-finalized-p class) nil)
3727  ;; KLUDGE (rudi 2012-06-17) this calls add-direct-subclass again
3728  (apply #'std-after-initialization-for-classes class all-keys)
3729  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3730
3731(defmethod reinitialize-instance :after ((gf standard-generic-function)
3732                                         &rest all-keys)
3733  (map-dependents gf #'(lambda (dep) (update-dependent gf dep all-keys))))
3734
3735;;; Finalize inheritance
3736
3737(atomic-defgeneric finalize-inheritance (class)
3738    (:method ((class standard-class))
3739       (std-finalize-inheritance class))
3740    (:method ((class funcallable-standard-class))
3741       (std-finalize-inheritance class)))
3742
3743;;; Default initargs
3744
3745;;; AMOP pg. 174
3746(atomic-defgeneric compute-default-initargs (class)
3747  (:method ((class standard-class))
3748    (std-compute-default-initargs class))
3749  (:method ((class funcallable-standard-class))
3750    (std-compute-default-initargs class)))
3751
3752;;; Class precedence lists
3753
3754(defgeneric compute-class-precedence-list (class))
3755(defmethod compute-class-precedence-list ((class standard-class))
3756  (std-compute-class-precedence-list class))
3757(defmethod compute-class-precedence-list ((class funcallable-standard-class))
3758  (std-compute-class-precedence-list class))
3759
3760;;; Slot inheritance
3761
3762(defgeneric compute-slots (class))
3763(defmethod compute-slots ((class standard-class))
3764  (std-compute-slots class))
3765(defmethod compute-slots ((class funcallable-standard-class))
3766  (std-compute-slots class))
3767
3768(defgeneric compute-effective-slot-definition (class name direct-slots))
3769(defmethod compute-effective-slot-definition
3770  ((class standard-class) name direct-slots)
3771  (std-compute-effective-slot-definition class name direct-slots))
3772(defmethod compute-effective-slot-definition
3773  ((class funcallable-standard-class) name direct-slots)
3774  (std-compute-effective-slot-definition class name direct-slots))
3775
3776;;; Methods having to do with generic function invocation.
3777
3778(defgeneric compute-discriminating-function (gf))
3779(defmethod compute-discriminating-function ((gf standard-generic-function))
3780  (std-compute-discriminating-function gf))
3781
3782(defgeneric method-more-specific-p (gf method1 method2 required-classes))
3783
3784(defmethod method-more-specific-p ((gf standard-generic-function)
3785                                   method1 method2 required-classes)
3786  (let ((method-indices
3787         (argument-precedence-order-indices
3788          (generic-function-argument-precedence-order gf)
3789          (getf (analyze-lambda-list (generic-function-lambda-list gf))
3790                ':required-args))))
3791    (std-method-more-specific-p method1 method2 required-classes method-indices)))
3792
3793;;; AMOP pg. 176
3794(defgeneric compute-effective-method (gf method-combination methods))
3795(defmethod compute-effective-method ((gf standard-generic-function) method-combination methods)
3796  (std-compute-effective-method gf method-combination methods))
3797
3798(defgeneric compute-applicable-methods (gf args))
3799(defmethod compute-applicable-methods ((gf standard-generic-function) args)
3800  (%compute-applicable-methods gf args))
3801
3802;;; AMOP pg. 207
3803(atomic-defgeneric make-method-lambda (generic-function method lambda-expression environment)
3804  (:method ((generic-function standard-generic-function)
3805            (method standard-method)
3806            lambda-expression environment)
3807    (declare (ignore environment))
3808    (values (compute-method-function lambda-expression) nil)))
3809
3810
3811;;; Slot definition accessors
3812
3813(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
3814  `(let (($cl (class-of ,slot-definition)))
3815     (case $cl
3816       ((+the-standard-slot-definition-class+
3817         +the-standard-direct-slot-definition-class+
3818         +the-standard-effective-slot-definition-class+)
3819        ,std-form)
3820       (t ,generic-form))))
3821
3822(atomic-defgeneric slot-definition-allocation (slot-definition)
3823  (:method ((slot-definition slot-definition))
3824    (slot-definition-dispatch slot-definition
3825      (%slot-definition-allocation slot-definition)
3826      (slot-value slot-definition 'sys::allocation))))
3827
3828(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
3829  (:method (value (slot-definition slot-definition))
3830    (slot-definition-dispatch slot-definition
3831      (set-slot-definition-allocation slot-definition value)
3832      (setf (slot-value slot-definition 'sys::allocation) value))))
3833
3834(atomic-defgeneric slot-definition-initargs (slot-definition)
3835  (:method ((slot-definition slot-definition))
3836    (slot-definition-dispatch slot-definition
3837      (%slot-definition-initargs slot-definition)
3838      (slot-value slot-definition 'sys::initargs))))
3839
3840(atomic-defgeneric slot-definition-initform (slot-definition)
3841  (:method ((slot-definition slot-definition))
3842    (slot-definition-dispatch slot-definition
3843      (%slot-definition-initform slot-definition)
3844      (slot-value slot-definition 'sys::initform))))
3845
3846(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
3847  (:method (value (slot-definition slot-definition))
3848    (slot-definition-dispatch slot-definition
3849      (set-slot-definition-initform slot-definition value)
3850      (setf (slot-value slot-definition 'sys::initform) value))))
3851
3852(atomic-defgeneric slot-definition-initfunction (slot-definition)
3853  (:method ((slot-definition slot-definition))
3854    (slot-definition-dispatch slot-definition
3855      (%slot-definition-initfunction slot-definition)
3856      (slot-value slot-definition 'sys::initfunction))))
3857
3858(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
3859  (:method (value (slot-definition slot-definition))
3860    (slot-definition-dispatch slot-definition
3861      (set-slot-definition-initfunction slot-definition value)
3862      (setf (slot-value slot-definition 'sys::initfunction) value))))
3863
3864(atomic-defgeneric slot-definition-name (slot-definition)
3865  (:method ((slot-definition slot-definition))
3866    (slot-definition-dispatch slot-definition
3867      (%slot-definition-name slot-definition)
3868      (slot-value slot-definition 'sys::name))))
3869
3870(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
3871  (:method (value (slot-definition slot-definition))
3872    (slot-definition-dispatch slot-definition
3873      (set-slot-definition-name slot-definition value)
3874      (setf (slot-value slot-definition 'sys::name) value))))
3875
3876(atomic-defgeneric slot-definition-readers (slot-definition)
3877  (:method ((slot-definition slot-definition))
3878    (slot-definition-dispatch slot-definition
3879      (%slot-definition-readers slot-definition)
3880      (slot-value slot-definition 'sys::readers))))
3881
3882(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
3883  (:method (value (slot-definition slot-definition))
3884    (slot-definition-dispatch slot-definition
3885      (set-slot-definition-readers slot-definition value)
3886      (setf (slot-value slot-definition 'sys::readers) value))))
3887
3888(atomic-defgeneric slot-definition-writers (slot-definition)
3889  (:method ((slot-definition slot-definition))
3890    (slot-definition-dispatch slot-definition
3891      (%slot-definition-writers slot-definition)
3892      (slot-value slot-definition 'sys::writers))))
3893
3894(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
3895  (:method (value (slot-definition slot-definition))
3896    (slot-definition-dispatch slot-definition
3897      (set-slot-definition-writers slot-definition value)
3898      (setf (slot-value slot-definition 'sys::writers) value))))
3899
3900(atomic-defgeneric slot-definition-allocation-class (slot-definition)
3901  (:method ((slot-definition slot-definition))
3902    (slot-definition-dispatch slot-definition
3903      (%slot-definition-allocation-class slot-definition)
3904      (slot-value slot-definition 'sys::allocation-class))))
3905
3906(atomic-defgeneric (setf slot-definition-allocation-class)
3907                       (value slot-definition)
3908  (:method (value (slot-definition slot-definition))
3909    (slot-definition-dispatch slot-definition
3910      (set-slot-definition-allocation-class slot-definition value)
3911      (setf (slot-value slot-definition 'sys::allocation-class) value))))
3912
3913(atomic-defgeneric slot-definition-location (slot-definition)
3914  (:method ((slot-definition slot-definition))
3915    (slot-definition-dispatch slot-definition
3916      (%slot-definition-location slot-definition)
3917      (slot-value slot-definition 'sys::location))))
3918
3919(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
3920  (:method (value (slot-definition slot-definition))
3921    (slot-definition-dispatch slot-definition
3922      (set-slot-definition-location slot-definition value)
3923      (setf (slot-value slot-definition 'sys::location) value))))
3924
3925(atomic-defgeneric slot-definition-type (slot-definition)
3926  (:method ((slot-definition slot-definition))
3927    (slot-definition-dispatch slot-definition
3928      (%slot-definition-type slot-definition)
3929      (slot-value slot-definition 'sys::%type))))
3930
3931(atomic-defgeneric (setf slot-definition-type) (value slot-definition)
3932  (:method (value (slot-definition slot-definition))
3933    (slot-definition-dispatch slot-definition
3934      (set-slot-definition-type slot-definition value)
3935      (setf (slot-value slot-definition 'sys::%type) value))))
3936
3937(atomic-defgeneric slot-definition-documentation (slot-definition)
3938  (:method ((slot-definition slot-definition))
3939    (slot-definition-dispatch slot-definition
3940      (%slot-definition-documentation slot-definition)
3941      (slot-value slot-definition 'sys:%documentation))))
3942
3943(atomic-defgeneric (setf slot-definition-documentation) (value slot-definition)
3944  (:method (value (slot-definition slot-definition))
3945    (slot-definition-dispatch slot-definition
3946      (set-slot-definition-documentation slot-definition value)
3947      (setf (slot-value slot-definition 'sys:%documentation) value))))
3948
3949
3950;;; Conditions.
3951
3952(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
3953  (let ((parent-types (or parent-types '(condition)))
3954        (report nil))
3955    (dolist (option options)
3956      (when (eq (car option) :report)
3957        (setf report (cadr option))
3958  (setf options (delete option options :test #'equal))
3959        (return)))
3960    (typecase report
3961      (null
3962       `(progn
3963          (defclass ,name ,parent-types ,slot-specs ,@options)
3964          ',name))
3965      (string
3966       `(progn
3967          (defclass ,name ,parent-types ,slot-specs ,@options)
3968          (defmethod print-object ((condition ,name) stream)
3969            (if *print-escape*
3970                (call-next-method)
3971                (progn (write-string ,report stream) condition)))
3972          ',name))
3973      (t
3974       `(progn
3975          (defclass ,name ,parent-types ,slot-specs ,@options)
3976          (defmethod print-object ((condition ,name) stream)
3977            (if *print-escape*
3978                (call-next-method)
3979                (funcall #',report condition stream)))
3980          ',name)))))
3981
3982(defun make-condition (type &rest initargs)
3983  (or (%make-condition type initargs)
3984      (let ((class (if (symbolp type) (find-class type) type)))
3985        (apply #'make-instance class initargs))))
3986
3987;; Adapted from SBCL.
3988;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
3989(defun coerce-to-condition (datum arguments default-type fun-name)
3990  (cond ((typep datum 'condition)
3991         (when arguments
3992           (error 'simple-type-error
3993                  :datum arguments
3994                  :expected-type 'null
3995                  :format-control "You may not supply additional arguments when giving ~S to ~S."
3996                  :format-arguments (list datum fun-name)))
3997         datum)
3998        ((symbolp datum)
3999         (apply #'make-condition datum arguments))
4000        ((or (stringp datum) (functionp datum))
4001         (make-condition default-type
4002                         :format-control datum
4003                         :format-arguments arguments))
4004        (t
4005         (error 'simple-type-error
4006                :datum datum
4007                :expected-type '(or symbol string)
4008                :format-control "Bad argument to ~S: ~S."
4009                :format-arguments (list fun-name datum)))))
4010
4011(defgeneric make-load-form (object &optional environment))
4012
4013(defmethod make-load-form ((object t) &optional environment)
4014  (declare (ignore environment))
4015  (apply #'no-applicable-method #'make-load-form (list object)))
4016
4017(defmethod make-load-form ((class class) &optional environment)
4018  (declare (ignore environment))
4019  (let ((name (class-name class)))
4020    (unless (and name (eq (find-class name nil) class))
4021      (error 'simple-type-error
4022             :format-control "Can't use anonymous or undefined class as a constant: ~S."
4023             :format-arguments (list class)))
4024    `(find-class ',name)))
4025
4026(defun invalid-method-error (method format-control &rest args)
4027  (let ((message (apply #'format nil format-control args)))
4028    (error "Invalid method error for ~S:~%    ~A" method message)))
4029
4030(defun method-combination-error (format-control &rest args)
4031  (let ((message (apply #'format nil format-control args)))
4032    (error "Method combination error in CLOS dispatch:~%    ~A" message)))
4033
4034
4035(atomic-defgeneric no-applicable-method (generic-function &rest args)
4036  (:method (generic-function &rest args)
4037      (error "There is no applicable method for the generic function ~S ~
4038              when called with arguments ~S."
4039             generic-function
4040             args)))
4041
4042
4043;;; FIXME (rudi 2012-01-28): this can be a function, it only needs to
4044;;; use standard accessor functions
4045(defgeneric find-method (generic-function
4046                         qualifiers
4047                         specializers
4048                         &optional errorp))
4049
4050(defmethod find-method ((generic-function standard-generic-function)
4051                        qualifiers specializers &optional (errorp t))
4052  (%find-method generic-function qualifiers specializers errorp))
4053
4054(defgeneric find-method ((generic-function symbol)
4055                         qualifiers specializers &optional (errorp t))
4056  (find-method (find-generic-function generic-function errorp)
4057               qualifiers specializers errorp))
4058
4059;;; AMOP pg. 167
4060(defgeneric add-method (generic-function method))
4061
4062(defmethod add-method :before ((generic-function generic-function)
4063                               (method method))
4064  (when (and (method-generic-function method)
4065             (not (eql generic-function (method-generic-function method))))
4066    (error 'simple-error
4067           :format-control "~S is already a method of ~S, cannot add to ~S."
4068           :format-arguments (list method (method-generic-function method)
4069                                   generic-function)))
4070  (check-method-lambda-list (generic-function-name generic-function)
4071                            (method-lambda-list method)
4072                            (generic-function-lambda-list generic-function)))
4073
4074(defmethod add-method ((generic-function standard-generic-function)
4075                       (method standard-method))
4076  (std-add-method generic-function method))
4077
4078(defmethod add-method :after ((generic-function generic-function)
4079                              (method method))
4080  (map-dependents generic-function
4081                  #'(lambda (dep) (update-dependent generic-function dep
4082                                                    'add-method method))))
4083
4084(defgeneric remove-method (generic-function method))
4085
4086(defmethod remove-method ((generic-function standard-generic-function)
4087                          (method standard-method))
4088  (std-remove-method generic-function method))
4089
4090(defmethod remove-method :after ((generic-function generic-function)
4091                                 (method method))
4092  (map-dependents generic-function
4093                  #'(lambda (dep) (update-dependent generic-function dep
4094                                                    'remove-method method))))
4095
4096;; See describe.lisp.
4097(defgeneric describe-object (object stream))
4098
4099;; FIXME
4100(defgeneric no-next-method (generic-function method &rest args))
4101
4102(atomic-defgeneric function-keywords (method)
4103  (:method ((method standard-method))
4104    (std-function-keywords method)))
4105
4106(setf *gf-initialize-instance* (symbol-function 'initialize-instance))
4107(setf *gf-allocate-instance* (symbol-function 'allocate-instance))
4108(setf *gf-shared-initialize* (symbol-function 'shared-initialize))
4109(setf *gf-reinitialize-instance* (symbol-function 'reinitialize-instance))
4110(setf *clos-booting* nil)
4111
4112(atomic-defgeneric class-prototype (class)
4113  (:method ((class standard-class))
4114    (allocate-instance class))
4115  (:method ((class funcallable-standard-class))
4116    (allocate-instance class))
4117  (:method ((class structure-class))
4118    (allocate-instance class))
4119  (:method :before (class)
4120    (unless (class-finalized-p class)
4121      (error "~@<~S is not finalized.~:@>" class))))
4122
4123
4124
4125
4126
4127(defmethod shared-initialize :before ((instance generic-function)
4128                                      slot-names
4129                                      &key lambda-list argument-precedence-order
4130                                      &allow-other-keys)
4131  (check-argument-precedence-order lambda-list argument-precedence-order))
4132
4133(defmethod shared-initialize :after ((instance standard-generic-function)
4134                                     slot-names
4135                                     &key lambda-list argument-precedence-order
4136                                     &allow-other-keys)
4137  (let* ((plist (analyze-lambda-list lambda-list))
4138         (required-args (getf plist ':required-args)))
4139    (%set-gf-required-args instance required-args)
4140    (%set-gf-optional-args instance (getf plist :optional-args))
4141    (set-generic-function-argument-precedence-order
4142     instance (or argument-precedence-order required-args)))
4143  (when (eq (generic-function-method-combination instance) 'standard)
4144    ;; fix up "naked" (make-instance 'standard-generic-function) -- gfs
4145    ;; created via defgeneric have that slot initalized properly
4146    (set-generic-function-method-combination instance
4147                                             +the-standard-method-combination+))
4148  (finalize-standard-generic-function instance))
4149
4150;;; Readers for generic function metaobjects
4151;;; AMOP pg. 216ff.
4152(atomic-defgeneric generic-function-argument-precedence-order (generic-function)
4153  (:method ((generic-function standard-generic-function))
4154    (sys:%generic-function-argument-precedence-order generic-function)))
4155
4156(atomic-defgeneric generic-function-declarations (generic-function)
4157  (:method ((generic-function standard-generic-function))
4158    (sys:%generic-function-declarations generic-function)))
4159
4160(atomic-defgeneric generic-function-lambda-list (generic-function)
4161  (:method ((generic-function standard-generic-function))
4162    (sys:%generic-function-lambda-list generic-function)))
4163
4164(atomic-defgeneric generic-function-method-class (generic-function)
4165  (:method ((generic-function standard-generic-function))
4166    (sys:%generic-function-method-class generic-function)))
4167
4168(atomic-defgeneric generic-function-method-combination (generic-function)
4169  (:method ((generic-function standard-generic-function))
4170    (sys:%generic-function-method-combination generic-function)))
4171
4172(atomic-defgeneric generic-function-methods (generic-function)
4173  (:method ((generic-function standard-generic-function))
4174    (sys:%generic-function-methods generic-function)))
4175
4176(atomic-defgeneric generic-function-name (generic-function)
4177  (:method ((generic-function standard-generic-function))
4178    (sys:%generic-function-name generic-function)))
4179
4180;;; AMOP pg. 231
4181(defgeneric (setf generic-function-name) (new-value gf)
4182  (:method (new-value (gf generic-function))
4183    (reinitialize-instance gf :name new-value)))
4184
4185;;; Readers for Method Metaobjects
4186;;; AMOP pg. 218ff.
4187
4188(atomic-defgeneric method-function (method)
4189  (:method ((method standard-method))
4190    (std-method-function method)))
4191
4192(atomic-defgeneric method-generic-function (method)
4193  (:method ((method standard-method))
4194    (std-method-generic-function method)))
4195
4196(atomic-defgeneric method-lambda-list (method)
4197  (:method ((method standard-method))
4198    (std-slot-value method 'sys::lambda-list)))
4199
4200(atomic-defgeneric method-specializers (method)
4201  (:method ((method standard-method))
4202    (std-method-specializers method)))
4203
4204(atomic-defgeneric method-qualifiers (method)
4205  (:method ((method standard-method))
4206    (std-method-qualifiers method)))
4207
4208(atomic-defgeneric accessor-method-slot-definition (method)
4209  (:method ((method standard-accessor-method))
4210    (std-accessor-method-slot-definition method)))
4211
4212
4213;;; find-method-combination
4214
4215;;; AMOP pg. 191
4216(atomic-defgeneric find-method-combination (gf name options)
4217  (:method (gf (name symbol) options)
4218    (std-find-method-combination gf name options)))
4219
4220;;; specializer-direct-method and friends.
4221
4222;;; AMOP pg. 237
4223(defgeneric specializer-direct-generic-functions (specializer))
4224
4225(defmethod specializer-direct-generic-functions ((specializer class))
4226  (delete-duplicates (mapcar #'method-generic-function
4227                             (class-direct-methods specializer))))
4228
4229(defmethod specializer-direct-generic-functions ((specializer eql-specializer))
4230  (delete-duplicates (mapcar #'method-generic-function
4231                             (slot-value specializer 'direct-methods))))
4232
4233;;; AMOP pg. 238
4234(defgeneric specializer-direct-methods (specializer))
4235
4236(defmethod specializer-direct-methods ((specializer class))
4237  (class-direct-methods specializer))
4238
4239(defmethod specializer-direct-methods ((specializer eql-specializer))
4240  (slot-value specializer 'direct-methods))
4241
4242;;; AMOP pg. 165
4243(atomic-defgeneric add-direct-method (specializer method)
4244  (:method ((specializer class) (method method))
4245    (pushnew method (class-direct-methods specializer)))
4246  (:method ((specializer eql-specializer) (method method))
4247    (pushnew method (slot-value specializer 'direct-methods))))
4248
4249
4250;;; AMOP pg. 227
4251(atomic-defgeneric remove-direct-method (specializer method)
4252  (:method ((specializer class) (method method))
4253    (setf (class-direct-methods specializer)
4254          (remove method (class-direct-methods specializer))))
4255  (:method ((specializer eql-specializer) (method method))
4256    (setf (slot-value specializer 'direct-methods)
4257          (remove method (slot-value specializer 'direct-methods)))))
4258
4259;;; The Dependent Maintenance Protocol (AMOP pg. 160ff.)
4260
4261(defvar *dependents* (make-hash-table :test 'eq :weakness :key))
4262
4263;;; AMOP pg. 164
4264(defgeneric add-dependent (metaobject dependent))
4265(defmethod add-dependent ((metaobject standard-class) dependent)
4266  (pushnew dependent (gethash metaobject *dependents* nil)))
4267(defmethod add-dependent ((metaobject funcallable-standard-class) dependent)
4268  (pushnew dependent (gethash metaobject *dependents* nil)))
4269(defmethod add-dependent ((metaobject standard-generic-function) dependent)
4270  (pushnew dependent (gethash metaobject *dependents* nil)))
4271
4272;;; AMOP pg. 225
4273(defgeneric remove-dependent (metaobject dependent))
4274(defmethod remove-dependent ((metaobject standard-class) dependent)
4275  (setf (gethash metaobject *dependents*)
4276        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4277(defmethod remove-dependent ((metaobject funcallable-standard-class) dependent)
4278  (setf (gethash metaobject *dependents*)
4279        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4280(defmethod remove-dependent ((metaobject standard-generic-function) dependent)
4281  (setf (gethash metaobject *dependents*)
4282        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4283
4284;;; AMOP pg. 210
4285(atomic-defgeneric map-dependents (metaobject function)
4286  (:method ((metaobject standard-class) function)
4287    (dolist (dependent (gethash metaobject *dependents* nil))
4288      (funcall function dependent)))
4289  (:method ((metaobject funcallable-standard-class) function)
4290    (dolist (dependent (gethash metaobject *dependents* nil))
4291      (funcall function dependent)))
4292  (:method ((metaobject standard-generic-function) function)
4293    (dolist (dependent (gethash metaobject *dependents* nil))
4294      (funcall function dependent))))
4295
4296;;; AMOP pg. 239
4297(defgeneric update-dependent (metaobject dependent &rest initargs))
4298
4299
4300;;; ensure-generic-function(-using-class), AMOP pg. 185ff.
4301(defgeneric ensure-generic-function-using-class (generic-function function-name
4302                                                 &key
4303                                                   argument-precedence-order
4304                                                   declarations documentation
4305                                                   generic-function-class
4306                                                   lambda-list method-class
4307                                                   method-combination
4308                                                   name
4309                                                 &allow-other-keys))
4310
4311(defmethod ensure-generic-function-using-class ((generic-function generic-function)
4312                                                function-name
4313                                                &rest all-keys
4314                                                &key (generic-function-class +the-standard-generic-function-class+)
4315                                                  lambda-list
4316                                                  (method-class +the-standard-method-class+)
4317                                                  (method-combination +the-standard-method-combination+)
4318                                                &allow-other-keys)
4319  (setf all-keys (copy-list all-keys))  ; since we modify it
4320  (remf all-keys :generic-function-class)
4321  (unless (classp generic-function-class)
4322    (setf generic-function-class (find-class generic-function-class)))
4323  (unless (classp method-class) (setf method-class (find-class method-class)))
4324  (unless (eq generic-function-class (class-of generic-function))
4325    (error "The class ~S is incompatible with the existing class of ~S."
4326           generic-function-class generic-function))
4327  (unless (or (null (generic-function-methods generic-function))
4328              (lambda-lists-congruent-p lambda-list (generic-function-lambda-list generic-function)))
4329    (error "The lambda list ~S is incompatible with the existing methods of ~S."
4330           lambda-list generic-function))
4331  (unless (or (null (generic-function-methods generic-function))
4332              (eq method-class (generic-function-method-class generic-function)))
4333    (error "The method class ~S is incompatible with the existing methods of ~S."
4334           method-class generic-function))
4335  (unless (typep method-combination 'method-combination)
4336    (setf method-combination
4337          (find-method-combination generic-function
4338                                   (car method-combination)
4339                                   (cdr method-combination))))
4340  (apply #'reinitialize-instance generic-function
4341         :method-combination method-combination
4342         :method-class method-class
4343         all-keys)
4344  generic-function)
4345
4346(defmethod ensure-generic-function-using-class ((generic-function null)
4347                                                function-name
4348                                                &rest all-keys
4349                                                &key (generic-function-class +the-standard-generic-function-class+)
4350                                                  (method-class +the-standard-method-class+)
4351                                                  (method-combination +the-standard-method-combination+)
4352                                                &allow-other-keys)
4353  (setf all-keys (copy-list all-keys))  ; since we modify it
4354  (remf all-keys :generic-function-class)
4355  (unless (classp generic-function-class)
4356    (setf generic-function-class (find-class generic-function-class)))
4357  (unless (classp method-class) (setf method-class (find-class method-class)))
4358  (unless (typep method-combination 'method-combination)
4359    (setf method-combination
4360          (find-method-combination (class-prototype generic-function-class)
4361                                   (car method-combination)
4362                                   (cdr method-combination))))
4363  (when (and (null *clos-booting*) (fboundp function-name))
4364    (if (autoloadp function-name)
4365        (fmakunbound function-name)
4366        (error 'program-error
4367               :format-control "~A already names an ordinary function, macro, or special operator."
4368               :format-arguments (list function-name))))
4369  (apply (if (eq generic-function-class +the-standard-generic-function-class+)
4370             #'make-instance-standard-generic-function
4371             #'make-instance)
4372         generic-function-class
4373         :name function-name
4374         :method-class method-class
4375         :method-combination method-combination
4376         all-keys))
4377
4378(defun ensure-generic-function (function-name &rest all-keys
4379                                &key
4380                                  lambda-list generic-function-class
4381                                  method-class
4382                                  method-combination
4383                                  argument-precedence-order
4384                                  declarations
4385                                  documentation
4386                                &allow-other-keys)
4387  (declare (ignore lambda-list generic-function-class method-class
4388                   method-combination argument-precedence-order declarations
4389                   documentation))
4390  (apply #'ensure-generic-function-using-class
4391         (find-generic-function function-name nil)
4392         function-name all-keys))
4393
4394;;; SLIME compatibility functions.
4395
4396(defun %method-generic-function (method)
4397  (method-generic-function method))
4398
4399(defun %method-function (method)
4400  (method-function method))
4401
4402(eval-when (:compile-toplevel :load-toplevel :execute)
4403  (require "MOP"))
4404
4405(provide 'clos)
4406
Note: See TracBrowser for help on using the repository browser.