eldoc.el 23.2 KB
Newer Older
1
;;; eldoc.el --- show function arglist or variable docstring in echo area  -*- lexical-binding: t; -*-
Noah Friedman's avatar
Noah Friedman committed
2

3
;; Copyright (C) 1996-2014 Free Software Foundation, Inc.
Noah Friedman's avatar
Noah Friedman committed
4

5 6
;; Author: Noah Friedman <friedman@splode.com>
;; Maintainer: friedman@splode.com
Noah Friedman's avatar
Noah Friedman committed
7 8 9
;; Keywords: extensions
;; Created: 1995-10-06

10
;; This file is part of GNU Emacs.
Noah Friedman's avatar
Noah Friedman committed
11

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Noah Friedman's avatar
Noah Friedman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
16 17

;; GNU Emacs is distributed in the hope that it will be useful,
Noah Friedman's avatar
Noah Friedman committed
18 19 20
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
21

Noah Friedman's avatar
Noah Friedman committed
22
;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Noah Friedman's avatar
Noah Friedman committed
24 25 26

;;; Commentary:

27 28 29 30 31 32 33 34
;; This program was inspired by the behavior of the "mouse documentation
;; window" on many Lisp Machine systems; as you type a function's symbol
;; name as part of a sexp, it will print the argument list for that
;; function.  Behavior is not identical; for example, you need not actually
;; type the function name, you need only move point around in a sexp that
;; calls it.  Also, if point is over a documented variable, it will print
;; the one-line documentation for that variable instead, to remind you of
;; that variable's meaning.
Noah Friedman's avatar
Noah Friedman committed
35 36 37 38

;; One useful way to enable this minor mode is to put the following in your
;; .emacs:
;;
39 40 41
;;      (add-hook 'emacs-lisp-mode-hook 'eldoc-mode)
;;      (add-hook 'lisp-interaction-mode-hook 'eldoc-mode)
;;      (add-hook 'ielm-mode-hook 'eldoc-mode)
Glenn Morris's avatar
Glenn Morris committed
42
;;      (add-hook 'eval-expression-minibuffer-setup-hook 'eldoc-mode)
Noah Friedman's avatar
Noah Friedman committed
43

44
;; Major modes for other languages may use ElDoc by defining an
45
;; appropriate function as the buffer-local value of
Richard M. Stallman's avatar
Richard M. Stallman committed
46
;; `eldoc-documentation-function'.
47

Noah Friedman's avatar
Noah Friedman committed
48 49
;;; Code:

50 51
(require 'help-fns)		       ;For fundoc-usage handling functions.

52 53
(defgroup eldoc nil
  "Show function arglist or variable docstring in echo area."
54
  :group 'lisp
55 56 57
  :group 'extensions)

(defcustom eldoc-idle-delay 0.50
58
  "Number of seconds of idle time to wait before printing.
Noah Friedman's avatar
Noah Friedman committed
59 60 61
If user input arrives before this interval of time has elapsed after the
last input, no documentation will be printed.

62 63 64
If this variable is set to 0, no idle time is required."
  :type 'number
  :group 'eldoc)
Noah Friedman's avatar
Noah Friedman committed
65

66 67 68 69 70 71
(defcustom eldoc-print-after-edit nil
  "If non-nil eldoc info is only shown when editing.
Changing the value requires toggling `eldoc-mode'."
  :type 'boolean
  :group 'eldoc)

