help.el 58.9 KB
Newer Older
1
;;; help.el --- help commands for Emacs  -*- lexical-binding:t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1985-1986, 1993-1994, 1998-2020 Free Software
Paul Eggert's avatar
Paul Eggert committed
4
;; Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Maintainer: emacs-devel@gnu.org
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: help, internal
8
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Richard M. Stallman's avatar
Richard M. Stallman committed
10 11
;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

25 26
;;; Commentary:

27
;; This code implements GNU Emacs's built-in help system, the one invoked by
28
;; `M-x help-for-help'.
29

Eric S. Raymond's avatar
Eric S. Raymond committed
30 31
;;; Code:

32 33
;; Get the macro make-help-screen when this is compiled,
;; or run interpreted, but not when the compiled code is loaded.
34
(eval-when-compile (require 'help-macro))
35

36 37 38 39
;; This makes `with-output-to-temp-buffer' buffers use `help-mode'.
(add-hook 'temp-buffer-setup-hook 'help-mode-setup)
(add-hook 'temp-buffer-show-hook 'help-mode-finish)

40 41 42
;; `help-window-point-marker' is a marker you can move to a valid
;; position of the buffer shown in the help window in order to override
;; the standard positioning mechanism (`point-min') chosen by
43 44 45 46
;; `with-output-to-temp-buffer' and `with-temp-buffer-window'.
;; `with-help-window' has this point nowhere before exiting.  Currently
;; used by `view-lossage' to assert that the last keystrokes are always
;; visible.
47
(defvar help-window-point-marker (make-marker)
48
  "Marker to override default `window-point' in help windows.")
49

50 51 52
(defvar help-window-old-frame nil
  "Frame selected at the time `with-help-window' is invoked.")

