Mercurial > emacs
annotate lisp/help-macro.el @ 6150:c1dde384f0dd
(shell-mode-map): Use copy-keymap.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 02 Mar 1994 16:51:02 +0000 |
parents | 81290a55365b |
children | 4fd40bd394fe |
rev | line source |
---|---|
2530
1e1a30d5d523
Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2456
diff
changeset
|
1 ;;; help-macro.el --- Makes command line help such as help-for-help |
2456 | 2 |
3 ;; Copyright (C) 1993 Free Software Foundation, Inc. | |
4 | |
5 ;; Author: Lynn Slater <lrs@indetech.com> | |
6 ;; Created: : Mon Oct 1 11:42:39 1990 | |
7 ;; Adapted-By: ESR | |
8 ;; Last Modified By: Lynn Slater x2048 | |
9 ;; Last Modified On: Mon Sep 23 14:40:19 1991 | |
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 | |
24 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, 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 | |
2530
1e1a30d5d523
Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2456
diff
changeset
|
35 ;; The name of this package was changed from help-screen.el to |
1e1a30d5d523
Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2456
diff
changeset
|
36 ;; help-macro.el in order to fit in a 14-character limit. |
1e1a30d5d523
Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2456
diff
changeset
|
37 |
2456 | 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 | |
2696
479c78c63f89
Provide help-macro, not help-screen.
Richard M. Stallman <rms@gnu.org>
parents:
2530
diff
changeset
|
71 (provide 'help-macro) |
2456 | 72 (require 'backquote) |
73 | |
5679
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
74 ;;;###autoload |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
75 (defvar three-step-help nil |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
76 "*Non-nil means give more info about Help command in three steps. |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
77 The three steps are simple prompt, prompt with all options, |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
78 and window listing and describing the options. |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
79 A value of nil means skip the middle step, so that |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
80 \\[help-command] \\[help-command] gives the window that lists the options.") |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
81 |
2456 | 82 (defmacro make-help-screen (fname help-line help-text helped-map) |
5378
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
83 "Construct help-menu function name FNAME. |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
84 When invoked, FNAME shows HELP-LINE and reads a command using HELPED-MAP. |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
85 If the command is the help character is requested, FNAME displays HELP-TEXT |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
86 and continues trying to read a command using HELPED-MAP. |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
87 When FNAME finally does get a command, it executes that command |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
88 and then returns." |
2456 | 89 (` (defun (, fname) () |
90 (, help-text) | |
91 (interactive) | |
92 (let ((line-prompt | |
5640
f0f285e628d0
(make-help-screen): Use overriding-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
5378
diff
changeset
|
93 (substitute-command-keys (, help-line)))) |
5679
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
94 (if three-step-help |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
95 (message line-prompt)) |
6078
81290a55365b
(make-help-screen): Initialize help-screen before changing the keymap.
Karl Heuer <kwzh@gnu.org>
parents:
5741
diff
changeset
|
96 (let* ((help-screen (documentation (quote (, fname)))) |
81290a55365b
(make-help-screen): Initialize help-screen before changing the keymap.
Karl Heuer <kwzh@gnu.org>
parents:
5741
diff
changeset
|
97 (overriding-local-map (make-sparse-keymap)) |
5640
f0f285e628d0
(make-help-screen): Use overriding-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
5378
diff
changeset
|
98 (minor-mode-map-alist nil) |
6078
81290a55365b
(make-help-screen): Initialize help-screen before changing the keymap.
Karl Heuer <kwzh@gnu.org>
parents:
5741
diff
changeset
|
99 config key char) |
3128
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
100 (unwind-protect |
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
101 (progn |
5640
f0f285e628d0
(make-help-screen): Use overriding-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
5378
diff
changeset
|
102 (setcdr overriding-local-map (, helped-map)) |
f0f285e628d0
(make-help-screen): Use overriding-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
5378
diff
changeset
|
103 (define-key overriding-local-map [t] 'undefined) |
5679
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
104 (if three-step-help |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
105 (setq key (read-key-sequence nil) |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
106 char (aref key 0)) |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
107 (setq char ??)) |
3128
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
108 (if (or (eq char ??) (eq char help-char)) |
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
109 (progn |
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
110 (setq config (current-window-configuration)) |
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
111 (switch-to-buffer-other-window "*Help*") |
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
112 (erase-buffer) |
5378
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
113 (insert help-screen) |
3128
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
114 (goto-char (point-min)) |
5679
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
115 (while (or (memq char (cons help-char '(?? ?\C-v ?\ ?\177 delete ?\M-v))) |
5640
f0f285e628d0
(make-help-screen): Use overriding-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
5378
diff
changeset
|
116 (equal key "\M-v")) |
5378
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
117 (condition-case nil |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
118 (progn |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
119 (if (memq char '(?\C-v ?\ )) |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
120 (scroll-up)) |
5679
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
121 (if (or (memq char '(?\177 ?\M-v delete)) |
5640
f0f285e628d0
(make-help-screen): Use overriding-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
5378
diff
changeset
|
122 (equal key "\M-v")) |
5378
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
123 (scroll-down))) |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
124 (error nil)) |
3128
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
125 (let ((cursor-in-echo-area t)) |
5679
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
126 (setq key (read-key-sequence |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
127 (format "Type one of the options listed%s: " |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
128 (if (pos-visible-in-window-p |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
129 (point-max)) |
90ba98c692b5
(three-step-help): New option.
Richard M. Stallman <rms@gnu.org>
parents:
5640
diff
changeset
|
130 "" " or Space to scroll"))) |
5741
ea9f55ec6ee9
(make-help-screen): Remove debugging code.
Karl Heuer <kwzh@gnu.org>
parents:
5679
diff
changeset
|
131 char (aref key 0)))))) |
5378
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
132 ;; Mouse clicks are not part of the help feature, |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
133 ;; so reexecute them in the standard environment. |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
134 (if (listp char) |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
135 (setq unread-command-events |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
136 (cons char unread-command-events) |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
137 config nil) |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
138 (let ((defn (key-binding key))) |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
139 (if defn |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
140 (progn |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
141 (if config |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
142 (progn |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
143 (set-window-configuration config) |
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
144 (setq config nil))) |
5640
f0f285e628d0
(make-help-screen): Use overriding-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
5378
diff
changeset
|
145 (setq overriding-local-map nil) |
5378
32a291ab0c5f
(make-help-screen): Use read-key-sequence.
Richard M. Stallman <rms@gnu.org>
parents:
3128
diff
changeset
|
146 (call-interactively defn)) |
3128
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
147 (ding))))) |
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
148 (if config |
2417a8dc0f14
(make-help-screen): Handle mouse events.
Richard M. Stallman <rms@gnu.org>
parents:
2696
diff
changeset
|
149 (set-window-configuration config)))))) |
2456 | 150 )) |
151 | |
2530
1e1a30d5d523
Name changed to fit in a 14-character limit.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2456
diff
changeset
|
152 ;;; help-macro.el |
2456 | 153 |