Package: emacs;
Reported by: Spencer Baugh <sbaugh <at> janestreet.com>
Date: Sun, 2 Apr 2023 17:38:02 UTC
Severity: normal
Found in version 29.0.60
Done: Eli Zaretskii <eliz <at> gnu.org>
Bug is archived. No further changes may be made.
View this message in rfc822 format
From: Spencer Baugh <sbaugh <at> janestreet.com> To: Eli Zaretskii <eliz <at> gnu.org> Cc: dmitry <at> gutov.dev, 62621 <at> debbugs.gnu.org, sbaugh <at> catern.com Subject: bug#62621: 29.0.60; uniquify can't make buffers unique based on things other than filename Date: Fri, 21 Jul 2023 09:34:28 -0400
[Message part 1 (text/plain, inline)]
Eli Zaretskii <eliz <at> gnu.org> writes: >> From: Spencer Baugh <sbaugh <at> janestreet.com> >> Cc: Dmitry Gutov <dmitry <at> gutov.dev>, sbaugh <at> catern.com, 62621 <at> debbugs.gnu.org >> Date: Wed, 19 Jul 2023 08:31:00 -0400 >> >> >> >>> 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: > > Thanks, but it still falls short of what Dmitry described above: the > doc string doesn't "mention several functions that can be used". > >> +(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." > > Please read this carefully and try to put yourself in the shoes of a > user who needs to make sense out of this description. The immediate > question I had is what does "transforming a buffer's directory" have > to do with "uniquifying the buffer name"? Uniquifying a buffer's name > is not about its directory, at least not in general. IOW, the > starting point of this description is too "inside" the implementation. OK, how about this?
[0001-Support-transforming-the-dirname-used-by-uniquify.patch (text/x-patch, inline)]
From d5d909040b04bd8d6265d5f19eb3610b6d3d87d8 Mon Sep 17 00:00:00 2001
From: Spencer Baugh <sbaugh <at> catern.com>
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 | 38 ++++++++++++++++++++++++++++++++-----
test/lisp/uniquify-tests.el | 33 ++++++++++++++++++++++++++++++++
3 files changed, 78 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..eec5aefc803 100644
--- a/lisp/uniquify.el
+++ b/lisp/uniquify.el
@@ -168,6 +168,32 @@ 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.
+
+When `uniquify-buffer-name-style' is non-nil, if a buffer's name
+would be the same as some other buffer, then components from the
+buffer's directory name are added to the buffer's name until the
+buffer's name is unique.
+
+By default, uniquifying only adds components from the buffer's
+directory name. If you set this variable to
+`project-uniquify-dirname-transform', slash-separated components
+from `project-name' will also be added to the buffer's name when
+buffers from two different projects would otherwise have the same
+name.
+
+To include your own custom details in the unique buffer name, set
+this variable to a function taking a single argument, the
+buffer's directory, and returning a file name (which does not
+need to actually exist in the filesystem) to use components from."
+ :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 +235,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 +295,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)
+ '("~<test>" "~<>")))
+ (push (find-file-noselect "~/foo") bufs)
+ (push (find-file-noselect "./~/foo") bufs)
+ (should (equal (mapcar #'buffer-name bufs)
+ '("foo<~>" "foo</nonexistent>" "~<test>" "~<>")))
+ (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<other>" "README<bar>")))
+ (push (find-file-noselect "foo2/bar/README") bufs)
+ (should (equal (mapcar #'buffer-name bufs)
+ '("README<foo2/bar>" "README<other>" "README<foo1/bar>")))
+ (while bufs
+ (kill-buffer (pop bufs))))))
+
(provide 'uniquify-tests)
;;; uniquify-tests.el ends here
--
2.39.3
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.