mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-12-25 10:47:00 +00:00
212 lines
8.9 KiB
EmacsLisp
212 lines
8.9 KiB
EmacsLisp
;;; advice-tests.el --- Test suite for the new advice thingy.
|
|
|
|
;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;;; Code:
|
|
|
|
(require 'ert)
|
|
|
|
(ert-deftest advice-tests-nadvice ()
|
|
"Test nadvice code."
|
|
(advice-add 'sm-test1 :around (lambda (f y) (* (funcall f y) 5)))
|
|
(advice-add 'sm-test1 :around (lambda (f y) (* (funcall f y) 2)))
|
|
(advice-remove 'sm-test1 (lambda (f y) (* (funcall f y) 5)))
|
|
(defun sm-test1 (x) (+ x 4))
|
|
(should (equal (sm-test1 6) 20))
|
|
(advice-remove 'sm-test1 (lambda (f y) (* (funcall f y) 2)))
|
|
(should (equal (sm-test1 6) 10))
|
|
(advice-add 'sm-test1 :around (lambda (f y) (* (funcall f y) 5)))
|
|
(should (equal (sm-test1 6) 50))
|
|
(defun sm-test1 (x) (+ x 14))
|
|
(should (equal (sm-test1 6) 100))
|
|
(should (equal (null (get 'sm-test1 'defalias-fset-function)) nil))
|
|
(advice-remove 'sm-test1 (lambda (f y) (* (funcall f y) 5)))
|
|
(should (equal (sm-test1 6) 20))
|
|
(should (equal (get 'sm-test1 'defalias-fset-function) nil))
|
|
|
|
(advice-add 'sm-test3 :around
|
|
(lambda (f &rest args) `(toto ,(apply f args)))
|
|
'((name . wrap-with-toto)))
|
|
(defmacro sm-test3 (x) `(call-test3 ,x))
|
|
(should (equal (macroexpand '(sm-test3 56)) '(toto (call-test3 56)))))
|
|
|
|
(ert-deftest advice-tests-macroaliases ()
|
|
"Test nadvice code on aliases to macros."
|
|
(defmacro sm-test1 (a) `(list ',a))
|
|
(defalias 'sm-test1-alias 'sm-test1)
|
|
(should (equal (macroexpand '(sm-test1-alias 5)) '(list '5)))
|
|
(advice-add 'sm-test1-alias :around
|
|
(lambda (f &rest args) `(cons 1 ,(apply f args))))
|
|
(should (equal (macroexpand '(sm-test1-alias 5)) '(cons 1 (list '5))))
|
|
(defmacro sm-test1 (a) `(list 0 ',a))
|
|
(should (equal (macroexpand '(sm-test1-alias 5)) '(cons 1 (list 0 '5)))))
|
|
|
|
|
|
(ert-deftest advice-tests-advice ()
|
|
"Test advice code."
|
|
(defun sm-test2 (x) (+ x 4))
|
|
(should (equal (sm-test2 6) 10))
|
|
(defadvice sm-test2 (around sm-test activate)
|
|
ad-do-it (setq ad-return-value (* ad-return-value 5)))
|
|
(should (equal (sm-test2 6) 50))
|
|
(ad-deactivate 'sm-test2)
|
|
(should (equal (sm-test2 6) 10))
|
|
(ad-activate 'sm-test2)
|
|
(should (equal (sm-test2 6) 50))
|
|
(defun sm-test2 (x) (+ x 14))
|
|
(should (equal (sm-test2 6) 100))
|
|
(should (equal (null (get 'sm-test2 'defalias-fset-function)) nil))
|
|
(ad-remove-advice 'sm-test2 'around 'sm-test)
|
|
(should (equal (sm-test2 6) 100))
|
|
(ad-activate 'sm-test2)
|
|
(should (equal (sm-test2 6) 20))
|
|
(should (equal (null (get 'sm-test2 'defalias-fset-function)) t))
|
|
|
|
(defadvice sm-test4 (around wrap-with-toto activate)
|
|
ad-do-it (setq ad-return-value `(toto ,ad-return-value)))
|
|
(defmacro sm-test4 (x) `(call-test4 ,x))
|
|
(should (equal (macroexpand '(sm-test4 56)) '(toto (call-test4 56))))
|
|
(defmacro sm-test4 (x) `(call-testq ,x))
|
|
(should (equal (macroexpand '(sm-test4 56)) '(toto (call-testq 56))))
|
|
|
|
;; This used to signal an error (bug#12858).
|
|
(autoload 'sm-test6 "foo")
|
|
(defadvice sm-test6 (around test activate)
|
|
ad-do-it))
|
|
|
|
(ert-deftest advice-tests-combination ()
|
|
"Combining old style and new style advices."
|
|
(defun sm-test5 (x) (+ x 4))
|
|
(should (equal (sm-test5 6) 10))
|
|
(advice-add 'sm-test5 :around (lambda (f y) (* (funcall f y) 5)))
|
|
(should (equal (sm-test5 6) 50))
|
|
(defadvice sm-test5 (around test activate)
|
|
ad-do-it (setq ad-return-value (+ ad-return-value 0.1)))
|
|
(should (equal (sm-test5 5) 45.1))
|
|
(ad-deactivate 'sm-test5)
|
|
(should (equal (sm-test5 6) 50))
|
|
(ad-activate 'sm-test5)
|
|
(should (equal (sm-test5 6) 50.1))
|
|
(defun sm-test5 (x) (+ x 14))
|
|
(should (equal (sm-test5 6) 100.1))
|
|
(advice-remove 'sm-test5 (lambda (f y) (* (funcall f y) 5)))
|
|
(should (equal (sm-test5 6) 20.1)))
|
|
|
|
(ert-deftest advice-test-called-interactively-p ()
|
|
"Check interaction between advice and called-interactively-p."
|
|
(defun sm-test7 (&optional x) (interactive) (+ (or x 7) 4))
|
|
(advice-add 'sm-test7 :around
|
|
(lambda (f &rest args)
|
|
(list (cons 1 (called-interactively-p)) (apply f args))))
|
|
(should (equal (sm-test7) '((1 . nil) 11)))
|
|
(should (equal (call-interactively 'sm-test7) '((1 . t) 11)))
|
|
(let ((smi 7))
|
|
(advice-add 'sm-test7 :before
|
|
(lambda (&rest args)
|
|
(setq smi (called-interactively-p))))
|
|
(should (equal (list (sm-test7) smi)
|
|
'(((1 . nil) 11) nil)))
|
|
(should (equal (list (call-interactively 'sm-test7) smi)
|
|
'(((1 . t) 11) t))))
|
|
(advice-add 'sm-test7 :around
|
|
(lambda (f &rest args)
|
|
(cons (cons 2 (called-interactively-p)) (apply f args))))
|
|
(should (equal (call-interactively 'sm-test7) '((2 . t) (1 . t) 11))))
|
|
|
|
(ert-deftest advice-test-called-interactively-p-around ()
|
|
"Check interaction between around advice and called-interactively-p.
|
|
|
|
This tests the currently broken case of the innermost advice to a
|
|
function being an around advice."
|
|
:expected-result :failed
|
|
(defun sm-test7.2 () (interactive) (cons 1 (called-interactively-p)))
|
|
(advice-add 'sm-test7.2 :around
|
|
(lambda (f &rest args)
|
|
(list (cons 1 (called-interactively-p)) (apply f args))))
|
|
(should (equal (sm-test7.2) '((1 . nil) (1 . nil))))
|
|
(should (equal (call-interactively 'sm-test7.2) '((1 . t) (1 . t)))))
|
|
|
|
(ert-deftest advice-test-called-interactively-p-filter-args ()
|
|
"Check interaction between filter-args advice and called-interactively-p."
|
|
:expected-result :failed
|
|
(defun sm-test7.3 () (interactive) (cons 1 (called-interactively-p)))
|
|
(advice-add 'sm-test7.3 :filter-args #'list)
|
|
(should (equal (sm-test7.3) '(1 . nil)))
|
|
(should (equal (call-interactively 'sm-test7.3) '(1 . t))))
|
|
|
|
(ert-deftest advice-test-call-interactively ()
|
|
"Check interaction between advice on call-interactively and called-interactively-p."
|
|
(defun sm-test7.4 () (interactive) (cons 1 (called-interactively-p)))
|
|
(let ((old (symbol-function 'call-interactively)))
|
|
(unwind-protect
|
|
(progn
|
|
(advice-add 'call-interactively :before #'ignore)
|
|
(should (equal (sm-test7.4) '(1 . nil)))
|
|
(should (equal (call-interactively 'sm-test7.4) '(1 . t))))
|
|
(advice-remove 'call-interactively #'ignore)
|
|
(should (eq (symbol-function 'call-interactively) old)))))
|
|
|
|
(ert-deftest advice-test-interactive ()
|
|
"Check handling of interactive spec."
|
|
(defun sm-test8 (a) (interactive "p") a)
|
|
(defadvice sm-test8 (before adv1 activate) nil)
|
|
(defadvice sm-test8 (before adv2 activate) (interactive "P") nil)
|
|
(should (equal (interactive-form 'sm-test8) '(interactive "P"))))
|
|
|
|
(ert-deftest advice-test-preactivate ()
|
|
(should (equal (null (get 'sm-test9 'defalias-fset-function)) t))
|
|
(defun sm-test9 (a) (interactive "p") a)
|
|
(should (equal (null (get 'sm-test9 'defalias-fset-function)) t))
|
|
(defadvice sm-test9 (before adv1 pre act protect compile) nil)
|
|
(should (equal (null (get 'sm-test9 'defalias-fset-function)) nil))
|
|
(defadvice sm-test9 (before adv2 pre act protect compile)
|
|
(interactive "P") nil)
|
|
(should (equal (interactive-form 'sm-test9) '(interactive "P"))))
|
|
|
|
(ert-deftest advice-test-multiples ()
|
|
(let ((sm-test10 (lambda (a) (+ a 10)))
|
|
(sm-advice (lambda (x) (if (consp x) (list (* 5 (car x))) (* 4 x)))))
|
|
(should (equal (funcall sm-test10 5) 15))
|
|
(add-function :filter-args (var sm-test10) sm-advice)
|
|
(should (advice-function-member-p sm-advice sm-test10))
|
|
(should (equal (funcall sm-test10 5) 35))
|
|
(add-function :filter-return (var sm-test10) sm-advice)
|
|
(should (equal (funcall sm-test10 5) 60))
|
|
;; Make sure we can add multiple times the same function, under the
|
|
;; condition that they have different `name' properties.
|
|
(add-function :filter-args (var sm-test10) sm-advice '((name . "args")))
|
|
(should (equal (funcall sm-test10 5) 140))
|
|
(remove-function (var sm-test10) "args")
|
|
(should (equal (funcall sm-test10 5) 60))
|
|
(add-function :filter-args (var sm-test10) sm-advice '((name . "args")))
|
|
(add-function :filter-return (var sm-test10) sm-advice '((name . "ret")))
|
|
(should (equal (funcall sm-test10 5) 560))
|
|
;; Make sure that if we specify to remove a function that was added
|
|
;; multiple times, they are all removed, rather than removing only some
|
|
;; arbitrary subset of them.
|
|
(remove-function (var sm-test10) sm-advice)
|
|
(should (equal (funcall sm-test10 5) 15))))
|
|
|
|
;; Local Variables:
|
|
;; no-byte-compile: t
|
|
;; End:
|
|
|
|
;;; advice-tests.el ends here.
|