*** empty log message ***
[emacs.git] / lisp / uniquify.el
blobf106297476c678d18ac900e425d414c41bfd97fa
1 ;;; uniquify.el --- unique buffer names dependent on file name
3 ;; Copyright (c) 1989,95,96,97,2001,2003 Free Software Foundation, Inc.
5 ;; Author: Dick King <king@reasoning.com>
6 ;; Maintainer: FSF
7 ;; Keywords: files
8 ;; Created: 15 May 86
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; Emacs's standard 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))
89 ;;; User-visible variables
91 (defgroup uniquify nil
92 "Unique buffer names dependent on file name"
93 :group 'applications)
96 (defcustom uniquify-buffer-name-style nil
97 "*If non-nil, buffer names are uniquified with parts of directory name.
98 The value determines the buffer name style and is one of `forward',
99 `reverse', `post-forward', or `post-forward-angle-brackets'.
100 For example, files `/foo/bar/mumble/name' and `/baz/quux/mumble/name'
101 would have the following buffer names in the various styles:
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>
106 nil name name<2>"
107 :type '(radio (const forward)
108 (const reverse)
109 (const post-forward)
110 (const post-forward-angle-brackets)
111 (const :tag "standard Emacs behavior (nil)" nil))
112 :require 'uniquify)
114 (defcustom uniquify-after-kill-buffer-p t
115 "If non-nil, rerationalize buffer names after a buffer has been killed."
116 :type 'boolean)
118 (defcustom uniquify-ask-about-buffer-names-p nil
119 "*If non-nil, permit user to choose names for buffers with same base file.
120 If the user chooses to name a buffer, uniquification is preempted and no
121 other buffer names are changed."
122 :type 'boolean)
124 ;; The default value matches certain Gnus buffers.
125 (defcustom uniquify-ignore-buffers-re nil
126 "*Regular expression matching buffer names that should not be uniquified.
127 For instance, set this to \"^draft-[0-9]+$\" to avoid having uniquify rename
128 draft buffers even if `uniquify-after-kill-buffer-p' is non-nil and the
129 visited file name isn't the same as that of the buffer."
130 :type '(choice (const :tag "Uniquify all buffers" nil) regexp))
132 (defcustom uniquify-min-dir-content 0
133 "*Minimum number of directory name components included in buffer name."
134 :type 'integer)
136 (defcustom uniquify-separator nil
137 "*String separator for buffer name components.
138 When `uniquify-buffer-name-style' is `post-forward', separates
139 base file name from directory part in buffer names (default \"|\").
140 When `uniquify-buffer-name-style' is `reverse', separates all
141 file name components (default \"\\\")."
142 :type '(choice (const nil) string))
144 (defcustom uniquify-trailing-separator-p nil
145 "*If non-nil, add a file name separator to dired buffer names.
146 If `uniquify-buffer-name-style' is `forward', add the separator at the end;
147 if it is `reverse', add the separator at the beginning; otherwise, this
148 variable is ignored."
149 :type 'boolean)
151 (defcustom uniquify-strip-common-suffix
152 ;; Using it when uniquify-min-dir-content>0 doesn't make much sense.
153 (eq 0 uniquify-min-dir-content)
154 "If non-nil, strip common directory suffixes of conflicting files.
155 E.g. if you open /a1/b/c/d and /a2/b/c/d, the buffer names will say
156 \"d|a1\" and \"d|a2\" instead of \"d|a1/b/c\" and \"d|a2/b/c\".
157 This can be handy when you have deep parallel hierarchies."
158 :type 'boolean)
160 (defvar uniquify-list-buffers-directory-modes '(dired-mode cvs-mode)
161 "List of modes for which uniquify should obey `list-buffers-directory'.
162 That means that when `buffer-file-name' is set to nil, `list-buffers-directory'
163 contains the name of the directory which the buffer is visiting.")
165 ;;; Utilities
167 ;; uniquify-fix-list data structure
168 (defstruct (uniquify-item
169 (:constructor nil) (:copier nil)
170 (:constructor uniquify-make-item
171 (base dirname buffer &optional proposed)))
172 base dirname buffer proposed)
174 ;; Internal variables used free
175 (defvar uniquify-possibly-resolvable nil)
177 (defvar uniquify-managed nil
178 "Non-nil if the name of this buffer is managed by uniquify.
179 It actually holds the list of `uniquify-item's corresponding to the conflict.")
180 (make-variable-buffer-local 'uniquify-managed)
181 (put 'uniquify-managed 'permanent-local t)
183 ;;; Main entry point.
185 (defun uniquify-rationalize-file-buffer-names (base dirname newbuf)
186 "Make file buffer names unique by adding segments from file name.
187 If `uniquify-min-dir-content' > 0, always pulls that many
188 file name elements.
189 Arguments BASE, DIRNAME, and NEWBUF specify the new buffer that causes
190 this rationaliztion."
191 (interactive)
192 (if (null dirname)
193 (with-current-buffer newbuf (setq uniquify-managed nil))
194 (setq dirname (expand-file-name (directory-file-name dirname)))
195 (let ((fix-list (list (uniquify-make-item base dirname newbuf)))
196 items)
197 (dolist (buffer (buffer-list))
198 (when (and (not (and uniquify-ignore-buffers-re
199 (string-match uniquify-ignore-buffers-re
200 (buffer-name buffer))))
201 ;; Only try to rename buffers we actually manage.
202 (setq items (buffer-local-value 'uniquify-managed buffer))
203 (equal base (uniquify-item-base (car items)))
204 ;; Don't re-add stuff we already have. Actually this
205 ;; whole `and' test should only match at most once.
206 (not (memq (car items) fix-list)))
207 (unless (cdr items)
208 ;; If there was no conflict, the buffer-name is equal to the
209 ;; base-name and we may have missed a rename-buffer because
210 ;; of code like in set-visited-file-name:
211 ;; (or (string= new-name (buffer-name)) (rename-buffer new-name t))
212 ;; So we need to refresh the dirname of the uniquify-item.
213 (setf (uniquify-item-dirname (car items))
214 (uniquify-buffer-file-name
215 (uniquify-item-buffer (car items))))
216 ;; This shouldn't happen, but maybe there's no dirname any more.
217 (unless (uniquify-item-dirname (car items))
218 (with-current-buffer (uniquify-item-buffer (car items))
219 (setq uniquify-managed nil))
220 (setq items nil)))
221 (setq fix-list (append fix-list items))))
222 ;; selects buffers whose names may need changing, and others that
223 ;; may conflict, then bring conflicting names together
224 (uniquify-rationalize fix-list))))
226 ;; uniquify's version of buffer-file-name; result never contains trailing slash
227 (defun uniquify-buffer-file-name (buffer)
228 "Return name of directory, file BUFFER is visiting, or nil if none.
229 Works on ordinary file-visiting buffers and buffers whose mode is mentioned
230 in `uniquify-list-buffers-directory-modes', otherwise returns nil."
231 (with-current-buffer buffer
232 (let ((filename
233 (or buffer-file-name
234 (if (memq major-mode uniquify-list-buffers-directory-modes)
235 list-buffers-directory))))
236 (when filename
237 (directory-file-name
238 (file-name-directory
239 (expand-file-name
240 (directory-file-name filename))))))))
242 (defun uniquify-rerationalize-w/o-cb (fix-list)
243 "Re-rationalize the buffers in FIX-LIST, but ignoring current-buffer."
244 (let ((new-fix-list nil))
245 (dolist (item fix-list)
246 (let ((buf (uniquify-item-buffer item)))
247 (unless (or (eq buf (current-buffer)) (not (buffer-live-p buf)))
248 (push item new-fix-list))))
249 (when new-fix-list
250 (uniquify-rationalize new-fix-list))))
252 (defun uniquify-rationalize (fix-list)
253 ;; Set up uniquify to re-rationalize after killing/renaming
254 ;; if there is a conflict.
255 (dolist (item fix-list)
256 (with-current-buffer (uniquify-item-buffer item)
257 ;; Refresh the dirnames and proposed names.
258 (setf (uniquify-item-proposed item)
259 (uniquify-get-proposed-name (uniquify-item-base item)
260 (uniquify-item-dirname item)))
261 (setq uniquify-managed fix-list)))
262 ;; Strip any shared last directory names of the dirname.
263 (when (and (cdr fix-list) uniquify-strip-common-suffix)
264 (let ((strip t))
265 (while (let* ((base (file-name-nondirectory
266 (uniquify-item-dirname (car fix-list))))
267 (items fix-list))
268 (when (> (length base) 0)
269 (while (and strip items)
270 (unless (equal base (file-name-nondirectory
271 (uniquify-item-dirname (pop items))))
272 (setq strip nil)))
273 strip))
274 ;; It's all the same => strip.
275 (dolist (item (prog1 fix-list (setq fix-list nil)))
276 ;; Create new items because the old ones are kept (with the true
277 ;; `dirname') for later rerationalizing.
278 (push (uniquify-make-item (uniquify-item-base item)
279 (let ((f (file-name-directory
280 (uniquify-item-dirname item))))
281 (and f (directory-file-name f)))
282 (uniquify-item-buffer item)
283 (uniquify-item-proposed item))
284 fix-list)))))
285 ;; If uniquify-min-dir-content is 0, this will end up just
286 ;; passing fix-list to uniquify-rationalize-conflicting-sublist.
287 (uniquify-rationalize-a-list fix-list))
289 (defun uniquify-item-greaterp (item1 item2)
290 (string-lessp (uniquify-item-proposed item2)
291 (uniquify-item-proposed item1)))
293 (defun uniquify-rationalize-a-list (fix-list &optional depth)
294 (unless depth (setq depth uniquify-min-dir-content))
295 (let (conflicting-sublist ; all elements have the same proposed name
296 (old-proposed "")
297 proposed)
298 ;; Divide fix-list into items with same proposed names and pass them
299 ;; to uniquify-rationalize-conflicting-sublist.
300 (dolist (item (sort fix-list 'uniquify-item-greaterp))
301 (setq proposed (uniquify-item-proposed item))
302 (unless (equal proposed old-proposed)
303 (uniquify-rationalize-conflicting-sublist conflicting-sublist
304 old-proposed depth)
305 (setq conflicting-sublist nil))
306 (push item conflicting-sublist)
307 (setq old-proposed proposed))
308 (uniquify-rationalize-conflicting-sublist conflicting-sublist
309 old-proposed depth)))
311 (defun uniquify-get-proposed-name (base dirname &optional depth)
312 (unless depth (setq depth uniquify-min-dir-content))
313 (assert (equal (directory-file-name dirname) dirname)) ;No trailing slash.
315 ;; Distinguish directories by adding extra separator.
316 (if (and uniquify-trailing-separator-p
317 (file-directory-p (expand-file-name base dirname))
318 (not (string-equal base "")))
319 (cond ((eq uniquify-buffer-name-style 'forward)
320 (setq base (file-name-as-directory base)))
321 ;; (setq base (concat base "/")))
322 ((eq uniquify-buffer-name-style 'reverse)
323 (setq base (concat (or uniquify-separator "\\") base)))))
325 (let ((extra-string nil)
326 (n depth))
327 (while (and (> n 0) dirname)
328 (let ((file (file-name-nondirectory dirname)))
329 (when (setq dirname (file-name-directory dirname))
330 (setq dirname (directory-file-name dirname)))
331 (setq n (1- n))
332 (push (if (zerop (length file)) ;nil or "".
333 (prog1 "" (setq dirname nil)) ;Could be `dirname' iso "".
334 file)
335 extra-string)))
336 (when (zerop n)
337 (if (and dirname extra-string
338 (equal dirname (file-name-directory dirname)))
339 ;; We're just before the root. Let's add the leading / already.
340 ;; With "/a/b"+"/c/d/b" this leads to "/a/b" and "d/b" but with
341 ;; "/a/b"+"/c/a/b" this leads to "/a/b" and "a/b".
342 (push "" extra-string))
343 (setq uniquify-possibly-resolvable t))
345 (cond
346 ((null extra-string) base)
347 ((string-equal base "") ;Happens for dired buffers on the root directory.
348 (mapconcat 'identity extra-string "/"))
349 ((eq uniquify-buffer-name-style 'reverse)
350 (mapconcat 'identity
351 (cons base (nreverse extra-string))
352 (or uniquify-separator "\\")))
353 ((eq uniquify-buffer-name-style 'forward)
354 (mapconcat 'identity (nconc extra-string (list base))
355 "/"))
356 ((eq uniquify-buffer-name-style 'post-forward)
357 (concat base (or uniquify-separator "|")
358 (mapconcat 'identity extra-string "/")))
359 ((eq uniquify-buffer-name-style 'post-forward-angle-brackets)
360 (concat base "<" (mapconcat 'identity extra-string "/")
361 ">"))
362 (t (error "Bad value for uniquify-buffer-name-style: %s"
363 uniquify-buffer-name-style)))))
366 ;; Deal with conflicting-sublist, all of whose elements have identical
367 ;; "base" components.
368 (defun uniquify-rationalize-conflicting-sublist (conf-list old-name depth)
369 (when conf-list
370 (if (or (cdr conf-list)
371 ;; Check that the proposed name doesn't conflict with some
372 ;; existing buffer.
373 (let ((buf (get-buffer old-name)))
374 (and buf (not (eq buf (uniquify-item-buffer (car conf-list)))))))
375 (when uniquify-possibly-resolvable
376 (setq uniquify-possibly-resolvable nil
377 depth (1+ depth))
378 (dolist (item conf-list)
379 (setf (uniquify-item-proposed item)
380 (uniquify-get-proposed-name
381 (uniquify-item-base item)
382 (uniquify-item-dirname item)
383 depth)))
384 (uniquify-rationalize-a-list conf-list depth))
385 (unless (string= old-name "")
386 (uniquify-rename-buffer (car conf-list) old-name)))))
389 (defun uniquify-rename-buffer (item newname)
390 (let ((buffer (uniquify-item-buffer item)))
391 (unless (equal newname (buffer-name buffer))
392 (with-current-buffer buffer
393 (let ((uniquify-buffer-name-style nil)) ;Avoid hooks on rename-buffer.
394 ;; Pass the `unique' arg, so the advice doesn't mark it as unmanaged.
395 (rename-buffer newname t))))))
397 ;;; Hooks from the rest of Emacs
399 ;; The logical place to put all this code is in generate-new-buffer-name.
400 ;; It's written in C, so we would add a generate-new-buffer-name-function
401 ;; which, if non-nil, would be called instead of the C. One problem with
402 ;; that is that generate-new-buffer-name takes a potential buffer name as
403 ;; its argument -- not other information, such as what file the buffer will
404 ;; visit.
406 ;; The below solution works because generate-new-buffer-name is called
407 ;; only by rename-buffer (which, as of 19.29, is never called from C) and
408 ;; generate-new-buffer, which is called only by Lisp functions
409 ;; create-file-buffer and rename-uniquely. Rename-uniquely generally
410 ;; isn't used for buffers visiting files, so it's sufficient to hook
411 ;; rename-buffer and create-file-buffer. (Setting find-file-hook isn't
412 ;; sufficient.)
414 (defadvice rename-buffer (after rename-buffer-uniquify activate)
415 "Uniquify buffer names with parts of directory name."
416 (uniquify-maybe-rerationalize-w/o-cb)
417 (if (null (ad-get-arg 1)) ; no UNIQUE argument.
418 ;; Mark this buffer so it won't be renamed by uniquify.
419 (setq uniquify-managed nil)
420 (when uniquify-buffer-name-style
421 ;; Rerationalize w.r.t the new name.
422 (uniquify-rationalize-file-buffer-names
423 (ad-get-arg 0)
424 (uniquify-buffer-file-name (current-buffer))
425 (current-buffer))
426 (setq ad-return-value (buffer-name (current-buffer))))))
428 (defadvice create-file-buffer (after create-file-buffer-uniquify activate)
429 "Uniquify buffer names with parts of directory name."
430 (if uniquify-buffer-name-style
431 (let ((filename (expand-file-name (directory-file-name (ad-get-arg 0)))))
432 (uniquify-rationalize-file-buffer-names
433 (file-name-nondirectory filename)
434 (file-name-directory filename) ad-return-value))))
436 ;; Buffer deletion
437 ;; Rerationalize after a buffer is killed, to reduce coinciding buffer names.
438 ;; This mechanism uses `kill-buffer-hook', which runs *before* deletion.
439 ;; That means that the kill-buffer-hook function cannot just delete the
440 ;; buffer -- it has to set something to do the rationalization *later*.
441 ;; It actually puts another function on `post-command-hook'. This other
442 ;; function runs the rationalization and then removes itself from the hook.
443 ;; Is there a better way to accomplish this?
444 ;; (This ought to set some global variables so the work is done only for
445 ;; buffers with names similar to the deleted buffer. -MDE)
447 (defun uniquify-maybe-rerationalize-w/o-cb ()
448 "Re-rationalize buffer names, ignoring current buffer.
449 For use on `kill-buffer-hook'."
450 (if (and (cdr uniquify-managed)
451 uniquify-buffer-name-style
452 uniquify-after-kill-buffer-p)
453 (uniquify-rerationalize-w/o-cb uniquify-managed)))
455 ;; Ideally we'd like to add it buffer-locally, but that doesn't work
456 ;; because kill-buffer-hook is not permanent-local :-(
457 (add-hook 'kill-buffer-hook 'uniquify-maybe-rerationalize-w/o-cb)
459 (provide 'uniquify)
461 ;;; arch-tag: e763faa3-56c9-4903-8eb8-26e1c45a0065
462 ;;; uniquify.el ends here