;;; uniquify.el --- unique buffer names dependent on file name
-;; Copyright (c) 1989, 1995 Free Software Foundation, Inc.
+;; Copyright (c) 1989, 1995, 1996, 1997, 2001 Free Software Foundation, Inc.
;; Author: Dick King <king@reasoning.com>
-;; Maintainer: Michael Ernst <mernst@theory.lcs.mit.edu>
+;; Maintainer: FSF
+;; Keywords: files
;; Created: 15 May 86
;; This file is part of GNU Emacs.
;; Makefile|zaphod, respectively (instead of Makefile and Makefile<2>).
;; Other buffer name styles are also available.
-;; To use this file, just load it.
-;; To disable it after loading, set variable uniquify-buffer-name-style to nil.
+;; 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,
;;; Change Log:
;; Originally by Dick King <king@reasoning.com> 15 May 86
-;; Converted for Emacs 18 by Stephen Gildea <gildea@lcs.mit.edu>
+;; Converted for Emacs 18 by Stephen Gildea <gildea@stop.mail-abuse.org>
;; 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 <mernst@theory.lcs.mit.edu> 15 Jun 94
;; 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 <craffert@ml.com> 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 <andre@visigenic.com> 9 Sep 97
+;; Add uniquify-list-buffers-directory-modes
+;; Stefan Monnier <monnier@cs.yale.edu> 17 Nov 2000
+;; Algorithm and data structure changed to reduce consing with lots of buffers
+;; Francesco Potortì <pot@gnu.org> (ideas by rms and monnier) 2001-07-18
;; Valuable feedback was provided by
;; Paul Smith <psmith@baynetworks.com>,
;; Alastair Burt <burt@dfki.uni-kl.de>,
;; Bob Weiner <weiner@footloose.sps.mot.com>,
;; Albert L. Ting <alt@vlibs.com>,
-;; gyro@reasoning.com.
+;; gyro@reasoning.com,
+;; Bryan O'Sullivan <bos@eng.sun.com>.
;;; Code:
(provide 'uniquify)
+(eval-when-compile (require 'cl))
;;; User-visible variables
-(defvar uniquify-buffer-name-style 'post-forward
+(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' (the default), or `post-forward-angle-brackets'.
+`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<bar/mumble> name<quux/mumble>
- nil name name<2>")
-
-(defvar uniquify-after-kill-buffer-p nil
+ 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).")
+names (rather than keeping pointers to the buffers themselves)."
+ :type 'boolean
+ :group 'uniquify)
-(defconst uniquify-ask-about-buffer-names-p nil
+(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.")
-
-(defvar uniquify-min-dir-content 0
- "*Minimum parts of directory name included in buffer name.")
-
-(defvar uniquify-separator nil
+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 \"\\\").")
+file name components (default \"\\\")."
+ :type '(choice (const nil) string)
+ :group 'uniquify)
-(defvar uniquify-trailing-separator-p nil
+(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.")
+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
-(defmacro uniquify-push (item list)
- (` (setq (, list) (cons (, item) (, list)))))
-
-(defmacro uniquify-fix-list-base (a)
- (` (car (, a))))
-
-(defmacro uniquify-fix-list-filename (a)
- (` (car (cdr (, a)))))
+;; 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)))
-(defmacro uniquify-fix-list-buffer (a)
- (` (car (cdr (cdr (, a))))))
-
-(defmacro uniquify-cadddr (a)
- (` (car (cdr (cdr (cdr (, a)))))))
+;; 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)
;;; Main entry point.
(defun uniquify-rationalize-file-buffer-names (&optional newbuffile newbuf)
- "Makes file buffer names unique by adding segments from file name.
+ "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."
+file name elements.
+Arguments NEWBUFFILE and NEWBUF cause only a subset of buffers to be renamed."
(interactive)
(let (fix-list
uniquify-non-file-buffer-names
- (depth uniquify-min-dir-content))
- (let ((buffers (buffer-list)))
- (while buffers
- (let* ((buffer (car buffers))
- (bfn (if (eq buffer newbuf)
- (and newbuffile
- (expand-file-name newbuffile))
- (uniquify-buffer-file-name buffer)))
- (rawname (and bfn (file-name-nondirectory bfn)))
- (deserving (and rawname
- (or (not newbuffile)
- (equal rawname
- (file-name-nondirectory newbuffile))))))
- (if deserving
- (uniquify-push (list rawname bfn buffer nil) fix-list)
- (uniquify-push (list (buffer-name buffer))
- uniquify-non-file-buffer-names)))
- (setq buffers (cdr buffers))))
+ (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
+ (directory-file-name 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.
- (setq fix-list
- (sort fix-list 'uniquify-fix-list-filename-lessp))
- ;; bringing conflicting names together
- (uniquify-rationalize-a-list fix-list depth)
- (mapcar 'uniquify-unrationalized-buffer fix-list)))
-
-;; uniquify's version of buffer-file-name
+ ;; 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 dired buffers as well as ordinary file-visiting buffers."
+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)
- (save-excursion
- (set-buffer buffer)
- list-buffers-directory)))
-
-(defun uniquify-fix-list-filename-lessp (fixlist1 fixlist2)
- (uniquify-filename-lessp
- (uniquify-fix-list-filename fixlist1) (uniquify-fix-list-filename fixlist2)))
-
-;; This examines the filename components in reverse order.
-(defun uniquify-filename-lessp (s1 s2)
- (let ((s1f (file-name-nondirectory s1))
- (s2f (file-name-nondirectory s2)))
- (and (not (equal s2f ""))
- (or (string-lessp s1f s2f)
- (and (equal s1f s2f)
- (let ((s1d (file-name-directory s1))
- (s2d (file-name-directory s2)))
- (and (not (<= (length s2d) 1))
- (or (<= (length s1d) 1)
- (uniquify-filename-lessp
- (substring s1d 0 -1)
- (substring s2d 0 -1))))))))))
-
-;; Was named do-the-buffers-you-couldnt-rationalize
-(defun uniquify-unrationalized-buffer (item)
- (or (uniquify-cadddr item) nil)) ;maybe better in the future
+ (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
- (old-name "")
- proposed-name uniquify-possibly-resolvable)
- (while fix-list
- (let ((item (car fix-list)))
- (setq proposed-name (uniquify-get-proposed-name item depth))
- (if (not (equal proposed-name old-name))
- (progn
- (uniquify-rationalize-conflicting-sublist
- conflicting-sublist old-name depth)
- (setq conflicting-sublist nil)))
- (uniquify-push item conflicting-sublist)
- (setq old-name proposed-name))
- (setq fix-list (cdr fix-list)))
- (uniquify-rationalize-conflicting-sublist
- conflicting-sublist old-name depth)))
-
-(defun uniquify-get-proposed-name (item depth)
- (let (index
- (extra-string "")
- (n depth)
- (base (uniquify-fix-list-base item))
- (fn (uniquify-fix-list-filename item)))
- (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, which is set by uniquify-rationalize-a-list.
-;; This is only called by uniquify-rationalize-a-list.
-(defun uniquify-rationalize-conflicting-sublist (conflicting-sublist old-name depth)
- (or (null conflicting-sublist)
- (and (null (cdr conflicting-sublist))
- (not (assoc old-name uniquify-non-file-buffer-names))
- (or (and (not (string= old-name ""))
- (uniquify-rename-buffer (car conflicting-sublist) old-name))
- t))
- (if uniquify-possibly-resolvable
- (uniquify-rationalize-a-list conflicting-sublist (1+ 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)
+ (assert (equal base (uniquify-file-name-nondirectory filename)))
+ (assert (equal (directory-file-name filename) filename))
+
+ ;; Distinguish directories by adding extra separator.
+ (if (and uniquify-trailing-separator-p
+ (file-directory-p filename)
+ (not (string-equal base "")))
+ (cond ((eq uniquify-buffer-name-style 'forward)
+ (setq base (file-name-as-directory base)))
+ ;; (setq base (concat base "/")))
+ ((eq uniquify-buffer-name-style 'reverse)
+ (setq base (concat (or uniquify-separator "\\") base)))))
+
+ (let ((extra-string nil)
+ (n depth))
+ (while (and (> n 0) filename
+ (setq filename (file-name-directory filename))
+ (setq filename (directory-file-name filename)))
+ (let ((file (file-name-nondirectory filename)))
+ (setq n (1- n))
+ (push (if (zerop (length file)) ;nil or "".
+ (prog1 "" (setq filename nil)) ;Could be `filename' iso "".
+ file)
+ extra-string)))
+ (when (zerop n)
+ (if (and filename extra-string
+ (setq filename (file-name-directory filename))
+ (equal filename
+ (file-name-directory (directory-file-name filename))))
+ ;; We're just before the root. Let's add the leading / already.
+ ;; With "/a/b"+"/c/d/b" this leads to "/a/b" and "d/b" but with
+ ;; "/a/b"+"/c/a/b" this leads to "/a/b" and "a/b".
+ (push "" extra-string))
+ (setq uniquify-possibly-resolvable t))
+
+ (cond
+ ((null extra-string) base)
+ ((string-equal base "") ;Happens for dired buffers on the root directory.
+ (mapconcat 'identity extra-string "/"))
+ ((eq uniquify-buffer-name-style 'reverse)
+ (mapconcat 'identity
+ (cons base (nreverse extra-string))
+ (or uniquify-separator "\\")))
+ ((eq uniquify-buffer-name-style 'forward)
+ (mapconcat 'identity (nconc extra-string (list base))
+ "/"))
+ ((eq uniquify-buffer-name-style 'post-forward)
+ (concat base (or uniquify-separator "|")
+ (mapconcat 'identity extra-string "/")))
+ ((eq uniquify-buffer-name-style 'post-forward-angle-brackets)
+ (concat base "<" (mapconcat 'identity 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-fix-list-buffer item)))
- (if (not (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))))
- (rplaca (nthcdr 3 item) t))
-
-(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)))
+(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)))))
;;; Hooks from the rest of Emacs
-;; Emacs 19 (Emacs or XEmacs)
-
;; 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
;; 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
+;; rename-buffer and create-file-buffer. (Setting find-file-hook isn't
;; sufficient.)
(defadvice rename-buffer (after rename-buffer-uniquify activate)
;; (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 ()
+(defun uniquify-delay-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)
+ uniquify-after-kill-buffer-p
+ ;; Rationalizing is costly, so don't do it for temp buffers.
+ (uniquify-buffer-file-name (current-buffer)))
(add-hook 'post-command-hook
- 'delayed-uniquify-rationalize-file-buffer-names)))
+ 'uniquify-delayed-rationalize-file-buffer-names)))
-(defun delayed-uniquify-rationalize-file-buffer-names ()
+(defun uniquify-delayed-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))
+ 'uniquify-delayed-rationalize-file-buffer-names))
-(add-hook 'kill-buffer-hook 'delay-uniquify-rationalize-file-buffer-names)
+(add-hook 'kill-buffer-hook 'uniquify-delay-rationalize-file-buffer-names)
;;; uniquify.el ends here
-