code.delx.au - gnu-emacs/blob - lisp/uniquify.el

   1 ;;; uniquify.el --- unique buffer names dependent on file name
   2
   3 ;; Copyright (c) 1989, 1995, 1996, 1997, 2001 Free Software Foundation, Inc.
   4
   5 ;; Author: Dick King <king@reasoning.com>
   6 ;; Maintainer: FSF
   7 ;; Keywords: files
   8 ;; Created: 15 May 86
   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
  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.
  26
  27 ;;; Commentary:
  28
  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.
  37
  38 ;; To use this file, do (require 'uniquify)
  39 ;; and set uniquify-buffer-name-style to one of its non-nil alternative values.
  40
  41 ;; For other options, see "User-visible variables", below.
  42
  43 ;; A version of uniquify.el that works under Emacs 18, Emacs 19, XEmacs,
  44 ;; and InfoDock is available from the maintainer.
  45
  46 ;;; Change Log:
  47
  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
  75
  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>.
  83
  84
  85 ;;; Code:
  86
  87 (eval-when-compile (require 'cl))
  88
  89 ;;; User-visible variables
  90
  91 (defgroup uniquify nil
  92   "Unique buffer names dependent on file name"
  93   :group 'applications)
  94
  95
  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
 113   :group 'uniquify)
 114
 115 (defcustom uniquify-after-kill-buffer-p nil
 116   "*If non-nil, rerationalize buffer names after a buffer has been killed.
 117 This can be dangerous if Emacs Lisp code is keeping track of buffers by their
 118 names (rather than keeping pointers to the buffers themselves)."
 119   :type 'boolean
 120   :group 'uniquify)
 121
 122 (defcustom uniquify-ask-about-buffer-names-p nil
 123   "*If non-nil, permit user to choose names for buffers with same base file.
 124 If the user chooses to name a buffer, uniquification is preempted and no
 125 other buffer names are changed."
 126   :type 'boolean
 127   :group 'uniquify)
 128
 129 ;; The default value matches certain Gnus buffers.
 130 (defcustom uniquify-ignore-buffers-re "^\\*\\(un\\)?sent "
 131   "*Regular expression matching buffer names that should not be uniquified.
 132 For instance, set this to \"^draft-[0-9]+$\" to avoid having uniquify rename
 133 draft buffers even if `uniquify-after-kill-buffer-p' is non-nil and the
 134 visited file name isn't the same as that of the buffer."
 135   :type '(choice (const :tag "Uniquify all buffers" nil) regexp)
 136   :group 'uniquify)
 137
 138 (defcustom uniquify-min-dir-content 0
 139   "*Minimum number of directory name components included in buffer name."
 140   :type 'integer
 141   :group 'uniquify)
 142
 143 (defcustom uniquify-separator nil
 144   "*String separator for buffer name components.
 145 When `uniquify-buffer-name-style' is `post-forward', separates
 146 base file name from directory part in buffer names (default \"|\").
 147 When `uniquify-buffer-name-style' is `reverse', separates all
 148 file name components (default \"\\\")."
 149   :type '(choice (const nil) string)
 150   :group 'uniquify)
 151
 152 (defcustom uniquify-trailing-separator-p nil
 153   "*If non-nil, add a file name separator to dired buffer names.
 154 If `uniquify-buffer-name-style' is `forward', add the separator at the end;
 155 if it is `reverse', add the separator at the beginning; otherwise, this
 156 variable is ignored."
 157   :type 'boolean
 158   :group 'uniquify)
 159
 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.")
 164
 165 ;;; Utilities
 166
 167 ;; For directories, return the last component, not the empty string.
 168 (defun uniquify-file-name-nondirectory (file-name)
 169   (file-name-nondirectory (directory-file-name file-name)))
 170
 171 ;; uniquify-fix-list data structure
 172 (defstruct (uniquify-item
 173             (:constructor nil) (:copier nil)
 174             (:constructor uniquify-make-item (base filename buffer proposed)))
 175   base filename buffer proposed)
 176
 177 ;; Internal variables used free
 178 (defvar uniquify-possibly-resolvable nil)
 179
 180 ;;; Main entry point.
 181
 182 (defun uniquify-rationalize-file-buffer-names (&optional newbuffile newbuf)
 183   "Make file buffer names unique by adding segments from file name.
 184 If `uniquify-min-dir-content' > 0, always pulls that many
 185 file name elements.
 186 Arguments NEWBUFFILE and NEWBUF cause only a subset of buffers to be renamed."
 187   (interactive)
 188   (let (fix-list
 189         (newbuffile-nd (and newbuffile
 190                             (uniquify-file-name-nondirectory newbuffile))))
 191     (dolist (buffer (buffer-list))
 192       (let ((bufname (buffer-name buffer))
 193             bfn rawname proposed)
 194         (if (and (not (and uniquify-ignore-buffers-re
 195                            (string-match uniquify-ignore-buffers-re
 196                                          bufname)))
 197                  (setq bfn (if (eq buffer newbuf)
 198                                (when newbuffile
 199                                  (expand-file-name
 200                                   (directory-file-name newbuffile)))
 201                              (uniquify-buffer-file-name buffer)))
 202                  (setq rawname (uniquify-file-name-nondirectory bfn))
 203                  (or (not newbuffile)
 204                      (equal rawname newbuffile-nd))
 205                  (setq proposed (uniquify-get-proposed-name rawname bfn)))
 206             (push (uniquify-make-item rawname bfn buffer proposed) fix-list))))
 207     ;; selects buffers whose names may need changing, and others that
 208     ;; may conflict, then bring conflicting names together
 209     (uniquify-rationalize-a-list fix-list)))
 210
 211 ;; uniquify's version of buffer-file-name; result never contains trailing slash
 212 (defun uniquify-buffer-file-name (buffer)
 213   "Return name of file BUFFER is visiting, or nil if none.
 214 Works on ordinary file-visiting buffers and buffers whose mode is mentioned
 215 in `uniquify-list-buffers-directory-modes', otherwise returns nil."
 216   (or (buffer-file-name buffer)
 217       (with-current-buffer buffer
 218         (and
 219          (memq major-mode uniquify-list-buffers-directory-modes)
 220          (if (boundp 'list-buffers-directory) ; XEmacs mightn't define this
 221              (and list-buffers-directory
 222                   (directory-file-name list-buffers-directory))
 223            ;; don't use default-directory if dired-directory is nil
 224            (and dired-directory
 225                 (expand-file-name
 226                  (directory-file-name
 227                   (if (consp dired-directory)
 228                       (car dired-directory)
 229                     dired-directory)))))))))
 230
 231 (defun uniquify-item-greaterp (item1 item2)
 232   (string-lessp (uniquify-item-proposed item2)
 233                 (uniquify-item-proposed item1)))
 234
 235 (defun uniquify-rationalize-a-list (fix-list &optional depth)
 236   (unless depth (setq depth uniquify-min-dir-content))
 237   (let (conflicting-sublist     ; all elements have the same proposed name
 238         (old-proposed "")
 239         proposed)
 240     ;; Divide fix-list into items with same proposed names and pass them
 241     ;; to uniquify-rationalize-conflicting-sublist.
 242     (dolist (item (sort fix-list 'uniquify-item-greaterp))
 243       (setq proposed (uniquify-item-proposed item))
 244       (unless (equal proposed old-proposed)
 245         (uniquify-rationalize-conflicting-sublist conflicting-sublist
 246                                                   old-proposed depth)
 247         (setq conflicting-sublist nil))
 248       (push item conflicting-sublist)
 249       (setq old-proposed proposed))
 250     (uniquify-rationalize-conflicting-sublist conflicting-sublist
 251                                               old-proposed depth)))
 252
 253 (defun uniquify-get-proposed-name (base filename &optional depth)
 254   (unless depth (setq depth uniquify-min-dir-content))
 255   (assert (equal base (uniquify-file-name-nondirectory filename)))
 256   (assert (equal (directory-file-name filename) filename))
 257
 258   ;; Distinguish directories by adding extra separator.
 259   (if (and uniquify-trailing-separator-p
 260            (file-directory-p filename)
 261            (not (string-equal base "")))
 262       (cond ((eq uniquify-buffer-name-style 'forward)
 263              (setq base (file-name-as-directory base)))
 264             ;; (setq base (concat base "/")))
 265             ((eq uniquify-buffer-name-style 'reverse)
 266              (setq base (concat (or uniquify-separator "\\") base)))))
 267
 268   (let ((extra-string nil)
 269         (n depth))
 270     (while (and (> n 0) filename
 271                 (setq filename (file-name-directory filename))
 272                 (setq filename (directory-file-name filename)))
 273       (let ((file (file-name-nondirectory filename)))
 274         (setq n (1- n))
 275         (push (if (zerop (length file)) ;nil or "".
 276                   (prog1 "" (setq filename nil)) ;Could be `filename' iso "".
 277                 file)
 278               extra-string)))
 279     (when (zerop n)
 280       (if (and filename extra-string
 281                (setq filename (file-name-directory filename))
 282                (equal filename
 283                       (file-name-directory (directory-file-name filename))))
 284           ;; We're just before the root.  Let's add the leading / already.
 285           ;; With "/a/b"+"/c/d/b" this leads to "/a/b" and "d/b" but with
 286           ;; "/a/b"+"/c/a/b" this leads to "/a/b" and "a/b".
 287           (push "" extra-string))
 288       (setq uniquify-possibly-resolvable t))
 289
 290     (cond
 291      ((null extra-string) base)
 292      ((string-equal base "") ;Happens for dired buffers on the root directory.
 293       (mapconcat 'identity extra-string "/"))
 294      ((eq uniquify-buffer-name-style 'reverse)
 295       (mapconcat 'identity
 296                  (cons base (nreverse extra-string))
 297                  (or uniquify-separator "\\")))
 298      ((eq uniquify-buffer-name-style 'forward)
 299       (mapconcat 'identity (nconc extra-string (list base))
 300                  "/"))
 301      ((eq uniquify-buffer-name-style 'post-forward)
 302       (concat base (or uniquify-separator "|")
 303               (mapconcat 'identity extra-string "/")))
 304      ((eq uniquify-buffer-name-style 'post-forward-angle-brackets)
 305       (concat base "<" (mapconcat 'identity extra-string "/")
 306               ">"))
 307      (t (error "Bad value for uniquify-buffer-name-style: %s"
 308                uniquify-buffer-name-style)))))
 309
 310
 311 ;; Deal with conflicting-sublist, all of whose elements have identical
 312 ;; "base" components.
 313 (defun uniquify-rationalize-conflicting-sublist (conf-list old-name depth)
 314   (when conf-list
 315     (if (or (cdr conf-list)
 316             ;; Check that the proposed name doesn't conflict with some
 317             ;; existing buffer.
 318             (let ((buf (get-buffer old-name)))
 319               (and buf (not (eq buf (uniquify-item-buffer (car conf-list)))))))
 320         (when uniquify-possibly-resolvable
 321           (setq uniquify-possibly-resolvable nil
 322                 depth (1+ depth))
 323           (dolist (item conf-list)
 324             (setf (uniquify-item-proposed item)
 325                   (uniquify-get-proposed-name
 326                    (uniquify-item-base item)
 327                    (uniquify-item-filename item)
 328                    depth)))
 329           (uniquify-rationalize-a-list conf-list depth))
 330       (unless (string= old-name "")
 331         (uniquify-rename-buffer (car conf-list) old-name)))))
 332
 333
 334 (defun uniquify-rename-buffer (item newname)
 335   (let ((buffer (uniquify-item-buffer item)))
 336     (unless (equal newname (buffer-name buffer))
 337       (with-current-buffer buffer
 338         (let ((uniquify-buffer-name-style nil)) ;Avoid hooks on rename-buffer.
 339           ;; Pass the `unique' arg, just in case.
 340           (rename-buffer newname t))))))
 341
 342 ;;; Hooks from the rest of Emacs
 343
 344 ;; The logical place to put all this code is in generate-new-buffer-name.
 345 ;; It's written in C, so we would add a generate-new-buffer-name-function
 346 ;; which, if non-nil, would be called instead of the C.  One problem with
 347 ;; that is that generate-new-buffer-name takes a potential buffer name as
 348 ;; its argument -- not other information, such as what file the buffer will
 349 ;; visit.
 350
 351 ;; The below solution works because generate-new-buffer-name is called
 352 ;; only by rename-buffer (which, as of 19.29, is never called from C) and
 353 ;; generate-new-buffer, which is called only by Lisp functions
 354 ;; create-file-buffer and rename-uniquely.  Rename-uniquely generally
 355 ;; isn't used for buffers visiting files, so it's sufficient to hook
 356 ;; rename-buffer and create-file-buffer.  (Setting find-file-hook isn't
 357 ;; sufficient.)
 358
 359 (defadvice rename-buffer (after rename-buffer-uniquify activate)
 360   "Uniquify buffer names with parts of directory name."
 361   (if (and uniquify-buffer-name-style
 362            ;; UNIQUE argument
 363            (ad-get-arg 1))
 364       (progn
 365         (if uniquify-after-kill-buffer-p
 366             ;; call with no argument; rationalize vs. old name as well as new
 367             (uniquify-rationalize-file-buffer-names)
 368           ;; call with argument: rationalize vs. new name only
 369           (uniquify-rationalize-file-buffer-names
 370            (uniquify-buffer-file-name (current-buffer)) (current-buffer)))
 371         (setq ad-return-value (buffer-name (current-buffer))))))
 372
 373 (defadvice create-file-buffer (after create-file-buffer-uniquify activate)
 374   "Uniquify buffer names with parts of directory name."
 375   (if uniquify-buffer-name-style
 376       (uniquify-rationalize-file-buffer-names (ad-get-arg 0) ad-return-value)))
 377
 378 ;; Buffer deletion
 379 ;; Rerationalize after a buffer is killed, to reduce coinciding buffer names.
 380 ;; This mechanism uses `kill-buffer-hook', which runs *before* deletion.
 381 ;; That means that the kill-buffer-hook function cannot just delete the
 382 ;; buffer -- it has to set something to do the rationalization *later*.
 383 ;; It actually puts another function on `post-command-hook'.  This other
 384 ;; function runs the rationalization and then removes itself from the hook.
 385 ;; Is there a better way to accomplish this?
 386 ;; (This ought to set some global variables so the work is done only for
 387 ;; buffers with names similar to the deleted buffer.  -MDE)
 388
 389 (defun uniquify-delay-rationalize-file-buffer-names ()
 390   "Add `delayed-uniquify-rationalize-file-buffer-names' to `post-command-hook'.
 391 For use on, eg, `kill-buffer-hook', to rationalize *after* buffer deletion."
 392   (if (and uniquify-buffer-name-style
 393            uniquify-after-kill-buffer-p
 394            ;; Rationalizing is costly, so don't do it for temp buffers.
 395            (uniquify-buffer-file-name (current-buffer)))
 396       (add-hook 'post-command-hook
 397                 'uniquify-delayed-rationalize-file-buffer-names)))
 398
 399 (defun uniquify-delayed-rationalize-file-buffer-names ()
 400   "Rerationalize buffer names and remove self from `post-command-hook'.
 401 See also `delay-rationalize-file-buffer-names' for hook setter."
 402   (uniquify-rationalize-file-buffer-names)
 403   (remove-hook 'post-command-hook
 404                'uniquify-delayed-rationalize-file-buffer-names))
 405
 406 ;; Ideally we'd like to add it buffer-locally, but that doesn't work
 407 ;; because kill-buffer-hook is not permanent-local :-(
 408 (add-hook 'kill-buffer-hook 'uniquify-delay-rationalize-file-buffer-names)
 409
 410 (provide 'uniquify)
 411 ;;; uniquify.el ends here