delete-selection-mode
[emacs.git] / lisp / bs.el
blob48779cb98e56b42592b2f0d2f67636b2119e2bca
1 ;;; bs.el --- menu for selecting and displaying buffers
3 ;; Copyright (C) 1998, 1999 Free Software Foundation, Inc.
4 ;; Author: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
5 ;; Maintainer: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
6 ;; Keywords: convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; 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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; Version: 1.17
28 ;; X-URL: http://home.netsurf.de/olaf.sylvester/emacs
30 ;; The bs-package contains a main function bs-show for poping up a
31 ;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
32 ;; The new buffer offers a Buffer Selection Menu for manipulating
33 ;; the buffer list and buffers.
35 ;; -----------------------------------------------------------------------
36 ;; | MR Buffer Size Mode File |
37 ;; | -- ------ ---- ---- ---- |
38 ;; |. bs.el 14690 Emacs-Lisp /home/sun/sylvester/el/bs.e$|
39 ;; | % executable.el 9429 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
40 ;; | % vc.el 104893 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
41 ;; | % test_vc.el 486 Emacs-Lisp /home/sun/sylvester/el/test$|
42 ;; | % vc-hooks.el 43605 Emacs-Lisp /usr/share/emacs/19.34/lisp$|
43 ;; -----------------------------------------------------------------------
45 ;;; Quick Installation und Customization:
47 ;; Use
48 ;; M-x bs-show
49 ;; for buffer selection or optional bind a key to main function `bs-show'
50 ;; (global-set-key "\C-x\C-b" 'bs-show) ;; or another key
52 ;; For customization use
53 ;; M-x bs-customize
56 ;;; More Commentary:
58 ;; bs-show will generate a new buffer named *buffer-selection*, which shows
59 ;; all buffers or a subset of them, and has possibilities for deleting,
60 ;; saving and selecting buffers. For more details see docstring of
61 ;; function `bs-mode'. A current configuration describes which buffers appear
62 ;; in *buffer-selection*. See docstring of variable `bs-configurations' for
63 ;; more details.
65 ;; The package bs combines the advantages of the Emacs functions
66 ;; `list-buffers' and `electric-buffer-list'.
68 ;; Additioal features for Buffer Selection Menu:
69 ;; - configurable list of buffers (show only files etc.).
70 ;; - comfortable way to change displayed subset of all buffers.
71 ;; - show sorted list of buffers.
72 ;; - cyclic navigation:
73 ;; - goes to top of buffer list if you are on last line and press down.
74 ;; - goes to end of buffer list if you are on first line and press up.
75 ;; - Offer an alternative buffer list by prefix key C-u.
77 ;;; Cycling through buffers
79 ;; This package offers two functions for buffer cycling. If you want to cycle
80 ;; through buffer list you can use `bs-cycle-next' or `bs-cycle-previous'.
81 ;; Bind these function to a key like
82 ;; (global-set-key [(f9)] 'bs-cycle-previous)
83 ;; (global-set-key [(f10)] 'bs-cycle-next)
85 ;; Both functions use a special subset of all buffers for cycling to avoid
86 ;; to go through internal buffers like *Messages*.
88 ;; Cycling through buffers ignores sorting because sorting destroys
89 ;; the logical buffer list. If buffer list is sorted by size you
90 ;; won't be able to cycle to the smallest buffer.
92 ;;; Customization:
94 ;; There is a customization group called `bs' in group `convenience'.
95 ;; Start customization by M-x bs-customize
97 ;; Buffer list
98 ;; -----------
99 ;; You can define your own configurations by extending variable
100 ;; `bs-configurations' (see docstring for details).
102 ;; `bs-default-configuration' contains the name of default configuration.
103 ;; The default value is "files" which means to show only files.
105 ;; If you always want to see all buffers, customize variable
106 ;; `bs-default-configuration' in customization group `bs'.
108 ;; Configure sorting
109 ;; -----------------
110 ;; You can define functions for sorting the buffer list.
111 ;; When selecting buffers, you can step through available sorting
112 ;; methods with key 'S'.
113 ;; To define a new way of sorting, customize variable `bs-sort-functions'.
115 ;; There are four basic functions for sorting:
116 ;; by buffer name, by mode, by size, or by filename
118 ;; Configure buffer cycling
119 ;; ------------------------
120 ;; When cycling through buffer list the functions for cycling will use
121 ;; the current configuration of bs to calculate the buffer list.
122 ;; If you want to use a different configuration for cycling you have to set
123 ;; the variable `bs-cycle-configuration-name'. You can customize this variable.
125 ;; For example: If you use the configuration called "files-and-scratch" you
126 ;; can cycle through all file buffers and *scratch* although your current
127 ;; configuration perhaps is "files" which ignores buffer *scratch*.
129 ;;; History:
131 ;;; Code:
133 ;; ----------------------------------------------------------------------
134 ;; Globals for customization
135 ;; ----------------------------------------------------------------------
137 (defgroup bs nil
138 "Buffer Selection: Maintaining buffers by buffer menu."
139 :version "21.1"
140 :link '(emacs-commentary-link "bs")
141 :link '(url-link "http://home.netsurf.de/olaf.sylvester/emacs")
142 :group 'convenience)
144 (defgroup bs-appearence nil
145 "Buffer Selection appearence: Appearence of bs buffer menu."
146 :group 'bs)
148 (defcustom bs-attributes-list
149 '(("" 1 1 left bs--get-marked-string)
150 ("M" 1 1 left bs--get-modified-string)
151 ("R" 2 2 left bs--get-readonly-string)
152 ("Buffer" bs--get-name-length 10 left bs--get-name)
153 ("" 1 1 left " ")
154 ("Size" 8 8 right bs--get-size-string)
155 ("" 1 1 left " ")
156 ("Mode" 12 12 right bs--get-mode-name)
157 ("" 2 2 left " ")
158 ("File" 12 12 left bs--get-file-name)
159 ("" 2 2 left " "))
160 "*List specifying the layout of a Buffer Selection Menu buffer.
161 Each entry specifies a column and is a list of the form of:
162 (HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING)
163 HEADER : string for header for first line or a function
164 which calculates column title.
165 MINIMUM-LENGTH : minimum width of column (number or name of function).
166 The function must return a positive integer.
167 MAXIMUM-LENGTH : maximum width of column (number or name of function)
168 (currently ignored)
169 ALIGNMENT : alignment of column: (`left' `right' `middle')
170 FUN-OR-STRING : Name of a function for calculating the value or
171 a string for a constant value.
172 The function gets as parameter the buffer we have started
173 buffer selection and the list of all buffers to show. The function must
174 return a string representing the columns value."
175 :group 'bs-appearence
176 :type '(repeat sexp))
178 (defvar bs--running-in-xemacs (string-match "XEmacs" (emacs-version))
179 "Non-nil when running under XEmacs.")
182 (defun bs--make-header-match-string ()
183 "Return a regexp matching the first line of a Buffer Selection Menu buffer."
184 (let ((res "^\\(")
185 (ele bs-attributes-list))
186 (while ele
187 (setq res (concat res (car (car ele)) " *"))
188 (setq ele (cdr ele)))
189 (concat res "$\\)")))
191 ;;; Font-Lock-Settings
192 (defvar bs-mode-font-lock-keywords
193 (list;; header in font-lock-type-face
194 (list (bs--make-header-match-string)
195 '(1 font-lock-type-face append) '(1 'bold append))
196 ;; Buffername embedded by *
197 (list "^\\(.*\\*.*\\*.*\\)$"
198 1 (if bs--running-in-xemacs
199 ;; problem in XEmacs with font-lock-constant-face
200 (if (facep 'font-lock-constant-face)
201 'font-lock-constant-face
202 'font-lock-comment-face)
203 'font-lock-constant-face))
204 ;; Dired-Buffers
205 '("^..\\(.*Dired by .*\\)$" 1 font-lock-function-name-face)
206 ;; the star for modified buffers
207 '("^.\\(\\*\\) +[^\\*]" 1 font-lock-comment-face))
208 "Default font lock expressions for Buffer Selection Menu.")
210 (defcustom bs-max-window-height 20
211 "*Maximal window height of Buffer Selection Menu."
212 :group 'bs-appearence
213 :type 'integer)
215 (defvar bs-dont-show-regexp nil
216 "Regular expression specifying which buffers not to show.
217 A buffer whose name matches this regular expression will not be
218 included in the buffer list.")
220 (defvar bs-must-show-regexp nil
221 "Regular expression for specifying buffers which must be shown.
222 A buffer whose name matches this regular expression will be
223 included in the buffer list.
224 Note that this variable is temporary: if the configuration is changed
225 it is reset to nil. Use `bs-must-always-show-regexp' to specify buffers
226 that must always be shown regardless of the configuration.")
228 (defcustom bs-must-always-show-regexp nil
229 "*Regular expression for specifying buffers to show always.
230 A buffer whose name matches this regular expression will
231 be shown regardless of current configuration of Buffer Selection Menu."
232 :group 'bs
233 :type '(choice (const :tag "Nothing at all" nil) regexp))
235 (defvar bs-dont-show-function nil
236 "Function for specifying buffers not to show.
237 The function gets one argument - the buffer to test. The function must
238 return a value different from nil to ignore the buffer in
239 Buffer Selection Menu.")
241 (defvar bs-must-show-function nil
242 "Function for specifying buffers which must be shown.
243 The function gets one argument - the buffer to test.")
245 (defvar bs-buffer-sort-function nil
246 "Sort function to sort the buffers that appear in Buffer Selection Menu.
247 The functions gets two arguments - the buffers to compare.")
249 (defcustom bs-maximal-buffer-name-column 45
250 "*Maximum column width for buffer names.
251 The column for buffer names has dynamic width. The width depends on
252 maximal and minimal length of names of buffers to show. The maximal
253 width is bounded by `bs-maximal-buffer-name-column'.
254 See also `bs-minimal-buffer-name-column'."
255 :group 'bs-appearence
256 :type 'integer)
258 (defcustom bs-minimal-buffer-name-column 15
259 "*Minimum column width for buffer names.
260 The column for buffer names has dynamic width. The width depends on
261 maximal and minimal length of names of buffers to show. The minimal
262 width is bounded by `bs-minimal-buffer-name-column'.
263 See also `bs-maximal-buffer-name-column'."
264 :group 'bs-appearence
265 :type 'integer)
267 (defconst bs-header-lines-length 2
268 "Number of lines for headers in Buffer Selection Menu.")
270 (defcustom bs-configurations
271 '(("all" nil nil nil nil nil)
272 ("files" nil nil nil bs-visits-non-file bs-sort-buffer-interns-are-last)
273 ("files-and-scratch" "^\\*scratch\\*" nil nil bs-visits-non-file
274 bs-sort-buffer-interns-are-last)
275 ("all-intern-last" nil nil nil nil bs-sort-buffer-interns-are-last))
276 "*List of all configurations you can use in the Buffer Selection Menu.
277 A configuration describes which buffers appear in Buffer Selection Menu
278 and describes the order of buffers. A configuration is a list with
279 six elements. The first element is a string and describes the configuration.
280 The following five elements represent the values for Buffer Selection Menu
281 configurations variables `bs-dont-show-regexp', `bs-dont-show-function',
282 `bs-must-show-regexp', `bs-must-show-function' and `bs-buffer-sort-function'.
283 By setting these variables you define a configuration."
284 :group 'bs-appearence
285 :type '(repeat sexp))
287 (defcustom bs-default-configuration "files"
288 "*Name of default configuration used by in the Buffer Selection Menu.
289 \\<bs-mode-map>
290 Will be changed using key \\[bs-select-next-configuration].
291 Must be a string used in `bs-configurations' for naming a configuration."
292 :group 'bs
293 :type 'string)
295 (defcustom bs-alternative-configuration "all"
296 "*Name of configuration used when calling `bs-show' with \
297 \\[universal-argument] as prefix key.
298 Must be a string used in `bs-configurations' for naming a configuration."
299 :group 'bs
300 :type 'string)
302 (defvar bs-current-configuration bs-default-configuration
303 "Name of current configuration.
304 Must be a string found in `bs-configurations' for naming a configuration.")
306 (defcustom bs-cycle-configuration-name nil
307 "*Name of configuration used when cycling through the buffer list.
308 A value of nil means to use current configuration `bs-default-configuration'.
309 Must be a string used in `bs-configurations' for naming a configuration."
310 :group 'bs
311 :type '(choice (const :tag "like current configuration" nil)
312 string))
314 (defcustom bs-string-show-always "+"
315 "*String added in column 1 indicating a buffer will always be shown."
316 :group 'bs-appearence
317 :type 'string)
319 (defcustom bs-string-show-never "-"
320 "*String added in column 1 indicating a buffer will never be shown."
321 :group 'bs-appearence
322 :type 'string)
324 (defcustom bs-string-current "."
325 "*String added in column 1 indicating the current buffer."
326 :group 'bs-appearence
327 :type 'string)
329 (defcustom bs-string-current-marked "#"
330 "*String added in column 1 indicating the current buffer when it is marked."
331 :group 'bs-appearence
332 :type 'string)
334 (defcustom bs-string-marked ">"
335 "*String added in column 1 indicating a marked buffer."
336 :group 'bs-appearence
337 :type 'string)
339 (defcustom bs-string-show-normally " "
340 "*String added in column 1 indicating a unmarked buffer."
341 :group 'bs-appearence
342 :type 'string)
344 (defvar bs--name-entry-length 20
345 "Maximum length of all displayed buffer names.
346 Used internally, only.")
348 ;; ----------------------------------------------------------------------
349 ;; Intern globals
350 ;; ----------------------------------------------------------------------
352 (defvar bs-buffer-show-mark nil
353 "Flag for the current mode for showing this buffer.
354 A value of nil means buffer will be shown depending on the current on
355 current configuration.
356 A value of `never' means to never show the buffer.
357 A value of `always' means to show buffer regardless of the configuration.")
359 (make-variable-buffer-local 'bs-buffer-show-mark)
361 ;; Make face named region (for XEmacs)
362 (unless (facep 'region)
363 (make-face 'region)
364 (set-face-background 'region "gray75"))
367 (defun bs--sort-by-name (b1 b2)
368 "Compare buffers B1 and B2 by buffer name."
369 (string< (buffer-name b1)
370 (buffer-name b2)))
372 (defun bs--sort-by-filename (b1 b2)
373 "Compare buffers B1 and B2 by file name."
374 (string< (or (buffer-file-name b1) "")
375 (or (buffer-file-name b2) "")))
377 (defun bs--sort-by-mode (b1 b2)
378 "Compare buffers B1 and B2 by mode name."
379 (save-excursion
380 (string< (progn (set-buffer b1) (format "%s" mode-name))
381 (progn (set-buffer b2) (format "%s" mode-name)))))
383 (defun bs--sort-by-size (b1 b2)
384 "Compare buffers B1 and B2 by buffer size."
385 (save-excursion
386 (< (progn (set-buffer b1) (buffer-size))
387 (progn (set-buffer b2) (buffer-size)))))
389 (defcustom bs-sort-functions
390 '(("by name" bs--sort-by-name "Buffer" region)
391 ("by size" bs--sort-by-size "Size" region)
392 ("by mode" bs--sort-by-mode "Mode" region)
393 ("by filename" bs--sort-by-filename "File" region)
394 ("by nothing" nil nil nil))
395 "*List of all possible sorting aspects for Buffer Selection Menu.
396 You can add a new entry with a call to `bs-define-sort-function'.
397 Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE)
398 NAME specifies the sort order defined by function FUNCTION.
399 FUNCTION nil means don't sort the buffer list. Otherwise the functions
400 must have two parameters - the buffers to compare.
401 REGEXP-FOR-SORTING is a regular expression which describes the
402 column title to highlight.
403 FACE is a face used to fontify the sorted column title. A value of nil means
404 don't highlight."
405 :group 'bs
406 :type '(repeat sexp))
408 (defun bs-define-sort-function (name fun &optional regexp-for-sorting face)
409 "Define a new function for buffer sorting in Buffer Selection Menu.
410 NAME specifies the sort order defined by function FUN.
411 A value of nil for FUN means don't sort the buffer list. Otherwise the
412 functions must have two parameters - the buffers to compare.
413 REGEXP-FOR-SORTING is a regular expression which describes the
414 column title to highlight.
415 FACE is a face used to fontify the sorted column title. A value of nil means
416 don't highlight.
417 The new sort aspect will be inserted into list `bs-sort-functions'."
418 (let ((tupel (assoc name bs-sort-functions)))
419 (if tupel
420 (setcdr tupel (list fun regexp-for-sorting face))
421 (setq bs-sort-functions
422 (cons (list name fun regexp-for-sorting face)
423 bs-sort-functions)))))
425 (defvar bs--current-sort-function nil
426 "Description of the current function for sorting the buffer list.
427 This is an element of `bs-sort-functions'.")
429 (defcustom bs-default-sort-name "by nothing"
430 "*Name of default sort behavior.
431 Must be \"by nothing\" or a string used in `bs-sort-functions' for
432 naming a sort behavior. Default is \"by nothing\" which means no sorting."
433 :group 'bs
434 :type 'string
435 :set (lambda (var-name value)
436 (set var-name value)
437 (setq bs--current-sort-function
438 (assoc value bs-sort-functions))))
440 (defvar bs--buffer-coming-from nil
441 "The buffer in which the user started the current Buffer Selection Menu.")
443 (defvar bs--show-all nil
444 "Flag whether showing all buffers regardless of current configuration.
445 Non nil means to show all buffers. Otherwise show buffers
446 defined by current configuration `bs-current-configuration'.")
448 (defvar bs--window-config-coming-from nil
449 "Window configuration before starting Buffer Selection Menu.")
451 (defvar bs--intern-show-never "^ \\|\\*buffer-selection\\*"
452 "Regular expression specifying which buffers never to show.
453 A buffer whose name matches this regular expression will never be
454 included in the buffer list.")
456 (defvar bs-current-list nil
457 "List of buffers shown in Buffer Selection Menu.
458 Used internally, only.")
460 (defvar bs--marked-buffers nil
461 "Currently marked buffers in Buffer Selection Menu.")
463 (defvar bs-mode-map ()
464 "Keymap of `bs-mode'.")
466 (if bs-mode-map
468 (setq bs-mode-map (make-sparse-keymap))
469 (define-key bs-mode-map " " 'bs-select)
470 (define-key bs-mode-map "f" 'bs-select)
471 (define-key bs-mode-map "v" 'bs-view)
472 (define-key bs-mode-map "!" 'bs-select-in-one-window)
473 (define-key bs-mode-map [mouse-2] 'bs-mouse-select) ;; for GNU EMACS
474 (define-key bs-mode-map [button2] 'bs-mouse-select) ;; for XEmacs
475 (define-key bs-mode-map "F" 'bs-select-other-frame)
477 (let ((key ?1))
478 (while (<= key ?9)
479 (define-key bs-mode-map (char-to-string key) 'digit-argument)
480 (setq key (1+ key))))
482 (define-key bs-mode-map "-" 'negative-argument)
483 (define-key bs-mode-map "\e-" 'negative-argument)
485 (define-key bs-mode-map "o" 'bs-select-other-window)
486 (define-key bs-mode-map "\C-o" 'bs-tmp-select-other-window)
487 ;; for GNU EMACS
488 (define-key bs-mode-map [mouse-3] 'bs-mouse-select-other-frame)
489 ;; for XEmacs
490 (define-key bs-mode-map [button3] 'bs-mouse-select-other-frame)
491 (define-key bs-mode-map [up] 'bs-up)
492 (define-key bs-mode-map "n" 'bs-down)
493 (define-key bs-mode-map "p" 'bs-up)
494 (define-key bs-mode-map [down] 'bs-down)
495 (define-key bs-mode-map "\C-m" 'bs-select)
496 (define-key bs-mode-map "b" 'bs-bury-buffer)
497 (define-key bs-mode-map "s" 'bs-save)
498 (define-key bs-mode-map "S" 'bs-show-sorted)
499 (define-key bs-mode-map "a" 'bs-toggle-show-all)
500 (define-key bs-mode-map "d" 'bs-delete)
501 (define-key bs-mode-map "\C-d" 'bs-delete-backward)
502 (define-key bs-mode-map "k" 'bs-delete)
503 (define-key bs-mode-map "g" 'bs-refresh)
504 (define-key bs-mode-map "C" 'bs-set-configuration-and-refresh)
505 (define-key bs-mode-map "c" 'bs-select-next-configuration)
506 (define-key bs-mode-map "q" 'bs-kill)
507 ;; (define-key bs-mode-map "z" 'bs-kill)
508 (define-key bs-mode-map "\C-c\C-c" 'bs-kill)
509 (define-key bs-mode-map "\C-g" 'bs-abort)
510 (define-key bs-mode-map "\C-]" 'bs-abort)
511 (define-key bs-mode-map "%" 'bs-toggle-readonly)
512 (define-key bs-mode-map "~" 'bs-clear-modified)
513 (define-key bs-mode-map "M" 'bs-toggle-current-to-show)
514 (define-key bs-mode-map "+" 'bs-set-current-buffer-to-show-always)
515 ;;(define-key bs-mode-map "-" 'bs-set-current-buffer-to-show-never)
516 (define-key bs-mode-map "t" 'bs-visit-tags-table)
517 (define-key bs-mode-map "m" 'bs-mark-current)
518 (define-key bs-mode-map "u" 'bs-unmark-current)
519 (define-key bs-mode-map ">" 'scroll-right)
520 (define-key bs-mode-map "<" 'scroll-left)
521 (define-key bs-mode-map "\e\e" nil)
522 (define-key bs-mode-map "\e\e\e" 'bs-kill)
523 (define-key bs-mode-map [escape escape escape] 'bs-kill)
524 (define-key bs-mode-map "?" 'bs-help))
526 ;; ----------------------------------------------------------------------
527 ;; Functions
528 ;; ----------------------------------------------------------------------
530 (defun bs-buffer-list (&optional list sort-description)
531 "Return a list of buffers to be shown.
532 LIST is a list of buffers to test for appearence in Buffer Selection Menu.
533 The result list depends on the global variables `bs-dont-show-regexp',
534 `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function'
535 and `bs-buffer-sort-function'.
536 If SORT-DESCRIPTION isn't nil the list will be sorted by
537 a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'."
538 (setq sort-description (or sort-description bs--current-sort-function)
539 list (or list (buffer-list)))
540 (let ((result nil))
541 (while list
542 (let* ((buffername (buffer-name (car list)))
543 (int-show-never (string-match bs--intern-show-never buffername))
544 (ext-show-never (and bs-dont-show-regexp
545 (string-match bs-dont-show-regexp
546 buffername)))
547 (extern-must-show (or (and bs-must-always-show-regexp
548 (string-match
549 bs-must-always-show-regexp
550 buffername))
551 (and bs-must-show-regexp
552 (string-match bs-must-show-regexp
553 buffername))))
554 (extern-show-never-from-fun (and bs-dont-show-function
555 (funcall bs-dont-show-function
556 (car list))))
557 (extern-must-show-from-fun (and bs-must-show-function
558 (funcall bs-must-show-function
559 (car list))))
560 (show-flag (save-excursion
561 (set-buffer (car list))
562 bs-buffer-show-mark)))
563 (if (or (eq show-flag 'always)
564 (and (or bs--show-all (not (eq show-flag 'never)))
565 (not int-show-never)
566 (or bs--show-all
567 extern-must-show
568 extern-must-show-from-fun
569 (and (not ext-show-never)
570 (not extern-show-never-from-fun)))))
571 (setq result (cons (car list)
572 result)))
573 (setq list (cdr list))))
574 (setq result (reverse result))
575 ;; The current buffer which was the start point of bs should be an element
576 ;; of result list, so that we can leave with space and be back in the
577 ;; buffer we started bs-show.
578 (if (and bs--buffer-coming-from
579 (buffer-live-p bs--buffer-coming-from)
580 (not (memq bs--buffer-coming-from result)))
581 (setq result (cons bs--buffer-coming-from result)))
582 ;; sorting
583 (if (and sort-description
584 (nth 1 sort-description))
585 (setq result (sort result (nth 1 sort-description)))
586 ;; else standard sorting
587 (bs-buffer-sort result))))
589 (defun bs-buffer-sort (buffer-list)
590 "Sort buffers in BUFFER-LIST according to `bs-buffer-sort-function'."
591 (if bs-buffer-sort-function
592 (sort buffer-list bs-buffer-sort-function)
593 buffer-list))
595 (defun bs--redisplay (&optional keep-line-p sort-description)
596 "Redisplay whole Buffer Selection Menu.
597 If KEEP-LINE-P is non nil the point will stay on current line.
598 SORT-DESCRIPTION is an element of `bs-sort-functions'"
599 (let ((line (1+ (count-lines 1 (point)))))
600 (bs-show-in-buffer (bs-buffer-list nil sort-description))
601 (if keep-line-p
602 (goto-line line))
603 (beginning-of-line)))
605 (defun bs--goto-current-buffer ()
606 "Goto line which represents the current buffer;
607 actually the line which begins with character in `bs-string-current' or
608 `bs-string-current-marked'."
609 (let ((regexp (concat "^"
610 (regexp-quote bs-string-current)
611 "\\|^"
612 (regexp-quote bs-string-current-marked)))
613 point)
614 (save-excursion
615 (goto-char (point-min))
616 (if (search-forward-regexp regexp nil t)
617 (setq point (- (point) 1))))
618 (if point
619 (goto-char point))))
621 (defun bs--current-config-message ()
622 "Return a string describing the current `bs-mode' configuration."
623 (if bs--show-all
624 "Show all buffers."
625 (format "Show buffer by configuration %S"
626 bs-current-configuration)))
628 (defun bs-mode ()
629 "Major mode for editing a subset of Emacs' buffers.
630 \\<bs-mode-map>
631 Aside from two header lines each line describes one buffer.
632 Move to a line representing the buffer you want to edit and select
633 buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill].
634 There are many key commands similar to `Buffer-menu-mode' for
635 manipulating the buffer list and buffers.
636 For faster navigation each digit key is a digit argument.
638 \\[bs-select] or SPACE -- select current line's buffer and other marked buffers.
639 \\[bs-toggle-show-all] -- toggle between all buffers and a special subset.
640 \\[bs-select-other-window] -- select current line's buffer in other window.
641 \\[bs-tmp-select-other-window] -- make another window display that buffer and
642 remain in Buffer Selection Menu.
643 \\[bs-mouse-select] -- select current line's buffer and other marked buffers.
644 \\[bs-save] -- save current line's buffer immediatly.
645 \\[bs-delete] -- kill current line's buffer immediatly.
646 \\[bs-toggle-readonly] -- toggle read-only status of current line's buffer.
647 \\[bs-clear-modified] -- clear modified-flag on that buffer.
648 \\[bs-mark-current] -- mark current line's buffer to be displayed.
649 \\[bs-unmark-current] -- unmark current line's buffer to be displayed.
650 \\[bs-show-sorted] -- display buffer list sorted by next sort aspect.
651 \\[bs-set-configuration-and-refresh] -- ask user for a configuration and \
652 apply selected configuration.
653 \\[bs-select-next-configuration] -- select and apply next \
654 available Buffer Selection Menu configuration.
655 \\[bs-kill] -- leave Buffer Selection Menu without a selection.
656 \\[bs-toggle-current-to-show] -- toggle status of appearence .
657 \\[bs-set-current-buffer-to-show-always] -- mark current line's buffer \
658 to show always.
659 \\[bs-visit-tags-table] -- call `visit-tags-table' on current line'w buffer.
660 \\[bs-help] -- display this help text."
661 (interactive)
662 (kill-all-local-variables)
663 (use-local-map bs-mode-map)
664 (make-local-variable 'font-lock-defaults)
665 (make-local-variable 'font-lock-verbose)
666 (setq major-mode 'bs-mode
667 mode-name "Buffer-Selection-Menu"
668 buffer-read-only t
669 truncate-lines t
670 font-lock-defaults '(bs-mode-font-lock-keywords t)
671 font-lock-verbose nil)
672 (run-hooks 'bs-mode-hook))
674 (defun bs-kill ()
675 "Let buffer disappear and reset window-configuration."
676 (interactive)
677 (bury-buffer (current-buffer))
678 (set-window-configuration bs--window-config-coming-from))
680 (defun bs-abort ()
681 "Ding and leave Buffer Selection Menu without a selection."
682 (interactive)
683 (ding)
684 (bs-kill))
686 (defun bs-set-configuration-and-refresh ()
687 "Ask user for a configuration and apply selected configuration.
688 Refresh whole Buffer Selection Menu."
689 (interactive)
690 (call-interactively 'bs-set-configuration)
691 (bs--redisplay t))
693 (defun bs-refresh ()
694 "Refresh whole Buffer Selection Menu."
695 (interactive)
696 (bs--redisplay t))
698 (defun bs--window-for-buffer (buffer-name)
699 "Return a window showing a buffer with name BUFFER-NAME.
700 Take only windows of current frame into account.
701 Return nil if there is no such buffer."
702 (let ((window nil))
703 (walk-windows (lambda (wind)
704 (if (string= (buffer-name (window-buffer wind))
705 buffer-name)
706 (setq window wind))))
707 window))
709 (defun bs--set-window-height ()
710 "Change the height of the selected window to suit the current buffer list."
711 (unless (one-window-p t)
712 (shrink-window (- (window-height (selected-window))
713 ;; window-height in xemacs includes mode-line
714 (+ (if bs--running-in-xemacs 3 1)
715 bs-header-lines-length
716 (min (length bs-current-list)
717 bs-max-window-height))))))
719 (defun bs--current-buffer ()
720 "Return buffer on current line.
721 Raise an error if not an a buffer line."
722 (beginning-of-line)
723 (let ((line (+ (- bs-header-lines-length)
724 (count-lines 1 (point)))))
725 (if (< line 0)
726 (error "You are on a header row"))
727 (nth line bs-current-list)))
729 (defun bs--update-current-line ()
730 "Update the entry on current line for Buffer Selection Menu."
731 (let ((buffer (bs--current-buffer))
732 (inhibit-read-only t))
733 (beginning-of-line)
734 (delete-region (point) (line-end-position))
735 (bs--insert-one-entry buffer)
736 (beginning-of-line)))
738 (defun bs-view ()
739 "View current line's buffer in View mode.
740 Leave Buffer Selection Menu."
741 (interactive)
742 (view-buffer (bs--current-buffer)))
744 (defun bs-select ()
745 "Select current line's buffer and other marked buffers.
746 If there are no marked buffers the window configuration before starting
747 Buffer Selectin Menu will be restored.
748 If there are marked buffers each marked buffer and the current line's buffer
749 will be selected in a window.
750 Leave Buffer Selection Menu."
751 (interactive)
752 (let ((buffer (bs--current-buffer)))
753 (bury-buffer (current-buffer))
754 (set-window-configuration bs--window-config-coming-from)
755 (switch-to-buffer buffer)
756 (if bs--marked-buffers
757 ;; Some marked buffers for selection
758 (let* ((all (delq buffer bs--marked-buffers))
759 (height (/ (1- (frame-height)) (1+ (length all)))))
760 (delete-other-windows)
761 (switch-to-buffer buffer)
762 (while all
763 (split-window nil height)
764 (other-window 1)
765 (switch-to-buffer (car all))
766 (setq all (cdr all)))
767 ;; goto window we have started bs.
768 (other-window 1)))))
770 (defun bs-select-other-window ()
771 "Select current line's buffer by `switch-to-buffer-other-window'.
772 The window configuration before starting Buffer Selectin Menu will be restored
773 unless there is no other window. In this case a new window will be created.
774 Leave Buffer Selection Menu."
775 (interactive)
776 (let ((buffer (bs--current-buffer)))
777 (bury-buffer (current-buffer))
778 (set-window-configuration bs--window-config-coming-from)
779 (switch-to-buffer-other-window buffer)))
781 (defun bs-tmp-select-other-window ()
782 "Make the other window select this line's buffer.
783 The current window remains selected."
784 (interactive)
785 (let ((buffer (bs--current-buffer)))
786 (display-buffer buffer t)))
788 (defun bs-select-other-frame ()
789 "Select current line's buffer in new created frame.
790 Leave Buffer Selection Menu."
791 (interactive)
792 (let ((buffer (bs--current-buffer)))
793 (bury-buffer (current-buffer))
794 (set-window-configuration bs--window-config-coming-from)
795 (switch-to-buffer-other-frame buffer)))
797 (defun bs-mouse-select-other-frame (event)
798 "Select selected line's buffer in new created frame.
799 Leave Buffer Selection Menu.
800 EVENT: a mouse click EVENT."
801 (interactive "e")
802 (mouse-set-point event)
803 (bs-select-other-frame))
805 (defun bs-mouse-select (event)
806 "Select buffer on mouse click EVENT.
807 Select buffer by `bs-select'."
808 (interactive "e")
809 (mouse-set-point event)
810 (bs-select))
812 (defun bs-select-in-one-window ()
813 "Select current line's buffer in one window and delete other windows.
814 Leave Buffer Selection Menu."
815 (interactive)
816 (bs-select)
817 (delete-other-windows))
819 (defun bs-bury-buffer ()
820 "Bury buffer on current line."
821 (interactive)
822 (bury-buffer (bs--current-buffer))
823 (bs--redisplay t))
825 (defun bs-save ()
826 "Save buffer on current line."
827 (interactive)
828 (let ((buffer (bs--current-buffer)))
829 (save-excursion
830 (set-buffer buffer)
831 (save-buffer))
832 (bs--update-current-line)))
834 (defun bs-visit-tags-table ()
835 "Visit the tags table in the buffer on this line.
836 See `visit-tags-table'."
837 (interactive)
838 (let ((file (buffer-file-name (bs--current-buffer))))
839 (if file
840 (visit-tags-table file)
841 (error "Specified buffer has no file"))))
843 (defun bs-toggle-current-to-show ()
844 "Toggle status of showing flag for buffer in current line."
845 (interactive)
846 (let ((buffer (bs--current-buffer))
847 res)
848 (save-excursion
849 (set-buffer buffer)
850 (setq res (cond ((null bs-buffer-show-mark)
851 'never)
852 ((eq bs-buffer-show-mark 'never)
853 'always)
854 (t nil)))
855 (setq bs-buffer-show-mark res))
856 (bs--update-current-line)
857 (bs--set-window-height)
858 (bs--show-config-message res)))
860 (defun bs-set-current-buffer-to-show-always (&optional not-to-show-p)
861 "Toggle status of buffer on line to `always shown'.
862 NOT-TO-SHOW-P: prefix argument.
863 With no prefix argument the buffer on current line is marked to show
864 always. Otherwise it is marked to show never."
865 (interactive "P")
866 (if not-to-show-p
867 (bs-set-current-buffer-to-show-never)
868 (bs--set-toggle-to-show (bs--current-buffer) 'always)))
870 (defun bs-set-current-buffer-to-show-never ()
871 "Toggle status of buffer on line to `never shown'."
872 (interactive)
873 (bs--set-toggle-to-show (bs--current-buffer) 'never))
875 (defun bs--set-toggle-to-show (buffer what)
876 "Set value `bs-buffer-show-mark' of buffer BUFFER to WHAT.
877 Redisplay current line and display a message describing
878 the status of buffer on current line."
879 (save-excursion
880 (set-buffer buffer)
881 (setq bs-buffer-show-mark what))
882 (bs--update-current-line)
883 (bs--set-window-height)
884 (bs--show-config-message what))
886 (defun bs-mark-current (count)
887 "Mark buffers.
888 COUNT is the number of buffers to mark.
889 Move cursor vertically down COUNT lines."
890 (interactive "p")
891 (let ((dir (if (> count 0) 1 -1))
892 (count (abs count)))
893 (while (> count 0)
894 (let ((buffer (bs--current-buffer)))
895 (if buffer
896 (setq bs--marked-buffers (cons buffer bs--marked-buffers)))
897 (bs--update-current-line)
898 (bs-down dir))
899 (setq count (1- count)))))
901 (defun bs-unmark-current (count)
902 "Unmark buffers.
903 COUNT is the number of buffers to unmark.
904 Move cursor vertically down COUNT lines."
905 (interactive "p")
906 (let ((dir (if (> count 0) 1 -1))
907 (count (abs count)))
908 (while (> count 0)
909 (let ((buffer (bs--current-buffer)))
910 (if buffer
911 (setq bs--marked-buffers (delq buffer bs--marked-buffers)))
912 (bs--update-current-line)
913 (bs-down dir))
914 (setq count (1- count)))))
916 (defun bs--show-config-message (what)
917 "Show message indicating the new showing status WHAT.
918 WHAT is a value of nil, `never', or `always'."
919 (bs-message-without-log (cond ((null what)
920 "Buffer will be shown normally.")
921 ((eq what 'never)
922 "Mark buffer to never be shown.")
923 (t "Mark buffer to show always."))))
925 (defun bs-delete ()
926 "Kill buffer on current line."
927 (interactive)
928 (let ((current (bs--current-buffer))
929 (inhibit-read-only t))
930 (setq bs-current-list (delq current bs-current-list))
931 (kill-buffer current)
932 (beginning-of-line)
933 (delete-region (point) (save-excursion
934 (end-of-line)
935 (if (eobp) (point) (1+ (point)))))
936 (if (eobp)
937 (progn
938 (backward-delete-char 1)
939 (beginning-of-line)
940 (recenter -1)))
941 (bs--set-window-height)))
943 (defun bs-delete-backward ()
944 "Like `bs-delete' but go to buffer in front of current."
945 (interactive)
946 (let ((on-last-line-p (save-excursion (end-of-line) (eobp))))
947 (bs-delete)
948 (unless on-last-line-p
949 (bs-up 1))))
951 (defun bs-show-sorted ()
952 "Show buffer list sorted by buffer name."
953 (interactive)
954 (setq bs--current-sort-function
955 (bs-next-config-aux (car bs--current-sort-function)
956 bs-sort-functions))
957 (bs--redisplay)
958 (bs--goto-current-buffer)
959 (bs-message-without-log "Sorted %s" (car bs--current-sort-function)))
961 (defun bs-apply-sort-faces (&optional sort-description)
962 "Set text properties for the sort described by SORT-DESCRIPTION.
963 SORT-DESCRIPTION is an element of `bs-sort-functions'.
964 Default is `bs--current-sort-function'."
965 (let ((sort-description (or sort-description
966 bs--current-sort-function)))
967 (save-excursion
968 (goto-char (point-min))
969 (if (and (nth 2 sort-description)
970 (search-forward-regexp (nth 2 sort-description) nil t))
971 (let ((inhibit-read-only t))
972 (put-text-property (match-beginning 0)
973 (match-end 0)
974 'face
975 (or (nth 3 sort-description)
976 'region)))))))
978 (defun bs-toggle-show-all ()
979 "Toggle show all buffers / show buffers with current configuration."
980 (interactive)
981 (setq bs--show-all (not bs--show-all))
982 (bs--redisplay)
983 (bs--goto-current-buffer)
984 (bs-message-without-log "%s" (bs--current-config-message)))
986 (defun bs-toggle-readonly ()
987 "Toggle read-only status for buffer on current line.
988 Uses Function `vc-toggle-read-only'."
989 (interactive)
990 (let ((buffer (bs--current-buffer)))
991 (save-excursion
992 (set-buffer buffer)
993 (vc-toggle-read-only))
994 (bs--update-current-line)))
996 (defun bs-clear-modified ()
997 "Set modified flag for buffer on current line to nil."
998 (interactive)
999 (let ((buffer (bs--current-buffer)))
1000 (save-excursion
1001 (set-buffer buffer)
1002 (set-buffer-modified-p nil)))
1003 (bs--update-current-line))
1005 (defun bs--nth-wrapper (count fun &rest args)
1006 "Call COUNT times function FUN with arguments ARGS."
1007 (setq count (or count 1))
1008 (while (> count 0)
1009 (apply fun args)
1010 (setq count (1- count))))
1012 (defun bs-up (arg)
1013 "Move cursor vertically up ARG lines in Buffer Selection Menu."
1014 (interactive "p")
1015 (if (and arg (numberp arg) (< arg 0))
1016 (bs--nth-wrapper (- arg) 'bs--down)
1017 (bs--nth-wrapper arg 'bs--up)))
1019 (defun bs--up ()
1020 "Move cursor vertically up one line.
1021 If on top of buffer list go to last line."
1022 (interactive "p")
1023 (previous-line 1)
1024 (if (<= (count-lines 1 (point)) (1- bs-header-lines-length))
1025 (progn
1026 (goto-char (point-max))
1027 (beginning-of-line)
1028 (recenter -1))
1029 (beginning-of-line)))
1031 (defun bs-down (arg)
1032 "Move cursor vertically down ARG lines in Buffer Selection Menu."
1033 (interactive "p")
1034 (if (and arg (numberp arg) (< arg 0))
1035 (bs--nth-wrapper (- arg) 'bs--up)
1036 (bs--nth-wrapper arg 'bs--down)))
1038 (defun bs--down ()
1039 "Move cursor vertically down one line.
1040 If at end of buffer list go to first line."
1041 (let ((last (line-end-position)))
1042 (if (eq last (point-max))
1043 (goto-line (1+ bs-header-lines-length))
1044 (next-line 1))))
1046 (defun bs-visits-non-file (buffer)
1047 "Return t or nil whether BUFFER visits no file.
1048 A value of t means BUFFER belongs to no file.
1049 A value of nil means BUFFER belongs to a file."
1050 (not (buffer-file-name buffer)))
1052 (defun bs-sort-buffer-interns-are-last (b1 b2)
1053 "Function for sorting intern buffers B1 and B2 at the end of all buffers."
1054 (string-match "^\\*" (buffer-name b2)))
1056 ;; ----------------------------------------------------------------------
1057 ;; Configurations:
1058 ;; ----------------------------------------------------------------------
1060 (defun bs-config-clear ()
1061 "*Reset all variables which specify a configuration.
1062 These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
1063 `bs-dont-show-function', `bs-must-show-function' and
1064 `bs-buffer-sort-function'."
1065 (setq bs-dont-show-regexp nil
1066 bs-must-show-regexp nil
1067 bs-dont-show-function nil
1068 bs-must-show-function nil
1069 bs-buffer-sort-function nil))
1071 (defun bs-config--only-files ()
1072 "Define a configuration for showing only buffers visiting a file."
1073 (bs-config-clear)
1074 (setq;; I want to see *-buffers at the end
1075 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1076 ;; Don't show files who don't belong to a file
1077 bs-dont-show-function 'bs-visits-non-file))
1079 (defun bs-config--files-and-scratch ()
1080 "Define a configuration for showing buffer *scratch* and file buffers."
1081 (bs-config-clear)
1082 (setq;; I want to see *-buffers at the end
1083 bs-buffer-sort-function 'bs-sort-buffer-interns-are-last
1084 ;; Don't show files who don't belong to a file
1085 bs-dont-show-function 'bs-visits-non-file
1086 ;; Show *scratch* buffer.
1087 bs-must-show-regexp "^\\*scratch\\*"))
1089 (defun bs-config--all ()
1090 "Define a configuration for showing all buffers.
1091 Reset all according variables by `bs-config-clear'."
1092 (bs-config-clear))
1094 (defun bs-config--all-intern-last ()
1095 "Define a configuration for showing all buffers.
1096 Intern buffers appear at end of all buffers."
1097 (bs-config-clear)
1098 ;; I want to see *-buffers at the end
1099 (setq bs-buffer-sort-function 'bs-sort-buffer-interns-are-last))
1101 (defun bs-set-configuration (name)
1102 "Set configuration to the one saved under string NAME in `bs-configurations'.
1103 When called interactively ask user for a configuration and apply selected
1104 configuration."
1105 (interactive (list (completing-read "Use configuration: "
1106 bs-configurations
1108 t)))
1109 (let ((list (assoc name bs-configurations)))
1110 (if list
1111 (if (listp list)
1112 (setq bs-current-configuration name
1113 bs-must-show-regexp (nth 1 list)
1114 bs-must-show-function (nth 2 list)
1115 bs-dont-show-regexp (nth 3 list)
1116 bs-dont-show-function (nth 4 list)
1117 bs-buffer-sort-function (nth 5 list))
1118 ;; for backward compability
1119 (funcall (cdr list)))
1120 ;; else
1121 (ding)
1122 (bs-message-without-log "No bs-configuration named %S." name))))
1124 (defun bs-help ()
1125 "Help for `bs-show'."
1126 (interactive)
1127 (describe-function 'bs-mode))
1129 (defun bs-next-config-aux (start-name list)
1130 "Get the next assoc after START-NAME in list LIST.
1131 Will return the first if START-NAME is at end."
1132 (let ((assocs list)
1133 (length (length list))
1134 pos)
1135 (while (and assocs (not pos))
1136 (if (string= (car (car assocs)) start-name)
1137 (setq pos (- length (length assocs))))
1138 (setq assocs (cdr assocs)))
1139 (setq pos (1+ pos))
1140 (if (eq pos length)
1141 (car list)
1142 (nth pos list))))
1144 (defun bs-next-config (name)
1145 "Return next configuration with respect to configuration with name NAME."
1146 (bs-next-config-aux name bs-configurations))
1148 (defun bs-select-next-configuration (&optional start-name)
1149 "Apply next configuration START-NAME and refresh buffer list.
1150 If START-NAME is nil the current configuration `bs-current-configuration'
1151 will be used."
1152 (interactive)
1153 (let ((config (bs-next-config (or start-name bs-current-configuration))))
1154 (bs-set-configuration (car config))
1155 (setq bs-default-configuration bs-current-configuration)
1156 (bs--redisplay t)
1157 (bs--set-window-height)
1158 (bs-message-without-log "Selected config: %s" (car config))))
1160 (defun bs-show-in-buffer (list)
1161 "Display buffer list LIST in buffer *buffer-selection*.
1162 Select buffer *buffer-selection* and display buffers according to current
1163 configuration `bs-current-configuration'. Set window height, fontify buffer
1164 and move point to current buffer."
1165 (setq bs-current-list list)
1166 (switch-to-buffer (get-buffer-create "*buffer-selection*"))
1167 (bs-mode)
1168 (let* ((inhibit-read-only t)
1169 (map-fun (lambda (entry)
1170 (length (buffer-name entry))))
1171 (max-length-of-names (apply 'max
1172 (cons 0 (mapcar map-fun list))))
1173 (name-entry-length (min bs-maximal-buffer-name-column
1174 (max bs-minimal-buffer-name-column
1175 max-length-of-names))))
1176 (erase-buffer)
1177 (setq bs--name-entry-length name-entry-length)
1178 (bs--show-header)
1179 (while list
1180 (bs--insert-one-entry (car list))
1181 (insert "\n")
1182 (setq list (cdr list)))
1183 (delete-backward-char 1)
1184 (bs--set-window-height)
1185 (bs--goto-current-buffer)
1186 (font-lock-fontify-buffer)
1187 (bs-apply-sort-faces)))
1189 (defun bs-next-buffer (&optional buffer-list sorting-p)
1190 "Return next buffer and buffer list for buffer cycling in BUFFER-LIST.
1191 Ignore sorting when SORTING-P is nil.
1192 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1193 buffer list. The result is a cons of normally the second element of
1194 BUFFER-LIST and the buffer list used for buffer cycling."
1195 (let* ((bs--current-sort-function (if sorting-p
1196 bs--current-sort-function))
1197 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1198 (cons (or (car (cdr bs-buffer-list))
1199 (car bs-buffer-list)
1200 (current-buffer))
1201 bs-buffer-list)))
1203 (defun bs-previous-buffer (&optional buffer-list sorting-p)
1204 "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST.
1205 Ignore sorting when SORTING-P is nil.
1206 If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as
1207 buffer list. The result is a cons of last element of BUFFER-LIST and the
1208 buffer list used for buffer cycling."
1209 (let* ((bs--current-sort-function (if sorting-p
1210 bs--current-sort-function))
1211 (bs-buffer-list (or buffer-list (bs-buffer-list))))
1212 (cons (or (car (last bs-buffer-list))
1213 (current-buffer))
1214 bs-buffer-list)))
1216 (defun bs-message-without-log (&rest args)
1217 "Like `message' but don't log it on the message log.
1218 All arguments ARGS are transfered to function `message'."
1219 (let ((message-log-max nil))
1220 (apply 'message args)))
1222 (defvar bs--cycle-list nil
1223 "Currentyl buffer list used for cycling.")
1225 ;;;###autoload
1226 (defun bs-cycle-next ()
1227 "Select next 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 bs--show-all))
1237 (if bs-cycle-configuration-name
1238 (bs-set-configuration bs-cycle-configuration-name))
1239 (let ((bs-buffer-sort-function nil)
1240 (bs--current-sort-function nil))
1241 (let* ((tupel (bs-next-buffer (if (or (eq last-command
1242 'bs-cycle-next)
1243 (eq last-command
1244 'bs-cycle-previous))
1245 bs--cycle-list)))
1246 (next (car tupel))
1247 (cycle-list (cdr tupel)))
1248 (setq bs--cycle-list (append (cdr cycle-list)
1249 (list (car cycle-list))))
1250 (bury-buffer)
1251 (switch-to-buffer next)
1252 (bs-message-without-log "Next buffers: %s"
1253 (or (cdr bs--cycle-list)
1254 "this buffer"))))))
1257 ;;;###autoload
1258 (defun bs-cycle-previous ()
1259 "Select previous buffer defined by buffer cycling.
1260 The buffers taking part in buffer cycling are defined
1261 by buffer configuration `bs-cycle-configuration-name'."
1262 (interactive)
1263 (let ((bs--buffer-coming-from (current-buffer))
1264 (bs-dont-show-regexp bs-dont-show-regexp)
1265 (bs-must-show-regexp bs-must-show-regexp)
1266 (bs-dont-show-function bs-dont-show-function)
1267 (bs-must-show-function bs-must-show-function)
1268 (bs--show-all bs--show-all))
1269 (if bs-cycle-configuration-name
1270 (bs-set-configuration bs-cycle-configuration-name))
1271 (let ((bs-buffer-sort-function nil)
1272 (bs--current-sort-function nil))
1273 (let* ((tupel (bs-previous-buffer (if (or (eq last-command
1274 'bs-cycle-next)
1275 (eq last-command
1276 'bs-cycle-previous))
1277 bs--cycle-list)))
1278 (prev-buffer (car tupel))
1279 (cycle-list (cdr tupel)))
1280 (setq bs--cycle-list (append (last cycle-list)
1281 (reverse (cdr (reverse cycle-list)))))
1282 (switch-to-buffer prev-buffer)
1283 (bs-message-without-log "Previous buffers: %s"
1284 (or (reverse (cdr bs--cycle-list))
1285 "this buffer"))))))
1287 (defun bs--get-value (fun &optional args)
1288 "Apply function FUN with arguments ARGS.
1289 Return result of evaluation. Will return FUN if FUN is a number
1290 or a string."
1291 (cond ((numberp fun)
1292 fun)
1293 ((stringp fun)
1294 fun)
1295 (t (apply fun args))))
1297 (defun bs--get-marked-string (start-buffer all-buffers)
1298 "Return a string which describes whether current buffer is marked.
1299 START-BUFFER is the buffer where we started buffer selection.
1300 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu.
1301 The result string is one of `bs-string-current', `bs-string-current-marked',
1302 `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
1303 `bs-string-show-always'."
1304 (cond;; current buffer is the buffer we started buffer selection.
1305 ((eq (current-buffer) start-buffer)
1306 (if (memq (current-buffer) bs--marked-buffers)
1307 bs-string-current-marked ; buffer is marked
1308 bs-string-current))
1309 ;; current buffer is marked
1310 ((memq (current-buffer) bs--marked-buffers)
1311 bs-string-marked)
1312 ;; current buffer hasn't a special mark.
1313 ((null bs-buffer-show-mark)
1314 bs-string-show-normally)
1315 ;; current buffer has a mark not to show itself.
1316 ((eq bs-buffer-show-mark 'never)
1317 bs-string-show-never)
1318 ;; otherwise current buffer is marked to show always.
1320 bs-string-show-always)))
1322 (defun bs--get-modified-string (start-buffer all-buffers)
1323 "Return a string which describes whether current buffer is modified.
1324 START-BUFFER is the buffer where we started buffer selection.
1325 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1326 (if (buffer-modified-p) "*" " "))
1328 (defun bs--get-readonly-string (start-buffer all-buffers)
1329 "Return a string which describes whether current buffer is read only.
1330 START-BUFFER is the buffer where we started buffer selection.
1331 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1332 (if buffer-read-only "%" " "))
1334 (defun bs--get-size-string (start-buffer all-buffers)
1335 "Return a string which describes the size of current buffer.
1336 START-BUFFER is the buffer where we started buffer selection.
1337 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1338 (int-to-string (buffer-size)))
1340 (defun bs--get-name (start-buffer all-buffers)
1341 "Return name of current buffer for Buffer Selection Menu.
1342 The name of current buffer gets additional text properties
1343 for mouse highlighting.
1344 START-BUFFER is the buffer where we started buffer selection.
1345 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1346 (let ((name (copy-sequence (buffer-name))))
1347 (put-text-property 0 (length name) 'mouse-face 'highlight name)
1348 (if (< (length name) bs--name-entry-length)
1349 (concat name
1350 (make-string (- bs--name-entry-length (length name)) ? ))
1351 name)))
1354 (defun bs--get-mode-name (start-buffer all-buffers)
1355 "Return the name of mode of current buffer for Buffer Selection Menu.
1356 START-BUFFER is the buffer where we started buffer selection.
1357 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1358 mode-name)
1360 (defun bs--get-file-name (start-buffer all-buffers)
1361 "Return string for column 'File' in Buffer Selection Menu.
1362 This is the variable `buffer-file-name' of current buffer.
1363 If current mode is `dired-mode' or `shell-mode' it returns the
1364 default directory.
1365 START-BUFFER is the buffer where we started buffer selection.
1366 ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
1367 (let ((string (copy-sequence (if (member major-mode
1368 '(shell-mode dired-mode))
1369 default-directory
1370 (or buffer-file-name "")))))
1371 (put-text-property 0 (length string) 'mouse-face 'highlight string)
1372 string))
1375 (defun bs--insert-one-entry (buffer)
1376 "Generate one entry for buffer BUFFER in Buffer Selection Menu.
1377 It goes over all columns described in `bs-attributes-list'
1378 and evaluates corresponding string. Inserts string in current buffer;
1379 normally *buffer-selection*."
1380 (let ((string "")
1381 (columns bs-attributes-list)
1382 (to-much 0)
1383 (apply-args (append (list bs--buffer-coming-from bs-current-list))))
1384 (save-excursion
1385 (while columns
1386 (set-buffer buffer)
1387 (let ((min (bs--get-value (nth 1 (car columns))))
1388 ;;(max (bs--get-value (nth 2 (car columns)))) refered no more
1389 (align (nth 3 (car columns)))
1390 (fun (nth 4 (car columns)))
1391 (val nil)
1392 new-string)
1393 (setq val (bs--get-value fun apply-args))
1394 (setq new-string (bs--format-aux val align (- min to-much)))
1395 (setq string (concat string new-string))
1396 (if (> (length new-string) min)
1397 (setq to-much (- (length new-string) min)))
1398 ) ; let
1399 (setq columns (cdr columns))))
1400 (insert string)
1401 string))
1403 (defun bs--format-aux (string align len)
1404 "Generate a string with STRING with alignment ALIGN and length LEN.
1405 ALIGN is one of the symbols `left', `middle', or `right'."
1406 (let ((length (length string)))
1407 (if (>= length len)
1408 string
1409 (if (eq 'right align)
1410 (concat (make-string (- len length) ? ) string)
1411 (concat string (make-string (- len length) ? ))))))
1413 (defun bs--show-header ()
1414 "Insert header for Buffer Selection Menu in current buffer."
1415 (mapcar '(lambda (string)
1416 (insert string "\n"))
1417 (bs--create-header)))
1419 (defun bs--get-name-length ()
1420 "Return value of `bs--name-entry-length'."
1421 bs--name-entry-length)
1423 (defun bs--create-header ()
1424 "Return all header lines used in Buffer Selection Menu as a list of strings."
1425 (list (mapconcat (lambda (column)
1426 (bs--format-aux (bs--get-value (car column))
1427 (nth 3 column) ; align
1428 (bs--get-value (nth 1 column))))
1429 bs-attributes-list
1431 (mapconcat (lambda (column)
1432 (let ((length (length (bs--get-value (car column)))))
1433 (bs--format-aux (make-string length ?-)
1434 (nth 3 column) ; align
1435 (bs--get-value (nth 1 column)))))
1436 bs-attributes-list
1437 "")))
1439 (defun bs--show-with-configuration (name &optional arg)
1440 "Display buffer list of configuration with NAME name.
1441 Set configuration NAME and determine window for Buffer Selection Menu.
1442 Unless current buffer is buffer *buffer-selection* we have to save
1443 the buffer we started Buffer Selection Menu and the current window
1444 configuration to restore buffer and window configuration after a
1445 selection. If there is already a window displaying *buffer-selection*
1446 select this window for Buffer Selection Menu. Otherwise open a new
1447 window.
1448 The optional argument ARG is the prefix argument when calling a function
1449 for buffer selection."
1450 (bs-set-configuration name)
1451 (let ((bs--show-all (or bs--show-all arg)))
1452 (unless (string= "*buffer-selection*" (buffer-name))
1453 ;; Only when not in buffer *buffer-selection*
1454 ;; we have to set the buffer we started the command
1455 (progn
1456 (setq bs--buffer-coming-from (current-buffer))
1457 (setq bs--window-config-coming-from (current-window-configuration))))
1458 (let ((liste (bs-buffer-list))
1459 (active-window (bs--window-for-buffer "*buffer-selection*")))
1460 (if active-window
1461 (select-window active-window)
1462 (if (> (window-height (selected-window)) 7)
1463 (progn
1464 (split-window-vertically)
1465 (other-window 1))))
1466 (bs-show-in-buffer liste)
1467 (bs-message-without-log "%s" (bs--current-config-message)))))
1469 (defun bs--configuration-name-for-prefix-arg (prefix-arg)
1470 "Convert prefix argument PREFIX-ARG to a name of a buffer configuration.
1471 If PREFIX-ARG is nil return `bs-default-configuration'.
1472 If PREFIX-ARG is an integer return PREFIX-ARG element of `bs-configurations'.
1473 Otherwise return `bs-alternative-configuration'."
1474 (cond;; usually activation
1475 ((null prefix-arg)
1476 bs-default-configuration)
1477 ;; call with integer as prefix argument
1478 ((integerp prefix-arg)
1479 (if (and (< 0 prefix-arg) (<= prefix-arg (length bs-configurations)))
1480 (car (nth (1- prefix-arg) bs-configurations))
1481 bs-default-configuration))
1482 ;; call by prefix argument C-u
1483 (t bs-alternative-configuration)))
1485 ;; ----------------------------------------------------------------------
1486 ;; Main function bs-customize and bs-show
1487 ;; ----------------------------------------------------------------------
1489 ;;;###autoload
1490 (defun bs-customize ()
1491 "Customization of group bs for Buffer Selection Menu."
1492 (interactive)
1493 (customize-group "bs"))
1495 ;;;###autoload
1496 (defun bs-show (arg)
1497 "Make a menu of buffers so you can manipulate buffers or the buffer list.
1498 \\<bs-mode-map>
1499 There are many key commands similar to `Buffer-menu-mode' for
1500 manipulating buffer list and buffers itself.
1501 User can move with [up] or [down], select a buffer
1502 by \\[bs-select] or [SPC]\n
1503 Type \\[bs-kill] to leave Buffer Selection Menu without a selection.
1504 Type \\[bs-help] after invocation to get help on commands available.
1505 With prefix argument ARG show a different buffer list. Function
1506 `bs--configuration-name-for-prefix-arg' determine accordingly
1507 name of buffer configuration."
1508 (interactive "P")
1509 (setq bs--marked-buffers nil)
1510 (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg)))
1512 ;;; Now provide feature bs
1513 (provide 'bs)
1515 ;;; bs.el ends here