bs.el 55.8 KB
Newer Older
1
;;; bs.el --- menu for selecting and displaying buffers -*- lexical-binding: t -*-
Gerd Moellmann's avatar
Gerd Moellmann committed
2

Eli Zaretskii's avatar
Eli Zaretskii committed
3
;; Copyright (C) 1998-2022 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
4
;; Author: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
5
;; Maintainer: emacs-devel@gnu.org
Gerd Moellmann's avatar
Gerd Moellmann committed
6
;; Keywords: convenience
7 8
;; Old-Version: 1.17
;; URL: http://www.geekware.de/software/emacs
Gerd Moellmann's avatar
Gerd Moellmann committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
24 25 26

;;; Commentary:

Juanma Barranquero's avatar
Juanma Barranquero committed
27
;; The bs-package contains a main function bs-show for popping up a
Gerd Moellmann's avatar
Gerd Moellmann committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41
;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
;; The new buffer offers a Buffer Selection Menu for manipulating
;; the buffer list and buffers.
;;
;; -----------------------------------------------------------------------
;; | MR Buffer          Size  Mode          File                         |
;; | -- ------          ----  ----          ----                         |
;; |.   bs.el           14690  Emacs-Lisp    /home/sun/sylvester/el/bs.e$|
;; |  % executable.el    9429  Emacs-Lisp    /usr/share/emacs/19.34/lisp$|
;; |  % vc.el          104893  Emacs-Lisp    /usr/share/emacs/19.34/lisp$|
;; |  % test_vc.el        486  Emacs-Lisp    /home/sun/sylvester/el/test$|
;; |  % vc-hooks.el     43605  Emacs-Lisp    /usr/share/emacs/19.34/lisp$|
;; -----------------------------------------------------------------------

Juanma Barranquero's avatar
Juanma Barranquero committed
42
;;; Quick Installation and Customization:
Gerd Moellmann's avatar
Gerd Moellmann committed
43

44
;; To display the bs menu, do
Gerd Moellmann's avatar
Gerd Moellmann committed
45
;;   M-x bs-show
46 47
;; To customize its behavior, do
;;   M-x bs-customize
Gerd Moellmann's avatar
Gerd Moellmann committed
48 49 50 51 52 53 54 55 56 57 58 59 60

;;; More Commentary:

;; bs-show will generate a new buffer named *buffer-selection*, which shows
;; all buffers or a subset of them, and has possibilities for deleting,
;; saving and selecting buffers. For more details see docstring of
;; function `bs-mode'. A current configuration describes which buffers appear
;; in *buffer-selection*. See docstring of variable `bs-configurations' for
;; more details.
;;
;; The package bs combines the advantages of the Emacs functions
;; `list-buffers' and `electric-buffer-list'.
;;
61
;; Additional features for Buffer Selection Menu:
Gerd Moellmann's avatar
Gerd Moellmann committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
;;  - configurable list of buffers (show only files etc.).
;;  - comfortable way to change displayed subset of all buffers.
;;  - show sorted list of buffers.
;;  - cyclic navigation:
;;     - goes to top of buffer list if you are on last line and press down.
;;     - goes to end of buffer list if you are on first line and press up.
;;  - Offer an alternative buffer list by prefix key C-u.

;;; Cycling through buffers

