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