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