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

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

Fix required-part parsing in case of 'required-part-only'.

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