emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] master a9a3d42: * lisp/emacs-lisp/cl-generic.el (cl--gener


From: Stefan Monnier
Subject: [Emacs-diffs] master a9a3d42: * lisp/emacs-lisp/cl-generic.el (cl--generic-method): New struct.
Date: Mon, 26 Jan 2015 16:43:13 +0000

branch: master
commit a9a3d429e6e53e2be0b20e84f9809dba1d03e52d
Author: Stefan Monnier <address@hidden>
Commit: Stefan Monnier <address@hidden>

    * lisp/emacs-lisp/cl-generic.el (cl--generic-method): New struct.
    
    (cl--generic): The method-table is now a (list-of cl--generic-method).
    (cl--generic-member-method): New function.
    (cl-generic-define-method): Use it.
    (cl--generic-build-combined-method, cl--generic-cache-miss):
    Adapt to new method-table.
    (cl--generic-no-next-method-function): Add `method' argument.
    (cl-generic-call-method): Adapt to new method representation.
    (cl--generic-cnm-sample, cl--generic-nnm-sample): Adjust.
    (cl-find-method, cl-method-qualifiers): New functions.
    (cl--generic-method-info): Adapt to new method representation.
    Return a string for the qualifiers.
    (cl--generic-describe):
    * lisp/emacs-lisp/eieio-opt.el (eieio-help-class): Adjust accordingly.
    (eieio-all-generic-functions, eieio-method-documentation):
    Adjust to new method representation.
    
    * lisp/emacs-lisp/eieio-compat.el (eieio--defmethod): Use cl-find-method.
    
    * test/automated/cl-generic-tests.el: Try and make sure cl-lib is not
    required at run-time.
---
 lisp/ChangeLog                     |   22 +++++
 lisp/emacs-lisp/cl-generic.el      |  158 +++++++++++++++++++++---------------
 lisp/emacs-lisp/eieio-compat.el    |    9 +-
 lisp/emacs-lisp/eieio-opt.el       |   18 ++---
 test/ChangeLog                     |    5 +
 test/automated/cl-generic-tests.el |    4 +-
 6 files changed, 133 insertions(+), 83 deletions(-)

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 0bdf4e2..ff352a2 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,27 @@
 2015-01-26  Stefan Monnier  <address@hidden>
 
+
+       * emacs-lisp/cl-generic.el (cl--generic-method): New struct.
+       (cl--generic): The method-table is now a (list-of cl--generic-method).
+       (cl--generic-member-method): New function.
+       (cl-generic-define-method): Use it.
+       (cl--generic-build-combined-method, cl--generic-cache-miss):
+       Adapt to new method-table.
+       (cl--generic-no-next-method-function): Add `method' argument.
+       (cl-generic-call-method): Adapt to new method representation.
+       (cl--generic-cnm-sample, cl--generic-nnm-sample): Adjust.
+       (cl-find-method, cl-method-qualifiers): New functions.
+       (cl--generic-method-info): Adapt to new method representation.
+       Return a string for the qualifiers.
+       (cl--generic-describe):
+       * emacs-lisp/eieio-opt.el (eieio-help-class): Adjust accordingly.
+       (eieio-all-generic-functions, eieio-method-documentation):
+       Adjust to new method representation.
+
+       * emacs-lisp/eieio-compat.el (eieio--defmethod): Use cl-find-method.
+
+2015-01-26  Stefan Monnier  <address@hidden>
+
        * emacs-lisp/cl-generic.el: Add a method-combination hook.
        (cl-generic-method-combination-function): New var.
        (cl--generic-lambda): Remove `with-cnm' arg.
diff --git a/lisp/emacs-lisp/cl-generic.el b/lisp/emacs-lisp/cl-generic.el
index 4245959..1bb7096 100644
--- a/lisp/emacs-lisp/cl-generic.el
+++ b/lisp/emacs-lisp/cl-generic.el
@@ -33,10 +33,6 @@
 ;;   code generation.  Given how rarely method-combinations are used,
 ;;   I just provided a cl-generic-method-combination-function, which
 ;;   people can use if they are really desperate for such functionality.
-;; - Method and generic function objects: CLOS defines methods as objects
-;;   (same for generic functions), whereas we don't offer such an abstraction.
-;; - `no-next-method' should receive the "calling method" object, but since we
-;;   don't have such a thing, we pass nil instead.
 ;; - In defgeneric we don't support the options:
 ;;   declare, :method-combination, :generic-function-class, :method-class,
 ;;   :method.
@@ -50,6 +46,8 @@
 ;;   eieio-core adds dispatch on:
 ;;   - class of eieio objects
 ;;   - actual class argument, using the syntax (subclass <class>).
+;; - cl-generic-method-combination-function (i.s.o define-method-combination).
+;; - cl-generic-call-method (which replaces make-method and call-method).
 
 ;; Efficiency considerations: overall, I've made an effort to make this fairly
 ;; efficient for the expected case (e.g. no constant redefinition of methods).
@@ -103,6 +101,18 @@ that for all other (PRIORITY . TAGCODE) where PRIORITY ≤ 
N, then
   "Function to get the list of types that a given \"tag\" matches.
 They should be sorted from most specific to least specific.")
 
+(cl-defstruct (cl--generic-method
+               (:constructor nil)
+               (:constructor cl--generic-method-make
+                (specializers qualifiers uses-cnm function))
+               (:predicate nil))
+  (specializers nil :read-only t :type list)
+  (qualifiers   nil :read-only t :type (list-of atom))
+  ;; USES-CNM is a boolean indicating if FUNCTION expects an extra argument
+  ;; holding the next-method.
+  (uses-cnm     nil :read-only t :type boolean)
+  (function     nil :read-only t :type function))
+
 (cl-defstruct (cl--generic
                (:constructor nil)
                (:constructor cl--generic-make
@@ -116,12 +126,7 @@ They should be sorted from most specific to least 
specific.")
   ;; decide in which order to sort them.
   ;; The most important dispatch is last in the list (and the least is first).
   (dispatches nil :type (list-of (cons natnum (list-of tagcode))))
-  ;; `method-table' is a list of
-  ;; ((SPECIALIZERS . QUALIFIERS) USES-CNM . FUNCTION), where
-  ;; USES-CNM is a boolean indicating if FUNCTION calls `cl-call-next-method'
-  ;; (and hence expects an extra argument holding the next-method).
-  (method-table nil :type (list-of (cons (cons (list-of type) (list-of atom))
-                                         (cons boolean function)))))
+  (method-table nil :type (list-of cl--generic-method)))
 
 (defmacro cl--generic (name)
   `(get ,name 'cl--generic))
@@ -344,15 +349,25 @@ which case this method will be invoked when the argument 
is `eql' to VAL.
          (cl-generic-define-method ',name ',qualifiers ',args
                                    ,uses-cnm ,fun)))))
 
