]> code.delx.au - gnu-emacs-elpa/blob - company-tests.el
Support multiple-width chars in annotations
[gnu-emacs-elpa] / 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 (ert-deftest company-create-lines-clears-out-non-printables ()
563 :tags '(interactive)
564 (let (company-show-numbers
565 (company-candidates (list
566 (decode-coding-string "avalis\351e" 'utf-8)
567 "avatar"))
568 (company-candidates-length 2)
569 (company-backend 'ignore))
570 (should (equal '(" avalis‗e "
571 " avatar ")
572 (company--create-lines 0 999)))))
573
574 (ert-deftest company-create-lines-handles-multiple-width ()
575 :tags '(interactive)
576 (let (company-show-numbers
577 (company-candidates '("蛙蛙蛙蛙" "蛙abc"))
578 (company-candidates-length 2)
579 (company-backend 'ignore))
580 (should (equal '(" 蛙蛙蛙蛙 "
581 " 蛙abc ")
582 (company--create-lines 0 999)))))
583
584 (ert-deftest company-create-lines-handles-multiple-width-in-annotation ()
585 (let* (company-show-numbers
586 (alist '(("a" . " ︸") ("b" . " ︸︸")))
587 (company-candidates (mapcar #'car alist))
588 (company-candidates-length 2)
589 (company-backend (lambda (c &optional a)
590 (when (eq c 'annotation)
591 (assoc-default a alist)))))
592 (should (equal '(" a ︸ "
593 " b ︸︸ ")
594 (company--create-lines 0 999)))))
595
596 (ert-deftest company-column-with-composition ()
597 :tags '(interactive)
598 (with-temp-buffer
599 (save-window-excursion
600 (set-window-buffer nil (current-buffer))
601 (insert "lambda ()")
602 (compose-region 1 (1+ (length "lambda")) "\\")
603 (should (= (company--column) 4)))))
604
605 (ert-deftest company-column-with-line-prefix ()
606 :tags '(interactive)
607 (with-temp-buffer
608 (save-window-excursion
609 (set-window-buffer nil (current-buffer))
610 (insert "foo")
611 (put-text-property (point-min) (point) 'line-prefix " ")
612 (should (= (company--column) 5)))))
613
614 (ert-deftest company-column-with-line-prefix-on-empty-line ()
615 :tags '(interactive)
616 (with-temp-buffer
617 (save-window-excursion
618 (set-window-buffer nil (current-buffer))
619 (insert "\n")
620 (forward-char -1)
621 (put-text-property (point-min) (point-max) 'line-prefix " ")
622 (should (= (company--column) 2)))))
623
624 (ert-deftest company-column-with-tabs ()
625 :tags '(interactive)
626 (with-temp-buffer
627 (save-window-excursion
628 (set-window-buffer nil (current-buffer))
629 (insert "|\t|\t|\t(")
630 (let ((tab-width 8))
631 (should (= (company--column) 25))))))
632
633 (ert-deftest company-row-with-header-line-format ()
634 :tags '(interactive)
635 (with-temp-buffer
636 (save-window-excursion
637 (set-window-buffer nil (current-buffer))
638 (should (= (company--row) 0))
639 (setq header-line-format "aaaaaaa")
640 (should (= (company--row) 0)))))
641
642 (ert-deftest company-plainify ()
643 (let ((tab-width 8))
644 (should (equal-including-properties
645 (company-plainify "\tabc\td\t")
646 (concat " "
647 "abc "
648 "d "))))
649 (should (equal-including-properties
650 (company-plainify (propertize "foobar" 'line-prefix "-*-"))
651 "-*-foobar")))
652
653 (ert-deftest company-buffer-lines-with-lines-folded ()
654 :tags '(interactive)
655 (with-temp-buffer
656 (insert (propertize "aaa\nbbb\nccc\nddd\n" 'display "aaa+\n"))
657 (insert "eee\nfff\nggg")
658 (should (equal (company-buffer-lines (point-min) (point-max))
659 '("aaa" "eee" "fff" "ggg")))))
660
661 (ert-deftest company-buffer-lines-with-multiline-display ()
662 :tags '(interactive)
663 (with-temp-buffer
664 (insert (propertize "a" 'display "bbb\nccc\ndddd\n"))
665 (insert "eee\nfff\nggg")
666 (should (equal (company-buffer-lines (point-min) (point-max))
667 '("" "" "" "eee" "fff" "ggg")))))
668
669 (ert-deftest company-modify-line ()
670 (let ((str "-*-foobar"))
671 (should (equal-including-properties
672 (company-modify-line str "zz" 4)
673 "-*-fzzbar"))
674 (should (equal-including-properties
675 (company-modify-line str "xx" 0)
676 "xx-foobar"))
677 (should (equal-including-properties
678 (company-modify-line str "zz" 10)
679 "-*-foobar zz"))))
680
681 (ert-deftest company-scrollbar-bounds ()
682 (should (equal nil (company--scrollbar-bounds 0 3 3)))
683 (should (equal nil (company--scrollbar-bounds 0 4 3)))
684 (should (equal '(0 . 0) (company--scrollbar-bounds 0 1 2)))
685 (should (equal '(1 . 1) (company--scrollbar-bounds 2 2 4)))
686 (should (equal '(2 . 3) (company--scrollbar-bounds 7 4 12)))
687 (should (equal '(1 . 2) (company--scrollbar-bounds 3 4 12)))
688 (should (equal '(1 . 3) (company--scrollbar-bounds 4 5 11))))
689
690 ;;; Async
691
692 (defun company-async-backend (command &optional arg)
693 (pcase command
694 (`prefix "foo")
695 (`candidates
696 (cons :async
697 (lambda (cb)
698 (run-with-timer 0.05 nil
699 #'funcall cb '("abc" "abd")))))))
700
701 (ert-deftest company-call-backend-forces-sync ()
702 (let ((company-backend 'company-async-backend)
703 (company-async-timeout 0.1))
704 (should (equal '("abc" "abd") (company-call-backend 'candidates)))))
705
706 (ert-deftest company-call-backend-errors-on-timeout ()
707 (with-temp-buffer
708 (let* ((company-backend (lambda (command &optional _arg)
709 (pcase command
710 (`candidates (cons :async 'ignore)))))
711 (company-async-timeout 0.1)
712 (err (should-error (company-call-backend 'candidates "foo"))))
713 (should (string-match-p "async timeout" (cadr err))))))
714
715 (ert-deftest company-call-backend-raw-passes-return-value-verbatim ()
716 (let ((company-backend 'company-async-backend))
717 (should (equal "foo" (company-call-backend-raw 'prefix)))
718 (should (equal :async (car (company-call-backend-raw 'candidates "foo"))))
719 (should (equal 'closure (cadr (company-call-backend-raw 'candidates "foo"))))))
720
721 (ert-deftest company-manual-begin-forces-async-candidates-to-sync ()
722 (with-temp-buffer
723 (company-mode)
724 (let (company-frontends
725 company-transformers
726 (company-backends (list 'company-async-backend)))
727 (company-manual-begin)
728 (should (equal "foo" company-prefix))
729 (should (equal '("abc" "abd") company-candidates)))))
730
731 (ert-deftest company-idle-begin-allows-async-candidates ()
732 (with-temp-buffer
733 (company-mode)
734 (let (company-frontends
735 company-transformers
736 (company-backends (list 'company-async-backend)))
737 (company-idle-begin (current-buffer) (selected-window)
738 (buffer-chars-modified-tick) (point))
739 (should (null company-candidates))
740 (sleep-for 0.1)
741 (should (equal "foo" company-prefix))
742 (should (equal '("abc" "abd") company-candidates)))))
743
744 (ert-deftest company-idle-begin-cancels-async-candidates-if-buffer-changed ()
745 (with-temp-buffer
746 (company-mode)
747 (let (company-frontends
748 (company-backends (list 'company-async-backend)))
749 (company-idle-begin (current-buffer) (selected-window)
750 (buffer-chars-modified-tick) (point))
751 (should (null company-candidates))
752 (insert "a")
753 (sleep-for 0.1)
754 (should (null company-candidates)))))
755
756 (ert-deftest company-idle-begin-async-allows-immediate-callbacks ()
757 (with-temp-buffer
758 (company-mode)
759 (let (company-frontends
760 (company-backends
761 (list (lambda (command &optional arg)
762 (pcase command
763 (`prefix (buffer-substring (point-min) (point)))
764 (`candidates
765 (let ((c (all-completions arg '("abc" "def"))))
766 (cons :async
767 (lambda (cb) (funcall cb c)))))
768 (`no-cache t)))))
769 (company-minimum-prefix-length 0))
770 (company-idle-begin (current-buffer) (selected-window)
771 (buffer-chars-modified-tick) (point))
772 (should (equal '("abc" "def") company-candidates))
773 (let ((last-command-event ?a))
774 (company-call 'self-insert-command 1))
775 (should (equal '("abc") company-candidates)))))
776
777 (ert-deftest company-multi-backend-forces-prefix-to-sync ()
778 (with-temp-buffer
779 (let ((company-backend (list 'ignore
780 (lambda (command)
781 (should (eq command 'prefix))
782 (cons :async
783 (lambda (cb)
784 (run-with-timer
785 0.01 nil
786 (lambda () (funcall cb nil))))))
787 (lambda (command)
788 (should (eq command 'prefix))
789 "foo"))))
790 (should (equal "foo" (company-call-backend-raw 'prefix))))
791 (let ((company-backend (list (lambda (_command)
792 (cons :async
793 (lambda (cb)
794 (run-with-timer
795 0.01 nil
796 (lambda () (funcall cb "bar"))))))
797 (lambda (_command)
798 "foo"))))
799 (should (equal "bar" (company-call-backend-raw 'prefix))))))
800
801 (ert-deftest company-multi-backend-merges-deferred-candidates ()
802 (with-temp-buffer
803 (let* ((immediate (lambda (command &optional arg)
804 (pcase command
805 (`prefix "foo")
806 (`candidates
807 (cons :async
808 (lambda (cb) (funcall cb '("f"))))))))
809 (company-backend (list 'ignore
810 (lambda (command &optional arg)
811 (pcase command
812 (`prefix "foo")
813 (`candidates
814 (should (equal arg "foo"))
815 (cons :async
816 (lambda (cb)
817 (run-with-timer
818 0.01 nil
819 (lambda () (funcall cb '("a" "b")))))))))
820 (lambda (command &optional arg)
821 (pcase command
822 (`prefix "foo")
823 (`candidates '("c" "d" "e"))))
824 immediate)))
825 (should (equal :async (car (company-call-backend-raw 'candidates "foo"))))
826 (should (equal '("a" "b" "c" "d" "e" "f")
827 (company-call-backend 'candidates "foo")))
828 (let ((company-backend (list immediate)))
829 (should (equal '("f") (company-call-backend 'candidates "foo")))))))
830
831 ;;; Transformers
832
833 (ert-deftest company-occurrence-prefer-closest-above ()
834 (with-temp-buffer
835 (save-window-excursion
836 (set-window-buffer nil (current-buffer))
837 (insert "foo0
838 foo1
839 ")
840 (save-excursion
841 (insert "
842 foo3
843 foo2"))
844 (let ((company-backend 'company-dabbrev)
845 (company-occurrence-weight-function
846 'company-occurrence-prefer-closest-above))
847 (should (equal '("foo1" "foo0" "foo3" "foo2" "foo4")
848 (company-sort-by-occurrence
849 '("foo0" "foo1" "foo2" "foo3" "foo4"))))))))
850
851 (ert-deftest company-occurrence-prefer-any-closest ()
852 (with-temp-buffer
853 (save-window-excursion
854 (set-window-buffer nil (current-buffer))
855 (insert "foo0
856 foo1
857 ")
858 (save-excursion
859 (insert "
860 foo3
861 foo2"))
862 (let ((company-backend 'company-dabbrev)
863 (company-occurrence-weight-function
864 'company-occurrence-prefer-any-closest))
865 (should (equal '("foo1" "foo3" "foo0" "foo2" "foo4")
866 (company-sort-by-occurrence
867 '("foo0" "foo1" "foo2" "foo3" "foo4"))))))))
868
869 ;;; Template
870
871 (ert-deftest company-template-removed-after-the-last-jump ()
872 (with-temp-buffer
873 (insert "{ }")
874 (goto-char 2)
875 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
876 (save-excursion
877 (dotimes (i 2)
878 (insert " ")
879 (company-template-add-field tpl (point) "foo")))
880 (company-call 'template-forward-field)
881 (should (= 3 (point)))
882 (company-call 'template-forward-field)
883 (should (= 7 (point)))
884 (company-call 'template-forward-field)
885 (should (= 11 (point)))
886 (should (zerop (length (overlay-get tpl 'company-template-fields))))
887 (should (null (overlay-buffer tpl))))))
888
889 (ert-deftest company-template-removed-after-input-and-jump ()
890 (with-temp-buffer
891 (insert "{ }")
892 (goto-char 2)
893 (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
894 (save-excursion
895 (insert " ")
896 (company-template-add-field tpl (point) "bar"))
897 (company-call 'template-move-to-first tpl)
898 (should (= 3 (point)))
899 (dolist (c (string-to-list "tee"))
900 (let ((last-command-event c))
901 (company-call 'self-insert-command 1)))
902 (should (string= "{ tee }" (buffer-string)))
903 (should (overlay-buffer tpl))
904 (company-call 'template-forward-field)
905 (should (= 7 (point)))
906 (should (null (overlay-buffer tpl))))))
907
908 (defun company-call (name &rest args)
909 (let* ((maybe (intern (format "company-%s" name)))
910 (command (if (fboundp maybe) maybe name)))
911 (let ((this-command command))
912 (run-hooks 'pre-command-hook))
913 (apply command args)
914 (let ((this-command command))
915 (run-hooks 'post-command-hook))))
916
917 (ert-deftest company-template-c-like-templatify ()
918 (with-temp-buffer
919 (let ((text "foo(int a, short b)"))
920 (insert text)
921 (company-template-c-like-templatify text)
922 (should (equal "foo(arg0, arg1)" (buffer-string)))
923 (should (looking-at "arg0"))
924 (should (equal "int a"
925 (overlay-get (company-template-field-at) 'display))))))
926
927 (ert-deftest company-template-c-like-templatify-trims-after-closing-paren ()
928 (with-temp-buffer
929 (let ((text "foo(int a, short b)!@ #1334 a"))
930 (insert text)
931 (company-template-c-like-templatify text)
932 (should (equal "foo(arg0, arg1)" (buffer-string)))
933 (should (looking-at "arg0")))))
934
935 (ert-deftest company-template-c-like-templatify-generics ()
936 (with-temp-buffer
937 (let ((text "foo<TKey, TValue>(int i, Dict<TKey, TValue>, long l)"))
938 (insert text)
939 (company-template-c-like-templatify text)
940 (should (equal "foo<arg0, arg1>(arg2, arg3, arg4)" (buffer-string)))
941 (should (looking-at "arg0"))
942 (should (equal "TKey" (overlay-get (company-template-field-at) 'display)))
943 (search-forward "arg3")
944 (forward-char -1)
945 (should (equal "Dict<TKey, TValue>"
946 (overlay-get (company-template-field-at) 'display))))))
947
948 ;;; Clang
949
950 (ert-deftest company-clang-objc-templatify ()
951 (with-temp-buffer
952 (let ((text "createBookWithTitle:andAuthor:"))
953 (insert text)
954 (company-clang-objc-templatify text)
955 (should (equal "createBookWithTitle:arg0 andAuthor:arg1" (buffer-string)))
956 (should (looking-at "arg0"))
957 (should (null (overlay-get (company-template-field-at) 'display))))))