Bind inhibit-modification-hooks rather than a/b-c-f
[emacs.git] / lisp / uniquify.el
blobc5692ffde342d166e2fe5580dd41db63fca1b8c3
1 ;;; uniquify.el --- unique buffer names dependent on file name -*- lexical-binding: t -*-
3 ;; Copyright (C) 1989, 1995-1997, 2001-2015 Free Software Foundation,
4 ;; Inc.
6 ;; Author: Dick King <king@reasoning.com>
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: files
9 ;; Created: 15 May 86
10 ;; Package: emacs
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
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.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; Emacs's traditional method for making buffer names unique adds <2>, <3>,
30 ;; etc. to the end of (all but one of) the buffers. This file replaces
31 ;; that behavior, for buffers visiting files and dired buffers, with a
32 ;; uniquification that adds parts of the file name until the buffer names
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.
38 ;; To use this file, do (require 'uniquify)
39 ;; and set uniquify-buffer-name-style to one of its non-nil alternative values.
41 ;; For other options, see "User-visible variables", below.
43 ;; A version of uniquify.el that works under Emacs 18, Emacs 19, XEmacs,
44 ;; and InfoDock is available from the maintainer.
46 ;;; Change Log:
48 ;; Originally by Dick King <king@reasoning.com> 15 May 86
49 ;; Converted for Emacs 18 by Stephen Gildea <gildea@stop.mail-abuse.org>
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
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
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
69 ;; Add uniquify-ignore-buffers-re.
70 ;; Andre Srinivasan <andre@visigenic.com> 9 Sep 97
71 ;; Add uniquify-list-buffers-directory-modes
72 ;; Stefan Monnier <monnier@cs.yale.edu> 17 Nov 2000
73 ;; Algorithm and data structure changed to reduce consing with lots of buffers
74 ;; Francesco Potortì <pot@gnu.org> (ideas by rms and monnier) 2001-07-18
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>,
81 ;; gyro@reasoning.com,
82 ;; Bryan O'Sullivan <bos@eng.sun.com>.
85 ;;; Code:
87 (eval-when-compile (require 'cl-lib))
89 ;;; User-visible variables
91 (defgroup uniquify nil
92 "Unique buffer names dependent on file name."
93 :group 'files)
96 (defcustom uniquify-buffer-name-style 'post-forward-angle-brackets
97 "How to construct unique buffer names for files with the same base name.
98 The value can be one of: `forward', `reverse', `post-forward',
99 `post-forward-angle-brackets', or nil.
101 For example, the files `/foo/bar/mumble/name' and `/baz/quux/mumble/name'
102 would have the following buffer names in the various styles:
104 forward bar/mumble/name quux/mumble/name
105 reverse name\\mumble\\bar name\\mumble\\quux
106 post-forward name|bar/mumble name|quux/mumble
107 post-forward-angle-brackets name<bar/mumble> name<quux/mumble>
108 nil name name<2>
110 The \"mumble\" part may be stripped as well, depending on the
111 setting of `uniquify-strip-common-suffix'. For more options that
112 you can set, browse the `uniquify' custom group."
113 :type '(radio (const forward)
114 (const reverse)
115 (const post-forward)
116 (const post-forward-angle-brackets)
117 (const :tag "numeric suffixes" nil))
118 :version "24.4"
119 :require 'uniquify)
121 (defcustom uniquify-after-kill-buffer-p t
122 "If non-nil, rerationalize buffer names after a buffer has been killed."
123 :type 'boolean)
125 ;; The default value matches certain Gnus buffers.
126 (defcustom uniquify-ignore-buffers-re nil
127 "Regular expression matching buffer names that should not be uniquified.
128 For instance, set this to \"^draft-[0-9]+$\" to avoid having uniquify rename
129 draft buffers even if `uniquify-after-kill-buffer-p' is non-nil and the
130 visited file name isn't the same as that of the buffer."
131 :type '(choice (const :tag "Uniquify all buffers" nil) regexp))
133 (defcustom uniquify-min-dir-content 0
134 "Minimum number of directory name components included in buffer name."
135 :type 'integer)
137 (defcustom uniquify-separator nil
138 "String separator for buffer name components.
139 When `uniquify-buffer-name-style' is `post-forward', separates
140 base file name from directory part in buffer names (default \"|\").
141 When `uniquify-buffer-name-style' is `reverse', separates all
142 file name components (default \"\\\")."
143 :type '(choice (const nil) string))
145 (defcustom uniquify-trailing-separator-p nil
146 "If non-nil, add a file name separator to dired buffer names.
147 If `uniquify-buffer-name-style' is `forward', add the separator at the end;
148 if it is `reverse', add the separator at the beginning; otherwise, this
149 variable is ignored."
150 :type 'boolean)
152 (defcustom uniquify-strip-common-suffix
153 ;; Using it when uniquify-min-dir-content>0 doesn't make much sense.
154 (eq 0 uniquify-min-dir-content)
155 "If non-nil, strip common directory suffixes of conflicting files.
156 E.g. if you open /a1/b/c/d and /a2/b/c/d, the buffer names will say
157 \"d|a1\" and \"d|a2\" instead of \"d|a1/b/c\" and \"d|a2/b/c\".
158 This can be handy when you have deep parallel hierarchies."
159 :type 'boolean)
161 (defvar uniquify-list-buffers-directory-modes '(dired-mode cvs-mode vc-dir-mode)
162 "List of modes for which uniquify should obey `list-buffers-directory'.
163 That means that when `buffer-file-name' is set to nil, `list-buffers-directory'
164 contains the name of the directory which the buffer is visiting.")
166 ;;; Utilities
168 ;; uniquify-fix-list data structure
169 (cl-defstruct (uniquify-item
170 (:constructor nil) (:copier nil)
171 (:constructor uniquify-make-item
172 (base dirname buffer &optional proposed)))
173 base dirname buffer proposed)
175 ;; Internal variables used free
176 (defvar uniquify-possibly-resolvable nil)
178 (defvar-local uniquify-managed nil
179 "Non-nil if the name of this buffer is managed by uniquify.
180 It actually holds the list of `uniquify-item's corresponding to the conflict.")
181 (put 'uniquify-managed 'permanent-local t)
183 ;; Used in desktop.el to save the non-uniquified buffer name
184 (defun uniquify-buffer-base-name ()
185 "Return the base name of the current buffer.
186 Return nil if the buffer is not managed by uniquify."
187 (and uniquify-managed
188 (uniquify-item-base (car uniquify-managed))))
190 ;;; Main entry point.
192 (defun uniquify-rationalize-file-buffer-names (base dirname newbuf)
193 "Make file buffer names unique by adding segments from file name.
194 If `uniquify-min-dir-content' > 0, always pulls that many
195 file name elements.
196 Arguments BASE, DIRNAME, and NEWBUF specify the new buffer that causes
197 this rationalization."
198 (interactive
199 (list (if uniquify-managed
200 (uniquify-item-base (car uniquify-managed)) (buffer-name))
201 (uniquify-buffer-file-name (current-buffer))
202 (current-buffer)))
203 ;; Make sure we don't get confused by outdated uniquify-managed info in
204 ;; this buffer.
205 (with-current-buffer newbuf (setq uniquify-managed nil))
206 (when dirname
207 (setq dirname (expand-file-name (directory-file-name dirname)))
208 (let ((fix-list (list (uniquify-make-item base dirname newbuf)))
209 items)
210 (dolist (buffer (buffer-list))
211 (when (and (not (and uniquify-ignore-buffers-re
212 (string-match uniquify-ignore-buffers-re
213 (buffer-name buffer))))
214 ;; Only try to rename buffers we actually manage.
215 (setq items (buffer-local-value 'uniquify-managed buffer))
216 (equal base (uniquify-item-base (car items)))
217 ;; Don't re-add stuff we already have. Actually this
218 ;; whole `and' test should only match at most once.
219 (not (memq (car items) fix-list)))
220 (unless (cdr items)
221 ;; If there was no conflict, the buffer-name is equal to the
222 ;; base-name and we may have missed a rename-buffer because
223 ;; of code like in set-visited-file-name:
224 ;; (or (string= new-name (buffer-name)) (rename-buffer new-name t))
225 ;; So we need to refresh the dirname of the uniquify-item.
226 (setf (uniquify-item-dirname (car items))
227 (uniquify-buffer-file-name
228 (uniquify-item-buffer (car items))))
229 ;; This shouldn't happen, but maybe there's no dirname any more.
230 (unless (uniquify-item-dirname (car items))
231 (with-current-buffer (uniquify-item-buffer (car items))
232 (setq uniquify-managed nil))
233 (setq items nil)))
234 ;; In case we missed some calls to kill-buffer, there may be dead
235 ;; buffers in uniquify-managed, so filter them out.
236 (setq items
237 (delq nil (mapcar
238 (lambda (item)
239 (if (buffer-live-p (uniquify-item-buffer item))
240 item))
241 items)))
242 (setq fix-list (append fix-list items))))
243 ;; selects buffers whose names may need changing, and others that
244 ;; may conflict, then bring conflicting names together
245 (uniquify-rationalize fix-list))))
247 ;; uniquify's version of buffer-file-name; result never contains trailing slash
248 (defun uniquify-buffer-file-name (buffer)
249 "Return name of directory, file BUFFER is visiting, or nil if none.
250 Works on ordinary file-visiting buffers and buffers whose mode is mentioned
251 in `uniquify-list-buffers-directory-modes', otherwise returns nil."
252 (with-current-buffer buffer
253 (let ((filename
254 (or buffer-file-name
255 (if (memq major-mode uniquify-list-buffers-directory-modes)
256 list-buffers-directory))))
257 (when filename
258 (directory-file-name
259 (file-name-directory
260 (expand-file-name
261 (directory-file-name filename))))))))
263 (defun uniquify-rerationalize-w/o-cb (fix-list)
264 "Re-rationalize the buffers in FIX-LIST, but ignoring `current-buffer'."
265 (let ((new-fix-list nil))
266 (dolist (item fix-list)
267 (let ((buf (uniquify-item-buffer item)))
268 (unless (or (eq buf (current-buffer)) (not (buffer-live-p buf)))
269 (push item new-fix-list))))
270 (when new-fix-list
271 (uniquify-rationalize new-fix-list))))
273 (defun uniquify-rationalize (fix-list)
274 ;; Set up uniquify to re-rationalize after killing/renaming
275 ;; if there is a conflict.
276 (dolist (item fix-list)
277 (with-current-buffer (uniquify-item-buffer item)
278 ;; Refresh the dirnames and proposed names.
279 (setf (uniquify-item-proposed item)
280 (uniquify-get-proposed-name (uniquify-item-base item)
281 (uniquify-item-dirname item)))
282 (setq uniquify-managed fix-list)))
283 ;; Strip any shared last directory names of the dirname.
284 (when (and (cdr fix-list) uniquify-strip-common-suffix)
285 (let ((strip t))
286 (while (let* ((base (file-name-nondirectory
287 (uniquify-item-dirname (car fix-list))))
288 (items fix-list))
289 (when (> (length base) 0)
290 (while (and strip items)
291 (unless (equal base (file-name-nondirectory
292 (uniquify-item-dirname (pop items))))
293 (setq strip nil)))
294 strip))
295 ;; It's all the same => strip.
296 (dolist (item (prog1 fix-list (setq fix-list nil)))
297 ;; Create new items because the old ones are kept (with the true
298 ;; `dirname') for later rerationalizing.
299 (push (uniquify-make-item (uniquify-item-base item)
300 (let ((f (file-name-directory
301 (uniquify-item-dirname item))))
302 (and f (directory-file-name f)))
303 (uniquify-item-buffer item)
304 (uniquify-item-proposed item))
305 fix-list)))))
306 ;; If uniquify-min-dir-content is 0, this will end up just
307 ;; passing fix-list to uniquify-rationalize-conflicting-sublist.
308 (uniquify-rationalize-a-list fix-list))
310 (defun uniquify-item-greaterp (item1 item2)
311 (string-lessp (uniquify-item-proposed item2)
312 (uniquify-item-proposed item1)))
314 (defun uniquify-rationalize-a-list (fix-list &optional depth)
315 (unless depth (setq depth uniquify-min-dir-content))
316 (let (conflicting-sublist ; all elements have the same proposed name
317 (old-proposed "")
318 proposed)
319 ;; Divide fix-list into items with same proposed names and pass them
320 ;; to uniquify-rationalize-conflicting-sublist.
321 (dolist (item (sort (copy-sequence fix-list) 'uniquify-item-greaterp))
322 (setq proposed (uniquify-item-proposed item))
323 (unless (equal proposed old-proposed)
324 (uniquify-rationalize-conflicting-sublist conflicting-sublist
325 old-proposed depth)
326 (setq conflicting-sublist nil))
327 (push item conflicting-sublist)
328 (setq old-proposed proposed))
329 (uniquify-rationalize-conflicting-sublist conflicting-sublist
330 old-proposed depth)))
332 (defun uniquify-get-proposed-name (base dirname &optional depth)
333 (unless depth (setq depth uniquify-min-dir-content))
334 (cl-assert (equal (directory-file-name dirname) dirname)) ;No trailing slash.
336 ;; Distinguish directories by adding extra separator.
337 (if (and uniquify-trailing-separator-p
338 (file-directory-p (expand-file-name base dirname))
339 (not (string-equal base "")))
340 (cond ((eq uniquify-buffer-name-style 'forward)
341 (setq base (file-name-as-directory base)))
342 ;; (setq base (concat base "/")))
343 ((eq uniquify-buffer-name-style 'reverse)
344 (setq base (concat (or uniquify-separator "\\") base)))))
346 (let ((extra-string nil)
347 (n depth))
348 (while (and (> n 0) dirname)
349 (let ((file (file-name-nondirectory dirname)))
350 (when (setq dirname (file-name-directory dirname))
351 (setq dirname (directory-file-name dirname)))
352 (setq n (1- n))
353 (push (if (zerop (length file)) ;nil or "".
354 (prog1 (or (file-remote-p dirname) "")
355 (setq dirname nil)) ;Could be `dirname' iso "".
356 file)
357 extra-string)))
358 (when (zerop n)
359 (if (and dirname extra-string
360 (equal dirname (file-name-directory dirname)))
361 ;; We're just before the root. Let's add the leading / already.
362 ;; With "/a/b"+"/c/d/b" this leads to "/a/b" and "d/b" but with
363 ;; "/a/b"+"/c/a/b" this leads to "/a/b" and "a/b".
364 (push "" extra-string))
365 (setq uniquify-possibly-resolvable t))
367 (cond
368 ((null extra-string) base)
369 ((string-equal base "") ;Happens for dired buffers on the root directory.
370 (mapconcat 'identity extra-string "/"))
371 ((eq uniquify-buffer-name-style 'reverse)
372 (mapconcat 'identity
373 (cons base (nreverse extra-string))
374 (or uniquify-separator "\\")))
375 ((eq uniquify-buffer-name-style 'forward)
376 (mapconcat 'identity (nconc extra-string (list base))
377 "/"))
378 ((eq uniquify-buffer-name-style 'post-forward)
379 (concat base (or uniquify-separator "|")
380 (mapconcat 'identity extra-string "/")))
381 ((eq uniquify-buffer-name-style 'post-forward-angle-brackets)
382 (concat base "<" (mapconcat 'identity extra-string "/")
383 ">"))
384 (t (error "Bad value for uniquify-buffer-name-style: %s"
385 uniquify-buffer-name-style)))))
388 ;; Deal with conflicting-sublist, all of whose elements have identical
389 ;; "base" components.
390 (defun uniquify-rationalize-conflicting-sublist (conf-list old-name depth)
391 (when conf-list
392 (if (or (cdr conf-list)
393 ;; Check that the proposed name doesn't conflict with some
394 ;; existing buffer.
395 (let ((buf (get-buffer old-name)))
396 (and buf (not (eq buf (uniquify-item-buffer (car conf-list)))))))
397 (when uniquify-possibly-resolvable
398 (setq uniquify-possibly-resolvable nil
399 depth (1+ depth))
400 (dolist (item conf-list)
401 (setf (uniquify-item-proposed item)
402 (uniquify-get-proposed-name
403 (uniquify-item-base item)
404 (uniquify-item-dirname item)
405 depth)))
406 (uniquify-rationalize-a-list conf-list depth))
407 (unless (string= old-name "")
408 (uniquify-rename-buffer (car conf-list) old-name)))))
411 (defun uniquify-rename-buffer (item newname)
412 (let ((buffer (uniquify-item-buffer item)))
413 (unless (equal newname (buffer-name buffer))
414 (with-current-buffer buffer
415 (let ((uniquify-buffer-name-style nil)) ;Avoid hooks on rename-buffer.
416 ;; Pass the `unique' arg, so the advice doesn't mark it as unmanaged.
417 (rename-buffer newname t))))))
419 ;;; Hooks from the rest of Emacs
421 (defun uniquify-maybe-rerationalize-w/o-cb ()
422 "Re-rationalize buffer names, ignoring current buffer."
423 (and (cdr uniquify-managed)
424 uniquify-buffer-name-style
425 (uniquify-rerationalize-w/o-cb uniquify-managed)))
427 ;; Buffer deletion
428 ;; Rerationalize after a buffer is killed, to reduce coinciding buffer names.
429 ;; This mechanism uses `kill-buffer-hook', which runs *before* deletion, so
430 ;; it calls `uniquify-rerationalize-w/o-cb' to rerationalize the buffer list
431 ;; ignoring the current buffer (which is going to be deleted anyway).
432 (defun uniquify-kill-buffer-function ()
433 "Re-rationalize buffer names, ignoring current buffer.
434 For use on `kill-buffer-hook'."
435 (and uniquify-after-kill-buffer-p
436 (uniquify-maybe-rerationalize-w/o-cb)))
438 ;; Ideally we'd like to add it buffer-locally, but that doesn't work
439 ;; because kill-buffer-hook is not permanent-local :-(
440 ;; FIXME kill-buffer-hook _is_ permanent-local in 22+.
441 (add-hook 'kill-buffer-hook 'uniquify-kill-buffer-function)
443 ;; The logical place to put all this code is in generate-new-buffer-name.
444 ;; It's written in C, so we would add a generate-new-buffer-name-function
445 ;; which, if non-nil, would be called instead of the C. One problem with
446 ;; that is that generate-new-buffer-name takes a potential buffer name as
447 ;; its argument -- not other information, such as what file the buffer will
448 ;; visit.
450 ;; The below solution works because generate-new-buffer-name is called
451 ;; only by rename-buffer (which, as of 19.29, is never called from C) and
452 ;; generate-new-buffer, which is called only by Lisp functions
453 ;; create-file-buffer and rename-uniquely. Rename-uniquely generally
454 ;; isn't used for buffers visiting files, so it's sufficient to hook
455 ;; rename-buffer and create-file-buffer. (Setting find-file-hook isn't
456 ;; sufficient.)
458 (advice-add 'rename-buffer :around #'uniquify--rename-buffer-advice)
459 (defun uniquify--rename-buffer-advice (rb-fun newname &optional unique &rest args)
460 "Uniquify buffer names with parts of directory name."
461 (let ((retval (apply rb-fun newname unique args)))
462 (uniquify-maybe-rerationalize-w/o-cb)
463 (if (null unique)
464 ;; Mark this buffer so it won't be renamed by uniquify.
465 (setq uniquify-managed nil)
466 (when uniquify-buffer-name-style
467 ;; Rerationalize w.r.t the new name.
468 (uniquify-rationalize-file-buffer-names
469 newname
470 (uniquify-buffer-file-name (current-buffer))
471 (current-buffer))
472 (setq retval (buffer-name (current-buffer)))))
473 retval))
476 (advice-add 'create-file-buffer :around #'uniquify--create-file-buffer-advice)
477 (defun uniquify--create-file-buffer-advice (cfb-fun filename &rest args)
478 "Uniquify buffer names with parts of directory name."
479 (let ((retval (apply cfb-fun filename args)))
480 (if uniquify-buffer-name-style
481 (let ((filename (expand-file-name (directory-file-name filename))))
482 (uniquify-rationalize-file-buffer-names
483 (file-name-nondirectory filename)
484 (file-name-directory filename) retval)))
485 retval))
487 ;;; The End
489 (defun uniquify-unload-function ()
490 "Unload the uniquify library."
491 (save-current-buffer
492 (let ((buffers nil))
493 (dolist (buf (buffer-list))
494 (set-buffer buf)
495 (when uniquify-managed
496 (push (cons buf (uniquify-item-base (car uniquify-managed))) buffers)))
497 (advice-remove 'rename-buffer #'uniquify--rename-buffer-advice)
498 (advice-remove 'create-file-buffer #'uniquify--create-file-buffer-advice)
499 (dolist (buf buffers)
500 (set-buffer (car buf))
501 (rename-buffer (cdr buf) t))))
502 ;; continue standard unloading
503 nil)
505 (provide 'uniquify)
507 ;;; uniquify.el ends here