;; Copyright (C) 2009 Nikolaj Schumacher
;;
;; Author: Nikolaj Schumacher <bugs * nschum de>
-;; Version: 0.1.5
+;; Version: 0.4.1
;; 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":
;;
;; ('candidates (list "foobar" "foobaz" "foobarbaz"))
;; ('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)))))
+;;
;; Known Issues:
;; When point is at the very end of the buffer, the pseudo-tooltip appears very
;; wrong, unless company is allowed to temporarily insert a fake newline.
;;
;;; Change Log:
;;
+;; Windows compatibility fixes.
+;;
+;; 2009-04-19 (0.4.1)
+;; Added `global-company-mode'.
+;; Performance enhancements.
+;; Added `company-eclim' back-end.
+;; Added safer workaround for Emacs `posn-col-row' bug.
+;;
+;; 2009-04-18 (0.4)
+;; Automatic completion is now aborted if the prefix gets too short.
+;; Added option `company-dabbrev-time-limit'.
+;; `company-backends' now supports merging back-ends.
+;; Added back-end `company-dabbrev-code' for generic code.
+;; Fixed `company-begin-with'.
+;;
+;; 2009-04-15 (0.3.1)
+;; Added 'stop prefix to prevent dabbrev from completing inside of symbols.
+;; Fixed issues with tabbar-mode and line-spacing.
+;; Performance enhancements.
+;;
+;; 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' and `company-auto-complete' options.
+;;
+;; 2009-04-05 (0.2.1)
+;; Improved Emacs Lisp back-end behavior for local variables.
+;; Added `company-elisp-detect-function-context' option.
+;; The mouse can now be used for selection.
+;;
+;; 2009-03-22 (0.2)
+;; Added `company-show-location'.
+;; Added etags back-end.
;; Added work-around for end-of-buffer bug.
;; Added `company-filter-candidates'.
;; More local Lisp variables are now included in the candidates.
(eval-when-compile (require 'cl))
-(add-to-list 'debug-ignored-errors
- "^Pseudo tooltip frontend cannot be used twice$")
-(add-to-list 'debug-ignored-errors "^Preview frontend cannot be used twice$")
+(add-to-list 'debug-ignored-errors "^.* frontend cannot be used twice$")
(add-to-list 'debug-ignored-errors "^Echo area cannot be used twice$")
-(add-to-list 'debug-ignored-errors "^No documentation available$")
-(add-to-list 'debug-ignored-errors "^Company not enabled$")
-(add-to-list 'debug-ignored-errors "^Company not in search mode$")
+(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"
"*Face used for the selection in the tool tip."
:group 'company)
+(defface company-tooltip-mouse
+ '((default :inherit highlight))
+ "*Face used for the tool tip item under the mouse."
+ :group 'company)
+
(defface company-tooltip-common
'((t :inherit company-tooltip
:foreground "red"))
company-preview-if-just-one-frontend)
(function :tag "custom function" nil))))
+(defvar company-safe-backends
+ '((company-abbrev . "Abbrev")
+ (company-css . "CSS")
+ (company-dabbrev . "dabbrev for plain text")
+ (company-dabbrev-code . "dabbrev for code")
+ (company-eclim . "eclim (an Eclipse interace)")
+ (company-elisp . "Emacs Lisp")
+ (company-etags . "etags")
+ (company-files . "Files")
+ (company-gtags . "GNU Global")
+ (company-ispell . "ispell")
+ (company-keywords . "Programming language keywords")
+ (company-nxml . "nxml")
+ (company-oddmuse . "Oddmuse")
+ (company-semantic . "CEDET Semantic")
+ (company-tempo . "Tempo templates")
+ (company-xcode . "Xcode")))
+(put 'company-safe-backends 'risky-local-variable t)
+
+(defun company-safe-backends-p (backends)
+ (and (consp backends)
+ (not (dolist (backend backends)
+ (unless (if (consp backend)
+ (company-safe-backends-p backend)
+ (assq backend company-safe-backends))
+ (return t))))))
+
(defcustom company-backends '(company-elisp company-nxml company-css
- company-semantic company-gtags company-oddmuse
- company-files company-dabbrev)
+ company-eclim company-semantic company-xcode
+ (company-gtags company-etags company-dabbrev-code
+ 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.
+
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.
+back-end. The function should return 'stop if it should complete but cannot
+\(e.g. if it is in the middle of a string\).
'candidates: The second argument is the prefix to be completed. The
return value should be a list of candidates that start with the prefix.
'sorted: The back-end may return t here to indicate that the candidates
are sorted and will not need to be sorted again.
+'duplicates: If non-nil, company will take care of removing duplicates
+from the list.
+
'no-cache: Usually company doesn't ask for candidates again as completion
progresses, unless the back-end returns t for this command. The second
argument is the latest prefix.
create a buffer (preferably with `company-doc-buffer'), fill it with
documentation and return it.
+'location: The second argument is a completion candidate. The back-end can
+return the cons of buffer and buffer location, or of file and line
+number where the completion candidate was defined.
+
+'require-match: If this value is t, the user is not allowed to enter anything
+not offering as a candidate. Use with care! The default value nil gives the
+user that choice with `company-require-match'. Return value 'never overrides
+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)))
+ :type `(repeat
+ (choice
+ :tag "Back-end"
+ ,@(mapcar (lambda (b) `(const :tag ,(cdr b) ,(car b)))
+ company-safe-backends)
+ (symbol :tag "User defined")
+ (repeat :tag "Merged Back-ends"
+ (choice :tag "Back-end"
+ ,@(mapcar (lambda (b)
+ `(const :tag ,(cdr b) ,(car b)))
+ company-safe-backends)
+ (symbol :tag "User defined"))))))
+
+(put 'company-backends 'safe-local-variable 'company-safe-backend-p)
+
+(defcustom company-completion-started-hook nil
+ "*Hook run when company starts completing.
+The hook is called with one argument that is non-nil if the completion was
+started manually."
+ :group 'company
+ :type 'hook)
+
+(defcustom company-completion-cancelled-hook nil
+ "*Hook run when company cancels completing.
+The hook is called with one argument that is non-nil if the completion was
+aborted manually."
+ :group 'company
+ :type 'hook)
+
+(defcustom company-completion-finished-hook nil
+ "*Hook run when company successfully completes.
+The hook is called with the selected candidate as an argument."
+ :group 'company
+ :type 'hook)
(defcustom company-minimum-prefix-length 3
"*The minimum prefix length for automatic completion."
:group 'company
:type '(integer :tag "prefix length"))
+(defcustom company-require-match 'company-explicit-action-p
+ "*If enabled, disallow non-matching input.
+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. `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")
+ (const :tag "On, if user interaction took place"
+ '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-syntax-entry'), 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)
(define-key keymap (kbd "<up>") 'company-select-previous)
+ (define-key keymap [down-mouse-1] 'ignore)
+ (define-key keymap [down-mouse-3] 'ignore)
+ (define-key keymap [mouse-1] 'company-complete-mouse)
+ (define-key keymap [mouse-3] 'company-select-mouse)
+ (define-key keymap [up-mouse-1] 'ignore)
+ (define-key keymap [up-mouse-3] 'ignore)
(define-key keymap "\C-m" 'company-complete-selection)
(define-key keymap "\t" 'company-complete-common)
(define-key keymap (kbd "<f1>") 'company-show-doc-buffer)
+ (define-key keymap "\C-w" 'company-show-location)
(define-key keymap "\C-s" 'company-search-candidates)
(define-key keymap "\C-\M-s" 'company-filter-candidates)
(dotimes (i 10)
keymap)
"Keymap that is enabled during an active completion.")
+(defvar company--disabled-backends nil)
+
+(defun company-init-backend (backend)
+ (and (symbolp backend)
+ (not (fboundp backend))
+ (ignore-errors (require backend nil t)))
+
+ (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)
+ (mapc 'company-init-backend backend)))
+
;;;###autoload
(define-minor-mode company-mode
"\"complete anything\"; in in-buffer completion framework.
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'):
(progn
(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))))
+ (mapc 'company-init-backend company-backends))
(remove-hook 'pre-command-hook 'company-pre-command t)
(remove-hook 'post-command-hook 'company-post-command t)
(company-cancel)
(kill-local-variable 'company-point)))
+(define-globalized-minor-mode global-company-mode company-mode
+ (lambda () (company-mode 1)))
+
+(defsubst company-assert-enabled ()
+ (unless company-mode
+ (company-uninstall-map)
+ (error "Company not enabled")))
+
;;; keymaps ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar company-overriding-keymap-bound nil)
company-overriding-keymap-bound t)))
(defun company-uninstall-map ()
- (when (and company-overriding-keymap-bound
- (eq overriding-terminal-local-map company-my-keymap))
+ (when (eq overriding-terminal-local-map company-my-keymap)
(setq overriding-terminal-local-map company-old-keymap
company-overriding-keymap-bound nil)))
;; Emacs calculates the active keymaps before reading the event. That means we
;; cannot change the keymap from a timer. So we send a bogus command.
(defun company-ignore ()
- (interactive))
+ (interactive)
+ (setq this-command last-command))
(global-set-key '[31415926] 'company-ignore)
(defun company-input-noop ()
(push 31415926 unread-command-events))
+;; Hack:
+;; posn-col-row is incorrect in older Emacsen when line-spacing is set
+(defun company--col-row (&optional pos)
+ (let ((posn (posn-at-point pos)))
+ (cons (car (posn-col-row posn)) (cdr (posn-actual-col-row posn)))))
+
+(defsubst company--column (&optional pos)
+ (car (posn-col-row (posn-at-point pos))))
+
+(defsubst company--row (&optional pos)
+ (cdr (posn-actual-col-row (posn-at-point pos))))
+
;;; backends ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-(defun company-grab (regexp &optional expression)
- (when (looking-back regexp)
+(defun company-grab (regexp &optional expression limit)
+ (when (looking-back regexp limit)
(or (match-string-no-properties (or expression 0)) "")))
-(defun company-in-string-or-comment (&optional point)
- (let ((pos (syntax-ppss)))
- (or (nth 3 pos) (nth 4 pos) (nth 7 pos))))
+(defun company-grab-line (regexp &optional expression)
+ (company-grab regexp expression (point-at-bol)))
+
+(defun company-grab-symbol ()
+ (if (looking-at "\\_>")
+ (buffer-substring (point) (save-excursion (skip-syntax-backward "w_")
+ (point)))
+ (unless (and (char-after) (memq (char-syntax (char-after)) '(?w ?_)))
+ "")))
+
+(defun company-grab-word ()
+ (if (looking-at "\\>")
+ (buffer-substring (point) (save-excursion (skip-syntax-backward "w")
+ (point)))
+ (unless (and (char-after) (eq (char-syntax (char-after)) ?w))
+ "")))
+
+(defun company-in-string-or-comment ()
+ (let ((ppss (syntax-ppss)))
+ (or (car (setq ppss (nthcdr 3 ppss)))
+ (car (setq ppss (cdr ppss)))
+ (nth 3 ppss))))
+
+(if (fboundp 'locate-dominating-file)
+ (defalias 'company-locate-dominating-file 'locate-dominating-file)
+ (defun company-locate-dominating-file (file name)
+ (catch 'root
+ (let ((dir (file-name-directory file))
+ (prev-dir nil))
+ (while (not (equal dir prev-dir))
+ (when (file-exists-p (expand-file-name name dir))
+ (throw 'root dir))
+ (setq prev-dir dir
+ dir (file-name-directory (directory-file-name dir))))))))
+
+(defun company-call-backend (&rest args)
+ (if (functionp company-backend)
+ (apply company-backend args)
+ (apply 'company--multi-backend-adapter company-backend args)))
+
+(defun company--multi-backend-adapter (backends command &rest args)
+ (case command
+ ('candidates
+ (apply 'append (mapcar (lambda (backend) (apply backend command args))
+ backends)))
+ ('sorted nil)
+ ('duplicates t)
+ (otherwise
+ (let (value)
+ (dolist (backend backends)
+ (when (setq value (apply backend command args))
+ (return value)))))))
;;; completion mechanism ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defvar company-selection-changed nil)
(make-variable-buffer-local 'company-selection-changed)
+(defvar company--explicit-action nil
+ "Non-nil, if explicit completion took place.")
+(make-variable-buffer-local 'company--explicit-action)
+
+(defvar company--point-max nil)
+(make-variable-buffer-local 'company--point-max)
+
(defvar company-point nil)
(make-variable-buffer-local 'company-point)
(defsubst company-strip-prefix (str)
(substring str (length company-prefix)))
+(defun company-explicit-action-p ()
+ "Return whether explicit completion action was taken by the user."
+ (or company--explicit-action
+ company-selection-changed))
+
(defsubst company-reformat (candidate)
;; company-ispell needs this, because the results are always lower-case
;; It's mory efficient to fix it only when they are displayed.
(concat company-prefix (substring candidate (length company-prefix))))
-(defsubst company-should-complete (prefix)
- (and (eq company-idle-delay t)
- (>= (length prefix) company-minimum-prefix-length)))
+(defun company--should-complete ()
+ (and (not (or buffer-read-only overriding-terminal-local-map
+ overriding-local-map))
+ (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))))
(defsubst company-call-frontends (command)
(dolist (frontend company-frontends)
company-selection)))))
(setq company-selection 0
company-candidates candidates))
+ ;; Save in cache:
+ (push (cons company-prefix company-candidates) company-candidates-cache)
;; Calculate common.
- (let ((completion-ignore-case (funcall company-backend 'ignore-case)))
+ (let ((completion-ignore-case (company-call-backend 'ignore-case)))
(setq company-common (try-completion company-prefix company-candidates)))
(when (eq company-common t)
(setq company-candidates nil)))
-(defsubst company-calculate-candidates (prefix)
- (setq company-prefix prefix)
- (company-update-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 ((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<)))
- candidates)))
- (unless company-candidates-cache
- (company-call-frontends 'show))
- (unless (assoc prefix company-candidates-cache)
- (push (cons prefix company-candidates) company-candidates-cache))
- company-candidates)
+(defun company-calculate-candidates (prefix)
+ (let ((candidates (cdr (assoc prefix company-candidates-cache))))
+ (or candidates
+ (when company-candidates-cache
+ (let ((len (length prefix))
+ (completion-ignore-case (company-call-backend 'ignore-case))
+ prev)
+ (dotimes (i (1+ len))
+ (when (setq prev (cdr (assoc (substring prefix 0 (- len i))
+ company-candidates-cache)))
+ (setq candidates (all-completions prefix prev))
+ (return t)))))
+ ;; no cache match, call back-end
+ (progn
+ (setq candidates (company-call-backend 'candidates prefix))
+ (when company-candidates-predicate
+ (setq candidates
+ (company-apply-predicate candidates
+ company-candidates-predicate)))
+ (unless (company-call-backend 'sorted)
+ (setq candidates (sort candidates 'string<)))
+ (when (company-call-backend 'duplicates)
+ ;; strip duplicates
+ (let ((c2 candidates))
+ (while c2
+ (setcdr c2 (progn (while (equal (pop c2) (car c2)))
+ c2)))))))
+ (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
(eq pos (point))
(not company-candidates)
(not (equal (point) company-point))
- (let ((company-idle-delay t))
+ (let ((company-idle-delay t)
+ (company-begin-commands t))
(company-begin)
(when company-candidates
(company-input-noop)
(company-post-command)))))
-(defun company-manual-begin ()
- (interactive)
- (unless company-mode (error "Company not enabled"))
+(defun company-auto-begin ()
+ (company-assert-enabled)
(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))
(company-begin)))
;; Return non-nil if active.
company-candidates)
-(defun company-continue ()
- (when company-candidates
- (when (funcall company-backend 'no-cache company-prefix)
- ;; Don't complete existing candidates, fetch new ones.
- (setq company-candidates-cache nil))
- (let ((new-prefix (funcall company-backend 'prefix)))
- (unless (and (= (- (point) (length new-prefix))
- (- company-point (length company-prefix)))
- (or (equal company-prefix new-prefix)
- (company-calculate-candidates new-prefix)))
- (setq company-candidates nil)))))
+(defun company-manual-begin ()
+ (interactive)
+ (setq company--explicit-action t)
+ (company-auto-begin))
+
+(defun company-require-match-p ()
+ (let ((backend-value (company-call-backend 'require-match)))
+ (or (eq backend-value t)
+ (and (if (functionp company-require-match)
+ (funcall company-require-match)
+ (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 (input)
+ "Return non-nil, if input starts with punctuation or parentheses."
+ (and (if (functionp company-auto-complete)
+ (funcall company-auto-complete)
+ company-auto-complete)
+ (if (functionp company-auto-complete-chars)
+ (funcall company-auto-complete-chars input)
+ (if (consp company-auto-complete-chars)
+ (memq (char-syntax (string-to-char input))
+ company-auto-complete-chars)
+ (string-match (substring input 0 1) company-auto-complete-chars)))))
+
+(defun company--incremental-p ()
+ (and (> (point) company-point)
+ (> (point-max) company--point-max)
+ (not (eq this-command 'backward-delete-char-untabify))
+ (equal (buffer-substring (- company-point (length company-prefix))
+ company-point)
+ company-prefix)))
+
+(defsubst company--string-incremental-p (old-prefix new-prefix)
+ (and (> (length new-prefix) (length old-prefix))
+ (equal old-prefix (substring new-prefix 0 (length old-prefix)))))
+
+(defun company--continue-failed (new-prefix)
+ (when (company--incremental-p)
+ (let ((input (buffer-substring-no-properties (point) company-point)))
+ (cond
+ ((company-auto-complete-p input)
+ ;; auto-complete
+ (save-excursion
+ (goto-char company-point)
+ (company-complete-selection)
+ nil))
+ ((and (company--string-incremental-p company-prefix new-prefix)
+ (company-require-match-p))
+ ;; wrong incremental input, but required match
+ (backward-delete-char (length input))
+ (ding)
+ (message "Matching input is required")
+ company-candidates)
+ ((equal company-prefix (car company-candidates))
+ ;; last input was actually success
+ (company-cancel company-prefix)
+ nil)))))
+
+(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))
+ (= (- (point) (length new-prefix))
+ (- company-point (length company-prefix))))
+ (company-calculate-candidates new-prefix))))
+ (or (cond
+ ((eq c t)
+ ;; t means complete/unique.
+ (company-cancel new-prefix)
+ nil)
+ ((consp c)
+ ;; incremental match
+ (setq company-prefix new-prefix)
+ (company-update-candidates c)
+ c)
+ (t (company--continue-failed new-prefix)))
+ (company-cancel))))
+
+(defun company--begin-new ()
+ (let (prefix c)
+ (dolist (backend (if company-backend
+ ;; prefer manual override
+ (list company-backend)
+ company-backends))
+ (setq prefix
+ (if (or (symbolp backend)
+ (functionp backend))
+ (when (or (not (symbolp backend))
+ (eq t (get backend 'company-init))
+ (unless (get backend 'company-init)
+ (company-init-backend backend)))
+ (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
+ c (company-calculate-candidates prefix))
+ ;; 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-explicit-action-p))
+ (company-call-frontends 'show)))
+ (return c)))))
(defun company-begin ()
- (if (or buffer-read-only overriding-terminal-local-map overriding-local-map)
- ;; Don't complete in these cases.
- (setq company-candidates nil)
- (company-continue)
- (unless company-candidates
- (let (prefix)
- (dolist (backend company-backends)
- (and (fboundp backend)
- (setq prefix (funcall backend 'prefix))
- (company-should-complete prefix)
- (setq company-backend backend)
- (company-calculate-candidates prefix))
- (return prefix)))))
- (if company-candidates
- (progn
- (and company-end-of-buffer-workaround
- (eobp)
- (setq company-added-newline t)
- (save-excursion (insert "\n")))
- (setq company-point (point))
- (company-enable-overriding-keymap company-active-map)
- (company-call-frontends 'update))
- (company-cancel)))
-
-(defun company-cancel ()
+ (setq company-candidates
+ (or (and company-candidates (company--continue))
+ (and (company--should-complete) (company--begin-new))))
+ (when company-candidates
+ (when (and company-end-of-buffer-workaround (eobp))
+ (save-excursion (insert "\n"))
+ (setq company-added-newline (buffer-chars-modified-tick)))
+ (setq company-point (point)
+ company--point-max (point-max))
+ (company-enable-overriding-keymap company-active-map)
+ (company-call-frontends 'update)))
+
+(defun company-cancel (&optional result)
(and company-added-newline
(> (point-max) (point-min))
- (delete-region (1- (point-max)) (point-max)))
+ (let ((tick (buffer-chars-modified-tick)))
+ (delete-region (1- (point-max)) (point-max))
+ (equal tick company-added-newline))
+ ;; Only set unmodified when tick remained the same since insert.
+ (set-buffer-modified-p nil))
+ (when company-prefix
+ (if (stringp result)
+ (run-hook-with-args 'company-completion-finished-hook result)
+ (run-hook-with-args 'company-completion-cancelled-hook result)))
(setq company-added-newline nil
company-backend nil
company-prefix nil
company-common nil
company-selection 0
company-selection-changed nil
+ company--explicit-action nil
+ company--point-max nil
company-point nil)
(when company-timer
(cancel-timer company-timer))
(company-enable-overriding-keymap nil))
(defun company-abort ()
- (company-cancel)
+ (interactive)
+ (company-cancel t)
+ ;; Don't start again, unless started manually.
+ (setq company-point (point)))
+
+(defun company-finish (result)
+ (insert (company-strip-prefix result))
+ (company-cancel result)
;; Don't start again, unless started manually.
(setq company-point (point)))
+(defsubst company-keep (command)
+ (and (symbolp command) (get command 'company-keep)))
+
(defun company-pre-command ()
- (unless (eq this-command 'company-show-doc-buffer)
+ (unless (company-keep this-command)
(condition-case err
(when company-candidates
(company-call-frontends 'pre-command))
(message "%s" (error-message-string err))
(company-cancel))))
(when company-timer
- (cancel-timer company-timer))
+ (cancel-timer company-timer)
+ (setq company-timer nil))
(company-uninstall-map))
(defun company-post-command ()
- (unless (eq this-command 'company-show-doc-buffer)
+ (unless (company-keep this-command)
(condition-case err
(progn
(unless (equal (point) company-point)
(company-begin))
- (when company-candidates
- (company-call-frontends 'post-command))
- (when (numberp company-idle-delay)
- (setq company-timer
- (run-with-timer company-idle-delay nil 'company-idle-begin
- (current-buffer) (selected-window)
- (buffer-chars-modified-tick) (point)))))
+ (if company-candidates
+ (company-call-frontends 'post-command)
+ (and (numberp company-idle-delay)
+ (or (eq t company-begin-commands)
+ (memq this-command company-begin-commands))
+ (setq company-timer
+ (run-with-timer company-idle-delay nil
+ 'company-idle-begin
+ (current-buffer) (selected-window)
+ (buffer-chars-modified-tick) (point))))))
(error (message "Company: An error occurred in post-command")
(message "%s" (error-message-string err))
(company-cancel))))
(defun company-search-printing-char ()
(interactive)
- (unless company-mode (error "Company not enabled"))
- (unless company-search-mode (error "Company not in search mode"))
+ (company-search-assert-enabled)
(setq company-search-string
(concat (or company-search-string "") (string last-command-event))
company-search-lighter (concat " Search: \"" company-search-string
(defun company-search-repeat-forward ()
"Repeat the incremental search in completion candidates forward."
(interactive)
- (unless company-mode (error "Company not enabled"))
- (unless company-search-mode (error "Company not in search mode"))
+ (company-search-assert-enabled)
(let ((pos (company-search company-search-string
(cdr (nthcdr company-selection
company-candidates)))))
(defun company-search-repeat-backward ()
"Repeat the incremental search in completion candidates backwards."
(interactive)
- (unless company-mode (error "Company not enabled"))
- (unless company-search-mode (error "Company not in search mode"))
+ (company-search-assert-enabled)
(let ((pos (company-search company-search-string
(nthcdr (- company-candidates-length
company-selection)
candidate))
`(string-match ,company-search-string candidate))))
(company-update-candidates
- (company-apply-predicate company-candidates company-candidates-predicate)))
+ (company-apply-predicate company-candidates company-candidates-predicate))
+ ;; Invalidate cache.
+ (setq company-candidates-cache (cons company-prefix company-candidates)))
(defun company-filter-printing-char ()
(interactive)
- (unless company-mode (error "Company not enabled"))
- (unless company-search-mode (error "Company not in search mode"))
+ (company-search-assert-enabled)
(company-search-printing-char)
(company-create-match-predicate)
(company-call-frontends 'update))
(defun company-search-kill-others ()
"Limit the completion candidates to the ones matching the search string."
(interactive)
- (unless company-mode (error "Company not enabled"))
- (unless company-search-mode (error "Company not in search mode"))
+ (company-search-assert-enabled)
(company-create-match-predicate)
(company-search-mode 0)
(company-call-frontends 'update))
(defun company-search-abort ()
"Abort searching the completion candidates."
(interactive)
- (unless company-mode (error "Company not enabled"))
- (unless company-search-mode (error "Company not in search mode"))
+ (company-search-assert-enabled)
(company-set-selection company-search-old-selection t)
(company-search-mode 0))
(defun company-search-other-char ()
(interactive)
- (unless company-mode (error "Company not enabled"))
- (unless company-search-mode (error "Company not in search mode"))
+ (company-search-assert-enabled)
(company-search-mode 0)
(when last-input-event
(clear-this-command-keys t)
(kill-local-variable 'company-search-old-selection)
(company-enable-overriding-keymap company-active-map)))
+(defsubst company-search-assert-enabled ()
+ (company-assert-enabled)
+ (unless company-search-mode
+ (company-uninstall-map)
+ (error "Company not in search mode")))
+
(defun company-search-candidates ()
"Start searching the completion candidates incrementally.
(when (company-manual-begin)
(company-set-selection (1- company-selection))))
+(defun company-select-mouse (event)
+ "Select the candidate picked by the mouse."
+ (interactive "e")
+ (when (nth 4 (event-start event))
+ (company-set-selection (- (cdr (posn-actual-col-row (event-start event)))
+ (company--row)
+ 1))
+ t))
+
+(defun company-complete-mouse (event)
+ "Complete the candidate picked by the mouse."
+ (interactive "e")
+ (when (company-select-mouse event)
+ (company-complete-selection)))
+
(defun company-complete-selection ()
"Complete the selected candidate."
(interactive)
(when (company-manual-begin)
- (insert (company-strip-prefix (nth company-selection company-candidates)))
- (company-abort)))
+ (company-finish (nth company-selection company-candidates))))
(defun company-complete-common ()
"Complete the common part of all candidates."
(interactive)
(when (company-manual-begin)
- (insert (company-strip-prefix company-common))))
+ (if (and (not (cdr company-candidates))
+ (equal company-common (car company-candidates)))
+ (company-complete-selection)
+ (insert (company-strip-prefix company-common)))))
(defun company-complete ()
"Complete the common part of all candidates or the current selection.
(setq this-command 'company-complete-common))))
(defun company-complete-number (n)
- "Complete the Nth candidate."
+ "Complete the Nth candidate.
+To show the number next to the candidates in some back-ends, enable
+`company-show-numbers'."
(when (company-manual-begin)
(and (< n 1) (> n company-candidates-length)
(error "No candidate number %d" n))
(decf n)
- (insert (company-strip-prefix (nth n company-candidates)))
- (company-abort)))
+ (company-finish (nth n company-candidates))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(let ((selected (nth company-selection company-candidates)))
(unless (equal selected (car company-last-metadata))
(setq company-last-metadata
- (cons selected (funcall company-backend 'meta selected))))
+ (cons selected (company-call-backend 'meta selected))))
(cdr company-last-metadata)))
(defun company-doc-buffer (&optional string)
(erase-buffer)
(current-buffer)))
+(defmacro company-electric (&rest body)
+ (declare (indent 0) (debug t))
+ `(when (company-manual-begin)
+ (save-window-excursion
+ (let ((height (window-height))
+ (row (company--row)))
+ ,@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))
+ (when last-input-event
+ (clear-this-command-keys t)
+ (setq unread-command-events (list last-input-event)))))))
+
(defun company-show-doc-buffer ()
"Temporarily show a buffer with the complete documentation for the selection."
(interactive)
- (unless company-mode (error "Company not enabled"))
- (when (company-manual-begin)
- (save-window-excursion
- (let* ((height (window-height))
- (row (cdr (posn-col-row (posn-at-point))))
- (selected (nth company-selection company-candidates))
- (buffer (funcall company-backend 'doc-buffer selected)))
- (if (not buffer)
- (error "No documentation available.")
- (display-buffer buffer)
- (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)))))
- (scroll-other-window))
- (when last-input-event
- (clear-this-command-keys t)
- (setq unread-command-events (list last-input-event))))))))
+ (company-electric
+ (let ((selected (nth company-selection company-candidates)))
+ (display-buffer (or (company-call-backend 'doc-buffer selected)
+ (error "No documentation available")) t))))
+(put 'company-show-doc-buffer 'company-keep t)
+
+(defun company-show-location ()
+ "Temporarily display a buffer showing the selected candidate in context."
+ (interactive)
+ (company-electric
+ (let* ((selected (nth company-selection company-candidates))
+ (location (company-call-backend 'location selected))
+ (pos (or (cdr location) (error "No location available")))
+ (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))
+ (set-window-start nil (point))))))
+(put 'company-show-location 'company-keep t)
+
+;;; package functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(defvar company-callback nil)
+(make-variable-buffer-local 'company-callback)
+
+(defvar company-begin-with-marker nil)
+(make-variable-buffer-local 'company-begin-with-marker)
+
+(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)
+ (remove-hook 'company-completion-finished-hook 'company-remove-callback t)
+ (set-marker company-begin-with-marker nil))
+
+(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 (setq company-callback callback)
+ (add-hook 'company-completion-finished-hook company-callback nil t))
+ (add-hook 'company-completion-cancelled-hook 'company-remove-callback nil t)
+ (add-hook 'company-completion-finished-hook 'company-remove-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\"\)\)"
+ (setq company-begin-with-marker (copy-marker (point) t))
+ (company-begin-backend
+ `(lambda (command &optional arg &rest ignored)
+ (cond
+ ((eq command 'prefix)
+ (when (equal (point) (marker-position company-begin-with-marker))
+ (buffer-substring ,(- (point) (or prefix-length 0)) (point))))
+ ((eq command 'candidates)
+ (all-completions arg ',candidates))
+ ((eq command 'require-match)
+ ,require-match)))
+ callback))
;;; pseudo-tooltip ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defun company-fill-propertize (line width selected)
(setq line (company-safe-substring line 0 width))
- (add-text-properties 0 width (list 'face 'company-tooltip) line)
+ (add-text-properties 0 width '(face company-tooltip
+ mouse-face company-tooltip-mouse)
+ line)
(add-text-properties 0 (length company-common)
- (list 'face 'company-tooltip-common) line)
+ '(face company-tooltip-common
+ mouse-face company-tooltip-mouse)
+ line)
(when selected
(if (and company-search-string
(string-match (regexp-quote company-search-string) line
(length company-prefix)))
(progn
(add-text-properties (match-beginning 0) (match-end 0)
- '(face company-tooltip-selection) line)
+ '(face company-tooltip-selection)
+ line)
(when (< (match-beginning 0) (length company-common))
(add-text-properties (match-beginning 0) (length company-common)
'(face company-tooltip-common-selection)
line)))
- (add-text-properties 0 width '(face company-tooltip-selection) line)
+ (add-text-properties 0 width '(face company-tooltip-selection
+ mouse-face company-tooltip-selection)
+ line)
(add-text-properties 0 (length company-common)
- (list 'face 'company-tooltip-common-selection)
+ '(face company-tooltip-common-selection
+ mouse-face company-tooltip-selection)
line)))
line)
(defun company-buffer-lines (beg end)
(goto-char beg)
- (let ((row (cdr (posn-col-row (posn-at-point))))
+ (let ((row (company--row))
lines)
(while (and (equal (move-to-window-line (incf row)) row)
(<= (point) end))
(setq remainder (format "...(%d)" remainder))))
(decf selection company-tooltip-offset)
- (setq width (min (length previous) (length remainder))
+ (setq width (max (length previous) (length remainder))
lines (nthcdr company-tooltip-offset company-candidates)
len (min limit len)
lines-copy lines)
(setq lines-copy lines)
;; number can make tooltip too long
- (and company-show-numbers
- (< (setq numbered company-tooltip-offset) 10)
- (incf width 2))
+ (when company-show-numbers
+ (setq numbered company-tooltip-offset))
(when previous
(push (propertize (company-safe-substring previous 0 width)
(overlay-put company-pseudo-tooltip-overlay 'window (selected-window)))))
(defun company-pseudo-tooltip-show-at-point (pos)
- (let ((col-row (posn-col-row (posn-at-point pos))))
- (company-pseudo-tooltip-show (1+ (cdr col-row)) (car col-row) company-selection)))
+ (let ((col-row (company--col-row pos)))
+ (when col-row
+ (company-pseudo-tooltip-show (1+ (cdr col-row)) (car col-row)
+ company-selection))))
(defun company-pseudo-tooltip-edit (lines selection)
(let* ((old-string (overlay-get company-pseudo-tooltip-overlay 'company-old))