source: trunk/source/level-1/l1-dcode.lisp @ 10426

Last change on this file since 10426 was 10426, checked in by gb, 12 years ago

Merge a lot of the CLOS/type-system changes from working-0711 branch
into trunk. Todo: compiler-macros for those changes.

Have -not- yet merged source-tracking changes, new record-source file
from working-0711, but this stuff seems to bootstrap in one swell foop.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 77.9 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 1994-2001 Digitool, Inc
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17
18(in-package "CCL")
19
20
21
22
23
24
25(defun %make-gf-instance (class &key
26                                name
27                                (method-combination *standard-method-combination* mcomb-p)
28                                (method-class *standard-method-class* mclass-p)
29                                declarations
30                                (lambda-list nil ll-p)
31                                (argument-precedence-order nil apo-p)
32                                &allow-other-keys)
33  (when mcomb-p
34    (unless (typep method-combination 'method-combination)
35      (report-bad-arg method-combination 'method-combination)))
36  (when mclass-p
37    (if (symbolp method-class)
38      (setq method-class (find-class method-class)))
39    (unless (subtypep method-class *method-class*)
40      (error "~s is not a subtype of ~s." method-class *method-class*)))
41  (when declarations
42    (unless (list-length declarations)
43      (error "~s is not a proper list" declarations)))
44  ;; Fix APO, lambda-list
45  (if apo-p
46    (if (not ll-p)
47      (error "Cannot specify ~s without specifying ~s" :argument-precedence-order
48             :lambda-list)))
49  (let* ((gf (%allocate-gf-instance class)))
50    (setf (sgf.name gf) name
51          (sgf.method-combination gf) method-combination
52          (sgf.methods gf) nil
53          (sgf.method-class gf) method-class
54          (sgf.decls gf) declarations
55          (sgf.%lambda-list gf) :unspecified
56          (sgf.dependents gf) nil)
57    (when ll-p
58      (if apo-p
59        (set-gf-arg-info gf :lambda-list lambda-list
60                         :argument-precedence-order argument-precedence-order)
61        (set-gf-arg-info gf :lambda-list lambda-list)))
62    gf))
63
64(defun gf-arg-info-valid-p (gf)
65  (let* ((bits (lfun-bits gf)))
66    (declare (fixnum bits))
67    (not (and (logbitp $lfbits-aok-bit bits)
68              (not (logbitp $lfbits-keys-bit bits))))))
69
70;;; Derive a GF lambda list from the method's lambda list.
71(defun flatten-method-lambda-list (lambda-list)
72  (collect ((ll))
73    (dolist (x lambda-list (ll))
74      (if (atom x)
75        (if (eq x '&aux)
76          (return (ll))
77          (ll x))
78        (ll (car x))))))
79         
80(defun %maybe-compute-gf-lambda-list (gf method)
81  (let* ((gf-ll (sgf.%lambda-list gf)))
82    (if (eq gf-ll :unspecified)
83      (and method
84           (let* ((method-lambda-list (%method-lambda-list method))
85                  (method-has-&key (member '&key method-lambda-list))
86                  (method-has-&allow-other-keys
87                   (member '&allow-other-keys method-lambda-list)))
88             (if method-has-&key
89               (nconc (ldiff method-lambda-list (cdr method-has-&key))
90                      (if method-has-&allow-other-keys
91                        '(&allow-other-keys)))
92               (flatten-method-lambda-list method-lambda-list))))
93      gf-ll)))
94             
95             
96;;; Borrowed from PCL, sort of.  We can encode required/optional/restp/keyp
97;;; information in the gf's lfun-bits
98(defun set-gf-arg-info (gf &key new-method (lambda-list nil lambda-list-p)
99                           (argument-precedence-order nil apo-p))
100  (let* ((methods (%gf-methods gf))
101         (dt (%gf-dispatch-table gf))
102         (gf-lfun-bits (lfun-bits gf))
103         (first-method-p (and new-method (null methods))))
104    (declare (fixnum gf-lfun-bits))
105    (unless lambda-list-p
106      (setq lambda-list
107            (%maybe-compute-gf-lambda-list gf (or (car (last methods))
108                                                  new-method))))
109    (when (or lambda-list-p
110              (and first-method-p
111                   (eq (%gf-%lambda-list gf) :unspecified)))
112      (multiple-value-bind (newbits keyvect)
113          (encode-lambda-list lambda-list t)
114        (declare (fixnum newbits))
115        (when (and methods (not first-method-p))
116          (unless (and (= (ldb $lfbits-numreq gf-lfun-bits)
117                          (ldb $lfbits-numreq newbits))
118                       (= (ldb $lfbits-numopt gf-lfun-bits)
119                          (ldb $lfbits-numopt newbits))
120                       (eq (or (logbitp $lfbits-keys-bit gf-lfun-bits)
121                               (logbitp $lfbits-rest-bit gf-lfun-bits)
122                               (logbitp $lfbits-restv-bit gf-lfun-bits))
123                           (or (logbitp $lfbits-keys-bit newbits)
124                               (logbitp $lfbits-rest-bit newbits)
125                               (logbitp $lfbits-restv-bit newbits))))
126            (cerror (format nil
127                            "Remove ~d method~:p from the generic-function and ~
128                             change its lambda list."
129                            (length (%gf-methods gf)))
130                    "New lambda list of generic function ~s is not congruent ~
131                     with lambda lists of existing methods.~%~
132                     Generic-function's   : ~s~%~
133                     Method's lambda-list : ~s~%"
134                    gf lambda-list (%method-lambda-list (car methods)))
135            (loop
136               (let ((methods (%gf-methods gf)))
137                 (if methods
138                     (remove-method gf (car methods))
139                     (return))))
140            (%set-defgeneric-keys gf nil)))
141        (when lambda-list-p
142          (setf (%gf-%lambda-list gf) lambda-list
143                (%gf-dispatch-table-keyvect dt) keyvect))
144        (when (and apo-p lambda-list-p)
145          (let* ((old-precedence-list (%gf-dispatch-table-precedence-list dt)))
146            (setf (%gf-dispatch-table-precedence-list dt)
147                  (canonicalize-argument-precedence-order
148                   argument-precedence-order
149                   (required-lambda-list-args lambda-list)))
150            (unless (equal old-precedence-list
151                           (%gf-dispatch-table-precedence-list dt))
152              (clear-gf-dispatch-table dt))))
153        (lfun-bits gf (logior (ash 1 $lfbits-gfn-bit)
154                              (logand $lfbits-args-mask newbits)))))
155    (when new-method
156      (check-defmethod-congruency gf new-method))))
157       
158(defun %gf-name (gf &optional (new-name nil new-name-p))
159  (let* ((old-name (%standard-generic-function-instance-location-access
160                    gf sgf.name)))
161    (if new-name-p
162      (setf (sgf.name gf) new-name))
163    (unless (eq old-name (%slot-unbound-marker))
164      old-name)))
165
166
167
168             
169(defun make-n+1th-arg-combined-method (methods gf argnum)
170  (let ((table (make-gf-dispatch-table)))
171    (setf (%gf-dispatch-table-methods table) methods
172          (%gf-dispatch-table-argnum table) (%i+ 1 argnum))
173    (let ((self (%cons-combined-method gf table #'%%nth-arg-dcode))) ; <<
174      (setf (%gf-dispatch-table-gf table) self)
175      self)))
176
177;;; Bring the generic function to the smallest possible size by removing
178;;; any cached recomputable info.  Currently this means clearing out the
179;;; combined methods from the dispatch table.
180
181(defun clear-gf-cache (gf)
182  #-bccl (unless t (typep gf 'standard-generic-function) 
183           (report-bad-arg gf 'standard-generic-function))
184  (let ((dt (%gf-dispatch-table gf)))
185    (if (eq (%gf-dispatch-table-size dt) *min-gf-dispatch-table-size*)
186      (clear-gf-dispatch-table dt)
187      (let ((new (make-gf-dispatch-table)))
188        (setf (%gf-dispatch-table-methods new) (%gf-dispatch-table-methods dt))
189        (setf (%gf-dispatch-table-precedence-list new)
190              (%gf-dispatch-table-precedence-list dt))
191        (setf (%gf-dispatch-table-gf new) gf)
192        (setf (%gf-dispatch-table-keyvect new)
193              (%gf-dispatch-table-keyvect dt))
194        (setf (%gf-dispatch-table-argnum new) (%gf-dispatch-table-argnum dt))
195        (setf (%gf-dispatch-table gf) new)))))
196
197(defun %gf-dispatch-table-store-conditional (dt index new)
198  "Returns T if the new value can be stored in DT at INDEX, replacing a NIL.
199   Returns NIL - without storing anything - if the value already in DT
200   at INDEX is non-NIL at the time of the store."
201  (let ((offset (+ (ash (%i+ index %gf-dispatch-table-first-data)
202                        target::word-shift)
203                   target::misc-data-offset)))
204    (or (%store-node-conditional offset dt nil new)
205        (%store-node-conditional offset dt *gf-dispatch-bug* new))))
206
207(defun grow-gf-dispatch-table (gf-or-cm wrapper table-entry &optional obsolete-wrappers-p)
208  ;; Grow the table associated with gf and insert table-entry as the value for
209  ;; wrapper.  Wrapper is a class-wrapper.  Assumes that it is not obsolete.
210  (let* ((dt (if (generic-function-p gf-or-cm)
211               (%gf-dispatch-table gf-or-cm)
212               (%combined-method-methods gf-or-cm)))
213         (size (%gf-dispatch-table-size dt))
214         (new-size (if obsolete-wrappers-p
215                     size
216                     (%i+ size size)))
217         new-dt)
218    (if (> new-size *max-gf-dispatch-table-size*)
219      (progn 
220        (setq new-dt (clear-gf-dispatch-table dt)
221                   *gf-dt-ovf-cnt* (%i+ *gf-dt-ovf-cnt* 1)))
222      (progn
223        (setq new-dt (make-gf-dispatch-table new-size))
224        (setf (%gf-dispatch-table-methods new-dt) (%gf-dispatch-table-methods dt)
225              (%gf-dispatch-table-precedence-list new-dt) (%gf-dispatch-table-precedence-list dt)
226              (%gf-dispatch-table-keyvect new-dt) (%gf-dispatch-table-keyvect dt)
227              (%gf-dispatch-table-gf new-dt) gf-or-cm
228              (%gf-dispatch-table-argnum new-dt) (%gf-dispatch-table-argnum dt))
229        (let ((i 0) index w cm)
230          (dotimes (j (%ilsr 1 (%gf-dispatch-table-size dt)))
231            (declare (fixnum j))
232            (unless (or (null (setq w (%gf-dispatch-table-ref dt i)))
233                        (eql 0 (%wrapper-hash-index w))
234                        (no-applicable-method-cm-p
235                         (setq cm (%gf-dispatch-table-ref dt (%i+ i 1)))))
236              (setq index (find-gf-dispatch-table-index new-dt w t))
237              (setf (%gf-dispatch-table-ref new-dt index) w)
238              (setf (%gf-dispatch-table-ref new-dt (%i+ index 1)) cm))
239            (setq i (%i+ i 2))))))
240    (let ((index (find-gf-dispatch-table-index new-dt wrapper t)))
241      (setf (%gf-dispatch-table-ref new-dt index) wrapper)
242      (setf (%gf-dispatch-table-ref new-dt (%i+ index 1)) table-entry))
243    (if (generic-function-p gf-or-cm)
244      (setf (%gf-dispatch-table gf-or-cm) new-dt)
245      (setf (%combined-method-methods gf-or-cm) new-dt))))
246
247
248(defun inner-lfun-bits (function &optional value)
249  (lfun-bits (closure-function function) value))
250
251
252
253;;; probably want to use alists vs. hash-tables initially
254
255
256;;; only used if error - well not really
257(defun collect-lexpr-args (args first &optional last) 
258  (if (listp args)
259    (subseq args first (or last (length args)))
260    (let ((res nil))
261      (when (not last)(setq last (%lexpr-count args)))
262      (dotimes (i (- last first))
263        (setq res (push (%lexpr-ref args last (+ first i)) res)))
264      (nreverse res))))
265
266
267
268
269(defmacro with-list-from-lexpr ((list lexpr) &body body)
270  (let ((len (gensym)))
271    `(let* ((,len (%lexpr-count ,lexpr))
272            (,list  (make-list ,len)))
273       (declare (dynamic-extent ,list) (fixnum ,len))       
274       (do* ((i 0 (1+ i))
275             (ls ,list (cdr ls)))
276            ((= i ,len) ,list)
277         (declare (fixnum i) (list ls))
278         (declare (optimize (speed 3)(safety 0)))
279         (%rplaca ls (%lexpr-ref ,lexpr ,len i)))
280       ,@body)))
281
282
283
284(defmacro %standard-instance-p (i)
285  `(eq (typecode ,i) ,(type-keyword-code :instance)))
286
287
288
289(declaim (inline %find-1st-arg-combined-method))
290(declaim (inline %find-nth-arg-combined-method))
291
292
293
294
295(defun %find-1st-arg-combined-method (dt arg)
296  (let ((wrapper (instance-class-wrapper arg)))
297    (when (eql 0 (%wrapper-hash-index wrapper))
298      (update-obsolete-instance arg)
299      (setq wrapper (instance-class-wrapper arg)))
300    (let* ((mask (%gf-dispatch-table-mask dt))
301           (index (%ilsl 1 (%ilogand mask (%wrapper-hash-index wrapper))))
302           table-wrapper flag)
303      (declare (fixnum index mask))
304      (loop 
305        (if (eq (setq table-wrapper (%gf-dispatch-table-ref dt index)) wrapper)
306          (return (%gf-dispatch-table-ref dt  (the fixnum (1+ index))))
307          (progn
308            (when (null (%gf-dispatch-table-ref dt (the fixnum (1+ index))))
309              (if (or (neq table-wrapper (%unbound-marker))
310                      (eql 0 flag))
311                (without-interrupts     ; why?
312                 (return (1st-arg-combined-method-trap (%gf-dispatch-table-gf dt) wrapper arg))) ; the only difference?
313                (setq flag 0 index -2)))
314            (setq index (+ 2 index))))))))
315
316;;; for calls from outside - e.g. stream-reader
317(defun find-1st-arg-combined-method (gf arg)
318  (declare (optimize (speed 3)(safety 0)))
319  (%find-1st-arg-combined-method (%gf-dispatch-table gf) arg))
320
321
322;;; more PC - it it possible one needs to go round more than once? -
323;;; seems unlikely
324(defun %find-nth-arg-combined-method (dt arg args) 
325  (declare (optimize (speed 3)(safety 0)))
326  (let ((wrapper (instance-class-wrapper arg)))
327    (when (eql 0 (%wrapper-hash-index wrapper))
328      (update-obsolete-instance arg)
329      (setq wrapper (instance-class-wrapper arg)))
330    (let* ((mask (%gf-dispatch-table-mask dt))
331           (index (%ilsl 1 (%ilogand mask (%wrapper-hash-index wrapper))))
332           table-wrapper flag)
333      (declare (fixnum index mask))
334      (loop 
335        (if (eq (setq table-wrapper (%gf-dispatch-table-ref dt index)) wrapper)
336          (return (%gf-dispatch-table-ref dt (the fixnum (1+ index))))
337          (progn
338            (when (null (%gf-dispatch-table-ref dt (the fixnum (1+ index))))
339              (if (or (neq table-wrapper (%unbound-marker))
340                      (eql 0 flag))
341                (without-interrupts     ; why?
342                 (let ((gf (%gf-dispatch-table-gf dt)))
343                   (if (listp args)
344                     (return (nth-arg-combined-method-trap-0 gf dt wrapper args))
345                     (with-list-from-lexpr (args-list args)
346                       (return (nth-arg-combined-method-trap-0 gf dt wrapper args-list))))))
347                (setq flag 0 index -2)))
348            (setq index (+ 2 index))))))))
349
350
351
352
353;;;;;;;;;;;;;;;;;;;;;;;;;;; Generic functions and methods ;;;;;;;;;;;;;;;;;;;;
354(defun %class-cpl (class)
355  (if (%standard-instance-p class)
356    (%class.cpl class)
357    (or
358     (and (typep class 'macptr)
359          (let* ((slots (foreign-slots-vector class)))
360            (and slots (%slot-ref slots %class.cpl))))
361     (error "Can't determine CPL of class ~s" class))))
362
363
364(defun standard-method-p (thing)
365  (when (%standard-instance-p thing)
366    (let* ((cpl (%class-cpl (%wrapper-class (instance.class-wrapper thing))))
367           (smc *standard-method-class*))
368      (dolist (c cpl)
369        (if (eq c smc)(return t))))))
370
371
372
373(defun %method-function-p (thing)
374  (when (functionp thing)
375    (let ((bits (lfun-bits thing)))
376      (declare (fixnum bits))
377      (logbitp $lfbits-method-bit bits))))
378
379
380
381
382(setf (type-predicate 'standard-generic-function) 'standard-generic-function-p)
383(setf (type-predicate 'combined-method) 'combined-method-p)
384
385(setf (type-predicate 'standard-method) 'standard-method-p)
386
387;; Maybe we shouldn't make this a real type...
388(setf (type-predicate 'method-function) '%method-function-p)
389
390
391(defvar %all-gfs% (%cons-population nil))
392
393
394(eval-when (:compile-toplevel :execute)
395(defconstant $lfbits-numinh-mask (logior (dpb -1 $lfbits-numinh 0)
396                                         (%ilsl $lfbits-nonnullenv-bit 1)))
397)
398
399
400#+ppc-target
401(defvar *fi-trampoline-code* (uvref #'funcallable-trampoline 0))
402
403
404#+ppc-target
405(defvar *unset-fin-code* (uvref #'unset-fin-trampoline 0))
406
407
408
409#+ppc-target
410(defvar *gf-proto-code* (uvref *gf-proto* 0))
411
412;;; The "early" version of %ALLOCATE-GF-INSTANCE.
413(setf (fdefinition '%allocate-gf-instance)
414      #'(lambda (class)
415          (declare (ignorable class))
416          (setq class *standard-generic-function-class*)
417          (let* ((wrapper (%class.own-wrapper class))
418                 (len (length #.(%wrapper-instance-slots (class-own-wrapper
419                                                          *standard-generic-function-class*))))
420                 (dt (make-gf-dispatch-table))
421                 (slots (allocate-typed-vector :slot-vector (1+ len) (%slot-unbound-marker)))
422                 (fn #+ppc-target
423                   (gvector :function
424                              *gf-proto-code*
425                              wrapper
426                              slots
427                              dt
428                              #'%%0-arg-dcode
429                              0
430                              (%ilogior (%ilsl $lfbits-gfn-bit 1)
431                                        (%ilogand $lfbits-args-mask 0)))
432                   #+x86-target
433                   (%clone-x86-function *gf-proto*
434                                        wrapper
435                                        slots
436                                        dt
437                                        #'%%0-arg-dcode
438                                        0
439                                        (%ilogior (%ilsl $lfbits-gfn-bit 1)
440                                                  (%ilogand $lfbits-args-mask 0)))))
441            (setf ;(gf.hash fn) (strip-tag-to-fixnum fn)
442                  (slot-vector.instance slots) fn
443                  (%gf-dispatch-table-gf dt) fn)
444            (push fn (population.data %all-gfs%))
445            fn)))
446
447
448
449
450
451
452 
453
454
455(defparameter *gf-proto-one-arg*  #'gag-one-arg)
456(defparameter *gf-proto-two-arg*  #'gag-two-arg)
457
458
459
460
461#+ppc-target
462(defvar *cm-proto-code* (uvref *cm-proto* 0))
463
464(defun %cons-combined-method (gf thing dcode)
465  ;; set bits and name = gf
466  #+ppc-target
467  (gvector :function
468           *cm-proto-code*
469           thing
470           dcode
471           gf
472           (%ilogior (%ilsl $lfbits-cm-bit 1)
473                            (%ilogand $lfbits-args-mask (lfun-bits gf))))
474  #+x86-target
475  (%clone-x86-function *cm-proto*
476                       thing
477                       dcode
478                       gf
479                       (%ilogior (%ilsl $lfbits-cm-bit 1)
480                                 (%ilogand $lfbits-args-mask (lfun-bits gf)))))
481
482(defun %gf-dispatch-table (gf)
483  ;(require-type gf 'standard-generic-function)
484  (gf.dispatch-table gf))
485
486(defun %gf-dcode (gf)
487  ;(require-type gf 'standard-generic-function)
488  (gf.dcode gf))
489
490(defun %set-gf-dcode (gf dcode)
491  (let ((gf (require-type gf 'funcallable-standard-object))
492        (dcode (require-type dcode 'function)))
493    (replace-function-code gf (or (cdr (assq dcode dcode-proto-alist))
494                                  #'funcallable-trampoline))
495    (setf (gf.dcode gf) dcode)))
496
497(defun %set-gf-dispatch-table (gf val)
498  (setf (gf.dispatch-table gf) val))
499
500(defun %combined-method-methods  (cm)
501  ;(require-type cm 'combined-method)
502  (combined-method.thing cm))
503
504(defun %combined-method-dcode (cm)
505  ;(require-type cm 'combined-method)
506  (combined-method.dcode cm))
507
508(defun %set-combined-method-methods (cm val)
509  (setf (combined-method.thing cm) val))
510
511(defun %set-combined-method-dcode (cm val)
512  (setf (combined-method.dcode cm) val))
513
514(declaim (inline funcallable-instance-p))
515(defun funcallable-instance-p (thing)
516  (when (typep thing 'function)
517    (let ((bits (lfun-bits-known-function thing)))
518      (declare (fixnum bits))
519      (eq (ash 1 $lfbits-gfn-bit)
520          (logand bits (logior (ash 1 $lfbits-gfn-bit)
521                               (ash 1 $lfbits-method-bit)))))))
522
523(setf (type-predicate 'funcallable-standard-object) 'funcallable-instance-p)
524
525(defstatic *generic-function-class-wrapper* nil)
526(defstatic *standard-generic-function-class-wrapper* nil)
527
528(defun generic-function-p (thing)
529  (and (typep thing 'funcallable-standard-object)
530       (let* ((wrapper (gf.instance.class-wrapper thing)))
531         ;; In practice, many generic-functions are standard-generic-functions.
532         (or (eq *standard-generic-function-class-wrapper* wrapper)
533             (eq *generic-function-class-wrapper* wrapper)
534             (let* ((bits (or (%wrapper-cpl-bits wrapper)
535                              (make-cpl-bits (%inited-class-cpl (%wrapper-class wrapper)))))
536                    (ordinal (%wrapper-class-ordinal *generic-function-class-wrapper*)))
537               (and bits ordinal
538                    (locally (declare (simple-bit-vector bits)
539                                      (fixnum ordinal)
540                                      (optimize (speed 3) (safety 0)))
541                      (and (< ordinal (length bits))
542                           (eql 1 (sbit bits ordinal))))))))))
543
544
545(defun standard-generic-function-p (thing)
546  (and (typep thing 'function)
547       (let ((bits (lfun-bits-known-function thing)))
548         (declare (fixnum bits))
549         (eq (ash 1 $lfbits-gfn-bit)
550             (logand bits (logior (ash 1 $lfbits-gfn-bit)
551                                  (ash 1 $lfbits-method-bit)))))
552       (or (eq (%class.own-wrapper *standard-generic-function-class*)
553               (gf.instance.class-wrapper thing))
554           (memq  *standard-generic-function-class*
555                  (%inited-class-cpl (class-of thing))))))
556
557
558(defun combined-method-p (thing)
559  (when (functionp thing)
560    (let ((bits (lfun-bits-known-function thing)))
561      (declare (fixnum bits))
562      (eq (ash 1 $lfbits-cm-bit)
563          (logand bits
564                  (logior (ash 1 $lfbits-cm-bit)
565                          (ash 1 $lfbits-method-bit)))))))
566
567(setf (type-predicate 'generic-function) 'generic-function-p)
568
569(setf (type-predicate 'standard-generic-function) 'standard-generic-function-p)
570(setf (type-predicate 'funcallable-standard-object) 'funcallable-instance-p)
571(setf (type-predicate 'combined-method) 'combined-method-p)
572
573
574
575;;; A generic-function looks like:
576;;;
577;;; header | trampoline |  dispatch-table | dcode | name | bits
578;;; %svref :    0              1              2       3      4
579;;;
580;;; The trampoline is *gf-proto*'s code vector.
581;;; The dispatch-table and dcode are sort of settable closed-over variables.
582
583(defsetf %gf-dispatch-table %set-gf-dispatch-table)
584
585(defun %gf-methods (gf)
586  (sgf.methods gf))
587
588(defun %gf-precedence-list (gf)
589  (%gf-dispatch-table-precedence-list (%gf-dispatch-table gf)))
590
591(defun %gf-%lambda-list (gf)
592  (sgf.%lambda-list gf))
593
594(defun (setf %gf-%lambda-list) (new gf)
595  (setf (sgf.%lambda-list gf) new))
596
597;;; Returns INSTANCE if it is either a standard instance of a
598;;; standard gf, else nil.
599(defun %maybe-gf-instance (instance)
600  (if (or (standard-generic-function-p instance)
601          (%standard-instance-p instance))
602    instance))
603
604(defsetf %gf-dcode %set-gf-dcode)
605
606(defun %gf-method-class (gf)
607  (sgf.method-class gf))
608
609
610(defun %gf-method-combination (gf)
611  (sgf.method-combination gf))
612
613(defun %combined-method-methods  (cm)
614  (combined-method.thing cm))
615
616(defun %combined-method-dcode (cm)
617  ;(require-type cm 'combined-method)
618  (combined-method.dcode cm))
619
620
621; need setters too
622
623(defsetf %combined-method-methods %set-combined-method-methods)
624
625(defparameter *min-gf-dispatch-table-size* 2
626  "The minimum size of a generic-function dispatch table")
627
628(defun make-gf-dispatch-table (&optional (size *min-gf-dispatch-table-size*))
629  (when (<= size 0) (report-bad-arg size '(integer 1)))
630  (setq size (%imax (%ilsl (%i- (integer-length (%i+ size size -1))
631                                1)
632                           1)           ; next power of 2
633                    *min-gf-dispatch-table-size*))
634  (let ((res (%cons-gf-dispatch-table size)))
635    (setf (%gf-dispatch-table-mask res) (%i- (%ilsr 1 size) 1)
636          (%gf-dispatch-table-argnum res) 0
637          (%gf-dispatch-table-ref res size) (%unbound-marker))
638    res))
639
640;;; I wanted this to be faster - I didn't
641(defun clear-gf-dispatch-table (dt)
642  (let ((i %gf-dispatch-table-first-data))
643    (dotimes (j (%gf-dispatch-table-size dt))
644      (declare (fixnum j))
645      (setf (%svref dt i) nil 
646            i (%i+ i 1)))
647    (setf (%svref dt i) (%unbound-marker)) ; paranoia...
648    (setf (svref dt (%i+ 1 i)) nil))
649  dt)
650
651
652; Remove all combined-methods from the world
653(defun clear-all-gf-caches ()
654  (dolist (f (population-data %all-gfs%))
655    (clear-gf-cache f))
656  (clrhash *combined-methods*)
657  nil)
658
659
660;;; Searches for an empty slot in dt at the hash-index for wrapper.
661;;; Returns nil if the table was full.
662(defun find-gf-dispatch-table-index (dt wrapper &optional skip-full-check?)
663  (let ((contains-obsolete-wrappers-p nil)
664        (mask (%gf-dispatch-table-mask dt)))
665    (declare (fixnum mask))
666    (unless skip-full-check?
667      (let* ((size (1+ mask))
668             (max-count (- size (the fixnum (ash (the fixnum (+ size 3)) -2))))
669             (index 0)
670             (count 0))
671        (declare (fixnum size max-count index count))
672        (dotimes (i size)
673          (declare (fixnum i))
674          (let ((wrapper (%gf-dispatch-table-ref dt index)))
675            (if wrapper
676              (if (eql 0 (%wrapper-hash-index wrapper))
677                (setf contains-obsolete-wrappers-p t
678                      (%gf-dispatch-table-ref dt index) *obsolete-wrapper*
679                      (%gf-dispatch-table-ref dt (1+ index)) *gf-dispatch-bug*)
680                (setq count (%i+ count 1)))))
681          (setq index (%i+ index 2)))
682        (when (> count max-count)
683          (return-from find-gf-dispatch-table-index (values nil contains-obsolete-wrappers-p)))))
684    (let* ((index (ash (logand mask (%wrapper-hash-index wrapper)) 1))
685           (flag nil)
686           table-wrapper)     
687      (values
688       (loop
689         (while (and (neq wrapper
690                          (setq table-wrapper (%gf-dispatch-table-ref dt index)))
691                     (%gf-dispatch-table-ref dt (1+ index))
692                     (neq 0 (%wrapper-hash-index table-wrapper)))
693           (setq index (%i+ index 2)))
694         (if (eq (%unbound-marker) table-wrapper)
695           (if flag
696             (return nil)         ; table full
697             (setq flag 1
698                   index 0))
699           (return index)))
700       contains-obsolete-wrappers-p))))
701
702
703(defvar *obsolete-wrapper* #(obsolete-wrapper 0))
704(defvar *gf-dispatch-bug*
705  #'(lambda (&rest rest)
706      (declare (ignore rest))
707      (error "Generic-function dispatch bug!")))
708
709 
710;;; This maximum is necessary because of the 32 bit arithmetic in
711;;; find-gf-dispatch-table-index.
712(defparameter *max-gf-dispatch-table-size* (expt 2 16))
713(defvar *gf-dt-ovf-cnt* 0)              ; overflow count
714
715(defvar *no-applicable-method-hash* nil)
716
717
718(let* ((eql-specializers-lock (make-lock))
719       (eql-specializers-hash (make-hash-table :test #'eql)))
720  (defun intern-eql-specializer (object)
721    (with-lock-grabbed (eql-specializers-lock)
722      (or (gethash object eql-specializers-hash)
723          (setf (gethash object eql-specializers-hash)
724                (make-instance 'eql-specializer :object object))))))
725
726
727(setq *no-applicable-method-hash* (make-hash-table :test 'eq :size 0 :weak :key))
728
729
730(defun make-no-applicable-method-function (gf)
731  (if *no-applicable-method-hash*
732    (progn
733      (or (gethash gf *no-applicable-method-hash*))
734      (setf (gethash gf *no-applicable-method-hash*)
735            (%cons-no-applicable-method gf)))
736    (%cons-no-applicable-method gf)))
737
738(defun %cons-no-applicable-method (gf)
739  (%cons-combined-method gf gf #'%%no-applicable-method))
740
741; Returns true if F is a combined-method that calls no-applicable-method
742(defun no-applicable-method-cm-p (f)
743  (and (typep f 'combined-method)
744       (eq '%%no-applicable-method
745           (function-name (%combined-method-dcode f)))))
746
747
748(defun %%no-applicable-method (gf args)
749  (if (listp args)
750    (apply #'no-applicable-method gf args)
751    (%apply-lexpr #'no-applicable-method gf args )))
752
753;;; if obsolete-wrappers-p is true, will rehash instead of grow.
754;;; It would be better to do the rehash in place, but I'm lazy today.
755
756
757(defun arg-wrapper (arg)
758  (or (standard-object-p arg)
759      (%class.own-wrapper (class-of arg))
760      (error "~a has no wrapper" arg)))
761
762;;;;;;;;;;;;;;;;;;;;;;;;; generic-function dcode ;;;;;;;;;;;;;;;;;;;;;;;;;;;
763
764;; dcode functions using other than *gf-proto*
765(defparameter dcode-proto-alist ())
766
767(defun register-dcode-proto (dcode proto)
768  (let ((a (assoc dcode dcode-proto-alist)))
769    (if a
770      (setf (cdr a) proto)
771      (push (cons dcode proto) dcode-proto-alist))))
772
773
774;;; Simple case for generic-functions with no specializers
775;;; Why anyone would want to do this I can't imagine.
776
777(defun %%0-arg-dcode (dispatch-table args) ; need to get gf from table
778  (let ((method (or (%gf-dispatch-table-ref dispatch-table 1)
779                    (0-arg-combined-method-trap
780                     (%gf-dispatch-table-gf dispatch-table)))))
781    (if (not (listp args))
782      (progn
783        (%apply-lexpr-tail-wise method args))
784      (apply method args))))
785
786(register-dcode-proto #'%%0-arg-dcode *gf-proto*)
787
788(defun dcode-too-few-args (arg-count cm-or-gf)
789  (error (make-condition 'too-few-arguments
790                         :nargs arg-count
791                         :fn (combined-method-gf cm-or-gf))))
792
793
794
795(defun %%1st-arg-dcode (dt  args)
796  ;(declare (dynamic-extent args))
797  (if (not (listp args))
798    (let* ((args-len (%lexpr-count args)))
799      (if (neq 0 args-len) 
800        (let ((method (%find-1st-arg-combined-method dt (%lexpr-ref args args-len 0))))
801          (%apply-lexpr-tail-wise method args))
802        (dcode-too-few-args 0 (%gf-dispatch-table-gf dt))))
803    (let* ()  ; happens if traced
804      (when (null args) (dcode-too-few-args 0 (%gf-dispatch-table-gf dt)))
805      (let ((method (%find-1st-arg-combined-method dt (%car args))))
806        (apply method args)))))
807(register-dcode-proto #'%%1st-arg-dcode *gf-proto*)
808
809(defun %%one-arg-dcode (dt  arg)
810  (let ((method (%find-1st-arg-combined-method dt arg)))
811    (funcall method arg)))
812(register-dcode-proto #'%%one-arg-dcode *gf-proto-one-arg*)
813
814;;; two args - specialized on first
815(defun %%1st-two-arg-dcode (dt arg1 arg2)
816  (let ((method (%find-1st-arg-combined-method dt arg1)))
817    (funcall method arg1 arg2)))
818(register-dcode-proto #'%%1st-two-arg-dcode *gf-proto-two-arg*)
819
820
821;;;  arg is dispatch-table and argnum is in the dispatch table
822(defun %%nth-arg-dcode (dt args)
823  (if (listp args)
824    (let* ((args-len (list-length args))
825           (argnum (%gf-dispatch-table-argnum dt)))
826      (declare (fixnum args-len argnum))
827      (when (>= argnum args-len) (dcode-too-few-args args-len (%gf-dispatch-table-gf dt)))
828      (let ((method (%find-nth-arg-combined-method dt (nth argnum args) args)))
829        (apply method args)))
830    (let* ((args-len (%lexpr-count args))
831           (argnum (%gf-dispatch-table-argnum dt)))
832      (declare (fixnum args-len argnum))
833      (when (>= argnum args-len) (dcode-too-few-args args-len (%gf-dispatch-table-gf dt)))
834      (let ((method (%find-nth-arg-combined-method dt (%lexpr-ref args args-len argnum) args)))
835        (%apply-lexpr-tail-wise method args)))))
836(register-dcode-proto #'%%nth-arg-dcode *gf-proto*)
837
838(defun 0-arg-combined-method-trap (gf)
839  (let* ((methods (%gf-methods gf))
840         (mc (%gf-method-combination gf))
841         (cm (if (eq mc *standard-method-combination*)
842               (make-standard-combined-method methods nil gf)
843               (compute-effective-method-function 
844                gf 
845                mc
846                (sort-methods (copy-list methods) nil)))))
847    (setf (%gf-dispatch-table-ref (%gf-dispatch-table gf) 1) cm)
848    cm))
849
850(defun compute-effective-method-function (gf mc methods) 
851  (if methods
852    (compute-effective-method gf mc methods)
853    (make-no-applicable-method-function gf)))
854
855(defun 1st-arg-combined-method-trap (gf wrapper arg)
856  ;; Here when we can't find the method in the dispatch table.
857  ;; Compute it and add it to the table.  This code will remain in Lisp.
858  (let ((table (%gf-dispatch-table gf))
859        (combined-method (compute-1st-arg-combined-method gf arg wrapper)))
860    (multiple-value-bind (index obsolete-wrappers-p)
861        (find-gf-dispatch-table-index table wrapper)
862      (if index
863          (if (%gf-dispatch-table-store-conditional table (%i+ index 1) combined-method)
864            (setf (%gf-dispatch-table-ref table index) wrapper))
865          (grow-gf-dispatch-table gf wrapper combined-method obsolete-wrappers-p)))
866    combined-method))
867
868(defvar *cpl-classes* nil)
869
870(defun %inited-class-cpl (class &optional initialize-can-fail)
871  (or (%class-cpl class)
872      (if (memq class *cpl-classes*)
873        (compute-cpl class)
874        (let ((*cpl-classes* (cons class *cpl-classes*)))
875          (declare (dynamic-extent *cpl-classes*))
876          (update-class class initialize-can-fail)
877          (%class-cpl class)))))
878
879
880(defun compute-1st-arg-combined-method (gf arg &optional 
881                                           (wrapper (arg-wrapper arg)))
882  (let* ((methods (%gf-dispatch-table-methods (%gf-dispatch-table gf)))
883         (cpl (%inited-class-cpl (%wrapper-class wrapper)))
884         (method-combination (%gf-method-combination gf))
885         applicable-methods eql-methods specializer)
886    (dolist (method methods)
887      (setq specializer (%car (%method.specializers method)))
888      (if (typep specializer 'eql-specializer)
889        (when (cpl-memq (%wrapper-class (arg-wrapper (eql-specializer-object specializer))) cpl)
890          (push method eql-methods))
891        (when (cpl-memq specializer cpl)
892          (push method applicable-methods))))
893    (if (null eql-methods)
894      (if (eq method-combination *standard-method-combination*)
895        (make-standard-combined-method applicable-methods (list cpl) gf)
896        (compute-effective-method-function 
897         gf 
898         method-combination
899         (sort-methods applicable-methods
900                       (list cpl)
901                       (%gf-precedence-list gf))))
902      (make-eql-combined-method 
903       eql-methods applicable-methods (list cpl) gf 0 nil method-combination))))
904     
905
906
907(defvar *combined-methods* (make-hash-table  :test 'equal :weak :value))                         
908
909(defun gethash-combined-method (key)
910  (gethash key *combined-methods*))
911
912(defun puthash-combined-method (key value)
913  (setf (gethash key *combined-methods*) value))
914
915;;; Some statistics on the hash table above
916(defvar *returned-combined-methods* 0)
917(defvar *consed-combined-methods* 0)
918
919;;; Assumes methods are already sorted if cpls is nil
920(defun make-standard-combined-method (methods cpls gf &optional
921                                              (ok-if-no-primaries (null methods)))
922  (unless (null cpls)
923    (setq methods (sort-methods 
924                   methods cpls (%gf-precedence-list (combined-method-gf gf)))))
925  (let* ((keywords (compute-allowable-keywords-vector gf methods))
926         (combined-method (make-standard-combined-method-internal
927                           methods gf keywords ok-if-no-primaries)))
928    (if (and keywords methods)
929      (make-keyword-checking-combined-method gf combined-method keywords)
930      combined-method)))
931
932
933;;; Initialized below after the functions exist.
934(defvar *clos-initialization-functions* nil)
935
936;;; Returns NIL if all keywords allowed, or a vector of the allowable ones.
937(defun compute-allowable-keywords-vector (gf methods)
938  (setq gf (combined-method-gf gf))
939  (unless (memq gf *clos-initialization-functions*)
940    (let* ((gbits (inner-lfun-bits gf))
941           (&key-mentioned-p (logbitp $lfbits-keys-bit gbits)))
942      (unless (or (logbitp $lfbits-aok-bit gbits)
943                  (dolist (method methods)
944                    (let ((mbits (lfun-bits (%method.function method))))
945                      (when (logbitp $lfbits-keys-bit mbits)
946                        (setq &key-mentioned-p t)
947                        (if (logbitp $lfbits-aok-bit mbits)
948                          (return t)))))
949                  (not &key-mentioned-p))
950        (let (keys)
951          (flet ((adjoin-keys (keyvect keys)
952                              (when keyvect
953                                (dovector (key keyvect) (pushnew key keys)))
954                              keys))
955            (when (logbitp $lfbits-keys-bit gbits)
956              (setq keys (adjoin-keys (%defgeneric-keys gf) keys)))
957            (dolist (method methods)
958              (let ((f (%inner-method-function method)))
959                (when (logbitp $lfbits-keys-bit (lfun-bits f))
960                  (setq keys (adjoin-keys (lfun-keyvect f) keys))))))
961          (apply #'vector keys))))))
962
963
964(defun make-keyword-checking-combined-method (gf combined-method keyvect)
965  (let* ((bits (inner-lfun-bits gf))
966         (numreq (ldb $lfbits-numreq bits))
967         (key-index (+ numreq (ldb $lfbits-numopt bits))))
968    (%cons-combined-method 
969     gf       
970     (vector key-index keyvect combined-method)
971     #'%%check-keywords)))
972
973
974
975(defun odd-keys-error (varg l) 
976  (let ((gf (combined-method-gf (%svref varg 2))))
977    (signal-program-error "Odd number of keyword args to ~s~%keyargs: ~s" gf l)))
978
979
980(defun bad-key-error (key varg l)
981  (let* ((keys (%svref varg 1))
982         (gf (combined-method-gf (%svref varg 2)))
983         (*print-array* t)
984         (*print-readably* t)
985         (readable-keys (format nil "~s" keys)))
986    (signal-program-error "Bad keyword ~s to ~s.~%keyargs: ~s~%allowable keys are ~a." key gf l readable-keys)))
987
988; vector arg is (vector key-index keyvect combined-method) ; the next combined method
989
990(defun %%check-keywords (vector-arg args)
991  (flet ((do-it (vector-arg args)
992           (let* ((args-len (length args))
993                  (keyvect (%svref vector-arg 1))
994                  (keyvect-len (length keyvect))
995                  (key-index (%svref vector-arg 0)))
996                                        ; vector arg is (vector key-index keyvect combined-method) ; the next combined method
997             (declare (fixnum args-len key-index keyvect-len))
998             (when (>= args-len key-index)
999               (let* ((keys-in (- args-len key-index))) ; actually * 2
1000                 (declare (fixnum  key-index keys-in keyvect-len))
1001                 (when (logbitp 0 keys-in) (odd-keys-error vector-arg (collect-lexpr-args args key-index args-len)))
1002                 (unless (%cadr (%pl-search (nthcdr key-index args) :allow-other-keys))
1003                   (do ((i key-index (+ i 2))
1004                        (kargs (nthcdr key-index args) (cddr kargs)))
1005                       ((eq i args-len))
1006                     (declare (fixnum i))
1007                     (let ((key (car kargs)))
1008                       (when (not (or (eq key :allow-other-keys)
1009                                      (dotimes (i keyvect-len nil)
1010                                        (if (eq key (%svref keyvect i))
1011                                          (return t)))))
1012                         (bad-key-error key vector-arg (collect-lexpr-args args key-index args-len))
1013                         ))))))
1014             (let ((method (%svref vector-arg 2)))
1015                                        ; magic here ?? not needed
1016               (apply method args)))))
1017    (if (listp args)
1018      (do-it vector-arg args)
1019      (with-list-from-lexpr (args-list args)
1020        (do-it vector-arg args-list)))))
1021
1022
1023
1024 
1025
1026
1027;;; called from %%call-next-method-with-args - its the key-or-init-fn
1028;;; called from call-next-method-with-args - just check the blooming keys
1029;;; dont invoke any methods - maybe use x%%check-keywords with last vector elt nil
1030; means dont call any methods - but need the gf or method for error message
1031(defun x-%%check-keywords (vector-arg ARGS)
1032  ;(declare (dynamic-extent args))
1033    ; vector arg is (vector key-index keyvect unused)
1034  (let* ((ARGS-LEN (length args))
1035         (keyvect (%svref vector-arg 1))
1036         (keyvect-len (length keyvect))
1037         (key-index (%svref vector-arg 0))
1038         (keys-in (- args-len key-index))
1039         aok)  ; actually * 2
1040    (declare (fixnum args-len key-index keys-in keyvect-len))
1041   
1042    (when (logbitp 0 keys-in) (odd-keys-error vector-arg (collect-lexpr-args args key-index args-len)))
1043    (do ((i key-index (+ i 2))
1044         (kargs (nthcdr key-index args) (cddr kargs)))
1045        ((eq i args-len))
1046      (declare (fixnum i))
1047      (when aok (return))
1048      (let ((key (car kargs)))
1049        (when (and (eq key :allow-other-keys)
1050                   (cadr kargs))
1051          (return))
1052        (when (not (dotimes (i keyvect-len nil)
1053                     (if (eq key (%svref keyvect i))
1054                       (return t))))
1055          ; not found - is :allow-other-keys t in rest of user args
1056          (when (not (do ((remargs kargs (cddr remargs)))
1057                         ((null remargs) nil)
1058                       (when (and (eq (car remargs) :allow-other-keys)
1059                                  (cadr remargs))
1060                         (setq aok t)
1061                         (return t))))             
1062            (bad-key-error key vector-arg 
1063                           (collect-lexpr-args args key-index args-len))))))))
1064#| ; testing
1065(setq keyvect  #(:a :b ))
1066(setq foo (make-array 3))
1067(setf (aref foo 0) keyvect (aref foo 1) 2)
1068(setf (aref foo 2)(method window-close (window)))
1069( %%check-keywords 1 2 :a 3 :c 4 foo)
1070( %%check-keywords 1 2 :a 3 :b 4 :d foo)
1071|#
1072 
1073   
1074
1075
1076
1077;;; Map an effective-method to it's generic-function.
1078;;; This is only used for effective-method's which are not combined-method's
1079;;; (e.g. those created by non-STANDARD method-combination)
1080(defvar *effective-method-gfs* (make-hash-table :test 'eq :weak :key))
1081
1082
1083(defun get-combined-method (method-list gf)
1084  (let ((cm (gethash-combined-method method-list)))
1085    (when cm
1086      (setq gf (combined-method-gf gf))
1087      (if (combined-method-p cm)
1088        (and (eq (combined-method-gf cm) gf) cm)
1089        (and (eq (gethash cm *effective-method-gfs*) gf) cm)))))
1090
1091(defun put-combined-method (method-list cm gf)
1092  (unless (%method-function-p cm)       ; don't bother with non-combined methods
1093    (puthash-combined-method method-list cm)
1094    (unless (combined-method-p cm)
1095      (setf (gethash cm *effective-method-gfs*) (combined-method-gf gf))))
1096  cm)
1097
1098(defun make-standard-combined-method-internal (methods gf &optional 
1099                                                       keywords
1100                                                       (ok-if-no-primaries
1101                                                        (null methods)))
1102  (let ((method-list (and methods (compute-method-list methods nil))))
1103    (if method-list                 ; no applicable primary methods
1104      (if (atom method-list)
1105        (%method.function method-list)    ; can jump right to the method-function
1106        (progn
1107          (incf *returned-combined-methods*)  ; dont need this
1108          (if (contains-call-next-method-with-args-p method-list)
1109            (make-cnm-combined-method gf methods method-list keywords)
1110            (or (get-combined-method method-list gf)
1111                (progn
1112                  (incf *consed-combined-methods*)  ; dont need this
1113                  (puthash-combined-method
1114                   method-list
1115                   (%cons-combined-method
1116                    gf method-list #'%%standard-combined-method-dcode)))))))
1117      (if ok-if-no-primaries
1118        (make-no-applicable-method-function (combined-method-gf gf))
1119        (no-applicable-primary-method gf methods)))))
1120
1121; Initialized after the initialization (generic) functions exist.
1122(defvar *initialization-functions-alist* nil)
1123
1124;;; This could be in-line above, but I was getting confused.
1125
1126;;; ok
1127(defun make-cnm-combined-method (gf methods method-list keywords)
1128  (setq gf (combined-method-gf gf))
1129  (let ((key (cons methods method-list)))
1130    (or (get-combined-method key gf)
1131        (let* (key-or-init-arg
1132               key-or-init-fn)
1133          (if keywords
1134            (let* ((bits (inner-lfun-bits gf))
1135                   (numreq (ldb $lfbits-numreq bits))
1136                   (key-index (+ numreq (ldb $lfbits-numopt bits))))
1137              (setq key-or-init-arg (vector key-index keywords gf))
1138              (setq key-or-init-fn #'x-%%check-keywords))
1139            (let ((init-cell (assq gf *initialization-functions-alist*)))
1140              (when init-cell               
1141                (setq key-or-init-arg init-cell)
1142                (setq key-or-init-fn #'%%cnm-with-args-check-initargs))))
1143          (incf *consed-combined-methods*)
1144          (let* ((vect (vector gf methods key-or-init-arg key-or-init-fn method-list))
1145                 (self (%cons-combined-method
1146                        gf vect #'%%cnm-with-args-combined-method-dcode)))
1147            ;(setf (svref vect 4) self)
1148            (puthash-combined-method ; if  testing 1 2 3 dont put in our real table
1149             key
1150             self))))))
1151
1152
1153(defparameter *check-call-next-method-with-args* t)
1154
1155(defun contains-call-next-method-with-args-p (method-list)
1156  (when *check-call-next-method-with-args*
1157    (let ((methods method-list)
1158          method)
1159      (loop
1160        (setq method (pop methods))
1161        (unless methods (return nil))
1162        (unless (listp method)
1163          (if (logbitp $lfbits-nextmeth-with-args-bit
1164                       (lfun-bits (%method.function method)))
1165            (return t)))))))
1166
1167;;; The METHODS arg is a sorted list of applicable methods.  Returns
1168;;; the method-list expected by
1169;;; %%before-and-after-combined-method-dcode or a single method, or
1170;;; NIL if there are no applicable primaries
1171(defun compute-method-list (methods &optional (sub-dispatch? t))
1172  (let (arounds befores primaries afters qs)
1173    (dolist (m methods)
1174      (setq qs (%method.qualifiers m))
1175      (if qs
1176        (if (cdr qs)
1177          (%invalid-method-error
1178           m "Multiple method qualifiers not allowed in ~s method combination"
1179           'standard)
1180          (case (car qs)
1181            (:before (push m befores))
1182            (:after (push m afters))
1183            (:around (push m arounds))
1184            (t (%invalid-method-error m "~s is not one of ~s, ~s, and ~s."
1185                                      (car qs) :before :after :around))))
1186        (push m primaries)))
1187    (setq primaries (nreverse primaries)
1188          arounds (nreverse arounds)
1189          befores (nreverse befores))
1190    (unless sub-dispatch?
1191      (setq primaries (nremove-uncallable-next-methods primaries)
1192            arounds (nremove-uncallable-next-methods arounds)))
1193    (flet ((next-method-bit-p (method)
1194                              (logbitp $lfbits-nextmeth-bit 
1195                                       (lfun-bits (%method.function method)))))
1196      (unless (null primaries)            ; return NIL if no applicable primary methods
1197        (when (and arounds
1198                   (not sub-dispatch?)
1199                   (not (next-method-bit-p (car (last arounds)))))
1200          ;; Arounds don't call-next-method, can't get to befores,
1201          ;; afters, or primaries
1202          (setq primaries arounds
1203                arounds nil
1204                befores nil
1205                afters nil))
1206        (if (and (null befores) (null afters)
1207                 (progn
1208                   (when arounds
1209                     (setq primaries (nconc arounds primaries)
1210                           arounds nil)
1211                     (unless sub-dispatch?
1212                       (setq primaries (nremove-uncallable-next-methods primaries))))
1213                   t)
1214                 (null (cdr primaries))
1215                 (not (next-method-bit-p (car primaries))))
1216          (car primaries)                 ; single method, no call-next-method
1217          (let ((method-list primaries))
1218            (if (or befores afters)
1219              (setq method-list (cons befores (cons afters method-list))))
1220            (nconc arounds method-list)))))))
1221
1222
1223
1224(defun %invalid-method-error (method format-string &rest format-args)
1225  (error "~s is an invalid method.~%~?" method format-string format-args))
1226
1227(defun %method-combination-error (format-string &rest args)
1228  (apply #'error format-string args))
1229
1230
1231
1232(defun combined-method-gf (gf-or-cm)
1233  (let ((gf gf-or-cm))
1234    (while (combined-method-p gf)
1235      (setq gf (lfun-name gf)))
1236    gf))
1237
1238
1239(defun nth-arg-combined-method-trap-0 (gf-or-cm table wrapper args)
1240  (let* ((argnum (%gf-dispatch-table-argnum table))
1241         (arg (nth argnum args)))
1242    (nth-arg-combined-method-trap gf-or-cm table argnum args arg wrapper)))
1243
1244
1245(defun nth-arg-combined-method-trap (gf-or-cm table argnum args &optional
1246                                              (arg (nth-or-gf-error 
1247                                                    argnum args gf-or-cm))
1248                                              (wrapper (arg-wrapper arg)))
1249  ;; Here when we can't find the method in the dispatch table.
1250  ;; Compute it and add it to the table.  This code will remain in Lisp.
1251  (multiple-value-bind (combined-method sub-dispatch?)
1252      (compute-nth-arg-combined-method
1253       gf-or-cm (%gf-dispatch-table-methods table) argnum args
1254       wrapper)
1255    (multiple-value-bind (index obsolete-wrappers-p)
1256        (find-gf-dispatch-table-index table wrapper)
1257      (if index
1258        (if (%gf-dispatch-table-store-conditional table (%i+ index 1) combined-method)
1259          (setf (%gf-dispatch-table-ref table index) wrapper))
1260        (grow-gf-dispatch-table gf-or-cm wrapper combined-method obsolete-wrappers-p)))
1261    (if sub-dispatch?
1262      (let ((table (%combined-method-methods combined-method)))
1263        (nth-arg-combined-method-trap
1264         combined-method
1265         table
1266         (%gf-dispatch-table-argnum table)
1267         args))
1268      combined-method)))
1269
1270;;; Returns (values combined-method sub-dispatch?)
1271;;; If sub-dispatch? is true, need to compute a combined-method on the
1272;;; next arg.
1273(defun compute-nth-arg-combined-method (gf methods argnum args &optional 
1274                                           (wrapper (arg-wrapper
1275                                                     (nth-or-gf-error
1276                                                      argnum args gf))))
1277  (let* ((cpl (%inited-class-cpl (%wrapper-class wrapper)))
1278         (real-gf (combined-method-gf gf))
1279         (mc (%gf-method-combination real-gf))
1280         (standard-mc? (eq mc *standard-method-combination*))
1281         applicable-methods eql-methods specializers specializer sub-dispatch?)
1282    (dolist (method methods)
1283      ;;(require-type method 'standard-method)   ; for debugging.
1284      (setq specializers (nthcdr argnum (%method.specializers method))
1285            specializer (%car specializers))
1286      (when (if (typep specializer 'eql-specializer)
1287              (when (cpl-memq (%wrapper-class
1288                                (arg-wrapper (eql-specializer-object specializer))) cpl)
1289                (push method eql-methods))
1290              (when (cpl-memq specializer cpl)
1291                (push method applicable-methods)))
1292        (if (contains-non-t-specializer? (%cdr specializers))
1293          (setq sub-dispatch? t))))
1294    (if (or eql-methods applicable-methods)
1295      (if (or (not standard-mc?)
1296            (contains-primary-method? applicable-methods)
1297            (contains-primary-method? eql-methods))
1298        (let ((cpls (args-cpls args)))
1299          (if eql-methods
1300            (make-eql-combined-method
1301             eql-methods applicable-methods cpls gf argnum sub-dispatch? mc)
1302            (if sub-dispatch?
1303              (values (make-n+1th-arg-combined-method applicable-methods gf argnum)
1304                      t)
1305              (if standard-mc?
1306                (make-standard-combined-method applicable-methods cpls gf)
1307                (compute-effective-method-function
1308                 real-gf mc (sort-methods applicable-methods
1309                                          (args-cpls args)
1310                                          (%gf-precedence-list real-gf)))))))
1311        (no-applicable-primary-method
1312         real-gf
1313         (sort-methods (append eql-methods applicable-methods)
1314                       (args-cpls args)
1315                       (%gf-precedence-list real-gf))))
1316       (make-no-applicable-method-function real-gf))))
1317
1318(defun nth-or-gf-error (n l gf)
1319  (declare (fixnum l))
1320  (do* ((i 0 (1+ i))
1321        (l l (cdr l)))
1322       ((null l) (dcode-too-few-args i gf))
1323    (declare (fixnum i))
1324    (if (= i n)
1325      (return (car l)))))
1326
1327(defun contains-non-t-specializer? (specializer-list)
1328  (dolist (s specializer-list nil)
1329    (unless (eq *t-class* s)
1330      (return t))))
1331
1332(defun contains-primary-method? (method-list)
1333  (dolist (m method-list nil)
1334    (if (null (%method.qualifiers m))
1335      (return t))))
1336
1337(defun args-cpls (args &aux res)
1338  (dolist (arg args)
1339    (push (%inited-class-cpl (%wrapper-class (arg-wrapper arg))) res))
1340  (nreverse res))
1341
1342
1343(defun compute-eql-combined-method-hash-table-threshold (&optional (iters 1000000) (max 200))
1344  (flet ((time-assq (cnt iters)
1345           (let ((alist (loop for i from 1 to cnt collect (cons i i)))
1346                 (start-time (get-internal-run-time))
1347                 (j 0)
1348                 res)
1349             (declare (fixnum j))
1350             (dotimes (i iters)
1351               (declare (fixnum i))
1352               (setq res (cdr (assq j alist)))
1353               (when (>= (incf j) cnt) (setq j 0)))
1354             (values (- (get-internal-run-time) start-time) res)))
1355         (time-hash (cnt iters)
1356           (let ((hash (make-hash-table :test 'eq))
1357                 start-time
1358                 (j 0)
1359                 res)
1360             (declare (fixnum j))
1361             (dotimes (i cnt)
1362               (setf (gethash i hash) i))
1363             (assert-hash-table-readonly hash)
1364             (setq start-time (get-internal-run-time))
1365             (dotimes (i iters)
1366               (declare (fixnum i))
1367               (setq res (gethash i hash))
1368               (when (>= (incf j) cnt) (setq j 0)))
1369             (values (- (get-internal-run-time) start-time) res))))
1370    (dotimes (i max)
1371      (let ((time-assq (time-assq i iters))
1372            (time-hash (time-hash i iters)))
1373        (format t "i: ~d, assq: ~d, hash: ~d~%" i time-assq time-hash)
1374        (when (> time-assq time-hash) (return i))))))
1375
1376;; Value computed on a dual-core 2.4 GHz AMD Opteron running FC3
1377;; This isn't the result of compute-eql-combined-method-hash-table-threshold,
1378;; it's the value at which assq takes 3/4 the time of hash, which weights
1379;; towards the worst case of the eql method, not the average for uniform inputs.
1380(defparameter *eql-combined-method-hash-table-threshold* 45)
1381
1382;;; A vector might be a little faster than an alist, but the hash table case
1383;;; will speed up large numbers of methods.
1384(defun make-eql-combined-method (eql-methods methods cpls gf argnum sub-dispatch? &optional
1385                                             (method-combination *standard-method-combination*))
1386  (let ((eql-ms (copy-list eql-methods))
1387        (precedence-list (%gf-precedence-list (combined-method-gf gf)))
1388        (standard-mc? (eq method-combination *standard-method-combination*))
1389        (real-gf (combined-method-gf gf))
1390        eql-method-alist
1391        (can-use-eq? t))
1392    (unless sub-dispatch?
1393      (setq methods (sort-methods methods cpls precedence-list)))
1394    (while eql-ms
1395      (let ((eql-element (eql-specializer-object (nth argnum (%method.specializers (car eql-ms)))))
1396            (this-element-methods eql-ms)
1397            cell last-cell)
1398        (if (or (and (numberp eql-element) (not (fixnump eql-element)))
1399                (macptrp eql-element))
1400          (setq can-use-eq? nil))
1401        (setf eql-ms (%cdr eql-ms)
1402              (%cdr this-element-methods) nil
1403              cell eql-ms)
1404        (while cell
1405          (if (eql eql-element
1406                     (eql-specializer-object (nth argnum (%method.specializers (car cell)))))
1407            (let ((cell-save cell))
1408              (if last-cell
1409                (setf (%cdr last-cell) (cdr cell))
1410                (setq eql-ms (cdr eql-ms)))
1411              (setf cell (cdr cell)
1412                    (%cdr cell-save) this-element-methods
1413                    this-element-methods cell-save))
1414            (setq last-cell cell
1415                  cell (cdr cell))))
1416        (let* ((sorted-methods
1417                (sort-methods (nreconc (copy-list this-element-methods)
1418                                       (copy-list methods))
1419                              cpls
1420                              precedence-list))
1421               (method-list (and standard-mc? (compute-method-list sorted-methods sub-dispatch?))))
1422          (when (or (not standard-mc?)
1423                    (memq method-list this-element-methods)
1424                    (and (consp method-list)
1425                         (labels ((member-anywhere (tem mlist)
1426                                    (member tem mlist
1427                                            :test #'(lambda (tem el)
1428                                                      (if (listp el)
1429                                                        (member-anywhere tem el)
1430                                                        (member el tem))))))
1431                           (member-anywhere this-element-methods method-list))))
1432            ; Do EQL comparison only if the EQL methods can run
1433            ; (e.g. does not come after a primary method that does not call-next-method)
1434            (push (cons eql-element
1435                        (if sub-dispatch?
1436                          (make-n+1th-arg-combined-method
1437                           sorted-methods gf argnum)
1438                          (if standard-mc?
1439                            (make-standard-combined-method sorted-methods nil gf)
1440                            (compute-effective-method-function
1441                             real-gf method-combination sorted-methods))))
1442                  eql-method-alist)))))
1443    ;;eql-method-alist has (element . combined-method) pairs.
1444    ;;for now, we're going to use assq or assoc
1445    (let ((default-method (if sub-dispatch?
1446                            (make-n+1th-arg-combined-method
1447                             methods gf argnum)
1448                            (if standard-mc?
1449                              (make-standard-combined-method methods nil gf t)
1450                              (compute-effective-method-function
1451                               real-gf method-combination methods)))))
1452      (if eql-method-alist
1453        (if (> (length eql-method-alist) *eql-combined-method-hash-table-threshold*)
1454          (let ((hash (make-hash-table :test (if can-use-eq? 'eq 'eql))))
1455            (dolist (pair eql-method-alist)
1456              (setf (gethash (car pair) hash) (cdr pair)))
1457            (assert-hash-table-readonly hash)
1458            (%cons-combined-method 
1459             gf (cons argnum (cons hash default-method))
1460             #'%%hash-table-combined-method-dcode))
1461          (%cons-combined-method
1462           gf (cons argnum (cons eql-method-alist default-method))
1463           (if can-use-eq? 
1464               #'%%assq-combined-method-dcode
1465               #'%%assoc-combined-method-dcode)))
1466        default-method))))
1467
1468
1469(defun %%assq-combined-method-dcode (stuff args)
1470  ;; stuff is (argnum eql-method-list . default-method)
1471  ;(declare (dynamic-extent args))
1472  (if (listp args)
1473    (let* ((args-len (list-length args))
1474           (argnum (car stuff)))
1475      (when (>= argnum args-len)(signal-program-error  "Too few args to ~s." (%method-gf (cddr stuff))))
1476      (let* ((arg (nth argnum args))
1477             (thing (assq arg (cadr stuff)))) ; are these things methods or method-functions? - fns   
1478        (if thing 
1479          (apply (cdr thing) args)
1480          (apply (cddr stuff) args))))
1481    (let* ((args-len (%lexpr-count args))
1482           (argnum (car stuff)))
1483      (when (>= argnum args-len)(signal-program-error "Too few args to ~s." (%method-gf (cddr stuff))))
1484      (let* ((arg (%lexpr-ref args args-len argnum))
1485             (thing (assq arg (cadr stuff))))
1486        (if thing 
1487          (%apply-lexpr (cdr thing) args)
1488          (%apply-lexpr (cddr stuff) args))))))
1489 
1490
1491(DEFun %%assoc-combined-method-dcode (stuff args)
1492  ;; stuff is (argnum eql-method-list . default-method)
1493  ;(declare (dynamic-extent args))
1494  (if (listp args)
1495    (let* ((args-len (list-length args))
1496           (argnum (car stuff)))
1497      (when (>= argnum args-len)(signal-program-error "Too few args to ~s." (%method-gf (cddr stuff))))
1498      (let* ((arg (nth argnum args))
1499             (thing (assoc arg (cadr stuff)))) ; are these things methods or method-functions?   
1500        (if thing 
1501          (apply (cdr thing) args)
1502          (apply (cddr stuff) args))))
1503    (let* ((args-len (%lexpr-count args))
1504           (argnum (car stuff)))
1505      (when (>= argnum args-len)(signal-program-error "Too few args to ~s." (%method-gf (cddr stuff))))
1506      (let* ((arg (%lexpr-ref args args-len argnum))
1507             (thing (assoc arg (cadr stuff)))) ; are these things methods or method-functions?   
1508        (if thing 
1509          (%apply-lexpr (cdr thing) args)
1510          (%apply-lexpr (cddr stuff) args))))))
1511
1512
1513
1514(defun %%hash-table-combined-method-dcode (stuff args)
1515  ;; stuff is (argnum eql-hash-table . default-method)
1516  ;(declare (dynamic-extent args))
1517  (if (listp args)
1518    (let* ((args-len (list-length args))
1519           (argnum (car stuff)))
1520      (when (>= argnum args-len)(signal-program-error "Too few args to ~s." (%method-gf (cddr stuff))))
1521      (let* ((arg (nth argnum args)))
1522        (apply (gethash arg (cadr stuff) (cddr stuff)) args)))
1523    (let* ((args-len (%lexpr-count args))
1524           (argnum (car stuff)))
1525      (when (>= argnum args-len)(signal-program-error "Too few args to ~s." (%method-gf (cddr stuff))))
1526      (let* ((arg (%lexpr-ref args args-len argnum)))
1527        (%apply-lexpr (gethash arg (cadr stuff) (cddr stuff)) args)))))
1528
1529
1530;;; Assumes the two methods have the same number of specializers and
1531;;; that each specializer of each method is in the corresponding
1532;;; element of cpls (e.g. cpls is a list of the cpl's for the classes
1533;;; of args for which both method1 & method2 are applicable.
1534(defun %method< (method1 method2 cpls)
1535  (let ((s1s (%method.specializers method1))
1536        (s2s (%method.specializers method2))
1537        s1 s2 cpl)
1538    (loop
1539      (if (null s1s)
1540        (return (method-qualifiers< method1 method2)))
1541      (setq s1 (%pop s1s)
1542            s2 (%pop s2s)
1543            cpl (%pop cpls))
1544      (cond ((typep s1 'eql-specializer) 
1545             (unless (eq s1 s2)
1546               (return t)))
1547            ((typep s2 'eql-specializer) (return nil))
1548            ((eq s1 s2))
1549            (t (return (%i< (cpl-index s1 cpl) (cpl-index s2 cpl))))))))
1550
1551(defun %simple-method< (method1 method2 cpl)
1552  (let ((s1 (%car (%method.specializers method1)))
1553        (s2 (%car (%method.specializers method2))))
1554    (cond ((typep s1 'eql-specializer) 
1555           (if (eq s1 s2)
1556             (method-qualifiers< method1 method2)
1557             t))
1558          ((typep s2 'eql-specializer) nil)
1559          ((eq s1 s2) (method-qualifiers< method1 method2))
1560          (t (%i< (cpl-index s1 cpl) (cpl-index s2 cpl))))))
1561
1562; Sort methods with argument-precedence-order
1563(defun %hairy-method< (method1 method2 cpls apo)
1564  (let ((s1s (%method.specializers method1))
1565        (s2s (%method.specializers method2))
1566        s1 s2 cpl index)
1567    (loop
1568      (if (null apo)
1569        (return (method-qualifiers< method1 method2)))
1570      (setq index (pop apo))
1571      (setq s1 (nth index s1s)
1572            s2 (nth index s2s)
1573            cpl (nth index cpls))
1574      (cond ((typep s1 'eql-specializer) 
1575             (unless (eq s1 s2)
1576               (return t)))
1577            ((typep s2 'eql-specializer) (return nil))
1578            ((eq s1 s2))
1579            (t (return (%i< (cpl-index s1 cpl) (cpl-index s2 cpl))))))))
1580
1581; This can matter if the user removes & reinstalls methods between
1582; invoking a generic-function and doing call-next-method with args.
1583; Hence, we need a truly canonical sort order for the methods
1584; (or a smarter comparison than EQUAL in %%cnm-with-args-check-methods).
1585(defun method-qualifiers< (method1 method2)
1586  (labels ((qualifier-list< (ql1 ql2 &aux q1 q2)
1587              (cond ((null ql1) (not (null ql2)))
1588                    ((null ql2) nil)
1589                    ((eq (setq q1 (car ql1)) (setq q2 (car ql2)))
1590                     (qualifier-list< (cdr ql1) (cdr ql2)))
1591                    ((string-lessp q1 q2) t)
1592                    ; This isn't entirely correct.
1593                    ; two qualifiers with the same pname in different packages
1594                    ; are not comparable here.
1595                    ; Unfortunately, users can change package names, hence,
1596                    ; comparing the package names doesn't work either.
1597                    (t nil))))
1598    (qualifier-list< (%method.qualifiers method1) (%method.qualifiers method2))))
1599       
1600(defun sort-methods (methods cpls &optional apo)
1601  (cond ((null cpls) methods)
1602        ((null (%cdr cpls))
1603         (setq cpls (%car cpls))
1604         (flet ((simple-sort-fn (m1 m2)
1605                  (%simple-method< m1 m2 cpls)))
1606           (declare (dynamic-extent #'simple-sort-fn))
1607           (%sort-list-no-key methods #'simple-sort-fn)))
1608        ((null apo)                     ; no unusual argument-precedence-order
1609         (flet ((sort-fn (m1 m2) 
1610                  (%method< m1 m2 cpls)))
1611           (declare (dynamic-extent #'sort-fn))
1612           (%sort-list-no-key methods #'sort-fn)))
1613        (t                              ; I guess some people are just plain rude
1614         (flet ((hairy-sort-fn (m1 m2)
1615                  (%hairy-method< m1 m2 cpls apo)))
1616           (declare (dynamic-extent #'hairy-sort-fn))
1617           (%sort-list-no-key methods #'hairy-sort-fn)))))
1618
1619(defun nremove-uncallable-next-methods (methods)
1620  (do ((m methods (%cdr m))
1621       mbits)
1622      ((null m))
1623    (setq mbits (lfun-bits (%method.function (%car m))))
1624    (unless (logbitp $lfbits-nextmeth-bit mbits)
1625      (setf (%cdr m) nil)
1626      (return)))
1627  methods)
1628
1629
1630(defun cpl-index (superclass cpl)
1631  ;; This will be table lookup later.  Also we'll prelookup the tables
1632  ;; in compute-1st-arg-combined-methods above.
1633  (locally (declare (optimize (speed 3)(safety 0)))
1634    (do ((i 0 (%i+ i 1))
1635         (cpl cpl (%cdr cpl)))
1636        ((null cpl) nil)
1637      (if (eq superclass (%car cpl))
1638        (return i)))))
1639
1640(defun cpl-memq (superclass cpl)
1641  (locally (declare (optimize (speed 3)(safety 0)))
1642    (do ((cpl cpl (%cdr cpl)))
1643        ((null cpl) nil)
1644      (if (eq superclass (%car cpl))
1645        (return cpl)))))
1646
1647;;; Combined method interpretation
1648
1649
1650;;; magic is a list of (cnm-cm (methods) . args) cnm-cm is the
1651;;; argument checker for call-next-method-with-args or nil could make
1652;;; it be a cons as a flag that magic has been heap consed - done
1653;;; could also switch car and cadr if we do &lexpr business then if
1654;;; cddr is lexpr-p (aka (not listp)) thats the clue also would need
1655;;; to do lexpr-apply or apply depending on the state.
1656
1657
1658(defun %%standard-combined-method-dcode (methods args)
1659  ;; combined-methods as made by make-combined-method are in methods
1660  ;; args are as put there by the caller of the gf.
1661  (let* ((car-meths (car methods))
1662         (cell-2 (cons methods args))
1663         (magic (cons nil cell-2)))
1664    ;; i.e. magic is nil methods . args
1665    (declare (dynamic-extent magic)
1666             (dynamic-extent cell-2))   
1667    (if (listp car-meths)
1668      (%%before-and-after-combined-method-dcode magic)
1669      (progn       
1670        (if (not (cdr methods))
1671          (%rplaca (cdr magic) car-meths)
1672          (%rplaca (cdr magic) (cdr methods)))
1673        ; so maybe its a combined-method ?? - no
1674        (apply-with-method-context magic (%method.function car-meths) args)))))
1675
1676;;; args is list, old-args may be lexpr
1677(defun cmp-args-old-args (args old-args numreq)
1678  (declare (optimize (speed 3)(safety 0)))
1679  (if (listp old-args)
1680    (do ((newl args (cdr newl))
1681         (oldl old-args (cdr oldl))
1682         (i 0 (1+ i)))
1683        ((eql i numreq) t)
1684      (when (neq (car newl)(car oldl))(return nil)))
1685    (let ((len (%lexpr-count old-args)))
1686      (do ((newl args (cdr newl))
1687           (i 0 (1+ i)))
1688          ((eql i numreq) t)
1689        (when (neq (car newl)(%lexpr-ref old-args len i))(return nil))))))       
1690
1691
1692; called from call-next-method-with-args with magic supplied and 1st time around with not
1693(defun %%cnm-with-args-combined-method-dcode (thing args &optional magic) ; was &rest args
1694  ;(declare (dynamic-extent args))
1695  ; now thing is vector of gf orig methods, arg for key or initarg check, key or initarg fnction
1696  ; and our job is to do all the arg checking
1697  (let ()
1698    (when magic
1699      (flet ((do-it (thing args)
1700               (let* ((args-len (length args))
1701                      (gf (svref thing 0))  ; could get this from a method
1702                      (numreq (ldb $lfbits-numreq (inner-lfun-bits gf)))
1703                      (next-methods (cadr magic)))
1704                 ;(when (null self)(error "Next method with args context error"))
1705                 (when (neq 0 numreq)
1706                   ; oh screw it - old-args may be lexpr too
1707                   (let ((old-args (cddr magic)))
1708                     (when (< args-len numreq) (signal-program-error "Too few args to ~S" gf))
1709                     (when (null (cmp-args-old-args args old-args numreq))
1710                       ; required args not eq - usually true, we expect
1711                       (let ((new-methods (%compute-applicable-methods* gf args))
1712                             (old-methods (svref thing 1)))
1713                         (when (not (equal new-methods old-methods))
1714                           (error '"Applicable-methods changed in call-next-method.~%~
1715                                    Should be: ~s~%Was: ~s~%Next-methods: ~s"
1716                                  old-methods new-methods next-methods))))))
1717                 (let ((key-or-init-fn (svref thing 3)))
1718                   (when key-or-init-fn 
1719                     ; was apply
1720                     (funcall key-or-init-fn (svref thing 2) args))))))
1721        (if (listp args)
1722          (do-it thing args)
1723          (with-list-from-lexpr (args-list args)
1724            (do-it thing args-list)))))
1725    ; ok done checking - lets do it
1726    (let* ((methods (if magic (cadr magic)(svref thing 4)))  ;<< was 5 this is nil unless cnm with args
1727           ; was if magic
1728           (car-meths (car methods))
1729           (cell-2 (cons methods args))
1730           (magic (cons thing cell-2)))
1731      (declare (dynamic-extent magic cell-2))
1732      ; i.e. magic is thing methods . args
1733      ;(%rplaca magic thing)
1734      ;(setf (cadr magic) methods)
1735      ;(%rplaca (cdr magic) methods)
1736      ;(setf (cddr magic) args)
1737      ;(%rplacd (cdr magic) args)
1738      (if (listp car-meths)
1739        (progn
1740          (%%before-and-after-combined-method-dcode magic))
1741        (progn       
1742          (if (not (cdr methods))
1743            (%rplaca (cdr magic) car-meths)
1744            (%rplaca (cdr magic) (cdr methods)))
1745          ; so maybe its a combined-method ?? - no
1746          (apply-with-method-context magic (%method.function car-meths) args))))))
1747
1748
1749
1750;;; here if car of methods is listp. methods = (befores afters . primaries)
1751(defun %%before-and-after-combined-method-dcode (magic) 
1752  (declare (list magic))
1753  (let* ((methods (cadr magic))         
1754         (befores (car methods))         
1755         (cdr-meths (cdr methods))
1756         (primaries (cdr cdr-meths))
1757         (afters (car cdr-meths))
1758         (args (cddr magic)))
1759    (declare (list befores afters primaries))
1760    (when befores 
1761      (dolist (method befores)
1762        (rplaca (cdr magic) method)
1763        (apply-with-method-context magic (%method.function method) args)))
1764    (let* ((cdr (cdr primaries))
1765           (method-function (%method.function (car primaries))))   ; guaranteed non nil?
1766      (rplaca (cdr magic) (if (null cdr)(car primaries) cdr))     
1767      (if (null afters)
1768        (apply-with-method-context magic method-function args)  ; tail call if possible
1769        (multiple-value-prog1
1770          (apply-with-method-context magic method-function args)       
1771          (dolist (method afters)
1772            (rplaca (cdr magic) method)
1773            (apply-with-method-context magic (%method.function method) args)))))))
1774
1775
1776; This is called by the compiler expansion of next-method-p
1777; I think there's a bug going around... LAP fever! I'm immune
1778(defun %next-method-p (magic)
1779  (let ((methods (%cadr magic)))
1780    (consp methods)))
1781
1782
1783(defun %call-next-method (magic &rest args) ; if args supplied they are new ones
1784  (declare (dynamic-extent args)) 
1785  (if args
1786    (apply #'%call-next-method-with-args magic args)
1787    (let* ((next-methods (%cadr magic))) ; don't get this closed magic stuff     
1788      (if (not (consp next-methods))
1789        ( %no-next-method  magic)           
1790        (let ((args (%cddr magic)))  ; get original args
1791          ;The unwind-protect is needed in case some hacker in his/her wisdom decides to:
1792          ; (defmethod foo (x) (catch 'foo (call-next-method)) (call-next-method))
1793          ; where the next-method throws to 'foo.
1794          ; The alternative is to make a new magic var with args
1795          ; actually not that fancy (call-next-method)(call-next-method) is same problem
1796          (let ()
1797            (unwind-protect
1798              (if (listp (car next-methods))
1799                ( %%before-and-after-combined-method-dcode magic)
1800                (let ((cdr (cdr next-methods)))
1801                  (rplaca (cdr magic)(if (not cdr)(car next-methods) cdr))
1802                  (let ((method-function (%method.function (car next-methods))))
1803                    (apply-with-method-context magic method-function args))))
1804              (rplaca (cdr magic) next-methods))))))))
1805
1806;; Note: we need to change the compiler to call this when it can prove that
1807;; call-next-method cannot be called a second time. I believe thats done.
1808
1809
1810(defun %tail-call-next-method (magic)
1811  (let* ((next-methods (%cadr magic))  ; or make it car
1812         (args (%cddr magic))) ; get original args       
1813    (if (not (consp next-methods)) ; or consp?
1814      ( %no-next-method magic)
1815      (if (listp (car next-methods))
1816        ( %%before-and-after-combined-method-dcode magic)
1817        (let ((cdr (cdr next-methods)))
1818          (rplaca (cdr magic) (if (not cdr)(car next-methods) cdr))
1819          (apply-with-method-context magic (%method.function (car next-methods)) args))))))
1820
1821;;; may be simpler to blow another cell so magic looks like
1822;;; (cnm-cm/nil next-methods . args) - done
1823;;; and also use first cell to mean heap-consed if itsa cons
1824
1825(defun %call-next-method-with-args (magic &rest args)
1826  (declare (dynamic-extent args))
1827  (if (null args)
1828    (%call-next-method magic)
1829    (let* ((methods (%cadr magic)))
1830      (if (not (consp methods))
1831        (%no-next-method  magic)
1832        (let* ((cnm-cm (car magic)))
1833          ; a combined method
1834          (when (consp cnm-cm)(setq cnm-cm (car cnm-cm)))
1835          ; could just put the vector in car magic & no self needed in vector?
1836          (let ((the-vect cnm-cm)) ;  <<
1837            (funcall #'%%cnm-with-args-combined-method-dcode ;(%combined-method-dcode cnm-cm)
1838                     the-vect
1839                     args
1840                     magic)))))))
1841
1842
1843
1844; called from x%%call-next-method-with-args - its the key-or-init-fn
1845(defun %%cnm-with-args-check-initargs (init-cell args)
1846  ; here we forget the lexpr idea because it wants to cdr
1847  ;(declare (dynamic-extent args))
1848  (let* ((rest (cdr args))
1849         (first-arg (car args)))
1850    (declare (list rest))
1851    (let* ((initargs rest)
1852           (init-function (car init-cell))
1853           (instance (cond ((eq init-function #'update-instance-for-different-class)
1854                            (setq initargs (cdr rest))
1855                            (car rest))
1856                           ((eq init-function #'shared-initialize)
1857                            (setq initargs (cdr rest))
1858                            first-arg)
1859                           ((eq init-function #'update-instance-for-redefined-class)
1860                            (setq initargs (%cdddr rest))
1861                            first-arg)
1862                           (t first-arg)))
1863           (class (class-of instance))
1864           bad-initarg)
1865      (dolist (functions (cdr init-cell)
1866                         (error "Bad initarg: ~s to call-next-method for ~s~%on ~s"
1867                                bad-initarg instance (car init-cell)))
1868        (multiple-value-bind 
1869          (errorp bad-key)
1870          (if (eq (car functions) #'initialize-instance)
1871            (apply #'check-initargs instance class initargs nil
1872                   #'initialize-instance #'allocate-instance #'shared-initialize
1873                   nil)
1874            (apply #'check-initargs instance class initargs nil functions))
1875          (if errorp
1876            (unless bad-initarg (setq bad-initarg bad-key))
1877            (return t)))))))
1878
1879
1880
1881(defun %no-next-method (magic)
1882  (let* ((method (%cadr magic)))
1883    (if (consp method) (setq method (car method)))
1884    (unless (typep method 'standard-method)
1885      (error "call-next-method called outside of generic-function dispatch context.~@
1886              Usually indicates an error in a define-method-combination form."))
1887    (let ((args (cddr magic))
1888          (gf (%method.gf method)))
1889      (if (listp args)
1890        (apply #'no-next-method gf method args)
1891        (%apply-lexpr #'no-next-method gf method args)))))
1892
1893
1894
1895
1896;;; This makes a consed version of the magic first arg to a method.
1897;;; Called when someone closes over the magic arg. (i.e. does (george
1898;;; #'call-next-method))
1899
1900(defun %cons-magic-next-method-arg (magic)
1901  ; car is a cons as a flag that its already heap-consed! - else cnm-cm or nil
1902  (if (consp (car magic))
1903    magic
1904    (list* (list (car magic))
1905           (if (consp (%cadr magic))
1906             (copy-list (%cadr magic)) ; is this copy needed - probably not
1907             (cadr magic))
1908           (let ((args (%cddr magic)))
1909             (if (listp args)
1910               (copy-list args)
1911               (let* ((len (%lexpr-count args))
1912                      (l (make-list len)))
1913                 (do ((i 0 (1+ i))
1914                      (list l (cdr list)))
1915                     ((null list))
1916                   (%rplaca list (%lexpr-ref args len i)))
1917                 l))))))
1918
1919
1920; Support CALL-METHOD in DEFINE-METHOD-COMBINATION
1921(defun %%call-method* (method next-methods args)
1922  (let* ((method-function (%method.function method))
1923         (bits (lfun-bits method-function)))
1924    (declare (fixnum bits))
1925    (if (not (and (logbitp $lfbits-nextmeth-bit  bits)
1926                  (logbitp  $lfbits-method-bit bits)))
1927      (if (listp args)
1928        (apply method-function args)
1929        (%apply-lexpr method-function args))
1930      (let* ((cell-2 (cons next-methods args))
1931             (magic (cons nil cell-2)))
1932        (declare (dynamic-extent magic)
1933                 (dynamic-extent cell-2)) 
1934        (if (null next-methods)
1935          (%rplaca (cdr magic) method))
1936        (apply-with-method-context magic method-function args)))))
1937
1938; Error checking version for user's to call
1939(defun %call-method* (method next-methods args)
1940  (let* ((method-function (%method.function method))
1941         (bits (lfun-bits method-function)))
1942    (declare (fixnum bits))
1943    (if (not (and (logbitp $lfbits-nextmeth-bit  bits)
1944                  (logbitp  $lfbits-method-bit bits)))
1945      (progn
1946        (require-type method 'standard-method)
1947        (if (listp args)
1948          (apply method-function args)
1949          (%apply-lexpr method-function args)))
1950      (progn
1951        (do* ((list next-methods (cdr list)))
1952             ((null list))
1953          (when (not (listp list))
1954            (%err-disp $XIMPROPERLIST next-methods))
1955          (when (not (standard-method-p (car list)))
1956            (report-bad-arg (car list) 'standard-method))) 
1957        (let* ((cell-2 (cons next-methods args))
1958               (magic (cons nil cell-2)))
1959          (declare (dynamic-extent magic)
1960                   (dynamic-extent cell-2)) 
1961          (if (null next-methods)
1962            (%rplaca (cdr magic) method))
1963          (apply-with-method-context magic method-function args))))))
1964
1965
1966
Note: See TracBrowser for help on using the repository browser.