source: trunk/j/src/org/armedbear/lisp/clos.lisp @ 5210

Last change on this file since 5210 was 5210, checked in by piso, 17 years ago

Work in progress.

File size: 62.6 KB
Line 
1;;; clos.lisp
2;;;
3;;; Copyright (C) 2003 Peter Graves
4;;; $Id: clos.lisp,v 1.48 2003-12-19 20:26:53 piso Exp $
5;;;
6;;; This program is free software; you can redistribute it and/or
7;;; modify it under the terms of the GNU General Public License
8;;; as published by the Free Software Foundation; either version 2
9;;; of the License, or (at your option) any later version.
10;;;
11;;; This program is distributed in the hope that it will be useful,
12;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14;;; GNU General Public License for more details.
15;;;
16;;; You should have received a copy of the GNU General Public License
17;;; along with this program; if not, write to the Free Software
18;;; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19
20;;; Adapted from Closette.
21
22;;; Closette Version 1.0 (February 10, 1991)
23;;;
24;;; Copyright (c) 1990, 1991 Xerox Corporation.
25;;; All rights reserved.
26;;;
27;;; Use and copying of this software and preparation of derivative works
28;;; based upon this software are permitted.  Any distribution of this
29;;; software or derivative works must comply with all applicable United
30;;; States export control laws.
31;;;
32;;; This software is made available AS IS, and Xerox Corporation makes no
33;;; warranty about the software, its performance or its conformity to any
34;;; specification.
35;;;
36;;; Closette is an implementation of a subset of CLOS with a metaobject
37;;; protocol as described in "The Art of The Metaobject Protocol",
38;;; MIT Press, 1991.
39
40(in-package "SYSTEM")
41
42(defmacro push-on-end (value location)
43  `(setf ,location (nconc ,location (list ,value))))
44
45;;; (SETF GETF*) is like (SETF GETF) except that it always changes the list,
46;;; which must be non-nil.
47
48(defun (setf getf*) (new-value plist key)
49  (block body
50    (do ((x plist (cddr x)))
51        ((null x))
52      (when (eq (car x) key)
53        (setf (car (cdr x)) new-value)
54        (return-from body new-value)))
55    (push-on-end key plist)
56    (push-on-end new-value plist)
57    new-value))
58
59(defun mapappend (fun &rest args)
60  (if (some #'null args)
61      ()
62      (append (apply fun (mapcar #'car args))
63              (apply #'mapappend fun (mapcar #'cdr args)))))
64
65(defun mapplist (fun x)
66  (if (null x)
67      ()
68      (cons (funcall fun (car x) (cadr x))
69            (mapplist fun (cddr x)))))
70
71(defsetf class-name %set-class-name)
72(defsetf class-layout %set-class-layout)
73(defsetf class-direct-superclasses %set-class-direct-superclasses)
74(defsetf class-direct-subclasses %set-class-direct-subclasses)
75(defsetf class-direct-methods %set-class-direct-methods)
76(defsetf class-direct-slots %set-class-direct-slots)
77(defsetf class-slots %set-class-slots)
78(defsetf class-direct-default-initargs %set-class-direct-default-initargs)
79(defsetf class-default-initargs %set-class-default-initargs)
80(defsetf class-precedence-list %set-class-precedence-list)
81(defsetf std-instance-layout %set-std-instance-layout)
82(defsetf std-instance-slots %set-std-instance-slots)
83(defsetf instance-ref %set-instance-ref)
84
85(defun (setf find-class) (new-value symbol &optional errorp environment)
86  (%set-find-class symbol new-value))
87
88(defun canonicalize-direct-slots (direct-slots)
89  `(list ,@(mapcar #'canonicalize-direct-slot direct-slots)))
90
91(defun canonicalize-direct-slot (spec)
92  (if (symbolp spec)
93      `(list :name ',spec)
94      (let ((name (car spec))
95            (initfunction nil)
96            (initform nil)
97            (initargs ())
98            (type nil)
99            (allocation nil)
100            (documentation nil)
101            (readers ())
102            (writers ())
103            (other-options ()))
104        (do ((olist (cdr spec) (cddr olist)))
105            ((null olist))
106          (case (car olist)
107            (:initform
108             (when initform
109               (error 'program-error
110                      "duplicate slot option :INITFORM for slot named ~S"
111                      name))
112             (setq initfunction
113                   `(function (lambda () ,(cadr olist))))
114             (setq initform `',(cadr olist)))
115            (:initarg
116             (push-on-end (cadr olist) initargs))
117            (:allocation
118             (when allocation
119               (error 'program-error
120                      "duplicate slot option :ALLOCATION for slot named ~S"
121                      name))
122             (setf allocation (cadr olist))
123             (push-on-end (car olist) other-options)
124             (push-on-end (cadr olist) other-options))
125            (:type
126             (when type
127               (error 'program-error
128                      "duplicate slot option :TYPE for slot named ~S"
129                      name))
130             (setf type (cadr olist))) ;; FIXME type is ignored
131            (:documentation
132             (when documentation
133               (error 'program-error
134                      "duplicate slot option :DOCUMENTATION for slot named ~S"
135                      name))
136             (setf documentation (cadr olist))) ;; FIXME documentation is ignored
137            (:reader
138             (push-on-end (cadr olist) readers))
139            (:writer
140             (push-on-end (cadr olist) writers))
141            (:accessor
142             (push-on-end (cadr olist) readers)
143             (push-on-end `(setf ,(cadr olist)) writers))
144            (t
145             (error 'program-error
146                    "invalid initialization argument ~S for slot named ~S"
147                    (car olist) name))))
148        `(list
149          :name ',name
150          ,@(when initfunction
151              `(:initform ,initform
152                          :initfunction ,initfunction))
153          ,@(when initargs `(:initargs ',initargs))
154          ,@(when readers `(:readers ',readers))
155          ,@(when writers `(:writers ',writers))
156          ,@other-options))))
157
158(defun canonicalize-direct-superclasses (direct-superclasses)
159  `(list ,@(mapcar #'canonicalize-direct-superclass direct-superclasses)))
160
161(defun canonicalize-direct-superclass (class-name)
162  `(find-class ',class-name))
163
164(defun canonicalize-defclass-options (options)
165  (mapappend #'canonicalize-defclass-option options))
166
167(defun canonicalize-defclass-option (option)
168  (case (car option)
169    (:metaclass
170     (list ':metaclass
171           `(find-class ',(cadr option))))
172    (:default-initargs
173     (list
174      ':direct-default-initargs
175      `(list ,@(mapappend
176                #'(lambda (x) x)
177                (mapplist
178                 #'(lambda (key value)
179                    `(',key ,(make-initfunction value)))
180                 (cdr option))))))
181    ((:documentation :report)
182     (list (car option) `',(cadr option)))
183    (t
184     (error 'program-error
185            :format-control "invalid DEFCLASS option ~S"
186            :format-arguments (list (car option))))))
187
188(defun make-initfunction (initform)
189  `(function (lambda () ,initform)))
190
191(defconstant +slot-unbound+ (make-symbol "SLOT-UNBOUND"))
192
193;;; Slot definition metaobjects
194
195(defstruct slot-definition
196  name
197  initfunction
198  initform
199  initargs
200  readers
201  writers
202  allocation
203  allocation-class
204  (location nil))
205
206(defun make-direct-slot-definition (class &rest properties
207                                          &key name
208                                          (initargs ())
209                                          (initform nil)
210                                          (initfunction nil)
211                                          (readers ())
212                                          (writers ())
213                                          (allocation :instance)
214                                          &allow-other-keys)
215  (let ((slot (make-slot-definition)))
216    (setf (slot-definition-name slot) name)
217    (setf (slot-definition-initargs slot) initargs)
218    (setf (slot-definition-initform slot) initform)
219    (setf (slot-definition-initfunction slot) initfunction)
220    (setf (slot-definition-readers slot) readers)
221    (setf (slot-definition-writers slot) writers)
222    (setf (slot-definition-allocation slot) allocation)
223    (setf (slot-definition-allocation-class slot) class)
224    slot))
225
226(defun make-effective-slot-definition (&rest properties
227                                             &key name
228                                             (initargs ())
229                                             (initform nil)
230                                             (initfunction nil)
231                                             (allocation :instance)
232                                             (allocation-class nil)
233                                             &allow-other-keys)
234  (let ((slot (make-slot-definition)))
235    (setf (slot-definition-name slot) name)
236    (setf (slot-definition-initargs slot) initargs)
237    (setf (slot-definition-initform slot) initform)
238    (setf (slot-definition-initfunction slot) initfunction)
239    (setf (slot-definition-allocation slot) allocation)
240    (setf (slot-definition-allocation-class slot) allocation-class)
241    slot))
242
243;;; finalize-inheritance
244
245(defun std-finalize-inheritance (class)
246  (setf (class-precedence-list class)
247        (funcall (if (eq (class-of class) the-class-standard-class)
248                     #'std-compute-class-precedence-list
249                     #'compute-class-precedence-list)
250                 class))
251  (setf (class-slots class)
252        (funcall (if (eq (class-of class) the-class-standard-class)
253                     #'std-compute-slots
254                     #'compute-slots)
255                 class))
256  (let ((length 0))
257    (dolist (slot (class-slots class))
258      (case (slot-definition-allocation slot)
259        (:instance
260         (setf (slot-definition-location slot) length)
261         (incf length))
262        (:class
263         (unless (slot-definition-location slot)
264           (let ((allocation-class (slot-definition-allocation-class slot)))
265             (setf (slot-definition-location slot)
266                   (if (eq class allocation-class)
267                       (cons (slot-definition-name slot) +slot-unbound+)
268                       (slot-location allocation-class (slot-definition-name slot)))))))))
269    (setf (class-layout class)
270          (make-layout class length)))
271  (setf (class-default-initargs class)
272        (compute-class-default-initargs class))
273  (values))
274
275(defun compute-class-default-initargs (class)
276  (mapappend #'class-direct-default-initargs
277             (class-precedence-list class)))
278
279;;; Class precedence lists
280
281(defun std-compute-class-precedence-list (class)
282  (let ((classes-to-order (collect-superclasses* class)))
283    (topological-sort classes-to-order
284                      (remove-duplicates
285                       (mapappend #'local-precedence-ordering
286                                  classes-to-order))
287                      #'std-tie-breaker-rule)))
288
289;;; topological-sort implements the standard algorithm for topologically
290;;; sorting an arbitrary set of elements while honoring the precedence
291;;; constraints given by a set of (X,Y) pairs that indicate that element
292;;; X must precede element Y.  The tie-breaker procedure is called when it
293;;; is necessary to choose from multiple minimal elements; both a list of
294;;; candidates and the ordering so far are provided as arguments.
295
296(defun topological-sort (elements constraints tie-breaker)
297  (let ((remaining-constraints constraints)
298        (remaining-elements elements)
299        (result ()))
300    (loop
301      (let ((minimal-elements
302             (remove-if
303              #'(lambda (class)
304                 (member class remaining-constraints
305                         :key #'cadr))
306              remaining-elements)))
307        (when (null minimal-elements)
308          (if (null remaining-elements)
309              (return-from topological-sort result)
310              (error "Inconsistent precedence graph.")))
311        (let ((choice (if (null (cdr minimal-elements))
312                          (car minimal-elements)
313                          (funcall tie-breaker
314                                   minimal-elements
315                                   result))))
316          (setq result (append result (list choice)))
317          (setq remaining-elements
318                (remove choice remaining-elements))
319          (setq remaining-constraints
320                (remove choice
321                        remaining-constraints
322                        :test #'member)))))))
323
324;;; In the event of a tie while topologically sorting class precedence lists,
325;;; the CLOS Specification says to "select the one that has a direct subclass
326;;; rightmost in the class precedence list computed so far."  The same result
327;;; is obtained by inspecting the partially constructed class precedence list
328;;; from right to left, looking for the first minimal element to show up among
329;;; the direct superclasses of the class precedence list constituent.
330;;; (There's a lemma that shows that this rule yields a unique result.)
331
332(defun std-tie-breaker-rule (minimal-elements cpl-so-far)
333  (dolist (cpl-constituent (reverse cpl-so-far))
334    (let* ((supers (class-direct-superclasses cpl-constituent))
335           (common (intersection minimal-elements supers)))
336      (when (not (null common))
337        (return-from std-tie-breaker-rule (car common))))))
338
339;;; This version of collect-superclasses* isn't bothered by cycles in the class
340;;; hierarchy, which sometimes happen by accident.
341
342(defun collect-superclasses* (class)
343  (labels ((all-superclasses-loop (seen superclasses)
344                                  (let ((to-be-processed
345                                         (set-difference superclasses seen)))
346                                    (if (null to-be-processed)
347                                        superclasses
348                                        (let ((class-to-process
349                                               (car to-be-processed)))
350                                          (all-superclasses-loop
351                                           (cons class-to-process seen)
352                                           (union (class-direct-superclasses
353                                                   class-to-process)
354                                                  superclasses)))))))
355          (all-superclasses-loop () (list class))))
356
357;;; The local precedence ordering of a class C with direct superclasses C_1,
358;;; C_2, ..., C_n is the set ((C C_1) (C_1 C_2) ...(C_n-1 C_n)).
359
360(defun local-precedence-ordering (class)
361  (mapcar #'list
362          (cons class
363                (butlast (class-direct-superclasses class)))
364          (class-direct-superclasses class)))
365
366;;; Slot inheritance
367
368(defun std-compute-slots (class)
369  (let* ((all-slots (mapappend #'class-direct-slots
370                               (class-precedence-list class)))
371         (all-names (remove-duplicates
372                     (mapcar #'slot-definition-name all-slots))))
373    (mapcar #'(lambda (name)
374               (funcall
375                (if (eq (class-of class) the-class-standard-class)
376                    #'std-compute-effective-slot-definition
377                    #'compute-effective-slot-definition)
378                class
379                (remove name all-slots
380                        :key #'slot-definition-name
381                        :test-not #'eq)))
382            all-names)))
383
384(defun std-compute-effective-slot-definition (class direct-slots)
385  (declare (ignore class))
386  (let ((initer (find-if-not #'null direct-slots
387                             :key #'slot-definition-initfunction)))
388    (make-effective-slot-definition
389     :name (slot-definition-name (car direct-slots))
390     :initform (if initer
391                   (slot-definition-initform initer)
392                   nil)
393     :initfunction (if initer
394                       (slot-definition-initfunction initer)
395                       nil)
396     :initargs (remove-duplicates
397                (mapappend #'slot-definition-initargs
398                           direct-slots))
399     :allocation (slot-definition-allocation (car direct-slots))
400     :allocation-class (slot-definition-allocation-class (car direct-slots)))))
401
402;;; Standard instance slot access
403
404;;; N.B. The location of the effective-slots slots in the class metaobject for
405;;; standard-class must be determined without making any further slot
406;;; references.
407
408(defvar the-slots-of-standard-class) ;standard-class's class-slots
409(defvar the-class-standard-class (find-class 'standard-class))
410
411(defun find-slot-definition (class slot-name)
412  (dolist (slot (class-slots class) nil)
413    (when (eq slot-name (slot-definition-name slot))
414      (return slot))))
415
416(defun slot-location (class slot-name)
417  (let ((slot (find-slot-definition class slot-name)))
418    (if slot
419        (slot-definition-location slot)
420        nil)))
421
422(defun std-slot-value (instance slot-name)
423  (let* ((location (slot-location (class-of instance) slot-name))
424         (value (cond ((fixnump location)
425                       (instance-ref instance location))
426                      ((consp location)
427                       (cdr location))
428                      (t
429                       (slot-missing (class-of instance) instance slot-name 'slot-value)))))
430    (if (eq +slot-unbound+ value)
431        (error "The slot ~S is unbound in the object ~S." slot-name instance)
432        value)))
433
434(defun slot-value (object slot-name)
435  (if (eq (class-of (class-of object)) the-class-standard-class)
436      (std-slot-value object slot-name)
437      (slot-value-using-class (class-of object) object slot-name)))
438
439(defun %set-std-slot-value (instance slot-name new-value)
440  (let ((location (slot-location (class-of instance) slot-name)))
441    (cond ((fixnump location)
442           (setf (instance-ref instance location) new-value))
443          ((consp location)
444           (setf (cdr location) new-value))
445          (t
446           (slot-missing (class-of instance) instance slot-name 'setf new-value))))
447  new-value)
448
449(defsetf std-slot-value %set-std-slot-value)
450
451(defun (setf slot-value) (new-value object slot-name)
452  (if (eq (class-of (class-of object)) the-class-standard-class)
453      (setf (std-slot-value object slot-name) new-value)
454      (setf-slot-value-using-class
455       new-value (class-of object) object slot-name)))
456
457(defun std-slot-boundp (instance slot-name)
458  (let ((location (slot-location (class-of instance) slot-name)))
459    (cond ((fixnump location)
460           (neq +slot-unbound+ (instance-ref instance location)))
461          ((consp location)
462           (neq +slot-unbound+ (cdr location)))
463          (t
464           (not (null (slot-missing (class-of instance) instance slot-name 'slot-boundp)))))))
465
466(defun slot-boundp (object slot-name)
467  (if (eq (class-of (class-of object)) the-class-standard-class)
468      (std-slot-boundp object slot-name)
469      (slot-boundp-using-class (class-of object) object slot-name)))
470
471(defun std-slot-makunbound (instance slot-name)
472  (let ((location (slot-location (class-of instance) slot-name)))
473    (cond ((fixnump location)
474           (setf (instance-ref instance location) +slot-unbound+))
475          ((consp location)
476           (setf (cdr location) +slot-unbound+))
477          (t
478           (slot-missing (class-of instance) instance slot-name 'slot-makunbound))))
479  instance)
480
481(defun slot-makunbound (object slot-name)
482  (if (eq (class-of (class-of object)) the-class-standard-class)
483      (std-slot-makunbound object slot-name)
484      (slot-makunbound-using-class (class-of object) object slot-name)))
485
486(defun std-slot-exists-p (instance slot-name)
487  (not (null (find slot-name (class-slots (class-of instance))
488                   :key #'slot-definition-name))))
489
490(defun slot-exists-p (object slot-name)
491  (if (eq (class-of (class-of object)) the-class-standard-class)
492      (std-slot-exists-p object slot-name)
493      (slot-exists-p-using-class (class-of object) object slot-name)))
494
495(defun instance-slot-p (slot)
496  (eq (slot-definition-allocation slot) :instance))
497
498(defun std-allocate-instance (class)
499  (let* ((layout (class-layout class))
500         (length (and layout (layout-length layout))))
501    (unless layout
502      (format t "no layout for class ~S~%" class)
503      (backtrace))
504    (unless length
505      (format t "no layout length for class ~S~%" class)
506      (setf length (count-if #'instance-slot-p (class-slots class))))
507    (allocate-std-instance class
508                           (allocate-slot-storage length +slot-unbound+))))
509
510(defun make-instance-standard-class (metaclass
511                                     &key name direct-superclasses direct-slots
512                                     direct-default-initargs
513                                     &allow-other-keys)
514  (declare (ignore metaclass))
515  (let ((class (std-allocate-instance (find-class 'standard-class))))
516    (setf (class-name class) name)
517    (setf (class-direct-subclasses class) ())
518    (setf (class-direct-methods class) ())
519    (std-after-initialization-for-classes class
520                                          :direct-superclasses direct-superclasses
521                                          :direct-slots direct-slots
522                                          :direct-default-initargs direct-default-initargs)
523    class))
524
525(defun std-after-initialization-for-classes (class
526                                             &key direct-superclasses direct-slots
527                                             direct-default-initargs
528                                             &allow-other-keys)
529  (let ((supers (or direct-superclasses
530                    (list (find-class 'standard-object)))))
531    (setf (class-direct-superclasses class) supers)
532    (dolist (superclass supers)
533      (push class (class-direct-subclasses superclass))))
534  (let ((slots (mapcar #'(lambda (slot-properties)
535                          (apply #'make-direct-slot-definition class slot-properties))
536                       direct-slots)))
537    (setf (class-direct-slots class) slots)
538    (dolist (direct-slot slots)
539      (dolist (reader (slot-definition-readers direct-slot))
540        (add-reader-method
541         class reader (slot-definition-name direct-slot)))
542      (dolist (writer (slot-definition-writers direct-slot))
543        (add-writer-method
544         class writer (slot-definition-name direct-slot)))))
545  (setf (class-direct-default-initargs class) direct-default-initargs)
546  (funcall (if (eq (class-of class) (find-class 'standard-class))
547               #'std-finalize-inheritance
548               #'finalize-inheritance)
549           class)
550  (values))
551
552(defun canonical-slot-name (canonical-slot)
553  (getf canonical-slot :name))
554
555(defun ensure-class (name &rest all-keys &allow-other-keys)
556  ;; Check for duplicate slots.
557  (let ((slots (getf all-keys :direct-slots)))
558    (dolist (s1 slots)
559      (let ((name1 (canonical-slot-name s1)))
560        (dolist (s2 (cdr (memq s1 slots)))
561    (when (eq name1 (canonical-slot-name s2))
562            (error 'program-error "duplicate slot ~S" name1))))))
563  ;; Check for duplicate argument names in :DEFAULT-INITARGS.
564  (let ((names ()))
565    (do* ((initargs (getf all-keys :direct-default-initargs) (cddr initargs))
566          (name (car initargs) (car initargs)))
567         ((null initargs))
568      (push name names))
569    (do* ((names names (cdr names))
570          (name (car names) (car names)))
571         ((null names))
572      (when (memq name (cdr names))
573        (error 'program-error
574               "duplicate initialization argument name ~S in :DEFAULT-INITARGS"
575               name))))
576  (let ((class (find-class name nil)))
577    (unless class
578      (setf class (apply #'make-instance-standard-class (find-class 'standard-class)
579                         :name name all-keys))
580      (%set-find-class name class))
581    class))
582
583(defmacro defclass (&whole form name direct-superclasses direct-slots &rest options)
584  (unless (>= (length form) 3)
585    (error 'program-error "wrong number of arguments for DEFCLASS"))
586  `(ensure-class ',name
587                 :direct-superclasses
588                 ,(canonicalize-direct-superclasses direct-superclasses)
589                 :direct-slots
590                 ,(canonicalize-direct-slots direct-slots)
591                 ,@(canonicalize-defclass-options options)))
592
593;;; Generic function metaobjects and standard-generic-function
594
595(defun method-combination-type (method-combination)
596  (if (atom method-combination)
597      method-combination
598      (car method-combination)))
599
600(defun method-combination-options (method-combination)
601  (if (atom method-combination)
602      nil
603      (cdr method-combination)))
604
605(defclass standard-generic-function (generic-function)
606  ((name :initarg :name)      ; :accessor generic-function-name
607   (lambda-list               ; :accessor generic-function-lambda-list
608    :initarg :lambda-list)
609   (methods :initform ())     ; :accessor generic-function-methods
610   (method-class              ; :accessor generic-function-method-class
611    :initarg :method-class)
612   (method-combination
613    :initarg :method-combination)
614   (classes-to-emf-table      ; :accessor classes-to-emf-table
615    :initform (make-hash-table :test #'equal))
616   (required-args :initform ())))
617
618(defvar the-class-standard-gf (find-class 'standard-generic-function))
619
620(defvar *sgf-required-args-index*
621  (slot-location the-class-standard-gf 'required-args))
622
623(defvar *sgf-classes-to-emf-table-index*
624  (slot-location the-class-standard-gf 'classes-to-emf-table))
625
626(defun generic-function-name (gf)
627  (slot-value gf 'name))
628(defun (setf generic-function-name) (new-value gf)
629  (setf (slot-value gf 'name) new-value))
630
631(defun generic-function-lambda-list (gf)
632  (slot-value gf 'lambda-list))
633(defun (setf generic-function-lambda-list) (new-value gf)
634  (setf (slot-value gf 'lambda-list) new-value))
635
636(defun generic-function-methods (gf)
637  (slot-value gf 'methods))
638(defun (setf generic-function-methods) (new-value gf)
639  (setf (slot-value gf 'methods) new-value))
640
641(defsetf generic-function-discriminating-function
642  %set-generic-function-discriminating-function)
643
644(defun generic-function-method-class (gf)
645  (slot-value gf 'method-class))
646(defun (setf generic-function-method-class) (new-value gf)
647  (setf (slot-value gf 'method-class) new-value))
648
649(defun generic-function-method-combination (gf)
650  (slot-value gf 'method-combination))
651(defun (setf generic-function-method-combination) (new-value gf)
652  (setf (slot-value gf 'method-combination) new-value))
653
654;;; Internal accessor for effective method function table
655
656(defun classes-to-emf-table (gf)
657  (instance-ref gf *sgf-classes-to-emf-table-index*))
658
659(defun (setf classes-to-emf-table) (new-value gf)
660  (setf (slot-value gf 'classes-to-emf-table) new-value))
661
662;;; Method metaobjects and standard-method
663
664(defclass standard-method (method)
665  ((lambda-list :initarg :lambda-list)     ; :accessor method-lambda-list
666   (qualifiers :initarg :qualifiers)       ; :accessor method-qualifiers
667   (specializers :initarg :specializers)   ; :accessor method-specializers
668   (body :initarg :body)                   ; :accessor method-body
669   (environment :initarg :environment)     ; :accessor method-environment
670   (generic-function :initform nil)        ; :accessor method-generic-function
671   (function)))                            ; :accessor method-function
672
673(defvar the-class-standard-method (find-class 'standard-method))
674
675(defvar *sm-function-index*
676  (slot-location the-class-standard-method 'function))
677
678(defun method-lambda-list (method) (slot-value method 'lambda-list))
679(defun (setf method-lambda-list) (new-value method)
680  (setf (slot-value method 'lambda-list) new-value))
681
682(defun method-qualifiers (method) (slot-value method 'qualifiers))
683(defun (setf method-qualifiers) (new-value method)
684  (setf (slot-value method 'qualifiers) new-value))
685
686(defun method-specializers (method) (slot-value method 'specializers))
687(defun (setf method-specializers) (new-value method)
688  (setf (slot-value method 'specializers) new-value))
689
690(defun method-body (method) (slot-value method 'body))
691(defun (setf method-body) (new-value method)
692  (setf (slot-value method 'body) new-value))
693
694(defun method-environment (method) (slot-value method 'environment))
695(defun (setf method-environment) (new-value method)
696  (setf (slot-value method 'environment) new-value))
697
698(defun method-generic-function (method)
699  (slot-value method 'generic-function))
700(defun (setf method-generic-function) (new-value method)
701  (setf (slot-value method 'generic-function) new-value))
702
703(defun method-function (method)
704  (instance-ref method *sm-function-index*))
705
706(defun (setf method-function) (new-value method)
707  (setf (slot-value method 'function) new-value))
708
709;;; defgeneric
710
711(defmacro defgeneric (function-name lambda-list
712                                    &rest options-and-method-descriptions)
713  (let ((options ())
714        (methods ()))
715    (dolist (item options-and-method-descriptions)
716      (case (car item)
717        (declare) ; FIXME
718        (:documentation) ; FIXME
719        (:method
720         (push `(defmethod ,function-name ,@(cdr item)) methods))
721        (t
722         (push item options))))
723    (setf options (nreverse options)
724          methods (nreverse methods))
725    `(prog1
726       (ensure-generic-function
727        ',function-name
728        :lambda-list ',lambda-list
729        ,@(canonicalize-defgeneric-options options))
730       ,@methods)))
731
732(defun canonicalize-defgeneric-options (options)
733  (mapappend #'canonicalize-defgeneric-option options))
734
735(defun canonicalize-defgeneric-option (option)
736  (case (car option)
737    (:generic-function-class
738     (list ':generic-function-class `(find-class ',(cadr option))))
739    (:method-class
740     (list ':method-class `(find-class ',(cadr option))))
741    (:method-combination
742     (list `',(car option) `',(cdr option)))
743    (t
744     (list `',(car option) `',(cadr option)))))
745
746(defparameter generic-function-table (make-hash-table :test #'equal))
747
748(defun find-generic-function (symbol &optional (errorp t))
749  (let ((gf (gethash symbol generic-function-table nil)))
750    (if (and (null gf) errorp)
751        (error "no generic function named ~S" symbol)
752        gf)))
753
754(defun (setf find-generic-function) (new-value symbol)
755  (setf (gethash symbol generic-function-table) new-value))
756
757;;; ensure-generic-function
758
759(defun ensure-generic-function (function-name
760                                &rest all-keys
761                                &key
762                                (generic-function-class the-class-standard-gf)
763                                (method-class the-class-standard-method)
764                                (method-combination 'standard)
765                                &allow-other-keys)
766  (when (autoloadp function-name)
767    (resolve function-name))
768  (if (find-generic-function function-name nil)
769      (find-generic-function function-name)
770      (progn
771        (when (fboundp function-name)
772          (error 'program-error
773                 "~A already names an ordinary function, macro, or special operator"
774                 function-name))
775        (let ((gf (apply (if (eq generic-function-class the-class-standard-gf)
776                             #'make-instance-standard-generic-function
777                             #'make-instance)
778                         generic-function-class
779                         :name function-name
780                         :method-class method-class
781                         :method-combination method-combination
782                         all-keys)))
783          (setf (find-generic-function function-name) gf)
784          gf))))
785
786;;; finalize-generic-function
787
788(defun finalize-generic-function (gf)
789  (setf (generic-function-discriminating-function gf)
790        (funcall (if (eq (class-of gf) the-class-standard-gf)
791                     #'std-compute-discriminating-function
792                     #'compute-discriminating-function)
793                 gf))
794  (setf (fdefinition (generic-function-name gf)) gf)
795  (clrhash (classes-to-emf-table gf))
796  (values))
797
798(defun gf-required-args (gf)
799  (instance-ref gf *sgf-required-args-index*))
800
801(defun make-instance-standard-generic-function (generic-function-class
802                                                &key name lambda-list
803                                                method-class
804                                                method-combination)
805  (declare (ignore generic-function-class))
806  (let ((gf (std-allocate-instance the-class-standard-gf)))
807    (setf (generic-function-name gf) name)
808    (setf (generic-function-lambda-list gf) lambda-list)
809    (setf (generic-function-methods gf) ())
810    (setf (generic-function-method-class gf) method-class)
811    (setf (generic-function-method-combination gf) method-combination)
812    (setf (classes-to-emf-table gf) (make-hash-table :test #'equal))
813    (setf (slot-value gf 'required-args)
814          (let ((plist (analyze-lambda-list (generic-function-lambda-list gf))))
815            (getf plist ':required-args)))
816    (finalize-generic-function gf)
817    gf))
818
819;;; Run-time environment hacking (Common Lisp ain't got 'em).
820
821(defun top-level-environment ()
822  nil) ; Bogus top level lexical environment
823
824(defvar compile-methods nil)      ; by default, run everything interpreted
825
826(defun compile-in-lexical-environment (env lambda-expr)
827  (declare (ignore env))
828  (if compile-methods
829      (compile nil lambda-expr)
830      (eval `(function ,lambda-expr))))
831
832;;; defmethod
833
834(defmacro defmethod (&rest args)
835  (multiple-value-bind (function-name qualifiers lambda-list specializers body)
836    (parse-defmethod args)
837    `(progn
838      (ensure-generic-function
839       ',function-name
840       :lambda-list ',lambda-list)
841      (ensure-method (find-generic-function ',function-name)
842                     :lambda-list ',lambda-list
843                     :qualifiers ',qualifiers
844                     :specializers ,(canonicalize-specializers specializers)
845                     :body ',body
846                     :environment (top-level-environment)))))
847
848(defun canonicalize-specializers (specializers)
849  `(list ,@(mapcar #'canonicalize-specializer specializers)))
850
851(defun canonicalize-specializer (specializer)
852  ;; FIXME (EQL specializers)
853  `(if (atom ',specializer) (find-class ',specializer) (find-class 't)))
854
855(defun parse-defmethod (args)
856  (let ((fn-spec (car args))
857        (qualifiers ())
858        (specialized-lambda-list nil)
859        (body ())
860        (parse-state :qualifiers))
861    (dolist (arg (cdr args))
862      (ecase parse-state
863        (:qualifiers
864         (if (and (atom arg) (not (null arg)))
865             (push-on-end arg qualifiers)
866             (progn (setq specialized-lambda-list arg)
867               (setq parse-state :body))))
868        (:body (push-on-end arg body))))
869    (values fn-spec
870            qualifiers
871            (extract-lambda-list specialized-lambda-list)
872            (extract-specializers specialized-lambda-list)
873            (list* 'block
874                   (if (consp fn-spec)
875                       (cadr fn-spec)
876                       fn-spec)
877                   body))))
878
879;;; Several tedious functions for analyzing lambda lists
880
881(defun required-portion (gf args)
882  (let ((number-required (length (gf-required-args gf))))
883    (when (< (length args) number-required)
884      (error 'program-error "not enough arguments for generic function ~S" gf))
885    (subseq args 0 number-required)))
886
887(defun extract-lambda-list (specialized-lambda-list)
888  (let* ((plist (analyze-lambda-list specialized-lambda-list))
889         (requireds (getf plist :required-names))
890         (rv (getf plist :rest-var))
891         (ks (getf plist :key-args))
892         (keysp (getf plist :keysp))
893         (aok (getf plist :allow-other-keys))
894         (opts (getf plist :optional-args))
895         (auxs (getf plist :auxiliary-args)))
896    `(,@requireds
897      ,@(if rv `(&rest ,rv) ())
898      ,@(if (or ks keysp aok) `(&key ,@ks) ())
899      ,@(if aok '(&allow-other-keys) ())
900      ,@(if opts `(&optional ,@opts) ())
901      ,@(if auxs `(&aux ,@auxs) ()))))
902
903(defun extract-specializers (specialized-lambda-list)
904  (let ((plist (analyze-lambda-list specialized-lambda-list)))
905    (getf plist ':specializers)))
906
907(defun analyze-lambda-list (lambda-list)
908  (labels ((make-keyword (symbol)
909                         (intern (symbol-name symbol)
910                                 (find-package 'keyword)))
911           (get-keyword-from-arg (arg)
912                                 (if (listp arg)
913                                     (if (listp (car arg))
914                                         (caar arg)
915                                         (make-keyword (car arg)))
916                                     (make-keyword arg))))
917          (let ((keys ())           ; Just the keywords
918                (key-args ())       ; Keywords argument specs
919                (keysp nil)         ;
920                (required-names ()) ; Just the variable names
921                (required-args ())  ; Variable names & specializers
922                (specializers ())   ; Just the specializers
923                (rest-var nil)
924                (optionals ())
925                (auxs ())
926                (allow-other-keys nil)
927                (state :parsing-required))
928            (dolist (arg lambda-list)
929              (if (member arg lambda-list-keywords)
930                  (ecase arg
931                    (&optional
932                     (setq state :parsing-optional))
933                    (&rest
934                     (setq state :parsing-rest))
935                    (&key
936                     (setq keysp t)
937                     (setq state :parsing-key))
938                    (&allow-other-keys
939                     (setq allow-other-keys 't))
940                    (&aux
941                     (setq state :parsing-aux)))
942                  (case state
943                    (:parsing-required
944                     (push-on-end arg required-args)
945                     (if (listp arg)
946                         (progn (push-on-end (car arg) required-names)
947                           (push-on-end (cadr arg) specializers))
948                         (progn (push-on-end arg required-names)
949                           (push-on-end 't specializers))))
950                    (:parsing-optional (push-on-end arg optionals))
951                    (:parsing-rest (setq rest-var arg))
952                    (:parsing-key
953                     (push-on-end (get-keyword-from-arg arg) keys)
954                     (push-on-end arg key-args))
955                    (:parsing-aux (push-on-end arg auxs)))))
956            (list  :required-names required-names
957                   :required-args required-args
958                   :specializers specializers
959                   :rest-var rest-var
960                   :keywords keys
961                   :key-args key-args
962                   :keysp keysp
963                   :auxiliary-args auxs
964                   :optional-args optionals
965                   :allow-other-keys allow-other-keys))))
966
967;;; ensure method
968
969#+nil
970(defun check-method-arg-info (gf arg-info method)
971  (multiple-value-bind (nreq nopt keysp restp allow-other-keys-p keywords)
972    (analyze-lambda-list (if (consp method)
973                             (early-method-lambda-list method)
974                             (method-lambda-list method)))
975    (flet ((lose (string &rest args)
976                 (error 'simple-program-error
977                        :format-control "~@<attempt to add the method~2I~_~S~I~_~
978                        to the generic function~2I~_~S;~I~_~
979                        but ~?~:>"
980                        :format-arguments (list method gf string args)))
981     (comparison-description (x y)
982                                   (if (> x y) "more" "fewer")))
983      (let ((gf-nreq (arg-info-number-required arg-info))
984      (gf-nopt (arg-info-number-optional arg-info))
985      (gf-key/rest-p (arg-info-key/rest-p arg-info))
986      (gf-keywords (arg-info-keys arg-info)))
987  (unless (= nreq gf-nreq)
988    (lose
989     "the method has ~A required arguments than the generic function."
990     (comparison-description nreq gf-nreq)))
991  (unless (= nopt gf-nopt)
992    (lose
993     "the method has ~A optional arguments than the generic function."
994     (comparison-description nopt gf-nopt)))
995  (unless (eq (or keysp restp) gf-key/rest-p)
996    (lose
997     "the method and generic function differ in whether they accept~_~
998      &REST or &KEY arguments."))
999  (when (consp gf-keywords)
1000    (unless (or (and restp (not keysp))
1001          allow-other-keys-p
1002          (every (lambda (k) (memq k keywords)) gf-keywords))
1003      (lose "the method does not accept each of the &KEY arguments~2I~_~
1004            ~S."
1005      gf-keywords)))))))
1006
1007(defun ensure-method (gf &rest all-keys)
1008  (let* ((gf-lambda-list (generic-function-lambda-list gf))
1009         (gf-restp (not (null (memq '&rest gf-lambda-list))))
1010         (gf-plist (analyze-lambda-list gf-lambda-list))
1011         (gf-keysp (getf gf-plist :keysp))
1012         (gf-keywords (getf gf-plist :keywords))
1013         (method-lambda-list (getf all-keys :lambda-list))
1014         (method-plist (analyze-lambda-list method-lambda-list))
1015         (method-restp (not (null (memq '&rest method-lambda-list))))
1016         (method-keysp (getf method-plist :keysp))
1017         (method-keywords (getf method-plist :keywords))
1018         (method-allow-other-keys-p (getf method-plist :allow-other-keys)))
1019    (unless (= (length (getf gf-plist :required-args))
1020               (length (getf method-plist :required-args)))
1021      (error "the method has the wrong number of required arguments for the generic function"))
1022    (unless (= (length (getf gf-plist :optional-args))
1023               (length (getf method-plist :optional-args)))
1024      (error "the method has the wrong number of optional arguments for the generic function"))
1025    (unless (eq (or gf-restp gf-keysp) (or method-restp method-keysp))
1026      (error "the method and the generic function differ in whether they accept &REST or &KEY arguments"))
1027    (when (consp gf-keywords)
1028      (unless (or (and method-restp (not method-keysp))
1029                  method-allow-other-keys-p
1030                  (every (lambda (k) (memq k method-keywords)) gf-keywords))
1031        (error "the method does not accept all of the keyword arguments defined for the generic function"))))
1032  (let ((new-method
1033         (apply
1034          (if (eq (generic-function-method-class gf) the-class-standard-method)
1035              #'make-instance-standard-method
1036              #'make-instance)
1037          (generic-function-method-class gf)
1038          all-keys)))
1039    (add-method gf new-method)
1040    new-method))
1041
1042(defun make-instance-standard-method (method-class
1043                                      &key lambda-list qualifiers
1044                                      specializers body environment)
1045  (declare (ignore method-class))
1046  (let ((method (std-allocate-instance the-class-standard-method)))
1047    (setf (method-lambda-list method) lambda-list)
1048    (setf (method-qualifiers method) qualifiers)
1049    (setf (method-specializers method) specializers)
1050    (setf (method-body method) (precompile-form body nil))
1051    (setf (method-environment method) environment)
1052    (setf (method-generic-function method) nil)
1053    (setf (method-function method)
1054          (std-compute-method-function method))
1055    method))
1056
1057(defun check-congruent (gf method)
1058  (let* ((plist1 (analyze-lambda-list (generic-function-lambda-list gf)))
1059         (args1 (getf plist1 :required-args))
1060         (plist2 (analyze-lambda-list (method-lambda-list method)))
1061         (args2 (getf plist2 :required-args)))
1062    (unless (= (length args1) (length args2))
1063      (error "lambda lists are not congruent"))))
1064
1065(defun add-method (gf method)
1066  (check-congruent gf method)
1067  ;; Remove existing method with same qualifiers and specializers (if any).
1068  (let ((old-method (find-method gf (method-qualifiers method)
1069                                 (method-specializers method) nil)))
1070    (when old-method
1071      (remove-method gf old-method)))
1072  (setf (method-generic-function method) gf)
1073  (push method (generic-function-methods gf))
1074  (dolist (specializer (method-specializers method))
1075    (pushnew method (class-direct-methods specializer)))
1076  (finalize-generic-function gf)
1077  gf)
1078
1079(defun remove-method (gf method)
1080  (setf (generic-function-methods gf)
1081        (remove method (generic-function-methods gf)))
1082  (setf (method-generic-function method) nil)
1083;;   (format t "remove-method method-specializers = ~S~%" (method-specializers method))
1084  (dolist (class (method-specializers method))
1085    (setf (class-direct-methods class)
1086          (remove method (class-direct-methods class))))
1087  (finalize-generic-function gf)
1088  gf)
1089
1090(defun find-method (gf qualifiers specializers &optional (errorp t))
1091  (let ((method
1092         (find-if #'(lambda (method)
1093                     (and (equal qualifiers
1094                                 (method-qualifiers method))
1095                          (equal specializers
1096                                 (method-specializers method))))
1097                  (generic-function-methods gf))))
1098    (if (and (null method) errorp)
1099        (error "no such method for ~S" (generic-function-name gf))
1100        method)))
1101
1102;;; Reader and writer methods
1103
1104(defun add-reader-method (class fn-name slot-name)
1105  (ensure-method
1106   (ensure-generic-function fn-name :lambda-list '(object))
1107   :lambda-list '(object)
1108   :qualifiers ()
1109   :specializers (list class)
1110   :body `(slot-value object ',slot-name)
1111   :environment (top-level-environment))
1112  (values))
1113
1114(defun add-writer-method (class fn-name slot-name)
1115  (ensure-method
1116   (ensure-generic-function
1117    fn-name :lambda-list '(new-value object))
1118   :lambda-list '(new-value object)
1119   :qualifiers ()
1120   :specializers (list (find-class 't) class)
1121   :body `(setf (slot-value object ',slot-name)
1122                new-value)
1123   :environment (top-level-environment))
1124  (values))
1125
1126(defun subclassp (c1 c2)
1127  (not (null (find c2 (class-precedence-list c1)))))
1128
1129;;;
1130;;; Generic function invocation
1131;;;
1132
1133;;; apply-generic-function
1134
1135(defun apply-generic-function (gf args)
1136  (apply (generic-function-discriminating-function gf) args))
1137
1138;;; compute-discriminating-function
1139
1140(defun std-compute-discriminating-function (gf)
1141  #'(lambda (&rest args)
1142     (let* ((classes (mapcar #'class-of
1143                             (required-portion gf args)))
1144            (emfun (gethash classes (classes-to-emf-table gf) nil)))
1145       (if emfun
1146           (funcall emfun args)
1147           (slow-method-lookup gf args classes)))))
1148
1149(defun slow-method-lookup (gf args classes)
1150  (let ((applicable-methods
1151         (compute-applicable-methods-using-classes gf classes)))
1152    (if applicable-methods
1153        (let ((emfun
1154               (funcall
1155                (if (eq (class-of gf) the-class-standard-gf)
1156                    #'std-compute-effective-method-function
1157                  #'compute-effective-method-function)
1158                gf applicable-methods)))
1159          (setf (gethash classes (classes-to-emf-table gf)) emfun)
1160          (funcall emfun args))
1161        (error "no applicable methods for generic function ~S with arguments ~S of classes ~S" gf args classes))))
1162
1163(defun compute-applicable-methods-using-classes (gf required-classes)
1164  (sort
1165   (copy-list
1166    (remove-if-not #'(lambda (method)
1167                      (every #'subclassp
1168                             required-classes
1169                             (method-specializers method)))
1170                   (generic-function-methods gf)))
1171   (if (eq (class-of gf) the-class-standard-gf)
1172       #'(lambda (m1 m2)
1173          (std-method-more-specific-p m1 m2 required-classes))
1174       #'(lambda (m1 m2)
1175          (method-more-specific-p gf m1 m2 required-classes)))))
1176
1177(defun sub-specializer-p (c1 c2 c-arg)
1178  (find c2 (cdr (memq c1 (class-precedence-list c-arg)))))
1179
1180(defun std-method-more-specific-p (method1 method2 required-classes)
1181  (mapc #'(lambda (spec1 spec2 arg-class)
1182           (unless (eq spec1 spec2)
1183             (return-from std-method-more-specific-p
1184                          (sub-specializer-p spec1 spec2 arg-class))))
1185        (method-specializers method1)
1186        (method-specializers method2)
1187        required-classes)
1188  nil)
1189
1190;;; apply-methods and compute-effective-method-function
1191
1192(defun apply-methods (gf args methods)
1193  (funcall (compute-effective-method-function gf methods)
1194           args))
1195
1196(defun primary-method-p (method)
1197  (null (intersection '(:before :after :around) (method-qualifiers method))))
1198
1199(defun before-method-p (method)
1200  (equal '(:before) (method-qualifiers method)))
1201
1202(defun after-method-p (method)
1203  (equal '(:after) (method-qualifiers method)))
1204
1205(defun around-method-p (method)
1206  (equal '(:around) (method-qualifiers method)))
1207
1208(defun std-compute-effective-method-function (gf methods)
1209  (let* ((mc (generic-function-method-combination gf))
1210         (type (method-combination-type mc))
1211         (options (method-combination-options mc))
1212         (order (car options))
1213         (primaries ())
1214         (arounds ())
1215         around)
1216    (dolist (m methods)
1217      (let ((qualifiers (method-qualifiers m)))
1218        (cond ((null qualifiers)
1219               (if (eq type 'standard)
1220                   (push m primaries)
1221                   (error "method combination type mismatch")))
1222              ((cdr qualifiers)
1223               (error "invalid method qualifiers"))
1224              ((eq (car qualifiers) :around)
1225               (push m arounds))
1226              ((eq (car qualifiers) type)
1227               (push m primaries))
1228              ((memq (car qualifiers) '(:before :after)))
1229              (t
1230               (error "invalid method qualifiers")))))
1231    (unless (eq order :most-specific-last)
1232      (setq primaries (nreverse primaries)))
1233    (setq arounds (nreverse arounds))
1234    (setq around (car arounds))
1235    (when (null primaries)
1236      (error "no primary methods for the generic function ~S" gf))
1237    (if around
1238        (let ((next-emfun
1239               (funcall
1240                (if (eq (class-of gf) the-class-standard-gf)
1241                    #'std-compute-effective-method-function
1242                    #'compute-effective-method-function)
1243                gf (remove around methods))))
1244          #'(lambda (args)
1245             (funcall (method-function around) args next-emfun)))
1246        (case type
1247          (STANDARD
1248           (let ((next-emfun (compute-primary-emfun (cdr primaries)))
1249                 (befores (remove-if-not #'before-method-p methods))
1250                 (reverse-afters
1251                  (reverse (remove-if-not #'after-method-p methods))))
1252             #'(lambda (args)
1253                (dolist (before befores)
1254                  (funcall (method-function before) args nil))
1255                (multiple-value-prog1
1256                 (funcall (method-function (car primaries)) args next-emfun)
1257                 (dolist (after reverse-afters)
1258                   (funcall (method-function after) args nil))))))
1259          (LIST
1260           #'(lambda (args)
1261              (let ((result ()))
1262                (dolist (primary primaries)
1263                  (push (funcall (method-function primary) args nil) result))
1264                (nreverse result))))
1265          (APPEND
1266           #'(lambda (args)
1267              (let ((result ()))
1268                (dolist (primary primaries)
1269                  (setf result (append result (funcall (method-function primary) args nil))))
1270                result)))
1271          (NCONC
1272           #'(lambda (args)
1273              (let ((result ()))
1274                (dolist (primary primaries)
1275                  (setf result (nconc result (funcall (method-function primary) args nil))))
1276                result)))
1277          (PROGN
1278           #'(lambda (args)
1279              (let ((result nil))
1280                (dolist (primary primaries)
1281                  (setf result (funcall (method-function primary) args nil)))
1282                result)))
1283          (AND
1284           #'(lambda (args)
1285              (let ((result t))
1286                (dolist (primary primaries)
1287                  (setf result
1288                        (and result
1289                             (funcall (method-function primary) args nil)))
1290                  (unless result (return)))
1291                result)))
1292          (OR
1293           #'(lambda (args)
1294              (let ((result nil))
1295                (dolist (primary primaries)
1296                  (setf result
1297                        (or result
1298                            (funcall (method-function primary) args nil)))
1299                  (when result (return)))
1300                result)))
1301          (+
1302           #'(lambda (args)
1303              (let ((result 0))
1304                (dolist (primary primaries)
1305                  (incf result (funcall (method-function primary) args nil)))
1306                result)))
1307          (MAX
1308           #'(lambda (args)
1309              (let ((result ()))
1310                (dolist (primary primaries)
1311                  (push (funcall (method-function primary) args nil) result))
1312                (apply #'max result))))
1313          (MIN
1314           #'(lambda (args)
1315              (let ((result ()))
1316                (dolist (primary primaries)
1317                  (push (funcall (method-function primary) args nil) result))
1318                (apply #'min result))))
1319          (t
1320           (error "unsupported method combination type ~S" type))))))
1321
1322;;; compute an effective method function from a list of primary methods:
1323
1324(defun compute-primary-emfun (methods)
1325  (if (null methods)
1326      nil
1327      (let ((next-emfun (compute-primary-emfun (cdr methods))))
1328        #'(lambda (args)
1329           (funcall (method-function (car methods)) args next-emfun)))))
1330
1331;;; apply-method and compute-method-function
1332
1333(defun apply-method (method args next-methods)
1334  (funcall (method-function method)
1335           args
1336           (if (null next-methods)
1337               nil
1338               (compute-effective-method-function
1339                (method-generic-function method) next-methods))))
1340
1341(defun std-compute-method-function (method)
1342  (let ((form (method-body method))
1343        (lambda-list (method-lambda-list method)))
1344    (compile-in-lexical-environment
1345     (method-environment method)
1346     `(lambda (args next-emfun)
1347        (flet ((call-next-method (&rest cnm-args)
1348                                 (if (null next-emfun)
1349                                     (error "no next method for generic function ~S"
1350                                            (method-generic-function ',method))
1351                                     (funcall next-emfun (or cnm-args args))))
1352               (next-method-p ()
1353                              (not (null next-emfun))))
1354          (apply #'(lambda ,(kludge-arglist lambda-list)
1355                    ,form)
1356                 args))))))
1357
1358;;; N.B. The function kludge-arglist is used to pave over the differences
1359;;; between argument keyword compatibility for regular functions versus
1360;;; generic functions.
1361
1362(defun kludge-arglist (lambda-list)
1363  (if (and (member '&key lambda-list)
1364           (not (member '&allow-other-keys lambda-list)))
1365      (append lambda-list '(&allow-other-keys))
1366      (if (and (not (member '&rest lambda-list))
1367               (not (member '&key lambda-list)))
1368          (append lambda-list '(&key &allow-other-keys))
1369          lambda-list)))
1370
1371;;; Slot access
1372
1373(defun setf-slot-value-using-class (new-value class instance slot-name)
1374  (setf (std-slot-value instance slot-name) new-value))
1375
1376(defgeneric slot-value-using-class (class instance slot-name))
1377(defmethod slot-value-using-class ((class standard-class) instance slot-name)
1378  (std-slot-value instance slot-name))
1379
1380(defgeneric (setf slot-value-using-class) (new-value class instance slot-name))
1381(defmethod (setf slot-value-using-class)
1382  (new-value (class standard-class) instance slot-name)
1383  (setf (std-slot-value instance slot-name) new-value))
1384
1385(defgeneric slot-exists-p-using-class (class instance slot-name))
1386
1387(defmethod slot-exists-p-using-class (class instance slot-name)
1388  nil)
1389
1390(defmethod slot-exists-p-using-class ((class standard-class) instance slot-name)
1391  (std-slot-exists-p instance slot-name))
1392
1393(defmethod slot-exists-p-using-class ((class structure-class) instance slot-name)
1394  (dolist (dsd (class-slots class))
1395    (when (eq (dsd-name dsd) slot-name)
1396      (return-from slot-exists-p-using-class t)))
1397  nil)
1398
1399(defgeneric slot-boundp-using-class (class instance slot-name))
1400(defmethod slot-boundp-using-class
1401  ((class standard-class) instance slot-name)
1402  (std-slot-boundp instance slot-name))
1403
1404(defgeneric slot-makunbound-using-class (class instance slot-name))
1405(defmethod slot-makunbound-using-class
1406  ((class standard-class) instance slot-name)
1407  (std-slot-makunbound instance slot-name))
1408
1409(defgeneric slot-missing (class instance slot-name operation &optional new-value))
1410(defmethod slot-missing ((class t) instance slot-name operation &optional new-value)
1411  (error "the slot ~S is missing from the class ~S" slot-name class))
1412
1413;;; Instance creation and initialization
1414
1415(defgeneric allocate-instance (class &rest initargs &key &allow-other-keys))
1416
1417(defmethod allocate-instance ((class standard-class) &rest initargs)
1418  (std-allocate-instance class))
1419
1420(defmethod allocate-instance ((class structure-class) &rest initargs)
1421  (%make-structure (class-name class)
1422                   (make-list (length (class-slots class))
1423                              :initial-element +slot-unbound+)))
1424
1425(defgeneric make-instance (class &key))
1426
1427(defmethod make-instance ((class standard-class) &rest initargs)
1428  (let ((class-default-initargs (class-default-initargs class)))
1429    (when class-default-initargs
1430      (let ((default-initargs ())
1431            (not-found (gensym)))
1432        (do* ((list class-default-initargs (cddr list))
1433              (key (car list) (car list))
1434              (fn (cadr list) (cadr list)))
1435             ((null list))
1436          (when (eq (getf initargs key not-found) not-found)
1437            (setf default-initargs (append default-initargs (list key (funcall fn))))))
1438        (setf initargs (append initargs default-initargs)))))
1439  (let ((instance (std-allocate-instance class)))
1440    (apply #'initialize-instance instance initargs)
1441    instance))
1442
1443(defmethod make-instance ((class symbol) &rest initargs)
1444  (apply #'make-instance (find-class class) initargs))
1445
1446(defgeneric initialize-instance (instance &key))
1447
1448(defmethod initialize-instance ((instance standard-object) &rest initargs)
1449  (apply #'shared-initialize instance t initargs))
1450
1451(defgeneric reinitialize-instance (instance &key))
1452
1453(defmethod reinitialize-instance
1454  ((instance standard-object) &rest initargs)
1455  (apply #'shared-initialize instance () initargs))
1456
1457(defun std-shared-initialize (instance slot-names all-keys)
1458  (dolist (slot (class-slots (class-of instance)))
1459    (let ((slot-name (slot-definition-name slot)))
1460      (multiple-value-bind (init-key init-value foundp)
1461        (get-properties all-keys (slot-definition-initargs slot))
1462        (if foundp
1463            (setf (std-slot-value instance slot-name) init-value)
1464            (when (and (not (std-slot-boundp instance slot-name))
1465                       (slot-definition-initfunction slot)
1466                       (or (eq slot-names t)
1467                           (member slot-name slot-names)))
1468              (setf (std-slot-value instance slot-name)
1469                    (funcall (slot-definition-initfunction slot))))))))
1470  instance)
1471
1472(defgeneric shared-initialize (instance slot-names &key))
1473
1474(defmethod shared-initialize ((instance standard-object)
1475                              slot-names &rest all-keys)
1476  (std-shared-initialize instance slot-names all-keys))
1477
1478;;; change-class
1479
1480(defgeneric change-class (instance new-class &key))
1481
1482(defmethod change-class ((old-instance standard-object) (new-class standard-class)
1483                         &rest initargs)
1484  (let ((new-instance (allocate-instance new-class)))
1485    (dolist (slot-name (mapcar #'slot-definition-name
1486                               (class-slots new-class)))
1487      (when (and (slot-exists-p old-instance slot-name)
1488                 (slot-boundp old-instance slot-name))
1489        (setf (slot-value new-instance slot-name)
1490              (slot-value old-instance slot-name))))
1491    (rotatef (std-instance-slots new-instance)
1492             (std-instance-slots old-instance))
1493    (rotatef (std-instance-layout new-instance)
1494             (std-instance-layout old-instance))
1495    (apply #'update-instance-for-different-class
1496           new-instance old-instance initargs)
1497    old-instance))
1498
1499(defmethod change-class ((instance standard-object) (new-class symbol) &rest initargs)
1500  (apply #'change-class instance (find-class new-class) initargs))
1501
1502(defgeneric update-instance-for-different-class (old new &key))
1503
1504(defmethod update-instance-for-different-class
1505  ((old standard-object) (new standard-object) &rest initargs)
1506  (let ((added-slots
1507         (remove-if #'(lambda (slot-name)
1508                       (slot-exists-p old slot-name))
1509                    (mapcar #'slot-definition-name
1510                            (class-slots (class-of new))))))
1511    (apply #'shared-initialize new added-slots initargs)))
1512
1513;;;  Methods having to do with class metaobjects.
1514
1515(defmethod initialize-instance :after ((class standard-class) &rest args)
1516  (apply #'std-after-initialization-for-classes class args))
1517
1518;;; Finalize inheritance
1519
1520(defgeneric finalize-inheritance (class))
1521(defmethod finalize-inheritance ((class standard-class))
1522  (std-finalize-inheritance class)
1523  (values))
1524
1525;;; Class precedence lists
1526
1527(defgeneric compute-class-precedence-list (class))
1528(defmethod compute-class-precedence-list ((class standard-class))
1529  (std-compute-class-precedence-list class))
1530
1531;;; Slot inheritance
1532
1533(defgeneric compute-slots (class))
1534(defmethod compute-slots ((class standard-class))
1535  (std-compute-slots class))
1536
1537(defgeneric compute-effective-slot-definition (class direct-slots))
1538(defmethod compute-effective-slot-definition
1539  ((class standard-class) direct-slots)
1540  (std-compute-effective-slot-definition class direct-slots))
1541
1542;;; Methods having to do with generic function metaobjects.
1543
1544(defmethod initialize-instance :after ((gf standard-generic-function) &key)
1545  (finalize-generic-function gf))
1546
1547;;; Methods having to do with method metaobjects.
1548
1549(defmethod initialize-instance :after ((method standard-method) &key)
1550  (setf (method-function method) (compute-method-function method)))
1551
1552;;; Methods having to do with generic function invocation.
1553
1554(defgeneric compute-discriminating-function (gf))
1555(defmethod compute-discriminating-function ((gf standard-generic-function))
1556  (std-compute-discriminating-function gf))
1557
1558(defgeneric method-more-specific-p (gf method1 method2 required-classes))
1559
1560(defmethod method-more-specific-p ((gf standard-generic-function)
1561                                   method1 method2 required-classes)
1562  (std-method-more-specific-p method1 method2 required-classes))
1563
1564(defgeneric compute-effective-method-function (gf methods))
1565(defmethod compute-effective-method-function ((gf standard-generic-function) methods)
1566  (std-compute-effective-method-function gf methods))
1567
1568(defgeneric compute-method-function (method))
1569(defmethod compute-method-function ((method standard-method))
1570  (std-compute-method-function method))
1571
1572(defgeneric compute-applicable-methods (gf args))
1573(defmethod compute-applicable-methods ((gf standard-generic-function) args)
1574  (compute-applicable-methods-using-classes gf (mapcar #'class-of args)))
1575
1576;;; Conditions.
1577
1578(defmacro define-condition (name (&rest parent-types) (&rest slot-specs)
1579         &body options)
1580  (let ((parent-types (or parent-types '(condition)))
1581        (report nil))
1582    (dolist (option options)
1583      (when (eq (car option) :report)
1584        (let ((arg (cadr option)))
1585          (setf report
1586                (if (stringp arg)
1587                    `#'(lambda (condition stream)
1588                        (declare (ignore condition))
1589                        (write-string ,arg stream))
1590                    `#'(lambda (condition stream)
1591                        (funcall #',arg condition stream)))))))
1592    `(progn
1593       (defclass ,name ,parent-types ,slot-specs ,@options)
1594       (defmethod print-object ((condition ,name) stream)
1595         (if *print-escape*
1596             (call-next-method)
1597             (funcall ,report condition stream)))
1598       ',name)))
1599
1600(defun make-condition (type &rest initargs)
1601  (or (%make-condition type initargs)
1602      (apply #'make-instance (find-class type) initargs)))
1603
1604(provide 'clos)
Note: See TracBrowser for help on using the repository browser.