1 ;;; bs.el --- menu for selecting and displaying buffers
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005 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 2, 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 (defvar bs--running-in-xemacs
(string-match "XEmacs" (emacs-version))
182 "Non-nil when running under XEmacs.")
184 (defun bs--make-header-match-string ()
185 "Return a regexp matching the first line of a Buffer Selection Menu buffer."
187 (ele bs-attributes-list
))
189 (setq res
(concat res
(car (car ele
)) " *"))
190 (setq ele
(cdr ele
)))
191 (concat res
"$\\)")))
193 ;; Font-Lock-Settings
194 (defvar bs-mode-font-lock-keywords
195 (list ;; header in font-lock-type-face
196 (list (bs--make-header-match-string)
197 '(1 font-lock-type-face append
) '(1 'bold append
))
198 ;; Buffername embedded by *
199 (list "^\\(.*\\*.*\\*.*\\)$"
201 ;; problem in XEmacs with font-lock-constant-face
202 (if (facep 'font-lock-constant-face
)
203 'font-lock-constant-face
204 'font-lock-comment-face
))
206 '("^..\\(.*Dired by .*\\)$" 1 font-lock-function-name-face
)
207 ;; the star for modified buffers
208 '("^.\\(\\*\\) +[^\\*]" 1 font-lock-comment-face
))
209 "Default font lock expressions for Buffer Selection Menu.")
211 (defcustom bs-max-window-height
20
212 "*Maximal window height of Buffer Selection Menu."
213 :group
'bs-appearance
216 (defvar bs-dont-show-regexp nil
217 "Regular expression specifying which buffers not to show.
218 A buffer whose name matches this regular expression will not be
219 included in the buffer list.")
221 (defvar bs-must-show-regexp nil
222 "Regular expression for specifying buffers which must be shown.
223 A buffer whose name matches this regular expression will be
224 included in the buffer list.
225 Note that this variable is temporary: if the configuration is changed
226 it is reset to nil. Use `bs-must-always-show-regexp' to specify buffers
227 that must always be shown regardless of the configuration.")
229 (defcustom bs-must-always-show-regexp nil
230 "*Regular expression for specifying buffers to show always.
231 A buffer whose name matches this regular expression will
232 be shown regardless of current configuration of Buffer Selection Menu."
234 :type
'(choice (const :tag
"Nothing at all" nil
) regexp
))
236 (defvar bs-dont-show-function nil
237 "Function for specifying buffers not to show.
238 The function gets one argument - the buffer to test. The function must
239 return a value different from nil to ignore the buffer in
240 Buffer Selection Menu.")
242 (defvar bs-must-show-function nil
243 "Function for specifying buffers which must be shown.
244 The function gets one argument - the buffer to test.")
246 (defvar bs-buffer-sort-function nil
247 "Sort function to sort the buffers that appear in Buffer Selection Menu.
248 The function gets two arguments - the buffers to compare.")
250 (defcustom bs-maximal-buffer-name-column
45
251 "*Maximum column width for buffer names.
252 The column for buffer names has dynamic width. The width depends on
253 maximal and minimal length of names of buffers to show. The maximal
254 width is bounded by `bs-maximal-buffer-name-column'.
255 See also `bs-minimal-buffer-name-column'."
256 :group
'bs-appearance
259 (defcustom bs-minimal-buffer-name-column
15
260 "*Minimum column width for buffer names.
261 The column for buffer names has dynamic width. The width depends on
262 maximal and minimal length of names of buffers to show. The minimal
263 width is bounded by `bs-minimal-buffer-name-column'.
264 See also `bs-maximal-buffer-name-column'."
265 :group
'bs-appearance
268 (defconst bs-header-lines-length
2
269 "Number of lines for headers in Buffer Selection Menu.")
271 (defcustom bs-configurations
272 '(("all" nil nil nil nil nil
)
273 ("files" nil nil nil bs-visits-non-file bs-sort-buffer-interns-are-last
)
274 ("files-and-scratch" "^\\*scratch\\*$" nil nil bs-visits-non-file
275 bs-sort-buffer-interns-are-last
)
276 ("all-intern-last" nil nil nil nil bs-sort-buffer-interns-are-last
))
277 "*List of all configurations you can use in the Buffer Selection Menu.
278 A configuration describes which buffers appear in Buffer Selection Menu
279 and also the order of buffers. A configuration is a list with
280 six elements. The first element is a string and describes the configuration.
281 The following five elements represent the values for Buffer Selection Menu
282 configuration variables `bs-must-show-regexp', `bs-must-show-function',
283 `bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'.
284 By setting these variables you define a configuration."
285 :group
'bs-appearance
286 :type
'(repeat sexp
))
288 (defcustom bs-default-configuration
"files"
289 "*Name of default configuration used by the Buffer Selection Menu.
291 Will be changed using key \\[bs-select-next-configuration].
292 Must be a string used in `bs-configurations' for naming a configuration."
296 (defcustom bs-alternative-configuration
"all"
297 "*Name of configuration used when calling `bs-show' with \
298 \\[universal-argument] as prefix key.
299 Must be a string used in `bs-configurations' for naming a configuration."
303 (defvar bs-current-configuration bs-default-configuration
304 "Name of current configuration.
305 Must be a string used in `bs-configurations' for naming a configuration.")
307 (defcustom bs-cycle-configuration-name nil
308 "*Name of configuration used when cycling through the buffer list.
309 A value of nil means to use current configuration `bs-default-configuration'.
310 Must be a string used in `bs-configurations' for naming a configuration."
312 :type
'(choice (const :tag
"like current configuration" nil
)
315 (defcustom bs-string-show-always
"+"
316 "*String added in column 1 indicating a buffer will always be shown."
317 :group
'bs-appearance
320 (defcustom bs-string-show-never
"-"
321 "*String added in column 1 indicating a buffer will never be shown."
322 :group
'bs-appearance
325 (defcustom bs-string-current
"."
326 "*String added in column 1 indicating the current buffer."
327 :group
'bs-appearance
330 (defcustom bs-string-current-marked
"#"
331 "*String added in column 1 indicating the current buffer when it is marked."
332 :group
'bs-appearance
335 (defcustom bs-string-marked
">"
336 "*String added in column 1 indicating a marked buffer."
337 :group
'bs-appearance
340 (defcustom bs-string-show-normally
" "
341 "*String added in column 1 indicating a unmarked buffer."
342 :group
'bs-appearance
345 (defvar bs--name-entry-length
20
346 "Maximum length of all displayed buffer names.
347 Used internally, only.")
349 ;; ----------------------------------------------------------------------
351 ;; ----------------------------------------------------------------------
353 (defvar bs-buffer-show-mark nil
354 "Flag for the current mode for showing this buffer.
355 A value of nil means buffer will be shown depending on the current
357 A value of `never' means to never show the buffer.
358 A value of `always' means to show buffer regardless of the configuration.")
360 (make-variable-buffer-local 'bs-buffer-show-mark
)
362 ;; Make face named region (for XEmacs)
363 (unless (facep 'region
)
365 (set-face-background 'region
"gray75"))
367 (defun bs--sort-by-name (b1 b2
)
368 "Compare buffers B1 and B2 by buffer name."
369 (string< (buffer-name b1
)
372 (defun bs--sort-by-filename (b1 b2
)
373 "Compare buffers B1 and B2 by file name."
374 (string< (or (buffer-file-name b1
) "")
375 (or (buffer-file-name b2
) "")))
377 (defun bs--sort-by-mode (b1 b2
)
378 "Compare buffers B1 and B2 by mode name."
380 (string< (progn (set-buffer b1
) (format "%s" mode-name
))
381 (progn (set-buffer b2
) (format "%s" mode-name
)))))
383 (defun bs--sort-by-size (b1 b2
)
384 "Compare buffers B1 and B2 by buffer size."
386 (< (progn (set-buffer b1
) (buffer-size))
387 (progn (set-buffer b2
) (buffer-size)))))
389 (defcustom bs-sort-functions
390 '(("by name" bs--sort-by-name
"Buffer" region
)
391 ("by size" bs--sort-by-size
"Size" region
)
392 ("by mode" bs--sort-by-mode
"Mode" region
)
393 ("by filename" bs--sort-by-filename
"File" region
)
394 ("by nothing" nil nil nil
))
395 "*List of all possible sorting aspects for Buffer Selection Menu.
396 You can add a new entry with a call to `bs-define-sort-function'.
397 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE)
398 NAME specifies the sort order defined by function FUNCTION.
399 FUNCTION nil means don't sort the buffer list. Otherwise the functions
400 must have two parameters - the buffers to compare.
401 REGEXP-FOR-SORTING is a regular expression which describes the
402 column title to highlight.
403 FACE is a face used to fontify the sorted column title. A value of nil means
406 :type
'(repeat sexp
))
408 (defun bs-define-sort-function (name fun
&optional regexp-for-sorting face
)
409 "Define a new function for buffer sorting in Buffer Selection Menu.
410 NAME specifies the sort order defined by function FUN.
411 A value of nil for FUN means don't sort the buffer list. Otherwise the
412 functions must have two parameters - the buffers to compare.
413 REGEXP-FOR-SORTING is a regular expression which describes the
414 column title to highlight.
415 FACE is a face used to fontify the sorted column title. A value of nil means
417 The new sort aspect will be inserted into list `bs-sort-functions'."
418 (let ((tupel (assoc name bs-sort-functions
)))
420 (setcdr tupel
(list fun regexp-for-sorting face
))
421 (setq bs-sort-functions
422 (cons (list name fun regexp-for-sorting face
)
423 bs-sort-functions
)))))
425 (defvar bs--current-sort-function nil
426 "Description of the current function for sorting the buffer list.
427 This is an element of `bs-sort-functions'.")
429 (defcustom bs-default-sort-name
"by nothing"
430 "*Name of default sort behavior.
431 Must be \"by nothing\" or a string used in `bs-sort-functions' for
432 naming a sort behavior. Default is \"by nothing\" which means no sorting."
435 :set
(lambda (var-name value
)
437 (setq bs--current-sort-function
438 (assoc value bs-sort-functions
))))
440 (defvar bs--buffer-coming-from nil
441 "The buffer in which the user started the current Buffer Selection Menu.")
443 (defvar bs--show-all nil
444 "Flag whether showing all buffers regardless of current configuration.
445 Non nil means to show all buffers. Otherwise show buffers
446 defined by current configuration `bs-current-configuration'.")
448 (defvar bs--window-config-coming-from nil
449 "Window configuration before starting Buffer Selection Menu.")
451 (defvar bs--intern-show-never
"^ \\|\\*buffer-selection\\*"
452 "Regular expression specifying which buffers never to show.
453 A buffer whose name matches this regular expression will never be
454 included in the buffer list.")
456 (defvar bs-current-list nil
457 "List of buffers shown in Buffer Selection Menu.
458 Used internally, only.")
460 (defvar bs--marked-buffers nil
461 "Currently marked buffers in Buffer Selection Menu.")
464 (let ((map (make-sparse-keymap)))
465 (define-key map
" " 'bs-select
)
466 (define-key map
"f" 'bs-select
)
467 (define-key map
"v" 'bs-view
)
468 (define-key map
"!" 'bs-select-in-one-window
)
469 (define-key map
[mouse-2
] 'bs-mouse-select
) ;; for GNU EMACS
470 (define-key map
[button2] 'bs-mouse-select) ;; for XEmacs
471 (define-key map "F" 'bs-select-other-frame)
474 (define-key map (char-to-string key) 'digit-argument)
475 (setq key (1+ key))))
476 (define-key map "-" 'negative-argument)
477 (define-key map "\e-" 'negative-argument)
478 (define-key map "o" 'bs-select-other-window)
479 (define-key map "\C-o" 'bs-tmp-select-other-window)
481 (define-key map [mouse-3] 'bs-mouse-select-other-frame)
483 (define-key map [button3] 'bs-mouse-select-other-frame)
484 (define-key map [up] 'bs-up)
485 (define-key map "n" 'bs-down)
486 (define-key map "p" 'bs-up)
487 (define-key map [down] 'bs-down)
488 (define-key map "\C-m" 'bs-select)
489 (define-key map "b" 'bs-bury-buffer)
490 (define-key map "s" 'bs-save)
491 (define-key map "S" 'bs-show-sorted)
492 (define-key map "a" 'bs-toggle-show-all)
493 (define-key map "d" 'bs-delete)
494 (define-key map "\C-d" 'bs-delete-backward)
495 (define-key map "k" 'bs-delete)
496 (define-key map "g" 'bs-refresh)
497 (define-key map "C" 'bs-set-configuration-and-refresh)
498 (define-key map "c" 'bs-select-next-configuration)
499 (define-key map "q" 'bs-kill)
500 ;; (define-key map "z" 'bs-kill)
501 (define-key map "\C-c\C-c" 'bs-kill)
502 (define-key map "\C-g" 'bs-abort)
503 (define-key map "\C-]" 'bs-abort)
504 (define-key map "%" 'bs-toggle-readonly)
505 (define-key map "~" 'bs-clear-modified)
506 (define-key map "M" 'bs-toggle-current-to-show)
507 (define-key map "+" 'bs-set-current-buffer-to-show-always)
508 ;;(define-key map "-" 'bs-set-current-buffer-to-show-never)
509 (define-key map "t" 'bs-visit-tags-table)
510 (define-key map "m" 'bs-mark-current)
511 (define-key map "u" 'bs-unmark-current)
512 (define-key map ">" 'scroll-right)
513 (define-key map "<" 'scroll-left)
514 (define-key map "?" 'bs-help)
516 "Keymap of `bs-mode'.")
518 ;; ----------------------------------------------------------------------
520 ;; ----------------------------------------------------------------------
522 (defun bs-buffer-list (&optional list sort-description)
523 "Return a list of buffers to be shown.
524 LIST is a list of buffers to test for appearance in Buffer Selection Menu.
525 The result list depends on the global variables `bs-dont-show-regexp',
526 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
527 and `bs-buffer-sort-function'.
528 If SORT-DESCRIPTION isn't nil the list will be sorted by
529 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
530 (setq sort-description (or sort-description bs--current-sort-function)
531 list (or list (buffer-list)))
534 (let* ((buffername (buffer-name (car list)))
535 (int-show-never (string-match bs--intern-show-never buffername))
536 (ext-show-never (and bs-dont-show-regexp
537 (string-match bs-dont-show-regexp
539 (extern-must-show (or (and bs-must-always-show-regexp
541 bs-must-always-show-regexp
543 (and bs-must-show-regexp
544 (string-match bs-must-show-regexp
546 (extern-show-never-from-fun (and bs-dont-show-function
547 (funcall bs-dont-show-function
549 (extern-must-show-from-fun (and bs-must-show-function
550 (funcall bs-must-show-function
552 (show-flag (buffer-local-value 'bs-buffer-show-mark (car list))))
553 (if (or (eq show-flag 'always)
554 (and (or bs--show-all (not (eq show-flag 'never)))
558 extern-must-show-from-fun
559 (and (not ext-show-never)
560 (not extern-show-never-from-fun)))))
561 (setq result (cons (car list)
563 (setq list (cdr list))))
564 (setq result (reverse result))
565 ;; The current buffer which was the start point of bs should be an element
566 ;; of result list, so that we can leave with space and be back in the
567 ;; buffer we started bs-show.
568 (if (and bs--buffer-coming-from
569 (buffer-live-p bs--buffer-coming-from)
570 (not (memq bs--buffer-coming-from result)))
571 (setq result (cons bs--buffer-coming-from result)))
573 (if (and sort-description
574 (nth 1 sort-description))
575 (setq result (sort result (nth 1 sort-description)))
576 ;; else standard sorting
577 (bs-buffer-sort result))))
579 (defun bs-buffer-sort (buffer-list)
580 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
581 (if bs-buffer-sort-function
582 (sort buffer-list bs-buffer-sort-function)
585 (defun bs--redisplay (&optional keep-line-p sort-description)
586 "Redisplay whole Buffer Selection Menu.
587 If KEEP-LINE-P is non nil the point will stay on current line.
588 SORT-DESCRIPTION is an element of `bs-sort-functions'"
589 (let ((line (1+ (count-lines 1 (point)))))
590 (bs-show-in-buffer (bs-buffer-list nil sort-description))
593 (beginning-of-line)))
595 (defun bs--goto-current-buffer ()
596 "Goto line which represents the current buffer;
597 actually the line which begins with character in `bs-string-current' or
598 `bs-string-current-marked'."
599 (let ((regexp (concat "^"
600 (regexp-quote bs-string-current)
602 (regexp-quote bs-string-current-marked)))
605 (goto-char (point-min))
606 (if (search-forward-regexp regexp nil t)
607 (setq point (- (point) 1))))
611 (defun bs--current-config-message ()
612 "Return a string describing the current `bs-mode' configuration."
615 (format "Show buffer by configuration %S"
616 bs-current-configuration)))
619 "Major mode for editing a subset of Emacs' buffers.
621 Aside from two header lines each line describes one buffer.
622 Move to a line representing the buffer you want to edit and select
623 buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill].
624 There are many key commands similar to `Buffer-menu-mode' for
625 manipulating the buffer list and buffers.
626 For faster navigation each digit key is a digit argument.
628 \\[bs-select] or SPACE -- select current line's buffer and other marked buffers.
629 \\[bs-toggle-show-all] -- toggle between all buffers and a special subset.
630 \\[bs-select-other-window] -- select current line's buffer in other window.
631 \\[bs-tmp-select-other-window] -- make another window display that buffer and
632 remain in Buffer Selection Menu.
633 \\[bs-mouse-select] -- select current line's buffer and other marked buffers.
634 \\[bs-save] -- save current line's buffer immediately.
635 \\[bs-delete] -- kill current line's buffer immediately.
636 \\[bs-toggle-readonly] -- toggle read-only status of current line's buffer.
637 \\[bs-clear-modified] -- clear modified-flag on that buffer.
638 \\[bs-mark-current] -- mark current line's buffer to be displayed.
639 \\[bs-unmark-current] -- unmark current line's buffer to be displayed.
640 \\[bs-show-sorted] -- display buffer list sorted by next sort aspect.
641 \\[bs-set-configuration-and-refresh] -- ask user for a configuration and \
642 apply selected configuration.
643 \\[bs-select-next-configuration] -- select and apply next \
644 available Buffer Selection Menu configuration.
645 \\[bs-kill] -- leave Buffer Selection Menu without a selection.
646 \\[bs-toggle-current-to-show] -- toggle status of appearance.
647 \\[bs-set-current-buffer-to-show-always] -- mark current line's buffer \
649 \\[bs-visit-tags-table] -- call `visit-tags-table' on current line's buffer.
650 \\[bs-help] -- display this help text."
652 (kill-all-local-variables)
653 (use-local-map bs-mode-map)
654 (make-local-variable 'font-lock-defaults)
655 (make-local-variable 'font-lock-verbose)
656 (setq major-mode 'bs-mode
657 mode-name "Buffer-Selection-Menu"
660 font-lock-defaults '(bs-mode-font-lock-keywords t)
661 font-lock-verbose nil)
662 (run-mode-hooks 'bs-mode-hook))
665 "Let buffer disappear and reset window-configuration."
667 (bury-buffer (current-buffer))
668 (set-window-configuration bs--window-config-coming-from))
671 "Ding and leave Buffer Selection Menu without a selection."
676 (defun bs-set-configuration-and-refresh ()
677 "Ask user for a configuration and apply selected configuration.
678 Refresh whole Buffer Selection Menu."
680 (call-interactively 'bs-set-configuration)
684 "Refresh whole Buffer Selection Menu."
688 (defun bs--window-for-buffer (buffer-name)
689 "Return a window showing a buffer with name BUFFER-NAME.
690 Take only windows of current frame into account.
691 Return nil if there is no such buffer."
693 (walk-windows (lambda (wind)
694 (if (string= (buffer-name (window-buffer wind))
696 (setq window wind))))
699 (defun bs--set-window-height ()
700 "Change the height of the selected window to suit the current buffer list."
701 (unless (one-window-p t)
702 (shrink-window (- (window-height (selected-window))
703 ;; window-height in xemacs includes mode-line
704 (+ (if bs--running-in-xemacs 3 1)
705 bs-header-lines-length
706 (min (length bs-current-list)
707 bs-max-window-height))))))
709 (defun bs--current-buffer ()
710 "Return buffer on current line.
711 Raise an error if not on a buffer line."
713 (let ((line (+ (- bs-header-lines-length)
714 (count-lines 1 (point)))))
716 (error "You are on a header row"))
717 (nth line bs-current-list)))
719 (defun bs--update-current-line ()
720 "Update the entry on current line for Buffer Selection Menu."
721 (let ((buffer (bs--current-buffer))
722 (inhibit-read-only t))
724 (delete-region (point) (line-end-position))
725 (bs--insert-one-entry buffer)
726 (beginning-of-line)))
729 "View current line's buffer in View mode.
730 Leave Buffer Selection Menu."
732 (view-buffer (bs--current-buffer)))
735 "Select current line's buffer and other marked buffers.
736 If there are no marked buffers the window configuration before starting
737 Buffer Selectin Menu will be restored.
738 If there are marked buffers each marked buffer and the current line's buffer
739 will be selected in a window.
740 Leave Buffer Selection Menu."
742 (let ((buffer (bs--current-buffer)))
743 (bury-buffer (current-buffer))
744 (set-window-configuration bs--window-config-coming-from)
745 (switch-to-buffer buffer)
746 (if bs--marked-buffers
747 ;; Some marked buffers for selection
748 (let* ((all (delq buffer bs--marked-buffers))
749 (height (/ (1- (frame-height)) (1+ (length all)))))
750 (delete-other-windows)
751 (switch-to-buffer buffer)
753 (split-window nil height)
755 (switch-to-buffer (car all))
756 (setq all (cdr all)))
757 ;; goto window we have started bs.
760 (defun bs-select-other-window ()
761 "Select current line's buffer by `switch-to-buffer-other-window'.
762 The window configuration before starting Buffer Selectin Menu will be restored
763 unless there is no other window. In this case a new window will be created.
764 Leave Buffer Selection Menu."
766 (let ((buffer (bs--current-buffer)))
767 (bury-buffer (current-buffer))
768 (set-window-configuration bs--window-config-coming-from)
769 (switch-to-buffer-other-window buffer)))
771 (defun bs-tmp-select-other-window ()
772 "Make the other window select this line's buffer.
773 The current window remains selected."
775 (let ((buffer (bs--current-buffer)))
776 (display-buffer buffer t)))
778 (defun bs-select-other-frame ()
779 "Select current line's buffer in new created frame.
780 Leave Buffer Selection Menu."
782 (let ((buffer (bs--current-buffer)))
783 (bury-buffer (current-buffer))
784 (set-window-configuration bs--window-config-coming-from)
785 (switch-to-buffer-other-frame buffer)))
787 (defun bs-mouse-select-other-frame (event)
788 "Select selected line's buffer in new created frame.
789 Leave Buffer Selection Menu.
790 EVENT: a mouse click EVENT."
792 (mouse-set-point event)
793 (bs-select-other-frame))
795 (defun bs-mouse-select (event)
796 "Select buffer on mouse click EVENT.
797 Select buffer by `bs-select'."
799 (mouse-set-point event)
802 (defun bs-select-in-one-window ()
803 "Select current line's buffer in one window and delete other windows.
804 Leave Buffer Selection Menu."
807 (delete-other-windows))
809 (defun bs-bury-buffer ()
810 "Bury buffer on current line."
812 (bury-buffer (bs--current-buffer))
816 "Save buffer on current line."
818 (let ((buffer (bs--current-buffer)))
822 (bs--update-current-line)))
824 (defun bs-visit-tags-table ()
825 "Visit the tags table in the buffer on this line.
826 See `visit-tags-table'."
828 (let ((file (buffer-file-name (bs--current-buffer))))
830 (visit-tags-table file)
831 (error "Specified buffer has no file"))))
833 (defun bs-toggle-current-to-show ()
834 "Toggle status of showing flag for buffer in current line."
836 (let ((buffer (bs--current-buffer))
840 (setq res (cond ((null bs-buffer-show-mark)
842 ((eq bs-buffer-show-mark 'never)
845 (setq bs-buffer-show-mark res))
846 (bs--update-current-line)
847 (bs--set-window-height)
848 (bs--show-config-message res)))
850 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
851 "Toggle status of buffer on line to `always shown'.
852 NOT-TO-SHOW-P: prefix argument.
853 With no prefix argument the buffer on current line is marked to show
854 always. Otherwise it is marked to show never."
857 (bs-set-current-buffer-to-show-never)
858 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
860 (defun bs-set-current-buffer-to-show-never ()
861 "Toggle status of buffer on line to `never shown'."
863 (bs--set-toggle-to-show (bs--current-buffer) 'never))
865 (defun bs--set-toggle-to-show (buffer what)
866 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
867 Redisplay current line and display a message describing
868 the status of buffer on current line."
869 (with-current-buffer buffer (setq bs-buffer-show-mark what))
870 (bs--update-current-line)
871 (bs--set-window-height)
872 (bs--show-config-message what))
874 (defun bs-mark-current (count)
876 COUNT is the number of buffers to mark.
877 Move cursor vertically down COUNT lines."
879 (let ((dir (if (> count 0) 1 -1))
882 (let ((buffer (bs--current-buffer)))
884 (setq bs--marked-buffers (cons buffer bs--marked-buffers)))
885 (bs--update-current-line)
887 (setq count (1- count)))))
889 (defun bs-unmark-current (count)
891 COUNT is the number of buffers to unmark.
892 Move cursor vertically down COUNT lines."
894 (let ((dir (if (> count 0) 1 -1))
897 (let ((buffer (bs--current-buffer)))
899 (setq bs--marked-buffers (delq buffer bs--marked-buffers)))
900 (bs--update-current-line)
902 (setq count (1- count)))))
904 (defun bs--show-config-message (what)
905 "Show message indicating the new showing status WHAT.
906 WHAT is a value of nil, `never', or `always'."
907 (bs-message-without-log (cond ((null what)
908 "Buffer will be shown normally.")
910 "Mark buffer to never be shown.")
911 (t "Mark buffer to show always."))))
914 "Kill buffer on current line."
916 (let ((current (bs--current-buffer))
917 (inhibit-read-only t))
918 (unless (kill-buffer current)
919 (error "Buffer was not deleted"))
920 (setq bs-current-list (delq current bs-current-list))
922 (delete-region (point) (save-excursion
924 (if (eobp) (point) (1+ (point)))))
927 (backward-delete-char 1)
930 (bs--set-window-height)))
932 (defun bs-delete-backward ()
933 "Like `bs-delete' but go to buffer in front of current."
935 (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
937 (unless on-last-line-p
940 (defun bs-show-sorted ()
941 "Show buffer list sorted by buffer name."
943 (setq bs--current-sort-function
944 (bs-next-config-aux (car bs--current-sort-function)
947 (bs--goto-current-buffer)
948 (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))
950 (defun bs-apply-sort-faces (&optional sort-description)
951 "Set text properties for the sort described by SORT-DESCRIPTION.
952 SORT-DESCRIPTION is an element of `bs-sort-functions'.
953 Default is `bs--current-sort-function'."
954 (let ((sort-description (or sort-description
955 bs--current-sort-function)))
957 (goto-char (point-min))
958 (if (and (nth 2 sort-description)
959 (search-forward-regexp (nth 2 sort-description) nil t))
960 (let ((inhibit-read-only t))
961 (put-text-property (match-beginning 0)
964 (or (nth 3 sort-description)
967 (defun bs-toggle-show-all ()
968 "Toggle show all buffers / show buffers with current configuration."
970 (setq bs--show-all (not bs--show-all))
972 (bs--goto-current-buffer)
973 (bs-message-without-log "%s" (bs--current-config-message)))
975 (defun bs-toggle-readonly ()
976 "Toggle read-only status for buffer on current line.
977 Uses function `vc-toggle-read-only'."
979 (let ((buffer (bs--current-buffer)))
982 (vc-toggle-read-only))
983 (bs--update-current-line)))
985 (defun bs-clear-modified ()
986 "Set modified flag for buffer on current line to nil."
988 (let ((buffer (bs--current-buffer)))
991 (set-buffer-modified-p nil)))
992 (bs--update-current-line))
994 (defun bs--nth-wrapper (count fun &rest args)
995 "Call COUNT times function FUN with arguments ARGS."
996 (setq count (or count 1))
999 (setq count (1- count))))
1002 "Move cursor vertically up ARG lines in Buffer Selection Menu."
1004 (if (and arg (numberp arg) (< arg 0))
1005 (bs--nth-wrapper (- arg) 'bs--down)
1006 (bs--nth-wrapper arg 'bs--up)))
1009 "Move cursor vertically up one line.
1010 If on top of buffer list go to last line."
1013 (if (<= (count-lines 1 (point)) (1- bs-header-lines-length))
1015 (goto-char (point-max))
1018 (beginning-of-line)))
1020 (defun bs-down (arg)
1021 "Move cursor vertically down ARG lines in Buffer Selection Menu."
1023 (if (and arg (numberp arg) (< arg 0))
1024 (bs--nth-wrapper (- arg) 'bs--up)
1025 (bs--nth-wrapper arg 'bs--down)))
1028 "Move cursor vertically down one line.
1029 If at end of buffer list go to first line."
1030 (let ((last (line-end-position)))
1031 (if (eq last (point-max))
1032 (goto-line (1+ bs-header-lines-length))
1035 (defun bs-visits-non-file (buffer)
1036 "Return t or nil whether BUFFER visits no file.
1037 A value of t means BUFFER belongs to no file.
1038 A value of nil means BUFFER belongs to a file."
1039 (not (buffer-file-name buffer)))
1041 (defun bs-sort-buffer-interns-are-last (b1 b2)
1042 "Function for sorting internal buffers B1 and B2 at the end of all buffers."
1043 (string-match "^\\*" (buffer-name b2)))
1045 ;; ----------------------------------------------------------------------
1047 ;; ----------------------------------------------------------------------
1049 (defun bs-config-clear ()
1050 "*Reset all variables which specify a configuration.
1051 These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
1052 `bs-dont-show-function', `bs-must-show-function' and
1053 `bs-buffer-sort-function'."
1054 (setq bs-dont-show-regexp nil
1055 bs-must-show-regexp nil
1056 bs-dont-show-function nil
1057 bs-must-show-function nil
1058 bs-buffer-sort-function nil))
1060 (defun bs-config--only-files ()
1061 "Define a configuration for showing only buffers visiting a file."
1063 (setq ;; I want to see *-buffers at the end
1064 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1065 ;; Don't show files who don't belong to a file
1066 bs-dont-show-function 'bs-visits-non-file))
1068 (defun bs-config--files-and-scratch ()
1069 "Define a configuration for showing buffer *scratch* and file buffers."
1071 (setq ;; I want to see *-buffers at the end
1072 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1073 ;; Don't show files who don't belong to a file
1074 bs-dont-show-function 'bs-visits-non-file
1075 ;; Show *scratch* buffer.
1076 bs-must-show-regexp "^\\*scratch\\*$"))
1078 (defun bs-config--all ()
1079 "Define a configuration for showing all buffers.
1080 Reset all according variables by `bs-config-clear'."
1083 (defun bs-config--all-intern-last ()
1084 "Define a configuration for showing all buffers.
1085 Internal buffers appear at end of all buffers."
1087 ;; I want to see *-buffers at the end
1088 (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))
1090 (defun bs-set-configuration (name)
1091 "Set configuration to the one saved under string NAME in `bs-configurations'.
1092 When called interactively ask user for a configuration and apply selected
1094 (interactive (list (completing-read "Use configuration: "
1098 (let ((list (assoc name bs-configurations)))
1101 (setq bs-current-configuration name
1102 bs-must-show-regexp (nth 1 list)
1103 bs-must-show-function (nth 2 list)
1104 bs-dont-show-regexp (nth 3 list)
1105 bs-dont-show-function (nth 4 list)
1106 bs-buffer-sort-function (nth 5 list))
1107 ;; for backward compability
1108 (funcall (cdr list)))
1111 (bs-message-without-log "No bs-configuration named %S." name))))
1114 "Help for `bs-show'."
1116 (describe-function 'bs-mode))
1118 (defun bs-next-config-aux (start-name list)
1119 "Get the next assoc after START-NAME in list LIST.
1120 Will return the first if START-NAME is at end."
1122 (length (length list))
1124 (while (and assocs (not pos))
1125 (if (string= (car (car assocs)) start-name)
1126 (setq pos (- length (length assocs))))
1127 (setq assocs (cdr assocs)))
1133 (defun bs-next-config (name)
1134 "Return next configuration with respect to configuration with name NAME."
1135 (bs-next-config-aux name bs-configurations))
1137 (defun bs-select-next-configuration (&optional start-name)
1138 "Apply next configuration START-NAME and refresh buffer list.
1139 If START-NAME is nil the current configuration `bs-current-configuration'
1142 (let ((config (bs-next-config (or start-name bs-current-configuration))))
1143 (bs-set-configuration (car config))
1144 (setq bs-default-configuration bs-current-configuration)
1146 (bs--set-window-height)
1147 (bs-message-without-log "Selected configuration: %s" (car config))))
1149 (defun bs-show-in-buffer (list)
1150 "Display buffer list LIST in buffer *buffer-selection*.
1151 Select buffer *buffer-selection* and display buffers according to current
1152 configuration `bs-current-configuration'. Set window height, fontify buffer
1153 and move point to current buffer."
1154 (setq bs-current-list list)
1155 (switch-to-buffer (get-buffer-create "*buffer-selection*"))
1157 (let* ((inhibit-read-only t)
1158 (map-fun (lambda (entry)
1159 (length (buffer-name entry))))
1160 (max-length-of-names (apply 'max
1161 (cons 0 (mapcar map-fun list))))
1162 (name-entry-length (min bs-maximal-buffer-name-column
1163 (max bs-minimal-buffer-name-column
1164 max-length-of-names))))
1166 (setq bs--name-entry-length name-entry-length)
1169 (bs--insert-one-entry (car list))
1171 (setq list (cdr list)))
1172 (delete-backward-char 1)
1173 (bs--set-window-height)
1174 (bs--goto-current-buffer)
1175 (font-lock-fontify-buffer)
1176 (bs-apply-sort-faces)))
1178 (defun bs-next-buffer (&optional buffer-list sorting-p)
1179 "Return next buffer and buffer list for buffer cycling in BUFFER-LIST.
1180 Ignore sorting when SORTING-P is nil.
1181 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1182 buffer list. The result is a cons of normally the second element of
1183 BUFFER-LIST and the buffer list used for buffer cycling."
1184 (let* ((bs--current-sort-function (if sorting-p
1185 bs--current-sort-function))
1186 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1187 (cons (or (car (cdr bs-buffer-list))
1188 (car bs-buffer-list)
1192 (defun bs-previous-buffer (&optional buffer-list sorting-p)
1193 "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST.
1194 Ignore sorting when SORTING-P is nil.
1195 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1196 buffer list. The result is a cons of last element of BUFFER-LIST and the
1197 buffer list used for buffer cycling."
1198 (let* ((bs--current-sort-function (if sorting-p
1199 bs--current-sort-function))
1200 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1201 (cons (or (car (last bs-buffer-list))
1205 (defun bs-message-without-log (&rest args)
1206 "Like `message' but don't log it on the message log.
1207 All arguments ARGS are transferred to function `message'."
1208 (let ((message-log-max nil))
1209 (apply 'message args)))
1211 (defvar bs--cycle-list nil
1212 "Current buffer list used for cycling.")
1215 (defun bs-cycle-next ()
1216 "Select next buffer defined by buffer cycling.
1217 The buffers taking part in buffer cycling are defined
1218 by buffer configuration `bs-cycle-configuration-name'."
1220 (let ((bs--buffer-coming-from (current-buffer))
1221 (bs-dont-show-regexp bs-dont-show-regexp)
1222 (bs-must-show-regexp bs-must-show-regexp)
1223 (bs-dont-show-function bs-dont-show-function)
1224 (bs-must-show-function bs-must-show-function)
1226 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1227 (let ((bs-buffer-sort-function nil)
1228 (bs--current-sort-function nil))
1229 (let* ((tupel (bs-next-buffer (if (or (eq last-command
1232 'bs-cycle-previous))
1235 (cycle-list (cdr tupel)))
1236 (setq bs--cycle-list (append (cdr cycle-list)
1237 (list (car cycle-list))))
1239 (switch-to-buffer next)
1240 (bs-message-without-log "Next buffers: %s"
1241 (or (cdr bs--cycle-list)
1246 (defun bs-cycle-previous ()
1247 "Select previous buffer defined by buffer cycling.
1248 The buffers taking part in buffer cycling are defined
1249 by buffer configuration `bs-cycle-configuration-name'."
1251 (let ((bs--buffer-coming-from (current-buffer))
1252 (bs-dont-show-regexp bs-dont-show-regexp)
1253 (bs-must-show-regexp bs-must-show-regexp)
1254 (bs-dont-show-function bs-dont-show-function)
1255 (bs-must-show-function bs-must-show-function)
1257 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1258 (let ((bs-buffer-sort-function nil)
1259 (bs--current-sort-function nil))
1260 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1263 'bs-cycle-previous))
1265 (prev-buffer (car tupel))
1266 (cycle-list (cdr tupel)))
1267 (setq bs--cycle-list (append (last cycle-list)
1268 (reverse (cdr (reverse cycle-list)))))
1269 (switch-to-buffer prev-buffer)
1270 (bs-message-without-log "Previous buffers: %s"
1271 (or (reverse (cdr bs--cycle-list))
1274 (defun bs--get-value (fun &optional args)
1275 "Apply function FUN with arguments ARGS.
1276 Return result of evaluation. Will return FUN if FUN is a number
1278 (cond ((numberp fun)
1282 (t (apply fun args))))
1284 (defun bs--get-marked-string (start-buffer all-buffers)
1285 "Return a string which describes whether current buffer is marked.
1286 START-BUFFER is the buffer where we started buffer selection.
1287 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu.
1288 The result string is one of `bs-string-current', `bs-string-current-marked',
1289 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1290 `bs-string-show-always'."
1291 (cond ;; current buffer is the buffer we started buffer selection.
1292 ((eq (current-buffer) start-buffer)
1293 (if (memq (current-buffer) bs--marked-buffers)
1294 bs-string-current-marked ; buffer is marked
1296 ;; current buffer is marked
1297 ((memq (current-buffer) bs--marked-buffers)
1299 ;; current buffer hasn't a special mark.
1300 ((null bs-buffer-show-mark)
1301 bs-string-show-normally)
1302 ;; current buffer has a mark not to show itself.
1303 ((eq bs-buffer-show-mark 'never)
1304 bs-string-show-never)
1305 ;; otherwise current buffer is marked to show always.
1307 bs-string-show-always)))
1309 (defun bs--get-modified-string (start-buffer all-buffers)
1310 "Return a string which describes whether current buffer is modified.
1311 START-BUFFER is the buffer where we started buffer selection.
1312 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1313 (if (buffer-modified-p) "*" " "))
1315 (defun bs--get-readonly-string (start-buffer all-buffers)
1316 "Return a string which describes whether current buffer is read only.
1317 START-BUFFER is the buffer where we started buffer selection.
1318 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1319 (if buffer-read-only "%" " "))
1321 (defun bs--get-size-string (start-buffer all-buffers)
1322 "Return a string which describes the size of current buffer.
1323 START-BUFFER is the buffer where we started buffer selection.
1324 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1325 (int-to-string (buffer-size)))
1327 (defun bs--get-name (start-buffer all-buffers)
1328 "Return name of current buffer for Buffer Selection Menu.
1329 The name of current buffer gets additional text properties
1330 for mouse highlighting.
1331 START-BUFFER is the buffer where we started buffer selection.
1332 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1333 (let ((name (copy-sequence (buffer-name))))
1334 (add-text-properties
1336 '(mouse-face highlight
1338 "mouse-2: select this buffer, mouse-3: select in other frame")
1340 (if (< (length name) bs--name-entry-length)
1342 (make-string (- bs--name-entry-length (length name)) ? ))
1345 (defun bs--get-mode-name (start-buffer all-buffers)
1346 "Return the name of mode of current buffer for Buffer Selection Menu.
1347 START-BUFFER is the buffer where we started buffer selection.
1348 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1351 (defun bs--get-file-name (start-buffer all-buffers)
1352 "Return string for column 'File' in Buffer Selection Menu.
1353 This is the variable `buffer-file-name' of current buffer.
1354 If current mode is `dired-mode' or `shell-mode' it returns the
1356 START-BUFFER is the buffer where we started buffer selection.
1357 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1358 (let ((string (copy-sequence (if (member major-mode
1359 '(shell-mode dired-mode))
1361 (or buffer-file-name "")))))
1362 (add-text-properties
1364 '(mouse-face highlight
1365 help-echo "mouse-2: select this buffer, mouse-3: select in other frame")
1369 (defun bs--insert-one-entry (buffer)
1370 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1371 It goes over all columns described in `bs-attributes-list'
1372 and evaluates corresponding string. Inserts string in current buffer;
1373 normally *buffer-selection*."
1375 (columns bs-attributes-list)
1377 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1381 (let ((min (bs--get-value (nth 1 (car columns))))
1382 ;;(max (bs--get-value (nth 2 (car columns)))) refered no more
1383 (align (nth 3 (car columns)))
1384 (fun (nth 4 (car columns)))
1387 (setq val (bs--get-value fun apply-args))
1388 (setq new-string (bs--format-aux val align (- min to-much)))
1389 (setq string (concat string new-string))
1390 (if (> (length new-string) min)
1391 (setq to-much (- (length new-string) min)))
1393 (setq columns (cdr columns))))
1397 (defun bs--format-aux (string align len)
1398 "Generate a string with STRING with alignment ALIGN and length LEN.
1399 ALIGN is one of the symbols `left', `middle', or `right'."
1400 (let ((length (length string)))
1403 (if (eq 'right align)
1404 (concat (make-string (- len length) ? ) string)
1405 (concat string (make-string (- len length) ? ))))))
1407 (defun bs--show-header ()
1408 "Insert header for Buffer Selection Menu in current buffer."
1409 (mapcar '(lambda (string)
1410 (insert string "\n"))
1411 (bs--create-header)))
1413 (defun bs--get-name-length ()
1414 "Return value of `bs--name-entry-length'."
1415 bs--name-entry-length)
1417 (defun bs--create-header ()
1418 "Return all header lines used in Buffer Selection Menu as a list of strings."
1419 (list (mapconcat (lambda (column)
1420 (bs--format-aux (bs--get-value (car column))
1421 (nth 3 column) ; align
1422 (bs--get-value (nth 1 column))))
1425 (mapconcat (lambda (column)
1426 (let ((length (length (bs--get-value (car column)))))
1427 (bs--format-aux (make-string length ?-)
1428 (nth 3 column) ; align
1429 (bs--get-value (nth 1 column)))))
1433 (defun bs--show-with-configuration (name &optional arg)
1434 "Display buffer list of configuration with name NAME.
1435 Set configuration NAME and determine window for Buffer Selection Menu.
1436 Unless current buffer is buffer *buffer-selection* we have to save
1437 the buffer we started Buffer Selection Menu and the current window
1438 configuration to restore buffer and window configuration after a
1439 selection. If there is already a window displaying *buffer-selection*
1440 select this window for Buffer Selection Menu. Otherwise open a new
1442 The optional argument ARG is the prefix argument when calling a function
1443 for buffer selection."
1444 (bs-set-configuration name)
1445 (let ((bs--show-all (or bs--show-all arg)))
1446 (unless (string= "*buffer-selection*" (buffer-name))
1447 ;; Only when not in buffer *buffer-selection*
1448 ;; we have to set the buffer we started the command
1450 (setq bs--buffer-coming-from (current-buffer))
1451 (setq bs--window-config-coming-from (current-window-configuration))))
1452 (let ((liste (bs-buffer-list))
1453 (active-window (bs--window-for-buffer "*buffer-selection*")))
1455 (select-window active-window)
1456 (if (> (window-height (selected-window)) 7)
1458 (split-window-vertically)
1460 (bs-show-in-buffer liste)
1461 (bs-message-without-log "%s" (bs--current-config-message)))))
1463 (defun bs--configuration-name-for-prefix-arg (prefix-arg)
1464 "Convert prefix argument PREFIX-ARG to a name of a buffer configuration.
1465 If PREFIX-ARG is nil return `bs-default-configuration'.
1466 If PREFIX-ARG is an integer return PREFIX-ARG element of `bs-configurations'.
1467 Otherwise return `bs-alternative-configuration'."
1468 (cond ;; usually activation
1470 bs-default-configuration)
1471 ;; call with integer as prefix argument
1472 ((integerp prefix-arg)
1473 (if (and (< 0 prefix-arg) (<= prefix-arg (length bs-configurations)))
1474 (car (nth (1- prefix-arg) bs-configurations))
1475 bs-default-configuration))
1476 ;; call by prefix argument C-u
1477 (t bs-alternative-configuration)))
1479 ;; ----------------------------------------------------------------------
1480 ;; Main function bs-customize and bs-show
1481 ;; ----------------------------------------------------------------------
1484 (defun bs-customize ()
1485 "Customization of group bs for Buffer Selection Menu."
1487 (customize-group "bs"))
1490 (defun bs-show (arg)
1491 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1493 There are many key commands similar to `Buffer-menu-mode' for
1494 manipulating buffer list and buffers itself.
1495 User can move with [up] or [down], select a buffer
1496 by \\[bs-select] or [SPC]\n
1497 Type \\[bs-kill] to leave Buffer Selection Menu without a selection.
1498 Type \\[bs-help] after invocation to get help on commands available.
1499 With prefix argument ARG show a different buffer list. Function
1500 `bs--configuration-name-for-prefix-arg' determine accordingly
1501 name of buffer configuration."
1503 (setq bs--marked-buffers nil)
1504 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1506 ;; Now provide feature bs
1509 ;;; arch-tag: c0d9ab34-bf06-4368-ae9d-af88878e6802