53 54 55 56 57 58 59 60
(defvar help-map
  (let ((map (make-sparse-keymap)))
    (define-key map (char-to-string help-char) 'help-for-help)
    (define-key map [help] 'help-for-help)
    (define-key map [f1] 'help-for-help)
    (define-key map "." 'display-local-help)
    (define-key map "?" 'help-for-help)

61
    (define-key map "\C-a" 'about-emacs)
62
    (define-key map "\C-c" 'describe-copying)
63 64
    (define-key map "\C-d" 'view-emacs-debugging)
    (define-key map "\C-e" 'view-external-packages)
65 66 67
    (define-key map "\C-f" 'view-emacs-FAQ)
    (define-key map "\C-m" 'view-order-manuals)
    (define-key map "\C-n" 'view-emacs-news)
68 69
    (define-key map "\C-o" 'describe-distribution)
    (define-key map "\C-p" 'view-emacs-problems)
70
    (define-key map "\C-s" 'search-forward-help-for-help)
71
    (define-key map "\C-t" 'view-emacs-todo)
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
    (define-key map "\C-w" 'describe-no-warranty)

    ;; This does not fit the pattern, but it is natural given the C-\ command.
    (define-key map "\C-\\" 'describe-input-method)

    (define-key map "C" 'describe-coding-system)
    (define-key map "F" 'Info-goto-emacs-command-node)
    (define-key map "I" 'describe-input-method)
    (define-key map "K" 'Info-goto-emacs-key-command-node)
    (define-key map "L" 'describe-language-environment)
    (define-key map "S" 'info-lookup-symbol)

    (define-key map "a" 'apropos-command)
    (define-key map "b" 'describe-bindings)
    (define-key map "c" 'describe-key-briefly)
    (define-key map "d" 'apropos-documentation)
    (define-key map "e" 'view-echo-area-messages)
    (define-key map "f" 'describe-function)
90
    (define-key map "g" 'describe-gnu-project)
91 92 93 94 95 96 97 98
    (define-key map "h" 'view-hello-file)

    (define-key map "i" 'info)
    (define-key map "4i" 'info-other-window)

    (define-key map "k" 'describe-key)
    (define-key map "l" 'view-lossage)
    (define-key map "m" 'describe-mode)
99
    (define-key map "o" 'describe-symbol)
100 101
    (define-key map "n" 'view-emacs-news)
    (define-key map "p" 'finder-by-keyword)
102
    (define-key map "P" 'describe-package)
103 104 105 106 107 108 109
    (define-key map "r" 'info-emacs-manual)
    (define-key map "s" 'describe-syntax)
    (define-key map "t" 'help-with-tutorial)
    (define-key map "w" 'where-is)
    (define-key map "v" 'describe-variable)
    (define-key map "q" 'help-quit)
    map)
Richard M. Stallman's avatar
Richard M. Stallman committed
110 111
  "Keymap for characters following the Help key.")

Eric S. Raymond's avatar
Eric S. Raymond committed
112
(define-key global-map (char-to-string help-char) 'help-command)
113 114
(define-key global-map [help] 'help-command)
(define-key global-map [f1] 'help-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
115 116
(fset 'help-command help-map)

117 118 119
;; insert-button makes the action nil if it is not store somewhere
(defvar help-button-cache nil)

120

Richard M. Stallman's avatar
Richard M. Stallman committed
121
(defun help-quit ()
Richard M. Stallman's avatar
Richard M. Stallman committed
122
  "Just exit from the Help command's command loop."
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124 125
  (interactive)
  nil)

126 127 128
(defvar help-return-method nil
  "What to do to \"exit\" the help buffer.
This is a list
129
 (WINDOW . t)              delete the selected window (and possibly its frame,
130
                           see `quit-window'), go to WINDOW.
131 132 133
 (WINDOW . quit-window)    do quit-window, then select WINDOW.
 (WINDOW BUF START POINT)  display BUF at START, POINT, then select WINDOW.")

134 135
(define-obsolete-function-alias 'print-help-return-message 'help-print-return-message "23.2")
(defun help-print-return-message (&optional function)
Richard M. Stallman's avatar
Richard M. Stallman committed
136
  "Display or return message saying how to restore windows after help command.
137 138
This function assumes that `standard-output' is the help buffer.
It computes a message, and applies the optional argument FUNCTION to it.
139 140
If FUNCTION is nil, it applies `message', thus displaying the message.
In addition, this function sets up `help-return-method', which see, that
141 142 143
specifies what to do when the user exits the help buffer.

Do not call this in the scope of `with-help-window'."
Richard M. Stallman's avatar
Richard M. Stallman committed
144
  (and (not (get-buffer-window standard-output))
145
       (let ((first-message
146 147 148
	      (cond ((or
		      pop-up-frames
		      (special-display-p (buffer-name standard-output)))
149
		     (setq help-return-method (cons (selected-window) t))
150 151 152 153 154 155 156 157
		     ;; If the help output buffer is a special display buffer,
		     ;; don't say anything about how to get rid of it.
		     ;; First of all, the user will do that with the window
		     ;; manager, not with Emacs.
		     ;; Secondly, the buffer has not been displayed yet,
		     ;; so we don't know whether its frame will be selected.
		     nil)
		    ((not (one-window-p t))
158 159
		     (setq help-return-method
			   (cons (selected-window) 'quit-window))
160
		     "Type \\[display-buffer] RET to restore the other window.")
161
		    (pop-up-windows
162
		     (setq help-return-method (cons (selected-window) t))
163 164
		     "Type \\[delete-other-windows] to remove help window.")
		    (t
165 166 167
		     (setq help-return-method
			   (list (selected-window) (window-buffer)
				 (window-start) (window-point)))
168 169 170 171
		     "Type \\[switch-to-buffer] RET to remove help window."))))
	 (funcall (or function 'message)
		  (concat
		   (if first-message
Dave Love's avatar
Dave Love committed
172 173
		       (substitute-command-keys first-message))
		   (if first-message "  ")
174 175
		   ;; If the help buffer will go in a separate frame,
		   ;; it's no use mentioning a command to scroll, so don't.
176 177
		   (if (or pop-up-windows
			   (special-display-p (buffer-name standard-output)))
178
		       nil
179
		     (if (same-window-p (buffer-name standard-output))
180 181 182 183
			 ;; Say how to scroll this window.
			 (substitute-command-keys
			  "\\[scroll-up] to scroll the help.")
		       ;; Say how to scroll some other window.
184
		       (substitute-command-keys
185
			"\\[scroll-other-window] to scroll the help."))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187 188 189

;; So keyboard macro definitions are documented correctly
(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))

190 191 192 193 194
(defalias 'help 'help-for-help-internal)
;; find-function can find this.
(defalias 'help-for-help 'help-for-help-internal)
;; It can't find this, but nobody will look.
(make-help-screen help-for-help-internal
195
  (purecopy "Type a help option: [abcCdefFgiIkKlLmnprstvw.] C-[cdefmnoptw] or ?")
196 197 198
  ;; Don't purecopy this one, because it's not evaluated (it's
  ;; directly used as a docstring in a function definition, so it'll
  ;; be moved to the DOC file anyway: no need for purecopying it).
199 200 201
  "You have typed %THIS-KEY%, the help character.  Type a Help option:
\(Use SPC or DEL to scroll through this text.  Type \\<help-map>\\[help-quit] to exit the Help command.)

202 203 204 205 206 207 208 209 210
a PATTERN   Show commands whose name matches the PATTERN (a list of words
              or a regexp).  See also the `apropos' command.
b           Display all key bindings.
c KEYS      Display the command name run by the given key sequence.
C CODING    Describe the given coding system, or RET for current ones.
d PATTERN   Show a list of functions, variables, and other items whose
              documentation matches the PATTERN (a list of words or a regexp).
e           Go to the *Messages* buffer which logs echo-area messages.
f FUNCTION  Display documentation for the given function.
211
F COMMAND   Show the Emacs manual's section that describes the command.
212 213
g           Display information about the GNU project.
h           Display the HELLO file which illustrates various scripts.
214
i           Start the Info documentation reader: read included manuals.
215 216
I METHOD    Describe a specific input method, or RET for current.
k KEYS      Display the full documentation for the key sequence.
217
K KEYS      Show the Emacs manual's section for the command bound to KEYS.
218
l           Show last 300 input keystrokes (lossage).
219 220 221 222
L LANG-ENV  Describes a specific language environment, or RET for current.
m           Display documentation of current minor modes and current major mode,
              including their special commands.
n           Display news of recent Emacs changes.
223
o SYMBOL    Display the given function or variable's documentation and value.
224
p TOPIC     Find packages matching a given topic keyword.
225
P PACKAGE   Describe the given Emacs Lisp package.
226 227
r           Display the Emacs manual in Info mode.
s           Display contents of current syntax table, plus explanations.
228
S SYMBOL    Show the section for the given symbol in the Info manual
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
              for the programming language used in this buffer.
t           Start the Emacs learn-by-doing tutorial.
v VARIABLE  Display the given variable's documentation and value.
w COMMAND   Display which keystrokes invoke the given command (where-is).
.           Display any available local help at point in the echo area.

C-a         Information about Emacs.
C-c         Emacs copying permission (GNU General Public License).
C-d         Instructions for debugging GNU Emacs.
C-e         External packages and information about Emacs.
C-f         Emacs FAQ.
C-m         How to order printed Emacs manuals.
C-n         News of recent Emacs changes.
C-o         Emacs ordering and distribution information.
C-p         Info about known Emacs problems.
244
C-s         Search forward \"help window\".
245
C-t         Emacs TODO list.
246
C-w         Information on absence of warranty for GNU Emacs."
247 248 249 250 251 252 253
  help-map)



(defun function-called-at-point ()
  "Return a function around point or else called by the list containing point.
If that doesn't give a function, return nil."
254 255 256 257 258 259 260 261 262 263 264 265 266 267
  (with-syntax-table emacs-lisp-mode-syntax-table
    (or (condition-case ()
            (save-excursion
              (or (not (zerop (skip-syntax-backward "_w")))
                  (eq (char-syntax (following-char)) ?w)
                  (eq (char-syntax (following-char)) ?_)
                  (forward-sexp -1))
              (skip-chars-forward "'")
              (let ((obj (read (current-buffer))))
                (and (symbolp obj) (fboundp obj) obj)))
          (error nil))
        (condition-case ()
            (save-excursion
              (save-restriction
268 269 270 271 272 273 274 275 276 277 278 279 280
                (let ((forward-sexp-function nil)) ;Use elisp-mode's value
                  (narrow-to-region (max (point-min)
                                         (- (point) 1000))
                                    (point-max))
                  ;; Move up to surrounding paren, then after the open.
                  (backward-up-list 1)
                  (forward-char 1)
                  ;; If there is space here, this is probably something
                  ;; other than a real Lisp function call, so ignore it.
                  (if (looking-at "[ \t]")
                      (error "Probably not a Lisp function call"))
                  (let ((obj (read (current-buffer))))
                    (and (symbolp obj) (fboundp obj) obj)))))
281 282 283 284 285 286 287 288 289
          (error nil))
        (let* ((str (find-tag-default))
               (sym (if str (intern-soft str))))
          (if (and sym (fboundp sym))
              sym
            (save-match-data
              (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str))
                (setq sym (intern-soft (match-string 1 str)))
                (and (fboundp sym) sym))))))))
290 291 292 293


;;; `User' help functions

294 295
(defun view-help-file (file &optional dir)
  (view-file (expand-file-name file (or dir data-directory)))
296
  (goto-address-mode 1)
297 298
  (goto-char (point-min)))

Richard M. Stallman's avatar
Richard M. Stallman committed
299 300 301
(defun describe-distribution ()
  "Display info on how to obtain the latest version of GNU Emacs."
  (interactive)
302
  (view-help-file "DISTRIB"))
Richard M. Stallman's avatar
Richard M. Stallman committed
303 304 305 306

(defun describe-copying ()
  "Display info on how you may redistribute copies of GNU Emacs."
  (interactive)
307
  (view-help-file "COPYING"))
Richard M. Stallman's avatar
Richard M. Stallman committed
308

309
;; Maybe this command should just be removed.
310
(defun describe-gnu-project ()
311
  "Browse online information on the GNU project."
312
  (interactive)
313
  (browse-url "https://www.gnu.org/gnu/thegnuproject.html"))
314

Richard M. Stallman's avatar
Richard M. Stallman committed
315 316 317 318 319
(defun describe-no-warranty ()
  "Display info on all the kinds of warranty Emacs does NOT have."
  (interactive)
  (describe-copying)
  (let (case-fold-search)
320 321
    (search-forward "Disclaimer of Warranty")
    (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
322 323
    (recenter 0)))

324
(defun describe-prefix-bindings ()
325 326 327
  "Describe the bindings of the prefix used to reach this command.
The prefix described consists of all but the last event
of the key sequence that ran this command."
328
  (interactive)
329
  (let ((key (this-command-keys)))
330 331 332 333 334 335 336 337 338
    (describe-bindings
     (if (stringp key)
	 (substring key 0 (1- (length key)))
       (let ((prefix (make-vector (1- (length key)) nil))
	     (i 0))
	 (while (< i (length prefix))
	   (aset prefix i (aref key i))
	   (setq i (1+ i)))
	 prefix)))))
339
;; Make C-h after a prefix, when not specifically bound,
340
;; run describe-prefix-bindings.
341 342
(setq prefix-help-command 'describe-prefix-bindings)

343
(defun view-emacs-news (&optional version)
344
  "Display info on recent changes to Emacs.
345
With argument, display info only for the selected version."
346
  (interactive "P")
347 348 349 350 351
  (unless version
    (setq version emacs-major-version))
  (when (consp version)
    (let* ((all-versions
	    (let (res)
352
	      (mapc
353 354 355 356 357 358 359
	       (lambda (file)
		 (with-temp-buffer
		   (insert-file-contents
		    (expand-file-name file data-directory))
		   (while (re-search-forward
			   (if (member file '("NEWS.18" "NEWS.1-17"))
			       "Changes in \\(?:Emacs\\|version\\)?[ \t]*\\([0-9]+\\(?:\\.[0-9]+\\)?\\)"
360
			     "^\\* [^0-9\n]*\\([0-9]+\\.[0-9]+\\)") nil t)
361 362 363 364
		     (setq res (cons (match-string-no-properties 1) res)))))
	       (cons "NEWS"
		     (directory-files data-directory nil
				      "^NEWS\\.[0-9][-0-9]*$" nil)))
365
	      (sort (delete-dups res) #'string>)))
366
	   (current (car all-versions)))
367 368 369 370 371 372 373 374 375 376 377 378 379 380
      (setq version (completing-read
		     (format "Read NEWS for the version (default %s): " current)
		     all-versions nil nil nil nil current))
      (if (integerp (string-to-number version))
	  (setq version (string-to-number version))
	(unless (or (member version all-versions)
		    (<= (string-to-number version) (string-to-number current)))
	  (error "No news about version %s" version)))))
  (when (integerp version)
    (cond ((<= version 12)
	   (setq version (format "1.%d" version)))
	  ((<= version 18)
	   (setq version (format "%d" version)))
	  ((> version emacs-major-version)
381
	   (error "No news about Emacs %d (yet)" version))))
382 383 384 385 386 387
  (let* ((vn (if (stringp version)
		 (string-to-number version)
	       version))
	 (file (cond
		((>= vn emacs-major-version) "NEWS")
		((< vn 18) "NEWS.1-17")
388 389
		(t (format "NEWS.%d" vn))))
	 res)
390 391 392 393 394 395 396
    (view-file (expand-file-name file data-directory))
    (widen)
    (goto-char (point-min))
    (when (stringp version)
      (when (re-search-forward
	     (concat (if (< vn 19)
			 "Changes in Emacs[ \t]*"
397
		       "^\\* [^0-9\n]*") version "$")
398 399 400 401 402 403 404 405 406
	     nil t)
	(beginning-of-line)
	(narrow-to-region
	 (point)
	 (save-excursion
	   (while (and (setq res
			     (re-search-forward
			      (if (< vn 19)
				  "Changes in \\(?:Emacs\\|version\\)?[ \t]*\\([0-9]+\\(?:\\.[0-9]+\\)?\\)"
407
				"^\\* [^0-9\n]*\\([0-9]+\\.[0-9]+\\)") nil t))
408 409 410 411 412
		       (equal (match-string-no-properties 1) version)))
	   (or res (goto-char (point-max)))
	   (beginning-of-line)
	   (point)))))))

413
(defun view-emacs-todo (&optional _arg)
414 415
  "Display the Emacs TODO list."
  (interactive "P")
416
  (view-help-file "TODO"))
417

418 419
(defun view-echo-area-messages ()
  "View the log of recent echo-area messages: the `*Messages*' buffer.
420 421
The number of messages retained in that buffer is specified by
the variable `message-log-max'."
422
  (interactive)
423
  (with-current-buffer (messages-buffer)
424
    (goto-char (point-max))
425 426 427 428 429
    (let ((win (display-buffer (current-buffer))))
      ;; If the buffer is already displayed, we need to forcibly set
      ;; the window point to scroll to the end of the buffer.
      (set-window-point win (point))
      win)))
430

431
(defun view-order-manuals ()
432
  "Display information on how to buy printed copies of Emacs manuals."
433
  (interactive)
434
  (info "(emacs)Printed Books"))
435

436 437 438
(defun view-emacs-FAQ ()
  "Display the Emacs Frequently Asked Questions (FAQ) file."
  (interactive)
439
  (info "(efaq)"))
440

441 442 443
(defun view-emacs-problems ()
  "Display info on known problems with Emacs and possible workarounds."
  (interactive)
444 445 446 447 448 449 450
  (view-help-file "PROBLEMS"))

(defun view-emacs-debugging ()
  "Display info on how to debug Emacs problems."
  (interactive)
  (view-help-file "DEBUG"))

451 452
;; This used to visit a plain text file etc/MORE.STUFF;
;; maybe this command should just be removed.
453
(defun view-external-packages ()
454
  "Display info on where to get more Emacs packages."
455
  (interactive)
456
  (info "(efaq)Packages that do not come with Emacs"))
457

Richard M. Stallman's avatar
Richard M. Stallman committed
458
(defun view-lossage ()
459
  "Display last few input keystrokes and the commands run.
460 461
For convenience this uses the same format as
`edit-last-kbd-macro'.
462

463
To record all your input, use `open-dribble-file'."
Richard M. Stallman's avatar
Richard M. Stallman committed
464
  (interactive)
465 466
  (help-setup-xref (list #'view-lossage)
		   (called-interactively-p 'interactive))
467
  (with-help-window (help-buffer)
468 469 470 471 472 473 474 475 476 477 478 479
    (princ " ")
    (princ (mapconcat (lambda (key)
			(cond
			 ((and (consp key) (null (car key)))
			  (format ";; %s\n" (if (symbolp (cdr key)) (cdr key)
					      "anonymous-command")))
			 ((or (integerp key) (symbolp key) (listp key))
			  (single-key-description key))
			 (t
			  (prin1-to-string key nil))))
		      (recent-keys 'include-cmds)
		      " "))
480
    (with-current-buffer standard-output
Richard M. Stallman's avatar
Richard M. Stallman committed
481
      (goto-char (point-min))
482 483 484 485 486
      (let ((comment-start ";; ")
            (comment-column 24))
        (while (not (eobp))
          (comment-indent)
	  (forward-line 1)))
487
      ;; Show point near the end of "lossage", as we did in Emacs 24.
488
      (set-marker help-window-point-marker (point)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
489

490 491

;; Key bindings
Richard M. Stallman's avatar
Richard M. Stallman committed
492

493
(defun describe-bindings (&optional prefix buffer)
494 495
  "Display a buffer showing a list of all defined keys, and their definitions.
The keys are displayed in order of precedence.
496 497

The optional argument PREFIX, if non-nil, should be a key sequence;
498 499
then we display only bindings that start with that prefix.
The optional argument BUFFER specifies which buffer's bindings
500 501
to display (default, the current buffer).  BUFFER can be a buffer
or a buffer name."
502
  (interactive)
503
  (or buffer (setq buffer (current-buffer)))
504 505
  (help-setup-xref (list #'describe-bindings prefix buffer)
		   (called-interactively-p 'interactive))
506 507 508 509 510
  (with-help-window (help-buffer)
    ;; Be aware that `describe-buffer-bindings' puts its output into
    ;; the current buffer.
    (with-current-buffer (help-buffer)
      (describe-buffer-bindings buffer prefix))))
511

512 513 514 515 516 517 518 519 520
;; This function used to be in keymap.c.
(defun describe-bindings-internal (&optional menus prefix)
  "Show a list of all defined keys, and their definitions.
We put that list in a buffer, and display the buffer.

The optional argument MENUS, if non-nil, says to mention menu bindings.
\(Ordinarily these are omitted from the output.)
The optional argument PREFIX, if non-nil, should be a key sequence;
then we display only bindings that start with that prefix."
521
  (declare (obsolete describe-buffer-bindings "24.4"))
522
  (let ((buf (current-buffer)))
523
    (with-help-window (help-buffer)
524 525 526 527
      ;; Be aware that `describe-buffer-bindings' puts its output into
      ;; the current buffer.
      (with-current-buffer (help-buffer)
	(describe-buffer-bindings buf prefix menus)))))
528

529
(defun where-is (definition &optional insert)
530
  "Print message listing key sequences that invoke the command DEFINITION.
531 532
Argument is a command definition, usually a symbol with a function definition.
If INSERT (the prefix arg) is non-nil, insert the message in the buffer."
533 534
  (interactive
   (let ((fn (function-called-at-point))
535
	 (enable-recursive-minibuffers t)
536
	 val)
537 538 539 540
     (setq val (completing-read
		(if fn
		    (format "Where is command (default %s): " fn)
		  "Where is command: ")
541 542 543 544
		obarray 'commandp t nil nil
		(and fn (symbol-name fn))))
     (list (unless (equal val "") (intern val))
	   current-prefix-arg)))
545
  (unless definition (error "No command"))
546
  (let ((func (indirect-function definition))
547
        (defs nil)
548
        (standard-output (if insert (current-buffer) standard-output)))
549
    ;; In DEFS, find all symbols that are aliases for DEFINITION.
550 551 552
    (mapatoms (lambda (symbol)
		(and (fboundp symbol)
		     (not (eq symbol definition))
553 554 555
		     (eq func (condition-case ()
				  (indirect-function symbol)
				(error symbol)))
556
		     (push symbol defs))))
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
    ;; Look at all the symbols--first DEFINITION,
    ;; then its aliases.
    (dolist (symbol (cons definition defs))
      (let* ((remapped (command-remapping symbol))
	     (keys (where-is-internal
		    symbol overriding-local-map nil nil remapped))
	     (keys (mapconcat 'key-description keys ", "))
	     string)
	(setq string
	      (if insert
		  (if (> (length keys) 0)
		      (if remapped
			  (format "%s (%s) (remapped from %s)"
				  keys remapped symbol)
			(format "%s (%s)" keys symbol))
		    (format "M-x %s RET" symbol))
		(if (> (length keys) 0)
		    (if remapped
			(format "%s is remapped to %s which is on %s"
576
				symbol remapped keys)
577 578 579 580 581 582 583 584 585 586 587
		      (format "%s is on %s" symbol keys))
		  ;; If this is the command the user asked about,
		  ;; and it is not on any key, say so.
		  ;; For other symbols, its aliases, say nothing
		  ;; about them unless they are on keys.
		  (if (eq symbol definition)
		      (format "%s is not on any key" symbol)))))
	(when string
	  (unless (eq symbol definition)
	    (princ ";\n its alias "))
	  (princ string)))))
588 589
  nil)

590 591
(defun help-key-description (key untranslated)
  (let ((string (key-description key)))
592 593
    (if (or (not untranslated)
	    (and (eq (aref untranslated 0) ?\e) (not (eq (aref key 0) ?\e))))
594 595 596 597 598
	string
      (let ((otherstring (key-description untranslated)))
	(if (equal string otherstring)
	    string
	  (format "%s (translated from %s)" string otherstring))))))
599

600 601 602
(defun help--binding-undefined-p (defn)
  (or (null defn) (integerp defn) (equal defn 'undefined)))

603 604 605 606
(defun help--analyze-key (key untranslated)
  "Get information about KEY its corresponding UNTRANSLATED events.
Returns a list of the form (BRIEF-DESC DEFN EVENT MOUSE-MSG)."
  (if (numberp untranslated)
607 608 609 610 611 612 613 614 615 616
      (error "Missing `untranslated'!"))
  (let* ((event (when (> (length key) 0)
                  (aref key (if (and (symbolp (aref key 0))
		                     (> (length key) 1)
		                     (consp (aref key 1)))
                                ;; Look at the second event when the first
                                ;; is a pseudo-event like `mode-line' or
                                ;; `left-fringe'.
		                1
	                      0))))
617 618
	 (modifiers (event-modifiers event))
	 (mouse-msg (if (or (memq 'click modifiers) (memq 'down modifiers)
619 620
			    (memq 'drag modifiers))
                        " at that spot" ""))
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
	 (defn (key-binding key t)))
    ;; Handle the case where we faked an entry in "Select and Paste" menu.
    (when (and (eq defn nil)
	       (stringp (aref key (1- (length key))))
	       (eq (key-binding (substring key 0 -1)) 'yank-menu))
      (setq defn 'menu-bar-select-yank))
    ;; Don't bother user with strings from (e.g.) the select-paste menu.
    (when (stringp (aref key (1- (length key))))
      (aset key (1- (length key)) "(any string)"))
    (when (and untranslated
               (stringp (aref untranslated (1- (length untranslated)))))
      (aset untranslated (1- (length untranslated)) "(any string)"))
    (list
     ;; Now describe the key, perhaps as changed.
     (let ((key-desc (help-key-description key untranslated)))
636
       (if (help--binding-undefined-p defn)
637 638 639 640
           (format "%s%s is undefined" key-desc mouse-msg)
         (format "%s%s runs the command %S" key-desc mouse-msg defn)))
     defn event mouse-msg)))

641 642 643 644 645 646 647 648 649 650 651 652 653 654
(defun help--filter-info-list (info-list i)
  "Drop the undefined keys."
  (or
   ;; Remove all `undefined' keys.
   (delq nil (mapcar (lambda (x)
                       (unless (help--binding-undefined-p (nth i x)) x))
                     info-list))
   ;; If nothing left, then keep one (the last one).
   (last info-list)))

(defun describe-key-briefly (&optional key-list insert untranslated)
  "Print the name of the functions KEY-LIST invokes.
KEY-LIST is a list of pairs (SEQ . RAW-SEQ) of key sequences, where
RAW-SEQ is the untranslated form of the key sequence SEQ.
655 656
If INSERT (the prefix arg) is non-nil, insert the message in the buffer.

657 658 659 660
While reading KEY-LIST interactively, this command temporarily enables
menu items or tool-bar buttons that are disabled to allow getting help
on them."
  (declare (advertised-calling-convention (key-list &optional insert) "27.1"))
661
  (interactive
662 663
   ;; Ignore mouse movement events because it's too easy to miss the
   ;; message while moving the mouse.
664 665 666 667 668 669 670 671 672 673 674 675 676
   (let ((key-list (help--read-key-sequence 'no-mouse-movement)))
     `(,key-list ,current-prefix-arg)))
  (when (arrayp key-list)
    ;; Old calling convention, changed
    (setq key-list (list (cons key-list
                               (if (numberp untranslated)
                                   (this-single-command-raw-keys)
                                 untranslated)))))
  (let* ((info-list (mapcar (lambda (kr)
                              (help--analyze-key (car kr) (cdr kr)))
                            key-list))
         (msg (mapconcat #'car (help--filter-info-list info-list 1) "\n")))
    (if insert (insert msg) (message "%s" msg))))
677

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
(defun help--key-binding-keymap (key &optional accept-default no-remap position)
  "Return a keymap holding a binding for KEY within current keymaps.
The effect of the arguments KEY, ACCEPT-DEFAULT, NO-REMAP and
POSITION is as documented in the function `key-binding'."
  (let* ((active-maps (current-active-maps t position))
         map found)
    ;; We loop over active maps like key-binding does.
    (while (and
            (not found)
            (setq map (pop active-maps)))
      (setq found (lookup-key map key accept-default))
      (when (integerp found)
        ;; The first `found' characters of KEY were found but not the
        ;; whole sequence.
        (setq found nil)))
    (when found
      (if (and (symbolp found)
               (not no-remap)
               (command-remapping found))
          ;; The user might want to know in which map the binding is
698
          ;; found, or in which map the remapping is found.  The
699
          ;; default is to show the latter.
700
          (help--key-binding-keymap (vector 'remap found))
701 702 703 704 705
        map))))

(defun help--binding-locus (key position)
  "Describe in which keymap KEY is defined.
Return a symbol pointing to that keymap if one exists ; otherwise
706 707
return nil.  The argument POSITION is as documented in the
function `key-binding'."
708
  (let ((map (help--key-binding-keymap key t nil position)))
709 710 711 712 713 714 715 716 717 718 719 720 721 722
    (when map
      (catch 'found
        (let ((advertised-syms (nconc
                                (list 'overriding-terminal-local-map
                                      'overriding-local-map)
                                (delq nil
                                      (mapcar
                                       (lambda (mode-and-map)
                                         (let ((mode (car mode-and-map)))
                                           (when (symbol-value mode)
                                             (intern-soft
                                              (format "%s-map" mode)))))
                                       minor-mode-map-alist))
                                (list 'global-map
723
                                      (intern-soft (format "%s-map" major-mode))))))
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
          ;; Look into these advertised symbols first.
          (dolist (sym advertised-syms)
            (when (and
                   (boundp sym)
                   (eq map (symbol-value sym)))
              (throw 'found sym)))
          ;; Only look in other symbols otherwise.
          (mapatoms
           (lambda (x)
             (when (and (boundp x)
                        ;; Avoid let-bound symbols.
                        (special-variable-p x)
                        (eq (symbol-value x) map))
               (throw 'found x))))
          nil)))))

740 741 742 743 744 745 746 747
(defun help--read-key-sequence (&optional no-mouse-movement)
  "Read a key sequence from the user.
Usually reads a single key sequence, except when that sequence might
hide another one (e.g. a down event, where the user is interested
in getting info about the up event, or a click event, where the user
wants to get info about the double click).
Return a list of elements of the form (SEQ . RAW-SEQ), where SEQ is a key
sequence, and RAW-SEQ is its untranslated form.
748 749
If NO-MOUSE-MOVEMENT is non-nil, ignore key sequences starting
with `mouse-movement' events."
750 751
  (let ((enable-disabled-menus-and-buttons t)
        (cursor-in-echo-area t)
752
        (side-event nil)
753 754
        saved-yank-menu)
    (unwind-protect
755
        (let (last-modifiers key-list)
756 757 758 759 760 761
          ;; If yank-menu is empty, populate it temporarily, so that
          ;; "Select and Paste" menu can generate a complete event.
          (when (null (cdr yank-menu))
            (setq saved-yank-menu (copy-sequence yank-menu))
            (menu-bar-update-yank-menu "(any string)" nil))
          (while
762 763 764 765 766 767 768 769 770
              ;; Read at least one key-sequence.
              (or (null key-list)
                  ;; After a down event, also read the (presumably) following
                  ;; up-event.
                  (memq 'down last-modifiers)
                  ;; After a click, see if a double click is on the way.
                  (and (memq 'click last-modifiers)
                       (not (sit-for (/ double-click-time 1000.0) t))))
            (let* ((seq (read-key-sequence "\
771 772
Describe the following key, mouse click, or menu item: "
                                           nil nil 'can-return-switch-frame))
773 774 775 776 777 778 779 780
                   (raw-seq (this-single-command-raw-keys))
                   (keyn (when (> (length seq) 0)
                           (aref seq (1- (length seq)))))
                   (base (event-basic-type keyn))
                   (modifiers (event-modifiers keyn)))
              (cond
               ((zerop (length seq)))   ;FIXME: Can this happen?
               ((and no-mouse-movement (eq base 'mouse-movement)) nil)
781 782 783 784 785
               ((memq base '(mouse-movement switch-frame select-window))
                ;; Mostly ignore these events since it's sometimes difficult to
                ;; generate the event you care about without also generating
                ;; these side-events along the way.
                (setq side-event (cons seq raw-seq)))
786 787 788 789
               ((eq base 'help-echo) nil)
               (t
                (setq last-modifiers modifiers)
                (push (cons seq raw-seq) key-list)))))
790 791 792
          (if side-event
              (cons side-event (nreverse key-list))
            (nreverse key-list)))
793 794 795 796 797
      ;; Put yank-menu back as it was, if we changed it.
      (when saved-yank-menu
        (setq yank-menu (copy-sequence saved-yank-menu))
        (fset 'yank-menu (cons 'keymap yank-menu))))))

798 799 800
(defun describe-key (&optional key-list buffer up-event)
  "Display documentation of the function invoked by KEY-LIST.
KEY-LIST can be any kind of a key sequence; it can include keyboard events,
801
mouse events, and/or menu events.  When calling from a program,
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
pass KEY-LIST as a list of elements (SEQ . RAW-SEQ) where SEQ is
a key-sequence and RAW-SEQ is its untranslated form.

While reading KEY-LIST interactively, this command temporarily enables
menu items or tool-bar buttons that are disabled to allow getting help
on them.

BUFFER is the buffer in which to lookup those keys; it defaults to the
current buffer."
  (declare (advertised-calling-convention (key-list &optional buffer) "27.1"))
  (interactive (list (help--read-key-sequence)))
  (when (arrayp key-list)
    ;; Compatibility with old calling convention.
    (setq key-list (cons (list key-list) (if up-event (list up-event))))
    (when buffer
      (let ((raw (if (numberp buffer) (this-single-command-raw-keys) buffer)))
        (setf (cdar (last key-list)) raw)))
    (setq buffer nil))
  (let* ((buf (or buffer (current-buffer)))
         (on-link
          (mapcar (lambda (kr)
                    (let ((raw (cdr kr)))
                      (and (not (memq mouse-1-click-follows-link '(nil double)))
                           (> (length raw) 0)
                           (eq (car-safe (aref raw 0)) 'mouse-1)
                           (with-current-buffer buf
                             (mouse-on-link-p (event-start (aref raw 0)))))))
                  key-list))
         (info-list
          (help--filter-info-list
           (with-current-buffer buf
             (mapcar (lambda (x)
                       (pcase-let* ((`(,seq . ,raw-seq) x)
                                    (`(,brief-desc ,defn ,event ,_mouse-msg)
                                     (help--analyze-key seq raw-seq))
                                    (locus
                                     (help--binding-locus
                                      seq (event-start event))))
                         `(,seq ,brief-desc ,defn ,locus)))
                     key-list))
           2)))
    (help-setup-xref (list (lambda (key-list buf)
                             (describe-key key-list
                                           (if (buffer-live-p buf) buf)))
                           key-list buf)
		     (called-interactively-p 'interactive))
    (if (and (<= (length info-list) 1)
             (help--binding-undefined-p (nth 2 (car info-list))))
        (message "%s" (nth 1 (car info-list)))
851
      (with-help-window (help-buffer)
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
        (when (> (length info-list) 1)
          ;; FIXME: Make this into clickable hyperlinks.
          (princ "There were several key-sequences:\n\n")
          (princ (mapconcat (lambda (info)
                              (pcase-let ((`(,_seq ,brief-desc ,_defn ,_locus)
                                           info))
                                (concat "  " brief-desc)))
                            info-list
                            "\n"))
          (when (delq nil on-link)
            (princ "\n\nThose are influenced by `mouse-1-click-follows-link'"))
          (princ "\n\nThey're all described below."))
        (pcase-dolist (`(,_seq ,brief-desc ,defn ,locus)
                       info-list)
          (when defn
            (when (> (length info-list) 1)
              (with-current-buffer standard-output
                (insert "\n\n"
                        ;; FIXME: Can't use eval-when-compile because purified
                        ;; strings lose their text properties :-(
872 873
                        (propertize "\n" 'face
                                    '(:height 0.1 :inverse-video t :extend t))
874 875 876 877 878 879 880
                        "\n")))

            (princ brief-desc)
            (when locus
              (princ (format " (found in %s)" locus)))
            (princ ", which is ")
	    (describe-function-1 defn)))))))
881

882 883 884 885 886 887 888
(defun search-forward-help-for-help ()
  "Search forward \"help window\"."
  (interactive)
  ;; Move cursor to the "help window".
  (pop-to-buffer " *Metahelp*")
  ;; Do incremental search forward.
  (isearch-forward nil t))
889

890
(defun describe-minor-mode (minor-mode)
891 892 893
  "Display documentation of a minor mode given as MINOR-MODE.
MINOR-MODE can be a minor mode symbol or a minor mode indicator string
appeared on the mode-line."
894
  (interactive (list (completing-read
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
		      "Minor mode: "
			      (nconc
			       (describe-minor-mode-completion-table-for-symbol)
			       (describe-minor-mode-completion-table-for-indicator)
			       ))))
  (if (symbolp minor-mode)
      (setq minor-mode (symbol-name minor-mode)))
  (let ((symbols (describe-minor-mode-completion-table-for-symbol))
	(indicators (describe-minor-mode-completion-table-for-indicator)))
    (cond
     ((member minor-mode symbols)
      (describe-minor-mode-from-symbol (intern minor-mode)))
     ((member minor-mode indicators)
      (describe-minor-mode-from-indicator minor-mode))
     (t
      (error "No such minor mode: %s" minor-mode)))))

912
;; symbol
913 914 915 916
(defun describe-minor-mode-completion-table-for-symbol ()
  ;; In order to list up all minor modes, minor-mode-list
  ;; is used here instead of minor-mode-alist.
  (delq nil (mapcar 'symbol-name minor-mode-list)))
917

918
(defun describe-minor-mode-from-symbol (symbol)
919
  "Display documentation of a minor mode given as a symbol, SYMBOL."
920
  (interactive (list (intern (completing-read
921 922 923 924 925 926 927 928
			      "Minor mode symbol: "
			      (describe-minor-mode-completion-table-for-symbol)))))
  (if (fboundp symbol)
      (describe-function symbol)
    (describe-variable symbol)))

;; indicator
(defun describe-minor-mode-completion-table-for-indicator ()
929
  (delq nil
930 931 932 933 934 935
	(mapcar (lambda (x)
		  (let ((i (format-mode-line x)))
		    ;; remove first space if existed
		    (cond
		     ((= 0 (length i))
		      nil)
936
		     ((eq (aref i 0) ?\s)
937
		      (substring i 1))
938
		     (t
939 940
		      i))))
		minor-mode-alist)))
941

942
(defun describe-minor-mode-from-indicator (indicator)
943 944 945
  "Display documentation of a minor mode specified by INDICATOR.
If you call this function interactively, you can give indicator which
is currently activated with completion."
946 947
  (interactive (list
		(completing-read
948
		 "Minor mode indicator: "
949
		 (describe-minor-mode-completion-table-for-indicator))))
950 951
  (let ((minor-mode (lookup-minor-mode-from-indicator indicator)))
    (if minor-mode
952
	(describe-minor-mode-from-symbol minor-mode)
953
      (error "Cannot find minor mode for `%s'" indicator))))
954 955

(defun lookup-minor-mode-from-indicator (indicator)
956
  "Return a minor mode symbol from its indicator on the mode line."
957
  ;; remove first space if existed
958
  (if (and (< 0 (length indicator))
959
	   (eq (aref indicator 0) ?\s))
960
      (setq indicator (substring indicator 1)))
961 962 963 964
  (let ((minor-modes minor-mode-alist)
	result)
    (while minor-modes
      (let* ((minor-mode (car (car minor-modes)))
965
	     (anindicator (format-mode-line
966 967
			   (car (cdr (car minor-modes))))))
	;; remove first space if existed
968
	(if (and (stringp anindicator)
969
		 (> (length anindicator) 0)
970
		 (eq (aref anindicator 0) ?\s))
971 972
	    (setq anindicator (substring anindicator 1)))
	(if (equal indicator anindicator)
973 974 975 976
	    (setq result minor-mode
		  minor-modes nil)
	  (setq minor-modes (cdr minor-modes)))))
    result))
977

978 979 980
(declare-function x-display-pixel-height "xfns.c" (&optional terminal))
(declare-function x-display-pixel-width "xfns.c" (&optional terminal))

981
;;; Automatic resizing of temporary buffers.
982
(defcustom temp-buffer-max-height
983
  (lambda (_buffer)
984
    (if (and (display-graphic-p) (eq (selected-window) (frame-root-window)))
985 986
	(/ (x-display-pixel-height) (frame-char-height) 2)
      (/ (- (frame-height) 2) 2)))
987
  "Maximum height of a window displaying a temporary buffer.
988
This is effective only when Temp Buffer Resize mode is enabled.
989 990 991
The value is the maximum height (in lines) which
`resize-temp-buffer-window' will give to a window displaying a
temporary buffer.  It can also be a function to be called to
Paul Eggert's avatar
Paul Eggert committed
992
choose the height for such a buffer.  It gets one argument, the
993 994
buffer, and should return a positive integer.  At the time the
function is called, the window to be resized is selected."
995 996
  :type '(choice integer function)
  :group 'help
Glenn Morris's avatar
Glenn Morris committed
997
  :version "24.3")
998

999
(defcustom temp-buffer-max-width
1000
  (lambda (_buffer)
1001
    (if (and (display-graphic-p) (eq (selected-window) (frame-root-window)))
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
	(/ (x-display-pixel-width) (frame-char-width) 2)
      (/ (- (frame-width) 2) 2)))
  "Maximum width of a window displaying a temporary buffer.
This is effective only when Temp Buffer Resize mode is enabled.
The value is the maximum width (in columns) which
`resize-temp-buffer-window' will give to a window displaying a
temporary buffer.  It can also be a function to be called to
choose the width for such a buffer.  It gets one argument, the
buffer, and should return a positive integer.  At the time the
function is called, the window to be resized is selected."
  :type '(choice integer function)
  :group 'help
  :version "24.4")

1016
(define-minor-mode temp-buffer-resize-mode
1017
  "Toggle auto-resizing temporary buffer windows (Temp Buffer Resize Mode).
1018 1019

When Temp Buffer Resize mode is enabled, the windows in which we
1020
show a temporary buffer are automatically resized in height to
1021 1022
fit the buffer's contents, but never more than
`temp-buffer-max-height' nor less than `window-min-height'.
1023

1024 1025
A window is resized only if it has been specially created for the
buffer.  Windows that have shown another buffer before are not
1026 1027
resized.  A frame is resized only if `fit-frame-to-buffer' is
non-nil.
1028

1029 1030
This mode is used by `help', `apropos' and `completion' buffers,
and some others."
1031
  :global t :group 'help
1032
  (if temp-buffer-resize-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
1033
      ;; `help-make-xrefs' may add a `back' button and thus increase the
1034 1035
      ;; text size, so `resize-temp-buffer-window' must be run *after* it.
      (add-hook 'temp-buffer-show-hook 'resize-temp-buffer-window 'append)
Stefan Monnier's avatar
Stefan Monnier committed
1036
    (remove-hook 'temp-buffer-show-hook 'resize-temp-buffer-window)))
1037

1038 1039
(defun resize-temp-buffer-window (&optional window)
  "Resize WINDOW to fit its contents.
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
WINDOW must be a live window and defaults to the selected one.
Do not resize if WINDOW was not created by `display-buffer'.

If WINDOW is part of a vertical combination, restrain its new
size by `temp-buffer-max-height' and do not resize if its minimum
accessible position is scrolled out of view.  If WINDOW is part
of a horizontal combination, restrain its new size by
`temp-buffer-max-width'.  In both cases, the value of the option
`fit-window-to-buffer-horizontally' can inhibit resizing.

If WINDOW is the root window of its frame, resize the frame
1051 1052 1053 1054
provided `fit-frame-to-buffer' is non-nil.

This function may call `preserve-window-size' to preserve the
size of WINDOW."
1055
  (setq window (window-normalize-window window t))
1056 1057 1058 1059
  (let ((height (if (functionp temp-buffer-max-height)
		    (with-selected-window window
		      (funcall temp-buffer-max-height (window-buffer)))
		  temp-buffer-max-height))
1060 1061 1062 1063
	(width (if (functionp temp-buffer-max-width)
		   (with-selected-window window
		     (funcall temp-buffer-max-width (window-buffer)))
		 temp-buffer-max-width))
1064
	(quit-cadr (cadr (window-parameter window 'quit-restore))))
1065 1066 1067 1068 1069 1070 1071 1072 1073
    ;; Resize WINDOW iff it was made by `display-buffer'.
    (when (or (and (eq quit-cadr 'window)
		   (or (and (window-combined-p window)
			    (not (eq fit-window-to-buffer-horizontally
				     'only))
			    (pos-visible-in-window-p (point-min) window))
		       (and (window-combined-p window t)
			    fit-window-to-buffer-horizontally)))
	      (and (eq quit-cadr 'frame)
1074 1075
                   fit-frame-to-buffer
                   (eq window (frame-root-window window))))
1076
	(fit-window-to-buffer window height nil width nil t))))
1077

1078
;;; Help windows.
1079 1080
(defcustom help-window-select nil
  "Non-nil means select help window for viewing.
1081
Choices are:
1082

1083 1084
 never (nil) Select help window only if there is no other window
             on its frame.
1085 1086 1087 1088 1089 1090

 other       Select help window if and only if it appears on the
             previously selected frame, that frame contains at
             least two other windows and the help window is
             either new or showed a different buffer before.

1091 1092
 always (t)  Always select the help window.

1093 1094 1095 1096 1097
If this option is non-nil and the help window appears on another
frame, then give that frame input focus too.  Note also that if
the help window appears on another frame, it may get selected and
its frame get input focus even if this option is nil.

1098
This option has effect if and only if the help window was created
1099
by `with-help-window'."
1100 1101 1102 1103 1104 1105
  :type '(choice (const :tag "never (nil)" nil)
		 (const :tag "other" other)
		 (const :tag "always (t)" t))
  :group 'help
  :version "23.1")

1106 1107 1108 1109
(define-obsolete-variable-alias 'help-enable-auto-load
  'help-enable-autoload "27.1")

(defcustom help-enable-autoload t
1110 1111 1112 1113 1114 1115 1116
  "Whether Help commands can perform autoloading.
If non-nil, whenever \\[describe-function] is called for an
autoloaded function whose docstring contains any key substitution
construct (see `substitute-command-keys'), the library is loaded,
so that the documentation can show the right key bindings."
  :type 'boolean
  :group 'help
1117
  :version "24.3")
1118

1119
(defun help-window-display-message (quit-part window &optional scroll)
1120 1121
  "Display message telling how to quit and scroll help window.
QUIT-PART is a string telling how to quit the help window WINDOW.
1122 1123 1124
Optional argument SCROLL non-nil means tell how to scroll WINDOW.
SCROLL equal `other' means tell how to scroll the \"other\"
window."
1125 1126
  (let ((scroll-part
	 (cond
1127 1128 1129
	  ;; If we don't have QUIT-PART we probably reuse a window
	  ;; showing the same buffer so we don't show any message.
	  ((not quit-part) nil)
1130 1131
	  ((pos-visible-in-window-p
	    (with-current-buffer (window-buffer window)
1132 1133 1134
	      (point-max)) window t)
	   ;; Buffer end is at least partially visible, no need to talk
	   ;; about scrolling.
1135
	   ".")
1136 1137 1138
	  ((eq scroll 'other)
	   ", \\[scroll-other-window] to scroll help.")
	  (scroll ", \\[scroll-up] to scroll help."))))
1139
    (message "%s"
1140 1141
     (substitute-command-keys (concat quit-part scroll-part)))))

1142 1143 1144 1145 1146 1147 1148
(defun help-window-setup (window &optional value)
  "Set up help window WINDOW for `with-help-window'.
WINDOW is the window used for displaying the help buffer.
Return VALUE."
  (let* ((help-buffer (when (window-live-p window)
			(window-buffer window)))
	 (help-setup (when (window-live-p window)
1149 1150 1151
		       (car (window-parameter window 'quit-restore))))
	 (frame (window-frame window)))

1152 1153 1154
    (when help-buffer
      ;; Handle `help-window-point-marker'.
      (when (eq (marker-buffer help-window-point-marker) help-buffer)
1155
	(set-window-point window help-window-point-marker)
1156 1157
	;; Reset `help-window-point-marker'.
	(set-marker help-window-point-marker nil))
1158

1159 1160 1161 1162 1163 1164 1165 1166 1167
      ;; If the help window appears on another frame, select it if
      ;; `help-window-select' is non-nil and give that frame input focus
      ;; too.  See also Bug#19012.
      (when (and help-window-select
		 (frame-live-p help-window-old-frame)
		 (not (eq frame help-window-old-frame)))
	(select-window window)
	(select-frame-set-input-focus frame))

1168
      (cond
1169
       ((or (eq window (selected-window))
1170 1171 1172 1173 1174 1175 1176
	    ;; If the help window is on the selected frame, select
	    ;; it if `help-window-select' is t or `help-window-select'
	    ;; is 'other, the frame contains at least three windows, and
	    ;; the help window did show another buffer before.  See also
	    ;; Bug#11039.
	    (and (eq frame (selected-frame))
		 (or (eq help-window-select t)
1177
		     (and (eq help-window-select 'other)
1178 1179
			  (> (length (window-list nil 'no-mini)) 2)
			  (not (eq help-setup 'same))))
1180
		 (select-window window)))
1181 1182 1183
	;; The help window is or gets selected ...
	(help-window-display-message
	 (cond
1184
	  ((eq help-setup 'window)
1185
	   ;; ... and is new, ...
1186
	   "Type \"q\" to delete help window")
1187
	  ((eq help-setup 'frame)
1188
	   ;; ... on a new frame, ...
1189
	   "Type \"q\" to quit the help frame")
1190
	  ((eq help-setup 'other)
1191 1192
	   ;; ... or displayed some other buffer before.
	   "Type \"q\" to restore previous buffer"))
1193
	 window t))
1194
       ((and (eq (window-frame window) help-window-old-frame)
1195 1196 1197 1198 1199
	     (= (length (window-list nil 'no-mini)) 2))
	;; There are two windows on the help window's frame and the
	;; other one is the selected one.
	(help-window-display-message
	 (cond
1200
	  ((eq help-setup 'window)
1201
	   "Type \\[delete-other-windows] to delete the help window")
1202
	  ((eq help-setup 'other)
1203
	   "Type \"q\" in help window to restore its previous buffer"))
1204
	 window 'other))
1205