lisp/ebuff-menu.el

   1 ;;; ebuff-menu.el --- electric-buffer-list mode
   2
   3 ;; Copyright (C) 1985, 1986, 1994 Free Software Foundation, Inc.
   4
   5 ;; Author: Richard Mlynarik <mly@ai.mit.edu>
   6
   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
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  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
  23 ;;; Commentary:
  24
  25 ;; Who says one can't have typeout windows in GNU Emacs?   The entry
  26 ;; point, `electric-buffer-list' works like ^r select buffer from the
  27 ;; ITS Emacs lunar or tmacs libraries.
  28
  29 ;;; Code:
  30
  31 (require 'electric)
  32
  33 ;; this depends on the format of list-buffers (from src/buffer.c) and
  34 ;; on stuff in lisp/buff-menu.el
  35
  36 (defvar electric-buffer-menu-mode-map nil)
  37
  38 ;;;###autoload
  39 (defun electric-buffer-list (arg)
  40   "Pops up a buffer describing the set of Emacs buffers.
  41 Vaguely like ITS lunar select buffer; combining typeoutoid buffer
  42 listing with menuoid buffer selection.
  43
  44 If the very next character typed is a space then the buffer list
  45 window disappears.  Otherwise, one may move around in the buffer list
  46 window, marking buffers to be selected, saved or deleted.
  47
  48 To exit and select a new buffer, type a space when the cursor is on
  49 the appropriate line of the buffer-list window.  Other commands are
  50 much like those of buffer-menu-mode.
  51
  52 Calls value of `electric-buffer-menu-mode-hook' on entry if non-nil.
  53
  54 \\{electric-buffer-menu-mode-map}"
  55   (interactive "P")
  56   (let (select buffer)
  57     (save-window-excursion
  58       (save-window-excursion (list-buffers arg))
  59       (setq buffer (window-buffer (Electric-pop-up-window "*Buffer List*")))
  60       (unwind-protect
  61           (progn
  62             (set-buffer buffer)
  63             (Electric-buffer-menu-mode)
  64             (setq select
  65                   (catch 'electric-buffer-menu-select
  66                     (message "<<< Press Return to bury the buffer list >>>")
  67                     (if (eq (setq unread-command-events (list (read-event)))
  68                             ?\ )
  69                         (progn (setq unread-command-events nil)
  70                                (throw 'electric-buffer-menu-select nil)))
  71                     (let ((start-point (point))
  72                           (first (progn (goto-char (point-min))
  73                                         (forward-line 2)
  74                                         (point)))
  75                           (last (progn (goto-char (point-max))
  76                                        (forward-line -1)
  77                                        (point)))
  78                           (goal-column 0))
  79                       ;; Use start-point if it is meaningful.
  80                       (goto-char (if (or (< start-point first)
  81                                          (> start-point last))
  82                                      first
  83                                    start-point))
  84                       (Electric-command-loop 'electric-buffer-menu-select
  85                                              nil
  86                                              t
  87                                              'electric-buffer-menu-looper
  88                                              (cons first last))))))
  89         (set-buffer buffer)
  90         (Buffer-menu-mode)
  91         (bury-buffer buffer)
  92         (message "")))
  93     (if select
  94         (progn (set-buffer buffer)
  95                (let ((opoint (point-marker)))
  96                  (Buffer-menu-execute)
  97                  (goto-char (point-min))
  98                  (if (prog1 (search-forward "\n>" nil t)
  99                        (goto-char opoint) (set-marker opoint nil))
 100                      (Buffer-menu-select)
 101                      (switch-to-buffer (Buffer-menu-buffer t))))))))
 102
 103 (defun electric-buffer-menu-looper (state condition)
 104   (cond ((and condition
 105               (not (memq (car condition) '(buffer-read-only
 106                                            end-of-buffer
 107                                            beginning-of-buffer))))
 108          (signal (car condition) (cdr condition)))
 109         ((< (point) (car state))
 110          (goto-char (point-min))
 111          (forward-line 2))
 112         ((> (point) (cdr state))
 113          (goto-char (point-max))
 114          (forward-line -1)
 115          (if (pos-visible-in-window-p (point-max))
 116              (recenter -1)))))
 117
 118 (put 'Electric-buffer-menu-mode 'mode-class 'special)
 119 (defun Electric-buffer-menu-mode ()
 120   "Major mode for editing a list of buffers.
 121 Each line describes one of the buffers in Emacs.
 122 Letters do not insert themselves; instead, they are commands.
 123 \\<electric-buffer-menu-mode-map>
 124 \\[keyboard-quit] or \\[Electric-buffer-menu-quit] -- exit buffer menu, returning to previous window and buffer
 125   configuration.  If the very first character typed is a space, it
 126   also has this effect.
 127 \\[Electric-buffer-menu-select] -- select buffer of line point is on.
 128   Also show buffers marked with m in other windows,
 129   deletes buffers marked with \"D\", and saves those marked with \"S\".
 130 \\[Buffer-menu-mark] -- mark buffer to be displayed.
 131 \\[Buffer-menu-not-modified] -- clear modified-flag on that buffer.
 132 \\[Buffer-menu-save] -- mark that buffer to be saved.
 133 \\[Buffer-menu-delete] or \\[Buffer-menu-delete-backwards] -- mark that buffer to be deleted.
 134 \\[Buffer-menu-unmark] -- remove all kinds of marks from current line.
 135 \\[Electric-buffer-menu-mode-view-buffer] -- view buffer, returning when done.
 136 \\[Buffer-menu-backup-unmark] -- back up a line and remove marks.
 137
 138 \\{electric-buffer-menu-mode-map}
 139
 140 Entry to this mode via command electric-buffer-list calls the value of
 141 electric-buffer-menu-mode-hook if it is non-nil."
 142   (kill-all-local-variables)
 143   (use-local-map electric-buffer-menu-mode-map)
 144   (setq mode-name "Electric Buffer Menu")
 145   (setq mode-line-buffer-identification "Electric Buffer List")
 146   (make-local-variable 'Helper-return-blurb)
 147   (setq Helper-return-blurb "return to buffer editing")
 148   (setq truncate-lines t)
 149   (setq buffer-read-only t)
 150   (setq major-mode 'Electric-buffer-menu-mode)
 151   (goto-char (point-min))
 152   (if (search-forward "\n." nil t) (forward-char -1))
 153   (run-hooks 'electric-buffer-menu-mode-hook))
 154
 155 ;; generally the same as Buffer-menu-mode-map
 156 ;;  (except we don't indirect to global-map)
 157 (put 'Electric-buffer-menu-undefined 'suppress-keymap t)
 158 (if electric-buffer-menu-mode-map
 159     nil
 160   (let ((map (make-keymap)) (submap (make-keymap)))
 161     (fillarray (car (cdr map)) 'Electric-buffer-menu-undefined)
 162     (define-key map "\e" submap)
 163     (fillarray (car (cdr submap)) 'Electric-buffer-menu-undefined)
 164     (define-key map "\C-z" 'suspend-emacs)
 165     (define-key map "v" 'Electric-buffer-menu-mode-view-buffer)
 166     (define-key map (char-to-string help-char) 'Helper-help)
 167     (define-key map "?" 'Helper-describe-bindings)
 168     (define-key map "\C-c" nil)
 169     (define-key map "\C-c\C-c" 'Electric-buffer-menu-quit)
 170     (define-key map "\C-]" 'Electric-buffer-menu-quit)
 171     (define-key map "q" 'Electric-buffer-menu-quit)
 172     (define-key map " " 'Electric-buffer-menu-select)
 173     (define-key map "\C-m" 'Electric-buffer-menu-select)
 174     (define-key map "\C-l" 'recenter)
 175     (define-key map "s" 'Buffer-menu-save)
 176     (define-key map "d" 'Buffer-menu-delete)
 177     (define-key map "k" 'Buffer-menu-delete)
 178     (define-key map "\C-d" 'Buffer-menu-delete-backwards)
 179     ;(define-key map "\C-k" 'Buffer-menu-delete)
 180     (define-key map "\177" 'Buffer-menu-backup-unmark)
 181     (define-key map "~" 'Buffer-menu-not-modified)
 182     (define-key map "u" 'Buffer-menu-unmark)
 183     (let ((i ?0))
 184       (while (<= i ?9)
 185         (define-key map (char-to-string i) 'digit-argument)
 186         (define-key map (concat "\e" (char-to-string i)) 'digit-argument)
 187         (setq i (1+ i))))
 188     (define-key map "-" 'negative-argument)
 189     (define-key map "\e-" 'negative-argument)
 190     (define-key map "m" 'Buffer-menu-mark)
 191     (define-key map "\C-u" 'universal-argument)
 192     (define-key map "\C-p" 'previous-line)
 193     (define-key map "\C-n" 'next-line)
 194     (define-key map "p" 'previous-line)
 195     (define-key map "n" 'next-line)
 196     (define-key map "\C-v" 'scroll-up)
 197     (define-key map "\ev" 'scroll-down)
 198     (define-key map ">" 'scroll-right)
 199     (define-key map "<" 'scroll-left)
 200     (define-key map "\e\C-v" 'scroll-other-window)
 201     (define-key map "\e>" 'end-of-buffer)
 202     (define-key map "\e<" 'beginning-of-buffer)
 203     (define-key map "\e\e" nil)
 204     (define-key map "\e\e\e" 'Electric-buffer-menu-quit)
 205     (define-key map [escape escape escape] 'Electric-buffer-menu-quit)
 206     (define-key map [mouse-2] 'Electric-buffer-menu-mouse-select)
 207     (setq electric-buffer-menu-mode-map map)))
 208
 209 (defun Electric-buffer-menu-exit ()
 210   (interactive)
 211   (setq unread-command-events (listify-key-sequence (this-command-keys)))
 212   ;; for robustness
 213   (condition-case ()
 214       (throw 'electric-buffer-menu-select nil)
 215     (error (Buffer-menu-mode)
 216            (other-buffer))))
 217
 218 (defun Electric-buffer-menu-select ()
 219   "Leave Electric Buffer Menu, selecting buffers and executing changes.
 220 Saves buffers marked \"S\".  Deletes buffers marked \"K\".
 221 Selects buffer at point and displays buffers marked \">\" in other windows."
 222   (interactive)
 223   (throw 'electric-buffer-menu-select (point)))
 224
 225 (defun Electric-buffer-menu-mouse-select (event)
 226   (interactive "e")
 227   (select-window (posn-window (event-end event)))
 228   (set-buffer (window-buffer (selected-window)))
 229   (goto-char (posn-point (event-end event)))
 230   (throw 'electric-buffer-menu-select (point)))
 231
 232 (defun Electric-buffer-menu-quit ()
 233   "Leave Electric Buffer Menu, restoring previous window configuration.
 234 Does not execute select, save, or delete commands."
 235   (interactive)
 236   (throw 'electric-buffer-menu-select nil))
 237
 238 (defun Electric-buffer-menu-undefined ()
 239   (interactive)
 240   (ding)
 241   (message (if (and (eq (key-binding "\C-c\C-c") 'Electric-buffer-menu-quit)
 242                     (eq (key-binding " ") 'Electric-buffer-menu-select)
 243                     (eq (key-binding (char-to-string help-char)) 'Helper-help)
 244                     (eq (key-binding "?") 'Helper-describe-bindings))
 245                (substitute-command-keys "Type C-c C-c to exit, Space to select, \\[Helper-help] for help, ? for commands")
 246              (substitute-command-keys "\
 247 Type \\[Electric-buffer-menu-quit] to exit, \
 248 \\[Electric-buffer-menu-select] to select, \
 249 \\[Helper-help] for help, \\[Helper-describe-bindings] for commands.")))
 250   (sit-for 4))
 251
 252 (defun Electric-buffer-menu-mode-view-buffer ()
 253   "View buffer on current line in Electric Buffer Menu.
 254 Returns to Electric Buffer Menu when done."
 255   (interactive)
 256   (let ((bufnam (Buffer-menu-buffer nil)))
 257     (if bufnam
 258         (view-buffer bufnam)
 259       (ding)
 260       (message "Buffer %s does not exist!" bufnam)
 261       (sit-for 4))))
 262
 263 ;;; ebuff-menu.el ends here