source: release/1.6/source/level-1/l1-dcode.lisp @ 15888

Last change on this file since 15888 was 14864, checked in by rme, 8 years ago

Reader method optimization/pessimization fixes from trunk.

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