41584
|
1 ;;; help-fns.el --- Complex help functions
|
41583
|
2
|
64762
|
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001,
|
68158
|
4 ;; 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
|
41583
|
5
|
|
6 ;; Maintainer: FSF
|
|
7 ;; Keywords: help, internal
|
|
8
|
|
9 ;; This file is part of GNU Emacs.
|
|
10
|
|
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
12 ;; it under the terms of the GNU General Public License as published by
|
|
13 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
14 ;; any later version.
|
|
15
|
|
16 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
19 ;; GNU General Public License for more details.
|
|
20
|
|
21 ;; You should have received a copy of the GNU General Public License
|
|
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
64091
|
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
24 ;; Boston, MA 02110-1301, USA.
|
41583
|
25
|
|
26 ;;; Commentary:
|
|
27
|
|
28 ;; This file contains those help commands which are complicated, and
|
|
29 ;; which may not be used in every session. For example
|
|
30 ;; `describe-function' will probably be heavily used when doing elisp
|
|
31 ;; programming, but not if just editing C files. Simpler help commands
|
|
32 ;; are in help.el
|
|
33
|
|
34 ;;; Code:
|
|
35
|
|
36 (require 'help-mode)
|
|
37
|
|
38 ;; Functions
|
|
39
|
|
40 ;;;###autoload
|
|
41 (defun describe-function (function)
|
|
42 "Display the full documentation of FUNCTION (a symbol)."
|
|
43 (interactive
|
|
44 (let ((fn (function-called-at-point))
|
|
45 (enable-recursive-minibuffers t)
|
|
46 val)
|
|
47 (setq val (completing-read (if fn
|
|
48 (format "Describe function (default %s): " fn)
|
|
49 "Describe function: ")
|
68402
|
50 obarray 'fboundp t nil nil
|
|
51 (and fn (symbol-name fn))))
|
41583
|
52 (list (if (equal val "")
|
|
53 fn (intern val)))))
|
|
54 (if (null function)
|
|
55 (message "You didn't specify a function")
|
|
56 (help-setup-xref (list #'describe-function function) (interactive-p))
|
42591
|
57 (save-excursion
|
|
58 (with-output-to-temp-buffer (help-buffer)
|
|
59 (prin1 function)
|
|
60 ;; Use " is " instead of a colon so that
|
|
61 ;; it is easier to get out the function name using forward-sexp.
|
|
62 (princ " is ")
|
|
63 (describe-function-1 function)
|
|
64 (print-help-return-message)
|
|
65 (with-current-buffer standard-output
|
|
66 ;; Return the text we displayed.
|
|
67 (buffer-string))))))
|
41583
|
68
|
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
69 (defun help-split-fundoc (docstring def)
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
70 "Split a function DOCSTRING into the actual doc and the usage info.
|
46957
|
71 Return (USAGE . DOC) or nil if there's no usage info.
|
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
72 DEF is the function whose usage we're looking for in DOCSTRING."
|
46957
|
73 ;; Functions can get the calling sequence at the end of the doc string.
|
46439
|
74 ;; In cases where `function' has been fset to a subr we can't search for
|
46957
|
75 ;; function's name in the doc string so we use `fn' as the anonymous
|
|
76 ;; function name instead.
|
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
77 (when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring))
|
47663
|
78 (cons (format "(%s%s"
|
|
79 ;; Replace `fn' with the actual function name.
|
|
80 (if (consp def) "anonymous" def)
|
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
81 (match-string 1 docstring))
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
82 (substring docstring 0 (match-beginning 0)))))
|
47663
|
83
|
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
84 (defun help-add-fundoc-usage (docstring arglist)
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
85 "Add the usage info to DOCSTRING.
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
86 If DOCSTRING already has a usage info, then just return it unchanged.
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
87 The usage info is built from ARGLIST. DOCSTRING can be nil.
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
88 ARGLIST can also be t or a string of the form \"(FUN ARG1 ARG2 ...)\"."
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
89 (unless (stringp docstring) (setq docstring "Not documented"))
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
90 (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring) (eq arglist t))
|
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
91 docstring
|
55723
813de71608a6
(help-add-fundoc-usage): Use %S only for output of `help-make-usage'.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
92 (concat docstring
|
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
93 (if (string-match "\n?\n\\'" docstring)
|
50559
4975a5944969
(help-add-fundoc-usage): Pass an empty string to `format' if
John Paul Wallington <jpw@pobox.com>
diff
changeset
|
94 (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "")
|
47663
|
95 "\n\n")
|
50799
|
96 (if (and (stringp arglist)
|
|
97 (string-match "\\`([^ ]+\\(.*\\))\\'" arglist))
|
|
98 (concat "(fn" (match-string 1 arglist) ")")
|
55723
813de71608a6
(help-add-fundoc-usage): Use %S only for output of `help-make-usage'.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
99 (format "%S" (help-make-usage 'fn arglist))))))
|
46439
|
100
|
|
101 (defun help-function-arglist (def)
|
46901
|
102 ;; Handle symbols aliased to other symbols.
|
|
103 (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def)))
|
|
104 ;; If definition is a macro, find the function inside it.
|
|
105 (if (eq (car-safe def) 'macro) (setq def (cdr def)))
|
46439
|
106 (cond
|
|
107 ((byte-code-function-p def) (aref def 0))
|
|
108 ((eq (car-safe def) 'lambda) (nth 1 def))
|
|
109 ((and (eq (car-safe def) 'autoload) (not (eq (nth 4 def) 'keymap)))
|
|
110 "[Arg list not available until function definition is loaded.]")
|
|
111 (t t)))
|
|
112
|
|
113 (defun help-make-usage (function arglist)
|
|
114 (cons (if (symbolp function) function 'anonymous)
|
|
115 (mapcar (lambda (arg)
|
46957
|
116 (if (not (symbolp arg))
|
|
117 (if (and (consp arg) (symbolp (car arg)))
|
|
118 ;; CL style default values for optional args.
|
|
119 (cons (intern (upcase (symbol-name (car arg))))
|
|
120 (cdr arg))
|
|
121 arg)
|
46439
|
122 (let ((name (symbol-name arg)))
|
|
123 (if (string-match "\\`&" name) arg
|
|
124 (intern (upcase name))))))
|
|
125 arglist)))
|
|
126
|
64304
|
127 ;; Could be this, if we make symbol-file do the work below.
|
|
128 ;; (defun help-C-file-name (subr-or-var kind)
|
|
129 ;; "Return the name of the C file where SUBR-OR-VAR is defined.
|
|
130 ;; KIND should be `var' for a variable or `subr' for a subroutine."
|
|
131 ;; (symbol-file (if (symbolp subr-or-var) subr-or-var
|
|
132 ;; (subr-name subr-or-var))
|
|
133 ;; (if (eq kind 'var) 'defvar 'defun)))
|
62908
|
134 ;;;###autoload
|
54749
|
135 (defun help-C-file-name (subr-or-var kind)
|
|
136 "Return the name of the C file where SUBR-OR-VAR is defined.
|
|
137 KIND should be `var' for a variable or `subr' for a subroutine."
|
|
138 (let ((docbuf (get-buffer-create " *DOC*"))
|
|
139 (name (if (eq 'var kind)
|
|
140 (concat "V" (symbol-name subr-or-var))
|
55234
|
141 (concat "F" (subr-name subr-or-var)))))
|
54749
|
142 (with-current-buffer docbuf
|
|
143 (goto-char (point-min))
|
|
144 (if (eobp)
|
|
145 (insert-file-contents-literally
|
|
146 (expand-file-name internal-doc-file-name doc-directory)))
|
58069
42823717f9da
* help-fns.el (help-C-file-name): File name must be in build-files
Jan Djärv <jan.h.d@swipnet.se>
diff
changeset
|
147 (let ((file (catch 'loop
|
42823717f9da
* help-fns.el (help-C-file-name): File name must be in build-files
Jan Djärv <jan.h.d@swipnet.se>
diff
changeset
|
148 (while t
|
42823717f9da
* help-fns.el (help-C-file-name): File name must be in build-files
Jan Djärv <jan.h.d@swipnet.se>
diff
changeset
|
149 (let ((pnt (search-forward (concat "" name "\n"))))
|
59410
|
150 (re-search-backward "S\\(.*\\)")
|
|
151 (let ((file (match-string 1)))
|
58069
42823717f9da
* help-fns.el (help-C-file-name): File name must be in build-files
Jan Djärv <jan.h.d@swipnet.se>
diff
changeset
|
152 (if (member file build-files)
|
42823717f9da
* help-fns.el (help-C-file-name): File name must be in build-files
Jan Djärv <jan.h.d@swipnet.se>
diff
changeset
|
153 (throw 'loop file)
|
42823717f9da
* help-fns.el (help-C-file-name): File name must be in build-files
Jan Djärv <jan.h.d@swipnet.se>
diff
changeset
|
154 (goto-char pnt))))))))
|
54749
|
155 (if (string-match "\\.\\(o\\|obj\\)\\'" file)
|
55234
|
156 (setq file (replace-match ".c" t t file)))
|
|
157 (if (string-match "\\.c\\'" file)
|
|
158 (concat "src/" file)
|
54749
|
159 file)))))
|
|
160
|
55958
519edd453780
(help-argument-name): Inherit from italic face only if the frame
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
161 (defface help-argument-name '((((supports :slant italic)) :inherit italic))
|
55946
|
162 "Face to highlight argument names in *Help* buffers."
|
|
163 :group 'help)
|
55909
|
164
|
55564
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
165 (defun help-default-arg-highlight (arg)
|
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
166 "Default function to highlight arguments in *Help* buffers.
|
55909
|
167 It returns ARG in face `help-argument-name'; ARG is also
|
|
168 downcased if it displays differently than the default
|
|
169 face (according to `face-differs-from-default-p')."
|
|
170 (propertize (if (face-differs-from-default-p 'help-argument-name)
|
|
171 (downcase arg)
|
|
172 arg)
|
|
173 'face 'help-argument-name))
|
55351
|
174
|
|
175 (defun help-do-arg-highlight (doc args)
|
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
176 (with-syntax-table (make-syntax-table emacs-lisp-mode-syntax-table)
|
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
177 (modify-syntax-entry ?\- "w")
|
65494
|
178 (dolist (arg args doc)
|
|
179 (setq doc (replace-regexp-in-string
|
|
180 ;; This is heuristic, but covers all common cases
|
|
181 ;; except ARG1-ARG2
|
|
182 (concat "\\<" ; beginning of word
|
|
183 "\\(?:[a-z-]*-\\)?" ; for xxx-ARG
|
|
184 "\\("
|
|
185 (regexp-quote arg)
|
|
186 "\\)"
|
|
187 "\\(?:es\\|s\\|th\\)?" ; for ARGth, ARGs
|
|
188 "\\(?:-[a-z0-9-]+\\)?" ; for ARG-xxx, ARG-n
|
68994
9dadad58610c
(help-do-arg-highlight): Recognize also ARG- followed by the opening bracket of
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
189 "\\(?:-[{([<`\"].*?\\)?"; for ARG-{x}, (x), <x>, [x], `x'
|
65494
|
190 "\\>") ; end of word
|
|
191 (help-default-arg-highlight arg)
|
|
192 doc t t 1)))))
|
55351
|
193
|
|
194 (defun help-highlight-arguments (usage doc &rest args)
|
|
195 (when usage
|
55454
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
196 (with-temp-buffer
|
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
197 (insert usage)
|
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
198 (goto-char (point-min))
|
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
199 (let ((case-fold-search nil)
|
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
200 (next (not (or args (looking-at "\\["))))
|
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
201 (opt nil))
|
55351
|
202 ;; Make a list of all arguments
|
55723
813de71608a6
(help-add-fundoc-usage): Use %S only for output of `help-make-usage'.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
203 (skip-chars-forward "^ ")
|
55351
|
204 (while next
|
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
205 (or opt (not (looking-at " &")) (setq opt t))
|
55454
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
206 (if (not (re-search-forward " \\([\\[(]*\\)\\([^] &)\.]+\\)" nil t))
|
55351
|
207 (setq next nil)
|
|
208 (setq args (cons (match-string 2) args))
|
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
209 (when (and opt (string= (match-string 1) "("))
|
55351
|
210 ;; A pesky CL-style optional argument with default value,
|
|
211 ;; so let's skip over it
|
|
212 (search-backward "(")
|
|
213 (goto-char (scan-sexps (point) 1)))))
|
|
214 ;; Highlight aguments in the USAGE string
|
55457
|
215 (setq usage (help-do-arg-highlight (buffer-string) args))
|
|
216 ;; Highlight arguments in the DOC string
|
55479
|
217 (setq doc (and doc (help-do-arg-highlight doc args))))))
|
|
218 ;; Return value is like the one from help-split-fundoc, but highlighted
|
|
219 (cons usage doc))
|
55351
|
220
|
66580
|
221 ;;;###autoload
|
66350
|
222 (defun describe-simplify-lib-file-name (file)
|
|
223 "Simplify a library name FILE to a relative name, and make it a source file."
|
|
224 (if file
|
|
225 ;; Try converting the absolute file name to a library name.
|
|
226 (let ((libname (file-name-nondirectory file)))
|
|
227 ;; Now convert that back to a file name and see if we get
|
|
228 ;; the original one. If so, they are equivalent.
|
|
229 (if (equal file (locate-file libname load-path '("")))
|
66523
|
230 (if (string-match "[.]elc\\'" libname)
|
66350
|
231 (substring libname 0 -1)
|
|
232 libname)
|
|
233 file))))
|
|
234
|
41583
|
235 ;;;###autoload
|
|
236 (defun describe-function-1 (function)
|
|
237 (let* ((def (if (symbolp function)
|
|
238 (symbol-function function)
|
|
239 function))
|
|
240 file-name string
|
|
241 (beg (if (commandp def) "an interactive " "a ")))
|
|
242 (setq string
|
|
243 (cond ((or (stringp def)
|
|
244 (vectorp def))
|
|
245 "a keyboard macro")
|
|
246 ((subrp def)
|
|
247 (if (eq 'unevalled (cdr (subr-arity def)))
|
|
248 (concat beg "special form")
|
|
249 (concat beg "built-in function")))
|
|
250 ((byte-code-function-p def)
|
|
251 (concat beg "compiled Lisp function"))
|
|
252 ((symbolp def)
|
|
253 (while (symbolp (symbol-function def))
|
|
254 (setq def (symbol-function def)))
|
|
255 (format "an alias for `%s'" def))
|
|
256 ((eq (car-safe def) 'lambda)
|
|
257 (concat beg "Lisp function"))
|
|
258 ((eq (car-safe def) 'macro)
|
|
259 "a Lisp macro")
|
|
260 ((eq (car-safe def) 'autoload)
|
|
261 (setq file-name (nth 1 def))
|
|
262 (format "%s autoloaded %s"
|
|
263 (if (commandp def) "an interactive" "an")
|
|
264 (if (eq (nth 4 def) 'keymap) "keymap"
|
|
265 (if (nth 4 def) "Lisp macro" "Lisp function"))
|
|
266 ))
|
46901
|
267 ((keymapp def)
|
41583
|
268 (let ((is-full nil)
|
|
269 (elts (cdr-safe def)))
|
|
270 (while elts
|
|
271 (if (char-table-p (car-safe elts))
|
|
272 (setq is-full t
|
|
273 elts nil))
|
|
274 (setq elts (cdr-safe elts)))
|
|
275 (if is-full
|
|
276 "a full keymap"
|
|
277 "a sparse keymap")))
|
|
278 (t "")))
|
|
279 (princ string)
|
|
280 (with-current-buffer standard-output
|
|
281 (save-excursion
|
|
282 (save-match-data
|
|
283 (if (re-search-backward "alias for `\\([^`']+\\)'" nil t)
|
|
284 (help-xref-button 1 'help-function def)))))
|
|
285 (or file-name
|
59125
|
286 (setq file-name (symbol-file function 'defun)))
|
66350
|
287 (setq file-name (describe-simplify-lib-file-name file-name))
|
45193
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
288 (when (equal file-name "loaddefs.el")
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
289 ;; Find the real def site of the preloaded function.
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
290 ;; This is necessary only for defaliases.
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
291 (let ((location
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
292 (condition-case nil
|
45975
|
293 (find-function-search-for-symbol function nil "loaddefs.el")
|
45193
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
294 (error nil))))
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
295 (when location
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
296 (with-current-buffer (car location)
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
297 (goto-char (cdr location))
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
298 (when (re-search-backward
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
299 "^;;; Generated autoloads from \\(.*\\)" nil t)
|
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
diff
changeset
|
300 (setq file-name (match-string 1)))))))
|
55234
|
301 (when (and (null file-name) (subrp def))
|
54749
|
302 ;; Find the C source file name.
|
55234
|
303 (setq file-name (if (get-buffer " *DOC*")
|
|
304 (help-C-file-name def 'subr)
|
|
305 'C-source)))
|
54749
|
306 (when file-name
|
42591
|
307 (princ " in `")
|
|
308 ;; We used to add .el to the file name,
|
|
309 ;; but that's completely wrong when the user used load-file.
|
55234
|
310 (princ (if (eq file-name 'C-source) "C source code" file-name))
|
42591
|
311 (princ "'")
|
|
312 ;; Make a hyperlink to the library.
|
41583
|
313 (with-current-buffer standard-output
|
54749
|
314 (save-excursion
|
42591
|
315 (re-search-backward "`\\([^`']+\\)'" nil t)
|
54749
|
316 (help-xref-button 1 'help-function-def function file-name))))
|
41583
|
317 (princ ".")
|
|
318 (terpri)
|
|
319 (when (commandp function)
|
73391
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
320 (if (and (eq function 'self-insert-command)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
321 (eq (key-binding "a") 'self-insert-command)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
322 (eq (key-binding "b") 'self-insert-command)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
323 (eq (key-binding "c") 'self-insert-command))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
324 (princ "It is bound to many ordinary text characters.\n")
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
325 (let* ((remapped (command-remapping function))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
326 (keys (where-is-internal
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
327 (or remapped function) overriding-local-map nil nil))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
328 non-modified-keys)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
329 ;; Which non-control non-meta keys run this command?
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
330 (dolist (key keys)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
331 (if (member (event-modifiers (aref key 0)) '(nil (shift)))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
332 (push key non-modified-keys)))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
333 (when remapped
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
334 (princ "It is remapped to `")
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
335 (princ (symbol-name remapped))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
336 (princ "'"))
|
55009
|
337
|
73391
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
338 (when keys
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
339 (princ (if remapped " which is bound to " "It is bound to "))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
340 ;; If lots of ordinary text characters run this command,
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
341 ;; don't mention them one by one.
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
342 (if (< (length non-modified-keys) 10)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
343 (princ (mapconcat 'key-description keys ", "))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
344 (dolist (key non-modified-keys)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
345 (setq keys (delq key keys)))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
346 (if keys
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
347 (progn
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
348 (princ (mapconcat 'key-description keys ", "))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
349 (princ ", and many ordinary text characters"))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
350 (princ "many ordinary text characters"))))
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
351 (when (or remapped keys non-modified-keys)
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
352 (princ ".")
|
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
353 (terpri)))))
|
46439
|
354 (let* ((arglist (help-function-arglist def))
|
|
355 (doc (documentation function))
|
46957
|
356 (usage (help-split-fundoc doc function)))
|
55351
|
357 (with-current-buffer standard-output
|
|
358 ;; If definition is a keymap, skip arglist note.
|
|
359 (unless (keymapp def)
|
|
360 (let* ((use (cond
|
|
361 (usage (setq doc (cdr usage)) (car usage))
|
|
362 ((listp arglist)
|
|
363 (format "%S" (help-make-usage function arglist)))
|
|
364 ((stringp arglist) arglist)
|
|
365 ;; Maybe the arglist is in the docstring of the alias.
|
|
366 ((let ((fun function))
|
|
367 (while (and (symbolp fun)
|
|
368 (setq fun (symbol-function fun))
|
|
369 (not (setq usage (help-split-fundoc
|
|
370 (documentation fun)
|
|
371 function)))))
|
|
372 usage)
|
|
373 (car usage))
|
|
374 ((or (stringp def)
|
|
375 (vectorp def))
|
|
376 (format "\nMacro: %s" (format-kbd-macro def)))
|
|
377 (t "[Missing arglist. Please make a bug report.]")))
|
|
378 (high (help-highlight-arguments use doc)))
|
67217
|
379 (let ((fill-begin (point)))
|
|
380 (insert (car high) "\n")
|
|
381 (fill-region fill-begin (point)))
|
55351
|
382 (setq doc (cdr high))))
|
|
383 (let ((obsolete (and
|
|
384 ;; function might be a lambda construct.
|
|
385 (symbolp function)
|
|
386 (get function 'byte-obsolete-info))))
|
|
387 (when obsolete
|
|
388 (princ "\nThis function is obsolete")
|
|
389 (when (nth 2 obsolete)
|
|
390 (insert (format " since %s" (nth 2 obsolete))))
|
|
391 (insert ";\n"
|
|
392 (if (stringp (car obsolete)) (car obsolete)
|
|
393 (format "use `%s' instead." (car obsolete)))
|
|
394 "\n"))
|
|
395 (insert "\n"
|
|
396 (or doc "Not documented.")))))))
|
41583
|
397
|
|
398
|
|
399 ;; Variables
|
|
400
|
|
401 ;;;###autoload
|
59368
|
402 (defun variable-at-point (&optional any-symbol)
|
41583
|
403 "Return the bound variable symbol found around point.
|
59368
|
404 Return 0 if there is no such symbol.
|
|
405 If ANY-SYMBOL is non-nil, don't insist the symbol be bound."
|
56884
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
406 (or (condition-case ()
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
407 (with-syntax-table emacs-lisp-mode-syntax-table
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
408 (save-excursion
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
409 (or (not (zerop (skip-syntax-backward "_w")))
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
410 (eq (char-syntax (following-char)) ?w)
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
411 (eq (char-syntax (following-char)) ?_)
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
412 (forward-sexp -1))
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
413 (skip-chars-forward "'")
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
414 (let ((obj (read (current-buffer))))
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
415 (and (symbolp obj) (boundp obj) obj))))
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
416 (error nil))
|
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
417 (let* ((str (find-tag-default))
|
58993
|
418 (sym (if str (intern-soft str))))
|
59368
|
419 (if (and sym (or any-symbol (boundp sym)))
|
58993
|
420 sym
|
|
421 (save-match-data
|
|
422 (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str))
|
|
423 (setq sym (intern-soft (match-string 1 str)))
|
59368
|
424 (and (or any-symbol (boundp sym)) sym)))))
|
56884
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
diff
changeset
|
425 0))
|
41583
|
426
|
|
427 ;;;###autoload
|
|
428 (defun describe-variable (variable &optional buffer)
|
|
429 "Display the full documentation of VARIABLE (a symbol).
|
|
430 Returns the documentation as a string, also.
|
|
431 If VARIABLE has a buffer-local value in BUFFER (default to the current buffer),
|
|
432 it is displayed along with the global value."
|
|
433 (interactive
|
|
434 (let ((v (variable-at-point))
|
|
435 (enable-recursive-minibuffers t)
|
|
436 val)
|
|
437 (setq val (completing-read (if (symbolp v)
|
|
438 (format
|
|
439 "Describe variable (default %s): " v)
|
|
440 "Describe variable: ")
|
66793
|
441 obarray
|
|
442 '(lambda (vv)
|
|
443 (or (boundp vv)
|
|
444 (get vv 'variable-documentation)))
|
|
445 t nil nil
|
41583
|
446 (if (symbolp v) (symbol-name v))))
|
|
447 (list (if (equal val "")
|
|
448 v (intern val)))))
|
45975
|
449 (unless (buffer-live-p buffer) (setq buffer (current-buffer)))
|
41583
|
450 (if (not (symbolp variable))
|
|
451 (message "You did not specify a variable")
|
42591
|
452 (save-excursion
|
46901
|
453 (let* ((valvoid (not (with-current-buffer buffer (boundp variable))))
|
|
454 ;; Extract the value before setting up the output buffer,
|
|
455 ;; in case `buffer' *is* the output buffer.
|
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
456 (val (unless valvoid (buffer-local-value variable buffer)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
457 val-start-pos)
|
42591
|
458 (help-setup-xref (list #'describe-variable variable buffer)
|
|
459 (interactive-p))
|
|
460 (with-output-to-temp-buffer (help-buffer)
|
|
461 (with-current-buffer buffer
|
|
462 (prin1 variable)
|
|
463 ;; Make a hyperlink to the library if appropriate. (Don't
|
|
464 ;; change the format of the buffer's initial line in case
|
|
465 ;; anything expects the current format.)
|
59125
|
466 (let ((file-name (symbol-file variable 'defvar)))
|
66350
|
467 (setq file-name (describe-simplify-lib-file-name file-name))
|
42591
|
468 (when (equal file-name "loaddefs.el")
|
|
469 ;; Find the real def site of the preloaded variable.
|
|
470 (let ((location
|
|
471 (condition-case nil
|
|
472 (find-variable-noselect variable file-name)
|
|
473 (error nil))))
|
|
474 (when location
|
|
475 (with-current-buffer (car location)
|
71849
2227a7e3b7eb
(describe-variable): Handle find-variable-noselect returning no position.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
476 (when (cdr location)
|
2227a7e3b7eb
(describe-variable): Handle find-variable-noselect returning no position.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
477 (goto-char (cdr location)))
|
42591
|
478 (when (re-search-backward
|
|
479 "^;;; Generated autoloads from \\(.*\\)" nil t)
|
|
480 (setq file-name (match-string 1)))))))
|
54749
|
481 (when (and (null file-name)
|
|
482 (integerp (get variable 'variable-documentation)))
|
|
483 ;; It's a variable not defined in Elisp but in C.
|
55234
|
484 (setq file-name
|
|
485 (if (get-buffer " *DOC*")
|
|
486 (help-C-file-name variable 'var)
|
|
487 'C-source)))
|
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
488 (if file-name
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
489 (progn
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
490 (princ " is a variable defined in `")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
491 (princ (if (eq file-name 'C-source) "C source code" file-name))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
492 (princ "'.\n")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
493 (with-current-buffer standard-output
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
494 (save-excursion
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
495 (re-search-backward "`\\([^`']+\\)'" nil t)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
496 (help-xref-button 1 'help-variable-def
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
497 variable file-name)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
498 (if valvoid
|
68153
27e860fd29ef
(describe-variable): Remove newlines from void variable output.
John Paul Wallington <jpw@pobox.com>
diff
changeset
|
499 (princ "It is void as a variable.")
|
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
500 (princ "Its ")))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
501 (if valvoid
|
68153
27e860fd29ef
(describe-variable): Remove newlines from void variable output.
John Paul Wallington <jpw@pobox.com>
diff
changeset
|
502 (princ " is void as a variable.")
|
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
503 (princ "'s "))))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
504 (if valvoid
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
505 nil
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
506 (with-current-buffer standard-output
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
507 (setq val-start-pos (point))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
508 (princ "value is ")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
509 (terpri)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
510 (let ((from (point)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
511 (pp val)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
512 ;; Hyperlinks in variable's value are quite frequently
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
513 ;; inappropriate e.g C-h v <RET> features <RET>
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
514 ;; (help-xref-on-pp from (point))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
515 (if (< (point) (+ from 20))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
516 (delete-region (1- from) from)))))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
517 (terpri)
|
41583
|
518
|
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
519 (when (local-variable-p variable)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
520 (princ (format "%socal in buffer %s; "
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
521 (if (get variable 'permanent-local)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
522 "Permanently l" "L")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
523 (buffer-name)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
524 (if (not (default-boundp variable))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
525 (princ "globally void")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
526 (let ((val (default-value variable)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
527 (with-current-buffer standard-output
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
528 (princ "global value is ")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
529 (terpri)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
530 ;; Fixme: pp can take an age if you happen to
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
531 ;; ask for a very large expression. We should
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
532 ;; probably print it raw once and check it's a
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
533 ;; sensible size before prettyprinting. -- fx
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
534 (let ((from (point)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
535 (pp val)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
536 ;; See previous comment for this function.
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
537 ;; (help-xref-on-pp from (point))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
538 (if (< (point) (+ from 20))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
539 (delete-region (1- from) from)))))))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
540 ;; Add a note for variables that have been make-var-buffer-local.
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
541 (when (and (local-variable-if-set-p variable)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
542 (or (not (local-variable-p variable))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
543 (with-temp-buffer
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
544 (local-variable-if-set-p variable))))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
545 (princ "\nAutomatically becomes buffer-local when set in any fashion.\n"))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
546 (terpri)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
547
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
548 ;; If the value is large, move it to the end.
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
549 (with-current-buffer standard-output
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
550 (when (> (count-lines (point-min) (point-max)) 10)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
551 ;; Note that setting the syntax table like below
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
552 ;; makes forward-sexp move over a `'s' at the end
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
553 ;; of a symbol.
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
554 (set-syntax-table emacs-lisp-mode-syntax-table)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
555 (goto-char val-start-pos)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
556 (delete-region (point) (progn (end-of-line) (point)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
557 (save-excursion
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
558 (insert "\n\nValue:")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
559 (set (make-local-variable 'help-button-cache)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
560 (point-marker)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
561 (insert "value is shown ")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
562 (insert-button "below"
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
563 'action help-button-cache
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
564 'follow-link t
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
565 'help-echo "mouse-2, RET: show value")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
566 (insert ".\n\n")))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
567
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
568 ;; Mention if it's an alias
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
569 (let* ((alias (condition-case nil
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
570 (indirect-variable variable)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
571 (error variable)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
572 (obsolete (get variable 'byte-obsolete-variable))
|
70283
fe86bf681435
* help-fns.el (describe-variable): Add info about safe local variables.
Dan Nicolaescu <dann@ics.uci.edu>
diff
changeset
|
573 (safe-var (get variable 'safe-local-variable))
|
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
574 (doc (or (documentation-property variable 'variable-documentation)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
575 (documentation-property alias 'variable-documentation))))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
576 (unless (eq alias variable)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
577 (princ (format "\nThis variable is an alias for `%s'.\n" alias)))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
578 (when obsolete
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
579 (princ "\nThis variable is obsolete")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
580 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete))))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
581 (princ ";") (terpri)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
582 (princ (if (stringp (car obsolete)) (car obsolete)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
583 (format "use `%s' instead." (car obsolete))))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
584 (terpri))
|
70588
|
585 (when safe-var
|
70589
|
586 (princ "This variable is safe as a file local variable ")
|
70588
|
587 (princ "if its value\nsatisfies the predicate ")
|
|
588 (princ (if (byte-code-function-p safe-var)
|
|
589 "which is byte-compiled expression.\n"
|
|
590 (format "`%s'.\n" safe-var)))
|
70283
fe86bf681435
* help-fns.el (describe-variable): Add info about safe local variables.
Dan Nicolaescu <dann@ics.uci.edu>
diff
changeset
|
591 (terpri))
|
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
592 (princ "Documentation:\n")
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
593 (princ (or doc "Not documented as a variable.")))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
594 ;; Make a link to customize if this variable can be customized.
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
595 (if (custom-variable-p variable)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
596 (let ((customize-label "customize"))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
597 (terpri)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
598 (terpri)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
599 (princ (concat "You can " customize-label " this variable."))
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
600 (with-current-buffer standard-output
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
601 (save-excursion
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
602 (re-search-backward
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
603 (concat "\\(" customize-label "\\)") nil t)
|
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
604 (help-xref-button 1 'help-customize-variable variable)))))
|
42591
|
605 (print-help-return-message)
|
|
606 (save-excursion
|
|
607 (set-buffer standard-output)
|
|
608 ;; Return the text we displayed.
|
|
609 (buffer-string))))))))
|
41583
|
610
|
|
611
|
|
612 ;;;###autoload
|
|
613 (defun describe-syntax (&optional buffer)
|
|
614 "Describe the syntax specifications in the syntax table of BUFFER.
|
|
615 The descriptions are inserted in a help buffer, which is then displayed.
|
|
616 BUFFER defaults to the current buffer."
|
|
617 (interactive)
|
|
618 (setq buffer (or buffer (current-buffer)))
|
|
619 (help-setup-xref (list #'describe-syntax buffer) (interactive-p))
|
|
620 (with-output-to-temp-buffer (help-buffer)
|
|
621 (let ((table (with-current-buffer buffer (syntax-table))))
|
|
622 (with-current-buffer standard-output
|
|
623 (describe-vector table 'internal-describe-syntax-value)
|
|
624 (while (setq table (char-table-parent table))
|
|
625 (insert "\nThe parent syntax table is:")
|
|
626 (describe-vector table 'internal-describe-syntax-value))))))
|
|
627
|
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
628 (defun help-describe-category-set (value)
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
629 (insert (cond
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
630 ((null value) "default")
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
631 ((char-table-p value) "deeper char-table ...")
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
632 (t (condition-case err
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
633 (category-set-mnemonics value)
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
634 (error "invalid"))))))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
635
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
636 ;;;###autoload
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
637 (defun describe-categories (&optional buffer)
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
638 "Describe the category specifications in the current category table.
|
54092
|
639 The descriptions are inserted in a buffer, which is then displayed.
|
|
640 If BUFFER is non-nil, then describe BUFFER's category table instead.
|
|
641 BUFFER should be a buffer or a buffer name."
|
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
642 (interactive)
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
643 (setq buffer (or buffer (current-buffer)))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
644 (help-setup-xref (list #'describe-categories buffer) (interactive-p))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
645 (with-output-to-temp-buffer (help-buffer)
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
646 (let ((table (with-current-buffer buffer (category-table))))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
647 (with-current-buffer standard-output
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
648 (describe-vector table 'help-describe-category-set)
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
649 (let ((docs (char-table-extra-slot table 0)))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
650 (if (or (not (vectorp docs)) (/= (length docs) 95))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
651 (insert "Invalid first extra slot in this char table\n")
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
652 (insert "Meanings of mnemonic characters are:\n")
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
653 (dotimes (i 95)
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
654 (let ((elt (aref docs i)))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
655 (when elt
|
65494
|
656 (insert (+ i ?\s) ": " elt "\n"))))
|
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
657 (while (setq table (char-table-parent table))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
658 (insert "\nThe parent category table is:")
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
659 (describe-vector table 'help-describe-category-set))))))))
|
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
660
|
41584
|
661 (provide 'help-fns)
|
41583
|
662
|
64304
|
663 ;; arch-tag: 9e10331c-ae81-4d13-965d-c4819aaab0b3
|
41584
|
664 ;;; help-fns.el ends here
|