1 ;;; company-eclim.el --- A company-mode completion back-end for eclim.
3 ;; Copyright (C) 2009, 2011, 2013 Free Software Foundation, Inc.
5 ;; Author: Nikolaj Schumacher
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; Using `emacs-eclim' together with (or instead of) this back-end is
25 ;; recommended, as it allows you to use other Eclim features.
27 ;; The alternative back-end provided by `emacs-eclim' uses `yasnippet'
28 ;; instead of `company-template' to expand function calls, and it supports
29 ;; some languages other than Java.
34 (require 'company-template)
35 (eval-when-compile (require 'cl))
37 (defun company-eclim-executable-find ()
39 (dolist (eclipse-root '("/Applications/eclipse" "/usr/lib/eclipse"
40 "/usr/local/lib/eclipse"))
41 (and (file-exists-p (setq file (expand-file-name "plugins" eclipse-root)))
42 (setq file (car (last (directory-files file t "^org.eclim_"))))
43 (file-exists-p (setq file (expand-file-name "bin/eclim" file)))
46 (defcustom company-eclim-executable
47 (or (executable-find "eclim") (company-eclim-executable-find))
48 "Location of eclim executable."
52 (defcustom company-eclim-auto-save t
53 "Determines whether to save the buffer when retrieving completions.
54 eclim can only complete correctly when the buffer has been saved."
56 :type '(choice (const :tag "Off" nil)
59 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
61 (defvar company-eclim--project-dir 'unknown)
62 (make-variable-buffer-local 'company-eclim--project-dir)
64 (defvar company-eclim--project-name nil)
65 (make-variable-buffer-local 'company-eclim--project-name)
67 (defvar company-eclim--doc nil)
68 (make-variable-buffer-local 'company-eclim--doc)
70 (defun company-eclim--call-process (&rest args)
71 (let ((coding-system-for-read 'utf-8)
75 (if (= 0 (setq res (apply 'call-process company-eclim-executable nil t nil
77 (let ((json-array-type 'list))
78 (goto-char (point-min))
81 (message "Company-eclim command failed with error %d:\n%s" res
82 (buffer-substring (point-min) (point-max)))
85 (defun company-eclim--project-list ()
86 (company-eclim--call-process "project_list"))
88 (defun company-eclim--project-dir ()
89 (if (eq company-eclim--project-dir 'unknown)
90 (setq company-eclim--project-dir
93 (company-locate-dominating-file buffer-file-name ".project"))))
94 company-eclim--project-dir))
96 (defun company-eclim--project-name ()
97 (or company-eclim--project-name
98 (let ((dir (company-eclim--project-dir)))
100 (setq company-eclim--project-name
101 (loop for project in (company-eclim--project-list)
102 when (equal (cdr (assoc 'path project)) dir)
103 return (cdr (assoc 'name project))))))))
105 (defun company-eclim--candidates (prefix)
107 (let ((project-file (file-relative-name buffer-file-name
108 (company-eclim--project-dir)))
109 (project-name (company-eclim--project-name)))
110 (when company-eclim-auto-save
111 (when (buffer-modified-p)
113 ;; FIXME: Sometimes this isn't finished when we complete.
114 (company-eclim--call-process "java_src_update"
115 "-p" (company-eclim--project-name)
117 (setq company-eclim--doc
118 (make-hash-table :test 'equal))
119 (dolist (item (cdr (assoc 'completions
120 (company-eclim--call-process
121 "java_complete" "-p" (company-eclim--project-name)
123 "-o" (number-to-string
124 (company-eclim--search-point prefix))
127 (let* ((meta (cdr (assoc 'info item)))
129 (when (string-match " [:-]" completion)
130 (setq completion (substring completion 0 (match-beginning 0))))
131 (puthash completion meta company-eclim--doc))))
132 (let ((completion-ignore-case nil))
133 (all-completions prefix company-eclim--doc)))
135 (defun company-eclim--search-point (prefix)
136 (if (or (plusp (length prefix)) (eq (char-before) ?.))
140 (defun company-eclim--meta (candidate)
141 (gethash candidate company-eclim--doc))
143 (defun company-eclim--templatify (call)
145 (beg (- (point) (length call)))
146 (templ (company-template-declare-template beg end)))
149 (while (re-search-forward "\\([(,] ?\\)\\([^ ]+ \\)\\([^ ,)]*\\)" end t)
150 (let ((name (match-string 3)))
151 (replace-match "\\1" t)
152 (decf end (length (match-string 2)))
153 (company-template-add-field templ (point) name))))
154 (company-template-move-to-first templ)))
156 (defun company-eclim (command &optional arg &rest ignored)
157 "A `company-mode' completion back-end for Eclim.
158 Eclim provides access to Eclipse Java IDE features for other editors.
160 Eclim version 1.7.13 or newer (?) is required.
162 Completions only work correctly when the buffer has been saved.
163 `company-eclim-auto-save' determines whether to do this automatically."
164 (interactive (list 'interactive))
166 (interactive (company-begin-backend 'company-eclim))
167 (prefix (and (derived-mode-p 'java-mode 'jde-mode)
169 company-eclim-executable
170 (company-eclim--project-name)
171 (not (company-in-string-or-comment))
172 (or (company-grab-symbol) 'stop)))
173 (candidates (company-eclim--candidates arg))
174 (meta (company-eclim--meta arg))
175 ;; because "" doesn't return everything
176 (no-cache (equal arg ""))
177 (crop (when (string-match "(" arg)
178 (substring arg 0 (match-beginning 0))))
179 (post-completion (when (string-match "([^)]" arg)
180 (company-eclim--templatify arg)))))
182 (provide 'company-eclim)
183 ;;; company-eclim.el ends here