blob: 691aedc5798d241601f264d59ed890a16d5c9ef6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
;;; cider-eldoc.el --- eldoc support for Clojure -*- lexical-binding: t -*-
;; Copyright © 2012-2014 Tim King, Phil Hagelberg
;; Copyright © 2013-2014 Bozhidar Batsov, Hugo Duncan, Steve Purcell
;;
;; Author: Tim King <kingtim@gmail.com>
;; Phil Hagelberg <technomancy@gmail.com>
;; Bozhidar Batsov <bozhidar@batsov.com>
;; Hugo Duncan <hugo@hugoduncan.org>
;; Steve Purcell <steve@sanityinc.com>
;; This program 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 3 of the License, or
;; (at your option) any later version.
;; This program 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, see <http://www.gnu.org/licenses/>.
;; This file is not part of GNU Emacs.
;;; Commentary:
;; eldoc support for Clojure.
;;; Code:
(require 'cider-client)
(require 'cider-interaction) ; for cider-symbol-at-point
(require 'eldoc)
(require 'dash)
(defvar cider-extra-eldoc-commands '("yas-expand")
"Extra commands to be added to eldoc's safe commands list.")
(defun cider-eldoc-format-thing (thing)
"Format the eldoc THING."
(propertize thing 'face 'font-lock-function-name-face))
(defun cider-highlight-args (arglist pos)
"Format the the function ARGLIST for eldoc.
POS is the index of the currently highlighted argument."
(let* ((rest-pos (cider--find-rest-args-position arglist))
(i 0))
(mapconcat
(lambda (arg)
(let ((argstr (format "%s" arg)))
(if (eq arg '&)
argstr
(prog1
(if (or (= (1+ i) pos)
(and rest-pos (> (+ 1 i) rest-pos)
(> pos rest-pos)))
(propertize argstr 'face
'eldoc-highlight-function-argument)
argstr)
(setq i (1+ i)))))) arglist " ")))
(defun cider--find-rest-args-position (arglist)
"Find the position of & in the ARGLIST vector."
(-elem-index '& (append arglist ())))
(defun cider-highlight-arglist (arglist pos)
"Format the ARGLIST for eldoc.
POS is the index of the argument to highlight."
(concat "[" (cider-highlight-args arglist pos) "]"))
(defun cider-eldoc-format-arglist (arglist pos)
"Format all the ARGLIST for eldoc.
POS is the index of current argument."
(concat "("
(mapconcat (lambda (args) (cider-highlight-arglist args pos))
arglist
" ")
")"))
(defun cider-eldoc-info-in-current-sexp ()
"Return a list of the current sexp and the current argument index."
(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 (cider-symbol-at-point) argument-index)))))
(defun cider-eldoc--arglist-op-fn (thing)
"Return the arglist for THING using nREPL info op."
(let* ((var-info (cider-var-info thing t))
(candidates (cdadr (assoc "candidates" var-info))))
(if candidates
(->> candidates
(-map (lambda (x) (cdr (assoc "arglists-str" x))))
(-map 'read)
-flatten
-distinct)
(let ((arglists (cider-get-var-attr var-info "arglists-str")))
(when arglists
(read arglists))))))
(defun cider-eldoc-arglist (thing)
"Return the arglist for THING."
(when (nrepl-op-supported-p "info")
(cider-eldoc--arglist-op-fn thing)))
(defun cider-eldoc ()
"Backend function for eldoc to show argument list in the echo area."
(when (cider-connected-p)
(let* ((info (cider-eldoc-info-in-current-sexp))
(thing (car info))
(pos (cadr info))
(value (cider-eldoc-arglist thing)))
(when value
(format "%s: %s"
(cider-eldoc-format-thing thing)
(cider-eldoc-format-arglist value pos))))))
(defun cider-turn-on-eldoc-mode ()
"Turn on eldoc mode in the current buffer."
(setq-local eldoc-documentation-function 'cider-eldoc)
(apply 'eldoc-add-command cider-extra-eldoc-commands)
(eldoc-mode +1))
(provide 'cider-eldoc)
;;; cider-eldoc.el ends here
|
