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