2 Copyright (C) 1985, 1986, 1993 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
28 Lisp_Object Qexecute_kbd_macro
;
30 Lisp_Object Vexecuting_macro
;
31 int executing_macro_index
;
33 Lisp_Object
Fexecute_kbd_macro ();
35 DEFUN ("start-kbd-macro", Fstart_kbd_macro
, Sstart_kbd_macro
, 1, 1, "P",
36 "Record subsequent keyboard input, defining a keyboard macro.\n\
37 The commands are recorded even as they are executed.\n\
38 Use \\[end-kbd-macro] to finish recording and make the macro available.\n\
39 Use \\[name-last-kbd-macro] to give it a permanent name.\n\
40 Non-nil arg (prefix arg) means append to last macro defined;\n\
41 This begins by re-executing that macro as if you typed it again.")
45 if (!NILP (current_kboard
->defining_kbd_macro
))
46 error ("Already defining kbd macro");
48 if (!current_kboard
->kbd_macro_buffer
)
50 current_kboard
->kbd_macro_bufsize
= 30;
51 current_kboard
->kbd_macro_buffer
52 = (Lisp_Object
*)malloc (30 * sizeof (Lisp_Object
));
57 current_kboard
->kbd_macro_ptr
= current_kboard
->kbd_macro_buffer
;
58 current_kboard
->kbd_macro_end
= current_kboard
->kbd_macro_buffer
;
59 message("Defining kbd macro...");
63 message("Appending to kbd macro...");
64 current_kboard
->kbd_macro_ptr
= current_kboard
->kbd_macro_end
;
65 Fexecute_kbd_macro (current_kboard
->Vlast_kbd_macro
,
68 current_kboard
->defining_kbd_macro
= Qt
;
73 DEFUN ("end-kbd-macro", Fend_kbd_macro
, Send_kbd_macro
, 0, 1, "p",
74 "Finish defining a keyboard macro.\n\
75 The definition was started by \\[start-kbd-macro].\n\
76 The macro is now available for use via \\[call-last-kbd-macro],\n\
77 or it can be given a name with \\[name-last-kbd-macro] and then invoked\n\
80 With numeric arg, repeat macro now that many times,\n\
81 counting the definition just completed as the first repetition.\n\
82 An argument of zero means repeat until error.")
86 if (NILP (current_kboard
->defining_kbd_macro
))
87 error ("Not defining kbd macro.");
92 CHECK_NUMBER (arg
, 0);
94 if (!NILP (current_kboard
->defining_kbd_macro
))
96 current_kboard
->defining_kbd_macro
= Qnil
;
98 current_kboard
->Vlast_kbd_macro
99 = make_event_array ((current_kboard
->kbd_macro_end
100 - current_kboard
->kbd_macro_buffer
),
101 current_kboard
->kbd_macro_buffer
);
102 message("Keyboard macro defined");
105 if (XFASTINT (arg
) == 0)
106 Fexecute_kbd_macro (current_kboard
->Vlast_kbd_macro
, arg
);
109 XSETINT (arg
, XINT (arg
)-1);
111 Fexecute_kbd_macro (current_kboard
->Vlast_kbd_macro
, arg
);
116 /* Store character c into kbd macro being defined */
118 store_kbd_macro_char (c
)
121 if (!NILP (current_kboard
->defining_kbd_macro
))
123 if ((current_kboard
->kbd_macro_ptr
124 - current_kboard
->kbd_macro_buffer
)
125 == current_kboard
->kbd_macro_bufsize
)
127 register Lisp_Object
*new;
128 current_kboard
->kbd_macro_bufsize
*= 2;
129 new = (Lisp_Object
*)xrealloc (current_kboard
->kbd_macro_buffer
,
130 (current_kboard
->kbd_macro_bufsize
131 * sizeof (Lisp_Object
)));
132 current_kboard
->kbd_macro_ptr
133 += new - current_kboard
->kbd_macro_buffer
;
134 current_kboard
->kbd_macro_end
135 += new - current_kboard
->kbd_macro_buffer
;
136 current_kboard
->kbd_macro_buffer
= new;
138 *current_kboard
->kbd_macro_ptr
++ = c
;
142 /* Declare that all chars stored so far in the kbd macro being defined
143 really belong to it. This is done in between editor commands. */
145 finalize_kbd_macro_chars ()
147 current_kboard
->kbd_macro_end
= current_kboard
->kbd_macro_ptr
;
150 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro
, Scall_last_kbd_macro
,
152 "Call the last keyboard macro that you defined with \\[start-kbd-macro].\n\
154 A prefix argument serves as a repeat count. Zero means repeat until error.\n\
156 To make a macro permanent so you can call it even after\n\
157 defining others, use \\[name-last-kbd-macro].")
161 if (! NILP (current_kboard
->defining_kbd_macro
))
162 error ("Can't execute anonymous macro while defining one");
163 else if (NILP (current_kboard
->Vlast_kbd_macro
))
164 error ("No kbd macro has been defined");
166 Fexecute_kbd_macro (current_kboard
->Vlast_kbd_macro
, prefix
);
170 /* Restore Vexecuting_macro and executing_macro_index - called when
171 the unwind-protect in Fexecute_kbd_macro gets invoked. */
177 Vexecuting_macro
= Fcar (info
);
179 executing_macro_index
= XINT (tem
);
183 DEFUN ("execute-kbd-macro", Fexecute_kbd_macro
, Sexecute_kbd_macro
, 1, 2, 0,
184 "Execute MACRO as string of editor command characters.\n\
185 If MACRO is a symbol, its function definition is used.\n\
186 COUNT is a repeat count, or nil for once, or 0 for infinite loop.")
188 Lisp_Object macro
, prefixarg
;
192 int count
= specpdl_ptr
- specpdl
;
196 if (!NILP (prefixarg
))
197 prefixarg
= Fprefix_numeric_value (prefixarg
),
198 repeat
= XINT (prefixarg
);
200 final
= indirect_function (macro
);
201 if (!STRINGP (final
) && !VECTORP (final
))
202 error ("Keyboard macros must be strings or vectors.");
204 XSETFASTINT (tem
, executing_macro_index
);
205 tem
= Fcons (Vexecuting_macro
, tem
);
206 record_unwind_protect (pop_kbd_macro
, tem
);
211 Vexecuting_macro
= final
;
212 executing_macro_index
= 0;
220 && (STRINGP (Vexecuting_macro
) || VECTORP (Vexecuting_macro
)));
223 return unbind_to (count
, Qnil
);
228 Vexecuting_macro
= Qnil
;
233 Qexecute_kbd_macro
= intern ("execute-kbd-macro");
234 staticpro (&Qexecute_kbd_macro
);
236 defsubr (&Sstart_kbd_macro
);
237 defsubr (&Send_kbd_macro
);
238 defsubr (&Scall_last_kbd_macro
);
239 defsubr (&Sexecute_kbd_macro
);
241 DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro
,
242 "Non-nil while a keyboard macro is being defined. Don't set this!");
244 DEFVAR_LISP ("executing-macro", &Vexecuting_macro
,
245 "Currently executing keyboard macro (string or vector); nil if none executing.");
247 DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro
,
248 "Currently executing keyboard macro (string or vector); nil if none executing.");
250 DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro
,
251 "Last kbd macro defined, as a string or vector; nil if none defined.");
256 initial_define_key (control_x_map
, ('e'), "call-last-kbd-macro");
257 initial_define_key (control_x_map
, ('('), "start-kbd-macro");
258 initial_define_key (control_x_map
, (')'), "end-kbd-macro");