help-mode.el 24.6 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 Free Software Foundation, Inc.
5 6 7 8 9 10 11 12

;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
14 15 16 17 18 19 20 21 22
;; 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
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
25 26 27 28 29 30 31 32 33

;;; 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
(define-key help-mode-map "\C-c\C-b" 'help-go-back)
43
(define-key help-mode-map "\C-c\C-c" 'help-follow-symbol)
44 45 46 47 48 49
;; 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
(define-button-type 'help-xref
71
  'follow-link t
Miles Bader's avatar
Miles Bader committed
72 73 74 75 76 77 78 79
  '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)))

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 112
;; 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"))
113 114 115 116

;; make some more ideosyncratic button types

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

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

(define-button-type 'help-info
Miles Bader's avatar
Miles Bader committed
127
  :supertype 'help-xref
128
  'help-function #'info
129 130 131 132 133 134
  '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"))
135 136

(define-button-type 'help-customize-variable
Miles Bader's avatar
Miles Bader committed
137
  :supertype 'help-xref
138 139
  'help-function (lambda (v)
		   (customize-variable v))
Miles Bader's avatar
Miles Bader committed
140
  'help-echo (purecopy "mouse-2, RET: customize variable"))
141

142
(define-button-type 'help-customize-face
Miles Bader's avatar
Miles Bader committed
143
  :supertype 'help-xref
144 145
  'help-function (lambda (v)
		   (customize-face v))
Miles Bader's avatar
Miles Bader committed
146
  'help-echo (purecopy "mouse-2, RET: customize face"))
147

148
(define-button-type 'help-function-def
Miles Bader's avatar
Miles Bader committed
149
  :supertype 'help-xref
150 151
  'help-function (lambda (fun file)
		   (require 'find-func)
152 153 154
		   (when (eq file 'C-source)
		     (setq file
			   (help-C-file-name (indirect-function fun) 'fun)))
Stefan Monnier's avatar
Stefan Monnier committed
155
		   ;; Don't use find-function-noselect because it follows
156
		   ;; aliases (which fails for built-in functions).
Stefan Monnier's avatar
Stefan Monnier committed
157
		   (let ((location
158
			  (find-function-search-for-symbol fun nil file)))
159
		     (pop-to-buffer (car location))
160 161 162
		     (if (cdr location)
			 (goto-char (cdr location))
		       (message "Unable to find location in file"))))
Miles Bader's avatar
Miles Bader committed
163
  'help-echo (purecopy "mouse-2, RET: find function's definition"))
164 165

(define-button-type 'help-variable-def
Miles Bader's avatar
Miles Bader committed
166
  :supertype 'help-xref
167
  'help-function (lambda (var &optional file)
168 169 170
		   (when (eq file 'C-source)
		     (setq file (help-C-file-name var 'var)))
		   (let ((location (find-variable-noselect var file)))
171
		     (pop-to-buffer (car location))
172 173 174
		     (if (cdr location)
		       (goto-char (cdr location))
		       (message "Unable to find location in file"))))
Kim F. Storm's avatar
Kim F. Storm committed
175
  'help-echo (purecopy "mouse-2, RET: find variable's definition"))
176

177 178 179 180 181 182 183 184 185
(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))
186 187 188
		     (if (cdr location)
			 (goto-char (cdr location))
		       (message "Unable to find location in file"))))
189 190
  'help-echo (purecopy "mouse-2, RET: find face's definition"))

191 192

;;;###autoload
193
(defun help-mode ()
194 195 196 197
  "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}"
198 199 200 201 202
  (interactive)
  (kill-all-local-variables)
  (use-local-map help-mode-map)
  (setq mode-name "Help")
  (setq major-mode 'help-mode)
203 204
  (view-mode)
  (make-local-variable 'view-no-disable-on-exit)
205
  (setq view-no-disable-on-exit t)
206 207 208 209
  (setq view-exit-action (lambda (buffer)
			   (or (window-minibuffer-p (selected-window))
			       (one-window-p t)
			       (delete-window))))
210
  (run-mode-hooks 'help-mode-hook))
211 212 213 214 215 216 217 218

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

;;;###autoload
(defun help-mode-finish ()
219
  (let ((entry (assq (selected-window) view-return-to-alist)))
220 221 222 223 224 225
	(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
226 227 228
	  (setq view-return-to-alist
		(cons (cons (selected-window) help-return-method)
		      view-return-to-alist))))
229 230 231 232
  (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)
233
    (help-make-xrefs (current-buffer))))
234

Stefan Monnier's avatar
Stefan Monnier committed
235 236
;; Grokking cross-reference information in doc strings and
;; hyperlinking it.
237 238 239 240 241 242 243 244 245

;; 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
246
  (purecopy (concat "\\(\\<\\(\\(variable\\|option\\)\\|"  ; Link to var
247 248 249
 		    "\\(function\\|command\\)\\|"          ; Link to function
 		    "\\(face\\)\\|"			   ; Link to face
 		    "\\(symbol\\|program\\|property\\)\\|" ; Don't link
250 251
		    "\\(source \\(?:code \\)?\\(?:of\\|for\\)\\)\\)"
		    "[ \t\n]+\\)?"
252 253 254 255 256 257 258
		    ;; 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
259
(defvar help-xref-mule-regexp nil
260 261 262 263 264 265 266 267
  "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
268
  (purecopy "\\<[Ii]nfo[ \t\n]+\\(node\\|anchor\\)[ \t\n]+`\\([^']+\\)'")
269 270
  "Regexp matching doc string references to an Info node.")

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

275 276 277 278 279 280 281
;;;###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
282 283 284 285 286 287
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
288 289 290 291 292 293
    (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
294
    (setq help-xref-stack-item item)))
295 296 297 298

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

Stefan Monnier's avatar
Stefan Monnier committed
299 300 301 302 303 304
(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
305 306 307 308 309 310 311
(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.")

312 313 314 315
;;;###autoload
(defun help-make-xrefs (&optional buffer)
  "Parse and hyperlink documentation cross-references in the given BUFFER.

316 317 318 319
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
320 321 322
`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
323
preceded by the word `variable' or `option'.
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

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)
351
                  (let ((data (match-string 2)))
352 353 354
		    (save-match-data
		      (unless (string-match "^([^)]+)" data)
			(setq data (concat "(emacs)" data))))
355
		    (help-xref-button 2 'help-info data))))
356 357 358 359 360
              ;; 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))))
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
	      ;; 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
392
                         ((match-string 3)  ; `variable' &c
393
                          (and (or (boundp sym) ; `variable' doesn't ensure
394
                                        ; it's actually bound
395
				   (get sym 'variable-documentation))
396
                               (help-xref-button 8 'help-variable sym)))
397
                         ((match-string 4)   ; `function' &c
398 399 400 401 402 403 404
                          (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)
405 406 407 408 409 410
;;;  this used:
;;; 			  #'(lambda (arg)
;;; 			      (let ((location
;;; 				     (find-function-noselect arg)))
;;; 				(pop-to-buffer (car location))
;;; 				(goto-char (cdr location))))
411
			  (help-xref-button 8 'help-function-def sym))
412 413 414 415
			 ((and
                           (facep sym)
                           (save-match-data (looking-at "[ \t\n]+face\\W")))
                          (help-xref-button 8 'help-face sym))
416 417 418
                         ((and (or (boundp sym)
				   (get sym 'variable-documentation))
			       (fboundp sym))
419 420 421
                          ;; We can't intuit whether to use the
                          ;; variable or function doc -- supply both.
                          (help-xref-button 8 'help-symbol sym))
422
                         ((and
423 424
			   (or (boundp sym)
			       (get sym 'variable-documentation))
425 426 427 428 429 430 431 432
 			   (or
 			    (documentation-property
 			     sym 'variable-documentation)
 			    (condition-case nil
 				(documentation-property
 				 (indirect-variable sym)
 				 'variable-documentation)
 			      (cyclic-variable-indirection nil))))
433 434
			  (help-xref-button 8 'help-variable sym))
			 ((fboundp sym)
435
			  (help-xref-button 8 'help-function sym)))))))
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
              ;; 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.
451 452 453 454

		;; 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.
455 456 457 458
                (while (re-search-forward "^key +binding\n\\(-+ +\\)-+\n\n"
                                          nil t)
                  (let ((col (- (match-end 1) (match-beginning 1))))
                    (while
459 460 461 462 463 464
                        (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)
465
		      (skip-chars-backward "^ \t\n")
466 467 468 469 470
		      (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))))
471 472
		      (forward-line))))))
	  (set-syntax-table stab))
473 474 475 476
	;; Delete extraneous newlines at the end of the docstring
	(goto-char (point-max))
	(while (and (not (bobp)) (bolp))
	  (delete-char -1))
477
        (insert "\n")
478
        ;; Make a back-reference in this buffer if appropriate.
Stefan Monnier's avatar
Stefan Monnier committed
479
        (when help-xref-stack
480
	  (insert "\n")
481
	  (help-insert-xref-button help-back-label 'help-back
482 483
				   (current-buffer))
          (insert "\n")))
484 485
      ;; View mode steals RET from us.
      (set (make-local-variable 'minor-mode-overriding-map-alist)
Stefan Monnier's avatar
Stefan Monnier committed
486
           (list (cons 'view-mode help-xref-override-view-map)))
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
      (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."
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
  (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)
531 532 533 534
				     ((and sym
					   (or (boundp sym)
					       (get sym
						    'variable-documentation)))
535 536 537 538 539
				      'help-variable))))
		    (when type (help-xref-button 1 type sym)))
		  (goto-char (match-end 1)))
		 (t (forward-char 1))))
	    (error nil)))))))
540 541 542 543 544


;; 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
545
Both variable, function and face documentation are extracted into a single
546
help buffer."
Stefan Monnier's avatar
Stefan Monnier committed
547 548
  (with-current-buffer (help-buffer)
    ;; Push the previous item on the stack before clobbering the output buffer.
549
    (help-setup-xref nil nil)
Stefan Monnier's avatar
Stefan Monnier committed
550 551 552 553 554 555 556 557
    (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)))
558 559
	  (sdoc (when (or (boundp symbol)
			  (get symbol 'variable-documentation))
Stefan Monnier's avatar
Stefan Monnier committed
560 561 562 563 564 565 566
		  ;; 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
567
	(when (or fdoc facedoc)
568 569 570
	  (goto-char (point-min))
	  (let ((inhibit-read-only t))
	    (when fdoc
Stefan Monnier's avatar
Stefan Monnier committed
571
	      (insert fdoc "\n\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
572 573
	      (when facedoc
		(insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
Stefan Monnier's avatar
Stefan Monnier committed
574 575 576
			" is also a " "face." "\n\n")))
	    (when facedoc
	      (insert facedoc "\n\n"))
577 578
	    (insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
		    " is also a " "variable." "\n\n"))
Stefan Monnier's avatar
Stefan Monnier committed
579 580 581 582 583 584 585 586 587 588 589 590 591 592
	  ;; 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)))))))
593 594


Stefan Monnier's avatar
Stefan Monnier committed
595
;; Navigation/hyperlinking with xrefs
596 597 598 599 600 601 602

(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
603 604 605 606
	      ;; 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
607 608 609 610
	      position (car item)
	      method (cadr item)
	      args (cddr item))))
    (apply method args)
611 612 613 614
    (with-current-buffer buffer
      (if (get-buffer-window buffer)
	  (set-window-point (get-buffer-window buffer) position)
	(goto-char position)))))
615 616

(defun help-go-back ()
617
  "Go back to previous topic in this help buffer."
618
  (interactive)
619 620
  (if help-xref-stack
      (help-xref-go-back (current-buffer))
621
    (error "No previous help buffer")))
622 623 624 625 626 627 628 629 630

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

631 632 633 634 635 636 637 638 639
;; 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.
640 641

For the cross-reference format, see `help-make-xrefs'."
642 643 644 645 646 647
  (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."
648 649 650
  (interactive "d")
  (unless pos
    (setq pos (point)))
651 652 653 654 655 656 657 658 659 660 661 662
  ;; 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)))))
663

664 665 666 667 668 669 670 671 672
(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)))
673 674 675

(provide 'help-mode)

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