X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/5246db4e1f0626faa0209b225cfb9a89f72065a4..f875b154b4dbaf7901c6bff923581197c1cf8ab5:/lisp/uniquify.el diff --git a/lisp/uniquify.el b/lisp/uniquify.el dissimilarity index 60% index 0152721dad..24b49a983a 100644 --- a/lisp/uniquify.el +++ b/lisp/uniquify.el @@ -1,384 +1,477 @@ -;;; uniquify.el --- unique buffer names dependent on file name - -;; Copyright (c) 1989, 1995 Free Software Foundation, Inc. - -;; Author: Dick King -;; Maintainer: Michael Ernst -;; 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, just load it. -;; To disable it after loading, set variable uniquify-buffer-name-style to nil. -;; 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. - -;;; 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 - -;; Valuable feedback was provided by -;; Paul Smith , -;; Alastair Burt , -;; Bob Weiner , -;; Albert L. Ting , -;; gyro@reasoning.com. - - -;;; Code: - -(provide 'uniquify) - -;;; User-visible variables - -(defvar uniquify-buffer-name-style 'post-forward - "*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 name - nil name name<2>") - -(defvar 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).") - -(defconst 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 - "*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 \"\\\").") - -(defvar 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.") - - -;;; 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))))))) - -;; 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) - "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 - (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)))) - ;; 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 -(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." - (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 - -(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))))) - -(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))) - - -;;; 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 -;; 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 - +;;; uniquify.el --- unique buffer names dependent on file name + +;; Copyright (C) 1989, 1995, 1996, 1997, 2001, 2002, 2003, +;; 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, 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. + +;;; 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: + +(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 t + "If non-nil, rerationalize buffer names after a buffer has been killed." + :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) + +;; The default value matches certain Gnus buffers. +(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) + +(defcustom uniquify-strip-common-suffix + ;; Using it when uniquify-min-dir-content>0 doesn't make much sense. + (eq 0 uniquify-min-dir-content) + "If non-nil, strip common directory suffixes of conflicting files. +E.g. if you open /a1/b/c/d and /a2/b/c/d, the buffer names will say +\"d|a1\" and \"d|a2\" instead of \"d|a1/b/c\" and \"d|a2/b/c\". +This can be handy when you have deep parallel hierarchies." + :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 + +;; uniquify-fix-list data structure +(defstruct (uniquify-item + (:constructor nil) (:copier nil) + (:constructor uniquify-make-item + (base dirname buffer &optional proposed))) + base dirname buffer proposed) + +;; Internal variables used free +(defvar uniquify-possibly-resolvable nil) + +(defvar uniquify-managed nil + "Non-nil if the name of this buffer is managed by uniquify. +It actually holds the list of `uniquify-item's corresponding to the conflict.") +(make-variable-buffer-local 'uniquify-managed) +(put 'uniquify-managed 'permanent-local t) + +;;; Main entry point. + +(defun uniquify-rationalize-file-buffer-names (base dirname 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 BASE, DIRNAME, and NEWBUF specify the new buffer that causes +this rationalization." + (interactive + (list (if uniquify-managed + (uniquify-item-base (car uniquify-managed)) (buffer-name)) + (uniquify-buffer-file-name (current-buffer)) + (current-buffer))) + ;; Make sure we don't get confused by outdated uniquify-managed info in + ;; this buffer. + (with-current-buffer newbuf (setq uniquify-managed nil)) + (when dirname + (setq dirname (expand-file-name (directory-file-name dirname))) + (let ((fix-list (list (uniquify-make-item base dirname newbuf))) + items) + (dolist (buffer (buffer-list)) + (when (and (not (and uniquify-ignore-buffers-re + (string-match uniquify-ignore-buffers-re + (buffer-name buffer)))) + ;; Only try to rename buffers we actually manage. + (setq items (buffer-local-value 'uniquify-managed buffer)) + (equal base (uniquify-item-base (car items))) + ;; Don't re-add stuff we already have. Actually this + ;; whole `and' test should only match at most once. + (not (memq (car items) fix-list))) + (unless (cdr items) + ;; If there was no conflict, the buffer-name is equal to the + ;; base-name and we may have missed a rename-buffer because + ;; of code like in set-visited-file-name: + ;; (or (string= new-name (buffer-name)) (rename-buffer new-name t)) + ;; So we need to refresh the dirname of the uniquify-item. + (setf (uniquify-item-dirname (car items)) + (uniquify-buffer-file-name + (uniquify-item-buffer (car items)))) + ;; This shouldn't happen, but maybe there's no dirname any more. + (unless (uniquify-item-dirname (car items)) + (with-current-buffer (uniquify-item-buffer (car items)) + (setq uniquify-managed nil)) + (setq items nil))) + (setq fix-list (append fix-list items)))) + ;; selects buffers whose names may need changing, and others that + ;; may conflict, then bring conflicting names together + (uniquify-rationalize fix-list)))) + +;; uniquify's version of buffer-file-name; result never contains trailing slash +(defun uniquify-buffer-file-name (buffer) + "Return name of directory, 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." + (with-current-buffer buffer + (let ((filename + (or buffer-file-name + (if (memq major-mode uniquify-list-buffers-directory-modes) + list-buffers-directory)))) + (when filename + (directory-file-name + (file-name-directory + (expand-file-name + (directory-file-name filename)))))))) + +(defun uniquify-rerationalize-w/o-cb (fix-list) + "Re-rationalize the buffers in FIX-LIST, but ignoring current-buffer." + (let ((new-fix-list nil)) + (dolist (item fix-list) + (let ((buf (uniquify-item-buffer item))) + (unless (or (eq buf (current-buffer)) (not (buffer-live-p buf))) + (push item new-fix-list)))) + (when new-fix-list + (uniquify-rationalize new-fix-list)))) + +(defun uniquify-rationalize (fix-list) + ;; Set up uniquify to re-rationalize after killing/renaming + ;; if there is a conflict. + (dolist (item fix-list) + (with-current-buffer (uniquify-item-buffer item) + ;; Refresh the dirnames and proposed names. + (setf (uniquify-item-proposed item) + (uniquify-get-proposed-name (uniquify-item-base item) + (uniquify-item-dirname item))) + (setq uniquify-managed fix-list))) + ;; Strip any shared last directory names of the dirname. + (when (and (cdr fix-list) uniquify-strip-common-suffix) + (let ((strip t)) + (while (let* ((base (file-name-nondirectory + (uniquify-item-dirname (car fix-list)))) + (items fix-list)) + (when (> (length base) 0) + (while (and strip items) + (unless (equal base (file-name-nondirectory + (uniquify-item-dirname (pop items)))) + (setq strip nil))) + strip)) + ;; It's all the same => strip. + (dolist (item (prog1 fix-list (setq fix-list nil))) + ;; Create new items because the old ones are kept (with the true + ;; `dirname') for later rerationalizing. + (push (uniquify-make-item (uniquify-item-base item) + (let ((f (file-name-directory + (uniquify-item-dirname item)))) + (and f (directory-file-name f))) + (uniquify-item-buffer item) + (uniquify-item-proposed item)) + fix-list))))) + ;; If uniquify-min-dir-content is 0, this will end up just + ;; passing fix-list to uniquify-rationalize-conflicting-sublist. + (uniquify-rationalize-a-list fix-list)) + +(defun uniquify-item-greaterp (item1 item2) + (string-lessp (uniquify-item-proposed item2) + (uniquify-item-proposed item1))) + +(defun uniquify-rationalize-a-list (fix-list &optional depth) + (unless depth (setq depth uniquify-min-dir-content)) + (let (conflicting-sublist ; all elements have the same proposed name + (old-proposed "") + proposed) + ;; Divide fix-list into items with same proposed names and pass them + ;; to uniquify-rationalize-conflicting-sublist. + (dolist (item (sort fix-list 'uniquify-item-greaterp)) + (setq proposed (uniquify-item-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 dirname &optional depth) + (unless depth (setq depth uniquify-min-dir-content)) + (assert (equal (directory-file-name dirname) dirname)) ;No trailing slash. + + ;; Distinguish directories by adding extra separator. + (if (and uniquify-trailing-separator-p + (file-directory-p (expand-file-name base dirname)) + (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) dirname) + (let ((file (file-name-nondirectory dirname))) + (when (setq dirname (file-name-directory dirname)) + (setq dirname (directory-file-name dirname))) + (setq n (1- n)) + (push (if (zerop (length file)) ;nil or "". + (prog1 "" (setq dirname nil)) ;Could be `dirname' iso "". + file) + extra-string))) + (when (zerop n) + (if (and dirname extra-string + (equal dirname (file-name-directory dirname))) + ;; 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) + ;; Check that the proposed name doesn't conflict with some + ;; existing buffer. + (let ((buf (get-buffer old-name))) + (and buf (not (eq buf (uniquify-item-buffer (car conf-list))))))) + (when uniquify-possibly-resolvable + (setq uniquify-possibly-resolvable nil + depth (1+ depth)) + (dolist (item conf-list) + (setf (uniquify-item-proposed item) + (uniquify-get-proposed-name + (uniquify-item-base item) + (uniquify-item-dirname 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-item-buffer item))) + (unless (equal newname (buffer-name buffer)) + (with-current-buffer buffer + (let ((uniquify-buffer-name-style nil)) ;Avoid hooks on rename-buffer. + ;; Pass the `unique' arg, so the advice doesn't mark it as unmanaged. + (rename-buffer newname t)))))) + +;;; 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-hook isn't +;; sufficient.) + +(defadvice rename-buffer (after rename-buffer-uniquify activate) + "Uniquify buffer names with parts of directory name." + (uniquify-maybe-rerationalize-w/o-cb) + (if (null (ad-get-arg 1)) ; no UNIQUE argument. + ;; Mark this buffer so it won't be renamed by uniquify. + (setq uniquify-managed nil) + (when uniquify-buffer-name-style + ;; Rerationalize w.r.t the new name. + (uniquify-rationalize-file-buffer-names + (ad-get-arg 0) + (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 + (let ((filename (expand-file-name (directory-file-name (ad-get-arg 0))))) + (uniquify-rationalize-file-buffer-names + (file-name-nondirectory filename) + (file-name-directory filename) 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 uniquify-maybe-rerationalize-w/o-cb () + "Re-rationalize buffer names, ignoring current buffer. +For use on `kill-buffer-hook'." + (if (and (cdr uniquify-managed) + uniquify-buffer-name-style + uniquify-after-kill-buffer-p) + (uniquify-rerationalize-w/o-cb uniquify-managed))) + +;; Ideally we'd like to add it buffer-locally, but that doesn't work +;; because kill-buffer-hook is not permanent-local :-( +(add-hook 'kill-buffer-hook 'uniquify-maybe-rerationalize-w/o-cb) + +(provide 'uniquify) + +;; arch-tag: e763faa3-56c9-4903-8eb8-26e1c45a0065 +;;; uniquify.el ends here