# emacs / lisp / uniquify.el

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