annotate lisp/help-fns.el @ 53898:d9e22d65acd3

*** empty log message ***
author Kim F. Storm <storm@cua.dk>
date Mon, 09 Feb 2004 09:17:22 +0000
parents 695cf19ef79e
children bce4d57a18d7 375f2633d815
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
50967
c2440710e1c4 (describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50841
diff changeset
3 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001, 2002, 2003
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
47236
debd2b1e4d08 (help-with-tutorial): Properly set up
Richard M. Stallman <rms@gnu.org>
parents: 46957
diff changeset
48 (let ((minibuffer-setup-hook minibuffer-setup-hook))
debd2b1e4d08 (help-with-tutorial): Properly set up
Richard M. Stallman <rms@gnu.org>
parents: 46957
diff changeset
49 (add-hook 'minibuffer-setup-hook
47663
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
50 'minibuffer-completion-help)
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
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))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
66 (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
67 (search-forward "\n<<")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
68 (beginning-of-line)
44291
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
69 ;; Convert the <<...>> line to the proper [...] line,
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
70 ;; 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
71 (cond ((save-excursion
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
72 (forward-line 1)
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
73 (looking-at "\\["))
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
74 (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
75 ((looking-at "<<Blank lines inserted.*>>")
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
76 (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
77 (t
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
78 (looking-at "<<")
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
79 (replace-match "[")
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
80 (search-forward ">>")
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
81 (replace-match "]")))
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
82 (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
83 (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
84 (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
85 6)))
44291
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
86 (if (< n 8)
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
87 (progn
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
88 ;; 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
89 ;; so delete it.
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
90 (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
91 (newline n))
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
92 ;; 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
93 (newline (/ n 2))
49588
37645a051842 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49102
diff changeset
94
44291
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
95 ;; Skip the [...] line (don't delete it).
cf7a8ea9f88d (help-with-tutorial): Allow various ways
Richard M. Stallman <rms@gnu.org>
parents: 43499
diff changeset
96 (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
97 (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
98 (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
99 (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
100
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
101 ;;;###autoload
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
102 (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
103 "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
104 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
105 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
106 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
107 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
108
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
109 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
110 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
111
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
112 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
113 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
114 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
115 (interactive (list (completing-read "Locate library: "
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
116 'locate-file-completion
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
117 (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
118 nil nil
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
119 t))
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
120 (let ((file (locate-file library
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
121 (or path load-path)
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
122 (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
123 (if interactive-call
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
124 (if file
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
125 (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
126 (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
127 file))
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
128
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 ;; Functions
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
131
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
132 ;;;###autoload
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
133 (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
134 "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
135 (interactive
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
136 (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
137 (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
138 val)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
139 (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
140 (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
141 "Describe function: ")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
142 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
143 (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
144 fn (intern val)))))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
145 (if (null function)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
146 (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
147 (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
148 (save-excursion
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
149 (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
150 (prin1 function)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
151 ;; 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
152 ;; 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
153 (princ " is ")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
154 (describe-function-1 function)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
155 (print-help-return-message)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
156 (with-current-buffer standard-output
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
157 ;; Return the text we displayed.
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
158 (buffer-string))))))
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
159
46957
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
160 (defun help-split-fundoc (doc def)
46439
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
161 "Split a function docstring DOC 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
162 Return (USAGE . DOC) or nil if there's no usage info.
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
163 DEF is the function whose usage we're looking for in DOC."
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
164 ;; 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
165 ;; 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
166 ;; 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
167 ;; function name instead.
47663
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
168 (when (and doc (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" doc))
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
169 (cons (format "(%s%s"
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
170 ;; 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
171 (if (consp def) "anonymous" def)
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
172 (match-string 1 doc))
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
173 (substring doc 0 (match-beginning 0)))))
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
174
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
175 (defun help-add-fundoc-usage (doc arglist)
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
176 "Add the usage info to the docstring DOC.
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
177 If DOC already has a usage info, then just return DOC unchanged.
50799
80f5ff945c90 (help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50559
diff changeset
178 The usage info is built from ARGLIST. DOC can be nil.
50841
e19ad6e42e63 (help-add-fundoc-usage): Use t for "no arglist".
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50799
diff changeset
179 ARGLIST can also be t or a string of the form \"(fun ARG1 ARG2 ...)\"."
47663
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
180 (unless (stringp doc) (setq doc "Not documented"))
50841
e19ad6e42e63 (help-add-fundoc-usage): Use t for "no arglist".
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50799
diff changeset
181 (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" doc) (eq arglist t))
47663
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
182 doc
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
183 (format "%s%s%s" doc
e9121795960f (help-with-tutorial): Use minibuffer-completion-help.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47236
diff changeset
184 (if (string-match "\n?\n\\'" doc)
50559
4975a5944969 (help-add-fundoc-usage): Pass an empty string to `format' if
John Paul Wallington <jpw@pobox.com>
parents: 49757
diff changeset
185 (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
186 "\n\n")
50799
80f5ff945c90 (help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50559
diff changeset
187 (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
188 (string-match "\\`([^ ]+\\(.*\\))\\'" arglist))
80f5ff945c90 (help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50559
diff changeset
189 (concat "(fn" (match-string 1 arglist) ")")
80f5ff945c90 (help-add-fundoc-usage): Allow arglist to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50559
diff changeset
190 (help-make-usage 'fn arglist)))))
46439
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
191
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
192 (defun help-function-arglist (def)
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
193 ;; Handle symbols aliased to other symbols.
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
194 (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
195 ;; 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
196 (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
197 (cond
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
198 ((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
199 ((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
200 ((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
201 "[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
202 (t t)))
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
203
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
204 (defun help-make-usage (function arglist)
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
205 (cons (if (symbolp function) function 'anonymous)
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
206 (mapcar (lambda (arg)
46957
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
207 (if (not (symbolp arg))
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
208 (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
209 ;; 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
210 (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
211 (cdr arg))
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
212 arg)
46439
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
213 (let ((name (symbol-name arg)))
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
214 (if (string-match "\\`&" name) arg
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
215 (intern (upcase name))))))
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
216 arglist)))
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
217
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
218 ;;;###autoload
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
219 (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
220 (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
221 (symbol-function function)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
222 function))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
223 file-name string
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
224 (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
225 (setq string
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
226 (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
227 (vectorp def))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
228 "a keyboard macro")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
229 ((subrp def)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
230 (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
231 (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
232 (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
233 ((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
234 (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
235 ((symbolp def)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
236 (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
237 (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
238 (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
239 ((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
240 (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
241 ((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
242 "a Lisp macro")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
243 ((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
244 (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
245 (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
246 (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
247 (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
248 (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
249 ))
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
250 ((keymapp def)
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
251 (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
252 (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
253 (while elts
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
254 (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
255 (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
256 elts nil))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
257 (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
258 (if is-full
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
259 "a full keymap"
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
260 "a sparse keymap")))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
261 (t "")))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
262 (princ string)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
263 (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
264 (save-excursion
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
265 (save-match-data
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
266 (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
267 (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
268 (or file-name
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
269 (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
270 (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
271 ;; 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
272 ;; 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
273 (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
274 (condition-case nil
45975
7ea38f55545b (describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45193
diff changeset
275 (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
276 (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
277 (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
278 (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
279 (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
280 (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
281 "^;;; 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
282 (setq file-name (match-string 1)))))))
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
283 (cond
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
284 (file-name
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
285 (princ " in `")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
286 ;; 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
287 ;; but that's completely wrong when the user used load-file.
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
288 (princ file-name)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
289 (princ "'")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
290 ;; 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
291 (with-current-buffer standard-output
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
292 (save-excursion
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
293 (re-search-backward "`\\([^`']+\\)'" nil t)
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
294 (help-xref-button 1 'help-function-def function file-name)))))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
295 (princ ".")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
296 (terpri)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
297 (when (commandp function)
49757
9fe119b14379 Renamed remap-command to command-remapping. All uses changed.
Kim F. Storm <storm@cua.dk>
parents: 49747
diff changeset
298 (let* ((remapped (command-remapping function))
43157
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
299 (keys (where-is-internal
49757
9fe119b14379 Renamed remap-command to command-remapping. All uses changed.
Kim F. Storm <storm@cua.dk>
parents: 49747
diff changeset
300 (or remapped function) overriding-local-map nil nil)))
43157
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
301 (when remapped
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
302 (princ "It is remapped to `")
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
303 (princ (symbol-name remapped))
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
304 (princ "'"))
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
305 (when keys
43157
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
306 (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
307 ;; FIXME: This list can be very long (f.ex. for self-insert-command).
43157
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
308 (princ (mapconcat 'key-description keys ", ")))
c72ba425c038 (describe-function-1): Report remapped commands.
Kim F. Storm <storm@cua.dk>
parents: 42591
diff changeset
309 (when (or remapped keys)
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
310 (princ ".")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
311 (terpri))))
46439
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
312 (let* ((arglist (help-function-arglist def))
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
313 (doc (documentation function))
46957
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
314 (usage (help-split-fundoc doc function)))
46827
cc564ceab7c2 (describe-function-1): Skip arglist note if
John Paul Wallington <jpw@pobox.com>
parents: 46765
diff changeset
315 ;; If definition is a keymap, skip arglist note.
cc564ceab7c2 (describe-function-1): Skip arglist note if
John Paul Wallington <jpw@pobox.com>
parents: 46765
diff changeset
316 (unless (keymapp def)
cc564ceab7c2 (describe-function-1): Skip arglist note if
John Paul Wallington <jpw@pobox.com>
parents: 46765
diff changeset
317 (princ (cond
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
318 (usage (setq doc (cdr usage)) (car usage))
46827
cc564ceab7c2 (describe-function-1): Skip arglist note if
John Paul Wallington <jpw@pobox.com>
parents: 46765
diff changeset
319 ((listp arglist) (help-make-usage function arglist))
cc564ceab7c2 (describe-function-1): Skip arglist note if
John Paul Wallington <jpw@pobox.com>
parents: 46765
diff changeset
320 ((stringp arglist) arglist)
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
321 ;; Maybe the arglist is in the docstring of the alias.
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
322 ((let ((fun function))
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
323 (while (and (symbolp fun)
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
324 (setq fun (symbol-function fun))
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
325 (not (setq usage (help-split-fundoc
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
326 (documentation fun)
46957
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
327 function)))))
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
328 usage)
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
329 (car usage))
49747
12970d0f7f60 (describe-function-1): Change output for keyboard macros.
Juanma Barranquero <lekktu@gmail.com>
parents: 49588
diff changeset
330 ((or (stringp def)
12970d0f7f60 (describe-function-1): Change output for keyboard macros.
Juanma Barranquero <lekktu@gmail.com>
parents: 49588
diff changeset
331 (vectorp def))
12970d0f7f60 (describe-function-1): Change output for keyboard macros.
Juanma Barranquero <lekktu@gmail.com>
parents: 49588
diff changeset
332 (format "\nMacro: %s" (format-kbd-macro def)))
46827
cc564ceab7c2 (describe-function-1): Skip arglist note if
John Paul Wallington <jpw@pobox.com>
parents: 46765
diff changeset
333 (t "[Missing arglist. Please make a bug report.]")))
cc564ceab7c2 (describe-function-1): Skip arglist note if
John Paul Wallington <jpw@pobox.com>
parents: 46765
diff changeset
334 (terpri))
46765
af4505d3e0f8 (describe-function-1): Test function for obsolescence only if it is a
Markus Rost <rost@math.uni-bielefeld.de>
parents: 46486
diff changeset
335 (let ((obsolete (and
af4505d3e0f8 (describe-function-1): Test function for obsolescence only if it is a
Markus Rost <rost@math.uni-bielefeld.de>
parents: 46486
diff changeset
336 ;; function might be a lambda construct.
af4505d3e0f8 (describe-function-1): Test function for obsolescence only if it is a
Markus Rost <rost@math.uni-bielefeld.de>
parents: 46486
diff changeset
337 (symbolp function)
af4505d3e0f8 (describe-function-1): Test function for obsolescence only if it is a
Markus Rost <rost@math.uni-bielefeld.de>
parents: 46486
diff changeset
338 (get function 'byte-obsolete-info))))
46439
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
339 (when obsolete
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
340 (terpri)
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
341 (princ "This function is obsolete")
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
342 (if (nth 2 obsolete) (princ (format " since %s" (nth 2 obsolete))))
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
343 (princ ";") (terpri)
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
344 (princ (if (stringp (car obsolete)) (car obsolete)
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
345 (format "use `%s' instead." (car obsolete))))
255c2fbbad1f (help-split-fundoc, help-function-arglist)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46393
diff changeset
346 (terpri)))
46486
521c1e2e7512 (describe-function-1): Put empty line before "Not documented" text.
Juanma Barranquero <lekktu@gmail.com>
parents: 46439
diff changeset
347 (terpri)
521c1e2e7512 (describe-function-1): Put empty line before "Not documented" text.
Juanma Barranquero <lekktu@gmail.com>
parents: 46439
diff changeset
348 (princ (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
349
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
350
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
351 ;; Variables
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
352
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
353 ;;;###autoload
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
354 (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
355 "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
356 Return 0 if there is no such symbol."
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
357 (condition-case ()
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
358 (with-syntax-table emacs-lisp-mode-syntax-table
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
359 (save-excursion
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
360 (or (not (zerop (skip-syntax-backward "_w")))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
361 (eq (char-syntax (following-char)) ?w)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
362 (eq (char-syntax (following-char)) ?_)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
363 (forward-sexp -1))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
364 (skip-chars-forward "'")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
365 (let ((obj (read (current-buffer))))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
366 (or (and (symbolp obj) (boundp obj) obj)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
367 0))))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
368 (error 0)))
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
369
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
370 ;;;###autoload
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
371 (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
372 "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
373 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
374 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
375 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
376 (interactive
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
377 (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
378 (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
379 val)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
380 (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
381 (format
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
382 "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
383 "Describe variable: ")
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
384 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
385 (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
386 (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
387 v (intern val)))))
45975
7ea38f55545b (describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45193
diff changeset
388 (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
389 (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
390 (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
391 (save-excursion
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
392 (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
393 ;; 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
394 ;; in case `buffer' *is* the output buffer.
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
395 (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
396 (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
397 (interactive-p))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
398 (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
399 (with-current-buffer buffer
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
400 (prin1 variable)
46901
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
401 (if valvoid
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
402 (princ " is void")
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
403 (with-current-buffer standard-output
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
404 (princ "'s value is ")
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
405 (terpri)
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
406 (let ((from (point)))
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
407 (pp val)
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
408 (help-xref-on-pp from (point))
3e733b163fd4 (locate-library): Use locate-file(-completion).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46827
diff changeset
409 (if (< (point) (+ from 20))
46957
ac5b720640e7 (help-split-fundoc): Replace the function name
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46901
diff changeset
410 (delete-region (1- from) from)))))
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
411 (terpri)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
412 (when (local-variable-p variable)
50967
c2440710e1c4 (describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50841
diff changeset
413 (princ (format "%socal in buffer %s; "
c2440710e1c4 (describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50841
diff changeset
414 (if (get variable 'permanent-local)
c2440710e1c4 (describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50841
diff changeset
415 "Permanently l" "L")
c2440710e1c4 (describe-variable): Mention permanent local status.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50841
diff changeset
416 (buffer-name)))
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
417 (if (not (default-boundp variable))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
418 (princ "globally void")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
419 (let ((val (default-value variable)))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
420 (with-current-buffer standard-output
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
421 (princ "global value is ")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
422 (terpri)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
423 ;; 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
424 ;; 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
425 ;; 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
426 ;; sensible size before prettyprinting. -- fx
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
427 (let ((from (point)))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
428 (pp val)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
429 (help-xref-on-pp from (point))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
430 (if (< (point) (+ from 20))
45975
7ea38f55545b (describe-variable): Only use `buffer' is still live.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45193
diff changeset
431 (delete-region (1- from) from))))))
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
432 (terpri))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
433 (terpri)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
434 (with-current-buffer standard-output
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
435 (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
436 ;; 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
437 ;; 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
438 ;; of a symbol.
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
439 (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
440 (goto-char (point-min))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
441 (if valvoid
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
442 (forward-line 1)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
443 (forward-sexp 1)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
444 (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
445 (insert " value is shown below.\n\n")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
446 (save-excursion
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
447 (insert "\n\nValue:"))))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
448 ;; 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
449 (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
450 (or (not (local-variable-p variable))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
451 (with-temp-buffer
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
452 (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
453 (save-excursion
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
454 (forward-line -1)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
455 (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
456 ;; 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
457 (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
458 (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
459 (error variable)))
51248f96252a (describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents: 46334
diff changeset
460 (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
461 (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
462 (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
463 (unless (eq alias variable)
1d8304aae3cc (describe-variable): Put `defvaralias' info before the documentation (patch from
Juanma Barranquero <lekktu@gmail.com>
parents: 46312
diff changeset
464 (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
465 (terpri)
46389
51248f96252a (describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents: 46334
diff changeset
466 (terpri))
51248f96252a (describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents: 46334
diff changeset
467 (when obsolete
51248f96252a (describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents: 46334
diff changeset
468 (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
469 (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
470 (princ ";") (terpri)
46389
51248f96252a (describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents: 46334
diff changeset
471 (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
472 (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
473 (terpri)
51248f96252a (describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents: 46334
diff changeset
474 (terpri))
51248f96252a (describe-variable): Show documentation for aliased variable if alias does not
Juanma Barranquero <lekktu@gmail.com>
parents: 46334
diff changeset
475 (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
476 ;; 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
477 (if (custom-variable-p variable)
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
478 (let ((customize-label "customize"))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
479 (terpri)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
480 (terpri)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
481 (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
482 (with-current-buffer standard-output
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
483 (save-excursion
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
484 (re-search-backward
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
485 (concat "\\(" customize-label "\\)") nil t)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
486 (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
487 ;; 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
488 ;; 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
489 ;; 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
490 (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
491 (when (equal file-name "loaddefs.el")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
492 ;; 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
493 (let ((location
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
494 (condition-case nil
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
495 (find-variable-noselect variable file-name)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
496 (error nil))))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
497 (when location
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
498 (with-current-buffer (car location)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
499 (goto-char (cdr location))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
500 (when (re-search-backward
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
501 "^;;; Generated autoloads from \\(.*\\)" nil t)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
502 (setq file-name (match-string 1)))))))
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
503 (when file-name
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
504 (princ "\n\nDefined in `")
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
505 (princ file-name)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
506 (princ "'.")
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
507 (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
508 (save-excursion
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
509 (re-search-backward "`\\([^`']+\\)'" nil t)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
510 (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
511 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
512
42591
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
513 (print-help-return-message)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
514 (save-excursion
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
515 (set-buffer standard-output)
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
516 ;; Return the text we displayed.
668b6361c3c4 (describe-variable, describe-function): Do save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 42265
diff changeset
517 (buffer-string))))))))
41583
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
518
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
519
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
520 ;;;###autoload
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
521 (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
522 "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
523 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
524 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
525 (interactive)
fbe606fb3351 Renamed help-funs.el into help-fns.el, at RMS's request.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
526 (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
527 (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
528 (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
529 (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
530 (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
531 (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
532 (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
533 (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
534 (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
535
41600
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
536 (defun help-describe-category-set (value)
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
537 (insert (cond
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
538 ((null value) "default")
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
539 ((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
540 (t (condition-case err
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
541 (category-set-mnemonics value)
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
542 (error "invalid"))))))
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
543
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
544 ;;;###autoload
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
545 (defun describe-categories (&optional buffer)
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
546 "Describe the category specifications in the current category table.
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
547 The descriptions are inserted in a buffer, which is then displayed."
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
548 (interactive)
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
549 (setq buffer (or buffer (current-buffer)))
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
550 (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
551 (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
552 (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
553 (with-current-buffer standard-output
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
554 (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
555 (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
556 (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
557 (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
558 (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
559 (dotimes (i 95)
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
560 (let ((elt (aref docs i)))
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
561 (when elt
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
562 (insert (+ i ?\ ) ": " elt "\n"))))
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
563 (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
564 (insert "\nThe parent category table is:")
037ba6ecc02a (describe-categories, help-describe-category-set): New.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41584
diff changeset
565 (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
566
41584
8b64dc23e305 Change the provide and the header as per the renaming.
Eli Zaretskii <eliz@gnu.org>
parents: 41583
diff changeset
567 (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
568
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 50967
diff changeset
569 ;;; 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
570 ;;; help-fns.el ends here