246
|
1 /* Keyboard macros.
|
64770
|
2 Copyright (C) 1985, 1986, 1993, 2000, 2001, 2002, 2003, 2004,
|
|
3 2005 Free Software Foundation, Inc.
|
246
|
4
|
|
5 This file is part of GNU Emacs.
|
|
6
|
|
7 GNU Emacs is free software; you can redistribute it and/or modify
|
|
8 it under the terms of the GNU General Public License as published by
|
647
|
9 the Free Software Foundation; either version 2, or (at your option)
|
246
|
10 any later version.
|
|
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
|
|
18 along with GNU Emacs; see the file COPYING. If not, write to
|
64084
|
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
20 Boston, MA 02110-1301, USA. */
|
246
|
21
|
|
22
|
4696
|
23 #include <config.h>
|
246
|
24 #include "lisp.h"
|
|
25 #include "macros.h"
|
|
26 #include "commands.h"
|
|
27 #include "buffer.h"
|
|
28 #include "window.h"
|
11341
|
29 #include "keyboard.h"
|
246
|
30
|
35119
|
31 Lisp_Object Qexecute_kbd_macro, Qkbd_macro_termination_hook;
|
246
|
32
|
15968
|
33 /* Kbd macro currently being executed (a string or vector). */
|
|
34
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
35 Lisp_Object Vexecuting_kbd_macro;
|
15968
|
36
|
|
37 /* Index of next character to fetch from that macro. */
|
|
38
|
62024
|
39 EMACS_INT executing_kbd_macro_index;
|
246
|
40
|
15968
|
41 /* Number of successful iterations so far
|
|
42 for innermost keyboard macro.
|
|
43 This is not bound at each level,
|
|
44 so after an error, it describes the innermost interrupted macro. */
|
|
45
|
62024
|
46 int executing_kbd_macro_iterations;
|
15968
|
47
|
|
48 /* This is the macro that was executing.
|
|
49 This is not bound at each level,
|
|
50 so after an error, it describes the innermost interrupted macro.
|
|
51 We use it only as a kind of flag, so no need to protect it. */
|
|
52
|
62024
|
53 Lisp_Object executing_kbd_macro;
|
15968
|
54
|
23434
|
55 extern Lisp_Object real_this_command;
|
|
56
|
246
|
57 Lisp_Object Fexecute_kbd_macro ();
|
|
58
|
46887
|
59 DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 2, "P",
|
41940
|
60 doc: /* Record subsequent keyboard input, defining a keyboard macro.
|
|
61 The commands are recorded even as they are executed.
|
|
62 Use \\[end-kbd-macro] to finish recording and make the macro available.
|
|
63 Use \\[name-last-kbd-macro] to give it a permanent name.
|
|
64 Non-nil arg (prefix arg) means append to last macro defined;
|
46887
|
65 this begins by re-executing that macro as if you typed it again.
|
49600
|
66 If optional second arg, NO-EXEC, is non-nil, do not re-execute last
|
46887
|
67 macro before appending to it. */)
|
|
68 (append, no_exec)
|
|
69 Lisp_Object append, no_exec;
|
246
|
70 {
|
11009
|
71 if (!NILP (current_kboard->defining_kbd_macro))
|
246
|
72 error ("Already defining kbd macro");
|
|
73
|
11009
|
74 if (!current_kboard->kbd_macro_buffer)
|
10910
b0edc245c9b7
(defining_kbd_macro): Delete; now part of perdisplay. All uses changed.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
75 {
|
11009
|
76 current_kboard->kbd_macro_bufsize = 30;
|
|
77 current_kboard->kbd_macro_buffer
|
14301
|
78 = (Lisp_Object *)xmalloc (30 * sizeof (Lisp_Object));
|
10910
b0edc245c9b7
(defining_kbd_macro): Delete; now part of perdisplay. All uses changed.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
79 }
|
246
|
80 update_mode_lines++;
|
485
|
81 if (NILP (append))
|
246
|
82 {
|
14301
|
83 if (current_kboard->kbd_macro_bufsize > 200)
|
|
84 {
|
|
85 current_kboard->kbd_macro_bufsize = 30;
|
|
86 current_kboard->kbd_macro_buffer
|
15223
|
87 = (Lisp_Object *)xrealloc (current_kboard->kbd_macro_buffer,
|
|
88 30 * sizeof (Lisp_Object));
|
14301
|
89 }
|
11009
|
90 current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer;
|
|
91 current_kboard->kbd_macro_end = current_kboard->kbd_macro_buffer;
|
14301
|
92 message ("Defining kbd macro...");
|
246
|
93 }
|
|
94 else
|
|
95 {
|
26825
|
96 int i, len;
|
49745
|
97 int cvt;
|
26825
|
98
|
|
99 /* Check the type of last-kbd-macro in case Lisp code changed it. */
|
|
100 if (!STRINGP (current_kboard->Vlast_kbd_macro)
|
|
101 && !VECTORP (current_kboard->Vlast_kbd_macro))
|
|
102 current_kboard->Vlast_kbd_macro
|
|
103 = wrong_type_argument (Qarrayp, current_kboard->Vlast_kbd_macro);
|
|
104
|
|
105 len = XINT (Flength (current_kboard->Vlast_kbd_macro));
|
|
106
|
|
107 /* Copy last-kbd-macro into the buffer, in case the Lisp code
|
|
108 has put another macro there. */
|
|
109 if (current_kboard->kbd_macro_bufsize < len + 30)
|
|
110 {
|
|
111 current_kboard->kbd_macro_bufsize = len + 30;
|
|
112 current_kboard->kbd_macro_buffer
|
|
113 = (Lisp_Object *)xrealloc (current_kboard->kbd_macro_buffer,
|
|
114 (len + 30) * sizeof (Lisp_Object));
|
|
115 }
|
49745
|
116
|
|
117 /* Must convert meta modifier when copying string to vector. */
|
62024
|
118 cvt = STRINGP (current_kboard->Vlast_kbd_macro);
|
26825
|
119 for (i = 0; i < len; i++)
|
49745
|
120 {
|
|
121 Lisp_Object c;
|
|
122 c = Faref (current_kboard->Vlast_kbd_macro, make_number (i));
|
49913
|
123 if (cvt && NATNUMP (c) && (XFASTINT (c) & 0x80))
|
|
124 XSETFASTINT (c, CHAR_META | (XFASTINT (c) & ~0x80));
|
49745
|
125 current_kboard->kbd_macro_buffer[i] = c;
|
|
126 }
|
26825
|
127
|
|
128 current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer + len;
|
|
129 current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr;
|
|
130
|
|
131 /* Re-execute the macro we are appending to,
|
|
132 for consistency of behavior. */
|
46887
|
133 if (NILP (no_exec))
|
|
134 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro,
|
|
135 make_number (1), Qnil);
|
26825
|
136
|
|
137 message ("Appending to kbd macro...");
|
246
|
138 }
|
11009
|
139 current_kboard->defining_kbd_macro = Qt;
|
49600
|
140
|
246
|
141 return Qnil;
|
|
142 }
|
|
143
|
47348
|
144 /* Finish defining the current keyboard macro. */
|
|
145
|
|
146 void
|
|
147 end_kbd_macro ()
|
|
148 {
|
|
149 current_kboard->defining_kbd_macro = Qnil;
|
|
150 update_mode_lines++;
|
|
151 current_kboard->Vlast_kbd_macro
|
|
152 = make_event_array ((current_kboard->kbd_macro_end
|
|
153 - current_kboard->kbd_macro_buffer),
|
|
154 current_kboard->kbd_macro_buffer);
|
|
155 }
|
|
156
|
46887
|
157 DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 2, "p",
|
41940
|
158 doc: /* Finish defining a keyboard macro.
|
|
159 The definition was started by \\[start-kbd-macro].
|
|
160 The macro is now available for use via \\[call-last-kbd-macro],
|
|
161 or it can be given a name with \\[name-last-kbd-macro] and then invoked
|
|
162 under that name.
|
|
163
|
|
164 With numeric arg, repeat macro now that many times,
|
|
165 counting the definition just completed as the first repetition.
|
46887
|
166 An argument of zero means repeat until error.
|
|
167
|
49600
|
168 In Lisp, optional second arg LOOPFUNC may be a function that is called prior to
|
46887
|
169 each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */)
|
|
170 (repeat, loopfunc)
|
|
171 Lisp_Object repeat, loopfunc;
|
246
|
172 {
|
11009
|
173 if (NILP (current_kboard->defining_kbd_macro))
|
22915
|
174 error ("Not defining kbd macro");
|
246
|
175
|
14081
|
176 if (NILP (repeat))
|
|
177 XSETFASTINT (repeat, 1);
|
246
|
178 else
|
40656
|
179 CHECK_NUMBER (repeat);
|
246
|
180
|
11009
|
181 if (!NILP (current_kboard->defining_kbd_macro))
|
246
|
182 {
|
47348
|
183 end_kbd_macro ();
|
14301
|
184 message ("Keyboard macro defined");
|
246
|
185 }
|
|
186
|
14081
|
187 if (XFASTINT (repeat) == 0)
|
46887
|
188 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat, loopfunc);
|
246
|
189 else
|
|
190 {
|
14081
|
191 XSETINT (repeat, XINT (repeat)-1);
|
|
192 if (XINT (repeat) > 0)
|
46887
|
193 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat, loopfunc);
|
246
|
194 }
|
|
195 return Qnil;
|
|
196 }
|
|
197
|
|
198 /* Store character c into kbd macro being defined */
|
|
199
|
20299
|
200 void
|
246
|
201 store_kbd_macro_char (c)
|
|
202 Lisp_Object c;
|
|
203 {
|
39135
|
204 struct kboard *kb = current_kboard;
|
|
205
|
|
206 if (!NILP (kb->defining_kbd_macro))
|
246
|
207 {
|
39135
|
208 if (kb->kbd_macro_ptr - kb->kbd_macro_buffer == kb->kbd_macro_bufsize)
|
246
|
209 {
|
39135
|
210 int ptr_offset, end_offset, nbytes;
|
49600
|
211
|
39135
|
212 ptr_offset = kb->kbd_macro_ptr - kb->kbd_macro_buffer;
|
|
213 end_offset = kb->kbd_macro_end - kb->kbd_macro_buffer;
|
|
214 kb->kbd_macro_bufsize *= 2;
|
|
215 nbytes = kb->kbd_macro_bufsize * sizeof *kb->kbd_macro_buffer;
|
|
216 kb->kbd_macro_buffer
|
|
217 = (Lisp_Object *) xrealloc (kb->kbd_macro_buffer, nbytes);
|
|
218 kb->kbd_macro_ptr = kb->kbd_macro_buffer + ptr_offset;
|
|
219 kb->kbd_macro_end = kb->kbd_macro_buffer + end_offset;
|
246
|
220 }
|
49600
|
221
|
39135
|
222 *kb->kbd_macro_ptr++ = c;
|
246
|
223 }
|
|
224 }
|
|
225
|
|
226 /* Declare that all chars stored so far in the kbd macro being defined
|
|
227 really belong to it. This is done in between editor commands. */
|
|
228
|
20299
|
229 void
|
246
|
230 finalize_kbd_macro_chars ()
|
|
231 {
|
11009
|
232 current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr;
|
246
|
233 }
|
12845
|
234
|
|
235 DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events,
|
|
236 Scancel_kbd_macro_events, 0, 0, 0,
|
41940
|
237 doc: /* Cancel the events added to a keyboard macro for this command. */)
|
|
238 ()
|
12845
|
239 {
|
|
240 current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end;
|
31829
|
241 return Qnil;
|
12845
|
242 }
|
13773
|
243
|
|
244 DEFUN ("store-kbd-macro-event", Fstore_kbd_macro_event,
|
|
245 Sstore_kbd_macro_event, 1, 1, 0,
|
41940
|
246 doc: /* Store EVENT into the keyboard macro being defined. */)
|
|
247 (event)
|
13773
|
248 Lisp_Object event;
|
|
249 {
|
|
250 store_kbd_macro_char (event);
|
|
251 return Qnil;
|
|
252 }
|
246
|
253
|
|
254 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro,
|
46887
|
255 0, 2, "p",
|
41940
|
256 doc: /* Call the last keyboard macro that you defined with \\[start-kbd-macro].
|
|
257
|
|
258 A prefix argument serves as a repeat count. Zero means repeat until error.
|
|
259
|
|
260 To make a macro permanent so you can call it even after
|
49600
|
261 defining others, use \\[name-last-kbd-macro].
|
46887
|
262
|
49600
|
263 In Lisp, optional second arg LOOPFUNC may be a function that is called prior to
|
46887
|
264 each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */)
|
|
265 (prefix, loopfunc)
|
|
266 Lisp_Object prefix, loopfunc;
|
246
|
267 {
|
16562
|
268 /* Don't interfere with recognition of the previous command
|
|
269 from before this macro started. */
|
22968
|
270 Vthis_command = current_kboard->Vlast_command;
|
24530
|
271 /* C-x z after the macro should repeat the macro. */
|
|
272 real_this_command = current_kboard->Vlast_kbd_macro;
|
16562
|
273
|
11009
|
274 if (! NILP (current_kboard->defining_kbd_macro))
|
246
|
275 error ("Can't execute anonymous macro while defining one");
|
11009
|
276 else if (NILP (current_kboard->Vlast_kbd_macro))
|
246
|
277 error ("No kbd macro has been defined");
|
|
278 else
|
46887
|
279 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, prefix, loopfunc);
|
16562
|
280
|
|
281 /* command_loop_1 sets this to nil before it returns;
|
|
282 get back the last command within the macro
|
|
283 so that it can be last, again, after we return. */
|
22968
|
284 Vthis_command = current_kboard->Vlast_command;
|
16562
|
285
|
246
|
286 return Qnil;
|
|
287 }
|
|
288
|
62024
|
289 /* Restore Vexecuting_kbd_macro and executing_kbd_macro_index.
|
|
290 Called when the unwind-protect in Fexecute_kbd_macro gets invoked. */
|
15968
|
291
|
246
|
292 static Lisp_Object
|
|
293 pop_kbd_macro (info)
|
|
294 Lisp_Object info;
|
|
295 {
|
|
296 Lisp_Object tem;
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
297 Vexecuting_kbd_macro = XCAR (info);
|
24530
|
298 tem = XCDR (info);
|
62024
|
299 executing_kbd_macro_index = XINT (XCAR (tem));
|
24530
|
300 real_this_command = XCDR (tem);
|
35119
|
301 Frun_hooks (1, &Qkbd_macro_termination_hook);
|
246
|
302 return Qnil;
|
|
303 }
|
|
304
|
46887
|
305 DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 3, 0,
|
41940
|
306 doc: /* Execute MACRO as string of editor command characters.
|
|
307 If MACRO is a symbol, its function definition is used.
|
49600
|
308 COUNT is a repeat count, or nil for once, or 0 for infinite loop.
|
46887
|
309
|
49600
|
310 Optional third arg LOOPFUNC may be a function that is called prior to
|
46887
|
311 each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */)
|
|
312 (macro, count, loopfunc)
|
|
313 Lisp_Object macro, count, loopfunc;
|
246
|
314 {
|
|
315 Lisp_Object final;
|
|
316 Lisp_Object tem;
|
46295
|
317 int pdlcount = SPECPDL_INDEX ();
|
246
|
318 int repeat = 1;
|
46887
|
319 struct gcpro gcpro1, gcpro2;
|
15968
|
320 int success_count = 0;
|
246
|
321
|
62024
|
322 executing_kbd_macro_iterations = 0;
|
24482
9b722e922325
(Fexecute_kbd_macro): Initialize executing_macro_iterations at beginning.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
323
|
14100
|
324 if (!NILP (count))
|
|
325 {
|
|
326 count = Fprefix_numeric_value (count);
|
|
327 repeat = XINT (count);
|
|
328 }
|
246
|
329
|
647
|
330 final = indirect_function (macro);
|
9122
|
331 if (!STRINGP (final) && !VECTORP (final))
|
22915
|
332 error ("Keyboard macros must be strings or vectors");
|
246
|
333
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
334 tem = Fcons (Vexecuting_kbd_macro,
|
62024
|
335 Fcons (make_number (executing_kbd_macro_index),
|
24530
|
336 real_this_command));
|
246
|
337 record_unwind_protect (pop_kbd_macro, tem);
|
|
338
|
46887
|
339 GCPRO2 (final, loopfunc);
|
246
|
340 do
|
|
341 {
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
342 Vexecuting_kbd_macro = final;
|
62024
|
343 executing_kbd_macro = final;
|
|
344 executing_kbd_macro_index = 0;
|
246
|
345
|
12119
|
346 current_kboard->Vprefix_arg = Qnil;
|
46887
|
347
|
|
348 if (!NILP (loopfunc))
|
|
349 {
|
|
350 Lisp_Object cont;
|
|
351 cont = call0 (loopfunc);
|
|
352 if (NILP (cont))
|
|
353 break;
|
|
354 }
|
|
355
|
246
|
356 command_loop_1 ();
|
1682
|
357
|
62024
|
358 executing_kbd_macro_iterations = ++success_count;
|
15968
|
359
|
1682
|
360 QUIT;
|
246
|
361 }
|
9122
|
362 while (--repeat
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
363 && (STRINGP (Vexecuting_kbd_macro) || VECTORP (Vexecuting_kbd_macro)));
|
246
|
364
|
62024
|
365 executing_kbd_macro = Qnil;
|
15968
|
366
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
367 real_this_command = Vexecuting_kbd_macro;
|
23434
|
368
|
246
|
369 UNGCPRO;
|
14094
|
370 return unbind_to (pdlcount, Qnil);
|
246
|
371 }
|
|
372
|
20299
|
373 void
|
246
|
374 init_macros ()
|
|
375 {
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
376 Vexecuting_kbd_macro = Qnil;
|
62024
|
377 executing_kbd_macro = Qnil;
|
246
|
378 }
|
|
379
|
20299
|
380 void
|
246
|
381 syms_of_macros ()
|
|
382 {
|
|
383 Qexecute_kbd_macro = intern ("execute-kbd-macro");
|
|
384 staticpro (&Qexecute_kbd_macro);
|
35119
|
385 Qkbd_macro_termination_hook = intern ("kbd-macro-termination-hook");
|
|
386 staticpro (&Qkbd_macro_termination_hook);
|
246
|
387
|
|
388 defsubr (&Sstart_kbd_macro);
|
|
389 defsubr (&Send_kbd_macro);
|
|
390 defsubr (&Scall_last_kbd_macro);
|
|
391 defsubr (&Sexecute_kbd_macro);
|
12845
|
392 defsubr (&Scancel_kbd_macro_events);
|
13773
|
393 defsubr (&Sstore_kbd_macro_event);
|
246
|
394
|
11009
|
395 DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
|
57962
|
396 doc: /* Non-nil while a keyboard macro is being defined. Don't set this!
|
|
397 The value is the symbol `append' while appending to the definition of
|
|
398 an existing macro. */);
|
246
|
399
|
61983
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
400 DEFVAR_LISP ("executing-kbd-macro", &Vexecuting_kbd_macro,
|
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
401 doc: /* Currently executing keyboard macro (string or vector).
|
f58aeabf21e7
(Vexecuting_kbd_macro): Renamed from Vexecuting_macro. All uses changed.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
402 This is nil when not executing a keyboard macro. */);
|
246
|
403
|
62024
|
404 DEFVAR_INT ("executing-kbd-macro-index", &executing_kbd_macro_index,
|
47307
|
405 doc: /* Index in currently executing keyboard macro; undefined if none executing. */);
|
|
406
|
11009
|
407 DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro,
|
41940
|
408 doc: /* Last kbd macro defined, as a string or vector; nil if none defined. */);
|
246
|
409 }
|
52401
|
410
|
|
411 /* arch-tag: d293fcc9-2266-4163-9198-7fa0de12ec9e
|
|
412 (do not change this comment) */
|