lisp/makesum.el

   1 ;;; makesum.el --- generate key binding summary for Emacs
   2
   3 ;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7 ;; Keywords: help
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; Displays a nice human-readable summary of all keybindings in a
  27 ;; two-column format.
  28
  29 ;;; Code:
  30
  31 ;;;###autoload
  32 (defun make-command-summary ()
  33   "Make a summary of current key bindings in the buffer *Summary*.
  34 Previous contents of that buffer are killed first."
  35   (interactive)
  36   (message "Making command summary...")
  37   ;; This puts a description of bindings in a buffer called *Help*.
  38   (save-window-excursion
  39    (describe-bindings))
  40   (with-output-to-temp-buffer "*Summary*"
  41     (save-excursion
  42      (let ((cur-mode mode-name))
  43        (set-buffer standard-output)
  44        (erase-buffer)
  45        (insert-buffer-substring "*Help*")
  46        (goto-char (point-min))
  47        (delete-region (point) (progn (forward-line 1) (point)))
  48        (while (search-forward "         " nil t)
  49          (replace-match "  "))
  50        (goto-char (point-min))
  51        (while (search-forward "-@ " nil t)
  52          (replace-match "-SP"))
  53        (goto-char (point-min))
  54        (while (search-forward "  .. ~ " nil t)
  55          (replace-match "SP .. ~"))
  56        (goto-char (point-min))
  57        (while (search-forward "C-?" nil t)
  58          (replace-match "DEL"))
  59        (goto-char (point-min))
  60        (while (search-forward "C-i" nil t)
  61          (replace-match "TAB"))
  62        (goto-char (point-min))
  63        (if (re-search-forward "^Local Bindings:" nil t)
  64            (progn
  65             (forward-char -1)
  66             (insert " for " (format-mode-line cur-mode) " Mode")
  67             (while (search-forward "??\n" nil t)
  68               (delete-region (point)
  69                              (progn
  70                               (forward-line -1)
  71                               (point))))))
  72        (goto-char (point-min))
  73        (insert "Emacs command summary, " (substring (current-time-string) 0 10)
  74                ".\n")
  75        ;; Delete "key    binding" and underlining of dashes.
  76        (delete-region (point) (progn (forward-line 2) (point)))
  77        (forward-line 1)                 ;Skip blank line
  78        (while (not (eobp))
  79          (let ((beg (point)))
  80            (or (re-search-forward "^$" nil t)
  81                (goto-char (point-max)))
  82            (double-column beg (point))
  83            (forward-line 1)))
  84        (goto-char (point-min)))))
  85   (message "Making command summary...done"))
  86
  87 (defun double-column (start end)
  88   (interactive "r")
  89   (let (half cnt
  90         line lines nlines
  91         (from-end (- (point-max) end)))
  92     (setq nlines (count-lines start end))
  93     (if (<= nlines 1)
  94         nil
  95       (setq half (/ (1+ nlines) 2))
  96       (goto-char start)
  97       (save-excursion
  98        (forward-line half)
  99        (while (< half nlines)
 100          (setq half (1+ half))
 101          (setq line (buffer-substring (point) (save-excursion (end-of-line) (point))))
 102          (setq lines (cons line lines))
 103          (delete-region (point) (progn (forward-line 1) (point)))))
 104       (setq lines (nreverse lines))
 105       (while lines
 106         (end-of-line)
 107         (indent-to 41)
 108         (insert (car lines))
 109         (forward-line 1)
 110         (setq lines (cdr lines))))
 111     (goto-char (- (point-max) from-end))))
 112
 113 (provide 'makesum)
 114
 115 ;; arch-tag: c2383336-fc89-46ad-8110-ded42bffaee3
 116 ;;; makesum.el ends here