buff-menu.el 28.1 KB
Newer Older
1
;;; buff-menu.el --- Interface for viewing and manipulating buffers -*- lexical-binding: t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1985-1987, 1993-1995, 2000-2020 Free Software
4
;; Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5

6
;; Maintainer: emacs-devel@gnu.org
Gerd Moellmann's avatar
Gerd Moellmann committed
7
;; Keywords: convenience
8
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Jim Blandy's avatar
Jim Blandy committed
10 11
;; This file is part of GNU Emacs.

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

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

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

25 26
;;; Commentary:

27 28 29
;; The Buffer Menu is used to view, edit, delete, or change attributes
;; of buffers.  The entry points are C-x C-b (`list-buffers') and
;; M-x buffer-menu.
30

Eric S. Raymond's avatar
Eric S. Raymond committed
31
;;; Code:
32

33
(require 'tabulated-list)
Jim Blandy's avatar
Jim Blandy committed
34

35 36 37 38 39
(defgroup Buffer-menu nil
  "Show a menu of all buffers in a buffer."
  :group 'tools
  :group 'convenience)

40 41 42 43 44 45
(defvar Buffer-menu-marker-char ?>
  "The mark character for marked buffers.")

(defvar Buffer-menu-del-char ?D
  "Character used to flag buffers for deletion.")

46
(defcustom Buffer-menu-use-header-line t
47
  "If non-nil, use the header line to display Buffer Menu column titles."
48 49 50
  :type 'boolean
  :group 'Buffer-menu)

51
(defface buffer-menu-buffer
52
  '((t (:weight bold)))
53
  "Face for buffer names in the Buffer Menu."
54
  :group 'Buffer-menu)
55
(put 'Buffer-menu-buffer 'face-alias 'buffer-menu-buffer)
56

57 58
(defcustom Buffer-menu-buffer+size-width nil
  "Combined width of buffer name and size columns in Buffer Menu.
59 60 61 62 63
If nil, use `Buffer-menu-name-width' and `Buffer-menu-size-width'.

If non-nil, the value of `Buffer-menu-name-width' is overridden;
the name column is assigned width `Buffer-menu-buffer+size-width'
minus `Buffer-menu-size-width'.  This use is deprecated."
64
  :type '(choice (const nil) number)
65
  :group 'Buffer-menu
66
  :version "24.3")
67 68

(make-obsolete-variable 'Buffer-menu-buffer+size-width
69
			"use `Buffer-menu-name-width' and `Buffer-menu-size-width' instead."
70
			"24.3")
71

72 73 74 75 76 77 78 79
(defun Buffer-menu--dynamic-name-width (buffers)
  "Return a name column width based on the current window width.
The width will never exceed the actual width of the buffer names,
but will never be narrower than 19 characters."
  (max 19
       ;; This gives 19 on an 80 column window, and take up
       ;; proportionally more space as the window widens.
       (min (truncate (/ (window-width) 4.2))
80 81 82
            (apply #'max 0 (mapcar (lambda (b)
                                     (length (buffer-name b)))
                                   buffers)))))
83 84 85 86 87 88 89

(defcustom Buffer-menu-name-width #'Buffer-menu--dynamic-name-width
  "Width of buffer name column in the Buffer Menu.
This can either be a number (used directly) or a function that
will be called with the list of buffers and should return a
number."
  :type '(choice function number)
90
  :group 'Buffer-menu
91
  :version "28.1")
92 93

(defcustom Buffer-menu-size-width 7
94
  "Width of buffer size column in the Buffer Menu."
95 96
  :type 'number
  :group 'Buffer-menu
97
  :version "24.3")
98

