Commit | Line | Data |
---|---|---|
5a7f5d07 | 1 | /* Keyboard macros. |
bb1c6663 | 2 | |
ba318903 | 3 | Copyright (C) 1985-1986, 1993, 2000-2014 Free Software Foundation, Inc. |
5a7f5d07 JB |
4 | |
5 | This file is part of GNU Emacs. | |
6 | ||
9ec0b715 | 7 | GNU Emacs is free software: you can redistribute it and/or modify |
5a7f5d07 | 8 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
9 | the Free Software Foundation, either version 3 of the License, or |
10 | (at your option) any later version. | |
5a7f5d07 JB |
11 | |
12 | GNU Emacs is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
9ec0b715 | 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
5a7f5d07 JB |
19 | |
20 | ||
18160b98 | 21 | #include <config.h> |
0328b6de | 22 | |
5a7f5d07 JB |
23 | #include "lisp.h" |
24 | #include "macros.h" | |
25 | #include "commands.h" | |
e5560ff7 | 26 | #include "character.h" |
5a7f5d07 JB |
27 | #include "buffer.h" |
28 | #include "window.h" | |
077d751f | 29 | #include "keyboard.h" |
5a7f5d07 | 30 | |
6e65b9cc | 31 | static Lisp_Object Qexecute_kbd_macro; |
955cbe7b | 32 | static Lisp_Object Qkbd_macro_termination_hook; |
5a7f5d07 | 33 | |
d4087e06 RS |
34 | /* Number of successful iterations so far |
35 | for innermost keyboard macro. | |
36 | This is not bound at each level, | |
37 | so after an error, it describes the innermost interrupted macro. */ | |
38 | ||
48e30793 | 39 | EMACS_INT executing_kbd_macro_iterations; |
d4087e06 RS |
40 | |
41 | /* This is the macro that was executing. | |
42 | This is not bound at each level, | |
43 | so after an error, it describes the innermost interrupted macro. | |
44 | We use it only as a kind of flag, so no need to protect it. */ | |
45 | ||
649d952d | 46 | Lisp_Object executing_kbd_macro; |
d4087e06 | 47 | |
f90d3a6b | 48 | DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 2, "P", |
70da46c3 PJ |
49 | doc: /* Record subsequent keyboard input, defining a keyboard macro. |
50 | The commands are recorded even as they are executed. | |
51 | Use \\[end-kbd-macro] to finish recording and make the macro available. | |
52 | Use \\[name-last-kbd-macro] to give it a permanent name. | |
53 | Non-nil arg (prefix arg) means append to last macro defined; | |
f90d3a6b | 54 | this begins by re-executing that macro as if you typed it again. |
177c0ea7 | 55 | If optional second arg, NO-EXEC, is non-nil, do not re-execute last |
2ec9db5d | 56 | macro before appending to it. */) |
5842a27b | 57 | (Lisp_Object append, Lisp_Object no_exec) |
5a7f5d07 | 58 | { |
1344aad4 | 59 | if (!NILP (KVAR (current_kboard, defining_kbd_macro))) |
5a7f5d07 JB |
60 | error ("Already defining kbd macro"); |
61 | ||
cd8b5aa3 | 62 | if (!current_kboard->kbd_macro_buffer) |
8b97da83 | 63 | { |
663e2b3f | 64 | current_kboard->kbd_macro_buffer = xmalloc (30 * word_size); |
c86960f0 | 65 | current_kboard->kbd_macro_bufsize = 30; |
8b97da83 | 66 | } |
2ec9db5d | 67 | update_mode_lines = 19; |
265a9e55 | 68 | if (NILP (append)) |
5a7f5d07 | 69 | { |
9e7c370a KH |
70 | if (current_kboard->kbd_macro_bufsize > 200) |
71 | { | |
9e7c370a | 72 | current_kboard->kbd_macro_buffer |
98c6f1e3 | 73 | = xrealloc (current_kboard->kbd_macro_buffer, |
663e2b3f | 74 | 30 * word_size); |
6d84508d | 75 | current_kboard->kbd_macro_bufsize = 30; |
9e7c370a | 76 | } |
cd8b5aa3 KH |
77 | current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer; |
78 | current_kboard->kbd_macro_end = current_kboard->kbd_macro_buffer; | |
2f73da9c | 79 | message1 ("Defining kbd macro..."); |
5a7f5d07 JB |
80 | } |
81 | else | |
82 | { | |
6d84508d PE |
83 | ptrdiff_t i; |
84 | EMACS_INT len; | |
7cded46f | 85 | bool cvt; |
f84db7d5 RS |
86 | |
87 | /* Check the type of last-kbd-macro in case Lisp code changed it. */ | |
1344aad4 | 88 | CHECK_VECTOR_OR_STRING (KVAR (current_kboard, Vlast_kbd_macro)); |
f84db7d5 | 89 | |
1344aad4 | 90 | len = XINT (Flength (KVAR (current_kboard, Vlast_kbd_macro))); |
f84db7d5 RS |
91 | |
92 | /* Copy last-kbd-macro into the buffer, in case the Lisp code | |
93 | has put another macro there. */ | |
94 | if (current_kboard->kbd_macro_bufsize < len + 30) | |
95 | { | |
d311d28c PE |
96 | if (PTRDIFF_MAX < MOST_POSITIVE_FIXNUM + 30 |
97 | && PTRDIFF_MAX < len + 30) | |
6d84508d | 98 | memory_full (SIZE_MAX); |
d311d28c PE |
99 | current_kboard->kbd_macro_buffer = |
100 | xpalloc (current_kboard->kbd_macro_buffer, | |
101 | ¤t_kboard->kbd_macro_bufsize, | |
102 | len + 30 - current_kboard->kbd_macro_bufsize, -1, | |
103 | sizeof *current_kboard->kbd_macro_buffer); | |
f84db7d5 | 104 | } |
295fff2c KS |
105 | |
106 | /* Must convert meta modifier when copying string to vector. */ | |
1344aad4 | 107 | cvt = STRINGP (KVAR (current_kboard, Vlast_kbd_macro)); |
f84db7d5 | 108 | for (i = 0; i < len; i++) |
295fff2c KS |
109 | { |
110 | Lisp_Object c; | |
1344aad4 | 111 | c = Faref (KVAR (current_kboard, Vlast_kbd_macro), make_number (i)); |
3499aebf SM |
112 | if (cvt && NATNUMP (c) && (XFASTINT (c) & 0x80)) |
113 | XSETFASTINT (c, CHAR_META | (XFASTINT (c) & ~0x80)); | |
295fff2c KS |
114 | current_kboard->kbd_macro_buffer[i] = c; |
115 | } | |
f84db7d5 RS |
116 | |
117 | current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer + len; | |
118 | current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr; | |
119 | ||
120 | /* Re-execute the macro we are appending to, | |
121 | for consistency of behavior. */ | |
f90d3a6b | 122 | if (NILP (no_exec)) |
1344aad4 | 123 | Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro), |
f90d3a6b | 124 | make_number (1), Qnil); |
f84db7d5 | 125 | |
2f73da9c | 126 | message1 ("Appending to kbd macro..."); |
5a7f5d07 | 127 | } |
15dbb4d6 | 128 | kset_defining_kbd_macro (current_kboard, Qt); |
177c0ea7 | 129 | |
5a7f5d07 JB |
130 | return Qnil; |
131 | } | |
132 | ||
eeb8fc0d KS |
133 | /* Finish defining the current keyboard macro. */ |
134 | ||
135 | void | |
971de7fb | 136 | end_kbd_macro (void) |
eeb8fc0d | 137 | { |
15dbb4d6 | 138 | kset_defining_kbd_macro (current_kboard, Qnil); |
2ec9db5d | 139 | update_mode_lines = 20; |
15dbb4d6 PE |
140 | kset_last_kbd_macro |
141 | (current_kboard, | |
142 | make_event_array ((current_kboard->kbd_macro_end | |
143 | - current_kboard->kbd_macro_buffer), | |
144 | current_kboard->kbd_macro_buffer)); | |
eeb8fc0d KS |
145 | } |
146 | ||
f90d3a6b | 147 | DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 2, "p", |
70da46c3 PJ |
148 | doc: /* Finish defining a keyboard macro. |
149 | The definition was started by \\[start-kbd-macro]. | |
150 | The macro is now available for use via \\[call-last-kbd-macro], | |
151 | or it can be given a name with \\[name-last-kbd-macro] and then invoked | |
152 | under that name. | |
153 | ||
154 | With numeric arg, repeat macro now that many times, | |
155 | counting the definition just completed as the first repetition. | |
f90d3a6b KS |
156 | An argument of zero means repeat until error. |
157 | ||
177c0ea7 | 158 | In Lisp, optional second arg LOOPFUNC may be a function that is called prior to |
f90d3a6b | 159 | each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */) |
5842a27b | 160 | (Lisp_Object repeat, Lisp_Object loopfunc) |
5a7f5d07 | 161 | { |
1344aad4 | 162 | if (NILP (KVAR (current_kboard, defining_kbd_macro))) |
d86ad277 | 163 | error ("Not defining kbd macro"); |
5a7f5d07 | 164 | |
86a3ca5e EN |
165 | if (NILP (repeat)) |
166 | XSETFASTINT (repeat, 1); | |
5a7f5d07 | 167 | else |
b7826503 | 168 | CHECK_NUMBER (repeat); |
5a7f5d07 | 169 | |
1344aad4 | 170 | if (!NILP (KVAR (current_kboard, defining_kbd_macro))) |
5a7f5d07 | 171 | { |
eeb8fc0d | 172 | end_kbd_macro (); |
2f73da9c | 173 | message1 ("Keyboard macro defined"); |
5a7f5d07 JB |
174 | } |
175 | ||
86a3ca5e | 176 | if (XFASTINT (repeat) == 0) |
1344aad4 | 177 | Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro), repeat, loopfunc); |
48e30793 | 178 | else if (XINT (repeat) > 1) |
5a7f5d07 | 179 | { |
2f73da9c | 180 | XSETINT (repeat, XINT (repeat) - 1); |
48e30793 PE |
181 | Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro), |
182 | repeat, loopfunc); | |
5a7f5d07 JB |
183 | } |
184 | return Qnil; | |
185 | } | |
186 | ||
2f73da9c | 187 | /* Store character c into kbd macro being defined. */ |
5a7f5d07 | 188 | |
c3fd8dd5 | 189 | void |
971de7fb | 190 | store_kbd_macro_char (Lisp_Object c) |
5a7f5d07 | 191 | { |
08e1d6df GM |
192 | struct kboard *kb = current_kboard; |
193 | ||
1344aad4 | 194 | if (!NILP (KVAR (kb, defining_kbd_macro))) |
5a7f5d07 | 195 | { |
08e1d6df | 196 | if (kb->kbd_macro_ptr - kb->kbd_macro_buffer == kb->kbd_macro_bufsize) |
5a7f5d07 | 197 | { |
6d84508d | 198 | ptrdiff_t ptr_offset, end_offset, nbytes; |
177c0ea7 | 199 | |
08e1d6df GM |
200 | ptr_offset = kb->kbd_macro_ptr - kb->kbd_macro_buffer; |
201 | end_offset = kb->kbd_macro_end - kb->kbd_macro_buffer; | |
6d84508d PE |
202 | if (min (PTRDIFF_MAX, SIZE_MAX) / sizeof *kb->kbd_macro_buffer / 2 |
203 | < kb->kbd_macro_bufsize) | |
204 | memory_full (SIZE_MAX); | |
c86960f0 | 205 | nbytes = kb->kbd_macro_bufsize * (2 * sizeof *kb->kbd_macro_buffer); |
38182d90 | 206 | kb->kbd_macro_buffer = xrealloc (kb->kbd_macro_buffer, nbytes); |
6d84508d | 207 | kb->kbd_macro_bufsize *= 2; |
08e1d6df GM |
208 | kb->kbd_macro_ptr = kb->kbd_macro_buffer + ptr_offset; |
209 | kb->kbd_macro_end = kb->kbd_macro_buffer + end_offset; | |
5a7f5d07 | 210 | } |
177c0ea7 | 211 | |
08e1d6df | 212 | *kb->kbd_macro_ptr++ = c; |
5a7f5d07 JB |
213 | } |
214 | } | |
215 | ||
216 | /* Declare that all chars stored so far in the kbd macro being defined | |
217 | really belong to it. This is done in between editor commands. */ | |
218 | ||
c3fd8dd5 | 219 | void |
971de7fb | 220 | finalize_kbd_macro_chars (void) |
5a7f5d07 | 221 | { |
cd8b5aa3 | 222 | current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr; |
5a7f5d07 | 223 | } |
199afd29 | 224 | |
a7ca3326 | 225 | DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events, |
199afd29 | 226 | Scancel_kbd_macro_events, 0, 0, 0, |
70da46c3 | 227 | doc: /* Cancel the events added to a keyboard macro for this command. */) |
5842a27b | 228 | (void) |
199afd29 RS |
229 | { |
230 | current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end; | |
6bbd7a29 | 231 | return Qnil; |
199afd29 | 232 | } |
2d5f65a9 KH |
233 | |
234 | DEFUN ("store-kbd-macro-event", Fstore_kbd_macro_event, | |
235 | Sstore_kbd_macro_event, 1, 1, 0, | |
70da46c3 | 236 | doc: /* Store EVENT into the keyboard macro being defined. */) |
5842a27b | 237 | (Lisp_Object event) |
2d5f65a9 KH |
238 | { |
239 | store_kbd_macro_char (event); | |
240 | return Qnil; | |
241 | } | |
5a7f5d07 JB |
242 | \f |
243 | DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro, | |
f90d3a6b | 244 | 0, 2, "p", |
70da46c3 PJ |
245 | doc: /* Call the last keyboard macro that you defined with \\[start-kbd-macro]. |
246 | ||
247 | A prefix argument serves as a repeat count. Zero means repeat until error. | |
248 | ||
249 | To make a macro permanent so you can call it even after | |
177c0ea7 | 250 | defining others, use \\[name-last-kbd-macro]. |
f90d3a6b | 251 | |
177c0ea7 | 252 | In Lisp, optional second arg LOOPFUNC may be a function that is called prior to |
f90d3a6b | 253 | each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */) |
5842a27b | 254 | (Lisp_Object prefix, Lisp_Object loopfunc) |
5a7f5d07 | 255 | { |
4315204e RS |
256 | /* Don't interfere with recognition of the previous command |
257 | from before this macro started. */ | |
1344aad4 | 258 | Vthis_command = KVAR (current_kboard, Vlast_command); |
80184dac | 259 | /* C-x z after the macro should repeat the macro. */ |
f2d6a3df | 260 | Vreal_this_command = KVAR (current_kboard, Vlast_kbd_macro); |
4315204e | 261 | |
1344aad4 | 262 | if (! NILP (KVAR (current_kboard, defining_kbd_macro))) |
5a7f5d07 | 263 | error ("Can't execute anonymous macro while defining one"); |
1344aad4 | 264 | else if (NILP (KVAR (current_kboard, Vlast_kbd_macro))) |
5a7f5d07 JB |
265 | error ("No kbd macro has been defined"); |
266 | else | |
1344aad4 | 267 | Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro), prefix, loopfunc); |
4315204e RS |
268 | |
269 | /* command_loop_1 sets this to nil before it returns; | |
270 | get back the last command within the macro | |
271 | so that it can be last, again, after we return. */ | |
1344aad4 | 272 | Vthis_command = KVAR (current_kboard, Vlast_command); |
4315204e | 273 | |
5a7f5d07 JB |
274 | return Qnil; |
275 | } | |
276 | ||
649d952d KS |
277 | /* Restore Vexecuting_kbd_macro and executing_kbd_macro_index. |
278 | Called when the unwind-protect in Fexecute_kbd_macro gets invoked. */ | |
d4087e06 | 279 | |
27e498e6 | 280 | static void |
971de7fb | 281 | pop_kbd_macro (Lisp_Object info) |
5a7f5d07 JB |
282 | { |
283 | Lisp_Object tem; | |
524ed533 | 284 | Vexecuting_kbd_macro = XCAR (info); |
80184dac | 285 | tem = XCDR (info); |
649d952d | 286 | executing_kbd_macro_index = XINT (XCAR (tem)); |
f2d6a3df | 287 | Vreal_this_command = XCDR (tem); |
2136b408 | 288 | Frun_hooks (1, &Qkbd_macro_termination_hook); |
5a7f5d07 JB |
289 | } |
290 | ||
a7ca3326 | 291 | DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 3, 0, |
70da46c3 | 292 | doc: /* Execute MACRO as string of editor command characters. |
fe461220 LI |
293 | MACRO can also be a vector of keyboard events. If MACRO is a symbol, |
294 | its function definition is used. | |
177c0ea7 | 295 | COUNT is a repeat count, or nil for once, or 0 for infinite loop. |
f90d3a6b | 296 | |
177c0ea7 | 297 | Optional third arg LOOPFUNC may be a function that is called prior to |
f90d3a6b | 298 | each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */) |
5842a27b | 299 | (Lisp_Object macro, Lisp_Object count, Lisp_Object loopfunc) |
5a7f5d07 JB |
300 | { |
301 | Lisp_Object final; | |
302 | Lisp_Object tem; | |
d311d28c | 303 | ptrdiff_t pdlcount = SPECPDL_INDEX (); |
48e30793 | 304 | EMACS_INT repeat = 1; |
f90d3a6b | 305 | struct gcpro gcpro1, gcpro2; |
48e30793 | 306 | EMACS_INT success_count = 0; |
5a7f5d07 | 307 | |
649d952d | 308 | executing_kbd_macro_iterations = 0; |
4b7da890 | 309 | |
1c8c5693 EN |
310 | if (!NILP (count)) |
311 | { | |
312 | count = Fprefix_numeric_value (count); | |
313 | repeat = XINT (count); | |
314 | } | |
5a7f5d07 | 315 | |
502ddf23 | 316 | final = indirect_function (macro); |
65346ae6 | 317 | if (!STRINGP (final) && !VECTORP (final)) |
d86ad277 | 318 | error ("Keyboard macros must be strings or vectors"); |
5a7f5d07 | 319 | |
524ed533 | 320 | tem = Fcons (Vexecuting_kbd_macro, |
649d952d | 321 | Fcons (make_number (executing_kbd_macro_index), |
f2d6a3df | 322 | Vreal_this_command)); |
5a7f5d07 JB |
323 | record_unwind_protect (pop_kbd_macro, tem); |
324 | ||
f90d3a6b | 325 | GCPRO2 (final, loopfunc); |
5a7f5d07 JB |
326 | do |
327 | { | |
524ed533 | 328 | Vexecuting_kbd_macro = final; |
649d952d KS |
329 | executing_kbd_macro = final; |
330 | executing_kbd_macro_index = 0; | |
5a7f5d07 | 331 | |
15dbb4d6 | 332 | kset_prefix_arg (current_kboard, Qnil); |
f90d3a6b KS |
333 | |
334 | if (!NILP (loopfunc)) | |
335 | { | |
336 | Lisp_Object cont; | |
337 | cont = call0 (loopfunc); | |
338 | if (NILP (cont)) | |
339 | break; | |
340 | } | |
341 | ||
5a7f5d07 | 342 | command_loop_1 (); |
e86f81cc | 343 | |
649d952d | 344 | executing_kbd_macro_iterations = ++success_count; |
d4087e06 | 345 | |
e86f81cc | 346 | QUIT; |
5a7f5d07 | 347 | } |
65346ae6 | 348 | while (--repeat |
524ed533 | 349 | && (STRINGP (Vexecuting_kbd_macro) || VECTORP (Vexecuting_kbd_macro))); |
5a7f5d07 | 350 | |
649d952d | 351 | executing_kbd_macro = Qnil; |
d4087e06 | 352 | |
f2d6a3df | 353 | Vreal_this_command = Vexecuting_kbd_macro; |
b80d5655 | 354 | |
5a7f5d07 | 355 | UNGCPRO; |
52d9c145 | 356 | return unbind_to (pdlcount, Qnil); |
5a7f5d07 JB |
357 | } |
358 | \f | |
c3fd8dd5 | 359 | void |
971de7fb | 360 | init_macros (void) |
5a7f5d07 | 361 | { |
524ed533 | 362 | Vexecuting_kbd_macro = Qnil; |
649d952d | 363 | executing_kbd_macro = Qnil; |
5a7f5d07 JB |
364 | } |
365 | ||
c3fd8dd5 | 366 | void |
971de7fb | 367 | syms_of_macros (void) |
5a7f5d07 | 368 | { |
cd3520a4 | 369 | DEFSYM (Qexecute_kbd_macro, "execute-kbd-macro"); |
bb1c6663 GM |
370 | |
371 | DEFVAR_LISP ("kbd-macro-termination-hook", Vkbd_macro_termination_hook, | |
372 | doc: /* Normal hook run whenever a keyboard macro terminates. | |
373 | This is run whether the macro ends normally or prematurely due to an error. */); | |
374 | Vkbd_macro_termination_hook = Qnil; | |
cd3520a4 | 375 | DEFSYM (Qkbd_macro_termination_hook, "kbd-macro-termination-hook"); |
5a7f5d07 JB |
376 | |
377 | defsubr (&Sstart_kbd_macro); | |
378 | defsubr (&Send_kbd_macro); | |
379 | defsubr (&Scall_last_kbd_macro); | |
380 | defsubr (&Sexecute_kbd_macro); | |
199afd29 | 381 | defsubr (&Scancel_kbd_macro_events); |
2d5f65a9 | 382 | defsubr (&Sstore_kbd_macro_event); |
5a7f5d07 | 383 | |
cd8b5aa3 | 384 | DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro, |
6cf374b1 LT |
385 | doc: /* Non-nil while a keyboard macro is being defined. Don't set this! |
386 | The value is the symbol `append' while appending to the definition of | |
387 | an existing macro. */); | |
5a7f5d07 | 388 | |
29208e82 | 389 | DEFVAR_LISP ("executing-kbd-macro", Vexecuting_kbd_macro, |
524ed533 RS |
390 | doc: /* Currently executing keyboard macro (string or vector). |
391 | This is nil when not executing a keyboard macro. */); | |
5a7f5d07 | 392 | |
29208e82 | 393 | DEFVAR_INT ("executing-kbd-macro-index", executing_kbd_macro_index, |
64799df5 KS |
394 | doc: /* Index in currently executing keyboard macro; undefined if none executing. */); |
395 | ||
cd8b5aa3 | 396 | DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro, |
70da46c3 | 397 | doc: /* Last kbd macro defined, as a string or vector; nil if none defined. */); |
5a7f5d07 | 398 | } |