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

   1 ;;; company.el --- extensible inline text completion mechanism
   2 ;;
   3 ;; Copyright (C) 2009 Nikolaj Schumacher
   4 ;;
   5 ;; Author: Nikolaj Schumacher <bugs * nschum de>
   6 ;; Version:
   7 ;; Keywords: abbrev, convenience, matchis
   8 ;; URL: http://nschum.de/src/emacs/company/
   9 ;; Compatibility: GNU Emacs 23.x
  10 ;;
  11 ;; This file is NOT part of GNU Emacs.
  12 ;;
  13 ;; This program is free software; you can redistribute it and/or
  14 ;; modify it under the terms of the GNU General Public License
  15 ;; as published by the Free Software Foundation; either version 2
  16 ;; of the License, or (at your option) any later version.
  17 ;;
  18 ;; This program is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22 ;;
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
  25 ;;
  26 ;;; Commentary:
  27 ;;
  28 ;;; Change Log:
  29 ;;
  30 ;;    Initial release.
  31 ;;
  32 ;;; Code:
  33
  34 (eval-when-compile (require 'cl))
  35
  36 (add-to-list 'debug-ignored-errors
  37              "^Pseudo tooltip frontend cannot be used twice$")
  38 (add-to-list 'debug-ignored-errors "^Preview frontend cannot be used twice$")
  39 (add-to-list 'debug-ignored-errors "^Echo area cannot be used twice$")
  40 (add-to-list 'debug-ignored-errors "^No documentation available$")
  41
  42 (defgroup company nil
  43   ""
  44   :group 'abbrev
  45   :group 'convenience
  46   :group 'maching)
  47
  48 (defface company-tooltip
  49   '((t :background "yellow"
  50        :foreground "black"))
  51   "*"
  52   :group 'company)
  53
  54 (defface company-tooltip-selection
  55   '((t :background "orange1"
  56        :foreground "black"))
  57   "*"
  58   :group 'company)
  59
  60 (defface company-tooltip-common
  61   '((t :inherit company-tooltip
  62        :foreground "red"))
  63   "*"
  64   :group 'company)
  65
  66 (defface company-tooltip-common-selection
  67   '((t :inherit company-tooltip-selection
  68        :foreground "red"))
  69   "*"
  70   :group 'company)
  71
  72 (defcustom company-tooltip-limit 10
  73   "*"
  74   :group 'company
  75   :type 'integer)
  76
  77 (defface company-preview
  78   '((t :background "blue4"
  79        :foreground "wheat"))
  80   "*"
  81   :group 'company)
  82
  83 (defface company-preview-common
  84   '((t :inherit company-preview
  85        :foreground "red"))
  86   "*"
  87   :group 'company)
  88
  89 (defface company-echo nil
  90   "*"
  91   :group 'company)
  92
  93 (defface company-echo-common
  94   '((((background dark)) (:foreground "firebrick1"))
  95     (((background light)) (:background "firebrick4")))
  96   "*"
  97   :group 'company)
  98
  99 (defun company-frontends-set (variable value)
 100   ;; uniquify
 101   (let ((remainder value))
 102     (setcdr remainder (delq (car remainder) (cdr remainder))))
 103   (and (memq 'company-pseudo-tooltip-unless-just-one-frontend value)
 104        (memq 'company-pseudo-tooltip-frontend value)
 105        (error "Pseudo tooltip frontend cannot be used twice"))
 106   (and (memq 'company-preview-if-just-one-frontend value)
 107        (memq 'company-preview-frontend value)
 108        (error "Preview frontend cannot be used twice"))
 109   (and (memq 'company-echo value)
 110        (memq 'company-echo-metadata-frontend value)
 111        (error "Echo area cannot be used twice"))
 112   ;; preview must come last
 113   (dolist (f '(company-preview-if-just-one-frontend company-preview-frontend))
 114     (when (memq f value)
 115       (setq value (append (delq f value) (list f)))))
 116   (set variable value))
 117
 118 (defcustom company-frontends '(company-pseudo-tooltip-unless-just-one-frontend
 119                                company-preview-if-just-one-frontend
 120                                company-echo-metadata-frontend)
 121   "*"
 122   :set 'company-frontends-set
 123   :group 'company
 124   :type '(repeat (choice (const :tag "echo" company-echo-frontend)
 125                          (const :tag "pseudo tooltip"
 126                                 company-pseudo-tooltip-frontend)
 127                          (const :tag "pseudo tooltip, multiple only"
 128                                 company-pseudo-tooltip-unless-just-one-frontend)
 129                          (const :tag "preview" company-preview-frontend)
 130                          (const :tag "preview, unique only"
 131                                 company-preview-if-just-one-frontend)
 132                          (function :tag "custom function" nil))))
 133
 134 (defcustom company-backends '(company-elisp company-nxml company-css
 135                               company-semantic company-oddmuse
 136                               company-dabbrev)
 137   "*"
 138   :group 'company
 139   :type '(repeat (function :tag "function" nil)))
 140
 141 (defcustom company-minimum-prefix-length 3
 142   "*"
 143   :group 'company
 144   :type '(integer :tag "prefix length"))
 145
 146 (defvar company-timer nil)
 147
 148 (defun company-timer-set (variable value)
 149   (set variable value)
 150   (when company-timer (cancel-timer company-timer))
 151   (when (numberp value)
 152     (setq company-timer (run-with-idle-timer value t 'company-idle-begin))))
 153
 154 (defcustom company-idle-delay .7
 155   "*"
 156   :set 'company-timer-set
 157   :group 'company
 158   :type '(choice (const :tag "never (nil)" nil)
 159                  (const :tag "immediate (t)" t)
 160                  (number :tag "seconds")))
 161
 162 ;;; mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 163
 164 (defvar company-mode-map (make-sparse-keymap))
 165
 166 (defvar company-active-map
 167   (let ((keymap (make-sparse-keymap)))
 168     (define-key keymap (kbd "M-n") 'company-select-next)
 169     (define-key keymap (kbd "M-p") 'company-select-previous)
 170     (define-key keymap "\C-m" 'company-complete-selection)
 171     (define-key keymap "\t" 'company-complete-common)
 172     (define-key keymap (kbd "<f1>") 'company-show-doc-buffer)
 173     keymap))
 174
 175 ;;;###autoload
 176 (define-minor-mode company-mode
 177   ""
 178   nil " comp" company-mode-map
 179   (if company-mode
 180       (progn
 181         (add-hook 'pre-command-hook 'company-pre-command nil t)
 182         (add-hook 'post-command-hook 'company-post-command nil t)
 183         (company-timer-set 'company-idle-delay
 184                            company-idle-delay))
 185     (remove-hook 'pre-command-hook 'company-pre-command t)
 186     (remove-hook 'post-command-hook 'company-post-command t)
 187     (company-cancel)
 188     (kill-local-variable 'company-point)))
 189
 190 ;;; keymaps ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 191
 192 (defvar company-overriding-keymap-bound nil)
 193 (make-variable-buffer-local 'company-overriding-keymap-bound)
 194
 195 (defvar company-old-keymap nil)
 196 (make-variable-buffer-local 'company-old-keymap)
 197
 198 (defvar company-my-keymap nil)
 199 (make-variable-buffer-local 'company-my-keymap)
 200
 201 (defsubst company-enable-overriding-keymap (keymap)
 202   (setq company-my-keymap keymap)
 203   (when company-overriding-keymap-bound
 204     (company-uninstall-map)))
 205
 206 (defun company-install-map ()
 207   (unless (or company-overriding-keymap-bound
 208               (null company-my-keymap))
 209     (setq company-old-keymap overriding-terminal-local-map
 210           overriding-terminal-local-map company-my-keymap
 211           company-overriding-keymap-bound t)))
 212
 213 (defun company-uninstall-map ()
 214   (when (and company-overriding-keymap-bound
 215              (eq overriding-terminal-local-map company-my-keymap))
 216     (setq overriding-terminal-local-map company-old-keymap
 217           company-overriding-keymap-bound nil)))
 218
 219 ;; Hack:
 220 ;; Emacs calculates the active keymaps before reading the event.  That means we
 221 ;; cannot change the keymap from a timer.  So we send a bogus command.
 222 (defun company-ignore ()
 223   (interactive))
 224
 225 (global-set-key '[31415926] 'company-ignore)
 226
 227 (defun company-input-noop ()
 228   (push 31415926 unread-command-events))
 229
 230 ;;; backends ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 231
 232 (defun company-grab (regexp &optional expression)
 233   (when (looking-back regexp)
 234     (or (match-string-no-properties (or expression 0)) "")))
 235
 236 (defun company-in-string-or-comment (&optional point)
 237   (let ((pos (syntax-ppss)))
 238     (or (nth 3 pos) (nth 4 pos) (nth 7 pos))))
 239
 240 ;;; completion mechanism ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 241
 242 (defvar company-backend nil)
 243 (make-variable-buffer-local 'company-backend)
 244
 245 (defvar company-prefix nil)
 246 (make-variable-buffer-local 'company-prefix)
 247
 248 (defvar company-candidates nil)
 249 (make-variable-buffer-local 'company-candidates)
 250
 251 (defvar company-candidates-cache nil)
 252 (make-variable-buffer-local 'company-candidates-cache)
 253
 254 (defvar company-common nil)
 255 (make-variable-buffer-local 'company-common)
 256
 257 (defvar company-selection 0)
 258 (make-variable-buffer-local 'company-selection)
 259
 260 (defvar company-selection-changed nil)
 261 (make-variable-buffer-local 'company-selection-changed)
 262
 263 (defvar company-point nil)
 264 (make-variable-buffer-local 'company-point)
 265
 266 (defvar company-disabled-backends nil)
 267
 268 (defsubst company-strip-prefix (str)
 269   (substring str (length company-prefix)))
 270
 271 (defsubst company-reformat (candidate)
 272   ;; company-ispell needs this, because the results are always lower-case
 273   ;; It's mory efficient to fix it only when they are displayed.
 274   (concat company-prefix (substring candidate (length company-prefix))))
 275
 276 (defsubst company-should-complete (prefix)
 277   (and (eq company-idle-delay t)
 278        (>= (length prefix) company-minimum-prefix-length)))
 279
 280 (defsubst company-call-frontends (command)
 281   (dolist (frontend company-frontends)
 282     (funcall frontend command)))
 283
 284 (defsubst company-set-selection (selection)
 285   (setq selection (max 0 (min (1- (length company-candidates)) selection)))
 286   (unless (equal selection company-selection)
 287     (setq company-selection selection
 288           company-selection-changed t)
 289     (company-call-frontends 'update)))
 290
 291 (defsubst company-calculate-candidates (prefix)
 292   (or (setq company-candidates (cdr (assoc prefix company-candidates-cache)))
 293       (let ((len (length prefix))
 294             (completion-ignore-case (funcall company-backend 'ignore-case))
 295             prev)
 296         (dotimes (i len)
 297           (when (setq prev (cdr (assoc (substring prefix 0 (- len i))
 298                                        company-candidates-cache)))
 299             (setq company-candidates (all-completions prefix prev))
 300             (return t))))
 301       (progn
 302         (setq company-candidates (funcall company-backend 'candidates prefix))
 303         (unless (funcall company-backend 'sorted)
 304           (setq company-candidates (sort company-candidates 'string<)))))
 305   (unless (assoc prefix company-candidates-cache)
 306     (push (cons prefix company-candidates) company-candidates-cache))
 307   (setq company-selection 0
 308         company-prefix prefix)
 309   (let ((completion-ignore-case (funcall company-backend 'ignore-case)))
 310     (setq company-common (try-completion company-prefix company-candidates)))
 311   (when (eq company-common t)
 312     (setq company-candidates nil))
 313   company-candidates)
 314
 315 (defun company-idle-begin ()
 316   (and company-mode
 317        (not company-candidates)
 318        (not (equal (point) company-point))
 319        (let ((company-idle-delay t))
 320          (company-begin)
 321          (when company-candidates
 322            (company-input-noop)
 323            (company-post-command)))))
 324
 325 (defun company-manual-begin ()
 326   (and company-mode
 327        (not company-candidates)
 328        (let ((company-idle-delay t)
 329              (company-minimum-prefix-length 0))
 330          (company-begin)))
 331   ;; Return non-nil if active.
 332   company-candidates)
 333
 334 (defun company-continue ()
 335   (when company-candidates
 336     (let ((new-prefix (funcall company-backend 'prefix)))
 337       (unless (and (= (- (point) (length new-prefix))
 338                       (- company-point (length company-prefix)))
 339                    (or (equal company-prefix new-prefix)
 340                        (company-calculate-candidates new-prefix)))
 341         (setq company-candidates nil)))))
 342
 343 (defun company-begin ()
 344   (company-continue)
 345   (unless company-candidates
 346     (let (prefix)
 347       (dolist (backend company-backends)
 348         (unless (fboundp backend)
 349           (ignore-errors (require backend nil t)))
 350         (if (fboundp backend)
 351             (when (setq prefix (funcall backend 'prefix))
 352               (when (company-should-complete prefix)
 353                 (setq company-backend backend)
 354                 (company-calculate-candidates prefix))
 355               (return prefix))
 356           (unless (memq backend company-disabled-backends)
 357             (push backend company-disabled-backends)
 358             (message "Company back-end '%s' could not be initialized"
 359                      backend))))))
 360   (if company-candidates
 361       (progn
 362         (setq company-point (point))
 363         (company-enable-overriding-keymap company-active-map)
 364         (company-call-frontends 'update))
 365     (company-cancel)))
 366
 367 (defun company-cancel ()
 368   (setq company-backend nil
 369         company-prefix nil
 370         company-candidates nil
 371         company-candidates-cache nil
 372         company-common nil
 373         company-selection 0
 374         company-selection-changed nil
 375         company-point nil)
 376   (company-call-frontends 'hide)
 377   (company-enable-overriding-keymap nil))
 378
 379 (defun company-abort ()
 380   (company-cancel)
 381   ;; Don't start again, unless started manually.
 382   (setq company-point (point)))
 383
 384 (defun company-pre-command ()
 385   (unless (eq this-command 'company-show-doc-buffer)
 386     (condition-case err
 387         (when company-candidates
 388           (company-call-frontends 'pre-command))
 389       (error (message "Company: An error occurred in pre-command")
 390              (message "%s" (error-message-string err))
 391              (company-cancel))))
 392   (company-uninstall-map))
 393
 394 (defun company-post-command ()
 395   (unless (eq this-command 'company-show-doc-buffer)
 396     (condition-case err
 397         (progn
 398           (unless (equal (point) company-point)
 399             (company-begin))
 400           (when company-candidates
 401             (company-call-frontends 'post-command)))
 402       (error (message "Company: An error occurred in post-command")
 403              (message "%s" (error-message-string err))
 404              (company-cancel))))
 405   (company-install-map))
 406
 407 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 408
 409 (defun company-select-next ()
 410   (interactive)
 411   (when (company-manual-begin)
 412     (company-set-selection (1+ company-selection))))
 413
 414 (defun company-select-previous ()
 415   (interactive)
 416   (when (company-manual-begin)
 417     (company-set-selection (1- company-selection))))
 418
 419 (defun company-complete-selection ()
 420   (interactive)
 421   (when (company-manual-begin)
 422     (insert (company-strip-prefix (nth company-selection company-candidates)))
 423     (company-abort)))
 424
 425 (defun company-complete-common ()
 426   (interactive)
 427   (when (company-manual-begin)
 428     (insert (company-strip-prefix company-common))))
 429
 430 (defun company-complete ()
 431   (interactive)
 432   (when (company-manual-begin)
 433     (if (or company-selection-changed
 434             (eq last-command 'company-complete-common))
 435         (call-interactively 'company-complete-selection)
 436       (call-interactively 'company-complete-common)
 437       (setq this-command 'company-complete-common))))
 438
 439 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 440
 441 (defconst company-space-strings-limit 100)
 442
 443 (defconst company-space-strings
 444   (let (lst)
 445     (dotimes (i company-space-strings-limit)
 446       (push (make-string (- company-space-strings-limit 1 i) ?\  ) lst))
 447     (apply 'vector lst)))
 448
 449 (defsubst company-space-string (len)
 450   (if (< len company-space-strings-limit)
 451       (aref company-space-strings len)
 452     (make-string len ?\ )))
 453
 454 (defsubst company-safe-substring (str from &optional to)
 455   (let ((len (length str)))
 456     (if (> from len)
 457         ""
 458       (if (and to (> to len))
 459           (concat (substring str from)
 460                   (company-space-string (- to len)))
 461         (substring str from to)))))
 462
 463 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 464
 465 (defvar company-last-metadata nil)
 466 (make-variable-buffer-local 'company-last-metadata)
 467
 468 (defun company-fetch-metadata ()
 469   (let ((selected (nth company-selection company-candidates)))
 470     (unless (equal selected (car company-last-metadata))
 471       (setq company-last-metadata
 472             (cons selected (funcall company-backend 'meta selected))))
 473     (cdr company-last-metadata)))
 474
 475 (defun company-doc-buffer (&optional string)
 476   (with-current-buffer (get-buffer-create "*Company meta-data*")
 477     (erase-buffer)
 478     (current-buffer)))
 479
 480 (defun company-show-doc-buffer ()
 481   (interactive)
 482   (when company-candidates
 483     (save-window-excursion
 484       (let* ((selected (nth company-selection company-candidates))
 485              (buffer (funcall company-backend 'doc-buffer selected)))
 486         (if (not buffer)
 487             (error "No documentation available.")
 488           (display-buffer buffer)
 489           (read-event)
 490           (when last-input-event
 491             (clear-this-command-keys t)
 492             (setq unread-command-events (list last-input-event))))))))
 493
 494 ;;; pseudo-tooltip ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 495
 496 (defvar company-pseudo-tooltip-overlay nil)
 497 (make-variable-buffer-local 'company-pseudo-tooltip-overlay)
 498
 499 (defvar company-tooltip-offset 0)
 500 (make-variable-buffer-local 'company-tooltip-offset)
 501
 502 (defun company-pseudo-tooltip-update-offset (selection num-lines limit)
 503
 504   (decf limit 2)
 505   (setq company-tooltip-offset
 506         (max (min selection company-tooltip-offset)
 507              (- selection -1 limit)))
 508
 509   (when (<= company-tooltip-offset 1)
 510     (incf limit)
 511     (setq company-tooltip-offset 0))
 512
 513   (when (>= company-tooltip-offset (- num-lines limit 1))
 514     (incf limit)
 515     (when (= selection (1- num-lines))
 516       (setq company-tooltip-offset (max (1- company-tooltip-offset) 0))))
 517
 518   limit)
 519
 520 ;;; propertize
 521
 522 (defun company-fill-propertize (line width selected)
 523   (setq line (company-safe-substring line 0 width))
 524   (add-text-properties 0 width
 525                        (list 'face (if selected
 526                                        'company-tooltip-selection
 527                                      'company-tooltip)) line)
 528   (add-text-properties 0 (length company-common)
 529                        (list 'face (if selected
 530                                        'company-tooltip-common-selection
 531                                      'company-tooltip-common)) line)
 532   line)
 533
 534 ;;; replace
 535
 536 (defun company-buffer-lines (beg end)
 537   (goto-char beg)
 538   (let ((row (cdr (posn-col-row (posn-at-point))))
 539         lines)
 540     (while (and (equal (move-to-window-line (incf row)) row)
 541                 (<= (point) end))
 542       (push (buffer-substring beg (min end (1- (point)))) lines)
 543       (setq beg (point)))
 544     (unless (eq beg end)
 545       (push (buffer-substring beg end) lines))
 546     (nreverse lines)))
 547
 548 (defun company-modify-line (old new offset)
 549   (concat (company-safe-substring old 0 offset)
 550           new
 551           (company-safe-substring old (+ offset (length new)))))
 552
 553 (defun company-replacement-string (old lines column nl)
 554   (let (new)
 555     ;; Inject into old lines.
 556     (while old
 557       (push (company-modify-line (pop old) (pop lines) column) new))
 558     ;; Append whole new lines.
 559     (while lines
 560       (push (company-modify-line "" (pop lines) column) new))
 561     (concat (when nl "\n")
 562             (mapconcat 'identity (nreverse new) "\n")
 563             "\n")))
 564
 565 (defun company-create-lines (column lines selection)
 566
 567   (let ((limit (max company-tooltip-limit 3))
 568         (len (length lines))
 569         width
 570         lines-copy
 571         previous
 572         remainder
 573         new)
 574
 575     ;; Scroll to offset.
 576     (setq limit (company-pseudo-tooltip-update-offset selection len limit))
 577
 578     (when (> company-tooltip-offset 0)
 579       (setq previous (format "...(%d)" company-tooltip-offset)))
 580
 581     (setq remainder (- len limit company-tooltip-offset)
 582           remainder (when (> remainder 0)
 583                       (setq remainder (format "...(%d)" remainder))))
 584
 585     (decf selection company-tooltip-offset)
 586     (setq width (min (length previous) (length remainder))
 587           lines (nthcdr company-tooltip-offset lines)
 588           len (min limit (length lines))
 589           lines-copy lines)
 590
 591     (dotimes (i len)
 592       (setq width (max (length (pop lines-copy)) width)))
 593     (setq width (min width (- (window-width) column)))
 594
 595     (when previous
 596       (push (propertize (company-safe-substring previous 0 width)
 597                         'face 'company-tooltip)
 598             new))
 599
 600     (dotimes (i len)
 601       (push (company-fill-propertize (company-reformat (pop lines))
 602                                      width (equal i selection))
 603             new))
 604
 605     (when remainder
 606       (push (propertize (company-safe-substring remainder 0 width)
 607                         'face 'company-tooltip)
 608             new))
 609
 610     (setq lines (nreverse new))))
 611
 612 ;; show
 613
 614 (defun company-pseudo-tooltip-show (row column lines selection)
 615   (company-pseudo-tooltip-hide)
 616   (unless lines (error "No text provided"))
 617   (save-excursion
 618
 619     (move-to-column 0)
 620
 621     (let* ((lines (company-create-lines column lines selection))
 622            (nl (< (move-to-window-line row) row))
 623            (beg (point))
 624            (end (save-excursion
 625                   (move-to-window-line (min (window-height)
 626                                             (+ row company-tooltip-limit)))
 627                   (point)))
 628            (old-string (company-buffer-lines beg end))
 629            str)
 630
 631       (setq company-pseudo-tooltip-overlay (make-overlay beg end))
 632
 633       (overlay-put company-pseudo-tooltip-overlay 'company-old old-string)
 634       (overlay-put company-pseudo-tooltip-overlay 'company-column column)
 635       (overlay-put company-pseudo-tooltip-overlay 'company-nl nl)
 636       (overlay-put company-pseudo-tooltip-overlay 'company-before
 637                    (company-replacement-string old-string lines column nl))
 638
 639       (overlay-put company-pseudo-tooltip-overlay 'window (selected-window)))))
 640
 641 (defun company-pseudo-tooltip-show-at-point (pos)
 642   (let ((col-row (posn-col-row (posn-at-point pos))))
 643     (company-pseudo-tooltip-show (1+ (cdr col-row)) (car col-row)
 644                                  company-candidates company-selection)))
 645
 646 (defun company-pseudo-tooltip-edit (lines selection)
 647   (let* ((old-string (overlay-get company-pseudo-tooltip-overlay 'company-old))
 648          (column (overlay-get company-pseudo-tooltip-overlay 'company-column))
 649          (nl (overlay-get company-pseudo-tooltip-overlay 'company-nl))
 650          (lines (company-create-lines column lines selection)))
 651     (overlay-put company-pseudo-tooltip-overlay 'company-before
 652                  (company-replacement-string old-string lines column nl))))
 653
 654 (defun company-pseudo-tooltip-hide ()
 655   (when company-pseudo-tooltip-overlay
 656     (delete-overlay company-pseudo-tooltip-overlay)
 657     (setq company-pseudo-tooltip-overlay nil)))
 658
 659 (defun company-pseudo-tooltip-hide-temporarily ()
 660   (when (overlayp company-pseudo-tooltip-overlay)
 661     (overlay-put company-pseudo-tooltip-overlay 'invisible nil)
 662     (overlay-put company-pseudo-tooltip-overlay 'before-string nil)))
 663
 664 (defun company-pseudo-tooltip-unhide ()
 665   (when company-pseudo-tooltip-overlay
 666     (overlay-put company-pseudo-tooltip-overlay 'invisible t)
 667     (overlay-put company-pseudo-tooltip-overlay 'before-string
 668                  (overlay-get company-pseudo-tooltip-overlay 'company-before))))
 669
 670 (defun company-pseudo-tooltip-frontend (command)
 671   (case command
 672     ('pre-command (company-pseudo-tooltip-hide-temporarily))
 673     ('post-command
 674      (unless (overlayp company-pseudo-tooltip-overlay)
 675        (company-pseudo-tooltip-show-at-point (- (point)
 676                                                 (length company-prefix))))
 677      (company-pseudo-tooltip-unhide))
 678     ('hide (company-pseudo-tooltip-hide)
 679            (setq company-tooltip-offset 0))
 680     ('update (when (overlayp company-pseudo-tooltip-overlay)
 681                (company-pseudo-tooltip-edit company-candidates
 682                                             company-selection)))))
 683
 684 (defun company-pseudo-tooltip-unless-just-one-frontend (command)
 685   (unless (and (eq command 'post-command)
 686                (not (cdr company-candidates)))
 687     (company-pseudo-tooltip-frontend command)))
 688
 689 ;;; overlay ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 690
 691 (defvar company-preview-overlay nil)
 692 (make-variable-buffer-local 'company-preview-overlay)
 693
 694 (defun company-preview-show-at-point (pos)
 695   (company-preview-hide)
 696
 697   (setq company-preview-overlay (make-overlay pos pos))
 698
 699   (let ((completion (company-strip-prefix (nth company-selection
 700                                                company-candidates))))
 701     (and (equal pos (point))
 702          (not (equal completion ""))
 703          (add-text-properties 0 1 '(cursor t) completion))
 704
 705     (setq completion (propertize completion 'face 'company-preview))
 706     (add-text-properties 0 (- (length company-common) (length company-prefix))
 707                          '(face company-preview-common) completion)
 708
 709     (overlay-put company-preview-overlay 'after-string completion)
 710     (overlay-put company-preview-overlay 'window (selected-window))))
 711
 712 (defun company-preview-hide ()
 713   (when company-preview-overlay
 714     (delete-overlay company-preview-overlay)
 715     (setq company-preview-overlay nil)))
 716
 717 (defun company-preview-frontend (command)
 718   (case command
 719     ('pre-command (company-preview-hide))
 720     ('post-command (company-preview-show-at-point (point)))
 721     ('hide (company-preview-hide))))
 722
 723 (defun company-preview-if-just-one-frontend (command)
 724   (unless (and (eq command 'post-command)
 725                (cdr company-candidates))
 726     (company-preview-frontend command)))
 727
 728 ;;; echo ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 729
 730 (defvar company-echo-last-msg nil)
 731 (make-variable-buffer-local 'company-echo-last-msg)
 732
 733 (defun company-echo-refresh ()
 734   (let ((message-log-max nil))
 735     (if company-echo-last-msg
 736         (message "%s" company-echo-last-msg)
 737       (message ""))))
 738
 739 (defun company-echo-show (candidates)
 740
 741   ;; Roll to selection.
 742   (setq candidates (nthcdr company-selection candidates))
 743
 744   (let ((limit (window-width (minibuffer-window)))
 745         (len -1)
 746         comp msg)
 747     (while candidates
 748       (setq comp (company-reformat (pop candidates))
 749             len (+ len 1 (length comp)))
 750       (if (>= len limit)
 751           (setq candidates nil)
 752         (setq comp (propertize comp 'face 'company-echo))
 753         (add-text-properties 0 (length company-common)
 754                              '(face company-echo-common) comp)
 755         (push comp msg)))
 756
 757     (setq company-echo-last-msg (mapconcat 'identity (nreverse msg) " "))
 758     (company-echo-refresh)))
 759
 760 (defun company-echo-frontend (command)
 761   (case command
 762     ('pre-command (company-echo-refresh))
 763     ('post-command (company-echo-show company-candidates))
 764     ('hide (setq company-echo-last-msg nil))))
 765
 766 (defun company-echo-metadata-frontend (command)
 767   (case command
 768     ('pre-command (company-echo-refresh))
 769     ('post-command (setq company-echo-last-msg (company-fetch-metadata))
 770                    (company-echo-refresh))
 771     ('hide (setq company-echo-last-msg nil))))
 772
 773
 774 (provide 'company)
 775 ;;; company.el ends here