* lisp/mail/emacsbug.el (report-emacs-bug): Try "sw_vers" on Darwin.
[emacs.git] / lisp / kmacro.el
blobda02ab5aca4235f6cd8fda1d393b2866bb7deb0f
1 ;;; kmacro.el --- enhanced keyboard macros -*- lexical-binding: t -*-
3 ;; Copyright (C) 2002-2017 Free Software Foundation, Inc.
5 ;; Author: Kim F. Storm <storm@cua.dk>
6 ;; Keywords: keyboard convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;; The kmacro package provides the user interface to emacs' basic
26 ;; keyboard macro functionality. With kmacro, two function keys are
27 ;; dedicated to keyboard macros, by default F3 and F4.
29 ;; Note: The traditional bindings C-x (, C-x ), and C-x e are still
30 ;; supported, but for some users these bindings are too hard to type
31 ;; to be really useful for doing small repeated tasks.
33 ;; To start defining a keyboard macro, use F3. To end the macro,
34 ;; use F4, and to call the macro also use F4. This makes it very
35 ;; easy to repeat a macro immediately after defining it.
37 ;; You can call the macro repeatedly by pressing F4 multiple times, or
38 ;; you can give a numeric prefix argument specifying the number of
39 ;; times to repeat the macro. Macro execution automatically
40 ;; terminates when point reaches the end of the buffer or if an error
41 ;; is signaled by ringing the bell.
43 ;; When you define a macro with F3/F4, it is automatically added to
44 ;; the head of the "keyboard macro ring", and F4 actually executes the
45 ;; first element of the macro ring.
47 ;; Note: an empty macro is never added to the macro ring.
49 ;; You can execute the second element on the macro ring with C-u F4 or
50 ;; C-x C-k C-l, you can use C-x C-k C-p and C-x C-k C-n to cycle
51 ;; through the macro ring, and you can swap the first and second
52 ;; elements with C-x C-k C-t. To delete the first element in the
53 ;; macro ring, use C-x C-k C-d.
55 ;; You can also use C-x C-k C-s to start a macro, and C-x C-k C-k to
56 ;; end it; then use C-k to execute it immediately, or C-x C-k C-k to
57 ;; execute it later.
59 ;; In general, immediately after using C-x C-k followed by one of C-k,
60 ;; C-l, C-p, or C-n, you can further cycle the macro ring using C-p or
61 ;; C-n, execute the first or second macro using C-k or C-l, delete
62 ;; the head macro with C-d, or edit the current macro with C-e without
63 ;; repeating the C-x C-k prefix.
65 ;; If you enter F3 while defining the macro, the numeric value of
66 ;; `kmacro-counter' is inserted using the `kmacro-counter-format', and
67 ;; `kmacro-counter' is incremented by 1 (or the numeric prefix value
68 ;; of F3).
70 ;; The initial value of `kmacro-counter' is 0, or the numeric prefix
71 ;; value given to F3 when starting the macro.
73 ;; Now, each time you call the macro using F4, the current
74 ;; value of `kmacro-counter' is inserted and incremented, making it
75 ;; easy to insert incremental numbers in the buffer.
77 ;; Example:
79 ;; The following sequence: M-5 F3 x M-2 F3 y F4 F4 F4 F4
80 ;; inserts the following string: x5yx7yx9yx11y
82 ;; A macro can also be called using a mouse click, default S-mouse-3.
83 ;; This calls the macro at the point where you click the mouse.
85 ;; You can edit the last macro using C-x C-k C-e.
87 ;; You can append to the last macro using C-u F3.
89 ;; You can set the macro counter using C-x C-k C-c, add to it using C-x C-k C-a,
90 ;; and you can set the macro counter format with C-x C-k C-f.
92 ;; The following key bindings are performed:
94 ;; Normal While defining macro
95 ;; --------------------------- ------------------------------
96 ;; f3 Define macro Insert current counter value
97 ;; Prefix arg specifies initial and increase counter by prefix
98 ;; counter value (default 0) (default increment: 1)
100 ;; C-u f3 APPENDs to last macro
102 ;; f4 Call last macro End macro
103 ;; Prefix arg specifies number
104 ;; of times to execute macro.
106 ;; C-u f4 Swap last and head of macro ring.
108 ;; S-mouse-3 Set point at click and End macro and execute macro at
109 ;; execute last macro. click.
111 ;;; Code:
113 ;; Customization:
114 (require 'replace)
116 (defgroup kmacro nil
117 "Simplified keyboard macro user interface."
118 :group 'keyboard
119 :group 'convenience
120 :version "22.1"
121 :link '(emacs-commentary-link :tag "Commentary" "kmacro.el")
122 :link '(emacs-library-link :tag "Lisp File" "kmacro.el"))
124 (defcustom kmacro-call-mouse-event 'S-mouse-3
125 "The mouse event used by kmacro to call a macro.
126 Set to nil if no mouse binding is desired."
127 :type 'symbol)
129 (defcustom kmacro-ring-max 8
130 "Maximum number of keyboard macros to save in macro ring."
131 :type 'integer)
134 (defcustom kmacro-execute-before-append t
135 "Controls whether appending to a macro starts by executing the macro.
136 If non-nil, using a single \\[universal-argument] prefix executes the macro
137 before appending, while more than one \\[universal-argument] prefix does not
138 execute the macro.
139 Otherwise, a single \\[universal-argument] prefix does not execute the
140 macro, while more than one \\[universal-argument] prefix causes the
141 macro to be executed before appending to it."
142 :type 'boolean)
145 (defcustom kmacro-repeat-no-prefix t
146 "Allow repeating certain macro commands without entering the C-x C-k prefix."
147 :type 'boolean)
149 (defcustom kmacro-call-repeat-key t
150 "Allow repeating macro call using last key or a specific key."
151 :type '(choice (const :tag "Disabled" nil)
152 (const :tag "Last key" t)
153 (character :tag "Character" :value ?e)
154 (symbol :tag "Key symbol" :value RET)))
156 (defcustom kmacro-call-repeat-with-arg nil
157 "Repeat macro call with original arg when non-nil; repeat once if nil."
158 :type 'boolean)
160 (defcustom kmacro-step-edit-mini-window-height 0.75
161 "Override `max-mini-window-height' when step edit keyboard macro."
162 :type 'number)
164 ;; Keymap
166 (defvar kmacro-keymap
167 (let ((map (make-sparse-keymap)))
168 ;; Start, end, execute macros
169 (define-key map "s" 'kmacro-start-macro)
170 (define-key map "\C-s" 'kmacro-start-macro)
171 (define-key map "\C-k" 'kmacro-end-or-call-macro-repeat)
172 (define-key map "r" 'apply-macro-to-region-lines)
173 (define-key map "q" 'kbd-macro-query) ;; Like C-x q
175 ;; macro ring
176 (define-key map "\C-n" 'kmacro-cycle-ring-next)
177 (define-key map "\C-p" 'kmacro-cycle-ring-previous)
178 (define-key map "\C-v" 'kmacro-view-macro-repeat)
179 (define-key map "\C-d" 'kmacro-delete-ring-head)
180 (define-key map "\C-t" 'kmacro-swap-ring)
181 (define-key map "\C-l" 'kmacro-call-ring-2nd-repeat)
183 ;; macro counter
184 (define-key map "\C-f" 'kmacro-set-format)
185 (define-key map "\C-c" 'kmacro-set-counter)
186 (define-key map "\C-i" 'kmacro-insert-counter)
187 (define-key map "\C-a" 'kmacro-add-counter)
189 ;; macro editing
190 (define-key map "\C-e" 'kmacro-edit-macro-repeat)
191 (define-key map "\r" 'kmacro-edit-macro)
192 (define-key map "e" 'edit-kbd-macro)
193 (define-key map "l" 'kmacro-edit-lossage)
194 (define-key map " " 'kmacro-step-edit-macro)
196 ;; naming and binding
197 (define-key map "b" 'kmacro-bind-to-key)
198 (define-key map "n" 'kmacro-name-last-macro)
199 (define-key map "x" 'kmacro-to-register)
200 map)
201 "Keymap for keyboard macro commands.")
202 (defalias 'kmacro-keymap kmacro-keymap)
204 ;;; Provide some binding for startup:
205 ;;;###autoload (global-set-key "\C-x(" 'kmacro-start-macro)
206 ;;;###autoload (global-set-key "\C-x)" 'kmacro-end-macro)
207 ;;;###autoload (global-set-key "\C-xe" 'kmacro-end-and-call-macro)
208 ;;;###autoload (global-set-key [f3] 'kmacro-start-macro-or-insert-counter)
209 ;;;###autoload (global-set-key [f4] 'kmacro-end-or-call-macro)
210 ;;;###autoload (global-set-key "\C-x\C-k" 'kmacro-keymap)
211 ;;;###autoload (autoload 'kmacro-keymap "kmacro" "Keymap for keyboard macro commands." t 'keymap)
213 (if kmacro-call-mouse-event
214 (global-set-key (vector kmacro-call-mouse-event) 'kmacro-end-call-mouse))
217 ;;; Called from keyboard-quit
219 (defun kmacro-keyboard-quit ()
220 (or (not defining-kbd-macro)
221 (eq defining-kbd-macro 'append)
222 (kmacro-ring-empty-p)
223 (kmacro-pop-ring)))
226 ;;; Keyboard macro counter
228 (defvar kmacro-counter 0
229 "Current keyboard macro counter.")
231 (defvar kmacro-default-counter-format "%d")
233 (defvar kmacro-counter-format "%d"
234 "Current keyboard macro counter format.")
236 (defvar kmacro-counter-format-start kmacro-counter-format
237 "Macro format at start of macro execution.")
239 (defvar kmacro-counter-value-start kmacro-counter
240 "Macro counter at start of macro execution.")
242 (defvar kmacro-last-counter 0
243 "Last counter inserted by key macro.")
245 (defvar kmacro-initial-counter-value nil
246 "Initial counter value for the next keyboard macro to be defined.")
249 (defun kmacro-insert-counter (arg)
250 "Insert macro counter, then increment it by ARG.
251 Interactively, ARG defaults to 1. With \\[universal-argument], insert
252 previous `kmacro-counter', and do not modify counter."
253 (interactive "P")
254 (if kmacro-initial-counter-value
255 (setq kmacro-counter kmacro-initial-counter-value
256 kmacro-initial-counter-value nil))
257 (if (consp arg)
258 (insert (format kmacro-counter-format kmacro-last-counter))
259 (insert (format kmacro-counter-format kmacro-counter))
260 (kmacro-add-counter (prefix-numeric-value arg))))
263 (defun kmacro-set-format (format)
264 "Set macro counter FORMAT."
265 (interactive "sMacro Counter Format: ")
266 (setq kmacro-counter-format
267 (if (equal format "") "%d" format))
268 ;; redefine initial macro counter if we are not executing a macro.
269 (if (not (or defining-kbd-macro executing-kbd-macro))
270 (setq kmacro-default-counter-format kmacro-counter-format)))
273 (defun kmacro-display-counter (&optional value)
274 "Display current counter value."
275 (unless value (setq value kmacro-counter))
276 (message "New macro counter value: %s (%d)"
277 (format kmacro-counter-format value) value))
279 (defun kmacro-set-counter (arg)
280 "Set `kmacro-counter' to ARG or prompt if missing.
281 With \\[universal-argument] prefix, reset counter to its value prior to this iteration of the macro."
282 (interactive "NMacro counter value: ")
283 (if (not (or defining-kbd-macro executing-kbd-macro))
284 (kmacro-display-counter (setq kmacro-initial-counter-value arg))
285 (setq kmacro-last-counter kmacro-counter
286 kmacro-counter (if (and current-prefix-arg (listp current-prefix-arg))
287 kmacro-counter-value-start
288 arg))
289 (unless executing-kbd-macro
290 (kmacro-display-counter))))
293 (defun kmacro-add-counter (arg)
294 "Add numeric prefix arg (prompt if missing) to macro counter.
295 With \\[universal-argument], restore previous counter value."
296 (interactive "NAdd to macro counter: ")
297 (if kmacro-initial-counter-value
298 (setq kmacro-counter kmacro-initial-counter-value
299 kmacro-initial-counter-value nil))
300 (let ((last kmacro-last-counter))
301 (setq kmacro-last-counter kmacro-counter
302 kmacro-counter (if (and current-prefix-arg (listp current-prefix-arg))
303 last
304 kmacro-counter (+ kmacro-counter arg))))
305 (unless executing-kbd-macro
306 (kmacro-display-counter)))
309 (defun kmacro-loop-setup-function ()
310 "Function called prior to each iteration of macro."
311 ;; Restore macro counter format to initial format, so it is ok to change
312 ;; counter format in the macro without restoring it.
313 (setq kmacro-counter-format kmacro-counter-format-start)
314 ;; Save initial counter value so we can restore it with C-u kmacro-set-counter.
315 (setq kmacro-counter-value-start kmacro-counter)
316 ;; Return non-nil to continue execution.
320 ;;; Keyboard macro ring
322 (defvar kmacro-ring nil
323 "The keyboard macro ring.
324 Each element is a list (MACRO COUNTER FORMAT). Actually, the head of
325 the macro ring (when defining or executing) is not stored in the ring;
326 instead it is available in the variables `last-kbd-macro', `kmacro-counter',
327 and `kmacro-counter-format'.")
329 ;; Remember what we are currently looking at with kmacro-view-macro.
331 (defvar kmacro-view-last-item nil)
332 (defvar kmacro-view-item-no 0)
335 (defun kmacro-ring-head ()
336 "Return pseudo head element in macro ring."
337 (and last-kbd-macro
338 (list last-kbd-macro kmacro-counter kmacro-counter-format-start)))
341 (defun kmacro-push-ring (&optional elt)
342 "Push ELT or current macro onto `kmacro-ring'."
343 (when (setq elt (or elt (kmacro-ring-head)))
344 (let ((history-delete-duplicates nil))
345 (add-to-history 'kmacro-ring elt kmacro-ring-max))))
348 (defun kmacro-split-ring-element (elt)
349 (setq last-kbd-macro (car elt)
350 kmacro-counter (nth 1 elt)
351 kmacro-counter-format-start (nth 2 elt)))
354 (defun kmacro-pop-ring1 (&optional raw)
355 "Pop head element off macro ring (no check).
356 Non-nil arg RAW means just return raw first element."
357 (prog1 (car kmacro-ring)
358 (unless raw
359 (kmacro-split-ring-element (car kmacro-ring)))
360 (setq kmacro-ring (cdr kmacro-ring))))
363 (defun kmacro-pop-ring (&optional raw)
364 "Pop head element off macro ring.
365 Non-nil arg RAW means just return raw first element."
366 (unless (kmacro-ring-empty-p)
367 (kmacro-pop-ring1 raw)))
370 (defun kmacro-ring-empty-p (&optional none)
371 "Tell user and return t if `last-kbd-macro' is nil or `kmacro-ring' is empty.
372 Check only `last-kbd-macro' if optional arg NONE is non-nil."
373 (while (and (null last-kbd-macro) kmacro-ring)
374 (kmacro-pop-ring1))
375 (cond
376 ((null last-kbd-macro)
377 (message "No keyboard macro defined.")
379 ((and (null none) (null kmacro-ring))
380 (message "Only one keyboard macro defined.")
382 (t nil)))
385 (defun kmacro-display (macro &optional trunc descr empty)
386 "Display a keyboard MACRO.
387 Optional arg TRUNC non-nil specifies to limit width of macro to 60 chars.
388 Optional arg DESCR is descriptive text for macro; default is \"Macro:\".
389 Optional arg EMPTY is message to print if no macros are defined."
390 (if macro
391 (let* ((x 60)
392 (m (format-kbd-macro macro))
393 (l (length m))
394 (z (and trunc (> l x))))
395 (message "%s%s: %s%s" (or descr "Macro")
396 (if (= kmacro-counter 0) ""
397 (format " [%s]"
398 (format kmacro-counter-format-start kmacro-counter)))
399 (if z (substring m 0 (1- x)) m) (if z "..." "")))
400 (message "%s" (or empty "No keyboard macros defined"))))
403 (defun kmacro-repeat-on-last-key (keys)
404 "Process kmacro commands keys immediately after cycling the ring."
405 (setq keys (vconcat keys))
406 (let ((n (1- (length keys)))
407 cmd done repeat)
408 (while (and last-kbd-macro
409 (not done)
410 (aset keys n (read-event))
411 (setq cmd (key-binding keys t))
412 (setq repeat (get cmd 'kmacro-repeat)))
413 (clear-this-command-keys t)
414 (cond
415 ((eq repeat 'ring)
416 (if kmacro-ring
417 (let ((kmacro-repeat-no-prefix nil))
418 (funcall cmd nil))
419 (kmacro-display last-kbd-macro t)))
420 ((eq repeat 'head)
421 (let ((kmacro-repeat-no-prefix nil))
422 (funcall cmd nil)))
423 ((eq repeat 'stop)
424 (funcall cmd nil)
425 (setq done t)))
426 (setq last-input-event nil)))
427 (when last-input-event
428 (clear-this-command-keys t)
429 (push last-input-event unread-command-events)))
432 (defun kmacro-get-repeat-prefix ()
433 (let (keys)
434 (and kmacro-repeat-no-prefix
435 (setq keys (this-single-command-keys))
436 (> (length keys) 1)
437 keys)))
440 ;;;###autoload
441 (defun kmacro-exec-ring-item (item arg)
442 "Execute item ITEM from the macro ring.
443 ARG is the number of times to execute the item."
444 ;; Use counter and format specific to the macro on the ring!
445 (let ((kmacro-counter (nth 1 item))
446 (kmacro-counter-format-start (nth 2 item)))
447 (execute-kbd-macro (car item) arg #'kmacro-loop-setup-function)
448 (setcar (cdr item) kmacro-counter)))
451 (defun kmacro-call-ring-2nd (arg)
452 "Execute second keyboard macro in macro ring."
453 (interactive "P")
454 (unless (kmacro-ring-empty-p)
455 (kmacro-exec-ring-item (car kmacro-ring) arg)))
458 (defun kmacro-call-ring-2nd-repeat (arg)
459 "Execute second keyboard macro in macro ring.
460 This is like `kmacro-call-ring-2nd', but allows repeating macro commands
461 without repeating the prefix."
462 (interactive "P")
463 (let ((keys (kmacro-get-repeat-prefix)))
464 (kmacro-call-ring-2nd arg)
465 (if (and kmacro-ring keys)
466 (kmacro-repeat-on-last-key keys))))
468 (put 'kmacro-call-ring-2nd-repeat 'kmacro-repeat 'head)
471 (defun kmacro-view-ring-2nd ()
472 "Display the current head of the keyboard macro ring."
473 (interactive)
474 (unless (kmacro-ring-empty-p)
475 (kmacro-display (car (car kmacro-ring)) nil "2nd macro")))
478 (defun kmacro-cycle-ring-next (&optional _arg)
479 "Move to next keyboard macro in keyboard macro ring.
480 Displays the selected macro in the echo area.
481 The ARG parameter is unused."
482 (interactive)
483 (unless (kmacro-ring-empty-p)
484 (kmacro-push-ring)
485 (let* ((keys (kmacro-get-repeat-prefix))
486 (len (length kmacro-ring))
487 (tail (nthcdr (- len 2) kmacro-ring))
488 (elt (car (cdr tail))))
489 (setcdr tail nil)
490 (kmacro-split-ring-element elt)
491 (kmacro-display last-kbd-macro t)
492 (if keys
493 (kmacro-repeat-on-last-key keys)))))
495 (put 'kmacro-cycle-ring-next 'kmacro-repeat 'ring)
498 (defun kmacro-cycle-ring-previous (&optional _arg)
499 "Move to previous keyboard macro in keyboard macro ring.
500 Displays the selected macro in the echo area.
501 The ARG parameter is unused."
502 (interactive)
503 (unless (kmacro-ring-empty-p)
504 (let ((keys (kmacro-get-repeat-prefix))
505 (cur (kmacro-ring-head)))
506 (kmacro-pop-ring1)
507 (if kmacro-ring
508 (nconc kmacro-ring (list cur))
509 (setq kmacro-ring (list cur)))
510 (kmacro-display last-kbd-macro t)
511 (if keys
512 (kmacro-repeat-on-last-key keys)))))
514 (put 'kmacro-cycle-ring-previous 'kmacro-repeat 'ring)
517 (defun kmacro-swap-ring ()
518 "Swap first two elements on keyboard macro ring."
519 (interactive)
520 (unless (kmacro-ring-empty-p)
521 (let ((cur (kmacro-ring-head)))
522 (kmacro-pop-ring1)
523 (kmacro-push-ring cur))
524 (kmacro-display last-kbd-macro t)))
527 (defun kmacro-delete-ring-head (&optional _arg)
528 "Delete current macro from keyboard macro ring.
529 The ARG parameter is unused."
530 (interactive)
531 (unless (kmacro-ring-empty-p t)
532 (if (null kmacro-ring)
533 (setq last-kbd-macro nil)
534 (kmacro-pop-ring))
535 (kmacro-display last-kbd-macro t nil "Keyboard macro ring is now empty.")))
537 (put 'kmacro-delete-ring-head 'kmacro-repeat 'head)
539 ;;; Traditional bindings:
542 ;;;###autoload
543 (defun kmacro-start-macro (arg)
544 "Record subsequent keyboard input, defining a keyboard macro.
545 The commands are recorded even as they are executed.
546 Use \\[kmacro-end-macro] to finish recording and make the macro available.
547 Use \\[kmacro-end-and-call-macro] to execute the macro.
549 Non-nil arg (prefix arg) means append to last macro defined.
551 With \\[universal-argument] prefix, append to last keyboard macro
552 defined. Depending on `kmacro-execute-before-append', this may begin
553 by re-executing the last macro as if you typed it again.
555 Otherwise, it sets `kmacro-counter' to ARG or 0 if missing before
556 defining the macro.
558 Use \\[kmacro-insert-counter] to insert (and increment) the macro counter.
559 The counter value can be set or modified via \\[kmacro-set-counter] and \\[kmacro-add-counter].
560 The format of the counter can be modified via \\[kmacro-set-format].
562 Use \\[kmacro-name-last-macro] to give it a name that will remain valid even
563 after another macro is defined.
564 Use \\[kmacro-bind-to-key] to bind it to a key sequence."
565 (interactive "P")
566 (if (or defining-kbd-macro executing-kbd-macro)
567 (message "Already defining keyboard macro.")
568 (let ((append (and arg (listp arg))))
569 (unless append
570 (if last-kbd-macro
571 (kmacro-push-ring
572 (list last-kbd-macro kmacro-counter kmacro-counter-format-start)))
573 (setq kmacro-counter (or (if arg (prefix-numeric-value arg))
574 kmacro-initial-counter-value
576 kmacro-initial-counter-value nil
577 kmacro-counter-value-start kmacro-counter
578 kmacro-last-counter kmacro-counter
579 kmacro-counter-format kmacro-default-counter-format
580 kmacro-counter-format-start kmacro-default-counter-format))
582 (start-kbd-macro append
583 (and append
584 (if kmacro-execute-before-append
585 (> (car arg) 4)
586 (= (car arg) 4))))
587 (if (and defining-kbd-macro append)
588 (setq defining-kbd-macro 'append)))))
591 ;;;###autoload
592 (defun kmacro-end-macro (arg)
593 "Finish defining a keyboard macro.
594 The definition was started by \\[kmacro-start-macro].
595 The macro is now available for use via \\[kmacro-call-macro],
596 or it can be given a name with \\[kmacro-name-last-macro] and then invoked
597 under that name.
599 With numeric arg, repeat macro now that many times,
600 counting the definition just completed as the first repetition.
601 An argument of zero means repeat until error."
602 (interactive "P")
603 ;; Isearch may push the kmacro-end-macro key sequence onto the macro.
604 ;; Just ignore it when executing the macro.
605 (unless executing-kbd-macro
606 (end-kbd-macro arg #'kmacro-loop-setup-function)
607 (when (and last-kbd-macro (= (length last-kbd-macro) 0))
608 (setq last-kbd-macro nil)
609 (message "Ignore empty macro")
610 ;; Don't call `kmacro-ring-empty-p' to avoid its messages.
611 (while (and (null last-kbd-macro) kmacro-ring)
612 (kmacro-pop-ring1)))))
615 ;;;###autoload
616 (defun kmacro-call-macro (arg &optional no-repeat end-macro macro)
617 "Call the keyboard MACRO that you defined with \\[kmacro-start-macro].
618 A prefix argument serves as a repeat count. Zero means repeat until error.
619 MACRO defaults to `last-kbd-macro'.
621 When you call the macro, you can call the macro again by repeating
622 just the last key in the key sequence that you used to call this
623 command. See `kmacro-call-repeat-key' and `kmacro-call-repeat-with-arg'
624 for details on how to adjust or disable this behavior.
626 To give a macro a name so you can call it even after defining others,
627 use \\[kmacro-name-last-macro]."
628 (interactive "p")
629 (let ((repeat-key (and (or (and (null no-repeat)
630 (> (length (this-single-command-keys)) 1))
631 ;; Used when we're in the process of repeating.
632 (eq no-repeat 'repeating))
633 last-input-event)))
634 (if end-macro
635 (kmacro-end-macro arg) ; modifies last-kbd-macro
636 (let ((last-kbd-macro (or macro last-kbd-macro)))
637 (call-last-kbd-macro arg #'kmacro-loop-setup-function)))
638 (when (consp arg)
639 (setq arg (car arg)))
640 (when (and (or (null arg) (> arg 0))
641 (setq repeat-key
642 (if (eq kmacro-call-repeat-key t)
643 repeat-key
644 kmacro-call-repeat-key)))
645 ;; Issue a hint to the user, if the echo area isn't in use.
646 (unless (current-message)
647 (message "(Type %s to repeat macro%s)"
648 (format-kbd-macro (vector repeat-key) nil)
649 (if (and kmacro-call-repeat-with-arg
650 arg (> arg 1))
651 (format " %d times" arg) "")))
652 ;; Can't use the `keep-pred' arg because this overlay keymap
653 ;; needs to be removed during the next run of the kmacro
654 ;; (i.e. we must add and remove this map at each repetition).
655 (set-transient-map
656 (let ((map (make-sparse-keymap)))
657 (define-key map (vector repeat-key)
658 `(lambda () (interactive)
659 (kmacro-call-macro ,(and kmacro-call-repeat-with-arg arg)
660 'repeating nil ,(if end-macro
661 last-kbd-macro
662 (or macro last-kbd-macro)))))
663 map)))))
666 ;;; Combined function key bindings:
668 ;;;###autoload
669 (defun kmacro-start-macro-or-insert-counter (arg)
670 "Record subsequent keyboard input, defining a keyboard macro.
671 The commands are recorded even as they are executed.
673 Sets the `kmacro-counter' to ARG (or 0 if no prefix arg) before defining the
674 macro.
676 With \\[universal-argument], appends to current keyboard macro (keeping
677 the current value of `kmacro-counter').
679 When defining/executing macro, inserts macro counter and increments
680 the counter with ARG or 1 if missing. With \\[universal-argument],
681 inserts previous `kmacro-counter' (but do not modify counter).
683 The macro counter can be modified via \\[kmacro-set-counter] and \\[kmacro-add-counter].
684 The format of the counter can be modified via \\[kmacro-set-format]."
685 (interactive "P")
686 (if (or defining-kbd-macro executing-kbd-macro)
687 (kmacro-insert-counter arg)
688 (kmacro-start-macro arg)))
691 ;;;###autoload
692 (defun kmacro-end-or-call-macro (arg &optional no-repeat)
693 "End kbd macro if currently being defined; else call last kbd macro.
694 With numeric prefix ARG, repeat macro that many times.
695 With \\[universal-argument], call second macro in macro ring."
696 (interactive "P")
697 (cond
698 (defining-kbd-macro
699 (if kmacro-call-repeat-key
700 (kmacro-call-macro arg no-repeat t)
701 (kmacro-end-macro arg)))
702 ((and (eq this-command 'kmacro-view-macro) ;; We are in repeat mode!
703 kmacro-view-last-item)
704 (kmacro-exec-ring-item (car kmacro-view-last-item) arg))
705 ((and arg (listp arg))
706 (kmacro-call-ring-2nd 1))
708 (kmacro-call-macro arg no-repeat))))
711 (defun kmacro-end-or-call-macro-repeat (arg)
712 "As `kmacro-end-or-call-macro' but allows repeat without repeating prefix."
713 (interactive "P")
714 (let ((keys (kmacro-get-repeat-prefix)))
715 (kmacro-end-or-call-macro arg t)
716 (if keys
717 (kmacro-repeat-on-last-key keys))))
719 (put 'kmacro-end-or-call-macro-repeat 'kmacro-repeat 'head)
722 ;;;###autoload
723 (defun kmacro-end-and-call-macro (arg &optional no-repeat)
724 "Call last keyboard macro, ending it first if currently being defined.
725 With numeric prefix ARG, repeat macro that many times.
726 Zero argument means repeat until there is an error.
728 To give a macro a name, so you can call it even after defining other
729 macros, use \\[kmacro-name-last-macro]."
730 (interactive "P")
731 (if defining-kbd-macro
732 (kmacro-end-macro nil))
733 (kmacro-call-macro arg no-repeat))
736 ;;;###autoload
737 (defun kmacro-end-call-mouse (event)
738 "Move point to the position clicked with the mouse and call last kbd macro.
739 If kbd macro currently being defined end it before activating it."
740 (interactive "e")
741 (when defining-kbd-macro
742 (end-kbd-macro))
743 (mouse-set-point event)
744 (kmacro-call-macro nil t))
747 ;;; Misc. commands
749 ;; An idea for macro bindings:
750 ;; Create a separate keymap installed as a minor-mode keymap (e.g. in
751 ;; the emulation-mode-map-alists) in which macro bindings are made
752 ;; independent of any other bindings. When first binding is made,
753 ;; the keymap is created, installed, and enabled. Key seq. C-x C-k +
754 ;; can then be used to toggle the use of this keymap on and off.
755 ;; This means that it would be safe(r) to bind ordinary keys like
756 ;; letters and digits, provided that we inhibit the keymap while
757 ;; executing the macro later on (but that's controversial...)
759 (defun kmacro-lambda-form (mac &optional counter format)
760 "Create lambda form for macro bound to symbol or key."
761 (if counter
762 (setq mac (list mac counter format)))
763 `(lambda (&optional arg)
764 "Keyboard macro."
765 (interactive "p")
766 (kmacro-exec-ring-item ',mac arg)))
768 (defun kmacro-extract-lambda (mac)
769 "Extract kmacro from a kmacro lambda form."
770 (and (eq (car-safe mac) 'lambda)
771 (setq mac (assoc 'kmacro-exec-ring-item mac))
772 (setq mac (car-safe (cdr-safe (car-safe (cdr-safe mac)))))
773 (listp mac)
774 (= (length mac) 3)
775 (arrayp (car mac))
776 mac))
779 (defalias 'kmacro-p #'kmacro-extract-lambda
780 "Return non-nil if MAC is a kmacro keyboard macro.")
782 (defun kmacro-bind-to-key (_arg)
783 "When not defining or executing a macro, offer to bind last macro to a key.
784 The key sequences [C-x C-k 0] through [C-x C-k 9] and [C-x C-k A]
785 through [C-x C-k Z] are reserved for user bindings, and to bind to
786 one of these sequences, just enter the digit or letter, rather than
787 the whole sequence.
789 You can bind to any valid key sequence, but if you try to bind to
790 a key with an existing command binding, you will be asked for
791 confirmation whether to replace that binding. Note that the
792 binding is made in the `global-map' keymap, so the macro binding
793 may be shaded by a local key binding.
794 The ARG parameter is unused."
795 (interactive "p")
796 (if (or defining-kbd-macro executing-kbd-macro)
797 (if defining-kbd-macro
798 (message "Cannot save macro while defining it."))
799 (unless last-kbd-macro
800 (error "No keyboard macro defined"))
801 (let ((key-seq (read-key-sequence "Bind last macro to key: "))
802 ok cmd)
803 (when (= (length key-seq) 1)
804 (let ((ch (aref key-seq 0)))
805 (if (and (integerp ch)
806 (or (and (>= ch ?0) (<= ch ?9))
807 (and (>= ch ?A) (<= ch ?Z))))
808 (setq key-seq (concat "\C-x\C-k" key-seq)
809 ok t))))
810 (when (and (not (equal key-seq "\a"))
811 (or ok
812 (not (setq cmd (key-binding key-seq)))
813 (stringp cmd)
814 (vectorp cmd)
815 (yes-or-no-p (format "%s runs command %S. Bind anyway? "
816 (format-kbd-macro key-seq)
817 cmd))))
818 (define-key global-map key-seq
819 (kmacro-lambda-form (kmacro-ring-head)))
820 (message "Keyboard macro bound to %s" (format-kbd-macro key-seq))))))
822 (defun kmacro-keyboard-macro-p (symbol)
823 "Return non-nil if SYMBOL is the name of some sort of keyboard macro."
824 (let ((f (symbol-function symbol)))
825 (when f
826 (or (stringp f)
827 (vectorp f)
828 (kmacro-p f)))))
830 (defun kmacro-name-last-macro (symbol)
831 "Assign a name to the last keyboard macro defined.
832 Argument SYMBOL is the name to define.
833 The symbol's function definition becomes the keyboard macro string.
834 Such a \"function\" cannot be called from Lisp, but it is a valid editor command."
835 (interactive "SName for last kbd macro: ")
836 (or last-kbd-macro
837 (error "No keyboard macro defined"))
838 (and (fboundp symbol)
839 (not (kmacro-keyboard-macro-p symbol))
840 (error "Function %s is already defined and not a keyboard macro"
841 symbol))
842 (if (string-equal symbol "")
843 (error "No command name given"))
844 ;; FIXME: Use plain old `last-kbd-macro' for kmacros where it doesn't
845 ;; make a difference?
846 (fset symbol (kmacro-lambda-form (kmacro-ring-head)))
847 ;; This used to be used to detect when a symbol corresponds to a kmacro.
848 ;; Nowadays it's unused because we used `kmacro-p' instead to see if the
849 ;; symbol's function definition matches that of a kmacro, which is more
850 ;; reliable.
851 (put symbol 'kmacro t))
854 (defun kmacro-execute-from-register (k)
855 (kmacro-call-macro current-prefix-arg nil nil k))
857 (defun kmacro-to-register (r)
858 "Store the last keyboard macro in register R.
860 Interactively, reads the register using `register-read-with-preview'."
861 (interactive
862 (progn
863 (or last-kbd-macro (error "No keyboard macro defined"))
864 (list (register-read-with-preview "Save to register: "))))
865 (set-register r (registerv-make
866 last-kbd-macro
867 :jump-func 'kmacro-execute-from-register
868 :print-func (lambda (k)
869 (princ (format "a keyboard macro:\n %s"
870 (format-kbd-macro k))))
871 :insert-func (lambda (k)
872 (insert (format-kbd-macro k))))))
875 (defun kmacro-view-macro (&optional _arg)
876 "Display the last keyboard macro.
877 If repeated, it shows previous elements in the macro ring.
878 The ARG parameter is unused."
879 (interactive)
880 (cond
881 ((or (kmacro-ring-empty-p)
882 (not (eq last-command 'kmacro-view-macro)))
883 (setq kmacro-view-last-item nil))
884 ((null kmacro-view-last-item)
885 (setq kmacro-view-last-item kmacro-ring
886 kmacro-view-item-no 2))
887 ((consp kmacro-view-last-item)
888 (setq kmacro-view-last-item (cdr kmacro-view-last-item)
889 kmacro-view-item-no (1+ kmacro-view-item-no)))
891 (setq kmacro-view-last-item nil)))
892 (setq this-command 'kmacro-view-macro
893 last-command this-command) ;; in case we repeat
894 (kmacro-display (if kmacro-view-last-item
895 (car (car kmacro-view-last-item))
896 last-kbd-macro)
898 (if kmacro-view-last-item
899 (concat (cond ((= kmacro-view-item-no 2) "2nd")
900 ((= kmacro-view-item-no 3) "3nd")
901 (t (format "%dth" kmacro-view-item-no)))
902 " previous macro")
903 "Last macro")))
905 (defun kmacro-view-macro-repeat (&optional arg)
906 "Display the last keyboard macro.
907 If repeated, it shows previous elements in the macro ring.
908 To execute the displayed macro ring item without changing the macro ring,
909 just enter C-k.
910 This is like `kmacro-view-macro', but allows repeating macro commands
911 without repeating the prefix."
912 (interactive)
913 (let ((keys (kmacro-get-repeat-prefix)))
914 (kmacro-view-macro arg)
915 (if (and last-kbd-macro keys)
916 (kmacro-repeat-on-last-key keys))))
918 (put 'kmacro-view-macro-repeat 'kmacro-repeat 'ring)
921 (defun kmacro-edit-macro-repeat (&optional arg)
922 "Edit last keyboard macro."
923 (interactive "P")
924 (edit-kbd-macro "\r" arg))
926 (put 'kmacro-edit-macro-repeat 'kmacro-repeat 'stop)
929 (defun kmacro-edit-macro (&optional arg)
930 "As edit last keyboard macro, but without kmacro-repeat property."
931 (interactive "P")
932 (edit-kbd-macro "\r" arg))
935 (defun kmacro-edit-lossage ()
936 "Edit most recent 300 keystrokes as a keyboard macro."
937 (interactive)
938 (kmacro-push-ring)
939 (edit-kbd-macro "\C-hl"))
942 ;;; Single-step editing of keyboard macros
944 (defvar kmacro-step-edit-active nil) ;; step-editing active
945 (defvar kmacro-step-edit-new-macro) ;; storage for new macro
946 (defvar kmacro-step-edit-inserting) ;; inserting into macro
947 (defvar kmacro-step-edit-appending) ;; append to end of macro
948 (defvar kmacro-step-edit-replace) ;; replace orig macro when done
949 (defvar kmacro-step-edit-key-index) ;; index of current key
950 (defvar kmacro-step-edit-action) ;; automatic action on next pre-command hook
951 (defvar kmacro-step-edit-help) ;; kmacro step edit help enabled
952 (defvar kmacro-step-edit-num-input-keys) ;; to ignore duplicate pre-command hook
954 (defvar kmacro-step-edit-map
955 (let ((map (make-sparse-keymap)))
956 ;; query-replace-map answers include: `act', `skip', `act-and-show',
957 ;; `exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
958 ;; `automatic', `backup', `exit-prefix', and `help'.")
959 ;; Also: `quit', `edit-replacement'
961 (set-keymap-parent map query-replace-map)
963 (define-key map "\t" 'act-repeat)
964 (define-key map [tab] 'act-repeat)
965 (define-key map "\C-k" 'skip-rest)
966 (define-key map "c" 'automatic)
967 (define-key map "f" 'skip-keep)
968 (define-key map "q" 'quit)
969 (define-key map "d" 'skip)
970 (define-key map "\C-d" 'skip)
971 (define-key map "i" 'insert)
972 (define-key map "I" 'insert-1)
973 (define-key map "r" 'replace)
974 (define-key map "R" 'replace-1)
975 (define-key map "a" 'append)
976 (define-key map "A" 'append-end)
977 map)
978 "Keymap that defines the responses to questions in `kmacro-step-edit-macro'.
979 This keymap is an extension to the `query-replace-map', allowing the
980 following additional answers: `insert', `insert-1', `replace', `replace-1',
981 `append', `append-end', `act-repeat', `skip-end', `skip-keep'.")
983 (defun kmacro-step-edit-prompt (macro index)
984 ;; Show step-edit prompt
985 (let ((keys (and (not kmacro-step-edit-appending)
986 index (substring macro index executing-kbd-macro-index)))
987 (future (and (not kmacro-step-edit-appending)
988 (substring macro executing-kbd-macro-index)))
989 (message-log-max nil)
990 (curmsg (current-message)))
992 ;; TODO: Scroll macro if max-mini-window-height is too small.
993 (message "%s"
994 (concat
995 (format "Macro: %s%s%s%s%s\n"
996 (format-kbd-macro kmacro-step-edit-new-macro 1)
997 (if (and kmacro-step-edit-new-macro (> (length kmacro-step-edit-new-macro) 0)) " " "")
998 (propertize (if keys (format-kbd-macro keys)
999 (if kmacro-step-edit-appending "<APPEND>" "<INSERT>")) 'face 'region)
1000 (if future " " "")
1001 (if future (format-kbd-macro future) ""))
1002 (cond
1003 ((minibufferp)
1004 (format "%s\n%s\n"
1005 (propertize "\
1006 minibuffer " 'face 'header-line)
1007 (buffer-substring (point-min) (point-max))))
1008 (curmsg
1009 (format "%s\n%s\n"
1010 (propertize "\
1011 echo area " 'face 'header-line)
1012 curmsg))
1013 (t ""))
1014 (if keys
1015 (format "%s\n%s%s %S [yn iIaArR C-k kq!] "
1016 (propertize "\
1017 --------------Step Edit Keyboard Macro [?: help]---------------" 'face 'mode-line)
1018 (if kmacro-step-edit-help "\
1019 Step: y/SPC: execute next, d/n/DEL: skip next, f: skip but keep
1020 TAB: execute while same, ?: toggle help
1021 Edit: i: insert, r: replace, a: append, A: append at end,
1022 I/R: insert/replace with one sequence,
1023 End: !/c: execute rest, C-k: skip rest and save, q/C-g: quit
1024 ----------------------------------------------------------------
1025 " "")
1026 (propertize "Next command:" 'face 'bold)
1027 this-command)
1028 (propertize
1029 (format "Type key sequence%s to insert and execute%s: "
1030 (if (numberp kmacro-step-edit-inserting) "" "s")
1031 (if (numberp kmacro-step-edit-inserting) "" " (end with C-j)"))
1032 'face 'bold))))))
1034 (defun kmacro-step-edit-query ()
1035 ;; Pre-command hook function for step-edit in "command" mode
1036 (let ((resize-mini-windows t)
1037 (max-mini-window-height kmacro-step-edit-mini-window-height)
1038 act restore-index next-index)
1040 ;; Handle commands which reads additional input using read-char.
1041 (cond
1042 ((and (eq this-command 'quoted-insert)
1043 (not (eq kmacro-step-edit-action t)))
1044 ;; Find the actual end of this key sequence.
1045 ;; Must be able to backtrack in case we actually execute it.
1046 (setq restore-index executing-kbd-macro-index)
1047 (let (unread-command-events)
1048 (quoted-insert 0)
1049 (when unread-command-events
1050 (setq executing-kbd-macro-index (- executing-kbd-macro-index (length unread-command-events))
1051 next-index executing-kbd-macro-index)))))
1053 ;; Query the user; stop macro execution temporarily.
1054 (let ((macro executing-kbd-macro)
1055 (executing-kbd-macro nil)
1056 (defining-kbd-macro nil))
1058 ;; Any action requested by previous command
1059 (cond
1060 ((eq kmacro-step-edit-action t) ;; Reentry for actual command @ end of prefix arg.
1061 (cond
1062 ((eq this-command 'quoted-insert)
1063 (clear-this-command-keys) ;; recent-keys actually
1064 (let (unread-command-events)
1065 (quoted-insert (prefix-numeric-value current-prefix-arg))
1066 (setq kmacro-step-edit-new-macro
1067 (vconcat kmacro-step-edit-new-macro (recent-keys)))
1068 (when unread-command-events
1069 (setq kmacro-step-edit-new-macro
1070 (substring kmacro-step-edit-new-macro 0 (- (length unread-command-events)))
1071 executing-kbd-macro-index (- executing-kbd-macro-index (length unread-command-events)))))
1072 (setq current-prefix-arg nil
1073 prefix-arg nil)
1074 (setq act 'ignore))
1076 (setq act 'act)))
1077 (setq kmacro-step-edit-action nil))
1078 ((eq this-command kmacro-step-edit-action) ;; TAB -> activate while same command
1079 (setq act 'act))
1081 (setq kmacro-step-edit-action nil)))
1083 ;; Handle prefix arg, or query user
1084 (cond
1085 (act act) ;; set above
1087 (kmacro-step-edit-prompt macro kmacro-step-edit-key-index)
1088 (setq act (lookup-key kmacro-step-edit-map
1089 (vector (with-current-buffer (current-buffer) (read-event))))))))
1091 ;; Resume macro execution and perform the action
1092 (cond
1093 ((cond
1094 ((eq act 'act)
1096 ((eq act 'act-repeat)
1097 (setq kmacro-step-edit-action this-command)
1099 ((eq act 'quit)
1100 (setq kmacro-step-edit-replace nil)
1101 (setq kmacro-step-edit-active 'ignore)
1102 nil)
1103 ((eq act 'skip)
1104 nil)
1105 ((eq act 'skip-keep)
1106 (setq this-command 'ignore)
1108 ((eq act 'skip-rest)
1109 (setq kmacro-step-edit-active 'ignore)
1110 nil)
1111 ((memq act '(automatic exit))
1112 (setq kmacro-step-edit-active nil)
1113 (setq act t)
1115 ((member act '(insert-1 insert))
1116 (setq executing-kbd-macro-index kmacro-step-edit-key-index)
1117 (setq kmacro-step-edit-inserting (if (eq act 'insert-1) 1 t))
1118 nil)
1119 ((member act '(replace-1 replace))
1120 (setq kmacro-step-edit-inserting (if (eq act 'replace-1) 1 t))
1121 (if (= executing-kbd-macro-index (length executing-kbd-macro))
1122 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1123 kmacro-step-edit-appending t))
1124 nil)
1125 ((eq act 'append)
1126 (setq kmacro-step-edit-inserting t)
1127 (if (= executing-kbd-macro-index (length executing-kbd-macro))
1128 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1129 kmacro-step-edit-appending t))
1131 ((eq act 'append-end)
1132 (if (= executing-kbd-macro-index (length executing-kbd-macro))
1133 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1134 kmacro-step-edit-inserting t
1135 kmacro-step-edit-appending t)
1136 (setq kmacro-step-edit-active 'append-end))
1137 (setq act t)
1139 ((eq act 'help)
1140 (setq executing-kbd-macro-index kmacro-step-edit-key-index)
1141 (setq kmacro-step-edit-help (not kmacro-step-edit-help))
1142 nil)
1143 (t ;; Ignore unknown responses
1144 (setq executing-kbd-macro-index kmacro-step-edit-key-index)
1145 nil))
1146 (if (> executing-kbd-macro-index kmacro-step-edit-key-index)
1147 (setq kmacro-step-edit-new-macro
1148 (vconcat kmacro-step-edit-new-macro
1149 (substring executing-kbd-macro
1150 kmacro-step-edit-key-index
1151 (if (eq act t) nil
1152 executing-kbd-macro-index)))))
1153 (if restore-index
1154 (setq executing-kbd-macro-index restore-index)))
1156 (setq this-command 'ignore)))
1157 (setq kmacro-step-edit-key-index next-index)))
1159 (defun kmacro-step-edit-insert ()
1160 ;; Pre-command hook function for step-edit in "insert" mode
1161 (let ((resize-mini-windows t)
1162 (max-mini-window-height kmacro-step-edit-mini-window-height)
1163 (macro executing-kbd-macro)
1164 (executing-kbd-macro nil)
1165 (defining-kbd-macro nil)
1166 cmd keys next-index)
1167 (setq executing-kbd-macro-index kmacro-step-edit-key-index)
1168 (kmacro-step-edit-prompt macro nil)
1169 ;; Now, we have read a key sequence from the macro, but we don't want
1170 ;; to execute it yet. So push it back and read another sequence.
1171 (setq keys (read-key-sequence nil nil nil nil t))
1172 (setq cmd (key-binding keys t nil))
1173 (if (cond
1174 ((null cmd)
1176 ((eq cmd 'quoted-insert)
1177 (clear-this-command-keys) ;; recent-keys actually
1178 (quoted-insert (prefix-numeric-value current-prefix-arg))
1179 (setq current-prefix-arg nil
1180 prefix-arg nil)
1181 (setq keys (vconcat keys (recent-keys)))
1182 (when (numberp kmacro-step-edit-inserting)
1183 (setq kmacro-step-edit-inserting nil)
1184 (when unread-command-events
1185 (setq keys (substring keys 0 (- (length unread-command-events)))
1186 executing-kbd-macro-index (- executing-kbd-macro-index (length unread-command-events))
1187 next-index executing-kbd-macro-index
1188 unread-command-events nil)))
1189 (setq cmd 'ignore)
1190 nil)
1191 ((numberp kmacro-step-edit-inserting)
1192 (setq kmacro-step-edit-inserting nil)
1193 nil)
1194 ((equal keys "\C-j")
1195 (setq kmacro-step-edit-inserting nil)
1196 (setq kmacro-step-edit-action nil)
1197 (setq next-index kmacro-step-edit-key-index)
1199 (t nil))
1200 (setq this-command 'ignore)
1201 (setq this-command cmd)
1202 (if (memq this-command '(self-insert-command digit-argument))
1203 (setq last-command-event (aref keys (1- (length keys)))))
1204 (if keys
1205 (setq kmacro-step-edit-new-macro (vconcat kmacro-step-edit-new-macro keys))))
1206 (setq kmacro-step-edit-key-index next-index)))
1208 (defun kmacro-step-edit-pre-command ()
1209 (remove-hook 'post-command-hook #'kmacro-step-edit-post-command)
1210 (when kmacro-step-edit-active
1211 (cond
1212 ((eq kmacro-step-edit-active 'ignore)
1213 (setq this-command 'ignore))
1214 ((eq kmacro-step-edit-active 'append-end)
1215 (if (= executing-kbd-macro-index (length executing-kbd-macro))
1216 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1217 kmacro-step-edit-inserting t
1218 kmacro-step-edit-appending t
1219 kmacro-step-edit-active t)))
1220 ((/= kmacro-step-edit-num-input-keys num-input-keys)
1221 (if kmacro-step-edit-inserting
1222 (kmacro-step-edit-insert)
1223 (kmacro-step-edit-query))
1224 (setq kmacro-step-edit-num-input-keys num-input-keys)
1225 (if (and kmacro-step-edit-appending (not kmacro-step-edit-inserting))
1226 (setq kmacro-step-edit-appending nil
1227 kmacro-step-edit-active 'ignore)))))
1228 (when (eq kmacro-step-edit-active t)
1229 (add-hook 'post-command-hook #'kmacro-step-edit-post-command t)))
1231 (defun kmacro-step-edit-minibuf-setup ()
1232 (remove-hook 'pre-command-hook #'kmacro-step-edit-pre-command t)
1233 (when kmacro-step-edit-active
1234 (add-hook 'pre-command-hook #'kmacro-step-edit-pre-command nil t)))
1236 (defun kmacro-step-edit-post-command ()
1237 (remove-hook 'pre-command-hook #'kmacro-step-edit-pre-command)
1238 (when kmacro-step-edit-active
1239 (add-hook 'pre-command-hook #'kmacro-step-edit-pre-command nil nil)
1240 (if kmacro-step-edit-key-index
1241 (setq executing-kbd-macro-index kmacro-step-edit-key-index)
1242 (setq kmacro-step-edit-key-index executing-kbd-macro-index))))
1245 (defun kmacro-step-edit-macro ()
1246 "Step edit and execute last keyboard macro.
1248 To customize possible responses, change the \"bindings\" in `kmacro-step-edit-map'."
1249 (interactive)
1250 (let ((kmacro-step-edit-active t)
1251 (kmacro-step-edit-new-macro "")
1252 (kmacro-step-edit-inserting nil)
1253 (kmacro-step-edit-appending nil)
1254 (kmacro-step-edit-replace t)
1255 (kmacro-step-edit-key-index 0)
1256 (kmacro-step-edit-action nil)
1257 (kmacro-step-edit-help nil)
1258 (kmacro-step-edit-num-input-keys num-input-keys)
1259 (pre-command-hook pre-command-hook)
1260 (post-command-hook post-command-hook)
1261 (minibuffer-setup-hook minibuffer-setup-hook))
1262 (add-hook 'pre-command-hook #'kmacro-step-edit-pre-command nil)
1263 (add-hook 'post-command-hook #'kmacro-step-edit-post-command t)
1264 (add-hook 'minibuffer-setup-hook #'kmacro-step-edit-minibuf-setup t)
1265 (call-last-kbd-macro nil nil)
1266 (when (and kmacro-step-edit-replace
1267 kmacro-step-edit-new-macro
1268 (not (equal last-kbd-macro kmacro-step-edit-new-macro)))
1269 (kmacro-push-ring)
1270 (setq last-kbd-macro kmacro-step-edit-new-macro))))
1272 (provide 'kmacro)
1274 ;;; kmacro.el ends here