mirrored from git://git.sv.gnu.org/emacs.git
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
kmacro.el
2038 lines (1762 loc) · 73.8 KB
/
kmacro.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
;;; kmacro.el --- enhanced keyboard macros -*- lexical-binding: t -*-
;; Copyright (C) 2002-2024 Free Software Foundation, Inc.
;; Author: Kim F. Storm <storm@cua.dk>
;; Keywords: keyboard convenience
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;; The kmacro package provides the user interface to Emacs's basic
;; keyboard macro functionality. With kmacro, two function keys are
;; dedicated to keyboard macros, by default F3 and F4.
;; Note: The traditional bindings C-x (, C-x ), and C-x e are still
;; supported, but for some users these bindings are too hard to type
;; to be really useful for doing small repeated tasks.
;; To start defining a keyboard macro, use F3. To end the macro,
;; use F4, and to call the macro also use F4. This makes it very
;; easy to repeat a macro immediately after defining it.
;;
;; You can call the macro repeatedly by pressing F4 multiple times, or
;; you can give a numeric prefix argument specifying the number of
;; times to repeat the macro. Macro execution automatically
;; terminates when point reaches the end of the buffer or if an error
;; is signaled by ringing the bell.
;; When you define a macro with F3/F4, it is automatically added to
;; the head of the "keyboard macro ring", and F4 actually executes the
;; first element of the macro ring.
;;
;; Note: an empty macro is never added to the macro ring.
;;
;; You can execute the second element on the macro ring with C-u F4 or
;; C-x C-k C-l, you can use C-x C-k C-p and C-x C-k C-n to cycle
;; through the macro ring, and you can swap the first and second
;; elements with C-x C-k C-t. To delete the first element in the
;; macro ring, use C-x C-k C-d.
;;
;; You can also use C-x C-k C-s to start a macro, and C-x C-k C-k to
;; end it; then use C-k to execute it immediately, or C-x C-k C-k to
;; execute it later.
;;
;; In general, immediately after using C-x C-k followed by one of C-k,
;; C-l, C-p, or C-n, you can further cycle the macro ring using C-p or
;; C-n, execute the first or second macro using C-k or C-l, delete
;; the head macro with C-d, or edit the current macro with C-e without
;; repeating the C-x C-k prefix.
;; If you enter F3 while defining the macro, the numeric value of
;; `kmacro-counter' is inserted using the `kmacro-counter-format', and
;; `kmacro-counter' is incremented by 1 (or the numeric prefix value
;; of F3).
;;
;; The initial value of `kmacro-counter' is 0, or the numeric prefix
;; value given to F3 when starting the macro.
;;
;; Now, each time you call the macro using F4, the current
;; value of `kmacro-counter' is inserted and incremented, making it
;; easy to insert incremental numbers in the buffer.
;;
;; Example:
;;
;; The following sequence: M-5 F3 x M-2 F3 y F4 F4 F4 F4
;; inserts the following string: x5yx7yx9yx11y
;; A macro can also be called using a mouse click, default S-mouse-3.
;; This calls the macro at the point where you click the mouse.
;; You can edit the last macro using C-x C-k C-e.
;; You can append to the last macro using C-u F3.
;; You can set the macro counter using C-x C-k C-c, add to it using C-x C-k C-a,
;; and you can set the macro counter format with C-x C-k C-f.
;; The following key bindings are performed:
;;
;; Normal While defining macro
;; --------------------------- ------------------------------
;; f3 Define macro Insert current counter value
;; Prefix arg specifies initial and increase counter by prefix
;; counter value (default 0) (default increment: 1)
;;
;; C-u f3 APPENDs to last macro
;;
;; f4 Call last macro End macro
;; Prefix arg specifies number
;; of times to execute macro.
;;
;; C-u f4 Swap last and head of macro ring.
;;
;; S-mouse-3 Set point at click and End macro and execute macro at
;; execute last macro. click.
;;; Code:
;; Customization:
(require 'replace)
(require 'cl-lib)
(defgroup kmacro nil
"Simplified keyboard macro user interface."
:group 'keyboard
:group 'convenience
:version "22.1"
:link '(emacs-commentary-link :tag "Commentary" "kmacro.el")
:link '(emacs-library-link :tag "Lisp File" "kmacro.el"))
(defcustom kmacro-call-mouse-event 'S-mouse-3
"The mouse event used by kmacro to call a macro.
Set to nil if no mouse binding is desired."
:type 'symbol)
(defcustom kmacro-ring-max 8
"Maximum number of keyboard macros to save in macro ring."
:type 'natnum)
(defcustom kmacro-execute-before-append t
"Controls whether appending to a macro starts by executing the macro.
If non-nil, using a single \\[universal-argument] prefix executes the macro
before appending, while more than one \\[universal-argument] prefix does not
execute the macro.
Otherwise, a single \\[universal-argument] prefix does not execute the
macro, while more than one \\[universal-argument] prefix causes the
macro to be executed before appending to it."
:type 'boolean)
(defcustom kmacro-repeat-no-prefix t
"Allow repeating certain macro commands without entering the \\[kmacro-keymap] prefix."
:type 'boolean)
(defcustom kmacro-call-repeat-key t
"Allow repeating macro call using last key or a specific key."
:type '(choice (const :tag "Disabled" nil)
(const :tag "Last key" t)
(character :tag "Character" :value ?e)
(symbol :tag "Key symbol" :value RET)))
(defcustom kmacro-call-repeat-with-arg nil
"Repeat macro call with original arg when non-nil; repeat once if nil."
:type 'boolean)
(defcustom kmacro-step-edit-mini-window-height 0.75
"Override `max-mini-window-height' when step edit keyboard macro."
:type 'number)
;; Keymap
(defvar-keymap kmacro-keymap
:doc "Keymap for keyboard macro commands."
;; Start, end, execute macros
"s" #'kmacro-start-macro
"C-s" #'kmacro-start-macro
"C-k" #'kmacro-end-or-call-macro-repeat
"r" #'apply-macro-to-region-lines
"q" #'kbd-macro-query ;; Like C-x q
"d" #'kmacro-redisplay
;; macro ring
"C-n" #'kmacro-cycle-ring-next
"C-p" #'kmacro-cycle-ring-previous
"C-v" #'kmacro-view-macro-repeat
"C-d" #'kmacro-delete-ring-head
"C-t" #'kmacro-swap-ring
"C-l" #'kmacro-call-ring-2nd-repeat
;; macro counter
"C-f" #'kmacro-set-format
"C-c" #'kmacro-set-counter
"C-i" #'kmacro-insert-counter
"C-a" #'kmacro-add-counter
"C-r l" #'kmacro-reg-load-counter
"C-r s" #'kmacro-reg-save-counter
"C-r a =" #'kmacro-reg-add-counter-equal
"C-r a <" #'kmacro-reg-add-counter-less
"C-r a >" #'kmacro-reg-add-counter-greater
"C-q =" #'kmacro-quit-counter-equal
"C-q <" #'kmacro-quit-counter-less
"C-q >" #'kmacro-quit-counter-greater
;; macro editing
"C-e" #'kmacro-edit-macro-repeat
"RET" #'kmacro-edit-macro
"e" #'edit-kbd-macro
"l" #'kmacro-edit-lossage
"SPC" #'kmacro-step-edit-macro
;; naming and binding
"b" #'kmacro-bind-to-key
"n" #'kmacro-name-last-macro
"x" #'kmacro-to-register)
(defalias 'kmacro-keymap kmacro-keymap)
;;; Provide some binding for startup:
;;;###autoload (global-set-key "\C-x(" #'kmacro-start-macro)
;;;###autoload (global-set-key "\C-x)" #'kmacro-end-macro)
;;;###autoload (global-set-key "\C-xe" #'kmacro-end-and-call-macro)
;;;###autoload (global-set-key [f3] #'kmacro-start-macro-or-insert-counter)
;;;###autoload (global-set-key [f4] #'kmacro-end-or-call-macro)
;;;###autoload (global-set-key "\C-x\C-k" #'kmacro-keymap)
;;;###autoload (autoload 'kmacro-keymap "kmacro" "Keymap for keyboard macro commands." t 'keymap)
(if kmacro-call-mouse-event
(global-set-key (vector kmacro-call-mouse-event) #'kmacro-end-call-mouse))
;;; Called from keyboard-quit
(defun kmacro-keyboard-quit ()
(or (not defining-kbd-macro)
(eq defining-kbd-macro 'append)
(kmacro-ring-empty-p)
(kmacro-pop-ring)))
;;; Keyboard macro counter
(defvar kmacro-counter 0
"Current keyboard macro counter.
This is normally initialized to zero when the macro is defined,
and incremented each time the value of the counter is inserted
into a buffer. See `kmacro-start-macro-or-insert-counter' for
more details.")
(defvar kmacro-default-counter-format "%d")
(defvar kmacro-counter-format "%d"
"Current keyboard macro counter format.
Can be set directly via `kmacro-set-format', which see.")
(defvar kmacro-counter-format-start kmacro-counter-format
"Macro format at start of macro execution.")
(defvar kmacro-counter-value-start kmacro-counter
"Macro counter at start of macro execution.")
(defvar kmacro-last-counter 0
"Last counter inserted by key macro.")
(defvar kmacro-initial-counter-value nil
"Initial counter value for the next keyboard macro to be defined.")
(defun kmacro-insert-counter (arg)
"Insert current value of `kmacro-counter', then increment it by ARG.
Interactively, ARG defaults to 1. With \\[universal-argument], insert
the previous value of `kmacro-counter', and do not increment the
current value.
The previous value of the counter is the one it had before
the last increment.
See Info node `(emacs) Keyboard Macro Counter' for more
information."
(interactive "P")
(if kmacro-initial-counter-value
(setq kmacro-counter kmacro-initial-counter-value
kmacro-initial-counter-value nil))
(if (consp arg)
(insert (format kmacro-counter-format kmacro-last-counter))
(insert (format kmacro-counter-format kmacro-counter))
(kmacro-add-counter (prefix-numeric-value arg))))
(defun kmacro-set-format (format)
"Set the format of `kmacro-counter' to FORMAT.
The default format is \"%d\", which means to insert the number in
decimal without any padding. You can specify any format string
that the `format' function accepts and that makes sense with a
single integer extra argument.
If you run this command while no keyboard macro is being defined,
the new format affects all subsequent macro definitions.
If you run this command while defining a keyboard macro, it
affects only that macro, from that point on.
Do not put the format string inside double quotes when you insert
it in the minibuffer.
See Info node `(emacs) Keyboard Macro Counter' for more
information."
(interactive "sMacro Counter Format: ")
(setq kmacro-counter-format
(if (equal format "") "%d" format))
;; redefine initial macro counter if we are not executing a macro.
(if (not (or defining-kbd-macro executing-kbd-macro))
(setq kmacro-default-counter-format kmacro-counter-format)))
(defun kmacro-display-counter (&optional value)
"Display current counter value.
See Info node `(emacs) Keyboard Macro Counter' for more
information."
(unless value (setq value kmacro-counter))
(message "New macro counter value: %s (%d)"
(format kmacro-counter-format value) value))
(defun kmacro-set-counter (arg)
"Set the value of `kmacro-counter' to ARG, or prompt for value if no argument.
With \\[universal-argument] prefix, reset counter to its value prior to this iteration of the
macro.
See Info node `(emacs) Keyboard Macro Counter' for more
information."
(interactive "NMacro counter value: ")
(if (not (or defining-kbd-macro executing-kbd-macro))
(kmacro-display-counter (setq kmacro-initial-counter-value arg))
(setq kmacro-last-counter kmacro-counter
kmacro-counter (if (and current-prefix-arg (listp current-prefix-arg))
kmacro-counter-value-start
arg))
(unless executing-kbd-macro
(kmacro-display-counter))))
(defun kmacro-add-counter (arg)
"Add the value of numeric prefix arg (prompt if missing) to `kmacro-counter'.
With \\[universal-argument], restore previous counter value.
See Info node `(emacs) Keyboard Macro Counter' for more
information."
(interactive "NAdd to macro counter: ")
(if kmacro-initial-counter-value
(setq kmacro-counter kmacro-initial-counter-value
kmacro-initial-counter-value nil))
(let ((last kmacro-last-counter))
(setq kmacro-last-counter kmacro-counter
kmacro-counter (if (and current-prefix-arg (listp current-prefix-arg))
last
(+ kmacro-counter arg))))
(unless executing-kbd-macro
(kmacro-display-counter)))
(defun kmacro-reg-load-counter (register)
"Load the value of a REGISTER into `kmacro-counter'."
(interactive
(list (register-read-with-preview "Load register to counter: ")))
(let ((register-val (get-register register)))
(when (numberp register-val)
(setq kmacro-counter register-val))))
(defun kmacro-reg-save-counter (register)
"Save the value of `kmacro-counter' to a REGISTER."
(interactive
(list (register-read-with-preview "Save counter to register: ")))
(set-register register kmacro-counter))
(defun kmacro-reg-add-counter-equal (&optional arg)
"Increment counter by one if it is equal to register value.
Prompt for the register to compare.
Optional non-nil ARG specifies the increment."
(interactive "p")
(let
((register (register-read-with-preview "Compare counter to register: ")))
(kmacro-reg-add-counter #'= register arg)))
(defun kmacro-reg-add-counter-less (&optional arg)
"Increment counter by one if it is less than register value.
Prompt for the register to compare.
Optional non-nil ARG specifies increment."
(interactive "p")
(let
((register (register-read-with-preview "Compare counter to register: ")))
(kmacro-reg-add-counter #'< register arg)))
(defun kmacro-reg-add-counter-greater (&optional arg)
"Increment counter by one if it is greater than register value.
Prompt for the register to compare.
Optional non-nil ARG specifies increment."
(interactive "p")
(let
((register (register-read-with-preview "Compare counter to register: ")))
(kmacro-reg-add-counter #'> register arg)))
(defun kmacro-reg-add-counter (pred register arg)
"Increment `kmacro-counter' by ARG if PRED returns non-nil.
PRED is called with two arguments: `kmacro-counter' and REGISTER."
(let ((register-val (get-register register)))
(when (funcall pred kmacro-counter register-val)
(setq current-prefix-arg nil)
(kmacro-add-counter arg))))
(defun kmacro-quit-counter-equal (&optional arg)
"Quit the keyboard macro if the counter is equal to ARG.
ARG defaults to zero if nil or omitted."
(interactive "p")
(kmacro-quit-counter #'= arg))
(defun kmacro-quit-counter-less (&optional arg)
"Quit the keyboard macro if the counter is less than ARGS.
ARG defaults to zero if nil or omitted."
(interactive "p")
(kmacro-quit-counter #'< arg))
(defun kmacro-quit-counter-greater (&optional arg)
"Quit the keyboard macro if the counter is greater than ARG.
ARG defaults to zero if nil or omitted."
(interactive "p")
(kmacro-quit-counter #'> arg))
(defun kmacro-quit-counter (pred arg)
"Quit the keyboard macro if PRED returns non-nil.
PRED is called with two arguments: `kmacro-counter' and ARG.
ARG defaults to zero if it is nil."
(when kmacro-initial-counter-value
(setq kmacro-counter kmacro-initial-counter-value
kmacro-initial-counter-value nil))
(let ((arg (if (null current-prefix-arg)
0 arg)))
(when (funcall pred kmacro-counter arg)
(keyboard-quit))))
(defun kmacro-loop-setup-function ()
"Function called prior to each iteration of macro."
;; Restore macro counter format to initial format, so it is ok to change
;; counter format in the macro without restoring it.
(setq kmacro-counter-format kmacro-counter-format-start)
;; Save initial counter value so we can restore it with C-u kmacro-set-counter.
(setq kmacro-counter-value-start kmacro-counter)
;; Return non-nil to continue execution.
t)
;;; Keyboard macro ring
(oclosure-define kmacro
"Keyboard macro."
keys (counter :mutable t) format)
(defvar kmacro-ring nil
"The keyboard macro ring.
Each element is a `kmacro'. Actually, the head of
the macro ring (when defining or executing) is not stored in the ring;
instead it is available in the variables `last-kbd-macro', `kmacro-counter',
and `kmacro-counter-format'.")
;; Remember what we are currently looking at with kmacro-view-macro.
(defvar kmacro-view-last-item nil)
(defvar kmacro-view-item-no 0)
(defun kmacro--to-vector (object)
"Normalize an old-style key sequence to the vector form."
(if (not (stringp object))
object
(let ((vec (string-to-vector object)))
(unless (multibyte-string-p object)
(dotimes (i (length vec))
(let ((k (aref vec i)))
(when (> k 127)
(setf (aref vec i) (+ k ?\M-\C-@ -128))))))
vec)))
(defun kmacro-ring-head ()
"Return pseudo head element in macro ring."
(and last-kbd-macro
(kmacro (kmacro--to-vector last-kbd-macro)
kmacro-counter kmacro-counter-format-start)))
(defun kmacro-push-ring (&optional elt)
"Push ELT or current macro onto `kmacro-ring'."
(when (setq elt (or elt (kmacro-ring-head)))
(when (consp elt)
(message "Converting obsolete list form of kmacro: %S" elt)
(setq elt (apply #'kmacro elt)))
(let ((history-delete-duplicates nil))
(add-to-history 'kmacro-ring elt kmacro-ring-max))))
(defun kmacro-split-ring-element (elt)
(setq last-kbd-macro (kmacro--keys elt)
kmacro-counter (kmacro--counter elt)
kmacro-counter-format-start (kmacro--format elt)))
(defun kmacro-pop-ring1 (&optional raw)
"Pop head element off macro ring (no check).
Non-nil arg RAW means just return raw first element."
(prog1 (car kmacro-ring)
(unless raw
(kmacro-split-ring-element (car kmacro-ring)))
(setq kmacro-ring (cdr kmacro-ring))))
(defun kmacro-pop-ring (&optional raw)
"Pop head element off macro ring.
Non-nil arg RAW means just return raw first element."
(unless (kmacro-ring-empty-p)
(kmacro-pop-ring1 raw)))
(defun kmacro-ring-empty-p (&optional none)
"Tell user and return t if `last-kbd-macro' is nil or `kmacro-ring' is empty.
Check only `last-kbd-macro' if optional arg NONE is non-nil."
(while (and (null last-kbd-macro) kmacro-ring)
(kmacro-pop-ring1))
(cond
((null last-kbd-macro)
(message "No keyboard macro defined.")
t)
((and (null none) (null kmacro-ring))
(message "Only one keyboard macro defined.")
t)
(t nil)))
(defun kmacro-display (macro &optional trunc descr empty)
"Display a keyboard MACRO.
Optional arg TRUNC non-nil specifies to limit width of macro to 60 chars.
Optional arg DESCR is descriptive text for macro; default is \"Macro:\".
Optional arg EMPTY is message to print if no macros are defined."
(if macro
(let* ((x 60)
(m (format-kbd-macro macro))
(l (length m))
(z (and trunc (> l x))))
(message "%s%s: %s%s" (or descr "Macro")
(if (= kmacro-counter 0) ""
(format " [%s]"
(format kmacro-counter-format-start kmacro-counter)))
(if z (substring m 0 (1- x)) m) (if z "..." "")))
(message "%s" (or empty "No keyboard macros defined"))))
(defun kmacro-repeat-on-last-key (keys)
"Process kmacro commands keys immediately after cycling the ring."
(setq keys (vconcat keys))
(let ((n (1- (length keys)))
cmd done repeat)
(while (and last-kbd-macro
(not done)
(aset keys n (read-event))
(setq cmd (key-binding keys t))
(setq repeat (get cmd 'kmacro-repeat)))
(clear-this-command-keys t)
(cond
((eq repeat 'ring)
(if kmacro-ring
(let ((kmacro-repeat-no-prefix nil))
(funcall cmd nil))
(kmacro-display last-kbd-macro t)))
((eq repeat 'head)
(let ((kmacro-repeat-no-prefix nil))
(funcall cmd nil)))
((eq repeat 'stop)
(funcall cmd nil)
(setq done t)))
(setq last-input-event nil)))
(when last-input-event
(clear-this-command-keys t)
(push last-input-event unread-command-events)))
(defun kmacro-get-repeat-prefix ()
(let (keys)
(and kmacro-repeat-no-prefix
(setq keys (this-single-command-keys))
(> (length keys) 1)
keys)))
;;;###autoload
(define-obsolete-function-alias 'kmacro-exec-ring-item #'funcall "29.1"
"Execute item ITEM from the macro ring.
ARG is the number of times to execute the item.")
(defun kmacro-call-ring-2nd (arg)
"Execute second keyboard macro in macro ring.
With numeric argument ARG, execute the macro that many times."
(interactive "p")
(unless (kmacro-ring-empty-p)
(funcall (car kmacro-ring) arg)))
(defun kmacro-call-ring-2nd-repeat (arg)
"Execute second keyboard macro in macro ring.
This is like `kmacro-call-ring-2nd', but allows repeating macro commands
without repeating the prefix."
(interactive "p")
(let ((keys (kmacro-get-repeat-prefix)))
(kmacro-call-ring-2nd arg)
(if (and kmacro-ring keys)
(kmacro-repeat-on-last-key keys))))
(put 'kmacro-call-ring-2nd-repeat 'kmacro-repeat 'head)
(defun kmacro-view-ring-2nd ()
"Display the second macro in the keyboard macro ring."
(interactive)
(unless (kmacro-ring-empty-p)
(kmacro-display (kmacro--keys (car kmacro-ring)) nil "2nd macro")))
(defun kmacro-cycle-ring-next (&optional _arg)
"Move to next keyboard macro in keyboard macro ring.
Displays the selected macro in the echo area.
The ARG parameter is unused."
(interactive)
(unless (kmacro-ring-empty-p)
(kmacro-push-ring)
(let* ((keys (kmacro-get-repeat-prefix))
(len (length kmacro-ring))
(tail (nthcdr (- len 2) kmacro-ring))
(elt (car (cdr tail))))
(setcdr tail nil)
(kmacro-split-ring-element elt)
(kmacro-display last-kbd-macro t)
(if keys
(kmacro-repeat-on-last-key keys)))))
(put 'kmacro-cycle-ring-next 'kmacro-repeat 'ring)
(defun kmacro-cycle-ring-previous (&optional _arg)
"Move to previous keyboard macro in keyboard macro ring.
Displays the selected macro in the echo area.
The ARG parameter is unused."
(interactive)
(unless (kmacro-ring-empty-p)
(let ((keys (kmacro-get-repeat-prefix))
(cur (kmacro-ring-head)))
(kmacro-pop-ring1)
(if kmacro-ring
(nconc kmacro-ring (list cur))
(setq kmacro-ring (list cur)))
(kmacro-display last-kbd-macro t)
(if keys
(kmacro-repeat-on-last-key keys)))))
(put 'kmacro-cycle-ring-previous 'kmacro-repeat 'ring)
(defun kmacro-swap-ring ()
"Swap first two elements on keyboard macro ring."
(interactive)
(unless (kmacro-ring-empty-p)
(let ((cur (kmacro-ring-head)))
(kmacro-pop-ring1)
(kmacro-push-ring cur))
(kmacro-display last-kbd-macro t)))
(defun kmacro-delete-ring-head (&optional _arg)
"Delete current macro from keyboard macro ring.
The ARG parameter is unused."
(interactive)
(unless (kmacro-ring-empty-p t)
(if (null kmacro-ring)
(setq last-kbd-macro nil)
(kmacro-pop-ring))
(kmacro-display last-kbd-macro t nil "Keyboard macro ring is now empty.")))
(put 'kmacro-delete-ring-head 'kmacro-repeat 'head)
;;; Traditional bindings:
;;;###autoload
(defun kmacro-start-macro (arg)
"Record subsequent keyboard input, defining a keyboard macro.
The commands are recorded even as they are executed.
Use \\[kmacro-end-macro] to finish recording and make the macro available.
Use \\[kmacro-end-and-call-macro] to execute the macro.
Non-nil arg (prefix arg) means append to last macro defined.
With \\[universal-argument] prefix, append to last keyboard macro
defined. Depending on `kmacro-execute-before-append', this may begin
by re-executing the last macro as if you typed it again.
Otherwise, it sets `kmacro-counter' to ARG or 0 if missing before
defining the macro.
Use \\[kmacro-insert-counter] to insert (and increment) the macro counter.
The counter value can be set or modified via \\[kmacro-set-counter] and \\[kmacro-add-counter].
The format of the counter can be modified via \\[kmacro-set-format].
Use \\[kmacro-name-last-macro] to give it a name that will remain valid even
after another macro is defined.
Use \\[kmacro-bind-to-key] to bind it to a key sequence."
(interactive "P")
(if (or defining-kbd-macro executing-kbd-macro)
(message "Already defining keyboard macro.")
(let ((append (and arg (listp arg))))
(unless append
(if last-kbd-macro
(kmacro-push-ring))
(setq kmacro-counter (or (if arg (prefix-numeric-value arg))
kmacro-initial-counter-value
0)
kmacro-initial-counter-value nil
kmacro-counter-value-start kmacro-counter
kmacro-last-counter kmacro-counter
kmacro-counter-format kmacro-default-counter-format
kmacro-counter-format-start kmacro-default-counter-format))
(start-kbd-macro append
(and append
(if kmacro-execute-before-append
(> (car arg) 4)
(= (car arg) 4))))
(if (and defining-kbd-macro append)
(setq defining-kbd-macro 'append)))))
;;;###autoload
(defun kmacro-end-macro (arg)
"Finish defining a keyboard macro.
The definition was started by \\[kmacro-start-macro].
The macro is now available for use via \\[kmacro-call-macro],
or it can be given a name with \\[kmacro-name-last-macro] and then invoked
under that name.
With numeric ARG, repeat the macro that many times,
counting the definition just completed as the first repetition.
An argument of zero means repeat until error."
(interactive "p")
;; Isearch may push the kmacro-end-macro key sequence onto the macro.
;; Just ignore it when executing the macro.
(unless executing-kbd-macro
(end-kbd-macro arg #'kmacro-loop-setup-function)
(when (and last-kbd-macro (= (length last-kbd-macro) 0))
(setq last-kbd-macro nil)
(message "Ignore empty macro")
;; Don't call `kmacro-ring-empty-p' to avoid its messages.
(while (and (null last-kbd-macro) kmacro-ring)
(kmacro-pop-ring1)))))
;;;###autoload
(defun kmacro-call-macro (arg &optional no-repeat end-macro macro)
"Call the keyboard MACRO that you defined with \\[kmacro-start-macro].
A prefix argument serves as a repeat count. Zero means repeat until error.
MACRO defaults to `last-kbd-macro'.
When you call the macro, you can call the macro again by repeating
just the last key in the key sequence that you used to call this
command. See `kmacro-call-repeat-key' and `kmacro-call-repeat-with-arg'
for details on how to adjust or disable this behavior.
To give a macro a name so you can call it even after defining others,
use \\[kmacro-name-last-macro]."
(interactive "p")
(let ((repeat-key (and (or (and (null no-repeat)
(> (length (this-single-command-keys)) 1))
;; Used when we're in the process of repeating.
(eq no-repeat 'repeating))
last-input-event)))
(if end-macro
(kmacro-end-macro arg) ; modifies last-kbd-macro
(let ((last-kbd-macro (or macro last-kbd-macro)))
(call-last-kbd-macro arg #'kmacro-loop-setup-function)))
(when (consp arg)
(setq arg (car arg)))
(when (and (or (null arg) (> arg 0))
(setq repeat-key
(if (eq kmacro-call-repeat-key t)
repeat-key
kmacro-call-repeat-key)))
;; Issue a hint to the user, if the echo area isn't in use.
(unless (current-message)
(message "(Type %s to repeat macro%s)"
(format-kbd-macro (vector repeat-key) nil)
(if (and kmacro-call-repeat-with-arg
arg (> arg 1))
(format " %d times" arg) "")))
;; Can't use the `keep-pred' arg because this overlay keymap
;; needs to be removed during the next run of the kmacro
;; (i.e. we must add and remove this map at each repetition).
(set-transient-map
(let ((map (make-sparse-keymap)))
(define-key map (vector repeat-key)
(let ((ra (and kmacro-call-repeat-with-arg arg))
(m (if end-macro
last-kbd-macro
(or macro last-kbd-macro))))
(lambda ()
(interactive)
(kmacro-call-macro ra 'repeating nil m))))
map)))))
;;; Combined function key bindings:
;;;###autoload
(defun kmacro-start-macro-or-insert-counter (arg)
"Record subsequent keyboard input, defining a keyboard macro.
The commands are recorded even as they are executed.
Initializes the macro's `kmacro-counter' to ARG (or 0 if no prefix arg)
before defining the macro.
With \\[universal-argument], appends to current keyboard macro (keeping
the current value of `kmacro-counter').
When used during defining/executing a macro, inserts the current value
of `kmacro-counter' and increments the counter value by ARG (or by 1 if no
prefix argument). With just \\[universal-argument], inserts the previous
value of `kmacro-counter', and does not modify the counter; this is
different from incrementing the counter by zero. (The previous value
of the counter is the one it had before the last increment.)
The macro counter can be set directly via \\[kmacro-set-counter] and \\[kmacro-add-counter].
The format of the inserted value of the counter can be controlled
via \\[kmacro-set-format]."
(interactive "P")
(if (or defining-kbd-macro executing-kbd-macro)
(kmacro-insert-counter arg)
(kmacro-start-macro arg)))
;;;###autoload
(defun kmacro-end-or-call-macro (arg &optional no-repeat)
"End kbd macro if currently being defined; else call last kbd macro.
With numeric prefix ARG, repeat macro that many times.
With \\[universal-argument], call second macro in macro ring."
(interactive "P")
(cond
(defining-kbd-macro
(if kmacro-call-repeat-key
(kmacro-call-macro arg no-repeat t)
(kmacro-end-macro arg)))
((and (eq this-command #'kmacro-view-macro) ;; We are in repeat mode!
kmacro-view-last-item)
(funcall (car kmacro-view-last-item) arg))
((and arg (listp arg))
(kmacro-call-ring-2nd 1))
(t
(kmacro-call-macro arg no-repeat))))
(defun kmacro-end-or-call-macro-repeat (arg)
"As `kmacro-end-or-call-macro' but allow repeat without repeating prefix."
(interactive "P")
(let ((keys (kmacro-get-repeat-prefix)))
(kmacro-end-or-call-macro arg t)
(if keys
(kmacro-repeat-on-last-key keys))))
(put 'kmacro-end-or-call-macro-repeat 'kmacro-repeat 'head)
;;;###autoload
(defun kmacro-end-and-call-macro (arg &optional no-repeat)
"Call last keyboard macro, ending it first if currently being defined.
With numeric prefix ARG, repeat macro that many times.
Zero argument means repeat until there is an error.
To give a macro a name, so you can call it even after defining other
macros, use \\[kmacro-name-last-macro]."
(interactive "p")
(if defining-kbd-macro
(kmacro-end-macro nil))
(kmacro-call-macro arg no-repeat))
;;;###autoload
(defun kmacro-end-call-mouse (event)
"Move point to the position clicked with the mouse and call last kbd macro.
If kbd macro currently being defined end it before activating it."
(interactive "e")
(when defining-kbd-macro
(end-kbd-macro)
(when (and last-kbd-macro (= (length last-kbd-macro) 0))
(setq last-kbd-macro nil)
(message "Ignore empty macro")
;; Don't call `kmacro-ring-empty-p' to avoid its messages.
(while (and (null last-kbd-macro) kmacro-ring)
(kmacro-pop-ring1))))
(mouse-set-point event)
(kmacro-call-macro nil t))
;;; Misc. commands
;; An idea for macro bindings:
;; Create a separate keymap installed as a minor-mode keymap (e.g. in
;; the emulation-mode-map-alists) in which macro bindings are made
;; independent of any other bindings. When first binding is made,
;; the keymap is created, installed, and enabled. Key seq. C-x C-k +
;; can then be used to toggle the use of this keymap on and off.
;; This means that it would be safe(r) to bind ordinary keys like
;; letters and digits, provided that we inhibit the keymap while
;; executing the macro later on (but that's controversial...)
;;;###autoload
(defun kmacro (keys &optional counter format)
"Create a `kmacro' for macro bound to symbol or key.
KEYS should be a vector or a string that obeys `key-valid-p'."
(oclosure-lambda (kmacro (keys (if (stringp keys) (key-parse keys) keys))
(counter (or counter 0))
(format (or format "%d")))
(&optional arg)
;; Use counter and format specific to the macro on the ring!
(let ((kmacro-counter counter)
(kmacro-counter-format-start format))
(execute-kbd-macro keys arg #'kmacro-loop-setup-function)
(setq counter kmacro-counter))))
(cl-defmethod oclosure-interactive-form ((_ kmacro)) '(interactive "p"))
;;;###autoload
(defun kmacro-lambda-form (mac &optional counter format)
;; Apparently, there are two different ways this is called:
;; either `counter' and `format' are both provided and `mac' is a vector,
;; or only `mac' is provided, as a list (MAC COUNTER FORMAT).
;; The first is used from `insert-kbd-macro' and `edmacro-finish-edit',
;; while the second is used from within this file.
(declare (obsolete kmacro "29.1"))
(if (kmacro-p mac) mac
(when (and (null counter) (consp mac))
(setq format (nth 2 mac))
(setq counter (nth 1 mac))
(setq mac (nth 0 mac)))
;; `kmacro' interprets a string according to `key-parse'.
(kmacro (kmacro--to-vector mac) counter format)))
(defun kmacro-extract-lambda (mac)
"Extract kmacro from a kmacro lambda form."
(declare (obsolete nil "29.1"))
(when (kmacro-p mac)
(list (kmacro--keys mac)
(kmacro--counter mac)
(kmacro--format mac))))
(defun kmacro-p (x)
"Return non-nil if MAC is a kmacro keyboard macro."
(cl-typep x 'kmacro))
(cl-defmethod cl-print-object ((object kmacro) stream)
(princ "#f(kmacro " stream)
(let ((vecdef (kmacro--keys object))
(counter (kmacro--counter object))
(format (kmacro--format object)))
(prin1 (key-description vecdef) stream)
(unless (and (equal counter 0) (equal format "%d"))
(princ " " stream)
(prin1 counter stream)
(princ " " stream)
(prin1 format stream))
(princ ")" stream)))
(defun kmacro-bind-to-key (_arg)
"When not defining or executing a macro, offer to bind last macro to a key.
The key sequences \\`C-x C-k 0' through \\`C-x C-k 9' and \\`C-x C-k A'
through \\`C-x C-k Z' are reserved for user bindings, and to bind to
one of these sequences, just enter the digit or letter, rather than
the whole sequence.
You can bind to any valid key sequence, but if you try to bind to
a key with an existing command binding, you will be asked for
confirmation whether to replace that binding. Note that the
binding is made in the `global-map' keymap, so the macro binding
may be shaded by a local key binding.
The ARG parameter is unused."
(interactive "p")
(if (or defining-kbd-macro executing-kbd-macro)
(if defining-kbd-macro
(message "Cannot save macro while defining it."))
(unless last-kbd-macro
(error "No keyboard macro defined"))
(let ((key-seq (read-key-sequence "Bind last macro to key: "))
ok cmd)
(when (= (length key-seq) 1)
(let ((ch (aref key-seq 0)))
(if (and (integerp ch)
(or (and (>= ch ?0) (<= ch ?9))
(and (>= ch ?A) (<= ch ?Z))))
(setq key-seq (concat "\C-x\C-k" key-seq)
ok t))))
(when (and (not (equal key-seq "\^G"))
(or ok
(not (setq cmd (key-binding key-seq)))