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