From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#68114: [PATCH] Make 'advice-remove' interactive Date: Sat, 06 Jan 2024 11:02:53 +0200 Message-ID: <83le92u94y.fsf@gnu.org> References: <87r0j42353.fsf@stebalien.com> <83a5ps6a5e.fsf@gnu.org> <87r0j491mx.fsf@stebalien.com> <837ckw5gug.fsf@gnu.org> <87r0j3hcir.fsf@stebalien.com> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="24134"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Stefan Monnier , 68114@debbugs.gnu.org To: Steven Allen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jan 06 10:04:11 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rM2bC-00063h-W2 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 06 Jan 2024 10:04:11 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rM2b6-0000ql-Bx; Sat, 06 Jan 2024 04:04:04 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rM2b4-0000qd-Hw for bug-gnu-emacs@gnu.org; Sat, 06 Jan 2024 04:04:02 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rM2az-0005xT-HR for bug-gnu-emacs@gnu.org; Sat, 06 Jan 2024 04:04:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rM2b4-0007BM-7B for bug-gnu-emacs@gnu.org; Sat, 06 Jan 2024 04:04:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 06 Jan 2024 09:04:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68114 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 68114-submit@debbugs.gnu.org id=B68114.170453179727542 (code B ref 68114); Sat, 06 Jan 2024 09:04:02 +0000 Original-Received: (at 68114) by debbugs.gnu.org; 6 Jan 2024 09:03:17 +0000 Original-Received: from localhost ([127.0.0.1]:58539 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rM2aK-0007A9-VV for submit@debbugs.gnu.org; Sat, 06 Jan 2024 04:03:17 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51838) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rM2aI-00079r-BP for 68114@debbugs.gnu.org; Sat, 06 Jan 2024 04:03:15 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rM2a8-0005oP-3p; Sat, 06 Jan 2024 04:03:04 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=Rbzy9KwIo7YWS7RWVeAlEoSbLNaM5Y/50j9Wcp+uCr4=; b=Meo5trHUiVIr 27R8seTU9dMVfBZk1x2OI/WJHJuVdpuamQFZhmnMoh7t5l2gz/Ug6PH5OpstEFZrvnSSxsziX3sGC Bo69C4fXEl+CLIezP/rhxCQvKWkVoAUvqOh6Kt0/YUUiGv5UWNKIwC2SaHsq3/DjqXRP/yVHJQWOB T6VbXNrrlKMubSlicHiZgquDKc05LyUF6Oj5eVty2YJDSua85iYBFws9LcdVV85jUkV42K3UNzrcN GhrVzBH+MORhvQqi8AvXI5BAXITCbXvo6G0esyHfjBvrvrcu9oEP5hEUtQd0G+CbRgDiBctK5mTt6 V5WP1XrhVbtcagv9MSdPvg==; In-Reply-To: <87r0j3hcir.fsf@stebalien.com> (message from Steven Allen on Sat, 30 Dec 2023 08:37:48 -0800) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:277438 Archived-At: > From: Steven Allen > Date: Sat, 30 Dec 2023 08:37:48 -0800 > > Ah, I responded to the previous message before seeing this one. > > > Please mention the bug number, since it is now known, in the log > > message. > > Done. > > > Two spaces between sentences, please. > > Fixed in the first revision (d4a07757). > > > Btw, what is "the 'name' of a piece of advice"? I realize that this > > text was there to begin with, but I don't think I understand what it > > wants to tell me, so maybe we could clarify that. The only reference > > to a "name" in the preceding text uses "name" to mean a symbol, but > > then what is "the name of a piece of advice"? I guess this goes back > > to define-advice, which says: > > > > @defmac define-advice symbol (where lambda-list &optional name depth) &rest body > > This macro defines a piece of advice and adds it to the function named > > @var{symbol}. The advice is an anonymous function if @var{name} is > > @code{nil} or a function named @code{symbol@@name}. See > > @code{advice-add} for explanation of other arguments. > > > > which is also a bit mysterious. Does NAME used here serve as "the > > name of the piece of advice"? if so, should "@code{symbol@@name}" be > > "@code{symbol@@@var{name}}" instead, i.e. "name" is not a literal > > string but the reference to NAME? > > So, those two names are actually different. The 'name' in referenced in > the `advice-remove` documentation is the 'name in the advice's 'props' > alist. The 'name' specified in `define-advice` is _not_ added to this > alist and is only used in the advice's function name. > > I'm happy to resolve this in a separate patch, if that's OK with you. > Something like (`define-advice` documentation): > > Note if NAME is nil the advice is anonymous; otherwise the advice > function is named `SYMBOL@NAME' and the advice is named NAME. > > Then actually add NAME to the properties. > > > I wonder whether "Remove advice from function: " would be a better > > prompt. > > Good point, done! > > > And here I wonder whether "Advice to remove: " would be a better > > prompt. > > Also done. Stefan, any comments to the patch below? > >From c9dbd06fd6484227e46361e39c29798750d2470e Mon Sep 17 00:00:00 2001 > From: Steven Allen > Date: Fri, 29 Dec 2023 09:53:05 -0800 > Subject: [PATCH] Make 'advice-remove' interactive > > `ad-advice-remove' is already interactive, but it doesn't work with > new-style advice. > > * lisp/emacs-lisp/nadvice.el (advice-remove): Make it > interactive (Bug#67926). > > * doc/lispref/functions.texi (Advising Named Functions): Document that > 'advice-remove' is now an interactive command. > --- > doc/lispref/functions.texi | 8 +++++--- > etc/NEWS | 4 ++++ > lisp/emacs-lisp/nadvice.el | 26 ++++++++++++++++++++++++++ > 3 files changed, 35 insertions(+), 3 deletions(-) > > diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi > index d0c8f3e90e8..6f5c1a997e2 100644 > --- a/doc/lispref/functions.texi > +++ b/doc/lispref/functions.texi > @@ -2077,10 +2077,12 @@ Advising Named Functions > (@pxref{Core Advising Primitives}). > @end defun > > -@defun advice-remove symbol function > +@deffn Command advice-remove symbol function > Remove the advice @var{function} from the named function @var{symbol}. > -@var{function} can also be the @code{name} of a piece of advice. > -@end defun > +@var{function} can also be the @code{name} of a piece of advice. When > +called interactively, prompt for both an advised @var{function} and > +the advice to remove. > +@end deffn > > @defun advice-member-p function symbol > Return non-@code{nil} if the advice @var{function} is already in the named > diff --git a/etc/NEWS b/etc/NEWS > index c002ec33d45..553365fc7a4 100644 > --- a/etc/NEWS > +++ b/etc/NEWS > @@ -83,6 +83,10 @@ see the variable 'url-request-extra-headers'. > > * Changes in Emacs 30.1 > > +** 'advice-remove' is now an interactive command. > +When called interactively, 'advice-remove' now prompts for an advised > +function to the advice to remove. > + > ** Emacs now supports Unicode Standard version 15.1. > > ** Network Security Manager > diff --git a/lisp/emacs-lisp/nadvice.el b/lisp/emacs-lisp/nadvice.el > index 9f2b42f5765..b1d314c0796 100644 > --- a/lisp/emacs-lisp/nadvice.el > +++ b/lisp/emacs-lisp/nadvice.el > @@ -539,6 +539,32 @@ advice-remove > or an autoload and it preserves `fboundp'. > Instead of the actual function to remove, FUNCTION can also be the `name' > of the piece of advice." > + (interactive > + (let* ((pred (lambda (sym) (advice--p (advice--symbol-function sym)))) > + (default (when-let* ((f (function-called-at-point)) > + ((funcall pred f))) > + (symbol-name f))) > + (prompt (format-prompt "Remove advice from function" default)) > + (symbol (intern (completing-read prompt obarray pred t nil nil default))) > + advices) > + (advice-mapc (lambda (f p) > + (let ((k (or (alist-get 'name p) f))) > + (push (cons > + ;; "name" (string) and 'name (symbol) are > + ;; considered different names so we use > + ;; `prin1-to-string' even if the name is > + ;; a string to distinguish between these > + ;; two cases. > + (prin1-to-string k) > + ;; We use `k' here instead of `f' because > + ;; the same advice can have multiple > + ;; names. > + k) > + advices))) > + symbol) > + (list symbol (cdr (assoc-string > + (completing-read "Advice to remove: " advices nil t) > + advices))))) > (let ((f (symbol-function symbol))) > (remove-function (cond ;This is `advice--symbol-function' but as a "place". > ((get symbol 'advice--pending) > -- > 2.43.0 >