Commit | Line | Data |
---|---|---|
b9a5a6af | 1 | ;;; msb.el --- Customizable buffer-selection with multiple menus. |
b578f267 | 2 | |
aade135d | 3 | ;; Copyright (C) 1993, 94, 95, 97, 98, 99 Free Software Foundation, Inc. |
b578f267 | 4 | |
0eb3b336 | 5 | ;; Author: Lars Lindberg <Lars.G.Lindberg@capgemini.se> |
eed30659 | 6 | ;; Maintainer: FSF |
b9a5a6af | 7 | ;; Created: 8 Oct 1993 |
3cfa0ee9 | 8 | ;; Lindberg's last update version: 3.34 |
0eb3b336 | 9 | ;; Keywords: mouse buffer menu |
b578f267 EN |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
b9a5a6af | 14 | ;; it under the terms of the GNU General Public License as published by |
b578f267 EN |
15 | ;; the Free Software Foundation; either version 2, or (at your option) |
16 | ;; any later version. | |
17 | ||
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
b9a5a6af RS |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
b578f267 | 22 | |
b9a5a6af | 23 | ;; You should have received a copy of the GNU General Public License |
b578f267 EN |
24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
25 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 | ;; Boston, MA 02111-1307, USA. | |
b9a5a6af | 27 | |
b9a5a6af | 28 | ;;; Commentary: |
b578f267 | 29 | |
b9a5a6af RS |
30 | ;; Purpose of this package: |
31 | ;; 1. Offer a function for letting the user choose buffer, | |
32 | ;; not necessarily for switching to it. | |
aade135d DL |
33 | ;; 2. Make a better mouse-buffer-menu. This is done as a global |
34 | ;; minor mode, msb-mode. | |
b9a5a6af RS |
35 | ;; |
36 | ;; Customization: | |
2e6286be RS |
37 | ;; Look at the variable `msb-menu-cond' for deciding what menus you |
38 | ;; want. It's not that hard to customize, despite my not-so-good | |
39 | ;; doc-string. Feel free to send me a better doc-string. | |
b9a5a6af RS |
40 | ;; There are some constants for you to try here: |
41 | ;; msb--few-menus | |
42 | ;; msb--very-many-menus (default) | |
3cfa0ee9 | 43 | ;; |
2e6286be RS |
44 | ;; Look at the variable `msb-item-handling-function' for customization |
45 | ;; of the appearance of every menu item. Try for instance setting | |
46 | ;; it to `msb-alon-item-handler'. | |
0eb3b336 | 47 | ;; |
2e6286be RS |
48 | ;; Look at the variable `msb-item-sort-function' for customization |
49 | ;; of sorting the menus. Set it to t for instance, which means no | |
b9a5a6af RS |
50 | ;; sorting - you will get latest used buffer first. |
51 | ;; | |
2e6286be | 52 | ;; Also check out the variable `msb-display-invisible-buffers-p'. |
b9a5a6af RS |
53 | |
54 | ;; Known bugs: | |
4aa4849b | 55 | ;; - Files-by-directory |
fd46fd17 | 56 | ;; + No possibility to show client/changed buffers separately. |
3cfa0ee9 | 57 | ;; + All file buffers only appear in a file sub-menu, they will |
fd46fd17 RS |
58 | ;; for instance not appear in the Mail sub-menu. |
59 | ||
b9a5a6af | 60 | ;; Future enhancements: |
b9a5a6af | 61 | |
b9a5a6af | 62 | ;;; Thanks goes to |
fd46fd17 RS |
63 | ;; Mark Brader <msb@sq.com> |
64 | ;; Jim Berry <m1jhb00@FRB.GOV> | |
65 | ;; Hans Chalupsky <hans@cs.Buffalo.EDU> | |
66 | ;; Larry Rosenberg <ljr@ictv.com> | |
67 | ;; Will Henney <will@astroscu.unam.mx> | |
68 | ;; Jari Aalto <jaalto@tre.tele.nokia.fi> | |
69 | ;; Michael Kifer <kifer@sbkifer.cs.sunysb.edu> | |
70 | ;; Gael Marziou <gael@gnlab030.grenoble.hp.com> | |
71 | ;; Dave Gillespie <daveg@thymus.synaptics.com> | |
72 | ;; Alon Albert <alon@milcse.rtsg.mot.com> | |
73 | ;; Kevin Broadey, <KevinB@bartley.demon.co.uk> | |
74 | ;; Ake Stenhof <ake@cadpoint.se> | |
75 | ;; Richard Stallman <rms@gnu.ai.mit.edu> | |
76 | ;; Steve Fisk <fisk@medved.bowdoin.edu> | |
b9a5a6af | 77 | |
492bd758 DL |
78 | ;; This version turned into a global minor mode and subsequently |
79 | ;; hacked on by Dave Love. | |
b9a5a6af RS |
80 | ;;; Code: |
81 | ||
492bd758 | 82 | (eval-when-compile (require 'cl)) |
b9a5a6af RS |
83 | |
84 | ;;; | |
2e6286be RS |
85 | ;;; Some example constants to be used for `msb-menu-cond'. See that |
86 | ;;; variable for more information. Please note that if the condition | |
87 | ;;; returns `multi', then the buffer can appear in several menus. | |
b9a5a6af RS |
88 | ;;; |
89 | (defconst msb--few-menus | |
90 | '(((and (boundp 'server-buffer-clients) | |
91 | server-buffer-clients | |
92 | 'multi) | |
93 | 3030 | |
94 | "Clients (%d)") | |
95 | ((and msb-display-invisible-buffers-p | |
96 | (msb-invisible-buffer-p) | |
97 | 'multi) | |
98 | 3090 | |
99 | "Invisible buffers (%d)") | |
100 | ((eq major-mode 'dired-mode) | |
101 | 2010 | |
102 | "Dired (%d)" | |
103 | msb-dired-item-handler | |
104 | msb-sort-by-directory) | |
105 | ((eq major-mode 'Man-mode) | |
106 | 4090 | |
107 | "Manuals (%d)") | |
108 | ((eq major-mode 'w3-mode) | |
109 | 4020 | |
110 | "WWW (%d)") | |
fd46fd17 | 111 | ((or (memq major-mode '(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode)) |
b9a5a6af RS |
112 | (memq major-mode '(mh-letter-mode |
113 | mh-show-mode | |
aade135d | 114 | mh-folder-mode)) |
b9a5a6af RS |
115 | (memq major-mode '(gnus-summary-mode |
116 | news-reply-mode | |
117 | gnus-group-mode | |
118 | gnus-article-mode | |
119 | gnus-kill-file-mode | |
120 | gnus-browse-killed-mode))) | |
121 | 4010 | |
122 | "Mail (%d)") | |
123 | ((not buffer-file-name) | |
124 | 4099 | |
125 | "Buffers (%d)") | |
126 | ('no-multi | |
127 | 1099 | |
128 | "Files (%d)"))) | |
129 | ||
130 | (defconst msb--very-many-menus | |
131 | '(((and (boundp 'server-buffer-clients) | |
132 | server-buffer-clients | |
133 | 'multi) | |
134 | 1010 | |
135 | "Clients (%d)") | |
136 | ((and (boundp 'vc-mode) vc-mode 'multi) | |
137 | 1020 | |
138 | "Version Control (%d)") | |
139 | ((and buffer-file-name | |
140 | (buffer-modified-p) | |
141 | 'multi) | |
142 | 1030 | |
143 | "Changed files (%d)") | |
144 | ((and (get-buffer-process (current-buffer)) | |
145 | 'multi) | |
146 | 1040 | |
147 | "Processes (%d)") | |
148 | ((and msb-display-invisible-buffers-p | |
149 | (msb-invisible-buffer-p) | |
150 | 'multi) | |
151 | 1090 | |
0eb3b336 | 152 | "Invisible buffers (%d)") |
b9a5a6af RS |
153 | ((eq major-mode 'dired-mode) |
154 | 2010 | |
155 | "Dired (%d)" | |
156 | ;; Note this different menu-handler | |
157 | msb-dired-item-handler | |
158 | ;; Also note this item-sorter | |
159 | msb-sort-by-directory) | |
160 | ((eq major-mode 'Man-mode) | |
3cfa0ee9 | 161 | 5030 |
b9a5a6af RS |
162 | "Manuals (%d)") |
163 | ((eq major-mode 'w3-mode) | |
3cfa0ee9 | 164 | 5020 |
b9a5a6af | 165 | "WWW (%d)") |
fd46fd17 | 166 | ((or (memq major-mode '(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode)) |
b9a5a6af RS |
167 | (memq major-mode '(mh-letter-mode |
168 | mh-show-mode | |
aade135d | 169 | mh-folder-mode)) |
b9a5a6af RS |
170 | (memq major-mode '(gnus-summary-mode |
171 | news-reply-mode | |
172 | gnus-group-mode | |
173 | gnus-article-mode | |
174 | gnus-kill-file-mode | |
175 | gnus-browse-killed-mode))) | |
3cfa0ee9 | 176 | 5010 |
b9a5a6af RS |
177 | "Mail (%d)") |
178 | ;; Catchup for all non-file buffers | |
179 | ((and (not buffer-file-name) | |
180 | 'no-multi) | |
3cfa0ee9 | 181 | 5099 |
b9a5a6af RS |
182 | "Other non-file buffers (%d)") |
183 | ((and (string-match "/\\.[^/]*$" buffer-file-name) | |
184 | 'multi) | |
185 | 3090 | |
186 | "Hidden Files (%d)") | |
187 | ((memq major-mode '(c-mode c++-mode)) | |
188 | 3010 | |
189 | "C/C++ Files (%d)") | |
190 | ((eq major-mode 'emacs-lisp-mode) | |
191 | 3020 | |
192 | "Elisp Files (%d)") | |
193 | ((eq major-mode 'latex-mode) | |
194 | 3030 | |
195 | "LaTex Files (%d)") | |
196 | ('no-multi | |
197 | 3099 | |
198 | "Other files (%d)"))) | |
199 | ||
200 | ;; msb--many-menus is obsolete | |
201 | (defvar msb--many-menus msb--very-many-menus) | |
202 | ||
203 | ;;; | |
204 | ;;; Customizable variables | |
205 | ;;; | |
206 | ||
3cfa0ee9 SE |
207 | (defgroup msb nil |
208 | "Customizable buffer-selection with multiple menus." | |
209 | :prefix "msb-" | |
210 | :group 'mouse) | |
211 | ||
aade135d DL |
212 | ;;;###autoload |
213 | (defcustom msb-mode nil | |
214 | "Toggle msb-mode. | |
215 | Setting this variable directly does not take effect; | |
216 | use either \\[customize] or the function `msb-mode'." | |
217 | :set (lambda (symbol value) | |
218 | (msb-mode (or value 0))) | |
219 | :initialize 'custom-initialize-default | |
220 | :version "20.4" | |
221 | :type 'boolean | |
222 | :group 'msb | |
223 | :require 'msb) | |
224 | ||
3cfa0ee9 SE |
225 | (defun msb-custom-set (symbol value) |
226 | "Set the value of custom variables for msb." | |
227 | (set symbol value) | |
eed30659 | 228 | (if (and (featurep 'msb) msb-mode) |
3cfa0ee9 SE |
229 | ;; wait until package has been loaded before bothering to update |
230 | ;; the buffer lists. | |
eed30659 | 231 | (msb-menu-bar-update-buffers t))) |
3cfa0ee9 SE |
232 | |
233 | (defcustom msb-menu-cond msb--very-many-menus | |
234 | "*List of criteria for splitting the mouse buffer menu. | |
235 | The elements in the list should be of this type: | |
236 | (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN). | |
237 | ||
238 | When making the split, the buffers are tested one by one against the | |
aade135d | 239 | CONDITION, just like a Lisp cond: When hitting a true condition, the |
3cfa0ee9 SE |
240 | other criteria are *not* tested and the buffer name will appear in the |
241 | menu with the menu-title corresponding to the true condition. | |
242 | ||
243 | If the condition returns the symbol `multi', then the buffer will be | |
244 | added to this menu *and* tested for other menus too. If it returns | |
245 | `no-multi', then the buffer will only be added if it hasn't been added | |
246 | to any other menu. | |
247 | ||
248 | During this test, the buffer in question is the current buffer, and | |
249 | the test is surrounded by calls to `save-excursion' and | |
250 | `save-match-data'. | |
251 | ||
252 | The categories are sorted by MENU-SORT-KEY. Smaller keys are on top. | |
253 | nil means don't display this menu. | |
254 | ||
255 | MENU-TITLE is really a format. If you add %d in it, the %d is | |
256 | replaced with the number of items in that menu. | |
257 | ||
258 | ITEM-HANDLING-FN, is optional. If it is supplied and is a function, | |
259 | than it is used for displaying the items in that particular buffer | |
260 | menu, otherwise the function pointed out by | |
261 | `msb-item-handling-function' is used. | |
262 | ||
263 | ITEM-SORT-FN, is also optional. | |
264 | If it is not supplied, the function pointed out by | |
265 | `msb-item-sort-function' is used. | |
266 | If it is nil, then no sort takes place and the buffers are presented | |
267 | in least-recently-used order. | |
268 | If it is t, then no sort takes place and the buffers are presented in | |
269 | most-recently-used order. | |
270 | If it is supplied and non-nil and not t than it is used for sorting | |
271 | the items in that particular buffer menu. | |
272 | ||
273 | Note1: There should always be a `catch-all' as last element, in this | |
274 | list. That is an element like (t TITLE ITEM-HANDLING-FUNCTION). | |
275 | Note2: A buffer menu appears only if it has at least one buffer in it. | |
276 | Note3: If you have a CONDITION that can't be evaluated you will get an | |
277 | error every time you do \\[msb]." | |
278 | :type `(choice (const :tag "long" :value ,msb--very-many-menus) | |
279 | (const :tag "short" :value ,msb--few-menus)) | |
280 | :set 'msb-custom-set | |
281 | :group 'msb) | |
282 | ||
283 | (defcustom msb-modes-key 4000 | |
284 | "The sort key for files sorted by mode." | |
285 | :type 'integer | |
286 | :set 'msb-custom-set | |
f9e9ac1d DN |
287 | :group 'msb |
288 | :version "20.3") | |
3cfa0ee9 SE |
289 | |
290 | (defcustom msb-separator-diff 100 | |
b9a5a6af | 291 | "*Non-nil means use separators. |
0eb3b336 | 292 | The separators will appear between all menus that have a sorting key |
3cfa0ee9 SE |
293 | that differs by this value or more." |
294 | :type '(choice integer (const nil)) | |
295 | :set 'msb-custom-set | |
296 | :group 'msb) | |
b9a5a6af RS |
297 | |
298 | (defvar msb-files-by-directory-sort-key 0 | |
0eb3b336 | 299 | "*The sort key for files sorted by directory.") |
b9a5a6af | 300 | |
3cfa0ee9 | 301 | (defcustom msb-max-menu-items 15 |
b9a5a6af | 302 | "*The maximum number of items in a menu. |
0eb3b336 | 303 | If this variable is set to 15 for instance, then the submenu will be |
3cfa0ee9 SE |
304 | split up in minor parts, 15 items each. Nil means no limit." |
305 | :type '(choice integer (const nil)) | |
306 | :set 'msb-custom-set | |
307 | :group 'msb) | |
b9a5a6af | 308 | |
3cfa0ee9 | 309 | (defcustom msb-max-file-menu-items 10 |
b9a5a6af RS |
310 | "*The maximum number of items from different directories. |
311 | ||
2e6286be | 312 | When the menu is of type `file by directory', this is the maximum |
6331da4b | 313 | number of buffers that are clumped together from different |
b9a5a6af RS |
314 | directories. |
315 | ||
4aa4849b RS |
316 | Set this to 1 if you want one menu per directory instead of clumping |
317 | them together. | |
318 | ||
3cfa0ee9 SE |
319 | If the value is not a number, then the value 10 is used." |
320 | :type 'integer | |
321 | :set 'msb-custom-set | |
322 | :group 'msb) | |
b9a5a6af | 323 | |
3cfa0ee9 SE |
324 | (defcustom msb-most-recently-used-sort-key -1010 |
325 | "*Where should the menu with the most recently used buffers be placed?" | |
326 | :type 'integer | |
327 | :set 'msb-custom-set | |
328 | :group 'msb) | |
b9a5a6af | 329 | |
3cfa0ee9 | 330 | (defcustom msb-display-most-recently-used 15 |
b9a5a6af | 331 | "*How many buffers should be in the most-recently-used menu. |
3cfa0ee9 SE |
332 | No buffers at all if less than 1 or nil (or any non-number)." |
333 | :type 'integer | |
334 | :set 'msb-custom-set | |
335 | :group 'msb) | |
336 | ||
337 | (defcustom msb-most-recently-used-title "Most recently used (%d)" | |
338 | "*The title for the most-recently-used menu." | |
339 | :type 'string | |
340 | :set 'msb-custom-set | |
341 | :group 'msb) | |
0eb3b336 | 342 | |
b9a5a6af | 343 | (defvar msb-horizontal-shift-function '(lambda () 0) |
0eb3b336 | 344 | "*Function that specifies how many pixels to shift the top menu leftwards.") |
b9a5a6af | 345 | |
3cfa0ee9 | 346 | (defcustom msb-display-invisible-buffers-p nil |
b9a5a6af RS |
347 | "*Show invisible buffers or not. |
348 | Non-nil means that the buffer menu should include buffers that have | |
3cfa0ee9 SE |
349 | names that starts with a space character." |
350 | :type 'boolean | |
351 | :set 'msb-custom-set | |
352 | :group 'msb) | |
b9a5a6af RS |
353 | |
354 | (defvar msb-item-handling-function 'msb-item-handler | |
355 | "*The appearance of a buffer menu. | |
356 | ||
357 | The default function to call for handling the appearance of a menu | |
2e6286be | 358 | item. It should take to arguments, BUFFER and MAX-BUFFER-NAME-LENGTH, |
b9a5a6af | 359 | where the latter is the max length of all buffer names. |
4aa4849b RS |
360 | |
361 | The function should return the string to use in the menu. | |
362 | ||
0eb3b336 RS |
363 | When the function is called, BUFFER is the current buffer. This |
364 | function is called for items in the variable `msb-menu-cond' that have | |
365 | nil as ITEM-HANDLING-FUNCTION. See `msb-menu-cond' for more | |
b9a5a6af RS |
366 | information.") |
367 | ||
3cfa0ee9 | 368 | (defcustom msb-item-sort-function 'msb-sort-by-name |
b9a5a6af | 369 | "*The order of items in a buffer menu. |
0eb3b336 | 370 | |
b9a5a6af | 371 | The default function to call for handling the order of items in a menu |
0eb3b336 RS |
372 | item. This function is called like a sort function. The items look |
373 | like (ITEM-NAME . BUFFER). | |
374 | ||
b9a5a6af RS |
375 | ITEM-NAME is the name of the item that will appear in the menu. |
376 | BUFFER is the buffer, this is not necessarily the current buffer. | |
377 | ||
3cfa0ee9 SE |
378 | Set this to nil or t if you don't want any sorting (faster)." |
379 | :type '(choice (const msb-sort-by-name) | |
380 | (const :tag "Newest first" t) | |
381 | (const :tag "Oldest first" nil)) | |
382 | :set 'msb-custom-set | |
383 | :group 'msb | |
384 | ) | |
385 | ||
386 | (defcustom msb-files-by-directory nil | |
aade135d DL |
387 | "*Non-nil means that files should be sorted by directory. |
388 | This is instead of the groups in `msb-menu-cond'." | |
3cfa0ee9 SE |
389 | :type 'boolean |
390 | :set 'msb-custom-set | |
391 | :group 'msb) | |
b9a5a6af | 392 | |
3cfa0ee9 SE |
393 | (defcustom msb-after-load-hooks nil |
394 | "Hooks to be run after the msb package has been loaded." | |
395 | :type 'hook | |
396 | :set 'msb-custom-set | |
397 | :group 'msb) | |
b9a5a6af RS |
398 | |
399 | ;;; | |
400 | ;;; Internal variables | |
401 | ;;; | |
402 | ||
403 | ;; The last calculated menu. | |
404 | (defvar msb--last-buffer-menu nil) | |
405 | ||
406 | ;; If this is non-nil, then it is a string that describes the error. | |
407 | (defvar msb--error nil) | |
408 | ||
409 | ;;; | |
4aa4849b | 410 | ;;; Some example function to be used for `msb-item-handling-function'. |
b9a5a6af RS |
411 | ;;; |
412 | (defun msb-item-handler (buffer &optional maxbuf) | |
413 | "Create one string item, concerning BUFFER, for the buffer menu. | |
414 | The item looks like: | |
415 | *% <buffer-name> | |
2e6286be RS |
416 | The `*' appears only if the buffer is marked as modified. |
417 | The `%' appears only if the buffer is read-only. | |
b9a5a6af RS |
418 | Optional second argument MAXBUF is completely ignored." |
419 | (let ((name (buffer-name)) | |
420 | (modified (if (buffer-modified-p) "*" " ")) | |
421 | (read-only (if buffer-read-only "%" " "))) | |
422 | (format "%s%s %s" modified read-only name))) | |
423 | ||
424 | ||
425 | (eval-when-compile (require 'dired)) | |
426 | ||
2e6286be RS |
427 | ;; `dired' can be called with a list of the form (directory file1 file2 ...) |
428 | ;; which causes `dired-directory' to be in the same form. | |
b9a5a6af RS |
429 | (defun msb--dired-directory () |
430 | (cond ((stringp dired-directory) | |
431 | (abbreviate-file-name (expand-file-name dired-directory))) | |
432 | ((consp dired-directory) | |
433 | (abbreviate-file-name (expand-file-name (car dired-directory)))) | |
434 | (t | |
2e6286be | 435 | (error "Unknown type of `dired-directory' in buffer %s" |
b9a5a6af RS |
436 | (buffer-name))))) |
437 | ||
438 | (defun msb-dired-item-handler (buffer &optional maxbuf) | |
439 | "Create one string item, concerning a dired BUFFER, for the buffer menu. | |
440 | The item looks like: | |
441 | *% <buffer-name> | |
2e6286be RS |
442 | The `*' appears only if the buffer is marked as modified. |
443 | The `%' appears only if the buffer is read-only. | |
b9a5a6af RS |
444 | Optional second argument MAXBUF is completely ignored." |
445 | (let ((name (msb--dired-directory)) | |
446 | (modified (if (buffer-modified-p) "*" " ")) | |
447 | (read-only (if buffer-read-only "%" " "))) | |
448 | (format "%s%s %s" modified read-only name))) | |
449 | ||
450 | (defun msb-alon-item-handler (buffer maxbuf) | |
451 | "Create one string item for the buffer menu. | |
452 | The item looks like: | |
453 | <buffer-name> *%# <file-name> | |
2e6286be RS |
454 | The `*' appears only if the buffer is marked as modified. |
455 | The `%' appears only if the buffer is read-only. | |
456 | The `#' appears only version control file (SCCS/RCS)." | |
b9a5a6af RS |
457 | (format (format "%%%ds %%s%%s%%s %%s" maxbuf) |
458 | (buffer-name buffer) | |
459 | (if (buffer-modified-p) "*" " ") | |
460 | (if buffer-read-only "%" " ") | |
461 | (if (and (boundp 'vc-mode) vc-mode) "#" " ") | |
462 | (or buffer-file-name ""))) | |
463 | ||
464 | ;;; | |
4aa4849b | 465 | ;;; Some example function to be used for `msb-item-sort-function'. |
b9a5a6af RS |
466 | ;;; |
467 | (defun msb-sort-by-name (item1 item2) | |
aade135d DL |
468 | "Sort the items ITEM1 and ITEM2 by their `buffer-name'. |
469 | An item looks like (NAME . BUFFER)." | |
b9a5a6af RS |
470 | (string-lessp (buffer-name (cdr item1)) |
471 | (buffer-name (cdr item2)))) | |
472 | ||
473 | ||
474 | (defun msb-sort-by-directory (item1 item2) | |
aade135d | 475 | "Sort the items ITEM1 and ITEM2 by directory name. Made for dired. |
b9a5a6af | 476 | An item look like (NAME . BUFFER)." |
0eb3b336 RS |
477 | (string-lessp (save-excursion (set-buffer (cdr item1)) |
478 | (msb--dired-directory)) | |
479 | (save-excursion (set-buffer (cdr item2)) | |
480 | (msb--dired-directory)))) | |
b9a5a6af RS |
481 | |
482 | ;;; | |
483 | ;;; msb | |
484 | ;;; | |
485 | ;;; This function can be used instead of (mouse-buffer-menu EVENT) | |
486 | ;;; function in "mouse.el". | |
0eb3b336 | 487 | ;;; |
b9a5a6af RS |
488 | (defun msb (event) |
489 | "Pop up several menus of buffers for selection with the mouse. | |
490 | This command switches buffers in the window that you clicked on, and | |
491 | selects that window. | |
492 | ||
2e6286be RS |
493 | See the function `mouse-select-buffer' and the variable |
494 | `msb-menu-cond' for more information about how the menus are split." | |
b9a5a6af | 495 | (interactive "e") |
fd46fd17 | 496 | (let ((old-window (selected-window)) |
b9a5a6af | 497 | (window (posn-window (event-start event)))) |
fd46fd17 RS |
498 | (unless (framep window) (select-window window)) |
499 | (let ((buffer (mouse-select-buffer event))) | |
500 | (if buffer | |
501 | (switch-to-buffer buffer) | |
502 | (select-window old-window)))) | |
b9a5a6af RS |
503 | nil) |
504 | ||
505 | ;;; | |
506 | ;;; Some supportive functions | |
507 | ;;; | |
508 | (defun msb-invisible-buffer-p (&optional buffer) | |
509 | "Return t if optional BUFFER is an \"invisible\" buffer. | |
510 | If the argument is left out or nil, then the current buffer is considered." | |
511 | (and (> (length (buffer-name buffer)) 0) | |
512 | (eq ?\ (aref (buffer-name buffer) 0)))) | |
513 | ||
7612d61a | 514 | (defun msb--strip-dir (dir) |
eed30659 | 515 | "Strip one hierarchy level from the end of DIR." |
862aacbf | 516 | (file-name-directory (directory-file-name dir))) |
b9a5a6af RS |
517 | |
518 | ;; Create an alist with all buffers from LIST that lies under the same | |
0eb3b336 | 519 | ;; directory will be in the same item as the directory string. |
9153492c | 520 | ;; ((PATH1 . (BUFFER-1 BUFFER-2 ...)) (PATH2 . (BUFFER-K BUFFER-K+1...)) ...) |
b9a5a6af RS |
521 | (defun msb--init-file-alist (list) |
522 | (let ((buffer-alist | |
0eb3b336 RS |
523 | ;; Make alist that looks like |
524 | ;; ((PATH-1 BUFFER-1) (PATH-2 BUFFER-2) ...) | |
525 | ;; sorted on PATH-x | |
b9a5a6af | 526 | (sort (mapcan |
3cfa0ee9 SE |
527 | (lambda (buffer) |
528 | (let ((file-name (expand-file-name (buffer-file-name buffer)))) | |
529 | (when file-name | |
530 | (list (cons (msb--strip-dir file-name) buffer))))) | |
b9a5a6af | 531 | list) |
3cfa0ee9 SE |
532 | (lambda (item1 item2) |
533 | (string< (car item1) (car item2)))))) | |
c549c1bf | 534 | ;; Now clump buffers together that have the same path |
b9a5a6af | 535 | ;; Make alist that looks like |
2e6286be | 536 | ;; ((PATH1 . (BUFFER-1 BUFFER-2 ...)) (PATH2 . (BUFFER-K)) ...) |
b9a5a6af | 537 | (let ((path nil) |
0eb3b336 RS |
538 | (buffers nil)) |
539 | (nconc | |
3cfa0ee9 SE |
540 | (mapcan (lambda (item) |
541 | (cond | |
542 | ((and path | |
543 | (string= path (car item))) | |
544 | ;; The same path as earlier: Add to current list of | |
545 | ;; buffers. | |
546 | (push (cdr item) buffers) | |
547 | ;; This item should not be added to list | |
548 | nil) | |
549 | (t | |
550 | ;; New path | |
551 | (let ((result (and path (cons path buffers)))) | |
552 | (setq path (car item)) | |
553 | (setq buffers (list (cdr item))) | |
554 | ;; Add the last result the list. | |
555 | (and result (list result)))))) | |
0eb3b336 RS |
556 | buffer-alist) |
557 | ;; Add the last result to the list | |
b9a5a6af RS |
558 | (list (cons path buffers)))))) |
559 | ||
0eb3b336 | 560 | (defun msb--format-title (top-found-p path number-of-items) |
eed30659 | 561 | "Format a suitable title for the menu item." |
492bd758 DL |
562 | (format (if top-found-p "%s... (%d)" "%s (%d)") |
563 | (abbreviate-file-name path) number-of-items)) | |
0eb3b336 | 564 | |
c549c1bf RS |
565 | ;; Variables for debugging. |
566 | (defvar msb--choose-file-menu-list) | |
567 | (defvar msb--choose-file-menu-arg-list) | |
0eb3b336 | 568 | |
b9a5a6af | 569 | (defun msb--choose-file-menu (list) |
eed30659 | 570 | "Choose file-menu with respect to directory for every buffer in LIST." |
c549c1bf | 571 | (setq msb--choose-file-menu-arg-list list) |
b9a5a6af RS |
572 | (let ((buffer-alist (msb--init-file-alist list)) |
573 | (final-list nil) | |
574 | (max-clumped-together (if (numberp msb-max-file-menu-items) | |
575 | msb-max-file-menu-items | |
576 | 10)) | |
577 | (top-found-p nil) | |
578 | (last-path nil) | |
3cfa0ee9 | 579 | first rest path buffers old-path) |
0eb3b336 RS |
580 | ;; Prepare for looping over all items in buffer-alist |
581 | (setq first (car buffer-alist) | |
582 | rest (cdr buffer-alist) | |
583 | path (car first) | |
584 | buffers (cdr first)) | |
c549c1bf | 585 | (setq msb--choose-file-menu-list (copy-list rest)) |
0eb3b336 RS |
586 | ;; This big loop tries to clump buffers together that have a |
587 | ;; similar name. Remember that buffer-alist is sorted based on the | |
588 | ;; path for the buffers. | |
b9a5a6af RS |
589 | (while rest |
590 | (let ((found-p nil) | |
591 | (tmp-rest rest) | |
0eb3b336 | 592 | result |
b9a5a6af RS |
593 | new-path item) |
594 | (setq item (car tmp-rest)) | |
0eb3b336 RS |
595 | ;; Clump together the "rest"-buffers that have a path that is |
596 | ;; a subpath of the current one. | |
b9a5a6af RS |
597 | (while (and tmp-rest |
598 | (<= (length buffers) max-clumped-together) | |
599 | (>= (length (car item)) (length path)) | |
492bd758 | 600 | (compare-strings path 0 nil (car item) 0 (length path))) |
b9a5a6af | 601 | (setq found-p t) |
0eb3b336 RS |
602 | (setq buffers (append buffers (cdr item))) ;nconc is faster than append |
603 | (setq tmp-rest (cdr tmp-rest) | |
604 | item (car tmp-rest))) | |
b9a5a6af RS |
605 | (cond |
606 | ((> (length buffers) max-clumped-together) | |
0eb3b336 RS |
607 | ;; Oh, we failed. Too many buffers clumped together. |
608 | ;; Just use the original ones for the result. | |
b9a5a6af | 609 | (setq last-path (car first)) |
0eb3b336 RS |
610 | (push (cons (msb--format-title top-found-p |
611 | (car first) | |
612 | (length (cdr first))) | |
613 | (cdr first)) | |
614 | final-list) | |
4aa4849b | 615 | (setq top-found-p nil) |
b9a5a6af | 616 | (setq first (car rest) |
0eb3b336 RS |
617 | rest (cdr rest) |
618 | path (car first) | |
b9a5a6af RS |
619 | buffers (cdr first))) |
620 | (t | |
0eb3b336 RS |
621 | ;; The first pass of clumping together worked out, go ahead |
622 | ;; with this result. | |
b9a5a6af RS |
623 | (when found-p |
624 | (setq top-found-p t) | |
625 | (setq first (cons path buffers) | |
626 | rest tmp-rest)) | |
0eb3b336 RS |
627 | ;; Now see if we can clump more buffers together if we go up |
628 | ;; one step in the file hierarchy. | |
3cfa0ee9 SE |
629 | ;; If path isn't changed by msb--strip-dir, we are looking |
630 | ;; at the machine name component of an ange-ftp filename. | |
631 | (setq old-path path) | |
7612d61a | 632 | (setq path (msb--strip-dir path) |
b9a5a6af | 633 | buffers (cdr first)) |
3cfa0ee9 SE |
634 | (if (equal old-path path) |
635 | (setq last-path path)) | |
b9a5a6af RS |
636 | (when (and last-path |
637 | (or (and (>= (length path) (length last-path)) | |
492bd758 DL |
638 | (compare-strings last-path 0 nil |
639 | path 0 (length last-path))) | |
b9a5a6af | 640 | (and (< (length path) (length last-path)) |
492bd758 DL |
641 | (compare-strings path 0 nil |
642 | last-path 0 (length path))))) | |
0eb3b336 RS |
643 | ;; We have reached the same place in the file hierarchy as |
644 | ;; the last result, so we should quit at this point and | |
645 | ;; take what we have as result. | |
646 | (push (cons (msb--format-title top-found-p | |
647 | (car first) | |
648 | (length (cdr first))) | |
649 | (cdr first)) | |
650 | final-list) | |
4aa4849b | 651 | (setq top-found-p nil) |
b9a5a6af | 652 | (setq first (car rest) |
0eb3b336 RS |
653 | rest (cdr rest) |
654 | path (car first) | |
655 | buffers (cdr first))))))) | |
656 | ;; Now take care of the last item. | |
3cfa0ee9 SE |
657 | (when first |
658 | (push (cons (msb--format-title top-found-p | |
659 | (car first) | |
660 | (length (cdr first))) | |
661 | (cdr first)) | |
662 | final-list)) | |
4aa4849b | 663 | (setq top-found-p nil) |
b9a5a6af RS |
664 | (nreverse final-list))) |
665 | ||
b9a5a6af | 666 | (defun msb--create-function-info (menu-cond-elt) |
eed30659 DL |
667 | "Create a vector from an element MENU-COND-ELT of `msb-menu-cond'. |
668 | This takes the form: | |
669 | \]BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER) | |
670 | See `msb-menu-cond' for a description of its elements." | |
b9a5a6af RS |
671 | (let* ((list-symbol (make-symbol "-msb-buffer-list")) |
672 | (tmp-ih (and (> (length menu-cond-elt) 3) | |
673 | (nth 3 menu-cond-elt))) | |
674 | (item-handler (if (and tmp-ih (fboundp tmp-ih)) | |
675 | tmp-ih | |
676 | msb-item-handling-function)) | |
677 | (tmp-s (if (> (length menu-cond-elt) 4) | |
678 | (nth 4 menu-cond-elt) | |
679 | msb-item-sort-function)) | |
680 | (sorter (if (or (fboundp tmp-s) | |
681 | (null tmp-s) | |
2e6286be | 682 | (eq tmp-s t)) |
b9a5a6af RS |
683 | tmp-s |
684 | msb-item-sort-function))) | |
685 | (when (< (length menu-cond-elt) 3) | |
aade135d | 686 | (error "Wrong format of msb-menu-cond")) |
b9a5a6af RS |
687 | (when (and (> (length menu-cond-elt) 3) |
688 | (not (fboundp tmp-ih))) | |
689 | (signal 'invalid-function (list tmp-ih))) | |
690 | (when (and (> (length menu-cond-elt) 4) | |
691 | tmp-s | |
692 | (not (fboundp tmp-s)) | |
2e6286be | 693 | (not (eq tmp-s t))) |
b9a5a6af | 694 | (signal 'invalid-function (list tmp-s))) |
2e6286be | 695 | (set list-symbol ()) |
b9a5a6af RS |
696 | (vector list-symbol ;BUFFER-LIST-VARIABLE |
697 | (nth 0 menu-cond-elt) ;CONDITION | |
698 | (nth 1 menu-cond-elt) ;SORT-KEY | |
699 | (nth 2 menu-cond-elt) ;MENU-TITLE | |
700 | item-handler ;ITEM-HANDLER | |
701 | sorter) ;SORTER | |
702 | )) | |
703 | ||
704 | ;; This defsubst is only used in `msb--choose-menu' below. It was | |
3cfa0ee9 | 705 | ;; pulled out merely to make the code somewhat clearer. The indentation |
b9a5a6af RS |
706 | ;; level was too big. |
707 | (defsubst msb--collect (function-info-vector) | |
708 | (let ((result nil) | |
709 | (multi-flag nil) | |
710 | function-info-list) | |
711 | (setq function-info-list | |
712 | (loop for fi | |
713 | across function-info-vector | |
714 | if (and (setq result | |
715 | (eval (aref fi 1))) ;Test CONDITION | |
716 | (not (and (eq result 'no-multi) | |
717 | multi-flag)) | |
718 | (progn (when (eq result 'multi) | |
719 | (setq multi-flag t)) | |
4aa4849b | 720 | t)) |
b9a5a6af RS |
721 | collect fi |
722 | until (and result | |
723 | (not (eq result 'multi))))) | |
724 | (when (and (not function-info-list) | |
725 | (not result)) | |
726 | (error "No catch-all in msb-menu-cond!")) | |
727 | function-info-list)) | |
728 | ||
b9a5a6af | 729 | (defun msb--add-to-menu (buffer function-info max-buffer-name-length) |
eed30659 DL |
730 | "Add BUFFER to the menu depicted by FUNCTION-INFO. |
731 | All side-effects. Adds an element of form (BUFFER-TITLE . BUFFER) | |
732 | to the buffer-list variable in function-info." | |
b9a5a6af RS |
733 | (let ((list-symbol (aref function-info 0))) ;BUFFER-LIST-VARIABLE |
734 | ;; Here comes the hairy side-effect! | |
735 | (set list-symbol | |
736 | (cons (cons (funcall (aref function-info 4) ;ITEM-HANDLER | |
737 | buffer | |
738 | max-buffer-name-length) | |
739 | buffer) | |
740 | (eval list-symbol))))) | |
0eb3b336 | 741 | |
b9a5a6af | 742 | (defsubst msb--choose-menu (buffer function-info-vector max-buffer-name-length) |
eed30659 DL |
743 | "Select the appropriate menu for BUFFER." |
744 | ;; This is all side-effects, folks! | |
745 | ;; This should be optimized. | |
b9a5a6af RS |
746 | (unless (and (not msb-display-invisible-buffers-p) |
747 | (msb-invisible-buffer-p buffer)) | |
748 | (condition-case nil | |
749 | (save-excursion | |
750 | (set-buffer buffer) | |
2e6286be | 751 | ;; Menu found. Add to this menu |
3cfa0ee9 SE |
752 | (mapc (lambda (function-info) |
753 | (msb--add-to-menu buffer function-info max-buffer-name-length)) | |
b9a5a6af RS |
754 | (msb--collect function-info-vector))) |
755 | (error (unless msb--error | |
756 | (setq msb--error | |
757 | (format | |
2e6286be | 758 | "In msb-menu-cond, error for buffer `%s'." |
b9a5a6af | 759 | (buffer-name buffer))) |
76e4c0ba | 760 | (error "%s" msb--error)))))) |
b9a5a6af | 761 | |
b9a5a6af | 762 | (defun msb--create-sort-item (function-info) |
eed30659 | 763 | "Return (SORT-KEY TITLE . BUFFER-LIST) or nil if the buffer-list is empty." |
b9a5a6af RS |
764 | (let ((buffer-list (eval (aref function-info 0)))) |
765 | (when buffer-list | |
766 | (let ((sorter (aref function-info 5)) ;SORTER | |
767 | (sort-key (aref function-info 2))) ;MENU-SORT-KEY | |
768 | (when sort-key | |
0eb3b336 | 769 | (cons sort-key |
b9a5a6af RS |
770 | (cons (format (aref function-info 3) ;MENU-TITLE |
771 | (length buffer-list)) | |
772 | (cond | |
773 | ((null sorter) | |
774 | buffer-list) | |
2e6286be | 775 | ((eq sorter t) |
b9a5a6af RS |
776 | (nreverse buffer-list)) |
777 | (t | |
778 | (sort buffer-list sorter)))))))))) | |
779 | ||
3cfa0ee9 | 780 | (defun msb--aggregate-alist (alist same-predicate sort-predicate) |
eed30659 DL |
781 | "Return ALIST as a sorted, aggregated alist. |
782 | ||
783 | In the result all items with the same car element (according to | |
784 | SAME-PREDICATE) are aggregated together. The alist is first sorted by | |
785 | SORT-PREDICATE. | |
786 | ||
787 | Example: | |
788 | (msb--aggregate-alist | |
789 | '((a . a1) (a . a2) (b . b1) (c . c3) (a . a4) (a . a3) (b . b3) (b . b2)) | |
790 | (function string=) | |
791 | (lambda (item1 item2) | |
792 | (string< (symbol-name item1) (symbol-name item2)))) | |
793 | results in | |
794 | ((a a1 a2 a4 a3) (b b1 b3 b2) (c c3))" | |
3cfa0ee9 SE |
795 | (when (not (null alist)) |
796 | (let (result | |
797 | same | |
798 | tmp-old-car | |
799 | tmp-same | |
800 | (first-time-p t) | |
801 | old-car) | |
802 | (nconc | |
803 | (mapcan (lambda (item) | |
804 | (cond | |
805 | (first-time-p | |
806 | (push (cdr item) same) | |
807 | (setq first-time-p nil) | |
808 | (setq old-car (car item)) | |
809 | nil) | |
810 | ((funcall same-predicate (car item) old-car) | |
811 | (push (cdr item) same) | |
812 | nil) | |
813 | (t | |
814 | (setq tmp-same same | |
815 | tmp-old-car old-car) | |
816 | (setq same (list (cdr item)) | |
817 | old-car (car item)) | |
818 | (list (cons tmp-old-car (nreverse tmp-same)))))) | |
819 | (sort alist (lambda (item1 item2) | |
820 | (funcall sort-predicate (car item1) (car item2))))) | |
821 | (list (cons old-car (nreverse same))))))) | |
822 | ||
823 | ||
824 | (defun msb--mode-menu-cond () | |
825 | (let ((key msb-modes-key)) | |
826 | (mapcar (lambda (item) | |
827 | (incf key) | |
828 | (list `( eq major-mode (quote ,(car item))) | |
829 | key | |
830 | (concat (cdr item) " (%d)"))) | |
aade135d | 831 | (sort |
3cfa0ee9 SE |
832 | (let ((mode-list nil)) |
833 | (mapc (lambda (buffer) | |
834 | (save-excursion | |
835 | (set-buffer buffer) | |
836 | (when (and (not (msb-invisible-buffer-p)) | |
837 | (not (assq major-mode mode-list)) | |
838 | (push (cons major-mode mode-name) | |
839 | mode-list))))) | |
840 | (cdr (buffer-list))) | |
841 | mode-list) | |
842 | (lambda (item1 item2) | |
843 | (string< (cdr item1) (cdr item2))))))) | |
844 | ||
b9a5a6af | 845 | (defun msb--most-recently-used-menu (max-buffer-name-length) |
eed30659 DL |
846 | "Return a list for the most recently used buffers. |
847 | It takes the form ((TITLE . BUFFER-LIST)...)." | |
4aa4849b RS |
848 | (when (and (numberp msb-display-most-recently-used) |
849 | (> msb-display-most-recently-used 0)) | |
fd46fd17 RS |
850 | (let* ((buffers (cdr (buffer-list))) |
851 | (most-recently-used | |
b9a5a6af | 852 | (loop with n = 0 |
fd46fd17 | 853 | for buffer in buffers |
b9a5a6af RS |
854 | if (save-excursion |
855 | (set-buffer buffer) | |
856 | (and (not (msb-invisible-buffer-p)) | |
857 | (not (eq major-mode 'dired-mode)))) | |
858 | collect (save-excursion | |
859 | (set-buffer buffer) | |
860 | (cons (funcall msb-item-handling-function | |
861 | buffer | |
862 | max-buffer-name-length) | |
863 | buffer)) | |
864 | and do (incf n) | |
4aa4849b | 865 | until (>= n msb-display-most-recently-used)))) |
b9a5a6af RS |
866 | (cons (if (stringp msb-most-recently-used-title) |
867 | (format msb-most-recently-used-title | |
868 | (length most-recently-used)) | |
869 | (signal 'wrong-type-argument (list msb-most-recently-used-title))) | |
870 | most-recently-used)))) | |
871 | ||
872 | (defun msb--create-buffer-menu-2 () | |
873 | (let ((max-buffer-name-length 0) | |
874 | file-buffers | |
875 | function-info-vector) | |
876 | ;; Calculate the longest buffer name. | |
877 | (mapc | |
3cfa0ee9 SE |
878 | (lambda (buffer) |
879 | (if (or msb-display-invisible-buffers-p | |
880 | (not (msb-invisible-buffer-p))) | |
881 | (setq max-buffer-name-length | |
882 | (max max-buffer-name-length | |
883 | (length (buffer-name buffer)))))) | |
b9a5a6af RS |
884 | (buffer-list)) |
885 | ;; Make a list with elements of type | |
886 | ;; (BUFFER-LIST-VARIABLE | |
887 | ;; CONDITION | |
888 | ;; MENU-SORT-KEY | |
889 | ;; MENU-TITLE | |
890 | ;; ITEM-HANDLER | |
891 | ;; SORTER) | |
892 | ;; Uses "function-global" variables: | |
893 | ;; function-info-vector | |
894 | (setq function-info-vector | |
895 | (apply (function vector) | |
896 | (mapcar (function msb--create-function-info) | |
3cfa0ee9 | 897 | (append msb-menu-cond (msb--mode-menu-cond))))) |
b9a5a6af | 898 | ;; Split the buffer-list into several lists; one list for each |
2e6286be | 899 | ;; criteria. This is the most critical part with respect to time. |
3cfa0ee9 SE |
900 | (mapc (lambda (buffer) |
901 | (cond ((and msb-files-by-directory | |
902 | (buffer-file-name buffer) | |
903 | ;; exclude ange-ftp buffers | |
904 | ;;(not (string-match "\\/[^/:]+:" | |
905 | ;; (buffer-file-name buffer))) | |
906 | ) | |
907 | (push buffer file-buffers)) | |
908 | (t | |
909 | (msb--choose-menu buffer | |
910 | function-info-vector | |
911 | max-buffer-name-length)))) | |
b9a5a6af RS |
912 | (buffer-list)) |
913 | (when file-buffers | |
914 | (setq file-buffers | |
3cfa0ee9 SE |
915 | (mapcar (lambda (buffer-list) |
916 | (cons msb-files-by-directory-sort-key | |
917 | (cons (car buffer-list) | |
918 | (sort | |
919 | (mapcar (function | |
920 | (lambda (buffer) | |
921 | (cons (save-excursion | |
922 | (set-buffer buffer) | |
923 | (funcall msb-item-handling-function | |
924 | buffer | |
925 | max-buffer-name-length)) | |
926 | buffer))) | |
927 | (cdr buffer-list)) | |
928 | (function | |
929 | (lambda (item1 item2) | |
930 | (string< (car item1) (car item2)))))))) | |
b9a5a6af RS |
931 | (msb--choose-file-menu file-buffers)))) |
932 | ;; Now make the menu - a list of (TITLE . BUFFER-LIST) | |
4aa4849b | 933 | (let* (menu |
b9a5a6af RS |
934 | (most-recently-used |
935 | (msb--most-recently-used-menu max-buffer-name-length)) | |
0eb3b336 | 936 | (others (nconc file-buffers |
b9a5a6af | 937 | (loop for elt |
4aa4849b RS |
938 | across function-info-vector |
939 | for value = (msb--create-sort-item elt) | |
940 | if value collect value)))) | |
b9a5a6af RS |
941 | (setq menu |
942 | (mapcar 'cdr ;Remove the SORT-KEY | |
943 | ;; Sort the menus - not the items. | |
944 | (msb--add-separators | |
945 | (sort | |
946 | ;; Get a list of (SORT-KEY TITLE . BUFFER-LIST) | |
947 | ;; Also sorts the items within the menus. | |
948 | (if (cdr most-recently-used) | |
949 | (cons | |
950 | ;; Add most recent used buffers | |
951 | (cons msb-most-recently-used-sort-key | |
952 | most-recently-used) | |
953 | others) | |
954 | others) | |
3cfa0ee9 SE |
955 | (lambda (elt1 elt2) |
956 | (< (car elt1) (car elt2))))))) | |
b9a5a6af RS |
957 | ;; Now make it a keymap menu |
958 | (append | |
959 | '(keymap "Select Buffer") | |
960 | (msb--make-keymap-menu menu) | |
961 | (when msb-separator-diff | |
0eb3b336 RS |
962 | (list (list 'separator "--"))) |
963 | (list (cons 'toggle | |
b9a5a6af RS |
964 | (cons |
965 | (if msb-files-by-directory | |
966 | "*Files by type*" | |
967 | "*Files by directory*") | |
968 | 'msb--toggle-menu-type))))))) | |
969 | ||
970 | (defun msb--create-buffer-menu () | |
971 | (save-match-data | |
972 | (save-excursion | |
973 | (msb--create-buffer-menu-2)))) | |
974 | ||
b9a5a6af | 975 | (defun msb--toggle-menu-type () |
eed30659 | 976 | "Multi purpose function for selecting a buffer with the mouse." |
b9a5a6af RS |
977 | (interactive) |
978 | (setq msb-files-by-directory (not msb-files-by-directory)) | |
c549c1bf RS |
979 | ;; This gets a warning, but it is correct, |
980 | ;; because this file redefines menu-bar-update-buffers. | |
eed30659 | 981 | (msb-menu-bar-update-buffers t)) |
b9a5a6af RS |
982 | |
983 | (defun mouse-select-buffer (event) | |
984 | "Pop up several menus of buffers, for selection with the mouse. | |
985 | Returns the selected buffer or nil if no buffer is selected. | |
986 | ||
4aa4849b | 987 | The way the buffers are split is conveniently handled with the |
2e6286be | 988 | variable `msb-menu-cond'." |
b9a5a6af RS |
989 | ;; Popup the menu and return the selected buffer. |
990 | (when (or msb--error | |
991 | (not msb--last-buffer-menu) | |
992 | (not (fboundp 'frame-or-buffer-changed-p)) | |
993 | (frame-or-buffer-changed-p)) | |
994 | (setq msb--error nil) | |
995 | (setq msb--last-buffer-menu (msb--create-buffer-menu))) | |
4aa4849b RS |
996 | (let ((position event) |
997 | choice) | |
b9a5a6af RS |
998 | (when (and (fboundp 'posn-x-y) |
999 | (fboundp 'posn-window)) | |
1000 | (let ((posX (car (posn-x-y (event-start event)))) | |
1001 | (posY (cdr (posn-x-y (event-start event)))) | |
4aa4849b | 1002 | (posWind (posn-window (event-start event)))) |
b9a5a6af RS |
1003 | ;; adjust position |
1004 | (setq posX (- posX (funcall msb-horizontal-shift-function)) | |
1005 | position (list (list posX posY) posWind)))) | |
1cc9a99e | 1006 | ;; This `sit-for' magically makes the menu stay up if the mouse |
6331da4b | 1007 | ;; button is released within 0.1 second. |
1cc9a99e RS |
1008 | (sit-for 0 100) |
1009 | ;; Popup the menu | |
4aa4849b | 1010 | (setq choice (x-popup-menu position msb--last-buffer-menu)) |
b9a5a6af | 1011 | (cond |
4aa4849b RS |
1012 | ((eq (car choice) 'toggle) |
1013 | ;; Bring up the menu again with type toggled. | |
1014 | (msb--toggle-menu-type) | |
1015 | (mouse-select-buffer event)) | |
1016 | ((and (numberp (car choice)) | |
1017 | (null (cdr choice))) | |
1018 | (let ((msb--last-buffer-menu (nthcdr 3 (assq (car choice) msb--last-buffer-menu)))) | |
b9a5a6af | 1019 | (mouse-select-buffer event))) |
4aa4849b RS |
1020 | ((while (numberp (car choice)) |
1021 | (setq choice (cdr choice)))) | |
1022 | ((and (stringp (car choice)) | |
1023 | (null (cdr choice))) | |
1024 | (car choice)) | |
dc3247b3 RS |
1025 | ((null choice) |
1026 | choice) | |
4aa4849b RS |
1027 | (t |
1028 | (error "Unknown form for buffer: %s" choice))))) | |
3cfa0ee9 | 1029 | |
b9a5a6af RS |
1030 | ;; Add separators |
1031 | (defun msb--add-separators (sorted-list) | |
1032 | (cond | |
1033 | ((or (not msb-separator-diff) | |
1034 | (not (numberp msb-separator-diff))) | |
1035 | sorted-list) | |
1036 | (t | |
1037 | (let ((last-key nil)) | |
1038 | (mapcan | |
3cfa0ee9 SE |
1039 | (lambda (item) |
1040 | (cond | |
1041 | ((and msb-separator-diff | |
aade135d | 1042 | last-key |
3cfa0ee9 SE |
1043 | (> (- (car item) last-key) |
1044 | msb-separator-diff)) | |
1045 | (setq last-key (car item)) | |
1046 | (list (cons last-key 'separator) | |
1047 | item)) | |
1048 | (t | |
1049 | (setq last-key (car item)) | |
1050 | (list item)))) | |
b9a5a6af RS |
1051 | sorted-list))))) |
1052 | ||
4aa4849b RS |
1053 | (defun msb--split-menus-2 (list mcount result) |
1054 | (cond | |
1055 | ((> (length list) msb-max-menu-items) | |
1056 | (let ((count 0) | |
1057 | sub-name | |
1058 | (tmp-list nil)) | |
1059 | (while (< count msb-max-menu-items) | |
1060 | (push (pop list) tmp-list) | |
1061 | (incf count)) | |
1062 | (setq tmp-list (nreverse tmp-list)) | |
1063 | (setq sub-name (concat (car (car tmp-list)) "...")) | |
0eb3b336 RS |
1064 | (push (nconc (list mcount sub-name |
1065 | 'keymap sub-name) | |
4aa4849b RS |
1066 | tmp-list) |
1067 | result)) | |
1068 | (msb--split-menus-2 list (1+ mcount) result)) | |
1069 | ((null result) | |
1070 | list) | |
1071 | (t | |
1072 | (let (sub-name) | |
1073 | (setq sub-name (concat (car (car list)) "...")) | |
0eb3b336 RS |
1074 | (push (nconc (list mcount sub-name |
1075 | 'keymap sub-name) | |
4aa4849b RS |
1076 | list) |
1077 | result)) | |
1078 | (nreverse result)))) | |
4aa4849b | 1079 | |
3cfa0ee9 SE |
1080 | (defun msb--split-menus (list) |
1081 | (if (and (integerp msb-max-menu-items) | |
1082 | (> msb-max-menu-items 0)) | |
1083 | (msb--split-menus-2 list 0 nil) | |
1084 | list)) | |
4aa4849b | 1085 | |
b9a5a6af RS |
1086 | (defun msb--make-keymap-menu (raw-menu) |
1087 | (let ((end (cons '(nil) 'menu-bar-select-buffer)) | |
1088 | (mcount 0)) | |
1089 | (mapcar | |
3cfa0ee9 | 1090 | (lambda (sub-menu) |
aade135d | 1091 | (cond |
3cfa0ee9 SE |
1092 | ((eq 'separator sub-menu) |
1093 | (list 'separator "--")) | |
1094 | (t | |
1095 | (let ((buffers (mapcar (function | |
1096 | (lambda (item) | |
1097 | (let ((string (car item)) | |
1098 | (buffer (cdr item))) | |
1099 | (cons (buffer-name buffer) | |
1100 | (cons string end))))) | |
1101 | (cdr sub-menu)))) | |
1102 | (nconc (list (incf mcount) (car sub-menu) | |
1103 | 'keymap (car sub-menu)) | |
1104 | (msb--split-menus buffers)))))) | |
b9a5a6af RS |
1105 | raw-menu))) |
1106 | ||
eed30659 DL |
1107 | (defun msb-menu-bar-update-buffers (&optional arg) |
1108 | "A re-written version of `menu-bar-update-buffers'." | |
b9a5a6af RS |
1109 | ;; If user discards the Buffers item, play along. |
1110 | (when (and (lookup-key (current-global-map) [menu-bar buffer]) | |
1111 | (or (not (fboundp 'frame-or-buffer-changed-p)) | |
1112 | (frame-or-buffer-changed-p) | |
1113 | arg)) | |
fd46fd17 | 1114 | (let ((frames (frame-list)) |
b9a5a6af | 1115 | buffers-menu frames-menu) |
b9a5a6af RS |
1116 | ;; Make the menu of buffers proper. |
1117 | (setq msb--last-buffer-menu (msb--create-buffer-menu)) | |
1118 | (setq buffers-menu msb--last-buffer-menu) | |
1119 | ;; Make a Frames menu if we have more than one frame. | |
fd46fd17 RS |
1120 | (when (cdr frames) |
1121 | (let* ((frame-length (length frames)) | |
1122 | (f-title (format "Frames (%d)" frame-length))) | |
1123 | ;; List only the N most recently selected frames | |
1124 | (when (and (integerp msb-max-menu-items) | |
1125 | (> msb-max-menu-items 1) | |
1126 | (> frame-length msb-max-menu-items)) | |
1127 | (setcdr (nthcdr msb-max-menu-items frames) nil)) | |
b9a5a6af | 1128 | (setq frames-menu |
fd46fd17 RS |
1129 | (nconc |
1130 | (list 'frame f-title '(nil) 'keymap f-title) | |
1131 | (mapcar | |
3cfa0ee9 SE |
1132 | (lambda (frame) |
1133 | (nconc | |
1134 | (list frame | |
1135 | (cdr (assq 'name | |
1136 | (frame-parameters frame))) | |
1137 | (cons nil nil)) | |
1138 | 'menu-bar-select-frame)) | |
fd46fd17 | 1139 | frames))))) |
b9a5a6af RS |
1140 | (define-key (current-global-map) [menu-bar buffer] |
1141 | (cons "Buffers" | |
1142 | (if (and buffers-menu frames-menu) | |
fd46fd17 RS |
1143 | ;; Combine Frame and Buffers menus with separator between |
1144 | (nconc (list 'keymap "Buffers and Frames" frames-menu | |
0eb3b336 | 1145 | (and msb-separator-diff '(separator "--"))) |
fd46fd17 RS |
1146 | (cddr buffers-menu)) |
1147 | (or buffers-menu 'undefined))))))) | |
b9a5a6af | 1148 | |
aade135d DL |
1149 | ;; Snarf current bindings of `mouse-buffer-menu' (normally |
1150 | ;; C-down-mouse-1). | |
1151 | (defvar msb-mode-map | |
1152 | (let ((map (make-sparse-keymap))) | |
1153 | (mapcar (lambda (key) | |
1154 | (define-key map key #'msb)) | |
1155 | (where-is-internal 'mouse-buffer-menu (make-sparse-keymap))) | |
1156 | map)) | |
1157 | ||
1158 | ;;;###autoload | |
1159 | (defun msb-mode (&optional arg) | |
1160 | "Toggle Msb mode. | |
1161 | With arg, turn Msb mode on if and only if arg is positive. | |
1162 | This mode overrides the binding(s) of `mouse-buffer-menu' to provide a | |
1163 | different buffer menu using the function `msb'." | |
1164 | (interactive "P") | |
1165 | (setq msb-mode (if arg | |
1166 | (> (prefix-numeric-value arg) 0) | |
1167 | (not msb-mode))) | |
1168 | (if msb-mode | |
eed30659 DL |
1169 | (progn |
1170 | (add-hook 'menu-bar-update-hook 'msb-menu-bar-update-buffers) | |
1171 | (remove-hook 'menu-bar-update-hook 'menu-bar-update-buffers)) | |
1172 | (remove-hook 'menu-bar-update-hook 'msb-menu-bar-update-buffers) | |
1173 | (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)) | |
1174 | (run-hooks 'menu-bar-update-hook)) | |
aade135d DL |
1175 | |
1176 | (add-to-list 'minor-mode-map-alist (cons 'msb-mode msb-mode-map)) | |
b9a5a6af RS |
1177 | |
1178 | (provide 'msb) | |
1179 | (eval-after-load 'msb (run-hooks 'msb-after-load-hooks)) | |
be17d374 | 1180 | |
b9a5a6af | 1181 | ;;; msb.el ends here |