1 ;;; bs.el --- menu for selecting and displaying buffers
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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)
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.
29 ;; X-URL: http://www.geekware.de/software/emacs
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.
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:
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
53 ;; For customization use
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
66 ;; The package bs combines the advantages of the Emacs functions
67 ;; `list-buffers' and `electric-buffer-list'.
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)
86 ;; Both functions use a special subset of all buffers for cycling to avoid
87 ;; to go through internal buffers like *Messages*.
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.
95 ;; There is a customization group called `bs' in group `convenience'.
96 ;; Start customization by M-x bs-customize
100 ;; You can define your own configurations by extending variable
101 ;; `bs-configurations' (see docstring for details).
103 ;; `bs-default-configuration' contains the name of default configuration.
104 ;; The default value is "files" which means to show only files.
106 ;; If you always want to see all buffers, customize variable
107 ;; `bs-default-configuration' in customization group `bs'.
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'.
116 ;; There are four basic functions for sorting:
117 ;; by buffer name, by mode, by size, or by filename
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.
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*.
134 ;; ----------------------------------------------------------------------
135 ;; Globals for customization
136 ;; ----------------------------------------------------------------------
139 "Buffer Selection: Maintaining buffers by buffer menu."
141 :link '(emacs-commentary-link "bs")
142 :link '(url-link "http://www.geekware.de/software/emacs")
145 (defgroup bs-appearance nil
146 "Buffer Selection appearance: Appearance of bs buffer menu."
149 (defcustom bs-attributes-list
150 '(("" 1 1 left bs--get-marked-string)
151 ("M" 1 1 left bs--get-modified-string)
152 ("R" 2 2 left bs--get-readonly-string)
153 ("Buffer" bs--get-name-length 10 left bs--get-name)
155 ("Size" 8 8 right bs--get-size-string)
157 ("Mode" 12 12 right bs--get-mode-name)
159 ("File" 12 12 left bs--get-file-name)
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)
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."
178 :group 'bs-appearance
179 :type '(repeat sexp))
181 (defun bs--make-header-match-string ()
182 "Return a regexp matching the first line of a Buffer Selection Menu buffer."
184 (ele bs-attributes-list))
186 (setq res (concat res (car (car ele)) " *"))
187 (setq ele (cdr ele)))
188 (concat res "$\\)")))
190 ;; Font-Lock-Settings
191 (defvar bs-mode-font-lock-keywords
192 (list ;; header in font-lock-type-face
193 (list (bs--make-header-match-string)
194 '(1 font-lock-type-face append) '(1 'bold append))
195 ;; Buffername embedded by *
196 (list "^\\(.*\\*.*\\*.*\\)$"
198 ;; problem in XEmacs with font-lock-constant-face
199 (if (facep 'font-lock-constant-face)
200 'font-lock-constant-face
201 'font-lock-comment-face))
203 '("^..\\(.*Dired by .*\\)$" 1 font-lock-function-name-face)
204 ;; the star for modified buffers
205 '("^.\\(\\*\\) +[^\\*]" 1 font-lock-comment-face))
206 "Default font lock expressions for Buffer Selection Menu.")
208 (defcustom bs-max-window-height 20
209 "*Maximal window height of Buffer Selection Menu."
210 :group 'bs-appearance
213 (defvar bs-dont-show-regexp nil
214 "Regular expression specifying which buffers not to show.
215 A buffer whose name matches this regular expression will not be
216 included in the buffer list.")
218 (defvar bs-must-show-regexp nil
219 "Regular expression for specifying buffers which must be shown.
220 A buffer whose name matches this regular expression will be
221 included in the buffer list.
222 Note that this variable is temporary: if the configuration is changed
223 it is reset to nil. Use `bs-must-always-show-regexp' to specify buffers
224 that must always be shown regardless of the configuration.")
226 (defcustom bs-must-always-show-regexp nil
227 "*Regular expression for specifying buffers to show always.
228 A buffer whose name matches this regular expression will
229 be shown regardless of current configuration of Buffer Selection Menu."
231 :type '(choice (const :tag "Nothing at all" nil) regexp))
233 (defvar bs-dont-show-function nil
234 "Function for specifying buffers not to show.
235 The function gets one argument - the buffer to test. The function must
236 return a value different from nil to ignore the buffer in
237 Buffer Selection Menu.")
239 (defvar bs-must-show-function nil
240 "Function for specifying buffers which must be shown.
241 The function gets one argument - the buffer to test.")
243 (defvar bs-buffer-sort-function nil
244 "Sort function to sort the buffers that appear in Buffer Selection Menu.
245 The function gets two arguments - the buffers to compare.
246 It must return non-nil if the first buffer should sort before the second.")
248 (defcustom bs-maximal-buffer-name-column 45
249 "*Maximum column width for buffer names.
250 The column for buffer names has dynamic width. The width depends on
251 maximal and minimal length of names of buffers to show. The maximal
252 width is bounded by `bs-maximal-buffer-name-column'.
253 See also `bs-minimal-buffer-name-column'."
254 :group 'bs-appearance
257 (defcustom bs-minimal-buffer-name-column 15
258 "*Minimum column width for buffer names.
259 The column for buffer names has dynamic width. The width depends on
260 maximal and minimal length of names of buffers to show. The minimal
261 width is bounded by `bs-minimal-buffer-name-column'.
262 See also `bs-maximal-buffer-name-column'."
263 :group 'bs-appearance
266 (defconst bs-header-lines-length 2
267 "Number of lines for headers in Buffer Selection Menu.")
269 (defcustom bs-configurations
270 '(("all" nil nil nil nil nil)
271 ("files" nil nil nil bs-visits-non-file bs-sort-buffer-interns-are-last)
272 ("files-and-scratch" "^\\*scratch\\*$" nil nil bs-visits-non-file
273 bs-sort-buffer-interns-are-last)
274 ("all-intern-last" nil nil nil nil bs-sort-buffer-interns-are-last))
275 "*List of all configurations you can use in the Buffer Selection Menu.
276 A configuration describes which buffers appear in Buffer Selection Menu
277 and also the order of buffers. A configuration is a list with
278 six elements. The first element is a string and describes the configuration.
279 The following five elements represent the values for Buffer Selection Menu
280 configuration variables `bs-must-show-regexp', `bs-must-show-function',
281 `bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'.
282 By setting these variables you define a configuration."
283 :group 'bs-appearance
284 :type '(repeat sexp))
286 (defcustom bs-default-configuration "files"
287 "*Name of default configuration used by the Buffer Selection Menu.
289 Will be changed using key \\[bs-select-next-configuration].
290 Must be a string used in `bs-configurations' for naming a configuration."
294 (defcustom bs-alternative-configuration "all"
295 "*Name of configuration used when calling `bs-show' with \
296 \\[universal-argument] as prefix key.
297 Must be a string used in `bs-configurations' for naming a configuration."
301 (defvar bs-current-configuration bs-default-configuration
302 "Name of current configuration.
303 Must be a string used in `bs-configurations' for naming a configuration.")
305 (defcustom bs-cycle-configuration-name nil
306 "*Name of configuration used when cycling through the buffer list.
307 A value of nil means to use current configuration `bs-default-configuration'.
308 Must be a string used in `bs-configurations' for naming a configuration."
310 :type '(choice (const :tag "like current configuration" nil)
313 (defcustom bs-string-show-always "+"
314 "*String added in column 1 indicating a buffer will always be shown."
315 :group 'bs-appearance
318 (defcustom bs-string-show-never "-"
319 "*String added in column 1 indicating a buffer will never be shown."
320 :group 'bs-appearance
323 (defcustom bs-string-current "."
324 "*String added in column 1 indicating the current buffer."
325 :group 'bs-appearance
328 (defcustom bs-string-current-marked "#"
329 "*String added in column 1 indicating the current buffer when it is marked."
330 :group 'bs-appearance
333 (defcustom bs-string-marked ">"
334 "*String added in column 1 indicating a marked buffer."
335 :group 'bs-appearance
338 (defcustom bs-string-show-normally " "
339 "*String added in column 1 indicating an unmarked buffer."
340 :group 'bs-appearance
343 (defvar bs--name-entry-length 20
344 "Maximum length of all displayed buffer names.
345 Used internally, only.")
347 ;; ----------------------------------------------------------------------
349 ;; ----------------------------------------------------------------------
351 (defvar bs-buffer-show-mark nil
352 "Flag for the current mode for showing this buffer.
353 A value of nil means buffer will be shown depending on the current
355 A value of `never' means to never show the buffer.
356 A value of `always' means to show buffer regardless of the configuration.")
358 (make-variable-buffer-local 'bs-buffer-show-mark)
360 ;; Make face named region (for XEmacs)
361 (unless (facep 'region)
363 (set-face-background 'region "gray75"))
365 (defun bs--sort-by-name (b1 b2)
366 "Compare buffers B1 and B2 by buffer name."
367 (string< (buffer-name b1)
370 (defun bs--sort-by-filename (b1 b2)
371 "Compare buffers B1 and B2 by file name."
372 (string< (or (buffer-file-name b1) "")
373 (or (buffer-file-name b2) "")))
375 (defun bs--sort-by-mode (b1 b2)
376 "Compare buffers B1 and B2 by mode name."
378 (string< (progn (set-buffer b1) (format "%s" mode-name))
379 (progn (set-buffer b2) (format "%s" mode-name)))))
381 (defun bs--sort-by-size (b1 b2)
382 "Compare buffers B1 and B2 by buffer size."
384 (< (progn (set-buffer b1) (buffer-size))
385 (progn (set-buffer b2) (buffer-size)))))
387 (defcustom bs-sort-functions
388 '(("by name" bs--sort-by-name "Buffer" region)
389 ("by size" bs--sort-by-size "Size" region)
390 ("by mode" bs--sort-by-mode "Mode" region)
391 ("by filename" bs--sort-by-filename "File" region)
392 ("by nothing" nil nil nil))
393 "*List of all possible sorting aspects for Buffer Selection Menu.
394 You can add a new entry with a call to `bs-define-sort-function'.
395 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE).
396 NAME specifies the sort order defined by function FUNCTION.
397 FUNCTION nil means don't sort the buffer list. Otherwise the function
398 must have two parameters - the buffers to compare.
399 REGEXP-FOR-SORTING is a regular expression which describes the
400 column title to highlight.
401 FACE is a face used to fontify the sorted column title. A value of nil means
404 :type '(repeat sexp))
406 (defun bs-define-sort-function (name fun &optional regexp-for-sorting face)
407 "Define a new function for buffer sorting in Buffer Selection Menu.
408 NAME specifies the sort order defined by function FUN.
409 A value of nil for FUN means don't sort the buffer list. Otherwise the
410 functions must have two parameters - the buffers to compare.
411 REGEXP-FOR-SORTING is a regular expression which describes the
412 column title to highlight.
413 FACE is a face used to fontify the sorted column title. A value of nil means
415 The new sort aspect will be inserted into list `bs-sort-functions'."
416 (let ((tupel (assoc name bs-sort-functions)))
418 (setcdr tupel (list fun regexp-for-sorting face))
419 (setq bs-sort-functions
420 (cons (list name fun regexp-for-sorting face)
421 bs-sort-functions)))))
423 (defvar bs--current-sort-function nil
424 "Description of the current function for sorting the buffer list.
425 This is an element of `bs-sort-functions'.")
427 (defcustom bs-default-sort-name "by nothing"
428 "*Name of default sort behavior.
429 Must be \"by nothing\" or a string used in `bs-sort-functions' for
430 naming a sort behavior. Default is \"by nothing\" which means no sorting."
433 :set (lambda (var-name value)
435 (setq bs--current-sort-function
436 (assoc value bs-sort-functions))))
438 (defvar bs--buffer-coming-from nil
439 "The buffer in which the user started the current Buffer Selection Menu.")
441 (defvar bs--show-all nil
442 "Flag whether showing all buffers regardless of current configuration.
443 Non-nil means to show all buffers. Otherwise show buffers
444 defined by current configuration `bs-current-configuration'.")
446 (defvar bs--window-config-coming-from nil
447 "Window configuration before starting Buffer Selection Menu.")
449 (defvar bs--intern-show-never "^ \\|\\*buffer-selection\\*"
450 "Regular expression specifying which buffers never to show.
451 A buffer whose name matches this regular expression will never be
452 included in the buffer list.")
454 (defvar bs-current-list nil
455 "List of buffers shown in Buffer Selection Menu.
456 Used internally, only.")
458 (defvar bs--marked-buffers nil
459 "Currently marked buffers in Buffer Selection Menu.")
462 (let ((map (make-sparse-keymap)))
463 (define-key map " " 'bs-select)
464 (define-key map "f" 'bs-select)
465 (define-key map "v" 'bs-view)
466 (define-key map "!" 'bs-select-in-one-window)
467 (define-key map [mouse-2] 'bs-mouse-select) ;; for GNU EMACS
468 (define-key map [button2] 'bs-mouse-select) ;; for XEmacs
469 (define-key map "F" 'bs-select-other-frame)
472 (define-key map (char-to-string key) 'digit-argument)
473 (setq key (1+ key))))
474 (define-key map "-" 'negative-argument)
475 (define-key map "\e-" 'negative-argument)
476 (define-key map "o" 'bs-select-other-window)
477 (define-key map "\C-o" 'bs-tmp-select-other-window)
479 (define-key map [mouse-3] 'bs-mouse-select-other-frame)
481 (define-key map [button3] 'bs-mouse-select-other-frame)
482 (define-key map [up] 'bs-up)
483 (define-key map "n" 'bs-down)
484 (define-key map "p" 'bs-up)
485 (define-key map [down] 'bs-down)
486 (define-key map "\C-m" 'bs-select)
487 (define-key map "b" 'bs-bury-buffer)
488 (define-key map "s" 'bs-save)
489 (define-key map "S" 'bs-show-sorted)
490 (define-key map "a" 'bs-toggle-show-all)
491 (define-key map "d" 'bs-delete)
492 (define-key map "\C-d" 'bs-delete-backward)
493 (define-key map "k" 'bs-delete)
494 (define-key map "g" 'bs-refresh)
495 (define-key map "C" 'bs-set-configuration-and-refresh)
496 (define-key map "c" 'bs-select-next-configuration)
497 (define-key map "q" 'bs-kill)
498 ;; (define-key map "z" 'bs-kill)
499 (define-key map "\C-c\C-c" 'bs-kill)
500 (define-key map "\C-g" 'bs-abort)
501 (define-key map "\C-]" 'bs-abort)
502 (define-key map "%" 'bs-toggle-readonly)
503 (define-key map "~" 'bs-clear-modified)
504 (define-key map "M" 'bs-toggle-current-to-show)
505 (define-key map "+" 'bs-set-current-buffer-to-show-always)
506 ;;(define-key map "-" 'bs-set-current-buffer-to-show-never)
507 (define-key map "t" 'bs-visit-tags-table)
508 (define-key map "m" 'bs-mark-current)
509 (define-key map "u" 'bs-unmark-current)
510 (define-key map ">" 'scroll-right)
511 (define-key map "<" 'scroll-left)
512 (define-key map "?" 'bs-help)
514 "Keymap of `bs-mode'.")
516 ;; ----------------------------------------------------------------------
518 ;; ----------------------------------------------------------------------
520 (defun bs-buffer-list (&optional list sort-description)
521 "Return a list of buffers to be shown.
522 LIST is a list of buffers to test for appearance in Buffer Selection Menu.
523 The result list depends on the global variables `bs-dont-show-regexp',
524 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
525 and `bs-buffer-sort-function'.
526 If SORT-DESCRIPTION isn't nil the list will be sorted by
527 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
528 (setq sort-description (or sort-description bs--current-sort-function)
529 list (or list (buffer-list)))
532 (let* ((buffername (buffer-name (car list)))
533 (int-show-never (string-match bs--intern-show-never buffername))
534 (ext-show-never (and bs-dont-show-regexp
535 (string-match bs-dont-show-regexp
537 (extern-must-show (or (and bs-must-always-show-regexp
539 bs-must-always-show-regexp
541 (and bs-must-show-regexp
542 (string-match bs-must-show-regexp
544 (extern-show-never-from-fun (and bs-dont-show-function
545 (funcall bs-dont-show-function
547 (extern-must-show-from-fun (and bs-must-show-function
548 (funcall bs-must-show-function
550 (show-flag (buffer-local-value 'bs-buffer-show-mark (car list))))
551 (if (or (eq show-flag 'always)
552 (and (or bs--show-all (not (eq show-flag 'never)))
556 extern-must-show-from-fun
557 (and (not ext-show-never)
558 (not extern-show-never-from-fun)))))
559 (setq result (cons (car list)
561 (setq list (cdr list))))
562 (setq result (reverse result))
563 ;; The current buffer which was the start point of bs should be an element
564 ;; of result list, so that we can leave with space and be back in the
565 ;; buffer we started bs-show.
566 (if (and bs--buffer-coming-from
567 (buffer-live-p bs--buffer-coming-from)
568 (not (memq bs--buffer-coming-from result)))
569 (setq result (cons bs--buffer-coming-from result)))
571 (if (and sort-description
572 (nth 1 sort-description))
573 (setq result (sort result (nth 1 sort-description)))
574 ;; else standard sorting
575 (bs-buffer-sort result))))
577 (defun bs-buffer-sort (buffer-list)
578 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
579 (if bs-buffer-sort-function
580 (sort buffer-list bs-buffer-sort-function)
583 (defun bs--redisplay (&optional keep-line-p sort-description)
584 "Redisplay whole Buffer Selection Menu.
585 If KEEP-LINE-P is non-nil the point will stay on current line.
586 SORT-DESCRIPTION is an element of `bs-sort-functions'."
587 (let ((line (1+ (count-lines 1 (point)))))
588 (bs-show-in-buffer (bs-buffer-list nil sort-description))
591 (beginning-of-line)))
593 (defun bs--goto-current-buffer ()
594 "Goto line which represents the current buffer;
595 actually the line which begins with character in `bs-string-current' or
596 `bs-string-current-marked'."
597 (let ((regexp (concat "^"
598 (regexp-quote bs-string-current)
600 (regexp-quote bs-string-current-marked)))
603 (goto-char (point-min))
604 (if (search-forward-regexp regexp nil t)
605 (setq point (- (point) 1))))
609 (defun bs--current-config-message ()
610 "Return a string describing the current `bs-mode' configuration."
613 (format "Show buffer by configuration %S"
614 bs-current-configuration)))
616 (defun bs--track-window-changes (frame)
617 "Track window changes to refresh the buffer list.
618 Used from `window-size-change-functions'."
619 (let ((win (get-buffer-window "*buffer-selection*" frame)))
621 (with-selected-window win
623 (bs--set-window-height)))))
625 (defun bs--remove-hooks ()
626 "Remove `bs--track-window-changes' and auxiliary hooks."
627 (remove-hook 'window-size-change-functions 'bs--track-window-changes)
629 (remove-hook 'kill-buffer-hook 'bs--remove-hooks t)
630 (remove-hook 'change-major-mode-hook 'bs--remove-hooks t))
632 (define-derived-mode bs-mode ()
633 "Major mode for editing a subset of Emacs' buffers.
635 Aside from two header lines each line describes one buffer.
636 Move to a line representing the buffer you want to edit and select
637 buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill].
638 There are many key commands similar to `Buffer-menu-mode' for
639 manipulating the buffer list and buffers.
640 For faster navigation each digit key is a digit argument.
642 \\[bs-select] or SPACE -- select current line's buffer and other marked buffers.
643 \\[bs-toggle-show-all] -- toggle between all buffers and a special subset.
644 \\[bs-select-other-window] -- select current line's buffer in other window.
645 \\[bs-tmp-select-other-window] -- make another window display that buffer and
646 remain in Buffer Selection Menu.
647 \\[bs-mouse-select] -- select current line's buffer and other marked buffers.
648 \\[bs-save] -- save current line's buffer immediately.
649 \\[bs-delete] -- kill current line's buffer immediately.
650 \\[bs-toggle-readonly] -- toggle read-only status of current line's buffer.
651 \\[bs-clear-modified] -- clear modified-flag on that buffer.
652 \\[bs-mark-current] -- mark current line's buffer to be displayed.
653 \\[bs-unmark-current] -- unmark current line's buffer to be displayed.
654 \\[bs-show-sorted] -- display buffer list sorted by next sort aspect.
655 \\[bs-set-configuration-and-refresh] -- ask user for a configuration and \
656 apply selected configuration.
657 \\[bs-select-next-configuration] -- select and apply next \
658 available Buffer Selection Menu configuration.
659 \\[bs-kill] -- leave Buffer Selection Menu without a selection.
660 \\[bs-toggle-current-to-show] -- toggle status of appearance.
661 \\[bs-set-current-buffer-to-show-always] -- mark current line's buffer \
663 \\[bs-visit-tags-table] -- call `visit-tags-table' on current line's buffer.
664 \\[bs-help] -- display this help text."
665 (make-local-variable 'font-lock-defaults)
666 (make-local-variable 'font-lock-verbose)
667 (make-local-variable 'font-lock-global-modes)
668 (buffer-disable-undo)
669 (setq buffer-read-only t
671 show-trailing-whitespace nil
672 font-lock-global-modes '(not bs-mode)
673 font-lock-defaults '(bs-mode-font-lock-keywords t)
674 font-lock-verbose nil)
675 (add-hook 'window-size-change-functions 'bs--track-window-changes)
676 (add-hook 'kill-buffer-hook 'bs--remove-hooks nil t)
677 (add-hook 'change-major-mode-hook 'bs--remove-hooks nil t))
679 (defun bs--restore-window-config ()
680 "Restore window configuration on the current frame."
681 (when bs--window-config-coming-from
682 (let ((frame (selected-frame)))
684 (set-window-configuration bs--window-config-coming-from)
685 (select-frame frame)))
686 (setq bs--window-config-coming-from nil)))
689 "Let buffer disappear and reset window configuration."
691 (bury-buffer (current-buffer))
692 (bs--restore-window-config))
695 "Ding and leave Buffer Selection Menu without a selection."
700 (defun bs-set-configuration-and-refresh ()
701 "Ask user for a configuration and apply selected configuration.
702 Refresh whole Buffer Selection Menu."
704 (call-interactively 'bs-set-configuration)
708 "Refresh whole Buffer Selection Menu."
712 (defun bs--set-window-height ()
713 "Change the height of the selected window to suit the current buffer list."
714 (unless (one-window-p t)
715 (fit-window-to-buffer (selected-window) bs-max-window-height)))
717 (defun bs--current-buffer ()
718 "Return buffer on current line.
719 Raise an error if not on a buffer line."
721 (let ((line (+ (- bs-header-lines-length)
722 (count-lines 1 (point)))))
724 (error "You are on a header row"))
725 (nth line bs-current-list)))
727 (defun bs--update-current-line ()
728 "Update the entry on current line for Buffer Selection Menu."
729 (let ((buffer (bs--current-buffer))
730 (inhibit-read-only t))
732 (delete-region (point) (line-end-position))
733 (bs--insert-one-entry buffer)
734 (beginning-of-line)))
737 "View current line's buffer in View mode.
738 Leave Buffer Selection Menu."
740 (view-buffer (bs--current-buffer)))
743 "Select current line's buffer and other marked buffers.
744 If there are no marked buffers the window configuration before starting
745 Buffer Selectin Menu will be restored.
746 If there are marked buffers each marked buffer and the current line's buffer
747 will be selected in a window.
748 Leave Buffer Selection Menu."
750 (let ((buffer (bs--current-buffer)))
751 (bury-buffer (current-buffer))
752 (bs--restore-window-config)
753 (switch-to-buffer buffer)
754 (if bs--marked-buffers
755 ;; Some marked buffers for selection
756 (let* ((all (delq buffer bs--marked-buffers))
757 (height (/ (1- (frame-height)) (1+ (length all)))))
758 (delete-other-windows)
759 (switch-to-buffer buffer)
761 (split-window nil height)
763 (switch-to-buffer (car all))
764 (setq all (cdr all)))
765 ;; goto window we have started bs.
768 (defun bs-select-other-window ()
769 "Select current line's buffer by `switch-to-buffer-other-window'.
770 The window configuration before starting Buffer Selectin Menu will be restored
771 unless there is no other window. In this case a new window will be created.
772 Leave Buffer Selection Menu."
774 (let ((buffer (bs--current-buffer)))
775 (bury-buffer (current-buffer))
776 (bs--restore-window-config)
777 (switch-to-buffer-other-window buffer)))
779 (defun bs-tmp-select-other-window ()
780 "Make the other window select this line's buffer.
781 The current window remains selected."
783 (let ((buffer (bs--current-buffer)))
784 (display-buffer buffer t)))
786 (defun bs-select-other-frame ()
787 "Select current line's buffer in new created frame.
788 Leave Buffer Selection Menu."
790 (let ((buffer (bs--current-buffer)))
791 (bury-buffer (current-buffer))
792 (bs--restore-window-config)
793 (switch-to-buffer-other-frame buffer)))
795 (defun bs-mouse-select-other-frame (event)
796 "Select selected line's buffer in new created frame.
797 Leave Buffer Selection Menu.
798 EVENT: a mouse click event."
800 (mouse-set-point event)
801 (bs-select-other-frame))
803 (defun bs-mouse-select (event)
804 "Select buffer on mouse click EVENT.
805 Select buffer by `bs-select'."
807 (mouse-set-point event)
810 (defun bs-select-in-one-window ()
811 "Select current line's buffer in one window and delete other windows.
812 Leave Buffer Selection Menu."
815 (delete-other-windows))
817 (defun bs-bury-buffer ()
818 "Bury buffer on current line."
820 (bury-buffer (bs--current-buffer))
824 "Save buffer on current line."
826 (let ((buffer (bs--current-buffer)))
830 (bs--update-current-line)))
832 (defun bs-visit-tags-table ()
833 "Visit the tags table in the buffer on this line.
834 See `visit-tags-table'."
836 (let ((file (buffer-file-name (bs--current-buffer))))
838 (visit-tags-table file)
839 (error "Specified buffer has no file"))))
841 (defun bs-toggle-current-to-show ()
842 "Toggle status of showing flag for buffer in current line."
844 (let ((buffer (bs--current-buffer))
848 (setq res (cond ((null bs-buffer-show-mark)
850 ((eq bs-buffer-show-mark 'never)
853 (setq bs-buffer-show-mark res))
854 (bs--update-current-line)
855 (bs--set-window-height)
856 (bs--show-config-message res)))
858 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
859 "Toggle status of buffer on line to `always shown'.
860 NOT-TO-SHOW-P: prefix argument.
861 With no prefix argument the buffer on current line is marked to show
862 always. Otherwise it is marked to show never."
865 (bs-set-current-buffer-to-show-never)
866 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
868 (defun bs-set-current-buffer-to-show-never ()
869 "Toggle status of buffer on line to `never shown'."
871 (bs--set-toggle-to-show (bs--current-buffer) 'never))
873 (defun bs--set-toggle-to-show (buffer what)
874 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
875 Redisplay current line and display a message describing
876 the status of buffer on current line."
877 (with-current-buffer buffer (setq bs-buffer-show-mark what))
878 (bs--update-current-line)
879 (bs--set-window-height)
880 (bs--show-config-message what))
882 (defun bs-mark-current (count)
884 COUNT is the number of buffers to mark.
885 Move cursor vertically down COUNT lines."
887 (let ((dir (if (> count 0) 1 -1))
890 (let ((buffer (bs--current-buffer)))
892 (setq bs--marked-buffers (cons buffer bs--marked-buffers)))
893 (bs--update-current-line)
895 (setq count (1- count)))))
897 (defun bs-unmark-current (count)
899 COUNT is the number of buffers to unmark.
900 Move cursor vertically down COUNT lines."
902 (let ((dir (if (> count 0) 1 -1))
905 (let ((buffer (bs--current-buffer)))
907 (setq bs--marked-buffers (delq buffer bs--marked-buffers)))
908 (bs--update-current-line)
910 (setq count (1- count)))))
912 (defun bs--show-config-message (what)
913 "Show message indicating the new showing status WHAT.
914 WHAT is a value of nil, `never', or `always'."
915 (bs-message-without-log (cond ((null what)
916 "Buffer will be shown normally.")
918 "Mark buffer to never be shown.")
919 (t "Mark buffer to show always."))))
922 "Kill buffer on current line."
924 (let ((current (bs--current-buffer))
925 (inhibit-read-only t))
926 (unless (kill-buffer current)
927 (error "Buffer was not deleted"))
928 (setq bs-current-list (delq current bs-current-list))
930 (delete-region (point) (save-excursion
932 (if (eobp) (point) (1+ (point)))))
935 (backward-delete-char 1)
938 (bs--set-window-height)))
940 (defun bs-delete-backward ()
941 "Like `bs-delete' but go to buffer in front of current."
943 (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
945 (unless on-last-line-p
948 (defun bs-show-sorted ()
949 "Show buffer list sorted by next sort aspect."
951 (setq bs--current-sort-function
952 (bs-next-config-aux (car bs--current-sort-function)
955 (bs--goto-current-buffer)
956 (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))
958 (defun bs-apply-sort-faces (&optional sort-description)
959 "Set text properties for the sort described by SORT-DESCRIPTION.
960 SORT-DESCRIPTION is an element of `bs-sort-functions'.
961 Default is `bs--current-sort-function'."
962 (let ((sort-description (or sort-description
963 bs--current-sort-function)))
965 (goto-char (point-min))
966 (if (and (nth 2 sort-description)
967 (search-forward-regexp (nth 2 sort-description) nil t))
968 (let ((inhibit-read-only t))
969 (put-text-property (match-beginning 0)
972 (or (nth 3 sort-description)
975 (defun bs-toggle-show-all ()
976 "Toggle show all buffers / show buffers with current configuration."
978 (setq bs--show-all (not bs--show-all))
980 (bs--goto-current-buffer)
981 (bs-message-without-log "%s" (bs--current-config-message)))
983 (defun bs-toggle-readonly ()
984 "Toggle read-only status for buffer on current line.
985 Uses function `vc-toggle-read-only'."
987 (let ((buffer (bs--current-buffer)))
990 (vc-toggle-read-only))
991 (bs--update-current-line)))
993 (defun bs-clear-modified ()
994 "Set modified flag for buffer on current line to nil."
996 (let ((buffer (bs--current-buffer)))
999 (set-buffer-modified-p nil)))
1000 (bs--update-current-line))
1002 (defun bs--nth-wrapper (count fun &rest args)
1003 "Call COUNT times function FUN with arguments ARGS."
1004 (setq count (or count 1))
1007 (setq count (1- count))))
1010 "Move cursor vertically up ARG lines in Buffer Selection Menu."
1012 (if (and arg (numberp arg) (< arg 0))
1013 (bs--nth-wrapper (- arg) 'bs--down)
1014 (bs--nth-wrapper arg 'bs--up)))
1017 "Move cursor vertically up one line.
1018 If on top of buffer list go to last line."
1019 (if (> (count-lines 1 (point)) bs-header-lines-length)
1021 (goto-char (point-max))
1025 (defun bs-down (arg)
1026 "Move cursor vertically down ARG lines in Buffer Selection Menu."
1028 (if (and arg (numberp arg) (< arg 0))
1029 (bs--nth-wrapper (- arg) 'bs--up)
1030 (bs--nth-wrapper arg 'bs--down)))
1033 "Move cursor vertically down one line.
1034 If at end of buffer list go to first line."
1035 (if (eq (line-end-position) (point-max))
1036 (goto-line (1+ bs-header-lines-length))
1039 (defun bs-visits-non-file (buffer)
1040 "Return whether BUFFER visits no file.
1041 A value of t means BUFFER belongs to no file.
1042 A value of nil means BUFFER belongs to a file."
1043 (not (buffer-file-name buffer)))
1045 (defun bs-sort-buffer-interns-are-last (b1 b2)
1046 "Function for sorting internal buffers at the end of all buffers."
1047 (string-match "^\\*" (buffer-name b2)))
1049 ;; ----------------------------------------------------------------------
1051 ;; ----------------------------------------------------------------------
1053 (defun bs-config-clear ()
1054 "Reset all variables which specify a configuration.
1055 These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
1056 `bs-dont-show-function', `bs-must-show-function' and
1057 `bs-buffer-sort-function'."
1058 (setq bs-dont-show-regexp nil
1059 bs-must-show-regexp nil
1060 bs-dont-show-function nil
1061 bs-must-show-function nil
1062 bs-buffer-sort-function nil))
1064 (defun bs-config--only-files ()
1065 "Define a configuration for showing only buffers visiting a file."
1067 (setq ;; I want to see *-buffers at the end
1068 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1069 ;; Don't show files who don't belong to a file
1070 bs-dont-show-function 'bs-visits-non-file))
1072 (defun bs-config--files-and-scratch ()
1073 "Define a configuration for showing buffer *scratch* and file buffers."
1075 (setq ;; I want to see *-buffers at the end
1076 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1077 ;; Don't show files who don't belong to a file
1078 bs-dont-show-function 'bs-visits-non-file
1079 ;; Show *scratch* buffer.
1080 bs-must-show-regexp "^\\*scratch\\*$"))
1082 (defun bs-config--all ()
1083 "Define a configuration for showing all buffers.
1084 Reset all according variables by `bs-config-clear'."
1087 (defun bs-config--all-intern-last ()
1088 "Define a configuration for showing all buffers.
1089 Internal buffers appear at end of all buffers."
1091 ;; I want to see *-buffers at the end
1092 (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))
1094 (defun bs-set-configuration (name)
1095 "Set configuration to the one saved under string NAME in `bs-configurations'.
1096 When called interactively ask user for a configuration and apply selected
1098 (interactive (list (completing-read "Use configuration: "
1102 (let ((list (assoc name bs-configurations)))
1105 (setq bs-current-configuration name
1106 bs-must-show-regexp (nth 1 list)
1107 bs-must-show-function (nth 2 list)
1108 bs-dont-show-regexp (nth 3 list)
1109 bs-dont-show-function (nth 4 list)
1110 bs-buffer-sort-function (nth 5 list))
1111 ;; for backward compability
1112 (funcall (cdr list)))
1115 (bs-message-without-log "No bs-configuration named %S." name))))
1118 "Help for `bs-show'."
1120 (describe-function 'bs-mode))
1122 (defun bs-next-config-aux (start-name list)
1123 "Get the next assoc after START-NAME in list LIST.
1124 Will return the first if START-NAME is at end."
1126 (length (length list))
1128 (while (and assocs (not pos))
1129 (if (string= (car (car assocs)) start-name)
1130 (setq pos (- length (length assocs))))
1131 (setq assocs (cdr assocs)))
1137 (defun bs-next-config (name)
1138 "Return next configuration with respect to configuration with name NAME."
1139 (bs-next-config-aux name bs-configurations))
1141 (defun bs-select-next-configuration (&optional start-name)
1142 "Apply next configuration START-NAME and refresh buffer list.
1143 If START-NAME is nil the current configuration `bs-current-configuration'
1146 (let ((config (bs-next-config (or start-name bs-current-configuration))))
1147 (bs-set-configuration (car config))
1148 (setq bs-default-configuration bs-current-configuration)
1150 (bs--set-window-height)
1151 (bs-message-without-log "Selected configuration: %s" (car config))))
1153 (defun bs-show-in-buffer (list)
1154 "Display buffer list LIST in buffer *buffer-selection*.
1155 Select buffer *buffer-selection* and display buffers according to current
1156 configuration `bs-current-configuration'. Set window height, fontify buffer
1157 and move point to current buffer."
1158 (setq bs-current-list list)
1159 (switch-to-buffer (get-buffer-create "*buffer-selection*"))
1161 (let* ((inhibit-read-only t)
1162 (map-fun (lambda (entry)
1163 (length (buffer-name entry))))
1164 (max-length-of-names (apply 'max
1165 (cons 0 (mapcar map-fun list))))
1166 (name-entry-length (min bs-maximal-buffer-name-column
1167 (max bs-minimal-buffer-name-column
1168 max-length-of-names))))
1170 (setq bs--name-entry-length name-entry-length)
1173 (bs--insert-one-entry (car list))
1175 (setq list (cdr list)))
1176 (delete-backward-char 1)
1177 (bs--set-window-height)
1178 (bs--goto-current-buffer)
1179 (font-lock-fontify-buffer)
1180 (bs-apply-sort-faces)
1181 (set-buffer-modified-p nil)))
1183 (defun bs-next-buffer (&optional buffer-list sorting-p)
1184 "Return next 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 normally the second element of
1188 BUFFER-LIST and the 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 (cdr bs-buffer-list))
1193 (car bs-buffer-list)
1197 (defun bs-previous-buffer (&optional buffer-list sorting-p)
1198 "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST.
1199 Ignore sorting when SORTING-P is nil.
1200 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1201 buffer list. The result is a cons of last element of BUFFER-LIST and the
1202 buffer list used for buffer cycling."
1203 (let* ((bs--current-sort-function (if sorting-p
1204 bs--current-sort-function))
1205 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1206 (cons (or (car (last bs-buffer-list))
1210 (defun bs-message-without-log (&rest args)
1211 "Like `message' but don't log it on the message log.
1212 All arguments ARGS are transferred to function `message'."
1213 (let ((message-log-max nil))
1214 (apply 'message args)))
1216 (defvar bs--cycle-list nil
1217 "Current buffer list used for cycling.")
1220 (defun bs-cycle-next ()
1221 "Select next buffer defined by buffer cycling.
1222 The buffers taking part in buffer cycling are defined
1223 by buffer configuration `bs-cycle-configuration-name'."
1225 (let ((bs--buffer-coming-from (current-buffer))
1226 (bs-dont-show-regexp bs-dont-show-regexp)
1227 (bs-must-show-regexp bs-must-show-regexp)
1228 (bs-dont-show-function bs-dont-show-function)
1229 (bs-must-show-function bs-must-show-function)
1231 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1232 (let ((bs-buffer-sort-function nil)
1233 (bs--current-sort-function nil))
1234 (let* ((tupel (bs-next-buffer (if (or (eq last-command
1237 'bs-cycle-previous))
1240 (cycle-list (cdr tupel)))
1241 (unless (window-dedicated-p (selected-window))
1242 ;; We don't want the frame iconified if the only window in the frame
1243 ;; happens to be dedicated; let's get the error from switch-to-buffer
1245 (switch-to-buffer next)
1246 (setq bs--cycle-list (append (cdr cycle-list)
1247 (list (car cycle-list))))
1248 (bs-message-without-log "Next buffers: %s"
1249 (or (cdr bs--cycle-list)
1253 (defun bs-cycle-previous ()
1254 "Select previous buffer defined by buffer cycling.
1255 The buffers taking part in buffer cycling are defined
1256 by buffer configuration `bs-cycle-configuration-name'."
1258 (let ((bs--buffer-coming-from (current-buffer))
1259 (bs-dont-show-regexp bs-dont-show-regexp)
1260 (bs-must-show-regexp bs-must-show-regexp)
1261 (bs-dont-show-function bs-dont-show-function)
1262 (bs-must-show-function bs-must-show-function)
1264 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1265 (let ((bs-buffer-sort-function nil)
1266 (bs--current-sort-function nil))
1267 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1270 'bs-cycle-previous))
1272 (prev-buffer (car tupel))
1273 (cycle-list (cdr tupel)))
1274 (switch-to-buffer prev-buffer)
1275 (setq bs--cycle-list (append (last cycle-list)
1276 (reverse (cdr (reverse cycle-list)))))
1277 (bs-message-without-log "Previous buffers: %s"
1278 (or (reverse (cdr bs--cycle-list))
1281 (defun bs--get-value (fun &optional args)
1282 "Apply function FUN with arguments ARGS.
1283 Return result of evaluation. Will return FUN if FUN is a number
1285 (cond ((numberp fun)
1289 (t (apply fun args))))
1291 (defun bs--get-marked-string (start-buffer all-buffers)
1292 "Return a string which describes whether current buffer is marked.
1293 START-BUFFER is the buffer where we started buffer selection.
1294 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu.
1295 The result string is one of `bs-string-current', `bs-string-current-marked',
1296 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1297 `bs-string-show-always'."
1298 (cond ;; current buffer is the buffer we started buffer selection.
1299 ((eq (current-buffer) start-buffer)
1300 (if (memq (current-buffer) bs--marked-buffers)
1301 bs-string-current-marked ; buffer is marked
1303 ;; current buffer is marked
1304 ((memq (current-buffer) bs--marked-buffers)
1306 ;; current buffer hasn't a special mark.
1307 ((null bs-buffer-show-mark)
1308 bs-string-show-normally)
1309 ;; current buffer has a mark not to show itself.
1310 ((eq bs-buffer-show-mark 'never)
1311 bs-string-show-never)
1312 ;; otherwise current buffer is marked to show always.
1314 bs-string-show-always)))
1316 (defun bs--get-modified-string (start-buffer all-buffers)
1317 "Return a string which describes whether current buffer is modified.
1318 START-BUFFER is the buffer where we started buffer selection.
1319 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1320 (if (buffer-modified-p) "*" " "))
1322 (defun bs--get-readonly-string (start-buffer all-buffers)
1323 "Return a string which describes whether current buffer is read only.
1324 START-BUFFER is the buffer where we started buffer selection.
1325 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1326 (if buffer-read-only "%" " "))
1328 (defun bs--get-size-string (start-buffer all-buffers)
1329 "Return a string which describes the size of current buffer.
1330 START-BUFFER is the buffer where we started buffer selection.
1331 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1332 (int-to-string (buffer-size)))
1334 (defun bs--get-name (start-buffer all-buffers)
1335 "Return name of current buffer for Buffer Selection Menu.
1336 The name of current buffer gets additional text properties
1337 for mouse highlighting.
1338 START-BUFFER is the buffer where we started buffer selection.
1339 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1340 (propertize (buffer-name)
1341 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"
1342 'mouse-face 'highlight))
1344 (defun bs--get-mode-name (start-buffer all-buffers)
1345 "Return the name of mode of current buffer for Buffer Selection Menu.
1346 START-BUFFER is the buffer where we started buffer selection.
1347 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1350 (defun bs--get-file-name (start-buffer all-buffers)
1351 "Return string for column 'File' in Buffer Selection Menu.
1352 This is the variable `buffer-file-name' of current buffer.
1353 If current mode is `dired-mode' or `shell-mode' it returns the
1355 START-BUFFER is the buffer where we started buffer selection.
1356 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1357 (propertize (if (member major-mode '(shell-mode dired-mode))
1359 (or buffer-file-name ""))
1360 'mouse-face 'highlight
1361 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"))
1363 (defun bs--insert-one-entry (buffer)
1364 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1365 It goes over all columns described in `bs-attributes-list'
1366 and evaluates corresponding string. Inserts string in current buffer;
1367 normally *buffer-selection*."
1369 (columns bs-attributes-list)
1371 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1375 (let ((min (bs--get-value (nth 1 (car columns))))
1376 ;;(max (bs--get-value (nth 2 (car columns)))) refered no more
1377 (align (nth 3 (car columns)))
1378 (fun (nth 4 (car columns)))
1381 (setq val (bs--get-value fun apply-args))
1382 (setq new-string (bs--format-aux val align (- min to-much)))
1383 (setq string (concat string new-string))
1384 (if (> (length new-string) min)
1385 (setq to-much (- (length new-string) min)))
1387 (setq columns (cdr columns))))
1391 (defun bs--format-aux (string align len)
1392 "Pad STRING to length LEN with alignment ALIGN.
1393 ALIGN is one of the symbols `left', `middle', or `right'."
1394 (let* ((width (length string))
1395 (len (max len width)))
1396 (format (format "%%%s%ds" (if (eq align 'right) "" "-") len)
1397 (if (eq align 'middle)
1398 (concat (make-string (/ (- len width) 2) ?\s) string)
1401 (defun bs--show-header ()
1402 "Insert header for Buffer Selection Menu in current buffer."
1403 (dolist (string (bs--create-header))
1404 (insert string "\n")))
1406 (defun bs--get-name-length ()
1407 "Return value of `bs--name-entry-length'."
1408 bs--name-entry-length)
1410 (defun bs--create-header ()
1411 "Return all header lines used in Buffer Selection Menu as a list of strings."
1412 (list (mapconcat (lambda (column)
1413 (bs--format-aux (bs--get-value (car column))
1414 (nth 3 column) ; align
1415 (bs--get-value (nth 1 column))))
1418 (mapconcat (lambda (column)
1419 (let ((length (length (bs--get-value (car column)))))
1420 (bs--format-aux (make-string length ?-)
1421 (nth 3 column) ; align
1422 (bs--get-value (nth 1 column)))))
1426 (defun bs--show-with-configuration (name &optional arg)
1427 "Display buffer list of configuration with name NAME.
1428 Set configuration NAME and determine window for Buffer Selection Menu.
1429 Unless current buffer is buffer *buffer-selection* we have to save
1430 the buffer we started Buffer Selection Menu and the current window
1431 configuration to restore buffer and window configuration after a
1432 selection. If there is already a window displaying *buffer-selection*
1433 select this window for Buffer Selection Menu. Otherwise open a new
1435 The optional argument ARG is the prefix argument when calling a function
1436 for buffer selection."
1437 (bs-set-configuration name)
1438 (let ((bs--show-all (or bs--show-all arg)))
1439 (unless (string= "*buffer-selection*" (buffer-name))
1440 ;; Only when not in buffer *buffer-selection*
1441 ;; we have to set the buffer we started the command
1442 (setq bs--buffer-coming-from (current-buffer)))
1443 (let ((liste (bs-buffer-list))
1444 (active-window (get-window-with-predicate
1446 (string= (buffer-name (window-buffer w))
1447 "*buffer-selection*"))
1448 nil (selected-frame))))
1450 (select-window active-window)
1451 (bs--restore-window-config)
1452 (setq bs--window-config-coming-from (current-window-configuration))
1453 (when (> (window-height (selected-window)) 7)
1454 (split-window-vertically)
1456 (bs-show-in-buffer liste)
1457 (bs-message-without-log "%s" (bs--current-config-message)))))
1459 (defun bs--configuration-name-for-prefix-arg (prefix-arg)
1460 "Convert prefix argument PREFIX-ARG to a name of a buffer configuration.
1461 If PREFIX-ARG is nil return `bs-default-configuration'.
1462 If PREFIX-ARG is an integer return PREFIX-ARG element of `bs-configurations'.
1463 Otherwise return `bs-alternative-configuration'."
1464 (cond ;; usually activation
1466 bs-default-configuration)
1467 ;; call with integer as prefix argument
1468 ((integerp prefix-arg)
1469 (if (and (< 0 prefix-arg) (<= prefix-arg (length bs-configurations)))
1470 (car (nth (1- prefix-arg) bs-configurations))
1471 bs-default-configuration))
1472 ;; call by prefix argument C-u
1473 (t bs-alternative-configuration)))
1475 ;; ----------------------------------------------------------------------
1476 ;; Main function bs-customize and bs-show
1477 ;; ----------------------------------------------------------------------
1480 (defun bs-customize ()
1481 "Customization of group bs for Buffer Selection Menu."
1483 (customize-group "bs"))
1486 (defun bs-show (arg)
1487 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1489 There are many key commands similar to `Buffer-menu-mode' for
1490 manipulating the buffer list and the buffers themselves.
1491 User can move with [up] or [down], select a buffer
1492 by \\[bs-select] or [SPC]\n
1493 Type \\[bs-kill] to leave Buffer Selection Menu without a selection.
1494 Type \\[bs-help] after invocation to get help on commands available.
1495 With prefix argument ARG show a different buffer list. Function
1496 `bs--configuration-name-for-prefix-arg' determine accordingly
1497 name of buffer configuration."
1499 (setq bs--marked-buffers nil)
1500 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1502 ;; Now provide feature bs
1505 ;;; arch-tag: c0d9ab34-bf06-4368-ae9d-af88878e6802