;;; iswitchb.el --- switch between buffers using substrings
-;; Copyright (C) 1996, 1997, 2000, 2001 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1997, 2000, 2001, 2003 Free Software Foundation, Inc.
;; Author: Stephen Eglen <stephen@gnu.org>
;; Maintainer: Stephen Eglen <stephen@gnu.org>
;; Installation:
;; To get the functions in this package bound to keys, use
;; M-x iswitchb-mode or customize the option `iswitchb-mode'.
+;; Alternatively, add the following line to your .emacs:
+;; (iswitchb-mode 1)
;; As you type in a substring, the list of buffers currently matching
;; the substring is displayed as you type. The list is ordered so
;; The list in {} are the matching buffers, most recent first (buffers
;; visible in the current frame are put at the end of the list by
;; default). At any time I can select the item at the head of the
-;; list by pressing RET. I can also bring the put the first element
-;; at the end of the list by pressing C-s, or put the last element at
-;; the head of the list by pressing C-r. The item in [] indicates
-;; what can be added to my input by pressing TAB. In this case, I
-;; will get "3" added to my input. So, press TAB:
+;; list by pressing RET. I can also put the first element at the end
+;; of the list by pressing C-s, or put the last element at the head of
+;; the list by pressing C-r. The item in [] indicates what can be
+;; added to my input by pressing TAB. In this case, I will get "3"
+;; added to my input. So, press TAB:
;; iswitch 23{123456,123}
;;
;; At this point, I still have two matching buffers.
;; then all buffers matching "Summary" are moved to the end of the
;; list. (I find this handy for keeping the INBOX Summary and so on
;; out of the way.) It also moves buffers matching "output\*$" to the
-;; end of the list (these are created by AUC TeX when compiling.)
+;; end of the list (these are created by AUCTeX when compiling.)
;; Other functions could be made available which alter the list of
;; matching buffers (either deleting or rearranging elements.)
;; Using iswitchb for other completion tasks.
-;; Kin Cho (kin@neoscale.com sent the following suggestion to use
-;; iswitchb for other completion tasks.
+;; Kin Cho (kin@neoscale.com) sent the following suggestion to use
+;; iswitchb for other completion tasks.
;;
;; (defun my-icompleting-read (prompt choices)
;; "Use iswitch as a completing-read replacement to choose from
;; (my-icompleting-read "Which fruit? " '
;; ("apple" "pineapple" "pear" "bananas" "oranges") )
+;; Kin Cho also suggested the following defun. Once you have a subset of
+;; matching buffers matching your current prompt, you can then press
+;; e.g. C-o to restrict matching to those buffers and clearing the prompt:
+;; (defun iswitchb-exclude-nonmatching()
+;; "Make iswitchb work on only the currently matching names."
+;; (interactive)
+;; (setq iswitchb-buflist iswitchb-matches)
+;; (setq iswitchb-rescan t)
+;; (delete-minibuffer-contents))
+;;
+;; (add-hook 'iswitchb-define-mode-map-hook
+;; '(lambda () (define-key
+;; iswitchb-mode-map "\C-o"
+;; 'iswitchb-exclude-nonmatching)))
+
;; Other lisp packages extend iswitchb behaviour to other tasks. See
;; ido.el (by Kim Storm) and mcomplete.el (Yuji Minejima).
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 buffernames."
- :type '(repeat regexp)
+ :type '(repeat (choice regexp function))
:group 'iswitchb)
+(defcustom iswitchb-max-to-show nil
+ "*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
+multitude of buffers open."
+ :type '(choice (const :tag "Show all" nil) integer)
+ :group 'iswitchb)
+
+(defcustom iswitchb-use-virtual-buffers nil
+ "*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
+ :require 'recentf
+ :set (function
+ (lambda (sym value)
+ (if value (recentf-mode 1))
+ (set sym value)))
+ :group 'iswitchb)
+
+(defvar iswitchb-virtual-buffers nil)
+
(defcustom iswitchb-cannot-complete-hook 'iswitchb-completion-help
"*Hook run when `iswitchb-complete' can't complete any more.
The most useful values are `iswitchb-completion-help', which pops up a
"Iswitchb-specific customization of minibuffer setup.
This hook is run during minibuffer setup iff `iswitchb' will be active.
-It is intended for use in customizing iswitchb for interoperation
-with other packages."
-;;; For instance:
-
-;;; \(add-hook 'iswitchb-minibuffer-setup-hook
-;;; \(function
-;;; \(lambda ()
-;;; \(make-local-variable 'resize-minibuffer-window-max-height)
-;;; \(setq resize-minibuffer-window-max-height 3))))
-
-;;; will constrain rsz-mini to a maximum minibuffer height of 3 lines when
-;;; iswitchb is running. Copied from `icomplete-minibuffer-setup-hook'."
+For instance:
+\(add-hook 'iswitchb-minibuffer-setup-hook
+ '\(lambda () (set (make-local-variable 'max-mini-window-height) 3)))
+will constrain the minibuffer to a maximum height of 3 lines when
+iswitchb is running."
:type 'hook
:group 'iswitchb)
(substitute-key-definition 'display-buffer ; C-x 4 C-o
'iswitchb-display-buffer map global-map)
map)
- "Global keymap for `iswtichb-mode'.")
+ "Global keymap for `iswitchb-mode'.")
(defvar iswitchb-history nil
"History of buffers selected using `iswitchb-buffer'.")
(defvar iswitchb-buffer-ignore-orig nil
"Stores original value of `iswitchb-buffer-ignore'.")
-(defvar iswitchb-xemacs (string-match "XEmacs" (emacs-version))
- "Non-nil if we are running XEmacs. Otherwise, assume we are running Emacs.")
-
(defvar iswitchb-default nil
"Default buffer for iswitchb.")
(define-key map "\C-m" 'iswitchb-exit-minibuffer)
(setq iswitchb-mode-map map)
(run-hooks 'iswitchb-define-mode-map-hook)))
-
+
;;; MAIN FUNCTION
(defun iswitchb ()
"Switch to buffer matching a substring.
\\[iswitchb-kill-buffer] Kill buffer at head of buffer list."
;;\\[iswitchb-toggle-ignore] Toggle ignoring certain buffers (see \
;;`iswitchb-buffer-ignore')
-
+
(let* ((prompt "iswitch ")
(buf (iswitchb-read-buffer prompt)))
(iswitchb-possible-new-buffer buf)))
))))
-;;;###autoload
-(defun iswitchb-read-buffer (prompt &optional default require-match)
+(defun iswitchb-read-buffer (prompt &optional default require-match
+ start matches-set)
"Replacement for the built-in `read-buffer'.
Return the name of a buffer selected.
-PROMPT is the prompt to give to the user. DEFAULT if given is the default
-buffer to be selected, which will go to the front of the list.
-If REQUIRE-MATCH is non-nil, an existing-buffer must be selected."
+PROMPT is the prompt to give to the user.
+DEFAULT if given is the default buffer to be selected, which will
+go to the front of the list.
+If REQUIRE-MATCH is non-nil, an existing-buffer must be selected.
+If START is a string, the selection process is started with that
+string.
+If MATCHES-SET is non-nil, the buflist is not updated before
+the selection process begins. Used by isearchb.el."
(let
(
buf-sel
(iswitchb-define-mode-map)
(setq iswitchb-exit nil)
- (setq iswitchb-rescan t)
- (setq iswitchb-text "")
(setq iswitchb-default
(if (bufferp default)
(buffer-name default)
default))
- (iswitchb-make-buflist iswitchb-default)
- (iswitchb-set-matches)
+ (setq iswitchb-text (or start ""))
+ (unless matches-set
+ (setq iswitchb-rescan t)
+ (iswitchb-make-buflist iswitchb-default)
+ (iswitchb-set-matches))
(let
((minibuffer-local-completion-map iswitchb-mode-map)
- (iswitchb-prepost-hooks t)
;; Record the minibuffer depth that we expect to find once
;; the minibuffer is set up and iswitchb-entryfn-p is called.
(iswitchb-minibuf-depth (1+ (minibuffer-depth)))
(iswitchb-require-match require-match))
;; prompt the user for the buffer name
(setq iswitchb-final-text (completing-read
- prompt ;the prompt
+ prompt ;the prompt
'(("dummy" . 1)) ;table
- nil ;predicate
- nil ;require-match [handled elsewhere]
- nil ;initial-contents
+ nil ;predicate
+ nil ;require-match [handled elsewhere]
+ start ;initial-contents
'iswitchb-history)))
- (if (get-buffer iswitchb-final-text)
+ (if (and (not (eq iswitchb-exit 'usefirst))
+ (get-buffer iswitchb-final-text))
;; This happens for example if the buffer was chosen with the mouse.
- (setq iswitchb-matches (list iswitchb-final-text)))
+ (setq iswitchb-matches (list iswitchb-final-text)
+ iswitchb-virtual-buffers nil))
+
+ ;; If no buffer matched, but a virtual buffer was selected, visit
+ ;; 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))
+ iswitchb-virtual-buffers nil)))
;; Handling the require-match must be done in a better way.
- (if (and require-match (not (iswitchb-existing-buffer-p)))
+ (if (and require-match
+ (not (iswitchb-existing-buffer-p)))
(error "Must specify valid buffer"))
- (if (or
- (eq iswitchb-exit 'takeprompt)
- (null iswitchb-matches))
+ (if (or (eq iswitchb-exit 'takeprompt)
+ (null iswitchb-matches))
(setq buf-sel iswitchb-final-text)
;; else take head of list
(setq buf-sel (car iswitchb-matches)))
-
+
;; Or possibly choose the default buffer
(if (equal iswitchb-final-text "")
- (setq buf-sel
- (car iswitchb-matches)))
+ (setq buf-sel (car iswitchb-matches)))
buf-sel))
(let (res)
(cond ((not iswitchb-matches)
(run-hooks 'iswitchb-cannot-complete-hook))
-
+
((= 1 (length iswitchb-matches))
;; only one choice, so select it.
(exit-minibuffer))
-
+
(t
;; else there could be some completions
(setq res iswitchb-common-match-string)
(interactive)
(if (or (not iswitchb-require-match)
(iswitchb-existing-buffer-p))
- (throw 'exit nil)))
+ (progn
+ (setq iswitchb-exit 'usefirst)
+ (throw 'exit nil))))
(defun iswitchb-select-buffer-text ()
"Select the buffer named by the prompt.
(setq iswitchb-exit 'findfile)
(exit-minibuffer))
+(eval-when-compile
+ (defvar recentf-list))
+
(defun iswitchb-next-match ()
"Put first element of `iswitchb-matches' at the end of the list."
(interactive)
(let ((next (cadr iswitchb-matches)))
- (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist next))
+ (if (and (null next) iswitchb-virtual-buffers)
+ (setq recentf-list
+ (iswitchb-chop recentf-list
+ (cdr (cadr iswitchb-virtual-buffers))))
+ (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist next)))
(setq iswitchb-rescan t)))
(defun iswitchb-prev-match ()
"Put last element of `iswitchb-matches' at the front of the list."
(interactive)
(let ((prev (car (last iswitchb-matches))))
- (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist prev))
+ (if (and (null prev) iswitchb-virtual-buffers)
+ (setq recentf-list
+ (iswitchb-chop recentf-list
+ (cdr (car (last iswitchb-virtual-buffers)))))
+ (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist prev)))
(setq iswitchb-rescan t)))
(defun iswitchb-chop (list elem)
(setq iswitchb-matches
(let* ((buflist iswitchb-buflist))
(iswitchb-get-matched-buffers iswitchb-text iswitchb-regexp
- buflist)))))
+ buflist))
+ iswitchb-virtual-buffers nil)))
(defun iswitchb-get-matched-buffers (regexp
&optional string-format buffer-list)
ret)
(mapcar
(lambda (x)
-
+
(if do-string
(setq name x) ;We already have the name
(setq name (buffer-name x)))
-
+
(cond
((and (or (and string-format (string-match regexp name))
(and (null string-format)
(string-match (regexp-quote regexp) name)))
-
+
(not (iswitchb-ignore-buffername-p name)))
(setq ret (cons name ret))
)))
(set-window-start win (point-min))
(scroll-other-window))
(set-buffer buf))
-
+
(with-output-to-temp-buffer temp-buf
- (if iswitchb-xemacs
-
+ (if (featurep 'xemacs)
+
;; XEmacs extents are put on by default, doesn't seem to be
;; any way of switching them off.
(display-completion-list (if iswitchb-matches
(or (eq iswitchb-method 'always-frame)
(y-or-n-p "Jump to frame? ")))
(setq newframe (window-frame win))
- (if (not iswitchb-xemacs)
+ (if (fboundp 'select-frame-set-input-focus)
(select-frame-set-input-focus newframe)
(raise-frame newframe)
(select-frame newframe)
((eq iswitchb-method 'otherframe)
(progn
(switch-to-buffer-other-frame buffer)
- (if (not iswitchb-xemacs)
+ (if (fboundp 'select-frame-set-input-focus)
(select-frame-set-input-focus (selected-frame)))
)))))
(if (and iswitchb-newbuffer
(or
(not iswitchb-prompt-newbuffer)
-
+
(and iswitchb-prompt-newbuffer
(y-or-n-p
(format
(get-buffer-window buffer 0) ; better than 'visible
)))
-;;;###autoload
(defun iswitchb-default-keybindings ()
"Set up default keybindings for `iswitchb-buffer'.
Call this function to override the normal bindings. This function also
(global-set-key "\C-x4\C-o" 'iswitchb-display-buffer)
(global-set-key "\C-x5b" 'iswitchb-buffer-other-frame))
-;;;###autoload
(defun iswitchb-buffer ()
"Switch to another buffer.
(setq iswitchb-method iswitchb-default-method)
(iswitchb))
-;;;###autoload
(defun iswitchb-buffer-other-window ()
"Switch to another buffer and show it in another window.
The buffer name is selected interactively by typing a substring.
(setq iswitchb-method 'otherwindow)
(iswitchb))
-;;;###autoload
(defun iswitchb-display-buffer ()
"Display a buffer in another window but don't select it.
The buffer name is selected interactively by typing a substring.
(setq iswitchb-method 'display)
(iswitchb))
-;;;###autoload
(defun iswitchb-buffer-other-frame ()
"Switch to another buffer and show it in another frame.
The buffer name is selected interactively by typing a substring.
(goto-char (point-min)))))
;; add this hook for XEmacs only.
-(if iswitchb-xemacs
+(if (featurep 'xemacs)
(add-hook 'iswitchb-minibuffer-setup-hook
'iswitchb-init-XEmacs-trick))
(define-key iswitchb-mode-map '[backspace] 'backward-delete-char)
(define-key iswitchb-mode-map '[(meta backspace)] 'backward-kill-word))
-(if iswitchb-xemacs
+(if (featurep 'xemacs)
(add-hook 'iswitchb-define-mode-map-hook
'iswitchb-xemacs-backspacekey))
(iswitchb-set-common-completion)
;; Insert the match-status information:
- (insert (iswitchb-completions
+ (insert (iswitchb-completions
contents
- minibuffer-completion-table
- minibuffer-completion-predicate
(not minibuffer-completion-confirm)))))))
-(defun iswitchb-completions (name candidates predicate require-match)
+(eval-when-compile
+ (defvar most-len)
+ (defvar most-is-exact))
+
+(defun iswitchb-output-completion (com)
+ (if (= (length com) most-len)
+ ;; Most is one exact match,
+ ;; note that and leave out
+ ;; for later indication:
+ (ignore
+ (setq most-is-exact t))
+ (substring com most-len)))
+
+(defun iswitchb-completions (name require-match)
"Return the string that is displayed after the user's text.
Modified from `icomplete-completions'."
-
+
(let ((comps iswitchb-matches)
; "-determined" - only one candidate
(open-bracket-determined (if require-match "(" "["))
first)
(setq comps (cons first (cdr comps)))))
+ ;; If no buffers matched, and virtual buffers are being used, then
+ ;; consult the list of past visited files, to see if we can find
+ ;; the file which the user might thought was still open.
+ (when (and iswitchb-use-virtual-buffers (null comps)
+ recentf-list)
+ (setq iswitchb-virtual-buffers nil)
+ (let ((head recentf-list) name)
+ (while head
+ (if (and (setq name (file-name-nondirectory (car head)))
+ (string-match (if iswitchb-regexp
+ iswitchb-text
+ (regexp-quote iswitchb-text)) name)
+ (null (get-file-buffer (car head)))
+ (not (assoc name iswitchb-virtual-buffers))
+ (not (iswitchb-ignore-buffername-p name))
+ (file-exists-p (car head)))
+ (setq iswitchb-virtual-buffers
+ (cons (cons name (car head))
+ iswitchb-virtual-buffers)))
+ (setq head (cdr head)))
+ (setq iswitchb-virtual-buffers (nreverse iswitchb-virtual-buffers)
+ comps (mapcar 'car iswitchb-virtual-buffers))
+ (let ((comp comps))
+ (while comp
+ (put-text-property 0 (length (car comp))
+ 'face 'font-lock-builtin-face
+ (car comp))
+ (setq comp (cdr comp))))))
+
(cond ((null comps) (format " %sNo match%s"
open-bracket-determined
close-bracket-determined))
"")
(if (not iswitchb-use-fonts) " [Matched]")))
(t ;multiple matches
+ (if (and iswitchb-max-to-show
+ (> (length comps) iswitchb-max-to-show))
+ (setq comps
+ (append
+ (let ((res nil)
+ (comp comps)
+ (end (/ iswitchb-max-to-show 2)))
+ (while (>= (setq end (1- end)) 0)
+ (setq res (cons (car comp) res)
+ comp (cdr comp)))
+ (nreverse res))
+ (list "...")
+ (nthcdr (- (length comps)
+ (/ iswitchb-max-to-show 2)) comps))))
(let* (
;;(most (try-completion name candidates predicate))
(most nil)
(most-len (length most))
most-is-exact
- first
(alternatives
- (apply
- (function concat)
- (cdr (apply
- (function nconc)
- (mapcar '(lambda (com)
- (if (= (length com) most-len)
- ;; Most is one exact match,
- ;; note that and leave out
- ;; for later indication:
- (progn
- (setq most-is-exact t)
- ())
- (list ","
- (substring com
- most-len))))
- comps))))))
+ (mapconcat (if most 'iswitchb-output-completion
+ 'identity) comps ",")))
(concat
;; put in common completion item -- what you get by
;; pressing tab
- (if (> (length iswitchb-common-match-string) (length name))
+ (if (and (stringp iswitchb-common-match-string)
+ (> (length iswitchb-common-match-string) (length name)))
(concat open-bracket-determined
(substring iswitchb-common-match-string
(length name))
(concat open-bracket-determined
(substring most (length name))
close-bracket-determined))
-
+
;; list all alternatives
open-bracket-prospects
(if most-is-exact
(if (and (boundp 'iswitchb-eoinput)
iswitchb-eoinput)
-
+
(if (> iswitchb-eoinput (point-max))
;; Oops, got rug pulled out from under us - reinit:
(setq iswitchb-eoinput (point-max))
(let ((buffer-undo-list buffer-undo-list )) ; prevent entry
(delete-region iswitchb-eoinput (point-max))))
-
+
;; Reestablish the local variable 'cause minibuffer-setup is weird:
(make-local-variable 'iswitchb-eoinput)
(setq iswitchb-eoinput 1)))
"Return non-nil iff we should ignore case when matching.
See the variable `iswitchb-case' for details."
(if iswitchb-case
- (if iswitchb-xemacs
+ (if (featurep 'xemacs)
(isearch-no-upper-case-p iswitchb-text)
(isearch-no-upper-case-p iswitchb-text t))))
(provide 'iswitchb)
+;;; arch-tag: d74198ae-753f-44f2-b34f-0c515398d90a
;;; iswitchb.el ends here