Commit | Line | Data |
---|---|---|
1a06eabd ER |
1 | ;;; help.el --- help commands for Emacs |
2 | ||
0d30b337 | 3 | ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002, |
aaef169d | 4 | ;; 2003, 2004, 2005, 2006 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 | 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, 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 | |
604aa5f0 SM |
41 | (defvar help-map |
42 | (let ((map (make-sparse-keymap))) | |
43 | (define-key map (char-to-string help-char) 'help-for-help) | |
44 | (define-key map [help] 'help-for-help) | |
45 | (define-key map [f1] 'help-for-help) | |
46 | (define-key map "." 'display-local-help) | |
47 | (define-key map "?" 'help-for-help) | |
48 | ||
49 | (define-key map "\C-c" 'describe-copying) | |
50 | (define-key map "\C-d" 'describe-distribution) | |
51 | (define-key map "\C-e" 'view-emacs-problems) | |
52 | (define-key map "\C-f" 'view-emacs-FAQ) | |
53 | (define-key map "\C-m" 'view-order-manuals) | |
54 | (define-key map "\C-n" 'view-emacs-news) | |
55 | (define-key map "\C-p" 'describe-project) | |
56 | (define-key map "\C-t" 'view-todo) | |
57 | (define-key map "\C-w" 'describe-no-warranty) | |
58 | ||
59 | ;; This does not fit the pattern, but it is natural given the C-\ command. | |
60 | (define-key map "\C-\\" 'describe-input-method) | |
61 | ||
62 | (define-key map "C" 'describe-coding-system) | |
63 | (define-key map "F" 'Info-goto-emacs-command-node) | |
64 | (define-key map "I" 'describe-input-method) | |
65 | (define-key map "K" 'Info-goto-emacs-key-command-node) | |
66 | (define-key map "L" 'describe-language-environment) | |
67 | (define-key map "S" 'info-lookup-symbol) | |
68 | ||
69 | (define-key map "a" 'apropos-command) | |
70 | (define-key map "b" 'describe-bindings) | |
71 | (define-key map "c" 'describe-key-briefly) | |
72 | (define-key map "d" 'apropos-documentation) | |
73 | (define-key map "e" 'view-echo-area-messages) | |
74 | (define-key map "f" 'describe-function) | |
75 | (define-key map "h" 'view-hello-file) | |
76 | ||
77 | (define-key map "i" 'info) | |
78 | (define-key map "4i" 'info-other-window) | |
79 | ||
80 | (define-key map "k" 'describe-key) | |
81 | (define-key map "l" 'view-lossage) | |
82 | (define-key map "m" 'describe-mode) | |
83 | (define-key map "n" 'view-emacs-news) | |
84 | (define-key map "p" 'finder-by-keyword) | |
85 | (define-key map "r" 'info-emacs-manual) | |
86 | (define-key map "s" 'describe-syntax) | |
87 | (define-key map "t" 'help-with-tutorial) | |
88 | (define-key map "w" 'where-is) | |
89 | (define-key map "v" 'describe-variable) | |
90 | (define-key map "q" 'help-quit) | |
91 | map) | |
433ae6f6 RS |
92 | "Keymap for characters following the Help key.") |
93 | ||
e17d2fd1 | 94 | (define-key global-map (char-to-string help-char) 'help-command) |
0af3df1c RS |
95 | (define-key global-map [help] 'help-command) |
96 | (define-key global-map [f1] 'help-command) | |
433ae6f6 RS |
97 | (fset 'help-command help-map) |
98 | ||
3e9c095d RS |
99 | (autoload 'finder-by-keyword "finder" |
100 | "Find packages matching a given keyword." t) | |
06b98c51 | 101 | |
e25e90b4 DP |
102 | ;; insert-button makes the action nil if it is not store somewhere |
103 | (defvar help-button-cache nil) | |
104 | ||
0cf0d828 | 105 | \f |
2fc9d9f4 | 106 | (defun help-quit () |
3120a677 | 107 | "Just exit from the Help command's command loop." |
2fc9d9f4 RS |
108 | (interactive) |
109 | nil) | |
110 | ||
01364a75 RS |
111 | (defvar help-return-method nil |
112 | "What to do to \"exit\" the help buffer. | |
113 | This is a list | |
a8e7142c EZ |
114 | (WINDOW . t) delete the selected window (and possibly its frame, |
115 | see `quit-window' and `View-quit'), go to WINDOW. | |
01364a75 RS |
116 | (WINDOW . quit-window) do quit-window, then select WINDOW. |
117 | (WINDOW BUF START POINT) display BUF at START, POINT, then select WINDOW.") | |
118 | ||
433ae6f6 RS |
119 | (defun print-help-return-message (&optional function) |
120 | "Display or return message saying how to restore windows after help command. | |
d009b6e9 RS |
121 | This function assumes that `standard-output' is the help buffer. |
122 | It computes a message, and applies the optional argument FUNCTION to it. | |
a8e7142c EZ |
123 | If FUNCTION is nil, it applies `message', thus displaying the message. |
124 | In addition, this function sets up `help-return-method', which see, that | |
125 | specifies what to do when the user exits the help buffer." | |
433ae6f6 | 126 | (and (not (get-buffer-window standard-output)) |
d536293f | 127 | (let ((first-message |
a8e7142c EZ |
128 | (cond ((or |
129 | pop-up-frames | |
130 | (special-display-p (buffer-name standard-output))) | |
01364a75 | 131 | (setq help-return-method (cons (selected-window) t)) |
d536293f RS |
132 | ;; If the help output buffer is a special display buffer, |
133 | ;; don't say anything about how to get rid of it. | |
134 | ;; First of all, the user will do that with the window | |
135 | ;; manager, not with Emacs. | |
136 | ;; Secondly, the buffer has not been displayed yet, | |
137 | ;; so we don't know whether its frame will be selected. | |
d536293f | 138 | nil) |
f3ad2fc8 GM |
139 | (display-buffer-reuse-frames |
140 | (setq help-return-method (cons (selected-window) | |
141 | 'quit-window)) | |
142 | nil) | |
d536293f | 143 | ((not (one-window-p t)) |
01364a75 RS |
144 | (setq help-return-method |
145 | (cons (selected-window) 'quit-window)) | |
d536293f RS |
146 | "Type \\[switch-to-buffer-other-window] RET to restore the other window.") |
147 | (pop-up-windows | |
01364a75 | 148 | (setq help-return-method (cons (selected-window) t)) |
d536293f RS |
149 | "Type \\[delete-other-windows] to remove help window.") |
150 | (t | |
01364a75 RS |
151 | (setq help-return-method |
152 | (list (selected-window) (window-buffer) | |
153 | (window-start) (window-point))) | |
d536293f RS |
154 | "Type \\[switch-to-buffer] RET to remove help window.")))) |
155 | (funcall (or function 'message) | |
156 | (concat | |
157 | (if first-message | |
376b2a24 DL |
158 | (substitute-command-keys first-message)) |
159 | (if first-message " ") | |
125a8d70 RS |
160 | ;; If the help buffer will go in a separate frame, |
161 | ;; it's no use mentioning a command to scroll, so don't. | |
7b057a3d EZ |
162 | (if (or pop-up-windows |
163 | (special-display-p (buffer-name standard-output))) | |
125a8d70 | 164 | nil |
a1c9f209 | 165 | (if (same-window-p (buffer-name standard-output)) |
125a8d70 RS |
166 | ;; Say how to scroll this window. |
167 | (substitute-command-keys | |
168 | "\\[scroll-up] to scroll the help.") | |
169 | ;; Say how to scroll some other window. | |
6e7f5182 | 170 | (substitute-command-keys |
125a8d70 | 171 | "\\[scroll-other-window] to scroll the help.")))))))) |
433ae6f6 | 172 | |
433ae6f6 RS |
173 | ;; So keyboard macro definitions are documented correctly |
174 | (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
175 | ||
a4bdcdf3 RS |
176 | (defalias 'help 'help-for-help-internal) |
177 | ;; find-function can find this. | |
178 | (defalias 'help-for-help 'help-for-help-internal) | |
179 | ;; It can't find this, but nobody will look. | |
180 | (make-help-screen help-for-help-internal | |
d50d22f1 | 181 | "a b c C e f F i I k C-k l L m p r s t v w C-c C-d C-f C-n C-p C-t C-w . or ? :" |
788d62cf MB |
182 | "You have typed %THIS-KEY%, the help character. Type a Help option: |
183 | \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.) | |
184 | ||
7e1b6c2c | 185 | a command-apropos. Give a list of words or a regexp, to get a list of |
c6f20f15 | 186 | commands whose names match. See also the apropos command. |
788d62cf MB |
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). | |
ccf849af KS |
193 | d apropos-documentation. Give a pattern (a list or words or a regexp), and |
194 | see a list of functions, variables, and other items whose built-in | |
195 | doucmentation string matches that pattern. See also the apropos command. | |
3ee341ec EZ |
196 | e view-echo-area-messages. Show the buffer where the echo-area messages |
197 | are stored. | |
198 | f describe-function. Type a function name and get its documentation. | |
4f16ea85 | 199 | F Info-goto-emacs-command-node. Type a function name; |
3ee341ec EZ |
200 | it takes you to the on-line manual's section that describes |
201 | the command. | |
54391990 | 202 | h Display the HELLO file which illustrates various scripts. |
3ee341ec | 203 | i info. The Info documentation reader: read on-line manuals. |
788d62cf MB |
204 | I describe-input-method. Describe a specific input method (if you type |
205 | its name) or the current input method (if you type just RET). | |
788d62cf | 206 | k describe-key. Type a command key sequence; |
3ee341ec | 207 | it displays the full documentation for that key sequence. |
4f16ea85 | 208 | K Info-goto-emacs-key-command-node. Type a command key sequence; |
3ee341ec EZ |
209 | it takes you to the on-line manual's section that describes |
210 | the command bound to that key. | |
788d62cf MB |
211 | l view-lossage. Show last 100 characters you typed. |
212 | L describe-language-environment. This describes either a | |
213 | specific language environment (if you type its name) | |
214 | or the current language environment (if you type just RET). | |
3ee341ec | 215 | m describe-mode. Display documentation of current minor modes, |
788d62cf | 216 | and the current major mode, including their special commands. |
3ee341ec | 217 | n view-emacs-news. Display news of recent Emacs changes. |
788d62cf | 218 | p finder-by-keyword. Find packages matching a given topic keyword. |
d50d22f1 | 219 | r info-emacs-manual. Display the Emacs manual in Info mode. |
788d62cf | 220 | s describe-syntax. Display contents of syntax table, plus explanations. |
4f16ea85 RS |
221 | S info-lookup-symbol. Display the definition of a specific symbol |
222 | as found in the manual for the language this buffer is written in. | |
788d62cf MB |
223 | t help-with-tutorial. Select the Emacs learn-by-doing tutorial. |
224 | v describe-variable. Type name of a variable; | |
225 | it displays the variable's documentation and value. | |
226 | w where-is. Type command name; it prints which keystrokes | |
227 | invoke that command. | |
7ada28ac LT |
228 | . display-local-help. Display any available local help at point |
229 | in the echo area. | |
788d62cf | 230 | |
4f16ea85 | 231 | C-c Display Emacs copying permission (GNU General Public License). |
788d62cf | 232 | C-d Display Emacs ordering information. |
4f16ea85 RS |
233 | C-e Display info about Emacs problems. |
234 | C-f Display the Emacs FAQ. | |
4f16ea85 | 235 | C-m Display how to order printed Emacs manuals. |
788d62cf MB |
236 | C-n Display news of recent Emacs changes. |
237 | C-p Display information about the GNU project. | |
1ebc1f01 | 238 | C-t Display the Emacs TODO list. |
788d62cf MB |
239 | C-w Display information on absence of warranty for GNU Emacs." |
240 | help-map) | |
241 | ||
242 | \f | |
243 | ||
244 | (defun function-called-at-point () | |
245 | "Return a function around point or else called by the list containing point. | |
246 | If that doesn't give a function, return nil." | |
542e904c JL |
247 | (or (with-syntax-table emacs-lisp-mode-syntax-table |
248 | (or (condition-case () | |
249 | (save-excursion | |
250 | (or (not (zerop (skip-syntax-backward "_w"))) | |
251 | (eq (char-syntax (following-char)) ?w) | |
252 | (eq (char-syntax (following-char)) ?_) | |
253 | (forward-sexp -1)) | |
254 | (skip-chars-forward "'") | |
255 | (let ((obj (read (current-buffer)))) | |
256 | (and (symbolp obj) (fboundp obj) obj))) | |
257 | (error nil)) | |
258 | (condition-case () | |
259 | (save-excursion | |
260 | (save-restriction | |
261 | (narrow-to-region (max (point-min) | |
262 | (- (point) 1000)) (point-max)) | |
263 | ;; Move up to surrounding paren, then after the open. | |
264 | (backward-up-list 1) | |
265 | (forward-char 1) | |
266 | ;; If there is space here, this is probably something | |
267 | ;; other than a real Lisp function call, so ignore it. | |
268 | (if (looking-at "[ \t]") | |
269 | (error "Probably not a Lisp function call")) | |
270 | (let ((obj (read (current-buffer)))) | |
271 | (and (symbolp obj) (fboundp obj) obj)))) | |
272 | (error nil)))) | |
273 | (let* ((str (find-tag-default)) | |
918f2e56 JL |
274 | (sym (if str (intern-soft str)))) |
275 | (if (and sym (fboundp sym)) | |
276 | sym | |
277 | (save-match-data | |
278 | (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str)) | |
279 | (setq sym (intern-soft (match-string 1 str))) | |
280 | (and (fboundp sym) sym))))))) | |
788d62cf MB |
281 | |
282 | \f | |
283 | ;;; `User' help functions | |
284 | ||
433ae6f6 RS |
285 | (defun describe-distribution () |
286 | "Display info on how to obtain the latest version of GNU Emacs." | |
287 | (interactive) | |
9e0e631c | 288 | (view-file (expand-file-name "DISTRIB" data-directory))) |
433ae6f6 RS |
289 | |
290 | (defun describe-copying () | |
291 | "Display info on how you may redistribute copies of GNU Emacs." | |
292 | (interactive) | |
64f3b7d3 | 293 | (view-file (expand-file-name "COPYING" data-directory)) |
433ae6f6 RS |
294 | (goto-char (point-min))) |
295 | ||
76766f2d RS |
296 | (defun describe-project () |
297 | "Display info on the GNU project." | |
298 | (interactive) | |
64f3b7d3 | 299 | (view-file (expand-file-name "THE-GNU-PROJECT" data-directory)) |
76766f2d RS |
300 | (goto-char (point-min))) |
301 | ||
433ae6f6 RS |
302 | (defun describe-no-warranty () |
303 | "Display info on all the kinds of warranty Emacs does NOT have." | |
304 | (interactive) | |
305 | (describe-copying) | |
306 | (let (case-fold-search) | |
307 | (search-forward "NO WARRANTY") | |
308 | (recenter 0))) | |
309 | ||
61c6b658 | 310 | (defun describe-prefix-bindings () |
c7cba9cb RS |
311 | "Describe the bindings of the prefix used to reach this command. |
312 | The prefix described consists of all but the last event | |
313 | of the key sequence that ran this command." | |
61c6b658 | 314 | (interactive) |
ccc06dcc KH |
315 | (let* ((key (this-command-keys))) |
316 | (describe-bindings | |
317 | (if (stringp key) | |
318 | (substring key 0 (1- (length key))) | |
319 | (let ((prefix (make-vector (1- (length key)) nil)) | |
320 | (i 0)) | |
321 | (while (< i (length prefix)) | |
322 | (aset prefix i (aref key i)) | |
323 | (setq i (1+ i))) | |
324 | prefix))))) | |
788d62cf | 325 | ;; Make C-h after a prefix, when not specifically bound, |
c7cba9cb | 326 | ;; run describe-prefix-bindings. |
61c6b658 RS |
327 | (setq prefix-help-command 'describe-prefix-bindings) |
328 | ||
382d018a RS |
329 | (defun view-emacs-news (&optional arg) |
330 | "Display info on recent changes to Emacs. | |
598ea453 | 331 | With argument, display info only for the selected version." |
382d018a | 332 | (interactive "P") |
598ea453 JL |
333 | (if (not arg) |
334 | (view-file (expand-file-name "NEWS" data-directory)) | |
335 | (let* ((map (sort | |
336 | (delete-dups | |
337 | (apply | |
338 | 'nconc | |
339 | (mapcar | |
340 | (lambda (file) | |
341 | (with-temp-buffer | |
342 | (insert-file-contents | |
343 | (expand-file-name file data-directory)) | |
344 | (let (res) | |
345 | (while (re-search-forward | |
346 | (if (string-match "^ONEWS\\.[0-9]+$" file) | |
347 | "Changes in \\(?:Emacs\\|version\\)?[ \t]*\\([0-9]+\\(?:\\.[0-9]+\\)?\\)" | |
348 | "^\* [^0-9\n]*\\([0-9]+\\.[0-9]+\\)") nil t) | |
349 | (setq res (cons (list (match-string-no-properties 1) | |
350 | file) res))) | |
351 | res))) | |
352 | (append '("NEWS" "ONEWS") | |
353 | (directory-files data-directory nil | |
354 | "^ONEWS\\.[0-9]+$" nil))))) | |
355 | (lambda (a b) | |
356 | (string< (car b) (car a))))) | |
357 | (current (caar map)) | |
358 | (version (completing-read | |
359 | (format "Read NEWS for the version (default %s): " current) | |
360 | (mapcar 'car map) nil nil nil nil current)) | |
361 | (file (cadr (assoc version map))) | |
362 | res) | |
363 | (if (not file) | |
364 | (error "No news is good news") | |
365 | (view-file (expand-file-name file data-directory)) | |
366 | (widen) | |
367 | (goto-char (point-min)) | |
368 | (when (re-search-forward | |
369 | (concat (if (string-match "^ONEWS\\.[0-9]+$" file) | |
370 | "Changes in \\(?:Emacs\\|version\\)?[ \t]*" | |
371 | "^\* [^0-9\n]*") version) | |
372 | nil t) | |
373 | (beginning-of-line) | |
374 | (narrow-to-region | |
375 | (point) | |
376 | (save-excursion | |
377 | (while (and (setq res | |
378 | (re-search-forward | |
379 | (if (string-match "^ONEWS\\.[0-9]+$" file) | |
380 | "Changes in \\(?:Emacs\\|version\\)?[ \t]*\\([0-9]+\\(?:\\.[0-9]+\\)?\\)" | |
381 | "^\* [^0-9\n]*\\([0-9]+\\.[0-9]+\\)") nil t)) | |
382 | (equal (match-string-no-properties 1) version))) | |
383 | (or res (goto-char (point-max))) | |
384 | (beginning-of-line) | |
385 | (point)))))))) | |
433ae6f6 | 386 | |
1ebc1f01 RS |
387 | (defun view-todo (&optional arg) |
388 | "Display the Emacs TODO list." | |
389 | (interactive "P") | |
390 | (view-file (expand-file-name "TODO" data-directory))) | |
391 | ||
4f16ea85 RS |
392 | (defun view-echo-area-messages () |
393 | "View the log of recent echo-area messages: the `*Messages*' buffer. | |
394 | The number of messages retained in that buffer | |
395 | is specified by the variable `message-log-max'." | |
396 | (interactive) | |
397 | (switch-to-buffer (get-buffer-create "*Messages*"))) | |
398 | ||
754084bb GM |
399 | (defun view-order-manuals () |
400 | "Display the Emacs ORDERS file." | |
401 | (interactive) | |
64f3b7d3 | 402 | (view-file (expand-file-name "ORDERS" data-directory)) |
38790755 | 403 | (goto-address)) |
754084bb | 404 | |
7ee71cf1 RS |
405 | (defun view-emacs-FAQ () |
406 | "Display the Emacs Frequently Asked Questions (FAQ) file." | |
407 | (interactive) | |
94ea540b | 408 | ;; (find-file-read-only (expand-file-name "FAQ" data-directory)) |
279b772d | 409 | (info "(efaq)")) |
7ee71cf1 | 410 | |
4cbff657 DL |
411 | (defun view-emacs-problems () |
412 | "Display info on known problems with Emacs and possible workarounds." | |
413 | (interactive) | |
414 | (view-file (expand-file-name "PROBLEMS" data-directory))) | |
415 | ||
433ae6f6 | 416 | (defun view-lossage () |
50b57199 EZ |
417 | "Display last 100 input keystrokes. |
418 | ||
419 | To record all your input on a file, use `open-dribble-file'." | |
433ae6f6 | 420 | (interactive) |
3e5929af SM |
421 | (help-setup-xref (list #'view-lossage) (interactive-p)) |
422 | (with-output-to-temp-buffer (help-buffer) | |
02dfca16 SM |
423 | (princ (mapconcat (lambda (key) |
424 | (if (or (integerp key) (symbolp key) (listp key)) | |
425 | (single-key-description key) | |
426 | (prin1-to-string key nil))) | |
298a7c8c RS |
427 | (recent-keys) |
428 | " ")) | |
b0fbf754 | 429 | (with-current-buffer standard-output |
433ae6f6 RS |
430 | (goto-char (point-min)) |
431 | (while (progn (move-to-column 50) (not (eobp))) | |
432 | (search-forward " " nil t) | |
3e5929af | 433 | (insert "\n"))) |
433ae6f6 RS |
434 | (print-help-return-message))) |
435 | ||
788d62cf MB |
436 | \f |
437 | ;; Key bindings | |
433ae6f6 | 438 | |
4c45295b | 439 | (defun describe-bindings (&optional prefix buffer) |
a8ad43aa RS |
440 | "Show a list of all defined keys, and their definitions. |
441 | We put that list in a buffer, and display the buffer. | |
442 | ||
443 | The optional argument PREFIX, if non-nil, should be a key sequence; | |
4c45295b KH |
444 | then we display only bindings that start with that prefix. |
445 | The optional argument BUFFER specifies which buffer's bindings | |
abca4ad7 LT |
446 | to display (default, the current buffer). BUFFER can be a buffer |
447 | or a buffer name." | |
3e5929af | 448 | (interactive) |
4c45295b | 449 | (or buffer (setq buffer (current-buffer))) |
3e5929af | 450 | (help-setup-xref (list #'describe-bindings prefix buffer) (interactive-p)) |
4c45295b | 451 | (with-current-buffer buffer |
3e5929af | 452 | (describe-bindings-internal nil prefix))) |
a8ad43aa | 453 | |
94ea540b SM |
454 | ;; This function used to be in keymap.c. |
455 | (defun describe-bindings-internal (&optional menus prefix) | |
456 | "Show a list of all defined keys, and their definitions. | |
457 | We put that list in a buffer, and display the buffer. | |
458 | ||
459 | The optional argument MENUS, if non-nil, says to mention menu bindings. | |
460 | \(Ordinarily these are omitted from the output.) | |
461 | The optional argument PREFIX, if non-nil, should be a key sequence; | |
462 | then we display only bindings that start with that prefix." | |
463 | (interactive) | |
464 | (let ((buf (current-buffer))) | |
465 | (with-output-to-temp-buffer "*Help*" | |
466 | (with-current-buffer standard-output | |
467 | (describe-buffer-bindings buf prefix menus))))) | |
468 | ||
e88a2c59 | 469 | (defun where-is (definition &optional insert) |
b2c85790 | 470 | "Print message listing key sequences that invoke the command DEFINITION. |
e88a2c59 RS |
471 | Argument is a command definition, usually a symbol with a function definition. |
472 | If INSERT (the prefix arg) is non-nil, insert the message in the buffer." | |
54c0b967 RS |
473 | (interactive |
474 | (let ((fn (function-called-at-point)) | |
788d62cf | 475 | (enable-recursive-minibuffers t) |
54c0b967 | 476 | val) |
3829bcc5 SM |
477 | (setq val (completing-read |
478 | (if fn | |
479 | (format "Where is command (default %s): " fn) | |
480 | "Where is command: ") | |
481 | obarray 'commandp t)) | |
482 | (list (if (equal val "") fn (intern val)) current-prefix-arg))) | |
7a698dc1 | 483 | (let ((func (indirect-function definition)) |
3829bcc5 | 484 | (defs nil) |
7a698dc1 | 485 | (standard-output (if insert (current-buffer) t))) |
740b479c | 486 | ;; In DEFS, find all symbols that are aliases for DEFINITION. |
3829bcc5 SM |
487 | (mapatoms (lambda (symbol) |
488 | (and (fboundp symbol) | |
489 | (not (eq symbol definition)) | |
d92c2757 RS |
490 | (eq func (condition-case () |
491 | (indirect-function symbol) | |
492 | (error symbol))) | |
3829bcc5 | 493 | (push symbol defs)))) |
740b479c RS |
494 | ;; Look at all the symbols--first DEFINITION, |
495 | ;; then its aliases. | |
496 | (dolist (symbol (cons definition defs)) | |
497 | (let* ((remapped (command-remapping symbol)) | |
498 | (keys (where-is-internal | |
499 | symbol overriding-local-map nil nil remapped)) | |
500 | (keys (mapconcat 'key-description keys ", ")) | |
501 | string) | |
502 | (setq string | |
503 | (if insert | |
504 | (if (> (length keys) 0) | |
505 | (if remapped | |
506 | (format "%s (%s) (remapped from %s)" | |
507 | keys remapped symbol) | |
508 | (format "%s (%s)" keys symbol)) | |
509 | (format "M-x %s RET" symbol)) | |
510 | (if (> (length keys) 0) | |
511 | (if remapped | |
512 | (format "%s is remapped to %s which is on %s" | |
a5f43550 | 513 | symbol remapped keys) |
740b479c RS |
514 | (format "%s is on %s" symbol keys)) |
515 | ;; If this is the command the user asked about, | |
516 | ;; and it is not on any key, say so. | |
517 | ;; For other symbols, its aliases, say nothing | |
518 | ;; about them unless they are on keys. | |
519 | (if (eq symbol definition) | |
520 | (format "%s is not on any key" symbol))))) | |
521 | (when string | |
522 | (unless (eq symbol definition) | |
523 | (princ ";\n its alias ")) | |
524 | (princ string))))) | |
54c0b967 RS |
525 | nil) |
526 | ||
788d62cf MB |
527 | (defun string-key-binding (key) |
528 | "Value is the binding of KEY in a string. | |
529 | If KEY is an event on a string, and that string has a `local-map' | |
530 | or `keymap' property, return the binding of KEY in the string's keymap." | |
531 | (let* ((defn nil) | |
532 | (start (when (vectorp key) | |
f03b7c7d GM |
533 | (if (memq (aref key 0) |
534 | '(mode-line header-line left-margin right-margin)) | |
788d62cf MB |
535 | (event-start (aref key 1)) |
536 | (and (consp (aref key 0)) | |
537 | (event-start (aref key 0)))))) | |
538 | (string-info (and (consp start) (nth 4 start)))) | |
539 | (when string-info | |
540 | (let* ((string (car string-info)) | |
541 | (pos (cdr string-info)) | |
f03b7c7d | 542 | (local-map (and (>= pos 0) |
788d62cf MB |
543 | (< pos (length string)) |
544 | (or (get-text-property pos 'local-map string) | |
545 | (get-text-property pos 'keymap string))))) | |
546 | (setq defn (and local-map (lookup-key local-map key))))) | |
547 | defn)) | |
1a06eabd | 548 | |
02dfca16 SM |
549 | (defun help-key-description (key untranslated) |
550 | (let ((string (key-description key))) | |
ae1bb8ac SM |
551 | (if (or (not untranslated) |
552 | (and (eq (aref untranslated 0) ?\e) (not (eq (aref key 0) ?\e)))) | |
02dfca16 SM |
553 | string |
554 | (let ((otherstring (key-description untranslated))) | |
555 | (if (equal string otherstring) | |
556 | string | |
557 | (format "%s (translated from %s)" string otherstring)))))) | |
71296446 | 558 | |
6527c983 EZ |
559 | (defun describe-key-briefly (&optional key insert untranslated) |
560 | "Print the name of the function KEY invokes. KEY is a string. | |
561 | If INSERT (the prefix arg) is non-nil, insert the message in the buffer. | |
562 | If non-nil, UNTRANSLATED is a vector of the untranslated events. | |
563 | It can also be a number in which case the untranslated events from | |
564 | the last key hit are used. | |
565 | ||
566 | If KEY is a menu item or a tool-bar button that is disabled, this command | |
8ee320fc | 567 | temporarily enables it to allow getting help on disabled items and buttons." |
2c8ed538 RS |
568 | (interactive |
569 | (let ((enable-disabled-menus-and-buttons t) | |
570 | (cursor-in-echo-area t) | |
571 | saved-yank-menu) | |
572 | (unwind-protect | |
573 | (let (key) | |
574 | ;; If yank-menu is empty, populate it temporarily, so that | |
575 | ;; "Select and Paste" menu can generate a complete event. | |
576 | (when (null (cdr yank-menu)) | |
577 | (setq saved-yank-menu (copy-sequence yank-menu)) | |
578 | (menu-bar-update-yank-menu "(any string)" nil)) | |
579 | (setq key (read-key-sequence "Describe key (or click or menu item): ")) | |
580 | (list | |
581 | key | |
774a814f RS |
582 | (if current-prefix-arg (prefix-numeric-value current-prefix-arg)) |
583 | 1)) | |
2c8ed538 RS |
584 | ;; Put yank-menu back as it was, if we changed it. |
585 | (when saved-yank-menu | |
586 | (setq yank-menu (copy-sequence saved-yank-menu)) | |
587 | (fset 'yank-menu (cons 'keymap yank-menu)))))) | |
02dfca16 SM |
588 | (if (numberp untranslated) |
589 | (setq untranslated (this-single-command-raw-keys))) | |
400a1b1f | 590 | (save-excursion |
788d62cf MB |
591 | (let ((modifiers (event-modifiers (aref key 0))) |
592 | (standard-output (if insert (current-buffer) t)) | |
593 | window position) | |
594 | ;; For a mouse button event, go to the button it applies to | |
595 | ;; to get the right key bindings. And go to the right place | |
596 | ;; in case the keymap depends on where you clicked. | |
597 | (if (or (memq 'click modifiers) (memq 'down modifiers) | |
598 | (memq 'drag modifiers)) | |
599 | (setq window (posn-window (event-start (aref key 0))) | |
600 | position (posn-point (event-start (aref key 0))))) | |
601 | (if (windowp window) | |
602 | (progn | |
603 | (set-buffer (window-buffer window)) | |
604 | (goto-char position))) | |
605 | ;; Ok, now look up the key and name the command. | |
606 | (let ((defn (or (string-key-binding key) | |
2c30b450 | 607 | (key-binding key t))) |
36178ae8 | 608 | key-desc) |
2c8ed538 RS |
609 | ;; Handle the case where we faked an entry in "Select and Paste" menu. |
610 | (if (and (eq defn nil) | |
611 | (stringp (aref key (1- (length key)))) | |
612 | (eq (key-binding (substring key 0 -1)) 'yank-menu)) | |
613 | (setq defn 'menu-bar-select-yank)) | |
36178ae8 RS |
614 | ;; Don't bother user with strings from (e.g.) the select-paste menu. |
615 | (if (stringp (aref key (1- (length key)))) | |
616 | (aset key (1- (length key)) "(any string)")) | |
59d922a4 LK |
617 | (if (and (> (length untranslated) 0) |
618 | (stringp (aref untranslated (1- (length untranslated))))) | |
36178ae8 RS |
619 | (aset untranslated (1- (length untranslated)) |
620 | "(any string)")) | |
621 | ;; Now describe the key, perhaps as changed. | |
622 | (setq key-desc (help-key-description key untranslated)) | |
d61ac4a6 | 623 | (if (or (null defn) (integerp defn) (equal defn 'undefined)) |
788d62cf | 624 | (princ (format "%s is undefined" key-desc)) |
80d553d4 RS |
625 | (princ (format (if (windowp window) |
626 | "%s at that spot runs the command %s" | |
627 | "%s runs the command %s") | |
788d62cf MB |
628 | key-desc |
629 | (if (symbolp defn) defn (prin1-to-string defn))))))))) | |
96ede6b2 | 630 | |
6527c983 EZ |
631 | (defun describe-key (&optional key untranslated up-event) |
632 | "Display documentation of the function invoked by KEY. | |
633 | KEY can be any kind of a key sequence; it can include keyboard events, | |
634 | mouse events, and/or menu events. When calling from a program, | |
635 | pass KEY as a string or a vector. | |
636 | ||
637 | If non-nil, UNTRANSLATED is a vector of the corresponding untranslated events. | |
638 | It can also be a number, in which case the untranslated events from | |
639 | the last key sequence entered are used. | |
640 | UP-EVENT is the up-event that was discarded by reading KEY, or nil. | |
641 | ||
642 | If KEY is a menu item or a tool-bar button that is disabled, this command | |
8ee320fc | 643 | temporarily enables it to allow getting help on disabled items and buttons." |
2c8ed538 RS |
644 | (interactive |
645 | (let ((enable-disabled-menus-and-buttons t) | |
646 | (cursor-in-echo-area t) | |
647 | saved-yank-menu) | |
648 | (unwind-protect | |
649 | (let (key) | |
650 | ;; If yank-menu is empty, populate it temporarily, so that | |
651 | ;; "Select and Paste" menu can generate a complete event. | |
652 | (when (null (cdr yank-menu)) | |
653 | (setq saved-yank-menu (copy-sequence yank-menu)) | |
654 | (menu-bar-update-yank-menu "(any string)" nil)) | |
655 | (setq key (read-key-sequence "Describe key (or click or menu item): ")) | |
656 | (list | |
657 | key | |
658 | (prefix-numeric-value current-prefix-arg) | |
659 | ;; If KEY is a down-event, read the corresponding up-event | |
660 | ;; and use it as the third argument. | |
661 | (if (and (consp key) (symbolp (car key)) | |
662 | (memq 'down (cdr (get (car key) 'event-symbol-elements)))) | |
663 | (read-event)))) | |
664 | ;; Put yank-menu back as it was, if we changed it. | |
665 | (when saved-yank-menu | |
666 | (setq yank-menu (copy-sequence saved-yank-menu)) | |
667 | (fset 'yank-menu (cons 'keymap yank-menu)))))) | |
02dfca16 SM |
668 | (if (numberp untranslated) |
669 | (setq untranslated (this-single-command-raw-keys))) | |
788d62cf MB |
670 | (save-excursion |
671 | (let ((modifiers (event-modifiers (aref key 0))) | |
672 | window position) | |
673 | ;; For a mouse button event, go to the button it applies to | |
674 | ;; to get the right key bindings. And go to the right place | |
675 | ;; in case the keymap depends on where you clicked. | |
676 | (if (or (memq 'click modifiers) (memq 'down modifiers) | |
677 | (memq 'drag modifiers)) | |
678 | (setq window (posn-window (event-start (aref key 0))) | |
679 | position (posn-point (event-start (aref key 0))))) | |
94ea540b | 680 | (when (windowp window) |
788d62cf | 681 | (set-buffer (window-buffer window)) |
94ea540b | 682 | (goto-char position)) |
2c30b450 | 683 | (let ((defn (or (string-key-binding key) (key-binding key t)))) |
2c8ed538 RS |
684 | ;; Handle the case where we faked an entry in "Select and Paste" menu. |
685 | (if (and (eq defn nil) | |
686 | (stringp (aref key (1- (length key)))) | |
687 | (eq (key-binding (substring key 0 -1)) 'yank-menu)) | |
688 | (setq defn 'menu-bar-select-yank)) | |
d61ac4a6 | 689 | (if (or (null defn) (integerp defn) (equal defn 'undefined)) |
02dfca16 | 690 | (message "%s is undefined" (help-key-description key untranslated)) |
3e5929af | 691 | (help-setup-xref (list #'describe-function defn) (interactive-p)) |
36178ae8 RS |
692 | ;; Don't bother user with strings from (e.g.) the select-paste menu. |
693 | (if (stringp (aref key (1- (length key)))) | |
694 | (aset key (1- (length key)) "(any string)")) | |
ab3fdfd6 RS |
695 | (if (and untranslated |
696 | (stringp (aref untranslated (1- (length untranslated))))) | |
36178ae8 RS |
697 | (aset untranslated (1- (length untranslated)) |
698 | "(any string)")) | |
3e5929af | 699 | (with-output-to-temp-buffer (help-buffer) |
02dfca16 | 700 | (princ (help-key-description key untranslated)) |
788d62cf MB |
701 | (if (windowp window) |
702 | (princ " at that spot")) | |
703 | (princ " runs the command ") | |
704 | (prin1 defn) | |
705 | (princ "\n which is ") | |
3e5929af | 706 | (describe-function-1 defn) |
4cf9f027 | 707 | (when up-event |
72b64ad5 KS |
708 | (let ((ev (aref up-event 0)) |
709 | (descr (key-description up-event)) | |
710 | (hdr "\n\n-------------- up event ---------------\n\n") | |
711 | defn | |
712 | mouse-1-tricky mouse-1-remapped) | |
713 | (when (and (consp ev) | |
714 | (eq (car ev) 'mouse-1) | |
715 | (windowp window) | |
716 | mouse-1-click-follows-link | |
717 | (not (eq mouse-1-click-follows-link 'double)) | |
718 | (with-current-buffer (window-buffer window) | |
719 | (mouse-on-link-p (posn-point (event-start ev))))) | |
720 | (setq mouse-1-tricky (integerp mouse-1-click-follows-link) | |
721 | mouse-1-remapped (or (not mouse-1-tricky) | |
722 | (> mouse-1-click-follows-link 0))) | |
723 | (if mouse-1-remapped | |
724 | (setcar ev 'mouse-2))) | |
725 | (setq defn (or (string-key-binding up-event) (key-binding up-event))) | |
4cf9f027 | 726 | (unless (or (null defn) (integerp defn) (equal defn 'undefined)) |
72b64ad5 KS |
727 | (princ (if mouse-1-tricky |
728 | "\n\n----------------- up-event (short click) ----------------\n\n" | |
729 | hdr)) | |
730 | (setq hdr nil) | |
731 | (princ descr) | |
4cf9f027 KS |
732 | (if (windowp window) |
733 | (princ " at that spot")) | |
72b64ad5 KS |
734 | (if mouse-1-remapped |
735 | (princ " is remapped to <mouse-2>\n which" )) | |
4cf9f027 KS |
736 | (princ " runs the command ") |
737 | (prin1 defn) | |
738 | (princ "\n which is ") | |
72b64ad5 KS |
739 | (describe-function-1 defn)) |
740 | (when mouse-1-tricky | |
741 | (setcar ev | |
742 | (if (> mouse-1-click-follows-link 0) 'mouse-1 'mouse-2)) | |
743 | (setq defn (or (string-key-binding up-event) (key-binding up-event))) | |
744 | (unless (or (null defn) (integerp defn) (equal defn 'undefined)) | |
745 | (princ (or hdr | |
746 | "\n\n----------------- up-event (long click) ----------------\n\n")) | |
747 | (princ "Pressing ") | |
748 | (princ descr) | |
749 | (if (windowp window) | |
750 | (princ " at that spot")) | |
751 | (princ (format " for longer than %d milli-seconds\n" | |
752 | (abs mouse-1-click-follows-link))) | |
753 | (if (not mouse-1-remapped) | |
754 | (princ " remaps it to <mouse-2> which" )) | |
755 | (princ " runs the command ") | |
756 | (prin1 defn) | |
757 | (princ "\n which is ") | |
1b12fa9d RS |
758 | (describe-function-1 defn))))) |
759 | (print-help-return-message))))))) | |
400a1b1f | 760 | |
400a1b1f | 761 | \f |
788d62cf MB |
762 | (defun describe-mode (&optional buffer) |
763 | "Display documentation of current major mode and minor modes. | |
efde809a JPW |
764 | A brief summary of the minor modes comes first, followed by the |
765 | major mode description. This is followed by detailed | |
766 | descriptions of the minor modes, each on a separate page. | |
767 | ||
768 | For this to work correctly for a minor mode, the mode's indicator | |
769 | variable \(listed in `minor-mode-alist') must also be a function | |
770 | whose documentation describes the minor mode." | |
400a1b1f | 771 | (interactive) |
dd39c336 SM |
772 | (unless buffer (setq buffer (current-buffer))) |
773 | (help-setup-xref (list #'describe-mode buffer) | |
9639be74 RS |
774 | (interactive-p)) |
775 | ;; For the sake of help-do-xref and help-xref-go-back, | |
776 | ;; don't switch buffers before calling `help-buffer'. | |
3e5929af | 777 | (with-output-to-temp-buffer (help-buffer) |
dd39c336 | 778 | (with-current-buffer buffer |
f6c57ef6 | 779 | (let (minor-modes) |
dd39c336 SM |
780 | ;; Older packages do not register in minor-mode-list but only in |
781 | ;; minor-mode-alist. | |
782 | (dolist (x minor-mode-alist) | |
783 | (setq x (car x)) | |
784 | (unless (memq x minor-mode-list) | |
785 | (push x minor-mode-list))) | |
f6c57ef6 RS |
786 | ;; Find enabled minor mode we will want to mention. |
787 | (dolist (mode minor-mode-list) | |
788 | ;; Document a minor mode if it is listed in minor-mode-alist, | |
789 | ;; non-nil, and has a function definition. | |
af5f4483 SM |
790 | (let ((fmode (or (get mode :minor-mode-function) mode))) |
791 | (and (boundp mode) (symbol-value mode) | |
792 | (fboundp fmode) | |
793 | (let ((pretty-minor-mode | |
794 | (if (string-match "\\(\\(-minor\\)?-mode\\)?\\'" | |
795 | (symbol-name fmode)) | |
796 | (capitalize | |
797 | (substring (symbol-name fmode) | |
798 | 0 (match-beginning 0))) | |
799 | fmode))) | |
800 | (push (list fmode pretty-minor-mode | |
801 | (format-mode-line (assq mode minor-mode-alist))) | |
802 | minor-modes))))) | |
f6c57ef6 RS |
803 | (setq minor-modes |
804 | (sort minor-modes | |
af5f4483 | 805 | (lambda (a b) (string-lessp (cadr a) (cadr b))))) |
f6c57ef6 RS |
806 | (when minor-modes |
807 | (princ "Summary of minor modes:\n") | |
e25e90b4 DP |
808 | (make-local-variable 'help-button-cache) |
809 | (with-current-buffer standard-output | |
810 | (dolist (mode minor-modes) | |
af5f4483 SM |
811 | (let ((mode-function (nth 0 mode)) |
812 | (pretty-minor-mode (nth 1 mode)) | |
e25e90b4 | 813 | (indicator (nth 2 mode))) |
dd39c336 SM |
814 | (setq indicator (if (zerop (length indicator)) |
815 | "no indicator" | |
816 | (format "indicator%s" indicator))) | |
e25e90b4 DP |
817 | (add-text-properties 0 (length pretty-minor-mode) |
818 | '(face bold) pretty-minor-mode) | |
819 | (save-excursion | |
820 | (goto-char (point-max)) | |
821 | (princ "\n\f\n") | |
822 | (push (point-marker) help-button-cache) | |
823 | ;; Document the minor modes fully. | |
824 | (insert pretty-minor-mode) | |
dd39c336 | 825 | (princ (format " minor mode (%s):\n" indicator)) |
e25e90b4 DP |
826 | (princ (documentation mode-function))) |
827 | (princ " ") | |
828 | (insert-button pretty-minor-mode | |
829 | 'action (car help-button-cache) | |
72b64ad5 | 830 | 'follow-link t |
e25e90b4 | 831 | 'help-echo "mouse-2, RET: show full information") |
dd39c336 | 832 | (princ (format " minor mode (%s):\n" indicator))))) |
f6c57ef6 RS |
833 | (princ "\n(Full information about these minor modes |
834 | follows the description of the major mode.)\n\n")) | |
835 | ;; Document the major mode. | |
e25e90b4 DP |
836 | (let ((mode mode-name)) |
837 | (with-current-buffer standard-output | |
838 | (insert mode) | |
839 | (add-text-properties (- (point) (length mode)) (point) '(face bold)))) | |
f6c57ef6 | 840 | (princ " mode:\n") |
e25e90b4 | 841 | (princ (documentation major-mode))) |
9639be74 | 842 | (print-help-return-message)))) |
400a1b1f | 843 | |
f6c57ef6 | 844 | |
8e864068 | 845 | (defun describe-minor-mode (minor-mode) |
335028c3 MY |
846 | "Display documentation of a minor mode given as MINOR-MODE. |
847 | MINOR-MODE can be a minor mode symbol or a minor mode indicator string | |
848 | appeared on the mode-line." | |
7ada28ac | 849 | (interactive (list (completing-read |
335028c3 MY |
850 | "Minor mode: " |
851 | (nconc | |
852 | (describe-minor-mode-completion-table-for-symbol) | |
853 | (describe-minor-mode-completion-table-for-indicator) | |
854 | )))) | |
855 | (if (symbolp minor-mode) | |
856 | (setq minor-mode (symbol-name minor-mode))) | |
857 | (let ((symbols (describe-minor-mode-completion-table-for-symbol)) | |
858 | (indicators (describe-minor-mode-completion-table-for-indicator))) | |
859 | (cond | |
860 | ((member minor-mode symbols) | |
861 | (describe-minor-mode-from-symbol (intern minor-mode))) | |
862 | ((member minor-mode indicators) | |
863 | (describe-minor-mode-from-indicator minor-mode)) | |
864 | (t | |
865 | (error "No such minor mode: %s" minor-mode))))) | |
866 | ||
7ada28ac | 867 | ;; symbol |
335028c3 MY |
868 | (defun describe-minor-mode-completion-table-for-symbol () |
869 | ;; In order to list up all minor modes, minor-mode-list | |
870 | ;; is used here instead of minor-mode-alist. | |
871 | (delq nil (mapcar 'symbol-name minor-mode-list))) | |
872 | (defun describe-minor-mode-from-symbol (symbol) | |
873 | "Display documentation of a minor mode given as a symbol, SYMBOL" | |
7ada28ac | 874 | (interactive (list (intern (completing-read |
335028c3 MY |
875 | "Minor mode symbol: " |
876 | (describe-minor-mode-completion-table-for-symbol))))) | |
877 | (if (fboundp symbol) | |
878 | (describe-function symbol) | |
879 | (describe-variable symbol))) | |
880 | ||
881 | ;; indicator | |
882 | (defun describe-minor-mode-completion-table-for-indicator () | |
7ada28ac | 883 | (delq nil |
335028c3 MY |
884 | (mapcar (lambda (x) |
885 | (let ((i (format-mode-line x))) | |
886 | ;; remove first space if existed | |
887 | (cond | |
888 | ((= 0 (length i)) | |
889 | nil) | |
890 | ((eq (aref i 0) ?\ ) | |
891 | (substring i 1)) | |
7ada28ac | 892 | (t |
335028c3 MY |
893 | i)))) |
894 | minor-mode-alist))) | |
8e864068 | 895 | (defun describe-minor-mode-from-indicator (indicator) |
335028c3 MY |
896 | "Display documentation of a minor mode specified by INDICATOR. |
897 | If you call this function interactively, you can give indicator which | |
898 | is currently activated with completion." | |
7ada28ac LT |
899 | (interactive (list |
900 | (completing-read | |
8e864068 | 901 | "Minor mode indicator: " |
335028c3 | 902 | (describe-minor-mode-completion-table-for-indicator)))) |
8e864068 JB |
903 | (let ((minor-mode (lookup-minor-mode-from-indicator indicator))) |
904 | (if minor-mode | |
335028c3 | 905 | (describe-minor-mode-from-symbol minor-mode) |
8e864068 JB |
906 | (error "Cannot find minor mode for `%s'" indicator)))) |
907 | ||
908 | (defun lookup-minor-mode-from-indicator (indicator) | |
909 | "Return a minor mode symbol from its indicator on the modeline." | |
335028c3 | 910 | ;; remove first space if existed |
7ada28ac | 911 | (if (and (< 0 (length indicator)) |
335028c3 MY |
912 | (eq (aref indicator 0) ?\ )) |
913 | (setq indicator (substring indicator 1))) | |
8e864068 JB |
914 | (let ((minor-modes minor-mode-alist) |
915 | result) | |
916 | (while minor-modes | |
917 | (let* ((minor-mode (car (car minor-modes))) | |
7ada28ac | 918 | (anindicator (format-mode-line |
335028c3 MY |
919 | (car (cdr (car minor-modes)))))) |
920 | ;; remove first space if existed | |
7ada28ac | 921 | (if (and (stringp anindicator) |
335028c3 MY |
922 | (> (length anindicator) 0) |
923 | (eq (aref anindicator 0) ?\ )) | |
924 | (setq anindicator (substring anindicator 1))) | |
925 | (if (equal indicator anindicator) | |
8e864068 JB |
926 | (setq result minor-mode |
927 | minor-modes nil) | |
928 | (setq minor-modes (cdr minor-modes))))) | |
929 | result)) | |
930 | ||
48ce3c22 RS |
931 | \f |
932 | ;;; Automatic resizing of temporary buffers. | |
933 | ||
4483ddc5 | 934 | (defcustom temp-buffer-max-height (lambda (buffer) (/ (- (frame-height) 2) 2)) |
48ce3c22 RS |
935 | "*Maximum height of a window displaying a temporary buffer. |
936 | This is the maximum height (in text lines) which `resize-temp-buffer-window' | |
937 | will give to a window displaying a temporary buffer. | |
938 | It can also be a function which will be called with the object corresponding | |
939 | to the buffer to be displayed as argument and should return an integer | |
940 | positive number." | |
941 | :type '(choice integer function) | |
942 | :group 'help | |
943 | :version "20.4") | |
944 | ||
4e1ede6c SM |
945 | (define-minor-mode temp-buffer-resize-mode |
946 | "Toggle the mode which makes windows smaller for temporary buffers. | |
48ce3c22 RS |
947 | With prefix argument ARG, turn the resizing of windows displaying temporary |
948 | buffers on if ARG is positive or off otherwise. | |
4e1ede6c SM |
949 | This makes the window the right height for its contents, but never |
950 | more than `temp-buffer-max-height' nor less than `window-min-height'. | |
951 | This applies to `help', `apropos' and `completion' buffers, and some others." | |
b0fbf754 | 952 | :global t :group 'help |
4e1ede6c | 953 | (if temp-buffer-resize-mode |
57f43907 | 954 | ;; `help-make-xrefs' may add a `back' button and thus increase the |
4e1ede6c SM |
955 | ;; text size, so `resize-temp-buffer-window' must be run *after* it. |
956 | (add-hook 'temp-buffer-show-hook 'resize-temp-buffer-window 'append) | |
8304a3bb | 957 | (remove-hook 'temp-buffer-show-hook 'resize-temp-buffer-window))) |
48ce3c22 RS |
958 | |
959 | (defun resize-temp-buffer-window () | |
960 | "Resize the current window to fit its contents. | |
4483ddc5 | 961 | Will not make it higher than `temp-buffer-max-height' nor smaller than |
b2c85790 | 962 | `window-min-height'. Do nothing if it is the only window on its frame, if it |
48ce3c22 RS |
963 | is not as wide as the frame or if some of the window's contents are scrolled |
964 | out of view." | |
965 | (unless (or (one-window-p 'nomini) | |
966 | (not (pos-visible-in-window-p (point-min))) | |
967 | (/= (frame-width) (window-width))) | |
d9c30bdf MB |
968 | (fit-window-to-buffer |
969 | (selected-window) | |
970 | (if (functionp temp-buffer-max-height) | |
971 | (funcall temp-buffer-max-height (current-buffer)) | |
972 | temp-buffer-max-height)))) | |
48ce3c22 | 973 | |
5fbeea74 GM |
974 | ;; Provide this for the sake of define-minor-mode which generates |
975 | ;; defcustoms which require 'help'. | |
5fbeea74 GM |
976 | (provide 'help) |
977 | ||
dd39c336 | 978 | ;; arch-tag: cf427352-27e9-49b7-9a6f-741ebab02423 |
1a06eabd | 979 | ;;; help.el ends here |