;; Copyright (C) 2009 Nikolaj Schumacher
;;
;; Author: Nikolaj Schumacher <bugs * nschum de>
-;; Version: 0.4.1
+;; Version: 0.4.3
;; Keywords: abbrev, convenience, matchis
;; URL: http://nschum.de/src/emacs/company/
;; Compatibility: GNU Emacs 22.x, GNU Emacs 23.x
;; ('meta (format "This value is named %s" arg))))
;;
;; Sometimes it is a good idea to mix two back-ends together, for example to
-;; enrich gtags with dabbrev text (to emulate local variables):
-;;
-;; (defun gtags-gtags-dabbrev-backend (command &optional arg &rest ignored)
-;; (case command
-;; (prefix (company-gtags 'prefix))
-;; (candidates (append (company-gtags 'candidates arg)
-;; (company-dabbrev 'candidates arg)))))
+;; enrich gtags with dabbrev-code results (to emulate local variables):
+;; To do this, add a list with the merged back-ends as an element in
+;; company-backends.
;;
;; Known Issues:
;; When point is at the very end of the buffer, the pseudo-tooltip appears very
;;
;;; Change Log:
;;
+;; 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"
(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")))
(defcustom company-backends '(company-elisp company-nxml company-css
company-eclim company-semantic 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.
company-safe-backends)
(symbol :tag "User defined"))))))
-(put 'company-backends 'safe-local-variable 'company-safe-backend-p)
+(put 'company-backends 'safe-local-variable 'company-safe-backends-p)
(defcustom company-completion-started-hook nil
"*Hook run when company starts completing.
(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)
(company-cancel company-prefix)
nil)))))
+(defun company--good-prefix-p (prefix)
+ (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)
;; Don't complete existing candidates, fetch new ones.
(setq company-candidates-cache nil))
(let* ((new-prefix (company-call-backend 'prefix))
- (c (when (and (stringp new-prefix)
- (or (company-explicit-action-p)
- (>= (length new-prefix)
- company-minimum-prefix-length))
+ (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)
(funcall backend 'prefix))
(company--multi-backend-adapter backend 'prefix)))
(when prefix
- (when (and (stringp prefix)
- (>= (length prefix) company-minimum-prefix-length))
- (setq company-backend backend
+ (when (company--good-prefix-p prefix)
+ (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)))
+ (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))
(erase-buffer)
(current-buffer)))
-(defmacro company-electric (&rest body)
+(defmacro company--electric-do (&rest body)
(declare (indent 0) (debug t))
`(when (company-manual-begin)
(save-window-excursion
(defun company-show-doc-buffer ()
"Temporarily show a buffer with the complete documentation for the selection."
(interactive)
- (company-electric
+ (company--electric-do
(let ((selected (nth company-selection company-candidates)))
(display-buffer (or (company-call-backend 'doc-buffer selected)
(error "No documentation available")) t))))
(defun company-show-location ()
"Temporarily display a buffer showing the selected candidate in context."
(interactive)
- (company-electric
+ (company--electric-do
(let* ((selected (nth company-selection company-candidates))
(location (company-call-backend 'location selected))
(pos (or (cdr location) (error "No location available")))
(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."
;; show
+(defsubst company--window-inner-height ()
+ (let ((edges (window-inside-edges (selected-window))))
+ (- (nth 3 edges) (nth 1 edges))))
+
(defsubst company--pseudo-tooltip-height ()
"Calculate the appropriate tooltip height.
Returns a negative number if the tooltip should be displayed above point."
- (let* ((lines (1- (count-lines (window-start) (point-at-bol))))
- (below (- (window-height) 3 lines)))
+ (let* ((lines (count-lines (window-start) (point-at-bol)))
+ (below (- (company--window-inner-height) 1 lines)))
(if (and (< below (min company-tooltip-minimum company-candidates-length))
(> lines below))
(- (max 3 (min company-tooltip-limit lines)))