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

   1 ;;; company-tests.el --- company-mode tests  -*- lexical-binding: t -*-
   2
   3 ;; Copyright (C) 2011, 2013-2014  Free Software Foundation, Inc.
   4
   5 ;; Author: Nikolaj Schumacher
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software: you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation, either version 3 of the License, or
  12 ;; (at your option) any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  21
  22
  23 ;;; Commentary:
  24 ;;
  25
  26 ;;; Code:
  27
  28 (require 'ert)
  29 (require 'company)
  30 (require 'company-keywords)
  31 (require 'company-clang)
  32
  33 (defun company--column (&optional pos)
  34   (car (company--col-row pos)))
  35
  36 ;;; Core
  37
  38 (ert-deftest company-sorted-keywords ()
  39   "Test that keywords in `company-keywords-alist' are in alphabetical order."
  40   (dolist (pair company-keywords-alist)
  41     (when (consp (cdr pair))
  42       (let ((prev (cadr pair)))
  43         (dolist (next (cddr pair))
  44           (should (not (equal prev next)))
  45           (should (string< prev next))
  46           (setq prev next))))))
  47
  48 (ert-deftest company-good-prefix ()
  49   (let ((company-minimum-prefix-length 5)
  50         company-abort-manual-when-too-short
  51         company--manual-action            ;idle begin
  52         (company-selection-changed t))    ;has no effect
  53     (should (eq t (company--good-prefix-p "!@#$%")))
  54     (should (eq nil (company--good-prefix-p "abcd")))
  55     (should (eq nil (company--good-prefix-p 'stop)))
  56     (should (eq t (company--good-prefix-p '("foo" . 5))))
  57     (should (eq nil (company--good-prefix-p '("foo" . 4))))
  58     (should (eq t (company--good-prefix-p '("foo" . t))))))
  59
  60 (ert-deftest company--manual-prefix-set-and-unset ()
  61   (with-temp-buffer
  62     (insert "ab")
  63     (company-mode)
  64     (let (company-frontends
  65           (company-backends
  66            (list (lambda (command &optional arg)
  67                    (cl-case command
  68                      (prefix (buffer-substring (point-min) (point)))
  69                      (candidates '("abc" "abd")))))))
  70       (company-manual-begin)
  71       (should (equal "ab" company--manual-prefix))
  72       (company-abort)
  73       (should (null company--manual-prefix)))))
  74
  75 (ert-deftest company-abort-manual-when-too-short ()
  76   (let ((company-minimum-prefix-length 5)
  77         (company-abort-manual-when-too-short t)
  78         (company-selection-changed t))    ;has not effect
  79     (let ((company--manual-action nil))   ;idle begin
  80       (should (eq t (company--good-prefix-p "!@#$%")))
  81       (should (eq t (company--good-prefix-p '("foo" . 5))))
  82       (should (eq t (company--good-prefix-p '("foo" . t)))))
  83     (let ((company--manual-action t)
  84           (company--manual-prefix "abc")) ;manual begin from this prefix
  85       (should (eq t (company--good-prefix-p "!@#$")))
  86       (should (eq nil (company--good-prefix-p "ab")))
  87       (should (eq nil (company--good-prefix-p 'stop)))
  88       (should (eq t (company--good-prefix-p '("foo" . 4))))
  89       (should (eq t (company--good-prefix-p "abcd")))
  90       (should (eq t (company--good-prefix-p "abc")))
  91       (should (eq t (company--good-prefix-p '("bar" . t)))))))
  92
  93 (ert-deftest company-multi-backend-with-lambdas ()
  94   (let ((company-backend
  95          (list (lambda (command &optional arg &rest ignore)
  96                  (cl-case command
  97                    (prefix "z")
  98                    (candidates '("a" "b"))))
  99                (lambda (command &optional arg &rest ignore)
 100                  (cl-case command
 101                    (prefix "z")
 102                    (candidates '("c" "d")))))))
 103     (should (equal (company-call-backend 'candidates "z") '("a" "b" "c" "d")))))
 104
 105 (ert-deftest company-multi-backend-filters-backends-by-prefix ()
 106   (let ((company-backend
 107          (list (lambda (command &optional arg &rest ignore)
 108                  (cl-case command
 109                    (prefix (cons "z" t))
 110                    (candidates '("a" "b"))))
 111                (lambda (command &optional arg &rest ignore)
 112                  (cl-case command
 113                    (prefix "t")
 114                    (candidates '("c" "d"))))
 115                (lambda (command &optional arg &rest ignore)
 116                  (cl-case command
 117                    (prefix "z")
 118                    (candidates '("e" "f")))))))
 119     (should (equal (company-call-backend 'candidates "z") '("a" "b" "e" "f")))))
 120
 121 (ert-deftest company-multi-backend-remembers-candidate-backend ()
 122   (let ((company-backend
 123          (list (lambda (command &optional arg)
 124                  (cl-case command
 125                    (ignore-case nil)
 126                    (annotation "1")
 127                    (candidates '("a" "c"))
 128                    (post-completion "13")))
 129                (lambda (command &optional arg)
 130                  (cl-case command
 131                    (ignore-case t)
 132                    (annotation "2")
 133                    (candidates '("b" "d"))
 134                    (post-completion "42")))
 135                (lambda (command &optional arg)
 136                  (cl-case command
 137                    (annotation "3")
 138                    (candidates '("e"))
 139                    (post-completion "74"))))))
 140     (let ((candidates (company-calculate-candidates nil)))
 141       (should (equal candidates '("a" "b" "c" "d" "e")))
 142       (should (equal t (company-call-backend 'ignore-case)))
 143       (should (equal "1" (company-call-backend 'annotation (nth 0 candidates))))
 144       (should (equal "2" (company-call-backend 'annotation (nth 1 candidates))))
 145       (should (equal "13" (company-call-backend 'post-completion (nth 2 candidates))))
 146       (should (equal "42" (company-call-backend 'post-completion (nth 3 candidates))))
 147       (should (equal "3" (company-call-backend 'annotation (nth 4 candidates))))
 148       (should (equal "74" (company-call-backend 'post-completion (nth 4 candidates)))))))
 149
 150 (ert-deftest company-multi-backend-handles-keyword-with ()
 151   (let ((primo (lambda (command &optional arg)
 152                  (cl-case command
 153                    (prefix "a")
 154                    (candidates '("abb" "abc" "abd")))))
 155         (secundo (lambda (command &optional arg)
 156                    (cl-case command
 157                      (prefix "a")
 158                      (candidates '("acc" "acd"))))))
 159     (let ((company-backend (list 'ignore 'ignore :with secundo)))
 160       (should (null (company-call-backend 'prefix))))
 161     (let ((company-backend (list 'ignore primo :with secundo)))
 162       (should (equal "a" (company-call-backend 'prefix)))
 163       (should (equal '("abb" "abc" "abd" "acc" "acd")
 164                      (company-call-backend 'candidates "a"))))))
 165
 166 (ert-deftest company-begin-backend-failure-doesnt-break-company-backends ()
 167   (with-temp-buffer
 168     (insert "a")
 169     (company-mode)
 170     (should-error
 171      (company-begin-backend (lambda (command &rest ignore))))
 172     (let (company-frontends
 173           (company-backends
 174            (list (lambda (command &optional arg)
 175                    (cl-case command
 176                      (prefix "a")
 177                      (candidates '("a" "ab" "ac")))))))
 178       (let (this-command)
 179         (company-call 'complete))
 180       (should (eq 3 company-candidates-length)))))
 181
 182 (ert-deftest company-require-match-explicit ()
 183   (with-temp-buffer
 184     (insert "ab")
 185     (company-mode)
 186     (let (company-frontends
 187           (company-require-match 'company-explicit-action-p)
 188           (company-backends
 189            (list (lambda (command &optional arg)
 190                    (cl-case command
 191                      (prefix (buffer-substring (point-min) (point)))
 192                      (candidates '("abc" "abd")))))))
 193       (let (this-command)
 194         (company-complete))
 195       (let ((last-command-event ?e))
 196         (company-call 'self-insert-command 1))
 197       (should (eq 2 company-candidates-length))
 198       (should (eq 3 (point))))))
 199
 200 (ert-deftest company-dont-require-match-when-idle ()
 201   (with-temp-buffer
 202     (insert "ab")
 203     (company-mode)
 204     (let (company-frontends
 205           (company-minimum-prefix-length 2)
 206           (company-require-match 'company-explicit-action-p)
 207           (company-backends
 208            (list (lambda (command &optional arg)
 209                    (cl-case command
 210                      (prefix (buffer-substring (point-min) (point)))
 211                      (candidates '("abc" "abd")))))))
 212       (company-idle-begin (current-buffer) (selected-window)
 213                           (buffer-chars-modified-tick) (point))
 214       (should (eq 2 company-candidates-length))
 215       (let ((last-command-event ?e))
 216         (company-call 'self-insert-command 1))
 217       (should (eq nil company-candidates-length))
 218       (should (eq 4 (point))))))
 219
 220 (ert-deftest company-dont-require-match-if-old-prefix-ended-and-was-a-match ()
 221   (with-temp-buffer
 222     (insert "ab")
 223     (company-mode)
 224     (let (company-frontends
 225           (company-require-match 'company-explicit-action-p)
 226           (company-backends
 227            (list (lambda (command &optional arg)
 228                    (cl-case command
 229                      (prefix (company-grab-word))
 230                      (candidates '("abc" "ab" "abd"))
 231                      (sorted t))))))
 232       (let (this-command)
 233         (company-complete))
 234       (let ((last-command-event ?e))
 235         (company-call 'self-insert-command 1))
 236       (should (eq 3 company-candidates-length))
 237       (should (eq 3 (point)))
 238       (let ((last-command-event ? ))
 239         (company-call 'self-insert-command 1))
 240       (should (null company-candidates-length))
 241       (should (eq 4 (point))))))
 242
 243 (ert-deftest company-should-complete-whitelist ()
 244   (with-temp-buffer
 245     (insert "ab")
 246     (company-mode)
 247     (let (company-frontends
 248           company-begin-commands
 249           (company-backends
 250            (list (lambda (command &optional arg)
 251                    (cl-case command
 252                      (prefix (buffer-substring (point-min) (point)))
 253                      (candidates '("abc" "abd")))))))
 254       (let ((company-continue-commands nil))
 255         (let (this-command)
 256           (company-complete))
 257         (company-call 'backward-delete-char 1)
 258         (should (null company-candidates-length)))
 259       (let ((company-continue-commands '(backward-delete-char)))
 260         (let (this-command)
 261           (company-complete))
 262         (company-call 'backward-delete-char 1)
 263         (should (eq 2 company-candidates-length))))))
 264
 265 (ert-deftest company-should-complete-blacklist ()
 266   (with-temp-buffer
 267     (insert "ab")
 268     (company-mode)
 269     (let (company-frontends
 270           company-begin-commands
 271           (company-backends
 272            (list (lambda (command &optional arg)
 273                    (cl-case command
 274                      (prefix (buffer-substring (point-min) (point)))
 275                      (candidates '("abc" "abd")))))))
 276       (let ((company-continue-commands '(not backward-delete-char)))
 277         (let (this-command)
 278           (company-complete))
 279         (company-call 'backward-delete-char 1)
 280         (should (null company-candidates-length)))
 281       (let ((company-continue-commands '(not backward-delete-char-untabify)))
 282         (let (this-command)
 283           (company-complete))
 284         (company-call 'backward-delete-char 1)
 285         (should (eq 2 company-candidates-length))))))
 286
 287 (ert-deftest company-auto-complete-explicit ()
 288   (with-temp-buffer
 289     (insert "ab")
 290     (company-mode)
 291     (let (company-frontends
 292           (company-auto-complete 'company-explicit-action-p)
 293           (company-auto-complete-chars '(? ))
 294           (company-backends
 295            (list (lambda (command &optional arg)
 296                    (cl-case command
 297                      (prefix (buffer-substring (point-min) (point)))
 298                      (candidates '("abcd" "abef")))))))
 299       (let (this-command)
 300         (company-complete))
 301       (let ((last-command-event ? ))
 302         (company-call 'self-insert-command 1))
 303       (should (string= "abcd " (buffer-string))))))
 304
 305 (ert-deftest company-no-auto-complete-when-idle ()
 306   (with-temp-buffer
 307     (insert "ab")
 308     (company-mode)
 309     (let (company-frontends
 310           (company-auto-complete 'company-explicit-action-p)
 311           (company-auto-complete-chars '(? ))
 312           (company-minimum-prefix-length 2)
 313           (company-backends
 314            (list (lambda (command &optional arg)
 315                    (cl-case command
 316                      (prefix (buffer-substring (point-min) (point)))
 317                      (candidates '("abcd" "abef")))))))
 318       (company-idle-begin (current-buffer) (selected-window)
 319                           (buffer-chars-modified-tick) (point))
 320       (let ((last-command-event ? ))
 321         (company-call 'self-insert-command 1))
 322       (should (string= "ab " (buffer-string))))))
 323
 324 (ert-deftest company-clears-explicit-action-when-no-matches ()
 325   (with-temp-buffer
 326     (company-mode)
 327     (let (company-frontends
 328           company-backends)
 329       (company-call 'manual-begin) ;; fails
 330       (should (null company-candidates))
 331       (should (null (company-explicit-action-p))))))
 332
 333 (ert-deftest company-ignore-case-replaces-prefix ()
 334   (with-temp-buffer
 335     (company-mode)
 336     (let (company-frontends
 337           company-end-of-buffer-workaround
 338           (company-backends
 339            (list (lambda (command &optional arg)
 340                    (cl-case command
 341                      (prefix (buffer-substring (point-min) (point)))
 342                      (candidates '("abcd" "abef"))
 343                      (ignore-case t))))))
 344       (insert "A")
 345       (let (this-command)
 346         (company-complete))
 347       (should (string= "ab" (buffer-string)))
 348       (delete-char -2)
 349       (insert "A") ; hack, to keep it in one test
 350       (company-complete-selection)
 351       (should (string= "abcd" (buffer-string))))))
 352
 353 (ert-deftest company-ignore-case-with-keep-prefix ()
 354   (with-temp-buffer
 355     (insert "AB")
 356     (company-mode)
 357     (let (company-frontends
 358           (company-backends
 359            (list (lambda (command &optional arg)
 360                    (cl-case command
 361                      (prefix (buffer-substring (point-min) (point)))
 362                      (candidates '("abcd" "abef"))
 363                      (ignore-case 'keep-prefix))))))
 364       (let (this-command)
 365         (company-complete))
 366       (company-complete-selection)
 367       (should (string= "ABcd" (buffer-string))))))
 368
 369 (ert-deftest company-non-prefix-completion ()
 370   (with-temp-buffer
 371     (insert "tc")
 372     (company-mode)
 373     (let (company-frontends
 374           company-end-of-buffer-workaround
 375           (company-backends
 376            (list (lambda (command &optional arg)
 377                    (cl-case command
 378                      (prefix (buffer-substring (point-min) (point)))
 379                      (candidates '("tea-cup" "teal-color")))))))
 380       (let (this-command)
 381         (company-complete))
 382       (should (string= "tc" (buffer-string)))
 383       (company-complete-selection)
 384       (should (string= "tea-cup" (buffer-string))))))
 385
 386 (ert-deftest company-pseudo-tooltip-does-not-get-displaced ()
 387   :tags '(interactive)
 388   (with-temp-buffer
 389     (save-window-excursion
 390       (set-window-buffer nil (current-buffer))
 391       (save-excursion (insert " ff"))
 392       (company-mode)
 393       (let ((company-frontends '(company-pseudo-tooltip-frontend))
 394             (company-begin-commands '(self-insert-command))
 395             (company-backends
 396              (list (lambda (c &optional arg)
 397                      (cl-case c (prefix "") (candidates '("a" "b" "c")))))))
 398         (let (this-command)
 399           (company-call 'complete))
 400         (company-call 'open-line 1)
 401         (should (eq 1 (overlay-start company-pseudo-tooltip-overlay)))))))
 402
 403 (ert-deftest company-pseudo-tooltip-show ()
 404   :tags '(interactive)
 405   (with-temp-buffer
 406     (save-window-excursion
 407     (set-window-buffer nil (current-buffer))
 408     (insert "aaaa\n  bb\nccccccc\nddd")
 409     (search-backward "bb")
 410     (let ((col (company--column))
 411           (company-candidates-length 2)
 412           (company-candidates '("123" "45"))
 413           (company-backend 'ignore))
 414       (company-pseudo-tooltip-show (company--row) col 0)
 415       (let ((ov company-pseudo-tooltip-overlay))
 416         ;; With margins.
 417         (should (eq (overlay-get ov 'company-width) 5))
 418         ;; FIXME: Make it 2?
 419         (should (eq (overlay-get ov 'company-height) company-tooltip-limit))
 420         (should (eq (overlay-get ov 'company-column) col))
 421         (should (string= (overlay-get ov 'company-display)
 422                          "\n  123 \nc 45  c\nddd\n")))))))
 423
 424 (ert-deftest company-pseudo-tooltip-edit-updates-width ()
 425   :tags '(interactive)
 426   (with-temp-buffer
 427     (set-window-buffer nil (current-buffer))
 428     (let ((company-candidates-length 5)
 429           (company-candidates '("123" "45" "67" "89" "1011"))
 430           (company-backend 'ignore)
 431           (company-tooltip-limit 4)
 432           (company-tooltip-offset-display 'scrollbar))
 433       (company-pseudo-tooltip-show (company--row)
 434                                    (company--column)
 435                                    0)
 436       (should (eq (overlay-get company-pseudo-tooltip-overlay 'company-width)
 437                   6))
 438       (company-pseudo-tooltip-edit 4)
 439       (should (eq (overlay-get company-pseudo-tooltip-overlay 'company-width)
 440                   7)))))
 441
 442 (ert-deftest company-preview-show-with-annotations ()
 443   :tags '(interactive)
 444   (with-temp-buffer
 445     (save-window-excursion
 446       (set-window-buffer nil (current-buffer))
 447       (save-excursion (insert "\n"))
 448       (let ((company-candidates-length 1)
 449             (company-candidates '("123")))
 450         (company-preview-show-at-point (point))
 451         (let* ((ov company-preview-overlay)
 452                (str (overlay-get ov 'after-string)))
 453           (should (string= str "123"))
 454           (should (eq (get-text-property 0 'cursor str) t)))))))
 455
 456 (ert-deftest company-pseudo-tooltip-show-with-annotations ()
 457   :tags '(interactive)
 458   (with-temp-buffer
 459     (save-window-excursion
 460       (set-window-buffer nil (current-buffer))
 461       (insert " ")
 462       (save-excursion (insert "\n"))
 463       (let ((company-candidates-length 2)
 464             (company-backend (lambda (action &optional arg &rest _ignore)
 465                                (when (eq action 'annotation)
 466                                  (cdr (assoc arg '(("123" . "(4)")))))))
 467             (company-candidates '("123" "45"))
 468             company-tooltip-align-annotations)
 469         (company-pseudo-tooltip-show-at-point (point) 0)
 470         (let ((ov company-pseudo-tooltip-overlay))
 471           ;; With margins.
 472           (should (eq (overlay-get ov 'company-width) 8))
 473           (should (string= (overlay-get ov 'company-display)
 474                            "\n 123(4) \n 45     \n")))))))
 475
 476 (ert-deftest company-pseudo-tooltip-show-with-annotations-right-aligned ()
 477   :tags '(interactive)
 478   (with-temp-buffer
 479     (save-window-excursion
 480       (set-window-buffer nil (current-buffer))
 481       (insert " ")
 482       (save-excursion (insert "\n"))
 483       (let ((company-candidates-length 3)
 484             (company-backend (lambda (action &optional arg &rest _ignore)
 485                                (when (eq action 'annotation)
 486                                  (cdr (assoc arg '(("123" . "(4)")
 487                                                    ("67" . "(891011)")))))))
 488             (company-candidates '("123" "45" "67"))
 489             (company-tooltip-align-annotations t))
 490         (company-pseudo-tooltip-show-at-point (point) 0)
 491         (let ((ov company-pseudo-tooltip-overlay))
 492           ;; With margins.
 493           (should (eq (overlay-get ov 'company-width) 13))
 494           (should (string= (overlay-get ov 'company-display)
 495                            "\n 123     (4) \n 45          \n 67 (891011) \n")))))))
 496
 497 (ert-deftest company-create-lines-shows-numbers ()
 498   (let ((company-show-numbers t)
 499         (company-candidates '("x" "y" "z"))
 500         (company-candidates-length 3)
 501         (company-backend 'ignore))
 502     (should (equal '(" x 1 " " y 2 " " z 3 ")
 503                    (company--create-lines 0 999)))))
 504
 505 (ert-deftest company-create-lines-truncates-annotations ()
 506   (let* ((ww (company--window-width))
 507          (data `(("1" . "(123)")
 508                  ("2" . nil)
 509                  ("3" . ,(concat "(" (make-string (- ww 2) ?4) ")"))
 510                  (,(make-string ww ?4) . "<4>")))
 511          (company-candidates (mapcar #'car data))
 512          (company-candidates-length 4)
 513          (company-tooltip-margin 1)
 514          (company-backend (lambda (cmd &optional arg)
 515                             (when (eq cmd 'annotation)
 516                               (cdr (assoc arg data)))))
 517          company-tooltip-align-annotations)
 518     (should (equal (list (format " 1(123)%s " (company-space-string (- ww 8)))
 519                          (format " 2%s " (company-space-string (- ww 3)))
 520                          (format " 3(444%s " (make-string (- ww 7) ?4))
 521                          (format " %s " (make-string (- ww 2) ?4)))
 522                    (company--create-lines 0 999)))
 523     (let ((company-tooltip-align-annotations t))
 524       (should (equal (list (format " 1%s(123) " (company-space-string (- ww 8)))
 525                            (format " 2%s " (company-space-string (- ww 3)))
 526                            (format " 3 (444%s " (make-string (- ww 8) ?4))
 527                            (format " %s " (make-string (- ww 2) ?4)))
 528                      (company--create-lines 0 999))))))
 529
 530 (ert-deftest company-create-lines-truncates-common-part ()
 531   (let* ((ww (company--window-width))
 532          (company-candidates-length 2)
 533          (company-tooltip-margin 1)
 534          (company-backend #'ignore))
 535     (let* ((company-common (make-string (- ww 3) ?1))
 536            (company-candidates `(,(concat company-common "2")
 537                                  ,(concat company-common "3"))))
 538       (should (equal (list (format " %s2 " (make-string (- ww 3) ?1))
 539                            (format " %s3 " (make-string (- ww 3) ?1)))
 540                      (company--create-lines 0 999))))
 541     (let* ((company-common (make-string (- ww 2) ?1))
 542            (company-candidates `(,(concat company-common "2")
 543                                  ,(concat company-common "3"))))
 544       (should (equal (list (format " %s " company-common)
 545                            (format " %s " company-common))
 546                      (company--create-lines 0 999))))
 547     (let* ((company-common (make-string ww ?1))
 548            (company-candidates `(,(concat company-common "2")
 549                                  ,(concat company-common "3")))
 550            (res (company--create-lines 0 999)))
 551       (should (equal (list (format " %s " (make-string (- ww 2) ?1))
 552                            (format " %s " (make-string (- ww 2) ?1)))
 553                      res))
 554       (should (eq 'company-tooltip-common-selection
 555                     (get-text-property (- ww 2) 'face
 556                                        (car res))))
 557       (should (eq 'company-tooltip-selection
 558                   (get-text-property (1- ww) 'face
 559                                      (car res))))
 560
 561 )))
 562
 563 (ert-deftest company-column-with-composition ()
 564   :tags '(interactive)
 565   (with-temp-buffer
 566     (save-window-excursion
 567       (set-window-buffer nil (current-buffer))
 568       (insert "lambda ()")
 569       (compose-region 1 (1+ (length "lambda")) "\\")
 570       (should (= (company--column) 4)))))
 571
 572 (ert-deftest company-column-with-line-prefix ()
 573   :tags '(interactive)
 574   (with-temp-buffer
 575     (save-window-excursion
 576       (set-window-buffer nil (current-buffer))
 577       (insert "foo")
 578       (put-text-property (point-min) (point) 'line-prefix "  ")
 579       (should (= (company--column) 5)))))
 580
 581 (ert-deftest company-column-with-line-prefix-on-empty-line ()
 582   :tags '(interactive)
 583   (with-temp-buffer
 584     (save-window-excursion
 585       (set-window-buffer nil (current-buffer))
 586       (insert "\n")
 587       (forward-char -1)
 588       (put-text-property (point-min) (point-max) 'line-prefix "  ")
 589       (should (= (company--column) 2)))))
 590
 591 (ert-deftest company-column-with-tabs ()
 592   :tags '(interactive)
 593   (with-temp-buffer
 594     (save-window-excursion
 595       (set-window-buffer nil (current-buffer))
 596       (insert "|\t|\t|\t(")
 597       (let ((tab-width 8))
 598         (should (= (company--column) 25))))))
 599
 600 (ert-deftest company-row-with-header-line-format ()
 601   :tags '(interactive)
 602   (with-temp-buffer
 603     (save-window-excursion
 604       (set-window-buffer nil (current-buffer))
 605       (should (= (company--row) 0))
 606       (setq header-line-format "aaaaaaa")
 607       (should (= (company--row) 0)))))
 608
 609 (ert-deftest company-plainify ()
 610   (let ((tab-width 8))
 611     (should (equal-including-properties
 612              (company-plainify "\tabc\td\t")
 613              (concat "        "
 614                      "abc     "
 615                      "d       "))))
 616   (should (equal-including-properties
 617            (company-plainify (propertize "foobar" 'line-prefix "-*-"))
 618            "-*-foobar")))
 619
 620 (ert-deftest company-buffer-lines-with-lines-folded ()
 621   :tags '(interactive)
 622   (with-temp-buffer
 623     (insert (propertize "aaa\nbbb\nccc\nddd\n" 'display "aaa+\n"))
 624     (insert "eee\nfff\nggg")
 625     (should (equal (company-buffer-lines (point-min) (point-max))
 626                    '("aaa" "eee" "fff" "ggg")))))
 627
 628 (ert-deftest company-buffer-lines-with-multiline-display ()
 629   :tags '(interactive)
 630   (with-temp-buffer
 631     (insert (propertize "a" 'display "bbb\nccc\ndddd\n"))
 632     (insert "eee\nfff\nggg")
 633     (should (equal (company-buffer-lines (point-min) (point-max))
 634                    '("" "" "" "eee" "fff" "ggg")))))
 635
 636 (ert-deftest company-modify-line ()
 637   (let ((str "-*-foobar"))
 638     (should (equal-including-properties
 639              (company-modify-line str "zz" 4)
 640              "-*-fzzbar"))
 641     (should (equal-including-properties
 642              (company-modify-line str "xx" 0)
 643              "xx-foobar"))
 644     (should (equal-including-properties
 645              (company-modify-line str "zz" 10)
 646              "-*-foobar zz"))))
 647
 648 (ert-deftest company-scrollbar-bounds ()
 649   (should (equal nil (company--scrollbar-bounds 0 3 3)))
 650   (should (equal nil (company--scrollbar-bounds 0 4 3)))
 651   (should (equal '(0 . 0) (company--scrollbar-bounds 0 1 2)))
 652   (should (equal '(1 . 1) (company--scrollbar-bounds 2 2 4)))
 653   (should (equal '(2 . 3) (company--scrollbar-bounds 7 4 12)))
 654   (should (equal '(1 . 2) (company--scrollbar-bounds 3 4 12)))
 655   (should (equal '(1 . 3) (company--scrollbar-bounds 4 5 11))))
 656
 657 ;;; Async
 658
 659 (defun company-async-backend (command &optional arg)
 660   (pcase command
 661     (`prefix "foo")
 662     (`candidates
 663      (cons :async
 664            (lambda (cb)
 665              (run-with-timer 0.05 nil
 666                              #'funcall cb '("abc" "abd")))))))
 667
 668 (ert-deftest company-call-backend-forces-sync ()
 669   (let ((company-backend 'company-async-backend)
 670         (company-async-timeout 0.1))
 671     (should (equal '("abc" "abd") (company-call-backend 'candidates)))))
 672
 673 (ert-deftest company-call-backend-errors-on-timeout ()
 674   (with-temp-buffer
 675     (let* ((company-backend (lambda (command &optional _arg)
 676                               (pcase command
 677                                 (`candidates (cons :async 'ignore)))))
 678            (company-async-timeout 0.1)
 679            (err (should-error (company-call-backend 'candidates "foo"))))
 680       (should (string-match-p "async timeout" (cadr err))))))
 681
 682 (ert-deftest company-call-backend-raw-passes-return-value-verbatim ()
 683   (let ((company-backend 'company-async-backend))
 684     (should (equal "foo" (company-call-backend-raw 'prefix)))
 685     (should (equal :async (car (company-call-backend-raw 'candidates "foo"))))
 686     (should (equal 'closure (cadr (company-call-backend-raw 'candidates "foo"))))))
 687
 688 (ert-deftest company-manual-begin-forces-async-candidates-to-sync ()
 689   (with-temp-buffer
 690     (company-mode)
 691     (let (company-frontends
 692           company-transformers
 693           (company-backends (list 'company-async-backend)))
 694       (company-manual-begin)
 695       (should (equal "foo" company-prefix))
 696       (should (equal '("abc" "abd") company-candidates)))))
 697
 698 (ert-deftest company-idle-begin-allows-async-candidates ()
 699   (with-temp-buffer
 700     (company-mode)
 701     (let (company-frontends
 702           company-transformers
 703           (company-backends (list 'company-async-backend)))
 704       (company-idle-begin (current-buffer) (selected-window)
 705                           (buffer-chars-modified-tick) (point))
 706       (should (null company-candidates))
 707       (sleep-for 0.1)
 708       (should (equal "foo" company-prefix))
 709       (should (equal '("abc" "abd") company-candidates)))))
 710
 711 (ert-deftest company-idle-begin-cancels-async-candidates-if-buffer-changed ()
 712   (with-temp-buffer
 713     (company-mode)
 714     (let (company-frontends
 715           (company-backends (list 'company-async-backend)))
 716       (company-idle-begin (current-buffer) (selected-window)
 717                           (buffer-chars-modified-tick) (point))
 718       (should (null company-candidates))
 719       (insert "a")
 720       (sleep-for 0.1)
 721       (should (null company-candidates)))))
 722
 723 (ert-deftest company-idle-begin-async-allows-immediate-callbacks ()
 724   (with-temp-buffer
 725     (company-mode)
 726     (let (company-frontends
 727           (company-backends
 728            (list (lambda (command &optional arg)
 729                    (pcase command
 730                      (`prefix (buffer-substring (point-min) (point)))
 731                      (`candidates
 732                       (let ((c (all-completions arg '("abc" "def"))))
 733                         (cons :async
 734                               (lambda (cb) (funcall cb c)))))
 735                      (`no-cache t)))))
 736           (company-minimum-prefix-length 0))
 737       (company-idle-begin (current-buffer) (selected-window)
 738                           (buffer-chars-modified-tick) (point))
 739       (should (equal '("abc" "def") company-candidates))
 740       (let ((last-command-event ?a))
 741         (company-call 'self-insert-command 1))
 742       (should (equal '("abc") company-candidates)))))
 743
 744 (ert-deftest company-multi-backend-forces-prefix-to-sync ()
 745   (with-temp-buffer
 746     (let ((company-backend (list 'ignore
 747                                  (lambda (command)
 748                                    (should (eq command 'prefix))
 749                                    (cons :async
 750                                          (lambda (cb)
 751                                            (run-with-timer
 752                                             0.01 nil
 753                                             (lambda () (funcall cb nil))))))
 754                                  (lambda (command)
 755                                    (should (eq command 'prefix))
 756                                    "foo"))))
 757       (should (equal "foo" (company-call-backend-raw 'prefix))))
 758     (let ((company-backend (list (lambda (_command)
 759                                    (cons :async
 760                                          (lambda (cb)
 761                                            (run-with-timer
 762                                             0.01 nil
 763                                             (lambda () (funcall cb "bar"))))))
 764                                  (lambda (_command)
 765                                    "foo"))))
 766       (should (equal "bar" (company-call-backend-raw 'prefix))))))
 767
 768 (ert-deftest company-multi-backend-merges-deferred-candidates ()
 769   (with-temp-buffer
 770     (let* ((immediate (lambda (command &optional arg)
 771                         (pcase command
 772                           (`prefix "foo")
 773                           (`candidates
 774                            (cons :async
 775                                  (lambda (cb) (funcall cb '("f"))))))))
 776            (company-backend (list 'ignore
 777                                   (lambda (command &optional arg)
 778                                     (pcase command
 779                                       (`prefix "foo")
 780                                       (`candidates
 781                                        (should (equal arg "foo"))
 782                                        (cons :async
 783                                              (lambda (cb)
 784                                                (run-with-timer
 785                                                 0.01 nil
 786                                                 (lambda () (funcall cb '("a" "b")))))))))
 787                                   (lambda (command &optional arg)
 788                                     (pcase command
 789                                       (`prefix "foo")
 790                                       (`candidates '("c" "d" "e"))))
 791                                   immediate)))
 792       (should (equal :async (car (company-call-backend-raw 'candidates "foo"))))
 793       (should (equal '("a" "b" "c" "d" "e" "f")
 794                      (company-call-backend 'candidates "foo")))
 795       (let ((company-backend (list immediate)))
 796         (should (equal '("f") (company-call-backend 'candidates "foo")))))))
 797
 798 ;;; Transformers
 799
 800 (ert-deftest company-occurrence-prefer-closest-above ()
 801   (with-temp-buffer
 802     (save-window-excursion
 803       (set-window-buffer nil (current-buffer))
 804       (insert "foo0
 805 foo1
 806 ")
 807       (save-excursion
 808         (insert "
 809 foo3
 810 foo2"))
 811       (let ((company-backend 'company-dabbrev)
 812             (company-occurrence-weight-function
 813              'company-occurrence-prefer-closest-above))
 814         (should (equal '("foo1" "foo0" "foo3" "foo2" "foo4")
 815                        (company-sort-by-occurrence
 816                         '("foo0" "foo1" "foo2" "foo3" "foo4"))))))))
 817
 818 (ert-deftest company-occurrence-prefer-any-closest ()
 819   (with-temp-buffer
 820     (save-window-excursion
 821       (set-window-buffer nil (current-buffer))
 822       (insert "foo0
 823 foo1
 824 ")
 825       (save-excursion
 826         (insert "
 827 foo3
 828 foo2"))
 829       (let ((company-backend 'company-dabbrev)
 830             (company-occurrence-weight-function
 831              'company-occurrence-prefer-any-closest))
 832         (should (equal '("foo1" "foo3" "foo0" "foo2" "foo4")
 833                        (company-sort-by-occurrence
 834                         '("foo0" "foo1" "foo2" "foo3" "foo4"))))))))
 835
 836 ;;; Template
 837
 838 (ert-deftest company-template-removed-after-the-last-jump ()
 839   (with-temp-buffer
 840     (insert "{ }")
 841     (goto-char 2)
 842     (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
 843       (save-excursion
 844         (dotimes (i 2)
 845           (insert " ")
 846           (company-template-add-field tpl (point) "foo")))
 847       (company-call 'template-forward-field)
 848       (should (= 3 (point)))
 849       (company-call 'template-forward-field)
 850       (should (= 7 (point)))
 851       (company-call 'template-forward-field)
 852       (should (= 11 (point)))
 853       (should (zerop (length (overlay-get tpl 'company-template-fields))))
 854       (should (null (overlay-buffer tpl))))))
 855
 856 (ert-deftest company-template-removed-after-input-and-jump ()
 857   (with-temp-buffer
 858     (insert "{ }")
 859     (goto-char 2)
 860     (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
 861       (save-excursion
 862         (insert " ")
 863         (company-template-add-field tpl (point) "bar"))
 864       (company-call 'template-move-to-first tpl)
 865       (should (= 3 (point)))
 866       (dolist (c (string-to-list "tee"))
 867         (let ((last-command-event c))
 868           (company-call 'self-insert-command 1)))
 869       (should (string= "{ tee }" (buffer-string)))
 870       (should (overlay-buffer tpl))
 871       (company-call 'template-forward-field)
 872       (should (= 7 (point)))
 873       (should (null (overlay-buffer tpl))))))
 874
 875 (defun company-call (name &rest args)
 876   (let* ((maybe (intern (format "company-%s" name)))
 877          (command (if (fboundp maybe) maybe name)))
 878     (let ((this-command command))
 879       (run-hooks 'pre-command-hook))
 880     (apply command args)
 881     (let ((this-command command))
 882       (run-hooks 'post-command-hook))))
 883
 884 (ert-deftest company-template-c-like-templatify ()
 885   (with-temp-buffer
 886     (let ((text "foo(int a, short b)"))
 887       (insert text)
 888       (company-template-c-like-templatify text)
 889       (should (equal "foo(arg0, arg1)" (buffer-string)))
 890       (should (looking-at "arg0"))
 891       (should (equal "int a"
 892                      (overlay-get (company-template-field-at) 'display))))))
 893
 894 (ert-deftest company-template-c-like-templatify-trims-after-closing-paren ()
 895   (with-temp-buffer
 896     (let ((text "foo(int a, short b)!@ #1334 a"))
 897       (insert text)
 898       (company-template-c-like-templatify text)
 899       (should (equal "foo(arg0, arg1)" (buffer-string)))
 900       (should (looking-at "arg0")))))
 901
 902 ;;; Clang
 903
 904 (ert-deftest company-clang-objc-templatify ()
 905   (with-temp-buffer
 906     (let ((text "createBookWithTitle:andAuthor:"))
 907       (insert text)
 908       (company-clang-objc-templatify text)
 909       (should (equal "createBookWithTitle:arg0 andAuthor:arg1" (buffer-string)))
 910       (should (looking-at "arg0"))
 911       (should (null (overlay-get (company-template-field-at) 'display))))))