(describe-char): Make it work on *Help* buffer.
[bpt/emacs.git] / lisp / iswitchb.el
CommitLineData
6c56c80b 1;;; iswitchb.el --- switch between buffers using substrings
962a4216 2
2d839509 3;; Copyright (C) 1996, 1997, 2000, 2001, 2003 Free Software Foundation, Inc.
962a4216 4
b2537dfa
RS
5;; Author: Stephen Eglen <stephen@gnu.org>
6;; Maintainer: Stephen Eglen <stephen@gnu.org>
19db4308 7;; Keywords: completion convenience
183040ff 8;; location: http://www.anc.ed.ac.uk/~stephen/emacs/
962a4216 9
6c56c80b
RS
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
962a4216
RS
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)
15;; any later version.
16
6c56c80b 17;; GNU Emacs is distributed in the hope that it will be useful,
962a4216
RS
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.
21
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.
26
c6e5b93f 27;;; Commentary:
962a4216 28
c6e5b93f 29;; Installation:
19db4308
DL
30;; To get the functions in this package bound to keys, use
31;; M-x iswitchb-mode or customize the option `iswitchb-mode'.
79f0a5ed
SE
32;; Alternatively, add the following line to your .emacs:
33;; (iswitchb-mode 1)
962a4216 34
962a4216 35;; As you type in a substring, the list of buffers currently matching
19db4308 36;; the substring is displayed as you type. The list is ordered so
962a4216
RS
37;; that the most recent buffers visited come at the start of the list.
38;; The buffer at the start of the list will be the one visited when
39;; you press return. By typing more of the substring, the list is
40;; narrowed down so that gradually the buffer you want will be at the
19db4308 41;; top of the list. Alternatively, you can use C-s and C-r to rotate
962a4216
RS
42;; buffer names in the list until the one you want is at the top of
43;; the list. Completion is also available so that you can see what is
44;; common to all of the matching buffers as you type.
45
46;; This code is similar to a couple of other packages. Michael R Cook
8097dd15 47;; <cook@sightpath.com> wrote a similar buffer switching package, but
962a4216
RS
48;; does exact matching rather than substring matching on buffer names.
49;; I also modified a couple of functions from icomplete.el to provide
50;; the completion feedback in the minibuffer.
51
19db4308 52;;; Example
962a4216 53
4d8ae757
RS
54;; If I have two buffers called "123456" and "123", with "123456" the
55;; most recent, when I use iswitchb, I first of all get presented with
56;; the list of all the buffers
962a4216 57;;
19db4308 58;; iswitch {123456,123}
962a4216
RS
59;;
60;; If I then press 2:
61;; iswitch 2[3]{123456,123}
62;;
63;; The list in {} are the matching buffers, most recent first (buffers
64;; visible in the current frame are put at the end of the list by
65;; default). At any time I can select the item at the head of the
2d839509
SE
66;; list by pressing RET. I can also put the first element at the end
67;; of the list by pressing C-s, or put the last element at the head of
68;; the list by pressing C-r. The item in [] indicates what can be
69;; added to my input by pressing TAB. In this case, I will get "3"
70;; added to my input. So, press TAB:
962a4216
RS
71;; iswitch 23{123456,123}
72;;
73;; At this point, I still have two matching buffers.
74;; If I want the first buffer in the list, I simply press RET. If I
75;; wanted the second in the list, I could press C-s to move it to the
76;; top of the list and then RET to select it.
77;;
4d8ae757 78;; However, if I type 4, I only have one match left:
962a4216
RS
79;; iswitch 234[123456] [Matched]
80;;
4d8ae757
RS
81;; Since there is only one matching buffer left, it is given in [] and we
82;; see the text [Matched] afterwards. I can now press TAB or RET to go
83;; to that buffer.
962a4216
RS
84;;
85;; If however, I now type "a":
86;; iswitch 234a [No match]
87;; There are no matching buffers. If I press RET or TAB, I can be
88;; prompted to create a new buffer called "234a".
89;;
90;; Of course, where this function comes in really useful is when you
91;; can specify the buffer using only a few keystrokes. In the above
92;; example, the quickest way to get to the "123456" buffer would be
ccd2f997 93;; just to type 4 and then RET (assuming there isn't any newer buffer
962a4216
RS
94;; with 4 in its name).
95
96;; To see a full list of all matching buffers in a separate buffer,
97;; hit ? or press TAB when there are no further completions to the
ccd2f997
KH
98;; substring. Repeated TAB presses will scroll you through this
99;; separate buffer.
962a4216 100
36a3b01c
RS
101;; The buffer at the head of the list can be killed by pressing C-k.
102;; If the buffer needs saving, you will be queried before the buffer
103;; is killed.
104
105;; If you find that the file you are after is not in a buffer, you can
106;; press C-x C-f to immediately drop into find-file.
107
4d8ae757
RS
108;; See the doc string of iswitchb for full keybindings and features.
109;; (describe-function 'iswitchb)
962a4216 110
8097dd15
GM
111;; Case matching: The case of strings when matching can be ignored or
112;; used depending on the value of iswitchb-case (default is the same
113;; as case-fold-search, normally t). Imagine you have the following
19db4308 114;; buffers:
8097dd15
GM
115;;
116;; INBOX *info* *scratch*
117;;
118;; Then these will be the matching buffers, depending on how you type
119;; the two letters `in' and the value of iswitchb-case:
120;;
121;; iswitchb-case user input | matching buffers
122;; ----------------------------------------------
19db4308
DL
123;; nil in | *info*
124;; t in | INBOX, *info*
125;; t IN | INBOX
126;; t In | [No match]
8097dd15 127
962a4216
RS
128;;; Customisation
129
130;; See the User Variables section below for easy ways to change the
36a3b01c
RS
131;; functionality of the program. These are accessible using the
132;; custom package.
8ae3ef6e 133;; To modify the keybindings, use something like:
962a4216 134;;
8ae3ef6e 135;;(add-hook 'iswitchb-mode-hook 'iswitchb-my-keys)
962a4216 136;;(defun iswitchb-my-keys ()
ccd2f997 137;; "Add my keybindings for iswitchb."
8ae3ef6e 138;; (define-key iswitchb-mode-map " " 'iswitchb-next-match))
962a4216 139;;
6b0cc1b5 140;; Seeing all the matching buffers
36a3b01c 141;;
962a4216 142;; If you have many matching buffers, they may not all fit onto one
f05b502e
GM
143;; line of the minibuffer. In Emacs 21, the variable
144;; `resize-mini-windows' controls how many lines of the minibuffer can
145;; be seen. For older versions of emacs, you can use
146;; `resize-minibuffer-mode'. You can also limit iswitchb so that it
962a4216
RS
147;; only shows a certain number of lines -- see the documentation for
148;; `iswitchb-minibuffer-setup-hook'.
149
6b0cc1b5 150;; Changing the list of buffers
962a4216
RS
151
152;; By default, the list of current buffers is most recent first,
153;; oldest last, with the exception that the buffers visible in the
154;; current frame are put at the end of the list. A hook exists to
155;; allow other functions to order the list. For example, if you add:
156;;
157;; (add-hook 'iswitchb-make-buflist-hook 'iswitchb-summaries-to-end)
158;;
159;; then all buffers matching "Summary" are moved to the end of the
160;; list. (I find this handy for keeping the INBOX Summary and so on
161;; out of the way.) It also moves buffers matching "output\*$" to the
162;; end of the list (these are created by AUC TeX when compiling.)
163;; Other functions could be made available which alter the list of
164;; matching buffers (either deleting or rearranging elements.)
165
166;; Font-Lock
167
168;; If you have font-lock loaded, the first matching buffer is
169;; highlighted. To switch this off, set (setq iswitchb-use-fonts nil)
170;; I don't use font-lock that much, so I've hardcoded the faces. If
171;; this is too harsh, let me know. Colouring of the matching buffer
172;; name was suggested by Carsten Dominik (dominik@strw.leidenuniv.nl)
173
6b0cc1b5 174;; Replacement for read-buffer
962a4216 175
ccd2f997
KH
176;; iswitchb-read-buffer has been written to be a drop in replacement
177;; for the normal buffer selection routine `read-buffer'. To use
c6e5b93f 178;; iswitch for all buffer selections in Emacs, add:
ccd2f997 179;; (setq read-buffer-function 'iswitchb-read-buffer)
4d8ae757 180;; (This variable was introduced in Emacs 20.3.)
c6e5b93f 181;; XEmacs users can get the same behaviour by doing:
19db4308 182;; (defalias 'read-buffer 'iswitchb-read-buffer)
c6e5b93f 183;; since `read-buffer' is defined in lisp.
36a3b01c 184
4d8ae757
RS
185;; Using iswitchb for other completion tasks.
186
a2c060f6 187;; Kin Cho (kin@neoscale.com) sent the following suggestion to use
f1180544 188;; iswitchb for other completion tasks.
4d8ae757
RS
189;;
190;; (defun my-icompleting-read (prompt choices)
191;; "Use iswitch as a completing-read replacement to choose from
192;; choices. PROMPT is a string to prompt with. CHOICES is a list of
193;; strings to choose from."
194;; (let ((iswitchb-make-buflist-hook
195;; (lambda ()
196;; (setq iswitchb-temp-buflist choices))))
197;; (iswitchb-read-buffer prompt)))
198;;
199;; example:
200;; (my-icompleting-read "Which fruit? " '
201;; ("apple" "pineapple" "pear" "bananas" "oranges") )
202
a2c060f6
PJ
203;; Kin Cho also suggested the following defun. Once you have a subset of
204;; matching buffers matching your current prompt, you can then press
205;; e.g. C-o to restrict matching to those buffers and clearing the prompt:
206;; (defun iswitchb-exclude-nonmatching()
207;; "Make iswitchb work on only the currently matching names."
208;; (interactive)
209;; (setq iswitchb-buflist iswitchb-matches)
210;; (setq iswitchb-rescan t)
211;; (delete-minibuffer-contents))
212;;
213;; (add-hook 'iswitchb-define-mode-map-hook
f1180544
JB
214;; '(lambda () (define-key
215;; iswitchb-mode-map "\C-o"
a2c060f6
PJ
216;; 'iswitchb-exclude-nonmatching)))
217
4d8ae757
RS
218;; Other lisp packages extend iswitchb behaviour to other tasks. See
219;; ido.el (by Kim Storm) and mcomplete.el (Yuji Minejima).
220
221;; Window managers: Switching frames/focus follows mouse; Sawfish.
222
223;; If you switch to a buffer that is visible in another frame,
224;; iswitchb can switch focus to that frame. If your window manager
225;; uses "click to focus" policy for window selection, you should also
226;; set focus-follows-mouse to nil.
227
228;; iswitch functionality has also been implemented for switching
229;; between windows in the Sawfish window manager.
230
6b0cc1b5
SE
231;; Regexp matching
232
233;; There is limited provision for regexp matching within iswitchb,
234;; enabled through `iswitchb-regexp'. This allows you to type `c$'
235;; for example and see all buffer names ending in `c'. This facility
236;; is quite limited though in two respects. First, you can't
237;; currently type in expressions like `[0-9]' directly -- you have to
238;; type them in when iswitchb-regexp is nil and then toggle on the
239;; regexp functionality. Likewise, don't enter an expression
240;; containing `\' in regexp mode. If you try, iswitchb gets confused,
241;; so just hit C-g and try again. Secondly, no completion mechanism
242;; is currently offered when regexp searching.
243
ccd2f997 244;;; TODO
36a3b01c 245
962a4216
RS
246;;; Acknowledgements
247
248;; Thanks to Jari Aalto <jari.aalto@poboxes.com> for help with the
249;; first version of this package, iswitch-buffer. Thanks also to many
250;; others for testing earlier versions.
251
252;;; Code:
253
c6e5b93f 254;; CL needed for cadr and last
181688f2
SE
255(if (not (and (fboundp 'cadr)
256 (fboundp 'last)))
257 (require 'cl))
c6e5b93f 258
36a3b01c
RS
259;; Set up the custom library.
260;; taken from http://www.dina.kvl.dk/~abraham/custom/
261(eval-and-compile
262 (condition-case ()
263 (require 'custom)
264 (error nil))
265 (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
266 nil ;; We've got what we needed
267 ;; We have the old custom-library, hack around it!
268 (defmacro defgroup (&rest args)
269 nil)
19db4308 270 (defmacro defcustom (var value doc &rest args)
b787fc05 271 `(defvar ,var ,value ,doc))))
36a3b01c 272
962a4216
RS
273;;; User Variables
274;;
275;; These are some things you might want to change.
276
36a3b01c 277(defgroup iswitchb nil
c6e5b93f 278 "Switch between buffers using substrings."
f5f727f8 279 :group 'convenience
19db4308 280 :group 'completion
36a3b01c 281 :link '(emacs-commentary-link :tag "Commentary" "iswitchb.el")
19db4308 282 :link '(url-link "http://www.anc.ed.ac.uk/~stephen/emacs/")
181688f2 283 :link '(emacs-library-link :tag "Lisp File" "iswitchb.el"))
36a3b01c
RS
284
285(defcustom iswitchb-case case-fold-search
8097dd15
GM
286 "*Non-nil if searching of buffer names should ignore case.
287If this is non-nil but the user input has any upper case letters, matching
288is temporarily case sensitive."
36a3b01c
RS
289 :type 'boolean
290 :group 'iswitchb)
962a4216 291
36a3b01c 292(defcustom iswitchb-buffer-ignore
962a4216 293 '("^ ")
6c56c80b
RS
294 "*List of regexps or functions matching buffer names to ignore.
295For example, traditional behavior is not to list buffers whose names begin
296with a space, for which the regexp is `^ '. See the source file for
36a3b01c 297example functions that filter buffernames."
e47525c4 298 :type '(repeat (choice regexp function))
36a3b01c
RS
299 :group 'iswitchb)
300
c80d9534
JW
301(defcustom iswitchb-max-to-show nil
302 "*If non-nil, limit the number of names shown in the minibuffer.
f329780b
SE
303If this value is N, and N is greater than the number of matching
304buffers, the first N/2 and the last N/2 matching buffers are
305shown. This can greatly speed up iswitchb if you have a
306multitude of buffers open."
06f4589a 307 :type '(choice (const :tag "Disable" nil) integer)
c80d9534
JW
308 :group 'iswitchb)
309
c9403808
RS
310(defcustom iswitchb-cannot-complete-hook 'iswitchb-completion-help
311 "*Hook run when `iswitchb-complete' can't complete any more.
312The most useful values are `iswitchb-completion-help', which pops up a
313window with completion alternatives, or `iswitchb-next-match' or
314`iswitchb-prev-match', which cycle the buffer list."
315 :type 'hook
316 :group 'iswitchb)
317
962a4216 318;;; Examples for setting the value of iswitchb-buffer-ignore
6b0cc1b5 319;(defun iswitchb-ignore-c-mode (name)
962a4216
RS
320; "Ignore all c mode buffers -- example function for iswitchb."
321; (save-excursion
322; (set-buffer name)
323; (string-match "^C$" mode-name)))
324
6b0cc1b5 325;(setq iswitchb-buffer-ignore '("^ " iswitchb-ignore-c-mode))
962a4216
RS
326;(setq iswitchb-buffer-ignore '("^ " "\\.c$" "\\.h$"))
327
36a3b01c 328(defcustom iswitchb-default-method 'always-frame
6c56c80b 329 "*How to switch to new buffer when using `iswitchb-buffer'.
962a4216
RS
330Possible values:
331`samewindow' Show new buffer in same window
332`otherwindow' Show new buffer in another window (same frame)
888472e0 333`display' Display buffer in another window without switching to it
962a4216
RS
334`otherframe' Show new buffer in another frame
335`maybe-frame' If a buffer is visible in another frame, prompt to ask if you
336 you want to see the buffer in the same window of the current
337 frame or in the other frame.
c6e5b93f 338`always-frame' If a buffer is visible in another frame, raise that
36a3b01c 339 frame. Otherwise, visit the buffer in the same window."
19db4308 340 :type '(choice (const samewindow)
c6e5b93f
SE
341 (const otherwindow)
342 (const display)
19db4308 343 (const otherframe)
c6e5b93f
SE
344 (const maybe-frame)
345 (const always-frame))
36a3b01c 346 :group 'iswitchb)
962a4216 347
36a3b01c 348(defcustom iswitchb-regexp nil
6c56c80b 349 "*Non-nil means that `iswitchb' will do regexp matching.
6b0cc1b5 350Value can be toggled within `iswitchb' using `iswitchb-toggle-regexp'."
36a3b01c
RS
351 :type 'boolean
352 :group 'iswitchb)
353
36a3b01c 354(defcustom iswitchb-newbuffer t
962a4216 355 "*Non-nil means create new buffer if no buffer matches substring.
36a3b01c
RS
356See also `iswitchb-prompt-newbuffer'."
357 :type 'boolean
358 :group 'iswitchb)
962a4216 359
36a3b01c 360(defcustom iswitchb-prompt-newbuffer t
962a4216 361 "*Non-nil means prompt user to confirm before creating new buffer.
36a3b01c
RS
362See also `iswitchb-newbuffer'."
363 :type 'boolean
364 :group 'iswitchb)
365
36a3b01c 366(defcustom iswitchb-use-fonts t
6b0cc1b5 367 "*Non-nil means use font-lock fonts for showing first match."
36a3b01c
RS
368 :type 'boolean
369 :group 'iswitchb)
962a4216 370
f5bd1691
GM
371(defcustom iswitchb-use-frame-buffer-list nil
372 "*Non-nil means use the currently selected frame's buffer list."
373 :type 'boolean
374 :group 'iswitchb)
375
36a3b01c 376(defcustom iswitchb-make-buflist-hook nil
19db4308 377 "Hook to run when list of matching buffers is created."
36a3b01c
RS
378 :type 'hook
379 :group 'iswitchb)
380
962a4216
RS
381(defvar iswitchb-all-frames 'visible
382 "*Argument to pass to `walk-windows' when finding visible buffers.
383See documentation of `walk-windows' for useful values.")
384
6b0cc1b5 385(defcustom iswitchb-minibuffer-setup-hook nil
19db4308 386 "Iswitchb-specific customization of minibuffer setup.
962a4216 387
6c56c80b 388This hook is run during minibuffer setup iff `iswitchb' will be active.
33a316ba
SE
389For instance:
390\(add-hook 'iswitchb-minibuffer-setup-hook
391 '\(lambda () (set (make-local-variable 'max-mini-window-height) 3)))
392will constrain the minibuffer to a maximum height of 3 lines when
393iswitchb is running."
6b0cc1b5
SE
394 :type 'hook
395 :group 'iswitchb)
396
397;; Do we need the variable iswitchb-use-mycompletion?
398
6b0cc1b5
SE
399;;; Internal Variables
400
401(defvar iswitchb-method nil
19db4308 402 "Stores the method for viewing the selected buffer.
6b0cc1b5
SE
403Its value is one of `samewindow', `otherwindow', `display', `otherframe',
404`maybe-frame' or `always-frame'. See `iswitchb-default-method' for
405details of values.")
962a4216
RS
406
407(defvar iswitchb-eoinput 1
408 "Point where minibuffer input ends and completion info begins.
6c56c80b 409Copied from `icomplete-eoinput'.")
962a4216
RS
410(make-variable-buffer-local 'iswitchb-eoinput)
411
962a4216
RS
412(defvar iswitchb-buflist nil
413 "Stores the current list of buffers that will be searched through.
414The list is ordered, so that the most recent buffers come first,
415although by default, the buffers visible in the current frame are put
416at the end of the list. Created by `iswitchb-make-buflist'.")
417
418;; todo -- is this necessary?
419
420(defvar iswitchb-use-mycompletion nil
19db4308 421 "Non-nil means use `iswitchb-buffer' completion feedback.
6c56c80b
RS
422Should only be set to t by iswitchb functions, so that it doesn't
423interfere with other minibuffer usage.")
962a4216 424
19db4308 425(defvar iswitchb-change-word-sub nil
962a4216
RS
426 "Private variable used by `iswitchb-word-matching-substring'.")
427
962a4216
RS
428(defvar iswitchb-common-match-string nil
429 "Stores the string that is common to all matching buffers.")
430
962a4216
RS
431(defvar iswitchb-rescan nil
432 "Non-nil means we need to regenerate the list of matching buffers.")
433
434(defvar iswitchb-text nil
435 "Stores the users string as it is typed in.")
436
437(defvar iswitchb-matches nil
ccd2f997 438 "List of buffers currently matching `iswitchb-text'.")
962a4216 439
19db4308
DL
440(defvar iswitchb-mode-map
441 (let ((map (make-sparse-keymap)))
442 (set-keymap-parent map minibuffer-local-map)
443 (define-key map "?" 'iswitchb-completion-help)
444 (define-key map "\C-s" 'iswitchb-next-match)
445 (define-key map "\C-r" 'iswitchb-prev-match)
446 (define-key map "\t" 'iswitchb-complete)
447 (define-key map "\C-j" 'iswitchb-select-buffer-text)
448 (define-key map "\C-t" 'iswitchb-toggle-regexp)
449 (define-key map "\C-x\C-f" 'iswitchb-find-file)
450 (define-key map "\C-c" 'iswitchb-toggle-case)
451 (define-key map "\C-k" 'iswitchb-kill-buffer)
452 (define-key map "\C-m" 'iswitchb-exit-minibuffer)
453 map)
454 "Minibuffer keymap for `iswitchb-buffer'.")
455
456(defvar iswitchb-global-map
457 (let ((map (make-sparse-keymap)))
458 (substitute-key-definition 'switch-to-buffer ; normally C-x b
459 'iswitchb-buffer map global-map)
460 (substitute-key-definition 'switch-to-buffer-other-window ; C-x 4 b
461 'iswitchb-buffer-other-window map global-map)
462 (substitute-key-definition 'switch-to-buffer-other-frame ; C-x 5 b
463 'iswitchb-buffer-other-frame map global-map)
464 (substitute-key-definition 'display-buffer ; C-x 4 C-o
465 'iswitchb-display-buffer map global-map)
466 map)
467 "Global keymap for `iswtichb-mode'.")
468
469(defvar iswitchb-history nil
6c56c80b 470 "History of buffers selected using `iswitchb-buffer'.")
962a4216 471
19db4308
DL
472(defvar iswitchb-exit nil
473 "Flag to monitor how `iswitchb-buffer' exits.
6c56c80b
RS
474If equal to `takeprompt', we use the prompt as the buffer name to be
475selected.")
962a4216
RS
476
477(defvar iswitchb-buffer-ignore-orig nil
478 "Stores original value of `iswitchb-buffer-ignore'.")
479
6b0cc1b5
SE
480(defvar iswitchb-default nil
481 "Default buffer for iswitchb.")
962a4216 482
02e526ad
SE
483;; The following variables are needed to keep the byte compiler quiet.
484(defvar iswitchb-require-match nil
485 "Non-nil if matching buffer must be selected.")
486
487(defvar iswitchb-temp-buflist nil
488 "Stores a temporary version of the buffer list being created.")
489
490(defvar iswitchb-bufs-in-frame nil
491 "List of the buffers visible in the current frame.")
492
c7b89861
EZ
493(defvar iswitchb-minibuf-depth nil
494 "Value we expect to be returned by `minibuffer-depth' in the minibuffer.")
495
962a4216
RS
496;;; FUNCTIONS
497
19db4308 498;;; ISWITCHB KEYMAP
962a4216 499(defun iswitchb-define-mode-map ()
19db4308
DL
500 "Set up the keymap for `iswitchb-buffer'.
501This is obsolete. Use \\[iswitchb-mode] or customize the
502variable `iswitchb-mode'."
962a4216
RS
503 (interactive)
504 (let (map)
ccd2f997 505 ;; generated every time so that it can inherit new functions.
962a4216
RS
506 ;;(or iswitchb-mode-map
507
508 (setq map (copy-keymap minibuffer-local-map))
509 (define-key map "?" 'iswitchb-completion-help)
510 (define-key map "\C-s" 'iswitchb-next-match)
511 (define-key map "\C-r" 'iswitchb-prev-match)
512 (define-key map "\t" 'iswitchb-complete)
513 (define-key map "\C-j" 'iswitchb-select-buffer-text)
514 (define-key map "\C-t" 'iswitchb-toggle-regexp)
36a3b01c 515 (define-key map "\C-x\C-f" 'iswitchb-find-file)
962a4216
RS
516 ;;(define-key map "\C-a" 'iswitchb-toggle-ignore)
517 (define-key map "\C-c" 'iswitchb-toggle-case)
36a3b01c 518 (define-key map "\C-k" 'iswitchb-kill-buffer)
ccd2f997 519 (define-key map "\C-m" 'iswitchb-exit-minibuffer)
962a4216 520 (setq iswitchb-mode-map map)
181688f2 521 (run-hooks 'iswitchb-define-mode-map-hook)))
f1180544 522
962a4216
RS
523;;; MAIN FUNCTION
524(defun iswitchb ()
525 "Switch to buffer matching a substring.
526As you type in a string, all of the buffers matching the string are
527displayed. When you have found the buffer you want, it can then be
528selected. As you type, most keys have their normal keybindings,
529except for the following:
530\\<iswitchb-mode-map>
531
532RET Select the buffer at the front of the list of matches. If the
6c56c80b 533list is empty, possibly prompt to create new buffer.
962a4216
RS
534
535\\[iswitchb-select-buffer-text] Select the current prompt as the buffer.
536If no buffer is found, prompt for a new one.
537
538\\[iswitchb-next-match] Put the first element at the end of the list.
539\\[iswitchb-prev-match] Put the last element at the start of the list.
19db4308 540\\[iswitchb-complete] Complete a common suffix to the current string that
962a4216
RS
541matches all buffers. If there is only one match, select that buffer.
542If there is no common suffix, show a list of all matching buffers
543in a separate window.
ccd2f997 544\\[iswitchb-toggle-regexp] Toggle regexp searching.
962a4216 545\\[iswitchb-toggle-case] Toggle case-sensitive searching of buffer names.
36a3b01c 546\\[iswitchb-completion-help] Show list of matching buffers in separate window.
19db4308 547\\[iswitchb-find-file] Exit iswitchb and drop into `find-file'.
36a3b01c 548\\[iswitchb-kill-buffer] Kill buffer at head of buffer list."
962a4216
RS
549 ;;\\[iswitchb-toggle-ignore] Toggle ignoring certain buffers (see \
550 ;;`iswitchb-buffer-ignore')
f1180544 551
8ae3ef6e
SM
552 (let* ((prompt "iswitch ")
553 (buf (iswitchb-read-buffer prompt)))
ccd2f997 554
ccd2f997
KH
555 ;;(message "chosen text %s" iswitchb-final-text)
556 ;; Choose the buffer name: either the text typed in, or the head
557 ;; of the list of matches
558
559 (cond ( (eq iswitchb-exit 'findfile)
560 (call-interactively 'find-file))
561
562 (t
563 ;; View the buffer
c6e5b93f 564 ;;(message "go to buf %s" buf)
ccd2f997
KH
565 ;; Check buf is non-nil.
566 (if buf
567 (if (get-buffer buf)
568 ;; buffer exists, so view it and then exit
569 (iswitchb-visit-buffer buf)
570 ;; else buffer doesn't exist
571 (iswitchb-possible-new-buffer buf)))
181688f2 572 ))))
ccd2f997 573
abc8b974 574;;;###autoload
ccd2f997
KH
575(defun iswitchb-read-buffer (prompt &optional default require-match)
576 "Replacement for the built-in `read-buffer'.
19db4308 577Return the name of a buffer selected.
ccd2f997
KH
578PROMPT is the prompt to give to the user. DEFAULT if given is the default
579buffer to be selected, which will go to the front of the list.
580If REQUIRE-MATCH is non-nil, an existing-buffer must be selected."
962a4216
RS
581 (let
582 (
962a4216
RS
583 buf-sel
584 iswitchb-final-text
962a4216 585 (icomplete-mode nil) ;; prevent icomplete starting up
962a4216
RS
586 ;; can only use fonts if they have been bound.
587 (iswitchb-use-fonts (and iswitchb-use-fonts
588 (boundp 'font-lock-comment-face)
ccd2f997
KH
589 (boundp 'font-lock-function-name-face))))
590
962a4216 591 (iswitchb-define-mode-map)
962a4216
RS
592 (setq iswitchb-exit nil)
593 (setq iswitchb-rescan t)
594 (setq iswitchb-text "")
6b0cc1b5
SE
595 (setq iswitchb-default
596 (if (bufferp default)
597 (buffer-name default)
598 default))
599 (iswitchb-make-buflist iswitchb-default)
36a3b01c 600 (iswitchb-set-matches)
19db4308 601 (let
ccd2f997 602 ((minibuffer-local-completion-map iswitchb-mode-map)
c7b89861
EZ
603 ;; Record the minibuffer depth that we expect to find once
604 ;; the minibuffer is set up and iswitchb-entryfn-p is called.
605 (iswitchb-minibuf-depth (1+ (minibuffer-depth)))
181688f2 606 (iswitchb-require-match require-match))
36a3b01c 607 ;; prompt the user for the buffer name
19db4308 608 (setq iswitchb-final-text (completing-read
ccd2f997 609 prompt ;the prompt
660e161f 610 '(("dummy" . 1)) ;table
ccd2f997
KH
611 nil ;predicate
612 nil ;require-match [handled elsewhere]
613 nil ;initial-contents
614 'iswitchb-history)))
4dddd07f
SE
615 (if (and (not (eq iswitchb-exit 'usefirst))
616 (get-buffer iswitchb-final-text))
8ae3ef6e
SM
617 ;; This happens for example if the buffer was chosen with the mouse.
618 (setq iswitchb-matches (list iswitchb-final-text)))
619
ccd2f997
KH
620 ;; Handling the require-match must be done in a better way.
621 (if (and require-match (not (iswitchb-existing-buffer-p)))
19db4308 622 (error "Must specify valid buffer"))
ccd2f997 623
19db4308 624 (if (or
ccd2f997
KH
625 (eq iswitchb-exit 'takeprompt)
626 (null iswitchb-matches))
627 (setq buf-sel iswitchb-final-text)
628 ;; else take head of list
629 (setq buf-sel (car iswitchb-matches)))
f1180544 630
ccd2f997 631 ;; Or possibly choose the default buffer
19db4308
DL
632 (if (equal iswitchb-final-text "")
633 (setq buf-sel
ccd2f997 634 (car iswitchb-matches)))
36a3b01c 635
ccd2f997 636 buf-sel))
36a3b01c 637
ccd2f997
KH
638(defun iswitchb-existing-buffer-p ()
639 "Return non-nil if there is a matching buffer."
640 (not (null iswitchb-matches)))
962a4216
RS
641
642;;; COMPLETION CODE
643
644(defun iswitchb-set-common-completion ()
6c56c80b
RS
645 "Find common completion of `iswitchb-text' in `iswitchb-matches'.
646The result is stored in `iswitchb-common-match-string'."
962a4216
RS
647
648 (let* (val)
649 (setq iswitchb-common-match-string nil)
650 (if (and iswitchb-matches
6b0cc1b5 651 (not iswitchb-regexp) ;; testing
962a4216
RS
652 (stringp iswitchb-text)
653 (> (length iswitchb-text) 0))
654 (if (setq val (iswitchb-find-common-substring
655 iswitchb-matches iswitchb-text))
656 (setq iswitchb-common-match-string val)))
181688f2 657 val))
962a4216
RS
658
659(defun iswitchb-complete ()
660 "Try and complete the current pattern amongst the buffer names."
661 (interactive)
662 (let (res)
663 (cond ((not iswitchb-matches)
c9403808 664 (run-hooks 'iswitchb-cannot-complete-hook))
f1180544 665
ccd2f997 666 ((= 1 (length iswitchb-matches))
962a4216
RS
667 ;; only one choice, so select it.
668 (exit-minibuffer))
f1180544 669
962a4216
RS
670 (t
671 ;; else there could be some completions
6b0cc1b5 672 (setq res iswitchb-common-match-string)
962a4216 673 (if (and (not (memq res '(t nil)))
36a3b01c 674 (not (equal res iswitchb-text)))
ccd2f997 675 ;; found something to complete, so put it in the minibuffer.
962a4216
RS
676 (progn
677 (setq iswitchb-rescan nil)
53811b42 678 (delete-region (minibuffer-prompt-end) (point))
962a4216
RS
679 (insert res))
680 ;; else nothing to complete
c9403808 681 (run-hooks 'iswitchb-cannot-complete-hook)
181688f2 682 )))))
962a4216
RS
683
684;;; TOGGLE FUNCTIONS
685
686(defun iswitchb-toggle-case ()
19db4308 687 "Toggle the value of variable `iswitchb-case'."
962a4216
RS
688 (interactive)
689 (setq iswitchb-case (not iswitchb-case))
690 ;; ask for list to be regenerated.
181688f2 691 (setq iswitchb-rescan t))
962a4216
RS
692
693(defun iswitchb-toggle-regexp ()
694 "Toggle the value of `iswitchb-regexp'."
695 (interactive)
696 (setq iswitchb-regexp (not iswitchb-regexp))
697 ;; ask for list to be regenerated.
181688f2 698 (setq iswitchb-rescan t))
962a4216
RS
699
700(defun iswitchb-toggle-ignore ()
701 "Toggle ignoring buffers specified with `iswitchb-buffer-ignore'."
702 (interactive)
703 (if iswitchb-buffer-ignore
704 (progn
705 (setq iswitchb-buffer-ignore-orig iswitchb-buffer-ignore)
181688f2 706 (setq iswitchb-buffer-ignore nil))
962a4216 707 ;; else
181688f2 708 (setq iswitchb-buffer-ignore iswitchb-buffer-ignore-orig))
6b0cc1b5 709 (iswitchb-make-buflist iswitchb-default)
962a4216 710 ;; ask for list to be regenerated.
181688f2 711 (setq iswitchb-rescan t))
962a4216 712
ccd2f997
KH
713(defun iswitchb-exit-minibuffer ()
714 "Exit minibuffer, but make sure we have a match if one is needed."
715 (interactive)
716 (if (or (not iswitchb-require-match)
717 (iswitchb-existing-buffer-p))
4dddd07f
SE
718 (progn
719 (setq iswitchb-exit 'usefirst)
720 (throw 'exit nil))))
962a4216
RS
721
722(defun iswitchb-select-buffer-text ()
6c56c80b
RS
723 "Select the buffer named by the prompt.
724If no buffer exactly matching the prompt exists, maybe create a new one."
962a4216
RS
725 (interactive)
726 (setq iswitchb-exit 'takeprompt)
727 (exit-minibuffer))
728
36a3b01c 729(defun iswitchb-find-file ()
19db4308 730 "Drop into `find-file' from buffer switching."
36a3b01c
RS
731 (interactive)
732 (setq iswitchb-exit 'findfile)
733 (exit-minibuffer))
734
19db4308 735(defun iswitchb-next-match ()
962a4216
RS
736 "Put first element of `iswitchb-matches' at the end of the list."
737 (interactive)
36a3b01c
RS
738 (let ((next (cadr iswitchb-matches)))
739 (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist next))
181688f2 740 (setq iswitchb-rescan t)))
962a4216 741
19db4308 742(defun iswitchb-prev-match ()
962a4216
RS
743 "Put last element of `iswitchb-matches' at the front of the list."
744 (interactive)
36a3b01c
RS
745 (let ((prev (car (last iswitchb-matches))))
746 (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist prev))
181688f2 747 (setq iswitchb-rescan t)))
36a3b01c
RS
748
749(defun iswitchb-chop (list elem)
750 "Remove all elements before ELEM and put them at the end of LIST."
751 (let ((ret nil)
752 (next nil)
753 (sofar nil))
754 (while (not ret)
755 (setq next (car list))
756 (if (equal next elem)
757 (setq ret (append list (nreverse sofar)))
758 ;; else
759 (progn
760 (setq list (cdr list))
761 (setq sofar (cons next sofar)))))
762 ret))
962a4216 763
962a4216
RS
764;;; CREATE LIST OF ALL CURRENT BUFFERS
765
ccd2f997 766(defun iswitchb-make-buflist (default)
6c56c80b 767 "Set `iswitchb-buflist' to the current list of buffers.
36a3b01c 768Currently visible buffers are put at the end of the list.
19db4308 769The hook `iswitchb-make-buflist-hook' is run after the list has been
36a3b01c 770created to allow the user to further modify the order of the buffer names
ccd2f997
KH
771in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
772it is put to the start of the list."
19db4308 773 (setq iswitchb-buflist
36a3b01c 774 (let* ((iswitchb-current-buffers (iswitchb-get-buffers-in-frames))
ceba0dac
GM
775 (iswitchb-temp-buflist
776 (delq nil
777 (mapcar
778 (lambda (x)
779 (let ((b-name (buffer-name x)))
780 (if (not
781 (or
782 (iswitchb-ignore-buffername-p b-name)
783 (memq b-name iswitchb-current-buffers)))
784 b-name)))
785 (buffer-list (and iswitchb-use-frame-buffer-list
786 (selected-frame)))))))
787 (setq iswitchb-temp-buflist
788 (nconc iswitchb-temp-buflist iswitchb-current-buffers))
962a4216 789 (run-hooks 'iswitchb-make-buflist-hook)
ceba0dac 790 ;; Should this be after the hooks, or should the hooks be the
ccd2f997
KH
791 ;; final thing to be run?
792 (if default
793 (progn
19db4308 794 (setq iswitchb-temp-buflist
02e526ad 795 (delete default iswitchb-temp-buflist))
19db4308 796 (setq iswitchb-temp-buflist
02e526ad
SE
797 (cons default iswitchb-temp-buflist))))
798 iswitchb-temp-buflist)))
962a4216 799
36a3b01c 800(defun iswitchb-to-end (lst)
02e526ad 801 "Move the elements from LST to the end of `iswitchb-temp-buflist'."
19db4308
DL
802 (mapcar
803 (lambda (elem)
02e526ad 804 (setq iswitchb-temp-buflist (delq elem iswitchb-temp-buflist)))
36a3b01c 805 lst)
ceba0dac 806 (setq iswitchb-temp-buflist (nconc iswitchb-temp-buflist lst)))
962a4216 807
962a4216 808(defun iswitchb-get-buffers-in-frames (&optional current)
962a4216 809 "Return the list of buffers that are visible in the current frame.
19db4308 810If optional argument CURRENT is given, restrict searching to the
962a4216
RS
811current frame, rather than all frames, regardless of value of
812`iswitchb-all-frames'."
962a4216 813 (let ((iswitchb-bufs-in-frame nil))
962a4216 814 (walk-windows 'iswitchb-get-bufname nil
19db4308 815 (if current
962a4216
RS
816 nil
817 iswitchb-all-frames))
818 iswitchb-bufs-in-frame))
819
962a4216
RS
820(defun iswitchb-get-bufname (win)
821 "Used by `iswitchb-get-buffers-in-frames' to walk through all windows."
ae5ac7d0
RS
822 (let ((buf (buffer-name (window-buffer win))))
823 (if (not (member buf iswitchb-bufs-in-frame))
824 ;; Only add buf if it is not already in list.
825 ;; This prevents same buf in two different windows being
826 ;; put into the list twice.
827 (setq iswitchb-bufs-in-frame
828 (cons buf iswitchb-bufs-in-frame)))))
962a4216 829
962a4216
RS
830;;; FIND MATCHING BUFFERS
831
832(defun iswitchb-set-matches ()
833 "Set `iswitchb-matches' to the list of buffers matching prompt."
962a4216
RS
834 (if iswitchb-rescan
835 (setq iswitchb-matches
181688f2 836 (let* ((buflist iswitchb-buflist))
36a3b01c 837 (iswitchb-get-matched-buffers iswitchb-text iswitchb-regexp
6b0cc1b5 838 buflist)))))
36a3b01c
RS
839
840(defun iswitchb-get-matched-buffers (regexp
841 &optional string-format buffer-list)
6b0cc1b5
SE
842 "Return buffers matching REGEXP.
843If STRING-FORMAT is nil, consider REGEXP as just a string.
6c56c80b 844BUFFER-LIST can be list of buffers or list of strings."
8097dd15 845 (let* ((case-fold-search (iswitchb-case))
962a4216
RS
846 ;; need reverse since we are building up list backwards
847 (list (reverse buffer-list))
6b0cc1b5 848 (do-string (stringp (car list)))
962a4216 849 name
181688f2 850 ret)
962a4216 851 (mapcar
36a3b01c 852 (lambda (x)
f1180544 853
36a3b01c
RS
854 (if do-string
855 (setq name x) ;We already have the name
856 (setq name (buffer-name x)))
f1180544 857
36a3b01c
RS
858 (cond
859 ((and (or (and string-format (string-match regexp name))
860 (and (null string-format)
861 (string-match (regexp-quote regexp) name)))
f1180544 862
181688f2 863 (not (iswitchb-ignore-buffername-p name)))
36a3b01c
RS
864 (setq ret (cons name ret))
865 )))
962a4216 866 list)
181688f2 867 ret))
962a4216
RS
868
869(defun iswitchb-ignore-buffername-p (bufname)
870 "Return t if the buffer BUFNAME should be ignored."
871 (let ((data (match-data))
872 (re-list iswitchb-buffer-ignore)
873 ignorep
181688f2 874 nextstr)
962a4216
RS
875 (while re-list
876 (setq nextstr (car re-list))
877 (cond
878 ((stringp nextstr)
879 (if (string-match nextstr bufname)
880 (progn
881 (setq ignorep t)
882 (setq re-list nil))))
883 ((fboundp nextstr)
884 (if (funcall nextstr bufname)
885 (progn
886 (setq ignorep t)
181688f2 887 (setq re-list nil)))))
962a4216 888 (setq re-list (cdr re-list)))
25c80f5c 889 (set-match-data data)
962a4216
RS
890
891 ;; return the result
181688f2 892 ignorep))
962a4216 893
962a4216
RS
894(defun iswitchb-word-matching-substring (word)
895 "Return part of WORD before 1st match to `iswitchb-change-word-sub'.
896If `iswitchb-change-word-sub' cannot be found in WORD, return nil."
8097dd15 897 (let ((case-fold-search (iswitchb-case)))
962a4216
RS
898 (let ((m (string-match iswitchb-change-word-sub word)))
899 (if m
900 (substring word m)
901 ;; else no match
902 nil))))
903
962a4216
RS
904(defun iswitchb-find-common-substring (lis subs)
905 "Return common string following SUBS in each element of LIS."
906 (let (res
907 alist
181688f2 908 iswitchb-change-word-sub)
962a4216
RS
909 (setq iswitchb-change-word-sub
910 (if iswitchb-regexp
911 subs
912 (regexp-quote subs)))
913 (setq res (mapcar 'iswitchb-word-matching-substring lis))
ccd2f997 914 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
962a4216
RS
915 (setq alist (mapcar 'iswitchb-makealist res)) ;; could use an OBARRAY
916
917 ;; try-completion returns t if there is an exact match.
8097dd15 918 (let ((completion-ignore-case (iswitchb-case)))
962a4216 919
181688f2 920 (try-completion subs alist))))
962a4216
RS
921
922(defun iswitchb-makealist (res)
923 "Return dotted pair (RES . 1)."
924 (cons res 1))
925
926;; from Wayne Mesard <wmesard@esd.sgi.com>
927(defun iswitchb-rotate-list (lis)
19db4308 928 "Destructively remove the last element from LIS.
962a4216
RS
929Return the modified list with the last element prepended to it."
930 (if (<= (length lis) 1)
931 lis
932 (let ((las lis)
933 (prev lis))
934 (while (consp (cdr las))
935 (setq prev las
936 las (cdr las)))
937 (setcdr prev nil)
181688f2 938 (cons (car las) lis))))
962a4216
RS
939
940(defun iswitchb-completion-help ()
8ae3ef6e 941 "Show possible completions in a *Completions* buffer."
962a4216 942 ;; we could allow this buffer to be used to select match, but I think
36a3b01c 943 ;; choose-completion-string will need redefining, so it just inserts
19db4308 944 ;; choice with out any previous input.
962a4216 945 (interactive)
36a3b01c 946 (setq iswitchb-rescan nil)
8ae3ef6e
SM
947 (let ((buf (current-buffer))
948 (temp-buf "*Completions*")
949 (win))
ccd2f997 950
8ae3ef6e 951 (if (eq last-command this-command)
ccd2f997
KH
952 ;; scroll buffer
953 (progn
954 (set-buffer temp-buf)
955 (setq win (get-buffer-window temp-buf))
956 (if (pos-visible-in-window-p (point-max) win)
957 (set-window-start win (point-min))
958 (scroll-other-window))
181688f2 959 (set-buffer buf))
f1180544 960
ccd2f997 961 (with-output-to-temp-buffer temp-buf
2d839509 962 (if (featurep 'xemacs)
f1180544 963
ccd2f997
KH
964 ;; XEmacs extents are put on by default, doesn't seem to be
965 ;; any way of switching them off.
966 (display-completion-list (if iswitchb-matches
967 iswitchb-matches
968 iswitchb-buflist)
969 :help-string "iswitchb "
19db4308
DL
970 :activate-callback
971 (lambda (x y z)
972 (message "doesn't work yet, sorry!")))
ccd2f997 973 ;; else running Emacs
19db4308
DL
974 (with-current-buffer standard-output
975 (fundamental-mode))
ccd2f997 976 (display-completion-list (if iswitchb-matches
19db4308 977 iswitchb-matches
ccd2f997
KH
978 iswitchb-buflist))
979 )))))
980
36a3b01c
RS
981;;; KILL CURRENT BUFFER
982
983(defun iswitchb-kill-buffer ()
ccd2f997 984 "Kill the buffer at the head of `iswitchb-matches'."
36a3b01c
RS
985 (interactive)
986 (let ( (enable-recursive-minibuffers t)
987 buf)
988
989 (setq buf (car iswitchb-matches))
990 ;; check to see if buf is non-nil.
991 (if buf
992 (progn
993 (kill-buffer buf)
994
995 ;; Check if buffer exists. XEmacs gnuserv.el makes alias
996 ;; for kill-buffer which does not return t if buffer is
997 ;; killed, so we can't rely on kill-buffer return value.
998 (if (get-buffer buf)
999 ;; buffer couldn't be killed.
19db4308 1000 (setq iswitchb-rescan t)
36a3b01c
RS
1001 ;; else buffer was killed so remove name from list.
1002 (setq iswitchb-buflist (delq buf iswitchb-buflist)))))))
1003
962a4216
RS
1004;;; VISIT CHOSEN BUFFER
1005(defun iswitchb-visit-buffer (buffer)
1006 "Visit buffer named BUFFER according to `iswitchb-method'."
1007 (let* (win newframe)
1008 (cond
1009 ((eq iswitchb-method 'samewindow)
1010 (switch-to-buffer buffer))
1011
1012 ((memq iswitchb-method '(always-frame maybe-frame))
1013 (cond
1014 ((and (setq win (iswitchb-window-buffer-p buffer))
1015 (or (eq iswitchb-method 'always-frame)
1016 (y-or-n-p "Jump to frame? ")))
1017 (setq newframe (window-frame win))
2d839509 1018 (if (fboundp 'select-frame-set-input-focus)
4d8ae757
RS
1019 (select-frame-set-input-focus newframe)
1020 (raise-frame newframe)
1021 (select-frame newframe)
1022 )
1023 (select-window win))
962a4216
RS
1024 (t
1025 ;; No buffer in other frames...
1026 (switch-to-buffer buffer)
1027 )))
1028
962a4216
RS
1029 ((eq iswitchb-method 'otherwindow)
1030 (switch-to-buffer-other-window buffer))
1031
888472e0
RS
1032 ((eq iswitchb-method 'display)
1033 (display-buffer buffer))
1034
962a4216
RS
1035 ((eq iswitchb-method 'otherframe)
1036 (progn
1037 (switch-to-buffer-other-frame buffer)
2d839509 1038 (if (fboundp 'select-frame-set-input-focus)
4d8ae757 1039 (select-frame-set-input-focus (selected-frame)))
181688f2 1040 )))))
962a4216
RS
1041
1042(defun iswitchb-possible-new-buffer (buf)
1043 "Possibly create and visit a new buffer called BUF."
1044
1045 (let ((newbufcreated))
1046 (if (and iswitchb-newbuffer
1047 (or
1048 (not iswitchb-prompt-newbuffer)
f1180544 1049
962a4216
RS
1050 (and iswitchb-prompt-newbuffer
1051 (y-or-n-p
1052 (format
1053 "No buffer matching `%s', create one? "
1054 buf)))))
1055 ;; then create a new buffer
1056 (progn
1057 (setq newbufcreated (get-buffer-create buf))
1058 (if (fboundp 'set-buffer-major-mode)
1059 (set-buffer-major-mode newbufcreated))
1060 (iswitchb-visit-buffer newbufcreated))
1061 ;; else wont create new buffer
181688f2 1062 (message (format "no buffer matching `%s'" buf)))))
962a4216
RS
1063
1064(defun iswitchb-window-buffer-p (buffer)
6c56c80b
RS
1065 "Return window pointer if BUFFER is visible in another frame.
1066If BUFFER is visible in the current frame, return nil."
962a4216 1067 (interactive)
962a4216
RS
1068 (let ((blist (iswitchb-get-buffers-in-frames 'current)))
1069 ;;If the buffer is visible in current frame, return nil
1070 (if (memq buffer blist)
1071 nil
ccd2f997
KH
1072 ;; maybe in other frame or icon
1073 (get-buffer-window buffer 0) ; better than 'visible
962a4216
RS
1074 )))
1075
6c56c80b 1076;;;###autoload
962a4216 1077(defun iswitchb-default-keybindings ()
6c56c80b 1078 "Set up default keybindings for `iswitchb-buffer'.
ee5897a4 1079Call this function to override the normal bindings. This function also
19db4308
DL
1080adds a hook to the minibuffer.
1081
1082Obsolescent. Use `iswitchb-mode'."
962a4216 1083 (interactive)
ee5897a4 1084 (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
322524b2
SE
1085 (global-set-key "\C-xb" 'iswitchb-buffer)
1086 (global-set-key "\C-x4b" 'iswitchb-buffer-other-window)
1087 (global-set-key "\C-x4\C-o" 'iswitchb-display-buffer)
1088 (global-set-key "\C-x5b" 'iswitchb-buffer-other-frame))
962a4216 1089
962a4216
RS
1090;;;###autoload
1091(defun iswitchb-buffer ()
1092 "Switch to another buffer.
1093
1094The buffer name is selected interactively by typing a substring. The
1095buffer is displayed according to `iswitchb-default-method' -- the
1096default is to show it in the same window, unless it is already visible
6c56c80b
RS
1097in another frame.
1098For details of keybindings, do `\\[describe-function] iswitchb'."
962a4216
RS
1099 (interactive)
1100 (setq iswitchb-method iswitchb-default-method)
ccd2f997 1101 (iswitchb))
962a4216 1102
962a4216
RS
1103;;;###autoload
1104(defun iswitchb-buffer-other-window ()
1105 "Switch to another buffer and show it in another window.
1106The buffer name is selected interactively by typing a substring.
6c56c80b 1107For details of keybindings, do `\\[describe-function] iswitchb'."
962a4216
RS
1108 (interactive)
1109 (setq iswitchb-method 'otherwindow)
ccd2f997 1110 (iswitchb))
962a4216 1111
888472e0
RS
1112;;;###autoload
1113(defun iswitchb-display-buffer ()
1114 "Display a buffer in another window but don't select it.
1115The buffer name is selected interactively by typing a substring.
1116For details of keybindings, do `\\[describe-function] iswitchb'."
1117 (interactive)
1118 (setq iswitchb-method 'display)
ccd2f997 1119 (iswitchb))
888472e0 1120
962a4216
RS
1121;;;###autoload
1122(defun iswitchb-buffer-other-frame ()
1123 "Switch to another buffer and show it in another frame.
1124The buffer name is selected interactively by typing a substring.
6c56c80b 1125For details of keybindings, do `\\[describe-function] iswitchb'."
962a4216
RS
1126 (interactive)
1127 (setq iswitchb-method 'otherframe)
962a4216
RS
1128 (iswitchb))
1129
36a3b01c 1130;;; XEmacs hack for showing default buffer
962a4216
RS
1131
1132;; The first time we enter the minibuffer, Emacs puts up the default
ccd2f997 1133;; buffer to switch to, but XEmacs doesn't -- presumably there is a
36a3b01c
RS
1134;; subtle difference in the two versions of post-command-hook. The
1135;; default is shown for both whenever we delete all of our text
1136;; though, indicating its just a problem the first time we enter the
1137;; function. To solve this, we use another entry hook for emacs to
1138;; show the default the first time we enter the minibuffer.
962a4216 1139
6b0cc1b5 1140(defun iswitchb-init-XEmacs-trick ()
6c56c80b
RS
1141 "Display default buffer when first entering minibuffer.
1142This is a hack for XEmacs, and should really be handled by `iswitchb-exhibit'."
962a4216
RS
1143 (if (iswitchb-entryfn-p)
1144 (progn
36a3b01c 1145 (iswitchb-exhibit)
962a4216
RS
1146 (goto-char (point-min)))))
1147
36a3b01c 1148;; add this hook for XEmacs only.
2d839509 1149(if (featurep 'xemacs)
19db4308 1150 (add-hook 'iswitchb-minibuffer-setup-hook
6b0cc1b5 1151 'iswitchb-init-XEmacs-trick))
962a4216 1152
36a3b01c 1153;;; XEmacs / backspace key
ccd2f997 1154;; For some reason, if the backspace key is pressed in XEmacs, the
962a4216 1155;; line gets confused, so I've added a simple key definition to make
19db4308 1156;; backspace act like the normal delete key.
962a4216
RS
1157
1158(defun iswitchb-xemacs-backspacekey ()
1159 "Bind backspace to `backward-delete-char'."
1160 (define-key iswitchb-mode-map '[backspace] 'backward-delete-char)
181688f2 1161 (define-key iswitchb-mode-map '[(meta backspace)] 'backward-kill-word))
962a4216 1162
2d839509 1163(if (featurep 'xemacs)
19db4308 1164 (add-hook 'iswitchb-define-mode-map-hook
962a4216
RS
1165 'iswitchb-xemacs-backspacekey))
1166
962a4216
RS
1167;;; ICOMPLETE TYPE CODE
1168
1169(defun iswitchb-exhibit ()
6c56c80b 1170 "Find matching buffers and display a list in the minibuffer.
962a4216
RS
1171Copied from `icomplete-exhibit' with two changes:
11721. It prints a default buffer name when there is no text yet entered.
11732. It calls my completion routine rather than the standard completion."
962a4216 1174 (if iswitchb-use-mycompletion
600f9d03 1175 (let ((contents (buffer-substring (minibuffer-prompt-end) (point-max)))
962a4216
RS
1176 (buffer-undo-list t))
1177 (save-excursion
1178 (goto-char (point-max))
1179 ; Register the end of input, so we
1180 ; know where the extra stuff
1181 ; (match-status info) begins:
1182 (if (not (boundp 'iswitchb-eoinput))
1183 ;; In case it got wiped out by major mode business:
1184 (make-local-variable 'iswitchb-eoinput))
1185 (setq iswitchb-eoinput (point))
1186 ;; Update the list of matches
1187 (setq iswitchb-text contents)
1188 (iswitchb-set-matches)
1189 (setq iswitchb-rescan t)
1190 (iswitchb-set-common-completion)
1191
1192 ;; Insert the match-status information:
f1180544 1193 (insert (iswitchb-completions
34d16326 1194 contents
34d16326 1195 (not minibuffer-completion-confirm)))))))
26119624 1196
c80d9534
JW
1197(defun iswitchb-output-completion (com)
1198 (if (= (length com) most-len)
1199 ;; Most is one exact match,
1200 ;; note that and leave out
1201 ;; for later indication:
1202 (ignore
1203 (setq most-is-exact t))
1204 (substring com most-len)))
1205
2d839509 1206(defun iswitchb-completions (name require-match)
962a4216
RS
1207 "Return the string that is displayed after the user's text.
1208Modified from `icomplete-completions'."
f1180544 1209
962a4216
RS
1210 (let ((comps iswitchb-matches)
1211 ; "-determined" - only one candidate
1212 (open-bracket-determined (if require-match "(" "["))
1213 (close-bracket-determined (if require-match ")" "]"))
1214 ;"-prospects" - more than one candidate
1215 (open-bracket-prospects "{")
1216 (close-bracket-prospects "}")
181688f2 1217 first)
962a4216
RS
1218
1219 (if (and iswitchb-use-fonts comps)
1220 (progn
1221 (setq first (car comps))
1222 (setq first (format "%s" first))
1223 (put-text-property 0 (length first) 'face
19db4308 1224 (if (= (length comps) 1)
962a4216
RS
1225 'font-lock-comment-face
1226 'font-lock-function-name-face)
19db4308 1227 first)
181688f2 1228 (setq comps (cons first (cdr comps)))))
962a4216
RS
1229
1230 (cond ((null comps) (format " %sNo match%s"
1231 open-bracket-determined
1232 close-bracket-determined))
1233
1234 ((null (cdr comps)) ;one match
1235 (concat (if (and (> (length (car comps))
1236 (length name)))
1237 (concat open-bracket-determined
19db4308 1238 ;; when there is one match, show the
962a4216
RS
1239 ;; matching buffer name in full
1240 (car comps)
1241 close-bracket-determined)
1242 "")
181688f2 1243 (if (not iswitchb-use-fonts) " [Matched]")))
962a4216 1244 (t ;multiple matches
c80d9534
JW
1245 (if (and iswitchb-max-to-show
1246 (> (length comps) iswitchb-max-to-show))
1247 (setq comps
1248 (append
5f5d410a
JW
1249 (let ((res nil)
1250 (comp comps)
1251 (end (/ iswitchb-max-to-show 2)))
1252 (while (>= (setq end (1- end)) 0)
1253 (setq res (cons (car comp) res)
1254 comp (cdr comp)))
1255 (nreverse res))
c80d9534 1256 (list "...")
5f5d410a
JW
1257 (nthcdr (- (length comps)
1258 (/ iswitchb-max-to-show 2)) comps))))
962a4216
RS
1259 (let* (
1260 ;;(most (try-completion name candidates predicate))
1261 (most nil)
1262 (most-len (length most))
1263 most-is-exact
c80d9534
JW
1264 (alternatives (if most
1265 (mapconcat 'iswitchb-output-completion
1266 comps ",")
1267 (mapconcat 'identity comps ","))))
962a4216
RS
1268
1269 (concat
1270
1271 ;; put in common completion item -- what you get by
1272 ;; pressing tab
4e141ed7
SE
1273 (if (and (stringp iswitchb-common-match-string)
1274 (> (length iswitchb-common-match-string) (length name)))
962a4216 1275 (concat open-bracket-determined
19db4308 1276 (substring iswitchb-common-match-string
962a4216 1277 (length name))
181688f2 1278 close-bracket-determined))
962a4216
RS
1279 ;; end of partial matches...
1280
1281 ;; think this bit can be ignored.
1282 (and (> most-len (length name))
1283 (concat open-bracket-determined
1284 (substring most (length name))
1285 close-bracket-determined))
f1180544 1286
962a4216
RS
1287 ;; list all alternatives
1288 open-bracket-prospects
1289 (if most-is-exact
1290 (concat "," alternatives)
1291 alternatives)
181688f2 1292 close-bracket-prospects))))))
962a4216
RS
1293
1294(defun iswitchb-minibuffer-setup ()
6c56c80b
RS
1295 "Set up minibuffer for `iswitchb-buffer'.
1296Copied from `icomplete-minibuffer-setup-hook'."
8ae3ef6e
SM
1297 (when (iswitchb-entryfn-p)
1298 (set (make-local-variable 'iswitchb-use-mycompletion) t)
1299 (add-hook 'pre-command-hook 'iswitchb-pre-command nil t)
1300 (add-hook 'post-command-hook 'iswitchb-post-command nil t)
1301 (run-hooks 'iswitchb-minibuffer-setup-hook)))
962a4216
RS
1302
1303(defun iswitchb-pre-command ()
6c56c80b 1304 "Run before command in `iswitchb-buffer'."
962a4216
RS
1305 (iswitchb-tidy))
1306
962a4216 1307(defun iswitchb-post-command ()
6c56c80b 1308 "Run after command in `iswitchb-buffer'."
181688f2 1309 (iswitchb-exhibit))
962a4216
RS
1310
1311(defun iswitchb-tidy ()
1312 "Remove completions display, if any, prior to new user input.
1313Copied from `icomplete-tidy'."
1314
1315 (if (and (boundp 'iswitchb-eoinput)
1316 iswitchb-eoinput)
f1180544 1317
962a4216
RS
1318 (if (> iswitchb-eoinput (point-max))
1319 ;; Oops, got rug pulled out from under us - reinit:
1320 (setq iswitchb-eoinput (point-max))
1321 (let ((buffer-undo-list buffer-undo-list )) ; prevent entry
1322 (delete-region iswitchb-eoinput (point-max))))
f1180544 1323
962a4216
RS
1324 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
1325 (make-local-variable 'iswitchb-eoinput)
1326 (setq iswitchb-eoinput 1)))
1327
962a4216 1328(defun iswitchb-entryfn-p ()
26119624 1329 "Return non-nil if we are using `iswitchb-buffer'."
c7b89861 1330 (eq iswitchb-minibuf-depth (minibuffer-depth)))
ccd2f997 1331
962a4216 1332(defun iswitchb-summaries-to-end ()
6c56c80b
RS
1333 "Move the summaries to the end of the list.
1334This is an example function which can be hooked on to
1335`iswitchb-make-buflist-hook'. Any buffer matching the regexps
1336`Summary' or `output\*$'are put to the end of the list."
19db4308
DL
1337 (let ((summaries (delq nil
1338 (mapcar
1339 (lambda (x)
1340 (if (string-match "Summary\\|output\\*$" x)
1341 x))
1342 iswitchb-temp-buflist))))
36a3b01c 1343 (iswitchb-to-end summaries)))
962a4216 1344
8097dd15
GM
1345(defun iswitchb-case ()
1346 "Return non-nil iff we should ignore case when matching.
1347See the variable `iswitchb-case' for details."
1348 (if iswitchb-case
2d839509 1349 (if (featurep 'xemacs)
8097dd15
GM
1350 (isearch-no-upper-case-p iswitchb-text)
1351 (isearch-no-upper-case-p iswitchb-text t))))
1352
19db4308 1353;;;###autoload
8ae3ef6e 1354(define-minor-mode iswitchb-mode
19db4308
DL
1355 "Toggle Iswitchb global minor mode.
1356With arg, turn Iswitchb mode on if and only iff ARG is positive.
1357This mode enables switching between buffers using substrings. See
1358`iswitchb' for details."
8ae3ef6e 1359 nil nil iswitchb-global-map :global t :group 'iswitchb
19db4308
DL
1360 (if iswitchb-mode
1361 (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
8ae3ef6e 1362 (remove-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)))
19db4308 1363
962a4216
RS
1364(provide 'iswitchb)
1365
ab5796a9 1366;;; arch-tag: d74198ae-753f-44f2-b34f-0c515398d90a
6c56c80b 1367;;; iswitchb.el ends here