forked from jojojames/fussy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfussy.el
1237 lines (1043 loc) · 46.4 KB
/
fussy.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
;;; fussy.el --- Fuzzy completion style using `flx' -*- lexical-binding: t; -*-
;; Copyright 2022 James Nguyen
;; Author: James Nguyen <james@jojojames.com>
;; Version: 1.0
;; Package-Requires: ((emacs "27.2") (flx "0.5"))
;; Keywords: matching
;; Homepage: https://github.com/jojojames/fussy
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This is a fuzzy Emacs completion style similar to the built-in
;; `flex' style, but using `flx' for scoring. It also supports various other
;; fuzzy scoring systems in place of `flx'.
;; This package is intended to be used with packages that leverage
;; `completion-styles', e.g. `completing-read' and
;; `completion-at-point-functions'.
;; It is usable with `icomplete' (as well as `fido-mode'), `selectrum',
;; `vertico', `corfu', `helm' and `company-mode''s `company-capf'.
;; It is not currently usable with `ido' which doesn't support
;; `completion-styles' and has its own sorting and filtering system. In
;; addition to those packages, other `company-mode' backends will not hook into
;; this package. `ivy' support can be somewhat baked in following
;; https://github.com/jojojames/fussy#ivy-integration but the
;; performance gains may not be as high as the other `completion-read' APIs.
;; To use this style, prepend `fussy' to `completion-styles'.
;; For improved performance,`fussy-filter-fn' and `fussy-score-fn' for filtering
;; and scoring matches are good initial starting points for customization.
;; The various available scoring backends in `fussy-score-fn' have varying
;; levels of performance and match quality.
;; For a faster version that implements the same matching as `flx', use
;; https://github.com/jcs-elpa/flx-rs which is a native module written in Rust.
;; Other notable scoring backends supported by this package:
;; flx: https://github.com/lewang/flx
;; fzf: https://github.com/junegunn/fzf
;; skim: https://github.com/lotabout/fuzzy-matcher
;; For an exhaustive list of scoring backends, take a look at
;; https://github.com/jojojames/fussy#scoring-backends
(require 'flx)
(eval-when-compile (require 'subr-x))
;;; Code:
;;
;; (@* "Landmarks" )
;;
;; `fussy-all-completions'
;; `fussy-score'
;; `fussy-filter-default'
;;
;; (@* "Customizations" )
;;
(defgroup fussy nil
"Fuzzy completion style using `flx.'."
:group 'flx
:link '(url-link :tag "GitHub" "https://github.com/jojojames/fussy"))
(defcustom fussy-max-query-length 100
"Collections with queries longer than this are not scored using `flx'.
See `fussy-all-completions' for implementation details."
:group 'fussy
:type 'integer)
(defcustom fussy-max-candidate-limit 30000
"Apply optimizations for collections greater than this limit.
`fussy-all-completions' will apply some optimizations.
N -> this variable's value
1. The collection (to be scored) will initially be filtered based on
`fussy-max-limit-preferred-candidate-fn'.
2. Score only up to N * `fussy-percent-of-candidates-to-score' words.
The rest won't be scored.
Additional implementation details:
https://github.com/abo-abo/swiper/issues/207#issuecomment-141541960"
:group 'fussy
:type 'integer)
(defcustom fussy-percent-of-candidates-to-score .7
"When `fussy-max-candidate-limit' is hit, this variable determines the %
of candidates out of all candidates to score. For example, if
`fussy-max-candidate-limit' is 30000 and the collection is 40000, the # of
candidates to score will be 28000."
:group 'fussy
:type 'number)
(defcustom fussy-ignore-case t
"If t, ignores `completion-ignore-case'.
If this is set to nil, highlighting may break for cases where we're
highlighting with `completion-pcm--hilit-commonality'."
:group 'fussy
:type 'boolean)
(defcustom fussy-score-threshold-to-filter nil
"Candidates with scores of N or less are filtered.
Some backends such as `fussy-fuz-score' return negative scores
for low-quality matches.
If this is set to nil, threshold is defined by alist of
thresholds for score functions. Set this to a number to override
`fussy-score-threshold-to-filter-alist'.
Raise N to see fewer candidates. Lower N to see more
candidates. Keep N at 0 or more for performance."
:group 'fussy
:type 'integer)
(defcustom fussy-score-threshold-to-filter-alist
'((flx-score . -100)
(fussy-fuz-score . -100)
(fussy-fuz-bin-score . -100)
(fussy-fzf-native-score . 0))
"Candidates with scores of N or less are filtered for a given
`fussy-score-fn'.
Some backends such as `fussy-fuz-score' return negative scores
for low-quality matches.
Setting `fussy-score-threshold-to-filter' to a number will
override this alist.
If `fussy-score-fn' is not in the mapping, default to a threshold
of 0 wherever alist is used."
:group 'fussy
:type 'alist)
(defcustom fussy-max-word-length-to-score 400
"Words that are longer than this length are not scored."
:group 'fussy
:type 'integer)
(defcustom fussy-propertize-fn
#'fussy-propertize-common-part
"Function used to propertize matches.
Takes OBJ \(to be propertized\) and
SCORE \(list of indices of OBJ to be propertized\).
This function is expected to return OBJ.
If this is nil, don't propertize (e.g. highlight matches) at all.
This can also be set to nil to assume highlighting from a different source.
e.g. `fussy-filter-orderless' can also be used for highlighting matches."
:type `(choice
(const :tag "No highlighting" nil)
(const :tag "By completions-common face."
,#'fussy-propertize-common-part)
(const :tag "By flx propertization." ,'flx-propertize)
(function :tag "Custom function"))
:group 'fussy)
(defcustom fussy-compare-same-score-fn
#'fussy-histlen->strlen<
"Function used to compare matches with the same 'completion-score.
FN takes in and compares two candidate strings C1 and C2 and
returns which candidates should have precedence.
If this is nil, do nothing."
:type `(choice
(const :tag "Don't compare candidates with same score." nil)
(const :tag "Shorter candidates have precedence."
,#'fussy-strlen<)
(const :tag "Longer candidates have precedence."
,#'fussy-strlen>)
(const :tag "Recent candidates have precedence."
,#'fussy-histlen<)
(const :tag "Recent (then shorter length) candidates have precedence."
,#'fussy-histlen->strlen<)
(function :tag "Custom function"))
:group 'fussy)
(defcustom fussy-max-limit-preferred-candidate-fn nil
"Function used when collection length is greater than\
`fussy-max-candidate-limit'.
FN takes in and compares two candidate strings C1 and C2 and
returns which candidates should have precedence.
If this is nil, take the first `fussy-max-candidate-limit' number
of candidates that was returned by the completion table."
:type `(choice
(const :tag "Take the first X number of candidates." nil)
(const :tag "Shorter candidates have precedence."
,#'fussy-strlen<)
(const :tag "Longer candidates have precedence."
,#'fussy-strlen>)
(const :tag "Recent candidates have precedence."
,#'fussy-histlen<)
(const :tag "Recent (then shorter length) candidates have precedence."
,#'fussy-histlen->strlen<)
(function :tag "Custom function"))
:group 'fussy)
(defcustom fussy-filter-fn
#'fussy-filter-flex
"Function used for filtering candidates before scoring.
FN takes in the same arguments as `fussy-try-completions'.
This FN should not be nil.
Use either `fussy-filter-orderless' or `fussy-filter-default' for faster
filtering through the `all-completions' (written in C) interface.
If using `fussy-filter-default', `fussy-default-regex-fn' can be configured."
:type `(choice
(const :tag "Built in Flex Filtering"
,#'fussy-filter-flex)
(const :tag "Built in Faster Flex Filtering in C"
,#'fussy-filter-default)
(const :tag "Orderless Flex Filtering"
,#'fussy-filter-orderless-flex)
(const :tag "Orderless"
,#'fussy-filter-orderless)
(function :tag "Custom function"))
:group 'fussy)
(define-obsolete-variable-alias 'fussy-filter-fast 'fussy-filter-default
"2022 07 12")
(define-obsolete-variable-alias 'fussy-fast-regex-fn 'fussy-default-regex-fn
"2022 07 12")
(defcustom fussy-default-regex-fn
#'fussy-pattern-default
"Function used to create regex for `fussy-filter-default'.
It takes in a STR and returns a regex usable with `all-completions'.
The return value of this FN is meant to be pushed to `completion-regexp-list'.
Flex 1 is what is used in `company-flx'. It seems to be the fastest from an eye
test but all the regex are comparable in performance.
Flex 2 functions match the regex returned by `orderless-flex'. Flex 2 functions
are more exhaustive than Flex 1 functions."
:type `(choice
(const :tag "Flex 1"
,#'fussy-pattern-flex-1)
(const :tag "Flex 2"
,#'fussy-pattern-flex-2)
(const :tag "Default"
,#'fussy-pattern-default)
(const :tag "First Letter"
,#'fussy-pattern-first-letter)
(function :tag "Custom function"))
:group 'fussy)
(defcustom fussy-score-fn
'flx-score
"Function used for scoring candidates.
FN should at least take in STR and QUERY."
:type `(choice
(const :tag "Score using Flx"
,'flx-score)
(const :tag "Score using Flx-RS"
,#'fussy-flx-rs-score)
(const :tag "Score using Fuz"
,#'fussy-fuz-score)
(const :tag "Score using Fuz-Bin"
,#'fussy-fuz-bin-score)
(const :tag "Score using LiquidMetal"
,#'fussy-liquidmetal-score)
(const :tag "Score using Sublime-Fuzzy"
,#'fussy-sublime-fuzzy-score)
(const :tag "Score using Hotfuzz"
,#'fussy-hotfuzz-score)
(function :tag "Custom function"))
:group 'fussy)
(defcustom fussy-fuz-use-skim-p t
"If t, use skim fuzzy matching algorithm with `fuz'.
If nil, use clangd fuzzy matching algorithm with `fuz'.
This boolean is only used if `fussy-fuz-score' is the `fussy-score-fn'."
:group 'fussy
:type 'boolean)
(defcustom fussy-score-fns-without-indices '(fussy-hotfuzz-score
fussy-sublime-fuzzy-score
fussy-liquidmetal-score)
"List of scoring functions that only returns the score.
e.g. Instead of returning LIST SCORE MATCH_1 MATCH_2 which something like
`flx-score' does, it returns LIST SCORE.
Scoring functions in this list's highlighting are then taken care of by either
`fussy-filter-orderless' or `completion-pcm--hilit-commonality'. See
`fussy--using-pcm-highlight-p'.
Functions in this list should match `fussy-score-fn'."
:type '(list function)
:group 'fussy)
(defcustom fussy-remove-bad-char-fn
#'fussy-without-tofu-char
"Function used to strip characters that some backends are unable to handle.
Some scoring backends \(e.g. Rust backends\) are unable to handle strings with
certain character encoding. This function is applied to the candidate strings
before they are passed to the scoring function.
This was added specifically for `consult' but other encodings could also pose
a problem. To keep the performance of the Rust backends useful,
`fussy-without-tofu-char' is set as the default function.
`fussy-without-tofu-char' is an order of magnitude faster than
`fussy-without-unencodeable-chars' but won't handle every case.
Another option is to use `fussy-encode-coding-string' which dumbly converts
a multibytestring without considering what the final string will look like.
Using this may work for the purpose of matching too as the final candidate
string may go from something like abcX to abcR where X was the multibyte char
that is not usable with the above scoring backends and R is a random ascii
character encoded from X.
For more information: \(https://github.com/minad/consult/issues/585\)"
:type `(choice
(const :tag "Remove Tofu"
,#'fussy-without-tofu-char)
(const :tag "Remove All"
,#'fussy-without-unencodeable-chars)
(const :tag "Convert to Unibyte"
,#'fussy-encode-coding-string)
(function :tag "Custom function"))
:group 'fussy)
(defcustom fussy-prefer-prefix t
"When using `fussy-filter-default', whether to prefer infix or prefix.
If t, prefix is used with `all-completions', if nil, use infix.
Infix is generally faster for `all-completions' but is not exhaustive.
Prefix can be slower but is exhaustive. For `completing-read',exhaustive
filtering is generally more preferable but for `completion-at-point-functions',
using infix can be a good tradeoff.
This variable should be let-bound/wrapped over `completion-at-point-functions',
e.g. `company-capf' and set to nil for typing performance and kept to t for
normal `completing-read' scenarios.
See comments in `fussy-filter-default' for examples of what infix or prefix
can look like."
:type 'boolean
:group 'fussy)
(defcustom fussy-filter-unscored-candidates t
"Whether or not to filter unscored candidates.
This only applies when `fussy-max-candidate-limit' is reached."
:type 'boolean
:group 'fussy)
(defcustom fussy-use-cache nil
"Whether or not to use cache in `fussy-all-completions'."
:type 'boolean
:group 'fussy)
;;;###autoload
(defcustom fussy-adjust-metadata-fn
#'fussy--adjust-metadata
"Used for `completion--adjust-metadata' to adjust completion metadata.
`completion--adjust-metadata' is what is used to set up sorting of candidates
based on `completion-score'. The default `flex' completion style in
`completion-styles' uses `completion--flex-adjust-metadata' which respects
the original completion table's sort functions:
e.g. display-sort-function, cycle-sort-function
The default of `fussy-adjust-metadata-fn' is used instead to ignore
existing sort functions in favor of sorting based only on the scoring done by
`fussy-score-fn'."
:type `(choice
(const :tag "Adjust metadata using fussy."
,#'fussy--adjust-metadata)
(const :tag "Adjust metadata using flex."
,#'completion--flex-adjust-metadata)
(function :tag "Custom function"))
:group 'fussy)
(defmacro fussy--measure-time (&rest body)
"Measure the time it takes to evaluate BODY.
https://lists.gnu.org/archive/html/help-gnu-emacs/2008-06/msg00087.html"
`(let ((time (current-time)))
(let ((result ,@body))
(message "%.06f" (float-time (time-since time)))
result)))
;;
;; (@* "Constants and Variables" )
;;
(defvar-local fussy--hist-hash nil
"Hash table representing `minibuffer-history-variable'.
KEYs are values in the list.
VALUES are positions of the values in the list.
See `fussy--history-hash-table'.")
(defvar-local fussy--score-threshold-to-filter-alist-cache nil
"Cached value of threshold derived from alist for score functions.
If `fussy-score-threshold-to-filter' is non-nil, the cache is
ignored.
See `fussy-score-threshold-to-filter-alist'.")
(defvar-local fussy--all-cache nil
"Hash table representing a cache for `fussy-all-completions'.")
;;
;; (@* "All Completions Interface/API" )
;;
;;;###autoload
(defun fussy-try-completions (string table pred point)
"Try to flex-complete STRING in TABLE given PRED and POINT.
Implement `try-completions' interface by using `completion-flex-try-completion'."
;; (message "called `fussy-try-completions'...")
(completion-flex-try-completion string table pred point))
;;;###autoload
(defun fussy-all-completions (string table pred point)
"Get flex-completions of STRING in TABLE, given PRED and POINT.
Implement `all-completions' interface with additional fuzzy / `flx' scoring."
;; (message "called `fussy-all-completions'...")
(setf fussy--hist-hash (fussy--history-hash-table))
(when (and fussy-use-cache
(or
(not fussy--all-cache)
(equal string "")))
(setf fussy--all-cache
(make-hash-table :test 'equal)))
(when fussy-ignore-case
;; `completion-ignore-case' is usually set up in `minibuffer-with-setup-hook'.
;; e.g. `read-file-name-default'
;; Many search functions leverage this variable. In the case of fuzzy
;; matching, it is better to match insensitively.
;; For example, the implementation of `completion-pcm--hilit-commonality'
;; uses `case-fold-search' which sets its value to `completion-ignore-case'.
;; Other examples include `completion-pcm--all-completions' which is used by
;; `fussy-filter-flex'. `orderless-filter' and `all-completions' also use
;; this variable.
(setq-local completion-ignore-case t))
(let* ((metadata (completion-metadata string table pred))
(cache (if (memq (completion-metadata-get metadata 'category)
'(file
project-file))
flx-file-cache
flx-strings-cache))
(beforepoint (substring string 0 point))
(afterpoint (substring string point))
(bounds (completion-boundaries beforepoint table pred afterpoint))
(prefix (substring beforepoint 0 (car bounds)))
(infix (concat
(substring beforepoint (car bounds))
(substring afterpoint 0 (cdr bounds)))))
(if-let ((cached-all (and fussy-use-cache
(cl-copy-list
(gethash string fussy--all-cache)))))
(progn
;; (message "%s from hash with length %d"
;; string (length cached-all))
;; (fussy--print-hash-table fussy--all-cache)
(nconc cached-all (length prefix)))
(pcase
(while-no-input
(pcase-let*
((`(,all ,pattern ,_prefix)
(if-let ((cached-all
(and
fussy-use-cache
(> (length string) 0)
(cl-copy-list
(gethash
(substring string 0 (- (length string) 1))
fussy--all-cache)))))
(progn
;; (message "using cache for filter")
(list
cached-all
(fussy-make-pcm-highlight-pattern
beforepoint afterpoint bounds)
prefix))
(funcall fussy-filter-fn
string table pred point))))
;; (message (format
;; "fn: %S string: %s prefix: %s infix: %s all: %S pattern: %s"
;; 'fussy-all-completions
;; string prefix infix (or all '("nada")) pattern))
(when all
(if (or (> (length infix) fussy-max-query-length)
(string= infix ""))
(fussy--pcm-highlight pattern all)
(if (< (length all) fussy-max-candidate-limit)
(fussy--maybe-highlight
pattern
(fussy-score all infix cache))
(let ((unscored-candidates '())
(candidates-to-score '()))
;; Presort candidates by
;; `fussy-max-limit-preferred-candidate-fn'.
(setf unscored-candidates
(if fussy-max-limit-preferred-candidate-fn
(sort
all fussy-max-limit-preferred-candidate-fn)
;; If `fussy-max-limit-preferred-candidate-fn'
;; is nil, we'll partition the candidates as is.
all))
;; Partition the candidates into sorted and unsorted groups.
(dotimes (_n (* (length unscored-candidates)
fussy-percent-of-candidates-to-score))
(push (pop unscored-candidates) candidates-to-score))
(append
;; Compute all of the fuzzy scores only for candidates.
(fussy--maybe-highlight
pattern
(fussy-score
(reverse candidates-to-score)
infix cache))
;; Add the unsorted candidates.
;; We could highlight these too,
;; (e.g. with `fussy--maybe-highlight') but these are
;; at the bottom of the pile of candidates.
(if fussy-filter-unscored-candidates
(let ((r (car (funcall fussy-default-regex-fn infix))))
(if r
(cl-remove-if-not
(lambda (c) (string-match-p r c))
unscored-candidates)
unscored-candidates))
unscored-candidates))))))))
('nil
;; (message "fn: %S nil" 'fussy-all-completions)
nil)
('t
;; (message "fn: %S quoteT" 'fussy-all-completions)
nil)
(`,collection
;; (message (format "fn: %S collection: %s"
;; 'fussy-all-completions collection))
;; Collection can be 0 when there are no candidates returned.
(if (consp collection)
(progn
(when fussy-use-cache
;; (message "putting %s into hash with coll length %s"
;; string (length collection))
;; (fussy--print-hash-table fussy--all-cache)
(puthash string (cl-copy-list collection)
fussy--all-cache))
(nconc collection (length prefix)))
nil))))))
;;
;; (@* "Scoring & Highlighting" )
;;
(defun fussy-score (candidates string &optional cache)
"Score and propertize CANDIDATES using STRING.
Use CACHE for scoring.
Set a text-property \='completion-score on candidates with their score.
`completion--adjust-metadata' later uses this \='completion-score for sorting."
(let ((result '()))
(dolist (x candidates)
(setf x (copy-sequence x))
(if (> (length x) fussy-max-word-length-to-score)
;; Don't score x but don't filter it out either.
(unless fussy-filter-unscored-candidates
(push x result))
(let ((score (funcall fussy-score-fn
x
(if (fussy--orderless-p)
(replace-regexp-in-string "\\\s" "" string)
string)
cache)))
;; (message
;; (format "fn: %S candidate: %s query: %s score %S"
;; 'fussy-score x string score))
;; Candidates with a score of N or less are filtered.
(when (and score
;; Score of '(nil) can be returned...
(car score)
(> (car score)
(or fussy-score-threshold-to-filter
fussy--score-threshold-to-filter-alist-cache
(setq fussy--score-threshold-to-filter-alist-cache
(or (alist-get
fussy-score-fn
fussy-score-threshold-to-filter-alist)
0)))))
(put-text-property 0 1 'completion-score (car score) x)
;; If we're using pcm highlight, we don't need to propertize the
;; string here. This is faster than the pcm highlight but doesn't
;; seem to work with `find-file'.
(when (fussy--should-propertize-p)
(setf
x (funcall fussy-propertize-fn x score)))
(push x result)))))
;; Returns nil if empty.
(reverse result)))
(defun fussy--should-propertize-p ()
"Whether or not to call `fussy-propertize-fn'.
If `fussy--using-pcm-highlight-p' is t, highlighting will be handled in
`fussy--maybe-highlight'.
If `fussy--orderless-p' is t, `fussy-filter-orderless' will take care of
highlighting.
If `fussy-propertize-fn' is nil, no highlighting should take place."
(and
(not (fussy--using-pcm-highlight-p))
(not (fussy--orderless-p))
fussy-propertize-fn))
(defun fussy--maybe-highlight (pattern collection)
"Highlight COLLECTION using PATTERN.
Only highlight if `fussy--using-pcm-highlight-p' is t."
;; (message (format "fn: %S collection: %s"
;; 'fussy--maybe-highlight collection))
(when collection
(if (fussy--using-pcm-highlight-p)
(fussy--pcm-highlight pattern collection)
;; Assume that the collection's highlighting is handled elsewhere.
collection)))
(defun fussy--pcm-highlight (pattern collection)
"Highlight with pcm-style for COLLECTION using PATTERN.
pcm-style refers to using `completion-pcm--hilit-commonality' for highlighting."
(completion-pcm--hilit-commonality pattern collection))
(defun fussy-propertize-common-part (obj score)
"Return propertized copy of OBJ according to score.
If SCORE does not have indices to highlight, return OBJ unmodified."
(if (or
;; Has only score but no indices or nil.
(<= (length score) 1)
;; Indices are higher than the length of obj indicating the indices are
;; incorrect. Skip highlighting to avoid breaking completion.
;; Take the last index to compare against obj because all indices need
;; to be less than the length of obj in order for highlighting to work.
(>= (car (last score)) (length obj)))
obj
;; Has a score and an index to highlight.
(let ((block-started (cadr score))
(last-char nil)
;; Originally we used `substring-no-properties' when setting str but
;; that strips text properties that other packages may set.
;; One example is `consult', which sprinkles text properties onto
;; the candidate. e.g. `consult--line-prefix' will check for
;; 'consult-location on str candidate.
(str (if (consp obj) (car obj) obj)))
(dolist (char (cdr score))
(when (and last-char
(not (= (1+ last-char) char)))
(add-face-text-property block-started (1+ last-char)
'completions-common-part nil str)
(setf block-started char))
(setf last-char char))
(add-face-text-property block-started (1+ last-char)
'completions-common-part nil str)
(when (and
last-char
(> (length str) (+ 2 last-char)))
(add-face-text-property (1+ last-char) (+ 2 last-char)
'completions-first-difference
nil
str))
(if (consp obj)
(cons str (cdr obj))
str))))
;;
;; (@* "Bootstrap" )
;;
;;;###autoload
(progn
(put 'fussy 'completion--adjust-metadata fussy-adjust-metadata-fn)
(add-to-list 'completion-styles-alist
'(fussy fussy-try-completions fussy-all-completions
"Smart Fuzzy completion with scoring.")))
;;
;; (@* "Sorting" )
;;
(defun fussy--adjust-metadata (metadata)
"If actually doing filtering, adjust METADATA's sorting."
(let ((flex-is-filtering-p
;; JT@2019-12-23: FIXME: this is kinda wrong. What we need
;; to test here is "some input that actually leads/led to
;; flex filtering", not "something after the minibuffer
;; prompt". E.g. The latter is always true for file
;; searches, meaning we'll be doing extra work when we
;; needn't.
(or (not (window-minibuffer-p))
(> (point-max) (minibuffer-prompt-end)))))
`(metadata
,@(and flex-is-filtering-p
`((display-sort-function . fussy--sort)))
,@(and flex-is-filtering-p
`((cycle-sort-function . fussy--sort)))
,@(cdr metadata))))
(defun fussy--sort (completions)
"Sort COMPLETIONS using `completion-score' and completion length."
(sort
completions
(lambda (c1 c2)
(let ((s1 (or (get-text-property 0 'completion-score c1) 0))
(s2 (or (get-text-property 0 'completion-score c2) 0)))
;; (message (format "c1: %s score: %d" c1 s1))
;; (message (format "c2: %s score: %d" c2 s2))
(if (and (= s1 s2)
fussy-compare-same-score-fn)
(funcall fussy-compare-same-score-fn c1 c2)
;; Candidates with higher completion score have precedence.
(> s1 s2))))))
;;
;; (@* "Candidate Comparisons" )
;;
(defun fussy-strlen< (c1 c2)
"Return t if C1's length is less than C2's length."
(< (length c1) (length c2)))
(defun fussy-strlen> (c1 c2)
"Return t if C1's length is greater than C2's length."
(> (length c1) (length c2)))
(defun fussy-histlen< (c1 c2)
"Return t if C1 occurred more recently than C2.
Check C1 and C2 in `minibuffer-history-variable' which is stored in
`fussy--hist-hash'."
(if-let* ((hist fussy--hist-hash)
(c1-pos (or (gethash c1 hist) most-positive-fixnum))
(c2-pos (or (gethash c2 hist) most-positive-fixnum)))
(< c1-pos c2-pos)
nil))
(defun fussy-histlen->strlen< (c1 c2)
"Return t if C1 occurs more recently than C2 or is shorter than C2."
(if-let* ((hist fussy--hist-hash)
(c1-pos (or (gethash c1 hist) most-positive-fixnum))
(c2-pos (or (gethash c2 hist) most-positive-fixnum)))
(if (= c1-pos c2-pos)
(fussy-strlen< c1 c2)
(< c1-pos c2-pos))
(fussy-strlen< c1 c2)))
;;
;; (@* "Utils" )
;;
(defun fussy--orderless-p ()
"Return whether or not we're using `orderless' for filtering."
(or (eq fussy-filter-fn 'fussy-filter-orderless)
(eq fussy-filter-fn 'fussy-filter-orderless-flex)))
(defun fussy--using-pcm-highlight-p ()
"Check if highlighting should use `completion-pcm--hilit-commonality'.
Check if TABLE needs to be specially highlighted.
Check if `fussy-score-fn' used doesn't return match indices.
Check if `orderless' is being used."
(and
;; These don't generate match indices to highlight at all so we should
;; highlight with `completion-pcm--hilit-commonality'.
(memq fussy-score-fn fussy-score-fns-without-indices)
;; If we're using `orderless' to filter, don't use pcm highlights because
;; `orderless' does it on its own.
(not (fussy--orderless-p))))
(defun fussy--history-hash-table ()
"Return hash table representing `minibuffer-history-variable'.
Key is the history string and Value is the history position."
(when-let* ((hist (and (not (eq minibuffer-history-variable t))
(symbol-value minibuffer-history-variable)))
(table (make-hash-table :test 'equal
:size (length hist))))
(cl-loop for index from 0
for item in hist
unless (gethash item table)
do (puthash item index table))
table))
(defun fussy-without-unencodeable-chars (string)
"Strip invalid chars from STRING.
See `fussy-remove-bad-char-fn'."
;; https://emacs.stackexchange.com/questions/5732/how-to-strip-invalid-utf-8-characters-from-a-string
(string-join
(delq nil (mapcar (lambda (ch)
(encode-coding-char ch 'utf-8 'unicode))
string))))
(defconst fussy--consult--tofu-char #x200000
"Special character used to encode line prefixes for disambiguation.
We use invalid characters outside the Unicode range.")
(defconst fussy--consult--tofu-range #x100000
"Special character range.")
(defsubst fussy--consult--tofu-p (char)
"Return non-nil if CHAR is a tofu."
(<= fussy--consult--tofu-char char
(+ fussy--consult--tofu-char fussy--consult--tofu-range -1)))
(defun fussy-without-tofu-char (string)
"Strip unencodeable char from STRING.
See `fussy-remove-bad-char-fn'."
(if (fussy--consult--tofu-p (aref string (- (length string) 1)))
(substring string 0 (- (length string) 1))
string))
(defsubst fussy-encode-coding-string (string)
"Call `encode-coding-string' for STRING."
(encode-coding-string string 'utf-8 t))
(defun fussy--print-hash-table (table)
"Print TABLE."
(message "------------------------------------------------------------------")
(maphash (lambda (key value)
(message "key: %s length value %s" key (length value)))
table)
(message "------------------------------------------------------------------"))
(defun fussy-wipe-cache (&rest _)
"Wipe buffer local `fussy--all-cache'."
;; (message "Setting `fussy--all-cache' to nil..")
(setf fussy--all-cache nil))
;;
;; (@* "Filtering" )
;;
(declare-function "orderless-filter" "orderless")
(declare-function "orderless-highlight-matches" "orderless")
(declare-function "orderless--prefix+pattern" "orderless")
(defvar orderless-skip-highlighting)
;; Make sure this is defined. Otherwise there will be some weird behavior
;; when compared against the .elc version of this file.
;; For example, `orderless-filter' will not respect the let* bound
;; `orderless-matching-styles'.
(defvar orderless-matching-styles)
(defun fussy-filter-orderless-flex (string table pred _point)
"Match STRING to the entries in TABLE.
Use `orderless' for filtering by passing STRING, TABLE and PRED to
`orderless-filter'. _POINT is not used. This version sets up `orderless'
to only use the `orderless-flex' pattern."
(require 'orderless)
(when (and (fboundp 'orderless-filter)
(fboundp 'orderless-highlight-matches)
(fboundp 'orderless--prefix+pattern))
(let* ((orderless-matching-styles '(orderless-flex))
(completions (orderless-filter string table pred)))
(when completions
(pcase-let* ((`(,prefix . ,pattern)
(orderless--prefix+pattern string table pred))
(skip-highlighting
(if (functionp orderless-skip-highlighting)
(funcall orderless-skip-highlighting)
orderless-skip-highlighting)))
(if skip-highlighting
(list completions pattern prefix)
(let ((result (list
(orderless-highlight-matches pattern completions)
pattern prefix)))
;; (message "fn: %S result: %S"
;; 'fussy-filter-orderless-flex result)
result)))))))
(defun fussy-filter-orderless (string table pred _point)
"Match STRING to the entries in TABLE.
Use `orderless' for filtering by passing STRING, TABLE and PRED to
`orderless-filter'. _POINT is not used."
(require 'orderless)
(when (and (fboundp 'orderless-filter)
(fboundp 'orderless-highlight-matches)
(fboundp 'orderless--prefix+pattern))
(let* ((completions (orderless-filter string table pred)))
(when completions
(pcase-let* ((`(,prefix . ,pattern)
(orderless--prefix+pattern string table pred))
(skip-highlighting
(if (functionp orderless-skip-highlighting)
(funcall orderless-skip-highlighting)
orderless-skip-highlighting)))
(if skip-highlighting
(list completions pattern prefix)
(list (orderless-highlight-matches pattern completions)
pattern prefix)))))))
(defun fussy-filter-flex (string table pred point)
"Match STRING to the entries in TABLE.
Respect PRED and POINT. The filter here is the same as in
`completion-flex-all-completions'."
(pcase-let ((`(,completions ,pattern ,prefix ,_suffix ,_carbounds)
(completion-substring--all-completions
string
table pred point
#'completion-flex--make-flex-pattern)))
(list completions pattern prefix)))
(defun fussy-filter-default (string table pred point)
"Match STRING to the entries in TABLE.
Respect PRED and POINT. This filter uses the `all-completions' interface
that's written in C for faster filtering."
(let* ((beforepoint (substring string 0 point))
(afterpoint (substring string point))
(bounds (completion-boundaries beforepoint table pred afterpoint))
(prefix (substring beforepoint 0 (car bounds)))
(infix (concat
(substring beforepoint (car bounds))
(substring afterpoint 0 (cdr bounds))))
(regexp (funcall fussy-default-regex-fn infix))
(completion-regexp-list regexp)
;; Commentary on why we prefer prefix over infix.
;; For `find-file', if the prefix exists, we're in a different
;; directory, so should be retrieving candidates from that directory
;; instead.
;; ex. We started in ~/ home directory. User starts typing cod.
;; infix will be: c -> co -> cod
;; prefix will be ~/
;; User then enters a directory called ~/Code and types abc.
;; infix will be: a -> ab -> abc
;; prefix will be ~/Code
;; For `project-find-file', the prefix will usually be empty and only
;; the infix will be matched against.
;; So, *knock on wood*, it seems safe to prefer prefix completion over
;; infix completion.
(completions
;; Is there an easier way to check if string is empty or nil?
(if (or (/= (length prefix) 0)
fussy-prefer-prefix)
;; Always use prefix if available for correctness.
;; For example, `find-file', should always use prefix.
(or (all-completions prefix table pred)
(all-completions infix table pred))