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