Mercurial > emacs
annotate lisp/help-fns.el @ 57550:a19498f00f9a
(spam-stat-unload-hook): Set as a variable w/ add-hook.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 17 Oct 2004 07:07:14 +0000 |
parents | 24f213302267 |
children | 2f9fe20953a6 ff0e824afa37 |
rev | line source |
---|---|
41584
8b64dc23e305
Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents:
41583
diff
changeset
|
1 ;;; help-fns.el --- Complex help functions |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
2 |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
3 ;; Copyright (C) 1985, 86, 93, 94, 98, 1999, 2000, 01, 02, 03, 2004 |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
4 ;; Free Software Foundation, Inc. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
5 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
6 ;; Maintainer: FSF |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
7 ;; Keywords: help, internal |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
8 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
9 ;; This file is part of GNU Emacs. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
10 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
11 ;; GNU Emacs is free software; you can redistribute it and/or modify |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
12 ;; it under the terms of the GNU General Public License as published by |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
13 ;; the Free Software Foundation; either version 2, or (at your option) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
14 ;; any later version. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
15 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
16 ;; GNU Emacs is distributed in the hope that it will be useful, |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
19 ;; GNU General Public License for more details. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
20 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
21 ;; You should have received a copy of the GNU General Public License |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
24 ;; Boston, MA 02111-1307, USA. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
25 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
26 ;;; Commentary: |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
27 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
28 ;; This file contains those help commands which are complicated, and |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
29 ;; which may not be used in every session. For example |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
30 ;; `describe-function' will probably be heavily used when doing elisp |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
31 ;; programming, but not if just editing C files. Simpler help commands |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
32 ;; are in help.el |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
33 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
34 ;;; Code: |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
35 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
36 (require 'help-mode) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
37 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
38 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
39 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
40 (defun help-with-tutorial (&optional arg) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
41 "Select the Emacs learn-by-doing tutorial. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
42 If there is a tutorial version written in the language |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
43 of the selected language environment, that version is used. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
44 If there's no tutorial in that language, `TUTORIAL' is selected. |
47663
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
45 With ARG, you are asked to choose which language." |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
46 (interactive "P") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
47 (let ((lang (if arg |
55454
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
48 (let ((minibuffer-setup-hook minibuffer-setup-hook)) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
49 (add-hook 'minibuffer-setup-hook |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
50 'minibuffer-completion-help) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
51 (read-language-name 'tutorial "Language: " "English")) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
52 (if (get-language-info current-language-environment 'tutorial) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
53 current-language-environment |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
54 "English"))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
55 file filename) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
56 (setq filename (get-language-info lang 'tutorial)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
57 (setq file (expand-file-name (concat "~/" filename))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
58 (delete-other-windows) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
59 (if (get-file-buffer file) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
60 (switch-to-buffer (get-file-buffer file)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
61 (switch-to-buffer (create-file-buffer file)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
62 (setq buffer-file-name file) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
63 (setq default-directory (expand-file-name "~/")) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
64 (setq buffer-auto-save-file-name nil) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
65 (insert-file-contents (expand-file-name filename data-directory)) |
54980
8041d88f98b5
(help-with-tutorial): Call `hack-local-variables'
Juri Linkov <juri@jurta.org>
parents:
54749
diff
changeset
|
66 (hack-local-variables) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
67 (goto-char (point-min)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
68 (search-forward "\n<<") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
69 (beginning-of-line) |
44291
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
70 ;; Convert the <<...>> line to the proper [...] line, |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
71 ;; or just delete the <<...>> line if a [...] line follows. |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
72 (cond ((save-excursion |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
73 (forward-line 1) |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
74 (looking-at "\\[")) |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
75 (delete-region (point) (progn (forward-line 1) (point)))) |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
76 ((looking-at "<<Blank lines inserted.*>>") |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
77 (replace-match "[Middle of page left blank for didactic purposes. Text continues below]")) |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
78 (t |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
79 (looking-at "<<") |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
80 (replace-match "[") |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
81 (search-forward ">>") |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
82 (replace-match "]"))) |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
83 (beginning-of-line) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
84 (let ((n (- (window-height (selected-window)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
85 (count-lines (point-min) (point)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
86 6))) |
44291
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
87 (if (< n 8) |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
88 (progn |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
89 ;; For a short gap, we don't need the [...] line, |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
90 ;; so delete it. |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
91 (delete-region (point) (progn (end-of-line) (point))) |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
92 (newline n)) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
93 ;; Some people get confused by the large gap. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
94 (newline (/ n 2)) |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49102
diff
changeset
|
95 |
44291
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
96 ;; Skip the [...] line (don't delete it). |
cf7a8ea9f88d
(help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents:
43499
diff
changeset
|
97 (forward-line 1) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
98 (newline (- n (/ n 2))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
99 (goto-char (point-min)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
100 (set-buffer-modified-p nil)))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
101 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
102 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
103 (defun locate-library (library &optional nosuffix path interactive-call) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
104 "Show the precise file name of Emacs library LIBRARY. |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
105 This command searches the directories in `load-path' like `\\[load-library]' |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
106 to find the file that `\\[load-library] RET LIBRARY RET' would load. |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
107 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes' |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
108 to the specified name LIBRARY. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
109 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
110 If the optional third arg PATH is specified, that list of directories |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
111 is used instead of `load-path'. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
112 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
113 When called from a program, the file name is normaly returned as a |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
114 string. When run interactively, the argument INTERACTIVE-CALL is t, |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
115 and the file name is displayed in the echo area." |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
116 (interactive (list (completing-read "Locate library: " |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
117 'locate-file-completion |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
118 (cons load-path load-suffixes)) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
119 nil nil |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
120 t)) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
121 (let ((file (locate-file library |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
122 (or path load-path) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
123 (append (unless nosuffix load-suffixes) '(""))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
124 (if interactive-call |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
125 (if file |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
126 (message "Library is file %s" (abbreviate-file-name file)) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
127 (message "No library %s in search path" library))) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
128 file)) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
129 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
130 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
131 ;; Functions |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
132 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
133 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
134 (defun describe-function (function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
135 "Display the full documentation of FUNCTION (a symbol)." |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
136 (interactive |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
137 (let ((fn (function-called-at-point)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
138 (enable-recursive-minibuffers t) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
139 val) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
140 (setq val (completing-read (if fn |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
141 (format "Describe function (default %s): " fn) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
142 "Describe function: ") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
143 obarray 'fboundp t nil nil (symbol-name fn))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
144 (list (if (equal val "") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
145 fn (intern val))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
146 (if (null function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
147 (message "You didn't specify a function") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
148 (help-setup-xref (list #'describe-function function) (interactive-p)) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
149 (save-excursion |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
150 (with-output-to-temp-buffer (help-buffer) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
151 (prin1 function) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
152 ;; Use " is " instead of a colon so that |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
153 ;; it is easier to get out the function name using forward-sexp. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
154 (princ " is ") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
155 (describe-function-1 function) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
156 (print-help-return-message) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
157 (with-current-buffer standard-output |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
158 ;; Return the text we displayed. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
159 (buffer-string)))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
160 |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
161 (defun help-split-fundoc (docstring def) |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
162 "Split a function DOCSTRING into the actual doc and the usage info. |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
163 Return (USAGE . DOC) or nil if there's no usage info. |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
164 DEF is the function whose usage we're looking for in DOCSTRING." |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
165 ;; Functions can get the calling sequence at the end of the doc string. |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
166 ;; In cases where `function' has been fset to a subr we can't search for |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
167 ;; function's name in the doc string so we use `fn' as the anonymous |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
168 ;; function name instead. |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
169 (when (and docstring (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring)) |
47663
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
170 (cons (format "(%s%s" |
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
171 ;; Replace `fn' with the actual function name. |
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
172 (if (consp def) "anonymous" def) |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
173 (match-string 1 docstring)) |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
174 (substring docstring 0 (match-beginning 0))))) |
47663
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
175 |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
176 (defun help-add-fundoc-usage (docstring arglist) |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
177 "Add the usage info to DOCSTRING. |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
178 If DOCSTRING already has a usage info, then just return it unchanged. |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
179 The usage info is built from ARGLIST. DOCSTRING can be nil. |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
180 ARGLIST can also be t or a string of the form \"(FUN ARG1 ARG2 ...)\"." |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
181 (unless (stringp docstring) (setq docstring "Not documented")) |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
182 (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" docstring) (eq arglist t)) |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
183 docstring |
55723
813de71608a6
(help-add-fundoc-usage): Use %S only for output of `help-make-usage'.
Juanma Barranquero <lekktu@gmail.com>
parents:
55564
diff
changeset
|
184 (concat docstring |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
185 (if (string-match "\n?\n\\'" docstring) |
50559
4975a5944969
(help-add-fundoc-usage): Pass an empty string to `format' if
John Paul Wallington <jpw@pobox.com>
parents:
49757
diff
changeset
|
186 (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "") |
47663
e9121795960f
(help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47236
diff
changeset
|
187 "\n\n") |
50799
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
188 (if (and (stringp arglist) |
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
189 (string-match "\\`([^ ]+\\(.*\\))\\'" arglist)) |
80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50559
diff
changeset
|
190 (concat "(fn" (match-string 1 arglist) ")") |
55723
813de71608a6
(help-add-fundoc-usage): Use %S only for output of `help-make-usage'.
Juanma Barranquero <lekktu@gmail.com>
parents:
55564
diff
changeset
|
191 (format "%S" (help-make-usage 'fn arglist)))))) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
192 |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
193 (defun help-function-arglist (def) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
194 ;; Handle symbols aliased to other symbols. |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
195 (if (and (symbolp def) (fboundp def)) (setq def (indirect-function def))) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
196 ;; If definition is a macro, find the function inside it. |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
197 (if (eq (car-safe def) 'macro) (setq def (cdr def))) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
198 (cond |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
199 ((byte-code-function-p def) (aref def 0)) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
200 ((eq (car-safe def) 'lambda) (nth 1 def)) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
201 ((and (eq (car-safe def) 'autoload) (not (eq (nth 4 def) 'keymap))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
202 "[Arg list not available until function definition is loaded.]") |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
203 (t t))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
204 |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
205 (defun help-make-usage (function arglist) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
206 (cons (if (symbolp function) function 'anonymous) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
207 (mapcar (lambda (arg) |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
208 (if (not (symbolp arg)) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
209 (if (and (consp arg) (symbolp (car arg))) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
210 ;; CL style default values for optional args. |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
211 (cons (intern (upcase (symbol-name (car arg)))) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
212 (cdr arg)) |
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
213 arg) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
214 (let ((name (symbol-name arg))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
215 (if (string-match "\\`&" name) arg |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
216 (intern (upcase name)))))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
217 arglist))) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
218 |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
219 (defun help-C-file-name (subr-or-var kind) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
220 "Return the name of the C file where SUBR-OR-VAR is defined. |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
221 KIND should be `var' for a variable or `subr' for a subroutine." |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
222 (let ((docbuf (get-buffer-create " *DOC*")) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
223 (name (if (eq 'var kind) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
224 (concat "V" (symbol-name subr-or-var)) |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
225 (concat "F" (subr-name subr-or-var))))) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
226 (with-current-buffer docbuf |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
227 (goto-char (point-min)) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
228 (if (eobp) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
229 (insert-file-contents-literally |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
230 (expand-file-name internal-doc-file-name doc-directory))) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
231 (search-forward (concat "" name "\n")) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
232 (re-search-backward "S\\(.*\\)") |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
233 (let ((file (match-string 1))) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
234 (if (string-match "\\.\\(o\\|obj\\)\\'" file) |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
235 (setq file (replace-match ".c" t t file))) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
236 (if (string-match "\\.c\\'" file) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
237 (concat "src/" file) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
238 file))))) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
239 |
55909
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
240 ;;;###autoload |
55958
519edd453780
(help-argument-name): Inherit from italic face only if the frame
Juanma Barranquero <lekktu@gmail.com>
parents:
55946
diff
changeset
|
241 (defface help-argument-name '((((supports :slant italic)) :inherit italic)) |
55946
039192c37cca
(help-argument-name): Add :group 'help.
Juri Linkov <juri@jurta.org>
parents:
55916
diff
changeset
|
242 "Face to highlight argument names in *Help* buffers." |
039192c37cca
(help-argument-name): Add :group 'help.
Juri Linkov <juri@jurta.org>
parents:
55916
diff
changeset
|
243 :group 'help) |
55909
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
244 |
55564
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
parents:
55537
diff
changeset
|
245 (defun help-default-arg-highlight (arg) |
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
parents:
55537
diff
changeset
|
246 "Default function to highlight arguments in *Help* buffers. |
55909
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
247 It returns ARG in face `help-argument-name'; ARG is also |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
248 downcased if it displays differently than the default |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
249 face (according to `face-differs-from-default-p')." |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
250 (propertize (if (face-differs-from-default-p 'help-argument-name) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
251 (downcase arg) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
252 arg) |
b917393b9c8c
(help-argument-name): Reintroduce face.
Juanma Barranquero <lekktu@gmail.com>
parents:
55723
diff
changeset
|
253 'face 'help-argument-name)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
254 |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
255 (defun help-do-arg-highlight (doc args) |
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
256 (with-syntax-table (make-syntax-table emacs-lisp-mode-syntax-table) |
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
257 (modify-syntax-entry ?\- "w") |
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
258 (while args |
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
259 (let ((arg (prog1 (car args) (setq args (cdr args))))) |
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
260 (setq doc (replace-regexp-in-string |
55537
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
261 ;; This is heuristic, but covers all common cases |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
262 ;; except ARG1-ARG2 |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
263 (concat "\\<" ; beginning of word |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
264 "\\(?:[a-z-]+-\\)?" ; for xxx-ARG |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
265 "\\(" |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
266 arg |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
267 "\\)" |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
268 "\\(?:es\\|s\\|th\\)?" ; for ARGth, ARGs |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
269 "\\(?:-[a-z-]+\\)?" ; for ARG-xxx |
66cd45c291c0
(help-split-fundoc, help-add-fundoc-usage): Make arguments match their use in
Juanma Barranquero <lekktu@gmail.com>
parents:
55479
diff
changeset
|
270 "\\>") ; end of word |
55564
280f311afedb
(help-arg-highlighting-function, help-argument-name): Delete.
Juanma Barranquero <lekktu@gmail.com>
parents:
55537
diff
changeset
|
271 (help-default-arg-highlight arg) |
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
272 doc t t 1)))) |
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
273 doc)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
274 |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
275 (defun help-highlight-arguments (usage doc &rest args) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
276 (when usage |
55454
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
277 (with-temp-buffer |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
278 (insert usage) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
279 (goto-char (point-min)) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
280 (let ((case-fold-search nil) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
281 (next (not (or args (looking-at "\\[")))) |
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
282 (opt nil)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
283 ;; Make a list of all arguments |
55723
813de71608a6
(help-add-fundoc-usage): Use %S only for output of `help-make-usage'.
Juanma Barranquero <lekktu@gmail.com>
parents:
55564
diff
changeset
|
284 (skip-chars-forward "^ ") |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
285 (while next |
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
286 (or opt (not (looking-at " &")) (setq opt t)) |
55454
3b8721850659
(help-highlight-arguments): Don't try to highlight missing or autoloaded
Juanma Barranquero <lekktu@gmail.com>
parents:
55426
diff
changeset
|
287 (if (not (re-search-forward " \\([\\[(]*\\)\\([^] &)\.]+\\)" nil t)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
288 (setq next nil) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
289 (setq args (cons (match-string 2) args)) |
55426
765deb51a826
(help-do-arg-highlight): Temporarily set ?\- to be a word constituent so
Juanma Barranquero <lekktu@gmail.com>
parents:
55381
diff
changeset
|
290 (when (and opt (string= (match-string 1) "(")) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
291 ;; A pesky CL-style optional argument with default value, |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
292 ;; so let's skip over it |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
293 (search-backward "(") |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
294 (goto-char (scan-sexps (point) 1))))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
295 ;; Highlight aguments in the USAGE string |
55457
f263b4b25c9e
(help-highlight-arguments): Fix braino.
Juanma Barranquero <lekktu@gmail.com>
parents:
55454
diff
changeset
|
296 (setq usage (help-do-arg-highlight (buffer-string) args)) |
f263b4b25c9e
(help-highlight-arguments): Fix braino.
Juanma Barranquero <lekktu@gmail.com>
parents:
55454
diff
changeset
|
297 ;; Highlight arguments in the DOC string |
55479
50b878285992
(help-argument-name): Default to italic.
Juanma Barranquero <lekktu@gmail.com>
parents:
55457
diff
changeset
|
298 (setq doc (and doc (help-do-arg-highlight doc args)))))) |
50b878285992
(help-argument-name): Default to italic.
Juanma Barranquero <lekktu@gmail.com>
parents:
55457
diff
changeset
|
299 ;; Return value is like the one from help-split-fundoc, but highlighted |
50b878285992
(help-argument-name): Default to italic.
Juanma Barranquero <lekktu@gmail.com>
parents:
55457
diff
changeset
|
300 (cons usage doc)) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
301 |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
302 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
303 (defun describe-function-1 (function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
304 (let* ((def (if (symbolp function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
305 (symbol-function function) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
306 function)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
307 file-name string |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
308 (beg (if (commandp def) "an interactive " "a "))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
309 (setq string |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
310 (cond ((or (stringp def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
311 (vectorp def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
312 "a keyboard macro") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
313 ((subrp def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
314 (if (eq 'unevalled (cdr (subr-arity def))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
315 (concat beg "special form") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
316 (concat beg "built-in function"))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
317 ((byte-code-function-p def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
318 (concat beg "compiled Lisp function")) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
319 ((symbolp def) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
320 (while (symbolp (symbol-function def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
321 (setq def (symbol-function def))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
322 (format "an alias for `%s'" def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
323 ((eq (car-safe def) 'lambda) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
324 (concat beg "Lisp function")) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
325 ((eq (car-safe def) 'macro) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
326 "a Lisp macro") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
327 ((eq (car-safe def) 'autoload) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
328 (setq file-name (nth 1 def)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
329 (format "%s autoloaded %s" |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
330 (if (commandp def) "an interactive" "an") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
331 (if (eq (nth 4 def) 'keymap) "keymap" |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
332 (if (nth 4 def) "Lisp macro" "Lisp function")) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
333 )) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
334 ((keymapp def) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
335 (let ((is-full nil) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
336 (elts (cdr-safe def))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
337 (while elts |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
338 (if (char-table-p (car-safe elts)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
339 (setq is-full t |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
340 elts nil)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
341 (setq elts (cdr-safe elts))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
342 (if is-full |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
343 "a full keymap" |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
344 "a sparse keymap"))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
345 (t ""))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
346 (princ string) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
347 (with-current-buffer standard-output |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
348 (save-excursion |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
349 (save-match-data |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
350 (if (re-search-backward "alias for `\\([^`']+\\)'" nil t) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
351 (help-xref-button 1 'help-function def))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
352 (or file-name |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
353 (setq file-name (symbol-file function))) |
45193
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
354 (when (equal file-name "loaddefs.el") |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
355 ;; Find the real def site of the preloaded function. |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
356 ;; This is necessary only for defaliases. |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
357 (let ((location |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
358 (condition-case nil |
45975
7ea38f55545b
(describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45193
diff
changeset
|
359 (find-function-search-for-symbol function nil "loaddefs.el") |
45193
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
360 (error nil)))) |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
361 (when location |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
362 (with-current-buffer (car location) |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
363 (goto-char (cdr location)) |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
364 (when (re-search-backward |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
365 "^;;; Generated autoloads from \\(.*\\)" nil t) |
3431e29f1d9c
(describe-function-1): If the source is `loaddefs.el', look for the
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44291
diff
changeset
|
366 (setq file-name (match-string 1))))))) |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
367 (when (and (null file-name) (subrp def)) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
368 ;; Find the C source file name. |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
369 (setq file-name (if (get-buffer " *DOC*") |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
370 (help-C-file-name def 'subr) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
371 'C-source))) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
372 (when file-name |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
373 (princ " in `") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
374 ;; We used to add .el to the file name, |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
375 ;; but that's completely wrong when the user used load-file. |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
376 (princ (if (eq file-name 'C-source) "C source code" file-name)) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
377 (princ "'") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
378 ;; Make a hyperlink to the library. |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
379 (with-current-buffer standard-output |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
380 (save-excursion |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
381 (re-search-backward "`\\([^`']+\\)'" nil t) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
382 (help-xref-button 1 'help-function-def function file-name)))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
383 (princ ".") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
384 (terpri) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
385 (when (commandp function) |
49757
9fe119b14379
Renamed remap-command to command-remapping. All uses changed.
Kim F. Storm <storm@cua.dk>
parents:
49747
diff
changeset
|
386 (let* ((remapped (command-remapping function)) |
43157
c72ba425c038
(describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents:
42591
diff
changeset
|
387 (keys (where-is-internal |
55009
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
388 (or remapped function) overriding-local-map nil nil)) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
389 non-modified-keys) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
390 ;; Which non-control non-meta keys run this command? |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
391 (dolist (key keys) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
392 (if (member (event-modifiers (aref key 0)) '(nil (shift))) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
393 (push key non-modified-keys))) |
43157
c72ba425c038
(describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents:
42591
diff
changeset
|
394 (when remapped |
c72ba425c038
(describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents:
42591
diff
changeset
|
395 (princ "It is remapped to `") |
c72ba425c038
(describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents:
42591
diff
changeset
|
396 (princ (symbol-name remapped)) |
c72ba425c038
(describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents:
42591
diff
changeset
|
397 (princ "'")) |
55009
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
398 |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
399 (when keys |
43157
c72ba425c038
(describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents:
42591
diff
changeset
|
400 (princ (if remapped " which is bound to " "It is bound to ")) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
401 ;; FIXME: This list can be very long (f.ex. for self-insert-command). |
55009
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
402 ;; If there are many, remove them from KEYS. |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
403 (if (< (length non-modified-keys) 10) |
55290
8037f1969898
(help-add-fundoc-usage): Use %S instead of %s to format arglist so default
Juanma Barranquero <lekktu@gmail.com>
parents:
55234
diff
changeset
|
404 (princ (mapconcat 'key-description keys ", ")) |
55009
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
405 (dolist (key non-modified-keys) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
406 (setq keys (delq key keys))) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
407 (if keys |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
408 (progn |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
409 (princ (mapconcat 'key-description keys ", ")) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
410 (princ ", and many ordinary text characters")) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
411 (princ "many ordinary text characters")))) |
10f2535aa14e
(describe-function-1): If many non-control non-meta
Richard M. Stallman <rms@gnu.org>
parents:
54980
diff
changeset
|
412 (when (or remapped keys non-modified-keys) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
413 (princ ".") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
414 (terpri)))) |
46439
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
415 (let* ((arglist (help-function-arglist def)) |
255c2fbbad1f
(help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46393
diff
changeset
|
416 (doc (documentation function)) |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
417 (usage (help-split-fundoc doc function))) |
55351
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
418 (with-current-buffer standard-output |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
419 ;; If definition is a keymap, skip arglist note. |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
420 (unless (keymapp def) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
421 (let* ((use (cond |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
422 (usage (setq doc (cdr usage)) (car usage)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
423 ((listp arglist) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
424 (format "%S" (help-make-usage function arglist))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
425 ((stringp arglist) arglist) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
426 ;; Maybe the arglist is in the docstring of the alias. |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
427 ((let ((fun function)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
428 (while (and (symbolp fun) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
429 (setq fun (symbol-function fun)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
430 (not (setq usage (help-split-fundoc |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
431 (documentation fun) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
432 function))))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
433 usage) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
434 (car usage)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
435 ((or (stringp def) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
436 (vectorp def)) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
437 (format "\nMacro: %s" (format-kbd-macro def))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
438 (t "[Missing arglist. Please make a bug report.]"))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
439 (high (help-highlight-arguments use doc))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
440 (insert (car high) "\n") |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
441 (setq doc (cdr high)))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
442 (let ((obsolete (and |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
443 ;; function might be a lambda construct. |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
444 (symbolp function) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
445 (get function 'byte-obsolete-info)))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
446 (when obsolete |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
447 (princ "\nThis function is obsolete") |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
448 (when (nth 2 obsolete) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
449 (insert (format " since %s" (nth 2 obsolete)))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
450 (insert ";\n" |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
451 (if (stringp (car obsolete)) (car obsolete) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
452 (format "use `%s' instead." (car obsolete))) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
453 "\n")) |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
454 (insert "\n" |
07c85e772ee2
(help-argument-name): New face, inheriting from
Juanma Barranquero <lekktu@gmail.com>
parents:
55290
diff
changeset
|
455 (or doc "Not documented."))))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
456 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
457 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
458 ;; Variables |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
459 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
460 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
461 (defun variable-at-point () |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
462 "Return the bound variable symbol found around point. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
463 Return 0 if there is no such symbol." |
56884
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
464 (or (condition-case () |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
465 (with-syntax-table emacs-lisp-mode-syntax-table |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
466 (save-excursion |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
467 (or (not (zerop (skip-syntax-backward "_w"))) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
468 (eq (char-syntax (following-char)) ?w) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
469 (eq (char-syntax (following-char)) ?_) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
470 (forward-sexp -1)) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
471 (skip-chars-forward "'") |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
472 (let ((obj (read (current-buffer)))) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
473 (and (symbolp obj) (boundp obj) obj)))) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
474 (error nil)) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
475 (let* ((str (find-tag-default)) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
476 (obj (if str (read str)))) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
477 (and (symbolp obj) (boundp obj) obj)) |
69c4e722e542
(variable-at-point): Try `find-tag-default' when other methods failed.
Juri Linkov <juri@jurta.org>
parents:
55958
diff
changeset
|
478 0)) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
479 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
480 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
481 (defun describe-variable (variable &optional buffer) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
482 "Display the full documentation of VARIABLE (a symbol). |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
483 Returns the documentation as a string, also. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
484 If VARIABLE has a buffer-local value in BUFFER (default to the current buffer), |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
485 it is displayed along with the global value." |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
486 (interactive |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
487 (let ((v (variable-at-point)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
488 (enable-recursive-minibuffers t) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
489 val) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
490 (setq val (completing-read (if (symbolp v) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
491 (format |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
492 "Describe variable (default %s): " v) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
493 "Describe variable: ") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
494 obarray 'boundp t nil nil |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
495 (if (symbolp v) (symbol-name v)))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
496 (list (if (equal val "") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
497 v (intern val))))) |
45975
7ea38f55545b
(describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45193
diff
changeset
|
498 (unless (buffer-live-p buffer) (setq buffer (current-buffer))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
499 (if (not (symbolp variable)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
500 (message "You did not specify a variable") |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
501 (save-excursion |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
502 (let* ((valvoid (not (with-current-buffer buffer (boundp variable)))) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
503 ;; Extract the value before setting up the output buffer, |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
504 ;; in case `buffer' *is* the output buffer. |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
505 (val (unless valvoid (buffer-local-value variable buffer)))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
506 (help-setup-xref (list #'describe-variable variable buffer) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
507 (interactive-p)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
508 (with-output-to-temp-buffer (help-buffer) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
509 (with-current-buffer buffer |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
510 (prin1 variable) |
46901
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
511 (if valvoid |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
512 (princ " is void") |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
513 (with-current-buffer standard-output |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
514 (princ "'s value is ") |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
515 (terpri) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
516 (let ((from (point))) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
517 (pp val) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
518 (help-xref-on-pp from (point)) |
3e733b163fd4
(locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46827
diff
changeset
|
519 (if (< (point) (+ from 20)) |
46957
ac5b720640e7
(help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
46901
diff
changeset
|
520 (delete-region (1- from) from))))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
521 (terpri) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
522 (when (local-variable-p variable) |
50967
c2440710e1c4
(describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50841
diff
changeset
|
523 (princ (format "%socal in buffer %s; " |
c2440710e1c4
(describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50841
diff
changeset
|
524 (if (get variable 'permanent-local) |
c2440710e1c4
(describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50841
diff
changeset
|
525 "Permanently l" "L") |
c2440710e1c4
(describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50841
diff
changeset
|
526 (buffer-name))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
527 (if (not (default-boundp variable)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
528 (princ "globally void") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
529 (let ((val (default-value variable))) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
530 (with-current-buffer standard-output |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
531 (princ "global value is ") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
532 (terpri) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
533 ;; Fixme: pp can take an age if you happen to |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
534 ;; ask for a very large expression. We should |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
535 ;; probably print it raw once and check it's a |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
536 ;; sensible size before prettyprinting. -- fx |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
537 (let ((from (point))) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
538 (pp val) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
539 (help-xref-on-pp from (point)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
540 (if (< (point) (+ from 20)) |
45975
7ea38f55545b
(describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45193
diff
changeset
|
541 (delete-region (1- from) from)))))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
542 (terpri)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
543 (terpri) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
544 (with-current-buffer standard-output |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
545 (when (> (count-lines (point-min) (point-max)) 10) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
546 ;; Note that setting the syntax table like below |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
547 ;; makes forward-sexp move over a `'s' at the end |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
548 ;; of a symbol. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
549 (set-syntax-table emacs-lisp-mode-syntax-table) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
550 (goto-char (point-min)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
551 (if valvoid |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
552 (forward-line 1) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
553 (forward-sexp 1) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
554 (delete-region (point) (progn (end-of-line) (point))) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
555 (save-excursion |
57484
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
556 (insert "\n\nValue:") |
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
557 (set (make-local-variable 'help-button-cache) |
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
558 (point-marker))) |
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
559 (insert " value is shown ") |
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
560 (insert-button "below" |
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
561 'action help-button-cache |
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
562 'help-echo "mouse-2, RET: show value") |
24f213302267
(describe-variable): Use it to make "below" a hyperlink.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
56884
diff
changeset
|
563 (insert ".\n\n"))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
564 ;; Add a note for variables that have been make-var-buffer-local. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
565 (when (and (local-variable-if-set-p variable) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
566 (or (not (local-variable-p variable)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
567 (with-temp-buffer |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
568 (local-variable-if-set-p variable)))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
569 (save-excursion |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
570 (forward-line -1) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
571 (insert "Automatically becomes buffer-local when set in any fashion.\n")))) |
46321
1d8304aae3cc
(describe-variable): Put `defvaralias' info before the documentation (patch from
Juanma Barranquero <lekktu@gmail.com>
parents:
46312
diff
changeset
|
572 ;; Mention if it's an alias |
46389
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
573 (let* ((alias (condition-case nil |
46321
1d8304aae3cc
(describe-variable): Put `defvaralias' info before the documentation (patch from
Juanma Barranquero <lekktu@gmail.com>
parents:
46312
diff
changeset
|
574 (indirect-variable variable) |
46389
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
575 (error variable))) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
576 (obsolete (get variable 'byte-obsolete-variable)) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
577 (doc (or (documentation-property variable 'variable-documentation) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
578 (documentation-property alias 'variable-documentation)))) |
46321
1d8304aae3cc
(describe-variable): Put `defvaralias' info before the documentation (patch from
Juanma Barranquero <lekktu@gmail.com>
parents:
46312
diff
changeset
|
579 (unless (eq alias variable) |
1d8304aae3cc
(describe-variable): Put `defvaralias' info before the documentation (patch from
Juanma Barranquero <lekktu@gmail.com>
parents:
46312
diff
changeset
|
580 (princ (format "This variable is an alias for `%s'." alias)) |
1d8304aae3cc
(describe-variable): Put `defvaralias' info before the documentation (patch from
Juanma Barranquero <lekktu@gmail.com>
parents:
46312
diff
changeset
|
581 (terpri) |
46389
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
582 (terpri)) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
583 (when obsolete |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
584 (princ "This variable is obsolete") |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
585 (if (cdr obsolete) (princ (format " since %s" (cdr obsolete)))) |
46393
4f6ec0250812
(describe-variable): Remove useless trailing whitespace.
Juanma Barranquero <lekktu@gmail.com>
parents:
46389
diff
changeset
|
586 (princ ";") (terpri) |
46389
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
587 (princ (if (stringp (car obsolete)) (car obsolete) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
588 (format "use `%s' instead." (car obsolete)))) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
589 (terpri) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
590 (terpri)) |
51248f96252a
(describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents:
46334
diff
changeset
|
591 (princ (or doc "Not documented as a variable."))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
592 ;; Make a link to customize if this variable can be customized. |
49102
8f2b5f65ebd1
(describe-variable): Use custom-variable-p.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
48477
diff
changeset
|
593 (if (custom-variable-p variable) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
594 (let ((customize-label "customize")) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
595 (terpri) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
596 (terpri) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
597 (princ (concat "You can " customize-label " this variable.")) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
598 (with-current-buffer standard-output |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
599 (save-excursion |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
600 (re-search-backward |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
601 (concat "\\(" customize-label "\\)") nil t) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
602 (help-xref-button 1 'help-customize-variable variable))))) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
603 ;; Make a hyperlink to the library if appropriate. (Don't |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
604 ;; change the format of the buffer's initial line in case |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
605 ;; anything expects the current format.) |
48477
2107f1adf452
(describe-variable): Look for (defvar . <sym>) in the
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
47663
diff
changeset
|
606 (let ((file-name (symbol-file (cons 'defvar variable)))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
607 (when (equal file-name "loaddefs.el") |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
608 ;; Find the real def site of the preloaded variable. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
609 (let ((location |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
610 (condition-case nil |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
611 (find-variable-noselect variable file-name) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
612 (error nil)))) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
613 (when location |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
614 (with-current-buffer (car location) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
615 (goto-char (cdr location)) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
616 (when (re-search-backward |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
617 "^;;; Generated autoloads from \\(.*\\)" nil t) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
618 (setq file-name (match-string 1))))))) |
54749
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
619 (when (and (null file-name) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
620 (integerp (get variable 'variable-documentation))) |
f7424850240d
(help-C-source-directory): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54092
diff
changeset
|
621 ;; It's a variable not defined in Elisp but in C. |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
622 (setq file-name |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
623 (if (get-buffer " *DOC*") |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
624 (help-C-file-name variable 'var) |
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
625 'C-source))) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
626 (when file-name |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
627 (princ "\n\nDefined in `") |
55234
fde56fd631fc
(help-C-file-name): Use new subr-name.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
55009
diff
changeset
|
628 (princ (if (eq file-name 'C-source) "C source code" file-name)) |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
629 (princ "'.") |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
630 (with-current-buffer standard-output |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
631 (save-excursion |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
632 (re-search-backward "`\\([^`']+\\)'" nil t) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
633 (help-xref-button 1 'help-variable-def |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
634 variable file-name))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
635 |
42591
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
636 (print-help-return-message) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
637 (save-excursion |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
638 (set-buffer standard-output) |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
639 ;; Return the text we displayed. |
668b6361c3c4
(describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents:
42265
diff
changeset
|
640 (buffer-string)))))))) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
641 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
642 |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
643 ;;;###autoload |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
644 (defun describe-syntax (&optional buffer) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
645 "Describe the syntax specifications in the syntax table of BUFFER. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
646 The descriptions are inserted in a help buffer, which is then displayed. |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
647 BUFFER defaults to the current buffer." |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
648 (interactive) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
649 (setq buffer (or buffer (current-buffer))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
650 (help-setup-xref (list #'describe-syntax buffer) (interactive-p)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
651 (with-output-to-temp-buffer (help-buffer) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
652 (let ((table (with-current-buffer buffer (syntax-table)))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
653 (with-current-buffer standard-output |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
654 (describe-vector table 'internal-describe-syntax-value) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
655 (while (setq table (char-table-parent table)) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
656 (insert "\nThe parent syntax table is:") |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
657 (describe-vector table 'internal-describe-syntax-value)))))) |
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
658 |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
659 (defun help-describe-category-set (value) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
660 (insert (cond |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
661 ((null value) "default") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
662 ((char-table-p value) "deeper char-table ...") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
663 (t (condition-case err |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
664 (category-set-mnemonics value) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
665 (error "invalid")))))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
666 |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
667 ;;;###autoload |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
668 (defun describe-categories (&optional buffer) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
669 "Describe the category specifications in the current category table. |
54092
bce4d57a18d7
(describe-categories): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
670 The descriptions are inserted in a buffer, which is then displayed. |
bce4d57a18d7
(describe-categories): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
671 If BUFFER is non-nil, then describe BUFFER's category table instead. |
bce4d57a18d7
(describe-categories): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
672 BUFFER should be a buffer or a buffer name." |
41600
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
673 (interactive) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
674 (setq buffer (or buffer (current-buffer))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
675 (help-setup-xref (list #'describe-categories buffer) (interactive-p)) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
676 (with-output-to-temp-buffer (help-buffer) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
677 (let ((table (with-current-buffer buffer (category-table)))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
678 (with-current-buffer standard-output |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
679 (describe-vector table 'help-describe-category-set) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
680 (let ((docs (char-table-extra-slot table 0))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
681 (if (or (not (vectorp docs)) (/= (length docs) 95)) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
682 (insert "Invalid first extra slot in this char table\n") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
683 (insert "Meanings of mnemonic characters are:\n") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
684 (dotimes (i 95) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
685 (let ((elt (aref docs i))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
686 (when elt |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
687 (insert (+ i ?\ ) ": " elt "\n")))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
688 (while (setq table (char-table-parent table)) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
689 (insert "\nThe parent category table is:") |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
690 (describe-vector table 'help-describe-category-set)))))))) |
037ba6ecc02a
(describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41584
diff
changeset
|
691 |
41584
8b64dc23e305
Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents:
41583
diff
changeset
|
692 (provide 'help-fns) |
41583
fbe606fb3351
Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff
changeset
|
693 |
52401 | 694 ;;; arch-tag: 9e10331c-ae81-4d13-965d-c4819aaab0b3 |
41584
8b64dc23e305
Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents:
41583
diff
changeset
|
695 ;;; help-fns.el ends here |