(internal_equal) <case Lisp_Vectorlike>: Declare size as
[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
c9403808
RS
301(defcustom iswitchb-cannot-complete-hook 'iswitchb-completion-help
302 "*Hook run when `iswitchb-complete' can't complete any more.
303The most useful values are `iswitchb-completion-help', which pops up a
304window with completion alternatives, or `iswitchb-next-match' or
305`iswitchb-prev-match', which cycle the buffer list."
306 :type 'hook
307 :group 'iswitchb)
308
962a4216 309;;; Examples for setting the value of iswitchb-buffer-ignore
6b0cc1b5 310;(defun iswitchb-ignore-c-mode (name)
962a4216
RS
311; "Ignore all c mode buffers -- example function for iswitchb."
312; (save-excursion
313; (set-buffer name)
314; (string-match "^C$" mode-name)))
315
6b0cc1b5 316;(setq iswitchb-buffer-ignore '("^ " iswitchb-ignore-c-mode))
962a4216
RS
317;(setq iswitchb-buffer-ignore '("^ " "\\.c$" "\\.h$"))
318
36a3b01c 319(defcustom iswitchb-default-method 'always-frame
6c56c80b 320 "*How to switch to new buffer when using `iswitchb-buffer'.
962a4216
RS
321Possible values:
322`samewindow' Show new buffer in same window
323`otherwindow' Show new buffer in another window (same frame)
888472e0 324`display' Display buffer in another window without switching to it
962a4216
RS
325`otherframe' Show new buffer in another frame
326`maybe-frame' If a buffer is visible in another frame, prompt to ask if you
327 you want to see the buffer in the same window of the current
328 frame or in the other frame.
c6e5b93f 329`always-frame' If a buffer is visible in another frame, raise that
36a3b01c 330 frame. Otherwise, visit the buffer in the same window."
19db4308 331 :type '(choice (const samewindow)
c6e5b93f
SE
332 (const otherwindow)
333 (const display)
19db4308 334 (const otherframe)
c6e5b93f
SE
335 (const maybe-frame)
336 (const always-frame))
36a3b01c 337 :group 'iswitchb)
962a4216 338
36a3b01c 339(defcustom iswitchb-regexp nil
6c56c80b 340 "*Non-nil means that `iswitchb' will do regexp matching.
6b0cc1b5 341Value can be toggled within `iswitchb' using `iswitchb-toggle-regexp'."
36a3b01c
RS
342 :type 'boolean
343 :group 'iswitchb)
344
36a3b01c 345(defcustom iswitchb-newbuffer t
962a4216 346 "*Non-nil means create new buffer if no buffer matches substring.
36a3b01c
RS
347See also `iswitchb-prompt-newbuffer'."
348 :type 'boolean
349 :group 'iswitchb)
962a4216 350
36a3b01c 351(defcustom iswitchb-prompt-newbuffer t
962a4216 352 "*Non-nil means prompt user to confirm before creating new buffer.
36a3b01c
RS
353See also `iswitchb-newbuffer'."
354 :type 'boolean
355 :group 'iswitchb)
356
36a3b01c 357(defcustom iswitchb-use-fonts t
6b0cc1b5 358 "*Non-nil means use font-lock fonts for showing first match."
36a3b01c
RS
359 :type 'boolean
360 :group 'iswitchb)
962a4216 361
f5bd1691
GM
362(defcustom iswitchb-use-frame-buffer-list nil
363 "*Non-nil means use the currently selected frame's buffer list."
364 :type 'boolean
365 :group 'iswitchb)
366
36a3b01c 367(defcustom iswitchb-make-buflist-hook nil
19db4308 368 "Hook to run when list of matching buffers is created."
36a3b01c
RS
369 :type 'hook
370 :group 'iswitchb)
371
962a4216
RS
372(defvar iswitchb-all-frames 'visible
373 "*Argument to pass to `walk-windows' when finding visible buffers.
374See documentation of `walk-windows' for useful values.")
375
6b0cc1b5 376(defcustom iswitchb-minibuffer-setup-hook nil
19db4308 377 "Iswitchb-specific customization of minibuffer setup.
962a4216 378
6c56c80b 379This hook is run during minibuffer setup iff `iswitchb' will be active.
962a4216 380It is intended for use in customizing iswitchb for interoperation
19db4308
DL
381with other packages."
382;;; For instance:
962a4216 383
19db4308
DL
384;;; \(add-hook 'iswitchb-minibuffer-setup-hook
385;;; \(function
386;;; \(lambda ()
387;;; \(make-local-variable 'resize-minibuffer-window-max-height)
388;;; \(setq resize-minibuffer-window-max-height 3))))
962a4216 389
19db4308
DL
390;;; will constrain rsz-mini to a maximum minibuffer height of 3 lines when
391;;; iswitchb is running. Copied from `icomplete-minibuffer-setup-hook'."
6b0cc1b5
SE
392 :type 'hook
393 :group 'iswitchb)
394
395;; Do we need the variable iswitchb-use-mycompletion?
396
6b0cc1b5
SE
397;;; Internal Variables
398
399(defvar iswitchb-method nil
19db4308 400 "Stores the method for viewing the selected buffer.
6b0cc1b5
SE
401Its value is one of `samewindow', `otherwindow', `display', `otherframe',
402`maybe-frame' or `always-frame'. See `iswitchb-default-method' for
403details of values.")
962a4216
RS
404
405(defvar iswitchb-eoinput 1
406 "Point where minibuffer input ends and completion info begins.
6c56c80b 407Copied from `icomplete-eoinput'.")
962a4216
RS
408(make-variable-buffer-local 'iswitchb-eoinput)
409
962a4216
RS
410(defvar iswitchb-buflist nil
411 "Stores the current list of buffers that will be searched through.
412The list is ordered, so that the most recent buffers come first,
413although by default, the buffers visible in the current frame are put
414at the end of the list. Created by `iswitchb-make-buflist'.")
415
416;; todo -- is this necessary?
417
418(defvar iswitchb-use-mycompletion nil
19db4308 419 "Non-nil means use `iswitchb-buffer' completion feedback.
6c56c80b
RS
420Should only be set to t by iswitchb functions, so that it doesn't
421interfere with other minibuffer usage.")
962a4216 422
19db4308 423(defvar iswitchb-change-word-sub nil
962a4216
RS
424 "Private variable used by `iswitchb-word-matching-substring'.")
425
962a4216
RS
426(defvar iswitchb-common-match-string nil
427 "Stores the string that is common to all matching buffers.")
428
962a4216
RS
429(defvar iswitchb-rescan nil
430 "Non-nil means we need to regenerate the list of matching buffers.")
431
432(defvar iswitchb-text nil
433 "Stores the users string as it is typed in.")
434
435(defvar iswitchb-matches nil
ccd2f997 436 "List of buffers currently matching `iswitchb-text'.")
962a4216 437
19db4308
DL
438(defvar iswitchb-mode-map
439 (let ((map (make-sparse-keymap)))
440 (set-keymap-parent map minibuffer-local-map)
441 (define-key map "?" 'iswitchb-completion-help)
442 (define-key map "\C-s" 'iswitchb-next-match)
443 (define-key map "\C-r" 'iswitchb-prev-match)
444 (define-key map "\t" 'iswitchb-complete)
445 (define-key map "\C-j" 'iswitchb-select-buffer-text)
446 (define-key map "\C-t" 'iswitchb-toggle-regexp)
447 (define-key map "\C-x\C-f" 'iswitchb-find-file)
448 (define-key map "\C-c" 'iswitchb-toggle-case)
449 (define-key map "\C-k" 'iswitchb-kill-buffer)
450 (define-key map "\C-m" 'iswitchb-exit-minibuffer)
451 map)
452 "Minibuffer keymap for `iswitchb-buffer'.")
453
454(defvar iswitchb-global-map
455 (let ((map (make-sparse-keymap)))
456 (substitute-key-definition 'switch-to-buffer ; normally C-x b
457 'iswitchb-buffer map global-map)
458 (substitute-key-definition 'switch-to-buffer-other-window ; C-x 4 b
459 'iswitchb-buffer-other-window map global-map)
460 (substitute-key-definition 'switch-to-buffer-other-frame ; C-x 5 b
461 'iswitchb-buffer-other-frame map global-map)
462 (substitute-key-definition 'display-buffer ; C-x 4 C-o
463 'iswitchb-display-buffer map global-map)
464 map)
465 "Global keymap for `iswtichb-mode'.")
466
467(defvar iswitchb-history nil
6c56c80b 468 "History of buffers selected using `iswitchb-buffer'.")
962a4216 469
19db4308
DL
470(defvar iswitchb-exit nil
471 "Flag to monitor how `iswitchb-buffer' exits.
6c56c80b
RS
472If equal to `takeprompt', we use the prompt as the buffer name to be
473selected.")
962a4216
RS
474
475(defvar iswitchb-buffer-ignore-orig nil
476 "Stores original value of `iswitchb-buffer-ignore'.")
477
6b0cc1b5
SE
478(defvar iswitchb-default nil
479 "Default buffer for iswitchb.")
962a4216 480
02e526ad
SE
481;; The following variables are needed to keep the byte compiler quiet.
482(defvar iswitchb-require-match nil
483 "Non-nil if matching buffer must be selected.")
484
485(defvar iswitchb-temp-buflist nil
486 "Stores a temporary version of the buffer list being created.")
487
488(defvar iswitchb-bufs-in-frame nil
489 "List of the buffers visible in the current frame.")
490
c7b89861
EZ
491(defvar iswitchb-minibuf-depth nil
492 "Value we expect to be returned by `minibuffer-depth' in the minibuffer.")
493
962a4216
RS
494;;; FUNCTIONS
495
19db4308 496;;; ISWITCHB KEYMAP
962a4216 497(defun iswitchb-define-mode-map ()
19db4308
DL
498 "Set up the keymap for `iswitchb-buffer'.
499This is obsolete. Use \\[iswitchb-mode] or customize the
500variable `iswitchb-mode'."
962a4216
RS
501 (interactive)
502 (let (map)
ccd2f997 503 ;; generated every time so that it can inherit new functions.
962a4216
RS
504 ;;(or iswitchb-mode-map
505
506 (setq map (copy-keymap minibuffer-local-map))
507 (define-key map "?" 'iswitchb-completion-help)
508 (define-key map "\C-s" 'iswitchb-next-match)
509 (define-key map "\C-r" 'iswitchb-prev-match)
510 (define-key map "\t" 'iswitchb-complete)
511 (define-key map "\C-j" 'iswitchb-select-buffer-text)
512 (define-key map "\C-t" 'iswitchb-toggle-regexp)
36a3b01c 513 (define-key map "\C-x\C-f" 'iswitchb-find-file)
962a4216
RS
514 ;;(define-key map "\C-a" 'iswitchb-toggle-ignore)
515 (define-key map "\C-c" 'iswitchb-toggle-case)
36a3b01c 516 (define-key map "\C-k" 'iswitchb-kill-buffer)
ccd2f997 517 (define-key map "\C-m" 'iswitchb-exit-minibuffer)
962a4216 518 (setq iswitchb-mode-map map)
181688f2 519 (run-hooks 'iswitchb-define-mode-map-hook)))
f1180544 520
962a4216
RS
521;;; MAIN FUNCTION
522(defun iswitchb ()
523 "Switch to buffer matching a substring.
524As you type in a string, all of the buffers matching the string are
525displayed. When you have found the buffer you want, it can then be
526selected. As you type, most keys have their normal keybindings,
527except for the following:
528\\<iswitchb-mode-map>
529
530RET Select the buffer at the front of the list of matches. If the
6c56c80b 531list is empty, possibly prompt to create new buffer.
962a4216
RS
532
533\\[iswitchb-select-buffer-text] Select the current prompt as the buffer.
534If no buffer is found, prompt for a new one.
535
536\\[iswitchb-next-match] Put the first element at the end of the list.
537\\[iswitchb-prev-match] Put the last element at the start of the list.
19db4308 538\\[iswitchb-complete] Complete a common suffix to the current string that
962a4216
RS
539matches all buffers. If there is only one match, select that buffer.
540If there is no common suffix, show a list of all matching buffers
541in a separate window.
ccd2f997 542\\[iswitchb-toggle-regexp] Toggle regexp searching.
962a4216 543\\[iswitchb-toggle-case] Toggle case-sensitive searching of buffer names.
36a3b01c 544\\[iswitchb-completion-help] Show list of matching buffers in separate window.
19db4308 545\\[iswitchb-find-file] Exit iswitchb and drop into `find-file'.
36a3b01c 546\\[iswitchb-kill-buffer] Kill buffer at head of buffer list."
962a4216
RS
547 ;;\\[iswitchb-toggle-ignore] Toggle ignoring certain buffers (see \
548 ;;`iswitchb-buffer-ignore')
f1180544 549
8ae3ef6e
SM
550 (let* ((prompt "iswitch ")
551 (buf (iswitchb-read-buffer prompt)))
ccd2f997 552
ccd2f997
KH
553 ;;(message "chosen text %s" iswitchb-final-text)
554 ;; Choose the buffer name: either the text typed in, or the head
555 ;; of the list of matches
556
557 (cond ( (eq iswitchb-exit 'findfile)
558 (call-interactively 'find-file))
559
560 (t
561 ;; View the buffer
c6e5b93f 562 ;;(message "go to buf %s" buf)
ccd2f997
KH
563 ;; Check buf is non-nil.
564 (if buf
565 (if (get-buffer buf)
566 ;; buffer exists, so view it and then exit
567 (iswitchb-visit-buffer buf)
568 ;; else buffer doesn't exist
569 (iswitchb-possible-new-buffer buf)))
181688f2 570 ))))
ccd2f997 571
abc8b974 572;;;###autoload
ccd2f997
KH
573(defun iswitchb-read-buffer (prompt &optional default require-match)
574 "Replacement for the built-in `read-buffer'.
19db4308 575Return the name of a buffer selected.
ccd2f997
KH
576PROMPT is the prompt to give to the user. DEFAULT if given is the default
577buffer to be selected, which will go to the front of the list.
578If REQUIRE-MATCH is non-nil, an existing-buffer must be selected."
962a4216
RS
579 (let
580 (
962a4216
RS
581 buf-sel
582 iswitchb-final-text
962a4216 583 (icomplete-mode nil) ;; prevent icomplete starting up
962a4216
RS
584 ;; can only use fonts if they have been bound.
585 (iswitchb-use-fonts (and iswitchb-use-fonts
586 (boundp 'font-lock-comment-face)
ccd2f997
KH
587 (boundp 'font-lock-function-name-face))))
588
962a4216 589 (iswitchb-define-mode-map)
962a4216
RS
590 (setq iswitchb-exit nil)
591 (setq iswitchb-rescan t)
592 (setq iswitchb-text "")
6b0cc1b5
SE
593 (setq iswitchb-default
594 (if (bufferp default)
595 (buffer-name default)
596 default))
597 (iswitchb-make-buflist iswitchb-default)
36a3b01c 598 (iswitchb-set-matches)
19db4308 599 (let
ccd2f997 600 ((minibuffer-local-completion-map iswitchb-mode-map)
c7b89861
EZ
601 ;; Record the minibuffer depth that we expect to find once
602 ;; the minibuffer is set up and iswitchb-entryfn-p is called.
603 (iswitchb-minibuf-depth (1+ (minibuffer-depth)))
181688f2 604 (iswitchb-require-match require-match))
36a3b01c 605 ;; prompt the user for the buffer name
19db4308 606 (setq iswitchb-final-text (completing-read
ccd2f997 607 prompt ;the prompt
660e161f 608 '(("dummy" . 1)) ;table
ccd2f997
KH
609 nil ;predicate
610 nil ;require-match [handled elsewhere]
611 nil ;initial-contents
612 'iswitchb-history)))
8ae3ef6e
SM
613 (if (get-buffer iswitchb-final-text)
614 ;; This happens for example if the buffer was chosen with the mouse.
615 (setq iswitchb-matches (list iswitchb-final-text)))
616
ccd2f997
KH
617 ;; Handling the require-match must be done in a better way.
618 (if (and require-match (not (iswitchb-existing-buffer-p)))
19db4308 619 (error "Must specify valid buffer"))
ccd2f997 620
19db4308 621 (if (or
ccd2f997
KH
622 (eq iswitchb-exit 'takeprompt)
623 (null iswitchb-matches))
624 (setq buf-sel iswitchb-final-text)
625 ;; else take head of list
626 (setq buf-sel (car iswitchb-matches)))
f1180544 627
ccd2f997 628 ;; Or possibly choose the default buffer
19db4308
DL
629 (if (equal iswitchb-final-text "")
630 (setq buf-sel
ccd2f997 631 (car iswitchb-matches)))
36a3b01c 632
ccd2f997 633 buf-sel))
36a3b01c 634
ccd2f997
KH
635(defun iswitchb-existing-buffer-p ()
636 "Return non-nil if there is a matching buffer."
637 (not (null iswitchb-matches)))
962a4216
RS
638
639;;; COMPLETION CODE
640
641(defun iswitchb-set-common-completion ()
6c56c80b
RS
642 "Find common completion of `iswitchb-text' in `iswitchb-matches'.
643The result is stored in `iswitchb-common-match-string'."
962a4216
RS
644
645 (let* (val)
646 (setq iswitchb-common-match-string nil)
647 (if (and iswitchb-matches
6b0cc1b5 648 (not iswitchb-regexp) ;; testing
962a4216
RS
649 (stringp iswitchb-text)
650 (> (length iswitchb-text) 0))
651 (if (setq val (iswitchb-find-common-substring
652 iswitchb-matches iswitchb-text))
653 (setq iswitchb-common-match-string val)))
181688f2 654 val))
962a4216
RS
655
656(defun iswitchb-complete ()
657 "Try and complete the current pattern amongst the buffer names."
658 (interactive)
659 (let (res)
660 (cond ((not iswitchb-matches)
c9403808 661 (run-hooks 'iswitchb-cannot-complete-hook))
f1180544 662
ccd2f997 663 ((= 1 (length iswitchb-matches))
962a4216
RS
664 ;; only one choice, so select it.
665 (exit-minibuffer))
f1180544 666
962a4216
RS
667 (t
668 ;; else there could be some completions
6b0cc1b5 669 (setq res iswitchb-common-match-string)
962a4216 670 (if (and (not (memq res '(t nil)))
36a3b01c 671 (not (equal res iswitchb-text)))
ccd2f997 672 ;; found something to complete, so put it in the minibuffer.
962a4216
RS
673 (progn
674 (setq iswitchb-rescan nil)
53811b42 675 (delete-region (minibuffer-prompt-end) (point))
962a4216
RS
676 (insert res))
677 ;; else nothing to complete
c9403808 678 (run-hooks 'iswitchb-cannot-complete-hook)
181688f2 679 )))))
962a4216
RS
680
681;;; TOGGLE FUNCTIONS
682
683(defun iswitchb-toggle-case ()
19db4308 684 "Toggle the value of variable `iswitchb-case'."
962a4216
RS
685 (interactive)
686 (setq iswitchb-case (not iswitchb-case))
687 ;; ask for list to be regenerated.
181688f2 688 (setq iswitchb-rescan t))
962a4216
RS
689
690(defun iswitchb-toggle-regexp ()
691 "Toggle the value of `iswitchb-regexp'."
692 (interactive)
693 (setq iswitchb-regexp (not iswitchb-regexp))
694 ;; ask for list to be regenerated.
181688f2 695 (setq iswitchb-rescan t))
962a4216
RS
696
697(defun iswitchb-toggle-ignore ()
698 "Toggle ignoring buffers specified with `iswitchb-buffer-ignore'."
699 (interactive)
700 (if iswitchb-buffer-ignore
701 (progn
702 (setq iswitchb-buffer-ignore-orig iswitchb-buffer-ignore)
181688f2 703 (setq iswitchb-buffer-ignore nil))
962a4216 704 ;; else
181688f2 705 (setq iswitchb-buffer-ignore iswitchb-buffer-ignore-orig))
6b0cc1b5 706 (iswitchb-make-buflist iswitchb-default)
962a4216 707 ;; ask for list to be regenerated.
181688f2 708 (setq iswitchb-rescan t))
962a4216 709
ccd2f997
KH
710(defun iswitchb-exit-minibuffer ()
711 "Exit minibuffer, but make sure we have a match if one is needed."
712 (interactive)
713 (if (or (not iswitchb-require-match)
714 (iswitchb-existing-buffer-p))
181688f2 715 (throw 'exit nil)))
962a4216
RS
716
717(defun iswitchb-select-buffer-text ()
6c56c80b
RS
718 "Select the buffer named by the prompt.
719If no buffer exactly matching the prompt exists, maybe create a new one."
962a4216
RS
720 (interactive)
721 (setq iswitchb-exit 'takeprompt)
722 (exit-minibuffer))
723
36a3b01c 724(defun iswitchb-find-file ()
19db4308 725 "Drop into `find-file' from buffer switching."
36a3b01c
RS
726 (interactive)
727 (setq iswitchb-exit 'findfile)
728 (exit-minibuffer))
729
19db4308 730(defun iswitchb-next-match ()
962a4216
RS
731 "Put first element of `iswitchb-matches' at the end of the list."
732 (interactive)
36a3b01c
RS
733 (let ((next (cadr iswitchb-matches)))
734 (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist next))
181688f2 735 (setq iswitchb-rescan t)))
962a4216 736
19db4308 737(defun iswitchb-prev-match ()
962a4216
RS
738 "Put last element of `iswitchb-matches' at the front of the list."
739 (interactive)
36a3b01c
RS
740 (let ((prev (car (last iswitchb-matches))))
741 (setq iswitchb-buflist (iswitchb-chop iswitchb-buflist prev))
181688f2 742 (setq iswitchb-rescan t)))
36a3b01c
RS
743
744(defun iswitchb-chop (list elem)
745 "Remove all elements before ELEM and put them at the end of LIST."
746 (let ((ret nil)
747 (next nil)
748 (sofar nil))
749 (while (not ret)
750 (setq next (car list))
751 (if (equal next elem)
752 (setq ret (append list (nreverse sofar)))
753 ;; else
754 (progn
755 (setq list (cdr list))
756 (setq sofar (cons next sofar)))))
757 ret))
962a4216 758
962a4216
RS
759;;; CREATE LIST OF ALL CURRENT BUFFERS
760
ccd2f997 761(defun iswitchb-make-buflist (default)
6c56c80b 762 "Set `iswitchb-buflist' to the current list of buffers.
36a3b01c 763Currently visible buffers are put at the end of the list.
19db4308 764The hook `iswitchb-make-buflist-hook' is run after the list has been
36a3b01c 765created to allow the user to further modify the order of the buffer names
ccd2f997
KH
766in this list. If DEFAULT is non-nil, and corresponds to an existing buffer,
767it is put to the start of the list."
19db4308 768 (setq iswitchb-buflist
36a3b01c 769 (let* ((iswitchb-current-buffers (iswitchb-get-buffers-in-frames))
ceba0dac
GM
770 (iswitchb-temp-buflist
771 (delq nil
772 (mapcar
773 (lambda (x)
774 (let ((b-name (buffer-name x)))
775 (if (not
776 (or
777 (iswitchb-ignore-buffername-p b-name)
778 (memq b-name iswitchb-current-buffers)))
779 b-name)))
780 (buffer-list (and iswitchb-use-frame-buffer-list
781 (selected-frame)))))))
782 (setq iswitchb-temp-buflist
783 (nconc iswitchb-temp-buflist iswitchb-current-buffers))
962a4216 784 (run-hooks 'iswitchb-make-buflist-hook)
ceba0dac 785 ;; Should this be after the hooks, or should the hooks be the
ccd2f997
KH
786 ;; final thing to be run?
787 (if default
788 (progn
19db4308 789 (setq iswitchb-temp-buflist
02e526ad 790 (delete default iswitchb-temp-buflist))
19db4308 791 (setq iswitchb-temp-buflist
02e526ad
SE
792 (cons default iswitchb-temp-buflist))))
793 iswitchb-temp-buflist)))
962a4216 794
36a3b01c 795(defun iswitchb-to-end (lst)
02e526ad 796 "Move the elements from LST to the end of `iswitchb-temp-buflist'."
19db4308
DL
797 (mapcar
798 (lambda (elem)
02e526ad 799 (setq iswitchb-temp-buflist (delq elem iswitchb-temp-buflist)))
36a3b01c 800 lst)
ceba0dac 801 (setq iswitchb-temp-buflist (nconc iswitchb-temp-buflist lst)))
962a4216 802
962a4216 803(defun iswitchb-get-buffers-in-frames (&optional current)
962a4216 804 "Return the list of buffers that are visible in the current frame.
19db4308 805If optional argument CURRENT is given, restrict searching to the
962a4216
RS
806current frame, rather than all frames, regardless of value of
807`iswitchb-all-frames'."
962a4216 808 (let ((iswitchb-bufs-in-frame nil))
962a4216 809 (walk-windows 'iswitchb-get-bufname nil
19db4308 810 (if current
962a4216
RS
811 nil
812 iswitchb-all-frames))
813 iswitchb-bufs-in-frame))
814
962a4216
RS
815(defun iswitchb-get-bufname (win)
816 "Used by `iswitchb-get-buffers-in-frames' to walk through all windows."
ae5ac7d0
RS
817 (let ((buf (buffer-name (window-buffer win))))
818 (if (not (member buf iswitchb-bufs-in-frame))
819 ;; Only add buf if it is not already in list.
820 ;; This prevents same buf in two different windows being
821 ;; put into the list twice.
822 (setq iswitchb-bufs-in-frame
823 (cons buf iswitchb-bufs-in-frame)))))
962a4216 824
962a4216
RS
825;;; FIND MATCHING BUFFERS
826
827(defun iswitchb-set-matches ()
828 "Set `iswitchb-matches' to the list of buffers matching prompt."
962a4216
RS
829 (if iswitchb-rescan
830 (setq iswitchb-matches
181688f2 831 (let* ((buflist iswitchb-buflist))
36a3b01c 832 (iswitchb-get-matched-buffers iswitchb-text iswitchb-regexp
6b0cc1b5 833 buflist)))))
36a3b01c
RS
834
835(defun iswitchb-get-matched-buffers (regexp
836 &optional string-format buffer-list)
6b0cc1b5
SE
837 "Return buffers matching REGEXP.
838If STRING-FORMAT is nil, consider REGEXP as just a string.
6c56c80b 839BUFFER-LIST can be list of buffers or list of strings."
8097dd15 840 (let* ((case-fold-search (iswitchb-case))
962a4216
RS
841 ;; need reverse since we are building up list backwards
842 (list (reverse buffer-list))
6b0cc1b5 843 (do-string (stringp (car list)))
962a4216 844 name
181688f2 845 ret)
962a4216 846 (mapcar
36a3b01c 847 (lambda (x)
f1180544 848
36a3b01c
RS
849 (if do-string
850 (setq name x) ;We already have the name
851 (setq name (buffer-name x)))
f1180544 852
36a3b01c
RS
853 (cond
854 ((and (or (and string-format (string-match regexp name))
855 (and (null string-format)
856 (string-match (regexp-quote regexp) name)))
f1180544 857
181688f2 858 (not (iswitchb-ignore-buffername-p name)))
36a3b01c
RS
859 (setq ret (cons name ret))
860 )))
962a4216 861 list)
181688f2 862 ret))
962a4216
RS
863
864(defun iswitchb-ignore-buffername-p (bufname)
865 "Return t if the buffer BUFNAME should be ignored."
866 (let ((data (match-data))
867 (re-list iswitchb-buffer-ignore)
868 ignorep
181688f2 869 nextstr)
962a4216
RS
870 (while re-list
871 (setq nextstr (car re-list))
872 (cond
873 ((stringp nextstr)
874 (if (string-match nextstr bufname)
875 (progn
876 (setq ignorep t)
877 (setq re-list nil))))
878 ((fboundp nextstr)
879 (if (funcall nextstr bufname)
880 (progn
881 (setq ignorep t)
181688f2 882 (setq re-list nil)))))
962a4216 883 (setq re-list (cdr re-list)))
25c80f5c 884 (set-match-data data)
962a4216
RS
885
886 ;; return the result
181688f2 887 ignorep))
962a4216 888
962a4216
RS
889(defun iswitchb-word-matching-substring (word)
890 "Return part of WORD before 1st match to `iswitchb-change-word-sub'.
891If `iswitchb-change-word-sub' cannot be found in WORD, return nil."
8097dd15 892 (let ((case-fold-search (iswitchb-case)))
962a4216
RS
893 (let ((m (string-match iswitchb-change-word-sub word)))
894 (if m
895 (substring word m)
896 ;; else no match
897 nil))))
898
962a4216
RS
899(defun iswitchb-find-common-substring (lis subs)
900 "Return common string following SUBS in each element of LIS."
901 (let (res
902 alist
181688f2 903 iswitchb-change-word-sub)
962a4216
RS
904 (setq iswitchb-change-word-sub
905 (if iswitchb-regexp
906 subs
907 (regexp-quote subs)))
908 (setq res (mapcar 'iswitchb-word-matching-substring lis))
ccd2f997 909 (setq res (delq nil res)) ;; remove any nil elements (shouldn't happen)
962a4216
RS
910 (setq alist (mapcar 'iswitchb-makealist res)) ;; could use an OBARRAY
911
912 ;; try-completion returns t if there is an exact match.
8097dd15 913 (let ((completion-ignore-case (iswitchb-case)))
962a4216 914
181688f2 915 (try-completion subs alist))))
962a4216
RS
916
917(defun iswitchb-makealist (res)
918 "Return dotted pair (RES . 1)."
919 (cons res 1))
920
921;; from Wayne Mesard <wmesard@esd.sgi.com>
922(defun iswitchb-rotate-list (lis)
19db4308 923 "Destructively remove the last element from LIS.
962a4216
RS
924Return the modified list with the last element prepended to it."
925 (if (<= (length lis) 1)
926 lis
927 (let ((las lis)
928 (prev lis))
929 (while (consp (cdr las))
930 (setq prev las
931 las (cdr las)))
932 (setcdr prev nil)
181688f2 933 (cons (car las) lis))))
962a4216
RS
934
935(defun iswitchb-completion-help ()
8ae3ef6e 936 "Show possible completions in a *Completions* buffer."
962a4216 937 ;; we could allow this buffer to be used to select match, but I think
36a3b01c 938 ;; choose-completion-string will need redefining, so it just inserts
19db4308 939 ;; choice with out any previous input.
962a4216 940 (interactive)
36a3b01c 941 (setq iswitchb-rescan nil)
8ae3ef6e
SM
942 (let ((buf (current-buffer))
943 (temp-buf "*Completions*")
944 (win))
ccd2f997 945
8ae3ef6e 946 (if (eq last-command this-command)
ccd2f997
KH
947 ;; scroll buffer
948 (progn
949 (set-buffer temp-buf)
950 (setq win (get-buffer-window temp-buf))
951 (if (pos-visible-in-window-p (point-max) win)
952 (set-window-start win (point-min))
953 (scroll-other-window))
181688f2 954 (set-buffer buf))
f1180544 955
ccd2f997 956 (with-output-to-temp-buffer temp-buf
2d839509 957 (if (featurep 'xemacs)
f1180544 958
ccd2f997
KH
959 ;; XEmacs extents are put on by default, doesn't seem to be
960 ;; any way of switching them off.
961 (display-completion-list (if iswitchb-matches
962 iswitchb-matches
963 iswitchb-buflist)
964 :help-string "iswitchb "
19db4308
DL
965 :activate-callback
966 (lambda (x y z)
967 (message "doesn't work yet, sorry!")))
ccd2f997 968 ;; else running Emacs
19db4308
DL
969 (with-current-buffer standard-output
970 (fundamental-mode))
ccd2f997 971 (display-completion-list (if iswitchb-matches
19db4308 972 iswitchb-matches
ccd2f997
KH
973 iswitchb-buflist))
974 )))))
975
36a3b01c
RS
976;;; KILL CURRENT BUFFER
977
978(defun iswitchb-kill-buffer ()
ccd2f997 979 "Kill the buffer at the head of `iswitchb-matches'."
36a3b01c
RS
980 (interactive)
981 (let ( (enable-recursive-minibuffers t)
982 buf)
983
984 (setq buf (car iswitchb-matches))
985 ;; check to see if buf is non-nil.
986 (if buf
987 (progn
988 (kill-buffer buf)
989
990 ;; Check if buffer exists. XEmacs gnuserv.el makes alias
991 ;; for kill-buffer which does not return t if buffer is
992 ;; killed, so we can't rely on kill-buffer return value.
993 (if (get-buffer buf)
994 ;; buffer couldn't be killed.
19db4308 995 (setq iswitchb-rescan t)
36a3b01c
RS
996 ;; else buffer was killed so remove name from list.
997 (setq iswitchb-buflist (delq buf iswitchb-buflist)))))))
998
962a4216
RS
999;;; VISIT CHOSEN BUFFER
1000(defun iswitchb-visit-buffer (buffer)
1001 "Visit buffer named BUFFER according to `iswitchb-method'."
1002 (let* (win newframe)
1003 (cond
1004 ((eq iswitchb-method 'samewindow)
1005 (switch-to-buffer buffer))
1006
1007 ((memq iswitchb-method '(always-frame maybe-frame))
1008 (cond
1009 ((and (setq win (iswitchb-window-buffer-p buffer))
1010 (or (eq iswitchb-method 'always-frame)
1011 (y-or-n-p "Jump to frame? ")))
1012 (setq newframe (window-frame win))
2d839509 1013 (if (fboundp 'select-frame-set-input-focus)
4d8ae757
RS
1014 (select-frame-set-input-focus newframe)
1015 (raise-frame newframe)
1016 (select-frame newframe)
1017 )
1018 (select-window win))
962a4216
RS
1019 (t
1020 ;; No buffer in other frames...
1021 (switch-to-buffer buffer)
1022 )))
1023
962a4216
RS
1024 ((eq iswitchb-method 'otherwindow)
1025 (switch-to-buffer-other-window buffer))
1026
888472e0
RS
1027 ((eq iswitchb-method 'display)
1028 (display-buffer buffer))
1029
962a4216
RS
1030 ((eq iswitchb-method 'otherframe)
1031 (progn
1032 (switch-to-buffer-other-frame buffer)
2d839509 1033 (if (fboundp 'select-frame-set-input-focus)
4d8ae757 1034 (select-frame-set-input-focus (selected-frame)))
181688f2 1035 )))))
962a4216
RS
1036
1037(defun iswitchb-possible-new-buffer (buf)
1038 "Possibly create and visit a new buffer called BUF."
1039
1040 (let ((newbufcreated))
1041 (if (and iswitchb-newbuffer
1042 (or
1043 (not iswitchb-prompt-newbuffer)
f1180544 1044
962a4216
RS
1045 (and iswitchb-prompt-newbuffer
1046 (y-or-n-p
1047 (format
1048 "No buffer matching `%s', create one? "
1049 buf)))))
1050 ;; then create a new buffer
1051 (progn
1052 (setq newbufcreated (get-buffer-create buf))
1053 (if (fboundp 'set-buffer-major-mode)
1054 (set-buffer-major-mode newbufcreated))
1055 (iswitchb-visit-buffer newbufcreated))
1056 ;; else wont create new buffer
181688f2 1057 (message (format "no buffer matching `%s'" buf)))))
962a4216
RS
1058
1059(defun iswitchb-window-buffer-p (buffer)
6c56c80b
RS
1060 "Return window pointer if BUFFER is visible in another frame.
1061If BUFFER is visible in the current frame, return nil."
962a4216 1062 (interactive)
962a4216
RS
1063 (let ((blist (iswitchb-get-buffers-in-frames 'current)))
1064 ;;If the buffer is visible in current frame, return nil
1065 (if (memq buffer blist)
1066 nil
ccd2f997
KH
1067 ;; maybe in other frame or icon
1068 (get-buffer-window buffer 0) ; better than 'visible
962a4216
RS
1069 )))
1070
6c56c80b 1071;;;###autoload
962a4216 1072(defun iswitchb-default-keybindings ()
6c56c80b 1073 "Set up default keybindings for `iswitchb-buffer'.
ee5897a4 1074Call this function to override the normal bindings. This function also
19db4308
DL
1075adds a hook to the minibuffer.
1076
1077Obsolescent. Use `iswitchb-mode'."
962a4216 1078 (interactive)
ee5897a4 1079 (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
322524b2
SE
1080 (global-set-key "\C-xb" 'iswitchb-buffer)
1081 (global-set-key "\C-x4b" 'iswitchb-buffer-other-window)
1082 (global-set-key "\C-x4\C-o" 'iswitchb-display-buffer)
1083 (global-set-key "\C-x5b" 'iswitchb-buffer-other-frame))
962a4216 1084
962a4216
RS
1085;;;###autoload
1086(defun iswitchb-buffer ()
1087 "Switch to another buffer.
1088
1089The buffer name is selected interactively by typing a substring. The
1090buffer is displayed according to `iswitchb-default-method' -- the
1091default is to show it in the same window, unless it is already visible
6c56c80b
RS
1092in another frame.
1093For details of keybindings, do `\\[describe-function] iswitchb'."
962a4216
RS
1094 (interactive)
1095 (setq iswitchb-method iswitchb-default-method)
ccd2f997 1096 (iswitchb))
962a4216 1097
962a4216
RS
1098;;;###autoload
1099(defun iswitchb-buffer-other-window ()
1100 "Switch to another buffer and show it in another window.
1101The buffer name is selected interactively by typing a substring.
6c56c80b 1102For details of keybindings, do `\\[describe-function] iswitchb'."
962a4216
RS
1103 (interactive)
1104 (setq iswitchb-method 'otherwindow)
ccd2f997 1105 (iswitchb))
962a4216 1106
888472e0
RS
1107;;;###autoload
1108(defun iswitchb-display-buffer ()
1109 "Display a buffer in another window but don't select it.
1110The buffer name is selected interactively by typing a substring.
1111For details of keybindings, do `\\[describe-function] iswitchb'."
1112 (interactive)
1113 (setq iswitchb-method 'display)
ccd2f997 1114 (iswitchb))
888472e0 1115
962a4216
RS
1116;;;###autoload
1117(defun iswitchb-buffer-other-frame ()
1118 "Switch to another buffer and show it in another frame.
1119The buffer name is selected interactively by typing a substring.
6c56c80b 1120For details of keybindings, do `\\[describe-function] iswitchb'."
962a4216
RS
1121 (interactive)
1122 (setq iswitchb-method 'otherframe)
962a4216
RS
1123 (iswitchb))
1124
36a3b01c 1125;;; XEmacs hack for showing default buffer
962a4216
RS
1126
1127;; The first time we enter the minibuffer, Emacs puts up the default
ccd2f997 1128;; buffer to switch to, but XEmacs doesn't -- presumably there is a
36a3b01c
RS
1129;; subtle difference in the two versions of post-command-hook. The
1130;; default is shown for both whenever we delete all of our text
1131;; though, indicating its just a problem the first time we enter the
1132;; function. To solve this, we use another entry hook for emacs to
1133;; show the default the first time we enter the minibuffer.
962a4216 1134
6b0cc1b5 1135(defun iswitchb-init-XEmacs-trick ()
6c56c80b
RS
1136 "Display default buffer when first entering minibuffer.
1137This is a hack for XEmacs, and should really be handled by `iswitchb-exhibit'."
962a4216
RS
1138 (if (iswitchb-entryfn-p)
1139 (progn
36a3b01c 1140 (iswitchb-exhibit)
962a4216
RS
1141 (goto-char (point-min)))))
1142
36a3b01c 1143;; add this hook for XEmacs only.
2d839509 1144(if (featurep 'xemacs)
19db4308 1145 (add-hook 'iswitchb-minibuffer-setup-hook
6b0cc1b5 1146 'iswitchb-init-XEmacs-trick))
962a4216 1147
36a3b01c 1148;;; XEmacs / backspace key
ccd2f997 1149;; For some reason, if the backspace key is pressed in XEmacs, the
962a4216 1150;; line gets confused, so I've added a simple key definition to make
19db4308 1151;; backspace act like the normal delete key.
962a4216
RS
1152
1153(defun iswitchb-xemacs-backspacekey ()
1154 "Bind backspace to `backward-delete-char'."
1155 (define-key iswitchb-mode-map '[backspace] 'backward-delete-char)
181688f2 1156 (define-key iswitchb-mode-map '[(meta backspace)] 'backward-kill-word))
962a4216 1157
2d839509 1158(if (featurep 'xemacs)
19db4308 1159 (add-hook 'iswitchb-define-mode-map-hook
962a4216
RS
1160 'iswitchb-xemacs-backspacekey))
1161
962a4216
RS
1162;;; ICOMPLETE TYPE CODE
1163
1164(defun iswitchb-exhibit ()
6c56c80b 1165 "Find matching buffers and display a list in the minibuffer.
962a4216
RS
1166Copied from `icomplete-exhibit' with two changes:
11671. It prints a default buffer name when there is no text yet entered.
11682. It calls my completion routine rather than the standard completion."
962a4216 1169 (if iswitchb-use-mycompletion
600f9d03 1170 (let ((contents (buffer-substring (minibuffer-prompt-end) (point-max)))
962a4216
RS
1171 (buffer-undo-list t))
1172 (save-excursion
1173 (goto-char (point-max))
1174 ; Register the end of input, so we
1175 ; know where the extra stuff
1176 ; (match-status info) begins:
1177 (if (not (boundp 'iswitchb-eoinput))
1178 ;; In case it got wiped out by major mode business:
1179 (make-local-variable 'iswitchb-eoinput))
1180 (setq iswitchb-eoinput (point))
1181 ;; Update the list of matches
1182 (setq iswitchb-text contents)
1183 (iswitchb-set-matches)
1184 (setq iswitchb-rescan t)
1185 (iswitchb-set-common-completion)
1186
1187 ;; Insert the match-status information:
f1180544 1188 (insert (iswitchb-completions
34d16326 1189 contents
34d16326 1190 (not minibuffer-completion-confirm)))))))
26119624 1191
2d839509 1192(defun iswitchb-completions (name require-match)
962a4216
RS
1193 "Return the string that is displayed after the user's text.
1194Modified from `icomplete-completions'."
f1180544 1195
962a4216
RS
1196 (let ((comps iswitchb-matches)
1197 ; "-determined" - only one candidate
1198 (open-bracket-determined (if require-match "(" "["))
1199 (close-bracket-determined (if require-match ")" "]"))
1200 ;"-prospects" - more than one candidate
1201 (open-bracket-prospects "{")
1202 (close-bracket-prospects "}")
181688f2 1203 first)
962a4216
RS
1204
1205 (if (and iswitchb-use-fonts comps)
1206 (progn
1207 (setq first (car comps))
1208 (setq first (format "%s" first))
1209 (put-text-property 0 (length first) 'face
19db4308 1210 (if (= (length comps) 1)
962a4216
RS
1211 'font-lock-comment-face
1212 'font-lock-function-name-face)
19db4308 1213 first)
181688f2 1214 (setq comps (cons first (cdr comps)))))
962a4216
RS
1215
1216 (cond ((null comps) (format " %sNo match%s"
1217 open-bracket-determined
1218 close-bracket-determined))
1219
1220 ((null (cdr comps)) ;one match
1221 (concat (if (and (> (length (car comps))
1222 (length name)))
1223 (concat open-bracket-determined
19db4308 1224 ;; when there is one match, show the
962a4216
RS
1225 ;; matching buffer name in full
1226 (car comps)
1227 close-bracket-determined)
1228 "")
181688f2 1229 (if (not iswitchb-use-fonts) " [Matched]")))
962a4216
RS
1230 (t ;multiple matches
1231 (let* (
1232 ;;(most (try-completion name candidates predicate))
1233 (most nil)
1234 (most-len (length most))
1235 most-is-exact
962a4216
RS
1236 (alternatives
1237 (apply
1238 (function concat)
1239 (cdr (apply
1240 (function nconc)
1241 (mapcar '(lambda (com)
1242 (if (= (length com) most-len)
1243 ;; Most is one exact match,
1244 ;; note that and leave out
1245 ;; for later indication:
1246 (progn
1247 (setq most-is-exact t)
1248 ())
1249 (list ","
1250 (substring com
1251 most-len))))
1252 comps))))))
1253
1254 (concat
1255
1256 ;; put in common completion item -- what you get by
1257 ;; pressing tab
4e141ed7
SE
1258 (if (and (stringp iswitchb-common-match-string)
1259 (> (length iswitchb-common-match-string) (length name)))
962a4216 1260 (concat open-bracket-determined
19db4308 1261 (substring iswitchb-common-match-string
962a4216 1262 (length name))
181688f2 1263 close-bracket-determined))
962a4216
RS
1264 ;; end of partial matches...
1265
1266 ;; think this bit can be ignored.
1267 (and (> most-len (length name))
1268 (concat open-bracket-determined
1269 (substring most (length name))
1270 close-bracket-determined))
f1180544 1271
962a4216
RS
1272 ;; list all alternatives
1273 open-bracket-prospects
1274 (if most-is-exact
1275 (concat "," alternatives)
1276 alternatives)
181688f2 1277 close-bracket-prospects))))))
962a4216
RS
1278
1279(defun iswitchb-minibuffer-setup ()
6c56c80b
RS
1280 "Set up minibuffer for `iswitchb-buffer'.
1281Copied from `icomplete-minibuffer-setup-hook'."
8ae3ef6e
SM
1282 (when (iswitchb-entryfn-p)
1283 (set (make-local-variable 'iswitchb-use-mycompletion) t)
1284 (add-hook 'pre-command-hook 'iswitchb-pre-command nil t)
1285 (add-hook 'post-command-hook 'iswitchb-post-command nil t)
1286 (run-hooks 'iswitchb-minibuffer-setup-hook)))
962a4216
RS
1287
1288(defun iswitchb-pre-command ()
6c56c80b 1289 "Run before command in `iswitchb-buffer'."
962a4216
RS
1290 (iswitchb-tidy))
1291
962a4216 1292(defun iswitchb-post-command ()
6c56c80b 1293 "Run after command in `iswitchb-buffer'."
181688f2 1294 (iswitchb-exhibit))
962a4216
RS
1295
1296(defun iswitchb-tidy ()
1297 "Remove completions display, if any, prior to new user input.
1298Copied from `icomplete-tidy'."
1299
1300 (if (and (boundp 'iswitchb-eoinput)
1301 iswitchb-eoinput)
f1180544 1302
962a4216
RS
1303 (if (> iswitchb-eoinput (point-max))
1304 ;; Oops, got rug pulled out from under us - reinit:
1305 (setq iswitchb-eoinput (point-max))
1306 (let ((buffer-undo-list buffer-undo-list )) ; prevent entry
1307 (delete-region iswitchb-eoinput (point-max))))
f1180544 1308
962a4216
RS
1309 ;; Reestablish the local variable 'cause minibuffer-setup is weird:
1310 (make-local-variable 'iswitchb-eoinput)
1311 (setq iswitchb-eoinput 1)))
1312
962a4216 1313(defun iswitchb-entryfn-p ()
26119624 1314 "Return non-nil if we are using `iswitchb-buffer'."
c7b89861 1315 (eq iswitchb-minibuf-depth (minibuffer-depth)))
ccd2f997 1316
962a4216 1317(defun iswitchb-summaries-to-end ()
6c56c80b
RS
1318 "Move the summaries to the end of the list.
1319This is an example function which can be hooked on to
1320`iswitchb-make-buflist-hook'. Any buffer matching the regexps
1321`Summary' or `output\*$'are put to the end of the list."
19db4308
DL
1322 (let ((summaries (delq nil
1323 (mapcar
1324 (lambda (x)
1325 (if (string-match "Summary\\|output\\*$" x)
1326 x))
1327 iswitchb-temp-buflist))))
36a3b01c 1328 (iswitchb-to-end summaries)))
962a4216 1329
8097dd15
GM
1330(defun iswitchb-case ()
1331 "Return non-nil iff we should ignore case when matching.
1332See the variable `iswitchb-case' for details."
1333 (if iswitchb-case
2d839509 1334 (if (featurep 'xemacs)
8097dd15
GM
1335 (isearch-no-upper-case-p iswitchb-text)
1336 (isearch-no-upper-case-p iswitchb-text t))))
1337
19db4308 1338;;;###autoload
8ae3ef6e 1339(define-minor-mode iswitchb-mode
19db4308
DL
1340 "Toggle Iswitchb global minor mode.
1341With arg, turn Iswitchb mode on if and only iff ARG is positive.
1342This mode enables switching between buffers using substrings. See
1343`iswitchb' for details."
8ae3ef6e 1344 nil nil iswitchb-global-map :global t :group 'iswitchb
19db4308
DL
1345 (if iswitchb-mode
1346 (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)
8ae3ef6e 1347 (remove-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup)))
19db4308 1348
962a4216
RS
1349(provide 'iswitchb)
1350
ab5796a9 1351;;; arch-tag: d74198ae-753f-44f2-b34f-0c515398d90a
6c56c80b 1352;;; iswitchb.el ends here