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

Last change on this file since 13965 was 13965, checked in by rschlatte, 10 years ago

Implement (setf generic-function-name)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 186.3 KB
Line 
1;;; clos.lisp
2;;;
3;;; Copyright (C) 2003-2007 Peter Graves
4;;; Copyright (C) 2010 Mark Evenson
5;;; $Id: clos.lisp 13965 2012-06-14 16:16:57Z 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        (documentation nil))
1416    (dolist (item options-and-method-descriptions)
1417      (case (car item)
1418        (declare) ; FIXME
1419        (:documentation
1420         (when documentation
1421           (error 'program-error
1422                  :format-control "Documentation option was specified twice for generic function ~S."
1423                  :format-arguments (list function-name)))
1424         (setf documentation t)
1425         (push item options))
1426        (:method
1427         (push
1428          `(push (defmethod ,function-name ,@(cdr item))
1429                 (generic-function-initial-methods (fdefinition ',function-name)))
1430          methods))
1431        (t
1432         (push item options))))
1433    (setf options (nreverse options)
1434          methods (nreverse methods))
1435    ;;; Since DEFGENERIC currently shares its argument parsing with
1436    ;;; DEFMETHOD, we perform this check here.
1437    (when (find '&aux lambda-list)
1438      (error 'program-error
1439             :format-control "&AUX is not allowed in a generic function lambda list: ~S"
1440             :format-arguments (list lambda-list)))
1441    `(prog1
1442       (%defgeneric
1443        ',function-name
1444        :lambda-list ',lambda-list
1445        ,@(canonicalize-defgeneric-options options))
1446       ,@methods)))
1447
1448(defun canonicalize-defgeneric-options (options)
1449  (mapappend #'canonicalize-defgeneric-option options))
1450
1451(defun canonicalize-defgeneric-option (option)
1452  (case (car option)
1453    (:generic-function-class
1454     (list :generic-function-class `(find-class ',(cadr option))))
1455    (:method-class
1456     (list :method-class `(find-class ',(cadr option))))
1457    (:method-combination
1458     (list :method-combination `',(cdr option)))
1459    (:argument-precedence-order
1460     (list :argument-precedence-order `',(cdr option)))
1461    (t
1462     (list `',(car option) `',(cadr option)))))
1463
1464;; From OpenMCL (called canonicalize-argument-precedence-order there,
1465;; but AMOP specifies argument-precedence-order to return a permutation
1466;; of the required arguments, not a list of indices, so we calculate
1467;; them on demand).
1468(defun argument-precedence-order-indices (apo req)
1469  (cond ((equal apo req) nil)
1470        ((not (eql (length apo) (length req)))
1471         (error 'program-error
1472                :format-control "Specified argument precedence order ~S does not match lambda list."
1473                :format-arguments (list apo)))
1474        (t (let ((res nil))
1475             (dolist (arg apo (nreverse res))
1476               (let ((index (position arg req)))
1477                 (if (or (null index) (memq index res))
1478                     (error 'program-error
1479                            :format-control "Specified argument precedence order ~S does not match lambda list."
1480                            :format-arguments (list apo)))
1481                 (push index res)))))))
1482
1483(defun find-generic-function (name &optional (errorp t))
1484  (let ((function (and (fboundp name) (fdefinition name))))
1485    (when function
1486      (when (typep function 'generic-function)
1487        (return-from find-generic-function function))
1488      (when (and *traced-names* (find name *traced-names* :test #'equal))
1489        (setf function (untraced-function name))
1490        (when (typep function 'generic-function)
1491          (return-from find-generic-function function)))))
1492  (if errorp
1493      (error "There is no generic function named ~S." name)
1494      nil))
1495
1496(defun lambda-lists-congruent-p (lambda-list1 lambda-list2)
1497  (let* ((plist1 (analyze-lambda-list lambda-list1))
1498         (args1 (getf plist1 :required-args))
1499         (plist2 (analyze-lambda-list lambda-list2))
1500         (args2 (getf plist2 :required-args)))
1501    (= (length args1) (length args2))))
1502
1503(defun %defgeneric (function-name &rest all-keys)
1504  (when (fboundp function-name)
1505    (let ((gf (fdefinition function-name)))
1506      (when (typep gf 'generic-function)
1507        ;; Remove methods defined by previous DEFGENERIC forms, as
1508        ;; specified by CLHS, 7.7 (Macro DEFGENERIC).
1509        (dolist (method (generic-function-initial-methods gf))
1510          (if (typep gf 'standard-generic-function)
1511              (progn
1512                (std-remove-method gf method)
1513                (map-dependents gf
1514                                #'(lambda (dep)
1515                                    (update-dependent gf dep
1516                                                      'remove-method method))))
1517              (remove-method gf method)))
1518        (setf (generic-function-initial-methods gf) '()))))
1519  (apply 'ensure-generic-function function-name all-keys))
1520
1521;;; Bootstrap version of ensure-generic-function, handling only
1522;;; standard-generic-function.  This function will be replaced in
1523;;; mop.lisp.
1524(declaim (notinline ensure-generic-function))
1525(defun ensure-generic-function (function-name
1526                                &rest all-keys
1527                                &key
1528                                lambda-list
1529                                (generic-function-class +the-standard-generic-function-class+)
1530                                (method-class +the-standard-method-class+)
1531                                (method-combination 'standard)
1532                                argument-precedence-order
1533                                documentation
1534                                &allow-other-keys)
1535  (when (autoloadp function-name)
1536    (resolve function-name))
1537  (setf all-keys (copy-list all-keys))  ; since we modify it
1538  (remf all-keys :generic-function-class)
1539  (let ((gf (find-generic-function function-name nil)))
1540    (if gf
1541        (progn
1542          (unless (or (null (generic-function-methods gf))
1543                      (lambda-lists-congruent-p lambda-list (generic-function-lambda-list gf)))
1544            (error 'simple-error
1545                   :format-control "The lambda list ~S is incompatible with the existing methods of ~S."
1546                   :format-arguments (list lambda-list gf)))
1547          (setf (generic-function-lambda-list gf) lambda-list)
1548          (setf (generic-function-documentation gf) documentation)
1549          (let* ((plist (analyze-lambda-list lambda-list))
1550                 (required-args (getf plist ':required-args)))
1551            (%set-gf-required-args gf required-args)
1552            (%set-gf-optional-args gf (getf plist :optional-args))
1553            (setf (generic-function-argument-precedence-order gf)
1554                  (or argument-precedence-order required-args))
1555            (finalize-standard-generic-function gf))
1556          gf)
1557        (progn
1558          (when (and (null *clos-booting*)
1559                     (fboundp function-name))
1560            (error 'program-error
1561                   :format-control "~A already names an ordinary function, macro, or special operator."
1562                   :format-arguments (list function-name)))
1563          (setf gf (apply (if (eq generic-function-class +the-standard-generic-function-class+)
1564                              #'make-instance-standard-generic-function
1565                              #'make-instance)
1566                          generic-function-class
1567                          :name function-name
1568                          :method-class method-class
1569                          :method-combination method-combination
1570                          all-keys))
1571          gf))))
1572
1573(defun initial-discriminating-function (gf args)
1574  (set-funcallable-instance-function
1575   gf
1576   (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
1577                #'std-compute-discriminating-function
1578                #'compute-discriminating-function)
1579            gf))
1580  (apply gf args))
1581
1582(defun collect-eql-specializer-objects (generic-function)
1583  (let ((result nil))
1584    (dolist (method (generic-function-methods generic-function))
1585      (dolist (specializer (method-specializers method))
1586        (when (typep specializer 'eql-specializer)
1587          (pushnew (eql-specializer-object specializer)
1588                   result
1589                   :test 'eql))))
1590    result))
1591
1592(defun finalize-standard-generic-function (gf)
1593  (%finalize-generic-function gf)
1594  (unless (generic-function-classes-to-emf-table gf)
1595    (set-generic-function-classes-to-emf-table gf (make-hash-table :test #'equal)))
1596  (clrhash (generic-function-classes-to-emf-table gf))
1597  (%init-eql-specializations gf (collect-eql-specializer-objects gf))
1598  (set-funcallable-instance-function
1599   gf #'(lambda (&rest args)
1600          (initial-discriminating-function gf args)))
1601  ;; FIXME Do we need to warn on redefinition somewhere else?
1602  (let ((*warn-on-redefinition* nil))
1603    (setf (fdefinition (%generic-function-name gf)) gf))
1604  (values))
1605
1606(defun make-instance-standard-generic-function (generic-function-class
1607                                                &key name lambda-list
1608                                                method-class
1609                                                method-combination
1610                                                argument-precedence-order
1611                                                documentation)
1612  ;; to avoid circularities, we do not call generic functions in here.
1613  (declare (ignore generic-function-class))
1614  (let ((gf (std-allocate-instance +the-standard-generic-function-class+)))
1615    (%set-generic-function-name gf name)
1616    (%set-generic-function-lambda-list gf lambda-list)
1617    (set-generic-function-initial-methods gf ())
1618    (set-generic-function-methods gf ())
1619    (set-generic-function-method-class gf method-class)
1620    (set-generic-function-method-combination gf method-combination)
1621    (set-generic-function-documentation gf documentation)
1622    (set-generic-function-classes-to-emf-table gf nil)
1623    (let* ((plist (analyze-lambda-list (generic-function-lambda-list gf)))
1624           (required-args (getf plist ':required-args)))
1625      (%set-gf-required-args gf required-args)
1626      (%set-gf-optional-args gf (getf plist :optional-args))
1627      (set-generic-function-argument-precedence-order
1628       gf (or argument-precedence-order required-args)))
1629    (finalize-standard-generic-function gf)
1630    gf))
1631
1632(defun canonicalize-specializers (specializers)
1633  (mapcar #'canonicalize-specializer specializers))
1634
1635(defun canonicalize-specializer (specializer)
1636  (cond ((classp specializer)
1637         specializer)
1638        ((typep specializer 'eql-specializer)
1639         specializer)
1640        ((symbolp specializer)
1641         (find-class specializer))
1642        ((and (consp specializer)
1643              (eq (car specializer) 'eql))
1644         (let ((object (cadr specializer)))
1645           (when (and (consp object)
1646                      (eq (car object) 'quote))
1647             (setf object (cadr object)))
1648           (intern-eql-specializer object)))
1649        ((and (consp specializer)
1650              (eq (car specializer) 'java:jclass))
1651         (let ((jclass (eval specializer)))
1652           (java::ensure-java-class jclass)))
1653        (t
1654         (error "Unknown specializer: ~S" specializer))))
1655
1656(defun parse-defmethod (args)
1657  (let ((function-name (car args))
1658        (qualifiers ())
1659        (specialized-lambda-list ())
1660        (body ())
1661        (parse-state :qualifiers))
1662    (dolist (arg (cdr args))
1663      (ecase parse-state
1664        (:qualifiers
1665         (if (and (atom arg) (not (null arg)))
1666             (push arg qualifiers)
1667             (progn
1668               (setf specialized-lambda-list arg)
1669               (setf parse-state :body))))
1670        (:body (push arg body))))
1671    (setf qualifiers (nreverse qualifiers)
1672          body (nreverse body))
1673    (multiple-value-bind (real-body declarations documentation)
1674        (parse-body body)
1675      (values function-name
1676              qualifiers
1677              (extract-lambda-list specialized-lambda-list)
1678              (extract-specializer-names specialized-lambda-list)
1679              documentation
1680              declarations
1681              (list* 'block
1682                     (fdefinition-block-name function-name)
1683                     real-body)))))
1684
1685(defun required-portion (gf args)
1686  (let ((number-required (length (gf-required-args gf))))
1687    (when (< (length args) number-required)
1688      (error 'program-error
1689             :format-control "Not enough arguments for generic function ~S."
1690             :format-arguments (list (%generic-function-name gf))))
1691    (subseq args 0 number-required)))
1692
1693(defun extract-lambda-list (specialized-lambda-list)
1694  (let* ((plist (analyze-lambda-list specialized-lambda-list))
1695         (requireds (getf plist :required-names))
1696         (rv (getf plist :rest-var))
1697         (ks (getf plist :key-args))
1698         (keysp (getf plist :keysp))
1699         (aok (getf plist :allow-other-keys))
1700         (opts (getf plist :optional-args))
1701         (auxs (getf plist :auxiliary-args)))
1702    `(,@requireds
1703      ,@(if rv `(&rest ,rv) ())
1704      ,@(if (or ks keysp aok) `(&key ,@ks) ())
1705      ,@(if aok '(&allow-other-keys) ())
1706      ,@(if opts `(&optional ,@opts) ())
1707      ,@(if auxs `(&aux ,@auxs) ()))))
1708
1709(defun extract-specializer-names (specialized-lambda-list)
1710  (let ((plist (analyze-lambda-list specialized-lambda-list)))
1711    (getf plist ':specializers)))
1712
1713(defun get-keyword-from-arg (arg)
1714  (if (listp arg)
1715      (if (listp (car arg))
1716          (caar arg)
1717          (make-keyword (car arg)))
1718      (make-keyword arg)))
1719
1720(defun analyze-lambda-list (lambda-list)
1721  (let ((keys ())           ; Just the keywords
1722        (key-args ())       ; Keywords argument specs
1723        (keysp nil)         ;
1724        (required-names ()) ; Just the variable names
1725        (required-args ())  ; Variable names & specializers
1726        (specializers ())   ; Just the specializers
1727        (rest-var nil)
1728        (optionals ())
1729        (auxs ())
1730        (allow-other-keys nil)
1731        (state :parsing-required))
1732    (dolist (arg lambda-list)
1733      (if (member arg lambda-list-keywords)
1734          (ecase arg
1735            (&optional
1736             (setq state :parsing-optional))
1737            (&rest
1738             (setq state :parsing-rest))
1739            (&key
1740             (setq keysp t)
1741             (setq state :parsing-key))
1742            (&allow-other-keys
1743             (setq allow-other-keys 't))
1744            (&aux
1745             (setq state :parsing-aux)))
1746          (case state
1747            (:parsing-required
1748             (push-on-end arg required-args)
1749             (if (listp arg)
1750                 (progn (push-on-end (car arg) required-names)
1751                   (push-on-end (cadr arg) specializers))
1752                 (progn (push-on-end arg required-names)
1753                   (push-on-end 't specializers))))
1754            (:parsing-optional (push-on-end arg optionals))
1755            (:parsing-rest (setq rest-var arg))
1756            (:parsing-key
1757             (push-on-end (get-keyword-from-arg arg) keys)
1758             (push-on-end arg key-args))
1759            (:parsing-aux (push-on-end arg auxs)))))
1760    (list  :required-names required-names
1761           :required-args required-args
1762           :specializers specializers
1763           :rest-var rest-var
1764           :keywords keys
1765           :key-args key-args
1766           :keysp keysp
1767           :auxiliary-args auxs
1768           :optional-args optionals
1769           :allow-other-keys allow-other-keys)))
1770
1771#+nil
1772(defun check-method-arg-info (gf arg-info method)
1773  (multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
1774      (analyze-lambda-list (if (consp method)
1775                               (early-method-lambda-list method)
1776                               (method-lambda-list method)))
1777    (flet ((lose (string &rest args)
1778                 (error 'simple-program-error
1779                        :format-control "~@<attempt to add the method~2I~_~S~I~_~
1780                        to the generic function~2I~_~S;~I~_~
1781                        but ~?~:>"
1782                        :format-arguments (list method gf string args)))
1783           (comparison-description (x y)
1784                                   (if (> x y) "more" "fewer")))
1785      (let ((gf-nreq (arg-info-number-required arg-info))
1786            (gf-nopt (arg-info-number-optional arg-info))
1787            (gf-key/rest-p (arg-info-key/rest-p arg-info))
1788            (gf-keywords (arg-info-keys arg-info)))
1789        (unless (= nreq gf-nreq)
1790          (lose
1791           "the method has ~A required arguments than the generic function."
1792           (comparison-description nreq gf-nreq)))
1793        (unless (= nopt gf-nopt)
1794          (lose
1795           "the method has ~A optional arguments than the generic function."
1796           (comparison-description nopt gf-nopt)))
1797        (unless (eq (or keysp restp) gf-key/rest-p)
1798          (lose
1799           "the method and generic function differ in whether they accept~_~
1800            &REST or &KEY arguments."))
1801        (when (consp gf-keywords)
1802          (unless (or (and restp (not keysp))
1803                      allow-other-keys-p
1804                      (every (lambda (k) (memq k keywords)) gf-keywords))
1805            (lose "the method does not accept each of the &KEY arguments~2I~_~
1806            ~S."
1807                  gf-keywords)))))))
1808
1809(defun check-method-lambda-list (name method-lambda-list gf-lambda-list)
1810  (let* ((gf-restp (not (null (memq '&rest gf-lambda-list))))
1811         (gf-plist (analyze-lambda-list gf-lambda-list))
1812         (gf-keysp (getf gf-plist :keysp))
1813         (gf-keywords (getf gf-plist :keywords))
1814         (method-plist (analyze-lambda-list method-lambda-list))
1815         (method-restp (not (null (memq '&rest method-lambda-list))))
1816         (method-keysp (getf method-plist :keysp))
1817         (method-keywords (getf method-plist :keywords))
1818         (method-allow-other-keys-p (getf method-plist :allow-other-keys)))
1819    (unless (= (length (getf gf-plist :required-args))
1820               (length (getf method-plist :required-args)))
1821      (error "The method-lambda-list ~S ~
1822              has the wrong number of required arguments ~
1823              for the generic function ~S." method-lambda-list name))
1824    (unless (= (length (getf gf-plist :optional-args))
1825               (length (getf method-plist :optional-args)))
1826      (error "The method-lambda-list ~S ~
1827              has the wrong number of optional arguments ~
1828              for the generic function ~S." method-lambda-list name))
1829    (unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
1830      (error "The method-lambda-list ~S ~
1831              and the generic function ~S ~
1832              differ in whether they accept &REST or &KEY arguments."
1833             method-lambda-list name))
1834    (when (consp gf-keywords)
1835      (unless (or (and method-restp (not method-keysp))
1836                  method-allow-other-keys-p
1837                  (every (lambda (k) (memq k method-keywords)) gf-keywords))
1838        (error "The method-lambda-list ~S does not accept ~
1839                all of the keyword arguments defined for the ~
1840                generic function." method-lambda-list name)))))
1841
1842(defvar *gf-initialize-instance* nil
1843  "Cached value of the INITIALIZE-INSTANCE generic function.
1844Initialized with the true value near the end of the file.")
1845(defvar *gf-allocate-instance* nil
1846  "Cached value of the ALLOCATE-INSTANCE generic function.
1847Initialized with the true value near the end of the file.")
1848(defvar *gf-shared-initialize* nil
1849  "Cached value of the SHARED-INITIALIZE generic function.
1850Initialized with the true value near the end of the file.")
1851(defvar *gf-reinitialize-instance* nil
1852  "Cached value of the REINITIALIZE-INSTANCE generic function.
1853Initialized with the true value near the end of the file.")
1854
1855(declaim (ftype (function * method) ensure-method))
1856(defun ensure-method (name &rest all-keys)
1857  (let ((method-lambda-list (getf all-keys :lambda-list))
1858        (gf (find-generic-function name nil)))
1859    (when (or (eq gf *gf-initialize-instance*)
1860              (eq gf *gf-allocate-instance*)
1861              (eq gf *gf-shared-initialize*)
1862              (eq gf *gf-reinitialize-instance*))
1863      ;; ### Clearly, this can be targeted much more exact
1864      ;; as we only need to remove the specializing class and all
1865      ;; its subclasses from the hash.
1866      (clrhash *make-instance-initargs-cache*)
1867      (clrhash *reinitialize-instance-initargs-cache*))
1868    (if gf
1869        (check-method-lambda-list name method-lambda-list
1870                                  (generic-function-lambda-list gf))
1871        (setf gf (ensure-generic-function name :lambda-list method-lambda-list)))
1872    (let ((method
1873           (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1874               (apply #'make-instance-standard-method gf all-keys)
1875               (apply #'make-instance (generic-function-method-class gf) all-keys))))
1876      (if (eq (generic-function-method-class gf) +the-standard-method-class+)
1877          (progn
1878            (std-add-method gf method)
1879            (map-dependents gf
1880                            #'(lambda (dep)
1881                                (update-dependent gf dep 'add-method method))))
1882          (add-method gf method))
1883      method)))
1884
1885(defun make-instance-standard-method (gf
1886                                      &key
1887                                      lambda-list
1888                                      qualifiers
1889                                      specializers
1890                                      documentation
1891                                      function
1892                                      fast-function)
1893  (declare (ignore gf))
1894  (let ((method (std-allocate-instance +the-standard-method-class+))
1895        (analyzed-args (analyze-lambda-list lambda-list)))
1896    (setf (method-lambda-list method) lambda-list)
1897    (setf (method-qualifiers method) qualifiers)
1898    (setf (std-slot-value method 'sys::specializers)
1899          (canonicalize-specializers specializers))
1900    (setf (method-documentation method) documentation)
1901    (setf (std-slot-value method 'sys::%generic-function) nil) ; set by add-method
1902    (setf (std-slot-value method 'sys::%function) function)
1903    (setf (std-slot-value method 'sys::fast-function) fast-function)
1904    (setf (std-slot-value method 'sys::keywords) (getf analyzed-args :keywords))
1905    (setf (std-slot-value method 'sys::other-keywords-p)
1906          (getf analyzed-args :allow-other-keys))
1907    method))
1908
1909;;; To be redefined as generic functions later
1910(declaim (notinline add-direct-method))
1911(defun add-direct-method (specializer method)
1912  (if (typep specializer 'eql-specializer)
1913      (pushnew method (std-slot-value specializer 'direct-methods))
1914      (pushnew method (class-direct-methods specializer))))
1915
1916(declaim (notinline remove-direct-method))
1917(defun remove-direct-method (specializer method)
1918  (if (typep specializer 'eql-specializer)
1919      (setf (std-slot-value specializer 'direct-methods)
1920            (remove method (std-slot-value specializer 'direct-methods)))
1921      (setf (class-direct-methods specializer)
1922            (remove method (class-direct-methods specializer)))))
1923
1924(defun std-add-method (gf method)
1925  (when (and (method-generic-function method)
1926             (not (eql gf (method-generic-function method))))
1927    (error 'simple-error
1928           :format-control "~S is already a method of ~S, cannot add to ~S."
1929           :format-arguments (list method (method-generic-function method) gf)))
1930  ;; Remove existing method with same qualifiers and specializers (if any).
1931  (let ((old-method (%find-method gf (std-method-qualifiers method)
1932                                 (method-specializers method) nil)))
1933    (when old-method
1934      (std-remove-method gf old-method)))
1935  (setf (std-slot-value method 'sys::%generic-function) gf)
1936  (push method (generic-function-methods gf))
1937  (dolist (specializer (method-specializers method))
1938    (add-direct-method specializer method))
1939  (finalize-standard-generic-function gf)
1940  gf)
1941
1942(defun std-remove-method (gf method)
1943  (setf (generic-function-methods gf)
1944        (remove method (generic-function-methods gf)))
1945  (setf (std-slot-value method 'sys::%generic-function) nil)
1946  (dolist (specializer (method-specializers method))
1947    (remove-direct-method specializer method))
1948  (finalize-standard-generic-function gf)
1949  gf)
1950
1951(defun %find-method (gf qualifiers specializers &optional (errorp t))
1952  ;; "If the specializers argument does not correspond in length to the number
1953  ;; of required arguments of the generic-function, an an error of type ERROR
1954  ;; is signaled."
1955  (unless (= (length specializers) (length (gf-required-args gf)))
1956    (error "The specializers argument has length ~S, but ~S has ~S required parameters."
1957           (length specializers)
1958           gf
1959           (length (gf-required-args gf))))
1960  (let* ((canonical-specializers (canonicalize-specializers specializers))
1961         (method
1962          (find-if #'(lambda (method)
1963                      (and (equal qualifiers
1964                                  (method-qualifiers method))
1965                           (equal canonical-specializers
1966                                  (method-specializers method))))
1967                   (generic-function-methods gf))))
1968    (if (and (null method) errorp)
1969        (error "No such method for ~S." (%generic-function-name gf))
1970        method)))
1971
1972(defun fast-callable-p (gf)
1973  (and (eq (generic-function-method-combination gf) 'standard)
1974       (null (intersection (%generic-function-lambda-list gf)
1975                           '(&rest &optional &key &allow-other-keys &aux)))))
1976
1977(declaim (ftype (function * t) slow-method-lookup-1))
1978
1979(declaim (ftype (function (t t t) t) slow-reader-lookup))
1980(defun slow-reader-lookup (gf layout slot-name)
1981  (let ((location (layout-slot-location layout slot-name)))
1982    (cache-slot-location gf layout location)
1983    location))
1984
1985(defun std-compute-discriminating-function (gf)
1986  ;; In this function, we know that gf is of class
1987  ;; standard-generic-function, so we call various
1988  ;; sys:%generic-function-foo readers to break circularities.
1989  ;; (rudi 2012-01-27): maybe we need to discriminate between
1990  ;; standard-methods and methods as well.
1991  (cond
1992    ((and (= (length (sys:%generic-function-methods gf)) 1)
1993          (typep (car (sys:%generic-function-methods gf)) 'standard-reader-method))
1994     (let* ((method (%car (sys:%generic-function-methods gf)))
1995            (class (car (std-method-specializers method)))
1996            (slot-name (slot-definition-name (accessor-method-slot-definition method))))
1997       #'(lambda (arg)
1998           (declare (optimize speed))
1999           (let* ((layout (std-instance-layout arg))
2000                  (location (get-cached-slot-location gf layout)))
2001             (unless location
2002               (unless (simple-typep arg class)
2003                 ;; FIXME no applicable method
2004                 (error 'simple-type-error
2005                        :datum arg
2006                        :expected-type class))
2007               (setf location (slow-reader-lookup gf layout slot-name)))
2008             (let ((value (if (consp location)
2009                              (cdr location) ; :allocation :class
2010                              (funcallable-standard-instance-access arg location))))
2011               (if (eq value +slot-unbound+)
2012                   (slot-unbound class arg slot-name)
2013                   value))))))
2014
2015    (t
2016     (let* ((emf-table (classes-to-emf-table gf))
2017            (number-required (length (gf-required-args gf)))
2018            (lambda-list (%generic-function-lambda-list gf))
2019            (exact (null (intersection lambda-list
2020                                       '(&rest &optional &key
2021                                         &allow-other-keys))))
2022            (no-aux (null (some 
2023                           (lambda (method) 
2024                             (find '&aux (std-slot-value method 'sys::lambda-list)))
2025                           (sys:%generic-function-methods gf)))))
2026       (if (and exact
2027                no-aux)
2028           (cond
2029             ((= number-required 1)
2030              (cond
2031                ((and (eq (sys:%generic-function-method-combination gf) 'standard)
2032                      (= (length (sys:%generic-function-methods gf)) 1))
2033                 (let* ((method (%car (sys:%generic-function-methods gf)))
2034                        (specializer (car (std-method-specializers method)))
2035                        (function (or (std-method-fast-function method)
2036                                      (std-method-function method))))
2037                   (if (typep specializer 'eql-specializer)
2038                       (let ((specializer-object (eql-specializer-object specializer)))
2039                         #'(lambda (arg)
2040                             (declare (optimize speed))
2041                             (if (eql arg specializer-object)
2042                                 (funcall function arg)
2043                                 (no-applicable-method gf (list arg)))))
2044                       #'(lambda (arg)
2045                           (declare (optimize speed))
2046                           (unless (simple-typep arg specializer)
2047                             ;; FIXME no applicable method
2048                             (error 'simple-type-error
2049                                    :datum arg
2050                                    :expected-type specializer))
2051                           (funcall function arg)))))
2052                (t
2053                 #'(lambda (arg)
2054                     (declare (optimize speed))
2055                     (let* ((specialization
2056                             (%get-arg-specialization gf arg))
2057                            (emfun (or (gethash1 specialization
2058                                                 emf-table)
2059                                       (slow-method-lookup-1
2060                                        gf arg specialization))))
2061                       (if emfun
2062                           (funcall emfun (list arg))
2063                           (apply #'no-applicable-method gf (list arg))))))))
2064             ((= number-required 2)
2065              #'(lambda (arg1 arg2)
2066                  (declare (optimize speed))
2067                  (let* ((args (list arg1 arg2))
2068                         (emfun (get-cached-emf gf args)))
2069                    (if emfun
2070                        (funcall emfun args)
2071                        (slow-method-lookup gf args)))))
2072             ((= number-required 3)
2073              #'(lambda (arg1 arg2 arg3)
2074                  (declare (optimize speed))
2075                  (let* ((args (list arg1 arg2 arg3))
2076                         (emfun (get-cached-emf gf args)))
2077                    (if emfun
2078                        (funcall emfun args)
2079                        (slow-method-lookup gf args)))))
2080             (t
2081              #'(lambda (&rest args)
2082                  (declare (optimize speed))
2083                  (let ((len (length args)))
2084                    (unless (= len number-required)
2085                      (error 'program-error
2086                             :format-control "Not enough arguments for generic function ~S."
2087                             :format-arguments (list (%generic-function-name gf)))))
2088                  (let ((emfun (get-cached-emf gf args)))
2089                    (if emfun
2090                        (funcall emfun args)
2091                        (slow-method-lookup gf args))))))
2092           ;;           (let ((non-key-args (+ number-required
2093           ;;                                  (length (gf-optional-args gf))))))
2094           #'(lambda (&rest args)
2095               (declare (optimize speed))
2096               (let ((len (length args)))
2097                 (unless (>= len number-required)
2098                   (error 'program-error
2099                          :format-control "Not enough arguments for generic function ~S."
2100                          :format-arguments (list (%generic-function-name gf)))))
2101               (let ((emfun (get-cached-emf gf args)))
2102                 (if emfun
2103                     (funcall emfun args)
2104                     (slow-method-lookup gf args)))))))))
2105
2106(defun sort-methods (methods gf required-classes)
2107  (if (or (null methods) (null (%cdr methods)))
2108      methods
2109      (sort methods
2110            (if (eq (class-of gf) +the-standard-generic-function-class+)
2111                (let ((method-indices
2112                       (argument-precedence-order-indices
2113                        (generic-function-argument-precedence-order gf)
2114                        (getf (analyze-lambda-list (generic-function-lambda-list gf))
2115                              ':required-args))))
2116                  #'(lambda (m1 m2)
2117                      (std-method-more-specific-p
2118                       m1 m2 required-classes method-indices)))
2119                #'(lambda (m1 m2)
2120                    (method-more-specific-p gf m1 m2 required-classes))))))
2121
2122(defun method-applicable-p (method args)
2123  (do* ((specializers (method-specializers method) (cdr specializers))
2124        (args args (cdr args)))
2125       ((null specializers) t)
2126    (let ((specializer (car specializers)))
2127      (if (typep specializer 'eql-specializer)
2128          (unless (eql (car args) (eql-specializer-object specializer))
2129            (return nil))
2130          (unless (subclassp (class-of (car args)) specializer)
2131            (return nil))))))
2132
2133(defun %compute-applicable-methods (gf args)
2134  (let ((required-classes (mapcar #'class-of (required-portion gf args)))
2135        (methods '()))
2136    (dolist (method (generic-function-methods gf))
2137      (when (method-applicable-p method args)
2138        (push method methods)))
2139    (sort-methods methods gf required-classes)))
2140
2141;;; METHOD-APPLICABLE-USING-CLASSES-P
2142;;;
2143;;; If the first return value is T, METHOD is definitely applicable to
2144;;; arguments that are instances of CLASSES.  If the first value is
2145;;; NIL and the second value is T, METHOD is definitely not applicable
2146;;; to arguments that are instances of CLASSES; if the second value is
2147;;; NIL the applicability of METHOD cannot be determined by inspecting
2148;;; the classes of its arguments only.
2149;;;
2150(defun method-applicable-using-classes-p (method classes)
2151  (do* ((specializers (method-specializers method) (cdr specializers))
2152  (classes classes (cdr classes))
2153  (knownp t))
2154       ((null specializers)
2155  (if knownp (values t t) (values nil nil)))
2156    (let ((specializer (car specializers)))
2157      (if (typep specializer 'eql-specializer)
2158    (if (eql (class-of (eql-specializer-object specializer)) 
2159       (car classes))
2160        (setf knownp nil)
2161        (return (values nil t)))
2162    (unless (subclassp (car classes) specializer)
2163      (return (values nil t)))))))
2164
2165(defun check-applicable-method-keyword-args (gf args
2166                                             keyword-args
2167                                             applicable-keywords)
2168  (when (oddp (length keyword-args))
2169    (error 'program-error
2170           :format-control "Odd number of keyword arguments in call to ~S ~
2171with arguments list ~S"
2172           :format-arguments (list gf args)))
2173  (unless (getf keyword-args :allow-other-keys)
2174    (loop for key in keyword-args by #'cddr
2175       unless (or (member key applicable-keywords)
2176                  (eq key :allow-other-keys))
2177       do (error 'program-error
2178                 :format-control "Invalid keyword argument ~S in call ~
2179to ~S with argument list ~S."
2180                 :format-arguments (list key gf args)))))
2181
2182(defun compute-applicable-keywords (gf applicable-methods)
2183  (let ((applicable-keywords
2184         (getf (analyze-lambda-list (generic-function-lambda-list gf))
2185               :keywords)))
2186    (loop for method in applicable-methods
2187       do (multiple-value-bind
2188                (keywords allow-other-keys)
2189              (function-keywords method)
2190            (when allow-other-keys
2191              (setf applicable-keywords :any)
2192              (return))
2193            (setf applicable-keywords
2194                  (union applicable-keywords keywords))))
2195    applicable-keywords))
2196
2197(defun wrap-emfun-for-keyword-args-check (gf emfun non-keyword-args
2198                                          applicable-keywords)
2199  #'(lambda (args)
2200      (check-applicable-method-keyword-args
2201         gf args
2202         (nthcdr non-keyword-args args) applicable-keywords)
2203      (funcall emfun args)))
2204
2205(defun slow-method-lookup (gf args)
2206  (let ((applicable-methods (%compute-applicable-methods gf args)))
2207    (if applicable-methods
2208        (let* ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
2209                                   #'std-compute-effective-method
2210                                   #'compute-effective-method)
2211                               gf (generic-function-method-combination gf)
2212                               applicable-methods))
2213               (non-keyword-args
2214                (+ (length (gf-required-args gf))
2215                   (length (gf-optional-args gf))))
2216               (gf-lambda-list (generic-function-lambda-list gf))
2217               (checks-required (and (member '&key gf-lambda-list)
2218                                     (not (member '&allow-other-keys
2219                                                  gf-lambda-list)))
2220                 )
2221              (applicable-keywords
2222               (when checks-required
2223                 ;; Don't do applicable keyword checks when this is
2224                 ;; one of the 'exceptional four' or when the gf allows
2225                 ;; other keywords.
2226                 (compute-applicable-keywords gf applicable-methods))))
2227          (when (and checks-required
2228                     (not (eq applicable-keywords :any)))
2229            (setf emfun
2230                  (wrap-emfun-for-keyword-args-check gf emfun non-keyword-args
2231                                                     applicable-keywords)))
2232          (cache-emf gf args emfun)
2233          (funcall emfun args))
2234        (apply #'no-applicable-method gf args))))
2235
2236(defun slow-method-lookup-1 (gf arg arg-specialization)
2237  (let ((applicable-methods (%compute-applicable-methods gf (list arg))))
2238    (if applicable-methods
2239        (let ((emfun (funcall (if (eq (class-of gf) +the-standard-generic-function-class+)
2240                                  #'std-compute-effective-method
2241                                  #'compute-effective-method)
2242                              gf (generic-function-method-combination gf)
2243                              applicable-methods)))
2244          (when emfun
2245            (setf (gethash arg-specialization (classes-to-emf-table gf)) emfun))
2246          emfun))))
2247
2248(defun sub-specializer-p (c1 c2 c-arg)
2249  (find c2 (cdr (memq c1 (%class-precedence-list c-arg)))))
2250
2251(defun std-method-more-specific-p (method1 method2 required-classes argument-precedence-order)
2252  (if argument-precedence-order
2253      (let ((specializers-1 (std-method-specializers method1))
2254            (specializers-2 (std-method-specializers method2)))
2255        (dolist (index argument-precedence-order)
2256          (let ((spec1 (nth index specializers-1))
2257                (spec2 (nth index specializers-2)))
2258            (unless (eq spec1 spec2)
2259              (cond ((typep spec1 'eql-specializer)
2260                     (return t))
2261                    ((typep spec2 'eql-specializer)
2262                     (return nil))
2263                    (t
2264                     (return (sub-specializer-p spec1 spec2
2265                                                (nth index required-classes)))))))))
2266      (do ((specializers-1 (std-method-specializers method1) (cdr specializers-1))
2267           (specializers-2 (std-method-specializers method2) (cdr specializers-2))
2268           (classes required-classes (cdr classes)))
2269          ((null specializers-1) nil)
2270        (let ((spec1 (car specializers-1))
2271              (spec2 (car specializers-2)))
2272          (unless (eq spec1 spec2)
2273            (cond ((typep spec1 'eql-specializer)
2274                   (return t))
2275                  ((typep spec2 'eql-specializer)
2276                   (return nil))
2277                  (t
2278                   (return (sub-specializer-p spec1 spec2 (car classes))))))))))
2279
2280(defun primary-method-p (method)
2281  (null (intersection '(:before :after :around) (method-qualifiers method))))
2282
2283(defun before-method-p (method)
2284  (equal '(:before) (method-qualifiers method)))
2285
2286(defun after-method-p (method)
2287  (equal '(:after) (method-qualifiers method)))
2288
2289(defun around-method-p (method)
2290  (equal '(:around) (method-qualifiers method)))
2291
2292(defun process-next-method-list (next-method-list)
2293  (mapcar #'(lambda (next-method-form)
2294              (cond
2295                ((listp next-method-form)
2296                 (assert (eq (first next-method-form) 'make-method))
2297                 (let* ((rest-sym (gensym)))
2298                   (make-instance-standard-method
2299                    nil ;; ignored
2300                    :lambda-list (list '&rest rest-sym)
2301                    :function (compute-method-function `(lambda (&rest ,rest-sym)
2302                                                          ,(second next-method-form))))))
2303                (t
2304                 (assert (typep next-method-form 'method))
2305                 next-method-form)))
2306          next-method-list))
2307
2308(defun std-compute-effective-method (gf mc methods)
2309  (let* ((mc-name (if (atom mc) mc (%car mc)))
2310         (options (if (atom mc) '() (%cdr mc)))
2311         (order (car options))
2312         (primaries '())
2313         (arounds '())
2314         around
2315         emf-form
2316         (long-method-combination-p
2317          (typep (get mc-name 'method-combination-object) 'long-method-combination)))
2318    (unless long-method-combination-p
2319      (dolist (m methods)
2320        (let ((qualifiers (method-qualifiers m)))
2321          (cond ((null qualifiers)
2322                 (if (eq mc-name 'standard)
2323                     (push m primaries)
2324                     (error "Method combination type mismatch.")))
2325                ((cdr qualifiers)
2326                 (error "Invalid method qualifiers."))
2327                ((eq (car qualifiers) :around)
2328                 (push m arounds))
2329                ((eq (car qualifiers) mc-name)
2330                 (push m primaries))
2331                ((memq (car qualifiers) '(:before :after)))
2332                (t
2333                 (error "Invalid method qualifiers."))))))
2334    (unless (eq order :most-specific-last)
2335      (setf primaries (nreverse primaries)))
2336    (setf arounds (nreverse arounds))
2337    (setf around (car arounds))
2338    (when (and (null primaries) (not long-method-combination-p))
2339      (error "No primary methods for the generic function ~S." gf))
2340    (cond
2341      (around
2342       (let ((next-emfun
2343              (funcall
2344               (if (eq (class-of gf) +the-standard-generic-function-class+)
2345                   #'std-compute-effective-method
2346                   #'compute-effective-method)
2347               gf (generic-function-method-combination gf)
2348               (remove around methods))))
2349         (setf emf-form
2350               (generate-emf-lambda (std-method-function around) next-emfun))))
2351      ((eq mc-name 'standard)
2352       (let* ((next-emfun (compute-primary-emfun (cdr primaries)))
2353              (befores (remove-if-not #'before-method-p methods))
2354              (reverse-afters
2355               (reverse (remove-if-not #'after-method-p methods))))
2356         (setf emf-form
2357               (cond
2358                 ((and (null befores) (null reverse-afters))
2359                  (let ((fast-function (std-method-fast-function (car primaries))))
2360                    (if fast-function
2361                        (ecase (length (gf-required-args gf))
2362                          (1
2363                           #'(lambda (args)
2364                               (declare (optimize speed))
2365                               (funcall fast-function (car args))))
2366                          (2
2367                           #'(lambda (args)
2368                               (declare (optimize speed))
2369                               (funcall fast-function (car args) (cadr args)))))
2370                        (generate-emf-lambda (std-method-function (car primaries))
2371                                             next-emfun))))
2372                 (t
2373                  (let ((method-function (std-method-function (car primaries))))
2374                    #'(lambda (args)
2375                        (declare (optimize speed))
2376                        (dolist (before befores)
2377                          (funcall (std-method-function before) args nil))
2378                        (multiple-value-prog1
2379                            (funcall method-function args next-emfun)
2380                          (dolist (after reverse-afters)
2381                            (funcall (std-method-function after) args nil))))))))))
2382      (long-method-combination-p
2383       (let* ((mc-obj (get mc-name 'method-combination-object))
2384              (function (long-method-combination-function mc-obj))
2385              (arguments (rest (slot-value gf 'method-combination))))
2386         (assert (typep mc-obj 'long-method-combination))
2387         (assert function)
2388         (setf emf-form
2389               (if arguments
2390                   (apply function gf methods arguments)
2391                   (funcall function gf methods)))))
2392      (t
2393       (let ((mc-obj (get mc-name 'method-combination-object)))
2394         (unless (typep mc-obj 'short-method-combination)
2395           (error "Unsupported method combination type ~A."
2396                  mc-name))
2397         (let* ((operator (short-method-combination-operator mc-obj))
2398                (ioa (short-method-combination-identity-with-one-argument mc-obj)))
2399           (setf emf-form
2400                 (if (and (null (cdr primaries))
2401                          (not (null ioa)))
2402                     (generate-emf-lambda (std-method-function (car primaries)) nil)
2403                     `(lambda (args)
2404                        (,operator ,@(mapcar
2405                                      (lambda (primary)
2406                                        `(funcall ,(std-method-function primary) args nil))
2407                                      primaries)))))))))
2408    (assert (not (null emf-form)))
2409    (or #+nil (ignore-errors (autocompile emf-form))
2410        (coerce-to-function emf-form))))
2411
2412(defun generate-emf-lambda (method-function next-emfun)
2413  #'(lambda (args)
2414      (declare (optimize speed))
2415      (funcall method-function args next-emfun)))
2416
2417;;; compute an effective method function from a list of primary methods:
2418
2419(defun compute-primary-emfun (methods)
2420  (if (null methods)
2421      nil
2422      (let ((next-emfun (compute-primary-emfun (cdr methods))))
2423        #'(lambda (args)
2424           (funcall (std-method-function (car methods)) args next-emfun)))))
2425
2426(defvar *call-next-method-p*)
2427(defvar *next-method-p-p*)
2428
2429(defun walk-form (form)
2430  (cond ((atom form)
2431         (cond ((eq form 'call-next-method)
2432                (setf *call-next-method-p* t))
2433               ((eq form 'next-method-p)
2434                (setf *next-method-p-p* t))))
2435        (t
2436         (walk-form (%car form))
2437         (walk-form (%cdr form)))))
2438
2439(defun compute-method-function (lambda-expression)
2440  (let ((lambda-list (allow-other-keys (cadr lambda-expression)))
2441        (body (cddr lambda-expression))
2442        (*call-next-method-p* nil)
2443        (*next-method-p-p* nil))
2444    (multiple-value-bind (body declarations) (parse-body body)
2445      (let ((ignorable-vars '()))
2446        (dolist (var lambda-list)
2447          (if (memq var lambda-list-keywords)
2448              (return)
2449              (push var ignorable-vars)))
2450        (push `(declare (ignorable ,@ignorable-vars)) declarations))
2451      (walk-form body)
2452      (cond ((or *call-next-method-p* *next-method-p-p*)
2453             `(lambda (args next-emfun)
2454                (flet ((call-next-method (&rest cnm-args)
2455                         (if (null next-emfun)
2456                             (error "No next method for generic function.")
2457                             (funcall next-emfun (or cnm-args args))))
2458                       (next-method-p ()
2459                         (not (null next-emfun))))
2460                  (declare (ignorable (function call-next-method)
2461                                      (function next-method-p)))
2462                  (apply #'(lambda ,lambda-list ,@declarations ,@body) args))))
2463            ((null (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux)))
2464             ;; Required parameters only.
2465             (case (length lambda-list)
2466               (1
2467                `(lambda (args next-emfun)
2468                   (declare (ignore next-emfun))
2469                   (let ((,(%car lambda-list) (%car args)))
2470                     (declare (ignorable ,(%car lambda-list)))
2471                     ,@declarations ,@body)))
2472               (2
2473                `(lambda (args next-emfun)
2474                   (declare (ignore next-emfun))
2475                   (let ((,(%car lambda-list) (%car args))
2476                         (,(%cadr lambda-list) (%cadr args)))
2477                     (declare (ignorable ,(%car lambda-list)
2478                                         ,(%cadr lambda-list)))
2479                     ,@declarations ,@body)))
2480               (3
2481                `(lambda (args next-emfun)
2482                   (declare (ignore next-emfun))
2483                   (let ((,(%car lambda-list) (%car args))
2484                         (,(%cadr lambda-list) (%cadr args))
2485                         (,(%caddr lambda-list) (%caddr args)))
2486                     (declare (ignorable ,(%car lambda-list)
2487                                         ,(%cadr lambda-list)
2488                                         ,(%caddr lambda-list)))
2489                     ,@declarations ,@body)))
2490               (t
2491                `(lambda (args next-emfun)
2492                   (declare (ignore next-emfun))
2493                   (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))
2494            (t
2495             `(lambda (args next-emfun)
2496                (declare (ignore next-emfun))
2497                (apply #'(lambda ,lambda-list ,@declarations ,@body) args)))))))
2498
2499(defun compute-method-fast-function (lambda-expression)
2500  (let ((lambda-list (allow-other-keys (cadr lambda-expression))))
2501    (when (intersection lambda-list '(&rest &optional &key &allow-other-keys &aux))
2502      (return-from compute-method-fast-function nil))
2503    ;; Only required args.
2504    (let ((body (cddr lambda-expression))
2505          (*call-next-method-p* nil)
2506          (*next-method-p-p* nil))
2507      (multiple-value-bind (body declarations) (parse-body body)
2508        (walk-form body)
2509        (when (or *call-next-method-p* *next-method-p-p*)
2510          (return-from compute-method-fast-function nil))
2511        (let ((decls `(declare (ignorable ,@lambda-list))))
2512          (setf lambda-expression
2513                (list* (car lambda-expression)
2514                       (cadr lambda-expression)
2515                       decls
2516                       (cddr lambda-expression))))
2517        (case (length lambda-list)
2518          (1
2519;;            `(lambda (args next-emfun)
2520;;               (let ((,(%car lambda-list) (%car args)))
2521;;                 (declare (ignorable ,(%car lambda-list)))
2522;;                 ,@declarations ,@body)))
2523           lambda-expression)
2524          (2
2525;;            `(lambda (args next-emfun)
2526;;               (let ((,(%car lambda-list) (%car args))
2527;;                     (,(%cadr lambda-list) (%cadr args)))
2528;;                 (declare (ignorable ,(%car lambda-list)
2529;;                                     ,(%cadr lambda-list)))
2530;;                 ,@declarations ,@body)))
2531           lambda-expression)
2532;;           (3
2533;;            `(lambda (args next-emfun)
2534;;               (let ((,(%car lambda-list) (%car args))
2535;;                     (,(%cadr lambda-list) (%cadr args))
2536;;                     (,(%caddr lambda-list) (%caddr args)))
2537;;                 (declare (ignorable ,(%car lambda-list)
2538;;                                     ,(%cadr lambda-list)
2539;;                                     ,(%caddr lambda-list)))
2540;;                 ,@declarations ,@body)))
2541          (t
2542           nil))))))
2543
2544;; From CLHS section 7.6.5:
2545;; "When a generic function or any of its methods mentions &key in a lambda
2546;; list, the specific set of keyword arguments accepted by the generic function
2547;; varies according to the applicable methods. The set of keyword arguments
2548;; accepted by the generic function for a particular call is the union of the
2549;; keyword arguments accepted by all applicable methods and the keyword
2550;; arguments mentioned after &key in the generic function definition, if any."
2551;; Adapted from Sacla.
2552(defun allow-other-keys (lambda-list)
2553  (if (and (member '&key lambda-list)
2554           (not (member '&allow-other-keys lambda-list)))
2555      (let* ((key-end (or (position '&aux lambda-list) (length lambda-list)))
2556             (aux-part (subseq lambda-list key-end)))
2557        `(,@(subseq lambda-list 0 key-end) &allow-other-keys ,@aux-part))
2558      lambda-list))
2559
2560(defmacro defmethod (&rest args)
2561  (multiple-value-bind
2562      (function-name qualifiers lambda-list specializers documentation declarations body)
2563      (parse-defmethod args)
2564    (let* ((specializers-form '())
2565           (lambda-expression `(lambda ,lambda-list ,@declarations ,body))
2566           (method-function (compute-method-function lambda-expression))
2567           (fast-function (compute-method-fast-function lambda-expression))
2568           )
2569      (dolist (specializer specializers)
2570        (cond ((and (consp specializer) (eq (car specializer) 'eql))
2571               (push `(list 'eql ,(cadr specializer)) specializers-form))
2572              (t
2573               (push `',specializer specializers-form))))
2574      (setf specializers-form `(list ,@(nreverse specializers-form)))
2575      `(progn
2576         (ensure-method ',function-name
2577                        :lambda-list ',lambda-list
2578                        :qualifiers ',qualifiers
2579                        :specializers (canonicalize-specializers ,specializers-form)
2580                        ,@(if documentation `(:documentation ,documentation))
2581                        :function (function ,method-function)
2582                        ,@(if fast-function `(:fast-function (function ,fast-function)))
2583                        )))))
2584
2585;;; Reader and writer methods
2586
2587(defun make-instance-standard-accessor-method (method-class
2588                                               &key
2589                                               lambda-list
2590                                               qualifiers
2591                                               specializers
2592                                               documentation
2593                                               function
2594                                               fast-function
2595                                               slot-definition)
2596  (let ((method (std-allocate-instance method-class)))
2597    (setf (method-lambda-list method) lambda-list)
2598    (setf (method-qualifiers method) qualifiers)
2599    (setf (std-slot-value method 'sys::specializers)
2600          (canonicalize-specializers specializers))
2601    (setf (method-documentation method) documentation)
2602    (setf (std-slot-value method 'sys::%generic-function) nil)
2603    (setf (std-slot-value method 'sys::%function) function)
2604    (setf (std-slot-value method 'sys::fast-function) fast-function)
2605    (setf (std-slot-value method 'sys::%slot-definition) slot-definition)
2606    (setf (std-slot-value method 'sys::keywords) nil)
2607    (setf (std-slot-value method 'sys::other-keywords-p) nil)
2608    method))
2609
2610(defun add-reader-method (class function-name slot-definition)
2611  (let* ((slot-name (slot-definition-name slot-definition))
2612         (lambda-expression
2613          (if (eq (class-of class) +the-standard-class+)
2614              `(lambda (object) (std-slot-value object ',slot-name))
2615              `(lambda (object) (slot-value object ',slot-name))))
2616         (method-function (compute-method-function lambda-expression))
2617         (fast-function (compute-method-fast-function lambda-expression))
2618         (method-lambda-list '(object))
2619         (gf (find-generic-function function-name nil))
2620         (initargs `(:lambda-list ,method-lambda-list
2621                     :qualifiers ()
2622                     :specializers (,class)
2623                     :function ,(if (autoloadp 'compile)
2624                                    method-function
2625                                    (autocompile method-function))
2626                     :fast-function ,(if (autoloadp 'compile)
2627                                         fast-function
2628                                         (autocompile fast-function))
2629                     :slot-definition ,slot-definition))
2630         (method-class (if (eq class +the-standard-class+)
2631                           +the-standard-reader-method-class+
2632                           (apply #'reader-method-class class slot-definition
2633                                  initargs))))
2634    ;; required by AMOP pg. 225
2635    (assert (subtypep method-class +the-standard-reader-method-class+))
2636    (if gf
2637        (check-method-lambda-list function-name
2638                                  method-lambda-list
2639                                  (generic-function-lambda-list gf))
2640        (setf gf (ensure-generic-function function-name
2641                                          :lambda-list method-lambda-list)))
2642    (let ((method
2643           (if (eq method-class +the-standard-reader-method-class+)
2644               (apply #'make-instance-standard-accessor-method method-class
2645                      initargs)
2646               (apply #'make-instance method-class
2647                      :generic-function nil ; handled by add-method
2648                      initargs))))
2649      (if (eq (class-of gf) +the-standard-generic-function-class+)
2650          (progn
2651            (std-add-method gf method)
2652            (map-dependents gf
2653                            #'(lambda (dep)
2654                                (update-dependent gf dep 'add-method method))))
2655          (add-method gf method))
2656      method)))
2657
2658(defun add-writer-method (class function-name slot-definition)
2659  (let* ((slot-name (slot-definition-name slot-definition))
2660         (lambda-expression
2661          (if (eq (class-of class) +the-standard-class+)
2662              `(lambda (new-value object)
2663                 (setf (std-slot-value object ',slot-name) new-value))
2664              `(lambda (new-value object)
2665                 (setf (slot-value object ',slot-name) new-value))))
2666         (method-function (compute-method-function lambda-expression))
2667         (fast-function (compute-method-fast-function lambda-expression))
2668         (method-lambda-list '(new-value object))
2669         (gf (find-generic-function function-name nil))
2670         (initargs `(:lambda-list ,method-lambda-list
2671                     :qualifiers ()
2672                     :specializers (,+the-T-class+ ,class)
2673                     :function ,(if (autoloadp 'compile)
2674                                    method-function
2675                                    (autocompile method-function))
2676                     :fast-function ,(if (autoloadp 'compile)
2677                                         fast-function
2678                                         (autocompile fast-function))))
2679         (method-class (if (eq class +the-standard-class+)
2680                           +the-standard-writer-method-class+
2681                           (apply #'writer-method-class class slot-definition
2682                                  initargs))))
2683    ;; required by AMOP pg. 242
2684    (assert (subtypep method-class +the-standard-writer-method-class+))
2685    (if gf
2686        (check-method-lambda-list function-name
2687                                  method-lambda-list
2688                                  (generic-function-lambda-list gf))
2689        (setf gf (ensure-generic-function function-name
2690                                          :lambda-list method-lambda-list)))
2691    (let ((method
2692           (if (eq method-class +the-standard-writer-method-class+)
2693               (apply #'make-instance-standard-accessor-method method-class
2694                      initargs)
2695               (apply #'make-instance method-class
2696                      :generic-function nil ; handled by add-method
2697                      initargs))))
2698      (if (eq (class-of gf) +the-standard-generic-function-class+)
2699          (progn
2700            (std-add-method gf method)
2701            (map-dependents gf
2702                            #'(lambda (dep)
2703                                (update-dependent gf dep 'add-method method))))
2704          (add-method gf method))
2705      method)))
2706
2707(defmacro atomic-defgeneric (function-name &rest rest)
2708  "Macro to define a generic function and 'swap it into place' after
2709it's been fully defined with all its methods.
2710
2711Note: the user should really use the (:method ..) method description
2712way of defining methods; there's not much use in atomically defining
2713generic functions without providing sensible behaviour..."
2714  (let ((temp-sym (gensym)))
2715    `(progn
2716       (defgeneric ,temp-sym ,@rest)
2717       (let ((gf (symbol-function ',temp-sym)))
2718         (setf ,(if (and (consp function-name)
2719                         (eq (car function-name) 'setf))
2720                    `(get ',(second function-name) 'setf-function)
2721                  `(symbol-function ',function-name)) gf)
2722         (%set-generic-function-name gf ',function-name)
2723         gf))))
2724
2725(defmacro redefine-class-forwarder (name slot &optional body-alist)
2726  "Define a generic function on a temporary symbol as an accessor
2727for the slot `slot'. Then, when definition is complete (including
2728allocation of methods), swap the definition in place.
2729
2730`body-alist' can be used to override the default method bodies for given
2731metaclasses.  In substitute method bodies, `class' names the class
2732instance and, for setters, `new-value' the new value."
2733  (let* ((setterp (consp name))
2734         (%name
2735          (intern (concatenate 'string
2736                               "%"
2737                               (if setterp (symbol-name 'set-) "")
2738                               (symbol-name (if setterp (cadr name) name)))
2739                  (find-package "SYS")))
2740         (bodies
2741          (append body-alist
2742                  (if setterp
2743                      `((built-in-class . (,%name new-value class))
2744                        (forward-referenced-class . (,%name new-value class))
2745                        (structure-class . (,%name new-value class))
2746                        (standard-class . (setf (slot-value class ',slot)
2747                                                new-value))
2748                        (funcallable-standard-class . (setf (slot-value class ',slot)
2749                                                            new-value)))
2750                      `((built-in-class . (,%name class))
2751                        (forward-referenced-class . (,%name class))
2752                        (structure-class . (,%name class))
2753                        (standard-class . (slot-value class ',slot))
2754                        (funcallable-standard-class . (slot-value class ',slot)))))))
2755    `(atomic-defgeneric ,name (,@(when setterp (list 'new-value)) class)
2756        ,@(mapcar #'(lambda (class-name)
2757                      `(:method (,@(when setterp (list 'new-value))
2758                                 (class ,class-name))
2759                         ,(cdr (assoc class-name bodies))))
2760                  '(built-in-class forward-referenced-class structure-class
2761                    standard-class funcallable-standard-class)))))
2762
2763
2764(redefine-class-forwarder class-name name)
2765;;; AMOP pg. 230
2766(redefine-class-forwarder (setf class-name) name
2767   ((standard-class . (reinitialize-instance class :name new-value))
2768    (funcallable-standard-class . (reinitialize-instance class :name new-value))))
2769(redefine-class-forwarder class-slots slots)
2770(redefine-class-forwarder (setf class-slots) slots)
2771(redefine-class-forwarder class-direct-slots direct-slots)
2772(redefine-class-forwarder (setf class-direct-slots) direct-slots)
2773(redefine-class-forwarder class-layout layout)
2774(redefine-class-forwarder (setf class-layout) layout)
2775(redefine-class-forwarder class-direct-superclasses direct-superclasses)
2776(redefine-class-forwarder (setf class-direct-superclasses) direct-superclasses)
2777(redefine-class-forwarder class-direct-subclasses direct-subclasses)
2778(redefine-class-forwarder (setf class-direct-subclasses) direct-subclasses)
2779(redefine-class-forwarder class-direct-methods direct-methods)
2780(redefine-class-forwarder (setf class-direct-methods) direct-methods)
2781(redefine-class-forwarder class-precedence-list precedence-list)
2782(redefine-class-forwarder (setf class-precedence-list) precedence-list)
2783(redefine-class-forwarder class-finalized-p finalized-p)
2784(redefine-class-forwarder (setf class-finalized-p) finalized-p)
2785(redefine-class-forwarder class-default-initargs default-initargs)
2786(redefine-class-forwarder (setf class-default-initargs) default-initargs)
2787(redefine-class-forwarder class-direct-default-initargs direct-default-initargs)
2788(redefine-class-forwarder (setf class-direct-default-initargs) direct-default-initargs)
2789
2790;;; Class definition
2791
2792(defun check-duplicate-slots (slots)
2793  (dolist (s1 slots)
2794    (let ((name1 (canonical-slot-name s1)))
2795      (dolist (s2 (cdr (memq s1 slots)))
2796        (when (eq name1 (canonical-slot-name s2))
2797          (error 'program-error "Duplicate slot ~S" name1))))))
2798
2799(defun check-duplicate-default-initargs (initargs)
2800  (let ((names ()))
2801    (do* ((initargs initargs (cddr initargs))
2802          (name (car initargs) (car initargs)))
2803         ((null initargs))
2804      (push name names))
2805    (do* ((names names (cdr names))
2806          (name (car names) (car names)))
2807         ((null names))
2808      (when (memq name (cdr names))
2809        (error 'program-error
2810               :format-control "Duplicate initialization argument name ~S in :DEFAULT-INITARGS."
2811               :format-arguments (list name))))))
2812
2813(defun canonicalize-direct-superclasses (direct-superclasses)
2814  (let ((classes '()))
2815    (dolist (class-specifier direct-superclasses)
2816      (let ((class (if (classp class-specifier)
2817                       class-specifier
2818                       (find-class class-specifier nil))))
2819        (unless class
2820          (setf class (make-instance +the-forward-referenced-class+
2821                                     :name class-specifier))
2822          (setf (find-class class-specifier) class))
2823        (when (and (typep class 'built-in-class)
2824                   (not (member class *extensible-built-in-classes*)))
2825          (error "Attempt to define a subclass of built-in-class ~S."
2826                 class-specifier))
2827        (push class classes)))
2828    (nreverse classes)))
2829
2830(atomic-defgeneric add-direct-subclass (superclass subclass)
2831  (:method ((superclass class) (subclass class))
2832    (setf (class-direct-subclasses superclass)
2833          (adjoin subclass (class-direct-subclasses superclass)))))
2834
2835(atomic-defgeneric remove-direct-subclass (superclass subclass)
2836  (:method ((superclass class) (subclass class))
2837    (setf (class-direct-subclasses superclass)
2838          (remove subclass (class-direct-subclasses superclass)))))
2839
2840 ;;; AMOP pg. 182
2841(defun ensure-class (name &rest all-keys &key &allow-other-keys)
2842  (let ((class (find-class name nil)))
2843    ;; CLHS DEFCLASS: "If a class with the same proper name already
2844    ;; exists [...] the existing class is redefined."  Ansi-tests
2845    ;; CLASS-0309 and CLASS-0310.1 demand this behavior.
2846    (if (and class (eql (class-name class) name))
2847        (apply #'ensure-class-using-class class name all-keys)
2848        (apply #'ensure-class-using-class nil name all-keys))))
2849
2850;;; AMOP pg. 183ff.
2851(defgeneric ensure-class-using-class (class name &key direct-default-initargs
2852                                      direct-slots direct-superclasses
2853                                      metaclass &allow-other-keys))
2854
2855(defmethod ensure-class-using-class :before (class name  &key direct-slots
2856                                             direct-default-initargs 
2857                                             &allow-other-keys)
2858  (check-duplicate-slots direct-slots)
2859  (check-duplicate-default-initargs direct-default-initargs))
2860
2861(defmethod ensure-class-using-class ((class null) name &rest all-keys
2862                                     &key (metaclass +the-standard-class+)
2863                                     direct-superclasses
2864                                     &allow-other-keys)
2865  (setf all-keys (copy-list all-keys))  ; since we modify it
2866  (remf all-keys :metaclass)
2867  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2868  (let ((class (apply (if (eq metaclass +the-standard-class+)
2869                          #'make-instance-standard-class
2870                          #'make-instance)
2871                      metaclass :name name
2872                      :direct-superclasses (canonicalize-direct-superclasses
2873                                            direct-superclasses)
2874                      all-keys)))
2875    (%set-find-class name class)
2876    class))
2877
2878(defmethod ensure-class-using-class ((class built-in-class) name &rest all-keys
2879                                     &key &allow-other-keys)
2880  (declare (ignore all-keys))
2881  (error "The symbol ~S names a built-in class." name))
2882
2883(defmethod ensure-class-using-class ((class forward-referenced-class) name
2884                                     &rest all-keys
2885                                     &key (metaclass +the-standard-class+)
2886                                     direct-superclasses &allow-other-keys)
2887  (setf all-keys (copy-list all-keys))  ; since we modify it
2888  (remf all-keys :metaclass)
2889  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2890  (change-class class metaclass)
2891  (apply #'reinitialize-instance class
2892         :name name
2893         :direct-superclasses (canonicalize-direct-superclasses
2894                               direct-superclasses)
2895         all-keys)
2896  class)
2897
2898(defmethod ensure-class-using-class ((class class) name
2899                                     &key (metaclass +the-standard-class+ metaclassp)
2900                                     direct-superclasses &rest all-keys
2901                                     &allow-other-keys)
2902  (declare (ignore name))
2903  (setf all-keys (copy-list all-keys))  ; since we modify it
2904  (remf all-keys :metaclass)
2905  (unless (classp metaclass) (setf metaclass (find-class metaclass)))
2906  (when (and metaclassp (not (eq (class-of class) metaclass)))
2907    (error 'program-error
2908           "Trying to redefine class ~S with different metaclass."
2909           (class-name class)))
2910  (apply #'reinitialize-instance class
2911         :direct-superclasses (canonicalize-direct-superclasses direct-superclasses)
2912         all-keys)
2913  class)
2914
2915(defun maybe-finalize-class-subtree (class)
2916  (when (every #'class-finalized-p (class-direct-superclasses class))
2917    (finalize-inheritance class)
2918    (dolist (subclass (class-direct-subclasses class))
2919      (maybe-finalize-class-subtree subclass))))
2920
2921(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
2922  (unless (>= (length form) 3)
2923    (error 'program-error "Wrong number of arguments for DEFCLASS."))
2924  (check-declaration-type name)
2925  `(ensure-class ',name
2926                 :direct-superclasses
2927                 (canonicalize-direct-superclasses ',direct-superclasses)
2928                 :direct-slots
2929                 ,(canonicalize-direct-slots direct-slots)
2930                 ,@(canonicalize-defclass-options options)))
2931
2932
2933;;; AMOP pg. 180
2934(defgeneric direct-slot-definition-class (class &rest initargs))
2935
2936(defmethod direct-slot-definition-class ((class class) &rest initargs)
2937  (declare (ignore initargs))
2938  +the-standard-direct-slot-definition-class+)
2939
2940;;; AMOP pg. 181
2941(defgeneric effective-slot-definition-class (class &rest initargs))
2942
2943(defmethod effective-slot-definition-class ((class class) &rest initargs)
2944  (declare (ignore initargs))
2945  +the-standard-effective-slot-definition-class+)
2946
2947;;; AMOP pg. 224
2948(defgeneric reader-method-class (class direct-slot &rest initargs))
2949
2950(defmethod reader-method-class ((class standard-class)
2951                                (direct-slot standard-direct-slot-definition)
2952                                &rest initargs)
2953  (declare (ignore initargs))
2954  +the-standard-reader-method-class+)
2955
2956(defmethod reader-method-class ((class funcallable-standard-class)
2957                                (direct-slot standard-direct-slot-definition)
2958                                &rest initargs)
2959  (declare (ignore initargs))
2960  +the-standard-reader-method-class+)
2961
2962;;; AMOP pg. 242
2963(defgeneric writer-method-class (class direct-slot &rest initargs))
2964
2965(defmethod writer-method-class ((class standard-class)
2966                                (direct-slot standard-direct-slot-definition)
2967                                &rest initargs)
2968  (declare (ignore initargs))
2969  +the-standard-writer-method-class+)
2970
2971(defmethod writer-method-class ((class funcallable-standard-class)
2972                                (direct-slot standard-direct-slot-definition)
2973                                &rest initargs)
2974  (declare (ignore initargs))
2975  +the-standard-writer-method-class+)
2976
2977(atomic-defgeneric documentation (x doc-type)
2978    (:method ((x symbol) doc-type)
2979        (%documentation x doc-type))
2980    (:method ((x function) doc-type)
2981        (%documentation x doc-type)))
2982
2983(atomic-defgeneric (setf documentation) (new-value x doc-type)
2984    (:method (new-value (x symbol) doc-type)
2985        (%set-documentation x doc-type new-value))
2986    (:method (new-value (x function) doc-type)
2987        (%set-documentation x doc-type new-value)))
2988
2989
2990;; FIXME This should be a weak hashtable!
2991(defvar *list-documentation-hashtable* (make-hash-table :test #'equal))
2992
2993(defmethod documentation ((x list) (doc-type (eql 'function)))
2994  (let ((alist (gethash x *list-documentation-hashtable*)))
2995    (and alist (cdr (assoc doc-type alist)))))
2996
2997(defmethod documentation ((x list) (doc-type (eql 'compiler-macro)))
2998  (let ((alist (gethash x *list-documentation-hashtable*)))
2999    (and alist (cdr (assoc doc-type alist)))))
3000
3001(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'function)))
3002  (let* ((alist (gethash x *list-documentation-hashtable*))
3003         (entry (and alist (assoc doc-type alist))))
3004    (cond (entry
3005           (setf (cdr entry) new-value))
3006          (t
3007           (setf (gethash x *list-documentation-hashtable*)
3008                 (push (cons doc-type new-value) alist)))))
3009  new-value)
3010
3011(defmethod (setf documentation) (new-value (x list) (doc-type (eql 'compiler-macro)))
3012  (let* ((alist (gethash x *list-documentation-hashtable*))
3013         (entry (and alist (assoc doc-type alist))))
3014    (cond (entry
3015           (setf (cdr entry) new-value))
3016          (t
3017           (setf (gethash x *list-documentation-hashtable*)
3018                 (push (cons doc-type new-value) alist)))))
3019  new-value)
3020
3021(defmethod documentation ((x class) (doc-type (eql 't)))
3022  (class-documentation x))
3023
3024(defmethod documentation ((x class) (doc-type (eql 'type)))
3025  (class-documentation x))
3026
3027(defmethod (setf documentation) (new-value (x class) (doc-type (eql 't)))
3028  (%set-class-documentation x new-value))
3029
3030(defmethod (setf documentation) (new-value (x class) (doc-type (eql 'type)))
3031  (%set-class-documentation x new-value))
3032
3033(defmethod documentation ((x structure-class) (doc-type (eql 't)))
3034  (%documentation x doc-type))
3035
3036(defmethod documentation ((x structure-class) (doc-type (eql 'type)))
3037  (%documentation x doc-type))
3038
3039(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 't)))
3040  (%set-documentation x doc-type new-value))
3041
3042(defmethod (setf documentation) (new-value (x structure-class) (doc-type (eql 'type)))
3043  (%set-documentation x doc-type new-value))
3044
3045(defmethod documentation ((x standard-generic-function) (doc-type (eql 't)))
3046  (generic-function-documentation x))
3047
3048(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 't)))
3049  (setf (generic-function-documentation x) new-value))
3050
3051(defmethod documentation ((x standard-generic-function) (doc-type (eql 'function)))
3052  (generic-function-documentation x))
3053
3054(defmethod (setf documentation) (new-value (x standard-generic-function) (doc-type (eql 'function)))
3055  (setf (generic-function-documentation x) new-value))
3056
3057(defmethod documentation ((x standard-method) (doc-type (eql 't)))
3058  (method-documentation x))
3059
3060(defmethod (setf documentation) (new-value (x standard-method) (doc-type (eql 't)))
3061  (setf (method-documentation x) new-value))
3062
3063(defmethod documentation ((x standard-slot-definition) (doc-type (eql 't)))
3064  (slot-definition-documentation x))
3065
3066(defmethod (setf documentation) (new-value (x standard-slot-definition) (doc-type (eql 't)))
3067  (setf (slot-definition-documentation x) new-value))
3068
3069(defmethod documentation ((x package) (doc-type (eql 't)))
3070  (%documentation x doc-type))
3071
3072(defmethod (setf documentation) (new-value (x package) (doc-type (eql 't)))
3073  (%set-documentation x doc-type new-value))
3074
3075(defmethod documentation ((x symbol) (doc-type (eql 'function)))
3076  (%documentation x doc-type))
3077
3078;;; Applicable methods
3079
3080(defgeneric compute-applicable-methods (gf args)
3081  (:method ((gf standard-generic-function) args)
3082    (%compute-applicable-methods gf args)))
3083
3084(defgeneric compute-applicable-methods-using-classes (gf classes)
3085  (:method ((gf standard-generic-function) classes)
3086    (let ((methods '()))
3087      (dolist (method (generic-function-methods gf))
3088  (multiple-value-bind (applicable knownp)
3089      (method-applicable-using-classes-p method classes)
3090    (cond (applicable
3091     (push method methods))
3092    ((not knownp)
3093     (return-from compute-applicable-methods-using-classes
3094       (values nil nil))))))
3095      (values (sort-methods methods gf classes)
3096        t))))
3097
3098
3099;;; Slot access
3100;;;
3101;;; See AMOP pg. 156ff. for an overview.
3102;;;
3103;;; AMOP specifies these generic functions to dispatch on slot objects
3104;;; (with the exception of slot-exists-p-using-class), although its
3105;;; sample implementation Closette dispatches on slot names.  We let
3106;;; slot-value and friends call their gf counterparts with the effective
3107;;; slot definition, but leave the definitions dispatching on slot name
3108;;; in place for user convenience.
3109
3110;;; AMOP pg. 235
3111(defgeneric slot-value-using-class (class instance slot))
3112
3113(defmethod slot-value-using-class ((class standard-class) instance (slot symbol))
3114  (std-slot-value instance slot))
3115(defmethod slot-value-using-class ((class standard-class) instance
3116                                   (slot standard-effective-slot-definition))
3117  (let* ((location (slot-definition-location slot))
3118         (value (if (consp location)
3119                    (cdr location)      ; :allocation :class
3120                    (standard-instance-access instance location))))
3121    (if (eq value +slot-unbound+)
3122        (slot-unbound class instance (slot-definition-name slot))
3123        value)))
3124
3125(defmethod slot-value-using-class ((class funcallable-standard-class)
3126                                   instance (slot symbol))
3127  (std-slot-value instance slot))
3128(defmethod slot-value-using-class ((class funcallable-standard-class) instance
3129                                   (slot standard-effective-slot-definition))
3130  (let* ((location (slot-definition-location slot))
3131         (value (if (consp location)
3132                    (cdr location)      ; :allocation :class
3133                    (funcallable-standard-instance-access instance location))))
3134    (if (eq value +slot-unbound+)
3135        (slot-unbound class instance (slot-definition-name slot))
3136        value)))
3137
3138(defmethod slot-value-using-class ((class structure-class) instance
3139                                   (slot symbol))
3140  (std-slot-value instance slot))
3141(defmethod slot-value-using-class ((class structure-class) instance
3142                                   (slot standard-effective-slot-definition))
3143  (std-slot-value instance (slot-definition-name slot)))
3144
3145;;; AMOP pg. 231
3146(defgeneric (setf slot-value-using-class) (new-value class instance slot))
3147
3148(defmethod (setf slot-value-using-class) (new-value
3149                                          (class standard-class)
3150                                          instance
3151                                          (slot symbol))
3152  (setf (std-slot-value instance slot) new-value))
3153(defmethod (setf slot-value-using-class) (new-value
3154                                          (class standard-class)
3155                                          instance
3156                                          (slot standard-effective-slot-definition))
3157  (let ((location (slot-definition-location slot)))
3158    (if (consp location)                ; :allocation :class
3159        (setf (cdr location) new-value)
3160        (setf (standard-instance-access instance location) new-value))))
3161
3162(defmethod (setf slot-value-using-class) (new-value
3163                                          (class funcallable-standard-class)
3164                                          instance
3165                                          (slot symbol))
3166  (setf (std-slot-value instance slot) new-value))
3167(defmethod (setf slot-value-using-class) (new-value
3168                                          (class funcallable-standard-class)
3169                                          instance
3170                                          (slot standard-effective-slot-definition))
3171  (let ((location (slot-definition-location slot)))
3172    (if (consp location)                ; :allocation :class
3173        (setf (cdr location) new-value)
3174        (setf (funcallable-standard-instance-access instance location)
3175              new-value))))
3176
3177(defmethod (setf slot-value-using-class) (new-value
3178                                          (class structure-class)
3179                                          instance
3180                                          (slot symbol))
3181  (setf (std-slot-value instance slot) new-value))
3182(defmethod (setf slot-value-using-class) (new-value
3183                                          (class structure-class)
3184                                          instance
3185                                          (slot standard-effective-slot-definition))
3186  (setf (std-slot-value instance (slot-definition-name slot)) new-value))
3187
3188;;; slot-exists-p-using-class is not specified by AMOP, and obviously
3189;;; cannot be specialized on the slot type.  Hence, its implementation
3190;;; differs from slot-(boundp|makunbound|value)-using-class
3191(defgeneric slot-exists-p-using-class (class instance slot-name))
3192
3193(defmethod slot-exists-p-using-class (class instance slot-name)
3194  nil)
3195
3196(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
3197  (std-slot-exists-p instance slot-name))
3198(defmethod slot-exists-p-using-class ((class funcallable-standard-class) instance slot-name)
3199  (std-slot-exists-p instance slot-name))
3200
3201(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
3202  (dolist (dsd (class-slots class))
3203    (when (eq (sys::dsd-name dsd) slot-name)
3204      (return-from slot-exists-p-using-class t)))
3205  nil)
3206
3207
3208(defgeneric slot-boundp-using-class (class instance slot))
3209(defmethod slot-boundp-using-class ((class standard-class) instance (slot symbol))
3210  (std-slot-boundp instance slot))
3211(defmethod slot-boundp-using-class ((class standard-class) instance
3212                                    (slot standard-effective-slot-definition))
3213  (let ((location (slot-definition-location slot)))
3214    (if (consp location)
3215        (eq (cdr location) +slot-unbound+) ; :allocation :class
3216        (eq (standard-instance-access instance location) +slot-unbound+))))
3217
3218(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3219                                    (slot symbol))
3220  (std-slot-boundp instance slot))
3221(defmethod slot-boundp-using-class ((class funcallable-standard-class) instance
3222                                    (slot standard-effective-slot-definition))
3223  (let ((location (slot-definition-location slot)))
3224    (if (consp location)
3225        (eq (cdr location) +slot-unbound+) ; :allocation :class
3226        (eq (funcallable-standard-instance-access instance location)
3227            +slot-unbound+))))
3228
3229(defmethod slot-boundp-using-class ((class structure-class) instance slot)
3230  "Structure slots can't be unbound, so this method always returns T."
3231  (declare (ignore class instance slot))
3232  t)
3233
3234(defgeneric slot-makunbound-using-class (class instance slot))
3235(defmethod slot-makunbound-using-class ((class standard-class)
3236                                        instance
3237                                        (slot symbol))
3238  (std-slot-makunbound instance slot))
3239(defmethod slot-makunbound-using-class ((class standard-class)
3240                                        instance
3241                                        (slot standard-effective-slot-definition))
3242  (let ((location (slot-definition-location slot)))
3243    (if (consp location)
3244        (setf (cdr location) +slot-unbound+)
3245        (setf (standard-instance-access instance location) +slot-unbound+))))
3246
3247(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3248                                        instance
3249                                        (slot symbol))
3250  (std-slot-makunbound instance slot))
3251(defmethod slot-makunbound-using-class ((class funcallable-standard-class)
3252                                        instance
3253                                        (slot symbol))
3254  (let ((location (slot-definition-location slot)))
3255    (if (consp location)
3256        (setf (cdr location) +slot-unbound+)
3257        (setf (funcallable-standard-instance-access instance location)
3258              +slot-unbound+))))
3259
3260(defmethod slot-makunbound-using-class ((class structure-class)
3261                                        instance
3262                                        slot)
3263  (declare (ignore class instance slot))
3264  (error "Structure slots can't be unbound"))
3265
3266(defgeneric slot-missing (class instance slot-name operation &optional new-value))
3267
3268(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
3269  (declare (ignore new-value))
3270  (error "The slot ~S is missing from the class ~S." slot-name class))
3271
3272(defgeneric slot-unbound (class instance slot-name))
3273
3274(defmethod slot-unbound ((class t) instance slot-name)
3275  (error 'unbound-slot :instance instance :name slot-name))
3276
3277;;; Instance creation and initialization
3278
3279;;; AMOP pg. 168ff.  Checking whether the class is finalized is done
3280;;; inside std-allocate-instance and allocate-funcallable-instance.
3281(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
3282
3283(defmethod allocate-instance ((class standard-class) &rest initargs)
3284  (declare (ignore initargs))
3285  (std-allocate-instance class))
3286
3287(defmethod allocate-instance ((class funcallable-standard-class) &rest initargs)
3288  (declare (ignore initargs))
3289  (allocate-funcallable-instance class))
3290
3291(defmethod allocate-instance ((class structure-class) &rest initargs)
3292  (declare (ignore initargs))
3293  (%make-structure (class-name class)
3294                   (make-list (length (class-slots class))
3295                              :initial-element +slot-unbound+)))
3296
3297(defmethod allocate-instance ((class built-in-class) &rest initargs)
3298  (declare (ignore initargs))
3299  (error "Cannot allocate instances of a built-in class: ~S" class))
3300
3301;; "The set of valid initialization arguments for a class is the set of valid
3302;; initialization arguments that either fill slots or supply arguments to
3303;; methods, along with the predefined initialization argument :ALLOW-OTHER-KEYS."
3304;; 7.1.2
3305
3306(defun calculate-allowable-initargs (gf-list args instance
3307                                             shared-initialize-param
3308                                             initargs)
3309  (let* ((methods
3310          (nconc
3311             (compute-applicable-methods #'shared-initialize
3312                                         (list* instance
3313                                                shared-initialize-param
3314                                                initargs))
3315             (mapcan #'(lambda (gf)
3316                         (compute-applicable-methods gf args))
3317                     gf-list)))
3318         (method-keyword-args
3319          (reduce #'merge-initargs-sets
3320                  (mapcar #'method-lambda-list methods)
3321                  :key #'extract-lambda-list-keywords
3322                  :initial-value nil))
3323         (slots-initargs
3324          (mapappend #'slot-definition-initargs
3325                     (class-slots (class-of instance)))))
3326    (merge-initargs-sets
3327     (merge-initargs-sets slots-initargs method-keyword-args)
3328     '(:allow-other-keys))))  ;; allow-other-keys is always allowed
3329
3330(defun check-initargs (gf-list args instance
3331                       shared-initialize-param initargs
3332                       cache call-site)
3333  "Checks the validity of `initargs' for the generic functions in `gf-list'
3334when called with `args' by calculating the applicable methods for each gf.
3335The applicable methods for SHARED-INITIALIZE based on `instance',
3336`shared-initialize-param' and `initargs' are added to the list of
3337applicable methods."
3338  (when (oddp (length initargs))
3339    (error 'program-error
3340           :format-control "Odd number of keyword arguments."))
3341  (unless (getf initargs :allow-other-keys)
3342    (multiple-value-bind (allowable-initargs present-p)
3343                         (when cache
3344                           (gethash (class-of instance) cache))
3345       (unless present-p
3346         (setf allowable-initargs
3347               (calculate-allowable-initargs gf-list args instance
3348                                             shared-initialize-param initargs))
3349         (when cache
3350           (setf (gethash (class-of instance) cache)
3351                 allowable-initargs)))
3352       (unless (eq t allowable-initargs)
3353         (do* ((tail initargs (cddr tail))
3354               (initarg (car tail) (car tail)))
3355              ((null tail))
3356              (unless (memq initarg allowable-initargs)
3357                (error 'program-error
3358                       :format-control "Invalid initarg ~S in call to ~S with arglist ~S."
3359                       :format-arguments (list initarg call-site args))))))))
3360
3361(defun merge-initargs-sets (list1 list2)
3362  (cond
3363   ((eq list1 t)  t)
3364   ((eq list2 t)  t)
3365   (t             (union list1 list2))))
3366
3367(defun extract-lambda-list-keywords (lambda-list)
3368  "Returns a list of keywords acceptable as keyword arguments,
3369or T when any keyword is acceptable due to presence of
3370&allow-other-keys."
3371  (when (member '&allow-other-keys lambda-list)
3372    (return-from extract-lambda-list-keywords t))
3373  (loop with keyword-args = (cdr (memq '&key lambda-list))
3374        for key in keyword-args
3375        when (eq key '&aux) do (loop-finish)
3376        when (eq key '&allow-other-keys) do (return t)
3377        when (listp key) do (setq key (car key))
3378        collect (if (symbolp key)
3379                    (make-keyword key)
3380                  (car key))))
3381
3382
3383(defgeneric make-instance (class &rest initargs &key &allow-other-keys))
3384
3385(defmethod make-instance :before ((class class) &rest initargs)
3386  (when (oddp (length initargs))
3387    (error 'program-error :format-control "Odd number of keyword arguments."))
3388  (unless (class-finalized-p class)
3389    (finalize-inheritance class)))
3390
3391(defun augment-initargs-with-defaults (class initargs)
3392  (let ((default-initargs '()))
3393    (dolist (initarg (class-default-initargs class))
3394      (let ((key (first initarg))
3395            (fn (third initarg)))
3396        (when (eq (getf initargs key +slot-unbound+) +slot-unbound+)
3397          (push key default-initargs)
3398          (push (funcall fn) default-initargs))))
3399    (append initargs (nreverse default-initargs))))
3400
3401(defmethod make-instance ((class standard-class) &rest initargs)
3402  (setf initargs (augment-initargs-with-defaults class initargs))
3403  (let ((instance (std-allocate-instance class)))
3404    (check-initargs (list #'allocate-instance #'initialize-instance)
3405                    (list* instance initargs)
3406                    instance t initargs
3407                    *make-instance-initargs-cache* 'make-instance)
3408    (apply #'initialize-instance instance initargs)
3409    instance))
3410
3411(defmethod make-instance ((class funcallable-standard-class) &rest initargs)
3412  (setf initargs (augment-initargs-with-defaults class initargs))
3413  (let ((instance (allocate-funcallable-instance class)))
3414    (check-initargs (list #'allocate-instance #'initialize-instance)
3415                    (list* instance initargs)
3416                    instance t initargs
3417                    *make-instance-initargs-cache* 'make-instance)
3418    (apply #'initialize-instance instance initargs)
3419    instance))
3420
3421(defmethod make-instance ((class symbol) &rest initargs)
3422  (apply #'make-instance (find-class class) initargs))
3423
3424(defgeneric initialize-instance (instance &rest initargs
3425                                          &key &allow-other-keys))
3426
3427(defmethod initialize-instance ((instance standard-object) &rest initargs)
3428  (apply #'shared-initialize instance t initargs))
3429
3430(defgeneric reinitialize-instance (instance &rest initargs
3431                                            &key &allow-other-keys))
3432
3433;; "The system-supplied primary method for REINITIALIZE-INSTANCE checks the
3434;; validity of initargs and signals an error if an initarg is supplied that is
3435;; not declared as valid. The method then calls the generic function SHARED-
3436;; INITIALIZE with the following arguments: the instance, nil (which means no
3437;; slots should be initialized according to their initforms), and the initargs
3438;; it received."
3439(defmethod reinitialize-instance ((instance standard-object) &rest initargs)
3440  (check-initargs (list #'reinitialize-instance) (list* instance initargs)
3441                  instance () initargs
3442                  *reinitialize-instance-initargs-cache* 'reinitialize-instance)
3443  (apply #'shared-initialize instance () initargs))
3444
3445(defun std-shared-initialize (instance slot-names all-keys)
3446  (when (oddp (length all-keys))
3447    (error 'program-error :format-control "Odd number of keyword arguments."))
3448  ;; do a quick scan of the arguments list to see if it's a real
3449  ;; 'initialization argument list' (which is not the same as
3450  ;; checking initarg validity
3451  (do* ((tail all-keys (cddr tail))
3452        (initarg (car tail) (car tail)))
3453      ((null tail))
3454    (unless (symbolp initarg)
3455      (error 'program-error
3456             :format-control "Initarg ~S not a symbol."
3457             :format-arguments (list initarg))))
3458  (dolist (slot (class-slots (class-of instance)))
3459    (let ((slot-name (slot-definition-name slot)))
3460      (multiple-value-bind (init-key init-value foundp)
3461          (get-properties all-keys (slot-definition-initargs slot))
3462        (if foundp
3463            (setf (std-slot-value instance slot-name) init-value)
3464            (unless (std-slot-boundp instance slot-name)
3465              (let ((initfunction (slot-definition-initfunction slot)))
3466                (when (and initfunction (or (eq slot-names t)
3467                                            (memq slot-name slot-names)))
3468                  (setf (std-slot-value instance slot-name)
3469                        (funcall initfunction)))))))))
3470  instance)
3471
3472(defgeneric shared-initialize (instance slot-names
3473                                        &rest initargs
3474                                        &key &allow-other-keys))
3475
3476(defmethod shared-initialize ((instance standard-object) slot-names
3477                              &rest initargs)
3478  (std-shared-initialize instance slot-names initargs))
3479
3480(defmethod shared-initialize :after ((instance standard-class) slot-names
3481                                     &key direct-superclasses
3482                                     direct-slots direct-default-initargs
3483                                     &allow-other-keys)
3484  (std-after-initialization-for-classes
3485   instance :direct-superclasses direct-superclasses
3486   :direct-slots direct-slots
3487   :direct-default-initargs direct-default-initargs))
3488
3489(defmethod shared-initialize :after ((instance funcallable-standard-class)
3490                                     slot-names &key direct-superclasses
3491                                     direct-slots direct-default-initargs
3492                                     &allow-other-keys)
3493  (std-after-initialization-for-classes
3494   instance :direct-superclasses direct-superclasses
3495   :direct-slots direct-slots
3496   :direct-default-initargs direct-default-initargs))
3497
3498(defmethod shared-initialize ((slot slot-definition) slot-names
3499                              &rest args
3500                              &key name initargs initform initfunction
3501                              readers writers allocation
3502                              &allow-other-keys)
3503  ;;Keyword args are duplicated from init-slot-definition only to have
3504  ;;them checked.
3505  (declare (ignore slot-names)) ;;TODO?
3506  (declare (ignore name initargs initform initfunction readers writers allocation))
3507  ;;For built-in slots
3508  (apply #'init-slot-definition slot :allow-other-keys t args)
3509  ;;For user-defined slots
3510  (call-next-method))
3511
3512;;; change-class
3513
3514(defgeneric change-class (instance new-class &key &allow-other-keys))
3515
3516(defmethod change-class ((old-instance standard-object) (new-class standard-class)
3517                         &rest initargs)
3518  (let ((old-slots (class-slots (class-of old-instance)))
3519        (new-slots (class-slots new-class))
3520        (new-instance (allocate-instance new-class)))
3521    ;; "The values of local slots specified by both the class CTO and the class
3522    ;; CFROM are retained. If such a local slot was unbound, it remains
3523    ;; unbound."
3524    (dolist (new-slot new-slots)
3525      (when (instance-slot-p new-slot)
3526        (let* ((slot-name (slot-definition-name new-slot))
3527               (old-slot (find slot-name old-slots :key 'slot-definition-name)))
3528          ;; "The values of slots specified as shared in the class CFROM and as
3529          ;; local in the class CTO are retained."
3530          (when (and old-slot (slot-boundp old-instance slot-name))
3531            (setf (slot-value new-instance slot-name)
3532                  (slot-value old-instance slot-name))))))
3533    (swap-slots old-instance new-instance)
3534    (rotatef (std-instance-layout new-instance)
3535             (std-instance-layout old-instance))
3536    (apply #'update-instance-for-different-class
3537           new-instance old-instance initargs)
3538    old-instance))
3539
3540(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
3541  (apply #'change-class instance (find-class new-class) initargs))
3542
3543(defgeneric update-instance-for-different-class (old new
3544                                                     &rest initargs
3545                                                     &key &allow-other-keys))
3546
3547(defmethod update-instance-for-different-class
3548  ((old standard-object) (new standard-object) &rest initargs)
3549  (let ((added-slots
3550         (remove-if #'(lambda (slot-name)
3551                       (slot-exists-p old slot-name))
3552                    (mapcar 'slot-definition-name
3553                            (class-slots (class-of new))))))
3554    (check-initargs (list #'update-instance-for-different-class)
3555                    (list old new initargs)
3556                    new added-slots initargs
3557                    nil 'update-instance-for-different-class)
3558    (apply #'shared-initialize new added-slots initargs)))
3559
3560;;; make-instances-obsolete
3561
3562(defgeneric make-instances-obsolete (class))
3563
3564(defmethod make-instances-obsolete ((class standard-class))
3565  (%make-instances-obsolete class))
3566(defmethod make-instances-obsolete ((class funcallable-standard-class))
3567  (%make-instances-obsolete class))
3568(defmethod make-instances-obsolete ((class symbol))
3569  (make-instances-obsolete (find-class class))
3570  class)
3571
3572;;; update-instance-for-redefined-class
3573
3574(defgeneric update-instance-for-redefined-class (instance
3575                                                 added-slots
3576                                                 discarded-slots
3577                                                 property-list
3578                                                 &rest initargs
3579                                                 &key
3580                                                 &allow-other-keys))
3581
3582(defmethod update-instance-for-redefined-class ((instance standard-object)
3583            added-slots
3584            discarded-slots
3585            property-list
3586            &rest initargs)
3587  (check-initargs (list #'update-instance-for-redefined-class)
3588                  (list* instance added-slots discarded-slots
3589                         property-list initargs)
3590                  instance added-slots initargs
3591                  nil 'update-instance-for-redefined-class)
3592  (apply #'shared-initialize instance added-slots initargs))
3593
3594;;;  Methods having to do with class metaobjects.
3595
3596(defmethod initialize-instance :after ((class standard-class) &rest args)
3597  (apply #'std-after-initialization-for-classes class args))
3598
3599(defmethod initialize-instance :after ((class funcallable-standard-class)
3600                                       &rest args)
3601  (apply #'std-after-initialization-for-classes class args))
3602
3603(defmethod reinitialize-instance :after ((class standard-class) &rest all-keys)
3604  (remhash class *make-instance-initargs-cache*)
3605  (remhash class *reinitialize-instance-initargs-cache*)
3606  (%make-instances-obsolete class)
3607  (setf (class-finalized-p class) nil)
3608  (check-initargs (list #'allocate-instance
3609                        #'initialize-instance)
3610                  (list* class all-keys)
3611                  class t all-keys
3612                  nil 'reinitialize-instance)
3613  (apply #'std-after-initialization-for-classes class all-keys)
3614  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3615
3616(defmethod reinitialize-instance :after ((class funcallable-standard-class)
3617                                         &rest all-keys)
3618  (remhash class *make-instance-initargs-cache*)
3619  (remhash class *reinitialize-instance-initargs-cache*)
3620  (%make-instances-obsolete class)
3621  (setf (class-finalized-p class) nil)
3622  (check-initargs (list #'allocate-instance
3623                        #'initialize-instance)
3624                  (list* class all-keys)
3625                  class t all-keys
3626                  nil 'reinitialize-instance)
3627  (apply #'std-after-initialization-for-classes class all-keys)
3628  (map-dependents class #'(lambda (dep) (update-dependent class dep all-keys))))
3629
3630(defmethod reinitialize-instance :after ((gf standard-generic-function)
3631                                         &rest all-keys)
3632  (map-dependents gf #'(lambda (dep) (update-dependent gf dep all-keys))))
3633
3634;;; Finalize inheritance
3635
3636(atomic-defgeneric finalize-inheritance (class)
3637    (:method ((class standard-class))
3638       (std-finalize-inheritance class))
3639    (:method ((class funcallable-standard-class))
3640       (std-finalize-inheritance class)))
3641
3642;;; Default initargs
3643
3644;;; AMOP pg. 174
3645(atomic-defgeneric compute-default-initargs (class)
3646  (:method ((class standard-class))
3647    (std-compute-default-initargs class))
3648  (:method ((class funcallable-standard-class))
3649    (std-compute-default-initargs class)))
3650
3651;;; Class precedence lists
3652
3653(defgeneric compute-class-precedence-list (class))
3654(defmethod compute-class-precedence-list ((class standard-class))
3655  (std-compute-class-precedence-list class))
3656(defmethod compute-class-precedence-list ((class funcallable-standard-class))
3657  (std-compute-class-precedence-list class))
3658
3659;;; Slot inheritance
3660
3661(defgeneric compute-slots (class))
3662(defmethod compute-slots ((class standard-class))
3663  (std-compute-slots class))
3664(defmethod compute-slots ((class funcallable-standard-class))
3665  (std-compute-slots class))
3666
3667(defgeneric compute-effective-slot-definition (class name direct-slots))
3668(defmethod compute-effective-slot-definition
3669  ((class standard-class) name direct-slots)
3670  (std-compute-effective-slot-definition class name direct-slots))
3671(defmethod compute-effective-slot-definition
3672  ((class funcallable-standard-class) name direct-slots)
3673  (std-compute-effective-slot-definition class name direct-slots))
3674;;; Methods having to do with generic function metaobjects.
3675
3676(defmethod initialize-instance :after ((gf standard-generic-function) &key)
3677  (finalize-standard-generic-function gf))
3678
3679;;; Methods having to do with generic function invocation.
3680
3681(defgeneric compute-discriminating-function (gf))
3682(defmethod compute-discriminating-function ((gf standard-generic-function))
3683  (std-compute-discriminating-function gf))
3684
3685(defgeneric method-more-specific-p (gf method1 method2 required-classes))
3686
3687(defmethod method-more-specific-p ((gf standard-generic-function)
3688                                   method1 method2 required-classes)
3689  (let ((method-indices
3690         (argument-precedence-order-indices
3691          (generic-function-argument-precedence-order gf)
3692          (getf (analyze-lambda-list (generic-function-lambda-list gf))
3693                ':required-args))))
3694    (std-method-more-specific-p method1 method2 required-classes method-indices)))
3695
3696;;; AMOP pg. 176
3697(defgeneric compute-effective-method (gf method-combination methods))
3698(defmethod compute-effective-method ((gf standard-generic-function) method-combination methods)
3699  (std-compute-effective-method gf method-combination methods))
3700
3701(defgeneric compute-applicable-methods (gf args))
3702(defmethod compute-applicable-methods ((gf standard-generic-function) args)
3703  (%compute-applicable-methods gf args))
3704
3705;;; Slot definition accessors
3706
3707(defmacro slot-definition-dispatch (slot-definition std-form generic-form)
3708  `(let (($cl (class-of ,slot-definition)))
3709     (case $cl
3710       ((+the-standard-slot-definition-class+
3711         +the-standard-direct-slot-definition-class+
3712         +the-standard-effective-slot-definition-class+)
3713        ,std-form)
3714       (t ,generic-form))))
3715
3716(atomic-defgeneric slot-definition-allocation (slot-definition)
3717  (:method ((slot-definition slot-definition))
3718    (slot-definition-dispatch slot-definition
3719      (%slot-definition-allocation slot-definition)
3720      (slot-value slot-definition 'sys::allocation))))
3721
3722(atomic-defgeneric (setf slot-definition-allocation) (value slot-definition)
3723  (:method (value (slot-definition slot-definition))
3724    (slot-definition-dispatch slot-definition
3725      (set-slot-definition-allocation slot-definition value)
3726      (setf (slot-value slot-definition 'sys::allocation) value))))
3727
3728(atomic-defgeneric slot-definition-initargs (slot-definition)
3729  (:method ((slot-definition slot-definition))
3730    (slot-definition-dispatch slot-definition
3731      (%slot-definition-initargs slot-definition)
3732      (slot-value slot-definition 'sys::initargs))))
3733
3734(atomic-defgeneric slot-definition-initform (slot-definition)
3735  (:method ((slot-definition slot-definition))
3736    (slot-definition-dispatch slot-definition
3737      (%slot-definition-initform slot-definition)
3738      (slot-value slot-definition 'sys::initform))))
3739
3740(atomic-defgeneric (setf slot-definition-initform) (value slot-definition)
3741  (:method (value (slot-definition slot-definition))
3742    (slot-definition-dispatch slot-definition
3743      (set-slot-definition-initform slot-definition value)
3744      (setf (slot-value slot-definition 'sys::initform) value))))
3745
3746(atomic-defgeneric slot-definition-initfunction (slot-definition)
3747  (:method ((slot-definition slot-definition))
3748    (slot-definition-dispatch slot-definition
3749      (%slot-definition-initfunction slot-definition)
3750      (slot-value slot-definition 'sys::initfunction))))
3751
3752(atomic-defgeneric (setf slot-definition-initfunction) (value slot-definition)
3753  (:method (value (slot-definition slot-definition))
3754    (slot-definition-dispatch slot-definition
3755      (set-slot-definition-initfunction slot-definition value)
3756      (setf (slot-value slot-definition 'sys::initfunction) value))))
3757
3758(atomic-defgeneric slot-definition-name (slot-definition)
3759  (:method ((slot-definition slot-definition))
3760    (slot-definition-dispatch slot-definition
3761      (%slot-definition-name slot-definition)
3762      (slot-value slot-definition 'sys::name))))
3763
3764(atomic-defgeneric (setf slot-definition-name) (value slot-definition)
3765  (:method (value (slot-definition slot-definition))
3766    (slot-definition-dispatch slot-definition
3767      (set-slot-definition-name slot-definition value)
3768      (setf (slot-value slot-definition 'sys::name) value))))
3769
3770(atomic-defgeneric slot-definition-readers (slot-definition)
3771  (:method ((slot-definition slot-definition))
3772    (slot-definition-dispatch slot-definition
3773      (%slot-definition-readers slot-definition)
3774      (slot-value slot-definition 'sys::readers))))
3775
3776(atomic-defgeneric (setf slot-definition-readers) (value slot-definition)
3777  (:method (value (slot-definition slot-definition))
3778    (slot-definition-dispatch slot-definition
3779      (set-slot-definition-readers slot-definition value)
3780      (setf (slot-value slot-definition 'sys::readers) value))))
3781
3782(atomic-defgeneric slot-definition-writers (slot-definition)
3783  (:method ((slot-definition slot-definition))
3784    (slot-definition-dispatch slot-definition
3785      (%slot-definition-writers slot-definition)
3786      (slot-value slot-definition 'sys::writers))))
3787
3788(atomic-defgeneric (setf slot-definition-writers) (value slot-definition)
3789  (:method (value (slot-definition slot-definition))
3790    (slot-definition-dispatch slot-definition
3791      (set-slot-definition-writers slot-definition value)
3792      (setf (slot-value slot-definition 'sys::writers) value))))
3793
3794(atomic-defgeneric slot-definition-allocation-class (slot-definition)
3795  (:method ((slot-definition slot-definition))
3796    (slot-definition-dispatch slot-definition
3797      (%slot-definition-allocation-class slot-definition)
3798      (slot-value slot-definition 'sys::allocation-class))))
3799
3800(atomic-defgeneric (setf slot-definition-allocation-class)
3801                       (value slot-definition)
3802  (:method (value (slot-definition slot-definition))
3803    (slot-definition-dispatch slot-definition
3804      (set-slot-definition-allocation-class slot-definition value)
3805      (setf (slot-value slot-definition 'sys::allocation-class) value))))
3806
3807(atomic-defgeneric slot-definition-location (slot-definition)
3808  (:method ((slot-definition slot-definition))
3809    (slot-definition-dispatch slot-definition
3810      (%slot-definition-location slot-definition)
3811      (slot-value slot-definition 'sys::location))))
3812
3813(atomic-defgeneric (setf slot-definition-location) (value slot-definition)
3814  (:method (value (slot-definition slot-definition))
3815    (slot-definition-dispatch slot-definition
3816      (set-slot-definition-location slot-definition value)
3817      (setf (slot-value slot-definition 'sys::location) value))))
3818
3819(atomic-defgeneric slot-definition-type (slot-definition)
3820  (:method ((slot-definition slot-definition))
3821    (slot-definition-dispatch slot-definition
3822      (%slot-definition-type slot-definition)
3823      (slot-value slot-definition 'sys::%type))))
3824
3825(atomic-defgeneric (setf slot-definition-type) (value slot-definition)
3826  (:method (value (slot-definition slot-definition))
3827    (slot-definition-dispatch slot-definition
3828      (set-slot-definition-type slot-definition value)
3829      (setf (slot-value slot-definition 'sys::%type) value))))
3830
3831(atomic-defgeneric slot-definition-documentation (slot-definition)
3832  (:method ((slot-definition slot-definition))
3833    (slot-definition-dispatch slot-definition
3834      (%slot-definition-documentation slot-definition)
3835      (slot-value slot-definition 'sys:%documentation))))
3836
3837(atomic-defgeneric (setf slot-definition-documentation) (value slot-definition)
3838  (:method (value (slot-definition slot-definition))
3839    (slot-definition-dispatch slot-definition
3840      (set-slot-definition-documentation slot-definition value)
3841      (setf (slot-value slot-definition 'sys:%documentation) value))))
3842
3843
3844;;; Conditions.
3845
3846(defmacro define-condition (name (&rest parent-types) (&rest slot-specs) &body options)
3847  (let ((parent-types (or parent-types '(condition)))
3848        (report nil))
3849    (dolist (option options)
3850      (when (eq (car option) :report)
3851        (setf report (cadr option))
3852  (setf options (delete option options :test #'equal))
3853        (return)))
3854    (typecase report
3855      (null
3856       `(progn
3857          (defclass ,name ,parent-types ,slot-specs ,@options)
3858          ',name))
3859      (string
3860       `(progn
3861          (defclass ,name ,parent-types ,slot-specs ,@options)
3862          (defmethod print-object ((condition ,name) stream)
3863            (if *print-escape*
3864                (call-next-method)
3865                (progn (write-string ,report stream) condition)))
3866          ',name))
3867      (t
3868       `(progn
3869          (defclass ,name ,parent-types ,slot-specs ,@options)
3870          (defmethod print-object ((condition ,name) stream)
3871            (if *print-escape*
3872                (call-next-method)
3873                (funcall #',report condition stream)))
3874          ',name)))))
3875
3876(defun make-condition (type &rest initargs)
3877  (or (%make-condition type initargs)
3878      (let ((class (if (symbolp type) (find-class type) type)))
3879        (apply #'make-instance class initargs))))
3880
3881;; Adapted from SBCL.
3882;; Originally defined in signal.lisp. Redefined here now that we have MAKE-CONDITION.
3883(defun coerce-to-condition (datum arguments default-type fun-name)
3884  (cond ((typep datum 'condition)
3885         (when arguments
3886           (error 'simple-type-error
3887                  :datum arguments
3888                  :expected-type 'null
3889                  :format-control "You may not supply additional arguments when giving ~S to ~S."
3890                  :format-arguments (list datum fun-name)))
3891         datum)
3892        ((symbolp datum)
3893         (apply #'make-condition datum arguments))
3894        ((or (stringp datum) (functionp datum))
3895         (make-condition default-type
3896                         :format-control datum
3897                         :format-arguments arguments))
3898        (t
3899         (error 'simple-type-error
3900                :datum datum
3901                :expected-type '(or symbol string)
3902                :format-control "Bad argument to ~S: ~S."
3903                :format-arguments (list fun-name datum)))))
3904
3905(defgeneric make-load-form (object &optional environment))
3906
3907(defmethod make-load-form ((object t) &optional environment)
3908  (declare (ignore environment))
3909  (apply #'no-applicable-method #'make-load-form (list object)))
3910
3911(defmethod make-load-form ((class class) &optional environment)
3912  (declare (ignore environment))
3913  (let ((name (class-name class)))
3914    (unless (and name (eq (find-class name nil) class))
3915      (error 'simple-type-error
3916             :format-control "Can't use anonymous or undefined class as a constant: ~S."
3917             :format-arguments (list class)))
3918    `(find-class ',name)))
3919
3920(defun invalid-method-error (method format-control &rest args)
3921  (let ((message (apply #'format nil format-control args)))
3922    (error "Invalid method error for ~S:~%    ~A" method message)))
3923
3924(defun method-combination-error (format-control &rest args)
3925  (let ((message (apply #'format nil format-control args)))
3926    (error "Method combination error in CLOS dispatch:~%    ~A" message)))
3927
3928
3929(atomic-defgeneric no-applicable-method (generic-function &rest args)
3930  (:method (generic-function &rest args)
3931      (error "There is no applicable method for the generic function ~S ~
3932              when called with arguments ~S."
3933             generic-function
3934             args)))
3935
3936
3937;;; FIXME (rudi 2012-01-28): this can be a function, it only needs to
3938;;; use standard accessor functions
3939(defgeneric find-method (generic-function
3940                         qualifiers
3941                         specializers
3942                         &optional errorp))
3943
3944(defmethod find-method ((generic-function standard-generic-function)
3945                        qualifiers specializers &optional (errorp t))
3946  (%find-method generic-function qualifiers specializers errorp))
3947
3948(defgeneric find-method ((generic-function symbol)
3949                         qualifiers specializers &optional (errorp t))
3950  (find-method (find-generic-function generic-function errorp)
3951               qualifiers specializers errorp))
3952
3953(defgeneric add-method (generic-function method))
3954
3955(defmethod add-method ((generic-function standard-generic-function)
3956                       (method method))
3957  (let ((method-lambda-list (method-lambda-list method))
3958        (gf-lambda-list (generic-function-lambda-list generic-function)))
3959    (check-method-lambda-list (%generic-function-name generic-function)
3960                              method-lambda-list gf-lambda-list))
3961  (std-add-method generic-function method))
3962
3963(defmethod add-method :after ((generic-function standard-generic-function)
3964                              (method method))
3965  (map-dependents generic-function
3966                  #'(lambda (dep) (update-dependent generic-function dep
3967                                                    'add-method method))))
3968
3969(defgeneric remove-method (generic-function method))
3970
3971(defmethod remove-method ((generic-function standard-generic-function)
3972                          (method method))
3973  (std-remove-method generic-function method))
3974
3975(defmethod remove-method :after ((generic-function standard-generic-function)
3976                                 (method method))
3977  (map-dependents generic-function
3978                  #'(lambda (dep) (update-dependent generic-function dep
3979                                                    'remove-method method))))
3980
3981;; See describe.lisp.
3982(defgeneric describe-object (object stream))
3983
3984;; FIXME
3985(defgeneric no-next-method (generic-function method &rest args))
3986
3987(atomic-defgeneric function-keywords (method)
3988  (:method ((method standard-method))
3989    (std-function-keywords method)))
3990
3991(setf *gf-initialize-instance* (symbol-function 'initialize-instance))
3992(setf *gf-allocate-instance* (symbol-function 'allocate-instance))
3993(setf *gf-shared-initialize* (symbol-function 'shared-initialize))
3994(setf *gf-reinitialize-instance* (symbol-function 'reinitialize-instance))
3995(setf *clos-booting* nil)
3996
3997(defgeneric class-prototype (class))
3998
3999(defmethod class-prototype :before (class)
4000  (unless (class-finalized-p class)
4001    (error "~@<~S is not finalized.~:@>" class)))
4002
4003(defmethod class-prototype ((class standard-class))
4004  (allocate-instance class))
4005
4006(defmethod class-prototype ((class funcallable-standard-class))
4007  (allocate-instance class))
4008
4009(defmethod class-prototype ((class structure-class))
4010  (allocate-instance class))
4011
4012(defmethod shared-initialize :after ((instance standard-generic-function)
4013                                     slot-names
4014                                     &key lambda-list argument-precedence-order
4015                                     &allow-other-keys)
4016  (let* ((plist (analyze-lambda-list lambda-list))
4017         (required-args (getf plist ':required-args)))
4018    (%set-gf-required-args instance required-args)
4019    (%set-gf-optional-args instance (getf plist :optional-args))
4020    (set-generic-function-argument-precedence-order
4021     instance (or argument-precedence-order required-args)))
4022  (finalize-standard-generic-function instance))
4023
4024;;; Readers for generic function metaobjects
4025;;; See AMOP pg. 216ff.
4026(atomic-defgeneric generic-function-argument-precedence-order (generic-function)
4027  (:method ((generic-function standard-generic-function))
4028    (sys:%generic-function-argument-precedence-order generic-function)))
4029
4030(atomic-defgeneric generic-function-declarations (generic-function)
4031  (:method ((generic-function standard-generic-function))
4032    ;; TODO: add slot to StandardGenericFunctionClass.java, use it
4033    nil))
4034
4035(atomic-defgeneric generic-function-lambda-list (generic-function)
4036  (:method ((generic-function standard-generic-function))
4037    (sys:%generic-function-lambda-list generic-function)))
4038
4039(atomic-defgeneric generic-function-method-class (generic-function)
4040  (:method ((generic-function standard-generic-function))
4041    (sys:%generic-function-method-class generic-function)))
4042
4043(atomic-defgeneric generic-function-method-combination (generic-function)
4044  (:method ((generic-function standard-generic-function))
4045    (sys:%generic-function-method-combination generic-function)))
4046
4047(atomic-defgeneric generic-function-methods (generic-function)
4048  (:method ((generic-function standard-generic-function))
4049    (sys:%generic-function-methods generic-function)))
4050
4051(atomic-defgeneric generic-function-name (generic-function)
4052  (:method ((generic-function standard-generic-function))
4053    (sys:%generic-function-name generic-function)))
4054
4055;;; AMOP pg. 231
4056(defgeneric (setf generic-function-name) (new-value gf)
4057  (:method (new-value (gf generic-function))
4058    (reinitialize-instance gf :name new-value)))
4059
4060;;; Readers for Method Metaobjects
4061;;; AMOP pg. 218ff.
4062
4063(atomic-defgeneric method-function (method)
4064  (:method ((method standard-method))
4065    (std-method-function method)))
4066
4067(atomic-defgeneric method-generic-function (method)
4068  (:method ((method standard-method))
4069    (std-method-generic-function method)))
4070
4071(atomic-defgeneric method-lambda-list (method)
4072  (:method ((method standard-method))
4073    (std-slot-value method 'sys::lambda-list)))
4074
4075(atomic-defgeneric method-specializers (method)
4076  (:method ((method standard-method))
4077    (std-method-specializers method)))
4078
4079(atomic-defgeneric method-qualifiers (method)
4080  (:method ((method standard-method))
4081    (std-method-qualifiers method)))
4082
4083(atomic-defgeneric accessor-method-slot-definition (method)
4084  (:method ((method standard-accessor-method))
4085    (std-accessor-method-slot-definition method)))
4086
4087;;; specializer-direct-method and friends.
4088
4089;;; AMOP pg. 237
4090(defgeneric specializer-direct-generic-functions (specializer))
4091
4092(defmethod specializer-direct-generic-functions ((specializer class))
4093  (delete-duplicates (mapcar #'method-generic-function
4094                             (class-direct-methods specializer))))
4095
4096(defmethod specializer-direct-generic-functions ((specializer eql-specializer))
4097  (delete-duplicates (mapcar #'method-generic-function
4098                             (slot-value specializer 'direct-methods))))
4099
4100;;; AMOP pg. 238
4101(defgeneric specializer-direct-methods (specializer))
4102
4103(defmethod specializer-direct-methods ((specializer class))
4104  (class-direct-methods specializer))
4105
4106(defmethod specializer-direct-methods ((specializer eql-specializer))
4107  (slot-value specializer 'direct-methods))
4108
4109;;; AMOP pg. 165
4110(atomic-defgeneric add-direct-method (specializer method)
4111  (:method ((specializer class) (method method))
4112    (pushnew method (class-direct-methods specializer)))
4113  (:method ((specializer eql-specializer) (method method))
4114    (pushnew method (slot-value specializer 'direct-methods))))
4115
4116
4117;;; AMOP pg. 227
4118(atomic-defgeneric remove-direct-method (specializer method)
4119  (:method ((specializer class) (method method))
4120    (setf (class-direct-methods specializer)
4121          (remove method (class-direct-methods specializer))))
4122  (:method ((specializer eql-specializer) (method method))
4123    (setf (slot-value specializer 'direct-methods)
4124          (remove method (slot-value specializer 'direct-methods)))))
4125
4126;;; The Dependent Maintenance Protocol (AMOP pg. 160ff.)
4127
4128(defvar *dependents* (make-hash-table :test 'eq :weakness :key))
4129
4130;;; AMOP pg. 164
4131(defgeneric add-dependent (metaobject dependent))
4132(defmethod add-dependent ((metaobject standard-class) dependent)
4133  (pushnew dependent (gethash metaobject *dependents* nil)))
4134(defmethod add-dependent ((metaobject funcallable-standard-class) dependent)
4135  (pushnew dependent (gethash metaobject *dependents* nil)))
4136(defmethod add-dependent ((metaobject standard-generic-function) dependent)
4137  (pushnew dependent (gethash metaobject *dependents* nil)))
4138
4139;;; AMOP pg. 225
4140(defgeneric remove-dependent (metaobject dependent))
4141(defmethod remove-dependent ((metaobject standard-class) dependent)
4142  (setf (gethash metaobject *dependents*)
4143        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4144(defmethod remove-dependent ((metaobject funcallable-standard-class) dependent)
4145  (setf (gethash metaobject *dependents*)
4146        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4147(defmethod remove-dependent ((metaobject standard-generic-function) dependent)
4148  (setf (gethash metaobject *dependents*)
4149        (delete dependent (gethash metaobject *dependents* nil) :test #'eq)))
4150
4151;;; AMOP pg. 210
4152(atomic-defgeneric map-dependents (metaobject function)
4153  (:method ((metaobject standard-class) function)
4154    (dolist (dependent (gethash metaobject *dependents* nil))
4155      (funcall function dependent)))
4156  (:method ((metaobject funcallable-standard-class) function)
4157    (dolist (dependent (gethash metaobject *dependents* nil))
4158      (funcall function dependent)))
4159  (:method ((metaobject standard-generic-function) function)
4160    (dolist (dependent (gethash metaobject *dependents* nil))
4161      (funcall function dependent))))
4162
4163;;; AMOP pg. 239
4164(defgeneric update-dependent (metaobject dependent &rest initargs))
4165
4166
4167;;; ensure-generic-function(-using-class), AMOP pg. 185ff.
4168(defgeneric ensure-generic-function-using-class (generic-function function-name
4169                                                 &key
4170                                                   argument-precedence-order
4171                                                   declarations documentation
4172                                                   generic-function-class
4173                                                   lambda-list method-class
4174                                                   method-combination
4175                                                   name
4176                                                 &allow-other-keys))
4177
4178(defmethod ensure-generic-function-using-class ((generic-function generic-function)
4179                                                function-name
4180                                                &rest all-keys
4181                                                &key (generic-function-class +the-standard-generic-function-class+)
4182                                                  lambda-list
4183                                                  argument-precedence-order
4184                                                  (method-class +the-standard-method-class+)
4185                                                  documentation
4186                                                &allow-other-keys)
4187  (setf all-keys (copy-list all-keys))  ; since we modify it
4188  (remf all-keys :generic-function-class)
4189  (unless (classp generic-function-class)
4190    (setf generic-function-class (find-class generic-function-class)))
4191  (unless (classp method-class) (setf method-class (find-class method-class)))
4192  (unless (eq generic-function-class (class-of generic-function))
4193    (error "The class ~S is incompatible with the existing class of ~S."
4194           generic-function-class generic-function))
4195  (unless (or (null (generic-function-methods generic-function))
4196              (lambda-lists-congruent-p lambda-list (generic-function-lambda-list generic-function)))
4197    (error "The lambda list ~S is incompatible with the existing methods of ~S."
4198           lambda-list generic-function))
4199  (unless (or (null (generic-function-methods generic-function))
4200              (eq method-class (generic-function-method-class generic-function)))
4201    (error "The method class ~S is incompatible with the existing methods of ~S."
4202           method-class generic-function))
4203  ;; FIXME (rudi 2012-03-26): should call reinitialize-instance here, as
4204  ;; per AMOP.
4205  (setf (generic-function-lambda-list generic-function) lambda-list)
4206  (setf (generic-function-documentation generic-function) documentation)
4207  (let* ((plist (analyze-lambda-list lambda-list))
4208         (required-args (getf plist ':required-args)))
4209    (%set-gf-required-args generic-function required-args)
4210    (%set-gf-optional-args generic-function (getf plist :optional-args))
4211    (setf (generic-function-argument-precedence-order generic-function)
4212          (or argument-precedence-order required-args))
4213    (finalize-standard-generic-function generic-function))
4214  generic-function)
4215
4216(defmethod ensure-generic-function-using-class ((generic-function null)
4217                                                function-name
4218                                                &rest all-keys
4219                                                &key (generic-function-class +the-standard-generic-function-class+)
4220                                                  (method-class +the-standard-method-class+)
4221                                                  (method-combination 'standard)
4222                                                &allow-other-keys)
4223  (setf all-keys (copy-list all-keys))  ; since we modify it
4224  (remf all-keys :generic-function-class)
4225  (unless (classp generic-function-class)
4226    (setf generic-function-class (find-class generic-function-class)))
4227  (unless (classp method-class) (setf method-class (find-class method-class)))
4228  (when (and (null *clos-booting*) (fboundp function-name))
4229    (if (autoloadp function-name)
4230        (fmakunbound function-name)
4231        (error 'program-error
4232               :format-control "~A already names an ordinary function, macro, or special operator."
4233               :format-arguments (list function-name))))
4234  (apply (if (eq generic-function-class +the-standard-generic-function-class+)
4235             #'make-instance-standard-generic-function
4236             #'make-instance)
4237         generic-function-class
4238         :name function-name
4239         :method-class method-class
4240         :method-combination method-combination
4241         all-keys))
4242
4243(defun ensure-generic-function (function-name &rest all-keys
4244                                &key
4245                                  lambda-list generic-function-class
4246                                  method-class
4247                                  method-combination
4248                                  argument-precedence-order
4249                                  documentation
4250                                &allow-other-keys)
4251  (declare (ignore lambda-list generic-function-class method-class
4252                   method-combination argument-precedence-order documentation))
4253  (apply #'ensure-generic-function-using-class
4254         (find-generic-function function-name nil)
4255         function-name all-keys))
4256
4257;;; SLIME compatibility functions.
4258
4259(defun %method-generic-function (method)
4260  (method-generic-function method))
4261
4262(defun %method-function (method)
4263  (method-function method))
4264
4265(eval-when (:compile-toplevel :load-toplevel :execute)
4266  (require "MOP"))
4267
4268(provide 'clos)
4269
Note: See TracBrowser for help on using the repository browser.