;; Author: Nikolaj Schumacher
;; Maintainer: Dmitry Gutov <dgutov@yandex.ru>
-;; Version: 0.6.9
+;; Version: 0.6.10
;; Keywords: abbrev, convenience, matching
;; URL: http://company-mode.github.io/
;; Compatibility: GNU Emacs 22.x, GNU Emacs 23.x, GNU Emacs 24.x
The first argument is the command requested from the back-end. It is one
of the following:
-`prefix': The back-end should return the text to be completed. It must be text
-immediately before point. Returning nil passes control to the next back-end.
-The function should return `stop' if it should complete but cannot \(e.g. if it
-is in the middle of a string\). Instead of a string, the back-end may return a
-cons where car is the prefix and cdr is used in `company-minimum-prefix-length'
-test. It's either number or t, in which case the test automatically succeeds.
+`prefix': The back-end should return the text to be completed. It must be
+text immediately before point. Returning nil passes control to the next
+back-end. The function should return `stop' if it should complete but
+cannot \(e.g. if it is in the middle of a string\). Instead of a string,
+the back-end may return a cons where car is the prefix and cdr is used in
+`company-minimum-prefix-length' test. It's either number or t, in which
+case the test automatically succeeds.
`candidates': The second argument is the prefix to be completed. The
return value should be a list of candidates that start with the prefix.
Optional commands:
-`sorted': The back-end may return t here to indicate that the candidates
-are sorted and will not need to be sorted again.
+`sorted': Return t here to indicate that the candidates are sorted and will
+not need to be sorted again.
`duplicates': If non-nil, company will take care of removing duplicates
from the list.
progresses, unless the back-end returns t for this command. The second
argument is the latest prefix.
-`meta': The second argument is a completion candidate. The back-end should
-return a (short) documentation string for it.
+`meta': The second argument is a completion candidate. Return a (short)
+documentation string for it.
-`doc-buffer': The second argument is a completion candidate.
-The back-end should create a buffer (preferably with `company-doc-buffer'),
-fill it with documentation and return it.
+`doc-buffer': The second argument is a completion candidate. Return a
+buffer with documentation for it. Preferably use `company-doc-buffer',
-`location': The second argument is a completion candidate. The back-end can
-return the cons of buffer and buffer location, or of file and line
-number where the completion candidate was defined.
+`location': The second argument is a completion candidate. Return the cons
+of buffer and buffer location, or of file and line number where the
+completion candidate was defined.
-`require-match': If this value is t, the user is not allowed to enter anything
-not offered as a candidate. Use with care! The default value nil gives the
-user that choice with `company-require-match'. Return value 'never overrides
-that option the other way around.
+`require-match': If this returns t, the user is not allowed to enter
+anything not offered as a candidate. Use with care! The default value nil
+gives the user that choice with `company-require-match'. Return value
+`never' overrides that option the other way around.
-`init': Called once for each buffer, the back-end can check for external
-programs and files and load any required libraries. Raising an error here will
-show up in message log once, and the backend will not be used for completion.
+`init': Called once for each buffer. The back-end can check for external
+programs and files and load any required libraries. Raising an error here
+will show up in message log once, and the back-end will not be used for
+completion.
-`post-completion': Called after a completion candidate has been inserted into
-the buffer. The second argument is the candidate. Can be used to modify it,
-e.g. to expand a snippet.
+`post-completion': Called after a completion candidate has been inserted
+into the buffer. The second argument is the candidate. Can be used to
+modify it, e.g. to expand a snippet.
The back-end should return nil for all commands it does not support or
does not know about. It should also be callable interactively and use
"Hook run when company successfully completes.
The hook is called with the selected candidate as an argument.
-If you indend to use it to post-process candidates from a specific back-end,
-consider using the `post-completion' command instead."
+If you indend to use it to post-process candidates from a specific
+back-end, consider using the `post-completion' command instead."
:type 'hook)
(defcustom company-minimum-prefix-length 3
(defcustom company-auto-complete nil
"Determines when to auto-complete.
-If this is enabled, all characters from `company-auto-complete-chars' complete
-the selected completion. This can also be a function."
+If this is enabled, all characters from `company-auto-complete-chars'
+complete the selected completion. This can also be a function."
:type '(choice (const :tag "Off" nil)
(function :tag "Predicate function")
(const :tag "On, if user interaction took place"
(defcustom company-auto-complete-chars '(?\ ?\) ?.)
"Determines which characters trigger an automatic completion.
-See `company-auto-complete'. If this is a string, each string character causes
-completion. If it is a list of syntax description characters (see
+See `company-auto-complete'. If this is a string, each string character
+causes completion. If it is a list of syntax description characters (see
`modify-syntax-entry'), all characters with that syntax auto-complete.
This can also be a function, which is called with the new input and should
"A list of commands following which company will start completing.
If this is t, it will complete after any command. See `company-idle-delay'.
-Alternatively any command with a non-nil 'company-begin property is treated as
-if it was on this list."
+Alternatively any command with a non-nil `company-begin' property is treated
+as if it was on this list."
:type '(choice (const :tag "Any command" t)
(const :tag "Self insert command" '(self-insert-command))
(repeat :tag "Commands" function)))
`company-filter-candidates'. These can be used while completion is
inactive, as well.
-The completion data is retrieved using `company-backends' and displayed using
-`company-frontends'. If you want to start a specific back-end, call it
-interactively or use `company-begin-backend'.
+The completion data is retrieved using `company-backends' and displayed
+using `company-frontends'. If you want to start a specific back-end, call
+it interactively or use `company-begin-backend'.
regular keymap (`company-mode-map'):
(company-cancel)
(kill-local-variable 'company-point)))
+(defcustom company-global-modes t
+ "Modes for which `company-mode' mode is turned on by `global-company-mode'.
+If nil, means no modes. If t, then all major modes have it turned on.
+If a list, it should be a list of `major-mode' symbol names for which
+`company-mode' should be automatically turned on. The sense of the list is
+negated if it begins with `not'. For example:
+ (c-mode c++-mode)
+means that `company-mode' is turned on for buffers in C and C++ modes only.
+ (not message-mode)
+means that `company-mode' is always turned on except in `message-mode' buffers."
+ :type '(choice (const :tag "none" nil)
+ (const :tag "all" t)
+ (set :menu-tag "mode specific" :tag "modes"
+ :value (not)
+ (const :tag "Except" not)
+ (repeat :inline t (symbol :tag "mode")))))
+
;;;###autoload
(define-globalized-minor-mode global-company-mode company-mode company-mode-on)
(defun company-mode-on ()
- (unless (or noninteractive (eq (aref (buffer-name) 0) ?\s))
+ (when (and (not (or noninteractive (eq (aref (buffer-name) 0) ?\s)))
+ (cond ((eq company-global-modes t)
+ t)
+ ((eq (car-safe company-global-modes) 'not)
+ (not (memq major-mode (cdr company-global-modes))))
+ (t (memq major-mode company-global-modes))))
(company-mode 1)))
(defsubst company-assert-enabled ()
Regular characters are appended to the search string.
-The command `company-search-kill-others' (\\[company-search-kill-others]) uses
- the search string to limit the completion candidates."
+The command `company-search-kill-others' (\\[company-search-kill-others])
+uses the search string to limit the completion candidates."
(interactive)
(company-search-mode 1)
(company-enable-overriding-keymap company-search-map))
(defun company-complete ()
"Complete the common part of all candidates or the current selection.
-The first time this is called, the common part is completed, the second time, or
-when the selection has been changed, the selected candidate is completed."
+The first time this is called, the common part is completed, the second
+time, or when the selection has been changed, the selected candidate is
+completed."
(interactive)
(when (company-manual-begin)
(if (or company-selection-changed
(cons selected (company-call-backend 'meta selected))))
(cdr company-last-metadata)))
-(defun company-doc-buffer (&optional _string)
- (with-current-buffer (get-buffer-create "*Company meta-data*")
+(defun company-doc-buffer (&optional string)
+ (with-current-buffer (get-buffer-create "*company-documentation*")
(erase-buffer)
+ (when string
+ (save-excursion
+ (insert string)))
(current-buffer)))
(defvar company--electric-commands
(setq unread-command-events (list last-input-event))))
(defun company-show-doc-buffer ()
- "Temporarily show a buffer with the complete documentation for the selection."
+ "Temporarily show the documentation buffer for the selection."
(interactive)
(company--electric-do
(let* ((selected (nth company-selection company-candidates))
(defun company-begin-with (candidates
&optional prefix-length require-match callback)
"Start a completion at point.
-CANDIDATES is the list of candidates to use and PREFIX-LENGTH is the length of
-the prefix that already is in the buffer before point. It defaults to 0.
+CANDIDATES is the list of candidates to use and PREFIX-LENGTH is the length
+of the prefix that already is in the buffer before point.
+It defaults to 0.
-CALLBACK is a function called with the selected result if the user successfully
-completes the input.
+CALLBACK is a function called with the selected result if the user
+successfully completes the input.
-Example:
-\(company-begin-with '\(\"foo\" \"foobar\" \"foobarbaz\"\)\)"
+Example: \(company-begin-with '\(\"foo\" \"foobar\" \"foobarbaz\"\)\)"
;; FIXME: When Emacs 23 is no longer a concern, replace
;; `company-begin-with-marker' with a lexical variable; use a lexical closure.
(setq company-begin-with-marker (copy-marker (point) t))
(let ((prefix (get-text-property 0 'line-prefix old)))
(when prefix ; Keep the original value unmodified, for no special reason.
(setq old (concat prefix old))
- (remove-text-properties 0 (length old) '(line-prefix) old))
- (concat (company-safe-substring old 0 offset)
- new
- (company-safe-substring old (+ offset (length new))))))
+ (remove-text-properties 0 (length old) '(line-prefix) old)))
+ (concat (company-safe-substring old 0 offset)
+ new
+ (company-safe-substring old (+ offset (length new)))))
(defsubst company--length-limit (lst limit)
(if (nthcdr limit lst)
(defun company-pseudo-tooltip-hide-temporarily ()
(when (overlayp company-pseudo-tooltip-overlay)
(overlay-put company-pseudo-tooltip-overlay 'invisible nil)
+ (overlay-put company-pseudo-tooltip-overlay 'line-prefix nil)
(overlay-put company-pseudo-tooltip-overlay 'before-string nil)))
(defun company-pseudo-tooltip-unhide ()