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