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

Last change on this file since 14914 was 14914, checked in by Mark Evenson, 5 years ago

Dramatically improve source recording on SYS::SOURCE plist for a symbol (Alan Ruttenberg)

The interface to recording information on the SYS:%SOURCE plist for a
symbol is now deprecated and will be removed with abcl-1.7.

Implementation


Source information for ABCL is now recorded on the SYS::SOURCE
property. The appropiate information for type is recorded by the
SYS::RECORD-SOURCE-INFORMATION-BY-TYPE function:

record-source-information-by-type (name type &optional source-pathname source-position)

TYPE is either a symbol or list.

Source information for functions, methods, and generic functions are
represented as lists of the following form:

(:generic-function function-name)
(:function function-name)
(:method method-name qualifiers specializers)

Where FUNCTION-NAME or METHOD-NAME can be a either be of the form
'symbol or '(setf symbol).

Source information for all other forms have a symbol for TYPE which is
one of the following:

:class, :variable, :condition, :constant, :compiler-macro, :macro
:package, :structure, :type, :setf-expander, :source-transform

These values follow SBCL'S implemenation in SLIME
c.f. <https://github.com/slime/slime/blob/bad2acf672c33b913aabc1a7facb9c3c16a4afe9/swank/sbcl.lisp#L748>

Modifications are in two places, one at the definitions, calling
record-source-information-by-type and then again in the file-compiler,
which writes forms like

(put 'source name (cons (list type pathname position) (get 'source name)))

In theory this can lead to redundancy if a fasl is loaded again and
again. I'm not sure how to fix this yet. Forms in the loader get
called early in build when many of the sequence functions aren't
present. Will probably just filter when presenting in slime.

<> :closes <http://abcl.org/trac/ticket/421> .
<> :merges <https://github.com/armedbear/abcl/pull/5> .

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