help-mode.el 31.4 KB
Newer Older
1 2
;;; help-mode.el --- `help-mode' used by *Help* buffers

3
;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
5 6 7 8 9 10

;; Maintainer: FSF
;; Keywords: help, internal

;; This file is part of GNU Emacs.

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
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
15 16 17 18 19 20 21

;; 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
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23 24 25 26 27 28 29 30 31

;;; Commentary:

;; Defines `help-mode', which is the mode used by *Help* buffers, and
;; associated support machinery, such as adding hyperlinks, etc.,

;;; Code:

(require 'button)
Stefan Monnier's avatar
Stefan Monnier committed
32
(require 'view)
33
(eval-when-compile (require 'easymenu))
34 35 36 37 38 39

(defvar help-mode-map (make-sparse-keymap)
  "Keymap for help mode.")

(set-keymap-parent help-mode-map button-buffer-map)

Stefan Monnier's avatar
Stefan Monnier committed
40
(define-key help-mode-map [mouse-2] 'help-follow-mouse)
41
(define-key help-mode-map "\C-c\C-b" 'help-go-back)
Nick Roberts's avatar
Nick Roberts committed
42
(define-key help-mode-map "\C-c\C-f" 'help-go-forward)
43
(define-key help-mode-map "\C-c\C-c" 'help-follow-symbol)
44 45 46
;; Documentation only, since we use minor-mode-overriding-map-alist.
(define-key help-mode-map "\r" 'help-follow)

Dan Nicolaescu's avatar
Dan Nicolaescu committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60
(easy-menu-define help-mode-menu help-mode-map
  "Menu for Help Mode."
  '("Help-Mode"
    ["Show Help for Symbol" help-follow-symbol
     :help "Show the docs for the symbol at point"]
    ["Previous Topic" help-go-back
     :help "Go back to previous topic in this help buffer"]
    ["Next Topic" help-go-forward
     :help "Go back to next topic in this help buffer"]
    ["Move to Previous Button" backward-button
     :help "Move to the Next Button in the help buffer"]
    ["Move to Next Button" forward-button
      :help "Move to the Next Button in the help buffer"]))

61 62 63
(defvar help-xref-stack nil
  "A stack of ways by which to return to help buffers after following xrefs.
Used by `help-follow' and `help-xref-go-back'.
Stefan Monnier's avatar
Stefan Monnier committed
64 65
An element looks like (POSITION FUNCTION ARGS...).
To use the element, do (apply FUNCTION ARGS) then goto the point.")
66
(put 'help-xref-stack 'permanent-local t)
Stefan Monnier's avatar
Stefan Monnier committed
67
(make-variable-buffer-local 'help-xref-stack)
68

Nick Roberts's avatar
Nick Roberts committed
69
(defvar help-xref-forward-stack nil
70
  "A stack used to navigate help forwards after using the back button.
Nick Roberts's avatar
Nick Roberts committed
71 72 73 74 75 76
Used by `help-follow' and `help-xref-go-forward'.
An element looks like (POSITION FUNCTION ARGS...).
To use the element, do (apply FUNCTION ARGS) then goto the point.")
(put 'help-xref-forward-stack 'permanent-local t)
(make-variable-buffer-local 'help-xref-forward-stack)

77 78 79 80
(defvar help-xref-stack-item nil
  "An item for `help-follow' in this buffer to push onto `help-xref-stack'.
The format is (FUNCTION ARGS...).")
(put 'help-xref-stack-item 'permanent-local t)
Stefan Monnier's avatar
Stefan Monnier committed
81
(make-variable-buffer-local 'help-xref-stack-item)
82

Nick Roberts's avatar
Nick Roberts committed
83 84 85 86 87 88
(defvar help-xref-stack-forward-item nil
  "An item for `help-go-back' to push onto `help-xref-forward-stack'.
The format is (FUNCTION ARGS...).")
(put 'help-xref-stack-forward-item 'permanent-local t)
(make-variable-buffer-local 'help-xref-stack-forward-item)

89
(setq-default help-xref-stack nil help-xref-stack-item nil)
Nick Roberts's avatar
Nick Roberts committed
90
(setq-default help-xref-forward-stack nil help-xref-forward-stack-item nil)
91

92 93 94 95
(defcustom help-mode-hook nil
  "Hook run by `help-mode'."
  :type 'hook
  :group 'help)
96 97 98

;; Button types used by help

Miles Bader's avatar
Miles Bader committed
99
(define-button-type 'help-xref
100
  'follow-link t
Miles Bader's avatar
Miles Bader committed
101 102 103 104 105 106 107 108
  'action #'help-button-action)

(defun help-button-action (button)
  "Call BUTTON's help function."
  (help-do-xref (button-start button)
		(button-get button 'help-function)
		(button-get button 'help-args)))

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
;; These 6 calls to define-button-type were generated in a dolist
;; loop, but that is bad because it means these button types don't
;; have an easily found definition.

(define-button-type 'help-function
  :supertype 'help-xref
  'help-function 'describe-function
  'help-echo (purecopy "mouse-2, RET: describe this function"))

(define-button-type 'help-variable
  :supertype 'help-xref
  'help-function 'describe-variable
  'help-echo (purecopy "mouse-2, RET: describe this variable"))

(define-button-type 'help-face
  :supertype 'help-xref
  'help-function 'describe-face
  'help-echo (purecopy "mouse-2, RET: describe this face"))

(define-button-type 'help-coding-system
  :supertype 'help-xref
  'help-function 'describe-coding-system
  'help-echo (purecopy "mouse-2, RET: describe this coding system"))

(define-button-type 'help-input-method
  :supertype 'help-xref
  'help-function 'describe-input-method
  'help-echo (purecopy "mouse-2, RET: describe this input method"))

(define-button-type 'help-character-set
  :supertype 'help-xref
  'help-function 'describe-character-set
  'help-echo (purecopy "mouse-2, RET: describe this character set"))
142 143 144 145

;; make some more ideosyncratic button types

(define-button-type 'help-symbol
Miles Bader's avatar
Miles Bader committed
146
  :supertype 'help-xref
147
  'help-function #'help-xref-interned
Miles Bader's avatar
Miles Bader committed
148
  'help-echo (purecopy "mouse-2, RET: describe this symbol"))
149 150

(define-button-type 'help-back
Miles Bader's avatar
Miles Bader committed
151
  :supertype 'help-xref
152
  'help-function #'help-xref-go-back
Miles Bader's avatar
Miles Bader committed
153
  'help-echo (purecopy "mouse-2, RET: go back to previous help buffer"))
154

Nick Roberts's avatar
Nick Roberts committed
155 156 157 158 159
(define-button-type 'help-forward
  :supertype 'help-xref
  'help-function #'help-xref-go-forward
  'help-echo (purecopy "mouse-2, RET: move forward to next help buffer"))

160 161 162 163 164 165
(define-button-type 'help-info-variable
  :supertype 'help-xref
  ;; the name of the variable is put before the argument to Info
  'help-function (lambda (a v) (info v))
  'help-echo (purecopy "mouse-2, RET: read this Info node"))

166
(define-button-type 'help-info
Miles Bader's avatar
Miles Bader committed
167
  :supertype 'help-xref
168
  'help-function #'info
169 170 171 172 173 174
  'help-echo (purecopy "mouse-2, RET: read this Info node"))

(define-button-type 'help-url
  :supertype 'help-xref
  'help-function #'browse-url
  'help-echo (purecopy "mouse-2, RET: view this URL in a browser"))
175 176

(define-button-type 'help-customize-variable
Miles Bader's avatar
Miles Bader committed
177
  :supertype 'help-xref
178 179
  'help-function (lambda (v)
		   (customize-variable v))
Miles Bader's avatar
Miles Bader committed
180
  'help-echo (purecopy "mouse-2, RET: customize variable"))
181

182
(define-button-type 'help-customize-face
Miles Bader's avatar
Miles Bader committed
183
  :supertype 'help-xref
184 185
  'help-function (lambda (v)
		   (customize-face v))
Miles Bader's avatar
Miles Bader committed
186
  'help-echo (purecopy "mouse-2, RET: customize face"))
187

188
(define-button-type 'help-function-def
Miles Bader's avatar
Miles Bader committed
189
  :supertype 'help-xref
190 191
  'help-function (lambda (fun file)
		   (require 'find-func)
192 193 194
		   (when (eq file 'C-source)
		     (setq file
			   (help-C-file-name (indirect-function fun) 'fun)))
Stefan Monnier's avatar
Stefan Monnier committed
195
		   ;; Don't use find-function-noselect because it follows
196
		   ;; aliases (which fails for built-in functions).
Stefan Monnier's avatar
Stefan Monnier committed
197
		   (let ((location
198
			  (find-function-search-for-symbol fun nil file)))
199
		     (pop-to-buffer (car location))
200 201 202
		     (if (cdr location)
			 (goto-char (cdr location))
		       (message "Unable to find location in file"))))
Miles Bader's avatar
Miles Bader committed
203
  'help-echo (purecopy "mouse-2, RET: find function's definition"))
204

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
(define-button-type 'help-function-cmacro
  :supertype 'help-xref
  'help-function (lambda (fun file)
		   (setq file (locate-library file t))
		   (if (and file (file-readable-p file))
		       (progn
			 (pop-to-buffer (find-file-noselect file))
			 (goto-char (point-min))
			 (if (re-search-forward
			      (format "^[ \t]*(define-compiler-macro[ \t]+%s"
				      (regexp-quote (symbol-name fun))) nil t)
			     (forward-line 0)
			   (message "Unable to find location in file")))
		     (message "Unable to find file")))
  'help-echo (purecopy "mouse-2, RET: find function's compiler macro"))

221
(define-button-type 'help-variable-def
Miles Bader's avatar
Miles Bader committed
222
  :supertype 'help-xref
223
  'help-function (lambda (var &optional file)
224 225 226
		   (when (eq file 'C-source)
		     (setq file (help-C-file-name var 'var)))
		   (let ((location (find-variable-noselect var file)))
227
		     (pop-to-buffer (car location))
228 229 230
		     (if (cdr location)
		       (goto-char (cdr location))
		       (message "Unable to find location in file"))))
Kim F. Storm's avatar
Kim F. Storm committed
231
  'help-echo (purecopy "mouse-2, RET: find variable's definition"))
232

233 234 235 236 237 238 239 240 241
(define-button-type 'help-face-def
  :supertype 'help-xref
  'help-function (lambda (fun file)
		   (require 'find-func)
		   ;; Don't use find-function-noselect because it follows
		   ;; aliases (which fails for built-in functions).
		   (let ((location
			  (find-function-search-for-symbol fun 'defface file)))
		     (pop-to-buffer (car location))
242 243 244
		     (if (cdr location)
			 (goto-char (cdr location))
		       (message "Unable to find location in file"))))
245 246
  'help-echo (purecopy "mouse-2, RET: find face's definition"))

247 248

;;;###autoload
249
(defun help-mode ()
250 251 252 253
  "Major mode for viewing help text and navigating references in it.
Entry to this mode runs the normal hook `help-mode-hook'.
Commands:
\\{help-mode-map}"
254 255 256 257 258
  (interactive)
  (kill-all-local-variables)
  (use-local-map help-mode-map)
  (setq mode-name "Help")
  (setq major-mode 'help-mode)
259

260
  (view-mode)
261 262 263 264 265 266 267 268 269 270 271 272 273 274
  (set (make-local-variable 'view-no-disable-on-exit) t)
  ;; With Emacs 22 `view-exit-action' could delete the selected window
  ;; disregarding whether the help buffer was shown in that window at
  ;; all.  Since `view-exit-action' is called with the help buffer as
  ;; argument it seems more appropriate to have it work on the buffer
  ;; only and leave it to `view-mode-exit' to delete any associated
  ;; window(s).
  (setq view-exit-action
	(lambda (buffer)
	  ;; Use `with-current-buffer' to make sure that `bury-buffer'
	  ;; also removes BUFFER from the selected window.
	  (with-current-buffer buffer
	    (bury-buffer))))

275
  (run-mode-hooks 'help-mode-hook))
276 277 278 279 280 281 282 283

;;;###autoload
(defun help-mode-setup ()
  (help-mode)
  (setq buffer-read-only nil))

;;;###autoload
(defun help-mode-finish ()
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
  (if (eq help-window t)
      ;; If `help-window' is t, `view-return-to-alist' is handled by
      ;; `with-help-window'.  In this case set `help-window' to the
      ;; selected window since now is the only moment where we can
      ;; unambiguously identify it.
      (setq help-window (selected-window))
    (let ((entry (assq (selected-window) view-return-to-alist)))
      (if entry
	  ;; When entering Help mode from the Help window,
	  ;; such as by following a link, preserve the same
	  ;; meaning for the q command.
	  ;; (setcdr entry (cons (selected-window) help-return-method))
	  nil
	(setq view-return-to-alist
	      (cons (cons (selected-window) help-return-method)
		    view-return-to-alist)))))

301 302 303 304
  (when (eq major-mode 'help-mode)
    ;; View mode's read-only status of existing *Help* buffer is lost
    ;; by with-output-to-temp-buffer.
    (toggle-read-only 1)
305
    (help-make-xrefs (current-buffer))))
306

Stefan Monnier's avatar
Stefan Monnier committed
307 308
;; Grokking cross-reference information in doc strings and
;; hyperlinking it.
309 310 311 312 313 314 315 316

;; This may have some scope for extension and the same or something
;; similar should be done for widget doc strings, which currently use
;; another mechanism.

(defvar help-back-label (purecopy "[back]")
  "Label to use by `help-make-xrefs' for the go-back reference.")

Nick Roberts's avatar
Nick Roberts committed
317 318 319
(defvar help-forward-label (purecopy "[forward]")
  "Label to use by `help-make-xrefs' for the go-forward reference.")

320
(defconst help-xref-symbol-regexp
321
  (purecopy (concat "\\(\\<\\(\\(variable\\|option\\)\\|"  ; Link to var
322 323 324
 		    "\\(function\\|command\\)\\|"          ; Link to function
 		    "\\(face\\)\\|"			   ; Link to face
 		    "\\(symbol\\|program\\|property\\)\\|" ; Don't link
325 326
		    "\\(source \\(?:code \\)?\\(?:of\\|for\\)\\)\\)"
		    "[ \t\n]+\\)?"
327 328 329 330 331 332 333
		    ;; Note starting with word-syntax character:
		    "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'"))
  "Regexp matching doc string references to symbols.

The words preceding the quoted symbol can be used in doc strings to
distinguish references to variables, functions and symbols.")

Stefan Monnier's avatar
Stefan Monnier committed
334
(defvar help-xref-mule-regexp nil
335 336 337 338 339 340 341 342
  "Regexp matching doc string references to MULE-related keywords.

It is usually nil, and is temporarily bound to an appropriate regexp
when help commands related to multilingual environment (e.g.,
`describe-coding-system') are invoked.")


(defconst help-xref-info-regexp
343
  (purecopy "\\<[Ii]nfo[ \t\n]+\\(node\\|anchor\\)[ \t\n]+`\\([^']+\\)'")
344 345
  "Regexp matching doc string references to an Info node.")

346 347 348 349
(defconst help-xref-url-regexp
  (purecopy "\\<[Uu][Rr][Ll][ \t\n]+`\\([^']+\\)'")
  "Regexp matching doc string references to a URL.")

350 351 352 353 354 355 356
;;;###autoload
(defun help-setup-xref (item interactive-p)
  "Invoked from commands using the \"*Help*\" buffer to install some xref info.

ITEM is a (FUNCTION . ARGS) pair appropriate for recreating the help
buffer after following a reference.  INTERACTIVE-P is non-nil if the
calling command was invoked interactively.  In this case the stack of
Stefan Monnier's avatar
Stefan Monnier committed
357 358 359 360 361 362
items for help buffer \"back\" buttons is cleared.

This should be called very early, before the output buffer is cleared,
because we want to record the \"previous\" position of point so we can
restore it properly when going back."
  (with-current-buffer (help-buffer)
Stefan Monnier's avatar
Stefan Monnier committed
363
    (when help-xref-stack-item
Nick Roberts's avatar
Nick Roberts committed
364 365
      (push (cons (point) help-xref-stack-item) help-xref-stack)
      (setq help-xref-forward-stack nil))
Stefan Monnier's avatar
Stefan Monnier committed
366 367 368 369
    (when interactive-p
      (let ((tail (nthcdr 10 help-xref-stack)))
	;; Truncate the stack.
	(if tail (setcdr tail nil))))
Stefan Monnier's avatar
Stefan Monnier committed
370
    (setq help-xref-stack-item item)))
371 372 373 374

(defvar help-xref-following nil
  "Non-nil when following a help cross-reference.")

375
;;;###autoload
Stefan Monnier's avatar
Stefan Monnier committed
376
(defun help-buffer ()
Chong Yidong's avatar
Chong Yidong committed
377 378 379 380 381
  "Return the name of a buffer for inserting help.
If `help-xref-following' is non-nil, this is the name of the
current buffer.
Otherwise, it is *Help*; if no buffer with that name currently
exists, it is created."
Stefan Monnier's avatar
Stefan Monnier committed
382 383 384 385 386
  (buffer-name				;for with-output-to-temp-buffer
   (if help-xref-following
       (current-buffer)
     (get-buffer-create "*Help*"))))

Stefan Monnier's avatar
Stefan Monnier committed
387 388 389 390 391 392 393
(defvar help-xref-override-view-map
  (let ((map (make-sparse-keymap)))
    (set-keymap-parent map view-mode-map)
    (define-key map "\r" nil)
    map)
  "Replacement keymap for `view-mode' in help buffers.")

394 395 396 397
;;;###autoload
(defun help-make-xrefs (&optional buffer)
  "Parse and hyperlink documentation cross-references in the given BUFFER.

398 399 400 401
Find cross-reference information in a buffer and activate such cross
references for selection with `help-follow'.  Cross-references have
the canonical form `...'  and the type of reference may be
disambiguated by the preceding word(s) used in
402 403 404
`help-xref-symbol-regexp'.  Faces only get cross-referenced if
preceded or followed by the word `face'.  Variables without
variable documentation do not get cross-referenced, unless
405
preceded by the word `variable' or `option'.
406 407 408 409 410 411 412 413 414 415

If the variable `help-xref-mule-regexp' is non-nil, find also
cross-reference information related to multilingual environment
\(e.g., coding-systems).  This variable is also used to disambiguate
the type of reference as the same way as `help-xref-symbol-regexp'.

A special reference `back' is made to return back through a stack of
help buffers.  Variable `help-back-label' specifies the text for
that."
  (interactive "b")
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
  (with-current-buffer (or buffer (current-buffer))
    (save-excursion
      (goto-char (point-min))
      ;; Skip the header-type info, though it might be useful to parse
      ;; it at some stage (e.g. "function in `library'").
      (forward-paragraph)
      (let ((old-modified (buffer-modified-p)))
        (let ((stab (syntax-table))
              (case-fold-search t)
              (inhibit-read-only t))
          (set-syntax-table emacs-lisp-mode-syntax-table)
          ;; The following should probably be abstracted out.
          (unwind-protect
              (progn
                ;; Info references
                (save-excursion
                  (while (re-search-forward help-xref-info-regexp nil t)
                    (let ((data (match-string 2)))
                      (save-match-data
                        (unless (string-match "^([^)]+)" data)
                          (setq data (concat "(emacs)" data))))
                      (help-xref-button 2 'help-info data))))
                ;; URLs
                (save-excursion
                  (while (re-search-forward help-xref-url-regexp nil t)
                    (let ((data (match-string 1)))
                      (help-xref-button 1 'help-url data))))
                ;; Mule related keywords.  Do this before trying
                ;; `help-xref-symbol-regexp' because some of Mule
                ;; keywords have variable or function definitions.
                (if help-xref-mule-regexp
                    (save-excursion
                      (while (re-search-forward help-xref-mule-regexp nil t)
                        (let* ((data (match-string 7))
                               (sym (intern-soft data)))
                          (cond
                           ((match-string 3) ; coding system
                            (and sym (coding-system-p sym)
                                 (help-xref-button 6 'help-coding-system sym)))
                           ((match-string 4) ; input method
                            (and (assoc data input-method-alist)
                                 (help-xref-button 7 'help-input-method data)))
                           ((or (match-string 5) (match-string 6)) ; charset
                            (and sym (charsetp sym)
                                 (help-xref-button 7 'help-character-set sym)))
                           ((assoc data input-method-alist)
                            (help-xref-button 7 'help-character-set data))
                           ((and sym (coding-system-p sym))
                            (help-xref-button 7 'help-coding-system sym))
                           ((and sym (charsetp sym))
                            (help-xref-button 7 'help-character-set sym)))))))
                ;; Quoted symbols
                (save-excursion
                  (while (re-search-forward help-xref-symbol-regexp nil t)
                    (let* ((data (match-string 8))
                           (sym (intern-soft data)))
                      (if sym
                          (cond
                           ((match-string 3) ; `variable' &c
                            (and (or (boundp sym) ; `variable' doesn't ensure
476
                                        ; it's actually bound
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
                                     (get sym 'variable-documentation))
                                 (help-xref-button 8 'help-variable sym)))
                           ((match-string 4) ; `function' &c
                            (and (fboundp sym) ; similarly
                                 (help-xref-button 8 'help-function sym)))
                           ((match-string 5) ; `face'
                            (and (facep sym)
                                 (help-xref-button 8 'help-face sym)))
                           ((match-string 6)) ; nothing for `symbol'
                           ((match-string 7)
                            ;; this used:
                            ;; #'(lambda (arg)
                            ;;     (let ((location
                            ;;            (find-function-noselect arg)))
                            ;;       (pop-to-buffer (car location))
                            ;; 	(goto-char (cdr location))))
                            (help-xref-button 8 'help-function-def sym))
                           ((and
                             (facep sym)
                             (save-match-data (looking-at "[ \t\n]+face\\W")))
                            (help-xref-button 8 'help-face sym))
                           ((and (or (boundp sym)
                                     (get sym 'variable-documentation))
                                 (fboundp sym))
                            ;; We can't intuit whether to use the
                            ;; variable or function doc -- supply both.
                            (help-xref-button 8 'help-symbol sym))
                           ((and
                             (or (boundp sym)
                                 (get sym 'variable-documentation))
                             (or
                              (documentation-property
                               sym 'variable-documentation)
                              (condition-case nil
                                  (documentation-property
                                   (indirect-variable sym)
                                   'variable-documentation)
                                (cyclic-variable-indirection nil))))
                            (help-xref-button 8 'help-variable sym))
                           ((fboundp sym)
                            (help-xref-button 8 'help-function sym)))))))
                ;; An obvious case of a key substitution:
                (save-excursion
                  (while (re-search-forward
                          ;; Assume command name is only word and symbol
                          ;; characters to get things like `use M-x foo->bar'.
                          ;; Command required to end with word constituent
                          ;; to avoid `.' at end of a sentence.
                          "\\<M-x\\s-+\\(\\sw\\(\\sw\\|\\s_\\)*\\sw\\)" nil t)
                    (let ((sym (intern-soft (match-string 1))))
                      (if (fboundp sym)
                          (help-xref-button 1 'help-function sym)))))
                ;; Look for commands in whole keymap substitutions:
                (save-excursion
                  ;; Make sure to find the first keymap.
                  (goto-char (point-min))
                  ;; Find a header and the column at which the command
                  ;; name will be found.

                  ;; If the keymap substitution isn't the last thing in
                  ;; the doc string, and if there is anything on the same
                  ;; line after it, this code won't recognize the end of it.
                  (while (re-search-forward "^key +binding\n\\(-+ +\\)-+\n\n"
                                            nil t)
                    (let ((col (- (match-end 1) (match-beginning 1))))
                      (while
                          (and (not (eobp))
                               ;; Stop at a pair of blank lines.
                               (not (looking-at "\n\\s-*\n")))
                        ;; Skip a single blank line.
                        (and (eolp) (forward-line))
                        (end-of-line)
                        (skip-chars-backward "^ \t\n")
                        (if (and (>= (current-column) col)
                                 (looking-at "\\(\\sw\\|\\s_\\)+$"))
                            (let ((sym (intern-soft (match-string 0))))
                              (if (fboundp sym)
                                  (help-xref-button 0 'help-function sym))))
                        (forward-line))))))
            (set-syntax-table stab))
          ;; Delete extraneous newlines at the end of the docstring
          (goto-char (point-max))
          (while (and (not (bobp)) (bolp))
            (delete-char -1))
          (insert "\n")
          (when (or help-xref-stack help-xref-forward-stack)
            (insert "\n"))
          ;; Make a back-reference in this buffer if appropriate.
          (when help-xref-stack
            (help-insert-xref-button help-back-label 'help-back
                                     (current-buffer)))
          ;; Make a forward-reference in this buffer if appropriate.
          (when help-xref-forward-stack
            (when help-xref-stack
              (insert "\t"))
            (help-insert-xref-button help-forward-label 'help-forward
                                     (current-buffer)))
          (when (or help-xref-stack help-xref-forward-stack)
            (insert "\n")))
        ;; View mode steals RET from us.
        (set (make-local-variable 'minor-mode-overriding-map-alist)
             (list (cons 'view-mode help-xref-override-view-map)))
        (set-buffer-modified-p old-modified)))))
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

;;;###autoload
(defun help-xref-button (match-number type &rest args)
  "Make a hyperlink for cross-reference text previously matched.
MATCH-NUMBER is the subexpression of interest in the last matched
regexp.  TYPE is the type of button to use.  Any remaining arguments are
passed to the button's help-function when it is invoked.
See `help-make-xrefs'."
  ;; Don't mung properties we've added specially in some instances.
  (unless (button-at (match-beginning match-number))
    (make-text-button (match-beginning match-number)
		      (match-end match-number)
		      'type type 'help-args args)))

;;;###autoload
(defun help-insert-xref-button (string type &rest args)
  "Insert STRING and make a hyperlink from cross-reference text on it.
TYPE is the type of button to use.  Any remaining arguments are passed
to the button's help-function when it is invoked.
See `help-make-xrefs'."
  (unless (button-at (point))
    (insert-text-button string 'type type 'help-args args)))

;;;###autoload
(defun help-xref-on-pp (from to)
  "Add xrefs for symbols in `pp's output between FROM and TO."
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
  (if (> (- to from) 5000) nil
    (with-syntax-table emacs-lisp-mode-syntax-table
      (save-excursion
	(save-restriction
	  (narrow-to-region from to)
	  (goto-char (point-min))
	  (condition-case nil
	      (while (not (eobp))
		(cond
		 ((looking-at "\"") (forward-sexp 1))
		 ((looking-at "#<") (search-forward ">" nil 'move))
		 ((looking-at "\\(\\(\\sw\\|\\s_\\)+\\)")
		  (let* ((sym (intern-soft (match-string 1)))
			 (type (cond ((fboundp sym) 'help-function)
				     ((or (memq sym '(t nil))
					  (keywordp sym))
				      nil)
623 624 625 626
				     ((and sym
					   (or (boundp sym)
					       (get sym
						    'variable-documentation)))
627 628 629 630 631
				      'help-variable))))
		    (when type (help-xref-button 1 type sym)))
		  (goto-char (match-end 1)))
		 (t (forward-char 1))))
	    (error nil)))))))
632 633 634 635 636


;; Additional functions for (re-)creating types of help buffers.
(defun help-xref-interned (symbol)
  "Follow a hyperlink which appeared to be an arbitrary interned SYMBOL.
Stefan Monnier's avatar
Stefan Monnier committed
637
Both variable, function and face documentation are extracted into a single
638
help buffer."
Stefan Monnier's avatar
Stefan Monnier committed
639 640
  (with-current-buffer (help-buffer)
    ;; Push the previous item on the stack before clobbering the output buffer.
641
    (help-setup-xref nil nil)
Stefan Monnier's avatar
Stefan Monnier committed
642 643 644 645 646 647 648 649
    (let ((facedoc (when (facep symbol)
		     ;; Don't record the current entry in the stack.
		     (setq help-xref-stack-item nil)
		     (describe-face symbol)))
	  (fdoc (when (fboundp symbol)
		  ;; Don't record the current entry in the stack.
		  (setq help-xref-stack-item nil)
		  (describe-function symbol)))
650 651
	  (sdoc (when (or (boundp symbol)
			  (get symbol 'variable-documentation))
Stefan Monnier's avatar
Stefan Monnier committed
652 653 654 655 656 657 658
		  ;; Don't record the current entry in the stack.
		  (setq help-xref-stack-item nil)
		  (describe-variable symbol))))
      (cond
       (sdoc
	;; We now have a help buffer on the variable.
	;; Insert the function and face text before it.
Richard M. Stallman's avatar
Richard M. Stallman committed
659
	(when (or fdoc facedoc)
660 661 662
	  (goto-char (point-min))
	  (let ((inhibit-read-only t))
	    (when fdoc
Stefan Monnier's avatar
Stefan Monnier committed
663
	      (insert fdoc "\n\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
664 665
	      (when facedoc
		(insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
Stefan Monnier's avatar
Stefan Monnier committed
666 667 668
			" is also a " "face." "\n\n")))
	    (when facedoc
	      (insert facedoc "\n\n"))
669 670
	    (insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
		    " is also a " "variable." "\n\n"))
Stefan Monnier's avatar
Stefan Monnier committed
671 672 673 674 675 676 677 678 679 680 681 682 683 684
	  ;; Don't record the `describe-variable' item in the stack.
	  (setq help-xref-stack-item nil)
	  (help-setup-xref (list #'help-xref-interned symbol) nil)))
       (fdoc
	;; We now have a help buffer on the function.
	;; Insert face text before it.
	(when facedoc
	  (goto-char (point-max))
	  (let ((inhibit-read-only t))
	    (insert "\n\n" (make-string 30 ?-) "\n\n" (symbol-name symbol)
		    " is also a " "face." "\n\n" facedoc))
	  ;; Don't record the `describe-function' item in the stack.
	  (setq help-xref-stack-item nil)
	  (help-setup-xref (list #'help-xref-interned symbol) nil)))))))
685 686


Stefan Monnier's avatar
Stefan Monnier committed
687
;; Navigation/hyperlinking with xrefs
688 689 690 691 692

(defun help-xref-go-back (buffer)
  "From BUFFER, go back to previous help buffer text using `help-xref-stack'."
  (let (item position method args)
    (with-current-buffer buffer
Nick Roberts's avatar
Nick Roberts committed
693
      (push (cons (point) help-xref-stack-item) help-xref-forward-stack)
694 695
      (when help-xref-stack
	(setq item (pop help-xref-stack)
Stefan Monnier's avatar
Stefan Monnier committed
696 697 698 699
	      ;; Clear the current item so that it won't get pushed
	      ;; by the function we're about to call.  TODO: We could also
	      ;; push it onto a "forward" stack and add a `forw' button.
	      help-xref-stack-item nil
700 701 702 703
	      position (car item)
	      method (cadr item)
	      args (cddr item))))
    (apply method args)
704 705 706 707
    (with-current-buffer buffer
      (if (get-buffer-window buffer)
	  (set-window-point (get-buffer-window buffer) position)
	(goto-char position)))))
708

Nick Roberts's avatar
Nick Roberts committed
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
(defun help-xref-go-forward (buffer)
  "From BUFFER, go forward to next help buffer."
  (let (item position method args)
    (with-current-buffer buffer
      (push (cons (point) help-xref-stack-item) help-xref-stack)
      (when help-xref-forward-stack
	(setq item (pop help-xref-forward-stack)
	      ;; Clear the current item so that it won't get pushed
	      ;; by the function we're about to call.  TODO: We could also
	      ;; push it onto a "forward" stack and add a `forw' button.
	      help-xref-stack-item nil
	      position (car item)
	      method (cadr item)
	      args (cddr item))))
    (apply method args)
    (with-current-buffer buffer
      (if (get-buffer-window buffer)
	  (set-window-point (get-buffer-window buffer) position)
	(goto-char position)))))
728

729
(defun help-go-back ()
730
  "Go back to previous topic in this help buffer."
731
  (interactive)
732 733
  (if help-xref-stack
      (help-xref-go-back (current-buffer))
734
    (error "No previous help buffer")))
735

Nick Roberts's avatar
Nick Roberts committed
736 737 738 739 740 741
(defun help-go-forward ()
  "Go back to next topic in this help buffer."
  (interactive)
  (if help-xref-forward-stack
      (help-xref-go-forward (current-buffer))
    (error "No next help buffer")))
742 743 744 745 746 747 748 749 750

(defun help-do-xref (pos function args)
  "Call the help cross-reference function FUNCTION with args ARGS.
Things are set up properly so that the resulting help-buffer has
a proper [back] button."
  ;; There is a reference at point.  Follow it.
  (let ((help-xref-following t))
    (apply function args)))

751 752 753 754 755 756 757 758 759
;; The doc string is meant to explain what buttons do.
(defun help-follow-mouse ()
  "Follow the cross-reference that you click on."
  (interactive)
  (error "No cross-reference here"))

;; The doc string is meant to explain what buttons do.
(defun help-follow ()
  "Follow cross-reference at point.
760 761

For the cross-reference format, see `help-make-xrefs'."
762 763 764 765 766 767
  (interactive)
  (error "No cross-reference here"))

(defun help-follow-symbol (&optional pos)
  "In help buffer, show docs for symbol at POS, defaulting to point.
Show all docs for that symbol as either a variable, function or face."
768 769 770
  (interactive "d")
  (unless pos
    (setq pos (point)))
771 772 773 774 775 776 777 778 779 780 781 782
  ;; check if the symbol under point is a function, variable or face
  (let ((sym
	 (intern
	  (save-excursion
	    (goto-char pos) (skip-syntax-backward "w_")
	    (buffer-substring (point)
			      (progn (skip-syntax-forward "w_")
				     (point)))))))
    (when (or (boundp sym)
	      (get sym 'variable-documentation)
	      (fboundp sym) (facep sym))
      (help-do-xref pos #'help-xref-interned (list sym)))))
783

784 785 786 787 788 789 790 791 792
(defun help-insert-string (string)
  "Insert STRING to the help buffer and install xref info for it.
This function can be used to restore the old contents of the help buffer
when going back to the previous topic in the xref stack.  It is needed
in case when it is impossible to recompute the old contents of the
help buffer by other means."
  (setq help-xref-stack-item (list #'help-insert-string string))
  (with-output-to-temp-buffer (help-buffer)
    (insert string)))
793 794 795

(provide 'help-mode)

796
;; arch-tag: 850954ae-3725-4cb4-8e91-0bf6d52d6b0b
797
;;; help-mode.el ends here