eldoc.el 26.1 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
(require 'help-fns)		       ;For fundoc-usage handling functions.
51
(require 'cl-lib)
52

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

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

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

67 68 69 70 71 72
(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)

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

79
(defcustom eldoc-argument-case #'identity
Noah Friedman's avatar
Noah Friedman committed
80 81 82
  "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
83 84 85 86
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."
87 88 89
  :type '(radio (function-item upcase)
		(function-item downcase)
                function)
90
  :group 'eldoc)
91
(make-obsolete-variable 'eldoc-argument-case nil "24.5")
Noah Friedman's avatar
Noah Friedman committed
92

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

99
If value is any non-nil value other than t, symbol name may be truncated
100 101 102 103 104 105
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
106 107 108 109
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."
110 111 112 113 114 115
  :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)

116 117
(defface eldoc-highlight-function-argument
  '((t (:inherit bold)))
118 119 120
  "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."
121 122
  :group 'eldoc)

123 124
;;; No user options below here.

125
(defvar eldoc-message-commands-table-size 31
126
  "Used by `eldoc-add-command' to initialize `eldoc-message-commands' obarray.
127 128 129 130 131 132 133 134
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.
135
ElDoc does not try to print function arglists, etc., after just any command,
136
because some commands print their own messages in the echo area and these
137
functions would instantly overwrite them.  But `self-insert-command' as well
138 139 140 141
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'.")

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

150
(defvar eldoc-last-message nil)
Noah Friedman's avatar
Noah Friedman committed
151

152
(defvar eldoc-timer nil "ElDoc's timer object.")
153

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

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

162 163 164 165 166 167 168 169 170 171
(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
172 173

;;;###autoload
174
(define-minor-mode eldoc-mode
Chong Yidong's avatar
Chong Yidong committed
175 176 177 178 179 180 181 182 183 184 185
  "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
186
  :group 'eldoc :lighter eldoc-minor-mode-string
187
  (setq eldoc-last-message nil)
188 189
  (if eldoc-mode
      (progn
190 191
	(when eldoc-print-after-edit
	  (setq-local eldoc-message-commands (eldoc-edit-message-commands)))
192
	(add-hook 'post-command-hook 'eldoc-schedule-timer nil t)
Leo Liu's avatar
Leo Liu committed
193
	(add-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area nil t))
194 195 196
    (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)))
197

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

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

  ;; 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))))

215 216 217 218 219 220 221 222
(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
223
	(add-hook 'minibuffer-exit-hook
224 225 226
		  (lambda () (setq eldoc-mode-line-string nil
			      ;; http://debbugs.gnu.org/16920
			      eldoc-last-message nil))
227
		  nil t)
228 229 230 231 232 233 234 235 236 237
	(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 " "))
238 239 240 241 242
			mode-line-format)))
          (setq eldoc-mode-line-string
                (when (stringp format-string)
                  (apply 'format format-string args)))
          (force-mode-line-update)))
243 244
    (apply 'message format-string args)))

245 246
(defun eldoc-message (&rest args)
  (let ((omessage eldoc-last-message))
247
    (setq eldoc-last-message
248 249 250 251 252 253 254
	  (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))))
255 256 257
    ;; 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.
258 259
    ;; Emacs way of preventing log messages.
    (let ((message-log-max nil))
260 261 262
      (cond (eldoc-last-message
	     (funcall eldoc-message-function "%s" eldoc-last-message))
	    (omessage (funcall eldoc-message-function nil)))))
263 264
  eldoc-last-message)

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

269 270 271 272 273 274 275 276
;; 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
277
       (not (minibufferp))      ;We don't use the echo area when in minibuffer.
278
       (if (and (eldoc-display-message-no-interference-p)
279
		(eldoc--message-command-p this-command))
280
	   (eldoc-message eldoc-last-message)
281 282
         ;; 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.
283
         (setq eldoc-last-message nil))))
284 285 286

;; Decide whether now is a good time to display a message.
(defun eldoc-display-message-p ()
287
  (and (eldoc-display-message-no-interference-p)
288 289 290 291
       ;; 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.
292 293 294
       (not this-command)
       (eldoc--message-command-p last-command)))

Noah Friedman's avatar
Noah Friedman committed
295

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

301

302
;;;###autoload
303 304
(defvar eldoc-documentation-function #'eldoc-documentation-function-default
  "Function to call to return doc string.
305 306 307 308 309 310
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.

311 312 313 314 315
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.

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

319
(defun eldoc-print-current-symbol-info ()
320 321 322
  ;; 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"
323 324 325 326 327
    (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))
328 329 330 331 332 333 334 335 336 337 338 339 340 341
	 (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))))))
342

343
(defun eldoc-get-fnsym-args-string (sym &optional index)
344 345
  "Return a string containing the parameter list of the function SYM.
If SYM is a subr and no arglist is obtainable from the docstring
346
or elsewhere, return a 1-line docstring."
347 348 349
  (let ((argstring
	 (cond
	  ((not (and sym (symbolp sym) (fboundp sym))) nil)
350 351
	  ((and (eq sym (aref eldoc-last-data 0))
		(eq 'function (aref eldoc-last-data 2)))
352
	   (aref eldoc-last-data 1))
353
	  (t
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
	   (let* ((advertised (gethash (indirect-function sym)
                                       advertised-signature-table t))
                  doc
		  (args
		   (cond
		    ((listp advertised) advertised)
		    ((setq doc (help-split-fundoc (documentation sym t) sym))
		     (car doc))
		    (t (help-function-arglist sym)))))
             ;; Stringify, and store before highlighting, downcasing, etc.
             ;; FIXME should truncate before storing.
	     (eldoc-last-data-store sym (eldoc-function-argstring args)
                                    'function))))))
    ;; Highlight, truncate.
    (if argstring
	(eldoc-highlight-function-argument sym argstring index))))
370

371 372 373
(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'."
374 375 376
  ;; FIXME: This should probably work on the list representation of `args'
  ;; rather than its string representation.
  ;; FIXME: This function is much too long, we need to split it up!
377 378
  (let ((start          nil)
	(end            0)
379 380 381 382 383
	(argument-face  'eldoc-highlight-function-argument)
        (args-lst (mapcar (lambda (x)
                            (replace-regexp-in-string
                             "\\`[(]\\|[)]\\'" "" x))
                          (split-string args))))
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 392 393 394 395 396

    ;; When `&key' is used finding position based on `index'
    ;; would be wrong, so find the arg at point and determine
    ;; position in ARGS based on this current arg.
    (when (string-match "&key" args)
      (let* (case-fold-search
397 398
             key-have-value
             (sym-name (symbol-name sym))
399
             (cur-w (current-word))
400
             (args-lst-ak (cdr (member "&key" args-lst)))
401
             (limit (save-excursion
402
                      (when (re-search-backward sym-name nil t)
403
                        (match-end 0))))
404
             (cur-a (if (and cur-w (string-match ":\\([^ ()]*\\)" cur-w))
405 406
                        (substring cur-w 1)
                      (save-excursion
407 408 409 410 411 412 413
                        (let (split)
                          (when (re-search-backward ":\\([^()\n]*\\)" limit t)
                            (setq split (split-string (match-string 1) " " t))
                            (prog1 (car split)
                              (when (cdr split)
                                (setq key-have-value t))))))))
             ;; If `cur-a' is not one of `args-lst-ak'
Paul Eggert's avatar
Paul Eggert committed
414
             ;; assume user is entering an unknown key
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
             ;; referenced in last position in signature.
             (other-key-arg (and (stringp cur-a)
                                 args-lst-ak
                                 (not (member (upcase cur-a) args-lst-ak))
                                 (upcase (car (last args-lst-ak))))))
        (unless (string= cur-w sym-name)
          ;; The last keyword have already a value
          ;; i.e :foo a b and cursor is at b.
          ;; If signature have also `&rest'
          ;; (assume it is after the `&key' section)
          ;; go to the arg after `&rest'.
          (if (and key-have-value
                   (save-excursion
                     (not (re-search-forward ":.*" (point-at-eol) t)))
                   (string-match "&rest \\([^ ()]*\\)" args))
              (setq index nil ; Skip next block based on positional args.
                    start (match-beginning 1)
                    end   (match-end 1))
            ;; If `cur-a' is nil probably cursor is on a positional arg
            ;; before `&key', in this case, exit this block and determine
            ;; position with `index'.
            (when (and cur-a     ; A keyword arg (dot removed) or nil.
                       (or (string-match
                            (concat "\\_<" (upcase cur-a) "\\_>") args)
                           (string-match
                            (concat "\\_<" other-key-arg "\\_>") args)))
              (setq index nil ; Skip next block based on positional args.
                    start (match-beginning 0)
                    end   (match-end 0)))))))
444
    ;; Handle now positional arguments.
445
    (while (and index (>= index 1))
446 447 448 449 450 451 452 453
      (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))
454
		    ((string= argument "&optional"))         ; Skip.
455 456 457
                    ((string= argument "&allow-other-keys")) ; Skip.
                    ;; Back to index 0 in ARG1 ARG2 ARG2 ARG3 etc...
                    ;; like in `setq'.
458 459 460 461 462
		    ((or (and (string-match-p "\\.\\.\\.$" argument)
                              (string= argument (car (last args-lst))))
                         (and (string-match-p "\\.\\.\\.$"
                                              (substring args 1 (1- (length args))))
                              (= (length (remove "..." args-lst)) 2)
463 464
                              (> index 1) (cl-oddp index)))
                     (setq index 0))
465 466 467 468 469 470 471 472 473 474 475
		    (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
476 477
		 sym doc (if (functionp sym) 'font-lock-function-name-face
                           'font-lock-keyword-face)))
478 479
      doc)))

480 481 482
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
483 484 485 486 487 488 489 490 491 492 493
  (cond ((not sym) nil)
        ((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)))
           (when doc
             (let ((doc (eldoc-docstring-format-sym-doc
                         sym (eldoc-docstring-first-line doc)
                         'font-lock-variable-name-face)))
               (eldoc-last-data-store sym doc 'variable)))))))
494 495 496 497

(defun eldoc-last-data-store (symbol doc type)
  (aset eldoc-last-data 0 symbol)
  (aset eldoc-last-data 1 doc)
498 499
  (aset eldoc-last-data 2 type)
  doc)
500 501 502 503 504 505 506

;; 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
507 508 509
	  ;; 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)))
510 511 512 513 514 515 516 517
            (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.
518
(defun eldoc-docstring-format-sym-doc (sym doc face)
519 520
  (save-match-data
    (let* ((name (symbol-name sym))
521
           (ea-multi eldoc-echo-area-use-multiline-p)
522 523 524 525 526 527 528 529
           ;; 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)))
530
             (format "%s: %s" (propertize name 'face face) doc))
531 532 533 534
            ((> (length doc) ea-width)
             (substring (format "%s" doc) 0 ea-width))
            ((>= strip (length name))
             (format "%s" doc))
535
            (t
536 537 538 539
             ;; 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))
540
             (format "%s: %s" (propertize name 'face face) doc))))))
Noah Friedman's avatar
Noah Friedman committed
541

542

543
;; Return a list of current function name and argument index.
Noah Friedman's avatar
Noah Friedman committed
544
(defun eldoc-fnsym-in-current-sexp ()
545 546 547 548 549 550 551 552 553 554
  (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
555
;; Move to the beginning of current sexp.  Return the number of nested
556
;; sexp the point was over or after.
557
(defun eldoc-beginning-of-sexp ()
558 559
  (let ((parse-sexp-ignore-comments t)
	(num-skipped-sexps 0))
560
    (condition-case _
561 562 563
	(progn
	  ;; First account for the case the point is directly over a
	  ;; beginning of a nested sexp.
564
	  (condition-case _
565 566 567 568 569 570 571 572 573 574 575 576 577
	      (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))
578 579 580 581 582 583 584 585 586 587

;; 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)
588
  (let ((defn (symbol-function fsym)))
589
    (and (symbolp defn)
590
         (condition-case _
591 592 593
             (setq defn (indirect-function fsym))
           (error (setq defn nil))))
    defn))
Noah Friedman's avatar
Noah Friedman committed
594

595 596 597
(defun eldoc-function-argstring (arglist)
  "Return ARGLIST as a string enclosed by ().
ARGLIST is either a string, or a list of strings or symbols."
598 599 600
  (let ((str (cond ((stringp arglist) arglist)
                   ((not (listp arglist)) nil)
                   (t (format "%S" (help-make-usage 'toto arglist))))))
601
    (if (and str (string-match "\\`([^ )]+ ?" str))
602 603
        (replace-match "(" t t str)
      str)))
604

Noah Friedman's avatar
Noah Friedman committed
605

606 607 608 609 610 611 612
;; 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)
613 614 615 616
  (dolist (name cmds)
    (and (symbolp name)
         (setq name (symbol-name name)))
    (set (intern name eldoc-message-commands) t)))
617 618

(defun eldoc-add-command-completions (&rest names)
619 620
  (dolist (name names)
    (apply 'eldoc-add-command (all-completions name obarray 'commandp))))
621 622

(defun eldoc-remove-command (&rest cmds)
623 624 625 626
  (dolist (name cmds)
    (and (symbolp name)
         (setq name (symbol-name name)))
    (unintern name eldoc-message-commands)))
627 628

(defun eldoc-remove-command-completions (&rest names)
629
  (dolist (name names)
630
    (apply 'eldoc-remove-command
631
           (all-completions name eldoc-message-commands))))
632

633

634 635
;; Prime the command list.
(eldoc-add-command-completions
636 637 638 639 640 641 642
 "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
643 644 645 646

(provide 'eldoc)

;;; eldoc.el ends here