forked from abo-abo/hydra
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hydra.el
1571 lines (1421 loc) · 59.5 KB
/
hydra.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
;;; hydra.el --- Make bindings that stick around. -*- lexical-binding: t -*-
;; Copyright (C) 2015-2019 Free Software Foundation, Inc.
;; Author: Oleh Krehel <[email protected]>
;; Maintainer: Oleh Krehel <[email protected]>
;; URL: https://github.com/abo-abo/hydra
;; Version: 0.15.0
;; Keywords: bindings
;; Package-Requires: ((cl-lib "0.5") (lv "0"))
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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:
;;
;; This package can be used to tie related commands into a family of
;; short bindings with a common prefix - a Hydra.
;;
;; Once you summon the Hydra (through the prefixed binding), all the
;; heads can be called in succession with only a short extension.
;; The Hydra is vanquished once Hercules, any binding that isn't the
;; Hydra's head, arrives. Note that Hercules, besides vanquishing the
;; Hydra, will still serve his original purpose, calling his proper
;; command. This makes the Hydra very seamless, it's like a minor
;; mode that disables itself automagically.
;;
;; Here's an example Hydra, bound in the global map (you can use any
;; keymap in place of `global-map'):
;;
;; (defhydra hydra-zoom (global-map "<f2>")
;; "zoom"
;; ("g" text-scale-increase "in")
;; ("l" text-scale-decrease "out"))
;;
;; It allows to start a command chain either like this:
;; "<f2> gg4ll5g", or "<f2> lgllg".
;;
;; Here's another approach, when you just want a "callable keymap":
;;
;; (defhydra hydra-toggle (:color blue)
;; "toggle"
;; ("a" abbrev-mode "abbrev")
;; ("d" toggle-debug-on-error "debug")
;; ("f" auto-fill-mode "fill")
;; ("t" toggle-truncate-lines "truncate")
;; ("w" whitespace-mode "whitespace")
;; ("q" nil "cancel"))
;;
;; This binds nothing so far, but if you follow up with:
;;
;; (global-set-key (kbd "C-c C-v") 'hydra-toggle/body)
;;
;; you will have bound "C-c C-v a", "C-c C-v d" etc.
;;
;; Knowing that `defhydra' defines e.g. `hydra-toggle/body' command,
;; you can nest Hydras if you wish, with `hydra-toggle/body' possibly
;; becoming a blue head of another Hydra.
;;
;; If you want to learn all intricacies of using `defhydra' without
;; having to figure it all out from this source code, check out the
;; wiki: https://github.com/abo-abo/hydra/wiki. There's a wealth of
;; information there. Everyone is welcome to bring the existing pages
;; up to date and add new ones.
;;
;; Additionally, the file hydra-examples.el serves to demo most of the
;; functionality.
;;; Code:
;;* Requires
(require 'cl-lib)
(require 'lv)
(require 'ring)
(defvar hydra-curr-map nil
"The keymap of the current Hydra called.")
(defvar hydra-curr-on-exit nil
"The on-exit predicate for the current Hydra.")
(defvar hydra-curr-foreign-keys nil
"The current :foreign-keys behavior.")
(defvar hydra-curr-body-fn nil
"The current hydra-.../body function.")
(defvar hydra-deactivate nil
"If a Hydra head sets this to t, exit the Hydra.
This will be done even if the head wasn't designated for exiting.")
(defvar hydra-amaranth-warn-message "An amaranth Hydra can only exit through a blue head"
"Amaranth Warning message. Shown when the user tries to press an unbound/non-exit key while in an amaranth head.")
(defun hydra-set-transient-map (keymap on-exit &optional foreign-keys)
"Set KEYMAP to the highest priority.
Call ON-EXIT when the KEYMAP is deactivated.
FOREIGN-KEYS determines the deactivation behavior, when a command
that isn't in KEYMAP is called:
nil: deactivate KEYMAP and run the command.
run: keep KEYMAP and run the command.
warn: keep KEYMAP and issue a warning instead of running the command."
(if hydra-deactivate
(hydra-keyboard-quit)
(setq hydra-curr-map keymap)
(setq hydra-curr-on-exit on-exit)
(setq hydra-curr-foreign-keys foreign-keys)
(add-hook 'pre-command-hook 'hydra--clearfun)
(internal-push-keymap keymap 'overriding-terminal-local-map)))
(defun hydra--clearfun ()
"Disable the current Hydra unless `this-command' is a head."
(unless (eq this-command 'hydra-pause-resume)
(when (or
(memq this-command '(handle-switch-frame
keyboard-quit))
(null overriding-terminal-local-map)
(not (or (eq this-command
(lookup-key hydra-curr-map (this-single-command-keys)))
(cl-case hydra-curr-foreign-keys
(warn
(setq this-command 'hydra-amaranth-warn))
(run
t)
(t nil)))))
(hydra-disable))))
(defvar hydra--ignore nil
"When non-nil, don't call `hydra-curr-on-exit'.")
(defvar hydra--input-method-function nil
"Store overridden `input-method-function' here.")
(defun hydra-disable ()
"Disable the current Hydra."
(setq hydra-deactivate nil)
(remove-hook 'pre-command-hook 'hydra--clearfun)
(unless hydra--ignore
(if (fboundp 'remove-function)
(remove-function input-method-function #'hydra--imf)
(when hydra--input-method-function
(setq input-method-function hydra--input-method-function)
(setq hydra--input-method-function nil))))
(dolist (frame (frame-list))
(with-selected-frame frame
(when overriding-terminal-local-map
(internal-pop-keymap hydra-curr-map 'overriding-terminal-local-map))))
(setq hydra-curr-map nil)
(unless hydra--ignore
(when hydra-curr-on-exit
(let ((on-exit hydra-curr-on-exit))
(setq hydra-curr-on-exit nil)
(funcall on-exit)))))
(unless (fboundp 'internal-push-keymap)
(defun internal-push-keymap (keymap symbol)
(let ((map (symbol-value symbol)))
(unless (memq keymap map)
(unless (memq 'add-keymap-witness (symbol-value symbol))
(setq map (make-composed-keymap nil (symbol-value symbol)))
(push 'add-keymap-witness (cdr map))
(set symbol map))
(push keymap (cdr map))))))
(unless (fboundp 'internal-pop-keymap)
(defun internal-pop-keymap (keymap symbol)
(let ((map (symbol-value symbol)))
(when (memq keymap map)
(setf (cdr map) (delq keymap (cdr map))))
(let ((tail (cddr map)))
(and (or (null tail) (keymapp tail))
(eq 'add-keymap-witness (nth 1 map))
(set symbol tail))))))
(defun hydra-amaranth-warn ()
"Issue a warning that the current input was ignored."
(interactive)
(message hydra-amaranth-warn-message))
;;* Customize
(defgroup hydra nil
"Make bindings that stick around."
:group 'bindings
:prefix "hydra-")
(defcustom hydra-is-helpful t
"When t, display a hint with possible bindings in the echo area."
:type 'boolean
:group 'hydra)
(defcustom hydra-default-hint ""
"Default :hint property to use for heads when not specified in
the body or the head."
:type 'sexp
:group 'hydra)
(declare-function posframe-show "posframe")
(declare-function posframe-hide "posframe")
(declare-function posframe-poshandler-window-center "posframe")
(defvar hydra-posframe-show-params
'(:internal-border-width 1
:internal-border-color "red"
:poshandler posframe-poshandler-window-center)
"List of parameters passed to `posframe-show'.")
(defvar hydra--posframe-timer nil
"Timer for hiding posframe hint.")
(defun hydra-posframe-show (str)
(require 'posframe)
(when hydra--posframe-timer
(cancel-timer hydra--posframe-timer))
(setq hydra--posframe-timer nil)
(apply #'posframe-show
" *hydra-posframe*"
:string str
hydra-posframe-show-params))
(defun hydra-posframe-hide ()
(require 'posframe)
(unless hydra--posframe-timer
(setq hydra--posframe-timer
(run-with-idle-timer
0 nil (lambda ()
(setq hydra--posframe-timer nil)
(posframe-hide " *hydra-posframe*"))))))
(defvar hydra-hint-display-alist
(list (list 'lv #'lv-message #'lv-delete-window)
(list 'message (lambda (str) (message "%s" str)) (lambda () (message "")))
(list 'posframe #'hydra-posframe-show #'hydra-posframe-hide))
"Store the functions for `hydra-hint-display-type'.")
(defcustom hydra-hint-display-type 'lv
"The utility to show hydra hint"
:type '(choice
(const message)
(const lv)
(const posframe))
:group 'hydra)
(defcustom hydra-verbose nil
"When non-nil, hydra will issue some non essential style warnings."
:type 'boolean)
(defcustom hydra-key-format-spec "%s"
"Default `format'-style specifier for _a_ syntax in docstrings.
When nil, you can specify your own at each location like this: _ 5a_."
:type 'string)
(defcustom hydra-doc-format-spec "%s"
"Default `format'-style specifier for ?a? syntax in docstrings."
:type 'string)
(defcustom hydra-look-for-remap nil
"When non-nil, hydra binding behaves as keymap binding with [remap].
When calling a head with a simple command, hydra will lookup for a potential
remap command according to the current active keymap and call it instead if
found"
:type 'boolean)
(make-obsolete-variable
'hydra-key-format-spec
"Since the docstrings are aligned by hand anyway, this isn't very useful."
"0.13.1")
(defface hydra-face-red
'((t (:foreground "#FF0000" :bold t)))
"Red Hydra heads don't exit the Hydra.
Every other command exits the Hydra."
:group 'hydra)
(defface hydra-face-blue
'((((class color) (background light))
:foreground "#0000FF" :bold t)
(((class color) (background dark))
:foreground "#8ac6f2" :bold t))
"Blue Hydra heads exit the Hydra.
Every other command exits as well.")
(defface hydra-face-amaranth
'((t (:foreground "#E52B50" :bold t)))
"Amaranth body has red heads and warns on intercepting non-heads.
Exitable only through a blue head.")
(defface hydra-face-pink
'((t (:foreground "#FF6EB4" :bold t)))
"Pink body has red heads and runs intercepted non-heads.
Exitable only through a blue head.")
(defface hydra-face-teal
'((t (:foreground "#367588" :bold t)))
"Teal body has blue heads and warns on intercepting non-heads.
Exitable only through a blue head.")
;;* Fontification
(defun hydra-add-font-lock ()
"Fontify `defhydra' statements."
(font-lock-add-keywords
'emacs-lisp-mode
'(("(\\(defhydra\\)\\_> +\\(.*?\\)\\_>"
(1 font-lock-keyword-face)
(2 font-lock-type-face))
("(\\(defhydradio\\)\\_> +\\(.*?\\)\\_>"
(1 font-lock-keyword-face)
(2 font-lock-type-face)))))
;;* Imenu
(defun hydra-add-imenu ()
"Add this to `emacs-lisp-mode-hook' to have hydras in `imenu'."
(add-to-list
'imenu-generic-expression
'("Hydras"
"^.*(\\(defhydra\\) \\([a-zA-Z-]+\\)"
2)))
;;* Find Function
(eval-after-load 'find-func
'(defadvice find-function-search-for-symbol
(around hydra-around-find-function-search-for-symbol-advice
(symbol type library) activate)
"Navigate to hydras with `find-function-search-for-symbol'."
(prog1 ad-do-it
(when (symbolp symbol)
;; The original function returns (cons (current-buffer) (point))
;; if it found the point.
(unless (cdr ad-return-value)
(with-current-buffer (find-file-noselect library)
(let ((sn (symbol-name symbol)))
(when (and (null type)
(string-match "\\`\\(hydra-[a-z-A-Z0-9]+\\)/\\(.*\\)\\'" sn)
(re-search-forward (concat "(defhydra " (match-string 1 sn))
nil t))
(goto-char (match-beginning 0)))
(cons (current-buffer) (point)))))))))
;;* Universal Argument
(defvar hydra-base-map
(let ((map (make-sparse-keymap)))
(define-key map [?\C-u] 'hydra--universal-argument)
(define-key map [?-] 'hydra--negative-argument)
(define-key map [?0] 'hydra--digit-argument)
(define-key map [?1] 'hydra--digit-argument)
(define-key map [?2] 'hydra--digit-argument)
(define-key map [?3] 'hydra--digit-argument)
(define-key map [?4] 'hydra--digit-argument)
(define-key map [?5] 'hydra--digit-argument)
(define-key map [?6] 'hydra--digit-argument)
(define-key map [?7] 'hydra--digit-argument)
(define-key map [?8] 'hydra--digit-argument)
(define-key map [?9] 'hydra--digit-argument)
(define-key map [kp-0] 'hydra--digit-argument)
(define-key map [kp-1] 'hydra--digit-argument)
(define-key map [kp-2] 'hydra--digit-argument)
(define-key map [kp-3] 'hydra--digit-argument)
(define-key map [kp-4] 'hydra--digit-argument)
(define-key map [kp-5] 'hydra--digit-argument)
(define-key map [kp-6] 'hydra--digit-argument)
(define-key map [kp-7] 'hydra--digit-argument)
(define-key map [kp-8] 'hydra--digit-argument)
(define-key map [kp-9] 'hydra--digit-argument)
(define-key map [kp-subtract] 'hydra--negative-argument)
map)
"Keymap that all Hydras inherit. See `universal-argument-map'.")
(defun hydra--universal-argument (arg)
"Forward to (`universal-argument' ARG)."
(interactive "P")
(setq prefix-arg (if (consp arg)
(list (* 4 (car arg)))
(if (eq arg '-)
(list -4)
'(4)))))
(defun hydra--digit-argument (arg)
"Forward to (`digit-argument' ARG)."
(interactive "P")
(let* ((char (if (integerp last-command-event)
last-command-event
(get last-command-event 'ascii-character)))
(digit (- (logand char ?\177) ?0)))
(setq prefix-arg (cond ((integerp arg)
(+ (* arg 10)
(if (< arg 0)
(- digit)
digit)))
((eq arg '-)
(if (zerop digit)
'-
(- digit)))
(t
digit)))))
(defun hydra--negative-argument (arg)
"Forward to (`negative-argument' ARG)."
(interactive "P")
(setq prefix-arg (cond ((integerp arg) (- arg))
((eq arg '-) nil)
(t '-))))
;;* Repeat
(defvar hydra-repeat--prefix-arg nil
"Prefix arg to use with `hydra-repeat'.")
(defvar hydra-repeat--command nil
"Command to use with `hydra-repeat'.")
(defun hydra-repeat (&optional arg)
"Repeat last command with last prefix arg.
When ARG is non-nil, use that instead."
(interactive "p")
(if (eq arg 1)
(unless (string-match "hydra-repeat$" (symbol-name last-command))
(setq hydra-repeat--command last-command)
(setq hydra-repeat--prefix-arg last-prefix-arg))
(setq hydra-repeat--prefix-arg arg))
(setq current-prefix-arg hydra-repeat--prefix-arg)
(funcall hydra-repeat--command))
;;* Misc internals
(defun hydra--callablep (x)
"Test if X is callable."
(or (functionp x)
(and (consp x)
(memq (car x) '(function quote)))))
(defun hydra--make-callable (x)
"Generate a callable symbol from X.
If X is a function symbol or a lambda, return it. Otherwise, it
should be a single statement. Wrap it in an interactive lambda."
(cond ((or (symbolp x) (functionp x))
x)
((and (consp x) (eq (car x) 'function))
(cadr x))
(t
`(lambda ()
(interactive)
,x))))
(defun hydra-plist-get-default (plist prop default)
"Extract a value from a property list.
PLIST is a property list, which is a list of the form
\(PROP1 VALUE1 PROP2 VALUE2...).
Return the value corresponding to PROP, or DEFAULT if PROP is not
one of the properties on the list."
(if (memq prop plist)
(plist-get plist prop)
default))
(defun hydra--head-property (h prop &optional default)
"Return for Hydra head H the value of property PROP.
Return DEFAULT if PROP is not in H."
(hydra-plist-get-default (cl-cdddr h) prop default))
(defun hydra--head-set-property (h prop value)
"In hydra Head H, set a property PROP to the value VALUE."
(cons (car h) (plist-put (cdr h) prop value)))
(defun hydra--head-has-property (h prop)
"Return non nil if heads H has the property PROP."
(plist-member (cdr h) prop))
(defun hydra--body-foreign-keys (body)
"Return what BODY does with a non-head binding."
(or
(plist-get (cddr body) :foreign-keys)
(let ((color (plist-get (cddr body) :color)))
(cl-case color
((amaranth teal) 'warn)
(pink 'run)))))
(defun hydra--body-exit (body)
"Return the exit behavior of BODY."
(or
(plist-get (cddr body) :exit)
(let ((color (plist-get (cddr body) :color)))
(cl-case color
((blue teal) t)
(t nil)))))
(defun hydra--normalize-body (body)
"Put BODY in a normalized format.
Add :exit and :foreign-keys if they are not there.
Remove :color key. And sort the plist alphabetically."
(let ((plist (cddr body)))
(plist-put plist :exit (hydra--body-exit body))
(plist-put plist :foreign-keys (hydra--body-foreign-keys body))
(let* ((alist0 (cl-loop for (k v) on plist
by #'cddr collect (cons k v)))
(alist1 (assq-delete-all :color alist0))
(alist2 (cl-sort alist1 #'string<
:key (lambda (x) (symbol-name (car x))))))
(append (list (car body) (cadr body))
(cl-mapcan (lambda (x) (list (car x) (cdr x))) alist2)))))
(defalias 'hydra--imf #'list)
(defun hydra-default-pre ()
"Default setup that happens in each head before :pre."
(when (eq input-method-function 'key-chord-input-method)
(if (fboundp 'add-function)
(add-function :override input-method-function #'hydra--imf)
(unless hydra--input-method-function
(setq hydra--input-method-function input-method-function)
(setq input-method-function nil)))))
(defvar hydra-timeout-timer (timer-create)
"Timer for `hydra-timeout'.")
(defvar hydra-message-timer (timer-create)
"Timer for the hint.")
(defvar hydra--work-around-dedicated t
"When non-nil, assume there's no bug in `pop-to-buffer'.
`pop-to-buffer' should not select a dedicated window.")
(defun hydra-keyboard-quit ()
"Quitting function similar to `keyboard-quit'."
(interactive)
(hydra-disable)
(cancel-timer hydra-timeout-timer)
(cancel-timer hydra-message-timer)
(unless (and hydra--ignore
(null hydra--work-around-dedicated))
(funcall
(nth 2 (assoc hydra-hint-display-type hydra-hint-display-alist))))
nil)
(defvar hydra-head-format "[%s]: "
"The formatter for each head of a plain docstring.")
(defvar hydra-key-doc-function 'hydra-key-doc-function-default
"The function for formatting key-doc pairs.")
(defun hydra-key-doc-function-default (key key-width doc doc-width)
(cond
((equal key " ") (format (format "%%-%ds" (+ 3 key-width doc-width)) doc))
((listp doc)
`(format ,(format "%%%ds: %%%ds" key-width (- -1 doc-width)) ,key ,doc))
(t (format (format "%%%ds: %%%ds" key-width (- -1 doc-width)) key doc))))
(defun hydra--to-string (x)
(if (stringp x)
x
(eval x)))
(defun hydra--eval-and-format (x)
(let ((str (hydra--to-string (cdr x))))
(format
(if (> (length str) 0)
(concat hydra-head-format str)
"%s")
(car x))))
(defun hydra--hint-heads-wocol (body heads)
"Generate a hint for the echo area.
BODY, and HEADS are parameters to `defhydra'.
Works for heads without a property :column."
(let (alist)
(dolist (h heads)
(let ((val (assoc (cadr h) alist))
(pstr (hydra-fontify-head h body)))
(if val
(setf (cadr val)
(concat (cadr val) " " pstr))
(push
(cons (cadr h)
(cons pstr (cl-caddr h)))
alist))))
(let ((keys (nreverse (mapcar #'cdr alist)))
(n-cols (plist-get (cddr body) :columns))
res)
(setq res
(if n-cols
(let ((n-rows (1+ (/ (length keys) n-cols)))
(max-key-len (apply #'max (mapcar (lambda (x) (length (car x))) keys)))
(max-doc-len (apply #'max (mapcar (lambda (x)
(length (hydra--to-string (cdr x)))) keys))))
`(concat
"\n"
(mapconcat #'identity
(mapcar
(lambda (x)
(mapconcat
(lambda (y)
(and y
(funcall hydra-key-doc-function
(car y)
,max-key-len
(hydra--to-string (cdr y))
,max-doc-len))) x ""))
',(hydra--matrix keys n-cols n-rows))
"\n")))
`(concat
(mapconcat
#'hydra--eval-and-format
',keys
", ")
,(if keys "." ""))))
(if (cl-every #'stringp
(mapcar 'cddr alist))
(eval res)
res))))
(defun hydra--hint (body heads)
"Generate a hint for the echo area.
BODY, and HEADS are parameters to `defhydra'."
(let* ((sorted-heads (hydra--sort-heads (hydra--normalize-heads heads)))
(heads-w-col (cl-remove-if-not (lambda (heads) (hydra--head-property (nth 0 heads) :column)) sorted-heads))
(heads-wo-col (cl-remove-if (lambda (heads) (hydra--head-property (nth 0 heads) :column)) sorted-heads))
(hint-w-col (when heads-w-col
(hydra--hint-from-matrix body (hydra--generate-matrix heads-w-col))))
(hint-wo-col (when heads-wo-col
(hydra--hint-heads-wocol body (car heads-wo-col)))))
(if (null hint-w-col)
hint-wo-col
(if (stringp hint-wo-col)
`(concat ,@hint-w-col ,hint-wo-col)
`(concat ,@hint-w-col ,@(cdr hint-wo-col))))))
(defvar hydra-fontify-head-function nil
"Possible replacement for `hydra-fontify-head-default'.")
(defun hydra-fontify-head-default (head body)
"Produce a pretty string from HEAD and BODY.
HEAD's binding is returned as a string with a colored face."
(let* ((foreign-keys (hydra--body-foreign-keys body))
(head-exit (hydra--head-property head :exit))
(head-color
(if head-exit
(if (eq foreign-keys 'warn)
'teal
'blue)
(cl-case foreign-keys
(warn 'amaranth)
(run 'pink)
(t 'red)))))
(when (and (null (cadr head))
(not head-exit))
(hydra--complain "nil cmd can only be blue"))
(propertize
(replace-regexp-in-string "%" "%%" (car head))
'face
(or (hydra--head-property head :face)
(cl-case head-color
(blue 'hydra-face-blue)
(red 'hydra-face-red)
(amaranth 'hydra-face-amaranth)
(pink 'hydra-face-pink)
(teal 'hydra-face-teal)
(t (error "Unknown color for %S" head)))))))
(defun hydra-fontify-head-greyscale (head _body)
"Produce a pretty string from HEAD and BODY.
HEAD's binding is returned as a string wrapped with [] or {}."
(format
(if (hydra--head-property head :exit)
"[%s]"
"{%s}") (car head)))
(defun hydra-fontify-head (head body)
"Produce a pretty string from HEAD and BODY."
(funcall (or hydra-fontify-head-function 'hydra-fontify-head-default)
head body))
(defun hydra--strip-align-markers (str)
"Remove ^ from STR, unless they're escaped: \\^."
(let ((start 0))
(while (setq start (string-match "\\\\?\\^" str start))
(if (eq (- (match-end 0) (match-beginning 0)) 2)
(progn
(setq str (replace-match "^" nil nil str))
(cl-incf start))
(setq str (replace-match "" nil nil str))))
str))
(defvar hydra-docstring-keys-translate-alist
'(("↑" . "<up>")
("↓" . "<down>")
("→" . "<right>")
("←" . "<left>")
("⌫" . "DEL")
("⌦" . "<deletechar>")
("⏎" . "RET")))
(defconst hydra-width-spec-regex " ?-?[0-9]*?"
"Regex for the width spec in keys and %` quoted sexps.")
(defvar hydra-key-regex "[][\\[:alnum:] ~.,;:/|?<>={}*+#%@!&^↑↓←→⌫⌦⏎'`()\"$-]+?"
"Regex for the key quoted in the docstring.")
(defun hydra--format (_name body docstring heads)
"Generate a `format' statement from STR.
\"%`...\" expressions are extracted into \"%S\".
_NAME, BODY, DOCSTRING and HEADS are parameters of `defhydra'.
The expressions can be auto-expanded according to NAME."
(unless (memq 'elisp--witness--lisp (mapcar #'cadr heads))
(setq docstring (hydra--strip-align-markers docstring))
(setq docstring (replace-regexp-in-string "___" "_β_" docstring))
(let ((rest (if (eq (plist-get (cddr body) :hint) 'none)
""
(hydra--hint body heads)))
(start 0)
(inner-regex (format "\\(%s\\)\\(%s\\)" hydra-width-spec-regex hydra-key-regex))
varlist
offset)
(while (setq start
(string-match
(format
"\\(?:%%\\( ?-?[0-9]*s?\\)\\(`[a-z-A-Z/0-9]+\\|(\\)\\)\\|\\(?:_%s_\\)\\|\\(?:[?]%s[?]\\)\\|__"
inner-regex
inner-regex)
docstring start))
(cond ((string= "__" (match-string 0 docstring))
(setq docstring (replace-match "_" nil t docstring))
(setq start (1- (match-end 0))))
((eq ?? (aref (match-string 0 docstring) 0))
(let* ((key (match-string 6 docstring))
(head (assoc key heads)))
(if head
(progn
(push (nth 2 head) varlist)
(setq docstring
(replace-match
(or
hydra-doc-format-spec
(concat "%" (match-string 3 docstring) "s"))
t nil docstring)))
(setq start (match-end 0))
(warn "Unrecognized key: ?%s?" key))))
((eq ?_ (aref (match-string 0 docstring) 0))
(let* ((key (match-string 4 docstring))
(key (if (equal key "β") "_" key))
normal-key
(head (or (assoc key heads)
(when (setq normal-key
(cdr (assoc
key hydra-docstring-keys-translate-alist)))
(assoc normal-key heads)))))
(if head
(progn
(push (hydra-fontify-head (if normal-key
(cons key (cdr head))
head)
body)
varlist)
(let ((replacement
(or
hydra-key-format-spec
(concat "%" (match-string 3 docstring) "s"))))
(setq docstring
(replace-match replacement t nil docstring))
(setq start (+ start (length replacement)))))
(setq start (match-end 0))
(warn "Unrecognized key: _%s_" key))))
(t
(let* ((varp (if (eq ?` (aref (match-string 2 docstring) 0)) 1 0))
(spec (match-string 1 docstring))
(lspec (length spec)))
(setq offset
(with-temp-buffer
(insert (substring docstring (+ 1 start varp
(length spec))))
(goto-char (point-min))
(push (read (current-buffer)) varlist)
(- (point) (point-min))))
(when (or (zerop lspec)
(/= (aref spec (1- (length spec))) ?s))
(setq spec (concat spec "S")))
(setq docstring
(concat
(substring docstring 0 start)
"%" spec
(substring docstring (+ start offset 1 lspec varp))))))))
(hydra--format-1 docstring rest varlist))))
(defun hydra--format-1 (docstring rest varlist)
(cond
((string= docstring "")
rest)
((listp rest)
(unless (string-match-p "[:\n]" docstring)
(setq docstring (concat docstring ":\n")))
(unless (or (string-match-p "\n\\'" docstring)
(equal (cadr rest) "\n"))
(setq docstring (concat docstring "\n")))
`(concat (format ,(replace-regexp-in-string "\\`\n" "" docstring) ,@(nreverse varlist))
,@(cdr rest)))
((eq ?\n (aref docstring 0))
`(format ,(concat (substring docstring 1) rest) ,@(nreverse varlist)))
(t
(let ((r `(replace-regexp-in-string
" +$" ""
(concat ,docstring
,(cond ((string-match-p "\\`\n" rest)
":")
((string-match-p "\n" rest)
":\n")
(t
": "))
(replace-regexp-in-string
"\\(%\\)" "\\1\\1" ,rest)))))
(if (stringp rest)
`(format ,(eval r))
`(format ,r))))))
(defun hydra--complain (format-string &rest args)
"Forward to (`message' FORMAT-STRING ARGS) unless `hydra-verbose' is nil."
(if hydra-verbose
(apply #'error format-string args)
(apply #'message format-string args)))
(defun hydra--doc (body-key body-name heads)
"Generate a part of Hydra docstring.
BODY-KEY is the body key binding.
BODY-NAME is the symbol that identifies the Hydra.
HEADS is a list of heads."
(format
"The heads for the associated hydra are:\n\n%s\n\n%s%s."
(mapconcat
(lambda (x)
(format "\"%s\": `%S'" (car x) (cadr x)))
heads ",\n")
(format "The body can be accessed via `%S'" body-name)
(if body-key
(format ", which is bound to \"%s\"" body-key)
"")))
(defun hydra--call-interactively-remap-maybe (cmd)
"`call-interactively' the given CMD or its remapped equivalent.
Only when `hydra-look-for-remap' is non nil."
(let ((remapped-cmd (if hydra-look-for-remap
(command-remapping `,cmd)
nil)))
(if remapped-cmd
(call-interactively `,remapped-cmd)
(call-interactively `,cmd))))
(defun hydra--call-interactively (cmd name)
"Generate a `call-interactively' statement for CMD.
Set `this-command' to NAME."
(if (and (symbolp name)
(not (memq name '(nil body))))
`(progn
(setq this-command ',name)
(hydra--call-interactively-remap-maybe #',cmd))
`(hydra--call-interactively-remap-maybe #',cmd)))
(defun hydra--make-defun (name body doc head
keymap body-pre body-before-exit
&optional body-after-exit)
"Make a defun wrapper, using NAME, BODY, DOC, HEAD, and KEYMAP.
NAME and BODY are the arguments to `defhydra'.
DOC was generated with `hydra--doc'.
HEAD is one of the HEADS passed to `defhydra'.
BODY-PRE is added to the start of the wrapper.
BODY-BEFORE-EXIT will be called before the hydra quits.
BODY-AFTER-EXIT is added to the end of the wrapper."
(let* ((cmd-name (hydra--head-name head name))
(cmd (when (car head)
(hydra--make-callable
(cadr head))))
(doc (if (car head)
(format "Call the head `%S' in the \"%s\" hydra.\n\n%s"
(cadr head) name doc)
(format "Call the body in the \"%s\" hydra.\n\n%s"
name doc)))
(hint (intern (format "%S/hint" name)))
(body-foreign-keys (hydra--body-foreign-keys body))
(body-timeout (plist-get body :timeout))
(idle (or (and (eq (cadr head) 'body) (plist-get body :idle))
(plist-get (nthcdr 3 head) :idle)))
(curr-body-fn-sym (intern (format "%S/body" name)))
(body-on-exit-t
`((hydra-keyboard-quit)
(setq hydra-curr-body-fn ',curr-body-fn-sym)
,@(if body-after-exit
`((unwind-protect
,(when cmd
(hydra--call-interactively cmd (cadr head)))
,body-after-exit))
(when cmd
`(,(hydra--call-interactively cmd (cadr head)))))))
(body-on-exit-nil
(delq
nil
`((let ((hydra--ignore ,(not (eq (cadr head) 'body))))
(hydra-keyboard-quit)
(setq hydra-curr-body-fn ',curr-body-fn-sym))
,(when cmd
`(condition-case err
,(hydra--call-interactively cmd (cadr head))
((quit error)
(message (error-message-string err)))))
,(if idle
`(hydra-idle-message ,idle ,hint ',name)
`(hydra-show-hint ,hint ',name))
(hydra-set-transient-map
,keymap
(lambda () (hydra-keyboard-quit) ,body-before-exit)
,(when body-foreign-keys
(list 'quote body-foreign-keys)))
,body-after-exit
,(when body-timeout
`(hydra-timeout ,body-timeout))))))
`(defun ,cmd-name ()
,doc
(interactive)
(require 'hydra)
(hydra-default-pre)
,@(when body-pre (list body-pre))
,@(cond ((eq (hydra--head-property head :exit) t)
body-on-exit-t)
((eq (hydra--head-property head :exit) nil)
body-on-exit-nil)
(t
`((if ,(hydra--head-property head :exit)
(progn
,@body-on-exit-t)
,@body-on-exit-nil)))))))
(defvar hydra-props-alist nil)
(defun hydra-set-property (name key val)
"Set hydra property.
NAME is the symbolic name of the hydra.
KEY and VAL are forwarded to `plist-put'."
(let ((entry (assoc name hydra-props-alist))
plist)
(when (null entry)
(add-to-list 'hydra-props-alist (list name))
(setq entry (assoc name hydra-props-alist)))
(setq plist (cdr entry))
(setcdr entry (plist-put plist key val))))
(defun hydra-get-property (name key)
"Get hydra property.
NAME is the symbolic name of the hydra.
KEY is forwarded to `plist-get'."
(let ((entry (assoc name hydra-props-alist)))
(when entry
(plist-get (cdr entry) key))))
(defun hydra-show-hint (hint caller)
(let ((verbosity (plist-get (cdr (assoc caller hydra-props-alist))
:verbosity)))
(cond ((eq verbosity 0))
((eq verbosity 1)
(message (eval hint)))
(t
(when hydra-is-helpful
(funcall
(nth 1 (assoc hydra-hint-display-type hydra-hint-display-alist))
(eval hint)))))))
(defmacro hydra--make-funcall (sym)
"Transform SYM into a `funcall' to call it."
`(when (and ,sym (symbolp ,sym))
(setq ,sym `(funcall #',,sym))))
(defun hydra--head-name (h name)
"Return the symbol for head H of hydra with NAME."
(let ((str (format "%S/%s" name
(cond ((symbolp (cadr h))
(cadr h))
((and (consp (cadr h))
(eq (cl-caadr h) 'function))
(cadr (cadr h)))
(t
(concat "lambda-" (car h)))))))
(when (and (hydra--head-property h :exit)
(not (memq (cadr h) '(body nil))))
(setq str (concat str "-and-exit")))
(intern str)))
(defun hydra--delete-duplicates (heads)
"Return HEADS without entries that have the same CMD part.
In duplicate HEADS, :cmd-name is modified to whatever they duplicate."
(let ((ali '(((hydra-repeat . nil) . hydra-repeat)))
res entry)
(dolist (h heads)