1 ;;; bs.el --- menu for selecting and displaying buffers
3 ;; Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
4 ;; Author: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
5 ;; Maintainer: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
6 ;; Keywords: convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
28 ;; X-URL: http://home.netsurf.de/olaf.sylvester/emacs
30 ;; The bs-package contains a main function bs-show for poping up a
31 ;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
32 ;; The new buffer offers a Buffer Selection Menu for manipulating
33 ;; the buffer list and buffers.
35 ;; -----------------------------------------------------------------------
36 ;; | MR Buffer Size Mode File |
37 ;; | -- ------ ---- ---- ---- |
38 ;; |. bs.el 14690 Emacs-Lisp /home/sun/sylvester/el/bs.e$|
39 ;; | % executable.el 9429 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
40 ;; | % vc.el 104893 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
41 ;; | % test_vc.el 486 Emacs-Lisp /home/sun/sylvester/el/test$|
42 ;; | % vc-hooks.el 43605 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
43 ;; -----------------------------------------------------------------------
45 ;;; Quick Installation und Customization:
49 ;; for buffer selection or optional bind a key to main function `bs-show'
50 ;; (global-set-key "\C-x\C-b" 'bs-show) ;; or another key
52 ;; For customization use
58 ;; bs-show will generate a new buffer named *buffer-selection*, which shows
59 ;; all buffers or a subset of them, and has possibilities for deleting,
60 ;; saving and selecting buffers. For more details see docstring of
61 ;; function `bs-mode'. A current configuration describes which buffers appear
62 ;; in *buffer-selection*. See docstring of variable `bs-configurations' for
65 ;; The package bs combines the advantages of the Emacs functions
66 ;; `list-buffers' and `electric-buffer-list'.
68 ;; Additional features for Buffer Selection Menu:
69 ;; - configurable list of buffers (show only files etc.).
70 ;; - comfortable way to change displayed subset of all buffers.
71 ;; - show sorted list of buffers.
72 ;; - cyclic navigation:
73 ;; - goes to top of buffer list if you are on last line and press down.
74 ;; - goes to end of buffer list if you are on first line and press up.
75 ;; - Offer an alternative buffer list by prefix key C-u.
77 ;;; Cycling through buffers
79 ;; This package offers two functions for buffer cycling. If you want to cycle
80 ;; through buffer list you can use `bs-cycle-next' or `bs-cycle-previous'.
81 ;; Bind these function to a key like
82 ;; (global-set-key [(f9)] 'bs-cycle-previous)
83 ;; (global-set-key [(f10)] 'bs-cycle-next)
85 ;; Both functions use a special subset of all buffers for cycling to avoid
86 ;; to go through internal buffers like *Messages*.
88 ;; Cycling through buffers ignores sorting because sorting destroys
89 ;; the logical buffer list. If buffer list is sorted by size you
90 ;; won't be able to cycle to the smallest buffer.
94 ;; There is a customization group called `bs' in group `convenience'.
95 ;; Start customization by M-x bs-customize
99 ;; You can define your own configurations by extending variable
100 ;; `bs-configurations' (see docstring for details).
102 ;; `bs-default-configuration' contains the name of default configuration.
103 ;; The default value is "files" which means to show only files.
105 ;; If you always want to see all buffers, customize variable
106 ;; `bs-default-configuration' in customization group `bs'.
110 ;; You can define functions for sorting the buffer list.
111 ;; When selecting buffers, you can step through available sorting
112 ;; methods with key 'S'.
113 ;; To define a new way of sorting, customize variable `bs-sort-functions'.
115 ;; There are four basic functions for sorting:
116 ;; by buffer name, by mode, by size, or by filename
118 ;; Configure buffer cycling
119 ;; ------------------------
120 ;; When cycling through buffer list the functions for cycling will use
121 ;; the current configuration of bs to calculate the buffer list.
122 ;; If you want to use a different configuration for cycling you have to set
123 ;; the variable `bs-cycle-configuration-name'. You can customize this variable.
125 ;; For example: If you use the configuration called "files-and-scratch" you
126 ;; can cycle through all file buffers and *scratch* although your current
127 ;; configuration perhaps is "files" which ignores buffer *scratch*.
133 ;; ----------------------------------------------------------------------
134 ;; Globals for customization
135 ;; ----------------------------------------------------------------------
138 "Buffer Selection: Maintaining buffers by buffer menu."
140 :link
'(emacs-commentary-link "bs")
141 :link
'(url-link "http://home.netsurf.de/olaf.sylvester/emacs")
144 (defgroup bs-appearance nil
145 "Buffer Selection appearance: Appearance of bs buffer menu."
148 (defcustom bs-attributes-list
149 '(("" 1 1 left bs--get-marked-string
)
150 ("M" 1 1 left bs--get-modified-string
)
151 ("R" 2 2 left bs--get-readonly-string
)
152 ("Buffer" bs--get-name-length
10 left bs--get-name
)
154 ("Size" 8 8 right bs--get-size-string
)
156 ("Mode" 12 12 right bs--get-mode-name
)
158 ("File" 12 12 left bs--get-file-name
)
160 "*List specifying the layout of a Buffer Selection Menu buffer.
161 Each entry specifies a column and is a list of the form of:
162 \(HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING)
163 HEADER : string for header for first line or a function
164 which calculates column title.
165 MINIMUM-LENGTH : minimum width of column (number or name of function).
166 The function must return a positive integer.
167 MAXIMUM-LENGTH : maximum width of column (number or name of function)
169 ALIGNMENT : alignment of column: (`left' `right' `middle')
170 FUN-OR-STRING : Name of a function for calculating the value or
171 a string for a constant value.
172 The function gets as parameter the buffer where we have started
173 buffer selection and the list of all buffers to show. The function must
174 return a string representing the column's value."
175 :group
'bs-appearance
176 :type
'(repeat sexp
))
178 (defvar bs--running-in-xemacs
(string-match "XEmacs" (emacs-version))
179 "Non-nil when running under XEmacs.")
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.")
247 (defcustom bs-maximal-buffer-name-column
45
248 "*Maximum column width for buffer names.
249 The column for buffer names has dynamic width. The width depends on
250 maximal and minimal length of names of buffers to show. The maximal
251 width is bounded by `bs-maximal-buffer-name-column'.
252 See also `bs-minimal-buffer-name-column'."
253 :group
'bs-appearance
256 (defcustom bs-minimal-buffer-name-column
15
257 "*Minimum column width for buffer names.
258 The column for buffer names has dynamic width. The width depends on
259 maximal and minimal length of names of buffers to show. The minimal
260 width is bounded by `bs-minimal-buffer-name-column'.
261 See also `bs-maximal-buffer-name-column'."
262 :group
'bs-appearance
265 (defconst bs-header-lines-length
2
266 "Number of lines for headers in Buffer Selection Menu.")
268 (defcustom bs-configurations
269 '(("all" nil nil nil nil nil
)
270 ("files" nil nil nil bs-visits-non-file bs-sort-buffer-interns-are-last
)
271 ("files-and-scratch" "^\\*scratch\\*$" nil nil bs-visits-non-file
272 bs-sort-buffer-interns-are-last
)
273 ("all-intern-last" nil nil nil nil bs-sort-buffer-interns-are-last
))
274 "*List of all configurations you can use in the Buffer Selection Menu.
275 A configuration describes which buffers appear in Buffer Selection Menu
276 and also the order of buffers. A configuration is a list with
277 six elements. The first element is a string and describes the configuration.
278 The following five elements represent the values for Buffer Selection Menu
279 configuration variables `bs-must-show-regexp', `bs-must-show-function',
280 `bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'.
281 By setting these variables you define a configuration."
282 :group
'bs-appearance
283 :type
'(repeat sexp
))
285 (defcustom bs-default-configuration
"files"
286 "*Name of default configuration used by the Buffer Selection Menu.
288 Will be changed using key \\[bs-select-next-configuration].
289 Must be a string used in `bs-configurations' for naming a configuration."
293 (defcustom bs-alternative-configuration
"all"
294 "*Name of configuration used when calling `bs-show' with \
295 \\[universal-argument] as prefix key.
296 Must be a string used in `bs-configurations' for naming a configuration."
300 (defvar bs-current-configuration bs-default-configuration
301 "Name of current configuration.
302 Must be a string used in `bs-configurations' for naming a configuration.")
304 (defcustom bs-cycle-configuration-name nil
305 "*Name of configuration used when cycling through the buffer list.
306 A value of nil means to use current configuration `bs-default-configuration'.
307 Must be a string used in `bs-configurations' for naming a configuration."
309 :type
'(choice (const :tag
"like current configuration" nil
)
312 (defcustom bs-string-show-always
"+"
313 "*String added in column 1 indicating a buffer will always be shown."
314 :group
'bs-appearance
317 (defcustom bs-string-show-never
"-"
318 "*String added in column 1 indicating a buffer will never be shown."
319 :group
'bs-appearance
322 (defcustom bs-string-current
"."
323 "*String added in column 1 indicating the current buffer."
324 :group
'bs-appearance
327 (defcustom bs-string-current-marked
"#"
328 "*String added in column 1 indicating the current buffer when it is marked."
329 :group
'bs-appearance
332 (defcustom bs-string-marked
">"
333 "*String added in column 1 indicating a marked buffer."
334 :group
'bs-appearance
337 (defcustom bs-string-show-normally
" "
338 "*String added in column 1 indicating a unmarked buffer."
339 :group
'bs-appearance
342 (defvar bs--name-entry-length
20
343 "Maximum length of all displayed buffer names.
344 Used internally, only.")
346 ;; ----------------------------------------------------------------------
348 ;; ----------------------------------------------------------------------
350 (defvar bs-buffer-show-mark nil
351 "Flag for the current mode for showing this buffer.
352 A value of nil means buffer will be shown depending on the current
354 A value of `never' means to never show the buffer.
355 A value of `always' means to show buffer regardless of the configuration.")
357 (make-variable-buffer-local 'bs-buffer-show-mark
)
359 ;; Make face named region (for XEmacs)
360 (unless (facep 'region
)
362 (set-face-background 'region
"gray75"))
364 (defun bs--sort-by-name (b1 b2
)
365 "Compare buffers B1 and B2 by buffer name."
366 (string< (buffer-name b1
)
369 (defun bs--sort-by-filename (b1 b2
)
370 "Compare buffers B1 and B2 by file name."
371 (string< (or (buffer-file-name b1
) "")
372 (or (buffer-file-name b2
) "")))
374 (defun bs--sort-by-mode (b1 b2
)
375 "Compare buffers B1 and B2 by mode name."
377 (string< (progn (set-buffer b1
) (format "%s" mode-name
))
378 (progn (set-buffer b2
) (format "%s" mode-name
)))))
380 (defun bs--sort-by-size (b1 b2
)
381 "Compare buffers B1 and B2 by buffer size."
383 (< (progn (set-buffer b1
) (buffer-size))
384 (progn (set-buffer b2
) (buffer-size)))))
386 (defcustom bs-sort-functions
387 '(("by name" bs--sort-by-name
"Buffer" region
)
388 ("by size" bs--sort-by-size
"Size" region
)
389 ("by mode" bs--sort-by-mode
"Mode" region
)
390 ("by filename" bs--sort-by-filename
"File" region
)
391 ("by nothing" nil nil nil
))
392 "*List of all possible sorting aspects for Buffer Selection Menu.
393 You can add a new entry with a call to `bs-define-sort-function'.
394 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE)
395 NAME specifies the sort order defined by function FUNCTION.
396 FUNCTION nil means don't sort the buffer list. Otherwise the functions
397 must have two parameters - the buffers to compare.
398 REGEXP-FOR-SORTING is a regular expression which describes the
399 column title to highlight.
400 FACE is a face used to fontify the sorted column title. A value of nil means
403 :type
'(repeat sexp
))
405 (defun bs-define-sort-function (name fun
&optional regexp-for-sorting face
)
406 "Define a new function for buffer sorting in Buffer Selection Menu.
407 NAME specifies the sort order defined by function FUN.
408 A value of nil for FUN means don't sort the buffer list. Otherwise the
409 functions must have two parameters - the buffers to compare.
410 REGEXP-FOR-SORTING is a regular expression which describes the
411 column title to highlight.
412 FACE is a face used to fontify the sorted column title. A value of nil means
414 The new sort aspect will be inserted into list `bs-sort-functions'."
415 (let ((tupel (assoc name bs-sort-functions
)))
417 (setcdr tupel
(list fun regexp-for-sorting face
))
418 (setq bs-sort-functions
419 (cons (list name fun regexp-for-sorting face
)
420 bs-sort-functions
)))))
422 (defvar bs--current-sort-function nil
423 "Description of the current function for sorting the buffer list.
424 This is an element of `bs-sort-functions'.")
426 (defcustom bs-default-sort-name
"by nothing"
427 "*Name of default sort behavior.
428 Must be \"by nothing\" or a string used in `bs-sort-functions' for
429 naming a sort behavior. Default is \"by nothing\" which means no sorting."
432 :set
(lambda (var-name value
)
434 (setq bs--current-sort-function
435 (assoc value bs-sort-functions
))))
437 (defvar bs--buffer-coming-from nil
438 "The buffer in which the user started the current Buffer Selection Menu.")
440 (defvar bs--show-all nil
441 "Flag whether showing all buffers regardless of current configuration.
442 Non nil means to show all buffers. Otherwise show buffers
443 defined by current configuration `bs-current-configuration'.")
445 (defvar bs--window-config-coming-from nil
446 "Window configuration before starting Buffer Selection Menu.")
448 (defvar bs--intern-show-never
"^ \\|\\*buffer-selection\\*"
449 "Regular expression specifying which buffers never to show.
450 A buffer whose name matches this regular expression will never be
451 included in the buffer list.")
453 (defvar bs-current-list nil
454 "List of buffers shown in Buffer Selection Menu.
455 Used internally, only.")
457 (defvar bs--marked-buffers nil
458 "Currently marked buffers in Buffer Selection Menu.")
460 (defvar bs-mode-map
()
461 "Keymap of `bs-mode'.")
465 (setq bs-mode-map
(make-sparse-keymap))
466 (define-key bs-mode-map
" " 'bs-select
)
467 (define-key bs-mode-map
"f" 'bs-select
)
468 (define-key bs-mode-map
"v" 'bs-view
)
469 (define-key bs-mode-map
"!" 'bs-select-in-one-window
)
470 (define-key bs-mode-map
[mouse-2
] 'bs-mouse-select
) ;; for GNU EMACS
471 (define-key bs-mode-map
[button2] 'bs-mouse-select) ;; for XEmacs
472 (define-key bs-mode-map "F" 'bs-select-other-frame)
476 (define-key bs-mode-map (char-to-string key) 'digit-argument)
477 (setq key (1+ key))))
479 (define-key bs-mode-map "-" 'negative-argument)
480 (define-key bs-mode-map "\e-" 'negative-argument)
482 (define-key bs-mode-map "o" 'bs-select-other-window)
483 (define-key bs-mode-map "\C-o" 'bs-tmp-select-other-window)
485 (define-key bs-mode-map [mouse-3] 'bs-mouse-select-other-frame)
487 (define-key bs-mode-map [button3] 'bs-mouse-select-other-frame)
488 (define-key bs-mode-map [up] 'bs-up)
489 (define-key bs-mode-map "n" 'bs-down)
490 (define-key bs-mode-map "p" 'bs-up)
491 (define-key bs-mode-map [down] 'bs-down)
492 (define-key bs-mode-map "\C-m" 'bs-select)
493 (define-key bs-mode-map "b" 'bs-bury-buffer)
494 (define-key bs-mode-map "s" 'bs-save)
495 (define-key bs-mode-map "S" 'bs-show-sorted)
496 (define-key bs-mode-map "a" 'bs-toggle-show-all)
497 (define-key bs-mode-map "d" 'bs-delete)
498 (define-key bs-mode-map "\C-d" 'bs-delete-backward)
499 (define-key bs-mode-map "k" 'bs-delete)
500 (define-key bs-mode-map "g" 'bs-refresh)
501 (define-key bs-mode-map "C" 'bs-set-configuration-and-refresh)
502 (define-key bs-mode-map "c" 'bs-select-next-configuration)
503 (define-key bs-mode-map "q" 'bs-kill)
504 ;; (define-key bs-mode-map "z" 'bs-kill)
505 (define-key bs-mode-map "\C-c\C-c" 'bs-kill)
506 (define-key bs-mode-map "\C-g" 'bs-abort)
507 (define-key bs-mode-map "\C-]" 'bs-abort)
508 (define-key bs-mode-map "%" 'bs-toggle-readonly)
509 (define-key bs-mode-map "~" 'bs-clear-modified)
510 (define-key bs-mode-map "M" 'bs-toggle-current-to-show)
511 (define-key bs-mode-map "+" 'bs-set-current-buffer-to-show-always)
512 ;;(define-key bs-mode-map "-" 'bs-set-current-buffer-to-show-never)
513 (define-key bs-mode-map "t" 'bs-visit-tags-table)
514 (define-key bs-mode-map "m" 'bs-mark-current)
515 (define-key bs-mode-map "u" 'bs-unmark-current)
516 (define-key bs-mode-map ">" 'scroll-right)
517 (define-key bs-mode-map "<" 'scroll-left)
518 (define-key bs-mode-map "\e\e" nil)
519 (define-key bs-mode-map "\e\e\e" 'bs-kill)
520 (define-key bs-mode-map [escape escape escape] 'bs-kill)
521 (define-key bs-mode-map "?" 'bs-help))
523 ;; ----------------------------------------------------------------------
525 ;; ----------------------------------------------------------------------
527 (defun bs-buffer-list (&optional list sort-description)
528 "Return a list of buffers to be shown.
529 LIST is a list of buffers to test for appearance in Buffer Selection Menu.
530 The result list depends on the global variables `bs-dont-show-regexp',
531 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
532 and `bs-buffer-sort-function'.
533 If SORT-DESCRIPTION isn't nil the list will be sorted by
534 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
535 (setq sort-description (or sort-description bs--current-sort-function)
536 list (or list (buffer-list)))
539 (let* ((buffername (buffer-name (car list)))
540 (int-show-never (string-match bs--intern-show-never buffername))
541 (ext-show-never (and bs-dont-show-regexp
542 (string-match bs-dont-show-regexp
544 (extern-must-show (or (and bs-must-always-show-regexp
546 bs-must-always-show-regexp
548 (and bs-must-show-regexp
549 (string-match bs-must-show-regexp
551 (extern-show-never-from-fun (and bs-dont-show-function
552 (funcall bs-dont-show-function
554 (extern-must-show-from-fun (and bs-must-show-function
555 (funcall bs-must-show-function
557 (show-flag (save-excursion
558 (set-buffer (car list))
559 bs-buffer-show-mark)))
560 (if (or (eq show-flag 'always)
561 (and (or bs--show-all (not (eq show-flag 'never)))
565 extern-must-show-from-fun
566 (and (not ext-show-never)
567 (not extern-show-never-from-fun)))))
568 (setq result (cons (car list)
570 (setq list (cdr list))))
571 (setq result (reverse result))
572 ;; The current buffer which was the start point of bs should be an element
573 ;; of result list, so that we can leave with space and be back in the
574 ;; buffer we started bs-show.
575 (if (and bs--buffer-coming-from
576 (buffer-live-p bs--buffer-coming-from)
577 (not (memq bs--buffer-coming-from result)))
578 (setq result (cons bs--buffer-coming-from result)))
580 (if (and sort-description
581 (nth 1 sort-description))
582 (setq result (sort result (nth 1 sort-description)))
583 ;; else standard sorting
584 (bs-buffer-sort result))))
586 (defun bs-buffer-sort (buffer-list)
587 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
588 (if bs-buffer-sort-function
589 (sort buffer-list bs-buffer-sort-function)
592 (defun bs--redisplay (&optional keep-line-p sort-description)
593 "Redisplay whole Buffer Selection Menu.
594 If KEEP-LINE-P is non nil the point will stay on current line.
595 SORT-DESCRIPTION is an element of `bs-sort-functions'"
596 (let ((line (1+ (count-lines 1 (point)))))
597 (bs-show-in-buffer (bs-buffer-list nil sort-description))
600 (beginning-of-line)))
602 (defun bs--goto-current-buffer ()
603 "Goto line which represents the current buffer;
604 actually the line which begins with character in `bs-string-current' or
605 `bs-string-current-marked'."
606 (let ((regexp (concat "^"
607 (regexp-quote bs-string-current)
609 (regexp-quote bs-string-current-marked)))
612 (goto-char (point-min))
613 (if (search-forward-regexp regexp nil t)
614 (setq point (- (point) 1))))
618 (defun bs--current-config-message ()
619 "Return a string describing the current `bs-mode' configuration."
622 (format "Show buffer by configuration %S"
623 bs-current-configuration)))
626 "Major mode for editing a subset of Emacs' buffers.
628 Aside from two header lines each line describes one buffer.
629 Move to a line representing the buffer you want to edit and select
630 buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill].
631 There are many key commands similar to `Buffer-menu-mode' for
632 manipulating the buffer list and buffers.
633 For faster navigation each digit key is a digit argument.
635 \\[bs-select] or SPACE -- select current line's buffer and other marked buffers.
636 \\[bs-toggle-show-all] -- toggle between all buffers and a special subset.
637 \\[bs-select-other-window] -- select current line's buffer in other window.
638 \\[bs-tmp-select-other-window] -- make another window display that buffer and
639 remain in Buffer Selection Menu.
640 \\[bs-mouse-select] -- select current line's buffer and other marked buffers.
641 \\[bs-save] -- save current line's buffer immediatly.
642 \\[bs-delete] -- kill current line's buffer immediatly.
643 \\[bs-toggle-readonly] -- toggle read-only status of current line's buffer.
644 \\[bs-clear-modified] -- clear modified-flag on that buffer.
645 \\[bs-mark-current] -- mark current line's buffer to be displayed.
646 \\[bs-unmark-current] -- unmark current line's buffer to be displayed.
647 \\[bs-show-sorted] -- display buffer list sorted by next sort aspect.
648 \\[bs-set-configuration-and-refresh] -- ask user for a configuration and \
649 apply selected configuration.
650 \\[bs-select-next-configuration] -- select and apply next \
651 available Buffer Selection Menu configuration.
652 \\[bs-kill] -- leave Buffer Selection Menu without a selection.
653 \\[bs-toggle-current-to-show] -- toggle status of appearance.
654 \\[bs-set-current-buffer-to-show-always] -- mark current line's buffer \
656 \\[bs-visit-tags-table] -- call `visit-tags-table' on current line's buffer.
657 \\[bs-help] -- display this help text."
659 (kill-all-local-variables)
660 (use-local-map bs-mode-map)
661 (make-local-variable 'font-lock-defaults)
662 (make-local-variable 'font-lock-verbose)
663 (setq major-mode 'bs-mode
664 mode-name "Buffer-Selection-Menu"
667 font-lock-defaults '(bs-mode-font-lock-keywords t)
668 font-lock-verbose nil)
669 (run-hooks 'bs-mode-hook))
672 "Let buffer disappear and reset window-configuration."
674 (bury-buffer (current-buffer))
675 (set-window-configuration bs--window-config-coming-from))
678 "Ding and leave Buffer Selection Menu without a selection."
683 (defun bs-set-configuration-and-refresh ()
684 "Ask user for a configuration and apply selected configuration.
685 Refresh whole Buffer Selection Menu."
687 (call-interactively 'bs-set-configuration)
691 "Refresh whole Buffer Selection Menu."
695 (defun bs--window-for-buffer (buffer-name)
696 "Return a window showing a buffer with name BUFFER-NAME.
697 Take only windows of current frame into account.
698 Return nil if there is no such buffer."
700 (walk-windows (lambda (wind)
701 (if (string= (buffer-name (window-buffer wind))
703 (setq window wind))))
706 (defun bs--set-window-height ()
707 "Change the height of the selected window to suit the current buffer list."
708 (unless (one-window-p t)
709 (shrink-window (- (window-height (selected-window))
710 ;; window-height in xemacs includes mode-line
711 (+ (if bs--running-in-xemacs 3 1)
712 bs-header-lines-length
713 (min (length bs-current-list)
714 bs-max-window-height))))))
716 (defun bs--current-buffer ()
717 "Return buffer on current line.
718 Raise an error if not on a buffer line."
720 (let ((line (+ (- bs-header-lines-length)
721 (count-lines 1 (point)))))
723 (error "You are on a header row"))
724 (nth line bs-current-list)))
726 (defun bs--update-current-line ()
727 "Update the entry on current line for Buffer Selection Menu."
728 (let ((buffer (bs--current-buffer))
729 (inhibit-read-only t))
731 (delete-region (point) (line-end-position))
732 (bs--insert-one-entry buffer)
733 (beginning-of-line)))
736 "View current line's buffer in View mode.
737 Leave Buffer Selection Menu."
739 (view-buffer (bs--current-buffer)))
742 "Select current line's buffer and other marked buffers.
743 If there are no marked buffers the window configuration before starting
744 Buffer Selectin Menu will be restored.
745 If there are marked buffers each marked buffer and the current line's buffer
746 will be selected in a window.
747 Leave Buffer Selection Menu."
749 (let ((buffer (bs--current-buffer)))
750 (bury-buffer (current-buffer))
751 (set-window-configuration bs--window-config-coming-from)
752 (switch-to-buffer buffer)
753 (if bs--marked-buffers
754 ;; Some marked buffers for selection
755 (let* ((all (delq buffer bs--marked-buffers))
756 (height (/ (1- (frame-height)) (1+ (length all)))))
757 (delete-other-windows)
758 (switch-to-buffer buffer)
760 (split-window nil height)
762 (switch-to-buffer (car all))
763 (setq all (cdr all)))
764 ;; goto window we have started bs.
767 (defun bs-select-other-window ()
768 "Select current line's buffer by `switch-to-buffer-other-window'.
769 The window configuration before starting Buffer Selectin Menu will be restored
770 unless there is no other window. In this case a new window will be created.
771 Leave Buffer Selection Menu."
773 (let ((buffer (bs--current-buffer)))
774 (bury-buffer (current-buffer))
775 (set-window-configuration bs--window-config-coming-from)
776 (switch-to-buffer-other-window buffer)))
778 (defun bs-tmp-select-other-window ()
779 "Make the other window select this line's buffer.
780 The current window remains selected."
782 (let ((buffer (bs--current-buffer)))
783 (display-buffer buffer t)))
785 (defun bs-select-other-frame ()
786 "Select current line's buffer in new created frame.
787 Leave Buffer Selection Menu."
789 (let ((buffer (bs--current-buffer)))
790 (bury-buffer (current-buffer))
791 (set-window-configuration bs--window-config-coming-from)
792 (switch-to-buffer-other-frame buffer)))
794 (defun bs-mouse-select-other-frame (event)
795 "Select selected line's buffer in new created frame.
796 Leave Buffer Selection Menu.
797 EVENT: a mouse click EVENT."
799 (mouse-set-point event)
800 (bs-select-other-frame))
802 (defun bs-mouse-select (event)
803 "Select buffer on mouse click EVENT.
804 Select buffer by `bs-select'."
806 (mouse-set-point event)
809 (defun bs-select-in-one-window ()
810 "Select current line's buffer in one window and delete other windows.
811 Leave Buffer Selection Menu."
814 (delete-other-windows))
816 (defun bs-bury-buffer ()
817 "Bury buffer on current line."
819 (bury-buffer (bs--current-buffer))
823 "Save buffer on current line."
825 (let ((buffer (bs--current-buffer)))
829 (bs--update-current-line)))
831 (defun bs-visit-tags-table ()
832 "Visit the tags table in the buffer on this line.
833 See `visit-tags-table'."
835 (let ((file (buffer-file-name (bs--current-buffer))))
837 (visit-tags-table file)
838 (error "Specified buffer has no file"))))
840 (defun bs-toggle-current-to-show ()
841 "Toggle status of showing flag for buffer in current line."
843 (let ((buffer (bs--current-buffer))
847 (setq res (cond ((null bs-buffer-show-mark)
849 ((eq bs-buffer-show-mark 'never)
852 (setq bs-buffer-show-mark res))
853 (bs--update-current-line)
854 (bs--set-window-height)
855 (bs--show-config-message res)))
857 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
858 "Toggle status of buffer on line to `always shown'.
859 NOT-TO-SHOW-P: prefix argument.
860 With no prefix argument the buffer on current line is marked to show
861 always. Otherwise it is marked to show never."
864 (bs-set-current-buffer-to-show-never)
865 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
867 (defun bs-set-current-buffer-to-show-never ()
868 "Toggle status of buffer on line to `never shown'."
870 (bs--set-toggle-to-show (bs--current-buffer) 'never))
872 (defun bs--set-toggle-to-show (buffer what)
873 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
874 Redisplay current line and display a message describing
875 the status of buffer on current line."
878 (setq bs-buffer-show-mark what))
879 (bs--update-current-line)
880 (bs--set-window-height)
881 (bs--show-config-message what))
883 (defun bs-mark-current (count)
885 COUNT is the number of buffers to mark.
886 Move cursor vertically down COUNT lines."
888 (let ((dir (if (> count 0) 1 -1))
891 (let ((buffer (bs--current-buffer)))
893 (setq bs--marked-buffers (cons buffer bs--marked-buffers)))
894 (bs--update-current-line)
896 (setq count (1- count)))))
898 (defun bs-unmark-current (count)
900 COUNT is the number of buffers to unmark.
901 Move cursor vertically down COUNT lines."
903 (let ((dir (if (> count 0) 1 -1))
906 (let ((buffer (bs--current-buffer)))
908 (setq bs--marked-buffers (delq buffer bs--marked-buffers)))
909 (bs--update-current-line)
911 (setq count (1- count)))))
913 (defun bs--show-config-message (what)
914 "Show message indicating the new showing status WHAT.
915 WHAT is a value of nil, `never', or `always'."
916 (bs-message-without-log (cond ((null what)
917 "Buffer will be shown normally.")
919 "Mark buffer to never be shown.")
920 (t "Mark buffer to show always."))))
923 "Kill buffer on current line."
925 (let ((current (bs--current-buffer))
926 (inhibit-read-only t))
927 (setq bs-current-list (delq current bs-current-list))
928 (kill-buffer current)
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 buffer name."
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."
1021 (if (<= (count-lines 1 (point)) (1- bs-header-lines-length))
1023 (goto-char (point-max))
1026 (beginning-of-line)))
1028 (defun bs-down (arg)
1029 "Move cursor vertically down ARG lines in Buffer Selection Menu."
1031 (if (and arg (numberp arg) (< arg 0))
1032 (bs--nth-wrapper (- arg) 'bs--up)
1033 (bs--nth-wrapper arg 'bs--down)))
1036 "Move cursor vertically down one line.
1037 If at end of buffer list go to first line."
1038 (let ((last (line-end-position)))
1039 (if (eq last (point-max))
1040 (goto-line (1+ bs-header-lines-length))
1043 (defun bs-visits-non-file (buffer)
1044 "Return t or nil whether BUFFER visits no file.
1045 A value of t means BUFFER belongs to no file.
1046 A value of nil means BUFFER belongs to a file."
1047 (not (buffer-file-name buffer)))
1049 (defun bs-sort-buffer-interns-are-last (b1 b2)
1050 "Function for sorting internal buffers B1 and B2 at the end of all buffers."
1051 (string-match "^\\*" (buffer-name b2)))
1053 ;; ----------------------------------------------------------------------
1055 ;; ----------------------------------------------------------------------
1057 (defun bs-config-clear ()
1058 "*Reset all variables which specify a configuration.
1059 These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
1060 `bs-dont-show-function', `bs-must-show-function' and
1061 `bs-buffer-sort-function'."
1062 (setq bs-dont-show-regexp nil
1063 bs-must-show-regexp nil
1064 bs-dont-show-function nil
1065 bs-must-show-function nil
1066 bs-buffer-sort-function nil))
1068 (defun bs-config--only-files ()
1069 "Define a configuration for showing only buffers visiting a file."
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))
1076 (defun bs-config--files-and-scratch ()
1077 "Define a configuration for showing buffer *scratch* and file buffers."
1079 (setq ;; I want to see *-buffers at the end
1080 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1081 ;; Don't show files who don't belong to a file
1082 bs-dont-show-function 'bs-visits-non-file
1083 ;; Show *scratch* buffer.
1084 bs-must-show-regexp "^\\*scratch\\*$"))
1086 (defun bs-config--all ()
1087 "Define a configuration for showing all buffers.
1088 Reset all according variables by `bs-config-clear'."
1091 (defun bs-config--all-intern-last ()
1092 "Define a configuration for showing all buffers.
1093 Internal buffers appear at end of all buffers."
1095 ;; I want to see *-buffers at the end
1096 (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))
1098 (defun bs-set-configuration (name)
1099 "Set configuration to the one saved under string NAME in `bs-configurations'.
1100 When called interactively ask user for a configuration and apply selected
1102 (interactive (list (completing-read "Use configuration: "
1106 (let ((list (assoc name bs-configurations)))
1109 (setq bs-current-configuration name
1110 bs-must-show-regexp (nth 1 list)
1111 bs-must-show-function (nth 2 list)
1112 bs-dont-show-regexp (nth 3 list)
1113 bs-dont-show-function (nth 4 list)
1114 bs-buffer-sort-function (nth 5 list))
1115 ;; for backward compability
1116 (funcall (cdr list)))
1119 (bs-message-without-log "No bs-configuration named %S." name))))
1122 "Help for `bs-show'."
1124 (describe-function 'bs-mode))
1126 (defun bs-next-config-aux (start-name list)
1127 "Get the next assoc after START-NAME in list LIST.
1128 Will return the first if START-NAME is at end."
1130 (length (length list))
1132 (while (and assocs (not pos))
1133 (if (string= (car (car assocs)) start-name)
1134 (setq pos (- length (length assocs))))
1135 (setq assocs (cdr assocs)))
1141 (defun bs-next-config (name)
1142 "Return next configuration with respect to configuration with name NAME."
1143 (bs-next-config-aux name bs-configurations))
1145 (defun bs-select-next-configuration (&optional start-name)
1146 "Apply next configuration START-NAME and refresh buffer list.
1147 If START-NAME is nil the current configuration `bs-current-configuration'
1150 (let ((config (bs-next-config (or start-name bs-current-configuration))))
1151 (bs-set-configuration (car config))
1152 (setq bs-default-configuration bs-current-configuration)
1154 (bs--set-window-height)
1155 (bs-message-without-log "Selected configuration: %s" (car config))))
1157 (defun bs-show-in-buffer (list)
1158 "Display buffer list LIST in buffer *buffer-selection*.
1159 Select buffer *buffer-selection* and display buffers according to current
1160 configuration `bs-current-configuration'. Set window height, fontify buffer
1161 and move point to current buffer."
1162 (setq bs-current-list list)
1163 (switch-to-buffer (get-buffer-create "*buffer-selection*"))
1165 (let* ((inhibit-read-only t)
1166 (map-fun (lambda (entry)
1167 (length (buffer-name entry))))
1168 (max-length-of-names (apply 'max
1169 (cons 0 (mapcar map-fun list))))
1170 (name-entry-length (min bs-maximal-buffer-name-column
1171 (max bs-minimal-buffer-name-column
1172 max-length-of-names))))
1174 (setq bs--name-entry-length name-entry-length)
1177 (bs--insert-one-entry (car list))
1179 (setq list (cdr list)))
1180 (delete-backward-char 1)
1181 (bs--set-window-height)
1182 (bs--goto-current-buffer)
1183 (font-lock-fontify-buffer)
1184 (bs-apply-sort-faces)))
1186 (defun bs-next-buffer (&optional buffer-list sorting-p)
1187 "Return next buffer and buffer list for buffer cycling in BUFFER-LIST.
1188 Ignore sorting when SORTING-P is nil.
1189 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1190 buffer list. The result is a cons of normally the second element of
1191 BUFFER-LIST and the buffer list used for buffer cycling."
1192 (let* ((bs--current-sort-function (if sorting-p
1193 bs--current-sort-function))
1194 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1195 (cons (or (car (cdr bs-buffer-list))
1196 (car bs-buffer-list)
1200 (defun bs-previous-buffer (&optional buffer-list sorting-p)
1201 "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST.
1202 Ignore sorting when SORTING-P is nil.
1203 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1204 buffer list. The result is a cons of last element of BUFFER-LIST and the
1205 buffer list used for buffer cycling."
1206 (let* ((bs--current-sort-function (if sorting-p
1207 bs--current-sort-function))
1208 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1209 (cons (or (car (last bs-buffer-list))
1213 (defun bs-message-without-log (&rest args)
1214 "Like `message' but don't log it on the message log.
1215 All arguments ARGS are transfered to function `message'."
1216 (let ((message-log-max nil))
1217 (apply 'message args)))
1219 (defvar bs--cycle-list nil
1220 "Current buffer list used for cycling.")
1223 (defun bs-cycle-next ()
1224 "Select next buffer defined by buffer cycling.
1225 The buffers taking part in buffer cycling are defined
1226 by buffer configuration `bs-cycle-configuration-name'."
1228 (let ((bs--buffer-coming-from (current-buffer))
1229 (bs-dont-show-regexp bs-dont-show-regexp)
1230 (bs-must-show-regexp bs-must-show-regexp)
1231 (bs-dont-show-function bs-dont-show-function)
1232 (bs-must-show-function bs-must-show-function)
1233 (bs--show-all bs--show-all))
1234 (if bs-cycle-configuration-name
1235 (bs-set-configuration bs-cycle-configuration-name))
1236 (let ((bs-buffer-sort-function nil)
1237 (bs--current-sort-function nil))
1238 (let* ((tupel (bs-next-buffer (if (or (eq last-command
1241 'bs-cycle-previous))
1244 (cycle-list (cdr tupel)))
1245 (setq bs--cycle-list (append (cdr cycle-list)
1246 (list (car cycle-list))))
1248 (switch-to-buffer next)
1249 (bs-message-without-log "Next buffers: %s"
1250 (or (cdr bs--cycle-list)
1255 (defun bs-cycle-previous ()
1256 "Select previous buffer defined by buffer cycling.
1257 The buffers taking part in buffer cycling are defined
1258 by buffer configuration `bs-cycle-configuration-name'."
1260 (let ((bs--buffer-coming-from (current-buffer))
1261 (bs-dont-show-regexp bs-dont-show-regexp)
1262 (bs-must-show-regexp bs-must-show-regexp)
1263 (bs-dont-show-function bs-dont-show-function)
1264 (bs-must-show-function bs-must-show-function)
1265 (bs--show-all bs--show-all))
1266 (if bs-cycle-configuration-name
1267 (bs-set-configuration bs-cycle-configuration-name))
1268 (let ((bs-buffer-sort-function nil)
1269 (bs--current-sort-function nil))
1270 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1273 'bs-cycle-previous))
1275 (prev-buffer (car tupel))
1276 (cycle-list (cdr tupel)))
1277 (setq bs--cycle-list (append (last cycle-list)
1278 (reverse (cdr (reverse cycle-list)))))
1279 (switch-to-buffer prev-buffer)
1280 (bs-message-without-log "Previous buffers: %s"
1281 (or (reverse (cdr bs--cycle-list))
1284 (defun bs--get-value (fun &optional args)
1285 "Apply function FUN with arguments ARGS.
1286 Return result of evaluation. Will return FUN if FUN is a number
1288 (cond ((numberp fun)
1292 (t (apply fun args))))
1294 (defun bs--get-marked-string (start-buffer all-buffers)
1295 "Return a string which describes whether current buffer is marked.
1296 START-BUFFER is the buffer where we started buffer selection.
1297 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu.
1298 The result string is one of `bs-string-current', `bs-string-current-marked',
1299 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1300 `bs-string-show-always'."
1301 (cond ;; current buffer is the buffer we started buffer selection.
1302 ((eq (current-buffer) start-buffer)
1303 (if (memq (current-buffer) bs--marked-buffers)
1304 bs-string-current-marked ; buffer is marked
1306 ;; current buffer is marked
1307 ((memq (current-buffer) bs--marked-buffers)
1309 ;; current buffer hasn't a special mark.
1310 ((null bs-buffer-show-mark)
1311 bs-string-show-normally)
1312 ;; current buffer has a mark not to show itself.
1313 ((eq bs-buffer-show-mark 'never)
1314 bs-string-show-never)
1315 ;; otherwise current buffer is marked to show always.
1317 bs-string-show-always)))
1319 (defun bs--get-modified-string (start-buffer all-buffers)
1320 "Return a string which describes whether current buffer is modified.
1321 START-BUFFER is the buffer where we started buffer selection.
1322 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1323 (if (buffer-modified-p) "*" " "))
1325 (defun bs--get-readonly-string (start-buffer all-buffers)
1326 "Return a string which describes whether current buffer is read only.
1327 START-BUFFER is the buffer where we started buffer selection.
1328 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1329 (if buffer-read-only "%" " "))
1331 (defun bs--get-size-string (start-buffer all-buffers)
1332 "Return a string which describes the size of current buffer.
1333 START-BUFFER is the buffer where we started buffer selection.
1334 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1335 (int-to-string (buffer-size)))
1337 (defun bs--get-name (start-buffer all-buffers)
1338 "Return name of current buffer for Buffer Selection Menu.
1339 The name of current buffer gets additional text properties
1340 for mouse highlighting.
1341 START-BUFFER is the buffer where we started buffer selection.
1342 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1343 (let ((name (copy-sequence (buffer-name))))
1344 (put-text-property 0 (length name) 'mouse-face 'highlight name)
1345 (if (< (length name) bs--name-entry-length)
1347 (make-string (- bs--name-entry-length (length name)) ? ))
1350 (defun bs--get-mode-name (start-buffer all-buffers)
1351 "Return the name of mode of current buffer for Buffer Selection Menu.
1352 START-BUFFER is the buffer where we started buffer selection.
1353 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1356 (defun bs--get-file-name (start-buffer all-buffers)
1357 "Return string for column 'File' in Buffer Selection Menu.
1358 This is the variable `buffer-file-name' of current buffer.
1359 If current mode is `dired-mode' or `shell-mode' it returns the
1361 START-BUFFER is the buffer where we started buffer selection.
1362 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1363 (let ((string (copy-sequence (if (member major-mode
1364 '(shell-mode dired-mode))
1366 (or buffer-file-name "")))))
1367 (put-text-property 0 (length string) 'mouse-face 'highlight string)
1370 (defun bs--insert-one-entry (buffer)
1371 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1372 It goes over all columns described in `bs-attributes-list'
1373 and evaluates corresponding string. Inserts string in current buffer;
1374 normally *buffer-selection*."
1376 (columns bs-attributes-list)
1378 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1382 (let ((min (bs--get-value (nth 1 (car columns))))
1383 ;;(max (bs--get-value (nth 2 (car columns)))) refered no more
1384 (align (nth 3 (car columns)))
1385 (fun (nth 4 (car columns)))
1388 (setq val (bs--get-value fun apply-args))
1389 (setq new-string (bs--format-aux val align (- min to-much)))
1390 (setq string (concat string new-string))
1391 (if (> (length new-string) min)
1392 (setq to-much (- (length new-string) min)))
1394 (setq columns (cdr columns))))
1398 (defun bs--format-aux (string align len)
1399 "Generate a string with STRING with alignment ALIGN and length LEN.
1400 ALIGN is one of the symbols `left', `middle', or `right'."
1401 (let ((length (length string)))
1404 (if (eq 'right align)
1405 (concat (make-string (- len length) ? ) string)
1406 (concat string (make-string (- len length) ? ))))))
1408 (defun bs--show-header ()
1409 "Insert header for Buffer Selection Menu in current buffer."
1410 (mapcar '(lambda (string)
1411 (insert string "\n"))
1412 (bs--create-header)))
1414 (defun bs--get-name-length ()
1415 "Return value of `bs--name-entry-length'."
1416 bs--name-entry-length)
1418 (defun bs--create-header ()
1419 "Return all header lines used in Buffer Selection Menu as a list of strings."
1420 (list (mapconcat (lambda (column)
1421 (bs--format-aux (bs--get-value (car column))
1422 (nth 3 column) ; align
1423 (bs--get-value (nth 1 column))))
1426 (mapconcat (lambda (column)
1427 (let ((length (length (bs--get-value (car column)))))
1428 (bs--format-aux (make-string length ?-)
1429 (nth 3 column) ; align
1430 (bs--get-value (nth 1 column)))))
1434 (defun bs--show-with-configuration (name &optional arg)
1435 "Display buffer list of configuration with name NAME.
1436 Set configuration NAME and determine window for Buffer Selection Menu.
1437 Unless current buffer is buffer *buffer-selection* we have to save
1438 the buffer we started Buffer Selection Menu and the current window
1439 configuration to restore buffer and window configuration after a
1440 selection. If there is already a window displaying *buffer-selection*
1441 select this window for Buffer Selection Menu. Otherwise open a new
1443 The optional argument ARG is the prefix argument when calling a function
1444 for buffer selection."
1445 (bs-set-configuration name)
1446 (let ((bs--show-all (or bs--show-all arg)))
1447 (unless (string= "*buffer-selection*" (buffer-name))
1448 ;; Only when not in buffer *buffer-selection*
1449 ;; we have to set the buffer we started the command
1451 (setq bs--buffer-coming-from (current-buffer))
1452 (setq bs--window-config-coming-from (current-window-configuration))))
1453 (let ((liste (bs-buffer-list))
1454 (active-window (bs--window-for-buffer "*buffer-selection*")))
1456 (select-window active-window)
1457 (if (> (window-height (selected-window)) 7)
1459 (split-window-vertically)
1461 (bs-show-in-buffer liste)
1462 (bs-message-without-log "%s" (bs--current-config-message)))))
1464 (defun bs--configuration-name-for-prefix-arg (prefix-arg)
1465 "Convert prefix argument PREFIX-ARG to a name of a buffer configuration.
1466 If PREFIX-ARG is nil return `bs-default-configuration'.
1467 If PREFIX-ARG is an integer return PREFIX-ARG element of `bs-configurations'.
1468 Otherwise return `bs-alternative-configuration'."
1469 (cond ;; usually activation
1471 bs-default-configuration)
1472 ;; call with integer as prefix argument
1473 ((integerp prefix-arg)
1474 (if (and (< 0 prefix-arg) (<= prefix-arg (length bs-configurations)))
1475 (car (nth (1- prefix-arg) bs-configurations))
1476 bs-default-configuration))
1477 ;; call by prefix argument C-u
1478 (t bs-alternative-configuration)))
1480 ;; ----------------------------------------------------------------------
1481 ;; Main function bs-customize and bs-show
1482 ;; ----------------------------------------------------------------------
1485 (defun bs-customize ()
1486 "Customization of group bs for Buffer Selection Menu."
1488 (customize-group "bs"))
1491 (defun bs-show (arg)
1492 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1494 There are many key commands similar to `Buffer-menu-mode' for
1495 manipulating buffer list and buffers itself.
1496 User can move with [up] or [down], select a buffer
1497 by \\[bs-select] or [SPC]\n
1498 Type \\[bs-kill] to leave Buffer Selection Menu without a selection.
1499 Type \\[bs-help] after invocation to get help on commands available.
1500 With prefix argument ARG show a different buffer list. Function
1501 `bs--configuration-name-for-prefix-arg' determine accordingly
1502 name of buffer configuration."
1504 (setq bs--marked-buffers nil)
1505 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1507 ;;; Now provide feature bs