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

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

fixes for (documentation x 'type) and (documentation x 'structure)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 197.0 KB
Line 
1;;; clos.lisp
2;;;
3;;; Copyright (C) 2003-2007 Peter Graves
4;;; Copyright (C) 2010 Mark Evenson
5;;; $Id: clos.lisp 14014 2012-07-21 14:02:32Z rschlatte $
6;;;
7;;; This program is free software; you can redistribute it and/or
8;;; modify it under the terms of the GNU General Public License
9;;; as published by the Free Software Foundation; either version 2
10;;; of the License, or (at your option) any later version.
11;;;
12;;; This program is distributed in the hope that it will be useful,
13;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15;;; GNU General Public License for more details.
16;;;
17;;; You should have received a copy of the GNU General Public License
18;;; along with this program; if not, write to the Free Software
19;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20;;;
21;;; As a special exception, the copyright holders of this library give you
22;;; permission to link this library with independent modules to produce an
23;;; executable, regardless of the license terms of these independent
24;;; modules, and to copy and distribute the resulting executable under
25;;; terms of your choice, provided that you also meet, for each linked
26;;; independent module, the terms and conditions of the license of that
27;;; module.  An independent module is a module which is not derived from
28;;; or based on this library.  If you modify this library, you may extend
29;;; this exception to your version of the library, but you are not
30;;; obligated to do so.  If you do not wish to do so, delete this
31;;; exception statement from your version.
32
33;;; Originally based on Closette.
34
35;;; Closette Version 1.0 (February 10, 1991)
36;;;
37;;; Copyright (c) 1990, 1991 Xerox Corporation.
38;;; All rights reserved.
39;;;
40;;; Use and copying of this software and preparation of derivative works
41;;; based upon this software are permitted.  Any distribution of this
42;;; software or derivative works must comply with all applicable United
43;;; States export control laws.
44;;;
45;;; This software is made available AS IS, and Xerox Corporation makes no
46;;; warranty about the software, its performance or its conformity to any
47;;; specification.
48;;;
49;;; Closette is an implementation of a subset of CLOS with a metaobject
50;;; protocol as described in "The Art of The Metaobject Protocol",
51;;; MIT Press, 1991.
52
53(in-package #:mop)
54
55;;
56;;
57;;
58;; In order to bootstrap CLOS, first implement the required API as
59;; normal functions which only apply to the "root" metaclass
60;; STANDARD-CLASS.
61;;
62;; After putting the normal functions in place, the building blocks
63;; are in place to gradually swap the normal functions with
64;; generic functions and methods.
65;;
66;; Some functionality implemented in the temporary regular functions
67;; needs to be available later as a method definition to be dispatched
68;; to for the standard case, e.g. with arguments of type STANDARD-CLASS
69;; or STANDARD-GENERIC-FUNCTION.  To prevent repeated code, the
70;; functions are implemented in functions by the same name as the API
71;; functions, but with the STD- prefix.  These functions are sometimes
72;; used in regular code as well, either in a "fast path" or to break a
73;; circularity (e.g., within compute-discriminating-function when the
74;; user adds a method to compute-discriminating-function).
75;;
76;; When hacking this file, note that some important parts are implemented
77;; in the Java world. These Java bits can be found in the files
78;;
79;; * LispClass.java
80;; * SlotClass.java
81;; * StandardClass.java
82;; * BuiltInClass.java
83;; * StandardObject.java
84;; * StandardObjectFunctions.java
85;; * FuncallableStandardObject.java
86;; * Layout.java
87;;
88;; In case of function names, those defined on the Java side can be
89;; recognized by their prefixed percent (%) sign.
90;;
91;; The API functions need to be declaimed NOTINLINE explicitly, because
92;; that prevents inlining in the current FASL (which is allowed by the
93;; CLHS without the declaration); this is a hard requirement to in order
94;; to be able to swap the symbol's function slot with a generic function
95;; later on - with it actually being used.
96;;
97;;
98;;
99;; ### Note that the "declares all API functions as regular functions"
100;; isn't true when I write the above, but it's definitely the target.
101;;
102;; A note about AMOP: the first chapters (and the sample Closette
103;; implementation) of the book sometimes deviate from the specification.
104;; For example, in the examples slot-value-using-class has the slot name
105;; as third argument where in the specification it is the effective slot
106;; definition.  When in doubt, we aim to follow the specification, the
107;; MOP test suite at http://common-lisp.net/project/closer/features.html
108;; and the behavior of other CL implementations in preference to
109;; chapters 1-4 and appendix D.
110
111(defconstant +the-standard-class+ (find-class 'standard-class))
112(defconstant +the-funcallable-standard-class+
113  (find-class 'funcallable-standard-class))
114(defconstant +the-structure-class+ (find-class 'structure-class))
115(defconstant +the-standard-object-class+ (find-class 'standard-object))
116(defconstant +the-funcallable-standard-object-class+
117  (find-class 'funcallable-standard-object))
118(defconstant +the-standard-method-class+ (find-class 'standard-method))
119(defconstant +the-forward-referenced-class+
120  (find-class 'forward-referenced-class))
121(defconstant +the-standard-generic-function-class+
122  (find-class 'standard-generic-function))
123(defconstant +the-T-class+ (find-class 'T))
124(defconstant +the-standard-slot-definition-class+ (find-class 'standard-slot-definition))
125(defconstant +the-standard-direct-slot-definition-class+ (find-class 'standard-direct-slot-definition))
126(defconstant +the-standard-effective-slot-definition-class+ (find-class 'standard-effective-slot-definition))
127
128;; Don't use DEFVAR, because that disallows loading clos.lisp
129;; after compiling it: the binding won't get assigned to T anymore
130(defparameter *clos-booting* t)
131
132(defmacro define-class->%class-forwarder (name)
133  (let* (($name (if (consp name) (cadr name) name))
134         (%name (intern (concatenate 'string
135                                     "%"
136                                     (if (consp name)
137                                         (symbol-name 'set-) "")
138                                     (symbol-name $name))
139                        (symbol-package $name))))
140    `(progn
141       (declaim (notinline ,name))
142       (defun ,name (&rest args)
143         (apply #',%name args)))))
144
145;;
146;;  DEFINE PLACE HOLDER FUNCTIONS
147;;
148
149(define-class->%class-forwarder class-name)
150(define-class->%class-forwarder (setf class-name))
151(define-class->%class-forwarder class-slots)
152(define-class->%class-forwarder (setf class-slots))
153(define-class->%class-forwarder class-direct-slots)
154(define-class->%class-forwarder (setf class-direct-slots))
155(define-class->%class-forwarder class-layout)
156(define-class->%class-forwarder (setf class-layout))
157(define-class->%class-forwarder class-direct-superclasses)
158(define-class->%class-forwarder (setf class-direct-superclasses))
159(define-class->%class-forwarder class-direct-subclasses)
160(define-class->%class-forwarder (setf class-direct-subclasses))
161(define-class->%class-forwarder class-direct-methods)
162(define-class->%class-forwarder (setf class-direct-methods))
163(define-class->%class-forwarder class-precedence-list)
164(define-class->%class-forwarder (setf class-precedence-list))
165(define-class->%class-forwarder class-finalized-p)
166(define-class->%class-forwarder (setf class-finalized-p))
167(define-class->%class-forwarder class-default-initargs)
168(define-class->%class-forwarder (setf class-default-initargs))
169(define-class->%class-forwarder class-direct-default-initargs)
170(define-class->%class-forwarder (setf class-direct-default-initargs))
171
172(declaim (notinline add-direct-subclass remove-direct-subclass))
173(defun add-direct-subclass (superclass subclass)
174  (setf (class-direct-subclasses superclass)
175        (adjoin subclass (class-direct-subclasses superclass))))
176(defun remove-direct-subclass (superclass subclass)
177  (setf (class-direct-subclasses superclass)
178        (remove subclass (class-direct-subclasses superclass))))
179
180(defun fixup-standard-class-hierarchy ()
181  ;; Make the result of class-direct-subclasses for the pre-built
182  ;; classes agree with AMOP Table 5.1 (pg. 141).  This could be done in
183  ;; StandardClass.java where these classes are defined, but it's less
184  ;; painful to do it Lisp-side.
185  (flet ((add-subclasses (class subclasses)
186           (when (atom subclasses) (setf subclasses (list subclasses)))
187           (setf (class-direct-subclasses (find-class class))
188                 (union (class-direct-subclasses (find-class class))
189                        (mapcar #'find-class subclasses)))))
190    (add-subclasses t 'standard-object)
191    (add-subclasses 'function 'funcallable-standard-object)
192    (add-subclasses 'standard-object '(funcallable-standard-object metaobject))
193    (add-subclasses 'metaobject
194                    '(generic-function method slot-definition specializer))
195    (add-subclasses 'specializer '(class))
196    (add-subclasses 'funcallable-standard-object 'generic-function)
197    (add-subclasses 'generic-function 'standard-generic-function)
198    (add-subclasses 'method 'standard-method)
199    (add-subclasses 'slot-definition
200                    '(direct-slot-definition effective-slot-definition
201                      standard-slot-definition))
202    (add-subclasses 'standard-slot-definition
203                    '(standard-direct-slot-definition
204                      standard-effective-slot-definition))
205    (add-subclasses 'direct-slot-definition 'standard-direct-slot-definition)
206    (add-subclasses 'effective-slot-definition
207                    'standard-effective-slot-definition)
208    (add-subclasses 'class
209                    '(built-in-class forward-referenced-class standard-class
210                      funcallable-standard-class))))
211(fixup-standard-class-hierarchy)
212
213(defun no-applicable-method (generic-function &rest args)
214  (error "There is no applicable method for the generic function ~S when called with arguments ~S."
215         generic-function
216         args))
217
218(defun function-keywords (method)
219  (std-function-keywords method))
220
221(declaim (notinline map-dependents))
222(defun map-dependents (metaobject function)
223  ;; stub, will be redefined later
224  (declare (ignore metaobject function))
225  nil)
226
227(defmacro push-on-end (value location)
228  `(setf ,location (nconc ,location (list ,value))))
229
230;;; (SETF GETF*) is like (SETF GETF) except that it always changes the list,
231;;; which must be non-nil.
232
233(defun (setf getf*) (new-value plist key)
234  (block body
235    (do ((x plist (cddr x)))
236        ((null x))
237      (when (eq (car x) key)
238        (setf (car (cdr x)) new-value)
239        (return-from body new-value)))
240    (push-on-end key plist)
241    (push-on-end new-value plist)
242    new-value))
243
244(defun mapappend (fun &rest args)
245  (if (some #'null args)
246      ()
247      (append (apply fun (mapcar #'car args))
248              (apply #'mapappend fun (mapcar #'cdr args)))))
249
250(defun mapplist (fun x)
251  (if (null x)
252      ()
253      (cons (funcall fun (car x) (cadr x))
254            (mapplist fun (cddr x)))))
255
256(defsetf std-instance-layout %set-std-instance-layout)
257(defsetf standard-instance-access %set-standard-instance-access)
258(defun funcallable-standard-instance-access (instance location)
259  (standard-instance-access instance location))
260(defsetf funcallable-standard-instance-access %set-standard-instance-access)
261
262(defun (setf find-class) (new-value symbol &optional errorp environment)
263  (declare (ignore errorp environment))
264  (%set-find-class symbol new-value))
265
266(defun canonicalize-direct-slots (direct-slots)
267  `(list ,@(mapcar #'canonicalize-direct-slot direct-slots)))
268
269(defun canonicalize-direct-slot (spec)
270  (if (symbolp spec)
271      `(list :name ',spec)
272      (let ((name (car spec))
273            (initfunction nil)
274            (initform nil)
275            (initargs ())
276            (type nil)
277            (allocation nil)
278            (documentation nil)
279            (readers ())
280            (writers ())
281            (other-options ())
282            (non-std-options ()))
283        (do ((olist (cdr spec) (cddr olist)))
284            ((null olist))
285          (case (car olist)
286            (:initform
287             (when initform
288               (error 'program-error
289                      "duplicate slot option :INITFORM for slot named ~S"
290                      name))
291             (setq initfunction t)
292             (setq initform (cadr olist)))
293            (:initarg
294             (push-on-end (cadr olist) initargs))
295            (:allocation
296             (when allocation
297               (error 'program-error
298                      "duplicate slot option :ALLOCATION for slot named ~S"
299                      name))
300             (setf allocation (cadr olist))
301             (push-on-end (car olist) other-options)
302             (push-on-end (cadr olist) other-options))
303            (:type
304             (when type
305               (error 'program-error
306                      "duplicate slot option :TYPE for slot named ~S"
307                      name))
308             (setf type (cadr olist)))
309            (:documentation
310             (when documentation
311               (error 'program-error
312                      "duplicate slot option :DOCUMENTATION for slot named ~S"
313                      name))
314             (setf documentation (cadr olist)))
315            (:reader
316             (maybe-note-name-defined (cadr olist))
317             (push-on-end (cadr olist) readers))
318            (:writer
319             (maybe-note-name-defined (cadr olist))
320             (push-on-end (cadr olist) writers))
321            (:accessor
322             (maybe-note-name-defined (cadr olist))
323             (push-on-end (cadr olist) readers)
324             (push-on-end `(setf ,(cadr olist)) writers))
325            (t
326             (push-on-end (cadr olist) (getf non-std-options (car olist))))))
327        `(list
328          :name ',name
329          ,@(when initfunction
330              `(:initform ',initform
331                :initfunction ,(if (eq allocation :class)
332                                   ;; CLHS specifies the initform for a
333                                   ;; class allocation level slot needs
334                                   ;; to be evaluated in the dynamic
335                                   ;; extent of the DEFCLASS form
336                                   (let ((var (gensym)))
337                                     `(let ((,var ,initform))
338                                        (lambda () ,var)))
339                                 `(lambda () ,initform))))
340          ,@(when initargs `(:initargs ',initargs))
341          ,@(when readers `(:readers ',readers))
342          ,@(when writers `(:writers ',writers))
343          ,@(when type `(:type ',type))
344          ,@(when documentation `(:documentation ',documentation))
345          ,@other-options
346          ,@(mapcar #'(lambda (opt) (if (or (atom opt) (/= 1 (length opt)))
347                                        `',opt
348                                        `',(car opt)))
349                    non-std-options)))))
350
351(defun maybe-note-name-defined (name)
352  (when (fboundp 'note-name-defined)
353    (note-name-defined name)))
354
355(defun canonicalize-defclass-options (options)
356  (mapappend #'canonicalize-defclass-option options))
357
358(defun canonicalize-defclass-option (option)
359  (case (car option)
360    (:metaclass
361     (list ':metaclass
362           `(find-class ',(cadr option))))
363    (:default-initargs
364     (list
365      ':direct-default-initargs
366      `(list ,@(mapplist
367                #'(lambda (key value)
368                    `(list ',key ',value ,(make-initfunction value)))
369                (cdr option)))))
370    ((:documentation :report)
371     (list (car option) `',(cadr option)))
372    (t (list `(quote ,(car option)) `(quote ,(cdr option))))))
373
374(defun make-initfunction (initform)
375  `(function (lambda () ,initform)))
376
377(defun slot-definition-allocation (slot-definition)
378  (%slot-definition-allocation slot-definition))
379
380(declaim (notinline (setf slot-definition-allocation)))
381(defun (setf slot-definition-allocation) (value slot-definition)
382  (set-slot-definition-allocation slot-definition value))
383
384(defun slot-definition-initargs (slot-definition)
385  (%slot-definition-initargs slot-definition))
386
387(declaim (notinline (setf slot-definition-initargs)))
388(defun (setf slot-definition-initargs) (value slot-definition)
389  (set-slot-definition-initargs slot-definition value))
390
391(defun slot-definition-initform (slot-definition)
392  (%slot-definition-initform slot-definition))
393
394(declaim (notinline (setf slot-definition-initform)))
395(defun (setf slot-definition-initform) (value slot-definition)
396  (set-slot-definition-initform slot-definition value))
397
398(defun slot-definition-initfunction (slot-definition)
399  (%slot-definition-initfunction slot-definition))
400
401(declaim (notinline (setf slot-definition-initfunction)))
402(defun (setf slot-definition-initfunction) (value slot-definition)
403  (set-slot-definition-initfunction slot-definition value))
404
405(defun slot-definition-name (slot-definition)
406  (%slot-definition-name slot-definition))
407
408(declaim (notinline (setf slot-definition-name)))
409(defun (setf slot-definition-name) (value slot-definition)
410  (set-slot-definition-name slot-definition value))
411
412(defun slot-definition-readers (slot-definition)
413  (%slot-definition-readers slot-definition))
414
415(declaim (notinline (setf slot-definition-readers)))
416(defun (setf slot-definition-readers) (value slot-definition)
417  (set-slot-definition-readers slot-definition value))
418
419(defun slot-definition-writers (slot-definition)
420  (%slot-definition-writers slot-definition))
421
422(declaim (notinline (setf slot-definition-writers)))
423(defun (setf slot-definition-writers) (value slot-definition)
424  (set-slot-definition-writers slot-definition value))
425
426(defun slot-definition-allocation-class (slot-definition)
427  (%slot-definition-allocation-class slot-definition))
428
429(declaim (notinline (setf slot-definition-allocation-class)))
430(defun (setf slot-definition-allocation-class) (value slot-definition)
431  (set-slot-definition-allocation-class slot-definition value))
432
433(defun slot-definition-location (slot-definition)
434  (%slot-definition-location slot-definition))
435
436(declaim (notinline (setf slot-definition-location-class)))
437(defun (setf slot-definition-location) (value slot-definition)
438  (set-slot-definition-location slot-definition value))
439
440(defun slot-definition-type (slot-definition)
441  (%slot-definition-type slot-definition))
442
443(declaim (notinline (setf slot-definition-type)))
444(defun (setf slot-definition-type) (value slot-definition)
445  (set-slot-definition-type slot-definition value))
446
447(defun slot-definition-documentation (slot-definition)
448  (%slot-definition-documentation slot-definition))
449
450(declaim (notinline (setf slot-definition-documentation)))
451(defun (setf slot-definition-documentation) (value slot-definition)
452  (set-slot-definition-documentation slot-definition value))
453
454(defun init-slot-definition (slot &key name
455                                    (initargs ())
456                                    (initform nil)
457                                    (initfunction nil)
458                                    (readers ())
459                                    (writers ())
460                                    (allocation :instance)
461                                    (allocation-class nil)
462                                    (type t)
463                                    (documentation nil))
464  (setf (slot-definition-name slot) name)
465  (setf (slot-definition-initargs slot) initargs)
466  (setf (slot-definition-initform slot) initform)
467  (setf (slot-definition-initfunction slot) initfunction)
468  (setf (slot-definition-readers slot) readers)
469  (setf (slot-definition-writers slot) writers)
470  (setf (slot-definition-allocation slot) allocation)
471  (setf (slot-definition-allocation-class slot) allocation-class)
472  (setf (slot-definition-type slot) type)
473  (setf (slot-definition-documentation slot) documentation)
474  slot)
475
476(declaim (notinline direct-slot-definition-class))
477(defun direct-slot-definition-class (class &rest args)
478  (declare (ignore class args))
479  +the-standard-direct-slot-definition-class+)
480
481(defun make-direct-slot-definition (class &rest args)
482  (let ((slot-class (apply #'direct-slot-definition-class class args)))
483    (if (eq slot-class +the-standard-direct-slot-definition-class+)
484        (let ((slot (make-slot-definition +the-standard-direct-slot-definition-class+)))
485          (apply #'init-slot-definition slot :allocation-class class args)
486          slot)
487        (progn
488          (let ((slot (apply #'make-instance slot-class :allocation-class class
489                             args)))
490            slot)))))
491
492(declaim (notinline effective-slot-definition-class))
493(defun effective-slot-definition-class (class &rest args)
494  (declare (ignore class args))
495  +the-standard-effective-slot-definition-class+)
496
497(defun make-effective-slot-definition (class &rest args)
498  (let ((slot-class (apply #'effective-slot-definition-class class args)))
499    (if (eq slot-class +the-standard-effective-slot-definition-class+)
500        (let ((slot (make-slot-definition +the-standard-effective-slot-definition-class+)))
501          (apply #'init-slot-definition slot args)
502          slot)
503        (progn
504          (let ((slot (apply #'make-instance slot-class args)))
505            slot)))))
506
507;;; finalize-inheritance
508
509(declaim (notinline compute-default-initargs))
510(defun compute-default-initargs (class)
511  (std-compute-default-initargs class))
512
513(defun std-compute-default-initargs (class)
514  (delete-duplicates
515   (mapcan #'(lambda (c)
516               (copy-list
517                (class-direct-default-initargs c)))
518           (class-precedence-list class))
519   :key #'car :from-end t))
520
521(defun std-finalize-inheritance (class)
522  ;; In case the class is already finalized, return
523  ;; immediately, as per AMOP.
524  (when (class-finalized-p class)
525    (return-from std-finalize-inheritance))
526  (setf (class-precedence-list class)
527   (funcall (if (eq (class-of class) +the-standard-class+)
528                #'std-compute-class-precedence-list
529                #'compute-class-precedence-list)
530            class))
531  (setf (class-slots class)
532        (funcall (if (eq (class-of class) +the-standard-class+)
533                     #'std-compute-slots
534                     #'compute-slots) class))
535  (let ((old-layout (class-layout class))
536        (length 0)
537        (instance-slots '())
538        (shared-slots '()))
539    (dolist (slot (class-slots class))
540      (case (slot-definition-allocation slot)
541        (:instance
542         (setf (slot-definition-location slot) length)
543         (incf length)
544         (push (slot-definition-name slot) instance-slots))
545        (:class
546         (unless (slot-definition-location slot)
547           (let ((allocation-class (slot-definition-allocation-class slot)))
548             (setf (slot-definition-location slot)
549                   (if (eq allocation-class class)
550                       (cons (slot-definition-name slot) +slot-unbound+)
551                       (slot-location allocation-class (slot-definition-name slot))))))
552         (push (slot-definition-location slot) shared-slots))))
553    (when old-layout
554      ;; Redefined class: initialize added shared slots.
555      (dolist (location shared-slots)
556        (let* ((slot-name (car location))
557               (old-location (layout-slot-location old-layout slot-name)))
558          (unless old-location
559            (let* ((slot-definition (find slot-name (class-slots class) :key 'slot-definition-name))
560                   (initfunction (slot-definition-initfunction slot-definition)))
561              (when initfunction
562                (setf (cdr location) (funcall initfunction))))))))
563    (setf (class-layout class)
564          (make-layout class (nreverse instance-slots) (nreverse shared-slots))))
565  (setf (class-default-initargs class)
566        (compute-default-initargs class))
567  (setf (class-finalized-p class) t))
568
569(declaim (notinline finalize-inheritance))
570(defun finalize-inheritance (class)
571  (std-finalize-inheritance class))
572
573
574;;; Class precedence lists
575
576(defun std-compute-class-precedence-list (class)
577  (let ((classes-to-order (collect-superclasses* class)))
578    (dolist (super classes-to-order)
579      (when (typep super 'forward-referenced-class)
580        (error "Can't compute class precedence list for class ~A ~
581                which depends on forward referenced class ~A." class super)))
582    (topological-sort classes-to-order
583                      (remove-duplicates
584                       (mapappend #'local-precedence-ordering
585                                  classes-to-order))
586                      #'std-tie-breaker-rule)))
587
588;;; topological-sort implements the standard algorithm for topologically
589;;; sorting an arbitrary set of elements while honoring the precedence
590;;; constraints given by a set of (X,Y) pairs that indicate that element
591;;; X must precede element Y.  The tie-breaker procedure is called when it
592;;; is necessary to choose from multiple minimal elements; both a list of
593;;; candidates and the ordering so far are provided as arguments.
594
595(defun topological-sort (elements constraints tie-breaker)
596  (let ((remaining-constraints constraints)
597        (remaining-elements elements)
598        (result ()))
599    (loop
600      (let ((minimal-elements
601             (remove-if
602              #'(lambda (class)
603                 (member class remaining-constraints
604                         :key #'cadr))
605              remaining-elements)))
606        (when (null minimal-elements)
607          (if (null remaining-elements)
608              (return-from topological-sort result)
609              (error "Inconsistent precedence graph.")))
610        (let ((choice (if (null (cdr minimal-elements))
611                          (car minimal-elements)
612                          (funcall tie-breaker
613                                   minimal-elements
614                                   result))))
615          (setq result (append result (list choice)))
616          (setq remaining-elements
617                (remove choice remaining-elements))
618          (setq remaining-constraints
619                (remove choice
620                        remaining-constraints
621                        :test #'member)))))))
622
623;;; In the event of a tie while topologically sorting class precedence lists,
624;;; the CLOS Specification says to "select the one that has a direct subclass
625;;; rightmost in the class precedence list computed so far."  The same result
626;;; is obtained by inspecting the partially constructed class precedence list
627;;; from right to left, looking for the first minimal element to show up among
628;;; the direct superclasses of the class precedence list constituent.
629;;; (There's a lemma that shows that this rule yields a unique result.)
630
631(defun std-tie-breaker-rule (minimal-elements cpl-so-far)
632  (dolist (cpl-constituent (reverse cpl-so-far))
633    (let* ((supers (class-direct-superclasses cpl-constituent))
634           (common (intersection minimal-elements supers)))
635      (when (not (null common))
636        (return-from std-tie-breaker-rule (car common))))))
637
638;;; This version of collect-superclasses* isn't bothered by cycles in the class
639;;; hierarchy, which sometimes happen by accident.
640
641(defun collect-superclasses* (class)
642  (labels ((all-superclasses-loop (seen superclasses)
643                                  (let ((to-be-processed
644                                         (set-difference superclasses seen)))
645                                    (if (null to-be-processed)
646                                        superclasses
647                                        (let ((class-to-process
648                                               (car to-be-processed)))
649                                          (all-superclasses-loop
650                                           (cons class-to-process seen)
651                                           (union (class-direct-superclasses
652                                                   class-to-process)
653                                                  superclasses)))))))
654          (all-superclasses-loop () (list class))))
655
656;;; The local precedence ordering of a class C with direct superclasses C_1,
657;;; C_2, ..., C_n is the set ((C C_1) (C_1 C_2) ...(C_n-1 C_n)).
658
659(defun local-precedence-ordering (class)
660  (mapcar #'list
661          (cons class
662                (butlast (class-direct-superclasses class)))
663          (class-direct-superclasses class)))
664
665;;; Slot inheritance
666
667(defun std-compute-slots (class)
668  (let* ((all-slots (mapappend #'class-direct-slots
669                               (class-precedence-list class)))
670         (all-names (remove-duplicates
671                     (mapcar 'slot-definition-name all-slots))))
672    (mapcar #'(lambda (name)
673               (funcall
674                (if (eq (class-of class) +the-standard-class+)
675                    #'std-compute-effective-slot-definition
676                    #'compute-effective-slot-definition)
677                class
678                name
679                (remove name all-slots
680                        :key 'slot-definition-name
681                        :test-not #'eq)))
682            all-names)))
683
684(defun std-compute-effective-slot-definition (class name direct-slots)
685  (let ((initer (find-if-not #'null direct-slots
686                             :key 'slot-definition-initfunction))
687        (documentation-slot (find-if-not #'null direct-slots
688                                         :key 'slot-definition-documentation))
689        (types (delete-duplicates
690                (delete t (mapcar #'slot-definition-type direct-slots))
691                :test #'equal)))
692    (make-effective-slot-definition
693     class
694     :name name
695     :initform (if initer
696                   (slot-definition-initform initer)
697                   nil)
698     :initfunction (if initer
699                       (slot-definition-initfunction initer)
700                       nil)
701     :initargs (remove-duplicates
702                (mapappend 'slot-definition-initargs
703                           direct-slots))
704     :allocation (slot-definition-allocation (car direct-slots))
705     :allocation-class (when (slot-boundp (car direct-slots)
706                                          'sys::allocation-class)
707                         ;;for some classes created in Java
708                         ;;(e.g. SimpleCondition) this slot is unbound
709                         (slot-definition-allocation-class (car direct-slots)))
710     :type (cond ((null types) t)
711                 ((= 1 (length types)) types)
712                 (t (list* 'and types)))
713     :documentation (if documentation-slot
714                        (documentation documentation-slot t)
715                        nil))))
716
717;;; Standard instance slot access
718
719;;; N.B. The location of the effective-slots slots in the class metaobject for
720;;; standard-class must be determined without making any further slot
721;;; references.
722
723(defun find-slot-definition (class slot-name)
724  (dolist (slot (class-slots class) nil)
725    (when (eq slot-name (slot-definition-name slot))
726      (return slot))))
727
728(defun slot-location (class slot-name)
729  (let ((slot (find-slot-definition class slot-name)))
730    (if slot
731        (slot-definition-location slot)
732        nil)))
733
734(defun instance-slot-location (instance slot-name)
735  (let ((layout (std-instance-layout instance)))
736    (and layout (layout-slot-location layout slot-name))))
737
738(defun slot-value (object slot-name)
739  (let* ((class (class-of object))
740         (metaclass (class-of class)))
741    (if (or (eq metaclass +the-standard-class+)
742            (eq metaclass +the-structure-class+)
743            (eq metaclass +the-funcallable-standard-class+))
744        (std-slot-value object slot-name)
745        (slot-value-using-class class object
746                                (find-slot-definition class slot-name)))))
747
748(defsetf std-slot-value set-std-slot-value)
749
750(defun %set-slot-value (object slot-name new-value)
751  (let* ((class (class-of object))
752         (metaclass (class-of class)))
753    (if (or (eq metaclass +the-standard-class+)
754            (eq metaclass +the-structure-class+)
755            (eq metaclass +the-funcallable-standard-class+))
756        (setf (std-slot-value object slot-name) new-value)
757        (setf (slot-value-using-class class object
758                                      (find-slot-definition class slot-name))
759              new-value))))
760
761(defsetf slot-value %set-slot-value)
762
763(defun slot-boundp (object slot-name)
764  (let* ((class (class-of object))
765         (metaclass (class-of class)))
766    (if (or (eq metaclass +the-standard-class+) 
767            (eq metaclass +the-funcallable-standard-class+))
768        (std-slot-boundp object slot-name)
769        (slot-boundp-using-class class object
770                                 (find-slot-definition class slot-name)))))
771
772(defun std-slot-makunbound (instance slot-name)
773  (let ((location (instance-slot-location instance slot-name)))
774    (cond ((fixnump location)
775           (setf (standard-instance-access instance location) +slot-unbound+))
776          ((consp location)
777           (setf (cdr location) +slot-unbound+))
778          (t
779           (slot-missing (class-of instance) instance slot-name 'slot-makunbound))))
780  instance)
781
782(defun slot-makunbound (object slot-name)
783  (let* ((class (class-of object))
784         (metaclass (class-of class)))
785    (if (or (eq metaclass +the-standard-class+)
786            (eq metaclass +the-funcallable-standard-class+))
787        (std-slot-makunbound object slot-name)
788        (slot-makunbound-using-class class object
789                                     (find-slot-definition class slot-name)))))
790
791(defun std-slot-exists-p (instance slot-name)
792  (not (null (find slot-name (class-slots (class-of instance))
793                   :key 'slot-definition-name))))
794
795(defun slot-exists-p (object slot-name)
796  (if (eq (class-of (class-of object)) +the-standard-class+)
797      (std-slot-exists-p object slot-name)
798      (slot-exists-p-using-class (class-of object) object slot-name)))
799
800(defun instance-slot-p (slot)
801  (eq (slot-definition-allocation slot) :instance))
802
803(defun std-allocate-instance (class)
804  (sys::%std-allocate-instance class))
805
806(defun allocate-funcallable-instance (class)
807  (let ((instance (sys::%allocate-funcallable-instance class)))
808    (set-funcallable-instance-function
809     instance
810     #'(lambda (&rest args)
811         (declare (ignore args))
812         (error 'program-error "Called a funcallable-instance with unset function.")))
813    instance))
814
815(declaim (notinline class-prototype))
816(defun class-prototype (class)
817  (unless (class-finalized-p class) (error "Class ~A not finalized" (class-name class)))
818  (std-allocate-instance class))
819
820(defun maybe-finalize-class-subtree (class)
821  (when (every #'class-finalized-p (class-direct-superclasses class))
822    (finalize-inheritance class)
823    (dolist (subclass (class-direct-subclasses class))
824      (maybe-finalize-class-subtree subclass))))
825
826(defun make-instance-standard-class (metaclass
827                                     &rest initargs
828                                     &key name direct-superclasses direct-slots
829                                       direct-default-initargs
830                                       documentation)
831  (declare (ignore metaclass))
832  (let ((class (std-allocate-instance +the-standard-class+)))
833    (unless *clos-booting*
834      (check-initargs (list #'allocate-instance #'initialize-instance)
835                      (list* class initargs)
836                      class t initargs
837                      *make-instance-initargs-cache* 'make-instance))
838    (%set-class-name name class)
839    ;; KLUDGE: necessary in define-primordial-class, otherwise
840    ;; StandardClass.getClassLayout() throws an error
841    (unless *clos-booting* (%set-class-layout nil class))
842    (%set-class-direct-subclasses ()  class)
843    (%set-class-direct-methods ()  class)
844    (%set-class-documentation class documentation)
845    (std-after-initialization-for-classes class
846                                          :direct-superclasses direct-superclasses
847                                          :direct-slots direct-slots
848                                          :direct-default-initargs direct-default-initargs)
849    class))
850
851;(defun convert-to-direct-slot-definition (class canonicalized-slot)
852;  (apply #'make-instance
853;         (apply #'direct-slot-definition-class
854;                class canonicalized-slot)
855;         canonicalized-slot))
856
857(defun std-after-initialization-for-classes (class
858                                             &key direct-superclasses direct-slots
859                                             direct-default-initargs
860                                             &allow-other-keys)
861  (let ((supers (cond (direct-superclasses)
862                      ((subtypep (class-of class)
863                                 +the-funcallable-standard-class+)
864                       (list +the-funcallable-standard-object-class+))
865                      ((subtypep (class-of class) +the-standard-class+)
866                       (list +the-standard-object-class+)))))
867    (setf (class-direct-superclasses class) supers)
868    (dolist (superclass supers)
869      (add-direct-subclass superclass class)))
870  (let ((slots (mapcar #'(lambda (slot-properties)
871                          (apply #'make-direct-slot-definition class slot-properties))
872                       direct-slots)))
873    (setf (class-direct-slots class) slots)
874    (dolist (direct-slot slots)
875      (dolist (reader (slot-definition-readers direct-slot))
876        (add-reader-method class reader direct-slot))
877      (dolist (writer (slot-definition-writers direct-slot))
878        (add-writer-method class writer direct-slot))))
879  (setf (class-direct-default-initargs class) direct-default-initargs)
880  (maybe-finalize-class-subtree class)
881  (values))
882
883;;; Bootstrap the lower parts of the metaclass hierarchy.
884
885(defmacro define-primordial-class (name superclasses direct-slots)
886  "Primitive class definition tool.
887No non-standard metaclasses, accessor methods, duplicate slots,
888non-existent superclasses, default initargs, or other complicated stuff.
889Handle with care."
890  (let ((class (gensym)))
891    `(let ((,class (make-instance-standard-class
892                    nil
893                    :name ',name
894                    :direct-superclasses ',(mapcar #'find-class superclasses)
895                    :direct-slots ,(canonicalize-direct-slots direct-slots))))
896       (%set-find-class ',name ,class)
897       ,class)))
898
899(define-primordial-class eql-specializer (specializer)
900  ((object :initform nil)
901   (direct-methods :initform nil)))
902
903(define-primordial-class method-combination (metaobject)
904  ((sys::name :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                   (if (typep specializer 'eql-specializer)
2170                       (let ((specializer-object (eql-specializer-object specializer)))
2171                         #'(lambda (arg)
2172                             (declare (optimize speed))
2173                             (if (eql arg specializer-object)
2174                                 (funcall function arg)
2175                                 (no-applicable-method gf (list arg)))))
2176                       #'(lambda (arg)
2177                           (declare (optimize speed))
2178                           (unless (simple-typep arg specializer)
2179                             ;; FIXME no applicable method
2180                             (error 'simple-type-error
2181                                    :datum arg
2182                                    :expected-type specializer))
2183                           (funcall function arg)))))
2184                (t
2185                 #'(lambda (arg)
2186                     (declare (optimize speed))
2187                     (let* ((specialization
2188                             (%get-arg-specialization gf arg))
2189                            (emfun (or (gethash1 specialization
2190                                                 emf-table)
2191                                       (slow-method-lookup-1
2192                                        gf arg specialization))))
2193                       (if emfun
2194                           (funcall emfun (list arg))
2195                           (apply #'no-applicable-method gf (list arg))))))))
2196             ((= number-required 2)
2197              #'(lambda (arg1 arg2)
2198                  (declare (optimize speed))
2199                  (let* ((args (list arg1 arg2))
2200                         (emfun (get-cached-emf gf args)))
2201                    (if emfun
2202                        (funcall emfun args)
2203                        (slow-method-lookup gf args)))))
2204             ((= number-required 3)
2205              #'(lambda (arg1 arg2 arg3)
2206                  (declare (optimize speed))
2207                  (let* ((args (list arg1 arg2 arg3))
2208                         (emfun (get-cached-emf gf args)))
2209                    (if emfun
2210                        (funcall emfun args)
2211                        (slow-method-lookup gf args)))))
2212             (t
2213              #'(lambda (&rest args)
2214                  (declare (optimize speed))
2215                  (let ((len (length args)))
2216                    (unless (= len number-required)
2217                      (error 'program-error
2218                             :format-control "Not enough arguments for generic function ~S."
2219                             :format-arguments (list (%generic-function-name gf)))))
2220                  (let ((emfun (get-cached-emf gf args)))
2221                    (if emfun
2222                        (funcall emfun args)
2223                        (slow-method-lookup gf args))))))
2224           ;;           (let ((non-key-args (+ number-required
2225           ;;                                  (length (gf-optional-args gf))))))
2226           #'(lambda (&rest args)
2227               (declare (optimize speed))
2228               (let ((len (length args)))
2229                 (unless (>= len number-required)
2230                   (error 'program-error
2231                          :format-control "Not enough arguments for generic function ~S."
2232                          :format-arguments (list (%generic-function-name gf)))))
2233               (let ((emfun (get-cached-emf gf args)))
2234                 (if emfun
2235                     (funcall emfun args)
2236                     (slow-method-lookup gf args)))))))))
2237
2238(defun sort-methods (methods gf required-classes)
2239  (if (or (null methods) (null (%cdr methods)))
2240      methods
2241      (sort methods
2242            (if (eq (class-of gf) +the-standard-generic-function-class+)
2243                (let ((method-indices
2244                       (argument-precedence-order-indices
2245                        (generic-function-argument-precedence-order gf)
2246                        (getf (analyze-lambda-list (generic-function-lambda-list gf))
2247                              ':required-args))))
2248                  #'(lambda (m1 m2)
2249                      (std-method-more-specific-p
2250                       m1 m2 required-classes method-indices)))
2251                #'(lambda (m1 m2)
2252                    (method-more-specific-p gf m1 m2 required-classes))))))
2253
2254(defun method-applicable-p (method args)
2255  (do* ((specializers (method-specializers method) (cdr specializers))
2256        (args args (cdr args)))
2257       ((null specializers) t)
2258    (let ((specializer (car specializers)))
2259      (if (typep specializer 'eql-specializer)
2260          (unless (eql (car args) (eql-specializer-object specializer))
2261            (return nil))
2262          (unless (subclassp (class-of (car args)) specializer)
2263            (return nil))))))
2264
2265(defun std-compute-applicable-methods (gf args)
2266  (let ((required-classes (mapcar #'class-of (required-portion gf args)))
2267        (methods '()))
2268    (dolist (method (generic-function-methods gf))
2269      (when (method-applicable-p method args)
2270        (push method methods)))
2271    (sort-methods methods gf required-classes)))
2272
2273(declaim (notinline compute-applicable-methods))
2274(defun compute-applicable-methods (gf args)
2275  (std-compute-applicable-methods gf args))
2276
2277;;; METHOD-APPLICABLE-USING-CLASSES-P
2278;;;
2279;;; If the first return value is T, METHOD is definitely applicable to
2280;;; arguments that are instances of CLASSES.  If the first value is
2281;;; NIL and the second value is T, METHOD is definitely not applicable
2282;;; to arguments that are instances of CLASSES; if the second value is
2283;;; NIL the applicability of METHOD cannot be determined by inspecting
2284;;; the classes of its arguments only.
2285;;;
2286(defun method-applicable-using-classes-p (method classes)
2287  (do* ((specializers (method-specializers method) (cdr specializers))
2288        (classes classes (cdr classes))
2289        (knownp t))
2290       ((null specializers)
2291        (if knownp (values t t) (values nil nil)))
2292    (let ((specializer (car specializers)))
2293      (if (typep specializer 'eql-specializer)
2294          (if (eql (class-of (eql-specializer-object specializer)) 
2295                   (car classes))
2296              (setf knownp nil)
2297              (return (values nil t)))
2298          (unless (subclassp (car classes) specializer)
2299            (return (values nil t)))))))
2300
2301(defun check-applicable-method-keyword-args (gf args
2302                                             keyword-args
2303                                             applicable-keywords)
2304  (when (oddp (length keyword-args))
2305    (error 'program-error
2306           :format-control "Odd number of keyword arguments in call to ~S ~
2307with arguments list ~S"
2308           :format-arguments (list gf args)))
2309  (unless (getf keyword-args :allow-other-keys)
2310    (loop for key in keyword-args by #'cddr
2311       unless (or (member key applicable-keywords)
2312                  (eq key :allow-other-keys))
2313       do (error 'program-error
2314                 :format-control "Invalid keyword argument ~S in call ~
2315to ~S with argument list ~S."
2316                 :format-arguments (list key gf args)))))
2317
2318(defun compute-applicable-keywords (gf applicable-methods)
2319  (let ((applicable-keywords
2320         (getf (analyze-lambda-list (generic-function-lambda-list gf))
2321               :keywords)))
2322    (loop for method in applicable-methods
2323       do (multiple-value-bind
2324                (keywords allow-other-keys)
2325              (function-keywords method)
2326            (when allow-other-keys
2327              (setf applicable-keywords :any)
2328              (return))
2329            (setf applicable-keywords
2330                  (union applicable-keywords keywords))))
2331    applicable-keywords))
2332
2333(defun wrap-emfun-for-keyword-args-check (gf emfun non-keyword-args
2334                                          applicable-keywords)
2335  #'(lambda (args)
2336      (check-applicable-method-keyword-args
2337         gf args
2338         (nthcdr non-keyword-args args) applicable-keywords)
2339      (funcall emfun args)))
2340
2341(defun slow-method-lookup (gf args)
2342  (let ((applicable-methods
2343          (if (eq (class-of gf) +the-standard-generic-function-class+)
2344              (std-compute-applicable-methods gf args)
2345              (or (compute-applicable-methods-using-classes gf (mapcar #'class-of args))
2346                  (compute-applicable-methods gf args)))))
2347    (if applicable-methods
2348        (let* ((emfun (funcall (if (eq (class-of gf)
2349                                       +the-standard-generic-function-class+)
2350                                   #'std-compute-effective-method
2351                                   #'compute-effective-method)
2352                               gf (generic-function-method-combination gf)
2353                               applicable-methods))
2354               (non-keyword-args (+ (length (gf-required-args gf))
2355                                    (length (gf-optional-args gf))))
2356               (gf-lambda-list (generic-function-lambda-list gf))
2357               (checks-required (and (member '&key gf-lambda-list)
2358                                     (not (member '&allow-other-keys
2359                                                  gf-lambda-list))))
2360              (applicable-keywords
2361               (when checks-required
2362                 ;; Don't do applicable keyword checks when this is
2363                 ;; one of the 'exceptional four' or when the gf allows
2364                 ;; other keywords.
2365                 (compute-applicable-keywords gf applicable-methods))))
2366          (when (and checks-required
2367                     (not (eq applicable-keywords :any)))
2368            (setf emfun
2369                  (wrap-emfun-for-keyword-args-check gf emfun non-keyword-args
2370                                                     applicable-keywords)))
2371          (cache-emf gf args emfun)
2372          (funcall emfun args))
2373        (apply #'no-applicable-method gf args))))
2374
2375(defun slow-method-lookup-1 (gf arg arg-specialization)
2376  (let ((applicable-methods
2377          (if (eq (class-of gf) +the-standard-generic-function-class+)
2378              (std-compute-applicable-methods gf (list arg))
2379              (or (compute-applicable-methods-using-classes gf (list (class-of arg)))
2380                  (compute-applicable-methods gf (list arg))))))
2381    (if applicable-methods
2382        (let ((emfun (funcall (if (eq (class-of gf)
2383                                      +the-standard-generic-function-class+)
2384                                  #'std-compute-effective-method
2385                                  #'compute-effective-method)
2386                              gf (generic-function-method-combination gf)
2387                              applicable-methods)))
2388          (when emfun
2389            (setf (gethash arg-specialization (classes-to-emf-table gf)) emfun))
2390          emfun))))
2391
2392(defun sub-specializer-p (c1 c2 c-arg)
2393  (find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
2394
2395(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
2396  (if argument-precedence-order
2397      (let ((specializers-1 (std-method-specializers method1))
2398            (specializers-2 (std-method-specializers method2)))
2399        (dolist (index argument-precedence-order)
2400          (let ((spec1 (nth index specializers-1))
2401                (spec2 (nth index specializers-2)))
2402            (unless (eq spec1 spec2)
2403              (cond ((typep spec1 'eql-specializer)
2404                     (return t))
2405                    ((typep spec2 'eql-specializer)
2406                     (return nil))
2407                    (t
2408                     (return (sub-specializer-p spec1 spec2
2409                                                (nth index required-classes)))))))))
2410      (do ((specializers-1 (std-method-specializers method1) (cdr specializers-1))
2411           (specializers-2 (std-method-specializers method2) (cdr specializers-2))
2412           (classes required-classes (cdr classes)))
2413          ((null specializers-1) nil)
2414        (let ((spec1 (car specializers-1))
2415              (spec2 (car specializers-2)))
2416          (unless (eq spec1 spec2)
2417            (cond ((typep spec1 'eql-specializer)
2418                   (return t))
2419                  ((typep spec2 'eql-specializer)
2420                   (return nil))
2421                  (t
2422                   (return (sub-specializer-p spec1 spec2 (car classes))))))))))
2423
2424(defun primary-method-p (method)
2425  (null (intersection '(:before :after :around) (method-qualifiers method))))
2426
2427(defun before-method-p (method)
2428  (equal '(:before) (method-qualifiers method)))
2429
2430(defun after-method-p (method)
2431  (equal '(:after) (method-qualifiers method)))
2432
2433(defun around-method-p (method)
2434  (equal '(:around) (method-qualifiers method)))
2435
2436(defun process-next-method-list (next-method-list)
2437  (mapcar #'(lambda (next-method-form)
2438              (cond
2439                ((listp next-method-form)
2440                 (assert (eq (first next-method-form) 'make-method))
2441                 (let* ((rest-sym (gensym)))
2442                   (make-instance-standard-method
2443                    nil ;; ignored
2444                    :lambda-list (list '&rest rest-sym)
2445                    :function (compute-method-function `(lambda (&rest ,rest-sym)
2446                                                          ,(second next-method-form))))))
2447                (t
2448                 (assert (typep next-method-form 'method))
2449                 next-method-form)))
2450          next-method-list))
2451
2452(defun std-compute-effective-method (gf method-combination methods)
2453  (assert (typep method-combination 'method-combination))
2454  (let* ((mc-name (method-combination-name method-combination))
2455         (options (slot-value method-combination 'options))
2456         (order (car options))
2457         (primaries '())
2458         (arounds '())
2459         around
2460         emf-form
2461         (long-method-combination-p
2462          (typep method-combination 'long-method-combination)))
2463    (unless long-method-combination-p
2464      (dolist (m methods)
2465        (let ((qualifiers (method-qualifiers m)))
2466          (cond ((null qualifiers)
2467                 (if (eq mc-name 'standard)
2468                     (push m primaries)
2469                     (error "Method combination type mismatch: missing qualifier for method combination ~S." method-combination)))
2470                ((cdr qualifiers)
2471                 (error "Invalid method qualifiers."))
2472                ((eq (car qualifiers) :around)
2473                 (push m arounds))
2474                ((eq (car qualifiers) mc-name)
2475                 (push m primaries))
2476                ((memq (car qualifiers) '(:before :after)))
2477                (t
2478                 (error "Invalid method qualifiers."))))))
2479    (unless (eq order :most-specific-last)
2480      (setf primaries (nreverse primaries)))
2481    (setf arounds (nreverse arounds))
2482    (setf around (car arounds))
2483    (when (and (null primaries) (not long-method-combination-p))
2484      (error "No primary methods for the generic function ~S." gf))
2485    (cond
2486      (around
2487       (let ((next-emfun
2488              (funcall
2489               (if (eq (class-of gf) +the-standard-generic-function-class+)
2490                   #'std-compute-effective-method
2491                   #'compute-effective-method)
2492               gf method-combination (remove around methods))))
2493         (setf emf-form
2494               (generate-emf-lambda (method-function around) next-emfun))))
2495      ((eq mc-name 'standard)
2496       (let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2497              (befores (remove-if-not #'before-method-p methods))
2498              (reverse-afters
2499               (reverse (remove-if-not #'after-method-p methods))))
2500         (setf emf-form
2501               (cond
2502                 ((and (null befores) (null reverse-afters))
2503                  (let ((fast-function (std-method-fast-function (car primaries))))
2504                    (if fast-function
2505                        (ecase (length (gf-required-args gf))
2506                          (1
2507                           #'(lambda (args)
2508                               (declare (optimize speed))
2509                               (funcall fast-function (car args))))
2510                          (2
2511                           #'(lambda (args)
2512                               (declare (optimize speed))
2513                               (funcall fast-function (car args) (cadr args)))))
2514                        (generate-emf-lambda (std-method-function (car primaries))
2515                                             next-emfun))))
2516                 (t
2517                  (let ((method-function (method-function (car primaries))))
2518                    #'(lambda (args)
2519                        (declare (optimize speed))
2520                        (dolist (before befores)
2521                          (funcall (method-function before) args nil))
2522                        (multiple-value-prog1
2523                            (funcall method-function args next-emfun)
2524                          (dolist (after reverse-afters)
2525                            (funcall (method-function after) args nil))))))))))
2526      (long-method-combination-p
2527       (let ((function (long-method-combination-function method-combination))
2528             (arguments (slot-value method-combination 'options)))
2529         (assert function)
2530         (setf emf-form
2531               (if arguments
2532                   (apply function gf methods arguments)
2533                   (funcall function gf methods)))))
2534      (t
2535       (unless (typep method-combination 'short-method-combination)
2536         (error "Unsupported method combination type ~A." mc-name))
2537       (let ((operator (short-method-combination-operator method-combination))
2538             (ioa (short-method-combination-identity-with-one-argument method-combination)))
2539         (setf emf-form
2540               (if (and ioa (null (cdr primaries)))
2541                   (generate-emf-lambda (method-function (car primaries)) nil)
2542                   `(lambda (args)
2543                      (,operator ,@(mapcar
2544                                    (lambda (primary)
2545                                      `(funcall ,(method-function primary) args nil))
2546                                    primaries))))))))
2547    (assert (not (null emf-form)))
2548    (or #+nil (ignore-errors (autocompile emf-form))
2549        (coerce-to-function emf-form))))
2550
2551(defun generate-emf-lambda (method-function next-emfun)
2552  #'(lambda (args)
2553      (declare (optimize speed))
2554      (funcall method-function args next-emfun)))
2555
2556;;; compute an effective method function from a list of primary methods:
2557
2558(defun compute-primary-emfun (methods)
2559  (if (null methods)
2560      nil
2561      (let ((next-emfun (compute-primary-emfun (cdr methods))))
2562        #'(lambda (args)
2563           (funcall (std-method-function (car methods)) args next-emfun)))))
2564
2565(defvar *call-next-method-p*)
2566(defvar *next-method-p-p*)
2567
2568(defun walk-form (form)
2569  (cond ((atom form)
2570         (cond ((eq form 'call-next-method)
2571                (setf *call-next-method-p* t))
2572               ((eq form 'next-method-p)
2573                (setf *next-method-p-p* t))))
2574        (t
2575         (walk-form (%car form))
2576         (walk-form (%cdr form)))))
2577
2578(defun compute-method-function (lambda-expression)
2579  (let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2580        (body (cddr lambda-expression))
2581        (*call-next-method-p* nil)
2582        (*next-method-p-p* nil))
2583    (multiple-value-bind (body declarations) (parse-body body)
2584      (let ((ignorable-vars '()))
2585        (dolist (var lambda-list)
2586          (if (memq var lambda-list-keywords)
2587              (return)
2588              (push var ignorable-vars)))
2589        (push `(declare (ignorable ,@ignorable-vars)) declarations))
2590      (walk-form body)
2591      (cond ((or *call-next-method-p* *next-method-p-p*)
2592             `(lambda (args next-emfun)
2593                (flet ((call-next-method (&rest cnm-args)
2594                         (if (null next-emfun)
2595                             (error "No next method for generic function.")
2596                             (funcall next-emfun (or cnm-args args))))
2597                       (next-method-p ()
2598                         (not (null next-emfun))))
2599                  (declare (ignorable (function call-next-method)
2600                                      (function next-method-p)))
2601                  (apply #'(lambda ,lambda-list ,@declarations ,@body) args))))
2602            ((null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2603             ;; Required parameters only.
2604             (case (length lambda-list)
2605               (1
2606                `(lambda (args next-emfun)
2607                   (declare (ignore next-emfun))
2608                   (let ((,(%car lambda-list) (%car args)))
2609                     (declare (ignorable ,(%car lambda-list)))
2610                     ,@declarations ,@body)))
2611               (2
2612                `(lambda (args next-emfun)
2613                   (declare (ignore next-emfun))
2614                   (let ((,(%car lambda-list) (%car args))
2615                         (,(%cadr lambda-list) (%cadr args)))
2616                     (declare (ignorable ,(%car lambda-list)
2617                                         ,(%cadr lambda-list)))
2618                     ,@declarations ,@body)))
2619               (3
2620                `(lambda (args next-emfun)
2621                   (declare (ignore next-emfun))
2622                   (let ((,(%car lambda-list) (%car args))
2623                         (,(%cadr lambda-list) (%cadr args))
2624                         (,(%caddr lambda-list) (%caddr args)))
2625                     (declare (ignorable ,(%car lambda-list)
2626                                         ,(%cadr lambda-list)
2627                                         ,(%caddr lambda-list)))
2628                     ,@declarations ,@body)))
2629               (t
2630                `(lambda (args next-emfun)
2631                   (declare (ignore next-emfun))
2632                   (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))
2633            (t
2634             `(lambda (args next-emfun)
2635                (declare (ignore next-emfun))
2636                (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))))
2637
2638(defun compute-method-fast-function (lambda-expression)
2639  (let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2640    (when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2641      (return-from compute-method-fast-function nil))
2642    ;; Only required args.
2643    (let ((body (cddr lambda-expression))
2644          (*call-next-method-p* nil)
2645          (*next-method-p-p* nil))
2646      (multiple-value-bind (body declarations) (parse-body body)
2647        (walk-form body)
2648        (when (or *call-next-method-p* *next-method-p-p*)
2649          (return-from compute-method-fast-function nil))
2650        (let ((decls `(declare (ignorable ,@lambda-list))))
2651          (setf lambda-expression
2652                (list* (car lambda-expression)
2653                       (cadr lambda-expression)
2654                       decls
2655                       (cddr lambda-expression))))
2656        (case (length lambda-list)
2657          (1
2658;;            `(lambda (args next-emfun)
2659;;               (let ((,(%car lambda-list) (%car args)))
2660;;                 (declare (ignorable ,(%car lambda-list)))
2661;;                 ,@declarations ,@body)))
2662           lambda-expression)
2663          (2
2664;;            `(lambda (args next-emfun)
2665;;               (let ((,(%car lambda-list) (%car args))
2666;;                     (,(%cadr lambda-list) (%cadr args)))
2667;;                 (declare (ignorable ,(%car lambda-list)
2668;;                                     ,(%cadr lambda-list)))
2669;;                 ,@declarations ,@body)))
2670           lambda-expression)
2671;;           (3
2672;;            `(lambda (args next-emfun)
2673;;               (let ((,(%car lambda-list) (%car args))
2674;;                     (,(%cadr lambda-list) (%cadr args))
2675;;                     (,(%caddr lambda-list) (%caddr args)))
2676;;                 (declare (ignorable ,(%car lambda-list)
2677;;                                     ,(%cadr lambda-list)
2678;;                                     ,(%caddr lambda-list)))
2679;;                 ,@declarations ,@body)))
2680          (t
2681           nil))))))
2682
2683(declaim (notinline make-method-lambda))
2684(defun make-method-lambda (generic-function method lambda-expression env)
2685  (declare (ignore generic-function method env))
2686  (values (compute-method-function lambda-expression) nil))
2687
2688
2689;; From CLHS section 7.6.5:
2690;; "When a generic function or any of its methods mentions &key in a lambda
2691;; list, the specific set of keyword arguments accepted by the generic function
2692;; varies according to the applicable methods. The set of keyword arguments
2693;; accepted by the generic function for a particular call is the union of the
2694;; keyword arguments accepted by all applicable methods and the keyword
2695;; arguments mentioned after &key in the generic function definition, if any."
2696;; Adapted from Sacla.
2697(defun allow-other-keys (lambda-list)
2698  (if (and (member '&key lambda-list)
2699           (not (member '&allow-other-keys lambda-list)))
2700      (let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2701             (aux-part (subseq lambda-list key-end)))
2702        `(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2703      lambda-list))
2704
2705(defmacro defmethod (&rest args &environment env)
2706  (multiple-value-bind
2707      (function-name qualifiers lambda-list specializers documentation declarations body)
2708      (parse-defmethod args)
2709    (let* ((specializers-form '())
2710           (lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2711           (gf (or (find-generic-function function-name nil)
2712                   (ensure-generic-function function-name :lambda-list lambda-list)))
2713           (method-function
2714             (make-method-lambda gf (class-prototype (generic-function-method-class gf))
2715                                 lambda-expression env))
2716           (fast-function (compute-method-fast-function lambda-expression))
2717           )
2718      (dolist (specializer specializers)
2719        (cond ((and (consp specializer) (eq (car specializer) 'eql))
2720               (push `(list 'eql ,(cadr specializer)) specializers-form))
2721              (t
2722               (push `',specializer specializers-form))))
2723      (setf specializers-form `(list ,@(nreverse specializers-form)))
2724      `(progn
2725         (ensure-method ',function-name
2726                        :lambda-list ',lambda-list
2727                        :qualifiers ',qualifiers
2728                        :specializers (canonicalize-specializers ,specializers-form)
2729                        ,@(if documentation `(:documentation ,documentation))
2730                        :function (function ,method-function)
2731                        ,@(if fast-function `(:fast-function (function ,fast-function)))
2732                        )))))
2733
2734;;; Reader and writer methods
2735
2736(defun make-instance-standard-accessor-method (method-class
2737                                               &key
2738                                               lambda-list
2739                                               qualifiers
2740                                               specializers
2741                                               documentation
2742                                               function
2743                                               fast-function
2744                                               slot-definition)
2745  (let ((method (std-allocate-instance method-class)))
2746    (setf (method-lambda-list method) lambda-list)
2747    (setf (method-qualifiers method) qualifiers)
2748    (setf (std-slot-value method 'sys::specializers)
2749          (canonicalize-specializers specializers))
2750    (setf (method-documentation method) documentation)
2751    (setf (std-slot-value method 'sys::%generic-function) nil)
2752    (setf (std-slot-value method 'sys::%function) function)
2753    (setf (std-slot-value method 'sys::fast-function) fast-function)
2754    (setf (std-slot-value method 'sys::%slot-definition) slot-definition)
2755    (setf (std-slot-value method 'sys::keywords) nil)
2756    (setf (std-slot-value method 'sys::other-keywords-p) nil)
2757    method))
2758
2759(defun add-reader-method (class function-name slot-definition)
2760  (let* ((slot-name (slot-definition-name slot-definition))
2761         (lambda-expression
2762          (if (eq (class-of class) +the-standard-class+)
2763              `(lambda (object) (std-slot-value object ',slot-name))
2764              `(lambda (object) (slot-value object ',slot-name))))
2765         (method-function (compute-method-function lambda-expression))
2766         (fast-function (compute-method-fast-function lambda-expression))
2767         (method-lambda-list '(object))
2768         (gf (find-generic-function function-name nil))
2769         (initargs `(:lambda-list ,method-lambda-list
2770                     :qualifiers ()
2771                     :specializers (,class)
2772                     :function ,(if (autoloadp 'compile)
2773                                    method-function
2774                                    (autocompile method-function))
2775                     :fast-function ,(if (autoloadp 'compile)
2776                                         fast-function
2777                                         (autocompile fast-function))
2778                     :slot-definition ,slot-definition))
2779         (method-class (if (eq class +the-standard-class+)
2780                           +the-standard-reader-method-class+
2781                           (apply #'reader-method-class class slot-definition
2782                                  initargs))))
2783    ;; required by AMOP pg. 225
2784    (assert (subtypep method-class +the-standard-reader-method-class+))
2785    (if gf
2786        (check-method-lambda-list function-name
2787                                  method-lambda-list
2788                                  (generic-function-lambda-list gf))
2789        (setf gf (ensure-generic-function function-name
2790                                          :lambda-list method-lambda-list)))
2791    (let ((method
2792           (if (eq method-class +the-standard-reader-method-class+)
2793               (apply #'make-instance-standard-accessor-method method-class
2794                      initargs)
2795               (apply #'make-instance method-class
2796                      :generic-function nil ; handled by add-method
2797                      initargs))))
2798      (if (eq (class-of gf) +the-standard-generic-function-class+)
2799          (progn
2800            (std-add-method gf method)
2801            (map-dependents gf
2802                            #'(lambda (dep)
2803                                (update-dependent gf dep 'add-method method))))
2804          (add-method gf method))
2805      method)))
2806
2807(defun add-writer-method (class function-name slot-definition)
2808  (let* ((slot-name (slot-definition-name slot-definition))
2809         (lambda-expression
2810          (if (eq (class-of class) +the-standard-class+)
2811              `(lambda (new-value object)
2812                 (setf (std-slot-value object ',slot-name) new-value))
2813              `(lambda (new-value object)
2814                 (setf (slot-value object ',slot-name) new-value))))
2815         (method-function (compute-method-function lambda-expression))
2816         (fast-function (compute-method-fast-function lambda-expression))
2817         (method-lambda-list '(new-value object))
2818         (gf (find-generic-function function-name nil))
2819         (initargs `(:lambda-list ,method-lambda-list
2820                     :qualifiers ()
2821                     :specializers (,+the-T-class+ ,class)
2822                     :function ,(if (autoloadp 'compile)
2823                                    method-function
2824                                    (autocompile method-function))
2825                     :fast-function ,(if (autoloadp 'compile)
2826                                         fast-function
2827                                         (autocompile fast-function))
2828                     :slot-definition ,slot-definition))
2829         (method-class (if (eq class +the-standard-class+)
2830                           +the-standard-writer-method-class+
2831                           (apply #'writer-method-class class slot-definition
2832                                  initargs))))
2833    ;; required by AMOP pg. 242
2834    (assert (subtypep method-class +the-standard-writer-method-class+))
2835    (if gf
2836        (check-method-lambda-list function-name
2837                                  method-lambda-list
2838                                  (generic-function-lambda-list gf))
2839        (setf gf (ensure-generic-function function-name
2840                                          :lambda-list method-lambda-list)))
2841    (let ((method
2842           (if (eq method-class +the-standard-writer-method-class+)
2843               (apply #'make-instance-standard-accessor-method method-class
2844                      initargs)
2845               (apply #'make-instance method-class
2846                      :generic-function nil ; handled by add-method
2847                      initargs))))
2848      (if (eq (class-of gf) +the-standard-generic-function-class+)
2849          (progn
2850            (std-add-method gf method)
2851            (map-dependents gf
2852                            #'(lambda (dep)
2853                                (update-dependent gf dep 'add-method method))))
2854          (add-method gf method))
2855      method)))
2856
2857(defmacro atomic-defgeneric (function-name &rest rest)
2858  "Macro to define a generic function and 'swap it into place' after
2859it's been fully defined with all its methods.
2860
2861Note: the user should really use the (:method ..) method description
2862way of defining methods; there's not much use in atomically defining
2863generic functions without providing sensible behaviour."
2864  (let ((temp-sym (gensym)))
2865    `(progn
2866       (defgeneric ,temp-sym ,@rest)
2867       (let ((gf (symbol-function ',temp-sym)))
2868         ;; FIXME (rudi 2012-07-08): fset gets the source location info
2869         ;; to charpos 23 always (but (setf fdefinition) leaves the
2870         ;; outdated source position in place, which is even worse).
2871         (fset ',function-name gf)
2872         (%set-generic-function-name gf ',function-name)
2873         (fmakunbound ',temp-sym)
2874         gf))))
2875
2876(defmacro redefine-class-forwarder (name slot &optional body-alist)
2877  "Define a generic function on a temporary symbol as an accessor
2878for the slot `slot'. Then, when definition is complete (including
2879allocation of methods), swap the definition in place.
2880
2881`body-alist' can be used to override the default method bodies for given
2882metaclasses.  In substitute method bodies, `class' names the class
2883instance and, for setters, `new-value' the new value."
2884  (let* ((setterp (consp name))
2885         (%name
2886          (intern (concatenate 'string
2887                               "%"
2888                               (if setterp (symbol-name 'set-) "")
2889                               (symbol-name (if setterp (cadr name) name)))
2890                  (find-package "SYS")))
2891         (bodies
2892          (append body-alist
2893                  (if setterp
2894                      `((built-in-class . (,%name new-value class))
2895                        (forward-referenced-class . (,%name new-value class))
2896                        (structure-class . (,%name new-value class))
2897                        (standard-class . (setf (slot-value class ',slot)
2898                                                new-value))
2899                        (funcallable-standard-class . (setf (slot-value class ',slot)
2900                                                            new-value)))
2901                      `((built-in-class . (,%name class))
2902                        (forward-referenced-class . (,%name class))
2903                        (structure-class . (,%name class))
2904                        (standard-class . (slot-value class ',slot))
2905                        (funcallable-standard-class . (slot-value class ',slot)))))))
2906    `(atomic-defgeneric ,name (,@(when setterp (list 'new-value)) class)
2907        ,@(mapcar #'(lambda (class-name)
2908                      `(:method (,@(when setterp (list 'new-value))
2909                                 (class ,class-name))
2910                         ,(cdr (assoc class-name bodies))))
2911                  '(built-in-class forward-referenced-class structure-class
2912                    standard-class funcallable-standard-class)))))
2913
2914
2915(redefine-class-forwarder class-name name)
2916;;; AMOP pg. 230
2917(redefine-class-forwarder (setf class-name) name
2918   ((standard-class . (progn (reinitialize-instance class :name new-value) new-value))
2919    (funcallable-standard-class . (progn (reinitialize-instance class :name new-value) new-value))))
2920(redefine-class-forwarder class-slots slots)
2921(redefine-class-forwarder (setf class-slots) slots)
2922(redefine-class-forwarder class-direct-slots direct-slots)
2923(redefine-class-forwarder (setf class-direct-slots) direct-slots)
2924(redefine-class-forwarder class-layout layout)
2925(redefine-class-forwarder (setf class-layout) layout)
2926(redefine-class-forwarder class-direct-superclasses direct-superclasses)
2927(redefine-class-forwarder (setf class-direct-superclasses) direct-superclasses)
2928(redefine-class-forwarder class-direct-subclasses direct-subclasses)
2929(redefine-class-forwarder (setf class-direct-subclasses) direct-subclasses)
2930(redefine-class-forwarder class-direct-methods direct-methods)
2931(redefine-class-forwarder (setf class-direct-methods) direct-methods)
2932(redefine-class-forwarder class-precedence-list precedence-list)
2933(redefine-class-forwarder (setf class-precedence-list) precedence-list)
2934(redefine-class-forwarder class-finalized-p finalized-p)
2935(redefine-class-forwarder (setf class-finalized-p) finalized-p)
2936(redefine-class-forwarder class-default-initargs default-initargs)
2937(redefine-class-forwarder (setf class-default-initargs) default-initargs)
2938(redefine-class-forwarder class-direct-default-initargs direct-default-initargs)
2939(redefine-class-forwarder (setf class-direct-default-initargs) direct-default-initargs)
2940
2941;;; Class definition
2942
2943(defun check-duplicate-slots (slots)
2944  (flet ((canonical-slot-name (canonical-slot)
2945           (getf canonical-slot :name)))
2946    (dolist (s1 slots)
2947      (let ((name1 (canonical-slot-name s1)))
2948        (dolist (s2 (cdr (memq s1 slots)))
2949          (when (eq name1 (canonical-slot-name s2))
2950            (error 'program-error "Duplicate slot ~S" name1)))))))
2951
2952(defun check-duplicate-default-initargs (initargs)
2953  (let ((names ()))
2954    (dolist (initarg initargs)
2955      (push (car initarg) names))
2956    (do* ((names names (cdr names))
2957          (name (car names) (car names)))
2958         ((null names))
2959      (when (memq name (cdr names))
2960        (error 'program-error
2961               :format-control "Duplicate initialization argument name ~S in :DEFAULT-INITARGS."
2962               :format-arguments (list name))))))
2963
2964(defun canonicalize-direct-superclasses (direct-superclasses)
2965  (let ((classes '()))
2966    (dolist (class-specifier direct-superclasses)
2967      (let ((class (if (classp class-specifier)
2968                       class-specifier
2969                       (find-class class-specifier nil))))
2970        (unless class
2971          (setf class (make-instance +the-forward-referenced-class+
2972                                     :name class-specifier))
2973          (setf (find-class class-specifier) class))
2974        (when (and (typep class 'built-in-class)
2975                   (not (member class *extensible-built-in-classes*)))
2976          (error "Attempt to define a subclass of built-in-class ~S."
2977                 class-specifier))
2978        (push class classes)))
2979    (nreverse classes)))
2980
2981(atomic-defgeneric add-direct-subclass (superclass subclass)
2982  (:method ((superclass class) (subclass class))
2983    (setf (class-direct-subclasses superclass)
2984          (adjoin subclass (class-direct-subclasses superclass)))))
2985
2986(atomic-defgeneric remove-direct-subclass (superclass subclass)
2987  (:method ((superclass class) (subclass class))
2988    (setf (class-direct-subclasses superclass)
2989          (remove subclass (class-direct-subclasses superclass)))))
2990
2991 ;;; AMOP pg. 182
2992(defun ensure-class (name &rest all-keys &key &allow-other-keys)
2993  (let ((class (find-class name nil)))
2994    ;; CLHS DEFCLASS: "If a class with the same proper name already
2995    ;; exists [...] the existing class is redefined."  Ansi-tests
2996    ;; CLASS-0309 and CLASS-0310.1 demand this behavior.
2997    (if (and class (eql (class-name class) name))
2998        (apply #'ensure-class-using-class class name all-keys)
2999        (apply #'ensure-class-using-class nil name all-keys))))
3000
3001;;; AMOP pg. 183ff.
3002(defgeneric ensure-class-using-class (class name &key direct-default-initargs
3003                                      direct-slots direct-superclasses
3004                                      metaclass &allow-other-keys))
3005
3006(defmethod ensure-class-using-class :before (class name  &key direct-slots
3007                                             direct-default-initargs 
3008                                             &allow-other-keys)
3009  (check-duplicate-slots direct-slots)
3010  (check-duplicate-default-initargs direct-default-initargs))
3011
3012(defmethod ensure-class-using-class ((class null) name &rest all-keys
3013                                     &key (metaclass +the-standard-class+)
3014                                     direct-superclasses
3015                                     &allow-other-keys)
3016  (setf all-keys (copy-list all-keys))  ; since we modify it
3017  (remf all-keys :metaclass)
3018  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
3019  (let ((class (apply (if (eq metaclass +the-standard-class+)
3020                          #'make-instance-standard-class
3021                          #'make-instance)
3022                      metaclass :name name
3023                      :direct-superclasses (canonicalize-direct-superclasses
3024                                            direct-superclasses)
3025                      all-keys)))
3026    (%set-find-class name class)
3027    class))
3028
3029(defmethod ensure-class-using-class ((class built-in-class) name &rest all-keys
3030                                     &key &allow-other-keys)
3031  (declare (ignore all-keys))
3032  (error "The symbol ~S names a built-in class." name))
3033
3034(defmethod ensure-class-using-class ((class forward-referenced-class) name
3035                                     &rest all-keys
3036                                     &key (metaclass +the-standard-class+)
3037                                     direct-superclasses &allow-other-keys)
3038  (setf all-keys (copy-list all-keys))  ; since we modify it
3039  (remf all-keys :metaclass)
3040  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
3041  (change-class class metaclass)
3042  (apply #'reinitialize-instance class
3043         :name name
3044         :direct-superclasses (canonicalize-direct-superclasses
3045                               direct-superclasses)
3046         all-keys)
3047  class)
3048
3049(defmethod ensure-class-using-class ((class class) name
3050                                     &key (metaclass +the-standard-class+ metaclassp)
3051                                     direct-superclasses &rest all-keys
3052                                     &allow-other-keys)
3053  (declare (ignore name))
3054  (setf all-keys (copy-list all-keys))  ; since we modify it
3055  (remf all-keys :metaclass)
3056  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
3057  (when (and metaclassp (not (eq (class-of class) metaclass)))
3058    (error 'program-error
3059           "Trying to redefine class ~S with different metaclass."
3060           (class-name class)))
3061  (apply #'reinitialize-instance class
3062         :direct-superclasses (canonicalize-direct-superclasses direct-superclasses)
3063         all-keys)
3064  class)
3065
3066(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
3067  (unless (>= (length form) 3)
3068    (error 'program-error "Wrong number of arguments for DEFCLASS."))
3069  (check-declaration-type name)
3070  `(ensure-class ',name
3071                 :direct-superclasses
3072                 (canonicalize-direct-superclasses ',direct-superclasses)
3073                 :direct-slots
3074                 ,(canonicalize-direct-slots direct-slots)
3075                 ,@(canonicalize-defclass-options options)))
3076
3077
3078;;; AMOP pg. 180
3079(defgeneric direct-slot-definition-class (class &rest initargs))
3080
3081(defmethod direct-slot-definition-class ((class class) &rest initargs)
3082  (declare (ignore initargs))
3083  +the-standard-direct-slot-definition-class+)
3084
3085;;; AMOP pg. 181
3086(defgeneric effective-slot-definition-class (class &rest initargs))
3087
3088(defmethod effective-slot-definition-class ((class class) &rest initargs)
3089  (declare (ignore initargs))
3090  +the-standard-effective-slot-definition-class+)
3091
3092;;; AMOP pg. 224
3093(defgeneric reader-method-class (class direct-slot &rest initargs))
3094
3095(defmethod reader-method-class ((class standard-class)
3096                                (direct-slot standard-direct-slot-definition)
3097                                &rest initargs)
3098  (declare (ignore initargs))
3099  +the-standard-reader-method-class+)
3100
3101(defmethod reader-method-class ((class funcallable-standard-class)
3102                                (direct-slot standard-direct-slot-definition)
3103                                &rest initargs)
3104  (declare (ignore initargs))
3105  +the-standard-reader-method-class+)
3106
3107;;; AMOP pg. 242
3108(defgeneric writer-method-class (class direct-slot &rest initargs))
3109
3110(defmethod writer-method-class ((class standard-class)
3111                                (direct-slot standard-direct-slot-definition)
3112                                &rest initargs)
3113  (declare (ignore initargs))
3114  +the-standard-writer-method-class+)
3115
3116(defmethod writer-method-class ((class funcallable-standard-class)
3117                                (direct-slot standard-direct-slot-definition)
3118                                &rest initargs)
3119  (declare (ignore initargs))
3120  +the-standard-writer-method-class+)
3121
3122(atomic-defgeneric documentation (x doc-type)
3123    (:method ((x symbol) doc-type)
3124        (%documentation x doc-type))
3125    (:method ((x function) doc-type)
3126        (%documentation x doc-type)))
3127
3128(atomic-defgeneric (setf documentation) (new-value x doc-type)
3129    (:method (new-value (x symbol) doc-type)
3130        (%set-documentation x doc-type new-value))
3131    (:method (new-value (x function) doc-type)
3132        (%set-documentation x doc-type new-value)))
3133
3134
3135;; FIXME This should be a weak hashtable!
3136(defvar *list-documentation-hashtable* (make-hash-table :test #'equal))
3137
3138(defmethod documentation ((x list) (doc-type (eql 'function)))
3139  (let ((alist (gethash x *list-documentation-hashtable*)))
3140    (and alist (cdr (assoc doc-type alist)))))
3141
3142(defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
3143  (let ((alist (gethash x *list-documentation-hashtable*)))
3144    (and alist (cdr (assoc doc-type alist)))))
3145
3146(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
3147  (let* ((alist (gethash x *list-documentation-hashtable*))
3148         (entry (and alist (assoc doc-type alist))))
3149    (cond (entry
3150           (setf (cdr entry) new-value))
3151          (t
3152           (setf (gethash x *list-documentation-hashtable*)
3153                 (push (cons doc-type new-value) alist)))))
3154  new-value)
3155
3156(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro)))
3157  (let* ((alist (gethash x *list-documentation-hashtable*))
3158         (entry (and alist (assoc doc-type alist))))
3159    (cond (entry
3160           (setf (cdr entry) new-value))
3161          (t
3162           (setf (gethash x *list-documentation-hashtable*)
3163                 (push (cons doc-type new-value) alist)))))
3164  new-value)
3165
3166(defmethod documentation ((x class) (doc-type (eql 't)))
3167  (class-documentation x))
3168
3169(defmethod documentation ((x class) (doc-type (eql 'type)))
3170  (class-documentation x))
3171
3172(defmethod (setf documentation) (new-value (x class) (doc-type (eql 't)))
3173  (%set-class-documentation x new-value))
3174
3175(defmethod (setf documentation) (new-value (x class) (doc-type (eql 'type)))
3176  (%set-class-documentation x new-value))
3177
3178(defmethod documentation ((x structure-class) (doc-type (eql 't)))
3179  (%documentation x t))
3180
3181(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
3182  (%documentation x t))
3183
3184(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 't)))
3185  (%set-documentation x t new-value))
3186
3187(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 'type)))
3188  (%set-documentation x t new-value))
3189
3190(defmethod documentation ((x standard-generic-function) (doc-type (eql 't)))
3191  (generic-function-documentation x))
3192
3193(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 't)))
3194  (setf (generic-function-documentation x) new-value))
3195
3196(defmethod documentation ((x standard-generic-function) (doc-type (eql 'function)))
3197  (generic-function-documentation x))
3198
3199(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 'function)))
3200  (setf (generic-function-documentation x) new-value))
3201
3202(defmethod documentation ((x standard-method) (doc-type (eql 't)))
3203  (method-documentation x))
3204
3205(defmethod (setf documentation) (new-value (x standard-method) (doc-type (eql 't)))
3206  (setf (method-documentation x) new-value))
3207
3208(defmethod documentation ((x standard-slot-definition) (doc-type (eql 't)))
3209  (slot-definition-documentation x))
3210
3211(defmethod (setf documentation) (new-value (x standard-slot-definition) (doc-type (eql 't)))
3212  (setf (slot-definition-documentation x) new-value))
3213
3214(defmethod documentation ((x package) (doc-type (eql 't)))
3215  (%documentation x doc-type))
3216
3217(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
3218  (%set-documentation x doc-type new-value))
3219
3220(defmethod documentation ((x symbol) (doc-type (eql 'function)))
3221  (%documentation x 'function))
3222
3223(defmethod documentation ((x symbol) (doc-type (eql 'type)))
3224  (let ((class (find-class x nil)))
3225    (if class
3226        (documentation class t)
3227        (%documentation x 'type))))
3228
3229(defmethod documentation ((x symbol) (doc-type (eql 'structure)))
3230  (%documentation x 'structure))
3231
3232(defmethod (setf documentation) (new-value (x symbol) (doc-type (eql 'type)))
3233  (let ((class (find-class x nil)))
3234    (if class
3235        (setf (documentation class t) new-value)
3236        (%set-documentation x 'type new-value))))
3237
3238(defmethod (setf documentation) (new-value (x symbol)
3239                                 (doc-type (eql 'structure)))
3240  (%set-documentation x 'structure new-value))
3241
3242;;; Applicable methods
3243
3244(atomic-defgeneric compute-applicable-methods (gf args)
3245  (:method ((gf standard-generic-function) args)
3246    (std-compute-applicable-methods gf args)))
3247
3248(defgeneric compute-applicable-methods-using-classes (gf classes)
3249  (:method ((gf standard-generic-function) classes)
3250    (let ((methods '()))
3251      (dolist (method (generic-function-methods gf))
3252  (multiple-value-bind (applicable knownp)
3253      (method-applicable-using-classes-p method classes)
3254    (cond (applicable
3255     (push method methods))
3256    ((not knownp)
3257     (return-from compute-applicable-methods-using-classes
3258       (values nil nil))))))
3259      (values (sort-methods methods gf classes)
3260        t))))
3261
3262
3263;;; Slot access
3264;;;
3265;;; See AMOP pg. 156ff. for an overview.
3266;;;
3267;;; AMOP specifies these generic functions to dispatch on slot objects
3268;;; (with the exception of slot-exists-p-using-class), although its
3269;;; sample implementation Closette dispatches on slot names.  We let
3270;;; slot-value and friends call their gf counterparts with the effective
3271;;; slot definition, but leave the definitions dispatching on slot name
3272;;; in place for user convenience.
3273
3274;;; AMOP pg. 235
3275(defgeneric slot-value-using-class (class instance slot))
3276
3277(defmethod slot-value-using-class ((class standard-class) instance (slot symbol))
3278  (std-slot-value instance slot))
3279(defmethod slot-value-using-class ((class standard-class) instance
3280                                   (slot standard-effective-slot-definition))
3281  (let* ((location (slot-definition-location slot))
3282         (value (if (consp location)
3283                    (cdr location)      ; :allocation :class
3284                    (standard-instance-access instance location))))
3285    (if (eq value +slot-unbound+)
3286        ;; fix SLOT-UNBOUND.5 from ansi test suite
3287        (nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3288        value)))
3289
3290(defmethod slot-value-using-class ((class funcallable-standard-class)
3291                                   instance (slot symbol))
3292  (std-slot-value instance slot))
3293(defmethod slot-value-using-class ((class funcallable-standard-class) instance
3294                                   (slot standard-effective-slot-definition))
3295  (let* ((location (slot-definition-location slot))
3296         (value (if (consp location)
3297                    (cdr location)      ; :allocation :class
3298                    (funcallable-standard-instance-access instance location))))
3299    (if (eq value +slot-unbound+)
3300        ;; fix SLOT-UNBOUND.5 from ansi test suite
3301        (nth-value 0 (slot-unbound class instance (slot-definition-name slot)))
3302        value)))
3303
3304(defmethod slot-value-using-class ((class structure-class) instance
3305                                   (slot symbol))
3306  (std-slot-value instance slot))
3307(defmethod slot-value-using-class ((class structure-class) instance
3308                                   (slot standard-effective-slot-definition))
3309  (std-slot-value instance (slot-definition-name slot)))
3310
3311;;; AMOP pg. 231
3312(defgeneric (setf slot-value-using-class) (new-value class instance slot))
3313
3314(defmethod (setf slot-value-using-class) (new-value
3315                                          (class standard-class)
3316                                          instance
3317                                          (slot symbol))
3318  (setf (std-slot-value instance slot) new-value))
3319(defmethod (setf slot-value-using-class) (new-value
3320                                          (class standard-class)
3321                                          instance
3322                                          (slot standard-effective-slot-definition))
3323  (let ((location (slot-definition-location slot)))
3324    (if (consp location)                ; :allocation :class
3325        (setf (cdr location) new-value)
3326        (setf (standard-instance-access instance location) new-value))))
3327
3328(defmethod (setf slot-value-using-class) (new-value
3329                                          (class funcallable-standard-class)
3330                                          instance
3331                                          (slot symbol))
3332  (setf (std-slot-value instance slot) new-value))
3333(defmethod (setf slot-value-using-class) (new-value
3334                                          (class funcallable-standard-class)
3335                                          instance
3336                                          (slot standard-effective-slot-definition))
3337  (let ((location (slot-definition-location slot)))
3338    (if (consp location)                ; :allocation :class
3339        (setf (cdr location) new-value)
3340        (setf (funcallable-standard-instance-access instance location)
3341              new-value))))
3342
3343(defmethod (setf slot-value-using-class) (new-value
3344                                          (class structure-class)
3345                                          instance
3346                                          (slot symbol))
3347  (setf (std-slot-value instance slot) new-value))
3348(defmethod (setf slot-value-using-class) (new-value
3349                                          (class structure-class)
3350                                          instance
3351                                          (slot standard-effective-slot-definition))
3352  (setf (std-slot-value instance (slot-definition-name slot)) new-value))
3353
3354;;; slot-exists-p-using-class is not specified by AMOP, and obviously
3355;;; cannot be specialized on the slot type.  Hence, its implementation
3356;;; differs from slot-(boundp|makunbound|value)-using-class
3357(defgeneric slot-exists-p-using-class (class instance slot-name))
3358
3359(defmethod slot-exists-p-using-class (class instance slot-name)
3360  nil)
3361
3362(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
3363  (std-slot-exists-p instance slot-name))
3364(defmethod slot-exists-p-using-class ((class funcallable-standard-class) instance slot-name)
3365  (std-slot-exists-p instance slot-name))
3366
3367(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
3368  (dolist (dsd (class-slots class))
3369    (when (eq (sys::dsd-name dsd) slot-name)
3370      (return-from slot-exists-p-using-class t)))
3371  nil)
3372
3373
3374(defgeneric slot-boundp-using-class (class instance slot))
3375(defmethod slot-boundp-using-class ((class standard-class) instance (slot symbol))
3376  (std-slot-boundp instance slot))
3377(defmethod slot-boundp-using-class ((class standard-class) instance
3378                                    (slot standard-effective-slot-definition))
3379  (let ((location (slot-definition-location slot)))
3380    (if (consp location)
3381        (eq (cdr location) +slot-unbound+) ; :allocation :class
3382        (eq (standard-instance-access instance location) +slot-unbound+))))
3383
3384(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3385                                    (slot symbol))
3386  (std-slot-boundp instance slot))
3387(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3388                                    (slot standard-effective-slot-definition))
3389  (let ((location (slot-definition-location slot)))
3390    (if (consp location)
3391        (eq (cdr location) +slot-unbound+) ; :allocation :class
3392        (eq (funcallable-standard-instance-access instance location)
3393            +slot-unbound+))))
3394
3395(defmethod slot-boundp-using-class ((class structure-class) instance slot)
3396  "Structure slots can't be unbound, so this method always returns T."
3397  (declare (ignore class instance slot))
3398  t)
3399
3400(defgeneric slot-makunbound-using-class (class instance slot))
3401(defmethod slot-makunbound-using-class ((class standard-class)
3402                                        instance
3403                                        (slot symbol))
3404  (std-slot-makunbound instance slot))
3405(defmethod slot-makunbound-using-class ((class standard-class)
3406                                        instance
3407                                        (slot standard-effective-slot-definition))
3408  (let ((location (slot-definition-location slot)))
3409    (if (consp location)
3410        (setf (cdr location) +slot-unbound+)
3411        (setf (standard-instance-access instance location) +slot-unbound+))))
3412
3413(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3414                                        instance
3415                                        (slot symbol))
3416  (std-slot-makunbound instance slot))
3417(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3418                                        instance
3419                                        (slot symbol))
3420  (let ((location (slot-definition-location slot)))
3421    (if (consp location)
3422        (setf (cdr location) +slot-unbound+)
3423        (setf (funcallable-standard-instance-access instance location)
3424              +slot-unbound+))))
3425
3426(defmethod slot-makunbound-using-class ((class structure-class)
3427                                        instance
3428                                        slot)
3429  (declare (ignore class instance slot))
3430  (error "Structure slots can't be unbound"))
3431
3432(defgeneric slot-missing (class instance slot-name operation &optional new-value))
3433
3434(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
3435  (declare (ignore new-value))
3436  (error "The slot ~S is missing from the class ~S." slot-name class))
3437
3438(defgeneric slot-unbound (class instance slot-name))
3439
3440(defmethod slot-unbound ((class t) instance slot-name)
3441  (error 'unbound-slot :instance instance :name slot-name))
3442
3443;;; Instance creation and initialization
3444
3445;;; AMOP pg. 168ff.
3446(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
3447
3448(defmethod allocate-instance ((class standard-class) &rest initargs)
3449  (declare (ignore initargs))
3450  (std-allocate-instance class))
3451
3452(defmethod allocate-instance ((class funcallable-standard-class) &rest initargs)
3453  (declare (ignore initargs))
3454  (allocate-funcallable-instance class))
3455
3456(defmethod allocate-instance ((class structure-class) &rest initargs)
3457  (declare (ignore initargs))
3458  (%make-structure (class-name class)
3459                   (make-list (length (class-slots class))
3460                              :initial-element +slot-unbound+)))
3461
3462(defmethod allocate-instance ((class built-in-class) &rest initargs)
3463  (declare (ignore initargs))
3464  (error "Cannot allocate instances of a built-in class: ~S" class))
3465
3466(defmethod allocate-instance :before ((class class) &rest initargs)
3467  (declare (ignore initargs))
3468  (unless (class-finalized-p class)
3469    (finalize-inheritance class)))
3470
3471;; "The set of valid initialization arguments for a class is the set of valid
3472;; initialization arguments that either fill slots or supply arguments to
3473;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
3474;; 7.1.2
3475
3476(defun calculate-allowable-initargs (gf-list args instance
3477                                             shared-initialize-param
3478                                             initargs)
3479  (let* ((methods
3480          (nconc
3481             (std-compute-applicable-methods #'shared-initialize
3482                                             (list* instance
3483                                                    shared-initialize-param
3484                                                    initargs))
3485             (mapcan #'(lambda (gf)
3486                         (if (eq (class-of gf)
3487                                 +the-standard-generic-function-class+)
3488                             (std-compute-applicable-methods gf args)
3489                             (compute-applicable-methods gf args)))
3490                     gf-list)))
3491         (method-keyword-args
3492          (reduce #'merge-initargs-sets
3493                  (mapcar #'method-lambda-list methods)
3494                  :key #'extract-lambda-list-keywords
3495                  :initial-value nil))
3496         (slots-initargs
3497          (mapappend #'slot-definition-initargs
3498                     (class-slots (class-of instance)))))
3499    (merge-initargs-sets
3500     (merge-initargs-sets slots-initargs method-keyword-args)
3501     '(:allow-other-keys))))  ;; allow-other-keys is always allowed
3502
3503(defun check-initargs (gf-list args instance
3504                       shared-initialize-param initargs
3505                       cache call-site)
3506  "Checks the validity of `initargs' for the generic functions in `gf-list'
3507when called with `args' by calculating the applicable methods for each gf.
3508The applicable methods for SHARED-INITIALIZE based on `instance',
3509`shared-initialize-param' and `initargs' are added to the list of
3510applicable methods."
3511  (when (oddp (length initargs))
3512    (error 'program-error
3513           :format-control "Odd number of keyword arguments."))
3514  (unless (getf initargs :allow-other-keys)
3515    (multiple-value-bind (allowable-initargs present-p)
3516                         (when cache
3517                           (gethash (class-of instance) cache))
3518       (unless present-p
3519         (setf allowable-initargs
3520               (calculate-allowable-initargs gf-list args instance
3521                                             shared-initialize-param initargs))
3522         (when cache
3523           (setf (gethash (class-of instance) cache)
3524                 allowable-initargs)))
3525       (unless (eq t allowable-initargs)
3526         (do* ((tail initargs (cddr tail))
3527               (initarg (car tail) (car tail)))
3528              ((null tail))
3529              (unless (memq initarg allowable-initargs)
3530                (error 'program-error
3531                       :format-control "Invalid initarg ~S in call to ~S with arglist ~S."
3532                       :format-arguments (list initarg call-site args))))))))
3533
3534(defun merge-initargs-sets (list1 list2)
3535  (cond
3536   ((eq list1 t)  t)
3537   ((eq list2 t)  t)
3538   (t             (union list1 list2))))
3539
3540(defun extract-lambda-list-keywords (lambda-list)
3541  "Returns a list of keywords acceptable as keyword arguments,
3542or T when any keyword is acceptable due to presence of
3543&allow-other-keys."
3544  (when (member '&allow-other-keys lambda-list)
3545    (return-from extract-lambda-list-keywords t))
3546  (loop with keyword-args = (cdr (memq '&key lambda-list))
3547        for key in keyword-args
3548        when (eq key '&aux) do (loop-finish)
3549        when (eq key '&allow-other-keys) do (return t)
3550        when (listp key) do (setq key (car key))
3551        collect (if (symbolp key)
3552                    (make-keyword key)
3553                  (car key))))
3554
3555
3556(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
3557
3558(defmethod make-instance :before ((class class) &rest initargs)
3559  (when (oddp (length initargs))
3560    (error 'program-error :format-control "Odd number of keyword arguments."))
3561  (unless (class-finalized-p class)
3562    (finalize-inheritance class)))
3563
3564(defun augment-initargs-with-defaults (class initargs)
3565  (let ((default-initargs '()))
3566    (dolist (initarg (class-default-initargs class))
3567      (let ((key (first initarg))
3568            (fn (third initarg)))
3569        (when (eq (getf initargs key +slot-unbound+) +slot-unbound+)
3570          (push key default-initargs)
3571          (push (funcall fn) default-initargs))))
3572    (append initargs (nreverse default-initargs))))
3573
3574(defmethod make-instance ((class standard-class) &rest initargs)
3575  (setf initargs (augment-initargs-with-defaults class initargs))
3576  (let ((instance (std-allocate-instance class)))
3577    (check-initargs (list #'allocate-instance #'initialize-instance)
3578                    (list* instance initargs)
3579                    instance t initargs
3580                    *make-instance-initargs-cache* 'make-instance)
3581    (apply #'initialize-instance instance initargs)
3582    instance))
3583
3584(defmethod make-instance ((class funcallable-standard-class) &rest initargs)
3585  (setf initargs (augment-initargs-with-defaults class initargs))
3586  (let ((instance (allocate-funcallable-instance class)))
3587    (check-initargs (list #'allocate-instance #'initialize-instance)
3588                    (list* instance initargs)
3589                    instance t initargs
3590                    *make-instance-initargs-cache* 'make-instance)
3591    (apply #'initialize-instance instance initargs)
3592    instance))
3593
3594(defmethod make-instance ((class symbol) &rest initargs)
3595  (apply #'make-instance (find-class class) initargs))
3596
3597(defgeneric initialize-instance (instance &rest initargs
3598                                          &key &allow-other-keys))
3599
3600(defmethod initialize-instance ((instance standard-object) &rest initargs)
3601  (apply #'shared-initialize instance t initargs))
3602
3603(defgeneric reinitialize-instance (instance &rest initargs
3604                                            &key &allow-other-keys))
3605
3606;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
3607;; validity of initargs and signals an error if an initarg is supplied that is
3608;; not declared as valid. The method then calls the generic function SHARED-
3609;; INITIALIZE with the following arguments: the instance, nil (which means no
3610;; slots should be initialized according to their initforms), and the initargs
3611;; it received."
3612(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
3613  (check-initargs (list #'reinitialize-instance) (list* instance initargs)
3614                  instance () initargs
3615                  *reinitialize-instance-initargs-cache* 'reinitialize-instance)
3616  (apply #'shared-initialize instance () initargs))
3617
3618(defun std-shared-initialize (instance slot-names all-keys)
3619  (when (oddp (length all-keys))
3620    (error 'program-error :format-control "Odd number of keyword arguments."))
3621  ;; do a quick scan of the arguments list to see if it's a real
3622  ;; 'initialization argument list' (which is not the same as
3623  ;; checking initarg validity
3624  (do* ((tail all-keys (cddr tail))
3625        (initarg (car tail) (car tail)))
3626      ((null tail))
3627    (unless (symbolp initarg)
3628      (error 'program-error
3629             :format-control "Initarg ~S not a symbol."
3630             :format-arguments (list initarg))))
3631  (dolist (slot (class-slots (class-of instance)))
3632    (let ((slot-name (slot-definition-name slot)))
3633      (multiple-value-bind (init-key init-value foundp)
3634          (get-properties all-keys (slot-definition-initargs slot))
3635        (if foundp
3636            (setf (std-slot-value instance slot-name) init-value)
3637            (unless (std-slot-boundp instance slot-name)
3638              (let ((initfunction (slot-definition-initfunction slot)))
3639                (when (and initfunction (or (eq slot-names t)
3640                                            (memq slot-name slot-names)))
3641                  (setf (std-slot-value instance slot-name)
3642                        (funcall initfunction)))))))))
3643  instance)
3644
3645(defgeneric shared-initialize (instance slot-names
3646                                        &rest initargs
3647                                        &key &allow-other-keys))
3648
3649(defmethod shared-initialize ((instance standard-object) slot-names
3650                              &rest initargs)
3651  (std-shared-initialize instance slot-names initargs))
3652
3653(defmethod shared-initialize :after ((instance standard-class) slot-names
3654                                     &key direct-superclasses
3655                                     direct-slots direct-default-initargs
3656                                     &allow-other-keys)
3657  (std-after-initialization-for-classes
3658   instance :direct-superclasses direct-superclasses
3659   :direct-slots direct-slots
3660   :direct-default-initargs direct-default-initargs))
3661
3662(defmethod shared-initialize :after ((instance funcallable-standard-class)
3663                                     slot-names &key direct-superclasses
3664                                     direct-slots direct-default-initargs
3665                                     &allow-other-keys)
3666  (std-after-initialization-for-classes
3667   instance :direct-superclasses direct-superclasses
3668   :direct-slots direct-slots
3669   :direct-default-initargs direct-default-initargs))
3670
3671(defmethod shared-initialize ((slot slot-definition) slot-names
3672                              &rest args
3673                              &key name initargs initform initfunction
3674                              readers writers allocation
3675                              &allow-other-keys)
3676  ;;Keyword args are duplicated from init-slot-definition only to have
3677  ;;them checked.
3678  (declare (ignore slot-names)) ;;TODO?
3679  (declare (ignore name initargs initform initfunction readers writers allocation))
3680  ;;For built-in slots
3681  (apply #'init-slot-definition slot :allow-other-keys t args)
3682  ;;For user-defined slots
3683  (call-next-method))
3684
3685;;; change-class
3686
3687(defgeneric change-class (instance new-class &key &allow-other-keys))
3688
3689(defmethod change-class ((old-instance standard-object) (new-class standard-class)
3690                         &rest initargs)
3691  (let ((old-slots (class-slots (class-of old-instance)))
3692        (new-slots (class-slots new-class))
3693        (new-instance (allocate-instance new-class)))
3694    ;; "The values of local slots specified by both the class CTO and the class
3695    ;; CFROM are retained. If such a local slot was unbound, it remains
3696    ;; unbound."
3697    (dolist (new-slot new-slots)
3698      (when (instance-slot-p new-slot)
3699        (let* ((slot-name (slot-definition-name new-slot))
3700               (old-slot (find slot-name old-slots :key 'slot-definition-name)))
3701          ;; "The values of slots specified as shared in the class CFROM and as
3702          ;; local in the class CTO are retained."
3703          (when (and old-slot (slot-boundp old-instance slot-name))
3704            (setf (slot-value new-instance slot-name)
3705                  (slot-value old-instance slot-name))))))
3706    (swap-slots old-instance new-instance)
3707    (rotatef (std-instance-layout new-instance)
3708             (std-instance-layout old-instance))
3709    (apply #'update-instance-for-different-class
3710           new-instance old-instance initargs)
3711    old-instance))
3712
3713(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
3714  (apply #'change-class instance (find-class new-class) initargs))
3715
3716(defgeneric update-instance-for-different-class (old new
3717                                                     &rest initargs
3718                                                     &key &allow-other-keys))
3719
3720(defmethod update-instance-for-different-class
3721  ((old standard-object) (new standard-object) &rest initargs)
3722  (let ((added-slots
3723         (remove-if #'(lambda (slot-name)
3724                       (slot-exists-p old slot-name))
3725                    (mapcar 'slot-definition-name
3726                            (class-slots (class-of new))))))
3727    (check-initargs (list #'update-instance-for-different-class)
3728                    (list old new initargs)
3729                    new added-slots initargs
3730                    nil 'update-instance-for-different-class)
3731    (apply #'shared-initialize new added-slots initargs)))
3732
3733;;; make-instances-obsolete
3734
3735(defgeneric make-instances-obsolete (class))
3736
3737(defmethod make-instances-obsolete ((class standard-class))
3738  (%make-instances-obsolete class))
3739(defmethod make-instances-obsolete ((class funcallable-standard-class))
3740  (%make-instances-obsolete class))
3741(defmethod make-instances-obsolete ((class symbol))
3742  (make-instances-obsolete (find-class class))
3743  class)
3744
3745;;; update-instance-for-redefined-class
3746
3747(defgeneric update-instance-for-redefined-class (instance
3748                                                 added-slots
3749                                                 discarded-slots
3750                                                 property-list
3751                                                 &rest initargs
3752                                                 &key
3753                                                 &allow-other-keys))
3754
3755(defmethod update-instance-for-redefined-class ((instance standard-object)
3756            added-slots
3757            discarded-slots
3758            property-list
3759            &rest initargs)
3760  (check-initargs (list #'update-instance-for-redefined-class)
3761                  (list* instance added-slots discarded-slots
3762                         property-list initargs)
3763                  instance added-slots initargs
3764                  nil 'update-instance-for-redefined-class)
3765  (apply #'shared-initialize instance added-slots initargs))
3766
3767;;;  Methods having to do with class metaobjects.
3768
3769(defmethod initialize-instance :after ((class standard-class) &rest args)
3770  (apply #'std-after-initialization-for-classes class args))
3771
3772(defmethod initialize-instance :after ((class funcallable-standard-class)
3773                                       &rest args)
3774  (apply #'std-after-initialization-for-classes class args))
3775
3776(defmethod reinitialize-instance :before ((class standard-class)
3777                                          &key direct-superclasses
3778                                          &rest all-keys)
3779  (check-initargs (list #'allocate-instance
3780                        #'initialize-instance)
3781                  (list* class all-keys)
3782                  class t all-keys
3783                  nil 'reinitialize-instance)
3784  (dolist (superclass (set-difference (class-direct-superclasses class)
3785                                      direct-superclasses))
3786    (remove-direct-subclass superclass class))
3787  (dolist (superclass (set-difference direct-superclasses
3788                                      (class-direct-superclasses class)))
3789    (add-direct-subclass superclass class)))
3790
3791(defmethod reinitialize-instance :before ((class funcallable-standard-class)
3792                                          &key direct-superclasses
3793                                          &rest all-keys)
3794  (check-initargs (list #'allocate-instance
3795                        #'initialize-instance)
3796                  (list* class all-keys)
3797                  class t all-keys
3798                  nil 'reinitialize-instance)
3799  (dolist (superclass (set-difference (class-direct-superclasses class)
3800                                      direct-superclasses))
3801    (remove-direct-subclass superclass class))
3802  (dolist (superclass (set-difference direct-superclasses
3803                                      (class-direct-superclasses class)))
3804    (add-direct-subclass superclass class)))
3805
3806(defmethod reinitialize-instance :after ((class standard-class) &rest all-keys)
3807  (remhash class *make-instance-initargs-cache*)
3808  (remhash class *reinitialize-instance-initargs-cache*)
3809  (%make-instances-obsolete class)
3810  (setf (class-finalized-p class) nil)
3811  ;; KLUDGE (rudi 2012-06-17) this calls add-direct-subclass again
3812  (apply #'std-after-initialization-for-classes class all-keys)
3813  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3814
3815(defmethod reinitialize-instance :after ((class funcallable-standard-class)
3816                                         &rest all-keys)
3817  (remhash class *make-instance-initargs-cache*)
3818  (remhash class *reinitialize-instance-initargs-cache*)
3819  (%make-instances-obsolete class)
3820  (setf (class-finalized-p class) nil)
3821  ;; KLUDGE (rudi 2012-06-17) this calls add-direct-subclass again
3822  (apply #'std-after-initialization-for-classes class all-keys)
3823  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3824
3825(defmethod reinitialize-instance :after ((gf standard-generic-function)
3826                                         &rest all-keys)
3827  (map-dependents gf #'(lambda (dep) (update-dependent gf dep all-keys))))
3828
3829;;; Finalize inheritance
3830
3831(atomic-defgeneric finalize-inheritance (class)
3832    (:method ((class standard-class))
3833       (std-finalize-inheritance class))
3834    (:method ((class funcallable-standard-class))
3835       (std-finalize-inheritance class)))
3836
3837;;; Default initargs
3838
3839;;; AMOP pg. 174
3840(atomic-defgeneric compute-default-initargs (class)
3841  (:method ((class standard-class))
3842    (std-compute-default-initargs class))
3843  (:method ((class funcallable-standard-class))
3844    (std-compute-default-initargs class)))
3845
3846;;; Class precedence lists
3847
3848(defgeneric compute-class-precedence-list (class))
3849(defmethod compute-class-precedence-list ((class standard-class))
3850  (std-compute-class-precedence-list class))
3851(defmethod compute-class-precedence-list ((class funcallable-standard-class))
3852  (std-compute-class-precedence-list class))
3853
3854;;; Slot inheritance
3855
3856(defgeneric compute-slots (class))
3857(defmethod compute-slots ((class standard-class))
3858  (std-compute-slots class))
3859(defmethod compute-slots ((class funcallable-standard-class))
3860  (std-compute-slots class))
3861
3862(defgeneric compute-effective-slot-definition (class name direct-slots))
3863(defmethod compute-effective-slot-definition
3864  ((class standard-class) name direct-slots)
3865  (std-compute-effective-slot-definition class name direct-slots))
3866(defmethod compute-effective-slot-definition
3867  ((class funcallable-standard-class) name direct-slots)
3868  (std-compute-effective-slot-definition class name direct-slots))
3869
3870;;; Methods having to do with generic function invocation.
3871
3872(defgeneric compute-discriminating-function (gf))
3873(defmethod compute-discriminating-function ((gf standard-generic-function))
3874  (std-compute-discriminating-function gf))
3875
3876(defgeneric method-more-specific-p (gf method1 method2 required-classes))
3877
3878(defmethod method-more-specific-p ((gf standard-generic-function)
3879                                   method1 method2 required-classes)
3880  (let ((method-indices
3881         (argument-precedence-order-indices
3882          (generic-function-argument-precedence-order gf)
3883          (getf (analyze-lambda-list (generic-function-lambda-list gf))
3884                ':required-args))))
3885    (std-method-more-specific-p method1 method2 required-classes method-indices)))
3886
3887;;; AMOP pg. 176
3888(defgeneric compute-effective-method (gf method-combination methods))
3889(defmethod compute-effective-method ((gf standard-generic-function) method-combination methods)
3890  (std-compute-effective-method gf method-combination methods))
3891
3892(defgeneric compute-applicable-methods (gf args))
3893(defmethod compute-applicable-methods ((gf standard-generic-function) args)
3894  (std-compute-applicable-methods gf args))
3895
3896;;; AMOP pg. 207
3897(atomic-defgeneric make-method-lambda (generic-function method lambda-expression environment)
3898  (:method ((generic-function standard-generic-function)
3899            (method standard-method)
3900            lambda-expression environment)
3901    (declare (ignore environment))
3902    (values (compute-method-function lambda-expression) nil)))
3903
3904
3905;;; Slot definition accessors
3906
3907(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
3908  `(let (($cl (class-of ,slot-definition)))
3909     (case $cl
3910       ((+the-standard-slot-definition-class+
3911         +the-standard-direct-slot-definition-class+
3912         +the-standard-effective-slot-definition-class+)
3913        ,std-form)
3914       (t ,generic-form))))
3915
3916(atomic-defgeneric slot-definition-allocation (slot-definition)
3917  (:method ((slot-definition slot-definition))
3918    (slot-definition-dispatch slot-definition
3919      (%slot-definition-allocation slot-definition)
3920      (slot-value slot-definition 'sys::allocation))))
3921
3922(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
3923  (:method (value (slot-definition slot-definition))
3924    (slot-definition-dispatch slot-definition
3925      (set-slot-definition-allocation slot-definition value)
3926      (setf (slot-value slot-definition 'sys::allocation) value))))
3927
3928(atomic-defgeneric slot-definition-initargs (slot-definition)
3929  (:method ((slot-definition slot-definition))
3930    (slot-definition-dispatch slot-definition
3931      (%slot-definition-initargs slot-definition)
3932      (slot-value slot-definition 'sys::initargs))))
3933
3934(atomic-defgeneric slot-definition-initform (slot-definition)
3935  (:method ((slot-definition slot-definition))
3936    (slot-definition-dispatch slot-definition
3937      (%slot-definition-initform slot-definition)
3938      (slot-value slot-definition 'sys::initform))))
3939
3940(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
3941  (:method (value (slot-definition slot-definition))
3942    (slot-definition-dispatch slot-definition
3943      (set-slot-definition-initform slot-definition value)
3944      (setf (slot-value slot-definition 'sys::initform) value))))
3945
3946(atomic-defgeneric slot-definition-initfunction (slot-definition)
3947  (:method ((slot-definition slot-definition))
3948    (slot-definition-dispatch slot-definition
3949      (%slot-definition-initfunction slot-definition)
3950      (slot-value slot-definition 'sys::initfunction))))
3951
3952(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
3953  (:method (value (slot-definition slot-definition))
3954    (slot-definition-dispatch slot-definition
3955      (set-slot-definition-initfunction slot-definition value)
3956      (setf (slot-value slot-definition 'sys::initfunction) value))))
3957
3958(atomic-defgeneric slot-definition-name (slot-definition)
3959  (:method ((slot-definition slot-definition))
3960    (slot-definition-dispatch slot-definition
3961      (%slot-definition-name slot-definition)
3962      (slot-value slot-definition 'sys::name))))
3963
3964(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
3965  (:method (value (slot-definition slot-definition))
3966    (slot-definition-dispatch slot-definition
3967      (set-slot-definition-name slot-definition value)
3968      (setf (slot-value slot-definition 'sys::name) value))))
3969
3970(atomic-defgeneric slot-definition-readers (slot-definition)
3971  (:method ((slot-definition slot-definition))
3972    (slot-definition-dispatch slot-definition
3973      (%slot-definition-readers slot-definition)
3974      (slot-value slot-definition 'sys::readers))))
3975
3976(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
3977  (:method (value (slot-definition slot-definition))
3978    (slot-definition-dispatch slot-definition
3979      (set-slot-definition-readers slot-definition value)
3980      (setf (slot-value slot-definition 'sys::readers) value))))
3981
3982(atomic-defgeneric slot-definition-writers (slot-definition)
3983  (:method ((slot-definition slot-definition))
3984    (slot-definition-dispatch slot-definition
3985      (%slot-definition-writers slot-definition)
3986      (slot-value slot-definition 'sys::writers))))
3987
3988(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
3989  (:method (value (slot-definition slot-definition))
3990    (slot-definition-dispatch slot-definition
3991      (set-slot-definition-writers slot-definition value)
3992      (setf (slot-value slot-definition 'sys::writers) value))))
3993
3994(atomic-defgeneric slot-definition-allocation-class (slot-definition)
3995  (:method ((slot-definition slot-definition))
3996    (slot-definition-dispatch slot-definition
3997      (%slot-definition-allocation-class slot-definition)
3998      (slot-value slot-definition 'sys::allocation-class))))
3999
4000(atomic-defgeneric (setf slot-definition-allocation-class)
4001                       (value slot-definition)
4002  (:method (value (slot-definition slot-definition))
4003    (slot-definition-dispatch slot-definition
4004      (set-slot-definition-allocation-class slot-definition value)
4005      (setf (slot-value slot-definition 'sys::allocation-class) value))))
4006
4007(atomic-defgeneric slot-definition-location (slot-definition)
4008  (:method ((slot-definition slot-definition))
4009    (slot-definition-dispatch slot-definition
4010      (%slot-definition-location slot-definition)
4011      (slot-value slot-definition 'sys::location))))
4012
4013(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
4014  (:method (value (slot-definition slot-definition))
4015    (slot-definition-dispatch slot-definition
4016      (set-slot-definition-location slot-definition value)
4017      (setf (slot-value slot-definition 'sys::location) value))))
4018
4019(atomic-defgeneric slot-definition-type (slot-definition)
4020  (:method ((slot-definition slot-definition))
4021    (slot-definition-dispatch slot-definition
4022      (%slot-definition-type slot-definition)
4023      (slot-value slot-definition 'sys::%type))))
4024
4025(atomic-defgeneric (setf slot-definition-type) (value slot-definition)
4026  (:method (value (slot-definition slot-definition))
4027    (slot-definition-dispatch slot-definition
4028      (set-slot-definition-type slot-definition value)
4029      (setf (slot-value slot-definition 'sys::%type) value))))
4030
4031(atomic-defgeneric slot-definition-documentation (slot-definition)
4032  (:method ((slot-definition slot-definition))
4033    (slot-definition-dispatch slot-definition
4034      (%slot-definition-documentation slot-definition)
4035      (slot-value slot-definition 'sys:%documentation))))
4036
4037(atomic-defgeneric (setf slot-definition-documentation) (value slot-definition)
4038  (:method (value (slot-definition slot-definition))
4039    (slot-definition-dispatch slot-definition
4040      (set-slot-definition-documentation slot-definition value)
4041      (setf (slot-value slot-definition 'sys:%documentation) value))))
4042
4043
4044;;; Conditions.
4045
4046(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
4047  (let ((parent-types (or parent-types '(condition)))
4048        (report nil))
4049    (dolist (option options)
4050      (when (eq (car option) :report)
4051        (setf report (cadr option))
4052  (setf options (delete option options :test #'equal))
4053        (return)))
4054    (typecase report
4055      (null
4056       `(progn
4057          (defclass ,name ,parent-types ,slot-specs ,@options)
4058          ',name))
4059      (string
4060       `(progn
4061          (defclass ,name ,parent-types ,slot-specs ,@options)
4062          (defmethod print-object ((condition ,name) stream)
4063            (if *print-escape*
4064                (call-next-method)
4065                (progn (write-string ,report stream) condition)))
4066          ',name))
4067      (t
4068       `(progn
4069          (defclass ,name ,parent-types ,slot-specs ,@options)
4070          (defmethod print-object ((condition ,name) stream)
4071            (if *print-escape*
4072                (call-next-method)
4073                (funcall #',report condition stream)))
4074          ',name)))))
4075
4076(defun make-condition (type &rest initargs)
4077  (or (%make-condition type initargs)
4078      (let ((class (if (symbolp type) (find-class type) type)))
4079        (apply #'make-instance class initargs))))
4080
4081;; Adapted from SBCL.
4082;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
4083(defun coerce-to-condition (datum arguments default-type fun-name)
4084  (cond ((typep datum 'condition)
4085         (when arguments
4086           (error 'simple-type-error
4087                  :datum arguments
4088                  :expected-type 'null
4089                  :format-control "You may not supply additional arguments when giving ~S to ~S."
4090                  :format-arguments (list datum fun-name)))
4091         datum)
4092        ((symbolp datum)
4093         (apply #'make-condition datum arguments))
4094        ((or (stringp datum) (functionp datum))
4095         (make-condition default-type
4096                         :format-control datum
4097                         :format-arguments arguments))
4098        (t
4099         (error 'simple-type-error
4100                :datum datum
4101                :expected-type '(or symbol string)
4102                :format-control "Bad argument to ~S: ~S."
4103                :format-arguments (list fun-name datum)))))
4104
4105(defgeneric make-load-form (object &optional environment))
4106
4107(defmethod make-load-form ((object t) &optional environment)
4108  (declare (ignore environment))
4109  (apply #'no-applicable-method #'make-load-form (list object)))
4110
4111(defmethod make-load-form ((class class) &optional environment)
4112  (declare (ignore environment))
4113  (let ((name (class-name class)))
4114    (unless (and name (eq (find-class name nil) class))
4115      (error 'simple-type-error
4116             :format-control "Can't use anonymous or undefined class as a constant: ~S."
4117             :format-arguments (list class)))
4118    `(find-class ',name)))
4119
4120(defun invalid-method-error (method format-control &rest args)
4121  (let ((message (apply #'format nil format-control args)))
4122    (error "Invalid method error for ~S:~%    ~A" method message)))
4123
4124(defun method-combination-error (format-control &rest args)
4125  (let ((message (apply #'format nil format-control args)))
4126    (error "Method combination error in CLOS dispatch:~%    ~A" message)))
4127
4128
4129(atomic-defgeneric no-applicable-method (generic-function &rest args)
4130  (:method (generic-function &rest args)
4131      (error "There is no applicable method for the generic function ~S ~
4132              when called with arguments ~S."
4133             generic-function
4134             args)))
4135
4136
4137;;; FIXME (rudi 2012-01-28): this can be a function, it only needs to
4138;;; use standard accessor functions
4139(defgeneric find-method (generic-function
4140                         qualifiers
4141                         specializers
4142                         &optional errorp))
4143
4144(defmethod find-method ((generic-function standard-generic-function)
4145                        qualifiers specializers &optional (errorp t))
4146  (%find-method generic-function qualifiers specializers errorp))
4147
4148(defgeneric find-method ((generic-function symbol)
4149                         qualifiers specializers &optional (errorp t))
4150  (find-method (find-generic-function generic-function errorp)
4151               qualifiers specializers errorp))
4152
4153;;; AMOP pg. 167
4154(defgeneric add-method (generic-function method))
4155
4156(defmethod add-method :before ((generic-function generic-function)
4157                               (method method))
4158  (when (and (method-generic-function method)
4159             (not (eql generic-function (method-generic-function method))))
4160    (error 'simple-error
4161           :format-control "~S is already a method of ~S, cannot add to ~S."
4162           :format-arguments (list method (method-generic-function method)
4163                                   generic-function)))
4164  (check-method-lambda-list (generic-function-name generic-function)
4165                            (method-lambda-list method)
4166                            (generic-function-lambda-list generic-function)))
4167
4168(defmethod add-method ((generic-function standard-generic-function)
4169                       (method standard-method))
4170  (std-add-method generic-function method))
4171
4172(defmethod add-method :after ((generic-function generic-function)
4173                              (method method))
4174  (map-dependents generic-function
4175                  #'(lambda (dep) (update-dependent generic-function dep
4176                                                    'add-method method))))
4177
4178(defgeneric remove-method (generic-function method))
4179
4180(defmethod remove-method ((generic-function standard-generic-function)
4181                          (method standard-method))
4182  (std-remove-method generic-function method))
4183
4184(defmethod remove-method :after ((generic-function generic-function)
4185                                 (method method))
4186  (map-dependents generic-function
4187                  #'(lambda (dep) (update-dependent generic-function dep
4188                                                    'remove-method method))))
4189
4190;; See describe.lisp.
4191(defgeneric describe-object (object stream))
4192
4193;; FIXME
4194(defgeneric no-next-method (generic-function method &rest args))
4195
4196(atomic-defgeneric function-keywords (method)
4197  (:method ((method standard-method))
4198    (std-function-keywords method)))
4199
4200(setf *gf-initialize-instance* (symbol-function 'initialize-instance))
4201(setf *gf-allocate-instance* (symbol-function 'allocate-instance))
4202(setf *gf-shared-initialize* (symbol-function 'shared-initialize))
4203(setf *gf-reinitialize-instance* (symbol-function 'reinitialize-instance))
4204(setf *clos-booting* nil)
4205
4206(atomic-defgeneric class-prototype (class)
4207  (:method ((class standard-class))
4208    (allocate-instance class))
4209  (:method ((class funcallable-standard-class))
4210    (allocate-instance class))
4211  (:method ((class structure-class))
4212    (allocate-instance class))
4213  (:method :before (class)
4214    (unless (class-finalized-p class)
4215      (error "~@<~S is not finalized.~:@>" class))))
4216
4217
4218
4219
4220
4221(defmethod shared-initialize :before ((instance generic-function)
4222                                      slot-names
4223                                      &key lambda-list argument-precedence-order
4224                                      &allow-other-keys)
4225  (check-argument-precedence-order lambda-list argument-precedence-order))
4226
4227(defmethod shared-initialize :after ((instance standard-generic-function)
4228                                     slot-names
4229                                     &key lambda-list argument-precedence-order
4230                                     &allow-other-keys)
4231  (let* ((plist (analyze-lambda-list lambda-list))
4232         (required-args (getf plist ':required-args)))
4233    (%set-gf-required-args instance required-args)
4234    (%set-gf-optional-args instance (getf plist :optional-args))
4235    (set-generic-function-argument-precedence-order
4236     instance (or argument-precedence-order required-args)))
4237  (when (eq (generic-function-method-combination instance) 'standard)
4238    ;; fix up "naked" (make-instance 'standard-generic-function) -- gfs
4239    ;; created via defgeneric have that slot initalized properly
4240    (set-generic-function-method-combination instance
4241                                             +the-standard-method-combination+))
4242  (finalize-standard-generic-function instance))
4243
4244;;; Readers for generic function metaobjects
4245;;; AMOP pg. 216ff.
4246(atomic-defgeneric generic-function-argument-precedence-order (generic-function)
4247  (:method ((generic-function standard-generic-function))
4248    (sys:%generic-function-argument-precedence-order generic-function)))
4249
4250(atomic-defgeneric generic-function-declarations (generic-function)
4251  (:method ((generic-function standard-generic-function))
4252    (sys:%generic-function-declarations generic-function)))
4253
4254(atomic-defgeneric generic-function-lambda-list (generic-function)
4255  (:method ((generic-function standard-generic-function))
4256    (sys:%generic-function-lambda-list generic-function)))
4257
4258(atomic-defgeneric generic-function-method-class (generic-function)
4259  (:method ((generic-function standard-generic-function))
4260    (sys:%generic-function-method-class generic-function)))
4261
4262(atomic-defgeneric generic-function-method-combination (generic-function)
4263  (:method ((generic-function standard-generic-function))
4264    (sys:%generic-function-method-combination generic-function)))
4265
4266(atomic-defgeneric generic-function-methods (generic-function)
4267  (:method ((generic-function standard-generic-function))
4268    (sys:%generic-function-methods generic-function)))
4269
4270(atomic-defgeneric generic-function-name (generic-function)
4271  (:method ((generic-function standard-generic-function))
4272    (sys:%generic-function-name generic-function)))
4273
4274;;; AMOP pg. 231
4275(defgeneric (setf generic-function-name) (new-value gf)
4276  (:method (new-value (gf generic-function))
4277    (reinitialize-instance gf :name new-value)))
4278
4279;;; Readers for Method Metaobjects
4280;;; AMOP pg. 218ff.
4281
4282(atomic-defgeneric method-function (method)
4283  (:method ((method standard-method))
4284    (std-method-function method)))
4285
4286(atomic-defgeneric method-generic-function (method)
4287  (:method ((method standard-method))
4288    (std-method-generic-function method)))
4289
4290(atomic-defgeneric method-lambda-list (method)
4291  (:method ((method standard-method))
4292    (std-slot-value method 'sys::lambda-list)))
4293
4294(atomic-defgeneric method-specializers (method)
4295  (:method ((method standard-method))
4296    (std-method-specializers method)))
4297
4298(atomic-defgeneric method-qualifiers (method)
4299  (:method ((method standard-method))
4300    (std-method-qualifiers method)))
4301
4302(atomic-defgeneric accessor-method-slot-definition (method)
4303  (:method ((method standard-accessor-method))
4304    (std-accessor-method-slot-definition method)))
4305
4306
4307;;; find-method-combination
4308
4309;;; AMOP pg. 191
4310(atomic-defgeneric find-method-combination (gf name options)
4311  (:method (gf (name symbol) options)
4312    (std-find-method-combination gf name options)))
4313
4314;;; specializer-direct-method and friends.
4315
4316;;; AMOP pg. 237
4317(defgeneric specializer-direct-generic-functions (specializer))
4318
4319(defmethod specializer-direct-generic-functions ((specializer class))
4320  (delete-duplicates (mapcar #'method-generic-function
4321                             (class-direct-methods specializer))))
4322
4323(defmethod specializer-direct-generic-functions ((specializer eql-specializer))
4324  (delete-duplicates (mapcar #'method-generic-function
4325                             (slot-value specializer 'direct-methods))))
4326
4327;;; AMOP pg. 238
4328(defgeneric specializer-direct-methods (specializer))
4329
4330(defmethod specializer-direct-methods ((specializer class))
4331  (class-direct-methods specializer))
4332
4333(defmethod specializer-direct-methods ((specializer eql-specializer))
4334  (slot-value specializer 'direct-methods))
4335
4336;;; AMOP pg. 165
4337(atomic-defgeneric add-direct-method (specializer method)
4338  (:method ((specializer class) (method method))
4339    (pushnew method (class-direct-methods specializer)))
4340  (:method ((specializer eql-specializer) (method method))
4341    (pushnew method (slot-value specializer 'direct-methods))))
4342
4343
4344;;; AMOP pg. 227
4345(atomic-defgeneric remove-direct-method (specializer method)
4346  (:method ((specializer class) (method method))
4347    (setf (class-direct-methods specializer)
4348          (remove method (class-direct-methods specializer))))
4349  (:method ((specializer eql-specializer) (method method))
4350    (setf (slot-value specializer 'direct-methods)
4351          (remove method (slot-value specializer 'direct-methods)))))
4352
4353;;; The Dependent Maintenance Protocol (AMOP pg. 160ff.)
4354
4355(defvar *dependents* (make-hash-table :test 'eq :weakness :key))
4356
4357;;; AMOP pg. 164
4358(defgeneric add-dependent (metaobject dependent))
4359(defmethod add-dependent ((metaobject standard-class) dependent)
4360  (pushnew dependent (gethash metaobject *dependents* nil)))
4361(defmethod add-dependent ((metaobject funcallable-standard-class) dependent)
4362  (pushnew dependent (gethash metaobject *dependents* nil)))
4363(defmethod add-dependent ((metaobject standard-generic-function) dependent)
4364  (pushnew dependent (gethash metaobject *dependents* nil)))
4365
4366;;; AMOP pg. 225
4367(defgeneric remove-dependent (metaobject dependent))
4368(defmethod remove-dependent ((metaobject standard-class) dependent)
4369  (setf (gethash metaobject *dependents*)
4370        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4371(defmethod remove-dependent ((metaobject funcallable-standard-class) dependent)
4372  (setf (gethash metaobject *dependents*)
4373        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4374(defmethod remove-dependent ((metaobject standard-generic-function) dependent)
4375  (setf (gethash metaobject *dependents*)
4376        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4377
4378;;; AMOP pg. 210
4379(atomic-defgeneric map-dependents (metaobject function)
4380  (:method ((metaobject standard-class) function)
4381    (dolist (dependent (gethash metaobject *dependents* nil))
4382      (funcall function dependent)))
4383  (:method ((metaobject funcallable-standard-class) function)
4384    (dolist (dependent (gethash metaobject *dependents* nil))
4385      (funcall function dependent)))
4386  (:method ((metaobject standard-generic-function) function)
4387    (dolist (dependent (gethash metaobject *dependents* nil))
4388      (funcall function dependent))))
4389
4390;;; AMOP pg. 239
4391(defgeneric update-dependent (metaobject dependent &rest initargs))
4392
4393
4394;;; ensure-generic-function(-using-class), AMOP pg. 185ff.
4395(defgeneric ensure-generic-function-using-class (generic-function function-name
4396                                                 &key
4397                                                   argument-precedence-order
4398                                                   declarations documentation
4399                                                   generic-function-class
4400                                                   lambda-list method-class
4401                                                   method-combination
4402                                                   name
4403                                                 &allow-other-keys))
4404
4405(defmethod ensure-generic-function-using-class ((generic-function generic-function)
4406                                                function-name
4407                                                &rest all-keys
4408                                                &key (generic-function-class +the-standard-generic-function-class+)
4409                                                  lambda-list
4410                                                  (method-class +the-standard-method-class+)
4411                                                  (method-combination +the-standard-method-combination+)
4412                                                &allow-other-keys)
4413  (setf all-keys (copy-list all-keys))  ; since we modify it
4414  (remf all-keys :generic-function-class)
4415  (unless (classp generic-function-class)
4416    (setf generic-function-class (find-class generic-function-class)))
4417  (unless (classp method-class) (setf method-class (find-class method-class)))
4418  (unless (eq generic-function-class (class-of generic-function))
4419    (error "The class ~S is incompatible with the existing class of ~S."
4420           generic-function-class generic-function))
4421  (unless (or (null (generic-function-methods generic-function))
4422              (lambda-lists-congruent-p lambda-list (generic-function-lambda-list generic-function)))
4423    (error "The lambda list ~S is incompatible with the existing methods of ~S."
4424           lambda-list generic-function))
4425  (unless (or (null (generic-function-methods generic-function))
4426              (eq method-class (generic-function-method-class generic-function)))
4427    (error "The method class ~S is incompatible with the existing methods of ~S."
4428           method-class generic-function))
4429  (unless (typep method-combination 'method-combination)
4430    (setf method-combination
4431          (find-method-combination generic-function
4432                                   (car method-combination)
4433                                   (cdr method-combination))))
4434  (apply #'reinitialize-instance generic-function
4435         :method-combination method-combination
4436         :method-class method-class
4437         all-keys)
4438  generic-function)
4439
4440(defmethod ensure-generic-function-using-class ((generic-function null)
4441                                                function-name
4442                                                &rest all-keys
4443                                                &key (generic-function-class +the-standard-generic-function-class+)
4444                                                  (method-class +the-standard-method-class+)
4445                                                  (method-combination +the-standard-method-combination+)
4446                                                &allow-other-keys)
4447  (setf all-keys (copy-list all-keys))  ; since we modify it
4448  (remf all-keys :generic-function-class)
4449  (unless (classp generic-function-class)
4450    (setf generic-function-class (find-class generic-function-class)))
4451  (unless (classp method-class) (setf method-class (find-class method-class)))
4452  (unless (typep method-combination 'method-combination)
4453    (setf method-combination
4454          (find-method-combination (class-prototype generic-function-class)
4455                                   (car method-combination)
4456                                   (cdr method-combination))))
4457  (when (and (null *clos-booting*) (fboundp function-name))
4458    (if (autoloadp function-name)
4459        (fmakunbound function-name)
4460        (error 'program-error
4461               :format-control "~A already names an ordinary function, macro, or special operator."
4462               :format-arguments (list function-name))))
4463  (apply (if (eq generic-function-class +the-standard-generic-function-class+)
4464             #'make-instance-standard-generic-function
4465             #'make-instance)
4466         generic-function-class
4467         :name function-name
4468         :method-class method-class
4469         :method-combination method-combination
4470         all-keys))
4471
4472(defun ensure-generic-function (function-name &rest all-keys
4473                                &key
4474                                  lambda-list generic-function-class
4475                                  method-class
4476                                  method-combination
4477                                  argument-precedence-order
4478                                  declarations
4479                                  documentation
4480                                &allow-other-keys)
4481  (declare (ignore lambda-list generic-function-class method-class
4482                   method-combination argument-precedence-order declarations
4483                   documentation))
4484  (apply #'ensure-generic-function-using-class
4485         (find-generic-function function-name nil)
4486         function-name all-keys))
4487
4488;;; SLIME compatibility functions.
4489
4490(defun %method-generic-function (method)
4491  (method-generic-function method))
4492
4493(defun %method-function (method)
4494  (method-function method))
4495
4496(eval-when (:compile-toplevel :load-toplevel :execute)
4497  (require "MOP"))
4498
4499(provide 'clos)
4500
Note: See TracBrowser for help on using the repository browser.