You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
172 lines
6.0 KiB
172 lines
6.0 KiB
;;; ess-eldoc.el --- Use eldoc to report R function names.
|
|
|
|
;; Copyright (C) 1997--2009 A.J. Rossini, Richard M. Heiberger, Martin
|
|
;; Maechler, Kurt Hornik, Rodney Sparapani, and Stephen Eglen.
|
|
|
|
;; Author: Stephen Eglen
|
|
;; Created: 2007-06-30
|
|
;; Maintainer: ESS-core <ESS-core@r-project.org>
|
|
|
|
;; This file is part of ESS
|
|
|
|
;; This file 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 file 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.
|
|
|
|
;; A copy of the GNU General Public License is available at
|
|
;; http://www.r-project.org/Licenses/
|
|
|
|
;;; Commentary:
|
|
|
|
;;;;; eldoc funcitonality has been moved into the core ;;;;;
|
|
;;;;; this file has no effect and is left in ESS in order not to break
|
|
;;;;; users configuration
|
|
|
|
;; This is an initial attempt to use the emacs facility ELDOC in R
|
|
;; buffers. Eldoc is used in Emacs lisp buffers to show the function
|
|
;; arglist and docstrings for variables. To try it, view an emacs
|
|
;; lisp buffer, and then do M-x turn-on-eldoc-mode, and move over
|
|
;; function and variable names.
|
|
|
|
;; This file extends eldoc to work in R buffers. It currently uses
|
|
;; Sven's ess-r-args.el file to retrieve args for a given R function
|
|
;; (via ess-r-args-get). Note that it works slightly different to
|
|
;; Sven's code, in that you just need to have the point over the name
|
|
;; of an R function, or inside its arguments list, for eldoc to show
|
|
;; the arg list.
|
|
|
|
;; To use this functionality, simply add
|
|
;;
|
|
;; (require 'ess-eldoc)
|
|
;;
|
|
;; to your .emacs file. When you visit a R mode, eldoc will be turned
|
|
;; on. However, you will first need to associate the R buffer with an
|
|
;; *R* process so that args can be looked up -- otherwise, eldoc will
|
|
;; silently not report anything. So, e.g. try:
|
|
;; C-x C-f somefile.R
|
|
;; M-x R (so that somefile.R is associated with *R*)
|
|
;; eldoc should then work.
|
|
|
|
;; e.g. put the following rnorm() command in an R buffer. The line
|
|
;; underneath shows a key of what arg list will be shown as you move
|
|
;; across the rnorm line.
|
|
|
|
;; rnorm(n=100, mean=sqrt(20), sd=10)
|
|
;; 1111111111111222223333333311444111
|
|
;; 1: rnorm
|
|
;; 2: mean
|
|
;; 3: sqrt
|
|
;; 4: sd
|
|
;;
|
|
|
|
;; Note that the arg list for rnorm() should be shown either when you
|
|
;; are on the function name, or in the arg list. However, since the
|
|
;; 2nd and 3rd arguments are also function names, the arg lists of
|
|
;; those function names are reported instead. This might be seen as
|
|
;; undesirable behaviour, in which case a solution would be to only
|
|
;; look up the function name if it is followed by (.
|
|
|
|
;; If you want to use this feature in *R* buffers, add the following
|
|
;; to .emacs:
|
|
;; (add-hook 'inferior-ess-mode-hook 'ess-use-eldoc)
|
|
|
|
|
|
;; In the current version, I do not cache the arg list, but that was
|
|
;; done in an earlier version, to save repeated calls to
|
|
;; ess-r-args-get.
|
|
|
|
;; This code has been tested only in Emacs 22.1. It will not work on
|
|
;; Emacs 21, because it needs the variable
|
|
;; eldoc-documentation-function.
|
|
|
|
;;;; VS [25-02-2012]: all these issues were at least partially addresed in the
|
|
;;;; new implementation:
|
|
|
|
;; Bug (in eldoc?): the arg list for legend() is too long to fit in
|
|
;; minibuffer, and it seems that we see the last N lines of the arg
|
|
;; list, rather than the first N lines. It would be better to see the
|
|
;; first N lines since the more important args come first.
|
|
|
|
;; Doc issue: the eldoc vars (e.g. eldoc-echo-area-use-multiline-p)
|
|
;; work only for elisp mode.
|
|
|
|
;; Issue: You will probably see the message "Using process 'R'" flash;
|
|
;; this is generated by `ess-request-a-process', and I'd like to avoid
|
|
;; that appearing, non-interactively.
|
|
|
|
;; If *R* is currently busy (e.g. processing Sys.sleep(999)), then the
|
|
;; eldoc commands won't work; ess-command could be silenced in this
|
|
;; regard perhaps with a new SILENT arg for example to prevent the
|
|
;; call to (ess-error).
|
|
|
|
|
|
;;; Code:
|
|
|
|
;; ;; This could be done on buffer local basis.
|
|
;; (setq ess-r-args-noargsmsg "")
|
|
|
|
;; ;; following two defvars are not currently used.
|
|
;; (defvar ess-eldoc-last-name nil
|
|
;; "Name of the last function looked up in eldoc.
|
|
;; We remember this to see whether we need to look up documentation, or used
|
|
;; the cached value in `ess-eldoc-last-args'.")
|
|
|
|
;; (defvar ess-eldoc-last-args nil
|
|
;; "Args list last looked up for eldoc. Used as cache.")
|
|
|
|
;; (defun ess-eldoc-2 ()
|
|
;; ;; simple, old version.
|
|
;; (interactive)
|
|
;; (ess-r-args-get (ess-read-object-name-default)))
|
|
|
|
;; (defun ess-eldoc-1 ()
|
|
;; "Return the doc string, or nil.
|
|
;; This is the first version; works only on function name, not within arg list."
|
|
;; (interactive)
|
|
|
|
;; ;; Possible ways to get the function at point.
|
|
;; ;;(setq name (thing-at-point 'sexp))
|
|
;; ;;(setq name (ess-read-object-name-default))
|
|
;; ;;(setq name (find-tag-default))
|
|
|
|
;; (if ess-current-process-name
|
|
;; (progn
|
|
;; (setq name (ess-guess-fun)) ;guess the word at point.
|
|
;; (if (equal (length name) 0)
|
|
;; nil
|
|
;; ;; else
|
|
;; (unless (equal name ess-eldoc-last-name)
|
|
;; ;; name is different to the last name we lookedup, so get
|
|
;; ;; new args from R and store them.
|
|
;; (setq ess-eldoc-last-args (ess-r-args-get name)
|
|
;; ess-eldoc-last-name name))
|
|
;; ess-eldoc-last-args))
|
|
;; ;; no ESS process current.
|
|
;; nil)
|
|
;; )
|
|
|
|
|
|
;; (defsubst ess-guess-fun ()
|
|
;; "Guess what the function at point is."
|
|
;; ;; Derived from Man-default-man-entry in man.el
|
|
;; (let (word)
|
|
;; (save-excursion
|
|
;; (skip-chars-backward "-a-zA-Z0-9._+:")
|
|
;; (let ((start (point)))
|
|
;; (skip-chars-forward "-a-zA-Z0-9._+:")
|
|
;; (setq word (buffer-substring-no-properties start (point)))))
|
|
;; word))
|
|
|
|
(defun ess-use-eldoc ()
|
|
"Does nothing. Defined not to break old users' code."
|
|
(interactive))
|
|
|
|
(provide 'ess-eldoc)
|
|
|
|
;;; ess-eldoc.el ends here
|