Commit | Line | Data |
---|---|---|
1a06eabd ER |
1 | ;;; help.el --- help commands for Emacs |
2 | ||
f03b7c7d | 3 | ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002 |
754084bb | 4 | ;; Free Software Foundation, Inc. |
3a801d0c | 5 | |
e5167999 | 6 | ;; Maintainer: FSF |
fd7fa35a | 7 | ;; Keywords: help, internal |
e5167999 | 8 | |
433ae6f6 RS |
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 | |
e5167999 | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
433ae6f6 RS |
14 | ;; 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 | |
b578f267 EN |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
433ae6f6 | 25 | |
d9ecc911 ER |
26 | ;;; Commentary: |
27 | ||
a1c9f209 | 28 | ;; This code implements GNU Emacs' on-line help system, the one invoked by |
95ac0a6f | 29 | ;; `M-x help-for-help'. |
d9ecc911 | 30 | |
e5167999 ER |
31 | ;;; Code: |
32 | ||
8aa3a187 RS |
33 | ;; Get the macro make-help-screen when this is compiled, |
34 | ;; or run interpreted, but not when the compiled code is loaded. | |
b1fe9304 | 35 | (eval-when-compile (require 'help-macro)) |
788d62cf MB |
36 | |
37 | ;; This makes `with-output-to-temp-buffer' buffers use `help-mode'. | |
38 | (add-hook 'temp-buffer-setup-hook 'help-mode-setup) | |
39 | (add-hook 'temp-buffer-show-hook 'help-mode-finish) | |
41b8542b | 40 | |
433ae6f6 RS |
41 | (defvar help-map (make-sparse-keymap) |
42 | "Keymap for characters following the Help key.") | |
43 | ||
e17d2fd1 | 44 | (define-key global-map (char-to-string help-char) 'help-command) |
0af3df1c RS |
45 | (define-key global-map [help] 'help-command) |
46 | (define-key global-map [f1] 'help-command) | |
433ae6f6 RS |
47 | (fset 'help-command help-map) |
48 | ||
e17d2fd1 | 49 | (define-key help-map (char-to-string help-char) 'help-for-help) |
0af3df1c RS |
50 | (define-key help-map [help] 'help-for-help) |
51 | (define-key help-map [f1] 'help-for-help) | |
433ae6f6 RS |
52 | (define-key help-map "?" 'help-for-help) |
53 | ||
54 | (define-key help-map "\C-c" 'describe-copying) | |
55 | (define-key help-map "\C-d" 'describe-distribution) | |
4f16ea85 RS |
56 | (define-key help-map "\C-e" 'view-emacs-problems) |
57 | (define-key help-map "\C-f" 'view-emacs-FAQ) | |
4f16ea85 RS |
58 | (define-key help-map "\C-m" 'view-order-manuals) |
59 | (define-key help-map "\C-n" 'view-emacs-news) | |
76766f2d | 60 | (define-key help-map "\C-p" 'describe-project) |
1ebc1f01 | 61 | (define-key help-map "\C-t" 'view-todo) |
4f16ea85 RS |
62 | (define-key help-map "\C-w" 'describe-no-warranty) |
63 | ||
64 | ;; This does not fit the pattern, but it is natural given the C-\ command. | |
65 | (define-key help-map "\C-\\" 'describe-input-method) | |
66 | ||
67 | (define-key help-map "C" 'describe-coding-system) | |
68 | (define-key help-map "F" 'Info-goto-emacs-command-node) | |
69 | (define-key help-map "I" 'describe-input-method) | |
70 | (define-key help-map "K" 'Info-goto-emacs-key-command-node) | |
71 | (define-key help-map "L" 'describe-language-environment) | |
72 | (define-key help-map "S" 'info-lookup-symbol) | |
73 | ||
122955bf | 74 | (define-key help-map "a" 'apropos-command) |
433ae6f6 RS |
75 | |
76 | (define-key help-map "b" 'describe-bindings) | |
77 | ||
78 | (define-key help-map "c" 'describe-key-briefly) | |
433ae6f6 | 79 | |
4f16ea85 RS |
80 | (define-key help-map "e" 'view-echo-area-messages) |
81 | ||
433ae6f6 RS |
82 | (define-key help-map "f" 'describe-function) |
83 | ||
4f16ea85 | 84 | (define-key help-map "h" 'view-hello-file) |
7ee71cf1 | 85 | |
433ae6f6 | 86 | (define-key help-map "i" 'info) |
4b08b7ed | 87 | (define-key help-map "4i" 'info-other-window) |
4f16ea85 RS |
88 | |
89 | (define-key help-map "k" 'describe-key) | |
433ae6f6 RS |
90 | |
91 | (define-key help-map "l" 'view-lossage) | |
92 | ||
93 | (define-key help-map "m" 'describe-mode) | |
94 | ||
433ae6f6 RS |
95 | (define-key help-map "n" 'view-emacs-news) |
96 | ||
06b98c51 | 97 | (define-key help-map "p" 'finder-by-keyword) |
3e9c095d RS |
98 | (autoload 'finder-by-keyword "finder" |
99 | "Find packages matching a given keyword." t) | |
06b98c51 | 100 | |
d009b6e9 RS |
101 | (define-key help-map "r" 'info-emacs-manual) |
102 | ||
433ae6f6 RS |
103 | (define-key help-map "s" 'describe-syntax) |
104 | ||
105 | (define-key help-map "t" 'help-with-tutorial) | |
106 | ||
107 | (define-key help-map "w" 'where-is) | |
108 | ||
109 | (define-key help-map "v" 'describe-variable) | |
110 | ||
2fc9d9f4 RS |
111 | (define-key help-map "q" 'help-quit) |
112 | ||
0cf0d828 | 113 | \f |
2fc9d9f4 | 114 | (defun help-quit () |
3120a677 | 115 | "Just exit from the Help command's command loop." |
2fc9d9f4 RS |
116 | (interactive) |
117 | nil) | |
118 | ||
01364a75 RS |
119 | (defvar help-return-method nil |
120 | "What to do to \"exit\" the help buffer. | |
121 | This is a list | |
122 | (WINDOW . t) delete the selected window, go to WINDOW. | |
123 | (WINDOW . quit-window) do quit-window, then select WINDOW. | |
124 | (WINDOW BUF START POINT) display BUF at START, POINT, then select WINDOW.") | |
125 | ||
433ae6f6 RS |
126 | (defun print-help-return-message (&optional function) |
127 | "Display or return message saying how to restore windows after help command. | |
d009b6e9 RS |
128 | This function assumes that `standard-output' is the help buffer. |
129 | It computes a message, and applies the optional argument FUNCTION to it. | |
130 | If FUNCTION is nil, it applies `message', thus displaying the message." | |
433ae6f6 | 131 | (and (not (get-buffer-window standard-output)) |
d536293f | 132 | (let ((first-message |
a1c9f209 | 133 | (cond ((special-display-p (buffer-name standard-output)) |
01364a75 | 134 | (setq help-return-method (cons (selected-window) t)) |
d536293f RS |
135 | ;; If the help output buffer is a special display buffer, |
136 | ;; don't say anything about how to get rid of it. | |
137 | ;; First of all, the user will do that with the window | |
138 | ;; manager, not with Emacs. | |
139 | ;; Secondly, the buffer has not been displayed yet, | |
140 | ;; so we don't know whether its frame will be selected. | |
d536293f | 141 | nil) |
f3ad2fc8 GM |
142 | (display-buffer-reuse-frames |
143 | (setq help-return-method (cons (selected-window) | |
144 | 'quit-window)) | |
145 | nil) | |
d536293f | 146 | ((not (one-window-p t)) |
01364a75 RS |
147 | (setq help-return-method |
148 | (cons (selected-window) 'quit-window)) | |
d536293f RS |
149 | "Type \\[switch-to-buffer-other-window] RET to restore the other window.") |
150 | (pop-up-windows | |
01364a75 | 151 | (setq help-return-method (cons (selected-window) t)) |
d536293f RS |
152 | "Type \\[delete-other-windows] to remove help window.") |
153 | (t | |
01364a75 RS |
154 | (setq help-return-method |
155 | (list (selected-window) (window-buffer) | |
156 | (window-start) (window-point))) | |
d536293f RS |
157 | "Type \\[switch-to-buffer] RET to remove help window.")))) |
158 | (funcall (or function 'message) | |
159 | (concat | |
160 | (if first-message | |
376b2a24 DL |
161 | (substitute-command-keys first-message)) |
162 | (if first-message " ") | |
125a8d70 RS |
163 | ;; If the help buffer will go in a separate frame, |
164 | ;; it's no use mentioning a command to scroll, so don't. | |
a1c9f209 | 165 | (if (special-display-p (buffer-name standard-output)) |
125a8d70 | 166 | nil |
a1c9f209 | 167 | (if (same-window-p (buffer-name standard-output)) |
125a8d70 RS |
168 | ;; Say how to scroll this window. |
169 | (substitute-command-keys | |
170 | "\\[scroll-up] to scroll the help.") | |
171 | ;; Say how to scroll some other window. | |
6e7f5182 | 172 | (substitute-command-keys |
125a8d70 | 173 | "\\[scroll-other-window] to scroll the help.")))))))) |
433ae6f6 | 174 | |
433ae6f6 RS |
175 | ;; So keyboard macro definitions are documented correctly |
176 | (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
177 | ||
788d62cf MB |
178 | (defalias 'help 'help-for-help) |
179 | (make-help-screen help-for-help | |
1ebc1f01 | 180 | "a b c C e f F i I k C-k l L m p s t v w C-c C-d C-f C-n C-p C-t C-w or ? :" |
788d62cf MB |
181 | "You have typed %THIS-KEY%, the help character. Type a Help option: |
182 | \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.) | |
183 | ||
184 | a command-apropos. Give a substring, and see a list of commands | |
185 | (functions interactively callable) that contain | |
186 | that substring. See also the apropos command. | |
187 | b describe-bindings. Display table of all key bindings. | |
188 | c describe-key-briefly. Type a command key sequence; | |
189 | it prints the function name that sequence runs. | |
190 | C describe-coding-system. This describes either a specific coding system | |
191 | (if you type its name) or the coding systems currently in use | |
192 | (if you type just RET). | |
4f16ea85 | 193 | e view-echo-area-messages. Show the `*Messages*' buffer. |
788d62cf | 194 | f describe-function. Type a function name and get documentation of it. |
4f16ea85 | 195 | F Info-goto-emacs-command-node. Type a function name; |
788d62cf | 196 | it takes you to the Info node for that command. |
54391990 | 197 | h Display the HELLO file which illustrates various scripts. |
788d62cf MB |
198 | i info. The info documentation reader. |
199 | I describe-input-method. Describe a specific input method (if you type | |
200 | its name) or the current input method (if you type just RET). | |
788d62cf MB |
201 | k describe-key. Type a command key sequence; |
202 | it displays the full documentation. | |
4f16ea85 | 203 | K Info-goto-emacs-key-command-node. Type a command key sequence; |
788d62cf MB |
204 | it takes you to the Info node for the command bound to that key. |
205 | l view-lossage. Show last 100 characters you typed. | |
206 | L describe-language-environment. This describes either a | |
207 | specific language environment (if you type its name) | |
208 | or the current language environment (if you type just RET). | |
209 | m describe-mode. Print documentation of current minor modes, | |
210 | and the current major mode, including their special commands. | |
788d62cf MB |
211 | p finder-by-keyword. Find packages matching a given topic keyword. |
212 | s describe-syntax. Display contents of syntax table, plus explanations. | |
4f16ea85 RS |
213 | S info-lookup-symbol. Display the definition of a specific symbol |
214 | as found in the manual for the language this buffer is written in. | |
788d62cf MB |
215 | t help-with-tutorial. Select the Emacs learn-by-doing tutorial. |
216 | v describe-variable. Type name of a variable; | |
217 | it displays the variable's documentation and value. | |
218 | w where-is. Type command name; it prints which keystrokes | |
219 | invoke that command. | |
220 | ||
4f16ea85 | 221 | C-c Display Emacs copying permission (GNU General Public License). |
788d62cf | 222 | C-d Display Emacs ordering information. |
4f16ea85 RS |
223 | C-e Display info about Emacs problems. |
224 | C-f Display the Emacs FAQ. | |
4f16ea85 | 225 | C-m Display how to order printed Emacs manuals. |
788d62cf MB |
226 | C-n Display news of recent Emacs changes. |
227 | C-p Display information about the GNU project. | |
1ebc1f01 | 228 | C-t Display the Emacs TODO list. |
788d62cf MB |
229 | C-w Display information on absence of warranty for GNU Emacs." |
230 | help-map) | |
231 | ||
232 | \f | |
233 | ||
234 | (defun function-called-at-point () | |
235 | "Return a function around point or else called by the list containing point. | |
236 | If that doesn't give a function, return nil." | |
237 | (with-syntax-table emacs-lisp-mode-syntax-table | |
238 | (or (condition-case () | |
239 | (save-excursion | |
240 | (or (not (zerop (skip-syntax-backward "_w"))) | |
241 | (eq (char-syntax (following-char)) ?w) | |
242 | (eq (char-syntax (following-char)) ?_) | |
243 | (forward-sexp -1)) | |
244 | (skip-chars-forward "'") | |
245 | (let ((obj (read (current-buffer)))) | |
246 | (and (symbolp obj) (fboundp obj) obj))) | |
247 | (error nil)) | |
248 | (condition-case () | |
249 | (save-excursion | |
250 | (save-restriction | |
251 | (narrow-to-region (max (point-min) | |
252 | (- (point) 1000)) (point-max)) | |
253 | ;; Move up to surrounding paren, then after the open. | |
254 | (backward-up-list 1) | |
255 | (forward-char 1) | |
256 | ;; If there is space here, this is probably something | |
257 | ;; other than a real Lisp function call, so ignore it. | |
258 | (if (looking-at "[ \t]") | |
259 | (error "Probably not a Lisp function call")) | |
260 | (let ((obj (read (current-buffer)))) | |
261 | (and (symbolp obj) (fboundp obj) obj)))) | |
262 | (error nil))))) | |
263 | ||
264 | \f | |
265 | ;;; `User' help functions | |
266 | ||
433ae6f6 RS |
267 | (defun describe-distribution () |
268 | "Display info on how to obtain the latest version of GNU Emacs." | |
269 | (interactive) | |
9e0e631c | 270 | (view-file (expand-file-name "DISTRIB" data-directory))) |
433ae6f6 RS |
271 | |
272 | (defun describe-copying () | |
273 | "Display info on how you may redistribute copies of GNU Emacs." | |
274 | (interactive) | |
64f3b7d3 | 275 | (view-file (expand-file-name "COPYING" data-directory)) |
433ae6f6 RS |
276 | (goto-char (point-min))) |
277 | ||
76766f2d RS |
278 | (defun describe-project () |
279 | "Display info on the GNU project." | |
280 | (interactive) | |
64f3b7d3 | 281 | (view-file (expand-file-name "THE-GNU-PROJECT" data-directory)) |
76766f2d RS |
282 | (goto-char (point-min))) |
283 | ||
433ae6f6 RS |
284 | (defun describe-no-warranty () |
285 | "Display info on all the kinds of warranty Emacs does NOT have." | |
286 | (interactive) | |
287 | (describe-copying) | |
288 | (let (case-fold-search) | |
289 | (search-forward "NO WARRANTY") | |
290 | (recenter 0))) | |
291 | ||
61c6b658 | 292 | (defun describe-prefix-bindings () |
c7cba9cb RS |
293 | "Describe the bindings of the prefix used to reach this command. |
294 | The prefix described consists of all but the last event | |
295 | of the key sequence that ran this command." | |
61c6b658 | 296 | (interactive) |
ccc06dcc KH |
297 | (let* ((key (this-command-keys))) |
298 | (describe-bindings | |
299 | (if (stringp key) | |
300 | (substring key 0 (1- (length key))) | |
301 | (let ((prefix (make-vector (1- (length key)) nil)) | |
302 | (i 0)) | |
303 | (while (< i (length prefix)) | |
304 | (aset prefix i (aref key i)) | |
305 | (setq i (1+ i))) | |
306 | prefix))))) | |
788d62cf | 307 | ;; Make C-h after a prefix, when not specifically bound, |
c7cba9cb | 308 | ;; run describe-prefix-bindings. |
61c6b658 RS |
309 | (setq prefix-help-command 'describe-prefix-bindings) |
310 | ||
382d018a RS |
311 | (defun view-emacs-news (&optional arg) |
312 | "Display info on recent changes to Emacs. | |
f0753a5f | 313 | With numeric argument, display information on correspondingly older changes." |
382d018a | 314 | (interactive "P") |
f0753a5f GM |
315 | (let* ((arg (if arg (prefix-numeric-value arg) 0)) |
316 | (file (cond ((eq arg 0) "NEWS") | |
317 | ((eq arg 1) "ONEWS") | |
318 | (t | |
319 | (nth (- arg 2) | |
320 | (nreverse (directory-files data-directory | |
975f82c9 | 321 | nil "^ONEWS\\.[0-9]+$" |
f0753a5f GM |
322 | nil))))))) |
323 | (if file | |
64f3b7d3 | 324 | (view-file (expand-file-name file data-directory)) |
f0753a5f | 325 | (error "No such old news")))) |
433ae6f6 | 326 | |
1ebc1f01 RS |
327 | (defun view-todo (&optional arg) |
328 | "Display the Emacs TODO list." | |
329 | (interactive "P") | |
330 | (view-file (expand-file-name "TODO" data-directory))) | |
331 | ||
4f16ea85 RS |
332 | (defun view-echo-area-messages () |
333 | "View the log of recent echo-area messages: the `*Messages*' buffer. | |
334 | The number of messages retained in that buffer | |
335 | is specified by the variable `message-log-max'." | |
336 | (interactive) | |
337 | (switch-to-buffer (get-buffer-create "*Messages*"))) | |
338 | ||
754084bb GM |
339 | (defun view-order-manuals () |
340 | "Display the Emacs ORDERS file." | |
341 | (interactive) | |
64f3b7d3 | 342 | (view-file (expand-file-name "ORDERS" data-directory)) |
38790755 | 343 | (goto-address)) |
754084bb | 344 | |
7ee71cf1 RS |
345 | (defun view-emacs-FAQ () |
346 | "Display the Emacs Frequently Asked Questions (FAQ) file." | |
347 | (interactive) | |
94ea540b | 348 | ;; (find-file-read-only (expand-file-name "FAQ" data-directory)) |
279b772d | 349 | (info "(efaq)")) |
7ee71cf1 | 350 | |
4cbff657 DL |
351 | (defun view-emacs-problems () |
352 | "Display info on known problems with Emacs and possible workarounds." | |
353 | (interactive) | |
354 | (view-file (expand-file-name "PROBLEMS" data-directory))) | |
355 | ||
433ae6f6 | 356 | (defun view-lossage () |
50b57199 EZ |
357 | "Display last 100 input keystrokes. |
358 | ||
359 | To record all your input on a file, use `open-dribble-file'." | |
433ae6f6 | 360 | (interactive) |
3e5929af SM |
361 | (help-setup-xref (list #'view-lossage) (interactive-p)) |
362 | (with-output-to-temp-buffer (help-buffer) | |
02dfca16 SM |
363 | (princ (mapconcat (lambda (key) |
364 | (if (or (integerp key) (symbolp key) (listp key)) | |
365 | (single-key-description key) | |
366 | (prin1-to-string key nil))) | |
298a7c8c RS |
367 | (recent-keys) |
368 | " ")) | |
b0fbf754 | 369 | (with-current-buffer standard-output |
433ae6f6 RS |
370 | (goto-char (point-min)) |
371 | (while (progn (move-to-column 50) (not (eobp))) | |
372 | (search-forward " " nil t) | |
3e5929af | 373 | (insert "\n"))) |
433ae6f6 RS |
374 | (print-help-return-message))) |
375 | ||
788d62cf MB |
376 | \f |
377 | ;; Key bindings | |
433ae6f6 | 378 | |
4c45295b | 379 | (defun describe-bindings (&optional prefix buffer) |
a8ad43aa RS |
380 | "Show a list of all defined keys, and their definitions. |
381 | We put that list in a buffer, and display the buffer. | |
382 | ||
383 | The optional argument PREFIX, if non-nil, should be a key sequence; | |
4c45295b KH |
384 | then we display only bindings that start with that prefix. |
385 | The optional argument BUFFER specifies which buffer's bindings | |
386 | to display (default, the current buffer)." | |
3e5929af | 387 | (interactive) |
4c45295b | 388 | (or buffer (setq buffer (current-buffer))) |
3e5929af | 389 | (help-setup-xref (list #'describe-bindings prefix buffer) (interactive-p)) |
4c45295b | 390 | (with-current-buffer buffer |
3e5929af | 391 | (describe-bindings-internal nil prefix))) |
a8ad43aa | 392 | |
94ea540b SM |
393 | ;; This function used to be in keymap.c. |
394 | (defun describe-bindings-internal (&optional menus prefix) | |
395 | "Show a list of all defined keys, and their definitions. | |
396 | We put that list in a buffer, and display the buffer. | |
397 | ||
398 | The optional argument MENUS, if non-nil, says to mention menu bindings. | |
399 | \(Ordinarily these are omitted from the output.) | |
400 | The optional argument PREFIX, if non-nil, should be a key sequence; | |
401 | then we display only bindings that start with that prefix." | |
402 | (interactive) | |
403 | (let ((buf (current-buffer))) | |
404 | (with-output-to-temp-buffer "*Help*" | |
405 | (with-current-buffer standard-output | |
406 | (describe-buffer-bindings buf prefix menus))))) | |
407 | ||
e88a2c59 | 408 | (defun where-is (definition &optional insert) |
b2c85790 | 409 | "Print message listing key sequences that invoke the command DEFINITION. |
e88a2c59 RS |
410 | Argument is a command definition, usually a symbol with a function definition. |
411 | If INSERT (the prefix arg) is non-nil, insert the message in the buffer." | |
54c0b967 RS |
412 | (interactive |
413 | (let ((fn (function-called-at-point)) | |
788d62cf | 414 | (enable-recursive-minibuffers t) |
54c0b967 RS |
415 | val) |
416 | (setq val (completing-read (if fn | |
417 | (format "Where is command (default %s): " fn) | |
418 | "Where is command: ") | |
d5f65532 | 419 | obarray 'commandp t)) |
54c0b967 | 420 | (list (if (equal val "") |
e88a2c59 RS |
421 | fn (intern val)) |
422 | current-prefix-arg))) | |
7a698dc1 JB |
423 | (let ((func (indirect-function definition)) |
424 | (map nil) | |
425 | (standard-output (if insert (current-buffer) t))) | |
426 | (mapatoms #'(lambda (symbol) | |
427 | (when (and (not (eq symbol definition)) | |
428 | (fboundp symbol) | |
429 | (eq func (indirect-function symbol))) | |
430 | (setq map (cons symbol map))))) | |
431 | (princ (mapconcat | |
432 | #'(lambda (symbol) | |
433 | (let* ((remapped (remap-command symbol)) | |
434 | (keys (mapconcat 'key-description | |
435 | (where-is-internal symbol | |
436 | overriding-local-map | |
437 | nil nil | |
438 | remapped) | |
439 | ", "))) | |
440 | (if insert | |
441 | (if (> (length keys) 0) | |
442 | (if remapped | |
443 | (format "%s (%s) (remapped from %s)" | |
444 | keys remapped symbol) | |
445 | (format "%s (%s)" keys symbol)) | |
446 | (format "M-x %s RET" symbol)) | |
447 | (if (> (length keys) 0) | |
448 | (if remapped | |
449 | (format "%s is remapped to %s which is on %s" | |
450 | definition symbol keys) | |
451 | (format "%s is on %s" symbol keys)) | |
452 | (format "%s is not on any key" symbol))))) | |
453 | (cons definition map) | |
454 | ";\nand "))) | |
54c0b967 RS |
455 | nil) |
456 | ||
788d62cf MB |
457 | (defun string-key-binding (key) |
458 | "Value is the binding of KEY in a string. | |
459 | If KEY is an event on a string, and that string has a `local-map' | |
460 | or `keymap' property, return the binding of KEY in the string's keymap." | |
461 | (let* ((defn nil) | |
462 | (start (when (vectorp key) | |
f03b7c7d GM |
463 | (if (memq (aref key 0) |
464 | '(mode-line header-line left-margin right-margin)) | |
788d62cf MB |
465 | (event-start (aref key 1)) |
466 | (and (consp (aref key 0)) | |
467 | (event-start (aref key 0)))))) | |
468 | (string-info (and (consp start) (nth 4 start)))) | |
469 | (when string-info | |
470 | (let* ((string (car string-info)) | |
471 | (pos (cdr string-info)) | |
f03b7c7d | 472 | (local-map (and (>= pos 0) |
788d62cf MB |
473 | (< pos (length string)) |
474 | (or (get-text-property pos 'local-map string) | |
475 | (get-text-property pos 'keymap string))))) | |
476 | (setq defn (and local-map (lookup-key local-map key))))) | |
477 | defn)) | |
1a06eabd | 478 | |
02dfca16 SM |
479 | (defun help-key-description (key untranslated) |
480 | (let ((string (key-description key))) | |
ae1bb8ac SM |
481 | (if (or (not untranslated) |
482 | (and (eq (aref untranslated 0) ?\e) (not (eq (aref key 0) ?\e)))) | |
02dfca16 SM |
483 | string |
484 | (let ((otherstring (key-description untranslated))) | |
485 | (if (equal string otherstring) | |
486 | string | |
487 | (format "%s (translated from %s)" string otherstring)))))) | |
488 | ||
489 | (defun describe-key-briefly (key &optional insert untranslated) | |
788d62cf | 490 | "Print the name of the function KEY invokes. KEY is a string. |
02dfca16 SM |
491 | If INSERT (the prefix arg) is non-nil, insert the message in the buffer. |
492 | If non-nil UNTRANSLATED is a vector of the untranslated events. | |
493 | It can also be a number in which case the untranslated events from | |
494 | the last key hit are used." | |
495 | (interactive "kDescribe key briefly: \nP\np") | |
496 | (if (numberp untranslated) | |
497 | (setq untranslated (this-single-command-raw-keys))) | |
400a1b1f | 498 | (save-excursion |
788d62cf MB |
499 | (let ((modifiers (event-modifiers (aref key 0))) |
500 | (standard-output (if insert (current-buffer) t)) | |
501 | window position) | |
502 | ;; For a mouse button event, go to the button it applies to | |
503 | ;; to get the right key bindings. And go to the right place | |
504 | ;; in case the keymap depends on where you clicked. | |
505 | (if (or (memq 'click modifiers) (memq 'down modifiers) | |
506 | (memq 'drag modifiers)) | |
507 | (setq window (posn-window (event-start (aref key 0))) | |
508 | position (posn-point (event-start (aref key 0))))) | |
509 | (if (windowp window) | |
510 | (progn | |
511 | (set-buffer (window-buffer window)) | |
512 | (goto-char position))) | |
513 | ;; Ok, now look up the key and name the command. | |
514 | (let ((defn (or (string-key-binding key) | |
515 | (key-binding key))) | |
02dfca16 | 516 | (key-desc (help-key-description key untranslated))) |
d61ac4a6 | 517 | (if (or (null defn) (integerp defn) (equal defn 'undefined)) |
788d62cf | 518 | (princ (format "%s is undefined" key-desc)) |
80d553d4 RS |
519 | (princ (format (if (windowp window) |
520 | "%s at that spot runs the command %s" | |
521 | "%s runs the command %s") | |
788d62cf MB |
522 | key-desc |
523 | (if (symbolp defn) defn (prin1-to-string defn))))))))) | |
96ede6b2 | 524 | |
788d62cf | 525 | |
02dfca16 | 526 | (defun describe-key (key &optional untranslated) |
a0d32c10 RS |
527 | "Display documentation of the function invoked by KEY. |
528 | KEY should be a key sequence--when calling from a program, | |
02dfca16 SM |
529 | pass a string or a vector. |
530 | If non-nil UNTRANSLATED is a vector of the untranslated events. | |
531 | It can also be a number in which case the untranslated events from | |
532 | the last key hit are used." | |
533 | (interactive "kDescribe key: \np") | |
534 | (if (numberp untranslated) | |
535 | (setq untranslated (this-single-command-raw-keys))) | |
788d62cf MB |
536 | (save-excursion |
537 | (let ((modifiers (event-modifiers (aref key 0))) | |
538 | window position) | |
539 | ;; For a mouse button event, go to the button it applies to | |
540 | ;; to get the right key bindings. And go to the right place | |
541 | ;; in case the keymap depends on where you clicked. | |
542 | (if (or (memq 'click modifiers) (memq 'down modifiers) | |
543 | (memq 'drag modifiers)) | |
544 | (setq window (posn-window (event-start (aref key 0))) | |
545 | position (posn-point (event-start (aref key 0))))) | |
94ea540b | 546 | (when (windowp window) |
788d62cf | 547 | (set-buffer (window-buffer window)) |
94ea540b | 548 | (goto-char position)) |
788d62cf | 549 | (let ((defn (or (string-key-binding key) (key-binding key)))) |
d61ac4a6 | 550 | (if (or (null defn) (integerp defn) (equal defn 'undefined)) |
02dfca16 | 551 | (message "%s is undefined" (help-key-description key untranslated)) |
3e5929af SM |
552 | (help-setup-xref (list #'describe-function defn) (interactive-p)) |
553 | (with-output-to-temp-buffer (help-buffer) | |
02dfca16 | 554 | (princ (help-key-description key untranslated)) |
788d62cf MB |
555 | (if (windowp window) |
556 | (princ " at that spot")) | |
557 | (princ " runs the command ") | |
558 | (prin1 defn) | |
559 | (princ "\n which is ") | |
3e5929af | 560 | (describe-function-1 defn) |
788d62cf | 561 | (print-help-return-message))))))) |
400a1b1f | 562 | |
400a1b1f | 563 | \f |
788d62cf MB |
564 | (defun describe-mode (&optional buffer) |
565 | "Display documentation of current major mode and minor modes. | |
566 | The major mode description comes first, followed by the minor modes, | |
567 | each on a separate page. | |
568 | For this to work correctly for a minor mode, the mode's indicator variable | |
569 | \(listed in `minor-mode-alist') must also be a function whose documentation | |
570 | describes the minor mode." | |
400a1b1f | 571 | (interactive) |
9639be74 RS |
572 | (help-setup-xref (list #'describe-mode (or buffer (current-buffer))) |
573 | (interactive-p)) | |
574 | ;; For the sake of help-do-xref and help-xref-go-back, | |
575 | ;; don't switch buffers before calling `help-buffer'. | |
3e5929af | 576 | (with-output-to-temp-buffer (help-buffer) |
9639be74 RS |
577 | (save-excursion |
578 | (when buffer (set-buffer buffer)) | |
579 | (when minor-mode-alist | |
580 | (princ "The major mode is described first. | |
788d62cf | 581 | For minor modes, see following pages.\n\n")) |
9639be74 RS |
582 | (princ mode-name) |
583 | (princ " mode:\n") | |
584 | (princ (documentation major-mode)) | |
585 | (let ((minor-modes minor-mode-alist)) | |
586 | (while minor-modes | |
587 | (let* ((minor-mode (car (car minor-modes))) | |
588 | (indicator (car (cdr (car minor-modes))))) | |
589 | ;; Document a minor mode if it is listed in minor-mode-alist, | |
590 | ;; bound locally in this buffer, non-nil, and has a function | |
591 | ;; definition. | |
592 | (if (and (boundp minor-mode) | |
593 | (symbol-value minor-mode) | |
594 | (fboundp minor-mode)) | |
595 | (let ((pretty-minor-mode minor-mode)) | |
596 | (if (string-match "\\(-minor\\)?-mode\\'" | |
597 | (symbol-name minor-mode)) | |
598 | (setq pretty-minor-mode | |
599 | (capitalize | |
600 | (substring (symbol-name minor-mode) | |
601 | 0 (match-beginning 0))))) | |
602 | (while (and indicator (symbolp indicator) | |
603 | (boundp indicator) | |
604 | (not (eq indicator (symbol-value indicator)))) | |
605 | (setq indicator (symbol-value indicator))) | |
606 | (princ "\n\f\n") | |
607 | (princ (format "%s minor mode (%s):\n" | |
608 | pretty-minor-mode | |
609 | (if indicator | |
610 | (format "indicator%s" indicator) | |
611 | "no indicator"))) | |
612 | (princ (documentation minor-mode))))) | |
613 | (setq minor-modes (cdr minor-modes)))) | |
614 | (print-help-return-message)))) | |
400a1b1f | 615 | |
48ce3c22 RS |
616 | \f |
617 | ;;; Automatic resizing of temporary buffers. | |
618 | ||
4483ddc5 | 619 | (defcustom temp-buffer-max-height (lambda (buffer) (/ (- (frame-height) 2) 2)) |
48ce3c22 RS |
620 | "*Maximum height of a window displaying a temporary buffer. |
621 | This is the maximum height (in text lines) which `resize-temp-buffer-window' | |
622 | will give to a window displaying a temporary buffer. | |
623 | It can also be a function which will be called with the object corresponding | |
624 | to the buffer to be displayed as argument and should return an integer | |
625 | positive number." | |
626 | :type '(choice integer function) | |
627 | :group 'help | |
628 | :version "20.4") | |
629 | ||
4e1ede6c SM |
630 | (define-minor-mode temp-buffer-resize-mode |
631 | "Toggle the mode which makes windows smaller for temporary buffers. | |
48ce3c22 RS |
632 | With prefix argument ARG, turn the resizing of windows displaying temporary |
633 | buffers on if ARG is positive or off otherwise. | |
4e1ede6c SM |
634 | This makes the window the right height for its contents, but never |
635 | more than `temp-buffer-max-height' nor less than `window-min-height'. | |
636 | This applies to `help', `apropos' and `completion' buffers, and some others." | |
b0fbf754 | 637 | :global t :group 'help |
4e1ede6c | 638 | (if temp-buffer-resize-mode |
57f43907 | 639 | ;; `help-make-xrefs' may add a `back' button and thus increase the |
4e1ede6c SM |
640 | ;; text size, so `resize-temp-buffer-window' must be run *after* it. |
641 | (add-hook 'temp-buffer-show-hook 'resize-temp-buffer-window 'append) | |
8304a3bb | 642 | (remove-hook 'temp-buffer-show-hook 'resize-temp-buffer-window))) |
48ce3c22 RS |
643 | |
644 | (defun resize-temp-buffer-window () | |
645 | "Resize the current window to fit its contents. | |
4483ddc5 | 646 | Will not make it higher than `temp-buffer-max-height' nor smaller than |
b2c85790 | 647 | `window-min-height'. Do nothing if it is the only window on its frame, if it |
48ce3c22 RS |
648 | is not as wide as the frame or if some of the window's contents are scrolled |
649 | out of view." | |
650 | (unless (or (one-window-p 'nomini) | |
651 | (not (pos-visible-in-window-p (point-min))) | |
652 | (/= (frame-width) (window-width))) | |
d9c30bdf MB |
653 | (fit-window-to-buffer |
654 | (selected-window) | |
655 | (if (functionp temp-buffer-max-height) | |
656 | (funcall temp-buffer-max-height (current-buffer)) | |
657 | temp-buffer-max-height)))) | |
48ce3c22 | 658 | |
5fbeea74 GM |
659 | ;; Provide this for the sake of define-minor-mode which generates |
660 | ;; defcustoms which require 'help'. | |
5fbeea74 GM |
661 | (provide 'help) |
662 | ||
1a06eabd | 663 | ;;; help.el ends here |