|
0
|
1 /* Keyboard macros.
|
|
|
2 Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc.
|
|
|
3
|
|
|
4 This file is part of XEmacs.
|
|
|
5
|
|
|
6 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
7 under the terms of the GNU General Public License as published by the
|
|
|
8 Free Software Foundation; either version 2, or (at your option) any
|
|
|
9 later version.
|
|
|
10
|
|
|
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 for more details.
|
|
|
15
|
|
|
16 You should have received a copy of the GNU General Public License
|
|
|
17 along with XEmacs; see the file COPYING. If not, write to
|
|
|
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
19 Boston, MA 02111-1307, USA. */
|
|
|
20
|
|
|
21 /* Synched up with: FSF 19.30. */
|
|
|
22
|
|
|
23 /* A keyboard macro is a string of ASCII characters, or a vector of event
|
|
|
24 objects. Only key-press, mouse-press, mouse-release, and menu-selection
|
|
|
25 events ever get into a keyboard macro.
|
|
|
26
|
|
|
27 When interactively defining a keyboard macro, it will always be a vector
|
|
|
28 of events; strings may be executed for backwards compatibility.
|
|
|
29 */
|
|
|
30
|
|
|
31 #include <config.h>
|
|
|
32 #include "lisp.h"
|
|
|
33 #include "events.h"
|
|
|
34 #include "macros.h"
|
|
|
35 #include "commands.h"
|
|
|
36 #include "console.h"
|
|
|
37 #include "buffer.h"
|
|
|
38 #include "window.h"
|
|
|
39 #include "frame.h"
|
|
|
40 #include "keymap.h"
|
|
|
41
|
|
|
42 Lisp_Object Qexecute_kbd_macro;
|
|
|
43
|
|
|
44 /* The current macro and our position in it. When executing nested kbd
|
|
|
45 macros, previous values for these are wound through the execution stack
|
|
|
46 with unwind-protect.
|
|
|
47 */
|
|
|
48 Lisp_Object Vexecuting_macro;
|
|
|
49 int executing_macro_index;
|
|
|
50
|
|
|
51
|
|
20
|
52 DEFUN ("start-kbd-macro", Fstart_kbd_macro, 1, 1, "P", /*
|
|
0
|
53 Record subsequent keyboard and menu input, defining a keyboard macro.
|
|
|
54 The commands are recorded even as they are executed.
|
|
|
55 Use \\[end-kbd-macro] to finish recording and make the macro available.
|
|
|
56 Use \\[name-last-kbd-macro] to give it a permanent name.
|
|
|
57 Non-nil arg (prefix arg) means append to last macro defined;
|
|
|
58 This begins by re-executing that macro as if you typed it again.
|
|
20
|
59 */
|
|
|
60 (append))
|
|
0
|
61 {
|
|
|
62 /* This function can GC */
|
|
|
63 struct console *con = XCONSOLE (Vselected_console);
|
|
|
64 if (!NILP (con->defining_kbd_macro))
|
|
|
65 error ("Already defining kbd macro");
|
|
|
66
|
|
|
67 if (NILP (con->kbd_macro_builder))
|
|
|
68 con->kbd_macro_builder = make_vector (30, Qnil);
|
|
|
69
|
|
|
70 zmacs_region_stays = 1; /* set this before calling Fexecute_kbd_macro()
|
|
|
71 so that functions there can override */
|
|
|
72 MARK_MODELINE_CHANGED;
|
|
|
73 if (NILP (append))
|
|
|
74 {
|
|
|
75 con->kbd_macro_ptr = 0;
|
|
|
76 con->kbd_macro_end = 0;
|
|
|
77 message ("Defining kbd macro...");
|
|
|
78 }
|
|
|
79 else
|
|
|
80 {
|
|
|
81 message ("Appending to kbd macro...");
|
|
|
82 con->kbd_macro_ptr = con->kbd_macro_end;
|
|
|
83 Fexecute_kbd_macro (con->last_kbd_macro, make_int (1));
|
|
|
84 }
|
|
|
85 con->defining_kbd_macro = Qt;
|
|
|
86
|
|
|
87 return Qnil;
|
|
|
88 }
|
|
|
89
|
|
280
|
90 DEFUN ("end-kbd-macro", Fend_kbd_macro, 0, 2, "P", /*
|
|
0
|
91 Finish defining a keyboard macro.
|
|
|
92 The definition was started by \\[start-kbd-macro].
|
|
|
93 The macro is now available for use via \\[call-last-kbd-macro],
|
|
|
94 or it can be given a name with \\[name-last-kbd-macro] and then invoked
|
|
|
95 under that name.
|
|
|
96
|
|
|
97 With numeric arg, repeat macro now that many times,
|
|
|
98 counting the definition just completed as the first repetition.
|
|
|
99 An argument of zero means repeat until error.
|
|
280
|
100
|
|
|
101 If REMOVE-LAST is an integer, it means to not record the last number
|
|
|
102 of events. This is used internally and will likely be removed.
|
|
20
|
103 */
|
|
280
|
104 (arg, remove_last))
|
|
0
|
105 {
|
|
|
106 /* This function can GC */
|
|
|
107 struct console *con = XCONSOLE (Vselected_console);
|
|
280
|
108 int repeat, kill;
|
|
0
|
109
|
|
|
110 if (NILP (con->defining_kbd_macro))
|
|
|
111 error ("Not defining kbd macro.");
|
|
|
112
|
|
280
|
113 /* #### Read the comment in modeline.el to see why this ugliness is
|
|
|
114 needed. #### Try to avoid it, somehow! */
|
|
|
115 if (!NILP (remove_last))
|
|
|
116 {
|
|
|
117 CHECK_NATNUM (remove_last);
|
|
|
118 kill = XINT (remove_last);
|
|
|
119 }
|
|
|
120 else
|
|
|
121 kill = 0;
|
|
|
122
|
|
0
|
123 if (NILP (arg))
|
|
|
124 repeat = -1;
|
|
|
125 else
|
|
|
126 repeat = XINT (Fprefix_numeric_value (arg));
|
|
|
127
|
|
|
128 if (!NILP (con->defining_kbd_macro))
|
|
|
129 {
|
|
|
130 int i;
|
|
280
|
131 int size = con->kbd_macro_end - kill;
|
|
|
132
|
|
|
133 if (size < 0)
|
|
|
134 size = 0;
|
|
0
|
135 con->last_kbd_macro = make_vector (size, Qnil);
|
|
280
|
136 for (i = 0; i < size; i++)
|
|
173
|
137 XVECTOR_DATA (con->last_kbd_macro) [i] =
|
|
|
138 XVECTOR_DATA (con->kbd_macro_builder) [i];
|
|
0
|
139 con->defining_kbd_macro = Qnil;
|
|
|
140 MARK_MODELINE_CHANGED;
|
|
|
141 message ("Keyboard macro defined");
|
|
|
142 }
|
|
|
143
|
|
|
144 zmacs_region_stays = 1; /* set this before calling Fexecute_kbd_macro()
|
|
|
145 so that functions there can override */
|
|
|
146 if (repeat < 0)
|
|
|
147 return Qnil;
|
|
|
148 else if (repeat == 0)
|
|
|
149 return Fexecute_kbd_macro (con->last_kbd_macro, Qzero);
|
|
|
150 else
|
|
|
151 return Fexecute_kbd_macro (con->last_kbd_macro,
|
|
|
152 make_int (repeat - 1));
|
|
|
153 }
|
|
|
154
|
|
|
155
|
|
|
156 /* Store event into kbd macro being defined
|
|
|
157 */
|
|
|
158 void
|
|
|
159 store_kbd_macro_event (Lisp_Object event)
|
|
|
160 {
|
|
|
161 struct console *con = event_console_or_selected (event);
|
|
|
162
|
|
173
|
163 if (con->kbd_macro_ptr == XVECTOR_LENGTH (con->kbd_macro_builder))
|
|
0
|
164 {
|
|
|
165 int i;
|
|
173
|
166 int old_size = XVECTOR_LENGTH (con->kbd_macro_builder);
|
|
0
|
167 int new_size = old_size * 2;
|
|
|
168 Lisp_Object new = make_vector (new_size, Qnil);
|
|
|
169 for (i = 0; i < old_size; i++)
|
|
173
|
170 XVECTOR_DATA (new) [i] = XVECTOR_DATA (con->kbd_macro_builder) [i];
|
|
0
|
171 con->kbd_macro_builder = new;
|
|
|
172 }
|
|
173
|
173 XVECTOR_DATA (con->kbd_macro_builder) [con->kbd_macro_ptr++] =
|
|
0
|
174 Fcopy_event (event, Qnil);
|
|
|
175 }
|
|
|
176
|
|
|
177 /* Extract the next kbd-macro element into the given event.
|
|
|
178 If we're done, throws to the catch in Fexecute_kbd_macro().
|
|
|
179 */
|
|
|
180 void
|
|
|
181 pop_kbd_macro_event (Lisp_Object event)
|
|
|
182 {
|
|
|
183 if (NILP (Vexecuting_macro)) abort ();
|
|
|
184
|
|
|
185 if (STRINGP (Vexecuting_macro) || VECTORP (Vexecuting_macro))
|
|
|
186 {
|
|
|
187 if (executing_macro_index < XINT (Flength (Vexecuting_macro)))
|
|
|
188 {
|
|
|
189 nth_of_key_sequence_as_event (Vexecuting_macro,
|
|
|
190 executing_macro_index++,
|
|
|
191 event);
|
|
|
192 return;
|
|
|
193 }
|
|
|
194 }
|
|
|
195 else if (!EQ (Vexecuting_macro, Qt)) /* Some things replace the macro
|
|
|
196 with Qt to force an early exit. */
|
|
|
197 error ("junk in executing-macro");
|
|
|
198
|
|
|
199 Fthrow (Qexecute_kbd_macro, Qt);
|
|
|
200 }
|
|
|
201
|
|
|
202
|
|
|
203 /* Declare that all chars stored so far in the kbd macro being defined
|
|
|
204 really belong to it. This is done in between editor commands. */
|
|
|
205
|
|
|
206 void
|
|
|
207 finalize_kbd_macro_chars (struct console *con)
|
|
|
208 {
|
|
|
209 con->kbd_macro_end = con->kbd_macro_ptr;
|
|
|
210 }
|
|
|
211
|
|
20
|
212 DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events, 0, 0, 0, /*
|
|
0
|
213 Cancel the events added to a keyboard macro for this command.
|
|
20
|
214 */
|
|
|
215 ())
|
|
0
|
216 {
|
|
|
217 struct console *con = XCONSOLE (Vselected_console);
|
|
|
218
|
|
|
219 con->kbd_macro_ptr = con->kbd_macro_end;
|
|
|
220
|
|
|
221 return Qnil;
|
|
|
222 }
|
|
|
223
|
|
20
|
224 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, 0, 1, "p", /*
|
|
0
|
225 Call the last keyboard macro that you defined with \\[start-kbd-macro].
|
|
|
226
|
|
|
227 A prefix argument serves as a repeat count. Zero means repeat until error.
|
|
|
228
|
|
|
229 To make a macro permanent so you can call it even after
|
|
|
230 defining others, use \\[name-last-kbd-macro].
|
|
20
|
231 */
|
|
|
232 (prefix))
|
|
0
|
233 {
|
|
|
234 /* This function can GC */
|
|
|
235 struct console *con = XCONSOLE (Vselected_console);
|
|
|
236
|
|
|
237 if (!NILP (con->defining_kbd_macro))
|
|
|
238 error ("Can't execute anonymous macro while defining one");
|
|
|
239 else if (NILP (con->last_kbd_macro))
|
|
|
240 error ("No kbd macro has been defined");
|
|
|
241 else
|
|
|
242 Fexecute_kbd_macro (con->last_kbd_macro, prefix);
|
|
|
243 return Qnil;
|
|
|
244 }
|
|
|
245
|
|
|
246 /* Restore Vexecuting_macro and executing_macro_index - called when
|
|
|
247 the unwind-protect in Fexecute_kbd_macro gets invoked. */
|
|
|
248 static Lisp_Object
|
|
|
249 pop_kbd_macro (Lisp_Object info)
|
|
|
250 {
|
|
|
251 Vexecuting_macro = Fcar (info);
|
|
272
|
252 executing_macro_index = XINT (Fcdr (info));
|
|
0
|
253 return Qnil;
|
|
|
254 }
|
|
|
255
|
|
20
|
256 DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, 1, 2, 0, /*
|
|
0
|
257 Execute MACRO as string of editor command characters.
|
|
|
258 If MACRO is a symbol, its function definition is used.
|
|
|
259 COUNT is a repeat count, or nil for once, or 0 for infinite loop.
|
|
20
|
260 */
|
|
|
261 (macro, prefixarg))
|
|
0
|
262 {
|
|
|
263 /* This function can GC */
|
|
|
264 Lisp_Object final;
|
|
|
265 Lisp_Object tem;
|
|
|
266 int speccount = specpdl_depth ();
|
|
|
267 int repeat = 1;
|
|
|
268 struct gcpro gcpro1;
|
|
|
269 struct console *con = XCONSOLE (Vselected_console);
|
|
|
270
|
|
|
271 if (!NILP (prefixarg))
|
|
|
272 {
|
|
|
273 prefixarg = Fprefix_numeric_value (prefixarg);
|
|
|
274 repeat = XINT (prefixarg);
|
|
|
275 }
|
|
|
276
|
|
|
277 final = indirect_function (macro, 1);
|
|
|
278 if (!STRINGP (final) && !VECTORP (final))
|
|
|
279 error ("Keyboard macros must be strings or vectors.");
|
|
|
280
|
|
|
281 tem = Fcons (Vexecuting_macro, make_int (executing_macro_index));
|
|
|
282 record_unwind_protect (pop_kbd_macro, tem);
|
|
|
283
|
|
|
284 GCPRO1 (final);
|
|
|
285 do
|
|
|
286 {
|
|
|
287 Vexecuting_macro = final;
|
|
|
288 executing_macro_index = 0;
|
|
|
289 con->prefix_arg = Qnil;
|
|
|
290 internal_catch (Qexecute_kbd_macro, call_command_loop,
|
|
|
291 Qnil, 0);
|
|
|
292 }
|
|
|
293 while (--repeat != 0
|
|
|
294 && (STRINGP (Vexecuting_macro) ||
|
|
|
295 VECTORP (Vexecuting_macro)));
|
|
|
296
|
|
|
297 UNGCPRO;
|
|
|
298 return unbind_to (speccount, Qnil);
|
|
|
299 }
|
|
|
300
|
|
|
301
|
|
|
302 void
|
|
|
303 syms_of_macros (void)
|
|
|
304 {
|
|
20
|
305 DEFSUBR (Fstart_kbd_macro);
|
|
|
306 DEFSUBR (Fend_kbd_macro);
|
|
|
307 DEFSUBR (Fcall_last_kbd_macro);
|
|
|
308 DEFSUBR (Fexecute_kbd_macro);
|
|
|
309 DEFSUBR (Fcancel_kbd_macro_events);
|
|
0
|
310 defsymbol (&Qexecute_kbd_macro, "execute-kbd-macro");
|
|
|
311 }
|
|
|
312
|
|
|
313 void
|
|
|
314 vars_of_macros (void)
|
|
|
315 {
|
|
|
316 DEFVAR_LISP ("executing-macro", &Vexecuting_macro /*
|
|
|
317 Currently executing keyboard macro (a vector of events or string);
|
|
|
318 nil if none executing.
|
|
|
319 */ );
|
|
|
320
|
|
|
321 DEFVAR_LISP ("executing-kbd-macro", &Vexecuting_macro /*
|
|
|
322 Currently executing keyboard macro (a vector of events or string);
|
|
|
323 nil if none executing.
|
|
|
324 */ );
|
|
|
325 }
|
|
|
326
|
|
|
327 void
|
|
|
328 init_macros (void)
|
|
|
329 {
|
|
|
330 Vexecuting_macro = Qnil;
|
|
|
331 }
|
|
|
332
|
