;;; company.el --- extensible inline text completion mechanism
;;
-;; Copyright (C) 2009 Nikolaj Schumacher
+;; Copyright (C) 2009-2010 Nikolaj Schumacher
;;
;; Author: Nikolaj Schumacher <bugs * nschum de>
-;; Version: 0.4.1
-;; Keywords: abbrev, convenience, matchis
+;; Version: 0.5
+;; Keywords: abbrev, convenience, matching
;; URL: http://nschum.de/src/emacs/company/
;; Compatibility: GNU Emacs 22.x, GNU Emacs 23.x
;;
;;
;;; Change Log:
;;
+;; 2010-02-24 (0.5)
+;; `company-ropemacs' now provides location and docs. (Fernando H. Silva)
+;; Added `company-with-candidate-inserted' macro.
+;; Added `company-clang' back-end.
+;; Added new mechanism for non-consecutive insertion.
+;; (So far only used by clang for ObjC.)
+;; The semantic back-end now shows meta information for local symbols.
+;; Added compatibility for CEDET in Emacs 23.2 and from CVS. (Oleg Andreev)
+;;
+;; 2009-05-07 (0.4.3)
+;; Added `company-other-backend'.
+;; Idle completion no longer interrupts multi-key command input.
+;; Added `company-ropemacs' and `company-pysmell' back-ends.
+;;
+;; 2009-04-25 (0.4.2)
+;; In C modes . and -> now count towards `company-minimum-prefix-length'.
;; Reverted default front-end back to `company-preview-if-just-one-frontend'.
;; The pseudo tooltip will no longer be clipped at the right window edge.
;; Added `company-tooltip-minimum'.
(add-to-list 'debug-ignored-errors "^Company not ")
(add-to-list 'debug-ignored-errors "^No candidate number ")
(add-to-list 'debug-ignored-errors "^Cannot complete at point$")
+(add-to-list 'debug-ignored-errors "^No other back-end$")
(defgroup company nil
"Extensible inline text completion mechanism"
:group 'abbrev
:group 'convenience
- :group 'maching)
+ :group 'matching)
(defface company-tooltip
'((t :background "yellow"
(defvar company-safe-backends
'((company-abbrev . "Abbrev")
+ (company-clang . "clang")
(company-css . "CSS")
(company-dabbrev . "dabbrev for plain text")
(company-dabbrev-code . "dabbrev for code")
(company-keywords . "Programming language keywords")
(company-nxml . "nxml")
(company-oddmuse . "Oddmuse")
+ (company-pysmell . "PySmell")
+ (company-ropemacs . "ropemacs")
(company-semantic . "CEDET Semantic")
(company-tempo . "Tempo templates")
(company-xcode . "Xcode")))
(return t))))))
(defcustom company-backends '(company-elisp company-nxml company-css
- company-eclim company-semantic company-xcode
+ company-eclim company-semantic company-clang
+ company-xcode company-ropemacs
(company-gtags company-etags company-dabbrev-code
- company-keywords)
+ company-pysmell company-keywords)
company-oddmuse company-files company-dabbrev)
"*The list of active back-ends (completion engines).
Each list elements can itself be a list of back-ends. In that case their
completions are merged. Otherwise only the first matching back-end returns
results.
+`company-begin-backend' can be used to start a specific back-end,
+`company-other-backend' will skip to the next matching back-end in the list.
+
Each back-end is a function that takes a variable number of arguments.
The first argument is the command requested from the back-end. It is one
of the following:
'prefix: The back-end should return the text to be completed. It must be
text immediately before `point'. Returning nil passes control to the next
back-end. The function should return 'stop if it should complete but cannot
-\(e.g. if it is in the middle of a string\).
+\(e.g. if it is in the middle of a string\). If the returned value is only
+part of the prefix (e.g. the part after \"->\" in C), the back-end may return a
+cons of prefix and prefix length, which is then used in the
+`company-minimum-prefix-length' test.
'candidates: The second argument is the prefix to be completed. The
return value should be a list of candidates that start with the prefix.
(if (or (symbolp backend)
(functionp backend))
- (if (ignore-errors (funcall backend 'init) t)
- (put backend 'company-init t)
- (put backend 'company-init 'failed)
- (unless (memq backend company--disabled-backends)
- (message "Company back-end '%s' could not be initialized"
- backend)
- (push backend company--disabled-backends))
- nil)
+ (condition-case err
+ (progn
+ (funcall backend 'init)
+ (put backend 'company-init t))
+ (error
+ (put backend 'company-init 'failed)
+ (unless (memq backend company--disabled-backends)
+ (message "Company back-end '%s' could not be initialized:\n%s"
+ backend (error-message-string err)))
+ (push backend company--disabled-backends)
+ nil))
(mapc 'company-init-backend backend)))
(defvar company-default-lighter " company")
(defsubst company-strip-prefix (str)
(substring str (length company-prefix)))
+(defmacro company-with-candidate-inserted (candidate &rest body)
+ "Evaluate BODY with CANDIDATE temporarily inserted.
+This is a tool for back-ends that need candidates inserted before they
+can retrieve meta-data for them."
+ (declare (indent 1))
+ `(let ((inhibit-modification-hooks t)
+ (inhibit-point-motion-hooks t)
+ (modified-p (buffer-modified-p)))
+ (insert (company-strip-prefix ,candidate))
+ (unwind-protect
+ (progn ,@body)
+ (delete-region company-point (point)))))
+
(defun company-explicit-action-p ()
"Return whether explicit completion action was taken by the user."
(or company--explicit-action
(defun company--should-complete ()
(and (not (or buffer-read-only overriding-terminal-local-map
overriding-local-map))
+ ;; Check if in the middle of entering a key combination.
+ (or (equal (this-command-keys-vector) [])
+ (not (keymapp (key-binding (this-command-keys-vector)))))
(eq company-idle-delay t)
(or (eq t company-begin-commands)
(memq this-command company-begin-commands)
(setq company--explicit-action t)
(company-auto-begin))
+(defun company-other-backend (&optional backward)
+ (interactive (list current-prefix-arg))
+ (company-assert-enabled)
+ (if company-backend
+ (let* ((after (cdr (member company-backend company-backends)))
+ (before (cdr (member company-backend (reverse company-backends))))
+ (next (if backward
+ (append before (reverse after))
+ (append after (reverse before)))))
+ (company-cancel)
+ (dolist (backend next)
+ (when (ignore-errors (company-begin-backend backend))
+ (return t))))
+ (company-manual-begin))
+ (unless company-candidates
+ (error "No other back-end")))
+
(defun company-require-match-p ()
(let ((backend-value (company-call-backend 'require-match)))
(or (eq backend-value t)
nil)))))
(defun company--good-prefix-p (prefix)
- (and (stringp prefix)
- (or (company-explicit-action-p)
- (>= (length prefix) company-minimum-prefix-length))))
+ (and (or (company-explicit-action-p)
+ (>= (or (cdr-safe prefix) (length prefix))
+ company-minimum-prefix-length))
+ (stringp (or (car-safe prefix) prefix))))
(defun company--continue ()
(when (company-call-backend 'no-cache company-prefix)
(setq company-candidates-cache nil))
(let* ((new-prefix (company-call-backend 'prefix))
(c (when (and (company--good-prefix-p new-prefix)
+ (setq new-prefix (or (car-safe new-prefix) new-prefix))
(= (- (point) (length new-prefix))
(- company-point (length company-prefix))))
+ (setq new-prefix (or (car-safe new-prefix) new-prefix))
(company-calculate-candidates new-prefix))))
(or (cond
((eq c t)
(company--multi-backend-adapter backend 'prefix)))
(when prefix
(when (company--good-prefix-p prefix)
- (setq company-backend backend
+ (setq prefix (or (car-safe prefix) prefix)
+ company-backend backend
c (company-calculate-candidates prefix))
;; t means complete/unique. We don't start, so no hooks.
- (when (consp c)
- (setq company-prefix prefix
- company-lighter (concat " " (symbol-name backend)))
+ (if (not (consp c))
+ (when company--explicit-action
+ (message "No completion found"))
+ (setq company-prefix prefix)
+ (when (symbolp backend)
+ (setq company-lighter (concat " " (symbol-name backend))))
(company-update-candidates c)
(run-hook-with-args 'company-completion-started-hook
(company-explicit-action-p))
(set-buffer-modified-p nil))
(when company-prefix
(if (stringp result)
- (run-hook-with-args 'company-completion-finished-hook result)
+ (progn
+ (company-call-backend 'pre-completion result)
+ (run-hook-with-args 'company-completion-finished-hook result)
+ (company-call-backend 'post-completion result))
(run-hook-with-args 'company-completion-cancelled-hook result)))
(setq company-added-newline nil
company-backend nil
(erase-buffer)
(current-buffer)))
+(defvar company--electric-commands
+ '(scroll-other-window scroll-other-window-down)
+ "List of Commands that won't break out of electric commands.")
+
(defmacro company--electric-do (&rest body)
(declare (indent 0) (debug t))
`(when (company-manual-begin)
(save-window-excursion
(let ((height (window-height))
- (row (company--row)))
+ (row (company--row))
+ cmd)
,@body
(and (< (window-height) height)
(< (- (window-height) row 2) company-tooltip-limit)
(recenter (- (window-height) row 2)))
- (while (eq 'scroll-other-window
- (key-binding (vector (list (read-event)))))
- (call-interactively 'scroll-other-window))
+ (while (memq (setq cmd (key-binding (vector (list (read-event)))))
+ company--electric-commands)
+ (call-interactively cmd))
(when last-input-event
(clear-this-command-keys t)
(setq unread-command-events (list last-input-event)))))))
"Temporarily show a buffer with the complete documentation for the selection."
(interactive)
(company--electric-do
- (let ((selected (nth company-selection company-candidates)))
- (display-buffer (or (company-call-backend 'doc-buffer selected)
- (error "No documentation available")) t))))
+ (let* ((selected (nth company-selection company-candidates))
+ (doc-buffer (or (company-call-backend 'doc-buffer selected)
+ (error "No documentation available"))))
+ (with-current-buffer doc-buffer
+ (goto-char (point-min)))
+ (display-buffer doc-buffer t))))
(put 'company-show-doc-buffer 'company-keep t)
(defun company-show-location ()
(buffer (or (and (bufferp (car location)) (car location))
(find-file-noselect (car location) t))))
(with-selected-window (display-buffer buffer t)
- (if (bufferp (car location))
- (goto-char pos)
- (goto-line pos))
+ (save-restriction
+ (widen)
+ (if (bufferp (car location))
+ (goto-char pos)
+ (goto-char (point-min))
+ (forward-line (1- pos))))
(set-window-start nil (point))))))
(put 'company-show-location 'company-keep t)
(remove-hook 'company-completion-finished-hook company-callback t)
(remove-hook 'company-completion-cancelled-hook 'company-remove-callback t)
(remove-hook 'company-completion-finished-hook 'company-remove-callback t)
- (set-marker company-begin-with-marker nil))
+ (when company-begin-with-marker
+ (set-marker company-begin-with-marker nil)))
(defun company-begin-backend (backend &optional callback)
"Start a completion at point using BACKEND."
(defvar company-echo-timer nil)
-(defvar company-echo-delay .1)
+(defvar company-echo-delay .01)
(defun company-echo-show (&optional getter)
(when getter
('post-command (company-echo-show-soon 'company-fetch-metadata))
('hide (company-echo-hide))))
+;; templates ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(autoload 'company-template-declare-template "company-template")
+
(provide 'company)
;;; company.el ends here