Commit | Line | Data |
---|---|---|
ba83908c | 1 | ;;; uniquify.el --- unique buffer names dependent on file name -*- lexical-binding: t -*- |
4c61f92c | 2 | |
ba318903 | 3 | ;; Copyright (C) 1989, 1995-1997, 2001-2014 Free Software Foundation, |
ab422c4d | 4 | ;; Inc. |
4c61f92c KH |
5 | |
6 | ;; Author: Dick King <king@reasoning.com> | |
34dc21db | 7 | ;; Maintainer: emacs-devel@gnu.org |
284b3043 | 8 | ;; Keywords: files |
4c61f92c | 9 | ;; Created: 15 May 86 |
bd78fa1d | 10 | ;; Package: emacs |
4c61f92c KH |
11 | |
12 | ;; This file is part of GNU Emacs. | |
13 | ||
eb3fa2cf | 14 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
4c61f92c | 15 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
16 | ;; the Free Software Foundation, either version 3 of the License, or |
17 | ;; (at your option) any later version. | |
4c61f92c KH |
18 | |
19 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 | ;; GNU General Public License for more details. | |
23 | ||
24 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 25 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
4c61f92c KH |
26 | |
27 | ;;; Commentary: | |
28 | ||
29 | ;; Emacs's standard method for making buffer names unique adds <2>, <3>, | |
20c4d633 | 30 | ;; etc. to the end of (all but one of) the buffers. This file replaces |
4c61f92c | 31 | ;; that behavior, for buffers visiting files and dired buffers, with a |
5246db4e | 32 | ;; uniquification that adds parts of the file name until the buffer names |
4c61f92c KH |
33 | ;; are unique. For instance, buffers visiting /u/mernst/tmp/Makefile and |
34 | ;; /usr/projects/zaphod/Makefile would be named Makefile|tmp and | |
35 | ;; Makefile|zaphod, respectively (instead of Makefile and Makefile<2>). | |
36 | ;; Other buffer name styles are also available. | |
37 | ||
4219b27b RS |
38 | ;; To use this file, do (require 'uniquify) |
39 | ;; and set uniquify-buffer-name-style to one of its non-nil alternative values. | |
40 | ||
4c61f92c KH |
41 | ;; For other options, see "User-visible variables", below. |
42 | ||
d7993a1c RS |
43 | ;; A version of uniquify.el that works under Emacs 18, Emacs 19, XEmacs, |
44 | ;; and InfoDock is available from the maintainer. | |
4c61f92c KH |
45 | |
46 | ;;; Change Log: | |
47 | ||
48 | ;; Originally by Dick King <king@reasoning.com> 15 May 86 | |
feeb94f7 | 49 | ;; Converted for Emacs 18 by Stephen Gildea <gildea@stop.mail-abuse.org> |
4c61f92c KH |
50 | ;; Make uniquify-min-dir-content 0 truly non-invasive. gildea 23 May 89 |
51 | ;; Some cleanup. uniquify-min-dir-content default 0. gildea 01 Jun 89 | |
52 | ;; Don't rename to "". Michael Ernst <mernst@theory.lcs.mit.edu> 15 Jun 94 | |
53 | ;; Add kill-buffer-hook. Kenneth Manheimer <ken.manheimer@nist.gov> 09 May 95 | |
54 | ;; Add advice for rename-buffer and create-file-buffer, handle dired buffers, | |
55 | ;; kill-buffer-rationalize-buffer-names-p, documentation. mernst 24 May 95 | |
56 | ;; Remove free variables, fix typos. mernst 5 Jun 95 | |
57 | ;; Efficiently support Emacs 19.27 & earlier. ken.manheimer, mernst 10 Jun 95 | |
58 | ;; Rename user options to "uniquify-...", add uniquify-reverse-dir-content-p, | |
59 | ;; add uniquify-ask-about-buffer-names-p. king, mernst 13 Jun 95 | |
60 | ;; Prefix functions by "uniquify-..."; rename mnemonic-buffer-names to | |
61 | ;; uniquify-buffer-name-style; add 'forward and 'post-forward-angle-brackets | |
62 | ;; styles; remove uniquify-reverse-dir-content-p; add | |
63 | ;; uniquify-trailing-separator-p. mernst 4 Aug 95 | |
bc2e0aae KH |
64 | ;; Don't call expand-file-name on nil. mernst 7 Jan 96 |
65 | ;; Check whether list-buffers-directory is bound. mernst 11 Oct 96 | |
66 | ;; Ignore non-file non-dired buffers. Colin Rafferty <craffert@ml.com> 3 Mar 97 | |
4ddd2beb RS |
67 | ;; Use last component, not "", for file name of directories. mernst 27 Jun 97 |
68 | ;; Use directory-file-name; code cleanup. mernst 6 Sep 97 | |
9a9c6f9f RS |
69 | ;; Add uniquify-ignore-buffers-re. |
70 | ;; Andre Srinivasan <andre@visigenic.com> 9 Sep 97 | |
f4eda05f SM |
71 | ;; Add uniquify-list-buffers-directory-modes |
72 | ;; Stefan Monnier <monnier@cs.yale.edu> 17 Nov 2000 | |
4126f5b7 | 73 | ;; Algorithm and data structure changed to reduce consing with lots of buffers |
ef9f9d30 | 74 | ;; Francesco Potortì <pot@gnu.org> (ideas by rms and monnier) 2001-07-18 |
4c61f92c KH |
75 | |
76 | ;; Valuable feedback was provided by | |
77 | ;; Paul Smith <psmith@baynetworks.com>, | |
78 | ;; Alastair Burt <burt@dfki.uni-kl.de>, | |
79 | ;; Bob Weiner <weiner@footloose.sps.mot.com>, | |
80 | ;; Albert L. Ting <alt@vlibs.com>, | |
bc2e0aae KH |
81 | ;; gyro@reasoning.com, |
82 | ;; Bryan O'Sullivan <bos@eng.sun.com>. | |
4c61f92c KH |
83 | |
84 | ||
85 | ;;; Code: | |
86 | ||
f58e0fd5 | 87 | (eval-when-compile (require 'cl-lib)) |
4c61f92c KH |
88 | |
89 | ;;; User-visible variables | |
90 | ||
c5292bc8 | 91 | (defgroup uniquify nil |
0c4eeda3 | 92 | "Unique buffer names dependent on file name." |
eba5b4dd | 93 | :group 'files) |
c5292bc8 RS |
94 | |
95 | ||
d5ccb7be | 96 | (defcustom uniquify-buffer-name-style 'post-forward-angle-brackets |
e725d58f | 97 | "If non-nil, buffer names are uniquified with parts of directory name. |
5246db4e | 98 | The value determines the buffer name style and is one of `forward', |
595ded73 | 99 | `reverse', `post-forward', or `post-forward-angle-brackets'. |
5246db4e KH |
100 | For example, files `/foo/bar/mumble/name' and `/baz/quux/mumble/name' |
101 | would have the following buffer names in the various styles: | |
4c61f92c KH |
102 | forward bar/mumble/name quux/mumble/name |
103 | reverse name\\mumble\\bar name\\mumble\\quux | |
104 | post-forward name|bar/mumble name|quux/mumble | |
105 | post-forward-angle-brackets name<bar/mumble> name<quux/mumble> | |
e725d58f SM |
106 | nil name name<2> |
107 | Of course, the \"mumble\" part may be stripped as well, depending on the setting | |
108 | of `uniquify-strip-common-suffix'." | |
c5292bc8 RS |
109 | :type '(radio (const forward) |
110 | (const reverse) | |
111 | (const post-forward) | |
4f5074c1 | 112 | (const post-forward-angle-brackets) |
4219b27b | 113 | (const :tag "standard Emacs behavior (nil)" nil)) |
d5ccb7be | 114 | :version "24.4" |
f5307782 JB |
115 | :require 'uniquify |
116 | :group 'uniquify) | |
c5292bc8 | 117 | |
dee9b44f | 118 | (defcustom uniquify-after-kill-buffer-p t |
c3c140d6 | 119 | "If non-nil, rerationalize buffer names after a buffer has been killed." |
f5307782 JB |
120 | :type 'boolean |
121 | :group 'uniquify) | |
4c61f92c | 122 | |
c5292bc8 | 123 | (defcustom uniquify-ask-about-buffer-names-p nil |
e725d58f | 124 | "If non-nil, permit user to choose names for buffers with same base file. |
4c61f92c | 125 | If the user chooses to name a buffer, uniquification is preempted and no |
c5292bc8 | 126 | other buffer names are changed." |
f5307782 JB |
127 | :type 'boolean |
128 | :group 'uniquify) | |
4c61f92c | 129 | |
1f9d00ca | 130 | ;; The default value matches certain Gnus buffers. |
dee9b44f | 131 | (defcustom uniquify-ignore-buffers-re nil |
e725d58f | 132 | "Regular expression matching buffer names that should not be uniquified. |
9a9c6f9f RS |
133 | For instance, set this to \"^draft-[0-9]+$\" to avoid having uniquify rename |
134 | draft buffers even if `uniquify-after-kill-buffer-p' is non-nil and the | |
135 | visited file name isn't the same as that of the buffer." | |
f5307782 JB |
136 | :type '(choice (const :tag "Uniquify all buffers" nil) regexp) |
137 | :group 'uniquify) | |
9a9c6f9f | 138 | |
c5292bc8 | 139 | (defcustom uniquify-min-dir-content 0 |
e725d58f | 140 | "Minimum number of directory name components included in buffer name." |
f5307782 JB |
141 | :type 'integer |
142 | :group 'uniquify) | |
4c61f92c | 143 | |
c5292bc8 | 144 | (defcustom uniquify-separator nil |
e725d58f | 145 | "String separator for buffer name components. |
5246db4e | 146 | When `uniquify-buffer-name-style' is `post-forward', separates |
4c61f92c | 147 | base file name from directory part in buffer names (default \"|\"). |
5246db4e | 148 | When `uniquify-buffer-name-style' is `reverse', separates all |
c5292bc8 | 149 | file name components (default \"\\\")." |
f5307782 JB |
150 | :type '(choice (const nil) string) |
151 | :group 'uniquify) | |
4c61f92c | 152 | |
c5292bc8 | 153 | (defcustom uniquify-trailing-separator-p nil |
e725d58f | 154 | "If non-nil, add a file name separator to dired buffer names. |
5246db4e KH |
155 | If `uniquify-buffer-name-style' is `forward', add the separator at the end; |
156 | if it is `reverse', add the separator at the beginning; otherwise, this | |
c5292bc8 | 157 | variable is ignored." |
f5307782 JB |
158 | :type 'boolean |
159 | :group 'uniquify) | |
4c61f92c | 160 | |
c3c140d6 SM |
161 | (defcustom uniquify-strip-common-suffix |
162 | ;; Using it when uniquify-min-dir-content>0 doesn't make much sense. | |
163 | (eq 0 uniquify-min-dir-content) | |
164 | "If non-nil, strip common directory suffixes of conflicting files. | |
165 | E.g. if you open /a1/b/c/d and /a2/b/c/d, the buffer names will say | |
166 | \"d|a1\" and \"d|a2\" instead of \"d|a1/b/c\" and \"d|a2/b/c\". | |
167 | This can be handy when you have deep parallel hierarchies." | |
f5307782 JB |
168 | :type 'boolean |
169 | :group 'uniquify) | |
c3c140d6 | 170 | |
76dc97b8 | 171 | (defvar uniquify-list-buffers-directory-modes '(dired-mode cvs-mode vc-dir-mode) |
f4eda05f SM |
172 | "List of modes for which uniquify should obey `list-buffers-directory'. |
173 | That means that when `buffer-file-name' is set to nil, `list-buffers-directory' | |
174 | contains the name of the directory which the buffer is visiting.") | |
4c61f92c KH |
175 | |
176 | ;;; Utilities | |
177 | ||
4ddd2beb | 178 | ;; uniquify-fix-list data structure |
f58e0fd5 | 179 | (cl-defstruct (uniquify-item |
df050870 | 180 | (:constructor nil) (:copier nil) |
c3c140d6 SM |
181 | (:constructor uniquify-make-item |
182 | (base dirname buffer &optional proposed))) | |
bf0e40d4 | 183 | base dirname buffer proposed) |
4c61f92c KH |
184 | |
185 | ;; Internal variables used free | |
4c61f92c KH |
186 | (defvar uniquify-possibly-resolvable nil) |
187 | ||
2e31777b | 188 | (defvar-local uniquify-managed nil |
518e35e6 SM |
189 | "Non-nil if the name of this buffer is managed by uniquify. |
190 | It actually holds the list of `uniquify-item's corresponding to the conflict.") | |
6b09e9c8 SM |
191 | (put 'uniquify-managed 'permanent-local t) |
192 | ||
20c4d633 JB |
193 | ;; Used in desktop.el to save the non-uniquified buffer name |
194 | (defun uniquify-buffer-base-name () | |
195 | "Return the base name of the current buffer. | |
ef9f9d30 | 196 | Return nil if the buffer is not managed by uniquify." |
20c4d633 | 197 | (and uniquify-managed |
ef9f9d30 | 198 | (uniquify-item-base (car uniquify-managed)))) |
20c4d633 | 199 | |
4c61f92c KH |
200 | ;;; Main entry point. |
201 | ||
75e2fcb6 | 202 | (defun uniquify-rationalize-file-buffer-names (base dirname newbuf) |
f4eda05f | 203 | "Make file buffer names unique by adding segments from file name. |
4c61f92c | 204 | If `uniquify-min-dir-content' > 0, always pulls that many |
124e448b | 205 | file name elements. |
aa744995 | 206 | Arguments BASE, DIRNAME, and NEWBUF specify the new buffer that causes |
2eec3e8e SM |
207 | this rationalization." |
208 | (interactive | |
209 | (list (if uniquify-managed | |
210 | (uniquify-item-base (car uniquify-managed)) (buffer-name)) | |
211 | (uniquify-buffer-file-name (current-buffer)) | |
212 | (current-buffer))) | |
9890ec7d SM |
213 | ;; Make sure we don't get confused by outdated uniquify-managed info in |
214 | ;; this buffer. | |
215 | (with-current-buffer newbuf (setq uniquify-managed nil)) | |
216 | (when dirname | |
75e2fcb6 SM |
217 | (setq dirname (expand-file-name (directory-file-name dirname))) |
218 | (let ((fix-list (list (uniquify-make-item base dirname newbuf))) | |
219 | items) | |
ad599c11 | 220 | (dolist (buffer (buffer-list)) |
75e2fcb6 SM |
221 | (when (and (not (and uniquify-ignore-buffers-re |
222 | (string-match uniquify-ignore-buffers-re | |
223 | (buffer-name buffer)))) | |
224 | ;; Only try to rename buffers we actually manage. | |
225 | (setq items (buffer-local-value 'uniquify-managed buffer)) | |
226 | (equal base (uniquify-item-base (car items))) | |
227 | ;; Don't re-add stuff we already have. Actually this | |
228 | ;; whole `and' test should only match at most once. | |
229 | (not (memq (car items) fix-list))) | |
aa744995 SM |
230 | (unless (cdr items) |
231 | ;; If there was no conflict, the buffer-name is equal to the | |
232 | ;; base-name and we may have missed a rename-buffer because | |
233 | ;; of code like in set-visited-file-name: | |
234 | ;; (or (string= new-name (buffer-name)) (rename-buffer new-name t)) | |
235 | ;; So we need to refresh the dirname of the uniquify-item. | |
236 | (setf (uniquify-item-dirname (car items)) | |
237 | (uniquify-buffer-file-name | |
238 | (uniquify-item-buffer (car items)))) | |
dee9b44f | 239 | ;; This shouldn't happen, but maybe there's no dirname any more. |
aa744995 | 240 | (unless (uniquify-item-dirname (car items)) |
aa744995 | 241 | (with-current-buffer (uniquify-item-buffer (car items)) |
1c4001a1 SM |
242 | (setq uniquify-managed nil)) |
243 | (setq items nil))) | |
8837a213 SM |
244 | ;; In case we missed some calls to kill-buffer, there may be dead |
245 | ;; buffers in uniquify-managed, so filter them out. | |
246 | (setq items | |
247 | (delq nil (mapcar | |
248 | (lambda (item) | |
249 | (if (buffer-live-p (uniquify-item-buffer item)) | |
250 | item)) | |
251 | items))) | |
75e2fcb6 | 252 | (setq fix-list (append fix-list items)))) |
ad599c11 SM |
253 | ;; selects buffers whose names may need changing, and others that |
254 | ;; may conflict, then bring conflicting names together | |
255 | (uniquify-rationalize fix-list)))) | |
4c61f92c | 256 | |
4ddd2beb | 257 | ;; uniquify's version of buffer-file-name; result never contains trailing slash |
4c61f92c | 258 | (defun uniquify-buffer-file-name (buffer) |
75e2fcb6 | 259 | "Return name of directory, file BUFFER is visiting, or nil if none. |
f4eda05f SM |
260 | Works on ordinary file-visiting buffers and buffers whose mode is mentioned |
261 | in `uniquify-list-buffers-directory-modes', otherwise returns nil." | |
75e2fcb6 SM |
262 | (with-current-buffer buffer |
263 | (let ((filename | |
264 | (or buffer-file-name | |
265 | (if (memq major-mode uniquify-list-buffers-directory-modes) | |
266 | list-buffers-directory)))) | |
267 | (when filename | |
aa744995 SM |
268 | (directory-file-name |
269 | (file-name-directory | |
270 | (expand-file-name | |
271 | (directory-file-name filename)))))))) | |
4c61f92c | 272 | |
518e35e6 | 273 | (defun uniquify-rerationalize-w/o-cb (fix-list) |
e725d58f | 274 | "Re-rationalize the buffers in FIX-LIST, but ignoring `current-buffer'." |
518e35e6 SM |
275 | (let ((new-fix-list nil)) |
276 | (dolist (item fix-list) | |
277 | (let ((buf (uniquify-item-buffer item))) | |
278 | (unless (or (eq buf (current-buffer)) (not (buffer-live-p buf))) | |
518e35e6 SM |
279 | (push item new-fix-list)))) |
280 | (when new-fix-list | |
281 | (uniquify-rationalize new-fix-list)))) | |
282 | ||
283 | (defun uniquify-rationalize (fix-list) | |
284 | ;; Set up uniquify to re-rationalize after killing/renaming | |
285 | ;; if there is a conflict. | |
c3c140d6 SM |
286 | (dolist (item fix-list) |
287 | (with-current-buffer (uniquify-item-buffer item) | |
aa744995 | 288 | ;; Refresh the dirnames and proposed names. |
c3c140d6 SM |
289 | (setf (uniquify-item-proposed item) |
290 | (uniquify-get-proposed-name (uniquify-item-base item) | |
291 | (uniquify-item-dirname item))) | |
518e35e6 | 292 | (setq uniquify-managed fix-list))) |
c3c140d6 SM |
293 | ;; Strip any shared last directory names of the dirname. |
294 | (when (and (cdr fix-list) uniquify-strip-common-suffix) | |
295 | (let ((strip t)) | |
296 | (while (let* ((base (file-name-nondirectory | |
297 | (uniquify-item-dirname (car fix-list)))) | |
298 | (items fix-list)) | |
299 | (when (> (length base) 0) | |
300 | (while (and strip items) | |
301 | (unless (equal base (file-name-nondirectory | |
302 | (uniquify-item-dirname (pop items)))) | |
303 | (setq strip nil))) | |
304 | strip)) | |
305 | ;; It's all the same => strip. | |
306 | (dolist (item (prog1 fix-list (setq fix-list nil))) | |
307 | ;; Create new items because the old ones are kept (with the true | |
308 | ;; `dirname') for later rerationalizing. | |
309 | (push (uniquify-make-item (uniquify-item-base item) | |
310 | (let ((f (file-name-directory | |
311 | (uniquify-item-dirname item)))) | |
312 | (and f (directory-file-name f))) | |
313 | (uniquify-item-buffer item) | |
314 | (uniquify-item-proposed item)) | |
315 | fix-list))))) | |
518e35e6 SM |
316 | ;; If uniquify-min-dir-content is 0, this will end up just |
317 | ;; passing fix-list to uniquify-rationalize-conflicting-sublist. | |
318 | (uniquify-rationalize-a-list fix-list)) | |
319 | ||
57749acf | 320 | (defun uniquify-item-greaterp (item1 item2) |
df050870 SM |
321 | (string-lessp (uniquify-item-proposed item2) |
322 | (uniquify-item-proposed item1))) | |
4c61f92c | 323 | |
df050870 SM |
324 | (defun uniquify-rationalize-a-list (fix-list &optional depth) |
325 | (unless depth (setq depth uniquify-min-dir-content)) | |
18ed17e4 | 326 | (let (conflicting-sublist ; all elements have the same proposed name |
4126f5b7 FP |
327 | (old-proposed "") |
328 | proposed) | |
df050870 SM |
329 | ;; Divide fix-list into items with same proposed names and pass them |
330 | ;; to uniquify-rationalize-conflicting-sublist. | |
3e9db557 | 331 | (dolist (item (sort (copy-sequence fix-list) 'uniquify-item-greaterp)) |
df050870 | 332 | (setq proposed (uniquify-item-proposed item)) |
4126f5b7 | 333 | (unless (equal proposed old-proposed) |
b2f1b848 | 334 | (uniquify-rationalize-conflicting-sublist conflicting-sublist |
4126f5b7 | 335 | old-proposed depth) |
b2f1b848 FP |
336 | (setq conflicting-sublist nil)) |
337 | (push item conflicting-sublist) | |
4126f5b7 FP |
338 | (setq old-proposed proposed)) |
339 | (uniquify-rationalize-conflicting-sublist conflicting-sublist | |
340 | old-proposed depth))) | |
4c61f92c | 341 | |
bf0e40d4 | 342 | (defun uniquify-get-proposed-name (base dirname &optional depth) |
df050870 | 343 | (unless depth (setq depth uniquify-min-dir-content)) |
f58e0fd5 | 344 | (cl-assert (equal (directory-file-name dirname) dirname)) ;No trailing slash. |
1c549bbe GM |
345 | |
346 | ;; Distinguish directories by adding extra separator. | |
347 | (if (and uniquify-trailing-separator-p | |
bf0e40d4 | 348 | (file-directory-p (expand-file-name base dirname)) |
1c549bbe GM |
349 | (not (string-equal base ""))) |
350 | (cond ((eq uniquify-buffer-name-style 'forward) | |
351 | (setq base (file-name-as-directory base))) | |
352 | ;; (setq base (concat base "/"))) | |
353 | ((eq uniquify-buffer-name-style 'reverse) | |
354 | (setq base (concat (or uniquify-separator "\\") base))))) | |
355 | ||
356 | (let ((extra-string nil) | |
b2f1b848 | 357 | (n depth)) |
bf0e40d4 SM |
358 | (while (and (> n 0) dirname) |
359 | (let ((file (file-name-nondirectory dirname))) | |
360 | (when (setq dirname (file-name-directory dirname)) | |
361 | (setq dirname (directory-file-name dirname))) | |
1c549bbe GM |
362 | (setq n (1- n)) |
363 | (push (if (zerop (length file)) ;nil or "". | |
b8206d82 MA |
364 | (prog1 (or (file-remote-p dirname) "") |
365 | (setq dirname nil)) ;Could be `dirname' iso "". | |
1c549bbe GM |
366 | file) |
367 | extra-string))) | |
368 | (when (zerop n) | |
bf0e40d4 SM |
369 | (if (and dirname extra-string |
370 | (equal dirname (file-name-directory dirname))) | |
1c549bbe GM |
371 | ;; We're just before the root. Let's add the leading / already. |
372 | ;; With "/a/b"+"/c/d/b" this leads to "/a/b" and "d/b" but with | |
373 | ;; "/a/b"+"/c/a/b" this leads to "/a/b" and "a/b". | |
374 | (push "" extra-string)) | |
375 | (setq uniquify-possibly-resolvable t)) | |
376 | ||
377 | (cond | |
378 | ((null extra-string) base) | |
379 | ((string-equal base "") ;Happens for dired buffers on the root directory. | |
5da10d40 | 380 | (mapconcat 'identity extra-string "/")) |
1c549bbe | 381 | ((eq uniquify-buffer-name-style 'reverse) |
5da10d40 RS |
382 | (mapconcat 'identity |
383 | (cons base (nreverse extra-string)) | |
384 | (or uniquify-separator "\\"))) | |
1c549bbe GM |
385 | ((eq uniquify-buffer-name-style 'forward) |
386 | (mapconcat 'identity (nconc extra-string (list base)) | |
5da10d40 | 387 | "/")) |
1c549bbe GM |
388 | ((eq uniquify-buffer-name-style 'post-forward) |
389 | (concat base (or uniquify-separator "|") | |
5da10d40 | 390 | (mapconcat 'identity extra-string "/"))) |
1c549bbe | 391 | ((eq uniquify-buffer-name-style 'post-forward-angle-brackets) |
5da10d40 RS |
392 | (concat base "<" (mapconcat 'identity extra-string "/") |
393 | ">")) | |
1c549bbe GM |
394 | (t (error "Bad value for uniquify-buffer-name-style: %s" |
395 | uniquify-buffer-name-style))))) | |
4c61f92c KH |
396 | |
397 | ||
4ddd2beb RS |
398 | ;; Deal with conflicting-sublist, all of whose elements have identical |
399 | ;; "base" components. | |
57749acf FP |
400 | (defun uniquify-rationalize-conflicting-sublist (conf-list old-name depth) |
401 | (when conf-list | |
402 | (if (or (cdr conf-list) | |
df050870 SM |
403 | ;; Check that the proposed name doesn't conflict with some |
404 | ;; existing buffer. | |
405 | (let ((buf (get-buffer old-name))) | |
406 | (and buf (not (eq buf (uniquify-item-buffer (car conf-list))))))) | |
57749acf FP |
407 | (when uniquify-possibly-resolvable |
408 | (setq uniquify-possibly-resolvable nil | |
409 | depth (1+ depth)) | |
410 | (dolist (item conf-list) | |
df050870 SM |
411 | (setf (uniquify-item-proposed item) |
412 | (uniquify-get-proposed-name | |
413 | (uniquify-item-base item) | |
bf0e40d4 | 414 | (uniquify-item-dirname item) |
df050870 | 415 | depth))) |
57749acf FP |
416 | (uniquify-rationalize-a-list conf-list depth)) |
417 | (unless (string= old-name "") | |
418 | (uniquify-rename-buffer (car conf-list) old-name))))) | |
419 | ||
4c61f92c KH |
420 | |
421 | (defun uniquify-rename-buffer (item newname) | |
df050870 | 422 | (let ((buffer (uniquify-item-buffer item))) |
4126f5b7 | 423 | (unless (equal newname (buffer-name buffer)) |
df050870 SM |
424 | (with-current-buffer buffer |
425 | (let ((uniquify-buffer-name-style nil)) ;Avoid hooks on rename-buffer. | |
6b09e9c8 | 426 | ;; Pass the `unique' arg, so the advice doesn't mark it as unmanaged. |
df050870 | 427 | (rename-buffer newname t)))))) |
4c61f92c | 428 | |
4c61f92c KH |
429 | ;;; Hooks from the rest of Emacs |
430 | ||
43ae2c48 GM |
431 | (defun uniquify-maybe-rerationalize-w/o-cb () |
432 | "Re-rationalize buffer names, ignoring current buffer." | |
433 | (and (cdr uniquify-managed) | |
434 | uniquify-buffer-name-style | |
435 | (uniquify-rerationalize-w/o-cb uniquify-managed))) | |
436 | ||
58be68a8 JB |
437 | ;; Buffer deletion |
438 | ;; Rerationalize after a buffer is killed, to reduce coinciding buffer names. | |
439 | ;; This mechanism uses `kill-buffer-hook', which runs *before* deletion, so | |
440 | ;; it calls `uniquify-rerationalize-w/o-cb' to rerationalize the buffer list | |
441 | ;; ignoring the current buffer (which is going to be deleted anyway). | |
43ae2c48 | 442 | (defun uniquify-kill-buffer-function () |
58be68a8 JB |
443 | "Re-rationalize buffer names, ignoring current buffer. |
444 | For use on `kill-buffer-hook'." | |
43ae2c48 GM |
445 | (and uniquify-after-kill-buffer-p |
446 | (uniquify-maybe-rerationalize-w/o-cb))) | |
58be68a8 JB |
447 | |
448 | ;; Ideally we'd like to add it buffer-locally, but that doesn't work | |
449 | ;; because kill-buffer-hook is not permanent-local :-( | |
43ae2c48 GM |
450 | ;; FIXME kill-buffer-hook _is_ permanent-local in 22+. |
451 | (add-hook 'kill-buffer-hook 'uniquify-kill-buffer-function) | |
58be68a8 | 452 | |
4c61f92c KH |
453 | ;; The logical place to put all this code is in generate-new-buffer-name. |
454 | ;; It's written in C, so we would add a generate-new-buffer-name-function | |
455 | ;; which, if non-nil, would be called instead of the C. One problem with | |
456 | ;; that is that generate-new-buffer-name takes a potential buffer name as | |
457 | ;; its argument -- not other information, such as what file the buffer will | |
458 | ;; visit. | |
459 | ||
460 | ;; The below solution works because generate-new-buffer-name is called | |
461 | ;; only by rename-buffer (which, as of 19.29, is never called from C) and | |
462 | ;; generate-new-buffer, which is called only by Lisp functions | |
463 | ;; create-file-buffer and rename-uniquely. Rename-uniquely generally | |
464 | ;; isn't used for buffers visiting files, so it's sufficient to hook | |
1a4914f3 | 465 | ;; rename-buffer and create-file-buffer. (Setting find-file-hook isn't |
4c61f92c KH |
466 | ;; sufficient.) |
467 | ||
2e31777b SM |
468 | (advice-add 'rename-buffer :around #'uniquify--rename-buffer-advice) |
469 | (defun uniquify--rename-buffer-advice (rb-fun newname &optional unique &rest args) | |
4c61f92c | 470 | "Uniquify buffer names with parts of directory name." |
2e31777b | 471 | (let ((retval (apply rb-fun newname unique args))) |
518e35e6 | 472 | (uniquify-maybe-rerationalize-w/o-cb) |
2e31777b | 473 | (if (null unique) |
6b09e9c8 SM |
474 | ;; Mark this buffer so it won't be renamed by uniquify. |
475 | (setq uniquify-managed nil) | |
476 | (when uniquify-buffer-name-style | |
518e35e6 SM |
477 | ;; Rerationalize w.r.t the new name. |
478 | (uniquify-rationalize-file-buffer-names | |
2e31777b | 479 | newname |
75e2fcb6 SM |
480 | (uniquify-buffer-file-name (current-buffer)) |
481 | (current-buffer)) | |
2e31777b SM |
482 | (setq retval (buffer-name (current-buffer))))) |
483 | retval)) | |
4c61f92c | 484 | |
2e31777b SM |
485 | |
486 | (advice-add 'create-file-buffer :around #'uniquify--create-file-buffer-advice) | |
487 | (defun uniquify--create-file-buffer-advice (cfb-fun filename &rest args) | |
4c61f92c | 488 | "Uniquify buffer names with parts of directory name." |
2e31777b | 489 | (let ((retval (apply cfb-fun filename args))) |
4c61f92c | 490 | (if uniquify-buffer-name-style |
2e31777b | 491 | (let ((filename (expand-file-name (directory-file-name filename)))) |
75e2fcb6 SM |
492 | (uniquify-rationalize-file-buffer-names |
493 | (file-name-nondirectory filename) | |
2e31777b SM |
494 | (file-name-directory filename) retval))) |
495 | retval)) | |
4c61f92c | 496 | |
2513e3fd JB |
497 | ;;; The End |
498 | ||
499 | (defun uniquify-unload-function () | |
352ddc78 | 500 | "Unload the uniquify library." |
2513e3fd JB |
501 | (save-current-buffer |
502 | (let ((buffers nil)) | |
503 | (dolist (buf (buffer-list)) | |
504 | (set-buffer buf) | |
505 | (when uniquify-managed | |
506 | (push (cons buf (uniquify-item-base (car uniquify-managed))) buffers))) | |
2e31777b SM |
507 | (advice-remove 'rename-buffer #'uniquify--rename-buffer-advice) |
508 | (advice-remove 'create-file-buffer #'uniquify--create-file-buffer-advice) | |
2513e3fd JB |
509 | (dolist (buf buffers) |
510 | (set-buffer (car buf)) | |
511 | (rename-buffer (cdr buf) t)))) | |
20c4d633 | 512 | ;; continue standard unloading |
2513e3fd | 513 | nil) |
8b374c3f | 514 | |
df050870 | 515 | (provide 'uniquify) |
ab5796a9 | 516 | |
4c61f92c | 517 | ;;; uniquify.el ends here |