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

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

More efficient arguments option variable references (&optional and &aux)
and support for supplied-p parameters (&optional) for long form D-M-C.

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