#include "buffer.h"
#include "window.h"
#include "keyboard.h"
-#include "keymap.h"
Lisp_Object Qexecute_kbd_macro, Qkbd_macro_termination_hook;
Lisp_Object Fexecute_kbd_macro ();
\f
-DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 1, "P",
- "Record subsequent keyboard input, defining a keyboard macro.\n\
-The commands are recorded even as they are executed.\n\
-Use \\[end-kbd-macro] to finish recording and make the macro available.\n\
-Use \\[name-last-kbd-macro] to give it a permanent name.\n\
-Non-nil arg (prefix arg) means append to last macro defined;\n\
-this begins by re-executing that macro as if you typed it again.")
- (append)
- Lisp_Object append;
+DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 2, "P",
+ doc: /* Record subsequent keyboard input, defining a keyboard macro.
+The commands are recorded even as they are executed.
+Use \\[end-kbd-macro] to finish recording and make the macro available.
+Use \\[name-last-kbd-macro] to give it a permanent name.
+Non-nil arg (prefix arg) means append to last macro defined;
+this begins by re-executing that macro as if you typed it again.
+If optional second arg, NO-EXEC, is non-nil, do not re-execute last
+macro before appending to it. */)
+ (append, no_exec)
+ Lisp_Object append, no_exec;
{
if (!NILP (current_kboard->defining_kbd_macro))
error ("Already defining kbd macro");
/* Re-execute the macro we are appending to,
for consistency of behavior. */
- Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro,
- make_number (1));
+ if (NILP (no_exec))
+ Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro,
+ make_number (1), Qnil);
message ("Appending to kbd macro...");
}
return Qnil;
}
-DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 1, "p",
- "Finish defining a keyboard macro.\n\
-The definition was started by \\[start-kbd-macro].\n\
-The macro is now available for use via \\[call-last-kbd-macro],\n\
-or it can be given a name with \\[name-last-kbd-macro] and then invoked\n\
-under that name.\n\
-\n\
-With numeric arg, repeat macro now that many times,\n\
-counting the definition just completed as the first repetition.\n\
-An argument of zero means repeat until error.")
- (repeat)
- Lisp_Object repeat;
+DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 2, "p",
+ doc: /* Finish defining a keyboard macro.
+The definition was started by \\[start-kbd-macro].
+The macro is now available for use via \\[call-last-kbd-macro],
+or it can be given a name with \\[name-last-kbd-macro] and then invoked
+under that name.
+
+With numeric arg, repeat macro now that many times,
+counting the definition just completed as the first repetition.
+An argument of zero means repeat until error.
+
+In Lisp, optional second arg LOOPFUNC may be a function that is called prior to
+each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */)
+ (repeat, loopfunc)
+ Lisp_Object repeat, loopfunc;
{
if (NILP (current_kboard->defining_kbd_macro))
error ("Not defining kbd macro");
if (NILP (repeat))
XSETFASTINT (repeat, 1);
else
- CHECK_NUMBER (repeat, 0);
+ CHECK_NUMBER (repeat);
if (!NILP (current_kboard->defining_kbd_macro))
{
}
if (XFASTINT (repeat) == 0)
- Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat);
+ Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat, loopfunc);
else
{
XSETINT (repeat, XINT (repeat)-1);
if (XINT (repeat) > 0)
- Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat);
+ Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat, loopfunc);
}
return Qnil;
}
DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events,
Scancel_kbd_macro_events, 0, 0, 0,
- "Cancel the events added to a keyboard macro for this command.")
- ()
+ doc: /* Cancel the events added to a keyboard macro for this command. */)
+ ()
{
current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end;
return Qnil;
DEFUN ("store-kbd-macro-event", Fstore_kbd_macro_event,
Sstore_kbd_macro_event, 1, 1, 0,
- "Store EVENT into the keyboard macro being defined.")
- (event)
+ doc: /* Store EVENT into the keyboard macro being defined. */)
+ (event)
Lisp_Object event;
{
store_kbd_macro_char (event);
}
\f
DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro,
- 0, 1, "p",
- "Call the last keyboard macro that you defined with \\[start-kbd-macro].\n\
-\n\
-A prefix argument serves as a repeat count. Zero means repeat until error.\n\
-\n\
-To make a macro permanent so you can call it even after\n\
-defining others, use \\[name-last-kbd-macro].")
- (prefix)
- Lisp_Object prefix;
+ 0, 2, "p",
+ doc: /* Call the last keyboard macro that you defined with \\[start-kbd-macro].
+
+A prefix argument serves as a repeat count. Zero means repeat until error.
+
+To make a macro permanent so you can call it even after
+defining others, use \\[name-last-kbd-macro].
+
+In Lisp, optional second arg LOOPFUNC may be a function that is called prior to
+each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */)
+ (prefix, loopfunc)
+ Lisp_Object prefix, loopfunc;
{
/* Don't interfere with recognition of the previous command
from before this macro started. */
else if (NILP (current_kboard->Vlast_kbd_macro))
error ("No kbd macro has been defined");
else
- Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, prefix);
+ Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, prefix, loopfunc);
/* command_loop_1 sets this to nil before it returns;
get back the last command within the macro
return Qnil;
}
-DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 2, 0,
- "Execute MACRO as string of editor command characters.\n\
-If MACRO is a symbol, its function definition is used.\n\
-COUNT is a repeat count, or nil for once, or 0 for infinite loop.")
- (macro, count)
- Lisp_Object macro, count;
+DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 3, 0,
+ doc: /* Execute MACRO as string of editor command characters.
+If MACRO is a symbol, its function definition is used.
+COUNT is a repeat count, or nil for once, or 0 for infinite loop.
+
+Optional third arg LOOPFUNC may be a function that is called prior to
+each iteration of the macro. Iteration stops if LOOPFUNC returns nil. */)
+ (macro, count, loopfunc)
+ Lisp_Object macro, count, loopfunc;
{
Lisp_Object final;
Lisp_Object tem;
- int pdlcount = specpdl_ptr - specpdl;
+ int pdlcount = SPECPDL_INDEX ();
int repeat = 1;
- struct gcpro gcpro1;
+ struct gcpro gcpro1, gcpro2;
int success_count = 0;
executing_macro_iterations = 0;
real_this_command));
record_unwind_protect (pop_kbd_macro, tem);
- GCPRO1 (final);
+ GCPRO2 (final, loopfunc);
do
{
Vexecuting_macro = final;
executing_macro_index = 0;
current_kboard->Vprefix_arg = Qnil;
+
+ if (!NILP (loopfunc))
+ {
+ Lisp_Object cont;
+ cont = call0 (loopfunc);
+ if (NILP (cont))
+ break;
+ }
+
command_loop_1 ();
executing_macro_iterations = ++success_count;
defsubr (&Sstore_kbd_macro_event);
DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
- "Non-nil while a keyboard macro is being defined. Don't set this!");
+ doc: /* Non-nil while a keyboard macro is being defined. Don't set this! */);
DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
- "Currently executing keyboard macro (string or vector); nil if none executing.");
+ doc: /* Currently executing keyboard macro (string or vector); nil if none executing. */);
DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro,
- "Currently executing keyboard macro (string or vector); nil if none executing.");
+ doc: /* Currently executing keyboard macro (string or vector); nil if none executing. */);
DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro,
- "Last kbd macro defined, as a string or vector; nil if none defined.");
+ doc: /* Last kbd macro defined, as a string or vector; nil if none defined. */);
}