72
;;;###autoload
73
(defcustom eldoc-minor-mode-string (purecopy " ElDoc")
74
  "String to display in mode line when ElDoc Mode is enabled; nil for none."
75
  :type '(choice string (const :tag "None" nil))
76
  :group 'eldoc)
77

78
(defcustom eldoc-argument-case 'upcase
Noah Friedman's avatar
Noah Friedman committed
79 80 81
  "Case to display argument names of functions, as a symbol.
This has two preferred values: `upcase' or `downcase'.
Actually, any name of a function which takes a string as an argument and
82 83 84 85
returns another string is acceptable.

Note that if `eldoc-documentation-function' is non-nil, this variable
has no effect, unless the function handles it explicitly."
86 87 88
  :type '(radio (function-item upcase)
		(function-item downcase)
                function)
89
  :group 'eldoc)
Noah Friedman's avatar
Noah Friedman committed
90

91
(defcustom eldoc-echo-area-use-multiline-p 'truncate-sym-name-if-fit
92
  "Allow long ElDoc messages to resize echo area display.
93
If value is t, never attempt to truncate messages; complete symbol name
94 95 96
and function arglist or 1-line variable documentation will be displayed
even if echo area must be resized to fit.

97
If value is any non-nil value other than t, symbol name may be truncated
98 99 100 101 102 103
if it will enable the function arglist or documentation string to fit on a
single line without resizing window.  Otherwise, behavior is just like
former case.

If value is nil, messages are always truncated to fit in a single line of
display in the echo area.  Function or variable symbol name may be
104 105 106 107
truncated to make more of the arglist or documentation string visible.

Note that if `eldoc-documentation-function' is non-nil, this variable
has no effect, unless the function handles it explicitly."
108 109 110 111 112 113
  :type '(radio (const :tag "Always" t)
                (const :tag "Never" nil)
                (const :tag "Yes, but truncate symbol names if it will\
 enable argument list to fit on one line" truncate-sym-name-if-fit))
  :group 'eldoc)

114 115
(defface eldoc-highlight-function-argument
  '((t (:inherit bold)))
116 117 118
  "Face used for the argument at point in a function's argument list.
Note that if `eldoc-documentation-function' is non-nil, this face
has no effect, unless the function handles it explicitly."
119 120
  :group 'eldoc)

121 122
;;; No user options below here.

123
(defvar eldoc-message-commands-table-size 31
124
  "Used by `eldoc-add-command' to initialize `eldoc-message-commands' obarray.
125 126 127 128 129 130 131 132
It should probably never be necessary to do so, but if you
choose to increase the number of buckets, you must do so before loading
this file since the obarray is initialized at load time.
Remember to keep it a prime number to improve hash performance.")

(defconst eldoc-message-commands
  (make-vector eldoc-message-commands-table-size 0)
  "Commands after which it is appropriate to print in the echo area.
133
ElDoc does not try to print function arglists, etc., after just any command,
134
because some commands print their own messages in the echo area and these
135
functions would instantly overwrite them.  But `self-insert-command' as well
136 137 138 139
as most motion commands are good candidates.
This variable contains an obarray of symbols; do not manipulate it
directly.  Instead, use `eldoc-add-command' and `eldoc-remove-command'.")

140
;; Not a constant.
141 142 143
(defconst eldoc-last-data (make-vector 3 nil)
  "Bookkeeping; elements are as follows:
  0 - contains the last symbol read from the buffer.
144 145
  1 - contains the string last displayed in the echo area for variables,
      or argument string for functions.
146
  2 - 'function if function args, 'variable if variable documentation.")
147

148
(defvar eldoc-last-message nil)
Noah Friedman's avatar
Noah Friedman committed
149

150
(defvar eldoc-timer nil "ElDoc's timer object.")
151

152
(defvar eldoc-current-idle-delay eldoc-idle-delay
153
  "Idle time delay currently in use by timer.
154
This is used to determine if `eldoc-idle-delay' is changed by the user.")
Noah Friedman's avatar
Noah Friedman committed
155

156
(defvar eldoc-message-function #'eldoc-minibuffer-message
157 158 159
  "The function used by `eldoc-message' to display messages.
It should receive the same arguments as `message'.")

160 161 162 163 164 165 166 167 168 169
(defun eldoc-edit-message-commands ()
  (let ((cmds (make-vector 31 0))
	(re (regexp-opt '("delete" "insert" "edit" "electric" "newline"))))
    (mapatoms (lambda (s)
		(and (commandp s)
		     (string-match-p re (symbol-name s))
		     (intern (symbol-name s) cmds)))
	      obarray)
    cmds))

Noah Friedman's avatar
Noah Friedman committed
170 171

;;;###autoload
172
(define-minor-mode eldoc-mode
Chong Yidong's avatar
Chong Yidong committed
173 174 175 176 177 178 179 180 181 182 183
  "Toggle echo area display of Lisp objects at point (ElDoc mode).
With a prefix argument ARG, enable ElDoc mode if ARG is positive,
and disable it otherwise.  If called from Lisp, enable ElDoc mode
if ARG is omitted or nil.

ElDoc mode is a buffer-local minor mode.  When enabled, the echo
area displays information about a function or variable in the
text where point is.  If point is on a documented variable, it
displays the first line of that variable's doc string.  Otherwise
it displays the argument list of the function called in the
expression point is on."
Lute Kamstra's avatar
Lute Kamstra committed
184
  :group 'eldoc :lighter eldoc-minor-mode-string
185
  (setq eldoc-last-message nil)
186 187
  (if eldoc-mode
      (progn
188 189
	(when eldoc-print-after-edit
	  (setq-local eldoc-message-commands (eldoc-edit-message-commands)))
190
	(add-hook 'post-command-hook 'eldoc-schedule-timer nil t)
Leo Liu's avatar
Leo Liu committed
191
	(add-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area nil t))
192 193 194
    (kill-local-variable 'eldoc-message-commands)
    (remove-hook 'post-command-hook 'eldoc-schedule-timer t)
    (remove-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area t)))
195

Noah Friedman's avatar
Noah Friedman committed
196
;;;###autoload
197
(define-obsolete-function-alias 'turn-on-eldoc-mode 'eldoc-mode "24.4")
Noah Friedman's avatar
Noah Friedman committed
198

199

200 201 202 203
(defun eldoc-schedule-timer ()
  (or (and eldoc-timer
           (memq eldoc-timer timer-idle-list))
      (setq eldoc-timer
204 205 206
            (run-with-idle-timer
	     eldoc-idle-delay t
	     (lambda () (and eldoc-mode (eldoc-print-current-symbol-info))))))
207 208 209 210 211 212

  ;; If user has changed the idle delay, update the timer.
  (cond ((not (= eldoc-idle-delay eldoc-current-idle-delay))
         (setq eldoc-current-idle-delay eldoc-idle-delay)
         (timer-set-idle-time eldoc-timer eldoc-idle-delay t))))

213 214 215 216 217 218 219 220
(defvar eldoc-mode-line-string nil)
(put 'eldoc-mode-line-string 'risky-local-variable t)

(defun eldoc-minibuffer-message (format-string &rest args)
  "Display messages in the mode-line when in the minibuffer.
Otherwise work like `message'."
  (if (minibufferp)
      (progn
221
	(add-hook 'minibuffer-exit-hook
222 223 224
		  (lambda () (setq eldoc-mode-line-string nil
			      ;; http://debbugs.gnu.org/16920
			      eldoc-last-message nil))
225
		  nil t)
226 227 228 229 230 231 232 233 234 235
	(with-current-buffer
	    (window-buffer
	     (or (window-in-direction 'above (minibuffer-window))
		 (minibuffer-selected-window)
		 (get-largest-window)))
	  (unless (and (listp mode-line-format)
		       (assq 'eldoc-mode-line-string mode-line-format))
	    (setq mode-line-format
		  (list "" '(eldoc-mode-line-string
			     (" " eldoc-mode-line-string " "))
236 237 238 239 240
			mode-line-format)))
          (setq eldoc-mode-line-string
                (when (stringp format-string)
                  (apply 'format format-string args)))
          (force-mode-line-update)))
241 242
    (apply 'message format-string args)))

243 244
(defun eldoc-message (&rest args)
  (let ((omessage eldoc-last-message))
245
    (setq eldoc-last-message
246 247 248 249 250 251 252
	  (cond ((eq (car args) eldoc-last-message) eldoc-last-message)
		((null (car args)) nil)
		;; If only one arg, no formatting to do, so put it in
		;; eldoc-last-message so eq test above might succeed on
		;; subsequent calls.
		((null (cdr args)) (car args))
		(t (apply 'format args))))
253 254 255
    ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages
    ;; are recorded in a log.  Do not put eldoc messages in that log since
    ;; they are Legion.
256 257
    ;; Emacs way of preventing log messages.
    (let ((message-log-max nil))
258 259 260
      (cond (eldoc-last-message
	     (funcall eldoc-message-function "%s" eldoc-last-message))
	    (omessage (funcall eldoc-message-function nil)))))
261 262
  eldoc-last-message)

263 264 265 266
(defun eldoc--message-command-p (command)
  (and (symbolp command)
       (intern-soft (symbol-name command) eldoc-message-commands)))

267 268 269 270 271 272 273 274
;; This function goes on pre-command-hook for XEmacs or when using idle
;; timers in Emacs.  Motion commands clear the echo area for some reason,
;; which make eldoc messages flicker or disappear just before motion
;; begins.  This function reprints the last eldoc message immediately
;; before the next command executes, which does away with the flicker.
;; This doesn't seem to be required for Emacs 19.28 and earlier.
(defun eldoc-pre-command-refresh-echo-area ()
  (and eldoc-last-message
275
       (not (minibufferp))      ;We don't use the echo area when in minibuffer.
276
       (if (and (eldoc-display-message-no-interference-p)
277
		(eldoc--message-command-p this-command))
278
	   (eldoc-message eldoc-last-message)
279 280
         ;; No need to call eldoc-message since the echo area will be cleared
         ;; for us, but do note that the last-message will be gone.
281
         (setq eldoc-last-message nil))))
282 283 284

;; Decide whether now is a good time to display a message.
(defun eldoc-display-message-p ()
285
  (and (eldoc-display-message-no-interference-p)
286 287 288 289
       ;; If this-command is non-nil while running via an idle
       ;; timer, we're still in the middle of executing a command,
       ;; e.g. a query-replace where it would be annoying to
       ;; overwrite the echo area.
290 291 292
       (not this-command)
       (eldoc--message-command-p last-command)))

Noah Friedman's avatar
Noah Friedman committed
293

294 295
;; Check various conditions about the current environment that might make
;; it undesirable to print eldoc messages right this instant.
296
(defun eldoc-display-message-no-interference-p ()
297
  (not (or executing-kbd-macro (bound-and-true-p edebug-active))))
298

299

300
;;;###autoload
301 302
(defvar eldoc-documentation-function #'eldoc-documentation-function-default
  "Function to call to return doc string.
303 304 305 306 307 308
The function of no args should return a one-line string for displaying
doc about a function etc. appropriate to the context around point.
It should return nil if there's no doc appropriate for the context.
Typically doc is returned if point is on a function-like name or in its
arg list.

309 310 311 312 313
The result is used as is, so the function must explicitly handle
the variables `eldoc-argument-case' and `eldoc-echo-area-use-multiline-p',
and the face `eldoc-highlight-function-argument', if they are to have any
effect.

314
This variable is expected to be made buffer-local by modes (other than
315
Emacs Lisp mode) that support ElDoc.")
316

317
(defun eldoc-print-current-symbol-info ()
318 319 320
  ;; This is run from post-command-hook or some idle timer thing,
  ;; so we need to be careful that errors aren't ignored.
  (with-demoted-errors "eldoc error: %s"
321 322 323 324 325
    (and (or (eldoc-display-message-p)
             ;; Erase the last message if we won't display a new one.
             (when eldoc-last-message
               (eldoc-message nil)
               nil))
326 327 328 329 330 331 332 333 334 335 336 337 338 339
	 (eldoc-message (funcall eldoc-documentation-function)))))

(defun eldoc-documentation-function-default ()
  "Default value for `eldoc-documentation-function' (which see)."
  (let ((current-symbol (eldoc-current-symbol))
	(current-fnsym  (eldoc-fnsym-in-current-sexp)))
    (cond ((null current-fnsym)
	   nil)
	  ((eq current-symbol (car current-fnsym))
	   (or (apply #'eldoc-get-fnsym-args-string current-fnsym)
	       (eldoc-get-var-docstring current-symbol)))
	  (t
	   (or (eldoc-get-var-docstring current-symbol)
	       (apply #'eldoc-get-fnsym-args-string current-fnsym))))))
340

341
(defun eldoc-get-fnsym-args-string (sym &optional index)
342 343
  "Return a string containing the parameter list of the function SYM.
If SYM is a subr and no arglist is obtainable from the docstring
344 345 346 347 348
or elsewhere, return a 1-line docstring.  Calls the functions
`eldoc-function-argstring-format' and
`eldoc-highlight-function-argument' to format the result.  The
former calls `eldoc-argument-case'; the latter gives the
function name `font-lock-function-name-face', and optionally
349
highlights argument number INDEX."
350
  (let (args doc advertised)
351
    (cond ((not (and sym (symbolp sym) (fboundp sym))))
352 353 354
	  ((and (eq sym (aref eldoc-last-data 0))
		(eq 'function (aref eldoc-last-data 2)))
	   (setq doc (aref eldoc-last-data 1)))
355 356 357
	  ((listp (setq advertised (gethash (indirect-function sym)
					    advertised-signature-table t)))
	   (setq args advertised))
358 359
	  ((setq doc (help-split-fundoc (documentation sym t) sym))
	   (setq args (car doc))
360
	   ;; Remove any enclosing (), since e-function-argstring adds them.
361
	   (string-match "\\`[^ )]* ?" args)
362
	   (setq args (substring args (match-end 0)))
363
	   (if (string-match-p ")\\'" args)
364 365 366 367 368 369 370 371 372 373 374 375
	       (setq args (substring args 0 -1))))
	  (t
	   (setq args (help-function-arglist sym))))
    (if args
	;; Stringify, and store before highlighting, downcasing, etc.
	;; FIXME should truncate before storing.
	(eldoc-last-data-store sym (setq args (eldoc-function-argstring args))
			       'function)
      (setq args doc))		  ; use stored value
    ;; Change case, highlight, truncate.
    (if args
	(eldoc-highlight-function-argument
376
	 sym (eldoc-function-argstring-format args) index))))
377

378 379 380
(defun eldoc-highlight-function-argument (sym args index)
  "Highlight argument INDEX in ARGS list for function SYM.
In the absence of INDEX, just call `eldoc-docstring-format-sym-doc'."
381 382
  (let ((start          nil)
	(end            0)
383
	(argument-face  'eldoc-highlight-function-argument))
384 385 386 387 388 389 390
    ;; Find the current argument in the argument string.  We need to
    ;; handle `&rest' and informal `...' properly.
    ;;
    ;; FIXME: What to do with optional arguments, like in
    ;;        (defun NAME ARGLIST [DOCSTRING] BODY...) case?
    ;;        The problem is there is no robust way to determine if
    ;;        the current argument is indeed a docstring.
391
    (while (and index (>= index 1))
392 393 394 395 396 397 398 399 400
      (if (string-match "[^ ()]+" args end)
	  (progn
	    (setq start (match-beginning 0)
		  end   (match-end 0))
	    (let ((argument (match-string 0 args)))
	      (cond ((string= argument "&rest")
		     ;; All the rest arguments are the same.
		     (setq index 1))
		    ((string= argument "&optional"))
401
		    ((string-match-p "\\.\\.\\.$" argument)
402 403 404 405 406 407 408 409 410 411 412 413
		     (setq index 0))
		    (t
		     (setq index (1- index))))))
	(setq end           (length args)
	      start         (1- end)
	      argument-face 'font-lock-warning-face
	      index         0)))
    (let ((doc args))
      (when start
	(setq doc (copy-sequence args))
	(add-text-properties start end (list 'face argument-face) doc))
      (setq doc (eldoc-docstring-format-sym-doc
414 415
		 sym doc (if (functionp sym) 'font-lock-function-name-face
                           'font-lock-keyword-face)))
416 417
      doc)))

418 419 420
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
421 422 423 424 425 426 427 428
  (when sym
    (cond ((and (eq sym (aref eldoc-last-data 0))
		(eq 'variable (aref eldoc-last-data 2)))
	   (aref eldoc-last-data 1))
	  (t
	   (let ((doc (documentation-property sym 'variable-documentation t)))
	     (cond (doc
		    (setq doc (eldoc-docstring-format-sym-doc
429 430
			       sym (eldoc-docstring-first-line doc)
			       'font-lock-variable-name-face))
431 432
		    (eldoc-last-data-store sym doc 'variable)))
	     doc)))))
433 434 435 436 437 438 439 440 441 442 443 444

(defun eldoc-last-data-store (symbol doc type)
  (aset eldoc-last-data 0 symbol)
  (aset eldoc-last-data 1 doc)
  (aset eldoc-last-data 2 type))

;; Note that any leading `*' in the docstring (which indicates the variable
;; is a user option) is removed.
(defun eldoc-docstring-first-line (doc)
  (and (stringp doc)
       (substitute-command-keys
        (save-match-data
445 446 447
	  ;; Don't use "^" in the regexp below since it may match
	  ;; anywhere in the doc-string.
	  (let ((start (if (string-match "\\`\\*" doc) (match-end 0) 0)))
448 449 450 451 452 453 454 455
            (cond ((string-match "\n" doc)
                   (substring doc start (match-beginning 0)))
                  ((zerop start) doc)
                  (t (substring doc start))))))))

;; If the entire line cannot fit in the echo area, the symbol name may be
;; truncated or eliminated entirely from the output to make room for the
;; description.
456
(defun eldoc-docstring-format-sym-doc (sym doc face)
457 458
  (save-match-data
    (let* ((name (symbol-name sym))
459
           (ea-multi eldoc-echo-area-use-multiline-p)
460 461 462 463 464 465 466 467
           ;; Subtract 1 from window width since emacs will not write
           ;; any chars to the last column, or in later versions, will
           ;; cause a wraparound and resize of the echo area.
           (ea-width (1- (window-width (minibuffer-window))))
           (strip (- (+ (length name) (length ": ") (length doc)) ea-width)))
      (cond ((or (<= strip 0)
                 (eq ea-multi t)
                 (and ea-multi (> (length doc) ea-width)))
468
             (format "%s: %s" (propertize name 'face face) doc))
469 470 471 472
            ((> (length doc) ea-width)
             (substring (format "%s" doc) 0 ea-width))
            ((>= strip (length name))
             (format "%s" doc))
473
            (t
474 475 476 477
             ;; Show the end of the partial symbol name, rather
             ;; than the beginning, since the former is more likely
             ;; to be unique given package namespace conventions.
             (setq name (substring name strip))
478
             (format "%s: %s" (propertize name 'face face) doc))))))
Noah Friedman's avatar
Noah Friedman committed
479

480

481
;; Return a list of current function name and argument index.
Noah Friedman's avatar
Noah Friedman committed
482
(defun eldoc-fnsym-in-current-sexp ()
483 484 485 486 487 488 489 490 491 492
  (save-excursion
    (let ((argument-index (1- (eldoc-beginning-of-sexp))))
      ;; If we are at the beginning of function name, this will be -1.
      (when (< argument-index 0)
	(setq argument-index 0))
      ;; Don't do anything if current word is inside a string.
      (if (= (or (char-after (1- (point))) 0) ?\")
	  nil
	(list (eldoc-current-symbol) argument-index)))))

Paul Eggert's avatar
Paul Eggert committed
493
;; Move to the beginning of current sexp.  Return the number of nested
494
;; sexp the point was over or after.
495
(defun eldoc-beginning-of-sexp ()
496 497
  (let ((parse-sexp-ignore-comments t)
	(num-skipped-sexps 0))
498
    (condition-case _
499 500 501
	(progn
	  ;; First account for the case the point is directly over a
	  ;; beginning of a nested sexp.
502
	  (condition-case _
503 504 505 506 507 508 509 510 511 512 513 514 515
	      (let ((p (point)))
		(forward-sexp -1)
		(forward-sexp 1)
		(when (< (point) p)
		  (setq num-skipped-sexps 1)))
	    (error))
	  (while
	      (let ((p (point)))
		(forward-sexp -1)
		(when (< (point) p)
		  (setq num-skipped-sexps (1+ num-skipped-sexps))))))
      (error))
    num-skipped-sexps))
516 517 518 519 520 521 522 523 524 525

;; returns nil unless current word is an interned symbol.
(defun eldoc-current-symbol ()
  (let ((c (char-after (point))))
    (and c
         (memq (char-syntax c) '(?w ?_))
         (intern-soft (current-word)))))

;; Do indirect function resolution if possible.
(defun eldoc-symbol-function (fsym)
526
  (let ((defn (symbol-function fsym)))
527
    (and (symbolp defn)
528
         (condition-case _
529 530 531
             (setq defn (indirect-function fsym))
           (error (setq defn nil))))
    defn))
Noah Friedman's avatar
Noah Friedman committed
532

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
(defun eldoc-function-argstring (arglist)
  "Return ARGLIST as a string enclosed by ().
ARGLIST is either a string, or a list of strings or symbols."
  (cond ((stringp arglist))
	((not (listp arglist))
	 (setq arglist nil))
	((symbolp (car arglist))
	 (setq arglist
	       (mapconcat (lambda (s) (symbol-name s))
			  arglist " ")))
	((stringp (car arglist))
	 (setq arglist
	       (mapconcat (lambda (s) s)
			  arglist " "))))
  (if arglist
      (format "(%s)" arglist)))

(defun eldoc-function-argstring-format (argstring)
551
  "Apply `eldoc-argument-case' to each word in ARGSTRING.
552 553
The words \"&rest\", \"&optional\" are returned unchanged."
  (mapconcat (lambda (s)
554
	       (if (string-match-p "\\`(?&\\(?:optional\\|rest\\))?\\'" s)
555 556
		   s
		 (funcall eldoc-argument-case s)))
557
	     (split-string argstring) " "))
558

Noah Friedman's avatar
Noah Friedman committed
559

560 561 562 563 564 565 566
;; When point is in a sexp, the function args are not reprinted in the echo
;; area after every possible interactive command because some of them print
;; their own messages in the echo area; the eldoc functions would instantly
;; overwrite them unless it is more restrained.
;; These functions do display-command table management.

(defun eldoc-add-command (&rest cmds)
567 568 569 570
  (dolist (name cmds)
    (and (symbolp name)
         (setq name (symbol-name name)))
    (set (intern name eldoc-message-commands) t)))
571 572

(defun eldoc-add-command-completions (&rest names)
573 574
  (dolist (name names)
    (apply 'eldoc-add-command (all-completions name obarray 'commandp))))
575 576

(defun eldoc-remove-command (&rest cmds)
577 578 579 580
  (dolist (name cmds)
    (and (symbolp name)
         (setq name (symbol-name name)))
    (unintern name eldoc-message-commands)))
581 582

(defun eldoc-remove-command-completions (&rest names)
583
  (dolist (name names)
584
    (apply 'eldoc-remove-command
585
           (all-completions name eldoc-message-commands))))
586

587

588 589
;; Prime the command list.
(eldoc-add-command-completions
590 591 592 593 594 595 596
 "backward-" "beginning-of-" "delete-other-windows" "delete-window"
 "down-list" "end-of-" "exchange-point-and-mark" "forward-" "goto-"
 "handle-select-window" "indent-for-tab-command" "left-" "mark-page"
 "mark-paragraph" "mouse-set-point" "move-" "move-beginning-of-"
 "move-end-of-" "next-" "other-window" "pop-global-mark" "previous-"
 "recenter" "right-" "scroll-" "self-insert-command" "split-window-"
 "up-list")
Noah Friedman's avatar
Noah Friedman committed
597 598 599 600

(provide 'eldoc)

;;; eldoc.el ends here