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

Last change on this file since 14007 was 14007, checked in by rschlatte, 9 years ago

Move definition of subclasses of standard-method metaclass to Lisp

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