Commit | Line | Data |
---|---|---|
5246db4e | 1 | ;;; uniquify.el --- unique buffer names dependent on file name |
4c61f92c | 2 | |
bc2e0aae | 3 | ;; Copyright (c) 1989, 1995, 1996, 1997 Free Software Foundation, Inc. |
4c61f92c KH |
4 | |
5 | ;; Author: Dick King <king@reasoning.com> | |
6 | ;; Maintainer: Michael Ernst <mernst@theory.lcs.mit.edu> | |
7 | ;; Created: 15 May 86 | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
13 | ;; the Free Software Foundation; either version 2, or (at your option) | |
14 | ;; any later version. | |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
4c61f92c KH |
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 | |
5246db4e | 31 | ;; uniquification that adds parts of the file name until the buffer names |
4c61f92c KH |
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 | ||
4219b27b RS |
37 | ;; To use this file, do (require 'uniquify) |
38 | ;; and set uniquify-buffer-name-style to one of its non-nil alternative values. | |
39 | ||
4c61f92c KH |
40 | ;; For other options, see "User-visible variables", below. |
41 | ||
d7993a1c RS |
42 | ;; A version of uniquify.el that works under Emacs 18, Emacs 19, XEmacs, |
43 | ;; and InfoDock is available from the maintainer. | |
4c61f92c | 44 | |
bc2e0aae KH |
45 | ;; Doesn't correctly handle buffer names created by M-x write-file in Emacs 18. |
46 | ;; Doesn't work under NT when backslash is used as a path separator (forward | |
47 | ;; slash path separator works fine). To fix, check system-type against | |
48 | ;; 'windows-nt, write a routine that breaks paths down into components. | |
49 | ;; (Surprisingly, there isn't one built in.) | |
50 | ||
4c61f92c KH |
51 | ;;; Change Log: |
52 | ||
53 | ;; Originally by Dick King <king@reasoning.com> 15 May 86 | |
54 | ;; Converted for Emacs 18 by Stephen Gildea <gildea@lcs.mit.edu> | |
55 | ;; Make uniquify-min-dir-content 0 truly non-invasive. gildea 23 May 89 | |
56 | ;; Some cleanup. uniquify-min-dir-content default 0. gildea 01 Jun 89 | |
57 | ;; Don't rename to "". Michael Ernst <mernst@theory.lcs.mit.edu> 15 Jun 94 | |
58 | ;; Add kill-buffer-hook. Kenneth Manheimer <ken.manheimer@nist.gov> 09 May 95 | |
59 | ;; Add advice for rename-buffer and create-file-buffer, handle dired buffers, | |
60 | ;; kill-buffer-rationalize-buffer-names-p, documentation. mernst 24 May 95 | |
61 | ;; Remove free variables, fix typos. mernst 5 Jun 95 | |
62 | ;; Efficiently support Emacs 19.27 & earlier. ken.manheimer, mernst 10 Jun 95 | |
63 | ;; Rename user options to "uniquify-...", add uniquify-reverse-dir-content-p, | |
64 | ;; add uniquify-ask-about-buffer-names-p. king, mernst 13 Jun 95 | |
65 | ;; Prefix functions by "uniquify-..."; rename mnemonic-buffer-names to | |
66 | ;; uniquify-buffer-name-style; add 'forward and 'post-forward-angle-brackets | |
67 | ;; styles; remove uniquify-reverse-dir-content-p; add | |
68 | ;; uniquify-trailing-separator-p. mernst 4 Aug 95 | |
bc2e0aae KH |
69 | ;; Don't call expand-file-name on nil. mernst 7 Jan 96 |
70 | ;; Check whether list-buffers-directory is bound. mernst 11 Oct 96 | |
71 | ;; Ignore non-file non-dired buffers. Colin Rafferty <craffert@ml.com> 3 Mar 97 | |
4c61f92c KH |
72 | |
73 | ;; Valuable feedback was provided by | |
74 | ;; Paul Smith <psmith@baynetworks.com>, | |
75 | ;; Alastair Burt <burt@dfki.uni-kl.de>, | |
76 | ;; Bob Weiner <weiner@footloose.sps.mot.com>, | |
77 | ;; Albert L. Ting <alt@vlibs.com>, | |
bc2e0aae KH |
78 | ;; gyro@reasoning.com, |
79 | ;; Bryan O'Sullivan <bos@eng.sun.com>. | |
4c61f92c KH |
80 | |
81 | ||
82 | ;;; Code: | |
83 | ||
84 | (provide 'uniquify) | |
85 | ||
86 | ;;; User-visible variables | |
87 | ||
c5292bc8 RS |
88 | (defgroup uniquify nil |
89 | "Unique buffer names dependent on file name" | |
90 | :group 'applications) | |
91 | ||
92 | ||
4219b27b | 93 | (defcustom uniquify-buffer-name-style nil |
4c61f92c | 94 | "*If non-nil, buffer names are uniquified with parts of directory name. |
5246db4e KH |
95 | The value determines the buffer name style and is one of `forward', |
96 | `reverse', `post-forward' (the default), or `post-forward-angle-brackets'. | |
97 | For example, files `/foo/bar/mumble/name' and `/baz/quux/mumble/name' | |
98 | would have the following buffer names in the various styles: | |
4c61f92c KH |
99 | forward bar/mumble/name quux/mumble/name |
100 | reverse name\\mumble\\bar name\\mumble\\quux | |
101 | post-forward name|bar/mumble name|quux/mumble | |
102 | post-forward-angle-brackets name<bar/mumble> name<quux/mumble> | |
c5292bc8 RS |
103 | nil name name<2>" |
104 | :type '(radio (const forward) | |
105 | (const reverse) | |
106 | (const post-forward) | |
107 | (const podt-forward-angle-brackets) | |
4219b27b | 108 | (const :tag "standard Emacs behavior (nil)" nil)) |
c5292bc8 RS |
109 | :group 'uniquify) |
110 | ||
111 | (defcustom uniquify-after-kill-buffer-p nil | |
4c61f92c KH |
112 | "*If non-nil, rerationalize buffer names after a buffer has been killed. |
113 | This can be dangerous if Emacs Lisp code is keeping track of buffers by their | |
c5292bc8 RS |
114 | names (rather than keeping pointers to the buffers themselves)." |
115 | :type 'boolean | |
116 | :group 'uniquify) | |
4c61f92c | 117 | |
c5292bc8 | 118 | (defcustom uniquify-ask-about-buffer-names-p nil |
4c61f92c KH |
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 | |
c5292bc8 RS |
121 | other buffer names are changed." |
122 | :type 'boolean | |
123 | :group 'uniquify) | |
4c61f92c | 124 | |
c5292bc8 RS |
125 | (defcustom uniquify-min-dir-content 0 |
126 | "*Minimum parts of directory name included in buffer name." | |
127 | :type 'integer | |
128 | :group 'uniquify) | |
4c61f92c | 129 | |
c5292bc8 | 130 | (defcustom uniquify-separator nil |
4c61f92c | 131 | "*String separator for buffer name components. |
5246db4e | 132 | When `uniquify-buffer-name-style' is `post-forward', separates |
4c61f92c | 133 | base file name from directory part in buffer names (default \"|\"). |
5246db4e | 134 | When `uniquify-buffer-name-style' is `reverse', separates all |
c5292bc8 RS |
135 | file name components (default \"\\\")." |
136 | :type '(choice (const nil) string) | |
137 | :group 'uniquify) | |
4c61f92c | 138 | |
c5292bc8 | 139 | (defcustom uniquify-trailing-separator-p nil |
5246db4e KH |
140 | "*If non-nil, add a file name separator to dired buffer names. |
141 | If `uniquify-buffer-name-style' is `forward', add the separator at the end; | |
142 | if it is `reverse', add the separator at the beginning; otherwise, this | |
c5292bc8 RS |
143 | variable is ignored." |
144 | :type 'boolean | |
145 | :group 'uniquify) | |
4c61f92c KH |
146 | |
147 | ||
148 | ;;; Utilities | |
149 | ||
150 | (defmacro uniquify-push (item list) | |
151 | (` (setq (, list) (cons (, item) (, list))))) | |
152 | ||
153 | (defmacro uniquify-fix-list-base (a) | |
154 | (` (car (, a)))) | |
155 | ||
156 | (defmacro uniquify-fix-list-filename (a) | |
157 | (` (car (cdr (, a))))) | |
158 | ||
159 | (defmacro uniquify-fix-list-buffer (a) | |
160 | (` (car (cdr (cdr (, a)))))) | |
161 | ||
162 | (defmacro uniquify-cadddr (a) | |
163 | (` (car (cdr (cdr (cdr (, a))))))) | |
164 | ||
165 | ;; Internal variables used free | |
166 | (defvar uniquify-non-file-buffer-names nil) | |
167 | (defvar uniquify-possibly-resolvable nil) | |
168 | ||
169 | ;;; Main entry point. | |
170 | ||
171 | (defun uniquify-rationalize-file-buffer-names (&optional newbuffile newbuf) | |
5246db4e | 172 | "Makes file buffer names unique by adding segments from file name. |
4c61f92c | 173 | If `uniquify-min-dir-content' > 0, always pulls that many |
5246db4e | 174 | file name elements. Arguments cause only a subset of buffers to be renamed." |
4c61f92c KH |
175 | (interactive) |
176 | (let (fix-list | |
177 | uniquify-non-file-buffer-names | |
178 | (depth uniquify-min-dir-content)) | |
179 | (let ((buffers (buffer-list))) | |
180 | (while buffers | |
181 | (let* ((buffer (car buffers)) | |
182 | (bfn (if (eq buffer newbuf) | |
04f3a656 KH |
183 | (and newbuffile |
184 | (expand-file-name newbuffile)) | |
4c61f92c KH |
185 | (uniquify-buffer-file-name buffer))) |
186 | (rawname (and bfn (file-name-nondirectory bfn))) | |
187 | (deserving (and rawname | |
188 | (or (not newbuffile) | |
189 | (equal rawname | |
190 | (file-name-nondirectory newbuffile)))))) | |
191 | (if deserving | |
192 | (uniquify-push (list rawname bfn buffer nil) fix-list) | |
193 | (uniquify-push (list (buffer-name buffer)) | |
194 | uniquify-non-file-buffer-names))) | |
195 | (setq buffers (cdr buffers)))) | |
196 | ;; selects buffers whose names may need changing, and others that | |
197 | ;; may conflict. | |
198 | (setq fix-list | |
d7993a1c | 199 | (sort fix-list 'uniquify-fix-list-filename-lessp)) |
4c61f92c KH |
200 | ;; bringing conflicting names together |
201 | (uniquify-rationalize-a-list fix-list depth) | |
202 | (mapcar 'uniquify-unrationalized-buffer fix-list))) | |
203 | ||
d7993a1c | 204 | ;; uniquify's version of buffer-file-name |
4c61f92c KH |
205 | (defun uniquify-buffer-file-name (buffer) |
206 | "Return name of file BUFFER is visiting, or nil if none. | |
bc2e0aae KH |
207 | Works on dired buffers as well as ordinary file-visiting buffers, |
208 | but no others." | |
4c61f92c | 209 | (or (buffer-file-name buffer) |
bc2e0aae | 210 | (and (featurep 'dired) |
4c61f92c KH |
211 | (save-excursion |
212 | (set-buffer buffer) | |
8a2d9406 RS |
213 | (when (eq major-mode 'dired-mode) ; do nothing if not a dired buffer |
214 | (if (boundp 'list-buffers-directory) ; XEmacs mightn't define this | |
215 | list-buffers-directory | |
216 | ;; don't use default-directory if dired-directory is nil | |
217 | (and dired-directory | |
218 | (expand-file-name | |
219 | (directory-file-name | |
220 | (if (consp dired-directory) | |
221 | (car dired-directory) | |
222 | dired-directory)))))))))) | |
4c61f92c | 223 | |
d7993a1c | 224 | (defun uniquify-fix-list-filename-lessp (fixlist1 fixlist2) |
4c61f92c | 225 | (uniquify-filename-lessp |
8a2d9406 RS |
226 | (uniquify-fix-list-filename fixlist1 |
227 | ) (uniquify-fix-list-filename fixlist2))) | |
4c61f92c | 228 | |
d7993a1c | 229 | ;; This examines the filename components in reverse order. |
4c61f92c KH |
230 | (defun uniquify-filename-lessp (s1 s2) |
231 | (let ((s1f (file-name-nondirectory s1)) | |
232 | (s2f (file-name-nondirectory s2))) | |
233 | (and (not (equal s2f "")) | |
234 | (or (string-lessp s1f s2f) | |
235 | (and (equal s1f s2f) | |
236 | (let ((s1d (file-name-directory s1)) | |
237 | (s2d (file-name-directory s2))) | |
238 | (and (not (<= (length s2d) 1)) | |
239 | (or (<= (length s1d) 1) | |
240 | (uniquify-filename-lessp | |
241 | (substring s1d 0 -1) | |
242 | (substring s2d 0 -1)))))))))) | |
243 | ||
244 | ;; Was named do-the-buffers-you-couldnt-rationalize | |
245 | (defun uniquify-unrationalized-buffer (item) | |
246 | (or (uniquify-cadddr item) nil)) ;maybe better in the future | |
247 | ||
248 | (defun uniquify-rationalize-a-list (fix-list depth) | |
249 | (let (conflicting-sublist | |
250 | (old-name "") | |
251 | proposed-name uniquify-possibly-resolvable) | |
252 | (while fix-list | |
253 | (let ((item (car fix-list))) | |
254 | (setq proposed-name (uniquify-get-proposed-name item depth)) | |
255 | (if (not (equal proposed-name old-name)) | |
256 | (progn | |
257 | (uniquify-rationalize-conflicting-sublist | |
258 | conflicting-sublist old-name depth) | |
259 | (setq conflicting-sublist nil))) | |
260 | (uniquify-push item conflicting-sublist) | |
261 | (setq old-name proposed-name)) | |
262 | (setq fix-list (cdr fix-list))) | |
263 | (uniquify-rationalize-conflicting-sublist | |
264 | conflicting-sublist old-name depth))) | |
265 | ||
266 | (defun uniquify-get-proposed-name (item depth) | |
267 | (let (index | |
268 | (extra-string "") | |
269 | (n depth) | |
270 | (base (uniquify-fix-list-base item)) | |
271 | (fn (uniquify-fix-list-filename item))) | |
272 | (while (and (> n 0) | |
273 | (setq index (string-match | |
274 | (concat "\\(^\\|/[^/]*\\)/" | |
275 | (regexp-quote extra-string) | |
276 | (regexp-quote base) | |
277 | "\\'") | |
278 | fn))) | |
279 | (setq extra-string (substring fn | |
280 | (if (zerop index) 0 (1+ index)) | |
281 | ;; (- (length base)) fails for base = "". | |
282 | ;; Equivalently, we could have used | |
283 | ;; (apply 'substring ... | |
284 | ;; (and (not (string= "" base)) | |
285 | ;; (list (- (length base))))) | |
286 | (- (length fn) (length base))) | |
287 | n (1- n))) | |
288 | (if (zerop n) (setq uniquify-possibly-resolvable t)) | |
289 | ||
290 | ||
291 | ;; Distinguish directories by adding extra separator. | |
292 | (if (and uniquify-trailing-separator-p | |
293 | (file-directory-p fn) | |
294 | (not (string-equal base ""))) | |
295 | (cond ((eq uniquify-buffer-name-style 'forward) | |
296 | (setq base (concat base "/"))) | |
297 | ((eq uniquify-buffer-name-style 'reverse) | |
298 | (setq base (concat (or uniquify-separator "\\") base))))) | |
299 | ||
300 | ;; Trim trailing separator on directory part | |
301 | (if (and (not (string-equal extra-string "")) | |
302 | (or (eq uniquify-buffer-name-style 'post-forward) | |
303 | (eq uniquify-buffer-name-style 'post-forward-angle-brackets))) | |
304 | (setq extra-string (substring extra-string 0 | |
305 | (- (length extra-string) 1)))) | |
306 | ||
307 | (cond ((string-equal extra-string "") | |
308 | base) | |
309 | ((string-equal base "") | |
310 | extra-string) | |
311 | ((eq uniquify-buffer-name-style 'forward) | |
312 | (concat extra-string base)) | |
313 | ((eq uniquify-buffer-name-style 'reverse) | |
314 | (concat base (uniquify-reverse-components extra-string))) | |
315 | ((eq uniquify-buffer-name-style 'post-forward) | |
316 | (concat base (or uniquify-separator "|") extra-string)) | |
317 | ((eq uniquify-buffer-name-style 'post-forward-angle-brackets) | |
318 | (concat base "<" extra-string ">")) | |
319 | (t (error "Bad value for uniquify-buffer-name-style: %s" | |
320 | uniquify-buffer-name-style))))) | |
321 | ||
322 | ||
323 | ;; Deal with conflicting-sublist, which is set by uniquify-rationalize-a-list. | |
324 | ;; This is only called by uniquify-rationalize-a-list. | |
325 | (defun uniquify-rationalize-conflicting-sublist (conflicting-sublist old-name depth) | |
326 | (or (null conflicting-sublist) | |
327 | (and (null (cdr conflicting-sublist)) | |
328 | (not (assoc old-name uniquify-non-file-buffer-names)) | |
329 | (or (and (not (string= old-name "")) | |
330 | (uniquify-rename-buffer (car conflicting-sublist) old-name)) | |
331 | t)) | |
332 | (if uniquify-possibly-resolvable | |
333 | (uniquify-rationalize-a-list conflicting-sublist (1+ depth))))) | |
334 | ||
335 | (defun uniquify-rename-buffer (item newname) | |
336 | (let ((buffer (uniquify-fix-list-buffer item))) | |
337 | (if (not (equal newname (buffer-name buffer))) | |
338 | (let ((unset (current-buffer)) | |
339 | ;; avoid hooks on rename-buffer | |
340 | (uniquify-buffer-name-style nil)) | |
341 | (set-buffer buffer) | |
342 | (rename-buffer newname) | |
343 | (set-buffer unset)))) | |
344 | (rplaca (nthcdr 3 item) t)) | |
345 | ||
346 | (defun uniquify-reverse-components (instring) | |
347 | (let ((sofar '()) | |
348 | (cursor 0) | |
349 | (len (length instring)) | |
350 | (sep (or uniquify-separator "\\"))) | |
351 | (while (< cursor len) | |
352 | (if (= (aref instring cursor) ?/) | |
353 | (setq sofar (cons sep sofar) | |
354 | cursor (1+ cursor)) | |
355 | (let ((first-slash (or (string-match "/" instring cursor) len))) | |
356 | (setq sofar (cons (substring instring cursor first-slash) sofar) | |
357 | cursor first-slash)))) | |
358 | (apply (function concat) sofar))) | |
359 | ||
360 | ||
361 | ;;; Hooks from the rest of Emacs | |
362 | ||
5246db4e | 363 | ;; Emacs 19 (Emacs or XEmacs) |
4c61f92c KH |
364 | |
365 | ;; The logical place to put all this code is in generate-new-buffer-name. | |
366 | ;; It's written in C, so we would add a generate-new-buffer-name-function | |
367 | ;; which, if non-nil, would be called instead of the C. One problem with | |
368 | ;; that is that generate-new-buffer-name takes a potential buffer name as | |
369 | ;; its argument -- not other information, such as what file the buffer will | |
370 | ;; visit. | |
371 | ||
372 | ;; The below solution works because generate-new-buffer-name is called | |
373 | ;; only by rename-buffer (which, as of 19.29, is never called from C) and | |
374 | ;; generate-new-buffer, which is called only by Lisp functions | |
375 | ;; create-file-buffer and rename-uniquely. Rename-uniquely generally | |
376 | ;; isn't used for buffers visiting files, so it's sufficient to hook | |
377 | ;; rename-buffer and create-file-buffer. (Setting find-file-hooks isn't | |
378 | ;; sufficient.) | |
379 | ||
380 | (defadvice rename-buffer (after rename-buffer-uniquify activate) | |
381 | "Uniquify buffer names with parts of directory name." | |
382 | (if (and uniquify-buffer-name-style | |
383 | ;; UNIQUE argument | |
384 | (ad-get-arg 1)) | |
385 | (progn | |
386 | (if uniquify-after-kill-buffer-p | |
387 | ;; call with no argument; rationalize vs. old name as well as new | |
388 | (uniquify-rationalize-file-buffer-names) | |
389 | ;; call with argument: rationalize vs. new name only | |
390 | (uniquify-rationalize-file-buffer-names | |
391 | (uniquify-buffer-file-name (current-buffer)) (current-buffer))) | |
392 | (setq ad-return-value (buffer-name (current-buffer)))))) | |
393 | ||
394 | (defadvice create-file-buffer (after create-file-buffer-uniquify activate) | |
395 | "Uniquify buffer names with parts of directory name." | |
396 | (if uniquify-buffer-name-style | |
397 | (uniquify-rationalize-file-buffer-names (ad-get-arg 0) ad-return-value))) | |
398 | ||
399 | ;; Buffer deletion | |
400 | ;; Rerationalize after a buffer is killed, to reduce coinciding buffer names. | |
401 | ;; This mechanism uses `kill-buffer-hook', which runs *before* deletion. | |
402 | ;; That means that the kill-buffer-hook function cannot just delete the | |
403 | ;; buffer -- it has to set something to do the rationalization *later*. | |
404 | ;; It actually puts another function on `post-command-hook'. This other | |
405 | ;; function runs the rationalization and then removes itself from the hook. | |
406 | ;; Is there a better way to accomplish this? | |
407 | ;; (This ought to set some global variables so the work is done only for | |
408 | ;; buffers with names similar to the deleted buffer. -MDE) | |
409 | ||
410 | (defun delay-uniquify-rationalize-file-buffer-names () | |
411 | "Add `delayed-uniquify-rationalize-file-buffer-names' to `post-command-hook'. | |
412 | For use on, eg, `kill-buffer-hook', to rationalize *after* buffer deletion." | |
413 | (if (and uniquify-buffer-name-style | |
414 | uniquify-after-kill-buffer-p) | |
415 | (add-hook 'post-command-hook | |
4219b27b RS |
416 | 'delayed-uniquify-rationalize-file-buffer-names) |
417 | (remove-hook 'kill-buffer-hook | |
418 | 'delay-uniquify-rationalize-file-buffer-names))) | |
4c61f92c KH |
419 | |
420 | (defun delayed-uniquify-rationalize-file-buffer-names () | |
421 | "Rerationalize buffer names and remove self from `post-command-hook'. | |
422 | See also `delay-rationalize-file-buffer-names' for hook setter." | |
423 | (uniquify-rationalize-file-buffer-names) | |
424 | (remove-hook 'post-command-hook | |
425 | 'delayed-uniquify-rationalize-file-buffer-names)) | |
426 | ||
427 | (add-hook 'kill-buffer-hook 'delay-uniquify-rationalize-file-buffer-names) | |
428 | ||
429 | ;;; uniquify.el ends here |