+(defun cl--generic-member-method (specializers qualifiers methods)
+  (while
+      (and methods
+           (let ((m (car methods)))
+             (not (and (equal (cl--generic-method-specializers m) specializers)
+                       (equal (cl--generic-method-qualifiers m) qualifiers)))))
+    (setq methods (cdr methods))
+    methods))
+
 ;;;###autoload
 (defun cl-generic-define-method (name qualifiers args uses-cnm function)
   (let* ((generic (cl-generic-ensure-function name))
          (mandatory (cl--generic-mandatory-args args))
          (specializers
           (mapcar (lambda (arg) (if (consp arg) (cadr arg) t)) mandatory))
-         (key (cons specializers qualifiers))
+         (method (cl--generic-method-make
+                  specializers qualifiers uses-cnm function))
          (mt (cl--generic-method-table generic))
-         (me (assoc key mt))
+         (me (cl--generic-member-method specializers qualifiers mt))
          (dispatches (cl--generic-dispatches generic))
          (i 0))
     (dolist (specializer specializers)
@@ -367,9 +382,8 @@ which case this method will be invoked when the argument is 
`eql' to VAL.
                 (nreverse (sort (cons tagcode (cdr x))
                                 #'car-less-than-car))))
         (setq i (1+ i))))
-    (if me (setcdr me (cons uses-cnm function))
-      (setf (cl--generic-method-table generic)
-            (cons `(,key ,uses-cnm . ,function) mt)))
+    (if me (setcar me method)
+      (setf (cl--generic-method-table generic) (cons method mt)))
     (cl-pushnew `(cl-defmethod . (,(cl--generic-name generic) . ,specializers))
                 current-load-list :test #'equal)
     (let ((gfun (cl--generic-make-function generic))
@@ -459,47 +473,40 @@ for all those different tags in the method-cache.")
       (gethash (cons generic-name methods)
                cl--generic-combined-method-memoization)
     (let ((mets-by-qual ()))
-      (dolist (qm methods)
-        (let* ((qualifiers (cdar qm))
+      (dolist (method methods)
+        (let* ((qualifiers (cl--generic-method-qualifiers method))
                (x (assoc qualifiers mets-by-qual)))
           ;; FIXME: sadly, alist-get only uses `assq' and we need `assoc'.
           ;;(push (cdr qm) (alist-get qualifiers mets-by-qual)))
           (if x
-              (push (cdr qm) (cdr x))
-            (push (list qualifiers (cdr qm)) mets-by-qual))))
+              (push method (cdr x))
+            (push (list qualifiers method) mets-by-qual))))
       (funcall cl-generic-method-combination-function
                generic-name mets-by-qual))))
 