99
(defcustom Buffer-menu-mode-width 16
100
  "Width of mode name column in the Buffer Menu."
101 102 103
  :type 'number
  :group 'Buffer-menu)

104 105 106 107 108 109 110 111 112 113
(defcustom Buffer-menu-use-frame-buffer-list t
  "If non-nil, the Buffer Menu uses the selected frame's buffer list.
Buffers that were never selected in that frame are listed at the end.
If the value is nil, the Buffer Menu uses the global buffer list.
This variable matters if the Buffer Menu is sorted by visited order,
as it is by default."
  :type 'boolean
  :group 'Buffer-menu
  :version "22.1")

114
(defvar Buffer-menu-files-only nil
115 116 117
  "Non-nil if the current Buffer Menu lists only file buffers.
This is set by the prefix argument to `buffer-menu' and related
commands.")
118 119 120
(make-variable-buffer-local 'Buffer-menu-files-only)

(defvar Buffer-menu-mode-map
121
  (let ((map (make-sparse-keymap))
122
	(menu-map (make-sparse-keymap)))
123
    (set-keymap-parent map tabulated-list-mode-map)
124 125 126 127 128 129 130 131 132 133 134 135
    (define-key map "v" 'Buffer-menu-select)
    (define-key map "2" 'Buffer-menu-2-window)
    (define-key map "1" 'Buffer-menu-1-window)
    (define-key map "f" 'Buffer-menu-this-window)
    (define-key map "e" 'Buffer-menu-this-window)
    (define-key map "\C-m" 'Buffer-menu-this-window)
    (define-key map "o" 'Buffer-menu-other-window)
    (define-key map "\C-o" 'Buffer-menu-switch-other-window)
    (define-key map "s" 'Buffer-menu-save)
    (define-key map "d" 'Buffer-menu-delete)
    (define-key map "k" 'Buffer-menu-delete)
    (define-key map "\C-k" 'Buffer-menu-delete)
136
    (define-key map "\C-d" 'Buffer-menu-delete-backwards)
137 138 139 140 141
    (define-key map "x" 'Buffer-menu-execute)
    (define-key map " " 'next-line)
    (define-key map "\177" 'Buffer-menu-backup-unmark)
    (define-key map "~" 'Buffer-menu-not-modified)
    (define-key map "u" 'Buffer-menu-unmark)
142 143
    (define-key map "\M-\177" 'Buffer-menu-unmark-all-buffers)
    (define-key map "U" 'Buffer-menu-unmark-all)
144 145 146 147 148 149
    (define-key map "m" 'Buffer-menu-mark)
    (define-key map "t" 'Buffer-menu-visit-tags-table)
    (define-key map "%" 'Buffer-menu-toggle-read-only)
    (define-key map "b" 'Buffer-menu-bury)
    (define-key map "V" 'Buffer-menu-view)
    (define-key map "T" 'Buffer-menu-toggle-files-only)
Juri Linkov's avatar
Juri Linkov committed
150 151
    (define-key map (kbd "M-s a C-s")   'Buffer-menu-isearch-buffers)
    (define-key map (kbd "M-s a M-C-s") 'Buffer-menu-isearch-buffers-regexp)
152
    (define-key map (kbd "M-s a C-o") 'Buffer-menu-multi-occur)
153

154 155 156
    (define-key map [mouse-2] 'Buffer-menu-mouse-select)
    (define-key map [follow-link] 'mouse-face)

157
    (define-key map [menu-bar Buffer-menu-mode] (cons (purecopy "Buffer-Menu") menu-map))
158 159 160 161 162 163 164 165 166
    (bindings--define-key menu-map [quit]
      '(menu-item "Quit" quit-window
		 :help "Remove the buffer menu from the display"))
    (bindings--define-key menu-map [rev]
      '(menu-item "Refresh" revert-buffer
		 :help "Refresh the *Buffer List* buffer contents"))
    (bindings--define-key menu-map [s0] menu-bar-separator)
    (bindings--define-key menu-map [tf]
      '(menu-item "Show Only File Buffers" Buffer-menu-toggle-files-only
167
		  :button (:toggle . Buffer-menu-files-only)
168 169
		  :help "Toggle whether the current buffer-menu displays only file buffers"))
    (bindings--define-key menu-map [s1] menu-bar-separator)
170
    ;; FIXME: The "Select" entries could use better names...
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
    (bindings--define-key menu-map [sel]
      '(menu-item "Select Marked" Buffer-menu-select
		 :help "Select this line's buffer; also display buffers marked with `>'"))
    (bindings--define-key menu-map [bm2]
      '(menu-item "Select Two" Buffer-menu-2-window
		 :help "Select this line's buffer, with previous buffer in second window"))
    (bindings--define-key menu-map [bm1]
      '(menu-item "Select Current" Buffer-menu-1-window
		 :help "Select this line's buffer, alone, in full frame"))
    (bindings--define-key menu-map [ow]
      '(menu-item "Select in Other Window" Buffer-menu-other-window
		 :help "Select this line's buffer in other window, leaving buffer menu visible"))
    (bindings--define-key menu-map [tw]
      '(menu-item "Select in Current Window" Buffer-menu-this-window
		 :help "Select this line's buffer in this window"))
    (bindings--define-key menu-map [s2] menu-bar-separator)
    (bindings--define-key menu-map [is]
      '(menu-item "Regexp Isearch Marked Buffers..." Buffer-menu-isearch-buffers-regexp
		 :help "Search for a regexp through all marked buffers using Isearch"))
    (bindings--define-key menu-map [ir]
      '(menu-item "Isearch Marked Buffers..." Buffer-menu-isearch-buffers
		 :help "Search for a string through all marked buffers using Isearch"))
