-;;; msb.el --- Customizable buffer-selection with multiple menus.
+;;; msb.el --- customizable buffer-selection with multiple menus
-;; Copyright (C) 1993, 1994, 1995, 1997 Lars Lindberg
-;; <Lars.G.Lindberg@capgemini.se>
-;; <Lars.G.Lindberg@mailbox.swipnet.se>
+;; Copyright (C) 1993, 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002,
+;; 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
-;; Author: Lars Lindberg <Lars.G.Lindberg@capgemini.se>
+;; Author: Lars Lindberg <lars.lindberg@home.se>
+;; Maintainer: FSF
;; Created: 8 Oct 1993
-;; Lindberg's last update version: 3.33
+;; Lindberg's last update version: 3.34
;; Keywords: mouse buffer menu
;; This file is part of GNU Emacs.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; Purpose of this package:
;; 1. Offer a function for letting the user choose buffer,
;; not necessarily for switching to it.
-;; 2. Make a better mouse-buffer-menu.
-;;
-;; Installation:
-
-;; 1. Byte compile msb first. It uses things in the cl package that
-;; are slow if not compiled, but blazingly fast when compiled. I
-;; have also had one report that said that msb malfunctioned when
-;; not compiled.
-;; 2. (require 'msb)
-;; Note! You now use msb instead of mouse-buffer-menu.
-;; 3. Now try the menu bar Buffers menu.
+;; 2. Make a better mouse-buffer-menu. This is done as a global
+;; minor mode, msb-mode.
;;
;; Customization:
;; Look at the variable `msb-menu-cond' for deciding what menus you
;; There are some constants for you to try here:
;; msb--few-menus
;; msb--very-many-menus (default)
-;;
+;;
;; Look at the variable `msb-item-handling-function' for customization
;; of the appearance of every menu item. Try for instance setting
;; it to `msb-alon-item-handler'.
-;;
+;;
;; Look at the variable `msb-item-sort-function' for customization
;; of sorting the menus. Set it to t for instance, which means no
;; sorting - you will get latest used buffer first.
;; Known bugs:
;; - Files-by-directory
;; + No possibility to show client/changed buffers separately.
-;; + All file buffers only appear in in a file sub-menu, they will
+;; + All file buffers only appear in a file sub-menu, they will
;; for instance not appear in the Mail sub-menu.
;; Future enhancements:
;; Alon Albert <alon@milcse.rtsg.mot.com>
;; Kevin Broadey, <KevinB@bartley.demon.co.uk>
;; Ake Stenhof <ake@cadpoint.se>
-;; Richard Stallman <rms@gnu.ai.mit.edu>
+;; Richard Stallman <rms@gnu.org>
;; Steve Fisk <fisk@medved.bowdoin.edu>
+;; This version turned into a global minor mode and subsequently
+;; hacked on by Dave Love.
;;; Code:
-(require 'cl)
+(eval-when-compile (require 'cl))
;;;
;;; Some example constants to be used for `msb-menu-cond'. See that
((eq major-mode 'w3-mode)
4020
"WWW (%d)")
- ((or (memq major-mode '(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode))
- (memq major-mode '(mh-letter-mode
- mh-show-mode
- mh-folder-mode))
- (memq major-mode '(gnus-summary-mode
- news-reply-mode
- gnus-group-mode
- gnus-article-mode
- gnus-kill-file-mode
- gnus-browse-killed-mode)))
+ ((or (memq major-mode
+ '(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode))
+ (memq major-mode '(mh-letter-mode mh-show-mode mh-folder-mode))
+ (memq major-mode
+ '(gnus-summary-mode message-mode gnus-group-mode
+ gnus-article-mode score-mode gnus-browse-killed-mode)))
4010
"Mail (%d)")
((not buffer-file-name)
;; Also note this item-sorter
msb-sort-by-directory)
((eq major-mode 'Man-mode)
- 4030
+ 5030
"Manuals (%d)")
((eq major-mode 'w3-mode)
- 4020
+ 5020
"WWW (%d)")
- ((or (memq major-mode '(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode))
- (memq major-mode '(mh-letter-mode
- mh-show-mode
- mh-folder-mode))
- (memq major-mode '(gnus-summary-mode
- news-reply-mode
- gnus-group-mode
- gnus-article-mode
- gnus-kill-file-mode
+ ((or (memq major-mode
+ '(rmail-mode rmail-edit-mode vm-summary-mode vm-mode mail-mode))
+ (memq major-mode '(mh-letter-mode mh-show-mode mh-folder-mode))
+ (memq major-mode '(gnus-summary-mode message-mode gnus-group-mode
+ gnus-article-mode score-mode
gnus-browse-killed-mode)))
- 4010
+ 5010
"Mail (%d)")
;; Catchup for all non-file buffers
((and (not buffer-file-name)
'no-multi)
- 4099
+ 5099
"Other non-file buffers (%d)")
((and (string-match "/\\.[^/]*$" buffer-file-name)
'multi)
"Elisp Files (%d)")
((eq major-mode 'latex-mode)
3030
- "LaTex Files (%d)")
+ "LaTeX Files (%d)")
('no-multi
3099
"Other files (%d)")))
;;; Customizable variables
;;;
-(defvar msb-separator-diff 100
+(defgroup msb nil
+ "Customizable buffer-selection with multiple menus."
+ :prefix "msb-"
+ :group 'mouse)
+
+(defun msb-custom-set (symbol value)
+ "Set the value of custom variables for msb."
+ (set symbol value)
+ (if (and (featurep 'msb) msb-mode)
+ ;; wait until package has been loaded before bothering to update
+ ;; the buffer lists.
+ (msb-menu-bar-update-buffers t)))
+
+(defcustom msb-menu-cond msb--very-many-menus
+ "*List of criteria for splitting the mouse buffer menu.
+The elements in the list should be of this type:
+ (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN).
+
+When making the split, the buffers are tested one by one against the
+CONDITION, just like a Lisp cond: When hitting a true condition, the
+other criteria are *not* tested and the buffer name will appear in the
+menu with the menu-title corresponding to the true condition.
+
+If the condition returns the symbol `multi', then the buffer will be
+added to this menu *and* tested for other menus too. If it returns
+`no-multi', then the buffer will only be added if it hasn't been added
+to any other menu.
+
+During this test, the buffer in question is the current buffer, and
+the test is surrounded by calls to `save-excursion' and
+`save-match-data'.
+
+The categories are sorted by MENU-SORT-KEY. Smaller keys are on top.
+nil means don't display this menu.
+
+MENU-TITLE is really a format. If you add %d in it, the %d is
+replaced with the number of items in that menu.
+
+ITEM-HANDLING-FN, is optional. If it is supplied and is a function,
+than it is used for displaying the items in that particular buffer
+menu, otherwise the function pointed out by
+`msb-item-handling-function' is used.
+
+ITEM-SORT-FN, is also optional.
+If it is not supplied, the function pointed out by
+`msb-item-sort-function' is used.
+If it is nil, then no sort takes place and the buffers are presented
+in least-recently-used order.
+If it is t, then no sort takes place and the buffers are presented in
+most-recently-used order.
+If it is supplied and non-nil and not t than it is used for sorting
+the items in that particular buffer menu.
+
+Note1: There should always be a `catch-all' as last element, in this
+list. That is an element like (t TITLE ITEM-HANDLING-FUNCTION).
+Note2: A buffer menu appears only if it has at least one buffer in it.
+Note3: If you have a CONDITION that can't be evaluated you will get an
+error every time you do \\[msb]."
+ :type `(choice (const :tag "long" :value ,msb--very-many-menus)
+ (const :tag "short" :value ,msb--few-menus)
+ (sexp :tag "user"))
+ :set 'msb-custom-set
+ :group 'msb)
+
+(defcustom msb-modes-key 4000
+ "The sort key for files sorted by mode."
+ :type 'integer
+ :set 'msb-custom-set
+ :group 'msb
+ :version "20.3")
+
+(defcustom msb-separator-diff 100
"*Non-nil means use separators.
The separators will appear between all menus that have a sorting key
-that differs by this value or more.")
+that differs by this value or more."
+ :type '(choice integer (const nil))
+ :set 'msb-custom-set
+ :group 'msb)
(defvar msb-files-by-directory-sort-key 0
"*The sort key for files sorted by directory.")
-(defvar msb-max-menu-items 15
+(defcustom msb-max-menu-items 15
"*The maximum number of items in a menu.
If this variable is set to 15 for instance, then the submenu will be
-split up in minor parts, 15 items each. If nil, there is no limit.")
+split up in minor parts, 15 items each. nil means no limit."
+ :type '(choice integer (const nil))
+ :set 'msb-custom-set
+ :group 'msb)
-(defvar msb-max-file-menu-items 10
+(defcustom msb-max-file-menu-items 10
"*The maximum number of items from different directories.
When the menu is of type `file by directory', this is the maximum
Set this to 1 if you want one menu per directory instead of clumping
them together.
-If the value is not a number, then the value 10 is used.")
+If the value is not a number, then the value 10 is used."
+ :type 'integer
+ :set 'msb-custom-set
+ :group 'msb)
-(defvar msb-most-recently-used-sort-key -1010
- "*Where should the menu with the most recently used buffers be placed?")
+(defcustom msb-most-recently-used-sort-key -1010
+ "*Where should the menu with the most recently used buffers be placed?"
+ :type 'integer
+ :set 'msb-custom-set
+ :group 'msb)
-(defvar msb-display-most-recently-used 15
+(defcustom msb-display-most-recently-used 15
"*How many buffers should be in the most-recently-used menu.
- No buffers at all if less than 1 or nil (or any non-number).")
+No buffers at all if less than 1 or nil (or any non-number)."
+ :type 'integer
+ :set 'msb-custom-set
+ :group 'msb)
+
+(defcustom msb-most-recently-used-title "Most recently used (%d)"
+ "*The title for the most-recently-used menu."
+ :type 'string
+ :set 'msb-custom-set
+ :group 'msb)
-(defvar msb-most-recently-used-title "Most recently used (%d)"
- "*The title for the most-recently-used menu.")
-
(defvar msb-horizontal-shift-function '(lambda () 0)
"*Function that specifies how many pixels to shift the top menu leftwards.")
-(defvar msb-display-invisible-buffers-p nil
+(defcustom msb-display-invisible-buffers-p nil
"*Show invisible buffers or not.
Non-nil means that the buffer menu should include buffers that have
-names that starts with a space character.")
+names that starts with a space character."
+ :type 'boolean
+ :set 'msb-custom-set
+ :group 'msb)
(defvar msb-item-handling-function 'msb-item-handler
"*The appearance of a buffer menu.
nil as ITEM-HANDLING-FUNCTION. See `msb-menu-cond' for more
information.")
-(defvar msb-item-sort-function 'msb-sort-by-name
+(defcustom msb-item-sort-function 'msb-sort-by-name
"*The order of items in a buffer menu.
The default function to call for handling the order of items in a menu
ITEM-NAME is the name of the item that will appear in the menu.
BUFFER is the buffer, this is not necessarily the current buffer.
-Set this to nil or t if you don't want any sorting (faster).")
-
-(defvar msb-files-by-directory nil
- "*Non-nil means that files should be sorted by directory instead of
-the groups in msb-menu-cond.")
-
-(defvar msb-menu-cond msb--very-many-menus
- "*List of criteria for splitting the mouse buffer menu.
-The elements in the list should be of this type:
- (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN).
-
-When making the split, the buffers are tested one by one against the
-CONDITION, just like a lisp cond: When hitting a true condition, the
-other criteria are *not* tested and the buffer name will appear in the
-menu with the menu-title corresponding to the true condition.
-
-If the condition returns the symbol `multi', then the buffer will be
-added to this menu *and* tested for other menus too. If it returns
-`no-multi', then the buffer will only be added if it hasn't been added
-to any other menu.
-
-During this test, the buffer in question is the current buffer, and
-the test is surrounded by calls to `save-excursion' and
-`save-match-data'.
-
-The categories are sorted by MENU-SORT-KEY. Smaller keys are on top.
-nil means don't display this menu.
-
-MENU-TITLE is really a format. If you add %d in it, the %d is
-replaced with the number of items in that menu.
-
-ITEM-HANDLING-FN, is optional. If it is supplied and is a function,
-than it is used for displaying the items in that particular buffer
-menu, otherwise the function pointed out by
-`msb-item-handling-function' is used.
-
-ITEM-SORT-FN, is also optional.
-If it is not supplied, the function pointed out by
-`msb-item-sort-function' is used.
-If it is nil, then no sort takes place and the buffers are presented
-in least-recently-used order.
-If it is t, then no sort takes place and the buffers are presented in
-most-recently-used order.
-If it is supplied and non-nil and not t than it is used for sorting
-the items in that particular buffer menu.
-
-Note1: There should always be a `catch-all' as last element, in this
-list. That is an element like (t TITLE ITEM-HANDLING-FUNCTION).
-Note2: A buffer menu appears only if it has at least one buffer in it.
-Note3: If you have a CONDITION that can't be evaluated you will get an
-error every time you do \\[msb].")
-
-(defvar msb-after-load-hooks nil
- "Hooks to be run after the msb package has been loaded.")
+Set this to nil or t if you don't want any sorting (faster)."
+ :type '(choice (const msb-sort-by-name)
+ (const :tag "Newest first" t)
+ (const :tag "Oldest first" nil))
+ :set 'msb-custom-set
+ :group 'msb)
+
+(defcustom msb-files-by-directory nil
+ "*Non-nil means that files should be sorted by directory.
+This is instead of the groups in `msb-menu-cond'."
+ :type 'boolean
+ :set 'msb-custom-set
+ :group 'msb)
+
+(defcustom msb-after-load-hook nil
+ "Hook run after the msb package has been loaded."
+ :type 'hook
+ :set 'msb-custom-set
+ :group 'msb)
;;;
;;; Internal variables
;;;
-;; Home directory for the current user
-(defvar msb--home-path
- (condition-case nil
- (substitute-in-file-name "$HOME")
- ;; If $HOME isn't defined, use nil
- (error nil)))
-
;; The last calculated menu.
(defvar msb--last-buffer-menu nil)
;;; Some example function to be used for `msb-item-sort-function'.
;;;
(defun msb-sort-by-name (item1 item2)
- "Sorts the items depending on their buffer-name
-An item look like (NAME . BUFFER)."
+ "Sort the items ITEM1 and ITEM2 by their `buffer-name'.
+An item looks like (NAME . BUFFER)."
(string-lessp (buffer-name (cdr item1))
(buffer-name (cdr item2))))
(defun msb-sort-by-directory (item1 item2)
- "Sorts the items depending on their directory. Made for dired.
+ "Sort the items ITEM1 and ITEM2 by directory name. Made for dired.
An item look like (NAME . BUFFER)."
(string-lessp (save-excursion (set-buffer (cdr item1))
(msb--dired-directory))
See the function `mouse-select-buffer' and the variable
`msb-menu-cond' for more information about how the menus are split."
(interactive "e")
+ ;; If EVENT is a down-event, read and discard the
+ ;; corresponding up-event.
+ (and (eventp event)
+ (memq 'down (event-modifiers event))
+ (read-event))
(let ((old-window (selected-window))
(window (posn-window (event-start event))))
(unless (framep window) (select-window window))
"Return t if optional BUFFER is an \"invisible\" buffer.
If the argument is left out or nil, then the current buffer is considered."
(and (> (length (buffer-name buffer)) 0)
- (eq ?\ (aref (buffer-name buffer) 0))))
+ (eq ?\s (aref (buffer-name buffer) 0))))
-;; Strip one hierarchy level from the end of PATH.
-(defun msb--strip-path (path)
- (save-match-data
- (cond
- ((string-match "^\\([^/]*/.+/\\)[^/]+$" path)
- (substring path (match-beginning 1) (match-end 1)))
- ((string-match "^\\([^/]*/\\)" path)
- (substring path (match-beginning 1) (match-end 1)))
- (t
- (error "msb: Path '%s' has an unrecognized format" path)))))
+(defun msb--strip-dir (dir)
+ "Strip one hierarchy level from the end of DIR."
+ (file-name-directory (directory-file-name dir)))
;; Create an alist with all buffers from LIST that lies under the same
-;; directory will be in the same item as the directory string.
-;; ((PATH1 . (BUFFER-1 BUFFER-2 ...)) (PATH2 . (BUFFER-K BUFFER-K+1...)) =
-...)
+;; directory will be in the same item as the directory name.
+;; ((DIR1 . (BUFFER-1 BUFFER-2 ...)) (DIR2 . (BUFFER-K BUFFER-K+1...)) ...)
(defun msb--init-file-alist (list)
(let ((buffer-alist
;; Make alist that looks like
- ;; ((PATH-1 BUFFER-1) (PATH-2 BUFFER-2) ...)
- ;; sorted on PATH-x
- (sort (mapcan
- (function
- (lambda (buffer)
- (let ((file-name (expand-file-name (buffer-file-name buffer)))) =
-;LGL 971218
- (when file-name
- (list (cons (msb--strip-path file-name) buffer))))))
- list)
- (function (lambda (item1 item2)
- (string< (car item1) (car item2)))))))
- ;; Now clump buffers togehter that have the same path
+ ;; ((DIR-1 BUFFER-1) (DIR-2 BUFFER-2) ...)
+ ;; sorted on DIR-x
+ (sort
+ (apply #'nconc
+ (mapcar
+ (lambda (buffer)
+ (let ((file-name (expand-file-name
+ (buffer-file-name buffer))))
+ (when file-name
+ (list (cons (msb--strip-dir file-name) buffer)))))
+ list))
+ (lambda (item1 item2)
+ (string< (car item1) (car item2))))))
+ ;; Now clump buffers together that have the same directory name
;; Make alist that looks like
- ;; ((PATH1 . (BUFFER-1 BUFFER-2 ...)) (PATH2 . (BUFFER-K)) ...)
- (let ((path nil)
+ ;; ((DIR1 . (BUFFER-1 BUFFER-2 ...)) (DIR2 . (BUFFER-K)) ...)
+ (let ((dir nil)
(buffers nil))
(nconc
- (mapcan (function
- (lambda (item)
+ (apply
+ #'nconc
+ (mapcar (lambda (item)
(cond
- ((and path
- (string=3D path (car item)))
- ;; The same path as earlier: Add to current list of
- ;; buffers.
+ ((equal dir (car item))
+ ;; The same dir as earlier:
+ ;; Add to current list of buffers.
(push (cdr item) buffers)
;; This item should not be added to list
nil)
(t
- ;; New path
- (let ((result (and path (cons path buffers))))
- (setq path (car item))
+ ;; New dir
+ (let ((result (and dir (cons dir buffers))))
+ (setq dir (car item))
(setq buffers (list (cdr item)))
;; Add the last result the list.
- (and result (list result)))))))
- buffer-alist)
+ (and result (list result))))))
+ buffer-alist))
;; Add the last result to the list
- (list (cons path buffers))))))
+ (list (cons dir buffers))))))
-;; Format a suitable title for the menu item.
-(defun msb--format-title (top-found-p path number-of-items)
- (let ((new-path path))
- (when (and msb--home-path
- (string-match (concat "^" msb--home-path) path))
- (setq new-path (concat "~/"
- (substring path (match-end 0)))))
- (format (if top-found-p "%s... (%d)" "%s (%d)")
- new-path number-of-items)))
+(defun msb--format-title (top-found-p dir number-of-items)
+ "Format a suitable title for the menu item."
+ (format (if top-found-p "%s... (%d)" "%s (%d)")
+ (abbreviate-file-name dir) number-of-items))
+;; Variables for debugging.
+(defvar msb--choose-file-menu-list)
+(defvar msb--choose-file-menu-arg-list)
-;; Choose file-menu with respect to directory for every buffer in LIST.
(defun msb--choose-file-menu (list)
+ "Choose file-menu with respect to directory for every buffer in LIST."
+ (setq msb--choose-file-menu-arg-list list)
(let ((buffer-alist (msb--init-file-alist list))
(final-list nil)
(max-clumped-together (if (numberp msb-max-file-menu-items)
msb-max-file-menu-items
10))
(top-found-p nil)
- (last-path nil)
- first rest path buffers)
+ (last-dir nil)
+ first rest dir buffers old-dir)
;; Prepare for looping over all items in buffer-alist
(setq first (car buffer-alist)
rest (cdr buffer-alist)
- path (car first)
+ dir (car first)
buffers (cdr first))
+ (setq msb--choose-file-menu-list (copy-sequence rest))
;; This big loop tries to clump buffers together that have a
;; similar name. Remember that buffer-alist is sorted based on the
- ;; path for the buffers.
+ ;; directory name of the buffers' visited files.
(while rest
(let ((found-p nil)
(tmp-rest rest)
result
- new-path item)
+ new-dir item)
(setq item (car tmp-rest))
- ;; Clump together the "rest"-buffers that have a path that is
- ;; a subpath of the current one.
+ ;; Clump together the "rest"-buffers that have a dir that is
+ ;; a subdir of the current one.
(while (and tmp-rest
(<= (length buffers) max-clumped-together)
- (>= (length (car item)) (length path))
- (string= path (substring (car item) 0 (length path))))
+ (>= (length (car item)) (length dir))
+ ;; `completion-ignore-case' seems to default to t
+ ;; on the systems with case-insensitive file names.
+ (eq t (compare-strings dir 0 nil
+ (car item) 0 (length dir)
+ completion-ignore-case)))
(setq found-p t)
(setq buffers (append buffers (cdr item))) ;nconc is faster than append
(setq tmp-rest (cdr tmp-rest)
((> (length buffers) max-clumped-together)
;; Oh, we failed. Too many buffers clumped together.
;; Just use the original ones for the result.
- (setq last-path (car first))
+ (setq last-dir (car first))
(push (cons (msb--format-title top-found-p
(car first)
(length (cdr first)))
(setq top-found-p nil)
(setq first (car rest)
rest (cdr rest)
- path (car first)
+ dir (car first)
buffers (cdr first)))
(t
;; The first pass of clumping together worked out, go ahead
;; with this result.
(when found-p
(setq top-found-p t)
- (setq first (cons path buffers)
+ (setq first (cons dir buffers)
rest tmp-rest))
;; Now see if we can clump more buffers together if we go up
;; one step in the file hierarchy.
- (setq path (msb--strip-path path)
+ ;; If dir isn't changed by msb--strip-dir, we are looking
+ ;; at the machine name component of an ange-ftp filename.
+ (setq old-dir dir)
+ (setq dir (msb--strip-dir dir)
buffers (cdr first))
- (when (and last-path
- (or (and (>= (length path) (length last-path))
- (string= last-path
- (substring path 0 (length last-path))))
- (and (< (length path) (length last-path))
- (string= path
- (substring last-path 0 (length path))))))
+ (if (equal old-dir dir)
+ (setq last-dir dir))
+ (when (and last-dir
+ (or (and (>= (length dir) (length last-dir))
+ (eq t (compare-strings
+ last-dir 0 nil dir 0
+ (length last-dir)
+ completion-ignore-case)))
+ (and (< (length dir) (length last-dir))
+ (eq t (compare-strings
+ dir 0 nil last-dir 0 (length dir)
+ completion-ignore-case)))))
;; We have reached the same place in the file hierarchy as
;; the last result, so we should quit at this point and
;; take what we have as result.
(setq top-found-p nil)
(setq first (car rest)
rest (cdr rest)
- path (car first)
+ dir (car first)
buffers (cdr first)))))))
;; Now take care of the last item.
- (push (cons (msb--format-title top-found-p
- (car first)
- (length (cdr first)))
- (cdr first))
- final-list)
+ (when first
+ (push (cons (msb--format-title top-found-p
+ (car first)
+ (length (cdr first)))
+ (cdr first))
+ final-list))
(setq top-found-p nil)
(nreverse final-list)))
-;; Create a vector as:
-;; [BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER)
-;; from an element in `msb-menu-cond'. See that variable for a
-;; description of its elements.
(defun msb--create-function-info (menu-cond-elt)
+ "Create a vector from an element MENU-COND-ELT of `msb-menu-cond'.
+This takes the form:
+\]BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER)
+See `msb-menu-cond' for a description of its elements."
(let* ((list-symbol (make-symbol "-msb-buffer-list"))
(tmp-ih (and (> (length menu-cond-elt) 3)
(nth 3 menu-cond-elt)))
(sorter (if (or (fboundp tmp-s)
(null tmp-s)
(eq tmp-s t))
- tmp-s
+ tmp-s
msb-item-sort-function)))
(when (< (length menu-cond-elt) 3)
- (error "Wrong format of msb-menu-cond."))
+ (error "Wrong format of msb-menu-cond"))
(when (and (> (length menu-cond-elt) 3)
(not (fboundp tmp-ih)))
(signal 'invalid-function (list tmp-ih)))
))
;; This defsubst is only used in `msb--choose-menu' below. It was
-;; pulled out merely to make the code somewhat clearer. The indention
+;; pulled out merely to make the code somewhat clearer. The indentation
;; level was too big.
(defsubst msb--collect (function-info-vector)
(let ((result nil)
(error "No catch-all in msb-menu-cond!"))
function-info-list))
-;; Adds BUFFER to the menu depicted by FUNCTION-INFO
-;; All side-effects. Adds an element of form (BUFFER-TITLE . BUFFER)
-;; to the buffer-list variable in function-info.
(defun msb--add-to-menu (buffer function-info max-buffer-name-length)
+ "Add BUFFER to the menu depicted by FUNCTION-INFO.
+All side-effects. Adds an element of form (BUFFER-TITLE . BUFFER)
+to the buffer-list variable in function-info."
(let ((list-symbol (aref function-info 0))) ;BUFFER-LIST-VARIABLE
;; Here comes the hairy side-effect!
(set list-symbol
max-buffer-name-length)
buffer)
(eval list-symbol)))))
-
-;; Selects the appropriate menu for BUFFER.
-;; This is all side-effects, folks!
-;; This should be optimized.
+
(defsubst msb--choose-menu (buffer function-info-vector max-buffer-name-length)
+ "Select the appropriate menu for BUFFER."
+ ;; This is all side-effects, folks!
+ ;; This should be optimized.
(unless (and (not msb-display-invisible-buffers-p)
(msb-invisible-buffer-p buffer))
(condition-case nil
(save-excursion
(set-buffer buffer)
;; Menu found. Add to this menu
- (mapc (function
- (lambda (function-info)
- (msb--add-to-menu buffer function-info max-buffer-name-length)))
- (msb--collect function-info-vector)))
+ (dolist (info (msb--collect function-info-vector))
+ (msb--add-to-menu buffer info max-buffer-name-length)))
(error (unless msb--error
(setq msb--error
(format
(buffer-name buffer)))
(error "%s" msb--error))))))
-;; Return (SORT-KEY TITLE . BUFFER-LIST) or nil if the
-;; buffer-list is empty.
(defun msb--create-sort-item (function-info)
+ "Return (SORT-KEY TITLE . BUFFER-LIST) or nil if the buffer-list is empty."
(let ((buffer-list (eval (aref function-info 0))))
(when buffer-list
(let ((sorter (aref function-info 5)) ;SORTER
(t
(sort buffer-list sorter))))))))))
-;; Returns a list on the form ((TITLE . BUFFER-LIST)) for
-;; the most recently used buffers.
+(defun msb--aggregate-alist (alist same-predicate sort-predicate)
+ "Return ALIST as a sorted, aggregated alist.
+
+In the result all items with the same car element (according to
+SAME-PREDICATE) are aggregated together. The alist is first sorted by
+SORT-PREDICATE.
+
+Example:
+\(msb--aggregate-alist
+ '((a . a1) (a . a2) (b . b1) (c . c3) (a . a4) (a . a3) (b . b3) (b . b2))
+ (function string=)
+ (lambda (item1 item2)
+ (string< (symbol-name item1) (symbol-name item2))))
+results in
+\((a a1 a2 a4 a3) (b b1 b3 b2) (c c3))"
+ (when (not (null alist))
+ (let (result
+ same
+ tmp-old-car
+ tmp-same
+ (first-time-p t)
+ old-car)
+ (nconc
+ (apply #'nconc
+ (mapcar
+ (lambda (item)
+ (cond
+ (first-time-p
+ (push (cdr item) same)
+ (setq first-time-p nil)
+ (setq old-car (car item))
+ nil)
+ ((funcall same-predicate (car item) old-car)
+ (push (cdr item) same)
+ nil)
+ (t
+ (setq tmp-same same
+ tmp-old-car old-car)
+ (setq same (list (cdr item))
+ old-car (car item))
+ (list (cons tmp-old-car (nreverse tmp-same))))))
+ (sort alist (lambda (item1 item2)
+ (funcall sort-predicate (car item1) (car item2))))))
+ (list (cons old-car (nreverse same)))))))
+
+
+(defun msb--mode-menu-cond ()
+ (let ((key msb-modes-key))
+ (mapcar (lambda (item)
+ (incf key)
+ (list `( eq major-mode (quote ,(car item)))
+ key
+ (concat (cdr item) " (%d)")))
+ (sort
+ (let ((mode-list nil))
+ (dolist (buffer (cdr (buffer-list)))
+ (save-excursion
+ (set-buffer buffer)
+ (when (and (not (msb-invisible-buffer-p))
+ (not (assq major-mode mode-list)))
+ (push (cons major-mode mode-name)
+ mode-list))))
+ mode-list)
+ (lambda (item1 item2)
+ (string< (cdr item1) (cdr item2)))))))
+
(defun msb--most-recently-used-menu (max-buffer-name-length)
+ "Return a list for the most recently used buffers.
+It takes the form ((TITLE . BUFFER-LIST)...)."
(when (and (numberp msb-display-most-recently-used)
(> msb-display-most-recently-used 0))
(let* ((buffers (cdr (buffer-list)))
file-buffers
function-info-vector)
;; Calculate the longest buffer name.
- (mapc
- (function
- (lambda (buffer)
- (if (or msb-display-invisible-buffers-p
+ (dolist (buffer (buffer-list))
+ (when (or msb-display-invisible-buffers-p
(not (msb-invisible-buffer-p)))
- (setq max-buffer-name-length
- (max max-buffer-name-length
- (length (buffer-name buffer)))))))
- (buffer-list))
+ (setq max-buffer-name-length
+ (max max-buffer-name-length (length (buffer-name buffer))))))
;; Make a list with elements of type
;; (BUFFER-LIST-VARIABLE
;; CONDITION
(setq function-info-vector
(apply (function vector)
(mapcar (function msb--create-function-info)
- msb-menu-cond)))
+ (append msb-menu-cond (msb--mode-menu-cond)))))
;; Split the buffer-list into several lists; one list for each
;; criteria. This is the most critical part with respect to time.
- (mapc (function (lambda (buffer)
- (cond ((and msb-files-by-directory
- (buffer-file-name buffer))
- (push buffer file-buffers))
- (t
- (msb--choose-menu buffer
- function-info-vector
- max-buffer-name-length)))))
- (buffer-list))
+ (dolist (buffer (buffer-list))
+ (cond ((and msb-files-by-directory
+ (buffer-file-name buffer)
+ ;; exclude ange-ftp buffers
+ ;;(not (string-match "\\/[^/:]+:"
+ ;; (buffer-file-name buffer)))
+ )
+ (push buffer file-buffers))
+ (t
+ (msb--choose-menu buffer
+ function-info-vector
+ max-buffer-name-length))))
(when file-buffers
(setq file-buffers
- (mapcar (function
- (lambda (buffer-list)
- (cons msb-files-by-directory-sort-key
- (cons (car buffer-list)
- (sort
- (mapcar (function
- (lambda (buffer)
- (cons (save-excursion
- (set-buffer buffer)
- (funcall msb-item-handling-function
- buffer
- max-buffer-name-length))
- buffer)))
- (cdr buffer-list))
- (function
- (lambda (item1 item2)
- (string< (car item1) (car item2)))))))))
+ (mapcar (lambda (buffer-list)
+ (cons msb-files-by-directory-sort-key
+ (cons (car buffer-list)
+ (sort
+ (mapcar (function
+ (lambda (buffer)
+ (cons (save-excursion
+ (set-buffer buffer)
+ (funcall msb-item-handling-function
+ buffer
+ max-buffer-name-length))
+ buffer)))
+ (cdr buffer-list))
+ (function
+ (lambda (item1 item2)
+ (string< (car item1) (car item2))))))))
(msb--choose-file-menu file-buffers))))
;; Now make the menu - a list of (TITLE . BUFFER-LIST)
(let* (menu
most-recently-used)
others)
others)
- (function (lambda (elt1 elt2)
- (< (car elt1) (car elt2))))))))
+ (lambda (elt1 elt2)
+ (< (car elt1) (car elt2)))))))
;; Now make it a keymap menu
(append
'(keymap "Select Buffer")
(list (cons 'toggle
(cons
(if msb-files-by-directory
- "*Files by type*"
- "*Files by directory*")
- 'msb--toggle-menu-type)))))))
+ "*Files by type*"
+ "*Files by directory*")
+ 'msb--toggle-menu-type)))))))
(defun msb--create-buffer-menu ()
(save-match-data
(save-excursion
(msb--create-buffer-menu-2))))
-;;;
-;;; Multi purpose function for selecting a buffer with the mouse.
-;;;
(defun msb--toggle-menu-type ()
+ "Multi purpose function for selecting a buffer with the mouse."
(interactive)
(setq msb-files-by-directory (not msb-files-by-directory))
- (menu-bar-update-buffers t))
+ ;; This gets a warning, but it is correct,
+ ;; because this file redefines menu-bar-update-buffers.
+ (msb-menu-bar-update-buffers t))
(defun mouse-select-buffer (event)
"Pop up several menus of buffers, for selection with the mouse.
(mouse-select-buffer event))
((and (numberp (car choice))
(null (cdr choice)))
- (let ((msb--last-buffer-menu (nthcdr 3 (assq (car choice) msb--last-buffer-menu))))
+ (let ((msb--last-buffer-menu (nthcdr 3 (assq (car choice)
+ msb--last-buffer-menu))))
(mouse-select-buffer event)))
((while (numberp (car choice))
(setq choice (cdr choice))))
choice)
(t
(error "Unknown form for buffer: %s" choice)))))
-
+
;; Add separators
(defun msb--add-separators (sorted-list)
- (cond
- ((or (not msb-separator-diff)
- (not (numberp msb-separator-diff)))
- sorted-list)
- (t
+ (if (or (not msb-separator-diff)
+ (not (numberp msb-separator-diff)))
+ sorted-list
(let ((last-key nil))
- (mapcan
- (function
- (lambda (item)
- (cond
- ((and msb-separator-diff
- last-key
- (> (- (car item) last-key)
- msb-separator-diff))
- (setq last-key (car item))
- (list (cons last-key 'separator)
- item))
- (t
- (setq last-key (car item))
- (list item)))))
- sorted-list)))))
+ (apply #'nconc
+ (mapcar
+ (lambda (item)
+ (cond
+ ((and msb-separator-diff
+ last-key
+ (> (- (car item) last-key)
+ msb-separator-diff))
+ (setq last-key (car item))
+ (list (cons last-key 'separator)
+ item))
+ (t
+ (setq last-key (car item))
+ (list item))))
+ sorted-list)))))
(defun msb--split-menus-2 (list mcount result)
(cond
(while (< count msb-max-menu-items)
(push (pop list) tmp-list)
(incf count))
- (setq tmp-list (nreverse tmp-list))
- (setq sub-name (concat (car (car tmp-list)) "..."))
- (push (nconc (list mcount sub-name
- 'keymap sub-name)
- tmp-list)
- result))
+ (setq tmp-list (nreverse tmp-list))
+ (setq sub-name (concat (car (car tmp-list)) "..."))
+ (push (nconc (list mcount sub-name
+ 'keymap sub-name)
+ tmp-list)
+ result))
(msb--split-menus-2 list (1+ mcount) result))
((null result)
list)
(t
(let (sub-name)
(setq sub-name (concat (car (car list)) "..."))
- (push (nconc (list mcount sub-name
- 'keymap sub-name)
- list)
- result))
+ (push (nconc (list mcount sub-name 'keymap sub-name)
+ list)
+ result))
(nreverse result))))
-
-(defun msb--split-menus (list)
- (msb--split-menus-2 list 0 nil))
+(defun msb--split-menus (list)
+ (if (and (integerp msb-max-menu-items)
+ (> msb-max-menu-items 0))
+ (msb--split-menus-2 list 0 nil)
+ list))
(defun msb--make-keymap-menu (raw-menu)
(let ((end (cons '(nil) 'menu-bar-select-buffer))
(mcount 0))
(mapcar
- (function
- (lambda (sub-menu)
- (cond
- ((eq 'separator sub-menu)
- (list 'separator "--"))
- (t
- (let ((buffers (mapcar (function
- (lambda (item)
- (let ((string (car item))
- (buffer (cdr item)))
- (cons (buffer-name buffer)
- (cons string end)))))
- (cdr sub-menu))))
- (nconc (list (incf mcount) (car sub-menu)
- 'keymap (car sub-menu))
- (msb--split-menus buffers)))))))
+ (lambda (sub-menu)
+ (cond
+ ((eq 'separator sub-menu)
+ (list 'separator "--"))
+ (t
+ (let ((buffers (mapcar (lambda (item)
+ (cons (buffer-name (cdr item))
+ (cons (car item) end)))
+ (cdr sub-menu))))
+ (nconc (list (incf mcount) (car sub-menu)
+ 'keymap (car sub-menu))
+ (msb--split-menus buffers))))))
raw-menu)))
-(defun menu-bar-update-buffers (&optional arg)
+(defun msb-menu-bar-update-buffers (&optional arg)
+ "A re-written version of `menu-bar-update-buffers'."
;; If user discards the Buffers item, play along.
(when (and (lookup-key (current-global-map) [menu-bar buffer])
(or (not (fboundp 'frame-or-buffer-changed-p))
(nconc
(list 'frame f-title '(nil) 'keymap f-title)
(mapcar
- (function
- (lambda (frame)
- (nconc
- (list frame
- (cdr (assq 'name
- (frame-parameters frame)))
- (cons nil nil))
- 'menu-bar-select-frame)))
+ (lambda (frame)
+ (nconc
+ (list (frame-parameter frame 'name)
+ (frame-parameter frame 'name)
+ (cons nil nil))
+ 'menu-bar-select-frame))
frames)))))
(define-key (current-global-map) [menu-bar buffer]
(cons "Buffers"
(cddr buffers-menu))
(or buffers-menu 'undefined)))))))
-(when (and (boundp 'menu-bar-update-hook)
- (not (fboundp 'frame-or-buffer-changed-p)))
- (defvar msb--buffer-count 0)
- (defun frame-or-buffer-changed-p ()
- (let ((count (length (buffer-list))))
- (when (/= count msb--buffer-count)
- (setq msb--buffer-count count)
- t))))
-
-(unless (or (not (boundp 'menu-bar-update-hook))
- (memq 'menu-bar-update-buffers menu-bar-update-hook))
- (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers))
-
-(and (fboundp 'mouse-buffer-menu)
- (substitute-key-definition 'mouse-buffer-menu 'msb (current-global-map)))
+;; Snarf current bindings of `mouse-buffer-menu' (normally
+;; C-down-mouse-1).
+(defvar msb-mode-map
+ (let ((map (make-sparse-keymap "Msb")))
+ (define-key map [remap mouse-buffer-menu] 'msb)
+ map))
+
+;;;###autoload
+(define-minor-mode msb-mode
+ "Toggle Msb mode.
+With arg, turn Msb mode on if and only if arg is positive.
+This mode overrides the binding(s) of `mouse-buffer-menu' to provide a
+different buffer menu using the function `msb'."
+ :global t :group 'msb
+ (if msb-mode
+ (progn
+ (add-hook 'menu-bar-update-hook 'msb-menu-bar-update-buffers)
+ (remove-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
+ (msb-menu-bar-update-buffers t))
+ (remove-hook 'menu-bar-update-hook 'msb-menu-bar-update-buffers)
+ (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
+ (menu-bar-update-buffers t)))
+
+(defun msb-unload-hook ()
+ (msb-mode 0))
+(add-hook 'msb-unload-hook 'msb-unload-hook)
(provide 'msb)
-(eval-after-load 'msb (run-hooks 'msb-after-load-hooks))
+(eval-after-load "msb" '(run-hooks 'msb-after-load-hook 'msb-after-load-hooks))
+;;; arch-tag: 403f9e82-b92e-4e7a-a797-5d6d9b76da36
;;; msb.el ends here