-
Notifications
You must be signed in to change notification settings - Fork 31
/
ido-completing-read+.el
1285 lines (1129 loc) · 55.1 KB
/
ido-completing-read+.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
;;; ido-completing-read+.el --- A completing-read-function using ido -*- lexical-binding: t -*-
;; Copyright (C) 2011-2017 Ryan C. Thompson
;; Filename: ido-completing-read+.el
;; Author: Ryan C. Thompson <[email protected]>
;; Created: Sat Apr 4 13:41:20 2015 (-0700)
;; Version: 4.14
;; Package-Requires: ((emacs "24.4") (seq "0.5") (memoize "1.1"))
;; URL: https://github.com/DarwinAwardWinner/ido-completing-read-plus
;; Keywords: ido, completion, convenience
;; This file is NOT part of GNU Emacs.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
;; If you use the excellent `ido-mode' for efficient completion of
;; file names and buffers, you might wonder if you can get ido-style
;; completion everywhere else too. Well, that's what this package
;; does! ido-ubiquitous is here to enable ido-style completion for
;; (almost) every function that uses the standard completion function
;; `completing-read'.
;; This package implements the `ido-completing-read+' function, which
;; is a wrapper for `ido-completing-read'. Importantly, it detects
;; edge cases that ordinary ido cannot handle and either adjusts them
;; so ido *can* handle them, or else simply falls back to Emacs'
;; standard completion instead. Hence, you can safely set
;; `completing-read-function' to `ido-completing-read+' without
;; worrying about breaking completion features that are incompatible
;; with ido. (Package authors interested in implementing ido support
;; within their packages can also use `ido-completing-read+' instead
;; of `ido-completing-read' to provide a more consistent user
;; experience.)
;; To use this package, call `ido-ubiquitous-mode' to enable the mode,
;; or use `M-x customize-variable ido-ubiquitous-mode' it to enable it
;; permanently. Once the mode is enabled, most functions that use
;; `completing-read' will now have ido completion. If you decide in
;; the middle of a command that you would rather not use ido, just use
;; C-f or C-b at the end/beginning of the input to fall back to
;; non-ido completion (this is the same shortcut as when using ido for
;; buffers or files).
;; Note that `completing-read-default' is a very general function with
;; many complex behaviors that ido cannot emulate. This package
;; attempts to detect some of these cases and avoid using ido when it
;; sees them. So some functions will not have ido completion even when
;; this mode is enabled. Some other functions have ido disabled in
;; them because their packages already provide support for ido via
;; other means (for example, magit). See `M-x describe-variable
;; ido-cr+-disable-list' for more information.
;; ido-completing-read+ version 4.0 is a major update. The formerly
;; separate package ido-ubiquitous has been subsumed into
;; ido-completing-read+, so ido-ubiquitous 4.0 is just a wrapper that
;; loads ido-completing-read+ and displays a warning about being
;; obsolete. If you have previously customized ido-ubiquitous, be sure
;; to check out `M-x customize-group ido-completing-read-plus' after
;; updating to 4.0 and make sure the new settings are to your liking.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Code:
(defconst ido-completing-read+-version "4.14"
"Currently running version of ido-completing-read+.
Note that when you update ido-completing-read+, this variable may
not be updated until you restart Emacs.")
(require 'nadvice)
(require 'ido)
(require 'seq)
(require 'minibuf-eldef)
(require 'cl-lib)
(require 'cus-edit)
;; Optional dependency, only needed for optimization
(require 'memoize nil t)
;; Silence some byte-compiler warnings
(eval-when-compile
(require 'minibuf-eldef)
(require 'flx-ido nil t))
;;; Debug messages
(define-minor-mode ido-cr+-debug-mode
"If non-nil, ido-cr+ will print debug info.
Debug info is printed to the *Messages* buffer."
:init-value nil
:global t
:group 'ido-completing-read-plus)
(defsubst ido-cr+--debug-message (format-string &rest args)
"Emit a debug message for ido-cr+.
This only has an effect when `ido-cr+-debug-mode' is non-nil.
Arguments are identical to `message'."
(when ido-cr+-debug-mode
(apply #'message (concat "ido-completing-read+: " format-string) args)))
;;; Ido variables
;; For unknown reasons, these variables need to be re-declared here to
;; silence byte-compiler warnings, despite already being declared in
;; ido.el.
(defmacro ido-cr+-define-ido-internal-var (symbol &optional initvalue docstring)
"Declare and initialize SYMBOL an ido internal variable.
This is used to suppress byte-compilation warnings about
reference to free variables when ido-cr+ attempts to access
internal ido variables with no initial value set. Such variables
are originally declared like `(defvar VARNAME)'.
This is a wrapper for `defvar' that supplies a default for the
INITVALUE and DOCSTRING arguments."
`(defvar ,symbol ,initvalue
,(or docstring
"Internal ido variable.
This variable was originally declared in `ido.el' without an
initial value or docstring. The documentation you're reading
comes from re-declaring it in `ido-completing-read+.el' in order
to suppress some byte-compilation warnings. Setting another
package's variable is not safe in general, but in this case it
should be, because ido always let-binds this variable before
using it, so the initial value shouldn't matter.")))
(ido-cr+-define-ido-internal-var ido-context-switch-command)
(ido-cr+-define-ido-internal-var ido-cur-list)
(ido-cr+-define-ido-internal-var ido-cur-item)
(ido-cr+-define-ido-internal-var ido-require-match)
(ido-cr+-define-ido-internal-var ido-process-ignore-lists)
;; Vars and functions from flx-ido package
(defvar flx-ido-mode)
(declare-function flx-ido-reset "ext:flx-ido.el")
;;;###autoload
(defvar ido-cr+-minibuffer-depth -1
"Minibuffer depth of the most recent ido-cr+ activation.
If this equals the current minibuffer depth, then the minibuffer
is currently being used by ido-cr+, and ido-cr+ features will be
active. Otherwise, something else is using the minibuffer and
ido-cr+ features will be deactivated to avoid interfering with
the other command.
This is set to -1 by default, since `(minibuffer-depth)' should
never return this value.")
(defvar ido-cr+-assume-static-collection nil
"If non-nil, ido-cr+ will assume that the collection is static.
This is used to avoid unnecessary work in the case where the
collection is a function, since a function collection could
potentially change the set of completion candidates
dynamically.")
(defvar ido-cr+-current-command nil
"Command most recently invoked by `call-interactively'.
This is necessary because `command-execute' and
`call-interactively' do not set `this-command'. Instead, the C
code that calls `command-execute' sets it beforehand, so using
either of those functions directly won't set `this-command'.")
(defvar ido-cr+-dynamic-collection nil
"Stores the collection argument if it is a function.
This allows ido-cr+ to update the set of completion candidates
dynamically.")
(defvar ido-cr+-last-dynamic-update-text nil
"The value of `ido-text' last time a dynamic update occurred.")
(defvar ido-cr+-dynamic-update-idle-time 0.25
"Time to wait before updating dynamic completion list.")
(defvar ido-cr+-dynamic-update-timer nil
"Idle timer for updating dynamic completion list.")
(defvar ido-cr+-exhibit-pending nil
"This is non-nil between calling `ido-tidy' and `ido-exhibit'.
Typically this is non-nil while any command is running and nil at all
other times, since those two functions are in `pre-command-hook'
and `post-command-hook' respectively. In particular, this will
generally be nil while running an idle timer.")
(make-obsolete-variable
'ido-cr+-no-default-action
" This variable no longer has any effect. Customize `ido-cr+-nil-def-alternate-behavior-list' instead."
"4.2")
(defvar ido-cr+-orig-completing-read-args nil
"Original arguments passed to `ido-completing-read+'.
These are used for falling back to `completing-read-default'.")
(defvar ido-cr+-all-completions-memoized 'all-completions
"Memoized version of `all-completions'.
During completion with dynamic collection, this variable is set
to a memoized copy of `all-completions'.")
(defvar ido-cr+-all-prefix-completions-memoized 'ido-cr+-all-prefix-completions
"Memoized version of `ido-cr+-all-prefix-completions'.
During completion with dynamic collection, this variable is set
to a memoized copy of `ido-cr+-all-prefix-completions'.")
(defvar ido-cr+-active-restrictions nil
"List of restrictions in place from `ido-restrict-to-matches'.
Each element is a cons cell of (REMOVEP . TEXT), where REMOVEP is
the prefix argument to `ido-restrict-to-matches' and TEXT is the
pattern used to restrict.")
(defvar ido-cr+-need-bug27807-workaround
(cl-letf*
((ido-exit ido-exit)
((symbol-function 'read-from-minibuffer)
(lambda (_prompt &optional initial-contents &rest _remaining-args)
(setq ido-exit 'takeprompt) ; Emulate pressing C-j in ido
(if (consp initial-contents)
(substring (car initial-contents) 0 (1- (cdr initial-contents)))
initial-contents)))
;; Need to get the unadvised original of `ido-completing-read'
;; because the advice is autoloaded, so calling it while
;; loading the package will trigger a recursive load.
((symbol-function 'ido-completing-read)
(advice--cd*r (symbol-function 'ido-completing-read)))
(input-before-point
(ido-completing-read "Pick: " '("aaa" "aab" "aac") nil nil '("aa" . 1))))
;; If an initial position of 1 yields a 0-length string, then this
;; Emacs does not have the bug fix and requires the workaround.
(= (length input-before-point) 0))
"If non-nil, enable the workaround for Emacs bug #27807.
This variable is normally set when ido-cr+ is loaded, and should
not need to be modified by users.")
(defgroup ido-completing-read-plus nil
"Extra features and compatibility for `ido-completing-read'."
:group 'ido)
(defcustom ido-cr+-fallback-function
;; Initialize to the current value of `completing-read-function',
;; unless that is already set to the ido completer, in which case
;; use `completing-read-default'.
(if (memq completing-read-function
'(ido-completing-read+
ido-completing-read
;; Current ido-ubiquitous function
completing-read-ido-ubiquitous
;; Old ido-ubiquitous functions that shouldn't be used
completing-read-ido
ido-ubiquitous-completing-read))
'completing-read-default
completing-read-function)
"Alternate `completing-read-function' to use when ido is not wanted.
This will be used for functions that are incompatible with ido
or if ido cannot handle the completion arguments. It will also be
used when the user requests non-ido completion manually via C-f
or C-b."
:type '(choice (const :tag "Standard emacs completion"
completing-read-default)
(function :tag "Other function"))
:group 'ido-completing-read-plus)
(defcustom ido-cr+-max-items 30000
"Max collection size to use ido-cr+ on.
If `ido-completing-read+' is called on a collection larger than
this, the fallback completion method will be used instead. To
disable fallback based on collection size, set this to nil."
:type '(choice (const :tag "No limit" nil)
(integer
:tag "Limit" :value 30000
:validate
(lambda (widget)
(let ((v (widget-value widget)))
(if (and (integerp v)
(> v 0))
nil
(widget-put widget :error "This field should contain a positive integer")
widget)))))
:group 'ido-completing-read-plus)
(define-obsolete-variable-alias
'ido-cr+-function-blacklist
'ido-cr+-disable-list
"ido-completing-read+ 4.14")
(defcustom ido-cr+-disable-list
'(read-file-name-internal
read-buffer
internal-complete-buffer
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/60
todo-add-category
;; Gnus already supports ido on its own
gnus-emacs-completing-read
gnus-iswitchb-completing-read
grep-read-files
;; Magit already supports ido on its own
magit-builtin-completing-read
;; ESS already supports ido on its own
ess-completing-read
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/39
Info-read-node-name
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/44
tmm-prompt
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/156
org-tags-completion-function
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/159
ffap-read-file-or-url
ffap-read-file-or-url-internal
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/161
sly-read-symbol-name
org-olpath-completing-read
)
"Functions & commands for which ido-cr+ should be disabled.
Each entry can be either a symbol or a string. A symbol means to
fall back specifically for the named function. A regular
expression means to fall back for any function whose name matches
that regular expression. When ido-cr+ is called through
`completing-read', if any function in the call stack of the
current command matches any of the disable list entries, ido-cr+
will be disabled for that command. Additionally, if the
collection in the call to `completing-read' is a function name
that matches any of the entries, ido-cr+ will be disabled.
Note that using specific function names is generally preferable
to regular expressions, because the associated function
definitions will be compared directly, so if the same function is
called by another name, it should still trigger the fallback. For
regular expressions, only name-based matching is possible."
:group 'ido-completing-read-plus
:type '(repeat (choice (symbol :tag "Function or command name")
(string :tag "Regexp"))))
(define-obsolete-variable-alias
'ido-cr+-function-whitelist
'ido-cr+-allow-list
"ido-completing-read+ 4.14")
(defcustom ido-cr+-allow-list
nil
"If non-nil, limit ido-cr+ only to the specified commands & functions.
If this variable is nil, the ido-cr+ will be enabled for all
commands and functions not specified in all commands/functions
not specified in `ido-cr+-function-backlist'.
If this variable is non-nil, ido-cr+'s limited mode will be
enabled, and ido-cr+ will be disabled for *all* functions unless
they match one of the entries in this variable. Matching is done
in the same manner as `ido-cr+-disable-list', and the disable
list also takes precedence over the allow list."
:group 'ido-completing-read-plus
:type '(repeat (choice (symbol :tag "Function or command name")
(string :tag "Regexp"))))
(defvaralias 'ido-cr+-nil-def-wall-of-shame
'ido-cr+-nil-def-alternate-behavior-list
"Functions and commands that use `completing-read' improperly.
Many functions that call `completing-read' are written with the
assumption that the setting the REQUIRE-MATCH argument of
`completing-read' to t means it is required to return a match.
While that would make logical sense, it's wrong. the docstring
for `completing-read' describes the correct behavior.
> If the input is null, ‘completing-read’ returns DEF, or the
> first element of the list of default values, or an empty string
> if DEF is nil, regardless of the value of REQUIRE-MATCH.
This can be avoided by passing an element of COLLECTION as DEF
instead of leaving it as nil.")
(defcustom ido-cr+-nil-def-alternate-behavior-list
'("\\`describe-\\(function\\|variable\\)\\'"
"\\`wl-"
;; https://github.com/mrkkrp/ebal/issues/12
"\\`ebal-"
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/4
webjump
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/83
where-is
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/51
find-tag
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/89
"\\`etags-select-"
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/58
imenu--completion-buffer
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/116
project--completing-read-strict
;; https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues/127#issuecomment-319463217
bookmark-completing-read
)
"Functions & commands with alternate behavior when DEF is nil.
This variable has the same format as `ido-cr+-disable-list'. When
`ido-completing-read+` is called through `completing-read'
by/with any command, function, or collection matched by entries
in this list, it will behave differently when DEF is nil. Instead
of using the empty string as the default value, it will use the
first element of COLLECTION.
This is needed for optimal compatibility with commands written
under the reasonable but wrong assumption that REQUIRE-MATCH
means that a match is required."
:group 'ido-completing-read-plus
:type '(repeat (choice (symbol :tag "Function or command name")
(string :tag "Regexp"))))
;;;###autoload
(defcustom ido-cr+-replace-completely nil
"If non-nil, replace `ido-completeing-read' completely with ido-cr+.
Enabling this may interfere with or cause errors in other
packages that use `ido-completing-read'. If you discover any such
incompatibilities, please file a bug report at
https://github.com/DarwinAwardWinner/ido-completing-read-plus/issues"
:type 'boolean)
;; Signal used to trigger fallback
(define-error 'ido-cr+-fallback "ido-cr+-fallback")
(defsubst ido-cr+--explain-fallback (arg)
"Emit a debug message explaining the reason for falling back.
ARG can be a string or an ido-cr+-fallback signal. In the latter
case, the DATA part of the signal is used as the message."
(when ido-cr+-debug-mode
(when (and (listp arg)
(eq (car arg) 'ido-cr+-fallback))
(setq arg (cadr arg)))
(ido-cr+--debug-message
"Falling back to `%s' because %s."
(if (symbolp ido-cr+-fallback-function)
ido-cr+-fallback-function
"ido-cr+-fallback-function")
arg)))
;;;###autoload
(defsubst ido-cr+-active ()
"Return non-nil if ido-cr+ is currently using the minibuffer."
(>= ido-cr+-minibuffer-depth (minibuffer-depth)))
(defun ido-cr+--called-from-completing-read ()
"Return non-nil if the most recent call to ido-cr+ was from `completing-read'."
(equal (cadr (backtrace-frame 1 'ido-completing-read+))
'completing-read))
(defmacro ido-cr+-function-is-in-list (fun fun-list &optional list-name)
"Return non-nil if FUN matches an entry in FUN-LIST.
This is used to check for matches to `ido-cr+-disable-list' and
`ido-cr+-allow-list'. Read those docstrings to see how
the matching is done.
This is declared as macro only in order to extract the variable
name used for the second argument so it can be used in a debug
message. It should be called as if it were a normal function. The
optional 3rd argument LIST-NAME can be used to provide this
information manually if it is known."
(when (null list-name)
(if (symbolp fun-list)
(setq list-name (symbol-name fun-list))
(setq list-name "list")))
`(cl-loop
for entry in ,fun-list
if (cond
;; Nil: Never matches anything
((null entry)
nil)
;; Symbol: Compare names and function definitions
((symbolp entry)
(or (eq entry ,fun)
(let ((entry-def (ignore-errors (indirect-function entry)))
(fun-def (ignore-errors (indirect-function ,fun))))
(and
fun-def entry-def
(eq
(indirect-function entry-def)
(indirect-function fun-def))))))
;; String: Do regexp matching against function name if it is a
;; symbol
((stringp entry)
(and (symbolp ,fun)
(string-match-p entry (symbol-name ,fun))))
;; Anything else: invalid list entry
(t
(ido-cr+--debug-message "Ignoring invalid entry in %s: `%S'" ,list-name entry)
nil))
return entry
;; If no list entry matches, return nil
finally return nil))
(define-obsolete-function-alias
'ido-cr+-function-is-blacklisted
'ido-cr+-disabled-in-function-p
"ido-completing-read+ 4.14")
(defsubst ido-cr+-disabled-in-function-p (fun)
"Return non-nil if ido-cr+ is disabled for FUN.
See `ido-cr+-disable-list'."
(ido-cr+-function-is-in-list fun ido-cr+-disable-list))
(define-obsolete-function-alias
'ido-cr+-function-is-whitelisted
'ido-cr+-allowed-in-function-p
"ido-completing-read+ 4.14")
(defsubst ido-cr+-allowed-in-function-p (fun)
"Return non-nil if ido-cr+ is allowed for FUN.
See `ido-cr+-allow-list'."
(or (null ido-cr+-allow-list)
(ido-cr+-function-is-in-list fun ido-cr+-allow-list)))
;;;###autoload
(defun ido-completing-read+ (prompt collection &optional predicate
require-match initial-input
hist def inherit-input-method)
"Ido-based method for reading from the minibuffer with completion.
See `completing-read' for the meaning of the arguments.
This function is a wrapper for `ido-completing-read' designed to
be used as the value of `completing-read-function'. Importantly,
it detects edge cases that ido cannot handle and uses normal
completion for them.
See `completing-read' for the meaning of the arguments."
(let* (;; Save the original arguments in case we need to do the
;; fallback
(ido-cr+-orig-completing-read-args
(list prompt collection predicate require-match
initial-input hist def inherit-input-method))
;; Need to save a copy of this since activating the
;; minibuffer once will clear out any temporary minibuffer
;; hooks, which need to get restored before falling back so
;; that they will trigger again when the fallback function
;; uses the minibuffer. We make a copy in case the original
;; list gets modified in place.
(orig-minibuffer-setup-hook (cl-copy-list minibuffer-setup-hook))
;; Need just the string part of INITIAL-INPUT
(initial-input-string
(cond
((consp initial-input)
(car initial-input))
((stringp initial-input)
initial-input)
((null initial-input)
"")
(t
(signal 'wrong-type-argument (list 'stringp initial-input)))))
(ido-cr+-active-restrictions nil)
;; If collection is a function, save it for later, unless
;; instructed not to
(ido-cr+-dynamic-collection
(when (and (not ido-cr+-assume-static-collection)
(functionp collection))
collection))
(ido-cr+-last-dynamic-update-text nil)
;; Only memoize if the collection is dynamic.
(ido-cr+-all-prefix-completions-memoized
(if (and ido-cr+-dynamic-collection (featurep 'memoize))
(memoize (indirect-function 'ido-cr+-all-prefix-completions))
'ido-cr+-all-prefix-completions))
(ido-cr+-all-completions-memoized
(if (and ido-cr+-dynamic-collection (featurep 'memoize))
(memoize (indirect-function 'all-completions))
'all-completions))
;; If the allow list is empty, everything is allowed
(ido-cr+-allowed (not ido-cr+-allow-list))
;; If non-nil, we need alternate nil DEF handling
(alt-nil-def nil))
(condition-case sig
(progn
;; Check a bunch of fallback conditions
(when (and inherit-input-method current-input-method)
(signal 'ido-cr+-fallback
'("ido cannot handle alternate input methods")))
;; Check for allow/disable-listed collection function
(when (functionp collection)
;; Disable list
(when (ido-cr+-disabled-in-function-p collection)
(if (symbolp collection)
(signal 'ido-cr+-fallback
(list (format "collection function `%S' is disabled" collection)))
(signal 'ido-cr+-fallback
(list "collection function is disabled"))))
;; Allow list
(when (and (not ido-cr+-allowed)
(ido-cr+-allowed-in-function-p collection))
(ido-cr+--debug-message
(if (symbolp collection)
(format "Collection function `%S' is allowed" collection)
"Collection function is allowed"))
(setq ido-cr+-allowed t))
;; nil DEF list
(when (and
require-match (null def)
(ido-cr+-function-is-in-list
collection
ido-cr+-nil-def-alternate-behavior-list))
(ido-cr+--debug-message
(if (symbolp collection)
(format "Using alternate nil DEF handling for collection function `%S'" collection)
"Using alternate nil DEF handling for collection function"))
(setq alt-nil-def t)))
;; Expand all currently-known completions.
(setq collection
(if ido-cr+-dynamic-collection
(funcall ido-cr+-all-prefix-completions-memoized
initial-input-string collection predicate)
(all-completions "" collection predicate)))
;; No point in using ido unless there's a collection
(when (and (= (length collection) 0)
(not ido-cr+-dynamic-collection))
(signal 'ido-cr+-fallback '("ido is not needed for an empty collection")))
;; Check for excessively large collection
(when (and ido-cr+-max-items
(> (length collection) ido-cr+-max-items))
(signal 'ido-cr+-fallback
(list
(format
"there are more than %i items in COLLECTION (see `ido-cr+-max-items')"
ido-cr+-max-items))))
;; If called from `completing-read', check for
;; disabled/allowed commands/callers
(when (ido-cr+--called-from-completing-read)
;; Check calling command and `ido-cr+-current-command'
(cl-loop
for cmd in (list this-command ido-cr+-current-command)
if (ido-cr+-disabled-in-function-p cmd)
do (signal 'ido-cr+-fallback
(list "calling command `%S' is disabled" cmd))
if (and (not ido-cr+-allowed)
(ido-cr+-allowed-in-function-p cmd))
do (progn
(ido-cr+--debug-message "Command `%S' is allowed" cmd)
(setq ido-cr+-allowed t))
if (and
require-match (null def) (not alt-nil-def)
(ido-cr+-function-is-in-list
cmd ido-cr+-nil-def-alternate-behavior-list))
do (progn
(ido-cr+--debug-message
"Using alternate nil DEF handling for command `%S'" cmd)
(setq alt-nil-def t)))
;; Check every function in the call stack starting after
;; `completing-read' until to the first
;; `funcall-interactively' (for a call from the function
;; body) or `call-interactively' (for a call from the
;; interactive form, in which the function hasn't actually
;; been called yet, so `funcall-interactively' won't be on
;; the stack.)
(cl-loop for i upfrom 1
for caller = (cadr (backtrace-frame i 'completing-read))
while caller
while (not (memq (indirect-function caller)
'(internal--funcall-interactively
(indirect-function 'call-interactively))))
if (ido-cr+-disabled-in-function-p caller)
do (signal 'ido-cr+-fallback
(list (if (symbolp caller)
(format "calling function `%S' is disabled" caller)
"a calling function is disabled")))
if (and (not ido-cr+-allowed)
(ido-cr+-allowed-in-function-p caller))
do (progn
(ido-cr+--debug-message
(if (symbolp caller)
(format "Calling function `%S' is allowed" caller)
"A calling function is allowed"))
(setq ido-cr+-allowed t))
if (and require-match (null def) (not alt-nil-def)
(ido-cr+-function-is-in-list
caller ido-cr+-nil-def-alternate-behavior-list))
do (progn
(ido-cr+--debug-message
(if (symbolp caller)
(format "Using alternate nil DEF handling for calling function `%S'" caller)
"Using alternate nil DEF handling for a calling function"))
(setq alt-nil-def t))))
(unless ido-cr+-allowed
(signal 'ido-cr+-fallback
(list "no functions or commands matched the allow list for this call")))
(when (and require-match (null def))
;; Replace nil with "" for DEF if match is required, unless
;; alternate nil DEF handling is enabled
(if alt-nil-def
(ido-cr+--debug-message
"Leaving the default at nil because alternate nil DEF handling is enabled.")
(ido-cr+--debug-message
"Adding \"\" as the default completion since no default was provided.")
(setq def (list ""))))
;; In ido, the semantics of "default" are simply "put it at
;; the front of the list". Furthermore, ido can't handle a
;; list of defaults, nor can it handle both DEF and
;; INITIAL-INPUT being non-nil. So, just pre-process the
;; collection to put the default(s) at the front and then
;; set DEF to nil in the call to ido to avoid these issues.
(unless (listp def)
;; Ensure DEF is a list
(setq def (list def)))
(when def
;; Ensure DEF are strings
(setq def (mapcar (apply-partially #'format "%s") def))
;; Prepend DEF to COLLECTION and remove duplicates
(setq collection (delete-dups (append def collection))
def nil))
;; Check for a specific bug
(when (and ido-enable-dot-prefix
(version< emacs-version "26.1")
(member "" collection))
(signal 'ido-cr+-fallback
'("ido cannot handle the empty string as an option when `ido-enable-dot-prefix' is non-nil; see https://debbugs.gnu.org/cgi/bugreport.cgi?bug=26997")))
;; Fix ido's broken handling of cons-style INITIAL-INPUT on
;; Emacsen older than 27. See Emacs bug #27807.
(when (and (consp initial-input)
ido-cr+-need-bug27807-workaround)
;; `completing-read' uses 0-based index while
;; `read-from-minibuffer' uses 1-based index.
(cl-incf (cdr initial-input)))
;; Finally ready to do actual ido completion
(prog1
(let ((ido-cr+-minibuffer-depth (1+ (minibuffer-depth)))
(ido-cr+-dynamic-update-timer nil)
(ido-cr+-exhibit-pending t)
;; Reset this for recursive calls to ido-cr+
(ido-cr+-assume-static-collection nil))
(unwind-protect
(let ((return-value
(ido-completing-read
prompt collection
predicate require-match initial-input hist def
inherit-input-method)))
;; Functions like `read-from-kill-ring' add
;; display properties for things like ellipses,
;; which need to be removed. (Somehow
;; `completing-read-default' removes these
;; properties from its return value, though I
;; don't understand how.)
(remove-text-properties 0 (length return-value) '(display) return-value)
return-value)
(when ido-cr+-dynamic-update-timer
(cancel-timer ido-cr+-dynamic-update-timer)
(setq ido-cr+-dynamic-update-timer nil))))
;; This detects when the user triggered fallback mode
;; manually.
(when (eq ido-exit 'fallback)
(signal 'ido-cr+-fallback '("user manually triggered fallback")))))
;; Handler for ido-cr+-fallback signal
(ido-cr+-fallback
(let (;; Reset `minibuffer-setup-hook' to original value
(minibuffer-setup-hook orig-minibuffer-setup-hook)
;; Reset this for recursive calls to ido-cr+
(ido-cr+-assume-static-collection nil))
(ido-cr+--explain-fallback sig)
(apply ido-cr+-fallback-function ido-cr+-orig-completing-read-args))))))
;;;###autoload
(defun ido-completing-read@ido-cr+-replace (orig-fun &rest args)
"This advice allows ido-cr+ to completely replace `ido-completing-read'.
See the varaible `ido-cr+-replace-completely' for more information."
(if (or (ido-cr+-active)
(not ido-cr+-replace-completely))
;; ido-cr+ has either already activated or isn't going to
;; activate, so just run the function as normal
(apply orig-fun args)
;; Otherwise, we need to activate ido-cr+.
(apply #'ido-completing-read+ args)))
;;;###autoload
(advice-add 'ido-completing-read :around
#'ido-completing-read@ido-cr+-replace)
;;;###autoload
(defun call-interactively@ido-cr+-record-current-command
(orig-fun command &rest args)
"Let-bind the command being interactively called.
See `ido-cr+-current-command' for more information."
(let ((ido-cr+-current-command command))
(apply orig-fun command args)))
;;;###autoload
(advice-add 'call-interactively :around
#'call-interactively@ido-cr+-record-current-command)
;; Fallback on magic C-f and C-b
(defun ido-magic-forward-char@ido-cr+-fallback (&rest _args)
"Allow falling back in ido-completing-read+."
(when (ido-cr+-active)
;; `ido-context-switch-command' is already let-bound at this
;; point.
(setq ido-context-switch-command #'ido-fallback-command)))
(advice-add 'ido-magic-forward-char :before
#'ido-magic-forward-char@ido-cr+-fallback)
(defun ido-magic-backward-char@ido-cr+-fallback (&rest _args)
"Allow falling back in ido-completing-read+."
(when (ido-cr+-active)
;; `ido-context-switch-command' is already let-bound at this
;; point.
(setq ido-context-switch-command #'ido-fallback-command)))
(advice-add 'ido-magic-backward-char :before
#'ido-magic-backward-char@ido-cr+-fallback)
(defun ido-select-text@ido-cr+-fix-require-match (orig-fun &rest args)
"Fix ido behavior when `require-match' is non-nil.
Standard ido will allow C-j to exit with an incomplete completion
even when `require-match' is non-nil. Ordinary completion does
not allow this. In ordinary completion, RET on an incomplete
match is equivalent to TAB, and C-j selects the first match.
Since RET in ido already selects the first match, this advice
sets up C-j to be equivalent to TAB in the same situation.
This advice only activates if the current ido completion was
called through ido-cr+."
(if (and
;; Only override C-j behavior if...
;; We're using ico-cr+, and...
(ido-cr+-active)
;; Require-match is non-nil, and...
ido-require-match
;; The current input doesn't exactly match a known option, and...
(not (member ido-text ido-cur-list))
;; The current input doesn't exactly match an option according
;; to `test-completion' (or the collection is not dynamic).
(or (not ido-cr+-dynamic-collection)
(test-completion ido-text ido-cr+-dynamic-collection
(nth 2 ido-cr+-orig-completing-read-args))))
(progn
(ido-cr+--debug-message
"Overriding C-j behavior for require-match: performing completion instead of exiting with current text. (This might still exit with a match if `ido-confirm-unique-completion' is nil)")
(ido-complete))
(apply orig-fun args)))
(advice-add 'ido-select-text :around
#'ido-select-text@ido-cr+-fix-require-match)
(defun ido-tidy@ido-cr+-set-exhibit-pending (&rest _args)
"Advice to manage the value of `ido-cr+-exhibit-pending'."
(setq ido-cr+-exhibit-pending t))
(advice-add 'ido-tidy :after 'ido-tidy@ido-cr+-set-exhibit-pending)
(defun ido-exhibit@ido-cr+-clear-exhibit-pending (&rest _args)
"Advice to manage the value of `ido-cr+-exhibit-pending'."
(setq ido-cr+-exhibit-pending nil))
(advice-add 'ido-exhibit :before 'ido-exhibit@ido-cr+-clear-exhibit-pending)
(defun ido-cr+-all-prefix-completions
(string collection &optional predicate)
"Run `all-completions' on every prefix of STRING.
Arguments COLLECTION and PREDICATE are as in `all-completions'.
Note that \"all prefixes\" includes both STRING itself and the
empty string. The return value is the union of all the returned
lists, with elements ordered by their first occurrence.
This function is only useful if COLLECTION is a function that
might return additional completions for certain non-empty strings
that it wouldn't return for the empty string. If COLLECTION is
not a function, this is equivalent to
`(all-completions \"\" COLELCTION PREDICATE)'."
(cond
;; Dynamic collection.
((functionp collection)
;; Collect completions for all prefixes of STRING starting from
;; "".
(cl-loop
for i from 0 upto (length string)
append (funcall
ido-cr+-all-completions-memoized
(substring string 0 i)
collection
predicate)
into completion-list
finally return (delete-dups completion-list)))
;; If COLLECTION is not dynamic, then just call `all-completions'
;; on the empty string, which will already return every possible
;; completion.
(t
(all-completions "" collection predicate))))
(defun ido-cr+-apply-restrictions (collection restrictions)
"Filter COLLECTION through RESTRICTIONS in sequence.
COLLECTION is a list of strings. RESTRICTIONS is a list of cons
cells, with the cdr being the restriction text and the car being
nil to include matches for that text and t to exclude matches for
that text. The return value is a list of strings that satisfy all
the restrictions, in the same order as they appeared in
COLLECTION.
RESTRICTIONS are applied one by one in order, which is important
because in theory the order can make a difference to the final
result."
(cl-loop
with filtered-collection = collection
with need-reverse = nil
for (removep . text) in restrictions
for restriction-matches =
(let ((ido-text text)
(ido-cur-item (or ido-cur-item 'list)))
(ido-set-matches-1 filtered-collection t))
do (setq filtered-collection
(if removep
(seq-difference filtered-collection restriction-matches)
(setq need-reverse (not need-reverse))
restriction-matches))
;; Each run of `ido-set-matches-1' reverses the order, so reverse
;; it one more time if it had an odd number of reverses.
finally return
(if need-reverse
(nreverse filtered-collection)
filtered-collection)))
(defun ido-cr+-cyclicp (x)
"Return non-nill if X is a list containing a circular reference."
(cl-loop
for tortoise on x
for hare on (cdr x) by #'cddr
thereis (eq tortoise hare)))
(defun ido-cr+-update-dynamic-collection ()
"Update the set of completions for a dynamic collection.
This has no effect unless `ido-cr+-dynamic-collection' is non-nil."
(when (and ido-cr+-dynamic-collection
(ido-cr+-active))
;; (cl-assert (not (ido-cr+-cyclicp ido-cur-list)))
(let ((orig-ido-cur-list ido-cur-list)
(ido-text
(buffer-substring-no-properties (minibuffer-prompt-end)
ido-eoinput)))
;; If current `ido-text' is equal to or a prefix of the previous
;; one, a dynamic update is not needed.
(when (or (null ido-cr+-last-dynamic-update-text)
(not (string-prefix-p ido-text ido-cr+-last-dynamic-update-text)))
(ido-cr+--debug-message "Doing a dynamic update because `ido-text' changed from %S to %S"
ido-cr+-last-dynamic-update-text ido-text)
(setq ido-cr+-last-dynamic-update-text ido-text)
(condition-case-unless-debug err
(let* ((predicate (nth 2 ido-cr+-orig-completing-read-args))
(first-match (car ido-matches))
(strings-to-check
(cond
;; If no match, then we only check `ido-text'
((null first-match)
(list ido-text))
;; If `ido-text' is a prefix of `first-match', then we
;; only need to check `first-match'