Commit | Line | Data |
---|---|---|
6448a6b3 GM |
1 | ;;; bs.el --- menu for selecting and displaying buffers |
2 | ||
0d30b337 | 3 | ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, |
d7a0267c | 4 | ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
6448a6b3 GM |
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 | |
b4aa6026 | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
6448a6b3 GM |
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 | |
086add15 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
6448a6b3 GM |
25 | |
26 | ;;; Commentary: | |
27 | ||
28 | ;; Version: 1.17 | |
91b69101 | 29 | ;; X-URL: http://www.geekware.de/software/emacs |
6448a6b3 GM |
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 | ;; | |
880ed9f1 | 69 | ;; Additional features for Buffer Selection Menu: |
6448a6b3 GM |
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 | ||
e47a90e5 JB |
134 | (defvar font-lock-verbose) |
135 | ||
6448a6b3 GM |
136 | ;; ---------------------------------------------------------------------- |
137 | ;; Globals for customization | |
138 | ;; ---------------------------------------------------------------------- | |
139 | ||
140 | (defgroup bs nil | |
141 | "Buffer Selection: Maintaining buffers by buffer menu." | |
00a9f6a5 | 142 | :version "21.1" |
dc7904f5 | 143 | :link '(emacs-commentary-link "bs") |
91b69101 | 144 | :link '(url-link "http://www.geekware.de/software/emacs") |
6448a6b3 GM |
145 | :group 'convenience) |
146 | ||
880ed9f1 GM |
147 | (defgroup bs-appearance nil |
148 | "Buffer Selection appearance: Appearance of bs buffer menu." | |
6448a6b3 GM |
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. | |
164 | Each entry specifies a column and is a list of the form of: | |
c0cb1027 | 165 | \(HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING) |
91b69101 JB |
166 | |
167 | HEADER : String for header for first line or a function | |
168 | which calculates column title. | |
169 | MINIMUM-LENGTH : Minimum width of column (number or name of function). | |
170 | The function must return a positive integer. | |
171 | MAXIMUM-LENGTH : Maximum width of column (number or name of function) | |
172 | (currently ignored). | |
173 | ALIGNMENT : Alignment of column (`left', `right', `middle'). | |
174 | FUN-OR-STRING : Name of a function for calculating the value or a | |
175 | string for a constant value. | |
176 | ||
880ed9f1 | 177 | The function gets as parameter the buffer where we have started |
6448a6b3 | 178 | buffer selection and the list of all buffers to show. The function must |
880ed9f1 GM |
179 | return a string representing the column's value." |
180 | :group 'bs-appearance | |
6448a6b3 GM |
181 | :type '(repeat sexp)) |
182 | ||
6448a6b3 GM |
183 | (defun bs--make-header-match-string () |
184 | "Return a regexp matching the first line of a Buffer Selection Menu buffer." | |
185 | (let ((res "^\\(") | |
880ed9f1 | 186 | (ele bs-attributes-list)) |
6448a6b3 GM |
187 | (while ele |
188 | (setq res (concat res (car (car ele)) " *")) | |
189 | (setq ele (cdr ele))) | |
190 | (concat res "$\\)"))) | |
191 | ||
d8754ce5 | 192 | ;; Font-Lock-Settings |
6448a6b3 | 193 | (defvar bs-mode-font-lock-keywords |
880ed9f1 | 194 | (list ;; header in font-lock-type-face |
dc7904f5 DL |
195 | (list (bs--make-header-match-string) |
196 | '(1 font-lock-type-face append) '(1 'bold append)) | |
197 | ;; Buffername embedded by * | |
198 | (list "^\\(.*\\*.*\\*.*\\)$" | |
a5b09d5a DL |
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)) | |
dc7904f5 DL |
204 | ;; Dired-Buffers |
205 | '("^..\\(.*Dired by .*\\)$" 1 font-lock-function-name-face) | |
206 | ;; the star for modified buffers | |
207 | '("^.\\(\\*\\) +[^\\*]" 1 font-lock-comment-face)) | |
6448a6b3 GM |
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." | |
880ed9f1 | 212 | :group 'bs-appearance |
6448a6b3 GM |
213 | :type 'integer) |
214 | ||
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.") | |
219 | ||
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.") | |
227 | ||
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)) | |
234 | ||
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.") | |
240 | ||
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.") | |
244 | ||
245 | (defvar bs-buffer-sort-function nil | |
246 | "Sort function to sort the buffers that appear in Buffer Selection Menu. | |
880ed9f1 | 247 | The function gets two arguments - the buffers to compare.") |
6448a6b3 GM |
248 | |
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'." | |
880ed9f1 | 255 | :group 'bs-appearance |
6448a6b3 GM |
256 | :type 'integer) |
257 | ||
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'." | |
880ed9f1 | 264 | :group 'bs-appearance |
6448a6b3 GM |
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) | |
880ed9f1 | 273 | ("files-and-scratch" "^\\*scratch\\*$" nil nil bs-visits-non-file |
6448a6b3 GM |
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 | |
880ed9f1 | 278 | and also the order of buffers. A configuration is a list with |
6448a6b3 GM |
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 | |
880ed9f1 GM |
281 | configuration variables `bs-must-show-regexp', `bs-must-show-function', |
282 | `bs-dont-show-regexp', `bs-dont-show-function' and `bs-buffer-sort-function'. | |
6448a6b3 | 283 | By setting these variables you define a configuration." |
880ed9f1 | 284 | :group 'bs-appearance |
6448a6b3 GM |
285 | :type '(repeat sexp)) |
286 | ||
287 | (defcustom bs-default-configuration "files" | |
880ed9f1 | 288 | "*Name of default configuration used by the Buffer Selection Menu. |
6448a6b3 GM |
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) | |
294 | ||
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) | |
301 | ||
302 | (defvar bs-current-configuration bs-default-configuration | |
303 | "Name of current configuration. | |
880ed9f1 | 304 | Must be a string used in `bs-configurations' for naming a configuration.") |
6448a6b3 GM |
305 | |
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)) | |
313 | ||
314 | (defcustom bs-string-show-always "+" | |
315 | "*String added in column 1 indicating a buffer will always be shown." | |
880ed9f1 | 316 | :group 'bs-appearance |
6448a6b3 GM |
317 | :type 'string) |
318 | ||
319 | (defcustom bs-string-show-never "-" | |
320 | "*String added in column 1 indicating a buffer will never be shown." | |
880ed9f1 | 321 | :group 'bs-appearance |
6448a6b3 GM |
322 | :type 'string) |
323 | ||
324 | (defcustom bs-string-current "." | |
325 | "*String added in column 1 indicating the current buffer." | |
880ed9f1 | 326 | :group 'bs-appearance |
6448a6b3 GM |
327 | :type 'string) |
328 | ||
329 | (defcustom bs-string-current-marked "#" | |
330 | "*String added in column 1 indicating the current buffer when it is marked." | |
880ed9f1 | 331 | :group 'bs-appearance |
6448a6b3 GM |
332 | :type 'string) |
333 | ||
334 | (defcustom bs-string-marked ">" | |
335 | "*String added in column 1 indicating a marked buffer." | |
880ed9f1 | 336 | :group 'bs-appearance |
6448a6b3 GM |
337 | :type 'string) |
338 | ||
339 | (defcustom bs-string-show-normally " " | |
340 | "*String added in column 1 indicating a unmarked buffer." | |
880ed9f1 | 341 | :group 'bs-appearance |
6448a6b3 GM |
342 | :type 'string) |
343 | ||
344 | (defvar bs--name-entry-length 20 | |
345 | "Maximum length of all displayed buffer names. | |
346 | Used internally, only.") | |
347 | ||
348 | ;; ---------------------------------------------------------------------- | |
880ed9f1 | 349 | ;; Internal globals |
6448a6b3 GM |
350 | ;; ---------------------------------------------------------------------- |
351 | ||
352 | (defvar bs-buffer-show-mark nil | |
353 | "Flag for the current mode for showing this buffer. | |
880ed9f1 GM |
354 | A value of nil means buffer will be shown depending on the current |
355 | configuration. | |
6448a6b3 GM |
356 | A value of `never' means to never show the buffer. |
357 | A 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 | ||
6448a6b3 GM |
366 | (defun bs--sort-by-name (b1 b2) |
367 | "Compare buffers B1 and B2 by buffer name." | |
368 | (string< (buffer-name b1) | |
dc7904f5 | 369 | (buffer-name b2))) |
6448a6b3 GM |
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) "") | |
dc7904f5 | 374 | (or (buffer-file-name b2) ""))) |
6448a6b3 GM |
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)) | |
dc7904f5 | 380 | (progn (set-buffer b2) (format "%s" mode-name))))) |
6448a6b3 GM |
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. | |
395 | You can add a new entry with a call to `bs-define-sort-function'. | |
396 | Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE) | |
397 | NAME specifies the sort order defined by function FUNCTION. | |
398 | FUNCTION nil means don't sort the buffer list. Otherwise the functions | |
399 | must have two parameters - the buffers to compare. | |
400 | REGEXP-FOR-SORTING is a regular expression which describes the | |
401 | column title to highlight. | |
402 | FACE is a face used to fontify the sorted column title. A value of nil means | |
403 | don'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. | |
409 | NAME specifies the sort order defined by function FUN. | |
410 | A value of nil for FUN means don't sort the buffer list. Otherwise the | |
411 | functions must have two parameters - the buffers to compare. | |
412 | REGEXP-FOR-SORTING is a regular expression which describes the | |
413 | column title to highlight. | |
414 | FACE is a face used to fontify the sorted column title. A value of nil means | |
415 | don't highlight. | |
416 | The new sort aspect will be inserted into list `bs-sort-functions'." | |
417 | (let ((tupel (assoc name bs-sort-functions))) | |
418 | (if tupel | |
dc7904f5 | 419 | (setcdr tupel (list fun regexp-for-sorting face)) |
6448a6b3 | 420 | (setq bs-sort-functions |
dc7904f5 DL |
421 | (cons (list name fun regexp-for-sorting face) |
422 | bs-sort-functions))))) | |
6448a6b3 GM |
423 | |
424 | (defvar bs--current-sort-function nil | |
425 | "Description of the current function for sorting the buffer list. | |
426 | This is an element of `bs-sort-functions'.") | |
427 | ||
428 | (defcustom bs-default-sort-name "by nothing" | |
429 | "*Name of default sort behavior. | |
430 | Must be \"by nothing\" or a string used in `bs-sort-functions' for | |
431 | naming a sort behavior. Default is \"by nothing\" which means no sorting." | |
432 | :group 'bs | |
433 | :type 'string | |
434 | :set (lambda (var-name value) | |
dc7904f5 DL |
435 | (set var-name value) |
436 | (setq bs--current-sort-function | |
437 | (assoc value bs-sort-functions)))) | |
6448a6b3 GM |
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. | |
aaf08d6b | 444 | Non-nil means to show all buffers. Otherwise show buffers |
6448a6b3 GM |
445 | defined by current configuration `bs-current-configuration'.") |
446 | ||
447 | (defvar bs--window-config-coming-from nil | |
448 | "Window configuration before starting Buffer Selection Menu.") | |
ce3ba12c | 449 | (make-variable-frame-local 'bs--window-config-coming-from) |
6448a6b3 GM |
450 | |
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.") | |
455 | ||
456 | (defvar bs-current-list nil | |
457 | "List of buffers shown in Buffer Selection Menu. | |
458 | Used internally, only.") | |
459 | ||
460 | (defvar bs--marked-buffers nil | |
461 | "Currently marked buffers in Buffer Selection Menu.") | |
462 | ||
e6e76838 AS |
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) | |
6448a6b3 GM |
516 | "Keymap of `bs-mode'.") |
517 | ||
6448a6b3 GM |
518 | ;; ---------------------------------------------------------------------- |
519 | ;; Functions | |
520 | ;; ---------------------------------------------------------------------- | |
521 | ||
522 | (defun bs-buffer-list (&optional list sort-description) | |
523 | "Return a list of buffers to be shown. | |
880ed9f1 | 524 | LIST is a list of buffers to test for appearance in Buffer Selection Menu. |
6448a6b3 GM |
525 | The result list depends on the global variables `bs-dont-show-regexp', |
526 | `bs-must-show-regexp', `bs-dont-show-function', `bs-must-show-function' | |
527 | and `bs-buffer-sort-function'. | |
528 | If SORT-DESCRIPTION isn't nil the list will be sorted by | |
529 | a special function. SORT-DESCRIPTION is an element of `bs-sort-functions'." | |
530 | (setq sort-description (or sort-description bs--current-sort-function) | |
dc7904f5 | 531 | list (or list (buffer-list))) |
6448a6b3 GM |
532 | (let ((result nil)) |
533 | (while list | |
534 | (let* ((buffername (buffer-name (car list))) | |
dc7904f5 DL |
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)))) | |
e64dbd8b | 552 | (show-flag (buffer-local-value 'bs-buffer-show-mark (car list)))) |
dc7904f5 DL |
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)))) | |
6448a6b3 GM |
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 | |
dc7904f5 DL |
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))) | |
6448a6b3 GM |
572 | ;; sorting |
573 | (if (and sort-description | |
dc7904f5 DL |
574 | (nth 1 sort-description)) |
575 | (setq result (sort result (nth 1 sort-description))) | |
6448a6b3 GM |
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. | |
aaf08d6b | 587 | If KEEP-LINE-P is non-nil the point will stay on current line. |
ce3ba12c | 588 | SORT-DESCRIPTION is an element of `bs-sort-functions'." |
6448a6b3 GM |
589 | (let ((line (1+ (count-lines 1 (point))))) |
590 | (bs-show-in-buffer (bs-buffer-list nil sort-description)) | |
591 | (if keep-line-p | |
dc7904f5 | 592 | (goto-line line)) |
6448a6b3 GM |
593 | (beginning-of-line))) |
594 | ||
595 | (defun bs--goto-current-buffer () | |
596 | "Goto line which represents the current buffer; | |
597 | actually the line which begins with character in `bs-string-current' or | |
598 | `bs-string-current-marked'." | |
dc7904f5 DL |
599 | (let ((regexp (concat "^" |
600 | (regexp-quote bs-string-current) | |
601 | "\\|^" | |
602 | (regexp-quote bs-string-current-marked))) | |
603 | point) | |
6448a6b3 GM |
604 | (save-excursion |
605 | (goto-char (point-min)) | |
606 | (if (search-forward-regexp regexp nil t) | |
dc7904f5 | 607 | (setq point (- (point) 1)))) |
6448a6b3 | 608 | (if point |
dc7904f5 | 609 | (goto-char point)))) |
6448a6b3 GM |
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" | |
dc7904f5 | 616 | bs-current-configuration))) |
6448a6b3 GM |
617 | |
618 | (defun bs-mode () | |
619 | "Major mode for editing a subset of Emacs' buffers. | |
620 | \\<bs-mode-map> | |
621 | Aside from two header lines each line describes one buffer. | |
622 | Move to a line representing the buffer you want to edit and select | |
623 | buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill]. | |
624 | There are many key commands similar to `Buffer-menu-mode' for | |
625 | manipulating the buffer list and buffers. | |
626 | For 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. | |
e148f726 TTN |
634 | \\[bs-save] -- save current line's buffer immediately. |
635 | \\[bs-delete] -- kill current line's buffer immediately. | |
6448a6b3 GM |
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 \ | |
642 | apply selected configuration. | |
643 | \\[bs-select-next-configuration] -- select and apply next \ | |
644 | available Buffer Selection Menu configuration. | |
645 | \\[bs-kill] -- leave Buffer Selection Menu without a selection. | |
880ed9f1 | 646 | \\[bs-toggle-current-to-show] -- toggle status of appearance. |
6448a6b3 GM |
647 | \\[bs-set-current-buffer-to-show-always] -- mark current line's buffer \ |
648 | to show always. | |
880ed9f1 | 649 | \\[bs-visit-tags-table] -- call `visit-tags-table' on current line's buffer. |
6448a6b3 GM |
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) | |
310a26be | 656 | (buffer-disable-undo) |
6448a6b3 | 657 | (setq major-mode 'bs-mode |
dc7904f5 DL |
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) | |
2a16b26c | 663 | (run-mode-hooks 'bs-mode-hook)) |
6448a6b3 | 664 | |
ce3ba12c JB |
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 | ||
6448a6b3 GM |
671 | (defun bs-kill () |
672 | "Let buffer disappear and reset window-configuration." | |
673 | (interactive) | |
674 | (bury-buffer (current-buffer)) | |
ce3ba12c | 675 | (bs--restore-window-config)) |
6448a6b3 GM |
676 | |
677 | (defun bs-abort () | |
678 | "Ding and leave Buffer Selection Menu without a selection." | |
dc7904f5 | 679 | (interactive) |
6448a6b3 GM |
680 | (ding) |
681 | (bs-kill)) | |
682 | ||
683 | (defun bs-set-configuration-and-refresh () | |
684 | "Ask user for a configuration and apply selected configuration. | |
685 | Refresh 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 | ||
6448a6b3 GM |
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) | |
ca6b8248 | 698 | (fit-window-to-buffer (selected-window) bs-max-window-height))) |
6448a6b3 GM |
699 | |
700 | (defun bs--current-buffer () | |
701 | "Return buffer on current line. | |
880ed9f1 | 702 | Raise an error if not on a buffer line." |
6448a6b3 GM |
703 | (beginning-of-line) |
704 | (let ((line (+ (- bs-header-lines-length) | |
dc7904f5 | 705 | (count-lines 1 (point))))) |
6448a6b3 | 706 | (if (< line 0) |
dc7904f5 | 707 | (error "You are on a header row")) |
6448a6b3 GM |
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)) | |
dc7904f5 | 713 | (inhibit-read-only t)) |
6448a6b3 GM |
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. | |
721 | Leave 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. | |
727 | If there are no marked buffers the window configuration before starting | |
728 | Buffer Selectin Menu will be restored. | |
729 | If there are marked buffers each marked buffer and the current line's buffer | |
730 | will be selected in a window. | |
731 | Leave Buffer Selection Menu." | |
732 | (interactive) | |
733 | (let ((buffer (bs--current-buffer))) | |
734 | (bury-buffer (current-buffer)) | |
ce3ba12c | 735 | (bs--restore-window-config) |
6448a6b3 GM |
736 | (switch-to-buffer buffer) |
737 | (if bs--marked-buffers | |
dc7904f5 DL |
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))))) | |
6448a6b3 GM |
750 | |
751 | (defun bs-select-other-window () | |
752 | "Select current line's buffer by `switch-to-buffer-other-window'. | |
753 | The window configuration before starting Buffer Selectin Menu will be restored | |
754 | unless there is no other window. In this case a new window will be created. | |
755 | Leave Buffer Selection Menu." | |
756 | (interactive) | |
757 | (let ((buffer (bs--current-buffer))) | |
758 | (bury-buffer (current-buffer)) | |
ce3ba12c | 759 | (bs--restore-window-config) |
6448a6b3 GM |
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. | |
764 | The 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. | |
771 | Leave Buffer Selection Menu." | |
772 | (interactive) | |
773 | (let ((buffer (bs--current-buffer))) | |
774 | (bury-buffer (current-buffer)) | |
ce3ba12c | 775 | (bs--restore-window-config) |
6448a6b3 GM |
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. | |
780 | Leave Buffer Selection Menu. | |
781 | EVENT: 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. | |
788 | Select 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. | |
795 | Leave 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. | |
817 | See `visit-tags-table'." | |
818 | (interactive) | |
819 | (let ((file (buffer-file-name (bs--current-buffer)))) | |
820 | (if file | |
dc7904f5 | 821 | (visit-tags-table file) |
6448a6b3 GM |
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)) | |
dc7904f5 | 828 | res) |
6448a6b3 GM |
829 | (save-excursion |
830 | (set-buffer buffer) | |
831 | (setq res (cond ((null bs-buffer-show-mark) | |
dc7904f5 DL |
832 | 'never) |
833 | ((eq bs-buffer-show-mark 'never) | |
834 | 'always) | |
835 | (t nil))) | |
6448a6b3 GM |
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'. | |
843 | NOT-TO-SHOW-P: prefix argument. | |
844 | With no prefix argument the buffer on current line is marked to show | |
845 | always. Otherwise it is marked to show never." | |
846 | (interactive "P") | |
847 | (if not-to-show-p | |
848 | (bs-set-current-buffer-to-show-never) | |
849 | (bs--set-toggle-to-show (bs--current-buffer) 'always))) | |
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. | |
858 | Redisplay current line and display a message describing | |
859 | the status of buffer on current line." | |
e64dbd8b | 860 | (with-current-buffer buffer (setq bs-buffer-show-mark what)) |
6448a6b3 GM |
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. | |
867 | COUNT is the number of buffers to mark. | |
868 | Move cursor vertically down COUNT lines." | |
869 | (interactive "p") | |
870 | (let ((dir (if (> count 0) 1 -1)) | |
dc7904f5 | 871 | (count (abs count))) |
6448a6b3 GM |
872 | (while (> count 0) |
873 | (let ((buffer (bs--current-buffer))) | |
dc7904f5 DL |
874 | (if buffer |
875 | (setq bs--marked-buffers (cons buffer bs--marked-buffers))) | |
876 | (bs--update-current-line) | |
877 | (bs-down dir)) | |
6448a6b3 GM |
878 | (setq count (1- count))))) |
879 | ||
880 | (defun bs-unmark-current (count) | |
881 | "Unmark buffers. | |
882 | COUNT is the number of buffers to unmark. | |
883 | Move cursor vertically down COUNT lines." | |
884 | (interactive "p") | |
885 | (let ((dir (if (> count 0) 1 -1)) | |
dc7904f5 | 886 | (count (abs count))) |
6448a6b3 GM |
887 | (while (> count 0) |
888 | (let ((buffer (bs--current-buffer))) | |
dc7904f5 DL |
889 | (if buffer |
890 | (setq bs--marked-buffers (delq buffer bs--marked-buffers))) | |
891 | (bs--update-current-line) | |
892 | (bs-down dir)) | |
6448a6b3 GM |
893 | (setq count (1- count))))) |
894 | ||
895 | (defun bs--show-config-message (what) | |
896 | "Show message indicating the new showing status WHAT. | |
897 | WHAT is a value of nil, `never', or `always'." | |
898 | (bs-message-without-log (cond ((null what) | |
dc7904f5 DL |
899 | "Buffer will be shown normally.") |
900 | ((eq what 'never) | |
901 | "Mark buffer to never be shown.") | |
902 | (t "Mark buffer to show always.")))) | |
6448a6b3 GM |
903 | |
904 | (defun bs-delete () | |
905 | "Kill buffer on current line." | |
906 | (interactive) | |
907 | (let ((current (bs--current-buffer)) | |
dc7904f5 | 908 | (inhibit-read-only t)) |
706e6a52 EZ |
909 | (unless (kill-buffer current) |
910 | (error "Buffer was not deleted")) | |
6448a6b3 | 911 | (setq bs-current-list (delq current bs-current-list)) |
6448a6b3 GM |
912 | (beginning-of-line) |
913 | (delete-region (point) (save-excursion | |
dc7904f5 DL |
914 | (end-of-line) |
915 | (if (eobp) (point) (1+ (point))))) | |
6448a6b3 | 916 | (if (eobp) |
dc7904f5 DL |
917 | (progn |
918 | (backward-delete-char 1) | |
919 | (beginning-of-line) | |
920 | (recenter -1))) | |
6448a6b3 GM |
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 | |
dc7904f5 | 929 | (bs-up 1)))) |
6448a6b3 GM |
930 | |
931 | (defun bs-show-sorted () | |
932 | "Show buffer list sorted by buffer name." | |
933 | (interactive) | |
934 | (setq bs--current-sort-function | |
dc7904f5 DL |
935 | (bs-next-config-aux (car bs--current-sort-function) |
936 | bs-sort-functions)) | |
6448a6b3 GM |
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. | |
943 | SORT-DESCRIPTION is an element of `bs-sort-functions'. | |
944 | Default is `bs--current-sort-function'." | |
945 | (let ((sort-description (or sort-description | |
dc7904f5 | 946 | bs--current-sort-function))) |
6448a6b3 GM |
947 | (save-excursion |
948 | (goto-char (point-min)) | |
6968a481 EZ |
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))))))) | |
6448a6b3 GM |
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. | |
880ed9f1 | 968 | Uses function `vc-toggle-read-only'." |
6448a6b3 GM |
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. | |
1001 | If on top of buffer list go to last line." | |
ca6b8248 JB |
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))) | |
6448a6b3 GM |
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. | |
1017 | If at end of buffer list go to first line." | |
ca6b8248 JB |
1018 | (if (eq (line-end-position) (point-max)) |
1019 | (goto-line (1+ bs-header-lines-length)) | |
1020 | (forward-line 1))) | |
6448a6b3 GM |
1021 | |
1022 | (defun bs-visits-non-file (buffer) | |
1023 | "Return t or nil whether BUFFER visits no file. | |
1024 | A value of t means BUFFER belongs to no file. | |
1025 | A 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) | |
880ed9f1 | 1029 | "Function for sorting internal buffers B1 and B2 at the end of all buffers." |
6448a6b3 GM |
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. | |
1038 | These 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 | |
dc7904f5 DL |
1042 | bs-must-show-regexp nil |
1043 | bs-dont-show-function nil | |
1044 | bs-must-show-function nil | |
1045 | bs-buffer-sort-function nil)) | |
6448a6b3 GM |
1046 | |
1047 | (defun bs-config--only-files () | |
1048 | "Define a configuration for showing only buffers visiting a file." | |
1049 | (bs-config-clear) | |
880ed9f1 | 1050 | (setq ;; I want to see *-buffers at the end |
dc7904f5 DL |
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)) | |
6448a6b3 GM |
1054 | |
1055 | (defun bs-config--files-and-scratch () | |
1056 | "Define a configuration for showing buffer *scratch* and file buffers." | |
1057 | (bs-config-clear) | |
880ed9f1 | 1058 | (setq ;; I want to see *-buffers at the end |
dc7904f5 DL |
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. | |
880ed9f1 | 1063 | bs-must-show-regexp "^\\*scratch\\*$")) |
6448a6b3 GM |
1064 | |
1065 | (defun bs-config--all () | |
1066 | "Define a configuration for showing all buffers. | |
1067 | Reset 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. | |
880ed9f1 | 1072 | Internal buffers appear at end of all buffers." |
6448a6b3 GM |
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'. | |
1079 | When called interactively ask user for a configuration and apply selected | |
1080 | configuration." | |
1081 | (interactive (list (completing-read "Use configuration: " | |
dc7904f5 DL |
1082 | bs-configurations |
1083 | nil | |
1084 | t))) | |
6448a6b3 GM |
1085 | (let ((list (assoc name bs-configurations))) |
1086 | (if list | |
dc7904f5 DL |
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))) | |
6448a6b3 GM |
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. | |
1107 | Will return the first if START-NAME is at end." | |
1108 | (let ((assocs list) | |
dc7904f5 DL |
1109 | (length (length list)) |
1110 | pos) | |
6448a6b3 GM |
1111 | (while (and assocs (not pos)) |
1112 | (if (string= (car (car assocs)) start-name) | |
dc7904f5 | 1113 | (setq pos (- length (length assocs)))) |
6448a6b3 GM |
1114 | (setq assocs (cdr assocs))) |
1115 | (setq pos (1+ pos)) | |
1116 | (if (eq pos length) | |
dc7904f5 | 1117 | (car list) |
6448a6b3 GM |
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. | |
1126 | If START-NAME is nil the current configuration `bs-current-configuration' | |
1127 | will 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) | |
880ed9f1 | 1134 | (bs-message-without-log "Selected configuration: %s" (car config)))) |
6448a6b3 GM |
1135 | |
1136 | (defun bs-show-in-buffer (list) | |
1137 | "Display buffer list LIST in buffer *buffer-selection*. | |
1138 | Select buffer *buffer-selection* and display buffers according to current | |
1139 | configuration `bs-current-configuration'. Set window height, fontify buffer | |
1140 | and 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) | |
dc7904f5 DL |
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)))) | |
6448a6b3 GM |
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) | |
310a26be JB |
1163 | (bs-apply-sort-faces) |
1164 | (set-buffer-modified-p nil))) | |
6448a6b3 GM |
1165 | |
1166 | (defun bs-next-buffer (&optional buffer-list sorting-p) | |
1167 | "Return next buffer and buffer list for buffer cycling in BUFFER-LIST. | |
1168 | Ignore sorting when SORTING-P is nil. | |
1169 | If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as | |
1170 | buffer list. The result is a cons of normally the second element of | |
1171 | BUFFER-LIST and the buffer list used for buffer cycling." | |
1172 | (let* ((bs--current-sort-function (if sorting-p | |
dc7904f5 DL |
1173 | bs--current-sort-function)) |
1174 | (bs-buffer-list (or buffer-list (bs-buffer-list)))) | |
6448a6b3 | 1175 | (cons (or (car (cdr bs-buffer-list)) |
dc7904f5 DL |
1176 | (car bs-buffer-list) |
1177 | (current-buffer)) | |
1178 | bs-buffer-list))) | |
6448a6b3 GM |
1179 | |
1180 | (defun bs-previous-buffer (&optional buffer-list sorting-p) | |
1181 | "Return previous buffer and buffer list for buffer cycling in BUFFER-LIST. | |
1182 | Ignore sorting when SORTING-P is nil. | |
1183 | If BUFFER-LIST is nil the result of `bs-buffer-list' will be used as | |
1184 | buffer list. The result is a cons of last element of BUFFER-LIST and the | |
1185 | buffer list used for buffer cycling." | |
1186 | (let* ((bs--current-sort-function (if sorting-p | |
dc7904f5 DL |
1187 | bs--current-sort-function)) |
1188 | (bs-buffer-list (or buffer-list (bs-buffer-list)))) | |
6448a6b3 | 1189 | (cons (or (car (last bs-buffer-list)) |
dc7904f5 DL |
1190 | (current-buffer)) |
1191 | bs-buffer-list))) | |
6448a6b3 GM |
1192 | |
1193 | (defun bs-message-without-log (&rest args) | |
1194 | "Like `message' but don't log it on the message log. | |
a1d5a11b | 1195 | All arguments ARGS are transferred to function `message'." |
6448a6b3 GM |
1196 | (let ((message-log-max nil)) |
1197 | (apply 'message args))) | |
1198 | ||
1199 | (defvar bs--cycle-list nil | |
880ed9f1 | 1200 | "Current buffer list used for cycling.") |
6448a6b3 GM |
1201 | |
1202 | ;;;###autoload | |
1203 | (defun bs-cycle-next () | |
1204 | "Select next buffer defined by buffer cycling. | |
1205 | The buffers taking part in buffer cycling are defined | |
1206 | by buffer configuration `bs-cycle-configuration-name'." | |
1207 | (interactive) | |
1208 | (let ((bs--buffer-coming-from (current-buffer)) | |
dc7904f5 DL |
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) | |
038e04cb GM |
1213 | (bs--show-all nil)) |
1214 | (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration)) | |
6448a6b3 | 1215 | (let ((bs-buffer-sort-function nil) |
dc7904f5 | 1216 | (bs--current-sort-function nil)) |
6448a6b3 | 1217 | (let* ((tupel (bs-next-buffer (if (or (eq last-command |
dc7904f5 DL |
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))) | |
b49bf494 CY |
1224 | (unless (window-dedicated-p (selected-window)) |
1225 | ;; We don't want the frame iconified if the only window in the frame | |
1226 | ;; happens to be dedicated; let's get the error from switch-to-buffer | |
1227 | (bury-buffer)) | |
1228 | (switch-to-buffer next) | |
dc7904f5 DL |
1229 | (setq bs--cycle-list (append (cdr cycle-list) |
1230 | (list (car cycle-list)))) | |
dc7904f5 DL |
1231 | (bs-message-without-log "Next buffers: %s" |
1232 | (or (cdr bs--cycle-list) | |
1233 | "this buffer")))))) | |
6448a6b3 | 1234 | |
6448a6b3 GM |
1235 | ;;;###autoload |
1236 | (defun bs-cycle-previous () | |
1237 | "Select previous buffer defined by buffer cycling. | |
1238 | The buffers taking part in buffer cycling are defined | |
1239 | by buffer configuration `bs-cycle-configuration-name'." | |
1240 | (interactive) | |
1241 | (let ((bs--buffer-coming-from (current-buffer)) | |
dc7904f5 DL |
1242 | (bs-dont-show-regexp bs-dont-show-regexp) |
1243 | (bs-must-show-regexp bs-must-show-regexp) | |
1244 | (bs-dont-show-function bs-dont-show-function) | |
1245 | (bs-must-show-function bs-must-show-function) | |
038e04cb GM |
1246 | (bs--show-all nil)) |
1247 | (bs-set-configuration (or bs-cycle-configuration-name bs-default-configuration)) | |
6448a6b3 | 1248 | (let ((bs-buffer-sort-function nil) |
dc7904f5 | 1249 | (bs--current-sort-function nil)) |
6448a6b3 | 1250 | (let* ((tupel (bs-previous-buffer (if (or (eq last-command |
dc7904f5 DL |
1251 | 'bs-cycle-next) |
1252 | (eq last-command | |
1253 | 'bs-cycle-previous)) | |
1254 | bs--cycle-list))) | |
1255 | (prev-buffer (car tupel)) | |
1256 | (cycle-list (cdr tupel))) | |
b49bf494 | 1257 | (switch-to-buffer prev-buffer) |
dc7904f5 DL |
1258 | (setq bs--cycle-list (append (last cycle-list) |
1259 | (reverse (cdr (reverse cycle-list))))) | |
dc7904f5 DL |
1260 | (bs-message-without-log "Previous buffers: %s" |
1261 | (or (reverse (cdr bs--cycle-list)) | |
1262 | "this buffer")))))) | |
6448a6b3 GM |
1263 | |
1264 | (defun bs--get-value (fun &optional args) | |
1265 | "Apply function FUN with arguments ARGS. | |
1266 | Return result of evaluation. Will return FUN if FUN is a number | |
1267 | or a string." | |
1268 | (cond ((numberp fun) | |
dc7904f5 DL |
1269 | fun) |
1270 | ((stringp fun) | |
1271 | fun) | |
1272 | (t (apply fun args)))) | |
6448a6b3 GM |
1273 | |
1274 | (defun bs--get-marked-string (start-buffer all-buffers) | |
1275 | "Return a string which describes whether current buffer is marked. | |
1276 | START-BUFFER is the buffer where we started buffer selection. | |
1277 | ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu. | |
1278 | The result string is one of `bs-string-current', `bs-string-current-marked', | |
1279 | `bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or | |
1280 | `bs-string-show-always'." | |
880ed9f1 | 1281 | (cond ;; current buffer is the buffer we started buffer selection. |
dc7904f5 DL |
1282 | ((eq (current-buffer) start-buffer) |
1283 | (if (memq (current-buffer) bs--marked-buffers) | |
1284 | bs-string-current-marked ; buffer is marked | |
1285 | bs-string-current)) | |
1286 | ;; current buffer is marked | |
1287 | ((memq (current-buffer) bs--marked-buffers) | |
1288 | bs-string-marked) | |
1289 | ;; current buffer hasn't a special mark. | |
1290 | ((null bs-buffer-show-mark) | |
1291 | bs-string-show-normally) | |
1292 | ;; current buffer has a mark not to show itself. | |
1293 | ((eq bs-buffer-show-mark 'never) | |
1294 | bs-string-show-never) | |
1295 | ;; otherwise current buffer is marked to show always. | |
1296 | (t | |
1297 | bs-string-show-always))) | |
6448a6b3 GM |
1298 | |
1299 | (defun bs--get-modified-string (start-buffer all-buffers) | |
1300 | "Return a string which describes whether current buffer is modified. | |
1301 | START-BUFFER is the buffer where we started buffer selection. | |
1302 | ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu." | |
1303 | (if (buffer-modified-p) "*" " ")) | |
1304 | ||
1305 | (defun bs--get-readonly-string (start-buffer all-buffers) | |
1306 | "Return a string which describes whether current buffer is read only. | |
1307 | START-BUFFER is the buffer where we started buffer selection. | |
1308 | ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu." | |
1309 | (if buffer-read-only "%" " ")) | |
1310 | ||
1311 | (defun bs--get-size-string (start-buffer all-buffers) | |
1312 | "Return a string which describes the size of current buffer. | |
1313 | START-BUFFER is the buffer where we started buffer selection. | |
1314 | ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu." | |
1315 | (int-to-string (buffer-size))) | |
1316 | ||
1317 | (defun bs--get-name (start-buffer all-buffers) | |
1318 | "Return name of current buffer for Buffer Selection Menu. | |
1319 | The name of current buffer gets additional text properties | |
1320 | for mouse highlighting. | |
1321 | START-BUFFER is the buffer where we started buffer selection. | |
1322 | ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu." | |
635ed242 JB |
1323 | (propertize (buffer-name) |
1324 | 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame" | |
1325 | 'mouse-face 'highlight)) | |
6448a6b3 | 1326 | |
6448a6b3 GM |
1327 | (defun bs--get-mode-name (start-buffer all-buffers) |
1328 | "Return the name of mode of current buffer for Buffer Selection Menu. | |
1329 | START-BUFFER is the buffer where we started buffer selection. | |
1330 | ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu." | |
1331 | mode-name) | |
1332 | ||
1333 | (defun bs--get-file-name (start-buffer all-buffers) | |
1334 | "Return string for column 'File' in Buffer Selection Menu. | |
1335 | This is the variable `buffer-file-name' of current buffer. | |
00a9f6a5 | 1336 | If current mode is `dired-mode' or `shell-mode' it returns the |
6448a6b3 GM |
1337 | default directory. |
1338 | START-BUFFER is the buffer where we started buffer selection. | |
1339 | ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu." | |
310a26be JB |
1340 | (propertize (if (member major-mode '(shell-mode dired-mode)) |
1341 | default-directory | |
1342 | (or buffer-file-name "")) | |
1343 | 'mouse-face 'highlight | |
1344 | 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame")) | |
6448a6b3 | 1345 | |
6448a6b3 GM |
1346 | (defun bs--insert-one-entry (buffer) |
1347 | "Generate one entry for buffer BUFFER in Buffer Selection Menu. | |
1348 | It goes over all columns described in `bs-attributes-list' | |
1349 | and evaluates corresponding string. Inserts string in current buffer; | |
1350 | normally *buffer-selection*." | |
1351 | (let ((string "") | |
dc7904f5 DL |
1352 | (columns bs-attributes-list) |
1353 | (to-much 0) | |
6448a6b3 GM |
1354 | (apply-args (append (list bs--buffer-coming-from bs-current-list)))) |
1355 | (save-excursion | |
1356 | (while columns | |
dc7904f5 DL |
1357 | (set-buffer buffer) |
1358 | (let ((min (bs--get-value (nth 1 (car columns)))) | |
1359 | ;;(max (bs--get-value (nth 2 (car columns)))) refered no more | |
1360 | (align (nth 3 (car columns))) | |
1361 | (fun (nth 4 (car columns))) | |
1362 | (val nil) | |
1363 | new-string) | |
1364 | (setq val (bs--get-value fun apply-args)) | |
1365 | (setq new-string (bs--format-aux val align (- min to-much))) | |
1366 | (setq string (concat string new-string)) | |
1367 | (if (> (length new-string) min) | |
1368 | (setq to-much (- (length new-string) min))) | |
1369 | ) ; let | |
1370 | (setq columns (cdr columns)))) | |
6448a6b3 GM |
1371 | (insert string) |
1372 | string)) | |
1373 | ||
1374 | (defun bs--format-aux (string align len) | |
1375 | "Generate a string with STRING with alignment ALIGN and length LEN. | |
1376 | ALIGN is one of the symbols `left', `middle', or `right'." | |
635ed242 JB |
1377 | (let* ((width (length string)) |
1378 | (len (max len width))) | |
1379 | (format (format "%%%s%ds" (if (eq align 'right) "" "-") len) | |
1380 | (if (eq align 'middle) | |
1381 | (concat (make-string (/ (- len width) 2) ?\s) string) | |
1382 | string)))) | |
6448a6b3 GM |
1383 | |
1384 | (defun bs--show-header () | |
1385 | "Insert header for Buffer Selection Menu in current buffer." | |
1386 | (mapcar '(lambda (string) | |
dc7904f5 DL |
1387 | (insert string "\n")) |
1388 | (bs--create-header))) | |
6448a6b3 GM |
1389 | |
1390 | (defun bs--get-name-length () | |
1391 | "Return value of `bs--name-entry-length'." | |
1392 | bs--name-entry-length) | |
1393 | ||
1394 | (defun bs--create-header () | |
1395 | "Return all header lines used in Buffer Selection Menu as a list of strings." | |
1396 | (list (mapconcat (lambda (column) | |
dc7904f5 DL |
1397 | (bs--format-aux (bs--get-value (car column)) |
1398 | (nth 3 column) ; align | |
1399 | (bs--get-value (nth 1 column)))) | |
1400 | bs-attributes-list | |
1401 | "") | |
1402 | (mapconcat (lambda (column) | |
1403 | (let ((length (length (bs--get-value (car column))))) | |
1404 | (bs--format-aux (make-string length ?-) | |
1405 | (nth 3 column) ; align | |
1406 | (bs--get-value (nth 1 column))))) | |
1407 | bs-attributes-list | |
1408 | ""))) | |
6448a6b3 GM |
1409 | |
1410 | (defun bs--show-with-configuration (name &optional arg) | |
880ed9f1 | 1411 | "Display buffer list of configuration with name NAME. |
6448a6b3 GM |
1412 | Set configuration NAME and determine window for Buffer Selection Menu. |
1413 | Unless current buffer is buffer *buffer-selection* we have to save | |
1414 | the buffer we started Buffer Selection Menu and the current window | |
1415 | configuration to restore buffer and window configuration after a | |
1416 | selection. If there is already a window displaying *buffer-selection* | |
1417 | select this window for Buffer Selection Menu. Otherwise open a new | |
1418 | window. | |
1419 | The optional argument ARG is the prefix argument when calling a function | |
1420 | for buffer selection." | |
1421 | (bs-set-configuration name) | |
1422 | (let ((bs--show-all (or bs--show-all arg))) | |
dc7904f5 | 1423 | (unless (string= "*buffer-selection*" (buffer-name)) |
6448a6b3 GM |
1424 | ;; Only when not in buffer *buffer-selection* |
1425 | ;; we have to set the buffer we started the command | |
ce3ba12c | 1426 | (setq bs--buffer-coming-from (current-buffer))) |
dc7904f5 | 1427 | (let ((liste (bs-buffer-list)) |
edf6fbc5 JB |
1428 | (active-window (get-window-with-predicate |
1429 | (lambda (w) | |
1430 | (string= (buffer-name (window-buffer w)) | |
1431 | "*buffer-selection*"))))) | |
dc7904f5 DL |
1432 | (if active-window |
1433 | (select-window active-window) | |
ce3ba12c JB |
1434 | (modify-frame-parameters nil |
1435 | (list (cons 'bs--window-config-coming-from | |
1436 | (current-window-configuration)))) | |
1437 | (when (> (window-height (selected-window)) 7) | |
1438 | (split-window-vertically) | |
1439 | (other-window 1))) | |
dc7904f5 DL |
1440 | (bs-show-in-buffer liste) |
1441 | (bs-message-without-log "%s" (bs--current-config-message))))) | |
6448a6b3 GM |
1442 | |
1443 | (defun bs--configuration-name-for-prefix-arg (prefix-arg) | |
1444 | "Convert prefix argument PREFIX-ARG to a name of a buffer configuration. | |
1445 | If PREFIX-ARG is nil return `bs-default-configuration'. | |
1446 | If PREFIX-ARG is an integer return PREFIX-ARG element of `bs-configurations'. | |
1447 | Otherwise return `bs-alternative-configuration'." | |
880ed9f1 | 1448 | (cond ;; usually activation |
dc7904f5 DL |
1449 | ((null prefix-arg) |
1450 | bs-default-configuration) | |
1451 | ;; call with integer as prefix argument | |
1452 | ((integerp prefix-arg) | |
1453 | (if (and (< 0 prefix-arg) (<= prefix-arg (length bs-configurations))) | |
1454 | (car (nth (1- prefix-arg) bs-configurations)) | |
1455 | bs-default-configuration)) | |
1456 | ;; call by prefix argument C-u | |
1457 | (t bs-alternative-configuration))) | |
6448a6b3 GM |
1458 | |
1459 | ;; ---------------------------------------------------------------------- | |
1460 | ;; Main function bs-customize and bs-show | |
1461 | ;; ---------------------------------------------------------------------- | |
1462 | ||
1463 | ;;;###autoload | |
1464 | (defun bs-customize () | |
1465 | "Customization of group bs for Buffer Selection Menu." | |
1466 | (interactive) | |
1467 | (customize-group "bs")) | |
1468 | ||
1469 | ;;;###autoload | |
1470 | (defun bs-show (arg) | |
dc7904f5 | 1471 | "Make a menu of buffers so you can manipulate buffers or the buffer list. |
6448a6b3 GM |
1472 | \\<bs-mode-map> |
1473 | There are many key commands similar to `Buffer-menu-mode' for | |
1474 | manipulating buffer list and buffers itself. | |
1475 | User can move with [up] or [down], select a buffer | |
1476 | by \\[bs-select] or [SPC]\n | |
1477 | Type \\[bs-kill] to leave Buffer Selection Menu without a selection. | |
1478 | Type \\[bs-help] after invocation to get help on commands available. | |
1479 | With prefix argument ARG show a different buffer list. Function | |
1480 | `bs--configuration-name-for-prefix-arg' determine accordingly | |
1481 | name of buffer configuration." | |
1482 | (interactive "P") | |
1483 | (setq bs--marked-buffers nil) | |
1484 | (bs--show-with-configuration (bs--configuration-name-for-prefix-arg arg))) | |
1485 | ||
d8754ce5 | 1486 | ;; Now provide feature bs |
6448a6b3 GM |
1487 | (provide 'bs) |
1488 | ||
ab5796a9 | 1489 | ;;; arch-tag: c0d9ab34-bf06-4368-ae9d-af88878e6802 |
6448a6b3 | 1490 | ;;; bs.el ends here |