Mercurial > emacs
annotate lisp/help-fns.el @ 76878:e4d2810db0e9
wording matters
author | Karl Berry <karl@gnu.org> |
---|---|
date | Sun, 01 Apr 2007 18:11:15 +0000 |
parents | 0906bcead2e0 |
children | 9355f9b7bbff fc951d52295d b8d9a391daf3 95d0cdf160ea |
rev | line source |
---|---|
41584
8b64dc23e305
Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents:
41583
diff
changeset
|
1 ;;; help-fns.el --- Complex help functions |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
2 |
64762
41bb365f41c4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64304
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, |
75347 | 4 ;; 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
5 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
6 ;; Maintainer: FSF |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
7 ;; Keywords: help, internal |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
8 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
9 ;; This file is part of GNU Emacs. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
10 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
11 ;; GNU Emacs is free software; you can redistribute it and/or modify |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
12 ;; it under the terms of the GNU General Public License as published by |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
13 ;; the Free Software Foundation; either version 2, or (at your option) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
14 ;; any later version. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
15 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
16 ;; GNU Emacs is distributed in the hope that it will be useful, |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
19 ;; GNU General Public License for more details. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
20 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
21 ;; You should have received a copy of the GNU General Public License |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
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
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
25 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
26 ;;; Commentary: |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
27 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
28 ;; This file contains those help commands which are complicated, and |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
29 ;; which may not be used in every session. For example |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
30 ;; `describe-function' will probably be heavily used when doing elisp |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
31 ;; programming, but not if just editing C files. Simpler help commands |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
32 ;; are in help.el |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
33 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
34 ;;; Code: |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
35 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
36 (require 'help-mode) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
37 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
38 ;; Functions |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
39 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
40 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
41 (defun describe-function (function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
42 "Display the full documentation of FUNCTION (a symbol)." |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
43 (interactive |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
44 (let ((fn (function-called-at-point)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
45 (enable-recursive-minibuffers t) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
46 val) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
47 (setq val (completing-read (if fn |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
48 (format "Describe function (default %s): " fn) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
49 "Describe function: ") |
68402
e1e34f1d35e3
(describe-function): Don't pass `nil' as default.
Richard M. Stallman <rms@gnu.org>
parents:
68158
diff
changeset
|
50 obarray 'fboundp t nil nil |
e1e34f1d35e3
(describe-function): Don't pass `nil' as default.
Richard M. Stallman <rms@gnu.org>
parents:
68158
diff
changeset
|
51 (and fn (symbol-name fn)))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
52 (list (if (equal val "") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
53 fn (intern val))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
54 (if (null function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
55 (message "You didn't specify a function") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
56 (help-setup-xref (list #'describe-function function) (interactive-p)) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
57 (save-excursion |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
58 (with-output-to-temp-buffer (help-buffer) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
59 (prin1 function) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
60 ;; Use " is " instead of a colon so that |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
61 ;; it is easier to get out the function name using forward-sexp. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
62 (princ " is ") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
63 (describe-function-1 function) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
64 (print-help-return-message) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
65 (with-current-buffer standard-output |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
66 ;; Return the text we displayed. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
67 (buffer-string)))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
68 |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
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>
parents:
55479
diff
changeset
|
70 "Split a function DOCSTRING into the actual doc and the usage info. |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
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>
parents:
55479
diff
changeset
|
72 DEF is the function whose usage we're looking for in DOCSTRING." |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
73 ;; Functions can get the calling sequence at the end of the doc string. |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
74 ;; In cases where `function' has been fset to a subr we can't search for |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
75 ;; function's name in the doc string so we use `fn' as the anonymous |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
76 ;; function name instead. |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
77 (when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring)) |
47663
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
78 (cons (format "(%s%s" |
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
79 ;; Replace `fn' with the actual function name. |
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
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>
parents:
55479
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>
parents:
55479
diff
changeset
|
82 (substring docstring 0 (match-beginning 0))))) |
47663
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
83 |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
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>
parents:
55479
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>
parents:
55479
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>
parents:
55479
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>
parents:
55479
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>
parents:
55479
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>
parents:
55479
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>
parents:
55479
diff
changeset
|
91 docstring |
55723
813de71608a6
(help-add-fundoc-usage): Use %S only for output of `help-make-usage'.
Juanma Barranquero <lekktu@gmail.com>
parents:
55564
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>
parents:
55479
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>
parents:
49757
diff
changeset
|
94 (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "") |
47663
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
95 "\n\n") |
50799
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
96 (if (and (stringp arglist) |
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
97 (string-match "\\`([^ ]+\\(.*\\))\\'" arglist)) |
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
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>
parents:
55564
diff
changeset
|
99 (format "%S" (help-make-usage 'fn arglist)))))) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
100 |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
101 (defun help-function-arglist (def) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
102 ;; Handle symbols aliased to other symbols. |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
103 (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def))) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
104 ;; If definition is a macro, find the function inside it. |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
105 (if (eq (car-safe def) 'macro) (setq def (cdr def))) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
106 (cond |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
107 ((byte-code-function-p def) (aref def 0)) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
108 ((eq (car-safe def) 'lambda) (nth 1 def)) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
109 ((and (eq (car-safe def) 'autoload) (not (eq (nth 4 def) 'keymap))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
110 "[Arg list not available until function definition is loaded.]") |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
111 (t t))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
112 |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
113 (defun help-make-usage (function arglist) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
114 (cons (if (symbolp function) function 'anonymous) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
115 (mapcar (lambda (arg) |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
116 (if (not (symbolp arg)) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
117 (if (and (consp arg) (symbolp (car arg))) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
118 ;; CL style default values for optional args. |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
119 (cons (intern (upcase (symbol-name (car arg)))) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
120 (cdr arg)) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
121 arg) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
122 (let ((name (symbol-name arg))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
123 (if (string-match "\\`&" name) arg |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
124 (intern (upcase name)))))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
125 arglist))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
126 |
64304
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
127 ;; Could be this, if we make symbol-file do the work below. |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
128 ;; (defun help-C-file-name (subr-or-var kind) |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
129 ;; "Return the name of the C file where SUBR-OR-VAR is defined. |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
130 ;; KIND should be `var' for a variable or `subr' for a subroutine." |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
131 ;; (symbol-file (if (symbolp subr-or-var) subr-or-var |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
132 ;; (subr-name subr-or-var)) |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
133 ;; (if (eq kind 'var) 'defvar 'defun))) |
62908
af6dffb5d180
* emacs-lisp/find-func.el (find-function-noselect): Handle
Masatake YAMATO <jet@gyve.org>
parents:
62499
diff
changeset
|
134 ;;;###autoload |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
135 (defun help-C-file-name (subr-or-var kind) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
136 "Return the name of the C file where SUBR-OR-VAR is defined. |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
137 KIND should be `var' for a variable or `subr' for a subroutine." |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
138 (let ((docbuf (get-buffer-create " *DOC*")) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
139 (name (if (eq 'var kind) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
140 (concat "V" (symbol-name subr-or-var)) |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
141 (concat "F" (subr-name subr-or-var))))) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
142 (with-current-buffer docbuf |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
143 (goto-char (point-min)) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
144 (if (eobp) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
145 (insert-file-contents-literally |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
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>
parents:
57794
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>
parents:
57794
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>
parents:
57794
diff
changeset
|
149 (let ((pnt (search-forward (concat "" name "\n")))) |
59410
ae92bd0348cd
Whitespace/comment change.
Richard M. Stallman <rms@gnu.org>
parents:
59368
diff
changeset
|
150 (re-search-backward "S\\(.*\\)") |
ae92bd0348cd
Whitespace/comment change.
Richard M. Stallman <rms@gnu.org>
parents:
59368
diff
changeset
|
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>
parents:
57794
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>
parents:
57794
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>
parents:
57794
diff
changeset
|
154 (goto-char pnt)))))))) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
155 (if (string-match "\\.\\(o\\|obj\\)\\'" file) |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
156 (setq file (replace-match ".c" t t file))) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
157 (if (string-match "\\.c\\'" file) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
158 (concat "src/" file) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
159 file))))) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
160 |
55958
519edd453780
(help-argument-name): Inherit from italic face only if the frame
Juanma Barranquero <lekktu@gmail.com>
parents:
55946
diff
changeset
|
161 (defface help-argument-name '((((supports :slant italic)) :inherit italic)) |
55946
039192c37cca
(help-argument-name): Add :group 'help.
Juri Linkov <juri@jurta.org>
parents:
55916
diff
changeset
|
162 "Face to highlight argument names in *Help* buffers." |
039192c37cca
(help-argument-name): Add :group 'help.
Juri Linkov <juri@jurta.org>
parents:
55916
diff
changeset
|
163 :group 'help) |
55909
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
164 |
55564
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
parents:
55537
diff
changeset
|
165 (defun help-default-arg-highlight (arg) |
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
parents:
55537
diff
changeset
|
166 "Default function to highlight arguments in *Help* buffers. |
55909
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
167 It returns ARG in face `help-argument-name'; ARG is also |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
168 downcased if it displays differently than the default |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
169 face (according to `face-differs-from-default-p')." |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
170 (propertize (if (face-differs-from-default-p 'help-argument-name) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
171 (downcase arg) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
172 arg) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
173 'face 'help-argument-name)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
174 |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
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>
parents:
55381
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>
parents:
55381
diff
changeset
|
177 (modify-syntax-entry ?\- "w") |
65494
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
178 (dolist (arg args doc) |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
179 (setq doc (replace-regexp-in-string |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
180 ;; This is heuristic, but covers all common cases |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
181 ;; except ARG1-ARG2 |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
182 (concat "\\<" ; beginning of word |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
183 "\\(?:[a-z-]*-\\)?" ; for xxx-ARG |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
184 "\\(" |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
185 (regexp-quote arg) |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
186 "\\)" |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
187 "\\(?:es\\|s\\|th\\)?" ; for ARGth, ARGs |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
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>
parents:
68402
diff
changeset
|
189 "\\(?:-[{([<`\"].*?\\)?"; for ARG-{x}, (x), <x>, [x], `x' |
65494
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
190 "\\>") ; end of word |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
191 (help-default-arg-highlight arg) |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
192 doc t t 1))))) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
193 |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
194 (defun help-highlight-arguments (usage doc &rest args) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
195 (when usage |
55454
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
196 (with-temp-buffer |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
197 (insert usage) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
198 (goto-char (point-min)) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
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>
parents:
55426
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>
parents:
55426
diff
changeset
|
201 (opt nil)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
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>
parents:
55564
diff
changeset
|
203 (skip-chars-forward "^ ") |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
204 (while next |
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
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>
parents:
55426
diff
changeset
|
206 (if (not (re-search-forward " \\([\\[(]*\\)\\([^] &)\.]+\\)" nil t)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
207 (setq next nil) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
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>
parents:
55381
diff
changeset
|
209 (when (and opt (string= (match-string 1) "(")) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
210 ;; A pesky CL-style optional argument with default value, |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
211 ;; so let's skip over it |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
212 (search-backward "(") |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
213 (goto-char (scan-sexps (point) 1))))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
214 ;; Highlight aguments in the USAGE string |
55457
f263b4b25c9e
(help-highlight-arguments): Fix braino.
Juanma Barranquero <lekktu@gmail.com>
parents:
55454
diff
changeset
|
215 (setq usage (help-do-arg-highlight (buffer-string) args)) |
f263b4b25c9e
(help-highlight-arguments): Fix braino.
Juanma Barranquero <lekktu@gmail.com>
parents:
55454
diff
changeset
|
216 ;; Highlight arguments in the DOC string |
55479
50b878285992
(help-argument-name): Default to italic.
Juanma Barranquero <lekktu@gmail.com>
parents:
55457
diff
changeset
|
217 (setq doc (and doc (help-do-arg-highlight doc args)))))) |
50b878285992
(help-argument-name): Default to italic.
Juanma Barranquero <lekktu@gmail.com>
parents:
55457
diff
changeset
|
218 ;; Return value is like the one from help-split-fundoc, but highlighted |
50b878285992
(help-argument-name): Default to italic.
Juanma Barranquero <lekktu@gmail.com>
parents:
55457
diff
changeset
|
219 (cons usage doc)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
220 |
66580
35ee6fbeca84
(describe-simplify-lib-file-name): Add autoload cookie.
Romain Francoise <romain@orebokech.com>
parents:
66523
diff
changeset
|
221 ;;;###autoload |
66350
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
222 (defun describe-simplify-lib-file-name (file) |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
223 "Simplify a library name FILE to a relative name, and make it a source file." |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
224 (if file |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
225 ;; Try converting the absolute file name to a library name. |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
226 (let ((libname (file-name-nondirectory file))) |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
227 ;; Now convert that back to a file name and see if we get |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
228 ;; the original one. If so, they are equivalent. |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
229 (if (equal file (locate-file libname load-path '(""))) |
66523
7ca34a6ac6c6
(describe-simplify-lib-file-name): Fix regexp.
Romain Francoise <romain@orebokech.com>
parents:
66508
diff
changeset
|
230 (if (string-match "[.]elc\\'" libname) |
66350
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
231 (substring libname 0 -1) |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
232 libname) |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
233 file)))) |
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
234 |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
235 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
236 (defun describe-function-1 (function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
237 (let* ((def (if (symbolp function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
238 (symbol-function function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
239 function)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
240 file-name string |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
241 (beg (if (commandp def) "an interactive " "a "))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
242 (setq string |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
243 (cond ((or (stringp def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
244 (vectorp def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
245 "a keyboard macro") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
246 ((subrp def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
247 (if (eq 'unevalled (cdr (subr-arity def))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
248 (concat beg "special form") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
249 (concat beg "built-in function"))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
250 ((byte-code-function-p def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
251 (concat beg "compiled Lisp function")) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
252 ((symbolp def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
253 (while (symbolp (symbol-function def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
254 (setq def (symbol-function def))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
255 (format "an alias for `%s'" def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
256 ((eq (car-safe def) 'lambda) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
257 (concat beg "Lisp function")) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
258 ((eq (car-safe def) 'macro) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
259 "a Lisp macro") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
260 ((eq (car-safe def) 'autoload) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
261 (setq file-name (nth 1 def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
262 (format "%s autoloaded %s" |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
263 (if (commandp def) "an interactive" "an") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
264 (if (eq (nth 4 def) 'keymap) "keymap" |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
265 (if (nth 4 def) "Lisp macro" "Lisp function")) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
266 )) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
267 ((keymapp def) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
268 (let ((is-full nil) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
269 (elts (cdr-safe def))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
270 (while elts |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
271 (if (char-table-p (car-safe elts)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
272 (setq is-full t |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
273 elts nil)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
274 (setq elts (cdr-safe elts))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
275 (if is-full |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
276 "a full keymap" |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
277 "a sparse keymap"))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
278 (t ""))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
279 (princ string) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
280 (with-current-buffer standard-output |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
281 (save-excursion |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
282 (save-match-data |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
283 (if (re-search-backward "alias for `\\([^`']+\\)'" nil t) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
284 (help-xref-button 1 'help-function def))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
285 (or file-name |
59125
32d2da4da4de
(describe-function-1): Call symbol-file with `defun'.
Richard M. Stallman <rms@gnu.org>
parents:
59019
diff
changeset
|
286 (setq file-name (symbol-file function 'defun))) |
66350
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
diff
changeset
|
292 (condition-case nil |
45975
7ea38f55545b
(describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45193
diff
changeset
|
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
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>
parents:
44291
diff
changeset
|
300 (setq file-name (match-string 1))))))) |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
301 (when (and (null file-name) (subrp def)) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
302 ;; Find the C source file name. |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
303 (setq file-name (if (get-buffer " *DOC*") |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
304 (help-C-file-name def 'subr) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
305 'C-source))) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
306 (when file-name |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
307 (princ " in `") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
308 ;; We used to add .el to the file name, |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
309 ;; but that's completely wrong when the user used load-file. |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
310 (princ (if (eq file-name 'C-source) "C source code" file-name)) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
311 (princ "'") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
312 ;; Make a hyperlink to the library. |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
313 (with-current-buffer standard-output |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
314 (save-excursion |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
315 (re-search-backward "`\\([^`']+\\)'" nil t) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
316 (help-xref-button 1 'help-function-def function file-name)))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
317 (princ ".") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
318 (terpri) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
319 (when (commandp function) |
73391
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
diff
changeset
|
326 (keys (where-is-internal |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
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>
parents:
71849
diff
changeset
|
328 non-modified-keys) |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
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>
parents:
71849
diff
changeset
|
330 (dolist (key keys) |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
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>
parents:
71849
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>
parents:
71849
diff
changeset
|
333 (when remapped |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
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>
parents:
71849
diff
changeset
|
335 (princ (symbol-name remapped)) |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
diff
changeset
|
336 (princ "'")) |
55009
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
337 |
73391
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
diff
changeset
|
338 (when keys |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
diff
changeset
|
346 (if keys |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
diff
changeset
|
347 (progn |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
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>
parents:
71849
diff
changeset
|
352 (princ ".") |
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
diff
changeset
|
353 (terpri))))) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
354 (let* ((arglist (help-function-arglist def)) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
355 (doc (documentation function)) |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
356 (usage (help-split-fundoc doc function))) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
357 (with-current-buffer standard-output |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
358 ;; If definition is a keymap, skip arglist note. |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
359 (unless (keymapp def) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
360 (let* ((use (cond |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
361 (usage (setq doc (cdr usage)) (car usage)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
362 ((listp arglist) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
363 (format "%S" (help-make-usage function arglist))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
364 ((stringp arglist) arglist) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
365 ;; Maybe the arglist is in the docstring of the alias. |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
366 ((let ((fun function)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
367 (while (and (symbolp fun) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
368 (setq fun (symbol-function fun)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
369 (not (setq usage (help-split-fundoc |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
370 (documentation fun) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
371 function))))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
372 usage) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
373 (car usage)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
374 ((or (stringp def) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
375 (vectorp def)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
376 (format "\nMacro: %s" (format-kbd-macro def))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
377 (t "[Missing arglist. Please make a bug report.]"))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
378 (high (help-highlight-arguments use doc))) |
67217
1731ed7a115f
(describe-function-1): Fill arglist.
John Paul Wallington <jpw@pobox.com>
parents:
66793
diff
changeset
|
379 (let ((fill-begin (point))) |
1731ed7a115f
(describe-function-1): Fill arglist.
John Paul Wallington <jpw@pobox.com>
parents:
66793
diff
changeset
|
380 (insert (car high) "\n") |
1731ed7a115f
(describe-function-1): Fill arglist.
John Paul Wallington <jpw@pobox.com>
parents:
66793
diff
changeset
|
381 (fill-region fill-begin (point))) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
382 (setq doc (cdr high)))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
383 (let ((obsolete (and |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
384 ;; function might be a lambda construct. |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
385 (symbolp function) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
386 (get function 'byte-obsolete-info)))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
387 (when obsolete |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
388 (princ "\nThis function is obsolete") |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
389 (when (nth 2 obsolete) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
390 (insert (format " since %s" (nth 2 obsolete)))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
391 (insert ";\n" |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
392 (if (stringp (car obsolete)) (car obsolete) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
393 (format "use `%s' instead." (car obsolete))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
394 "\n")) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
395 (insert "\n" |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
396 (or doc "Not documented."))))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
397 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
398 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
399 ;; Variables |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
400 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
401 ;;;###autoload |
59368
658501d06a20
(variable-at-point): New arg ANY-SYMBOL.
Richard M. Stallman <rms@gnu.org>
parents:
59125
diff
changeset
|
402 (defun variable-at-point (&optional any-symbol) |
74514
c8981abb2053
(variable-at-point): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
73550
diff
changeset
|
403 "Return the bound variable symbol found at or before point. |
59368
658501d06a20
(variable-at-point): New arg ANY-SYMBOL.
Richard M. Stallman <rms@gnu.org>
parents:
59125
diff
changeset
|
404 Return 0 if there is no such symbol. |
658501d06a20
(variable-at-point): New arg ANY-SYMBOL.
Richard M. Stallman <rms@gnu.org>
parents:
59125
diff
changeset
|
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>
parents:
55958
diff
changeset
|
406 (or (condition-case () |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
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>
parents:
55958
diff
changeset
|
408 (save-excursion |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
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>
parents:
55958
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>
parents:
55958
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>
parents:
55958
diff
changeset
|
412 (forward-sexp -1)) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
413 (skip-chars-forward "'") |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
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>
parents:
55958
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>
parents:
55958
diff
changeset
|
416 (error nil)) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
417 (let* ((str (find-tag-default)) |
58993
3a6978b560e9
* help-fns.el (variable-at-point):
Juri Linkov <juri@jurta.org>
parents:
58069
diff
changeset
|
418 (sym (if str (intern-soft str)))) |
59368
658501d06a20
(variable-at-point): New arg ANY-SYMBOL.
Richard M. Stallman <rms@gnu.org>
parents:
59125
diff
changeset
|
419 (if (and sym (or any-symbol (boundp sym))) |
58993
3a6978b560e9
* help-fns.el (variable-at-point):
Juri Linkov <juri@jurta.org>
parents:
58069
diff
changeset
|
420 sym |
3a6978b560e9
* help-fns.el (variable-at-point):
Juri Linkov <juri@jurta.org>
parents:
58069
diff
changeset
|
421 (save-match-data |
3a6978b560e9
* help-fns.el (variable-at-point):
Juri Linkov <juri@jurta.org>
parents:
58069
diff
changeset
|
422 (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str)) |
3a6978b560e9
* help-fns.el (variable-at-point):
Juri Linkov <juri@jurta.org>
parents:
58069
diff
changeset
|
423 (setq sym (intern-soft (match-string 1 str))) |
59368
658501d06a20
(variable-at-point): New arg ANY-SYMBOL.
Richard M. Stallman <rms@gnu.org>
parents:
59125
diff
changeset
|
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>
parents:
55958
diff
changeset
|
425 0)) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
426 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
427 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
428 (defun describe-variable (variable &optional buffer) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
429 "Display the full documentation of VARIABLE (a symbol). |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
430 Returns the documentation as a string, also. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
431 If VARIABLE has a buffer-local value in BUFFER (default to the current buffer), |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
432 it is displayed along with the global value." |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
433 (interactive |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
434 (let ((v (variable-at-point)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
435 (enable-recursive-minibuffers t) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
436 val) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
437 (setq val (completing-read (if (symbolp v) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
438 (format |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
439 "Describe variable (default %s): " v) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
440 "Describe variable: ") |
66793
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
441 obarray |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
442 '(lambda (vv) |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
443 (or (boundp vv) |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
444 (get vv 'variable-documentation))) |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
445 t nil nil |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
446 (if (symbolp v) (symbol-name v)))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
447 (list (if (equal val "") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
448 v (intern val))))) |
45975
7ea38f55545b
(describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45193
diff
changeset
|
449 (unless (buffer-live-p buffer) (setq buffer (current-buffer))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
450 (if (not (symbolp variable)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
451 (message "You did not specify a variable") |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
452 (save-excursion |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
453 (let* ((valvoid (not (with-current-buffer buffer (boundp variable)))) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
454 ;; Extract the value before setting up the output buffer, |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
457 val-start-pos) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
458 (help-setup-xref (list #'describe-variable variable buffer) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
459 (interactive-p)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
460 (with-output-to-temp-buffer (help-buffer) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
461 (with-current-buffer buffer |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
462 (prin1 variable) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
463 ;; Make a hyperlink to the library if appropriate. (Don't |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
464 ;; change the format of the buffer's initial line in case |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
465 ;; anything expects the current format.) |
59125
32d2da4da4de
(describe-function-1): Call symbol-file with `defun'.
Richard M. Stallman <rms@gnu.org>
parents:
59019
diff
changeset
|
466 (let ((file-name (symbol-file variable 'defvar))) |
66350
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
467 (setq file-name (describe-simplify-lib-file-name file-name)) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
468 (when (equal file-name "loaddefs.el") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
469 ;; Find the real def site of the preloaded variable. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
470 (let ((location |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
471 (condition-case nil |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
472 (find-variable-noselect variable file-name) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
473 (error nil)))) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
474 (when location |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
475 (with-current-buffer (car location) |
71849
2227a7e3b7eb
(describe-variable): Handle find-variable-noselect returning no position.
Richard M. Stallman <rms@gnu.org>
parents:
70589
diff
changeset
|
476 (when (cdr location) |
2227a7e3b7eb
(describe-variable): Handle find-variable-noselect returning no position.
Richard M. Stallman <rms@gnu.org>
parents:
70589
diff
changeset
|
477 (goto-char (cdr location))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
478 (when (re-search-backward |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
479 "^;;; Generated autoloads from \\(.*\\)" nil t) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
480 (setq file-name (match-string 1))))))) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
481 (when (and (null file-name) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
482 (integerp (get variable 'variable-documentation))) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
483 ;; It's a variable not defined in Elisp but in C. |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
484 (setq file-name |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
485 (if (get-buffer " *DOC*") |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
486 (help-C-file-name variable 'var) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
487 'C-source))) |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
488 (if file-name |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
489 (progn |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
492 (princ "'.\n") |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
diff
changeset
|
494 (save-excursion |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
497 variable file-name))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
498 (if valvoid |
68153
27e860fd29ef
(describe-variable): Remove newlines from void variable output.
John Paul Wallington <jpw@pobox.com>
parents:
67222
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>
parents:
64762
diff
changeset
|
500 (princ "Its "))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
501 (if valvoid |
68153
27e860fd29ef
(describe-variable): Remove newlines from void variable output.
John Paul Wallington <jpw@pobox.com>
parents:
67222
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>
parents:
64762
diff
changeset
|
503 (princ "'s ")))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
504 (if valvoid |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
505 nil |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
508 (princ "value is ") |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
509 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
510 (let ((from (point))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
511 (pp val) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
517 (terpri) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
518 |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
522 "Permanently l" "L") |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
523 (buffer-name))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
diff
changeset
|
525 (princ "globally void") |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
529 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
534 (let ((from (point))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
535 (pp val) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
543 (with-temp-buffer |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
546 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
547 |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
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>
parents:
64762
diff
changeset
|
553 ;; of a symbol. |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
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>
parents:
64762
diff
changeset
|
555 (goto-char val-start-pos) |
75384
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
556 ;; The line below previously read as |
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
557 ;; (delete-region (point) (progn (end-of-line) (point))) |
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
558 ;; which suppressed display of the buffer local value for |
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
559 ;; large values. |
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
560 (when (looking-at "value is") (replace-match "")) |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
561 (save-excursion |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
562 (insert "\n\nValue:") |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
563 (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>
parents:
64762
diff
changeset
|
564 (point-marker))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
565 (insert "value is shown ") |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
566 (insert-button "below" |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
567 'action help-button-cache |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
568 'follow-link t |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
569 'help-echo "mouse-2, RET: show value") |
75384
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
570 (insert ".\n"))) |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
571 |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
572 ;; Mention if it's an alias |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
573 (let* ((alias (condition-case nil |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
574 (indirect-variable variable) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
575 (error variable))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
576 (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>
parents:
68994
diff
changeset
|
577 (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>
parents:
64762
diff
changeset
|
578 (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>
parents:
64762
diff
changeset
|
579 (documentation-property alias 'variable-documentation)))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
580 (unless (eq alias variable) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
581 (princ (format "\nThis variable is an alias for `%s'.\n" alias))) |
74700
e262a8360a6a
(describe-variable): Improve blank separator lines.
Richard M. Stallman <rms@gnu.org>
parents:
74514
diff
changeset
|
582 (if (or obsolete safe-var) |
e262a8360a6a
(describe-variable): Improve blank separator lines.
Richard M. Stallman <rms@gnu.org>
parents:
74514
diff
changeset
|
583 (terpri)) |
e262a8360a6a
(describe-variable): Improve blank separator lines.
Richard M. Stallman <rms@gnu.org>
parents:
74514
diff
changeset
|
584 |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
585 (when obsolete |
74700
e262a8360a6a
(describe-variable): Improve blank separator lines.
Richard M. Stallman <rms@gnu.org>
parents:
74514
diff
changeset
|
586 (princ "This variable is obsolete") |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
587 (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>
parents:
64762
diff
changeset
|
588 (princ ";") (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
589 (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>
parents:
64762
diff
changeset
|
590 (format "use `%s' instead." (car obsolete)))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
591 (terpri)) |
70588
8a6fc6278754
(describe-variable): Don't print safe-var if it is
Reiner Steib <Reiner.Steib@gmx.de>
parents:
70283
diff
changeset
|
592 (when safe-var |
70589
d09c5cf66b5c
Remove bogus \n\n from last commit.
Reiner Steib <Reiner.Steib@gmx.de>
parents:
70588
diff
changeset
|
593 (princ "This variable is safe as a file local variable ") |
70588
8a6fc6278754
(describe-variable): Don't print safe-var if it is
Reiner Steib <Reiner.Steib@gmx.de>
parents:
70283
diff
changeset
|
594 (princ "if its value\nsatisfies the predicate ") |
8a6fc6278754
(describe-variable): Don't print safe-var if it is
Reiner Steib <Reiner.Steib@gmx.de>
parents:
70283
diff
changeset
|
595 (princ (if (byte-code-function-p safe-var) |
8a6fc6278754
(describe-variable): Don't print safe-var if it is
Reiner Steib <Reiner.Steib@gmx.de>
parents:
70283
diff
changeset
|
596 "which is byte-compiled expression.\n" |
74700
e262a8360a6a
(describe-variable): Improve blank separator lines.
Richard M. Stallman <rms@gnu.org>
parents:
74514
diff
changeset
|
597 (format "`%s'.\n" safe-var)))) |
e262a8360a6a
(describe-variable): Improve blank separator lines.
Richard M. Stallman <rms@gnu.org>
parents:
74514
diff
changeset
|
598 (princ "\nDocumentation:\n") |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
599 (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>
parents:
64762
diff
changeset
|
600 ;; 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>
parents:
64762
diff
changeset
|
601 (if (custom-variable-p variable) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
602 (let ((customize-label "customize")) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
603 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
604 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
605 (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>
parents:
64762
diff
changeset
|
606 (with-current-buffer standard-output |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
607 (save-excursion |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
608 (re-search-backward |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
609 (concat "\\(" customize-label "\\)") nil t) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
610 (help-xref-button 1 'help-customize-variable variable))))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
611 (print-help-return-message) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
612 (save-excursion |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
613 (set-buffer standard-output) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
614 ;; Return the text we displayed. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
615 (buffer-string)))))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
616 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
617 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
618 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
619 (defun describe-syntax (&optional buffer) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
620 "Describe the syntax specifications in the syntax table of BUFFER. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
621 The descriptions are inserted in a help buffer, which is then displayed. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
622 BUFFER defaults to the current buffer." |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
623 (interactive) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
624 (setq buffer (or buffer (current-buffer))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
625 (help-setup-xref (list #'describe-syntax buffer) (interactive-p)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
626 (with-output-to-temp-buffer (help-buffer) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
627 (let ((table (with-current-buffer buffer (syntax-table)))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
628 (with-current-buffer standard-output |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
629 (describe-vector table 'internal-describe-syntax-value) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
630 (while (setq table (char-table-parent table)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
631 (insert "\nThe parent syntax table is:") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
632 (describe-vector table 'internal-describe-syntax-value)))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
633 |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
634 (defun help-describe-category-set (value) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
635 (insert (cond |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
636 ((null value) "default") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
637 ((char-table-p value) "deeper char-table ...") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
638 (t (condition-case err |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
639 (category-set-mnemonics value) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
640 (error "invalid")))))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
641 |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
642 ;;;###autoload |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
643 (defun describe-categories (&optional buffer) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
644 "Describe the category specifications in the current category table. |
54092
bce4d57a18d7
(describe-categories): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
645 The descriptions are inserted in a buffer, which is then displayed. |
bce4d57a18d7
(describe-categories): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
646 If BUFFER is non-nil, then describe BUFFER's category table instead. |
bce4d57a18d7
(describe-categories): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
647 BUFFER should be a buffer or a buffer name." |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
648 (interactive) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
649 (setq buffer (or buffer (current-buffer))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
650 (help-setup-xref (list #'describe-categories buffer) (interactive-p)) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
651 (with-output-to-temp-buffer (help-buffer) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
652 (let ((table (with-current-buffer buffer (category-table)))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
653 (with-current-buffer standard-output |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
654 (describe-vector table 'help-describe-category-set) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
655 (let ((docs (char-table-extra-slot table 0))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
656 (if (or (not (vectorp docs)) (/= (length docs) 95)) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
657 (insert "Invalid first extra slot in this char table\n") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
658 (insert "Meanings of mnemonic characters are:\n") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
659 (dotimes (i 95) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
660 (let ((elt (aref docs i))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
661 (when elt |
65494
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
662 (insert (+ i ?\s) ": " elt "\n")))) |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
663 (while (setq table (char-table-parent table)) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
664 (insert "\nThe parent category table is:") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
665 (describe-vector table 'help-describe-category-set)))))))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
666 |
41584
8b64dc23e305
Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents:
41583
diff
changeset
|
667 (provide 'help-fns) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
668 |
64304
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
669 ;; arch-tag: 9e10331c-ae81-4d13-965d-c4819aaab0b3 |
41584
8b64dc23e305
Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents:
41583
diff
changeset
|
670 ;;; help-fns.el ends here |