(provide 'uniquify)
(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 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>"
: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)
(defmacro uniquify-push (item list)
(` (setq (, list) (cons (, item) (, list)))))
(defun uniquify-file-name-nondirectory (file-name)
(file-name-nondirectory (directory-file-name file-name)))
(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))))))
(defun uniquify-fix-item-unrationalized-buffer (item)
(or (car (cdr (cdr (cdr item)))) nil))
(defun uniquify-fix-item-filename-lessp (fixlist1 fixlist2)
(uniquify-filename-lessp (uniquify-fix-item-filename fixlist1)
(uniquify-fix-item-filename fixlist2)))
(defvar uniquify-non-file-buffer-names nil)
(defvar uniquify-possibly-resolvable nil)
(defun uniquify-rationalize-file-buffer-names (&optional newbuffile newbuf)
"Makes 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)
(let ((buffers (buffer-list)))
(while buffers
(let* ((buffer (car buffers))
(bfn (if (eq buffer newbuf)
(and newbuffile
(expand-file-name
(if (file-directory-p newbuffile)
(directory-file-name newbuffile)
newbuffile)))
(uniquify-buffer-file-name buffer)))
(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
(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)))
(setq buffers (cdr buffers))))
(setq fix-list
(sort fix-list 'uniquify-fix-item-filename-lessp))
(uniquify-rationalize-a-list fix-list uniquify-min-dir-content)
(mapcar 'uniquify-fix-item-unrationalized-buffer fix-list)))
(defun uniquify-buffer-file-name (buffer)
"Return name of file BUFFER is visiting, or nil if none.
Works on dired buffers and ordinary file-visiting buffers, but no others."
(or (buffer-file-name buffer)
(and (featurep 'dired)
(save-excursion
(set-buffer buffer)
(and
(eq major-mode 'dired-mode) (if (boundp 'list-buffers-directory) (and list-buffers-directory
(directory-file-name list-buffers-directory))
(and dired-directory
(expand-file-name
(directory-file-name
(if (consp dired-directory)
(car dired-directory)
dired-directory))))))))))
(defun uniquify-filename-lessp (s1 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)
(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))))))))))
(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-item-base item))
(fn (uniquify-fix-item-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 fn) (length base)))
n (1- n)))
(if (zerop n) (setq uniquify-possibly-resolvable t))
(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)))))
(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)))))
(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)))))
(defun uniquify-rename-buffer (item newname)
(let ((buffer (uniquify-fix-item-buffer item)))
(if (not (equal newname (buffer-name buffer)))
(let ((unset (current-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)))
(defadvice rename-buffer (after rename-buffer-uniquify activate)
"Uniquify buffer names with parts of directory name."
(if (and uniquify-buffer-name-style
(ad-get-arg 1))
(progn
(if uniquify-after-kill-buffer-p
(uniquify-rationalize-file-buffer-names)
(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)))
(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)