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