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

Last change on this file since 14028 was 14028, checked in by ehuelsmann, 9 years ago

When creating a generic function on top of an autoloader, don't
resolve the autoloader: that's probably what we are already doing
(but the function doesn't get replaced until autoloading has succeeded).

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