Commit | Line | Data |
---|---|---|
c0274f38 ER |
1 | ;;; buff-menu.el --- buffer menu main function and support functions. |
2 | ||
d733c5ec | 3 | ;; Copyright (C) 1985, 1986, 1987, 1993, 1994 Free Software Foundation, Inc. |
2dd96f23 | 4 | |
9750e079 ER |
5 | ;; Maintainer: FSF |
6 | ||
2dd96f23 JB |
7 | ;; This file is part of GNU Emacs. |
8 | ||
9 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 | ;; it under the terms of the GNU General Public License as published by | |
35aaf00c | 11 | ;; the Free Software Foundation; either version 2, or (at your option) |
2dd96f23 JB |
12 | ;; any later version. |
13 | ||
14 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | ;; GNU General Public License for more details. | |
18 | ||
19 | ;; You should have received a copy of the GNU General Public License | |
20 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
21 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
22 | ||
e41b2db1 ER |
23 | ;;; Commentary: |
24 | ||
25 | ;; Edit, delete, or change attributes of all currently active Emacs | |
eb8c3be9 | 26 | ;; buffers from a list summarizing their state. A good way to browse |
e41b2db1 | 27 | ;; any special or scratch buffers you have loaded, since you can't find |
86dbbfc2 ER |
28 | ;; them by filename. The single entry point is `Buffer-menu-mode', |
29 | ;; normally bound to C-x C-b. | |
30 | ||
31 | ;;; Change Log: | |
32 | ||
33 | ;; Merged by esr with recent mods to Emacs 19 buff-menu, 23 Mar 1993 | |
34 | ;; | |
86dbbfc2 ER |
35 | ;; Modified by Bob Weiner, Motorola, Inc., 4/14/89 |
36 | ;; | |
37 | ;; Added optional backup argument to 'Buffer-menu-unmark' to make it undelete | |
38 | ;; current entry and then move to previous one. | |
39 | ;; | |
40 | ;; Based on FSF code dating back to 1985. | |
e41b2db1 | 41 | |
5de9bdab | 42 | ;;; Code: |
86dbbfc2 | 43 | |
3ed788ec RS |
44 | ;;;Not needed, now that q is now just quit and Buffer-menu-select is v. |
45 | ;;;(defvar Buffer-menu-window-config nil | |
46 | ;;; "Window configuration saved from entry to `buffer-menu'.") | |
2dd96f23 JB |
47 | |
48 | ; Put buffer *Buffer List* into proper mode right away | |
49 | ; so that from now on even list-buffers is enough to get a buffer menu. | |
50 | ||
e5ea316b KH |
51 | (defvar Buffer-menu-buffer-column nil) |
52 | ||
2dd96f23 JB |
53 | (defvar Buffer-menu-mode-map nil "") |
54 | ||
55 | (if Buffer-menu-mode-map | |
56 | () | |
57 | (setq Buffer-menu-mode-map (make-keymap)) | |
58 | (suppress-keymap Buffer-menu-mode-map t) | |
3ed788ec RS |
59 | (define-key Buffer-menu-mode-map "q" 'Buffer-menu-quit) |
60 | (define-key Buffer-menu-mode-map "v" 'Buffer-menu-select) | |
2dd96f23 JB |
61 | (define-key Buffer-menu-mode-map "2" 'Buffer-menu-2-window) |
62 | (define-key Buffer-menu-mode-map "1" 'Buffer-menu-1-window) | |
63 | (define-key Buffer-menu-mode-map "f" 'Buffer-menu-this-window) | |
64 | (define-key Buffer-menu-mode-map "o" 'Buffer-menu-other-window) | |
35aaf00c | 65 | (define-key Buffer-menu-mode-map "\C-o" 'Buffer-menu-switch-other-window) |
2dd96f23 JB |
66 | (define-key Buffer-menu-mode-map "s" 'Buffer-menu-save) |
67 | (define-key Buffer-menu-mode-map "d" 'Buffer-menu-delete) | |
68 | (define-key Buffer-menu-mode-map "k" 'Buffer-menu-delete) | |
69 | (define-key Buffer-menu-mode-map "\C-d" 'Buffer-menu-delete-backwards) | |
70 | (define-key Buffer-menu-mode-map "\C-k" 'Buffer-menu-delete) | |
71 | (define-key Buffer-menu-mode-map "x" 'Buffer-menu-execute) | |
72 | (define-key Buffer-menu-mode-map " " 'next-line) | |
73 | (define-key Buffer-menu-mode-map "n" 'next-line) | |
74 | (define-key Buffer-menu-mode-map "p" 'previous-line) | |
75 | (define-key Buffer-menu-mode-map "\177" 'Buffer-menu-backup-unmark) | |
76 | (define-key Buffer-menu-mode-map "~" 'Buffer-menu-not-modified) | |
77 | (define-key Buffer-menu-mode-map "?" 'describe-mode) | |
78 | (define-key Buffer-menu-mode-map "u" 'Buffer-menu-unmark) | |
79 | (define-key Buffer-menu-mode-map "m" 'Buffer-menu-mark) | |
d91e2b1a ER |
80 | (define-key Buffer-menu-mode-map "t" 'Buffer-menu-visit-tags-table) |
81 | (define-key Buffer-menu-mode-map "%" 'Buffer-menu-toggle-read-only) | |
710e5da8 | 82 | (define-key Buffer-menu-mode-map "g" 'revert-buffer) |
2cf5fc7e | 83 | (define-key Buffer-menu-mode-map [mouse-2] 'Buffer-menu-mouse-select) |
d91e2b1a | 84 | ) |
2dd96f23 JB |
85 | |
86 | ;; Buffer Menu mode is suitable only for specially formatted data. | |
87 | (put 'Buffer-menu-mode 'mode-class 'special) | |
88 | ||
89 | (defun Buffer-menu-mode () | |
90 | "Major mode for editing a list of buffers. | |
91 | Each line describes one of the buffers in Emacs. | |
92 | Letters do not insert themselves; instead, they are commands. | |
93 | \\<Buffer-menu-mode-map> | |
2cf5fc7e RS |
94 | \\[Buffer-menu-mouse-select] -- select buffer you click on, in place of the buffer menu. |
95 | \\[Buffer-menu-this-window] -- select current line's buffer in place of the buffer menu. | |
96 | \\[Buffer-menu-other-window] -- select that buffer in another window, | |
97 | so the buffer menu buffer remains visible in its window. | |
98 | \\[Buffer-menu-switch-other-window] -- make another window display that buffer. | |
99 | \\[Buffer-menu-mark] -- mark current line's buffer to be displayed. | |
100 | \\[Buffer-menu-select] -- select current line's buffer. | |
101 | Also show buffers marked with m, in other windows. | |
dc6d9681 | 102 | \\[Buffer-menu-1-window] -- select that buffer in full-frame window. |
2dd96f23 JB |
103 | \\[Buffer-menu-2-window] -- select that buffer in one window, |
104 | together with buffer selected before this one in another window. | |
2dd96f23 JB |
105 | \\[Buffer-menu-visit-tags-table] -- visit-tags-table this buffer. |
106 | \\[Buffer-menu-not-modified] -- clear modified-flag on that buffer. | |
107 | \\[Buffer-menu-save] -- mark that buffer to be saved, and move down. | |
108 | \\[Buffer-menu-delete] -- mark that buffer to be deleted, and move down. | |
109 | \\[Buffer-menu-delete-backwards] -- mark that buffer to be deleted, and move up. | |
110 | \\[Buffer-menu-execute] -- delete or save marked buffers. | |
111 | \\[Buffer-menu-unmark] -- remove all kinds of marks from current line. | |
86dbbfc2 | 112 | With prefix argument, also move up one line. |
d91e2b1a ER |
113 | \\[Buffer-menu-backup-unmark] -- back up a line and remove marks. |
114 | \\[Buffer-menu-toggle-read-only] -- toggle read-only status of buffer on this line." | |
2dd96f23 JB |
115 | (kill-all-local-variables) |
116 | (use-local-map Buffer-menu-mode-map) | |
2dd96f23 JB |
117 | (setq major-mode 'Buffer-menu-mode) |
118 | (setq mode-name "Buffer Menu") | |
823316aa KH |
119 | (save-excursion |
120 | (goto-char (point-min)) | |
e5ea316b KH |
121 | (search-forward "Buffer") |
122 | (backward-word 1) | |
123 | (setq Buffer-menu-buffer-column (current-column)) | |
823316aa KH |
124 | (forward-line 2) |
125 | (while (not (eobp)) | |
e5ea316b KH |
126 | (let ((where (Buffer-menu-buffer-name-position))) |
127 | (put-text-property (car where) (cdr where) 'mouse-face 'highlight)) | |
823316aa | 128 | (forward-line 1))) |
710e5da8 RS |
129 | (make-local-variable 'revert-buffer-function) |
130 | (setq revert-buffer-function 'Buffer-menu-revert-function) | |
823316aa KH |
131 | (setq truncate-lines t) |
132 | (setq buffer-read-only t) | |
2dd96f23 | 133 | (run-hooks 'buffer-menu-mode-hook)) |
710e5da8 RS |
134 | |
135 | (defun Buffer-menu-revert-function (ignore1 ignore2) | |
136 | (list-buffers)) | |
2dd96f23 | 137 | \f |
2dd96f23 JB |
138 | (defun Buffer-menu-buffer (error-if-non-existent-p) |
139 | "Return buffer described by this line of buffer menu." | |
e5ea316b KH |
140 | (let* ((where (Buffer-menu-buffer-name-position)) |
141 | (string (buffer-substring (car where) (cdr where)))) | |
142 | (or (get-buffer string) | |
143 | (if error-if-non-existent-p | |
144 | (error "No buffer named \"%s\"" string) | |
145 | nil)))) | |
146 | ||
147 | ;; Find the start and end positions of the buffer name on this line. | |
148 | ;; Returns a cons (START . END). | |
149 | (defun Buffer-menu-buffer-name-position () | |
2dd96f23 JB |
150 | (save-excursion |
151 | (beginning-of-line) | |
152 | (forward-char Buffer-menu-buffer-column) | |
e5ea316b | 153 | (let ((start (point))) |
2dd96f23 JB |
154 | (re-search-forward "\t\\| ") |
155 | (skip-chars-backward " \t") | |
e5ea316b | 156 | (cons start (point))))) |
2dd96f23 | 157 | \f |
06b1a5ef | 158 | (defun buffer-menu (&optional arg) |
2dd96f23 JB |
159 | "Make a menu of buffers so you can save, delete or select them. |
160 | With argument, show only buffers that are visiting files. | |
161 | Type ? after invocation to get help on commands available. | |
86dbbfc2 ER |
162 | Type q immediately to make the buffer menu go away and to restore |
163 | previous window configuration." | |
2dd96f23 | 164 | (interactive "P") |
3ed788ec | 165 | ;;; (setq Buffer-menu-window-config (current-window-configuration)) |
95b9ce23 | 166 | (list-buffers arg) |
70e808bd RS |
167 | (let ((newpoint (save-excursion (set-buffer "*Buffer List*") |
168 | (point)))) | |
169 | (pop-to-buffer "*Buffer List*") | |
170 | (goto-char newpoint)) | |
2dd96f23 | 171 | (message |
3ed788ec RS |
172 | "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help.")) |
173 | ||
174 | (defun Buffer-menu-quit () | |
175 | "Quit the buffer menu." | |
176 | (interactive) | |
177 | (let ((buffer (current-buffer))) | |
178 | ;; Restore previous window configuration before displaying | |
179 | ;; selected buffers. | |
180 | (switch-to-buffer (other-buffer)) | |
181 | (bury-buffer buffer))) | |
2dd96f23 JB |
182 | |
183 | (defun Buffer-menu-mark () | |
184 | "Mark buffer on this line for being displayed by \\<Buffer-menu-mode-map>\\[Buffer-menu-select] command." | |
185 | (interactive) | |
186 | (beginning-of-line) | |
187 | (if (looking-at " [-M]") | |
188 | (ding) | |
189 | (let ((buffer-read-only nil)) | |
190 | (delete-char 1) | |
191 | (insert ?>) | |
192 | (forward-line 1)))) | |
193 | ||
86dbbfc2 ER |
194 | (defun Buffer-menu-unmark (&optional backup) |
195 | "Cancel all requested operations on buffer on this line and move down. | |
196 | Optional ARG means move up." | |
197 | (interactive "P") | |
2dd96f23 JB |
198 | (beginning-of-line) |
199 | (if (looking-at " [-M]") | |
200 | (ding) | |
201 | (let* ((buf (Buffer-menu-buffer t)) | |
202 | (mod (buffer-modified-p buf)) | |
203 | (readonly (save-excursion (set-buffer buf) buffer-read-only)) | |
204 | (buffer-read-only nil)) | |
205 | (delete-char 3) | |
206 | (insert (if readonly (if mod " *%" " %") (if mod " * " " "))))) | |
86dbbfc2 | 207 | (forward-line (if backup -1 1))) |
2dd96f23 JB |
208 | |
209 | (defun Buffer-menu-backup-unmark () | |
210 | "Move up and cancel all requested operations on buffer on line above." | |
211 | (interactive) | |
212 | (forward-line -1) | |
213 | (Buffer-menu-unmark) | |
214 | (forward-line -1)) | |
215 | ||
216 | (defun Buffer-menu-delete () | |
217 | "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command." | |
218 | (interactive) | |
219 | (beginning-of-line) | |
220 | (if (looking-at " [-M]") ;header lines | |
221 | (ding) | |
222 | (let ((buffer-read-only nil)) | |
223 | (delete-char 1) | |
224 | (insert ?D) | |
225 | (forward-line 1)))) | |
226 | ||
227 | (defun Buffer-menu-delete-backwards () | |
228 | "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command | |
229 | and then move up one line" | |
230 | (interactive) | |
231 | (Buffer-menu-delete) | |
232 | (forward-line -2) | |
233 | (if (looking-at " [-M]") (forward-line 1))) | |
234 | ||
235 | (defun Buffer-menu-save () | |
236 | "Mark buffer on this line to be saved by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command." | |
237 | (interactive) | |
238 | (beginning-of-line) | |
239 | (forward-char 1) | |
240 | (if (looking-at " [-M]") ;header lines | |
241 | (ding) | |
242 | (let ((buffer-read-only nil)) | |
243 | (delete-char 1) | |
244 | (insert ?S) | |
245 | (forward-line 1)))) | |
246 | ||
a8ce00dc | 247 | (defun Buffer-menu-not-modified (&optional arg) |
2dd96f23 | 248 | "Mark buffer on this line as unmodified (no changes to save)." |
a8ce00dc | 249 | (interactive "P") |
2dd96f23 JB |
250 | (save-excursion |
251 | (set-buffer (Buffer-menu-buffer t)) | |
a8ce00dc | 252 | (set-buffer-modified-p arg)) |
2dd96f23 JB |
253 | (save-excursion |
254 | (beginning-of-line) | |
255 | (forward-char 1) | |
a8ce00dc | 256 | (if (= (char-after (point)) (if arg ? ?*)) |
2dd96f23 JB |
257 | (let ((buffer-read-only nil)) |
258 | (delete-char 1) | |
a8ce00dc | 259 | (insert (if arg ?* ? )))))) |
2dd96f23 JB |
260 | |
261 | (defun Buffer-menu-execute () | |
262 | "Save and/or delete buffers marked with \\<Buffer-menu-mode-map>\\[Buffer-menu-save] or \\<Buffer-menu-mode-map>\\[Buffer-menu-delete] commands." | |
263 | (interactive) | |
264 | (save-excursion | |
265 | (goto-char (point-min)) | |
266 | (forward-line 1) | |
267 | (while (re-search-forward "^.S" nil t) | |
268 | (let ((modp nil)) | |
269 | (save-excursion | |
270 | (set-buffer (Buffer-menu-buffer t)) | |
271 | (save-buffer) | |
272 | (setq modp (buffer-modified-p))) | |
273 | (let ((buffer-read-only nil)) | |
274 | (delete-char -1) | |
275 | (insert (if modp ?* ? )))))) | |
276 | (save-excursion | |
277 | (goto-char (point-min)) | |
278 | (forward-line 1) | |
279 | (let ((buff-menu-buffer (current-buffer)) | |
280 | (buffer-read-only nil)) | |
281 | (while (search-forward "\nD" nil t) | |
282 | (forward-char -1) | |
283 | (let ((buf (Buffer-menu-buffer nil))) | |
284 | (or (eq buf nil) | |
285 | (eq buf buff-menu-buffer) | |
286 | (save-excursion (kill-buffer buf)))) | |
287 | (if (Buffer-menu-buffer nil) | |
288 | (progn (delete-char 1) | |
289 | (insert ? )) | |
290 | (delete-region (point) (progn (forward-line 1) (point))) | |
291 | (forward-char -1)))))) | |
292 | ||
293 | (defun Buffer-menu-select () | |
294 | "Select this line's buffer; also display buffers marked with `>'. | |
295 | You can mark buffers with the \\<Buffer-menu-mode-map>\\[Buffer-menu-mark] command." | |
296 | (interactive) | |
297 | (let ((buff (Buffer-menu-buffer t)) | |
298 | (menu (current-buffer)) | |
299 | (others ()) | |
300 | tem) | |
301 | (goto-char (point-min)) | |
302 | (while (search-forward "\n>" nil t) | |
303 | (setq tem (Buffer-menu-buffer t)) | |
304 | (let ((buffer-read-only nil)) | |
305 | (delete-char -1) | |
306 | (insert ?\ )) | |
307 | (or (eq tem buff) (memq tem others) (setq others (cons tem others)))) | |
308 | (setq others (nreverse others) | |
dc6d9681 | 309 | tem (/ (1- (frame-height)) (1+ (length others)))) |
2dd96f23 JB |
310 | (delete-other-windows) |
311 | (switch-to-buffer buff) | |
312 | (or (eq menu buff) | |
313 | (bury-buffer menu)) | |
86dbbfc2 ER |
314 | (if (equal (length others) 0) |
315 | (progn | |
3ed788ec RS |
316 | ;;; ;; Restore previous window configuration before displaying |
317 | ;;; ;; selected buffers. | |
318 | ;;; (if Buffer-menu-window-config | |
319 | ;;; (progn | |
320 | ;;; (set-window-configuration Buffer-menu-window-config) | |
321 | ;;; (setq Buffer-menu-window-config nil))) | |
86dbbfc2 ER |
322 | (switch-to-buffer buff)) |
323 | (while others | |
324 | (split-window nil tem) | |
325 | (other-window 1) | |
326 | (switch-to-buffer (car others)) | |
327 | (setq others (cdr others))) | |
328 | (other-window 1) ;back to the beginning! | |
329 | ))) | |
330 | ||
2dd96f23 JB |
331 | \f |
332 | (defun Buffer-menu-visit-tags-table () | |
333 | "Visit the tags table in the buffer on this line. See `visit-tags-table'." | |
334 | (interactive) | |
335 | (let ((file (buffer-file-name (Buffer-menu-buffer t)))) | |
336 | (if file | |
337 | (visit-tags-table file) | |
338 | (error "Specified buffer has no file")))) | |
339 | ||
340 | (defun Buffer-menu-1-window () | |
dc6d9681 | 341 | "Select this line's buffer, alone, in full frame." |
2dd96f23 JB |
342 | (interactive) |
343 | (switch-to-buffer (Buffer-menu-buffer t)) | |
344 | (bury-buffer (other-buffer)) | |
345 | (delete-other-windows)) | |
346 | ||
2cf5fc7e RS |
347 | (defun Buffer-menu-mouse-select (event) |
348 | "Select the buffer whose line you click on." | |
349 | (interactive "e") | |
350 | (let (buffer) | |
351 | (save-excursion | |
352 | (set-buffer (window-buffer (posn-window (event-end event)))) | |
353 | (save-excursion | |
354 | (goto-char (posn-point (event-end event))) | |
355 | (setq buffer (Buffer-menu-buffer t)))) | |
356 | (select-window (posn-window (event-end event))) | |
d953b88c RS |
357 | (if (and (window-dedicated-p (selected-window)) |
358 | (eq (selected-window) (frame-root-window))) | |
359 | (switch-to-buffer-other-frame buffer) | |
360 | (switch-to-buffer buffer)))) | |
2cf5fc7e | 361 | |
2dd96f23 JB |
362 | (defun Buffer-menu-this-window () |
363 | "Select this line's buffer in this window." | |
364 | (interactive) | |
365 | (switch-to-buffer (Buffer-menu-buffer t))) | |
366 | ||
367 | (defun Buffer-menu-other-window () | |
368 | "Select this line's buffer in other window, leaving buffer menu visible." | |
369 | (interactive) | |
370 | (switch-to-buffer-other-window (Buffer-menu-buffer t))) | |
371 | ||
35aaf00c RM |
372 | (defun Buffer-menu-switch-other-window () |
373 | "Make the other window select this line's buffer. | |
374 | The current window remains selected." | |
375 | (interactive) | |
376 | (display-buffer (Buffer-menu-buffer t))) | |
377 | ||
2dd96f23 JB |
378 | (defun Buffer-menu-2-window () |
379 | "Select this line's buffer, with previous buffer in second window." | |
380 | (interactive) | |
381 | (let ((buff (Buffer-menu-buffer t)) | |
382 | (menu (current-buffer)) | |
383 | (pop-up-windows t)) | |
86dbbfc2 | 384 | (delete-other-windows) |
2dd96f23 JB |
385 | (switch-to-buffer (other-buffer)) |
386 | (pop-to-buffer buff) | |
387 | (bury-buffer menu))) | |
c0274f38 | 388 | |
d91e2b1a | 389 | (defun Buffer-menu-toggle-read-only () |
f450965c | 390 | "Toggle read-only status of buffer on this line, perhaps via version control." |
d91e2b1a ER |
391 | (interactive) |
392 | (let (char) | |
393 | (save-excursion | |
394 | (set-buffer (Buffer-menu-buffer t)) | |
f450965c | 395 | (vc-toggle-read-only) |
d91e2b1a ER |
396 | (setq char (if buffer-read-only ?% ? ))) |
397 | (save-excursion | |
398 | (beginning-of-line) | |
399 | (forward-char 2) | |
400 | (if (/= (following-char) char) | |
401 | (let (buffer-read-only) | |
402 | (delete-char 1) | |
403 | (insert char)))))) | |
404 | ||
c0274f38 | 405 | ;;; buff-menu.el ends here |