Mercurial > emacs
annotate lisp/help-fns.el @ 110410:f2e111723c3a
Merge changes made in Gnus trunk.
Reimplement nnimap, and do tweaks to the rest of the code to support that.
* gnus-int.el (gnus-finish-retrieve-group-infos)
(gnus-retrieve-group-data-early): New functions.
* gnus-range.el (gnus-range-nconcat): New function.
* gnus-start.el (gnus-get-unread-articles): Support early retrieval of
data.
(gnus-read-active-for-groups): Support finishing the early retrieval of
data.
* gnus-sum.el (gnus-summary-move-article): Pass the move-to group name
if the move is internal, so that nnimap can do fast internal moves.
* gnus.el (gnus-article-special-mark-lists): Add uid/active tuples, for
nnimap usage.
* nnimap.el: Rewritten.
* nnmail.el (nnmail-inhibit-default-split-group): New internal variable
to allow the mail splitting to not return a default group. This is
useful for nnimap, which will leave unmatched mail in the inbox.
* utf7.el (utf7-encode): Autoload.
Implement shell connection.
* nnimap.el (nnimap-open-shell-stream): New function.
(nnimap-open-connection): Use it.
Get the number of lines by using BODYSTRUCTURE.
(nnimap-transform-headers): Get the number of lines in each message.
(nnimap-retrieve-headers): Query for BODYSTRUCTURE so that we get the
number of lines.
Not all servers return UIDNEXT. Work past this problem.
Remove junk from end of file.
Fix typo in "bogus" section.
Make capabilties be case-insensitive.
Require cl when compiling.
Don't bug out if the LIST command doesn't have any parameters.
2010-09-17 Knut Anders Hatlen <kahatlen@gmail.com> (tiny change)
* nnimap.el (nnimap-get-groups): Don't bug out if the LIST command
doesn't have any parameters.
(mm-text-html-renderer): Document gnus-article-html.
2010-09-17 Julien Danjou <julien@danjou.info> (tiny fix)
* mm-decode.el (mm-text-html-renderer): Document gnus-article-html.
* dgnushack.el: Define netrc-credentials.
If the user doesn't have a /etc/services, supply some sensible port defaults.
Have `unseen-or-unread' select an unread unseen article first.
(nntp-open-server): Return whether the open was successful or not.
Throughout all files, replace (save-excursion (set-buffer ...)) with (with-current-buffer ... ).
Save result so that it doesn't say "failed" all the time.
Add ~/.authinfo to the default, since that's probably most useful for users.
Don't use the "finish" method when we're reading from the agent.
Add some more nnimap-relevant agent stuff to nnagent.el.
* nnimap.el (nnimap-with-process-buffer): Removed.
Revert one line that was changed by mistake in the last checkin.
(nnimap-open-connection): Don't error out when we can't make a connection
nnimap-related changes to avoid bugging out if we can't contact a server.
* gnus-start.el (gnus-get-unread-articles): Don't try to scan groups
from methods that are denied.
* nnimap.el (nnimap-possibly-change-group): Return nil if we can't log
in.
(nnimap-finish-retrieve-group-infos): Make sure we're not waiting for
nothing.
* gnus-sum.el (gnus-select-newsgroup): Indent.
author | Katsumi Yamaoka <yamaoka@jpl.org> |
---|---|
date | Sat, 18 Sep 2010 10:02:19 +0000 |
parents | 280c8ae2476d |
children | 19f465048335 |
rev | line source |
---|---|
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
1 ;;; help-fns.el --- Complex help functions |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
2 |
104931
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002, |
106815 | 4 ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
104037
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
5 ;; Free Software Foundation, Inc. |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
6 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
7 ;; Maintainer: FSF |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
8 ;; Keywords: help, internal |
110015
280c8ae2476d
Add "Package:" file headers to denote built-in packages.
Chong Yidong <cyd@stupidchicken.com>
parents:
109342
diff
changeset
|
9 ;; Package: emacs |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
10 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
11 ;; This file is part of GNU Emacs. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
12 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
13 ;; GNU Emacs is free software: you can redistribute it and/or modify |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
14 ;; it under the terms of the GNU General Public License as published by |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
15 ;; the Free Software Foundation, either version 3 of the License, or |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
16 ;; (at your option) any later version. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
17 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
18 ;; GNU Emacs is distributed in the hope that it will be useful, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
21 ;; GNU General Public License for more details. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
22 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
23 ;; You should have received a copy of the GNU General Public License |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
25 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
26 ;;; Commentary: |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
27 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
28 ;; This file contains those help commands which are complicated, and |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
29 ;; which may not be used in every session. For example |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
30 ;; `describe-function' will probably be heavily used when doing elisp |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
31 ;; programming, but not if just editing C files. Simpler help commands |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
32 ;; are in help.el |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
33 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
34 ;;; Code: |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
35 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
36 ;; Functions |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
37 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
38 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
39 (defun describe-function (function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
40 "Display the full documentation of FUNCTION (a symbol)." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
41 (interactive |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
42 (let ((fn (function-called-at-point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
43 (enable-recursive-minibuffers t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
44 val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
45 (setq val (completing-read (if fn |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
46 (format "Describe function (default %s): " fn) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
47 "Describe function: ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
48 obarray 'fboundp t nil nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
49 (and fn (symbol-name fn)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
50 (list (if (equal val "") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
51 fn (intern val))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
52 (if (null function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
53 (message "You didn't specify a function") |
105372
bd2966850aac
Use `called-interactively-p' instead of `interactive-p'.
Juanma Barranquero <lekktu@gmail.com>
parents:
105363
diff
changeset
|
54 (help-setup-xref (list #'describe-function function) |
bd2966850aac
Use `called-interactively-p' instead of `interactive-p'.
Juanma Barranquero <lekktu@gmail.com>
parents:
105363
diff
changeset
|
55 (called-interactively-p 'interactive)) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
56 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
57 (with-help-window (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
58 (prin1 function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
59 ;; Use " is " instead of a colon so that |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
60 ;; it is easier to get out the function name using forward-sexp. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
61 (princ " is ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
62 (describe-function-1 function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
63 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
64 ;; Return the text we displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
65 (buffer-string)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
66 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
67 (defun help-split-fundoc (docstring def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
68 "Split a function DOCSTRING into the actual doc and the usage info. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
69 Return (USAGE . DOC) or nil if there's no usage info. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
70 DEF is the function whose usage we're looking for in DOCSTRING." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
71 ;; Functions can get the calling sequence at the end of the doc string. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
72 ;; In cases where `function' has been fset to a subr we can't search for |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
73 ;; function's name in the doc string so we use `fn' as the anonymous |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
74 ;; function name instead. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
75 (when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
76 (cons (format "(%s%s" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
77 ;; Replace `fn' with the actual function name. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
78 (if (consp def) "anonymous" def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
79 (match-string 1 docstring)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
80 (substring docstring 0 (match-beginning 0))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
81 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
82 (defun help-add-fundoc-usage (docstring arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
83 "Add the usage info to DOCSTRING. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
84 If DOCSTRING already has a usage info, then just return it unchanged. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
85 The usage info is built from ARGLIST. DOCSTRING can be nil. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
86 ARGLIST can also be t or a string of the form \"(FUN ARG1 ARG2 ...)\"." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
87 (unless (stringp docstring) (setq docstring "Not documented")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
88 (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring) (eq arglist t)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
89 docstring |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
90 (concat docstring |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
91 (if (string-match "\n?\n\\'" docstring) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
92 (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
93 "\n\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
94 (if (and (stringp arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
95 (string-match "\\`([^ ]+\\(.*\\))\\'" arglist)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
96 (concat "(fn" (match-string 1 arglist) ")") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
97 (format "%S" (help-make-usage 'fn arglist)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
98 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
99 (defun help-function-arglist (def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
100 ;; Handle symbols aliased to other symbols. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
101 (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
102 ;; If definition is a macro, find the function inside it. |
105386
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
103 (if (eq (car-safe def) 'macro) (setq def (cdr def))) |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
104 (cond |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
105 ((byte-code-function-p def) (aref def 0)) |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
106 ((eq (car-safe def) 'lambda) (nth 1 def)) |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
107 ((and (eq (car-safe def) 'autoload) (not (eq (nth 4 def) 'keymap))) |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
108 "[Arg list not available until function definition is loaded.]") |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
109 (t t))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
110 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
111 (defun help-make-usage (function arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
112 (cons (if (symbolp function) function 'anonymous) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
113 (mapcar (lambda (arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
114 (if (not (symbolp arg)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
115 (if (and (consp arg) (symbolp (car arg))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
116 ;; CL style default values for optional args. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
117 (cons (intern (upcase (symbol-name (car arg)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
118 (cdr arg)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
119 arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
120 (let ((name (symbol-name arg))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
121 (if (string-match "\\`&" name) arg |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
122 (intern (upcase name)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
123 arglist))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
124 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
125 ;; Could be this, if we make symbol-file do the work below. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
126 ;; (defun help-C-file-name (subr-or-var kind) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
127 ;; "Return the name of the C file where SUBR-OR-VAR is defined. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
128 ;; KIND should be `var' for a variable or `subr' for a subroutine." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
129 ;; (symbol-file (if (symbolp subr-or-var) subr-or-var |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
130 ;; (subr-name subr-or-var)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
131 ;; (if (eq kind 'var) 'defvar 'defun))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
132 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
133 (defun help-C-file-name (subr-or-var kind) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
134 "Return the name of the C file where SUBR-OR-VAR is defined. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
135 KIND should be `var' for a variable or `subr' for a subroutine." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
136 (let ((docbuf (get-buffer-create " *DOC*")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
137 (name (if (eq 'var kind) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
138 (concat "V" (symbol-name subr-or-var)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
139 (concat "F" (subr-name subr-or-var))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
140 (with-current-buffer docbuf |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
141 (goto-char (point-min)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
142 (if (eobp) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
143 (insert-file-contents-literally |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
144 (expand-file-name internal-doc-file-name doc-directory))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
145 (let ((file (catch 'loop |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
146 (while t |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
147 (let ((pnt (search-forward (concat "" name "\n")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
148 (re-search-backward "S\\(.*\\)") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
149 (let ((file (match-string 1))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
150 (if (member file build-files) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
151 (throw 'loop file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
152 (goto-char pnt)))))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
153 (if (string-match "^ns.*\\(\\.o\\|obj\\)\\'" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
154 (setq file (replace-match ".m" t t file 1)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
155 (if (string-match "\\.\\(o\\|obj\\)\\'" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
156 (setq file (replace-match ".c" t t file)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
157 (if (string-match "\\.\\(c\\|m\\)\\'" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
158 (concat "src/" file) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
159 file))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
160 |
105184
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
161 (defcustom help-downcase-arguments nil |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
162 "If non-nil, argument names in *Help* buffers are downcased." |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
163 :type 'boolean |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
164 :group 'help |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
165 :version "23.2") |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
166 |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
167 (defun help-highlight-arg (arg) |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
168 "Highlight ARG as an argument name for a *Help* buffer. |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
169 Return ARG in face `help-argument-name'; ARG is also downcased |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
170 if the variable `help-downcase-arguments' is non-nil." |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
171 (propertize (if help-downcase-arguments (downcase arg) arg) |
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
172 'face 'help-argument-name)) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
173 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
174 (defun help-do-arg-highlight (doc args) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
175 (with-syntax-table (make-syntax-table emacs-lisp-mode-syntax-table) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
176 (modify-syntax-entry ?\- "w") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
177 (dolist (arg args doc) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
178 (setq doc (replace-regexp-in-string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
179 ;; This is heuristic, but covers all common cases |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
180 ;; except ARG1-ARG2 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
181 (concat "\\<" ; beginning of word |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
182 "\\(?:[a-z-]*-\\)?" ; for xxx-ARG |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
183 "\\(" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
184 (regexp-quote arg) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
185 "\\)" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
186 "\\(?:es\\|s\\|th\\)?" ; for ARGth, ARGs |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
187 "\\(?:-[a-z0-9-]+\\)?" ; for ARG-xxx, ARG-n |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
188 "\\(?:-[{([<`\"].*?\\)?"; for ARG-{x}, (x), <x>, [x], `x' |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
189 "\\>") ; end of word |
105184
22328c89c071
* help-fns.el (help-downcase-arguments): New option, defaulting to nil.
Juanma Barranquero <lekktu@gmail.com>
parents:
105023
diff
changeset
|
190 (help-highlight-arg arg) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
191 doc t t 1))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
192 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
193 (defun help-highlight-arguments (usage doc &rest args) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
194 (when usage |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
195 (with-temp-buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
196 (insert usage) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
197 (goto-char (point-min)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
198 (let ((case-fold-search nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
199 (next (not (or args (looking-at "\\[")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
200 (opt nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
201 ;; Make a list of all arguments |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
202 (skip-chars-forward "^ ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
203 (while next |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
204 (or opt (not (looking-at " &")) (setq opt t)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
205 (if (not (re-search-forward " \\([\\[(]*\\)\\([^] &)\.]+\\)" nil t)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
206 (setq next nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
207 (setq args (cons (match-string 2) args)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
208 (when (and opt (string= (match-string 1) "(")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
209 ;; A pesky CL-style optional argument with default value, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
210 ;; so let's skip over it |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
211 (search-backward "(") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
212 (goto-char (scan-sexps (point) 1))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
213 ;; Highlight aguments in the USAGE string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
214 (setq usage (help-do-arg-highlight (buffer-string) args)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
215 ;; Highlight arguments in the DOC string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
216 (setq doc (and doc (help-do-arg-highlight doc args)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
217 ;; Return value is like the one from help-split-fundoc, but highlighted |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
218 (cons usage doc)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
219 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
220 ;; The following function was compiled from the former functions |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
221 ;; `describe-simplify-lib-file-name' and `find-source-lisp-file' with |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
222 ;; some excerpts from `describe-function-1' and `describe-variable'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
223 ;; The only additional twists provided are (1) locate the defining file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
224 ;; for autoloaded functions, and (2) give preference to files in the |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
225 ;; "install directory" (directories found via `load-path') rather than |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
226 ;; to files in the "compile directory" (directories found by searching |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
227 ;; the loaddefs.el file). We autoload it because it's also used by |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
228 ;; `describe-face' (instead of `describe-simplify-lib-file-name'). |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
229 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
230 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
231 (defun find-lisp-object-file-name (object type) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
232 "Guess the file that defined the Lisp object OBJECT, of type TYPE. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
233 OBJECT should be a symbol associated with a function, variable, or face; |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
234 alternatively, it can be a function definition. |
109342
4980a77d04a6
* help-fns.el (find-lisp-object-file-name): Doc fix (bug#6494).
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
235 If TYPE is `defvar', search for a variable definition. |
4980a77d04a6
* help-fns.el (find-lisp-object-file-name): Doc fix (bug#6494).
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
236 If TYPE is `defface', search for a face definition. |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
237 If TYPE is the value returned by `symbol-function' for a function symbol, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
238 search for a function definition. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
239 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
240 The return value is the absolute name of a readable file where OBJECT is |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
241 defined. If several such files exist, preference is given to a file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
242 found via `load-path'. The return value can also be `C-source', which |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
243 means that OBJECT is a function or variable defined in C. If no |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
244 suitable file is found, return nil." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
245 (let* ((autoloaded (eq (car-safe type) 'autoload)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
246 (file-name (or (and autoloaded (nth 1 type)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
247 (symbol-file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
248 object (if (memq type (list 'defvar 'defface)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
249 type |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
250 'defun))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
251 (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
252 (autoloaded |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
253 ;; An autoloaded function: Locate the file since `symbol-function' |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
254 ;; has only returned a bare string here. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
255 (setq file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
256 (locate-file file-name load-path '(".el" ".elc") 'readable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
257 ((and (stringp file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
258 (string-match "[.]*loaddefs.el\\'" file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
259 ;; An autoloaded variable or face. Visit loaddefs.el in a buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
260 ;; and try to extract the defining file. The following form is |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
261 ;; from `describe-function-1' and `describe-variable'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
262 (let ((location |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
263 (condition-case nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
264 (find-function-search-for-symbol object nil file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
265 (error nil)))) |
102309
ee7d5d4ca6e7
(find-lisp-object-file-name): Need a buffer position, not just a
Glenn Morris <rgm@gnu.org>
parents:
100908
diff
changeset
|
266 (when (cdr location) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
267 (with-current-buffer (car location) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
268 (goto-char (cdr location)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
269 (when (re-search-backward |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
270 "^;;; Generated autoloads from \\(.*\\)" nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
271 (setq file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
272 (locate-file |
105023
e0d5fc8f7387
(find-lisp-object-file-name): When looking for autoloaded
Glenn Morris <rgm@gnu.org>
parents:
104931
diff
changeset
|
273 (file-name-sans-extension |
e0d5fc8f7387
(find-lisp-object-file-name): When looking for autoloaded
Glenn Morris <rgm@gnu.org>
parents:
104931
diff
changeset
|
274 (match-string-no-properties 1)) |
e0d5fc8f7387
(find-lisp-object-file-name): When looking for autoloaded
Glenn Morris <rgm@gnu.org>
parents:
104931
diff
changeset
|
275 load-path '(".el" ".elc") 'readable)))))))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
276 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
277 (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
278 ((and (not file-name) (subrp type)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
279 ;; A built-in function. The form is from `describe-function-1'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
280 (if (get-buffer " *DOC*") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
281 (help-C-file-name type 'subr) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
282 'C-source)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
283 ((and (not file-name) (symbolp object) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
284 (integerp (get object 'variable-documentation))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
285 ;; A variable defined in C. The form is from `describe-variable'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
286 (if (get-buffer " *DOC*") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
287 (help-C-file-name object 'var) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
288 'C-source)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
289 ((not (stringp file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
290 ;; If we don't have a file-name string by now, we lost. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
291 nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
292 ((let ((lib-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
293 (if (string-match "[.]elc\\'" file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
294 (substring-no-properties file-name 0 -1) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
295 file-name))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
296 ;; When the Elisp source file can be found in the install |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
297 ;; directory return the name of that file - `file-name' should |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
298 ;; have become an absolute file name ny now. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
299 (or (and (file-readable-p lib-name) lib-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
300 ;; The library might be compressed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
301 (and (file-readable-p (concat lib-name ".gz")) lib-name)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
302 ((let* ((lib-name (file-name-nondirectory file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
303 ;; The next form is from `describe-simplify-lib-file-name'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
304 (file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
305 ;; Try converting the absolute file name to a library |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
306 ;; name, convert that back to a file name and see if we |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
307 ;; get the original one. If so, they are equivalent. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
308 (if (equal file-name (locate-file lib-name load-path '(""))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
309 (if (string-match "[.]elc\\'" lib-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
310 (substring-no-properties lib-name 0 -1) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
311 lib-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
312 file-name)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
313 ;; The next three forms are from `find-source-lisp-file'. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
314 (elc-file (locate-file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
315 (concat file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
316 (if (string-match "\\.el\\'" file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
317 "c" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
318 ".elc")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
319 load-path nil 'readable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
320 (str (when elc-file |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
321 (with-temp-buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
322 (insert-file-contents-literally elc-file nil 0 256) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
323 (buffer-string)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
324 (src-file (and str |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
325 (string-match ";;; from file \\(.*\\.el\\)" str) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
326 (match-string 1 str)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
327 (and src-file (file-readable-p src-file) src-file)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
328 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
329 (declare-function ad-get-advice-info "advice" (function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
330 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
331 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
332 (defun describe-function-1 (function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
333 (let* ((advised (and (symbolp function) (featurep 'advice) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
334 (ad-get-advice-info function))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
335 ;; If the function is advised, use the symbol that has the |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
336 ;; real definition, if that symbol is already set up. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
337 (real-function |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
338 (or (and advised |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
339 (let ((origname (cdr (assq 'origname advised)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
340 (and (fboundp origname) origname))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
341 function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
342 ;; Get the real definition. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
343 (def (if (symbolp real-function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
344 (symbol-function real-function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
345 function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
346 file-name string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
347 (beg (if (commandp def) "an interactive " "a ")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
348 (pt1 (with-current-buffer (help-buffer) (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
349 errtype) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
350 (setq string |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
351 (cond ((or (stringp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
352 (vectorp def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
353 "a keyboard macro") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
354 ((subrp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
355 (if (eq 'unevalled (cdr (subr-arity def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
356 (concat beg "special form") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
357 (concat beg "built-in function"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
358 ((byte-code-function-p def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
359 (concat beg "compiled Lisp function")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
360 ((symbolp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
361 (while (and (fboundp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
362 (symbolp (symbol-function def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
363 (setq def (symbol-function def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
364 ;; Handle (defalias 'foo 'bar), where bar is undefined. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
365 (or (fboundp def) (setq errtype 'alias)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
366 (format "an alias for `%s'" def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
367 ((eq (car-safe def) 'lambda) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
368 (concat beg "Lisp function")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
369 ((eq (car-safe def) 'macro) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
370 "a Lisp macro") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
371 ((eq (car-safe def) 'autoload) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
372 (format "%s autoloaded %s" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
373 (if (commandp def) "an interactive" "an") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
374 (if (eq (nth 4 def) 'keymap) "keymap" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
375 (if (nth 4 def) "Lisp macro" "Lisp function")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
376 ((keymapp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
377 (let ((is-full nil) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
378 (elts (cdr-safe def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
379 (while elts |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
380 (if (char-table-p (car-safe elts)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
381 (setq is-full t |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
382 elts nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
383 (setq elts (cdr-safe elts))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
384 (if is-full |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
385 "a full keymap" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
386 "a sparse keymap"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
387 (t ""))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
388 (princ string) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
389 (if (eq errtype 'alias) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
390 (princ ",\nwhich is not defined. Please make a bug report.") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
391 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
392 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
393 (save-match-data |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
394 (when (re-search-backward "alias for `\\([^`']+\\)'" nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
395 (help-xref-button 1 'help-function def))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
396 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
397 (setq file-name (find-lisp-object-file-name function def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
398 (when file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
399 (princ " in `") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
400 ;; We used to add .el to the file name, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
401 ;; but that's completely wrong when the user used load-file. |
98319
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
402 (princ (if (eq file-name 'C-source) |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
403 "C source code" |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
404 (file-name-nondirectory file-name))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
405 (princ "'") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
406 ;; Make a hyperlink to the library. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
407 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
408 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
409 (re-search-backward "`\\([^`']+\\)'" nil t) |
103611
6f6def36a946
* help-fns.el (describe-function-1): Correctly locate adviced
Chong Yidong <cyd@stupidchicken.com>
parents:
102309
diff
changeset
|
410 (help-xref-button 1 'help-function-def function file-name)))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
411 (princ ".") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
412 (with-current-buffer (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
413 (fill-region-as-paragraph (save-excursion (goto-char pt1) (forward-line 0) (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
414 (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
415 (terpri)(terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
416 (when (commandp function) |
99564
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
417 (let ((pt2 (with-current-buffer (help-buffer) (point))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
418 (remapped (command-remapping function))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
419 (unless (memq remapped '(ignore undefined)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
420 (let ((keys (where-is-internal |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
421 (or remapped function) overriding-local-map nil nil)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
422 non-modified-keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
423 (if (and (eq function 'self-insert-command) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
424 (vectorp (car-safe keys)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
425 (consp (aref (car keys) 0))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
426 (princ "It is bound to many ordinary text characters.\n") |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
427 ;; Which non-control non-meta keys run this command? |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
428 (dolist (key keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
429 (if (member (event-modifiers (aref key 0)) '(nil (shift))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
430 (push key non-modified-keys))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
431 (when remapped |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
432 (princ "It is remapped to `") |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
433 (princ (symbol-name remapped)) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
434 (princ "'")) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
435 |
99564
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
436 (when keys |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
437 (princ (if remapped ", which is bound to " "It is bound to ")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
438 ;; If lots of ordinary text characters run this command, |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
439 ;; don't mention them one by one. |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
440 (if (< (length non-modified-keys) 10) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
441 (princ (mapconcat 'key-description keys ", ")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
442 (dolist (key non-modified-keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
443 (setq keys (delq key keys))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
444 (if keys |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
445 (progn |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
446 (princ (mapconcat 'key-description keys ", ")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
447 (princ ", and many ordinary text characters")) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
448 (princ "many ordinary text characters")))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
449 (when (or remapped keys non-modified-keys) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
450 (princ ".") |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
451 (terpri))))) |
e3d49b38c157
(describe-function-1): Do char-range check for self-insert-command.
Chong Yidong <cyd@stupidchicken.com>
parents:
99119
diff
changeset
|
452 |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
453 (with-current-buffer (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
454 (fill-region-as-paragraph pt2 (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
455 (unless (looking-back "\n\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
456 (terpri))))) |
104931
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
457 ;; Note that list* etc do not get this property until |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
458 ;; cl-hack-byte-compiler runs, after bytecomp is loaded. |
105475
dbbce03200d3
(describe-function-1): Don't burp is the function is not a symbol.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105386
diff
changeset
|
459 (when (and (symbolp function) |
dbbce03200d3
(describe-function-1): Don't burp is the function is not a symbol.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105386
diff
changeset
|
460 (eq (get function 'byte-compile) |
dbbce03200d3
(describe-function-1): Don't burp is the function is not a symbol.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105386
diff
changeset
|
461 'cl-byte-compile-compiler-macro)) |
104931
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
462 (princ "This function has a compiler macro") |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
463 (let ((lib (get function 'compiler-macro-file))) |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
464 (when (stringp lib) |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
465 (princ (format " in `%s'" lib)) |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
466 (with-current-buffer standard-output |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
467 (save-excursion |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
468 (re-search-backward "`\\([^`']+\\)'" nil t) |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
469 (help-xref-button 1 'help-function-cmacro function lib))))) |
179ce0a21ce8
(describe-function-1): Mention if a function has a compiler-macro.
Glenn Morris <rgm@gnu.org>
parents:
104258
diff
changeset
|
470 (princ ".\n\n")) |
105386
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
471 (let* ((advertised (gethash def advertised-signature-table t)) |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
472 (arglist (if (listp advertised) |
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
473 advertised (help-function-arglist def))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
474 (doc (documentation function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
475 (usage (help-split-fundoc doc function))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
476 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
477 ;; If definition is a keymap, skip arglist note. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
478 (unless (keymapp function) |
105386
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
479 (if usage (setq doc (cdr usage))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
480 (let* ((use (cond |
105386
f004275b4271
* help-fns.el (help-function-arglist): Don't check advertised-signature-table.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105372
diff
changeset
|
481 ((and usage (not (listp advertised))) (car usage)) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
482 ((listp arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
483 (format "%S" (help-make-usage function arglist))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
484 ((stringp arglist) arglist) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
485 ;; Maybe the arglist is in the docstring of a symbol |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
486 ;; this one is aliased to. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
487 ((let ((fun real-function)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
488 (while (and (symbolp fun) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
489 (setq fun (symbol-function fun)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
490 (not (setq usage (help-split-fundoc |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
491 (documentation fun) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
492 function))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
493 usage) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
494 (car usage)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
495 ((or (stringp def) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
496 (vectorp def)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
497 (format "\nMacro: %s" (format-kbd-macro def))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
498 (t "[Missing arglist. Please make a bug report.]"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
499 (high (help-highlight-arguments use doc))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
500 (let ((fill-begin (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
501 (insert (car high) "\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
502 (fill-region fill-begin (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
503 (setq doc (cdr high)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
504 (let* ((obsolete (and |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
505 ;; function might be a lambda construct. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
506 (symbolp function) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
507 (get function 'byte-obsolete-info))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
508 (use (car obsolete))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
509 (when obsolete |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
510 (princ "\nThis function is obsolete") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
511 (when (nth 2 obsolete) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
512 (insert (format " since %s" (nth 2 obsolete)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
513 (insert (cond ((stringp use) (concat ";\n" use)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
514 (use (format ";\nuse `%s' instead." use)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
515 (t ".")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
516 "\n")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
517 (insert "\n" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
518 (or doc "Not documented.")))))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
519 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
520 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
521 ;; Variables |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
522 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
523 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
524 (defun variable-at-point (&optional any-symbol) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
525 "Return the bound variable symbol found at or before point. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
526 Return 0 if there is no such symbol. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
527 If ANY-SYMBOL is non-nil, don't insist the symbol be bound." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
528 (with-syntax-table emacs-lisp-mode-syntax-table |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
529 (or (condition-case () |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
530 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
531 (or (not (zerop (skip-syntax-backward "_w"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
532 (eq (char-syntax (following-char)) ?w) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
533 (eq (char-syntax (following-char)) ?_) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
534 (forward-sexp -1)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
535 (skip-chars-forward "'") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
536 (let ((obj (read (current-buffer)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
537 (and (symbolp obj) (boundp obj) obj))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
538 (error nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
539 (let* ((str (find-tag-default)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
540 (sym (if str (intern-soft str)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
541 (if (and sym (or any-symbol (boundp sym))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
542 sym |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
543 (save-match-data |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
544 (when (and str (string-match "\\`\\W*\\(.*?\\)\\W*\\'" str)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
545 (setq sym (intern-soft (match-string 1 str))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
546 (and (or any-symbol (boundp sym)) sym))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
547 0))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
548 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
549 (defun describe-variable-custom-version-info (variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
550 (let ((custom-version (get variable 'custom-version)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
551 (cpv (get variable 'custom-package-version)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
552 (output nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
553 (if custom-version |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
554 (setq output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
555 (format "This variable was introduced, or its default value was changed, in\nversion %s of Emacs.\n" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
556 custom-version)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
557 (when cpv |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
558 (let* ((package (car-safe cpv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
559 (version (if (listp (cdr-safe cpv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
560 (car (cdr-safe cpv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
561 (cdr-safe cpv))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
562 (pkg-versions (assq package customize-package-emacs-version-alist)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
563 (emacsv (cdr (assoc version pkg-versions)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
564 (if (and package version) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
565 (setq output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
566 (format (concat "This variable was introduced, or its default value was changed, in\nversion %s of the %s package" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
567 (if emacsv |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
568 (format " that is part of Emacs %s" emacsv)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
569 ".\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
570 version package)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
571 output)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
572 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
573 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
574 (defun describe-variable (variable &optional buffer frame) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
575 "Display the full documentation of VARIABLE (a symbol). |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
576 Returns the documentation as a string, also. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
577 If VARIABLE has a buffer-local value in BUFFER or FRAME |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
578 \(default to the current buffer and current frame), |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
579 it is displayed along with the global value." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
580 (interactive |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
581 (let ((v (variable-at-point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
582 (enable-recursive-minibuffers t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
583 val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
584 (setq val (completing-read (if (symbolp v) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
585 (format |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
586 "Describe variable (default %s): " v) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
587 "Describe variable: ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
588 obarray |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
589 '(lambda (vv) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
590 (or (boundp vv) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
591 (get vv 'variable-documentation))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
592 t nil nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
593 (if (symbolp v) (symbol-name v)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
594 (list (if (equal val "") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
595 v (intern val))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
596 (let (file-name) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
597 (unless (buffer-live-p buffer) (setq buffer (current-buffer))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
598 (unless (frame-live-p frame) (setq frame (selected-frame))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
599 (if (not (symbolp variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
600 (message "You did not specify a variable") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
601 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
602 (let ((valvoid (not (with-current-buffer buffer (boundp variable)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
603 val val-start-pos locus) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
604 ;; Extract the value before setting up the output buffer, |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
605 ;; in case `buffer' *is* the output buffer. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
606 (unless valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
607 (with-selected-frame frame |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
608 (with-current-buffer buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
609 (setq val (symbol-value variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
610 locus (variable-binding-locus variable))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
611 (help-setup-xref (list #'describe-variable variable buffer) |
105372
bd2966850aac
Use `called-interactively-p' instead of `interactive-p'.
Juanma Barranquero <lekktu@gmail.com>
parents:
105363
diff
changeset
|
612 (called-interactively-p 'interactive)) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
613 (with-help-window (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
614 (with-current-buffer buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
615 (prin1 variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
616 (setq file-name (find-lisp-object-file-name variable 'defvar)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
617 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
618 (if file-name |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
619 (progn |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
620 (princ " is a variable defined in `") |
98319
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
621 (princ (if (eq file-name 'C-source) |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
622 "C source code" |
16aabd7d9d9d
(describe-function-1, describe-variable): Print
Martin Rudalics <rudalics@gmx.at>
parents:
98097
diff
changeset
|
623 (file-name-nondirectory file-name))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
624 (princ "'.\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
625 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
626 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
627 (re-search-backward "`\\([^`']+\\)'" nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
628 (help-xref-button 1 'help-variable-def |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
629 variable file-name))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
630 (if valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
631 (princ "It is void as a variable.") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
632 (princ "Its "))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
633 (if valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
634 (princ " is void as a variable.") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
635 (princ "'s ")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
636 (if valvoid |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
637 nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
638 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
639 (setq val-start-pos (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
640 (princ "value is ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
641 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
642 (let ((from (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
643 (pp val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
644 ;; Hyperlinks in variable's value are quite frequently |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
645 ;; inappropriate e.g C-h v <RET> features <RET> |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
646 ;; (help-xref-on-pp from (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
647 (if (< (point) (+ from 20)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
648 (delete-region (1- from) from))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
649 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
650 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
651 (when locus |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
652 (if (bufferp locus) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
653 (princ (format "%socal in buffer %s; " |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
654 (if (get variable 'permanent-local) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
655 "Permanently l" "L") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
656 (buffer-name))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
657 (princ (format "It is a frame-local variable; "))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
658 (if (not (default-boundp variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
659 (princ "globally void") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
660 (let ((val (default-value variable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
661 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
662 (princ "global value is ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
663 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
664 ;; Fixme: pp can take an age if you happen to |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
665 ;; ask for a very large expression. We should |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
666 ;; probably print it raw once and check it's a |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
667 ;; sensible size before prettyprinting. -- fx |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
668 (let ((from (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
669 (pp val) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
670 ;; See previous comment for this function. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
671 ;; (help-xref-on-pp from (point)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
672 (if (< (point) (+ from 20)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
673 (delete-region (1- from) from)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
674 (terpri)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
675 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
676 ;; If the value is large, move it to the end. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
677 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
678 (when (> (count-lines (point-min) (point-max)) 10) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
679 ;; Note that setting the syntax table like below |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
680 ;; makes forward-sexp move over a `'s' at the end |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
681 ;; of a symbol. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
682 (set-syntax-table emacs-lisp-mode-syntax-table) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
683 (goto-char val-start-pos) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
684 ;; The line below previously read as |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
685 ;; (delete-region (point) (progn (end-of-line) (point))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
686 ;; which suppressed display of the buffer local value for |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
687 ;; large values. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
688 (when (looking-at "value is") (replace-match "")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
689 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
690 (insert "\n\nValue:") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
691 (set (make-local-variable 'help-button-cache) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
692 (point-marker))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
693 (insert "value is shown ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
694 (insert-button "below" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
695 'action help-button-cache |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
696 'follow-link t |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
697 'help-echo "mouse-2, RET: show value") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
698 (insert ".\n"))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
699 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
700 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
701 (let* ((alias (condition-case nil |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
702 (indirect-variable variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
703 (error variable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
704 (obsolete (get variable 'byte-obsolete-variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
705 (use (car obsolete)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
706 (safe-var (get variable 'safe-local-variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
707 (doc (or (documentation-property variable 'variable-documentation) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
708 (documentation-property alias 'variable-documentation))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
709 (extra-line nil)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
710 ;; Add a note for variables that have been make-var-buffer-local. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
711 (when (and (local-variable-if-set-p variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
712 (or (not (local-variable-p variable)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
713 (with-temp-buffer |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
714 (local-variable-if-set-p variable)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
715 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
716 (princ " Automatically becomes buffer-local when set in any fashion.\n")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
717 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
718 ;; Mention if it's an alias |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
719 (unless (eq alias variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
720 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
721 (princ (format " This variable is an alias for `%s'.\n" alias))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
722 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
723 (when obsolete |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
724 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
725 (princ " This variable is obsolete") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
726 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
727 (princ (cond ((stringp use) (concat ";\n " use)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
728 (use (format ";\n use `%s' instead." (car obsolete))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
729 (t "."))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
730 (terpri)) |
103983
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
731 |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
732 (when (member (cons variable val) file-local-variables-alist) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
733 (setq extra-line t) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
734 (if (member (cons variable val) dir-local-variables-alist) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
735 (let ((file (and (buffer-file-name) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
736 (not (file-remote-p (buffer-file-name))) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
737 (dir-locals-find-file (buffer-file-name))))) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
738 (princ " This variable is a directory local variable") |
104134
0bef83c2fc08
* help-fns.el (describe-variable): Treat list return values from
Chong Yidong <cyd@stupidchicken.com>
parents:
104037
diff
changeset
|
739 (when file |
0bef83c2fc08
* help-fns.el (describe-variable): Treat list return values from
Chong Yidong <cyd@stupidchicken.com>
parents:
104037
diff
changeset
|
740 (princ (concat "\n from the file \"" |
0bef83c2fc08
* help-fns.el (describe-variable): Treat list return values from
Chong Yidong <cyd@stupidchicken.com>
parents:
104037
diff
changeset
|
741 (if (consp file) |
0bef83c2fc08
* help-fns.el (describe-variable): Treat list return values from
Chong Yidong <cyd@stupidchicken.com>
parents:
104037
diff
changeset
|
742 (car file) |
0bef83c2fc08
* help-fns.el (describe-variable): Treat list return values from
Chong Yidong <cyd@stupidchicken.com>
parents:
104037
diff
changeset
|
743 file) |
0bef83c2fc08
* help-fns.el (describe-variable): Treat list return values from
Chong Yidong <cyd@stupidchicken.com>
parents:
104037
diff
changeset
|
744 "\""))) |
103983
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
745 (princ ".\n")) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
746 (princ " This variable is a file local variable.\n"))) |
4af91568dcc6
(describe-variable): Add information about file-local and dir-local variables.
Juri Linkov <juri@jurta.org>
parents:
103611
diff
changeset
|
747 |
104037
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
748 (when (memq variable ignored-local-variables) |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
749 (setq extra-line t) |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
750 (princ " This variable is ignored when used as a file local \ |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
751 variable.\n")) |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
752 |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
753 ;; Can be both risky and safe, eg auto-fill-function. |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
754 (when (risky-local-variable-p variable) |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
755 (setq extra-line t) |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
756 (princ " This variable is potentially risky when used as a \ |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
757 file local variable.\n") |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
758 (when (assq variable safe-local-variable-values) |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
759 (princ " However, you have added it to \ |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
760 `safe-local-variable-values'.\n"))) |
cb6235bd8c86
(describe-variable): Describe ignored and risky local
Glenn Morris <rgm@gnu.org>
parents:
103983
diff
changeset
|
761 |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
762 (when safe-var |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
763 (setq extra-line t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
764 (princ " This variable is safe as a file local variable ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
765 (princ "if its value\n satisfies the predicate ") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
766 (princ (if (byte-code-function-p safe-var) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
767 "which is byte-compiled expression.\n" |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
768 (format "`%s'.\n" safe-var)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
769 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
770 (if extra-line (terpri)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
771 (princ "Documentation:\n") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
772 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
773 (insert (or doc "Not documented as a variable.")))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
774 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
775 ;; Make a link to customize if this variable can be customized. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
776 (when (custom-variable-p variable) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
777 (let ((customize-label "customize")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
778 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
779 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
780 (princ (concat "You can " customize-label " this variable.")) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
781 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
782 (save-excursion |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
783 (re-search-backward |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
784 (concat "\\(" customize-label "\\)") nil t) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
785 (help-xref-button 1 'help-customize-variable variable)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
786 ;; Note variable's version or package version |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
787 (let ((output (describe-variable-custom-version-info variable))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
788 (when output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
789 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
790 (terpri) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
791 (princ output)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
792 |
105994
009383a57ce8
* x-dnd.el (x-dnd-maybe-call-test-function):
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
105694
diff
changeset
|
793 (with-current-buffer standard-output |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
794 ;; Return the text we displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
795 (buffer-string)))))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
796 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
797 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
798 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
799 (defun describe-syntax (&optional buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
800 "Describe the syntax specifications in the syntax table of BUFFER. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
801 The descriptions are inserted in a help buffer, which is then displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
802 BUFFER defaults to the current buffer." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
803 (interactive) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
804 (setq buffer (or buffer (current-buffer))) |
105372
bd2966850aac
Use `called-interactively-p' instead of `interactive-p'.
Juanma Barranquero <lekktu@gmail.com>
parents:
105363
diff
changeset
|
805 (help-setup-xref (list #'describe-syntax buffer) |
bd2966850aac
Use `called-interactively-p' instead of `interactive-p'.
Juanma Barranquero <lekktu@gmail.com>
parents:
105363
diff
changeset
|
806 (called-interactively-p 'interactive)) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
807 (with-help-window (help-buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
808 (let ((table (with-current-buffer buffer (syntax-table)))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
809 (with-current-buffer standard-output |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
810 (describe-vector table 'internal-describe-syntax-value) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
811 (while (setq table (char-table-parent table)) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
812 (insert "\nThe parent syntax table is:") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
813 (describe-vector table 'internal-describe-syntax-value)))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
814 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
815 (defun help-describe-category-set (value) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
816 (insert (cond |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
817 ((null value) "default") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
818 ((char-table-p value) "deeper char-table ...") |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
819 (t (condition-case err |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
820 (category-set-mnemonics value) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
821 (error "invalid")))))) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
822 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
823 ;;;###autoload |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
824 (defun describe-categories (&optional buffer) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
825 "Describe the category specifications in the current category table. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
826 The descriptions are inserted in a buffer, which is then displayed. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
827 If BUFFER is non-nil, then describe BUFFER's category table instead. |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
828 BUFFER should be a buffer or a buffer name." |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
829 (interactive) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
830 (setq buffer (or buffer (current-buffer))) |
105372
bd2966850aac
Use `called-interactively-p' instead of `interactive-p'.
Juanma Barranquero <lekktu@gmail.com>
parents:
105363
diff
changeset
|
831 (help-setup-xref (list #'describe-categories buffer) |
bd2966850aac
Use `called-interactively-p' instead of `interactive-p'.
Juanma Barranquero <lekktu@gmail.com>
parents:
105363
diff
changeset
|
832 (called-interactively-p 'interactive)) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
833 (with-help-window (help-buffer) |
99119
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
834 (let* ((table (with-current-buffer buffer (category-table))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
835 (docs (char-table-extra-slot table 0))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
836 (if (or (not (vectorp docs)) (/= (length docs) 95)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
837 (error "Invalid first extra slot in this category table\n")) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
838 (with-current-buffer standard-output |
99119
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
839 (insert "Legend of category mnemonics (see the tail for the longer description)\n") |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
840 (let ((pos (point)) (items 0) lines n) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
841 (dotimes (i 95) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
842 (if (aref docs i) (setq items (1+ items)))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
843 (setq lines (1+ (/ (1- items) 4))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
844 (setq n 0) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
845 (dotimes (i 95) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
846 (let ((elt (aref docs i))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
847 (when elt |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
848 (string-match ".*" elt) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
849 (setq elt (match-string 0 elt)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
850 (if (>= (length elt) 17) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
851 (setq elt (concat (substring elt 0 14) "..."))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
852 (if (< (point) (point-max)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
853 (move-to-column (* 20 (/ n lines)) t)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
854 (insert (+ i ?\s) ?: elt) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
855 (if (< (point) (point-max)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
856 (forward-line 1) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
857 (insert "\n")) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
858 (setq n (1+ n)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
859 (if (= (% n lines) 0) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
860 (goto-char pos)))))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
861 (goto-char (point-max)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
862 (insert "\n" |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
863 "character(s)\tcategory mnemonics\n" |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
864 "------------\t------------------") |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
865 (describe-vector table 'help-describe-category-set) |
99119
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
866 (insert "Legend of category mnemonics:\n") |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
867 (dotimes (i 95) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
868 (let ((elt (aref docs i))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
869 (when elt |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
870 (if (string-match "\n" elt) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
871 (setq elt (substring elt (match-end 0)))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
872 (insert (+ i ?\s) ": " elt "\n")))) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
873 (while (setq table (char-table-parent table)) |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
874 (insert "\nThe parent category table is:") |
6b4c01048db2
(describe-categories): Display the terse legend at the head.
Kenichi Handa <handa@m17n.org>
parents:
98319
diff
changeset
|
875 (describe-vector table 'help-describe-category-set)))))) |
98097
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
876 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
877 (provide 'help-fns) |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
878 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
879 ;; arch-tag: 9e10331c-ae81-4d13-965d-c4819aaab0b3 |
1a289c2bc9d8
(describe-function-1): Don't print extra newline
Martin Rudalics <rudalics@gmx.at>
parents:
98095
diff
changeset
|
880 ;;; help-fns.el ends here |