;; Copyright (C) 2009 Nikolaj Schumacher
;;
;; Author: Nikolaj Schumacher <bugs * nschum de>
-;; Version: 0.2.1
+;; Version: 0.3
;; Keywords: abbrev, convenience, matchis
;; URL: http://nschum.de/src/emacs/company/
;; Compatibility: GNU Emacs 22.x, GNU Emacs 23.x
;; Enable company-mode with M-x company-mode. For further information look at
;; the documentation for `company-mode' (C-h f company-mode RET)
;;
+;; If you want to start a specific back-end, call it interactively or use
+;; `company-begin-backend'. For example:
+;; M-x company-abbrev will prompt for and insert an abbrev.
+;;
;; To write your own back-end, look at the documentation for `company-backends'.
;; Here is a simple example completing "foo":
;;
;;
;;; Change Log:
;;
+;; 2009-04-12 (0.3)
+;; Added `company-begin-commands' option.
+;; Added abbrev, tempo and Xcode back-ends.
+;; Back-ends are now interactive. You can start them with M-x backend-name.
+;; Added `company-begin-with' for starting company from elisp-code.
;; Added hooks.
-;; Added `company-require-match' option.
+;; Added `company-require-match' and `company-auto-complete' options.
;;
;; 2009-04-05 (0.2.1)
;; Improved Emacs Lisp back-end behavior for local variables.
(add-to-list 'debug-ignored-errors "^No \\(document\\|loc\\)ation available$")
(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$")
(defgroup company nil
"Extensible inline text completion mechanism"
(function :tag "custom function" nil))))
(defcustom company-backends '(company-elisp company-nxml company-css
- company-semantic company-gtags company-etags
- company-oddmuse company-files company-dabbrev)
+ company-semantic company-xcode company-gtags
+ company-etags company-oddmuse company-files
+ company-dabbrev)
"*The list of active back-ends (completion engines).
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
that option the other way around.
The back-end should return nil for all commands it does not support or
-does not know about."
+does not know about. It should also be callable interactively and use
+`company-begin-backend' to start itself in that case."
:group 'company
:type '(repeat (function :tag "function" nil)))
This can be a function do determine if a match is required.
This can be overridden by the back-end, if it returns t or 'never to
-'require-match."
+'require-match. `company-auto-complete' also takes precedence over this."
+ :group 'company
+ :type '(choice (const :tag "Off" nil)
+ (function :tag "Predicate function")
+ (const :tag "On, if user interaction took place"
+ 'company-explicit-action-p)
+ (const :tag "On" t)))
+
+(defcustom company-auto-complete 'company-explicit-action-p
+ "Determines when to auto-complete.
+If this is enabled, all characters from `company-auto-complete-chars' complete
+the selected completion. This can also be a function."
:group 'company
:type '(choice (const :tag "Off" nil)
(function :tag "Predicate function")
'company-explicit-action-p)
(const :tag "On" t)))
+(defcustom company-auto-complete-chars '(?\ ?\( ?\) ?. ?\" ?$ ?\' ?< ?| ?!)
+ "Determines which characters trigger an automatic completion.
+See `company-auto-complete'. If this is a string, each string character causes
+completion. If it is a list of syntax description characters (see
+`modify-char-syntax'), all characters with that syntax auto-complete.
+
+This can also be a function, which is called with the new input and should
+return non-nil if company should auto-complete.
+
+A character that is part of a valid candidate never starts auto-completion."
+ :group 'company
+ :type '(choice (string :tag "Characters")
+ (set :tag "Syntax"
+ (const :tag "Whitespace" ?\ )
+ (const :tag "Symbol" ?_)
+ (const :tag "Opening parentheses" ?\()
+ (const :tag "Closing parentheses" ?\))
+ (const :tag "Word constituent" ?w)
+ (const :tag "Punctuation." ?.)
+ (const :tag "String quote." ?\")
+ (const :tag "Paired delimiter." ?$)
+ (const :tag "Expression quote or prefix operator." ?\')
+ (const :tag "Comment starter." ?<)
+ (const :tag "Comment ender." ?>)
+ (const :tag "Character-quote." ?/)
+ (const :tag "Generic string fence." ?|)
+ (const :tag "Generic comment fence." ?!))
+ (function :tag "Predicate function")))
+
(defcustom company-idle-delay .7
"*The idle delay in seconds until automatic completions starts.
A value of nil means never complete automatically, t means complete
(const :tag "immediate (t)" t)
(number :tag "seconds")))
+(defcustom company-begin-commands t
+ "*A list of commands following which company will start completing.
+If this is t, it will complete after any command. See `company-idle-delay'.
+
+Alternatively any command with a non-nil 'company-begin property is treated as
+if it was on this list."
+ :group 'company
+ :type '(choice (const :tag "Any command" t)
+ (const :tag "Self insert command" '(self-insert-command))
+ (repeat :tag "Commands" function)))
+
(defcustom company-show-numbers nil
"*If enabled, show quick-access numbers for the first ten candidates."
:group 'company
(defvar company-active-map
(let ((keymap (make-sparse-keymap)))
+ (define-key keymap "\e\e\e" 'company-abort)
+ (define-key keymap "\C-g" 'company-abort)
(define-key keymap (kbd "M-n") 'company-select-next)
(define-key keymap (kbd "M-p") 'company-select-previous)
(define-key keymap (kbd "<down>") 'company-select-next)
inactive, as well.
The completion data is retrieved using `company-backends' and displayed using
-`company-frontends'.
+`company-frontends'. If you want to start a specific back-end, call it
+interactively or use `company-begin-backend'.
regular keymap (`company-mode-map'):
(add-hook 'pre-command-hook 'company-pre-command nil t)
(add-hook 'post-command-hook 'company-post-command nil t)
(dolist (backend company-backends)
- (unless (fboundp backend)
- (ignore-errors (require backend nil t)))
- (unless (fboundp backend)
- (message "Company back-end '%s' could not be initialized"
- backend))))
+ (when (symbolp backend)
+ (unless (fboundp backend)
+ (ignore-errors (require backend nil t)))
+ (unless (fboundp backend)
+ (message "Company back-end '%s' could not be initialized"
+ backend)))))
(remove-hook 'pre-command-hook 'company-pre-command t)
(remove-hook 'post-command-hook 'company-post-command t)
(company-cancel)
(defsubst company-should-complete (prefix)
(and (eq company-idle-delay t)
+ (or (eq t company-begin-commands)
+ (memq this-command company-begin-commands)
+ (and (symbolp this-command) (get this-command 'company-begin)))
+ (not (and transient-mark-mode mark-active))
(>= (length prefix) company-minimum-prefix-length)))
(defsubst company-call-frontends (command)
(setq company-candidates nil)))
(defun company-calculate-candidates (prefix)
- (or (cdr (assoc prefix company-candidates-cache))
- (when company-candidates-cache
- (let ((len (length prefix))
- (completion-ignore-case (funcall company-backend 'ignore-case))
- prev)
- (dotimes (i len)
- (when (setq prev (cdr (assoc (substring prefix 0 (- len i))
- company-candidates-cache)))
- (return (all-completions prefix prev))))))
- (let ((candidates (funcall company-backend 'candidates prefix)))
- (when company-candidates-predicate
- (setq candidates
- (company-apply-predicate candidates
- company-candidates-predicate)))
- (unless (funcall company-backend 'sorted)
- (setq candidates (sort candidates 'string<)))
- (when (or (cdr candidates)
- (not (equal (car candidates) prefix)))
- ;; Don't start when already completed and unique.
- candidates))))
+ (let ((candidates
+ (or (cdr (assoc prefix company-candidates-cache))
+ (when company-candidates-cache
+ (let ((len (length prefix))
+ (completion-ignore-case (funcall company-backend
+ 'ignore-case))
+ prev)
+ (dotimes (i len)
+ (when (setq prev (cdr (assoc (substring prefix 0 (- len i))
+ company-candidates-cache)))
+ (return (all-completions prefix prev))))))
+ (let ((c (funcall company-backend 'candidates prefix)))
+ (when company-candidates-predicate
+ (setq c (company-apply-predicate
+ c company-candidates-predicate)))
+ (unless (funcall company-backend 'sorted)
+ (setq c (sort c 'string<)))
+ c))))
+ (if (or (cdr candidates)
+ (not (equal (car candidates) prefix)))
+ ;; Don't start when already completed and unique.
+ candidates
+ ;; Not the right place? maybe when setting?
+ (and company-candidates t))))
(defun company-idle-begin (buf win tick pos)
(and company-mode
(and company-mode
(not company-candidates)
(let ((company-idle-delay t)
- (company-minimum-prefix-length 0))
+ (company-minimum-prefix-length 0)
+ (company-begin-commands t))
(setq company--explicit-action t)
(company-begin)))
;; Return non-nil if active.
(eq company-require-match t))
(not (eq backend-value 'never))))))
+(defun company-punctuation-p (input)
+ "Return non-nil, if input starts with punctuation or parentheses."
+ (memq (char-syntax (string-to-char input)) '(?. ?\( ?\))))
+
+(defun company-auto-complete-p (beg end)
+ "Return non-nil, if input starts with punctuation or parentheses."
+ (and (> end beg)
+ (if (functionp company-auto-complete)
+ (funcall company-auto-complete)
+ company-auto-complete)
+ (if (functionp company-auto-complete-chars)
+ (funcall company-auto-complete-chars (buffer-substring beg end))
+ (if (consp company-auto-complete-chars)
+ (memq (char-syntax (char-after beg)) company-auto-complete-chars)
+ (string-match (buffer-substring beg (1+ beg))
+ company-auto-complete-chars)))))
+
(defun company-continue ()
(when company-candidates
(when (funcall company-backend 'no-cache company-prefix)
(- company-point (length company-prefix)))
(or (equal company-prefix new-prefix)
(let ((c (company-calculate-candidates new-prefix)))
- (when c
- (setq company-prefix new-prefix)
- (company-update-candidates c)
- t))))
- (if (not (and (company-incremental-p company-prefix new-prefix)
- (company-require-match-p)))
- (setq company-candidates nil)
- (backward-delete-char (length new-prefix))
- (insert company-prefix)
- (ding)
- (message "Matching input is required")
- company-candidates)))))
+ ;; t means complete/unique.
+ (if (eq c t)
+ (progn (company-cancel new-prefix) t)
+ (when (consp c)
+ (setq company-prefix new-prefix)
+ (company-update-candidates c)
+ t)))))
+ (if (company-auto-complete-p company-point (point))
+ (save-excursion
+ (goto-char company-point)
+ (company-complete-selection)
+ (setq company-candidates nil))
+ (if (not (and (company-incremental-p company-prefix new-prefix)
+ (company-require-match-p)))
+ (progn
+ (when (equal company-prefix (car company-candidates))
+ ;; cancel, but last input was actually success
+ (company-cancel company-prefix))
+ (setq company-candidates nil))
+ (backward-delete-char (length new-prefix))
+ (insert company-prefix)
+ (ding)
+ (message "Matching input is required")))
+ company-candidates))))
(defun company-begin ()
(if (or buffer-read-only overriding-terminal-local-map overriding-local-map)
(company-continue)
(unless company-candidates
(let (prefix)
- (dolist (backend company-backends)
- (when (and (fboundp backend)
+ (dolist (backend (if company-backend
+ ;; prefer manual override
+ (list company-backend)
+ (cons company-backend company-backends)))
+ (when (and (functionp backend)
(setq prefix (funcall backend 'prefix)))
(setq company-backend backend)
(when (company-should-complete prefix)
(let ((c (company-calculate-candidates prefix)))
- (when c
+ ;; t means complete/unique. We don't start, so no hooks.
+ (when (consp c)
(setq company-prefix prefix)
(company-update-candidates c)
(run-hook-with-args 'company-completion-started-hook
(company-enable-overriding-keymap nil))
(defun company-abort ()
+ (interactive)
(company-cancel t)
;; Don't start again, unless started manually.
(setq company-point (point)))
"Complete the common part of all candidates."
(interactive)
(when (company-manual-begin)
- (if (equal company-common (car company-candidates))
- ;; for success message
+ (if (and (not (cdr company-candidates))
+ (equal company-common (car company-candidates)))
(company-complete-selection)
(insert (company-strip-prefix company-common)))))
(set-window-start nil (point))))))
(put 'company-show-location 'company-keep t)
+;;; package functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(defvar company-callback nil)
+(make-variable-buffer-local 'company-callback)
+
+(defun company-remove-callback (&optional ignored)
+ (remove-hook 'company-completion-finished-hook company-callback t)
+ (remove-hook 'company-completion-cancelled-hook 'company-remove-callback t))
+
+(defun company-begin-backend (backend &optional callback)
+ "Start a completion at point using BACKEND."
+ (interactive (let ((val (completing-read "Company back-end: "
+ obarray
+ 'functionp nil "company-")))
+ (when val
+ (list (intern val)))))
+ (when callback
+ (setq company-callback
+ `(lambda (completion)
+ (funcall ',callback completion)
+ (company-remove-callback)))
+ (add-hook 'company-completion-cancelled-hook 'company-remove-callback nil t)
+ (add-hook 'company-completion-finished-hook company-callback nil t))
+ (setq company-backend backend)
+ ;; Return non-nil if active.
+ (or (company-manual-begin)
+ (error "Cannot complete at point")))
+
+(defun company-begin-with (candidates
+ &optional prefix-length require-match callback)
+ "Start a completion at point.
+CANDIDATES is the list of candidates to use and PREFIX-LENGTH is the length of
+the prefix that already is in the buffer before point. It defaults to 0.
+
+CALLBACK is a function called with the selected result if the user successfully
+completes the input.
+
+Example:
+\(company-begin-with '\(\"foo\" \"foobar\" \"foobarbaz\"\)\)"
+ (company-begin-backend
+ (let ((start (- (point) (or prefix-length 0))))
+ `(lambda (command &optional arg &rest ignored)
+ (case command-history
+ ('prefix (message "prefix %s" (buffer-substring ,start (point)))
+ (when (>= (point) ,start)
+ (buffer-substring ,start (point))))
+ ('candidates (all-completions arg ',candidates))
+ ('require-match ,require-match))))
+ callback))
+
;;; pseudo-tooltip ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar company-pseudo-tooltip-overlay nil)