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