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