Christophe Weblog Wiki Code Publications Music
content-negotiation is better described using OR method-combination
[specializable.git] / specializable.lisp
index e7e365c33ea4e250fe7b3e2896bdff297fd6c10a..8d01319b1267e28a5da465263fbb8b4df27163c5 100644 (file)
@@ -8,37 +8,64 @@
   (:export "SPECIALIZABLE-GENERIC-FUNCTION" "SPECIALIZABLE-METHOD"
            "EXTENDED-SPECIALIZER"
 
-           "SPECIALIZER-ACCEPTS-P" "SPECIALIZER-ACCEPTS-CLASS-P"
+           "SPECIALIZER-ACCEPTS-P" "SPECIALIZER-ACCEPTS-GENERALIZER-P"
            "SPECIALIZER<"
 
            "GENERALIZER-OF-USING-CLASS"
            "COMPUTE-APPLICABLE-METHODS-USING-GENERALIZERS"
+           "GENERALIZER-EQUAL-HASH-KEY"
            
            "DEFINE-EXTENDED-SPECIALIZER"))
 
 (in-package "SPECIALIZABLE")
 
 (defclass extended-specializer (sb-mop:specializer)
-  ((direct-methods :initform nil
-                   :accessor %specializer-direct-methods
-                   :reader specializer-direct-methods)))
+  ;; FIXME: this doesn't actually do quite what I wanted.
+  ((direct-methods-table :allocation :class
+                         :initform nil :accessor direct-methods-table)))
+
+(defmethod sb-mop:add-direct-method ((specializer extended-specializer) method)
+  (let* ((table (direct-methods-table specializer))
+         (cell (assoc specializer table :test #'sb-pcl::same-specializer-p)))
+    (unless cell
+      (setf cell (cons specializer nil))
+      (push cell (direct-methods-table specializer)))
+    (push method (cdr cell))))
+
+(defmethod sb-mop:remove-direct-method ((specializer extended-specializer) method)
+  (let* ((table (direct-methods-table specializer))
+         (cell (assoc specializer table :test #'sb-pcl::same-specializer-p)))
+    (setf (cdr cell) (remove method (cdr cell)))))
+
+(defmethod sb-mop:specializer-direct-methods ((specializer extended-specializer))
+  (cdr (assoc specializer (direct-methods-table specializer)
+              :test #'sb-pcl::same-specializer-p)))
+(defmethod sb-mop:specializer-direct-generic-functions ((specializer extended-specializer))
+  (remove-duplicates (mapcar #'sb-mop:method-generic-function (sb-mop:specializer-direct-methods specializer))))
 
 (defclass specializable-generic-function (standard-generic-function)
-  ((extended-specializers :initform (make-hash-table :test 'equal)
-                          :reader generic-function-extended-specializers)
-   (emf-table :initform (make-hash-table :test 'equal) :reader emf-table))
+  ((emf-table :initform (make-hash-table :test 'equal) :reader emf-table)
+   (cacheingp :initform t :initarg :cacheingp)
+   (single-arg-cacheing-p :initform t :initarg :single-arg-cacheing-p))
   (:metaclass sb-mop:funcallable-standard-class)
   (:default-initargs :method-class (find-class 'specializable-method)))
 
-(defclass specializable-method (standard-method)
-  ((lambda-expression :initarg :lambda-expression
-                     :accessor specializable-method-lambda-expression)))
+;;; TODO: we don't use this class yet, but we might do later
+(defclass specializable-method (standard-method) ())
+
+;;; TODO use info?
+(defun extended-specializer-name-p (name)
+  (and (symbolp name)
+       (get name 'extended-specializer-parser)))
+
+(deftype extended-specializer-name ()
+  `(satisfies extended-specializer-name-p))
 
 (defmacro define-extended-specializer (name (gf-var &rest args) &body body)
   ;; FIXME: unparser
   `(setf (get ',name 'extended-specializer-parser)
-        (lambda (,gf-var ,@args)
-          ,@body)))
+         (lambda (,gf-var ,@args)
+           ,@body)))
 
 ;; doesn't work, because we'd have to dump GF into the fasl for the macro
 ;; expansion
           '|This is not a generic function| ;fixme, see comment above
           args)))
 
-(defmethod sb-mop:add-direct-method ((specializer extended-specializer) method)
-  (pushnew method (%specializer-direct-methods specializer)))
-
-(defmethod sb-mop:remove-direct-method ((specializer extended-specializer) method)
-  (setf (%specializer-direct-methods specializer)
-        (remove method (specializer-direct-methods specializer))))
-
 ;;; from SBCL:
 
 (defmethod sb-pcl:parse-specializer-using-class
-    ((gf specializable-generic-function) name)
-  (cond
-    ((typep name 'sb-mop:specializer) name)
-    ((symbolp name) (find-class name))
-    ((consp name)
-     (case (car name)
-       (eql (sb-mop:intern-eql-specializer (cadr name)))
-       (t (make-extended-specializer name))))
-    (t (error "unexpected specializer name"))))
+    ((gf specializable-generic-function) (specializer-name t))
+  (if (typep specializer-name '(cons extended-specializer-name))
+      (make-extended-specializer specializer-name)
+      (call-next-method)))
 
 (defmethod sb-pcl:make-method-specializers-form
     ((gf specializable-generic-function) method snames env)
       (error "Too few arguments to generic function ~S." gf))
     (subseq args 0 number-required)))
 
+(defgeneric generalizer-equal-hash-key (generic-function generalizer))
+(defmethod generalizer-equal-hash-key
+    ((gf specializable-generic-function) (g class))
+  (sb-pcl::class-wrapper g))
+
+(defun first-arg-only-special-case (gf)
+  (let ((arg-info (sb-pcl::gf-arg-info gf)))
+    (and (slot-value gf 'single-arg-cacheing-p)
+         (>= (sb-pcl::arg-info-number-required arg-info) 1)
+         (every (lambda (x) (eql x t))
+                (cdr (sb-pcl::arg-info-metatypes arg-info))))))
+
 ;;; FIXME: in some kind of order, the discriminating function needs to handle:
 ;;; - argument count checking;
-;;; - keyword argument validity;
-;;; - flushing the emf cache on method addition/removal
-;;; - flushing the cache on class redefinition;
+;;; - DONE (in effective method) keyword argument validity;
+;;; - DONE flushing the emf cache on method addition/removal
+;;; - DONE (sort of, using wrappers/g-e-h-k) flushing the cache on class redefinition;
 ;;; - cache thread-safety.
+;;; - speed
+;;; - DONE (in SBCL itself) interaction with TRACE et al.
 (defmethod sb-mop:compute-discriminating-function ((gf specializable-generic-function))
-  (lambda (&rest args)
-    (let* ((generalizers (mapcar (lambda (x) (generalizer-of-using-class gf x))
-                                 (required-portion gf args)))
-          (emfun (gethash generalizers (emf-table gf) nil)))
-      (if emfun
-         (funcall emfun args)
-         (slow-method-lookup gf args generalizers)))))
+  (cond
+    ((not (slot-value gf 'cacheingp))
+     (lambda (&rest args)
+       (let ((generalizers (mapcar (lambda (x) (generalizer-of-using-class gf x))
+                                   args)))
+         (slow-method-lookup-and-call gf args generalizers))))
+    ((first-arg-only-special-case gf)
+     (lambda (&rest args)
+       (let* ((g (generalizer-of-using-class gf (car args)))
+              (k (generalizer-equal-hash-key gf g))
+              (emfun (gethash k (emf-table gf) nil)))
+         (if emfun
+             (sb-pcl::invoke-emf emfun args)
+             (slow-method-lookup-and-call
+              gf args (cons g (mapcar (lambda (x) (generalizer-of-using-class gf x))
+                                      (cdr (required-portion gf args)))))))))
+    (t
+     (lambda (&rest args)
+       (let* ((generalizers (mapcar (lambda (x) (generalizer-of-using-class gf x))
+                                    (required-portion gf args)))
+              (keys (mapcar (lambda (x) (generalizer-equal-hash-key gf x)) generalizers))
+              (emfun (gethash keys (emf-table gf) nil)))
+         (if emfun
+             (sb-pcl::invoke-emf emfun args)
+             (slow-method-lookup-and-call gf args generalizers)))))))
+
+(defmethod reinitialize-instance :after ((gf specializable-generic-function) &key)
+  (clrhash (emf-table gf)))
 
 (defun slow-method-lookup (gf args generalizers)
-  ;; differs from closette
   (multiple-value-bind (applicable-methods definitivep)
       (compute-applicable-methods-using-generalizers gf generalizers)
-    (if definitivep
-       (let* ((emfun
-               (compute-effective-method-function gf applicable-methods)))
-         (setf (gethash generalizers (emf-table gf)) emfun)
-         (funcall emfun args))
-       (funcall (compute-effective-method-function
-                  gf (sb-mop:compute-applicable-methods gf args))
-                 args))))
+    (unless definitivep
+      (setf applicable-methods (compute-applicable-methods gf args)))
+    (values (compute-effective-method-function gf applicable-methods)
+            definitivep)))
+
+(defun slow-method-lookup-and-call (gf args generalizers)
+  (multiple-value-bind (emf cacheablep)
+      (slow-method-lookup gf args generalizers)
+    (when cacheablep
+      (let ((keys (mapcar (lambda (x) (generalizer-equal-hash-key gf x)) generalizers)))
+        (if (first-arg-only-special-case gf)
+            (setf (gethash (car keys) (emf-table gf)) emf)
+            (setf (gethash keys (emf-table gf)) emf))))
+    (sb-pcl::invoke-emf emf args)))
+
+(defun compute-effective-method-function (gf methods)
+  (if (null methods)
+      (lambda (&rest args) (apply #'no-applicable-method gf args))
+      (let* ((mc (sb-mop:generic-function-method-combination gf))
+             (sb-pcl::*applicable-methods* methods)
+             (em (sb-mop:compute-effective-method gf mc methods)))
+        (sb-pcl::make-effective-method-function gf em))))
 
 ;; new, not in closette
 (defgeneric generalizer-of-using-class (generic-function object))
 (defmethod generalizer-of-using-class ((generic-function specializable-generic-function) object)
   (class-of object))
 
-(defgeneric specializer-accepts-generalizer-p (specializer generalizer))
-(defmethod specializer-accepts-generalizer-p ((specializer class) (generalizer class))
-  ;; does the specializer's object have the -same- class as the the actual
-  ;; argument?
+(defgeneric specializer-accepts-generalizer-p (gf specializer generalizer))
+(defmethod specializer-accepts-generalizer-p
+    ((gf specializable-generic-function) (specializer class) (generalizer class))
   (if (subtypep generalizer specializer)
-      ;; definitive: this method matches all instances of this class
       (values t t)
-      ;; definitive: this method doesn't match instances of this class
       (values nil t)))
 (defmethod specializer-accepts-generalizer-p
-    ((specializer sb-mop:eql-specializer) (generalizer class))
-  ;; does the specializer's object have the -same- class as the actual
-  ;; argument?
+    ((gf specializable-generic-function) (specializer sb-mop:eql-specializer) (generalizer class))
   (if (eq generalizer (class-of (sb-mop:eql-specializer-object specializer)))
-      ;; not definitive, since the actual object might differ
       (values t nil)
-      ;; definitely not the same object
       (values nil t)))
 
 (defgeneric compute-applicable-methods-using-generalizers (gf generalizers))
     (flet ((filter (method)
              (every (lambda (s g)
                       (multiple-value-bind (acceptsp definitivep)
-                          (specializer-accepts-generalizer-p s g)
+                          (specializer-accepts-generalizer-p gf s g)
                         (unless definitivep
                           (setf result-definitive-p nil))
                         acceptsp))
        (method-more-specific-p gf m1 m2 generalizers)))))
 
 (defun method-more-specific-p (gf method1 method2 generalizers)
-  ;; differs from closette
-  (declare (ignore gf))
   ;; FIXME: argument precedence order
   (block nil
     (mapc #'(lambda (spec1 spec2 generalizer)
-             (ecase (specializer< spec1 spec2 generalizer)
+             (ecase (specializer< gf spec1 spec2 generalizer)
                (< (return t))
                (=)
                ((nil > /=) (return nil))))
     nil))
 
 ;; new, not in closette
-(defgeneric specializer< (s1 s2 generalizer))
-(defmethod specializer< ((s1 class) (s2 class) (generalizer class))
+(defgeneric specializer< (gf s1 s2 generalizer))
+(defmethod specializer<
+    ((gf specializable-generic-function) (s1 class) (s2 class) (generalizer class))
   (if (eq s1 s2)
       '=
       (let ((cpl (sb-mop:class-precedence-list generalizer)))
        (if (find s2 (cdr (member s1 cpl)))
            '<
-           nil))))
+            '>))))
 (defmethod specializer<
-    ((s1 sb-mop:eql-specializer) (s2 sb-mop:eql-specializer) generalizer)
+    ((gf specializable-generic-function) (s1 sb-mop:eql-specializer) (s2 sb-mop:eql-specializer) generalizer)
   (declare (ignore generalizer))
   (if (eq (sb-mop:eql-specializer-object s1) (sb-mop:eql-specializer-object s2))
       '=
       nil))
-(defmethod specializer< ((s1 sb-mop:eql-specializer) (s2 class) generalizer)
+(defmethod specializer< ((gf specializable-generic-function) (s1 sb-mop:eql-specializer) (s2 class) generalizer)
   (declare (ignore generalizer))
   '<)
-(defmethod specializer< ((c1 class) (c2 sb-mop:eql-specializer) generalizer)
+(defmethod specializer< ((gf specializable-generic-function) (c1 class) (c2 sb-mop:eql-specializer) generalizer)
   (declare (ignore generalizer))
   '>)
-\f
-;;;; method combination
-
-;;; FIXME: this is actually only standard method combination.
-
-;; unchanged from closette
-(defun primary-method-p (method)
-  (null (method-qualifiers method)))
-(defun before-method-p (method)
-  (equal '(:before) (method-qualifiers method)))
-(defun after-method-p (method)
-  (equal '(:after) (method-qualifiers method)))
-(defun around-method-p (method)
-  (equal '(:around) (method-qualifiers method)))
-
-;;; (defun compute-effective-method-function (gf methods)
-;;;   (let ((primaries (remove-if-not #'primary-method-p methods))
-;;;         (around (find-if #'around-method-p methods)))
-;;;     (when (null primaries)
-;;;       (error "No primary methods for the~@
-;;;              generic function ~S." gf))
-;;;     (if around
-;;;         (let ((next-emfun
-;;;           (compute-effective-method-function gf (remove around methods))))
-;;;           #'(lambda (args)
-;;;               (funcall (method-function around) args next-emfun)))
-;;;         (let ((next-emfun (compute-primary-emfun (cdr primaries)))
-;;;          (befores (remove-if-not #'before-method-p methods))
-;;;          (reverse-afters
-;;;           (reverse (remove-if-not #'after-method-p methods))))
-;;;           #'(lambda (args)
-;;;               (dolist (before befores)
-;;;                 (funcall (method-function before) args nil))
-;;;               (multiple-value-prog1
-;;;              (funcall (method-function (car primaries)) args next-emfun)
-;;;                 (dolist (after reverse-afters)
-;;;                   (funcall (method-function after) args nil))))))))
-
-(defun compute-effective-method-function (gf methods)
-  (let* ((primaries
-         (or (remove-if-not #'primary-method-p methods)
-             (error "No primary methods for the generic function ~S." gf)))
-        (primary-emf
-         (let* ((nexts (mapcar #'sb-mop:method-function (cdr primaries)))
-                (befores (remove-if-not #'before-method-p methods))
-                (reverse-afters
-                 (reverse (remove-if-not #'after-method-p methods))))
-           #'(lambda (args)
-               (dolist (before befores)
-                 (funcall (sb-mop:method-function before) args nil))
-               (multiple-value-prog1
-                   (funcall (sb-mop:method-function (car primaries))
-                            args
-                            nexts)
-                 (dolist (after reverse-afters)
-                   (funcall (sb-mop:method-function after) args nil))))))
-        (arounds (remove-if-not #'around-method-p methods)))
-    (if arounds
-        (let ((next (append (mapcar #'sb-mop:method-function (cdr arounds))
-                           (lambda (args nexts)
-                             (declare (ignore nexts))
-                             (funcall primary-emf args)))))
-         (lambda (args)
-           (funcall (sb-mop:method-function (car arounds))
-                    args
-                    next)))
-        primary-emf)))