2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
[bpt/emacs.git] / lisp / iswitchb.el
index b5242e1..2f271c5 100644 (file)
@@ -1,7 +1,7 @@
 ;;; iswitchb.el --- switch between buffers using substrings
 
 ;; Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;;   2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
 
 ;; Author: Stephen Eglen <stephen@gnu.org>
 ;; Maintainer: Stephen Eglen <stephen@gnu.org>
@@ -9,10 +9,10 @@
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, 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
@@ -20,9 +20,7 @@
 ;; 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.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 ;; iswitch for all buffer selections in Emacs, add:
 ;; (setq read-buffer-function 'iswitchb-read-buffer)
 ;; (This variable was introduced in Emacs 20.3.)
-;; XEmacs users can get the same behaviour by doing:
+;; XEmacs users can get the same behavior by doing:
 ;; (defalias 'read-buffer 'iswitchb-read-buffer)
 ;; since `read-buffer' is defined in lisp.
 
 ;;                     iswitchb-mode-map "\C-o"
 ;;                     'iswitchb-exclude-nonmatching)))
 
-;; Other lisp packages extend iswitchb behaviour to other tasks.  See
+;; Other lisp packages extend iswitchb behavior to other tasks.  See
 ;; ido.el (by Kim Storm) and mcomplete.el (Yuji Minejima).
 
 ;; Window managers: Switching frames/focus follows mouse; Sawfish.
   :link '(emacs-library-link :tag "Lisp File" "iswitchb.el"))
 
 (defcustom iswitchb-case case-fold-search
-  "*Non-nil if searching of buffer names should ignore case.
+  "Non-nil if searching of buffer names should ignore case.
 If this is non-nil but the user input has any upper case letters, matching
 is temporarily case sensitive."
   :type 'boolean
@@ -267,7 +265,7 @@ is temporarily case sensitive."
 
 (defcustom iswitchb-buffer-ignore
   '("^ ")
-  "*List of regexps or functions matching buffer names to ignore.
+  "List of regexps or functions matching buffer names to ignore.
 For example, traditional behavior is not to list buffers whose names begin
 with a space, for which the regexp is `^ '.  See the source file for
 example functions that filter buffer names."
@@ -276,7 +274,7 @@ example functions that filter buffer names."
 (put 'iswitchb-buffer-ignore 'risky-local-variable t)
 
 (defcustom iswitchb-max-to-show nil
-  "*If non-nil, limit the number of names shown in the minibuffer.
+  "If non-nil, limit the number of names shown in the minibuffer.
 If this value is N, and N is greater than the number of matching
 buffers, the first N/2 and the last N/2 matching buffers are
 shown.  This can greatly speed up iswitchb if you have a
@@ -285,7 +283,7 @@ multitude of buffers open."
   :group 'iswitchb)
 
 (defcustom iswitchb-use-virtual-buffers nil
-  "*If non-nil, refer to past buffers when none match.
+  "If non-nil, refer to past buffers when none match.
 This feature relies upon the `recentf' package, which will be
 enabled if this variable is configured to a non-nil value."
   :type 'boolean
@@ -299,7 +297,7 @@ enabled if this variable is configured to a non-nil value."
 (defvar iswitchb-virtual-buffers nil)
 
 (defcustom iswitchb-cannot-complete-hook 'iswitchb-completion-help
-  "*Hook run when `iswitchb-complete' can't complete any more.
+  "Hook run when `iswitchb-complete' can't complete any more.
 The most useful values are `iswitchb-completion-help', which pops up a
 window with completion alternatives, or `iswitchb-next-match' or
 `iswitchb-prev-match', which cycle the buffer list."
@@ -316,7 +314,7 @@ window with completion alternatives, or `iswitchb-next-match' or
 ;;(setq iswitchb-buffer-ignore '("^ " "\\.c\\'" "\\.h\\'"))
 
 (defcustom iswitchb-default-method  'always-frame
-    "*How to switch to new buffer when using `iswitchb-buffer'.
+    "How to switch to new buffer when using `iswitchb-buffer'.
 Possible values:
 `samewindow'   Show new buffer in same window
 `otherwindow'  Show new buffer in another window (same frame)
@@ -336,19 +334,19 @@ Possible values:
     :group 'iswitchb)
 
 (defcustom iswitchb-regexp nil
-  "*Non-nil means that `iswitchb' will do regexp matching.
+  "Non-nil means that `iswitchb' will do regexp matching.
 Value can be toggled within `iswitchb' using `iswitchb-toggle-regexp'."
   :type 'boolean
   :group 'iswitchb)
 
 (defcustom iswitchb-newbuffer t
-  "*Non-nil means create new buffer if no buffer matches substring.
+  "Non-nil means create new buffer if no buffer matches substring.
 See also `iswitchb-prompt-newbuffer'."
   :type 'boolean
   :group 'iswitchb)
 
 (defcustom iswitchb-prompt-newbuffer t
-  "*Non-nil means prompt user to confirm before creating new buffer.
+  "Non-nil means prompt user to confirm before creating new buffer.
 See also `iswitchb-newbuffer'."
   :type 'boolean
   :group 'iswitchb)
@@ -356,12 +354,12 @@ See also `iswitchb-newbuffer'."
 (define-obsolete-variable-alias 'iswitchb-use-fonts 'iswitchb-use-faces "22.1")
 
 (defcustom iswitchb-use-faces t
-  "*Non-nil means use font-lock faces for showing first match."
+  "Non-nil means use font-lock faces for showing first match."
   :type 'boolean
   :group 'iswitchb)
 
 (defcustom iswitchb-use-frame-buffer-list nil
-  "*Non-nil means use the currently selected frame's buffer list."
+  "Non-nil means use the currently selected frame's buffer list."
   :type 'boolean
   :group 'iswitchb)
 
@@ -370,6 +368,11 @@ See also `iswitchb-newbuffer'."
   :type 'hook
   :group 'iswitchb)
 
+(defcustom iswitchb-delim ","
+  "Delimiter to put between buffer names when displaying results."
+  :type 'string
+  :group 'iswitchb)
+
 (defvar iswitchb-all-frames 'visible
   "*Argument to pass to `walk-windows' when finding visible buffers.
 See documentation of `walk-windows' for useful values.")
@@ -654,9 +657,12 @@ the selection process begins.  Used by isearchb.el."
     ;; that file now and act as though that buffer had been selected.
     (if (and iswitchb-virtual-buffers
             (not (iswitchb-existing-buffer-p)))
-       (let ((virt (car iswitchb-virtual-buffers)))
-         (find-file-noselect (cdr virt))
-         (setq iswitchb-matches (list (car virt))
+       (let ((virt (car iswitchb-virtual-buffers))
+             (new-buf))
+         ;; Keep the name of the buffer returned by find-file-noselect, as 
+         ;; the buffer 'virt' could be a symlink to a file of a different name.
+         (setq new-buf (buffer-name (find-file-noselect (cdr virt))))
+         (setq iswitchb-matches (list new-buf)
                iswitchb-virtual-buffers nil)))
 
     ;; Handling the require-match must be done in a better way.
@@ -1007,19 +1013,13 @@ Return the modified list with the last element prepended to it."
 
            ;; XEmacs extents are put on by default, doesn't seem to be
            ;; any way of switching them off.
-           (display-completion-list (if iswitchb-matches
-                                        iswitchb-matches
-                                      iswitchb-buflist)
+           (display-completion-list (or iswitchb-matches iswitchb-buflist)
                                     :help-string "iswitchb "
                                     :activate-callback
                                     (lambda (x y z)
                                       (message "doesn't work yet, sorry!")))
          ;; else running Emacs
-         (with-current-buffer standard-output
-           (fundamental-mode))
-         (display-completion-list (if iswitchb-matches
-                                      iswitchb-matches
-                                    iswitchb-buflist))))
+         (display-completion-list (or iswitchb-matches iswitchb-buflist))))
       (setq iswitchb-common-match-inserted nil))))
 
 ;;; KILL CURRENT BUFFER
@@ -1342,7 +1342,7 @@ Modified from `icomplete-completions'."
                  most-is-exact
                  (alternatives
                   (mapconcat (if most 'iswitchb-output-completion
-                               'identity) comps ",")))
+                               'identity) comps iswitchb-delim)))
 
             (concat
 
@@ -1365,7 +1365,7 @@ Modified from `icomplete-completions'."
              ;; list all alternatives
              open-bracket-prospects
              (if most-is-exact
-                 (concat "," alternatives)
+                 (concat iswitchb-delim alternatives)
                alternatives)
              close-bracket-prospects))))))