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

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

fix ansi tests SLOT-UNBOUND.5, SLOT-UNBOUND.6

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