From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Joseph Turner via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#65797: `buffer-match-p` should not use `func-arity` Date: Mon, 16 Oct 2023 13:16:32 -0700 Message-ID: <878r82b9v4.fsf@breatheoutbreathe.in> References: <87v8cmct9b.fsf@breatheoutbreathe.in> <87sf7o38g1.fsf_-_@posteo.net> <871qf1rbdo.fsf@posteo.net> <87o7hz4zg2.fsf@posteo.net> <87sf7b8ker.fsf@posteo.net> <87y1h2blxq.fsf@posteo.net> <874jjqb715.fsf@posteo.net> <0371b6ff-58e4-961e-29c9-4efb65b82185@gutov.dev> <87v8bhtr3k.fsf@breatheoutbreathe.in> <3a282a0b-3efa-ec12-2143-0496ebf6c828@gutov.dev> <831qdxu3y8.fsf@gnu.org> <831qdwqupk.fsf@gnu.org> Reply-To: Joseph Turner Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33357"; mail-complaints-to="usenet@ciao.gmane.io" Cc: dmitry@gutov.dev, Eli Zaretskii , mattias.engdegard@gmail.com, philipk@posteo.net, 65797@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Oct 16 22:17:55 2023 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 1qsU2F-0008RV-A6 for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 16 Oct 2023 22:17:55 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qsU1y-0005Dh-Hr; Mon, 16 Oct 2023 16:17:38 -0400 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 1qsU1x-0005DW-2M for bug-gnu-emacs@gnu.org; Mon, 16 Oct 2023 16:17:37 -0400 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 1qsU1w-0007Ih-R2 for bug-gnu-emacs@gnu.org; Mon, 16 Oct 2023 16:17:36 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qsU2L-0001EL-Nw for bug-gnu-emacs@gnu.org; Mon, 16 Oct 2023 16:18:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Joseph Turner Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 16 Oct 2023 20:18:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65797 X-GNU-PR-Package: emacs Original-Received: via spool by 65797-submit@debbugs.gnu.org id=B65797.16974874784720 (code B ref 65797); Mon, 16 Oct 2023 20:18:01 +0000 Original-Received: (at 65797) by debbugs.gnu.org; 16 Oct 2023 20:17:58 +0000 Original-Received: from localhost ([127.0.0.1]:58082 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qsU2H-0001E3-A0 for submit@debbugs.gnu.org; Mon, 16 Oct 2023 16:17:57 -0400 Original-Received: from out-210.mta1.migadu.com ([2001:41d0:203:375::d2]:36617) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qsU2D-0001Ds-ID for 65797@debbugs.gnu.org; Mon, 16 Oct 2023 16:17:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=breatheoutbreathe.in; s=key1; t=1697487446; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=kB6YaXC4op6izQWA21WNRA1GVkT/GWONXjBlM6hJSUg=; b=TIOWQB73qU4fZyluUIBIFZxKrqsNZk29Ue37PzfEfFy1b3c38yreztsU8H38u5g0Cs0vOl iQVEFf3Uec4pe5k+tokjPcQM5/yQtXtE57hevUn7QsHHPnVKYKYmOdLATZGEvWqFgM90BX 8jpAcudkOJ9tKq3TdyEhaMtIFcHrI44= X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: X-Migadu-Flow: FLOW_OUT 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:272585 Archived-At: Stefan Monnier writes: >> Sigh. I guess we can install this on emacs-29 and cross the >> fingers... > > I'm not insisting on it. > If you think it's risky, let's just have it on `master`. > > BTW, see below the actual patch, including changes to etc/NEWS, manual, > as well as the addition of a runtime warning (without which I can't see > how we'll ever be able to get rid of the ugly backward compatibility > hack). Minor nit: There's a typo in the NEWS file. "tho" should be "though". > Stefan > > [2. text/x-diff; buffer-match.patch] > diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi > index 86c47ae7310..a2d0f5687ba 100644 > --- a/doc/lispref/buffers.texi > +++ b/doc/lispref/buffers.texi > @@ -957,10 +957,10 @@ Buffer List > infinite recursion. > @end defvar > > -@defun buffer-match-p condition buffer-or-name &optional arg > +@defun buffer-match-p condition buffer-or-name &rest args > This function checks if a buffer designated by @code{buffer-or-name} > -satisfies the specified @code{condition}. Optional third argument > -@var{arg} is passed to the predicate function in @var{condition}. A > +satisfies the specified @code{condition}. Optional arguments > +@var{args} are passed to the predicate function in @var{condition}. A > valid @var{condition} can be one of the following: > @itemize @bullet{} > @item > @@ -969,23 +969,21 @@ Buffer List > name. > @item > A predicate function, which should return non-@code{nil} if the buffer > -matches. If the function expects one argument, it is called with > -@var{buffer-or-name} as the argument; if it expects 2 arguments, the > -first argument is @var{buffer-or-name} and the second is @var{arg} > -(or @code{nil} if @var{arg} is omitted). > +matches. It is called with > +@var{buffer-or-name} as the first argument followed by @var{args}. > @item > A cons-cell @code{(@var{oper} . @var{expr})} where @var{oper} is one > of > @table @code > @item (not @var{cond}) > Satisfied if @var{cond} doesn't satisfy @code{buffer-match-p} with > -the same buffer and @code{arg}. > +the same buffer and @code{args}. > @item (or @var{conds}@dots{}) > Satisfied if @emph{any} condition in @var{conds} satisfies > -@code{buffer-match-p}, with the same buffer and @code{arg}. > +@code{buffer-match-p}, with the same buffer and @code{args}. > @item (and @var{conds}@dots{}) > Satisfied if @emph{all} the conditions in @var{conds} satisfy > -@code{buffer-match-p}, with the same buffer and @code{arg}. > +@code{buffer-match-p}, with the same buffer and @code{args}. > @item derived-mode > Satisfied if the buffer's major mode derives from @var{expr}. > @item major-mode > @@ -998,14 +996,14 @@ Buffer List > @end itemize > @end defun > > -@defun match-buffers condition &optional buffer-list arg > +@defun match-buffers condition &optional buffer-list &rest args > This function returns a list of all buffers that satisfy the > @code{condition}. If no buffers match, the function returns > @code{nil}. The argument @var{condition} is as defined in > @code{buffer-match-p} above. By default, all the buffers are > considered, but this can be restricted via the optional argument > @code{buffer-list}, which should be a list of buffers to consider. > -Optional third argument @var{arg} will be passed to @var{condition} in > +Remaining arguments @var{args} will be passed to @var{condition} in > the same way as @code{buffer-match-p} does. > @end defun > > diff --git a/etc/NEWS b/etc/NEWS > index 3bd47a0112b..c74b4978afe 100644 > --- a/etc/NEWS > +++ b/etc/NEWS > @@ -945,6 +945,13 @@ the file listing's performance is still optimized. > > * Incompatible Lisp Changes in Emacs 30.1 > > +** `buffer-match-p and `match-buffers` take `&rest args` > +They used to take a single `&optional arg` and were documented to use > +an unreliable hack to try and accommodate condition predicates that > +don't accept this optional arg. > +The new semantics makes no such affordances, tho the code still > +supports it (with a warning) for backward compatibility. > + > ** 'post-gc-hook' runs after updating 'gcs-done' and 'gcs-elapsed'. > > --- > diff --git a/lisp/subr.el b/lisp/subr.el > index 58274987d71..0732319ccd0 100644 > --- a/lisp/subr.el > +++ b/lisp/subr.el > @@ -7277,13 +7277,15 @@ string-lines > (setq start (length string))))) > (nreverse lines)))) > > -(defun buffer-match-p (condition buffer-or-name &optional arg) > +(defvar buffer-match-p--past-warnings nil) > + > +(defun buffer-match-p (condition buffer-or-name &rest args) > "Return non-nil if BUFFER-OR-NAME matches CONDITION. > CONDITION is either: > - the symbol t, to always match, > - the symbol nil, which never matches, > - a regular expression, to match a buffer name, > -- a predicate function that takes BUFFER-OR-NAME and ARG as > +- a predicate function that takes BUFFER-OR-NAME plus ARGS as > arguments, and returns non-nil if the buffer matches, > - a cons-cell, where the car describes how to interpret the cdr. > The car can be one of the following: > @@ -7308,9 +7310,18 @@ buffer-match-p > ((pred stringp) > (string-match-p condition (buffer-name buffer))) > ((pred functionp) > - (if (eq 1 (cdr (func-arity condition))) > - (funcall condition buffer-or-name) > - (funcall condition buffer-or-name arg))) > + (if (cdr args) > + ;; New in Emacs>29.1. no need for compatibility hack. > + (apply condition buffer-or-name args) > + (condition-case-unless-debug err > + (apply condition buffer-or-name args) > + (wrong-number-of-arguments > + (unless (member condition > + buffer-match-p--past-warnings) > + (message "%s" (error-message-string err)) > + (push condition buffer-match-p--past-warnings)) > + (apply condition buffer-or-name > + (if args nil '(nil))))))) > (`(major-mode . ,mode) > (eq > (buffer-local-value 'major-mode buffer) > @@ -7332,17 +7343,17 @@ buffer-match-p > (throw 'match t))))))) > (funcall match (list condition)))) > > -(defun match-buffers (condition &optional buffers arg) > +(defun match-buffers (condition &optional buffers &rest args) > "Return a list of buffers that match CONDITION, or nil if none match. > See `buffer-match-p' for various supported CONDITIONs. > By default all buffers are checked, but the optional > argument BUFFERS can restrict that: its value should be > an explicit list of buffers to check. > -Optional argument ARG is passed to `buffer-match-p', for > +Optional arguments ARGS are passed to `buffer-match-p', for > predicate conditions in CONDITION." > (let (bufs) > (dolist (buf (or buffers (buffer-list))) > - (when (buffer-match-p condition (get-buffer buf) arg) > + (when (apply #'buffer-match-p condition (get-buffer buf) args) > (push buf bufs))) > bufs)) > > diff --git a/lisp/window.el b/lisp/window.el > index 2f9b46ebb0a..12d3fb1dfe7 100644 > --- a/lisp/window.el > +++ b/lisp/window.el > @@ -7535,10 +7535,8 @@ display-buffer-alist > arguments: a buffer to display and an alist of the same form as > ALIST. See `display-buffer' for details. > > -`display-buffer' scans this alist until it either finds a > -matching regular expression or the function specified by a > -condition returns non-nil. In any of these cases, it adds the > -associated action to the list of actions it will try." > +`display-buffer' scans this alist until the CONDITION is satisfied > +and adds the associated ACTION to the list of actions it will try." > :type `(alist :key-type > (choice :tag "Condition" > regexp