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

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

Implement specializer-method--related protocol.

Add add-direct-method, remove-direct-method, specializer-direct-methods,
specializer-direct-generic-functions

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