1 ;;; buff-menu.el --- buffer menu main function and support functions.
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95 Free Software Foundation, Inc.
6 ;; Keywords: extensions, dumped
8 ;; This file is part of SXEmacs.
10 ;; SXEmacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; SXEmacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Synched up with: FSF 19.34 except as noted.
27 ;; This file is dumped with SXEmacs.
29 ;; Edit, delete, or change attributes of all currently active Emacs
30 ;; buffers from a list summarizing their state. A good way to browse
31 ;; any special or scratch buffers you have loaded, since you can't find
32 ;; them by filename. The single entry point is `Buffer-menu-mode',
33 ;; normally bound to C-x C-b.
37 ;; Merged by esr with recent mods to Emacs 19 buff-menu, 23 Mar 1993
39 ;; Modified by Bob Weiner, Motorola, Inc., 4/14/89
41 ;; Added optional backup argument to 'Buffer-menu-unmark' to make it undelete
42 ;; current entry and then move to previous one.
44 ;; Based on FSF code dating back to 1985.
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.
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.
59 ;;;(defvar Buffer-menu-window-config nil
60 ;;; "Window configuration saved from entry to `buffer-menu'.")
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.
65 (defvar Buffer-menu-buffer-column 4)
67 (defvar Buffer-menu-mode-map nil)
69 (if Buffer-menu-mode-map
71 (setq Buffer-menu-mode-map (make-keymap))
72 (suppress-keymap Buffer-menu-mode-map t)
73 (set-keymap-name Buffer-menu-mode-map 'Buffer-menu-mode-map) ; XEmacs
74 (define-key Buffer-menu-mode-map "q" 'Buffer-menu-quit)
75 (define-key Buffer-menu-mode-map "v" 'Buffer-menu-select)
76 (define-key Buffer-menu-mode-map "2" 'Buffer-menu-2-window)
77 (define-key Buffer-menu-mode-map "1" 'Buffer-menu-1-window)
78 (define-key Buffer-menu-mode-map "f" 'Buffer-menu-this-window)
79 (define-key Buffer-menu-mode-map "\C-m" 'Buffer-menu-this-window)
80 (define-key Buffer-menu-mode-map "o" 'Buffer-menu-other-window)
81 (define-key Buffer-menu-mode-map "\C-o" 'Buffer-menu-switch-other-window)
82 (define-key Buffer-menu-mode-map "s" 'Buffer-menu-save)
83 (define-key Buffer-menu-mode-map "d" 'Buffer-menu-delete)
84 (define-key Buffer-menu-mode-map "k" 'Buffer-menu-delete)
85 (define-key Buffer-menu-mode-map "\C-d" 'Buffer-menu-delete-backwards)
86 (define-key Buffer-menu-mode-map "\C-k" 'Buffer-menu-delete)
87 (define-key Buffer-menu-mode-map "x" 'Buffer-menu-execute)
88 (define-key Buffer-menu-mode-map " " 'next-line)
89 (define-key Buffer-menu-mode-map "n" 'next-line)
90 (define-key Buffer-menu-mode-map "p" 'previous-line)
91 (define-key Buffer-menu-mode-map 'backspace 'Buffer-menu-backup-unmark)
92 (define-key Buffer-menu-mode-map 'delete 'Buffer-menu-backup-unmark)
93 (define-key Buffer-menu-mode-map "~" 'Buffer-menu-not-modified)
94 (define-key Buffer-menu-mode-map "?" 'describe-mode)
95 (define-key Buffer-menu-mode-map "u" 'Buffer-menu-unmark)
96 (define-key Buffer-menu-mode-map "m" 'Buffer-menu-mark)
97 (define-key Buffer-menu-mode-map "t" 'Buffer-menu-visit-tags-table)
98 (define-key Buffer-menu-mode-map "%" 'Buffer-menu-toggle-read-only)
99 (define-key Buffer-menu-mode-map "g" 'revert-buffer)
100 (define-key Buffer-menu-mode-map 'button2 'Buffer-menu-mouse-select)
101 (define-key Buffer-menu-mode-map 'button3 'Buffer-menu-popup-menu)
104 ;; Buffer Menu mode is suitable only for specially formatted data.
105 (put 'Buffer-menu-mode 'mode-class 'special)
107 (defun Buffer-menu-mode ()
108 "Major mode for editing a list of buffers.
109 Each line describes one of the buffers in Emacs.
110 Letters do not insert themselves; instead, they are commands.
111 \\<Buffer-menu-mode-map>
112 \\[Buffer-menu-mouse-select] -- select buffer you click on, in place of the buffer menu.
113 \\[Buffer-menu-this-window] -- select current line's buffer in place of the buffer menu.
114 \\[Buffer-menu-other-window] -- select that buffer in another window,
115 so the buffer menu buffer remains visible in its window.
116 \\[Buffer-menu-switch-other-window] -- make another window display that buffer.
117 \\[Buffer-menu-mark] -- mark current line's buffer to be displayed.
118 \\[Buffer-menu-select] -- select current line's buffer.
119 Also show buffers marked with m, in other windows.
120 \\[Buffer-menu-1-window] -- select that buffer in full-frame window.
121 \\[Buffer-menu-2-window] -- select that buffer in one window,
122 together with buffer selected before this one in another window.
123 \\[Buffer-menu-visit-tags-table] -- visit-tags-table this buffer.
124 \\[Buffer-menu-not-modified] -- clear modified-flag on that buffer.
125 \\[Buffer-menu-save] -- mark that buffer to be saved, and move down.
126 \\[Buffer-menu-delete] -- mark that buffer to be deleted, and move down.
127 \\[Buffer-menu-delete-backwards] -- mark that buffer to be deleted, and move up.
128 \\[Buffer-menu-execute] -- delete or save marked buffers.
129 \\[Buffer-menu-unmark] -- remove all kinds of marks from current line.
130 With prefix argument, also move up one line.
131 \\[Buffer-menu-backup-unmark] -- back up a line and remove marks.
132 \\[Buffer-menu-toggle-read-only] -- toggle read-only status of buffer on this line."
133 (kill-all-local-variables)
134 (use-local-map Buffer-menu-mode-map)
135 (setq major-mode 'Buffer-menu-mode)
136 (setq mode-name "Buffer Menu")
137 (make-local-variable 'revert-buffer-function)
138 (setq revert-buffer-function 'Buffer-menu-revert-function)
139 (setq truncate-lines t)
140 (setq buffer-read-only t)
141 (make-local-hook 'mouse-track-click-hook) ; XEmacs
142 (add-hook 'mouse-track-click-hook 'Buffer-menu-maybe-mouse-select t t) ; XEmacs
143 (run-hooks 'buffer-menu-mode-hook))
145 (defun Buffer-menu-revert-function (ignore1 ignore2)
148 (defun Buffer-menu-buffer (error-if-non-existent-p)
149 "Return buffer described by this line of buffer menu."
150 (let* ((where (save-excursion
152 (+ (point) Buffer-menu-buffer-column)))
153 (name (and (not (eobp)) (get-text-property where 'buffer-name))))
155 (or (get-buffer name)
156 (if error-if-non-existent-p
157 (error "No buffer named `%s'" name)
159 (if error-if-non-existent-p
160 (error "No buffer on this line")
163 (defun buffer-menu (&optional arg)
164 "Make a menu of buffers so you can save, delete or select them.
165 With argument, show only buffers that are visiting files.
166 Type ? after invocation to get help on commands available.
167 Type q immediately to make the buffer menu go away."
169 ;;; (setq Buffer-menu-window-config (current-window-configuration))
170 (switch-to-buffer (list-buffers-noselect arg))
172 "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))
174 (defun buffer-menu-other-window (&optional arg)
175 "Display a list of buffers in another window.
176 With the buffer list buffer, you can save, delete or select the buffers.
177 With argument, show only buffers that are visiting files.
178 Type ? after invocation to get help on commands available.
179 Type q immediately to make the buffer menu go away."
181 ;;; (setq Buffer-menu-window-config (current-window-configuration))
182 (switch-to-buffer-other-window (list-buffers-noselect arg))
184 "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))
186 (defun Buffer-menu-quit ()
187 "Quit the buffer menu."
189 (let ((buffer (current-buffer)))
190 ;; Switch away from the buffer menu and bury it.
191 (switch-to-buffer (other-buffer))
192 (bury-buffer buffer)))
194 (defun Buffer-menu-mark ()
195 "Mark buffer on this line for being displayed by \\<Buffer-menu-mode-map>\\[Buffer-menu-select] command."
198 (if (looking-at " [-M]")
200 (let ((buffer-read-only nil))
205 (defun Buffer-menu-unmark (&optional backup)
206 "Cancel all requested operations on buffer on this line and move down.
207 Optional ARG means move up."
210 (if (looking-at " [-M]")
212 (let* ((buf (Buffer-menu-buffer t))
213 (mod (buffer-modified-p buf))
214 (readonly (save-excursion (set-buffer buf) buffer-read-only))
215 (buffer-read-only nil))
217 (insert (if readonly (if mod " *%" " %") (if mod " * " " ")))))
218 (forward-line (if backup -1 1)))
220 (defun Buffer-menu-backup-unmark ()
221 "Move up and cancel all requested operations on buffer on line above."
227 (defun Buffer-menu-delete (&optional arg)
228 "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command.
229 Prefix arg is how many buffers to delete.
230 Negative arg means delete backwards."
233 (if (looking-at " [-M]") ;header lines
235 (let ((buffer-read-only nil))
236 (if (or (null arg) (= arg 0))
247 (setq arg (1+ arg))))))
249 (defun Buffer-menu-delete-backwards (&optional arg)
250 "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command
251 and then move up one line. Prefix arg means move that many lines."
253 (Buffer-menu-delete (- (or arg 1)))
254 (while (looking-at " [-M]")
257 (defun Buffer-menu-save ()
258 "Mark buffer on this line to be saved by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command."
261 (if (looking-at " [-M]") ;header lines
263 (let ((buffer-read-only nil))
269 (defun Buffer-menu-not-modified (&optional arg)
270 "Mark buffer on this line as unmodified (no changes to save)."
273 (set-buffer (Buffer-menu-buffer t))
274 (set-buffer-modified-p arg))
278 (if (= (char-after (point)) (if arg ? ?*))
279 (let ((buffer-read-only nil))
281 (insert (if arg ?* ? ))))))
283 (defun Buffer-menu-execute ()
284 "Save and/or delete buffers marked with \\<Buffer-menu-mode-map>\\[Buffer-menu-save] or \\<Buffer-menu-mode-map>\\[Buffer-menu-delete] commands."
287 (goto-char (point-min))
289 (while (re-search-forward "^.S" nil t)
292 (set-buffer (Buffer-menu-buffer t))
294 (setq modp (buffer-modified-p)))
295 (let ((buffer-read-only nil))
297 (insert (if modp ?* ? ))))))
299 (goto-char (point-min))
301 (let ((buff-menu-buffer (current-buffer))
302 (buffer-read-only nil))
303 (while (search-forward "\nD" nil t)
305 (let ((buf (Buffer-menu-buffer nil)))
307 (eq buf buff-menu-buffer)
308 (save-excursion (kill-buffer buf))))
309 (if (Buffer-menu-buffer nil)
310 (progn (delete-char 1)
312 (delete-region (point) (progn (forward-line 1) (point)))
313 (backward-char 1))))))
315 (defun Buffer-menu-select ()
316 "Select this line's buffer; also display buffers marked with `>'.
317 You can mark buffers with the \\<Buffer-menu-mode-map>\\[Buffer-menu-mark] command.
318 This command deletes and replaces all the previously existing windows
319 in the selected frame."
321 (let ((buff (Buffer-menu-buffer t))
322 (menu (current-buffer))
325 (goto-char (point-min))
326 (while (search-forward "\n>" nil t)
327 (setq tem (Buffer-menu-buffer t))
328 (let ((buffer-read-only nil))
331 (or (eq tem buff) (memq tem others) (setq others (cons tem others))))
332 (setq others (nreverse others)
333 tem (/ (1- (frame-height)) (1+ (length others))))
334 (delete-other-windows)
335 (switch-to-buffer buff)
338 (if (equal (length others) 0)
340 ;;; ;; Restore previous window configuration before displaying
341 ;;; ;; selected buffers.
342 ;;; (if Buffer-menu-window-config
344 ;;; (set-window-configuration Buffer-menu-window-config)
345 ;;; (setq Buffer-menu-window-config nil)))
346 (switch-to-buffer buff))
348 (split-window nil tem)
350 (switch-to-buffer (car others))
351 (setq others (cdr others)))
352 (other-window 1) ;back to the beginning!
357 (eval-when-compile (autoload 'visit-tags-table "etags"))
359 (defun Buffer-menu-visit-tags-table ()
360 "Visit the tags table in the buffer on this line. See `visit-tags-table'."
362 (let ((file (buffer-file-name (Buffer-menu-buffer t))))
364 (visit-tags-table file)
365 (error "Specified buffer has no file"))))
367 (defun Buffer-menu-1-window ()
368 "Select this line's buffer, alone, in full frame."
370 (switch-to-buffer (Buffer-menu-buffer t))
371 (bury-buffer (other-buffer))
372 (delete-other-windows)
374 ;; This is to get w->force_start set to nil. Don't ask me, I only work here.
375 (set-window-buffer (selected-window) (current-buffer)))
377 (defun Buffer-menu-mouse-select (event)
378 "Select the buffer whose line you click on."
382 (set-buffer (event-buffer event)) ; XEmacs
384 (goto-char (event-point event)) ; XEmacs
385 (setq buffer (Buffer-menu-buffer t))))
386 (select-window (event-window event)) ; XEmacs
387 (if (and (window-dedicated-p (selected-window))
388 (eq (selected-window) (frame-root-window)))
389 (switch-to-buffer-other-frame buffer)
390 (switch-to-buffer buffer))))
393 (defun Buffer-menu-maybe-mouse-select (event &optional click-count)
395 (and (>= click-count 2)
396 (let ((buffer (current-buffer))
398 (config (current-window-configuration)))
401 (Buffer-menu-mouse-select event)
404 (set-window-configuration config)
409 (defun Buffer-menu-this-window ()
410 "Select this line's buffer in this window."
412 (switch-to-buffer (Buffer-menu-buffer t)))
414 (defun Buffer-menu-other-window ()
415 "Select this line's buffer in other window, leaving buffer menu visible."
417 (switch-to-buffer-other-window (Buffer-menu-buffer t)))
419 (defun Buffer-menu-switch-other-window ()
420 "Make the other window select this line's buffer.
421 The current window remains selected."
423 (display-buffer (Buffer-menu-buffer t)))
425 (defun Buffer-menu-2-window ()
426 "Select this line's buffer, with previous buffer in second window."
428 (let ((buff (Buffer-menu-buffer t))
429 (menu (current-buffer))
431 (delete-other-windows)
432 (switch-to-buffer (other-buffer))
436 (defun Buffer-menu-toggle-read-only ()
437 "Toggle read-only status of buffer on this line, perhaps via version control."
441 (set-buffer (Buffer-menu-buffer t))
442 (modeline-toggle-read-only)
443 (setq char (if buffer-read-only ?% ? )))
447 (if (/= (following-char) char)
448 (let (buffer-read-only)
453 (defvar Buffer-menu-popup-menu
455 ["Select Buffer" Buffer-menu-select t]
456 ["Select buffer Other Window" Buffer-menu-other-window t]
457 ["Clear Buffer Modification Flag" Buffer-menu-not-modified t]
459 ["Mark Buffer for Selection" Buffer-menu-mark t]
460 ["Mark Buffer for Save" Buffer-menu-save t]
461 ["Mark Buffer for Deletion" Buffer-menu-delete t]
462 ["Unmark Buffer" Buffer-menu-unmark t]
464 ["Delete/Save Marked Buffers" Buffer-menu-execute t]
468 (defun Buffer-menu-popup-menu (event)
470 (mouse-set-point event)
472 (let ((buffer (Buffer-menu-buffer nil)))
475 (nconc (list (car Buffer-menu-popup-menu)
477 "Commands on buffer \"" (buffer-name buffer) "\":")
479 (cdr Buffer-menu-popup-menu)))
480 (error "no buffer on this line"))))
484 (defvar list-buffers-header-line
485 (concat " MR Buffer Size Mode File\n"
486 " -- ------ ---- ---- ----\n"))
489 (defvar list-buffers-identification 'default-list-buffers-identification
490 "String used to identify this buffer, or a function of one argument
491 to generate such a string. This variable is always buffer-local.")
492 (make-variable-buffer-local 'list-buffers-identification)
496 (defvar list-buffers-directory nil)
499 (make-variable-buffer-local 'list-buffers-directory)
502 (defun default-list-buffers-identification (output)
504 (let ((file (or (buffer-file-name (current-buffer))
505 (and (boundp 'list-buffers-directory)
506 list-buffers-directory)))
515 ;; right-justify the size
516 (move-to-column 19 t)
520 (setq s (- 6 (- p col)))
521 (while (> s 0) ; speed/consing tradeoff...
529 ;; if the mode-name is really long, clip it for the filename
530 (if (> 0 (setq s (- 39 (current-column))))
531 (delete-char (max s (- eob (point)))))
536 (defun list-buffers-internal (output &optional predicate)
537 (let ((current (current-buffer))
538 (buffers (buffer-list)))
541 (setq buffer-read-only nil)
543 (buffer-disable-undo output)
544 (insert list-buffers-header-line)
548 (buffer (car buffers))
549 (name (buffer-name buffer))
550 this-buffer-line-start)
551 (setq buffers (cdr buffers))
552 (cond ((null name)) ;deleted buffer
554 (not (if (stringp predicate)
555 (string-match predicate name)
556 (funcall predicate buffer))))
560 (let ((ro buffer-read-only)
561 (id list-buffers-identification))
563 (setq this-buffer-line-start (point))
564 (insert (if (eq buffer current)
565 (progn (setq current (point)) ?\.)
567 (insert (if (buffer-modified-p buffer)
573 (if (string-match "[\n\"\\ \t]" name)
574 (let ((print-escape-newlines t))
585 (princ "***" output) (prin1 e output)))
587 (goto-char (point-max)))))
588 (put-nonduplicable-text-property this-buffer-line-start
591 (put-nonduplicable-text-property this-buffer-line-start
597 (if (not (bufferp current))
598 (goto-char current)))))
599 ;(define-key ctl-x-map "\C-b" 'list-buffers)
601 (defun list-buffers (&optional files-only)
602 "Display a list of names of existing buffers.
603 The list is displayed in a buffer named `*Buffer List*'.
604 Note that buffers with names starting with spaces are omitted.
605 Non-nil optional arg FILES-ONLY means mention only file buffers.
607 The M column contains a * for buffers that are modified.
608 The R column contains a % for buffers that are read-only."
609 (interactive (list (if current-prefix-arg t nil))) ; XEmacs
610 (display-buffer (list-buffers-noselect files-only)))
613 (defun list-buffers-noselect (&optional files-only)
614 "Create and return a buffer with a list of names of existing buffers.
615 The buffer is named `*Buffer List*'.
616 Note that buffers with names starting with spaces are omitted.
617 Non-nil optional arg FILES-ONLY means mention only file buffers.
619 The M column contains a * for buffers that are modified.
620 The R column contains a % for buffers that are read-only."
621 (let ((buffer (get-buffer-create "*Buffer List*")))
622 (list-buffers-internal buffer
623 (if (memq files-only '(t nil))
625 (let ((n (buffer-name b)))
626 (cond ((and (/= 0 (length n))
628 ;;don't mention if starts with " "
631 (buffer-file-name b))
637 (defun buffers-menu-omit-invisible-buffers (buf)
638 "For use as a value of `buffers-menu-omit-function'.
639 Omits normally invisible buffers (those whose name begins with a space)."
640 (not (null (string-match "\\` " (buffer-name buf)))))
644 ;;; buff-menu.el ends here