| blob | 68bb9b6d4ded693b9fa71d7ac5433f80b1afa0d6 |
1 ;;; eldoc.el --- show function arglist or variable docstring in echo area
3 ;; Copyright (C) 1995 Noah S. Friedman
5 ;; Author: Noah Friedman <friedman@prep.ai.mit.edu>
6 ;; Maintainer: friedman@prep.ai.mit.edu
7 ;; Keywords: extensions
8 ;; Status: Works in Emacs 19 and XEmacs.
9 ;; Created: 1995-10-06
11 ;; LCD Archive Entry:
12 ;; eldoc|Noah Friedman|friedman@prep.ai.mit.edu|
13 ;; show function arglist or variable docstring in echo area|
14 ;; $Date: 1995/11/18 22:32:07 $|$Revision: 1.3 $|~/misc/eldoc.el.gz|
16 ;; $Id: eldoc.el,v 1.3 1995/11/18 22:32:07 friedman Exp friedman $
18 ;; This program is free software; you can redistribute it and/or modify
19 ;; it under the terms of the GNU General Public License as published by
20 ;; the Free Software Foundation; either version 2, or (at your option)
21 ;; any later version.
22 ;;
23 ;; This program is distributed in the hope that it will be useful,
24 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
25 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 ;; GNU General Public License for more details.
27 ;;
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with this program; if not, you can either send email to this
30 ;; program's maintainer or write to: The Free Software Foundation,
31 ;; Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA.
33 ;;; Commentary:
35 ;; This program was inspired by the behavior of the Lisp Machine "mouse
36 ;; documentation window"; as you type a function's symbol name as part of a
37 ;; sexp, it will print the argument list for that function. However, this
38 ;; program's behavior is different in a couple of significant ways. For
39 ;; one, you need not actually type the function name; you need only move
40 ;; point around in a sexp that calls it. However, if point is over a
41 ;; documented variable, it will print the one-line documentation for that
42 ;; variable instead, to remind you of that variable's purpose.
44 ;; One useful way to enable this minor mode is to put the following in your
45 ;; .emacs:
46 ;;
47 ;; (autoload 'turn-on-eldoc-mode "eldoc" nil t)
48 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-eldoc-mode)
49 ;; (add-hook 'lisp-interaction-mode-hook 'turn-on-eldoc-mode)
51 ;;; Code:
53 ;;;###autoload
55 "*If non-nil, show the defined parameters for the elisp function near point.
57 For the emacs lisp function at the beginning of the sexp which point is
58 within, show the defined parameters for the function in the echo area.
59 This information is extracted directly from the function or macro if it is
60 in pure lisp.
62 If the emacs function is a subr, the parameters are obtained from the
63 documentation string if possible.
65 If point is over a documented variable, print that variable's docstring
66 instead; see function `eldoc-print-var-docstring'.
72 "*Number of seconds of idle time to wait before printing.
73 If user input arrives before this interval of time has elapsed after the
74 last input, no documentation will be printed.
79 "Case to display argument names of functions, as a symbol.
80 This has two preferred values: `upcase' or `downcase'.
81 Actually, any name of a function which takes a string as an argument and
85 "*Obarray of command names where it is appropriate to print in the echo area.
87 This is not done for all commands since some print their own
88 messages in the echo area, and these functions would instantly overwrite
89 them. But self-insert-command as well as most motion commands are good
90 candidates.
92 It is probably best to manipulate this data structure with the commands
96 ;; If you increase the number of buckets, keep it a prime number.
102 "goto-"
103 "recenter"
113 ;; Bookkeeping; the car contains the last symbol read from the buffer.
114 ;; The cdr contains the string last displayed in the echo area, so it can
115 ;; be printed again if necessary without reconsing.
121 ;; Put this minor mode on the global minor-mode-alist.
127 \f
128 ;;;###autoload
130 "*If non-nil, then enable eldoc-mode (see variable docstring)."
133 ;; Make sure it's on the post-command-idle-hook if defined, otherwise put
134 ;; it on post-command-hook. The former first appeared in Emacs 19.30.
136 'post-command-idle-hook
146 eldoc-mode)
148 ;;;###autoload
150 "Unequivocally turn on eldoc-mode (see variable documentation)."
155 "Add COMMAND to the list of commands which causes function arg display.
156 If called interactively, completion matches any bound function.
158 When point is in a sexp, the function args are not reprinted in the echo
159 area after every possible interactive command because some of them print
160 their own messages in the echo area; the eldoc functions would instantly
161 overwrite them unless it is more restrained."
167 "Remove COMMAND from the list of commands which causes function arg display.
168 If called interactively, completion matches only those functions currently
169 in the list.
171 When point is in a sexp, the function args are not reprinted in the echo
172 area after every possible interactive command because some of them print
173 their own messages in the echo area; the eldoc functions would instantly
174 overwrite them unless it is more restrained."
176 "Remove function from eldoc message commands list: "
189 ;; Having this mode operate in the minibuffer makes it impossible to
190 ;; see what you're doing.
203 \f
205 "Print the brief (one-line) documentation string for the variable at point.
206 If called with no argument, print the first line of the variable
207 documentation string for the symbol at point in the echo area.
208 If called with a symbol, print the line for that symbol.
210 If the entire line cannot fit in the echo area, the variable name may be
211 truncated or eliminated entirely from the output to make room.
212 Any leading `*' in the docstring (which indicates the variable is a user
213 option) is not printed."
225 ;; Subtract 1 from window width since emacs seems not to
226 ;; write any chars to the last column, at least for some
227 ;; terminal types.
238 t))))
240 \f
241 ;;;###autoload
243 "*Show the defined parameters for the function near point.
244 For the function at the beginning of the sexp which point is within, show
245 the defined parameters for the function in the echo area.
246 This information is extracted directly from the function or macro if it is
247 in pure lisp.
248 If the emacs function is a subr, the parameters are obtained from the
249 documentation string if possible."
266 printit
267 ;; In emacs 19.29 and later, all messages are recorded in a log.
268 ;; Do not put eldoc messages in the log since they are Legion.
280 ;; If we hit a quotation mark before a paren, we
281 ;; are inside a specific string, not a list of
282 ;; symbols.
284 nil)
290 sym)))
296 prelim-def))
314 ;; Try first searching for args starting with symbol name.
315 ;; This is to avoid matching parenthetical remarks in e.g. sit-for.
317 ;; end does not include trailing ")" sequence.
323 ;; Try again not requiring this symbol name in the docstring.
324 ;; This will be the case when looking up aliases.
326 ;; end does not include trailing ")" sequence.
332 ;; Emacs subr docstring style:
333 ;; (fn arg1 arg2 ...): description...
335 ;; end does not include trailing "):" sequence.
341 ;; XEmacs subr docstring style:
342 ;; "arguments: (arg1 arg2 ...)
344 ;; Also, skip leading paren, but the first word is actually an
345 ;; argument, not the function name.
350 ;; This finds the argstring for `condition-case'.
351 ;; I don't know if there are any others with the same pattern.
353 docstring)
354 ;; end does not include trailing ")" sequence.
360 ;; This finds the argstring for `setq-default'.
361 ;; I don't know if there are any others with the same pattern.
363 ;; end does not include trailing ")" sequence.
370 nil)
378 doclist))
397 arglist)))
402 s
404 arglist))))
407 \f
408 ;; forward-sexp calls scan-sexps, which returns an error if it hits the
409 ;; beginning or end of the sexp. This returns nil instead.
411 "Move forward across one balanced expression (sexp).
412 With argument, do it that many times. Negative arg -COUNT means
413 move backward across COUNT balanced expressions.
414 Return distance in buffer moved, or nil."
423 ;; Do indirect function resolution if possible.
431 defn))
441 ;;; eldoc.el ends here