-(defun cl--generic-no-next-method-function (generic)
+(defun cl--generic-no-next-method-function (generic method)
   (lambda (&rest args)
-    ;; FIXME: CLOS passes as second arg the "calling method".
-    ;; We don't currently have "method objects" like CLOS
-    ;; does so we can't really do it the CLOS way.
-    ;; The closest would be to pass the lambda corresponding
-    ;; to the method, or maybe the ((SPECIALIZERS
-    ;; . QUALIFIER) USE-CNM . FUNCTION) entry from the method
-    ;; table, but the caller wouldn't be able to do much with
-    ;; it anyway.  So we pass nil for now.
-    (apply #'cl-no-next-method generic nil args)))
+    (apply #'cl-no-next-method generic method args)))
 
 (defun cl-generic-call-method (generic-name method &optional fun)
   "Return a function that calls METHOD.
 FUN is the function that should be called when METHOD calls
 `call-next-method'."
-  (pcase method
-    (`(nil . ,method) method)
-    (`(,_uses-cnm . ,method)
-     (let ((next (or fun (cl--generic-no-next-method-function generic-name))))
-       (lambda (&rest args)
-         (apply method
-                ;; FIXME: This sucks: passing just `next' would
-                ;; be a lot more efficient than the lambda+apply
-                ;; quasi-η, but we need this to implement the
-                ;; "if call-next-method is called with no
-                ;; arguments, then use the previous arguments".
-                (lambda (&rest cnm-args)
-                  (apply next (or cnm-args args)))
-                args))))))
+  (if (not (cl--generic-method-uses-cnm method))
+      (cl--generic-method-function method)
+    (let ((met-fun (cl--generic-method-function method))
+          (next (or fun (cl--generic-no-next-method-function
+                         generic-name method))))
+      (lambda (&rest args)
+        (apply met-fun
+               ;; FIXME: This sucks: passing just `next' would
+               ;; be a lot more efficient than the lambda+apply
+               ;; quasi-η, but we need this to implement the
+               ;; "if call-next-method is called with no
+               ;; arguments, then use the previous arguments".
+               (lambda (&rest cnm-args)
+                 (apply next (or cnm-args args)))
+               args)))))
 
 (defun cl--generic-standard-method-combination (generic-name mets-by-qual)
   (dolist (x mets-by-qual)
@@ -533,10 +540,10 @@ FUN is the function that should be called when METHOD 
calls
         (setq fun (cl-generic-call-method generic-name method fun)))
       fun))))
 
-(defconst cl--generic-nnm-sample (cl--generic-no-next-method-function 'dummy))
+(defconst cl--generic-nnm-sample (cl--generic-no-next-method-function t t))
 (defconst cl--generic-cnm-sample
   (funcall (cl--generic-build-combined-method
-            nil `(((specializer . nil) t . ,#'identity)))))
+            nil (list (cl--generic-method-make () () t #'identity)))))
 
 (defun cl--generic-isnot-nnm-p (cnm)
   "Return non-nil if CNM is the function that calls `cl-no-next-method'."
@@ -567,11 +574,13 @@ FUN is the function that should be called when METHOD 
calls
 (defun cl--generic-cache-miss (generic dispatch-arg dispatches-left tags)
   (let ((types (apply #'append (mapcar cl-generic-tag-types-function tags)))
         (methods '()))
-    (dolist (method-desc (cl--generic-method-table generic))
-      (let* ((specializer (or (nth dispatch-arg (caar method-desc)) t))
+    (dolist (method (cl--generic-method-table generic))
+      (let* ((specializer (or (nth dispatch-arg
+                                   (cl--generic-method-specializers method))
+                              t))
              (m (member specializer types)))
         (when m
-          (push (cons (length m) method-desc) methods))))
+          (push (cons (length m) method) methods))))
     ;; Sort the methods, most specific first.
     ;; It would be tempting to sort them once and for all in the method-table
     ;; rather than here, but the order might depend on the actual argument
@@ -614,6 +623,14 @@ Can only be used from within the lexical body of a primary 
or around method."
   (declare (obsolete "make sure there's always a next method, or catch 
`cl-no-next-method' instead" "25.1"))
   (error "cl-next-method-p only allowed inside primary and around methods"))
 
+;;;###autoload
+(defun cl-find-method (generic qualifiers specializers)
+  (car (cl--generic-member-method
+        specializers qualifiers
+        (cl--generic-method-table (cl--generic generic)))))
+
+(defalias 'cl-method-qualifiers 'cl--generic-method-qualifiers)
+
 ;;; Add support for describe-function
 
 (defun cl--generic-search-method (met-name)
@@ -638,22 +655,30 @@ Can only be used from within the lexical body of a 
primary or around method."
                `(cl-defmethod . ,#'cl--generic-search-method)))
 
 (defun cl--generic-method-info (method)
-  (pcase-let ((`((,specializers . ,qualifier) ,uses-cnm . ,function) method))
-    (let* ((args (help-function-arglist function 'names))
-           (docstring (documentation function))
-           (doconly (if docstring
-                        (let ((split (help-split-fundoc docstring nil)))
-                          (if split (cdr split) docstring))))
-           (combined-args ()))
-      (if uses-cnm (setq args (cdr args)))
-      (dolist (specializer specializers)
-        (let ((arg (if (eq '&rest (car args))
-                       (intern (format "arg%d" (length combined-args)))
-                     (pop args))))
-          (push (if (eq specializer t) arg (list arg specializer))
-                combined-args)))
-      (setq combined-args (append (nreverse combined-args) args))
-      (list qualifier combined-args doconly))))
+  (let* ((specializers (cl--generic-method-specializers method))
+         (qualifiers   (cl--generic-method-qualifiers method))
+         (uses-cnm     (cl--generic-method-uses-cnm method))
+         (function     (cl--generic-method-function method))
+         (args (help-function-arglist function 'names))
+         (docstring (documentation function))
+         (qual-string
+          (if (null qualifiers) ""
+            (cl-assert (consp qualifiers))
+            (let ((s (prin1-to-string qualifiers)))
+              (concat (substring s 1 -1) " "))))
+         (doconly (if docstring
+                      (let ((split (help-split-fundoc docstring nil)))
+                        (if split (cdr split) docstring))))
+         (combined-args ()))
+    (if uses-cnm (setq args (cdr args)))
+    (dolist (specializer specializers)
+      (let ((arg (if (eq '&rest (car args))
+                     (intern (format "arg%d" (length combined-args)))
+                   (pop args))))
+        (push (if (eq specializer t) arg (list arg specializer))
+              combined-args)))
+    (setq combined-args (append (nreverse combined-args) args))
+    (list qual-string combined-args doconly)))
 
 (add-hook 'help-fns-describe-function-functions #'cl--generic-describe)
 (defun cl--generic-describe (function)
@@ -667,8 +692,9 @@ Can only be used from within the lexical body of a primary 
or around method."
         (dolist (method (cl--generic-method-table generic))
           (let* ((info (cl--generic-method-info method)))
             ;; FIXME: Add hyperlinks for the types as well.
-            (insert (format "%S %S" (nth 0 info) (nth 1 info)))
-            (let* ((met-name (cons function (caar method)))
+            (insert (format "%s%S" (nth 0 info) (nth 1 info)))
+            (let* ((met-name (cons function
+                                   (cl--generic-method-specializers method)))
                    (file (find-lisp-object-file-name met-name 'cl-defmethod)))
               (when file
                 (insert " in `")
diff --git a/lisp/emacs-lisp/eieio-compat.el b/lisp/emacs-lisp/eieio-compat.el
index 30bb5ce..fcca99d 100644
--- a/lisp/emacs-lisp/eieio-compat.el
+++ b/lisp/emacs-lisp/eieio-compat.el
@@ -203,11 +203,10 @@ Summary:
     ;; or :after, make sure there's a matching dummy primary.
     (when (and (memq kind '(:before :after))
                ;; FIXME: Use `cl-find-method'?
-               (not (assoc (cons (mapcar (lambda (arg)
-                                           (if (consp arg) (nth 1 arg) t))
-                                         specializers)
-                                 nil)
-                           (cl--generic-method-table (cl--generic method)))))
+               (not (cl-find-method method ()
+                                    (mapcar (lambda (arg)
+                                              (if (consp arg) (nth 1 arg) t))
+                                            specializers))))
       (cl-generic-define-method method () specializers t
                                 (lambda (cnm &rest args)
                                   (if (cl--generic-isnot-nnm-p cnm)
diff --git a/lisp/emacs-lisp/eieio-opt.el b/lisp/emacs-lisp/eieio-opt.el
index a131b02..8d40edf 100644
--- a/lisp/emacs-lisp/eieio-opt.el
+++ b/lisp/emacs-lisp/eieio-opt.el
@@ -129,9 +129,9 @@ If CLASS is actually an object, then also display current 
values of that object.
         (insert "`")
         (help-insert-xref-button (symbol-name generic) 'help-function generic)
         (insert "'")
-       (pcase-dolist (`(,qualifier ,args ,doc)
+       (pcase-dolist (`(,qualifiers ,args ,doc)
                        (eieio-method-documentation generic class))
-          (insert (format " %S %S\n" qualifier args)
+          (insert (format " %s%S\n" qualifiers args)
                   (or doc "")))
        (insert "\n\n")))))
 
@@ -325,10 +325,9 @@ methods for CLASS."
          (and generic
              (catch 'found
                (if (null class) (throw 'found t))
-               (pcase-dolist (`((,specializers . ,_qualifier) . ,_)
-                              (cl--generic-method-table generic))
+               (dolist (method (cl--generic-method-table generic))
                  (if (eieio--specializers-apply-to-class-p
-                      specializers class)
+                      (cl--generic-method-specializers method) class)
                      (throw 'found t))))
              (push symbol l)))))
     l))
@@ -336,15 +335,14 @@ methods for CLASS."
 (defun eieio-method-documentation (generic class)
   "Return info for all methods of GENERIC applicable to CLASS.
 The value returned is a list of elements of the form
-\(QUALIFIER ARGS DOC)."
+\(QUALIFIERS ARGS DOC)."
   (let ((generic (cl--generic generic))
         (docs ()))
     (when generic
       (dolist (method (cl--generic-method-table generic))
-        (pcase-let ((`((,specializers . ,_qualifier) . ,_) method))
-          (when (eieio--specializers-apply-to-class-p
-                 specializers class)
-            (push (cl--generic-method-info method) docs)))))
+        (when (eieio--specializers-apply-to-class-p
+               (cl--generic-method-specializers method) class)
+          (push (cl--generic-method-info method) docs))))
     docs))
 
 ;;; METHOD STATS
diff --git a/test/ChangeLog b/test/ChangeLog
index 9a31da4..61ab8b6 100644
--- a/test/ChangeLog
+++ b/test/ChangeLog
@@ -1,5 +1,10 @@
 2015-01-26  Stefan Monnier  <address@hidden>
 
+       * automated/cl-generic-tests.el: Try and make sure cl-lib is not
+       required at run-time.
+
+2015-01-26  Stefan Monnier  <address@hidden>
+
        * automated/cl-generic-tests.el (cl-generic-test-11-next-method-p):
        New test.
 
diff --git a/test/automated/cl-generic-tests.el 
b/test/automated/cl-generic-tests.el
index 5b3a9fd..5194802 100644
--- a/test/automated/cl-generic-tests.el
+++ b/test/automated/cl-generic-tests.el
@@ -23,8 +23,8 @@
 
 ;;; Code:
 
-(require 'ert)
-(require 'cl-lib)
+(eval-when-compile (require 'ert)) ;Don't indirectly require cl-lib at 
run-time.
+(require 'cl-generic)
 
 (cl-defgeneric cl--generic-1 (x y))
 (cl-defgeneric (setf cl--generic-1) (v y z) "My generic doc.")



reply via email to

[Prev in Thread] Current Thread [Next in Thread]