Mercurial > emacs
annotate lisp/help.el @ 23963:c242e2dc93a9
(what-cursor-position): Fix previous change.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 30 Dec 1998 20:41:24 +0000 |
parents | 5ab992b6ca59 |
children | 1876f867ff95 |
rev | line source |
---|---|
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
1 ;;; help.el --- help commands for Emacs |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
2 |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998 Free Software Foundation, Inc. |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
4 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
5 ;; Maintainer: FSF |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
6 ;; Keywords: help, internal |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
7 |
409 | 8 ;; This file is part of GNU Emacs. |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
12 ;; the Free Software Foundation; either version 2, or (at your option) |
409 | 13 ;; any later version. |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
14169 | 21 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
409 | 24 |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
25 ;;; Commentary: |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
26 |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
27 ;; This code implements GNU Emacs' on-line help system, the one invoked by |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
28 ;;`M-x help-for-help'. |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
29 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
30 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
31 |
2312
ad7b89a430df
Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents:
2237
diff
changeset
|
32 ;; Get the macro make-help-screen when this is compiled, |
ad7b89a430df
Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents:
2237
diff
changeset
|
33 ;; or run interpreted, but not when the compiled code is loaded. |
2697
05ff97695d32
Require help-macro, not help-screen.
Richard M. Stallman <rms@gnu.org>
parents:
2638
diff
changeset
|
34 (eval-when-compile (require 'help-macro)) |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
35 |
409 | 36 (defvar help-map (make-sparse-keymap) |
37 "Keymap for characters following the Help key.") | |
38 | |
9833 | 39 (defvar help-mode-map (make-sparse-keymap) |
40 "Keymap for help mode.") | |
41 | |
919 | 42 (define-key global-map (char-to-string help-char) 'help-command) |
12424
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
43 (define-key global-map [help] 'help-command) |
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
44 (define-key global-map [f1] 'help-command) |
409 | 45 (fset 'help-command help-map) |
46 | |
919 | 47 (define-key help-map (char-to-string help-char) 'help-for-help) |
12424
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
48 (define-key help-map [help] 'help-for-help) |
aa25c9b2e043
Bind f1 and help like C-h.
Richard M. Stallman <rms@gnu.org>
parents:
11890
diff
changeset
|
49 (define-key help-map [f1] 'help-for-help) |
409 | 50 (define-key help-map "?" 'help-for-help) |
51 | |
52 (define-key help-map "\C-c" 'describe-copying) | |
53 (define-key help-map "\C-d" 'describe-distribution) | |
54 (define-key help-map "\C-w" 'describe-no-warranty) | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
55 (define-key help-map "\C-p" 'describe-project) |
17200
9438563a5151
(help-map): Use apropos-command, not command-apropos.
Richard M. Stallman <rms@gnu.org>
parents:
17005
diff
changeset
|
56 (define-key help-map "a" 'apropos-command) |
409 | 57 |
58 (define-key help-map "b" 'describe-bindings) | |
59 | |
60 (define-key help-map "c" 'describe-key-briefly) | |
61 (define-key help-map "k" 'describe-key) | |
62 | |
63 (define-key help-map "d" 'describe-function) | |
64 (define-key help-map "f" 'describe-function) | |
65 | |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
66 (define-key help-map "F" 'view-emacs-FAQ) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
67 |
409 | 68 (define-key help-map "i" 'info) |
22470
eec1f722bded
(help-map): C-h 4 i runs info-other-window.
Richard M. Stallman <rms@gnu.org>
parents:
22417
diff
changeset
|
69 (define-key help-map "4i" 'info-other-window) |
732 | 70 (define-key help-map "\C-f" 'Info-goto-emacs-command-node) |
71 (define-key help-map "\C-k" 'Info-goto-emacs-key-command-node) | |
18293
ac6884f51b58
(help-map): Make C-i run info-lookup-symbol.
Richard M. Stallman <rms@gnu.org>
parents:
17917
diff
changeset
|
72 (define-key help-map "\C-i" 'info-lookup-symbol) |
409 | 73 |
74 (define-key help-map "l" 'view-lossage) | |
75 | |
76 (define-key help-map "m" 'describe-mode) | |
77 | |
78 (define-key help-map "\C-n" 'view-emacs-news) | |
79 (define-key help-map "n" 'view-emacs-news) | |
80 | |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
81 (define-key help-map "p" 'finder-by-keyword) |
7978
8356e992ddb6
(finder-by-keyword): Add doc string and t for interactive.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
82 (autoload 'finder-by-keyword "finder" |
8356e992ddb6
(finder-by-keyword): Add doc string and t for interactive.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
83 "Find packages matching a given keyword." t) |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
84 |
409 | 85 (define-key help-map "s" 'describe-syntax) |
86 | |
87 (define-key help-map "t" 'help-with-tutorial) | |
88 | |
89 (define-key help-map "w" 'where-is) | |
90 | |
91 (define-key help-map "v" 'describe-variable) | |
92 | |
6580 | 93 (define-key help-map "q" 'help-quit) |
94 | |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
95 (define-key help-mode-map [mouse-2] 'help-follow-mouse) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
96 (define-key help-mode-map "\C-c\C-b" 'help-go-back) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
97 (define-key help-mode-map "\C-c\C-c" 'help-follow) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
98 (define-key help-mode-map "\t" 'help-next-ref) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
99 (define-key help-mode-map [backtab] 'help-previous-ref) |
21708
280e4b4cbd2a
(help-mode-map): Add S-tab, like backtab.
Dave Love <fx@gnu.org>
parents:
21698
diff
changeset
|
100 (define-key help-mode-map [(shift tab)] 'help-previous-ref) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
101 ;; Documentation only, since we use minor-mode-overriding-map-alist. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
102 (define-key help-mode-map "\r" 'help-follow) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
103 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
104 ;; Font-locking is incompatible with the new xref stuff. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
105 ;(defvar help-font-lock-keywords |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
106 ; (eval-when-compile |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
107 ; (let ((name-char "[-+a-zA-Z0-9_*]") (sym-char "[-+a-zA-Z0-9_:*]")) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
108 ; (list |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
109 ; ;; |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
110 ; ;; The symbol itself. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
111 ; (list (concat "\\`\\(" name-char "+\\)\\(\\(:\\)\\|\\('\\)\\)") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
112 ; '(1 (if (match-beginning 3) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
113 ; font-lock-function-name-face |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
114 ; font-lock-variable-name-face))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
115 ; ;; |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
116 ; ;; Words inside `' which tend to be symbol names. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
117 ; (list (concat "`\\(" sym-char sym-char "+\\)'") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
118 ; 1 'font-lock-constant-face t) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
119 ; ;; |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
120 ; ;; CLisp `:' keywords as references. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
121 ; (list (concat "\\<:" sym-char "+\\>") 0 'font-lock-builtin-face t)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
122 ; "Default expressions to highlight in Help mode.") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
123 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
124 (defvar help-xref-stack nil |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
125 "A stack of ways by which to return to help buffers after following xrefs. |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
126 Used by `help-follow' and `help-xref-go-back'. |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
127 An element looks like (POSITION FUNCTION ARGS...). |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
128 To use the element, do (apply FUNCTION ARGS) then (goto-char POSITION).") |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
129 (put 'help-xref-stack 'permanent-local t) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
130 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
131 (defvar help-xref-stack-item nil |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
132 "An item for `help-follow' in this buffer to push onto `help-xref-stack'. |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
133 The format is (FUNCTION ARGS...).") |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
134 (put 'help-xref-stack-item 'permanent-local t) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
135 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
136 (setq-default help-xref-stack nil help-xref-stack-item nil) |
12816
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
137 |
9833 | 138 (defun help-mode () |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
139 "Major mode for viewing help text and navigating references in it. |
9833 | 140 Entry to this mode runs the normal hook `help-mode-hook'. |
141 Commands: | |
142 \\{help-mode-map}" | |
143 (interactive) | |
144 (kill-all-local-variables) | |
145 (use-local-map help-mode-map) | |
146 (setq mode-name "Help") | |
147 (setq major-mode 'help-mode) | |
12816
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
148 (make-local-variable 'font-lock-defaults) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
149 (setq font-lock-defaults nil) ; font-lock would defeat xref |
13079
6a91723f2a8c
(help-mode): Call view-mode.
Richard M. Stallman <rms@gnu.org>
parents:
12941
diff
changeset
|
150 (view-mode) |
19228
3e0e9b7e2307
(help-mode): Set view-no-disable-on-exit.
Richard M. Stallman <rms@gnu.org>
parents:
19124
diff
changeset
|
151 (make-local-variable 'view-no-disable-on-exit) |
3e0e9b7e2307
(help-mode): Set view-no-disable-on-exit.
Richard M. Stallman <rms@gnu.org>
parents:
19124
diff
changeset
|
152 (setq view-no-disable-on-exit t) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
153 ;; `help-make-xrefs' would be run here if not invoked from |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
154 ;; `help-mode-maybe'. |
9833 | 155 (run-hooks 'help-mode-hook)) |
156 | |
20060
36044c8b8aef
(help-mode-maybe): New function, on temp-buffer-show-hook.
Karl Heuer <kwzh@gnu.org>
parents:
19576
diff
changeset
|
157 (defun help-mode-maybe () |
36044c8b8aef
(help-mode-maybe): New function, on temp-buffer-show-hook.
Karl Heuer <kwzh@gnu.org>
parents:
19576
diff
changeset
|
158 (if (eq major-mode 'fundamental-mode) |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
159 (help-mode)) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
160 (when (eq major-mode 'help-mode) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
161 ;; View mode's read-only status of existing *Help* buffer is lost |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
162 ;; by with-output-to-temp-buffer. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
163 (toggle-read-only 1) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
164 (help-make-xrefs (current-buffer))) |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
165 (setq view-return-to-alist |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
166 (list (cons (selected-window) help-return-method)))) |
20060
36044c8b8aef
(help-mode-maybe): New function, on temp-buffer-show-hook.
Karl Heuer <kwzh@gnu.org>
parents:
19576
diff
changeset
|
167 |
36044c8b8aef
(help-mode-maybe): New function, on temp-buffer-show-hook.
Karl Heuer <kwzh@gnu.org>
parents:
19576
diff
changeset
|
168 (add-hook 'temp-buffer-show-hook 'help-mode-maybe) |
36044c8b8aef
(help-mode-maybe): New function, on temp-buffer-show-hook.
Karl Heuer <kwzh@gnu.org>
parents:
19576
diff
changeset
|
169 |
6580 | 170 (defun help-quit () |
23333 | 171 "Just exit from the Help command's command loop." |
6580 | 172 (interactive) |
173 nil) | |
174 | |
17005
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
175 (defun help-with-tutorial (&optional arg) |
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
176 "Select the Emacs learn-by-doing tutorial. |
19423
f6f7ae045fe3
(help-with-tutorial): Use current-language-environment.
Richard M. Stallman <rms@gnu.org>
parents:
19243
diff
changeset
|
177 If there is a tutorial version written in the language |
19576
b0bd0bd48893
(help-with-tutorial): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
19423
diff
changeset
|
178 of the selected language environment, that version is used. |
19423
f6f7ae045fe3
(help-with-tutorial): Use current-language-environment.
Richard M. Stallman <rms@gnu.org>
parents:
19243
diff
changeset
|
179 If there's no tutorial in that language, `TUTORIAL' is selected. |
20286
5cf064c70ee5
(help-with-tutorial-alist): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
20250
diff
changeset
|
180 With arg, you are asked to choose which language." |
17005
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
181 (interactive "P") |
21440
4718a738947a
(help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents:
21385
diff
changeset
|
182 (let ((lang (if arg |
4718a738947a
(help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents:
21385
diff
changeset
|
183 (read-language-name 'tutorial "Language: " "English") |
4718a738947a
(help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents:
21385
diff
changeset
|
184 (if (get-language-info current-language-environment 'tutorial) |
4718a738947a
(help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents:
21385
diff
changeset
|
185 current-language-environment |
21587
a89b6f48c73d
(help-with-tutorial): Locally bind file and filename.
Richard M. Stallman <rms@gnu.org>
parents:
21491
diff
changeset
|
186 "English"))) |
a89b6f48c73d
(help-with-tutorial): Locally bind file and filename.
Richard M. Stallman <rms@gnu.org>
parents:
21491
diff
changeset
|
187 file filename) |
21440
4718a738947a
(help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents:
21385
diff
changeset
|
188 (setq filename (get-language-info lang 'tutorial)) |
17756
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
189 (setq file (expand-file-name (concat "~/" filename))) |
409 | 190 (delete-other-windows) |
191 (if (get-file-buffer file) | |
192 (switch-to-buffer (get-file-buffer file)) | |
193 (switch-to-buffer (create-file-buffer file)) | |
194 (setq buffer-file-name file) | |
195 (setq default-directory (expand-file-name "~/")) | |
755 | 196 (setq buffer-auto-save-file-name nil) |
17005
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
197 (insert-file-contents (expand-file-name filename data-directory)) |
409 | 198 (goto-char (point-min)) |
199 (search-forward "\n<<") | |
200 (beginning-of-line) | |
201 (delete-region (point) (progn (end-of-line) (point))) | |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
202 (let ((n (- (window-height (selected-window)) |
409 | 203 (count-lines (point-min) (point)) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
204 6))) |
6433
e50519261181
(help-with-tutorial): Change previous change;
Richard M. Stallman <rms@gnu.org>
parents:
6419
diff
changeset
|
205 (if (< n 12) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
206 (newline n) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
207 ;; Some people get confused by the large gap. |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
208 (newline (/ n 2)) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
209 (insert "[Middle of page left blank for didactic purposes. " |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
210 "Text continues below]") |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
211 (newline (- n (/ n 2))))) |
409 | 212 (goto-char (point-min)) |
213 (set-buffer-modified-p nil)))) | |
214 | |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
215 (defun describe-key-briefly (key &optional insert) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
216 "Print the name of the function KEY invokes. KEY is a string. |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
217 If INSERT (the prefix arg) is non-nil, insert the message in the buffer." |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
218 (interactive "kDescribe key briefly: \nP") |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
219 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
220 (let ((modifiers (event-modifiers (aref key 0))) |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
221 (standard-output (if insert (current-buffer) t)) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
222 window position) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
223 ;; For a mouse button event, go to the button it applies to |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
224 ;; to get the right key bindings. And go to the right place |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
225 ;; in case the keymap depends on where you clicked. |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
226 (if (or (memq 'click modifiers) (memq 'down modifiers) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
227 (memq 'drag modifiers)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
228 (setq window (posn-window (event-start (aref key 0))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
229 position (posn-point (event-start (aref key 0))))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
230 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
231 (progn |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
232 (set-buffer (window-buffer window)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
233 (goto-char position))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
234 ;; Ok, now look up the key and name the command. |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
235 (let ((defn (key-binding key)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
236 (key-desc (key-description key))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
237 (if (or (null defn) (integerp defn)) |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
238 (princ (format "%s is undefined" key-desc)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
239 (princ (format (if insert |
22060
530d5f35aa4e
(describe-key-briefly): When INSERT, put cmd name in `...'.
Richard M. Stallman <rms@gnu.org>
parents:
21973
diff
changeset
|
240 "`%s' (`%s')" |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
241 (if (windowp window) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
242 "%s at that spot runs the command %s" |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
243 "%s runs the command %s")) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
244 key-desc |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
245 (if (symbolp defn) defn (prin1-to-string defn))))))))) |
409 | 246 |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
247 (defvar help-return-method nil |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
248 "What to do to \"exit\" the help buffer. |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
249 This is a list |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
250 (WINDOW . t) delete the selected window, go to WINDOW. |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
251 (WINDOW . quit-window) do quit-window, then select WINDOW. |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
252 (WINDOW BUF START POINT) display BUF at START, POINT, then select WINDOW.") |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
253 |
409 | 254 (defun print-help-return-message (&optional function) |
255 "Display or return message saying how to restore windows after help command. | |
256 Computes a message and applies the optional argument FUNCTION to it. | |
257 If FUNCTION is nil, applies `message' to it, thus printing it." | |
258 (and (not (get-buffer-window standard-output)) | |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
259 (let ((first-message |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
260 (cond ((special-display-p (buffer-name standard-output)) |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
261 (setq help-return-method (cons (selected-window) t)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
262 ;; If the help output buffer is a special display buffer, |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
263 ;; don't say anything about how to get rid of it. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
264 ;; First of all, the user will do that with the window |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
265 ;; manager, not with Emacs. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
266 ;; Secondly, the buffer has not been displayed yet, |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
267 ;; so we don't know whether its frame will be selected. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
268 nil) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
269 ((not (one-window-p t)) |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
270 (setq help-return-method |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
271 (cons (selected-window) 'quit-window)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
272 "Type \\[switch-to-buffer-other-window] RET to restore the other window.") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
273 (pop-up-windows |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
274 (setq help-return-method (cons (selected-window) t)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
275 "Type \\[delete-other-windows] to remove help window.") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
276 (t |
21188
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
277 (setq help-return-method |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
278 (list (selected-window) (window-buffer) |
607ce9d7cf53
(help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
20953
diff
changeset
|
279 (window-start) (window-point))) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
280 "Type \\[switch-to-buffer] RET to remove help window.")))) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
281 (funcall (or function 'message) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
282 (concat |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
283 (if first-message |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
284 (substitute-command-keys first-message) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
285 "") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
286 (if first-message " " "") |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
287 ;; If the help buffer will go in a separate frame, |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
288 ;; it's no use mentioning a command to scroll, so don't. |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
289 (if (special-display-p (buffer-name standard-output)) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
290 nil |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
291 (if (same-window-p (buffer-name standard-output)) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
292 ;; Say how to scroll this window. |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
293 (substitute-command-keys |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
294 "\\[scroll-up] to scroll the help.") |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
295 ;; Say how to scroll some other window. |
11428
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
296 (substitute-command-keys |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
297 "\\[scroll-other-window] to scroll the help.")))))))) |
409 | 298 |
299 (defun describe-key (key) | |
300 "Display documentation of the function invoked by KEY. KEY is a string." | |
301 (interactive "kDescribe key: ") | |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
302 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
303 (let ((modifiers (event-modifiers (aref key 0))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
304 window position) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
305 ;; For a mouse button event, go to the button it applies to |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
306 ;; to get the right key bindings. And go to the right place |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
307 ;; in case the keymap depends on where you clicked. |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
308 (if (or (memq 'click modifiers) (memq 'down modifiers) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
309 (memq 'drag modifiers)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
310 (setq window (posn-window (event-start (aref key 0))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
311 position (posn-point (event-start (aref key 0))))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
312 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
313 (progn |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
314 (set-buffer (window-buffer window)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
315 (goto-char position))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
316 (let ((defn (key-binding key))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
317 (if (or (null defn) (integerp defn)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
318 (message "%s is undefined" (key-description key)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
319 (with-output-to-temp-buffer "*Help*" |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
320 (princ (key-description key)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
321 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
322 (princ " at that spot")) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
323 (princ " runs the command ") |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
324 (prin1 defn) |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
325 (princ "\n which is ") |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
326 (describe-function-1 defn nil) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
327 (print-help-return-message))))))) |
409 | 328 |
6902
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
329 (defun describe-mode () |
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
330 "Display documentation of current major mode and minor modes. |
23778
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
331 The major mode description comes first, followed by the minor modes, |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
332 each on a separate page. |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
333 |
409 | 334 For this to work correctly for a minor mode, the mode's indicator variable |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
335 \(listed in `minor-mode-alist') must also be a function whose documentation |
409 | 336 describes the minor mode." |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
337 (interactive) |
409 | 338 (with-output-to-temp-buffer "*Help*" |
23778
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
339 (when minor-mode-alist |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
340 (princ "The major mode is described first. |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
341 For minor modes, see following pages.\n\n")) |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
342 (princ mode-name) |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
343 (princ " mode:\n") |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
344 (princ (documentation major-mode)) |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
345 (help-setup-xref (list #'help-xref-mode (current-buffer)) (interactive-p)) |
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
346 (let ((minor-modes minor-mode-alist)) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
347 (while minor-modes |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
348 (let* ((minor-mode (car (car minor-modes))) |
16694
c19089a334b2
(describe-mode): Include minor modes that aren't buffer local.
Richard M. Stallman <rms@gnu.org>
parents:
16557
diff
changeset
|
349 (indicator (car (cdr (car minor-modes))))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
350 ;; Document a minor mode if it is listed in minor-mode-alist, |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
351 ;; bound locally in this buffer, non-nil, and has a function |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
352 ;; definition. |
16694
c19089a334b2
(describe-mode): Include minor modes that aren't buffer local.
Richard M. Stallman <rms@gnu.org>
parents:
16557
diff
changeset
|
353 (if (and (symbol-value minor-mode) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
354 (fboundp minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
355 (let ((pretty-minor-mode minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
356 (if (string-match "-mode$" (symbol-name minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
357 (setq pretty-minor-mode |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
358 (capitalize |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
359 (substring (symbol-name minor-mode) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
360 0 (match-beginning 0))))) |
23742
8c57752f8e9c
(describe-mode): Don't avoid loop indirecting thru value of INDICATOR.
Richard M. Stallman <rms@gnu.org>
parents:
23741
diff
changeset
|
361 (while (and indicator (symbolp indicator) |
8c57752f8e9c
(describe-mode): Don't avoid loop indirecting thru value of INDICATOR.
Richard M. Stallman <rms@gnu.org>
parents:
23741
diff
changeset
|
362 (boundp indicator) |
8c57752f8e9c
(describe-mode): Don't avoid loop indirecting thru value of INDICATOR.
Richard M. Stallman <rms@gnu.org>
parents:
23741
diff
changeset
|
363 (not (eq indicator (symbol-value indicator)))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
364 (setq indicator (symbol-value indicator))) |
23778
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
365 (princ "\n\f\n") |
14832
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
366 (princ (format "%s minor mode (%s):\n" |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
367 pretty-minor-mode |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
368 (if indicator |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
369 (format "indicator%s" indicator) |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
370 "no indicator"))) |
23778
9cee50f0ec56
(describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents:
23749
diff
changeset
|
371 (princ (documentation minor-mode))))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
372 (setq minor-modes (cdr minor-modes)))) |
409 | 373 (print-help-return-message))) |
374 | |
375 ;; So keyboard macro definitions are documented correctly | |
376 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
377 | |
378 (defun describe-distribution () | |
379 "Display info on how to obtain the latest version of GNU Emacs." | |
380 (interactive) | |
381 (find-file-read-only | |
444 | 382 (expand-file-name "DISTRIB" data-directory))) |
409 | 383 |
384 (defun describe-copying () | |
385 "Display info on how you may redistribute copies of GNU Emacs." | |
386 (interactive) | |
387 (find-file-read-only | |
444 | 388 (expand-file-name "COPYING" data-directory)) |
409 | 389 (goto-char (point-min))) |
390 | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
391 (defun describe-project () |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
392 "Display info on the GNU project." |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
393 (interactive) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
394 (find-file-read-only |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
395 (expand-file-name "GNU" data-directory)) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
396 (goto-char (point-min))) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
397 |
409 | 398 (defun describe-no-warranty () |
399 "Display info on all the kinds of warranty Emacs does NOT have." | |
400 (interactive) | |
401 (describe-copying) | |
402 (let (case-fold-search) | |
403 (search-forward "NO WARRANTY") | |
404 (recenter 0))) | |
405 | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
406 (defun describe-prefix-bindings () |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
407 "Describe the bindings of the prefix used to reach this command. |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
408 The prefix described consists of all but the last event |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
409 of the key sequence that ran this command." |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
410 (interactive) |
11890
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
411 (let* ((key (this-command-keys))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
412 (describe-bindings |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
413 (if (stringp key) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
414 (substring key 0 (1- (length key))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
415 (let ((prefix (make-vector (1- (length key)) nil)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
416 (i 0)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
417 (while (< i (length prefix)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
418 (aset prefix i (aref key i)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
419 (setq i (1+ i))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
420 prefix))))) |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
421 ;; Make C-h after a prefix, when not specifically bound, |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
422 ;; run describe-prefix-bindings. |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
423 (setq prefix-help-command 'describe-prefix-bindings) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
424 |
21210
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
425 (defun view-emacs-news (&optional arg) |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
426 "Display info on recent changes to Emacs. |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
427 With numeric argument display information on correspondingly older changes." |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
428 (interactive "P") |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
429 (let* ((arg (if arg (prefix-numeric-value arg) 0))) |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
430 (find-file-read-only |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
431 (expand-file-name (concat (make-string arg ?O) "NEWS") |
2a51a4912199
(view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents:
21188
diff
changeset
|
432 data-directory)))) |
409 | 433 |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
434 (defun view-emacs-FAQ () |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
435 "Display the Emacs Frequently Asked Questions (FAQ) file." |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
436 (interactive) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
437 (find-file-read-only (expand-file-name "FAQ" data-directory))) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
438 |
409 | 439 (defun view-lossage () |
440 "Display last 100 input keystrokes." | |
441 (interactive) | |
442 (with-output-to-temp-buffer "*Help*" | |
8504
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
443 (princ (mapconcat (function (lambda (key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
444 (if (or (integerp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
445 (symbolp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
446 (listp key)) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
447 (single-key-description key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
448 (prin1-to-string key nil)))) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
449 (recent-keys) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
450 " ")) |
409 | 451 (save-excursion |
452 (set-buffer standard-output) | |
453 (goto-char (point-min)) | |
454 (while (progn (move-to-column 50) (not (eobp))) | |
455 (search-forward " " nil t) | |
21973
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
456 (insert "\n")) |
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
457 (setq help-xref-stack nil |
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
458 help-xref-stack-item nil)) |
409 | 459 (print-help-return-message))) |
460 | |
6580 | 461 (defalias 'help 'help-for-help) |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
462 (make-help-screen help-for-help |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
463 "a b c C f F C-f i I k C-k l L m n p s t v w C-c C-d C-n C-p C-w; ? for help:" |
23332
d0403c974cac
(help-for-help): Use %THIS-KEY%.
Richard M. Stallman <rms@gnu.org>
parents:
23291
diff
changeset
|
464 "You have typed %THIS-KEY%, the help character. Type a Help option: |
10479
f2f290b13413
(help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
10196
diff
changeset
|
465 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.) |
409 | 466 |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
467 a command-apropos. Give a substring, and see a list of commands |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
468 (functions interactively callable) that contain |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
469 that substring. See also the apropos command. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
470 b describe-bindings. Display table of all key bindings. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
471 c describe-key-briefly. Type a command key sequence; |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
472 it prints the function name that sequence runs. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
473 C describe-coding-system. This describes either a specific coding system |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
474 (if you type its name) or the coding systems currently in use |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
475 (if you type just RET). |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
476 f describe-function. Type a function name and get documentation of it. |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
477 C-f Info-goto-emacs-command-node. Type a function name; |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
478 it takes you to the Info node for that command. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
479 i info. The info documentation reader. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
480 I describe-input-method. Describe a specific input method (if you type |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
481 its name) or the current input method (if you type just RET). |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
482 k describe-key. Type a command key sequence; |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
483 it displays the full documentation. |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
484 C-k Info-goto-emacs-key-command-node. Type a command key sequence; |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
485 it takes you to the Info node for the command bound to that key. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
486 l view-lossage. Shows last 100 characters you typed. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
487 L describe-language-environment. This describes either the a |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
488 specific language environment (if you type its name) |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
489 or the current language environment (if you type just RET). |
20250
e29142cee7c3
(help-for-help): Update text for `m'.
Karl Heuer <kwzh@gnu.org>
parents:
20243
diff
changeset
|
490 m describe-mode. Print documentation of current minor modes, |
e29142cee7c3
(help-for-help): Update text for `m'.
Karl Heuer <kwzh@gnu.org>
parents:
20243
diff
changeset
|
491 and the current major mode, including their special commands. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
492 n view-emacs-news. Shows emacs news file. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
493 p finder-by-keyword. Find packages matching a given topic keyword. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
494 s describe-syntax. Display contents of syntax table, plus explanations |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
495 t help-with-tutorial. Select the Emacs learn-by-doing tutorial. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
496 v describe-variable. Type name of a variable; |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
497 it displays the variable's documentation and value. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
498 w where-is. Type command name; it prints which keystrokes |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
499 invoke that command. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
500 |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
501 F Display the frequently asked questions file. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
502 h Display the HELLO file which illustrates various scripts. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
503 C-c Display Emacs copying permission (General Public License). |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
504 C-d Display Emacs ordering information. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
505 C-n Display news of recent Emacs changes. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
506 C-p Display information about the GNU project. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
507 C-w Display information on absence of warranty for GNU Emacs." |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
508 help-map) |
409 | 509 |
23962
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
510 ;; Return a function whose name is around point. |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
511 ;; If that gives no function, return a function which is called by the |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
512 ;; list containing point. |
409 | 513 ;; If that doesn't give a function, return nil. |
514 (defun function-called-at-point () | |
20077
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
515 (let ((stab (syntax-table))) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
516 (set-syntax-table emacs-lisp-mode-syntax-table) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
517 (unwind-protect |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
518 (or (condition-case () |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
519 (save-excursion |
23962
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
520 (or (not (zerop (skip-syntax-backward "_w"))) |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
521 (eq (char-syntax (following-char)) ?w) |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
522 (eq (char-syntax (following-char)) ?_) |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
523 (forward-sexp -1)) |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
524 (skip-chars-forward "'") |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
525 (let ((obj (read (current-buffer)))) |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
526 (and (symbolp obj) (fboundp obj) obj))) |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
527 (error nil)) |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
528 (condition-case () |
5ab992b6ca59
(function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents:
23922
diff
changeset
|
529 (save-excursion |
20077
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
530 (save-restriction |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
531 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max)) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
532 ;; Move up to surrounding paren, then after the open. |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
533 (backward-up-list 1) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
534 (forward-char 1) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
535 ;; If there is space here, this is probably something |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
536 ;; other than a real Lisp function call, so ignore it. |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
537 (if (looking-at "[ \t]") |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
538 (error "Probably not a Lisp function call")) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
539 (let (obj) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
540 (setq obj (read (current-buffer))) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
541 (and (symbolp obj) (fboundp obj) obj)))) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
542 (error nil))) |
437758b7ca50
(function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents:
20069
diff
changeset
|
543 (set-syntax-table stab)))) |
409 | 544 |
23853
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
545 (defvar symbol-file-load-history-loaded nil |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
546 "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'. |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
547 That file records the part of `load-history' for preloaded files, |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
548 which is cleared out before dumping to make Emacs smaller.") |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
549 |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
550 (defun symbol-file (function) |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
551 "Return the input source from which SYM was loaded. |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
552 The value is normally a string that was passed to `load': |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
553 either an absolute file name, or a library name |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
554 \(with no directory name and no `.el' or `.elc' at the end). |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
555 It can also be nil, if the definition is not associated with any file." |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
556 (unless symbol-file-load-history-loaded |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
557 (load (expand-file-name |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
558 ;; fns-XX.YY.ZZ.el does not work on DOS filesystem. |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
559 (if (eq system-type 'ms-dos) |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
560 "fns.el" |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
561 (format "fns-%s.el" emacs-version)) |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
562 exec-directory) |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
563 ;; The file name fns-%s.el already has a .el extension. |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
564 nil nil t) |
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
565 (setq symbol-file-load-history-loaded t)) |
9639
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
566 (let ((files load-history) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
567 file functions) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
568 (while files |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
569 (if (memq function (cdr (car files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
570 (setq file (car (car files)) files nil)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
571 (setq files (cdr files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
572 file)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
573 |
409 | 574 (defun describe-function (function) |
575 "Display the full documentation of FUNCTION (a symbol)." | |
576 (interactive | |
577 (let ((fn (function-called-at-point)) | |
578 (enable-recursive-minibuffers t) | |
579 val) | |
580 (setq val (completing-read (if fn | |
581 (format "Describe function (default %s): " fn) | |
582 "Describe function: ") | |
20069
1f8e6121713d
(describe-variable): Pass default value to completing-read.
Karl Heuer <kwzh@gnu.org>
parents:
20060
diff
changeset
|
583 obarray 'fboundp t nil nil (symbol-name fn))) |
409 | 584 (list (if (equal val "") |
585 fn (intern val))))) | |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
586 (if function |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
587 (with-output-to-temp-buffer "*Help*" |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
588 (prin1 function) |
19124
e5e8552b076a
(describe-function): Use " is " instead of colon.
Richard M. Stallman <rms@gnu.org>
parents:
18632
diff
changeset
|
589 ;; Use " is " instead of a colon so that |
e5e8552b076a
(describe-function): Use " is " instead of colon.
Richard M. Stallman <rms@gnu.org>
parents:
18632
diff
changeset
|
590 ;; it is easier to get out the function name using forward-sexp. |
e5e8552b076a
(describe-function): Use " is " instead of colon.
Richard M. Stallman <rms@gnu.org>
parents:
18632
diff
changeset
|
591 (princ " is ") |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
592 (describe-function-1 function nil) |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
593 (print-help-return-message) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
594 (save-excursion |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
595 (set-buffer standard-output) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
596 ;; Return the text we displayed. |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
597 (buffer-string))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
598 (message "You didn't specify a function"))) |
409 | 599 |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
600 (defun describe-function-1 (function parens) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
601 (let* ((def (symbol-function function)) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
602 file-name string need-close |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
603 (beg (if (commandp def) "an interactive " "a "))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
604 (setq string |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
605 (cond ((or (stringp def) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
606 (vectorp def)) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
607 "a keyboard macro") |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
608 ((subrp def) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
609 (concat beg "built-in function")) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
610 ((byte-code-function-p def) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
611 (concat beg "compiled Lisp function")) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
612 ((symbolp def) |
22973
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
613 (while (symbolp (symbol-function def)) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
614 (setq def (symbol-function def))) |
23818
19e467700712
(describe-function-1): Fix description for alias.
Dave Love <fx@gnu.org>
parents:
23797
diff
changeset
|
615 (format "an alias for `%s'" def)) |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
616 ((eq (car-safe def) 'lambda) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
617 (concat beg "Lisp function")) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
618 ((eq (car-safe def) 'macro) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
619 "a Lisp macro") |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
620 ((eq (car-safe def) 'mocklisp) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
621 "a mocklisp function") |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
622 ((eq (car-safe def) 'autoload) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
623 (setq file-name (nth 1 def)) |
23922
81d1dacd379e
(describe-function-1): Say "keymap", not "Lisp macro",
Andreas Schwab <schwab@suse.de>
parents:
23853
diff
changeset
|
624 (format "%s autoloaded %s" |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
625 (if (commandp def) "an interactive" "an") |
23922
81d1dacd379e
(describe-function-1): Say "keymap", not "Lisp macro",
Andreas Schwab <schwab@suse.de>
parents:
23853
diff
changeset
|
626 (if (eq (nth 4 def) 'keymap) "keymap" |
81d1dacd379e
(describe-function-1): Say "keymap", not "Lisp macro",
Andreas Schwab <schwab@suse.de>
parents:
23853
diff
changeset
|
627 (if (nth 4 def) "Lisp macro" "Lisp function")) |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
628 )) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
629 (t ""))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
630 (when (and parens (not (equal string ""))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
631 (setq need-close t) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
632 (princ "(")) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
633 (princ string) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
634 (or file-name |
23853
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
635 (setq file-name (symbol-file function))) |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
636 (if file-name |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
637 (progn |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
638 (princ " in `") |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
639 ;; We used to add .el to the file name, |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
640 ;; but that's completely wrong when the user used load-file. |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
641 (princ file-name) |
21695
2c9cfb84bf1b
(describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents:
21587
diff
changeset
|
642 (princ "'") |
2c9cfb84bf1b
(describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents:
21587
diff
changeset
|
643 ;; Make a hyperlink to the library. |
2c9cfb84bf1b
(describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents:
21587
diff
changeset
|
644 (with-current-buffer "*Help*" |
2c9cfb84bf1b
(describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents:
21587
diff
changeset
|
645 (save-excursion |
2c9cfb84bf1b
(describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents:
21587
diff
changeset
|
646 (re-search-backward "`\\([^`']+\\)'" nil t) |
21972
9c71660c0a8d
(describe-function-1): Use find-function-noselect instead of find-function.
Richard M. Stallman <rms@gnu.org>
parents:
21708
diff
changeset
|
647 (help-xref-button 1 #'(lambda (arg) |
9c71660c0a8d
(describe-function-1): Use find-function-noselect instead of find-function.
Richard M. Stallman <rms@gnu.org>
parents:
21708
diff
changeset
|
648 (let ((location |
9c71660c0a8d
(describe-function-1): Use find-function-noselect instead of find-function.
Richard M. Stallman <rms@gnu.org>
parents:
21708
diff
changeset
|
649 (find-function-noselect arg))) |
22850
e7684a1dd417
(describe-function-1): Fix the code that uses find-function-noselect.
Richard M. Stallman <rms@gnu.org>
parents:
22470
diff
changeset
|
650 (pop-to-buffer (car location)) |
e7684a1dd417
(describe-function-1): Fix the code that uses find-function-noselect.
Richard M. Stallman <rms@gnu.org>
parents:
22470
diff
changeset
|
651 (goto-char (cdr location)))) |
21972
9c71660c0a8d
(describe-function-1): Use find-function-noselect instead of find-function.
Richard M. Stallman <rms@gnu.org>
parents:
21708
diff
changeset
|
652 function))))) |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
653 (if need-close (princ ")")) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
654 (princ ".") |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
655 (terpri) |
22973
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
656 ;; Handle symbols aliased to other symbols. |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
657 (setq def (indirect-function def)) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
658 ;; If definition is a macro, find the function inside it. |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
659 (if (eq (car-safe def) 'macro) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
660 (setq def (cdr def))) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
661 (let ((arglist (cond ((byte-code-function-p def) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
662 (car (append def nil))) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
663 ((eq (car-safe def) 'lambda) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
664 (nth 1 def)) |
c3bbca1b6f3a
(describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents:
22850
diff
changeset
|
665 (t t)))) |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
666 (if (listp arglist) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
667 (progn |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
668 (princ (cons function |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
669 (mapcar (lambda (arg) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
670 (if (memq arg '(&optional &rest)) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
671 arg |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
672 (intern (upcase (symbol-name arg))))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
673 arglist))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
674 (terpri)))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
675 (let ((doc (documentation function))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
676 (if doc |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
677 (progn (terpri) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
678 (princ doc) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
679 (help-setup-xref (list #'describe-function function) (interactive-p))) |
21491
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
680 (princ "not documented"))))) |
7a8169a735f5
(describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents:
21440
diff
changeset
|
681 |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
682 ;; We return 0 if we can't find a variable to return. |
409 | 683 (defun variable-at-point () |
684 (condition-case () | |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
685 (let ((stab (syntax-table))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
686 (unwind-protect |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
687 (save-excursion |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
688 (set-syntax-table emacs-lisp-mode-syntax-table) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
689 (or (not (zerop (skip-syntax-backward "_w"))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
690 (eq (char-syntax (following-char)) ?w) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
691 (eq (char-syntax (following-char)) ?_) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
692 (forward-sexp -1)) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
693 (skip-chars-forward "'") |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
694 (let ((obj (read (current-buffer)))) |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
695 (or (and (symbolp obj) (boundp obj) obj) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
696 0))) |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
697 (set-syntax-table stab))) |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
698 (error 0))) |
409 | 699 |
700 (defun describe-variable (variable) | |
701 "Display the full documentation of VARIABLE (a symbol). | |
702 Returns the documentation as a string, also." | |
703 (interactive | |
704 (let ((v (variable-at-point)) | |
705 (enable-recursive-minibuffers t) | |
706 val) | |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
707 (setq val (completing-read (if (symbolp v) |
409 | 708 (format "Describe variable (default %s): " v) |
709 "Describe variable: ") | |
20290
456ed25a8605
(describe-variable): Don't use symbol-name if v isn't symbol.
Karl Heuer <kwzh@gnu.org>
parents:
20286
diff
changeset
|
710 obarray 'boundp t nil nil |
456ed25a8605
(describe-variable): Don't use symbol-name if v isn't symbol.
Karl Heuer <kwzh@gnu.org>
parents:
20286
diff
changeset
|
711 (if (symbolp v) (symbol-name v)))) |
409 | 712 (list (if (equal val "") |
713 v (intern val))))) | |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
714 (if (symbolp variable) |
16557
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
715 (let (valvoid) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
716 (with-output-to-temp-buffer "*Help*" |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
717 (prin1 variable) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
718 (if (not (boundp variable)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
719 (progn |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
720 (princ " is void") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
721 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
722 (setq valvoid t)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
723 (princ "'s value is ") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
724 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
725 (pp (symbol-value variable)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
726 (terpri)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
727 (if (local-variable-p variable) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
728 (progn |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
729 (princ (format "Local in buffer %s; " (buffer-name))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
730 (if (not (default-boundp variable)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
731 (princ "globally void") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
732 (princ "global value is ") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
733 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
734 (pp (default-value variable))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
735 (terpri))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
736 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
737 (save-current-buffer |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
738 (set-buffer standard-output) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
739 (if (> (count-lines (point-min) (point-max)) 10) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
740 (progn |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
741 (goto-char (point-min)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
742 (if valvoid |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
743 (forward-line 1) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
744 (forward-sexp 1) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
745 (delete-region (point) (progn (end-of-line) (point))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
746 (insert "'s value is shown below.\n\n") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
747 (save-excursion |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
748 (insert "\n\nValue:")))))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
749 (princ "Documentation:") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
750 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
751 (let ((doc (documentation-property variable 'variable-documentation))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
752 (princ (or doc "not documented as a variable."))) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
753 (help-setup-xref (list #'describe-variable variable) (interactive-p)) |
22234
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
754 |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
755 ;; Make a link to customize if this variable can be customized. |
23741
0146ed131b2a
(describe-variable): Allow any variable with a defcustom,
Richard M. Stallman <rms@gnu.org>
parents:
23640
diff
changeset
|
756 ;; Note, it is not reliable to test only for a custom-type property |
22407 | 757 ;; because those are only present after the var's definition |
758 ;; has been loaded. | |
23741
0146ed131b2a
(describe-variable): Allow any variable with a defcustom,
Richard M. Stallman <rms@gnu.org>
parents:
23640
diff
changeset
|
759 (if (or (user-variable-p variable) (get variable 'custom-type)) |
22234
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
760 (let ((customize-label "customize")) |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
761 (terpri) |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
762 (terpri) |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
763 (princ (concat "You can " customize-label " this variable.")) |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
764 (with-current-buffer "*Help*" |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
765 (save-excursion |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
766 (re-search-backward |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
767 (concat "\\(" customize-label "\\)") nil t) |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
768 (help-xref-button 1 #'(lambda (v) |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
769 (customize-variable v)) variable) |
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
770 )))) |
23591
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
771 ;; Make a hyperlink to the library if appropriate. (Don't |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
772 ;; change the format of the buffer's initial line in case |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
773 ;; anything expects the current format.) |
23853
e9fe8ed71303
(symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents:
23818
diff
changeset
|
774 (let ((file-name (symbol-file variable))) |
23591
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
775 (when file-name |
23787
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
776 (princ "\n\nDefined in `") |
23591
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
777 (princ file-name) |
23787
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
778 (princ "'.") |
23591
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
779 (with-current-buffer "*Help*" |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
780 (save-excursion |
23787
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
781 (re-search-backward "`\\([^`']+\\)'" nil t) |
23591
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
782 (help-xref-button 1 (lambda (arg) |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
783 (let ((location |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
784 (find-variable-noselect arg))) |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
785 (pop-to-buffer (car location)) |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
786 (goto-char (cdr location)))) |
9487b796b92c
(describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents:
23333
diff
changeset
|
787 variable))))) |
22234
40229c79e16b
(describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents:
22060
diff
changeset
|
788 |
16557
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
789 (print-help-return-message) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
790 (save-excursion |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
791 (set-buffer standard-output) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
792 ;; Return the text we displayed. |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
793 (buffer-string)))) |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
794 (message "You did not specify a variable"))) |
409 | 795 |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
796 (defun describe-bindings (&optional prefix buffer) |
20848
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
797 "Show a list of all defined keys, and their definitions. |
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
798 We put that list in a buffer, and display the buffer. |
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
799 |
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
800 The optional argument PREFIX, if non-nil, should be a key sequence; |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
801 then we display only bindings that start with that prefix. |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
802 The optional argument BUFFER specifies which buffer's bindings |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
803 to display (default, the current buffer)." |
20882
6566e48896f4
(describe-bindings): Fix interactive spec.
Richard M. Stallman <rms@gnu.org>
parents:
20848
diff
changeset
|
804 (interactive "P") |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
805 (or buffer (setq buffer (current-buffer))) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
806 (with-current-buffer buffer |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
807 (describe-bindings-internal nil prefix)) |
21973
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
808 (with-current-buffer "*Help*" |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
809 (help-setup-xref (list #'describe-bindings prefix buffer) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
810 (interactive-p)))) |
20848
4c3e62fe8898
(describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents:
20290
diff
changeset
|
811 |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
812 (defun where-is (definition &optional insert) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
813 "Print message listing key sequences that invoke specified command. |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
814 Argument is a command definition, usually a symbol with a function definition. |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
815 If INSERT (the prefix arg) is non-nil, insert the message in the buffer." |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
816 (interactive |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
817 (let ((fn (function-called-at-point)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
818 (enable-recursive-minibuffers t) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
819 val) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
820 (setq val (completing-read (if fn |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
821 (format "Where is command (default %s): " fn) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
822 "Where is command: ") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
823 obarray 'fboundp t)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
824 (list (if (equal val "") |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
825 fn (intern val)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
826 current-prefix-arg))) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
827 (let* ((keys (where-is-internal definition overriding-local-map nil nil)) |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
828 (keys1 (mapconcat 'key-description keys ", ")) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
829 (standard-output (if insert (current-buffer) t))) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
830 (if insert |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
831 (if (> (length keys1) 0) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
832 (princ (format "%s (%s)" keys1 definition)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
833 (princ (format "M-x %s RET" definition))) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
834 (if (> (length keys1) 0) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
835 (princ (format "%s is on %s" definition keys1)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
836 (princ (format "%s is not on any key" definition))))) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
837 nil) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
838 |
16273
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
839 (defun locate-library (library &optional nosuffix path interactive-call) |
16063
b4427bbd451e
(locate-library): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
15826
diff
changeset
|
840 "Show the precise file name of Emacs library LIBRARY. |
409 | 841 This command searches the directories in `load-path' like `M-x load-library' |
842 to find the file that `M-x load-library RET LIBRARY RET' would load. | |
843 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el' | |
16064
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
844 to the specified name LIBRARY. |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
845 |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
846 If the optional third arg PATH is specified, that list of directories |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
847 is used instead of `load-path'." |
16273
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
848 (interactive (list (read-string "Locate library: ") |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
849 nil nil |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
850 t)) |
20176
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
851 (let (result) |
16273
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
852 (catch 'answer |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
853 (mapcar |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
854 (lambda (dir) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
855 (mapcar |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
856 (lambda (suf) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
857 (let ((try (expand-file-name (concat library suf) dir))) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
858 (and (file-readable-p try) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
859 (null (file-directory-p try)) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
860 (progn |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
861 (setq result try) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
862 (throw 'answer try))))) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
863 (if nosuffix |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
864 '("") |
20176
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
865 '(".elc" ".el" "") |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
866 ;;; load doesn't handle this yet. |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
867 ;;; (let ((basic '(".elc" ".el" "")) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
868 ;;; (compressed '(".Z" ".gz" ""))) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
869 ;;; ;; If autocompression mode is on, |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
870 ;;; ;; consider all combinations of library suffixes |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
871 ;;; ;; and compression suffixes. |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
872 ;;; (if (rassq 'jka-compr-handler file-name-handler-alist) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
873 ;;; (apply 'nconc |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
874 ;;; (mapcar (lambda (compelt) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
875 ;;; (mapcar (lambda (baselt) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
876 ;;; (concat baselt compelt)) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
877 ;;; basic)) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
878 ;;; compressed)) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
879 ;;; basic)) |
fb907b54fe26
(locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents:
20133
diff
changeset
|
880 ))) |
16273
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
881 (or path load-path))) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
882 (and interactive-call |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
883 (if result |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
884 (message "Library is file %s" result) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
885 (message "No library %s in search path" library))) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
886 result)) |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
887 |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
888 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
889 ;;; Grokking cross-reference information in doc strings and |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
890 ;;; hyperlinking it. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
891 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
892 ;; This may have some scope for extension and the same or something |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
893 ;; similar should be done for widget doc strings, which currently use |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
894 ;; another mechanism. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
895 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
896 (defcustom help-highlight-p t |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
897 "*If non-nil, `help-make-xrefs' highlight cross-references. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
898 Under a window system it highlights them with face defined by |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
899 `help-highlight-face'. On a character terminal highlighted |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
900 references look like cross-references in info mode." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
901 :group 'help |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
902 :version "20.3" |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
903 :type 'boolean) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
904 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
905 (defcustom help-highlight-face 'underline |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
906 "Face used by `help-make-xrefs' to highlight cross-references. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
907 Must be previously-defined." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
908 :group 'help |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
909 :version "20.3" |
21698
9ebbb53c1c20
(help-highlight-face): Use `face' as custom type.
Richard M. Stallman <rms@gnu.org>
parents:
21695
diff
changeset
|
910 :type 'face) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
911 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
912 (defvar help-back-label "[back]" |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
913 "Label to use by `help-make-xrefs' for the go-back reference.") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
914 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
915 (defvar help-xref-symbol-regexp |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
916 (concat "\\(\\<\\(\\(variable\\|option\\)\\|" |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
917 "\\(function\\|command\\)\\|" |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
918 "\\(symbol\\)\\)\\s-+\\)?" |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
919 ;; Note starting with word-syntax character: |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
920 "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
921 "Regexp matching doc string references to symbols. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
922 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
923 The words preceding the quoted symbol can be used in doc strings to |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
924 distinguish references to variables, functions and symbols.") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
925 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
926 (defvar help-xref-info-regexp |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
927 "\\<info\\s-+node\\s-`\\([^']+\\)'" |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
928 "Regexp matching doc string references to an Info node.") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
929 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
930 (defun help-setup-xref (item interactive-p) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
931 "Invoked from commands using the \"*Help*\" buffer to install some xref info. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
932 |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
933 ITEM is a (FUNCTION . ARGS) pair appropriate for recreating the help |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
934 buffer after following a reference. INTERACTIVE-P is non-nil if the |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
935 calling command was invoked interactively. In this case the stack of |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
936 items for help buffer \"back\" buttons is cleared." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
937 (if interactive-p |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
938 (setq help-xref-stack nil)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
939 (setq help-xref-stack-item item)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
940 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
941 (defun help-make-xrefs (&optional buffer) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
942 "Parse and hyperlink documentation cross-references in the given BUFFER. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
943 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
944 Find cross-reference information in a buffer and, if |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
945 `help-highlight-p' is non-nil, highlight it with face defined by |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
946 `help-highlight-face'; activate such cross references for selection |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
947 with `help-follow'. Cross-references have the canonical form `...' |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
948 and the type of reference may be disambiguated by the preceding |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
949 word(s) used in `help-xref-symbol-regexp'. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
950 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
951 A special reference `back' is made to return back through a stack of |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
952 help buffers. Variable `help-back-label' specifies the text for |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
953 that." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
954 (interactive "b") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
955 (save-excursion |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
956 (set-buffer (or buffer (current-buffer))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
957 (goto-char (point-min)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
958 ;; Skip the header-type info, though it might be useful to parse |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
959 ;; it at some stage (e.g. "function in `library'"). |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
960 (forward-paragraph) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
961 (let ((old-modified (buffer-modified-p))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
962 (let ((stab (syntax-table)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
963 (case-fold-search t) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
964 (inhibit-read-only t)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
965 (set-syntax-table emacs-lisp-mode-syntax-table) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
966 ;; The following should probably be abstracted out. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
967 (unwind-protect |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
968 (progn |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
969 ;; Quoted symbols |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
970 (save-excursion |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
971 (while (re-search-forward help-xref-symbol-regexp nil t) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
972 (let* ((data (match-string 6)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
973 (sym (intern-soft data))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
974 (if sym |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
975 (cond |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
976 ((match-string 3) ; `variable' &c |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
977 (and (boundp sym) ; `variable' doesn't ensure |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
978 ; it's actually bound |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
979 (help-xref-button 6 #'describe-variable sym))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
980 ((match-string 4) ; `function' &c |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
981 (and (fboundp sym) ; similarly |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
982 (help-xref-button 6 #'describe-function sym))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
983 ((match-string 5)) ; nothing for symbol |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
984 ((and (boundp sym) (fboundp sym)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
985 ;; We can't intuit whether to use the |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
986 ;; variable or function doc -- supply both. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
987 (help-xref-button 6 #'help-xref-interned sym)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
988 ((boundp sym) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
989 (help-xref-button 6 #'describe-variable sym)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
990 ((fboundp sym) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
991 (help-xref-button 6 #'describe-function sym))))))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
992 ;; Info references |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
993 (save-excursion |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
994 (while (re-search-forward help-xref-info-regexp nil t) |
23797
5475f2331d88
(help-make-xrefs): Use `info', not the non-autoloaded
Dave Love <fx@gnu.org>
parents:
23796
diff
changeset
|
995 (help-xref-button 1 #'info (match-string 1)))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
996 ;; An obvious case of a key substitution: |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
997 (save-excursion |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
998 (while (re-search-forward |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
999 "\\<M-x\\s-+\\(\\sw\\(\\sw\\|\\s_\\)+\\)" nil t) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1000 (let ((sym (intern-soft (match-string 1)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1001 (if (fboundp sym) |
21385
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1002 (help-xref-button 1 #'describe-function sym))))) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1003 ;; Look for commands in whole keymap substitutions: |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1004 (save-excursion |
22417
e78006d10683
(help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents:
22407
diff
changeset
|
1005 ;; Make sure to find the first keymap. |
e78006d10683
(help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents:
22407
diff
changeset
|
1006 (goto-char (point-min)) |
21385
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1007 ;; Find a header and the column at which the command |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1008 ;; name will be found. |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1009 (while (re-search-forward "^key +binding\n\\(-+ +\\)-+\n\n" |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1010 nil t) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1011 (let ((col (- (match-end 1) (match-beginning 1)))) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1012 (while |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1013 ;; Ignore single blank lines in table, but not |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1014 ;; double ones, which should terminate it. |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1015 (and (looking-at "^\n?[^\n]") |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1016 (progn |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1017 (if (and (> (move-to-column col) 0) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1018 (looking-at "\\(\\sw\\|\\s_\\)+$")) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1019 ;; |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1020 (let ((sym (intern-soft (match-string 0)))) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1021 (if (fboundp sym) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1022 (help-xref-button |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1023 0 #'describe-function sym)))) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1024 t) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1025 (zerop (forward-line)) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1026 (move-to-column 0))))))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1027 (set-syntax-table stab)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1028 ;; Make a back-reference in this buffer if appropriate. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1029 (when help-xref-stack |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1030 (goto-char (point-max)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1031 (save-excursion |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1032 (insert "\n\n" help-back-label)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1033 ;; Just to provide the match data: |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1034 (looking-at (concat "\n\n\\(" (regexp-quote help-back-label) "\\)")) |
21973
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1035 (help-xref-button 1 #'help-xref-go-back (current-buffer)))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1036 ;; View mode steals RET from us. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1037 (set (make-local-variable 'minor-mode-overriding-map-alist) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1038 (list (cons 'view-mode |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1039 (let ((map (make-sparse-keymap))) |
21385
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1040 (set-keymap-parent map view-mode-map) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1041 (define-key map "\r" 'help-follow) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1042 map)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1043 (set-buffer-modified-p old-modified)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1044 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1045 (defun help-xref-button (match-number function data) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1046 "Make a hyperlink for cross-reference text previously matched. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1047 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1048 MATCH-NUMBER is the subexpression of interest in the last matched |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1049 regexp. FUNCTION is a function to invoke when the button is |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1050 activated, applied to DATA. DATA may be a single value or a list. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1051 See `help-make-xrefs'." |
23787
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1052 ;; Don't mung properties we've added specially in some instances. |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1053 (unless (get-text-property (match-beginning match-number) 'help-xref) |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1054 (add-text-properties (match-beginning match-number) |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1055 (match-end match-number) |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1056 (list 'mouse-face 'highlight |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1057 'help-xref (cons function |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1058 (if (listp data) |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1059 data |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1060 (list data))))) |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1061 (if help-highlight-p |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1062 (put-text-property (match-beginning match-number) |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1063 (match-end match-number) |
2bb8777a3ba7
(help-xref-button): Do nothing if text already has the help-xref property.
Richard M. Stallman <rms@gnu.org>
parents:
23778
diff
changeset
|
1064 'face help-highlight-face)))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1065 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1066 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1067 ;; Additional functions for (re-)creating types of help buffers. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1068 (defun help-xref-interned (symbol) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1069 "Follow a hyperlink which appeared to be an arbitrary interned SYMBOL. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1070 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1071 Both variable and function documentation are extracted into a single |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1072 help buffer." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1073 (let ((fdoc (describe-function symbol))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1074 (describe-variable symbol) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1075 ;; We now have a help buffer on the variable. Insert the function |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1076 ;; text after it. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1077 (goto-char (point-max)) |
23216
cd79894839e7
(help-xref-interned): Bind inhibit-read-only when
Dave Love <fx@gnu.org>
parents:
22973
diff
changeset
|
1078 (let ((inhibit-read-only t)) |
cd79894839e7
(help-xref-interned): Bind inhibit-read-only when
Dave Love <fx@gnu.org>
parents:
22973
diff
changeset
|
1079 (insert "\n\n" fdoc))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1080 (goto-char (point-min)) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1081 (help-setup-xref (list #'help-xref-interned symbol) nil)) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1082 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1083 (defun help-xref-mode (buffer) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1084 "Do a `describe-mode' for the specified BUFFER." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1085 (save-excursion |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1086 (set-buffer buffer) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1087 (describe-mode))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1088 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1089 ;;; Navigation/hyperlinking with xrefs |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1090 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1091 (defun help-follow-mouse (click) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1092 "Follow the cross-reference that you click on." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1093 (interactive "e") |
22417
e78006d10683
(help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents:
22407
diff
changeset
|
1094 (let* ((start (event-start click)) |
e78006d10683
(help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents:
22407
diff
changeset
|
1095 (window (car start)) |
e78006d10683
(help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents:
22407
diff
changeset
|
1096 (pos (car (cdr start)))) |
e78006d10683
(help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents:
22407
diff
changeset
|
1097 (with-current-buffer (window-buffer window) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1098 (help-follow pos)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1099 |
21973
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1100 (defun help-xref-go-back (buffer) |
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1101 "Go back to the previous help buffer text using info on `help-xref-stack'." |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1102 (interactive) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1103 (let (item position method args) |
21973
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1104 (with-current-buffer buffer |
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1105 (when help-xref-stack |
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1106 (setq help-xref-stack (cdr help-xref-stack)) ; due to help-follow |
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1107 (setq item (car help-xref-stack) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1108 position (car item) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1109 method (cadr item) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1110 args (cddr item)) |
21973
f3d29552e393
(view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents:
21972
diff
changeset
|
1111 (setq help-xref-stack (cdr help-xref-stack)))) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1112 (apply method args) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1113 (goto-char position))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1114 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1115 (defun help-go-back () |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1116 (interactive) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1117 (help-follow (1- (point-max)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1118 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1119 (defun help-follow (&optional pos) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1120 "Follow cross-reference at POS, defaulting to point. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1121 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1122 For the cross-reference format, see `help-make-xrefs'." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1123 (interactive "d") |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1124 (let* ((help-data (or (and (not (= pos (point-max))) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1125 (get-text-property pos 'help-xref)) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1126 (and (not (= pos (point-min))) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1127 (get-text-property (1- pos) 'help-xref)))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1128 (method (car help-data)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1129 (args (cdr help-data))) |
22325
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1130 (setq help-xref-stack (cons (cons (point) help-xref-stack-item) |
baef082e5d6d
(help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents:
22234
diff
changeset
|
1131 help-xref-stack)) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1132 (setq help-xref-stack-item nil) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1133 (when help-data |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1134 ;; There is a reference at point. Follow it. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1135 (apply method args)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1136 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1137 ;; For tabbing through buffer. |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1138 (defun help-next-ref () |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1139 "Find the next help cross-reference in the buffer." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1140 (interactive) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1141 (let (pos) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1142 (while (not pos) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1143 (if (get-text-property (point) 'help-xref) ; move off reference |
21385
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1144 (goto-char (or (next-single-property-change (point) 'help-xref) |
a14e82c3a69e
(help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents:
21371
diff
changeset
|
1145 (point)))) |
21371
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1146 (cond ((setq pos (next-single-property-change (point) 'help-xref)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1147 (if pos (goto-char pos))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1148 ((bobp) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1149 (message "No cross references in the buffer.") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1150 (setq pos t)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1151 (t ; be circular |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1152 (goto-char (point-min))))))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1153 |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1154 (defun help-previous-ref () |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1155 "Find the previous help cross-reference in the buffer." |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1156 (interactive) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1157 (let (pos) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1158 (while (not pos) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1159 (if (get-text-property (point) 'help-xref) ; move off reference |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1160 (goto-char (or (previous-single-property-change (point) 'help-xref) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1161 (point)))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1162 (cond ((setq pos (previous-single-property-change (point) 'help-xref)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1163 (if pos (goto-char pos))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1164 ((bobp) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1165 (message "No cross references in the buffer.") |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1166 (setq pos t)) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1167 (t ; be circular |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1168 (goto-char (point-max))))))) |
22a3be0ae9dc
(help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents:
21210
diff
changeset
|
1169 |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1170 |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1171 ;;; Automatic resizing of temporary buffers. |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1172 |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1173 (defcustom temp-buffer-resize-mode nil |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1174 "Non-nil means resize windows displaying temporary buffers. |
23796
cfe23974522e
(temp-buffer-resize-mode): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
23787
diff
changeset
|
1175 This makes the window the right height for its contents, but never |
cfe23974522e
(temp-buffer-resize-mode): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
23787
diff
changeset
|
1176 more than `temp-buffer-max-height' nor less than `window-min-height'. |
cfe23974522e
(temp-buffer-resize-mode): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
23787
diff
changeset
|
1177 This applies to `help', `apropos' and `completion' buffers, and some others. |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1178 |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1179 This variable must be modified via \\[customize] in order to have an effect." |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1180 :get (lambda (symbol) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1181 (and (memq 'resize-temp-buffer-window temp-buffer-show-hook) t)) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1182 :set (lambda (symbol value) |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1183 (temp-buffer-resize-mode (if value 1 -1))) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1184 :initialize 'custom-initialize-default |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1185 :type 'boolean |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1186 :group 'help |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1187 :version "20.4") |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1188 |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1189 (defcustom temp-buffer-max-height (lambda (buffer) (/ (- (frame-height) 2) 2)) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1190 "*Maximum height of a window displaying a temporary buffer. |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1191 This is the maximum height (in text lines) which `resize-temp-buffer-window' |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1192 will give to a window displaying a temporary buffer. |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1193 It can also be a function which will be called with the object corresponding |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1194 to the buffer to be displayed as argument and should return an integer |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1195 positive number." |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1196 :type '(choice integer function) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1197 :group 'help |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1198 :version "20.4") |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1199 |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1200 (defun temp-buffer-resize-mode (arg) |
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1201 "Toggle the mode which that makes windows smaller for temporary buffers. |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1202 With prefix argument ARG, turn the resizing of windows displaying temporary |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1203 buffers on if ARG is positive or off otherwise. |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1204 See the documentation of the variable `temp-buffer-resize-mode' for |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1205 more information." |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1206 (interactive "P") |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1207 (let ((turn-it-on |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1208 (if (null arg) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1209 (not (memq 'resize-temp-buffer-window temp-buffer-show-hook)) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1210 (> (prefix-numeric-value arg) 0)))) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1211 (if turn-it-on |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1212 (progn |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1213 ;; `help-mode-maybe' may add a `back' button and thus increase the |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1214 ;; text size, so `resize-temp-buffer-window' must be run *after* it. |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1215 (add-hook 'temp-buffer-show-hook 'resize-temp-buffer-window 'append) |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1216 (setq temp-buffer-resize-mode t)) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1217 (remove-hook 'temp-buffer-show-hook 'resize-temp-buffer-window) |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1218 (setq temp-buffer-resize-mode nil)))) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1219 |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1220 (defun resize-temp-buffer-window () |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1221 "Resize the current window to fit its contents. |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1222 Will not make it higher than `temp-buffer-max-height' nor smaller than |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1223 `window-min-height'. Do nothing if it is the only window on its frame, if it |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1224 is not as wide as the frame or if some of the window's contents are scrolled |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1225 out of view." |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1226 (unless (or (one-window-p 'nomini) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1227 (not (pos-visible-in-window-p (point-min))) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1228 (/= (frame-width) (window-width))) |
23749
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1229 (let* ((max-height (if (functionp temp-buffer-max-height) |
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1230 (funcall temp-buffer-max-height (current-buffer)) |
ea095fa15fb9
Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents:
23747
diff
changeset
|
1231 temp-buffer-max-height)) |
23747
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1232 (win-height (1- (window-height))) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1233 (min-height (1- window-min-height)) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1234 (text-height (window-buffer-height(selected-window))) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1235 (new-height (max (min text-height max-height) min-height))) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1236 (enlarge-window (- new-height win-height))))) |
fb3963445995
Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents:
23742
diff
changeset
|
1237 |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
1238 ;;; help.el ends here |