;; Less frequently used:
;; (function . edebug-match-function)
(lambda-expr . edebug-match-lambda-expr)
+ (cl-generic-method-args . edebug-match-cl-generic-method-args)
(¬ . edebug-match-¬)
(&key . edebug-match-&key)
(place . edebug-match-place)
spec))
nil)
+(defun edebug-match-cl-generic-method-args (cursor)
+ (let ((args (edebug-top-element-required cursor "Expected arguments")))
+ (if (not (consp args))
+ (edebug-no-match cursor "List expected"))
+ ;; Append the arguments to edebug-def-name.
+ (setq edebug-def-name
+ (intern (format "%s %s" edebug-def-name args)))
+ (edebug-move-cursor cursor)
+ (list args)))
+
(defun edebug-match-arg (cursor)
;; set the def-args bound in edebug-defining-form
(let ((edebug-arg (edebug-top-element-required cursor "Expected arg")))
)))))
(defun edebug-instrument-function (func)
- ;; Func should be a function symbol.
- ;; Return the function symbol, or nil if not instrumented.
+ "Instrument the function or generic method FUNC.
+Return the list of function symbols which were instrumented.
+This may be simply (FUNC) for a normal function, or a list of
+generated symbols for methods. If a function or method to
+instrument cannot be found, signal an error."
(let ((func-marker (get func 'edebug)))
(cond
((and (markerp func-marker) (marker-buffer func-marker))
(with-current-buffer (marker-buffer func-marker)
(goto-char func-marker)
(edebug-eval-top-level-form)
- func))
+ (list func)))
((consp func-marker)
(message "%s is already instrumented." func)
- func)
+ (list func))
+ ((get func 'cl--generic)
+ (let ((method-defs (method-files func))
+ symbols)
+ (unless method-defs
+ (error "Could not find any method definitions for %s" func))
+ (pcase-dolist (`(,file . ,spec) method-defs)
+ (let* ((loc (find-function-search-for-symbol spec 'cl-defmethod file)))
+ (unless (cdr loc)
+ (error "Could not find the definition for %s in its file" spec))
+ (with-current-buffer (car loc)
+ (goto-char (cdr loc))
+ (edebug-eval-top-level-form)
+ (push (edebug-form-data-symbol) symbols))))
+ symbols))
(t
(let ((loc (find-function-noselect func t)))
(unless (cdr loc)
(with-current-buffer (car loc)
(goto-char (cdr loc))
(edebug-eval-top-level-form)
- func))))))
+ (list func)))))))
(defun edebug-instrument-callee ()
"Instrument the definition of the function or macro about to be called.
Do this when stopped before the form or it will be too late.
One side effect of using this command is that the next time the
-function or macro is called, Edebug will be called there as well."
+function or macro is called, Edebug will be called there as well.
+If the callee is a generic function, Edebug will instrument all
+the methods, not just the one which is about to be called. Return
+the list of symbols which were instrumented."
(interactive)
(if (not (looking-at "("))
(error "You must be before a list form")
(defun edebug-step-in ()
- "Step into the definition of the function or macro about to be called.
+ "Step into the definition of the function, macro or method about to be called.
This first does `edebug-instrument-callee' to ensure that it is
instrumented. Then it does `edebug-on-entry' and switches to `go' mode."
(interactive)
- (let ((func (edebug-instrument-callee)))
- (if func
+ (let ((funcs (edebug-instrument-callee)))
+ (if funcs
(progn
- (edebug-on-entry func 'temp)
- (edebug-go-mode nil)))))
+ (mapc (lambda (func) (edebug-on-entry func 'temp)) funcs)
+ (edebug-go-mode nil)))))
(defun edebug-on-entry (function &optional flag)
"Cause Edebug to stop when FUNCTION is called.
(setq files (cdr files)))
file)))
+(defun method-files (method)
+ "Return a list of files where METHOD is defined by `cl-defmethod'.
+The list will have entries of the form (FILE . (METHOD ...))
+where (METHOD ...) contains the qualifiers and specializers of
+the method and is a suitable argument for
+`find-function-search-for-symbol'. Filenames are absolute."
+ (let ((files load-history)
+ result)
+ (while files
+ (let ((defs (cdr (car files))))
+ (while defs
+ (let ((def (car defs)))
+ (if (and (eq (car-safe def) 'cl-defmethod)
+ (eq (cadr def) method))
+ (push (cons (car (car files)) (cdr def)) result)))
+ (setq defs (cdr defs))))
+ (setq files (cdr files)))
+ result))
+
(defun locate-library (library &optional nosuffix path interactive-call)
"Show the precise file name of Emacs library LIBRARY.
LIBRARY should be a relative file name of the library, a string.
(should-error (eval '(dolist "foo") t)
:type 'wrong-type-argument))
+(require 'cl-generic)
+(cl-defgeneric subr-tests--generic (x))
+(cl-defmethod subr-tests--generic ((x string))
+ (message "%s is a string" x))
+(cl-defmethod subr-tests--generic ((x integer))
+ (message "%s is a number" x))
+(cl-defgeneric subr-tests--generic-without-methods (x y))
+(defvar subr-tests--this-file (or load-file-name buffer-file-name))
+
+(ert-deftest subr-tests--method-files--finds-methods ()
+ "`method-files' returns a list of files and methods for a generic function."
+ (let ((retval (method-files 'subr-tests--generic)))
+ (should (equal (length retval) 2))
+ (mapc (lambda (x)
+ (should (equal (car x) subr-tests--this-file))
+ (should (equal (cadr x) 'subr-tests--generic)))
+ retval)
+ (should-not (equal (nth 0 retval) (nth 1 retval)))))
+
+(ert-deftest subr-tests--method-files--nonexistent-methods ()
+ "`method-files' returns nil if asked to find a method which doesn't exist."
+ (should-not (method-files 'subr-tests--undefined-generic))
+ (should-not (method-files 'subr-tests--generic-without-methods)))
+
(provide 'subr-tests)
;;; subr-tests.el ends here
projects / emacs.git / commitdiff