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

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

Don't defer compute-discriminating-function

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 188.3 KB
Line 
1;;; clos.lisp
2;;;
3;;; Copyright (C) 2003-2007 Peter Graves
4;;; Copyright (C) 2010 Mark Evenson
5;;; $Id: clos.lisp 13978 2012-06-18 16:32:48Z 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 collect-eql-specializer-objects (generic-function)
1578  (let ((result nil))
1579    (dolist (method (generic-function-methods generic-function))
1580      (dolist (specializer (method-specializers method))
1581        (when (typep specializer 'eql-specializer)
1582          (pushnew (eql-specializer-object specializer)
1583                   result
1584                   :test 'eql))))
1585    result))
1586
1587(defun finalize-standard-generic-function (gf)
1588  (%finalize-generic-function gf)
1589  (unless (generic-function-classes-to-emf-table gf)
1590    (set-generic-function-classes-to-emf-table gf (make-hash-table :test #'equal)))
1591  (clrhash (generic-function-classes-to-emf-table gf))
1592  (%init-eql-specializations gf (collect-eql-specializer-objects gf))
1593  (set-funcallable-instance-function
1594   gf
1595   (if (eq (class-of gf) +the-standard-generic-function-class+)
1596       (std-compute-discriminating-function gf)
1597       (compute-discriminating-function gf)))
1598  ;; FIXME Do we need to warn on redefinition somewhere else?
1599  (let ((*warn-on-redefinition* nil))
1600    (setf (fdefinition (%generic-function-name gf)) gf))
1601  (values))
1602
1603(defun make-instance-standard-generic-function (generic-function-class
1604                                                &key name lambda-list
1605                                                method-class
1606                                                method-combination
1607                                                argument-precedence-order
1608                                                declarations
1609                                                documentation)
1610  ;; to avoid circularities, we do not call generic functions in here.
1611  (declare (ignore generic-function-class))
1612  (check-argument-precedence-order lambda-list argument-precedence-order)
1613  (let ((gf (std-allocate-instance +the-standard-generic-function-class+)))
1614    (%set-generic-function-name gf name)
1615    (%set-generic-function-lambda-list gf lambda-list)
1616    (set-generic-function-initial-methods gf ())
1617    (set-generic-function-methods gf ())
1618    (set-generic-function-method-class gf method-class)
1619    (set-generic-function-method-combination gf method-combination)
1620    (set-generic-function-declarations gf declarations)
1621    (set-generic-function-documentation gf documentation)
1622    (set-generic-function-classes-to-emf-table gf nil)
1623    (let* ((plist (analyze-lambda-list (generic-function-lambda-list gf)))
1624           (required-args (getf plist ':required-args)))
1625      (%set-gf-required-args gf required-args)
1626      (%set-gf-optional-args gf (getf plist :optional-args))
1627      (set-generic-function-argument-precedence-order
1628       gf (or argument-precedence-order required-args)))
1629    (finalize-standard-generic-function gf)
1630    gf))
1631
1632(defun canonicalize-specializers (specializers)
1633  (mapcar #'canonicalize-specializer specializers))
1634
1635(defun canonicalize-specializer (specializer)
1636  (cond ((classp specializer)
1637         specializer)
1638        ((typep specializer 'eql-specializer)
1639         specializer)
1640        ((symbolp specializer)
1641         (find-class specializer))
1642        ((and (consp specializer)
1643              (eq (car specializer) 'eql))
1644         (let ((object (cadr specializer)))
1645           (when (and (consp object)
1646                      (eq (car object) 'quote))
1647             (setf object (cadr object)))
1648           (intern-eql-specializer object)))
1649        ((and (consp specializer)
1650              (eq (car specializer) 'java:jclass))
1651         (let ((jclass (eval specializer)))
1652           (java::ensure-java-class jclass)))
1653        (t
1654         (error "Unknown specializer: ~S" specializer))))
1655
1656(defun parse-defmethod (args)
1657  (let ((function-name (car args))
1658        (qualifiers ())
1659        (specialized-lambda-list ())
1660        (body ())
1661        (parse-state :qualifiers))
1662    (dolist (arg (cdr args))
1663      (ecase parse-state
1664        (:qualifiers
1665         (if (and (atom arg) (not (null arg)))
1666             (push arg qualifiers)
1667             (progn
1668               (setf specialized-lambda-list arg)
1669               (setf parse-state :body))))
1670        (:body (push arg body))))
1671    (setf qualifiers (nreverse qualifiers)
1672          body (nreverse body))
1673    (multiple-value-bind (real-body declarations documentation)
1674        (parse-body body)
1675      (values function-name
1676              qualifiers
1677              (extract-lambda-list specialized-lambda-list)
1678              (extract-specializer-names specialized-lambda-list)
1679              documentation
1680              declarations
1681              (list* 'block
1682                     (fdefinition-block-name function-name)
1683                     real-body)))))
1684
1685(defun required-portion (gf args)
1686  (let ((number-required (length (gf-required-args gf))))
1687    (when (< (length args) number-required)
1688      (error 'program-error
1689             :format-control "Not enough arguments for generic function ~S."
1690             :format-arguments (list (%generic-function-name gf))))
1691    (subseq args 0 number-required)))
1692
1693(defun extract-lambda-list (specialized-lambda-list)
1694  (let* ((plist (analyze-lambda-list specialized-lambda-list))
1695         (requireds (getf plist :required-names))
1696         (rv (getf plist :rest-var))
1697         (ks (getf plist :key-args))
1698         (keysp (getf plist :keysp))
1699         (aok (getf plist :allow-other-keys))
1700         (opts (getf plist :optional-args))
1701         (auxs (getf plist :auxiliary-args)))
1702    `(,@requireds
1703      ,@(if rv `(&rest ,rv) ())
1704      ,@(if (or ks keysp aok) `(&key ,@ks) ())
1705      ,@(if aok '(&allow-other-keys) ())
1706      ,@(if opts `(&optional ,@opts) ())
1707      ,@(if auxs `(&aux ,@auxs) ()))))
1708
1709(defun extract-specializer-names (specialized-lambda-list)
1710  (let ((plist (analyze-lambda-list specialized-lambda-list)))
1711    (getf plist ':specializers)))
1712
1713(defun get-keyword-from-arg (arg)
1714  (if (listp arg)
1715      (if (listp (car arg))
1716          (caar arg)
1717          (make-keyword (car arg)))
1718      (make-keyword arg)))
1719
1720(defun analyze-lambda-list (lambda-list)
1721  (let ((keys ())           ; Just the keywords
1722        (key-args ())       ; Keywords argument specs
1723        (keysp nil)         ;
1724        (required-names ()) ; Just the variable names
1725        (required-args ())  ; Variable names & specializers
1726        (specializers ())   ; Just the specializers
1727        (rest-var nil)
1728        (optionals ())
1729        (auxs ())
1730        (allow-other-keys nil)
1731        (state :parsing-required))
1732    (dolist (arg lambda-list)
1733      (if (member arg lambda-list-keywords)
1734          (ecase arg
1735            (&optional
1736             (setq state :parsing-optional))
1737            (&rest
1738             (setq state :parsing-rest))
1739            (&key
1740             (setq keysp t)
1741             (setq state :parsing-key))
1742            (&allow-other-keys
1743             (setq allow-other-keys 't))
1744            (&aux
1745             (setq state :parsing-aux)))
1746          (case state
1747            (:parsing-required
1748             (push-on-end arg required-args)
1749             (if (listp arg)
1750                 (progn (push-on-end (car arg) required-names)
1751                   (push-on-end (cadr arg) specializers))
1752                 (progn (push-on-end arg required-names)
1753                   (push-on-end 't specializers))))
1754            (:parsing-optional (push-on-end arg optionals))
1755            (:parsing-rest (setq rest-var arg))
1756            (:parsing-key
1757             (push-on-end (get-keyword-from-arg arg) keys)
1758             (push-on-end arg key-args))
1759            (:parsing-aux (push-on-end arg auxs)))))
1760    (list  :required-names required-names
1761           :required-args required-args
1762           :specializers specializers
1763           :rest-var rest-var
1764           :keywords keys
1765           :key-args key-args
1766           :keysp keysp
1767           :auxiliary-args auxs
1768           :optional-args optionals
1769           :allow-other-keys allow-other-keys)))
1770
1771#+nil
1772(defun check-method-arg-info (gf arg-info method)
1773  (multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
1774      (analyze-lambda-list (if (consp method)
1775                               (early-method-lambda-list method)
1776                               (method-lambda-list method)))
1777    (flet ((lose (string &rest args)
1778                 (error 'simple-program-error
1779                        :format-control "~@<attempt to add the method~2I~_~S~I~_~
1780                        to the generic function~2I~_~S;~I~_~
1781                        but ~?~:>"
1782                        :format-arguments (list method gf string args)))
1783           (comparison-description (x y)
1784                                   (if (> x y) "more" "fewer")))
1785      (let ((gf-nreq (arg-info-number-required arg-info))
1786            (gf-nopt (arg-info-number-optional arg-info))
1787            (gf-key/rest-p (arg-info-key/rest-p arg-info))
1788            (gf-keywords (arg-info-keys arg-info)))
1789        (unless (= nreq gf-nreq)
1790          (lose
1791           "the method has ~A required arguments than the generic function."
1792           (comparison-description nreq gf-nreq)))
1793        (unless (= nopt gf-nopt)
1794          (lose
1795           "the method has ~A optional arguments than the generic function."
1796           (comparison-description nopt gf-nopt)))
1797        (unless (eq (or keysp restp) gf-key/rest-p)
1798          (lose
1799           "the method and generic function differ in whether they accept~_~
1800            &REST or &KEY arguments."))
1801        (when (consp gf-keywords)
1802          (unless (or (and restp (not keysp))
1803                      allow-other-keys-p
1804                      (every (lambda (k) (memq k keywords)) gf-keywords))
1805            (lose "the method does not accept each of the &KEY arguments~2I~_~
1806            ~S."
1807                  gf-keywords)))))))
1808
1809(defun check-method-lambda-list (name method-lambda-list gf-lambda-list)
1810  (let* ((gf-restp (not (null (memq '&rest gf-lambda-list))))
1811         (gf-plist (analyze-lambda-list gf-lambda-list))
1812         (gf-keysp (getf gf-plist :keysp))
1813         (gf-keywords (getf gf-plist :keywords))
1814         (method-plist (analyze-lambda-list method-lambda-list))
1815         (method-restp (not (null (memq '&rest method-lambda-list))))
1816         (method-keysp (getf method-plist :keysp))
1817         (method-keywords (getf method-plist :keywords))
1818         (method-allow-other-keys-p (getf method-plist :allow-other-keys)))
1819    (unless (= (length (getf gf-plist :required-args))
1820               (length (getf method-plist :required-args)))
1821      (error "The method-lambda-list ~S ~
1822              has the wrong number of required arguments ~
1823              for the generic function ~S." method-lambda-list name))
1824    (unless (= (length (getf gf-plist :optional-args))
1825               (length (getf method-plist :optional-args)))
1826      (error "The method-lambda-list ~S ~
1827              has the wrong number of optional arguments ~
1828              for the generic function ~S." method-lambda-list name))
1829    (unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
1830      (error "The method-lambda-list ~S ~
1831              and the generic function ~S ~
1832              differ in whether they accept &REST or &KEY arguments."
1833             method-lambda-list name))
1834    (when (consp gf-keywords)
1835      (unless (or (and method-restp (not method-keysp))
1836                  method-allow-other-keys-p
1837                  (every (lambda (k) (memq k method-keywords)) gf-keywords))
1838        (error "The method-lambda-list ~S does not accept ~
1839                all of the keyword arguments defined for the ~
1840                generic function." method-lambda-list name)))))
1841
1842(defun check-argument-precedence-order (lambda-list argument-precedence-order)
1843  (when argument-precedence-order
1844    (if lambda-list
1845        ;; raising the required program-errors is a side-effect of
1846        ;; calculating the given permutation of apo vs req
1847        (argument-precedence-order-indices
1848         argument-precedence-order
1849         (getf (analyze-lambda-list lambda-list) :required-args))
1850        ;; AMOP pg. 198
1851        (error 'program-error "argument precedence order specified without lambda list"))))
1852
1853(defvar *gf-initialize-instance* nil
1854  "Cached value of the INITIALIZE-INSTANCE generic function.
1855Initialized with the true value near the end of the file.")
1856(defvar *gf-allocate-instance* nil
1857  "Cached value of the ALLOCATE-INSTANCE generic function.
1858Initialized with the true value near the end of the file.")
1859(defvar *gf-shared-initialize* nil
1860  "Cached value of the SHARED-INITIALIZE generic function.
1861Initialized with the true value near the end of the file.")
1862(defvar *gf-reinitialize-instance* nil
1863  "Cached value of the REINITIALIZE-INSTANCE generic function.
1864Initialized with the true value near the end of the file.")
1865
1866(declaim (ftype (function * method) ensure-method))
1867(defun ensure-method (name &rest all-keys)
1868  (let ((method-lambda-list (getf all-keys :lambda-list))
1869        (gf (find-generic-function name nil)))
1870    (when (or (eq gf *gf-initialize-instance*)
1871              (eq gf *gf-allocate-instance*)
1872              (eq gf *gf-shared-initialize*)
1873              (eq gf *gf-reinitialize-instance*))
1874      ;; ### Clearly, this can be targeted much more exact
1875      ;; as we only need to remove the specializing class and all
1876      ;; its subclasses from the hash.
1877      (clrhash *make-instance-initargs-cache*)
1878      (clrhash *reinitialize-instance-initargs-cache*))
1879    (if gf
1880        (check-method-lambda-list name method-lambda-list
1881                                  (generic-function-lambda-list gf))
1882        (setf gf (ensure-generic-function name :lambda-list method-lambda-list)))
1883    (let ((method
1884           (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1885               (apply #'make-instance-standard-method gf all-keys)
1886               (apply #'make-instance (generic-function-method-class gf) all-keys))))
1887      (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1888          (progn
1889            (std-add-method gf method)
1890            (map-dependents gf
1891                            #'(lambda (dep)
1892                                (update-dependent gf dep 'add-method method))))
1893          (add-method gf method))
1894      method)))
1895
1896(defun make-instance-standard-method (gf
1897                                      &key
1898                                      lambda-list
1899                                      qualifiers
1900                                      specializers
1901                                      documentation
1902                                      function
1903                                      fast-function)
1904  (declare (ignore gf))
1905  (let ((method (std-allocate-instance +the-standard-method-class+))
1906        (analyzed-args (analyze-lambda-list lambda-list)))
1907    (setf (method-lambda-list method) lambda-list)
1908    (setf (method-qualifiers method) qualifiers)
1909    (setf (std-slot-value method 'sys::specializers)
1910          (canonicalize-specializers specializers))
1911    (setf (method-documentation method) documentation)
1912    (setf (std-slot-value method 'sys::%generic-function) nil) ; set by add-method
1913    (setf (std-slot-value method 'sys::%function) function)
1914    (setf (std-slot-value method 'sys::fast-function) fast-function)
1915    (setf (std-slot-value method 'sys::keywords) (getf analyzed-args :keywords))
1916    (setf (std-slot-value method 'sys::other-keywords-p)
1917          (getf analyzed-args :allow-other-keys))
1918    method))
1919
1920;;; To be redefined as generic functions later
1921(declaim (notinline add-direct-method))
1922(defun add-direct-method (specializer method)
1923  (if (typep specializer 'eql-specializer)
1924      (pushnew method (std-slot-value specializer 'direct-methods))
1925      (pushnew method (class-direct-methods specializer))))
1926
1927(declaim (notinline remove-direct-method))
1928(defun remove-direct-method (specializer method)
1929  (if (typep specializer 'eql-specializer)
1930      (setf (std-slot-value specializer 'direct-methods)
1931            (remove method (std-slot-value specializer 'direct-methods)))
1932      (setf (class-direct-methods specializer)
1933            (remove method (class-direct-methods specializer)))))
1934
1935(defun std-add-method (gf method)
1936  ;; calls sites need to make sure that method is either a method of the
1937  ;; given gf or does not have a gf.
1938  (let ((old-method (%find-method gf (std-method-qualifiers method)
1939                                 (method-specializers method) nil)))
1940    (when old-method
1941      (if (and (eq (class-of gf) +the-standard-generic-function-class+)
1942               (eq (class-of old-method) +the-standard-method-class+))
1943          (std-remove-method gf old-method)
1944          (remove-method gf old-method))))
1945  (setf (std-slot-value method 'sys::%generic-function) gf)
1946  (push method (generic-function-methods gf))
1947  (dolist (specializer (method-specializers method))
1948    (add-direct-method specializer method))
1949  (finalize-standard-generic-function gf)
1950  gf)
1951
1952(defun std-remove-method (gf method)
1953  (setf (generic-function-methods gf)
1954        (remove method (generic-function-methods gf)))
1955  (setf (std-slot-value method 'sys::%generic-function) nil)
1956  (dolist (specializer (method-specializers method))
1957    (remove-direct-method specializer method))
1958  (finalize-standard-generic-function gf)
1959  gf)
1960
1961(defun %find-method (gf qualifiers specializers &optional (errorp t))
1962  ;; "If the specializers argument does not correspond in length to the number
1963  ;; of required arguments of the generic-function, an an error of type ERROR
1964  ;; is signaled."
1965  (unless (= (length specializers) (length (gf-required-args gf)))
1966    (error "The specializers argument has length ~S, but ~S has ~S required parameters."
1967           (length specializers)
1968           gf
1969           (length (gf-required-args gf))))
1970  (let* ((canonical-specializers (canonicalize-specializers specializers))
1971         (method
1972          (find-if #'(lambda (method)
1973                      (and (equal qualifiers
1974                                  (method-qualifiers method))
1975                           (equal canonical-specializers
1976                                  (method-specializers method))))
1977                   (generic-function-methods gf))))
1978    (if (and (null method) errorp)
1979        (error "No such method for ~S." (%generic-function-name gf))
1980        method)))
1981
1982(defun fast-callable-p (gf)
1983  (and (eq (generic-function-method-combination gf) 'standard)
1984       (null (intersection (%generic-function-lambda-list gf)
1985                           '(&rest &optional &key &allow-other-keys &aux)))))
1986
1987(declaim (ftype (function * t) slow-method-lookup-1))
1988
1989(declaim (ftype (function (t t t) t) slow-reader-lookup))
1990(defun slow-reader-lookup (gf layout slot-name)
1991  (let ((location (layout-slot-location layout slot-name)))
1992    (cache-slot-location gf layout location)
1993    location))
1994
1995(defun std-compute-discriminating-function (gf)
1996  ;; In this function, we know that gf is of class
1997  ;; standard-generic-function, so we call various
1998  ;; sys:%generic-function-foo readers to break circularities.
1999  ;; (rudi 2012-01-27): maybe we need to discriminate between
2000  ;; standard-methods and methods as well.
2001  (cond
2002    ((and (= (length (sys:%generic-function-methods gf)) 1)
2003          (typep (car (sys:%generic-function-methods gf)) 'standard-reader-method))
2004     (let* ((method (%car (sys:%generic-function-methods gf)))
2005            (class (car (std-method-specializers method)))
2006            (slot-name (slot-definition-name (accessor-method-slot-definition method))))
2007       #'(lambda (arg)
2008           (declare (optimize speed))
2009           (let* ((layout (std-instance-layout arg))
2010                  (location (get-cached-slot-location gf layout)))
2011             (unless location
2012               (unless (simple-typep arg class)
2013                 ;; FIXME no applicable method
2014                 (error 'simple-type-error
2015                        :datum arg
2016                        :expected-type class))
2017               (setf location (slow-reader-lookup gf layout slot-name)))
2018             (let ((value (if (consp location)
2019                              (cdr location) ; :allocation :class
2020                              (funcallable-standard-instance-access arg location))))
2021               (if (eq value +slot-unbound+)
2022                   ;; fix SLOT-UNBOUND.5 from ansi test suite
2023                   (nth-value 0 (slot-unbound class arg slot-name))
2024                   value))))))
2025
2026    (t
2027     (let* ((emf-table (classes-to-emf-table gf))
2028            (number-required (length (gf-required-args gf)))
2029            (lambda-list (%generic-function-lambda-list gf))
2030            (exact (null (intersection lambda-list
2031                                       '(&rest &optional &key
2032                                         &allow-other-keys))))
2033            (no-aux (null (some 
2034                           (lambda (method) 
2035                             (find '&aux (std-slot-value method 'sys::lambda-list)))
2036                           (sys:%generic-function-methods gf)))))
2037       (if (and exact
2038                no-aux)
2039           (cond
2040             ((= number-required 1)
2041              (cond
2042                ((and (eq (sys:%generic-function-method-combination gf) 'standard)
2043                      (= (length (sys:%generic-function-methods gf)) 1))
2044                 (let* ((method (%car (sys:%generic-function-methods gf)))
2045                        (specializer (car (std-method-specializers method)))
2046                        (function (or (std-method-fast-function method)
2047                                      (std-method-function method))))
2048                   (if (typep specializer 'eql-specializer)
2049                       (let ((specializer-object (eql-specializer-object specializer)))
2050                         #'(lambda (arg)
2051                             (declare (optimize speed))
2052                             (if (eql arg specializer-object)
2053                                 (funcall function arg)
2054                                 (no-applicable-method gf (list arg)))))
2055                       #'(lambda (arg)
2056                           (declare (optimize speed))
2057                           (unless (simple-typep arg specializer)
2058                             ;; FIXME no applicable method
2059                             (error 'simple-type-error
2060                                    :datum arg
2061                                    :expected-type specializer))
2062                           (funcall function arg)))))
2063                (t
2064                 #'(lambda (arg)
2065                     (declare (optimize speed))
2066                     (let* ((specialization
2067                             (%get-arg-specialization gf arg))
2068                            (emfun (or (gethash1 specialization
2069                                                 emf-table)
2070                                       (slow-method-lookup-1
2071                                        gf arg specialization))))
2072                       (if emfun
2073                           (funcall emfun (list arg))
2074                           (apply #'no-applicable-method gf (list arg))))))))
2075             ((= number-required 2)
2076              #'(lambda (arg1 arg2)
2077                  (declare (optimize speed))
2078                  (let* ((args (list arg1 arg2))
2079                         (emfun (get-cached-emf gf args)))
2080                    (if emfun
2081                        (funcall emfun args)
2082                        (slow-method-lookup gf args)))))
2083             ((= number-required 3)
2084              #'(lambda (arg1 arg2 arg3)
2085                  (declare (optimize speed))
2086                  (let* ((args (list arg1 arg2 arg3))
2087                         (emfun (get-cached-emf gf args)))
2088                    (if emfun
2089                        (funcall emfun args)
2090                        (slow-method-lookup gf args)))))
2091             (t
2092              #'(lambda (&rest args)
2093                  (declare (optimize speed))
2094                  (let ((len (length args)))
2095                    (unless (= len number-required)
2096                      (error 'program-error
2097                             :format-control "Not enough arguments for generic function ~S."
2098                             :format-arguments (list (%generic-function-name gf)))))
2099                  (let ((emfun (get-cached-emf gf args)))
2100                    (if emfun
2101                        (funcall emfun args)
2102                        (slow-method-lookup gf args))))))
2103           ;;           (let ((non-key-args (+ number-required
2104           ;;                                  (length (gf-optional-args gf))))))
2105           #'(lambda (&rest args)
2106               (declare (optimize speed))
2107               (let ((len (length args)))
2108                 (unless (>= len number-required)
2109                   (error 'program-error
2110                          :format-control "Not enough arguments for generic function ~S."
2111                          :format-arguments (list (%generic-function-name gf)))))
2112               (let ((emfun (get-cached-emf gf args)))
2113                 (if emfun
2114                     (funcall emfun args)
2115                     (slow-method-lookup gf args)))))))))
2116
2117(defun sort-methods (methods gf required-classes)
2118  (if (or (null methods) (null (%cdr methods)))
2119      methods
2120      (sort methods
2121            (if (eq (class-of gf) +the-standard-generic-function-class+)
2122                (let ((method-indices
2123                       (argument-precedence-order-indices
2124                        (generic-function-argument-precedence-order gf)
2125                        (getf (analyze-lambda-list (generic-function-lambda-list gf))
2126                              ':required-args))))
2127                  #'(lambda (m1 m2)
2128                      (std-method-more-specific-p
2129                       m1 m2 required-classes method-indices)))
2130                #'(lambda (m1 m2)
2131                    (method-more-specific-p gf m1 m2 required-classes))))))
2132
2133(defun method-applicable-p (method args)
2134  (do* ((specializers (method-specializers method) (cdr specializers))
2135        (args args (cdr args)))
2136       ((null specializers) t)
2137    (let ((specializer (car specializers)))
2138      (if (typep specializer 'eql-specializer)
2139          (unless (eql (car args) (eql-specializer-object specializer))
2140            (return nil))
2141          (unless (subclassp (class-of (car args)) specializer)
2142            (return nil))))))
2143
2144(defun %compute-applicable-methods (gf args)
2145  (let ((required-classes (mapcar #'class-of (required-portion gf args)))
2146        (methods '()))
2147    (dolist (method (generic-function-methods gf))
2148      (when (method-applicable-p method args)
2149        (push method methods)))
2150    (sort-methods methods gf required-classes)))
2151
2152;;; METHOD-APPLICABLE-USING-CLASSES-P
2153;;;
2154;;; If the first return value is T, METHOD is definitely applicable to
2155;;; arguments that are instances of CLASSES.  If the first value is
2156;;; NIL and the second value is T, METHOD is definitely not applicable
2157;;; to arguments that are instances of CLASSES; if the second value is
2158;;; NIL the applicability of METHOD cannot be determined by inspecting
2159;;; the classes of its arguments only.
2160;;;
2161(defun method-applicable-using-classes-p (method classes)
2162  (do* ((specializers (method-specializers method) (cdr specializers))
2163  (classes classes (cdr classes))
2164  (knownp t))
2165       ((null specializers)
2166  (if knownp (values t t) (values nil nil)))
2167    (let ((specializer (car specializers)))
2168      (if (typep specializer 'eql-specializer)
2169    (if (eql (class-of (eql-specializer-object specializer)) 
2170       (car classes))
2171        (setf knownp nil)
2172        (return (values nil t)))
2173    (unless (subclassp (car classes) specializer)
2174      (return (values nil t)))))))
2175
2176(defun check-applicable-method-keyword-args (gf args
2177                                             keyword-args
2178                                             applicable-keywords)
2179  (when (oddp (length keyword-args))
2180    (error 'program-error
2181           :format-control "Odd number of keyword arguments in call to ~S ~
2182with arguments list ~S"
2183           :format-arguments (list gf args)))
2184  (unless (getf keyword-args :allow-other-keys)
2185    (loop for key in keyword-args by #'cddr
2186       unless (or (member key applicable-keywords)
2187                  (eq key :allow-other-keys))
2188       do (error 'program-error
2189                 :format-control "Invalid keyword argument ~S in call ~
2190to ~S with argument list ~S."
2191                 :format-arguments (list key gf args)))))
2192
2193(defun compute-applicable-keywords (gf applicable-methods)
2194  (let ((applicable-keywords
2195         (getf (analyze-lambda-list (generic-function-lambda-list gf))
2196               :keywords)))
2197    (loop for method in applicable-methods
2198       do (multiple-value-bind
2199                (keywords allow-other-keys)
2200              (function-keywords method)
2201            (when allow-other-keys
2202              (setf applicable-keywords :any)
2203              (return))
2204            (setf applicable-keywords
2205                  (union applicable-keywords keywords))))
2206    applicable-keywords))
2207
2208(defun wrap-emfun-for-keyword-args-check (gf emfun non-keyword-args
2209                                          applicable-keywords)
2210  #'(lambda (args)
2211      (check-applicable-method-keyword-args
2212         gf args
2213         (nthcdr non-keyword-args args) applicable-keywords)
2214      (funcall emfun args)))
2215
2216(defun slow-method-lookup (gf args)
2217  (let ((applicable-methods (%compute-applicable-methods gf args)))
2218    (if applicable-methods
2219        (let* ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
2220                                   #'std-compute-effective-method
2221                                   #'compute-effective-method)
2222                               gf (generic-function-method-combination gf)
2223                               applicable-methods))
2224               (non-keyword-args
2225                (+ (length (gf-required-args gf))
2226                   (length (gf-optional-args gf))))
2227               (gf-lambda-list (generic-function-lambda-list gf))
2228               (checks-required (and (member '&key gf-lambda-list)
2229                                     (not (member '&allow-other-keys
2230                                                  gf-lambda-list)))
2231                 )
2232              (applicable-keywords
2233               (when checks-required
2234                 ;; Don't do applicable keyword checks when this is
2235                 ;; one of the 'exceptional four' or when the gf allows
2236                 ;; other keywords.
2237                 (compute-applicable-keywords gf applicable-methods))))
2238          (when (and checks-required
2239                     (not (eq applicable-keywords :any)))
2240            (setf emfun
2241                  (wrap-emfun-for-keyword-args-check gf emfun non-keyword-args
2242                                                     applicable-keywords)))
2243          (cache-emf gf args emfun)
2244          (funcall emfun args))
2245        (apply #'no-applicable-method gf args))))
2246
2247(defun slow-method-lookup-1 (gf arg arg-specialization)
2248  (let ((applicable-methods (%compute-applicable-methods gf (list arg))))
2249    (if applicable-methods
2250        (let ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
2251                                  #'std-compute-effective-method
2252                                  #'compute-effective-method)
2253                              gf (generic-function-method-combination gf)
2254                              applicable-methods)))
2255          (when emfun
2256            (setf (gethash arg-specialization (classes-to-emf-table gf)) emfun))
2257          emfun))))
2258
2259(defun sub-specializer-p (c1 c2 c-arg)
2260  (find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
2261
2262(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
2263  (if argument-precedence-order
2264      (let ((specializers-1 (std-method-specializers method1))
2265            (specializers-2 (std-method-specializers method2)))
2266        (dolist (index argument-precedence-order)
2267          (let ((spec1 (nth index specializers-1))
2268                (spec2 (nth index specializers-2)))
2269            (unless (eq spec1 spec2)
2270              (cond ((typep spec1 'eql-specializer)
2271                     (return t))
2272                    ((typep spec2 'eql-specializer)
2273                     (return nil))
2274                    (t
2275                     (return (sub-specializer-p spec1 spec2
2276                                                (nth index required-classes)))))))))
2277      (do ((specializers-1 (std-method-specializers method1) (cdr specializers-1))
2278           (specializers-2 (std-method-specializers method2) (cdr specializers-2))
2279           (classes required-classes (cdr classes)))
2280          ((null specializers-1) nil)
2281        (let ((spec1 (car specializers-1))
2282              (spec2 (car specializers-2)))
2283          (unless (eq spec1 spec2)
2284            (cond ((typep spec1 'eql-specializer)
2285                   (return t))
2286                  ((typep spec2 'eql-specializer)
2287                   (return nil))
2288                  (t
2289                   (return (sub-specializer-p spec1 spec2 (car classes))))))))))
2290
2291(defun primary-method-p (method)
2292  (null (intersection '(:before :after :around) (method-qualifiers method))))
2293
2294(defun before-method-p (method)
2295  (equal '(:before) (method-qualifiers method)))
2296
2297(defun after-method-p (method)
2298  (equal '(:after) (method-qualifiers method)))
2299
2300(defun around-method-p (method)
2301  (equal '(:around) (method-qualifiers method)))
2302
2303(defun process-next-method-list (next-method-list)
2304  (mapcar #'(lambda (next-method-form)
2305              (cond
2306                ((listp next-method-form)
2307                 (assert (eq (first next-method-form) 'make-method))
2308                 (let* ((rest-sym (gensym)))
2309                   (make-instance-standard-method
2310                    nil ;; ignored
2311                    :lambda-list (list '&rest rest-sym)
2312                    :function (compute-method-function `(lambda (&rest ,rest-sym)
2313                                                          ,(second next-method-form))))))
2314                (t
2315                 (assert (typep next-method-form 'method))
2316                 next-method-form)))
2317          next-method-list))
2318
2319(defun std-compute-effective-method (gf mc methods)
2320  (let* ((mc-name (if (atom mc) mc (%car mc)))
2321         (options (if (atom mc) '() (%cdr mc)))
2322         (order (car options))
2323         (primaries '())
2324         (arounds '())
2325         around
2326         emf-form
2327         (long-method-combination-p
2328          (typep (get mc-name 'method-combination-object) 'long-method-combination)))
2329    (unless long-method-combination-p
2330      (dolist (m methods)
2331        (let ((qualifiers (method-qualifiers m)))
2332          (cond ((null qualifiers)
2333                 (if (eq mc-name 'standard)
2334                     (push m primaries)
2335                     (error "Method combination type mismatch.")))
2336                ((cdr qualifiers)
2337                 (error "Invalid method qualifiers."))
2338                ((eq (car qualifiers) :around)
2339                 (push m arounds))
2340                ((eq (car qualifiers) mc-name)
2341                 (push m primaries))
2342                ((memq (car qualifiers) '(:before :after)))
2343                (t
2344                 (error "Invalid method qualifiers."))))))
2345    (unless (eq order :most-specific-last)
2346      (setf primaries (nreverse primaries)))
2347    (setf arounds (nreverse arounds))
2348    (setf around (car arounds))
2349    (when (and (null primaries) (not long-method-combination-p))
2350      (error "No primary methods for the generic function ~S." gf))
2351    (cond
2352      (around
2353       (let ((next-emfun
2354              (funcall
2355               (if (eq (class-of gf) +the-standard-generic-function-class+)
2356                   #'std-compute-effective-method
2357                   #'compute-effective-method)
2358               gf (generic-function-method-combination gf)
2359               (remove around methods))))
2360         (setf emf-form
2361               (generate-emf-lambda (std-method-function around) next-emfun))))
2362      ((eq mc-name 'standard)
2363       (let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2364              (befores (remove-if-not #'before-method-p methods))
2365              (reverse-afters
2366               (reverse (remove-if-not #'after-method-p methods))))
2367         (setf emf-form
2368               (cond
2369                 ((and (null befores) (null reverse-afters))
2370                  (let ((fast-function (std-method-fast-function (car primaries))))
2371                    (if fast-function
2372                        (ecase (length (gf-required-args gf))
2373                          (1
2374                           #'(lambda (args)
2375                               (declare (optimize speed))
2376                               (funcall fast-function (car args))))
2377                          (2
2378                           #'(lambda (args)
2379                               (declare (optimize speed))
2380                               (funcall fast-function (car args) (cadr args)))))
2381                        (generate-emf-lambda (std-method-function (car primaries))
2382                                             next-emfun))))
2383                 (t
2384                  (let ((method-function (std-method-function (car primaries))))
2385                    #'(lambda (args)
2386                        (declare (optimize speed))
2387                        (dolist (before befores)
2388                          (funcall (std-method-function before) args nil))
2389                        (multiple-value-prog1
2390                            (funcall method-function args next-emfun)
2391                          (dolist (after reverse-afters)
2392                            (funcall (std-method-function after) args nil))))))))))
2393      (long-method-combination-p
2394       (let* ((mc-obj (get mc-name 'method-combination-object))
2395              (function (long-method-combination-function mc-obj))
2396              (arguments (rest (slot-value gf 'method-combination))))
2397         (assert (typep mc-obj 'long-method-combination))
2398         (assert function)
2399         (setf emf-form
2400               (if arguments
2401                   (apply function gf methods arguments)
2402                   (funcall function gf methods)))))
2403      (t
2404       (let ((mc-obj (get mc-name 'method-combination-object)))
2405         (unless (typep mc-obj 'short-method-combination)
2406           (error "Unsupported method combination type ~A."
2407                  mc-name))
2408         (let* ((operator (short-method-combination-operator mc-obj))
2409                (ioa (short-method-combination-identity-with-one-argument mc-obj)))
2410           (setf emf-form
2411                 (if (and (null (cdr primaries))
2412                          (not (null ioa)))
2413                     (generate-emf-lambda (std-method-function (car primaries)) nil)
2414                     `(lambda (args)
2415                        (,operator ,@(mapcar
2416                                      (lambda (primary)
2417                                        `(funcall ,(std-method-function primary) args nil))
2418                                      primaries)))))))))
2419    (assert (not (null emf-form)))
2420    (or #+nil (ignore-errors (autocompile emf-form))
2421        (coerce-to-function emf-form))))
2422
2423(defun generate-emf-lambda (method-function next-emfun)
2424  #'(lambda (args)
2425      (declare (optimize speed))
2426      (funcall method-function args next-emfun)))
2427
2428;;; compute an effective method function from a list of primary methods:
2429
2430(defun compute-primary-emfun (methods)
2431  (if (null methods)
2432      nil
2433      (let ((next-emfun (compute-primary-emfun (cdr methods))))
2434        #'(lambda (args)
2435           (funcall (std-method-function (car methods)) args next-emfun)))))
2436
2437(defvar *call-next-method-p*)
2438(defvar *next-method-p-p*)
2439
2440(defun walk-form (form)
2441  (cond ((atom form)
2442         (cond ((eq form 'call-next-method)
2443                (setf *call-next-method-p* t))
2444               ((eq form 'next-method-p)
2445                (setf *next-method-p-p* t))))
2446        (t
2447         (walk-form (%car form))
2448         (walk-form (%cdr form)))))
2449
2450(defun compute-method-function (lambda-expression)
2451  (let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2452        (body (cddr lambda-expression))
2453        (*call-next-method-p* nil)
2454        (*next-method-p-p* nil))
2455    (multiple-value-bind (body declarations) (parse-body body)
2456      (let ((ignorable-vars '()))
2457        (dolist (var lambda-list)
2458          (if (memq var lambda-list-keywords)
2459              (return)
2460              (push var ignorable-vars)))
2461        (push `(declare (ignorable ,@ignorable-vars)) declarations))
2462      (walk-form body)
2463      (cond ((or *call-next-method-p* *next-method-p-p*)
2464             `(lambda (args next-emfun)
2465                (flet ((call-next-method (&rest cnm-args)
2466                         (if (null next-emfun)
2467                             (error "No next method for generic function.")
2468                             (funcall next-emfun (or cnm-args args))))
2469                       (next-method-p ()
2470                         (not (null next-emfun))))
2471                  (declare (ignorable (function call-next-method)
2472                                      (function next-method-p)))
2473                  (apply #'(lambda ,lambda-list ,@declarations ,@body) args))))
2474            ((null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2475             ;; Required parameters only.
2476             (case (length lambda-list)
2477               (1
2478                `(lambda (args next-emfun)
2479                   (declare (ignore next-emfun))
2480                   (let ((,(%car lambda-list) (%car args)))
2481                     (declare (ignorable ,(%car lambda-list)))
2482                     ,@declarations ,@body)))
2483               (2
2484                `(lambda (args next-emfun)
2485                   (declare (ignore next-emfun))
2486                   (let ((,(%car lambda-list) (%car args))
2487                         (,(%cadr lambda-list) (%cadr args)))
2488                     (declare (ignorable ,(%car lambda-list)
2489                                         ,(%cadr lambda-list)))
2490                     ,@declarations ,@body)))
2491               (3
2492                `(lambda (args next-emfun)
2493                   (declare (ignore next-emfun))
2494                   (let ((,(%car lambda-list) (%car args))
2495                         (,(%cadr lambda-list) (%cadr args))
2496                         (,(%caddr lambda-list) (%caddr args)))
2497                     (declare (ignorable ,(%car lambda-list)
2498                                         ,(%cadr lambda-list)
2499                                         ,(%caddr lambda-list)))
2500                     ,@declarations ,@body)))
2501               (t
2502                `(lambda (args next-emfun)
2503                   (declare (ignore next-emfun))
2504                   (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))
2505            (t
2506             `(lambda (args next-emfun)
2507                (declare (ignore next-emfun))
2508                (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))))
2509
2510(defun compute-method-fast-function (lambda-expression)
2511  (let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2512    (when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2513      (return-from compute-method-fast-function nil))
2514    ;; Only required args.
2515    (let ((body (cddr lambda-expression))
2516          (*call-next-method-p* nil)
2517          (*next-method-p-p* nil))
2518      (multiple-value-bind (body declarations) (parse-body body)
2519        (walk-form body)
2520        (when (or *call-next-method-p* *next-method-p-p*)
2521          (return-from compute-method-fast-function nil))
2522        (let ((decls `(declare (ignorable ,@lambda-list))))
2523          (setf lambda-expression
2524                (list* (car lambda-expression)
2525                       (cadr lambda-expression)
2526                       decls
2527                       (cddr lambda-expression))))
2528        (case (length lambda-list)
2529          (1
2530;;            `(lambda (args next-emfun)
2531;;               (let ((,(%car lambda-list) (%car args)))
2532;;                 (declare (ignorable ,(%car lambda-list)))
2533;;                 ,@declarations ,@body)))
2534           lambda-expression)
2535          (2
2536;;            `(lambda (args next-emfun)
2537;;               (let ((,(%car lambda-list) (%car args))
2538;;                     (,(%cadr lambda-list) (%cadr args)))
2539;;                 (declare (ignorable ,(%car lambda-list)
2540;;                                     ,(%cadr lambda-list)))
2541;;                 ,@declarations ,@body)))
2542           lambda-expression)
2543;;           (3
2544;;            `(lambda (args next-emfun)
2545;;               (let ((,(%car lambda-list) (%car args))
2546;;                     (,(%cadr lambda-list) (%cadr args))
2547;;                     (,(%caddr lambda-list) (%caddr args)))
2548;;                 (declare (ignorable ,(%car lambda-list)
2549;;                                     ,(%cadr lambda-list)
2550;;                                     ,(%caddr lambda-list)))
2551;;                 ,@declarations ,@body)))
2552          (t
2553           nil))))))
2554
2555;; From CLHS section 7.6.5:
2556;; "When a generic function or any of its methods mentions &key in a lambda
2557;; list, the specific set of keyword arguments accepted by the generic function
2558;; varies according to the applicable methods. The set of keyword arguments
2559;; accepted by the generic function for a particular call is the union of the
2560;; keyword arguments accepted by all applicable methods and the keyword
2561;; arguments mentioned after &key in the generic function definition, if any."
2562;; Adapted from Sacla.
2563(defun allow-other-keys (lambda-list)
2564  (if (and (member '&key lambda-list)
2565           (not (member '&allow-other-keys lambda-list)))
2566      (let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2567             (aux-part (subseq lambda-list key-end)))
2568        `(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2569      lambda-list))
2570
2571(defmacro defmethod (&rest args)
2572  (multiple-value-bind
2573      (function-name qualifiers lambda-list specializers documentation declarations body)
2574      (parse-defmethod args)
2575    (let* ((specializers-form '())
2576           (lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2577           (method-function (compute-method-function lambda-expression))
2578           (fast-function (compute-method-fast-function lambda-expression))
2579           )
2580      (dolist (specializer specializers)
2581        (cond ((and (consp specializer) (eq (car specializer) 'eql))
2582               (push `(list 'eql ,(cadr specializer)) specializers-form))
2583              (t
2584               (push `',specializer specializers-form))))
2585      (setf specializers-form `(list ,@(nreverse specializers-form)))
2586      `(progn
2587         (ensure-method ',function-name
2588                        :lambda-list ',lambda-list
2589                        :qualifiers ',qualifiers
2590                        :specializers (canonicalize-specializers ,specializers-form)
2591                        ,@(if documentation `(:documentation ,documentation))
2592                        :function (function ,method-function)
2593                        ,@(if fast-function `(:fast-function (function ,fast-function)))
2594                        )))))
2595
2596;;; Reader and writer methods
2597
2598(defun make-instance-standard-accessor-method (method-class
2599                                               &key
2600                                               lambda-list
2601                                               qualifiers
2602                                               specializers
2603                                               documentation
2604                                               function
2605                                               fast-function
2606                                               slot-definition)
2607  (let ((method (std-allocate-instance method-class)))
2608    (setf (method-lambda-list method) lambda-list)
2609    (setf (method-qualifiers method) qualifiers)
2610    (setf (std-slot-value method 'sys::specializers)
2611          (canonicalize-specializers specializers))
2612    (setf (method-documentation method) documentation)
2613    (setf (std-slot-value method 'sys::%generic-function) nil)
2614    (setf (std-slot-value method 'sys::%function) function)
2615    (setf (std-slot-value method 'sys::fast-function) fast-function)
2616    (setf (std-slot-value method 'sys::%slot-definition) slot-definition)
2617    (setf (std-slot-value method 'sys::keywords) nil)
2618    (setf (std-slot-value method 'sys::other-keywords-p) nil)
2619    method))
2620
2621(defun add-reader-method (class function-name slot-definition)
2622  (let* ((slot-name (slot-definition-name slot-definition))
2623         (lambda-expression
2624          (if (eq (class-of class) +the-standard-class+)
2625              `(lambda (object) (std-slot-value object ',slot-name))
2626              `(lambda (object) (slot-value object ',slot-name))))
2627         (method-function (compute-method-function lambda-expression))
2628         (fast-function (compute-method-fast-function lambda-expression))
2629         (method-lambda-list '(object))
2630         (gf (find-generic-function function-name nil))
2631         (initargs `(:lambda-list ,method-lambda-list
2632                     :qualifiers ()
2633                     :specializers (,class)
2634                     :function ,(if (autoloadp 'compile)
2635                                    method-function
2636                                    (autocompile method-function))
2637                     :fast-function ,(if (autoloadp 'compile)
2638                                         fast-function
2639                                         (autocompile fast-function))
2640                     :slot-definition ,slot-definition))
2641         (method-class (if (eq class +the-standard-class+)
2642                           +the-standard-reader-method-class+
2643                           (apply #'reader-method-class class slot-definition
2644                                  initargs))))
2645    ;; required by AMOP pg. 225
2646    (assert (subtypep method-class +the-standard-reader-method-class+))
2647    (if gf
2648        (check-method-lambda-list function-name
2649                                  method-lambda-list
2650                                  (generic-function-lambda-list gf))
2651        (setf gf (ensure-generic-function function-name
2652                                          :lambda-list method-lambda-list)))
2653    (let ((method
2654           (if (eq method-class +the-standard-reader-method-class+)
2655               (apply #'make-instance-standard-accessor-method method-class
2656                      initargs)
2657               (apply #'make-instance method-class
2658                      :generic-function nil ; handled by add-method
2659                      initargs))))
2660      (if (eq (class-of gf) +the-standard-generic-function-class+)
2661          (progn
2662            (std-add-method gf method)
2663            (map-dependents gf
2664                            #'(lambda (dep)
2665                                (update-dependent gf dep 'add-method method))))
2666          (add-method gf method))
2667      method)))
2668
2669(defun add-writer-method (class function-name slot-definition)
2670  (let* ((slot-name (slot-definition-name slot-definition))
2671         (lambda-expression
2672          (if (eq (class-of class) +the-standard-class+)
2673              `(lambda (new-value object)
2674                 (setf (std-slot-value object ',slot-name) new-value))
2675              `(lambda (new-value object)
2676                 (setf (slot-value object ',slot-name) new-value))))
2677         (method-function (compute-method-function lambda-expression))
2678         (fast-function (compute-method-fast-function lambda-expression))
2679         (method-lambda-list '(new-value object))
2680         (gf (find-generic-function function-name nil))
2681         (initargs `(:lambda-list ,method-lambda-list
2682                     :qualifiers ()
2683                     :specializers (,+the-T-class+ ,class)
2684                     :function ,(if (autoloadp 'compile)
2685                                    method-function
2686                                    (autocompile method-function))
2687                     :fast-function ,(if (autoloadp 'compile)
2688                                         fast-function
2689                                         (autocompile fast-function))))
2690         (method-class (if (eq class +the-standard-class+)
2691                           +the-standard-writer-method-class+
2692                           (apply #'writer-method-class class slot-definition
2693                                  initargs))))
2694    ;; required by AMOP pg. 242
2695    (assert (subtypep method-class +the-standard-writer-method-class+))
2696    (if gf
2697        (check-method-lambda-list function-name
2698                                  method-lambda-list
2699                                  (generic-function-lambda-list gf))
2700        (setf gf (ensure-generic-function function-name
2701                                          :lambda-list method-lambda-list)))
2702    (let ((method
2703           (if (eq method-class +the-standard-writer-method-class+)
2704               (apply #'make-instance-standard-accessor-method method-class
2705                      initargs)
2706               (apply #'make-instance method-class
2707                      :generic-function nil ; handled by add-method
2708                      initargs))))
2709      (if (eq (class-of gf) +the-standard-generic-function-class+)
2710          (progn
2711            (std-add-method gf method)
2712            (map-dependents gf
2713                            #'(lambda (dep)
2714                                (update-dependent gf dep 'add-method method))))
2715          (add-method gf method))
2716      method)))
2717
2718(defmacro atomic-defgeneric (function-name &rest rest)
2719  "Macro to define a generic function and 'swap it into place' after
2720it's been fully defined with all its methods.
2721
2722Note: the user should really use the (:method ..) method description
2723way of defining methods; there's not much use in atomically defining
2724generic functions without providing sensible behaviour..."
2725  (let ((temp-sym (gensym)))
2726    `(progn
2727       (defgeneric ,temp-sym ,@rest)
2728       (let ((gf (symbol-function ',temp-sym)))
2729         (setf ,(if (and (consp function-name)
2730                         (eq (car function-name) 'setf))
2731                    `(get ',(second function-name) 'setf-function)
2732                  `(symbol-function ',function-name)) gf)
2733         (%set-generic-function-name gf ',function-name)
2734         gf))))
2735
2736(defmacro redefine-class-forwarder (name slot &optional body-alist)
2737  "Define a generic function on a temporary symbol as an accessor
2738for the slot `slot'. Then, when definition is complete (including
2739allocation of methods), swap the definition in place.
2740
2741`body-alist' can be used to override the default method bodies for given
2742metaclasses.  In substitute method bodies, `class' names the class
2743instance and, for setters, `new-value' the new value."
2744  (let* ((setterp (consp name))
2745         (%name
2746          (intern (concatenate 'string
2747                               "%"
2748                               (if setterp (symbol-name 'set-) "")
2749                               (symbol-name (if setterp (cadr name) name)))
2750                  (find-package "SYS")))
2751         (bodies
2752          (append body-alist
2753                  (if setterp
2754                      `((built-in-class . (,%name new-value class))
2755                        (forward-referenced-class . (,%name new-value class))
2756                        (structure-class . (,%name new-value class))
2757                        (standard-class . (setf (slot-value class ',slot)
2758                                                new-value))
2759                        (funcallable-standard-class . (setf (slot-value class ',slot)
2760                                                            new-value)))
2761                      `((built-in-class . (,%name class))
2762                        (forward-referenced-class . (,%name class))
2763                        (structure-class . (,%name class))
2764                        (standard-class . (slot-value class ',slot))
2765                        (funcallable-standard-class . (slot-value class ',slot)))))))
2766    `(atomic-defgeneric ,name (,@(when setterp (list 'new-value)) class)
2767        ,@(mapcar #'(lambda (class-name)
2768                      `(:method (,@(when setterp (list 'new-value))
2769                                 (class ,class-name))
2770                         ,(cdr (assoc class-name bodies))))
2771                  '(built-in-class forward-referenced-class structure-class
2772                    standard-class funcallable-standard-class)))))
2773
2774
2775(redefine-class-forwarder class-name name)
2776;;; AMOP pg. 230
2777(redefine-class-forwarder (setf class-name) name
2778   ((standard-class . (progn (reinitialize-instance class :name new-value) new-value))
2779    (funcallable-standard-class . (progn (reinitialize-instance class :name new-value) new-value))))
2780(redefine-class-forwarder class-slots slots)
2781(redefine-class-forwarder (setf class-slots) slots)
2782(redefine-class-forwarder class-direct-slots direct-slots)
2783(redefine-class-forwarder (setf class-direct-slots) direct-slots)
2784(redefine-class-forwarder class-layout layout)
2785(redefine-class-forwarder (setf class-layout) layout)
2786(redefine-class-forwarder class-direct-superclasses direct-superclasses)
2787(redefine-class-forwarder (setf class-direct-superclasses) direct-superclasses)
2788(redefine-class-forwarder class-direct-subclasses direct-subclasses)
2789(redefine-class-forwarder (setf class-direct-subclasses) direct-subclasses)
2790(redefine-class-forwarder class-direct-methods direct-methods)
2791(redefine-class-forwarder (setf class-direct-methods) direct-methods)
2792(redefine-class-forwarder class-precedence-list precedence-list)
2793(redefine-class-forwarder (setf class-precedence-list) precedence-list)
2794(redefine-class-forwarder class-finalized-p finalized-p)
2795(redefine-class-forwarder (setf class-finalized-p) finalized-p)
2796(redefine-class-forwarder class-default-initargs default-initargs)
2797(redefine-class-forwarder (setf class-default-initargs) default-initargs)
2798(redefine-class-forwarder class-direct-default-initargs direct-default-initargs)
2799(redefine-class-forwarder (setf class-direct-default-initargs) direct-default-initargs)
2800
2801;;; Class definition
2802
2803(defun check-duplicate-slots (slots)
2804  (dolist (s1 slots)
2805    (let ((name1 (canonical-slot-name s1)))
2806      (dolist (s2 (cdr (memq s1 slots)))
2807        (when (eq name1 (canonical-slot-name s2))
2808          (error 'program-error "Duplicate slot ~S" name1))))))
2809
2810(defun check-duplicate-default-initargs (initargs)
2811  (let ((names ()))
2812    (dolist (initarg initargs)
2813      (push (car initarg) names))
2814    (do* ((names names (cdr names))
2815          (name (car names) (car names)))
2816         ((null names))
2817      (when (memq name (cdr names))
2818        (error 'program-error
2819               :format-control "Duplicate initialization argument name ~S in :DEFAULT-INITARGS."
2820               :format-arguments (list name))))))
2821
2822(defun canonicalize-direct-superclasses (direct-superclasses)
2823  (let ((classes '()))
2824    (dolist (class-specifier direct-superclasses)
2825      (let ((class (if (classp class-specifier)
2826                       class-specifier
2827                       (find-class class-specifier nil))))
2828        (unless class
2829          (setf class (make-instance +the-forward-referenced-class+
2830                                     :name class-specifier))
2831          (setf (find-class class-specifier) class))
2832        (when (and (typep class 'built-in-class)
2833                   (not (member class *extensible-built-in-classes*)))
2834          (error "Attempt to define a subclass of built-in-class ~S."
2835                 class-specifier))
2836        (push class classes)))
2837    (nreverse classes)))
2838
2839(atomic-defgeneric add-direct-subclass (superclass subclass)
2840  (:method ((superclass class) (subclass class))
2841    (setf (class-direct-subclasses superclass)
2842          (adjoin subclass (class-direct-subclasses superclass)))))
2843
2844(atomic-defgeneric remove-direct-subclass (superclass subclass)
2845  (:method ((superclass class) (subclass class))
2846    (setf (class-direct-subclasses superclass)
2847          (remove subclass (class-direct-subclasses superclass)))))
2848
2849 ;;; AMOP pg. 182
2850(defun ensure-class (name &rest all-keys &key &allow-other-keys)
2851  (let ((class (find-class name nil)))
2852    ;; CLHS DEFCLASS: "If a class with the same proper name already
2853    ;; exists [...] the existing class is redefined."  Ansi-tests
2854    ;; CLASS-0309 and CLASS-0310.1 demand this behavior.
2855    (if (and class (eql (class-name class) name))
2856        (apply #'ensure-class-using-class class name all-keys)
2857        (apply #'ensure-class-using-class nil name all-keys))))
2858
2859;;; AMOP pg. 183ff.
2860(defgeneric ensure-class-using-class (class name &key direct-default-initargs
2861                                      direct-slots direct-superclasses
2862                                      metaclass &allow-other-keys))
2863
2864(defmethod ensure-class-using-class :before (class name  &key direct-slots
2865                                             direct-default-initargs 
2866                                             &allow-other-keys)
2867  (check-duplicate-slots direct-slots)
2868  (check-duplicate-default-initargs direct-default-initargs))
2869
2870(defmethod ensure-class-using-class ((class null) name &rest all-keys
2871                                     &key (metaclass +the-standard-class+)
2872                                     direct-superclasses
2873                                     &allow-other-keys)
2874  (setf all-keys (copy-list all-keys))  ; since we modify it
2875  (remf all-keys :metaclass)
2876  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2877  (let ((class (apply (if (eq metaclass +the-standard-class+)
2878                          #'make-instance-standard-class
2879                          #'make-instance)
2880                      metaclass :name name
2881                      :direct-superclasses (canonicalize-direct-superclasses
2882                                            direct-superclasses)
2883                      all-keys)))
2884    (%set-find-class name class)
2885    class))
2886
2887(defmethod ensure-class-using-class ((class built-in-class) name &rest all-keys
2888                                     &key &allow-other-keys)
2889  (declare (ignore all-keys))
2890  (error "The symbol ~S names a built-in class." name))
2891
2892(defmethod ensure-class-using-class ((class forward-referenced-class) name
2893                                     &rest all-keys
2894                                     &key (metaclass +the-standard-class+)
2895                                     direct-superclasses &allow-other-keys)
2896  (setf all-keys (copy-list all-keys))  ; since we modify it
2897  (remf all-keys :metaclass)
2898  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2899  (change-class class metaclass)
2900  (apply #'reinitialize-instance class
2901         :name name
2902         :direct-superclasses (canonicalize-direct-superclasses
2903                               direct-superclasses)
2904         all-keys)
2905  class)
2906
2907(defmethod ensure-class-using-class ((class class) name
2908                                     &key (metaclass +the-standard-class+ metaclassp)
2909                                     direct-superclasses &rest all-keys
2910                                     &allow-other-keys)
2911  (declare (ignore name))
2912  (setf all-keys (copy-list all-keys))  ; since we modify it
2913  (remf all-keys :metaclass)
2914  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2915  (when (and metaclassp (not (eq (class-of class) metaclass)))
2916    (error 'program-error
2917           "Trying to redefine class ~S with different metaclass."
2918           (class-name class)))
2919  (apply #'reinitialize-instance class
2920         :direct-superclasses (canonicalize-direct-superclasses direct-superclasses)
2921         all-keys)
2922  class)
2923
2924(defun maybe-finalize-class-subtree (class)
2925  (when (every #'class-finalized-p (class-direct-superclasses class))
2926    (finalize-inheritance class)
2927    (dolist (subclass (class-direct-subclasses class))
2928      (maybe-finalize-class-subtree subclass))))
2929
2930(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
2931  (unless (>= (length form) 3)
2932    (error 'program-error "Wrong number of arguments for DEFCLASS."))
2933  (check-declaration-type name)
2934  `(ensure-class ',name
2935                 :direct-superclasses
2936                 (canonicalize-direct-superclasses ',direct-superclasses)
2937                 :direct-slots
2938                 ,(canonicalize-direct-slots direct-slots)
2939                 ,@(canonicalize-defclass-options options)))
2940
2941
2942;;; AMOP pg. 180
2943(defgeneric direct-slot-definition-class (class &rest initargs))
2944
2945(defmethod direct-slot-definition-class ((class class) &rest initargs)
2946  (declare (ignore initargs))
2947  +the-standard-direct-slot-definition-class+)
2948
2949;;; AMOP pg. 181
2950(defgeneric effective-slot-definition-class (class &rest initargs))
2951
2952(defmethod effective-slot-definition-class ((class class) &rest initargs)
2953  (declare (ignore initargs))
2954  +the-standard-effective-slot-definition-class+)
2955
2956;;; AMOP pg. 224
2957(defgeneric reader-method-class (class direct-slot &rest initargs))
2958
2959(defmethod reader-method-class ((class standard-class)
2960                                (direct-slot standard-direct-slot-definition)
2961                                &rest initargs)
2962  (declare (ignore initargs))
2963  +the-standard-reader-method-class+)
2964
2965(defmethod reader-method-class ((class funcallable-standard-class)
2966                                (direct-slot standard-direct-slot-definition)
2967                                &rest initargs)
2968  (declare (ignore initargs))
2969  +the-standard-reader-method-class+)
2970
2971;;; AMOP pg. 242
2972(defgeneric writer-method-class (class direct-slot &rest initargs))
2973
2974(defmethod writer-method-class ((class standard-class)
2975                                (direct-slot standard-direct-slot-definition)
2976                                &rest initargs)
2977  (declare (ignore initargs))
2978  +the-standard-writer-method-class+)
2979
2980(defmethod writer-method-class ((class funcallable-standard-class)
2981                                (direct-slot standard-direct-slot-definition)
2982                                &rest initargs)
2983  (declare (ignore initargs))
2984  +the-standard-writer-method-class+)
2985
2986(atomic-defgeneric documentation (x doc-type)
2987    (:method ((x symbol) doc-type)
2988        (%documentation x doc-type))
2989    (:method ((x function) doc-type)
2990        (%documentation x doc-type)))
2991
2992(atomic-defgeneric (setf documentation) (new-value x doc-type)
2993    (:method (new-value (x symbol) doc-type)
2994        (%set-documentation x doc-type new-value))
2995    (:method (new-value (x function) doc-type)
2996        (%set-documentation x doc-type new-value)))
2997
2998
2999;; FIXME This should be a weak hashtable!
3000(defvar *list-documentation-hashtable* (make-hash-table :test #'equal))
3001
3002(defmethod documentation ((x list) (doc-type (eql 'function)))
3003  (let ((alist (gethash x *list-documentation-hashtable*)))
3004    (and alist (cdr (assoc doc-type alist)))))
3005
3006(defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
3007  (let ((alist (gethash x *list-documentation-hashtable*)))
3008    (and alist (cdr (assoc doc-type alist)))))
3009
3010(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
3011  (let* ((alist (gethash x *list-documentation-hashtable*))
3012         (entry (and alist (assoc doc-type alist))))
3013    (cond (entry
3014           (setf (cdr entry) new-value))
3015          (t
3016           (setf (gethash x *list-documentation-hashtable*)
3017                 (push (cons doc-type new-value) alist)))))
3018  new-value)
3019
3020(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro)))
3021  (let* ((alist (gethash x *list-documentation-hashtable*))
3022         (entry (and alist (assoc doc-type alist))))
3023    (cond (entry
3024           (setf (cdr entry) new-value))
3025          (t
3026           (setf (gethash x *list-documentation-hashtable*)
3027                 (push (cons doc-type new-value) alist)))))
3028  new-value)
3029
3030(defmethod documentation ((x class) (doc-type (eql 't)))
3031  (class-documentation x))
3032
3033(defmethod documentation ((x class) (doc-type (eql 'type)))
3034  (class-documentation x))
3035
3036(defmethod (setf documentation) (new-value (x class) (doc-type (eql 't)))
3037  (%set-class-documentation x new-value))
3038
3039(defmethod (setf documentation) (new-value (x class) (doc-type (eql 'type)))
3040  (%set-class-documentation x new-value))
3041
3042(defmethod documentation ((x structure-class) (doc-type (eql 't)))
3043  (%documentation x doc-type))
3044
3045(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
3046  (%documentation x doc-type))
3047
3048(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 't)))
3049  (%set-documentation x doc-type new-value))
3050
3051(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 'type)))
3052  (%set-documentation x doc-type new-value))
3053
3054(defmethod documentation ((x standard-generic-function) (doc-type (eql 't)))
3055  (generic-function-documentation x))
3056
3057(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 't)))
3058  (setf (generic-function-documentation x) new-value))
3059
3060(defmethod documentation ((x standard-generic-function) (doc-type (eql 'function)))
3061  (generic-function-documentation x))
3062
3063(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 'function)))
3064  (setf (generic-function-documentation x) new-value))
3065
3066(defmethod documentation ((x standard-method) (doc-type (eql 't)))
3067  (method-documentation x))
3068
3069(defmethod (setf documentation) (new-value (x standard-method) (doc-type (eql 't)))
3070  (setf (method-documentation x) new-value))
3071
3072(defmethod documentation ((x standard-slot-definition) (doc-type (eql 't)))
3073  (slot-definition-documentation x))
3074
3075(defmethod (setf documentation) (new-value (x standard-slot-definition) (doc-type (eql 't)))
3076  (setf (slot-definition-documentation x) new-value))
3077
3078(defmethod documentation ((x package) (doc-type (eql 't)))
3079  (%documentation x doc-type))
3080
3081(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
3082  (%set-documentation x doc-type new-value))
3083
3084(defmethod documentation ((x symbol) (doc-type (eql 'function)))
3085  (%documentation x doc-type))
3086
3087;;; Applicable methods
3088
3089(defgeneric compute-applicable-methods (gf args)
3090  (:method ((gf standard-generic-function) args)
3091    (%compute-applicable-methods gf args)))
3092
3093(defgeneric compute-applicable-methods-using-classes (gf classes)
3094  (:method ((gf standard-generic-function) classes)
3095    (let ((methods '()))
3096      (dolist (method (generic-function-methods gf))
3097  (multiple-value-bind (applicable knownp)
3098      (method-applicable-using-classes-p method classes)
3099    (cond (applicable
3100     (push method methods))
3101    ((not knownp)
3102     (return-from compute-applicable-methods-using-classes
3103       (values nil nil))))))
3104      (values (sort-methods methods gf classes)
3105        t))))
3106
3107
3108;;; Slot access
3109;;;
3110;;; See AMOP pg. 156ff. for an overview.
3111;;;
3112;;; AMOP specifies these generic functions to dispatch on slot objects
3113;;; (with the exception of slot-exists-p-using-class), although its
3114;;; sample implementation Closette dispatches on slot names.  We let
3115;;; slot-value and friends call their gf counterparts with the effective
3116;;; slot definition, but leave the definitions dispatching on slot name
3117;;; in place for user convenience.
3118
3119;;; AMOP pg. 235
3120(defgeneric slot-value-using-class (class instance slot))
3121
3122(defmethod slot-value-using-class ((class standard-class) instance (slot symbol))
3123  (std-slot-value instance slot))
3124(defmethod slot-value-using-class ((class standard-class) instance
3125                                   (slot standard-effective-slot-definition))
3126  (let* ((location (slot-definition-location slot))
3127         (value (if (consp location)
3128                    (cdr location)      ; :allocation :class
3129                    (standard-instance-access instance location))))
3130    (if (eq value +slot-unbound+)
3131        ;; fix SLOT-UNBOUND.5 from ansi test suite
3132        (nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3133        value)))
3134
3135(defmethod slot-value-using-class ((class funcallable-standard-class)
3136                                   instance (slot symbol))
3137  (std-slot-value instance slot))
3138(defmethod slot-value-using-class ((class funcallable-standard-class) instance
3139                                   (slot standard-effective-slot-definition))
3140  (let* ((location (slot-definition-location slot))
3141         (value (if (consp location)
3142                    (cdr location)      ; :allocation :class
3143                    (funcallable-standard-instance-access instance location))))
3144    (if (eq value +slot-unbound+)
3145        ;; fix SLOT-UNBOUND.5 from ansi test suite
3146        (nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3147        value)))
3148
3149(defmethod slot-value-using-class ((class structure-class) instance
3150                                   (slot symbol))
3151  (std-slot-value instance slot))
3152(defmethod slot-value-using-class ((class structure-class) instance
3153                                   (slot standard-effective-slot-definition))
3154  (std-slot-value instance (slot-definition-name slot)))
3155
3156;;; AMOP pg. 231
3157(defgeneric (setf slot-value-using-class) (new-value class instance slot))
3158
3159(defmethod (setf slot-value-using-class) (new-value
3160                                          (class standard-class)
3161                                          instance
3162                                          (slot symbol))
3163  (setf (std-slot-value instance slot) new-value))
3164(defmethod (setf slot-value-using-class) (new-value
3165                                          (class standard-class)
3166                                          instance
3167                                          (slot standard-effective-slot-definition))
3168  (let ((location (slot-definition-location slot)))
3169    (if (consp location)                ; :allocation :class
3170        (setf (cdr location) new-value)
3171        (setf (standard-instance-access instance location) new-value))))
3172
3173(defmethod (setf slot-value-using-class) (new-value
3174                                          (class funcallable-standard-class)
3175                                          instance
3176                                          (slot symbol))
3177  (setf (std-slot-value instance slot) new-value))
3178(defmethod (setf slot-value-using-class) (new-value
3179                                          (class funcallable-standard-class)
3180                                          instance
3181                                          (slot standard-effective-slot-definition))
3182  (let ((location (slot-definition-location slot)))
3183    (if (consp location)                ; :allocation :class
3184        (setf (cdr location) new-value)
3185        (setf (funcallable-standard-instance-access instance location)
3186              new-value))))
3187
3188(defmethod (setf slot-value-using-class) (new-value
3189                                          (class structure-class)
3190                                          instance
3191                                          (slot symbol))
3192  (setf (std-slot-value instance slot) new-value))
3193(defmethod (setf slot-value-using-class) (new-value
3194                                          (class structure-class)
3195                                          instance
3196                                          (slot standard-effective-slot-definition))
3197  (setf (std-slot-value instance (slot-definition-name slot)) new-value))
3198
3199;;; slot-exists-p-using-class is not specified by AMOP, and obviously
3200;;; cannot be specialized on the slot type.  Hence, its implementation
3201;;; differs from slot-(boundp|makunbound|value)-using-class
3202(defgeneric slot-exists-p-using-class (class instance slot-name))
3203
3204(defmethod slot-exists-p-using-class (class instance slot-name)
3205  nil)
3206
3207(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
3208  (std-slot-exists-p instance slot-name))
3209(defmethod slot-exists-p-using-class ((class funcallable-standard-class) instance slot-name)
3210  (std-slot-exists-p instance slot-name))
3211
3212(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
3213  (dolist (dsd (class-slots class))
3214    (when (eq (sys::dsd-name dsd) slot-name)
3215      (return-from slot-exists-p-using-class t)))
3216  nil)
3217
3218
3219(defgeneric slot-boundp-using-class (class instance slot))
3220(defmethod slot-boundp-using-class ((class standard-class) instance (slot symbol))
3221  (std-slot-boundp instance slot))
3222(defmethod slot-boundp-using-class ((class standard-class) instance
3223                                    (slot standard-effective-slot-definition))
3224  (let ((location (slot-definition-location slot)))
3225    (if (consp location)
3226        (eq (cdr location) +slot-unbound+) ; :allocation :class
3227        (eq (standard-instance-access instance location) +slot-unbound+))))
3228
3229(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3230                                    (slot symbol))
3231  (std-slot-boundp instance slot))
3232(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3233                                    (slot standard-effective-slot-definition))
3234  (let ((location (slot-definition-location slot)))
3235    (if (consp location)
3236        (eq (cdr location) +slot-unbound+) ; :allocation :class
3237        (eq (funcallable-standard-instance-access instance location)
3238            +slot-unbound+))))
3239
3240(defmethod slot-boundp-using-class ((class structure-class) instance slot)
3241  "Structure slots can't be unbound, so this method always returns T."
3242  (declare (ignore class instance slot))
3243  t)
3244
3245(defgeneric slot-makunbound-using-class (class instance slot))
3246(defmethod slot-makunbound-using-class ((class standard-class)
3247                                        instance
3248                                        (slot symbol))
3249  (std-slot-makunbound instance slot))
3250(defmethod slot-makunbound-using-class ((class standard-class)
3251                                        instance
3252                                        (slot standard-effective-slot-definition))
3253  (let ((location (slot-definition-location slot)))
3254    (if (consp location)
3255        (setf (cdr location) +slot-unbound+)
3256        (setf (standard-instance-access instance location) +slot-unbound+))))
3257
3258(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3259                                        instance
3260                                        (slot symbol))
3261  (std-slot-makunbound instance slot))
3262(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3263                                        instance
3264                                        (slot symbol))
3265  (let ((location (slot-definition-location slot)))
3266    (if (consp location)
3267        (setf (cdr location) +slot-unbound+)
3268        (setf (funcallable-standard-instance-access instance location)
3269              +slot-unbound+))))
3270
3271(defmethod slot-makunbound-using-class ((class structure-class)
3272                                        instance
3273                                        slot)
3274  (declare (ignore class instance slot))
3275  (error "Structure slots can't be unbound"))
3276
3277(defgeneric slot-missing (class instance slot-name operation &optional new-value))
3278
3279(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
3280  (declare (ignore new-value))
3281  (error "The slot ~S is missing from the class ~S." slot-name class))
3282
3283(defgeneric slot-unbound (class instance slot-name))
3284
3285(defmethod slot-unbound ((class t) instance slot-name)
3286  (error 'unbound-slot :instance instance :name slot-name))
3287
3288;;; Instance creation and initialization
3289
3290;;; AMOP pg. 168ff.  Checking whether the class is finalized is done
3291;;; inside std-allocate-instance and allocate-funcallable-instance.
3292(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
3293
3294(defmethod allocate-instance ((class standard-class) &rest initargs)
3295  (declare (ignore initargs))
3296  (std-allocate-instance class))
3297
3298(defmethod allocate-instance ((class funcallable-standard-class) &rest initargs)
3299  (declare (ignore initargs))
3300  (allocate-funcallable-instance class))
3301
3302(defmethod allocate-instance ((class structure-class) &rest initargs)
3303  (declare (ignore initargs))
3304  (%make-structure (class-name class)
3305                   (make-list (length (class-slots class))
3306                              :initial-element +slot-unbound+)))
3307
3308(defmethod allocate-instance ((class built-in-class) &rest initargs)
3309  (declare (ignore initargs))
3310  (error "Cannot allocate instances of a built-in class: ~S" class))
3311
3312;; "The set of valid initialization arguments for a class is the set of valid
3313;; initialization arguments that either fill slots or supply arguments to
3314;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
3315;; 7.1.2
3316
3317(defun calculate-allowable-initargs (gf-list args instance
3318                                             shared-initialize-param
3319                                             initargs)
3320  (let* ((methods
3321          (nconc
3322             (compute-applicable-methods #'shared-initialize
3323                                         (list* instance
3324                                                shared-initialize-param
3325                                                initargs))
3326             (mapcan #'(lambda (gf)
3327                         (compute-applicable-methods gf args))
3328                     gf-list)))
3329         (method-keyword-args
3330          (reduce #'merge-initargs-sets
3331                  (mapcar #'method-lambda-list methods)
3332                  :key #'extract-lambda-list-keywords
3333                  :initial-value nil))
3334         (slots-initargs
3335          (mapappend #'slot-definition-initargs
3336                     (class-slots (class-of instance)))))
3337    (merge-initargs-sets
3338     (merge-initargs-sets slots-initargs method-keyword-args)
3339     '(:allow-other-keys))))  ;; allow-other-keys is always allowed
3340
3341(defun check-initargs (gf-list args instance
3342                       shared-initialize-param initargs
3343                       cache call-site)
3344  "Checks the validity of `initargs' for the generic functions in `gf-list'
3345when called with `args' by calculating the applicable methods for each gf.
3346The applicable methods for SHARED-INITIALIZE based on `instance',
3347`shared-initialize-param' and `initargs' are added to the list of
3348applicable methods."
3349  (when (oddp (length initargs))
3350    (error 'program-error
3351           :format-control "Odd number of keyword arguments."))
3352  (unless (getf initargs :allow-other-keys)
3353    (multiple-value-bind (allowable-initargs present-p)
3354                         (when cache
3355                           (gethash (class-of instance) cache))
3356       (unless present-p
3357         (setf allowable-initargs
3358               (calculate-allowable-initargs gf-list args instance
3359                                             shared-initialize-param initargs))
3360         (when cache
3361           (setf (gethash (class-of instance) cache)
3362                 allowable-initargs)))
3363       (unless (eq t allowable-initargs)
3364         (do* ((tail initargs (cddr tail))
3365               (initarg (car tail) (car tail)))
3366              ((null tail))
3367              (unless (memq initarg allowable-initargs)
3368                (error 'program-error
3369                       :format-control "Invalid initarg ~S in call to ~S with arglist ~S."
3370                       :format-arguments (list initarg call-site args))))))))
3371
3372(defun merge-initargs-sets (list1 list2)
3373  (cond
3374   ((eq list1 t)  t)
3375   ((eq list2 t)  t)
3376   (t             (union list1 list2))))
3377
3378(defun extract-lambda-list-keywords (lambda-list)
3379  "Returns a list of keywords acceptable as keyword arguments,
3380or T when any keyword is acceptable due to presence of
3381&allow-other-keys."
3382  (when (member '&allow-other-keys lambda-list)
3383    (return-from extract-lambda-list-keywords t))
3384  (loop with keyword-args = (cdr (memq '&key lambda-list))
3385        for key in keyword-args
3386        when (eq key '&aux) do (loop-finish)
3387        when (eq key '&allow-other-keys) do (return t)
3388        when (listp key) do (setq key (car key))
3389        collect (if (symbolp key)
3390                    (make-keyword key)
3391                  (car key))))
3392
3393
3394(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
3395
3396(defmethod make-instance :before ((class class) &rest initargs)
3397  (when (oddp (length initargs))
3398    (error 'program-error :format-control "Odd number of keyword arguments."))
3399  (unless (class-finalized-p class)
3400    (finalize-inheritance class)))
3401
3402(defun augment-initargs-with-defaults (class initargs)
3403  (let ((default-initargs '()))
3404    (dolist (initarg (class-default-initargs class))
3405      (let ((key (first initarg))
3406            (fn (third initarg)))
3407        (when (eq (getf initargs key +slot-unbound+) +slot-unbound+)
3408          (push key default-initargs)
3409          (push (funcall fn) default-initargs))))
3410    (append initargs (nreverse default-initargs))))
3411
3412(defmethod make-instance ((class standard-class) &rest initargs)
3413  (setf initargs (augment-initargs-with-defaults class initargs))
3414  (let ((instance (std-allocate-instance class)))
3415    (check-initargs (list #'allocate-instance #'initialize-instance)
3416                    (list* instance initargs)
3417                    instance t initargs
3418                    *make-instance-initargs-cache* 'make-instance)
3419    (apply #'initialize-instance instance initargs)
3420    instance))
3421
3422(defmethod make-instance ((class funcallable-standard-class) &rest initargs)
3423  (setf initargs (augment-initargs-with-defaults class initargs))
3424  (let ((instance (allocate-funcallable-instance class)))
3425    (check-initargs (list #'allocate-instance #'initialize-instance)
3426                    (list* instance initargs)
3427                    instance t initargs
3428                    *make-instance-initargs-cache* 'make-instance)
3429    (apply #'initialize-instance instance initargs)
3430    instance))
3431
3432(defmethod make-instance ((class symbol) &rest initargs)
3433  (apply #'make-instance (find-class class) initargs))
3434
3435(defgeneric initialize-instance (instance &rest initargs
3436                                          &key &allow-other-keys))
3437
3438(defmethod initialize-instance ((instance standard-object) &rest initargs)
3439  (apply #'shared-initialize instance t initargs))
3440
3441(defgeneric reinitialize-instance (instance &rest initargs
3442                                            &key &allow-other-keys))
3443
3444;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
3445;; validity of initargs and signals an error if an initarg is supplied that is
3446;; not declared as valid. The method then calls the generic function SHARED-
3447;; INITIALIZE with the following arguments: the instance, nil (which means no
3448;; slots should be initialized according to their initforms), and the initargs
3449;; it received."
3450(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
3451  (check-initargs (list #'reinitialize-instance) (list* instance initargs)
3452                  instance () initargs
3453                  *reinitialize-instance-initargs-cache* 'reinitialize-instance)
3454  (apply #'shared-initialize instance () initargs))
3455
3456(defun std-shared-initialize (instance slot-names all-keys)
3457  (when (oddp (length all-keys))
3458    (error 'program-error :format-control "Odd number of keyword arguments."))
3459  ;; do a quick scan of the arguments list to see if it's a real
3460  ;; 'initialization argument list' (which is not the same as
3461  ;; checking initarg validity
3462  (do* ((tail all-keys (cddr tail))
3463        (initarg (car tail) (car tail)))
3464      ((null tail))
3465    (unless (symbolp initarg)
3466      (error 'program-error
3467             :format-control "Initarg ~S not a symbol."
3468             :format-arguments (list initarg))))
3469  (dolist (slot (class-slots (class-of instance)))
3470    (let ((slot-name (slot-definition-name slot)))
3471      (multiple-value-bind (init-key init-value foundp)
3472          (get-properties all-keys (slot-definition-initargs slot))
3473        (if foundp
3474            (setf (std-slot-value instance slot-name) init-value)
3475            (unless (std-slot-boundp instance slot-name)
3476              (let ((initfunction (slot-definition-initfunction slot)))
3477                (when (and initfunction (or (eq slot-names t)
3478                                            (memq slot-name slot-names)))
3479                  (setf (std-slot-value instance slot-name)
3480                        (funcall initfunction)))))))))
3481  instance)
3482
3483(defgeneric shared-initialize (instance slot-names
3484                                        &rest initargs
3485                                        &key &allow-other-keys))
3486
3487(defmethod shared-initialize ((instance standard-object) slot-names
3488                              &rest initargs)
3489  (std-shared-initialize instance slot-names initargs))
3490
3491(defmethod shared-initialize :after ((instance standard-class) slot-names
3492                                     &key direct-superclasses
3493                                     direct-slots direct-default-initargs
3494                                     &allow-other-keys)
3495  (std-after-initialization-for-classes
3496   instance :direct-superclasses direct-superclasses
3497   :direct-slots direct-slots
3498   :direct-default-initargs direct-default-initargs))
3499
3500(defmethod shared-initialize :after ((instance funcallable-standard-class)
3501                                     slot-names &key direct-superclasses
3502                                     direct-slots direct-default-initargs
3503                                     &allow-other-keys)
3504  (std-after-initialization-for-classes
3505   instance :direct-superclasses direct-superclasses
3506   :direct-slots direct-slots
3507   :direct-default-initargs direct-default-initargs))
3508
3509(defmethod shared-initialize ((slot slot-definition) slot-names
3510                              &rest args
3511                              &key name initargs initform initfunction
3512                              readers writers allocation
3513                              &allow-other-keys)
3514  ;;Keyword args are duplicated from init-slot-definition only to have
3515  ;;them checked.
3516  (declare (ignore slot-names)) ;;TODO?
3517  (declare (ignore name initargs initform initfunction readers writers allocation))
3518  ;;For built-in slots
3519  (apply #'init-slot-definition slot :allow-other-keys t args)
3520  ;;For user-defined slots
3521  (call-next-method))
3522
3523;;; change-class
3524
3525(defgeneric change-class (instance new-class &key &allow-other-keys))
3526
3527(defmethod change-class ((old-instance standard-object) (new-class standard-class)
3528                         &rest initargs)
3529  (let ((old-slots (class-slots (class-of old-instance)))
3530        (new-slots (class-slots new-class))
3531        (new-instance (allocate-instance new-class)))
3532    ;; "The values of local slots specified by both the class CTO and the class
3533    ;; CFROM are retained. If such a local slot was unbound, it remains
3534    ;; unbound."
3535    (dolist (new-slot new-slots)
3536      (when (instance-slot-p new-slot)
3537        (let* ((slot-name (slot-definition-name new-slot))
3538               (old-slot (find slot-name old-slots :key 'slot-definition-name)))
3539          ;; "The values of slots specified as shared in the class CFROM and as
3540          ;; local in the class CTO are retained."
3541          (when (and old-slot (slot-boundp old-instance slot-name))
3542            (setf (slot-value new-instance slot-name)
3543                  (slot-value old-instance slot-name))))))
3544    (swap-slots old-instance new-instance)
3545    (rotatef (std-instance-layout new-instance)
3546             (std-instance-layout old-instance))
3547    (apply #'update-instance-for-different-class
3548           new-instance old-instance initargs)
3549    old-instance))
3550
3551(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
3552  (apply #'change-class instance (find-class new-class) initargs))
3553
3554(defgeneric update-instance-for-different-class (old new
3555                                                     &rest initargs
3556                                                     &key &allow-other-keys))
3557
3558(defmethod update-instance-for-different-class
3559  ((old standard-object) (new standard-object) &rest initargs)
3560  (let ((added-slots
3561         (remove-if #'(lambda (slot-name)
3562                       (slot-exists-p old slot-name))
3563                    (mapcar 'slot-definition-name
3564                            (class-slots (class-of new))))))
3565    (check-initargs (list #'update-instance-for-different-class)
3566                    (list old new initargs)
3567                    new added-slots initargs
3568                    nil 'update-instance-for-different-class)
3569    (apply #'shared-initialize new added-slots initargs)))
3570
3571;;; make-instances-obsolete
3572
3573(defgeneric make-instances-obsolete (class))
3574
3575(defmethod make-instances-obsolete ((class standard-class))
3576  (%make-instances-obsolete class))
3577(defmethod make-instances-obsolete ((class funcallable-standard-class))
3578  (%make-instances-obsolete class))
3579(defmethod make-instances-obsolete ((class symbol))
3580  (make-instances-obsolete (find-class class))
3581  class)
3582
3583;;; update-instance-for-redefined-class
3584
3585(defgeneric update-instance-for-redefined-class (instance
3586                                                 added-slots
3587                                                 discarded-slots
3588                                                 property-list
3589                                                 &rest initargs
3590                                                 &key
3591                                                 &allow-other-keys))
3592
3593(defmethod update-instance-for-redefined-class ((instance standard-object)
3594            added-slots
3595            discarded-slots
3596            property-list
3597            &rest initargs)
3598  (check-initargs (list #'update-instance-for-redefined-class)
3599                  (list* instance added-slots discarded-slots
3600                         property-list initargs)
3601                  instance added-slots initargs
3602                  nil 'update-instance-for-redefined-class)
3603  (apply #'shared-initialize instance added-slots initargs))
3604
3605;;;  Methods having to do with class metaobjects.
3606
3607(defmethod initialize-instance :after ((class standard-class) &rest args)
3608  (apply #'std-after-initialization-for-classes class args))
3609
3610(defmethod initialize-instance :after ((class funcallable-standard-class)
3611                                       &rest args)
3612  (apply #'std-after-initialization-for-classes class args))
3613
3614(defmethod reinitialize-instance :before ((class standard-class)
3615                                          &key direct-superclasses
3616                                          &rest all-keys)
3617  (check-initargs (list #'allocate-instance
3618                        #'initialize-instance)
3619                  (list* class all-keys)
3620                  class t all-keys
3621                  nil 'reinitialize-instance)
3622  (dolist (superclass (set-difference (class-direct-superclasses class)
3623                                      direct-superclasses))
3624    (remove-direct-subclass superclass class))
3625  (dolist (superclass (set-difference direct-superclasses
3626                                      (class-direct-superclasses class)))
3627    (add-direct-subclass superclass class)))
3628
3629(defmethod reinitialize-instance :before ((class funcallable-standard-class)
3630                                          &key direct-superclasses
3631                                          &rest all-keys)
3632  (check-initargs (list #'allocate-instance
3633                        #'initialize-instance)
3634                  (list* class all-keys)
3635                  class t all-keys
3636                  nil 'reinitialize-instance)
3637  (dolist (superclass (set-difference (class-direct-superclasses class)
3638                                      direct-superclasses))
3639    (remove-direct-subclass superclass class))
3640  (dolist (superclass (set-difference direct-superclasses
3641                                      (class-direct-superclasses class)))
3642    (add-direct-subclass superclass class)))
3643
3644(defmethod reinitialize-instance :after ((class standard-class) &rest all-keys)
3645  (remhash class *make-instance-initargs-cache*)
3646  (remhash class *reinitialize-instance-initargs-cache*)
3647  (%make-instances-obsolete class)
3648  (setf (class-finalized-p class) nil)
3649  ;; KLUDGE (rudi 2012-06-17) this calls add-direct-subclass again
3650  (apply #'std-after-initialization-for-classes class all-keys)
3651  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3652
3653(defmethod reinitialize-instance :after ((class funcallable-standard-class)
3654                                         &rest all-keys)
3655  (remhash class *make-instance-initargs-cache*)
3656  (remhash class *reinitialize-instance-initargs-cache*)
3657  (%make-instances-obsolete class)
3658  (setf (class-finalized-p class) nil)
3659  ;; KLUDGE (rudi 2012-06-17) this calls add-direct-subclass again
3660  (apply #'std-after-initialization-for-classes class all-keys)
3661  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3662
3663(defmethod reinitialize-instance :after ((gf standard-generic-function)
3664                                         &rest all-keys)
3665  (map-dependents gf #'(lambda (dep) (update-dependent gf dep all-keys))))
3666
3667;;; Finalize inheritance
3668
3669(atomic-defgeneric finalize-inheritance (class)
3670    (:method ((class standard-class))
3671       (std-finalize-inheritance class))
3672    (:method ((class funcallable-standard-class))
3673       (std-finalize-inheritance class)))
3674
3675;;; Default initargs
3676
3677;;; AMOP pg. 174
3678(atomic-defgeneric compute-default-initargs (class)
3679  (:method ((class standard-class))
3680    (std-compute-default-initargs class))
3681  (:method ((class funcallable-standard-class))
3682    (std-compute-default-initargs class)))
3683
3684;;; Class precedence lists
3685
3686(defgeneric compute-class-precedence-list (class))
3687(defmethod compute-class-precedence-list ((class standard-class))
3688  (std-compute-class-precedence-list class))
3689(defmethod compute-class-precedence-list ((class funcallable-standard-class))
3690  (std-compute-class-precedence-list class))
3691
3692;;; Slot inheritance
3693
3694(defgeneric compute-slots (class))
3695(defmethod compute-slots ((class standard-class))
3696  (std-compute-slots class))
3697(defmethod compute-slots ((class funcallable-standard-class))
3698  (std-compute-slots class))
3699
3700(defgeneric compute-effective-slot-definition (class name direct-slots))
3701(defmethod compute-effective-slot-definition
3702  ((class standard-class) name direct-slots)
3703  (std-compute-effective-slot-definition class name direct-slots))
3704(defmethod compute-effective-slot-definition
3705  ((class funcallable-standard-class) name direct-slots)
3706  (std-compute-effective-slot-definition class name direct-slots))
3707
3708;;; Methods having to do with generic function invocation.
3709
3710(defgeneric compute-discriminating-function (gf))
3711(defmethod compute-discriminating-function ((gf standard-generic-function))
3712  (std-compute-discriminating-function gf))
3713
3714(defgeneric method-more-specific-p (gf method1 method2 required-classes))
3715
3716(defmethod method-more-specific-p ((gf standard-generic-function)
3717                                   method1 method2 required-classes)
3718  (let ((method-indices
3719         (argument-precedence-order-indices
3720          (generic-function-argument-precedence-order gf)
3721          (getf (analyze-lambda-list (generic-function-lambda-list gf))
3722                ':required-args))))
3723    (std-method-more-specific-p method1 method2 required-classes method-indices)))
3724
3725;;; AMOP pg. 176
3726(defgeneric compute-effective-method (gf method-combination methods))
3727(defmethod compute-effective-method ((gf standard-generic-function) method-combination methods)
3728  (std-compute-effective-method gf method-combination methods))
3729
3730(defgeneric compute-applicable-methods (gf args))
3731(defmethod compute-applicable-methods ((gf standard-generic-function) args)
3732  (%compute-applicable-methods gf args))
3733
3734;;; Slot definition accessors
3735
3736(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
3737  `(let (($cl (class-of ,slot-definition)))
3738     (case $cl
3739       ((+the-standard-slot-definition-class+
3740         +the-standard-direct-slot-definition-class+
3741         +the-standard-effective-slot-definition-class+)
3742        ,std-form)
3743       (t ,generic-form))))
3744
3745(atomic-defgeneric slot-definition-allocation (slot-definition)
3746  (:method ((slot-definition slot-definition))
3747    (slot-definition-dispatch slot-definition
3748      (%slot-definition-allocation slot-definition)
3749      (slot-value slot-definition 'sys::allocation))))
3750
3751(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
3752  (:method (value (slot-definition slot-definition))
3753    (slot-definition-dispatch slot-definition
3754      (set-slot-definition-allocation slot-definition value)
3755      (setf (slot-value slot-definition 'sys::allocation) value))))
3756
3757(atomic-defgeneric slot-definition-initargs (slot-definition)
3758  (:method ((slot-definition slot-definition))
3759    (slot-definition-dispatch slot-definition
3760      (%slot-definition-initargs slot-definition)
3761      (slot-value slot-definition 'sys::initargs))))
3762
3763(atomic-defgeneric slot-definition-initform (slot-definition)
3764  (:method ((slot-definition slot-definition))
3765    (slot-definition-dispatch slot-definition
3766      (%slot-definition-initform slot-definition)
3767      (slot-value slot-definition 'sys::initform))))
3768
3769(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
3770  (:method (value (slot-definition slot-definition))
3771    (slot-definition-dispatch slot-definition
3772      (set-slot-definition-initform slot-definition value)
3773      (setf (slot-value slot-definition 'sys::initform) value))))
3774
3775(atomic-defgeneric slot-definition-initfunction (slot-definition)
3776  (:method ((slot-definition slot-definition))
3777    (slot-definition-dispatch slot-definition
3778      (%slot-definition-initfunction slot-definition)
3779      (slot-value slot-definition 'sys::initfunction))))
3780
3781(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
3782  (:method (value (slot-definition slot-definition))
3783    (slot-definition-dispatch slot-definition
3784      (set-slot-definition-initfunction slot-definition value)
3785      (setf (slot-value slot-definition 'sys::initfunction) value))))
3786
3787(atomic-defgeneric slot-definition-name (slot-definition)
3788  (:method ((slot-definition slot-definition))
3789    (slot-definition-dispatch slot-definition
3790      (%slot-definition-name slot-definition)
3791      (slot-value slot-definition 'sys::name))))
3792
3793(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
3794  (:method (value (slot-definition slot-definition))
3795    (slot-definition-dispatch slot-definition
3796      (set-slot-definition-name slot-definition value)
3797      (setf (slot-value slot-definition 'sys::name) value))))
3798
3799(atomic-defgeneric slot-definition-readers (slot-definition)
3800  (:method ((slot-definition slot-definition))
3801    (slot-definition-dispatch slot-definition
3802      (%slot-definition-readers slot-definition)
3803      (slot-value slot-definition 'sys::readers))))
3804
3805(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
3806  (:method (value (slot-definition slot-definition))
3807    (slot-definition-dispatch slot-definition
3808      (set-slot-definition-readers slot-definition value)
3809      (setf (slot-value slot-definition 'sys::readers) value))))
3810
3811(atomic-defgeneric slot-definition-writers (slot-definition)
3812  (:method ((slot-definition slot-definition))
3813    (slot-definition-dispatch slot-definition
3814      (%slot-definition-writers slot-definition)
3815      (slot-value slot-definition 'sys::writers))))
3816
3817(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
3818  (:method (value (slot-definition slot-definition))
3819    (slot-definition-dispatch slot-definition
3820      (set-slot-definition-writers slot-definition value)
3821      (setf (slot-value slot-definition 'sys::writers) value))))
3822
3823(atomic-defgeneric slot-definition-allocation-class (slot-definition)
3824  (:method ((slot-definition slot-definition))
3825    (slot-definition-dispatch slot-definition
3826      (%slot-definition-allocation-class slot-definition)
3827      (slot-value slot-definition 'sys::allocation-class))))
3828
3829(atomic-defgeneric (setf slot-definition-allocation-class)
3830                       (value slot-definition)
3831  (:method (value (slot-definition slot-definition))
3832    (slot-definition-dispatch slot-definition
3833      (set-slot-definition-allocation-class slot-definition value)
3834      (setf (slot-value slot-definition 'sys::allocation-class) value))))
3835
3836(atomic-defgeneric slot-definition-location (slot-definition)
3837  (:method ((slot-definition slot-definition))
3838    (slot-definition-dispatch slot-definition
3839      (%slot-definition-location slot-definition)
3840      (slot-value slot-definition 'sys::location))))
3841
3842(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
3843  (:method (value (slot-definition slot-definition))
3844    (slot-definition-dispatch slot-definition
3845      (set-slot-definition-location slot-definition value)
3846      (setf (slot-value slot-definition 'sys::location) value))))
3847
3848(atomic-defgeneric slot-definition-type (slot-definition)
3849  (:method ((slot-definition slot-definition))
3850    (slot-definition-dispatch slot-definition
3851      (%slot-definition-type slot-definition)
3852      (slot-value slot-definition 'sys::%type))))
3853
3854(atomic-defgeneric (setf slot-definition-type) (value slot-definition)
3855  (:method (value (slot-definition slot-definition))
3856    (slot-definition-dispatch slot-definition
3857      (set-slot-definition-type slot-definition value)
3858      (setf (slot-value slot-definition 'sys::%type) value))))
3859
3860(atomic-defgeneric slot-definition-documentation (slot-definition)
3861  (:method ((slot-definition slot-definition))
3862    (slot-definition-dispatch slot-definition
3863      (%slot-definition-documentation slot-definition)
3864      (slot-value slot-definition 'sys:%documentation))))
3865
3866(atomic-defgeneric (setf slot-definition-documentation) (value slot-definition)
3867  (:method (value (slot-definition slot-definition))
3868    (slot-definition-dispatch slot-definition
3869      (set-slot-definition-documentation slot-definition value)
3870      (setf (slot-value slot-definition 'sys:%documentation) value))))
3871
3872
3873;;; Conditions.
3874
3875(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
3876  (let ((parent-types (or parent-types '(condition)))
3877        (report nil))
3878    (dolist (option options)
3879      (when (eq (car option) :report)
3880        (setf report (cadr option))
3881  (setf options (delete option options :test #'equal))
3882        (return)))
3883    (typecase report
3884      (null
3885       `(progn
3886          (defclass ,name ,parent-types ,slot-specs ,@options)
3887          ',name))
3888      (string
3889       `(progn
3890          (defclass ,name ,parent-types ,slot-specs ,@options)
3891          (defmethod print-object ((condition ,name) stream)
3892            (if *print-escape*
3893                (call-next-method)
3894                (progn (write-string ,report stream) condition)))
3895          ',name))
3896      (t
3897       `(progn
3898          (defclass ,name ,parent-types ,slot-specs ,@options)
3899          (defmethod print-object ((condition ,name) stream)
3900            (if *print-escape*
3901                (call-next-method)
3902                (funcall #',report condition stream)))
3903          ',name)))))
3904
3905(defun make-condition (type &rest initargs)
3906  (or (%make-condition type initargs)
3907      (let ((class (if (symbolp type) (find-class type) type)))
3908        (apply #'make-instance class initargs))))
3909
3910;; Adapted from SBCL.
3911;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
3912(defun coerce-to-condition (datum arguments default-type fun-name)
3913  (cond ((typep datum 'condition)
3914         (when arguments
3915           (error 'simple-type-error
3916                  :datum arguments
3917                  :expected-type 'null
3918                  :format-control "You may not supply additional arguments when giving ~S to ~S."
3919                  :format-arguments (list datum fun-name)))
3920         datum)
3921        ((symbolp datum)
3922         (apply #'make-condition datum arguments))
3923        ((or (stringp datum) (functionp datum))
3924         (make-condition default-type
3925                         :format-control datum
3926                         :format-arguments arguments))
3927        (t
3928         (error 'simple-type-error
3929                :datum datum
3930                :expected-type '(or symbol string)
3931                :format-control "Bad argument to ~S: ~S."
3932                :format-arguments (list fun-name datum)))))
3933
3934(defgeneric make-load-form (object &optional environment))
3935
3936(defmethod make-load-form ((object t) &optional environment)
3937  (declare (ignore environment))
3938  (apply #'no-applicable-method #'make-load-form (list object)))
3939
3940(defmethod make-load-form ((class class) &optional environment)
3941  (declare (ignore environment))
3942  (let ((name (class-name class)))
3943    (unless (and name (eq (find-class name nil) class))
3944      (error 'simple-type-error
3945             :format-control "Can't use anonymous or undefined class as a constant: ~S."
3946             :format-arguments (list class)))
3947    `(find-class ',name)))
3948
3949(defun invalid-method-error (method format-control &rest args)
3950  (let ((message (apply #'format nil format-control args)))
3951    (error "Invalid method error for ~S:~%    ~A" method message)))
3952
3953(defun method-combination-error (format-control &rest args)
3954  (let ((message (apply #'format nil format-control args)))
3955    (error "Method combination error in CLOS dispatch:~%    ~A" message)))
3956
3957
3958(atomic-defgeneric no-applicable-method (generic-function &rest args)
3959  (:method (generic-function &rest args)
3960      (error "There is no applicable method for the generic function ~S ~
3961              when called with arguments ~S."
3962             generic-function
3963             args)))
3964
3965
3966;;; FIXME (rudi 2012-01-28): this can be a function, it only needs to
3967;;; use standard accessor functions
3968(defgeneric find-method (generic-function
3969                         qualifiers
3970                         specializers
3971                         &optional errorp))
3972
3973(defmethod find-method ((generic-function standard-generic-function)
3974                        qualifiers specializers &optional (errorp t))
3975  (%find-method generic-function qualifiers specializers errorp))
3976
3977(defgeneric find-method ((generic-function symbol)
3978                         qualifiers specializers &optional (errorp t))
3979  (find-method (find-generic-function generic-function errorp)
3980               qualifiers specializers errorp))
3981
3982;;; AMOP pg. 167
3983(defgeneric add-method (generic-function method))
3984
3985(defmethod add-method :before ((generic-function generic-function)
3986                               (method method))
3987  (when (and (method-generic-function method)
3988             (not (eql generic-function (method-generic-function method))))
3989    (error 'simple-error
3990           :format-control "~S is already a method of ~S, cannot add to ~S."
3991           :format-arguments (list method (method-generic-function method)
3992                                   generic-function)))
3993  (check-method-lambda-list (generic-function-name generic-function)
3994                            (method-lambda-list method)
3995                            (generic-function-lambda-list generic-function)))
3996
3997(defmethod add-method ((generic-function standard-generic-function)
3998                       (method standard-method))
3999  (std-add-method generic-function method))
4000
4001(defmethod add-method :after ((generic-function generic-function)
4002                              (method method))
4003  (map-dependents generic-function
4004                  #'(lambda (dep) (update-dependent generic-function dep
4005                                                    'add-method method))))
4006
4007(defgeneric remove-method (generic-function method))
4008
4009(defmethod remove-method ((generic-function standard-generic-function)
4010                          (method standard-method))
4011  (std-remove-method generic-function method))
4012
4013(defmethod remove-method :after ((generic-function generic-function)
4014                                 (method method))
4015  (map-dependents generic-function
4016                  #'(lambda (dep) (update-dependent generic-function dep
4017                                                    'remove-method method))))
4018
4019;; See describe.lisp.
4020(defgeneric describe-object (object stream))
4021
4022;; FIXME
4023(defgeneric no-next-method (generic-function method &rest args))
4024
4025(atomic-defgeneric function-keywords (method)
4026  (:method ((method standard-method))
4027    (std-function-keywords method)))
4028
4029(setf *gf-initialize-instance* (symbol-function 'initialize-instance))
4030(setf *gf-allocate-instance* (symbol-function 'allocate-instance))
4031(setf *gf-shared-initialize* (symbol-function 'shared-initialize))
4032(setf *gf-reinitialize-instance* (symbol-function 'reinitialize-instance))
4033(setf *clos-booting* nil)
4034
4035(defgeneric class-prototype (class))
4036
4037(defmethod class-prototype :before (class)
4038  (unless (class-finalized-p class)
4039    (error "~@<~S is not finalized.~:@>" class)))
4040
4041(defmethod class-prototype ((class standard-class))
4042  (allocate-instance class))
4043
4044(defmethod class-prototype ((class funcallable-standard-class))
4045  (allocate-instance class))
4046
4047(defmethod class-prototype ((class structure-class))
4048  (allocate-instance class))
4049
4050(defmethod shared-initialize :before ((instance generic-function)
4051                                      slot-names
4052                                      &key lambda-list argument-precedence-order
4053                                      &allow-other-keys)
4054  (check-argument-precedence-order lambda-list argument-precedence-order))
4055
4056(defmethod shared-initialize :after ((instance standard-generic-function)
4057                                     slot-names
4058                                     &key lambda-list argument-precedence-order
4059                                     &allow-other-keys)
4060  (let* ((plist (analyze-lambda-list lambda-list))
4061         (required-args (getf plist ':required-args)))
4062    (%set-gf-required-args instance required-args)
4063    (%set-gf-optional-args instance (getf plist :optional-args))
4064    (set-generic-function-argument-precedence-order
4065     instance (or argument-precedence-order required-args)))
4066  (finalize-standard-generic-function instance))
4067
4068;;; Readers for generic function metaobjects
4069;;; AMOP pg. 216ff.
4070(atomic-defgeneric generic-function-argument-precedence-order (generic-function)
4071  (:method ((generic-function standard-generic-function))
4072    (sys:%generic-function-argument-precedence-order generic-function)))
4073
4074(atomic-defgeneric generic-function-declarations (generic-function)
4075  (:method ((generic-function standard-generic-function))
4076    (sys:%generic-function-declarations generic-function)))
4077
4078(atomic-defgeneric generic-function-lambda-list (generic-function)
4079  (:method ((generic-function standard-generic-function))
4080    (sys:%generic-function-lambda-list generic-function)))
4081
4082(atomic-defgeneric generic-function-method-class (generic-function)
4083  (:method ((generic-function standard-generic-function))
4084    (sys:%generic-function-method-class generic-function)))
4085
4086(atomic-defgeneric generic-function-method-combination (generic-function)
4087  (:method ((generic-function standard-generic-function))
4088    (sys:%generic-function-method-combination generic-function)))
4089
4090(atomic-defgeneric generic-function-methods (generic-function)
4091  (:method ((generic-function standard-generic-function))
4092    (sys:%generic-function-methods generic-function)))
4093
4094(atomic-defgeneric generic-function-name (generic-function)
4095  (:method ((generic-function standard-generic-function))
4096    (sys:%generic-function-name generic-function)))
4097
4098;;; AMOP pg. 231
4099(defgeneric (setf generic-function-name) (new-value gf)
4100  (:method (new-value (gf generic-function))
4101    (reinitialize-instance gf :name new-value)))
4102
4103;;; Readers for Method Metaobjects
4104;;; AMOP pg. 218ff.
4105
4106(atomic-defgeneric method-function (method)
4107  (:method ((method standard-method))
4108    (std-method-function method)))
4109
4110(atomic-defgeneric method-generic-function (method)
4111  (:method ((method standard-method))
4112    (std-method-generic-function method)))
4113
4114(atomic-defgeneric method-lambda-list (method)
4115  (:method ((method standard-method))
4116    (std-slot-value method 'sys::lambda-list)))
4117
4118(atomic-defgeneric method-specializers (method)
4119  (:method ((method standard-method))
4120    (std-method-specializers method)))
4121
4122(atomic-defgeneric method-qualifiers (method)
4123  (:method ((method standard-method))
4124    (std-method-qualifiers method)))
4125
4126(atomic-defgeneric accessor-method-slot-definition (method)
4127  (:method ((method standard-accessor-method))
4128    (std-accessor-method-slot-definition method)))
4129
4130;;; specializer-direct-method and friends.
4131
4132;;; AMOP pg. 237
4133(defgeneric specializer-direct-generic-functions (specializer))
4134
4135(defmethod specializer-direct-generic-functions ((specializer class))
4136  (delete-duplicates (mapcar #'method-generic-function
4137                             (class-direct-methods specializer))))
4138
4139(defmethod specializer-direct-generic-functions ((specializer eql-specializer))
4140  (delete-duplicates (mapcar #'method-generic-function
4141                             (slot-value specializer 'direct-methods))))
4142
4143;;; AMOP pg. 238
4144(defgeneric specializer-direct-methods (specializer))
4145
4146(defmethod specializer-direct-methods ((specializer class))
4147  (class-direct-methods specializer))
4148
4149(defmethod specializer-direct-methods ((specializer eql-specializer))
4150  (slot-value specializer 'direct-methods))
4151
4152;;; AMOP pg. 165
4153(atomic-defgeneric add-direct-method (specializer method)
4154  (:method ((specializer class) (method method))
4155    (pushnew method (class-direct-methods specializer)))
4156  (:method ((specializer eql-specializer) (method method))
4157    (pushnew method (slot-value specializer 'direct-methods))))
4158
4159
4160;;; AMOP pg. 227
4161(atomic-defgeneric remove-direct-method (specializer method)
4162  (:method ((specializer class) (method method))
4163    (setf (class-direct-methods specializer)
4164          (remove method (class-direct-methods specializer))))
4165  (:method ((specializer eql-specializer) (method method))
4166    (setf (slot-value specializer 'direct-methods)
4167          (remove method (slot-value specializer 'direct-methods)))))
4168
4169;;; The Dependent Maintenance Protocol (AMOP pg. 160ff.)
4170
4171(defvar *dependents* (make-hash-table :test 'eq :weakness :key))
4172
4173;;; AMOP pg. 164
4174(defgeneric add-dependent (metaobject dependent))
4175(defmethod add-dependent ((metaobject standard-class) dependent)
4176  (pushnew dependent (gethash metaobject *dependents* nil)))
4177(defmethod add-dependent ((metaobject funcallable-standard-class) dependent)
4178  (pushnew dependent (gethash metaobject *dependents* nil)))
4179(defmethod add-dependent ((metaobject standard-generic-function) dependent)
4180  (pushnew dependent (gethash metaobject *dependents* nil)))
4181
4182;;; AMOP pg. 225
4183(defgeneric remove-dependent (metaobject dependent))
4184(defmethod remove-dependent ((metaobject standard-class) dependent)
4185  (setf (gethash metaobject *dependents*)
4186        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4187(defmethod remove-dependent ((metaobject funcallable-standard-class) dependent)
4188  (setf (gethash metaobject *dependents*)
4189        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4190(defmethod remove-dependent ((metaobject standard-generic-function) dependent)
4191  (setf (gethash metaobject *dependents*)
4192        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4193
4194;;; AMOP pg. 210
4195(atomic-defgeneric map-dependents (metaobject function)
4196  (:method ((metaobject standard-class) function)
4197    (dolist (dependent (gethash metaobject *dependents* nil))
4198      (funcall function dependent)))
4199  (:method ((metaobject funcallable-standard-class) function)
4200    (dolist (dependent (gethash metaobject *dependents* nil))
4201      (funcall function dependent)))
4202  (:method ((metaobject standard-generic-function) function)
4203    (dolist (dependent (gethash metaobject *dependents* nil))
4204      (funcall function dependent))))
4205
4206;;; AMOP pg. 239
4207(defgeneric update-dependent (metaobject dependent &rest initargs))
4208
4209
4210;;; ensure-generic-function(-using-class), AMOP pg. 185ff.
4211(defgeneric ensure-generic-function-using-class (generic-function function-name
4212                                                 &key
4213                                                   argument-precedence-order
4214                                                   declarations documentation
4215                                                   generic-function-class
4216                                                   lambda-list method-class
4217                                                   method-combination
4218                                                   name
4219                                                 &allow-other-keys))
4220
4221(defmethod ensure-generic-function-using-class ((generic-function generic-function)
4222                                                function-name
4223                                                &rest all-keys
4224                                                &key (generic-function-class +the-standard-generic-function-class+)
4225                                                  lambda-list
4226                                                  (method-class +the-standard-method-class+)
4227                                                &allow-other-keys)
4228  (setf all-keys (copy-list all-keys))  ; since we modify it
4229  (remf all-keys :generic-function-class)
4230  (unless (classp generic-function-class)
4231    (setf generic-function-class (find-class generic-function-class)))
4232  (unless (classp method-class) (setf method-class (find-class method-class)))
4233  (unless (eq generic-function-class (class-of generic-function))
4234    (error "The class ~S is incompatible with the existing class of ~S."
4235           generic-function-class generic-function))
4236  (unless (or (null (generic-function-methods generic-function))
4237              (lambda-lists-congruent-p lambda-list (generic-function-lambda-list generic-function)))
4238    (error "The lambda list ~S is incompatible with the existing methods of ~S."
4239           lambda-list generic-function))
4240  (unless (or (null (generic-function-methods generic-function))
4241              (eq method-class (generic-function-method-class generic-function)))
4242    (error "The method class ~S is incompatible with the existing methods of ~S."
4243           method-class generic-function))
4244  (apply #'reinitialize-instance generic-function
4245         :method-class method-class all-keys)
4246  generic-function)
4247
4248(defmethod ensure-generic-function-using-class ((generic-function null)
4249                                                function-name
4250                                                &rest all-keys
4251                                                &key (generic-function-class +the-standard-generic-function-class+)
4252                                                  (method-class +the-standard-method-class+)
4253                                                  (method-combination 'standard)
4254                                                &allow-other-keys)
4255  (setf all-keys (copy-list all-keys))  ; since we modify it
4256  (remf all-keys :generic-function-class)
4257  (unless (classp generic-function-class)
4258    (setf generic-function-class (find-class generic-function-class)))
4259  (unless (classp method-class) (setf method-class (find-class method-class)))
4260  (when (and (null *clos-booting*) (fboundp function-name))
4261    (if (autoloadp function-name)
4262        (fmakunbound function-name)
4263        (error 'program-error
4264               :format-control "~A already names an ordinary function, macro, or special operator."
4265               :format-arguments (list function-name))))
4266  (apply (if (eq generic-function-class +the-standard-generic-function-class+)
4267             #'make-instance-standard-generic-function
4268             #'make-instance)
4269         generic-function-class
4270         :name function-name
4271         :method-class method-class
4272         :method-combination method-combination
4273         all-keys))
4274
4275(defun ensure-generic-function (function-name &rest all-keys
4276                                &key
4277                                  lambda-list generic-function-class
4278                                  method-class
4279                                  method-combination
4280                                  argument-precedence-order
4281                                  declarations
4282                                  documentation
4283                                &allow-other-keys)
4284  (declare (ignore lambda-list generic-function-class method-class
4285                   method-combination argument-precedence-order declarations
4286                   documentation))
4287  (apply #'ensure-generic-function-using-class
4288         (find-generic-function function-name nil)
4289         function-name all-keys))
4290
4291;;; SLIME compatibility functions.
4292
4293(defun %method-generic-function (method)
4294  (method-generic-function method))
4295
4296(defun %method-function (method)
4297  (method-function method))
4298
4299(eval-when (:compile-toplevel :load-toplevel :execute)
4300  (require "MOP"))
4301
4302(provide 'clos)
4303
Note: See TracBrowser for help on using the repository browser.