38412
|
1 ;;; help-macro.el --- makes command line help such as help-for-help
|
2456
|
2
|
64762
|
3 ;; Copyright (C) 1993, 1994, 2002, 2003, 2004,
|
|
4 ;; 2005 Free Software Foundation, Inc.
|
2456
|
5
|
|
6 ;; Author: Lynn Slater <lrs@indetech.com>
|
17976
|
7 ;; Maintainer: FSF
|
38412
|
8 ;; Created: Mon Oct 1 11:42:39 1990
|
2456
|
9 ;; Adapted-By: ESR
|
|
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
|
14169
|
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
64091
|
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
26 ;; Boston, MA 02110-1301, USA.
|
2456
|
27
|
|
28 ;;; Commentary:
|
14169
|
29
|
|
30 ;; This file supplies the macro make-help-screen which constructs
|
2456
|
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
|
38412
|
33 ;; example, the GNU Emacs Empire Tool uses this for every "nested" mode map
|
2456
|
34 ;; called from the main mode map.
|
|
35
|
2530
|
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
|
2456
|
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
|
25298
|
48 ;;-> based in part on empire-sector-civ-threshold
|
2456
|
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 ;;
|
25298
|
66 ;; 22-Jan-1991 Lynn Slater x2048
|
2456
|
67 ;; Last Modified: Mon Oct 1 11:43:52 1990 #3 (Lynn Slater)
|
|
68 ;; documented better
|
|
69
|
|
70 ;;; Code:
|
|
71
|
|
72 (require 'backquote)
|
|
73
|
5679
|
74 ;;;###autoload
|
25298
|
75 (defcustom three-step-help nil
|
5679
|
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
|
25298
|
80 \\[help-command] \\[help-command] gives the window that lists the options."
|
|
81 :type 'boolean
|
|
82 :group 'help)
|
5679
|
83
|
2456
|
84 (defmacro make-help-screen (fname help-line help-text helped-map)
|
5378
|
85 "Construct help-menu function name FNAME.
|
|
86 When invoked, FNAME shows HELP-LINE and reads a command using HELPED-MAP.
|
8709
|
87 If the command is the help character, FNAME displays HELP-TEXT
|
5378
|
88 and continues trying to read a command using HELPED-MAP.
|
23331
|
89 If HELP-TEXT contains the sequence `%THIS-KEY%', that is replaced
|
|
90 with the key sequence that invoked FNAME.
|
5378
|
91 When FNAME finally does get a command, it executes that command
|
|
92 and then returns."
|
23331
|
93 (let ((doc-fn (intern (concat (symbol-name fname) "-doc"))))
|
|
94 `(progn
|
|
95 (defun ,doc-fn () ,help-text)
|
|
96 (defun ,fname ()
|
|
97 "Help command."
|
2456
|
98 (interactive)
|
|
99 (let ((line-prompt
|
23331
|
100 (substitute-command-keys ,help-line)))
|
5679
|
101 (if three-step-help
|
14316
|
102 (message "%s" line-prompt))
|
23331
|
103 (let* ((help-screen (documentation (quote ,doc-fn)))
|
8242
|
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))
|
5640
|
108 (minor-mode-map-alist nil)
|
8260
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
109 (prev-frame (selected-frame))
|
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
110 config new-frame key char)
|
23331
|
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)))
|
3128
|
115 (unwind-protect
|
|
116 (progn
|
23331
|
117 (setcdr local-map ,helped-map)
|
8242
|
118 (define-key local-map [t] 'undefined)
|
20029
|
119 ;; Make the scroll bar keep working normally.
|
|
120 (define-key local-map [vertical-scroll-bar]
|
|
121 (lookup-key global-map [vertical-scroll-bar]))
|
5679
|
122 (if three-step-help
|
11424
29493ce2d1ca
(make-help-screen): Explicitly translate key thru function-key-map.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
123 (progn
|
29493ce2d1ca
(make-help-screen): Explicitly translate key thru function-key-map.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
124 (setq key (let ((overriding-local-map local-map))
|
59521
|
125 (read-key-sequence nil)))
|
11424
29493ce2d1ca
(make-help-screen): Explicitly translate key thru function-key-map.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
126 ;; Make the HELP key translate to C-h.
|
29493ce2d1ca
(make-help-screen): Explicitly translate key thru function-key-map.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
127 (if (lookup-key function-key-map key)
|
29493ce2d1ca
(make-help-screen): Explicitly translate key thru function-key-map.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
128 (setq key (lookup-key function-key-map key)))
|
29493ce2d1ca
(make-help-screen): Explicitly translate key thru function-key-map.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
129 (setq char (aref key 0)))
|
5679
|
130 (setq char ??))
|
12423
|
131 (if (or (eq char ??) (eq char help-char)
|
|
132 (memq char help-event-list))
|
3128
|
133 (progn
|
|
134 (setq config (current-window-configuration))
|
|
135 (switch-to-buffer-other-window "*Help*")
|
8661
7615ef8778de
(make-help-screen): Don't call window-frame in a non-multi-frame Emacs.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
136 (and (fboundp 'make-frame)
|
7615ef8778de
(make-help-screen): Don't call window-frame in a non-multi-frame Emacs.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
137 (not (eq (window-frame (selected-window))
|
7615ef8778de
(make-help-screen): Don't call window-frame in a non-multi-frame Emacs.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
138 prev-frame))
|
7615ef8778de
(make-help-screen): Don't call window-frame in a non-multi-frame Emacs.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
139 (setq new-frame (window-frame (selected-window))
|
7615ef8778de
(make-help-screen): Don't call window-frame in a non-multi-frame Emacs.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
140 config nil))
|
18449
|
141 (setq buffer-read-only nil)
|
3128
|
142 (erase-buffer)
|
5378
|
143 (insert help-screen)
|
9855
|
144 (help-mode)
|
3128
|
145 (goto-char (point-min))
|
12423
|
146 (while (or (memq char (append help-event-list
|
49838
|
147 (cons help-char '(?? ?\C-v ?\s ?\177 delete backspace vertical-scroll-bar ?\M-v))))
|
8260
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
148 (eq (car-safe char) 'switch-frame)
|
5640
|
149 (equal key "\M-v"))
|
5378
|
150 (condition-case nil
|
|
151 (progn
|
8260
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
152 (if (eq (car-safe char) 'switch-frame)
|
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
153 (handle-switch-frame char))
|
5378
|
154 (if (memq char '(?\C-v ?\ ))
|
|
155 (scroll-up))
|
12423
|
156 (if (or (memq char '(?\177 ?\M-v
|
|
157 delete backspace))
|
5640
|
158 (equal key "\M-v"))
|
5378
|
159 (scroll-down)))
|
|
160 (error nil))
|
8242
|
161 (let ((cursor-in-echo-area t)
|
|
162 (overriding-local-map local-map))
|
5679
|
163 (setq key (read-key-sequence
|
|
164 (format "Type one of the options listed%s: "
|
|
165 (if (pos-visible-in-window-p
|
|
166 (point-max))
|
21120
|
167 "" ", or SPACE or DEL to scroll")))
|
20029
|
168 char (aref key 0)))
|
|
169
|
|
170 ;; If this is a scroll bar command, just run it.
|
|
171 (when (eq char 'vertical-scroll-bar)
|
|
172 (command-execute (lookup-key local-map key) nil key)))))
|
18656
52a3dec2b6cc
(make-help-screen): Clear the prompt when we get a real command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
173 ;; We don't need the prompt any more.
|
52a3dec2b6cc
(make-help-screen): Clear the prompt when we get a real command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
174 (message "")
|
5378
|
175 ;; Mouse clicks are not part of the help feature,
|
|
176 ;; so reexecute them in the standard environment.
|
|
177 (if (listp char)
|
|
178 (setq unread-command-events
|
|
179 (cons char unread-command-events)
|
|
180 config nil)
|
10477
|
181 (let ((defn (lookup-key local-map key)))
|
5378
|
182 (if defn
|
|
183 (progn
|
|
184 (if config
|
|
185 (progn
|
|
186 (set-window-configuration config)
|
|
187 (setq config nil)))
|
8260
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
188 (if new-frame
|
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
189 (progn (iconify-frame new-frame)
|
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
190 (setq new-frame nil)))
|
5378
|
191 (call-interactively defn))
|
3128
|
192 (ding)))))
|
8260
1ad35b4d9128
(make-help-screen): Handle case where *Help* comes up in a separate frame.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
193 (if new-frame (iconify-frame new-frame))
|
3128
|
194 (if config
|
|
195 (set-window-configuration config))))))
|
23331
|
196 )))
|
2456
|
197
|
25298
|
198 (provide 'help-macro)
|
2456
|
199
|
52401
|
200 ;;; arch-tag: 59fee949-1686-485a-8a05-83418073e257
|
25298
|
201 ;;; help-macro.el ends here
|