Mercurial > emacs
changeset 16969:436fd36233d1
Update copyright notice to reflect assignment to FSF and incorporation
into Emacs.
Attempt to load `timer'.
(eldoc-idle-delay): Make defconst.
(eldoc-minor-mode-string): Make defconst.
(eldoc-argument-case): Make defconst.
(eldoc-message-commands): Renamed from eldoc-mode-message-commands.
All callers changed.
Add `mouse-set-point' as a default candidate.
(eldoc-use-idle-timer-p): New constant.
(eldoc-timer): New variable.
(eldoc-current-idle-delay): New variable.
(eldoc-schedule-timer): New function.
(eldoc-mode): Use idle timers if supported.
(eldoc-add-command): Provide completion on interactive commands only, not
all bound functions.
(eldoc-print-current-symbol-info): Renamed from
eldoc-mode-print-current-symbol-info. All callers changed.
Check whether using idle timers or being run from post-command hooks.
Use `executing-kbd-macro' instead of `executing-macro'.
(eldoc-print-fnsym-args): Don't make interactive.
Cache current symbol name in eldoc-last-data; it was forgetting to do this
previously.
If subr args cannot be determined, show single-line docstring for it instead.
(eldoc-docstring-message): New function.
(eldoc-print-docstring): New function.
(eldoc-print-var-docstring): Use them.
(eldoc-function-argstring-from-docstring-method-table): New constant.
(eldoc-function-argstring-from-docstring): Use it.
| author | Noah Friedman <friedman@splode.com> |
|---|---|
| date | Mon, 03 Feb 1997 06:13:34 +0000 |
| parents | 7c030111c6bb |
| children | d2c5d2988a0a |
| files | lisp/emacs-lisp/eldoc.el |
| diffstat | 1 files changed, 282 insertions(+), 207 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/emacs-lisp/eldoc.el Mon Feb 03 02:51:09 1997 +0000 +++ b/lisp/emacs-lisp/eldoc.el Mon Feb 03 06:13:34 1997 +0000 @@ -1,45 +1,41 @@ ;;; eldoc.el --- show function arglist or variable docstring in echo area -;; Copyright (C) 1995 Noah S. Friedman +;; Copyright (C) 1996, 1997 Free Software Foundation, Inc. ;; Author: Noah Friedman <friedman@prep.ai.mit.edu> ;; Maintainer: friedman@prep.ai.mit.edu ;; Keywords: extensions -;; Status: Works in Emacs 19 and XEmacs. ;; Created: 1995-10-06 -;; LCD Archive Entry: -;; eldoc|Noah Friedman|friedman@prep.ai.mit.edu| -;; show function arglist or variable docstring in echo area| -;; $Date: 1996/07/14 16:46:25 $|$Revision: 1.6 $|~/misc/eldoc.el.gz| +;; $Id: eldoc.el,v 1.7 1996/10/04 04:43:42 friedman Exp $ -;; $Id: eldoc.el,v 1.6 1996/07/14 16:46:25 friedman Exp friedman $ +;; This file is part of GNU Emacs. -;; This program is free software; you can redistribute it and/or modify +;; GNU Emacs is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 2, or (at your option) ;; any later version. -;; -;; This program is distributed in the hope that it will be useful, + +;; GNU Emacs is distributed in the hope that it will be useful, ;; 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. -;; + ;; You should have received a copy of the GNU General Public License -;; along with this program; if not, you can either send email to this -;; program's maintainer or write to: The Free Software Foundation, -;; Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA. +;; along with GNU Emacs; see the file COPYING. If not, write to the +;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, +;; Boston, MA 02111-1307, USA. ;;; Commentary: -;; This program was inspired by the behavior of the Lisp Machine "mouse -;; documentation window"; as you type a function's symbol name as part of a -;; sexp, it will print the argument list for that function. However, this -;; program's behavior is different in a couple of significant ways. For -;; one, you need not actually type the function name; you need only move -;; point around in a sexp that calls it. However, 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 purpose. +;; 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. ;; One useful way to enable this minor mode is to put the following in your ;; .emacs: @@ -50,6 +46,13 @@ ;;; Code: +;; Use idle timers if available in the version of emacs running. +;; Please don't change this to use `require'; this package works as-is in +;; XEmacs (which doesn't have timer.el as of 19.14), and I would like to +;; maintain compatibility with that since I must use it sometimes. --Noah +(or (featurep 'timer) + (load "timer" t)) + ;;;###autoload (defvar eldoc-mode nil "*If non-nil, show the defined parameters for the elisp function near point. @@ -57,57 +60,66 @@ For the emacs lisp function at the beginning of the sexp which point is within, show the defined parameters for the function in the echo area. This information is extracted directly from the function or macro if it is -in pure lisp. - -If the emacs function is a subr, the parameters are obtained from the -documentation string if possible. +in pure lisp. If the emacs function is a subr, the parameters are obtained +from the documentation string if possible. If point is over a documented variable, print that variable's docstring -instead; see function `eldoc-print-var-docstring'. +instead. This variable is buffer-local.") (make-variable-buffer-local 'eldoc-mode) -(defvar eldoc-idle-delay 0.50 +(defconst eldoc-idle-delay 0.50 "*Number of seconds of idle time to wait before printing. If user input arrives before this interval of time has elapsed after the last input, no documentation will be printed. If this variable is set to 0, no idle time is required.") -(defvar eldoc-argument-case 'upcase +(defconst eldoc-minor-mode-string " ElDoc" + "*String to display in mode line when Eldoc Mode is enabled.") + +;; Put this minor mode on the global minor-mode-alist. +(or (assq 'eldoc-mode (default-value 'minor-mode-alist)) + (setq-default minor-mode-alist + (append (default-value 'minor-mode-alist) + '((eldoc-mode eldoc-minor-mode-string))))) + +(defconst eldoc-argument-case 'upcase "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 returns another string is acceptable.") -(defvar eldoc-mode-message-commands nil - "*Obarray of command names where it is appropriate to print in the echo area. +(defvar eldoc-message-commands nil + "*Commands after which it is appropriate to print in the echo area. + +Eldoc does not try to print function arglists, etc. after just any command, +because some commands print their own messages in the echo area and these +functions would instantly overwrite them. But self-insert-command as well +as most motion commands are good candidates. -This is not done for all commands since some print their own -messages in the echo area, and these functions would instantly overwrite -them. But self-insert-command as well as most motion commands are good -candidates. +This variable contains an obarray of symbols; it is probably best to +manipulate this data structure with the commands `eldoc-add-command' and +`eldoc-remove-command'.") -It is probably best to manipulate this data structure with the commands -`eldoc-add-command' and `eldoc-remove-command'.") - -(cond ((null eldoc-mode-message-commands) +(cond ((null eldoc-message-commands) ;; If you increase the number of buckets, keep it a prime number. - (setq eldoc-mode-message-commands (make-vector 31 0)) + (setq eldoc-message-commands (make-vector 31 0)) (let ((list '("self-insert-command" "next-" "previous-" "forward-" "backward-" "beginning-of-" "end-of-" "goto-" "recenter" - "scroll-")) + "scroll-" + "mouse-set-point")) (syms nil)) (while list (setq syms (all-completions (car list) obarray 'fboundp)) (setq list (cdr list)) (while syms - (set (intern (car syms) eldoc-mode-message-commands) t) + (set (intern (car syms) eldoc-message-commands) t) (setq syms (cdr syms))))))) ;; Bookkeeping; the car contains the last symbol read from the buffer. @@ -115,14 +127,15 @@ ;; be printed again if necessary without reconsing. (defvar eldoc-last-data '(nil . nil)) -(defvar eldoc-minor-mode-string " ElDoc" - "*String to display in mode line when Eldoc Mode is enabled.") +;; Idle timers are supported in Emacs 19.31 and later. +(defconst eldoc-use-idle-timer-p (fboundp 'run-with-idle-timer)) -;; Put this minor mode on the global minor-mode-alist. -(or (assq 'eldoc-mode (default-value 'minor-mode-alist)) - (setq-default minor-mode-alist - (append (default-value 'minor-mode-alist) - '((eldoc-mode eldoc-minor-mode-string))))) +;; eldoc's timer object, if using idle timers +(defvar eldoc-timer nil) + +;; idle time delay currently in use by timer. +;; This is used to determine if eldoc-idle-delay is changed by the user. +(defvar eldoc-current-idle-delay eldoc-idle-delay) ;; 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 @@ -137,15 +150,26 @@ ;;;###autoload (defun eldoc-mode (&optional prefix) - "*If non-nil, then enable eldoc-mode (see variable docstring)." + "*Enable or disable eldoc mode. +See documentation for the variable of the same name for more details. + +If called interactively with no prefix argument, toggle current condition +of the mode. +If called with a positive or negative prefix argument, enable or disable +the mode, respectively." (interactive "P") - ;; Make sure it's on the post-command-idle-hook if defined, otherwise put - ;; it on post-command-hook. The former first appeared in Emacs 19.30. - (add-hook (if (boundp 'post-command-idle-hook) - 'post-command-idle-hook - 'post-command-hook) - 'eldoc-mode-print-current-symbol-info) + (cond (eldoc-use-idle-timer-p + (add-hook 'post-command-hook 'eldoc-schedule-timer)) + (t + ;; Use post-command-idle-hook if defined, otherwise use + ;; post-command-hook. The former is only proper to use in Emacs + ;; 19.30; that is the first version in which it appeared, but it + ;; was obsolesced by idle timers in Emacs 19.31. + (add-hook (if (boundp 'post-command-idle-hook) + 'post-command-idle-hook + 'post-command-hook) + 'eldoc-print-current-symbol-info))) (setq eldoc-mode (if prefix (>= (prefix-numeric-value prefix) 0) @@ -165,15 +189,15 @@ (defun eldoc-add-command (cmd) "Add COMMAND to the list of commands which causes function arg display. -If called interactively, completion matches any bound function. +If called interactively, completion on defined commands is available. 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." - (interactive "aAdd function to eldoc message commands list: ") + (interactive "CAdd function to eldoc message commands list: ") (and (fboundp cmd) - (set (intern (symbol-name cmd) eldoc-mode-message-commands) t))) + (set (intern (symbol-name cmd) eldoc-message-commands) t))) (defun eldoc-remove-command (cmd) "Remove COMMAND from the list of commands which causes function arg display. @@ -186,24 +210,51 @@ overwrite them unless it is more restrained." (interactive (list (completing-read "Remove function from eldoc message commands list: " - eldoc-mode-message-commands 'boundp t))) + eldoc-message-commands 'boundp t))) (and (symbolp cmd) (setq cmd (symbol-name cmd))) (if (fboundp 'unintern) - (unintern cmd eldoc-mode-message-commands) - (let ((s (intern-soft cmd eldoc-mode-message-commands))) + (unintern cmd eldoc-message-commands) + (let ((s (intern-soft cmd eldoc-message-commands))) (and s (makunbound s))))) -(defun eldoc-mode-print-current-symbol-info () +;; Idle timers are part of Emacs 19.31 and later. +(defun eldoc-schedule-timer () + (or (and eldoc-timer + (memq eldoc-timer timer-idle-list)) + (setq eldoc-timer + (run-with-idle-timer eldoc-idle-delay t + 'eldoc-print-current-symbol-info))) + + ;; 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)))) + + +(defun eldoc-print-current-symbol-info () (and eldoc-mode - (not executing-macro) - ;; Having this mode operate in the minibuffer makes it impossible to - ;; see what you're doing. + (not executing-kbd-macro) + + ;; Having this mode operate in an active minibuffer makes it + ;; impossible to what you're doing. (not (eq (selected-window) (minibuffer-window))) - (sit-for eldoc-idle-delay) - (symbolp this-command) - (intern-soft (symbol-name this-command) eldoc-mode-message-commands) + + (cond (eldoc-use-idle-timer-p + (and (symbolp last-command) + (intern-soft (symbol-name last-command) + eldoc-message-commands))) + (t + ;; If we don't have idle timers, this function is + ;; running on post-command-hook directly; that means the + ;; user's last command is still on `this-command', and we + ;; must wait briefly for input to see whether to do display. + (and (symbolp this-command) + (intern-soft (symbol-name this-command) + eldoc-message-commands) + (sit-for eldoc-idle-delay)))) + (let ((current-symbol (eldoc-current-symbol)) (current-fnsym (eldoc-fnsym-in-current-sexp))) (cond ((eq current-symbol current-fnsym) @@ -212,70 +263,24 @@ (or (eldoc-print-var-docstring current-symbol) (eldoc-print-fnsym-args current-fnsym))))))) - -(defun eldoc-print-var-docstring (&optional sym) - "Print the brief (one-line) documentation string for the variable at point. -If called with no argument, print the first line of the variable -documentation string for the symbol at point in the echo area. -If called with a symbol, print the line for that symbol. - -If the entire line cannot fit in the echo area, the variable name may be -truncated or eliminated entirely from the output to make room. -Any leading `*' in the docstring (which indicates the variable is a user -option) is not printed." - (interactive) - (let* ((s (or sym (eldoc-current-symbol))) - (name (symbol-name s)) - (doc (and s (documentation-property s 'variable-documentation t)))) - (and doc - (save-match-data - (and (string-match "\n" doc) - (setq doc (substring doc 0 (match-beginning 0)))) - (and (string-match "^\\*" doc) - (setq doc (substring doc 1))) - (let* ((doclen (+ (length name) (length ": ") (length doc))) - ;; Subtract 1 from window width since emacs seems not to - ;; write any chars to the last column, at least for some - ;; terminal types. - (strip (- doclen (1- (window-width (minibuffer-window)))))) - (cond ((> strip 0) - (let* ((len (length name))) - (cond ((>= strip len) - (eldoc-message "%s" doc)) - (t - (setq name (substring name 0 (- len strip))) - (eldoc-message "%s: %s" name doc))))) - (t - (eldoc-message "%s: %s" s doc)))) - t)))) - - -;;;###autoload (defun eldoc-print-fnsym-args (&optional symbol) - "*Show the defined parameters for the function near point. -For the function at the beginning of the sexp which point is within, show -the defined parameters for the function in the echo area. -This information is extracted directly from the function or macro if it is -in pure lisp. -If the emacs function is a subr, the parameters are obtained from the -documentation string if possible." (interactive) (let ((sym (or symbol (eldoc-fnsym-in-current-sexp))) - (printit t) (args nil)) (cond ((not (and (symbolp sym) (fboundp sym)))) ((eq sym (car eldoc-last-data)) - (setq printit nil) (setq args (cdr eldoc-last-data))) ((subrp (eldoc-symbol-function sym)) - (setq args (eldoc-function-argstring-from-docstring sym)) + (setq args (or (eldoc-function-argstring-from-docstring sym) + (eldoc-docstring-first-line (documentation sym t)))) + (setcar eldoc-last-data sym) (setcdr eldoc-last-data args)) (t (setq args (eldoc-function-argstring sym)) + (setcar eldoc-last-data sym) (setcdr eldoc-last-data args))) (and args - printit (eldoc-message "%s: %s" sym args)))) (defun eldoc-fnsym-in-current-sexp () @@ -313,94 +318,6 @@ (t t)))) (eldoc-function-argstring-format arglist))) -(defun eldoc-function-argstring-from-docstring (fn) - (let ((docstring (documentation fn 'raw)) - (doc nil) - (doclist nil) - (end nil)) - (save-match-data - ;; TODO: Move these into a separate table that is iterated over until - ;; a match is found. - (cond - ;; Try first searching for args starting with symbol name. - ;; This is to avoid matching parenthetical remarks in e.g. sit-for. - ((string-match (format "^(%s[^\n)]*)$" fn) docstring) - ;; end does not include trailing ")" sequence. - (setq end (- (match-end 0) 1)) - (if (string-match " +" docstring (match-beginning 0)) - (setq doc (substring docstring (match-end 0) end)) - (setq doc ""))) - - ;; Try again not requiring this symbol name in the docstring. - ;; This will be the case when looking up aliases. - ((string-match (format "^([^\n)]+)$" fn) docstring) - ;; end does not include trailing ")" sequence. - (setq end (- (match-end 0) 1)) - (if (string-match " +" docstring (match-beginning 0)) - (setq doc (substring docstring (match-end 0) end)) - (setq doc ""))) - - ;; Emacs subr docstring style: - ;; (fn arg1 arg2 ...): description... - ((string-match "^([^\n)]+):" docstring) - ;; end does not include trailing "):" sequence. - (setq end (- (match-end 0) 2)) - (if (string-match " +" docstring (match-beginning 0)) - (setq doc (substring docstring (match-end 0) end)) - (setq doc ""))) - - ;; XEmacs subr docstring style: - ;; "arguments: (arg1 arg2 ...) - ((string-match "^arguments: (\\([^\n)]+\\))" docstring) - ;; Also, skip leading paren, but the first word is actually an - ;; argument, not the function name. - (setq doc (substring docstring - (match-beginning 1) - (match-end 1)))) - - ;; This finds the argstring for `condition-case'. - ;; I don't know if there are any others with the same pattern. - ((string-match (format "^Usage looks like \\((%s[^\n)]*)\\)\\.$" fn) - docstring) - ;; end does not include trailing ")" sequence. - (setq end (- (match-end 1) 1)) - (if (string-match " +" docstring (match-beginning 1)) - (setq doc (substring docstring (match-end 0) end)) - (setq doc ""))) - - ;; This finds the argstring for `setq-default'. - ;; I don't know if there are any others with the same pattern. - ((string-match (format "^[ \t]+\\((%s[^\n)]*)\\)$" fn) docstring) - ;; end does not include trailing ")" sequence. - (setq end (- (match-end 1) 1)) - (if (string-match " +" docstring (match-beginning 1)) - (setq doc (substring docstring (match-end 0) end)) - (setq doc ""))) - - ;; This finds the argstring for `start-process'. - ;; I don't know if there are any others with the same pattern. - ((string-match "^Args are +\\([^\n]+\\)$" docstring) - (setq doc (substring docstring (match-beginning 1) (match-end 1)))) - ) - - (cond ((not (stringp doc)) - nil) - ((string-match "&" doc) - (let ((p 0) - (l (length doc))) - (while (< p l) - (cond ((string-match "[ \t\n]+" doc p) - (setq doclist - (cons (substring doc p (match-beginning 0)) - doclist)) - (setq p (match-end 0))) - (t - (setq doclist (cons (substring doc p) doclist)) - (setq p l)))) - (eldoc-function-argstring-format (nreverse doclist)))) - (t - (concat "(" (funcall eldoc-argument-case doc) ")")))))) - (defun eldoc-function-argstring-format (arglist) (cond ((not (listp arglist)) (setq arglist nil)) @@ -422,6 +339,164 @@ (concat "(" (mapconcat 'identity arglist " ") ")")) +(defun eldoc-print-var-docstring (&optional sym) + (or sym (setq sym (eldoc-current-symbol))) + (eldoc-print-docstring sym (documentation-property + sym 'variable-documentation t))) + +;; Print the brief (one-line) documentation string for the symbol. +(defun eldoc-print-docstring (symbol doc) + (and doc + (eldoc-message "%s" (eldoc-docstring-message symbol doc)))) + +;; If the entire line cannot fit in the echo area, the variable name may be +;; truncated or eliminated entirely from the output to make room. +;; Any leading `*' in the docstring (which indicates the variable is a user +;; option) is not printed." +(defun eldoc-docstring-message (symbol doc) + (and doc + (let ((name (symbol-name symbol))) + (setq doc (eldoc-docstring-first-line doc)) + (save-match-data + (let* ((doclen (+ (length name) (length ": ") (length doc))) + ;; Subtract 1 from window width since emacs seems not to + ;; write any chars to the last column, at least for some + ;; terminal types. + (strip (- doclen (1- (window-width (minibuffer-window)))))) + (cond ((> strip 0) + (let* ((len (length name))) + (cond ((>= strip len) + (format "%s" doc)) + (t + (setq name (substring name 0 (- len strip))) + (format "%s: %s" name doc))))) + (t + (format "%s: %s" symbol doc)))))))) + +(defun eldoc-docstring-first-line (doc) + (save-match-data + (and (string-match "\n" doc) + (setq doc (substring doc 0 (match-beginning 0)))) + (and (string-match "^\\*" doc) + (setq doc (substring doc 1)))) + doc) + + +;; Alist of predicate/action pairs. +;; Each member of the list is a sublist consisting of a predicate function +;; used to determine if the arglist for a function can be found using a +;; certain pattern, and a function which returns the actual arglist from +;; that docstring. +;; +;; The order in this table is significant, since later predicates may be +;; more general than earlier ones. +;; +;; Compiler note for Emacs 19.29 and later: these functions will be +;; compiled to bytecode, but can't be lazy-loaded even if you set +;; byte-compile-dynamic; to do that would require making them named +;; top-level defuns, and that's not particularly desirable either. +(defconst eldoc-function-argstring-from-docstring-method-table + (list + ;; Try first searching for args starting with symbol name. + ;; This is to avoid matching parenthetical remarks in e.g. sit-for. + (list (function (lambda (doc fn) + (string-match (format "^(%s[^\n)]*)$" fn) doc))) + (function (lambda (doc) + ;; end does not include trailing ")" sequence. + (let ((end (- (match-end 0) 1))) + (if (string-match " +" doc (match-beginning 0)) + (substring doc (match-end 0) end) + ""))))) + + ;; Try again not requiring this symbol name in the docstring. + ;; This will be the case when looking up aliases. + (list (function (lambda (doc fn) + (string-match "^([^\n)]+)$" doc))) + (function (lambda (doc) + ;; end does not include trailing ")" sequence. + (let ((end (- (match-end 0) 1))) + (and (string-match " +" doc (match-beginning 0)) + (substring doc (match-end 0) end)))))) + + ;; Emacs subr docstring style: + ;; (fn arg1 arg2 ...): description... + (list (function (lambda (doc fn) + (string-match "^([^\n)]+):" doc))) + (function (lambda (doc) + ;; end does not include trailing "):" sequence. + (let ((end (- (match-end 0) 2))) + (and (string-match " +" doc (match-beginning 0)) + (substring doc (match-end 0) end)))))) + + ;; XEmacs subr docstring style: + ;; "arguments: (arg1 arg2 ...) + (list (function (lambda (doc fn) + (string-match "^arguments: (\\([^\n)]+\\))" doc))) + (function (lambda (doc) + ;; also skip leading paren, but the first word is + ;; actually an argument, not the function name. + (substring doc (match-beginning 1) (match-end 1))))) + + ;; This finds the argstring for `condition-case'. Any others? + (list (function (lambda (doc fn) + (string-match + (format "^Usage looks like \\((%s[^\n)]*)\\)\\.$" fn) + doc))) + (function (lambda (doc) + ;; end does not include trailing ")" sequence. + (let ((end (- (match-end 1) 1))) + (and (string-match " +" doc (match-beginning 1)) + (substring doc (match-end 0) end)))))) + + ;; This finds the argstring for `setq-default'. Any others? + (list (function (lambda (doc fn) + (string-match (format "^[ \t]+\\((%s[^\n)]*)\\)$" fn) + doc))) + (function (lambda (doc) + ;; end does not include trailing ")" sequence. + (let ((end (- (match-end 1) 1))) + (and (string-match " +" doc (match-beginning 1)) + (substring doc (match-end 0) end)))))) + + ;; This finds the argstring for `start-process'. Any others? + (list (function (lambda (doc fn) + (string-match "^Args are +\\([^\n]+\\)$" doc))) + (function (lambda (doc) + (substring doc (match-beginning 1) (match-end 1))))) + )) + +(defun eldoc-function-argstring-from-docstring (fn) + (let ((docstring (documentation fn 'raw)) + (table eldoc-function-argstring-from-docstring-method-table) + (doc nil) + (doclist nil)) + (save-match-data + (while table + (cond ((funcall (car (car table)) docstring fn) + (setq doc (funcall (car (cdr (car table))) docstring)) + (setq table nil)) + (t + (setq table (cdr table))))) + + (cond ((not (stringp doc)) + nil) + ((string-match "&" doc) + (let ((p 0) + (l (length doc))) + (while (< p l) + (cond ((string-match "[ \t\n]+" doc p) + (setq doclist + (cons (substring doc p (match-beginning 0)) + doclist)) + (setq p (match-end 0))) + (t + (setq doclist (cons (substring doc p) doclist)) + (setq p l)))) + (eldoc-function-argstring-format (nreverse doclist)))) + (t + (concat "(" (funcall eldoc-argument-case doc) ")")))))) + + ;; forward-sexp calls scan-sexps, which returns an error if it hits the ;; beginning or end of the sexp. This returns nil instead. (defun eldoc-forward-sexp-safe (&optional count)