Add 2010 to copyright years.
[bpt/emacs.git] / lisp / buff-menu.el
CommitLineData
5e684428 1;;; buff-menu.el --- buffer menu main function and support functions -*- coding:utf-8 -*-
c0274f38 2
f4872033 3;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 2000, 2001, 2002, 2003,
114f9c96 4;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
2dd96f23 5
9750e079 6;; Maintainer: FSF
6d6c3f84 7;; Keywords: convenience
9750e079 8
2dd96f23
JB
9;; This file is part of GNU Emacs.
10
eb3fa2cf 11;; GNU Emacs is free software: you can redistribute it and/or modify
2dd96f23 12;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
2dd96f23
JB
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
eb3fa2cf 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
2dd96f23 23
e41b2db1
ER
24;;; Commentary:
25
26;; Edit, delete, or change attributes of all currently active Emacs
eb8c3be9 27;; buffers from a list summarizing their state. A good way to browse
e41b2db1 28;; any special or scratch buffers you have loaded, since you can't find
6d6c3f84 29;; them by filename. The single entry point is `list-buffers',
86dbbfc2
ER
30;; normally bound to C-x C-b.
31
32;;; Change Log:
33
42a19c2a
RS
34;; Buffer-menu-view: New function
35;; Buffer-menu-view-other-window: New function
36
86dbbfc2
ER
37;; Merged by esr with recent mods to Emacs 19 buff-menu, 23 Mar 1993
38;;
86dbbfc2
ER
39;; Modified by Bob Weiner, Motorola, Inc., 4/14/89
40;;
41;; Added optional backup argument to 'Buffer-menu-unmark' to make it undelete
42;; current entry and then move to previous one.
43;;
44;; Based on FSF code dating back to 1985.
e41b2db1 45
5de9bdab 46;;; Code:
10e1dad9 47
d5aacb46
SM
48;;Trying to preserve the old window configuration works well in
49;;simple scenarios, when you enter the buffer menu, use it, and exit it.
50;;But it does strange things when you switch back to the buffer list buffer
51;;with C-x b, later on, when the window configuration is different.
52;;The choice seems to be, either restore the window configuration
53;;in all cases, or in no cases.
54;;I decided it was better not to restore the window config at all. -- rms.
08c82d4d 55
d5aacb46
SM
56;;But since then, I changed buffer-menu to use the selected window,
57;;so q now once again goes back to the previous window configuration.
08c82d4d 58
d5aacb46
SM
59;;(defvar Buffer-menu-window-config nil
60;; "Window configuration saved from entry to `buffer-menu'.")
2dd96f23 61
d5aacb46
SM
62;; Put buffer *Buffer List* into proper mode right away
63;; so that from now on even list-buffers is enough to get a buffer menu.
2dd96f23 64
bc7bb432
JB
65(defgroup Buffer-menu nil
66 "Show a menu of all buffers in a buffer."
67 :group 'tools
68 :group 'convenience)
69
70(defcustom Buffer-menu-use-header-line t
9201cc28 71 "Non-nil means to use an immovable header-line."
bc7bb432
JB
72 :type 'boolean
73 :group 'Buffer-menu)
74
d247d0fe 75(defface buffer-menu-buffer
bc7bb432 76 '((t (:weight bold)))
d247d0fe 77 "Face used to highlight buffer names in the buffer menu."
2a8f2d4c 78 :group 'Buffer-menu)
d247d0fe 79(put 'Buffer-menu-buffer 'face-alias 'buffer-menu-buffer)
bc7bb432 80
4f0992b3 81(defcustom Buffer-menu-buffer+size-width 26
9201cc28 82 "How wide to jointly make the buffer name and size columns."
bc7bb432
JB
83 :type 'number
84 :group 'Buffer-menu)
85
4f0992b3 86(defcustom Buffer-menu-mode-width 16
9201cc28 87 "How wide to make the mode name column."
bc7bb432
JB
88 :type 'number
89 :group 'Buffer-menu)
90
3ce5f932
LT
91(defcustom Buffer-menu-use-frame-buffer-list t
92 "If non-nil, the Buffer Menu uses the selected frame's buffer list.
93Buffers that were never selected in that frame are listed at the end.
94If the value is nil, the Buffer Menu uses the global buffer list.
95This variable matters if the Buffer Menu is sorted by visited order,
96as it is by default."
97 :type 'boolean
98 :group 'Buffer-menu
99 :version "22.1")
100
d5aacb46 101;; This should get updated & resorted when you click on a column heading
bc7bb432 102(defvar Buffer-menu-sort-column nil
84bbd894
RS
103 "Which column to sort the menu on.
104Use 2 to sort by buffer names, or 5 to sort by file names.
392225ee 105A nil value means sort by visited order (the default).")
bc7bb432
JB
106
107(defconst Buffer-menu-buffer-column 4)
e5ea316b 108
7b0a86ab
LT
109(defvar Buffer-menu-files-only nil
110 "Non-nil if the current buffer-menu lists only file buffers.
111This variable determines whether reverting the buffer lists only
112file buffers. It affects both manual reverting and reverting by
113Auto Revert Mode.")
114
392225ee
JB
115(make-variable-buffer-local 'Buffer-menu-files-only)
116
fb5614e8 117(defvar Info-current-file) ;; from info.el
b653cee4 118(defvar Info-current-node) ;; from info.el
fb5614e8 119
392225ee 120(defvar Buffer-menu-mode-map
6a6baf11
DN
121 (let ((map (make-keymap))
122 (menu-map (make-sparse-keymap)))
392225ee 123 (suppress-keymap map t)
392225ee
JB
124 (define-key map "v" 'Buffer-menu-select)
125 (define-key map "2" 'Buffer-menu-2-window)
126 (define-key map "1" 'Buffer-menu-1-window)
127 (define-key map "f" 'Buffer-menu-this-window)
128 (define-key map "e" 'Buffer-menu-this-window)
129 (define-key map "\C-m" 'Buffer-menu-this-window)
130 (define-key map "o" 'Buffer-menu-other-window)
131 (define-key map "\C-o" 'Buffer-menu-switch-other-window)
132 (define-key map "s" 'Buffer-menu-save)
133 (define-key map "d" 'Buffer-menu-delete)
134 (define-key map "k" 'Buffer-menu-delete)
135 (define-key map "\C-d" 'Buffer-menu-delete-backwards)
136 (define-key map "\C-k" 'Buffer-menu-delete)
137 (define-key map "x" 'Buffer-menu-execute)
138 (define-key map " " 'next-line)
139 (define-key map "n" 'next-line)
140 (define-key map "p" 'previous-line)
141 (define-key map "\177" 'Buffer-menu-backup-unmark)
142 (define-key map "~" 'Buffer-menu-not-modified)
392225ee
JB
143 (define-key map "u" 'Buffer-menu-unmark)
144 (define-key map "m" 'Buffer-menu-mark)
145 (define-key map "t" 'Buffer-menu-visit-tags-table)
146 (define-key map "%" 'Buffer-menu-toggle-read-only)
147 (define-key map "b" 'Buffer-menu-bury)
392225ee
JB
148 (define-key map "V" 'Buffer-menu-view)
149 (define-key map "T" 'Buffer-menu-toggle-files-only)
150 (define-key map [mouse-2] 'Buffer-menu-mouse-select)
151 (define-key map [follow-link] 'mouse-face)
9cda680d
JL
152 (define-key map (kbd "M-s a C-s") 'Buffer-menu-isearch-buffers)
153 (define-key map (kbd "M-s a M-C-s") 'Buffer-menu-isearch-buffers-regexp)
c9753fb4 154 (define-key map [menu-bar Buffer-menu-mode] (cons (purecopy "Buffer-Menu") menu-map))
6a6baf11 155 (define-key menu-map [quit]
905a9ed3 156 `(menu-item ,(purecopy "Quit") quit-window
c9753fb4 157 :help ,(purecopy "Remove the buffer menu from the display")))
6a6baf11 158 (define-key menu-map [rev]
905a9ed3
DN
159 `(menu-item ,(purecopy "Refresh") revert-buffer
160 :help ,(purecopy "Refresh the *Buffer List* buffer contents")))
a3c20c83 161 (define-key menu-map [s0] menu-bar-separator)
6a6baf11 162 (define-key menu-map [tf]
905a9ed3 163 `(menu-item ,(purecopy "Show only file buffers") Buffer-menu-toggle-files-only
6a6baf11 164 :button (:toggle . Buffer-menu-files-only)
905a9ed3 165 :help ,(purecopy "Toggle whether the current buffer-menu displays only file buffers")))
a3c20c83 166 (define-key menu-map [s1] menu-bar-separator)
6a6baf11
DN
167 ;; FIXME: The "Select" entries could use better names...
168 (define-key menu-map [sel]
905a9ed3
DN
169 `(menu-item ,(purecopy "Select marked") Buffer-menu-select
170 :help ,(purecopy "Select this line's buffer; also display buffers marked with `>'")))
6a6baf11 171 (define-key menu-map [bm2]
905a9ed3
DN
172 `(menu-item ,(purecopy "Select two") Buffer-menu-2-window
173 :help ,(purecopy "Select this line's buffer, with previous buffer in second window")))
6a6baf11 174 (define-key menu-map [bm1]
905a9ed3
DN
175 `(menu-item ,(purecopy "Select current") Buffer-menu-1-window
176 :help ,(purecopy "Select this line's buffer, alone, in full frame")))
6a6baf11 177 (define-key menu-map [ow]
905a9ed3
DN
178 `(menu-item ,(purecopy "Select in other window") Buffer-menu-other-window
179 :help ,(purecopy "Select this line's buffer in other window, leaving buffer menu visible")))
6a6baf11 180 (define-key menu-map [tw]
905a9ed3
DN
181 `(menu-item ,(purecopy "Select in current window") Buffer-menu-this-window
182 :help ,(purecopy "Select this line's buffer in this window")))
a3c20c83 183 (define-key menu-map [s2] menu-bar-separator)
6a6baf11 184 (define-key menu-map [is]
905a9ed3
DN
185 `(menu-item ,(purecopy "Regexp Isearch marked buffers") Buffer-menu-isearch-buffers-regexp
186 :help ,(purecopy "Search for a regexp through all marked buffers using Isearch")))
6a6baf11 187 (define-key menu-map [ir]
905a9ed3
DN
188 `(menu-item ,(purecopy "Isearch marked buffers") Buffer-menu-isearch-buffers
189 :help ,(purecopy "Search for a string through all marked buffers using Isearch")))
a3c20c83 190 (define-key menu-map [s3] menu-bar-separator)
6a6baf11 191 (define-key menu-map [by]
905a9ed3
DN
192 `(menu-item ,(purecopy "Bury") Buffer-menu-bury
193 :help ,(purecopy "Bury the buffer listed on this line")))
6a6baf11 194 (define-key menu-map [vt]
905a9ed3
DN
195 `(menu-item ,(purecopy "Set unmodified") Buffer-menu-not-modified
196 :help ,(purecopy "Mark buffer on this line as unmodified (no changes to save)")))
6a6baf11 197 (define-key menu-map [ex]
905a9ed3
DN
198 `(menu-item ,(purecopy "Execute") Buffer-menu-execute
199 :help ,(purecopy "Save and/or delete buffers marked with s or k commands")))
a3c20c83 200 (define-key menu-map [s4] menu-bar-separator)
6a6baf11 201 (define-key menu-map [delb]
905a9ed3
DN
202 `(menu-item ,(purecopy "Mark for delete and move backwards") Buffer-menu-delete-backwards
203 :help ,(purecopy "Mark buffer on this line to be deleted by x command and move up one line")))
6a6baf11 204 (define-key menu-map [del]
905a9ed3
DN
205 `(menu-item ,(purecopy "Mark for delete") Buffer-menu-delete
206 :help ,(purecopy "Mark buffer on this line to be deleted by x command")))
6a6baf11
DN
207
208 (define-key menu-map [sv]
905a9ed3
DN
209 `(menu-item ,(purecopy "Mark for save") Buffer-menu-save
210 :help ,(purecopy "Mark buffer on this line to be saved by x command")))
6a6baf11 211 (define-key menu-map [umk]
905a9ed3
DN
212 `(menu-item ,(purecopy "Unmark") Buffer-menu-unmark
213 :help ,(purecopy "Cancel all requested operations on buffer on this line and move down")))
6a6baf11 214 (define-key menu-map [mk]
905a9ed3
DN
215 `(menu-item ,(purecopy "Mark") Buffer-menu-mark
216 :help ,(purecopy "Mark buffer on this line for being displayed by v command")))
392225ee
JB
217 map)
218 "Local keymap for `Buffer-menu-mode' buffers.")
2dd96f23
JB
219
220;; Buffer Menu mode is suitable only for specially formatted data.
221(put 'Buffer-menu-mode 'mode-class 'special)
222
fa9d0f38 223(define-derived-mode Buffer-menu-mode special-mode "Buffer Menu"
2dd96f23
JB
224 "Major mode for editing a list of buffers.
225Each line describes one of the buffers in Emacs.
226Letters do not insert themselves; instead, they are commands.
227\\<Buffer-menu-mode-map>
2cf5fc7e
RS
228\\[Buffer-menu-mouse-select] -- select buffer you click on, in place of the buffer menu.
229\\[Buffer-menu-this-window] -- select current line's buffer in place of the buffer menu.
230\\[Buffer-menu-other-window] -- select that buffer in another window,
231 so the buffer menu buffer remains visible in its window.
42a19c2a
RS
232\\[Buffer-menu-view] -- select current line's buffer, but in view-mode.
233\\[Buffer-menu-view-other-window] -- select that buffer in
234 another window, in view-mode.
2cf5fc7e
RS
235\\[Buffer-menu-switch-other-window] -- make another window display that buffer.
236\\[Buffer-menu-mark] -- mark current line's buffer to be displayed.
237\\[Buffer-menu-select] -- select current line's buffer.
238 Also show buffers marked with m, in other windows.
dc6d9681 239\\[Buffer-menu-1-window] -- select that buffer in full-frame window.
2dd96f23
JB
240\\[Buffer-menu-2-window] -- select that buffer in one window,
241 together with buffer selected before this one in another window.
1fbb8c2e
JL
242\\[Buffer-menu-isearch-buffers] -- Do incremental search in the marked buffers.
243\\[Buffer-menu-isearch-buffers-regexp] -- Isearch for regexp in the marked buffers.
2dd96f23
JB
244\\[Buffer-menu-visit-tags-table] -- visit-tags-table this buffer.
245\\[Buffer-menu-not-modified] -- clear modified-flag on that buffer.
246\\[Buffer-menu-save] -- mark that buffer to be saved, and move down.
247\\[Buffer-menu-delete] -- mark that buffer to be deleted, and move down.
248\\[Buffer-menu-delete-backwards] -- mark that buffer to be deleted, and move up.
249\\[Buffer-menu-execute] -- delete or save marked buffers.
250\\[Buffer-menu-unmark] -- remove all kinds of marks from current line.
86dbbfc2 251 With prefix argument, also move up one line.
d91e2b1a 252\\[Buffer-menu-backup-unmark] -- back up a line and remove marks.
0f88624e 253\\[Buffer-menu-toggle-read-only] -- toggle read-only status of buffer on this line.
fa9d0f38 254\\[revert-buffer] -- update the list of buffers.
7b0a86ab 255\\[Buffer-menu-toggle-files-only] -- toggle whether the menu displays only file buffers.
a59faabe 256\\[Buffer-menu-bury] -- bury the buffer listed on this line."
7b0a86ab
LT
257 (set (make-local-variable 'revert-buffer-function)
258 'Buffer-menu-revert-function)
259 (set (make-local-variable 'buffer-stale-function)
012ad4a3 260 #'(lambda (&optional noconfirm) 'fast))
823316aa 261 (setq truncate-lines t)
392225ee 262 (setq buffer-read-only t))
710e5da8 263
bf48d4ef
GM
264(define-obsolete-variable-alias 'buffer-menu-mode-hook
265 'Buffer-menu-mode-hook "23.1")
266
710e5da8 267(defun Buffer-menu-revert-function (ignore1 ignore2)
fda73b45
LT
268 (or (eq buffer-undo-list t)
269 (setq buffer-undo-list nil))
7b0a86ab 270 ;; We can not use save-excursion here. The buffer gets erased.
3f9c9ff7
LT
271 (let ((opoint (point))
272 (eobp (eobp))
273 (ocol (current-column))
bfb2dda4
DP
274 (oline (progn (move-to-column 4)
275 (get-text-property (point) 'buffer)))
fda73b45
LT
276 (prop (point-min))
277 ;; do not make undo records for the reversion.
278 (buffer-undo-list t))
63de2160
LT
279 ;; We can be called by Auto Revert Mode with the "*Buffer Menu*"
280 ;; temporarily the current buffer. Make sure that the
281 ;; interactively current buffer is correctly identified with a `.'
282 ;; by `list-buffers-noselect'.
283 (with-current-buffer (window-buffer)
284 (list-buffers-noselect Buffer-menu-files-only))
3f9c9ff7
LT
285 (if oline
286 (while (setq prop (next-single-property-change prop 'buffer))
287 (when (eq (get-text-property prop 'buffer) oline)
288 (goto-char prop)
289 (move-to-column ocol)))
290 (goto-char (if eobp (point-max) opoint)))))
7b0a86ab
LT
291
292(defun Buffer-menu-toggle-files-only (arg)
293 "Toggle whether the current buffer-menu displays only file buffers.
294With a positive ARG display only file buffers. With zero or
295negative ARG, display other buffers as well."
296 (interactive "P")
297 (setq Buffer-menu-files-only
298 (cond ((not arg) (not Buffer-menu-files-only))
299 ((> (prefix-numeric-value arg) 0) t)))
300 (revert-buffer))
301
2dd96f23 302\f
2dd96f23
JB
303(defun Buffer-menu-buffer (error-if-non-existent-p)
304 "Return buffer described by this line of buffer menu."
1b40dbed
RS
305 (let* ((where (save-excursion
306 (beginning-of-line)
307 (+ (point) Buffer-menu-buffer-column)))
601ed8a0
GM
308 (name (and (not (eobp)) (get-text-property where 'buffer-name)))
309 (buf (and (not (eobp)) (get-text-property where 'buffer))))
1b40dbed
RS
310 (if name
311 (or (get-buffer name)
601ed8a0 312 (and buf (buffer-name buf) buf)
1b40dbed
RS
313 (if error-if-non-existent-p
314 (error "No buffer named `%s'" name)
315 nil))
601ed8a0 316 (or (and buf (buffer-name buf) buf)
463a7342
JPW
317 (if error-if-non-existent-p
318 (error "No buffer on this line")
601ed8a0 319 nil)))))
2dd96f23 320\f
06b1a5ef 321(defun buffer-menu (&optional arg)
2dd96f23
JB
322 "Make a menu of buffers so you can save, delete or select them.
323With argument, show only buffers that are visiting files.
324Type ? after invocation to get help on commands available.
6a0d92d3
RS
325Type q to remove the buffer menu from the display.
326
327The first column shows `>' for a buffer you have
328marked to be displayed, `D' for one you have marked for
329deletion, and `.' for the current buffer.
330
bc7bb432
JB
331The C column has a `.' for the buffer from which you came.
332The R column has a `%' if the buffer is read-only.
6a0d92d3
RS
333The M column has a `*' if it is modified,
334or `S' if you have marked it for saving.
6a0d92d3
RS
335After this come the buffer name, its size in characters,
336its major mode, and the visited file name (if any)."
08c82d4d
RS
337 (interactive "P")
338;;; (setq Buffer-menu-window-config (current-window-configuration))
339 (switch-to-buffer (list-buffers-noselect arg))
340 (message
341 "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))
342
343(defun buffer-menu-other-window (&optional arg)
344 "Display a list of buffers in another window.
345With the buffer list buffer, you can save, delete or select the buffers.
346With argument, show only buffers that are visiting files.
347Type ? after invocation to get help on commands available.
6a0d92d3
RS
348Type q to remove the buffer menu from the display.
349For more information, see the function `buffer-menu'."
2dd96f23 350 (interactive "P")
3ed788ec 351;;; (setq Buffer-menu-window-config (current-window-configuration))
08c82d4d 352 (switch-to-buffer-other-window (list-buffers-noselect arg))
2dd96f23 353 (message
3ed788ec
RS
354 "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))
355
bc7bb432
JB
356(defun Buffer-menu-no-header ()
357 (beginning-of-line)
358 (if (or Buffer-menu-use-header-line
359 (not (eq (char-after) ?C)))
360 t
361 (ding)
362 (forward-line 1)
363 nil))
364
2dd96f23
JB
365(defun Buffer-menu-mark ()
366 "Mark buffer on this line for being displayed by \\<Buffer-menu-mode-map>\\[Buffer-menu-select] command."
367 (interactive)
bc7bb432 368 (when (Buffer-menu-no-header)
70ef8857 369 (let ((inhibit-read-only t))
2dd96f23
JB
370 (delete-char 1)
371 (insert ?>)
372 (forward-line 1))))
373
86dbbfc2
ER
374(defun Buffer-menu-unmark (&optional backup)
375 "Cancel all requested operations on buffer on this line and move down.
bfa13d19 376Optional prefix arg means move up."
86dbbfc2 377 (interactive "P")
bc7bb432 378 (when (Buffer-menu-no-header)
2dd96f23
JB
379 (let* ((buf (Buffer-menu-buffer t))
380 (mod (buffer-modified-p buf))
70ef8857
SM
381 (readonly (with-current-buffer buf buffer-read-only))
382 (inhibit-read-only t))
2dd96f23 383 (delete-char 3)
bc7bb432 384 (insert (if readonly (if mod " %*" " % ") (if mod " *" " ")))))
86dbbfc2 385 (forward-line (if backup -1 1)))
2dd96f23
JB
386
387(defun Buffer-menu-backup-unmark ()
388 "Move up and cancel all requested operations on buffer on line above."
389 (interactive)
390 (forward-line -1)
391 (Buffer-menu-unmark)
392 (forward-line -1))
393
77a43e01
RS
394(defun Buffer-menu-delete (&optional arg)
395 "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command.
396Prefix arg is how many buffers to delete.
397Negative arg means delete backwards."
398 (interactive "p")
bc7bb432 399 (when (Buffer-menu-no-header)
70ef8857 400 (let ((inhibit-read-only t))
77a43e01
RS
401 (if (or (null arg) (= arg 0))
402 (setq arg 1))
403 (while (> arg 0)
404 (delete-char 1)
405 (insert ?D)
406 (forward-line 1)
407 (setq arg (1- arg)))
bc7bb432
JB
408 (while (and (< arg 0)
409 (Buffer-menu-no-header))
77a43e01
RS
410 (delete-char 1)
411 (insert ?D)
412 (forward-line -1)
413 (setq arg (1+ arg))))))
414
415(defun Buffer-menu-delete-backwards (&optional arg)
2dd96f23 416 "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command
77a43e01
RS
417and then move up one line. Prefix arg means move that many lines."
418 (interactive "p")
bc7bb432 419 (Buffer-menu-delete (- (or arg 1))))
2dd96f23
JB
420
421(defun Buffer-menu-save ()
422 "Mark buffer on this line to be saved by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command."
423 (interactive)
bc7bb432 424 (when (Buffer-menu-no-header)
70ef8857 425 (let ((inhibit-read-only t))
bc7bb432 426 (forward-char 2)
2dd96f23
JB
427 (delete-char 1)
428 (insert ?S)
429 (forward-line 1))))
430
a8ce00dc 431(defun Buffer-menu-not-modified (&optional arg)
2dd96f23 432 "Mark buffer on this line as unmodified (no changes to save)."
a8ce00dc 433 (interactive "P")
70ef8857 434 (with-current-buffer (Buffer-menu-buffer t)
a8ce00dc 435 (set-buffer-modified-p arg))
2dd96f23
JB
436 (save-excursion
437 (beginning-of-line)
bc7bb432 438 (forward-char 2)
bfa13d19 439 (if (= (char-after) (if arg ?\s ?*))
70ef8857 440 (let ((inhibit-read-only t))
2dd96f23 441 (delete-char 1)
bfa13d19 442 (insert (if arg ?* ?\s))))))
2dd96f23 443
bfb2dda4
DP
444(defun Buffer-menu-beginning ()
445 (goto-char (point-min))
446 (unless Buffer-menu-use-header-line
447 (forward-line)))
448
2dd96f23
JB
449(defun Buffer-menu-execute ()
450 "Save and/or delete buffers marked with \\<Buffer-menu-mode-map>\\[Buffer-menu-save] or \\<Buffer-menu-mode-map>\\[Buffer-menu-delete] commands."
451 (interactive)
452 (save-excursion
bfb2dda4 453 (Buffer-menu-beginning)
bc7bb432 454 (while (re-search-forward "^..S" nil t)
2dd96f23 455 (let ((modp nil))
70ef8857 456 (with-current-buffer (Buffer-menu-buffer t)
2dd96f23
JB
457 (save-buffer)
458 (setq modp (buffer-modified-p)))
70ef8857 459 (let ((inhibit-read-only t))
2dd96f23 460 (delete-char -1)
bfa13d19 461 (insert (if modp ?* ?\s))))))
2dd96f23 462 (save-excursion
bfb2dda4 463 (Buffer-menu-beginning)
2dd96f23 464 (let ((buff-menu-buffer (current-buffer))
70ef8857 465 (inhibit-read-only t))
4f1ab860 466 (while (re-search-forward "^D" nil t)
2dd96f23
JB
467 (forward-char -1)
468 (let ((buf (Buffer-menu-buffer nil)))
469 (or (eq buf nil)
470 (eq buf buff-menu-buffer)
601ed8a0
GM
471 (save-excursion (kill-buffer buf)))
472 (if (and buf (buffer-name buf))
2dd96f23 473 (progn (delete-char 1)
bfa13d19 474 (insert ?\s))
2dd96f23 475 (delete-region (point) (progn (forward-line 1) (point)))
4f1ab860
DL
476 (unless (bobp)
477 (forward-char -1))))))))
2dd96f23
JB
478
479(defun Buffer-menu-select ()
480 "Select this line's buffer; also display buffers marked with `>'.
08c82d4d
RS
481You can mark buffers with the \\<Buffer-menu-mode-map>\\[Buffer-menu-mark] command.
482This command deletes and replaces all the previously existing windows
483in the selected frame."
2dd96f23
JB
484 (interactive)
485 (let ((buff (Buffer-menu-buffer t))
10e1dad9 486 (menu (current-buffer))
2dd96f23
JB
487 (others ())
488 tem)
bfb2dda4 489 (Buffer-menu-beginning)
a9fb4690 490 (while (re-search-forward "^>" nil t)
2dd96f23 491 (setq tem (Buffer-menu-buffer t))
70ef8857 492 (let ((inhibit-read-only t))
2dd96f23 493 (delete-char -1)
bfa13d19 494 (insert ?\s))
2dd96f23
JB
495 (or (eq tem buff) (memq tem others) (setq others (cons tem others))))
496 (setq others (nreverse others)
dc6d9681 497 tem (/ (1- (frame-height)) (1+ (length others))))
2dd96f23
JB
498 (delete-other-windows)
499 (switch-to-buffer buff)
500 (or (eq menu buff)
501 (bury-buffer menu))
86dbbfc2
ER
502 (if (equal (length others) 0)
503 (progn
3ed788ec
RS
504;;; ;; Restore previous window configuration before displaying
505;;; ;; selected buffers.
506;;; (if Buffer-menu-window-config
507;;; (progn
508;;; (set-window-configuration Buffer-menu-window-config)
509;;; (setq Buffer-menu-window-config nil)))
86dbbfc2
ER
510 (switch-to-buffer buff))
511 (while others
512 (split-window nil tem)
513 (other-window 1)
514 (switch-to-buffer (car others))
515 (setq others (cdr others)))
516 (other-window 1) ;back to the beginning!
517)))
518
9cda680d
JL
519(defun Buffer-menu-marked-buffers ()
520 "Return a list of buffers marked with the \\<Buffer-menu-mode-map>\\[Buffer-menu-mark] command."
521 (let (buffers)
522 (Buffer-menu-beginning)
523 (while (re-search-forward "^>" nil t)
524 (setq buffers (cons (Buffer-menu-buffer t) buffers)))
525 (nreverse buffers)))
526
527(defun Buffer-menu-isearch-buffers ()
528 "Search for a string through all marked buffers using Isearch."
529 (interactive)
530 (multi-isearch-buffers (Buffer-menu-marked-buffers)))
531
532(defun Buffer-menu-isearch-buffers-regexp ()
533 "Search for a regexp through all marked buffers using Isearch."
534 (interactive)
535 (multi-isearch-buffers-regexp (Buffer-menu-marked-buffers)))
08c82d4d 536
2dd96f23
JB
537\f
538(defun Buffer-menu-visit-tags-table ()
539 "Visit the tags table in the buffer on this line. See `visit-tags-table'."
540 (interactive)
541 (let ((file (buffer-file-name (Buffer-menu-buffer t))))
542 (if file
543 (visit-tags-table file)
544 (error "Specified buffer has no file"))))
545
546(defun Buffer-menu-1-window ()
dc6d9681 547 "Select this line's buffer, alone, in full frame."
2dd96f23
JB
548 (interactive)
549 (switch-to-buffer (Buffer-menu-buffer t))
550 (bury-buffer (other-buffer))
551 (delete-other-windows))
552
2cf5fc7e
RS
553(defun Buffer-menu-mouse-select (event)
554 "Select the buffer whose line you click on."
555 (interactive "e")
556 (let (buffer)
70ef8857 557 (with-current-buffer (window-buffer (posn-window (event-end event)))
2cf5fc7e
RS
558 (save-excursion
559 (goto-char (posn-point (event-end event)))
560 (setq buffer (Buffer-menu-buffer t))))
561 (select-window (posn-window (event-end event)))
d953b88c
RS
562 (if (and (window-dedicated-p (selected-window))
563 (eq (selected-window) (frame-root-window)))
564 (switch-to-buffer-other-frame buffer)
565 (switch-to-buffer buffer))))
2cf5fc7e 566
2dd96f23
JB
567(defun Buffer-menu-this-window ()
568 "Select this line's buffer in this window."
569 (interactive)
570 (switch-to-buffer (Buffer-menu-buffer t)))
571
572(defun Buffer-menu-other-window ()
573 "Select this line's buffer in other window, leaving buffer menu visible."
574 (interactive)
575 (switch-to-buffer-other-window (Buffer-menu-buffer t)))
576
35aaf00c
RM
577(defun Buffer-menu-switch-other-window ()
578 "Make the other window select this line's buffer.
579The current window remains selected."
580 (interactive)
a0e4e275
JL
581 (let ((pop-up-windows t)
582 same-window-buffer-names
583 same-window-regexps)
584 (display-buffer (Buffer-menu-buffer t))))
35aaf00c 585
2dd96f23
JB
586(defun Buffer-menu-2-window ()
587 "Select this line's buffer, with previous buffer in second window."
588 (interactive)
589 (let ((buff (Buffer-menu-buffer t))
590 (menu (current-buffer))
a0e4e275
JL
591 (pop-up-windows t)
592 same-window-buffer-names
593 same-window-regexps)
86dbbfc2 594 (delete-other-windows)
2dd96f23
JB
595 (switch-to-buffer (other-buffer))
596 (pop-to-buffer buff)
597 (bury-buffer menu)))
c0274f38 598
d91e2b1a 599(defun Buffer-menu-toggle-read-only ()
f450965c 600 "Toggle read-only status of buffer on this line, perhaps via version control."
d91e2b1a
ER
601 (interactive)
602 (let (char)
70ef8857
SM
603 (with-current-buffer (Buffer-menu-buffer t)
604 (toggle-read-only)
bfa13d19 605 (setq char (if buffer-read-only ?% ?\s)))
d91e2b1a
ER
606 (save-excursion
607 (beginning-of-line)
bc7bb432 608 (forward-char 1)
d91e2b1a 609 (if (/= (following-char) char)
70ef8857 610 (let ((inhibit-read-only t))
d91e2b1a
ER
611 (delete-char 1)
612 (insert char))))))
613
36570c92
RS
614(defun Buffer-menu-bury ()
615 "Bury the buffer listed on this line."
616 (interactive)
bc7bb432 617 (when (Buffer-menu-no-header)
a59faabe
RS
618 (save-excursion
619 (beginning-of-line)
620 (bury-buffer (Buffer-menu-buffer t))
621 (let ((line (buffer-substring (point) (progn (forward-line 1) (point))))
70ef8857 622 (inhibit-read-only t))
a59faabe
RS
623 (delete-region (point) (progn (forward-line -1) (point)))
624 (goto-char (point-max))
625 (insert line))
626 (message "Buried buffer moved to the end"))))
42a19c2a
RS
627
628
629(defun Buffer-menu-view ()
630 "View this line's buffer in View mode."
631 (interactive)
632 (view-buffer (Buffer-menu-buffer t)))
633
634
635(defun Buffer-menu-view-other-window ()
636 "View this line's buffer in View mode in another window."
637 (interactive)
638 (view-buffer-other-window (Buffer-menu-buffer t)))
0b03ce3a
RS
639\f
640
349b6bfe 641;;;###autoload
0b03ce3a
RS
642(define-key ctl-x-map "\C-b" 'list-buffers)
643
349b6bfe 644;;;###autoload
0b03ce3a
RS
645(defun list-buffers (&optional files-only)
646 "Display a list of names of existing buffers.
647The list is displayed in a buffer named `*Buffer List*'.
648Note that buffers with names starting with spaces are omitted.
649Non-null optional arg FILES-ONLY means mention only file buffers.
650
6a0d92d3 651For more information, see the function `buffer-menu'."
0b03ce3a 652 (interactive "P")
08c82d4d
RS
653 (display-buffer (list-buffers-noselect files-only)))
654
e1ff8dd0
SM
655(defconst Buffer-menu-short-ellipsis
656 ;; This file is preloaded, so we can't use char-displayable-p here
657 ;; because we don't know yet what display we're going to connect to.
658 ":" ;; (if (char-displayable-p ?…) "…" ":")
659 )
31e02fab 660
bc7bb432 661(defun Buffer-menu-buffer+size (name size &optional name-props size-props)
31e02fab
SM
662 (if (> (+ (string-width name) (string-width size) 2)
663 Buffer-menu-buffer+size-width)
bc7bb432 664 (setq name
31e02fab
SM
665 (let ((tail
666 (if (string-match "<[0-9]+>$" name)
667 (match-string 0 name)
668 "")))
669 (concat (truncate-string-to-width
670 name
671 (- Buffer-menu-buffer+size-width
672 (max (string-width size) 3)
673 (string-width tail)
674 2))
675 Buffer-menu-short-ellipsis
676 tail)))
ee5861c8
AS
677 ;; Don't put properties on (buffer-name).
678 (setq name (copy-sequence name)))
bc7bb432
JB
679 (add-text-properties 0 (length name) name-props name)
680 (add-text-properties 0 (length size) size-props size)
d19e23ae
CY
681 (let ((name+space-width (- Buffer-menu-buffer+size-width
682 (string-width size))))
683 (concat name
684 (propertize (make-string (- name+space-width (string-width name))
685 ?\s)
686 'display `(space :align-to ,(+ 4 name+space-width)))
687 size)))
bc7bb432 688
d5aacb46
SM
689(defun Buffer-menu-sort (column)
690 "Sort the buffer menu by COLUMN."
691 (interactive "P")
692 (when column
693 (setq column (prefix-numeric-value column))
694 (if (< column 2) (setq column 2))
695 (if (> column 5) (setq column 5)))
696 (setq Buffer-menu-sort-column column)
70ef8857 697 (let ((inhibit-read-only t) l buf m1 m2)
bfb2dda4
DP
698 (save-excursion
699 (Buffer-menu-beginning)
700 (while (not (eobp))
701 (when (buffer-live-p (setq buf (get-text-property (+ (point) 4) 'buffer)))
702 (setq m1 (char-after)
703 m1 (if (memq m1 '(?> ?D)) m1)
704 m2 (char-after (+ (point) 2))
705 m2 (if (eq m2 ?S) m2))
706 (if (or m1 m2)
707 (push (list buf m1 m2) l)))
708 (forward-line)))
52a0198d 709 (revert-buffer)
bfb2dda4
DP
710 (save-excursion
711 (Buffer-menu-beginning)
712 (while (not (eobp))
713 (when (setq buf (assq (get-text-property (+ (point) 4) 'buffer) l))
714 (setq m1 (cadr buf)
715 m2 (cadr (cdr buf)))
716 (when m1
717 (delete-char 1)
718 (insert m1)
719 (backward-char 1))
720 (when m2
721 (forward-char 2)
722 (delete-char 1)
723 (insert m2)))
724 (forward-line)))))
d5aacb46 725
104fc809
CY
726(defun Buffer-menu-sort-by-column (&optional e)
727 "Sort the buffer menu by the column clicked on."
728 (interactive (list last-input-event))
729 (if e (mouse-select-window e))
730 (let* ((pos (event-start e))
731 (obj (posn-object pos))
732 (col (if obj
733 (get-text-property (cdr obj) 'column (car obj))
734 (get-text-property (posn-point pos) 'column))))
735 (Buffer-menu-sort col)))
736
737(defvar Buffer-menu-sort-button-map
738 (let ((map (make-sparse-keymap)))
739 ;; This keymap handles both nil and non-nil values for
740 ;; Buffer-menu-use-header-line.
741 (define-key map [header-line mouse-1] 'Buffer-menu-sort-by-column)
742 (define-key map [header-line mouse-2] 'Buffer-menu-sort-by-column)
743 (define-key map [mouse-2] 'Buffer-menu-sort-by-column)
744 (define-key map [follow-link] 'mouse-face)
745 (define-key map "\C-m" 'Buffer-menu-sort-by-column)
746 map)
747 "Local keymap for Buffer menu sort buttons.")
748
d5aacb46
SM
749(defun Buffer-menu-make-sort-button (name column)
750 (if (equal column Buffer-menu-sort-column) (setq column nil))
104fc809
CY
751 (propertize name
752 'column column
753 'help-echo (concat
754 (if Buffer-menu-use-header-line
755 "mouse-1, mouse-2: sort by "
756 "mouse-2, RET: sort by ")
757 (if column (downcase name) "visited order"))
758 'mouse-face 'highlight
759 'keymap Buffer-menu-sort-button-map))
d5aacb46 760
61617913 761(defun list-buffers-noselect (&optional files-only buffer-list)
08c82d4d
RS
762 "Create and return a buffer with a list of names of existing buffers.
763The buffer is named `*Buffer List*'.
764Note that buffers with names starting with spaces are omitted.
765Non-null optional arg FILES-ONLY means mention only file buffers.
766
61617913
RS
767If BUFFER-LIST is non-nil, it should be a list of buffers;
768it means list those buffers and no others.
769
6a0d92d3 770For more information, see the function `buffer-menu'."
bc7bb432
JB
771 (let* ((old-buffer (current-buffer))
772 (standard-output standard-output)
bfa13d19 773 (mode-end (make-string (- Buffer-menu-mode-width 2) ?\s))
5e684428 774 (header (concat "CRM "
d5aacb46
SM
775 (Buffer-menu-buffer+size
776 (Buffer-menu-make-sort-button "Buffer" 2)
777 (Buffer-menu-make-sort-button "Size" 3))
778 " "
779 (Buffer-menu-make-sort-button "Mode" 4) mode-end
780 (Buffer-menu-make-sort-button "File" 5) "\n"))
f4872033 781 list desired-point)
748a336b 782 (when Buffer-menu-use-header-line
d5aacb46 783 (let ((pos 0))
fff861a2
JB
784 ;; Turn whitespace chars in the header into stretch specs so
785 ;; they work regardless of the header-line face.
786 (while (string-match "[ \t\n]+" header pos)
748a336b
SM
787 (setq pos (match-end 0))
788 (put-text-property (match-beginning 0) pos 'display
5e684428 789 ;; Assume fixed-size chars in the buffer.
6d3bce2b 790 (list 'space :align-to pos)
5e684428
SM
791 header)))
792 ;; Try to better align the one-char headers.
793 (put-text-property 0 3 'face 'fixed-pitch header)
794 ;; Add a "dummy" leading space to align the beginning of the header
795 ;; line with the beginning of the text (rather than with the left
c822571a 796 ;; scrollbar or the left fringe). --Stef
5e684428 797 (setq header (concat (propertize " " 'display '(space :align-to 0))
a6a2fd5e 798 header)))
d5aacb46 799 (with-current-buffer (get-buffer-create "*Buffer List*")
08c82d4d
RS
800 (setq buffer-read-only nil)
801 (erase-buffer)
802 (setq standard-output (current-buffer))
bc7bb432 803 (unless Buffer-menu-use-header-line
c822571a
SM
804 ;; Use U+2014 (EM DASH) to underline if possible, else use ASCII
805 ;; (i.e. U+002D, HYPHEN-MINUS).
806 (let ((underline (if (char-displayable-p ?\u2014) ?\u2014 ?-)))
5e684428
SM
807 (insert header
808 (apply 'string
809 (mapcar (lambda (c)
bfa13d19 810 (if (memq c '(?\n ?\s)) c underline))
5e684428 811 header)))))
a6a2fd5e 812 ;; Collect info for every buffer we're interested in.
3ce5f932
LT
813 (dolist (buffer (or buffer-list
814 (buffer-list
815 (when Buffer-menu-use-frame-buffer-list
816 (selected-frame)))))
a6a2fd5e
JL
817 (with-current-buffer buffer
818 (let ((name (buffer-name))
819 (file buffer-file-name))
820 (unless (and (not buffer-list)
821 (or
822 ;; Don't mention internal buffers.
823 (and (string= (substring name 0 1) " ") (null file))
824 ;; Maybe don't mention buffers without files.
825 (and files-only (not file))
826 (string= name "*Buffer List*")))
827 ;; Otherwise output info.
828 (let ((mode (concat (format-mode-line mode-name nil nil buffer)
829 (if mode-line-process
830 (format-mode-line mode-line-process
831 nil nil buffer))))
832 (bits (string
bfa13d19 833 (if (eq buffer old-buffer) ?. ?\s)
a6a2fd5e
JL
834 ;; Handle readonly status. The output buffer
835 ;; is special cased to appear readonly; it is
836 ;; actually made so at a later date.
837 (if (or (eq buffer standard-output)
838 buffer-read-only)
bfa13d19 839 ?% ?\s)
a6a2fd5e 840 ;; Identify modified buffers.
bfa13d19 841 (if (buffer-modified-p) ?* ?\s)
a6a2fd5e 842 ;; Space separator.
bfa13d19 843 ?\s)))
a6a2fd5e
JL
844 (unless file
845 ;; No visited file. Check local value of
fb5614e8
EZ
846 ;; list-buffers-directory and, for Info buffers,
847 ;; Info-current-file.
848 (cond ((and (boundp 'list-buffers-directory)
849 list-buffers-directory)
850 (setq file list-buffers-directory))
851 ((eq major-mode 'Info-mode)
852 (setq file Info-current-file)
853 (cond
26f544d3 854 ((equal file "dir")
fb5614e8
EZ
855 (setq file "*Info Directory*"))
856 ((eq file 'apropos)
857 (setq file "*Info Apropos*"))
858 ((eq file 'history)
859 (setq file "*Info History*"))
860 ((eq file 'toc)
861 (setq file "*Info TOC*"))
862 ((not (stringp file)) ;; avoid errors
b653cee4
EZ
863 (setq file nil))
864 (t
865 (setq file (concat "("
866 (file-name-nondirectory file)
9cda680d 867 ") "
b653cee4 868 Info-current-node)))))))
a6a2fd5e
JL
869 (push (list buffer bits name (buffer-size) mode file)
870 list))))))
871 ;; Preserve the original buffer-list ordering, just in case.
872 (setq list (nreverse list))
f4872033 873 ;; Place the buffers's info in the output buffer, sorted if necessary.
bc7bb432
JB
874 (dolist (buffer
875 (if Buffer-menu-sort-column
876 (sort list
877 (if (eq Buffer-menu-sort-column 3)
878 (lambda (a b)
879 (< (nth Buffer-menu-sort-column a)
880 (nth Buffer-menu-sort-column b)))
881 (lambda (a b)
882 (string< (nth Buffer-menu-sort-column a)
883 (nth Buffer-menu-sort-column b)))))
884 list))
885 (if (eq (car buffer) old-buffer)
886 (setq desired-point (point)))
887 (insert (cadr buffer)
888 ;; Put the buffer name into a text property
889 ;; so we don't have to extract it from the text.
890 ;; This way we avoid problems with unusual buffer names.
392640c4
NR
891 (let ((name (nth 2 buffer))
892 (size (int-to-string (nth 3 buffer))))
d19e23ae 893 (Buffer-menu-buffer+size name size
392640c4
NR
894 `(buffer-name ,name
895 buffer ,(car buffer)
896 font-lock-face buffer-menu-buffer
897 mouse-face highlight
9201cc28 898 help-echo
392640c4
NR
899 ,(if (>= (length name)
900 (- Buffer-menu-buffer+size-width
901 (max (length size) 3)
902 2))
903 name
904 "mouse-2: select this buffer"))))
a3e5a603
SM
905 " "
906 (if (> (string-width (nth 4 buffer)) Buffer-menu-mode-width)
907 (truncate-string-to-width (nth 4 buffer)
31e02fab 908 Buffer-menu-mode-width)
bc7bb432
JB
909 (nth 4 buffer)))
910 (when (nth 5 buffer)
911 (indent-to (+ Buffer-menu-buffer-column Buffer-menu-buffer+size-width
912 Buffer-menu-mode-width 4) 1)
913 (princ (abbreviate-file-name (nth 5 buffer))))
914 (princ "\n"))
0b03ce3a 915 (Buffer-menu-mode)
bc7bb432 916 (when Buffer-menu-use-header-line
748a336b 917 (setq header-line-format header))
08c82d4d
RS
918 ;; DESIRED-POINT doesn't have to be set; it is not when the
919 ;; current buffer is not displayed for some reason.
0b03ce3a 920 (and desired-point
08c82d4d 921 (goto-char desired-point))
7b0a86ab
LT
922 (setq Buffer-menu-files-only files-only)
923 (set-buffer-modified-p nil)
08c82d4d 924 (current-buffer))))
0b03ce3a 925
f4872033 926;; arch-tag: e7dfcfc9-6cb2-46e4-bf55-8ef1936d83c6
c0274f38 927;;; buff-menu.el ends here