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