From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Spencer Baugh Newsgroups: gmane.emacs.bugs Subject: bug#62621: 29.0.60; uniquify can't make buffers unique based on things other than filename Date: Wed, 19 Jul 2023 08:31:00 -0400 Message-ID: References: <87bkgfjugn.fsf@catern.com> <83edlb3t0t.fsf@gnu.org> <22ee6190-5946-9bde-b648-a55dd2188576@gutov.dev> <83mszt7a1a.fsf@gnu.org> <5c266c9b-a719-41d9-327e-6a2152adaffe@gutov.dev> <838rbc5c8v.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="4146"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Dmitry Gutov , 62621@debbugs.gnu.org, sbaugh@catern.com To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Jul 19 14:32:19 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 1qM6Lr-0000nU-CT for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 19 Jul 2023 14:32:19 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qM6Ld-0006Ke-Nb; Wed, 19 Jul 2023 08:32:05 -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 1qM6Lb-0006Hf-Fh for bug-gnu-emacs@gnu.org; Wed, 19 Jul 2023 08:32:03 -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 1qM6LZ-00073b-VK for bug-gnu-emacs@gnu.org; Wed, 19 Jul 2023 08:32:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qM6LZ-00076o-Pe for bug-gnu-emacs@gnu.org; Wed, 19 Jul 2023 08:32:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Spencer Baugh Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 19 Jul 2023 12:32:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 62621 X-GNU-PR-Package: emacs Original-Received: via spool by 62621-submit@debbugs.gnu.org id=B62621.168976987027253 (code B ref 62621); Wed, 19 Jul 2023 12:32:01 +0000 Original-Received: (at 62621) by debbugs.gnu.org; 19 Jul 2023 12:31:10 +0000 Original-Received: from localhost ([127.0.0.1]:55156 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qM6Kj-00075U-Tu for submit@debbugs.gnu.org; Wed, 19 Jul 2023 08:31:10 -0400 Original-Received: from mxout5.mail.janestreet.com ([64.215.233.18]:48717) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qM6Kf-00074o-I2 for 62621@debbugs.gnu.org; Wed, 19 Jul 2023 08:31:09 -0400 In-Reply-To: <838rbc5c8v.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 19 Jul 2023 15:14:56 +0300") 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:265527 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii writes: >> Date: Wed, 19 Jul 2023 05:22:56 +0300 >> Cc: sbaugh@catern.com, sbaugh@janestreet.com, 62621@debbugs.gnu.org >> From: Dmitry Gutov >> >> On 18/07/2023 14:07, Eli Zaretskii wrote: >> >> Date: Tue, 18 Jul 2023 03:34:06 +0300 >> >> Cc:sbaugh@janestreet.com,62621@debbugs.gnu.org >> >> From: Dmitry Gutov >> >> >> >>> Repeat after me: Use options whose values are functions >> >>> are hard on our users, because they require them to be Lisp >> >>> programmers. >> >> That doesn't have to be the case. If the defcustom's docstring mentions >> >> several functions that can be used, and the :type widget includes them >> >> as well, the user can decide to switch to any of them without writing >> >> any Lisp (or having to understand the implementations). >> > But that was not so in this particular case. >> >> That's easy to fix, as long as you don't have additional objections to >> that approach. > > I'd need to see the fix first, because I don't think I have a clear > idea of what you have in mind. > > (My objections, btw, where very minor and of pure usability nature. > Frankly, I'm surprised such a simple and more-or-less agreed-upon > comment got such a long thread of discussing various loosely-related > issues.) Like this: --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Support-transforming-the-dirname-used-by-uniquify.patch >From 7fcbc7499809134104bb5dbde206094d85f48806 Mon Sep 17 00:00:00 2001 From: Spencer Baugh Date: Sun, 9 Jul 2023 22:21:03 -0400 Subject: [PATCH] Support transforming the dirname used by uniquify By transforming the dirname, we can add additional information to use during uniquifying. A basic one: uniquifying buffer names based on the project name. * lisp/progmodes/project.el (project-uniquify-dirname-transform): Add. * lisp/uniquify.el (uniquify-dirname-transform-default) (uniquify-dirname-transform): Add. (bug#62621) (uniquify-rationalize-file-buffer-names, uniquify-buffer-file-name): Use uniquify-dirname-transform. * test/lisp/uniquify-tests.el (uniquify-home, uniquify-project-transform): Add tests. --- lisp/progmodes/project.el | 12 ++++++++++++ lisp/uniquify.el | 25 ++++++++++++++++++++----- test/lisp/uniquify-tests.el | 33 +++++++++++++++++++++++++++++++++ 3 files changed, 65 insertions(+), 5 deletions(-) diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el index d482cc24d70..78f9fb410c1 100644 --- a/lisp/progmodes/project.el +++ b/lisp/progmodes/project.el @@ -1835,5 +1835,17 @@ project-switch-project (let ((project-current-directory-override dir)) (call-interactively command)))) +;;;###autoload +(defun project-uniquify-dirname-transform (dirname) + "Include `project-name' in DIRNAME if in a project." + (if-let (proj (project-current nil dirname)) + (let ((root (project-root proj))) + (expand-file-name + (file-name-concat + (file-name-directory root) + (project-name proj) + (file-relative-name dirname root)))) + dirname)) + (provide 'project) ;;; project.el ends here diff --git a/lisp/uniquify.el b/lisp/uniquify.el index d1ca455b673..328f85bf32f 100644 --- a/lisp/uniquify.el +++ b/lisp/uniquify.el @@ -168,6 +168,19 @@ uniquify-list-buffers-directory-modes That means that when `buffer-file-name' is set to nil, `list-buffers-directory' contains the name of the directory which the buffer is visiting.") +(defcustom uniquify-dirname-transform #'identity + "Function to transform buffer's directory for uniquifying its name. + +It takes a single argument: the directory of the buffer. It +should return a string filename (which does not need to actually +exist in the filesystem) to use for uniquifying the buffer name." + :type '(choice (function-item :tag "Don't change the dirname" identity) + (function-item :tag "Include project name in dirname" + #'project-uniquify-dirname-transform) + function) + :version "30.1" + :group 'uniquify) + ;;; Utilities ;; uniquify-fix-list data structure @@ -209,7 +222,8 @@ uniquify-rationalize-file-buffer-names ;; this buffer. (with-current-buffer newbuf (setq uniquify-managed nil)) (when dirname - (setq dirname (expand-file-name (directory-file-name dirname))) + (setq dirname (funcall uniquify-dirname-transform + (expand-file-name (directory-file-name dirname)))) (let ((fix-list (list (uniquify-make-item base dirname newbuf nil))) items) @@ -268,10 +282,11 @@ uniquify-buffer-file-name (if (memq major-mode uniquify-list-buffers-directory-modes) list-buffers-directory)))) (when filename - (directory-file-name - (file-name-directory - (expand-file-name - (directory-file-name filename)))))))) + (funcall uniquify-dirname-transform + (directory-file-name + (file-name-directory + (expand-file-name + (directory-file-name filename))))))))) (defun uniquify-rerationalize-w/o-cb (fix-list) "Re-rationalize the buffers in FIX-LIST, but ignoring `current-buffer'." diff --git a/test/lisp/uniquify-tests.el b/test/lisp/uniquify-tests.el index abd61fa3504..e533c4b644c 100644 --- a/test/lisp/uniquify-tests.el +++ b/test/lisp/uniquify-tests.el @@ -88,6 +88,21 @@ uniquify-dirs '("a/dir/" "b/dir/"))) (mapc #'kill-buffer bufs))))) +(ert-deftest uniquify-home () + "uniquify works, albeit confusingly, in the presence of directories named \"~\"" + (let (bufs) + (save-excursion + (push (find-file-noselect "~") bufs) + (push (find-file-noselect "./~") bufs) + (should (equal (mapcar #'buffer-name bufs) + '("~" "~<>"))) + (push (find-file-noselect "~/foo") bufs) + (push (find-file-noselect "./~/foo") bufs) + (should (equal (mapcar #'buffer-name bufs) + '("foo<~>" "foo" "~" "~<>"))) + (while bufs + (kill-buffer (pop bufs)))))) + (ert-deftest uniquify-rename-to-dir () "Giving a buffer a name which matches a directory doesn't rename the buffer" (let ((uniquify-buffer-name-style 'forward) @@ -125,5 +140,23 @@ uniquify-space-prefix (should (equal (buffer-name) "| foo")) (kill-buffer))) +(require 'project) +(ert-deftest uniquify-project-transform () + "`project-uniquify-dirname-transform' works" + (let ((uniquify-dirname-transform #'project-uniquify-dirname-transform) + (project-vc-name "foo1/bar") + bufs) + (save-excursion + (should (file-exists-p "../README")) + (push (find-file-noselect "../README") bufs) + (push (find-file-noselect "other/README") bufs) + (should (equal (mapcar #'buffer-name bufs) + '("README" "README"))) + (push (find-file-noselect "foo2/bar/README") bufs) + (should (equal (mapcar #'buffer-name bufs) + '("README" "README" "README"))) + (while bufs + (kill-buffer (pop bufs)))))) + (provide 'uniquify-tests) ;;; uniquify-tests.el ends here -- 2.39.3 --=-=-=--