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 XEmacs.
10 ;; XEmacs is free software; you can redistribute it and/or modify it
11 ;; under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; XEmacs is distributed in the hope that it will be useful, but
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ;; General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25 ;;; Synched up with: FSF 19.34 except as noted.
29 ;; This file is dumped with XEmacs.
31 ;; Edit, delete, or change attributes of all currently active Emacs
32 ;; buffers from a list summarizing their state. A good way to browse
33 ;; any special or scratch buffers you have loaded, since you can't find
34 ;; them by filename. The single entry point is `Buffer-menu-mode',
35 ;; normally bound to C-x C-b.
39 ;; Merged by esr with recent mods to Emacs 19 buff-menu, 23 Mar 1993
41 ;; Modified by Bob Weiner, Motorola, Inc., 4/14/89
43 ;; Added optional backup argument to 'Buffer-menu-unmark' to make it undelete
44 ;; current entry and then move to previous one.
46 ;; Based on FSF code dating back to 1985.
50 ;;;Trying to preserve the old window configuration works well in
51 ;;;simple scenarios, when you enter the buffer menu, use it, and exit it.
52 ;;;But it does strange things when you switch back to the buffer list buffer
53 ;;;with C-x b, later on, when the window configuration is different.
54 ;;;The choice seems to be, either restore the window configuration
55 ;;;in all cases, or in no cases.
56 ;;;I decided it was better not to restore the window config at all. -- rms.
58 ;;;But since then, I changed buffer-menu to use the selected window,
59 ;;;so q now once again goes back to the previous window configuration.
61 ;;;(defvar Buffer-menu-window-config nil
62 ;;; "Window configuration saved from entry to `buffer-menu'.")
64 ; Put buffer *Buffer List* into proper mode right away
65 ; so that from now on even list-buffers is enough to get a buffer menu.
67 (defvar Buffer-menu-buffer-column 4)
69 (defvar Buffer-menu-mode-map nil)
71 (if Buffer-menu-mode-map
73 (setq Buffer-menu-mode-map (make-keymap))
74 (suppress-keymap Buffer-menu-mode-map t)
75 (set-keymap-name Buffer-menu-mode-map 'Buffer-menu-mode-map) ; XEmacs
76 (define-key Buffer-menu-mode-map "q" 'Buffer-menu-quit)
77 (define-key Buffer-menu-mode-map "v" 'Buffer-menu-select)
78 (define-key Buffer-menu-mode-map "2" 'Buffer-menu-2-window)
79 (define-key Buffer-menu-mode-map "1" 'Buffer-menu-1-window)
80 (define-key Buffer-menu-mode-map "f" 'Buffer-menu-this-window)
81 (define-key Buffer-menu-mode-map "\C-m" 'Buffer-menu-this-window)
82 (define-key Buffer-menu-mode-map "o" 'Buffer-menu-other-window)
83 (define-key Buffer-menu-mode-map "\C-o" 'Buffer-menu-switch-other-window)
84 (define-key Buffer-menu-mode-map "s" 'Buffer-menu-save)
85 (define-key Buffer-menu-mode-map "d" 'Buffer-menu-delete)
86 (define-key Buffer-menu-mode-map "k" 'Buffer-menu-delete)
87 (define-key Buffer-menu-mode-map "\C-d" 'Buffer-menu-delete-backwards)
88 (define-key Buffer-menu-mode-map "\C-k" 'Buffer-menu-delete)
89 (define-key Buffer-menu-mode-map "x" 'Buffer-menu-execute)
90 (define-key Buffer-menu-mode-map " " 'next-line)
91 (define-key Buffer-menu-mode-map "n" 'next-line)
92 (define-key Buffer-menu-mode-map "p" 'previous-line)
93 (define-key Buffer-menu-mode-map 'backspace 'Buffer-menu-backup-unmark)
94 (define-key Buffer-menu-mode-map 'delete 'Buffer-menu-backup-unmark)
95 (define-key Buffer-menu-mode-map "~" 'Buffer-menu-not-modified)
96 (define-key Buffer-menu-mode-map "?" 'describe-mode)
97 (define-key Buffer-menu-mode-map "u" 'Buffer-menu-unmark)
98 (define-key Buffer-menu-mode-map "m" 'Buffer-menu-mark)
99 (define-key Buffer-menu-mode-map "t" 'Buffer-menu-visit-tags-table)
100 (define-key Buffer-menu-mode-map "%" 'Buffer-menu-toggle-read-only)
101 (define-key Buffer-menu-mode-map "g" 'revert-buffer)
102 (define-key Buffer-menu-mode-map 'button2 'Buffer-menu-mouse-select)
103 (define-key Buffer-menu-mode-map 'button3 'Buffer-menu-popup-menu)
106 ;; Buffer Menu mode is suitable only for specially formatted data.
107 (put 'Buffer-menu-mode 'mode-class 'special)
109 (defun Buffer-menu-mode ()
110 "Major mode for editing a list of buffers.
111 Each line describes one of the buffers in Emacs.
112 Letters do not insert themselves; instead, they are commands.
113 \\<Buffer-menu-mode-map>
114 \\[Buffer-menu-mouse-select] -- select buffer you click on, in place of the buffer menu.
115 \\[Buffer-menu-this-window] -- select current line's buffer in place of the buffer menu.
116 \\[Buffer-menu-other-window] -- select that buffer in another window,
117 so the buffer menu buffer remains visible in its window.
118 \\[Buffer-menu-switch-other-window] -- make another window display that buffer.
119 \\[Buffer-menu-mark] -- mark current line's buffer to be displayed.
120 \\[Buffer-menu-select] -- select current line's buffer.
121 Also show buffers marked with m, in other windows.
122 \\[Buffer-menu-1-window] -- select that buffer in full-frame window.
123 \\[Buffer-menu-2-window] -- select that buffer in one window,
124 together with buffer selected before this one in another window.
125 \\[Buffer-menu-visit-tags-table] -- visit-tags-table this buffer.
126 \\[Buffer-menu-not-modified] -- clear modified-flag on that buffer.
127 \\[Buffer-menu-save] -- mark that buffer to be saved, and move down.
128 \\[Buffer-menu-delete] -- mark that buffer to be deleted, and move down.
129 \\[Buffer-menu-delete-backwards] -- mark that buffer to be deleted, and move up.
130 \\[Buffer-menu-execute] -- delete or save marked buffers.
131 \\[Buffer-menu-unmark] -- remove all kinds of marks from current line.
132 With prefix argument, also move up one line.
133 \\[Buffer-menu-backup-unmark] -- back up a line and remove marks.
134 \\[Buffer-menu-toggle-read-only] -- toggle read-only status of buffer on this line."
135 (kill-all-local-variables)
136 (use-local-map Buffer-menu-mode-map)
137 (setq major-mode 'Buffer-menu-mode)
138 (setq mode-name "Buffer Menu")
139 (make-local-variable 'revert-buffer-function)
140 (setq revert-buffer-function 'Buffer-menu-revert-function)
141 (setq truncate-lines t)
142 (setq buffer-read-only t)
143 (make-local-hook 'mouse-track-click-hook) ; XEmacs
144 (add-hook 'mouse-track-click-hook 'Buffer-menu-maybe-mouse-select t t) ; XEmacs
145 (run-hooks 'buffer-menu-mode-hook))
147 (defun Buffer-menu-revert-function (ignore1 ignore2)
150 (defun Buffer-menu-buffer (error-if-non-existent-p)
151 "Return buffer described by this line of buffer menu."
152 (let* ((where (save-excursion
154 (+ (point) Buffer-menu-buffer-column)))
155 (name (and (not (eobp)) (get-text-property where 'buffer-name))))
157 (or (get-buffer name)
158 (if error-if-non-existent-p
159 (error "No buffer named `%s'" name)
161 (if error-if-non-existent-p
162 (error "No buffer on this line")
165 (defun buffer-menu (&optional arg)
166 "Make a menu of buffers so you can save, delete or select them.
167 With argument, show only buffers that are visiting files.
168 Type ? after invocation to get help on commands available.
169 Type q immediately to make the buffer menu go away."
171 ;;; (setq Buffer-menu-window-config (current-window-configuration))
172 (switch-to-buffer (list-buffers-noselect arg))
174 "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))
176 (defun buffer-menu-other-window (&optional arg)
177 "Display a list of buffers in another window.
178 With the buffer list buffer, you can save, delete or select the buffers.
179 With argument, show only buffers that are visiting files.
180 Type ? after invocation to get help on commands available.
181 Type q immediately to make the buffer menu go away."
183 ;;; (setq Buffer-menu-window-config (current-window-configuration))
184 (switch-to-buffer-other-window (list-buffers-noselect arg))
186 "Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))
188 (defun Buffer-menu-quit ()
189 "Quit the buffer menu."
191 (let ((buffer (current-buffer)))
192 ;; Switch away from the buffer menu and bury it.
193 (switch-to-buffer (other-buffer))
194 (bury-buffer buffer)))
196 (defun Buffer-menu-mark ()
197 "Mark buffer on this line for being displayed by \\<Buffer-menu-mode-map>\\[Buffer-menu-select] command."
200 (if (looking-at " [-M]")
202 (let ((buffer-read-only nil))
207 (defun Buffer-menu-unmark (&optional backup)
208 "Cancel all requested operations on buffer on this line and move down.
209 Optional ARG means move up."
212 (if (looking-at " [-M]")
214 (let* ((buf (Buffer-menu-buffer t))
215 (mod (buffer-modified-p buf))
216 (readonly (save-excursion (set-buffer buf) buffer-read-only))
217 (buffer-read-only nil))
219 (insert (if readonly (if mod " *%" " %") (if mod " * " " ")))))
220 (forward-line (if backup -1 1)))
222 (defun Buffer-menu-backup-unmark ()
223 "Move up and cancel all requested operations on buffer on line above."
229 (defun Buffer-menu-delete (&optional arg)
230 "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command.
231 Prefix arg is how many buffers to delete.
232 Negative arg means delete backwards."
235 (if (looking-at " [-M]") ;header lines
237 (let ((buffer-read-only nil))
238 (if (or (null arg) (= arg 0))
249 (setq arg (1+ arg))))))
251 (defun Buffer-menu-delete-backwards (&optional arg)
252 "Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command
253 and then move up one line. Prefix arg means move that many lines."
255 (Buffer-menu-delete (- (or arg 1)))
256 (while (looking-at " [-M]")
259 (defun Buffer-menu-save ()
260 "Mark buffer on this line to be saved by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command."
263 (if (looking-at " [-M]") ;header lines
265 (let ((buffer-read-only nil))
271 (defun Buffer-menu-not-modified (&optional arg)
272 "Mark buffer on this line as unmodified (no changes to save)."
275 (set-buffer (Buffer-menu-buffer t))
276 (set-buffer-modified-p arg))
280 (if (= (char-after (point)) (if arg ? ?*))
281 (let ((buffer-read-only nil))
283 (insert (if arg ?* ? ))))))
285 (defun Buffer-menu-execute ()
286 "Save and/or delete buffers marked with \\<Buffer-menu-mode-map>\\[Buffer-menu-save] or \\<Buffer-menu-mode-map>\\[Buffer-menu-delete] commands."
289 (goto-char (point-min))
291 (while (re-search-forward "^.S" nil t)
294 (set-buffer (Buffer-menu-buffer t))
296 (setq modp (buffer-modified-p)))
297 (let ((buffer-read-only nil))
299 (insert (if modp ?* ? ))))))
301 (goto-char (point-min))
303 (let ((buff-menu-buffer (current-buffer))
304 (buffer-read-only nil))
305 (while (search-forward "\nD" nil t)
307 (let ((buf (Buffer-menu-buffer nil)))
309 (eq buf buff-menu-buffer)
310 (save-excursion (kill-buffer buf))))
311 (if (Buffer-menu-buffer nil)
312 (progn (delete-char 1)
314 (delete-region (point) (progn (forward-line 1) (point)))
315 (backward-char 1))))))
317 (defun Buffer-menu-select ()
318 "Select this line's buffer; also display buffers marked with `>'.
319 You can mark buffers with the \\<Buffer-menu-mode-map>\\[Buffer-menu-mark] command.
320 This command deletes and replaces all the previously existing windows
321 in the selected frame."
323 (let ((buff (Buffer-menu-buffer t))
324 (menu (current-buffer))
327 (goto-char (point-min))
328 (while (search-forward "\n>" nil t)
329 (setq tem (Buffer-menu-buffer t))
330 (let ((buffer-read-only nil))
333 (or (eq tem buff) (memq tem others) (setq others (cons tem others))))
334 (setq others (nreverse others)
335 tem (/ (1- (frame-height)) (1+ (length others))))
336 (delete-other-windows)
337 (switch-to-buffer buff)
340 (if (equal (length others) 0)
342 ;;; ;; Restore previous window configuration before displaying
343 ;;; ;; selected buffers.
344 ;;; (if Buffer-menu-window-config
346 ;;; (set-window-configuration Buffer-menu-window-config)
347 ;;; (setq Buffer-menu-window-config nil)))
348 (switch-to-buffer buff))
350 (split-window nil tem)
352 (switch-to-buffer (car others))
353 (setq others (cdr others)))
354 (other-window 1) ;back to the beginning!
359 (eval-when-compile (autoload 'visit-tags-table "etags"))
361 (defun Buffer-menu-visit-tags-table ()
362 "Visit the tags table in the buffer on this line. See `visit-tags-table'."
364 (let ((file (buffer-file-name (Buffer-menu-buffer t))))
366 (visit-tags-table file)
367 (error "Specified buffer has no file"))))
369 (defun Buffer-menu-1-window ()
370 "Select this line's buffer, alone, in full frame."
372 (switch-to-buffer (Buffer-menu-buffer t))
373 (bury-buffer (other-buffer))
374 (delete-other-windows)
376 ;; This is to get w->force_start set to nil. Don't ask me, I only work here.
377 (set-window-buffer (selected-window) (current-buffer)))
379 (defun Buffer-menu-mouse-select (event)
380 "Select the buffer whose line you click on."
384 (set-buffer (event-buffer event)) ; XEmacs
386 (goto-char (event-point event)) ; XEmacs
387 (setq buffer (Buffer-menu-buffer t))))
388 (select-window (event-window event)) ; XEmacs
389 (if (and (window-dedicated-p (selected-window))
390 (eq (selected-window) (frame-root-window)))
391 (switch-to-buffer-other-frame buffer)
392 (switch-to-buffer buffer))))
395 (defun Buffer-menu-maybe-mouse-select (event &optional click-count)
397 (and (>= click-count 2)
398 (let ((buffer (current-buffer))
400 (config (current-window-configuration)))
403 (Buffer-menu-mouse-select event)
406 (set-window-configuration config)
411 (defun Buffer-menu-this-window ()
412 "Select this line's buffer in this window."
414 (switch-to-buffer (Buffer-menu-buffer t)))
416 (defun Buffer-menu-other-window ()
417 "Select this line's buffer in other window, leaving buffer menu visible."
419 (switch-to-buffer-other-window (Buffer-menu-buffer t)))
421 (defun Buffer-menu-switch-other-window ()
422 "Make the other window select this line's buffer.
423 The current window remains selected."
425 (display-buffer (Buffer-menu-buffer t)))
427 (defun Buffer-menu-2-window ()
428 "Select this line's buffer, with previous buffer in second window."
430 (let ((buff (Buffer-menu-buffer t))
431 (menu (current-buffer))
433 (delete-other-windows)
434 (switch-to-buffer (other-buffer))
438 (defun Buffer-menu-toggle-read-only ()
439 "Toggle read-only status of buffer on this line, perhaps via version control."
443 (set-buffer (Buffer-menu-buffer t))
444 (modeline-toggle-read-only)
445 (setq char (if buffer-read-only ?% ? )))
449 (if (/= (following-char) char)
450 (let (buffer-read-only)
455 (defvar Buffer-menu-popup-menu
457 ["Select Buffer" Buffer-menu-select t]
458 ["Select buffer Other Window" Buffer-menu-other-window t]
459 ["Clear Buffer Modification Flag" Buffer-menu-not-modified t]
461 ["Mark Buffer for Selection" Buffer-menu-mark t]
462 ["Mark Buffer for Save" Buffer-menu-save t]
463 ["Mark Buffer for Deletion" Buffer-menu-delete t]
464 ["Unmark Buffer" Buffer-menu-unmark t]
466 ["Delete/Save Marked Buffers" Buffer-menu-execute t]
470 (defun Buffer-menu-popup-menu (event)
472 (mouse-set-point event)
474 (let ((buffer (Buffer-menu-buffer nil)))
477 (nconc (list (car Buffer-menu-popup-menu)
479 "Commands on buffer \"" (buffer-name buffer) "\":")
481 (cdr Buffer-menu-popup-menu)))
482 (error "no buffer on this line"))))
486 (defvar list-buffers-header-line
487 (concat " MR Buffer Size Mode File\n"
488 " -- ------ ---- ---- ----\n"))
491 (defvar list-buffers-identification 'default-list-buffers-identification
492 "String used to identify this buffer, or a function of one argument
493 to generate such a string. This variable is always buffer-local.")
494 (make-variable-buffer-local 'list-buffers-identification)
498 (defvar list-buffers-directory nil)
501 (make-variable-buffer-local 'list-buffers-directory)
504 (defun default-list-buffers-identification (output)
506 (let ((file (or (buffer-file-name (current-buffer))
507 (and (boundp 'list-buffers-directory)
508 list-buffers-directory)))
517 ;; right-justify the size
518 (move-to-column 19 t)
522 (setq s (- 6 (- p col)))
523 (while (> s 0) ; speed/consing tradeoff...
531 ;; if the mode-name is really long, clip it for the filename
532 (if (> 0 (setq s (- 39 (current-column))))
533 (delete-char (max s (- eob (point)))))
538 (defun list-buffers-internal (output &optional predicate)
539 (let ((current (current-buffer))
540 (buffers (buffer-list)))
543 (setq buffer-read-only nil)
545 (buffer-disable-undo output)
546 (insert list-buffers-header-line)
550 (buffer (car buffers))
551 (name (buffer-name buffer))
552 this-buffer-line-start)
553 (setq buffers (cdr buffers))
554 (cond ((null name)) ;deleted buffer
556 (not (if (stringp predicate)
557 (string-match predicate name)
558 (funcall predicate buffer))))
562 (let ((ro buffer-read-only)
563 (id list-buffers-identification))
565 (setq this-buffer-line-start (point))
566 (insert (if (eq buffer current)
567 (progn (setq current (point)) ?\.)
569 (insert (if (buffer-modified-p buffer)
575 (if (string-match "[\n\"\\ \t]" name)
576 (let ((print-escape-newlines t))
587 (princ "***" output) (prin1 e output)))
589 (goto-char (point-max)))))
590 (put-nonduplicable-text-property this-buffer-line-start
593 (put-nonduplicable-text-property this-buffer-line-start
599 (if (not (bufferp current))
600 (goto-char current)))))
601 ;(define-key ctl-x-map "\C-b" 'list-buffers)
603 (defun list-buffers (&optional files-only)
604 "Display a list of names of existing buffers.
605 The list is displayed in a buffer named `*Buffer List*'.
606 Note that buffers with names starting with spaces are omitted.
607 Non-nil optional arg FILES-ONLY means mention only file buffers.
609 The M column contains a * for buffers that are modified.
610 The R column contains a % for buffers that are read-only."
611 (interactive (list (if current-prefix-arg t nil))) ; XEmacs
612 (display-buffer (list-buffers-noselect files-only)))
615 (defun list-buffers-noselect (&optional files-only)
616 "Create and return a buffer with a list of names of existing buffers.
617 The buffer is named `*Buffer List*'.
618 Note that buffers with names starting with spaces are omitted.
619 Non-nil optional arg FILES-ONLY means mention only file buffers.
621 The M column contains a * for buffers that are modified.
622 The R column contains a % for buffers that are read-only."
623 (let ((buffer (get-buffer-create "*Buffer List*")))
624 (list-buffers-internal buffer
625 (if (memq files-only '(t nil))
627 (let ((n (buffer-name b)))
628 (cond ((and (/= 0 (length n))
630 ;;don't mention if starts with " "
633 (buffer-file-name b))
639 (defun buffers-menu-omit-invisible-buffers (buf)
640 "For use as a value of `buffers-menu-omit-function'.
641 Omits normally invisible buffers (those whose name begins with a space)."
642 (not (null (string-match "\\` " (buffer-name buf)))))
646 ;;; buff-menu.el ends here