193 194 195
    (bindings--define-key menu-map [mo]
      '(menu-item "Multi Occur Marked Buffers..." Buffer-menu-multi-occur
		 :help "Show lines matching a regexp in marked buffers using Occur"))
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    (bindings--define-key menu-map [s3] menu-bar-separator)
    (bindings--define-key menu-map [by]
      '(menu-item "Bury" Buffer-menu-bury
		 :help "Bury the buffer listed on this line"))
    (bindings--define-key menu-map [vt]
      '(menu-item "Set Unmodified" Buffer-menu-not-modified
		 :help "Mark buffer on this line as unmodified (no changes to save)"))
    (bindings--define-key menu-map [ex]
      '(menu-item "Execute" Buffer-menu-execute
		 :help "Save and/or delete buffers marked with s or k commands"))
    (bindings--define-key menu-map [s4] menu-bar-separator)
    (bindings--define-key menu-map [delb]
      '(menu-item "Mark for Delete and Move Backwards" Buffer-menu-delete-backwards
		 :help "Mark buffer on this line to be deleted by x command and move up one line"))
    (bindings--define-key menu-map [del]
      '(menu-item "Mark for Delete" Buffer-menu-delete
		 :help "Mark buffer on this line to be deleted by x command"))

    (bindings--define-key menu-map [sv]
      '(menu-item "Mark for Save" Buffer-menu-save
		 :help "Mark buffer on this line to be saved by x command"))
    (bindings--define-key menu-map [umk]
      '(menu-item "Unmark" Buffer-menu-unmark
		 :help "Cancel all requested operations on buffer on this line and move down"))
220 221 222 223 224 225
    (bindings--define-key menu-map [umkab]
      '(menu-item "Remove marks..." Buffer-menu-unmark-all-buffers
                  :help "Cancel a requested operation on all buffers"))
    (bindings--define-key menu-map [umka]
      '(menu-item "Unmark all" Buffer-menu-unmark-all
                  :help "Cancel all requested operations on buffers"))
226 227 228
    (bindings--define-key menu-map [mk]
      '(menu-item "Mark" Buffer-menu-mark
		 :help "Mark buffer on this line for being displayed by v command"))
229 230
    map)
  "Local keymap for `Buffer-menu-mode' buffers.")
Jim Blandy's avatar
Jim Blandy committed
231

