help-mode.el 22.3 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, 2004
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
;;   Free Software Foundation, Inc.

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

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; 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
34
(require 'view)
35 36 37 38 39 40

(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
41
(define-key help-mode-map [mouse-2] 'help-follow-mouse)
42 43 44 45 46 47 48 49
(define-key help-mode-map "\C-c\C-b" 'help-go-back)
(define-key help-mode-map "\C-c\C-c" 'help-follow)
;; Documentation only, since we use minor-mode-overriding-map-alist.
(define-key help-mode-map "\r" 'help-follow)

(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
50 51
An element looks like (POSITION FUNCTION ARGS...).
To use the element, do (apply FUNCTION ARGS) then goto the point.")
52
(put 'help-xref-stack 'permanent-local t)
Stefan Monnier's avatar
Stefan Monnier committed
53
(make-variable-buffer-local 'help-xref-stack)
54 55 56 57 58

(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
59
(make-variable-buffer-local 'help-xref-stack-item)
60 61 62

(setq-default help-xref-stack nil help-xref-stack-item nil)

63 64 65 66
(defcustom help-mode-hook nil
  "Hook run by `help-mode'."
  :type 'hook
  :group 'help)
67 68 69

;; Button types used by help

Miles Bader's avatar
Miles Bader committed
70 71 72 73 74 75 76 77 78
(define-button-type 'help-xref
  '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)))

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
;; 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"))
112 113 114 115

;; make some more ideosyncratic button types

(define-button-type 'help-symbol
Miles Bader's avatar
Miles Bader committed
116
  :supertype 'help-xref
117
  'help-function #'help-xref-interned
Miles Bader's avatar
Miles Bader committed
118
  'help-echo (purecopy "mouse-2, RET: describe this symbol"))
119 120

(define-button-type 'help-back
Miles Bader's avatar
Miles Bader committed
121
  :supertype 'help-xref
122
  'help-function #'help-xref-go-back
Miles Bader's avatar
Miles Bader committed
123
  'help-echo (purecopy "mouse-2, RET: go back to previous help buffer"))
124 125

(define-button-type 'help-info
Miles Bader's avatar
Miles Bader committed
126
  :supertype 'help-xref
127
  'help-function #'info
Miles Bader's avatar
Miles Bader committed
128
  'help-echo (purecopy"mouse-2, RET: read this Info node"))
129 130

(define-button-type 'help-customize-variable
Miles Bader's avatar
Miles Bader committed
131
  :supertype 'help-xref
132 133 134 135
  'help-function (lambda (v)
		   (if help-xref-stack
		       (pop help-xref-stack))
		   (customize-variable v))
Miles Bader's avatar
Miles Bader committed
136
  'help-echo (purecopy "mouse-2, RET: customize variable"))
137

138
(define-button-type 'help-customize-face
Miles Bader's avatar
Miles Bader committed
139
  :supertype 'help-xref
140 141 142 143
  'help-function (lambda (v)
		   (if help-xref-stack
		       (pop help-xref-stack))
		   (customize-face v))
Miles Bader's avatar
Miles Bader committed
144
  'help-echo (purecopy "mouse-2, RET: customize face"))
145

146
(define-button-type 'help-function-def
Miles Bader's avatar
Miles Bader committed
147
  :supertype 'help-xref
148 149
  'help-function (lambda (fun file)
		   (require 'find-func)
Stefan Monnier's avatar
Stefan Monnier committed
150
		   ;; Don't use find-function-noselect because it follows
151
		   ;; aliases (which fails for built-in functions).
Stefan Monnier's avatar
Stefan Monnier committed
152
		   (let ((location
153 154 155 156 157
			  (cond
			   ((bufferp file) (cons file fun))
			   ((string-match "\\`src/\\(.*\\.c\\)" file)
			    (help-find-C-source fun (match-string 1 file) 'fun))
			   (t (find-function-search-for-symbol fun nil file)))))
158 159
		     (pop-to-buffer (car location))
		     (goto-char (cdr location))))
Miles Bader's avatar
Miles Bader committed
160
  'help-echo (purecopy "mouse-2, RET: find function's definition"))
161 162

(define-button-type 'help-variable-def
Miles Bader's avatar
Miles Bader committed
163
  :supertype 'help-xref
164 165
  'help-function (lambda (var &optional file)
		   (let ((location
166 167 168 169
			  (cond
			   ((string-match "\\`src/\\(.*\\.c\\)" file)
			    (help-find-C-source var (match-string 1 file) 'var))
			   (t (find-variable-noselect var file)))))
170 171
		     (pop-to-buffer (car location))
		     (goto-char (cdr location))))
Miles Bader's avatar
Miles Bader committed
172
  'help-echo (purecopy"mouse-2, RET: find variable's definition"))
173 174 175


;;;###autoload
176
(defun help-mode ()
177 178 179 180
  "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}"
181 182 183 184 185
  (interactive)
  (kill-all-local-variables)
  (use-local-map help-mode-map)
  (setq mode-name "Help")
  (setq major-mode 'help-mode)
186 187
  (view-mode)
  (make-local-variable 'view-no-disable-on-exit)
188 189
  (setq view-no-disable-on-exit t)
  (run-hooks 'help-mode-hook))
190 191 192 193 194 195 196 197

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

;;;###autoload
(defun help-mode-finish ()
198 199 200 201 202 203
  (let ((entry (assq (selected-window) view-return-to-alist)))
	(if entry (setcdr entry (cons (selected-window)
				      help-return-method))
	  (setq view-return-to-alist
		(cons (cons (selected-window) help-return-method)
		      view-return-to-alist))))
204 205 206 207
  (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)
208
    (help-make-xrefs (current-buffer))))
209

Stefan Monnier's avatar
Stefan Monnier committed
210 211
;; Grokking cross-reference information in doc strings and
;; hyperlinking it.
212 213 214 215 216 217 218 219 220 221 222 223 224

;; 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.")

(defconst help-xref-symbol-regexp
  (purecopy (concat "\\(\\<\\(\\(variable\\|option\\)\\|"
		    "\\(function\\|command\\)\\|"
		    "\\(face\\)\\|"
		    "\\(symbol\\)\\|"
225 226
		    "\\(source \\(?:code \\)?\\(?:of\\|for\\)\\)\\)"
		    "[ \t\n]+\\)?"
227 228 229 230 231 232 233
		    ;; 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
234
(defvar help-xref-mule-regexp nil
235 236 237 238 239 240 241 242
  "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
243
  (purecopy "\\<[Ii]nfo[ \t\n]+\\(node\\|anchor\\)[ \t\n]+`\\([^']+\\)'")
244 245 246 247 248 249 250 251 252
  "Regexp matching doc string references to an Info node.")

;;;###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
253 254 255 256 257 258
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
259 260 261 262 263 264
    (when help-xref-stack-item
      (push (cons (point) help-xref-stack-item) help-xref-stack))
    (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
265
    (setq help-xref-stack-item item)))
266 267 268 269

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

Stefan Monnier's avatar
Stefan Monnier committed
270 271 272 273 274 275
(defun help-buffer ()
  (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
276 277 278 279 280 281 282
(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.")

283 284 285 286
;;;###autoload
(defun help-make-xrefs (&optional buffer)
  "Parse and hyperlink documentation cross-references in the given BUFFER.

287 288 289 290
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
291 292 293
`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
294
preceded by the word `variable' or `option'.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

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")
  (save-excursion
    (set-buffer (or buffer (current-buffer)))
    (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)
322
                  (let ((data (match-string 2)))
323 324 325
		    (save-match-data
		      (unless (string-match "^([^)]+)" data)
			(setq data (concat "(emacs)" data))))
326
		    (help-xref-button 2 'help-info data))))
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
	      ;; 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
358
                         ((match-string 3)  ; `variable' &c
359 360 361
                          (and (boundp sym) ; `variable' doesn't ensure
                                        ; it's actually bound
                               (help-xref-button 8 'help-variable sym)))
362
                         ((match-string 4)   ; `function' &c
363 364 365 366 367 368 369
                          (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)
370 371 372 373 374 375
;;;  this used:
;;; 			  #'(lambda (arg)
;;; 			      (let ((location
;;; 				     (find-function-noselect arg)))
;;; 				(pop-to-buffer (car location))
;;; 				(goto-char (cdr location))))
376
			  (help-xref-button 8 'help-function-def sym))
377 378 379
			 ((facep sym)
			  (if (save-match-data (looking-at "[ \t\n]+face\\W"))
			      (help-xref-button 8 'help-face sym)))
380 381 382 383
                         ((and (boundp sym) (fboundp sym))
                          ;; We can't intuit whether to use the
                          ;; variable or function doc -- supply both.
                          (help-xref-button 8 'help-symbol sym))
384 385
                         ((and
			   (boundp sym)
386 387 388 389 390 391 392 393
 			   (or
 			    (documentation-property
 			     sym 'variable-documentation)
 			    (condition-case nil
 				(documentation-property
 				 (indirect-variable sym)
 				 'variable-documentation)
 			      (cyclic-variable-indirection nil))))
394 395
			  (help-xref-button 8 'help-variable sym))
			 ((fboundp sym)
396
			  (help-xref-button 8 'help-function sym)))))))
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
              ;; An obvious case of a key substitution:
              (save-excursion
                (while (re-search-forward
			;; Assume command name is only word characters
			;; and dashes to get things like `use M-x foo.'.
                        "\\<M-x\\s-+\\(\\sw\\(\\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.
412 413 414 415

		;; 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.
416 417 418 419
                (while (re-search-forward "^key +binding\n\\(-+ +\\)-+\n\n"
                                          nil t)
                  (let ((col (- (match-end 1) (match-beginning 1))))
                    (while
420 421 422 423 424 425 426 427 428 429 430 431
                        (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\\|-\\)+$"))
			  (let ((sym (intern-soft (match-string 0))))
			    (if (fboundp sym)
				(help-xref-button 0 'help-function sym))))
432 433
		      (forward-line))))))
	  (set-syntax-table stab))
434 435 436 437
	;; Delete extraneous newlines at the end of the docstring
	(goto-char (point-max))
	(while (and (not (bobp)) (bolp))
	  (delete-char -1))
438
        (insert "\n")
439
        ;; Make a back-reference in this buffer if appropriate.
Stefan Monnier's avatar
Stefan Monnier committed
440
        (when help-xref-stack
441
	  (insert "\n")
442
	  (help-insert-xref-button help-back-label 'help-back
443 444
				   (current-buffer))
          (insert "\n")))
445 446
      ;; View mode steals RET from us.
      (set (make-local-variable 'minor-mode-overriding-map-alist)
Stefan Monnier's avatar
Stefan Monnier committed
447
           (list (cons 'view-mode help-xref-override-view-map)))
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
      (set-buffer-modified-p old-modified))))

;;;###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."
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
  (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)
				     ((and sym (boundp sym))
				      'help-variable))))
		    (when type (help-xref-button 1 type sym)))
		  (goto-char (match-end 1)))
		 (t (forward-char 1))))
	    (error nil)))))))
498 499 500 501 502


;; 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
503
Both variable, function and face documentation are extracted into a single
504
help buffer."
Stefan Monnier's avatar
Stefan Monnier committed
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
  (with-current-buffer (help-buffer)
    ;; Push the previous item on the stack before clobbering the output buffer.
    (help-setup-xref nil nil)
    (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)))
	  (sdoc (when (boundp symbol)
		  ;; 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
524
	(when (or fdoc facedoc)
525 526 527
	  (goto-char (point-min))
	  (let ((inhibit-read-only t))
	    (when fdoc
Stefan Monnier's avatar
Stefan Monnier committed
528
	      (insert fdoc "\n\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
529 530
	      (when facedoc
		(insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
Stefan Monnier's avatar
Stefan Monnier committed
531 532 533
			" is also a " "face." "\n\n")))
	    (when facedoc
	      (insert facedoc "\n\n"))
534 535
	    (insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
		    " is also a " "variable." "\n\n"))
Stefan Monnier's avatar
Stefan Monnier committed
536 537 538 539 540 541 542 543 544 545 546 547 548 549
	  ;; 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)))))))
550 551


Stefan Monnier's avatar
Stefan Monnier committed
552
;; Navigation/hyperlinking with xrefs
553

Stefan Monnier's avatar
Stefan Monnier committed
554 555 556 557 558 559 560 561 562
(defun help-follow-mouse (click)
  "Follow the cross-reference that you CLICK on."
  (interactive "e")
  (let* ((start (event-start click))
	 (window (car start))
	 (pos (car (cdr start))))
    (with-current-buffer (window-buffer window)
      (help-follow pos))))

563 564 565 566 567 568
(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
      (when help-xref-stack
	(setq item (pop help-xref-stack)
Stefan Monnier's avatar
Stefan Monnier committed
569 570 571 572
	      ;; 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
573 574 575 576
	      position (car item)
	      method (cadr item)
	      args (cddr item))))
    (apply method args)
577 578 579 580
    (with-current-buffer buffer
      (if (get-buffer-window buffer)
	  (set-window-point (get-buffer-window buffer) position)
	(goto-char position)))))
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 606 607 608 609 610 611 612 613

(defun help-go-back ()
  "Invoke the [back] button (if any) in the Help mode buffer."
  (interactive)
  (let ((back-button (button-at (1- (point-max)))))
    (if back-button
	(button-activate back-button)
      (error "No [back] button"))))

(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)))

(defun help-follow (&optional pos)
  "Follow cross-reference at POS, defaulting to point.

For the cross-reference format, see `help-make-xrefs'."
  (interactive "d")
  (unless pos
    (setq pos (point)))
  (unless (push-button pos)
    ;; check if the symbol under point is a function or variable
    (let ((sym
	   (intern
	    (save-excursion
	      (goto-char pos) (skip-syntax-backward "w_")
	      (buffer-substring (point)
				(progn (skip-syntax-forward "w_")
				       (point)))))))
Stefan Monnier's avatar
Stefan Monnier committed
614
      (when (or (boundp sym) (fboundp sym) (facep sym))
615 616 617 618 619
	(help-do-xref pos #'help-xref-interned (list sym))))))


(provide 'help-mode)

Miles Bader's avatar
Miles Bader committed
620
;;; arch-tag: 850954ae-3725-4cb4-8e91-0bf6d52d6b0b
621
;;; help-mode.el ends here