code.delx.au - gnu-emacs-elpa/blob - company.el

   1 ;;; company.el --- Modular text completion framework  -*- lexical-binding: t -*-
   2
   3 ;; Copyright (C) 2009-2016  Free Software Foundation, Inc.
   4
   5 ;; Author: Nikolaj Schumacher
   6 ;; Maintainer: Dmitry Gutov <dgutov@yandex.ru>
   7 ;; URL: http://company-mode.github.io/
   8 ;; Version: 0.9.0-cvs
   9 ;; Keywords: abbrev, convenience, matching
  10 ;; Package-Requires: ((emacs "24.1") (cl-lib "0.5"))
  11
  12 ;; This file is part of GNU Emacs.
  13
  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.
  18
  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.
  23
  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/>.
  26
  27 ;;; Commentary:
  28 ;;
  29 ;; Company is a modular completion framework.  Modules for retrieving completion
  30 ;; candidates are called backends, modules for displaying them are frontends.
  31 ;;
  32 ;; Company comes with many backends, e.g. `company-etags'.  These are
  33 ;; distributed in separate files and can be used individually.
  34 ;;
  35 ;; Enable `company-mode' in all buffers with M-x global-company-mode.  For
  36 ;; further information look at the documentation for `company-mode' (C-h f
  37 ;; company-mode RET).
  38 ;;
  39 ;; If you want to start a specific backend, call it interactively or use
  40 ;; `company-begin-backend'.  For example:
  41 ;; M-x company-abbrev will prompt for and insert an abbrev.
  42 ;;
  43 ;; To write your own backend, look at the documentation for `company-backends'.
  44 ;; Here is a simple example completing "foo":
  45 ;;
  46 ;; (defun company-my-backend (command &optional arg &rest ignored)
  47 ;;   (pcase command
  48 ;;     (`prefix (company-grab-symbol))
  49 ;;     (`candidates (list "foobar" "foobaz" "foobarbaz"))
  50 ;;     (`meta (format "This value is named %s" arg))))
  51 ;;
  52 ;; Sometimes it is a good idea to mix several backends together, for example to
  53 ;; enrich gtags with dabbrev-code results (to emulate local variables).  To do
  54 ;; this, add a list with both backends as an element in `company-backends'.
  55 ;;
  56 ;;; Change Log:
  57 ;;
  58 ;; See NEWS.md in the repository.
  59
  60 ;;; Code:
  61
  62 (require 'cl-lib)
  63 (require 'newcomment)
  64 (require 'pcase)
  65
  66 ;; FIXME: Use `user-error'.
  67 (add-to-list 'debug-ignored-errors "^.* frontend cannot be used twice$")
  68 (add-to-list 'debug-ignored-errors "^Echo area cannot be used twice$")
  69 (add-to-list 'debug-ignored-errors "^No \\(document\\|loc\\)ation available$")
  70 (add-to-list 'debug-ignored-errors "^Company not ")
  71 (add-to-list 'debug-ignored-errors "^No candidate number ")
  72 (add-to-list 'debug-ignored-errors "^Cannot complete at point$")
  73 (add-to-list 'debug-ignored-errors "^No other backend$")
  74
  75 ;;; Compatibility
  76 (eval-and-compile
  77   ;; `defvar-local' for Emacs 24.2 and below
  78   (unless (fboundp 'defvar-local)
  79     (defmacro defvar-local (var val &optional docstring)
  80       "Define VAR as a buffer-local variable with default value VAL.
  81 Like `defvar' but additionally marks the variable as being automatically
  82 buffer-local wherever it is set."
  83       (declare (debug defvar) (doc-string 3))
  84       `(progn
  85          (defvar ,var ,val ,docstring)
  86          (make-variable-buffer-local ',var)))))
  87
  88 (defgroup company nil
  89   "Extensible inline text completion mechanism"
  90   :group 'abbrev
  91   :group 'convenience
  92   :group 'matching)
  93
  94 (defface company-tooltip
  95   '((default :foreground "black")
  96     (((class color) (min-colors 88) (background light))
  97      (:background "cornsilk"))
  98     (((class color) (min-colors 88) (background dark))
  99      (:background "yellow")))
 100   "Face used for the tooltip.")
 101
 102 (defface company-tooltip-selection
 103   '((((class color) (min-colors 88) (background light))
 104      (:background "light blue"))
 105     (((class color) (min-colors 88) (background dark))
 106      (:background "orange1"))
 107     (t (:background "green")))
 108   "Face used for the selection in the tooltip.")
 109
 110 (defface company-tooltip-search
 111   '((default :inherit company-tooltip-selection))
 112   "Face used for the search string in the tooltip.")
 113
 114 (defface company-tooltip-mouse
 115   '((default :inherit highlight))
 116   "Face used for the tooltip item under the mouse.")
 117
 118 (defface company-tooltip-common
 119   '((((background light))
 120      :foreground "darkred")
 121     (((background dark))
 122      :foreground "red"))
 123   "Face used for the common completion in the tooltip.")
 124
 125 (defface company-tooltip-common-selection
 126   '((default :inherit company-tooltip-common))
 127   "Face used for the selected common completion in the tooltip.")
 128
 129 (defface company-tooltip-annotation
 130   '((((background light))
 131      :foreground "firebrick4")
 132     (((background dark))
 133      :foreground "red4"))
 134   "Face used for the completion annotation in the tooltip.")
 135
 136 (defface company-tooltip-annotation-selection
 137   '((default :inherit company-tooltip-annotation))
 138   "Face used for the selected completion annotation in the tooltip.")
 139
 140 (defface company-scrollbar-fg
 141   '((((background light))
 142      :background "darkred")
 143     (((background dark))
 144      :background "red"))
 145   "Face used for the tooltip scrollbar thumb.")
 146
 147 (defface company-scrollbar-bg
 148   '((((background light))
 149      :background "wheat")
 150     (((background dark))
 151      :background "gold"))
 152   "Face used for the tooltip scrollbar background.")
 153
 154 (defface company-preview
 155   '((((background light))
 156      :inherit (company-tooltip-selection company-tooltip))
 157     (((background dark))
 158      :background "blue4"
 159      :foreground "wheat"))
 160   "Face used for the completion preview.")
 161
 162 (defface company-preview-common
 163   '((((background light))
 164      :inherit company-tooltip-common-selection)
 165     (((background dark))
 166      :inherit company-preview
 167      :foreground "red"))
 168   "Face used for the common part of the completion preview.")
 169
 170 (defface company-preview-search
 171   '((((background light))
 172      :inherit company-tooltip-common-selection)
 173     (((background dark))
 174      :inherit company-preview
 175      :background "blue1"))
 176   "Face used for the search string in the completion preview.")
 177
 178 (defface company-echo nil
 179   "Face used for completions in the echo area.")
 180
 181 (defface company-echo-common
 182   '((((background dark)) (:foreground "firebrick1"))
 183     (((background light)) (:background "firebrick4")))
 184   "Face used for the common part of completions in the echo area.")
 185
 186 (defun company-frontends-set (variable value)
 187   ;; Uniquify.
 188   (let ((value (delete-dups (copy-sequence value))))
 189     (and (memq 'company-pseudo-tooltip-unless-just-one-frontend value)
 190          (memq 'company-pseudo-tooltip-frontend value)
 191          (error "Pseudo tooltip frontend cannot be used twice"))
 192     (and (memq 'company-preview-if-just-one-frontend value)
 193          (memq 'company-preview-frontend value)
 194          (error "Preview frontend cannot be used twice"))
 195     (and (memq 'company-echo value)
 196          (memq 'company-echo-metadata-frontend value)
 197          (error "Echo area cannot be used twice"))
 198     ;; Preview must come last.
 199     (dolist (f '(company-preview-if-just-one-frontend company-preview-frontend))
 200       (when (cdr (memq f value))
 201         (setq value (append (delq f value) (list f)))))
 202     (set variable value)))
 203
 204 (defcustom company-frontends '(company-pseudo-tooltip-unless-just-one-frontend
 205                                company-preview-if-just-one-frontend
 206                                company-echo-metadata-frontend)
 207   "The list of active frontends (visualizations).
 208 Each frontend is a function that takes one argument.  It is called with
 209 one of the following arguments:
 210
 211 `show': When the visualization should start.
 212
 213 `hide': When the visualization should end.
 214
 215 `update': When the data has been updated.
 216
 217 `pre-command': Before every command that is executed while the
 218 visualization is active.
 219
 220 `post-command': After every command that is executed while the
 221 visualization is active.
 222
 223 The visualized data is stored in `company-prefix', `company-candidates',
 224 `company-common', `company-selection', `company-point' and
 225 `company-search-string'."
 226   :set 'company-frontends-set
 227   :type '(repeat (choice (const :tag "echo" company-echo-frontend)
 228                          (const :tag "echo, strip common"
 229                                 company-echo-strip-common-frontend)
 230                          (const :tag "show echo meta-data in echo"
 231                                 company-echo-metadata-frontend)
 232                          (const :tag "pseudo tooltip"
 233                                 company-pseudo-tooltip-frontend)
 234                          (const :tag "pseudo tooltip, multiple only"
 235                                 company-pseudo-tooltip-unless-just-one-frontend)
 236                          (const :tag "preview" company-preview-frontend)
 237                          (const :tag "preview, unique only"
 238                                 company-preview-if-just-one-frontend)
 239                          (function :tag "custom function" nil))))
 240
 241 (defcustom company-tooltip-limit 10
 242   "The maximum number of candidates in the tooltip."
 243   :type 'integer)
 244
 245 (defcustom company-tooltip-minimum 6
 246   "The minimum height of the tooltip.
 247 If this many lines are not available, prefer to display the tooltip above."
 248   :type 'integer)
 249
 250 (defcustom company-tooltip-minimum-width 0
 251   "The minimum width of the tooltip's inner area.
 252 This doesn't include the margins and the scroll bar."
 253   :type 'integer
 254   :package-version '(company . "0.8.0"))
 255
 256 (defcustom company-tooltip-margin 1
 257   "Width of margin columns to show around the toolip."
 258   :type 'integer)
 259
 260 (defcustom company-tooltip-offset-display 'scrollbar
 261   "Method using which the tooltip displays scrolling position.
 262 `scrollbar' means draw a scrollbar to the right of the items.
 263 `lines' means wrap items in lines with \"before\" and \"after\" counters."
 264   :type '(choice (const :tag "Scrollbar" scrollbar)
 265                  (const :tag "Two lines" lines)))
 266
 267 (defcustom company-tooltip-align-annotations nil
 268   "When non-nil, align annotations to the right tooltip border."
 269   :type 'boolean
 270   :package-version '(company . "0.7.1"))
 271
 272 (defcustom company-tooltip-flip-when-above nil
 273   "Whether to flip the tooltip when it's above the current line."
 274   :type 'boolean
 275   :package-version '(company . "0.8.1"))
 276
 277 (defvar company-safe-backends
 278   '((company-abbrev . "Abbrev")
 279     (company-bbdb . "BBDB")
 280     (company-capf . "completion-at-point-functions")
 281     (company-clang . "Clang")
 282     (company-cmake . "CMake")
 283     (company-css . "CSS")
 284     (company-dabbrev . "dabbrev for plain text")
 285     (company-dabbrev-code . "dabbrev for code")
 286     (company-eclim . "Eclim (an Eclipse interface)")
 287     (company-elisp . "Emacs Lisp")
 288     (company-etags . "etags")
 289     (company-files . "Files")
 290     (company-gtags . "GNU Global")
 291     (company-ispell . "Ispell")
 292     (company-keywords . "Programming language keywords")
 293     (company-nxml . "nxml")
 294     (company-oddmuse . "Oddmuse")
 295     (company-semantic . "Semantic")
 296     (company-tempo . "Tempo templates")
 297     (company-xcode . "Xcode")))
 298 (put 'company-safe-backends 'risky-local-variable t)
 299
 300 (defun company-safe-backends-p (backends)
 301   (and (consp backends)
 302        (not (cl-dolist (backend backends)
 303               (unless (if (consp backend)
 304                           (company-safe-backends-p backend)
 305                         (assq backend company-safe-backends))
 306                 (cl-return t))))))
 307
 308 (defcustom company-backends `(,@(unless (version< "24.3.51" emacs-version)
 309                                   (list 'company-elisp))
 310                               company-bbdb
 311                               company-nxml company-css
 312                               company-eclim company-semantic company-clang
 313                               company-xcode company-cmake
 314                               company-capf
 315                               company-files
 316                               (company-dabbrev-code company-gtags company-etags
 317                                company-keywords)
 318                               company-oddmuse company-dabbrev)
 319   "The list of active backends (completion engines).
 320
 321 Only one backend is used at a time.  The choice depends on the order of
 322 the items in this list, and on the values they return in response to the
 323 `prefix' command (see below).  But a backend can also be a \"grouped\"
 324 one (see below).
 325
 326 `company-begin-backend' can be used to start a specific backend,
 327 `company-other-backend' will skip to the next matching backend in the list.
 328
 329 Each backend is a function that takes a variable number of arguments.
 330 The first argument is the command requested from the backend.  It is one
 331 of the following:
 332
 333 `prefix': The backend should return the text to be completed.  It must be
 334 text immediately before point.  Returning nil from this command passes
 335 control to the next backend.  The function should return `stop' if it
 336 should complete but cannot (e.g. if it is in the middle of a string).
 337 Instead of a string, the backend may return a cons (PREFIX . LENGTH)
 338 where LENGTH is a number used in place of PREFIX's length when
 339 comparing against `company-minimum-prefix-length'.  LENGTH can also
 340 be just t, and in the latter case the test automatically succeeds.
 341
 342 `candidates': The second argument is the prefix to be completed.  The
 343 return value should be a list of candidates that match the prefix.
 344
 345 Non-prefix matches are also supported (candidates that don't start with the
 346 prefix, but match it in some backend-defined way).  Backends that use this
 347 feature must disable cache (return t to `no-cache') and might also want to
 348 respond to `match'.
 349
 350 Optional commands
 351 =================
 352
 353 `sorted': Return t here to indicate that the candidates are sorted and will
 354 not need to be sorted again.
 355
 356 `duplicates': If non-nil, company will take care of removing duplicates
 357 from the list.
 358
 359 `no-cache': Usually company doesn't ask for candidates again as completion
 360 progresses, unless the backend returns t for this command.  The second
 361 argument is the latest prefix.
 362
 363 `ignore-case': Return t here if the backend returns case-insensitive
 364 matches.  This value is used to determine the longest common prefix (as
 365 used in `company-complete-common'), and to filter completions when fetching
 366 them from cache.
 367
 368 `meta': The second argument is a completion candidate.  Return a (short)
 369 documentation string for it.
 370
 371 `doc-buffer': The second argument is a completion candidate.  Return a
 372 buffer with documentation for it.  Preferably use `company-doc-buffer'.  If
 373 not all buffer contents pertain to this candidate, return a cons of buffer
 374 and window start position.
 375
 376 `location': The second argument is a completion candidate.  Return a cons
 377 of buffer and buffer location, or of file and line number where the
 378 completion candidate was defined.
 379
 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
 385 properties.
 386
 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.
 391
 392 `require-match': If this returns t, the user is not allowed to enter
 393 anything not offered as a candidate.  Please don't use that value in normal
 394 backends.  The default value nil gives the user that choice with
 395 `company-require-match'.  Return value `never' overrides that option the
 396 other way around.
 397
 398 `init': Called once for each buffer. The backend can check for external
 399 programs and files and load any required libraries.  Raising an error here
 400 will show up in message log once, and the backend will not be used for
 401 completion.
 402
 403 `post-completion': Called after a completion candidate has been inserted
 404 into the buffer.  The second argument is the candidate.  Can be used to
 405 modify it, e.g. to expand a snippet.
 406
 407 The backend should return nil for all commands it does not support or
 408 does not know about.  It should also be callable interactively and use
 409 `company-begin-backend' to start itself in that case.
 410
 411 Grouped backends
 412 ================
 413
 414 An element of `company-backends' can also be a list of backends.  The
 415 completions from backends in such groups are merged, but only from those
 416 backends which return the same `prefix'.
 417
 418 If a backend command takes a candidate as an argument (e.g. `meta'), the
 419 call is dispatched to the backend the candidate came from.  In other
 420 cases (except for `duplicates' and `sorted'), the first non-nil value among
 421 all the backends is returned.
 422
 423 The group can also contain keywords.  Currently, `:with' and `:sorted'
 424 keywords are defined.  If the group contains keyword `:with', the backends
 425 listed after this keyword are ignored for the purpose of the `prefix'
 426 command.  If the group contains keyword `:sorted', the final list of
 427 candidates is not sorted after concatenation.
 428
 429 Asynchronous backends
 430 =====================
 431
 432 The return value of each command can also be a cons (:async . FETCHER)
 433 where FETCHER is a function of one argument, CALLBACK.  When the data
 434 arrives, FETCHER must call CALLBACK and pass it the appropriate return
 435 value, as described above.  That call must happen in the same buffer as
 436 where completion was initiated.
 437
 438 True asynchronous operation is only supported for command `candidates', and
 439 only during idle completion.  Other commands will block the user interface,
 440 even if the backend uses the asynchronous calling convention."
 441   :type `(repeat
 442           (choice
 443            :tag "backend"
 444            ,@(mapcar (lambda (b) `(const :tag ,(cdr b) ,(car b)))
 445                      company-safe-backends)
 446            (symbol :tag "User defined")
 447            (repeat :tag "Merged backends"
 448                    (choice :tag "backend"
 449                            ,@(mapcar (lambda (b)
 450                                        `(const :tag ,(cdr b) ,(car b)))
 451                                      company-safe-backends)
 452                            (const :tag "With" :with)
 453                            (symbol :tag "User defined"))))))
 454
 455 (put 'company-backends 'safe-local-variable 'company-safe-backends-p)
 456
 457 (defcustom company-transformers nil
 458   "Functions to change the list of candidates received from backends.
 459
 460 Each function gets called with the return value of the previous one.
 461 The first one gets passed the list of candidates, already sorted and
 462 without duplicates."
 463   :type '(choice
 464           (const :tag "None" nil)
 465           (const :tag "Sort by occurrence" (company-sort-by-occurrence))
 466           (const :tag "Sort by backend importance"
 467                  (company-sort-by-backend-importance))
 468           (repeat :tag "User defined" (function))))
 469
 470 (defcustom company-completion-started-hook nil
 471   "Hook run when company starts completing.
 472 The hook is called with one argument that is non-nil if the completion was
 473 started manually."
 474   :type 'hook)
 475
 476 (defcustom company-completion-cancelled-hook nil
 477   "Hook run when company cancels completing.
 478 The hook is called with one argument that is non-nil if the completion was
 479 aborted manually."
 480   :type 'hook)
 481
 482 (defcustom company-completion-finished-hook nil
 483   "Hook run when company successfully completes.
 484 The hook is called with the selected candidate as an argument.
 485
 486 If you indend to use it to post-process candidates from a specific
 487 backend, consider using the `post-completion' command instead."
 488   :type 'hook)
 489
 490 (defcustom company-minimum-prefix-length 3
 491   "The minimum prefix length for idle completion."
 492   :type '(integer :tag "prefix length"))
 493
 494 (defcustom company-abort-manual-when-too-short nil
 495   "If enabled, cancel a manually started completion when the prefix gets
 496 shorter than both `company-minimum-prefix-length' and the length of the
 497 prefix it was started from."
 498   :type 'boolean
 499   :package-version '(company . "0.8.0"))
 500
 501 (defcustom company-require-match 'company-explicit-action-p
 502   "If enabled, disallow non-matching input.
 503 This can be a function do determine if a match is required.
 504
 505 This can be overridden by the backend, if it returns t or `never' to
 506 `require-match'.  `company-auto-complete' also takes precedence over this."
 507   :type '(choice (const :tag "Off" nil)
 508                  (function :tag "Predicate function")
 509                  (const :tag "On, if user interaction took place"
 510                         'company-explicit-action-p)
 511                  (const :tag "On" t)))
 512
 513 (defcustom company-auto-complete nil
 514   "Determines when to auto-complete.
 515 If this is enabled, all characters from `company-auto-complete-chars'
 516 trigger insertion of the selected completion candidate.
 517 This can also be a function."
 518   :type '(choice (const :tag "Off" nil)
 519                  (function :tag "Predicate function")
 520                  (const :tag "On, if user interaction took place"
 521                         'company-explicit-action-p)
 522                  (const :tag "On" t)))
 523
 524 (defcustom company-auto-complete-chars '(?\  ?\) ?.)
 525   "Determines which characters trigger auto-completion.
 526 See `company-auto-complete'.  If this is a string, each string character
 527 tiggers auto-completion.  If it is a list of syntax description characters (see
 528 `modify-syntax-entry'), all characters with that syntax auto-complete.
 529
 530 This can also be a function, which is called with the new input and should
 531 return non-nil if company should auto-complete.
 532
 533 A character that is part of a valid candidate never triggers auto-completion."
 534   :type '(choice (string :tag "Characters")
 535                  (set :tag "Syntax"
 536                       (const :tag "Whitespace" ?\ )
 537                       (const :tag "Symbol" ?_)
 538                       (const :tag "Opening parentheses" ?\()
 539                       (const :tag "Closing parentheses" ?\))
 540                       (const :tag "Word constituent" ?w)
 541                       (const :tag "Punctuation." ?.)
 542                       (const :tag "String quote." ?\")
 543                       (const :tag "Paired delimiter." ?$)
 544                       (const :tag "Expression quote or prefix operator." ?\')
 545                       (const :tag "Comment starter." ?<)
 546                       (const :tag "Comment ender." ?>)
 547                       (const :tag "Character-quote." ?/)
 548                       (const :tag "Generic string fence." ?|)
 549                       (const :tag "Generic comment fence." ?!))
 550                  (function :tag "Predicate function")))
 551
 552 (defcustom company-idle-delay .5
 553   "The idle delay in seconds until completion starts automatically.
 554 The prefix still has to satisfy `company-minimum-prefix-length' before that
 555 happens.  The value of nil means no idle completion."
 556   :type '(choice (const :tag "never (nil)" nil)
 557                  (const :tag "immediate (0)" 0)
 558                  (number :tag "seconds")))
 559
 560 (defcustom company-begin-commands '(self-insert-command
 561                                     org-self-insert-command
 562                                     orgtbl-self-insert-command
 563                                     c-scope-operator
 564                                     c-electric-colon
 565                                     c-electric-lt-gt
 566                                     c-electric-slash)
 567   "A list of commands after which idle completion is allowed.
 568 If this is t, it can show completions after any command except a few from a
 569 pre-defined list.  See `company-idle-delay'.
 570
 571 Alternatively, any command with a non-nil `company-begin' property is
 572 treated as if it was on this list."
 573   :type '(choice (const :tag "Any command" t)
 574                  (const :tag "Self insert command" '(self-insert-command))
 575                  (repeat :tag "Commands" function))
 576   :package-version '(company . "0.8.4"))
 577
 578 (defcustom company-continue-commands '(not save-buffer save-some-buffers
 579                                            save-buffers-kill-terminal
 580                                            save-buffers-kill-emacs)
 581   "A list of commands that are allowed during completion.
 582 If this is t, or if `company-begin-commands' is t, any command is allowed.
 583 Otherwise, the value must be a list of symbols.  If it starts with `not',
 584 the cdr is the list of commands that abort completion.  Otherwise, all
 585 commands except those in that list, or in `company-begin-commands', or
 586 commands in the `company-' namespace, abort completion."
 587   :type '(choice (const :tag "Any command" t)
 588                  (cons  :tag "Any except"
 589                         (const not)
 590                         (repeat :tag "Commands" function))
 591                  (repeat :tag "Commands" function)))
 592
 593 (defcustom company-show-numbers nil
 594   "If enabled, show quick-access numbers for the first ten candidates."
 595   :type '(choice (const :tag "off" nil)
 596                  (const :tag "on" t)))
 597
 598 (defcustom company-selection-wrap-around nil
 599   "If enabled, selecting item before first or after last wraps around."
 600   :type '(choice (const :tag "off" nil)
 601                  (const :tag "on" t)))
 602
 603 (defvar company-async-wait 0.03
 604   "Pause between checks to see if the value's been set when turning an
 605 asynchronous call into synchronous.")
 606
 607 (defvar company-async-timeout 2
 608   "Maximum wait time for a value to be set during asynchronous call.")
 609
 610 ;;; mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 611
 612 (defvar company-mode-map (make-sparse-keymap)
 613   "Keymap used by `company-mode'.")
 614
 615 (defvar company-active-map
 616   (let ((keymap (make-sparse-keymap)))
 617     (define-key keymap "\e\e\e" 'company-abort)
 618     (define-key keymap "\C-g" 'company-abort)
 619     (define-key keymap (kbd "M-n") 'company-select-next)
 620     (define-key keymap (kbd "M-p") 'company-select-previous)
 621     (define-key keymap (kbd "<down>") 'company-select-next-or-abort)
 622     (define-key keymap (kbd "<up>") 'company-select-previous-or-abort)
 623     (define-key keymap [remap scroll-up-command] 'company-next-page)
 624     (define-key keymap [remap scroll-down-command] 'company-previous-page)
 625     (define-key keymap [down-mouse-1] 'ignore)
 626     (define-key keymap [down-mouse-3] 'ignore)
 627     (define-key keymap [mouse-1] 'company-complete-mouse)
 628     (define-key keymap [mouse-3] 'company-select-mouse)
 629     (define-key keymap [up-mouse-1] 'ignore)
 630     (define-key keymap [up-mouse-3] 'ignore)
 631     (define-key keymap [return] 'company-complete-selection)
 632     (define-key keymap (kbd "RET") 'company-complete-selection)
 633     (define-key keymap [tab] 'company-complete-common)
 634     (define-key keymap (kbd "TAB") 'company-complete-common)
 635     (define-key keymap (kbd "<f1>") 'company-show-doc-buffer)
 636     (define-key keymap (kbd "C-h") 'company-show-doc-buffer)
 637     (define-key keymap "\C-w" 'company-show-location)
 638     (define-key keymap "\C-s" 'company-search-candidates)
 639     (define-key keymap "\C-\M-s" 'company-filter-candidates)
 640     (dotimes (i 10)
 641       (define-key keymap (read-kbd-macro (format "M-%d" i)) 'company-complete-number))
 642      keymap)
 643   "Keymap that is enabled during an active completion.")
 644
 645 (defvar company--disabled-backends nil)
 646
 647 (defun company-init-backend (backend)
 648   (and (symbolp backend)
 649        (not (fboundp backend))
 650        (ignore-errors (require backend nil t)))
 651   (cond
 652    ((symbolp backend)
 653     (condition-case err
 654         (progn
 655           (funcall backend 'init)
 656           (put backend 'company-init t))
 657       (error
 658        (put backend 'company-init 'failed)
 659        (unless (memq backend company--disabled-backends)
 660          (message "Company backend '%s' could not be initialized:\n%s"
 661                   backend (error-message-string err)))
 662        (cl-pushnew backend company--disabled-backends)
 663        nil)))
 664    ;; No initialization for lambdas.
 665    ((functionp backend) t)
 666    (t ;; Must be a list.
 667     (cl-dolist (b backend)
 668       (unless (keywordp b)
 669         (company-init-backend b))))))
 670
 671 (defcustom company-lighter-base "company"
 672   "Base string to use for the `company-mode' lighter."
 673   :type 'string
 674   :package-version '(company . "0.8.10"))
 675
 676 (defvar company-lighter '(" "
 677                           (company-candidates
 678                            (:eval
 679                             (if (consp company-backend)
 680                                 (company--group-lighter (nth company-selection
 681                                                              company-candidates)
 682                                                         company-lighter-base)
 683                               (symbol-name company-backend)))
 684                            company-lighter-base))
 685   "Mode line lighter for Company.
 686
 687 The value of this variable is a mode line template as in
 688 `mode-line-format'.")
 689
 690 (put 'company-lighter 'risky-local-variable t)
 691
 692 ;;;###autoload
 693 (define-minor-mode company-mode
 694   "\"complete anything\"; is an in-buffer completion framework.
 695 Completion starts automatically, depending on the values
 696 `company-idle-delay' and `company-minimum-prefix-length'.
 697
 698 Completion can be controlled with the commands:
 699 `company-complete-common', `company-complete-selection', `company-complete',
 700 `company-select-next', `company-select-previous'.  If these commands are
 701 called before `company-idle-delay', completion will also start.
 702
 703 Completions can be searched with `company-search-candidates' or
 704 `company-filter-candidates'.  These can be used while completion is
 705 inactive, as well.
 706
 707 The completion data is retrieved using `company-backends' and displayed
 708 using `company-frontends'.  If you want to start a specific backend, call
 709 it interactively or use `company-begin-backend'.
 710
 711 By default, the completions list is sorted alphabetically, unless the
 712 backend chooses otherwise, or `company-transformers' changes it later.
 713
 714 regular keymap (`company-mode-map'):
 715
 716 \\{company-mode-map}
 717 keymap during active completions (`company-active-map'):
 718
 719 \\{company-active-map}"
 720   nil company-lighter company-mode-map
 721   (if company-mode
 722       (progn
 723         (when (eq company-idle-delay t)
 724           (setq company-idle-delay 0)
 725           (warn "Setting `company-idle-delay' to t is deprecated.  Set it to 0 instead."))
 726         (add-hook 'pre-command-hook 'company-pre-command nil t)
 727         (add-hook 'post-command-hook 'company-post-command nil t)
 728         (mapc 'company-init-backend company-backends))
 729     (remove-hook 'pre-command-hook 'company-pre-command t)
 730     (remove-hook 'post-command-hook 'company-post-command t)
 731     (company-cancel)
 732     (kill-local-variable 'company-point)))
 733
 734 (defcustom company-global-modes t
 735   "Modes for which `company-mode' mode is turned on by `global-company-mode'.
 736 If nil, means no modes.  If t, then all major modes have it turned on.
 737 If a list, it should be a list of `major-mode' symbol names for which
 738 `company-mode' should be automatically turned on.  The sense of the list is
 739 negated if it begins with `not'.  For example:
 740  (c-mode c++-mode)
 741 means that `company-mode' is turned on for buffers in C and C++ modes only.
 742  (not message-mode)
 743 means that `company-mode' is always turned on except in `message-mode' buffers."
 744   :type '(choice (const :tag "none" nil)
 745                  (const :tag "all" t)
 746                  (set :menu-tag "mode specific" :tag "modes"
 747                       :value (not)
 748                       (const :tag "Except" not)
 749                       (repeat :inline t (symbol :tag "mode")))))
 750
 751 ;;;###autoload
 752 (define-globalized-minor-mode global-company-mode company-mode company-mode-on)
 753
 754 (defun company-mode-on ()
 755   (when (and (not (or noninteractive (eq (aref (buffer-name) 0) ?\s)))
 756              (cond ((eq company-global-modes t)
 757                     t)
 758                    ((eq (car-safe company-global-modes) 'not)
 759                     (not (memq major-mode (cdr company-global-modes))))
 760                    (t (memq major-mode company-global-modes))))
 761     (company-mode 1)))
 762
 763 (defsubst company-assert-enabled ()
 764   (unless company-mode
 765     (company-uninstall-map)
 766     (error "Company not enabled")))
 767
 768 ;;; keymaps ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 769
 770 (defvar-local company-my-keymap nil)
 771
 772 (defvar company-emulation-alist '((t . nil)))
 773
 774 (defsubst company-enable-overriding-keymap (keymap)
 775   (company-uninstall-map)
 776   (setq company-my-keymap keymap))
 777
 778 (defun company-ensure-emulation-alist ()
 779   (unless (eq 'company-emulation-alist (car emulation-mode-map-alists))
 780     (setq emulation-mode-map-alists
 781           (cons 'company-emulation-alist
 782                 (delq 'company-emulation-alist emulation-mode-map-alists)))))
 783
 784 (defun company-install-map ()
 785   (unless (or (cdar company-emulation-alist)
 786               (null company-my-keymap))
 787     (setf (cdar company-emulation-alist) company-my-keymap)))
 788
 789 (defun company-uninstall-map ()
 790   (setf (cdar company-emulation-alist) nil))
 791
 792 ;; Hack:
 793 ;; Emacs calculates the active keymaps before reading the event.  That means we
 794 ;; cannot change the keymap from a timer.  So we send a bogus command.
 795 ;; XXX: Even in Emacs 24.4, seems to be needed in the terminal.
 796 (defun company-ignore ()
 797   (interactive)
 798   (setq this-command last-command))
 799
 800 (global-set-key '[company-dummy-event] 'company-ignore)
 801
 802 (defun company-input-noop ()
 803   (push 'company-dummy-event unread-command-events))
 804
 805 (defun company--posn-col-row (posn)
 806   (let ((col (car (posn-col-row posn)))
 807         ;; `posn-col-row' doesn't work well with lines of different height.
 808         ;; `posn-actual-col-row' doesn't handle multiple-width characters.
 809         (row (cdr (or (posn-actual-col-row posn)
 810                       ;; When position is non-visible for some reason.
 811                       (posn-col-row posn)))))
 812     (when (and header-line-format (version< emacs-version "24.3.93.3"))
 813       ;; http://debbugs.gnu.org/18384
 814       (cl-decf row))
 815     (cons (+ col (window-hscroll)) row)))
 816
 817 (defun company--col-row (&optional pos)
 818   (company--posn-col-row (posn-at-point pos)))
 819
 820 (defun company--row (&optional pos)
 821   (cdr (company--col-row pos)))
 822
 823 ;;; backends ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 824
 825 (defvar-local company-backend nil)
 826
 827 (defun company-grab (regexp &optional expression limit)
 828   (when (looking-back regexp limit)
 829     (or (match-string-no-properties (or expression 0)) "")))
 830
 831 (defun company-grab-line (regexp &optional expression)
 832   "Return a match string for REGEXP if it matches text before point.
 833 If EXPRESSION is non-nil, return the match string for the respective
 834 parenthesized expression in REGEXP.
 835 Matching is limited to the current line."
 836   (let ((inhibit-field-text-motion t))
 837     (company-grab regexp expression (point-at-bol))))
 838
 839 (defun company-grab-symbol ()
 840   "If point is at the end of a symbol, return it.
 841 Otherwise, if point is not inside a symbol, return an empty string."
 842   (if (looking-at "\\_>")
 843       (buffer-substring (point) (save-excursion (skip-syntax-backward "w_")
 844                                                 (point)))
 845     (unless (and (char-after) (memq (char-syntax (char-after)) '(?w ?_)))
 846       "")))
 847
 848 (defun company-grab-word ()
 849   "If point is at the end of a word, return it.
 850 Otherwise, if point is not inside a symbol, return an empty string."
 851   (if (looking-at "\\>")
 852       (buffer-substring (point) (save-excursion (skip-syntax-backward "w")
 853                                                 (point)))
 854     (unless (and (char-after) (eq (char-syntax (char-after)) ?w))
 855       "")))
 856
 857 (defun company-grab-symbol-cons (idle-begin-after-re &optional max-len)
 858   "Return a string SYMBOL or a cons (SYMBOL . t).
 859 SYMBOL is as returned by `company-grab-symbol'.  If the text before point
 860 matches IDLE-BEGIN-AFTER-RE, return it wrapped in a cons."
 861   (let ((symbol (company-grab-symbol)))
 862     (when symbol
 863       (save-excursion
 864         (forward-char (- (length symbol)))
 865         (if (looking-back idle-begin-after-re (if max-len
 866                                                   (- (point) max-len)
 867                                                 (line-beginning-position)))
 868             (cons symbol t)
 869           symbol)))))
 870
 871 (defun company-in-string-or-comment ()
 872   "Return non-nil if point is within a string or comment."
 873   (let ((ppss (syntax-ppss)))
 874     (or (car (setq ppss (nthcdr 3 ppss)))
 875         (car (setq ppss (cdr ppss)))
 876         (nth 3 ppss))))
 877
 878 (defun company-call-backend (&rest args)
 879   (company--force-sync #'company-call-backend-raw args company-backend))
 880
 881 (defun company--force-sync (fun args backend)
 882   (let ((value (apply fun args)))
 883     (if (not (eq (car-safe value) :async))
 884         value
 885       (let ((res 'trash)
 886             (start (time-to-seconds)))
 887         (funcall (cdr value)
 888                  (lambda (result) (setq res result)))
 889         (while (eq res 'trash)
 890           (if (> (- (time-to-seconds) start) company-async-timeout)
 891               (error "Company: backend %s async timeout with args %s"
 892                      backend args)
 893             (sleep-for company-async-wait)))
 894         res))))
 895
 896 (defun company-call-backend-raw (&rest args)
 897   (condition-case-unless-debug err
 898       (if (functionp company-backend)
 899           (apply company-backend args)
 900         (apply #'company--multi-backend-adapter company-backend args))
 901     (error (error "Company: backend %s error \"%s\" with args %s"
 902                   company-backend (error-message-string err) args))))
 903
 904 (defun company--multi-backend-adapter (backends command &rest args)
 905   (let ((backends (cl-loop for b in backends
 906                            when (not (and (symbolp b)
 907                                           (eq 'failed (get b 'company-init))))
 908                            collect b)))
 909
 910     (when (eq command 'prefix)
 911       (setq backends (butlast backends (length (member :with backends)))))
 912
 913     (unless (memq command '(sorted))
 914       (setq backends (cl-delete-if #'keywordp backends)))
 915
 916     (pcase command
 917       (`candidates
 918        (company--multi-backend-adapter-candidates backends (car args)))
 919       (`sorted (memq :sorted backends))
 920       (`duplicates t)
 921       ((or `prefix `ignore-case `no-cache `require-match)
 922        (let (value)
 923          (cl-dolist (backend backends)
 924            (when (setq value (company--force-sync
 925                               backend (cons command args) backend))
 926              (cl-return value)))))
 927       (_
 928        (let ((arg (car args)))
 929          (when (> (length arg) 0)
 930            (let ((backend (or (get-text-property 0 'company-backend arg)
 931                               (car backends))))
 932              (apply backend command args))))))))
 933
 934 (defun company--multi-backend-adapter-candidates (backends prefix)
 935   (let ((pairs (cl-loop for backend in (cdr backends)
 936                         when (equal (company--prefix-str
 937                                      (funcall backend 'prefix))
 938                                     prefix)
 939                         collect (cons (funcall backend 'candidates prefix)
 940                                       (let ((b backend))
 941                                         (lambda (candidates)
 942                                           (mapcar
 943                                            (lambda (str)
 944                                              (propertize str 'company-backend b))
 945                                            candidates)))))))
 946     (when (equal (company--prefix-str (funcall (car backends) 'prefix)) prefix)
 947       ;; Small perf optimization: don't tag the candidates received
 948       ;; from the first backend in the group.
 949       (push (cons (funcall (car backends) 'candidates prefix)
 950                   'identity)
 951             pairs))
 952     (company--merge-async pairs (lambda (values) (apply #'append values)))))
 953
 954 (defun company--merge-async (pairs merger)
 955   (let ((async (cl-loop for pair in pairs
 956                         thereis
 957                         (eq :async (car-safe (car pair))))))
 958     (if (not async)
 959         (funcall merger (cl-loop for (val . mapper) in pairs
 960                                  collect (funcall mapper val)))
 961       (cons
 962        :async
 963        (lambda (callback)
 964          (let* (lst
 965                 (pending (mapcar #'car pairs))
 966                 (finisher (lambda ()
 967                             (unless pending
 968                               (funcall callback
 969                                        (funcall merger
 970                                                 (nreverse lst)))))))
 971            (dolist (pair pairs)
 972              (push nil lst)
 973              (let* ((cell lst)
 974                     (val (car pair))
 975                     (mapper (cdr pair))
 976                     (this-finisher (lambda (res)
 977                                      (setq pending (delq val pending))
 978                                      (setcar cell (funcall mapper res))
 979                                      (funcall finisher))))
 980                (if (not (eq :async (car-safe val)))
 981                    (funcall this-finisher val)
 982                  (let ((fetcher (cdr val)))
 983                    (funcall fetcher this-finisher)))))))))))
 984
 985 (defun company--prefix-str (prefix)
 986   (or (car-safe prefix) prefix))
 987
 988 ;;; completion mechanism ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 989
 990 (defvar-local company-prefix nil)
 991
 992 (defvar-local company-candidates nil)
 993
 994 (defvar-local company-candidates-length nil)
 995
 996 (defvar-local company-candidates-cache nil)
 997
 998 (defvar-local company-candidates-predicate nil)
 999
1000 (defvar-local company-common nil)
1001
1002 (defvar-local company-selection 0)
1003
1004 (defvar-local company-selection-changed nil)
1005
1006 (defvar-local company--manual-action nil
1007   "Non-nil, if manual completion took place.")
1008
1009 (defvar-local company--manual-prefix nil)
1010
1011 (defvar company--auto-completion nil
1012   "Non-nil when current candidate is being inserted automatically.
1013 Controlled by `company-auto-complete'.")
1014
1015 (defvar-local company--point-max nil)
1016
1017 (defvar-local company-point nil)
1018
1019 (defvar company-timer nil)
1020
1021 (defsubst company-strip-prefix (str)
1022   (substring str (length company-prefix)))
1023
1024 (defun company--insert-candidate (candidate)
1025   (when (> (length candidate) 0)
1026     (setq candidate (substring-no-properties candidate))
1027     ;; XXX: Return value we check here is subject to change.
1028     (if (eq (company-call-backend 'ignore-case) 'keep-prefix)
1029         (insert (company-strip-prefix candidate))
1030       (unless (equal company-prefix candidate)
1031         (delete-region (- (point) (length company-prefix)) (point))
1032         (insert candidate)))))
1033
1034 (defmacro company-with-candidate-inserted (candidate &rest body)
1035   "Evaluate BODY with CANDIDATE temporarily inserted.
1036 This is a tool for backends that need candidates inserted before they
1037 can retrieve meta-data for them."
1038   (declare (indent 1))
1039   `(let ((inhibit-modification-hooks t)
1040          (inhibit-point-motion-hooks t)
1041          (modified-p (buffer-modified-p)))
1042      (company--insert-candidate ,candidate)
1043      (unwind-protect
1044          (progn ,@body)
1045        (delete-region company-point (point))
1046        (set-buffer-modified-p modified-p))))
1047
1048 (defun company-explicit-action-p ()
1049   "Return whether explicit completion action was taken by the user."
1050   (or company--manual-action
1051       company-selection-changed))
1052
1053 (defun company-reformat (candidate)
1054   ;; company-ispell needs this, because the results are always lower-case
1055   ;; It's mory efficient to fix it only when they are displayed.
1056   ;; FIXME: Adopt the current text's capitalization instead?
1057   (if (eq (company-call-backend 'ignore-case) 'keep-prefix)
1058       (concat company-prefix (substring candidate (length company-prefix)))
1059     candidate))
1060
1061 (defun company--should-complete ()
1062   (and (eq company-idle-delay 'now)
1063        (not (or buffer-read-only overriding-terminal-local-map
1064                 overriding-local-map))
1065        ;; Check if in the middle of entering a key combination.
1066        (or (equal (this-command-keys-vector) [])
1067            (not (keymapp (key-binding (this-command-keys-vector)))))
1068        (not (and transient-mark-mode mark-active))))
1069
1070 (defun company--should-continue ()
1071   (or (eq t company-begin-commands)
1072       (eq t company-continue-commands)
1073       (if (eq 'not (car company-continue-commands))
1074           (not (memq this-command (cdr company-continue-commands)))
1075         (or (memq this-command company-begin-commands)
1076             (memq this-command company-continue-commands)
1077             (and (symbolp this-command)
1078                  (string-match-p "\\`company-" (symbol-name this-command)))))))
1079
1080 (defun company-call-frontends (command)
1081   (dolist (frontend company-frontends)
1082     (condition-case-unless-debug err
1083         (funcall frontend command)
1084       (error (error "Company: frontend %s error \"%s\" on command %s"
1085                     frontend (error-message-string err) command)))))
1086
1087 (defun company-set-selection (selection &optional force-update)
1088   (setq selection
1089         (if company-selection-wrap-around
1090             (mod selection company-candidates-length)
1091           (max 0 (min (1- company-candidates-length) selection))))
1092   (when (or force-update (not (equal selection company-selection)))
1093     (setq company-selection selection
1094           company-selection-changed t)
1095     (company-call-frontends 'update)))
1096
1097 (defun company--group-lighter (candidate base)
1098   (let ((backend (or (get-text-property 0 'company-backend candidate)
1099                      (cl-some (lambda (x) (and (not (keywordp x)) x))
1100                               company-backend))))
1101     (when (and backend (symbolp backend))
1102       (let ((name (replace-regexp-in-string "company-\\|-company" ""
1103                                             (symbol-name backend))))
1104         (format "%s-<%s>" base name)))))
1105
1106 (defun company-update-candidates (candidates)
1107   (setq company-candidates-length (length candidates))
1108   (if company-selection-changed
1109       ;; Try to restore the selection
1110       (let ((selected (nth company-selection company-candidates)))
1111         (setq company-selection 0
1112               company-candidates candidates)
1113         (when selected
1114           (catch 'found
1115             (while candidates
1116               (let ((candidate (pop candidates)))
1117                 (when (and (string= candidate selected)
1118                            (equal (company-call-backend 'annotation candidate)
1119                                   (company-call-backend 'annotation selected)))
1120                   (throw 'found t)))
1121               (cl-incf company-selection))
1122             (setq company-selection 0
1123                   company-selection-changed nil))))
1124     (setq company-selection 0
1125           company-candidates candidates))
1126   ;; Calculate common.
1127   (let ((completion-ignore-case (company-call-backend 'ignore-case)))
1128     ;; We want to support non-prefix completion, so filtering is the
1129     ;; responsibility of each respective backend, not ours.
1130     ;; On the other hand, we don't want to replace non-prefix input in
1131     ;; `company-complete-common', unless there's only one candidate.
1132     (setq company-common
1133           (if (cdr company-candidates)
1134               (let ((common (try-completion "" company-candidates)))
1135                 (when (string-prefix-p company-prefix common
1136                                        completion-ignore-case)
1137                   common))
1138             (car company-candidates)))))
1139
1140 (defun company-calculate-candidates (prefix)
1141   (let ((candidates (cdr (assoc prefix company-candidates-cache)))
1142         (ignore-case (company-call-backend 'ignore-case)))
1143     (or candidates
1144         (when company-candidates-cache
1145           (let ((len (length prefix))
1146                 (completion-ignore-case ignore-case)
1147                 prev)
1148             (cl-dotimes (i (1+ len))
1149               (when (setq prev (cdr (assoc (substring prefix 0 (- len i))
1150                                            company-candidates-cache)))
1151                 (setq candidates (all-completions prefix prev))
1152                 (cl-return t)))))
1153         (progn
1154           ;; No cache match, call the backend.
1155           (setq candidates (company--preprocess-candidates
1156                             (company--fetch-candidates prefix)))
1157           ;; Save in cache.
1158           (push (cons prefix candidates) company-candidates-cache)))
1159     ;; Only now apply the predicate and transformers.
1160     (setq candidates (company--postprocess-candidates candidates))
1161     (when candidates
1162       (if (or (cdr candidates)
1163               (not (eq t (compare-strings (car candidates) nil nil
1164                                           prefix nil nil ignore-case))))
1165           candidates
1166         ;; Already completed and unique; don't start.
1167         t))))
1168
1169 (defun company--fetch-candidates (prefix)
1170   (let* ((non-essential (not (company-explicit-action-p)))
1171          (c (if company--manual-action
1172                 (company-call-backend 'candidates prefix)
1173               (company-call-backend-raw 'candidates prefix)))
1174          res)
1175     (if (not (eq (car c) :async))
1176         c
1177       (let ((buf (current-buffer))
1178             (win (selected-window))
1179             (tick (buffer-chars-modified-tick))
1180             (pt (point))
1181             (backend company-backend))
1182         (funcall
1183          (cdr c)
1184          (lambda (candidates)
1185            (if (not (and candidates (eq res 'done)))
1186                ;; There's no completions to display,
1187                ;; or the fetcher called us back right away.
1188                (setq res candidates)
1189              (setq company-backend backend
1190                    company-candidates-cache
1191                    (list (cons prefix
1192                                (company--preprocess-candidates candidates))))
1193              (unwind-protect
1194                  (company-idle-begin buf win tick pt)
1195                (unless company-candidates
1196                  (setq company-backend nil
1197                        company-candidates-cache nil)))))))
1198       ;; FIXME: Relying on the fact that the callers
1199       ;; will interpret nil as "do nothing" is shaky.
1200       ;; A throw-catch would be one possible improvement.
1201       (or res
1202           (progn (setq res 'done) nil)))))
1203
1204 (defun company--preprocess-candidates (candidates)
1205   (unless (company-call-backend 'sorted)
1206     (setq candidates (sort candidates 'string<)))
1207   (when (company-call-backend 'duplicates)
1208     (setq candidates (company--strip-duplicates candidates)))
1209   candidates)
1210
1211 (defun company--postprocess-candidates (candidates)
1212   (when (or company-candidates-predicate company-transformers)
1213     (setq candidates (copy-sequence candidates)))
1214   (when company-candidates-predicate
1215     (setq candidates (cl-delete-if-not company-candidates-predicate candidates)))
1216   (company--transform-candidates candidates))
1217
1218 (defun company--strip-duplicates (candidates)
1219   (let* ((annos 'unk)
1220          (str (car candidates))
1221          (ref (cdr candidates))
1222          res str2 anno2)
1223     (while ref
1224       (setq str2 (pop ref))
1225       (if (not (equal str str2))
1226           (progn
1227             (push str res)
1228             (setq str str2)
1229             (setq annos 'unk))
1230         (setq anno2 (company-call-backend
1231                      'annotation str2))
1232         (cond
1233          ((null anno2))             ; Skip it.
1234          ((when (eq annos 'unk)
1235             (let ((ann1 (company-call-backend 'annotation str)))
1236               (if (null ann1)
1237                   ;; No annotation on the earlier element, drop it.
1238                   t
1239                 (setq annos (list ann1))
1240                 nil)))
1241           (setq annos (list anno2))
1242           (setq str str2))
1243          ((member anno2 annos))     ; Also skip.
1244          (t
1245           (push anno2 annos)
1246           (push str res)            ; Maintain ordering.
1247           (setq str str2)))))
1248     (when str (push str res))
1249     (nreverse res)))
1250
1251 (defun company--transform-candidates (candidates)
1252   (let ((c candidates))
1253     (dolist (tr company-transformers)
1254       (setq c (funcall tr c)))
1255     c))
1256
1257 (defcustom company-occurrence-weight-function
1258   #'company-occurrence-prefer-closest-above
1259   "Function to weigh matches in `company-sort-by-occurrence'.
1260 It's called with three arguments: cursor position, the beginning and the
1261 end of the match."
1262   :type '(choice
1263           (const :tag "First above point, then below point"
1264                  company-occurrence-prefer-closest-above)
1265           (const :tag "Prefer closest in any direction"
1266                  company-occurrence-prefer-any-closest)))
1267
1268 (defun company-occurrence-prefer-closest-above (pos match-beg match-end)
1269   "Give priority to the matches above point, then those below point."
1270   (if (< match-beg pos)
1271       (- pos match-end)
1272     (- match-beg (window-start))))
1273
1274 (defun company-occurrence-prefer-any-closest (pos _match-beg match-end)
1275   "Give priority to the matches closest to the point."
1276   (abs (- pos match-end)))
1277
1278 (defun company-sort-by-occurrence (candidates)
1279   "Sort CANDIDATES according to their occurrences.
1280 Searches for each in the currently visible part of the current buffer and
1281 prioritizes the matches according to `company-occurrence-weight-function'.
1282 The rest of the list is appended unchanged.
1283 Keywords and function definition names are ignored."
1284   (let* ((w-start (window-start))
1285          (w-end (window-end))
1286          (start-point (point))
1287          occurs
1288          (noccurs
1289           (save-excursion
1290             (cl-delete-if
1291              (lambda (candidate)
1292                (when (catch 'done
1293                        (goto-char w-start)
1294                        (while (search-forward candidate w-end t)
1295                          (when (and (not (eq (point) start-point))
1296                                     (save-match-data
1297                                       (company--occurrence-predicate)))
1298                            (throw 'done t))))
1299                  (push
1300                   (cons candidate
1301                         (funcall company-occurrence-weight-function
1302                                  start-point
1303                                  (match-beginning 0)
1304                                  (match-end 0)))
1305                   occurs)
1306                  t))
1307              candidates))))
1308     (nconc
1309      (mapcar #'car (sort occurs (lambda (e1 e2) (<= (cdr e1) (cdr e2)))))
1310      noccurs)))
1311
1312 (defun company--occurrence-predicate ()
1313   (let ((beg (match-beginning 0))
1314         (end (match-end 0)))
1315     (save-excursion
1316       (goto-char end)
1317       (and (not (memq (get-text-property (1- (point)) 'face)
1318                       '(font-lock-function-name-face
1319                         font-lock-keyword-face)))
1320            (let ((prefix (company--prefix-str
1321                           (company-call-backend 'prefix))))
1322              (and (stringp prefix)
1323                   (= (length prefix) (- end beg))))))))
1324
1325 (defun company-sort-by-backend-importance (candidates)
1326   "Sort CANDIDATES as two priority groups.
1327 If `company-backend' is a function, do nothing.  If it's a list, move
1328 candidates from backends before keyword `:with' to the front.  Candidates
1329 from the rest of the backends in the group, if any, will be left at the end."
1330   (if (functionp company-backend)
1331       candidates
1332     (let ((low-priority (cdr (memq :with company-backend))))
1333       (if (null low-priority)
1334           candidates
1335         (sort candidates
1336               (lambda (c1 c2)
1337                 (and
1338                  (let ((b2 (get-text-property 0 'company-backend c2)))
1339                    (and b2 (memq b2 low-priority)))
1340                  (let ((b1 (get-text-property 0 'company-backend c1)))
1341                    (or (not b1) (not (memq b1 low-priority)))))))))))
1342
1343 (defun company-idle-begin (buf win tick pos)
1344   (and (eq buf (current-buffer))
1345        (eq win (selected-window))
1346        (eq tick (buffer-chars-modified-tick))
1347        (eq pos (point))
1348        (when (company-auto-begin)
1349          (company-input-noop)
1350          (let ((this-command 'company-idle-begin))
1351            (company-post-command)))))
1352
1353 (defun company-auto-begin ()
1354   (and company-mode
1355        (not company-candidates)
1356        (let ((company-idle-delay 'now))
1357          (condition-case-unless-debug err
1358              (progn
1359                (company--perform)
1360                ;; Return non-nil if active.
1361                company-candidates)
1362            (error (message "Company: An error occurred in auto-begin")
1363                   (message "%s" (error-message-string err))
1364                   (company-cancel))
1365            (quit (company-cancel))))))
1366
1367 ;;;###autoload
1368 (defun company-manual-begin ()
1369   (interactive)
1370   (company-assert-enabled)
1371   (setq company--manual-action t)
1372   (unwind-protect
1373       (let ((company-minimum-prefix-length 0))
1374         (or company-candidates
1375             (company-auto-begin)))
1376     (unless company-candidates
1377       (setq company--manual-action nil))))
1378
1379 (defun company-other-backend (&optional backward)
1380   (interactive (list current-prefix-arg))
1381   (company-assert-enabled)
1382   (let* ((after (if company-backend
1383                     (cdr (member company-backend company-backends))
1384                   company-backends))
1385          (before (cdr (member company-backend (reverse company-backends))))
1386          (next (if backward
1387                    (append before (reverse after))
1388                  (append after (reverse before)))))
1389     (company-cancel)
1390     (cl-dolist (backend next)
1391       (when (ignore-errors (company-begin-backend backend))
1392         (cl-return t))))
1393   (unless company-candidates
1394     (error "No other backend")))
1395
1396 (defun company-require-match-p ()
1397   (let ((backend-value (company-call-backend 'require-match)))
1398     (or (eq backend-value t)
1399         (and (not (eq backend-value 'never))
1400              (if (functionp company-require-match)
1401                  (funcall company-require-match)
1402                (eq company-require-match t))))))
1403
1404 (defun company-auto-complete-p (input)
1405   "Return non-nil, if input starts with punctuation or parentheses."
1406   (and (if (functionp company-auto-complete)
1407            (funcall company-auto-complete)
1408          company-auto-complete)
1409        (if (functionp company-auto-complete-chars)
1410            (funcall company-auto-complete-chars input)
1411          (if (consp company-auto-complete-chars)
1412              (memq (char-syntax (string-to-char input))
1413                    company-auto-complete-chars)
1414            (string-match (substring input 0 1) company-auto-complete-chars)))))
1415
1416 (defun company--incremental-p ()
1417   (and (> (point) company-point)
1418        (> (point-max) company--point-max)
1419        (not (eq this-command 'backward-delete-char-untabify))
1420        (equal (buffer-substring (- company-point (length company-prefix))
1421                                 company-point)
1422               company-prefix)))
1423
1424 (defun company--continue-failed (new-prefix)
1425   (let ((input (buffer-substring-no-properties (point) company-point)))
1426     (cond
1427      ((company-auto-complete-p input)
1428       ;; auto-complete
1429       (save-excursion
1430         (goto-char company-point)
1431         (let ((company--auto-completion t))
1432           (company-complete-selection))
1433         nil))
1434      ((and (or (not (company-require-match-p))
1435                ;; Don't require match if the new prefix
1436                ;; doesn't continue the old one, and the latter was a match.
1437                (not (stringp new-prefix))
1438                (<= (length new-prefix) (length company-prefix)))
1439            (member company-prefix company-candidates))
1440       ;; Last input was a success,
1441       ;; but we're treating it as an abort + input anyway,
1442       ;; like the `unique' case below.
1443       (company-cancel 'non-unique))
1444      ((company-require-match-p)
1445       ;; Wrong incremental input, but required match.
1446       (delete-char (- (length input)))
1447       (ding)
1448       (message "Matching input is required")
1449       company-candidates)
1450      (t (company-cancel)))))
1451
1452 (defun company--good-prefix-p (prefix)
1453   (and (stringp (company--prefix-str prefix)) ;excludes 'stop
1454        (or (eq (cdr-safe prefix) t)
1455            (let ((len (or (cdr-safe prefix) (length prefix))))
1456              (if company--manual-prefix
1457                  (or (not company-abort-manual-when-too-short)
1458                      ;; Must not be less than minimum or initial length.
1459                      (>= len (min company-minimum-prefix-length
1460                                   (length company--manual-prefix))))
1461                (>= len company-minimum-prefix-length))))))
1462
1463 (defun company--continue ()
1464   (when (company-call-backend 'no-cache company-prefix)
1465     ;; Don't complete existing candidates, fetch new ones.
1466     (setq company-candidates-cache nil))
1467   (let* ((new-prefix (company-call-backend 'prefix))
1468          (c (when (and (company--good-prefix-p new-prefix)
1469                        (setq new-prefix (company--prefix-str new-prefix))
1470                        (= (- (point) (length new-prefix))
1471                           (- company-point (length company-prefix))))
1472               (company-calculate-candidates new-prefix))))
1473     (cond
1474      ((eq c t)
1475       ;; t means complete/unique.
1476       ;; Handle it like completion was aborted, to differentiate from user
1477       ;; calling one of Company's commands to insert the candidate,
1478       ;; not to trigger template expansion, etc.
1479       (company-cancel 'unique))
1480      ((consp c)
1481       ;; incremental match
1482       (setq company-prefix new-prefix)
1483       (company-update-candidates c)
1484       c)
1485      ((not (company--incremental-p))
1486       (company-cancel))
1487      (t (company--continue-failed new-prefix)))))
1488
1489 (defun company--begin-new ()
1490   (let (prefix c)
1491     (cl-dolist (backend (if company-backend
1492                             ;; prefer manual override
1493                             (list company-backend)
1494                           company-backends))
1495       (setq prefix
1496             (if (or (symbolp backend)
1497                     (functionp backend))
1498                 (when (or (not (symbolp backend))
1499                           (eq t (get backend 'company-init))
1500                           (unless (get backend 'company-init)
1501                             (company-init-backend backend)))
1502                   (funcall backend 'prefix))
1503               (company--multi-backend-adapter backend 'prefix)))
1504       (when prefix
1505         (when (company--good-prefix-p prefix)
1506           (setq company-prefix (company--prefix-str prefix)
1507                 company-backend backend
1508                 c (company-calculate-candidates company-prefix))
1509           (if (not (consp c))
1510               (progn
1511                 (when company--manual-action
1512                   (message "No completion found"))
1513                 (when (eq c t)
1514                   ;; t means complete/unique.
1515                   ;; Run the hooks anyway, to e.g. clear the cache.
1516                   (company-cancel 'unique)))
1517             (when company--manual-action
1518               (setq company--manual-prefix prefix))
1519             (company-update-candidates c)
1520             (run-hook-with-args 'company-completion-started-hook
1521                                 (company-explicit-action-p))
1522             (company-call-frontends 'show)))
1523         (cl-return c)))))
1524
1525 (defun company--perform ()
1526   (or (and company-candidates (company--continue))
1527       (and (company--should-complete) (company--begin-new)))
1528   (if (not company-candidates)
1529       (setq company-backend nil)
1530     (setq company-point (point)
1531           company--point-max (point-max))
1532     (company-ensure-emulation-alist)
1533     (company-enable-overriding-keymap company-active-map)
1534     (company-call-frontends 'update)))
1535
1536 (defun company-cancel (&optional result)
1537   (let ((prefix company-prefix)
1538         (backend company-backend))
1539     (setq company-backend nil
1540           company-prefix nil
1541           company-candidates nil
1542           company-candidates-length nil
1543           company-candidates-cache nil
1544           company-candidates-predicate nil
1545           company-common nil
1546           company-selection 0
1547           company-selection-changed nil
1548           company--manual-action nil
1549           company--manual-prefix nil
1550           company--point-max nil
1551           company-point nil)
1552     (when company-timer
1553       (cancel-timer company-timer))
1554     (company-echo-cancel t)
1555     (company-search-mode 0)
1556     (company-call-frontends 'hide)
1557     (company-enable-overriding-keymap nil)
1558     (when prefix
1559       ;; FIXME: RESULT can also be e.g. `unique'.  We should call
1560       ;; `company-completion-finished-hook' in that case, with right argument.
1561       (if (stringp result)
1562           (let ((company-backend backend))
1563             (company-call-backend 'pre-completion result)
1564             (run-hook-with-args 'company-completion-finished-hook result)
1565             (company-call-backend 'post-completion result))
1566         (run-hook-with-args 'company-completion-cancelled-hook result))))
1567   ;; Make return value explicit.
1568   nil)
1569
1570 (defun company-abort ()
1571   (interactive)
1572   (company-cancel 'abort))
1573
1574 (defun company-finish (result)
1575   (company--insert-candidate result)
1576   (company-cancel result))
1577
1578 (defsubst company-keep (command)
1579   (and (symbolp command) (get command 'company-keep)))
1580
1581 (defun company-pre-command ()
1582   (company--electric-restore-window-configuration)
1583   (unless (company-keep this-command)
1584     (condition-case-unless-debug err
1585         (when company-candidates
1586           (company-call-frontends 'pre-command)
1587           (unless (company--should-continue)
1588             (company-abort)))
1589       (error (message "Company: An error occurred in pre-command")
1590              (message "%s" (error-message-string err))
1591              (company-cancel))))
1592   (when company-timer
1593     (cancel-timer company-timer)
1594     (setq company-timer nil))
1595   (company-echo-cancel t)
1596   (company-uninstall-map))
1597
1598 (defun company-post-command ()
1599   (when (and company-candidates
1600              (null this-command))
1601     ;; Happens when the user presses `C-g' while inside
1602     ;; `flyspell-post-command-hook', for example.
1603     ;; Or any other `post-command-hook' function that can call `sit-for',
1604     ;; or any quittable timer function.
1605     (company-abort)
1606     (setq this-command 'company-abort))
1607   (unless (company-keep this-command)
1608     (condition-case-unless-debug err
1609         (progn
1610           (unless (equal (point) company-point)
1611             (let (company-idle-delay) ; Against misbehavior while debugging.
1612               (company--perform)))
1613           (if company-candidates
1614               (company-call-frontends 'post-command)
1615             (and (numberp company-idle-delay)
1616                  (not defining-kbd-macro)
1617                  (company--should-begin)
1618                  (setq company-timer
1619                        (run-with-timer company-idle-delay nil
1620                                        'company-idle-begin
1621                                        (current-buffer) (selected-window)
1622                                        (buffer-chars-modified-tick) (point))))))
1623       (error (message "Company: An error occurred in post-command")
1624              (message "%s" (error-message-string err))
1625              (company-cancel))))
1626   (company-install-map))
1627
1628 (defvar company--begin-inhibit-commands '(company-abort
1629                                           company-complete-mouse
1630                                           company-complete
1631                                           company-complete-common
1632                                           company-complete-selection
1633                                           company-complete-number)
1634   "List of commands after which idle completion is (still) disabled when
1635 `company-begin-commands' is t.")
1636
1637 (defun company--should-begin ()
1638   (if (eq t company-begin-commands)
1639       (not (memq this-command company--begin-inhibit-commands))
1640     (or
1641      (memq this-command company-begin-commands)
1642      (and (symbolp this-command) (get this-command 'company-begin)))))
1643
1644 ;;; search ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1645
1646 (defcustom company-search-regexp-function #'regexp-quote
1647   "Function to construct the search regexp from input.
1648 It's called with one argument, the current search input.  It must return
1649 either a regexp without groups, or one where groups don't intersect and
1650 each one wraps a part of the input string."
1651   :type '(choice
1652           (const :tag "Exact match" regexp-quote)
1653           (const :tag "Words separated with spaces" company-search-words-regexp)
1654           (const :tag "Words separated with spaces, in any order"
1655                  company-search-words-in-any-order-regexp)
1656           (const :tag "All characters in given order, with anything in between"
1657                  company-search-flex-regexp)))
1658
1659 (defvar-local company-search-string "")
1660
1661 (defvar company-search-lighter '(" "
1662                                  (company-search-filtering "Filter" "Search")
1663                                  ": \""
1664                                  company-search-string
1665                                  "\""))
1666
1667 (defvar-local company-search-filtering nil
1668   "Non-nil to filter the completion candidates by the search string")
1669
1670 (defvar-local company--search-old-selection 0)
1671
1672 (defvar-local company--search-old-changed nil)
1673
1674 (defun company-search-words-regexp (input)
1675   (mapconcat (lambda (word) (format "\\(%s\\)" (regexp-quote word)))
1676              (split-string input " +" t) ".*"))
1677
1678 (defun company-search-words-in-any-order-regexp (input)
1679   (let* ((words (mapcar (lambda (word) (format "\\(%s\\)" (regexp-quote word)))
1680                         (split-string input " +" t)))
1681          (permutations (company--permutations words)))
1682     (mapconcat (lambda (words)
1683                  (mapconcat #'identity words ".*"))
1684                permutations
1685                "\\|")))
1686
1687 (defun company-search-flex-regexp (input)
1688   (if (zerop (length input))
1689       ""
1690     (concat (regexp-quote (string (aref input 0)))
1691             (mapconcat (lambda (c)
1692                          (concat "[^" (string c) "]*"
1693                                  (regexp-quote (string c))))
1694                        (substring input 1) ""))))
1695
1696 (defun company--permutations (lst)
1697   (if (not lst)
1698       '(nil)
1699     (cl-mapcan
1700      (lambda (e)
1701        (mapcar (lambda (perm) (cons e perm))
1702                (company--permutations (cl-remove e lst :count 1))))
1703      lst)))
1704
1705 (defun company--search (text lines)
1706   (let ((re (funcall company-search-regexp-function text))
1707         (i 0))
1708     (cl-dolist (line lines)
1709       (when (string-match-p re line (length company-prefix))
1710         (cl-return i))
1711       (cl-incf i))))
1712
1713 (defun company-search-keypad ()
1714   (interactive)
1715   (let* ((name (symbol-name last-command-event))
1716          (last-command-event (aref name (1- (length name)))))
1717     (company-search-printing-char)))
1718
1719 (defun company-search-printing-char ()
1720   (interactive)
1721   (company--search-assert-enabled)
1722   (let ((ss (concat company-search-string (string last-command-event))))
1723     (when company-search-filtering
1724       (company--search-update-predicate ss))
1725     (company--search-update-string ss)))
1726
1727 (defun company--search-update-predicate (ss)
1728   (let* ((re (funcall company-search-regexp-function ss))
1729          (company-candidates-predicate
1730           (and (not (string= re ""))
1731                company-search-filtering
1732                (lambda (candidate) (string-match re candidate))))
1733          (cc (company-calculate-candidates company-prefix)))
1734     (unless cc (error "No match"))
1735     (company-update-candidates cc)))
1736
1737 (defun company--search-update-string (new)
1738   (let* ((pos (company--search new (nthcdr company-selection company-candidates))))
1739     (if (null pos)
1740         (ding)
1741       (setq company-search-string new)
1742       (company-set-selection (+ company-selection pos) t))))
1743
1744 (defun company--search-assert-input ()
1745   (company--search-assert-enabled)
1746   (when (string= company-search-string "")
1747     (error "Empty search string")))
1748
1749 (defun company-search-repeat-forward ()
1750   "Repeat the incremental search in completion candidates forward."
1751   (interactive)
1752   (company--search-assert-input)
1753   (let ((pos (company--search company-search-string
1754                               (cdr (nthcdr company-selection
1755                                            company-candidates)))))
1756     (if (null pos)
1757         (ding)
1758       (company-set-selection (+ company-selection pos 1) t))))
1759
1760 (defun company-search-repeat-backward ()
1761   "Repeat the incremental search in completion candidates backwards."
1762   (interactive)
1763   (company--search-assert-input)
1764   (let ((pos (company--search company-search-string
1765                               (nthcdr (- company-candidates-length
1766                                          company-selection)
1767                                       (reverse company-candidates)))))
1768     (if (null pos)
1769         (ding)
1770       (company-set-selection (- company-selection pos 1) t))))
1771
1772 (defun company-search-toggle-filtering ()
1773   "Toggle `company-search-filtering'."
1774   (interactive)
1775   (company--search-assert-enabled)
1776   (setq company-search-filtering (not company-search-filtering))
1777   (let ((ss company-search-string))
1778     (company--search-update-predicate ss)
1779     (company--search-update-string ss)))
1780
1781 (defun company-search-abort ()
1782   "Abort searching the completion candidates."
1783   (interactive)
1784   (company--search-assert-enabled)
1785   (company-search-mode 0)
1786   (company-set-selection company--search-old-selection t)
1787   (setq company-selection-changed company--search-old-changed))
1788
1789 (defun company-search-other-char ()
1790   (interactive)
1791   (company--search-assert-enabled)
1792   (company-search-mode 0)
1793   (company--unread-last-input))
1794
1795 (defun company-search-delete-char ()
1796   (interactive)
1797   (company--search-assert-enabled)
1798   (if (string= company-search-string "")
1799       (ding)
1800     (let ((ss (substring company-search-string 0 -1)))
1801       (when company-search-filtering
1802         (company--search-update-predicate ss))
1803       (company--search-update-string ss))))
1804
1805 (defvar company-search-map
1806   (let ((i 0)
1807         (keymap (make-keymap)))
1808     (if (fboundp 'max-char)
1809         (set-char-table-range (nth 1 keymap) (cons #x100 (max-char))
1810                               'company-search-printing-char)
1811       (with-no-warnings
1812         ;; obsolete in Emacs 23
1813         (let ((l (generic-character-list))
1814               (table (nth 1 keymap)))
1815           (while l
1816             (set-char-table-default table (car l) 'company-search-printing-char)
1817             (setq l (cdr l))))))
1818     (define-key keymap [t] 'company-search-other-char)
1819     (while (< i ?\s)
1820       (define-key keymap (make-string 1 i) 'company-search-other-char)
1821       (cl-incf i))
1822     (while (< i 256)
1823       (define-key keymap (vector i) 'company-search-printing-char)
1824       (cl-incf i))
1825     (dotimes (i 10)
1826       (define-key keymap (read (format "[kp-%s]" i)) 'company-search-keypad))
1827     (let ((meta-map (make-sparse-keymap)))
1828       (define-key keymap (char-to-string meta-prefix-char) meta-map)
1829       (define-key keymap [escape] meta-map))
1830     (define-key keymap (vector meta-prefix-char t) 'company-search-other-char)
1831     (define-key keymap (kbd "M-n") 'company-select-next)
1832     (define-key keymap (kbd "M-p") 'company-select-previous)
1833     (define-key keymap (kbd "<down>") 'company-select-next-or-abort)
1834     (define-key keymap (kbd "<up>") 'company-select-previous-or-abort)
1835     (define-key keymap "\e\e\e" 'company-search-other-char)
1836     (define-key keymap [escape escape escape] 'company-search-other-char)
1837     (define-key keymap (kbd "DEL") 'company-search-delete-char)
1838     (define-key keymap [backspace] 'company-search-delete-char)
1839     (define-key keymap "\C-g" 'company-search-abort)
1840     (define-key keymap "\C-s" 'company-search-repeat-forward)
1841     (define-key keymap "\C-r" 'company-search-repeat-backward)
1842     (define-key keymap "\C-o" 'company-search-toggle-filtering)
1843     (dotimes (i 10)
1844       (define-key keymap (read-kbd-macro (format "M-%d" i)) 'company-complete-number))
1845     keymap)
1846   "Keymap used for incrementally searching the completion candidates.")
1847
1848 (define-minor-mode company-search-mode
1849   "Search mode for completion candidates.
1850 Don't start this directly, use `company-search-candidates' or
1851 `company-filter-candidates'."
1852   nil company-search-lighter nil
1853   (if company-search-mode
1854       (if (company-manual-begin)
1855           (progn
1856             (setq company--search-old-selection company-selection
1857                   company--search-old-changed company-selection-changed)
1858             (company-call-frontends 'update)
1859             (company-enable-overriding-keymap company-search-map))
1860         (setq company-search-mode nil))
1861     (kill-local-variable 'company-search-string)
1862     (kill-local-variable 'company-search-filtering)
1863     (kill-local-variable 'company--search-old-selection)
1864     (kill-local-variable 'company--search-old-changed)
1865     (when company-backend
1866       (company--search-update-predicate "")
1867       (company-call-frontends 'update))
1868     (company-enable-overriding-keymap company-active-map)))
1869
1870 (defun company--search-assert-enabled ()
1871   (company-assert-enabled)
1872   (unless company-search-mode
1873     (company-uninstall-map)
1874     (error "Company not in search mode")))
1875
1876 (defun company-search-candidates ()
1877   "Start searching the completion candidates incrementally.
1878
1879 \\<company-search-map>Search can be controlled with the commands:
1880 - `company-search-repeat-forward' (\\[company-search-repeat-forward])
1881 - `company-search-repeat-backward' (\\[company-search-repeat-backward])
1882 - `company-search-abort' (\\[company-search-abort])
1883 - `company-search-delete-char' (\\[company-search-delete-char])
1884
1885 Regular characters are appended to the search string.
1886
1887 Customize `company-search-regexp-function' to change how the input
1888 is interpreted when searching.
1889
1890 The command `company-search-toggle-filtering' (\\[company-search-toggle-filtering])
1891 uses the search string to filter the completion candidates."
1892   (interactive)
1893   (company-search-mode 1))
1894
1895 (defvar company-filter-map
1896   (let ((keymap (make-keymap)))
1897     (define-key keymap [remap company-search-printing-char]
1898       'company-filter-printing-char)
1899     (set-keymap-parent keymap company-search-map)
1900     keymap)
1901   "Keymap used for incrementally searching the completion candidates.")
1902
1903 (defun company-filter-candidates ()
1904   "Start filtering the completion candidates incrementally.
1905 This works the same way as `company-search-candidates' immediately
1906 followed by `company-search-toggle-filtering'."
1907   (interactive)
1908   (company-search-mode 1)
1909   (setq company-search-filtering t))
1910
1911 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1912
1913 (defun company-select-next (&optional arg)
1914   "Select the next candidate in the list.
1915
1916 With ARG, move by that many elements."
1917   (interactive "p")
1918   (when (company-manual-begin)
1919     (company-set-selection (+ (or arg 1) company-selection))))
1920
1921 (defun company-select-previous (&optional arg)
1922   "Select the previous candidate in the list.
1923
1924 With ARG, move by that many elements."
1925   (interactive "p")
1926   (company-select-next (if arg (- arg) -1)))
1927
1928 (defun company-select-next-or-abort (&optional arg)
1929   "Select the next candidate if more than one, else abort
1930 and invoke the normal binding.
1931
1932 With ARG, move by that many elements."
1933   (interactive "p")
1934   (if (> company-candidates-length 1)
1935       (company-select-next arg)
1936     (company-abort)
1937     (company--unread-last-input)))
1938
1939 (defun company-select-previous-or-abort (&optional arg)
1940   "Select the previous candidate if more than one, else abort
1941 and invoke the normal binding.
1942
1943 With ARG, move by that many elements."
1944   (interactive "p")
1945   (if (> company-candidates-length 1)
1946       (company-select-previous arg)
1947     (company-abort)
1948     (company--unread-last-input)))
1949
1950 (defun company-next-page ()
1951   "Select the candidate one page further."
1952   (interactive)
1953   (when (company-manual-begin)
1954     (company-set-selection (+ company-selection
1955                               company-tooltip-limit))))
1956
1957 (defun company-previous-page ()
1958   "Select the candidate one page earlier."
1959   (interactive)
1960   (when (company-manual-begin)
1961     (company-set-selection (- company-selection
1962                               company-tooltip-limit))))
1963
1964 (defvar company-pseudo-tooltip-overlay)
1965
1966 (defvar company-tooltip-offset)
1967
1968 (defun company--inside-tooltip-p (event-col-row row height)
1969   (let* ((ovl company-pseudo-tooltip-overlay)
1970          (column (overlay-get ovl 'company-column))
1971          (width (overlay-get ovl 'company-width))
1972          (evt-col (car event-col-row))
1973          (evt-row (cdr event-col-row)))
1974     (and (>= evt-col column)
1975          (< evt-col (+ column width))
1976          (if (> height 0)
1977              (and (> evt-row row)
1978                   (<= evt-row (+ row height) ))
1979            (and (< evt-row row)
1980                 (>= evt-row (+ row height)))))))
1981
1982 (defun company--event-col-row (event)
1983   (company--posn-col-row (event-start event)))
1984
1985 (defun company-select-mouse (event)
1986   "Select the candidate picked by the mouse."
1987   (interactive "e")
1988   (let ((event-col-row (company--event-col-row event))
1989         (ovl-row (company--row))
1990         (ovl-height (and company-pseudo-tooltip-overlay
1991                          (min (overlay-get company-pseudo-tooltip-overlay
1992                                            'company-height)
1993                               company-candidates-length))))
1994     (if (and ovl-height
1995              (company--inside-tooltip-p event-col-row ovl-row ovl-height))
1996         (progn
1997           (company-set-selection (+ (cdr event-col-row)
1998                                     (1- company-tooltip-offset)
1999                                     (if (and (eq company-tooltip-offset-display 'lines)
2000                                              (not (zerop company-tooltip-offset)))
2001                                         -1 0)
2002                                     (- ovl-row)
2003                                     (if (< ovl-height 0)
2004                                         (- 1 ovl-height)
2005                                       0)))
2006           t)
2007       (company-abort)
2008       (company--unread-last-input)
2009       nil)))
2010
2011 (defun company-complete-mouse (event)
2012   "Insert the candidate picked by the mouse."
2013   (interactive "e")
2014   (when (company-select-mouse event)
2015     (company-complete-selection)))
2016
2017 (defun company-complete-selection ()
2018   "Insert the selected candidate."
2019   (interactive)
2020   (when (company-manual-begin)
2021     (let ((result (nth company-selection company-candidates)))
2022       (company-finish result))))
2023
2024 (defun company-complete-common ()
2025   "Insert the common part of all candidates."
2026   (interactive)
2027   (when (company-manual-begin)
2028     (if (and (not (cdr company-candidates))
2029              (equal company-common (car company-candidates)))
2030         (company-complete-selection)
2031       (company--insert-candidate company-common))))
2032
2033 (defun company-complete-common-or-cycle (&optional arg)
2034   "Insert the common part of all candidates, or select the next one.
2035
2036 With ARG, move by that many elements."
2037   (interactive "p")
2038   (when (company-manual-begin)
2039     (let ((tick (buffer-chars-modified-tick)))
2040       (call-interactively 'company-complete-common)
2041       (when (eq tick (buffer-chars-modified-tick))
2042         (let ((company-selection-wrap-around t)
2043               (current-prefix-arg arg))
2044           (call-interactively 'company-select-next))))))
2045
2046 (defun company-indent-or-complete-common ()
2047   "Indent the current line or region, or complete the common part."
2048   (interactive)
2049   (cond
2050    ((use-region-p)
2051     (indent-region (region-beginning) (region-end)))
2052    ((let ((old-point (point))
2053           (old-tick (buffer-chars-modified-tick))
2054           (tab-always-indent t))
2055       (call-interactively #'indent-for-tab-command)
2056       (when (and (eq old-point (point))
2057                  (eq old-tick (buffer-chars-modified-tick)))
2058         (company-complete-common))))))
2059
2060 ;;;###autoload
2061 (defun company-complete ()
2062   "Insert the common part of all candidates or the current selection.
2063 The first time this is called, the common part is inserted, the second
2064 time, or when the selection has been changed, the selected candidate is
2065 inserted."
2066   (interactive)
2067   (when (company-manual-begin)
2068     (if (or company-selection-changed
2069             (eq last-command 'company-complete-common))
2070         (call-interactively 'company-complete-selection)
2071       (call-interactively 'company-complete-common)
2072       (setq this-command 'company-complete-common))))
2073
2074 (defun company-complete-number (n)
2075   "Insert the Nth candidate visible in the tooltip.
2076 To show the number next to the candidates in some backends, enable
2077 `company-show-numbers'.  When called interactively, uses the last typed
2078 character, stripping the modifiers.  That character must be a digit."
2079   (interactive
2080    (list (let* ((type (event-basic-type last-command-event))
2081                 (char (if (characterp type)
2082                           ;; Number on the main row.
2083                           type
2084                         ;; Keypad number, if bound directly.
2085                         (car (last (string-to-list (symbol-name type))))))
2086                 (n (- char ?0)))
2087            (if (zerop n) 10 n))))
2088   (when (company-manual-begin)
2089     (and (or (< n 1) (> n (- company-candidates-length
2090                              company-tooltip-offset)))
2091          (error "No candidate number %d" n))
2092     (cl-decf n)
2093     (company-finish (nth (+ n company-tooltip-offset)
2094                          company-candidates))))
2095
2096 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2097
2098 (defconst company-space-strings-limit 100)
2099
2100 (defconst company-space-strings
2101   (let (lst)
2102     (dotimes (i company-space-strings-limit)
2103       (push (make-string (- company-space-strings-limit 1 i) ?\  ) lst))
2104     (apply 'vector lst)))
2105
2106 (defun company-space-string (len)
2107   (if (< len company-space-strings-limit)
2108       (aref company-space-strings len)
2109     (make-string len ?\ )))
2110
2111 (defun company-safe-substring (str from &optional to)
2112   (if (> from (string-width str))
2113       ""
2114     (with-temp-buffer
2115       (insert str)
2116       (move-to-column from)
2117       (let ((beg (point)))
2118         (if to
2119             (progn
2120               (move-to-column to)
2121               (concat (buffer-substring beg (point))
2122                       (let ((padding (- to (current-column))))
2123                         (when (> padding 0)
2124                           (company-space-string padding)))))
2125           (buffer-substring beg (point-max)))))))
2126
2127 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2128
2129 (defvar-local company-last-metadata nil)
2130
2131 (defun company-fetch-metadata ()
2132   (let ((selected (nth company-selection company-candidates)))
2133     (unless (eq selected (car company-last-metadata))
2134       (setq company-last-metadata
2135             (cons selected (company-call-backend 'meta selected))))
2136     (cdr company-last-metadata)))
2137
2138 (defun company-doc-buffer (&optional string)
2139   (with-current-buffer (get-buffer-create "*company-documentation*")
2140     (erase-buffer)
2141     (when string
2142       (save-excursion
2143         (insert string)))
2144     (current-buffer)))
2145
2146 (defvar company--electric-saved-window-configuration nil)
2147
2148 (defvar company--electric-commands
2149   '(scroll-other-window scroll-other-window-down mwheel-scroll)
2150   "List of Commands that won't break out of electric commands.")
2151
2152 (defun company--electric-restore-window-configuration ()
2153   "Restore window configuration (after electric commands)."
2154   (when (and company--electric-saved-window-configuration
2155              (not (memq this-command company--electric-commands)))
2156     (set-window-configuration company--electric-saved-window-configuration)
2157     (setq company--electric-saved-window-configuration nil)))
2158
2159 (defmacro company--electric-do (&rest body)
2160   (declare (indent 0) (debug t))
2161   `(when (company-manual-begin)
2162      (cl-assert (null company--electric-saved-window-configuration))
2163      (setq company--electric-saved-window-configuration (current-window-configuration))
2164      (let ((height (window-height))
2165            (row (company--row)))
2166        ,@body
2167        (and (< (window-height) height)
2168             (< (- (window-height) row 2) company-tooltip-limit)
2169             (recenter (- (window-height) row 2))))))
2170
2171 (defun company--unread-last-input ()
2172   (when last-input-event
2173     (clear-this-command-keys t)
2174     (setq unread-command-events (list last-input-event))))
2175
2176 (defun company-show-doc-buffer ()
2177   "Temporarily show the documentation buffer for the selection."
2178   (interactive)
2179   (let (other-window-scroll-buffer)
2180     (company--electric-do
2181       (let* ((selected (nth company-selection company-candidates))
2182              (doc-buffer (or (company-call-backend 'doc-buffer selected)
2183                              (error "No documentation available")))
2184              start)
2185         (when (consp doc-buffer)
2186           (setq start (cdr doc-buffer)
2187                 doc-buffer (car doc-buffer)))
2188         (setq other-window-scroll-buffer (get-buffer doc-buffer))
2189         (let ((win (display-buffer doc-buffer t)))
2190           (set-window-start win (if start start (point-min))))))))
2191 (put 'company-show-doc-buffer 'company-keep t)
2192
2193 (defun company-show-location ()
2194   "Temporarily display a buffer showing the selected candidate in context."
2195   (interactive)
2196   (let (other-window-scroll-buffer)
2197     (company--electric-do
2198       (let* ((selected (nth company-selection company-candidates))
2199              (location (company-call-backend 'location selected))
2200              (pos (or (cdr location) (error "No location available")))
2201              (buffer (or (and (bufferp (car location)) (car location))
2202                          (find-file-noselect (car location) t))))
2203         (setq other-window-scroll-buffer (get-buffer buffer))
2204         (with-selected-window (display-buffer buffer t)
2205           (save-restriction
2206             (widen)
2207             (if (bufferp (car location))
2208                 (goto-char pos)
2209               (goto-char (point-min))
2210               (forward-line (1- pos))))
2211           (set-window-start nil (point)))))))
2212 (put 'company-show-location 'company-keep t)
2213
2214 ;;; package functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2215
2216 (defvar-local company-callback nil)
2217
2218 (defun company-remove-callback (&optional ignored)
2219   (remove-hook 'company-completion-finished-hook company-callback t)
2220   (remove-hook 'company-completion-cancelled-hook 'company-remove-callback t)
2221   (remove-hook 'company-completion-finished-hook 'company-remove-callback t))
2222
2223 (defun company-begin-backend (backend &optional callback)
2224   "Start a completion at point using BACKEND."
2225   (interactive (let ((val (completing-read "Company backend: "
2226                                            obarray
2227                                            'functionp nil "company-")))
2228                  (when val
2229                    (list (intern val)))))
2230   (when (setq company-callback callback)
2231     (add-hook 'company-completion-finished-hook company-callback nil t))
2232   (add-hook 'company-completion-cancelled-hook 'company-remove-callback nil t)
2233   (add-hook 'company-completion-finished-hook 'company-remove-callback nil t)
2234   (setq company-backend backend)
2235   ;; Return non-nil if active.
2236   (or (company-manual-begin)
2237       (error "Cannot complete at point")))
2238
2239 (defun company-begin-with (candidates
2240                            &optional prefix-length require-match callback)
2241   "Start a completion at point.
2242 CANDIDATES is the list of candidates to use and PREFIX-LENGTH is the length
2243 of the prefix that already is in the buffer before point.
2244 It defaults to 0.
2245
2246 CALLBACK is a function called with the selected result if the user
2247 successfully completes the input.
2248
2249 Example: \(company-begin-with '\(\"foo\" \"foobar\" \"foobarbaz\"\)\)"
2250   (let ((begin-marker (copy-marker (point) t)))
2251     (company-begin-backend
2252      (lambda (command &optional arg &rest ignored)
2253        (pcase command
2254          (`prefix
2255           (when (equal (point) (marker-position begin-marker))
2256             (buffer-substring (- (point) (or prefix-length 0)) (point))))
2257          (`candidates
2258           (all-completions arg candidates))
2259          (`require-match
2260           require-match)))
2261      callback)))
2262
2263 (declare-function find-library-name "find-func")
2264 (declare-function lm-version "lisp-mnt")
2265
2266 (defun company-version (&optional show-version)
2267   "Get the Company version as string.
2268
2269 If SHOW-VERSION is non-nil, show the version in the echo area."
2270   (interactive (list t))
2271   (with-temp-buffer
2272     (require 'find-func)
2273     (insert-file-contents (find-library-name "company"))
2274     (require 'lisp-mnt)
2275     (if show-version
2276         (message "Company version: %s" (lm-version))
2277       (lm-version))))
2278
2279 (defun company-diag ()
2280   "Pop a buffer with information about completions at point."
2281   (interactive)
2282   (let* ((bb company-backends)
2283          backend
2284          (prefix (cl-loop for b in bb
2285                           thereis (let ((company-backend b))
2286                                     (setq backend b)
2287                                     (company-call-backend 'prefix))))
2288          cc annotations)
2289     (when (stringp prefix)
2290       (let ((company-backend backend))
2291         (setq cc (company-call-backend 'candidates prefix)
2292               annotations
2293               (mapcar
2294                (lambda (c) (cons c (company-call-backend 'annotation c)))
2295                cc))))
2296     (pop-to-buffer (get-buffer-create "*company-diag*"))
2297     (setq buffer-read-only nil)
2298     (erase-buffer)
2299     (insert (format "Emacs %s (%s) of %s on %s"
2300                     emacs-version system-configuration
2301                     (format-time-string "%Y-%m-%d" emacs-build-time)
2302                     emacs-build-system))
2303     (insert "\nCompany " (company-version) "\n\n")
2304     (insert "company-backends: " (pp-to-string bb))
2305     (insert "\n")
2306     (insert "Used backend: " (pp-to-string backend))
2307     (insert "\n")
2308     (insert "Prefix: " (pp-to-string prefix))
2309     (insert "\n")
2310     (insert (message  "Completions:"))
2311     (unless cc (insert " none"))
2312     (save-excursion
2313       (dolist (c annotations)
2314         (insert "\n  " (prin1-to-string (car c)))
2315         (when (cdr c)
2316           (insert " " (prin1-to-string (cdr c))))))
2317     (special-mode)))
2318
2319 ;;; pseudo-tooltip ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2320
2321 (defvar-local company-pseudo-tooltip-overlay nil)
2322
2323 (defvar-local company-tooltip-offset 0)
2324
2325 (defun company-tooltip--lines-update-offset (selection num-lines limit)
2326   (cl-decf limit 2)
2327   (setq company-tooltip-offset
2328         (max (min selection company-tooltip-offset)
2329              (- selection -1 limit)))
2330
2331   (when (<= company-tooltip-offset 1)
2332     (cl-incf limit)
2333     (setq company-tooltip-offset 0))
2334
2335   (when (>= company-tooltip-offset (- num-lines limit 1))
2336     (cl-incf limit)
2337     (when (= selection (1- num-lines))
2338       (cl-decf company-tooltip-offset)
2339       (when (<= company-tooltip-offset 1)
2340         (setq company-tooltip-offset 0)
2341         (cl-incf limit))))
2342
2343   limit)
2344
2345 (defun company-tooltip--simple-update-offset (selection _num-lines limit)
2346   (setq company-tooltip-offset
2347         (if (< selection company-tooltip-offset)
2348             selection
2349           (max company-tooltip-offset
2350                (- selection limit -1)))))
2351
2352 ;;; propertize
2353
2354 (defsubst company-round-tab (arg)
2355   (* (/ (+ arg tab-width) tab-width) tab-width))
2356
2357 (defun company-plainify (str)
2358   (let ((prefix (get-text-property 0 'line-prefix str)))
2359     (when prefix ; Keep the original value unmodified, for no special reason.
2360       (setq str (concat prefix str))
2361       (remove-text-properties 0 (length str) '(line-prefix) str)))
2362   (let* ((pieces (split-string str "\t"))
2363          (copy pieces))
2364     (while (cdr copy)
2365       (setcar copy (company-safe-substring
2366                     (car copy) 0 (company-round-tab (string-width (car copy)))))
2367       (pop copy))
2368     (apply 'concat pieces)))
2369
2370 (defun company-fill-propertize (value annotation width selected left right)
2371   (let* ((margin (length left))
2372          (common (or (company-call-backend 'match value)
2373                      (if company-common
2374                          (string-width company-common)
2375                        0)))
2376          (_ (setq value (company--pre-render value)
2377                   annotation (and annotation (company--pre-render annotation t))))
2378          (ann-ralign company-tooltip-align-annotations)
2379          (ann-truncate (< width
2380                           (+ (length value) (length annotation)
2381                              (if ann-ralign 1 0))))
2382          (ann-start (+ margin
2383                        (if ann-ralign
2384                            (if ann-truncate
2385                                (1+ (length value))
2386                              (- width (length annotation)))
2387                          (length value))))
2388          (ann-end (min (+ ann-start (length annotation)) (+ margin width)))
2389          (line (concat left
2390                        (if (or ann-truncate (not ann-ralign))
2391                            (company-safe-substring
2392                             (concat value
2393                                     (when (and annotation ann-ralign) " ")
2394                                     annotation)
2395                             0 width)
2396                          (concat
2397                           (company-safe-substring value 0
2398                                                   (- width (length annotation)))
2399                           annotation))
2400                        right)))
2401     (setq common (+ (min common width) margin))
2402     (setq width (+ width margin (length right)))
2403
2404     (font-lock-append-text-property 0 width 'mouse-face
2405                                     'company-tooltip-mouse
2406                                     line)
2407     (when (< ann-start ann-end)
2408       (font-lock-append-text-property ann-start ann-end 'face
2409                                       (if selected
2410                                           'company-tooltip-annotation-selection
2411                                         'company-tooltip-annotation)
2412                                       line))
2413     (font-lock-prepend-text-property margin common 'face
2414                                      (if selected
2415                                          'company-tooltip-common-selection
2416                                        'company-tooltip-common)
2417                                      line)
2418     (when selected
2419       (if (let ((re (funcall company-search-regexp-function
2420                              company-search-string)))
2421             (and (not (string= re ""))
2422                  (string-match re value (length company-prefix))))
2423           (pcase-dolist (`(,mbeg . ,mend) (company--search-chunks))
2424             (let ((beg (+ margin mbeg))
2425                   (end (+ margin mend))
2426                   (width (- width (length right))))
2427               (when (< beg width)
2428                 (font-lock-prepend-text-property beg (min end width)
2429                                                  'face 'company-tooltip-search
2430                                                  line))))
2431         (font-lock-append-text-property 0 width 'face
2432                                         'company-tooltip-selection
2433                                         line)))
2434     (font-lock-append-text-property 0 width 'face
2435                                     'company-tooltip
2436                                     line)
2437     line))
2438
2439 (defun company--search-chunks ()
2440   (let ((md (match-data t))
2441         res)
2442     (if (<= (length md) 2)
2443         (push (cons (nth 0 md) (nth 1 md)) res)
2444       (while (setq md (nthcdr 2 md))
2445         (when (car md)
2446           (push (cons (car md) (cadr md)) res))))
2447     res))
2448
2449 (defun company--pre-render (str &optional annotation-p)
2450   (or (company-call-backend 'pre-render str annotation-p)
2451       (progn
2452         (when (or (text-property-not-all 0 (length str) 'face nil str)
2453                   (text-property-not-all 0 (length str) 'mouse-face nil str))
2454           (setq str (copy-sequence str))
2455           (remove-text-properties 0 (length str)
2456                                   '(face nil font-lock-face nil mouse-face nil)
2457                                   str))
2458         str)))
2459
2460 (defun company--clean-string (str)
2461   (replace-regexp-in-string
2462    "\\([^[:graph:] ]\\)\\|\\(\ufeff\\)\\|[[:multibyte:]]"
2463    (lambda (match)
2464      (cond
2465       ((match-beginning 1)
2466        ;; FIXME: Better char for 'non-printable'?
2467        ;; We shouldn't get any of these, but sometimes we might.
2468        "\u2017")
2469       ((match-beginning 2)
2470        ;; Zero-width non-breakable space.
2471        "")
2472       ((> (string-width match) 1)
2473        (concat
2474         (make-string (1- (string-width match)) ?\ufeff)
2475         match))
2476       (t match)))
2477    str))
2478
2479 ;;; replace
2480
2481 (defun company-buffer-lines (beg end)
2482   (goto-char beg)
2483   (let (lines lines-moved)
2484     (while (and (not (eobp)) ; http://debbugs.gnu.org/19553
2485                 (> (setq lines-moved (vertical-motion 1)) 0)
2486                 (<= (point) end))
2487       (let ((bound (min end (point))))
2488         ;; A visual line can contain several physical lines (e.g. with outline's
2489         ;; folding overlay).  Take only the first one.
2490         (push (buffer-substring beg
2491                                 (save-excursion
2492                                   (goto-char beg)
2493                                   (re-search-forward "$" bound 'move)
2494                                   (point)))
2495               lines))
2496       ;; One physical line can be displayed as several visual ones as well:
2497       ;; add empty strings to the list, to even the count.
2498       (dotimes (_ (1- lines-moved))
2499         (push "" lines))
2500       (setq beg (point)))
2501     (unless (eq beg end)
2502       (push (buffer-substring beg end) lines))
2503     (nreverse lines)))
2504
2505 (defun company-modify-line (old new offset)
2506   (concat (company-safe-substring old 0 offset)
2507           new
2508           (company-safe-substring old (+ offset (length new)))))
2509
2510 (defsubst company--length-limit (lst limit)
2511   (if (nthcdr limit lst)
2512       limit
2513     (length lst)))
2514
2515 (defsubst company--window-height ()
2516   (if (fboundp 'window-screen-lines)
2517       (floor (window-screen-lines))
2518     (window-body-height)))
2519
2520 (defun company--window-width ()
2521   (let ((ww (window-body-width)))
2522     ;; Account for the line continuation column.
2523     (when (zerop (cadr (window-fringes)))
2524       (cl-decf ww))
2525     (unless (or (display-graphic-p)
2526                 (version< "24.3.1" emacs-version))
2527       ;; Emacs 24.3 and earlier included margins
2528       ;; in window-width when in TTY.
2529       (cl-decf ww
2530                (let ((margins (window-margins)))
2531                  (+ (or (car margins) 0)
2532                     (or (cdr margins) 0)))))
2533     (when (and word-wrap
2534                (version< emacs-version "24.4.51.5"))
2535       ;; http://debbugs.gnu.org/19300
2536       (cl-decf ww))
2537     ;; whitespace-mode with newline-mark
2538     (when (and buffer-display-table
2539                (aref buffer-display-table ?\n))
2540       (cl-decf ww (1- (length (aref buffer-display-table ?\n)))))
2541     ww))
2542
2543 (defun company--replacement-string (lines old column nl &optional align-top)
2544   (cl-decf column company-tooltip-margin)
2545
2546   (when (and align-top company-tooltip-flip-when-above)
2547     (setq lines (reverse lines)))
2548
2549   (let ((width (length (car lines)))
2550         (remaining-cols (- (+ (company--window-width) (window-hscroll))
2551                            column)))
2552     (when (> width remaining-cols)
2553       (cl-decf column (- width remaining-cols))))
2554
2555   (let ((offset (and (< column 0) (- column)))
2556         new)
2557     (when offset
2558       (setq column 0))
2559     (when align-top
2560       ;; untouched lines first
2561       (dotimes (_ (- (length old) (length lines)))
2562         (push (pop old) new)))
2563     ;; length into old lines.
2564     (while old
2565       (push (company-modify-line (pop old)
2566                                  (company--offset-line (pop lines) offset)
2567                                  column)
2568             new))
2569     ;; Append whole new lines.
2570     (while lines
2571       (push (concat (company-space-string column)
2572                     (company--offset-line (pop lines) offset))
2573             new))
2574
2575     (let ((str (concat (when nl " \n")
2576                        (mapconcat 'identity (nreverse new) "\n")
2577                        "\n")))
2578       (font-lock-append-text-property 0 (length str) 'face 'default str)
2579       (when nl (put-text-property 0 1 'cursor t str))
2580       str)))
2581
2582 (defun company--offset-line (line offset)
2583   (if (and offset line)
2584       (substring line offset)
2585     line))
2586
2587 (defun company--create-lines (selection limit)
2588   (let ((len company-candidates-length)
2589         (window-width (company--window-width))
2590         lines
2591         width
2592         lines-copy
2593         items
2594         previous
2595         remainder
2596         scrollbar-bounds)
2597
2598     ;; Maybe clear old offset.
2599     (when (< len (+ company-tooltip-offset limit))
2600       (setq company-tooltip-offset 0))
2601
2602     ;; Scroll to offset.
2603     (if (eq company-tooltip-offset-display 'lines)
2604         (setq limit (company-tooltip--lines-update-offset selection len limit))
2605       (company-tooltip--simple-update-offset selection len limit))
2606
2607     (cond
2608      ((eq company-tooltip-offset-display 'scrollbar)
2609       (setq scrollbar-bounds (company--scrollbar-bounds company-tooltip-offset
2610                                                         limit len)))
2611      ((eq company-tooltip-offset-display 'lines)
2612       (when (> company-tooltip-offset 0)
2613         (setq previous (format "...(%d)" company-tooltip-offset)))
2614       (setq remainder (- len limit company-tooltip-offset)
2615             remainder (when (> remainder 0)
2616                         (setq remainder (format "...(%d)" remainder))))))
2617
2618     (cl-decf selection company-tooltip-offset)
2619     (setq width (max (length previous) (length remainder))
2620           lines (nthcdr company-tooltip-offset company-candidates)
2621           len (min limit len)
2622           lines-copy lines)
2623
2624     (cl-decf window-width (* 2 company-tooltip-margin))
2625     (when scrollbar-bounds (cl-decf window-width))
2626
2627     (dotimes (_ len)
2628       (let* ((value (pop lines-copy))
2629              (annotation (company-call-backend 'annotation value)))
2630         (setq value (company--clean-string (company-reformat value)))
2631         (when annotation
2632           (when company-tooltip-align-annotations
2633             ;; `lisp-completion-at-point' adds a space.
2634             (setq annotation (comment-string-strip annotation t nil)))
2635           (setq annotation (company--clean-string annotation)))
2636         (push (cons value annotation) items)
2637         (setq width (max (+ (length value)
2638                             (if (and annotation company-tooltip-align-annotations)
2639                                 (1+ (length annotation))
2640                               (length annotation)))
2641                          width))))
2642
2643     (setq width (min window-width
2644                      (max company-tooltip-minimum-width
2645                           (if company-show-numbers
2646                               (+ 2 width)
2647                             width))))
2648
2649     (let ((items (nreverse items))
2650           (numbered (if company-show-numbers 0 99999))
2651           new)
2652       (when previous
2653         (push (company--scrollpos-line previous width) new))
2654
2655       (dotimes (i len)
2656         (let* ((item (pop items))
2657                (str (car item))
2658                (annotation (cdr item))
2659                (right (company-space-string company-tooltip-margin))
2660                (width width))
2661           (when (< numbered 10)
2662             (cl-decf width 2)
2663             (cl-incf numbered)
2664             (setq right (concat (format " %d" (mod numbered 10)) right)))
2665           (push (concat
2666                  (company-fill-propertize str annotation
2667                                           width (equal i selection)
2668                                           (company-space-string
2669                                            company-tooltip-margin)
2670                                           right)
2671                  (when scrollbar-bounds
2672                    (company--scrollbar i scrollbar-bounds)))
2673                 new)))
2674
2675       (when remainder
2676         (push (company--scrollpos-line remainder width) new))
2677
2678       (nreverse new))))
2679
2680 (defun company--scrollbar-bounds (offset limit length)
2681   (when (> length limit)
2682     (let* ((size (ceiling (* limit (float limit)) length))
2683            (lower (floor (* limit (float offset)) length))
2684            (upper (+ lower size -1)))
2685       (cons lower upper))))
2686
2687 (defun company--scrollbar (i bounds)
2688   (propertize " " 'face
2689               (if (and (>= i (car bounds)) (<= i (cdr bounds)))
2690                   'company-scrollbar-fg
2691                 'company-scrollbar-bg)))
2692
2693 (defun company--scrollpos-line (text width)
2694   (propertize (concat (company-space-string company-tooltip-margin)
2695                       (company-safe-substring text 0 width)
2696                       (company-space-string company-tooltip-margin))
2697               'face 'company-tooltip))
2698
2699 ;; show
2700
2701 (defun company--pseudo-tooltip-height ()
2702   "Calculate the appropriate tooltip height.
2703 Returns a negative number if the tooltip should be displayed above point."
2704   (let* ((lines (company--row))
2705          (below (- (company--window-height) 1 lines)))
2706     (if (and (< below (min company-tooltip-minimum company-candidates-length))
2707              (> lines below))
2708         (- (max 3 (min company-tooltip-limit lines)))
2709       (max 3 (min company-tooltip-limit below)))))
2710
2711 (defun company-pseudo-tooltip-show (row column selection)
2712   (company-pseudo-tooltip-hide)
2713   (save-excursion
2714
2715     (let* ((height (company--pseudo-tooltip-height))
2716            above)
2717
2718       (when (< height 0)
2719         (setq row (+ row height -1)
2720               above t))
2721
2722       (let* ((nl (< (move-to-window-line row) row))
2723              (beg (point))
2724              (end (save-excursion
2725                     (move-to-window-line (+ row (abs height)))
2726                     (point)))
2727              (ov (make-overlay beg end nil t))
2728              (args (list (mapcar 'company-plainify
2729                                  (company-buffer-lines beg end))
2730                          column nl above)))
2731
2732         (setq company-pseudo-tooltip-overlay ov)
2733         (overlay-put ov 'company-replacement-args args)
2734
2735         (let ((lines (company--create-lines selection (abs height))))
2736           (overlay-put ov 'company-display
2737                        (apply 'company--replacement-string lines args))
2738           (overlay-put ov 'company-width (string-width (car lines))))
2739
2740         (overlay-put ov 'company-column column)
2741         (overlay-put ov 'company-height height)))))
2742
2743 (defun company-pseudo-tooltip-show-at-point (pos column-offset)
2744   (let* ((col-row (company--col-row pos))
2745          (col (- (car col-row) column-offset)))
2746     (when (< col 0) (setq col 0))
2747     (company-pseudo-tooltip-show (1+ (cdr col-row)) col company-selection)))
2748
2749 (defun company-pseudo-tooltip-edit (selection)
2750   (let* ((height (overlay-get company-pseudo-tooltip-overlay 'company-height))
2751          (lines  (company--create-lines selection (abs height))))
2752     (overlay-put company-pseudo-tooltip-overlay 'company-width
2753                  (string-width (car lines)))
2754     (overlay-put company-pseudo-tooltip-overlay 'company-display
2755                  (apply 'company--replacement-string
2756                         lines
2757                         (overlay-get company-pseudo-tooltip-overlay
2758                                      'company-replacement-args)))))
2759
2760 (defun company-pseudo-tooltip-hide ()
2761   (when company-pseudo-tooltip-overlay
2762     (delete-overlay company-pseudo-tooltip-overlay)
2763     (setq company-pseudo-tooltip-overlay nil)))
2764
2765 (defun company-pseudo-tooltip-hide-temporarily ()
2766   (when (overlayp company-pseudo-tooltip-overlay)
2767     (overlay-put company-pseudo-tooltip-overlay 'invisible nil)
2768     (overlay-put company-pseudo-tooltip-overlay 'line-prefix nil)
2769     (overlay-put company-pseudo-tooltip-overlay 'after-string nil)
2770     (overlay-put company-pseudo-tooltip-overlay 'display nil)))
2771
2772 (defun company-pseudo-tooltip-unhide ()
2773   (when company-pseudo-tooltip-overlay
2774     (let* ((ov company-pseudo-tooltip-overlay)
2775            (disp (overlay-get ov 'company-display)))
2776       ;; Beat outline's folding overlays, at least.
2777       (overlay-put ov 'priority 1)
2778       ;; No (extra) prefix for the first line.
2779       (overlay-put ov 'line-prefix "")
2780       ;; `display' is better
2781       ;; (http://debbugs.gnu.org/18285, http://debbugs.gnu.org/20847),
2782       ;; but it doesn't work on 0-length overlays.
2783       (if (< (overlay-start ov) (overlay-end ov))
2784           (overlay-put ov 'display disp)
2785         (overlay-put ov 'after-string disp)
2786         (overlay-put ov 'invisible t))
2787       (overlay-put ov 'window (selected-window)))))
2788
2789 (defun company-pseudo-tooltip-guard ()
2790   (cons
2791    (save-excursion (beginning-of-visual-line))
2792    (let ((ov company-pseudo-tooltip-overlay)
2793          (overhang (save-excursion (end-of-visual-line)
2794                                    (- (line-end-position) (point)))))
2795      (when (>= (overlay-get ov 'company-height) 0)
2796        (cons
2797         (buffer-substring-no-properties (point) (overlay-start ov))
2798         (when (>= overhang 0) overhang))))))
2799
2800 (defun company-pseudo-tooltip-frontend (command)
2801   "`company-mode' frontend similar to a tooltip but based on overlays."
2802   (cl-case command
2803     (pre-command (company-pseudo-tooltip-hide-temporarily))
2804     (post-command
2805      (unless (when (overlayp company-pseudo-tooltip-overlay)
2806               (let* ((ov company-pseudo-tooltip-overlay)
2807                      (old-height (overlay-get ov 'company-height))
2808                      (new-height (company--pseudo-tooltip-height)))
2809                 (and
2810                  (>= (* old-height new-height) 0)
2811                  (>= (abs old-height) (abs new-height))
2812                  (equal (company-pseudo-tooltip-guard)
2813                         (overlay-get ov 'company-guard)))))
2814        ;; Redraw needed.
2815        (company-pseudo-tooltip-show-at-point (point) (length company-prefix))
2816        (overlay-put company-pseudo-tooltip-overlay
2817                     'company-guard (company-pseudo-tooltip-guard)))
2818      (company-pseudo-tooltip-unhide))
2819     (hide (company-pseudo-tooltip-hide)
2820           (setq company-tooltip-offset 0))
2821     (update (when (overlayp company-pseudo-tooltip-overlay)
2822               (company-pseudo-tooltip-edit company-selection)))))
2823
2824 (defun company-pseudo-tooltip-unless-just-one-frontend (command)
2825   "`company-pseudo-tooltip-frontend', but not shown for single candidates."
2826   (unless (and (eq command 'post-command)
2827                (company--show-inline-p))
2828     (company-pseudo-tooltip-frontend command)))
2829
2830 ;;; overlay ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2831
2832 (defvar-local company-preview-overlay nil)
2833
2834 (defun company-preview-show-at-point (pos)
2835   (company-preview-hide)
2836
2837   (let ((completion (nth company-selection company-candidates)))
2838     (setq completion (copy-sequence (company--pre-render completion)))
2839     (font-lock-append-text-property 0 (length completion)
2840                                     'face 'company-preview
2841                                     completion)
2842     (font-lock-prepend-text-property 0 (length company-common)
2843                                      'face 'company-preview-common
2844                                      completion)
2845
2846     ;; Add search string
2847     (and (string-match (funcall company-search-regexp-function
2848                                 company-search-string)
2849                        completion)
2850          (pcase-dolist (`(,mbeg . ,mend) (company--search-chunks))
2851            (font-lock-prepend-text-property mbeg mend
2852                                             'face 'company-preview-search
2853                                             completion)))
2854
2855     (setq completion (company-strip-prefix completion))
2856
2857     (and (equal pos (point))
2858          (not (equal completion ""))
2859          (add-text-properties 0 1 '(cursor 1) completion))
2860
2861     (let* ((beg pos)
2862            (pto company-pseudo-tooltip-overlay)
2863            (ptf-workaround (and
2864                             pto
2865                             (char-before pos)
2866                             (eq pos (overlay-start pto)))))
2867       ;; Try to accomodate for the pseudo-tooltip overlay,
2868       ;; which may start at the same position if it's at eol.
2869       (when ptf-workaround
2870         (cl-decf beg)
2871         (setq completion (concat (buffer-substring beg pos) completion)))
2872
2873       (setq company-preview-overlay (make-overlay beg pos))
2874
2875       (let ((ov company-preview-overlay))
2876         (overlay-put ov (if ptf-workaround 'display 'after-string)
2877                      completion)
2878         (overlay-put ov 'window (selected-window))))))
2879
2880 (defun company-preview-hide ()
2881   (when company-preview-overlay
2882     (delete-overlay company-preview-overlay)
2883     (setq company-preview-overlay nil)))
2884
2885 (defun company-preview-frontend (command)
2886   "`company-mode' frontend showing the selection as if it had been inserted."
2887   (pcase command
2888     (`pre-command (company-preview-hide))
2889     (`post-command (company-preview-show-at-point (point)))
2890     (`hide (company-preview-hide))))
2891
2892 (defun company-preview-if-just-one-frontend (command)
2893   "`company-preview-frontend', but only shown for single candidates."
2894   (when (or (not (eq command 'post-command))
2895             (company--show-inline-p))
2896     (company-preview-frontend command)))
2897
2898 (defun company--show-inline-p ()
2899   (and (not (cdr company-candidates))
2900        company-common
2901        (or (eq (company-call-backend 'ignore-case) 'keep-prefix)
2902            (string-prefix-p company-prefix company-common))))
2903
2904 ;;; echo ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2905
2906 (defvar-local company-echo-last-msg nil)
2907
2908 (defvar company-echo-timer nil)
2909
2910 (defvar company-echo-delay .01)
2911
2912 (defun company-echo-show (&optional getter)
2913   (when getter
2914     (setq company-echo-last-msg (funcall getter)))
2915   (let ((message-log-max nil))
2916     (if company-echo-last-msg
2917         (message "%s" company-echo-last-msg)
2918       (message ""))))
2919
2920 (defun company-echo-show-soon (&optional getter)
2921   (company-echo-cancel)
2922   (setq company-echo-timer (run-with-timer 0 nil 'company-echo-show getter)))
2923
2924 (defun company-echo-cancel (&optional unset)
2925   (when company-echo-timer
2926     (cancel-timer company-echo-timer))
2927   (when unset
2928     (setq company-echo-timer nil)))
2929
2930 (defun company-echo-show-when-idle (&optional getter)
2931   (company-echo-cancel)
2932   (setq company-echo-timer
2933         (run-with-idle-timer company-echo-delay nil 'company-echo-show getter)))
2934
2935 (defun company-echo-format ()
2936
2937   (let ((limit (window-body-width (minibuffer-window)))
2938         (len -1)
2939         ;; Roll to selection.
2940         (candidates (nthcdr company-selection company-candidates))
2941         (i (if company-show-numbers company-selection 99999))
2942         comp msg)
2943
2944     (while candidates
2945       (setq comp (company-reformat (pop candidates))
2946             len (+ len 1 (length comp)))
2947       (if (< i 10)
2948           ;; Add number.
2949           (progn
2950             (setq comp (propertize (format "%d: %s" i comp)
2951                                    'face 'company-echo))
2952             (cl-incf len 3)
2953             (cl-incf i)
2954             (add-text-properties 3 (+ 3 (length company-common))
2955                                  '(face company-echo-common) comp))
2956         (setq comp (propertize comp 'face 'company-echo))
2957         (add-text-properties 0 (length company-common)
2958                              '(face company-echo-common) comp))
2959       (if (>= len limit)
2960           (setq candidates nil)
2961         (push comp msg)))
2962
2963     (mapconcat 'identity (nreverse msg) " ")))
2964
2965 (defun company-echo-strip-common-format ()
2966
2967   (let ((limit (window-body-width (minibuffer-window)))
2968         (len (+ (length company-prefix) 2))
2969         ;; Roll to selection.
2970         (candidates (nthcdr company-selection company-candidates))
2971         (i (if company-show-numbers company-selection 99999))
2972         msg comp)
2973
2974     (while candidates
2975       (setq comp (company-strip-prefix (pop candidates))
2976             len (+ len 2 (length comp)))
2977       (when (< i 10)
2978         ;; Add number.
2979         (setq comp (format "%s (%d)" comp i))
2980         (cl-incf len 4)
2981         (cl-incf i))
2982       (if (>= len limit)
2983           (setq candidates nil)
2984         (push (propertize comp 'face 'company-echo) msg)))
2985
2986     (concat (propertize company-prefix 'face 'company-echo-common) "{"
2987             (mapconcat 'identity (nreverse msg) ", ")
2988             "}")))
2989
2990 (defun company-echo-hide ()
2991   (unless (equal company-echo-last-msg "")
2992     (setq company-echo-last-msg "")
2993     (company-echo-show)))
2994
2995 (defun company-echo-frontend (command)
2996   "`company-mode' frontend showing the candidates in the echo area."
2997   (pcase command
2998     (`post-command (company-echo-show-soon 'company-echo-format))
2999     (`hide (company-echo-hide))))
3000
3001 (defun company-echo-strip-common-frontend (command)
3002   "`company-mode' frontend showing the candidates in the echo area."
3003   (pcase command
3004     (`post-command (company-echo-show-soon 'company-echo-strip-common-format))
3005     (`hide (company-echo-hide))))
3006
3007 (defun company-echo-metadata-frontend (command)
3008   "`company-mode' frontend showing the documentation in the echo area."
3009   (pcase command
3010     (`post-command (company-echo-show-when-idle 'company-fetch-metadata))
3011     (`hide (company-echo-hide))))
3012
3013 (provide 'company)
3014 ;;; company.el ends here