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

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

Work in progress.

File size: 47.2 KB
Line 
1;;; defclass.lisp
2;;;
3;;; Copyright (C) 2003 Peter Graves
4;;; $Id: defclass.lisp,v 1.12 2003-10-11 19:49:14 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(defclass standard-generic-function ()
504  ((name :initarg :name)      ; :accessor generic-function-name
505   (lambda-list               ; :accessor generic-function-lambda-list
506    :initarg :lambda-list)
507   (methods :initform ())     ; :accessor generic-function-methods
508   (method-class              ; :accessor generic-function-method-class
509    :initarg :method-class)
510   (discriminating-function)  ; :accessor generic-function-
511   ;    -discriminating-function
512   (classes-to-emf-table      ; :accessor classes-to-emf-table
513    :initform (make-hash-table :test #'equal))))
514
515(defvar the-class-standard-gf (find-class 'standard-generic-function))
516
517(defun generic-function-name (gf)
518  (slot-value gf 'name))
519(defun (setf generic-function-name) (new-value gf)
520  (setf (slot-value gf 'name) new-value))
521
522(defun generic-function-lambda-list (gf)
523  (slot-value gf 'lambda-list))
524(defun (setf generic-function-lambda-list) (new-value gf)
525  (setf (slot-value gf 'lambda-list) new-value))
526
527(defun generic-function-methods (gf)
528  (slot-value gf 'methods))
529(defun (setf generic-function-methods) (new-value gf)
530  (setf (slot-value gf 'methods) new-value))
531
532(defun generic-function-discriminating-function (gf)
533  (slot-value gf 'discriminating-function))
534(defun (setf generic-function-discriminating-function) (new-value gf)
535  (setf (slot-value gf 'discriminating-function) new-value))
536
537(defun generic-function-method-class (gf)
538  (slot-value gf 'method-class))
539(defun (setf generic-function-method-class) (new-value gf)
540  (setf (slot-value gf 'method-class) new-value))
541
542;;; Internal accessor for effective method function table
543
544(defun classes-to-emf-table (gf)
545  (slot-value gf 'classes-to-emf-table))
546(defun (setf classes-to-emf-table) (new-value gf)
547  (setf (slot-value gf 'classes-to-emf-table) new-value))
548
549;;;
550;;; Method metaobjects and standard-method
551;;;
552
553(defclass standard-method ()
554  ((lambda-list :initarg :lambda-list)     ; :accessor method-lambda-list
555   (qualifiers :initarg :qualifiers)       ; :accessor method-qualifiers
556   (specializers :initarg :specializers)   ; :accessor method-specializers
557   (body :initarg :body)                   ; :accessor method-body
558   (environment :initarg :environment)     ; :accessor method-environment
559   (generic-function :initform nil)        ; :accessor method-generic-function
560   (function)))                            ; :accessor method-function
561
562(defvar the-class-standard-method (find-class 'standard-method))
563
564(defun method-lambda-list (method) (slot-value method 'lambda-list))
565(defun (setf method-lambda-list) (new-value method)
566  (setf (slot-value method 'lambda-list) new-value))
567
568(defun method-qualifiers (method) (slot-value method 'qualifiers))
569(defun (setf method-qualifiers) (new-value method)
570  (setf (slot-value method 'qualifiers) new-value))
571
572(defun method-specializers (method) (slot-value method 'specializers))
573(defun (setf method-specializers) (new-value method)
574  (setf (slot-value method 'specializers) new-value))
575
576(defun method-body (method) (slot-value method 'body))
577(defun (setf method-body) (new-value method)
578  (setf (slot-value method 'body) new-value))
579
580(defun method-environment (method) (slot-value method 'environment))
581(defun (setf method-environment) (new-value method)
582  (setf (slot-value method 'environment) new-value))
583
584(defun method-generic-function (method)
585  (slot-value method 'generic-function))
586(defun (setf method-generic-function) (new-value method)
587  (setf (slot-value method 'generic-function) new-value))
588
589(defun method-function (method) (slot-value method 'function))
590(defun (setf method-function) (new-value method)
591  (setf (slot-value method 'function) new-value))
592
593;;; defgeneric
594
595(defmacro defgeneric (function-name lambda-list
596                                    &rest options-and-method-descriptions)
597  (let ((options ())
598        (methods ()))
599    (dolist (item options-and-method-descriptions)
600      (case (car item)
601        (declare) ; FIXME
602        (:method
603         (push `(defmethod ,function-name ,@(cdr item)) methods))
604        (t
605         (push item options))))
606    (setf options (nreverse options)
607          methods (nreverse methods))
608    `(prog1
609       (ensure-generic-function
610        ',function-name
611        :lambda-list ',lambda-list
612        ,@(canonicalize-defgeneric-options options))
613       ,@methods)))
614
615(defun canonicalize-defgeneric-options (options)
616  (mapappend #'canonicalize-defgeneric-option options))
617
618(defun canonicalize-defgeneric-option (option)
619  (case (car option)
620    (:generic-function-class
621     (list ':generic-function-class
622           `(find-class ',(cadr option))))
623    (:method-class
624     (list ':method-class
625           `(find-class ',(cadr option))))
626    (t (list `',(car option) `',(cadr option)))))
627
628;;; find-generic-function looks up a generic function by name.  It's an
629;;; artifact of the fact that our generic function metaobjects can't legally
630;;; be stored a symbol's function value.
631
632(defparameter generic-function-table (make-hash-table :test #'equal))
633
634(defun find-generic-function (symbol &optional (errorp t))
635  (let ((gf (gethash symbol generic-function-table nil)))
636    (if (and (null gf) errorp)
637        (error "no generic function named ~S" symbol)
638        gf)))
639
640(defun (setf find-generic-function) (new-value symbol)
641  (setf (gethash symbol generic-function-table) new-value))
642
643;;; ensure-generic-function
644
645(defun ensure-generic-function
646  (function-name
647   &rest all-keys
648   &key (generic-function-class the-class-standard-gf)
649   (method-class the-class-standard-method)
650   &allow-other-keys)
651;;   (format t "ensure-generic-function function-name = ~S~%" function-name)
652;;   (when (fboundp function-name)
653;;     (error "~A already names an ordinary function, macro, or special operator"
654;;            function-name))
655  (if (find-generic-function function-name nil)
656      (find-generic-function function-name)
657      (progn
658        (when (fboundp function-name)
659          (error "~A already names an ordinary function, macro, or special operator"
660                 function-name))
661        (let ((gf (apply (if (eq generic-function-class the-class-standard-gf)
662                             #'make-instance-standard-generic-function
663                             #'make-instance)
664                         generic-function-class
665                         :name function-name
666                         :method-class method-class
667                         all-keys)))
668          (setf (find-generic-function function-name) gf)
669          gf))))
670
671;;; finalize-generic-function
672
673;;; N.B. Same basic idea as finalize-inheritance.  Takes care of recomputing
674;;; and storing the discriminating function, and clearing the effective method
675;;; function table.
676
677(defun finalize-generic-function (gf)
678  (setf (generic-function-discriminating-function gf)
679        (funcall (if (eq (class-of gf) the-class-standard-gf)
680                     #'std-compute-discriminating-function
681                     #'compute-discriminating-function)
682                 gf))
683  (setf (fdefinition (generic-function-name gf))
684        (generic-function-discriminating-function gf))
685  (clrhash (classes-to-emf-table gf))
686  (values))
687
688;;; make-instance-standard-generic-function creates and initializes an
689;;; instance of standard-generic-function without falling into method lookup.
690;;; However, it cannot be called until standard-generic-function exists.
691
692(defun make-instance-standard-generic-function (generic-function-class
693                                                &key name lambda-list method-class)
694  (declare (ignore generic-function-class))
695  (let ((gf (std-allocate-instance the-class-standard-gf)))
696;;     (format t "gf = ~S~%" gf)
697    (setf (generic-function-name gf) name)
698    (setf (generic-function-lambda-list gf) lambda-list)
699    (setf (generic-function-methods gf) ())
700    (setf (generic-function-method-class gf) method-class)
701    (setf (classes-to-emf-table gf) (make-hash-table :test #'equal))
702    (finalize-generic-function gf)
703    gf))
704
705;;; Run-time environment hacking (Common Lisp ain't got 'em).
706
707(defun top-level-environment ()
708  nil) ; Bogus top level lexical environment
709
710(defvar compile-methods nil)      ; by default, run everything interpreted
711
712(defun compile-in-lexical-environment (env lambda-expr)
713  (declare (ignore env))
714  (if compile-methods
715      (compile nil lambda-expr)
716      (eval `(function ,lambda-expr))))
717
718;;; defmethod
719
720(defmacro defmethod (&rest args)
721  (multiple-value-bind (function-name qualifiers lambda-list specializers
722                                      body)
723    (parse-defmethod args)
724    `(progn
725      (ensure-generic-function
726       ',function-name
727       :lambda-list ',lambda-list)
728      (ensure-method (find-generic-function ',function-name)
729                     :lambda-list ',lambda-list
730                     :qualifiers ',qualifiers
731                     :specializers ,(canonicalize-specializers specializers)
732                     :body ',body
733                     :environment (top-level-environment)))))
734
735(defun canonicalize-specializers (specializers)
736  `(list ,@(mapcar #'canonicalize-specializer specializers)))
737
738(defun canonicalize-specializer (specializer)
739  ;; FIXME (EQL specializers)
740  `(if (atom ',specializer) (find-class ',specializer) (find-class 't)))
741
742(defun parse-defmethod (args)
743  (let ((fn-spec (car args))
744        (qualifiers ())
745        (specialized-lambda-list nil)
746        (body ())
747        (parse-state :qualifiers))
748    (dolist (arg (cdr args))
749      (ecase parse-state
750        (:qualifiers
751         (if (and (atom arg) (not (null arg)))
752             (push-on-end arg qualifiers)
753             (progn (setq specialized-lambda-list arg)
754               (setq parse-state :body))))
755        (:body (push-on-end arg body))))
756    (values fn-spec
757            qualifiers
758            (extract-lambda-list specialized-lambda-list)
759            (extract-specializers specialized-lambda-list)
760            (list* 'block
761                   (if (consp fn-spec)
762                       (cadr fn-spec)
763                       fn-spec)
764                   body))))
765
766;;; Several tedious functions for analyzing lambda lists
767
768(defun required-portion (gf args)
769  (let ((number-required (length (gf-required-arglist gf))))
770    (when (< (length args) number-required)
771      (error "Too few arguments to generic function ~S." gf))
772    (subseq args 0 number-required)))
773
774(defun gf-required-arglist (gf)
775  (let ((plist
776         (analyze-lambda-list
777          (generic-function-lambda-list gf))))
778    (getf plist ':required-args)))
779
780(defun extract-lambda-list (specialized-lambda-list)
781  (let* ((plist (analyze-lambda-list specialized-lambda-list))
782         (requireds (getf plist ':required-names))
783         (rv (getf plist ':rest-var))
784         (ks (getf plist ':key-args))
785         (aok (getf plist ':allow-other-keys))
786         (opts (getf plist ':optional-args))
787         (auxs (getf plist ':auxiliary-args)))
788    `(,@requireds
789      ,@(if rv `(&rest ,rv) ())
790      ,@(if (or ks aok) `(&key ,@ks) ())
791      ,@(if aok '(&allow-other-keys) ())
792      ,@(if opts `(&optional ,@opts) ())
793      ,@(if auxs `(&aux ,@auxs) ()))))
794
795(defun extract-specializers (specialized-lambda-list)
796  (let ((plist (analyze-lambda-list specialized-lambda-list)))
797    (getf plist ':specializers)))
798
799(defun analyze-lambda-list (lambda-list)
800  (labels ((make-keyword (symbol)
801                         (intern (symbol-name symbol)
802                                 (find-package 'keyword)))
803           (get-keyword-from-arg (arg)
804                                 (if (listp arg)
805                                     (if (listp (car arg))
806                                         (caar arg)
807                                         (make-keyword (car arg)))
808                                     (make-keyword arg))))
809          (let ((keys ())           ; Just the keywords
810                (key-args ())       ; Keywords argument specs
811                (required-names ()) ; Just the variable names
812                (required-args ())  ; Variable names & specializers
813                (specializers ())   ; Just the specializers
814                (rest-var nil)
815                (optionals ())
816                (auxs ())
817                (allow-other-keys nil)
818                (state :parsing-required))
819            (dolist (arg lambda-list)
820              (if (member arg lambda-list-keywords)
821                  (ecase arg
822                    (&optional
823                     (setq state :parsing-optional))
824                    (&rest
825                     (setq state :parsing-rest))
826                    (&key
827                     (setq state :parsing-key))
828                    (&allow-other-keys
829                     (setq allow-other-keys 't))
830                    (&aux
831                     (setq state :parsing-aux)))
832                  (case state
833                    (:parsing-required
834                     (push-on-end arg required-args)
835                     (if (listp arg)
836                         (progn (push-on-end (car arg) required-names)
837                           (push-on-end (cadr arg) specializers))
838                         (progn (push-on-end arg required-names)
839                           (push-on-end 't specializers))))
840                    (:parsing-optional (push-on-end arg optionals))
841                    (:parsing-rest (setq rest-var arg))
842                    (:parsing-key
843                     (push-on-end (get-keyword-from-arg arg) keys)
844                     (push-on-end arg key-args))
845                    (:parsing-aux (push-on-end arg auxs)))))
846            (list  :required-names required-names
847                   :required-args required-args
848                   :specializers specializers
849                   :rest-var rest-var
850                   :keywords keys
851                   :key-args key-args
852                   :auxiliary-args auxs
853                   :optional-args optionals
854                   :allow-other-keys allow-other-keys))))
855
856;;; ensure method
857
858(defun ensure-method (gf &rest all-keys)
859  (let ((new-method
860         (apply
861          (if (eq (generic-function-method-class gf)
862                  the-class-standard-method)
863              #'make-instance-standard-method
864              #'make-instance)
865          (generic-function-method-class gf)
866          all-keys)))
867    (add-method gf new-method)
868    new-method))
869
870;;; make-instance-standard-method creates and initializes an instance of
871;;; standard-method without falling into method lookup.  However, it cannot
872;;; be called until standard-method exists.
873
874(defun make-instance-standard-method (method-class
875                                      &key lambda-list qualifiers
876                                      specializers body environment)
877  (declare (ignore method-class))
878  (let ((method (std-allocate-instance the-class-standard-method)))
879    (setf (method-lambda-list method) lambda-list)
880    (setf (method-qualifiers method) qualifiers)
881    (setf (method-specializers method) specializers)
882    (setf (method-body method) body)
883    (setf (method-environment method) environment)
884    (setf (method-generic-function method) nil)
885    (setf (method-function method)
886          (std-compute-method-function method))
887    method))
888
889;;; add-method
890
891;;; N.B. This version first removes any existing method on the generic function
892;;; with the same qualifiers and specializers.  It's a pain to develop
893;;; programs without this feature of full CLOS.
894
895(defun add-method (gf method)
896  (let ((old-method
897         (find-method gf (method-qualifiers method)
898                      (method-specializers method) nil)))
899    (when old-method (remove-method gf old-method)))
900  (setf (method-generic-function method) gf)
901  (push method (generic-function-methods gf))
902  (dolist (specializer (method-specializers method))
903    (pushnew method (class-direct-methods specializer)))
904  (finalize-generic-function gf)
905  method)
906
907(defun remove-method (gf method)
908  (setf (generic-function-methods gf)
909        (remove method (generic-function-methods gf)))
910  (setf (method-generic-function method) nil)
911;;   (format t "remove-method method-specializers = ~S~%" (method-specializers method))
912  (dolist (class (method-specializers method))
913    (setf (class-direct-methods class)
914          (remove method (class-direct-methods class))))
915  (finalize-generic-function gf)
916  method)
917
918(defun find-method (gf qualifiers specializers
919                       &optional (errorp t))
920  (let ((method
921         (find-if #'(lambda (method)
922                     (and (equal qualifiers
923                                 (method-qualifiers method))
924                          (equal specializers
925                                 (method-specializers method))))
926                  (generic-function-methods gf))))
927    (if (and (null method) errorp)
928        (error "No such method for ~S." (generic-function-name gf))
929        method)))
930
931;;; Reader and write methods
932
933(defun add-reader-method (class fn-name slot-name)
934  (ensure-method
935   (ensure-generic-function fn-name :lambda-list '(object))
936   :lambda-list '(object)
937   :qualifiers ()
938   :specializers (list class)
939   :body `(slot-value object ',slot-name)
940   :environment (top-level-environment))
941  (values))
942
943(defun add-writer-method (class fn-name slot-name)
944  (ensure-method
945   (ensure-generic-function
946    fn-name :lambda-list '(new-value object))
947   :lambda-list '(new-value object)
948   :qualifiers ()
949   :specializers (list (find-class 't) class)
950   :body `(setf (slot-value object ',slot-name)
951                new-value)
952   :environment (top-level-environment))
953  (values))
954
955;;; subclassp and sub-specializer-p
956
957(defun subclassp (c1 c2)
958  (not (null (find c2 (class-precedence-list c1)))))
959
960(defun sub-specializer-p (c1 c2 c-arg)
961  (let ((cpl (class-precedence-list c-arg)))
962    (not (null (find c2 (cdr (member c1 cpl)))))))
963
964;;;
965;;; Generic function invocation
966;;;
967
968;;; apply-generic-function
969
970(defun apply-generic-function (gf args)
971  (apply (generic-function-discriminating-function gf) args))
972
973;;; compute-discriminating-function
974
975(defun std-compute-discriminating-function (gf)
976  #'(lambda (&rest args)
977     (let* ((classes (mapcar #'class-of
978                             (required-portion gf args)))
979            (emfun (gethash classes (classes-to-emf-table gf) nil)))
980       (if emfun
981           (funcall emfun args)
982           (slow-method-lookup gf args classes)))))
983
984(defun slow-method-lookup (gf args classes)
985  (let* ((applicable-methods
986          (compute-applicable-methods-using-classes gf classes))
987         (emfun
988          (funcall
989           (if (eq (class-of gf) the-class-standard-gf)
990               #'std-compute-effective-method-function
991               #'compute-effective-method-function)
992           gf applicable-methods)))
993    (setf (gethash classes (classes-to-emf-table gf)) emfun)
994    (funcall emfun args)))
995
996;;; compute-applicable-methods-using-classes
997
998(defun compute-applicable-methods-using-classes
999  (gf required-classes)
1000  (sort
1001   (copy-list
1002    (remove-if-not #'(lambda (method)
1003                      (every #'subclassp
1004                             required-classes
1005                             (method-specializers method)))
1006                   (generic-function-methods gf)))
1007   #'(lambda (m1 m2)
1008      (funcall
1009       (if (eq (class-of gf) the-class-standard-gf)
1010           #'std-method-more-specific-p
1011           #'method-more-specific-p)
1012       gf m1 m2 required-classes))))
1013
1014;;; method-more-specific-p
1015
1016(defun std-method-more-specific-p (gf method1 method2 required-classes)
1017  (declare (ignore gf))
1018  (mapc #'(lambda (spec1 spec2 arg-class)
1019           (unless (eq spec1 spec2)
1020             (return-from std-method-more-specific-p
1021                          (sub-specializer-p spec1 spec2 arg-class))))
1022        (method-specializers method1)
1023        (method-specializers method2)
1024        required-classes)
1025  nil)
1026
1027;;; apply-methods and compute-effective-method-function
1028
1029(defun apply-methods (gf args methods)
1030  (funcall (compute-effective-method-function gf methods)
1031           args))
1032
1033(defun primary-method-p (method)
1034  (null (method-qualifiers method)))
1035(defun before-method-p (method)
1036  (equal '(:before) (method-qualifiers method)))
1037(defun after-method-p (method)
1038  (equal '(:after) (method-qualifiers method)))
1039(defun around-method-p (method)
1040  (equal '(:around) (method-qualifiers method)))
1041
1042(defun std-compute-effective-method-function (gf methods)
1043  (let ((primaries (remove-if-not #'primary-method-p methods))
1044        (around (find-if #'around-method-p methods)))
1045    (when (null primaries)
1046      (error "No primary methods for the~@
1047      generic function ~S." gf))
1048    (if around
1049        (let ((next-emfun
1050               (funcall
1051                (if (eq (class-of gf) the-class-standard-gf)
1052                    #'std-compute-effective-method-function
1053                    #'compute-effective-method-function)
1054                gf (remove around methods))))
1055          #'(lambda (args)
1056             (funcall (method-function around) args next-emfun)))
1057        (let ((next-emfun (compute-primary-emfun (cdr primaries)))
1058              (befores (remove-if-not #'before-method-p methods))
1059              (reverse-afters
1060               (reverse (remove-if-not #'after-method-p methods))))
1061          #'(lambda (args)
1062             (dolist (before befores)
1063               (funcall (method-function before) args nil))
1064             (multiple-value-prog1
1065              (funcall (method-function (car primaries)) args next-emfun)
1066              (dolist (after reverse-afters)
1067                (funcall (method-function after) args nil))))))))
1068
1069;;; compute an effective method function from a list of primary methods:
1070
1071(defun compute-primary-emfun (methods)
1072  (if (null methods)
1073      nil
1074      (let ((next-emfun (compute-primary-emfun (cdr methods))))
1075        #'(lambda (args)
1076           (funcall (method-function (car methods)) args next-emfun)))))
1077
1078;;; apply-method and compute-method-function
1079
1080(defun apply-method (method args next-methods)
1081  (funcall (method-function method)
1082           args
1083           (if (null next-methods)
1084               nil
1085               (compute-effective-method-function
1086                (method-generic-function method) next-methods))))
1087
1088(defun std-compute-method-function (method)
1089  (let ((form (method-body method))
1090        (lambda-list (method-lambda-list method)))
1091    (compile-in-lexical-environment (method-environment method)
1092                                    `(lambda (args next-emfun)
1093                                       (flet ((call-next-method (&rest cnm-args)
1094                                                                (if (null next-emfun)
1095                                                                    (error "No next method for the~@
1096                                                                    generic function ~S."
1097                                                                           (method-generic-function ',method))
1098                                                                    (funcall next-emfun (or cnm-args args))))
1099                                              (next-method-p ()
1100                                                             (not (null next-emfun))))
1101                                         (apply #'(lambda ,(kludge-arglist lambda-list)
1102                                                   ,form)
1103                                                args))))))
1104
1105;;; N.B. The function kludge-arglist is used to pave over the differences
1106;;; between argument keyword compatibility for regular functions versus
1107;;; generic functions.
1108
1109(defun kludge-arglist (lambda-list)
1110  (if (and (member '&key lambda-list)
1111           (not (member '&allow-other-keys lambda-list)))
1112      (append lambda-list '(&allow-other-keys))
1113      (if (and (not (member '&rest lambda-list))
1114               (not (member '&key lambda-list)))
1115          (append lambda-list '(&key &allow-other-keys))
1116          lambda-list)))
1117
1118;;; Slot access
1119
1120(defun setf-slot-value-using-class (new-value class instance slot-name)
1121  (setf (std-slot-value instance slot-name) new-value))
1122
1123(defgeneric slot-value-using-class (class instance slot-name))
1124(defmethod slot-value-using-class ((class standard-class) instance slot-name)
1125  (std-slot-value instance slot-name))
1126
1127(defgeneric (setf slot-value-using-class) (new-value class instance slot-name))
1128(defmethod (setf slot-value-using-class)
1129  (new-value (class standard-class) instance slot-name)
1130  (setf (std-slot-value instance slot-name) new-value))
1131;;; N.B. To avoid making a forward reference to a (setf xxx) generic function:
1132;; (defun setf-slot-value-using-class (new-value class object slot-name)
1133;;   (setf (slot-value-using-class class object slot-name) new-value))
1134
1135(defgeneric slot-exists-p-using-class (class instance slot-name))
1136(defmethod slot-exists-p-using-class
1137  ((class standard-class) instance slot-name)
1138  (std-slot-exists-p instance slot-name))
1139
1140(defgeneric slot-boundp-using-class (class instance slot-name))
1141(defmethod slot-boundp-using-class
1142  ((class standard-class) instance slot-name)
1143  (std-slot-boundp instance slot-name))
1144
1145(defgeneric slot-makunbound-using-class (class instance slot-name))
1146(defmethod slot-makunbound-using-class
1147  ((class standard-class) instance slot-name)
1148  (std-slot-makunbound instance slot-name))
1149
1150;;; Instance creation and initialization
1151
1152;; (defgeneric allocate-instance (class))
1153;; (defmethod allocate-instance ((class standard-class))
1154;;   (std-allocate-instance class))
1155
1156(defgeneric make-instance (class &key))
1157(defmethod make-instance ((class standard-class) &rest initargs)
1158  (let ((instance (allocate-instance class)))
1159    (apply #'initialize-instance instance initargs)
1160    instance))
1161(defmethod make-instance ((class symbol) &rest initargs)
1162  (apply #'make-instance (find-class class) initargs))
1163
1164(defgeneric initialize-instance (instance &key))
1165(defmethod initialize-instance ((instance standard-object) &rest initargs)
1166  (apply #'shared-initialize instance t initargs))
1167
1168(defgeneric reinitialize-instance (instance &key))
1169(defmethod reinitialize-instance
1170  ((instance standard-object) &rest initargs)
1171  (apply #'shared-initialize instance () initargs))
1172
1173(defgeneric shared-initialize (instance slot-names &key))
1174(defmethod shared-initialize ((instance standard-object)
1175                              slot-names &rest all-keys)
1176  (dolist (slot (class-slots (class-of instance)))
1177    (let ((slot-name (slot-definition-name slot)))
1178      (multiple-value-bind (init-key init-value foundp)
1179        (get-properties
1180         all-keys (slot-definition-initargs slot))
1181        (declare (ignore init-key))
1182        (if foundp
1183            (setf (slot-value instance slot-name) init-value)
1184            (when (and (not (slot-boundp instance slot-name))
1185                       (not (null (slot-definition-initfunction slot)))
1186                       (or (eq slot-names t)
1187                           (member slot-name slot-names)))
1188              (setf (slot-value instance slot-name)
1189                    (funcall (slot-definition-initfunction slot))))))))
1190  instance)
1191
1192;;; change-class
1193
1194(defgeneric change-class (instance new-class &key))
1195(defmethod change-class
1196  ((old-instance standard-object)
1197   (new-class standard-class)
1198   &rest initargs)
1199  (let ((new-instance (allocate-instance new-class)))
1200    (dolist (slot-name (mapcar #'slot-definition-name
1201                               (class-slots new-class)))
1202      (when (and (slot-exists-p old-instance slot-name)
1203                 (slot-boundp old-instance slot-name))
1204        (setf (slot-value new-instance slot-name)
1205              (slot-value old-instance slot-name))))
1206    (rotatef (std-instance-slots new-instance)
1207             (std-instance-slots old-instance))
1208    (rotatef (std-instance-class new-instance)
1209             (std-instance-class old-instance))
1210    (apply #'update-instance-for-different-class
1211           new-instance old-instance initargs)
1212    old-instance))
1213
1214(defmethod change-class
1215  ((instance standard-object) (new-class symbol) &rest initargs)
1216  (apply #'change-class instance (find-class new-class) initargs))
1217
1218(defgeneric update-instance-for-different-class (old new &key))
1219(defmethod update-instance-for-different-class
1220  ((old standard-object) (new standard-object) &rest initargs)
1221  (let ((added-slots
1222         (remove-if #'(lambda (slot-name)
1223                       (slot-exists-p old slot-name))
1224                    (mapcar #'slot-definition-name
1225                            (class-slots (class-of new))))))
1226    (apply #'shared-initialize new added-slots initargs)))
Note: See TracBrowser for help on using the repository browser.