New macro define-advice

* doc/lispref/functions.texi (Advising Named Functions): Document
define-advice.

* lisp/emacs-lisp/nadvice.el (define-advice): New macro.
* lisp/emacs-lisp/lisp-mode.el (lisp-imenu-generic-expression): Add
define-advice.
(lisp-font-lock-keywords-1): Add define-advice.

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 0a8a0a88cce586dd52e955a9114c3bd250ad4983..6706f936c5ee7cf0109a1838d02ebceb0500bed4 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2014-11-18  Leo Liu  <sdl.web@gmail.com>
+
+       * functions.texi (Advising Named Functions): Document
+       define-advice.
+
 2014-11-17  Paul Eggert  <eggert@cs.ucla.edu>
 
        Improve time stamp handling, and be more consistent about it.

diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index 023175e3632d8e3d599a7f76ed12132ab7902998..50849d4228c8a01782322eec9fb44eb0a1b81c33 100644 (file)
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -1360,6 +1360,13 @@ called directly from C, and such calls ignore advice; hence, one ends
 up in a confusing situation where some calls (occurring from Lisp
 code) obey the advice and other calls (from C code) do not.
 
+@defmac define-advice symbol (where lambda-list &optional name depth) &rest body
+This macro defines an advice and adds it to the function named
+@var{symbol}.  The advice is an anonymous function if @var{name} is
+nil or a function named @code{symbol@@name}.  See @code{advice-add}
+for explanation of other arguments.
+@end defmac
+
 @defun advice-add symbol where function &optional props
 Add the advice @var{function} to the named function @var{symbol}.
 @var{where} and @var{props} have the same meaning as for @code{add-function}

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index e885c924487c666c6adce8c5aa523d2313c0fa37..a1635bc475c312965b1e0960349261f7d2bd1d60 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,10 @@
+2014-11-18  Leo Liu  <sdl.web@gmail.com>
+
+       * emacs-lisp/nadvice.el (define-advice): New macro.
+       * emacs-lisp/lisp-mode.el (lisp-imenu-generic-expression): Add
+       define-advice.
+       (lisp-font-lock-keywords-1): Add define-advice.
+
 2014-11-18  Daiki Ueno  <ueno@gnu.org>
 
        * epg.el (epg-context): New slot EDIT-CALLBACK.

diff --git a/lisp/emacs-lisp/lisp-mode.el b/lisp/emacs-lisp/lisp-mode.el
index a13baf0ee22d0cfef8222197f0e47f4494bd26e8..d84113b418a90490e289fb2a9e3de48c666e1bc2 100644 (file)
--- a/lisp/emacs-lisp/lisp-mode.el
+++ b/lisp/emacs-lisp/lisp-mode.el
@@ -96,7 +96,7 @@
                              '("defun" "defmacro"
                                 ;; Elisp.
                                 "defun*" "defsubst"
-                               "defadvice" "define-skeleton"
+                               "define-advice" "defadvice" "define-skeleton"
                                "define-compilation-mode" "define-minor-mode"
                                "define-global-minor-mode"
                                "define-globalized-minor-mode"
@@ -195,7 +195,7 @@
                          "ignore-errors" "dotimes" "dolist" "declare"))
               (lisp-errs '("warn" "error" "signal"))
               ;; Elisp constructs.  FIXME: update dynamically from obarray.
-              (el-fdefs '("defadvice" "defalias"
+              (el-fdefs '("define-advice" "defadvice" "defalias"
                           "define-derived-mode" "define-minor-mode"
                           "define-generic-mode" "define-global-minor-mode"
                           "define-globalized-minor-mode" "define-skeleton"

diff --git a/lisp/emacs-lisp/nadvice.el b/lisp/emacs-lisp/nadvice.el
index bfd939d69e267a3f633ab4808a4912f3b5f5480d..a81d3e43de38f62beeab90748d610267485a884e 100644 (file)
--- a/lisp/emacs-lisp/nadvice.el
+++ b/lisp/emacs-lisp/nadvice.el
@@ -441,6 +441,30 @@ of the piece of advice."
              (fset symbol (car (get symbol 'advice--saved-rewrite)))))))
   nil)
 
+;;;###autoload
+(defmacro define-advice (symbol args &rest body)
+  "Define an advice and add it to function named SYMBOL.
+See `advice-add' and `add-function' for explanation on the
+arguments.  Note if NAME is nil the advice is anonymous;
+otherwise it is named `SYMBOL@NAME'.
+
+\(fn SYMBOL (WHERE LAMBDA-LIST &optional NAME DEPTH) &rest BODY)"
+  (declare (indent 2) (doc-string 3) (debug (sexp sexp body)))
+  (or (listp args) (signal 'wrong-type-argument (list 'listp args)))
+  (or (<= 2 (length args) 4)
+      (signal 'wrong-number-of-arguments (list 2 4 (length args))))
+  (let* ((where         (nth 0 args))
+         (lambda-list   (nth 1 args))
+         (name          (nth 2 args))
+         (depth         (nth 3 args))
+         (props         (and depth `((depth . ,depth))))
+         (advice (cond ((null name) `(lambda ,lambda-list ,@body))
+                       ((or (stringp name) (symbolp name))
+                        (intern (format "%s@%s" symbol name)))
+                       (t (error "Unrecognized name spec `%S'" name)))))
+    `(prog1 ,@(and (symbolp advice) `((defun ,advice ,lambda-list ,@body)))
+       (advice-add ',symbol ,where #',advice ,@(and props `(',props))))))
+
 (defun advice-mapc (fun symbol)
   "Apply FUN to every advice function in SYMBOL.
 FUN is called with a two arguments: the function that was added, and the