home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / lucid / lemacs-19.6 / lisp / packages / buff-menu.el < prev    next >
Encoding:
Text File  |  1993-03-13  |  15.1 KB  |  439 lines
  1. ;; Buffer menu main function and support functions.
  2. ;; Copyright (C) 1985-1993 Free Software Foundation, Inc.
  3.  
  4. ;; This file is part of GNU Emacs.
  5.  
  6. ;; GNU Emacs is free software; you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation; either version 2, or (at your option)
  9. ;; any later version.
  10.  
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. ;; GNU General Public License for more details.
  15.  
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  18. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19.  
  20.  
  21. ; Put buffer *Buffer List* into proper mode right away
  22. ; so that from now on even list-buffers is enough to get a buffer menu.
  23.  
  24. (defvar Buffer-menu-mode-map nil "")
  25.  
  26. (if Buffer-menu-mode-map
  27.     ()
  28.   (setq Buffer-menu-mode-map (make-keymap))
  29.   (suppress-keymap Buffer-menu-mode-map t)
  30.   (define-key Buffer-menu-mode-map "q" 'Buffer-menu-select)
  31.   (define-key Buffer-menu-mode-map "2" 'Buffer-menu-2-window)
  32.   (define-key Buffer-menu-mode-map "1" 'Buffer-menu-1-window)
  33.   (define-key Buffer-menu-mode-map "f" 'Buffer-menu-this-window)
  34.   (define-key Buffer-menu-mode-map "o" 'Buffer-menu-other-window)
  35.   (define-key Buffer-menu-mode-map "s" 'Buffer-menu-save)
  36.   (define-key Buffer-menu-mode-map "d" 'Buffer-menu-delete)
  37.   (define-key Buffer-menu-mode-map "k" 'Buffer-menu-delete)
  38.   (define-key Buffer-menu-mode-map "\C-d" 'Buffer-menu-delete-backwards)
  39.   (define-key Buffer-menu-mode-map "\C-k" 'Buffer-menu-delete)
  40.   (define-key Buffer-menu-mode-map "x" 'Buffer-menu-execute)
  41.   (define-key Buffer-menu-mode-map " " 'next-line)
  42.   (define-key Buffer-menu-mode-map "\177" 'Buffer-menu-backup-unmark)
  43.   (define-key Buffer-menu-mode-map "~" 'Buffer-menu-not-modified)
  44.   (define-key Buffer-menu-mode-map "?" 'describe-mode)
  45.   (define-key Buffer-menu-mode-map "u" 'Buffer-menu-unmark)
  46.   (define-key Buffer-menu-mode-map "m" 'Buffer-menu-mark)
  47.   (define-key Buffer-menu-mode-map "t" 'Buffer-menu-visit-tags-table)
  48.   (define-key Buffer-menu-mode-map 'button2 'Buffer-menu-mouse-select)
  49.   (define-key Buffer-menu-mode-map 'button3 'Buffer-menu-popup-menu)
  50.   )
  51.  
  52. ;; Buffer Menu mode is suitable only for specially formatted data.
  53. (put 'Buffer-menu-mode 'mode-class 'special)
  54.  
  55. (defun Buffer-menu-mode ()
  56.   "Major mode for editing a list of buffers.
  57. Each line describes one of the buffers in Emacs.
  58. Letters do not insert themselves; instead, they are commands.
  59. m -- mark buffer to be displayed.
  60. q -- select buffer of line point is on.
  61.   Also show buffers marked with m in other windows.
  62. 1 -- select that buffer in full-screen window.
  63. 2 -- select that buffer in one window,
  64.   together with buffer selected before this one in another window.
  65. f -- select that buffer in place of the buffer menu buffer.
  66. o -- select that buffer in another window,
  67.   so the buffer menu buffer remains visible in its window.
  68. t -- visit-tags-table this buffer.
  69. ~ -- clear modified-flag on that buffer.
  70. s -- mark that buffer to be saved, and move down.
  71. d or k -- mark that buffer to be deleted, and move down.
  72. C-d -- mark that buffer to be deleted, and move up.
  73. x -- delete or save marked buffers.
  74. u -- remove all kinds of marks from current line.
  75. Delete -- back up a line and remove marks.
  76.  
  77. Precisely,\\{Buffer-menu-mode-map}"
  78.   (kill-all-local-variables)
  79.   (use-local-map Buffer-menu-mode-map)
  80.   (setq truncate-lines t)
  81.   (setq buffer-read-only t)
  82.   (setq major-mode 'Buffer-menu-mode)
  83.   (setq mode-name "Buffer Menu")
  84.   (require 'mode-motion)
  85.   (setq mode-motion-hook 'mode-motion-highlight-line)
  86.   (run-hooks 'buffer-menu-mode-hook))
  87.  
  88. (defvar Buffer-menu-buffer-column 4)
  89.  
  90. ;; from mly@ai.mit.edu (Richard Mlynarik)
  91. (defun Buffer-menu-buffer (error-if-non-existent-p)
  92.   "Return buffer described by this line of buffer menu."
  93.   (save-excursion
  94.     (beginning-of-line)
  95.     (forward-char Buffer-menu-buffer-column)
  96.     (let* ((start (point))
  97.            (string (if (/= (preceding-char) ?\")
  98.                        ;; End of buffer name marked by tab or a space.
  99.                        (progn (re-search-forward "\t\\| ")
  100.                               (skip-chars-backward " \t")
  101.                               (buffer-substring start (point)))
  102.                        (progn
  103.                          (backward-char 1)
  104.                          (read (current-buffer))))))
  105.       (or (get-buffer string)
  106.       (if error-if-non-existent-p
  107.           (error "No buffer named \"%s\"" string)
  108.         nil)))))
  109.  
  110. (defvar list-buffers-header-line
  111.   (concat " MR Buffer           Size  Mode         File\n"
  112.       " -- ------           ----  ----         ----\n"))
  113.  
  114. (defvar list-buffers-identification 'default-list-buffers-identification
  115.   "String used to identify this buffer, or a function of one argument
  116. to generate such a string.  This variable is always buffer-local.")
  117. (make-variable-buffer-local 'list-buffers-identification)
  118.  
  119. (defun default-list-buffers-identification (output)
  120.   (save-excursion
  121.     (let ((file (or (buffer-file-name (current-buffer))
  122.             (and (boundp 'list-buffers-directory)
  123.              list-buffers-directory)))
  124.       (size (buffer-size))
  125.       (mode mode-name)
  126.       eob p s col)
  127.       (set-buffer output)
  128.       (end-of-line)
  129.       (setq eob (point))
  130.       (prin1 size)
  131.       (setq p (point))
  132.       ;; right-justify the size
  133.       (move-to-column 19 t)
  134.       (setq col (point))
  135.       (if (> eob col)
  136.       (goto-char eob))
  137.       (setq s (- 6 (- p col)))
  138.       (while (> s 0) ; speed/consing tradeoff...
  139.     (insert ? )
  140.     (setq s (1- s)))
  141.       (end-of-line)
  142.       (indent-to 27 1)
  143.       (insert mode)
  144.       (if (not file)
  145.       nil
  146.     ;; if the mode-name is really long, clip it for the filename
  147.     (if (> 0 (setq s (- 39 (current-column))))
  148.         (delete-char (max s (- eob (point)))))
  149.     (indent-to 40 1)
  150.     (insert file)))))
  151.  
  152. (defun list-buffers (&optional files-only)
  153.   "Display a list of names of existing buffers.
  154. Inserts it in buffer *Buffer List* and displays that.
  155. Note that buffers with names starting with spaces are omitted.
  156. Non-null optional arg FILES-ONLY means mention only file buffers.
  157.  
  158. The M column contains a * for buffers that are modified.
  159. The R column contains a % for buffers that are read-only."
  160.   (interactive "P")
  161.   (let ((current (current-buffer))
  162.     (col1 19)
  163.     output)
  164.     (with-output-to-temp-buffer "*Buffer List*"
  165.       (save-excursion
  166.         (let ((buffers (buffer-list)))
  167.           (setq output standard-output)
  168.           (set-buffer output)
  169.           (Buffer-menu-mode)
  170.           (setq buffer-read-only nil)
  171.           (buffer-disable-undo output)
  172.           (insert list-buffers-header-line)
  173.           (while buffers
  174.             (let* ((buffer (car buffers))
  175.                    (name (buffer-name buffer))
  176.                    (file (buffer-file-name buffer)))
  177.               (setq buffers (cdr buffers))
  178.               (cond ((null name)) ;deleted buffer
  179.                     ((and (/= 0 (length name));don't mention if starts with " "
  180.                           (= (aref name 0) ?\ )))
  181.                     ((and files-only (null file)))
  182.                     (t
  183.                      (set-buffer buffer)
  184.                      (let ((ro buffer-read-only)
  185.                            (id list-buffers-identification))
  186.                        (set-buffer output)
  187.                        (insert (if (eq buffer current)
  188.                                    (progn (setq current (point)) ?\.)
  189.                                    ?\ ))
  190.                (insert (if (buffer-modified-p buffer)
  191.                                    ?\* 
  192.                    ?\ ))
  193.                (insert (if ro
  194.                                    ?\%
  195.                                    ?\ ))
  196.                        (if (string-match "[\n\"\\ \t]" name)
  197.                            (let ((print-escape-newlines t))
  198.                              (prin1 name output))
  199.                            (insert ?\  name))
  200.                        (indent-to col1 1)
  201.                        (cond ((stringp id)
  202.                               (insert id))
  203.                              (id
  204.                               (set-buffer buffer)
  205.                               (condition-case e
  206.                                   (funcall id output)
  207.                                 (error
  208.                                  (princ "***" output) (prin1 e output)))
  209.                               (set-buffer output)
  210.                               (goto-char (point-max)))))
  211.                      (insert ?\n)))))
  212.           (setq buffer-read-only t))))
  213.     (if (not (bufferp current))
  214.     (save-excursion
  215.       (set-buffer output)
  216.       (goto-char current)))))
  217.  
  218. (defun buffer-menu (arg)
  219.   "Make a menu of buffers so you can save, delete or select them.
  220. With argument, show only buffers that are visiting files.
  221. Type ? after invocation to get help on commands available.
  222. Type q immediately to make the buffer menu go away."
  223.   (interactive "P")
  224.   (list-buffers arg)
  225.   (pop-to-buffer "*Buffer List*")
  226.   (forward-line 2)
  227.   (message
  228.    "Commands: d, s, x; 1, 2, m, u, q; delete; ~;  ? for help."))
  229.  
  230. (defun Buffer-menu-mark ()
  231.   "Mark buffer on this line for being displayed by \\[Buffer-menu-select] command."
  232.   (interactive)
  233.   (beginning-of-line)
  234.   (if (looking-at " [-M]")
  235.       (ding)
  236.     (let ((buffer-read-only nil))
  237.       (delete-char 1)
  238.       (insert ?>)
  239.       (forward-line 1))))
  240.  
  241. (defun Buffer-menu-unmark ()
  242.   "Cancel all requested operations on buffer on this line."
  243.   (interactive)
  244.   (beginning-of-line)
  245.   (if (looking-at " [-M]")
  246.       (ding)
  247.     (let* ((buf (Buffer-menu-buffer t))
  248.        (mod (buffer-modified-p buf))
  249.        (readonly (save-excursion (set-buffer buf) buffer-read-only))
  250.        (buffer-read-only nil))
  251.       (delete-char 3)
  252.       (insert (if readonly (if mod " *%" "  %") (if mod " * " "   ")))))
  253.   (forward-line 1))
  254.  
  255. (defun Buffer-menu-backup-unmark ()
  256.   "Move up and cancel all requested operations on buffer on line above."
  257.   (interactive)
  258.   (forward-line -1)
  259.   (Buffer-menu-unmark)
  260.   (forward-line -1))
  261.  
  262. (defun Buffer-menu-delete ()
  263.   "Mark buffer on this line to be deleted by \\[Buffer-menu-execute] command."
  264.   (interactive)
  265.   (beginning-of-line)
  266.   (if (looking-at " [-M]")        ;header lines
  267.       (ding)
  268.     (let ((buffer-read-only nil))
  269.       (delete-char 1)
  270.       (insert ?D)
  271.       (forward-line 1))))
  272.  
  273. (defun Buffer-menu-delete-backwards ()
  274.   "Mark buffer on this line to be deleted by \\[Buffer-menu-execute] command
  275. and then move up one line"
  276.   (interactive)
  277.   (Buffer-menu-delete)
  278.   (forward-line -2)
  279.   (if (looking-at " [-M]") (forward-line 1)))
  280.  
  281. (defun Buffer-menu-save ()
  282.   "Mark buffer on this line to be saved by \\[Buffer-menu-execute] command."
  283.   (interactive)
  284.   (beginning-of-line)
  285.   (forward-char 1)
  286.   (if (looking-at " [-M]")        ;header lines
  287.       (ding)
  288.     (let ((buffer-read-only nil))
  289.       (delete-char 1)
  290.       (insert ?S)
  291.       (forward-line 1))))
  292.  
  293. (defun Buffer-menu-not-modified ()
  294.   "Mark buffer on this line as unmodified (no changes to save)."
  295.   (interactive)
  296.   (save-excursion
  297.     (set-buffer (Buffer-menu-buffer t))
  298.     (set-buffer-modified-p nil))
  299.   (save-excursion
  300.    (beginning-of-line)
  301.    (forward-char 1)
  302.    (if (looking-at "\\*")
  303.        (let ((buffer-read-only nil))
  304.      (delete-char 1)
  305.      (insert ? )))))
  306.  
  307. (defun Buffer-menu-execute ()
  308.   "Save and/or delete buffers marked with \\[Buffer-menu-save] or \\[Buffer-menu-delete] commands."
  309.   (interactive)
  310.   (save-excursion
  311.     (goto-char (point-min))
  312.     (forward-line 1)
  313.     (while (re-search-forward "^.S" nil t)
  314.       (let ((modp nil))
  315.     (save-excursion
  316.       (set-buffer (Buffer-menu-buffer t))
  317.       (save-buffer)
  318.       (setq modp (buffer-modified-p)))
  319.     (let ((buffer-read-only nil))
  320.       (delete-char -1)
  321.       (insert (if modp ?* ? ))))))
  322.   (save-excursion
  323.     (goto-char (point-min))
  324.     (forward-line 1)
  325.     (let ((buff-menu-buffer (current-buffer))
  326.       (buffer-read-only nil))
  327.       (while (search-forward "\nD" nil t)
  328.     (forward-char -1)
  329.     (let ((buf (Buffer-menu-buffer nil)))
  330.       (or (eq buf nil)
  331.           (eq buf buff-menu-buffer)
  332.           (save-excursion (kill-buffer buf))))
  333.     (if (Buffer-menu-buffer nil)
  334.         (progn (delete-char 1)
  335.            (insert ? ))
  336.       (delete-region (point) (progn (forward-line 1) (point)))
  337.        (forward-char -1))))))
  338.  
  339. (defun Buffer-menu-select ()
  340.   "Select this line's buffer; also display buffers marked with \">\".
  341. You can mark buffers with the \\[Buffer-menu-mark] command."
  342.   (interactive)
  343.   (let ((buff (Buffer-menu-buffer t))
  344.     (menu (current-buffer))          
  345.     (others ())
  346.     tem)
  347.     (goto-char (point-min))
  348.     (while (search-forward "\n>" nil t)
  349.       (setq tem (Buffer-menu-buffer t))
  350.       (let ((buffer-read-only nil))
  351.     (delete-char -1)
  352.     (insert ?\ ))
  353.       (or (eq tem buff) (memq tem others) (setq others (cons tem others))))
  354.     (setq others (nreverse others)
  355.       tem (/ (1- (screen-height)) (1+ (length others))))
  356.     (delete-other-windows)
  357.     (switch-to-buffer buff)
  358.     (or (eq menu buff)
  359.     (bury-buffer menu))
  360.     (while others
  361.       (split-window nil tem)
  362.       (other-window 1)
  363.       (switch-to-buffer (car others))
  364.       (setq others (cdr others)))
  365.     (other-window 1)))            ;back to the beginning!
  366.  
  367. (defun Buffer-menu-visit-tags-table ()
  368.   "Visit the tags table in the buffer on this line.  See `visit-tags-table'."
  369.   (interactive)
  370.   (let ((file (buffer-file-name (Buffer-menu-buffer t))))
  371.     (if file
  372.     (visit-tags-table file)
  373.       (error "Specified buffer has no file"))))
  374.  
  375. (defun Buffer-menu-1-window ()
  376.   "Select this line's buffer, alone, in full screen."
  377.   (interactive)
  378.   (switch-to-buffer (Buffer-menu-buffer t))
  379.   (bury-buffer (other-buffer))
  380.   (delete-other-windows)
  381.   ;; This is to get w->force_start set to nil.  Don't ask me, I only work here.
  382.   (set-window-buffer (selected-window) (current-buffer)))
  383.  
  384. (defun Buffer-menu-this-window ()
  385.   "Select this line's buffer in this window."
  386.   (interactive)
  387.   (switch-to-buffer (Buffer-menu-buffer t)))
  388.  
  389. (defun Buffer-menu-other-window ()
  390.   "Select this line's buffer in other window, leaving buffer menu visible."
  391.   (interactive)
  392.   (switch-to-buffer-other-window (Buffer-menu-buffer t)))
  393.  
  394. (defun Buffer-menu-2-window ()
  395.   "Select this line's buffer, with previous buffer in second window."
  396.   (interactive)
  397.   (let ((buff (Buffer-menu-buffer t))
  398.     (menu (current-buffer))
  399.     (pop-up-windows t))
  400.     (switch-to-buffer (other-buffer))
  401.     (pop-to-buffer buff)
  402.     (bury-buffer menu)))
  403.  
  404.  
  405. ;;; mouseability
  406.  
  407. (defun Buffer-menu-mouse-select (event)
  408.   (interactive "e")
  409.   (mouse-set-point event)
  410.   (Buffer-menu-select))
  411.  
  412. (defvar Buffer-menu-popup-menu
  413.   '("Buffer Commands"
  414.     ["Select Buffer"            Buffer-menu-select        t]
  415.     ["Select buffer Other Window"    Buffer-menu-other-window    t]
  416.     ["Clear Buffer Modification Flag"    Buffer-menu-not-modified    t]
  417.     "----"
  418.     ["Mark Buffer for Selection"    Buffer-menu-mark        t]
  419.     ["Mark Buffer for Save"        Buffer-menu-save        t]
  420.     ["Mark Buffer for Deletion"        Buffer-menu-delete        t]
  421.     ["Unmark Buffer"            Buffer-menu-unmark        t]
  422.     "----"
  423.     ["Delete/Save Marked Buffers"    Buffer-menu-execute        t]
  424.     ))
  425.  
  426. (defun Buffer-menu-popup-menu (event)
  427.   (interactive "e")
  428.   (mouse-set-point event)
  429.   (beginning-of-line)
  430.   (let ((buffer (Buffer-menu-buffer nil)))
  431.     (if buffer
  432.     (popup-menu
  433.      (nconc (list (car Buffer-menu-popup-menu)
  434.               (concat
  435.                "Commands on buffer \"" (buffer-name buffer) "\":")
  436.               "----")
  437.         (cdr Buffer-menu-popup-menu)))
  438.       (error "no buffer on this line"))))
  439.