1 ;;; iswitchb.el --- switch between buffers using substrings
3 ;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Stephen Eglen <stephen@cns.ed.ac.uk>
6 ;; Maintainer: Stephen Eglen <stephen@cns.ed.ac.uk>
7 ;; Keywords: extensions
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; To get the functions in this package bound to keys, do
29 ;; (iswitchb-default-keybindings)
33 ;; As you type in a substring, the list of buffers currently matching
34 ;; the substring are 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 an 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 ;; <mcook@cognex.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 isnt 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
98 ;; The buffer at the head of the list can be killed by pressing C-k.
99 ;; If the buffer needs saving, you will be queried before the buffer
102 ;; If you find that the file you are after is not in a buffer, you can
103 ;; press C-x C-f to immediately drop into find-file.
106 ;; See the doc string of iswitchb for full keybindings and features.
107 ;; (describe-function 'iswitchb)
111 ;; See the User Variables section below for easy ways to change the
112 ;; functionality of the program. These are accessible using the
114 ;; To modify the keybindings, use the hook provided. For example:
115 ;;(add-hook 'iswitchb-define-mode-map-hook
116 ;; 'iswitchb-my-keys)
118 ;;(defun iswitchb-my-keys ()
119 ;; "Add my keybings for iswitchb."
120 ;; (define-key iswitchb-mode-map " " 'iswitchb-next-match)
123 ;; Seeing all the matching buffers.
125 ;; If you have many matching buffers, they may not all fit onto one
126 ;; line of the minibuffer. In this case, you should use rsz-mini
127 ;; (resize-minibuffer-mode). You can also limit iswitchb so that it
128 ;; only shows a certain number of lines -- see the documentation for
129 ;; `iswitchb-minibuffer-setup-hook'.
132 ;; Changing the list of buffers.
134 ;; By default, the list of current buffers is most recent first,
135 ;; oldest last, with the exception that the buffers visible in the
136 ;; current frame are put at the end of the list. A hook exists to
137 ;; allow other functions to order the list. For example, if you add:
139 ;; (add-hook 'iswitchb-make-buflist-hook 'iswitchb-summaries-to-end)
141 ;; then all buffers matching "Summary" are moved to the end of the
142 ;; list. (I find this handy for keeping the INBOX Summary and so on
143 ;; out of the way.) It also moves buffers matching "output\*$" to the
144 ;; end of the list (these are created by AUC TeX when compiling.)
145 ;; Other functions could be made available which alter the list of
146 ;; matching buffers (either deleting or rearranging elements.)
150 ;; If you have font-lock loaded, the first matching buffer is
151 ;; highlighted. To switch this off, set (setq iswitchb-use-fonts nil)
152 ;; I don't use font-lock that much, so I've hardcoded the faces. If
153 ;; this is too harsh, let me know. Colouring of the matching buffer
154 ;; name was suggested by Carsten Dominik (dominik@strw.leidenuniv.nl)
156 ;;; Comparison with iswitch-buffer
158 ;; This package is a rewrite of iswitch-buffer, using the minibuffer
159 ;; rather than the echo area. The advantages of using the minibuffer
161 ;; o minibuffer has more powerful editing facilities
162 ;; o doesnt interfere with other packages that use the echo area
163 ;; o *Messages* buffer doesnt get filled up with all of the messages that
164 ;; go to the modeline
165 ;; o cursor is in the minibuffer, which somehow looks right.
166 ;; o minibuffer can be resized dynamically to show all the possible matching
167 ;; buffers rather than just the first line's worth (using rsz-mini).
170 ;; o cant change the prompt to indicate status of searching (eg whether
171 ;; regexp searching is currently on).
175 ;; Could this selection also be used for other buffer selection
176 ;; routines, such as append-to-buffer and kill-buffer?
178 ;; Pressing Tab key twice (without completion) does not scroll the
183 ;; Thanks to Jari Aalto <jari.aalto@poboxes.com> for help with the
184 ;; first version of this package, iswitch-buffer. Thanks also to many
185 ;; others for testing earlier versions.
189 ;; Set up the custom library.
190 ;; taken from http://www.dina.kvl.dk/~abraham/custom/
195 (if (and (featurep 'custom
) (fboundp 'custom-declare-variable
))
196 nil
;; We've got what we needed
197 ;; We have the old custom-library, hack around it!
198 (defmacro defgroup
(&rest args
)
200 (defmacro defcustom
(var value doc
&rest args
)
201 (` (defvar (, var
) (, value
) (, doc
))))))
205 ;; These are some things you might want to change.
207 (defgroup iswitchb nil
208 "switch between buffers using substrings."
210 ;; These links are to be added in later versions of custom and
211 ;; so are currently commented out.
212 :link
'(emacs-commentary-link :tag
"Commentary" "iswitchb.el")
213 :link
'(emacs-library-link :tag
"Lisp File" "iswitchb.el")
217 (defcustom iswitchb-case case-fold-search
218 "*Non-nil if searching of buffer names should ignore case."
222 (defcustom iswitchb-buffer-ignore
224 "*List of regexps or functions matching buffer names to ignore.
225 For example, traditional behavior is not to list buffers whose names begin
226 with a space, for which the regexp is `^ '. See the source file for
227 example functions that filter buffernames."
228 :type
'(repeat regexp
)
232 ;;; Examples for setting the value of iswitchb-buffer-ignore
233 ;(defun -c-mode (name)
234 ; "Ignore all c mode buffers -- example function for iswitchb."
237 ; (string-match "^C$" mode-name)))
239 ;(setq iswitchb-buffer-ignore '("^ " ignore-c-mode))
240 ;(setq iswitchb-buffer-ignore '("^ " "\\.c$" "\\.h$"))
242 (defcustom iswitchb-default-method
'always-frame
243 "*How to switch to new buffer when using `iswitchb-buffer'.
245 `samewindow' Show new buffer in same window
246 `otherwindow' Show new buffer in another window (same frame)
247 `display' Display buffer in another window without switching to it
248 `otherframe' Show new buffer in another frame
249 `maybe-frame' If a buffer is visible in another frame, prompt to ask if you
250 you want to see the buffer in the same window of the current
251 frame or in the other frame.
252 `always-frame' If a buffer is visible in another frame, raise that
253 frame. Otherwise, visit the buffer in the same window."
254 :type
'(choice (const :tag
"samewindow" samewindow
)
255 (const :tag
"otherwindow" otherwindow
)
256 (const :tag
"display" display
)
257 (const :tag
"otherframe" otherframe
)
258 (const :tag
"maybe-frame" maybe-frame
)
259 (const :tag
"always-frame" always-frame
))
263 (defcustom iswitchb-regexp nil
264 "*Non-nil means that `iswitchb' will do regexp matching.
265 Value can be toggled within `iswitchb'."
270 (defcustom iswitchb-newbuffer t
271 "*Non-nil means create new buffer if no buffer matches substring.
272 See also `iswitchb-prompt-newbuffer'."
277 (defcustom iswitchb-prompt-newbuffer t
278 "*Non-nil means prompt user to confirm before creating new buffer.
279 See also `iswitchb-newbuffer'."
284 (defcustom iswitchb-define-mode-map-hook nil
285 "*Hook to define keys in `iswitchb-mode-map' for extra keybindings."
291 (defcustom iswitchb-use-fonts t
292 "*Non-nil means use fonts for showing first match."
297 (defcustom iswitchb-make-buflist-hook nil
298 "*Hook to run when list of matching buffers is created."
304 (defvar iswitchb-method nil
305 "*Stores the method for viewing the selected buffer.
306 Its value is one of `samewindow', `otherwindow', `display', `otherframe',
307 `maybe-frame' or `always-frame'. See `iswitchb-default-method' for
310 (defvar iswitchb-all-frames
'visible
311 "*Argument to pass to `walk-windows' when finding visible buffers.
312 See documentation of `walk-windows' for useful values.")
316 ;; Do we need the variable iswitchb-use-mycompletion?
319 ;;; Internal Variables
320 (defvar iswitchb-minibuffer-setup-hook nil
321 "Iswitchb-specific customization of minibuffer setup.
323 This hook is run during minibuffer setup iff `iswitchb' will be active.
324 It is intended for use in customizing iswitchb for interoperation
325 with other packages. For instance:
327 \(add-hook 'iswitchb-minibuffer-setup-hook
330 \(make-local-variable 'resize-minibuffer-window-max-height)
331 \(setq resize-minibuffer-window-max-height 3))))
333 will constrain rsz-mini to a maximum minibuffer height of 3 lines when
334 iswitchb is running. Copied from `icomplete-minibuffer-setup-hook'.")
336 (defvar iswitchb-eoinput
1
337 "Point where minibuffer input ends and completion info begins.
338 Copied from `icomplete-eoinput'.")
339 (make-variable-buffer-local 'iswitchb-eoinput
)
342 (defvar iswitchb-buflist nil
343 "Stores the current list of buffers that will be searched through.
344 The list is ordered, so that the most recent buffers come first,
345 although by default, the buffers visible in the current frame are put
346 at the end of the list. Created by `iswitchb-make-buflist'.")
348 ;; todo -- is this necessary?
350 (defvar iswitchb-use-mycompletion nil
351 "Non-nil means use `iswitchb-buffer' completion feedback.
352 Should only be set to t by iswitchb functions, so that it doesn't
353 interfere with other minibuffer usage.")
355 (defvar iswitchb-change-word-sub nil
356 "Private variable used by `iswitchb-word-matching-substring'.")
359 (defvar iswitchb-common-match-string nil
360 "Stores the string that is common to all matching buffers.")
363 (defvar iswitchb-rescan nil
364 "Non-nil means we need to regenerate the list of matching buffers.")
366 (defvar iswitchb-text nil
367 "Stores the users string as it is typed in.")
369 (defvar iswitchb-matches nil
370 "List of buffers currenly matching `iswitchb-text'.")
372 (defvar iswitchb-mode-map nil
373 "Keymap for `iswitchb-buffer'.")
375 (defvar iswitchb-history nil
376 "History of buffers selected using `iswitchb-buffer'.")
378 (defvar iswitchb-exit nil
379 "Flag to monitor how `iswitchb-buffer' exits.
380 If equal to `takeprompt', we use the prompt as the buffer name to be
383 (defvar iswitchb-buffer-ignore-orig nil
384 "Stores original value of `iswitchb-buffer-ignore'.")
386 (defvar iswitchb-xemacs
(string-match "XEmacs" (emacs-version))
387 "Non-nil if we are running XEmacs. Otherwise, assume we are running Emacs.")
394 (defun iswitchb-define-mode-map ()
395 "Set up the keymap for `iswitchb-buffer'."
398 ;; generated every time so that it can inheret new functions.
399 ;;(or iswitchb-mode-map
401 (setq map
(copy-keymap minibuffer-local-map
))
402 (define-key map
"?" 'iswitchb-completion-help
)
403 (define-key map
"\C-s" 'iswitchb-next-match
)
404 (define-key map
"\C-r" 'iswitchb-prev-match
)
405 (define-key map
"\t" 'iswitchb-complete
)
406 (define-key map
"\C-j" 'iswitchb-select-buffer-text
)
407 (define-key map
"\C-t" 'iswitchb-toggle-regexp
)
408 (define-key map
"\C-x\C-f" 'iswitchb-find-file
)
409 ;;(define-key map "\C-a" 'iswitchb-toggle-ignore)
410 (define-key map
"\C-c" 'iswitchb-toggle-case
)
411 (define-key map
"\C-k" 'iswitchb-kill-buffer
)
412 (setq iswitchb-mode-map map
)
413 (run-hooks 'iswitchb-define-mode-map-hook
)
420 "Switch to buffer matching a substring.
421 As you type in a string, all of the buffers matching the string are
422 displayed. When you have found the buffer you want, it can then be
423 selected. As you type, most keys have their normal keybindings,
424 except for the following:
425 \\<iswitchb-mode-map>
427 RET Select the buffer at the front of the list of matches. If the
428 list is empty, possibly prompt to create new buffer.
430 \\[iswitchb-select-buffer-text] Select the current prompt as the buffer.
431 If no buffer is found, prompt for a new one.
433 \\[iswitchb-next-match] Put the first element at the end of the list.
434 \\[iswitchb-prev-match] Put the last element at the start of the list.
435 \\[iswitchb-complete] Complete a common suffix to the current string that
436 matches all buffers. If there is only one match, select that buffer.
437 If there is no common suffix, show a list of all matching buffers
438 in a separate window.
439 \\[iswitchb-toggle-regexp] Toggle rexep searching.
440 \\[iswitchb-toggle-case] Toggle case-sensitive searching of buffer names.
441 \\[iswitchb-completion-help] Show list of matching buffers in separate window.
442 \\[iswitchb-find-file] Exit iswitchb and drop into find-file.
443 \\[iswitchb-kill-buffer] Kill buffer at head of buffer list."
444 ;;\\[iswitchb-toggle-ignore] Toggle ignoring certain buffers (see \
445 ;;`iswitchb-buffer-ignore')
452 (minibuffer-confirm-incomplete nil
) ;XEmacs todo: prevent `;confirm'
453 (icomplete-mode nil
) ;; prevent icomplete starting up
454 ;; can only use fonts if they have been bound.
455 (iswitchb-use-fonts (and iswitchb-use-fonts
456 (boundp 'font-lock-comment-face
)
457 (boundp 'font-lock-function-name-face
)))
460 (iswitchb-define-mode-map)
461 (setq iswitchb-exit nil
)
462 (setq iswitchb-rescan t
)
463 (setq iswitchb-text
"")
464 (iswitchb-set-matches)
465 (setq prompt
(format "iswitch "))
466 (iswitchb-make-buflist)
468 ((minibuffer-local-completion-map iswitchb-mode-map
))
469 ;; prompt the user for the buffer name
470 (setq iswitchb-final-text
(completing-read prompt
478 ;;(message "chosen text %s" iswitchb-final-text)
479 ;; Choose the buffer name: either the text typed in, or the head
480 ;; of the list of matches
482 (cond ( (eq iswitchb-exit
'findfile
)
483 (call-interactively 'find-file
))
487 (eq iswitchb-exit
'takeprompt
)
488 (null iswitchb-matches
))
489 (setq buf-sel iswitchb-final-text
)
490 ;; else take head of list
491 (setq buf-sel
(car iswitchb-matches
)))
493 ;; Or possibly choose the default buffer
494 (if (equal iswitchb-final-text
"")
495 (setq buf-sel
(car iswitchb-matches
)))
498 (message "go to buf %s" buf-sel
)
499 ;; Check buf-sel is non-nil.
501 (if (get-buffer buf-sel
)
502 ;; buffer exists, so view it and then exit
503 (iswitchb-visit-buffer buf-sel
)
504 ;; else buffer doesnt exist
505 (iswitchb-possible-new-buffer buf-sel
)))
513 (defun iswitchb-set-common-completion ()
514 "Find common completion of `iswitchb-text' in `iswitchb-matches'.
515 The result is stored in `iswitchb-common-match-string'."
518 (setq iswitchb-common-match-string nil
)
519 (if (and iswitchb-matches
520 (stringp iswitchb-text
)
521 (> (length iswitchb-text
) 0))
522 (if (setq val
(iswitchb-find-common-substring
523 iswitchb-matches iswitchb-text
))
524 (setq iswitchb-common-match-string val
)))
529 (defun iswitchb-complete ()
530 "Try and complete the current pattern amongst the buffer names."
533 (cond ((not iswitchb-matches
)
534 (iswitchb-completion-help)
537 ((eq 1 (length iswitchb-matches
))
538 ;; only one choice, so select it.
542 ;; else there could be some completions
544 (setq res
(iswitchb-find-common-substring
545 iswitchb-matches iswitchb-text
))
546 (if (and (not (memq res
'(t nil
)))
547 (not (equal res iswitchb-text
)))
548 ;; found something to complete, so put it in the minibuff.
550 (setq iswitchb-rescan nil
)
551 (delete-region (point-min) (point))
553 ;; else nothing to complete
554 (iswitchb-completion-help)
563 (defun iswitchb-toggle-case ()
564 "Toggle the value of `iswitchb-case'."
566 (setq iswitchb-case
(not iswitchb-case
))
567 ;; ask for list to be regenerated.
568 (setq iswitchb-rescan t
)
571 (defun iswitchb-toggle-regexp ()
572 "Toggle the value of `iswitchb-regexp'."
574 (setq iswitchb-regexp
(not iswitchb-regexp
))
575 ;; ask for list to be regenerated.
576 (setq iswitchb-rescan t
)
580 (defun iswitchb-toggle-ignore ()
581 "Toggle ignoring buffers specified with `iswitchb-buffer-ignore'."
583 (if iswitchb-buffer-ignore
585 (setq iswitchb-buffer-ignore-orig iswitchb-buffer-ignore
)
586 (setq iswitchb-buffer-ignore nil
)
589 (setq iswitchb-buffer-ignore iswitchb-buffer-ignore-orig
)
591 ;; ask for list to be regenerated.
592 (setq iswitchb-rescan t
)
596 (defun iswitchb-select-buffer-text ()
597 "Select the buffer named by the prompt.
598 If no buffer exactly matching the prompt exists, maybe create a new one."
600 (setq iswitchb-exit
'takeprompt
)
605 (defun iswitchb-find-file ()
606 "Drop into find-file from buffer switching."
608 (setq iswitchb-exit
'findfile
)
611 (defun iswitchb-next-match ()
612 "Put first element of `iswitchb-matches' at the end of the list."
614 (let ((next (cadr iswitchb-matches
)))
615 (setq iswitchb-buflist
(iswitchb-chop iswitchb-buflist next
))
616 (setq iswitchb-rescan t
)
619 (defun iswitchb-prev-match ()
620 "Put last element of `iswitchb-matches' at the front of the list."
622 (let ((prev (car (last iswitchb-matches
))))
623 (setq iswitchb-buflist
(iswitchb-chop iswitchb-buflist prev
))
624 (setq iswitchb-rescan t
)
630 (defun iswitchb-chop (list elem
)
631 "Remove all elements before ELEM and put them at the end of LIST."
636 (setq next
(car list
))
637 (if (equal next elem
)
638 (setq ret
(append list
(nreverse sofar
)))
641 (setq list
(cdr list
))
642 (setq sofar
(cons next sofar
)))))
648 ;;; CREATE LIST OF ALL CURRENT BUFFERS
651 (defun iswitchb-make-buflist ()
652 "Set `iswitchb-buflist' to the current list of buffers.
653 Currently visible buffers are put at the end of the list.
654 The hook `iswitchb-make-buflist-hook' is run after the list has been
655 created to allow the user to further modify the order of the buffer names
657 (setq iswitchb-buflist
658 (let* ((iswitchb-current-buffers (iswitchb-get-buffers-in-frames))
663 (let ((b-name (buffer-name x
)))
666 (iswitchb-ignore-buffername-p b-name
)
667 (memq b-name iswitchb-current-buffers
)))
670 (nconc buflist iswitchb-current-buffers
)
671 (run-hooks 'iswitchb-make-buflist-hook
)
674 (defun iswitchb-to-end (lst)
675 "Move the elements from LST to the end of BUFLIST."
678 (setq buflist
(delq elem buflist
)))
684 (defun iswitchb-get-buffers-in-frames (&optional current
)
685 "Return the list of buffers that are visible in the current frame.
686 If optional argument `current' is given, restrict searching to the
687 current frame, rather than all frames, regardless of value of
688 `iswitchb-all-frames'."
689 (let ((iswitchb-bufs-in-frame nil
))
690 (walk-windows 'iswitchb-get-bufname nil
693 iswitchb-all-frames
))
694 iswitchb-bufs-in-frame
))
697 (defun iswitchb-get-bufname (win)
698 "Used by `iswitchb-get-buffers-in-frames' to walk through all windows."
699 (let ((buf (buffer-name (window-buffer win
))))
700 (if (not (member buf iswitchb-bufs-in-frame
))
701 ;; Only add buf if it is not already in list.
702 ;; This prevents same buf in two different windows being
703 ;; put into the list twice.
704 (setq iswitchb-bufs-in-frame
705 (cons buf iswitchb-bufs-in-frame
)))))
708 ;;; FIND MATCHING BUFFERS
711 (defun iswitchb-set-matches ()
712 "Set `iswitchb-matches' to the list of buffers matching prompt."
714 (setq iswitchb-matches
715 (let* ((buflist iswitchb-buflist
)
717 (iswitchb-get-matched-buffers iswitchb-text iswitchb-regexp
720 (defun iswitchb-get-matched-buffers (regexp
721 &optional string-format buffer-list
)
722 "Return buffers matching REGEXP.
723 If STRING-FORMAT is non-nil, consider REGEXP as string.
724 BUFFER-LIST can be list of buffers or list of strings."
725 (let* ((case-fold-search iswitchb-case
)
726 ;; need reverse since we are building up list backwards
727 (list (reverse buffer-list
))
728 (do-string (stringp (car list
)))
736 (setq name x
) ;We already have the name
737 (setq name
(buffer-name x
)))
740 ((and (or (and string-format
(string-match regexp name
))
741 (and (null string-format
)
742 (string-match (regexp-quote regexp
) name
)))
744 ;; todo (not (iswitchb-ignore-buffername-p name))
746 (setq ret
(cons name ret
))
755 (defun iswitchb-ignore-buffername-p (bufname)
756 "Return t if the buffer BUFNAME should be ignored."
757 (let ((data (match-data))
758 (re-list iswitchb-buffer-ignore
)
763 (setq nextstr
(car re-list
))
766 (if (string-match nextstr bufname
)
769 (setq re-list nil
))))
771 (if (funcall nextstr bufname
)
777 (setq re-list
(cdr re-list
)))
778 (store-match-data data
)
786 (defun iswitchb-word-matching-substring (word)
787 "Return part of WORD before 1st match to `iswitchb-change-word-sub'.
788 If `iswitchb-change-word-sub' cannot be found in WORD, return nil."
789 (let ((case-fold-search iswitchb-case
))
790 (let ((m (string-match iswitchb-change-word-sub word
)))
801 (defun iswitchb-find-common-substring (lis subs
)
802 "Return common string following SUBS in each element of LIS."
805 iswitchb-change-word-sub
807 (setq iswitchb-change-word-sub
810 (regexp-quote subs
)))
811 (setq res
(mapcar 'iswitchb-word-matching-substring lis
))
812 (setq res
(delq nil res
)) ;; remove any nil elements (shouldnt happen)
813 (setq alist
(mapcar 'iswitchb-makealist res
)) ;; could use an OBARRAY
815 ;; try-completion returns t if there is an exact match.
816 (let ((completion-ignore-case iswitchb-case
))
818 (try-completion subs alist
)
822 (defun iswitchb-makealist (res)
823 "Return dotted pair (RES . 1)."
826 ;; from Wayne Mesard <wmesard@esd.sgi.com>
827 (defun iswitchb-rotate-list (lis)
828 "Destructively removes the last element from LIS.
829 Return the modified list with the last element prepended to it."
830 (if (<= (length lis
) 1)
834 (while (consp (cdr las
))
838 (cons (car las
) lis
))
842 (defun iswitchb-completion-help ()
843 "Show possible completions in a *Buffer Completions* buffer."
844 ;; we could allow this buffer to be used to select match, but I think
845 ;; choose-completion-string will need redefining, so it just inserts
846 ;; choice with out any previous input.
848 (setq iswitchb-rescan nil
)
849 (let ((completion-setup-hook nil
) ;disable fancy highlight/selection.
851 (with-output-to-temp-buffer "*Buffer Completions*"
854 ;; XEmacs extents are put on by default, doesn't seem to be
855 ;; any way of switching them off.
856 (display-completion-list (if iswitchb-matches
859 :help-string
"iswitchb "
862 (message "doesnt work yet, sorry!")))
863 ;; else running Emacs
864 (display-completion-list (if iswitchb-matches
870 ;;; KILL CURRENT BUFFER
872 (defun iswitchb-kill-buffer ()
873 "Kill the buffer at the head of `iswtichb-matches'."
875 (let ( (enable-recursive-minibuffers t
)
878 (setq buf
(car iswitchb-matches
))
879 ;; check to see if buf is non-nil.
884 ;; Check if buffer exists. XEmacs gnuserv.el makes alias
885 ;; for kill-buffer which does not return t if buffer is
886 ;; killed, so we can't rely on kill-buffer return value.
888 ;; buffer couldn't be killed.
889 (setq iswitchb-rescan t
)
890 ;; else buffer was killed so remove name from list.
891 (setq iswitchb-buflist
(delq buf iswitchb-buflist
)))))))
894 ;;; VISIT CHOSEN BUFFER
895 (defun iswitchb-visit-buffer (buffer)
896 "Visit buffer named BUFFER according to `iswitchb-method'."
899 ((eq iswitchb-method
'samewindow
)
900 (switch-to-buffer buffer
))
902 ((memq iswitchb-method
'(always-frame maybe-frame
))
904 ((and (setq win
(iswitchb-window-buffer-p buffer
))
905 (or (eq iswitchb-method
'always-frame
)
906 (y-or-n-p "Jump to frame? ")))
907 (setq newframe
(window-frame win
))
908 (raise-frame newframe
)
909 (select-frame newframe
)
911 (if (not iswitchb-xemacs
)
912 ;; reposition mouse to make frame active. not needed in XEmacs
913 ;; This line came from the other-frame defun in Emacs.
914 (set-mouse-position (selected-frame) (1- (frame-width)) 0))
917 ;; No buffer in other frames...
918 (switch-to-buffer buffer
)
923 ((eq iswitchb-method
'otherwindow
)
924 (switch-to-buffer-other-window buffer
))
926 ((eq iswitchb-method
'display
)
927 (display-buffer buffer
))
929 ((eq iswitchb-method
'otherframe
)
931 (switch-to-buffer-other-frame buffer
)
932 (if (not iswitchb-xemacs
)
933 (set-mouse-position (selected-frame) (1- (frame-width)) 0))
937 (defun iswitchb-possible-new-buffer (buf)
938 "Possibly create and visit a new buffer called BUF."
940 (let ((newbufcreated))
941 (if (and iswitchb-newbuffer
943 (not iswitchb-prompt-newbuffer
)
945 (and iswitchb-prompt-newbuffer
948 "No buffer matching `%s', create one? "
950 ;; then create a new buffer
952 (setq newbufcreated
(get-buffer-create buf
))
953 (if (fboundp 'set-buffer-major-mode
)
954 (set-buffer-major-mode newbufcreated
))
955 (iswitchb-visit-buffer newbufcreated
))
956 ;; else wont create new buffer
957 (message (format "no buffer matching `%s'" buf
))
960 (defun iswitchb-window-buffer-p (buffer)
961 "Return window pointer if BUFFER is visible in another frame.
962 If BUFFER is visible in the current frame, return nil."
964 (let ((blist (iswitchb-get-buffers-in-frames 'current
)))
965 ;;If the buffer is visible in current frame, return nil
966 (if (memq buffer blist
)
968 ;; maybe in other frame...
969 (get-buffer-window buffer
'visible
)
973 (defun iswitchb-default-keybindings ()
974 "Set up default keybindings for `iswitchb-buffer'.
975 Call this function to override the normal bindings."
977 (global-set-key (read-kbd-macro "C-x b") 'iswitchb-buffer
)
978 (global-set-key (read-kbd-macro "C-x 4 b") 'iswitchb-buffer-other-window
)
979 (global-set-key (read-kbd-macro "C-x 4 C-o") 'iswitchb-display-buffer
)
980 (global-set-key (read-kbd-macro "C-x 5 b") 'iswitchb-buffer-other-frame
))
984 (defun iswitchb-buffer ()
985 "Switch to another buffer.
987 The buffer name is selected interactively by typing a substring. The
988 buffer is displayed according to `iswitchb-default-method' -- the
989 default is to show it in the same window, unless it is already visible
991 For details of keybindings, do `\\[describe-function] iswitchb'."
993 (setq iswitchb-method iswitchb-default-method
)
998 (defun iswitchb-buffer-other-window ()
999 "Switch to another buffer and show it in another window.
1000 The buffer name is selected interactively by typing a substring.
1001 For details of keybindings, do `\\[describe-function] iswitchb'."
1003 (setq iswitchb-method
'otherwindow
)
1009 (defun iswitchb-display-buffer ()
1010 "Display a buffer in another window but don't select it.
1011 The buffer name is selected interactively by typing a substring.
1012 For details of keybindings, do `\\[describe-function] iswitchb'."
1014 (setq iswitchb-method
'display
)
1020 (defun iswitchb-buffer-other-frame ()
1021 "Switch to another buffer and show it in another frame.
1022 The buffer name is selected interactively by typing a substring.
1023 For details of keybindings, do `\\[describe-function] iswitchb'."
1025 (setq iswitchb-method
'otherframe
)
1030 (defun iswitchb-entry ()
1031 "Simply fall into `iswitchb' -- the main function."
1038 ;;; XEmacs hack for showing default buffer
1040 ;; The first time we enter the minibuffer, Emacs puts up the default
1041 ;; buffer to switch to, but XEmacs doesnt -- presumably there is a
1042 ;; subtle difference in the two versions of post-command-hook. The
1043 ;; default is shown for both whenever we delete all of our text
1044 ;; though, indicating its just a problem the first time we enter the
1045 ;; function. To solve this, we use another entry hook for emacs to
1046 ;; show the default the first time we enter the minibuffer.
1048 (defun iswitchb-init-Xemacs-trick ()
1049 "Display default buffer when first entering minibuffer.
1050 This is a hack for XEmacs, and should really be handled by `iswitchb-exhibit'."
1051 (if (iswitchb-entryfn-p)
1054 (goto-char (point-min)))))
1057 ;; add this hook for XEmacs only.
1059 (add-hook 'iswitchb-minibuffer-setup-hook
1060 'iswitchb-init-Xemacs-trick
))
1063 ;;; XEmacs / backspace key
1064 ;; For some reason, if the backspace key is pressed in xemacs, the
1065 ;; line gets confused, so I've added a simple key definition to make
1066 ;; backspace act like the normal delete key.
1068 (defun iswitchb-xemacs-backspacekey ()
1069 "Bind backspace to `backward-delete-char'."
1070 (define-key iswitchb-mode-map
'[backspace] 'backward-delete-char)
1071 (define-key iswitchb-mode-map '[(meta backspace)] 'backward-kill-word)
1076 (add-hook 'iswitchb-define-mode-map-hook
1077 'iswitchb-xemacs-backspacekey))
1081 ;;; ICOMPLETE TYPE CODE
1083 (defun iswitchb-exhibit ()
1084 "Find matching buffers and display a list in the minibuffer.
1085 Copied from `icomplete-exhibit' with two changes:
1086 1. It prints a default buffer name when there is no text yet entered.
1087 2. It calls my completion routine rather than the standard completion."
1089 (if iswitchb-use-mycompletion
1090 (let ((contents (buffer-substring (point-min)(point-max)))
1091 (buffer-undo-list t))
1093 (goto-char (point-max))
1094 ; Register the end of input, so we
1095 ; know where the extra stuff
1096 ; (match-status info) begins:
1097 (if (not (boundp 'iswitchb-eoinput))
1098 ;; In case it got wiped out by major mode business:
1099 (make-local-variable 'iswitchb-eoinput))
1100 (setq iswitchb-eoinput (point))
1101 ;; Update the list of matches
1102 (setq iswitchb-text contents)
1103 (iswitchb-set-matches)
1104 (setq iswitchb-rescan t)
1105 (iswitchb-set-common-completion)
1107 ;; Insert the match-status information:
1109 (iswitchb-completions
1111 minibuffer-completion-table
1112 minibuffer-completion-predicate
1113 (not minibuffer-completion-confirm)))
1118 (defun iswitchb-completions
1119 (name candidates predicate require-match)
1120 "Return the string that is displayed after the user's text.
1121 Modified from `icomplete-completions'."
1123 (let ((comps iswitchb-matches)
1124 ; "-determined" - only one candidate
1125 (open-bracket-determined (if require-match "(" "["))
1126 (close-bracket-determined (if require-match ")" "]"))
1127 ;"-prospects" - more than one candidate
1128 (open-bracket-prospects "{")
1129 (close-bracket-prospects "}")
1133 (if (and iswitchb-use-fonts comps)
1135 (setq first (car comps))
1136 (setq first (format "%s" first))
1137 (put-text-property 0 (length first) 'face
1138 (if (eq (length comps) 1)
1139 'font-lock-comment-face
1140 'font-lock-function-name-face)
1142 (setq comps (cons first (cdr comps)))
1145 (cond ((null comps) (format " %sNo match%s"
1146 open-bracket-determined
1147 close-bracket-determined))
1149 ((null (cdr comps)) ;one match
1150 (concat (if (and (> (length (car comps))
1152 (concat open-bracket-determined
1153 ;; when there is one match, show the
1154 ;; matching buffer name in full
1156 close-bracket-determined)
1158 (if (not iswitchb-use-fonts) " [Matched]")
1160 (t ;multiple matches
1162 ;;(most (try-completion name candidates predicate))
1164 (most-len (length most))
1172 (mapcar '(lambda (com)
1173 (if (= (length com) most-len)
1174 ;; Most is one exact match,
1175 ;; note that and leave out
1176 ;; for later indication:
1178 (setq most-is-exact t)
1187 ;; put in common completion item -- what you get by
1189 (if (> (length iswitchb-common-match-string) (length name))
1190 (concat open-bracket-determined
1191 (substring iswitchb-common-match-string
1193 close-bracket-determined)
1195 ;; end of partial matches...
1197 ;; think this bit can be ignored.
1198 (and (> most-len (length name))
1199 (concat open-bracket-determined
1200 (substring most (length name))
1201 close-bracket-determined))
1203 ;; list all alternatives
1204 open-bracket-prospects
1206 (concat "," alternatives)
1208 close-bracket-prospects)))
1211 (defun iswitchb-minibuffer-setup ()
1212 "Set up minibuffer for `iswitchb-buffer'.
1213 Copied from `icomplete-minibuffer-setup-hook'."
1214 (if (iswitchb-entryfn-p)
1217 (make-local-variable 'iswitchb-use-mycompletion)
1218 (setq iswitchb-use-mycompletion t)
1219 (make-local-hook 'pre-command-hook)
1220 (add-hook 'pre-command-hook
1221 'iswitchb-pre-command
1223 (make-local-hook 'post-command-hook)
1224 (add-hook 'post-command-hook
1225 'iswitchb-post-command
1228 (run-hooks 'iswitchb-minibuffer-setup-hook)
1233 (defun iswitchb-pre-command ()
1234 "Run before command in `iswitchb-buffer'."
1238 (defun iswitchb-post-command ()
1239 "Run after command in `iswitchb-buffer'."
1245 (defun iswitchb-tidy ()
1246 "Remove completions display, if any, prior to new user input.
1247 Copied from `icomplete-tidy'."
1249 (if (and (boundp 'iswitchb-eoinput)
1252 (if (> iswitchb-eoinput (point-max))
1253 ;; Oops, got rug pulled out from under us - reinit:
1254 (setq iswitchb-eoinput (point-max))
1255 (let ((buffer-undo-list buffer-undo-list )) ; prevent entry
1256 (delete-region iswitchb-eoinput (point-max))))
1258 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
1259 (make-local-variable 'iswitchb-eoinput)
1260 (setq iswitchb-eoinput 1)))
1263 (defun iswitchb-entryfn-p ()
1264 "Return non-nil if `this-command' shows we are using `iswitchb-buffer'."
1265 (and (symbolp this-command) ; ignore lambda functions
1268 iswitchb-buffer-other-frame
1269 iswitchb-display-buffer
1270 iswitchb-buffer-other-window))))
1275 (defun iswitchb-summaries-to-end ()
1276 "Move the summaries to the end of the list.
1277 This is an example function which can be hooked on to
1278 `iswitchb-make-buflist-hook'. Any buffer matching the regexps
1279 `Summary' or `output\*$'are put to the end of the list."
1280 (let ((summaries (delq nil (mapcar
1283 (string-match "Summary" x)
1284 (string-match "output\\*$" x))
1289 (iswitchb-to-end summaries)))
1294 (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
1298 ;;; iswitchb.el ends here