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

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

Follow up to r14058: efficient binding of required vars.
Also:

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