| blob | fbc130174b833c4d26d61d46a481c7045900e2cd |
1 ;;; msb.el --- customizable buffer-selection with multiple menus
3 ;; Copyright (C) 1993-1995, 1997-2015 Free Software Foundation, Inc.
5 ;; Author: Lars Lindberg <lars.lindberg@home.se>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Created: 8 Oct 1993
8 ;; Lindberg's last update version: 3.34
9 ;; Keywords: mouse buffer menu
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
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.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Purpose of this package:
29 ;; 1. Offer a function for letting the user choose buffer,
30 ;; not necessarily for switching to it.
31 ;; 2. Make a better mouse-buffer-menu. This is done as a global
32 ;; minor mode, msb-mode.
33 ;;
34 ;; Customization:
35 ;; Look at the variable `msb-menu-cond' for deciding what menus you
36 ;; want. It's not that hard to customize, despite my not-so-good
37 ;; doc-string. Feel free to send me a better doc-string.
38 ;; There are some constants for you to try here:
39 ;; msb--few-menus
40 ;; msb--very-many-menus (default)
41 ;;
42 ;; Look at the variable `msb-item-handling-function' for customization
43 ;; of the appearance of every menu item. Try for instance setting
44 ;; it to `msb-alon-item-handler'.
45 ;;
46 ;; Look at the variable `msb-item-sort-function' for customization
47 ;; of sorting the menus. Set it to t for instance, which means no
48 ;; sorting - you will get latest used buffer first.
49 ;;
50 ;; Also check out the variable `msb-display-invisible-buffers-p'.
52 ;; Known bugs:
53 ;; - Files-by-directory
54 ;; + No possibility to show client/changed buffers separately.
55 ;; + All file buffers only appear in a file sub-menu, they will
56 ;; for instance not appear in the Mail sub-menu.
58 ;; Future enhancements:
60 ;;; Thanks goes to
61 ;; Mark Brader <msb@sq.com>
62 ;; Jim Berry <m1jhb00@FRB.GOV>
63 ;; Hans Chalupsky <hans@cs.Buffalo.EDU>
64 ;; Larry Rosenberg <ljr@ictv.com>
65 ;; Will Henney <will@astroscu.unam.mx>
66 ;; Jari Aalto <jaalto@tre.tele.nokia.fi>
67 ;; Michael Kifer <kifer@sbkifer.cs.sunysb.edu>
68 ;; Gael Marziou <gael@gnlab030.grenoble.hp.com>
69 ;; Dave Gillespie <daveg@thymus.synaptics.com>
70 ;; Alon Albert <alon@milcse.rtsg.mot.com>
71 ;; Kevin Broadey, <KevinB@bartley.demon.co.uk>
72 ;; Ake Stenhof <ake@cadpoint.se>
73 ;; Richard Stallman <rms@gnu.org>
74 ;; Steve Fisk <fisk@medved.bowdoin.edu>
76 ;; This version turned into a global minor mode and subsequently
77 ;; hacked on by Dave Love.
78 ;;; Code:
82 ;;
83 ;; Some example constants to be used for `msb-menu-cond'. See that
84 ;; variable for more information. Please note that if the condition
85 ;; returns `multi', then the buffer can appear in several menus.
86 ;;
89 server-buffer-clients
91 3030
96 3090
99 2010
100 "Dired (%d)"
101 msb-dired-item-handler
102 msb-sort-by-directory)
104 4090
107 4020
114 gnus-article-mode score-mode gnus-browse-killed-mode)))
115 4010
118 4099
120 ('no-multi
121 1099
126 server-buffer-clients
128 1010
131 1020
136 1030
140 1040
145 1090
148 2010
149 "Dired (%d)"
150 ;; Note this different menu-handler
151 msb-dired-item-handler
152 ;; Also note this item-sorter
153 msb-sort-by-directory)
155 5030
158 5020
164 gnus-article-mode score-mode
165 gnus-browse-killed-mode)))
166 5010
168 ;; Catchup for all non-file buffers
171 5099
175 3090
178 3010
181 3020
184 3030
186 ('no-multi
187 3099
190 ;;;
191 ;;; Customizable variables
192 ;;;
195 "Customizable buffer-selection with multiple menus."
200 "Set the value of custom variables for msb."
203 ;; wait until package has been loaded before bothering to update
204 ;; the buffer lists.
208 "List of criteria for splitting the mouse buffer menu.
209 The elements in the list should be of this type:
210 (CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLING-FN ITEM-SORT-FN).
212 When making the split, the buffers are tested one by one against the
213 CONDITION, just like a Lisp cond: When hitting a true condition, the
214 other criteria are *not* tested and the buffer name will appear in the
215 menu with the menu-title corresponding to the true condition.
217 If the condition returns the symbol `multi', then the buffer will be
218 added to this menu *and* tested for other menus too. If it returns
219 `no-multi', then the buffer will only be added if it hasn't been added
220 to any other menu.
222 During this test, the buffer in question is the current buffer, and
223 the test is surrounded by calls to `save-excursion' and
224 `save-match-data'.
226 The categories are sorted by MENU-SORT-KEY. Smaller keys are on top.
227 A value of nil means don't display this menu.
229 MENU-TITLE is really a format. If you add %d in it, the %d is
230 replaced with the number of items in that menu.
232 ITEM-HANDLING-FN is optional. If it is supplied and is a function,
233 then it is used for displaying the items in that particular buffer
234 menu, otherwise the function pointed out by
235 `msb-item-handling-function' is used.
237 ITEM-SORT-FN is also optional.
238 If it is not supplied, the function pointed out by
239 `msb-item-sort-function' is used.
240 If it is nil, then no sort takes place and the buffers are presented
241 in least-recently-used order.
242 If it is t, then no sort takes place and the buffers are presented in
243 most-recently-used order.
244 If it is supplied and non-nil and not t than it is used for sorting
245 the items in that particular buffer menu.
247 Note1: There should always be a `catch-all' as last element, in this
248 list. That is an element like (t TITLE ITEM-HANDLING-FUNCTION).
249 Note2: A buffer menu appears only if it has at least one buffer in it.
250 Note3: If you have a CONDITION that can't be evaluated you will get an
259 "The sort key for files sorted by mode."
266 "Non-nil means use separators.
267 The separators will appear between all menus that have a sorting key
268 that differs by this value or more."
277 "The maximum number of items in a menu.
278 If this variable is set to 15 for instance, then the submenu will be
279 split up in minor parts, 15 items each. A value of nil means no limit."
285 "The maximum number of items from different directories.
287 When the menu is of type `file by directory', this is the maximum
288 number of buffers that are clumped together from different
289 directories.
291 Set this to 1 if you want one menu per directory instead of clumping
292 them together.
294 If the value is not a number, then the value 10 is used."
300 "Where should the menu with the most recently used buffers be placed?"
306 "How many buffers should be in the most-recently-used menu.
307 No buffers at all if less than 1 or nil (or any non-number)."
313 "The title for the most-recently-used menu."
322 "Show invisible buffers or not.
323 Non-nil means that the buffer menu should include buffers that have
324 names that starts with a space character."
330 "The appearance of a buffer menu.
332 The default function to call for handling the appearance of a menu
333 item. It should take two arguments, BUFFER and MAX-BUFFER-NAME-LENGTH,
334 where the latter is the max length of all buffer names.
336 The function should return the string to use in the menu.
338 When the function is called, BUFFER is the current buffer. This
339 function is called for items in the variable `msb-menu-cond' that have
340 nil as ITEM-HANDLING-FUNCTION. See `msb-menu-cond' for more
344 "The order of items in a buffer menu.
346 The default function to call for handling the order of items in a menu
347 item. This function is called like a sort function. The items look
348 like (ITEM-NAME . BUFFER).
350 ITEM-NAME is the name of the item that will appear in the menu.
351 BUFFER is the buffer, this is not necessarily the current buffer.
353 Set this to nil or t if you don't want any sorting (faster)."
361 "Non-nil means that files should be sorted by directory.
362 This is instead of the groups in `msb-menu-cond'."
371 "Hook run after the msb package has been loaded."
376 ;;;
377 ;;; Internal variables
378 ;;;
380 ;; The last calculated menu.
383 ;; If this is non-nil, then it is a string that describes the error.
386 ;;;
387 ;;; Some example function to be used for `msb-item-handling-function'.
388 ;;;
390 "Create one string item, concerning BUFFER, for the buffer menu.
391 The item looks like:
392 *% <buffer-name>
393 The `*' appears only if the buffer is marked as modified.
394 The `%' appears only if the buffer is read-only.
395 Optional second argument MAXBUF is completely ignored."
402 ;; `dired' can be called with a list of the form (directory file1 file2 ...)
403 ;; which causes `dired-directory' to be in the same form.
414 "Create one string item, concerning a dired BUFFER, for the buffer menu.
415 The item looks like:
416 *% <buffer-name>
417 The `*' appears only if the buffer is marked as modified.
418 The `%' appears only if the buffer is read-only.
419 Optional second argument MAXBUF is completely ignored."
426 "Create one string item for the buffer menu.
427 The item looks like:
428 <buffer-name> *%# <file-name>
429 The `*' appears only if the buffer is marked as modified.
430 The `%' appears only if the buffer is read-only.
431 The `#' appears only version control file (SCCS/RCS)."
439 ;;;
440 ;;; Some example function to be used for `msb-item-sort-function'.
441 ;;;
443 "Sort the items ITEM1 and ITEM2 by their `buffer-name'.
444 An item looks like (NAME . BUFFER)."
450 "Sort the items ITEM1 and ITEM2 by directory name. Made for dired.
451 An item look like (NAME . BUFFER)."
457 ;;;
458 ;;; msb
459 ;;;
460 ;;; This function can be used instead of (mouse-buffer-menu EVENT)
461 ;;; function in "mouse.el".
462 ;;;
464 "Pop up several menus of buffers for selection with the mouse.
465 This command switches buffers in the window that you clicked on, and
466 selects that window.
468 See the function `mouse-select-buffer' and the variable
469 `msb-menu-cond' for more information about how the menus are split."
473 early-release)
475 ;; This `sit-for' magically makes the menu stay up if the mouse
476 ;; button is released within 0.1 second.
482 ;; If the above `sit-for' was interrupted by a mouse-up, avoid
483 ;; generating a drag event.
486 nil)
488 ;;;
489 ;;; Some supportive functions
490 ;;;
493 If the argument is left out or nil, then the current buffer is considered."
498 "Strip one hierarchy level from the end of DIR."
501 ;; Create an alist with all buffers from LIST that lies under the same
502 ;; directory will be in the same item as the directory name.
503 ;; ((DIR1 . (BUFFER-1 BUFFER-2 ...)) (DIR2 . (BUFFER-K BUFFER-K+1...)) ...)
506 ;; Make alist that looks like
507 ;; ((DIR-1 BUFFER-1) (DIR-2 BUFFER-2) ...)
508 ;; sorted on DIR-x
517 list))
520 ;; Now clump buffers together that have the same directory name
521 ;; Make alist that looks like
522 ;; ((DIR1 . (BUFFER-1 BUFFER-2 ...)) (DIR2 . (BUFFER-K)) ...)
527 #'nconc
531 ;; The same dir as earlier:
532 ;; Add to current list of buffers.
534 ;; This item should not be added to list
535 nil)
537 ;; New dir
541 ;; Add the last result the list.
543 buffer-alist))
544 ;; Add the last result to the list
548 "Format a suitable title for the menu item."
552 ;; Variables for debugging.
557 "Choose file-menu with respect to directory for every buffer in LIST."
562 msb-max-file-menu-items
566 first rest dir buffers old-dir)
567 ;; Prepare for looping over all items in buffer-alist
573 ;; This big loop tries to clump buffers together that have a
574 ;; similar name. Remember that buffer-alist is sorted based on the
575 ;; directory name of the buffers' visited files.
579 item)
581 ;; Clump together the "rest"-buffers that have a dir that is
582 ;; a subdir of the current one.
586 ;; `completion-ignore-case' seems to default to t
587 ;; on the systems with case-insensitive file names.
590 completion-ignore-case)))
597 ;; Oh, we failed. Too many buffers clumped together.
598 ;; Just use the original ones for the result.
604 final-list)
611 ;; The first pass of clumping together worked out, go ahead
612 ;; with this result.
616 rest tmp-rest))
617 ;; Now see if we can clump more buffers together if we go up
618 ;; one step in the file hierarchy.
619 ;; If dir isn't changed by msb--strip-dir, we are looking
620 ;; at the machine name component of an ange-ftp filename.
631 completion-ignore-case)))
635 completion-ignore-case)))))
636 ;; We have reached the same place in the file hierarchy as
637 ;; the last result, so we should quit at this point and
638 ;; take what we have as result.
643 final-list)
649 ;; Now take care of the last item.
655 final-list))
660 "Create a vector from an element MENU-COND-ELT of `msb-menu-cond'.
661 This takes the form:
662 [BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER]
663 See `msb-menu-cond' for a description of its elements."
668 tmp-ih
669 msb-item-handling-function))
672 msb-item-sort-function))
676 tmp-s
677 msb-item-sort-function)))
684 tmp-s
693 item-handler ;ITEM-HANDLER
695 ))
697 ;; This defsubst is only used in `msb--choose-menu' below. It was
698 ;; pulled out merely to make the code somewhat clearer. The indentation
699 ;; level was too big.
703 function-info-list)
706 across function-info-vector
710 multi-flag))
713 t))
714 collect fi
720 function-info-list))
723 "Add BUFFER to the menu depicted by FUNCTION-INFO.
724 All side-effects. Adds an element of form (BUFFER-TITLE . BUFFER)
725 to the buffer-list variable in FUNCTION-INFO."
727 ;; Here comes the hairy side-effect!
730 buffer
731 max-buffer-name-length)
732 buffer)
736 "Select the appropriate menu for BUFFER."
737 ;; This is all side-effects, folks!
738 ;; This should be optimized.
743 ;; Menu found. Add to this menu
749 "In msb-menu-cond, error for buffer `%s'."
754 "Return (SORT-KEY TITLE . BUFFER-LIST) or nil if the buffer-list is empty."
765 buffer-list)
772 "Return ALIST as a sorted, aggregated alist.
774 In the result all items with the same car element (according to
775 SAME-PREDICATE) are aggregated together. The alist is first sorted by
776 SORT-PREDICATE.
778 Example:
779 \(msb--aggregate-alist
781 (function string=)
782 (lambda (item1 item2)
783 (string< (symbol-name item1) (symbol-name item2))))
784 results in
785 \((a a1 a2 a4 a3) (b b1 b3 b2) (c c3))"
788 tmp-old-car
789 tmp-same
791 old-car)
801 nil)
804 nil)
807 tmp-old-car old-car)
822 key
832 mode-list))))
833 mode-list)
838 "Return a list for the most recently used buffers.
839 It takes the form ((TITLE . BUFFER-LIST)...)."
845 for buffer in buffers
851 buffer
852 max-buffer-name-length)
853 buffer))
860 most-recently-used))))
864 file-buffers
865 function-info-vector)
866 ;; Calculate the longest buffer name.
872 ;; Make a list with elements of type
873 ;; (BUFFER-LIST-VARIABLE
874 ;; CONDITION
875 ;; MENU-SORT-KEY
876 ;; MENU-TITLE
877 ;; ITEM-HANDLER
878 ;; SORTER)
879 ;; Uses "function-global" variables:
880 ;; function-info-vector
885 ;; Split the buffer-list into several lists; one list for each
886 ;; criteria. This is the most critical part with respect to time.
890 ;; exclude ange-ftp buffers
891 ;;(not (string-match "\\/[^/:]+:"
892 ;; (buffer-file-name buffer)))
893 )
897 function-info-vector
898 max-buffer-name-length))))
902 `(,msb-files-by-directory-sort-key
908 msb-item-handling-function
909 buffer
910 max-buffer-name-length))
911 buffer))
916 ;; Now make the menu - a list of (TITLE . BUFFER-LIST)
922 across function-info-vector
924 if value collect value))))
927 ;; Sort the menus - not the items.
930 ;; Get a list of (SORT-KEY TITLE . BUFFER-LIST)
931 ;; Also sorts the items within the menus.
934 ;; Add most recent used buffers
936 most-recently-used)
937 others)
938 others)
941 ;; Now make it a keymap menu
950 "*Files by type*"
960 "Multi-purpose function for selecting a buffer with the mouse."
963 ;; This gets a warning, but it is correct,
964 ;; because this file redefines menu-bar-update-buffers.
968 "Pop up several menus of buffers, for selection with the mouse.
969 Returns the selected buffer or nil if no buffer is selected.
971 The way the buffers are split is conveniently handled with the
972 variable `msb-menu-cond'."
973 ;; Popup the menu and return the selected buffer.
981 choice)
987 ;; adjust position
990 ;; Popup the menu
994 ;; Bring up the menu again with type toggled.
1000 msb--last-buffer-menu))))
1008 choice)
1012 ;; Add separators
1016 sorted-list
1023 last-key
1025 msb-separator-diff))
1028 item))
1032 sorted-list)))))
1038 sub-name
1047 tmp-list)
1048 result))
1051 list)
1056 list)
1057 result))
1064 list))
1082 raw-menu)))
1085 "A re-written version of `menu-bar-update-buffers'."
1086 ;; If user discards the Buffers item, play along.
1090 arg))
1092 buffers-menu frames-menu)
1093 ;; Make the menu of buffers proper.
1095 ;; Skip the `keymap' symbol.
1097 ;; Make a Frames menu if we have more than one frame.
1101 ;; List only the N most recently selected frames
1116 frames)))))
1119 ;; Combine Frame and Buffers menus with separator between
1123 buffers-menu)))))
1125 ;; Snarf current bindings of `mouse-buffer-menu' (normally
1126 ;; C-down-mouse-1).
1130 map))
1132 ;;;###autoload
1134 "Toggle Msb mode.
1135 With a prefix argument ARG, enable Msb mode if ARG is positive,
1136 and disable it otherwise. If called from Lisp, enable the mode
1137 if ARG is omitted or nil.
1139 This mode overrides the binding(s) of `mouse-buffer-menu' to provide a
1140 different buffer menu using the function `msb'."
1152 "Unload the Msb library."
1154 ;; continue standard unloading
1155 nil)
1160 ;;; msb.el ends here