;;; iswitchb.el --- switch between buffers using substrings
-;; Copyright (C) 1996, 1997, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1997, 2000, 2001, 2003 Free Software Foundation, Inc.
-;; Author: Stephen Eglen <stephen@anc.ed.ac.uk>
-;; Maintainer: Stephen Eglen <stephen@anc.ed.ac.uk>
+;; Author: Stephen Eglen <stephen@gnu.org>
+;; Maintainer: Stephen Eglen <stephen@gnu.org>
;; Keywords: completion convenience
;; location: http://www.anc.ed.ac.uk/~stephen/emacs/
;; 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
;;; Example
-;;If I have two buffers called "123456" and "123", with "123456" the
-;;most recent, when I use iswitchb, I first of all get presented with
-;;the list of all the buffers
+;; If I have two buffers called "123456" and "123", with "123456" the
+;; most recent, when I use iswitchb, I first of all get presented with
+;; the list of all the buffers
;;
;; iswitch {123456,123}
;;
;; 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.
;; wanted the second in the list, I could press C-s to move it to the
;; top of the list and then RET to select it.
;;
-;;However, If I type 4, I only have one match left:
+;; However, if I type 4, I only have one match left:
;; iswitch 234[123456] [Matched]
;;
-;;Since there is only one matching buffer left, it is given in [] and we
-;;see the text [Matched] afterwards. I can now press TAB or RET to go
-;;to that buffer.
+;; Since there is only one matching buffer left, it is given in [] and we
+;; see the text [Matched] afterwards. I can now press TAB or RET to go
+;; to that buffer.
;;
;; If however, I now type "a":
;; iswitch 234a [No match]
;; If you find that the file you are after is not in a buffer, you can
;; press C-x C-f to immediately drop into find-file.
-;;
-;; See the doc string of iswitchb for full keybindings and features.
-;; (describe-function 'iswitchb)
+;; See the doc string of iswitchb for full keybindings and features.
+;; (describe-function 'iswitchb)
;; Case matching: The case of strings when matching can be ignored or
;; used depending on the value of iswitchb-case (default is the same
;; See the User Variables section below for easy ways to change the
;; functionality of the program. These are accessible using the
;; custom package.
-;; To modify the keybindings, use the hook provided. For example:
-;;(add-hook 'iswitchb-define-mode-map-hook
-;; 'iswitchb-my-keys)
+;; To modify the keybindings, use something like:
;;
+;;(add-hook 'iswitchb-mode-hook 'iswitchb-my-keys)
;;(defun iswitchb-my-keys ()
;; "Add my keybindings for iswitchb."
-;; (define-key iswitchb-mode-map " " 'iswitchb-next-match)
-;; )
+;; (define-key iswitchb-mode-map " " 'iswitchb-next-match))
;;
;; Seeing all the matching buffers
;;
;; If you have many matching buffers, they may not all fit onto one
-;; line of the minibuffer. In this case, you should use rsz-mini
-;; (resize-minibuffer-mode). You can also limit iswitchb so that it
+;; line of the minibuffer. In Emacs 21, the variable
+;; `resize-mini-windows' controls how many lines of the minibuffer can
+;; be seen. For older versions of emacs, you can use
+;; `resize-minibuffer-mode'. You can also limit iswitchb so that it
;; only shows a certain number of lines -- see the documentation for
;; `iswitchb-minibuffer-setup-hook'.
;; for the normal buffer selection routine `read-buffer'. To use
;; iswitch for all buffer selections in Emacs, add:
;; (setq read-buffer-function 'iswitchb-read-buffer)
-;; (This variable should be present in Emacs 20.3+)
+;; (This variable was introduced in Emacs 20.3.)
;; XEmacs users can get the same behaviour by doing:
;; (defalias 'read-buffer 'iswitchb-read-buffer)
;; since `read-buffer' is defined in lisp.
+;; Using 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
+;; choices. PROMPT is a string to prompt with. CHOICES is a list of
+;; strings to choose from."
+;; (let ((iswitchb-make-buflist-hook
+;; (lambda ()
+;; (setq iswitchb-temp-buflist choices))))
+;; (iswitchb-read-buffer prompt)))
+;;
+;; example:
+;; (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).
+
+;; Window managers: Switching frames/focus follows mouse; Sawfish.
+
+;; If you switch to a buffer that is visible in another frame,
+;; iswitchb can switch focus to that frame. If your window manager
+;; uses "click to focus" policy for window selection, you should also
+;; set focus-follows-mouse to nil.
+
+;; iswitch functionality has also been implemented for switching
+;; between windows in the Sawfish window manager.
+
;; Regexp matching
;; There is limited provision for regexp matching within iswitchb,
:link '(url-link "http://www.anc.ed.ac.uk/~stephen/emacs/")
:link '(emacs-library-link :tag "Lisp File" "iswitchb.el"))
-;;;###autoload
-(defcustom iswitchb-mode nil
- "Toggle Iswitchb mode.
-Setting this variable directly does not take effect;
-use either \\[customize] or the function `iswitchb-mode'."
- :set (lambda (symbol value)
- (iswitchb-mode (or value 0)))
- :initialize 'custom-initialize-default
- :group 'iswitchb
- :version "21.1"
- :type 'boolean)
-
-(defcustom iswitchb-mode-hook nil
- "Hook run at the end of function `iswitchb-mode'."
- :group 'iswitchb
- :type 'hook)
-
(defcustom iswitchb-case case-fold-search
"*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
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-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
+window with completion alternatives, or `iswitchb-next-match' or
+`iswitchb-prev-match', which cycle the buffer list."
+ :type 'hook
:group 'iswitchb)
;;; Examples for setting the value of iswitchb-buffer-ignore
:type 'boolean
:group 'iswitchb)
-(defcustom iswitchb-define-mode-map-hook nil
- "Hook to define keys in `iswitchb-mode-map' for extra keybindings."
- :type 'hook
- :group 'iswitchb)
-
(defcustom iswitchb-use-fonts t
"*Non-nil means use font-lock fonts for showing first match."
:type 'boolean
(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.")
(defvar iswitchb-bufs-in-frame nil
"List of the buffers visible in the current frame.")
+(defvar iswitchb-minibuf-depth nil
+ "Value we expect to be returned by `minibuffer-depth' in the minibuffer.")
+
;;; FUNCTIONS
;;; ISWITCHB KEYMAP
(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 buf)
-
- (setq prompt (format "iswitch "))
- (setq buf (iswitchb-read-buffer prompt))
+ (let* ((prompt "iswitch ")
+ (buf (iswitchb-read-buffer prompt)))
;;(message "chosen text %s" iswitchb-final-text)
;; Choose the buffer name: either the text typed in, or the head
(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
- '(("dummy".1)) ;table
+ '(("dummy" . 1)) ;table
nil ;predicate
nil ;require-match [handled elsewhere]
nil ;initial-contents
'iswitchb-history)))
+ (if (get-buffer iswitchb-final-text)
+ ;; This happens for example if the buffer was chosen with the mouse.
+ (setq iswitchb-matches (list iswitchb-final-text)))
+
;; Handling the require-match must be done in a better way.
(if (and require-match (not (iswitchb-existing-buffer-p)))
(error "Must specify valid buffer"))
(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
(interactive)
(let (res)
(cond ((not iswitchb-matches)
- (iswitchb-completion-help))
-
+ (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)
(delete-region (minibuffer-prompt-end) (point))
(insert res))
;; else nothing to complete
- (iswitchb-completion-help)
+ (run-hooks 'iswitchb-cannot-complete-hook)
)))))
;;; TOGGLE FUNCTIONS
it is put to the start of the list."
(setq iswitchb-buflist
(let* ((iswitchb-current-buffers (iswitchb-get-buffers-in-frames))
- (iswitchb-temp-buflist
- (delq nil
- (mapcar
- (lambda (x)
- (let ((b-name (buffer-name x)))
- (if (not
- (or
- (iswitchb-ignore-buffername-p b-name)
- (memq b-name iswitchb-current-buffers)))
- b-name)))
- (buffer-list (and iswitchb-use-frame-buffer-list
- (selected-frame)))))))
- (nconc iswitchb-temp-buflist iswitchb-current-buffers)
+ (iswitchb-temp-buflist
+ (delq nil
+ (mapcar
+ (lambda (x)
+ (let ((b-name (buffer-name x)))
+ (if (not
+ (or
+ (iswitchb-ignore-buffername-p b-name)
+ (memq b-name iswitchb-current-buffers)))
+ b-name)))
+ (buffer-list (and iswitchb-use-frame-buffer-list
+ (selected-frame)))))))
+ (setq iswitchb-temp-buflist
+ (nconc iswitchb-temp-buflist iswitchb-current-buffers))
(run-hooks 'iswitchb-make-buflist-hook)
- ;; Should this be after the hooks, or should the hooks be the
+ ;; Should this be after the hooks, or should the hooks be the
;; final thing to be run?
(if default
(progn
(lambda (elem)
(setq iswitchb-temp-buflist (delq elem iswitchb-temp-buflist)))
lst)
- (nconc iswitchb-temp-buflist lst))
+ (setq iswitchb-temp-buflist (nconc iswitchb-temp-buflist lst)))
(defun iswitchb-get-buffers-in-frames (&optional current)
"Return the list of buffers that are visible in the current frame.
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))
)))
(cons (car las) lis))))
(defun iswitchb-completion-help ()
- "Show possible completions in a *Buffer Completions* buffer."
+ "Show possible completions in a *Completions* buffer."
;; we could allow this buffer to be used to select match, but I think
;; choose-completion-string will need redefining, so it just inserts
;; choice with out any previous input.
(interactive)
(setq iswitchb-rescan nil)
- (let ((completion-setup-hook nil) ;disable fancy highlight/selection.
- (buf (current-buffer))
- (temp-buf "*Buffer Completions*")
- (win)
- (again (eq last-command this-command)))
+ (let ((buf (current-buffer))
+ (temp-buf "*Completions*")
+ (win))
- (if again
+ (if (eq last-command this-command)
;; scroll buffer
(progn
(set-buffer temp-buf)
(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))
- (raise-frame newframe)
- (select-frame newframe)
- (select-window win)
- (if (not iswitchb-xemacs)
- ;; reposition mouse to make frame active. not needed in XEmacs
- ;; This line came from the other-frame defun in Emacs.
- (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
+ (if (fboundp 'select-frame-set-input-focus)
+ (select-frame-set-input-focus newframe)
+ (raise-frame newframe)
+ (select-frame newframe)
+ )
+ (select-window win))
(t
;; No buffer in other frames...
(switch-to-buffer buffer)
((eq iswitchb-method 'otherframe)
(progn
(switch-to-buffer-other-frame buffer)
- (if (not iswitchb-xemacs)
- (set-mouse-position (selected-frame) (1- (frame-width)) 0))
+ (if (fboundp 'select-frame-set-input-focus)
+ (select-frame-set-input-focus (selected-frame)))
)))))
(defun iswitchb-possible-new-buffer (buf)
(if (and iswitchb-newbuffer
(or
(not iswitchb-prompt-newbuffer)
-
+
(and iswitchb-prompt-newbuffer
(y-or-n-p
(format
(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-string (iswitchb-completions
- contents
- minibuffer-completion-table
- minibuffer-completion-predicate
- (not minibuffer-completion-confirm)))))))
+ (insert (iswitchb-completions
+ contents
+ (not minibuffer-completion-confirm)))))))
-(defun iswitchb-completions (name candidates predicate require-match)
+(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 "(" "["))
(most nil)
(most-len (length most))
most-is-exact
- first
(alternatives
(apply
(function 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
(defun iswitchb-minibuffer-setup ()
"Set up minibuffer for `iswitchb-buffer'.
Copied from `icomplete-minibuffer-setup-hook'."
- (if (iswitchb-entryfn-p)
- (progn
-
- (make-local-variable 'iswitchb-use-mycompletion)
- (setq iswitchb-use-mycompletion t)
- (make-local-hook 'pre-command-hook)
- (add-hook 'pre-command-hook
- 'iswitchb-pre-command
- nil t)
- (make-local-hook 'post-command-hook)
- (add-hook 'post-command-hook
- 'iswitchb-post-command
- nil t)
-
- (run-hooks 'iswitchb-minibuffer-setup-hook))))
+ (when (iswitchb-entryfn-p)
+ (set (make-local-variable 'iswitchb-use-mycompletion) t)
+ (add-hook 'pre-command-hook 'iswitchb-pre-command nil t)
+ (add-hook 'post-command-hook 'iswitchb-post-command nil t)
+ (run-hooks 'iswitchb-minibuffer-setup-hook)))
(defun iswitchb-pre-command ()
"Run before command in `iswitchb-buffer'."
(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)))
(defun iswitchb-entryfn-p ()
"Return non-nil if we are using `iswitchb-buffer'."
- ;; Testing if `iswitchb-prepost-hooks' is bound does not work when
- ;; we're invoking a recursive mini-buffer from an Iswitchb buffer.
- ;; In this case, `iswitchb-prepost-hooks' is bound in the second
- ;; mini-buffer, although it's not an Iswitchb buffer.
- (memq this-command
- '(iswitchb-buffer iswitchb-buffer-other-frame
- iswitchb-display-buffer
- iswitchb-buffer-other-window)))
+ (eq iswitchb-minibuf-depth (minibuffer-depth)))
(defun iswitchb-summaries-to-end ()
"Move the summaries to the end of the list.
"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))))
;;;###autoload
-(defun iswitchb-mode (&optional arg)
+(define-minor-mode iswitchb-mode
"Toggle Iswitchb global minor mode.
With arg, turn Iswitchb mode on if and only iff ARG is positive.
This mode enables switching between buffers using substrings. See
`iswitchb' for details."
- (interactive "P")
- (setq iswitchb-mode
- (if arg
- (> (prefix-numeric-value arg) 0)
- (not iswitchb-mode)))
+ nil nil iswitchb-global-map :global t :group 'iswitchb
(if iswitchb-mode
(add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
- (remove-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup))
- (run-hooks 'iswitchb-mode-hook)
- (if (interactive-p)
- (message "Iswitchb mode %sabled"
- (if iswitchb-mode "en" "dis"))))
-
-(unless (assq 'iswitchb-mode minor-mode-map-alist)
- (push (cons 'iswitchb-mode iswitchb-global-map)
- minor-mode-map-alist))
+ (remove-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)))
(provide 'iswitchb)
+;;; arch-tag: d74198ae-753f-44f2-b34f-0c515398d90a
;;; iswitchb.el ends here
HCoop / bpt / emacs.git / blobdiff