annotate lisp/help-fns.el @ 83430:10f26433fe3f

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