| blob | 75b1e4a4d429f7688c744bd781419e6b34e427c1 |
1 ;;; bs.el --- menu for selecting and displaying buffers
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 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, or (at your option)
14 ;; 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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Version: 1.17
29 ;; X-URL: http://www.geekware.de/software/emacs
30 ;;
31 ;; The bs-package contains a main function bs-show for poping up a
32 ;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
33 ;; The new buffer offers a Buffer Selection Menu for manipulating
34 ;; the buffer list and buffers.
35 ;;
36 ;; -----------------------------------------------------------------------
37 ;; | MR Buffer Size Mode File |
38 ;; | -- ------ ---- ---- ---- |
39 ;; |. bs.el 14690 Emacs-Lisp /home/sun/sylvester/el/bs.e$|
40 ;; | % executable.el 9429 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
41 ;; | % vc.el 104893 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
42 ;; | % test_vc.el 486 Emacs-Lisp /home/sun/sylvester/el/test$|
43 ;; | % vc-hooks.el 43605 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
44 ;; -----------------------------------------------------------------------
46 ;;; Quick Installation und Customization:
48 ;; Use
49 ;; M-x bs-show
50 ;; for buffer selection or optional bind a key to main function `bs-show'
51 ;; (global-set-key "\C-x\C-b" 'bs-show) ;; or another key
52 ;;
53 ;; For customization use
54 ;; M-x bs-customize
57 ;;; More Commentary:
59 ;; bs-show will generate a new buffer named *buffer-selection*, which shows
60 ;; all buffers or a subset of them, and has possibilities for deleting,
61 ;; saving and selecting buffers. For more details see docstring of
62 ;; function `bs-mode'. A current configuration describes which buffers appear
63 ;; in *buffer-selection*. See docstring of variable `bs-configurations' for
64 ;; more details.
65 ;;
66 ;; The package bs combines the advantages of the Emacs functions
67 ;; `list-buffers' and `electric-buffer-list'.
68 ;;
69 ;; Additional features for Buffer Selection Menu:
70 ;; - configurable list of buffers (show only files etc.).
71 ;; - comfortable way to change displayed subset of all buffers.
72 ;; - show sorted list of buffers.
73 ;; - cyclic navigation:
74 ;; - goes to top of buffer list if you are on last line and press down.
75 ;; - goes to end of buffer list if you are on first line and press up.
76 ;; - Offer an alternative buffer list by prefix key C-u.
78 ;;; Cycling through buffers
80 ;; This package offers two functions for buffer cycling. If you want to cycle
81 ;; through buffer list you can use `bs-cycle-next' or `bs-cycle-previous'.
82 ;; Bind these function to a key like
83 ;; (global-set-key [(f9)] 'bs-cycle-previous)
84 ;; (global-set-key [(f10)] 'bs-cycle-next)
85 ;;
86 ;; Both functions use a special subset of all buffers for cycling to avoid
87 ;; to go through internal buffers like *Messages*.
88 ;;
89 ;; Cycling through buffers ignores sorting because sorting destroys
90 ;; the logical buffer list. If buffer list is sorted by size you
91 ;; won't be able to cycle to the smallest buffer.
93 ;;; Customization:
95 ;; There is a customization group called `bs' in group `convenience'.
96 ;; Start customization by M-x bs-customize
97 ;;
98 ;; Buffer list
99 ;; -----------
100 ;; You can define your own configurations by extending variable
101 ;; `bs-configurations' (see docstring for details).
102 ;;
103 ;; `bs-default-configuration' contains the name of default configuration.
104 ;; The default value is "files" which means to show only files.
105 ;;
106 ;; If you always want to see all buffers, customize variable
107 ;; `bs-default-configuration' in customization group `bs'.
108 ;;
109 ;; Configure sorting
110 ;; -----------------
111 ;; You can define functions for sorting the buffer list.
112 ;; When selecting buffers, you can step through available sorting
113 ;; methods with key 'S'.
114 ;; To define a new way of sorting, customize variable `bs-sort-functions'.
115 ;;
116 ;; There are four basic functions for sorting:
117 ;; by buffer name, by mode, by size, or by filename
118 ;;
119 ;; Configure buffer cycling
120 ;; ------------------------
121 ;; When cycling through buffer list the functions for cycling will use
122 ;; the current configuration of bs to calculate the buffer list.
123 ;; If you want to use a different configuration for cycling you have to set
124 ;; the variable `bs-cycle-configuration-name'. You can customize this variable.
125 ;;
126 ;; For example: If you use the configuration called "files-and-scratch" you
127 ;; can cycle through all file buffers and *scratch* although your current
128 ;; configuration perhaps is "files" which ignores buffer *scratch*.
130 ;;; History:
132 ;;; 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."
388 "List of all possible sorting aspects for Buffer Selection Menu.
389 You can add a new entry with a call to `bs-define-sort-function'.
390 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE).
391 NAME specifies the sort order defined by function FUNCTION.
392 FUNCTION nil means don't sort the buffer list. Otherwise the function
393 must have two parameters - the buffers to compare.
394 REGEXP-FOR-SORTING is a regular expression which describes the
395 column title to highlight.
396 FACE is a face used to fontify the sorted column title. A value of nil means
397 don't highlight."
402 "Define a new function for buffer sorting in Buffer Selection Menu.
403 NAME specifies the sort order defined by function FUN.
404 A value of nil for FUN means don't sort the buffer list. Otherwise the
405 functions must have two parameters - the buffers to compare.
406 REGEXP-FOR-SORTING is a regular expression which describes the
407 column title to highlight.
408 FACE is a face used to fontify the sorted column title. A value of nil means
409 don't highlight.
410 The new sort aspect will be inserted into list `bs-sort-functions'."
416 bs-sort-functions)))))
419 "Description of the current function for sorting the buffer list.
423 "Name of default sort behavior.
437 "Flag whether showing all buffers regardless of current configuration.
438 Non-nil means to show all buffers. Otherwise show buffers
445 "Regular expression specifying which buffers never to show.
446 A buffer whose name matches this regular expression will never be
450 "List of buffers shown in Buffer Selection Menu.
464 (define-key map "F" 'bs-select-other-frame)
465 (let ((key ?1))
466 (while (<= key ?9)
467 (define-key map (char-to-string key) 'digit-argument)
468 (setq key (1+ key))))
469 (define-key map "-" 'negative-argument)
470 (define-key map "\e-" 'negative-argument)
471 (define-key map "o" 'bs-select-other-window)
472 (define-key map "\C-o" 'bs-tmp-select-other-window)
473 ;; for GNU EMACS
474 (define-key map [mouse-3] 'bs-mouse-select-other-frame)
475 ;; for XEmacs
476 (define-key map [button3] 'bs-mouse-select-other-frame)
477 (define-key map [up] 'bs-up)
478 (define-key map "n" 'bs-down)
479 (define-key map "p" 'bs-up)
480 (define-key map [down] 'bs-down)
481 (define-key map "\C-m" 'bs-select)
482 (define-key map "b" 'bs-bury-buffer)
483 (define-key map "s" 'bs-save)
484 (define-key map "S" 'bs-show-sorted)
485 (define-key map "a" 'bs-toggle-show-all)
486 (define-key map "d" 'bs-delete)
487 (define-key map "\C-d" 'bs-delete-backward)
488 (define-key map "k" 'bs-delete)
489 (define-key map "g" 'bs-refresh)
490 (define-key map "C" 'bs-set-configuration-and-refresh)
491 (define-key map "c" 'bs-select-next-configuration)
492 (define-key map "q" 'bs-kill)
493 ;; (define-key map "z" 'bs-kill)
494 (define-key map "\C-c\C-c" 'bs-kill)
495 (define-key map "\C-g" 'bs-abort)
496 (define-key map "\C-]" 'bs-abort)
497 (define-key map "%" 'bs-toggle-readonly)
498 (define-key map "~" 'bs-clear-modified)
499 (define-key map "M" 'bs-toggle-current-to-show)
500 (define-key map "+" 'bs-set-current-buffer-to-show-always)
501 ;;(define-key map "-" 'bs-set-current-buffer-to-show-never)
502 (define-key map "t" 'bs-visit-tags-table)
503 (define-key map "m" 'bs-mark-current)
504 (define-key map "u" 'bs-unmark-current)
505 (define-key map ">" 'scroll-right)
506 (define-key map "<" 'scroll-left)
507 (define-key map "?" 'bs-help)
508 map)
509 "Keymap of `bs-mode'.")
511 ;; ----------------------------------------------------------------------
512 ;; Functions
513 ;; ----------------------------------------------------------------------
515 (defun bs-buffer-list (&optional list sort-description)
516 "Return a list of buffers to be shown.
517 LIST is a list of buffers to test for appearance in Buffer Selection Menu.
518 The result list depends on the global variables `bs-dont-show-regexp',
519 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
520 and `bs-buffer-sort-function'.
521 If SORT-DESCRIPTION isn't nil the list will be sorted by
522 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
523 (setq sort-description (or sort-description bs--current-sort-function)
524 list (or list (buffer-list)))
525 (let ((result nil))
526 (dolist (buf list)
527 (let* ((buffername (buffer-name buf))
528 (int-show-never (string-match-p bs--intern-show-never buffername))
529 (ext-show-never (and bs-dont-show-regexp
530 (string-match-p bs-dont-show-regexp
531 buffername)))
532 (extern-must-show (or (and bs-must-always-show-regexp
533 (string-match-p
534 bs-must-always-show-regexp
535 buffername))
536 (and bs-must-show-regexp
537 (string-match-p bs-must-show-regexp
538 buffername))))
539 (extern-show-never-from-fun (and bs-dont-show-function
540 (funcall bs-dont-show-function
541 buf)))
542 (extern-must-show-from-fun (and bs-must-show-function
543 (funcall bs-must-show-function
544 buf)))
545 (show-flag (buffer-local-value 'bs-buffer-show-mark buf)))
546 (when (or (eq show-flag 'always)
547 (and (or bs--show-all (not (eq show-flag 'never)))
548 (not int-show-never)
549 (or bs--show-all
550 extern-must-show
551 extern-must-show-from-fun
552 (and (not ext-show-never)
553 (not extern-show-never-from-fun)))))
554 (setq result (cons buf result)))))
555 (setq result (reverse result))
556 ;; The current buffer which was the start point of bs should be an element
557 ;; of result list, so that we can leave with space and be back in the
558 ;; buffer we started bs-show.
559 (when (and bs--buffer-coming-from
560 (buffer-live-p bs--buffer-coming-from)
561 (not (memq bs--buffer-coming-from result)))
562 (setq result (cons bs--buffer-coming-from result)))
563 ;; sorting
564 (if (and sort-description
565 (nth 1 sort-description))
566 (setq result (sort result (nth 1 sort-description)))
567 ;; else standard sorting
568 (bs-buffer-sort result))))
570 (defun bs-buffer-sort (buffer-list)
571 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
572 (if bs-buffer-sort-function
573 (sort buffer-list bs-buffer-sort-function)
574 buffer-list))
576 (defun bs--redisplay (&optional keep-line-p sort-description)
577 "Redisplay whole Buffer Selection Menu.
578 If KEEP-LINE-P is non-nil the point will stay on current line.
579 SORT-DESCRIPTION is an element of `bs-sort-functions'."
580 (let ((line (1+ (count-lines 1 (point)))))
581 (bs-show-in-buffer (bs-buffer-list nil sort-description))
582 (when keep-line-p
583 (goto-line line))
584 (beginning-of-line)))
586 (defun bs--goto-current-buffer ()
587 "Goto line which represents the current buffer;
588 actually the line which begins with character in `bs-string-current' or
589 `bs-string-current-marked'."
590 (let ((regexp (concat "^"
591 (regexp-quote bs-string-current)
593 (regexp-quote bs-string-current-marked)))
594 point)
595 (save-excursion
596 (goto-char (point-min))
597 (when (search-forward-regexp regexp nil t)
598 (setq point (1- (point)))))
599 (when point
600 (goto-char point))))
602 (defun bs--current-config-message ()
603 "Return a string describing the current `bs-mode' configuration."
604 (if bs--show-all
605 "Show all buffers."
606 (format "Show buffer by configuration %S"
607 bs-current-configuration)))
609 (defun bs--track-window-changes (frame)
610 "Track window changes to refresh the buffer list.
611 Used from `window-size-change-functions'."
612 (let ((win (get-buffer-window "*buffer-selection*" frame)))
613 (when win
614 (with-selected-window win
615 (bs--set-window-height)))))
617 (defun bs--remove-hooks ()
618 "Remove `bs--track-window-changes' and auxiliary hooks."
619 (remove-hook 'window-size-change-functions 'bs--track-window-changes)
620 ;; Remove itself
621 (remove-hook 'kill-buffer-hook 'bs--remove-hooks t)
622 (remove-hook 'change-major-mode-hook 'bs--remove-hooks t))
624 (put 'bs-mode 'mode-class 'special)
626 (define-derived-mode bs-mode nil "Buffer-Selection-Menu"
627 "Major mode for editing a subset of Emacs' buffers.
629 Aside from two header lines each line describes one buffer.
630 Move to a line representing the buffer you want to edit and select
632 There are many key commands similar to `Buffer-menu-mode' for
633 manipulating the buffer list and buffers.
634 For faster navigation each digit key is a digit argument.
640 remain in Buffer Selection Menu.
650 apply selected configuration.
652 available Buffer Selection Menu configuration.
656 to show always.
659 (make-local-variable 'font-lock-defaults)
660 (make-local-variable 'font-lock-verbose)
661 (make-local-variable 'font-lock-global-modes)
662 (buffer-disable-undo)
663 (setq buffer-read-only t
664 truncate-lines t
665 show-trailing-whitespace nil
666 font-lock-global-modes '(not bs-mode)
667 font-lock-defaults '(bs-mode-font-lock-keywords t)
668 font-lock-verbose nil)
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 ()
702 "Refresh whole Buffer Selection Menu."
703 (interactive)
704 (bs--redisplay t))
706 (defun bs--set-window-height ()
707 "Change the height of the selected window to suit the current buffer list."
708 (unless (one-window-p t)
709 (fit-window-to-buffer (selected-window) bs-max-window-height)))
711 (defun bs--current-buffer ()
712 "Return buffer on current line.
713 Raise an error if not on a buffer line."
714 (beginning-of-line)
715 (let ((line (+ (- bs-header-lines-length)
716 (count-lines 1 (point)))))
717 (when (< line 0)
718 (error "You are on a header row"))
719 (nth line bs-current-list)))
721 (defun bs--update-current-line ()
722 "Update the entry on current line for Buffer Selection Menu."
723 (let ((buffer (bs--current-buffer))
724 (inhibit-read-only t))
725 (beginning-of-line)
726 (delete-region (point) (line-end-position))
727 (bs--insert-one-entry buffer)
728 (beginning-of-line)))
730 (defun bs-view ()
731 "View current line's buffer in View mode.
732 Leave Buffer Selection Menu."
733 (interactive)
734 (view-buffer (bs--current-buffer)))
736 (defun bs-select ()
737 "Select current line's buffer and other marked buffers.
738 If there are no marked buffers the window configuration before starting
739 Buffer Selection Menu will be restored.
740 If there are marked buffers each marked buffer and the current line's buffer
741 will be selected in a window.
742 Leave Buffer Selection Menu."
743 (interactive)
744 (let ((buffer (bs--current-buffer)))
745 (bury-buffer (current-buffer))
746 (bs--restore-window-config)
747 (switch-to-buffer buffer)
748 (when bs--marked-buffers
749 ;; Some marked buffers for selection
750 (let* ((all (delq buffer bs--marked-buffers))
751 (height (/ (1- (frame-height)) (1+ (length all)))))
752 (delete-other-windows)
753 (switch-to-buffer buffer)
754 (dolist (buf all)
755 (split-window nil height)
756 (other-window 1)
757 (switch-to-buffer buf))
758 ;; goto window we have started bs.
759 (other-window 1)))))
761 (defun bs-select-other-window ()
762 "Select current line's buffer by `switch-to-buffer-other-window'.
763 The window configuration before starting Buffer Selection Menu will be restored
764 unless there is no other window. In this case a new window will be created.
765 Leave Buffer Selection Menu."
766 (interactive)
767 (let ((buffer (bs--current-buffer)))
768 (bury-buffer (current-buffer))
769 (bs--restore-window-config)
770 (switch-to-buffer-other-window buffer)))
772 (defun bs-tmp-select-other-window ()
773 "Make the other window select this line's buffer.
774 The current window remains selected."
775 (interactive)
776 (let ((buffer (bs--current-buffer)))
777 (display-buffer buffer t)))
779 (defun bs-select-other-frame ()
780 "Select current line's buffer in new created frame.
781 Leave Buffer Selection Menu."
782 (interactive)
783 (let ((buffer (bs--current-buffer)))
784 (bury-buffer (current-buffer))
785 (bs--restore-window-config)
786 (switch-to-buffer-other-frame buffer)))
788 (defun bs-mouse-select-other-frame (event)
789 "Select selected line's buffer in new created frame.
790 Leave Buffer Selection Menu.
791 EVENT: a mouse click event."
792 (interactive "e")
793 (mouse-set-point event)
794 (bs-select-other-frame))
796 (defun bs-mouse-select (event)
797 "Select buffer on mouse click EVENT.
798 Select buffer by `bs-select'."
799 (interactive "e")
800 (mouse-set-point event)
801 (bs-select))
803 (defun bs-select-in-one-window ()
804 "Select current line's buffer in one window and delete other windows.
805 Leave Buffer Selection Menu."
806 (interactive)
807 (bs-select)
808 (delete-other-windows))
810 (defun bs-bury-buffer ()
811 "Bury buffer on current line."
812 (interactive)
813 (bury-buffer (bs--current-buffer))
814 (bs--redisplay t))
816 (defun bs-save ()
817 "Save buffer on current line."
818 (interactive)
819 (let ((buffer (bs--current-buffer)))
820 (save-excursion
821 (set-buffer buffer)
822 (save-buffer))
823 (bs--update-current-line)))
825 (defun bs-visit-tags-table ()
826 "Visit the tags table in the buffer on this line.
827 See `visit-tags-table'."
828 (interactive)
829 (let ((file (buffer-file-name (bs--current-buffer))))
830 (if file
831 (visit-tags-table file)
832 (error "Specified buffer has no file"))))
834 (defun bs-toggle-current-to-show ()
835 "Toggle status of showing flag for buffer in current line."
836 (interactive)
837 (let ((buffer (bs--current-buffer))
838 res)
839 (save-excursion
840 (set-buffer buffer)
841 (setq res (cond ((null bs-buffer-show-mark)
842 'never)
843 ((eq bs-buffer-show-mark 'never)
844 'always)
845 (t nil)))
846 (setq bs-buffer-show-mark res))
847 (bs--update-current-line)
848 (bs--set-window-height)
849 (bs--show-config-message res)))
851 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
852 "Toggle status of buffer on line to `always shown'.
853 NOT-TO-SHOW-P: prefix argument.
854 With no prefix argument the buffer on current line is marked to show
855 always. Otherwise it is marked to show never."
856 (interactive "P")
857 (if not-to-show-p
858 (bs-set-current-buffer-to-show-never)
859 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
861 (defun bs-set-current-buffer-to-show-never ()
862 "Toggle status of buffer on line to `never shown'."
863 (interactive)
864 (bs--set-toggle-to-show (bs--current-buffer) 'never))
866 (defun bs--set-toggle-to-show (buffer what)
867 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
868 Redisplay current line and display a message describing
869 the status of buffer on current line."
870 (with-current-buffer buffer (setq bs-buffer-show-mark what))
871 (bs--update-current-line)
872 (bs--set-window-height)
873 (bs--show-config-message what))
875 (defun bs--mark-unmark (count fun)
876 "Call FUN on COUNT consecutive buffers of *buffer-selection*."
877 (let ((dir (if (> count 0) 1 -1)))
878 (dotimes (i (abs count))
879 (let ((buffer (bs--current-buffer)))
880 (when buffer (funcall fun buffer))
881 (bs--update-current-line)
882 (bs-down dir)))))
884 (defun bs-mark-current (count)
885 "Mark buffers.
886 COUNT is the number of buffers to mark.
887 Move cursor vertically down COUNT lines."
888 (interactive "p")
889 (bs--mark-unmark count
890 (lambda (buf)
891 (add-to-list 'bs--marked-buffers buf))))
893 (defun bs-unmark-current (count)
894 "Unmark buffers.
895 COUNT is the number of buffers to unmark.
896 Move cursor vertically down COUNT lines."
897 (interactive "p")
898 (bs--mark-unmark count
899 (lambda (buf)
900 (setq bs--marked-buffers (delq buf bs--marked-buffers)))))
902 (defun bs--show-config-message (what)
903 "Show message indicating the new showing status WHAT.
904 WHAT is a value of nil, `never', or `always'."
905 (bs-message-without-log (cond ((null what)
906 "Buffer will be shown normally.")
907 ((eq what 'never)
908 "Mark buffer to never be shown.")
909 (t "Mark buffer to show always."))))
911 (defun bs-delete ()
912 "Kill buffer on current line."
913 (interactive)
914 (let ((current (bs--current-buffer))
915 (inhibit-read-only t))
916 (unless (kill-buffer current)
917 (error "Buffer was not deleted"))
918 (setq bs-current-list (delq current bs-current-list))
919 (beginning-of-line)
920 (delete-region (point) (save-excursion
921 (end-of-line)
922 (if (eobp) (point) (1+ (point)))))
923 (when (eobp)
924 (backward-delete-char 1)
925 (beginning-of-line)
926 (recenter -1))
927 (bs--set-window-height)))
929 (defun bs-delete-backward ()
930 "Like `bs-delete' but go to buffer in front of current."
931 (interactive)
932 (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
933 (bs-delete)
934 (unless on-last-line-p
935 (bs-up 1))))
937 (defun bs-show-sorted ()
938 "Show buffer list sorted by next sort aspect."
939 (interactive)
940 (setq bs--current-sort-function
941 (bs-next-config-aux (car bs--current-sort-function)
942 bs-sort-functions))
943 (bs--redisplay)
944 (bs--goto-current-buffer)
945 (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))
947 (defun bs-apply-sort-faces (&optional sort-description)
948 "Set text properties for the sort described by SORT-DESCRIPTION.
949 SORT-DESCRIPTION is an element of `bs-sort-functions'.
950 Default is `bs--current-sort-function'."
951 (let ((sort-description (or sort-description
952 bs--current-sort-function)))
953 (save-excursion
954 (goto-char (point-min))
955 (when (and (nth 2 sort-description)
956 (search-forward-regexp (nth 2 sort-description) nil t))
957 (let ((inhibit-read-only t))
958 (put-text-property (match-beginning 0)
959 (match-end 0)
960 'face
961 (or (nth 3 sort-description)
962 'region)))))))
964 (defun bs-toggle-show-all ()
965 "Toggle show all buffers / show buffers with current configuration."
966 (interactive)
967 (setq bs--show-all (not bs--show-all))
968 (bs--redisplay)
969 (bs--goto-current-buffer)
970 (bs-message-without-log "%s" (bs--current-config-message)))
972 (defun bs-toggle-readonly ()
973 "Toggle read-only status for buffer on current line.
974 Uses function `vc-toggle-read-only'."
975 (interactive)
976 (let ((buffer (bs--current-buffer)))
977 (save-excursion
978 (set-buffer buffer)
979 (vc-toggle-read-only))
980 (bs--update-current-line)))
982 (defun bs-clear-modified ()
983 "Set modified flag for buffer on current line to nil."
984 (interactive)
985 (let ((buffer (bs--current-buffer)))
986 (save-excursion
987 (set-buffer buffer)
988 (set-buffer-modified-p nil)))
989 (bs--update-current-line))
991 (defun bs--nth-wrapper (count fun &rest args)
992 "Call COUNT times function FUN with arguments ARGS."
993 (dotimes (i (or count 1))
994 (apply fun args)))
996 (defun bs-up (arg)
997 "Move cursor vertically up ARG lines in Buffer Selection Menu."
998 (interactive "p")
999 (if (and arg (numberp arg) (< arg 0))
1000 (bs--nth-wrapper (- arg) 'bs--down)
1001 (bs--nth-wrapper arg 'bs--up)))
1003 (defun bs--up ()
1004 "Move cursor vertically up one line.
1005 If on top of buffer list go to last line."
1006 (if (> (count-lines 1 (point)) bs-header-lines-length)
1007 (forward-line -1)
1008 (goto-char (point-max))
1009 (beginning-of-line)
1010 (recenter -1)))
1012 (defun bs-down (arg)
1013 "Move cursor vertically down ARG lines in Buffer Selection Menu."
1014 (interactive "p")
1015 (if (and arg (numberp arg) (< arg 0))
1016 (bs--nth-wrapper (- arg) 'bs--up)
1017 (bs--nth-wrapper arg 'bs--down)))
1019 (defun bs--down ()
1020 "Move cursor vertically down one line.
1021 If at end of buffer list go to first line."
1022 (if (eq (line-end-position) (point-max))
1023 (goto-line (1+ bs-header-lines-length))
1024 (forward-line 1)))
1026 (defun bs-visits-non-file (buffer)
1027 "Return whether BUFFER visits no file.
1028 A value of t means BUFFER belongs to no file.
1029 A value of nil means BUFFER belongs to a file."
1030 (not (buffer-file-name buffer)))
1032 (defun bs-sort-buffer-interns-are-last (b1 b2)
1033 "Function for sorting internal buffers at the end of all buffers."
1036 ;; ----------------------------------------------------------------------
1037 ;; Configurations:
1038 ;; ----------------------------------------------------------------------
1040 (defun bs-config-clear ()
1041 "Reset all variables which specify a configuration.
1042 These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
1043 `bs-dont-show-function', `bs-must-show-function' and
1044 `bs-buffer-sort-function'."
1045 (setq bs-dont-show-regexp nil
1046 bs-must-show-regexp nil
1047 bs-dont-show-function nil
1048 bs-must-show-function nil
1049 bs-buffer-sort-function nil))
1051 (defun bs-config--only-files ()
1052 "Define a configuration for showing only buffers visiting a file."
1053 (bs-config-clear)
1054 (setq ;; I want to see *-buffers at the end
1055 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1056 ;; Don't show files who don't belong to a file
1057 bs-dont-show-function 'bs-visits-non-file))
1059 (defun bs-config--files-and-scratch ()
1060 "Define a configuration for showing buffer *scratch* and file buffers."
1061 (bs-config-clear)
1062 (setq ;; I want to see *-buffers at the end
1063 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1064 ;; Don't show files who don't belong to a file
1065 bs-dont-show-function 'bs-visits-non-file
1066 ;; Show *scratch* buffer.
1069 (defun bs-config--all ()
1070 "Define a configuration for showing all buffers.
1071 Reset all according variables by `bs-config-clear'."
1072 (bs-config-clear))
1074 (defun bs-config--all-intern-last ()
1075 "Define a configuration for showing all buffers.
1076 Internal buffers appear at end of all buffers."
1077 (bs-config-clear)
1078 ;; I want to see *-buffers at the end
1079 (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))
1081 (defun bs-set-configuration (name)
1082 "Set configuration to the one saved under string NAME in `bs-configurations'.
1083 When called interactively ask user for a configuration and apply selected
1084 configuration."
1085 (interactive (list (completing-read "Use configuration: "
1086 bs-configurations
1087 nil
1088 t)))
1089 (let ((list (assoc name bs-configurations)))
1090 (if list
1091 (if (listp list)
1092 (setq bs-current-configuration name
1093 bs-must-show-regexp (nth 1 list)
1094 bs-must-show-function (nth 2 list)
1095 bs-dont-show-regexp (nth 3 list)
1096 bs-dont-show-function (nth 4 list)
1097 bs-buffer-sort-function (nth 5 list))
1098 ;; for backward compability
1099 (funcall (cdr list)))
1100 ;; else
1101 (ding)
1102 (bs-message-without-log "No bs-configuration named %S." name))))
1104 (defun bs-help ()
1105 "Help for `bs-show'."
1106 (interactive)
1107 (describe-function 'bs-mode))
1109 (defun bs-next-config-aux (start-name list)
1110 "Get the next assoc after START-NAME in list LIST.
1111 Will return the first if START-NAME is at end."
1112 (let ((assocs list)
1113 (length (length list))
1114 pos)
1115 (while (and assocs (not pos))
1116 (when (string= (car (car assocs)) start-name)
1117 (setq pos (- length (length assocs))))
1118 (setq assocs (cdr assocs)))
1119 (setq pos (1+ pos))
1120 (if (eq pos length)
1121 (car list)
1122 (nth pos list))))
1124 (defun bs-next-config (name)
1125 "Return next configuration with respect to configuration with name NAME."
1126 (bs-next-config-aux name bs-configurations))
1128 (defun bs-select-next-configuration (&optional start-name)
1129 "Apply next configuration START-NAME and refresh buffer list.
1130 If START-NAME is nil the current configuration `bs-current-configuration'
1131 will be used."
1132 (interactive)
1133 (let ((config (bs-next-config (or start-name bs-current-configuration))))
1134 (bs-set-configuration (car config))
1135 (setq bs-default-configuration bs-current-configuration)
1136 (bs--redisplay t)
1137 (bs--set-window-height)
1138 (bs-message-without-log "Selected configuration: %s" (car config))))
1140 (defun bs-show-in-buffer (list)
1141 "Display buffer list LIST in buffer *buffer-selection*.
1142 Select buffer *buffer-selection* and display buffers according to current
1143 configuration `bs-current-configuration'. Set window height, fontify buffer
1144 and move point to current buffer."
1145 (setq bs-current-list list)
1146 (switch-to-buffer (get-buffer-create "*buffer-selection*"))
1147 (bs-mode)
1148 (let* ((inhibit-read-only t)
1149 (map-fun (lambda (entry)
1150 (length (buffer-name entry))))
1151 (max-length-of-names (apply 'max
1152 (cons 0 (mapcar map-fun list))))
1153 (name-entry-length (min bs-maximal-buffer-name-column
1154 (max bs-minimal-buffer-name-column
1155 max-length-of-names))))
1156 (erase-buffer)
1157 (setq bs--name-entry-length name-entry-length)
1158 (bs--show-header)
1159 (dolist (buffer list)
1160 (bs--insert-one-entry buffer)
1162 (delete-backward-char 1)
1163 (bs--set-window-height)
1164 (bs--goto-current-buffer)
1165 (font-lock-fontify-buffer)
1166 (bs-apply-sort-faces)
1167 (set-buffer-modified-p nil)))
1169 (defun bs-next-buffer (&optional buffer-list sorting-p)
1170 "Return next buffer and buffer list for buffer cycling in BUFFER-LIST.
1171 Ignore sorting when SORTING-P is nil.
1172 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1173 buffer list. The result is a cons of normally the second element of
1174 BUFFER-LIST and the buffer list used for buffer cycling."
1175 (let* ((bs--current-sort-function (if sorting-p
1176 bs--current-sort-function))
1177 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1178 (cons (or (car (cdr bs-buffer-list))
1179 (car bs-buffer-list)
1180 (current-buffer))
1181 bs-buffer-list)))
1183 (defun bs-previous-buffer (&optional buffer-list sorting-p)
1184 "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST.
1185 Ignore sorting when SORTING-P is nil.
1186 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1187 buffer list. The result is a cons of last element of BUFFER-LIST and the
1188 buffer list used for buffer cycling."
1189 (let* ((bs--current-sort-function (if sorting-p
1190 bs--current-sort-function))
1191 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1192 (cons (or (car (last bs-buffer-list))
1193 (current-buffer))
1194 bs-buffer-list)))
1196 (defun bs-message-without-log (&rest args)
1197 "Like `message' but don't log it on the message log.
1198 All arguments ARGS are transferred to function `message'."
1199 (let ((message-log-max nil))
1200 (apply 'message args)))
1202 (defvar bs--cycle-list nil
1203 "Current buffer list used for cycling.")
1205 ;;;###autoload
1206 (defun bs-cycle-next ()
1207 "Select next buffer defined by buffer cycling.
1208 The buffers taking part in buffer cycling are defined
1209 by buffer configuration `bs-cycle-configuration-name'."
1210 (interactive)
1211 (let ((bs--buffer-coming-from (current-buffer))
1212 (bs-dont-show-regexp bs-dont-show-regexp)
1213 (bs-must-show-regexp bs-must-show-regexp)
1214 (bs-dont-show-function bs-dont-show-function)
1215 (bs-must-show-function bs-must-show-function)
1216 (bs--show-all nil))
1217 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1218 (let ((bs-buffer-sort-function nil)
1219 (bs--current-sort-function nil))
1220 (let* ((tupel (bs-next-buffer (if (or (eq last-command
1221 'bs-cycle-next)
1222 (eq last-command
1223 'bs-cycle-previous))
1224 bs--cycle-list)))
1225 (next (car tupel))
1226 (cycle-list (cdr tupel)))
1227 (unless (window-dedicated-p (selected-window))
1228 ;; We don't want the frame iconified if the only window in the frame
1229 ;; happens to be dedicated; let's get the error from switch-to-buffer
1230 (bury-buffer))
1231 (switch-to-buffer next)
1232 (setq bs--cycle-list (append (cdr cycle-list)
1233 (list (car cycle-list))))
1234 (bs-message-without-log "Next buffers: %s"
1235 (or (cdr bs--cycle-list)
1236 "this buffer"))))))
1238 ;;;###autoload
1239 (defun bs-cycle-previous ()
1240 "Select previous buffer defined by buffer cycling.
1241 The buffers taking part in buffer cycling are defined
1242 by buffer configuration `bs-cycle-configuration-name'."
1243 (interactive)
1244 (let ((bs--buffer-coming-from (current-buffer))
1245 (bs-dont-show-regexp bs-dont-show-regexp)
1246 (bs-must-show-regexp bs-must-show-regexp)
1247 (bs-dont-show-function bs-dont-show-function)
1248 (bs-must-show-function bs-must-show-function)
1249 (bs--show-all nil))
1250 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1251 (let ((bs-buffer-sort-function nil)
1252 (bs--current-sort-function nil))
1253 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1254 'bs-cycle-next)
1255 (eq last-command
1256 'bs-cycle-previous))
1257 bs--cycle-list)))
1258 (prev-buffer (car tupel))
1259 (cycle-list (cdr tupel)))
1260 (switch-to-buffer prev-buffer)
1261 (setq bs--cycle-list (append (last cycle-list)
1262 (reverse (cdr (reverse cycle-list)))))
1263 (bs-message-without-log "Previous buffers: %s"
1264 (or (reverse (cdr bs--cycle-list))
1265 "this buffer"))))))
1267 (defun bs--get-value (fun &optional args)
1268 "Apply function FUN with arguments ARGS.
1269 Return result of evaluation. Will return FUN if FUN is a number
1270 or a string."
1271 (cond ((numberp fun)
1272 fun)
1273 ((stringp fun)
1274 fun)
1275 (t (apply fun args))))
1277 (defun bs--get-marked-string (start-buffer all-buffers)
1278 "Return a string which describes whether current buffer is marked.
1279 START-BUFFER is the buffer where we started buffer selection.
1280 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu.
1281 The result string is one of `bs-string-current', `bs-string-current-marked',
1282 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1283 `bs-string-show-always'."
1284 (cond ;; current buffer is the buffer we started buffer selection.
1285 ((eq (current-buffer) start-buffer)
1286 (if (memq (current-buffer) bs--marked-buffers)
1287 bs-string-current-marked ; buffer is marked
1288 bs-string-current))
1289 ;; current buffer is marked
1290 ((memq (current-buffer) bs--marked-buffers)
1291 bs-string-marked)
1292 ;; current buffer hasn't a special mark.
1293 ((null bs-buffer-show-mark)
1294 bs-string-show-normally)
1295 ;; current buffer has a mark not to show itself.
1296 ((eq bs-buffer-show-mark 'never)
1297 bs-string-show-never)
1298 ;; otherwise current buffer is marked to show always.
1299 (t
1300 bs-string-show-always)))
1302 (defun bs--get-modified-string (start-buffer all-buffers)
1303 "Return a string which describes whether current buffer is modified.
1304 START-BUFFER is the buffer where we started buffer selection.
1305 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1306 (if (buffer-modified-p) "*" " "))
1308 (defun bs--get-readonly-string (start-buffer all-buffers)
1309 "Return a string which describes whether current buffer is read only.
1310 START-BUFFER is the buffer where we started buffer selection.
1311 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1312 (if buffer-read-only "%" " "))
1314 (defun bs--get-size-string (start-buffer all-buffers)
1315 "Return a string which describes the size of current buffer.
1316 START-BUFFER is the buffer where we started buffer selection.
1317 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1318 (int-to-string (buffer-size)))
1320 (defun bs--get-name (start-buffer all-buffers)
1321 "Return name of current buffer for Buffer Selection Menu.
1322 The name of current buffer gets additional text properties
1323 for mouse highlighting.
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 (propertize (buffer-name)
1327 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"
1328 'mouse-face 'highlight))
1330 (defun bs--get-mode-name (start-buffer all-buffers)
1331 "Return the name of mode of current buffer for Buffer Selection Menu.
1332 START-BUFFER is the buffer where we started buffer selection.
1333 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1334 (format-mode-line mode-name nil nil start-buffer))
1336 (defun bs--get-file-name (start-buffer all-buffers)
1337 "Return string for column 'File' in Buffer Selection Menu.
1338 This is the variable `buffer-file-name' of current buffer.
1339 If current mode is `dired-mode' or `shell-mode' it returns the
1340 default directory.
1341 START-BUFFER is the buffer where we started buffer selection.
1342 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1343 (propertize (if (member major-mode '(shell-mode dired-mode))
1344 default-directory
1345 (or buffer-file-name ""))
1346 'mouse-face 'highlight
1347 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"))
1349 (defun bs--insert-one-entry (buffer)
1350 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1351 It goes over all columns described in `bs-attributes-list'
1352 and evaluates corresponding string. Inserts string in current buffer;
1353 normally *buffer-selection*."
1354 (let ((string "")
1355 (to-much 0)
1356 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1357 (save-excursion
1358 (set-buffer buffer)
1359 (dolist (column bs-attributes-list)
1360 (let* ((min (bs--get-value (nth 1 column)))
1361 (new-string (bs--format-aux (bs--get-value (nth 4 column) ; fun
1362 apply-args)
1363 (nth 3 column) ; align
1364 (- min to-much)))
1365 (len (length new-string)))
1366 (setq string (concat string new-string))
1367 (when (> len min)
1368 (setq to-much (- len min))))))
1369 (insert string)))
1371 (defun bs--format-aux (string align len)
1372 "Pad STRING to length LEN with alignment ALIGN.
1373 ALIGN is one of the symbols `left', `middle', or `right'."
1374 (let* ((width (length string))
1375 (len (max len width)))
1376 (format (format "%%%s%ds" (if (eq align 'right) "" "-") len)
1377 (if (eq align 'middle)
1378 (concat (make-string (/ (- len width) 2) ?\s) string)
1379 string))))
1381 (defun bs--show-header ()
1382 "Insert header for Buffer Selection Menu in current buffer."
1383 (insert (bs--create-header-line #'identity)
1385 (bs--create-header-line (lambda (title)
1386 (make-string (length title) ?-)))
1389 (defun bs--get-name-length ()
1390 "Return value of `bs--name-entry-length'."
1391 bs--name-entry-length)
1393 (defun bs--create-header-line (col)
1394 "Generate a line for the header.
1395 COL is called for each column in `bs-attributes-list' as a
1396 function of one argument, the string heading for the column."
1397 (mapconcat (lambda (column)
1398 (bs--format-aux (funcall col (bs--get-value (car column)))
1399 (nth 3 column) ; align
1400 (bs--get-value (nth 1 column))))
1401 bs-attributes-list
1402 ""))
1404 (defun bs--show-with-configuration (name &optional arg)
1405 "Display buffer list of configuration with name NAME.
1406 Set configuration NAME and determine window for Buffer Selection Menu.
1407 Unless current buffer is buffer *buffer-selection* we have to save
1408 the buffer we started Buffer Selection Menu and the current window
1409 configuration to restore buffer and window configuration after a
1410 selection. If there is already a window displaying *buffer-selection*
1411 select this window for Buffer Selection Menu. Otherwise open a new
1412 window.
1413 The optional argument ARG is the prefix argument when calling a function
1414 for buffer selection."
1415 (bs-set-configuration name)
1416 (let ((bs--show-all (or bs--show-all arg)))
1417 (unless (string= "*buffer-selection*" (buffer-name))
1418 ;; Only when not in buffer *buffer-selection*
1419 ;; we have to set the buffer we started the command
1420 (setq bs--buffer-coming-from (current-buffer)))
1421 (let ((liste (bs-buffer-list))
1422 (active-window (get-window-with-predicate
1423 (lambda (w)
1424 (string= (buffer-name (window-buffer w))
1425 "*buffer-selection*"))
1426 nil (selected-frame))))
1427 (if active-window
1428 (select-window active-window)
1429 (bs--restore-window-config)
1430 (setq bs--window-config-coming-from (current-window-configuration))
1431 (when (> (window-height (selected-window)) 7)
1432 (split-window-vertically)
1433 (other-window 1)))
1434 (bs-show-in-buffer liste)
1435 (bs-message-without-log "%s" (bs--current-config-message)))))
1437 (defun bs--configuration-name-for-prefix-arg (prefix-arg)
1438 "Convert prefix argument PREFIX-ARG to a name of a buffer configuration.
1439 If PREFIX-ARG is nil return `bs-default-configuration'.
1440 If PREFIX-ARG is an integer return PREFIX-ARG element of `bs-configurations'.
1441 Otherwise return `bs-alternative-configuration'."
1442 (cond ;; usually activation
1443 ((null prefix-arg)
1444 bs-default-configuration)
1445 ;; call with integer as prefix argument
1446 ((integerp prefix-arg)
1447 (if (and (< 0 prefix-arg) (<= prefix-arg (length bs-configurations)))
1448 (car (nth (1- prefix-arg) bs-configurations))
1449 bs-default-configuration))
1450 ;; call by prefix argument C-u
1451 (t bs-alternative-configuration)))
1453 ;; ----------------------------------------------------------------------
1454 ;; Main function bs-customize and bs-show
1455 ;; ----------------------------------------------------------------------
1457 ;;;###autoload
1458 (defun bs-customize ()
1459 "Customization of group bs for Buffer Selection Menu."
1460 (interactive)
1461 (customize-group "bs"))
1463 ;;;###autoload
1464 (defun bs-show (arg)
1465 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1467 There are many key commands similar to `Buffer-menu-mode' for
1468 manipulating the buffer list and the buffers themselves.
1469 User can move with [up] or [down], select a buffer
1473 With prefix argument ARG show a different buffer list. Function
1474 `bs--configuration-name-for-prefix-arg' determine accordingly
1475 name of buffer configuration."
1476 (interactive "P")
1477 (setq bs--marked-buffers nil)
1478 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1480 ;; Now provide feature bs
1481 (provide 'bs)
1483 ;; arch-tag: c0d9ab34-bf06-4368-ae9d-af88878e6802
1484 ;;; bs.el ends here