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

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

Commit comment that's been sitting in my working copy
(only for me to see) too long.

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