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