annotate lisp/emacs-lisp/eldoc.el @ 90751:52a7f3f50b89

Merge from emacs--devo--0 Patches applied: * emacs--devo--0 (patch 624-636) - Update from CVS - Merge from gnus--rel--5.10 * gnus--rel--5.10 (patch 200-201) - Merge from emacs--devo--0 - Update from CVS: lisp/nnweb.el (nnweb-google-parse-1): Update parser. Revision: emacs@sv.gnu.org/emacs--unicode--0--patch-171
author Miles Bader <miles@gnu.org>
date Tue, 13 Feb 2007 12:14:16 +0000
parents 95d0cdf160ea
children d7172f202ab8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
1 ;;; eldoc.el --- show function arglist or variable docstring in echo area
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
2
74466
1d4b1a32fd66 Update copyright years.
Glenn Morris <rgm@gnu.org>
parents: 72737
diff changeset
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
75346
7a3f13e2dd57 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 74466
diff changeset
4 ;; 2005, 2006, 2007 Free Software Foundation, Inc.
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
5
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
6 ;; Author: Noah Friedman <friedman@splode.com>
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
7 ;; Maintainer: friedman@splode.com
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
8 ;; Keywords: extensions
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
9 ;; Created: 1995-10-06
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
10
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
11 ;; This file is part of GNU Emacs.
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
12
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
14 ;; it under the terms of the GNU General Public License as published by
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
15 ;; the Free Software Foundation; either version 2, or (at your option)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
16 ;; any later version.
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
17
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
18 ;; GNU Emacs is distributed in the hope that it will be useful,
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
21 ;; GNU General Public License for more details.
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
22
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
23 ;; You should have received a copy of the GNU General Public License
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64085
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 62486
diff changeset
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18a818a2ee7c Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 62486
diff changeset
26 ;; Boston, MA 02110-1301, USA.
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
27
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
28 ;;; Commentary:
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
29
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
30 ;; This program was inspired by the behavior of the "mouse documentation
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
31 ;; window" on many Lisp Machine systems; as you type a function's symbol
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
32 ;; name as part of a sexp, it will print the argument list for that
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
33 ;; function. Behavior is not identical; for example, you need not actually
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
34 ;; type the function name, you need only move point around in a sexp that
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
35 ;; calls it. Also, if point is over a documented variable, it will print
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
36 ;; the one-line documentation for that variable instead, to remind you of
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
37 ;; that variable's meaning.
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
38
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
39 ;; One useful way to enable this minor mode is to put the following in your
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
40 ;; .emacs:
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
41 ;;
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
42 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-eldoc-mode)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
43 ;; (add-hook 'lisp-interaction-mode-hook 'turn-on-eldoc-mode)
16975
188c4da9bf5d (eldoc-display-message-p): New function.
Noah Friedman <friedman@splode.com>
parents: 16969
diff changeset
44 ;; (add-hook 'ielm-mode-hook 'turn-on-eldoc-mode)
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
45
52445
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
46 ;; Major modes for other languages may use Eldoc by defining an
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
47 ;; appropriate function as the buffer-local value of
61856
86712739476e Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 61855
diff changeset
48 ;; `eldoc-documentation-function'.
52445
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
49
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
50 ;;; Code:
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
51
48470
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
52 (require 'help-fns) ;For fundoc-usage handling functions.
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
53
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
54 (defgroup eldoc nil
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
55 "Show function arglist or variable docstring in echo area."
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
56 :group 'lisp
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
57 :group 'extensions)
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
58
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
59 (defcustom eldoc-idle-delay 0.50
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
60 "*Number of seconds of idle time to wait before printing.
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
61 If user input arrives before this interval of time has elapsed after the
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
62 last input, no documentation will be printed.
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
63
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
64 If this variable is set to 0, no idle time is required."
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
65 :type 'number
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
66 :group 'eldoc)
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
67
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
68 ;;;###autoload
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
69 (defcustom eldoc-minor-mode-string " ElDoc"
42623
365f0cb0170e (eldoc-minor-mode-string): Fix custom type.
Richard M. Stallman <rms@gnu.org>
parents: 41167
diff changeset
70 "*String to display in mode line when Eldoc Mode is enabled; nil for none."
365f0cb0170e (eldoc-minor-mode-string): Fix custom type.
Richard M. Stallman <rms@gnu.org>
parents: 41167
diff changeset
71 :type '(choice string (const :tag "None" nil))
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
72 :group 'eldoc)
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
73
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
74 (defcustom eldoc-argument-case 'upcase
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
75 "Case to display argument names of functions, as a symbol.
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
76 This has two preferred values: `upcase' or `downcase'.
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
77 Actually, any name of a function which takes a string as an argument and
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
78 returns another string is acceptable."
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
79 :type '(radio (function-item upcase)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
80 (function-item downcase)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
81 function)
17445
f2db4e8bb6ed Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17253
diff changeset
82 :group 'eldoc)
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
83
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
84 (defcustom eldoc-echo-area-use-multiline-p 'truncate-sym-name-if-fit
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
85 "*Allow long eldoc messages to resize echo area display.
50853
3a65ede5c70c (eldoc-echo-area-use-multiline-p): Don't quote nil and t in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 49697
diff changeset
86 If value is t, never attempt to truncate messages; complete symbol name
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
87 and function arglist or 1-line variable documentation will be displayed
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
88 even if echo area must be resized to fit.
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
89
50853
3a65ede5c70c (eldoc-echo-area-use-multiline-p): Don't quote nil and t in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 49697
diff changeset
90 If value is any non-nil value other than t, symbol name may be truncated
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
91 if it will enable the function arglist or documentation string to fit on a
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
92 single line without resizing window. Otherwise, behavior is just like
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
93 former case.
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
94
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
95 If value is nil, messages are always truncated to fit in a single line of
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
96 display in the echo area. Function or variable symbol name may be
49697
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
97 truncated to make more of the arglist or documentation string visible."
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
98 :type '(radio (const :tag "Always" t)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
99 (const :tag "Never" nil)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
100 (const :tag "Yes, but truncate symbol names if it will\
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
101 enable argument list to fit on one line" truncate-sym-name-if-fit))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
102 :group 'eldoc)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
103
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
104 ;;; No user options below here.
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
105
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
106 (defvar eldoc-message-commands-table-size 31
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
107 "This is used by eldoc-add-command to initialize eldoc-message-commands
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
108 as an obarray.
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
109 It should probably never be necessary to do so, but if you
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
110 choose to increase the number of buckets, you must do so before loading
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
111 this file since the obarray is initialized at load time.
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
112 Remember to keep it a prime number to improve hash performance.")
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
113
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
114 (defconst eldoc-message-commands
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
115 (make-vector eldoc-message-commands-table-size 0)
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
116 "Commands after which it is appropriate to print in the echo area.
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
117 Eldoc does not try to print function arglists, etc. after just any command,
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
118 because some commands print their own messages in the echo area and these
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
119 functions would instantly overwrite them. But self-insert-command as well
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
120 as most motion commands are good candidates.
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
121 This variable contains an obarray of symbols; do not manipulate it
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
122 directly. Instead, use `eldoc-add-command' and `eldoc-remove-command'.")
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
123
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
124 (defconst eldoc-last-data (make-vector 3 nil)
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
125 "Bookkeeping; elements are as follows:
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
126 0 - contains the last symbol read from the buffer.
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
127 1 - contains the string last displayed in the echo area for that
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
128 symbol, so it can be printed again if necessary without reconsing.
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
129 2 - 'function if function args, 'variable if variable documentation.")
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
130 (defvar eldoc-last-message nil)
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
131
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
132 (defvar eldoc-timer nil "eldoc's timer object.")
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
133
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
134 (defvar eldoc-current-idle-delay eldoc-idle-delay
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
135 "idle time delay currently in use by timer.
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
136 This is used to determine if `eldoc-idle-delay' is changed by the user.")
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
137
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
138
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
139 ;;;###autoload
41167
ae8862effdf5 (eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34127
diff changeset
140 (define-minor-mode eldoc-mode
ae8862effdf5 (eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34127
diff changeset
141 "Toggle ElDoc mode on or off.
61855
bc5bdf5bff56 (eldoc-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 61278
diff changeset
142 In ElDoc mode, the echo area displays information about a
bc5bdf5bff56 (eldoc-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 61278
diff changeset
143 function or variable in the text where point is. If point is
62486
8c229cb5f3ef (eldoc-mode): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62313
diff changeset
144 on a documented variable, it displays the first line of that
8c229cb5f3ef (eldoc-mode): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62313
diff changeset
145 variable's doc string. Otherwise it displays the argument list
8c229cb5f3ef (eldoc-mode): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62313
diff changeset
146 of the function called in the expression point is on.
41167
ae8862effdf5 (eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34127
diff changeset
147
ae8862effdf5 (eldoc-mode): Use define-minor-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 34127
diff changeset
148 With prefix ARG, turn ElDoc mode on if and only if ARG is positive."
61278
83d73d728418 (eldoc-mode): Specify :group.
Lute Kamstra <lute@gnu.org>
parents: 54770
diff changeset
149 :group 'eldoc :lighter eldoc-minor-mode-string
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
150 (setq eldoc-last-message nil)
49697
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
151 (if eldoc-mode
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
152 (progn
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
153 (add-hook 'post-command-hook 'eldoc-schedule-timer nil t)
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
154 (add-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area t))
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
155 (remove-hook 'post-command-hook 'eldoc-schedule-timer)
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
156 (remove-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area)))
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
157
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
158 ;;;###autoload
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
159 (defun turn-on-eldoc-mode ()
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
160 "Unequivocally turn on eldoc-mode (see variable documentation)."
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
161 (interactive)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
162 (eldoc-mode 1))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
163
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
164
16969
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
165 (defun eldoc-schedule-timer ()
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
166 (or (and eldoc-timer
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
167 (memq eldoc-timer timer-idle-list))
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
168 (setq eldoc-timer
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
169 (run-with-idle-timer eldoc-idle-delay t
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
170 'eldoc-print-current-symbol-info)))
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
171
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
172 ;; If user has changed the idle delay, update the timer.
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
173 (cond ((not (= eldoc-idle-delay eldoc-current-idle-delay))
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
174 (setq eldoc-current-idle-delay eldoc-idle-delay)
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
175 (timer-set-idle-time eldoc-timer eldoc-idle-delay t))))
436fd36233d1 Update copyright notice to reflect assignment to FSF and incorporation
Noah Friedman <friedman@splode.com>
parents: 16385
diff changeset
176
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
177 (defun eldoc-message (&rest args)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
178 (let ((omessage eldoc-last-message))
50853
3a65ede5c70c (eldoc-echo-area-use-multiline-p): Don't quote nil and t in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 49697
diff changeset
179 (setq eldoc-last-message
49697
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
180 (cond ((eq (car args) eldoc-last-message) eldoc-last-message)
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
181 ((null (car args)) nil)
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
182 ;; If only one arg, no formatting to do, so put it in
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
183 ;; eldoc-last-message so eq test above might succeed on
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
184 ;; subsequent calls.
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
185 ((null (cdr args)) (car args))
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
186 (t (apply 'format args))))
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
187 ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
188 ;; are recorded in a log. Do not put eldoc messages in that log since
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
189 ;; they are Legion.
49697
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
190 ;; Emacs way of preventing log messages.
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
191 (let ((message-log-max nil))
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
192 (cond (eldoc-last-message (message "%s" eldoc-last-message))
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
193 (omessage (message nil)))))
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
194 eldoc-last-message)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
195
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
196 ;; This function goes on pre-command-hook for XEmacs or when using idle
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
197 ;; timers in Emacs. Motion commands clear the echo area for some reason,
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
198 ;; which make eldoc messages flicker or disappear just before motion
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
199 ;; begins. This function reprints the last eldoc message immediately
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
200 ;; before the next command executes, which does away with the flicker.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
201 ;; This doesn't seem to be required for Emacs 19.28 and earlier.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
202 (defun eldoc-pre-command-refresh-echo-area ()
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
203 (and eldoc-last-message
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
204 (if (eldoc-display-message-no-interference-p)
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
205 (eldoc-message eldoc-last-message)
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
206 (setq eldoc-last-message nil))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
207
16975
188c4da9bf5d (eldoc-display-message-p): New function.
Noah Friedman <friedman@splode.com>
parents: 16969
diff changeset
208 ;; Decide whether now is a good time to display a message.
188c4da9bf5d (eldoc-display-message-p): New function.
Noah Friedman <friedman@splode.com>
parents: 16969
diff changeset
209 (defun eldoc-display-message-p ()
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
210 (and (eldoc-display-message-no-interference-p)
49697
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
211 ;; If this-command is non-nil while running via an idle
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
212 ;; timer, we're still in the middle of executing a command,
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
213 ;; e.g. a query-replace where it would be annoying to
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
214 ;; overwrite the echo area.
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
215 (and (not this-command)
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
216 (symbolp last-command)
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
217 (intern-soft (symbol-name last-command)
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
218 eldoc-message-commands))))
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
219
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
220 ;; Check various conditions about the current environment that might make
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
221 ;; it undesirable to print eldoc messages right this instant.
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
222 (defun eldoc-display-message-no-interference-p ()
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
223 (and eldoc-mode
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
224 (not executing-kbd-macro)
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
225 (not (and (boundp 'edebug-active) edebug-active))
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
226 ;; Having this mode operate in an active minibuffer/echo area causes
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
227 ;; interference with what's going on there.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
228 (not cursor-in-echo-area)
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
229 (not (eq (selected-window) (minibuffer-window)))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
230
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
231
62313
6ee2b2667bce (eldoc-documentation-function): Add autoload.
Richard M. Stallman <rms@gnu.org>
parents: 61856
diff changeset
232 ;;;###autoload
61855
bc5bdf5bff56 (eldoc-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 61278
diff changeset
233 (defvar eldoc-documentation-function nil
52445
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
234 "If non-nil, function to call to return doc string.
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
235 The function of no args should return a one-line string for displaying
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
236 doc about a function etc. appropriate to the context around point.
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
237 It should return nil if there's no doc appropriate for the context.
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
238 Typically doc is returned if point is on a function-like name or in its
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
239 arg list.
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
240
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
241 This variable is expected to be made buffer-local by modes (other than
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
242 Emacs Lisp mode) that support Eldoc.")
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
243
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
244 (defun eldoc-print-current-symbol-info ()
48470
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
245 (condition-case err
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
246 (and (eldoc-display-message-p)
61855
bc5bdf5bff56 (eldoc-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 61278
diff changeset
247 (if eldoc-documentation-function
bc5bdf5bff56 (eldoc-mode): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 61278
diff changeset
248 (eldoc-message (funcall eldoc-documentation-function))
52445
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
249 (let* ((current-symbol (eldoc-current-symbol))
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
250 (current-fnsym (eldoc-fnsym-in-current-sexp))
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
251 (doc (cond
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
252 ((eq current-symbol current-fnsym)
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
253 (or (eldoc-get-fnsym-args-string current-fnsym)
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
254 (eldoc-get-var-docstring current-symbol)))
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
255 (t
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
256 (or (eldoc-get-var-docstring current-symbol)
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
257 (eldoc-get-fnsym-args-string current-fnsym))))))
d776a9884cef (eldoc-print-current-symbol-info-function):
Dave Love <fx@gnu.org>
parents: 52401
diff changeset
258 (eldoc-message doc))))
48470
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
259 ;; This is run from post-command-hook or some idle timer thing,
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
260 ;; so we need to be careful that errors aren't ignored.
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
261 (error (message "eldoc error: %s" err))))
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
262
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
263 ;; Return a string containing the function parameter list, or 1-line
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
264 ;; docstring if function is a subr and no arglist is obtainable from the
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
265 ;; docstring or elsewhere.
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
266 (defun eldoc-get-fnsym-args-string (sym)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
267 (let ((args nil)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
268 (doc nil))
49697
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
269 (cond ((not (and sym (symbolp sym) (fboundp sym))))
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
270 ((and (eq sym (aref eldoc-last-data 0))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
271 (eq 'function (aref eldoc-last-data 2)))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
272 (setq doc (aref eldoc-last-data 1)))
48470
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
273 ((setq doc (help-split-fundoc (documentation sym t) sym))
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
274 (setq args (car doc))
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
275 (string-match "\\`[^ )]* ?" args)
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
276 (setq args (concat "(" (substring args (match-end 0)))))
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
277 (t
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
278 (setq args (eldoc-function-argstring sym))))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
279 (cond (args
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
280 (setq doc (eldoc-docstring-format-sym-doc sym args))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
281 (eldoc-last-data-store sym doc 'function)))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
282 doc))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
284 ;; Return a string containing a brief (one-line) documentation string for
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
285 ;; the variable.
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
286 (defun eldoc-get-var-docstring (sym)
49017
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
287 (when sym
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
288 (cond ((and (eq sym (aref eldoc-last-data 0))
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
289 (eq 'variable (aref eldoc-last-data 2)))
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
290 (aref eldoc-last-data 1))
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
291 (t
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
292 (let ((doc (documentation-property sym 'variable-documentation t)))
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
293 (cond (doc
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
294 (setq doc (eldoc-docstring-format-sym-doc
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
295 sym (eldoc-docstring-first-line doc)))
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
296 (eldoc-last-data-store sym doc 'variable)))
09ff6e632947 (eldoc-get-var-docstring): Only return a
John Paul Wallington <jpw@pobox.com>
parents: 48470
diff changeset
297 doc)))))
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
298
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
299 (defun eldoc-last-data-store (symbol doc type)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
300 (aset eldoc-last-data 0 symbol)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
301 (aset eldoc-last-data 1 doc)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
302 (aset eldoc-last-data 2 type))
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
303
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
304 ;; Note that any leading `*' in the docstring (which indicates the variable
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
305 ;; is a user option) is removed.
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
306 (defun eldoc-docstring-first-line (doc)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
307 (and (stringp doc)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
308 (substitute-command-keys
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
309 (save-match-data
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
310 (let ((start (if (string-match "^\\*" doc) (match-end 0) 0)))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
311 (cond ((string-match "\n" doc)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
312 (substring doc start (match-beginning 0)))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
313 ((zerop start) doc)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
314 (t (substring doc start))))))))
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
315
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
316 ;; If the entire line cannot fit in the echo area, the symbol name may be
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
317 ;; truncated or eliminated entirely from the output to make room for the
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
318 ;; description.
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
319 (defun eldoc-docstring-format-sym-doc (sym doc)
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
320 (save-match-data
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
321 (let* ((name (symbol-name sym))
49697
eb34aebd1084 (eldoc-echo-area-multiline-supported-p, eldoc-use-idle-timer-p): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 49018
diff changeset
322 (ea-multi eldoc-echo-area-use-multiline-p)
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
323 ;; Subtract 1 from window width since emacs will not write
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
324 ;; any chars to the last column, or in later versions, will
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
325 ;; cause a wraparound and resize of the echo area.
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
326 (ea-width (1- (window-width (minibuffer-window))))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
327 (strip (- (+ (length name) (length ": ") (length doc)) ea-width)))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
328 (cond ((or (<= strip 0)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
329 (eq ea-multi t)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
330 (and ea-multi (> (length doc) ea-width)))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
331 (format "%s: %s" sym doc))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
332 ((> (length doc) ea-width)
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
333 (substring (format "%s" doc) 0 ea-width))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
334 ((>= strip (length name))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
335 (format "%s" doc))
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
336 (t
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
337 ;; Show the end of the partial symbol name, rather
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
338 ;; than the beginning, since the former is more likely
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
339 ;; to be unique given package namespace conventions.
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
340 (setq name (substring name strip))
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
341 (format "%s: %s" name doc))))))
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
342
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
343
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
344 (defun eldoc-fnsym-in-current-sexp ()
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
345 (let ((p (point)))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
346 (eldoc-beginning-of-sexp)
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
347 (prog1
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
348 ;; Don't do anything if current word is inside a string.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
349 (if (= (or (char-after (1- (point))) 0) ?\")
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
350 nil
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
351 (eldoc-current-symbol))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
352 (goto-char p))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
353
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
354 (defun eldoc-beginning-of-sexp ()
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
355 (let ((parse-sexp-ignore-comments t))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
356 (condition-case err
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
357 (while (progn
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
358 (forward-sexp -1)
48470
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
359 (or (= (char-before) ?\")
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
360 (> (point) (point-min)))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
361 (error nil))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
362
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
363 ;; returns nil unless current word is an interned symbol.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
364 (defun eldoc-current-symbol ()
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
365 (let ((c (char-after (point))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
366 (and c
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
367 (memq (char-syntax c) '(?w ?_))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
368 (intern-soft (current-word)))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
369
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
370 ;; Do indirect function resolution if possible.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
371 (defun eldoc-symbol-function (fsym)
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
372 (let ((defn (and (fboundp fsym)
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
373 (symbol-function fsym))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
374 (and (symbolp defn)
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
375 (condition-case err
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
376 (setq defn (indirect-function fsym))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
377 (error (setq defn nil))))
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
378 defn))
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
379
30389
38f19553e93d (eldoc-minor-mode-string): Add autoload cookie; otherwise autoloaded
Noah Friedman <friedman@splode.com>
parents: 23586
diff changeset
380 (defun eldoc-function-argstring (fn)
48470
5a25c61f2c8b (eldoc-print-current-symbol-info):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 42623
diff changeset
381 (eldoc-function-argstring-format (help-function-arglist fn)))
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
382
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
383 (defun eldoc-function-argstring-format (arglist)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
384 (cond ((not (listp arglist))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
385 (setq arglist nil))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
386 ((symbolp (car arglist))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
387 (setq arglist
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
388 (mapcar (function (lambda (s)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
389 (if (memq s '(&optional &rest))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
390 (symbol-name s)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
391 (funcall eldoc-argument-case
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
392 (symbol-name s)))))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
393 arglist)))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
394 ((stringp (car arglist))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
395 (setq arglist
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
396 (mapcar (function (lambda (s)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
397 (if (member s '("&optional" "&rest"))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
398 s
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
399 (funcall eldoc-argument-case s))))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
400 arglist))))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
401 (concat "(" (mapconcat 'identity arglist " ") ")"))
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
402
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
403
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
404 ;; When point is in a sexp, the function args are not reprinted in the echo
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
405 ;; area after every possible interactive command because some of them print
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
406 ;; their own messages in the echo area; the eldoc functions would instantly
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
407 ;; overwrite them unless it is more restrained.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
408 ;; These functions do display-command table management.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
409
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
410 (defun eldoc-add-command (&rest cmds)
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
411 (dolist (name cmds)
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
412 (and (symbolp name)
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
413 (setq name (symbol-name name)))
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
414 (set (intern name eldoc-message-commands) t)))
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
415
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
416 (defun eldoc-add-command-completions (&rest names)
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
417 (dolist (name names)
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
418 (apply 'eldoc-add-command (all-completions name obarray 'commandp))))
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
419
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
420 (defun eldoc-remove-command (&rest cmds)
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
421 (dolist (name cmds)
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
422 (and (symbolp name)
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
423 (setq name (symbol-name name)))
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
424 (unintern name eldoc-message-commands)))
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
425
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
426 (defun eldoc-remove-command-completions (&rest names)
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
427 (dolist (name names)
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
428 (apply 'eldoc-remove-command
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
429 (all-completions name eldoc-message-commands))))
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
430
23283
2442a5dce1a8 (eldoc-message): Check for 1-arg case, and store string in
Noah Friedman <friedman@splode.com>
parents: 18699
diff changeset
431
16996
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
432 ;; Prime the command list.
2d67501c45b9 (eldoc-message-commands): Doc fixes.
Noah Friedman <friedman@splode.com>
parents: 16975
diff changeset
433 (eldoc-add-command-completions
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
434 "backward-" "beginning-of-" "move-beginning-of-" "delete-other-windows"
72737
455031002c62 * window.el (mouse-autoselect-window-timer)
Chong Yidong <cyd@stupidchicken.com>
parents: 68648
diff changeset
435 "delete-window" "handle-select-window"
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
436 "end-of-" "move-end-of-" "exchange-point-and-mark" "forward-"
64933
efb3c9d498e7 Add move-beginning-of-line, move-end-of-line, end-of-line,
Eli Zaretskii <eliz@gnu.org>
parents: 64751
diff changeset
437 "indent-for-tab-command" "goto-" "mark-page" "mark-paragraph"
efb3c9d498e7 Add move-beginning-of-line, move-end-of-line, end-of-line,
Eli Zaretskii <eliz@gnu.org>
parents: 64751
diff changeset
438 "mouse-set-point" "move-" "pop-global-mark" "next-" "other-window"
efb3c9d498e7 Add move-beginning-of-line, move-end-of-line, end-of-line,
Eli Zaretskii <eliz@gnu.org>
parents: 64751
diff changeset
439 "previous-" "recenter" "scroll-" "self-insert-command"
efb3c9d498e7 Add move-beginning-of-line, move-end-of-line, end-of-line,
Eli Zaretskii <eliz@gnu.org>
parents: 64751
diff changeset
440 "split-window-" "up-list" "down-list")
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
441
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
442 (provide 'eldoc)
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
443
65843
e28dd6224eb2 Move comments into docstrings.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 64933
diff changeset
444 ;; arch-tag: c9a58f9d-2055-46c1-9b82-7248b71a8375
13530
625e90e74d83 Initial revision
Noah Friedman <friedman@splode.com>
parents:
diff changeset
445 ;;; eldoc.el ends here