xemacs-beta: lisp/utils/eldoc.el comparison

comparison lisp/utils/eldoc.el @ 24:4103f0995bd7 r19-15b95

Import from CVS: tag r19-15b95

author	cvs
date	Mon, 13 Aug 2007 08:51:03 +0200
parents	8fc7fe29b841
children

comparison

equal deleted inserted replaced

-:0edd3412f124
+:4103f0995bd7
 ;; Author: Noah Friedman <friedman@prep.ai.mit.edu>
 ;; Maintainer: friedman@prep.ai.mit.edu
 ;; Keywords: extensions
 ;; Created: 1995-10-06
-;; $Id: eldoc.el,v 1.1 1997/02/14 20:00:10 steve Exp $
+;; $Id: eldoc.el,v 1.2 1997/02/22 22:08:00 steve Exp $
 ;; This file is part of GNU Emacs.
 ;; 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
 ;; .emacs:
 ;;
 ;;      (autoload 'turn-on-eldoc-mode "eldoc" nil t)
 ;;      (add-hook 'emacs-lisp-mode-hook 'turn-on-eldoc-mode)
 ;;      (add-hook 'lisp-interaction-mode-hook 'turn-on-eldoc-mode)
+;;      (add-hook 'ielm-mode-hook 'turn-on-eldoc-mode)
 ;;; 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
 "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.")
