-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathamx-3.4.tar
1423 lines (1221 loc) · 60 KB
/
amx-3.4.tar
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
amx-3.4/ 0000755 0000000 0000000 00000000000 00000000000 010604 5 ustar root root amx-3.4/amx.el 0000644 0000000 0000000 00000142535 00000000000 011725 0 ustar root root ;;; amx.el --- Alternative M-x with extra features. -*- lexical-binding: t; -*-
;; Copyright (C) 2017 Ryan C. Thompson
;;
;; Some Portions Copyright (C) 2009-2014 Cornelius Mika and other contributors
;;
;; Author: Ryan C. Thompson <rct@thompsonclan.org>
;; Cornelius Mika <cornelius.mika@gmail.com>
;; Maintainer: Ryan C. Thompson <rct@thompsonclan.org>
;; URL: http://github.com/DarwinAwardWinner/amx/
;; Package-Version: 3.4
;; Package-Commit: 37f9c7ae55eb0331b27200fb745206fc58ceffc0
;; Package-Requires: ((emacs "24.4") (s "0"))
;; Version: 3.4
;; Keywords: convenience, usability, completion
;; This file is not 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Quick start: Run `M-x amx-mode'. Enable ido-mode or ivy-mode if you
;; like. Use M-x as normal.
;;
;; For a more details see:
;; http://github.com/DarwinAwardWinner/amx/blob/master/README.mkdn
;;; Code:
(require 'cl-lib)
(require 's)
(defvar amx-initialized nil
"If non-nil amx is initialized.")
(defvar amx-cache)
(defvar amx-data)
(defvar amx-history)
(defvar amx-backend)
;; Variables used from other packages
(defvar smex-save-file)
(defvar ivy-mode)
(defvar ivy-text)
(defvar ido-mode)
(defvar ido-ubiquitous-mode)
(defvar ido-completion-map)
(defvar ido-setup-hook)
(defvar ido-text)
(defvar helm-comp-read-map)
(defvar amx-command-count 0
"Number of commands known to amx.")
(defvar amx-custom-action nil
"If non-nil, amx will call this in place of `execute-extended-command'.
This should be set to a function that accepts a symbol
representing the name of a command.")
(defvar amx-minibuffer-depth -1
"Used to determine if amx \"owns\" the current active minibuffer.")
(defvar amx-command-keybind-hash (make-hash-table :size 0)
"Hash table for translating between commands and key bindings.
See `amx-make-keybind-hash'.")
(defvar amx-origin-buffer nil
"The buffer amx was called from.
This is used to determine which buffer's key bindings to use when
`amx-show-key-bindings' is non-nil.")
(defvar amx-known-backends nil
"Plist of known amx completion backends.")
(defvar amx-temp-prompt-string nil
"If non-nil, overrides `amx-prompt-string' once.
Each time `amx-prompt-with-prefix-arg' is called, this is reset
to nil.")
;; This timer will run every time Emacs is idle for 1 second, but most
;; of the time it will do nothing.
(defvar amx-short-idle-update-timer nil)
;; This timer forces a periodic updates to happen if you walk away for
;; a few hours, so that amx won't wait until you come back to do a
;; periodic update
(defvar amx-long-idle-update-timer nil)
(defvar amx-last-update-time nil
"Time when `amx-update' was last run.
If nil, a `amx-update' is needed ASAP.")
(cl-defstruct amx-backend
name
required-feature
comp-fun
get-text-fun
exit-fun
auto-activate)
(defgroup amx nil
"M-x interface with Ido-style fuzzy matching and ranking heuristics."
:group 'extensions
:group 'convenience
:link '(emacs-library-link :tag "Lisp File" "amx.el"))
;;;###autoload
(define-minor-mode amx-mode
;; TODO Update all references to ido
"Use ido completion for M-x"
:global t
:group 'amx
(if amx-mode
(progn
(amx-initialize)
(add-hook 'auto-save-hook 'amx-save-to-file)
(global-set-key [remap execute-extended-command] 'amx))
(remove-hook 'auto-save-hook 'amx-save-to-file)
(when (eq (global-key-binding [remap execute-extended-command]) 'amx)
(global-unset-key [remap execute-extended-command]))))
(define-minor-mode amx-debug-mode
"If non-nil, amx will print debug info.
Debug info is printed to the *Messages* buffer."
:global t
:group 'amx)
(defsubst amx--debug-message (format-string &rest args)
"Send a message prefixed with \"amx\" and the current time.
This has no effect unless `amx-debug-mode' is enabled.
Arguments have the same meaning as in `message'."
(when amx-debug-mode
(apply #'message (concat "amx (%s): " format-string)
(format-time-string "%FT%T.%6N%z") args)))
(defun amx-set-auto-update-interval (symbol value)
"Custom setter for `amx-auto-update-interval'.
Arguments have the same meaning as in `set-default'.
In addition to setting the variable, this will also set up an
idle timer to ensure that updates happen when idle."
(cl-assert (eq symbol 'amx-auto-update-interval))
(set-default symbol value)
;; Cancel any previous timer
(when amx-long-idle-update-timer
(cancel-timer amx-long-idle-update-timer)
(setq amx-long-idle-update-timer nil))
(when value
;; Enable idle updating
(setq amx-long-idle-update-timer
(run-with-idle-timer (1+ (* 60 value)) t
'amx-idle-update))))
(defcustom amx-auto-update-interval nil
"Time in minutes between periodic updates of the command list.
Amx already updates the command list after functions like `load'
and `eval-expression' that could possibly define new commands.
Generally this should be enough to catch all newly-loaded
commands, but just in case any slip through, you can enable
periodic updates to catch them. If this variable is nil, no
periodic updates will be performed."
:type '(choice (const :tag "Disabled" nil)
(number :tag "Minutes"))
:set #'amx-set-auto-update-interval)
(defun amx-set-save-file (symbol value)
"Custom setter for `amx-save-file'.
Arguments are the same as in `set-default'."
(cl-assert (eq symbol 'amx-save-file))
(let ((old-value (when (boundp symbol) (symbol-value symbol))))
(set-default symbol value)
(if (file-exists-p value)
;; If the new save file already exists, reinitialize from it
;; (but only if amx is already initialized).
(when (bound-and-true-p amx-initialized)
(amx-initialize t))
;; If the new save file doesn't exist but the old one does, copy
;; the old file to the new location. In this case we don't need
;; to re-initialize, because the contents of the file have not
;; changed.
(when (and old-value (file-exists-p old-value))
(copy-file old-value value)))))
(defcustom amx-save-file (locate-user-emacs-file "amx-items" ".amx-items")
"File in which the amx state is saved between Emacs sessions.
Variables stored are: `amx-data', `amx-history'.
When changing this variable through Custom, amx will check for an
already-existing file at the new path. If it exists, amx will
re-initialize using this file. Otherwise, it will copy the
current save file from the old location to the new one."
:type '(choice (string :tag "File name")
(const :tag "Don't save" nil))
:set #'amx-set-save-file)
(defcustom amx-history-length 7
"Number of recently executed commands to record."
;; TODO allow this to be set any time
:type 'integer)
(defcustom amx-show-key-bindings t
"If non-nil, show key binding while completing commands.
Enabling this feature can cause a noticeable delay when running
`amx', so you may wish to disable it (by setting this variable to
nil) if you don't find it useful."
:type 'boolean)
(defcustom amx-prompt-string "M-x "
"String to display in the Amx prompt."
:type 'string)
(defcustom amx-ignored-command-matchers
'("\\`self-insert-command\\'"
"\\`self-insert-and-exit\\'"
"\\`ad-Orig-"
"\\`menu-bar"
amx-command-marked-ignored-p
amx-command-obsolete-p
amx-command-mouse-interactive-p)
"List of regexps and/or functions.
Each element is either a regular expression or a function of one
argument. Commands that match any of the regexps or return
non-nil for any of these functions will be hidden from the amx
completion list (but will still be accessible by typing in their
exact name).
Note that if you want an exact match, the Elisp regular
expression anchors for start and end of string are \"\\`\" and
\"\\'\", respectively.
Enabling this feature can cause a noticeable delay when running
`amx', so you may wish to disable it (by setting this variable to
nil) if you don't find it useful."
:type '(repeat
(choice
(regexp :tag "Regular expression")
(function :tag "Function"))))
;;--------------------------------------------------------------------------------
;; Amx Internals
(defun amx-get-command-name (cmd)
"Return CMD as a string.
CMD can be a string, symbol, or cons cell whose `car' is a string
or symbol."
(cond
((symbolp cmd)
(symbol-name cmd))
((consp cmd)
(amx-get-command-name (car cmd)))
((stringp cmd)
cmd)
(t
(error "Unrecognized command: %S" cmd))))
(defun amx-get-command-symbol (cmd &optional force)
"Return CMD as a symbol, or nil if it is not a command.
CMD can be a symbol or a string, and will always be returned as a
symbol (although the returned symbol may be nil).
If optional argument FORCE is non-nil, return the symbol even if it
does not correspond to a defined command."
(cond
((consp cmd)
(amx-get-command-symbol (car cmd)))
((symbolp cmd)
(when (or force (commandp cmd))
cmd))
((stringp cmd)
(amx-get-command-symbol
(funcall (if force #'intern #'intern-soft) cmd)
force))
((null cmd)
nil)
(t
(error "Unrecognized command: %S" cmd))))
(defun amx-get-default (choices &optional bind-hash)
"Get the first non-ignored entry from CHOICES as a string."
(cl-loop
with bind-hash = (or bind-hash amx-command-keybind-hash)
for choice in
(if (listp choices)
choices
(amx--debug-message "Getting default from non-list collection might be slow")
(all-completions "" choices))
for cmd = (amx-get-command-name choice)
if (not (amx-command-ignored-p cmd))
return (amx-augment-command-with-keybind (format "%s" cmd) bind-hash)
finally return nil))
;;--------------------------------------------------------------------------------
;; Amx Interface
(defsubst amx-active ()
"Return non-nil if amx is currently using the minibuffer."
(>= amx-minibuffer-depth (minibuffer-depth)))
;;;###autoload
(defun amx ()
"Read a command name and execute the command.
This is the main entry point for the Amx package, an alternative
to the normal \\[execute-extended-command] built into Emacs that
provides several extra features."
(interactive)
(amx-initialize)
(if (amx-active)
(amx-update-and-rerun)
(amx-update-if-needed)
(amx-read-and-run amx-cache)))
(defun amx-update-and-rerun ()
"Check for newly defined commands and re-run `amx'.
This function should only be called if amx completion is already
running."
(unless (amx-active)
(error "Cannot rerun amx because it is not currently running"))
(select-window (active-minibuffer-window))
(message "Re-running amx")
(let ((new-initial-input
(funcall (amx-backend-get-text-fun (amx-get-backend)))))
(amx-do-with-selected-item
(lambda (_) (amx-update) (amx-read-and-run amx-cache new-initial-input)))))
(defun amx-read-and-run (commands &optional initial-input)
"Prompt the user using Amx to choose one of COMMANDS and run it.
INITIAL-INPUT has the same meaning as in
`completing-read'."
(amx--debug-message "Starting amx-read-and-run")
(let* ((amx-origin-buffer
(or amx-origin-buffer (current-buffer)))
(amx-command-keybind-hash
(if amx-show-key-bindings
(amx-make-keybind-hash)
(make-hash-table :size 0)))
(def (amx-get-default commands))
(_ignore (amx--debug-message "Got default: %s" def))
(commands
;; Add key bindings to completions
(if amx-show-key-bindings
(completion-table-in-turn
(amx-augment-commands-with-keybinds commands)
commands)
commands))
(collection
(if amx-ignored-command-matchers
;; Initially complete with only non-ignored commands,
;; but if all of those are ruled out, allow completing
;; with ignored commands.
(apply-partially #'completion-table-with-predicate
commands
(lambda (cmd) (not (amx-command-ignored-p cmd)))
nil)
commands))
(_ignore (amx--debug-message "Ready to call amx-completing-read"))
;; Symbol
(chosen-item
(amx-clean-command-name
(amx-completing-read collection
:initial-input initial-input
:def def)))
;; String
(chosen-item-name (symbol-name chosen-item)))
(cl-assert (commandp chosen-item))
(if amx-custom-action
(let ((action amx-custom-action))
(setq amx-custom-action nil)
(funcall action chosen-item))
(unwind-protect
;; Don't warn about non-interactive use of
;; `execute-extended-command'
(with-no-warnings
(execute-extended-command current-prefix-arg chosen-item-name))
(amx-rank chosen-item)))))
;;;###autoload
(defun amx-major-mode-commands ()
"Like `amx', but limited to commands that are relevant to the active major mode."
(interactive)
(amx-initialize)
(let ((commands (delete-dups (append (amx-extract-commands-from-keymap (current-local-map))
(amx-extract-commands-from-features major-mode)))))
(setq commands (amx-sort-according-to-cache commands))
(setq commands
(apply-partially #'completion-table-with-predicate
commands
(lambda (cmd) (not (amx-command-ignored-p cmd)))
nil))
(amx-read-and-run commands)))
(defvar amx-map
(let ((keymap (make-sparse-keymap)))
(define-key keymap (kbd "C-h f") 'amx-describe-function)
(define-key keymap (kbd "C-h w") 'amx-where-is)
(define-key keymap (kbd "M-.") 'amx-find-function)
keymap)
"Additional key bindings for amx completion.")
(defvar amx-ido-map
(let ((keymap (make-sparse-keymap)))
(define-key keymap (kbd "C-a") 'move-beginning-of-line)
(set-keymap-parent keymap amx-map)
keymap))
(defun amx-prepare-ido-bindings ()
"Add Amx bindings to the ido completion map.
This must be run from `ido-setup-hook'."
(setq ido-completion-map
(make-composed-keymap (list amx-ido-map ido-completion-map))))
(defun amx-default-exit-minibuffer ()
"Run the key binding for RET.
This should work for most completion backends, without having to
know exactly which functions each one uses to exit the
minibuffer."
(execute-kbd-macro (kbd "RET")))
(cl-defun amx-completing-read (choices &key initial-input predicate def backend)
(when backend
(amx-load-backend backend))
(let ((amx-backend (or backend amx-backend)))
(amx--debug-message "Doing completion using backend `%s'" amx-backend)
;; Need to do this to ensure that the specified backend is
;; available
(let ((amx-minibuffer-depth (1+ (minibuffer-depth)))
(comp-fun (amx-backend-comp-fun (amx-get-backend))))
(funcall comp-fun choices
:initial-input initial-input
;; Work around a bug
:predicate (or predicate #'identity)
:def def))))
(defun amx-prompt-with-prefix-arg ()
"Return `amx-prompt-string' with the prefix arg prepended."
(let ((amx-prompt-string
(or amx-temp-prompt-string amx-prompt-string)))
(setq amx-temp-prompt-string nil)
(if (not current-prefix-arg)
amx-prompt-string
(concat
(if (eq current-prefix-arg '-)
"- "
(if (integerp current-prefix-arg)
(format "%d " current-prefix-arg)
(if (= (car current-prefix-arg) 4)
"C-u "
(format "%d " (car current-prefix-arg)))))
amx-prompt-string))))
;;--------------------------------------------------------------------------------
;; Pluggable Backends
(cl-defun amx-define-backend (&key name comp-fun
(get-text-fun 'amx-default-get-text)
(exit-fun 'amx-default-exit-minibuffer)
required-feature
auto-activate)
"Define a new backend for `amx'.
A backend must be defined with at least a `:name' and a
`:comp-fun', which is the function to call to do completion. The
`:comp-fun' must accept the same arguments as
`amx-completing-read-default'.
Additionally, a backend must declare a `:get-text-fun', unless
`amx-default-get-text' is sufficient to get the user's currently
entered text for the backend. Similarly, if pressing RET is not
the correct way to exit the minibuffer with the currently
selected text or item when using the backend, it must declare an
`:exit-fun' that does so.
If the backend needs to load a feature in order to be used, it
must declare that feature using `:required-feature'. If there is
a condition under which the backend should automatically be
activated, that should be declared as `:auto-activate'. If the
condition evaluates to non-nil, the auto backend will automatically
choose the backend."
(cl-assert
(and (symbolp name) name
;; Unfortunately we can't rely on these to be defined as
;; functions since their respective packages may not be
;; loaded.
(or (functionp comp-fun) (symbolp comp-fun))
(or (functionp get-text-fun) (symbolp get-text-fun))
(or (functionp exit-fun) (symbolp exit-fun))
(symbolp required-feature))
nil
"Invalid amx backend spec: (:name %S :comp-fun %S :get-text-fun %S :exit-fun %S :required-feature %S :auto-activate %S)"
(list name comp-fun get-text-fun exit-fun required-feature auto-activate))
(let ((backend
(make-amx-backend :name name
:comp-fun comp-fun
:get-text-fun get-text-fun
:exit-fun exit-fun
:required-feature required-feature
:auto-activate auto-activate)))
(setq amx-known-backends
(plist-put amx-known-backends name backend))))
(cl-defun amx-get-backend (&optional (backend amx-backend))
(cond
((amx-backend-p backend)
backend)
((plist-get amx-known-backends backend))
(t (error "Unknown amx backed %S" backend))))
(cl-defun amx-completing-read-default (choices &key initial-input predicate def)
"Amx backend for default Emacs completion."
(amx--debug-message "Preparing default-style completion")
(require 'minibuf-eldef)
(let ((minibuffer-completion-table choices)
(prompt (concat (amx-prompt-with-prefix-arg)
(when def
(format "[%s]: " def))))
(prev-eldef-mode minibuffer-electric-default-mode))
(unwind-protect
(progn
(minibuffer-electric-default-mode 1)
(minibuffer-with-setup-hook
(lambda ()
(use-local-map (make-composed-keymap
(list amx-map (current-local-map)))))
(amx--debug-message "Starting default-style completion")
(completing-read-default
prompt choices predicate t initial-input
'extended-command-history def)))
(minibuffer-electric-default-mode
(if prev-eldef-mode 1 0)))))
(defun amx-default-get-text ()
"Default function for getting the user's current text input.
May not work for things like ido and ivy."
(buffer-substring-no-properties (minibuffer-prompt-end) (point-max)))
(amx-define-backend
:name 'standard
:comp-fun 'amx-completing-read-default
:get-text-fun 'amx-default-get-text)
(declare-function ido-completing-read+ "ext:ido-completing-read+")
(cl-defun amx-completing-read-ido (choices &key initial-input predicate def)
"Amx backend for ido completion."
(require 'ido-completing-read+)
(let ((ido-completion-map ido-completion-map)
(ido-setup-hook (cons 'amx-prepare-ido-bindings ido-setup-hook))
(minibuffer-completion-table choices))
(ido-completing-read+ (amx-prompt-with-prefix-arg) choices predicate t
initial-input 'extended-command-history def)))
(defun amx-ido-get-text ()
"Function to return the user's entered text for ido."
ido-text)
(amx-define-backend
:name 'ido
:comp-fun 'amx-completing-read-ido
:get-text-fun 'amx-ido-get-text
:required-feature 'ido-completing-read+
:auto-activate '(or (bound-and-true-p ido-mode)
(bound-and-true-p ido-ubiquitous-mode)))
(declare-function ivy-read "ext:ivy")
(cl-defun amx-completing-read-ivy (choices &key initial-input predicate def)
"Amx backend for ivy completion."
(require 'ivy)
(ivy-read (amx-prompt-with-prefix-arg) choices
:predicate predicate
:keymap amx-map
:history 'extended-command-history
:initial-input initial-input
:preselect def
:require-match t
:caller 'amx-completing-read-ivy))
(defun amx-ivy-get-text ()
"Function to return the user's entered text for ivy."
ivy-text)
(amx-define-backend
:name 'ivy
:comp-fun 'amx-completing-read-ivy
:get-text-fun 'amx-ivy-get-text
:required-feature 'ivy
:auto-activate '(bound-and-true-p ivy-mode))
(declare-function helm-comp-read "ext:helm-mode")
(cl-defun amx-completing-read-helm (choices &key initial-input predicate def)
"Amx backend for helm completion."
(require 'helm-config)
(require 'helm-mode) ; Provides `helm-comp-read-map'
(helm-comp-read (amx-prompt-with-prefix-arg) choices
:initial-input initial-input
:test predicate
:default def
:name "Helm M-x Completions"
:buffer "Helm M-x Completions"
:history extended-command-history
:reverse-history t
:must-match t
:fuzzy (or (bound-and-true-p helm-mode-fuzzy-match)
(bound-and-true-p helm-M-x-fuzzy-match))
:keymap (make-composed-keymap amx-map helm-comp-read-map)))
(amx-define-backend
:name 'helm
:comp-fun 'amx-completing-read-helm
:get-text-fun 'amx-default-get-text
:exit-fun 'helm-confirm-and-exit-minibuffer
:required-feature 'helm
:auto-activate '(bound-and-true-p helm-mode))
(declare-function selectrum-completing-read "ext:selectrum")
(defvar selectrum-should-sort)
(defvar selectrum-should-sort-p)
(cl-defun amx-completing-read-selectrum (choices &key initial-input predicate def)
"Amx backend for selectrum completion."
(minibuffer-with-setup-hook
(lambda ()
(setq-local selectrum-should-sort nil)
(use-local-map (make-composed-keymap
(list amx-map (current-local-map)))))
;; FIXME: `selectrum-should-sort-p' should be removed after it can be
;; assumed all amx users updated also Selectrum.
(let ((selectrum-should-sort-p nil))
(selectrum-completing-read (amx-prompt-with-prefix-arg)
choices
predicate
t
initial-input
'extended-command-history
def))))
(amx-define-backend
:name 'selectrum
:comp-fun 'amx-completing-read-selectrum
:get-text-fun 'amx-default-get-text
:required-feature 'selectrum
:auto-activate '(bound-and-true-p selectrum-mode))
(defsubst amx-auto-select-backend ()
(cl-loop for (bname b) on amx-known-backends by 'cddr
;; Don't auto-select the auto backend, or the
;; default backend.
unless (memq bname '(auto standard))
;; Auto-select a backend if its auto-activate
;; condition evaluates to non-nil.
if (ignore-errors (eval (amx-backend-auto-activate b)))
return b
;; If no backend's auto-activate condition is
;; fulfilled, auto-select the standard backend.
finally return 'standard))
(cl-defun amx-completing-read-auto (choices &key initial-input predicate def)
"Automatically select the appropriate completion system for M-x.
This iterates through the `:auto-activate' declarations of each
backend until it finds one that evaluates to non-nil, and uses that
backend."
(let ((backend (amx-auto-select-backend)))
(amx--debug-message "Auto-selected backend `%s'"
(if (symbolp backend) backend
(amx-backend-name backend)))
(condition-case err
(amx-load-backend backend)
(error
(if (eq backend 'standard)
(error "Failed to use standard backend")
(display-warning
'amx
(format "Falling back to standard amx backend due to error loading %s backend: %S"
backend (cadr err)))
(setq backend 'standard))))
(amx-completing-read choices
:initial-input initial-input
:predicate predicate
:def def
:backend backend)))
(amx-define-backend
:name 'auto
:comp-fun 'amx-completing-read-auto
:get-text-fun (lambda () (error "This exit function should never be called"))
:exit-fun (lambda () (error "This get-text function should never be called")))
(defun amx-load-backend (backend)
"Load all required features for BACKEND."
(let* ((backend (amx-get-backend backend))
(feature (amx-backend-required-feature backend)))
(unless (listp feature)
(setq feature (list feature)))
(cl-loop for f in feature
unless (require f nil 'noerror)
do (error "Feature `%s' is required for backend `%s'"
f (amx-backend-name backend)))))
(defun amx-set-backend (symbol value)
"Custom setter for `amx-backend'.
Arguments are the same as in `set-default'.
This function will refuse to set the backend unless it can load
the associated feature, if any."
(cl-assert (eq symbol 'amx-backend))
(let* ((backend (or (plist-get amx-known-backends value)
(error "Unknown amx backend: %s" value))))
(amx-load-backend backend))
;; If we got through that, then actually set the variable
(set-default symbol value))
(defcustom amx-backend 'auto
"Completion backend used by amx.
This should be the name of backend defined using
`amx-define-backend', such as `ido' or `ivy', or the symbol
`auto' to have amx select a backend automatically."
:type '(choice
(const :tag "Auto-select" auto)
(const :tag "Ido" ido)
(const :tag "Ivy" ivy)
(const :tag "Helm" helm)
(const :tag "Selectrum" selectrum)
(const :tag "Standard" standard)
(symbol :tag "Custom backend"))
:set #'amx-set-backend)
;;--------------------------------------------------------------------------------
;; Cache and Maintenance
(defun amx-rebuild-cache ()
"Add newly defined commands to `amx-cache'."
(setq amx-cache nil)
;; Build up list 'new-commands' and later put it at the end of 'amx-cache'.
;; This speeds up sorting.
(let (new-commands)
(mapatoms (lambda (symbol)
(when (commandp symbol)
(let ((known-command (assq symbol amx-data)))
(if known-command
(setq amx-cache (cons known-command amx-cache))
(setq new-commands (cons (list symbol) new-commands)))))))
(if (eq (length amx-cache) 0)
(setq amx-cache new-commands)
(setcdr (last amx-cache) new-commands)))
(setq amx-cache (sort amx-cache 'amx-sorting-rules))
(amx-restore-history))
(defun amx-restore-history ()
"Rearrange `amx-cache' according to `amx-history'."
(if (> (length amx-history) amx-history-length)
(setcdr (nthcdr (- amx-history-length 1) amx-history) nil))
(mapc (lambda (command)
(unless (eq command (caar amx-cache))
(let ((command-cell-position (amx-detect-position
amx-cache
(lambda (cell)
(eq command (caar cell))))))
(when command-cell-position
(let ((command-cell (amx-remove-nth-cell
command-cell-position amx-cache)))
(setcdr command-cell amx-cache)
(setq amx-cache command-cell))))))
(reverse amx-history)))
(defun amx-sort-according-to-cache (list)
"Sort LIST of commands by their order in `amx-cache'."
(let (sorted)
(dolist (command-item amx-cache)
(let ((command (car command-item)))
(when (memq command list)
(setq sorted (cons command sorted))
(setq list (delq command list)))))
(nreverse (append list sorted))))
(defun amx-update ()
"Update the Amx cache with any newly-defined commands."
(interactive)
(amx--debug-message "Doing full update")
(amx-save-history)
(amx-rebuild-cache)
(setq amx-last-update-time (current-time))
(amx--debug-message "Finished full update"))
(defun amx-detect-new-commands ()
"Return non-nil if the number of defined commands has changed.
The return value is actually the new count of commands."
(let ((i 0))
(mapatoms (lambda (symbol) (if (commandp symbol) (setq i (1+ i)))))
(unless (= i amx-command-count)
(setq amx-command-count i))))
(defun amx-update-if-needed (&optional count-commands)
"Run `amx-update' if necessary.
If `amx-last-update-time' is nil, do an update unconditionally.
Otherwise, if optional arg COUNT-COMMANDS is non-nil, count the
total number of defined commands in `obarray' and update if it
has changed."
(if (or (null amx-last-update-time)
(and count-commands
(amx-detect-new-commands)))
(amx-update)
(amx--debug-message "No update needed at this time.")))
;;;###autoload
(defun amx-initialize (&optional reinit)
"Ensure that amx is properly initialized.
This function is normally idempotent, only having an effect the
first time it is called, so it is safe to call it at the
beginning of any function that expects amx to be initialized.
However, optional arg REINIT forces the initialization needs to
be re-run. Interactively, reinitialize when a prefix arg is
provided."
(interactive "P")
(when (or reinit (not amx-initialized))
(amx-load-save-file)
(amx-detect-new-commands)
(amx-rebuild-cache)
(add-hook 'kill-emacs-hook 'amx-save-to-file)
(setq amx-initialized t)))
(defsubst amx-buffer-not-empty-p ()
"Return non-nil if current buffer contains a non-space character."
(string-match-p "\[^[:space:]\]" (buffer-string)))
(defun amx-load-save-file ()
"Load `amx-history' and `amx-data' from `amx-save-file'.
In order to facilitate migrating from smex, if `amx-save-file'
does not exist, but smex is loaded and `smex-save-file' exists,
copy `smex-save-file' to `amx-save-file' and load it."
(setq amx-history nil amx-data nil)
(when amx-save-file
(let ((amx-save-file
(if (and (not (file-exists-p amx-save-file))
(bound-and-true-p smex-save-file)
(file-exists-p smex-save-file))
(prog1 smex-save-file
(message "Amx is loading your saved data from smex."))
amx-save-file)))
(let ((save-file (expand-file-name amx-save-file)))
(when (file-readable-p save-file)
(with-temp-buffer
(insert-file-contents save-file)
(condition-case nil
(setq amx-history (read (current-buffer))
amx-data (read (current-buffer)))
(error (if (amx-buffer-not-empty-p)
(error "Invalid data in amx-save-file (%s). Can't restore history"
amx-save-file)
(unless (boundp 'amx-history) (setq amx-history nil))
(unless (boundp 'amx-data) (setq amx-data nil)))))))))))
(defun amx-save-history ()
"Update `amx-history'."
(setq amx-history
(cl-loop
for i from 1 upto amx-history-length
for (command-name . count) in amx-cache
collect command-name)))
(defun amx-pp* (list list-name)
"Helper function for `amx-pp'."
(let ((print-level nil) (eval-expression-print-level nil)
(print-length nil) (eval-expression-print-length nil))
(insert "\n;; ----- " list-name " -----\n(\n ")
(while list
(let* ((elt (car list))
(s (if (consp elt) (car elt) elt)))
(if (and (stringp s) (= (length s) 0))
(setq s nil))
(if s
(prin1 elt (current-buffer)))
(if (and (setq list (cdr list)) s)
(insert "\n "))))
(insert "\n)\n")))
(defmacro amx-pp (list-var)
"A copy of `ido-pp' that's compatible with lexical bindings."
`(amx-pp* ,list-var ,(symbol-name list-var)))
(defun amx-save-to-file ()
"Save Amx history and cache to `amx-save-file' for future sessions."
(interactive)
(when amx-save-file
;; If `init-file-user' is nil, we are running under "emacs -Q", so
;; don't save anything to disk
(if init-file-user
(progn
(amx-save-history)
(with-temp-file (expand-file-name amx-save-file)
(amx-pp amx-history)
(amx-pp amx-data)))
(display-warning 'amx "Not saving amx state from \"emacs -Q\"."))))
;;--------------------------------------------------------------------------------
;; Ranking
(defun amx-sorting-rules (command-item other-command-item)
"Return non-nil if COMMAND-ITEM should sort before OTHER-COMMAND-ITEM."
(let* ((count (or (cdr command-item ) 0))
(other-count (or (cdr other-command-item) 0))
(name (car command-item))
(other-name (car other-command-item))
(length (length (symbol-name name)))
(other-length (length (symbol-name other-name))))
(or (> count other-count) ; 1. Frequency of use
(and (= count other-count)
(or (< length other-length) ; 2. Command length
(and (= length other-length)
(string< name other-name))))))) ; 3. Alphabetical order
(defun amx-rank (command)
"Update the recently-used ranking for COMMAND."
(let ((command-item (or (assq command amx-cache)
;; Update caches and try again if not found.
(progn (amx-update)
(assq command amx-cache)))))
(when command-item
(amx-update-counter command-item)
;; Don't touch the cache order if the chosen command
;; has just been execucted previously.
(unless (eq command-item (car amx-cache))
(let (command-cell
(pos (amx-detect-position amx-cache (lambda (cell)
(eq command-item (car cell))))))
;; Remove the just executed command.
(setq command-cell (amx-remove-nth-cell pos amx-cache))
;; And put it on top of the cache.
(setcdr command-cell amx-cache)
(setq amx-cache command-cell)
;; Now put the last history item back to its normal place.
(amx-sort-item-at amx-history-length))))))
(defun amx-update-counter (command-item)
"Update the run counter for COMMAND-ITEM.
If COMMAND-ITEM already has a counter, it is incremented by 1.
Otherwise, its counter is initilized to 1."
(let ((count (cdr command-item)))
(setcdr command-item
(if count
(1+ count)
;; Else: Command has just been executed for the first time.
;; Add it to `amx-data'.
(if amx-data
(setcdr (last amx-data) (list command-item))
(setq amx-data (list command-item)))
1))))
(defun amx-sort-item-at (n)
"Sort item at position N in `amx-cache'."
(let* ((command-cell (nthcdr n amx-cache))
(command-item (car command-cell)))
(let ((insert-at (amx-detect-position
command-cell
(lambda (cell)
(amx-sorting-rules command-item (car cell))))))