| blob | 307b3c4ae9a49f2235da8ccf62ba9befabea307d |
1 ;;; bs.el --- menu for selecting and displaying buffers
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
4 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 ;; Author: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
6 ;; Maintainer: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
7 ;; Keywords: convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Version: 1.17
27 ;; X-URL: http://www.geekware.de/software/emacs
28 ;;
29 ;; The bs-package contains a main function bs-show for poping up a
30 ;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
31 ;; The new buffer offers a Buffer Selection Menu for manipulating
32 ;; the buffer list and buffers.
33 ;;
34 ;; -----------------------------------------------------------------------
35 ;; | MR Buffer Size Mode File |
36 ;; | -- ------ ---- ---- ---- |
37 ;; |. bs.el 14690 Emacs-Lisp /home/sun/sylvester/el/bs.e$|
38 ;; | % executable.el 9429 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
39 ;; | % vc.el 104893 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
40 ;; | % test_vc.el 486 Emacs-Lisp /home/sun/sylvester/el/test$|
41 ;; | % vc-hooks.el 43605 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
42 ;; -----------------------------------------------------------------------
44 ;;; Quick Installation und Customization:
46 ;; Use
47 ;; M-x bs-show
48 ;; for buffer selection or optional bind a key to main function `bs-show'
49 ;; (global-set-key "\C-x\C-b" 'bs-show) ;; or another key
50 ;;
51 ;; For customization use
52 ;; M-x bs-customize
55 ;;; More Commentary:
57 ;; bs-show will generate a new buffer named *buffer-selection*, which shows
58 ;; all buffers or a subset of them, and has possibilities for deleting,
59 ;; saving and selecting buffers. For more details see docstring of
60 ;; function `bs-mode'. A current configuration describes which buffers appear
61 ;; in *buffer-selection*. See docstring of variable `bs-configurations' for
62 ;; more details.
63 ;;
64 ;; The package bs combines the advantages of the Emacs functions
65 ;; `list-buffers' and `electric-buffer-list'.
66 ;;
67 ;; Additional features for Buffer Selection Menu:
68 ;; - configurable list of buffers (show only files etc.).
69 ;; - comfortable way to change displayed subset of all buffers.
70 ;; - show sorted list of buffers.
71 ;; - cyclic navigation:
72 ;; - goes to top of buffer list if you are on last line and press down.
73 ;; - goes to end of buffer list if you are on first line and press up.
74 ;; - Offer an alternative buffer list by prefix key C-u.
76 ;;; Cycling through buffers
78 ;; This package offers two functions for buffer cycling. If you want to cycle
79 ;; through buffer list you can use `bs-cycle-next' or `bs-cycle-previous'.
80 ;; Bind these function to a key like
81 ;; (global-set-key [(f9)] 'bs-cycle-previous)
82 ;; (global-set-key [(f10)] 'bs-cycle-next)
83 ;;
84 ;; Both functions use a special subset of all buffers for cycling to avoid
85 ;; to go through internal buffers like *Messages*.
86 ;;
87 ;; Cycling through buffers ignores sorting because sorting destroys
88 ;; the logical buffer list. If buffer list is sorted by size you
89 ;; won't be able to cycle to the smallest buffer.
91 ;;; Customization:
93 ;; There is a customization group called `bs' in group `convenience'.
94 ;; Start customization by M-x bs-customize
95 ;;
96 ;; Buffer list
97 ;; -----------
98 ;; You can define your own configurations by extending variable
99 ;; `bs-configurations' (see docstring for details).
100 ;;
101 ;; `bs-default-configuration' contains the name of default configuration.
102 ;; The default value is "files" which means to show only files.
103 ;;
104 ;; If you always want to see all buffers, customize variable
105 ;; `bs-default-configuration' in customization group `bs'.
106 ;;
107 ;; Configure sorting
108 ;; -----------------
109 ;; You can define functions for sorting the buffer list.
110 ;; When selecting buffers, you can step through available sorting
111 ;; methods with key 'S'.
112 ;; To define a new way of sorting, customize variable `bs-sort-functions'.
113 ;;
114 ;; There are four basic functions for sorting:
115 ;; by buffer name, by mode, by size, or by filename
116 ;;
117 ;; Configure buffer cycling
118 ;; ------------------------
119 ;; When cycling through buffer list the functions for cycling will use
120 ;; the current configuration of bs to calculate the buffer list.
121 ;; If you want to use a different configuration for cycling you have to set
122 ;; the variable `bs-cycle-configuration-name'. You can customize this variable.
123 ;;
124 ;; For example: If you use the configuration called "files-and-scratch" you
125 ;; can cycle through all file buffers and *scratch* although your current
126 ;; configuration perhaps is "files" which ignores buffer *scratch*.
128 ;;; History:
130 ;;; Code:
134 ;; ----------------------------------------------------------------------
135 ;; Globals for customization
136 ;; ----------------------------------------------------------------------
139 "Buffer Selection: Maintaining buffers by buffer menu."
146 "Buffer Selection appearance: Appearance of bs buffer menu."
161 "List specifying the layout of a Buffer Selection Menu buffer.
162 Each entry specifies a column and is a list of the form of:
163 \(HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING)
165 HEADER : String for header for first line or a function
166 which calculates column title.
167 MINIMUM-LENGTH : Minimum width of column (number or name of function).
168 The function must return a positive integer.
169 MAXIMUM-LENGTH : Maximum width of column (number or name of function)
170 (currently ignored).
171 ALIGNMENT : Alignment of column (`left', `right', `middle').
172 FUN-OR-STRING : Name of a function for calculating the value or a
173 string for a constant value.
175 The function gets as parameter the buffer where we have started
176 buffer selection and the list of all buffers to show. The function must
177 return a string representing the column's value."
182 "Return a regexp matching the first line of a Buffer Selection Menu buffer."
185 ;; Font-Lock-Settings
190 ;; Buffername embedded by *
192 1
193 ;; problem in XEmacs with font-lock-constant-face
195 'font-lock-constant-face
197 ;; Dired-Buffers
199 ;; the star for modified buffers
204 "Maximal window height of Buffer Selection Menu."
209 "Regular expression specifying which buffers not to show.
210 A buffer whose name matches this regular expression will not be
214 "Regular expression for specifying buffers which must be shown.
215 A buffer whose name matches this regular expression will be
216 included in the buffer list.
217 Note that this variable is temporary: if the configuration is changed
218 it is reset to nil. Use `bs-must-always-show-regexp' to specify buffers
222 "Regular expression for specifying buffers to show always.
223 A buffer whose name matches this regular expression will
224 be shown regardless of current configuration of Buffer Selection Menu."
229 "Function for specifying buffers not to show.
230 The function gets one argument - the buffer to test. The function must
231 return a value different from nil to ignore the buffer in
235 "Function for specifying buffers which must be shown.
239 "Sort function to sort the buffers that appear in Buffer Selection Menu.
240 The function gets two arguments - the buffers to compare.
244 "Maximum 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 maximal
247 width is bounded by `bs-maximal-buffer-name-column'.
248 See also `bs-minimal-buffer-name-column'."
253 "Minimum column width for buffer names.
254 The column for buffer names has dynamic width. The width depends on
255 maximal and minimal length of names of buffers to show. The minimal
256 width is bounded by `bs-minimal-buffer-name-column'.
257 See also `bs-maximal-buffer-name-column'."
268 bs-sort-buffer-interns-are-last)
270 "List of all configurations you can use in the Buffer Selection Menu.
271 A configuration describes which buffers appear in Buffer Selection Menu
272 and also the order of buffers. A configuration is a list with
273 six elements. The first element is a string and describes the configuration.
274 The following five elements represent the values for Buffer Selection Menu
275 configuration variables `bs-must-show-regexp', `bs-must-show-function',
276 `bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'.
277 By setting these variables you define a configuration."
282 "Name of default configuration used by the Buffer Selection Menu.
285 Must be a string used in `bs-configurations' for naming a configuration."
290 "Name of configuration used when calling `bs-show' with \
292 Must be a string used in `bs-configurations' for naming a configuration."
297 "Name of current configuration.
301 "Name of configuration used when cycling through the buffer list.
302 A value of nil means to use current configuration `bs-default-configuration'.
303 Must be a string used in `bs-configurations' for naming a configuration."
306 string))
309 "String added in column 1 indicating a buffer will always be shown."
314 "String added in column 1 indicating a buffer will never be shown."
319 "String added in column 1 indicating the current buffer."
324 "String added in column 1 indicating the current buffer when it is marked."
329 "String added in column 1 indicating a marked buffer."
334 "String added in column 1 indicating an unmarked buffer."
339 "Maximum length of all displayed buffer names.
342 ;; ----------------------------------------------------------------------
343 ;; Internal globals
344 ;; ----------------------------------------------------------------------
347 "Flag for the current mode for showing this buffer.
348 A value of nil means buffer will be shown depending on the current
349 configuration.
350 A value of `never' means to never show the buffer.
355 ;; Make face named region (for XEmacs)
361 "Compare buffers B1 and B2 by buffer name."
366 "Compare buffers B1 and B2 by file name."
371 "Compare buffers B1 and B2 by mode name."
377 "Compare buffers B1 and B2 by buffer size."
386 "List of all possible sorting aspects for Buffer Selection Menu.
387 You can add a new entry with a call to `bs-define-sort-function'.
388 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE).
389 NAME specifies the sort order defined by function FUNCTION.
390 FUNCTION nil means don't sort the buffer list. Otherwise the function
391 must have two parameters - the buffers to compare.
392 REGEXP-FOR-SORTING is a regular expression which describes the
393 column title to highlight.
394 FACE is a face used to fontify the sorted column title. A value of nil means
395 don't highlight."
400 "Define a new function for buffer sorting in Buffer Selection Menu.
401 NAME specifies the sort order defined by function FUN.
402 A value of nil for FUN means don't sort the buffer list. Otherwise the
403 functions must have two parameters - the buffers to compare.
404 REGEXP-FOR-SORTING is a regular expression which describes the
405 column title to highlight.
406 FACE is a face used to fontify the sorted column title. A value of nil means
407 don't highlight.
408 The new sort aspect will be inserted into list `bs-sort-functions'."
414 bs-sort-functions)))))
417 "Description of the current function for sorting the buffer list.
421 "Name of default sort behavior.
435 "Flag whether showing all buffers regardless of current configuration.
436 Non-nil means to show all buffers. Otherwise show buffers
443 "Regular expression specifying which buffers never to show.
444 A buffer whose name matches this regular expression will never be
448 "List of buffers shown in Buffer Selection Menu.
462 (define-key map "F" 'bs-select-other-frame)
463 (let ((key ?1))
464 (while (<= key ?9)
465 (define-key map (char-to-string key) 'digit-argument)
466 (setq key (1+ key))))
467 (define-key map "-" 'negative-argument)
468 (define-key map "\e-" 'negative-argument)
469 (define-key map "o" 'bs-select-other-window)
470 (define-key map "\C-o" 'bs-tmp-select-other-window)
471 ;; for GNU EMACS
472 (define-key map [mouse-3] 'bs-mouse-select-other-frame)
473 ;; for XEmacs
474 (define-key map [button3] 'bs-mouse-select-other-frame)
475 (define-key map [up] 'bs-up)
476 (define-key map "n" 'bs-down)
477 (define-key map "p" 'bs-up)
478 (define-key map [down] 'bs-down)
479 (define-key map "\C-m" 'bs-select)
480 (define-key map "b" 'bs-bury-buffer)
481 (define-key map "s" 'bs-save)
482 (define-key map "S" 'bs-show-sorted)
483 (define-key map "a" 'bs-toggle-show-all)
484 (define-key map "d" 'bs-delete)
485 (define-key map "\C-d" 'bs-delete-backward)
486 (define-key map "k" 'bs-delete)
487 (define-key map "g" 'bs-refresh)
488 (define-key map "C" 'bs-set-configuration-and-refresh)
489 (define-key map "c" 'bs-select-next-configuration)
490 (define-key map "q" 'bs-kill)
491 ;; (define-key map "z" 'bs-kill)
492 (define-key map "\C-c\C-c" 'bs-kill)
493 (define-key map "\C-g" 'bs-abort)
494 (define-key map "\C-]" 'bs-abort)
495 (define-key map "%" 'bs-toggle-readonly)
496 (define-key map "~" 'bs-clear-modified)
497 (define-key map "M" 'bs-toggle-current-to-show)
498 (define-key map "+" 'bs-set-current-buffer-to-show-always)
499 ;;(define-key map "-" 'bs-set-current-buffer-to-show-never)
500 (define-key map "t" 'bs-visit-tags-table)
501 (define-key map "m" 'bs-mark-current)
502 (define-key map "u" 'bs-unmark-current)
503 (define-key map ">" 'scroll-right)
504 (define-key map "<" 'scroll-left)
505 (define-key map "?" 'bs-help)
506 map)
507 "Keymap of `bs-mode'.")
509 ;; ----------------------------------------------------------------------
510 ;; Functions
511 ;; ----------------------------------------------------------------------
513 (defun bs-buffer-list (&optional list sort-description)
514 "Return a list of buffers to be shown.
515 LIST is a list of buffers to test for appearance in Buffer Selection Menu.
516 The result list depends on the global variables `bs-dont-show-regexp',
517 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
518 and `bs-buffer-sort-function'.
519 If SORT-DESCRIPTION isn't nil the list will be sorted by
520 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
521 (setq sort-description (or sort-description bs--current-sort-function)
522 list (or list (buffer-list)))
523 (let ((result nil))
524 (dolist (buf list)
525 (let* ((buffername (buffer-name buf))
526 (int-show-never (string-match-p bs--intern-show-never buffername))
527 (ext-show-never (and bs-dont-show-regexp
528 (string-match-p bs-dont-show-regexp
529 buffername)))
530 (extern-must-show (or (and bs-must-always-show-regexp
531 (string-match-p
532 bs-must-always-show-regexp
533 buffername))
534 (and bs-must-show-regexp
535 (string-match-p bs-must-show-regexp
536 buffername))))
537 (extern-show-never-from-fun (and bs-dont-show-function
538 (funcall bs-dont-show-function
539 buf)))
540 (extern-must-show-from-fun (and bs-must-show-function
541 (funcall bs-must-show-function
542 buf)))
543 (show-flag (buffer-local-value 'bs-buffer-show-mark buf)))
544 (when (or (eq show-flag 'always)
545 (and (or bs--show-all (not (eq show-flag 'never)))
546 (not int-show-never)
547 (or bs--show-all
548 extern-must-show
549 extern-must-show-from-fun
550 (and (not ext-show-never)
551 (not extern-show-never-from-fun)))))
552 (setq result (cons buf result)))))
553 (setq result (reverse result))
554 ;; The current buffer which was the start point of bs should be an element
555 ;; of result list, so that we can leave with space and be back in the
556 ;; buffer we started bs-show.
557 (when (and bs--buffer-coming-from
558 (buffer-live-p bs--buffer-coming-from)
559 (not (memq bs--buffer-coming-from result)))
560 (setq result (cons bs--buffer-coming-from result)))
561 ;; sorting
562 (if (and sort-description
563 (nth 1 sort-description))
564 (setq result (sort result (nth 1 sort-description)))
565 ;; else standard sorting
566 (bs-buffer-sort result))))
568 (defun bs-buffer-sort (buffer-list)
569 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
570 (if bs-buffer-sort-function
571 (sort buffer-list bs-buffer-sort-function)
572 buffer-list))
574 (defun bs--redisplay (&optional keep-line-p sort-description)
575 "Redisplay whole Buffer Selection Menu.
576 If KEEP-LINE-P is non-nil the point will stay on current line.
577 SORT-DESCRIPTION is an element of `bs-sort-functions'."
578 (let ((line (count-lines 1 (point))))
579 (bs-show-in-buffer (bs-buffer-list nil sort-description))
580 (when keep-line-p
581 (goto-char (point-min))
582 (forward-line line))
583 (beginning-of-line)))
585 (defun bs--goto-current-buffer ()
586 "Goto line which represents the current buffer;
587 actually the line which begins with character in `bs-string-current' or
588 `bs-string-current-marked'."
589 (let ((regexp (concat "^"
590 (regexp-quote bs-string-current)
592 (regexp-quote bs-string-current-marked)))
593 point)
594 (save-excursion
595 (goto-char (point-min))
596 (when (search-forward-regexp regexp nil t)
597 (setq point (1- (point)))))
598 (when point
599 (goto-char point))))
601 (defun bs--current-config-message ()
602 "Return a string describing the current `bs-mode' configuration."
603 (if bs--show-all
604 "Show all buffers."
605 (format "Show buffer by configuration %S"
606 bs-current-configuration)))
608 (defun bs--track-window-changes (frame)
609 "Track window changes to refresh the buffer list.
610 Used from `window-size-change-functions'."
611 (let ((win (get-buffer-window "*buffer-selection*" frame)))
612 (when win
613 (with-selected-window win
614 (bs--set-window-height)))))
616 (defun bs--remove-hooks ()
617 "Remove `bs--track-window-changes' and auxiliary hooks."
618 (remove-hook 'window-size-change-functions 'bs--track-window-changes)
619 ;; Remove itself
620 (remove-hook 'kill-buffer-hook 'bs--remove-hooks t)
621 (remove-hook 'change-major-mode-hook 'bs--remove-hooks t))
623 (put 'bs-mode 'mode-class 'special)
625 (define-derived-mode bs-mode nil "Buffer-Selection-Menu"
626 "Major mode for editing a subset of Emacs' buffers.
628 Aside from two header lines each line describes one buffer.
629 Move to a line representing the buffer you want to edit and select
631 There are many key commands similar to `Buffer-menu-mode' for
632 manipulating the buffer list and buffers.
633 For faster navigation each digit key is a digit argument.
639 remain in Buffer Selection Menu.
649 apply selected configuration.
651 available Buffer Selection Menu configuration.
655 to show always.
658 (make-local-variable 'font-lock-defaults)
659 (make-local-variable 'font-lock-verbose)
660 (make-local-variable 'font-lock-global-modes)
661 (buffer-disable-undo)
662 (setq buffer-read-only t
663 truncate-lines t
664 show-trailing-whitespace nil
665 font-lock-global-modes '(not bs-mode)
666 font-lock-defaults '(bs-mode-font-lock-keywords t)
667 font-lock-verbose nil)
668 (set (make-local-variable 'revert-buffer-function) 'bs-refresh)
669 (add-hook 'window-size-change-functions 'bs--track-window-changes)
670 (add-hook 'kill-buffer-hook 'bs--remove-hooks nil t)
671 (add-hook 'change-major-mode-hook 'bs--remove-hooks nil t))
673 (defun bs--restore-window-config ()
674 "Restore window configuration on the current frame."
675 (when bs--window-config-coming-from
676 (let ((frame (selected-frame)))
677 (unwind-protect
678 (set-window-configuration bs--window-config-coming-from)
679 (select-frame frame)))
680 (setq bs--window-config-coming-from nil)))
682 (defun bs-kill ()
683 "Let buffer disappear and reset window configuration."
684 (interactive)
685 (bury-buffer (current-buffer))
686 (bs--restore-window-config))
688 (defun bs-abort ()
689 "Ding and leave Buffer Selection Menu without a selection."
690 (interactive)
691 (ding)
692 (bs-kill))
694 (defun bs-set-configuration-and-refresh ()
695 "Ask user for a configuration and apply selected configuration.
696 Refresh whole Buffer Selection Menu."
697 (interactive)
698 (call-interactively 'bs-set-configuration)
699 (bs--redisplay t))
701 (defun bs-refresh (&rest ignored)
702 "Refresh whole Buffer Selection Menu.
703 Arguments are IGNORED (for `revert-buffer')."
704 (interactive)
705 (bs--redisplay t))
707 (defun bs--set-window-height ()
708 "Change the height of the selected window to suit the current buffer list."
709 (unless (one-window-p t)
710 (fit-window-to-buffer (selected-window) bs-max-window-height)))
712 (defun bs--current-buffer ()
713 "Return buffer on current line.
714 Raise an error if not on a buffer line."
715 (beginning-of-line)
716 (let ((line (+ (- bs-header-lines-length)
717 (count-lines 1 (point)))))
718 (when (< line 0)
719 (error "You are on a header row"))
720 (nth line bs-current-list)))
722 (defun bs--update-current-line ()
723 "Update the entry on current line for Buffer Selection Menu."
724 (let ((buffer (bs--current-buffer))
725 (inhibit-read-only t))
726 (beginning-of-line)
727 (delete-region (point) (line-end-position))
728 (bs--insert-one-entry buffer)
729 (beginning-of-line)))
731 (defun bs-view ()
732 "View current line's buffer in View mode.
733 Leave Buffer Selection Menu."
734 (interactive)
735 (view-buffer (bs--current-buffer)))
737 (defun bs-select ()
738 "Select current line's buffer and other marked buffers.
739 If there are no marked buffers the window configuration before starting
740 Buffer Selection Menu will be restored.
741 If there are marked buffers each marked buffer and the current line's buffer
742 will be selected in a window.
743 Leave Buffer Selection Menu."
744 (interactive)
745 (let ((buffer (bs--current-buffer)))
746 (bury-buffer (current-buffer))
747 (bs--restore-window-config)
748 (switch-to-buffer buffer)
749 (when bs--marked-buffers
750 ;; Some marked buffers for selection
751 (let* ((all (delq buffer bs--marked-buffers))
752 (height (/ (1- (frame-height)) (1+ (length all)))))
753 (delete-other-windows)
754 (switch-to-buffer buffer)
755 (dolist (buf all)
756 (split-window nil height)
757 (other-window 1)
758 (switch-to-buffer buf))
759 ;; goto window we have started bs.
760 (other-window 1)))))
762 (defun bs-select-other-window ()
763 "Select current line's buffer by `switch-to-buffer-other-window'.
764 The window configuration before starting Buffer Selection Menu will be restored
765 unless there is no other window. In this case a new window will be created.
766 Leave Buffer Selection Menu."
767 (interactive)
768 (let ((buffer (bs--current-buffer)))
769 (bury-buffer (current-buffer))
770 (bs--restore-window-config)
771 (switch-to-buffer-other-window buffer)))
773 (defun bs-tmp-select-other-window ()
774 "Make the other window select this line's buffer.
775 The current window remains selected."
776 (interactive)
777 (let ((buffer (bs--current-buffer)))
778 (display-buffer buffer t)))
780 (defun bs-select-other-frame ()
781 "Select current line's buffer in new created frame.
782 Leave Buffer Selection Menu."
783 (interactive)
784 (let ((buffer (bs--current-buffer)))
785 (bury-buffer (current-buffer))
786 (bs--restore-window-config)
787 (switch-to-buffer-other-frame buffer)))
789 (defun bs-mouse-select-other-frame (event)
790 "Select selected line's buffer in new created frame.
791 Leave Buffer Selection Menu.
792 EVENT: a mouse click event."
793 (interactive "e")
794 (mouse-set-point event)
795 (bs-select-other-frame))
797 (defun bs-mouse-select (event)
798 "Select buffer on mouse click EVENT.
799 Select buffer by `bs-select'."
800 (interactive "e")
801 (mouse-set-point event)
802 (bs-select))
804 (defun bs-select-in-one-window ()
805 "Select current line's buffer in one window and delete other windows.
806 Leave Buffer Selection Menu."
807 (interactive)
808 (bs-select)
809 (delete-other-windows))
811 (defun bs-bury-buffer ()
812 "Bury buffer on current line."
813 (interactive)
814 (bury-buffer (bs--current-buffer))
815 (bs--redisplay t))
817 (defun bs-save ()
818 "Save buffer on current line."
819 (interactive)
820 (with-current-buffer (bs--current-buffer)
821 (save-buffer))
822 (bs--update-current-line))
824 (defun bs-visit-tags-table ()
825 "Visit the tags table in the buffer on this line.
826 See `visit-tags-table'."
827 (interactive)
828 (let ((file (buffer-file-name (bs--current-buffer))))
829 (if file
830 (visit-tags-table file)
831 (error "Specified buffer has no file"))))
833 (defun bs-toggle-current-to-show ()
834 "Toggle status of showing flag for buffer in current line."
835 (interactive)
836 (let ((res
837 (with-current-buffer (bs--current-buffer)
838 (setq bs-buffer-show-mark (case bs-buffer-show-mark
839 ((nil) 'never)
840 ((never) 'always)
841 (t nil))))))
842 (bs--update-current-line)
843 (bs--set-window-height)
844 (bs--show-config-message res)))
846 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
847 "Toggle status of buffer on line to `always shown'.
848 NOT-TO-SHOW-P: prefix argument.
849 With no prefix argument the buffer on current line is marked to show
850 always. Otherwise it is marked to show never."
851 (interactive "P")
852 (if not-to-show-p
853 (bs-set-current-buffer-to-show-never)
854 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
856 (defun bs-set-current-buffer-to-show-never ()
857 "Toggle status of buffer on line to `never shown'."
858 (interactive)
859 (bs--set-toggle-to-show (bs--current-buffer) 'never))
861 (defun bs--set-toggle-to-show (buffer what)
862 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
863 Redisplay current line and display a message describing
864 the status of buffer on current line."
865 (with-current-buffer buffer (setq bs-buffer-show-mark what))
866 (bs--update-current-line)
867 (bs--set-window-height)
868 (bs--show-config-message what))
870 (defun bs--mark-unmark (count fun)
871 "Call FUN on COUNT consecutive buffers of *buffer-selection*."
872 (let ((dir (if (> count 0) 1 -1)))
873 (dotimes (i (abs count))
874 (let ((buffer (bs--current-buffer)))
875 (when buffer (funcall fun buffer))
876 (bs--update-current-line)
877 (bs-down dir)))))
879 (defun bs-mark-current (count)
880 "Mark buffers.
881 COUNT is the number of buffers to mark.
882 Move cursor vertically down COUNT lines."
883 (interactive "p")
884 (bs--mark-unmark count
885 (lambda (buf)
886 (add-to-list 'bs--marked-buffers buf))))
888 (defun bs-unmark-current (count)
889 "Unmark buffers.
890 COUNT is the number of buffers to unmark.
891 Move cursor vertically down COUNT lines."
892 (interactive "p")
893 (bs--mark-unmark count
894 (lambda (buf)
895 (setq bs--marked-buffers (delq buf bs--marked-buffers)))))
897 (defun bs--show-config-message (what)
898 "Show message indicating the new showing status WHAT.
899 WHAT is a value of nil, `never', or `always'."
900 (bs-message-without-log (cond ((null what)
901 "Buffer will be shown normally.")
902 ((eq what 'never)
903 "Mark buffer to never be shown.")
904 (t "Mark buffer to show always."))))
906 (defun bs-delete ()
907 "Kill buffer on current line."
908 (interactive)
909 (let ((current (bs--current-buffer))
910 (inhibit-read-only t))
911 (unless (kill-buffer current)
912 (error "Buffer was not deleted"))
913 (setq bs-current-list (delq current bs-current-list))
914 (beginning-of-line)
915 (delete-region (point) (save-excursion
916 (end-of-line)
917 (if (eobp) (point) (1+ (point)))))
918 (when (eobp)
919 (backward-delete-char 1)
920 (beginning-of-line)
921 (recenter -1))
922 (bs--set-window-height)))
924 (defun bs-delete-backward ()
925 "Like `bs-delete' but go to buffer in front of current."
926 (interactive)
927 (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
928 (bs-delete)
929 (unless on-last-line-p
930 (bs-up 1))))
932 (defun bs-show-sorted ()
933 "Show buffer list sorted by next sort aspect."
934 (interactive)
935 (setq bs--current-sort-function
936 (bs-next-config-aux (car bs--current-sort-function)
937 bs-sort-functions))
938 (bs--redisplay)
939 (bs--goto-current-buffer)
940 (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))
942 (defun bs-apply-sort-faces (&optional sort-description)
943 "Set text properties for the sort described by SORT-DESCRIPTION.
944 SORT-DESCRIPTION is an element of `bs-sort-functions'.
945 Default is `bs--current-sort-function'."
946 (let ((sort-description (or sort-description
947 bs--current-sort-function)))
948 (save-excursion
949 (goto-char (point-min))
950 (when (and (nth 2 sort-description)
951 (search-forward-regexp (nth 2 sort-description) nil t))
952 (let ((inhibit-read-only t))
953 (put-text-property (match-beginning 0)
954 (match-end 0)
955 'face
956 (or (nth 3 sort-description)
957 'region)))))))
959 (defun bs-toggle-show-all ()
960 "Toggle show all buffers / show buffers with current configuration."
961 (interactive)
962 (setq bs--show-all (not bs--show-all))
963 (bs--redisplay)
964 (bs--goto-current-buffer)
965 (bs-message-without-log "%s" (bs--current-config-message)))
967 (defun bs-toggle-readonly ()
968 "Toggle read-only status for buffer on current line.
969 Uses function `toggle-read-only'."
970 (interactive)
971 (with-current-buffer (bs--current-buffer)
972 (toggle-read-only))
973 (bs--update-current-line))
975 (defun bs-clear-modified ()
976 "Set modified flag for buffer on current line to nil."
977 (interactive)
978 (with-current-buffer (bs--current-buffer)
979 (set-buffer-modified-p nil))
980 (bs--update-current-line))
982 (defun bs--nth-wrapper (count fun &rest args)
983 "Call COUNT times function FUN with arguments ARGS."
984 (dotimes (i (or count 1))
985 (apply fun args)))
987 (defun bs-up (arg)
988 "Move cursor vertically up ARG lines in Buffer Selection Menu."
989 (interactive "p")
990 (if (and arg (numberp arg) (< arg 0))
991 (bs--nth-wrapper (- arg) 'bs--down)
992 (bs--nth-wrapper arg 'bs--up)))
994 (defun bs--up ()
995 "Move cursor vertically up one line.
996 If on top of buffer list go to last line."
997 (if (> (count-lines 1 (point)) bs-header-lines-length)
998 (forward-line -1)
999 (goto-char (point-max))
1000 (beginning-of-line)
1001 (recenter -1)))
1003 (defun bs-down (arg)
1004 "Move cursor vertically down ARG lines in Buffer Selection Menu."
1005 (interactive "p")
1006 (if (and arg (numberp arg) (< arg 0))
1007 (bs--nth-wrapper (- arg) 'bs--up)
1008 (bs--nth-wrapper arg 'bs--down)))
1010 (defun bs--down ()
1011 "Move cursor vertically down one line.
1012 If at end of buffer list go to first line."
1013 (if (eq (line-end-position) (point-max))
1014 (progn
1015 (goto-char (point-min))
1016 (forward-line bs-header-lines-length))
1017 (forward-line 1)))
1019 (defun bs-visits-non-file (buffer)
1020 "Return whether BUFFER visits no file.
1021 A value of t means BUFFER belongs to no file.
1022 A value of nil means BUFFER belongs to a file."
1023 (not (buffer-file-name buffer)))
1025 (defun bs-sort-buffer-interns-are-last (b1 b2)
1026 "Function for sorting internal buffers at the end of all buffers."
1029 ;; ----------------------------------------------------------------------
1030 ;; Configurations:
1031 ;; ----------------------------------------------------------------------
1033 (defun bs-config-clear ()
1034 "Reset all variables which specify a configuration.
1035 These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
1036 `bs-dont-show-function', `bs-must-show-function' and
1037 `bs-buffer-sort-function'."
1038 (setq bs-dont-show-regexp nil
1039 bs-must-show-regexp nil
1040 bs-dont-show-function nil
1041 bs-must-show-function nil
1042 bs-buffer-sort-function nil))
1044 (defun bs-config--only-files ()
1045 "Define a configuration for showing only buffers visiting a file."
1046 (bs-config-clear)
1047 (setq ;; I want to see *-buffers at the end
1048 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1049 ;; Don't show files who don't belong to a file
1050 bs-dont-show-function 'bs-visits-non-file))
1052 (defun bs-config--files-and-scratch ()
1053 "Define a configuration for showing buffer *scratch* and file buffers."
1054 (bs-config-clear)
1055 (setq ;; I want to see *-buffers at the end
1056 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1057 ;; Don't show files who don't belong to a file
1058 bs-dont-show-function 'bs-visits-non-file
1059 ;; Show *scratch* buffer.
1062 (defun bs-config--all ()
1063 "Define a configuration for showing all buffers.
1064 Reset all according variables by `bs-config-clear'."
1065 (bs-config-clear))
1067 (defun bs-config--all-intern-last ()
1068 "Define a configuration for showing all buffers.
1069 Internal buffers appear at end of all buffers."
1070 (bs-config-clear)
1071 ;; I want to see *-buffers at the end
1072 (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))
1074 (defun bs-set-configuration (name)
1075 "Set configuration to the one saved under string NAME in `bs-configurations'.
1076 When called interactively ask user for a configuration and apply selected
1077 configuration."
1078 (interactive (list (completing-read "Use configuration: "
1079 bs-configurations
1080 nil
1081 t)))
1082 (let ((list (assoc name bs-configurations)))
1083 (if list
1084 (if (listp list)
1085 (setq bs-current-configuration name
1086 bs-must-show-regexp (nth 1 list)
1087 bs-must-show-function (nth 2 list)
1088 bs-dont-show-regexp (nth 3 list)
1089 bs-dont-show-function (nth 4 list)
1090 bs-buffer-sort-function (nth 5 list))
1091 ;; for backward compability
1092 (funcall (cdr list)))
1093 ;; else
1094 (ding)
1095 (bs-message-without-log "No bs-configuration named %S." name))))
1097 (defun bs-help ()
1098 "Help for `bs-show'."
1099 (interactive)
1100 (describe-function 'bs-mode))
1102 (defun bs-next-config-aux (start-name list)
1103 "Get the next assoc after START-NAME in list LIST.
1104 Will return the first if START-NAME is at end."
1105 (let ((assocs list)
1106 (length (length list))
1107 pos)
1108 (while (and assocs (not pos))
1109 (when (string= (car (car assocs)) start-name)
1110 (setq pos (- length (length assocs))))
1111 (setq assocs (cdr assocs)))
1112 (setq pos (1+ pos))
1113 (if (eq pos length)
1114 (car list)
1115 (nth pos list))))
1117 (defun bs-next-config (name)
1118 "Return next configuration with respect to configuration with name NAME."
1119 (bs-next-config-aux name bs-configurations))
1121 (defun bs-select-next-configuration (&optional start-name)
1122 "Apply next configuration START-NAME and refresh buffer list.
1123 If START-NAME is nil the current configuration `bs-current-configuration'
1124 will be used."
1125 (interactive)
1126 (let ((config (bs-next-config (or start-name bs-current-configuration))))
1127 (bs-set-configuration (car config))
1128 (setq bs-default-configuration bs-current-configuration)
1129 (bs--redisplay t)
1130 (bs--set-window-height)
1131 (bs-message-without-log "Selected configuration: %s" (car config))))
1133 (defun bs-show-in-buffer (list)
1134 "Display buffer list LIST in buffer *buffer-selection*.
1135 Select buffer *buffer-selection* and display buffers according to current
1136 configuration `bs-current-configuration'. Set window height, fontify buffer
1137 and move point to current buffer."
1138 (setq bs-current-list list)
1139 (switch-to-buffer (get-buffer-create "*buffer-selection*"))
1140 (bs-mode)
1141 (let* ((inhibit-read-only t)
1142 (map-fun (lambda (entry)
1143 (length (buffer-name entry))))
1144 (max-length-of-names (apply 'max
1145 (cons 0 (mapcar map-fun list))))
1146 (name-entry-length (min bs-maximal-buffer-name-column
1147 (max bs-minimal-buffer-name-column
1148 max-length-of-names))))
1149 (erase-buffer)
1150 (setq bs--name-entry-length name-entry-length)
1151 (bs--show-header)
1152 (dolist (buffer list)
1153 (bs--insert-one-entry buffer)
1155 (delete-backward-char 1)
1156 (bs--set-window-height)
1157 (bs--goto-current-buffer)
1158 (font-lock-fontify-buffer)
1159 (bs-apply-sort-faces)
1160 (set-buffer-modified-p nil)))
1162 (defun bs-next-buffer (&optional buffer-list sorting-p)
1163 "Return next buffer and buffer list for buffer cycling in BUFFER-LIST.
1164 Ignore sorting when SORTING-P is nil.
1165 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1166 buffer list. The result is a cons of normally the second element of
1167 BUFFER-LIST and the buffer list used for buffer cycling."
1168 (let* ((bs--current-sort-function (if sorting-p
1169 bs--current-sort-function))
1170 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1171 (cons (or (car (cdr bs-buffer-list))
1172 (car bs-buffer-list)
1173 (current-buffer))
1174 bs-buffer-list)))
1176 (defun bs-previous-buffer (&optional buffer-list sorting-p)
1177 "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST.
1178 Ignore sorting when SORTING-P is nil.
1179 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1180 buffer list. The result is a cons of last element of BUFFER-LIST and the
1181 buffer list used for buffer cycling."
1182 (let* ((bs--current-sort-function (if sorting-p
1183 bs--current-sort-function))
1184 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1185 (cons (or (car (last bs-buffer-list))
1186 (current-buffer))
1187 bs-buffer-list)))
1189 (defun bs-message-without-log (&rest args)
1190 "Like `message' but don't log it on the message log.
1191 All arguments ARGS are transferred to function `message'."
1192 (let ((message-log-max nil))
1193 (apply 'message args)))
1195 (defvar bs--cycle-list nil
1196 "Current buffer list used for cycling.")
1198 ;;;###autoload
1199 (defun bs-cycle-next ()
1200 "Select next buffer defined by buffer cycling.
1201 The buffers taking part in buffer cycling are defined
1202 by buffer configuration `bs-cycle-configuration-name'."
1203 (interactive)
1204 (let ((bs--buffer-coming-from (current-buffer))
1205 (bs-dont-show-regexp bs-dont-show-regexp)
1206 (bs-must-show-regexp bs-must-show-regexp)
1207 (bs-dont-show-function bs-dont-show-function)
1208 (bs-must-show-function bs-must-show-function)
1209 (bs--show-all nil))
1210 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1211 (let ((bs-buffer-sort-function nil)
1212 (bs--current-sort-function nil))
1213 (let* ((tupel (bs-next-buffer (if (or (eq last-command
1214 'bs-cycle-next)
1215 (eq last-command
1216 'bs-cycle-previous))
1217 bs--cycle-list)))
1218 (next (car tupel))
1219 (cycle-list (cdr tupel)))
1220 (unless (window-dedicated-p (selected-window))
1221 ;; We don't want the frame iconified if the only window in the frame
1222 ;; happens to be dedicated; let's get the error from switch-to-buffer
1223 (bury-buffer))
1224 (switch-to-buffer next)
1225 (setq bs--cycle-list (append (cdr cycle-list)
1226 (list (car cycle-list))))
1227 (bs-message-without-log "Next buffers: %s"
1228 (or (cdr bs--cycle-list)
1229 "this buffer"))))))
1231 ;;;###autoload
1232 (defun bs-cycle-previous ()
1233 "Select previous buffer defined by buffer cycling.
1234 The buffers taking part in buffer cycling are defined
1235 by buffer configuration `bs-cycle-configuration-name'."
1236 (interactive)
1237 (let ((bs--buffer-coming-from (current-buffer))
1238 (bs-dont-show-regexp bs-dont-show-regexp)
1239 (bs-must-show-regexp bs-must-show-regexp)
1240 (bs-dont-show-function bs-dont-show-function)
1241 (bs-must-show-function bs-must-show-function)
1242 (bs--show-all nil))
1243 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1244 (let ((bs-buffer-sort-function nil)
1245 (bs--current-sort-function nil))
1246 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1247 'bs-cycle-next)
1248 (eq last-command
1249 'bs-cycle-previous))
1250 bs--cycle-list)))
1251 (prev-buffer (car tupel))
1252 (cycle-list (cdr tupel)))
1253 (switch-to-buffer prev-buffer)
1254 (setq bs--cycle-list (append (last cycle-list)
1255 (reverse (cdr (reverse cycle-list)))))
1256 (bs-message-without-log "Previous buffers: %s"
1257 (or (reverse (cdr bs--cycle-list))
1258 "this buffer"))))))
1260 (defun bs--get-value (fun &optional args)
1261 "Apply function FUN with arguments ARGS.
1262 Return result of evaluation. Will return FUN if FUN is a number
1263 or a string."
1264 (cond ((numberp fun)
1265 fun)
1266 ((stringp fun)
1267 fun)
1268 (t (apply fun args))))
1270 (defun bs--get-marked-string (start-buffer all-buffers)
1271 "Return a string which describes whether current buffer is marked.
1272 START-BUFFER is the buffer where we started buffer selection.
1273 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu.
1274 The result string is one of `bs-string-current', `bs-string-current-marked',
1275 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1276 `bs-string-show-always'."
1277 (cond ;; current buffer is the buffer we started buffer selection.
1278 ((eq (current-buffer) start-buffer)
1279 (if (memq (current-buffer) bs--marked-buffers)
1280 bs-string-current-marked ; buffer is marked
1281 bs-string-current))
1282 ;; current buffer is marked
1283 ((memq (current-buffer) bs--marked-buffers)
1284 bs-string-marked)
1285 ;; current buffer hasn't a special mark.
1286 ((null bs-buffer-show-mark)
1287 bs-string-show-normally)
1288 ;; current buffer has a mark not to show itself.
1289 ((eq bs-buffer-show-mark 'never)
1290 bs-string-show-never)
1291 ;; otherwise current buffer is marked to show always.
1292 (t
1293 bs-string-show-always)))
1295 (defun bs--get-modified-string (start-buffer all-buffers)
1296 "Return a string which describes whether current buffer is modified.
1297 START-BUFFER is the buffer where we started buffer selection.
1298 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1299 (if (buffer-modified-p) "*" " "))
1301 (defun bs--get-readonly-string (start-buffer all-buffers)
1302 "Return a string which describes whether current buffer is read only.
1303 START-BUFFER is the buffer where we started buffer selection.
1304 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1305 (if buffer-read-only "%" " "))
1307 (defun bs--get-size-string (start-buffer all-buffers)
1308 "Return a string which describes the size of current buffer.
1309 START-BUFFER is the buffer where we started buffer selection.
1310 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1311 (int-to-string (buffer-size)))
1313 (defun bs--get-name (start-buffer all-buffers)
1314 "Return name of current buffer for Buffer Selection Menu.
1315 The name of current buffer gets additional text properties
1316 for mouse highlighting.
1317 START-BUFFER is the buffer where we started buffer selection.
1318 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1319 (propertize (buffer-name)
1320 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"
1321 'mouse-face 'highlight))
1323 (defun bs--get-mode-name (start-buffer all-buffers)
1324 "Return the name of mode of current buffer for Buffer Selection Menu.
1325 START-BUFFER is the buffer where we started buffer selection.
1326 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1327 (format-mode-line mode-name nil nil start-buffer))
1329 (defun bs--get-file-name (start-buffer all-buffers)
1330 "Return string for column 'File' in Buffer Selection Menu.
1331 This is the variable `buffer-file-name' of current buffer.
1332 If not visiting a file, `list-buffers-directory' is returned instead.
1333 START-BUFFER is the buffer where we started buffer selection.
1334 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1335 (propertize (or buffer-file-name
1336 (bound-and-true-p list-buffers-directory)
1337 "")
1338 'mouse-face 'highlight
1339 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"))
1341 (defun bs--insert-one-entry (buffer)
1342 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1343 It goes over all columns described in `bs-attributes-list'
1344 and evaluates corresponding string. Inserts string in current buffer;
1345 normally *buffer-selection*."
1346 (let ((string "")
1347 (to-much 0)
1348 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1349 (with-current-buffer buffer
1350 (dolist (column bs-attributes-list)
1351 (let* ((min (bs--get-value (nth 1 column)))
1352 (new-string (bs--format-aux (bs--get-value (nth 4 column) ; fun
1353 apply-args)
1354 (nth 3 column) ; align
1355 (- min to-much)))
1356 (len (length new-string)))
1357 (setq string (concat string new-string))
1358 (when (> len min)
1359 (setq to-much (- len min))))))
1360 (insert string)))
1362 (defun bs--format-aux (string align len)
1363 "Pad STRING to length LEN with alignment ALIGN.
1364 ALIGN is one of the symbols `left', `middle', or `right'."
1365 (let* ((width (length string))
1366 (len (max len width)))
1367 (format (format "%%%s%ds" (if (eq align 'right) "" "-") len)
1368 (if (eq align 'middle)
1369 (concat (make-string (/ (- len width) 2) ?\s) string)
1370 string))))
1372 (defun bs--show-header ()
1373 "Insert header for Buffer Selection Menu in current buffer."
1374 (insert (bs--create-header-line #'identity)
1376 (bs--create-header-line (lambda (title)
1377 (make-string (length title) ?-)))
1380 (defun bs--get-name-length ()
1381 "Return value of `bs--name-entry-length'."
1382 bs--name-entry-length)
1384 (defun bs--create-header-line (col)
1385 "Generate a line for the header.
1386 COL is called for each column in `bs-attributes-list' as a
1387 function of one argument, the string heading for the column."
1388 (mapconcat (lambda (column)
1389 (bs--format-aux (funcall col (bs--get-value (car column)))
1390 (nth 3 column) ; align
1391 (bs--get-value (nth 1 column))))
1392 bs-attributes-list
1393 ""))
1395 (defun bs--show-with-configuration (name &optional arg)
1396 "Display buffer list of configuration with name NAME.
1397 Set configuration NAME and determine window for Buffer Selection Menu.
1398 Unless current buffer is buffer *buffer-selection* we have to save
1399 the buffer we started Buffer Selection Menu and the current window
1400 configuration to restore buffer and window configuration after a
1401 selection. If there is already a window displaying *buffer-selection*
1402 select this window for Buffer Selection Menu. Otherwise open a new
1403 window.
1404 The optional argument ARG is the prefix argument when calling a function
1405 for buffer selection."
1406 (bs-set-configuration name)
1407 (let ((bs--show-all (or bs--show-all arg)))
1408 (unless (string= "*buffer-selection*" (buffer-name))
1409 ;; Only when not in buffer *buffer-selection*
1410 ;; we have to set the buffer we started the command
1411 (setq bs--buffer-coming-from (current-buffer)))
1412 (let ((liste (bs-buffer-list))
1413 (active-window (get-window-with-predicate
1414 (lambda (w)
1415 (string= (buffer-name (window-buffer w))
1416 "*buffer-selection*"))
1417 nil (selected-frame))))
1418 (if active-window
1419 (select-window active-window)
1420 (bs--restore-window-config)
1421 (setq bs--window-config-coming-from (current-window-configuration))
1422 (when (> (window-height (selected-window)) 7)
1423 (split-window-vertically)
1424 (other-window 1)))
1425 (bs-show-in-buffer liste)
1426 (bs-message-without-log "%s" (bs--current-config-message)))))
1428 (defun bs--configuration-name-for-prefix-arg (prefix-arg)
1429 "Convert prefix argument PREFIX-ARG to a name of a buffer configuration.
1430 If PREFIX-ARG is nil return `bs-default-configuration'.
1431 If PREFIX-ARG is an integer return PREFIX-ARG element of `bs-configurations'.
1432 Otherwise return `bs-alternative-configuration'."
1433 (cond ;; usually activation
1434 ((null prefix-arg)
1435 bs-default-configuration)
1436 ;; call with integer as prefix argument
1437 ((integerp prefix-arg)
1438 (if (and (< 0 prefix-arg) (<= prefix-arg (length bs-configurations)))
1439 (car (nth (1- prefix-arg) bs-configurations))
1440 bs-default-configuration))
1441 ;; call by prefix argument C-u
1442 (t bs-alternative-configuration)))
1444 ;; ----------------------------------------------------------------------
1445 ;; Main function bs-customize and bs-show
1446 ;; ----------------------------------------------------------------------
1448 ;;;###autoload
1449 (defun bs-customize ()
1450 "Customization of group bs for Buffer Selection Menu."
1451 (interactive)
1452 (customize-group "bs"))
1454 ;;;###autoload
1455 (defun bs-show (arg)
1456 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1458 There are many key commands similar to `Buffer-menu-mode' for
1459 manipulating the buffer list and the buffers themselves.
1460 User can move with [up] or [down], select a buffer
1464 With prefix argument ARG show a different buffer list. Function
1465 `bs--configuration-name-for-prefix-arg' determine accordingly
1466 name of buffer configuration."
1467 (interactive "P")
1468 (setq bs--marked-buffers nil)
1469 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1471 ;; ----------------------------------------------------------------------
1472 ;; Cleanup
1473 ;; ----------------------------------------------------------------------
1475 (defun bs-unload-function ()
1476 "Unload the Buffer Selection library."
1477 (let ((bs-buf (get-buffer "*buffer-selection*")))
1478 (when bs-buf
1479 (with-current-buffer bs-buf
1480 (when (eq major-mode 'bs-mode)
1481 (bs-kill)
1482 (kill-buffer bs-buf)))))
1483 ;; continue standard unloading
1484 nil)
1486 ;; Now provide feature bs
1487 (provide 'bs)
1489 ;; arch-tag: c0d9ab34-bf06-4368-ae9d-af88878e6802
1490 ;;; bs.el ends here