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

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