;;; bs.el --- menu for selecting and displaying buffers
-;; Copyright (C) 1998, 1999, 2000, 2001, 2004 Free Software Foundation, Inc.
+;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+;; 2005, 2006, 2007 Free Software Foundation, Inc.
;; Author: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
;; Maintainer: Olaf Sylvester <Olaf.Sylvester@netsurf.de>
;; Keywords: convenience
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; Version: 1.17
-;; X-URL: http://home.netsurf.de/olaf.sylvester/emacs
+;; X-URL: http://www.geekware.de/software/emacs
;;
;; The bs-package contains a main function bs-show for poping up a
;; buffer in a way similar to `list-buffers' and `electric-buffer-list':
"Buffer Selection: Maintaining buffers by buffer menu."
:version "21.1"
:link '(emacs-commentary-link "bs")
- :link '(url-link "http://home.netsurf.de/olaf.sylvester/emacs")
+ :link '(url-link "http://www.geekware.de/software/emacs")
:group 'convenience)
(defgroup bs-appearance nil
"*List specifying the layout of a Buffer Selection Menu buffer.
Each entry specifies a column and is a list of the form of:
\(HEADER MINIMUM-LENGTH MAXIMUM-LENGTH ALIGNMENT FUN-OR-STRING)
-HEADER : string for header for first line or a function
- which calculates column title.
-MINIMUM-LENGTH : minimum width of column (number or name of function).
- The function must return a positive integer.
-MAXIMUM-LENGTH : maximum width of column (number or name of function)
- (currently ignored)
-ALIGNMENT : alignment of column: (`left' `right' `middle')
-FUN-OR-STRING : Name of a function for calculating the value or
-a string for a constant value.
+
+HEADER : String for header for first line or a function
+ which calculates column title.
+MINIMUM-LENGTH : Minimum width of column (number or name of function).
+ The function must return a positive integer.
+MAXIMUM-LENGTH : Maximum width of column (number or name of function)
+ (currently ignored).
+ALIGNMENT : Alignment of column (`left', `right', `middle').
+FUN-OR-STRING : Name of a function for calculating the value or a
+ string for a constant value.
+
The function gets as parameter the buffer where we have started
buffer selection and the list of all buffers to show. The function must
return a string representing the column's value."
:group 'bs-appearance
:type '(repeat sexp))
-(defvar bs--running-in-xemacs (string-match "XEmacs" (emacs-version))
- "Non-nil when running under XEmacs.")
-
(defun bs--make-header-match-string ()
"Return a regexp matching the first line of a Buffer Selection Menu buffer."
(let ((res "^\\(")
(defvar bs-buffer-sort-function nil
"Sort function to sort the buffers that appear in Buffer Selection Menu.
-The function gets two arguments - the buffers to compare.")
+The function gets two arguments - the buffers to compare.
+It must return non-nil if the first buffer should sort before the second.")
(defcustom bs-maximal-buffer-name-column 45
"*Maximum column width for buffer names.
:type 'string)
(defcustom bs-string-show-normally " "
- "*String added in column 1 indicating a unmarked buffer."
+ "*String added in column 1 indicating an unmarked buffer."
:group 'bs-appearance
:type 'string)
("by nothing" nil nil nil))
"*List of all possible sorting aspects for Buffer Selection Menu.
You can add a new entry with a call to `bs-define-sort-function'.
-Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE)
+Each element is a list of four elements (NAME FUNCTION REGEXP-FOR-SORTING FACE).
NAME specifies the sort order defined by function FUNCTION.
-FUNCTION nil means don't sort the buffer list. Otherwise the functions
+FUNCTION nil means don't sort the buffer list. Otherwise the function
must have two parameters - the buffers to compare.
REGEXP-FOR-SORTING is a regular expression which describes the
column title to highlight.
(defvar bs--show-all nil
"Flag whether showing all buffers regardless of current configuration.
-Non nil means to show all buffers. Otherwise show buffers
+Non-nil means to show all buffers. Otherwise show buffers
defined by current configuration `bs-current-configuration'.")
(defvar bs--window-config-coming-from nil
(defun bs--redisplay (&optional keep-line-p sort-description)
"Redisplay whole Buffer Selection Menu.
-If KEEP-LINE-P is non nil the point will stay on current line.
-SORT-DESCRIPTION is an element of `bs-sort-functions'"
+If KEEP-LINE-P is non-nil the point will stay on current line.
+SORT-DESCRIPTION is an element of `bs-sort-functions'."
(let ((line (1+ (count-lines 1 (point)))))
(bs-show-in-buffer (bs-buffer-list nil sort-description))
(if keep-line-p
(format "Show buffer by configuration %S"
bs-current-configuration)))
-(defun bs-mode ()
+(defun bs--track-window-changes (frame)
+ "Track window changes to refresh the buffer list.
+Used from `window-size-change-functions'."
+ (let ((win (get-buffer-window "*buffer-selection*" frame)))
+ (when win
+ (with-selected-window win
+ (bs--set-window-height)))))
+
+(defun bs--remove-hooks ()
+ "Remove `bs--track-window-changes' and auxiliary hooks."
+ (remove-hook 'window-size-change-functions 'bs--track-window-changes)
+ ;; Remove itself
+ (remove-hook 'kill-buffer-hook 'bs--remove-hooks t)
+ (remove-hook 'change-major-mode-hook 'bs--remove-hooks t))
+
+(put 'bs-mode 'mode-class 'special)
+
+(define-derived-mode bs-mode () "Buffer-Selection-Menu"
"Major mode for editing a subset of Emacs' buffers.
\\<bs-mode-map>
Aside from two header lines each line describes one buffer.
Move to a line representing the buffer you want to edit and select
-buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill].
+buffer by \\[bs-select] or SPC. Abort buffer list with \\[bs-kill].
There are many key commands similar to `Buffer-menu-mode' for
manipulating the buffer list and buffers.
For faster navigation each digit key is a digit argument.
to show always.
\\[bs-visit-tags-table] -- call `visit-tags-table' on current line's buffer.
\\[bs-help] -- display this help text."
- (interactive)
- (kill-all-local-variables)
- (use-local-map bs-mode-map)
(make-local-variable 'font-lock-defaults)
(make-local-variable 'font-lock-verbose)
- (setq major-mode 'bs-mode
- mode-name "Buffer-Selection-Menu"
- buffer-read-only t
+ (make-local-variable 'font-lock-global-modes)
+ (buffer-disable-undo)
+ (setq buffer-read-only t
truncate-lines t
+ show-trailing-whitespace nil
+ font-lock-global-modes '(not bs-mode)
font-lock-defaults '(bs-mode-font-lock-keywords t)
font-lock-verbose nil)
- (run-mode-hooks 'bs-mode-hook))
+ (add-hook 'window-size-change-functions 'bs--track-window-changes)
+ (add-hook 'kill-buffer-hook 'bs--remove-hooks nil t)
+ (add-hook 'change-major-mode-hook 'bs--remove-hooks nil t))
+
+(defun bs--restore-window-config ()
+ "Restore window configuration on the current frame."
+ (when bs--window-config-coming-from
+ (let ((frame (selected-frame)))
+ (unwind-protect
+ (set-window-configuration bs--window-config-coming-from)
+ (select-frame frame)))
+ (setq bs--window-config-coming-from nil)))
(defun bs-kill ()
- "Let buffer disappear and reset window-configuration."
+ "Let buffer disappear and reset window configuration."
(interactive)
(bury-buffer (current-buffer))
- (set-window-configuration bs--window-config-coming-from))
+ (bs--restore-window-config))
(defun bs-abort ()
"Ding and leave Buffer Selection Menu without a selection."
(interactive)
(bs--redisplay t))
-(defun bs--window-for-buffer (buffer-name)
- "Return a window showing a buffer with name BUFFER-NAME.
-Take only windows of current frame into account.
-Return nil if there is no such buffer."
- (let ((window nil))
- (walk-windows (lambda (wind)
- (if (string= (buffer-name (window-buffer wind))
- buffer-name)
- (setq window wind))))
- window))
-
(defun bs--set-window-height ()
"Change the height of the selected window to suit the current buffer list."
(unless (one-window-p t)
- (shrink-window (- (window-height (selected-window))
- ;; window-height in xemacs includes mode-line
- (+ (if bs--running-in-xemacs 3 1)
- bs-header-lines-length
- (min (length bs-current-list)
- bs-max-window-height))))))
+ (fit-window-to-buffer (selected-window) bs-max-window-height)))
(defun bs--current-buffer ()
"Return buffer on current line.
(defun bs-select ()
"Select current line's buffer and other marked buffers.
If there are no marked buffers the window configuration before starting
-Buffer Selectin Menu will be restored.
+Buffer Selection Menu will be restored.
If there are marked buffers each marked buffer and the current line's buffer
will be selected in a window.
Leave Buffer Selection Menu."
(interactive)
(let ((buffer (bs--current-buffer)))
(bury-buffer (current-buffer))
- (set-window-configuration bs--window-config-coming-from)
+ (bs--restore-window-config)
(switch-to-buffer buffer)
(if bs--marked-buffers
;; Some marked buffers for selection
(defun bs-select-other-window ()
"Select current line's buffer by `switch-to-buffer-other-window'.
-The window configuration before starting Buffer Selectin Menu will be restored
+The window configuration before starting Buffer Selection Menu will be restored
unless there is no other window. In this case a new window will be created.
Leave Buffer Selection Menu."
(interactive)
(let ((buffer (bs--current-buffer)))
(bury-buffer (current-buffer))
- (set-window-configuration bs--window-config-coming-from)
+ (bs--restore-window-config)
(switch-to-buffer-other-window buffer)))
(defun bs-tmp-select-other-window ()
(interactive)
(let ((buffer (bs--current-buffer)))
(bury-buffer (current-buffer))
- (set-window-configuration bs--window-config-coming-from)
+ (bs--restore-window-config)
(switch-to-buffer-other-frame buffer)))
(defun bs-mouse-select-other-frame (event)
"Select selected line's buffer in new created frame.
Leave Buffer Selection Menu.
-EVENT: a mouse click EVENT."
+EVENT: a mouse click event."
(interactive "e")
(mouse-set-point event)
(bs-select-other-frame))
(bs-up 1))))
(defun bs-show-sorted ()
- "Show buffer list sorted by buffer name."
+ "Show buffer list sorted by next sort aspect."
(interactive)
(setq bs--current-sort-function
(bs-next-config-aux (car bs--current-sort-function)
(defun bs--up ()
"Move cursor vertically up one line.
If on top of buffer list go to last line."
- (interactive "p")
- (previous-line 1)
- (if (<= (count-lines 1 (point)) (1- bs-header-lines-length))
- (progn
- (goto-char (point-max))
- (beginning-of-line)
- (recenter -1))
- (beginning-of-line)))
+ (if (> (count-lines 1 (point)) bs-header-lines-length)
+ (forward-line -1)
+ (goto-char (point-max))
+ (beginning-of-line)
+ (recenter -1)))
(defun bs-down (arg)
"Move cursor vertically down ARG lines in Buffer Selection Menu."
(defun bs--down ()
"Move cursor vertically down one line.
If at end of buffer list go to first line."
- (let ((last (line-end-position)))
- (if (eq last (point-max))
- (goto-line (1+ bs-header-lines-length))
- (next-line 1))))
+ (if (eq (line-end-position) (point-max))
+ (goto-line (1+ bs-header-lines-length))
+ (forward-line 1)))
(defun bs-visits-non-file (buffer)
- "Return t or nil whether BUFFER visits no file.
+ "Return whether BUFFER visits no file.
A value of t means BUFFER belongs to no file.
A value of nil means BUFFER belongs to a file."
(not (buffer-file-name buffer)))
(defun bs-sort-buffer-interns-are-last (b1 b2)
- "Function for sorting internal buffers B1 and B2 at the end of all buffers."
+ "Function for sorting internal buffers at the end of all buffers."
(string-match "^\\*" (buffer-name b2)))
;; ----------------------------------------------------------------------
;; ----------------------------------------------------------------------
(defun bs-config-clear ()
- "*Reset all variables which specify a configuration.
+ "Reset all variables which specify a configuration.
These variables are `bs-dont-show-regexp', `bs-must-show-regexp',
`bs-dont-show-function', `bs-must-show-function' and
`bs-buffer-sort-function'."
(bs--set-window-height)
(bs--goto-current-buffer)
(font-lock-fontify-buffer)
- (bs-apply-sort-faces)))
+ (bs-apply-sort-faces)
+ (set-buffer-modified-p nil)))
(defun bs-next-buffer (&optional buffer-list sorting-p)
"Return next buffer and buffer list for buffer cycling in BUFFER-LIST.
bs--cycle-list)))
(next (car tupel))
(cycle-list (cdr tupel)))
+ (unless (window-dedicated-p (selected-window))
+ ;; We don't want the frame iconified if the only window in the frame
+ ;; happens to be dedicated; let's get the error from switch-to-buffer
+ (bury-buffer))
+ (switch-to-buffer next)
(setq bs--cycle-list (append (cdr cycle-list)
(list (car cycle-list))))
- (bury-buffer)
- (switch-to-buffer next)
(bs-message-without-log "Next buffers: %s"
(or (cdr bs--cycle-list)
"this buffer"))))))
-
;;;###autoload
(defun bs-cycle-previous ()
"Select previous buffer defined by buffer cycling.
bs--cycle-list)))
(prev-buffer (car tupel))
(cycle-list (cdr tupel)))
+ (switch-to-buffer prev-buffer)
(setq bs--cycle-list (append (last cycle-list)
(reverse (cdr (reverse cycle-list)))))
- (switch-to-buffer prev-buffer)
(bs-message-without-log "Previous buffers: %s"
(or (reverse (cdr bs--cycle-list))
"this buffer"))))))
(defun bs--get-marked-string (start-buffer all-buffers)
"Return a string which describes whether current buffer is marked.
START-BUFFER is the buffer where we started buffer selection.
-ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu.
+ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu.
The result string is one of `bs-string-current', `bs-string-current-marked',
`bs-string-marked', `bs-string-show-normally', `bs-string-show-never', or
`bs-string-show-always'."
(defun bs--get-modified-string (start-buffer all-buffers)
"Return a string which describes whether current buffer is modified.
START-BUFFER is the buffer where we started buffer selection.
-ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
+ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
(if (buffer-modified-p) "*" " "))
(defun bs--get-readonly-string (start-buffer all-buffers)
"Return a string which describes whether current buffer is read only.
START-BUFFER is the buffer where we started buffer selection.
-ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
+ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
(if buffer-read-only "%" " "))
(defun bs--get-size-string (start-buffer all-buffers)
"Return a string which describes the size of current buffer.
START-BUFFER is the buffer where we started buffer selection.
-ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
+ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
(int-to-string (buffer-size)))
(defun bs--get-name (start-buffer all-buffers)
The name of current buffer gets additional text properties
for mouse highlighting.
START-BUFFER is the buffer where we started buffer selection.
-ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
- (let ((name (copy-sequence (buffer-name))))
- (add-text-properties
- 0 (length name)
- '(mouse-face highlight
- help-echo
- "mouse-2: select this buffer, mouse-3: select in other frame")
- name)
- (if (< (length name) bs--name-entry-length)
- (concat name
- (make-string (- bs--name-entry-length (length name)) ? ))
- name)))
+ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
+ (propertize (buffer-name)
+ 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"
+ 'mouse-face 'highlight))
(defun bs--get-mode-name (start-buffer all-buffers)
"Return the name of mode of current buffer for Buffer Selection Menu.
START-BUFFER is the buffer where we started buffer selection.
-ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
+ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
mode-name)
(defun bs--get-file-name (start-buffer all-buffers)
If current mode is `dired-mode' or `shell-mode' it returns the
default directory.
START-BUFFER is the buffer where we started buffer selection.
-ALL-BUFFERS is the list of buffer appearing in Buffer Selection Menu."
- (let ((string (copy-sequence (if (member major-mode
- '(shell-mode dired-mode))
- default-directory
- (or buffer-file-name "")))))
- (add-text-properties
- 0 (length string)
- '(mouse-face highlight
- help-echo "mouse-2: select this buffer, mouse-3: select in other frame")
- string)
- string))
+ALL-BUFFERS is the list of buffers appearing in Buffer Selection Menu."
+ (propertize (if (member major-mode '(shell-mode dired-mode))
+ default-directory
+ (or buffer-file-name ""))
+ 'mouse-face 'highlight
+ 'help-echo "mouse-2: select this buffer, mouse-3: select in other frame"))
(defun bs--insert-one-entry (buffer)
"Generate one entry for buffer BUFFER in Buffer Selection Menu.
string))
(defun bs--format-aux (string align len)
- "Generate a string with STRING with alignment ALIGN and length LEN.
+ "Pad STRING to length LEN with alignment ALIGN.
ALIGN is one of the symbols `left', `middle', or `right'."
- (let ((length (length string)))
- (if (>= length len)
- string
- (if (eq 'right align)
- (concat (make-string (- len length) ? ) string)
- (concat string (make-string (- len length) ? ))))))
+ (let* ((width (length string))
+ (len (max len width)))
+ (format (format "%%%s%ds" (if (eq align 'right) "" "-") len)
+ (if (eq align 'middle)
+ (concat (make-string (/ (- len width) 2) ?\s) string)
+ string))))
(defun bs--show-header ()
"Insert header for Buffer Selection Menu in current buffer."
- (mapcar '(lambda (string)
- (insert string "\n"))
- (bs--create-header)))
+ (dolist (string (bs--create-header))
+ (insert string "\n")))
(defun bs--get-name-length ()
"Return value of `bs--name-entry-length'."
(unless (string= "*buffer-selection*" (buffer-name))
;; Only when not in buffer *buffer-selection*
;; we have to set the buffer we started the command
- (progn
- (setq bs--buffer-coming-from (current-buffer))
- (setq bs--window-config-coming-from (current-window-configuration))))
+ (setq bs--buffer-coming-from (current-buffer)))
(let ((liste (bs-buffer-list))
- (active-window (bs--window-for-buffer "*buffer-selection*")))
+ (active-window (get-window-with-predicate
+ (lambda (w)
+ (string= (buffer-name (window-buffer w))
+ "*buffer-selection*"))
+ nil (selected-frame))))
(if active-window
(select-window active-window)
- (if (> (window-height (selected-window)) 7)
- (progn
- (split-window-vertically)
- (other-window 1))))
+ (bs--restore-window-config)
+ (setq bs--window-config-coming-from (current-window-configuration))
+ (when (> (window-height (selected-window)) 7)
+ (split-window-vertically)
+ (other-window 1)))
(bs-show-in-buffer liste)
(bs-message-without-log "%s" (bs--current-config-message)))))
"Make a menu of buffers so you can manipulate buffers or the buffer list.
\\<bs-mode-map>
There are many key commands similar to `Buffer-menu-mode' for
-manipulating buffer list and buffers itself.
+manipulating the buffer list and the buffers themselves.
User can move with [up] or [down], select a buffer
by \\[bs-select] or [SPC]\n
Type \\[bs-kill] to leave Buffer Selection Menu without a selection.