;; This package offers two functions for buffer cycling. If you want to cycle
;; through buffer list you can use `bs-cycle-next' or `bs-cycle-previous'.
;; Bind these function to a key like
;;   (global-set-key [(f9)]   'bs-cycle-previous)
;;   (global-set-key [(f10)]  'bs-cycle-next)
;;
;; Both functions use a special subset of all buffers for cycling to avoid
;; to go through internal buffers like *Messages*.
;;
;; Cycling through buffers ignores sorting because sorting destroys
;; the logical buffer list. If buffer list is sorted by size you
;; won't be able to cycle to the smallest buffer.

;;; Customization:

;; There is a customization group called `bs' in group `convenience'.
;; Start customization by M-x bs-customize
;;
;; Buffer list
;; -----------
;; You can define your own configurations by extending variable
;; `bs-configurations' (see docstring for details).
;;
;; `bs-default-configuration' contains the name of default configuration.
;; The default value is "files" which means to show only files.
;;
;; If you always want to see all buffers, customize variable
;; `bs-default-configuration' in customization group `bs'.
;;
;; Configure sorting
;; -----------------
;; You can define functions for sorting the buffer list.
;; When selecting buffers, you can step through available sorting
;; methods with key 'S'.
;; To define a new way of sorting, customize variable `bs-sort-functions'.
;;
;; There are four basic functions for sorting:
;;   by buffer name, by mode, by size, or by filename
;;
;; Configure buffer cycling
;; ------------------------
;; When cycling through buffer list the functions for cycling will use
;; the current configuration of bs to calculate the buffer list.
;; If you want to use a different configuration for cycling you have to set
;; the variable `bs-cycle-configuration-name'. You can customize this variable.
;;
;; For example: If you use the configuration called "files-and-scratch" you
;; can cycle through all file buffers and *scratch* although your current
;; configuration perhaps is "files" which ignores buffer *scratch*.

;;; Code:

;; ----------------------------------------------------------------------
;; Globals for customization
;; ----------------------------------------------------------------------

(defgroup bs nil
  "Buffer Selection: Maintaining buffers by buffer menu."
Dave Love's avatar
Dave Love committed
130
  :version "21.1"
Dave Love's avatar
Dave Love committed
131
  :link '(emacs-commentary-link "bs")
132
  :link '(url-link "http://www.geekware.de/software/emacs")
Gerd Moellmann's avatar
Gerd Moellmann committed
133 134
  :group 'convenience)

135 136
(defgroup bs-appearance nil
  "Buffer Selection appearance: Appearance of bs buffer menu."
Gerd Moellmann's avatar
Gerd Moellmann committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150
  :group 'bs)

(defcustom bs-attributes-list
  '((""       1   1 left  bs--get-marked-string)
    ("M"      1   1 left  bs--get-modified-string)
    ("R"      2   2 left  bs--get-readonly-string)
    ("Buffer" bs--get-name-length 10 left  bs--get-name)
    (""       1   1 left  " ")
    ("Size"   8   8 right bs--get-size-string)
    (""       1   1 left  " ")
    ("Mode"   12 12 right bs--get-mode-name)
    (""       2   2 left  "  ")
    ("File"   12 12 left  bs--get-file-name)
    (""       2   2 left  "  "))
151
  "List specifying the layout of a Buffer Selection Menu buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
152
Each entry specifies a column and is a list of the form of:
153
\(HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING)
154 155 156 157 158 159 160 161 162 163 164

HEADER         : String for header for first line or a function
                 which calculates column title.
MINIMUM-LENGTH : Minimum width of column (number or name of function).
                 The function must return a positive integer.
MAXIMUM-LENGTH : Maximum width of column (number or name of function)
                 (currently ignored).
ALIGNMENT      : Alignment of column (`left', `right', `middle').
FUN-OR-STRING  : Name of a function for calculating the value or a
                 string for a constant value.

165
The function gets as parameter the buffer where we have started
Gerd Moellmann's avatar
Gerd Moellmann committed
166
buffer selection and the list of all buffers to show.  The function must
167 168
return a string representing the column's value."
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
169 170 171 172
  :type '(repeat sexp))

(defun bs--make-header-match-string ()
  "Return a regexp matching the first line of a Buffer Selection Menu buffer."
173 174 175 176 177 178
  (concat "^\\("
          (apply #'concat (mapcan (lambda (e)
                                    (and (not (equal (car e) ""))
                                         (list " *" (car e))))
                                  bs-attributes-list))
          " *$\\)"))
Gerd Moellmann's avatar
Gerd Moellmann committed
179

180
;; Font-Lock-Settings
Gerd Moellmann's avatar
Gerd Moellmann committed
181
(defvar bs-mode-font-lock-keywords
182
  (list ;; header in font-lock-type-face
Dave Love's avatar
Dave Love committed
183 184 185
   (list (bs--make-header-match-string)
	 '(1 font-lock-type-face append) '(1 'bold append))
   ;; Buffername embedded by *
186
   (list "^\\(.*\\*.*\\*.*\\)$" 1 'font-lock-constant-face)
Dave Love's avatar
Dave Love committed
187
   ;; Dired-Buffers
Yoni Rabkin's avatar
Yoni Rabkin committed
188
   '("^..\\(.*Dired .*\\)$" 1 font-lock-function-name-face)
Dave Love's avatar
Dave Love committed
189 190
   ;; the star for modified buffers
   '("^.\\(\\*\\) +[^\\*]"     1 font-lock-comment-face))
Gerd Moellmann's avatar
Gerd Moellmann committed
191 192 193
  "Default font lock expressions for Buffer Selection Menu.")

(defcustom bs-max-window-height 20
194
  "Maximal window height of Buffer Selection Menu."
195
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
  :type 'integer)

(defvar bs-dont-show-regexp nil
  "Regular expression specifying which buffers not to show.
A buffer whose name matches this regular expression will not be
included in the buffer list.")

(defvar bs-must-show-regexp nil
  "Regular expression for specifying buffers which must be shown.
A buffer whose name matches this regular expression will be
included in the buffer list.
Note that this variable is temporary: if the configuration is changed
it is reset to nil.  Use `bs-must-always-show-regexp' to specify buffers
that must always be shown regardless of the configuration.")

(defcustom bs-must-always-show-regexp nil
212
  "Regular expression for specifying buffers to show always.
Gerd Moellmann's avatar
Gerd Moellmann committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
A buffer whose name matches this regular expression will
be shown regardless of current configuration of Buffer Selection Menu."
  :group 'bs
  :type '(choice (const :tag "Nothing at all" nil) regexp))

(defvar bs-dont-show-function nil
  "Function for specifying buffers not to show.
The function gets one argument - the buffer to test.  The function must
return a value different from nil to ignore the buffer in
Buffer Selection Menu.")

(defvar bs-must-show-function nil
  "Function for specifying buffers which must be shown.
The function gets one argument - the buffer to test.")

(defvar bs-buffer-sort-function nil
  "Sort function to sort the buffers that appear in Buffer Selection Menu.
230 231
The function gets two arguments - the buffers to compare.
It must return non-nil if the first buffer should sort before the second.")
Gerd Moellmann's avatar
Gerd Moellmann committed
232 233

(defcustom bs-maximal-buffer-name-column 45
234
  "Maximum column width for buffer names.
Gerd Moellmann's avatar
Gerd Moellmann committed
235 236 237 238
The column for buffer names has dynamic width.  The width depends on
maximal and minimal length of names of buffers to show.  The maximal
width is bounded by `bs-maximal-buffer-name-column'.
See also `bs-minimal-buffer-name-column'."
239
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
240 241 242
  :type 'integer)

(defcustom bs-minimal-buffer-name-column 15
243
  "Minimum column width for buffer names.
Gerd Moellmann's avatar
Gerd Moellmann committed
244 245 246 247
The column for buffer names has dynamic width.  The width depends on
maximal and minimal length of names of buffers to show.  The minimal
width is bounded by `bs-minimal-buffer-name-column'.
See also `bs-maximal-buffer-name-column'."
248
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
249 250 251 252 253 254 255 256
  :type 'integer)

(defconst bs-header-lines-length 2
  "Number of lines for headers in Buffer Selection Menu.")

(defcustom bs-configurations
  '(("all" nil nil nil nil nil)
    ("files" nil nil nil bs-visits-non-file bs-sort-buffer-interns-are-last)
257
    ("files-and-scratch" "^\\*scratch\\*$" nil nil bs-visits-non-file
Gerd Moellmann's avatar
Gerd Moellmann committed
258 259
     bs-sort-buffer-interns-are-last)
    ("all-intern-last" nil nil nil nil bs-sort-buffer-interns-are-last))
260
  "List of all configurations you can use in the Buffer Selection Menu.
Gerd Moellmann's avatar
Gerd Moellmann committed
261
A configuration describes which buffers appear in Buffer Selection Menu
262
and also the order of buffers.  A configuration is a list with
Gerd Moellmann's avatar
Gerd Moellmann committed
263 264
six elements.  The first element is a string and describes the configuration.
The following five elements represent the values for Buffer Selection Menu
265 266
configuration variables `bs-must-show-regexp', `bs-must-show-function',
`bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'.
Gerd Moellmann's avatar
Gerd Moellmann committed
267
By setting these variables you define a configuration."
268
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
269 270 271
  :type '(repeat sexp))

(defcustom bs-default-configuration "files"
272
  "Name of default configuration used by the Buffer Selection Menu.
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274 275 276 277 278 279
\\<bs-mode-map>
Will be changed using key \\[bs-select-next-configuration].
Must be a string used in `bs-configurations' for naming a configuration."
  :group 'bs
  :type 'string)

(defcustom bs-alternative-configuration "all"
280
  "Name of configuration used when calling `bs-show' with \
Gerd Moellmann's avatar
Gerd Moellmann committed
281 282 283 284 285 286 287
\\[universal-argument] as prefix key.
Must be a string used in `bs-configurations' for naming a configuration."
  :group 'bs
  :type  'string)

(defvar bs-current-configuration bs-default-configuration
  "Name of current configuration.
288
Must be a string used in `bs-configurations' for naming a configuration.")
Gerd Moellmann's avatar
Gerd Moellmann committed
289 290

(defcustom bs-cycle-configuration-name nil
291
  "Name of configuration used when cycling through the buffer list.
Gerd Moellmann's avatar
Gerd Moellmann committed
292 293 294 295 296 297 298
A value of nil means to use current configuration `bs-default-configuration'.
Must be a string used in `bs-configurations' for naming a configuration."
  :group 'bs
  :type '(choice (const :tag "like current configuration" nil)
   string))

(defcustom bs-string-show-always "+"
299
  "String added in column 1 indicating a buffer will always be shown."
300
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
301 302 303
  :type 'string)

(defcustom bs-string-show-never "-"
304
  "String added in column 1 indicating a buffer will never be shown."
305
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
306 307 308
  :type 'string)

(defcustom bs-string-current "."
309
  "String added in column 1 indicating the current buffer."
310
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
311 312 313
  :type 'string)

(defcustom bs-string-current-marked "#"
314
  "String added in column 1 indicating the current buffer when it is marked."
315
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
316 317 318
  :type 'string)

(defcustom bs-string-marked ">"
319
  "String added in column 1 indicating a marked buffer."
320
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
321 322 323
  :type 'string)

(defcustom bs-string-show-normally  " "
324
  "String added in column 1 indicating an unmarked buffer."
325
  :group 'bs-appearance
Gerd Moellmann's avatar
Gerd Moellmann committed
326 327 328 329 330 331 332
  :type 'string)

(defvar bs--name-entry-length 20
  "Maximum length of all displayed buffer names.
Used internally, only.")

;; ----------------------------------------------------------------------
333
;; Internal globals
Gerd Moellmann's avatar
Gerd Moellmann committed
334 335
;; ----------------------------------------------------------------------

336
(defvar-local bs-buffer-show-mark nil
Gerd Moellmann's avatar
Gerd Moellmann committed
337
  "Flag for the current mode for showing this buffer.
338 339
A value of nil means buffer will be shown depending on the current
configuration.
Gerd Moellmann's avatar
Gerd Moellmann committed
340 341 342 343 344 345
A value of `never' means to never show the buffer.
A value of `always' means to show buffer regardless of the configuration.")

(defun bs--sort-by-name (b1 b2)
  "Compare buffers B1 and B2 by buffer name."
  (string< (buffer-name b1)
Dave Love's avatar
Dave Love committed
346
	   (buffer-name b2)))
Gerd Moellmann's avatar
Gerd Moellmann committed
347 348 349 350

(defun bs--sort-by-filename (b1 b2)
  "Compare buffers B1 and B2 by file name."
  (string< (or (buffer-file-name b1) "")
Dave Love's avatar
Dave Love committed
351
	   (or (buffer-file-name b2) "")))
Gerd Moellmann's avatar
Gerd Moellmann committed
352 353 354

(defun bs--sort-by-mode (b1 b2)
  "Compare buffers B1 and B2 by mode name."
355 356 357
  (save-current-buffer
    (string< (progn (set-buffer b1) (format-mode-line mode-name nil nil b1))
	     (progn (set-buffer b2) (format-mode-line mode-name nil nil b2)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
358 359 360

(defun bs--sort-by-size (b1 b2)
  "Compare buffers B1 and B2 by buffer size."
361
  (< (buffer-size b1) (buffer-size b2)))
Gerd Moellmann's avatar
Gerd Moellmann committed
362 363 364 365 366 367 368

(defcustom bs-sort-functions
  '(("by name"     bs--sort-by-name     "Buffer" region)
    ("by size"     bs--sort-by-size     "Size"   region)
    ("by mode"     bs--sort-by-mode     "Mode"   region)
    ("by filename" bs--sort-by-filename "File"   region)
    ("by nothing"  nil                  nil      nil))
369
  "List of all possible sorting aspects for Buffer Selection Menu.
Gerd Moellmann's avatar
Gerd Moellmann committed
370
You can add a new entry with a call to `bs-define-sort-function'.
371
Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE).
Gerd Moellmann's avatar
Gerd Moellmann committed
372
NAME specifies the sort order defined by function FUNCTION.
373
FUNCTION nil means don't sort the buffer list.  Otherwise the function
Gerd Moellmann's avatar
Gerd Moellmann committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
must have two parameters - the buffers to compare.
REGEXP-FOR-SORTING is a regular expression which describes the
column title to highlight.
FACE is a face used to fontify the sorted column title.  A value of nil means
don't highlight."
  :group 'bs
  :type '(repeat sexp))

(defun bs-define-sort-function (name fun &optional regexp-for-sorting face)
  "Define a new function for buffer sorting in Buffer Selection Menu.
NAME specifies the sort order defined by function FUN.
A value of nil for FUN means don't sort the buffer list.  Otherwise the
functions must have two parameters - the buffers to compare.
REGEXP-FOR-SORTING is a regular expression which describes the
column title to highlight.
FACE is a face used to fontify the sorted column title.  A value of nil means
don't highlight.
The new sort aspect will be inserted into list `bs-sort-functions'."
  (let ((tupel (assoc name bs-sort-functions)))
    (if tupel
Dave Love's avatar
Dave Love committed
394
	(setcdr tupel (list fun regexp-for-sorting face))
Gerd Moellmann's avatar
Gerd Moellmann committed
395
      (setq bs-sort-functions
Dave Love's avatar
Dave Love committed
396 397
	    (cons (list name fun regexp-for-sorting face)
		  bs-sort-functions)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
398 399 400 401 402 403

(defvar bs--current-sort-function nil
  "Description of the current function for sorting the buffer list.
This is an element of `bs-sort-functions'.")

(defcustom bs-default-sort-name "by nothing"
404
  "Name of default sort behavior.
Gerd Moellmann's avatar
Gerd Moellmann committed
405 406 407 408 409
Must be \"by nothing\" or a string used in `bs-sort-functions' for
naming a sort behavior.  Default is \"by nothing\" which means no sorting."
  :group 'bs
  :type  'string
  :set (lambda (var-name value)
Dave Love's avatar
Dave Love committed
410 411 412
	 (set var-name value)
	 (setq bs--current-sort-function
	       (assoc value bs-sort-functions))))
Gerd Moellmann's avatar
Gerd Moellmann committed
413 414 415 416 417 418

(defvar bs--buffer-coming-from nil
  "The buffer in which the user started the current Buffer Selection Menu.")

(defvar bs--show-all nil
  "Flag whether showing all buffers regardless of current configuration.
419
Non-nil means to show all buffers.  Otherwise show buffers
Gerd Moellmann's avatar
Gerd Moellmann committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
defined by current configuration `bs-current-configuration'.")

(defvar bs--window-config-coming-from nil
  "Window configuration before starting Buffer Selection Menu.")

(defvar bs--intern-show-never "^ \\|\\*buffer-selection\\*"
  "Regular expression specifying which buffers never to show.
A buffer whose name matches this regular expression will never be
included in the buffer list.")

(defvar bs-current-list nil
  "List of buffers shown in Buffer Selection Menu.
Used internally, only.")

(defvar bs--marked-buffers nil
  "Currently marked buffers in Buffer Selection Menu.")

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
(defvar-keymap bs-mode-map
  :doc "Keymap of `bs-mode'."
  "SPC"     #'bs-select
  "f"       #'bs-select
  "v"       #'bs-view
  "!"       #'bs-select-in-one-window
  "F"       #'bs-select-other-frame
  "1"       #'digit-argument
  "2"       #'digit-argument
  "3"       #'digit-argument
  "4"       #'digit-argument
  "5"       #'digit-argument
  "6"       #'digit-argument
  "7"       #'digit-argument
  "8"       #'digit-argument
  "9"       #'digit-argument
  "-"       #'negative-argument
  "ESC -"   #'negative-argument
  "o"       #'bs-select-other-window
  "C-o"     #'bs-tmp-select-other-window
  "<up>"    #'bs-up
  "n"       #'bs-down
  "p"       #'bs-up
  "<down>"  #'bs-down
  "C-m"     #'bs-select
  "b"       #'bs-bury-buffer
  "s"       #'bs-save
  "S"       #'bs-show-sorted
  "a"       #'bs-toggle-show-all
  "d"       #'bs-delete
  "C-d"     #'bs-delete-backward
  "k"       #'bs-delete
  "g"       #'bs-refresh
  "C"       #'bs-set-configuration-and-refresh
  "c"       #'bs-select-next-configuration
  "q"       #'bs-kill
  ;; "z"       #'bs-kill
  "C-c C-c" #'bs-kill
  "C-g"     #'bs-abort
  "C-]"     #'bs-abort
  "%"       #'bs-toggle-readonly
  "~"       #'bs-clear-modified
  "M"       #'bs-toggle-current-to-show
  "+"       #'bs-set-current-buffer-to-show-always
  ;; "-"       #'bs-set-current-buffer-to-show-never
  "t"       #'bs-visit-tags-table
  "m"       #'bs-mark-current
  "u"       #'bs-unmark-current
  "U"       #'bs-unmark-all
  "DEL"     #'bs-unmark-previous
  ">"       #'scroll-right
  "<"       #'scroll-left
  "?"       #'bs-help
  "<mouse-2>" #'bs-mouse-select
  "<mouse-3>" #'bs-mouse-select-other-frame)
Gerd Moellmann's avatar
Gerd Moellmann committed
492 493 494 495 496 497 498

;; ----------------------------------------------------------------------
;; Functions
;; ----------------------------------------------------------------------

(defun bs-buffer-list (&optional list sort-description)
  "Return a list of buffers to be shown.
499
LIST is a list of buffers to test for appearance in Buffer Selection Menu.
Gerd Moellmann's avatar
Gerd Moellmann committed
500 501 502 503 504 505
The result list depends on the global variables `bs-dont-show-regexp',
`bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
and `bs-buffer-sort-function'.
If SORT-DESCRIPTION isn't nil the list will be sorted by
a special function.  SORT-DESCRIPTION is an element of `bs-sort-functions'."
  (setq sort-description (or sort-description bs--current-sort-function)
Dave Love's avatar
Dave Love committed
506
	list (or list (buffer-list)))
Gerd Moellmann's avatar
Gerd Moellmann committed
507
  (let ((result nil))
508 509 510
    (dolist (buf list)
      (let* ((buffername (buffer-name buf))
	     (int-show-never (string-match-p bs--intern-show-never buffername))
Dave Love's avatar
Dave Love committed
511
	     (ext-show-never (and bs-dont-show-regexp
512 513
				  (string-match-p bs-dont-show-regexp
						  buffername)))
Dave Love's avatar
Dave Love committed
514
	     (extern-must-show (or (and bs-must-always-show-regexp
515
					(string-match-p
Dave Love's avatar
Dave Love committed
516 517 518
					 bs-must-always-show-regexp
					 buffername))
				   (and bs-must-show-regexp
519 520
					(string-match-p bs-must-show-regexp
							buffername))))
Dave Love's avatar
Dave Love committed
521 522
	     (extern-show-never-from-fun (and bs-dont-show-function
					      (funcall bs-dont-show-function
523
						       buf)))
Dave Love's avatar
Dave Love committed
524 525
	     (extern-must-show-from-fun (and bs-must-show-function
					     (funcall bs-must-show-function
526 527 528 529 530 531 532 533 534 535 536
						      buf)))
	     (show-flag (buffer-local-value 'bs-buffer-show-mark buf)))
	(when (or (eq show-flag 'always)
		  (and (or bs--show-all (not (eq show-flag 'never)))
		       (not int-show-never)
		       (or bs--show-all
			   extern-must-show
			   extern-must-show-from-fun
			   (and (not ext-show-never)
				(not extern-show-never-from-fun)))))
	  (setq result (cons buf result)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
537 538 539 540
    (setq result (reverse result))
    ;; The current buffer which was the start point of bs should be an element
    ;; of result list, so that we can leave with space and be back in the
    ;; buffer we started bs-show.
541 542 543 544
    (when (and bs--buffer-coming-from
	       (buffer-live-p bs--buffer-coming-from)
	       (not (memq bs--buffer-coming-from result)))
      (setq result (cons bs--buffer-coming-from result)))
Gerd Moellmann's avatar
Gerd Moellmann committed
545 546
    ;; sorting
    (if (and sort-description
Dave Love's avatar
Dave Love committed
547 548
	     (nth 1 sort-description))
	(setq result (sort result (nth 1 sort-description)))
Gerd Moellmann's avatar
Gerd Moellmann committed
549 550 551 552 553 554 555 556 557 558 559
      ;; else standard sorting
      (bs-buffer-sort result))))

(defun bs-buffer-sort (buffer-list)
  "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
  (if bs-buffer-sort-function
      (sort buffer-list bs-buffer-sort-function)
    buffer-list))

(defun bs--redisplay (&optional keep-line-p sort-description)
  "Redisplay whole Buffer Selection Menu.
560
If KEEP-LINE-P is non-nil the point will stay on current line.
561
SORT-DESCRIPTION is an element of `bs-sort-functions'."
562
  (let ((line (count-lines 1 (point))))
Gerd Moellmann's avatar
Gerd Moellmann committed
563
    (bs-show-in-buffer (bs-buffer-list nil sort-description))
564
    (when keep-line-p
565 566
      (goto-char (point-min))
      (forward-line line))
Gerd Moellmann's avatar
Gerd Moellmann committed
567 568 569 570 571 572
    (beginning-of-line)))

(defun bs--goto-current-buffer ()
  "Goto line which represents the current buffer;
actually the line which begins with character in `bs-string-current' or
`bs-string-current-marked'."
Dave Love's avatar
Dave Love committed
573 574 575 576 577
  (let ((regexp (concat "^"
			(regexp-quote bs-string-current)
			"\\|^"
			(regexp-quote bs-string-current-marked)))
	point)
Gerd Moellmann's avatar
Gerd Moellmann committed
578 579
    (save-excursion
      (goto-char (point-min))
580 581 582 583
      (when (search-forward-regexp regexp nil t)
	(setq point (1- (point)))))
    (when point
      (goto-char point))))
Gerd Moellmann's avatar
Gerd Moellmann committed
584 585 586 587 588 589

(defun bs--current-config-message ()
  "Return a string describing the current `bs-mode' configuration."
  (if bs--show-all
      "Show all buffers."
    (format "Show buffer by configuration %S"
Dave Love's avatar
Dave Love committed
590
	    bs-current-configuration)))
Gerd Moellmann's avatar
Gerd Moellmann committed
591

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
(defun bs--track-window-changes (frame)
  "Track window changes to refresh the buffer list.
Used from `window-size-change-functions'."
  (let ((win (get-buffer-window "*buffer-selection*" frame)))
    (when win
      (with-selected-window win
	(bs--set-window-height)))))

(defun bs--remove-hooks ()
  "Remove `bs--track-window-changes' and auxiliary hooks."
  (remove-hook 'window-size-change-functions 'bs--track-window-changes)
  ;; Remove itself
  (remove-hook 'kill-buffer-hook 'bs--remove-hooks t)
  (remove-hook 'change-major-mode-hook 'bs--remove-hooks t))

607 608
(put 'bs-mode 'mode-class 'special)

609
(define-derived-mode bs-mode nil "Buffer-Selection-Menu"
610
  "Major mode for editing a subset of Emacs's buffers.
Gerd Moellmann's avatar
Gerd Moellmann committed
611 612 613
\\<bs-mode-map>
Aside from two header lines each line describes one buffer.
Move to a line representing the buffer you want to edit and select
614
buffer by \\[bs-select] or SPC.  Abort buffer list with \\[bs-kill].
Gerd Moellmann's avatar
Gerd Moellmann committed
615 616 617 618 619
There are many key commands similar to `Buffer-menu-mode' for
manipulating the buffer list and buffers.
For faster navigation each digit key is a digit argument.

\\[bs-select] or SPACE -- select current line's buffer and other marked buffers.
620 621 622
\\[bs-select-in-one-window] -- select current's line buffer in one \
window, and delete other
     windows in the same frame.
Gerd Moellmann's avatar
Gerd Moellmann committed
623
\\[bs-select-other-window] -- select current line's buffer in other window.
624 625 626 627 628 629
\\[bs-tmp-select-other-window] -- display current line's buffer in \
other window, and remain in
     Buffer Selection Menu.
\\[bs-select-other-frame] -- select current's line buffer in a new frame.
\\[bs-view] -- view current's line buffer in View mode.
\\[bs-visit-tags-table] -- call `visit-tags-table' on current line's buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
630
\\[bs-mouse-select] -- select current line's buffer and other marked buffers.
631 632
\\[bs-mouse-select-other-frame] -- select current's line buffer in a new frame.

Gerd Moellmann's avatar
Gerd Moellmann committed
633 634
\\[bs-mark-current] -- mark current line's buffer to be displayed.
\\[bs-unmark-current] -- unmark current line's buffer to be displayed.
635
\\[bs-unmark-previous] -- unmark previous line's buffer to be displayed.
636 637 638 639 640 641 642 643
\\[bs-unmark-all] -- unmark all buffer lines.

\\[bs-bury-buffer] -- bury current's line buffer.
\\[bs-save] -- save current line's buffer immediately.
\\[bs-delete] -- kill current line's buffer immediately.
\\[bs-delete-backward] -- like \\[bs-delete], but then move to previous line.
\\[bs-clear-modified] -- clear modified-flag on that buffer.
\\[bs-toggle-readonly] -- toggle read-only status of current line's buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
644 645
\\[bs-set-current-buffer-to-show-always] -- mark current line's buffer \
to show always.
646 647 648 649 650 651 652 653 654 655 656
\\[bs-toggle-current-to-show] -- toggle status of appearance.

\\[bs-toggle-show-all] -- toggle between all buffers and a special subset.
\\[bs-select-next-configuration] -- select and apply next available \
configuration.
\\[bs-set-configuration-and-refresh] -- ask user for a configuration and \
apply it.
\\[bs-show-sorted] -- display buffer list sorted by next sort aspect.

\\[bs-kill] -- leave Buffer Selection Menu without a selection.
\\[bs-refresh] -- refresh Buffer Selection Menu.
Gerd Moellmann's avatar
Gerd Moellmann committed
657
\\[bs-help] -- display this help text."
658
  (buffer-disable-undo)
659
  (setq buffer-read-only t
Dave Love's avatar
Dave Love committed
660
	truncate-lines t
661 662 663 664 665
	show-trailing-whitespace nil)
  (setq-local font-lock-defaults '(bs-mode-font-lock-keywords t))
  (setq-local font-lock-verbose nil)
  (setq-local font-lock-global-modes '(not bs-mode))
  (setq-local revert-buffer-function 'bs-refresh)
666 667 668
  (add-hook 'window-size-change-functions 'bs--track-window-changes)
  (add-hook 'kill-buffer-hook 'bs--remove-hooks nil t)
  (add-hook 'change-major-mode-hook 'bs--remove-hooks nil t))
Gerd Moellmann's avatar
Gerd Moellmann committed
669

670 671 672
(defun bs--restore-window-config ()
  "Restore window configuration on the current frame."
  (when bs--window-config-coming-from
673 674 675 676
    (let ((frame (selected-frame)))
      (unwind-protect
	   (set-window-configuration bs--window-config-coming-from)
	(select-frame frame)))
677 678
    (setq bs--window-config-coming-from nil)))

Gerd Moellmann's avatar
Gerd Moellmann committed
679
(defun bs-kill ()
680
  "Let buffer disappear and reset window configuration."
Gerd Moellmann's avatar
Gerd Moellmann committed
681 682
  (interactive)
  (bury-buffer (current-buffer))
683
  (bs--restore-window-config))
Gerd Moellmann's avatar
Gerd Moellmann committed
684 685 686

(defun bs-abort ()
  "Ding and leave Buffer Selection Menu without a selection."
Dave Love's avatar
Dave Love committed
687
  (interactive)
Gerd Moellmann's avatar
Gerd Moellmann committed
688 689 690 691 692 693 694 695 696 697
  (ding)
  (bs-kill))

(defun bs-set-configuration-and-refresh ()
  "Ask user for a configuration and apply selected configuration.
Refresh whole Buffer Selection Menu."
  (interactive)
  (call-interactively 'bs-set-configuration)
  (bs--redisplay t))

698
(defun bs-refresh (&rest _ignored)
699 700
  "Refresh whole Buffer Selection Menu.
Arguments are IGNORED (for `revert-buffer')."
Gerd Moellmann's avatar
Gerd Moellmann committed
701 702 703 704 705 706
  (interactive)
  (bs--redisplay t))

(defun bs--set-window-height ()
  "Change the height of the selected window to suit the current buffer list."
  (unless (one-window-p t)
707
    (fit-window-to-buffer (selected-window) bs-max-window-height)))
Gerd Moellmann's avatar
Gerd Moellmann committed
708 709 710

(defun bs--current-buffer ()
  "Return buffer on current line.
711
Raise an error if not on a buffer line."
Gerd Moellmann's avatar
Gerd Moellmann committed
712 713
  (beginning-of-line)
  (let ((line (+ (- bs-header-lines-length)
Dave Love's avatar
Dave Love committed
714
		 (count-lines 1 (point)))))
715 716
    (when (< line 0)
      (error "You are on a header row"))
Gerd Moellmann's avatar
Gerd Moellmann committed
717 718 719 720 721
    (nth line bs-current-list)))

(defun bs--update-current-line ()
  "Update the entry on current line for Buffer Selection Menu."
  (let ((buffer (bs--current-buffer))
Dave Love's avatar
Dave Love committed
722
	(inhibit-read-only t))
Gerd Moellmann's avatar
Gerd Moellmann committed
723 724 725 726 727 728 729 730 731 732 733 734 735 736
    (beginning-of-line)
    (delete-region (point) (line-end-position))
    (bs--insert-one-entry buffer)
    (beginning-of-line)))

(defun bs-view ()
  "View current line's buffer in View mode.
Leave Buffer Selection Menu."
  (interactive)
  (view-buffer (bs--current-buffer)))

(defun bs-select ()
  "Select current line's buffer and other marked buffers.
If there are no marked buffers the window configuration before starting
737
Buffer Selection Menu will be restored.
Gerd Moellmann's avatar
Gerd Moellmann committed
738 739 740 741 742 743
If there are marked buffers each marked buffer and the current line's buffer
will be selected in a window.
Leave Buffer Selection Menu."
  (interactive)
  (let ((buffer (bs--current-buffer)))
    (bury-buffer (current-buffer))
744
    (bs--restore-window-config)
Gerd Moellmann's avatar
Gerd Moellmann committed
745
    (switch-to-buffer buffer)
746 747 748 749 750 751 752 753 754 755 756 757
    (when bs--marked-buffers
      ;; Some marked buffers for selection
      (let* ((all (delq buffer bs--marked-buffers))
	     (height (/ (1- (frame-height)) (1+ (length all)))))
	(delete-other-windows)
	(switch-to-buffer buffer)
	(dolist (buf all)
	  (split-window nil height)
	  (other-window 1)
	  (switch-to-buffer buf))
	;; goto window we have started bs.
	(other-window 1)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
758 759 760

(defun bs-select-other-window ()
  "Select current line's buffer by `switch-to-buffer-other-window'.
761
The window configuration before starting Buffer Selection Menu will be restored
Gerd Moellmann's avatar
Gerd Moellmann committed
762 763 764 765 766
unless there is no other window.  In this case a new window will be created.
Leave Buffer Selection Menu."
  (interactive)
  (let ((buffer (bs--current-buffer)))
    (bury-buffer (current-buffer))
767
    (bs--restore-window-config)
Gerd Moellmann's avatar
Gerd Moellmann committed
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
    (switch-to-buffer-other-window buffer)))

(defun bs-tmp-select-other-window ()
  "Make the other window select this line's buffer.
The current window remains selected."
  (interactive)
  (let ((buffer (bs--current-buffer)))
    (display-buffer buffer t)))

(defun bs-select-other-frame ()
  "Select current line's buffer in new created frame.
Leave Buffer Selection Menu."
  (interactive)
  (let ((buffer (bs--current-buffer)))
    (bury-buffer (current-buffer))
783
    (bs--restore-window-config)
Gerd Moellmann's avatar
Gerd Moellmann committed
784 785 786 787 788
    (switch-to-buffer-other-frame buffer)))

(defun bs-mouse-select-other-frame (event)
  "Select selected line's buffer in new created frame.
Leave Buffer Selection Menu.
789
EVENT: a mouse click event."
Gerd Moellmann's avatar
Gerd Moellmann committed
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
  (interactive "e")
  (mouse-set-point event)
  (bs-select-other-frame))

(defun bs-mouse-select (event)
  "Select buffer on mouse click EVENT.
Select buffer by `bs-select'."
  (interactive "e")
  (mouse-set-point event)
  (bs-select))

(defun bs-select-in-one-window ()
  "Select current line's buffer in one window and delete other windows.
Leave Buffer Selection Menu."
  (interactive)
  (bs-select)
  (delete-other-windows))

(defun bs-bury-buffer ()
  "Bury buffer on current line."
  (interactive)
  (bury-buffer (bs--current-buffer))
  (bs--redisplay t))

(defun bs-save ()
  "Save buffer on current line."
  (interactive)
817
  (with-current-buffer (bs--current-buffer)
Stefan Monnier's avatar
Stefan Monnier committed
818 819
    (save-buffer))
  (bs--update-current-line))
Gerd Moellmann's avatar
Gerd Moellmann committed
820 821 822 823 824 825 826

(defun bs-visit-tags-table ()
  "Visit the tags table in the buffer on this line.
See `visit-tags-table'."
  (interactive)
  (let ((file (buffer-file-name (bs--current-buffer))))
    (if file
Dave Love's avatar
Dave Love committed
827
	(visit-tags-table file)
Gerd Moellmann's avatar
Gerd Moellmann committed
828 829 830 831 832
      (error "Specified buffer has no file"))))

(defun bs-toggle-current-to-show ()
  "Toggle status of showing flag for buffer in current line."
  (interactive)
833 834
  (let ((res
         (with-current-buffer (bs--current-buffer)
Stefan Monnier's avatar
Stefan Monnier committed
835
           (setq bs-buffer-show-mark (pcase bs-buffer-show-mark
836 837
                                       ('nil   'never)
                                       ('never 'always)
Stefan Monnier's avatar
Stefan Monnier committed
838
                                       (_       nil))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
    (bs--update-current-line)
    (bs--set-window-height)
    (bs--show-config-message res)))

(defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
  "Toggle status of buffer on line to `always shown'.
NOT-TO-SHOW-P: prefix argument.
With no prefix argument the buffer on current line is marked to show
always.  Otherwise it is marked to show never."
  (interactive "P")
  (if not-to-show-p
      (bs-set-current-buffer-to-show-never)
    (bs--set-toggle-to-show (bs--current-buffer) 'always)))

(defun bs-set-current-buffer-to-show-never ()
  "Toggle status of buffer on line to `never shown'."
  (interactive)
  (bs--set-toggle-to-show (bs--current-buffer) 'never))

(defun bs--set-toggle-to-show (buffer what)
  "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
Redisplay current line and display a message describing
the status of buffer on current line."
862
  (with-current-buffer buffer (setq bs-buffer-show-mark what))
Gerd Moellmann's avatar
Gerd Moellmann committed
863 864 865 866
  (bs--update-current-line)
  (bs--set-window-height)
  (bs--show-config-message what))

867 868 869
(defun bs--mark-unmark (count fun)
  "Call FUN on COUNT consecutive buffers of *buffer-selection*."
  (let ((dir (if (> count 0) 1 -1)))
870
    (dotimes (_i (abs count))
871 872 873 874 875
      (let ((buffer (bs--current-buffer)))
	(when buffer (funcall fun buffer))
	(bs--update-current-line)
	(bs-down dir)))))

Gerd Moellmann's avatar
Gerd Moellmann committed
876 877 878
(defun bs-mark-current (count)
  "Mark buffers.
COUNT is the number of buffers to mark.
879
Move point vertically down COUNT lines."
Gerd Moellmann's avatar
Gerd Moellmann committed
880
  (interactive "p")
881 882 883
  (bs--mark-unmark count
		   (lambda (buf)
		     (add-to-list 'bs--marked-buffers buf))))
Gerd Moellmann's avatar
Gerd Moellmann committed
884 885 886 887

(defun bs-unmark-current (count)
  "Unmark buffers.
COUNT is the number of buffers to unmark.
888
Move point vertically down COUNT lines."
Gerd Moellmann's avatar
Gerd Moellmann committed
889
  (interactive "p")
890 891 892
  (bs--mark-unmark count
		   (lambda (buf)
		     (setq bs--marked-buffers (delq buf bs--marked-buffers)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
893

894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
(defun bs-unmark-previous (count)
  "Unmark previous COUNT buffers.
Move point vertically up COUNT lines.
When called interactively a numeric prefix argument sets COUNT."
  (interactive "p")
  (forward-line (- count))
  (save-excursion (bs-unmark-current count)))

(defun bs-unmark-all ()
  "Unmark all buffers."
  (interactive)
  (let ((marked (string-to-char bs-string-marked))
        (current (string-to-char bs-string-current))
        (marked-cur (string-to-char bs-string-current-marked))
        (unmarked (string-to-char bs-string-show-normally))
        (inhibit-read-only t))
    (save-excursion
      (goto-char (point-min))
      (forward-line 2)
      (while (not (eobp))
        (if (eq (char-after) marked)
            (subst-char-in-region (point) (1+ (point)) marked unmarked)
          (when (eq (char-after) marked-cur)
            (subst-char-in-region (point) (1+ (point)) marked-cur current)))
        (forward-line 1))
      (setq bs--marked-buffers nil))))

Gerd Moellmann's avatar
Gerd Moellmann committed
921 922 923 924
(defun bs--show-config-message (what)
  "Show message indicating the new showing status WHAT.
WHAT is a value of nil, `never', or `always'."
  (bs-message-without-log (cond ((null what)
Dave Love's avatar
Dave Love committed
925 926 927 928
				 "Buffer will be shown normally.")
				((eq what 'never)
				 "Mark buffer to never be shown.")
				(t "Mark buffer to show always."))))
Gerd Moellmann's avatar
Gerd Moellmann committed
929 930 931 932 933

(defun bs-delete ()
  "Kill buffer on current line."
  (interactive)
  (let ((current (bs--current-buffer))
Dave Love's avatar
Dave Love committed
934
	(inhibit-read-only t))
935 936
    (unless (kill-buffer current)
      (error "Buffer was not deleted"))
Gerd Moellmann's avatar
Gerd Moellmann committed
937 938 939
    (setq bs-current-list (delq current bs-current-list))
    (beginning-of-line)
    (delete-region (point) (save-excursion
Dave Love's avatar
Dave Love committed
940 941
			     (end-of-line)
			     (if (eobp) (point) (1+ (point)))))
942 943 944 945
    (when (eobp)
      (backward-delete-char 1)
      (beginning-of-line)
      (recenter -1))
Gerd Moellmann's avatar
Gerd Moellmann committed
946 947 948 949 950 951 952 953
    (bs--set-window-height)))

(defun bs-delete-backward ()
  "Like `bs-delete' but go to buffer in front of current."
  (interactive)
  (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
    (bs-delete)
    (unless on-last-line-p
Dave Love's avatar
Dave Love committed
954
      (bs-up 1))))
Gerd Moellmann's avatar
Gerd Moellmann committed
955 956

(defun bs-show-sorted ()
957
  "Show buffer list sorted by next sort aspect."
Gerd Moellmann's avatar
Gerd Moellmann committed
958 959
  (interactive)
  (setq bs--current-sort-function
Dave Love's avatar
Dave Love committed
960 961
	(bs-next-config-aux (car bs--current-sort-function)
			    bs-sort-functions))
Gerd Moellmann's avatar
Gerd Moellmann committed
962 963 964 965 966 967 968 969 970
  (bs--redisplay)
  (bs--goto-current-buffer)
  (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))

(defun bs-apply-sort-faces (&optional sort-description)
  "Set text properties for the sort described by SORT-DESCRIPTION.
SORT-DESCRIPTION is an element of `bs-sort-functions'.
Default is `bs--current-sort-function'."
  (let ((sort-description (or sort-description
Dave Love's avatar
Dave Love committed
971
			      bs--current-sort-function)))
Gerd Moellmann's avatar
Gerd Moellmann committed
972 973
    (save-excursion
      (goto-char (point-min))
974 975 976 977 978 979 980 981
      (when (and (nth 2 sort-description)
		 (search-forward-regexp (nth 2 sort-description) nil t))
	(let ((inhibit-read-only t))
	  (put-text-property (match-beginning 0)
			     (match-end 0)
			     'face
			     (or (nth 3 sort-description)
				 'region)))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
982 983 984 985 986 987 988 989 990 991 992

(defun bs-toggle-show-all ()
  "Toggle show all buffers / show buffers with current configuration."
  (interactive)
  (setq bs--show-all (not bs--show-all))
  (bs--redisplay)
  (bs--goto-current-buffer)
  (bs-message-without-log "%s" (bs--current-config-message)))

(defun bs-toggle-readonly ()
  "Toggle read-only status for buffer on current line.
993
Uses function `read-only-mode'."
Gerd Moellmann's avatar
Gerd Moellmann committed
994
  (interactive)
995
  (with-current-buffer (bs--current-buffer)
996
    (read-only-mode 'toggle))
997
  (bs--update-current-line))
Gerd Moellmann's avatar
Gerd Moellmann committed
998 999 1000 1001

(defun bs-clear-modified ()
  "Set modified flag for buffer on current line to nil."
  (interactive)
1002 1003
  (with-current-buffer (bs--current-buffer)
    (set-buffer-modified-p nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
1004 1005 1006 1007
  (bs--update-current-line))

(defun bs--nth-wrapper (count fun &rest args)
  "Call COUNT times function FUN with arguments ARGS."
1008
  (dotimes (_i (or count 1))
1009
    (apply fun args)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1010 1011

(defun bs-up (arg)
1012
  "Move point vertically up ARG lines in Buffer Selection Menu."
Gerd Moellmann's avatar
Gerd Moellmann committed
1013 1014 1015 1016 1017 1018
  (interactive "p")
  (if (and arg (numberp arg) (< arg 0))
      (bs--nth-wrapper (- arg) 'bs--down)
    (bs--nth-wrapper arg 'bs--up)))

(defun bs--up ()
1019
  "Move point vertically up one line.
Gerd Moellmann's avatar
Gerd Moellmann committed
1020
If on top of buffer list go to last line."
1021 1022 1023 1024 1025
  (if (> (count-lines 1 (point)) bs-header-lines-length)
      (forward-line -1)
    (goto-char (point-max))
    (beginning-of-line)
    (recenter -1)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1026 1027

(defun bs-down (arg)
1028
  "Move point vertically down ARG lines in Buffer Selection Menu."
Gerd Moellmann's avatar
Gerd Moellmann committed
1029 1030 1031 1032 1033 1034
  (interactive "p")
  (if (and arg (numberp arg) (< arg 0))
      (bs--nth-wrapper (- arg) 'bs--up)
    (bs--nth-wrapper arg 'bs--down)))

(defun bs--down ()
1035
  "Move point vertically down one line.
Gerd Moellmann's avatar
Gerd Moellmann committed
1036
If at end of buffer list go to first line."
1037
  (if (eq (line-end-position) (point-max))
1038
      (progn
Juanma Barranquero's avatar
Juanma Barranquero committed
1039
	(goto-char (point-min))
1040
	(forward-line bs-header-lines-length))
1041
    (forward-line 1)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1042 1043

(defun bs-visits-non-file (buffer)
1044
  "Return whether BUFFER visits no file.
Gerd Moellmann's avatar
Gerd Moellmann committed
1045 1046 1047 1048
A value of t means BUFFER belongs to no file.
A value of nil means BUFFER belongs to a file."
  (not (buffer-file-name buffer)))

1049
(defun bs-sort-buffer-interns-are-last (_b1 b2)
1050
  "Function for sorting internal buffers at the end of all buffers."
1051
  (string-match-p "^\\*" (buffer-name b2)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1052 1053 1054 1055 1056 1057

;; ----------------------------------------------------------------------
;; Configurations:
;; ----------------------------------------------------------------------

(defun bs-config-clear ()
1058
  "Reset all variables which specify a configuration.
Gerd Moellmann's avatar
Gerd Moellmann committed
1059 1060 1061 1062
These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
`bs-dont-show-function', `bs-must-show-function' and
`bs-buffer-sort-function'."
  (setq bs-dont-show-regexp nil
Dave Love's avatar
Dave Love committed
1063 1064 1065 1066
	bs-must-show-regexp nil
	bs-dont-show-function nil
	bs-must-show-function nil
	bs-buffer-sort-function nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
1067 1068 1069 1070

(defun bs-config--only-files ()
  "Define a configuration for showing only buffers visiting a file."
  (bs-config-clear)
1071
  (setq ;; I want to see *-buffers at the end
Dave Love's avatar
Dave Love committed
1072 1073 1074
   bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
   ;; Don't show files who don't belong to a file
   bs-dont-show-function 'bs-visits-non-file))
Gerd Moellmann's avatar
Gerd Moellmann committed
1075 1076 1077 1078

(defun bs-config--files-and-scratch ()
  "Define a configuration for showing buffer *scratch* and file buffers."
  (bs-config-clear)
1079
  (setq ;; I want to see *-buffers at the end
Dave Love's avatar
Dave Love committed
1080 1081 1082 1083
   bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
   ;; Don't show files who don't belong to a file
   bs-dont-show-function 'bs-visits-non-file
   ;; Show *scratch* buffer.
1084
   bs-must-show-regexp "^\\*scratch\\*$"))
Gerd Moellmann's avatar
Gerd Moellmann committed
1085 1086 1087 1088 1089 1090 1091 1092

(defun bs-config--all ()
  "Define a configuration for showing all buffers.
Reset all according variables by `bs-config-clear'."
  (bs-config-clear))

(defun bs-config--all-intern-last ()
  "Define a configuration for showing all buffers.
1093
Internal buffers appear at end of all buffers."
Gerd Moellmann's avatar
Gerd Moellmann committed
1094 1095 1096 1097 1098 1099 1100 1101 1102
  (bs-config-clear)
  ;; I want to see *-buffers at the end
  (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))

(defun bs-set-configuration (name)
  "Set configuration to the one saved under string NAME in `bs-configurations'.
When called interactively ask user for a configuration and apply selected
configuration."
  (interactive (list (completing-read "Use configuration: "
Dave Love's avatar
Dave Love committed
1103 1104 1105
				      bs-configurations
				      nil
				      t)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1106 1107
  (let ((list (assoc name bs-configurations)))
    (if list
Dave Love's avatar
Dave Love committed
1108 1109 1110 1111 1112 1113 1114
	(if (listp list)
	    (setq bs-current-configuration name
		  bs-must-show-regexp     (nth 1 list)
		  bs-must-show-function   (nth 2 list)
		  bs-dont-show-regexp     (nth 3 list)
		  bs-dont-show-function   (nth 4 list)
		  bs-buffer-sort-function (nth 5 list))
Juanma Barranquero's avatar
Juanma Barranquero committed
1115
	  ;; for backward compatibility
Dave Love's avatar
Dave Love committed
1116
	  (funcall (cdr list)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
      ;; else
      (ding)
      (bs-message-without-log "No bs-configuration named %S." name))))

(defun bs-help ()
  "Help for `bs-show'."
  (interactive)
  (describe-function 'bs-mode))

(defun bs-next-config-aux (start-name list)
  "Get the next assoc after START-NAME in list LIST.
Will return the first if START-NAME is at end."
  (let ((assocs list)
Dave Love's avatar
Dave Love committed
1130 1131
	(length (length list))
	pos)
Gerd Moellmann's avatar
Gerd Moellmann committed
1132
    (while (and assocs (not pos))
1133 1134
      (when (string= (car (car assocs)) start-name)
	(setq pos (- length (length assocs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1135 1136 1137
      (setq assocs (cdr assocs)))
    (setq pos (1+ pos))
    (if (eq pos length)
Dave Love's avatar
Dave Love committed
1138
	(car list)
Gerd Moellmann's avatar
Gerd Moellmann committed
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
      (nth pos list))))