source: trunk/j/src/org/armedbear/lisp/defclass.lisp @ 4309

Last change on this file since 4309 was 4309, checked in by piso, 19 years ago

Work in progress.

File size: 42.4 KB
Line 
1;;; defclass.lisp
2;;;
3;;; Copyright (C) 2003 Peter Graves
4;;; $Id: defclass.lisp,v 1.8 2003-10-11 17:31:00 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(in-package "SYSTEM")
21
22(defmacro push-on-end (value location)
23  `(setf ,location (nconc ,location (list ,value))))
24
25;;; (SETF GETF*) is like (SETF GETF) except that it always changes the list,
26;;; which must be non-nil.
27
28(defun (setf getf*) (new-value plist key)
29  (block body
30    (do ((x plist (cddr x)))
31        ((null x))
32      (when (eq (car x) key)
33        (setf (car (cdr x)) new-value)
34        (return-from body new-value)))
35    (push-on-end key plist)
36    (push-on-end new-value plist)
37    new-value))
38
39(defun mapappend (fun &rest args)
40  (if (some #'null args)
41      ()
42      (append (apply fun (mapcar #'car args))
43              (apply #'mapappend fun (mapcar #'cdr args)))))
44
45(defun mapplist (fun x)
46  (if (null x)
47      ()
48      (cons (funcall fun (car x) (cadr x))
49            (mapplist fun (cddr x)))))
50
51(defsetf class-name %set-class-name)
52(defsetf class-direct-superclasses %set-class-direct-superclasses)
53(defsetf class-direct-subclasses %set-class-direct-subclasses)
54(defsetf class-direct-methods %set-class-direct-methods)
55(defsetf class-direct-slots %set-class-direct-slots)
56(defsetf class-precedence-list %set-class-precedence-list)
57(defsetf class-slots %set-class-slots)
58
59(defun canonicalize-direct-slots (direct-slots)
60  `(list ,@(mapcar #'canonicalize-direct-slot direct-slots)))
61
62(defun canonicalize-direct-slot (spec)
63  (if (symbolp spec)
64      `(list :name ',spec)
65      (let ((name (car spec))
66            (initfunction nil)
67            (initform nil)
68            (initargs ())
69            (readers ())
70            (writers ())
71            (other-options ()))
72        (do ((olist (cdr spec) (cddr olist)))
73            ((null olist))
74          (case (car olist)
75            (:initform
76             (setq initfunction
77                   `(function (lambda () ,(cadr olist))))
78             (setq initform `',(cadr olist)))
79            (:initarg
80             (push-on-end (cadr olist) initargs))
81            (:reader
82             (push-on-end (cadr olist) readers))
83            (:writer
84             (push-on-end (cadr olist) writers))
85            (:accessor
86             (push-on-end (cadr olist) readers)
87             (push-on-end `(setf ,(cadr olist)) writers))
88            (otherwise
89             (push-on-end `',(car olist) other-options)
90             (push-on-end `',(cadr olist) other-options))))
91        `(list
92          :name ',name
93          ,@(when initfunction
94              `(:initform ,initform
95                          :initfunction ,initfunction))
96          ,@(when initargs `(:initargs ',initargs))
97          ,@(when readers `(:readers ',readers))
98          ,@(when writers `(:writers ',writers))
99          ,@other-options))))
100
101(defun canonicalize-direct-superclasses (direct-superclasses)
102  `(list ,@(mapcar #'canonicalize-direct-superclass direct-superclasses)))
103
104(defun canonicalize-direct-superclass (class-name)
105  `(find-class ',class-name))
106
107(defun canonicalize-defclass-options (options)
108  (mapappend #'canonicalize-defclass-option options))
109
110(defun canonicalize-defclass-option (option)
111  (case (car option)
112    (:metaclass
113     (list ':metaclass
114           `(find-class ',(cadr option))))
115    (:default-initargs
116     (list
117      ':direct-default-initargs
118      `(list ,@(mapappend
119                #'(lambda (x) x)
120                (mapplist
121                 #'(lambda (key value)
122                    `(',key ,value))
123                 (cdr option))))))
124    (t (list `',(car option) `',(cadr option)))))
125
126;;; Slot definition metaobjects
127
128;;; N.B. Quietly retain all unknown slot options (rather than signaling an
129;;; error), so that it's easy to add new ones.
130
131(defun make-direct-slot-definition
132  (&rest properties
133         &key name (initargs ()) (initform nil) (initfunction nil)
134         (readers ()) (writers ()) (allocation :instance)
135         &allow-other-keys)
136  (let ((slot (copy-list properties))) ; Don't want to side effect &rest list
137    (setf (getf* slot ':name) name)
138    (setf (getf* slot ':initargs) initargs)
139    (setf (getf* slot ':initform) initform)
140    (setf (getf* slot ':initfunction) initfunction)
141    (setf (getf* slot ':readers) readers)
142    (setf (getf* slot ':writers) writers)
143    (setf (getf* slot ':allocation) allocation)
144    slot))
145
146(defun make-effective-slot-definition
147  (&rest properties
148         &key name (initargs ()) (initform nil) (initfunction nil)
149         (allocation :instance)
150         &allow-other-keys)
151  (let ((slot (copy-list properties)))  ; Don't want to side effect &rest list
152    (setf (getf* slot ':name) name)
153    (setf (getf* slot ':initargs) initargs)
154    (setf (getf* slot ':initform) initform)
155    (setf (getf* slot ':initfunction) initfunction)
156    (setf (getf* slot ':allocation) allocation)
157    slot))
158
159(defun slot-definition-name (slot)
160  (getf slot ':name))
161(defun (setf slot-definition-name) (new-value slot)
162  (setf (getf* slot ':name) new-value))
163
164(defun slot-definition-initfunction (slot)
165  (getf slot ':initfunction))
166(defun (setf slot-definition-initfunction) (new-value slot)
167  (setf (getf* slot ':initfunction) new-value))
168
169(defun slot-definition-initform (slot)
170  (getf slot ':initform))
171(defun (setf slot-definition-initform) (new-value slot)
172  (setf (getf* slot ':initform) new-value))
173
174(defun slot-definition-initargs (slot)
175  (getf slot ':initargs))
176(defun (setf slot-definition-initargs) (new-value slot)
177  (setf (getf* slot ':initargs) new-value))
178
179(defun slot-definition-readers (slot)
180  (getf slot ':readers))
181(defun (setf slot-definition-readers) (new-value slot)
182  (setf (getf* slot ':readers) new-value))
183
184(defun slot-definition-writers (slot)
185  (getf slot ':writers))
186(defun (setf slot-definition-writers) (new-value slot)
187  (setf (getf* slot ':writers) new-value))
188
189(defun slot-definition-allocation (slot)
190  (getf slot ':allocation))
191(defun (setf slot-definition-allocation) (new-value slot)
192  (setf (getf* slot ':allocation) new-value))
193
194;;; finalize-inheritance
195
196(defun std-finalize-inheritance (class)
197  (setf (class-precedence-list class)
198        (funcall (if (eq (class-of class) the-class-standard-class)
199                     #'std-compute-class-precedence-list
200                     #'compute-class-precedence-list)
201                 class))
202  (setf (class-slots class)
203        (funcall (if (eq (class-of class) the-class-standard-class)
204                     #'std-compute-slots
205                     #'compute-slots)
206                 class))
207  (values))
208
209;;; Class precedence lists
210
211(defun std-compute-class-precedence-list (class)
212  (let ((classes-to-order (collect-superclasses* class)))
213    (topological-sort classes-to-order
214                      (remove-duplicates
215                       (mapappend #'local-precedence-ordering
216                                  classes-to-order))
217                      #'std-tie-breaker-rule)))
218
219;;; topological-sort implements the standard algorithm for topologically
220;;; sorting an arbitrary set of elements while honoring the precedence
221;;; constraints given by a set of (X,Y) pairs that indicate that element
222;;; X must precede element Y.  The tie-breaker procedure is called when it
223;;; is necessary to choose from multiple minimal elements; both a list of
224;;; candidates and the ordering so far are provided as arguments.
225
226(defun topological-sort (elements constraints tie-breaker)
227  (let ((remaining-constraints constraints)
228        (remaining-elements elements)
229        (result ()))
230    (loop
231      (let ((minimal-elements
232             (remove-if
233              #'(lambda (class)
234                 (member class remaining-constraints
235                         :key #'cadr))
236              remaining-elements)))
237        (when (null minimal-elements)
238          (if (null remaining-elements)
239              (return-from topological-sort result)
240              (error "Inconsistent precedence graph.")))
241        (let ((choice (if (null (cdr minimal-elements))
242                          (car minimal-elements)
243                          (funcall tie-breaker
244                                   minimal-elements
245                                   result))))
246          (setq result (append result (list choice)))
247          (setq remaining-elements
248                (remove choice remaining-elements))
249          (setq remaining-constraints
250                (remove choice
251                        remaining-constraints
252                        :test #'member)))))))
253
254;;; In the event of a tie while topologically sorting class precedence lists,
255;;; the CLOS Specification says to "select the one that has a direct subclass
256;;; rightmost in the class precedence list computed so far."  The same result
257;;; is obtained by inspecting the partially constructed class precedence list
258;;; from right to left, looking for the first minimal element to show up among
259;;; the direct superclasses of the class precedence list constituent.
260;;; (There's a lemma that shows that this rule yields a unique result.)
261
262(defun std-tie-breaker-rule (minimal-elements cpl-so-far)
263  (dolist (cpl-constituent (reverse cpl-so-far))
264    (let* ((supers (class-direct-superclasses cpl-constituent))
265           (common (intersection minimal-elements supers)))
266      (when (not (null common))
267        (return-from std-tie-breaker-rule (car common))))))
268
269;;; This version of collect-superclasses* isn't bothered by cycles in the class
270;;; hierarchy, which sometimes happen by accident.
271
272(defun collect-superclasses* (class)
273  (labels ((all-superclasses-loop (seen superclasses)
274                                  (let ((to-be-processed
275                                         (set-difference superclasses seen)))
276                                    (if (null to-be-processed)
277                                        superclasses
278                                        (let ((class-to-process
279                                               (car to-be-processed)))
280                                          (all-superclasses-loop
281                                           (cons class-to-process seen)
282                                           (union (class-direct-superclasses
283                                                   class-to-process)
284                                                  superclasses)))))))
285          (all-superclasses-loop () (list class))))
286
287;;; The local precedence ordering of a class C with direct superclasses C_1,
288;;; C_2, ..., C_n is the set ((C C_1) (C_1 C_2) ...(C_n-1 C_n)).
289
290(defun local-precedence-ordering (class)
291  (mapcar #'list
292          (cons class
293                (butlast (class-direct-superclasses class)))
294          (class-direct-superclasses class)))
295
296;;; Slot inheritance
297
298(defun std-compute-slots (class)
299  (let* ((all-slots (mapappend #'class-direct-slots
300                               (class-precedence-list class)))
301         (all-names (remove-duplicates
302                     (mapcar #'slot-definition-name all-slots))))
303    (mapcar #'(lambda (name)
304               (funcall
305                (if (eq (class-of class) the-class-standard-class)
306                    #'std-compute-effective-slot-definition
307                    #'compute-effective-slot-definition)
308                class
309                (remove name all-slots
310                        :key #'slot-definition-name
311                        :test-not #'eq)))
312            all-names)))
313
314(defun std-compute-effective-slot-definition (class direct-slots)
315  (declare (ignore class))
316  (let ((initer (find-if-not #'null direct-slots
317                             :key #'slot-definition-initfunction)))
318    (make-effective-slot-definition
319     :name (slot-definition-name (car direct-slots))
320     :initform (if initer
321                   (slot-definition-initform initer)
322                   nil)
323     :initfunction (if initer
324                       (slot-definition-initfunction initer)
325                       nil)
326     :initargs (remove-duplicates
327                (mapappend #'slot-definition-initargs
328                           direct-slots))
329     :allocation (slot-definition-allocation (car direct-slots)))))
330
331;;; Simple vectors are used for slot storage.
332
333(defun allocate-slot-storage (size initial-value)
334  (make-array size :initial-element initial-value))
335
336;;; Standard instance slot access
337
338;;; N.B. The location of the effective-slots slots in the class metaobject for
339;;; standard-class must be determined without making any further slot
340;;; references.
341
342(defvar the-slots-of-standard-class) ;standard-class's class-slots
343(defvar the-class-standard-class (find-class 'standard-class))
344
345(defun slot-location (class slot-name)
346  (if (and (eq slot-name 'effective-slots)
347           (eq class the-class-standard-class))
348      (position 'effective-slots the-slots-of-standard-class
349                :key #'slot-definition-name)
350      (let ((slot (find slot-name
351                        (class-slots class)
352                        :key #'slot-definition-name)))
353        (if (null slot)
354            (error "the slot ~S is missing from the class ~S"
355                   slot-name class)
356            (let ((pos (position slot
357                                 (remove-if-not #'instance-slot-p
358                                                (class-slots class)))))
359              (if (null pos)
360                  (error "the slot ~S is not an instance slot in the class ~S"
361                         slot-name class)
362                  pos))))))
363
364(defun slot-contents (slots location)
365  (svref slots location))
366
367(defun (setf slot-contents) (new-value slots location)
368  (setf (svref slots location) new-value))
369
370(defun std-slot-value (instance slot-name)
371  (let* ((location (slot-location (class-of instance) slot-name))
372         (slots (std-instance-slots instance))
373         (val (slot-contents slots location)))
374    (if (eq secret-unbound-value val)
375        (error "The slot ~S is unbound in the object ~S."
376               slot-name instance)
377        val)))
378(defun slot-value (object slot-name)
379  (if (eq (class-of (class-of object)) the-class-standard-class)
380      (std-slot-value object slot-name)
381      (slot-value-using-class (class-of object) object slot-name)))
382
383(defun (setf std-slot-value) (new-value instance slot-name)
384  (let ((location (slot-location (class-of instance) slot-name))
385        (slots (std-instance-slots instance)))
386    (setf (slot-contents slots location) new-value)))
387(defun (setf slot-value) (new-value object slot-name)
388  (if (eq (class-of (class-of object)) the-class-standard-class)
389      (setf (std-slot-value object slot-name) new-value)
390      (setf-slot-value-using-class
391       new-value (class-of object) object slot-name)))
392
393(defun std-slot-boundp (instance slot-name)
394  (let ((location (slot-location (class-of instance) slot-name))
395        (slots (std-instance-slots instance)))
396    (not (eq secret-unbound-value (slot-contents slots location)))))
397(defun slot-boundp (object slot-name)
398  (if (eq (class-of (class-of object)) the-class-standard-class)
399      (std-slot-boundp object slot-name)
400      (slot-boundp-using-class (class-of object) object slot-name)))
401
402(defun std-slot-makunbound (instance slot-name)
403  (let ((location (slot-location (class-of instance) slot-name))
404        (slots (std-instance-slots instance)))
405    (setf (slot-contents slots location) secret-unbound-value))
406  instance)
407(defun slot-makunbound (object slot-name)
408  (if (eq (class-of (class-of object)) the-class-standard-class)
409      (std-slot-makunbound object slot-name)
410      (slot-makunbound-using-class (class-of object) object slot-name)))
411
412(defun std-slot-exists-p (instance slot-name)
413  (not (null (find slot-name (class-slots (class-of instance))
414                   :key #'slot-definition-name))))
415(defun slot-exists-p (object slot-name)
416  (if (eq (class-of (class-of object)) the-class-standard-class)
417      (std-slot-exists-p object slot-name)
418      (slot-exists-p-using-class (class-of object) object slot-name)))
419
420;;; Standard instance allocation
421
422(defparameter secret-unbound-value (list "slot unbound"))
423
424(defun instance-slot-p (slot)
425  (eq (slot-definition-allocation slot) ':instance))
426
427(defun std-allocate-instance (class)
428;;   (format t "std-allocate-instance class = ~S~%" class)
429;;   (format t "class-slots = ~S~%" (class-slots class))
430  (allocate-std-instance
431   class
432   (allocate-slot-storage (count-if #'instance-slot-p (class-slots class))
433                          secret-unbound-value)))
434
435(defun allocate-instance (class)
436  (std-allocate-instance class))
437
438(defun make-instance-standard-class (metaclass &key name direct-superclasses direct-slots
439                                               &allow-other-keys)
440  (declare (ignore metaclass))
441;;   (format t "name = ~S~%" name)
442;;   (format t "direct-superclasses = ~S~%" direct-superclasses)
443;;   (format t "direct-slots = ~S~%" direct-slots)
444  (let ((class (std-allocate-instance (find-class 'standard-class))))
445    (setf (class-name class) name)
446    (setf (class-direct-subclasses class) ())
447    (setf (class-direct-methods class) ())
448    (std-after-initialization-for-classes class
449                                          :direct-slots direct-slots
450                                          :direct-superclasses direct-superclasses)
451    class))
452
453;; FIXME
454(defun std-after-initialization-for-classes (class
455                                             &key direct-superclasses direct-slots
456                                             &allow-other-keys)
457  (let ((supers
458         (or direct-superclasses
459             (list (find-class 'standard-object)))))
460    (setf (class-direct-superclasses class) supers)
461    (dolist (superclass supers)
462      (push class (class-direct-subclasses superclass))))
463  (let ((slots
464         (mapcar #'(lambda (slot-properties)
465                    (apply #'make-direct-slot-definition
466                           slot-properties))
467                 direct-slots)))
468    (setf (class-direct-slots class) slots)
469;;     (dolist (direct-slot slots)
470;;       (dolist (reader (slot-definition-readers direct-slot))
471;;         (add-reader-method
472;;          class reader (slot-definition-name direct-slot)))
473;;       (dolist (writer (slot-definition-writers direct-slot))
474;;         (add-writer-method
475;;          class writer (slot-definition-name direct-slot))))
476    )
477  (funcall (if (eq (class-of class) (find-class 'standard-class))
478               #'std-finalize-inheritance
479               #'finalize-inheritance)
480           class)
481  (values))
482
483(defun ensure-class (name &rest all-keys &allow-other-keys)
484  (let ((class (find-class name nil)))
485    (unless class
486      (setf class (apply #'make-instance-standard-class (find-class 'standard-class) :name name all-keys))
487      (add-class class))
488    class))
489
490(defmacro defclass (name direct-superclasses direct-slots
491                         &rest options)
492  `(ensure-class ',name
493                 :direct-superclasses
494                 ,(canonicalize-direct-superclasses direct-superclasses)
495                 :direct-slots
496                 ,(canonicalize-direct-slots direct-slots)
497                 ,@(canonicalize-defclass-options options)))
498
499;;;
500;;; Generic function metaobjects and standard-generic-function
501;;;
502
503;; (defparameter the-defclass-standard-generic-function
504;;   '(defclass standard-generic-function ()
505;;     ((name :initarg :name)      ; :accessor generic-function-name
506;;      (lambda-list               ; :accessor generic-function-lambda-list
507;;       :initarg :lambda-list)
508;;      (methods :initform ())     ; :accessor generic-function-methods
509;;      (method-class              ; :accessor generic-function-method-class
510;;       :initarg :method-class)
511;;      (discriminating-function)  ; :accessor generic-function-
512;;      ;    -discriminating-function
513;;      (classes-to-emf-table      ; :accessor classes-to-emf-table
514;;       :initform (make-hash-table :test #'equal)))))
515
516(defclass standard-generic-function ()
517  ((name :initarg :name)      ; :accessor generic-function-name
518   (lambda-list               ; :accessor generic-function-lambda-list
519    :initarg :lambda-list)
520   (methods :initform ())     ; :accessor generic-function-methods
521   (method-class              ; :accessor generic-function-method-class
522    :initarg :method-class)
523   (discriminating-function)  ; :accessor generic-function-
524   ;    -discriminating-function
525   (classes-to-emf-table      ; :accessor classes-to-emf-table
526    :initform (make-hash-table :test #'equal))))
527
528(defvar the-class-standard-gf (find-class 'standard-generic-function))
529
530(defun generic-function-name (gf)
531  (slot-value gf 'name))
532(defun (setf generic-function-name) (new-value gf)
533  (setf (slot-value gf 'name) new-value))
534
535(defun generic-function-lambda-list (gf)
536  (slot-value gf 'lambda-list))
537(defun (setf generic-function-lambda-list) (new-value gf)
538  (setf (slot-value gf 'lambda-list) new-value))
539
540(defun generic-function-methods (gf)
541  (slot-value gf 'methods))
542(defun (setf generic-function-methods) (new-value gf)
543  (setf (slot-value gf 'methods) new-value))
544
545(defun generic-function-discriminating-function (gf)
546  (slot-value gf 'discriminating-function))
547(defun (setf generic-function-discriminating-function) (new-value gf)
548  (setf (slot-value gf 'discriminating-function) new-value))
549
550(defun generic-function-method-class (gf)
551  (slot-value gf 'method-class))
552(defun (setf generic-function-method-class) (new-value gf)
553  (setf (slot-value gf 'method-class) new-value))
554
555;;; Internal accessor for effective method function table
556
557(defun classes-to-emf-table (gf)
558  (slot-value gf 'classes-to-emf-table))
559(defun (setf classes-to-emf-table) (new-value gf)
560  (setf (slot-value gf 'classes-to-emf-table) new-value))
561
562;;;
563;;; Method metaobjects and standard-method
564;;;
565
566(defparameter the-defclass-standard-method
567  '(defclass standard-method ()
568    ((lambda-list :initarg :lambda-list)     ; :accessor method-lambda-list
569     (qualifiers :initarg :qualifiers)       ; :accessor method-qualifiers
570     (specializers :initarg :specializers)   ; :accessor method-specializers
571     (body :initarg :body)                   ; :accessor method-body
572     (environment :initarg :environment)     ; :accessor method-environment
573     (generic-function :initform nil)        ; :accessor method-generic-function
574     (function))))                           ; :accessor method-function
575
576(defvar the-class-standard-method (find-class 'standard-method))
577
578(defun method-lambda-list (method) (slot-value method 'lambda-list))
579(defun (setf method-lambda-list) (new-value method)
580  (setf (slot-value method 'lambda-list) new-value))
581
582(defun method-qualifiers (method) (slot-value method 'qualifiers))
583(defun (setf method-qualifiers) (new-value method)
584  (setf (slot-value method 'qualifiers) new-value))
585
586(defun method-specializers (method) (slot-value method 'specializers))
587(defun (setf method-specializers) (new-value method)
588  (setf (slot-value method 'specializers) new-value))
589
590(defun method-body (method) (slot-value method 'body))
591(defun (setf method-body) (new-value method)
592  (setf (slot-value method 'body) new-value))
593
594(defun method-environment (method) (slot-value method 'environment))
595(defun (setf method-environment) (new-value method)
596  (setf (slot-value method 'environment) new-value))
597
598(defun method-generic-function (method)
599  (slot-value method 'generic-function))
600(defun (setf method-generic-function) (new-value method)
601  (setf (slot-value method 'generic-function) new-value))
602
603(defun method-function (method) (slot-value method 'function))
604(defun (setf method-function) (new-value method)
605  (setf (slot-value method 'function) new-value))
606
607;;; defgeneric
608
609(defmacro defgeneric (function-name lambda-list
610                                    &rest options-and-method-descriptions)
611  (let ((options ())
612        (methods ()))
613    (dolist (item options-and-method-descriptions)
614      (case (car item)
615        (declare) ; FIXME
616        (:method
617         (push `(defmethod ,function-name ,@(cdr item)) methods))
618        (t
619         (push item options))))
620    (setf options (nreverse options)
621          methods (nreverse methods))
622    `(prog1
623       (ensure-generic-function
624        ',function-name
625        :lambda-list ',lambda-list
626        ,@(canonicalize-defgeneric-options options))
627       ,@methods)))
628
629(defun canonicalize-defgeneric-options (options)
630  (mapappend #'canonicalize-defgeneric-option options))
631
632(defun canonicalize-defgeneric-option (option)
633  (case (car option)
634    (:generic-function-class
635     (list ':generic-function-class
636           `(find-class ',(cadr option))))
637    (:method-class
638     (list ':method-class
639           `(find-class ',(cadr option))))
640    (t (list `',(car option) `',(cadr option)))))
641
642;;; find-generic-function looks up a generic function by name.  It's an
643;;; artifact of the fact that our generic function metaobjects can't legally
644;;; be stored a symbol's function value.
645
646(defparameter generic-function-table (make-hash-table :test #'equal))
647
648(defun find-generic-function (symbol &optional (errorp t))
649  (let ((gf (gethash symbol generic-function-table nil)))
650    (if (and (null gf) errorp)
651        (error "No generic function named ~S." symbol)
652        gf)))
653
654(defun (setf find-generic-function) (new-value symbol)
655  (setf (gethash symbol generic-function-table) new-value))
656
657;;; ensure-generic-function
658
659(defun ensure-generic-function
660  (function-name
661   &rest all-keys
662   &key (generic-function-class the-class-standard-gf)
663   (method-class the-class-standard-method)
664   &allow-other-keys)
665  (format t "ensure-generic-function function-name = ~S~%" function-name)
666  (when (fboundp function-name)
667    (error "~A already names an ordinary function, macro, or special operator"
668           function-name))
669  (if (find-generic-function function-name nil)
670      (find-generic-function function-name)
671      (let ((gf (apply (if (eq generic-function-class the-class-standard-gf)
672                           #'make-instance-standard-generic-function
673                           #'make-instance)
674                       generic-function-class
675                       :name function-name
676                       :method-class method-class
677                       all-keys)))
678        (setf (find-generic-function function-name) gf)
679        gf)))
680
681;;; finalize-generic-function
682
683;;; N.B. Same basic idea as finalize-inheritance.  Takes care of recomputing
684;;; and storing the discriminating function, and clearing the effective method
685;;; function table.
686
687(defun finalize-generic-function (gf)
688  (setf (generic-function-discriminating-function gf)
689        (funcall (if (eq (class-of gf) the-class-standard-gf)
690                     #'std-compute-discriminating-function
691                     #'compute-discriminating-function)
692                 gf))
693  (setf (fdefinition (generic-function-name gf))
694        (generic-function-discriminating-function gf))
695  (clrhash (classes-to-emf-table gf))
696  (values))
697
698;;; make-instance-standard-generic-function creates and initializes an
699;;; instance of standard-generic-function without falling into method lookup.
700;;; However, it cannot be called until standard-generic-function exists.
701
702(defun make-instance-standard-generic-function (generic-function-class
703                                                &key name lambda-list method-class)
704  (declare (ignore generic-function-class))
705  (let ((gf (std-allocate-instance the-class-standard-gf)))
706    (format t "gf = ~S~%" gf)
707    (setf (generic-function-name gf) name)
708    (setf (generic-function-lambda-list gf) lambda-list)
709    (setf (generic-function-methods gf) ())
710    (setf (generic-function-method-class gf) method-class)
711    (setf (classes-to-emf-table gf) (make-hash-table :test #'equal))
712    (finalize-generic-function gf)
713    gf))
714
715;;; defmethod
716
717;; (defmacro defmethod (&rest args)
718;;   (multiple-value-bind (function-name qualifiers
719;;                                       lambda-list specializers body)
720;;     (parse-defmethod args)
721;;     `(ensure-method (find-generic-function ',function-name)
722;;                     :lambda-list ',lambda-list
723;;                     :qualifiers ',qualifiers
724;;                     :specializers ,(canonicalize-specializers specializers)
725;;                     :body ',body
726;;                     :environment (top-level-environment))))
727
728(defun canonicalize-specializers (specializers)
729  `(list ,@(mapcar #'canonicalize-specializer specializers)))
730
731(defun canonicalize-specializer (specializer)
732  `(find-class ',specializer))
733
734(defun parse-defmethod (args)
735  (let ((fn-spec (car args))
736        (qualifiers ())
737        (specialized-lambda-list nil)
738        (body ())
739        (parse-state :qualifiers))
740    (dolist (arg (cdr args))
741      (ecase parse-state
742        (:qualifiers
743         (if (and (atom arg) (not (null arg)))
744             (push-on-end arg qualifiers)
745             (progn (setq specialized-lambda-list arg)
746               (setq parse-state :body))))
747        (:body (push-on-end arg body))))
748    (values fn-spec
749            qualifiers
750            (extract-lambda-list specialized-lambda-list)
751            (extract-specializers specialized-lambda-list)
752            (list* 'block
753                   (if (consp fn-spec)
754                       (cadr fn-spec)
755                       fn-spec)
756                   body))))
757
758;;; Several tedious functions for analyzing lambda lists
759
760(defun required-portion (gf args)
761  (let ((number-required (length (gf-required-arglist gf))))
762    (when (< (length args) number-required)
763      (error "Too few arguments to generic function ~S." gf))
764    (subseq args 0 number-required)))
765
766(defun gf-required-arglist (gf)
767  (let ((plist
768         (analyze-lambda-list
769          (generic-function-lambda-list gf))))
770    (getf plist ':required-args)))
771
772(defun extract-lambda-list (specialized-lambda-list)
773  (let* ((plist (analyze-lambda-list specialized-lambda-list))
774         (requireds (getf plist ':required-names))
775         (rv (getf plist ':rest-var))
776         (ks (getf plist ':key-args))
777         (aok (getf plist ':allow-other-keys))
778         (opts (getf plist ':optional-args))
779         (auxs (getf plist ':auxiliary-args)))
780    `(,@requireds
781      ,@(if rv `(&rest ,rv) ())
782      ,@(if (or ks aok) `(&key ,@ks) ())
783      ,@(if aok '(&allow-other-keys) ())
784      ,@(if opts `(&optional ,@opts) ())
785      ,@(if auxs `(&aux ,@auxs) ()))))
786
787(defun extract-specializers (specialized-lambda-list)
788  (let ((plist (analyze-lambda-list specialized-lambda-list)))
789    (getf plist ':specializers)))
790
791(defun analyze-lambda-list (lambda-list)
792  (labels ((make-keyword (symbol)
793                         (intern (symbol-name symbol)
794                                 (find-package 'keyword)))
795           (get-keyword-from-arg (arg)
796                                 (if (listp arg)
797                                     (if (listp (car arg))
798                                         (caar arg)
799                                         (make-keyword (car arg)))
800                                     (make-keyword arg))))
801          (let ((keys ())           ; Just the keywords
802                (key-args ())       ; Keywords argument specs
803                (required-names ()) ; Just the variable names
804                (required-args ())  ; Variable names & specializers
805                (specializers ())   ; Just the specializers
806                (rest-var nil)
807                (optionals ())
808                (auxs ())
809                (allow-other-keys nil)
810                (state :parsing-required))
811            (dolist (arg lambda-list)
812              (if (member arg lambda-list-keywords)
813                  (ecase arg
814                    (&optional
815                     (setq state :parsing-optional))
816                    (&rest
817                     (setq state :parsing-rest))
818                    (&key
819                     (setq state :parsing-key))
820                    (&allow-other-keys
821                     (setq allow-other-keys 't))
822                    (&aux
823                     (setq state :parsing-aux)))
824                  (case state
825                    (:parsing-required
826                     (push-on-end arg required-args)
827                     (if (listp arg)
828                         (progn (push-on-end (car arg) required-names)
829                           (push-on-end (cadr arg) specializers))
830                         (progn (push-on-end arg required-names)
831                           (push-on-end 't specializers))))
832                    (:parsing-optional (push-on-end arg optionals))
833                    (:parsing-rest (setq rest-var arg))
834                    (:parsing-key
835                     (push-on-end (get-keyword-from-arg arg) keys)
836                     (push-on-end arg key-args))
837                    (:parsing-aux (push-on-end arg auxs)))))
838            (list  :required-names required-names
839                   :required-args required-args
840                   :specializers specializers
841                   :rest-var rest-var
842                   :keywords keys
843                   :key-args key-args
844                   :auxiliary-args auxs
845                   :optional-args optionals
846                   :allow-other-keys allow-other-keys))))
847
848;;; ensure method
849
850(defun ensure-method (gf &rest all-keys)
851  (let ((new-method
852         (apply
853          (if (eq (generic-function-method-class gf)
854                  the-class-standard-method)
855              #'make-instance-standard-method
856              #'make-instance)
857          (generic-function-method-class gf)
858          all-keys)))
859    (add-method gf new-method)
860    new-method))
861
862;;; make-instance-standard-method creates and initializes an instance of
863;;; standard-method without falling into method lookup.  However, it cannot
864;;; be called until standard-method exists.
865
866(defun make-instance-standard-method (method-class
867                                      &key lambda-list qualifiers
868                                      specializers body environment)
869  (declare (ignore method-class))
870  (let ((method (std-allocate-instance the-class-standard-method)))
871    (setf (method-lambda-list method) lambda-list)
872    (setf (method-qualifiers method) qualifiers)
873    (setf (method-specializers method) specializers)
874    (setf (method-body method) body)
875    (setf (method-environment method) environment)
876    (setf (method-generic-function method) nil)
877    (setf (method-function method)
878          (std-compute-method-function method))
879    method))
880
881;;; add-method
882
883;;; N.B. This version first removes any existing method on the generic function
884;;; with the same qualifiers and specializers.  It's a pain to develop
885;;; programs without this feature of full CLOS.
886
887(defun add-method (gf method)
888  (let ((old-method
889         (find-method gf (method-qualifiers method)
890                      (method-specializers method) nil)))
891    (when old-method (remove-method gf old-method)))
892  (setf (method-generic-function method) gf)
893  (push method (generic-function-methods gf))
894  (dolist (specializer (method-specializers method))
895    (pushnew method (class-direct-methods specializer)))
896  (finalize-generic-function gf)
897  method)
898
899(defun remove-method (gf method)
900  (setf (generic-function-methods gf)
901        (remove method (generic-function-methods gf)))
902  (setf (method-generic-function method) nil)
903  (dolist (class (method-specializers method))
904    (setf (class-direct-methods class)
905          (remove method (class-direct-methods class))))
906  (finalize-generic-function gf)
907  method)
908
909(defun find-method (gf qualifiers specializers
910                       &optional (errorp t))
911  (let ((method
912         (find-if #'(lambda (method)
913                     (and (equal qualifiers
914                                 (method-qualifiers method))
915                          (equal specializers
916                                 (method-specializers method))))
917                  (generic-function-methods gf))))
918    (if (and (null method) errorp)
919        (error "No such method for ~S." (generic-function-name gf))
920        method)))
921
922;;; Reader and write methods
923
924(defun add-reader-method (class fn-name slot-name)
925  (ensure-method
926   (ensure-generic-function fn-name :lambda-list '(object))
927   :lambda-list '(object)
928   :qualifiers ()
929   :specializers (list class)
930   :body `(slot-value object ',slot-name)
931   :environment (top-level-environment))
932  (values))
933
934(defun add-writer-method (class fn-name slot-name)
935  (ensure-method
936   (ensure-generic-function
937    fn-name :lambda-list '(new-value object))
938   :lambda-list '(new-value object)
939   :qualifiers ()
940   :specializers (list (find-class 't) class)
941   :body `(setf (slot-value object ',slot-name)
942                new-value)
943   :environment (top-level-environment))
944  (values))
945
946;;;
947;;; Generic function invocation
948;;;
949
950;;; apply-generic-function
951
952(defun apply-generic-function (gf args)
953  (apply (generic-function-discriminating-function gf) args))
954
955;;; compute-discriminating-function
956
957(defun std-compute-discriminating-function (gf)
958  #'(lambda (&rest args)
959     (let* ((classes (mapcar #'class-of
960                             (required-portion gf args)))
961            (emfun (gethash classes (classes-to-emf-table gf) nil)))
962       (if emfun
963           (funcall emfun args)
964           (slow-method-lookup gf args classes)))))
965
966(defun slow-method-lookup (gf args classes)
967  (let* ((applicable-methods
968          (compute-applicable-methods-using-classes gf classes))
969         (emfun
970          (funcall
971           (if (eq (class-of gf) the-class-standard-gf)
972               #'std-compute-effective-method-function
973               #'compute-effective-method-function)
974           gf applicable-methods)))
975    (setf (gethash classes (classes-to-emf-table gf)) emfun)
976    (funcall emfun args)))
977
978;;; compute-applicable-methods-using-classes
979
980(defun compute-applicable-methods-using-classes
981  (gf required-classes)
982  (sort
983   (copy-list
984    (remove-if-not #'(lambda (method)
985                      (every #'subclassp
986                             required-classes
987                             (method-specializers method)))
988                   (generic-function-methods gf)))
989   #'(lambda (m1 m2)
990      (funcall
991       (if (eq (class-of gf) the-class-standard-gf)
992           #'std-method-more-specific-p
993           #'method-more-specific-p)
994       gf m1 m2 required-classes))))
995
996;;; method-more-specific-p
997
998(defun std-method-more-specific-p (gf method1 method2 required-classes)
999  (declare (ignore gf))
1000  (mapc #'(lambda (spec1 spec2 arg-class)
1001           (unless (eq spec1 spec2)
1002             (return-from std-method-more-specific-p
1003                          (sub-specializer-p spec1 spec2 arg-class))))
1004        (method-specializers method1)
1005        (method-specializers method2)
1006        required-classes)
1007  nil)
1008
1009;;; apply-methods and compute-effective-method-function
1010
1011(defun apply-methods (gf args methods)
1012  (funcall (compute-effective-method-function gf methods)
1013           args))
1014
1015(defun primary-method-p (method)
1016  (null (method-qualifiers method)))
1017(defun before-method-p (method)
1018  (equal '(:before) (method-qualifiers method)))
1019(defun after-method-p (method)
1020  (equal '(:after) (method-qualifiers method)))
1021(defun around-method-p (method)
1022  (equal '(:around) (method-qualifiers method)))
1023
1024(defun std-compute-effective-method-function (gf methods)
1025  (let ((primaries (remove-if-not #'primary-method-p methods))
1026        (around (find-if #'around-method-p methods)))
1027    (when (null primaries)
1028      (error "No primary methods for the~@
1029      generic function ~S." gf))
1030    (if around
1031        (let ((next-emfun
1032               (funcall
1033                (if (eq (class-of gf) the-class-standard-gf)
1034                    #'std-compute-effective-method-function
1035                    #'compute-effective-method-function)
1036                gf (remove around methods))))
1037          #'(lambda (args)
1038             (funcall (method-function around) args next-emfun)))
1039        (let ((next-emfun (compute-primary-emfun (cdr primaries)))
1040              (befores (remove-if-not #'before-method-p methods))
1041              (reverse-afters
1042               (reverse (remove-if-not #'after-method-p methods))))
1043          #'(lambda (args)
1044             (dolist (before befores)
1045               (funcall (method-function before) args nil))
1046             (multiple-value-prog1
1047              (funcall (method-function (car primaries)) args next-emfun)
1048              (dolist (after reverse-afters)
1049                (funcall (method-function after) args nil))))))))
1050
1051;;; compute an effective method function from a list of primary methods:
1052
1053(defun compute-primary-emfun (methods)
1054  (if (null methods)
1055      nil
1056      (let ((next-emfun (compute-primary-emfun (cdr methods))))
1057        #'(lambda (args)
1058           (funcall (method-function (car methods)) args next-emfun)))))
1059
1060;;; apply-method and compute-method-function
1061
1062(defun apply-method (method args next-methods)
1063  (funcall (method-function method)
1064           args
1065           (if (null next-methods)
1066               nil
1067               (compute-effective-method-function
1068                (method-generic-function method) next-methods))))
1069
1070(defun std-compute-method-function (method)
1071  (let ((form (method-body method))
1072        (lambda-list (method-lambda-list method)))
1073    (compile-in-lexical-environment (method-environment method)
1074                                    `(lambda (args next-emfun)
1075                                       (flet ((call-next-method (&rest cnm-args)
1076                                                                (if (null next-emfun)
1077                                                                    (error "No next method for the~@
1078                                                                    generic function ~S."
1079                                                                           (method-generic-function ',method))
1080                                                                    (funcall next-emfun (or cnm-args args))))
1081                                              (next-method-p ()
1082                                                             (not (null next-emfun))))
1083                                         (apply #'(lambda ,(kludge-arglist lambda-list)
1084                                                   ,form)
1085                                                args))))))
1086
1087;;; N.B. The function kludge-arglist is used to pave over the differences
1088;;; between argument keyword compatibility for regular functions versus
1089;;; generic functions.
1090
1091(defun kludge-arglist (lambda-list)
1092  (if (and (member '&key lambda-list)
1093           (not (member '&allow-other-keys lambda-list)))
1094      (append lambda-list '(&allow-other-keys))
1095      (if (and (not (member '&rest lambda-list))
1096               (not (member '&key lambda-list)))
1097          (append lambda-list '(&key &allow-other-keys))
1098          lambda-list)))
Note: See TracBrowser for help on using the repository browser.