| blob | 54fbb896b51f6a2a1bc26311d6cd80a43447eb1b |
1 ;;; eldoc.el --- show function arglist or variable docstring in echo area
3 ;; Copyright (C) 1996, 97, 98, 99, 2000 Free Software Foundation, Inc.
5 ;; Author: Noah Friedman <friedman@splode.com>
6 ;; Maintainer: friedman@splode.com
7 ;; Keywords: extensions
8 ;; Created: 1995-10-06
10 ;; $Id: eldoc.el,v 1.17 2000/07/24 00:37:03 friedman Exp $
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
29 ;;; Commentary:
31 ;; This program was inspired by the behavior of the "mouse documentation
32 ;; window" on many Lisp Machine systems; as you type a function's symbol
33 ;; name as part of a sexp, it will print the argument list for that
34 ;; function. Behavior is not identical; for example, you need not actually
35 ;; type the function name, you need only move point around in a sexp that
36 ;; calls it. Also, if point is over a documented variable, it will print
37 ;; the one-line documentation for that variable instead, to remind you of
38 ;; that variable's meaning.
40 ;; One useful way to enable this minor mode is to put the following in your
41 ;; .emacs:
42 ;;
43 ;; (autoload 'turn-on-eldoc-mode "eldoc" nil t)
44 ;; (add-hook 'emacs-lisp-mode-hook 'turn-on-eldoc-mode)
45 ;; (add-hook 'lisp-interaction-mode-hook 'turn-on-eldoc-mode)
46 ;; (add-hook 'ielm-mode-hook 'turn-on-eldoc-mode)
48 ;;; Code:
50 ;; Use idle timers if available in the version of emacs running.
51 ;; Please don't change this to use `require'; this package works
52 ;; as-is in XEmacs 19.14 and later and I am striving to maintain
53 ;; compatibility between emacs variants.
58 "Show function arglist or variable docstring in echo area."
62 ;;;###autoload
64 "*If non-nil, show the defined parameters for the elisp function near point.
66 For the emacs lisp function at the beginning of the sexp which point is
67 within, show the defined parameters for the function in the echo area.
68 This information is extracted directly from the function or macro if it is
69 in pure lisp. If the emacs function is a subr, the parameters are obtained
70 from the documentation string if possible.
72 If point is over a documented variable, print that variable's docstring
73 instead.
75 This variable is buffer-local."
81 "*Number of seconds of idle time to wait before printing.
82 If user input arrives before this interval of time has elapsed after the
83 last input, no documentation will be printed.
85 If this variable is set to 0, no idle time is required."
89 ;;;###autoload
91 "*String to display in mode line when Eldoc Mode is enabled."
96 "Case to display argument names of functions, as a symbol.
97 This has two preferred values: `upcase' or `downcase'.
98 Actually, any name of a function which takes a string as an argument and
99 returns another string is acceptable."
102 function)
106 "*Allow long eldoc messages to resize echo area display.
107 If value is `t', never attempt to truncate messages; complete symbol name
108 and function arglist or 1-line variable documentation will be displayed
109 even if echo area must be resized to fit.
111 If value is any non-nil value other than `t', symbol name may be truncated
112 if it will enable the function arglist or documentation string to fit on a
113 single line without resizing window. Otherwise, behavior is just like
114 former case.
116 If value is nil, messages are always truncated to fit in a single line of
117 display in the echo area. Function or variable symbol name may be
118 truncated to make more of the arglist or documentation string visible.
120 Non-nil values for this variable have no effect unless
121 `eldoc-echo-area-multiline-supported-p' is non-nil."
128 ;;; No user options below here.
130 ;; Non-nil if this version of emacs supports dynamically resizable echo areas.
136 ;; Commands after which it is appropriate to print in the echo area.
137 ;; Eldoc does not try to print function arglists, etc. after just any command,
138 ;; because some commands print their own messages in the echo area and these
139 ;; functions would instantly overwrite them. But self-insert-command as well
140 ;; as most motion commands are good candidates.
141 ;; This variable contains an obarray of symbols; do not manipulate it
142 ;; directly. Instead, use `eldoc-add-command' and `eldoc-remove-command'.
145 ;; This is used by eldoc-add-command to initialize eldoc-message-commands
146 ;; as an obarray.
147 ;; It should probably never be necessary to do so, but if you
148 ;; choose to increase the number of buckets, you must do so before loading
149 ;; this file since the obarray is initialized at load time.
150 ;; Remember to keep it a prime number to improve hash performance.
153 ;; Bookkeeping; elements are as follows:
154 ;; 0 - contains the last symbol read from the buffer.
155 ;; 1 - contains the string last displayed in the echo area for that
156 ;; symbol, so it can be printed again if necessary without reconsing.
157 ;; 2 - 'function if function args, 'variable if variable documentation.
161 ;; Idle timers are supported in Emacs 19.31 and later.
164 ;; eldoc's timer object, if using idle timers
167 ;; idle time delay currently in use by timer.
168 ;; This is used to determine if eldoc-idle-delay is changed by the user.
171 ;; Put minor mode string on the global minor-mode-alist.
172 ;;;###autoload
181 \f
182 ;;;###autoload
184 "*Enable or disable eldoc mode.
185 See documentation for the variable of the same name for more details.
187 If called interactively with no prefix argument, toggle current condition
188 of the mode.
189 If called with a positive or negative prefix argument, enable or disable
190 the mode, respectively."
197 ;; Use post-command-idle-hook if defined, otherwise use
198 ;; post-command-hook. The former is only proper to use in Emacs
199 ;; 19.30; that is the first version in which it appeared, but it
200 ;; was obsolesced by idle timers in Emacs 19.31.
202 'post-command-idle-hook
205 ;; quick and dirty hack for seeing if this is XEmacs
216 eldoc-mode)
218 ;;;###autoload
220 "Unequivocally turn on eldoc-mode (see variable documentation)."
224 \f
225 ;; Idle timers are part of Emacs 19.31 and later.
233 ;; If user has changed the idle delay, update the timer.
244 ;; If only one arg, no formatting to do so put it in
245 ;; eldoc-last-message so eq test above might succeed on
246 ;; subsequent calls.
251 ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages
252 ;; are recorded in a log. Do not put eldoc messages in that log since
253 ;; they are Legion.
255 ;; XEmacs 19.13 way of preventing log messages.
261 ;; Emacs way of preventing log messages.
267 eldoc-last-message)
269 ;; This function goes on pre-command-hook for XEmacs or when using idle
270 ;; timers in Emacs. Motion commands clear the echo area for some reason,
271 ;; which make eldoc messages flicker or disappear just before motion
272 ;; begins. This function reprints the last eldoc message immediately
273 ;; before the next command executes, which does away with the flicker.
274 ;; This doesn't seem to be required for Emacs 19.28 and earlier.
281 ;; Decide whether now is a good time to display a message.
285 ;; If this-command is non-nil while running via an idle
286 ;; timer, we're still in the middle of executing a command,
287 ;; e.g. a query-replace where it would be annoying to
288 ;; overwrite the echo area.
292 eldoc-message-commands)))
294 ;; If we don't have idle timers, this function is
295 ;; running on post-command-hook directly; that means the
296 ;; user's last command is still on `this-command', and we
297 ;; must wait briefly for input to see whether to do display.
300 eldoc-message-commands)
303 ;; Check various conditions about the current environment that might make
304 ;; it undesirable to print eldoc messages right this instant.
309 ;; Having this mode operate in an active minibuffer/echo area causes
310 ;; interference with what's going on there.
314 \f
327 ;; Return a string containing the function parameter list, or 1-line
328 ;; docstring if function is a subr and no arglist is obtainable from the
329 ;; docstring or elsewhere.
347 doc))
349 ;; Return a string containing a brief (one-line) documentation string for
350 ;; the variable.
361 doc))))
368 ;; Note that any leading `*' in the docstring (which indicates the variable
369 ;; is a user option) is removed.
380 ;; If the entire line cannot fit in the echo area, the symbol name may be
381 ;; truncated or eliminated entirely from the output to make room for the
382 ;; description.
387 eldoc-echo-area-use-multiline-p))
388 ;; Subtract 1 from window width since emacs will not write
389 ;; any chars to the last column, or in later versions, will
390 ;; cause a wraparound and resize of the echo area.
402 ;; Show the end of the partial symbol name, rather
403 ;; than the beginning, since the former is more likely
404 ;; to be unique given package namespace conventions.
408 \f
413 ;; Don't do anything if current word is inside a string.
415 nil
428 ;; returns nil unless current word is an interned symbol.
435 ;; Do indirect function resolution if possible.
443 defn))
449 prelim-def))
459 arglist))
474 arglist)))
479 s
481 arglist))))
484 \f
485 ;; Alist of predicate/action pairs.
486 ;; Each member of the list is a sublist consisting of a predicate function
487 ;; used to determine if the arglist for a function can be found using a
488 ;; certain pattern, and a function which returns the actual arglist from
489 ;; that docstring.
490 ;;
491 ;; The order in this table is significant, since later predicates may be
492 ;; more general than earlier ones.
493 ;;
494 ;; Compiler note for Emacs/XEmacs versions which support dynamic loading:
495 ;; these functions will be compiled to bytecode, but can't be lazy-loaded
496 ;; even if you set byte-compile-dynamic; to do that would require making
497 ;; them named top-level defuns, which is not particularly desirable either.
500 ;; Try first searching for args starting with symbol name.
501 ;; This is to avoid matching parenthetical remarks in e.g. sit-for.
505 ;; end does not include trailing ")" sequence.
511 ;; Try again not requiring this symbol name in the docstring.
512 ;; This will be the case when looking up aliases.
514 ;; save-restriction has a pathological docstring in
515 ;; Emacs/XEmacs 19.
519 ;; end does not include trailing ")" sequence.
524 ;; Emacs subr docstring style:
525 ;; (fn arg1 arg2 ...): description...
529 ;; end does not include trailing "):" sequence.
534 ;; XEmacs subr docstring style:
535 ;; "arguments: (arg1 arg2 ...)
539 ;; also skip leading paren, but the first word is
540 ;; actually an argument, not the function name.
543 ;; This finds the argstring for `condition-case'. Any others?
547 doc)))
549 ;; end does not include trailing ")" sequence.
554 ;; This finds the argstring for `setq-default'. Any others?
557 doc)))
559 ;; end does not include trailing ")" sequence.
564 ;; This finds the argstring for `start-process'. Any others?
570 ;; These common subrs don't have arglists in their docstrings. So cheat.
574 ;; The value nil is a placeholder; otherwise, the
575 ;; following string may be compiled as a docstring,
576 ;; and not a return value for the function.
577 ;; In interpreted lisp form they are
578 ;; indistinguishable; it only matters for compiled
579 ;; forms.
580 nil
582 ))
598 nil)
606 doclist))
615 \f
616 ;; When point is in a sexp, the function args are not reprinted in the echo
617 ;; area after every possible interactive command because some of them print
618 ;; their own messages in the echo area; the eldoc functions would instantly
619 ;; overwrite them unless it is more restrained.
620 ;; These functions do display-command table management.
669 \f
670 ;; Prime the command list.
680 ;;; eldoc.el ends here