Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alt doc for higher-order functions #1749

Merged
merged 5 commits into from
May 18, 2016
Merged

Alt doc for higher-order functions #1749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9556859
Remove reference to `should` from tests
cskksc May 15, 2016
6ff455e
Rename cider--eldoc-remove-dot-sym
cskksc May 17, 2016
fa79263
[#1638] Consider the eldoc at point before first symbol
cskksc May 17, 2016
5df8bbd
[Fix #1572] Add support for variables in eldoc
cskksc May 18, 2016
3074f2b
Refactor some eldoc functions
cskksc May 18, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* [#1720](https://github.com/clojure-emacs/cider/issues/1720): Add a command `cider-eval-sexp-at-point` to evaluate the form around point (bound to `C-c C-v v`).
* [#1564](https://github.com/clojure-emacs/cider/issues/1564): CIDER's internal namespaces and vars are filtered from the ns-browser and apropos functions.
* [#1725](https://github.com/clojure-emacs/cider/issues/1725): Display class names in eldoc for interop forms.
* [#1572](https://github.com/clojure-emacs/cider/issues/1572): Add support for variables in eldoc.

### Changes

Expand Down
145 changes: 111 additions & 34 deletions cider-eldoc.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,15 @@ a \"& x more\" suffix. Otherwise, all the classes are displayed."
:group 'cider
:package-version '(cider . "0.13.0"))

(defcustom cider-eldoc-display-for-symbol-at-point t
"When non-nil, display eldoc for symbol at point if available.
So in (map inc ...) when the cursor is over inc its eldoc would be
displayed. When nil, always display eldoc for first symbol of the sexp."
:type 'boolean
:safe 'booleanp
:group 'cider
:package-version '(cider . "0.13.0"))

(defun cider--eldoc-format-class-names (class-names)
"Return a formatted CLASS-NAMES prefix string.
CLASS-NAMES is a list of classes to which a Java interop form belongs.
Expand Down Expand Up @@ -102,14 +111,18 @@ mapping `cider-eldoc-ns-function' on it returns an empty list."
;; don't add the parentheses
(t (format "%s" (car eldoc-class-names))))))

(defun cider-eldoc-format-thing (ns symbol thing)
(defun cider-eldoc-format-thing (ns symbol thing type)
"Format the eldoc subject defined by NS, SYMBOL and THING.
THING represents the thing at point which triggered eldoc. Normally NS and
SYMBOL are used (they are derived from THING), but when empty we fallback to
THING (e.g. for Java methods)."
THING (e.g. for Java methods). Format it as a function, if FUNCTION-P
is non-nil. Else format it as a variable."
(if-let ((method-name (if (and symbol (not (string= symbol "")))
symbol
thing))
(propertized-method-name (if (equal type 'function)
(cider-propertize method-name 'var)
(cider-propertize method-name 'font-lock-variable-name-face)))
(ns-or-class (if (and ns (stringp ns))
(funcall cider-eldoc-ns-function ns)
(cider--eldoc-format-class-names ns))))
Expand All @@ -121,9 +134,31 @@ THING (e.g. for Java methods)."
;; it is already propertized
ns-or-class
(cider-propertize ns-or-class 'ns))
(cider-propertize method-name 'var))
propertized-method-name)
;; in case ns-or-class is nil
(cider-propertize method-name 'var)))
propertized-method-name))

(defun cider-eldoc-format-variable (thing pos eldoc-info)
"Return the formatted eldoc string for a variable.
THING is the variable name. POS will always be 0 here.
ELDOC-INFO is a p-list containing the eldoc information."
(let ((ns (lax-plist-get eldoc-info "ns"))
(symbol (lax-plist-get eldoc-info "symbol"))
(docstring (lax-plist-get eldoc-info "docstring")))
(when docstring
(format "%s: %s" (cider-eldoc-format-thing ns symbol thing 'var)
docstring))))

(defun cider-eldoc-format-function (thing pos eldoc-info)
"Return the formatted eldoc string for a function.
THING is the function name. POS is the argument-index of the functions
arglists. ELDOC-INFO is a p-list containing the eldoc information."
(let ((ns (lax-plist-get eldoc-info "ns"))
(symbol (lax-plist-get eldoc-info "symbol"))
(arglists (lax-plist-get eldoc-info "arglists")))
(format "%s: %s"
(cider-eldoc-format-thing ns symbol thing 'function)
(cider-eldoc-format-arglist arglists pos))))

(defun cider-highlight-args (arglist pos)
"Format the the function ARGLIST for eldoc.
Expand Down Expand Up @@ -199,18 +234,53 @@ if the maximum number of sexps to skip is exceeded."
(error))
num-skipped-sexps))

(defun cider-eldoc-info-in-current-sexp ()
"Return a list of the current sexp and the current argument index."
(defun cider-eldoc-thing-type (eldoc-info)
"Return the type of the thing being displayed by eldoc.
It can be a function or var now."
(pcase (lax-plist-get eldoc-info "type")
("function" 'function)
("variable" 'var)))

(defun cider-eldoc-info-at-point ()
"Return eldoc info at point.
First go to the beginning of the sexp and check if the eldoc is to be
considered (i.e sexp is a method call) and not a map or vector literal.
Then go back to the point and return its eldoc."
(save-excursion
(when-let ((beginning-of-sexp (cider-eldoc-beginning-of-sexp))
(argument-index (1- 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, vector,
;; hash or set literal.
(unless (member (or (char-after (1- (point))) 0) '(?\" ?\{ ?\[))
(list (cider-symbol-at-point) argument-index)))))
(unless (cider-in-comment-p)
(let* ((current-point (point)))
(cider-eldoc-beginning-of-sexp)
(unless (member (or (char-before (point)) 0) '(?\" ?\{ ?\[))
(goto-char current-point)
(when-let (eldoc-info (cider-eldoc-info
(cider--eldoc-remove-dot (cider-symbol-at-point))))
(list "eldoc-info" eldoc-info
"thing" (cider-symbol-at-point)
"pos" 0)))))))

(defun cider-eldoc-info-at-sexp-beginning ()
"Return eldoc info for first symbol in the sexp."
(save-excursion
(let* ((beginning-of-sexp (cider-eldoc-beginning-of-sexp))
;; If we are at the beginning of function name, this will be -1
(argument-index (max 0 (1- beginning-of-sexp))))
(unless (or (member (or (char-before (point)) 0) '(?\" ?\{ ?\[))
(cider-in-comment-p))
(when-let (eldoc-info (cider-eldoc-info
(cider--eldoc-remove-dot (cider-symbol-at-point))))
(list "eldoc-info" eldoc-info
"thing" (cider-symbol-at-point)
"pos" argument-index))))))

(defun cider-eldoc-info-in-current-sexp ()
"Return eldoc information from the sexp.
If `cider-eldoc-display-for-symbol-at-poin' is non-nil and
the symbol at point has a valid eldoc available, return that.
Otherwise return the eldoc of the first symbol of the sexp."
(let ((sym-at-point-eldoc-info (cider-eldoc-info-at-point)))
(if (and cider-eldoc-display-for-symbol-at-point sym-at-point-eldoc-info)
sym-at-point-eldoc-info
(cider-eldoc-info-at-sexp-beginning))))

(defun cider-eldoc--convert-ns-keywords (thing)
"Convert THING values that match ns macro keywords to function names."
Expand Down Expand Up @@ -240,14 +310,20 @@ This includes the arglist and ns and symbol name (if available)."
;; check if we can used the cached eldoc info
(cond
;; handle keywords for map access
((string-prefix-p ":" thing) (list nil thing '(("map") ("map" "not-found"))))
((string-prefix-p ":" thing) (list "symbol" thing
"type" "function"
"arglists" '(("map") ("map" "not-found"))))
;; handle Classname. by displaying the eldoc for new
((string-match-p "^[A-Z].+\\.$" thing) (list nil thing '(("args*"))))
((string-match-p "^[A-Z].+\\.$" thing) (list "symbol" thing
"type" "function"
"arglists" '(("args*"))))
;; generic case
(t (if (equal thing (car cider-eldoc-last-symbol))
(cdr cider-eldoc-last-symbol)
(cadr cider-eldoc-last-symbol)
(when-let ((eldoc-info (cider-sync-request:eldoc thing)))
(let* ((arglist (nrepl-dict-get eldoc-info "eldoc"))
(let* ((arglists (nrepl-dict-get eldoc-info "eldoc"))
(docstring (nrepl-dict-get eldoc-info "docstring"))
(type (nrepl-dict-get eldoc-info "type"))
(ns (nrepl-dict-get eldoc-info "ns"))
(class (nrepl-dict-get eldoc-info "class"))
(name (nrepl-dict-get eldoc-info "name"))
Expand All @@ -257,15 +333,19 @@ This includes the arglist and ns and symbol name (if available)."
class))
(name-or-member (if (and name (not (string= name "")))
name
(format ".%s" member))))
(format ".%s" member)))
(eldoc-plist (list "ns" ns-or-class
"symbol" name-or-member
"arglists" arglists
"docstring" docstring
"type" type)))
;; middleware eldoc lookups are expensive, so we
;; cache the last lookup. This eliminates the need
;; for extra middleware requests within the same sexp.
(setq cider-eldoc-last-symbol
(list thing ns-or-class name-or-member arglist))
(list ns-or-class name-or-member arglist)))))))))
(setq cider-eldoc-last-symbol (list thing eldoc-plist))
eldoc-plist))))))))

(defun cider--eldoc-remove-dot-sym (sym)
(defun cider--eldoc-remove-dot (sym)
"Remove the preceding \".\" from a namespace qualified SYM and return sym.
Only useful for interop forms. Clojure forms would be returned unchanged."
(when sym (replace-regexp-in-string "/\\." "/" sym)))
Expand All @@ -275,17 +355,14 @@ Only useful for interop forms. Clojure forms would be returned unchanged."
(when (and (cider-connected-p)
;; don't clobber an error message in the minibuffer
(not (member last-command '(next-error previous-error))))
(let* ((sexp-info (cider-eldoc-info-in-current-sexp))
(thing (car sexp-info))
(pos (cadr sexp-info))
(eldoc-info (cider-eldoc-info (cider--eldoc-remove-dot-sym thing)))
(ns (nth 0 eldoc-info))
(symbol (nth 1 eldoc-info))
(arglists (nth 2 eldoc-info)))
(let* ((sexp-eldoc-info (cider-eldoc-info-in-current-sexp))
(eldoc-info (lax-plist-get sexp-eldoc-info "eldoc-info"))
(pos (lax-plist-get sexp-eldoc-info "pos"))
(thing (lax-plist-get sexp-eldoc-info "thing")))
(when eldoc-info
(format "%s: %s"
(cider-eldoc-format-thing ns symbol thing)
(cider-eldoc-format-arglist arglists pos))))))
(if (equal (cider-eldoc-thing-type eldoc-info) 'function)
(cider-eldoc-format-function thing pos eldoc-info)
(cider-eldoc-format-variable thing pos eldoc-info))))))

(defun cider-eldoc-setup ()
"Setup eldoc in the current buffer.
Expand Down
3 changes: 2 additions & 1 deletion cider-interaction.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,8 @@ in the buffer."
(arglists (nth 2 eldoc-info)))
(when eldoc-info
(format "%s: %s"
(cider-eldoc-format-thing ns symbol thing)
(cider-eldoc-format-thing ns symbol thing
(cider-eldoc-thing-type eldoc-info))
(cider-eldoc-format-arglist arglists 0)))))

(defun cider-stdin-handler (&optional buffer)
Expand Down
8 changes: 8 additions & 0 deletions doc/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ experience.

![Eldoc](images/eldoc.png)

CIDER also would show the eldoc for the symbol at point. So in (map inc ...)
when the cursor is over inc its eldoc would be displayed. You can turn off this
behaviour by:

```el
(setq cider-eldoc-display-for-symbol-at-point nil)
```

* Suppress auto-enabling of `cider-mode` in `clojure-mode` buffers, when starting
CIDER:

Expand Down
Loading