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

Last change on this file since 13977 was 13977, checked in by rschlatte, 10 years ago

Properly call remove-direct-method on class redefinition

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