* net/tramp-compat.el (tramp-compat-temporary-file-directory):
[emacs.git] / lisp / bs.el
blob08d05a946e37e78a69ff8c0304507bbaf25a9365
1 ;;; bs.el --- menu for selecting and displaying buffers -*- lexical-binding: t -*-
3 ;; Copyright (C) 1998-2012 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 3 of the License, or
13 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; Version: 1.17
26 ;; X-URL: http://www.geekware.de/software/emacs
28 ;; The bs-package contains a main function bs-show for popping up a
29 ;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
30 ;; The new buffer offers a Buffer Selection Menu for manipulating
31 ;; the buffer list and buffers.
33 ;; -----------------------------------------------------------------------
34 ;; | MR Buffer Size Mode File |
35 ;; | -- ------ ---- ---- ---- |
36 ;; |. bs.el 14690 Emacs-Lisp /home/sun/sylvester/el/bs.e$|
37 ;; | % executable.el 9429 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
38 ;; | % vc.el 104893 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
39 ;; | % test_vc.el 486 Emacs-Lisp /home/sun/sylvester/el/test$|
40 ;; | % vc-hooks.el 43605 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
41 ;; -----------------------------------------------------------------------
43 ;;; Quick Installation and Customization:
45 ;; To display the bs menu, do
46 ;; M-x bs-show
47 ;; To customize its behavior, do
48 ;; M-x bs-customize
50 ;;; More Commentary:
52 ;; bs-show will generate a new buffer named *buffer-selection*, which shows
53 ;; all buffers or a subset of them, and has possibilities for deleting,
54 ;; saving and selecting buffers. For more details see docstring of
55 ;; function `bs-mode'. A current configuration describes which buffers appear
56 ;; in *buffer-selection*. See docstring of variable `bs-configurations' for
57 ;; more details.
59 ;; The package bs combines the advantages of the Emacs functions
60 ;; `list-buffers' and `electric-buffer-list'.
62 ;; Additional features for Buffer Selection Menu:
63 ;; - configurable list of buffers (show only files etc.).
64 ;; - comfortable way to change displayed subset of all buffers.
65 ;; - show sorted list of buffers.
66 ;; - cyclic navigation:
67 ;; - goes to top of buffer list if you are on last line and press down.
68 ;; - goes to end of buffer list if you are on first line and press up.
69 ;; - Offer an alternative buffer list by prefix key C-u.
71 ;;; Cycling through buffers
73 ;; This package offers two functions for buffer cycling. If you want to cycle
74 ;; through buffer list you can use `bs-cycle-next' or `bs-cycle-previous'.
75 ;; Bind these function to a key like
76 ;; (global-set-key [(f9)] 'bs-cycle-previous)
77 ;; (global-set-key [(f10)] 'bs-cycle-next)
79 ;; Both functions use a special subset of all buffers for cycling to avoid
80 ;; to go through internal buffers like *Messages*.
82 ;; Cycling through buffers ignores sorting because sorting destroys
83 ;; the logical buffer list. If buffer list is sorted by size you
84 ;; won't be able to cycle to the smallest buffer.
86 ;;; Customization:
88 ;; There is a customization group called `bs' in group `convenience'.
89 ;; Start customization by M-x bs-customize
91 ;; Buffer list
92 ;; -----------
93 ;; You can define your own configurations by extending variable
94 ;; `bs-configurations' (see docstring for details).
96 ;; `bs-default-configuration' contains the name of default configuration.
97 ;; The default value is "files" which means to show only files.
99 ;; If you always want to see all buffers, customize variable
100 ;; `bs-default-configuration' in customization group `bs'.
102 ;; Configure sorting
103 ;; -----------------
104 ;; You can define functions for sorting the buffer list.
105 ;; When selecting buffers, you can step through available sorting
106 ;; methods with key 'S'.
107 ;; To define a new way of sorting, customize variable `bs-sort-functions'.
109 ;; There are four basic functions for sorting:
110 ;; by buffer name, by mode, by size, or by filename
112 ;; Configure buffer cycling
113 ;; ------------------------
114 ;; When cycling through buffer list the functions for cycling will use
115 ;; the current configuration of bs to calculate the buffer list.
116 ;; If you want to use a different configuration for cycling you have to set
117 ;; the variable `bs-cycle-configuration-name'. You can customize this variable.
119 ;; For example: If you use the configuration called "files-and-scratch" you
120 ;; can cycle through all file buffers and *scratch* although your current
121 ;; configuration perhaps is "files" which ignores buffer *scratch*.
123 ;;; History:
125 ;;; Code:
127 (eval-when-compile (require 'cl))
129 ;; ----------------------------------------------------------------------
130 ;; Globals for customization
131 ;; ----------------------------------------------------------------------
133 (defgroup bs nil
134 "Buffer Selection: Maintaining buffers by buffer menu."
135 :version "21.1"
136 :link '(emacs-commentary-link "bs")
137 :link '(url-link "http://www.geekware.de/software/emacs")
138 :group 'convenience)
140 (defgroup bs-appearance nil
141 "Buffer Selection appearance: Appearance of bs buffer menu."
142 :group 'bs)
144 (defcustom bs-attributes-list
145 '(("" 1 1 left bs--get-marked-string)
146 ("M" 1 1 left bs--get-modified-string)
147 ("R" 2 2 left bs--get-readonly-string)
148 ("Buffer" bs--get-name-length 10 left bs--get-name)
149 ("" 1 1 left " ")
150 ("Size" 8 8 right bs--get-size-string)
151 ("" 1 1 left " ")
152 ("Mode" 12 12 right bs--get-mode-name)
153 ("" 2 2 left " ")
154 ("File" 12 12 left bs--get-file-name)
155 ("" 2 2 left " "))
156 "List specifying the layout of a Buffer Selection Menu buffer.
157 Each entry specifies a column and is a list of the form of:
158 \(HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING)
160 HEADER : String for header for first line or a function
161 which calculates column title.
162 MINIMUM-LENGTH : Minimum width of column (number or name of function).
163 The function must return a positive integer.
164 MAXIMUM-LENGTH : Maximum width of column (number or name of function)
165 (currently ignored).
166 ALIGNMENT : Alignment of column (`left', `right', `middle').
167 FUN-OR-STRING : Name of a function for calculating the value or a
168 string for a constant value.
170 The function gets as parameter the buffer where we have started
171 buffer selection and the list of all buffers to show. The function must
172 return a string representing the column's value."
173 :group 'bs-appearance
174 :type '(repeat sexp))
176 (defun bs--make-header-match-string ()
177 "Return a regexp matching the first line of a Buffer Selection Menu buffer."
178 (concat "^\\(" (mapconcat #'car bs-attributes-list " *") " *$\\)"))
180 ;; Font-Lock-Settings
181 (defvar bs-mode-font-lock-keywords
182 (list ;; header in font-lock-type-face
183 (list (bs--make-header-match-string)
184 '(1 font-lock-type-face append) '(1 'bold append))
185 ;; Buffername embedded by *
186 (list "^\\(.*\\*.*\\*.*\\)$"
188 ;; problem in XEmacs with font-lock-constant-face
189 (if (facep 'font-lock-constant-face)
190 'font-lock-constant-face
191 'font-lock-comment-face))
192 ;; Dired-Buffers
193 '("^..\\(.*Dired .*\\)$" 1 font-lock-function-name-face)
194 ;; the star for modified buffers
195 '("^.\\(\\*\\) +[^\\*]" 1 font-lock-comment-face))
196 "Default font lock expressions for Buffer Selection Menu.")
198 (defcustom bs-max-window-height 20
199 "Maximal window height of Buffer Selection Menu."
200 :group 'bs-appearance
201 :type 'integer)
203 (defvar bs-dont-show-regexp nil
204 "Regular expression specifying which buffers not to show.
205 A buffer whose name matches this regular expression will not be
206 included in the buffer list.")
208 (defvar bs-must-show-regexp nil
209 "Regular expression for specifying buffers which must be shown.
210 A buffer whose name matches this regular expression will be
211 included in the buffer list.
212 Note that this variable is temporary: if the configuration is changed
213 it is reset to nil. Use `bs-must-always-show-regexp' to specify buffers
214 that must always be shown regardless of the configuration.")
216 (defcustom bs-must-always-show-regexp nil
217 "Regular expression for specifying buffers to show always.
218 A buffer whose name matches this regular expression will
219 be shown regardless of current configuration of Buffer Selection Menu."
220 :group 'bs
221 :type '(choice (const :tag "Nothing at all" nil) regexp))
223 (defvar bs-dont-show-function nil
224 "Function for specifying buffers not to show.
225 The function gets one argument - the buffer to test. The function must
226 return a value different from nil to ignore the buffer in
227 Buffer Selection Menu.")
229 (defvar bs-must-show-function nil
230 "Function for specifying buffers which must be shown.
231 The function gets one argument - the buffer to test.")
233 (defvar bs-buffer-sort-function nil
234 "Sort function to sort the buffers that appear in Buffer Selection Menu.
235 The function gets two arguments - the buffers to compare.
236 It must return non-nil if the first buffer should sort before the second.")
238 (defcustom bs-maximal-buffer-name-column 45
239 "Maximum column width for buffer names.
240 The column for buffer names has dynamic width. The width depends on
241 maximal and minimal length of names of buffers to show. The maximal
242 width is bounded by `bs-maximal-buffer-name-column'.
243 See also `bs-minimal-buffer-name-column'."
244 :group 'bs-appearance
245 :type 'integer)
247 (defcustom bs-minimal-buffer-name-column 15
248 "Minimum 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 minimal
251 width is bounded by `bs-minimal-buffer-name-column'.
252 See also `bs-maximal-buffer-name-column'."
253 :group 'bs-appearance
254 :type 'integer)
256 (defconst bs-header-lines-length 2
257 "Number of lines for headers in Buffer Selection Menu.")
259 (defcustom bs-configurations
260 '(("all" nil nil nil nil nil)
261 ("files" nil nil nil bs-visits-non-file bs-sort-buffer-interns-are-last)
262 ("files-and-scratch" "^\\*scratch\\*$" nil nil bs-visits-non-file
263 bs-sort-buffer-interns-are-last)
264 ("all-intern-last" nil nil nil nil bs-sort-buffer-interns-are-last))
265 "List of all configurations you can use in the Buffer Selection Menu.
266 A configuration describes which buffers appear in Buffer Selection Menu
267 and also the order of buffers. A configuration is a list with
268 six elements. The first element is a string and describes the configuration.
269 The following five elements represent the values for Buffer Selection Menu
270 configuration variables `bs-must-show-regexp', `bs-must-show-function',
271 `bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'.
272 By setting these variables you define a configuration."
273 :group 'bs-appearance
274 :type '(repeat sexp))
276 (defcustom bs-default-configuration "files"
277 "Name of default configuration used by the Buffer Selection Menu.
278 \\<bs-mode-map>
279 Will be changed using key \\[bs-select-next-configuration].
280 Must be a string used in `bs-configurations' for naming a configuration."
281 :group 'bs
282 :type 'string)
284 (defcustom bs-alternative-configuration "all"
285 "Name of configuration used when calling `bs-show' with \
286 \\[universal-argument] as prefix key.
287 Must be a string used in `bs-configurations' for naming a configuration."
288 :group 'bs
289 :type 'string)
291 (defvar bs-current-configuration bs-default-configuration
292 "Name of current configuration.
293 Must be a string used in `bs-configurations' for naming a configuration.")
295 (defcustom bs-cycle-configuration-name nil
296 "Name of configuration used when cycling through the buffer list.
297 A value of nil means to use current configuration `bs-default-configuration'.
298 Must be a string used in `bs-configurations' for naming a configuration."
299 :group 'bs
300 :type '(choice (const :tag "like current configuration" nil)
301 string))
303 (defcustom bs-string-show-always "+"
304 "String added in column 1 indicating a buffer will always be shown."
305 :group 'bs-appearance
306 :type 'string)
308 (defcustom bs-string-show-never "-"
309 "String added in column 1 indicating a buffer will never be shown."
310 :group 'bs-appearance
311 :type 'string)
313 (defcustom bs-string-current "."
314 "String added in column 1 indicating the current buffer."
315 :group 'bs-appearance
316 :type 'string)
318 (defcustom bs-string-current-marked "#"
319 "String added in column 1 indicating the current buffer when it is marked."
320 :group 'bs-appearance
321 :type 'string)
323 (defcustom bs-string-marked ">"
324 "String added in column 1 indicating a marked buffer."
325 :group 'bs-appearance
326 :type 'string)
328 (defcustom bs-string-show-normally " "
329 "String added in column 1 indicating an unmarked buffer."
330 :group 'bs-appearance
331 :type 'string)
333 (defvar bs--name-entry-length 20
334 "Maximum length of all displayed buffer names.
335 Used internally, only.")
337 ;; ----------------------------------------------------------------------
338 ;; Internal globals
339 ;; ----------------------------------------------------------------------
341 (defvar bs-buffer-show-mark nil
342 "Flag for the current mode for showing this buffer.
343 A value of nil means buffer will be shown depending on the current
344 configuration.
345 A value of `never' means to never show the buffer.
346 A value of `always' means to show buffer regardless of the configuration.")
348 (make-variable-buffer-local 'bs-buffer-show-mark)
350 ;; Make face named region (for XEmacs)
351 (unless (facep 'region)
352 (make-face 'region)
353 (set-face-background 'region "gray75"))
355 (defun bs--sort-by-name (b1 b2)
356 "Compare buffers B1 and B2 by buffer name."
357 (string< (buffer-name b1)
358 (buffer-name b2)))
360 (defun bs--sort-by-filename (b1 b2)
361 "Compare buffers B1 and B2 by file name."
362 (string< (or (buffer-file-name b1) "")
363 (or (buffer-file-name b2) "")))
365 (defun bs--sort-by-mode (b1 b2)
366 "Compare buffers B1 and B2 by mode name."
367 (save-current-buffer
368 (string< (progn (set-buffer b1) (format-mode-line mode-name nil nil b1))
369 (progn (set-buffer b2) (format-mode-line mode-name nil nil b2)))))
371 (defun bs--sort-by-size (b1 b2)
372 "Compare buffers B1 and B2 by buffer size."
373 (< (buffer-size b1) (buffer-size b2)))
375 (defcustom bs-sort-functions
376 '(("by name" bs--sort-by-name "Buffer" region)
377 ("by size" bs--sort-by-size "Size" region)
378 ("by mode" bs--sort-by-mode "Mode" region)
379 ("by filename" bs--sort-by-filename "File" region)
380 ("by nothing" nil nil nil))
381 "List of all possible sorting aspects for Buffer Selection Menu.
382 You can add a new entry with a call to `bs-define-sort-function'.
383 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE).
384 NAME specifies the sort order defined by function FUNCTION.
385 FUNCTION nil means don't sort the buffer list. Otherwise the function
386 must have two parameters - the buffers to compare.
387 REGEXP-FOR-SORTING is a regular expression which describes the
388 column title to highlight.
389 FACE is a face used to fontify the sorted column title. A value of nil means
390 don't highlight."
391 :group 'bs
392 :type '(repeat sexp))
394 (defun bs-define-sort-function (name fun &optional regexp-for-sorting face)
395 "Define a new function for buffer sorting in Buffer Selection Menu.
396 NAME specifies the sort order defined by function FUN.
397 A value of nil for FUN means don't sort the buffer list. Otherwise the
398 functions must have two parameters - the buffers to compare.
399 REGEXP-FOR-SORTING is a regular expression which describes the
400 column title to highlight.
401 FACE is a face used to fontify the sorted column title. A value of nil means
402 don't highlight.
403 The new sort aspect will be inserted into list `bs-sort-functions'."
404 (let ((tupel (assoc name bs-sort-functions)))
405 (if tupel
406 (setcdr tupel (list fun regexp-for-sorting face))
407 (setq bs-sort-functions
408 (cons (list name fun regexp-for-sorting face)
409 bs-sort-functions)))))
411 (defvar bs--current-sort-function nil
412 "Description of the current function for sorting the buffer list.
413 This is an element of `bs-sort-functions'.")
415 (defcustom bs-default-sort-name "by nothing"
416 "Name of default sort behavior.
417 Must be \"by nothing\" or a string used in `bs-sort-functions' for
418 naming a sort behavior. Default is \"by nothing\" which means no sorting."
419 :group 'bs
420 :type 'string
421 :set (lambda (var-name value)
422 (set var-name value)
423 (setq bs--current-sort-function
424 (assoc value bs-sort-functions))))
426 (defvar bs--buffer-coming-from nil
427 "The buffer in which the user started the current Buffer Selection Menu.")
429 (defvar bs--show-all nil
430 "Flag whether showing all buffers regardless of current configuration.
431 Non-nil means to show all buffers. Otherwise show buffers
432 defined by current configuration `bs-current-configuration'.")
434 (defvar bs--window-config-coming-from nil
435 "Window configuration before starting Buffer Selection Menu.")
437 (defvar bs--intern-show-never "^ \\|\\*buffer-selection\\*"
438 "Regular expression specifying which buffers never to show.
439 A buffer whose name matches this regular expression will never be
440 included in the buffer list.")
442 (defvar bs-current-list nil
443 "List of buffers shown in Buffer Selection Menu.
444 Used internally, only.")
446 (defvar bs--marked-buffers nil
447 "Currently marked buffers in Buffer Selection Menu.")
449 (defvar bs-mode-map
450 (let ((map (make-sparse-keymap)))
451 (define-key map " " 'bs-select)
452 (define-key map "f" 'bs-select)
453 (define-key map "v" 'bs-view)
454 (define-key map "!" 'bs-select-in-one-window)
455 (define-key map [mouse-2] 'bs-mouse-select) ;; for GNU EMACS
456 (define-key map [button2] 'bs-mouse-select) ;; for XEmacs
457 (define-key map "F" 'bs-select-other-frame)
458 (let ((key ?1))
459 (while (<= key ?9)
460 (define-key map (char-to-string key) 'digit-argument)
461 (setq key (1+ key))))
462 (define-key map "-" 'negative-argument)
463 (define-key map "\e-" 'negative-argument)
464 (define-key map "o" 'bs-select-other-window)
465 (define-key map "\C-o" 'bs-tmp-select-other-window)
466 ;; for GNU EMACS
467 (define-key map [mouse-3] 'bs-mouse-select-other-frame)
468 ;; for XEmacs
469 (define-key map [button3] 'bs-mouse-select-other-frame)
470 (define-key map [up] 'bs-up)
471 (define-key map "n" 'bs-down)
472 (define-key map "p" 'bs-up)
473 (define-key map [down] 'bs-down)
474 (define-key map "\C-m" 'bs-select)
475 (define-key map "b" 'bs-bury-buffer)
476 (define-key map "s" 'bs-save)
477 (define-key map "S" 'bs-show-sorted)
478 (define-key map "a" 'bs-toggle-show-all)
479 (define-key map "d" 'bs-delete)
480 (define-key map "\C-d" 'bs-delete-backward)
481 (define-key map "k" 'bs-delete)
482 (define-key map "g" 'bs-refresh)
483 (define-key map "C" 'bs-set-configuration-and-refresh)
484 (define-key map "c" 'bs-select-next-configuration)
485 (define-key map "q" 'bs-kill)
486 ;; (define-key map "z" 'bs-kill)
487 (define-key map "\C-c\C-c" 'bs-kill)
488 (define-key map "\C-g" 'bs-abort)
489 (define-key map "\C-]" 'bs-abort)
490 (define-key map "%" 'bs-toggle-readonly)
491 (define-key map "~" 'bs-clear-modified)
492 (define-key map "M" 'bs-toggle-current-to-show)
493 (define-key map "+" 'bs-set-current-buffer-to-show-always)
494 ;;(define-key map "-" 'bs-set-current-buffer-to-show-never)
495 (define-key map "t" 'bs-visit-tags-table)
496 (define-key map "m" 'bs-mark-current)
497 (define-key map "u" 'bs-unmark-current)
498 (define-key map ">" 'scroll-right)
499 (define-key map "<" 'scroll-left)
500 (define-key map "?" 'bs-help)
501 map)
502 "Keymap of `bs-mode'.")
504 ;; ----------------------------------------------------------------------
505 ;; Functions
506 ;; ----------------------------------------------------------------------
508 (defun bs-buffer-list (&optional list sort-description)
509 "Return a list of buffers to be shown.
510 LIST is a list of buffers to test for appearance in Buffer Selection Menu.
511 The result list depends on the global variables `bs-dont-show-regexp',
512 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
513 and `bs-buffer-sort-function'.
514 If SORT-DESCRIPTION isn't nil the list will be sorted by
515 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
516 (setq sort-description (or sort-description bs--current-sort-function)
517 list (or list (buffer-list)))
518 (let ((result nil))
519 (dolist (buf list)
520 (let* ((buffername (buffer-name buf))
521 (int-show-never (string-match-p bs--intern-show-never buffername))
522 (ext-show-never (and bs-dont-show-regexp
523 (string-match-p bs-dont-show-regexp
524 buffername)))
525 (extern-must-show (or (and bs-must-always-show-regexp
526 (string-match-p
527 bs-must-always-show-regexp
528 buffername))
529 (and bs-must-show-regexp
530 (string-match-p bs-must-show-regexp
531 buffername))))
532 (extern-show-never-from-fun (and bs-dont-show-function
533 (funcall bs-dont-show-function
534 buf)))
535 (extern-must-show-from-fun (and bs-must-show-function
536 (funcall bs-must-show-function
537 buf)))
538 (show-flag (buffer-local-value 'bs-buffer-show-mark buf)))
539 (when (or (eq show-flag 'always)
540 (and (or bs--show-all (not (eq show-flag 'never)))
541 (not int-show-never)
542 (or bs--show-all
543 extern-must-show
544 extern-must-show-from-fun
545 (and (not ext-show-never)
546 (not extern-show-never-from-fun)))))
547 (setq result (cons buf result)))))
548 (setq result (reverse result))
549 ;; The current buffer which was the start point of bs should be an element
550 ;; of result list, so that we can leave with space and be back in the
551 ;; buffer we started bs-show.
552 (when (and bs--buffer-coming-from
553 (buffer-live-p bs--buffer-coming-from)
554 (not (memq bs--buffer-coming-from result)))
555 (setq result (cons bs--buffer-coming-from result)))
556 ;; sorting
557 (if (and sort-description
558 (nth 1 sort-description))
559 (setq result (sort result (nth 1 sort-description)))
560 ;; else standard sorting
561 (bs-buffer-sort result))))
563 (defun bs-buffer-sort (buffer-list)
564 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
565 (if bs-buffer-sort-function
566 (sort buffer-list bs-buffer-sort-function)
567 buffer-list))
569 (defun bs--redisplay (&optional keep-line-p sort-description)
570 "Redisplay whole Buffer Selection Menu.
571 If KEEP-LINE-P is non-nil the point will stay on current line.
572 SORT-DESCRIPTION is an element of `bs-sort-functions'."
573 (let ((line (count-lines 1 (point))))
574 (bs-show-in-buffer (bs-buffer-list nil sort-description))
575 (when keep-line-p
576 (goto-char (point-min))
577 (forward-line line))
578 (beginning-of-line)))
580 (defun bs--goto-current-buffer ()
581 "Goto line which represents the current buffer;
582 actually the line which begins with character in `bs-string-current' or
583 `bs-string-current-marked'."
584 (let ((regexp (concat "^"
585 (regexp-quote bs-string-current)
586 "\\|^"
587 (regexp-quote bs-string-current-marked)))
588 point)
589 (save-excursion
590 (goto-char (point-min))
591 (when (search-forward-regexp regexp nil t)
592 (setq point (1- (point)))))
593 (when point
594 (goto-char point))))
596 (defun bs--current-config-message ()
597 "Return a string describing the current `bs-mode' configuration."
598 (if bs--show-all
599 "Show all buffers."
600 (format "Show buffer by configuration %S"
601 bs-current-configuration)))
603 (defun bs--track-window-changes (frame)
604 "Track window changes to refresh the buffer list.
605 Used from `window-size-change-functions'."
606 (let ((win (get-buffer-window "*buffer-selection*" frame)))
607 (when win
608 (with-selected-window win
609 (bs--set-window-height)))))
611 (defun bs--remove-hooks ()
612 "Remove `bs--track-window-changes' and auxiliary hooks."
613 (remove-hook 'window-size-change-functions 'bs--track-window-changes)
614 ;; Remove itself
615 (remove-hook 'kill-buffer-hook 'bs--remove-hooks t)
616 (remove-hook 'change-major-mode-hook 'bs--remove-hooks t))
618 (put 'bs-mode 'mode-class 'special)
620 (define-derived-mode bs-mode nil "Buffer-Selection-Menu"
621 "Major mode for editing a subset of Emacs's buffers.
622 \\<bs-mode-map>
623 Aside from two header lines each line describes one buffer.
624 Move to a line representing the buffer you want to edit and select
625 buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill].
626 There are many key commands similar to `Buffer-menu-mode' for
627 manipulating the buffer list and buffers.
628 For faster navigation each digit key is a digit argument.
630 \\[bs-select] or SPACE -- select current line's buffer and other marked buffers.
631 \\[bs-toggle-show-all] -- toggle between all buffers and a special subset.
632 \\[bs-select-other-window] -- select current line's buffer in other window.
633 \\[bs-tmp-select-other-window] -- make another window display that buffer and
634 remain in Buffer Selection Menu.
635 \\[bs-mouse-select] -- select current line's buffer and other marked buffers.
636 \\[bs-save] -- save current line's buffer immediately.
637 \\[bs-delete] -- kill current line's buffer immediately.
638 \\[bs-toggle-readonly] -- toggle read-only status of current line's buffer.
639 \\[bs-clear-modified] -- clear modified-flag on that buffer.
640 \\[bs-mark-current] -- mark current line's buffer to be displayed.
641 \\[bs-unmark-current] -- unmark current line's buffer to be displayed.
642 \\[bs-show-sorted] -- display buffer list sorted by next sort aspect.
643 \\[bs-set-configuration-and-refresh] -- ask user for a configuration and \
644 apply selected configuration.
645 \\[bs-select-next-configuration] -- select and apply next \
646 available Buffer Selection Menu configuration.
647 \\[bs-kill] -- leave Buffer Selection Menu without a selection.
648 \\[bs-toggle-current-to-show] -- toggle status of appearance.
649 \\[bs-set-current-buffer-to-show-always] -- mark current line's buffer \
650 to show always.
651 \\[bs-visit-tags-table] -- call `visit-tags-table' on current line's buffer.
652 \\[bs-help] -- display this help text."
653 (make-local-variable 'font-lock-defaults)
654 (make-local-variable 'font-lock-verbose)
655 (make-local-variable 'font-lock-global-modes)
656 (buffer-disable-undo)
657 (setq buffer-read-only t
658 truncate-lines t
659 show-trailing-whitespace nil
660 font-lock-global-modes '(not bs-mode)
661 font-lock-defaults '(bs-mode-font-lock-keywords t)
662 font-lock-verbose nil)
663 (set (make-local-variable 'revert-buffer-function) 'bs-refresh)
664 (add-hook 'window-size-change-functions 'bs--track-window-changes)
665 (add-hook 'kill-buffer-hook 'bs--remove-hooks nil t)
666 (add-hook 'change-major-mode-hook 'bs--remove-hooks nil t))
668 (defun bs--restore-window-config ()
669 "Restore window configuration on the current frame."
670 (when bs--window-config-coming-from
671 (let ((frame (selected-frame)))
672 (unwind-protect
673 (set-window-configuration bs--window-config-coming-from)
674 (select-frame frame)))
675 (setq bs--window-config-coming-from nil)))
677 (defun bs-kill ()
678 "Let buffer disappear and reset window configuration."
679 (interactive)
680 (bury-buffer (current-buffer))
681 (bs--restore-window-config))
683 (defun bs-abort ()
684 "Ding and leave Buffer Selection Menu without a selection."
685 (interactive)
686 (ding)
687 (bs-kill))
689 (defun bs-set-configuration-and-refresh ()
690 "Ask user for a configuration and apply selected configuration.
691 Refresh whole Buffer Selection Menu."
692 (interactive)
693 (call-interactively 'bs-set-configuration)
694 (bs--redisplay t))
696 (defun bs-refresh (&rest _ignored)
697 "Refresh whole Buffer Selection Menu.
698 Arguments are IGNORED (for `revert-buffer')."
699 (interactive)
700 (bs--redisplay t))
702 (defun bs--set-window-height ()
703 "Change the height of the selected window to suit the current buffer list."
704 (unless (one-window-p t)
705 (fit-window-to-buffer (selected-window) bs-max-window-height)))
707 (defun bs--current-buffer ()
708 "Return buffer on current line.
709 Raise an error if not on a buffer line."
710 (beginning-of-line)
711 (let ((line (+ (- bs-header-lines-length)
712 (count-lines 1 (point)))))
713 (when (< line 0)
714 (error "You are on a header row"))
715 (nth line bs-current-list)))
717 (defun bs--update-current-line ()
718 "Update the entry on current line for Buffer Selection Menu."
719 (let ((buffer (bs--current-buffer))
720 (inhibit-read-only t))
721 (beginning-of-line)
722 (delete-region (point) (line-end-position))
723 (bs--insert-one-entry buffer)
724 (beginning-of-line)))
726 (defun bs-view ()
727 "View current line's buffer in View mode.
728 Leave Buffer Selection Menu."
729 (interactive)
730 (view-buffer (bs--current-buffer)))
732 (defun bs-select ()
733 "Select current line's buffer and other marked buffers.
734 If there are no marked buffers the window configuration before starting
735 Buffer Selection Menu will be restored.
736 If there are marked buffers each marked buffer and the current line's buffer
737 will be selected in a window.
738 Leave Buffer Selection Menu."
739 (interactive)
740 (let ((buffer (bs--current-buffer)))
741 (bury-buffer (current-buffer))
742 (bs--restore-window-config)
743 (switch-to-buffer buffer)
744 (when bs--marked-buffers
745 ;; Some marked buffers for selection
746 (let* ((all (delq buffer bs--marked-buffers))
747 (height (/ (1- (frame-height)) (1+ (length all)))))
748 (delete-other-windows)
749 (switch-to-buffer buffer)
750 (dolist (buf all)
751 (split-window nil height)
752 (other-window 1)
753 (switch-to-buffer buf))
754 ;; goto window we have started bs.
755 (other-window 1)))))
757 (defun bs-select-other-window ()
758 "Select current line's buffer by `switch-to-buffer-other-window'.
759 The window configuration before starting Buffer Selection Menu will be restored
760 unless there is no other window. In this case a new window will be created.
761 Leave Buffer Selection Menu."
762 (interactive)
763 (let ((buffer (bs--current-buffer)))
764 (bury-buffer (current-buffer))
765 (bs--restore-window-config)
766 (switch-to-buffer-other-window buffer)))
768 (defun bs-tmp-select-other-window ()
769 "Make the other window select this line's buffer.
770 The current window remains selected."
771 (interactive)
772 (let ((buffer (bs--current-buffer)))
773 (display-buffer buffer t)))
775 (defun bs-select-other-frame ()
776 "Select current line's buffer in new created frame.
777 Leave Buffer Selection Menu."
778 (interactive)
779 (let ((buffer (bs--current-buffer)))
780 (bury-buffer (current-buffer))
781 (bs--restore-window-config)
782 (switch-to-buffer-other-frame buffer)))
784 (defun bs-mouse-select-other-frame (event)
785 "Select selected line's buffer in new created frame.
786 Leave Buffer Selection Menu.
787 EVENT: a mouse click event."
788 (interactive "e")
789 (mouse-set-point event)
790 (bs-select-other-frame))
792 (defun bs-mouse-select (event)
793 "Select buffer on mouse click EVENT.
794 Select buffer by `bs-select'."
795 (interactive "e")
796 (mouse-set-point event)
797 (bs-select))
799 (defun bs-select-in-one-window ()
800 "Select current line's buffer in one window and delete other windows.
801 Leave Buffer Selection Menu."
802 (interactive)
803 (bs-select)
804 (delete-other-windows))
806 (defun bs-bury-buffer ()
807 "Bury buffer on current line."
808 (interactive)
809 (bury-buffer (bs--current-buffer))
810 (bs--redisplay t))
812 (defun bs-save ()
813 "Save buffer on current line."
814 (interactive)
815 (with-current-buffer (bs--current-buffer)
816 (save-buffer))
817 (bs--update-current-line))
819 (defun bs-visit-tags-table ()
820 "Visit the tags table in the buffer on this line.
821 See `visit-tags-table'."
822 (interactive)
823 (let ((file (buffer-file-name (bs--current-buffer))))
824 (if file
825 (visit-tags-table file)
826 (error "Specified buffer has no file"))))
828 (defun bs-toggle-current-to-show ()
829 "Toggle status of showing flag for buffer in current line."
830 (interactive)
831 (let ((res
832 (with-current-buffer (bs--current-buffer)
833 (setq bs-buffer-show-mark (case bs-buffer-show-mark
834 ((nil) 'never)
835 ((never) 'always)
836 (t nil))))))
837 (bs--update-current-line)
838 (bs--set-window-height)
839 (bs--show-config-message res)))
841 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
842 "Toggle status of buffer on line to `always shown'.
843 NOT-TO-SHOW-P: prefix argument.
844 With no prefix argument the buffer on current line is marked to show
845 always. Otherwise it is marked to show never."
846 (interactive "P")
847 (if not-to-show-p
848 (bs-set-current-buffer-to-show-never)
849 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
851 (defun bs-set-current-buffer-to-show-never ()
852 "Toggle status of buffer on line to `never shown'."
853 (interactive)
854 (bs--set-toggle-to-show (bs--current-buffer) 'never))
856 (defun bs--set-toggle-to-show (buffer what)
857 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
858 Redisplay current line and display a message describing
859 the status of buffer on current line."
860 (with-current-buffer buffer (setq bs-buffer-show-mark what))
861 (bs--update-current-line)
862 (bs--set-window-height)
863 (bs--show-config-message what))
865 (defun bs--mark-unmark (count fun)
866 "Call FUN on COUNT consecutive buffers of *buffer-selection*."
867 (let ((dir (if (> count 0) 1 -1)))
868 (dotimes (_i (abs count))
869 (let ((buffer (bs--current-buffer)))
870 (when buffer (funcall fun buffer))
871 (bs--update-current-line)
872 (bs-down dir)))))
874 (defun bs-mark-current (count)
875 "Mark buffers.
876 COUNT is the number of buffers to mark.
877 Move cursor vertically down COUNT lines."
878 (interactive "p")
879 (bs--mark-unmark count
880 (lambda (buf)
881 (add-to-list 'bs--marked-buffers buf))))
883 (defun bs-unmark-current (count)
884 "Unmark buffers.
885 COUNT is the number of buffers to unmark.
886 Move cursor vertically down COUNT lines."
887 (interactive "p")
888 (bs--mark-unmark count
889 (lambda (buf)
890 (setq bs--marked-buffers (delq buf bs--marked-buffers)))))
892 (defun bs--show-config-message (what)
893 "Show message indicating the new showing status WHAT.
894 WHAT is a value of nil, `never', or `always'."
895 (bs-message-without-log (cond ((null what)
896 "Buffer will be shown normally.")
897 ((eq what 'never)
898 "Mark buffer to never be shown.")
899 (t "Mark buffer to show always."))))
901 (defun bs-delete ()
902 "Kill buffer on current line."
903 (interactive)
904 (let ((current (bs--current-buffer))
905 (inhibit-read-only t))
906 (unless (kill-buffer current)
907 (error "Buffer was not deleted"))
908 (setq bs-current-list (delq current bs-current-list))
909 (beginning-of-line)
910 (delete-region (point) (save-excursion
911 (end-of-line)
912 (if (eobp) (point) (1+ (point)))))
913 (when (eobp)
914 (backward-delete-char 1)
915 (beginning-of-line)
916 (recenter -1))
917 (bs--set-window-height)))
919 (defun bs-delete-backward ()
920 "Like `bs-delete' but go to buffer in front of current."
921 (interactive)
922 (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
923 (bs-delete)
924 (unless on-last-line-p
925 (bs-up 1))))
927 (defun bs-show-sorted ()
928 "Show buffer list sorted by next sort aspect."
929 (interactive)
930 (setq bs--current-sort-function
931 (bs-next-config-aux (car bs--current-sort-function)
932 bs-sort-functions))
933 (bs--redisplay)
934 (bs--goto-current-buffer)
935 (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))
937 (defun bs-apply-sort-faces (&optional sort-description)
938 "Set text properties for the sort described by SORT-DESCRIPTION.
939 SORT-DESCRIPTION is an element of `bs-sort-functions'.
940 Default is `bs--current-sort-function'."
941 (let ((sort-description (or sort-description
942 bs--current-sort-function)))
943 (save-excursion
944 (goto-char (point-min))
945 (when (and (nth 2 sort-description)
946 (search-forward-regexp (nth 2 sort-description) nil t))
947 (let ((inhibit-read-only t))
948 (put-text-property (match-beginning 0)
949 (match-end 0)
950 'face
951 (or (nth 3 sort-description)
952 'region)))))))
954 (defun bs-toggle-show-all ()
955 "Toggle show all buffers / show buffers with current configuration."
956 (interactive)
957 (setq bs--show-all (not bs--show-all))
958 (bs--redisplay)
959 (bs--goto-current-buffer)
960 (bs-message-without-log "%s" (bs--current-config-message)))
962 (defun bs-toggle-readonly ()
963 "Toggle read-only status for buffer on current line.
964 Uses function `toggle-read-only'."
965 (interactive)
966 (with-current-buffer (bs--current-buffer)
967 (call-interactively 'toggle-read-only))
968 (bs--update-current-line))
970 (defun bs-clear-modified ()
971 "Set modified flag for buffer on current line to nil."
972 (interactive)
973 (with-current-buffer (bs--current-buffer)
974 (set-buffer-modified-p nil))
975 (bs--update-current-line))
977 (defun bs--nth-wrapper (count fun &rest args)
978 "Call COUNT times function FUN with arguments ARGS."
979 (dotimes (_i (or count 1))
980 (apply fun args)))
982 (defun bs-up (arg)
983 "Move cursor vertically up ARG lines in Buffer Selection Menu."
984 (interactive "p")
985 (if (and arg (numberp arg) (< arg 0))
986 (bs--nth-wrapper (- arg) 'bs--down)
987 (bs--nth-wrapper arg 'bs--up)))
989 (defun bs--up ()
990 "Move cursor vertically up one line.
991 If on top of buffer list go to last line."
992 (if (> (count-lines 1 (point)) bs-header-lines-length)
993 (forward-line -1)
994 (goto-char (point-max))
995 (beginning-of-line)
996 (recenter -1)))
998 (defun bs-down (arg)
999 "Move cursor vertically down ARG lines in Buffer Selection Menu."
1000 (interactive "p")
1001 (if (and arg (numberp arg) (< arg 0))
1002 (bs--nth-wrapper (- arg) 'bs--up)
1003 (bs--nth-wrapper arg 'bs--down)))
1005 (defun bs--down ()
1006 "Move cursor vertically down one line.
1007 If at end of buffer list go to first line."
1008 (if (eq (line-end-position) (point-max))
1009 (progn
1010 (goto-char (point-min))
1011 (forward-line 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 compatibility
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-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 ;; We don't want the frame iconified if the only window in the frame
1216 ;; happens to be dedicated.
1217 (bury-buffer (current-buffer))
1218 (switch-to-buffer next nil t)
1219 (setq bs--cycle-list (append (cdr cycle-list)
1220 (list (car cycle-list))))
1221 (bs-message-without-log "Next buffers: %s"
1222 (or (cdr bs--cycle-list)
1223 "this buffer"))))))
1225 ;;;###autoload
1226 (defun bs-cycle-previous ()
1227 "Select previous buffer defined by buffer cycling.
1228 The buffers taking part in buffer cycling are defined
1229 by buffer configuration `bs-cycle-configuration-name'."
1230 (interactive)
1231 (let ((bs--buffer-coming-from (current-buffer))
1232 (bs-dont-show-regexp bs-dont-show-regexp)
1233 (bs-must-show-regexp bs-must-show-regexp)
1234 (bs-dont-show-function bs-dont-show-function)
1235 (bs-must-show-function bs-must-show-function)
1236 (bs--show-all nil))
1237 (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration))
1238 (let ((bs-buffer-sort-function nil)
1239 (bs--current-sort-function nil))
1240 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1241 'bs-cycle-next)
1242 (eq last-command
1243 'bs-cycle-previous))
1244 bs--cycle-list)))
1245 (prev-buffer (car tupel))
1246 (cycle-list (cdr tupel)))
1247 (switch-to-buffer prev-buffer nil t)
1248 (setq bs--cycle-list (append (last cycle-list)
1249 (reverse (cdr (reverse cycle-list)))))
1250 (bs-message-without-log "Previous buffers: %s"
1251 (or (reverse (cdr bs--cycle-list))
1252 "this buffer"))))))
1254 (defun bs--get-value (fun &optional args)
1255 "Apply function FUN with arguments ARGS.
1256 Return result of evaluation. Will return FUN if FUN is a number
1257 or a string."
1258 (cond ((numberp fun)
1259 fun)
1260 ((stringp fun)
1261 fun)
1262 (t (apply fun args))))
1264 (defun bs--get-marked-string (start-buffer _all-buffers)
1265 "Return a string which describes whether current buffer is marked.
1266 START-BUFFER is the buffer where we started buffer selection.
1267 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu.
1268 The result string is one of `bs-string-current', `bs-string-current-marked',
1269 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1270 `bs-string-show-always'."
1271 (cond ;; current buffer is the buffer we started buffer selection.
1272 ((eq (current-buffer) start-buffer)
1273 (if (memq (current-buffer) bs--marked-buffers)
1274 bs-string-current-marked ; buffer is marked
1275 bs-string-current))
1276 ;; current buffer is marked
1277 ((memq (current-buffer) bs--marked-buffers)
1278 bs-string-marked)
1279 ;; current buffer hasn't a special mark.
1280 ((null bs-buffer-show-mark)
1281 bs-string-show-normally)
1282 ;; current buffer has a mark not to show itself.
1283 ((eq bs-buffer-show-mark 'never)
1284 bs-string-show-never)
1285 ;; otherwise current buffer is marked to show always.
1287 bs-string-show-always)))
1289 (defun bs--get-modified-string (_start-buffer _all-buffers)
1290 "Return a string which describes whether current buffer is modified.
1291 START-BUFFER is the buffer where we started buffer selection.
1292 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1293 (if (buffer-modified-p) "*" " "))
1295 (defun bs--get-readonly-string (_start-buffer _all-buffers)
1296 "Return a string which describes whether current buffer is read only.
1297 START-BUFFER is the buffer where we started buffer selection.
1298 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1299 (if buffer-read-only "%" " "))
1301 (defun bs--get-size-string (_start-buffer _all-buffers)
1302 "Return a string which describes the size of current buffer.
1303 START-BUFFER is the buffer where we started buffer selection.
1304 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1305 (int-to-string (buffer-size)))
1307 (defun bs--get-name (_start-buffer _all-buffers)
1308 "Return name of current buffer for Buffer Selection Menu.
1309 The name of current buffer gets additional text properties
1310 for mouse highlighting.
1311 START-BUFFER is the buffer where we started buffer selection.
1312 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1313 (propertize (buffer-name)
1314 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"
1315 'mouse-face 'highlight))
1317 (defun bs--get-mode-name (start-buffer _all-buffers)
1318 "Return the name of mode of current buffer for Buffer Selection Menu.
1319 START-BUFFER is the buffer where we started buffer selection.
1320 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1321 (format-mode-line mode-name nil nil start-buffer))
1323 (defun bs--get-file-name (_start-buffer _all-buffers)
1324 "Return string for column 'File' in Buffer Selection Menu.
1325 This is the variable `buffer-file-name' of current buffer.
1326 If not visiting a file, `list-buffers-directory' is returned instead.
1327 START-BUFFER is the buffer where we started buffer selection.
1328 ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
1329 (propertize (or buffer-file-name
1330 (bound-and-true-p list-buffers-directory)
1332 'mouse-face 'highlight
1333 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"))
1335 (defun bs--insert-one-entry (buffer)
1336 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1337 It goes over all columns described in `bs-attributes-list'
1338 and evaluates corresponding string. Inserts string in current buffer;
1339 normally *buffer-selection*."
1340 (let ((string "")
1341 (to-much 0)
1342 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1343 (with-current-buffer buffer
1344 (dolist (column bs-attributes-list)
1345 (let* ((min (bs--get-value (nth 1 column)))
1346 (new-string (bs--format-aux (bs--get-value (nth 4 column) ; fun
1347 apply-args)
1348 (nth 3 column) ; align
1349 (- min to-much)))
1350 (len (length new-string)))
1351 (setq string (concat string new-string))
1352 (when (> len min)
1353 (setq to-much (- len min))))))
1354 (insert string)))
1356 (defun bs--format-aux (string align len)
1357 "Pad STRING to length LEN with alignment ALIGN.
1358 ALIGN is one of the symbols `left', `middle', or `right'."
1359 (let* ((width (length string))
1360 (len (max len width)))
1361 (format (format "%%%s%ds" (if (eq align 'right) "" "-") len)
1362 (if (eq align 'middle)
1363 (concat (make-string (/ (- len width) 2) ?\s) string)
1364 string))))
1366 (defun bs--show-header ()
1367 "Insert header for Buffer Selection Menu in current buffer."
1368 (insert (bs--create-header-line #'identity)
1369 "\n"
1370 (bs--create-header-line (lambda (title)
1371 (make-string (length title) ?-)))
1372 "\n"))
1374 (defun bs--get-name-length ()
1375 "Return value of `bs--name-entry-length'."
1376 bs--name-entry-length)
1378 (defun bs--create-header-line (col)
1379 "Generate a line for the header.
1380 COL is called for each column in `bs-attributes-list' as a
1381 function of one argument, the string heading for the column."
1382 (mapconcat (lambda (column)
1383 (bs--format-aux (funcall col (bs--get-value (car column)))
1384 (nth 3 column) ; align
1385 (bs--get-value (nth 1 column))))
1386 bs-attributes-list
1387 ""))
1389 (defun bs--show-with-configuration (name &optional arg)
1390 "Display buffer list of configuration with name NAME.
1391 Set configuration NAME and determine window for Buffer Selection Menu.
1392 Unless current buffer is buffer *buffer-selection* we have to save
1393 the buffer we started Buffer Selection Menu and the current window
1394 configuration to restore buffer and window configuration after a
1395 selection. If there is already a window displaying *buffer-selection*
1396 select this window for Buffer Selection Menu. Otherwise open a new
1397 window.
1398 The optional argument ARG is the prefix argument when calling a function
1399 for buffer selection."
1400 (bs-set-configuration name)
1401 (let ((bs--show-all (or bs--show-all arg)))
1402 (unless (string= "*buffer-selection*" (buffer-name))
1403 ;; Only when not in buffer *buffer-selection*
1404 ;; we have to set the buffer we started the command
1405 (setq bs--buffer-coming-from (current-buffer)))
1406 (let ((liste (bs-buffer-list))
1407 (active-window (get-window-with-predicate
1408 (lambda (w)
1409 (string= (buffer-name (window-buffer w))
1410 "*buffer-selection*"))
1411 nil (selected-frame))))
1412 (if active-window
1413 (select-window active-window)
1414 (bs--restore-window-config)
1415 (setq bs--window-config-coming-from (current-window-configuration))
1416 (when (> (window-height (selected-window)) 7)
1417 ;; Errors would mess with the window configuration (bug#10882).
1418 (ignore-errors (select-window (split-window-below)))))
1419 (bs-show-in-buffer liste)
1420 (bs-message-without-log "%s" (bs--current-config-message)))))
1422 (defun bs--configuration-name-for-prefix-arg (prefix)
1423 "Convert prefix argument PREFIX to a name of a buffer configuration.
1424 If PREFIX is nil return `bs-default-configuration'.
1425 If PREFIX is an integer return PREFIX element of `bs-configurations'.
1426 Otherwise return `bs-alternative-configuration'."
1427 (cond ;; usually activation
1428 ((null prefix)
1429 bs-default-configuration)
1430 ;; call with integer as prefix argument
1431 ((integerp prefix)
1432 (if (and (< 0 prefix) (<= prefix (length bs-configurations)))
1433 (car (nth (1- prefix) bs-configurations))
1434 bs-default-configuration))
1435 ;; call by prefix argument C-u
1436 (t bs-alternative-configuration)))
1438 ;; ----------------------------------------------------------------------
1439 ;; Main function bs-customize and bs-show
1440 ;; ----------------------------------------------------------------------
1442 ;;;###autoload
1443 (defun bs-customize ()
1444 "Customization of group bs for Buffer Selection Menu."
1445 (interactive)
1446 (customize-group "bs"))
1448 ;;;###autoload
1449 (defun bs-show (arg)
1450 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1451 \\<bs-mode-map>
1452 There are many key commands similar to `Buffer-menu-mode' for
1453 manipulating the buffer list and the buffers themselves.
1454 User can move with [up] or [down], select a buffer
1455 by \\[bs-select] or [SPC]\n
1456 Type \\[bs-kill] to leave Buffer Selection Menu without a selection.
1457 Type \\[bs-help] after invocation to get help on commands available.
1458 With prefix argument ARG show a different buffer list. Function
1459 `bs--configuration-name-for-prefix-arg' determine accordingly
1460 name of buffer configuration."
1461 (interactive "P")
1462 (setq bs--marked-buffers nil)
1463 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1465 ;; ----------------------------------------------------------------------
1466 ;; Cleanup
1467 ;; ----------------------------------------------------------------------
1469 (defun bs-unload-function ()
1470 "Unload the Buffer Selection library."
1471 (let ((bs-buf (get-buffer "*buffer-selection*")))
1472 (when bs-buf
1473 (with-current-buffer bs-buf
1474 (when (eq major-mode 'bs-mode)
1475 (bs-kill)
1476 (kill-buffer bs-buf)))))
1477 ;; continue standard unloading
1478 nil)
1480 ;; Now provide feature bs
1481 (provide 'bs)
1483 ;;; bs.el ends here