;;; buff-menu.el --- buffer menu main function and support functions
-;; Copyright (C) 1985, 86, 87, 93, 94, 95, 2000, 2001
+;; Copyright (C) 1985, 86, 87, 93, 94, 95, 2000, 2001, 2002, 03, 2004
;; Free Software Foundation, Inc.
;; Maintainer: FSF
;;; Code:
-;;;Trying to preserve the old window configuration works well in
-;;;simple scenarios, when you enter the buffer menu, use it, and exit it.
-;;;But it does strange things when you switch back to the buffer list buffer
-;;;with C-x b, later on, when the window configuration is different.
-;;;The choice seems to be, either restore the window configuration
-;;;in all cases, or in no cases.
-;;;I decided it was better not to restore the window config at all. -- rms.
+;;Trying to preserve the old window configuration works well in
+;;simple scenarios, when you enter the buffer menu, use it, and exit it.
+;;But it does strange things when you switch back to the buffer list buffer
+;;with C-x b, later on, when the window configuration is different.
+;;The choice seems to be, either restore the window configuration
+;;in all cases, or in no cases.
+;;I decided it was better not to restore the window config at all. -- rms.
-;;;But since then, I changed buffer-menu to use the selected window,
-;;;so q now once again goes back to the previous window configuration.
+;;But since then, I changed buffer-menu to use the selected window,
+;;so q now once again goes back to the previous window configuration.
-;;;(defvar Buffer-menu-window-config nil
-;;; "Window configuration saved from entry to `buffer-menu'.")
+;;(defvar Buffer-menu-window-config nil
+;; "Window configuration saved from entry to `buffer-menu'.")
-; Put buffer *Buffer List* into proper mode right away
-; so that from now on even list-buffers is enough to get a buffer menu.
+;; Put buffer *Buffer List* into proper mode right away
+;; so that from now on even list-buffers is enough to get a buffer menu.
-(defvar Buffer-menu-buffer-column nil)
+(defgroup Buffer-menu nil
+ "Show a menu of all buffers in a buffer."
+ :group 'tools
+ :group 'convenience)
-(defvar Buffer-menu-mode-map nil "")
+(defcustom Buffer-menu-use-header-line t
+ "*Non-nil means to use an immovable header-line."
+ :type 'boolean
+ :group 'Buffer-menu)
+
+(defface Buffer-menu-buffer-face
+ '((t (:weight bold)))
+ "Face used to highlight buffer name."
+ :group 'font-lock-highlighting-faces)
+
+(defcustom Buffer-menu-buffer+size-width 26
+ "*How wide to jointly make the buffer name and size columns."
+ :type 'number
+ :group 'Buffer-menu)
+
+(defcustom Buffer-menu-mode-width 16
+ "*How wide to make the mode name column."
+ :type 'number
+ :group 'Buffer-menu)
+
+;; This should get updated & resorted when you click on a column heading
+(defvar Buffer-menu-sort-column nil
+ "*2 for sorting by buffer names. 5 for sorting by file names.
+nil for default sorting by visited order.")
+
+(defconst Buffer-menu-buffer-column 4)
+
+(defvar Buffer-menu-mode-map nil
+ "Local keymap for `Buffer-menu-mode' buffers.")
+
+(defvar Buffer-menu-files-only nil
+ "Non-nil if the current buffer-menu lists only file buffers.
+This variable determines whether reverting the buffer lists only
+file buffers. It affects both manual reverting and reverting by
+Auto Revert Mode.")
+
+(make-variable-buffer-local 'Buffer-menu-files-only)
(if Buffer-menu-mode-map
()
(define-key Buffer-menu-mode-map "b" 'Buffer-menu-bury)
(define-key Buffer-menu-mode-map "g" 'Buffer-menu-revert)
(define-key Buffer-menu-mode-map "V" 'Buffer-menu-view)
+ (define-key Buffer-menu-mode-map "T" 'Buffer-menu-toggle-files-only)
(define-key Buffer-menu-mode-map [mouse-2] 'Buffer-menu-mouse-select)
)
\\[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.
\\[Buffer-menu-revert] -- 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."
(kill-all-local-variables)
(use-local-map Buffer-menu-mode-map)
(setq major-mode 'Buffer-menu-mode)
(setq mode-name "Buffer Menu")
- (make-local-variable 'revert-buffer-function)
- (setq revert-buffer-function 'Buffer-menu-revert-function)
+ (set (make-local-variable 'revert-buffer-function)
+ 'Buffer-menu-revert-function)
+ (set (make-local-variable 'buffer-stale-function)
+ #'(lambda (&optional noconfirm) 'fast))
(setq truncate-lines t)
(setq buffer-read-only t)
(run-hooks 'buffer-menu-mode-hook))
(revert-buffer))
(defun Buffer-menu-revert-function (ignore1 ignore2)
- (list-buffers))
+ ;; We can not use save-excursion here. The buffer gets erased.
+ (let ((old-point (point)))
+ (list-buffers-noselect Buffer-menu-files-only)
+ (goto-char old-point)))
+
+(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)))
+ (revert-buffer))
+
\f
(defun Buffer-menu-buffer (error-if-non-existent-p)
"Return buffer described by this line of buffer menu."
(error "No buffer named `%s'" name)
nil))
(or (and buf (buffer-name buf) buf)
- (if error-if-non-existent-p
- (error "No buffer on this line")
+ (if error-if-non-existent-p
+ (error "No buffer on this line")
nil)))))
\f
(defun buffer-menu (&optional arg)
marked to be displayed, `D' for one you have marked for
deletion, and `.' for the current buffer.
+The C column has a `.' for the buffer from which you came.
+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 R column has a `%' if the buffer is read-only.
After this come the buffer name, its size in characters,
its major mode, and the visited file name (if any)."
(interactive "P")
(message
"Commands: d, s, x, u; f, o, 1, 2, m, v; ~, %%; q to quit; ? for help."))
+(defun Buffer-menu-no-header ()
+ (beginning-of-line)
+ (if (or Buffer-menu-use-header-line
+ (not (eq (char-after) ?C)))
+ t
+ (ding)
+ (forward-line 1)
+ nil))
+
(defun Buffer-menu-mark ()
"Mark buffer on this line for being displayed by \\<Buffer-menu-mode-map>\\[Buffer-menu-select] command."
(interactive)
- (beginning-of-line)
- (if (looking-at " [-M]")
- (ding)
+ (when (Buffer-menu-no-header)
(let ((buffer-read-only nil))
(delete-char 1)
(insert ?>)
"Cancel all requested operations on buffer on this line and move down.
Optional ARG means move up."
(interactive "P")
- (beginning-of-line)
- (if (looking-at " [-M]")
- (ding)
+ (when (Buffer-menu-no-header)
(let* ((buf (Buffer-menu-buffer t))
(mod (buffer-modified-p buf))
(readonly (save-excursion (set-buffer buf) buffer-read-only))
(buffer-read-only nil))
(delete-char 3)
- (insert (if readonly (if mod " *%" " %") (if mod " * " " ")))))
+ (insert (if readonly (if mod " %*" " % ") (if mod " *" " ")))))
(forward-line (if backup -1 1)))
(defun Buffer-menu-backup-unmark ()
Prefix arg is how many buffers to delete.
Negative arg means delete backwards."
(interactive "p")
- (beginning-of-line)
- (if (looking-at " [-M]") ;header lines
- (ding)
+ (when (Buffer-menu-no-header)
(let ((buffer-read-only nil))
(if (or (null arg) (= arg 0))
(setq arg 1))
(insert ?D)
(forward-line 1)
(setq arg (1- arg)))
- (while (< arg 0)
+ (while (and (< arg 0)
+ (Buffer-menu-no-header))
(delete-char 1)
(insert ?D)
(forward-line -1)
"Mark buffer on this line to be deleted by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command
and then move up one line. Prefix arg means move that many lines."
(interactive "p")
- (Buffer-menu-delete (- (or arg 1)))
- (while (looking-at " [-M]")
- (forward-line 1)))
+ (Buffer-menu-delete (- (or arg 1))))
(defun Buffer-menu-save ()
"Mark buffer on this line to be saved by \\<Buffer-menu-mode-map>\\[Buffer-menu-execute] command."
(interactive)
- (beginning-of-line)
- (if (looking-at " [-M]") ;header lines
- (ding)
+ (when (Buffer-menu-no-header)
(let ((buffer-read-only nil))
- (forward-char 1)
+ (forward-char 2)
(delete-char 1)
(insert ?S)
(forward-line 1))))
(set-buffer-modified-p arg))
(save-excursion
(beginning-of-line)
- (forward-char 1)
- (if (= (char-after (point)) (if arg ? ?*))
+ (forward-char 2)
+ (if (= (char-after) (if arg ? ?*))
(let ((buffer-read-only nil))
(delete-char 1)
(insert (if arg ?* ? ))))))
(interactive)
(save-excursion
(goto-char (point-min))
- (forward-line 1)
- (while (re-search-forward "^.S" nil t)
+ (unless Buffer-menu-use-header-line
+ (forward-line 1))
+ (while (re-search-forward "^..S" nil t)
(let ((modp nil))
(save-excursion
(set-buffer (Buffer-menu-buffer t))
(insert (if modp ?* ? ))))))
(save-excursion
(goto-char (point-min))
- (forward-line 1)
+ (unless Buffer-menu-use-header-line
+ (forward-line 1))
(let ((buff-menu-buffer (current-buffer))
(buffer-read-only nil))
- (while (search-forward "\nD" nil t)
+ (while (re-search-forward "^D" nil t)
(forward-char -1)
(let ((buf (Buffer-menu-buffer nil)))
(or (eq buf nil)
(progn (delete-char 1)
(insert ? ))
(delete-region (point) (progn (forward-line 1) (point)))
- (forward-char -1)))))))
+ (unless (bobp)
+ (forward-char -1))))))))
(defun Buffer-menu-select ()
"Select this line's buffer; also display buffers marked with `>'.
(others ())
tem)
(goto-char (point-min))
- (while (search-forward "\n>" nil t)
+ (unless Buffer-menu-use-header-line
+ (forward-line 1))
+ (while (re-search-forward "^>" nil t)
(setq tem (Buffer-menu-buffer t))
(let ((buffer-read-only nil))
(delete-char -1)
(setq char (if buffer-read-only ?% ? )))
(save-excursion
(beginning-of-line)
- (forward-char 2)
+ (forward-char 1)
(if (/= (following-char) char)
(let (buffer-read-only)
(delete-char 1)
(defun Buffer-menu-bury ()
"Bury the buffer listed on this line."
(interactive)
- (beginning-of-line)
- (if (looking-at " [-M]") ;header lines
- (ding)
+ (when (Buffer-menu-no-header)
(save-excursion
(beginning-of-line)
(bury-buffer (Buffer-menu-buffer t))
(interactive "P")
(display-buffer (list-buffers-noselect files-only)))
+(defun Buffer-menu-buffer+size (name size &optional name-props size-props)
+ (if (> (+ (length name) (length size) 2) Buffer-menu-buffer+size-width)
+ (setq name
+ (if (string-match "<[0-9]+>$" name)
+ (concat (substring name 0
+ (- Buffer-menu-buffer+size-width
+ (max (length size) 3)
+ (match-end 0)
+ (- (match-beginning 0))
+ 2))
+ ":" ; narrow ellipsis
+ (match-string 0 name))
+ (concat (substring name 0
+ (- Buffer-menu-buffer+size-width
+ (max (length size) 3)
+ 2))
+ ":"))) ; narrow ellipsis
+ ;; Don't put properties on (buffer-name).
+ (setq name (copy-sequence name)))
+ (add-text-properties 0 (length name) name-props name)
+ (add-text-properties 0 (length size) size-props size)
+ (concat name
+ (make-string (- Buffer-menu-buffer+size-width
+ (length name)
+ (length size))
+ ? )
+ size))
+
+(defun Buffer-menu-sort (column)
+ "Sort the buffer menu by COLUMN."
+ (interactive "P")
+ (when column
+ (setq column (prefix-numeric-value column))
+ (if (< column 2) (setq column 2))
+ (if (> column 5) (setq column 5)))
+ (setq Buffer-menu-sort-column column)
+ (Buffer-menu-revert))
+
+(defun Buffer-menu-make-sort-button (name column)
+ (if (equal column Buffer-menu-sort-column) (setq column nil))
+ (propertize name
+ 'help-echo (if column
+ (concat "mouse-2: sort by " (downcase name))
+ "mouse-2: sort by visited order")
+ 'mouse-face 'highlight
+ 'keymap (let ((map (make-sparse-keymap)))
+ (define-key map [header-line mouse-2]
+ `(lambda () (interactive)
+ (Buffer-menu-sort ,column)))
+ map)))
+
(defun list-buffers-noselect (&optional files-only)
"Create and return a buffer with a list of names of existing buffers.
The buffer is named `*Buffer List*'.
Non-null optional arg FILES-ONLY means mention only file buffers.
For more information, see the function `buffer-menu'."
- (let ((old-buffer (current-buffer))
- (standard-output standard-output)
- desired-point)
- (save-excursion
- (set-buffer (get-buffer-create "*Buffer List*"))
+ (let* ((old-buffer (current-buffer))
+ (standard-output standard-output)
+ (mode-end (make-string (- Buffer-menu-mode-width 2) ? ))
+ (header (concat " " (propertize "CRM " 'face 'fixed-pitch)
+ (Buffer-menu-buffer+size
+ (Buffer-menu-make-sort-button "Buffer" 2)
+ (Buffer-menu-make-sort-button "Size" 3))
+ " "
+ (Buffer-menu-make-sort-button "Mode" 4) mode-end
+ (Buffer-menu-make-sort-button "File" 5) "\n"))
+ list desired-point name file)
+ (when Buffer-menu-use-header-line
+ (let ((pos 0))
+ ;; Turn spaces in the header into stretch specs so they work
+ ;; regardless of the header-line face.
+ (while (string-match "[ \t]+" header pos)
+ (setq pos (match-end 0))
+ (put-text-property (match-beginning 0) pos 'display
+ ;; Assume fixed-size chars
+ (list 'space :align-to (1- pos))
+ header))))
+ (with-current-buffer (get-buffer-create "*Buffer List*")
(setq buffer-read-only nil)
(erase-buffer)
(setq standard-output (current-buffer))
- (princ "\
- MR Buffer Size Mode File
- -- ------ ---- ---- ----
-")
- ;; Record the column where buffer names start.
- (setq Buffer-menu-buffer-column 4)
- (dolist (buffer (buffer-list))
- (let ((name (buffer-name buffer))
- (file (buffer-file-name buffer))
- this-buffer-line-start
- this-buffer-read-only
- (this-buffer-size (buffer-size buffer))
- this-buffer-mode-name
- this-buffer-directory)
- (with-current-buffer buffer
- (setq this-buffer-read-only buffer-read-only
- this-buffer-mode-name mode-name)
- (unless file
- ;; No visited file. Check local value of
- ;; list-buffers-directory.
- (when (and (boundp 'list-buffers-directory)
- list-buffers-directory)
- (setq this-buffer-directory list-buffers-directory))))
- (cond
- ;; Don't mention internal buffers.
- ((and (string= (substring name 0 1) " ") (null file)))
- ;; Maybe don't mention buffers without files.
- ((and files-only (not file)))
- ((string= name "*Buffer List*"))
- ;; Otherwise output info.
- (t
- (setq this-buffer-line-start (point))
- ;; Identify current buffer.
- (if (eq buffer old-buffer)
- (progn
- (setq desired-point (point))
- (princ "."))
- (princ " "))
- ;; Identify modified buffers.
- (princ (if (buffer-modified-p buffer) "*" " "))
- ;; Handle readonly status. The output buffer is special
- ;; cased to appear readonly; it is actually made so at a
- ;; later date.
- (princ (if (or (eq buffer standard-output)
- this-buffer-read-only)
- "% "
- " "))
- (princ name)
- ;; Put the buffer name into a text property
- ;; so we don't have to extract it from the text.
- ;; This way we avoid problems with unusual buffer names.
- (setq this-buffer-line-start
- (+ this-buffer-line-start Buffer-menu-buffer-column))
- (let ((name-end (point)))
- (indent-to 17 2)
- (put-text-property this-buffer-line-start name-end
- 'buffer-name name)
- (put-text-property this-buffer-line-start (point)
- 'buffer buffer)
- (put-text-property this-buffer-line-start name-end
- 'mouse-face 'highlight)
- (put-text-property this-buffer-line-start name-end
- 'help-echo "mouse-2: select this buffer"))
- (let ((size (format "%8d" this-buffer-size))
- (mode this-buffer-mode-name)
- (excess (- (current-column) 17)))
- (while (and (> excess 0) (= (aref size 0) ?\ ))
- (setq size (substring size 1)
- excess (1- excess)))
- (princ size)
- (indent-to 27 1)
- (princ mode))
- (indent-to 40 1)
- (or file (setq file this-buffer-directory))
- (when file
- (princ (abbreviate-file-name file)))
- (princ "\n")))))
+ (unless Buffer-menu-use-header-line
+ (insert header (propertize "---" 'face 'fixed-pitch) " ")
+ (insert (Buffer-menu-buffer+size "------" "----"))
+ (insert " ----" mode-end "----\n")
+ (put-text-property 1 (point) 'intangible t))
+ (setq list
+ (delq t
+ (mapcar
+ (lambda (buffer)
+ (with-current-buffer buffer
+ (setq name (buffer-name)
+ file (buffer-file-name))
+ (cond
+ ;; Don't mention internal buffers.
+ ((and (string= (substring name 0 1) " ") (null file)))
+ ;; Maybe don't mention buffers without files.
+ ((and files-only (not file)))
+ ((string= name "*Buffer List*"))
+ ;; Otherwise output info.
+ (t
+ (unless file
+ ;; No visited file. Check local value of
+ ;; list-buffers-directory.
+ (when (and (boundp 'list-buffers-directory)
+ list-buffers-directory)
+ (setq file list-buffers-directory)))
+ (list buffer
+ (format "%c%c%c "
+ (if (eq buffer old-buffer) ?. ? )
+ ;; Handle readonly status. The output buffer is special
+ ;; cased to appear readonly; it is actually made so at a
+ ;; later date.
+ (if (or (eq buffer standard-output)
+ buffer-read-only)
+ ?% ? )
+ ;; Identify modified buffers.
+ (if (buffer-modified-p) ?* ? ))
+ name (buffer-size) mode-name file)))))
+ (buffer-list))))
+ (dolist (buffer
+ (if Buffer-menu-sort-column
+ (sort list
+ (if (eq Buffer-menu-sort-column 3)
+ (lambda (a b)
+ (< (nth Buffer-menu-sort-column a)
+ (nth Buffer-menu-sort-column b)))
+ (lambda (a b)
+ (string< (nth Buffer-menu-sort-column a)
+ (nth Buffer-menu-sort-column b)))))
+ list))
+ (if (eq (car buffer) old-buffer)
+ (setq desired-point (point)))
+ (insert (cadr buffer)
+ ;; Put the buffer name into a text property
+ ;; so we don't have to extract it from the text.
+ ;; This way we avoid problems with unusual buffer names.
+ (Buffer-menu-buffer+size (nth 2 buffer)
+ (int-to-string (nth 3 buffer))
+ `(buffer-name ,(nth 2 buffer)
+ buffer ,(car buffer)
+ face Buffer-menu-buffer-face
+ mouse-face highlight
+ help-echo "mouse-2: select this buffer"))
+ " "
+ (if (> (length (nth 4 buffer)) Buffer-menu-mode-width)
+ (substring (nth 4 buffer) 0 Buffer-menu-mode-width)
+ (nth 4 buffer)))
+ (when (nth 5 buffer)
+ (indent-to (+ Buffer-menu-buffer-column Buffer-menu-buffer+size-width
+ Buffer-menu-mode-width 4) 1)
+ (princ (abbreviate-file-name (nth 5 buffer))))
+ (princ "\n"))
(Buffer-menu-mode)
+ (when Buffer-menu-use-header-line
+ (setq header-line-format header))
;; DESIRED-POINT doesn't have to be set; it is not when the
;; current buffer is not displayed for some reason.
(and desired-point
(goto-char desired-point))
+ (setq Buffer-menu-files-only files-only)
+ (set-buffer-modified-p nil)
(current-buffer))))
+;;; arch-tag: e7dfcfc9-6cb2-46e4-bf55-8ef1936d83c6
;;; buff-menu.el ends here