annotate lisp/help.el @ 26963:f281dfbf8cd2

*** empty log message ***
author Gerd Moellmann <gerd@gnu.org>
date Tue, 21 Dec 1999 09:08:41 +0000
parents 45e359e91cbb
children 1cc1c05b9ab7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
25473
1ad8606c8cc7 (help-make-xrefs): Don't lose on non-empty blank line after key table.
Dave Love <fx@gnu.org>
parents: 25047
diff changeset
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999 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
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; any later version.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; GNU General Public License for more details.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 13358
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 13358
diff changeset
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 13358
diff changeset
23 ;; Boston, MA 02111-1307, USA.
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
25473
1ad8606c8cc7 (help-make-xrefs): Don't lose on non-empty blank line after key table.
Dave Love <fx@gnu.org>
parents: 25047
diff changeset
28 ;; `M-x help-for-help'.
2315
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))
25846
3c430bda7857 Require view when compiling.
Dave Love <fx@gnu.org>
parents: 25689
diff changeset
35 (eval-when-compile (require 'view))
2237
2670a8f6a42e Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2134
diff changeset
36
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 (defvar help-map (make-sparse-keymap)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 "Keymap for characters following the Help key.")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
40 (defvar help-mode-map (make-sparse-keymap)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
41 "Keymap for help mode.")
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
42
919
567b06901789 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 918
diff changeset
43 (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
44 (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
45 (define-key global-map [f1] 'help-command)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 (fset 'help-command help-map)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47
919
567b06901789 entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 918
diff changeset
48 (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
49 (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
50 (define-key help-map [f1] 'help-for-help)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 (define-key help-map "?" 'help-for-help)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 (define-key help-map "\C-c" 'describe-copying)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 (define-key help-map "\C-d" 'describe-distribution)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 (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
56 (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
57 (define-key help-map "a" 'apropos-command)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 (define-key help-map "b" 'describe-bindings)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 (define-key help-map "c" 'describe-key-briefly)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 (define-key help-map "k" 'describe-key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 (define-key help-map "d" 'describe-function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 (define-key help-map "f" 'describe-function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66
10923
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
67 (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
68
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 (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
70 (define-key help-map "4i" 'info-other-window)
732
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 660
diff changeset
71 (define-key help-map "\C-f" 'Info-goto-emacs-command-node)
a8d94735277e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 660
diff changeset
72 (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
73 (define-key help-map "\C-i" 'info-lookup-symbol)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 (define-key help-map "l" 'view-lossage)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 (define-key help-map "m" 'describe-mode)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 (define-key help-map "\C-n" 'view-emacs-news)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 (define-key help-map "n" 'view-emacs-news)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81
2134
b275e1b50542 Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2079
diff changeset
82 (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
83 (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
84 "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
85
26757
6af9f1dc59c4 (view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents: 26650
diff changeset
86 (define-key help-map "P" 'view-emacs-problems)
6af9f1dc59c4 (view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents: 26650
diff changeset
87
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 (define-key help-map "s" 'describe-syntax)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 (define-key help-map "t" 'help-with-tutorial)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 (define-key help-map "w" 'where-is)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 (define-key help-map "v" 'describe-variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95
6580
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
96 (define-key help-map "q" 'help-quit)
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
97
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
98 (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
99 (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
100 (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
101 (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
102 (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
103 (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
104 ;; 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
105 (define-key help-mode-map "\r" 'help-follow)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
106
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
107 ;; 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
108 ;(defvar help-font-lock-keywords
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
109 ; (eval-when-compile
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
110 ; (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
111 ; (list
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
112 ; ;;
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
113 ; ;; The symbol itself.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
114 ; (list (concat "\\`\\(" name-char "+\\)\\(\\(:\\)\\|\\('\\)\\)")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
115 ; '(1 (if (match-beginning 3)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
116 ; font-lock-function-name-face
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
117 ; font-lock-variable-name-face)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
118 ; ;;
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
119 ; ;; Words inside `' which tend to be symbol names.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
120 ; (list (concat "`\\(" sym-char sym-char "+\\)'")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
121 ; 1 'font-lock-constant-face t)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
122 ; ;;
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
123 ; ;; CLisp `:' keywords as references.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
124 ; (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
125 ; "Default expressions to highlight in Help mode.")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
126
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
127 (defvar help-xref-stack nil
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
128 "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
129 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
130 An element looks like (POSITION FUNCTION ARGS...).
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
131 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
132 (put 'help-xref-stack 'permanent-local t)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
133
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
134 (defvar help-xref-stack-item nil
22325
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
135 "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
136 The format is (FUNCTION ARGS...).")
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
137 (put 'help-xref-stack-item 'permanent-local t)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
138
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
139 (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
140
26650
69a74a4cd1fa (help-mode-hook): Define.
Dave Love <fx@gnu.org>
parents: 26224
diff changeset
141 (defcustom help-mode-hook nil
69a74a4cd1fa (help-mode-hook): Define.
Dave Love <fx@gnu.org>
parents: 26224
diff changeset
142 "Hook run by `help-mode'."
69a74a4cd1fa (help-mode-hook): Define.
Dave Love <fx@gnu.org>
parents: 26224
diff changeset
143 :type 'hook
69a74a4cd1fa (help-mode-hook): Define.
Dave Love <fx@gnu.org>
parents: 26224
diff changeset
144 :group 'help)
69a74a4cd1fa (help-mode-hook): Define.
Dave Love <fx@gnu.org>
parents: 26224
diff changeset
145
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
146 (defun help-mode ()
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
147 "Major mode for viewing help text and navigating references in it.
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
148 Entry to this mode runs the normal hook `help-mode-hook'.
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
149 Commands:
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
150 \\{help-mode-map}"
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
151 (interactive)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
152 (kill-all-local-variables)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
153 (use-local-map help-mode-map)
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
154 (setq mode-name "Help")
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
155 (setq major-mode 'help-mode)
12816
7a19739bd181 Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents: 12499
diff changeset
156 (make-local-variable 'font-lock-defaults)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
157 (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
158 (view-mode)
19228
3e0e9b7e2307 (help-mode): Set view-no-disable-on-exit.
Richard M. Stallman <rms@gnu.org>
parents: 19124
diff changeset
159 (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
160 (setq view-no-disable-on-exit t)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
161 ;; `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
162 ;; `help-mode-maybe'.
9833
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
163 (run-hooks 'help-mode-hook))
5215339470b8 (help-mode): New function.
Karl Heuer <kwzh@gnu.org>
parents: 9639
diff changeset
164
24048
1876f867ff95 (help-mode-finish): Renamed from help-mode-maybe.
Richard M. Stallman <rms@gnu.org>
parents: 23962
diff changeset
165 (defun help-mode-setup ()
1876f867ff95 (help-mode-finish): Renamed from help-mode-maybe.
Richard M. Stallman <rms@gnu.org>
parents: 23962
diff changeset
166 (help-mode)
1876f867ff95 (help-mode-finish): Renamed from help-mode-maybe.
Richard M. Stallman <rms@gnu.org>
parents: 23962
diff changeset
167 (setq buffer-read-only nil))
1876f867ff95 (help-mode-finish): Renamed from help-mode-maybe.
Richard M. Stallman <rms@gnu.org>
parents: 23962
diff changeset
168
24081
5677e2f45278 (temp-buffer-setup-hook, temp-buffer-show-hook): Revert last change.
Dave Love <fx@gnu.org>
parents: 24079
diff changeset
169 (add-hook 'temp-buffer-setup-hook 'help-mode-setup)
24048
1876f867ff95 (help-mode-finish): Renamed from help-mode-maybe.
Richard M. Stallman <rms@gnu.org>
parents: 23962
diff changeset
170
1876f867ff95 (help-mode-finish): Renamed from help-mode-maybe.
Richard M. Stallman <rms@gnu.org>
parents: 23962
diff changeset
171 (defun help-mode-finish ()
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
172 (when (eq major-mode 'help-mode)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
173 ;; 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
174 ;; by with-output-to-temp-buffer.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
175 (toggle-read-only 1)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
176 (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
177 (setq view-return-to-alist
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
178 (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
179
24081
5677e2f45278 (temp-buffer-setup-hook, temp-buffer-show-hook): Revert last change.
Dave Love <fx@gnu.org>
parents: 24079
diff changeset
180 (add-hook 'temp-buffer-show-hook 'help-mode-finish)
20060
36044c8b8aef (help-mode-maybe): New function, on temp-buffer-show-hook.
Karl Heuer <kwzh@gnu.org>
parents: 19576
diff changeset
181
6580
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
182 (defun help-quit ()
23333
b8369b78f1ba (help-quit): Add doc.
Richard M. Stallman <rms@gnu.org>
parents: 23332
diff changeset
183 "Just exit from the Help command's command loop."
6580
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
184 (interactive)
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
185 nil)
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
186
17005
1fa50c7fdde3 (help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents: 16771
diff changeset
187 (defun help-with-tutorial (&optional arg)
1fa50c7fdde3 (help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents: 16771
diff changeset
188 "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
189 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
190 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
191 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
192 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
193 (interactive "P")
21440
4718a738947a (help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents: 21385
diff changeset
194 (let ((lang (if arg
4718a738947a (help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents: 21385
diff changeset
195 (read-language-name 'tutorial "Language: " "English")
4718a738947a (help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents: 21385
diff changeset
196 (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
197 current-language-environment
21587
a89b6f48c73d (help-with-tutorial): Locally bind file and filename.
Richard M. Stallman <rms@gnu.org>
parents: 21491
diff changeset
198 "English")))
a89b6f48c73d (help-with-tutorial): Locally bind file and filename.
Richard M. Stallman <rms@gnu.org>
parents: 21491
diff changeset
199 file filename)
21440
4718a738947a (help-with-tutorial-alist): This variable deleted.
Kenichi Handa <handa@m17n.org>
parents: 21385
diff changeset
200 (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
201 (setq file (expand-file-name (concat "~/" filename)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 (delete-other-windows)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 (if (get-file-buffer file)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 (switch-to-buffer (get-file-buffer file))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 (switch-to-buffer (create-file-buffer file))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 (setq buffer-file-name file)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 (setq default-directory (expand-file-name "~/"))
755
e43123226372 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 732
diff changeset
208 (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
209 (insert-file-contents (expand-file-name filename data-directory))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211 (search-forward "\n<<")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 (beginning-of-line)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 (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
214 (let ((n (- (window-height (selected-window))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 (count-lines (point-min) (point))
6419
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
216 6)))
6433
e50519261181 (help-with-tutorial): Change previous change;
Richard M. Stallman <rms@gnu.org>
parents: 6419
diff changeset
217 (if (< n 12)
6419
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
218 (newline n)
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
219 ;; 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
220 (newline (/ n 2))
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
221 (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
222 "Text continues below]")
e5ce725b661d (help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents: 6079
diff changeset
223 (newline (- n (/ n 2)))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 (set-buffer-modified-p nil))))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226
25047
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
227 (defun mode-line-key-binding (key)
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
228 "Value is the binding of KEY in the mode line or nil if none."
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
229 (let (string-info defn)
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
230 (when (and (eq 'mode-line (aref key 0))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
231 (consp (setq string-info (nth 4 (event-start (aref key 1))))))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
232 (let* ((string (car string-info))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
233 (pos (cdr string-info))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
234 (local-map (and (> pos 0)
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
235 (< pos (length string))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
236 (get-text-property pos 'local-map string))))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
237 (setq defn (and local-map (lookup-key local-map key)))))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
238 defn))
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
239
17917
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
240 (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
241 "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
242 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
243 (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
244 (save-excursion
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
245 (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
246 (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
247 window position)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
248 ;; 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
249 ;; 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
250 ;; 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
251 (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
252 (memq 'drag modifiers))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
253 (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
254 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
255 (if (windowp window)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
256 (progn
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
257 (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
258 (goto-char position)))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
259 ;; Ok, now look up the key and name the command.
25047
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
260 (let ((defn (or (mode-line-key-binding key)
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
261 (key-binding key)))
17917
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
262 (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
263 (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
264 (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
265 (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
266 "`%s' (`%s')"
17917
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
267 (if (windowp window)
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
268 "%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
269 "%s runs the command %s"))
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
270 key-desc
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
271 (if (symbolp defn) defn (prin1-to-string defn)))))))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272
21188
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
273 (defvar help-return-method nil
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
274 "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
275 This is a list
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
276 (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
277 (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
278 (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
279
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 (defun print-help-return-message (&optional function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281 "Display or return message saying how to restore windows after help command.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282 Computes a message and applies the optional argument FUNCTION to it.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 If FUNCTION is nil, applies `message' to it, thus printing it."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
284 (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
285 (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
286 (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
287 (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
288 ;; 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
289 ;; 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
290 ;; 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
291 ;; manager, not with Emacs.
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
292 ;; 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
293 ;; 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
294 nil)
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
295 ((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
296 (setq help-return-method
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
297 (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
298 "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
299 (pop-up-windows
21188
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
300 (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
301 "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
302 (t
21188
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
303 (setq help-return-method
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
304 (list (selected-window) (window-buffer)
607ce9d7cf53 (help-mode-maybe): Set view-return-to-alist.
Richard M. Stallman <rms@gnu.org>
parents: 20953
diff changeset
305 (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
306 "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
307 (funcall (or function 'message)
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
308 (concat
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
309 (if first-message
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
310 (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
311 "")
604d89082229 (print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents: 7978
diff changeset
312 (if first-message " " "")
11524
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
313 ;; 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
314 ;; 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
315 (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
316 nil
16391
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
317 (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
318 ;; 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
319 (substitute-command-keys
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
320 "\\[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
321 ;; 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
322 (substitute-command-keys
11524
cafa503e806c (print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents: 11428
diff changeset
323 "\\[scroll-other-window] to scroll the help."))))))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
324
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
325 (defun describe-key (key)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
326 "Display documentation of the function invoked by KEY. KEY is a string."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
327 (interactive "kDescribe key: ")
13293
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
328 (save-excursion
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
329 (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
330 window position)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
331 ;; 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
332 ;; 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
333 ;; 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
334 (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
335 (memq 'drag modifiers))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
336 (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
337 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
338 (if (windowp window)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
339 (progn
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
340 (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
341 (goto-char position)))
25047
b69a152b82e3 (describe-key-briefly): Handle mode line strings
Gerd Moellmann <gerd@gnu.org>
parents: 24974
diff changeset
342 (let ((defn (or (mode-line-key-binding key) (key-binding key))))
13293
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
343 (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
344 (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
345 (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
346 (princ (key-description key))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
347 (if (windowp window)
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
348 (princ " at that spot"))
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
349 (princ " runs the command ")
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
350 (prin1 defn)
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
351 (princ "\n which is ")
24759
a03aa24489bd (describe-function-1): Extra arg, interactive-p.
Richard M. Stallman <rms@gnu.org>
parents: 24714
diff changeset
352 (describe-function-1 defn nil (interactive-p))
13293
5270a0a465a7 (describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents: 13209
diff changeset
353 (print-help-return-message)))))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354
6902
962a6ffb7b97 (describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents: 6580
diff changeset
355 (defun describe-mode ()
962a6ffb7b97 (describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents: 6580
diff changeset
356 "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
357 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
358 each on a separate page.
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
359
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360 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
361 \(listed in `minor-mode-alist') must also be a function whose documentation
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 describes the minor mode."
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
363 (interactive)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 (with-output-to-temp-buffer "*Help*"
23778
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
365 (when minor-mode-alist
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
366 (princ "The major mode is described first.
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
367 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
368 (princ mode-name)
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
369 (princ " mode:\n")
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
370 (princ (documentation major-mode))
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
371 (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
372 (let ((minor-modes minor-mode-alist))
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
373 (while minor-modes
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
374 (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
375 (indicator (car (cdr (car minor-modes)))))
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
376 ;; 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
377 ;; 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
378 ;; definition.
16694
c19089a334b2 (describe-mode): Include minor modes that aren't buffer local.
Richard M. Stallman <rms@gnu.org>
parents: 16557
diff changeset
379 (if (and (symbol-value minor-mode)
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
380 (fboundp minor-mode))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
381 (let ((pretty-minor-mode minor-mode))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
382 (if (string-match "-mode$" (symbol-name minor-mode))
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
383 (setq pretty-minor-mode
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
384 (capitalize
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
385 (substring (symbol-name minor-mode)
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
386 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
387 (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
388 (boundp indicator)
8c57752f8e9c (describe-mode): Don't avoid loop indirecting thru value of INDICATOR.
Richard M. Stallman <rms@gnu.org>
parents: 23741
diff changeset
389 (not (eq indicator (symbol-value indicator))))
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
390 (setq indicator (symbol-value indicator)))
23778
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
391 (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
392 (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
393 pretty-minor-mode
4d511dd9bfce (describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
394 (if indicator
4d511dd9bfce (describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
395 (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
396 "no indicator")))
23778
9cee50f0ec56 (describe-mode): Put major mode first.
Richard M. Stallman <rms@gnu.org>
parents: 23749
diff changeset
397 (princ (documentation minor-mode)))))
6903
61d9d9b5ccba (describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 6902
diff changeset
398 (setq minor-modes (cdr minor-modes))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 (print-help-return-message)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 ;; So keyboard macro definitions are documented correctly
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 (defun describe-distribution ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 "Display info on how to obtain the latest version of GNU Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 (find-file-read-only
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
408 (expand-file-name "DISTRIB" data-directory)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 (defun describe-copying ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 "Display info on how you may redistribute copies of GNU Emacs."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 (find-file-read-only
444
4cec2e6d4f9e *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 409
diff changeset
414 (expand-file-name "COPYING" data-directory))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 (goto-char (point-min)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416
5025
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
417 (defun describe-project ()
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
418 "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
419 (interactive)
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
420 (find-file-read-only
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
421 (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
422 (goto-char (point-min)))
0556b068e9ee (describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents: 4467
diff changeset
423
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 (defun describe-no-warranty ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425 "Display info on all the kinds of warranty Emacs does NOT have."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427 (describe-copying)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428 (let (case-fold-search)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 (search-forward "NO WARRANTY")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
430 (recenter 0)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431
3980
bf2d4294a1dd (describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents: 3145
diff changeset
432 (defun describe-prefix-bindings ()
3982
e50f7b531c7f (describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 3980
diff changeset
433 "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
434 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
435 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
436 (interactive)
11890
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
437 (let* ((key (this-command-keys)))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
438 (describe-bindings
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
439 (if (stringp key)
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
440 (substring key 0 (1- (length key)))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
441 (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
442 (i 0))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
443 (while (< i (length prefix))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
444 (aset prefix i (aref key i))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
445 (setq i (1+ i)))
543a76aa50b9 (describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents: 11524
diff changeset
446 prefix)))))
3982
e50f7b531c7f (describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 3980
diff changeset
447 ;; 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
448 ;; run describe-prefix-bindings.
3980
bf2d4294a1dd (describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents: 3145
diff changeset
449 (setq prefix-help-command 'describe-prefix-bindings)
bf2d4294a1dd (describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents: 3145
diff changeset
450
21210
2a51a4912199 (view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents: 21188
diff changeset
451 (defun view-emacs-news (&optional arg)
2a51a4912199 (view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents: 21188
diff changeset
452 "Display info on recent changes to Emacs.
2a51a4912199 (view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents: 21188
diff changeset
453 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
454 (interactive "P")
2a51a4912199 (view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents: 21188
diff changeset
455 (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
456 (find-file-read-only
2a51a4912199 (view-emacs-news): Handle prefix arg.
Richard M. Stallman <rms@gnu.org>
parents: 21188
diff changeset
457 (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
458 data-directory))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459
10923
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
460 (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
461 "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
462 (interactive)
25846
3c430bda7857 Require view when compiling.
Dave Love <fx@gnu.org>
parents: 25689
diff changeset
463 ;;; (find-file-read-only (expand-file-name "FAQ" data-directory))
3c430bda7857 Require view when compiling.
Dave Love <fx@gnu.org>
parents: 25689
diff changeset
464 (info "(emacs-faq)"))
10923
fe008aef4cf1 (view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents: 10622
diff changeset
465
26757
6af9f1dc59c4 (view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents: 26650
diff changeset
466 (defun view-emacs-problems ()
6af9f1dc59c4 (view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents: 26650
diff changeset
467 "Display info on known problems with Emacs and possible workarounds."
6af9f1dc59c4 (view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents: 26650
diff changeset
468 (interactive)
6af9f1dc59c4 (view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents: 26650
diff changeset
469 (view-file (expand-file-name "PROBLEMS" data-directory)))
6af9f1dc59c4 (view-emacs-problems): New command, bound to C-h P.
Dave Love <fx@gnu.org>
parents: 26650
diff changeset
470
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 (defun view-lossage ()
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472 "Display last 100 input keystrokes."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 (interactive)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 (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
475 (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
476 (if (or (integerp key)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
477 (symbolp key)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
478 (listp key))
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
479 (single-key-description key)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
480 (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
481 (recent-keys)
8c492f23ee28 (view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents: 8259
diff changeset
482 " "))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 (save-excursion
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484 (set-buffer standard-output)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 (goto-char (point-min))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 (while (progn (move-to-column 50) (not (eobp)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487 (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
488 (insert "\n"))
f3d29552e393 (view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents: 21972
diff changeset
489 (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
490 help-xref-stack-item nil))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 (print-help-return-message)))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492
6580
4c20c6b1d2c2 (help): New alias.
Richard M. Stallman <rms@gnu.org>
parents: 6476
diff changeset
493 (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
494 (make-help-screen help-for-help
18632
0e44be1e2051 (help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents: 18293
diff changeset
495 "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
496 "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
497 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498
4467
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
499 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
500 (functions interactively callable) that contain
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
501 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
502 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
503 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
504 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
505 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
506 (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
507 (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
508 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
509 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
510 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
511 i info. The info documentation reader.
18632
0e44be1e2051 (help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents: 18293
diff changeset
512 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
513 its name) or the current input method (if you type just RET).
24830
459c58257c18 (help-for-help): Mention C-h C-i. Clear up C-h n.
Karl Heuer <kwzh@gnu.org>
parents: 24815
diff changeset
514 C-i info-lookup-symbol. Display the definition of a specific symbol
459c58257c18 (help-for-help): Mention C-h C-i. Clear up C-h n.
Karl Heuer <kwzh@gnu.org>
parents: 24815
diff changeset
515 as found in the manual for the language this buffer is written in.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
516 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
517 it displays the full documentation.
1e8785572dd4 (help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents: 3986
diff changeset
518 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
519 it takes you to the Info node for the command bound to that key.
24830
459c58257c18 (help-for-help): Mention C-h C-i. Clear up C-h n.
Karl Heuer <kwzh@gnu.org>
parents: 24815
diff changeset
520 l view-lossage. Show last 100 characters you typed.
18632
0e44be1e2051 (help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents: 18293
diff changeset
521 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
522 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
523 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
524 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
525 and the current major mode, including their special commands.
24830
459c58257c18 (help-for-help): Mention C-h C-i. Clear up C-h n.
Karl Heuer <kwzh@gnu.org>
parents: 24815
diff changeset
526 n view-emacs-news. Display news of recent Emacs changes.
2638
5ff504c4ae11 (help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents: 2440
diff changeset
527 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
528 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
529 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
530 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
531 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
532 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
533 invoke that command.
18632
0e44be1e2051 (help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents: 18293
diff changeset
534
0e44be1e2051 (help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents: 18293
diff changeset
535 F Display the frequently asked questions file.
0e44be1e2051 (help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents: 18293
diff changeset
536 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
537 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
538 C-d Display Emacs ordering information.
0e44be1e2051 (help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents: 18293
diff changeset
539 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
540 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
541 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
542 help-map)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 (defun function-called-at-point ()
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
545 "Return a function around point or else called by the list containing point.
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
546 If that doesn't give a function, return nil."
20077
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
547 (let ((stab (syntax-table)))
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
548 (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
549 (unwind-protect
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
550 (or (condition-case ()
13209
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
551 (save-excursion
23962
5ab992b6ca59 (function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents: 23922
diff changeset
552 (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
553 (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
554 (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
555 (forward-sexp -1))
5ab992b6ca59 (function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents: 23922
diff changeset
556 (skip-chars-forward "'")
5ab992b6ca59 (function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents: 23922
diff changeset
557 (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
558 (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
559 (error nil))
5ab992b6ca59 (function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents: 23922
diff changeset
560 (condition-case ()
5ab992b6ca59 (function-called-at-point): First look for function at point.
Richard M. Stallman <rms@gnu.org>
parents: 23922
diff changeset
561 (save-excursion
20077
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
562 (save-restriction
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
563 (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
564 ;; 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
565 (backward-up-list 1)
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
566 (forward-char 1)
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
567 ;; 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
568 ;; 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
569 (if (looking-at "[ \t]")
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
570 (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
571 (let (obj)
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
572 (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
573 (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
574 (error nil)))
437758b7ca50 (function-called-at-point): Always use Emacs Lisp syntax tab.
Karl Heuer <kwzh@gnu.org>
parents: 20069
diff changeset
575 (set-syntax-table stab))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576
23853
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
577 (defvar symbol-file-load-history-loaded nil
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
578 "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
579 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
580 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
581
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
582 (defun symbol-file (function)
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
583 "Return the input source from which FUNCTION was loaded.
23853
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
584 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
585 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
586 \(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
587 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
588 (unless symbol-file-load-history-loaded
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
589 (load (expand-file-name
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
590 ;; 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
591 (if (eq system-type 'ms-dos)
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
592 "fns.el"
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
593 (format "fns-%s.el" emacs-version))
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
594 exec-directory)
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
595 ;; 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
596 nil nil t)
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
597 (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
598 (let ((files load-history)
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
599 file functions)
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
600 (while files
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
601 (if (memq function (cdr (car files)))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
602 (setq file (car (car files)) files nil))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
603 (setq files (cdr files)))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
604 file))
7cad0025f303 (describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9638
diff changeset
605
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 (defun describe-function (function)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 "Display the full documentation of FUNCTION (a symbol)."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 (interactive
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609 (let ((fn (function-called-at-point))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 (enable-recursive-minibuffers t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611 val)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 (setq val (completing-read (if fn
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 (format "Describe function (default %s): " fn)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 "Describe function: ")
20069
1f8e6121713d (describe-variable): Pass default value to completing-read.
Karl Heuer <kwzh@gnu.org>
parents: 20060
diff changeset
615 obarray 'fboundp t nil nil (symbol-name fn)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 (list (if (equal val "")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 fn (intern val)))))
16439
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
618 (if function
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
619 (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
620 (prin1 function)
19124
e5e8552b076a (describe-function): Use " is " instead of colon.
Richard M. Stallman <rms@gnu.org>
parents: 18632
diff changeset
621 ;; 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
622 ;; 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
623 (princ " is ")
24759
a03aa24489bd (describe-function-1): Extra arg, interactive-p.
Richard M. Stallman <rms@gnu.org>
parents: 24714
diff changeset
624 (describe-function-1 function nil (interactive-p))
16439
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
625 (print-help-return-message)
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
626 (save-excursion
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
627 (set-buffer standard-output)
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
628 ;; Return the text we displayed.
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
629 (buffer-string)))
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
630 (message "You didn't specify a function")))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631
24759
a03aa24489bd (describe-function-1): Extra arg, interactive-p.
Richard M. Stallman <rms@gnu.org>
parents: 24714
diff changeset
632 (defun describe-function-1 (function parens interactive-p)
24331
84dcf9017a67 (describe-function-1): Accept non-symbols.
Richard M. Stallman <rms@gnu.org>
parents: 24177
diff changeset
633 (let* ((def (if (symbolp function)
84dcf9017a67 (describe-function-1): Accept non-symbols.
Richard M. Stallman <rms@gnu.org>
parents: 24177
diff changeset
634 (symbol-function function)
84dcf9017a67 (describe-function-1): Accept non-symbols.
Richard M. Stallman <rms@gnu.org>
parents: 24177
diff changeset
635 function))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
636 file-name string need-close
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
637 (beg (if (commandp def) "an interactive " "a ")))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
638 (setq string
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
639 (cond ((or (stringp def)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
640 (vectorp def))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
641 "a keyboard macro")
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
642 ((subrp def)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
643 (concat beg "built-in function"))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
644 ((byte-code-function-p def)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
645 (concat beg "compiled Lisp function"))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
646 ((symbolp def)
22973
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
647 (while (symbolp (symbol-function def))
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
648 (setq def (symbol-function def)))
23818
19e467700712 (describe-function-1): Fix description for alias.
Dave Love <fx@gnu.org>
parents: 23797
diff changeset
649 (format "an alias for `%s'" def))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
650 ((eq (car-safe def) 'lambda)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
651 (concat beg "Lisp function"))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
652 ((eq (car-safe def) 'macro)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
653 "a Lisp macro")
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
654 ((eq (car-safe def) 'mocklisp)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
655 "a mocklisp function")
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
656 ((eq (car-safe def) 'autoload)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
657 (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
658 (format "%s autoloaded %s"
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
659 (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
660 (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
661 (if (nth 4 def) "Lisp macro" "Lisp function"))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
662 ))
25605
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
663 ;; perhaps use keymapp here instead
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
664 ((eq (car-safe def) 'keymap)
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
665 (let ((is-full nil)
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
666 (elts (cdr-safe def)))
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
667 (while elts
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
668 (if (char-table-p (car-safe elts))
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
669 (setq is-full t
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
670 elts nil))
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
671 (setq elts (cdr-safe elts)))
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
672 (if is-full
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
673 "a full keymap"
d1251e911451 (describe-function-1): Don't return empty string for keymaps.
Richard M. Stallman <rms@gnu.org>
parents: 25473
diff changeset
674 "a sparse keymap")))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
675 (t "")))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
676 (when (and parens (not (equal string "")))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
677 (setq need-close t)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
678 (princ "("))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
679 (princ string)
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
680 (with-current-buffer "*Help*"
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
681 (save-excursion
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
682 (save-match-data
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
683 (if (re-search-backward "alias for `\\([^`']+\\)'" nil t)
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
684 (help-xref-button 1 #'describe-function def)))))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
685 (or file-name
23853
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
686 (setq file-name (symbol-file function)))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
687 (if file-name
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
688 (progn
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
689 (princ " in `")
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
690 ;; We used to add .el to the file name,
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
691 ;; 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
692 (princ file-name)
21695
2c9cfb84bf1b (describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents: 21587
diff changeset
693 (princ "'")
2c9cfb84bf1b (describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents: 21587
diff changeset
694 ;; Make a hyperlink to the library.
2c9cfb84bf1b (describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents: 21587
diff changeset
695 (with-current-buffer "*Help*"
2c9cfb84bf1b (describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents: 21587
diff changeset
696 (save-excursion
2c9cfb84bf1b (describe-function): Make hyperlink to library file
Dave Love <fx@gnu.org>
parents: 21587
diff changeset
697 (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
698 (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
699 (let ((location
9c71660c0a8d (describe-function-1): Use find-function-noselect instead of find-function.
Richard M. Stallman <rms@gnu.org>
parents: 21708
diff changeset
700 (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
701 (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
702 (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
703 function)))))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
704 (if need-close (princ ")"))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
705 (princ ".")
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
706 (terpri)
22973
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
707 ;; Handle symbols aliased to other symbols.
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
708 (setq def (indirect-function def))
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
709 ;; 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
710 (if (eq (car-safe def) 'macro)
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
711 (setq def (cdr def)))
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
712 (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
713 (car (append def nil)))
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
714 ((eq (car-safe def) 'lambda)
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
715 (nth 1 def))
c3bbca1b6f3a (describe-function-1): Handle macros properly.
Richard M. Stallman <rms@gnu.org>
parents: 22850
diff changeset
716 (t t))))
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
717 (if (listp arglist)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
718 (progn
24402
85a2d7a71970 (describe-function-1): Don't print a whole lambda-function.
Richard M. Stallman <rms@gnu.org>
parents: 24331
diff changeset
719 (princ (cons (if (symbolp function) function "anonymous")
21491
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
720 (mapcar (lambda (arg)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
721 (if (memq arg '(&optional &rest))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
722 arg
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
723 (intern (upcase (symbol-name arg)))))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
724 arglist)))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
725 (terpri))))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
726 (let ((doc (documentation function)))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
727 (if doc
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
728 (progn (terpri)
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
729 (princ doc)
24759
a03aa24489bd (describe-function-1): Extra arg, interactive-p.
Richard M. Stallman <rms@gnu.org>
parents: 24714
diff changeset
730 (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
731 (princ "not documented")))))
7a8169a735f5 (describe-function-1): New function.
Karl Heuer <kwzh@gnu.org>
parents: 21440
diff changeset
732
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733 (defun variable-at-point ()
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
734 "Return the bound variable symbol found around point.
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
735 Return 0 if there is no such symbol."
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 (condition-case ()
13209
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
737 (let ((stab (syntax-table)))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
738 (unwind-protect
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
739 (save-excursion
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
740 (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
741 (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
742 (eq (char-syntax (following-char)) ?w)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
743 (eq (char-syntax (following-char)) ?_)
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
744 (forward-sexp -1))
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
745 (skip-chars-forward "'")
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
746 (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
747 (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
748 0)))
13209
c2f172263810 (variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents: 13197
diff changeset
749 (set-syntax-table stab)))
16439
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
750 (error 0)))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
751
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
752 (defun describe-variable (variable)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
753 "Display the full documentation of VARIABLE (a symbol).
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754 Returns the documentation as a string, also."
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
755 (interactive
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
756 (let ((v (variable-at-point))
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757 (enable-recursive-minibuffers t)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
758 val)
16439
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
759 (setq val (completing-read (if (symbolp v)
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
760 (format "Describe variable (default %s): " v)
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
761 "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
762 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
763 (if (symbolp v) (symbol-name v))))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764 (list (if (equal val "")
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
765 v (intern val)))))
16439
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
766 (if (symbolp variable)
16557
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
767 (let (valvoid)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
768 (with-output-to-temp-buffer "*Help*"
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
769 (prin1 variable)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
770 (if (not (boundp variable))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
771 (progn
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
772 (princ " is void")
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
773 (terpri)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
774 (setq valvoid t))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
775 (princ "'s value is ")
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
776 (terpri)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
777 (pp (symbol-value variable))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
778 (terpri))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
779 (if (local-variable-p variable)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
780 (progn
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
781 (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
782 (if (not (default-boundp variable))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
783 (princ "globally void")
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
784 (princ "global value is ")
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
785 (terpri)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
786 (pp (default-value variable)))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
787 (terpri)))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
788 (terpri)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
789 (save-current-buffer
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
790 (set-buffer standard-output)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
791 (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
792 (progn
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
793 (goto-char (point-min))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
794 (if valvoid
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
795 (forward-line 1)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
796 (forward-sexp 1)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
797 (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
798 (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
799 (save-excursion
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
800 (insert "\n\nValue:"))))))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
801 (princ "Documentation:")
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
802 (terpri)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
803 (let ((doc (documentation-property variable 'variable-documentation)))
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
804 (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
805 (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
806
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
807 ;; 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
808 ;; Note, it is not reliable to test only for a custom-type property
22407
e7ec3ed4c814 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 22325
diff changeset
809 ;; because those are only present after the var's definition
e7ec3ed4c814 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 22325
diff changeset
810 ;; has been loaded.
24974
2668e8c9f19e (describe-variable): Fix test for customizability.
Dave Love <fx@gnu.org>
parents: 24830
diff changeset
811 (if (or (get variable 'custom-type) ; after defcustom
2668e8c9f19e (describe-variable): Fix test for customizability.
Dave Love <fx@gnu.org>
parents: 24830
diff changeset
812 (get variable 'custom-loads) ; from loaddefs.el
2668e8c9f19e (describe-variable): Fix test for customizability.
Dave Love <fx@gnu.org>
parents: 24830
diff changeset
813 (get variable 'standard-value)) ; from cus-start.el
22234
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
814 (let ((customize-label "customize"))
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
815 (terpri)
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
816 (terpri)
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
817 (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
818 (with-current-buffer "*Help*"
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
819 (save-excursion
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
820 (re-search-backward
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
821 (concat "\\(" customize-label "\\)") nil t)
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
822 (help-xref-button 1 #'(lambda (v)
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
823 (customize-variable v)) variable)
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
824 ))))
23591
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
825 ;; 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
826 ;; 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
827 ;; anything expects the current format.)
23853
e9fe8ed71303 (symbol-file-load-history-loaded): Variable renamed,
Karl Heuer <kwzh@gnu.org>
parents: 23818
diff changeset
828 (let ((file-name (symbol-file variable)))
23591
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
829 (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
830 (princ "\n\nDefined in `")
23591
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
831 (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
832 (princ "'.")
23591
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
833 (with-current-buffer "*Help*"
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
834 (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
835 (re-search-backward "`\\([^`']+\\)'" nil t)
23591
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
836 (help-xref-button 1 (lambda (arg)
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
837 (let ((location
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
838 (find-variable-noselect arg)))
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
839 (pop-to-buffer (car location))
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
840 (goto-char (cdr location))))
9487b796b92c (describe-variable): Hyperlink the definition.
Dave Love <fx@gnu.org>
parents: 23333
diff changeset
841 variable)))))
22234
40229c79e16b (describe-variable): Add a button to call
Richard M. Stallman <rms@gnu.org>
parents: 22060
diff changeset
842
16557
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
843 (print-help-return-message)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
844 (save-excursion
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
845 (set-buffer standard-output)
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
846 ;; Return the text we displayed.
4ff6a0f0f5c7 (describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents: 16439
diff changeset
847 (buffer-string))))
16439
0c61b1f40de2 (describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents: 16391
diff changeset
848 (message "You did not specify a variable")))
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849
22325
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
850 (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
851 "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
852 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
853
4c3e62fe8898 (describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents: 20290
diff changeset
854 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
855 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
856 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
857 to display (default, the current buffer)."
20882
6566e48896f4 (describe-bindings): Fix interactive spec.
Richard M. Stallman <rms@gnu.org>
parents: 20848
diff changeset
858 (interactive "P")
22325
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
859 (or buffer (setq buffer (current-buffer)))
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
860 (with-current-buffer buffer
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
861 (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
862 (with-current-buffer "*Help*"
22325
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
863 (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
864 (interactive-p))))
20848
4c3e62fe8898 (describe-bindings): New command (formerly in keymap.c).
Richard M. Stallman <rms@gnu.org>
parents: 20290
diff changeset
865
17917
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
866 (defun where-is (definition &optional insert)
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
867 "Print message listing key sequences that invoke the command DEFINITION.
17917
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
868 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
869 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
870 (interactive
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
871 (let ((fn (function-called-at-point))
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
872 (enable-recursive-minibuffers t)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
873 val)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
874 (setq val (completing-read (if fn
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
875 (format "Where is command (default %s): " fn)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
876 "Where is command: ")
26805
45e359e91cbb 1999-12-11 Samir Barjoud <samir@mindspring.com>
Dave Love <fx@gnu.org>
parents: 26757
diff changeset
877 obarray 'commandp t))
6476
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
878 (list (if (equal val "")
17917
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
879 fn (intern val))
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
880 current-prefix-arg)))
6476
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
881 (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
882 (keys1 (mapconcat 'key-description keys ", "))
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
883 (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
884 (if insert
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
885 (if (> (length keys1) 0)
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
886 (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
887 (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
888 (if (> (length keys1) 0)
2a41f677885f (describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents: 17756
diff changeset
889 (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
890 (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
891 nil)
2e28b96d5b64 (where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6433
diff changeset
892
16273
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
893 (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
894 "Show the precise file name of Emacs library LIBRARY.
409
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 This command searches the directories in `load-path' like `M-x load-library'
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896 to find the file that `M-x load-library RET LIBRARY RET' would load.
671fceb3316b Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
897 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
898 to the specified name LIBRARY.
a9d32637ee38 (locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents: 16063
diff changeset
899
a9d32637ee38 (locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents: 16063
diff changeset
900 If the optional third arg PATH is specified, that list of directories
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
901 is used instead of `load-path'.
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
902
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
903 When called from a program, the file name is normaly returned as a
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
904 string. When run interactively, the argument INTERACTIVE-CALL is t,
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
905 and the file name is displayed in the echo area."
16273
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
906 (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
907 nil nil
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
908 t))
20176
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
909 (let (result)
16273
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
910 (catch 'answer
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
911 (mapcar
16391
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
912 (lambda (dir)
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
913 (mapcar
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
914 (lambda (suf)
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
915 (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
916 (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
917 (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
918 (progn
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
919 (setq result try)
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
920 (throw 'answer try)))))
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
921 (if nosuffix
5d64d742ccbb (print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents: 16273
diff changeset
922 '("")
20176
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
923 '(".elc" ".el" "")
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
924 ;;; load doesn't handle this yet.
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
925 ;;; (let ((basic '(".elc" ".el" ""))
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
926 ;;; (compressed '(".Z" ".gz" "")))
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
927 ;;; ;; If autocompression mode is on,
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
928 ;;; ;; consider all combinations of library suffixes
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
929 ;;; ;; and compression suffixes.
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
930 ;;; (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
931 ;;; (apply 'nconc
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
932 ;;; (mapcar (lambda (compelt)
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
933 ;;; (mapcar (lambda (baselt)
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
934 ;;; (concat baselt compelt))
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
935 ;;; basic))
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
936 ;;; compressed))
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
937 ;;; basic))
fb907b54fe26 (locate-library): Comment out the code that searches
Karl Heuer <kwzh@gnu.org>
parents: 20133
diff changeset
938 )))
16273
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
939 (or path load-path)))
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
940 (and interactive-call
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
941 (if result
14ff4afa06ec (locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents: 16064
diff changeset
942 (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
943 (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
944 result))
660
08eb386dd0f3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
945
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
946
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
947 ;;; Grokking cross-reference information in doc strings and
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
948 ;;; hyperlinking it.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
949
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
950 ;; 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
951 ;; 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
952 ;; another mechanism.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
953
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
954 (defcustom help-highlight-p t
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
955 "*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
956 Under a window system it highlights them with face defined by
25689
60a23f3bd0cc (help-highlight-p): Doc fix.
Dave Love <fx@gnu.org>
parents: 25605
diff changeset
957 `help-highlight-face'."
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
958 :group 'help
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
959 :version "20.3"
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
960 :type 'boolean)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
961
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
962 (defcustom help-highlight-face 'underline
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
963 "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
964 Must be previously-defined."
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
965 :group 'help
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
966 :version "20.3"
21698
9ebbb53c1c20 (help-highlight-face): Use `face' as custom type.
Richard M. Stallman <rms@gnu.org>
parents: 21695
diff changeset
967 :type 'face)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
968
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
969 (defvar help-back-label "[back]"
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
970 "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
971
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
972 (defvar help-xref-symbol-regexp
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
973 (concat "\\(\\<\\(\\(variable\\|option\\)\\|"
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
974 "\\(function\\|command\\)\\|"
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
975 "\\(symbol\\)\\)\\s-+\\)?"
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
976 ;; Note starting with word-syntax character:
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
977 "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
978 "Regexp matching doc string references to symbols.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
979
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
980 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
981 distinguish references to variables, functions and symbols.")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
982
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
983 (defvar help-xref-info-regexp
24403
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
984 "\\<[Ii]nfo[ \t\n]+node[ \t\n]+`\\([^']+\\)'"
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
985 "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
986
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
987 (defun help-setup-xref (item interactive-p)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
988 "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
989
22325
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
990 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
991 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
992 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
993 items for help buffer \"back\" buttons is cleared."
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
994 (if interactive-p
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
995 (setq help-xref-stack nil))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
996 (setq help-xref-stack-item item))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
997
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
998 (defun help-make-xrefs (&optional buffer)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
999 "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
1000
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1001 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
1002 `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
1003 `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
1004 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
1005 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
1006 word(s) used in `help-xref-symbol-regexp'.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1007
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1008 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
1009 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
1010 that."
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1011 (interactive "b")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1012 (save-excursion
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1013 (set-buffer (or buffer (current-buffer)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1014 (goto-char (point-min))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1015 ;; 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
1016 ;; 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
1017 (forward-paragraph)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1018 (let ((old-modified (buffer-modified-p)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1019 (let ((stab (syntax-table))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1020 (case-fold-search t)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1021 (inhibit-read-only t))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1022 (set-syntax-table emacs-lisp-mode-syntax-table)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1023 ;; The following should probably be abstracted out.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1024 (unwind-protect
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1025 (progn
24403
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1026 ;; Info references
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1027 (save-excursion
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1028 (while (re-search-forward help-xref-info-regexp nil t)
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1029 (let ((data (match-string 1)))
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1030 (save-match-data
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1031 (unless (string-match "^([^)]+)" data)
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1032 (setq data (concat "(emacs)" data))))
00fd80d4b49f (help-xref-info-regexp): Allow linebreaks and capital.
Richard M. Stallman <rms@gnu.org>
parents: 24402
diff changeset
1033 (help-xref-button 1 #'info data))))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1034 ;; Quoted symbols
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1035 (save-excursion
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1036 (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
1037 (let* ((data (match-string 6))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1038 (sym (intern-soft data)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1039 (if sym
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1040 (cond
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1041 ((match-string 3) ; `variable' &c
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1042 (and (boundp sym) ; `variable' doesn't ensure
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1043 ; it's actually bound
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1044 (help-xref-button 6 #'describe-variable sym)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1045 ((match-string 4) ; `function' &c
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1046 (and (fboundp sym) ; similarly
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1047 (help-xref-button 6 #'describe-function sym)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1048 ((match-string 5)) ; nothing for symbol
26005
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1049 ((or (boundp sym) (fboundp sym))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1050 ;; We can't intuit whether to use the
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1051 ;; variable or function doc -- supply both.
26005
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1052 (help-xref-button 6 #'help-xref-interned sym)))))))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1053 ;; An obvious case of a key substitution:
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1054 (save-excursion
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
1055 (while (re-search-forward
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
1056 ;; Assume command name is only word characters
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
1057 ;; and dashes to get things like `use M-x foo.'.
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
1058 "\\<M-x\\s-+\\(\\sw\\(\\sw\\|-\\)+\\)" nil t)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1059 (let ((sym (intern-soft (match-string 1))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1060 (if (fboundp sym)
21385
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1061 (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
1062 ;; 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
1063 (save-excursion
22417
e78006d10683 (help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents: 22407
diff changeset
1064 ;; 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
1065 (goto-char (point-min))
21385
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1066 ;; 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
1067 ;; name will be found.
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1068 (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
1069 nil t)
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1070 (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
1071 (while
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1072 ;; 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
1073 ;; double ones, which should terminate it.
25473
1ad8606c8cc7 (help-make-xrefs): Don't lose on non-empty blank line after key table.
Dave Love <fx@gnu.org>
parents: 25047
diff changeset
1074 (and (not (looking-at "\n\\s-*\n"))
21385
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1075 (progn
24710
bcb0ee72502c (help-make-xrefs): Handle more cases when looking for
Andreas Schwab <schwab@suse.de>
parents: 24642
diff changeset
1076 (and (eolp) (forward-line))
bcb0ee72502c (help-make-xrefs): Handle more cases when looking for
Andreas Schwab <schwab@suse.de>
parents: 24642
diff changeset
1077 (end-of-line)
bcb0ee72502c (help-make-xrefs): Handle more cases when looking for
Andreas Schwab <schwab@suse.de>
parents: 24642
diff changeset
1078 (skip-chars-backward "^\t\n")
bcb0ee72502c (help-make-xrefs): Handle more cases when looking for
Andreas Schwab <schwab@suse.de>
parents: 24642
diff changeset
1079 (if (and (>= (current-column) col)
24714
19bd1617f9e3 (help-make-xrefs): Fix typpo.
Dave Love <fx@gnu.org>
parents: 24710
diff changeset
1080 (looking-at "\\(\\sw\\|-\\)+$"))
21385
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1081 (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
1082 (if (fboundp sym)
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1083 (help-xref-button
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1084 0 #'describe-function sym))))
24710
bcb0ee72502c (help-make-xrefs): Handle more cases when looking for
Andreas Schwab <schwab@suse.de>
parents: 24642
diff changeset
1085 (zerop (forward-line)))))))))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1086 (set-syntax-table stab))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1087 ;; 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
1088 (when help-xref-stack
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1089 (goto-char (point-max))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1090 (save-excursion
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1091 (insert "\n\n" help-back-label))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1092 ;; Just to provide the match data:
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1093 (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
1094 (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
1095 ;; View mode steals RET from us.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1096 (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
1097 (list (cons 'view-mode
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1098 (let ((map (make-sparse-keymap)))
21385
a14e82c3a69e (help-make-xrefs): Grok commands in keymap table
Dave Love <fx@gnu.org>
parents: 21371
diff changeset
1099 (set-keymap-parent map view-mode-map)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1100 (define-key map "\r" 'help-follow)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1101 map))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1102 (set-buffer-modified-p old-modified))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1103
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1104 (defun help-xref-button (match-number function data)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1105 "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
1106
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1107 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
1108 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
1109 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
1110 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
1111 ;; 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
1112 (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
1113 (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
1114 (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
1115 (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
1116 '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
1117 (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
1118 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
1119 (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
1120 (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
1121 (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
1122 (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
1123 'face help-highlight-face))))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1124
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1125
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1126 ;; 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
1127 (defun help-xref-interned (symbol)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1128 "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
1129
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1130 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
1131 help buffer."
26005
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1132 (let ((fdoc (when (fboundp symbol) (describe-function symbol))))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1133 (when (or (boundp symbol) (not fdoc))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1134 (describe-variable symbol)
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1135 ;; We now have a help buffer on the variable. Insert the function
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1136 ;; text before it.
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1137 (when fdoc
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1138 (with-current-buffer "*Help*"
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1139 (goto-char (point-min))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1140 (let ((inhibit-read-only t))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1141 (insert fdoc "\n\n" (symbol-name symbol) " is also a variable.\n\n"))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1142 (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
1143
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1144 (defun help-xref-mode (buffer)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1145 "Do a `describe-mode' for the specified BUFFER."
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1146 (save-excursion
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1147 (set-buffer buffer)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1148 (describe-mode)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1149
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1150 ;;; Navigation/hyperlinking with xrefs
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1151
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1152 (defun help-follow-mouse (click)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1153 "Follow the cross-reference that you click on."
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1154 (interactive "e")
22417
e78006d10683 (help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents: 22407
diff changeset
1155 (let* ((start (event-start click))
e78006d10683 (help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents: 22407
diff changeset
1156 (window (car start))
e78006d10683 (help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents: 22407
diff changeset
1157 (pos (car (cdr start))))
e78006d10683 (help-make-xrefs): When scanning keymap binding listings,
Richard M. Stallman <rms@gnu.org>
parents: 22407
diff changeset
1158 (with-current-buffer (window-buffer window)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1159 (help-follow pos))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1160
21973
f3d29552e393 (view-lossage): Set help-xref-stack* in the help buffer.
Richard M. Stallman <rms@gnu.org>
parents: 21972
diff changeset
1161 (defun help-xref-go-back (buffer)
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
1162 "From BUFFER, go back to previous help buffer text using `help-xref-stack'."
22325
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
1163 (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
1164 (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
1165 (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
1166 (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
1167 (setq item (car help-xref-stack)
22325
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
1168 position (car item)
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
1169 method (cadr item)
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
1170 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
1171 (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
1172 (apply method args)
baef082e5d6d (help-setup-xref): Change all callers to
Karl Heuer <kwzh@gnu.org>
parents: 22234
diff changeset
1173 (goto-char position)))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1174
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1175 (defun help-go-back ()
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
1176 "Invoke the [back] button (if any) in the Help mode buffer."
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1177 (interactive)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1178 (help-follow (1- (point-max))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1179
26224
53779a54d9cc (help-follow): Make arg optional again and really default to point.
Dave Love <fx@gnu.org>
parents: 26005
diff changeset
1180 (defun help-follow (&optional pos)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1181 "Follow cross-reference at POS, defaulting to point.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1182
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1183 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
1184 (interactive "d")
26224
53779a54d9cc (help-follow): Make arg optional again and really default to point.
Dave Love <fx@gnu.org>
parents: 26005
diff changeset
1185 (unless pos
53779a54d9cc (help-follow): Make arg optional again and really default to point.
Dave Love <fx@gnu.org>
parents: 26005
diff changeset
1186 (setq pos (point)))
26005
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1187 (let* ((help-data
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1188 (or (and (not (= pos (point-max)))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1189 (get-text-property pos 'help-xref))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1190 (and (not (= pos (point-min)))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1191 (get-text-property (1- pos) 'help-xref))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1192 ;; check if the symbol under point is a function or variable
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1193 (let ((sym
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1194 (intern
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1195 (save-excursion
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1196 (goto-char pos) (skip-syntax-backward "w_")
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1197 (buffer-substring (point)
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1198 (progn (skip-syntax-forward "w_")
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1199 (point)))))))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1200 (when (or (boundp sym) (fboundp sym))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1201 (list #'help-xref-interned sym)))))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1202 (method (car help-data))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1203 (args (cdr help-data)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1204 (when help-data
26005
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1205 (setq help-xref-stack (cons (cons (point) help-xref-stack-item)
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1206 help-xref-stack))
6613b3835666 (help-xref-interned): make it also work on variable-only and
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 25846
diff changeset
1207 (setq help-xref-stack-item nil)
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1208 ;; There is a reference at point. Follow it.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1209 (apply method args))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1210
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1211 ;; For tabbing through buffer.
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1212 (defun help-next-ref ()
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1213 "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
1214 (interactive)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1215 (let (pos)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1216 (while (not pos)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1217 (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
1218 (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
1219 (point))))
21371
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1220 (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
1221 (if pos (goto-char pos)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1222 ((bobp)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1223 (message "No cross references in the buffer.")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1224 (setq pos t))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1225 (t ; be circular
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1226 (goto-char (point-min)))))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1227
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1228 (defun help-previous-ref ()
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1229 "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
1230 (interactive)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1231 (let (pos)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1232 (while (not pos)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1233 (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
1234 (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
1235 (point))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1236 (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
1237 (if pos (goto-char pos)))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1238 ((bobp)
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1239 (message "No cross references in the buffer.")
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1240 (setq pos t))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1241 (t ; be circular
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1242 (goto-char (point-max)))))))
22a3be0ae9dc (help-highlight-face): Use underline.
Richard M. Stallman <rms@gnu.org>
parents: 21210
diff changeset
1243
23747
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1244
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1245 ;;; Automatic resizing of temporary buffers.
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1246
23749
ea095fa15fb9 Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents: 23747
diff changeset
1247 (defcustom temp-buffer-resize-mode nil
23747
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1248 "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
1249 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
1250 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
1251 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
1252
24642
27387f2d010c (temp-buffer-resize-mode): Doc fix.
Dave Love <fx@gnu.org>
parents: 24597
diff changeset
1253 Setting this variable directly does not take effect;
27387f2d010c (temp-buffer-resize-mode): Doc fix.
Dave Love <fx@gnu.org>
parents: 24597
diff changeset
1254 use either \\[customize] or the function `temp-buffer-resize-mode'."
23747
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1255 :get (lambda (symbol)
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1256 (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
1257 :set (lambda (symbol value)
23749
ea095fa15fb9 Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents: 23747
diff changeset
1258 (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
1259 :initialize 'custom-initialize-default
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1260 :type 'boolean
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1261 :group 'help
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1262 :version "20.4")
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1263
23749
ea095fa15fb9 Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents: 23747
diff changeset
1264 (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
1265 "*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
1266 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
1267 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
1268 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
1269 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
1270 positive number."
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1271 :type '(choice integer function)
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1272 :group 'help
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1273 :version "20.4")
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1274
23749
ea095fa15fb9 Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents: 23747
diff changeset
1275 (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
1276 "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
1277 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
1278 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
1279 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
1280 more information."
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1281 (interactive "P")
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1282 (let ((turn-it-on
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1283 (if (null arg)
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1284 (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
1285 (> (prefix-numeric-value arg) 0))))
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1286 (if turn-it-on
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1287 (progn
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1288 ;; `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
1289 ;; 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
1290 (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
1291 (setq temp-buffer-resize-mode t))
23747
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1292 (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
1293 (setq temp-buffer-resize-mode nil))))
23747
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1294
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1295 (defun resize-temp-buffer-window ()
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1296 "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
1297 Will not make it higher than `temp-buffer-max-height' nor smaller than
24079
11e777f59a1f (help-make-xrefs): Avoid infloop in keymap substitutions
Dave Love <fx@gnu.org>
parents: 24055
diff changeset
1298 `window-min-height'. Do nothing if it is the only window on its frame, if it
23747
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1299 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
1300 out of view."
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1301 (unless (or (one-window-p 'nomini)
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1302 (not (pos-visible-in-window-p (point-min)))
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1303 (/= (frame-width) (window-width)))
23749
ea095fa15fb9 Rename function and variables added in previous change:
Richard M. Stallman <rms@gnu.org>
parents: 23747
diff changeset
1304 (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
1305 (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
1306 temp-buffer-max-height))
23747
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1307 (win-height (1- (window-height)))
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1308 (min-height (1- window-min-height))
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1309 (text-height (window-buffer-height(selected-window)))
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1310 (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
1311 (enlarge-window (- new-height win-height)))))
fb3963445995 Add resizing of temporary buffers.
Richard M. Stallman <rms@gnu.org>
parents: 23742
diff changeset
1312
660
08eb386dd0f3 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 444
diff changeset
1313 ;;; help.el ends here