-
-
Notifications
You must be signed in to change notification settings - Fork 43
/
corfu.el
1420 lines (1287 loc) · 61.3 KB
/
corfu.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; corfu.el --- COmpletion in Region FUnction -*- lexical-binding: t -*-
;; Copyright (C) 2021-2024 Free Software Foundation, Inc.
;; Author: Daniel Mendler <mail@daniel-mendler.de>
;; Maintainer: Daniel Mendler <mail@daniel-mendler.de>
;; Created: 2021
;; Version: 1.5
;; Package-Requires: ((emacs "27.1") (compat "30"))
;; Homepage: https://github.com/minad/corfu
;; Keywords: abbrev, convenience, matching, completion, text
;; This file is part of GNU Emacs.
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Corfu enhances in-buffer completion with a small completion popup.
;; The current candidates are shown in a popup below or above the
;; point. The candidates can be selected by moving up and down.
;; Corfu is the minimalistic in-buffer completion counterpart of the
;; Vertico minibuffer UI.
;;; Code:
(require 'compat)
(eval-when-compile
(require 'cl-lib)
(require 'subr-x))
(defgroup corfu nil
"COmpletion in Region FUnction."
:link '(info-link :tag "Info Manual" "(corfu)")
:link '(url-link :tag "Homepage" "https://github.com/minad/corfu")
:link '(emacs-library-link :tag "Library Source" "corfu.el")
:group 'convenience
:group 'tools
:group 'matching
:prefix "corfu-")
(defcustom corfu-count 10
"Maximal number of candidates to show."
:type 'natnum)
(defcustom corfu-scroll-margin 2
"Number of lines at the top and bottom when scrolling.
The value should lie between 0 and corfu-count/2."
:type 'natnum)
(defcustom corfu-min-width 15
"Popup minimum width in characters."
:type 'natnum)
(defcustom corfu-max-width 100
"Popup maximum width in characters."
:type 'natnum)
(defcustom corfu-cycle nil
"Enable cycling for `corfu-next' and `corfu-previous'."
:type 'boolean)
(defcustom corfu-on-exact-match 'insert
"Configure how a single exact match should be handled.
- nil: No special handling, continue completion.
- insert: Insert candidate, quit and call the `:exit-function'.
- quit: Quit completion without further action.
- show: Initiate completion even for a single match only."
:type '(choice (const insert) (const show) (const quit) (const nil)))
(defcustom corfu-continue-commands
;; nil is undefined command
'(nil ignore universal-argument universal-argument-more digit-argument
"\\`corfu-" "\\`scroll-other-window")
"Continue Corfu completion after executing these commands.
The list can container either command symbols or regular expressions."
:type '(repeat (choice regexp symbol)))
(defcustom corfu-preview-current 'insert
"Preview currently selected candidate.
If the variable has the value `insert', the candidate is automatically
inserted on further input."
:type '(choice boolean (const insert)))
(defcustom corfu-preselect 'valid
"Configure if the prompt or first candidate is preselected.
- prompt: Always select the prompt.
- first: Always select the first candidate.
- valid: Only select the prompt if valid and not equal to the first candidate.
- directory: Like first, but select the prompt if it is a directory."
:type '(choice (const prompt) (const valid) (const first) (const directory)))
(defcustom corfu-separator ?\s
"Component separator character.
The character used for separating components in the input. The presence
of this separator character will inhibit quitting at completion
boundaries, so that any further characters can be entered. To enter the
first separator character, call `corfu-insert-separator' (bound to M-SPC
by default). Useful for multi-component completion styles such as
Orderless."
:type 'character)
(defcustom corfu-quit-at-boundary 'separator
"Automatically quit at completion boundary.
nil: Never quit at completion boundary.
t: Always quit at completion boundary.
separator: Quit at boundary if no `corfu-separator' has been inserted."
:type '(choice boolean (const separator)))
(defcustom corfu-quit-no-match 'separator
"Automatically quit if no matching candidate is found.
When staying alive even if there is no match a warning message is
shown in the popup.
nil: Stay alive even if there is no match.
t: Quit if there is no match.
separator: Only stay alive if there is no match and
`corfu-separator' has been inserted."
:type '(choice boolean (const separator)))
(defcustom corfu-left-margin-width 0.5
"Width of the left margin in units of the character width."
:type 'float)
(defcustom corfu-right-margin-width 0.5
"Width of the right margin in units of the character width."
:type 'float)
(defcustom corfu-bar-width 0.2
"Width of the bar in units of the character width."
:type 'float)
(defcustom corfu-margin-formatters nil
"Registry for margin formatter functions.
Each function of the list is called with the completion metadata as
argument until an appropriate formatter is found. The function should
return a formatter function, which takes the candidate string and must
return a string, possibly an icon."
:type 'hook)
(defcustom corfu-sort-function #'corfu-sort-length-alpha
"Default sorting function.
This function is used if the completion table does not specify a
`display-sort-function'."
:type `(choice
(const :tag "No sorting" nil)
(const :tag "By length and alpha" ,#'corfu-sort-length-alpha)
(function :tag "Custom function")))
(defcustom corfu-sort-override-function nil
"Override sort function which overrides the `display-sort-function'.
This function is used even if a completion table specifies its
own sort function."
:type '(choice (const nil) function))
(defcustom corfu-auto-prefix 3
"Minimum length of prefix for auto completion.
The completion backend can override this with
:company-prefix-length. It is *not recommended* to use a small
prefix length (below 2), since this will create high load for
Emacs. See also `corfu-auto-delay'."
:type 'natnum)
(defcustom corfu-auto-delay 0.2
"Delay for auto completion.
It is *not recommended* to use a short delay or even 0, since
this will create high load for Emacs, in particular if executing
the completion backend is costly."
:type 'float)
(defcustom corfu-auto-commands
'("self-insert-command\\'" "delete-backward-char\\'" "\\`backward-delete-char"
c-electric-colon c-electric-lt-gt c-electric-slash c-scope-operator)
"Commands which initiate auto completion.
The list can container either command symbols or regular expressions."
:type '(repeat (choice regexp symbol)))
(defcustom corfu-auto nil
"Enable auto completion.
See also the settings `corfu-auto-delay', `corfu-auto-prefix' and
`corfu-auto-commands'."
:type 'boolean)
(defgroup corfu-faces nil
"Faces used by Corfu."
:group 'corfu
:group 'faces)
(defface corfu-default
'((((class color) (min-colors 88) (background dark)) :background "#191a1b")
(((class color) (min-colors 88) (background light)) :background "#f0f0f0")
(t :background "gray"))
"Default face, foreground and background colors used for the popup.")
(defface corfu-current
'((((class color) (min-colors 88) (background dark))
:background "#00415e" :foreground "white")
(((class color) (min-colors 88) (background light))
:background "#c0efff" :foreground "black")
(t :background "blue" :foreground "white"))
"Face used to highlight the currently selected candidate.")
(defface corfu-bar
'((((class color) (min-colors 88) (background dark)) :background "#a8a8a8")
(((class color) (min-colors 88) (background light)) :background "#505050")
(t :background "gray"))
"The background color is used for the scrollbar indicator.")
(defface corfu-border
'((((class color) (min-colors 88) (background dark)) :background "#323232")
(((class color) (min-colors 88) (background light)) :background "#d7d7d7")
(t :background "gray"))
"The background color used for the thin border.")
(defface corfu-annotations
'((t :inherit completions-annotations))
"Face used for annotations.")
(defface corfu-deprecated
'((t :inherit shadow :strike-through t))
"Face used for deprecated candidates.")
(defvar-keymap corfu-mode-map
:doc "Keymap used when `corfu-mode' is active.")
(defvar-keymap corfu-map
:doc "Keymap used when popup is shown."
"<remap> <move-beginning-of-line>" #'corfu-prompt-beginning
"<remap> <move-end-of-line>" #'corfu-prompt-end
"<remap> <beginning-of-buffer>" #'corfu-first
"<remap> <end-of-buffer>" #'corfu-last
"<remap> <scroll-down-command>" #'corfu-scroll-down
"<remap> <scroll-up-command>" #'corfu-scroll-up
"<remap> <next-line>" #'corfu-next
"<remap> <previous-line>" #'corfu-previous
"<remap> <completion-at-point>" #'corfu-complete
"<remap> <keyboard-escape-quit>" #'corfu-reset
"<down>" #'corfu-next
"<up>" #'corfu-previous
"M-n" #'corfu-next
"M-p" #'corfu-previous
"C-g" #'corfu-quit
"RET" #'corfu-insert
"TAB" #'corfu-complete
"M-TAB" #'corfu-expand
"M-g" 'corfu-info-location
"M-h" 'corfu-info-documentation
"M-SPC" #'corfu-insert-separator)
(defvar corfu--auto-timer (timer-create)
"Auto completion timer.")
(defvar corfu--candidates nil
"List of candidates.")
(defvar corfu--metadata nil
"Completion metadata.")
(defvar corfu--base ""
"Base string, which is concatenated with the candidate.")
(defvar corfu--total 0
"Length of the candidate list `corfu--candidates'.")
(defvar corfu--hilit #'identity
"Lazy candidate highlighting function.")
(defvar corfu--index -1
"Index of current candidate or negative for prompt selection.")
(defvar corfu--preselect -1
"Index of preselected candidate, negative for prompt selection.")
(defvar corfu--scroll 0
"Scroll position.")
(defvar corfu--input nil
"Cons of last prompt contents and point.")
(defvar corfu--preview-ov nil
"Current candidate overlay.")
(defvar corfu--change-group nil
"Undo change group.")
(defvar corfu--frame nil
"Popup frame.")
(defconst corfu--initial-state
(mapcar
(lambda (k) (cons k (symbol-value k)))
'(corfu--base
corfu--candidates
corfu--hilit
corfu--index
corfu--preselect
corfu--scroll
corfu--input
corfu--total
corfu--preview-ov
corfu--change-group
corfu--metadata))
"Initial Corfu state.")
(defvar corfu--frame-parameters
'((no-accept-focus . t)
(no-focus-on-map . t)
(min-width . t)
(min-height . t)
(border-width . 0)
(outer-border-width . 0)
(internal-border-width . 1)
(child-frame-border-width . 1)
(left-fringe . 0)
(right-fringe . 0)
(vertical-scroll-bars . nil)
(horizontal-scroll-bars . nil)
(menu-bar-lines . 0)
(tool-bar-lines . 0)
(tab-bar-lines . 0)
(no-other-frame . t)
(unsplittable . t)
(undecorated . t)
(cursor-type . nil)
(no-special-glyphs . t)
(desktop-dont-save . t))
"Default child frame parameters.")
(defvar corfu--buffer-parameters
'((mode-line-format . nil)
(header-line-format . nil)
(tab-line-format . nil)
(tab-bar-format . nil) ;; Emacs 28 tab-bar-format
(frame-title-format . "")
(truncate-lines . t)
(cursor-in-non-selected-windows . nil)
(cursor-type . nil)
(show-trailing-whitespace . nil)
(display-line-numbers . nil)
(left-fringe-width . nil)
(right-fringe-width . nil)
(left-margin-width . 0)
(right-margin-width . 0)
(fringes-outside-margins . 0)
(fringe-indicator-alist . nil)
(indicate-empty-lines . nil)
(indicate-buffer-boundaries . nil)
(buffer-read-only . t))
"Default child frame buffer parameters.")
(defvar corfu--mouse-ignore-map
(let ((map (make-sparse-keymap)))
(dotimes (i 7)
(dolist (k '(mouse down-mouse drag-mouse double-mouse triple-mouse))
(keymap-set map (format "<%s-%s>" k (1+ i)) #'ignore)))
map)
"Ignore all mouse clicks.")
(defun corfu--replace (beg end str)
"Replace range between BEG and END with STR."
(unless (equal str (buffer-substring-no-properties beg end))
;; bug#55205: completion--replace removed properties as an unwanted
;; side-effect. We also don't want to leave text properties.
(completion--replace beg end (substring-no-properties str))))
(defun corfu--capf-wrapper (fun &optional prefix)
"Wrapper for `completion-at-point' FUN.
The wrapper determines if the Capf is applicable at the current
position and performs sanity checking on the returned result.
For non-exclusive Capfs wrapper additionally checks if the
current input can be completed successfully. PREFIX is a prefix
length override, set to t for manual completion."
(pcase (funcall fun)
((and res `(,beg ,end ,table . ,plist))
(and (integer-or-marker-p beg) ;; Valid Capf result
(<= beg (point) end) ;; Sanity checking
;; When auto completing, check the prefix length!
(let ((len (or prefix
(plist-get plist :company-prefix-length)
(- (point) beg))))
(or (eq len t) (>= len corfu-auto-prefix)))
;; For non-exclusive Capfs, check for valid completion.
(or (not (eq 'no (plist-get plist :exclusive)))
(let* ((str (buffer-substring-no-properties beg end))
(pt (- (point) beg))
(pred (plist-get plist :predicate))
(md (completion-metadata (substring str 0 pt) table pred)))
;; We use `completion-try-completion' to check if there are
;; completions. The upstream `completion--capf-wrapper' uses
;; `try-completion' which is incorrect since it only checks for
;; prefix completions.
(completion-try-completion str table pred pt md)))
(cons fun res)))))
(defun corfu--make-buffer (name)
"Create buffer with NAME."
(let ((fr face-remapping-alist)
(ls line-spacing)
(buffer (get-buffer-create name)))
(with-current-buffer buffer
;;; XXX HACK install mouse ignore map
(use-local-map corfu--mouse-ignore-map)
(dolist (var corfu--buffer-parameters)
(set (make-local-variable (car var)) (cdr var)))
(setq-local face-remapping-alist (copy-tree fr)
line-spacing ls)
(cl-pushnew 'corfu-default (alist-get 'default face-remapping-alist))
buffer)))
(defvar x-gtk-resize-child-frames) ;; Not present on non-gtk builds
(defvar corfu--gtk-resize-child-frames
(let ((case-fold-search t))
;; XXX HACK to fix resizing on gtk3/gnome taken from posframe.el
;; More information:
;; * https://github.com/minad/corfu/issues/17
;; * https://gitlab.gnome.org/GNOME/mutter/-/issues/840
;; * https://lists.gnu.org/archive/html/emacs-devel/2020-02/msg00001.html
(and (string-match-p "gtk3" system-configuration-features)
(string-match-p "gnome\\|cinnamon"
(or (getenv "XDG_CURRENT_DESKTOP")
(getenv "DESKTOP_SESSION") ""))
'resize-mode)))
;; Function adapted from posframe.el by tumashu
(defun corfu--make-frame (frame x y width height buffer)
"Show BUFFER in child frame at X/Y with WIDTH/HEIGHT.
FRAME is the existing frame."
(when-let (((frame-live-p frame))
(timer (frame-parameter frame 'corfu--hide-timer)))
(cancel-timer timer)
(set-frame-parameter frame 'corfu--hide-timer nil))
(let* ((window-min-height 1)
(window-min-width 1)
(inhibit-redisplay t)
(x-gtk-resize-child-frames corfu--gtk-resize-child-frames)
(before-make-frame-hook)
(after-make-frame-functions)
(parent (window-frame)))
(unless (and (frame-live-p frame)
(eq (frame-parent frame)
(and (not (bound-and-true-p exwm--connection)) parent))
;; If there is more than one window, `frame-root-window' may
;; return nil. Recreate the frame in this case.
(window-live-p (frame-root-window frame)))
(when frame (delete-frame frame))
(setq frame (make-frame
`((parent-frame . ,parent)
(minibuffer . ,(minibuffer-window parent))
(width . 0) (height . 0) (visibility . nil)
,@corfu--frame-parameters))))
;; XXX HACK Setting the same frame-parameter/face-background is not a nop.
;; Check before applying the setting. Without the check, the frame flickers
;; on Mac. We have to apply the face background before adjusting the frame
;; parameter, otherwise the border is not updated.
(let ((new (face-attribute 'corfu-border :background nil 'default)))
(unless (equal (face-attribute 'internal-border :background frame 'default) new)
(set-face-background 'internal-border new frame))
;; XXX The Emacs Mac Port does not support `internal-border', we also have
;; to set `child-frame-border'.
(unless (or (not (facep 'child-frame-border))
(equal (face-attribute 'child-frame-border :background frame 'default) new))
(set-face-background 'child-frame-border new frame)))
;; Reset frame parameters if they changed. For example `tool-bar-mode'
;; overrides the parameter `tool-bar-lines' for every frame, including child
;; frames. The child frame API is a pleasure to work with. It is full of
;; lovely surprises.
(let* ((is (frame-parameters frame))
(should `((background-color
. ,(face-attribute 'corfu-default :background nil 'default))
(font . ,(frame-parameter parent 'font))
,@corfu--frame-parameters))
(diff (cl-loop for p in should for (k . v) = p
unless (equal (alist-get k is) v) collect p)))
(when diff (modify-frame-parameters frame diff)))
(let ((win (frame-root-window frame)))
(unless (eq (window-buffer win) buffer)
(set-window-buffer win buffer))
;; Disallow selection of root window (gh:minad/corfu#63)
(set-window-parameter win 'no-delete-other-windows t)
(set-window-parameter win 'no-other-window t)
;; Mark window as dedicated to prevent frame reuse (gh:minad/corfu#60)
(set-window-dedicated-p win t))
(redirect-frame-focus frame parent)
(set-frame-size frame width height t)
(pcase-let ((`(,px . ,py) (frame-position frame)))
(unless (and (= x px) (= y py))
(set-frame-position frame x y))))
(make-frame-visible frame)
;; Unparent child frame if EXWM is used, otherwise EXWM buffers are drawn on
;; top of the Corfu child frame.
(when (and (bound-and-true-p exwm--connection) (frame-parent frame))
(set-frame-parameter frame 'parent-frame nil))
frame)
(defun corfu--hide-frame-deferred (frame)
"Deferred hiding of child FRAME."
(when (and (frame-live-p frame) (frame-visible-p frame))
(set-frame-parameter frame 'corfu--hide-timer nil)
(make-frame-invisible frame)
(with-current-buffer (window-buffer (frame-root-window frame))
(with-silent-modifications
(erase-buffer)))))
(defun corfu--hide-frame (frame)
"Hide child FRAME."
(when (and (frame-live-p frame) (frame-visible-p frame)
(not (frame-parameter frame 'corfu--hide-timer)))
(set-frame-parameter frame 'corfu--hide-timer
(run-at-time 0 nil #'corfu--hide-frame-deferred frame))))
(defun corfu--move-to-front (elem list)
"Move ELEM to front of LIST."
;; In contrast to Vertico, this function handles duplicates. See also the
;; special deduplication function `corfu--delete-dups' based on
;; `equal-including-properties'
(nconc (cl-loop for x in list if (equal x elem) collect x)
(delete elem list)))
(defun corfu--filter-completions (&rest args)
"Compute all completions for ARGS with lazy highlighting."
(dlet ((completion-lazy-hilit t) (completion-lazy-hilit-fn nil))
(static-if (>= emacs-major-version 30)
(cons (apply #'completion-all-completions args) completion-lazy-hilit-fn)
(cl-letf* ((orig-pcm (symbol-function #'completion-pcm--hilit-commonality))
(orig-flex (symbol-function #'completion-flex-all-completions))
((symbol-function #'completion-flex-all-completions)
(lambda (&rest args)
;; Unfortunately for flex we have to undo the lazy highlighting, since flex uses
;; the completion-score for sorting, which is applied during highlighting.
(cl-letf (((symbol-function #'completion-pcm--hilit-commonality) orig-pcm))
(apply orig-flex args))))
((symbol-function #'completion-pcm--hilit-commonality)
(lambda (pattern cands)
(setq completion-lazy-hilit-fn
(lambda (x)
;; `completion-pcm--hilit-commonality' sometimes throws an internal error
;; for example when entering "/sudo:://u".
(condition-case nil
(car (completion-pcm--hilit-commonality pattern (list x)))
(t x))))
cands))
((symbol-function #'completion-hilit-commonality)
(lambda (cands prefix &optional base)
(setq completion-lazy-hilit-fn
(lambda (x) (car (completion-hilit-commonality (list x) prefix base))))
(and cands (nconc cands base)))))
(cons (apply #'completion-all-completions args) completion-lazy-hilit-fn)))))
(defsubst corfu--length-string< (x y)
"Sorting predicate which compares X and Y first by length then by `string<'."
(or (< (length x) (length y)) (and (= (length x) (length y)) (string< x y))))
(defmacro corfu--partition! (list form)
"Evaluate FORM for every element and partition LIST."
(cl-with-gensyms (head1 head2 tail1 tail2)
`(let* ((,head1 (cons nil nil))
(,head2 (cons nil nil))
(,tail1 ,head1)
(,tail2 ,head2))
(while ,list
(if (let ((it (car ,list))) ,form)
(progn
(setcdr ,tail1 ,list)
(pop ,tail1))
(setcdr ,tail2 ,list)
(pop ,tail2))
(pop ,list))
(setcdr ,tail1 (cdr ,head2))
(setcdr ,tail2 nil)
(setq ,list (cdr ,head1)))))
(defun corfu--move-prefix-candidates-to-front (field cands)
"Move CANDS which match prefix of FIELD to the beginning."
(let* ((word (substring field 0
(seq-position field corfu-separator)))
(len (length word)))
(corfu--partition!
cands
(and (>= (length it) len)
(eq t (compare-strings word 0 len it 0 len
completion-ignore-case))))))
;; bug#6581: `equal-including-properties' uses `eq' for properties until 29.1.
;; Approximate by comparing `text-properties-at' position 0.
(defalias 'corfu--equal-including-properties
(static-if (< emacs-major-version 29)
(lambda (x y)
(and (equal x y)
(equal (text-properties-at 0 x) (text-properties-at 0 y))))
#'equal-including-properties))
(defun corfu--delete-dups (list)
"Delete `equal-including-properties' consecutive duplicates from LIST."
(let ((beg list))
(while (cdr beg)
(let ((end (cdr beg)))
(while (equal (car beg) (car end)) (pop end))
;; The deduplication is quadratic in the number of duplicates. We can
;; avoid the quadratic complexity with a hash table which takes
;; properties into account (available since Emacs 28).
(while (not (eq beg end))
(let ((dup beg))
(while (not (eq (cdr dup) end))
(if (corfu--equal-including-properties (car beg) (cadr dup))
(setcdr dup (cddr dup))
(pop dup))))
(pop beg)))))
list)
(defun corfu--sort-function ()
"Return the sorting function."
(or corfu-sort-override-function
(corfu--metadata-get 'display-sort-function)
corfu-sort-function))
(defun corfu--recompute (str pt table pred)
"Recompute state from STR, PT, TABLE and PRED."
(pcase-let* ((before (substring str 0 pt))
(after (substring str pt))
(corfu--metadata (completion-metadata before table pred))
;; bug#47678: `completion-boundaries' fails for `partial-completion'
;; if the cursor is moved between the slashes of "~//".
;; See also vertico.el which has the same issue.
(bounds (condition-case nil
(completion-boundaries before table pred after)
(t (cons 0 (length after)))))
(field (substring str (car bounds) (+ pt (cdr bounds))))
(completing-file (eq (corfu--metadata-get 'category) 'file))
(`(,all . ,hl) (corfu--filter-completions str table pred pt corfu--metadata))
(base (or (when-let ((z (last all))) (prog1 (cdr z) (setcdr z nil))) 0))
(corfu--base (substring str 0 base))
(pre nil))
;; Filter the ignored file extensions. We cannot use modified predicate for
;; this filtering, since this breaks the special casing in the
;; `completion-file-name-table' for `file-exists-p' and `file-directory-p'.
(when completing-file (setq all (completion-pcm--filename-try-filter all)))
;; Sort using the `display-sort-function' or the Corfu sort functions, and
;; delete duplicates with respect to `equal-including-properties'. This is
;; a deviation from the Vertico completion UI with more aggressive
;; deduplication, where candidates are compared with `equal'. Corfu
;; preserves candidates which differ in their text properties. Corfu tries
;; to preserve text properties as much as possible, when calling the
;; `:exit-function' to help Capfs with candidate disambiguation. This
;; matters in particular for Lsp backends, which produce duplicates for
;; overloaded methods.
(setq all (corfu--delete-dups (funcall (or (corfu--sort-function) #'identity) all))
all (corfu--move-prefix-candidates-to-front field all))
(when (and completing-file (not (string-suffix-p "/" field)))
(setq all (corfu--move-to-front (concat field "/") all)))
(setq all (corfu--move-to-front field all)
pre (if (or (eq corfu-preselect 'prompt) (not all)
(and completing-file (eq corfu-preselect 'directory)
(= (length corfu--base) (length str))
(test-completion str table pred))
(and (eq corfu-preselect 'valid)
(not (equal field (car all)))
(not (and completing-file (equal (concat field "/") (car all))))
(test-completion str table pred)))
-1 0))
`((corfu--base . ,corfu--base)
(corfu--metadata . ,corfu--metadata)
(corfu--candidates . ,all)
(corfu--total . ,(length all))
(corfu--hilit . ,(or hl #'identity))
(corfu--preselect . ,pre)
(corfu--index . ,(or (and (>= corfu--index 0) (/= corfu--index corfu--preselect)
(seq-position all (nth corfu--index corfu--candidates)))
pre)))))
(defun corfu--update (&optional interruptible)
"Update state, optionally INTERRUPTIBLE."
(pcase-let* ((`(,beg ,end ,table ,pred . ,_) completion-in-region--data)
(pt (- (point) beg))
(str (buffer-substring-no-properties beg end))
(input (cons str pt)))
(unless (equal corfu--input input)
;; Redisplay such that the input is immediately shown before the expensive
;; candidate recomputation (gh:minad/corfu#48). See also corresponding
;; issue gh:minad/vertico#89.
(when interruptible (redisplay))
;; Bind non-essential=t to prevent Tramp from opening new connections,
;; without the user explicitly requesting it via M-TAB.
(pcase (let ((non-essential t))
;; XXX Guard against errors during candidate generation.
;; bug#61274: `dabbrev-capf' signals errors.
(condition-case err
(if interruptible
(while-no-input (corfu--recompute str pt table pred))
(corfu--recompute str pt table pred))
(error
(message "Corfu completion error: %s" (error-message-string err))
t)))
('nil (keyboard-quit))
((and state (pred consp))
(setq corfu--input input)
(dolist (s state) (set (car s) (cdr s))))))
input))
(defun corfu--match-symbol-p (pattern sym)
"Return non-nil if SYM is matching an element of the PATTERN list."
(cl-loop with case-fold-search = nil
for x in (and (symbolp sym) pattern)
thereis (if (symbolp x)
(eq sym x)
(string-match-p x (symbol-name sym)))))
(defun corfu--metadata-get (prop)
"Return PROP from completion metadata."
;; Marginalia and various icon packages advise `completion-metadata-get' to
;; inject their annotations, but are meant only for minibuffer completion.
;; Therefore call `completion-metadata-get' without advices here.
(let ((completion-extra-properties (nth 4 completion-in-region--data)))
(funcall (advice--cd*r (symbol-function (compat-function completion-metadata-get)))
corfu--metadata prop)))
(defun corfu--format-candidates (cands)
"Format annotated CANDS."
(cl-loop for c in cands do
(cl-loop for s in-ref c do
(setf s (replace-regexp-in-string "[ \t]*\n[ \t]*" " " s))))
(let* ((cw (cl-loop for x in cands maximize (string-width (car x))))
(pw (cl-loop for x in cands maximize (string-width (cadr x))))
(sw (cl-loop for x in cands maximize (string-width (caddr x))))
(width (+ pw cw sw))
;; -4 because of margins and some additional safety
(max-width (min corfu-max-width (- (frame-width) 4))))
(when (> width max-width)
(setq sw (max 0 (- max-width pw cw))
width (+ pw cw sw)))
(when (< width corfu-min-width)
(setq cw (+ cw (- corfu-min-width width))
width corfu-min-width))
(setq width (min width max-width))
(list pw width
(cl-loop for (cand prefix suffix) in cands collect
(truncate-string-to-width
(concat
prefix (make-string (max 0 (- pw (string-width prefix))) ?\s)
cand
(when (/= sw 0)
(make-string (+ (max 0 (- cw (string-width cand)))
(max 0 (- sw (string-width suffix))))
?\s))
suffix)
width)))))
(defun corfu--compute-scroll ()
"Compute new scroll position."
(let ((off (max (min corfu-scroll-margin (/ corfu-count 2)) 0))
(corr (if (= corfu-scroll-margin (/ corfu-count 2)) (1- (mod corfu-count 2)) 0)))
(setq corfu--scroll (min (max 0 (- corfu--total corfu-count))
(max 0 (+ corfu--index off 1 (- corfu-count))
(min (- corfu--index off corr) corfu--scroll))))))
(defun corfu--candidates-popup (pos)
"Show candidates popup at POS."
(corfu--compute-scroll)
(pcase-let* ((last (min (+ corfu--scroll corfu-count) corfu--total))
(bar (ceiling (* corfu-count corfu-count) corfu--total))
(lo (min (- corfu-count bar 1) (floor (* corfu-count corfu--scroll) corfu--total)))
(`(,mf . ,acands) (corfu--affixate
(cl-loop repeat corfu-count
for c in (nthcdr corfu--scroll corfu--candidates)
collect (funcall corfu--hilit (substring c)))))
(`(,pw ,width ,fcands) (corfu--format-candidates acands))
;; Disable the left margin if a margin formatter is active.
(corfu-left-margin-width (if mf 0 corfu-left-margin-width)))
;; Nonlinearity at the end and the beginning
(when (/= corfu--scroll 0)
(setq lo (max 1 lo)))
(when (/= last corfu--total)
(setq lo (min (- corfu-count bar 2) lo)))
(corfu--popup-show pos pw width fcands (- corfu--index corfu--scroll)
(and (> corfu--total corfu-count) lo) bar)))
(defun corfu--range-valid-p ()
"Check the completion range, return non-nil if valid."
(pcase-let ((buf (current-buffer))
(pt (point))
(`(,beg ,end . ,_) completion-in-region--data))
(and beg end
(eq buf (marker-buffer beg)) (eq buf (window-buffer))
(<= beg pt end)
(save-excursion (goto-char beg) (<= (pos-bol) pt (pos-eol))))))
(defun corfu--continue-p ()
"Check if completion should continue after a command.
Corfu bails out if the current buffer changed unexpectedly or if
point moved out of range, see `corfu--range-valid-p'. Also the
input must satisfy the `completion-in-region-mode--predicate' and
the last command must be listed in `corfu-continue-commands'."
(and (corfu--range-valid-p)
;; We keep Corfu alive if a `overriding-terminal-local-map' is
;; installed, e.g., the `universal-argument-map'. It would be good to
;; think about a better criterion instead. Unfortunately relying on
;; `this-command' alone is insufficient, since the value of
;; `this-command' gets clobbered in the case of transient keymaps.
(or overriding-terminal-local-map
;; Check if it is an explicitly listed continue command
(corfu--match-symbol-p corfu-continue-commands this-command)
(pcase-let ((`(,beg ,end . ,_) completion-in-region--data))
(and (or (not corfu--input) (< beg end)) ;; Check for empty input
(or (not corfu-quit-at-boundary) ;; Check separator or predicate
(and (eq corfu-quit-at-boundary 'separator)
(or (eq this-command #'corfu-insert-separator)
;; with separator, any further chars allowed
(seq-contains-p (car corfu--input) corfu-separator)))
(funcall completion-in-region-mode--predicate)))))))
(defun corfu--preview-current-p ()
"Return t if the selected candidate is previewed."
(and corfu-preview-current (>= corfu--index 0) (/= corfu--index corfu--preselect)))
(defun corfu--preview-current (beg end)
"Show current candidate as overlay given BEG and END."
(when (corfu--preview-current-p)
(setq beg (+ beg (length corfu--base))
corfu--preview-ov (make-overlay beg end nil))
(overlay-put corfu--preview-ov 'priority 1000)
(overlay-put corfu--preview-ov 'window (selected-window))
(overlay-put corfu--preview-ov (if (= beg end) 'after-string 'display)
(nth corfu--index corfu--candidates))))
(defun corfu--window-change (_)
"Window and buffer change hook which quits Corfu."
(unless (corfu--range-valid-p)
(corfu-quit)))
(defun corfu--post-command ()
"Refresh Corfu after last command."
(if (corfu--continue-p)
(corfu--exhibit)
(corfu-quit))
(when corfu-auto
(corfu--auto-post-command)))
(defun corfu--goto (index)
"Go to candidate with INDEX."
(setq corfu--index (max corfu--preselect (min index (1- corfu--total)))))
(defun corfu--exit-function (str status cands)
"Call the `:exit-function' with STR and STATUS.
Lookup STR in CANDS to restore text properties."
(when-let ((exit (plist-get completion-extra-properties :exit-function)))
(funcall exit (or (car (member str cands)) str) status)))
(defun corfu--done (str status cands)
"Exit completion and call the exit function with STR and STATUS.
Lookup STR in CANDS to restore text properties."
(let ((completion-extra-properties (nth 4 completion-in-region--data)))
;; For successful completions, amalgamate undo operations,
;; such that completion can be undone in a single step.
(undo-amalgamate-change-group corfu--change-group)
(corfu-quit)
(corfu--exit-function str status cands)))
(defun corfu--setup (beg end table pred)
"Setup Corfu completion state.
See `completion-in-region' for the arguments BEG, END, TABLE, PRED."
(setq beg (if (markerp beg) beg (copy-marker beg))
end (if (and (markerp end) (marker-insertion-type end)) end (copy-marker end t))
completion-in-region--data (list beg end table pred completion-extra-properties))
(completion-in-region-mode 1)
(activate-change-group (setq corfu--change-group (prepare-change-group)))
(setcdr (assq #'completion-in-region-mode minor-mode-overriding-map-alist) corfu-map)
(add-hook 'pre-command-hook #'corfu--prepare nil 'local)
(add-hook 'window-selection-change-functions #'corfu--window-change nil 'local)
(add-hook 'window-buffer-change-functions #'corfu--window-change nil 'local)
(add-hook 'post-command-hook #'corfu--post-command)
;; Disable default post-command handling, since we have our own
;; checks in `corfu--post-command'.
(remove-hook 'post-command-hook #'completion-in-region--postch)
(let ((sym (make-symbol "corfu--teardown"))
(buf (current-buffer)))
(fset sym (lambda ()
;; Ensure that the tear-down runs in the correct buffer, if still alive.
(unless completion-in-region-mode
(remove-hook 'completion-in-region-mode-hook sym)
(corfu--teardown buf))))
(add-hook 'completion-in-region-mode-hook sym)))
(defun corfu--in-region (&rest args)
"Corfu completion in region function called with ARGS."
;; XXX We can get an endless loop when `completion-in-region-function' is set
;; globally to `corfu--in-region'. This should never happen.
(apply (if (corfu--popup-support-p) #'corfu--in-region-1
(default-value 'completion-in-region-function))
args))
(defun corfu--in-region-1 (beg end table &optional pred)
"Complete in region, see `completion-in-region' for BEG, END, TABLE, PRED."
(barf-if-buffer-read-only)
;; Restart the completion. This can happen for example if C-M-/
;; (`dabbrev-completion') is pressed while the Corfu popup is already open.
(when completion-in-region-mode (corfu-quit))
(let* ((pt (max 0 (- (point) beg)))
(str (buffer-substring-no-properties beg end))
(metadata (completion-metadata (substring str 0 pt) table pred))
(threshold (completion--cycle-threshold metadata))
(completion-in-region-mode-predicate
(or completion-in-region-mode-predicate #'always)))
(pcase (completion-try-completion str table pred pt metadata)
('nil (corfu--message "No match") nil)
('t (goto-char end)
(corfu--message "Sole match")
(if (eq corfu-on-exact-match 'show)
(corfu--setup beg end table pred)
(corfu--exit-function
str 'finished
(alist-get 'corfu--candidates (corfu--recompute str pt table pred))))
t)
(`(,newstr . ,newpt)
(setq beg (if (markerp beg) beg (copy-marker beg))
end (copy-marker end t))
(corfu--replace beg end newstr)
(goto-char (+ beg newpt))
(let* ((state (corfu--recompute newstr newpt table pred))
(base (alist-get 'corfu--base state))
(total (alist-get 'corfu--total state))
(candidates (alist-get 'corfu--candidates state)))
(if (= total 1)
;; If completion is finished and cannot be further completed, and
;; the value of `corfu-on-exact-match' is not 'show, return
;; 'finished. Otherwise setup the Corfu popup.
(if (or (eq corfu-on-exact-match 'show)
(consp (completion-try-completion
newstr table pred newpt
(completion-metadata newstr table pred))))
(corfu--setup beg end table pred)
(corfu--exit-function newstr 'finished candidates))
(if (or (= total 0) (not threshold)
(and (not (eq threshold t)) (< threshold total)))
(corfu--setup beg end table pred)
(corfu--cycle-candidates total candidates (+ (length base) beg) end)
;; Do not show Corfu when "trivially" cycling, i.e.,
;; when the completion is finished after the candidate.
(unless (equal (completion-boundaries (car candidates) table pred "")
'(0 . 0))
(corfu--setup beg end table pred)))))
t))))
(defun corfu--message (&rest msg)
"Show completion MSG."
(let (message-log-max) (apply #'message msg)))
(defun corfu--cycle-candidates (total cands beg end)
"Cycle between TOTAL number of CANDS.
See `completion-in-region' for the arguments BEG, END, TABLE, PRED."
(let* ((idx 0)
(map (make-sparse-keymap))
(replace (lambda ()
(interactive)
(corfu--replace beg end (nth idx cands))
(corfu--message "Cycling %d/%d..." (1+ idx) total)
(setq idx (mod (1+ idx) total))
(set-transient-map map))))
(define-key map [remap completion-at-point] replace)
(define-key map [remap corfu-complete] replace)
(define-key map (vector last-command-event) replace)
(funcall replace)))
(defun corfu--auto-complete-deferred (&optional tick)
"Initiate auto completion if TICK did not change."
(when (and (not completion-in-region-mode)
(or (not tick) (equal tick (corfu--auto-tick))))
(pcase (while-no-input ;; Interruptible Capf query
(run-hook-wrapped 'completion-at-point-functions #'corfu--capf-wrapper))
(`(,fun ,beg ,end ,table . ,plist)
(let ((completion-in-region-mode-predicate
(lambda ()
(when-let ((newbeg (car-safe (funcall fun))))
(= newbeg beg))))
(completion-extra-properties plist))
(corfu--setup beg end table (plist-get plist :predicate))
(corfu--exhibit 'auto))))))
(defun corfu--auto-post-command ()
"Post command hook which initiates auto completion."
(cancel-timer corfu--auto-timer)
(if (and (not completion-in-region-mode)
(not defining-kbd-macro)
(not buffer-read-only)
(corfu--match-symbol-p corfu-auto-commands this-command)
(corfu--popup-support-p))
(if (<= corfu-auto-delay 0)
(corfu--auto-complete-deferred)
;; Do not use `timer-set-idle-time' since this leads to
;; unpredictable pauses, in particular with `flyspell-mode'.
(timer-set-time corfu--auto-timer
(timer-relative-time nil corfu-auto-delay))