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

Last change on this file since 13218 was 13218, checked in by ehuelsmann, 11 years ago

Replace algorithm in EXTRACT-LAMBDA-LIST-KEYWORDS to make a single
iteration through the lambda list.

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