1 ;;; msb.el --- Customizable buffer-selection with multiple menus.
3 ;; Copyright (C) 1993, 1994, 1995, 1997, 1998 Free Software Foundation, Inc.
5 ;; Author: Lars Lindberg <Lars.G.Lindberg@capgemini.se>
7 ;; Lindberg's last update version: 3.34
8 ;; Keywords: mouse buffer menu
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
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)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
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.
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.
29 ;; Purpose of this package:
30 ;; 1. Offer a function for letting the user choose buffer,
31 ;; not necessarily for switching to it.
32 ;; 2. Make a better mouse-buffer-menu.
36 ;; 1. Byte compile msb first. It uses things in the cl package that
37 ;; are slow if not compiled, but blazingly fast when compiled. I
38 ;; have also had one report that said that msb malfunctioned when
41 ;; Note! You now use msb instead of mouse-buffer-menu.
42 ;; 3. Now try the menu bar Buffers menu.
45 ;; Look at the variable `msb-menu-cond' for deciding what menus you
46 ;; want. It's not that hard to customize, despite my not-so-good
47 ;; doc-string. Feel free to send me a better doc-string.
48 ;; There are some constants for you to try here:
50 ;; msb--very-many-menus (default)
52 ;; Look at the variable `msb-item-handling-function' for customization
53 ;; of the appearance of every menu item. Try for instance setting
54 ;; it to `msb-alon-item-handler'.
56 ;; Look at the variable `msb-item-sort-function' for customization
57 ;; of sorting the menus. Set it to t for instance, which means no
58 ;; sorting - you will get latest used buffer first.
60 ;; Also check out the variable `msb-display-invisible-buffers-p'.
63 ;; - Files-by-directory
64 ;; + No possibility to show client/changed buffers separately.
65 ;; + All file buffers only appear in a file sub-menu, they will
66 ;; for instance not appear in the Mail sub-menu.
68 ;; Future enhancements:
71 ;; Mark Brader <msb@sq.com>
72 ;; Jim Berry <m1jhb00@FRB.GOV>
73 ;; Hans Chalupsky <hans@cs.Buffalo.EDU>
74 ;; Larry Rosenberg <ljr@ictv.com>
75 ;; Will Henney <will@astroscu.unam.mx>
76 ;; Jari Aalto <jaalto@tre.tele.nokia.fi>
77 ;; Michael Kifer <kifer@sbkifer.cs.sunysb.edu>
78 ;; Gael Marziou <gael@gnlab030.grenoble.hp.com>
79 ;; Dave Gillespie <daveg@thymus.synaptics.com>
80 ;; Alon Albert <alon@milcse.rtsg.mot.com>
81 ;; Kevin Broadey, <KevinB@bartley.demon.co.uk>
82 ;; Ake Stenhof <ake@cadpoint.se>
83 ;; Richard Stallman <rms@gnu.ai.mit.edu>
84 ;; Steve Fisk <fisk@medved.bowdoin.edu>
91 ;;; Some example constants to be used for `msb-menu-cond'. See that
92 ;;; variable for more information. Please note that if the condition
93 ;;; returns `multi', then the buffer can appear in several menus.
95 (defconst msb--few-menus
96 '(((and (boundp 'server-buffer-clients
)
101 ((and msb-display-invisible-buffers-p
102 (msb-invisible-buffer-p)
105 "Invisible buffers (%d)")
106 ((eq major-mode
'dired-mode
)
109 msb-dired-item-handler
110 msb-sort-by-directory
)
111 ((eq major-mode
'Man-mode
)
114 ((eq major-mode
'w3-mode
)
117 ((or (memq major-mode
'(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode
))
118 (memq major-mode
'(mh-letter-mode
121 (memq major-mode
'(gnus-summary-mode
126 gnus-browse-killed-mode
)))
129 ((not buffer-file-name
)
136 (defconst msb--very-many-menus
137 '(((and (boundp 'server-buffer-clients
)
138 server-buffer-clients
142 ((and (boundp 'vc-mode
) vc-mode
'multi
)
144 "Version Control (%d)")
145 ((and buffer-file-name
149 "Changed files (%d)")
150 ((and (get-buffer-process (current-buffer))
154 ((and msb-display-invisible-buffers-p
155 (msb-invisible-buffer-p)
158 "Invisible buffers (%d)")
159 ((eq major-mode
'dired-mode
)
162 ;; Note this different menu-handler
163 msb-dired-item-handler
164 ;; Also note this item-sorter
165 msb-sort-by-directory
)
166 ((eq major-mode
'Man-mode
)
169 ((eq major-mode
'w3-mode
)
172 ((or (memq major-mode
'(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode
))
173 (memq major-mode
'(mh-letter-mode
176 (memq major-mode
'(gnus-summary-mode
181 gnus-browse-killed-mode
)))
184 ;; Catchup for all non-file buffers
185 ((and (not buffer-file-name
)
188 "Other non-file buffers (%d)")
189 ((and (string-match "/\\.[^/]*$" buffer-file-name
)
193 ((memq major-mode
'(c-mode c
++-mode
))
196 ((eq major-mode
'emacs-lisp-mode
)
199 ((eq major-mode
'latex-mode
)
204 "Other files (%d)")))
206 ;; msb--many-menus is obsolete
207 (defvar msb--many-menus msb--very-many-menus
)
210 ;;; Customizable variables
214 "Customizable buffer-selection with multiple menus."
218 (defun msb-custom-set (symbol value
)
219 "Set the value of custom variables for msb."
222 ;; wait until package has been loaded before bothering to update
224 (menu-bar-update-buffers t
))
227 (defcustom msb-menu-cond msb--very-many-menus
228 "*List of criteria for splitting the mouse buffer menu.
229 The elements in the list should be of this type:
230 (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN).
232 When making the split, the buffers are tested one by one against the
233 CONDITION, just like a lisp cond: When hitting a true condition, the
234 other criteria are *not* tested and the buffer name will appear in the
235 menu with the menu-title corresponding to the true condition.
237 If the condition returns the symbol `multi', then the buffer will be
238 added to this menu *and* tested for other menus too. If it returns
239 `no-multi', then the buffer will only be added if it hasn't been added
242 During this test, the buffer in question is the current buffer, and
243 the test is surrounded by calls to `save-excursion' and
246 The categories are sorted by MENU-SORT-KEY. Smaller keys are on top.
247 nil means don't display this menu.
249 MENU-TITLE is really a format. If you add %d in it, the %d is
250 replaced with the number of items in that menu.
252 ITEM-HANDLING-FN, is optional. If it is supplied and is a function,
253 than it is used for displaying the items in that particular buffer
254 menu, otherwise the function pointed out by
255 `msb-item-handling-function' is used.
257 ITEM-SORT-FN, is also optional.
258 If it is not supplied, the function pointed out by
259 `msb-item-sort-function' is used.
260 If it is nil, then no sort takes place and the buffers are presented
261 in least-recently-used order.
262 If it is t, then no sort takes place and the buffers are presented in
263 most-recently-used order.
264 If it is supplied and non-nil and not t than it is used for sorting
265 the items in that particular buffer menu.
267 Note1: There should always be a `catch-all' as last element, in this
268 list. That is an element like (t TITLE ITEM-HANDLING-FUNCTION).
269 Note2: A buffer menu appears only if it has at least one buffer in it.
270 Note3: If you have a CONDITION that can't be evaluated you will get an
271 error every time you do \\[msb]."
272 :type
`(choice (const :tag
"long" :value
,msb--very-many-menus
)
273 (const :tag
"short" :value
,msb--few-menus
))
277 (defcustom msb-modes-key
4000
278 "The sort key for files sorted by mode."
283 (defcustom msb-separator-diff
100
284 "*Non-nil means use separators.
285 The separators will appear between all menus that have a sorting key
286 that differs by this value or more."
287 :type
'(choice integer
(const nil
))
291 (defvar msb-files-by-directory-sort-key
0
292 "*The sort key for files sorted by directory.")
294 (defcustom msb-max-menu-items
15
295 "*The maximum number of items in a menu.
296 If this variable is set to 15 for instance, then the submenu will be
297 split up in minor parts, 15 items each. Nil means no limit."
298 :type
'(choice integer
(const nil
))
302 (defcustom msb-max-file-menu-items
10
303 "*The maximum number of items from different directories.
305 When the menu is of type `file by directory', this is the maximum
306 number of buffers that are clumped together from different
309 Set this to 1 if you want one menu per directory instead of clumping
312 If the value is not a number, then the value 10 is used."
317 (defcustom msb-most-recently-used-sort-key -
1010
318 "*Where should the menu with the most recently used buffers be placed?"
323 (defcustom msb-display-most-recently-used
15
324 "*How many buffers should be in the most-recently-used menu.
325 No buffers at all if less than 1 or nil (or any non-number)."
330 (defcustom msb-most-recently-used-title
"Most recently used (%d)"
331 "*The title for the most-recently-used menu."
336 (defvar msb-horizontal-shift-function
'(lambda () 0)
337 "*Function that specifies how many pixels to shift the top menu leftwards.")
339 (defcustom msb-display-invisible-buffers-p nil
340 "*Show invisible buffers or not.
341 Non-nil means that the buffer menu should include buffers that have
342 names that starts with a space character."
347 (defvar msb-item-handling-function
'msb-item-handler
348 "*The appearance of a buffer menu.
350 The default function to call for handling the appearance of a menu
351 item. It should take to arguments, BUFFER and MAX-BUFFER-NAME-LENGTH,
352 where the latter is the max length of all buffer names.
354 The function should return the string to use in the menu.
356 When the function is called, BUFFER is the current buffer. This
357 function is called for items in the variable `msb-menu-cond' that have
358 nil as ITEM-HANDLING-FUNCTION. See `msb-menu-cond' for more
361 (defcustom msb-item-sort-function
'msb-sort-by-name
362 "*The order of items in a buffer menu.
364 The default function to call for handling the order of items in a menu
365 item. This function is called like a sort function. The items look
366 like (ITEM-NAME . BUFFER).
368 ITEM-NAME is the name of the item that will appear in the menu.
369 BUFFER is the buffer, this is not necessarily the current buffer.
371 Set this to nil or t if you don't want any sorting (faster)."
372 :type
'(choice (const msb-sort-by-name
)
373 (const :tag
"Newest first" t
)
374 (const :tag
"Oldest first" nil
))
379 (defcustom msb-files-by-directory nil
380 "*Non-nil means that files should be sorted by directory instead of
381 the groups in msb-menu-cond."
386 (defcustom msb-after-load-hooks nil
387 "Hooks to be run after the msb package has been loaded."
393 ;;; Internal variables
396 ;; Home directory for the current user
397 (defconst msb--home-dir
399 (substitute-in-file-name "$HOME")
400 ;; If $HOME isn't defined, use nil
403 ;; The last calculated menu.
404 (defvar msb--last-buffer-menu nil
)
406 ;; If this is non-nil, then it is a string that describes the error.
407 (defvar msb--error nil
)
410 ;;; Some example function to be used for `msb-item-handling-function'.
412 (defun msb-item-handler (buffer &optional maxbuf
)
413 "Create one string item, concerning BUFFER, for the buffer menu.
416 The `*' appears only if the buffer is marked as modified.
417 The `%' appears only if the buffer is read-only.
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
)))
425 (eval-when-compile (require 'dired
))
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.
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
))))
435 (error "Unknown type of `dired-directory' in buffer %s"
438 (defun msb-dired-item-handler (buffer &optional maxbuf
)
439 "Create one string item, concerning a dired BUFFER, for the buffer menu.
442 The `*' appears only if the buffer is marked as modified.
443 The `%' appears only if the buffer is read-only.
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
)))
450 (defun msb-alon-item-handler (buffer maxbuf
)
451 "Create one string item for the buffer menu.
453 <buffer-name> *%# <file-name>
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)."
457 (format (format "%%%ds %%s%%s%%s %%s" maxbuf
)
459 (if (buffer-modified-p) "*" " ")
460 (if buffer-read-only
"%" " ")
461 (if (and (boundp 'vc-mode
) vc-mode
) "#" " ")
462 (or buffer-file-name
"")))
465 ;;; Some example function to be used for `msb-item-sort-function'.
467 (defun msb-sort-by-name (item1 item2
)
468 "Sorts the items depending on their buffer-name
469 An item look like (NAME . BUFFER)."
470 (string-lessp (buffer-name (cdr item1
))
471 (buffer-name (cdr item2
))))
474 (defun msb-sort-by-directory (item1 item2
)
475 "Sorts the items depending on their directory. Made for dired.
476 An item look like (NAME . BUFFER)."
477 (string-lessp (save-excursion (set-buffer (cdr item1
))
478 (msb--dired-directory))
479 (save-excursion (set-buffer (cdr item2
))
480 (msb--dired-directory))))
485 ;;; This function can be used instead of (mouse-buffer-menu EVENT)
486 ;;; function in "mouse.el".
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
493 See the function `mouse-select-buffer' and the variable
494 `msb-menu-cond' for more information about how the menus are split."
496 (let ((old-window (selected-window))
497 (window (posn-window (event-start event
))))
498 (unless (framep window
) (select-window window
))
499 (let ((buffer (mouse-select-buffer event
)))
501 (switch-to-buffer buffer
)
502 (select-window old-window
))))
506 ;;; Some supportive functions
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))))
514 ;; Strip one hierarchy level from the end of DIR.
515 (defun msb--strip-dir (dir)
516 (file-name-directory (directory-file-name dir
)))
518 ;; Create an alist with all buffers from LIST that lies under the same
519 ;; directory will be in the same item as the directory string.
520 ;; ((PATH1 . (BUFFER-1 BUFFER-2 ...)) (PATH2 . (BUFFER-K BUFFER-K+1...)) ...)
521 (defun msb--init-file-alist (list)
523 ;; Make alist that looks like
524 ;; ((PATH-1 BUFFER-1) (PATH-2 BUFFER-2) ...)
528 (let ((file-name (expand-file-name (buffer-file-name buffer
))))
530 (list (cons (msb--strip-dir file-name
) buffer
)))))
532 (lambda (item1 item2
)
533 (string< (car item1
) (car item2
))))))
534 ;; Now clump buffers together that have the same path
535 ;; Make alist that looks like
536 ;; ((PATH1 . (BUFFER-1 BUFFER-2 ...)) (PATH2 . (BUFFER-K)) ...)
540 (mapcan (lambda (item)
543 (string= path
(car item
)))
544 ;; The same path as earlier: Add to current list of
546 (push (cdr item
) buffers
)
547 ;; This item should not be added to list
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
))))))
557 ;; Add the last result to the list
558 (list (cons path buffers
))))))
560 ;; Format a suitable title for the menu item.
561 (defun msb--format-title (top-found-p path number-of-items
)
562 (let ((new-path path
))
563 (when (and msb--home-dir
564 (string-match (concat "^" msb--home-dir
) path
))
565 (setq new-path
(concat "~"
566 (substring path
(match-end 0)))))
567 (format (if top-found-p
"%s... (%d)" "%s (%d)")
568 new-path number-of-items
)))
570 ;; Variables for debugging.
571 (defvar msb--choose-file-menu-list
)
572 (defvar msb--choose-file-menu-arg-list
)
574 ;; Choose file-menu with respect to directory for every buffer in LIST.
575 (defun msb--choose-file-menu (list)
576 (setq msb--choose-file-menu-arg-list list
)
577 (let ((buffer-alist (msb--init-file-alist list
))
579 (max-clumped-together (if (numberp msb-max-file-menu-items
)
580 msb-max-file-menu-items
584 first rest path buffers old-path
)
585 ;; Prepare for looping over all items in buffer-alist
586 (setq first
(car buffer-alist
)
587 rest
(cdr buffer-alist
)
590 (setq msb--choose-file-menu-list
(copy-list rest
))
591 ;; This big loop tries to clump buffers together that have a
592 ;; similar name. Remember that buffer-alist is sorted based on the
593 ;; path for the buffers.
599 (setq item
(car tmp-rest
))
600 ;; Clump together the "rest"-buffers that have a path that is
601 ;; a subpath of the current one.
603 (<= (length buffers
) max-clumped-together
)
604 (>= (length (car item
)) (length path
))
605 (string= path
(substring (car item
) 0 (length path
))))
607 (setq buffers
(append buffers
(cdr item
))) ;nconc is faster than append
608 (setq tmp-rest
(cdr tmp-rest
)
609 item
(car tmp-rest
)))
611 ((> (length buffers
) max-clumped-together
)
612 ;; Oh, we failed. Too many buffers clumped together.
613 ;; Just use the original ones for the result.
614 (setq last-path
(car first
))
615 (push (cons (msb--format-title top-found-p
617 (length (cdr first
)))
620 (setq top-found-p nil
)
621 (setq first
(car rest
)
624 buffers
(cdr first
)))
626 ;; The first pass of clumping together worked out, go ahead
630 (setq first
(cons path buffers
)
632 ;; Now see if we can clump more buffers together if we go up
633 ;; one step in the file hierarchy.
634 ;; If path isn't changed by msb--strip-dir, we are looking
635 ;; at the machine name component of an ange-ftp filename.
637 (setq path
(msb--strip-dir path
)
639 (if (equal old-path path
)
640 (setq last-path path
))
642 (or (and (>= (length path
) (length last-path
))
644 (substring path
0 (length last-path
))))
645 (and (< (length path
) (length last-path
))
647 (substring last-path
0 (length path
))))))
648 ;; We have reached the same place in the file hierarchy as
649 ;; the last result, so we should quit at this point and
650 ;; take what we have as result.
651 (push (cons (msb--format-title top-found-p
653 (length (cdr first
)))
656 (setq top-found-p nil
)
657 (setq first
(car rest
)
660 buffers
(cdr first
)))))))
661 ;; Now take care of the last item.
663 (push (cons (msb--format-title top-found-p
665 (length (cdr first
)))
668 (setq top-found-p nil
)
669 (nreverse final-list
)))
671 ;; Create a vector as:
672 ;; [BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER)
673 ;; from an element in `msb-menu-cond'. See that variable for a
674 ;; description of its elements.
675 (defun msb--create-function-info (menu-cond-elt)
676 (let* ((list-symbol (make-symbol "-msb-buffer-list"))
677 (tmp-ih (and (> (length menu-cond-elt
) 3)
678 (nth 3 menu-cond-elt
)))
679 (item-handler (if (and tmp-ih
(fboundp tmp-ih
))
681 msb-item-handling-function
))
682 (tmp-s (if (> (length menu-cond-elt
) 4)
683 (nth 4 menu-cond-elt
)
684 msb-item-sort-function
))
685 (sorter (if (or (fboundp tmp-s
)
689 msb-item-sort-function
)))
690 (when (< (length menu-cond-elt
) 3)
691 (error "Wrong format of msb-menu-cond."))
692 (when (and (> (length menu-cond-elt
) 3)
693 (not (fboundp tmp-ih
)))
694 (signal 'invalid-function
(list tmp-ih
)))
695 (when (and (> (length menu-cond-elt
) 4)
697 (not (fboundp tmp-s
))
699 (signal 'invalid-function
(list tmp-s
)))
701 (vector list-symbol
;BUFFER-LIST-VARIABLE
702 (nth 0 menu-cond-elt
) ;CONDITION
703 (nth 1 menu-cond-elt
) ;SORT-KEY
704 (nth 2 menu-cond-elt
) ;MENU-TITLE
705 item-handler
;ITEM-HANDLER
709 ;; This defsubst is only used in `msb--choose-menu' below. It was
710 ;; pulled out merely to make the code somewhat clearer. The indentation
711 ;; level was too big.
712 (defsubst msb--collect
(function-info-vector)
716 (setq function-info-list
718 across function-info-vector
720 (eval (aref fi
1))) ;Test CONDITION
721 (not (and (eq result
'no-multi
)
723 (progn (when (eq result
'multi
)
728 (not (eq result
'multi
)))))
729 (when (and (not function-info-list
)
731 (error "No catch-all in msb-menu-cond!"))
734 ;; Adds BUFFER to the menu depicted by FUNCTION-INFO
735 ;; All side-effects. Adds an element of form (BUFFER-TITLE . BUFFER)
736 ;; to the buffer-list variable in function-info.
737 (defun msb--add-to-menu (buffer function-info max-buffer-name-length
)
738 (let ((list-symbol (aref function-info
0))) ;BUFFER-LIST-VARIABLE
739 ;; Here comes the hairy side-effect!
741 (cons (cons (funcall (aref function-info
4) ;ITEM-HANDLER
743 max-buffer-name-length
)
745 (eval list-symbol
)))))
747 ;; Selects the appropriate menu for BUFFER.
748 ;; This is all side-effects, folks!
749 ;; This should be optimized.
750 (defsubst msb--choose-menu
(buffer function-info-vector max-buffer-name-length
)
751 (unless (and (not msb-display-invisible-buffers-p
)
752 (msb-invisible-buffer-p buffer
))
756 ;; Menu found. Add to this menu
757 (mapc (lambda (function-info)
758 (msb--add-to-menu buffer function-info max-buffer-name-length
))
759 (msb--collect function-info-vector
)))
760 (error (unless msb--error
763 "In msb-menu-cond, error for buffer `%s'."
764 (buffer-name buffer
)))
765 (error "%s" msb--error
))))))
767 ;; Return (SORT-KEY TITLE . BUFFER-LIST) or nil if the
768 ;; buffer-list is empty.
769 (defun msb--create-sort-item (function-info)
770 (let ((buffer-list (eval (aref function-info
0))))
772 (let ((sorter (aref function-info
5)) ;SORTER
773 (sort-key (aref function-info
2))) ;MENU-SORT-KEY
776 (cons (format (aref function-info
3) ;MENU-TITLE
777 (length buffer-list
))
782 (nreverse buffer-list
))
784 (sort buffer-list sorter
))))))))))
786 ;; Return ALIST as a sorted, aggregated alist, where all items with
787 ;; the same car element (according to SAME-PREDICATE) are aggregated
788 ;; together. The alist is first sorted by SORT-PREDICATE.
790 ;; (msb--aggregate-alist
791 ;; '((a . a1) (a . a2) (b . b1) (c . c3) (a . a4) (a . a3) (b . b3) (b . b2))
792 ;; (function string=)
793 ;; (lambda (item1 item2)
794 ;; (string< (symbol-name item1) (symbol-name item2))))
796 ;; ((a a1 a2 a4 a3) (b b1 b3 b2) (c c3))
797 (defun msb--aggregate-alist (alist same-predicate sort-predicate
)
798 (when (not (null alist
))
806 (mapcan (lambda (item)
809 (push (cdr item
) same
)
810 (setq first-time-p nil
)
811 (setq old-car
(car item
))
813 ((funcall same-predicate
(car item
) old-car
)
814 (push (cdr item
) same
)
819 (setq same
(list (cdr item
))
821 (list (cons tmp-old-car
(nreverse tmp-same
))))))
822 (sort alist
(lambda (item1 item2
)
823 (funcall sort-predicate
(car item1
) (car item2
)))))
824 (list (cons old-car
(nreverse same
)))))))
827 (defun msb--mode-menu-cond ()
828 (let ((key msb-modes-key
))
829 (mapcar (lambda (item)
831 (list `( eq major-mode
(quote ,(car item
)))
833 (concat (cdr item
) " (%d)")))
835 (let ((mode-list nil
))
836 (mapc (lambda (buffer)
839 (when (and (not (msb-invisible-buffer-p))
840 (not (assq major-mode mode-list
))
841 (push (cons major-mode mode-name
)
845 (lambda (item1 item2
)
846 (string< (cdr item1
) (cdr item2
)))))))
848 ;; Returns a list on the form ((TITLE . BUFFER-LIST)) for
849 ;; the most recently used buffers.
850 (defun msb--most-recently-used-menu (max-buffer-name-length)
851 (when (and (numberp msb-display-most-recently-used
)
852 (> msb-display-most-recently-used
0))
853 (let* ((buffers (cdr (buffer-list)))
856 for buffer in buffers
859 (and (not (msb-invisible-buffer-p))
860 (not (eq major-mode
'dired-mode
))))
861 collect
(save-excursion
863 (cons (funcall msb-item-handling-function
865 max-buffer-name-length
)
868 until
(>= n msb-display-most-recently-used
))))
869 (cons (if (stringp msb-most-recently-used-title
)
870 (format msb-most-recently-used-title
871 (length most-recently-used
))
872 (signal 'wrong-type-argument
(list msb-most-recently-used-title
)))
873 most-recently-used
))))
875 (defun msb--create-buffer-menu-2 ()
876 (let ((max-buffer-name-length 0)
878 function-info-vector
)
879 ;; Calculate the longest buffer name.
882 (if (or msb-display-invisible-buffers-p
883 (not (msb-invisible-buffer-p)))
884 (setq max-buffer-name-length
885 (max max-buffer-name-length
886 (length (buffer-name buffer
))))))
888 ;; Make a list with elements of type
889 ;; (BUFFER-LIST-VARIABLE
895 ;; Uses "function-global" variables:
896 ;; function-info-vector
897 (setq function-info-vector
898 (apply (function vector
)
899 (mapcar (function msb--create-function-info
)
900 (append msb-menu-cond
(msb--mode-menu-cond)))))
901 ;; Split the buffer-list into several lists; one list for each
902 ;; criteria. This is the most critical part with respect to time.
903 (mapc (lambda (buffer)
904 (cond ((and msb-files-by-directory
905 (buffer-file-name buffer
)
906 ;; exclude ange-ftp buffers
907 ;;(not (string-match "\\/[^/:]+:"
908 ;; (buffer-file-name buffer)))
910 (push buffer file-buffers
))
912 (msb--choose-menu buffer
914 max-buffer-name-length
))))
918 (mapcar (lambda (buffer-list)
919 (cons msb-files-by-directory-sort-key
920 (cons (car buffer-list
)
924 (cons (save-excursion
926 (funcall msb-item-handling-function
928 max-buffer-name-length
))
932 (lambda (item1 item2
)
933 (string< (car item1
) (car item2
))))))))
934 (msb--choose-file-menu file-buffers
))))
935 ;; Now make the menu - a list of (TITLE . BUFFER-LIST)
938 (msb--most-recently-used-menu max-buffer-name-length
))
939 (others (nconc file-buffers
941 across function-info-vector
942 for value
= (msb--create-sort-item elt
)
943 if value collect value
))))
945 (mapcar 'cdr
;Remove the SORT-KEY
946 ;; Sort the menus - not the items.
949 ;; Get a list of (SORT-KEY TITLE . BUFFER-LIST)
950 ;; Also sorts the items within the menus.
951 (if (cdr most-recently-used
)
953 ;; Add most recent used buffers
954 (cons msb-most-recently-used-sort-key
959 (< (car elt1
) (car elt2
)))))))
960 ;; Now make it a keymap menu
962 '(keymap "Select Buffer")
963 (msb--make-keymap-menu menu
)
964 (when msb-separator-diff
965 (list (list 'separator
"--")))
968 (if msb-files-by-directory
970 "*Files by directory*")
971 'msb--toggle-menu-type
)))))))
973 (defun msb--create-buffer-menu ()
976 (msb--create-buffer-menu-2))))
979 ;;; Multi purpose function for selecting a buffer with the mouse.
981 (defun msb--toggle-menu-type ()
983 (setq msb-files-by-directory
(not msb-files-by-directory
))
984 ;; This gets a warning, but it is correct,
985 ;; because this file redefines menu-bar-update-buffers.
986 (menu-bar-update-buffers t
))
988 (defun mouse-select-buffer (event)
989 "Pop up several menus of buffers, for selection with the mouse.
990 Returns the selected buffer or nil if no buffer is selected.
992 The way the buffers are split is conveniently handled with the
993 variable `msb-menu-cond'."
994 ;; Popup the menu and return the selected buffer.
996 (not msb--last-buffer-menu
)
997 (not (fboundp 'frame-or-buffer-changed-p
))
998 (frame-or-buffer-changed-p))
999 (setq msb--error nil
)
1000 (setq msb--last-buffer-menu
(msb--create-buffer-menu)))
1001 (let ((position event
)
1003 (when (and (fboundp 'posn-x-y
)
1004 (fboundp 'posn-window
))
1005 (let ((posX (car (posn-x-y (event-start event
))))
1006 (posY (cdr (posn-x-y (event-start event
))))
1007 (posWind (posn-window (event-start event
))))
1009 (setq posX
(- posX
(funcall msb-horizontal-shift-function
))
1010 position
(list (list posX posY
) posWind
))))
1011 ;; This `sit-for' magically makes the menu stay up if the mouse
1012 ;; button is released within 0.1 second.
1015 (setq choice
(x-popup-menu position msb--last-buffer-menu
))
1017 ((eq (car choice
) 'toggle
)
1018 ;; Bring up the menu again with type toggled.
1019 (msb--toggle-menu-type)
1020 (mouse-select-buffer event
))
1021 ((and (numberp (car choice
))
1022 (null (cdr choice
)))
1023 (let ((msb--last-buffer-menu (nthcdr 3 (assq (car choice
) msb--last-buffer-menu
))))
1024 (mouse-select-buffer event
)))
1025 ((while (numberp (car choice
))
1026 (setq choice
(cdr choice
))))
1027 ((and (stringp (car choice
))
1028 (null (cdr choice
)))
1033 (error "Unknown form for buffer: %s" choice
)))))
1036 (defun msb--add-separators (sorted-list)
1038 ((or (not msb-separator-diff
)
1039 (not (numberp msb-separator-diff
)))
1042 (let ((last-key nil
))
1046 ((and msb-separator-diff
1048 (> (- (car item
) last-key
)
1049 msb-separator-diff
))
1050 (setq last-key
(car item
))
1051 (list (cons last-key
'separator
)
1054 (setq last-key
(car item
))
1058 (defun msb--split-menus-2 (list mcount result
)
1060 ((> (length list
) msb-max-menu-items
)
1064 (while (< count msb-max-menu-items
)
1065 (push (pop list
) tmp-list
)
1067 (setq tmp-list
(nreverse tmp-list
))
1068 (setq sub-name
(concat (car (car tmp-list
)) "..."))
1069 (push (nconc (list mcount sub-name
1073 (msb--split-menus-2 list
(1+ mcount
) result
))
1078 (setq sub-name
(concat (car (car list
)) "..."))
1079 (push (nconc (list mcount sub-name
1083 (nreverse result
))))
1085 (defun msb--split-menus (list)
1086 (if (and (integerp msb-max-menu-items
)
1087 (> msb-max-menu-items
0))
1088 (msb--split-menus-2 list
0 nil
)
1091 (defun msb--make-keymap-menu (raw-menu)
1092 (let ((end (cons '(nil) 'menu-bar-select-buffer
))
1097 ((eq 'separator sub-menu
)
1098 (list 'separator
"--"))
1100 (let ((buffers (mapcar (function
1102 (let ((string (car item
))
1103 (buffer (cdr item
)))
1104 (cons (buffer-name buffer
)
1105 (cons string end
)))))
1107 (nconc (list (incf mcount
) (car sub-menu
)
1108 'keymap
(car sub-menu
))
1109 (msb--split-menus buffers
))))))
1112 (defun menu-bar-update-buffers (&optional arg
)
1113 ;; If user discards the Buffers item, play along.
1114 (when (and (lookup-key (current-global-map) [menu-bar buffer
])
1115 (or (not (fboundp 'frame-or-buffer-changed-p
))
1116 (frame-or-buffer-changed-p)
1118 (let ((frames (frame-list))
1119 buffers-menu frames-menu
)
1120 ;; Make the menu of buffers proper.
1121 (setq msb--last-buffer-menu
(msb--create-buffer-menu))
1122 (setq buffers-menu msb--last-buffer-menu
)
1123 ;; Make a Frames menu if we have more than one frame.
1125 (let* ((frame-length (length frames
))
1126 (f-title (format "Frames (%d)" frame-length
)))
1127 ;; List only the N most recently selected frames
1128 (when (and (integerp msb-max-menu-items
)
1129 (> msb-max-menu-items
1)
1130 (> frame-length msb-max-menu-items
))
1131 (setcdr (nthcdr msb-max-menu-items frames
) nil
))
1134 (list 'frame f-title
'(nil) 'keymap f-title
)
1140 (frame-parameters frame
)))
1142 'menu-bar-select-frame
))
1144 (define-key (current-global-map) [menu-bar buffer
]
1146 (if (and buffers-menu frames-menu
)
1147 ;; Combine Frame and Buffers menus with separator between
1148 (nconc (list 'keymap
"Buffers and Frames" frames-menu
1149 (and msb-separator-diff
'(separator "--")))
1150 (cddr buffers-menu
))
1151 (or buffers-menu
'undefined
)))))))
1153 (when (and (boundp 'menu-bar-update-hook
)
1154 (not (fboundp 'frame-or-buffer-changed-p
)))
1155 (defvar msb--buffer-count
0)
1156 (defun frame-or-buffer-changed-p ()
1157 (let ((count (length (buffer-list))))
1158 (when (/= count msb--buffer-count
)
1159 (setq msb--buffer-count count
)
1162 (unless (or (not (boundp 'menu-bar-update-hook
))
1163 (memq 'menu-bar-update-buffers menu-bar-update-hook
))
1164 (add-hook 'menu-bar-update-hook
'menu-bar-update-buffers
))
1166 (and (fboundp 'mouse-buffer-menu
)
1167 (substitute-key-definition 'mouse-buffer-menu
'msb
(current-global-map)))
1170 (eval-after-load 'msb
(run-hooks 'msb-after-load-hooks
))
1172 ;;; msb.el ends here