-;;; uniquify.el --- unique buffer names dependent on pathname
+;;; uniquify.el --- unique buffer names dependent on file name
-;; Copyright (c) 1989, 1995 Free Software Foundation, Inc.
+;; Copyright (c) 1989, 1995, 1996, 1997 Free Software Foundation, Inc.
;; Author: Dick King <king@reasoning.com>
-;; Maintainer: Michael Ernst <mernst@theory.lcs.mit.edu>
+;; Maintainer: FSF
;; Created: 15 May 86
;; This file is part of GNU Emacs.
;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; 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 pathname until the buffer names
+;; 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, 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.
-;; uniquify.el works under Emacs, XEmacs, and InfoDock.
+;; A version of uniquify.el that works under Emacs 18, Emacs 19, XEmacs,
+;; and InfoDock is available from the maintainer.
-;; Doesn't correctly handle buffer names created by M-x write-file in Emacs 18.
+;; 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:
;; 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
;; 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.
-For example, files /foo/bar/mumble/name and /baz/quux/mumble/name
-would be in the following buffers:
+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<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 pathname 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
+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
-pathname components (default \"\\\").")
-
-(defvar uniquify-trailing-separator-p nil
- "*If non-nil, add a pathname separator to dired buffer names.
-If `uniquify-buffer-name-style' is 'forward, add the separator at the end;
-if it's is 'reverse, add the separator at the beginning; otherwise, this
-variable is ignored.")
-
+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
-(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)))))
-
-(defmacro uniquify-fix-list-buffer (a)
- (` (car (cdr (cdr (, a))))))
-
-(defmacro uniquify-cadddr (a)
- (` (car (cdr (cdr (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)))
+
+;; uniquify-fix-list data structure
+(defmacro uniquify-fix-item-base (a)
+ `(car ,a))
+(defmacro uniquify-fix-item-filename (a)
+ `(car (cdr ,a)))
+(defmacro uniquify-fix-item-buffer (a)
+ `(car (cdr (cdr ,a))))
+;; Not a macro: passed to mapcar.
+(defun uniquify-fix-item-unrationalized-buffer (item)
+ (or (car (cdr (cdr (cdr item)))) nil)) ;maybe better in the future
+
+(defun uniquify-fix-item-filename-lessp (fixlist1 fixlist2)
+ (uniquify-filename-lessp (uniquify-fix-item-filename fixlist1)
+ (uniquify-fix-item-filename fixlist2)))
;; 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 pathname.
+ "Make file buffer names unique by adding segments from file name.
If `uniquify-min-dir-content' > 0, always pulls that many
-pathname elements. Arguments cause only a subset of buffers to be renamed."
+file name elements. Arguments cause only a subset of buffers to be renamed."
(interactive)
(let (fix-list
- uniquify-non-file-buffer-names
- (depth uniquify-min-dir-content))
+ uniquify-non-file-buffer-names)
(let ((buffers (buffer-list)))
(while buffers
(let* ((buffer (car buffers))
(bfn (if (eq buffer newbuf)
- (expand-file-name newbuffile)
+ (and newbuffile
+ (expand-file-name
+ (if (file-directory-p newbuffile)
+ (directory-file-name newbuffile)
+ newbuffile)))
(uniquify-buffer-file-name buffer)))
- (rawname (and bfn (file-name-nondirectory bfn)))
+ (rawname (and bfn (uniquify-file-name-nondirectory bfn)))
(deserving (and rawname
+ (not (and uniquify-ignore-buffers-re
+ (string-match uniquify-ignore-buffers-re
+ (buffer-name buffer))))
(or (not newbuffile)
(equal rawname
- (file-name-nondirectory newbuffile))))))
+ (uniquify-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)))
+ (push (list rawname bfn buffer nil) fix-list)
+ (push (list (buffer-name buffer))
+ uniquify-non-file-buffer-names)))
(setq buffers (cdr buffers))))
;; selects buffers whose names may need changing, and others that
;; may conflict.
(setq fix-list
- (sort fix-list 'uniquify-filename-sort))
+ (sort fix-list 'uniquify-fix-item-filename-lessp))
;; bringing conflicting names together
- (uniquify-rationalize-a-list fix-list depth)
- (mapcar 'uniquify-unrationalized-buffer fix-list)))
+ (uniquify-rationalize-a-list fix-list uniquify-min-dir-content)
+ (mapcar 'uniquify-fix-item-unrationalized-buffer fix-list)))
+;; 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-filename-sort (s1 s2)
- (uniquify-filename-lessp
- (uniquify-fix-list-filename s1) (uniquify-fix-list-filename s2)))
-
+ (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)))))))))
+
+;; 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)))
+ (let ((s1f (uniquify-file-name-nondirectory s1))
+ (s2f (uniquify-file-name-nondirectory s2)))
(and (not (equal s2f ""))
(or (string-lessp s1f s2f)
(and (equal s1f s2f)
(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
-
(defun uniquify-rationalize-a-list (fix-list depth)
- (let (conflicting-sublist
+ (let (conflicting-sublist ; all elements have the same proposed name
(old-name "")
proposed-name uniquify-possibly-resolvable)
(while fix-list
(uniquify-rationalize-conflicting-sublist
conflicting-sublist old-name depth)
(setq conflicting-sublist nil)))
- (uniquify-push item conflicting-sublist)
+ (push item conflicting-sublist)
(setq old-name proposed-name))
(setq fix-list (cdr fix-list)))
(uniquify-rationalize-conflicting-sublist
(let (index
(extra-string "")
(n depth)
- (base (uniquify-fix-list-base item))
- (fn (uniquify-fix-list-filename item)))
+ (base (uniquify-fix-item-base item))
+ (fn (uniquify-fix-item-filename item)))
(while (and (> n 0)
(setq index (string-match
(concat "\\(^\\|/[^/]*\\)/"
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.
+;; Deal with conflicting-sublist, all of whose elements have identical
+;; "base" components.
(defun uniquify-rationalize-conflicting-sublist (conflicting-sublist old-name depth)
(or (null conflicting-sublist)
(and (null (cdr conflicting-sublist))
(uniquify-rationalize-a-list conflicting-sublist (1+ depth)))))
(defun uniquify-rename-buffer (item newname)
- (let ((buffer (uniquify-fix-list-buffer item)))
+ (let ((buffer (uniquify-fix-item-buffer item)))
(if (not (equal newname (buffer-name buffer)))
(let ((unset (current-buffer))
;; avoid hooks on rename-buffer
;;; Hooks from the rest of Emacs
-;; Emacs 19 (GNU 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
(add-hook 'kill-buffer-hook 'delay-uniquify-rationalize-file-buffer-names)
;;; uniquify.el ends here
-
HCoop / bpt / emacs.git / blobdiff