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

Last change on this file since 14053 was 14053, checked in by ehuelsmann, 10 years ago

Factor out the emf generating code from METHOD-COMBINATION-TYPE-LAMBDA
into its own function.

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