From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: sbaugh@catern.com Newsgroups: gmane.emacs.bugs Subject: bug#62621: 29.0.60; uniquify can't make buffers unique based on things other than filename Date: Thu, 13 Jul 2023 22:51:53 +0000 (UTC) Message-ID: <87bkgfjugn.fsf@catern.com> References: 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="4813"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 62621@debbugs.gnu.org To: Spencer Baugh Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Jul 14 00:53:22 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 1qK5BZ-00013d-Ld for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 14 Jul 2023 00:53:22 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qK5BI-0005Jh-Vr; Thu, 13 Jul 2023 18:53: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 1qK5BG-0005JX-P5 for bug-gnu-emacs@gnu.org; Thu, 13 Jul 2023 18:53:02 -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 1qK5BG-0006UD-HC for bug-gnu-emacs@gnu.org; Thu, 13 Jul 2023 18:53:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qK5BG-0001RW-D6 for bug-gnu-emacs@gnu.org; Thu, 13 Jul 2023 18:53:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: sbaugh@catern.com Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 13 Jul 2023 22:53:02 +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.16892887225453 (code B ref 62621); Thu, 13 Jul 2023 22:53:02 +0000 Original-Received: (at 62621) by debbugs.gnu.org; 13 Jul 2023 22:52:02 +0000 Original-Received: from localhost ([127.0.0.1]:41031 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qK5AH-0001Pn-HH for submit@debbugs.gnu.org; Thu, 13 Jul 2023 18:52:02 -0400 Original-Received: from s.wrqvwxzv.outbound-mail.sendgrid.net ([149.72.154.232]:22566) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qK5AF-0001PZ-39 for 62621@debbugs.gnu.org; Thu, 13 Jul 2023 18:52:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=catern.com; h=from:subject:in-reply-to:references:mime-version:to:cc:content-type: cc:content-type:from:subject:to; s=s1; bh=j9W7o9LoxT49Sd6PfOT/HEtNW2deZHAoNgaMzf+YK0Y=; b=THb/gvyy10Jy0wY7765EfBVTU+0RAG7j+4AbQ+j/IJ27/C7VYSHrWSWFSAT7rVL9Qg74 8wpQu1IqrYQHtYrP/ssigLM4tX/CKq0dOAfyUT9Byr0nJFnWl+PlS1dLYcjwDjRZa9+leg Hn88sji/M2PtKkW9YaH2nJaJTQt4XAoRamybNH4kAgZ7VSgYx40GqVidKr4kReQOLG4NqO Jnbx+e4KCgaysrpk1I6bKyZlzigS9Mkr++Tp7tK6Y4NgZG58oDqzsKVhZefz6yXDJ6A5cQ OT/LxAJKPISKkLp0ShwdN3Wx9knxzdHWPdWmHYKySNhPuikSd2w/PYtRADd7TKFA== Original-Received: by filterdrecv-66949dbc98-kr5j5 with SMTP id filterdrecv-66949dbc98-kr5j5-1-64B08009-11 2023-07-13 22:51:53.146931397 +0000 UTC m=+5526724.228198610 Original-Received: from earth.catern.com (unknown) by geopod-ismtpd-6 (SG) with ESMTP id tIPr5OszTqObLDs9XZG2gg Thu, 13 Jul 2023 22:51:53.079 +0000 (UTC) X-Comment: SPF check N/A for local connections - client-ip=::1; helo=localhost; envelope-from=sbaugh@catern.com; receiver=janestreet.com Original-Received: from localhost (localhost [IPv6:::1]) by earth.catern.com (Postfix) with ESMTPSA id B02446251B; Thu, 13 Jul 2023 18:51:52 -0400 (EDT) In-Reply-To: (Spencer Baugh's message of "Sun, 02 Apr 2023 13:37:36 -0400") X-SG-EID: ZgbRq7gjGrt0q/Pjvxk7wM0yQFRdOkTJAtEbkjCkHbKpzxVmZqFHjWqdI9nIX+wIEy5NAo8tkwAYZY9kBO95Wd7d+MRGz1tTbFtSMsylqri6SXjRYlI6vumQo29CAk7kuF0LFLwuqj7rHOEhExBLvnWyudMygC4UW3uXc0dBhZDyP7uSiDzNZ51V/FN4lDji8/5GoDfVTvqIKVrDgW1wgQ== X-Entity-ID: d/0VcHixlS0t7iB1YKCv4Q== 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:265054 Archived-At: --=-=-= Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit OK, after resolving bug#62732, now at last my nice and short patch for this feature. I've thought quite a bit about how to make this configurable, and I think just letting people write their own arbitrary transformation functions, as I do in this patch, is what we should provide. Making things any more modular is fairly difficult. Packages can come along and provide other fancy functions if they like. --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-Support-transforming-the-dirname-used-by-uniquify.patch >From 5e6260951b31fbd9da826cc2ff56bfbecdbbe7eb 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 | 22 +++++++++++++++++----- test/lisp/uniquify-tests.el | 33 +++++++++++++++++++++++++++++++++ 3 files changed, 62 insertions(+), 5 deletions(-) diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el index 03ed966cc45..11fa93fb70d 100644 --- a/lisp/progmodes/project.el +++ b/lisp/progmodes/project.el @@ -1887,5 +1887,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..bd49346da45 100644 --- a/lisp/uniquify.el +++ b/lisp/uniquify.el @@ -168,6 +168,16 @@ 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 + "A function to transform the dirname used to uniquify a buffer. + +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) + :group 'uniquify) + ;;; Utilities ;; uniquify-fix-list data structure @@ -209,7 +219,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 +279,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.41.0 --=-=-=--