Mercurial > emacs
annotate lisp/help-fns.el @ 98083:78f10c77413c
(Fcall_process): Canonicalize current directory name.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Sun, 07 Sep 2008 19:10:28 +0000 |
parents | 904041a08605 |
children | 6e27d74c7d56 |
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, |
79721 | 4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93573
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
41583
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 |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93573
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93573
diff
changeset
|
14 ;; (at your option) any later version. |
41583
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 |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93573
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
23 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
24 ;;; Commentary: |
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 ;; 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
|
27 ;; 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
|
28 ;; `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
|
29 ;; 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
|
30 ;; 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
|
31 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
32 ;;; Code: |
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 (require 'help-mode) |
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 ;; Functions |
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 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
39 (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
|
40 "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
|
41 (interactive |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
42 (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
|
43 (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
|
44 val) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
45 (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
|
46 (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
|
47 "Describe function: ") |
68402
e1e34f1d35e3
(describe-function): Don't pass `nil' as default.
Richard M. Stallman <rms@gnu.org>
parents:
68158
diff
changeset
|
48 obarray 'fboundp t nil nil |
e1e34f1d35e3
(describe-function): Don't pass `nil' as default.
Richard M. Stallman <rms@gnu.org>
parents:
68158
diff
changeset
|
49 (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
|
50 (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
|
51 fn (intern val))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
52 (if (null function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
53 (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
|
54 (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
|
55 (save-excursion |
86012
494608f8dd24
(describe-function, describe-variable)
Martin Rudalics <rudalics@gmx.at>
parents:
85464
diff
changeset
|
56 (with-help-window (help-buffer) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
57 (prin1 function) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
58 ;; 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
|
59 ;; 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
|
60 (princ " is ") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
61 (describe-function-1 function) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
62 (with-current-buffer standard-output |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
63 ;; Return the text we displayed. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
64 (buffer-string)))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
65 |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
66 (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
|
67 "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
|
68 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
|
69 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
|
70 ;; 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
|
71 ;; 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
|
72 ;; 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
|
73 ;; 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
|
74 (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
|
75 (cons (format "(%s%s" |
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
76 ;; 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
|
77 (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
|
78 (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
|
79 (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
|
80 |
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 (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
|
82 "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
|
83 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
|
84 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
|
85 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
|
86 (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
|
87 (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
|
88 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
|
89 (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
|
90 (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
|
91 (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
|
92 "\n\n") |
50799
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
93 (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
|
94 (string-match "\\`([^ ]+\\(.*\\))\\'" arglist)) |
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
95 (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
|
96 (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
|
97 |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
98 (defun help-function-arglist (def) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
99 ;; Handle symbols aliased to other symbols. |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
100 (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
|
101 ;; 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
|
102 (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
|
103 (cond |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
104 ((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
|
105 ((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
|
106 ((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
|
107 "[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
|
108 (t t))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
109 |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
110 (defun help-make-usage (function arglist) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
111 (cons (if (symbolp function) function 'anonymous) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
112 (mapcar (lambda (arg) |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
113 (if (not (symbolp arg)) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
114 (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
|
115 ;; 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
|
116 (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
|
117 (cdr arg)) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
118 arg) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
119 (let ((name (symbol-name arg))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
120 (if (string-match "\\`&" name) arg |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
121 (intern (upcase name)))))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
122 arglist))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
123 |
64304
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
124 ;; 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
|
125 ;; (defun help-C-file-name (subr-or-var kind) |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
126 ;; "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
|
127 ;; 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
|
128 ;; (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
|
129 ;; (subr-name subr-or-var)) |
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
130 ;; (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
|
131 ;;;###autoload |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
132 (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
|
133 "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
|
134 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
|
135 (let ((docbuf (get-buffer-create " *DOC*")) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
136 (name (if (eq 'var kind) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
137 (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
|
138 (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
|
139 (with-current-buffer docbuf |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
140 (goto-char (point-min)) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
141 (if (eobp) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
142 (insert-file-contents-literally |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
143 (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
|
144 (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
|
145 (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
|
146 (let ((pnt (search-forward (concat "" name "\n")))) |
59410
ae92bd0348cd
Whitespace/comment change.
Richard M. Stallman <rms@gnu.org>
parents:
59368
diff
changeset
|
147 (re-search-backward "S\\(.*\\)") |
ae92bd0348cd
Whitespace/comment change.
Richard M. Stallman <rms@gnu.org>
parents:
59368
diff
changeset
|
148 (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
|
149 (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
|
150 (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
|
151 (goto-char pnt)))))))) |
97060
a5fc76bb12d1
apply patch from Seiji Zenitani to find doc strings in ns*.m files
Adrian Robert <Adrian.B.Robert@gmail.com>
parents:
95601
diff
changeset
|
152 (if (string-match "^ns.*\\(\\.o\\|obj\\)\\'" file) |
a5fc76bb12d1
apply patch from Seiji Zenitani to find doc strings in ns*.m files
Adrian Robert <Adrian.B.Robert@gmail.com>
parents:
95601
diff
changeset
|
153 (setq file (replace-match ".m" t t file 1)) |
a5fc76bb12d1
apply patch from Seiji Zenitani to find doc strings in ns*.m files
Adrian Robert <Adrian.B.Robert@gmail.com>
parents:
95601
diff
changeset
|
154 (if (string-match "\\.\\(o\\|obj\\)\\'" file) |
a5fc76bb12d1
apply patch from Seiji Zenitani to find doc strings in ns*.m files
Adrian Robert <Adrian.B.Robert@gmail.com>
parents:
95601
diff
changeset
|
155 (setq file (replace-match ".c" t t file)))) |
a5fc76bb12d1
apply patch from Seiji Zenitani to find doc strings in ns*.m files
Adrian Robert <Adrian.B.Robert@gmail.com>
parents:
95601
diff
changeset
|
156 (if (string-match "\\.\\(c\\|m\\)\\'" file) |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
157 (concat "src/" file) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
158 file))))) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
159 |
55958
519edd453780
(help-argument-name): Inherit from italic face only if the frame
Juanma Barranquero <lekktu@gmail.com>
parents:
55946
diff
changeset
|
160 (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
|
161 "Face to highlight argument names in *Help* buffers." |
039192c37cca
(help-argument-name): Add :group 'help.
Juri Linkov <juri@jurta.org>
parents:
55916
diff
changeset
|
162 :group 'help) |
55909
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
163 |
55564
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
parents:
55537
diff
changeset
|
164 (defun help-default-arg-highlight (arg) |
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
parents:
55537
diff
changeset
|
165 "Default function to highlight arguments in *Help* buffers. |
55909
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
166 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
|
167 downcased if it displays differently than the default |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
168 face (according to `face-differs-from-default-p')." |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
169 (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
|
170 (downcase arg) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
171 arg) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
172 'face 'help-argument-name)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
173 |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
174 (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
|
175 (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
|
176 (modify-syntax-entry ?\- "w") |
65494
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
177 (dolist (arg args doc) |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
178 (setq doc (replace-regexp-in-string |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
179 ;; This is heuristic, but covers all common cases |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
180 ;; except ARG1-ARG2 |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
181 (concat "\\<" ; beginning of word |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
182 "\\(?:[a-z-]*-\\)?" ; for xxx-ARG |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
183 "\\(" |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
184 (regexp-quote arg) |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
185 "\\)" |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
186 "\\(?:es\\|s\\|th\\)?" ; for ARGth, ARGs |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
187 "\\(?:-[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
|
188 "\\(?:-[{([<`\"].*?\\)?"; for ARG-{x}, (x), <x>, [x], `x' |
65494
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
189 "\\>") ; end of word |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
190 (help-default-arg-highlight arg) |
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
191 doc t t 1))))) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
192 |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
193 (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
|
194 (when usage |
55454
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
195 (with-temp-buffer |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
196 (insert usage) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
197 (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
|
198 (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
|
199 (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
|
200 (opt nil)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
201 ;; 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
|
202 (skip-chars-forward "^ ") |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
203 (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
|
204 (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
|
205 (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
|
206 (setq next nil) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
207 (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
|
208 (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
|
209 ;; 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
|
210 ;; so let's skip over it |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
211 (search-backward "(") |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
212 (goto-char (scan-sexps (point) 1))))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
213 ;; Highlight aguments in the USAGE string |
55457
f263b4b25c9e
(help-highlight-arguments): Fix braino.
Juanma Barranquero <lekktu@gmail.com>
parents:
55454
diff
changeset
|
214 (setq usage (help-do-arg-highlight (buffer-string) args)) |
f263b4b25c9e
(help-highlight-arguments): Fix braino.
Juanma Barranquero <lekktu@gmail.com>
parents:
55454
diff
changeset
|
215 ;; Highlight arguments in the DOC string |
55479
50b878285992
(help-argument-name): Default to italic.
Juanma Barranquero <lekktu@gmail.com>
parents:
55457
diff
changeset
|
216 (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
|
217 ;; 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
|
218 (cons usage doc)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
219 |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
220 ;; The following function was compiled from the former functions |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
221 ;; `describe-simplify-lib-file-name' and `find-source-lisp-file' with |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
222 ;; some excerpts from `describe-function-1' and `describe-variable'. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
223 ;; The only additional twists provided are (1) locate the defining file |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
224 ;; for autoloaded functions, and (2) give preference to files in the |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
225 ;; "install directory" (directories found via `load-path') rather than |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
226 ;; to files in the "compile directory" (directories found by searching |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
227 ;; the loaddefs.el file). We autoload it because it's also used by |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
228 ;; `describe-face' (instead of `describe-simplify-lib-file-name'). |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
229 |
66580
35ee6fbeca84
(describe-simplify-lib-file-name): Add autoload cookie.
Romain Francoise <romain@orebokech.com>
parents:
66523
diff
changeset
|
230 ;;;###autoload |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
231 (defun find-lisp-object-file-name (object type) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
232 "Guess the file that defined the Lisp object OBJECT, of type TYPE. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
233 OBJECT should be a symbol associated with a function, variable, or face; |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
234 alternatively, it can be a function definition. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
235 If TYPE is `variable', search for a variable definition. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
236 If TYPE is `face', search for a face definition. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
237 If TYPE is the value returned by `symbol-function' for a function symbol, |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
238 search for a function definition. |
66350
65603aeca64d
(describe-simplify-lib-file-name): New function.
Richard M. Stallman <rms@gnu.org>
parents:
65494
diff
changeset
|
239 |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
240 The return value is the absolute name of a readable file where OBJECT is |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
241 defined. If several such files exist, preference is given to a file |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
242 found via `load-path'. The return value can also be `C-source', which |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
243 means that OBJECT is a function or variable defined in C. If no |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
244 suitable file is found, return nil." |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
245 (let* ((autoloaded (eq (car-safe type) 'autoload)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
246 (file-name (or (and autoloaded (nth 1 type)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
247 (symbol-file |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
248 object (if (memq type (list 'defvar 'defface)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
249 type |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
250 'defun))))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
251 (cond |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
252 (autoloaded |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
253 ;; An autoloaded function: Locate the file since `symbol-function' |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
254 ;; has only returned a bare string here. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
255 (setq file-name |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
256 (locate-file file-name load-path '(".el" ".elc") 'readable))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
257 ((and (stringp file-name) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
258 (string-match "[.]*loaddefs.el\\'" file-name)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
259 ;; An autoloaded variable or face. Visit loaddefs.el in a buffer |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
260 ;; and try to extract the defining file. The following form is |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
261 ;; from `describe-function-1' and `describe-variable'. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
262 (let ((location |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
263 (condition-case nil |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
264 (find-function-search-for-symbol object nil file-name) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
265 (error nil)))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
266 (when location |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
267 (with-current-buffer (car location) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
268 (goto-char (cdr location)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
269 (when (re-search-backward |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
270 "^;;; Generated autoloads from \\(.*\\)" nil t) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
271 (setq file-name |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
272 (locate-file |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
273 (match-string-no-properties 1) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
274 load-path nil 'readable)))))))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
275 |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
276 (cond |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
277 ((and (not file-name) (subrp type)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
278 ;; A built-in function. The form is from `describe-function-1'. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
279 (if (get-buffer " *DOC*") |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
280 (help-C-file-name type 'subr) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
281 'C-source)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
282 ((and (not file-name) (symbolp object) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
283 (integerp (get object 'variable-documentation))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
284 ;; A variable defined in C. The form is from `describe-variable'. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
285 (if (get-buffer " *DOC*") |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
286 (help-C-file-name object 'var) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
287 'C-source)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
288 ((not (stringp file-name)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
289 ;; If we don't have a file-name string by now, we lost. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
290 nil) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
291 ((let ((lib-name |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
292 (if (string-match "[.]elc\\'" file-name) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
293 (substring-no-properties file-name 0 -1) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
294 file-name))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
295 ;; When the Elisp source file can be found in the install |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
296 ;; directory return the name of that file - `file-name' should |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
297 ;; have become an absolute file name ny now. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
298 (and (file-readable-p lib-name) lib-name))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
299 ((let* ((lib-name (file-name-nondirectory file-name)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
300 ;; The next form is from `describe-simplify-lib-file-name'. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
301 (file-name |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
302 ;; Try converting the absolute file name to a library |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
303 ;; name, convert that back to a file name and see if we |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
304 ;; get the original one. If so, they are equivalent. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
305 (if (equal file-name (locate-file lib-name load-path '(""))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
306 (if (string-match "[.]elc\\'" lib-name) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
307 (substring-no-properties lib-name 0 -1) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
308 lib-name) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
309 file-name)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
310 ;; The next three forms are from `find-source-lisp-file'. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
311 (elc-file (locate-file |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
312 (concat file-name |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
313 (if (string-match "\\.el\\'" file-name) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
314 "c" |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
315 ".elc")) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
316 load-path nil 'readable)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
317 (str (when elc-file |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
318 (with-temp-buffer |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
319 (insert-file-contents-literally elc-file nil 0 256) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
320 (buffer-string)))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
321 (src-file (and str |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
322 (string-match ";;; from file \\(.*\\.el\\)" str) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
323 (match-string 1 str)))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
324 (and src-file (file-readable-p src-file) src-file)))))) |
81039
fc951d52295d
(find-source-lisp-file): New function.
Jan Djärv <jan.h.d@swipnet.se>
parents:
75384
diff
changeset
|
325 |
87109
c5028f32763a
Remove directory part from filenames in function declarations.
Glenn Morris <rgm@gnu.org>
parents:
86265
diff
changeset
|
326 (declare-function ad-get-advice-info "advice" (function)) |
86265
22dc0bc9daf8
* frame.el (msdos-mouse-p):
Dan Nicolaescu <dann@ics.uci.edu>
parents:
86012
diff
changeset
|
327 |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
328 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
329 (defun describe-function-1 (function) |
87131
12a53ee55069
(describe-function-1): Call ad-get-advice-info only on symbols.
Richard M. Stallman <rms@gnu.org>
parents:
87109
diff
changeset
|
330 (let* ((advised (and (symbolp function) (featurep 'advice) |
12a53ee55069
(describe-function-1): Call ad-get-advice-info only on symbols.
Richard M. Stallman <rms@gnu.org>
parents:
87109
diff
changeset
|
331 (ad-get-advice-info function))) |
85429
f11bfc50b5be
(describe-function-1): Don't use the advice origname
Richard M. Stallman <rms@gnu.org>
parents:
85314
diff
changeset
|
332 ;; If the function is advised, use the symbol that has the |
f11bfc50b5be
(describe-function-1): Don't use the advice origname
Richard M. Stallman <rms@gnu.org>
parents:
85314
diff
changeset
|
333 ;; real definition, if that symbol is already set up. |
85303
6830ce7af289
(describe-function-1): Find source of advised functions.
Richard M. Stallman <rms@gnu.org>
parents:
85140
diff
changeset
|
334 (real-function |
85429
f11bfc50b5be
(describe-function-1): Don't use the advice origname
Richard M. Stallman <rms@gnu.org>
parents:
85314
diff
changeset
|
335 (or (and advised |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
336 (let ((origname (cdr (assq 'origname advised)))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
337 (and (fboundp origname) origname))) |
85430 | 338 function)) |
85303
6830ce7af289
(describe-function-1): Find source of advised functions.
Richard M. Stallman <rms@gnu.org>
parents:
85140
diff
changeset
|
339 ;; Get the real definition. |
6830ce7af289
(describe-function-1): Find source of advised functions.
Richard M. Stallman <rms@gnu.org>
parents:
85140
diff
changeset
|
340 (def (if (symbolp real-function) |
6830ce7af289
(describe-function-1): Find source of advised functions.
Richard M. Stallman <rms@gnu.org>
parents:
85140
diff
changeset
|
341 (symbol-function real-function) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
342 function)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
343 file-name string |
91795
bfe257ff864c
2008-02-11 Drew Adams <drew.adams@oracle.com>
Bastien Guerry <bzg@altern.org>
parents:
87649
diff
changeset
|
344 (beg (if (commandp def) "an interactive " "a ")) |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
345 (pt1 (with-current-buffer (help-buffer) (point))) |
97865
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
346 errtype) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
347 (setq string |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
348 (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
|
349 (vectorp def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
350 "a keyboard macro") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
351 ((subrp def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
352 (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
|
353 (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
|
354 (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
|
355 ((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
|
356 (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
|
357 ((symbolp def) |
97865
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
358 (while (and (fboundp def) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
359 (symbolp (symbol-function def))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
360 (setq def (symbol-function def))) |
97865
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
361 ;; Handle (defalias 'foo 'bar), where bar is undefined. |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
362 (or (fboundp def) (setq errtype 'alias)) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
363 (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
|
364 ((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
|
365 (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
|
366 ((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
|
367 "a Lisp macro") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
368 ((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
|
369 (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
|
370 (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
|
371 (if (eq (nth 4 def) 'keymap) "keymap" |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
372 (if (nth 4 def) "Lisp macro" "Lisp function")))) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
373 ((keymapp def) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
374 (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
|
375 (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
|
376 (while elts |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
377 (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
|
378 (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
|
379 elts nil)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
380 (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
|
381 (if is-full |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
382 "a full keymap" |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
383 "a sparse keymap"))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
384 (t ""))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
385 (princ string) |
97865
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
386 (if (eq errtype 'alias) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
387 (princ ",\nwhich is not defined. Please make a bug report.") |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
388 (with-current-buffer standard-output |
97865
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
389 (save-excursion |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
390 (save-match-data |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
391 (when (re-search-backward "alias for `\\([^`']+\\)'" nil t) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
392 (help-xref-button 1 'help-function def))))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
393 |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
394 (setq file-name (find-lisp-object-file-name function def)) |
97865
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
395 (when file-name |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
396 (princ " in `") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
397 ;; We used to add .el to the file name, |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
398 ;; but that's completely wrong when the user used load-file. |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
399 (princ (if (eq file-name 'C-source) "C source code" file-name)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
400 (princ "'") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
401 ;; Make a hyperlink to the library. |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
402 (with-current-buffer standard-output |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
403 (save-excursion |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
404 (re-search-backward "`\\([^`']+\\)'" nil t) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
405 (help-xref-button 1 'help-function-def real-function file-name)))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
406 (princ ".") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
407 (with-current-buffer (help-buffer) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
408 (fill-region-as-paragraph (save-excursion (goto-char pt1) (forward-line 0) (point)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
409 (point))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
410 (terpri)(terpri) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
411 (when (commandp function) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
412 (let ((pt2 (with-current-buffer (help-buffer) (point)))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
413 (if (and (eq function 'self-insert-command) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
414 (eq (key-binding "a") 'self-insert-command) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
415 (eq (key-binding "b") 'self-insert-command) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
416 (eq (key-binding "c") 'self-insert-command)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
417 (princ "It is bound to many ordinary text characters.\n") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
418 (let* ((remapped (command-remapping function)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
419 (keys (where-is-internal |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
420 (or remapped function) overriding-local-map nil nil)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
421 non-modified-keys) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
422 ;; Which non-control non-meta keys run this command? |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
423 (dolist (key keys) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
424 (if (member (event-modifiers (aref key 0)) '(nil (shift))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
425 (push key non-modified-keys))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
426 (when remapped |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
427 (princ "It is remapped to `") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
428 (princ (symbol-name remapped)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
429 (princ "'")) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
430 |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
431 (when keys |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
432 (princ (if remapped ", which is bound to " "It is bound to ")) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
433 ;; If lots of ordinary text characters run this command, |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
434 ;; don't mention them one by one. |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
435 (if (< (length non-modified-keys) 10) |
73391
d636f1f6f544
(describe-function-1): Special case optimization for self-insert-command.
Richard M. Stallman <rms@gnu.org>
parents:
71849
diff
changeset
|
436 (princ (mapconcat 'key-description keys ", ")) |
97865
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
437 (dolist (key non-modified-keys) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
438 (setq keys (delq key keys))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
439 (if keys |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
440 (progn |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
441 (princ (mapconcat 'key-description keys ", ")) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
442 (princ ", and many ordinary text characters")) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
443 (princ "many ordinary text characters")))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
444 (when (or remapped keys non-modified-keys) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
445 (princ ".") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
446 (terpri)))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
447 (with-current-buffer (help-buffer) (fill-region-as-paragraph pt2 (point))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
448 (terpri))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
449 (let* ((arglist (help-function-arglist def)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
450 (doc (documentation function)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
451 (usage (help-split-fundoc doc function))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
452 (with-current-buffer standard-output |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
453 ;; If definition is a keymap, skip arglist note. |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
454 (unless (keymapp function) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
455 (let* ((use (cond |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
456 (usage (setq doc (cdr usage)) (car usage)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
457 ((listp arglist) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
458 (format "%S" (help-make-usage function arglist))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
459 ((stringp arglist) arglist) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
460 ;; Maybe the arglist is in the docstring of a symbol |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
461 ;; this one is aliased to. |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
462 ((let ((fun real-function)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
463 (while (and (symbolp fun) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
464 (setq fun (symbol-function fun)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
465 (not (setq usage (help-split-fundoc |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
466 (documentation fun) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
467 function))))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
468 usage) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
469 (car usage)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
470 ((or (stringp def) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
471 (vectorp def)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
472 (format "\nMacro: %s" (format-kbd-macro def))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
473 (t "[Missing arglist. Please make a bug report.]"))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
474 (high (help-highlight-arguments use doc))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
475 (let ((fill-begin (point))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
476 (insert (car high) "\n") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
477 (fill-region fill-begin (point))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
478 (setq doc (cdr high)))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
479 (let* ((obsolete (and |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
480 ;; function might be a lambda construct. |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
481 (symbolp function) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
482 (get function 'byte-obsolete-info))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
483 (use (car obsolete))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
484 (when obsolete |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
485 (princ "\nThis function is obsolete") |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
486 (when (nth 2 obsolete) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
487 (insert (format " since %s" (nth 2 obsolete)))) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
488 (insert (cond ((stringp use) (concat ";\n" use)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
489 (use (format ";\nuse `%s' instead." use)) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
490 (t ".")) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
491 "\n")) |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
492 (insert "\n" |
52bbade97925
(describe-function-1): Handle broken aliases. (Bug#825)
Glenn Morris <rgm@gnu.org>
parents:
97060
diff
changeset
|
493 (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
|
494 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
495 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
496 ;; Variables |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
497 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
498 ;;;###autoload |
59368
658501d06a20
(variable-at-point): New arg ANY-SYMBOL.
Richard M. Stallman <rms@gnu.org>
parents:
59125
diff
changeset
|
499 (defun variable-at-point (&optional any-symbol) |
74514
c8981abb2053
(variable-at-point): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
73550
diff
changeset
|
500 "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
|
501 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
|
502 If ANY-SYMBOL is non-nil, don't insist the symbol be bound." |
95601
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
503 (with-syntax-table emacs-lisp-mode-syntax-table |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
504 (or (condition-case () |
56884
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
505 (save-excursion |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
506 (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
|
507 (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
|
508 (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
|
509 (forward-sexp -1)) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
510 (skip-chars-forward "'") |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
511 (let ((obj (read (current-buffer)))) |
95601
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
512 (and (symbolp obj) (boundp obj) obj))) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
513 (error nil)) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
514 (let* ((str (find-tag-default)) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
515 (sym (if str (intern-soft str)))) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
516 (if (and sym (or any-symbol (boundp sym))) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
517 sym |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
518 (save-match-data |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
519 (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str)) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
520 (setq sym (intern-soft (match-string 1 str))) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
521 (and (or any-symbol (boundp sym)) sym))))) |
0f9baaf9427f
* help.el (function-called-at-point):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
95444
diff
changeset
|
522 0))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
523 |
85464
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
524 (defun describe-variable-custom-version-info (variable) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
525 (let ((custom-version (get variable 'custom-version)) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
526 (cpv (get variable 'custom-package-version)) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
527 (output nil)) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
528 (if custom-version |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
529 (setq output |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
530 (format "This variable was introduced, or its default value was changed, in\nversion %s of Emacs.\n" |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
531 custom-version)) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
532 (when cpv |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
533 (let* ((package (car-safe cpv)) |
95444
f4d291b9de49
(describe-variable-custom-version-info): Handle dotted
John Paul Wallington <jpw@pobox.com>
parents:
94678
diff
changeset
|
534 (version (if (listp (cdr-safe cpv)) |
f4d291b9de49
(describe-variable-custom-version-info): Handle dotted
John Paul Wallington <jpw@pobox.com>
parents:
94678
diff
changeset
|
535 (car (cdr-safe cpv)) |
f4d291b9de49
(describe-variable-custom-version-info): Handle dotted
John Paul Wallington <jpw@pobox.com>
parents:
94678
diff
changeset
|
536 (cdr-safe cpv))) |
85464
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
537 (pkg-versions (assq package customize-package-emacs-version-alist)) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
538 (emacsv (cdr (assoc version pkg-versions)))) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
539 (if (and package version) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
540 (setq output |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
541 (format (concat "This variable was introduced, or its default value was changed, in\nversion %s of the %s package" |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
542 (if emacsv |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
543 (format " that is part of Emacs %s" emacsv)) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
544 ".\n") |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
545 version package)))))) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
546 output)) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
547 |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
548 ;;;###autoload |
83293
aa4ff0258607
Fix describe-variable with frame-local variables.
Karoly Lorentey <lorentey@elte.hu>
parents:
59909
diff
changeset
|
549 (defun describe-variable (variable &optional buffer frame) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
550 "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
|
551 Returns the documentation as a string, also. |
83293
aa4ff0258607
Fix describe-variable with frame-local variables.
Karoly Lorentey <lorentey@elte.hu>
parents:
59909
diff
changeset
|
552 If VARIABLE has a buffer-local value in BUFFER or FRAME |
aa4ff0258607
Fix describe-variable with frame-local variables.
Karoly Lorentey <lorentey@elte.hu>
parents:
59909
diff
changeset
|
553 \(default to the current buffer and current frame), |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
554 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
|
555 (interactive |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
556 (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
|
557 (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
|
558 val) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
559 (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
|
560 (format |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
561 "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
|
562 "Describe variable: ") |
66793
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
563 obarray |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
564 '(lambda (vv) |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
565 (or (boundp vv) |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
566 (get vv 'variable-documentation))) |
c086dd3d5f44
2005-11-10 Alan Mackenzie <acm@muc.de>
Alan Mackenzie <acm@muc.de>
parents:
66580
diff
changeset
|
567 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
|
568 (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
|
569 (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
|
570 v (intern val))))) |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
571 (let (file-name) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
572 (unless (buffer-live-p buffer) (setq buffer (current-buffer))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
573 (unless (frame-live-p frame) (setq frame (selected-frame))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
574 (if (not (symbolp variable)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
575 (message "You did not specify a variable") |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
576 (save-excursion |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
577 (let ((valvoid (not (with-current-buffer buffer (boundp variable)))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
578 val val-start-pos locus) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
579 ;; Extract the value before setting up the output buffer, |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
580 ;; in case `buffer' *is* the output buffer. |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
581 (unless valvoid |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
582 (with-selected-frame frame |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
583 (with-current-buffer buffer |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
584 (setq val (symbol-value variable) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
585 locus (variable-binding-locus variable))))) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
586 (help-setup-xref (list #'describe-variable variable buffer) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
587 (interactive-p)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
588 (with-help-window (help-buffer) |
83293
aa4ff0258607
Fix describe-variable with frame-local variables.
Karoly Lorentey <lorentey@elte.hu>
parents:
59909
diff
changeset
|
589 (with-current-buffer buffer |
97916
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
590 (prin1 variable) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
591 (setq file-name (find-lisp-object-file-name variable 'defvar)) |
904041a08605
(describe-simplify-lib-file-name, find-source-lisp-file): Removed.
Martin Rudalics <rudalics@gmx.at>
parents:
97865
diff
changeset
|
592 |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
593 (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
|
594 (progn |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
595 (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
|
596 (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
|
597 (princ "'.\n") |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
598 (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
|
599 (save-excursion |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
600 (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
|
601 (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
|
602 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
|
603 (if valvoid |
68153
27e860fd29ef
(describe-variable): Remove newlines from void variable output.
John Paul Wallington <jpw@pobox.com>
parents:
67222
diff
changeset
|
604 (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
|
605 (princ "Its "))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
606 (if valvoid |
68153
27e860fd29ef
(describe-variable): Remove newlines from void variable output.
John Paul Wallington <jpw@pobox.com>
parents:
67222
diff
changeset
|
607 (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
|
608 (princ "'s ")))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
609 (if valvoid |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
610 nil |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
611 (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
|
612 (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
|
613 (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
|
614 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
615 (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
|
616 (pp val) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
617 ;; 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
|
618 ;; 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
|
619 ;; (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
|
620 (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
|
621 (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
|
622 (terpri) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
623 |
83380
94f174e5569d
Merged from miles@gnu.org--gnu-2005 (patch 543)
Karoly Lorentey <lorentey@elte.hu>
diff
changeset
|
624 (when locus |
94f174e5569d
Merged from miles@gnu.org--gnu-2005 (patch 543)
Karoly Lorentey <lorentey@elte.hu>
diff
changeset
|
625 (if (bufferp locus) |
94f174e5569d
Merged from miles@gnu.org--gnu-2005 (patch 543)
Karoly Lorentey <lorentey@elte.hu>
diff
changeset
|
626 (princ (format "%socal in buffer %s; " |
94f174e5569d
Merged from miles@gnu.org--gnu-2005 (patch 543)
Karoly Lorentey <lorentey@elte.hu>
diff
changeset
|
627 (if (get variable 'permanent-local) |
94f174e5569d
Merged from miles@gnu.org--gnu-2005 (patch 543)
Karoly Lorentey <lorentey@elte.hu>
diff
changeset
|
628 "Permanently l" "L") |
94f174e5569d
Merged from miles@gnu.org--gnu-2005 (patch 543)
Karoly Lorentey <lorentey@elte.hu>
diff
changeset
|
629 (buffer-name))) |
94f174e5569d
Merged from miles@gnu.org--gnu-2005 (patch 543)
Karoly Lorentey <lorentey@elte.hu>
diff
changeset
|
630 (princ (format "It is a frame-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
|
631 (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
|
632 (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
|
633 (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
|
634 (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
|
635 (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
|
636 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
637 ;; 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
|
638 ;; 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
|
639 ;; 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
|
640 ;; 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
|
641 (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
|
642 (pp val) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
643 ;; 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
|
644 ;; (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
|
645 (if (< (point) (+ from 20)) |
85140
caa57db87d2a
(describe-variable): Add missing " " for multiline
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
85103
diff
changeset
|
646 (delete-region (1- from) from)))))) |
caa57db87d2a
(describe-variable): Add missing " " for multiline
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
85103
diff
changeset
|
647 (terpri)) |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
648 |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
649 ;; 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
|
650 (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
|
651 (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
|
652 ;; 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
|
653 ;; 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
|
654 ;; 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
|
655 (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
|
656 (goto-char val-start-pos) |
75384
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
657 ;; The line below previously read as |
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
658 ;; (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
|
659 ;; 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
|
660 ;; large values. |
0906bcead2e0
(describe-variable): Don't suppress display of
Martin Rudalics <rudalics@gmx.at>
parents:
75347
diff
changeset
|
661 (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
|
662 (save-excursion |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
663 (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
|
664 (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
|
665 (point-marker))) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
666 (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
|
667 (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
|
668 '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
|
669 '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
|
670 '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
|
671 (insert ".\n"))) |
85103
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
672 (terpri) |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
673 |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
674 (let* ((alias (condition-case nil |
92211
a1afa11e3c51
(describe-variable): Add phrases about initialization file with and
Robert J. Chassell <bob@rattlesnake.com>
parents:
91795
diff
changeset
|
675 (indirect-variable variable) |
a1afa11e3c51
(describe-variable): Add phrases about initialization file with and
Robert J. Chassell <bob@rattlesnake.com>
parents:
91795
diff
changeset
|
676 (error variable))) |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
677 (obsolete (get variable 'byte-obsolete-variable)) |
93247
5fc9c77f2aea
(describe-function-1, describe-variable): If CURRENT-NAME is nil,
Juanma Barranquero <lekktu@gmail.com>
parents:
93215
diff
changeset
|
678 (use (car obsolete)) |
70283
fe86bf681435
* help-fns.el (describe-variable): Add info about safe local variables.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
68994
diff
changeset
|
679 (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
|
680 (doc (or (documentation-property variable 'variable-documentation) |
85103
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
681 (documentation-property alias 'variable-documentation))) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
682 (extra-line nil)) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
683 ;; Add a note for variables that have been make-var-buffer-local. |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
684 (when (and (local-variable-if-set-p variable) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
685 (or (not (local-variable-p variable)) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
686 (with-temp-buffer |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
687 (local-variable-if-set-p variable)))) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
688 (setq extra-line t) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
689 (princ " Automatically becomes buffer-local when set in any fashion.\n")) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
690 |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
691 ;; Mention if it's an alias |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
692 (unless (eq alias variable) |
85103
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
693 (setq extra-line t) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
694 (princ (format " This 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
|
695 |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
696 (when obsolete |
85103
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
697 (setq extra-line t) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
698 (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
|
699 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete)))) |
93247
5fc9c77f2aea
(describe-function-1, describe-variable): If CURRENT-NAME is nil,
Juanma Barranquero <lekktu@gmail.com>
parents:
93215
diff
changeset
|
700 (princ (cond ((stringp use) (concat ";\n " use)) |
5fc9c77f2aea
(describe-function-1, describe-variable): If CURRENT-NAME is nil,
Juanma Barranquero <lekktu@gmail.com>
parents:
93215
diff
changeset
|
701 (use (format ";\n use `%s' instead." (car obsolete))) |
5fc9c77f2aea
(describe-function-1, describe-variable): If CURRENT-NAME is nil,
Juanma Barranquero <lekktu@gmail.com>
parents:
93215
diff
changeset
|
702 (t "."))) |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
703 (terpri)) |
70588
8a6fc6278754
(describe-variable): Don't print safe-var if it is
Reiner Steib <Reiner.Steib@gmx.de>
parents:
70283
diff
changeset
|
704 (when safe-var |
85103
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
705 (setq extra-line t) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
706 (princ " This variable is safe as a file local variable ") |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
707 (princ "if its value\n satisfies the predicate ") |
70588
8a6fc6278754
(describe-variable): Don't print safe-var if it is
Reiner Steib <Reiner.Steib@gmx.de>
parents:
70283
diff
changeset
|
708 (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
|
709 "which is byte-compiled expression.\n" |
74700
e262a8360a6a
(describe-variable): Improve blank separator lines.
Richard M. Stallman <rms@gnu.org>
parents:
74514
diff
changeset
|
710 (format "`%s'.\n" safe-var)))) |
85103
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
711 |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
712 (if extra-line (terpri)) |
ee30e57a2bd8
(describe-variable): Slightly change the layout of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84338
diff
changeset
|
713 (princ "Documentation:\n") |
84338
0ecc849c7f5c
Johan Bockg? <bojohan at dd.chalmers.se>
Glenn Morris <rgm@gnu.org>
parents:
83648
diff
changeset
|
714 (with-current-buffer standard-output |
0ecc849c7f5c
Johan Bockg? <bojohan at dd.chalmers.se>
Glenn Morris <rgm@gnu.org>
parents:
83648
diff
changeset
|
715 (insert (or doc "Not documented as a variable.")))) |
92211
a1afa11e3c51
(describe-variable): Add phrases about initialization file with and
Robert J. Chassell <bob@rattlesnake.com>
parents:
91795
diff
changeset
|
716 |
93573
553dfbccecfa
(describe-variable): Undo 2008-02-25 change.
Chong Yidong <cyd@stupidchicken.com>
parents:
93247
diff
changeset
|
717 ;; Make a link to customize if this variable can be customized. |
553dfbccecfa
(describe-variable): Undo 2008-02-25 change.
Chong Yidong <cyd@stupidchicken.com>
parents:
93247
diff
changeset
|
718 (when (custom-variable-p variable) |
553dfbccecfa
(describe-variable): Undo 2008-02-25 change.
Chong Yidong <cyd@stupidchicken.com>
parents:
93247
diff
changeset
|
719 (let ((customize-label "customize")) |
85464
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
720 (terpri) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
721 (terpri) |
93573
553dfbccecfa
(describe-variable): Undo 2008-02-25 change.
Chong Yidong <cyd@stupidchicken.com>
parents:
93247
diff
changeset
|
722 (princ (concat "You can " customize-label " this variable.")) |
85464
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
723 (with-current-buffer standard-output |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
724 (save-excursion |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
725 (re-search-backward |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
726 (concat "\\(" customize-label "\\)") nil t) |
93573
553dfbccecfa
(describe-variable): Undo 2008-02-25 change.
Chong Yidong <cyd@stupidchicken.com>
parents:
93247
diff
changeset
|
727 (help-xref-button 1 'help-customize-variable variable)))) |
85464
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
728 ;; Note variable's version or package version |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
729 (let ((output (describe-variable-custom-version-info variable))) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
730 (when output |
65470
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
731 (terpri) |
a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
732 (terpri) |
85464
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
733 (princ output)))) |
b8519672d451
(describe-variable-custom-version-info): New function to return
John Paul Wallington <jpw@pobox.com>
parents:
85430
diff
changeset
|
734 |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
735 (save-excursion |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
736 (set-buffer standard-output) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
737 ;; Return the text we displayed. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
738 (buffer-string)))))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
739 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
740 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
741 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
742 (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
|
743 "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
|
744 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
|
745 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
|
746 (interactive) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
747 (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
|
748 (help-setup-xref (list #'describe-syntax buffer) (interactive-p)) |
86012
494608f8dd24
(describe-function, describe-variable)
Martin Rudalics <rudalics@gmx.at>
parents:
85464
diff
changeset
|
749 (with-help-window (help-buffer) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
750 (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
|
751 (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
|
752 (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
|
753 (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
|
754 (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
|
755 (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
|
756 |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
757 (defun help-describe-category-set (value) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
758 (insert (cond |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
759 ((null value) "default") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
760 ((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
|
761 (t (condition-case err |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
762 (category-set-mnemonics value) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
763 (error "invalid")))))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
764 |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
765 ;;;###autoload |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
766 (defun describe-categories (&optional buffer) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
767 "Describe the category specifications in the current category table. |
54092
bce4d57a18d7
(describe-categories): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
768 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
|
769 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
|
770 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
|
771 (interactive) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
772 (setq buffer (or buffer (current-buffer))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
773 (help-setup-xref (list #'describe-categories buffer) (interactive-p)) |
86012
494608f8dd24
(describe-function, describe-variable)
Martin Rudalics <rudalics@gmx.at>
parents:
85464
diff
changeset
|
774 (with-help-window (help-buffer) |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
775 (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
|
776 (with-current-buffer standard-output |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
777 (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
|
778 (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
|
779 (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
|
780 (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
|
781 (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
|
782 (dotimes (i 95) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
783 (let ((elt (aref docs i))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
784 (when elt |
65494
e444511e983e
(describe-categories): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents:
65470
diff
changeset
|
785 (insert (+ i ?\s) ": " elt "\n")))) |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
786 (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
|
787 (insert "\nThe parent category table is:") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
788 (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
|
789 |
41584
8b64dc23e305
Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents:
41583
diff
changeset
|
790 (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
|
791 |
64304
4ca52e899ec6
Fix up commenting style.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
64091
diff
changeset
|
792 ;; 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
|
793 ;;; help-fns.el ends here |