232 233
(define-derived-mode Buffer-menu-mode tabulated-list-mode "Buffer Menu"
  "Major mode for Buffer Menu buffers.
Chong Yidong's avatar
Chong Yidong committed
234 235 236
The Buffer Menu is invoked by the commands \\[list-buffers],
\\[buffer-menu], and \\[buffer-menu-other-window].
See `buffer-menu' for a description of its contents.
237

Chong Yidong's avatar
Chong Yidong committed
238
In Buffer Menu mode, the following commands are defined:
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
\\<Buffer-menu-mode-map>
\\[quit-window]    Remove the Buffer Menu from the display.
\\[Buffer-menu-this-window]  Select current line's buffer in place of the buffer menu.
\\[Buffer-menu-other-window]    Select that buffer in another window,
     so the Buffer Menu remains visible in its window.
\\[Buffer-menu-view]    Select current line's buffer, in View mode.
\\[Buffer-menu-view-other-window]  Select that buffer in
     another window, in view-mode.
\\[Buffer-menu-switch-other-window]  Make another window display that buffer.
\\[Buffer-menu-mark]    Mark current line's buffer to be displayed.
\\[Buffer-menu-select]    Select current line's buffer.
     Also show buffers marked with m, in other windows.
\\[Buffer-menu-1-window]    Select that buffer in full-frame window.
\\[Buffer-menu-2-window]    Select that buffer in one window, together with the
     buffer selected before this one in another window.
Chong Yidong's avatar
Chong Yidong committed
254
\\[Buffer-menu-isearch-buffers]    Incremental search in the marked buffers.
255
\\[Buffer-menu-isearch-buffers-regexp]  Isearch for regexp in the marked buffers.
256
\\[Buffer-menu-multi-occur] Show lines matching regexp in the marked buffers.
257 258 259 260 261 262 263 264
\\[Buffer-menu-visit-tags-table]    visit-tags-table this buffer.
\\[Buffer-menu-not-modified]    Clear modified-flag on that buffer.
\\[Buffer-menu-save]    Mark that buffer to be saved, and move down.
\\[Buffer-menu-delete]  Mark that buffer to be deleted, and move down.
\\[Buffer-menu-delete-backwards]  Mark that buffer to be deleted, and move up.
\\[Buffer-menu-execute]    Delete or save marked buffers.
\\[Buffer-menu-unmark]    Remove all marks from current line.
     With prefix argument, also move up one line.
265 266
\\[Buffer-menu-unmark-all-buffers]    Remove a particular mark from all lines.
\\[Buffer-menu-unmark-all]    Remove all marks from all lines.
267 268 269 270 271
\\[Buffer-menu-backup-unmark]  Back up a line and remove marks.
\\[Buffer-menu-toggle-read-only]    Toggle read-only status of buffer on this line.
\\[revert-buffer]    Update the list of buffers.
\\[Buffer-menu-toggle-files-only]    Toggle whether the menu displays only file buffers.
\\[Buffer-menu-bury]    Bury the buffer listed on this line."
Chong Yidong's avatar
Chong Yidong committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  (set (make-local-variable 'buffer-stale-function)
       (lambda (&optional _noconfirm) 'fast))
  (add-hook 'tabulated-list-revert-hook 'list-buffers--refresh nil t))

(defun buffer-menu (&optional arg)
  "Switch to the Buffer Menu.
By default, the Buffer Menu lists all buffers except those whose
names start with a space (which are for internal use).  With
prefix argument ARG, show only buffers that are visiting files.

In the Buffer Menu, the first column (denoted \"C\") shows \".\"
for the buffer from which you came, \">\" for buffers you mark to
be displayed, and \"D\" for those you mark for deletion.

The \"R\" column has a \"%\" if the buffer is read-only.
The \"M\" column has a \"*\" if it is modified, or \"S\" if you
have marked it for saving.

The remaining columns show the buffer name, the buffer size in
characters, its major mode, and the visited file name (if any).

See `Buffer-menu-mode' for the keybindings available the Buffer
294 295 296 297 298
Menu.

The width of the various columns can be customized by changing
the `Buffer-menu-name-width', `Buffer-menu-size-width' and
`Buffer-menu-mode-width' variables."
299 300 301 302 303 304
  (interactive "P")
  (switch-to-buffer (list-buffers-noselect arg))
  (message
   "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))

(defun buffer-menu-other-window (&optional arg)
305 306 307 308 309 310
  "Display the Buffer Menu in another window.
See `buffer-menu' for a description of the Buffer Menu.

By default, all buffers are listed except those whose names start
with a space (which are for internal use).  With prefix argument
ARG, show only buffers that are visiting files."
Jim Blandy's avatar
Jim Blandy committed
311
  (interactive "P")
312
  (switch-to-buffer-other-window (list-buffers-noselect arg))
Jim Blandy's avatar
Jim Blandy committed
313
  (message
314 315
   "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))

316
;;;###autoload
317 318 319
(defun list-buffers (&optional arg)
  "Display a list of existing buffers.
The list is displayed in a buffer named \"*Buffer List*\".
Chong Yidong's avatar
Chong Yidong committed
320
See `buffer-menu' for a description of the Buffer Menu.
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356

By default, all buffers are listed except those whose names start
with a space (which are for internal use).  With prefix argument
ARG, show only buffers that are visiting files."
  (interactive "P")
  (display-buffer (list-buffers-noselect arg)))

(defun Buffer-menu-toggle-files-only (arg)
  "Toggle whether the current buffer-menu displays only file buffers.
With a positive ARG, display only file buffers.  With zero or
negative ARG, display other buffers as well."
  (interactive "P")
  (setq Buffer-menu-files-only
	(cond ((not arg) (not Buffer-menu-files-only))
	      ((> (prefix-numeric-value arg) 0) t)))
  (message (if Buffer-menu-files-only
	       "Showing only file-visiting buffers."
	     "Showing all non-internal buffers."))
  (revert-buffer))

(defalias 'Buffer-menu-sort 'tabulated-list-sort)


(defun Buffer-menu-buffer (&optional error-if-non-existent-p)
  "Return the buffer described by the current Buffer Menu line.
If there is no buffer here, return nil if ERROR-IF-NON-EXISTENT-P
is nil or omitted, and signal an error otherwise."
  (let ((buffer (tabulated-list-get-id)))
    (cond ((null buffer)
	   (if error-if-non-existent-p
	       (error "No buffer on this line")))
	  ((not (buffer-live-p buffer))
	   (if error-if-non-existent-p
	       (error "This buffer has been killed")))
	  (t buffer))))

357 358 359
(defun Buffer-menu-no-header ()
  (beginning-of-line)
  (if (or Buffer-menu-use-header-line
360
	  (not (tabulated-list-header-overlay-p (point))))
361 362 363 364 365
      t
    (ding)
    (forward-line 1)
    nil))

366 367 368 369 370 371 372 373
(defun Buffer-menu-beginning ()
  (goto-char (point-min))
  (unless Buffer-menu-use-header-line
    (forward-line)))


;;; Commands for modifying Buffer Menu entries.

Jim Blandy's avatar
Jim Blandy committed
374
(defun Buffer-menu-mark ()
375 376
  "Mark the Buffer menu entry at point for later display.
It will be displayed by the \\<Buffer-menu-mode-map>\\[Buffer-menu-select] command."
Jim Blandy's avatar
Jim Blandy committed
377
  (interactive)
378
  (tabulated-list-set-col 0 (char-to-string Buffer-menu-marker-char) t)
379
  (forward-line))
Jim Blandy's avatar
Jim Blandy committed
380

381 382
(defun Buffer-menu-unmark (&optional backup)
  "Cancel all requested operations on buffer on this line and move down.
383
Optional prefix arg means move up."
384
  (interactive "P")
385
  (Buffer-menu--unmark)
386
  (forward-line (if backup -1 1)))
Jim Blandy's avatar
Jim Blandy committed
387

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
(defun Buffer-menu-unmark-all-buffers (mark)
  "Cancel a requested operation on all buffers.
MARK is the character to flag the operation on the buffers.
When called interactively prompt for MARK;  RET remove all marks."
  (interactive "cRemove marks (RET means all):")
  (save-excursion
    (goto-char (point-min))
    (when (tabulated-list-header-overlay-p)
      (forward-line))
    (while (not (eobp))
      (let ((xmarks (list (aref (tabulated-list-get-entry) 0)
                          (aref (tabulated-list-get-entry) 2))))
        (when (or (char-equal mark ?\r)
                  (member (char-to-string mark) xmarks))
          (Buffer-menu--unmark)))
      (forward-line))))

(defun Buffer-menu-unmark-all ()
  "Cancel all requested operations on buffers."
  (interactive)
  (Buffer-menu-unmark-all-buffers ?\r))

Jim Blandy's avatar
Jim Blandy committed
410 411 412 413
(defun Buffer-menu-backup-unmark ()
  "Move up and cancel all requested operations on buffer on line above."
  (interactive)
  (forward-line -1)
414 415 416 417 418 419 420 421 422
  (Buffer-menu--unmark))

(defun Buffer-menu--unmark ()
  (tabulated-list-set-col 0 " " t)
  (let ((buf (Buffer-menu-buffer)))
    (when buf
      (if (buffer-modified-p buf)
          (tabulated-list-set-col 2 "*" t)
        (tabulated-list-set-col 2 " " t)))))
Jim Blandy's avatar
Jim Blandy committed
423

424
(defun Buffer-menu-delete (&optional arg)
425 426 427 428 429 430
  "Mark the buffer on this Buffer Menu buffer line for deletion.
A subsequent \\<Buffer-menu-mode-map>`\\[Buffer-menu-execute]' command
will delete it.

If prefix argument ARG is non-nil, it specifies the number of
buffers to delete; a negative ARG means to delete backwards."
431
  (interactive "p")
432 433 434 435
  (if (or (null arg) (= arg 0))
      (setq arg 1))
  (while (> arg 0)
    (when (Buffer-menu-buffer)
436
      (tabulated-list-set-col 0 (char-to-string Buffer-menu-del-char) t))
437 438 439 440
    (forward-line 1)
    (setq arg (1- arg)))
  (while (< arg 0)
    (when (Buffer-menu-buffer)
441
      (tabulated-list-set-col 0 (char-to-string Buffer-menu-del-char) t))
442 443
    (forward-line -1)
    (setq arg (1+ arg))))
444 445

(defun Buffer-menu-delete-backwards (&optional arg)
446
  "Mark the buffer on this Buffer Menu line for deletion, and move up.
Chong Yidong's avatar
Chong Yidong committed
447 448 449
A subsequent \\<Buffer-menu-mode-map>`\\[Buffer-menu-execute]'
command will delete the marked buffer.  Prefix ARG means move
that many lines."
450
  (interactive "p")
451
  (Buffer-menu-delete (- (or arg 1))))
Jim Blandy's avatar
Jim Blandy committed
452 453

(defun Buffer-menu-save ()
454 455 456
  "Mark the buffer on this Buffer Menu line for saving.
A subsequent \\<Buffer-menu-mode-map>`\\[Buffer-menu-execute]' command
will save it."
Jim Blandy's avatar
Jim Blandy committed
457
  (interactive)
458 459 460
  (when (Buffer-menu-buffer)
    (tabulated-list-set-col 2 "S" t)
    (forward-line 1)))
Jim Blandy's avatar
Jim Blandy committed
461

462
(defun Buffer-menu-not-modified (&optional arg)
463 464 465
  "Mark the buffer on this line as unmodified (no changes to save).
If ARG is non-nil (interactively, with a prefix argument), mark
it as modified."
466
  (interactive "P")
467
  (with-current-buffer (Buffer-menu-buffer t)
468
    (set-buffer-modified-p arg))
469
  (tabulated-list-set-col 2 (if arg "*" " ") t))
470

Jim Blandy's avatar
Jim Blandy committed
471
(defun Buffer-menu-execute ()
472 473 474
  "Save and/or delete marked buffers in the Buffer Menu.
Buffers marked with \\<Buffer-menu-mode-map>`\\[Buffer-menu-save]' are saved.
Buffers marked with \\<Buffer-menu-mode-map>`\\[Buffer-menu-delete]' are deleted."
Jim Blandy's avatar
Jim Blandy committed
475 476
  (interactive)
  (save-excursion
477
    (Buffer-menu-beginning)
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
    (while (not (eobp))
      (let ((buffer (tabulated-list-get-id))
	    (entry  (tabulated-list-get-entry)))
	(cond ((null entry)
	       (forward-line 1))
	      ((not (buffer-live-p buffer))
	       (tabulated-list-delete-entry))
	      (t
	       (let ((delete (eq (char-after) ?D)))
		 (when (equal (aref entry 2) "S")
		   (condition-case nil
		       (progn
			 (with-current-buffer buffer
			   (save-buffer))
			 (tabulated-list-set-col 2 " " t))
		     (error (warn "Error saving %s" buffer))))
Devon Sean McCullough's avatar
Devon Sean McCullough committed
494 495 496 497
		 (if (and delete
			  (not (eq buffer (current-buffer)))
                          (kill-buffer buffer))
                     (tabulated-list-delete-entry)
498
		   (forward-line 1)))))))))
Jim Blandy's avatar
Jim Blandy committed
499 500

(defun Buffer-menu-select ()
501 502
  "Select this line's buffer; also, display buffers marked with `>'.
You can mark buffers with the \\<Buffer-menu-mode-map>`\\[Buffer-menu-mark]' command.
503

504
This command deletes and replaces all the previously existing windows
505
in the selected frame, and will remove any marks."
Jim Blandy's avatar
Jim Blandy committed
506
  (interactive)
507 508 509 510
  (let* ((this-buffer (Buffer-menu-buffer t))
	 (menu-buffer (current-buffer))
	 (others (delq this-buffer (Buffer-menu-marked-buffers t)))
	 (height (/ (1- (frame-height)) (1+ (length others)))))
Jim Blandy's avatar
Jim Blandy committed
511
    (delete-other-windows)
512 513 514 515 516 517 518 519 520 521 522 523 524
    (switch-to-buffer this-buffer)
    (unless (eq menu-buffer this-buffer)
      (bury-buffer menu-buffer))
    (dolist (buffer others)
      (split-window nil height)
      (other-window 1)
      (switch-to-buffer buffer))
    ;; Back to the beginning!
    (other-window 1)))

(defun Buffer-menu-marked-buffers (&optional unmark)
  "Return the list of buffers marked with `Buffer-menu-mark'.
If UNMARK is non-nil, unmark them."
Juri Linkov's avatar
Juri Linkov committed
525 526 527
  (let (buffers)
    (Buffer-menu-beginning)
    (while (re-search-forward "^>" nil t)
528 529 530 531 532
      (let ((buffer (Buffer-menu-buffer)))
	(if (and buffer unmark)
	    (tabulated-list-set-col 0 " " t))
	(if (buffer-live-p buffer)
	    (push buffer buffers))))
Juri Linkov's avatar
Juri Linkov committed
533 534 535 536 537 538 539 540 541 542 543
    (nreverse buffers)))

(defun Buffer-menu-isearch-buffers ()
  "Search for a string through all marked buffers using Isearch."
  (interactive)
  (multi-isearch-buffers (Buffer-menu-marked-buffers)))

(defun Buffer-menu-isearch-buffers-regexp ()
  "Search for a regexp through all marked buffers using Isearch."
  (interactive)
  (multi-isearch-buffers-regexp (Buffer-menu-marked-buffers)))
544

545
(defun Buffer-menu-multi-occur (regexp &optional nlines)
546
  "Show all lines in marked buffers containing a match for a regexp."
547 548
  (interactive (occur-read-primary-args))
  (multi-occur (Buffer-menu-marked-buffers) regexp nlines))
549

Jim Blandy's avatar
Jim Blandy committed
550 551 552 553 554 555 556 557 558 559

(defun Buffer-menu-visit-tags-table ()
  "Visit the tags table in the buffer on this line.  See `visit-tags-table'."
  (interactive)
  (let ((file (buffer-file-name (Buffer-menu-buffer t))))
    (if file
	(visit-tags-table file)
      (error "Specified buffer has no file"))))

(defun Buffer-menu-1-window ()
Jim Blandy's avatar
Jim Blandy committed
560
  "Select this line's buffer, alone, in full frame."
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
  (interactive)
  (switch-to-buffer (Buffer-menu-buffer t))
  (bury-buffer (other-buffer))
  (delete-other-windows))

(defun Buffer-menu-this-window ()
  "Select this line's buffer in this window."
  (interactive)
  (switch-to-buffer (Buffer-menu-buffer t)))

(defun Buffer-menu-other-window ()
  "Select this line's buffer in other window, leaving buffer menu visible."
  (interactive)
  (switch-to-buffer-other-window (Buffer-menu-buffer t)))

Roland McGrath's avatar
Roland McGrath committed
576 577 578 579
(defun Buffer-menu-switch-other-window ()
  "Make the other window select this line's buffer.
The current window remains selected."
  (interactive)
580
  (display-buffer (Buffer-menu-buffer t) t))
Roland McGrath's avatar
Roland McGrath committed
581

Jim Blandy's avatar
Jim Blandy committed
582 583 584 585
(defun Buffer-menu-2-window ()
  "Select this line's buffer, with previous buffer in second window."
  (interactive)
  (let ((buff (Buffer-menu-buffer t))
586
	(menu (current-buffer)))
587
    (delete-other-windows)
Jim Blandy's avatar
Jim Blandy committed
588
    (switch-to-buffer (other-buffer))
589
    (switch-to-buffer-other-window buff)
Jim Blandy's avatar
Jim Blandy committed
590
    (bury-buffer menu)))
Eric S. Raymond's avatar
Eric S. Raymond committed
591

592
(defun Buffer-menu-toggle-read-only ()
593
  "Toggle read-only status of buffer on this line.
594
This behaves like invoking \\[read-only-mode] in that buffer."
595
  (interactive)
596 597
  (let ((read-only
         (with-current-buffer (Buffer-menu-buffer t)
598
           (read-only-mode 'toggle)
599
           buffer-read-only)))
600
    (tabulated-list-set-col 1 (if read-only "%" " ") t)))
601

602 603 604
(defun Buffer-menu-bury ()
  "Bury the buffer listed on this line."
  (interactive)
605 606 607 608 609 610 611 612 613 614 615 616
  (let ((buffer (tabulated-list-get-id)))
    (cond ((null buffer))
	  ((buffer-live-p buffer)
	   (bury-buffer buffer)
	   (save-excursion
	     (let ((elt (tabulated-list-delete-entry)))
	       (goto-char (point-max))
	       (apply 'tabulated-list-print-entry elt)))
	   (message "Buffer buried."))
	  (t
	   (tabulated-list-delete-entry)
	   (message "Buffer is dead; removing from list.")))))
617 618 619 620 621 622 623 624 625 626

(defun Buffer-menu-view ()
  "View this line's buffer in View mode."
  (interactive)
  (view-buffer (Buffer-menu-buffer t)))

(defun Buffer-menu-view-other-window ()
  "View this line's buffer in View mode in another window."
  (interactive)
  (view-buffer-other-window (Buffer-menu-buffer t)))
627

628
;;; Functions for populating the Buffer Menu.
629

630
;;;###autoload
631
(defun list-buffers-noselect (&optional files-only buffer-list)
632 633 634 635 636 637 638 639 640
  "Create and return a Buffer Menu buffer.
This is called by `buffer-menu' and others as a subroutine.

If FILES-ONLY is non-nil, show only file-visiting buffers.
If BUFFER-LIST is non-nil, it should be a list of buffers; it
means list those buffers and no others."
  (let ((old-buffer (current-buffer))
	(buffer (get-buffer-create "*Buffer List*")))
    (with-current-buffer buffer
641
      (Buffer-menu-mode)
Andreas Schwab's avatar
Andreas Schwab committed
642 643
      (setq Buffer-menu-files-only
	    (and files-only (>= (prefix-numeric-value files-only) 0)))
644 645 646 647
      (list-buffers--refresh buffer-list old-buffer)
      (tabulated-list-print))
    buffer))

648 649 650 651 652 653
(defun Buffer-menu-mouse-select (event)
  "Select the buffer whose line you click on."
  (interactive "e")
  (select-window (posn-window (event-end event)))
  (let ((buffer (tabulated-list-get-id (posn-point (event-end event)))))
    (when (buffer-live-p buffer)
654
      (if (and (window-dedicated-p)
655 656 657 658
	       (eq (selected-window) (frame-root-window)))
	  (switch-to-buffer-other-frame buffer)
	(switch-to-buffer buffer)))))

659 660
(defun list-buffers--refresh (&optional buffer-list old-buffer)
  ;; Set up `tabulated-list-format'.
661
  (let ((size-width Buffer-menu-size-width)
662 663 664
        (marked-buffers (Buffer-menu-marked-buffers))
        (buffer-menu-buffer (current-buffer))
	(show-non-file (not Buffer-menu-files-only))
665
	entries name-width)
666
    ;; Collect info for each buffer we're interested in.
667 668 669 670 671 672 673 674
    (dolist (buffer (or buffer-list
			(buffer-list (if Buffer-menu-use-frame-buffer-list
					 (selected-frame)))))
      (with-current-buffer buffer
	(let* ((name (buffer-name))
	       (file buffer-file-name))
	  (when (and (buffer-live-p buffer)
		     (or buffer-list
Tino Calancha's avatar
Tino Calancha committed
675 676
			 (and (or (not (string= (substring name 0 1) " "))
                                  file)
677 678 679
			      (not (eq buffer buffer-menu-buffer))
			      (or file show-non-file))))
	    (push (list buffer
680 681 682 683
			(vector (cond
                                 ((eq buffer old-buffer) ".")
                                 ((member buffer marked-buffers) ">")
                                 (t " "))
684 685 686 687
				(if buffer-read-only "%" " ")
				(if (buffer-modified-p) "*" " ")
				(Buffer-menu--pretty-name name)
				(number-to-string (buffer-size))
688 689
				(concat (format-mode-line mode-name
                                                          nil nil buffer)
690 691 692 693 694
					(if mode-line-process
					    (format-mode-line mode-line-process
							      nil nil buffer)))
				(Buffer-menu--pretty-file-name file)))
		  entries)))))
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
    (setq name-width (if (functionp Buffer-menu-name-width)
                         (funcall Buffer-menu-name-width (mapcar #'car entries))
                       Buffer-menu-name-width))
    ;; Handle obsolete variable:
    (if Buffer-menu-buffer+size-width
	(setq name-width (- Buffer-menu-buffer+size-width size-width)))
    (setq tabulated-list-format
	  (vector '("C" 1 t :pad-right 0)
		  '("R" 1 t :pad-right 0)
		  '("M" 1 t)
		  `("Buffer" ,name-width t)
		  `("Size" ,size-width tabulated-list-entry-size->
                    :right-align t)
		  `("Mode" ,Buffer-menu-mode-width t)
		  '("File" 1 t)))
    (setq tabulated-list-use-header-line Buffer-menu-use-header-line)
711 712 713 714 715 716 717 718
    (setq tabulated-list-entries (nreverse entries)))
  (tabulated-list-init-header))

(defun tabulated-list-entry-size-> (entry1 entry2)
  (> (string-to-number (aref (cadr entry1) 4))
     (string-to-number (aref (cadr entry2) 4))))

(defun Buffer-menu--pretty-name (name)
719 720 721
  (propertize name
	      'font-lock-face 'buffer-menu-buffer
	      'mouse-face 'highlight))
722 723 724 725

(defun Buffer-menu--pretty-file-name (file)
  (cond (file
	 (abbreviate-file-name file))
726 727
	((bound-and-true-p list-buffers-directory)
         (abbreviate-file-name list-buffers-directory))
728 729
	(t "")))

Eric S. Raymond's avatar
Eric S. Raymond committed
730
;;; buff-menu.el ends here