+;; No user options below here.
 (defvar eldoc-message-commands nil
-"*Commands after which it is appropriate to print in the echo area.
+"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 variable contains an obarray of symbols; it is probably best to
+This variable contains an obarray of symbols; do not manipulate it
-manipulate this data structure with the commands `eldoc-add-command' and
+directly.  Instead, use the functions `eldoc-add-command' and
 `eldoc-remove-command'.")
-(cond ((null eldoc-message-commands)
+;; This is used by eldoc-add-command to initialize eldoc-message-commands
-;; If you increase the number of buckets, keep it a prime number.
+;; as an obarray.
-(setq eldoc-message-commands (make-vector 31 0))
+;; If you increase the number of buckets, keep it a prime number.
-(let ((list '("self-insert-command"
+(defconst eldoc-message-commands-table-size 31)
-"next-"         "previous-"
-"forward-"      "backward-"
-"beginning-of-" "end-of-"
-"goto-"
-"recenter"
-"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-message-commands) t)
-(setq syms (cdr syms)))))))
 ;; Bookkeeping; the car contains the last symbol read from the buffer.
 ;; The cdr contains the string last displayed in the echo area, so it can
 ;; be printed again if necessary without reconsing.
 (defvar eldoc-last-data '(nil . nil))
+(defvar eldoc-last-message nil)
 ;; Idle timers are supported in Emacs 19.31 and later.
 (defconst eldoc-use-idle-timer-p (fboundp 'run-with-idle-timer))
 ;; 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
-;; they are Legion.
-(defmacro eldoc-message (&rest args)
-(if (fboundp 'display-message)
-;; XEmacs 19.13 way of preventing log messages.
-(list 'display-message '(quote no-log) (apply 'list 'format args))
-(list 'let (list (list 'message-log-max 'nil))
-(apply 'list 'message args))))
 ;;;###autoload
 (defun eldoc-mode (&optional prefix)
 "*Enable or disable eldoc mode.
 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")
+(setq eldoc-last-message nil)
 (cond (eldoc-use-idle-timer-p
-(add-hook 'post-command-hook 'eldoc-schedule-timer))
+(add-hook 'post-command-hook 'eldoc-schedule-timer)
+(add-hook 'pre-command-hook 'eldoc-pre-command-refresh-echo-area))
 (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)))
+'eldoc-print-current-symbol-info)
+;; quick and dirty hack for seeing if this is XEmacs
+(and (fboundp 'display-message)
+(add-hook 'pre-command-hook
+'eldoc-pre-command-refresh-echo-area))))
 (setq eldoc-mode (if prefix
 (>= (prefix-numeric-value prefix) 0)
 (not eldoc-mode)))
 (and (interactive-p)
 (if eldoc-mode
 (message "eldoc-mode is enabled")
 (message "eldoc-mode is disabled")))
 eldoc-mode)
 ;;;###autoload
 (defun turn-on-eldoc-mode ()
 "Unequivocally turn on eldoc-mode (see variable documentation)."
 (interactive)
 (eldoc-mode 1))
-(defun eldoc-add-command (cmd)
-"Add COMMAND to the list of commands which causes function arg display.
-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 "CAdd function to eldoc message commands list: ")
-(and (fboundp cmd)
-(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.
-If called interactively, completion matches only those functions currently
-in the list.
-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 (list (completing-read
-"Remove function from eldoc message commands list: "
-eldoc-message-commands 'boundp t)))
-(and (symbolp cmd)
-(setq cmd (symbol-name cmd)))
-(if (fboundp 'unintern)
-(unintern cmd eldoc-message-commands)
-(let ((s (intern-soft cmd eldoc-message-commands)))
-(and s
-(makunbound s)))))
 ;; Idle timers are part of Emacs 19.31 and later.
 (defun eldoc-schedule-timer ()
 (or (and eldoc-timer
 (memq eldoc-timer timer-idle-list))
 ;; 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))))
+;; 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
+(if (eldoc-display-message-no-interference-p)
+(eldoc-message eldoc-last-message)
+(setq eldoc-last-message nil))))
+(defun eldoc-message (&rest args)
+(let ((omessage eldoc-last-message))
+(cond ((eq (car args) eldoc-last-message))
+((or (null args)
+(null (car args)))
+(setq eldoc-last-message nil))
+(t
+(setq eldoc-last-message (apply 'format args))))
+;; 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.
+(if (fboundp 'display-message)
+;; XEmacs 19.13 way of preventing log messages.
+(if eldoc-last-message
+(display-message 'no-log eldoc-last-message)
+(and omessage
+(clear-message 'no-log)))
+(let ((message-log-max nil))
+(if eldoc-last-message
+(message "%s" eldoc-last-message)
+(and omessage
+(message nil))))))
+eldoc-last-message)
 (defun eldoc-print-current-symbol-info ()
-(and eldoc-mode
+(and (eldoc-display-message-p)
-(not executing-kbd-macro)
+(let ((current-symbol (eldoc-current-symbol))
+(current-fnsym  (eldoc-fnsym-in-current-sexp)))
-;; Having this mode operate in an active minibuffer makes it
+(or (cond ((eq current-symbol current-fnsym)
-;; impossible to see what you're doing.
+(or (eldoc-print-fnsym-args current-fnsym)
-(not (eq (selected-window) (minibuffer-window)))
+(eldoc-print-var-docstring current-symbol)))
+(t
+(or (eldoc-print-var-docstring current-symbol)
+(eldoc-print-fnsym-args current-fnsym))))
+(eldoc-message nil)))))
+;; Decide whether now is a good time to display a message.
+(defun eldoc-display-message-p ()
+(and (eldoc-display-message-no-interference-p)
 (cond (eldoc-use-idle-timer-p
-(and (symbolp last-command)
+;; 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.
+(and (not this-command)
+(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))))
+(sit-for eldoc-idle-delay))))))
-(let ((current-symbol (eldoc-current-symbol))
+(defun eldoc-display-message-no-interference-p ()
-(current-fnsym  (eldoc-fnsym-in-current-sexp)))
+(and eldoc-mode
-(cond ((eq current-symbol current-fnsym)
+(not executing-kbd-macro)
-(eldoc-print-fnsym-args current-fnsym))
+;; Having this mode operate in an active minibuffer/echo area causes
-(t
+;; interference with what's going on there.
-(or (eldoc-print-var-docstring current-symbol)
+(not cursor-in-echo-area)
-(eldoc-print-fnsym-args current-fnsym)))))))
+(not (eq (selected-window) (minibuffer-window)))))
-(defun eldoc-print-fnsym-args (&optional symbol)
+(defun eldoc-print-fnsym-args (sym)
 (interactive)
-(let ((sym (or symbol (eldoc-fnsym-in-current-sexp)))
+(let ((args nil))
-(args nil))
+(cond ((not (and sym
-(cond ((not (and (symbolp sym)
+(symbolp sym)
 (fboundp sym))))
 ((eq sym (car eldoc-last-data))
 (setq args (cdr eldoc-last-data)))
 ((subrp (eldoc-symbol-function sym))
 (setq args (or (eldoc-function-argstring-from-docstring sym)
 (setcdr eldoc-last-data args)))
 (and args
 (eldoc-message "%s: %s" sym args))))
 (defun eldoc-fnsym-in-current-sexp ()
-(let* ((p (point))
+(let ((p (point)))
-(sym (progn
+(eldoc-beginning-of-sexp)
-(while (and (eldoc-forward-sexp-safe -1)
+(prog1
-(> (point) (point-min))))
+;; Don't do anything if current word is inside a string.
-(cond ((or (= (point) (point-min))
+(if (= (or (char-after (1- (point))) 0) ?\")
-(memq (or (char-after (point)) 0)
+nil
-'(?\( ?\"))
+(eldoc-current-symbol))
-;; If we hit a quotation mark before a paren, we
+(goto-char p))))
-;; are inside a specific string, not a list of
-;; symbols.
+(defun eldoc-beginning-of-sexp ()
-(eq (or (char-after (1- (point))) 0) ?\"))
+(let ((parse-sexp-ignore-comments t))
-nil)
+(condition-case err
-(t (condition-case nil
+(while (progn
-(read (current-buffer))
+(forward-sexp -1)
-(error nil)))))))
+(or (= (or (char-after (1- (point)))) ?\")
-(goto-char p)
+(> (point) (point-min)))))
-(and (symbolp sym)
+(error nil))))
-sym)))
+;; 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)
+(let ((defn (and (fboundp fsym)
+(symbol-function fsym))))
+(and (symbolp defn)
+(condition-case err
+(setq defn (indirect-function fsym))
+(error (setq defn nil))))
+defn))
 (defun eldoc-function-argstring (fn)
 (let* ((prelim-def (eldoc-symbol-function fn))
 (def (if (eq (car-safe prelim-def) 'macro)
 (cdr prelim-def)
 (funcall eldoc-argument-case s))))
 arglist))))
 (concat "(" (mapconcat 'identity arglist " ") ")"))
-(defun eldoc-print-var-docstring (&optional sym)
+(defun eldoc-print-var-docstring (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)
 ;; 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)))))
+;; These subrs don't have arglists in their docstrings.
+;; This is cheating.
+(list (function (lambda (doc fn)
+(memq fn '(and or list + -))))
+(function (lambda (doc)
+;; The value nil is a placeholder; otherwise, the
+;; following string may be compiled as a docstring,
+;; and not a return value for the function.
+;; In interpreted lisp form they are
+;; indistinguishable; it only matters for compiled
+;; forms.
+nil
+"&rest args")))
 ))
 (defun eldoc-function-argstring-from-docstring (fn)
 (let ((docstring (documentation fn 'raw))
 (table eldoc-function-argstring-from-docstring-method-table)
 (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
+;; When point is in a sexp, the function args are not reprinted in the echo
-;; beginning or end of the sexp.  This returns nil instead.
+;; area after every possible interactive command because some of them print
-(defun eldoc-forward-sexp-safe (&optional count)
+;; their own messages in the echo area; the eldoc functions would instantly
-"Move forward across one balanced expression (sexp).
+;; overwrite them unless it is more restrained.
-With argument, do it that many times.  Negative arg -COUNT means
+;; These functions do display-command table management.
-move backward across COUNT balanced expressions.
-Return distance in buffer moved, or nil."
+(defun eldoc-add-command (&rest cmds)
-(or count (setq count 1))
+(or eldoc-message-commands
-(condition-case err
+(setq eldoc-message-commands
-(- (- (point) (progn
+(make-vector eldoc-message-commands-table-size 0)))
-(let ((parse-sexp-ignore-comments t))
-(forward-sexp count))
+(let (name sym)
-(point))))
+(while cmds
-(error nil)))
+(setq name (car cmds))
+(setq cmds (cdr cmds))
-;; Do indirect function resolution if possible.
-(defun eldoc-symbol-function (fsym)
+(cond ((symbolp name)
-(let ((defn (and (fboundp fsym)
+(setq sym name)
-(symbol-function fsym))))
+(setq name (symbol-name sym)))
-(and (symbolp defn)
+((stringp name)
-(condition-case err
+(setq sym (intern-soft name))))
-(setq defn (indirect-function fsym))
-(error (setq defn nil))))
+(and (symbolp sym)
-defn))
+(fboundp sym)
+(set (intern name eldoc-message-commands) t)))))
-(defun eldoc-current-symbol ()
-(let ((c (char-after (point))))
+(defun eldoc-add-command-completions (&rest names)
-(and c
+(while names
-(memq (char-syntax c) '(?w ?_))
+(apply 'eldoc-add-command
-(intern-soft (current-word)))))
+(all-completions (car names) obarray 'fboundp))
+(setq names (cdr names))))
+(defun eldoc-remove-command (&rest cmds)
+(let (name)
+(while cmds
+(setq name (car cmds))
+(setq cmds (cdr cmds))
+(and (symbolp name)
+(setq name (symbol-name name)))
+(if (fboundp 'unintern)
+(unintern name eldoc-message-commands)
+(let ((s (intern-soft name eldoc-message-commands)))
+(and s
+(makunbound s)))))))
+(defun eldoc-remove-command-completions (&rest names)
+(while names
+(apply 'eldoc-remove-command
+(all-completions (car names) eldoc-message-commands))
+(setq names (cdr names))))
+;; Prime the command list.
+(eldoc-add-command-completions
+"backward-" "beginning-of-" "delete-other-windows" "delete-window"
+"end-of-" "forward-" "goto-" "mouse-set-point" "next-" "other-window"
+"previous-" "recenter" "scroll-" "self-insert-command" "split-window-")
 (provide 'eldoc)
 ;;; eldoc.el ends here

Mercurial > hg > xemacs-beta

comparison lisp/utils/eldoc.el @ 24:4103f0995bd7 r19-15b95