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

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

Fix CLOS::EXTRACT-REQUIRED-PART when there is no required part;
e.g. (&key some-key) only.

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