1 ;;; iswitchb.el --- switch between buffers using substrings
3 ;; Copyright (C) 1996, 1997, 2000, 2001 Free Software Foundation, Inc.
5 ;; Author: Stephen Eglen <stephen@gnu.org>
6 ;; Maintainer: Stephen Eglen <stephen@gnu.org>
7 ;; Keywords: completion convenience
8 ;; location: http://www.anc.ed.ac.uk/~stephen/emacs/
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
30 ;; To get the functions in this package bound to keys, use
31 ;; M-x iswitchb-mode or customize the option `iswitchb-mode'.
33 ;; As you type in a substring, the list of buffers currently matching
34 ;; the substring is displayed as you type. The list is ordered so
35 ;; that the most recent buffers visited come at the start of the list.
36 ;; The buffer at the start of the list will be the one visited when
37 ;; you press return. By typing more of the substring, the list is
38 ;; narrowed down so that gradually the buffer you want will be at the
39 ;; top of the list. Alternatively, you can use C-s and C-r to rotate
40 ;; buffer names in the list until the one you want is at the top of
41 ;; the list. Completion is also available so that you can see what is
42 ;; common to all of the matching buffers as you type.
44 ;; This code is similar to a couple of other packages. Michael R Cook
45 ;; <cook@sightpath.com> wrote a similar buffer switching package, but
46 ;; does exact matching rather than substring matching on buffer names.
47 ;; I also modified a couple of functions from icomplete.el to provide
48 ;; the completion feedback in the minibuffer.
52 ;;If I have two buffers called "123456" and "123", with "123456" the
53 ;;most recent, when I use iswitchb, I first of all get presented with
54 ;;the list of all the buffers
56 ;; iswitch {123456,123}
59 ;; iswitch 2[3]{123456,123}
61 ;; The list in {} are the matching buffers, most recent first (buffers
62 ;; visible in the current frame are put at the end of the list by
63 ;; default). At any time I can select the item at the head of the
64 ;; list by pressing RET. I can also bring the put the first element
65 ;; at the end of the list by pressing C-s, or put the last element at
66 ;; the head of the list by pressing C-r. The item in [] indicates
67 ;; what can be added to my input by pressing TAB. In this case, I
68 ;; will get "3" added to my input. So, press TAB:
69 ;; iswitch 23{123456,123}
71 ;; At this point, I still have two matching buffers.
72 ;; If I want the first buffer in the list, I simply press RET. If I
73 ;; wanted the second in the list, I could press C-s to move it to the
74 ;; top of the list and then RET to select it.
76 ;;However, If I type 4, I only have one match left:
77 ;; iswitch 234[123456] [Matched]
79 ;;Since there is only one matching buffer left, it is given in [] and we
80 ;;see the text [Matched] afterwards. I can now press TAB or RET to go
83 ;; If however, I now type "a":
84 ;; iswitch 234a [No match]
85 ;; There are no matching buffers. If I press RET or TAB, I can be
86 ;; prompted to create a new buffer called "234a".
88 ;; Of course, where this function comes in really useful is when you
89 ;; can specify the buffer using only a few keystrokes. In the above
90 ;; example, the quickest way to get to the "123456" buffer would be
91 ;; just to type 4 and then RET (assuming there isn't any newer buffer
92 ;; with 4 in its name).
94 ;; To see a full list of all matching buffers in a separate buffer,
95 ;; hit ? or press TAB when there are no further completions to the
96 ;; substring. Repeated TAB presses will scroll you through this
99 ;; The buffer at the head of the list can be killed by pressing C-k.
100 ;; If the buffer needs saving, you will be queried before the buffer
103 ;; If you find that the file you are after is not in a buffer, you can
104 ;; press C-x C-f to immediately drop into find-file.
107 ;; See the doc string of iswitchb for full keybindings and features.
108 ;; (describe-function 'iswitchb)
110 ;; Case matching: The case of strings when matching can be ignored or
111 ;; used depending on the value of iswitchb-case (default is the same
112 ;; as case-fold-search, normally t). Imagine you have the following
115 ;; INBOX *info* *scratch*
117 ;; Then these will be the matching buffers, depending on how you type
118 ;; the two letters `in' and the value of iswitchb-case:
120 ;; iswitchb-case user input | matching buffers
121 ;; ----------------------------------------------
123 ;; t in | INBOX, *info*
129 ;; See the User Variables section below for easy ways to change the
130 ;; functionality of the program. These are accessible using the
132 ;; To modify the keybindings, use something like:
134 ;;(add-hook 'iswitchb-mode-hook 'iswitchb-my-keys)
135 ;;(defun iswitchb-my-keys ()
136 ;; "Add my keybindings for iswitchb."
137 ;; (define-key iswitchb-mode-map " " 'iswitchb-next-match))
139 ;; Seeing all the matching buffers
141 ;; If you have many matching buffers, they may not all fit onto one
142 ;; line of the minibuffer. In Emacs 21, the variable
143 ;; `resize-mini-windows' controls how many lines of the minibuffer can
144 ;; be seen. For older versions of emacs, you can use
145 ;; `resize-minibuffer-mode'. You can also limit iswitchb so that it
146 ;; only shows a certain number of lines -- see the documentation for
147 ;; `iswitchb-minibuffer-setup-hook'.
149 ;; Changing the list of buffers
151 ;; By default, the list of current buffers is most recent first,
152 ;; oldest last, with the exception that the buffers visible in the
153 ;; current frame are put at the end of the list. A hook exists to
154 ;; allow other functions to order the list. For example, if you add:
156 ;; (add-hook 'iswitchb-make-buflist-hook 'iswitchb-summaries-to-end)
158 ;; then all buffers matching "Summary" are moved to the end of the
159 ;; list. (I find this handy for keeping the INBOX Summary and so on
160 ;; out of the way.) It also moves buffers matching "output\*$" to the
161 ;; end of the list (these are created by AUC TeX when compiling.)
162 ;; Other functions could be made available which alter the list of
163 ;; matching buffers (either deleting or rearranging elements.)
167 ;; If you have font-lock loaded, the first matching buffer is
168 ;; highlighted. To switch this off, set (setq iswitchb-use-fonts nil)
169 ;; I don't use font-lock that much, so I've hardcoded the faces. If
170 ;; this is too harsh, let me know. Colouring of the matching buffer
171 ;; name was suggested by Carsten Dominik (dominik@strw.leidenuniv.nl)
173 ;; Replacement for read-buffer
175 ;; iswitchb-read-buffer has been written to be a drop in replacement
176 ;; for the normal buffer selection routine `read-buffer'. To use
177 ;; iswitch for all buffer selections in Emacs, add:
178 ;; (setq read-buffer-function 'iswitchb-read-buffer)
179 ;; (This variable should be present in Emacs 20.3+)
180 ;; XEmacs users can get the same behaviour by doing:
181 ;; (defalias 'read-buffer 'iswitchb-read-buffer)
182 ;; since `read-buffer' is defined in lisp.
186 ;; There is limited provision for regexp matching within iswitchb,
187 ;; enabled through `iswitchb-regexp'. This allows you to type `c$'
188 ;; for example and see all buffer names ending in `c'. This facility
189 ;; is quite limited though in two respects. First, you can't
190 ;; currently type in expressions like `[0-9]' directly -- you have to
191 ;; type them in when iswitchb-regexp is nil and then toggle on the
192 ;; regexp functionality. Likewise, don't enter an expression
193 ;; containing `\' in regexp mode. If you try, iswitchb gets confused,
194 ;; so just hit C-g and try again. Secondly, no completion mechanism
195 ;; is currently offered when regexp searching.
201 ;; Thanks to Jari Aalto <jari.aalto@poboxes.com> for help with the
202 ;; first version of this package, iswitch-buffer. Thanks also to many
203 ;; others for testing earlier versions.
207 ;; CL needed for cadr and last
208 (if (not (and (fboundp 'cadr)
212 ;; Set up the custom library.
213 ;; taken from http://www.dina.kvl.dk/~abraham/custom/
218 (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
219 nil ;; We've got what we needed
220 ;; We have the old custom-library, hack around it!
221 (defmacro defgroup (&rest args)
223 (defmacro defcustom (var value doc &rest args)
224 `(defvar ,var ,value ,doc))))
228 ;; These are some things you might want to change.
230 (defgroup iswitchb nil
231 "Switch between buffers using substrings."
234 :link '(emacs-commentary-link :tag "Commentary" "iswitchb.el")
235 :link '(url-link "http://www.anc.ed.ac.uk/~stephen/emacs/")
236 :link '(emacs-library-link :tag "Lisp File" "iswitchb.el"))
238 (defcustom iswitchb-case case-fold-search
239 "*Non-nil if searching of buffer names should ignore case.
240 If this is non-nil but the user input has any upper case letters, matching
241 is temporarily case sensitive."
245 (defcustom iswitchb-buffer-ignore
247 "*List of regexps or functions matching buffer names to ignore.
248 For example, traditional behavior is not to list buffers whose names begin
249 with a space, for which the regexp is `^ '. See the source file for
250 example functions that filter buffernames."
251 :type '(repeat regexp)
254 (defcustom iswitchb-cannot-complete-hook 'iswitchb-completion-help
255 "*Hook run when `iswitchb-complete' can't complete any more.
256 The most useful values are `iswitchb-completion-help', which pops up a
257 window with completion alternatives, or `iswitchb-next-match' or
258 `iswitchb-prev-match', which cycle the buffer list."
262 ;;; Examples for setting the value of iswitchb-buffer-ignore
263 ;(defun iswitchb-ignore-c-mode (name)
264 ; "Ignore all c mode buffers -- example function for iswitchb."
267 ; (string-match "^C$" mode-name)))
269 ;(setq iswitchb-buffer-ignore '("^ " iswitchb-ignore-c-mode))
270 ;(setq iswitchb-buffer-ignore '("^ " "\\.c$" "\\.h$"))
272 (defcustom iswitchb-default-method 'always-frame
273 "*How to switch to new buffer when using `iswitchb-buffer'.
275 `samewindow' Show new buffer in same window
276 `otherwindow' Show new buffer in another window (same frame)
277 `display' Display buffer in another window without switching to it
278 `otherframe' Show new buffer in another frame
279 `maybe-frame' If a buffer is visible in another frame, prompt to ask if you
280 you want to see the buffer in the same window of the current
281 frame or in the other frame.
282 `always-frame' If a buffer is visible in another frame, raise that
283 frame. Otherwise, visit the buffer in the same window."
284 :type '(choice (const samewindow)
289 (const always-frame))
292 (defcustom iswitchb-regexp nil
293 "*Non-nil means that `iswitchb' will do regexp matching.
294 Value can be toggled within `iswitchb' using `iswitchb-toggle-regexp'."
298 (defcustom iswitchb-newbuffer t
299 "*Non-nil means create new buffer if no buffer matches substring.
300 See also `iswitchb-prompt-newbuffer'."
304 (defcustom iswitchb-prompt-newbuffer t
305 "*Non-nil means prompt user to confirm before creating new buffer.
306 See also `iswitchb-newbuffer'."
310 (defcustom iswitchb-use-fonts t
311 "*Non-nil means use font-lock fonts for showing first match."
315 (defcustom iswitchb-use-frame-buffer-list nil
316 "*Non-nil means use the currently selected frame's buffer list."
320 (defcustom iswitchb-make-buflist-hook nil
321 "Hook to run when list of matching buffers is created."
325 (defvar iswitchb-all-frames 'visible
326 "*Argument to pass to `walk-windows' when finding visible buffers.
327 See documentation of `walk-windows' for useful values.")
329 (defcustom iswitchb-minibuffer-setup-hook nil
330 "Iswitchb-specific customization of minibuffer setup.
332 This hook is run during minibuffer setup iff `iswitchb' will be active.
333 It is intended for use in customizing iswitchb for interoperation
334 with other packages."
337 ;;; \(add-hook 'iswitchb-minibuffer-setup-hook
340 ;;; \(make-local-variable 'resize-minibuffer-window-max-height)
341 ;;; \(setq resize-minibuffer-window-max-height 3))))
343 ;;; will constrain rsz-mini to a maximum minibuffer height of 3 lines when
344 ;;; iswitchb is running. Copied from `icomplete-minibuffer-setup-hook'."
348 ;; Do we need the variable iswitchb-use-mycompletion?
350 ;;; Internal Variables
352 (defvar iswitchb-method nil
353 "Stores the method for viewing the selected buffer.
354 Its value is one of `samewindow', `otherwindow', `display', `otherframe',
355 `maybe-frame' or `always-frame'. See `iswitchb-default-method' for
358 (defvar iswitchb-eoinput 1
359 "Point where minibuffer input ends and completion info begins.
360 Copied from `icomplete-eoinput'.")
361 (make-variable-buffer-local 'iswitchb-eoinput)
363 (defvar iswitchb-buflist nil
364 "Stores the current list of buffers that will be searched through.
365 The list is ordered, so that the most recent buffers come first,
366 although by default, the buffers visible in the current frame are put
367 at the end of the list. Created by `iswitchb-make-buflist'.")
369 ;; todo -- is this necessary?
371 (defvar iswitchb-use-mycompletion nil
372 "Non-nil means use `iswitchb-buffer' completion feedback.
373 Should only be set to t by iswitchb functions, so that it doesn't
374 interfere with other minibuffer usage.")
376 (defvar iswitchb-change-word-sub nil
377 "Private variable used by `iswitchb-word-matching-substring'.")
379 (defvar iswitchb-common-match-string nil
380 "Stores the string that is common to all matching buffers.")
382 (defvar iswitchb-rescan nil
383 "Non-nil means we need to regenerate the list of matching buffers.")
385 (defvar iswitchb-text nil
386 "Stores the users string as it is typed in.")
388 (defvar iswitchb-matches nil
389 "List of buffers currently matching `iswitchb-text'.")
391 (defvar iswitchb-mode-map
392 (let ((map (make-sparse-keymap)))
393 (set-keymap-parent map minibuffer-local-map)
394 (define-key map "?" 'iswitchb-completion-help)
395 (define-key map "\C-s" 'iswitchb-next-match)
396 (define-key map "\C-r" 'iswitchb-prev-match)
397 (define-key map "\t" 'iswitchb-complete)
398 (define-key map "\C-j" 'iswitchb-select-buffer-text)
399 (define-key map "\C-t" 'iswitchb-toggle-regexp)
400 (define-key map "\C-x\C-f" 'iswitchb-find-file)
401 (define-key map "\C-c" 'iswitchb-toggle-case)
402 (define-key map "\C-k" 'iswitchb-kill-buffer)
403 (define-key map "\C-m" 'iswitchb-exit-minibuffer)
405 "Minibuffer keymap for `iswitchb-buffer'.")
407 (defvar iswitchb-global-map
408 (let ((map (make-sparse-keymap)))
409 (substitute-key-definition 'switch-to-buffer ; normally C-x b
410 'iswitchb-buffer map global-map)
411 (substitute-key-definition 'switch-to-buffer-other-window ; C-x 4 b
412 'iswitchb-buffer-other-window map global-map)
413 (substitute-key-definition 'switch-to-buffer-other-frame ; C-x 5 b
414 'iswitchb-buffer-other-frame map global-map)
415 (substitute-key-definition 'display-buffer ; C-x 4 C-o
416 'iswitchb-display-buffer map global-map)
418 "Global keymap for `iswtichb-mode'.")
420 (defvar iswitchb-history nil
421 "History of buffers selected using `iswitchb-buffer'.")
423 (defvar iswitchb-exit nil
424 "Flag to monitor how `iswitchb-buffer' exits.
425 If equal to `takeprompt', we use the prompt as the buffer name to be
428 (defvar iswitchb-buffer-ignore-orig nil
429 "Stores original value of `iswitchb-buffer-ignore'.")
431 (defvar iswitchb-xemacs (string-match "XEmacs" (emacs-version))
432 "Non-nil if we are running XEmacs. Otherwise, assume we are running Emacs.")
434 (defvar iswitchb-default nil
435 "Default buffer for iswitchb.")
437 ;; The following variables are needed to keep the byte compiler quiet.
438 (defvar iswitchb-require-match nil
439 "Non-nil if matching buffer must be selected.")
441 (defvar iswitchb-temp-buflist nil
442 "Stores a temporary version of the buffer list being created.")
444 (defvar iswitchb-bufs-in-frame nil
445 "List of the buffers visible in the current frame.")
447 (defvar iswitchb-minibuf-depth nil
448 "Value we expect to be returned by `minibuffer-depth' in the minibuffer.")
453 (defun iswitchb-define-mode-map ()
454 "Set up the keymap for `iswitchb-buffer'.
455 This is obsolete. Use \\[iswitchb-mode] or customize the
456 variable `iswitchb-mode'."
459 ;; generated every time so that it can inherit new functions.
460 ;;(or iswitchb-mode-map
462 (setq map (copy-keymap minibuffer-local-map))
463 (define-key map "?" 'iswitchb-completion-help)
464 (define-key map "\C-s" 'iswitchb-next-match)
465 (define-key map "\C-r" 'iswitchb-prev-match)
466 (define-key map "\t" 'iswitchb-complete)
467 (define-key map "\C-j" 'iswitchb-select-buffer-text)
468 (define-key map "\C-t" 'iswitchb-toggle-regexp)
469 (define-key map "\C-x\C-f" 'iswitchb-find-file)
470 ;;(define-key map "\C-a" 'iswitchb-toggle-ignore)
471 (define-key map "\C-c" 'iswitchb-toggle-case)
472 (define-key map "\C-k" 'iswitchb-kill-buffer)
473 (define-key map "\C-m" 'iswitchb-exit-minibuffer)
474 (setq iswitchb-mode-map map)
475 (run-hooks 'iswitchb-define-mode-map-hook)))
479 "Switch to buffer matching a substring.
480 As you type in a string, all of the buffers matching the string are
481 displayed. When you have found the buffer you want, it can then be
482 selected. As you type, most keys have their normal keybindings,
483 except for the following:
484 \\<iswitchb-mode-map>
486 RET Select the buffer at the front of the list of matches. If the
487 list is empty, possibly prompt to create new buffer.
489 \\[iswitchb-select-buffer-text] Select the current prompt as the buffer.
490 If no buffer is found, prompt for a new one.
492 \\[iswitchb-next-match] Put the first element at the end of the list.
493 \\[iswitchb-prev-match] Put the last element at the start of the list.
494 \\[iswitchb-complete] Complete a common suffix to the current string that
495 matches all buffers. If there is only one match, select that buffer.
496 If there is no common suffix, show a list of all matching buffers
497 in a separate window.
498 \\[iswitchb-toggle-regexp] Toggle regexp searching.
499 \\[iswitchb-toggle-case] Toggle case-sensitive searching of buffer names.
500 \\[iswitchb-completion-help] Show list of matching buffers in separate window.
501 \\[iswitchb-find-file] Exit iswitchb and drop into `find-file'.
502 \\[iswitchb-kill-buffer] Kill buffer at head of buffer list."
503 ;;\\[iswitchb-toggle-ignore] Toggle ignoring certain buffers (see \
504 ;;`iswitchb-buffer-ignore')
506 (let* ((prompt "iswitch ")
507 (buf (iswitchb-read-buffer prompt)))
509 ;;(message "chosen text %s" iswitchb-final-text)
510 ;; Choose the buffer name: either the text typed in, or the head
511 ;; of the list of matches
513 (cond ( (eq iswitchb-exit 'findfile)
514 (call-interactively 'find-file))
518 ;;(message "go to buf %s" buf)
519 ;; Check buf is non-nil.
522 ;; buffer exists, so view it and then exit
523 (iswitchb-visit-buffer buf)
524 ;; else buffer doesn't exist
525 (iswitchb-possible-new-buffer buf)))
529 (defun iswitchb-read-buffer (prompt &optional default require-match)
530 "Replacement for the built-in `read-buffer'.
531 Return the name of a buffer selected.
532 PROMPT is the prompt to give to the user. DEFAULT if given is the default
533 buffer to be selected, which will go to the front of the list.
534 If REQUIRE-MATCH is non-nil, an existing-buffer must be selected."
539 (icomplete-mode nil) ;; prevent icomplete starting up
540 ;; can only use fonts if they have been bound.
541 (iswitchb-use-fonts (and iswitchb-use-fonts
542 (boundp 'font-lock-comment-face)
543 (boundp 'font-lock-function-name-face))))
545 (iswitchb-define-mode-map)
546 (setq iswitchb-exit nil)
547 (setq iswitchb-rescan t)
548 (setq iswitchb-text "")
549 (setq iswitchb-default
550 (if (bufferp default)
551 (buffer-name default)
553 (iswitchb-make-buflist iswitchb-default)
554 (iswitchb-set-matches)
556 ((minibuffer-local-completion-map iswitchb-mode-map)
557 (iswitchb-prepost-hooks t)
558 ;; Record the minibuffer depth that we expect to find once
559 ;; the minibuffer is set up and iswitchb-entryfn-p is called.
560 (iswitchb-minibuf-depth (1+ (minibuffer-depth)))
561 (iswitchb-require-match require-match))
562 ;; prompt the user for the buffer name
563 (setq iswitchb-final-text (completing-read
565 '(("dummy" . 1)) ;table
567 nil ;require-match [handled elsewhere]
568 nil ;initial-contents
570 (if (get-buffer iswitchb-final-text)
571 ;; This happens for example if the buffer was chosen with the mouse.
572 (setq iswitchb-matches (list iswitchb-final-text)))
574 ;; Handling the require-match must be done in a better way.
575 (if (and require-match (not (iswitchb-existing-buffer-p)))
576 (error "Must specify valid buffer"))
579 (eq iswitchb-exit 'takeprompt)
580 (null iswitchb-matches))
581 (setq buf-sel iswitchb-final-text)
582 ;; else take head of list
583 (setq buf-sel (car iswitchb-matches)))
585 ;; Or possibly choose the default buffer
586 (if (equal iswitchb-final-text "")
588 (car iswitchb-matches)))
592 (defun iswitchb-existing-buffer-p ()
593 "Return non-nil if there is a matching buffer."
594 (not (null iswitchb-matches)))
598 (defun iswitchb-set-common-completion ()
599 "Find common completion of `iswitchb-text' in `iswitchb-matches'.
600 The result is stored in `iswitchb-common-match-string'."
603 (setq iswitchb-common-match-string nil)
604 (if (and iswitchb-matches
605 (not iswitchb-regexp) ;; testing
606 (stringp iswitchb-text)
607 (> (length iswitchb-text) 0))
608 (if (setq val (iswitchb-find-common-substring
609 iswitchb-matches iswitchb-text))
610 (setq iswitchb-common-match-string val)))
613 (defun iswitchb-complete ()
614 "Try and complete the current pattern amongst the buffer names."
617 (cond ((not iswitchb-matches)
618 (run-hooks 'iswitchb-cannot-complete-hook))
620 ((= 1 (length iswitchb-matches))
621 ;; only one choice, so select it.
625 ;; else there could be some completions
626 (setq res iswitchb-common-match-string)
627 (if (and (not (memq res '(t nil)))
628 (not (equal res iswitchb-text)))
629 ;; found something to complete, so put it in the minibuffer.
631 (setq iswitchb-rescan nil)
632 (delete-region (minibuffer-prompt-end) (point))
634 ;; else nothing to complete
635 (run-hooks 'iswitchb-cannot-complete-hook)
640 (defun iswitchb-toggle-case ()
641 "Toggle the value of variable `iswitchb-case'."
643 (setq iswitchb-case (not iswitchb-case))
644 ;; ask for list to be regenerated.
645 (setq iswitchb-rescan t))
647 (defun iswitchb-toggle-regexp ()
648 "Toggle the value of `iswitchb-regexp'."
650 (setq iswitchb-regexp (not iswitchb-regexp))
651 ;; ask for list to be regenerated.
652 (setq iswitchb-rescan t))
654 (defun iswitchb-toggle-ignore ()
655 "Toggle ignoring buffers specified with `iswitchb-buffer-ignore'."
657 (if iswitchb-buffer-ignore
659 (setq iswitchb-buffer-ignore-orig iswitchb-buffer-ignore)
660 (setq iswitchb-buffer-ignore nil))
662 (setq iswitchb-buffer-ignore iswitchb-buffer-ignore-orig))
663 (iswitchb-make-buflist iswitchb-default)
664 ;; ask for list to be regenerated.
665 (setq iswitchb-rescan t))
667 (defun iswitchb-exit-minibuffer ()
668 "Exit minibuffer, but make sure we have a match if one is needed."
670 (if (or (not iswitchb-require-match)
671 (iswitchb-existing-buffer-p))
674 (defun iswitchb-select-buffer-text ()
675 "Select the buffer named by the prompt.
676 If no buffer exactly matching the prompt exists, maybe create a new one."
678 (setq iswitchb-exit 'takeprompt)
681 (defun iswitchb-find-file ()
682 "Drop into `find-file' from buffer switching."
684 (setq iswitchb-exit 'findfile)
687 (defun iswitchb-next-match ()
688 "Put first element of `iswitchb-matches' at the end of the list."
690 (let ((next (cadr iswitchb-matches)))
691 (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist next))
692 (setq iswitchb-rescan t)))
694 (defun iswitchb-prev-match ()
695 "Put last element of `iswitchb-matches' at the front of the list."
697 (let ((prev (car (last iswitchb-matches))))
698 (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist prev))
699 (setq iswitchb-rescan t)))
701 (defun iswitchb-chop (list elem)
702 "Remove all elements before ELEM and put them at the end of LIST."
707 (setq next (car list))
708 (if (equal next elem)
709 (setq ret (append list (nreverse sofar)))
712 (setq list (cdr list))
713 (setq sofar (cons next sofar)))))
716 ;;; CREATE LIST OF ALL CURRENT BUFFERS
718 (defun iswitchb-make-buflist (default)
719 "Set `iswitchb-buflist' to the current list of buffers.
720 Currently visible buffers are put at the end of the list.
721 The hook `iswitchb-make-buflist-hook' is run after the list has been
722 created to allow the user to further modify the order of the buffer names
723 in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
724 it is put to the start of the list."
725 (setq iswitchb-buflist
726 (let* ((iswitchb-current-buffers (iswitchb-get-buffers-in-frames))
727 (iswitchb-temp-buflist
731 (let ((b-name (buffer-name x)))
734 (iswitchb-ignore-buffername-p b-name)
735 (memq b-name iswitchb-current-buffers)))
737 (buffer-list (and iswitchb-use-frame-buffer-list
738 (selected-frame)))))))
739 (setq iswitchb-temp-buflist
740 (nconc iswitchb-temp-buflist iswitchb-current-buffers))
741 (run-hooks 'iswitchb-make-buflist-hook)
742 ;; Should this be after the hooks, or should the hooks be the
743 ;; final thing to be run?
746 (setq iswitchb-temp-buflist
747 (delete default iswitchb-temp-buflist))
748 (setq iswitchb-temp-buflist
749 (cons default iswitchb-temp-buflist))))
750 iswitchb-temp-buflist)))
752 (defun iswitchb-to-end (lst)
753 "Move the elements from LST to the end of `iswitchb-temp-buflist'."
756 (setq iswitchb-temp-buflist (delq elem iswitchb-temp-buflist)))
758 (setq iswitchb-temp-buflist (nconc iswitchb-temp-buflist lst)))
760 (defun iswitchb-get-buffers-in-frames (&optional current)
761 "Return the list of buffers that are visible in the current frame.
762 If optional argument CURRENT is given, restrict searching to the
763 current frame, rather than all frames, regardless of value of
764 `iswitchb-all-frames'."
765 (let ((iswitchb-bufs-in-frame nil))
766 (walk-windows 'iswitchb-get-bufname nil
769 iswitchb-all-frames))
770 iswitchb-bufs-in-frame))
772 (defun iswitchb-get-bufname (win)
773 "Used by `iswitchb-get-buffers-in-frames' to walk through all windows."
774 (let ((buf (buffer-name (window-buffer win))))
775 (if (not (member buf iswitchb-bufs-in-frame))
776 ;; Only add buf if it is not already in list.
777 ;; This prevents same buf in two different windows being
778 ;; put into the list twice.
779 (setq iswitchb-bufs-in-frame
780 (cons buf iswitchb-bufs-in-frame)))))
782 ;;; FIND MATCHING BUFFERS
784 (defun iswitchb-set-matches ()
785 "Set `iswitchb-matches' to the list of buffers matching prompt."
787 (setq iswitchb-matches
788 (let* ((buflist iswitchb-buflist))
789 (iswitchb-get-matched-buffers iswitchb-text iswitchb-regexp
792 (defun iswitchb-get-matched-buffers (regexp
793 &optional string-format buffer-list)
794 "Return buffers matching REGEXP.
795 If STRING-FORMAT is nil, consider REGEXP as just a string.
796 BUFFER-LIST can be list of buffers or list of strings."
797 (let* ((case-fold-search (iswitchb-case))
798 ;; need reverse since we are building up list backwards
799 (list (reverse buffer-list))
800 (do-string (stringp (car list)))
807 (setq name x) ;We already have the name
808 (setq name (buffer-name x)))
811 ((and (or (and string-format (string-match regexp name))
812 (and (null string-format)
813 (string-match (regexp-quote regexp) name)))
815 (not (iswitchb-ignore-buffername-p name)))
816 (setq ret (cons name ret))
821 (defun iswitchb-ignore-buffername-p (bufname)
822 "Return t if the buffer BUFNAME should be ignored."
823 (let ((data (match-data))
824 (re-list iswitchb-buffer-ignore)
828 (setq nextstr (car re-list))
831 (if (string-match nextstr bufname)
834 (setq re-list nil))))
836 (if (funcall nextstr bufname)
839 (setq re-list nil)))))
840 (setq re-list (cdr re-list)))
841 (set-match-data data)
846 (defun iswitchb-word-matching-substring (word)
847 "Return part of WORD before 1st match to `iswitchb-change-word-sub'.
848 If `iswitchb-change-word-sub' cannot be found in WORD, return nil."
849 (let ((case-fold-search (iswitchb-case)))
850 (let ((m (string-match iswitchb-change-word-sub word)))
856 (defun iswitchb-find-common-substring (lis subs)
857 "Return common string following SUBS in each element of LIS."
860 iswitchb-change-word-sub)
861 (setq iswitchb-change-word-sub
864 (regexp-quote subs)))
865 (setq res (mapcar 'iswitchb-word-matching-substring lis))
866 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
867 (setq alist (mapcar 'iswitchb-makealist res)) ;; could use an OBARRAY
869 ;; try-completion returns t if there is an exact match.
870 (let ((completion-ignore-case (iswitchb-case)))
872 (try-completion subs alist))))
874 (defun iswitchb-makealist (res)
875 "Return dotted pair (RES . 1)."
878 ;; from Wayne Mesard <wmesard@esd.sgi.com>
879 (defun iswitchb-rotate-list (lis)
880 "Destructively remove the last element from LIS.
881 Return the modified list with the last element prepended to it."
882 (if (<= (length lis) 1)
886 (while (consp (cdr las))
890 (cons (car las) lis))))
892 (defun iswitchb-completion-help ()
893 "Show possible completions in a *Completions* buffer."
894 ;; we could allow this buffer to be used to select match, but I think
895 ;; choose-completion-string will need redefining, so it just inserts
896 ;; choice with out any previous input.
898 (setq iswitchb-rescan nil)
899 (let ((buf (current-buffer))
900 (temp-buf "*Completions*")
903 (if (eq last-command this-command)
906 (set-buffer temp-buf)
907 (setq win (get-buffer-window temp-buf))
908 (if (pos-visible-in-window-p (point-max) win)
909 (set-window-start win (point-min))
910 (scroll-other-window))
913 (with-output-to-temp-buffer temp-buf
916 ;; XEmacs extents are put on by default, doesn't seem to be
917 ;; any way of switching them off.
918 (display-completion-list (if iswitchb-matches
921 :help-string "iswitchb "
924 (message "doesn't work yet, sorry!")))
925 ;; else running Emacs
926 (with-current-buffer standard-output
928 (display-completion-list (if iswitchb-matches
933 ;;; KILL CURRENT BUFFER
935 (defun iswitchb-kill-buffer ()
936 "Kill the buffer at the head of `iswitchb-matches'."
938 (let ( (enable-recursive-minibuffers t)
941 (setq buf (car iswitchb-matches))
942 ;; check to see if buf is non-nil.
947 ;; Check if buffer exists. XEmacs gnuserv.el makes alias
948 ;; for kill-buffer which does not return t if buffer is
949 ;; killed, so we can't rely on kill-buffer return value.
951 ;; buffer couldn't be killed.
952 (setq iswitchb-rescan t)
953 ;; else buffer was killed so remove name from list.
954 (setq iswitchb-buflist (delq buf iswitchb-buflist)))))))
956 ;;; VISIT CHOSEN BUFFER
957 (defun iswitchb-visit-buffer (buffer)
958 "Visit buffer named BUFFER according to `iswitchb-method'."
961 ((eq iswitchb-method 'samewindow)
962 (switch-to-buffer buffer))
964 ((memq iswitchb-method '(always-frame maybe-frame))
966 ((and (setq win (iswitchb-window-buffer-p buffer))
967 (or (eq iswitchb-method 'always-frame)
968 (y-or-n-p "Jump to frame? ")))
969 (setq newframe (window-frame win))
970 (raise-frame newframe)
971 (select-frame newframe)
973 (if (not iswitchb-xemacs)
974 ;; reposition mouse to make frame active. not needed in XEmacs
975 ;; This line came from the other-frame defun in Emacs.
976 (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
978 ;; No buffer in other frames...
979 (switch-to-buffer buffer)
982 ((eq iswitchb-method 'otherwindow)
983 (switch-to-buffer-other-window buffer))
985 ((eq iswitchb-method 'display)
986 (display-buffer buffer))
988 ((eq iswitchb-method 'otherframe)
990 (switch-to-buffer-other-frame buffer)
991 (if (not iswitchb-xemacs)
992 (set-mouse-position (selected-frame) (1- (frame-width)) 0))
995 (defun iswitchb-possible-new-buffer (buf)
996 "Possibly create and visit a new buffer called BUF."
998 (let ((newbufcreated))
999 (if (and iswitchb-newbuffer
1001 (not iswitchb-prompt-newbuffer)
1003 (and iswitchb-prompt-newbuffer
1006 "No buffer matching `%s', create one? "
1008 ;; then create a new buffer
1010 (setq newbufcreated (get-buffer-create buf))
1011 (if (fboundp 'set-buffer-major-mode)
1012 (set-buffer-major-mode newbufcreated))
1013 (iswitchb-visit-buffer newbufcreated))
1014 ;; else wont create new buffer
1015 (message (format "no buffer matching `%s'" buf)))))
1017 (defun iswitchb-window-buffer-p (buffer)
1018 "Return window pointer if BUFFER is visible in another frame.
1019 If BUFFER is visible in the current frame, return nil."
1021 (let ((blist (iswitchb-get-buffers-in-frames 'current)))
1022 ;;If the buffer is visible in current frame, return nil
1023 (if (memq buffer blist)
1025 ;; maybe in other frame or icon
1026 (get-buffer-window buffer 0) ; better than 'visible
1030 (defun iswitchb-default-keybindings ()
1031 "Set up default keybindings for `iswitchb-buffer'.
1032 Call this function to override the normal bindings. This function also
1033 adds a hook to the minibuffer.
1035 Obsolescent. Use `iswitchb-mode'."
1037 (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
1038 (global-set-key "\C-xb" 'iswitchb-buffer)
1039 (global-set-key "\C-x4b" 'iswitchb-buffer-other-window)
1040 (global-set-key "\C-x4\C-o" 'iswitchb-display-buffer)
1041 (global-set-key "\C-x5b" 'iswitchb-buffer-other-frame))
1044 (defun iswitchb-buffer ()
1045 "Switch to another buffer.
1047 The buffer name is selected interactively by typing a substring. The
1048 buffer is displayed according to `iswitchb-default-method' -- the
1049 default is to show it in the same window, unless it is already visible
1051 For details of keybindings, do `\\[describe-function] iswitchb'."
1053 (setq iswitchb-method iswitchb-default-method)
1057 (defun iswitchb-buffer-other-window ()
1058 "Switch to another buffer and show it in another window.
1059 The buffer name is selected interactively by typing a substring.
1060 For details of keybindings, do `\\[describe-function] iswitchb'."
1062 (setq iswitchb-method 'otherwindow)
1066 (defun iswitchb-display-buffer ()
1067 "Display a buffer in another window but don't select it.
1068 The buffer name is selected interactively by typing a substring.
1069 For details of keybindings, do `\\[describe-function] iswitchb'."
1071 (setq iswitchb-method 'display)
1075 (defun iswitchb-buffer-other-frame ()
1076 "Switch to another buffer and show it in another frame.
1077 The buffer name is selected interactively by typing a substring.
1078 For details of keybindings, do `\\[describe-function] iswitchb'."
1080 (setq iswitchb-method 'otherframe)
1083 ;;; XEmacs hack for showing default buffer
1085 ;; The first time we enter the minibuffer, Emacs puts up the default
1086 ;; buffer to switch to, but XEmacs doesn't -- presumably there is a
1087 ;; subtle difference in the two versions of post-command-hook. The
1088 ;; default is shown for both whenever we delete all of our text
1089 ;; though, indicating its just a problem the first time we enter the
1090 ;; function. To solve this, we use another entry hook for emacs to
1091 ;; show the default the first time we enter the minibuffer.
1093 (defun iswitchb-init-XEmacs-trick ()
1094 "Display default buffer when first entering minibuffer.
1095 This is a hack for XEmacs, and should really be handled by `iswitchb-exhibit'."
1096 (if (iswitchb-entryfn-p)
1099 (goto-char (point-min)))))
1101 ;; add this hook for XEmacs only.
1103 (add-hook 'iswitchb-minibuffer-setup-hook
1104 'iswitchb-init-XEmacs-trick))
1106 ;;; XEmacs / backspace key
1107 ;; For some reason, if the backspace key is pressed in XEmacs, the
1108 ;; line gets confused, so I've added a simple key definition to make
1109 ;; backspace act like the normal delete key.
1111 (defun iswitchb-xemacs-backspacekey ()
1112 "Bind backspace to `backward-delete-char'."
1113 (define-key iswitchb-mode-map '[backspace] 'backward-delete-char)
1114 (define-key iswitchb-mode-map '[(meta backspace)] 'backward-kill-word))
1117 (add-hook 'iswitchb-define-mode-map-hook
1118 'iswitchb-xemacs-backspacekey))
1120 ;;; ICOMPLETE TYPE CODE
1122 (defun iswitchb-exhibit ()
1123 "Find matching buffers and display a list in the minibuffer.
1124 Copied from `icomplete-exhibit' with two changes:
1125 1. It prints a default buffer name when there is no text yet entered.
1126 2. It calls my completion routine rather than the standard completion."
1127 (if iswitchb-use-mycompletion
1128 (let ((contents (buffer-substring (minibuffer-prompt-end) (point-max)))
1129 (buffer-undo-list t))
1131 (goto-char (point-max))
1132 ; Register the end of input, so we
1133 ; know where the extra stuff
1134 ; (match-status info) begins:
1135 (if (not (boundp 'iswitchb-eoinput))
1136 ;; In case it got wiped out by major mode business:
1137 (make-local-variable 'iswitchb-eoinput))
1138 (setq iswitchb-eoinput (point))
1139 ;; Update the list of matches
1140 (setq iswitchb-text contents)
1141 (iswitchb-set-matches)
1142 (setq iswitchb-rescan t)
1143 (iswitchb-set-common-completion)
1145 ;; Insert the match-status information:
1146 (insert (iswitchb-completions
1148 minibuffer-completion-table
1149 minibuffer-completion-predicate
1150 (not minibuffer-completion-confirm)))))))
1152 (defun iswitchb-completions (name candidates predicate require-match)
1153 "Return the string that is displayed after the user's text.
1154 Modified from `icomplete-completions'."
1156 (let ((comps iswitchb-matches)
1157 ; "-determined" - only one candidate
1158 (open-bracket-determined (if require-match "(" "["))
1159 (close-bracket-determined (if require-match ")" "]"))
1160 ;"-prospects" - more than one candidate
1161 (open-bracket-prospects "{")
1162 (close-bracket-prospects "}")
1165 (if (and iswitchb-use-fonts comps)
1167 (setq first (car comps))
1168 (setq first (format "%s" first))
1169 (put-text-property 0 (length first) 'face
1170 (if (= (length comps) 1)
1171 'font-lock-comment-face
1172 'font-lock-function-name-face)
1174 (setq comps (cons first (cdr comps)))))
1176 (cond ((null comps) (format " %sNo match%s"
1177 open-bracket-determined
1178 close-bracket-determined))
1180 ((null (cdr comps)) ;one match
1181 (concat (if (and (> (length (car comps))
1183 (concat open-bracket-determined
1184 ;; when there is one match, show the
1185 ;; matching buffer name in full
1187 close-bracket-determined)
1189 (if (not iswitchb-use-fonts) " [Matched]")))
1190 (t ;multiple matches
1192 ;;(most (try-completion name candidates predicate))
1194 (most-len (length most))
1202 (mapcar '(lambda (com)
1203 (if (= (length com) most-len)
1204 ;; Most is one exact match,
1205 ;; note that and leave out
1206 ;; for later indication:
1208 (setq most-is-exact t)
1217 ;; put in common completion item -- what you get by
1219 (if (> (length iswitchb-common-match-string) (length name))
1220 (concat open-bracket-determined
1221 (substring iswitchb-common-match-string
1223 close-bracket-determined))
1224 ;; end of partial matches...
1226 ;; think this bit can be ignored.
1227 (and (> most-len (length name))
1228 (concat open-bracket-determined
1229 (substring most (length name))
1230 close-bracket-determined))
1232 ;; list all alternatives
1233 open-bracket-prospects
1235 (concat "," alternatives)
1237 close-bracket-prospects))))))
1239 (defun iswitchb-minibuffer-setup ()
1240 "Set up minibuffer for `iswitchb-buffer'.
1241 Copied from `icomplete-minibuffer-setup-hook'."
1242 (when (iswitchb-entryfn-p)
1243 (set (make-local-variable 'iswitchb-use-mycompletion) t)
1244 (add-hook 'pre-command-hook 'iswitchb-pre-command nil t)
1245 (add-hook 'post-command-hook 'iswitchb-post-command nil t)
1246 (run-hooks 'iswitchb-minibuffer-setup-hook)))
1248 (defun iswitchb-pre-command ()
1249 "Run before command in `iswitchb-buffer'."
1252 (defun iswitchb-post-command ()
1253 "Run after command in `iswitchb-buffer'."
1256 (defun iswitchb-tidy ()
1257 "Remove completions display, if any, prior to new user input.
1258 Copied from `icomplete-tidy'."
1260 (if (and (boundp 'iswitchb-eoinput)
1263 (if (> iswitchb-eoinput (point-max))
1264 ;; Oops, got rug pulled out from under us - reinit:
1265 (setq iswitchb-eoinput (point-max))
1266 (let ((buffer-undo-list buffer-undo-list )) ; prevent entry
1267 (delete-region iswitchb-eoinput (point-max))))
1269 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
1270 (make-local-variable 'iswitchb-eoinput)
1271 (setq iswitchb-eoinput 1)))
1273 (defun iswitchb-entryfn-p ()
1274 "Return non-nil if we are using `iswitchb-buffer'."
1275 (eq iswitchb-minibuf-depth (minibuffer-depth)))
1277 (defun iswitchb-summaries-to-end ()
1278 "Move the summaries to the end of the list.
1279 This is an example function which can be hooked on to
1280 `iswitchb-make-buflist-hook'. Any buffer matching the regexps
1281 `Summary' or `output\*$'are put to the end of the list."
1282 (let ((summaries (delq nil
1285 (if (string-match "Summary\\|output\\*$" x)
1287 iswitchb-temp-buflist))))
1288 (iswitchb-to-end summaries)))
1290 (defun iswitchb-case ()
1291 "Return non-nil iff we should ignore case when matching.
1292 See the variable `iswitchb-case' for details."
1295 (isearch-no-upper-case-p iswitchb-text)
1296 (isearch-no-upper-case-p iswitchb-text t))))
1299 (define-minor-mode iswitchb-mode
1300 "Toggle Iswitchb global minor mode.
1301 With arg, turn Iswitchb mode on if and only iff ARG is positive.
1302 This mode enables switching between buffers using substrings. See
1303 `iswitchb' for details."
1304 nil nil iswitchb-global-map :global t :group 'iswitchb
1306 (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
1307 (remove-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)))
1311 ;;; iswitchb.el ends here