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