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