annotate lisp/help-mode.el @ 70400:ecfaf1d192c9

(normal-splash-screen, fancy-splash-screens-1): Add a reference to the Lisp manual to the warning about pure space overflow.
author Eli Zaretskii <eliz@gnu.org>
date Fri, 05 May 2006 12:50:04 +0000
parents a379c5190e90
children d530d0a35e81 2ecafc6d5db7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
1 ;;; help-mode.el --- `help-mode' used by *Help* buffers
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
2
64762
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64306
diff changeset
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002,
68651
3bd95f4f2941 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 67854
diff changeset
4 ;; 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
5
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
6 ;; Maintainer: FSF
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
7 ;; Keywords: help, internal
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
8
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
10
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
14 ;; any later version.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
15
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
20
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64091
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 63657
diff changeset
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 63657
diff changeset
24 ;; Boston, MA 02110-1301, USA.
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
25
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
27
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
28 ;; Defines `help-mode', which is the mode used by *Help* buffers, and
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
29 ;; associated support machinery, such as adding hyperlinks, etc.,
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
30
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
31 ;;; Code:
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
32
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
33 (require 'button)
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
34 (require 'view)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
35
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
36 (defvar help-mode-map (make-sparse-keymap)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
37 "Keymap for help mode.")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
38
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
39 (set-keymap-parent help-mode-map button-buffer-map)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
40
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
41 (define-key help-mode-map [mouse-2] 'help-follow-mouse)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
42 (define-key help-mode-map "\C-c\C-b" 'help-go-back)
69587
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
43 (define-key help-mode-map "\C-c\C-c" 'help-follow-symbol)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
44 ;; Documentation only, since we use minor-mode-overriding-map-alist.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
45 (define-key help-mode-map "\r" 'help-follow)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
46
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
47 (defvar help-xref-stack nil
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
48 "A stack of ways by which to return to help buffers after following xrefs.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
49 Used by `help-follow' and `help-xref-go-back'.
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
50 An element looks like (POSITION FUNCTION ARGS...).
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
51 To use the element, do (apply FUNCTION ARGS) then goto the point.")
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
52 (put 'help-xref-stack 'permanent-local t)
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
53 (make-variable-buffer-local 'help-xref-stack)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
54
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
55 (defvar help-xref-stack-item nil
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
56 "An item for `help-follow' in this buffer to push onto `help-xref-stack'.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
57 The format is (FUNCTION ARGS...).")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
58 (put 'help-xref-stack-item 'permanent-local t)
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
59 (make-variable-buffer-local 'help-xref-stack-item)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
60
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
61 (setq-default help-xref-stack nil help-xref-stack-item nil)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
62
41331
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
63 (defcustom help-mode-hook nil
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
64 "Hook run by `help-mode'."
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
65 :type 'hook
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
66 :group 'help)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
67
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
68 ;; Button types used by help
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
69
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
70 (define-button-type 'help-xref
59020
9916bd512da7 (help-xref): Add follow-link property.
Kim F. Storm <storm@cua.dk>
parents: 56579
diff changeset
71 'follow-link t
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
72 'action #'help-button-action)
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
73
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
74 (defun help-button-action (button)
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
75 "Call BUTTON's help function."
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
76 (help-do-xref (button-start button)
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
77 (button-get button 'help-function)
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
78 (button-get button 'help-args)))
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
79
41505
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
80 ;; These 6 calls to define-button-type were generated in a dolist
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
81 ;; loop, but that is bad because it means these button types don't
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
82 ;; have an easily found definition.
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
83
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
84 (define-button-type 'help-function
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
85 :supertype 'help-xref
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
86 'help-function 'describe-function
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
87 'help-echo (purecopy "mouse-2, RET: describe this function"))
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
88
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
89 (define-button-type 'help-variable
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
90 :supertype 'help-xref
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
91 'help-function 'describe-variable
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
92 'help-echo (purecopy "mouse-2, RET: describe this variable"))
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
93
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
94 (define-button-type 'help-face
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
95 :supertype 'help-xref
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
96 'help-function 'describe-face
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
97 'help-echo (purecopy "mouse-2, RET: describe this face"))
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
98
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
99 (define-button-type 'help-coding-system
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
100 :supertype 'help-xref
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
101 'help-function 'describe-coding-system
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
102 'help-echo (purecopy "mouse-2, RET: describe this coding system"))
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
103
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
104 (define-button-type 'help-input-method
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
105 :supertype 'help-xref
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
106 'help-function 'describe-input-method
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
107 'help-echo (purecopy "mouse-2, RET: describe this input method"))
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
108
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
109 (define-button-type 'help-character-set
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
110 :supertype 'help-xref
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
111 'help-function 'describe-character-set
77dd7bf4d860 (help-function, help-variable, help-face)
Richard M. Stallman <rms@gnu.org>
parents: 41331
diff changeset
112 'help-echo (purecopy "mouse-2, RET: describe this character set"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
113
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
114 ;; make some more ideosyncratic button types
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
115
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
116 (define-button-type 'help-symbol
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
117 :supertype 'help-xref
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
118 'help-function #'help-xref-interned
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
119 'help-echo (purecopy "mouse-2, RET: describe this symbol"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
120
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
121 (define-button-type 'help-back
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
122 :supertype 'help-xref
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
123 'help-function #'help-xref-go-back
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
124 'help-echo (purecopy "mouse-2, RET: go back to previous help buffer"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
125
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
126 (define-button-type 'help-info
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
127 :supertype 'help-xref
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
128 'help-function #'info
66513
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
129 'help-echo (purecopy "mouse-2, RET: read this Info node"))
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
130
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
131 (define-button-type 'help-url
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
132 :supertype 'help-xref
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
133 'help-function #'browse-url
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
134 'help-echo (purecopy "mouse-2, RET: view this URL in a browser"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
135
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
136 (define-button-type 'help-customize-variable
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
137 :supertype 'help-xref
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
138 'help-function (lambda (v)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
139 (customize-variable v))
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
140 'help-echo (purecopy "mouse-2, RET: customize variable"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
141
39800
8f2810b5b5e8 (help-customize-face): New button-type.
Miles Bader <miles@gnu.org>
parents: 39787
diff changeset
142 (define-button-type 'help-customize-face
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
143 :supertype 'help-xref
39800
8f2810b5b5e8 (help-customize-face): New button-type.
Miles Bader <miles@gnu.org>
parents: 39787
diff changeset
144 'help-function (lambda (v)
8f2810b5b5e8 (help-customize-face): New button-type.
Miles Bader <miles@gnu.org>
parents: 39787
diff changeset
145 (customize-face v))
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
146 'help-echo (purecopy "mouse-2, RET: customize face"))
39800
8f2810b5b5e8 (help-customize-face): New button-type.
Miles Bader <miles@gnu.org>
parents: 39787
diff changeset
147
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
148 (define-button-type 'help-function-def
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
149 :supertype 'help-xref
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
150 'help-function (lambda (fun file)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
151 (require 'find-func)
55233
038fab289258 (help-function-def, help-variable-def):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55010
diff changeset
152 (when (eq file 'C-source)
038fab289258 (help-function-def, help-variable-def):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55010
diff changeset
153 (setq file
038fab289258 (help-function-def, help-variable-def):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55010
diff changeset
154 (help-C-file-name (indirect-function fun) 'fun)))
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
155 ;; Don't use find-function-noselect because it follows
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
156 ;; aliases (which fails for built-in functions).
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
157 (let ((location
55233
038fab289258 (help-function-def, help-variable-def):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55010
diff changeset
158 (find-function-search-for-symbol fun nil file)))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
159 (pop-to-buffer (car location))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
160 (goto-char (cdr location))))
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
161 'help-echo (purecopy "mouse-2, RET: find function's definition"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
162
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
163 (define-button-type 'help-variable-def
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
164 :supertype 'help-xref
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
165 'help-function (lambda (var &optional file)
55233
038fab289258 (help-function-def, help-variable-def):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55010
diff changeset
166 (when (eq file 'C-source)
038fab289258 (help-function-def, help-variable-def):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55010
diff changeset
167 (setq file (help-C-file-name var 'var)))
038fab289258 (help-function-def, help-variable-def):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55010
diff changeset
168 (let ((location (find-variable-noselect var file)))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
169 (pop-to-buffer (car location))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
170 (goto-char (cdr location))))
40638
84e66cdcffc5 (help-xref): New button type.
Miles Bader <miles@gnu.org>
parents: 40191
diff changeset
171 'help-echo (purecopy"mouse-2, RET: find variable's definition"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
172
62387
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
173 (define-button-type 'help-face-def
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
174 :supertype 'help-xref
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
175 'help-function (lambda (fun file)
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
176 (require 'find-func)
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
177 ;; Don't use find-function-noselect because it follows
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
178 ;; aliases (which fails for built-in functions).
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
179 (let ((location
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
180 (find-function-search-for-symbol fun 'defface file)))
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
181 (pop-to-buffer (car location))
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
182 (goto-char (cdr location))))
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
183 'help-echo (purecopy "mouse-2, RET: find face's definition"))
c051115aeb95 (help-face-def): New button type.
Richard M. Stallman <rms@gnu.org>
parents: 60462
diff changeset
184
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
185
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
186 ;;;###autoload
41331
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
187 (defun help-mode ()
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
188 "Major mode for viewing help text and navigating references in it.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
189 Entry to this mode runs the normal hook `help-mode-hook'.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
190 Commands:
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
191 \\{help-mode-map}"
41331
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
192 (interactive)
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
193 (kill-all-local-variables)
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
194 (use-local-map help-mode-map)
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
195 (setq mode-name "Help")
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
196 (setq major-mode 'help-mode)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
197 (view-mode)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
198 (make-local-variable 'view-no-disable-on-exit)
41331
8fa706b1026c (help-mode): Undo 2001-10-07 change.
Richard M. Stallman <rms@gnu.org>
parents: 40638
diff changeset
199 (setq view-no-disable-on-exit t)
70326
a379c5190e90 (help-mode): view-exit-action calls delete-window
Richard M. Stallman <rms@gnu.org>
parents: 70095
diff changeset
200 (setq view-exit-action (lambda (buffer)
a379c5190e90 (help-mode): view-exit-action calls delete-window
Richard M. Stallman <rms@gnu.org>
parents: 70095
diff changeset
201 (or (window-minibuffer-p (selected-window))
a379c5190e90 (help-mode): view-exit-action calls delete-window
Richard M. Stallman <rms@gnu.org>
parents: 70095
diff changeset
202 (one-window-p t)
a379c5190e90 (help-mode): view-exit-action calls delete-window
Richard M. Stallman <rms@gnu.org>
parents: 70095
diff changeset
203 (delete-window))))
62729
40c5f688942a (help-mode): Use run-mode-hooks.
Lute Kamstra <lute@gnu.org>
parents: 62387
diff changeset
204 (run-mode-hooks 'help-mode-hook))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
205
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
206 ;;;###autoload
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
207 (defun help-mode-setup ()
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
208 (help-mode)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
209 (setq buffer-read-only nil))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
210
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
211 ;;;###autoload
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
212 (defun help-mode-finish ()
55010
734c2a20e3ec (help-mode-finish): Set help-return-alist first
Richard M. Stallman <rms@gnu.org>
parents: 54781
diff changeset
213 (let ((entry (assq (selected-window) view-return-to-alist)))
60462
df46d87c0c2f (help-mode-finish): Don't alter the element
Richard M. Stallman <rms@gnu.org>
parents: 59020
diff changeset
214 (if entry
df46d87c0c2f (help-mode-finish): Don't alter the element
Richard M. Stallman <rms@gnu.org>
parents: 59020
diff changeset
215 ;; When entering Help mode from the Help window,
df46d87c0c2f (help-mode-finish): Don't alter the element
Richard M. Stallman <rms@gnu.org>
parents: 59020
diff changeset
216 ;; such as by following a link, preserve the same
df46d87c0c2f (help-mode-finish): Don't alter the element
Richard M. Stallman <rms@gnu.org>
parents: 59020
diff changeset
217 ;; meaning for the q command.
df46d87c0c2f (help-mode-finish): Don't alter the element
Richard M. Stallman <rms@gnu.org>
parents: 59020
diff changeset
218 ;; (setcdr entry (cons (selected-window) help-return-method))
df46d87c0c2f (help-mode-finish): Don't alter the element
Richard M. Stallman <rms@gnu.org>
parents: 59020
diff changeset
219 nil
55010
734c2a20e3ec (help-mode-finish): Set help-return-alist first
Richard M. Stallman <rms@gnu.org>
parents: 54781
diff changeset
220 (setq view-return-to-alist
734c2a20e3ec (help-mode-finish): Set help-return-alist first
Richard M. Stallman <rms@gnu.org>
parents: 54781
diff changeset
221 (cons (cons (selected-window) help-return-method)
734c2a20e3ec (help-mode-finish): Set help-return-alist first
Richard M. Stallman <rms@gnu.org>
parents: 54781
diff changeset
222 view-return-to-alist))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
223 (when (eq major-mode 'help-mode)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
224 ;; View mode's read-only status of existing *Help* buffer is lost
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
225 ;; by with-output-to-temp-buffer.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
226 (toggle-read-only 1)
55010
734c2a20e3ec (help-mode-finish): Set help-return-alist first
Richard M. Stallman <rms@gnu.org>
parents: 54781
diff changeset
227 (help-make-xrefs (current-buffer))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
228
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
229 ;; Grokking cross-reference information in doc strings and
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
230 ;; hyperlinking it.
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
231
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
232 ;; This may have some scope for extension and the same or something
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
233 ;; similar should be done for widget doc strings, which currently use
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
234 ;; another mechanism.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
235
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
236 (defvar help-back-label (purecopy "[back]")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
237 "Label to use by `help-make-xrefs' for the go-back reference.")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
238
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
239 (defconst help-xref-symbol-regexp
69587
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
240 (purecopy (concat "\\(\\<\\(\\(variable\\|option\\)\\|" ; Link to var
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
241 "\\(function\\|command\\)\\|" ; Link to function
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
242 "\\(face\\)\\|" ; Link to face
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
243 "\\(symbol\\|program\\)\\|" ; Don't link
52876
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
244 "\\(source \\(?:code \\)?\\(?:of\\|for\\)\\)\\)"
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
245 "[ \t\n]+\\)?"
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
246 ;; Note starting with word-syntax character:
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
247 "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'"))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
248 "Regexp matching doc string references to symbols.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
249
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
250 The words preceding the quoted symbol can be used in doc strings to
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
251 distinguish references to variables, functions and symbols.")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
252
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
253 (defvar help-xref-mule-regexp nil
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
254 "Regexp matching doc string references to MULE-related keywords.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
255
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
256 It is usually nil, and is temporarily bound to an appropriate regexp
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
257 when help commands related to multilingual environment (e.g.,
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
258 `describe-coding-system') are invoked.")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
259
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
260
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
261 (defconst help-xref-info-regexp
53455
0e3e62b0f4f2 (help-xref-info-regexp): Make hyperlinks to Info documentation if the
Luc Teirlinck <teirllm@auburn.edu>
parents: 52885
diff changeset
262 (purecopy "\\<[Ii]nfo[ \t\n]+\\(node\\|anchor\\)[ \t\n]+`\\([^']+\\)'")
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
263 "Regexp matching doc string references to an Info node.")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
264
66513
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
265 (defconst help-xref-url-regexp
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
266 (purecopy "\\<[Uu][Rr][Ll][ \t\n]+`\\([^']+\\)'")
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
267 "Regexp matching doc string references to a URL.")
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
268
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
269 ;;;###autoload
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
270 (defun help-setup-xref (item interactive-p)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
271 "Invoked from commands using the \"*Help*\" buffer to install some xref info.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
272
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
273 ITEM is a (FUNCTION . ARGS) pair appropriate for recreating the help
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
274 buffer after following a reference. INTERACTIVE-P is non-nil if the
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
275 calling command was invoked interactively. In this case the stack of
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
276 items for help buffer \"back\" buttons is cleared.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
277
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
278 This should be called very early, before the output buffer is cleared,
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
279 because we want to record the \"previous\" position of point so we can
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
280 restore it properly when going back."
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
281 (with-current-buffer (help-buffer)
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
282 (when help-xref-stack-item
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
283 (push (cons (point) help-xref-stack-item) help-xref-stack))
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
284 (when interactive-p
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
285 (let ((tail (nthcdr 10 help-xref-stack)))
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
286 ;; Truncate the stack.
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
287 (if tail (setcdr tail nil))))
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
288 (setq help-xref-stack-item item)))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
289
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
290 (defvar help-xref-following nil
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
291 "Non-nil when following a help cross-reference.")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
292
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
293 (defun help-buffer ()
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
294 (buffer-name ;for with-output-to-temp-buffer
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
295 (if help-xref-following
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
296 (current-buffer)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
297 (get-buffer-create "*Help*"))))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
298
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
299 (defvar help-xref-override-view-map
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
300 (let ((map (make-sparse-keymap)))
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
301 (set-keymap-parent map view-mode-map)
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
302 (define-key map "\r" nil)
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
303 map)
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
304 "Replacement keymap for `view-mode' in help buffers.")
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
305
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
306 ;;;###autoload
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
307 (defun help-make-xrefs (&optional buffer)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
308 "Parse and hyperlink documentation cross-references in the given BUFFER.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
309
45763
6499a200d5d5 (help-mode): Don't set `font-lock-defaults'.
Colin Walters <walters@gnu.org>
parents: 42680
diff changeset
310 Find cross-reference information in a buffer and activate such cross
6499a200d5d5 (help-mode): Don't set `font-lock-defaults'.
Colin Walters <walters@gnu.org>
parents: 42680
diff changeset
311 references for selection with `help-follow'. Cross-references have
6499a200d5d5 (help-mode): Don't set `font-lock-defaults'.
Colin Walters <walters@gnu.org>
parents: 42680
diff changeset
312 the canonical form `...' and the type of reference may be
6499a200d5d5 (help-mode): Don't set `font-lock-defaults'.
Colin Walters <walters@gnu.org>
parents: 42680
diff changeset
313 disambiguated by the preceding word(s) used in
52876
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
314 `help-xref-symbol-regexp'. Faces only get cross-referenced if
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
315 preceded or followed by the word `face'. Variables without
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
316 variable documentation do not get cross-referenced, unless
52878
80f69b7f19c1 (help-make-xrefs): Slight correction to previous change.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52876
diff changeset
317 preceded by the word `variable' or `option'.
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
318
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
319 If the variable `help-xref-mule-regexp' is non-nil, find also
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
320 cross-reference information related to multilingual environment
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
321 \(e.g., coding-systems). This variable is also used to disambiguate
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
322 the type of reference as the same way as `help-xref-symbol-regexp'.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
323
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
324 A special reference `back' is made to return back through a stack of
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
325 help buffers. Variable `help-back-label' specifies the text for
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
326 that."
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
327 (interactive "b")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
328 (save-excursion
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
329 (set-buffer (or buffer (current-buffer)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
330 (goto-char (point-min))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
331 ;; Skip the header-type info, though it might be useful to parse
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
332 ;; it at some stage (e.g. "function in `library'").
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
333 (forward-paragraph)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
334 (let ((old-modified (buffer-modified-p)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
335 (let ((stab (syntax-table))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
336 (case-fold-search t)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
337 (inhibit-read-only t))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
338 (set-syntax-table emacs-lisp-mode-syntax-table)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
339 ;; The following should probably be abstracted out.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
340 (unwind-protect
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
341 (progn
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
342 ;; Info references
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
343 (save-excursion
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
344 (while (re-search-forward help-xref-info-regexp nil t)
53455
0e3e62b0f4f2 (help-xref-info-regexp): Make hyperlinks to Info documentation if the
Luc Teirlinck <teirllm@auburn.edu>
parents: 52885
diff changeset
345 (let ((data (match-string 2)))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
346 (save-match-data
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
347 (unless (string-match "^([^)]+)" data)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
348 (setq data (concat "(emacs)" data))))
53455
0e3e62b0f4f2 (help-xref-info-regexp): Make hyperlinks to Info documentation if the
Luc Teirlinck <teirllm@auburn.edu>
parents: 52885
diff changeset
349 (help-xref-button 2 'help-info data))))
66513
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
350 ;; URLs
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
351 (save-excursion
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
352 (while (re-search-forward help-xref-url-regexp nil t)
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
353 (let ((data (match-string 1)))
bfd70a868157 (help-url): New button type. Calls browse-url.
Bill Wohler <wohler@newt.com>
parents: 64762
diff changeset
354 (help-xref-button 1 'help-url data))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
355 ;; Mule related keywords. Do this before trying
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
356 ;; `help-xref-symbol-regexp' because some of Mule
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
357 ;; keywords have variable or function definitions.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
358 (if help-xref-mule-regexp
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
359 (save-excursion
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
360 (while (re-search-forward help-xref-mule-regexp nil t)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
361 (let* ((data (match-string 7))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
362 (sym (intern-soft data)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
363 (cond
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
364 ((match-string 3) ; coding system
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
365 (and sym (coding-system-p sym)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
366 (help-xref-button 6 'help-coding-system sym)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
367 ((match-string 4) ; input method
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
368 (and (assoc data input-method-alist)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
369 (help-xref-button 7 'help-input-method data)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
370 ((or (match-string 5) (match-string 6)) ; charset
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
371 (and sym (charsetp sym)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
372 (help-xref-button 7 'help-character-set sym)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
373 ((assoc data input-method-alist)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
374 (help-xref-button 7 'help-character-set data))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
375 ((and sym (coding-system-p sym))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
376 (help-xref-button 7 'help-coding-system sym))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
377 ((and sym (charsetp sym))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
378 (help-xref-button 7 'help-character-set sym)))))))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
379 ;; Quoted symbols
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
380 (save-excursion
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
381 (while (re-search-forward help-xref-symbol-regexp nil t)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
382 (let* ((data (match-string 8))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
383 (sym (intern-soft data)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
384 (if sym
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
385 (cond
52876
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
386 ((match-string 3) ; `variable' &c
66874
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
387 (and (or (boundp sym) ; `variable' doesn't ensure
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
388 ; it's actually bound
66874
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
389 (get sym 'variable-documentation))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
390 (help-xref-button 8 'help-variable sym)))
52876
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
391 ((match-string 4) ; `function' &c
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
392 (and (fboundp sym) ; similarly
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
393 (help-xref-button 8 'help-function sym)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
394 ((match-string 5) ; `face'
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
395 (and (facep sym)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
396 (help-xref-button 8 'help-face sym)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
397 ((match-string 6)) ; nothing for `symbol'
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
398 ((match-string 7)
52876
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
399 ;;; this used:
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
400 ;;; #'(lambda (arg)
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
401 ;;; (let ((location
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
402 ;;; (find-function-noselect arg)))
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
403 ;;; (pop-to-buffer (car location))
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
404 ;;; (goto-char (cdr location))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
405 (help-xref-button 8 'help-function-def sym))
63657
06603f5724ed (help-make-xrefs): If a symbol representing a face name is not followed by the
Juanma Barranquero <lekktu@gmail.com>
parents: 62729
diff changeset
406 ((and
06603f5724ed (help-make-xrefs): If a symbol representing a face name is not followed by the
Juanma Barranquero <lekktu@gmail.com>
parents: 62729
diff changeset
407 (facep sym)
06603f5724ed (help-make-xrefs): If a symbol representing a face name is not followed by the
Juanma Barranquero <lekktu@gmail.com>
parents: 62729
diff changeset
408 (save-match-data (looking-at "[ \t\n]+face\\W")))
06603f5724ed (help-make-xrefs): If a symbol representing a face name is not followed by the
Juanma Barranquero <lekktu@gmail.com>
parents: 62729
diff changeset
409 (help-xref-button 8 'help-face sym))
66874
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
410 ((and (or (boundp sym)
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
411 (get sym 'variable-documentation))
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
412 (fboundp sym))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
413 ;; We can't intuit whether to use the
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
414 ;; variable or function doc -- supply both.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
415 (help-xref-button 8 'help-symbol sym))
52876
64833a41c107 (help-xref-symbol-regexp): Treat newlines as whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52401
diff changeset
416 ((and
66874
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
417 (or (boundp sym)
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
418 (get sym 'variable-documentation))
54717
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
419 (or
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
420 (documentation-property
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
421 sym 'variable-documentation)
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
422 (condition-case nil
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
423 (documentation-property
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
424 (indirect-variable sym)
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
425 'variable-documentation)
a0b481c8f7d5 (help-make-xrefs): Recognize aliased variable with
Jesper Harder <harder@ifa.au.dk>
parents: 53455
diff changeset
426 (cyclic-variable-indirection nil))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
427 (help-xref-button 8 'help-variable sym))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
428 ((fboundp sym)
52885
8221f516da37 (help-make-xrefs): Make sure that if a symbol is followed by the word
Luc Teirlinck <teirllm@auburn.edu>
parents: 52878
diff changeset
429 (help-xref-button 8 'help-function sym)))))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
430 ;; An obvious case of a key substitution:
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
431 (save-excursion
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
432 (while (re-search-forward
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
433 ;; Assume command name is only word characters
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
434 ;; and dashes to get things like `use M-x foo.'.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
435 "\\<M-x\\s-+\\(\\sw\\(\\sw\\|-\\)+\\)" nil t)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
436 (let ((sym (intern-soft (match-string 1))))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
437 (if (fboundp sym)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
438 (help-xref-button 1 'help-function sym)))))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
439 ;; Look for commands in whole keymap substitutions:
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
440 (save-excursion
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
441 ;; Make sure to find the first keymap.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
442 (goto-char (point-min))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
443 ;; Find a header and the column at which the command
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
444 ;; name will be found.
50684
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
445
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
446 ;; If the keymap substitution isn't the last thing in
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
447 ;; the doc string, and if there is anything on the
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
448 ;; same line after it, this code won't recognize the end of it.
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
449 (while (re-search-forward "^key +binding\n\\(-+ +\\)-+\n\n"
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
450 nil t)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
451 (let ((col (- (match-end 1) (match-beginning 1))))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
452 (while
50684
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
453 (and (not (eobp))
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
454 ;; Stop at a pair of blank lines.
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
455 (not (looking-at "\n\\s-*\n")))
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
456 ;; Skip a single blank line.
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
457 (and (eolp) (forward-line))
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
458 (end-of-line)
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
459 (skip-chars-backward "^\t\n")
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
460 (if (and (>= (current-column) col)
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
461 (looking-at "\\(\\sw\\|-\\)+$"))
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
462 (let ((sym (intern-soft (match-string 0))))
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
463 (if (fboundp sym)
21af30889a41 (help-make-xrefs): Clean up the loop that scans
Richard M. Stallman <rms@gnu.org>
parents: 49690
diff changeset
464 (help-xref-button 0 'help-function sym))))
50691
e2879cfe85cf (help-make-xrefs): Remove extra paren.
John Paul Wallington <jpw@pobox.com>
parents: 50684
diff changeset
465 (forward-line))))))
e2879cfe85cf (help-make-xrefs): Remove extra paren.
John Paul Wallington <jpw@pobox.com>
parents: 50684
diff changeset
466 (set-syntax-table stab))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
467 ;; Delete extraneous newlines at the end of the docstring
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
468 (goto-char (point-max))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
469 (while (and (not (bobp)) (bolp))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
470 (delete-char -1))
54781
bdfa0aa8c425 (help-make-xrefs): Add a final newline to the *Help* buffer.
Juri Linkov <juri@jurta.org>
parents: 54748
diff changeset
471 (insert "\n")
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
472 ;; Make a back-reference in this buffer if appropriate.
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
473 (when help-xref-stack
54781
bdfa0aa8c425 (help-make-xrefs): Add a final newline to the *Help* buffer.
Juri Linkov <juri@jurta.org>
parents: 54748
diff changeset
474 (insert "\n")
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
475 (help-insert-xref-button help-back-label 'help-back
54781
bdfa0aa8c425 (help-make-xrefs): Add a final newline to the *Help* buffer.
Juri Linkov <juri@jurta.org>
parents: 54748
diff changeset
476 (current-buffer))
bdfa0aa8c425 (help-make-xrefs): Add a final newline to the *Help* buffer.
Juri Linkov <juri@jurta.org>
parents: 54748
diff changeset
477 (insert "\n")))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
478 ;; View mode steals RET from us.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
479 (set (make-local-variable 'minor-mode-overriding-map-alist)
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
480 (list (cons 'view-mode help-xref-override-view-map)))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
481 (set-buffer-modified-p old-modified))))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
482
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
483 ;;;###autoload
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
484 (defun help-xref-button (match-number type &rest args)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
485 "Make a hyperlink for cross-reference text previously matched.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
486 MATCH-NUMBER is the subexpression of interest in the last matched
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
487 regexp. TYPE is the type of button to use. Any remaining arguments are
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
488 passed to the button's help-function when it is invoked.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
489 See `help-make-xrefs'."
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
490 ;; Don't mung properties we've added specially in some instances.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
491 (unless (button-at (match-beginning match-number))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
492 (make-text-button (match-beginning match-number)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
493 (match-end match-number)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
494 'type type 'help-args args)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
495
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
496 ;;;###autoload
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
497 (defun help-insert-xref-button (string type &rest args)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
498 "Insert STRING and make a hyperlink from cross-reference text on it.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
499 TYPE is the type of button to use. Any remaining arguments are passed
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
500 to the button's help-function when it is invoked.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
501 See `help-make-xrefs'."
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
502 (unless (button-at (point))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
503 (insert-text-button string 'type type 'help-args args)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
504
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
505 ;;;###autoload
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
506 (defun help-xref-on-pp (from to)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
507 "Add xrefs for symbols in `pp's output between FROM and TO."
49690
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
508 (if (> (- to from) 5000) nil
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
509 (with-syntax-table emacs-lisp-mode-syntax-table
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
510 (save-excursion
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
511 (save-restriction
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
512 (narrow-to-region from to)
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
513 (goto-char (point-min))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
514 (condition-case nil
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
515 (while (not (eobp))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
516 (cond
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
517 ((looking-at "\"") (forward-sexp 1))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
518 ((looking-at "#<") (search-forward ">" nil 'move))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
519 ((looking-at "\\(\\(\\sw\\|\\s_\\)+\\)")
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
520 (let* ((sym (intern-soft (match-string 1)))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
521 (type (cond ((fboundp sym) 'help-function)
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
522 ((or (memq sym '(t nil))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
523 (keywordp sym))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
524 nil)
66874
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
525 ((and sym
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
526 (or (boundp sym)
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
527 (get sym
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
528 'variable-documentation)))
49690
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
529 'help-variable))))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
530 (when type (help-xref-button 1 type sym)))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
531 (goto-char (match-end 1)))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
532 (t (forward-char 1))))
e2f33e589249 (help-xref-on-pp): Only add xref if the text is less than 5K.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46437
diff changeset
533 (error nil)))))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
534
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
535
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
536 ;; Additional functions for (re-)creating types of help buffers.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
537 (defun help-xref-interned (symbol)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
538 "Follow a hyperlink which appeared to be an arbitrary interned SYMBOL.
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
539 Both variable, function and face documentation are extracted into a single
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
540 help buffer."
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
541 (with-current-buffer (help-buffer)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
542 ;; Push the previous item on the stack before clobbering the output buffer.
64306
c7d6013c38b6 (help-xref-interned): Undo last mistaken change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64305
diff changeset
543 (help-setup-xref nil nil)
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
544 (let ((facedoc (when (facep symbol)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
545 ;; Don't record the current entry in the stack.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
546 (setq help-xref-stack-item nil)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
547 (describe-face symbol)))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
548 (fdoc (when (fboundp symbol)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
549 ;; Don't record the current entry in the stack.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
550 (setq help-xref-stack-item nil)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
551 (describe-function symbol)))
66874
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
552 (sdoc (when (or (boundp symbol)
2f22c8af038b (help-make-xrefs, help-xref-on-pp, help-xref-interned, help-follow):
Luc Teirlinck <teirllm@auburn.edu>
parents: 66513
diff changeset
553 (get symbol 'variable-documentation))
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
554 ;; Don't record the current entry in the stack.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
555 (setq help-xref-stack-item nil)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
556 (describe-variable symbol))))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
557 (cond
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
558 (sdoc
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
559 ;; We now have a help buffer on the variable.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
560 ;; Insert the function and face text before it.
42593
dbb64f2b3684 Fix indentation.
Richard M. Stallman <rms@gnu.org>
parents: 42334
diff changeset
561 (when (or fdoc facedoc)
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
562 (goto-char (point-min))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
563 (let ((inhibit-read-only t))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
564 (when fdoc
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
565 (insert fdoc "\n\n")
42593
dbb64f2b3684 Fix indentation.
Richard M. Stallman <rms@gnu.org>
parents: 42334
diff changeset
566 (when facedoc
dbb64f2b3684 Fix indentation.
Richard M. Stallman <rms@gnu.org>
parents: 42334
diff changeset
567 (insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
568 " is also a " "face." "\n\n")))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
569 (when facedoc
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
570 (insert facedoc "\n\n"))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
571 (insert (make-string 30 ?-) "\n\n" (symbol-name symbol)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
572 " is also a " "variable." "\n\n"))
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
573 ;; Don't record the `describe-variable' item in the stack.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
574 (setq help-xref-stack-item nil)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
575 (help-setup-xref (list #'help-xref-interned symbol) nil)))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
576 (fdoc
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
577 ;; We now have a help buffer on the function.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
578 ;; Insert face text before it.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
579 (when facedoc
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
580 (goto-char (point-max))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
581 (let ((inhibit-read-only t))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
582 (insert "\n\n" (make-string 30 ?-) "\n\n" (symbol-name symbol)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
583 " is also a " "face." "\n\n" facedoc))
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
584 ;; Don't record the `describe-function' item in the stack.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
585 (setq help-xref-stack-item nil)
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
586 (help-setup-xref (list #'help-xref-interned symbol) nil)))))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
587
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
588
46437
6987a52d9b98 (view): Always require.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45767
diff changeset
589 ;; Navigation/hyperlinking with xrefs
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
590
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
591 (defun help-xref-go-back (buffer)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
592 "From BUFFER, go back to previous help buffer text using `help-xref-stack'."
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
593 (let (item position method args)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
594 (with-current-buffer buffer
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
595 (when help-xref-stack
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
596 (setq item (pop help-xref-stack)
39787
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
597 ;; Clear the current item so that it won't get pushed
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
598 ;; by the function we're about to call. TODO: We could also
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
599 ;; push it onto a "forward" stack and add a `forw' button.
b44e34df3fa2 (help-buffer): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39727
diff changeset
600 help-xref-stack-item nil
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
601 position (car item)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
602 method (cadr item)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
603 args (cddr item))))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
604 (apply method args)
42680
3814cb15269e (help-xref-go-back): Restore POSITION in proper buffer and proper window.
Richard M. Stallman <rms@gnu.org>
parents: 42593
diff changeset
605 (with-current-buffer buffer
3814cb15269e (help-xref-go-back): Restore POSITION in proper buffer and proper window.
Richard M. Stallman <rms@gnu.org>
parents: 42593
diff changeset
606 (if (get-buffer-window buffer)
3814cb15269e (help-xref-go-back): Restore POSITION in proper buffer and proper window.
Richard M. Stallman <rms@gnu.org>
parents: 42593
diff changeset
607 (set-window-point (get-buffer-window buffer) position)
3814cb15269e (help-xref-go-back): Restore POSITION in proper buffer and proper window.
Richard M. Stallman <rms@gnu.org>
parents: 42593
diff changeset
608 (goto-char position)))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
609
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
610 (defun help-go-back ()
55679
839ccd7aaee0 (help-go-back): Don't depend on position of back button.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55233
diff changeset
611 "Go back to previous topic in this help buffer."
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
612 (interactive)
55679
839ccd7aaee0 (help-go-back): Don't depend on position of back button.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55233
diff changeset
613 (if help-xref-stack
839ccd7aaee0 (help-go-back): Don't depend on position of back button.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55233
diff changeset
614 (help-xref-go-back (current-buffer))
56579
6a5acd0aae39 (help-go-back): Delete period from end of error message.
John Paul Wallington <jpw@pobox.com>
parents: 55679
diff changeset
615 (error "No previous help buffer")))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
616
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
617 (defun help-do-xref (pos function args)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
618 "Call the help cross-reference function FUNCTION with args ARGS.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
619 Things are set up properly so that the resulting help-buffer has
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
620 a proper [back] button."
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
621 ;; There is a reference at point. Follow it.
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
622 (let ((help-xref-following t))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
623 (apply function args)))
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
624
69587
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
625 ;; The doc string is meant to explain what buttons do.
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
626 (defun help-follow-mouse ()
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
627 "Follow the cross-reference that you click on."
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
628 (interactive)
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
629 (error "No cross-reference here"))
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
630
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
631 ;; The doc string is meant to explain what buttons do.
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
632 (defun help-follow ()
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
633 "Follow cross-reference at point.
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
634
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
635 For the cross-reference format, see `help-make-xrefs'."
69587
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
636 (interactive)
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
637 (error "No cross-reference here"))
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
638
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
639 (defun help-follow-symbol (&optional pos)
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
640 "In help buffer, show docs for symbol at POS, defaulting to point.
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
641 Show all docs for that symbol as either a variable, function or face."
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
642 (interactive "d")
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
643 (unless pos
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
644 (setq pos (point)))
69587
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
645 ;; check if the symbol under point is a function, variable or face
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
646 (let ((sym
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
647 (intern
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
648 (save-excursion
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
649 (goto-char pos) (skip-syntax-backward "w_")
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
650 (buffer-substring (point)
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
651 (progn (skip-syntax-forward "w_")
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
652 (point)))))))
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
653 (when (or (boundp sym)
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
654 (get sym 'variable-documentation)
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
655 (fboundp sym) (facep sym))
ddaea7e69d4f (help-follow-symbol): New function. Essentially identical to the old
Luc Teirlinck <teirllm@auburn.edu>
parents: 68651
diff changeset
656 (help-do-xref pos #'help-xref-interned (list sym)))))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
657
67854
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
658 (defun help-insert-string (string)
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
659 "Insert STRING to the help buffer and install xref info for it.
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
660 This function can be used to restore the old contents of the help buffer
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
661 when going back to the previous topic in the xref stack. It is needed
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
662 in case when it is impossible to recompute the old contents of the
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
663 help buffer by other means."
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
664 (setq help-xref-stack-item (list #'help-insert-string string))
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
665 (with-output-to-temp-buffer (help-buffer)
eb33196c14d7 (help-insert-string): New function. Save buffer
Nick Roberts <nickrob@snap.net.nz>
parents: 67697
diff changeset
666 (insert string)))
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
667
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
668 (provide 'help-mode)
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
669
64305
d533a2de8243 (help-xref-interned): Properly setup xref info.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64091
diff changeset
670 ;; arch-tag: 850954ae-3725-4cb4-8e91-0bf6d52d6b0b
39727
3806fe844742 New file, contents mostly from `help.el'.
Miles Bader <miles@gnu.org>
parents:
diff changeset
671 ;;; help-mode.el ends here