lisp/help-macro.el

   1 ;;; help-macro.el --- makes command line help such as help-for-help
   2
   3 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
   4
   5 ;; Author: Lynn Slater <lrs@indetech.com>
   6 ;; Maintainer: FSF
   7 ;; Created: Mon Oct  1 11:42:39 1990
   8 ;; Adapted-By: ESR
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25 ;; Boston, MA 02111-1307, USA.
  26
  27 ;;; Commentary:
  28
  29 ;; This file supplies the macro make-help-screen which constructs
  30 ;; single character dispatching with browsable help such as that provided
  31 ;; by help-for-help. This can be used to make many modes easier to use; for
  32 ;; example, the GNU Emacs Empire Tool uses this for every "nested" mode map
  33 ;; called from the main mode map.
  34
  35 ;;       The name of this package was changed from help-screen.el to
  36 ;; help-macro.el in order to fit in a 14-character limit.
  37
  38 ;;-> ***********************  Example of use *********************************
  39
  40 ;;->(make-help-screen help-for-empire-redistribute-map
  41 ;;->              "c:civ m:mil p:population f:food ?"
  42 ;;->              "You have discovered the GEET redistribution commands
  43 ;;->   From here, you can use the following options:
  44 ;;->
  45 ;;->c   Redistribute civs from overfull sectors into connected underfull ones
  46 ;;->      The functions typically named by empire-ideal-civ-fcn control
  47 ;;->          based in part on empire-sector-civ-threshold
  48 ;;->m   Redistribute military using levels given by empire-ideal-mil-fcn
  49 ;;->p   Redistribute excess population to highways for max pop growth
  50 ;;->      Excess is any sector so full babies will not be born.
  51 ;;->f   Even out food on highways to highway min and leave levels
  52 ;;->      This is good to pump max food to all warehouses/dist pts
  53 ;;->
  54 ;;->
  55 ;;->Use \\[help-for-empire-redistribute-map] for help on redistribution.
  56 ;;->Use \\[help-for-empire-extract-map] for help on data extraction.
  57 ;;->Please use \\[describe-key] to find out more about any of the other keys."
  58 ;;->              empire-shell-redistribute-map)
  59
  60 ;;->  (define-key c-mp "\C-h" 'help-for-empire-redistribute-map)
  61 ;;->  (define-key c-mp help-character 'help-for-empire-redistribute-map)
  62
  63 ;;; Change Log:
  64 ;;
  65 ;; 22-Jan-1991          Lynn Slater x2048
  66 ;;    Last Modified: Mon Oct  1 11:43:52 1990 #3 (Lynn Slater)
  67 ;;    documented better
  68
  69 ;;; Code:
  70
  71 (require 'backquote)
  72
  73 ;;;###autoload
  74 (defcustom three-step-help nil
  75   "*Non-nil means give more info about Help command in three steps.
  76 The three steps are simple prompt, prompt with all options,
  77 and window listing and describing the options.
  78 A value of nil means skip the middle step, so that
  79 \\[help-command] \\[help-command] gives the window that lists the options."
  80   :type 'boolean
  81   :group 'help)
  82
  83 (defmacro make-help-screen (fname help-line help-text helped-map)
  84   "Construct help-menu function name FNAME.
  85 When invoked, FNAME shows HELP-LINE and reads a command using HELPED-MAP.
  86 If the command is the help character, FNAME displays HELP-TEXT
  87 and continues trying to read a command using HELPED-MAP.
  88 If HELP-TEXT contains the sequence `%THIS-KEY%', that is replaced
  89 with the key sequence that invoked FNAME.
  90 When FNAME finally does get a command, it executes that command
  91 and then returns."
  92  (let ((doc-fn (intern (concat (symbol-name fname) "-doc"))))
  93   `(progn
  94     (defun ,doc-fn () ,help-text)
  95     (defun ,fname ()
  96            "Help command."
  97            (interactive)
  98            (let ((line-prompt
  99                   (substitute-command-keys ,help-line)))
 100              (if three-step-help
 101                  (message "%s" line-prompt))
 102              (let* ((help-screen (documentation (quote ,doc-fn)))
 103                     ;; We bind overriding-local-map for very small
 104                     ;; sections, *excluding* where we switch buffers
 105                     ;; and where we execute the chosen help command.
 106                     (local-map (make-sparse-keymap))
 107                     (minor-mode-map-alist nil)
 108                     (prev-frame (selected-frame))
 109                     config new-frame key char)
 110                (if (string-match "%THIS-KEY%" help-screen)
 111                    (setq help-screen
 112                          (replace-match (key-description (substring (this-command-keys) 0 -1))
 113                                         t t help-screen)))
 114                (unwind-protect
 115                    (progn
 116                      (setcdr local-map ,helped-map)
 117                      (define-key local-map [t] 'undefined)
 118                      ;; Make the scroll bar keep working normally.
 119                      (define-key local-map [vertical-scroll-bar]
 120                        (lookup-key global-map [vertical-scroll-bar]))
 121                      (if three-step-help
 122                          (progn
 123                            (setq key (let ((overriding-local-map local-map))
 124                                      (read-key-sequence nil)))
 125                            ;; Make the HELP key translate to C-h.
 126                            (if (lookup-key function-key-map key)
 127                                (setq key (lookup-key function-key-map key)))
 128                            (setq char (aref key 0)))
 129                        (setq char ??))
 130                      (if (or (eq char ??) (eq char help-char)
 131                              (memq char help-event-list))
 132                          (progn
 133                            (setq config (current-window-configuration))
 134                            (switch-to-buffer-other-window "*Help*")
 135                            (and (fboundp 'make-frame)
 136                                 (not (eq (window-frame (selected-window))
 137                                          prev-frame))
 138                                 (setq new-frame (window-frame (selected-window))
 139                                       config nil))
 140                            (setq buffer-read-only nil)
 141                            (erase-buffer)
 142                            (insert help-screen)
 143                            (help-mode)
 144                            (goto-char (point-min))
 145                            (while (or (memq char (append help-event-list
 146                                                          (cons help-char '(?? ?\C-v ?\ ?\177 delete backspace vertical-scroll-bar ?\M-v))))
 147                                       (eq (car-safe char) 'switch-frame)
 148                                       (equal key "\M-v"))
 149                              (condition-case nil
 150                                  (progn
 151                                    (if (eq (car-safe char) 'switch-frame)
 152                                        (handle-switch-frame char))
 153                                    (if (memq char '(?\C-v ?\ ))
 154                                        (scroll-up))
 155                                    (if (or (memq char '(?\177 ?\M-v
 156                                                         delete backspace))
 157                                            (equal key "\M-v"))
 158                                        (scroll-down)))
 159                                (error nil))
 160                              (let ((cursor-in-echo-area t)
 161                                    (overriding-local-map local-map))
 162                                (setq key (read-key-sequence
 163                                           (format "Type one of the options listed%s: "
 164                                                   (if (pos-visible-in-window-p
 165                                                        (point-max))
 166                                                       "" ", or SPACE or DEL to scroll")))
 167                                      char (aref key 0)))
 168
 169                              ;; If this is a scroll bar command, just run it.
 170                              (when (eq char 'vertical-scroll-bar)
 171                                (command-execute (lookup-key local-map key) nil key)))))
 172                      ;; We don't need the prompt any more.
 173                      (message "")
 174                      ;; Mouse clicks are not part of the help feature,
 175                      ;; so reexecute them in the standard environment.
 176                      (if (listp char)
 177                          (setq unread-command-events
 178                                (cons char unread-command-events)
 179                                config nil)
 180                        (let ((defn (lookup-key local-map key)))
 181                          (if defn
 182                              (progn
 183                                (if config
 184                                    (progn
 185                                      (set-window-configuration config)
 186                                      (setq config nil)))
 187                                (if new-frame
 188                                    (progn (iconify-frame new-frame)
 189                                           (setq new-frame nil)))
 190                                (call-interactively defn))
 191                            (ding)))))
 192                  (if new-frame (iconify-frame new-frame))
 193                  (if config
 194                      (set-window-configuration config))))))
 195      )))
 196
 197 (provide 'help-macro)
 198
 199 ;;; help-macro.el ends here