1 ;;; uniquify.el --- unique buffer names dependent on file name
3 ;; Copyright (C) 1989, 1995, 1996, 1997, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Dick King <king@reasoning.com>
11 ;; This file is part of GNU Emacs.
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, or (at your option)
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.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; Emacs's standard method for making buffer names unique adds <2>, <3>,
31 ;; etc. to the end of (all but one of) the buffers. This file replaces
32 ;; that behavior, for buffers visiting files and dired buffers, with a
33 ;; uniquification that adds parts of the file name until the buffer names
34 ;; are unique. For instance, buffers visiting /u/mernst/tmp/Makefile and
35 ;; /usr/projects/zaphod/Makefile would be named Makefile|tmp and
36 ;; Makefile|zaphod, respectively (instead of Makefile and Makefile<2>).
37 ;; Other buffer name styles are also available.
39 ;; To use this file, do (require 'uniquify)
40 ;; and set uniquify-buffer-name-style to one of its non-nil alternative values.
42 ;; For other options, see "User-visible variables", below.
44 ;; A version of uniquify.el that works under Emacs 18, Emacs 19, XEmacs,
45 ;; and InfoDock is available from the maintainer.
49 ;; Originally by Dick King <king@reasoning.com> 15 May 86
50 ;; Converted for Emacs 18 by Stephen Gildea <gildea@stop.mail-abuse.org>
51 ;; Make uniquify-min-dir-content 0 truly non-invasive. gildea 23 May 89
52 ;; Some cleanup. uniquify-min-dir-content default 0. gildea 01 Jun 89
53 ;; Don't rename to "". Michael Ernst <mernst@theory.lcs.mit.edu> 15 Jun 94
54 ;; Add kill-buffer-hook. Kenneth Manheimer <ken.manheimer@nist.gov> 09 May 95
55 ;; Add advice for rename-buffer and create-file-buffer, handle dired buffers,
56 ;; kill-buffer-rationalize-buffer-names-p, documentation. mernst 24 May 95
57 ;; Remove free variables, fix typos. mernst 5 Jun 95
58 ;; Efficiently support Emacs 19.27 & earlier. ken.manheimer, mernst 10 Jun 95
59 ;; Rename user options to "uniquify-...", add uniquify-reverse-dir-content-p,
60 ;; add uniquify-ask-about-buffer-names-p. king, mernst 13 Jun 95
61 ;; Prefix functions by "uniquify-..."; rename mnemonic-buffer-names to
62 ;; uniquify-buffer-name-style; add 'forward and 'post-forward-angle-brackets
63 ;; styles; remove uniquify-reverse-dir-content-p; add
64 ;; uniquify-trailing-separator-p. mernst 4 Aug 95
65 ;; Don't call expand-file-name on nil. mernst 7 Jan 96
66 ;; Check whether list-buffers-directory is bound. mernst 11 Oct 96
67 ;; Ignore non-file non-dired buffers. Colin Rafferty <craffert@ml.com> 3 Mar 97
68 ;; Use last component, not "", for file name of directories. mernst 27 Jun 97
69 ;; Use directory-file-name; code cleanup. mernst 6 Sep 97
70 ;; Add uniquify-ignore-buffers-re.
71 ;; Andre Srinivasan <andre@visigenic.com> 9 Sep 97
72 ;; Add uniquify-list-buffers-directory-modes
73 ;; Stefan Monnier <monnier@cs.yale.edu> 17 Nov 2000
74 ;; Algorithm and data structure changed to reduce consing with lots of buffers
75 ;; Francesco Potortì <pot@gnu.org> (ideas by rms and monnier) 2001-07-18
77 ;; Valuable feedback was provided by
78 ;; Paul Smith <psmith@baynetworks.com>,
79 ;; Alastair Burt <burt@dfki.uni-kl.de>,
80 ;; Bob Weiner <weiner@footloose.sps.mot.com>,
81 ;; Albert L. Ting <alt@vlibs.com>,
82 ;; gyro@reasoning.com,
83 ;; Bryan O'Sullivan <bos@eng.sun.com>.
88 (eval-when-compile (require 'cl
))
90 ;;; User-visible variables
92 (defgroup uniquify nil
93 "Unique buffer names dependent on file name."
97 (defcustom uniquify-buffer-name-style nil
98 "If non-nil, buffer names are uniquified with parts of directory name.
99 The value determines the buffer name style and is one of `forward',
100 `reverse', `post-forward', or `post-forward-angle-brackets'.
101 For example, files `/foo/bar/mumble/name' and `/baz/quux/mumble/name'
102 would have the following buffer names in the various styles:
103 forward bar/mumble/name quux/mumble/name
104 reverse name\\mumble\\bar name\\mumble\\quux
105 post-forward name|bar/mumble name|quux/mumble
106 post-forward-angle-brackets name<bar/mumble> name<quux/mumble>
108 Of course, the \"mumble\" part may be stripped as well, depending on the setting
109 of `uniquify-strip-common-suffix'."
110 :type
'(radio (const forward
)
113 (const post-forward-angle-brackets
)
114 (const :tag
"standard Emacs behavior (nil)" nil
))
118 (defcustom uniquify-after-kill-buffer-p t
119 "If non-nil, rerationalize buffer names after a buffer has been killed."
123 (defcustom uniquify-ask-about-buffer-names-p nil
124 "If non-nil, permit user to choose names for buffers with same base file.
125 If the user chooses to name a buffer, uniquification is preempted and no
126 other buffer names are changed."
130 ;; The default value matches certain Gnus buffers.
131 (defcustom uniquify-ignore-buffers-re nil
132 "Regular expression matching buffer names that should not be uniquified.
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."
136 :type
'(choice (const :tag
"Uniquify all buffers" nil
) regexp
)
139 (defcustom uniquify-min-dir-content
0
140 "Minimum number of directory name components included in buffer name."
144 (defcustom uniquify-separator nil
145 "String separator for buffer name components.
146 When `uniquify-buffer-name-style' is `post-forward', separates
147 base file name from directory part in buffer names (default \"|\").
148 When `uniquify-buffer-name-style' is `reverse', separates all
149 file name components (default \"\\\")."
150 :type
'(choice (const nil
) string
)
153 (defcustom uniquify-trailing-separator-p nil
154 "If non-nil, add a file name separator to dired buffer names.
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
157 variable is ignored."
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."
171 (defvar uniquify-list-buffers-directory-modes
'(dired-mode cvs-mode
)
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.")
178 ;; uniquify-fix-list data structure
179 (defstruct (uniquify-item
180 (:constructor nil
) (:copier nil
)
181 (:constructor uniquify-make-item
182 (base dirname buffer
&optional proposed
)))
183 base dirname buffer proposed
)
185 ;; Internal variables used free
186 (defvar uniquify-possibly-resolvable nil
)
188 (defvar uniquify-managed nil
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.")
191 (make-variable-buffer-local 'uniquify-managed
)
192 (put 'uniquify-managed
'permanent-local t
)
194 ;; Used in desktop.el to save the non-uniquified buffer name
195 (defun uniquify-buffer-base-name ()
196 "Return the base name of the current buffer.
197 Return nil if the buffer is not managed by uniquify,
198 or if the base name is empty."
199 (and uniquify-managed
200 (let ((base (uniquify-item-base (car uniquify-managed
))))
201 (if (string= base
"") nil base
))))
203 ;;; Main entry point.
205 (defun uniquify-rationalize-file-buffer-names (base dirname newbuf
)
206 "Make file buffer names unique by adding segments from file name.
207 If `uniquify-min-dir-content' > 0, always pulls that many
209 Arguments BASE, DIRNAME, and NEWBUF specify the new buffer that causes
210 this rationalization."
212 (list (if uniquify-managed
213 (uniquify-item-base (car uniquify-managed
)) (buffer-name))
214 (uniquify-buffer-file-name (current-buffer))
216 ;; Make sure we don't get confused by outdated uniquify-managed info in
218 (with-current-buffer newbuf
(setq uniquify-managed nil
))
220 (setq dirname
(expand-file-name (directory-file-name dirname
)))
221 (let ((fix-list (list (uniquify-make-item base dirname newbuf
)))
223 (dolist (buffer (buffer-list))
224 (when (and (not (and uniquify-ignore-buffers-re
225 (string-match uniquify-ignore-buffers-re
226 (buffer-name buffer
))))
227 ;; Only try to rename buffers we actually manage.
228 (setq items
(buffer-local-value 'uniquify-managed buffer
))
229 (equal base
(uniquify-item-base (car items
)))
230 ;; Don't re-add stuff we already have. Actually this
231 ;; whole `and' test should only match at most once.
232 (not (memq (car items
) fix-list
)))
234 ;; If there was no conflict, the buffer-name is equal to the
235 ;; base-name and we may have missed a rename-buffer because
236 ;; of code like in set-visited-file-name:
237 ;; (or (string= new-name (buffer-name)) (rename-buffer new-name t))
238 ;; So we need to refresh the dirname of the uniquify-item.
239 (setf (uniquify-item-dirname (car items
))
240 (uniquify-buffer-file-name
241 (uniquify-item-buffer (car items
))))
242 ;; This shouldn't happen, but maybe there's no dirname any more.
243 (unless (uniquify-item-dirname (car items
))
244 (with-current-buffer (uniquify-item-buffer (car items
))
245 (setq uniquify-managed nil
))
247 ;; In case we missed some calls to kill-buffer, there may be dead
248 ;; buffers in uniquify-managed, so filter them out.
252 (if (buffer-live-p (uniquify-item-buffer item
))
255 (setq fix-list
(append fix-list items
))))
256 ;; selects buffers whose names may need changing, and others that
257 ;; may conflict, then bring conflicting names together
258 (uniquify-rationalize fix-list
))))
260 ;; uniquify's version of buffer-file-name; result never contains trailing slash
261 (defun uniquify-buffer-file-name (buffer)
262 "Return name of directory, file BUFFER is visiting, or nil if none.
263 Works on ordinary file-visiting buffers and buffers whose mode is mentioned
264 in `uniquify-list-buffers-directory-modes', otherwise returns nil."
265 (with-current-buffer buffer
268 (if (memq major-mode uniquify-list-buffers-directory-modes
)
269 list-buffers-directory
))))
274 (directory-file-name filename
))))))))
276 (defun uniquify-rerationalize-w/o-cb
(fix-list)
277 "Re-rationalize the buffers in FIX-LIST, but ignoring `current-buffer'."
278 (let ((new-fix-list nil
))
279 (dolist (item fix-list
)
280 (let ((buf (uniquify-item-buffer item
)))
281 (unless (or (eq buf
(current-buffer)) (not (buffer-live-p buf
)))
282 (push item new-fix-list
))))
284 (uniquify-rationalize new-fix-list
))))
286 (defun uniquify-rationalize (fix-list)
287 ;; Set up uniquify to re-rationalize after killing/renaming
288 ;; if there is a conflict.
289 (dolist (item fix-list
)
290 (with-current-buffer (uniquify-item-buffer item
)
291 ;; Refresh the dirnames and proposed names.
292 (setf (uniquify-item-proposed item
)
293 (uniquify-get-proposed-name (uniquify-item-base item
)
294 (uniquify-item-dirname item
)))
295 (setq uniquify-managed fix-list
)))
296 ;; Strip any shared last directory names of the dirname.
297 (when (and (cdr fix-list
) uniquify-strip-common-suffix
)
299 (while (let* ((base (file-name-nondirectory
300 (uniquify-item-dirname (car fix-list
))))
302 (when (> (length base
) 0)
303 (while (and strip items
)
304 (unless (equal base
(file-name-nondirectory
305 (uniquify-item-dirname (pop items
))))
308 ;; It's all the same => strip.
309 (dolist (item (prog1 fix-list
(setq fix-list nil
)))
310 ;; Create new items because the old ones are kept (with the true
311 ;; `dirname') for later rerationalizing.
312 (push (uniquify-make-item (uniquify-item-base item
)
313 (let ((f (file-name-directory
314 (uniquify-item-dirname item
))))
315 (and f
(directory-file-name f
)))
316 (uniquify-item-buffer item
)
317 (uniquify-item-proposed item
))
319 ;; If uniquify-min-dir-content is 0, this will end up just
320 ;; passing fix-list to uniquify-rationalize-conflicting-sublist.
321 (uniquify-rationalize-a-list fix-list
))
323 (defun uniquify-item-greaterp (item1 item2
)
324 (string-lessp (uniquify-item-proposed item2
)
325 (uniquify-item-proposed item1
)))
327 (defun uniquify-rationalize-a-list (fix-list &optional depth
)
328 (unless depth
(setq depth uniquify-min-dir-content
))
329 (let (conflicting-sublist ; all elements have the same proposed name
332 ;; Divide fix-list into items with same proposed names and pass them
333 ;; to uniquify-rationalize-conflicting-sublist.
334 (dolist (item (sort fix-list
'uniquify-item-greaterp
))
335 (setq proposed
(uniquify-item-proposed item
))
336 (unless (equal proposed old-proposed
)
337 (uniquify-rationalize-conflicting-sublist conflicting-sublist
339 (setq conflicting-sublist nil
))
340 (push item conflicting-sublist
)
341 (setq old-proposed proposed
))
342 (uniquify-rationalize-conflicting-sublist conflicting-sublist
343 old-proposed depth
)))
345 (defun uniquify-get-proposed-name (base dirname
&optional depth
)
346 (unless depth
(setq depth uniquify-min-dir-content
))
347 (assert (equal (directory-file-name dirname
) dirname
)) ;No trailing slash.
349 ;; Distinguish directories by adding extra separator.
350 (if (and uniquify-trailing-separator-p
351 (file-directory-p (expand-file-name base dirname
))
352 (not (string-equal base
"")))
353 (cond ((eq uniquify-buffer-name-style
'forward
)
354 (setq base
(file-name-as-directory base
)))
355 ;; (setq base (concat base "/")))
356 ((eq uniquify-buffer-name-style
'reverse
)
357 (setq base
(concat (or uniquify-separator
"\\") base
)))))
359 (let ((extra-string nil
)
361 (while (and (> n
0) dirname
)
362 (let ((file (file-name-nondirectory dirname
)))
363 (when (setq dirname
(file-name-directory dirname
))
364 (setq dirname
(directory-file-name dirname
)))
366 (push (if (zerop (length file
)) ;nil or "".
367 (prog1 "" (setq dirname nil
)) ;Could be `dirname' iso "".
371 (if (and dirname extra-string
372 (equal dirname
(file-name-directory dirname
)))
373 ;; We're just before the root. Let's add the leading / already.
374 ;; With "/a/b"+"/c/d/b" this leads to "/a/b" and "d/b" but with
375 ;; "/a/b"+"/c/a/b" this leads to "/a/b" and "a/b".
376 (push "" extra-string
))
377 (setq uniquify-possibly-resolvable t
))
380 ((null extra-string
) base
)
381 ((string-equal base
"") ;Happens for dired buffers on the root directory.
382 (mapconcat 'identity extra-string
"/"))
383 ((eq uniquify-buffer-name-style
'reverse
)
385 (cons base
(nreverse extra-string
))
386 (or uniquify-separator
"\\")))
387 ((eq uniquify-buffer-name-style
'forward
)
388 (mapconcat 'identity
(nconc extra-string
(list base
))
390 ((eq uniquify-buffer-name-style
'post-forward
)
391 (concat base
(or uniquify-separator
"|")
392 (mapconcat 'identity extra-string
"/")))
393 ((eq uniquify-buffer-name-style
'post-forward-angle-brackets
)
394 (concat base
"<" (mapconcat 'identity extra-string
"/")
396 (t (error "Bad value for uniquify-buffer-name-style: %s"
397 uniquify-buffer-name-style
)))))
400 ;; Deal with conflicting-sublist, all of whose elements have identical
401 ;; "base" components.
402 (defun uniquify-rationalize-conflicting-sublist (conf-list old-name depth
)
404 (if (or (cdr conf-list
)
405 ;; Check that the proposed name doesn't conflict with some
407 (let ((buf (get-buffer old-name
)))
408 (and buf
(not (eq buf
(uniquify-item-buffer (car conf-list
)))))))
409 (when uniquify-possibly-resolvable
410 (setq uniquify-possibly-resolvable nil
412 (dolist (item conf-list
)
413 (setf (uniquify-item-proposed item
)
414 (uniquify-get-proposed-name
415 (uniquify-item-base item
)
416 (uniquify-item-dirname item
)
418 (uniquify-rationalize-a-list conf-list depth
))
419 (unless (string= old-name
"")
420 (uniquify-rename-buffer (car conf-list
) old-name
)))))
423 (defun uniquify-rename-buffer (item newname
)
424 (let ((buffer (uniquify-item-buffer item
)))
425 (unless (equal newname
(buffer-name buffer
))
426 (with-current-buffer buffer
427 (let ((uniquify-buffer-name-style nil
)) ;Avoid hooks on rename-buffer.
428 ;; Pass the `unique' arg, so the advice doesn't mark it as unmanaged.
429 (rename-buffer newname t
))))))
431 ;;; Hooks from the rest of Emacs
434 ;; Rerationalize after a buffer is killed, to reduce coinciding buffer names.
435 ;; This mechanism uses `kill-buffer-hook', which runs *before* deletion, so
436 ;; it calls `uniquify-rerationalize-w/o-cb' to rerationalize the buffer list
437 ;; ignoring the current buffer (which is going to be deleted anyway).
438 (defun uniquify-maybe-rerationalize-w/o-cb
()
439 "Re-rationalize buffer names, ignoring current buffer.
440 For use on `kill-buffer-hook'."
441 (if (and (cdr uniquify-managed
)
442 uniquify-buffer-name-style
443 uniquify-after-kill-buffer-p
)
444 (uniquify-rerationalize-w/o-cb uniquify-managed
)))
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 (add-hook 'kill-buffer-hook
'uniquify-maybe-rerationalize-w
/o-cb
)
450 ;; The logical place to put all this code is in generate-new-buffer-name.
451 ;; It's written in C, so we would add a generate-new-buffer-name-function
452 ;; which, if non-nil, would be called instead of the C. One problem with
453 ;; that is that generate-new-buffer-name takes a potential buffer name as
454 ;; its argument -- not other information, such as what file the buffer will
457 ;; The below solution works because generate-new-buffer-name is called
458 ;; only by rename-buffer (which, as of 19.29, is never called from C) and
459 ;; generate-new-buffer, which is called only by Lisp functions
460 ;; create-file-buffer and rename-uniquely. Rename-uniquely generally
461 ;; isn't used for buffers visiting files, so it's sufficient to hook
462 ;; rename-buffer and create-file-buffer. (Setting find-file-hook isn't
465 (defadvice rename-buffer
(after rename-buffer-uniquify activate
)
466 "Uniquify buffer names with parts of directory name."
467 (uniquify-maybe-rerationalize-w/o-cb
)
468 (if (null (ad-get-arg 1)) ; no UNIQUE argument.
469 ;; Mark this buffer so it won't be renamed by uniquify.
470 (setq uniquify-managed nil
)
471 (when uniquify-buffer-name-style
472 ;; Rerationalize w.r.t the new name.
473 (uniquify-rationalize-file-buffer-names
475 (uniquify-buffer-file-name (current-buffer))
477 (setq ad-return-value
(buffer-name (current-buffer))))))
479 (defadvice create-file-buffer
(after create-file-buffer-uniquify activate
)
480 "Uniquify buffer names with parts of directory name."
481 (if uniquify-buffer-name-style
482 (let ((filename (expand-file-name (directory-file-name (ad-get-arg 0)))))
483 (uniquify-rationalize-file-buffer-names
484 (file-name-nondirectory filename
)
485 (file-name-directory filename
) ad-return-value
))))
489 (defun uniquify-unload-function ()
490 "Unload the uniquify library."
493 (dolist (buf (buffer-list))
495 (when uniquify-managed
496 (push (cons buf
(uniquify-item-base (car uniquify-managed
))) buffers
)))
497 (dolist (fun '(rename-buffer create-file-buffer
))
498 (ad-remove-advice fun
'after
(intern (concat (symbol-name fun
) "-uniquify")))
500 (dolist (buf buffers
)
501 (set-buffer (car buf
))
502 (rename-buffer (cdr buf
) t
))))
503 ;; continue standard unloading
508 ;; arch-tag: e763faa3-56c9-4903-8eb8-26e1c45a0065
509 ;;; uniquify.el ends here