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

Last change on this file since 5040 was 5040, checked in by piso, 18 years ago

Work in progress.

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