| blob | 494bc426188d663b73a2d0b4884bff13a2ff5476 |
1 ;;; bs.el --- menu for selecting and displaying buffers -*- lexical-binding: t -*-
3 ;; Copyright (C) 1998-2021 Free Software Foundation, Inc.
4 ;; Author: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
5 ;; Maintainer: emacs-devel@gnu.org
6 ;; Keywords: convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Version: 1.17
26 ;; X-URL: http://www.geekware.de/software/emacs
27 ;;
28 ;; The bs-package contains a main function bs-show for popping up a
29 ;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
30 ;; The new buffer offers a Buffer Selection Menu for manipulating
31 ;; the buffer list and buffers.
32 ;;
33 ;; -----------------------------------------------------------------------
34 ;; | MR Buffer Size Mode File |
35 ;; | -- ------ ---- ---- ---- |
36 ;; |. bs.el 14690 Emacs-Lisp /home/sun/sylvester/el/bs.e$|
37 ;; | % executable.el 9429 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
38 ;; | % vc.el 104893 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
39 ;; | % test_vc.el 486 Emacs-Lisp /home/sun/sylvester/el/test$|
40 ;; | % vc-hooks.el 43605 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
41 ;; -----------------------------------------------------------------------
43 ;;; Quick Installation and Customization:
45 ;; To display the bs menu, do
46 ;; M-x bs-show
47 ;; To customize its behavior, do
48 ;; M-x bs-customize
50 ;;; More Commentary:
52 ;; bs-show will generate a new buffer named *buffer-selection*, which shows
53 ;; all buffers or a subset of them, and has possibilities for deleting,
54 ;; saving and selecting buffers. For more details see docstring of
55 ;; function `bs-mode'. A current configuration describes which buffers appear
56 ;; in *buffer-selection*. See docstring of variable `bs-configurations' for
57 ;; more details.
58 ;;
59 ;; The package bs combines the advantages of the Emacs functions
60 ;; `list-buffers' and `electric-buffer-list'.
61 ;;
62 ;; Additional features for Buffer Selection Menu:
63 ;; - configurable list of buffers (show only files etc.).
64 ;; - comfortable way to change displayed subset of all buffers.
65 ;; - show sorted list of buffers.
66 ;; - cyclic navigation:
67 ;; - goes to top of buffer list if you are on last line and press down.
68 ;; - goes to end of buffer list if you are on first line and press up.
69 ;; - Offer an alternative buffer list by prefix key C-u.
71 ;;; Cycling through buffers
73 ;; This package offers two functions for buffer cycling. If you want to cycle
74 ;; through buffer list you can use `bs-cycle-next' or `bs-cycle-previous'.
75 ;; Bind these function to a key like
76 ;; (global-set-key [(f9)] 'bs-cycle-previous)
77 ;; (global-set-key [(f10)] 'bs-cycle-next)
78 ;;
79 ;; Both functions use a special subset of all buffers for cycling to avoid
80 ;; to go through internal buffers like *Messages*.
81 ;;
82 ;; Cycling through buffers ignores sorting because sorting destroys
83 ;; the logical buffer list. If buffer list is sorted by size you
84 ;; won't be able to cycle to the smallest buffer.
86 ;;; Customization:
88 ;; There is a customization group called `bs' in group `convenience'.
89 ;; Start customization by M-x bs-customize
90 ;;
91 ;; Buffer list
92 ;; -----------
93 ;; You can define your own configurations by extending variable
94 ;; `bs-configurations' (see docstring for details).
95 ;;
96 ;; `bs-default-configuration' contains the name of default configuration.
97 ;; The default value is "files" which means to show only files.
98 ;;
99 ;; If you always want to see all buffers, customize variable
100 ;; `bs-default-configuration' in customization group `bs'.
101 ;;
102 ;; Configure sorting
103 ;; -----------------
104 ;; You can define functions for sorting the buffer list.
105 ;; When selecting buffers, you can step through available sorting
106 ;; methods with key 'S'.
107 ;; To define a new way of sorting, customize variable `bs-sort-functions'.
108 ;;
109 ;; There are four basic functions for sorting:
110 ;; by buffer name, by mode, by size, or by filename
111 ;;
112 ;; Configure buffer cycling
113 ;; ------------------------
114 ;; When cycling through buffer list the functions for cycling will use
115 ;; the current configuration of bs to calculate the buffer list.
116 ;; If you want to use a different configuration for cycling you have to set
117 ;; the variable `bs-cycle-configuration-name'. You can customize this variable.
118 ;;
119 ;; For example: If you use the configuration called "files-and-scratch" you
120 ;; can cycle through all file buffers and *scratch* although your current
121 ;; configuration perhaps is "files" which ignores buffer *scratch*.
123 ;;; Code:
125 ;; ----------------------------------------------------------------------
126 ;; Globals for customization
127 ;; ----------------------------------------------------------------------
130 "Buffer Selection: Maintaining buffers by buffer menu."
137 "Buffer Selection appearance: Appearance of bs buffer menu."
152 "List specifying the layout of a Buffer Selection Menu buffer.
153 Each entry specifies a column and is a list of the form of:
154 \(HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING)
156 HEADER : String for header for first line or a function
157 which calculates column title.
158 MINIMUM-LENGTH : Minimum width of column (number or name of function).
159 The function must return a positive integer.
160 MAXIMUM-LENGTH : Maximum width of column (number or name of function)
161 (currently ignored).
162 ALIGNMENT : Alignment of column (`left', `right', `middle').
163 FUN-OR-STRING : Name of a function for calculating the value or a
164 string for a constant value.
166 The function gets as parameter the buffer where we have started
167 buffer selection and the list of all buffers to show. The function must
168 return a string representing the column's value."
173 "Return a regexp matching the first line of a Buffer Selection Menu buffer."
178 bs-attributes-list))
181 ;; Font-Lock-Settings
186 ;; Buffername embedded by *
188 ;; Dired-Buffers
190 ;; the star for modified buffers
195 "Maximal window height of Buffer Selection Menu."
200 "Regular expression specifying which buffers not to show.
201 A buffer whose name matches this regular expression will not be
205 "Regular expression for specifying buffers which must be shown.
206 A buffer whose name matches this regular expression will be
207 included in the buffer list.
208 Note that this variable is temporary: if the configuration is changed
209 it is reset to nil. Use `bs-must-always-show-regexp' to specify buffers
213 "Regular expression for specifying buffers to show always.
214 A buffer whose name matches this regular expression will
215 be shown regardless of current configuration of Buffer Selection Menu."
220 "Function for specifying buffers not to show.
221 The function gets one argument - the buffer to test. The function must
222 return a value different from nil to ignore the buffer in
226 "Function for specifying buffers which must be shown.
230 "Sort function to sort the buffers that appear in Buffer Selection Menu.
231 The function gets two arguments - the buffers to compare.
235 "Maximum column width for buffer names.
236 The column for buffer names has dynamic width. The width depends on
237 maximal and minimal length of names of buffers to show. The maximal
238 width is bounded by `bs-maximal-buffer-name-column'.
239 See also `bs-minimal-buffer-name-column'."
244 "Minimum column width for buffer names.
245 The column for buffer names has dynamic width. The width depends on
246 maximal and minimal length of names of buffers to show. The minimal
247 width is bounded by `bs-minimal-buffer-name-column'.
248 See also `bs-maximal-buffer-name-column'."
259 bs-sort-buffer-interns-are-last)
261 "List of all configurations you can use in the Buffer Selection Menu.
262 A configuration describes which buffers appear in Buffer Selection Menu
263 and also the order of buffers. A configuration is a list with
264 six elements. The first element is a string and describes the configuration.
265 The following five elements represent the values for Buffer Selection Menu
266 configuration variables `bs-must-show-regexp', `bs-must-show-function',
267 `bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'.
268 By setting these variables you define a configuration."
273 "Name of default configuration used by the Buffer Selection Menu.
276 Must be a string used in `bs-configurations' for naming a configuration."
281 "Name of configuration used when calling `bs-show' with \
283 Must be a string used in `bs-configurations' for naming a configuration."
288 "Name of current configuration.
292 "Name of configuration used when cycling through the buffer list.
293 A value of nil means to use current configuration `bs-default-configuration'.
294 Must be a string used in `bs-configurations' for naming a configuration."
297 string))
300 "String added in column 1 indicating a buffer will always be shown."
305 "String added in column 1 indicating a buffer will never be shown."
310 "String added in column 1 indicating the current buffer."
315 "String added in column 1 indicating the current buffer when it is marked."
320 "String added in column 1 indicating a marked buffer."
325 "String added in column 1 indicating an unmarked buffer."
330 "Maximum length of all displayed buffer names.
333 ;; ----------------------------------------------------------------------
334 ;; Internal globals
335 ;; ----------------------------------------------------------------------
338 "Flag for the current mode for showing this buffer.
339 A value of nil means buffer will be shown depending on the current
340 configuration.
341 A value of `never' means to never show the buffer.
345 "Compare buffers B1 and B2 by buffer name."
350 "Compare buffers B1 and B2 by file name."
355 "Compare buffers B1 and B2 by mode name."
361 "Compare buffers B1 and B2 by buffer size."
370 "List of all possible sorting aspects for Buffer Selection Menu.
371 You can add a new entry with a call to `bs-define-sort-function'.
372 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE).
373 NAME specifies the sort order defined by function FUNCTION.
374 FUNCTION nil means don't sort the buffer list. Otherwise the function
375 must have two parameters - the buffers to compare.
376 REGEXP-FOR-SORTING is a regular expression which describes the
377 column title to highlight.
378 FACE is a face used to fontify the sorted column title. A value of nil means
379 don't highlight."
384 "Define a new function for buffer sorting in Buffer Selection Menu.
385 NAME specifies the sort order defined by function FUN.
386 A value of nil for FUN means don't sort the buffer list. Otherwise the
387 functions must have two parameters - the buffers to compare.
388 REGEXP-FOR-SORTING is a regular expression which describes the
389 column title to highlight.
390 FACE is a face used to fontify the sorted column title. A value of nil means
391 don't highlight.
392 The new sort aspect will be inserted into list `bs-sort-functions'."
398 bs-sort-functions)))))
401 "Description of the current function for sorting the buffer list.
405 "Name of default sort behavior.
419 "Flag whether showing all buffers regardless of current configuration.
420 Non-nil means to show all buffers. Otherwise show buffers
427 "Regular expression specifying which buffers never to show.
428 A buffer whose name matches this regular expression will never be
432 "List of buffers shown in Buffer Selection Menu.
456 (define-key map "n" 'bs-down)
457 (define-key map "p" 'bs-up)
458 (define-key map [down] 'bs-down)
459 (define-key map "\C-m" 'bs-select)
460 (define-key map "b" 'bs-bury-buffer)
461 (define-key map "s" 'bs-save)
462 (define-key map "S" 'bs-show-sorted)
463 (define-key map "a" 'bs-toggle-show-all)
464 (define-key map "d" 'bs-delete)
465 (define-key map "\C-d" 'bs-delete-backward)
466 (define-key map "k" 'bs-delete)
467 (define-key map "g" 'bs-refresh)
468 (define-key map "C" 'bs-set-configuration-and-refresh)
469 (define-key map "c" 'bs-select-next-configuration)
470 (define-key map "q" 'bs-kill)
471 ;; (define-key map "z" 'bs-kill)
472 (define-key map "\C-c\C-c" 'bs-kill)
473 (define-key map "\C-g" 'bs-abort)
474 (define-key map "\C-]" 'bs-abort)
475 (define-key map "%" 'bs-toggle-readonly)
476 (define-key map "~" 'bs-clear-modified)
477 (define-key map "M" 'bs-toggle-current-to-show)
478 (define-key map "+" 'bs-set-current-buffer-to-show-always)
479 ;;(define-key map "-" 'bs-set-current-buffer-to-show-never)
480 (define-key map "t" 'bs-visit-tags-table)
481 (define-key map "m" 'bs-mark-current)
482 (define-key map "u" 'bs-unmark-current)
483 (define-key map "U" 'bs-unmark-all)
485 (define-key map ">" 'scroll-right)
486 (define-key map "<" 'scroll-left)
487 (define-key map "?" 'bs-help)
488 map)
489 "Keymap of `bs-mode'.")
491 ;; ----------------------------------------------------------------------
492 ;; Functions
493 ;; ----------------------------------------------------------------------
495 (defun bs-buffer-list (&optional list sort-description)
496 "Return a list of buffers to be shown.
497 LIST is a list of buffers to test for appearance in Buffer Selection Menu.
498 The result list depends on the global variables `bs-dont-show-regexp',
499 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
500 and `bs-buffer-sort-function'.
501 If SORT-DESCRIPTION isn't nil the list will be sorted by
502 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
503 (setq sort-description (or sort-description bs--current-sort-function)
504 list (or list (buffer-list)))
505 (let ((result nil))
506 (dolist (buf list)
507 (let* ((buffername (buffer-name buf))
508 (int-show-never (string-match-p bs--intern-show-never buffername))
509 (ext-show-never (and bs-dont-show-regexp
510 (string-match-p bs-dont-show-regexp
511 buffername)))
512 (extern-must-show (or (and bs-must-always-show-regexp
513 (string-match-p
514 bs-must-always-show-regexp
515 buffername))
516 (and bs-must-show-regexp
517 (string-match-p bs-must-show-regexp
518 buffername))))
519 (extern-show-never-from-fun (and bs-dont-show-function
520 (funcall bs-dont-show-function
521 buf)))
522 (extern-must-show-from-fun (and bs-must-show-function
523 (funcall bs-must-show-function
524 buf)))
525 (show-flag (buffer-local-value 'bs-buffer-show-mark buf)))
526 (when (or (eq show-flag 'always)
527 (and (or bs--show-all (not (eq show-flag 'never)))
528 (not int-show-never)
529 (or bs--show-all
530 extern-must-show
531 extern-must-show-from-fun
532 (and (not ext-show-never)
533 (not extern-show-never-from-fun)))))
534 (setq result (cons buf result)))))
535 (setq result (reverse result))
536 ;; The current buffer which was the start point of bs should be an element
537 ;; of result list, so that we can leave with space and be back in the
538 ;; buffer we started bs-show.
539 (when (and bs--buffer-coming-from
540 (buffer-live-p bs--buffer-coming-from)
541 (not (memq bs--buffer-coming-from result)))
542 (setq result (cons bs--buffer-coming-from result)))
543 ;; sorting
544 (if (and sort-description
545 (nth 1 sort-description))
546 (setq result (sort result (nth 1 sort-description)))
547 ;; else standard sorting
548 (bs-buffer-sort result))))
550 (defun bs-buffer-sort (buffer-list)
551 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
552 (if bs-buffer-sort-function
553 (sort buffer-list bs-buffer-sort-function)
554 buffer-list))
556 (defun bs--redisplay (&optional keep-line-p sort-description)
557 "Redisplay whole Buffer Selection Menu.
558 If KEEP-LINE-P is non-nil the point will stay on current line.
559 SORT-DESCRIPTION is an element of `bs-sort-functions'."
560 (let ((line (count-lines 1 (point))))
561 (bs-show-in-buffer (bs-buffer-list nil sort-description))
562 (when keep-line-p
563 (goto-char (point-min))
564 (forward-line line))
565 (beginning-of-line)))
567 (defun bs--goto-current-buffer ()
568 "Goto line which represents the current buffer;
569 actually the line which begins with character in `bs-string-current' or
570 `bs-string-current-marked'."
571 (let ((regexp (concat "^"
572 (regexp-quote bs-string-current)
574 (regexp-quote bs-string-current-marked)))
575 point)
576 (save-excursion
577 (goto-char (point-min))
578 (when (search-forward-regexp regexp nil t)
579 (setq point (1- (point)))))
580 (when point
581 (goto-char point))))
583 (defun bs--current-config-message ()
584 "Return a string describing the current `bs-mode' configuration."
585 (if bs--show-all
586 "Show all buffers."
587 (format "Show buffer by configuration %S"
588 bs-current-configuration)))
590 (defun bs--track-window-changes (frame)
591 "Track window changes to refresh the buffer list.
592 Used from `window-size-change-functions'."
593 (let ((win (get-buffer-window "*buffer-selection*" frame)))
594 (when win
595 (with-selected-window win
596 (bs--set-window-height)))))
598 (defun bs--remove-hooks ()
599 "Remove `bs--track-window-changes' and auxiliary hooks."
600 (remove-hook 'window-size-change-functions 'bs--track-window-changes)
601 ;; Remove itself
602 (remove-hook 'kill-buffer-hook 'bs--remove-hooks t)
603 (remove-hook 'change-major-mode-hook 'bs--remove-hooks t))
605 (put 'bs-mode 'mode-class 'special)
607 (define-derived-mode bs-mode nil "Buffer-Selection-Menu"
608 "Major mode for editing a subset of Emacs's buffers.
610 Aside from two header lines each line describes one buffer.
611 Move to a line representing the buffer you want to edit and select
613 There are many key commands similar to `Buffer-menu-mode' for
614 manipulating the buffer list and buffers.
615 For faster navigation each digit key is a digit argument.
619 window, and delete other
620 windows in the same frame.
623 other window, and remain in
624 Buffer Selection Menu.
643 to show always.
648 configuration.
650 apply it.
656 (buffer-disable-undo)
657 (setq buffer-read-only t
658 truncate-lines t
659 show-trailing-whitespace nil)
660 (setq-local font-lock-defaults '(bs-mode-font-lock-keywords t))
661 (setq-local font-lock-verbose nil)
662 (setq-local font-lock-global-modes '(not bs-mode))
663 (setq-local revert-buffer-function 'bs-refresh)
664 (add-hook 'window-size-change-functions 'bs--track-window-changes)
665 (add-hook 'kill-buffer-hook 'bs--remove-hooks nil t)
666 (add-hook 'change-major-mode-hook 'bs--remove-hooks nil t))
668 (defun bs--restore-window-config ()
669 "Restore window configuration on the current frame."
670 (when bs--window-config-coming-from
671 (let ((frame (selected-frame)))
672 (unwind-protect
673 (set-window-configuration bs--window-config-coming-from)
674 (select-frame frame)))
675 (setq bs--window-config-coming-from nil)))
677 (defun bs-kill ()
678 "Let buffer disappear and reset window configuration."
679 (interactive)
680 (bury-buffer (current-buffer))
681 (bs--restore-window-config))
683 (defun bs-abort ()
684 "Ding and leave Buffer Selection Menu without a selection."
685 (interactive)
686 (ding)
687 (bs-kill))
689 (defun bs-set-configuration-and-refresh ()
690 "Ask user for a configuration and apply selected configuration.
691 Refresh whole Buffer Selection Menu."
692 (interactive)
693 (call-interactively 'bs-set-configuration)
694 (bs--redisplay t))
696 (defun bs-refresh (&rest _ignored)
697 "Refresh whole Buffer Selection Menu.
698 Arguments are IGNORED (for `revert-buffer')."
699 (interactive)
700 (bs--redisplay t))
702 (defun bs--set-window-height ()
703 "Change the height of the selected window to suit the current buffer list."
704 (unless (one-window-p t)
705 (fit-window-to-buffer (selected-window) bs-max-window-height)))
707 (defun bs--current-buffer ()
708 "Return buffer on current line.
709 Raise an error if not on a buffer line."
710 (beginning-of-line)
711 (let ((line (+ (- bs-header-lines-length)
712 (count-lines 1 (point)))))
713 (when (< line 0)
714 (error "You are on a header row"))
715 (nth line bs-current-list)))
717 (defun bs--update-current-line ()
718 "Update the entry on current line for Buffer Selection Menu."
719 (let ((buffer (bs--current-buffer))
720 (inhibit-read-only t))
721 (beginning-of-line)
722 (delete-region (point) (line-end-position))
723 (bs--insert-one-entry buffer)
724 (beginning-of-line)))
726 (defun bs-view ()
727 "View current line's buffer in View mode.
728 Leave Buffer Selection Menu."
729 (interactive)
730 (view-buffer (bs--current-buffer)))
732 (defun bs-select ()
733 "Select current line's buffer and other marked buffers.
734 If there are no marked buffers the window configuration before starting
735 Buffer Selection Menu will be restored.
736 If there are marked buffers each marked buffer and the current line's buffer
737 will be selected in a window.
738 Leave Buffer Selection Menu."
739 (interactive)
740 (let ((buffer (bs--current-buffer)))
741 (bury-buffer (current-buffer))
742 (bs--restore-window-config)
743 (switch-to-buffer buffer)
744 (when bs--marked-buffers
745 ;; Some marked buffers for selection
746 (let* ((all (delq buffer bs--marked-buffers))
747 (height (/ (1- (frame-height)) (1+ (length all)))))
748 (delete-other-windows)
749 (switch-to-buffer buffer)
750 (dolist (buf all)
751 (split-window nil height)
752 (other-window 1)
753 (switch-to-buffer buf))
754 ;; goto window we have started bs.
755 (other-window 1)))))
757 (defun bs-select-other-window ()
758 "Select current line's buffer by `switch-to-buffer-other-window'.
759 The window configuration before starting Buffer Selection Menu will be restored
760 unless there is no other window. In this case a new window will be created.
761 Leave Buffer Selection Menu."
762 (interactive)
763 (let ((buffer (bs--current-buffer)))
764 (bury-buffer (current-buffer))
765 (bs--restore-window-config)
766 (switch-to-buffer-other-window buffer)))
768 (defun bs-tmp-select-other-window ()
769 "Make the other window select this line's buffer.
770 The current window remains selected."
771 (interactive)
772 (let ((buffer (bs--current-buffer)))
773 (display-buffer buffer t)))
775 (defun bs-select-other-frame ()
776 "Select current line's buffer in new created frame.
777 Leave Buffer Selection Menu."
778 (interactive)
779 (let ((buffer (bs--current-buffer)))
780 (bury-buffer (current-buffer))
781 (bs--restore-window-config)
782 (switch-to-buffer-other-frame buffer)))
784 (defun bs-mouse-select-other-frame (event)
785 "Select selected line's buffer in new created frame.
786 Leave Buffer Selection Menu.
787 EVENT: a mouse click event."
788 (interactive "e")
789 (mouse-set-point event)
790 (bs-select-other-frame))
792 (defun bs-mouse-select (event)
793 "Select buffer on mouse click EVENT.
794 Select buffer by `bs-select'."
795 (interactive "e")
796 (mouse-set-point event)
797 (bs-select))
799 (defun bs-select-in-one-window ()
800 "Select current line's buffer in one window and delete other windows.
801 Leave Buffer Selection Menu."
802 (interactive)
803 (bs-select)
804 (delete-other-windows))
806 (defun bs-bury-buffer ()
807 "Bury buffer on current line."
808 (interactive)
809 (bury-buffer (bs--current-buffer))
810 (bs--redisplay t))
812 (defun bs-save ()
813 "Save buffer on current line."
814 (interactive)
815 (with-current-buffer (bs--current-buffer)
816 (save-buffer))
817 (bs--update-current-line))
819 (defun bs-visit-tags-table ()
820 "Visit the tags table in the buffer on this line.
821 See `visit-tags-table'."
822 (interactive)
823 (let ((file (buffer-file-name (bs--current-buffer))))
824 (if file
825 (visit-tags-table file)
826 (error "Specified buffer has no file"))))
828 (defun bs-toggle-current-to-show ()
829 "Toggle status of showing flag for buffer in current line."
830 (interactive)
831 (let ((res
832 (with-current-buffer (bs--current-buffer)
833 (setq bs-buffer-show-mark (pcase bs-buffer-show-mark
834 ('nil 'never)
835 ('never 'always)
836 (_ nil))))))
837 (bs--update-current-line)
838 (bs--set-window-height)
839 (bs--show-config-message res)))
841 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
842 "Toggle status of buffer on line to `always shown'.
843 NOT-TO-SHOW-P: prefix argument.
844 With no prefix argument the buffer on current line is marked to show
845 always. Otherwise it is marked to show never."
846 (interactive "P")
847 (if not-to-show-p
848 (bs-set-current-buffer-to-show-never)
849 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
851 (defun bs-set-current-buffer-to-show-never ()
852 "Toggle status of buffer on line to `never shown'."
853 (interactive)
854 (bs--set-toggle-to-show (bs--current-buffer) 'never))
856 (defun bs--set-toggle-to-show (buffer what)
857 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
858 Redisplay current line and display a message describing
859 the status of buffer on current line."
860 (with-current-buffer buffer (setq bs-buffer-show-mark what))
861 (bs--update-current-line)
862 (bs--set-window-height)
863 (bs--show-config-message what))
865 (defun bs--mark-unmark (count fun)
866 "Call FUN on COUNT consecutive buffers of *buffer-selection*."
867 (let ((dir (if (> count 0) 1 -1)))
868 (dotimes (_i (abs count))
869 (let ((buffer (bs--current-buffer)))
870 (when buffer (funcall fun buffer))
871 (bs--update-current-line)
872 (bs-down dir)))))
874 (defun bs-mark-current (count)
875 "Mark buffers.
876 COUNT is the number of buffers to mark.
877 Move point vertically down COUNT lines."
878 (interactive "p")
879 (bs--mark-unmark count
880 (lambda (buf)
881 (add-to-list 'bs--marked-buffers buf))))
883 (defun bs-unmark-current (count)
884 "Unmark buffers.
885 COUNT is the number of buffers to unmark.
886 Move point vertically down COUNT lines."
887 (interactive "p")
888 (bs--mark-unmark count
889 (lambda (buf)
890 (setq bs--marked-buffers (delq buf bs--marked-buffers)))))
892 (defun bs-unmark-previous (count)
893 "Unmark previous COUNT buffers.
894 Move point vertically up COUNT lines.
895 When called interactively a numeric prefix argument sets COUNT."
896 (interactive "p")
897 (forward-line (- count))
898 (save-excursion (bs-unmark-current count)))
900 (defun bs-unmark-all ()
901 "Unmark all buffers."
902 (interactive)
903 (let ((marked (string-to-char bs-string-marked))
904 (current (string-to-char bs-string-current))
905 (marked-cur (string-to-char bs-string-current-marked))
906 (unmarked (string-to-char bs-string-show-normally))
907 (inhibit-read-only t))
908 (save-excursion
909 (goto-char (point-min))
910 (forward-line 2)
911 (while (not (eobp))
912 (if (eq (char-after) marked)
913 (subst-char-in-region (point) (1+ (point)) marked unmarked)
914 (when (eq (char-after) marked-cur)
915 (subst-char-in-region (point) (1+ (point)) marked-cur current)))
916 (forward-line 1))
917 (setq bs--marked-buffers nil))))
919 (defun bs--show-config-message (what)
920 "Show message indicating the new showing status WHAT.
921 WHAT is a value of nil, `never', or `always'."
922 (bs-message-without-log (cond ((null what)
923 "Buffer will be shown normally.")
924 ((eq what 'never)
925 "Mark buffer to never be shown.")
926 (t "Mark buffer to show always."))))
928 (defun bs-delete ()
929 "Kill buffer on current line."
930 (interactive)
931 (let ((current (bs--current-buffer))
932 (inhibit-read-only t))
933 (unless (kill-buffer current)
934 (error "Buffer was not deleted"))
935 (setq bs-current-list (delq current bs-current-list))
936 (beginning-of-line)
937 (delete-region (point) (save-excursion
938 (end-of-line)
939 (if (eobp) (point) (1+ (point)))))
940 (when (eobp)
941 (backward-delete-char 1)
942 (beginning-of-line)
943 (recenter -1))
944 (bs--set-window-height)))
946 (defun bs-delete-backward ()
947 "Like `bs-delete' but go to buffer in front of current."
948 (interactive)
949 (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
950 (bs-delete)
951 (unless on-last-line-p
952 (bs-up 1))))
954 (defun bs-show-sorted ()
955 "Show buffer list sorted by next sort aspect."
956 (interactive)
957 (setq bs--current-sort-function
958 (bs-next-config-aux (car bs--current-sort-function)
959 bs-sort-functions))
960 (bs--redisplay)
961 (bs--goto-current-buffer)
962 (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))
964 (defun bs-apply-sort-faces (&optional sort-description)
965 "Set text properties for the sort described by SORT-DESCRIPTION.
966 SORT-DESCRIPTION is an element of `bs-sort-functions'.
967 Default is `bs--current-sort-function'."
968 (let ((sort-description (or sort-description
969 bs--current-sort-function)))
970 (save-excursion
971 (goto-char (point-min))
972 (when (and (nth 2 sort-description)
973 (search-forward-regexp (nth 2 sort-description) nil t))
974 (let ((inhibit-read-only t))
975 (put-text-property (match-beginning 0)
976 (match-end 0)
977 'face
978 (or (nth 3 sort-description)
979 'region)))))))
981 (defun bs-toggle-show-all ()
982 "Toggle show all buffers / show buffers with current configuration."
983 (interactive)
984 (setq bs--show-all (not bs--show-all))
985 (bs--redisplay)
986 (bs--goto-current-buffer)
987 (bs-message-without-log "%s" (bs--current-config-message)))
989 (defun bs-toggle-readonly ()
990 "Toggle read-only status for buffer on current line.
991 Uses function `read-only-mode'."
992 (interactive)
993 (with-current-buffer (bs--current-buffer)
994 (read-only-mode 'toggle))
995 (bs--update-current-line))
997 (defun bs-clear-modified ()
998 "Set modified flag for buffer on current line to nil."
999 (interactive)
1000 (with-current-buffer (bs--current-buffer)
1001 (set-buffer-modified-p nil))
1002 (bs--update-current-line))
1004 (defun bs--nth-wrapper (count fun &rest args)
1005 "Call COUNT times function FUN with arguments ARGS."
1006 (dotimes (_i (or count 1))
1007 (apply fun args)))
1009 (defun bs-up (arg)
1010 "Move point vertically up ARG lines in Buffer Selection Menu."
1011 (interactive "p")
1012 (if (and arg (numberp arg) (< arg 0))
1013 (bs--nth-wrapper (- arg) 'bs--down)
1014 (bs--nth-wrapper arg 'bs--up)))
1016 (defun bs--up ()
1017 "Move point vertically up one line.
1018 If on top of buffer list go to last line."
1019 (if (> (count-lines 1 (point)) bs-header-lines-length)
1020 (forward-line -1)
1021 (goto-char (point-max))
1022 (beginning-of-line)
1023 (recenter -1)))
1025 (defun bs-down (arg)
1026 "Move point vertically down ARG lines in Buffer Selection Menu."
1027 (interactive "p")
1028 (if (and arg (numberp arg) (< arg 0))
1029 (bs--nth-wrapper (- arg) 'bs--up)
1030 (bs--nth-wrapper arg 'bs--down)))
1032 (defun bs--down ()
1033 "Move point vertically down one line.
1034 If at end of buffer list go to first line."
1035 (if (eq (line-end-position) (point-max))
1036 (progn
1037 (goto-char (point-min))
1038 (forward-line bs-header-lines-length))
1039 (forward-line 1)))
1041 (defun bs-visits-non-file (buffer)
1042 "Return whether BUFFER visits no file.
1043 A value of t means BUFFER belongs to no file.
1044 A value of nil means BUFFER belongs to a file."
1045 (not (buffer-file-name buffer)))
1047 (defun bs-sort-buffer-interns-are-last (_b1 b2)
1048 "Function for sorting internal buffers at the end of all buffers."
1051 ;; ----------------------------------------------------------------------
1052 ;; Configurations:
1053 ;; ----------------------------------------------------------------------
1055 (defun bs-config-clear ()
1056 "Reset all variables which specify a configuration.
1057 These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
1058 `bs-dont-show-function', `bs-must-show-function' and
1059 `bs-buffer-sort-function'."
1060 (setq bs-dont-show-regexp nil
1061 bs-must-show-regexp nil
1062 bs-dont-show-function nil
1063 bs-must-show-function nil
1064 bs-buffer-sort-function nil))
1066 (defun bs-config--only-files ()
1067 "Define a configuration for showing only buffers visiting a file."
1068 (bs-config-clear)
1069 (setq ;; I want to see *-buffers at the end
1070 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1071 ;; Don't show files who don't belong to a file
1072 bs-dont-show-function 'bs-visits-non-file))
1074 (defun bs-config--files-and-scratch ()
1075 "Define a configuration for showing buffer *scratch* and file buffers."
1076 (bs-config-clear)
1077 (setq ;; I want to see *-buffers at the end
1078 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1079 ;; Don't show files who don't belong to a file
1080 bs-dont-show-function 'bs-visits-non-file
1081 ;; Show *scratch* buffer.
1084 (defun bs-config--all ()
1085 "Define a configuration for showing all buffers.
1086 Reset all according variables by `bs-config-clear'."
1087 (bs-config-clear))
1089 (defun bs-config--all-intern-last ()
1090 "Define a configuration for showing all buffers.
1091 Internal buffers appear at end of all buffers."
1092 (bs-config-clear)
1093 ;; I want to see *-buffers at the end
1094 (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))
1096 (defun bs-set-configuration (name)
1097 "Set configuration to the one saved under string NAME in `bs-configurations'.
1098 When called interactively ask user for a configuration and apply selected
1099 configuration."
1100 (interactive (list (completing-read "Use configuration: "
1101 bs-configurations
1102 nil
1103 t)))
1104 (let ((list (assoc name bs-configurations)))
1105 (if list
1106 (if (listp list)
1107 (setq bs-current-configuration name
1108 bs-must-show-regexp (nth 1 list)
1109 bs-must-show-function (nth 2 list)
1110 bs-dont-show-regexp (nth 3 list)
1111 bs-dont-show-function (nth 4 list)
1112 bs-buffer-sort-function (nth 5 list))
1113 ;; for backward compatibility
1114 (funcall (cdr list)))
1115 ;; else
1116 (ding)
1117 (bs-message-without-log "No bs-configuration named %S." name))))
1119 (defun bs-help ()
1120 "Help for `bs-show'."
1121 (interactive)
1122 (describe-function 'bs-mode))
1124 (defun bs-next-config-aux (start-name list)
1125 "Get the next assoc after START-NAME in list LIST.
1126 Will return the first if START-NAME is at end."
1127 (let ((assocs list)
1128 (length (length list))
1129 pos)
1130 (while (and assocs (not pos))
1131 (when (string= (car (car assocs)) start-name)
1132 (setq pos (- length (length assocs))))
1133 (setq assocs (cdr assocs)))
1134 (setq pos (1+ pos))
1135 (if (eq pos length)
1136 (car list)
1137 (nth pos list))))
1139 (defun bs-next-config (name)
1140 "Return next configuration with respect to configuration with name NAME."
1141 (bs-next-config-aux name bs-configurations))
1143 (defun bs-select-next-configuration (&optional start-name)
1144 "Apply next configuration START-NAME and refresh buffer list.
1145 If START-NAME is nil the current configuration `bs-current-configuration'
1146 will be used."
1147 (interactive)
1148 (let ((config (bs-next-config (or start-name bs-current-configuration))))
1149 (bs-set-configuration (car config))
1150 (setq bs-default-configuration bs-current-configuration)
1151 (bs--redisplay t)
1152 (bs--set-window-height)
1153 (bs-message-without-log "Selected configuration: %s" (car config))))
1155 (defun bs-show-in-buffer (list)
1156 "Display buffer list LIST in buffer *buffer-selection*.
1157 Select buffer *buffer-selection* and display buffers according to current
1158 configuration `bs-current-configuration'. Set window height, fontify buffer
1159 and move point to current buffer."
1160 (setq bs-current-list list)
1161 (switch-to-buffer (get-buffer-create "*buffer-selection*"))
1162 (bs-mode)
1163 (let* ((inhibit-read-only t)
1164 (map-fun (lambda (entry)
1165 (string-width (buffer-name entry))))
1166 (max-length-of-names (apply 'max
1167 (cons 0 (mapcar map-fun list))))
1168 (name-entry-length (min bs-maximal-buffer-name-column
1169 (max bs-minimal-buffer-name-column
1170 max-length-of-names))))
1171 (erase-buffer)
1172 (setq bs--name-entry-length name-entry-length)
1173 (bs--show-header)
1174 (dolist (buffer list)
1175 (bs--insert-one-entry buffer)
1177 (delete-char -1)
1178 (bs--set-window-height)
1179 (bs--goto-current-buffer)
1180 (font-lock-ensure)
1181 (bs-apply-sort-faces)
1182 (set-buffer-modified-p nil)))
1184 (defun bs-next-buffer (&optional buffer-list sorting-p)
1185 "Return next buffer and buffer list for buffer cycling in BUFFER-LIST.
1186 Ignore sorting when SORTING-P is nil.
1187 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1188 buffer list. The result is a cons of normally the second element of
1189 BUFFER-LIST and the buffer list used for buffer cycling."
1190 (let* ((bs--current-sort-function (if sorting-p
1191 bs--current-sort-function))
1192 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1193 (cons (or (car (cdr bs-buffer-list))
1194 (car bs-buffer-list)
1195 (current-buffer))
1196 bs-buffer-list)))
1198 (defun bs-previous-buffer (&optional buffer-list sorting-p)
1199 "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST.
1200 Ignore sorting when SORTING-P is nil.
1201 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1202 buffer list. The result is a cons of last element of BUFFER-LIST and the
1203 buffer list used for buffer cycling."
1204 (let* ((bs--current-sort-function (if sorting-p
1205 bs--current-sort-function))
1206 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1207 (cons (or (car (last bs-buffer-list))
1208 (current-buffer))
1209 bs-buffer-list)))
1211 (defun bs-message-without-log (&rest args)
1212 "Like `message' but don't log it on the message log.
1213 All arguments ARGS are transferred to function `message'."
1214 (let ((message-log-max nil))
1215 (apply 'message args)))
1217 (defvar bs--cycle-list nil
1218 "Current buffer list used for cycling.")
1220 ;;;###autoload
1221 (defun bs-cycle-next ()
1222 "Select next buffer defined by buffer cycling.
1223 The buffers taking part in buffer cycling are defined
1224 by buffer configuration `bs-cycle-configuration-name'."
1225 (interactive)
1226 (let ((bs--buffer-coming-from (current-buffer))
1227 (bs-dont-show-regexp bs-dont-show-regexp)
1228 (bs-must-show-regexp bs-must-show-regexp)
1229 (bs-dont-show-function bs-dont-show-function)
1230 (bs-must-show-function bs-must-show-function)
1231 (bs--show-all nil))
1232 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1233 (let ((bs-buffer-sort-function nil)
1234 (bs--current-sort-function nil))
1235 (let* ((tupel (bs-next-buffer (if (or (eq last-command
1236 'bs-cycle-next)
1237 (eq last-command
1238 'bs-cycle-previous))
1239 bs--cycle-list)))
1240 (next (car tupel))
1241 (cycle-list (cdr tupel)))
1242 ;; We don't want the frame iconified if the only window in the frame
1243 ;; happens to be dedicated.
1244 (bury-buffer (current-buffer))
1245 (switch-to-buffer next nil t)
1246 (setq bs--cycle-list (append (cdr cycle-list)
1247 (list (car cycle-list))))
1248 (bs-message-without-log "Next buffers: %s"
1249 (or (cdr bs--cycle-list)
1250 "this buffer"))))))
1252 ;;;###autoload
1253 (defun bs-cycle-previous ()
1254 "Select previous buffer defined by buffer cycling.
1255 The buffers taking part in buffer cycling are defined
1256 by buffer configuration `bs-cycle-configuration-name'."
1257 (interactive)
1258 (let ((bs--buffer-coming-from (current-buffer))
1259 (bs-dont-show-regexp bs-dont-show-regexp)
1260 (bs-must-show-regexp bs-must-show-regexp)
1261 (bs-dont-show-function bs-dont-show-function)
1262 (bs-must-show-function bs-must-show-function)
1263 (bs--show-all nil))
1264 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1265 (let ((bs-buffer-sort-function nil)
1266 (bs--current-sort-function nil))
1267 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1268 'bs-cycle-next)
1269 (eq last-command
1270 'bs-cycle-previous))
1271 bs--cycle-list)))
1272 (prev-buffer (car tupel))
1273 (cycle-list (cdr tupel)))
1274 (switch-to-buffer prev-buffer nil t)
1275 (setq bs--cycle-list (append (last cycle-list)
1276 (reverse (cdr (reverse cycle-list)))))
1277 (bs-message-without-log "Previous buffers: %s"
1278 (or (reverse (cdr bs--cycle-list))
1279 "this buffer"))))))
1281 (defun bs--get-value (fun &optional args)
1282 "Apply function FUN with arguments ARGS.
1283 Return result of evaluation. Will return FUN if FUN is a number
1284 or a string."
1285 (cond ((numberp fun)
1286 fun)
1287 ((stringp fun)
1288 fun)
1289 (t (apply fun args))))
1291 (defun bs--get-marked-string (start-buffer _all-buffers)
1292 "Return a string which describes whether current buffer is marked.
1293 START-BUFFER is the buffer where we started buffer selection.
1294 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu.
1295 The result string is one of `bs-string-current', `bs-string-current-marked',
1296 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1297 `bs-string-show-always'."
1298 (cond ;; current buffer is the buffer we started buffer selection.
1299 ((eq (current-buffer) start-buffer)
1300 (if (memq (current-buffer) bs--marked-buffers)
1301 bs-string-current-marked ; buffer is marked
1302 bs-string-current))
1303 ;; current buffer is marked
1304 ((memq (current-buffer) bs--marked-buffers)
1305 bs-string-marked)
1306 ;; current buffer hasn't a special mark.
1307 ((null bs-buffer-show-mark)
1308 bs-string-show-normally)
1309 ;; current buffer has a mark not to show itself.
1310 ((eq bs-buffer-show-mark 'never)
1311 bs-string-show-never)
1312 ;; otherwise current buffer is marked to show always.
1313 (t
1314 bs-string-show-always)))
1316 (defun bs--get-modified-string (_start-buffer _all-buffers)
1317 "Return a string which describes whether current buffer is modified.
1318 START-BUFFER is the buffer where we started buffer selection.
1319 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1320 (if (buffer-modified-p) "*" " "))
1322 (defun bs--get-readonly-string (_start-buffer _all-buffers)
1323 "Return a string which describes whether current buffer is read only.
1324 START-BUFFER is the buffer where we started buffer selection.
1325 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1326 (if buffer-read-only "%" " "))
1328 (defun bs--get-size-string (_start-buffer _all-buffers)
1329 "Return a string which describes the size of current buffer.
1330 START-BUFFER is the buffer where we started buffer selection.
1331 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1332 (int-to-string (buffer-size)))
1334 (defun bs--get-name (_start-buffer _all-buffers)
1335 "Return name of current buffer for Buffer Selection Menu.
1336 The name of current buffer gets additional text properties
1337 for mouse highlighting.
1338 START-BUFFER is the buffer where we started buffer selection.
1339 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1340 (propertize (buffer-name)
1341 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"
1342 'mouse-face 'highlight))
1344 (defun bs--get-mode-name (start-buffer _all-buffers)
1345 "Return the name of mode of current buffer for Buffer Selection Menu.
1346 START-BUFFER is the buffer where we started buffer selection.
1347 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1348 (format-mode-line mode-name nil nil start-buffer))
1350 (defun bs--get-file-name (_start-buffer _all-buffers)
1351 "Return string for column `File' in Buffer Selection Menu.
1352 This is the variable `buffer-file-name' of current buffer.
1353 If not visiting a file, `list-buffers-directory' is returned instead.
1354 START-BUFFER is the buffer where we started buffer selection.
1355 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1356 (propertize (or buffer-file-name
1357 (bound-and-true-p list-buffers-directory)
1358 "")
1359 'mouse-face 'highlight
1360 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"))
1362 (defun bs--insert-one-entry (buffer)
1363 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1364 It goes over all columns described in `bs-attributes-list'
1365 and evaluates corresponding string. Inserts string in current buffer;
1366 normally *buffer-selection*."
1367 (let ((string "")
1368 (to-much 0)
1369 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1370 (with-current-buffer buffer
1371 (dolist (column bs-attributes-list)
1372 (let* ((min (bs--get-value (nth 1 column)))
1373 (new-string (bs--format-aux (bs--get-value (nth 4 column) ; fun
1374 apply-args)
1375 (nth 3 column) ; align
1376 (- min to-much)))
1377 (len (string-width new-string)))
1378 (setq string (concat string new-string))
1379 (when (> len min)
1380 (setq to-much (- len min))))))
1381 (insert string)))
1383 (defun bs--format-aux (string align len)
1384 "Pad STRING to length LEN with alignment ALIGN.
1385 ALIGN is one of the symbols `left', `middle', or `right'."
1386 (let* ((width (length string))
1387 (len (max len width)))
1388 (format (format "%%%s%ds" (if (eq align 'right) "" "-") len)
1389 (if (eq align 'middle)
1390 (concat (make-string (/ (- len width) 2) ?\s) string)
1391 string))))
1393 (defun bs--show-header ()
1394 "Insert header for Buffer Selection Menu in current buffer."
1395 (insert (bs--create-header-line #'identity)
1397 (bs--create-header-line (lambda (title)
1398 (make-string (length title) ?-)))
1401 (defun bs--get-name-length ()
1402 "Return value of `bs--name-entry-length'."
1403 bs--name-entry-length)
1405 (defun bs--create-header-line (col)
1406 "Generate a line for the header.
1407 COL is called for each column in `bs-attributes-list' as a
1408 function of one argument, the string heading for the column."
1409 (mapconcat (lambda (column)
1410 (bs--format-aux (funcall col (bs--get-value (car column)))
1411 (nth 3 column) ; align
1412 (bs--get-value (nth 1 column))))
1413 bs-attributes-list
1414 ""))
1416 (defun bs--show-with-configuration (name &optional arg)
1417 "Display buffer list of configuration with name NAME.
1418 Set configuration NAME and determine window for Buffer Selection Menu.
1419 Unless current buffer is buffer *buffer-selection* we have to save
1420 the buffer we started Buffer Selection Menu and the current window
1421 configuration to restore buffer and window configuration after a
1422 selection. If there is already a window displaying *buffer-selection*
1423 select this window for Buffer Selection Menu. Otherwise open a new
1424 window.
1425 The optional argument ARG is the prefix argument when calling a function
1426 for buffer selection."
1427 (bs-set-configuration name)
1428 (let ((bs--show-all (or bs--show-all arg)))
1429 (unless (string= "*buffer-selection*" (buffer-name))
1430 ;; Only when not in buffer *buffer-selection*
1431 ;; we have to set the buffer we started the command
1432 (setq bs--buffer-coming-from (current-buffer)))
1433 (let ((liste (bs-buffer-list))
1434 (active-window (get-window-with-predicate
1435 (lambda (w)
1436 (string= (buffer-name (window-buffer w))
1437 "*buffer-selection*"))
1438 nil (selected-frame))))
1439 (if active-window
1440 (select-window active-window)
1441 (bs--restore-window-config)
1442 (setq bs--window-config-coming-from (current-window-configuration))
1443 (when (> (window-height) 7)
1444 ;; Errors would mess with the window configuration (bug#10882).
1445 (ignore-errors (select-window (split-window-below)))))
1446 (bs-show-in-buffer liste)
1447 (bs-message-without-log "%s" (bs--current-config-message)))))
1449 (defun bs--configuration-name-for-prefix-arg (prefix)
1450 "Convert prefix argument PREFIX to a name of a buffer configuration.
1451 If PREFIX is nil return `bs-default-configuration'.
1452 If PREFIX is an integer return PREFIX element of `bs-configurations'.
1453 Otherwise return `bs-alternative-configuration'."
1454 (cond ;; usually activation
1455 ((null prefix)
1456 bs-default-configuration)
1457 ;; call with integer as prefix argument
1458 ((integerp prefix)
1459 (if (and (< 0 prefix) (<= prefix (length bs-configurations)))
1460 (car (nth (1- prefix) bs-configurations))
1461 bs-default-configuration))
1462 ;; call by prefix argument C-u
1463 (t bs-alternative-configuration)))
1465 ;; ----------------------------------------------------------------------
1466 ;; Main function bs-customize and bs-show
1467 ;; ----------------------------------------------------------------------
1469 ;;;###autoload
1470 (defun bs-customize ()
1471 "Customization of group bs for Buffer Selection Menu."
1472 (interactive)
1473 (customize-group "bs"))
1475 ;;;###autoload
1476 (defun bs-show (arg)
1477 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1479 There are many key commands similar to `Buffer-menu-mode' for
1480 manipulating the buffer list and the buffers themselves.
1485 With prefix argument ARG show a different buffer list. Function
1486 `bs--configuration-name-for-prefix-arg' determine accordingly
1487 name of buffer configuration."
1488 (interactive "P")
1489 (setq bs--marked-buffers nil)
1490 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1492 ;; ----------------------------------------------------------------------
1493 ;; Cleanup
1494 ;; ----------------------------------------------------------------------
1496 (defun bs-unload-function ()
1497 "Unload the Buffer Selection library."
1498 (let ((bs-buf (get-buffer "*buffer-selection*")))
1499 (when bs-buf
1500 (with-current-buffer bs-buf
1501 (when (eq major-mode 'bs-mode)
1502 (bs-kill)
1503 (kill-buffer bs-buf)))))
1504 ;; continue standard unloading
1505 nil)
1507 (provide 'bs)
1509 ;;; bs.el ends here