*** empty log message ***
[bpt/emacs.git] / lisp / kmacro.el
CommitLineData
c30c4abe
KS
1;;; kmacro.el --- enhanced keyboard macros
2
1b25dccd 3;; Copyright (C) 2002, 2003, 2004 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
22;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23;; Boston, MA 02111-1307, USA.
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)))
352 (let ((len (length kmacro-ring)))
353 (setq kmacro-ring (cons elt kmacro-ring))
354 (if (>= len kmacro-ring-max)
355 (setcdr (nthcdr len kmacro-ring) nil)))))
356
357
358(defun kmacro-split-ring-element (elt)
359 (setq last-kbd-macro (car elt)
360 kmacro-counter (nth 1 elt)
361 kmacro-counter-format-start (nth 2 elt)))
362
363
364(defun kmacro-pop-ring1 (&optional raw)
365 "Pop head element off macro ring (no check).
366Non-nil arg RAW means just return raw first element."
367 (prog1 (car kmacro-ring)
368 (unless raw
369 (kmacro-split-ring-element (car kmacro-ring)))
370 (setq kmacro-ring (cdr kmacro-ring))))
371
372
373(defun kmacro-pop-ring (&optional raw)
374 "Pop head element off macro ring.
375Non-nil arg RAW means just return raw first element."
376 (unless (kmacro-ring-empty-p)
377 (kmacro-pop-ring1 raw)))
f1180544 378
1fa13bd4
KS
379
380(defun kmacro-ring-length ()
381 "Return length of macro ring, including pseudo head."
382 (+ (if last-kbd-macro 1 0) (length kmacro-ring)))
383
384
385(defun kmacro-ring-empty-p (&optional none)
386 "Tell user and return t if `last-kbd-macro' is nil or `kmacro-ring' is empty.
387Check only `last-kbd-macro' if optional arg NONE is non-nil."
388 (while (and (null last-kbd-macro) kmacro-ring)
389 (kmacro-pop-ring1))
390 (cond
391 ((null last-kbd-macro)
392 (message "No keyboard macro defined.")
393 t)
394 ((and (null none) (null kmacro-ring))
395 (message "Only one keyboard macro defined.")
396 t)
397 (t nil)))
398
399
a1839f06
KS
400(defun kmacro-display (macro &optional trunc descr empty)
401 "Display a keyboard MACRO.
402Optional arg TRUNC non-nil specifies to limit width of macro to 60 chars.
403Optional arg DESCR is descriptive text for macro; default is \"Macro:\".
404Optional arg EMPTY is message to print if no macros are defined."
1fa13bd4
KS
405 (if macro
406 (let* ((x 60)
407 (m (format-kbd-macro macro))
408 (l (length m))
7dcb2dfd
LT
409 (z (and trunc (> l x))))
410 (message "%s%s: %s%s" (or descr "Macro")
411 (if (= kmacro-counter 0) ""
412 (format " [%s]"
413 (format kmacro-counter-format-start kmacro-counter)))
414 (if z (substring m 0 (1- x)) m) (if z "..." "")))
1fa13bd4
KS
415 (message (or empty "No keyboard macros defined"))))
416
417
c8bf445e
KS
418(defun kmacro-repeat-on-last-key (keys)
419 "Process kmacro commands keys immidiately after cycling the ring."
420 (setq keys (vconcat keys))
421 (let ((n (1- (length keys)))
422 cmd done repeat)
423 (while (and last-kbd-macro
424 (not done)
425 (aset keys n (read-event))
426 (setq cmd (key-binding keys t))
427 (setq repeat (get cmd 'kmacro-repeat)))
428 (clear-this-command-keys t)
429 (cond
430 ((eq repeat 'ring)
431 (if kmacro-ring
432 (let ((kmacro-repeat-no-prefix nil))
433 (funcall cmd nil))
434 (kmacro-display last-kbd-macro t)))
435 ((eq repeat 'head)
436 (let ((kmacro-repeat-no-prefix nil))
437 (funcall cmd nil)))
438 ((eq repeat 'stop)
439 (funcall cmd nil)
440 (setq done t)))
441 (setq last-input-event nil)))
442 (when last-input-event
443 (clear-this-command-keys t)
444 (setq unread-command-events (list last-input-event))))
445
446
447(defun kmacro-get-repeat-prefix ()
448 (let (keys)
449 (and kmacro-repeat-no-prefix
450 (setq keys (this-single-command-keys))
451 (> (length keys) 1)
452 keys)))
453
454
a1839f06
KS
455(defun kmacro-exec-ring-item (item arg)
456 "Execute item ITEM from the macro ring."
457 ;; Use counter and format specific to the macro on the ring!
458 (let ((kmacro-counter (nth 1 item))
459 (kmacro-counter-format-start (nth 2 item)))
460 (execute-kbd-macro (car item) arg #'kmacro-loop-setup-function)
461 (setcar (cdr item) kmacro-counter)))
462
463
1fa13bd4
KS
464(defun kmacro-call-ring-2nd (arg)
465 "Execute second keyboard macro at in macro ring."
466 (interactive "P")
467 (unless (kmacro-ring-empty-p)
a1839f06 468 (kmacro-exec-ring-item (car kmacro-ring) arg)))
1fa13bd4
KS
469
470
c8bf445e 471(defun kmacro-call-ring-2nd-repeat (arg)
a1839f06
KS
472 "Execute second keyboard macro at in macro ring.
473This is like `kmacro-call-ring-2nd', but allows repeating macro commands
474without repeating the prefix."
1fa13bd4 475 (interactive "P")
c8bf445e
KS
476 (let ((keys (kmacro-get-repeat-prefix)))
477 (kmacro-call-ring-2nd arg)
478 (if (and kmacro-ring keys)
479 (kmacro-repeat-on-last-key keys))))
1fa13bd4 480
c8bf445e 481(put 'kmacro-call-ring-2nd-repeat 'kmacro-repeat 'head)
1fa13bd4 482
c30c4abe 483
1fa13bd4
KS
484(defun kmacro-view-ring-2nd ()
485 "Display the current head of the keyboard macro ring."
486 (interactive)
487 (unless (kmacro-ring-empty-p)
488 (kmacro-display (car (car kmacro-ring)) "2nd macro")))
489
490
1fa13bd4
KS
491(defun kmacro-cycle-ring-next (&optional arg)
492 "Move to next keyboard macro in keyboard macro ring.
493Displays the selected macro in the echo area."
494 (interactive)
495 (unless (kmacro-ring-empty-p)
496 (kmacro-push-ring)
c8bf445e
KS
497 (let* ((keys (kmacro-get-repeat-prefix))
498 (len (length kmacro-ring))
1fa13bd4
KS
499 (tail (nthcdr (- len 2) kmacro-ring))
500 (elt (car (cdr tail))))
501 (setcdr tail nil)
c8bf445e
KS
502 (kmacro-split-ring-element elt)
503 (kmacro-display last-kbd-macro t)
504 (if keys
505 (kmacro-repeat-on-last-key keys)))))
1fa13bd4
KS
506
507(put 'kmacro-cycle-ring-next 'kmacro-repeat 'ring)
508
509
510(defun kmacro-cycle-ring-previous (&optional arg)
511 "Move to previous keyboard macro in keyboard macro ring.
512Displays the selected macro in the echo area."
513 (interactive)
514 (unless (kmacro-ring-empty-p)
c8bf445e
KS
515 (let ((keys (kmacro-get-repeat-prefix))
516 (cur (kmacro-ring-head)))
1fa13bd4
KS
517 (kmacro-pop-ring1)
518 (if kmacro-ring
519 (nconc kmacro-ring (list cur))
c8bf445e
KS
520 (setq kmacro-ring (list cur)))
521 (kmacro-display last-kbd-macro t)
522 (if keys
523 (kmacro-repeat-on-last-key keys)))))
1fa13bd4
KS
524
525(put 'kmacro-cycle-ring-previous 'kmacro-repeat 'ring)
c30c4abe 526
1fa13bd4
KS
527
528(defun kmacro-swap-ring ()
529 "Swap first two elements on keyboard macro ring."
530 (interactive)
531 (unless (kmacro-ring-empty-p)
532 (let ((cur (kmacro-ring-head)))
533 (kmacro-pop-ring1)
534 (kmacro-push-ring cur))
535 (kmacro-display last-kbd-macro t)))
536
537
538(defun kmacro-delete-ring-head (&optional arg)
539 "Delete current macro from keyboard macro ring."
540 (interactive)
541 (unless (kmacro-ring-empty-p t)
542 (if (null kmacro-ring)
543 (setq last-kbd-macro nil)
544 (kmacro-pop-ring))
545 (kmacro-display last-kbd-macro t nil "Keyboard macro ring is now empty.")))
546
547(put 'kmacro-delete-ring-head 'kmacro-repeat 'head)
548
549;;; Traditional bindings:
550
f1180544 551
1fa13bd4 552;;;###autoload
c30c4abe 553(defun kmacro-start-macro (arg)
1fa13bd4
KS
554 "Record subsequent keyboard input, defining a keyboard macro.
555The commands are recorded even as they are executed.
63b833de 556Use \\[kmacro-end-macro] to finish recording and make the macro available.
7fdc0c13 557Use \\[kmacro-end-and-call-macro] to execute the macro.
18d1e6c9
KS
558
559Non-nil arg (prefix arg) means append to last macro defined.
1fa13bd4
KS
560
561With \\[universal-argument] prefix, append to last keyboard macro
562defined. Depending on `kmacro-execute-before-append', this may begin
563by re-executing the last macro as if you typed it again.
564
565Otherwise, it sets `kmacro-counter' to ARG or 0 if missing before
566defining the macro.
567
568Use \\[kmacro-insert-counter] to insert (and increment) the macro counter.
569The counter value can be set or modified via \\[kmacro-set-counter] and \\[kmacro-add-counter].
18d1e6c9
KS
570The format of the counter can be modified via \\[kmacro-set-format].
571
572Use \\[kmacro-name-last-macro] to give it a permanent name.
573Use \\[kmacro-bind-to-key] to bind it to a key sequence."
1fa13bd4
KS
574 (interactive "P")
575 (if (or defining-kbd-macro executing-kbd-macro)
576 (message "Already defining keyboard macro.")
577 (let ((append (and arg (listp arg))))
578 (unless append
579 (if last-kbd-macro
580 (let ((len (length kmacro-ring)))
f1180544 581 (setq kmacro-ring
1fa13bd4
KS
582 (cons
583 (list last-kbd-macro kmacro-counter kmacro-counter-format-start)
584 kmacro-ring))
585 (if (>= len kmacro-ring-max)
586 (setcdr (nthcdr len kmacro-ring) nil))))
a1839f06
KS
587 (setq kmacro-counter (or (if arg (prefix-numeric-value arg))
588 kmacro-initial-counter-value
589 0)
590 kmacro-initial-counter-value nil
1fa13bd4
KS
591 kmacro-counter-value-start kmacro-counter
592 kmacro-last-counter kmacro-counter
7dcb2dfd
LT
593 kmacro-counter-format kmacro-default-counter-format
594 kmacro-counter-format-start kmacro-default-counter-format))
1fa13bd4 595
f1180544 596 (start-kbd-macro append
1fa13bd4
KS
597 (and append
598 (if kmacro-execute-before-append
599 (> (car arg) 4)
1b25dccd
KS
600 (= (car arg) 4))))
601 (if (and defining-kbd-macro append)
602 (setq defining-kbd-macro 'append)))))
1fa13bd4
KS
603
604
605;;;###autoload
606(defun kmacro-end-macro (arg)
607 "Finish defining a keyboard macro.
608The definition was started by \\[kmacro-start-macro].
609The macro is now available for use via \\[kmacro-call-macro],
18d1e6c9 610or it can be given a name with \\[kmacro-name-last-macro] and then invoked
1fa13bd4
KS
611under that name.
612
613With numeric arg, repeat macro now that many times,
614counting the definition just completed as the first repetition.
615An argument of zero means repeat until error."
616 (interactive "P")
617 (end-kbd-macro arg #'kmacro-loop-setup-function)
618 (when (and last-kbd-macro (= (length last-kbd-macro) 0))
619 (message "Ignore empty macro")
620 (kmacro-pop-ring)))
621
622
623;;;###autoload
c8bf445e 624(defun kmacro-call-macro (arg &optional no-repeat end-macro)
1fa13bd4 625 "Call the last keyboard macro that you defined with \\[kmacro-start-macro].
1fa13bd4
KS
626A prefix argument serves as a repeat count. Zero means repeat until error.
627
c8bf445e
KS
628When you call the macro, you can call the macro again by repeating
629just the last key in the key sequence that you used to call this
630command. See `kmacro-call-repeat-key' and `kmacro-call-repeat-with-arg'
631for details on how to adjust or disable this behaviour.
1fa13bd4 632
c8bf445e 633To make a macro permanent so you can call it even after defining
18d1e6c9 634others, use \\[kmacro-name-last-macro]."
c8bf445e
KS
635 (interactive "p")
636 (let ((repeat-key (and (null no-repeat)
637 (> (length (this-single-command-keys)) 1)
638 last-input-event))
639 repeat-key-str)
640 (if end-macro
641 (kmacro-end-macro arg)
642 (call-last-kbd-macro arg #'kmacro-loop-setup-function))
1698f788
MB
643 (when (consp arg)
644 (setq arg (car arg)))
c8bf445e
KS
645 (when (and (or (null arg) (> arg 0))
646 (setq repeat-key
1698f788
MB
647 (if (eq kmacro-call-repeat-key t)
648 repeat-key
649 kmacro-call-repeat-key)))
723d6a64 650 (setq repeat-key-str (format-kbd-macro (vector repeat-key) nil))
c8bf445e 651 (while repeat-key
f1180544 652 (message "(Type %s to repeat macro%s)"
1c59ca78 653 repeat-key-str
c8bf445e
KS
654 (if (and kmacro-call-repeat-with-arg
655 arg (> arg 1))
1c59ca78 656 (format " %d times" arg) ""))
c8bf445e
KS
657 (if (equal repeat-key (read-event))
658 (progn
659 (clear-this-command-keys t)
1698f788
MB
660 (call-last-kbd-macro (and kmacro-call-repeat-with-arg arg)
661 #'kmacro-loop-setup-function)
c8bf445e
KS
662 (setq last-input-event nil))
663 (setq repeat-key nil)))
664 (when last-input-event
665 (clear-this-command-keys t)
666 (setq unread-command-events (list last-input-event))))))
1fa13bd4
KS
667
668
669;;; Combined function key bindings:
670
671;;;###autoload
672(defun kmacro-start-macro-or-insert-counter (arg)
c8bf445e
KS
673 "Record subsequent keyboard input, defining a keyboard macro.
674The commands are recorded even as they are executed.
c30c4abe 675
c8bf445e
KS
676Sets the `kmacro-counter' to ARG (or 0 if no prefix arg) before defining the
677macro.
678
679With \\[universal-argument], appends to current keyboard macro (keeping
680the current value of `kmacro-counter').
681
682When defining/executing macro, inserts macro counter and increments
683the counter with ARG or 1 if missing. With \\[universal-argument],
684inserts previous kmacro-counter (but do not modify counter).
c30c4abe 685
1fa13bd4 686The macro counter can be modified via \\[kmacro-set-counter] and \\[kmacro-add-counter].
c30c4abe 687The format of the counter can be modified via \\[kmacro-set-format]."
1fa13bd4 688 (interactive "P")
c30c4abe 689 (if (or defining-kbd-macro executing-kbd-macro)
1fa13bd4
KS
690 (kmacro-insert-counter arg)
691 (kmacro-start-macro arg)))
c30c4abe 692
1fa13bd4
KS
693
694;;;###autoload
c8bf445e 695(defun kmacro-end-or-call-macro (arg &optional no-repeat)
c30c4abe 696 "End kbd macro if currently being defined; else call last kbd macro.
7e30f58e 697With numeric prefix ARG, repeat macro that many times.
1fa13bd4
KS
698With \\[universal-argument], call second macro in macro ring."
699 (interactive "P")
f1180544 700 (cond
c30c4abe 701 (defining-kbd-macro
c8bf445e
KS
702 (if kmacro-call-repeat-key
703 (kmacro-call-macro arg no-repeat t)
704 (kmacro-end-macro arg)))
a1839f06
KS
705 ((and (eq this-command 'kmacro-view-macro) ;; We are in repeat mode!
706 kmacro-view-last-item)
707 (kmacro-exec-ring-item (car kmacro-view-last-item) arg))
1fa13bd4
KS
708 ((and arg (listp arg))
709 (kmacro-call-ring-2nd 1))
c30c4abe 710 (t
c8bf445e 711 (kmacro-call-macro arg no-repeat))))
1fa13bd4
KS
712
713
c8bf445e
KS
714(defun kmacro-end-or-call-macro-repeat (arg)
715 "As `kmacro-end-or-call-macro' but allows repeat without repeating prefix."
1fa13bd4 716 (interactive "P")
c8bf445e
KS
717 (let ((keys (kmacro-get-repeat-prefix)))
718 (kmacro-end-or-call-macro arg t)
719 (if keys
720 (kmacro-repeat-on-last-key keys))))
1fa13bd4 721
c8bf445e 722(put 'kmacro-end-or-call-macro-repeat 'kmacro-repeat 'head)
c30c4abe 723
c30c4abe 724
723d6a64
KS
725;;;###autoload
726(defun kmacro-end-and-call-macro (arg &optional no-repeat)
727 "Call last keyboard macro, ending it first if currently being defined.
4231e11f
RS
728With numeric prefix ARG, repeat macro that many times.
729Zero argument means repeat until there is an error.
730
731To give a macro a permanent name, so you can call it
18d1e6c9 732even after defining other macros, use \\[kmacro-name-last-macro]."
723d6a64
KS
733 (interactive "P")
734 (if defining-kbd-macro
735 (kmacro-end-macro nil))
736 (kmacro-call-macro arg no-repeat))
737
738
1fa13bd4 739;;;###autoload
c30c4abe
KS
740(defun kmacro-end-call-mouse (event)
741 "Move point to the position clicked with the mouse and call last kbd macro.
742If kbd macro currently being defined end it before activating it."
743 (interactive "e")
744 (when defining-kbd-macro
1fa13bd4 745 (end-kbd-macro))
c30c4abe 746 (mouse-set-point event)
c8bf445e 747 (kmacro-call-macro nil t))
c30c4abe 748
1fa13bd4
KS
749
750;;; Misc. commands
751
a1839f06
KS
752;; An idea for macro bindings:
753;; Create a separate keymap installed as a minor-mode keymap (e.g. in
754;; the emulation-mode-map-alists) in which macro bindings are made
755;; independent of any other bindings. When first binding is made,
756;; the kemap is created, installed, and enabled. Key seq. C-x C-k +
757;; can then be used to toggle the use of this keymap on and off.
758;; This means that it would be safe(r) to bind ordinary keys like
759;; letters and digits, provided that we inhibit the keymap while
760;; executing the macro later on (but that's controversial...)
761
424e6532
KS
762(defun kmacro-lambda-form (mac &optional counter format)
763 "Create lambda form for macro bound to symbol or key."
764 (if counter
765 (setq mac (list mac counter format)))
766 `(lambda (&optional arg)
767 "Keyboard macro."
768 (interactive "p")
769 (kmacro-exec-ring-item ',mac arg)))
770
771(defun kmacro-extract-lambda (mac)
772 "Extract kmacro from a kmacro lambda form."
773 (and (consp mac)
774 (eq (car mac) 'lambda)
775 (setq mac (assoc 'kmacro-exec-ring-item mac))
776 (consp (cdr mac))
777 (consp (car (cdr mac)))
778 (consp (cdr (car (cdr mac))))
779 (setq mac (car (cdr (car (cdr mac)))))
780 (listp mac)
781 (= (length mac) 3)
782 (arrayp (car mac))
783 mac))
784
785
1fa13bd4 786(defun kmacro-bind-to-key (arg)
a1839f06
KS
787 "When not defining or executing a macro, offer to bind last macro to a key.
788The key sequences [C-x C-k 0] through [C-x C-k 9] and [C-x C-k A]
789through [C-x C-k Z] are reserved for user bindings, and to bind to
790one of these sequences, just enter the digit or letter, rather than
791the whole sequence.
792
793You can bind to any valid key sequence, but if you try to bind to
794a key with an existing command binding, you will be asked for
795confirmation whether to replace that binding. Note that the
796binding is made in the `global-map' keymap, so the macro binding
797may be shaded by a local key binding."
c30c4abe
KS
798 (interactive "p")
799 (if (or defining-kbd-macro executing-kbd-macro)
1fa13bd4
KS
800 (if defining-kbd-macro
801 (message "Cannot save macro while defining it."))
802 (unless last-kbd-macro
803 (error "No keyboard macro defined"))
a1839f06
KS
804 (let ((key-seq (read-key-sequence "Bind last macro to key: "))
805 ok cmd)
806 (when (= (length key-seq) 1)
807 (let ((ch (aref key-seq 0)))
808 (if (or (and (>= ch ?0) (<= ch ?9))
809 (and (>= ch ?A) (<= ch ?Z)))
810 (setq key-seq (concat "\C-x\C-k" key-seq)
811 ok t))))
812 (when (and (not (equal key-seq "\a"))
813 (or ok
814 (not (setq cmd (key-binding key-seq)))
815 (stringp cmd)
816 (vectorp cmd)
817 (yes-or-no-p (format "%s runs command %S. Bind anyway? "
818 (format-kbd-macro key-seq)
819 cmd))))
18d1e6c9 820 (define-key global-map key-seq
424e6532 821 (kmacro-lambda-form (kmacro-ring-head)))
a1839f06 822 (message "Keyboard macro bound to %s" (format-kbd-macro key-seq))))))
c30c4abe 823
c30c4abe 824
18d1e6c9
KS
825(defun kmacro-name-last-macro (symbol)
826 "Assign a name to the last keyboard macro defined.
827Argument SYMBOL is the name to define.
828The symbol's function definition becomes the keyboard macro string.
829Such a \"function\" cannot be called from Lisp, but it is a valid editor command."
830 (interactive "SName for last kbd macro: ")
831 (or last-kbd-macro
832 (error "No keyboard macro defined"))
833 (and (fboundp symbol)
834 (not (get symbol 'kmacro))
835 (not (stringp (symbol-function symbol)))
836 (not (vectorp (symbol-function symbol)))
837 (error "Function %s is already defined and not a keyboard macro"
838 symbol))
839 (if (string-equal symbol "")
840 (error "No command name given"))
424e6532 841 (fset symbol (kmacro-lambda-form (kmacro-ring-head)))
18d1e6c9
KS
842 (put symbol 'kmacro t))
843
844
1fa13bd4 845(defun kmacro-view-macro (&optional arg)
a1839f06
KS
846 "Display the last keyboard macro.
847If repeated, it shows previous elements in the macro ring."
1fa13bd4 848 (interactive)
a1839f06
KS
849 (cond
850 ((or (kmacro-ring-empty-p)
851 (not (eq last-command 'kmacro-view-macro)))
852 (setq kmacro-view-last-item nil))
853 ((null kmacro-view-last-item)
854 (setq kmacro-view-last-item kmacro-ring
855 kmacro-view-item-no 2))
856 ((consp kmacro-view-last-item)
857 (setq kmacro-view-last-item (cdr kmacro-view-last-item)
858 kmacro-view-item-no (1+ kmacro-view-item-no)))
859 (t
860 (setq kmacro-view-last-item nil)))
861 (setq this-command 'kmacro-view-macro
862 last-command this-command) ;; in case we repeat
863 (kmacro-display (if kmacro-view-last-item
864 (car (car kmacro-view-last-item))
865 last-kbd-macro)
866 nil
867 (if kmacro-view-last-item
868 (concat (cond ((= kmacro-view-item-no 2) "2nd")
869 ((= kmacro-view-item-no 3) "3nd")
870 (t (format "%dth" kmacro-view-item-no)))
871 " previous macro")
872 "Last macro")))
c30c4abe 873
c8bf445e 874(defun kmacro-view-macro-repeat (&optional arg)
a1839f06
KS
875 "Display the last keyboard macro.
876If repeated, it shows previous elements in the macro ring.
877To execute the displayed macro ring item without changing the macro ring,
878just enter C-k.
879This is like `kmacro-view-macro', but allows repeating macro commands
880without repeating the prefix."
c30c4abe 881 (interactive)
c8bf445e
KS
882 (let ((keys (kmacro-get-repeat-prefix)))
883 (kmacro-view-macro arg)
884 (if (and last-kbd-macro keys)
885 (kmacro-repeat-on-last-key keys))))
1fa13bd4 886
a1839f06 887(put 'kmacro-view-macro-repeat 'kmacro-repeat 'ring)
1fa13bd4 888
c8bf445e
KS
889
890(defun kmacro-edit-macro-repeat (&optional arg)
1fa13bd4
KS
891 "Edit last keyboard macro."
892 (interactive "P")
893 (edit-kbd-macro "\r" arg))
894
c8bf445e 895(put 'kmacro-edit-macro-repeat 'kmacro-repeat 'stop)
1fa13bd4
KS
896
897
c8bf445e 898(defun kmacro-edit-macro (&optional arg)
1fa13bd4
KS
899 "As edit last keyboard macro, but without kmacro-repeat property."
900 (interactive "P")
c8bf445e 901 (edit-kbd-macro "\r" arg))
1fa13bd4
KS
902
903
904(defun kmacro-edit-lossage ()
905 "Edit most recent 100 keystrokes as a keyboard macro."
906 (interactive)
907 (kmacro-push-ring)
908 (edit-kbd-macro "\C-hl"))
c30c4abe 909
c30c4abe 910
723d6a64
KS
911;;; Single-step editing of keyboard macros
912
913(defvar kmacro-step-edit-active) ;; step-editing active
914(defvar kmacro-step-edit-new-macro) ;; storage for new macro
915(defvar kmacro-step-edit-inserting) ;; inserting into macro
916(defvar kmacro-step-edit-appending) ;; append to end of macro
917(defvar kmacro-step-edit-replace) ;; replace orig macro when done
918(defvar kmacro-step-edit-prefix-index) ;; index of first prefix arg key
919(defvar kmacro-step-edit-key-index) ;; index of current key
920(defvar kmacro-step-edit-action) ;; automatic action on next pre-command hook
921(defvar kmacro-step-edit-help) ;; kmacro step edit help enabled
922(defvar kmacro-step-edit-num-input-keys) ;; to ignore duplicate pre-command hook
923
924(defvar kmacro-step-edit-map (make-sparse-keymap)
925 "Keymap that defines the responses to questions in `kmacro-step-edit-macro'.
926This keymap is an extension to the `query-replace-map', allowing the
1c59ca78
KS
927following additional answers: `insert', `insert-1', `replace', `replace-1',
928`append', `append-end', `act-repeat', `skip-end', `skip-keep'.")
723d6a64
KS
929
930;; query-replace-map answers include: `act', `skip', `act-and-show',
931;; `exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
932;; `automatic', `backup', `exit-prefix', and `help'.")
933;; Also: `quit', `edit-replacement'
934
935(set-keymap-parent kmacro-step-edit-map query-replace-map)
936
937(define-key kmacro-step-edit-map "\t" 'act-repeat)
938(define-key kmacro-step-edit-map [tab] 'act-repeat)
939(define-key kmacro-step-edit-map "\C-k" 'skip-rest)
940(define-key kmacro-step-edit-map "c" 'automatic)
941(define-key kmacro-step-edit-map "f" 'skip-keep)
942(define-key kmacro-step-edit-map "q" 'quit)
943(define-key kmacro-step-edit-map "d" 'skip)
5190c95e 944(define-key kmacro-step-edit-map "\C-d" 'skip)
723d6a64
KS
945(define-key kmacro-step-edit-map "i" 'insert)
946(define-key kmacro-step-edit-map "I" 'insert-1)
947(define-key kmacro-step-edit-map "r" 'replace)
948(define-key kmacro-step-edit-map "R" 'replace-1)
949(define-key kmacro-step-edit-map "a" 'append)
1c59ca78 950(define-key kmacro-step-edit-map "A" 'append-end)
723d6a64
KS
951
952(defvar kmacro-step-edit-prefix-commands
953 '(universal-argument universal-argument-more universal-argument-minus
954 digit-argument negative-argument)
955 "Commands which builds up a prefix arg for the current command")
956
957(defun kmacro-step-edit-prompt (macro index)
958 ;; Show step-edit prompt
959 (let ((keys (and (not kmacro-step-edit-appending)
960 index (substring macro index executing-macro-index)))
961 (future (and (not kmacro-step-edit-appending)
962 (substring macro executing-macro-index)))
963 (message-log-max nil)
964 (curmsg (current-message)))
965
966 ;; TODO: Scroll macro if max-mini-window-height is too small.
2b4b4feb
KS
967 (message "%s"
968 (concat
723d6a64
KS
969 (format "Macro: %s%s%s%s%s\n"
970 (format-kbd-macro kmacro-step-edit-new-macro 1)
971 (if (and kmacro-step-edit-new-macro (> (length kmacro-step-edit-new-macro) 0)) " " "")
f1180544 972 (propertize (if keys (format-kbd-macro keys)
723d6a64
KS
973 (if kmacro-step-edit-appending "<APPEND>" "<INSERT>")) 'face 'region)
974 (if future " " "")
975 (if future (format-kbd-macro future) ""))
976 (cond
977 ((minibufferp)
978 (format "%s\n%s\n"
979 (propertize "\
980 minibuffer " 'face 'header-line)
981 (buffer-substring (point-min) (point-max))))
982 (curmsg
983 (format "%s\n%s\n"
984 (propertize "\
985 echo area " 'face 'header-line)
986 curmsg))
987 (t ""))
988 (if keys
f1180544 989 (format "%s\n%s%s %S [yn iIaArR C-k kq!] "
723d6a64
KS
990 (propertize "\
991--------------Step Edit Keyboard Macro [?: help]---------------" 'face 'mode-line)
992 (if kmacro-step-edit-help "\
993 Step: y/SPC: execute next, d/n/DEL: skip next, f: skip but keep
994 TAB: execute while same, ?: toggle help
482b44d8
KS
995 Edit: i: insert, r: replace, a: append, A: append at end,
996 I/R: insert/replace with one sequence,
723d6a64
KS
997 End: !/c: execute rest, C-k: skip rest and save, q/C-g: quit
998----------------------------------------------------------------
999" "")
1000 (propertize "Next command:" 'face 'bold)
1001 this-command)
f1180544 1002 (propertize
723d6a64
KS
1003 (format "Type key sequence%s to insert and execute%s: "
1004 (if (numberp kmacro-step-edit-inserting) "" "s")
1c59ca78 1005 (if (numberp kmacro-step-edit-inserting) "" " (end with C-j)"))
723d6a64
KS
1006 'face 'bold))))))
1007
1008(defun kmacro-step-edit-query ()
1009 ;; Pre-command hook function for step-edit in "command" mode
1010 (let ((resize-mini-windows t)
1011 (max-mini-window-height kmacro-step-edit-mini-window-height)
1012 act restore-index next-index)
1013
1014 ;; Handle commands which reads additional input using read-char.
1015 (cond
1016 ((and (eq this-command 'quoted-insert)
1017 (not (eq kmacro-step-edit-action t)))
1018 ;; Find the actual end of this key sequence.
1019 ;; Must be able to backtrack in case we actually execute it.
1020 (setq restore-index executing-macro-index)
1021 (let (unread-command-events)
1022 (quoted-insert 0)
1023 (when unread-command-events
1024 (setq executing-macro-index (- executing-macro-index (length unread-command-events))
1025 next-index executing-macro-index)))))
1026
1027 ;; Query the user; stop macro exection temporarily
1028 (let ((macro executing-kbd-macro)
1029 (executing-kbd-macro nil)
1030 (defining-kbd-macro nil))
1031
1032 ;; Any action requested by previous command
1033 (cond
1034 ((eq kmacro-step-edit-action t) ;; Reentry for actual command @ end of prefix arg.
1035 (cond
1036 ((eq this-command 'quoted-insert)
1037 (clear-this-command-keys) ;; recent-keys actually
1038 (let (unread-command-events)
1039 (quoted-insert (prefix-numeric-value current-prefix-arg))
f1180544 1040 (setq kmacro-step-edit-new-macro
723d6a64
KS
1041 (vconcat kmacro-step-edit-new-macro (recent-keys)))
1042 (when unread-command-events
1043 (setq kmacro-step-edit-new-macro
1044 (substring kmacro-step-edit-new-macro 0 (- (length unread-command-events)))
1045 executing-macro-index (- executing-macro-index (length unread-command-events)))))
1046 (setq current-prefix-arg nil
1047 prefix-arg nil)
1048 (setq act 'ignore))
1049 (t
1050 (setq act 'act)))
1051 (setq kmacro-step-edit-action nil))
1052 ((eq this-command kmacro-step-edit-action) ;; TAB -> activate while same command
1053 (setq act 'act))
1054 (t
1055 (setq kmacro-step-edit-action nil)))
1056
1057 ;; Handle prefix arg, or query user
1058 (cond
1059 (act act) ;; set above
1060 ((memq this-command kmacro-step-edit-prefix-commands)
1061 (unless kmacro-step-edit-prefix-index
1062 (setq kmacro-step-edit-prefix-index kmacro-step-edit-key-index))
1063 (setq act 'universal-argument))
1064 ((eq this-command 'universal-argument-other-key)
1065 (setq act 'universal-argument))
1066 (t
1067 (kmacro-step-edit-prompt macro (or kmacro-step-edit-prefix-index kmacro-step-edit-key-index))
1068 (setq act (lookup-key kmacro-step-edit-map
1069 (vector (with-current-buffer (current-buffer) (read-event))))))))
1070
1071 ;; Resume macro execution and perform the action
1072 (cond
1073 ((eq act 'universal-argument)
1074 nil)
1075 ((cond
1076 ((eq act 'act)
1077 t)
1078 ((eq act 'act-repeat)
1079 (setq kmacro-step-edit-action this-command)
1080 t)
1081 ((eq act 'quit)
1082 (setq kmacro-step-edit-replace nil)
1083 (setq kmacro-step-edit-active 'ignore)
1084 nil)
1085 ((eq act 'skip)
1086 (setq kmacro-step-edit-prefix-index nil)
1087 nil)
1088 ((eq act 'skip-keep)
1089 (setq this-command 'ignore)
1090 t)
1091 ((eq act 'skip-rest)
1092 (setq kmacro-step-edit-active 'ignore)
1093 nil)
5190c95e 1094 ((memq act '(automatic exit))
723d6a64
KS
1095 (setq kmacro-step-edit-active nil)
1096 (setq act t)
1097 t)
1098 ((member act '(insert-1 insert))
1099 (setq executing-macro-index (or kmacro-step-edit-prefix-index kmacro-step-edit-key-index))
1100 (setq kmacro-step-edit-inserting (if (eq act 'insert-1) 1 t))
1101 nil)
1102 ((member act '(replace-1 replace))
1103 (setq kmacro-step-edit-inserting (if (eq act 'replace-1) 1 t))
1104 (setq kmacro-step-edit-prefix-index nil)
1105 (if (= executing-macro-index (length executing-kbd-macro))
1106 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1107 kmacro-step-edit-appending t))
1108 nil)
1c59ca78
KS
1109 ((eq act 'append)
1110 (setq kmacro-step-edit-inserting t)
723d6a64
KS
1111 (if (= executing-macro-index (length executing-kbd-macro))
1112 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1113 kmacro-step-edit-appending t))
1114 t)
1c59ca78
KS
1115 ((eq act 'append-end)
1116 (if (= executing-macro-index (length executing-kbd-macro))
1117 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1118 kmacro-step-edit-inserting t
1119 kmacro-step-edit-appending t)
1120 (setq kmacro-step-edit-active 'append-end))
1121 (setq act t)
1122 t)
723d6a64
KS
1123 ((eq act 'help)
1124 (setq executing-macro-index (or kmacro-step-edit-prefix-index kmacro-step-edit-key-index))
1125 (setq kmacro-step-edit-help (not kmacro-step-edit-help))
1126 nil)
1127 (t ;; Ignore unknown responses
1128 (setq executing-macro-index (or kmacro-step-edit-prefix-index kmacro-step-edit-key-index))
1129 nil))
1130 (if (> executing-macro-index (or kmacro-step-edit-prefix-index kmacro-step-edit-key-index))
1131 (setq kmacro-step-edit-new-macro
1132 (vconcat kmacro-step-edit-new-macro
f1180544 1133 (substring executing-kbd-macro
723d6a64
KS
1134 (or kmacro-step-edit-prefix-index kmacro-step-edit-key-index)
1135 (if (eq act t) nil executing-macro-index)))
1136 kmacro-step-edit-prefix-index nil))
1137 (if restore-index
1138 (setq executing-macro-index restore-index)))
1139 (t
1140 (setq this-command 'ignore)))
1141 (setq kmacro-step-edit-key-index next-index)))
1142
1143(defun kmacro-step-edit-insert ()
1144 ;; Pre-command hook function for step-edit in "insert" mode
1145 (let ((resize-mini-windows t)
1146 (max-mini-window-height kmacro-step-edit-mini-window-height)
1147 (macro executing-kbd-macro)
1148 (executing-kbd-macro nil)
1149 (defining-kbd-macro nil)
1150 cmd keys next-index)
1151 (setq executing-macro-index (or kmacro-step-edit-prefix-index kmacro-step-edit-key-index)
1152 kmacro-step-edit-prefix-index nil)
1153 (kmacro-step-edit-prompt macro nil)
1154 ;; Now, we have read a key sequence from the macro, but we don't want
1155 ;; to execute it yet. So push it back and read another sequence.
1156 (reset-this-command-lengths)
1157 (setq keys (read-key-sequence nil nil nil nil t))
1158 (setq cmd (key-binding keys t nil))
1159 (if (cond
1160 ((null cmd)
1161 t)
1162 ((eq cmd 'quoted-insert)
1163 (clear-this-command-keys) ;; recent-keys actually
1164 (quoted-insert (prefix-numeric-value current-prefix-arg))
1165 (setq current-prefix-arg nil
1166 prefix-arg nil)
1167 (setq keys (vconcat keys (recent-keys)))
1168 (when (numberp kmacro-step-edit-inserting)
1169 (setq kmacro-step-edit-inserting nil)
1170 (when unread-command-events
1171 (setq keys (substring keys 0 (- (length unread-command-events)))
1172 executing-macro-index (- executing-macro-index (length unread-command-events))
1173 next-index executing-macro-index
1174 unread-command-events nil)))
1175 (setq cmd 'ignore)
1176 nil)
1177 ((memq cmd kmacro-step-edit-prefix-commands)
1178 (setq universal-argument-num-events 0)
1179 (reset-this-command-lengths)
1180 nil)
1181 ((eq cmd 'universal-argument-other-key)
1182 (setq kmacro-step-edit-action t)
1183 (setq universal-argument-num-events 0)
1184 (reset-this-command-lengths)
1185 (if (numberp kmacro-step-edit-inserting)
1186 (setq kmacro-step-edit-inserting nil))
1187 nil)
1188 ((numberp kmacro-step-edit-inserting)
1189 (setq kmacro-step-edit-inserting nil)
1190 nil)
1191 ((equal keys "\C-j")
1192 (setq kmacro-step-edit-inserting nil)
1193 (setq kmacro-step-edit-action nil)
1194 ;; Forget any (partial) prefix arg from next command
1195 (setq kmacro-step-edit-prefix-index nil)
1196 (reset-this-command-lengths)
1197 (setq overriding-terminal-local-map nil)
1198 (setq universal-argument-num-events nil)
1199 (setq next-index kmacro-step-edit-key-index)
1200 t)
1201 (t nil))
1202 (setq this-command 'ignore)
1203 (setq this-command cmd)
1204 (if (memq this-command '(self-insert-command digit-argument))
1205 (setq last-command-char (aref keys (1- (length keys)))))
1206 (if keys
1207 (setq kmacro-step-edit-new-macro (vconcat kmacro-step-edit-new-macro keys))))
1208 (setq kmacro-step-edit-key-index next-index)))
1209
1210(defun kmacro-step-edit-pre-command ()
1211 (remove-hook 'post-command-hook 'kmacro-step-edit-post-command)
1212 (when kmacro-step-edit-active
1213 (cond
1214 ((eq kmacro-step-edit-active 'ignore)
1215 (setq this-command 'ignore))
1c59ca78
KS
1216 ((eq kmacro-step-edit-active 'append-end)
1217 (if (= executing-macro-index (length executing-kbd-macro))
1218 (setq executing-kbd-macro (vconcat executing-kbd-macro [nil])
1219 kmacro-step-edit-inserting t
1220 kmacro-step-edit-appending t
1221 kmacro-step-edit-active t)))
723d6a64
KS
1222 ((/= kmacro-step-edit-num-input-keys num-input-keys)
1223 (if kmacro-step-edit-inserting
1224 (kmacro-step-edit-insert)
1225 (kmacro-step-edit-query))
1226 (setq kmacro-step-edit-num-input-keys num-input-keys)
1227 (if (and kmacro-step-edit-appending (not kmacro-step-edit-inserting))
1228 (setq kmacro-step-edit-appending nil
1229 kmacro-step-edit-active 'ignore)))))
1230 (when (eq kmacro-step-edit-active t)
1231 (add-hook 'post-command-hook 'kmacro-step-edit-post-command t)))
1232
1233(defun kmacro-step-edit-minibuf-setup ()
1234 (remove-hook 'pre-command-hook 'kmacro-step-edit-pre-command t)
1235 (when kmacro-step-edit-active
1236 (add-hook 'pre-command-hook 'kmacro-step-edit-pre-command nil t)))
1237
1238(defun kmacro-step-edit-post-command ()
1239 (remove-hook 'pre-command-hook 'kmacro-step-edit-pre-command)
1240 (when kmacro-step-edit-active
1241 (add-hook 'pre-command-hook 'kmacro-step-edit-pre-command nil nil)
1242 (if kmacro-step-edit-key-index
1243 (setq executing-macro-index kmacro-step-edit-key-index)
f1180544 1244 (setq kmacro-step-edit-key-index executing-macro-index))))
723d6a64
KS
1245
1246
1247(defun kmacro-step-edit-macro ()
1248 "Step edit and execute last keyboard macro.
1249
1250To customize possible responses, change the \"bindings\" in `kmacro-step-edit-map'."
1251 (interactive)
1252 (let ((kmacro-step-edit-active t)
1253 (kmacro-step-edit-new-macro "")
1254 (kmacro-step-edit-inserting nil)
1255 (kmacro-step-edit-appending nil)
1256 (kmacro-step-edit-replace t)
1257 (kmacro-step-edit-prefix-index nil)
1258 (kmacro-step-edit-key-index 0)
1259 (kmacro-step-edit-action nil)
1260 (kmacro-step-edit-help nil)
1261 (kmacro-step-edit-num-input-keys num-input-keys)
1262 (pre-command-hook pre-command-hook)
1263 (post-command-hook post-command-hook)
1264 (minibuffer-setup-hook minibuffer-setup-hook))
1265 (add-hook 'pre-command-hook 'kmacro-step-edit-pre-command nil)
1266 (add-hook 'post-command-hook 'kmacro-step-edit-post-command t)
1267 (add-hook 'minibuffer-setup-hook 'kmacro-step-edit-minibuf-setup t)
1268 (call-last-kbd-macro nil nil)
5190c95e
KS
1269 (when (and kmacro-step-edit-replace
1270 kmacro-step-edit-new-macro
1271 (not (equal last-kbd-macro kmacro-step-edit-new-macro)))
1272 (kmacro-push-ring)
1273 (setq last-kbd-macro kmacro-step-edit-new-macro))))
723d6a64 1274
7e30f58e 1275(provide 'kmacro)
ab5796a9
MB
1276
1277;;; arch-tag: d3fe0b24-ae41-47de-a4d6-41a77d5559f0
7e30f58e 1278;;; kmacro.el ends here