1 ;;; company.el --- Modular text completion framework -*- lexical-binding: t -*-
3 ;; Copyright (C) 2009-2015 Free Software Foundation, Inc.
5 ;; Author: Nikolaj Schumacher
6 ;; Maintainer: Dmitry Gutov <dgutov@yandex.ru>
7 ;; URL: http://company-mode.github.io/
9 ;; Keywords: abbrev, convenience, matching
10 ;; Package-Requires: ((emacs "24.1") (cl-lib "0.5"))
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; Company is a modular completion mechanism. Modules for retrieving completion
30 ;; candidates are called back-ends, modules for displaying them are front-ends.
32 ;; Company comes with many back-ends, e.g. `company-elisp'. These are
33 ;; distributed in separate files and can be used individually.
35 ;; Place company.el and the back-ends you want to use in a directory and add the
36 ;; following to your .emacs:
37 ;; (add-to-list 'load-path "/path/to/company")
38 ;; (autoload 'company-mode "company" nil t)
40 ;; Enable company-mode with M-x company-mode. For further information look at
41 ;; the documentation for `company-mode' (C-h f company-mode RET)
43 ;; If you want to start a specific back-end, call it interactively or use
44 ;; `company-begin-backend'. For example:
45 ;; M-x company-abbrev will prompt for and insert an abbrev.
47 ;; To write your own back-end, look at the documentation for `company-backends'.
48 ;; Here is a simple example completing "foo":
50 ;; (defun company-my-backend (command &optional arg &rest ignored)
52 ;; (`prefix (when (looking-back "foo\\>")
54 ;; (`candidates (list "foobar" "foobaz" "foobarbaz"))
55 ;; (`meta (format "This value is named %s" arg))))
57 ;; Sometimes it is a good idea to mix several back-ends together, for example to
58 ;; enrich gtags with dabbrev-code results (to emulate local variables).
59 ;; To do this, add a list with both back-ends as an element in company-backends.
63 ;; See NEWS.md in the repository.
70 ;; FIXME: Use `user-error'.
71 (add-to-list 'debug-ignored-errors "^.* frontend cannot be used twice$")
72 (add-to-list 'debug-ignored-errors "^Echo area cannot be used twice$")
73 (add-to-list 'debug-ignored-errors "^No \\(document\\|loc\\)ation available$")
74 (add-to-list 'debug-ignored-errors "^Company not ")
75 (add-to-list 'debug-ignored-errors "^No candidate number ")
76 (add-to-list 'debug-ignored-errors "^Cannot complete at point$")
77 (add-to-list 'debug-ignored-errors "^No other back-end$")
81 ;; `defvar-local' for Emacs 24.2 and below
82 (unless (fboundp 'defvar-local)
83 (defmacro defvar-local (var val &optional docstring)
84 "Define VAR as a buffer-local variable with default value VAL.
85 Like `defvar' but additionally marks the variable as being automatically
86 buffer-local wherever it is set."
87 (declare (debug defvar) (doc-string 3))
89 (defvar ,var ,val ,docstring)
90 (make-variable-buffer-local ',var)))))
93 "Extensible inline text completion mechanism"
98 (defface company-tooltip
99 '((default :foreground "black")
100 (((class color) (min-colors 88) (background light))
101 (:background "cornsilk"))
102 (((class color) (min-colors 88) (background dark))
103 (:background "yellow")))
104 "Face used for the tooltip.")
106 (defface company-tooltip-selection
107 '((default :inherit company-tooltip)
108 (((class color) (min-colors 88) (background light))
109 (:background "light blue"))
110 (((class color) (min-colors 88) (background dark))
111 (:background "orange1"))
112 (t (:background "green")))
113 "Face used for the selection in the tooltip.")
115 (defface company-tooltip-search
116 '((default :inherit company-tooltip-selection))
117 "Face used for the search string in the tooltip.")
119 (defface company-tooltip-mouse
120 '((default :inherit highlight))
121 "Face used for the tooltip item under the mouse.")
123 (defface company-tooltip-common
124 '((default :inherit company-tooltip)
125 (((background light))
126 :foreground "darkred")
129 "Face used for the common completion in the tooltip.")
131 (defface company-tooltip-common-selection
132 '((default :inherit company-tooltip-selection)
133 (((background light))
134 :foreground "darkred")
137 "Face used for the selected common completion in the tooltip.")
139 (defface company-tooltip-annotation
140 '((default :inherit company-tooltip)
141 (((background light))
142 :foreground "firebrick4")
145 "Face used for the annotation in the tooltip.")
147 (defface company-scrollbar-fg
148 '((((background light))
149 :background "darkred")
152 "Face used for the tooltip scrollbar thumb.")
154 (defface company-scrollbar-bg
155 '((default :inherit company-tooltip)
156 (((background light))
160 "Face used for the tooltip scrollbar background.")
162 (defface company-preview
163 '((((background light))
164 :inherit company-tooltip-selection)
167 :foreground "wheat"))
168 "Face used for the completion preview.")
170 (defface company-preview-common
171 '((((background light))
172 :inherit company-tooltip-selection)
174 :inherit company-preview
176 "Face used for the common part of the completion preview.")
178 (defface company-preview-search
179 '((((background light))
180 :inherit company-tooltip-common-selection)
182 :inherit company-preview
183 :background "blue1"))
184 "Face used for the search string in the completion preview.")
186 (defface company-echo nil
187 "Face used for completions in the echo area.")
189 (defface company-echo-common
190 '((((background dark)) (:foreground "firebrick1"))
191 (((background light)) (:background "firebrick4")))
192 "Face used for the common part of completions in the echo area.")
194 (defun company-frontends-set (variable value)
196 (let ((value (delete-dups (copy-sequence value))))
197 (and (memq 'company-pseudo-tooltip-unless-just-one-frontend value)
198 (memq 'company-pseudo-tooltip-frontend value)
199 (error "Pseudo tooltip frontend cannot be used twice"))
200 (and (memq 'company-preview-if-just-one-frontend value)
201 (memq 'company-preview-frontend value)
202 (error "Preview frontend cannot be used twice"))
203 (and (memq 'company-echo value)
204 (memq 'company-echo-metadata-frontend value)
205 (error "Echo area cannot be used twice"))
206 ;; Preview must come last.
207 (dolist (f '(company-preview-if-just-one-frontend company-preview-frontend))
208 (when (cdr (memq f value))
209 (setq value (append (delq f value) (list f)))))
210 (set variable value)))
212 (defcustom company-frontends '(company-pseudo-tooltip-unless-just-one-frontend
213 company-preview-if-just-one-frontend
214 company-echo-metadata-frontend)
215 "The list of active front-ends (visualizations).
216 Each front-end is a function that takes one argument. It is called with
217 one of the following arguments:
219 `show': When the visualization should start.
221 `hide': When the visualization should end.
223 `update': When the data has been updated.
225 `pre-command': Before every command that is executed while the
226 visualization is active.
228 `post-command': After every command that is executed while the
229 visualization is active.
231 The visualized data is stored in `company-prefix', `company-candidates',
232 `company-common', `company-selection', `company-point' and
233 `company-search-string'."
234 :set 'company-frontends-set
235 :type '(repeat (choice (const :tag "echo" company-echo-frontend)
236 (const :tag "echo, strip common"
237 company-echo-strip-common-frontend)
238 (const :tag "show echo meta-data in echo"
239 company-echo-metadata-frontend)
240 (const :tag "pseudo tooltip"
241 company-pseudo-tooltip-frontend)
242 (const :tag "pseudo tooltip, multiple only"
243 company-pseudo-tooltip-unless-just-one-frontend)
244 (const :tag "preview" company-preview-frontend)
245 (const :tag "preview, unique only"
246 company-preview-if-just-one-frontend)
247 (function :tag "custom function" nil))))
249 (defcustom company-tooltip-limit 10
250 "The maximum number of candidates in the tooltip."
253 (defcustom company-tooltip-minimum 6
254 "The minimum height of the tooltip.
255 If this many lines are not available, prefer to display the tooltip above."
258 (defcustom company-tooltip-minimum-width 0
259 "The minimum width of the tooltip's inner area.
260 This doesn't include the margins and the scroll bar."
262 :package-version '(company . "0.8.0"))
264 (defcustom company-tooltip-margin 1
265 "Width of margin columns to show around the toolip."
268 (defcustom company-tooltip-offset-display 'scrollbar
269 "Method using which the tooltip displays scrolling position.
270 `scrollbar' means draw a scrollbar to the right of the items.
271 `lines' means wrap items in lines with \"before\" and \"after\" counters."
272 :type '(choice (const :tag "Scrollbar" scrollbar)
273 (const :tag "Two lines" lines)))
275 (defcustom company-tooltip-align-annotations nil
276 "When non-nil, align annotations to the right tooltip border."
278 :package-version '(company . "0.7.1"))
280 (defcustom company-tooltip-flip-when-above nil
281 "Whether to flip the tooltip when it's above the current line."
283 :package-version '(company . "0.8.1"))
285 (defvar company-safe-backends
286 '((company-abbrev . "Abbrev")
287 (company-bbdb . "BBDB")
288 (company-capf . "completion-at-point-functions")
289 (company-clang . "Clang")
290 (company-cmake . "CMake")
291 (company-css . "CSS")
292 (company-dabbrev . "dabbrev for plain text")
293 (company-dabbrev-code . "dabbrev for code")
294 (company-eclim . "Eclim (an Eclipse interface)")
295 (company-elisp . "Emacs Lisp")
296 (company-etags . "etags")
297 (company-files . "Files")
298 (company-gtags . "GNU Global")
299 (company-ispell . "Ispell")
300 (company-keywords . "Programming language keywords")
301 (company-nxml . "nxml")
302 (company-oddmuse . "Oddmuse")
303 (company-pysmell . "PySmell")
304 (company-ropemacs . "ropemacs")
305 (company-semantic . "Semantic")
306 (company-tempo . "Tempo templates")
307 (company-xcode . "Xcode")))
308 (put 'company-safe-backends 'risky-local-variable t)
310 (defun company-safe-backends-p (backends)
311 (and (consp backends)
312 (not (cl-dolist (backend backends)
313 (unless (if (consp backend)
314 (company-safe-backends-p backend)
315 (assq backend company-safe-backends))
318 (defcustom company-backends `(,@(unless (version< "24.3.50" emacs-version)
319 (list 'company-elisp))
321 company-nxml company-css
322 company-eclim company-semantic company-clang
323 company-xcode company-ropemacs company-cmake
325 (company-dabbrev-code company-gtags company-etags
327 company-oddmuse company-files company-dabbrev)
328 "The list of active back-ends (completion engines).
330 Only one back-end is used at a time. The choice depends on the order of
331 the items in this list, and on the values they return in response to the
332 `prefix' command (see below). But a back-end can also be a \"grouped\"
335 `company-begin-backend' can be used to start a specific back-end,
336 `company-other-backend' will skip to the next matching back-end in the list.
338 Each back-end is a function that takes a variable number of arguments.
339 The first argument is the command requested from the back-end. It is one
342 `prefix': The back-end should return the text to be completed. It must be
343 text immediately before point. Returning nil from this command passes
344 control to the next back-end. The function should return `stop' if it
345 should complete but cannot (e.g. if it is in the middle of a string).
346 Instead of a string, the back-end may return a cons where car is the prefix
347 and cdr is used in `company-minimum-prefix-length' test. It must be either
348 number or t, and in the latter case the test automatically succeeds.
350 `candidates': The second argument is the prefix to be completed. The
351 return value should be a list of candidates that match the prefix.
353 Non-prefix matches are also supported (candidates that don't start with the
354 prefix, but match it in some backend-defined way). Backends that use this
355 feature must disable cache (return t to `no-cache') and might also want to
360 `sorted': Return t here to indicate that the candidates are sorted and will
361 not need to be sorted again.
363 `duplicates': If non-nil, company will take care of removing duplicates
366 `no-cache': Usually company doesn't ask for candidates again as completion
367 progresses, unless the back-end returns t for this command. The second
368 argument is the latest prefix.
370 `meta': The second argument is a completion candidate. Return a (short)
371 documentation string for it.
373 `doc-buffer': The second argument is a completion candidate. Return a
374 buffer with documentation for it. Preferably use `company-doc-buffer',
376 `location': The second argument is a completion candidate. Return the cons
377 of buffer and buffer location, or of file and line number where the
378 completion candidate was defined.
380 `annotation': The second argument is a completion candidate. Return a
381 string to be displayed inline with the candidate in the popup. If
382 duplicates are removed by company, candidates with equal string values will
383 be kept if they have different annotations. For that to work properly,
384 backends should store the related information on candidates using text
387 `match': The second argument is a completion candidate. Return the index
388 after the end of text matching `prefix' within the candidate string. It
389 will be used when rendering the popup. This command only makes sense for
390 backends that provide non-prefix completion.
392 `require-match': If this returns t, the user is not allowed to enter
393 anything not offered as a candidate. Use with care! The default value nil
394 gives the user that choice with `company-require-match'. Return value
395 `never' overrides that option the other way around.
397 `init': Called once for each buffer. The back-end can check for external
398 programs and files and load any required libraries. Raising an error here
399 will show up in message log once, and the back-end will not be used for
402 `post-completion': Called after a completion candidate has been inserted
403 into the buffer. The second argument is the candidate. Can be used to
404 modify it, e.g. to expand a snippet.
406 The back-end should return nil for all commands it does not support or
407 does not know about. It should also be callable interactively and use
408 `company-begin-backend' to start itself in that case.
412 An element of `company-backends' can also itself be a list of back-ends,
413 then it's considered to be a \"grouped\" back-end.
415 When possible, commands taking a candidate as an argument are dispatched to
416 the back-end it came from. In other cases, the first non-nil value among
417 all the back-ends is returned.
419 The latter is the case for the `prefix' command. But if the group contains
420 the keyword `:with', the back-ends after it are ignored for this command.
422 The completions from back-ends in a group are merged (but only from those
423 that return the same `prefix').
425 Asynchronous back-ends:
427 The return value of each command can also be a cons (:async . FETCHER)
428 where FETCHER is a function of one argument, CALLBACK. When the data
429 arrives, FETCHER must call CALLBACK and pass it the appropriate return
430 value, as described above.
432 True asynchronous operation is only supported for command `candidates', and
433 only during idle completion. Other commands will block the user interface,
434 even if the back-end uses the asynchronous calling convention."
438 ,@(mapcar (lambda (b) `(const :tag ,(cdr b) ,(car b)))
439 company-safe-backends)
440 (symbol :tag "User defined")
441 (repeat :tag "Merged Back-ends"
442 (choice :tag "Back-end"
443 ,@(mapcar (lambda (b)
444 `(const :tag ,(cdr b) ,(car b)))
445 company-safe-backends)
446 (const :tag "With" :with)
447 (symbol :tag "User defined"))))))
449 (put 'company-backends 'safe-local-variable 'company-safe-backends-p)
451 (defcustom company-transformers nil
452 "Functions to change the list of candidates received from backends.
454 Each function gets called with the return value of the previous one.
455 The first one gets passed the list of candidates, already sorted and
458 (const :tag "None" nil)
459 (const :tag "Sort by occurrence" (company-sort-by-occurrence))
460 (const :tag "Sort by back-end importance"
461 (company-sort-by-backend-importance))
462 (repeat :tag "User defined" (function))))
464 (defcustom company-completion-started-hook nil
465 "Hook run when company starts completing.
466 The hook is called with one argument that is non-nil if the completion was
470 (defcustom company-completion-cancelled-hook nil
471 "Hook run when company cancels completing.
472 The hook is called with one argument that is non-nil if the completion was
476 (defcustom company-completion-finished-hook nil
477 "Hook run when company successfully completes.
478 The hook is called with the selected candidate as an argument.
480 If you indend to use it to post-process candidates from a specific
481 back-end, consider using the `post-completion' command instead."
484 (defcustom company-minimum-prefix-length 3
485 "The minimum prefix length for idle completion."
486 :type '(integer :tag "prefix length"))
488 (defcustom company-abort-manual-when-too-short nil
489 "If enabled, cancel a manually started completion when the prefix gets
490 shorter than both `company-minimum-prefix-length' and the length of the
491 prefix it was started from."
493 :package-version '(company . "0.8.0"))
495 (defcustom company-require-match 'company-explicit-action-p
496 "If enabled, disallow non-matching input.
497 This can be a function do determine if a match is required.
499 This can be overridden by the back-end, if it returns t or `never' to
500 `require-match'. `company-auto-complete' also takes precedence over this."
501 :type '(choice (const :tag "Off" nil)
502 (function :tag "Predicate function")
503 (const :tag "On, if user interaction took place"
504 'company-explicit-action-p)
505 (const :tag "On" t)))
507 (defcustom company-auto-complete nil
508 "Determines when to auto-complete.
509 If this is enabled, all characters from `company-auto-complete-chars'
510 trigger insertion of the selected completion candidate.
511 This can also be a function."
512 :type '(choice (const :tag "Off" nil)
513 (function :tag "Predicate function")
514 (const :tag "On, if user interaction took place"
515 'company-explicit-action-p)
516 (const :tag "On" t)))
518 (defcustom company-auto-complete-chars '(?\ ?\) ?.)
519 "Determines which characters trigger auto-completion.
520 See `company-auto-complete'. If this is a string, each string character
521 tiggers auto-completion. If it is a list of syntax description characters (see
522 `modify-syntax-entry'), all characters with that syntax auto-complete.
524 This can also be a function, which is called with the new input and should
525 return non-nil if company should auto-complete.
527 A character that is part of a valid candidate never triggers auto-completion."
528 :type '(choice (string :tag "Characters")
530 (const :tag "Whitespace" ?\ )
531 (const :tag "Symbol" ?_)
532 (const :tag "Opening parentheses" ?\()
533 (const :tag "Closing parentheses" ?\))
534 (const :tag "Word constituent" ?w)
535 (const :tag "Punctuation." ?.)
536 (const :tag "String quote." ?\")
537 (const :tag "Paired delimiter." ?$)
538 (const :tag "Expression quote or prefix operator." ?\')
539 (const :tag "Comment starter." ?<)
540 (const :tag "Comment ender." ?>)
541 (const :tag "Character-quote." ?/)
542 (const :tag "Generic string fence." ?|)
543 (const :tag "Generic comment fence." ?!))
544 (function :tag "Predicate function")))
546 (defcustom company-idle-delay .5
547 "The idle delay in seconds until completion starts automatically.
548 The prefix still has to satisfy `company-minimum-prefix-length' before that
549 happens. The value of nil means no idle completion."
550 :type '(choice (const :tag "never (nil)" nil)
551 (const :tag "immediate (0)" 0)
552 (number :tag "seconds")))
554 (defcustom company-begin-commands '(self-insert-command
555 org-self-insert-command
556 orgtbl-self-insert-command
561 "A list of commands after which idle completion is allowed.
562 If this is t, it can show completions after any command except a few from a
563 pre-defined list. See `company-idle-delay'.
565 Alternatively, any command with a non-nil `company-begin' property is
566 treated as if it was on this list."
567 :type '(choice (const :tag "Any command" t)
568 (const :tag "Self insert command" '(self-insert-command))
569 (repeat :tag "Commands" function))
570 :package-version '(company . "0.8.4"))
572 (defcustom company-continue-commands '(not save-buffer save-some-buffers
573 save-buffers-kill-terminal
574 save-buffers-kill-emacs)
575 "A list of commands that are allowed during completion.
576 If this is t, or if `company-begin-commands' is t, any command is allowed.
577 Otherwise, the value must be a list of symbols. If it starts with `not',
578 the cdr is the list of commands that abort completion. Otherwise, all
579 commands except those in that list, or in `company-begin-commands', or
580 commands in the `company-' namespace, abort completion."
581 :type '(choice (const :tag "Any command" t)
582 (cons :tag "Any except"
584 (repeat :tag "Commands" function))
585 (repeat :tag "Commands" function)))
587 (defcustom company-show-numbers nil
588 "If enabled, show quick-access numbers for the first ten candidates."
589 :type '(choice (const :tag "off" nil)
590 (const :tag "on" t)))
592 (defcustom company-selection-wrap-around nil
593 "If enabled, selecting item before first or after last wraps around."
594 :type '(choice (const :tag "off" nil)
595 (const :tag "on" t)))
597 (defvar company-async-wait 0.03
598 "Pause between checks to see if the value's been set when turning an
599 asynchronous call into synchronous.")
601 (defvar company-async-timeout 2
602 "Maximum wait time for a value to be set during asynchronous call.")
604 ;;; mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
606 (defvar company-mode-map (make-sparse-keymap)
607 "Keymap used by `company-mode'.")
609 (defvar company-active-map
610 (let ((keymap (make-sparse-keymap)))
611 (define-key keymap "\e\e\e" 'company-abort)
612 (define-key keymap "\C-g" 'company-abort)
613 (define-key keymap (kbd "M-n") 'company-select-next)
614 (define-key keymap (kbd "M-p") 'company-select-previous)
615 (define-key keymap (kbd "<down>") 'company-select-next-or-abort)
616 (define-key keymap (kbd "<up>") 'company-select-previous-or-abort)
617 (define-key keymap [remap scroll-up-command] 'company-next-page)
618 (define-key keymap [remap scroll-down-command] 'company-previous-page)
619 (define-key keymap [down-mouse-1] 'ignore)
620 (define-key keymap [down-mouse-3] 'ignore)
621 (define-key keymap [mouse-1] 'company-complete-mouse)
622 (define-key keymap [mouse-3] 'company-select-mouse)
623 (define-key keymap [up-mouse-1] 'ignore)
624 (define-key keymap [up-mouse-3] 'ignore)
625 (define-key keymap [return] 'company-complete-selection)
626 (define-key keymap (kbd "RET") 'company-complete-selection)
627 (define-key keymap [tab] 'company-complete-common)
628 (define-key keymap (kbd "TAB") 'company-complete-common)
629 (define-key keymap (kbd "<f1>") 'company-show-doc-buffer)
630 (define-key keymap (kbd "C-h") 'company-show-doc-buffer)
631 (define-key keymap "\C-w" 'company-show-location)
632 (define-key keymap "\C-s" 'company-search-candidates)
633 (define-key keymap "\C-\M-s" 'company-filter-candidates)
635 (define-key keymap (read-kbd-macro (format "M-%d" i)) 'company-complete-number))
637 "Keymap that is enabled during an active completion.")
639 (defvar company--disabled-backends nil)
641 (defun company-init-backend (backend)
642 (and (symbolp backend)
643 (not (fboundp backend))
644 (ignore-errors (require backend nil t)))
649 (funcall backend 'init)
650 (put backend 'company-init t))
652 (put backend 'company-init 'failed)
653 (unless (memq backend company--disabled-backends)
654 (message "Company back-end '%s' could not be initialized:\n%s"
655 backend (error-message-string err)))
656 (cl-pushnew backend company--disabled-backends)
658 ;; No initialization for lambdas.
659 ((functionp backend) t)
660 (t ;; Must be a list.
661 (cl-dolist (b backend)
663 (company-init-backend b))))))
665 (defcustom company-lighter-base "company"
666 "Base string to use for the `company-mode' lighter."
668 :package-version '(company . "0.8.10"))
670 (defvar company-lighter '(" "
673 (if (consp company-backend)
674 (company--group-lighter (nth company-selection
676 company-lighter-base)
677 (symbol-name company-backend)))
678 company-lighter-base))
679 "Mode line lighter for Company.
681 The value of this variable is a mode line template as in
682 `mode-line-format'.")
684 (put 'company-lighter 'risky-local-variable t)
687 (define-minor-mode company-mode
688 "\"complete anything\"; is an in-buffer completion framework.
689 Completion starts automatically, depending on the values
690 `company-idle-delay' and `company-minimum-prefix-length'.
692 Completion can be controlled with the commands:
693 `company-complete-common', `company-complete-selection', `company-complete',
694 `company-select-next', `company-select-previous'. If these commands are
695 called before `company-idle-delay', completion will also start.
697 Completions can be searched with `company-search-candidates' or
698 `company-filter-candidates'. These can be used while completion is
701 The completion data is retrieved using `company-backends' and displayed
702 using `company-frontends'. If you want to start a specific back-end, call
703 it interactively or use `company-begin-backend'.
705 regular keymap (`company-mode-map'):
708 keymap during active completions (`company-active-map'):
710 \\{company-active-map}"
711 nil company-lighter company-mode-map
714 (when (eq company-idle-delay t)
715 (setq company-idle-delay 0)
716 (warn "Setting `company-idle-delay' to t is deprecated. Set it to 0 instead."))
717 (add-hook 'pre-command-hook 'company-pre-command nil t)
718 (add-hook 'post-command-hook 'company-post-command nil t)
719 (mapc 'company-init-backend company-backends))
720 (remove-hook 'pre-command-hook 'company-pre-command t)
721 (remove-hook 'post-command-hook 'company-post-command t)
723 (kill-local-variable 'company-point)))
725 (defcustom company-global-modes t
726 "Modes for which `company-mode' mode is turned on by `global-company-mode'.
727 If nil, means no modes. If t, then all major modes have it turned on.
728 If a list, it should be a list of `major-mode' symbol names for which
729 `company-mode' should be automatically turned on. The sense of the list is
730 negated if it begins with `not'. For example:
732 means that `company-mode' is turned on for buffers in C and C++ modes only.
734 means that `company-mode' is always turned on except in `message-mode' buffers."
735 :type '(choice (const :tag "none" nil)
737 (set :menu-tag "mode specific" :tag "modes"
739 (const :tag "Except" not)
740 (repeat :inline t (symbol :tag "mode")))))
743 (define-globalized-minor-mode global-company-mode company-mode company-mode-on)
745 (defun company-mode-on ()
746 (when (and (not (or noninteractive (eq (aref (buffer-name) 0) ?\s)))
747 (cond ((eq company-global-modes t)
749 ((eq (car-safe company-global-modes) 'not)
750 (not (memq major-mode (cdr company-global-modes))))
751 (t (memq major-mode company-global-modes))))
754 (defsubst company-assert-enabled ()
756 (company-uninstall-map)
757 (error "Company not enabled")))
759 ;;; keymaps ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
761 (defvar-local company-my-keymap nil)
763 (defvar company-emulation-alist '((t . nil)))
765 (defsubst company-enable-overriding-keymap (keymap)
766 (company-uninstall-map)
767 (setq company-my-keymap keymap))
769 (defun company-ensure-emulation-alist ()
770 (unless (eq 'company-emulation-alist (car emulation-mode-map-alists))
771 (setq emulation-mode-map-alists
772 (cons 'company-emulation-alist
773 (delq 'company-emulation-alist emulation-mode-map-alists)))))
775 (defun company-install-map ()
776 (unless (or (cdar company-emulation-alist)
777 (null company-my-keymap))
778 (setf (cdar company-emulation-alist) company-my-keymap)))
780 (defun company-uninstall-map ()
781 (setf (cdar company-emulation-alist) nil))
784 ;; Emacs calculates the active keymaps before reading the event. That means we
785 ;; cannot change the keymap from a timer. So we send a bogus command.
786 ;; XXX: Even in Emacs 24.4, seems to be needed in the terminal.
787 (defun company-ignore ()
789 (setq this-command last-command))
791 (global-set-key '[company-dummy-event] 'company-ignore)
793 (defun company-input-noop ()
794 (push 'company-dummy-event unread-command-events))
796 (defun company--posn-col-row (posn)
797 (let ((col (car (posn-col-row posn)))
798 ;; `posn-col-row' doesn't work well with lines of different height.
799 ;; `posn-actual-col-row' doesn't handle multiple-width characters.
800 (row (cdr (posn-actual-col-row posn))))
801 (when (and header-line-format (version< emacs-version "24.3.93.3"))
802 ;; http://debbugs.gnu.org/18384
804 (cons (+ col (window-hscroll)) row)))
806 (defun company--col-row (&optional pos)
807 (company--posn-col-row (posn-at-point pos)))
809 (defun company--row (&optional pos)
810 (cdr (company--col-row pos)))
812 ;;; backends ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
814 (defvar-local company-backend nil)
816 (defun company-grab (regexp &optional expression limit)
817 (when (looking-back regexp limit)
818 (or (match-string-no-properties (or expression 0)) "")))
820 (defun company-grab-line (regexp &optional expression)
821 (company-grab regexp expression (point-at-bol)))
823 (defun company-grab-symbol ()
824 (if (looking-at "\\_>")
825 (buffer-substring (point) (save-excursion (skip-syntax-backward "w_")
827 (unless (and (char-after) (memq (char-syntax (char-after)) '(?w ?_)))
830 (defun company-grab-word ()
831 (if (looking-at "\\>")
832 (buffer-substring (point) (save-excursion (skip-syntax-backward "w")
834 (unless (and (char-after) (eq (char-syntax (char-after)) ?w))
837 (defun company-grab-symbol-cons (idle-begin-after-re &optional max-len)
838 (let ((symbol (company-grab-symbol)))
841 (forward-char (- (length symbol)))
842 (if (looking-back idle-begin-after-re (if max-len
844 (line-beginning-position)))
848 (defun company-in-string-or-comment ()
849 (let ((ppss (syntax-ppss)))
850 (or (car (setq ppss (nthcdr 3 ppss)))
851 (car (setq ppss (cdr ppss)))
854 (defun company-call-backend (&rest args)
855 (company--force-sync #'company-call-backend-raw args company-backend))
857 (defun company--force-sync (fun args backend)
858 (let ((value (apply fun args)))
859 (if (not (eq (car-safe value) :async))
862 (start (time-to-seconds)))
864 (lambda (result) (setq res result)))
865 (while (eq res 'trash)
866 (if (> (- (time-to-seconds) start) company-async-timeout)
867 (error "Company: Back-end %s async timeout with args %s"
869 (sleep-for company-async-wait)))
872 (defun company-call-backend-raw (&rest args)
873 (condition-case-unless-debug err
874 (if (functionp company-backend)
875 (apply company-backend args)
876 (apply #'company--multi-backend-adapter company-backend args))
877 (error (error "Company: Back-end %s error \"%s\" with args %s"
878 company-backend (error-message-string err) args))))
880 (defun company--multi-backend-adapter (backends command &rest args)
881 (let ((backends (cl-loop for b in backends
882 when (not (and (symbolp b)
883 (eq 'failed (get b 'company-init))))
886 (if (eq command 'prefix)
887 (butlast backends (length (member :with backends)))
888 (delq :with backends)))
891 (company--multi-backend-adapter-candidates backends (car args)))
894 ((or `prefix `ignore-case `no-cache `require-match)
896 (cl-dolist (backend backends)
897 (when (setq value (company--force-sync
898 backend (cons command args) backend))
899 (cl-return value)))))
901 (let ((arg (car args)))
902 (when (> (length arg) 0)
903 (let ((backend (or (get-text-property 0 'company-backend arg)
905 (apply backend command args))))))))
907 (defun company--multi-backend-adapter-candidates (backends prefix)
908 (let ((pairs (cl-loop for backend in (cdr backends)
909 when (equal (company--prefix-str
910 (funcall backend 'prefix))
912 collect (cons (funcall backend 'candidates prefix)
917 (propertize str 'company-backend b))
919 (when (equal (company--prefix-str (funcall (car backends) 'prefix)) prefix)
920 ;; Small perf optimization: don't tag the candidates received
921 ;; from the first backend in the group.
922 (push (cons (funcall (car backends) 'candidates prefix)
925 (company--merge-async pairs (lambda (values) (apply #'append values)))))
927 (defun company--merge-async (pairs merger)
928 (let ((async (cl-loop for pair in pairs
930 (eq :async (car-safe (car pair))))))
932 (funcall merger (cl-loop for (val . mapper) in pairs
933 collect (funcall mapper val)))
938 (pending (mapcar #'car pairs))
949 (this-finisher (lambda (res)
950 (setq pending (delq val pending))
951 (setcar cell (funcall mapper res))
952 (funcall finisher))))
953 (if (not (eq :async (car-safe val)))
954 (funcall this-finisher val)
955 (let ((fetcher (cdr val)))
956 (funcall fetcher this-finisher)))))))))))
958 (defun company--prefix-str (prefix)
959 (or (car-safe prefix) prefix))
961 ;;; completion mechanism ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
963 (defvar-local company-prefix nil)
965 (defvar-local company-candidates nil)
967 (defvar-local company-candidates-length nil)
969 (defvar-local company-candidates-cache nil)
971 (defvar-local company-candidates-predicate nil)
973 (defvar-local company-common nil)
975 (defvar-local company-selection 0)
977 (defvar-local company-selection-changed nil)
979 (defvar-local company--manual-action nil
980 "Non-nil, if manual completion took place.")
982 (defvar-local company--manual-prefix nil)
984 (defvar company--auto-completion nil
985 "Non-nil when current candidate is being inserted automatically.
986 Controlled by `company-auto-complete'.")
988 (defvar-local company--point-max nil)
990 (defvar-local company-point nil)
992 (defvar company-timer nil)
994 (defsubst company-strip-prefix (str)
995 (substring str (length company-prefix)))
997 (defun company--insert-candidate (candidate)
998 (setq candidate (substring-no-properties candidate))
999 ;; XXX: Return value we check here is subject to change.
1000 (if (eq (company-call-backend 'ignore-case) 'keep-prefix)
1001 (insert (company-strip-prefix candidate))
1002 (unless (equal company-prefix candidate)
1003 (delete-region (- (point) (length company-prefix)) (point))
1004 (insert candidate))))
1006 (defmacro company-with-candidate-inserted (candidate &rest body)
1007 "Evaluate BODY with CANDIDATE temporarily inserted.
1008 This is a tool for back-ends that need candidates inserted before they
1009 can retrieve meta-data for them."
1010 (declare (indent 1))
1011 `(let ((inhibit-modification-hooks t)
1012 (inhibit-point-motion-hooks t)
1013 (modified-p (buffer-modified-p)))
1014 (company--insert-candidate ,candidate)
1017 (delete-region company-point (point))
1018 (set-buffer-modified-p modified-p))))
1020 (defun company-explicit-action-p ()
1021 "Return whether explicit completion action was taken by the user."
1022 (or company--manual-action
1023 company-selection-changed))
1025 (defun company-reformat (candidate)
1026 ;; company-ispell needs this, because the results are always lower-case
1027 ;; It's mory efficient to fix it only when they are displayed.
1028 ;; FIXME: Adopt the current text's capitalization instead?
1029 (if (eq (company-call-backend 'ignore-case) 'keep-prefix)
1030 (concat company-prefix (substring candidate (length company-prefix)))
1033 (defun company--should-complete ()
1034 (and (eq company-idle-delay 'now)
1035 (not (or buffer-read-only overriding-terminal-local-map
1036 overriding-local-map))
1037 ;; Check if in the middle of entering a key combination.
1038 (or (equal (this-command-keys-vector) [])
1039 (not (keymapp (key-binding (this-command-keys-vector)))))
1040 (not (and transient-mark-mode mark-active))))
1042 (defun company--should-continue ()
1043 (or (eq t company-begin-commands)
1044 (eq t company-continue-commands)
1045 (if (eq 'not (car company-continue-commands))
1046 (not (memq this-command (cdr company-continue-commands)))
1047 (or (memq this-command company-begin-commands)
1048 (memq this-command company-continue-commands)
1049 (and (symbolp this-command)
1050 (string-match-p "\\`company-" (symbol-name this-command)))))))
1052 (defun company-call-frontends (command)
1053 (dolist (frontend company-frontends)
1054 (condition-case-unless-debug err
1055 (funcall frontend command)
1056 (error (error "Company: Front-end %s error \"%s\" on command %s"
1057 frontend (error-message-string err) command)))))
1059 (defun company-set-selection (selection &optional force-update)
1061 (if company-selection-wrap-around
1062 (mod selection company-candidates-length)
1063 (max 0 (min (1- company-candidates-length) selection))))
1064 (when (or force-update (not (equal selection company-selection)))
1065 (setq company-selection selection
1066 company-selection-changed t)
1067 (company-call-frontends 'update)))
1069 (defun company--group-lighter (candidate base)
1070 (let ((backend (or (get-text-property 0 'company-backend candidate)
1071 (car company-backend))))
1072 (when (and backend (symbolp backend))
1073 (let ((name (replace-regexp-in-string "company-\\|-company" ""
1074 (symbol-name backend))))
1075 (format "%s-<%s>" base name)))))
1077 (defun company-update-candidates (candidates)
1078 (setq company-candidates-length (length candidates))
1079 (if company-selection-changed
1080 ;; Try to restore the selection
1081 (let ((selected (nth company-selection company-candidates)))
1082 (setq company-selection 0
1083 company-candidates candidates)
1087 (let ((candidate (pop candidates)))
1088 (when (and (string= candidate selected)
1089 (equal (company-call-backend 'annotation candidate)
1090 (company-call-backend 'annotation selected)))
1092 (cl-incf company-selection))
1093 (setq company-selection 0
1094 company-selection-changed nil))))
1095 (setq company-selection 0
1096 company-candidates candidates))
1097 ;; Calculate common.
1098 (let ((completion-ignore-case (company-call-backend 'ignore-case)))
1099 ;; We want to support non-prefix completion, so filtering is the
1100 ;; responsibility of each respective backend, not ours.
1101 ;; On the other hand, we don't want to replace non-prefix input in
1102 ;; `company-complete-common', unless there's only one candidate.
1103 (setq company-common
1104 (if (cdr company-candidates)
1105 (let ((common (try-completion "" company-candidates)))
1106 (when (string-prefix-p company-prefix common
1107 completion-ignore-case)
1109 (car company-candidates)))))
1111 (defun company-calculate-candidates (prefix)
1112 (let ((candidates (cdr (assoc prefix company-candidates-cache)))
1113 (ignore-case (company-call-backend 'ignore-case)))
1115 (when company-candidates-cache
1116 (let ((len (length prefix))
1117 (completion-ignore-case ignore-case)
1119 (cl-dotimes (i (1+ len))
1120 (when (setq prev (cdr (assoc (substring prefix 0 (- len i))
1121 company-candidates-cache)))
1122 (setq candidates (all-completions prefix prev))
1125 ;; No cache match, call the backend.
1126 (setq candidates (company--preprocess-candidates
1127 (company--fetch-candidates prefix)))
1129 (push (cons prefix candidates) company-candidates-cache)))
1130 ;; Only now apply the predicate and transformers.
1131 (setq candidates (company--postprocess-candidates candidates))
1133 (if (or (cdr candidates)
1134 (not (eq t (compare-strings (car candidates) nil nil
1135 prefix nil nil ignore-case))))
1137 ;; Already completed and unique; don't start.
1140 (defun company--fetch-candidates (prefix)
1141 (let ((c (if company--manual-action
1142 (company-call-backend 'candidates prefix)
1143 (company-call-backend-raw 'candidates prefix)))
1145 (if (not (eq (car c) :async))
1147 (let ((buf (current-buffer))
1148 (win (selected-window))
1149 (tick (buffer-chars-modified-tick))
1151 (backend company-backend))
1154 (lambda (candidates)
1155 (if (not (and candidates (eq res 'done)))
1156 ;; There's no completions to display,
1157 ;; or the fetcher called us back right away.
1158 (setq res candidates)
1159 (setq company-backend backend
1160 company-candidates-cache
1162 (company--preprocess-candidates candidates))))
1163 (company-idle-begin buf win tick pt)))))
1164 ;; FIXME: Relying on the fact that the callers
1165 ;; will interpret nil as "do nothing" is shaky.
1166 ;; A throw-catch would be one possible improvement.
1168 (progn (setq res 'done) nil)))))
1170 (defun company--preprocess-candidates (candidates)
1171 (unless (company-call-backend 'sorted)
1172 (setq candidates (sort candidates 'string<)))
1173 (when (company-call-backend 'duplicates)
1174 (company--strip-duplicates candidates))
1177 (defun company--postprocess-candidates (candidates)
1178 (when (or company-candidates-predicate company-transformers)
1179 (setq candidates (copy-sequence candidates)))
1180 (when company-candidates-predicate
1181 (setq candidates (cl-delete-if-not company-candidates-predicate candidates)))
1182 (company--transform-candidates candidates))
1184 (defun company--strip-duplicates (candidates)
1185 (let ((c2 candidates)
1189 (let ((str (pop c2)))
1190 (while (let ((str2 (car c2)))
1191 (if (not (equal str str2))
1195 (when (eq annos 'unk)
1196 (setq annos (list (company-call-backend
1198 (let ((anno2 (company-call-backend
1200 (if (member anno2 annos)
1207 (defun company--transform-candidates (candidates)
1208 (let ((c candidates))
1209 (dolist (tr company-transformers)
1210 (setq c (funcall tr c)))
1213 (defcustom company-occurrence-weight-function
1214 #'company-occurrence-prefer-closest-above
1215 "Function to weigh matches in `company-sort-by-occurrence'.
1216 It's called with three arguments: cursor position, the beginning and the
1219 (const :tag "First above point, then below point"
1220 company-occurrence-prefer-closest-above)
1221 (const :tag "Prefer closest in any direction"
1222 company-occurrence-prefer-any-closest)))
1224 (defun company-occurrence-prefer-closest-above (pos match-beg match-end)
1225 "Give priority to the matches above point, then those below point."
1226 (if (< match-beg pos)
1228 (- match-beg (window-start))))
1230 (defun company-occurrence-prefer-any-closest (pos _match-beg match-end)
1231 "Give priority to the matches closest to the point."
1232 (abs (- pos match-end)))
1234 (defun company-sort-by-occurrence (candidates)
1235 "Sort CANDIDATES according to their occurrences.
1236 Searches for each in the currently visible part of the current buffer and
1237 prioritizes the matches according to `company-occurrence-weight-function'.
1238 The rest of the list is appended unchanged.
1239 Keywords and function definition names are ignored."
1240 (let* ((w-start (window-start))
1241 (w-end (window-end))
1242 (start-point (point))
1250 (while (search-forward candidate w-end t)
1251 (when (and (not (eq (point) start-point))
1253 (company--occurrence-predicate)))
1257 (funcall company-occurrence-weight-function
1265 (mapcar #'car (sort occurs (lambda (e1 e2) (<= (cdr e1) (cdr e2)))))
1268 (defun company--occurrence-predicate ()
1269 (let ((beg (match-beginning 0))
1270 (end (match-end 0)))
1273 (and (not (memq (get-text-property (1- (point)) 'face)
1274 '(font-lock-function-name-face
1275 font-lock-keyword-face)))
1276 (let ((prefix (company--prefix-str
1277 (company-call-backend 'prefix))))
1278 (and (stringp prefix)
1279 (= (length prefix) (- end beg))))))))
1281 (defun company-sort-by-backend-importance (candidates)
1282 "Sort CANDIDATES as two priority groups.
1283 If `company-backend' is a function, do nothing. If it's a list, move
1284 candidates from back-ends before keyword `:with' to the front. Candidates
1285 from the rest of the back-ends in the group, if any, will be left at the end."
1286 (if (functionp company-backend)
1288 (let ((low-priority (cdr (memq :with company-backend))))
1289 (if (null low-priority)
1294 (let ((b2 (get-text-property 0 'company-backend c2)))
1295 (and b2 (memq b2 low-priority)))
1296 (let ((b1 (get-text-property 0 'company-backend c1)))
1297 (or (not b1) (not (memq b1 low-priority)))))))))))
1299 (defun company-idle-begin (buf win tick pos)
1300 (and (eq buf (current-buffer))
1301 (eq win (selected-window))
1302 (eq tick (buffer-chars-modified-tick))
1304 (when (company-auto-begin)
1305 (company-input-noop)
1306 (let ((this-command 'company-idle-begin))
1307 (company-post-command)))))
1309 (defun company-auto-begin ()
1311 (not company-candidates)
1312 (let ((company-idle-delay 'now))
1313 (condition-case-unless-debug err
1316 ;; Return non-nil if active.
1318 (error (message "Company: An error occurred in auto-begin")
1319 (message "%s" (error-message-string err))
1321 (quit (company-cancel))))))
1323 (defun company-manual-begin ()
1325 (company-assert-enabled)
1326 (setq company--manual-action t)
1328 (let ((company-minimum-prefix-length 0))
1329 (or company-candidates
1330 (company-auto-begin)))
1331 (unless company-candidates
1332 (setq company--manual-action nil))))
1334 (defun company-other-backend (&optional backward)
1335 (interactive (list current-prefix-arg))
1336 (company-assert-enabled)
1337 (let* ((after (if company-backend
1338 (cdr (member company-backend company-backends))
1340 (before (cdr (member company-backend (reverse company-backends))))
1342 (append before (reverse after))
1343 (append after (reverse before)))))
1345 (cl-dolist (backend next)
1346 (when (ignore-errors (company-begin-backend backend))
1348 (unless company-candidates
1349 (error "No other back-end")))
1351 (defun company-require-match-p ()
1352 (let ((backend-value (company-call-backend 'require-match)))
1353 (or (eq backend-value t)
1354 (and (not (eq backend-value 'never))
1355 (if (functionp company-require-match)
1356 (funcall company-require-match)
1357 (eq company-require-match t))))))
1359 (defun company-auto-complete-p (input)
1360 "Return non-nil, if input starts with punctuation or parentheses."
1361 (and (if (functionp company-auto-complete)
1362 (funcall company-auto-complete)
1363 company-auto-complete)
1364 (if (functionp company-auto-complete-chars)
1365 (funcall company-auto-complete-chars input)
1366 (if (consp company-auto-complete-chars)
1367 (memq (char-syntax (string-to-char input))
1368 company-auto-complete-chars)
1369 (string-match (substring input 0 1) company-auto-complete-chars)))))
1371 (defun company--incremental-p ()
1372 (and (> (point) company-point)
1373 (> (point-max) company--point-max)
1374 (not (eq this-command 'backward-delete-char-untabify))
1375 (equal (buffer-substring (- company-point (length company-prefix))
1379 (defun company--continue-failed (new-prefix)
1380 (let ((input (buffer-substring-no-properties (point) company-point)))
1382 ((company-auto-complete-p input)
1385 (goto-char company-point)
1386 (let ((company--auto-completion t))
1387 (company-complete-selection))
1389 ((and (or (not (company-require-match-p))
1390 ;; Don't require match if the new prefix
1391 ;; doesn't continue the old one, and the latter was a match.
1392 (not (stringp new-prefix))
1393 (<= (length new-prefix) (length company-prefix)))
1394 (member company-prefix company-candidates))
1395 ;; Last input was a success,
1396 ;; but we're treating it as an abort + input anyway,
1397 ;; like the `unique' case below.
1398 (company-cancel 'non-unique))
1399 ((company-require-match-p)
1400 ;; Wrong incremental input, but required match.
1401 (delete-char (- (length input)))
1403 (message "Matching input is required")
1405 (t (company-cancel)))))
1407 (defun company--good-prefix-p (prefix)
1408 (and (stringp (company--prefix-str prefix)) ;excludes 'stop
1409 (or (eq (cdr-safe prefix) t)
1410 (let ((len (or (cdr-safe prefix) (length prefix))))
1411 (if company--manual-prefix
1412 (or (not company-abort-manual-when-too-short)
1413 ;; Must not be less than minimum or initial length.
1414 (>= len (min company-minimum-prefix-length
1415 (length company--manual-prefix))))
1416 (>= len company-minimum-prefix-length))))))
1418 (defun company--continue ()
1419 (when (company-call-backend 'no-cache company-prefix)
1420 ;; Don't complete existing candidates, fetch new ones.
1421 (setq company-candidates-cache nil))
1422 (let* ((new-prefix (company-call-backend 'prefix))
1423 (c (when (and (company--good-prefix-p new-prefix)
1424 (setq new-prefix (company--prefix-str new-prefix))
1425 (= (- (point) (length new-prefix))
1426 (- company-point (length company-prefix))))
1427 (company-calculate-candidates new-prefix))))
1430 ;; t means complete/unique.
1431 ;; Handle it like completion was aborted, to differentiate from user
1432 ;; calling one of Company's commands to insert the candidate,
1433 ;; not to trigger template expansion, etc.
1434 (company-cancel 'unique))
1436 ;; incremental match
1437 (setq company-prefix new-prefix)
1438 (company-update-candidates c)
1440 ((not (company--incremental-p))
1442 (t (company--continue-failed new-prefix)))))
1444 (defun company--begin-new ()
1446 (cl-dolist (backend (if company-backend
1447 ;; prefer manual override
1448 (list company-backend)
1451 (if (or (symbolp backend)
1452 (functionp backend))
1453 (when (or (not (symbolp backend))
1454 (eq t (get backend 'company-init))
1455 (unless (get backend 'company-init)
1456 (company-init-backend backend)))
1457 (funcall backend 'prefix))
1458 (company--multi-backend-adapter backend 'prefix)))
1460 (when (company--good-prefix-p prefix)
1461 (setq company-prefix (company--prefix-str prefix)
1462 company-backend backend
1463 c (company-calculate-candidates company-prefix))
1464 ;; t means complete/unique. We don't start, so no hooks.
1466 (when company--manual-action
1467 (message "No completion found"))
1468 (when company--manual-action
1469 (setq company--manual-prefix prefix))
1470 (company-update-candidates c)
1471 (run-hook-with-args 'company-completion-started-hook
1472 (company-explicit-action-p))
1473 (company-call-frontends 'show)))
1476 (defun company--perform ()
1477 (or (and company-candidates (company--continue))
1478 (and (company--should-complete) (company--begin-new)))
1479 (if (not company-candidates)
1480 (setq company-backend nil)
1481 (setq company-point (point)
1482 company--point-max (point-max))
1483 (company-ensure-emulation-alist)
1484 (company-enable-overriding-keymap company-active-map)
1485 (company-call-frontends 'update)))
1487 (defun company-cancel (&optional result)
1489 (when company-prefix
1490 (if (stringp result)
1492 (company-call-backend 'pre-completion result)
1493 (run-hook-with-args 'company-completion-finished-hook result)
1494 (company-call-backend 'post-completion result))
1495 (run-hook-with-args 'company-completion-cancelled-hook result)))
1496 (setq company-backend nil
1498 company-candidates nil
1499 company-candidates-length nil
1500 company-candidates-cache nil
1501 company-candidates-predicate nil
1504 company-selection-changed nil
1505 company--manual-action nil
1506 company--manual-prefix nil
1507 company--point-max nil
1510 (cancel-timer company-timer))
1511 (company-search-mode 0)
1512 (company-call-frontends 'hide)
1513 (company-enable-overriding-keymap nil))
1514 ;; Make return value explicit.
1517 (defun company-abort ()
1519 (company-cancel 'abort))
1521 (defun company-finish (result)
1522 (company--insert-candidate result)
1523 (company-cancel result))
1525 (defsubst company-keep (command)
1526 (and (symbolp command) (get command 'company-keep)))
1528 (defun company-pre-command ()
1529 (unless (company-keep this-command)
1530 (condition-case-unless-debug err
1531 (when company-candidates
1532 (company-call-frontends 'pre-command)
1533 (unless (company--should-continue)
1535 (error (message "Company: An error occurred in pre-command")
1536 (message "%s" (error-message-string err))
1539 (cancel-timer company-timer)
1540 (setq company-timer nil))
1541 (company-uninstall-map))
1543 (defun company-post-command ()
1544 (when (null this-command)
1545 ;; Happens when the user presses `C-g' while inside
1546 ;; `flyspell-post-command-hook', for example.
1547 ;; Or any other `post-command-hook' function that can call `sit-for',
1548 ;; or any quittable timer function.
1550 (setq this-command 'company-abort))
1551 (unless (company-keep this-command)
1552 (condition-case-unless-debug err
1554 (unless (equal (point) company-point)
1555 (let (company-idle-delay) ; Against misbehavior while debugging.
1556 (company--perform)))
1557 (if company-candidates
1558 (company-call-frontends 'post-command)
1559 (and (numberp company-idle-delay)
1560 (company--should-begin)
1562 (run-with-timer company-idle-delay nil
1564 (current-buffer) (selected-window)
1565 (buffer-chars-modified-tick) (point))))))
1566 (error (message "Company: An error occurred in post-command")
1567 (message "%s" (error-message-string err))
1569 (company-install-map))
1571 (defvar company--begin-inhibit-commands '(company-abort
1572 company-complete-mouse
1574 company-complete-common
1575 company-complete-selection
1576 company-complete-number)
1577 "List of commands after which idle completion is (still) disabled when
1578 `company-begin-commands' is t.")
1580 (defun company--should-begin ()
1581 (if (eq t company-begin-commands)
1582 (not (memq this-command company--begin-inhibit-commands))
1584 (memq this-command company-begin-commands)
1585 (and (symbolp this-command) (get this-command 'company-begin)))))
1587 ;;; search ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1589 (defvar-local company-search-string "")
1591 (defvar company-search-lighter '(" "
1592 (company-search-filtering "Filter" "Search")
1594 company-search-string
1597 (defvar-local company-search-filtering nil
1598 "Non-nil to filter the completion candidates by the search string")
1600 (defvar-local company--search-old-selection 0)
1602 (defvar-local company--search-old-changed nil)
1604 (defun company--search (text lines)
1605 (let ((quoted (regexp-quote text))
1607 (cl-dolist (line lines)
1608 (when (string-match quoted line (length company-prefix))
1612 (defun company-search-keypad ()
1614 (let* ((name (symbol-name last-command-event))
1615 (last-command-event (aref name (1- (length name)))))
1616 (company-search-printing-char)))
1618 (defun company-search-printing-char ()
1620 (company--search-assert-enabled)
1621 (let ((ss (concat company-search-string (string last-command-event))))
1622 (when company-search-filtering
1623 (company--search-update-predicate ss))
1624 (company--search-update-string ss)))
1626 (defun company--search-update-predicate (&optional ss)
1627 (let* ((company-candidates-predicate
1628 (and (not (string= ss ""))
1629 company-search-filtering
1630 (lambda (candidate) (string-match ss candidate))))
1631 (cc (company-calculate-candidates company-prefix)))
1632 (unless cc (error "No match"))
1633 (company-update-candidates cc)))
1635 (defun company--search-update-string (new)
1636 (let* ((pos (company--search new (nthcdr company-selection company-candidates))))
1639 (setq company-search-string new)
1640 (company-set-selection (+ company-selection pos) t))))
1642 (defun company--search-assert-input ()
1643 (company--search-assert-enabled)
1644 (when (string= company-search-string "")
1645 (error "Empty search string")))
1647 (defun company-search-repeat-forward ()
1648 "Repeat the incremental search in completion candidates forward."
1650 (company--search-assert-input)
1651 (let ((pos (company--search company-search-string
1652 (cdr (nthcdr company-selection
1653 company-candidates)))))
1656 (company-set-selection (+ company-selection pos 1) t))))
1658 (defun company-search-repeat-backward ()
1659 "Repeat the incremental search in completion candidates backwards."
1661 (company--search-assert-input)
1662 (let ((pos (company--search company-search-string
1663 (nthcdr (- company-candidates-length
1665 (reverse company-candidates)))))
1668 (company-set-selection (- company-selection pos 1) t))))
1670 (defun company-search-toggle-filtering ()
1671 "Toggle `company-search-filtering'."
1673 (company--search-assert-enabled)
1674 (setq company-search-filtering (not company-search-filtering))
1675 (let ((ss company-search-string))
1676 (company--search-update-predicate ss)
1677 (company--search-update-string ss)))
1679 (defun company-search-abort ()
1680 "Abort searching the completion candidates."
1682 (company--search-assert-enabled)
1683 (company-search-mode 0)
1684 (company-set-selection company--search-old-selection t)
1685 (setq company-selection-changed company--search-old-changed))
1687 (defun company-search-other-char ()
1689 (company--search-assert-enabled)
1690 (company-search-mode 0)
1691 (company--unread-last-input))
1693 (defun company-search-delete-char ()
1695 (company--search-assert-enabled)
1696 (if (string= company-search-string "")
1698 (let ((ss (substring company-search-string 0 -1)))
1699 (when company-search-filtering
1700 (company--search-update-predicate ss))
1701 (company--search-update-string ss))))
1703 (defvar company-search-map
1705 (keymap (make-keymap)))
1706 (if (fboundp 'max-char)
1707 (set-char-table-range (nth 1 keymap) (cons #x100 (max-char))
1708 'company-search-printing-char)
1710 ;; obsolete in Emacs 23
1711 (let ((l (generic-character-list))
1712 (table (nth 1 keymap)))
1714 (set-char-table-default table (car l) 'company-search-printing-char)
1715 (setq l (cdr l))))))
1716 (define-key keymap [t] 'company-search-other-char)
1718 (define-key keymap (make-string 1 i) 'company-search-other-char)
1721 (define-key keymap (vector i) 'company-search-printing-char)
1724 (define-key keymap (read (format "[kp-%s]" i)) 'company-search-keypad))
1725 (let ((meta-map (make-sparse-keymap)))
1726 (define-key keymap (char-to-string meta-prefix-char) meta-map)
1727 (define-key keymap [escape] meta-map))
1728 (define-key keymap (vector meta-prefix-char t) 'company-search-other-char)
1729 (define-key keymap (kbd "M-n") 'company-select-next)
1730 (define-key keymap (kbd "M-p") 'company-select-previous)
1731 (define-key keymap (kbd "<down>") 'company-select-next-or-abort)
1732 (define-key keymap (kbd "<up>") 'company-select-previous-or-abort)
1733 (define-key keymap "\e\e\e" 'company-search-other-char)
1734 (define-key keymap [escape escape escape] 'company-search-other-char)
1735 (define-key keymap (kbd "DEL") 'company-search-delete-char)
1736 (define-key keymap [backspace] 'company-search-delete-char)
1737 (define-key keymap "\C-g" 'company-search-abort)
1738 (define-key keymap "\C-s" 'company-search-repeat-forward)
1739 (define-key keymap "\C-r" 'company-search-repeat-backward)
1740 (define-key keymap "\C-o" 'company-search-toggle-filtering)
1742 (define-key keymap (read-kbd-macro (format "M-%d" i)) 'company-complete-number))
1744 "Keymap used for incrementally searching the completion candidates.")
1746 (define-minor-mode company-search-mode
1747 "Search mode for completion candidates.
1748 Don't start this directly, use `company-search-candidates' or
1749 `company-filter-candidates'."
1750 nil company-search-lighter nil
1751 (if company-search-mode
1752 (if (company-manual-begin)
1754 (setq company--search-old-selection company-selection
1755 company--search-old-changed company-selection-changed)
1756 (company-call-frontends 'update)
1757 (company-enable-overriding-keymap company-search-map))
1758 (setq company-search-mode nil))
1759 (kill-local-variable 'company-search-string)
1760 (kill-local-variable 'company-search-filtering)
1761 (kill-local-variable 'company--search-old-selection)
1762 (kill-local-variable 'company--search-old-changed)
1763 (when company-backend
1764 (company--search-update-predicate "")
1765 (company-call-frontends 'update))
1766 (company-enable-overriding-keymap company-active-map)))
1768 (defun company--search-assert-enabled ()
1769 (company-assert-enabled)
1770 (unless company-search-mode
1771 (company-uninstall-map)
1772 (error "Company not in search mode")))
1774 (defun company-search-candidates ()
1775 "Start searching the completion candidates incrementally.
1777 \\<company-search-map>Search can be controlled with the commands:
1778 - `company-search-repeat-forward' (\\[company-search-repeat-forward])
1779 - `company-search-repeat-backward' (\\[company-search-repeat-backward])
1780 - `company-search-abort' (\\[company-search-abort])
1781 - `company-search-delete-char' (\\[company-search-delete-char])
1783 Regular characters are appended to the search string.
1785 The command `company-search-toggle-filtering' (\\[company-search-toggle-filtering])
1786 uses the search string to filter the completion candidates."
1788 (company-search-mode 1))
1790 (defvar company-filter-map
1791 (let ((keymap (make-keymap)))
1792 (define-key keymap [remap company-search-printing-char]
1793 'company-filter-printing-char)
1794 (set-keymap-parent keymap company-search-map)
1796 "Keymap used for incrementally searching the completion candidates.")
1798 (defun company-filter-candidates ()
1799 "Start filtering the completion candidates incrementally.
1800 This works the same way as `company-search-candidates' immediately
1801 followed by `company-search-toggle-filtering'."
1803 (company-search-mode 1)
1804 (setq company-search-filtering t))
1806 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1808 (defun company-select-next ()
1809 "Select the next candidate in the list."
1811 (when (company-manual-begin)
1812 (company-set-selection (1+ company-selection))))
1814 (defun company-select-previous ()
1815 "Select the previous candidate in the list."
1817 (when (company-manual-begin)
1818 (company-set-selection (1- company-selection))))
1820 (defun company-select-next-or-abort ()
1821 "Select the next candidate if more than one, else abort
1822 and invoke the normal binding."
1824 (if (> company-candidates-length 1)
1825 (company-select-next)
1827 (company--unread-last-input)))
1829 (defun company-select-previous-or-abort ()
1830 "Select the previous candidate if more than one, else abort
1831 and invoke the normal binding."
1833 (if (> company-candidates-length 1)
1834 (company-select-previous)
1836 (company--unread-last-input)))
1838 (defun company-next-page ()
1839 "Select the candidate one page further."
1841 (when (company-manual-begin)
1842 (company-set-selection (+ company-selection
1843 company-tooltip-limit))))
1845 (defun company-previous-page ()
1846 "Select the candidate one page earlier."
1848 (when (company-manual-begin)
1849 (company-set-selection (- company-selection
1850 company-tooltip-limit))))
1852 (defvar company-pseudo-tooltip-overlay)
1854 (defvar company-tooltip-offset)
1856 (defun company--inside-tooltip-p (event-col-row row height)
1857 (let* ((ovl company-pseudo-tooltip-overlay)
1858 (column (overlay-get ovl 'company-column))
1859 (width (overlay-get ovl 'company-width))
1860 (evt-col (car event-col-row))
1861 (evt-row (cdr event-col-row)))
1862 (and (>= evt-col column)
1863 (< evt-col (+ column width))
1865 (and (> evt-row row)
1866 (<= evt-row (+ row height) ))
1867 (and (< evt-row row)
1868 (>= evt-row (+ row height)))))))
1870 (defun company--event-col-row (event)
1871 (company--posn-col-row (event-start event)))
1873 (defun company-select-mouse (event)
1874 "Select the candidate picked by the mouse."
1876 (let ((event-col-row (company--event-col-row event))
1877 (ovl-row (company--row))
1878 (ovl-height (and company-pseudo-tooltip-overlay
1879 (min (overlay-get company-pseudo-tooltip-overlay
1881 company-candidates-length))))
1883 (company--inside-tooltip-p event-col-row ovl-row ovl-height))
1885 (company-set-selection (+ (cdr event-col-row)
1886 (1- company-tooltip-offset)
1887 (if (and (eq company-tooltip-offset-display 'lines)
1888 (not (zerop company-tooltip-offset)))
1891 (if (< ovl-height 0)
1896 (company--unread-last-input)
1899 (defun company-complete-mouse (event)
1900 "Insert the candidate picked by the mouse."
1902 (when (company-select-mouse event)
1903 (company-complete-selection)))
1905 (defun company-complete-selection ()
1906 "Insert the selected candidate."
1908 (when (company-manual-begin)
1909 (let ((result (nth company-selection company-candidates)))
1910 (company-finish result))))
1912 (defun company-complete-common ()
1913 "Insert the common part of all candidates."
1915 (when (company-manual-begin)
1916 (if (and (not (cdr company-candidates))
1917 (equal company-common (car company-candidates)))
1918 (company-complete-selection)
1919 (when company-common
1920 (company--insert-candidate company-common)))))
1922 (defun company-complete-common-or-cycle ()
1923 "Insert the common part of all candidates, or select the next one."
1925 (when (company-manual-begin)
1926 (let ((tick (buffer-chars-modified-tick)))
1927 (call-interactively 'company-complete-common)
1928 (when (eq tick (buffer-chars-modified-tick))
1929 (let ((company-selection-wrap-around t))
1930 (call-interactively 'company-select-next))))))
1932 (defun company-complete ()
1933 "Insert the common part of all candidates or the current selection.
1934 The first time this is called, the common part is inserted, the second
1935 time, or when the selection has been changed, the selected candidate is
1938 (when (company-manual-begin)
1939 (if (or company-selection-changed
1940 (eq last-command 'company-complete-common))
1941 (call-interactively 'company-complete-selection)
1942 (call-interactively 'company-complete-common)
1943 (setq this-command 'company-complete-common))))
1945 (defun company-complete-number (n)
1946 "Insert the Nth candidate visible in the tooltip.
1947 To show the number next to the candidates in some back-ends, enable
1948 `company-show-numbers'. When called interactively, uses the last typed
1949 character, stripping the modifiers. That character must be a digit."
1951 (list (let* ((type (event-basic-type last-command-event))
1952 (char (if (characterp type)
1953 ;; Number on the main row.
1955 ;; Keypad number, if bound directly.
1956 (car (last (string-to-list (symbol-name type))))))
1958 (if (zerop n) 10 n))))
1959 (when (company-manual-begin)
1960 (and (or (< n 1) (> n (- company-candidates-length
1961 company-tooltip-offset)))
1962 (error "No candidate number %d" n))
1964 (company-finish (nth (+ n company-tooltip-offset)
1965 company-candidates))))
1967 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1969 (defconst company-space-strings-limit 100)
1971 (defconst company-space-strings
1973 (dotimes (i company-space-strings-limit)
1974 (push (make-string (- company-space-strings-limit 1 i) ?\ ) lst))
1975 (apply 'vector lst)))
1977 (defun company-space-string (len)
1978 (if (< len company-space-strings-limit)
1979 (aref company-space-strings len)
1980 (make-string len ?\ )))
1982 (defun company-safe-substring (str from &optional to)
1983 (if (> from (string-width str))
1987 (move-to-column from)
1988 (let ((beg (point)))
1992 (concat (buffer-substring beg (point))
1993 (let ((padding (- to (current-column))))
1995 (company-space-string padding)))))
1996 (buffer-substring beg (point-max)))))))
1998 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2000 (defvar-local company-last-metadata nil)
2002 (defun company-fetch-metadata ()
2003 (let ((selected (nth company-selection company-candidates)))
2004 (unless (eq selected (car company-last-metadata))
2005 (setq company-last-metadata
2006 (cons selected (company-call-backend 'meta selected))))
2007 (cdr company-last-metadata)))
2009 (defun company-doc-buffer (&optional string)
2010 (with-current-buffer (get-buffer-create "*company-documentation*")
2017 (defvar company--electric-commands
2018 '(scroll-other-window scroll-other-window-down)
2019 "List of Commands that won't break out of electric commands.")
2021 (defmacro company--electric-do (&rest body)
2022 (declare (indent 0) (debug t))
2023 `(when (company-manual-begin)
2024 (save-window-excursion
2025 (let ((height (window-height))
2026 (row (company--row))
2029 (and (< (window-height) height)
2030 (< (- (window-height) row 2) company-tooltip-limit)
2031 (recenter (- (window-height) row 2)))
2032 (while (memq (setq cmd (key-binding (vector (list (read-event)))))
2033 company--electric-commands)
2034 (call-interactively cmd))
2035 (company--unread-last-input)))))
2037 (defun company--unread-last-input ()
2038 (when last-input-event
2039 (clear-this-command-keys t)
2040 (setq unread-command-events (list last-input-event))))
2042 (defun company-show-doc-buffer ()
2043 "Temporarily show the documentation buffer for the selection."
2045 (company--electric-do
2046 (let* ((selected (nth company-selection company-candidates))
2047 (doc-buffer (or (company-call-backend 'doc-buffer selected)
2048 (error "No documentation available"))))
2049 (with-current-buffer doc-buffer
2050 (goto-char (point-min)))
2051 (display-buffer doc-buffer t))))
2052 (put 'company-show-doc-buffer 'company-keep t)
2054 (defun company-show-location ()
2055 "Temporarily display a buffer showing the selected candidate in context."
2057 (company--electric-do
2058 (let* ((selected (nth company-selection company-candidates))
2059 (location (company-call-backend 'location selected))
2060 (pos (or (cdr location) (error "No location available")))
2061 (buffer (or (and (bufferp (car location)) (car location))
2062 (find-file-noselect (car location) t))))
2063 (with-selected-window (display-buffer buffer t)
2066 (if (bufferp (car location))
2068 (goto-char (point-min))
2069 (forward-line (1- pos))))
2070 (set-window-start nil (point))))))
2071 (put 'company-show-location 'company-keep t)
2073 ;;; package functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2075 (defvar-local company-callback nil)
2077 (defun company-remove-callback (&optional ignored)
2078 (remove-hook 'company-completion-finished-hook company-callback t)
2079 (remove-hook 'company-completion-cancelled-hook 'company-remove-callback t)
2080 (remove-hook 'company-completion-finished-hook 'company-remove-callback t))
2082 (defun company-begin-backend (backend &optional callback)
2083 "Start a completion at point using BACKEND."
2084 (interactive (let ((val (completing-read "Company back-end: "
2086 'functionp nil "company-")))
2088 (list (intern val)))))
2089 (when (setq company-callback callback)
2090 (add-hook 'company-completion-finished-hook company-callback nil t))
2091 (add-hook 'company-completion-cancelled-hook 'company-remove-callback nil t)
2092 (add-hook 'company-completion-finished-hook 'company-remove-callback nil t)
2093 (setq company-backend backend)
2094 ;; Return non-nil if active.
2095 (or (company-manual-begin)
2096 (error "Cannot complete at point")))
2098 (defun company-begin-with (candidates
2099 &optional prefix-length require-match callback)
2100 "Start a completion at point.
2101 CANDIDATES is the list of candidates to use and PREFIX-LENGTH is the length
2102 of the prefix that already is in the buffer before point.
2105 CALLBACK is a function called with the selected result if the user
2106 successfully completes the input.
2108 Example: \(company-begin-with '\(\"foo\" \"foobar\" \"foobarbaz\"\)\)"
2109 (let ((begin-marker (copy-marker (point) t)))
2110 (company-begin-backend
2111 (lambda (command &optional arg &rest ignored)
2114 (when (equal (point) (marker-position begin-marker))
2115 (buffer-substring (- (point) (or prefix-length 0)) (point))))
2117 (all-completions arg candidates))
2122 (defun company-version (&optional show-version)
2123 "Get the Company version as string.
2125 If SHOW-VERSION is non-nil, show the version in the echo area."
2126 (interactive (list t))
2128 (insert-file-contents (find-library-name "company"))
2131 (message "Company version: %s" (lm-version))
2134 ;;; pseudo-tooltip ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2136 (defvar-local company-pseudo-tooltip-overlay nil)
2138 (defvar-local company-tooltip-offset 0)
2140 (defun company-tooltip--lines-update-offset (selection num-lines limit)
2142 (setq company-tooltip-offset
2143 (max (min selection company-tooltip-offset)
2144 (- selection -1 limit)))
2146 (when (<= company-tooltip-offset 1)
2148 (setq company-tooltip-offset 0))
2150 (when (>= company-tooltip-offset (- num-lines limit 1))
2152 (when (= selection (1- num-lines))
2153 (cl-decf company-tooltip-offset)
2154 (when (<= company-tooltip-offset 1)
2155 (setq company-tooltip-offset 0)
2160 (defun company-tooltip--simple-update-offset (selection _num-lines limit)
2161 (setq company-tooltip-offset
2162 (if (< selection company-tooltip-offset)
2164 (max company-tooltip-offset
2165 (- selection limit -1)))))
2169 (defsubst company-round-tab (arg)
2170 (* (/ (+ arg tab-width) tab-width) tab-width))
2172 (defun company-plainify (str)
2173 (let ((prefix (get-text-property 0 'line-prefix str)))
2174 (when prefix ; Keep the original value unmodified, for no special reason.
2175 (setq str (concat prefix str))
2176 (remove-text-properties 0 (length str) '(line-prefix) str)))
2177 (let* ((pieces (split-string str "\t"))
2180 (setcar copy (company-safe-substring
2181 (car copy) 0 (company-round-tab (string-width (car copy)))))
2183 (apply 'concat pieces)))
2185 (defun company-fill-propertize (value annotation width selected left right)
2186 (let* ((margin (length left))
2187 (common (or (company-call-backend 'match value)
2189 (string-width company-common)
2191 (ann-ralign company-tooltip-align-annotations)
2192 (ann-truncate (< width
2193 (+ (length value) (length annotation)
2194 (if ann-ralign 1 0))))
2195 (ann-start (+ margin
2199 (- width (length annotation)))
2201 (ann-end (min (+ ann-start (length annotation)) (+ margin width)))
2203 (if (or ann-truncate (not ann-ralign))
2204 (company-safe-substring
2206 (when (and annotation ann-ralign) " ")
2210 (company-safe-substring value 0
2211 (- width (length annotation)))
2214 (setq common (+ (min common width) margin))
2215 (setq width (+ width margin (length right)))
2217 (add-text-properties 0 width '(face company-tooltip
2218 mouse-face company-tooltip-mouse)
2220 (add-text-properties margin common
2221 '(face company-tooltip-common
2222 mouse-face company-tooltip-mouse)
2224 (when (< ann-start ann-end)
2225 (add-text-properties ann-start ann-end
2226 '(face company-tooltip-annotation
2227 mouse-face company-tooltip-mouse)
2230 (if (and (not (string= company-search-string ""))
2231 (string-match (regexp-quote company-search-string) value
2232 (length company-prefix)))
2233 (let ((beg (+ margin (match-beginning 0)))
2234 (end (+ margin (match-end 0)))
2235 (width (- width (length right))))
2237 (add-text-properties beg (min end width)
2238 '(face company-tooltip-search)
2240 (add-text-properties 0 width '(face company-tooltip-selection
2241 mouse-face company-tooltip-selection)
2243 (add-text-properties margin common
2244 '(face company-tooltip-common-selection
2245 mouse-face company-tooltip-selection)
2249 (defun company--clean-string (str)
2250 (replace-regexp-in-string
2251 "\\([^[:graph:] ]\\)\\|\\(\ufeff\\)\\|[[:multibyte:]]"
2254 ((match-beginning 1)
2255 ;; FIXME: Better char for 'non-printable'?
2256 ;; We shouldn't get any of these, but sometimes we might.
2258 ((match-beginning 2)
2259 ;; Zero-width non-breakable space.
2261 ((> (string-width match) 1)
2263 (make-string (1- (string-width match)) ?\ufeff)
2270 (defun company-buffer-lines (beg end)
2272 (let (lines lines-moved)
2273 (while (and (not (eobp)) ; http://debbugs.gnu.org/19553
2274 (> (setq lines-moved (vertical-motion 1)) 0)
2276 (let ((bound (min end (1- (point)))))
2277 ;; A visual line can contain several physical lines (e.g. with outline's
2278 ;; folding overlay). Take only the first one.
2279 (push (buffer-substring beg
2282 (re-search-forward "$" bound 'move)
2285 ;; One physical line can be displayed as several visual ones as well:
2286 ;; add empty strings to the list, to even the count.
2287 (dotimes (_ (1- lines-moved))
2290 (unless (eq beg end)
2291 (push (buffer-substring beg end) lines))
2294 (defun company-modify-line (old new offset)
2295 (concat (company-safe-substring old 0 offset)
2297 (company-safe-substring old (+ offset (length new)))))
2299 (defsubst company--length-limit (lst limit)
2300 (if (nthcdr limit lst)
2304 (defsubst company--window-height ()
2305 (if (fboundp 'window-screen-lines)
2306 (floor (window-screen-lines))
2307 (window-body-height)))
2309 (defun company--window-width ()
2310 (let ((ww (window-body-width)))
2311 ;; Account for the line continuation column.
2312 (when (zerop (cadr (window-fringes)))
2314 (unless (or (display-graphic-p)
2315 (version< "24.3.1" emacs-version))
2316 ;; Emacs 24.3 and earlier included margins
2317 ;; in window-width when in TTY.
2319 (let ((margins (window-margins)))
2320 (+ (or (car margins) 0)
2321 (or (cdr margins) 0)))))
2322 (when (and word-wrap
2323 (version< emacs-version "24.4.51.5"))
2324 ;; http://debbugs.gnu.org/18384
2328 (defun company--replacement-string (lines old column nl &optional align-top)
2329 (cl-decf column company-tooltip-margin)
2331 (when (and align-top company-tooltip-flip-when-above)
2332 (setq lines (reverse lines)))
2334 (let ((width (length (car lines)))
2335 (remaining-cols (- (+ (company--window-width) (window-hscroll))
2337 (when (> width remaining-cols)
2338 (cl-decf column (- width remaining-cols))))
2340 (let ((offset (and (< column 0) (- column)))
2345 ;; untouched lines first
2346 (dotimes (_ (- (length old) (length lines)))
2347 (push (pop old) new)))
2348 ;; length into old lines.
2350 (push (company-modify-line (pop old)
2351 (company--offset-line (pop lines) offset)
2354 ;; Append whole new lines.
2356 (push (concat (company-space-string column)
2357 (company--offset-line (pop lines) offset))
2360 (let ((str (concat (when nl " ")
2362 (mapconcat 'identity (nreverse new) "\n")
2364 (font-lock-append-text-property 0 (length str) 'face 'default str)
2365 (when nl (put-text-property 0 1 'cursor t str))
2368 (defun company--offset-line (line offset)
2369 (if (and offset line)
2370 (substring line offset)
2373 (defun company--create-lines (selection limit)
2374 (let ((len company-candidates-length)
2375 (window-width (company--window-width))
2384 ;; Maybe clear old offset.
2385 (when (< len (+ company-tooltip-offset limit))
2386 (setq company-tooltip-offset 0))
2388 ;; Scroll to offset.
2389 (if (eq company-tooltip-offset-display 'lines)
2390 (setq limit (company-tooltip--lines-update-offset selection len limit))
2391 (company-tooltip--simple-update-offset selection len limit))
2394 ((eq company-tooltip-offset-display 'scrollbar)
2395 (setq scrollbar-bounds (company--scrollbar-bounds company-tooltip-offset
2397 ((eq company-tooltip-offset-display 'lines)
2398 (when (> company-tooltip-offset 0)
2399 (setq previous (format "...(%d)" company-tooltip-offset)))
2400 (setq remainder (- len limit company-tooltip-offset)
2401 remainder (when (> remainder 0)
2402 (setq remainder (format "...(%d)" remainder))))))
2404 (cl-decf selection company-tooltip-offset)
2405 (setq width (max (length previous) (length remainder))
2406 lines (nthcdr company-tooltip-offset company-candidates)
2410 (cl-decf window-width (* 2 company-tooltip-margin))
2411 (when scrollbar-bounds (cl-decf window-width))
2414 (let* ((value (pop lines-copy))
2415 (annotation (company-call-backend 'annotation value)))
2416 (setq value (company--clean-string (company-reformat value)))
2418 (when company-tooltip-align-annotations
2419 ;; `lisp-completion-at-point' adds a space.
2420 (setq annotation (comment-string-strip annotation t nil)))
2421 (setq annotation (company--clean-string annotation)))
2422 (push (cons value annotation) items)
2423 (setq width (max (+ (length value)
2424 (if (and annotation company-tooltip-align-annotations)
2425 (1+ (length annotation))
2426 (length annotation)))
2429 (setq width (min window-width
2430 (max company-tooltip-minimum-width
2431 (if company-show-numbers
2435 (let ((items (nreverse items))
2436 (numbered (if company-show-numbers 0 99999))
2439 (push (company--scrollpos-line previous width) new))
2442 (let* ((item (pop items))
2444 (annotation (cdr item))
2445 (right (company-space-string company-tooltip-margin))
2447 (when (< numbered 10)
2450 (setq right (concat (format " %d" (mod numbered 10)) right)))
2452 (company-fill-propertize str annotation
2453 width (equal i selection)
2454 (company-space-string
2455 company-tooltip-margin)
2457 (when scrollbar-bounds
2458 (company--scrollbar i scrollbar-bounds)))
2462 (push (company--scrollpos-line remainder width) new))
2466 (defun company--scrollbar-bounds (offset limit length)
2467 (when (> length limit)
2468 (let* ((size (ceiling (* limit (float limit)) length))
2469 (lower (floor (* limit (float offset)) length))
2470 (upper (+ lower size -1)))
2471 (cons lower upper))))
2473 (defun company--scrollbar (i bounds)
2474 (propertize " " 'face
2475 (if (and (>= i (car bounds)) (<= i (cdr bounds)))
2476 'company-scrollbar-fg
2477 'company-scrollbar-bg)))
2479 (defun company--scrollpos-line (text width)
2480 (propertize (concat (company-space-string company-tooltip-margin)
2481 (company-safe-substring text 0 width)
2482 (company-space-string company-tooltip-margin))
2483 'face 'company-tooltip))
2487 (defun company--pseudo-tooltip-height ()
2488 "Calculate the appropriate tooltip height.
2489 Returns a negative number if the tooltip should be displayed above point."
2490 (let* ((lines (company--row))
2491 (below (- (company--window-height) 1 lines)))
2492 (if (and (< below (min company-tooltip-minimum company-candidates-length))
2494 (- (max 3 (min company-tooltip-limit lines)))
2495 (max 3 (min company-tooltip-limit below)))))
2497 (defun company-pseudo-tooltip-show (row column selection)
2498 (company-pseudo-tooltip-hide)
2501 (let* ((height (company--pseudo-tooltip-height))
2505 (setq row (+ row height -1)
2508 (let* ((nl (< (move-to-window-line row) row))
2510 (end (save-excursion
2511 (move-to-window-line (+ row (abs height)))
2513 (ov (make-overlay (if nl beg (1- beg)) end nil t))
2514 (args (list (mapcar 'company-plainify
2515 (company-buffer-lines beg end))
2518 (setq company-pseudo-tooltip-overlay ov)
2519 (overlay-put ov 'company-replacement-args args)
2521 (let ((lines (company--create-lines selection (abs height))))
2522 (overlay-put ov 'company-display
2523 (apply 'company--replacement-string lines args))
2524 (overlay-put ov 'company-width (string-width (car lines))))
2526 (overlay-put ov 'company-column column)
2527 (overlay-put ov 'company-height height)))))
2529 (defun company-pseudo-tooltip-show-at-point (pos column-offset)
2530 (let* ((col-row (company--col-row pos))
2531 (col (- (car col-row) column-offset)))
2532 (when (< col 0) (setq col 0))
2533 (company-pseudo-tooltip-show (1+ (cdr col-row)) col company-selection)))
2535 (defun company-pseudo-tooltip-edit (selection)
2536 (let* ((height (overlay-get company-pseudo-tooltip-overlay 'company-height))
2537 (lines (company--create-lines selection (abs height))))
2538 (overlay-put company-pseudo-tooltip-overlay 'company-width
2539 (string-width (car lines)))
2540 (overlay-put company-pseudo-tooltip-overlay 'company-display
2541 (apply 'company--replacement-string
2543 (overlay-get company-pseudo-tooltip-overlay
2544 'company-replacement-args)))))
2546 (defun company-pseudo-tooltip-hide ()
2547 (when company-pseudo-tooltip-overlay
2548 (delete-overlay company-pseudo-tooltip-overlay)
2549 (setq company-pseudo-tooltip-overlay nil)))
2551 (defun company-pseudo-tooltip-hide-temporarily ()
2552 (when (overlayp company-pseudo-tooltip-overlay)
2553 (overlay-put company-pseudo-tooltip-overlay 'invisible nil)
2554 (overlay-put company-pseudo-tooltip-overlay 'after-string nil)))
2556 (defun company-pseudo-tooltip-unhide ()
2557 (when company-pseudo-tooltip-overlay
2558 (let* ((ov company-pseudo-tooltip-overlay)
2559 (disp (overlay-get ov 'company-display)))
2560 ;; Beat outline's folding overlays, at least.
2561 (overlay-put ov 'priority 1)
2562 ;; `display' could be better (http://debbugs.gnu.org/18285), but it
2563 ;; doesn't work when the overlay is empty, which is what happens at eob.
2564 ;; It also seems to interact badly with `cursor'.
2565 ;; We deal with priorities by having the overlay start before the newline.
2566 (overlay-put ov 'after-string disp)
2567 (overlay-put ov 'invisible t)
2568 (overlay-put ov 'window (selected-window)))))
2570 (defun company-pseudo-tooltip-guard ()
2572 (save-excursion (beginning-of-visual-line))
2573 (let ((ov company-pseudo-tooltip-overlay)
2574 (overhang (save-excursion (end-of-visual-line)
2575 (- (line-end-position) (point)))))
2576 (when (>= (overlay-get ov 'company-height) 0)
2578 (buffer-substring-no-properties (point) (overlay-start ov))
2579 (when (>= overhang 0) overhang))))))
2581 (defun company-pseudo-tooltip-frontend (command)
2582 "`company-mode' front-end similar to a tooltip but based on overlays."
2584 (pre-command (company-pseudo-tooltip-hide-temporarily))
2586 (unless (when (overlayp company-pseudo-tooltip-overlay)
2587 (let* ((ov company-pseudo-tooltip-overlay)
2588 (old-height (overlay-get ov 'company-height))
2589 (new-height (company--pseudo-tooltip-height)))
2591 (>= (* old-height new-height) 0)
2592 (>= (abs old-height) (abs new-height))
2593 (equal (company-pseudo-tooltip-guard)
2594 (overlay-get ov 'company-guard)))))
2596 (company-pseudo-tooltip-show-at-point (point) (length company-prefix))
2597 (overlay-put company-pseudo-tooltip-overlay
2598 'company-guard (company-pseudo-tooltip-guard)))
2599 (company-pseudo-tooltip-unhide))
2600 (hide (company-pseudo-tooltip-hide)
2601 (setq company-tooltip-offset 0))
2602 (update (when (overlayp company-pseudo-tooltip-overlay)
2603 (company-pseudo-tooltip-edit company-selection)))))
2605 (defun company-pseudo-tooltip-unless-just-one-frontend (command)
2606 "`company-pseudo-tooltip-frontend', but not shown for single candidates."
2607 (unless (and (eq command 'post-command)
2608 (company--show-inline-p))
2609 (company-pseudo-tooltip-frontend command)))
2611 ;;; overlay ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2613 (defvar-local company-preview-overlay nil)
2615 (defun company-preview-show-at-point (pos)
2616 (company-preview-hide)
2618 (let ((completion (nth company-selection company-candidates)))
2619 (setq completion (propertize completion 'face 'company-preview))
2620 (add-text-properties 0 (length company-common)
2621 '(face company-preview-common) completion)
2623 ;; Add search string
2624 (and company-search-string
2625 (string-match (regexp-quote company-search-string) completion)
2626 (add-text-properties (match-beginning 0)
2628 '(face company-preview-search)
2631 (setq completion (company-strip-prefix completion))
2633 (and (equal pos (point))
2634 (not (equal completion ""))
2635 (add-text-properties 0 1 '(cursor 1) completion))
2638 (pto company-pseudo-tooltip-overlay)
2639 (ptf-workaround (and
2642 (eq pos (overlay-start pto)))))
2643 ;; Try to accomodate for the pseudo-tooltip overlay,
2644 ;; which may start at the same position if it's at eol.
2645 (when ptf-workaround
2647 (setq completion (concat (buffer-substring beg pos) completion)))
2649 (setq company-preview-overlay (make-overlay beg pos))
2651 (let ((ov company-preview-overlay))
2652 (overlay-put ov (if ptf-workaround 'display 'after-string)
2654 (overlay-put ov 'window (selected-window))))))
2656 (defun company-preview-hide ()
2657 (when company-preview-overlay
2658 (delete-overlay company-preview-overlay)
2659 (setq company-preview-overlay nil)))
2661 (defun company-preview-frontend (command)
2662 "`company-mode' front-end showing the selection as if it had been inserted."
2664 (`pre-command (company-preview-hide))
2665 (`post-command (company-preview-show-at-point (point)))
2666 (`hide (company-preview-hide))))
2668 (defun company-preview-if-just-one-frontend (command)
2669 "`company-preview-frontend', but only shown for single candidates."
2670 (when (or (not (eq command 'post-command))
2671 (company--show-inline-p))
2672 (company-preview-frontend command)))
2674 (defun company--show-inline-p ()
2675 (and (not (cdr company-candidates))
2677 (or (eq (company-call-backend 'ignore-case) 'keep-prefix)
2678 (string-prefix-p company-prefix company-common))))
2680 ;;; echo ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2682 (defvar-local company-echo-last-msg nil)
2684 (defvar company-echo-timer nil)
2686 (defvar company-echo-delay .01)
2688 (defun company-echo-show (&optional getter)
2690 (setq company-echo-last-msg (funcall getter)))
2691 (let ((message-log-max nil))
2692 (if company-echo-last-msg
2693 (message "%s" company-echo-last-msg)
2696 (defun company-echo-show-soon (&optional getter)
2697 (when company-echo-timer
2698 (cancel-timer company-echo-timer))
2699 (setq company-echo-timer (run-with-timer 0 nil 'company-echo-show getter)))
2701 (defsubst company-echo-show-when-idle (&optional getter)
2702 (when (sit-for company-echo-delay)
2703 (company-echo-show getter)))
2705 (defun company-echo-format ()
2707 (let ((limit (window-body-width (minibuffer-window)))
2709 ;; Roll to selection.
2710 (candidates (nthcdr company-selection company-candidates))
2711 (i (if company-show-numbers company-selection 99999))
2715 (setq comp (company-reformat (pop candidates))
2716 len (+ len 1 (length comp)))
2720 (setq comp (propertize (format "%d: %s" i comp)
2721 'face 'company-echo))
2724 (add-text-properties 3 (+ 3 (length company-common))
2725 '(face company-echo-common) comp))
2726 (setq comp (propertize comp 'face 'company-echo))
2727 (add-text-properties 0 (length company-common)
2728 '(face company-echo-common) comp))
2730 (setq candidates nil)
2733 (mapconcat 'identity (nreverse msg) " ")))
2735 (defun company-echo-strip-common-format ()
2737 (let ((limit (window-body-width (minibuffer-window)))
2738 (len (+ (length company-prefix) 2))
2739 ;; Roll to selection.
2740 (candidates (nthcdr company-selection company-candidates))
2741 (i (if company-show-numbers company-selection 99999))
2745 (setq comp (company-strip-prefix (pop candidates))
2746 len (+ len 2 (length comp)))
2749 (setq comp (format "%s (%d)" comp i))
2753 (setq candidates nil)
2754 (push (propertize comp 'face 'company-echo) msg)))
2756 (concat (propertize company-prefix 'face 'company-echo-common) "{"
2757 (mapconcat 'identity (nreverse msg) ", ")
2760 (defun company-echo-hide ()
2761 (unless (equal company-echo-last-msg "")
2762 (setq company-echo-last-msg "")
2763 (company-echo-show)))
2765 (defun company-echo-frontend (command)
2766 "`company-mode' front-end showing the candidates in the echo area."
2768 (`post-command (company-echo-show-soon 'company-echo-format))
2769 (`hide (company-echo-hide))))
2771 (defun company-echo-strip-common-frontend (command)
2772 "`company-mode' front-end showing the candidates in the echo area."
2774 (`post-command (company-echo-show-soon 'company-echo-strip-common-format))
2775 (`hide (company-echo-hide))))
2777 (defun company-echo-metadata-frontend (command)
2778 "`company-mode' front-end showing the documentation in the echo area."
2780 (`post-command (company-echo-show-when-idle 'company-fetch-metadata))
2781 (`hide (company-echo-hide))))
2784 ;;; company.el ends here