/* Keyboard macros.
- Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
+ Copyright (C) 1985, 1986, 1993, 2000, 2001, 2002, 2003, 2004,
+ 2005, 2006 Free Software Foundation, Inc.
This file is part of GNU Emacs.
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING. If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA. */
-#include "config.h"
+#include <config.h>
#include "lisp.h"
#include "macros.h"
#include "commands.h"
#include "buffer.h"
#include "window.h"
+#include "keyboard.h"
-Lisp_Object Qexecute_kbd_macro;
+Lisp_Object Qexecute_kbd_macro, Qkbd_macro_termination_hook;
-int defining_kbd_macro;
+/* Kbd macro currently being executed (a string or vector). */
-/* The start of storage for the current keyboard macro, and its size. */
-Lisp_Object *kbd_macro_buffer;
-int kbd_macro_bufsize;
+Lisp_Object Vexecuting_kbd_macro;
-/* Where to store the next keystroke of the macro. */
-Lisp_Object *kbd_macro_ptr;
+/* Index of next character to fetch from that macro. */
-/* The finalized section of the macro starts at kbd_macro_buffer and
- ends before this. This is not the same as kbd_macro_pointer, because
- we advance this to kbd_macro_pointer when a key's command is complete.
- This way, the keystrokes for "end-kbd-macro" are not included in the
- macro. */
-Lisp_Object *kbd_macro_end;
+EMACS_INT executing_kbd_macro_index;
-Lisp_Object Vlast_kbd_macro;
+/* Number of successful iterations so far
+ for innermost keyboard macro.
+ This is not bound at each level,
+ so after an error, it describes the innermost interrupted macro. */
-Lisp_Object Vexecuting_macro;
-int executing_macro_index;
+int executing_kbd_macro_iterations;
+
+/* This is the macro that was executing.
+ This is not bound at each level,
+ so after an error, it describes the innermost interrupted macro.
+ We use it only as a kind of flag, so no need to protect it. */
+
+Lisp_Object executing_kbd_macro;
+
+extern Lisp_Object real_this_command;
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 (defining_kbd_macro)
+ if (!NILP (current_kboard->defining_kbd_macro))
error ("Already defining kbd macro");
+ if (!current_kboard->kbd_macro_buffer)
+ {
+ current_kboard->kbd_macro_bufsize = 30;
+ current_kboard->kbd_macro_buffer
+ = (Lisp_Object *)xmalloc (30 * sizeof (Lisp_Object));
+ }
update_mode_lines++;
if (NILP (append))
{
- kbd_macro_ptr = kbd_macro_buffer;
- kbd_macro_end = kbd_macro_buffer;
- message("Defining kbd macro...");
+ if (current_kboard->kbd_macro_bufsize > 200)
+ {
+ current_kboard->kbd_macro_bufsize = 30;
+ current_kboard->kbd_macro_buffer
+ = (Lisp_Object *)xrealloc (current_kboard->kbd_macro_buffer,
+ 30 * sizeof (Lisp_Object));
+ }
+ current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer;
+ current_kboard->kbd_macro_end = current_kboard->kbd_macro_buffer;
+ message ("Defining kbd macro...");
}
else
{
- message("Appending to kbd macro...");
- kbd_macro_ptr = kbd_macro_end;
- Fexecute_kbd_macro (Vlast_kbd_macro, make_number (1));
+ int i, len;
+ int cvt;
+
+ /* Check the type of last-kbd-macro in case Lisp code changed it. */
+ if (!STRINGP (current_kboard->Vlast_kbd_macro)
+ && !VECTORP (current_kboard->Vlast_kbd_macro))
+ current_kboard->Vlast_kbd_macro
+ = wrong_type_argument (Qarrayp, current_kboard->Vlast_kbd_macro);
+
+ len = XINT (Flength (current_kboard->Vlast_kbd_macro));
+
+ /* Copy last-kbd-macro into the buffer, in case the Lisp code
+ has put another macro there. */
+ if (current_kboard->kbd_macro_bufsize < len + 30)
+ {
+ current_kboard->kbd_macro_bufsize = len + 30;
+ current_kboard->kbd_macro_buffer
+ = (Lisp_Object *)xrealloc (current_kboard->kbd_macro_buffer,
+ (len + 30) * sizeof (Lisp_Object));
+ }
+
+ /* Must convert meta modifier when copying string to vector. */
+ cvt = STRINGP (current_kboard->Vlast_kbd_macro);
+ for (i = 0; i < len; i++)
+ {
+ Lisp_Object c;
+ c = Faref (current_kboard->Vlast_kbd_macro, make_number (i));
+ if (cvt && NATNUMP (c) && (XFASTINT (c) & 0x80))
+ XSETFASTINT (c, CHAR_META | (XFASTINT (c) & ~0x80));
+ current_kboard->kbd_macro_buffer[i] = c;
+ }
+
+ current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer + len;
+ current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr;
+
+ /* Re-execute the macro we are appending to,
+ for consistency of behavior. */
+ if (NILP (no_exec))
+ Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro,
+ make_number (1), Qnil);
+
+ message ("Appending to kbd macro...");
}
- defining_kbd_macro++;
-
+ current_kboard->defining_kbd_macro = Qt;
+
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.")
- (arg)
- Lisp_Object arg;
+/* Finish defining the current keyboard macro. */
+
+void
+end_kbd_macro ()
+{
+ current_kboard->defining_kbd_macro = Qnil;
+ update_mode_lines++;
+ current_kboard->Vlast_kbd_macro
+ = make_event_array ((current_kboard->kbd_macro_end
+ - current_kboard->kbd_macro_buffer),
+ current_kboard->kbd_macro_buffer);
+}
+
+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 (!defining_kbd_macro)
- error ("Not defining kbd macro.");
+ if (NILP (current_kboard->defining_kbd_macro))
+ error ("Not defining kbd macro");
- if (NILP (arg))
- XFASTINT (arg) = 1;
+ if (NILP (repeat))
+ XSETFASTINT (repeat, 1);
else
- CHECK_NUMBER (arg, 0);
+ CHECK_NUMBER (repeat);
- if (defining_kbd_macro)
+ if (!NILP (current_kboard->defining_kbd_macro))
{
- defining_kbd_macro = 0;
- update_mode_lines++;
- Vlast_kbd_macro = make_array (kbd_macro_end - kbd_macro_buffer,
- kbd_macro_buffer);
- message("Keyboard macro defined");
+ end_kbd_macro ();
+ message ("Keyboard macro defined");
}
- if (XFASTINT (arg) == 0)
- Fexecute_kbd_macro (Vlast_kbd_macro, arg);
+ if (XFASTINT (repeat) == 0)
+ Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat, loopfunc);
else
{
- XFASTINT (arg)--;
- if (XFASTINT (arg) > 0)
- Fexecute_kbd_macro (Vlast_kbd_macro, arg);
+ XSETINT (repeat, XINT (repeat)-1);
+ if (XINT (repeat) > 0)
+ Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, repeat, loopfunc);
}
return Qnil;
}
/* Store character c into kbd macro being defined */
+void
store_kbd_macro_char (c)
Lisp_Object c;
{
- if (defining_kbd_macro)
+ struct kboard *kb = current_kboard;
+
+ if (!NILP (kb->defining_kbd_macro))
{
- if (kbd_macro_ptr - kbd_macro_buffer == kbd_macro_bufsize)
+ if (kb->kbd_macro_ptr - kb->kbd_macro_buffer == kb->kbd_macro_bufsize)
{
- register Lisp_Object *new
- = (Lisp_Object *) xrealloc (kbd_macro_buffer,
- ((kbd_macro_bufsize *= 2)
- * sizeof (Lisp_Object)));
- kbd_macro_ptr += new - kbd_macro_buffer;
- kbd_macro_end += new - kbd_macro_buffer;
- kbd_macro_buffer = new;
+ int ptr_offset, end_offset, nbytes;
+
+ ptr_offset = kb->kbd_macro_ptr - kb->kbd_macro_buffer;
+ end_offset = kb->kbd_macro_end - kb->kbd_macro_buffer;
+ kb->kbd_macro_bufsize *= 2;
+ nbytes = kb->kbd_macro_bufsize * sizeof *kb->kbd_macro_buffer;
+ kb->kbd_macro_buffer
+ = (Lisp_Object *) xrealloc (kb->kbd_macro_buffer, nbytes);
+ kb->kbd_macro_ptr = kb->kbd_macro_buffer + ptr_offset;
+ kb->kbd_macro_end = kb->kbd_macro_buffer + end_offset;
}
- *kbd_macro_ptr++ = c;
+
+ *kb->kbd_macro_ptr++ = c;
}
}
/* Declare that all chars stored so far in the kbd macro being defined
really belong to it. This is done in between editor commands. */
+void
finalize_kbd_macro_chars ()
{
- kbd_macro_end = kbd_macro_ptr;
+ current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr;
+}
+
+DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events,
+ Scancel_kbd_macro_events, 0, 0, 0,
+ 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,
+ doc: /* Store EVENT into the keyboard macro being defined. */)
+ (event)
+ Lisp_Object event;
+{
+ store_kbd_macro_char (event);
+ return Qnil;
}
\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;
{
- if (defining_kbd_macro)
+ /* Don't interfere with recognition of the previous command
+ from before this macro started. */
+ Vthis_command = current_kboard->Vlast_command;
+ /* C-x z after the macro should repeat the macro. */
+ real_this_command = current_kboard->Vlast_kbd_macro;
+
+ if (! NILP (current_kboard->defining_kbd_macro))
error ("Can't execute anonymous macro while defining one");
- else if (NILP (Vlast_kbd_macro))
+ else if (NILP (current_kboard->Vlast_kbd_macro))
error ("No kbd macro has been defined");
else
- Fexecute_kbd_macro (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
+ so that it can be last, again, after we return. */
+ Vthis_command = current_kboard->Vlast_command;
+
return Qnil;
}
-/* Restore Vexecuting_macro and executing_macro_index - called when
- the unwind-protect in Fexecute_kbd_macro gets invoked. */
+/* Restore Vexecuting_kbd_macro and executing_kbd_macro_index.
+ Called when the unwind-protect in Fexecute_kbd_macro gets invoked. */
+
static Lisp_Object
pop_kbd_macro (info)
Lisp_Object info;
{
Lisp_Object tem;
- Vexecuting_macro = Fcar (info);
- tem = Fcdr (info);
- executing_macro_index = XINT (tem);
+ Vexecuting_kbd_macro = XCAR (info);
+ tem = XCDR (info);
+ executing_kbd_macro_index = XINT (XCAR (tem));
+ real_this_command = XCDR (tem);
+ Frun_hooks (1, &Qkbd_macro_termination_hook);
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, prefixarg)
- Lisp_Object macro, prefixarg;
+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 count = specpdl_ptr - specpdl;
+ int pdlcount = SPECPDL_INDEX ();
int repeat = 1;
- struct gcpro gcpro1;
+ struct gcpro gcpro1, gcpro2;
+ int success_count = 0;
+
+ executing_kbd_macro_iterations = 0;
- if (!NILP (prefixarg))
- prefixarg = Fprefix_numeric_value (prefixarg),
- repeat = XINT (prefixarg);
+ if (!NILP (count))
+ {
+ count = Fprefix_numeric_value (count);
+ repeat = XINT (count);
+ }
final = indirect_function (macro);
- if (XTYPE (final) != Lisp_String
- && XTYPE (final) != Lisp_Vector)
- error ("Keyboard macros must be strings or vectors.");
+ if (!STRINGP (final) && !VECTORP (final))
+ error ("Keyboard macros must be strings or vectors");
- XFASTINT (tem) = executing_macro_index;
- tem = Fcons (Vexecuting_macro, tem);
+ tem = Fcons (Vexecuting_kbd_macro,
+ Fcons (make_number (executing_kbd_macro_index),
+ real_this_command));
record_unwind_protect (pop_kbd_macro, tem);
- GCPRO1 (final);
+ GCPRO2 (final, loopfunc);
do
{
- Vexecuting_macro = final;
- executing_macro_index = 0;
+ Vexecuting_kbd_macro = final;
+ executing_kbd_macro = final;
+ executing_kbd_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_kbd_macro_iterations = ++success_count;
+
+ QUIT;
}
- while (--repeat && (XTYPE (Vexecuting_macro) == Lisp_String
- || XTYPE (Vexecuting_macro) == Lisp_Vector));
+ while (--repeat
+ && (STRINGP (Vexecuting_kbd_macro) || VECTORP (Vexecuting_kbd_macro)));
+
+ executing_kbd_macro = Qnil;
+
+ real_this_command = Vexecuting_kbd_macro;
UNGCPRO;
- return unbind_to (count, Qnil);
+ return unbind_to (pdlcount, Qnil);
}
\f
+void
init_macros ()
{
- Vlast_kbd_macro = Qnil;
- defining_kbd_macro = 0;
-
- Vexecuting_macro = Qnil;
+ Vexecuting_kbd_macro = Qnil;
+ executing_kbd_macro = Qnil;
}
+void
syms_of_macros ()
{
- kbd_macro_bufsize = 100;
- kbd_macro_buffer = (Lisp_Object *) malloc (kbd_macro_bufsize
- * sizeof (Lisp_Object));
-
Qexecute_kbd_macro = intern ("execute-kbd-macro");
staticpro (&Qexecute_kbd_macro);
+ Qkbd_macro_termination_hook = intern ("kbd-macro-termination-hook");
+ staticpro (&Qkbd_macro_termination_hook);
defsubr (&Sstart_kbd_macro);
defsubr (&Send_kbd_macro);
defsubr (&Scall_last_kbd_macro);
defsubr (&Sexecute_kbd_macro);
+ defsubr (&Scancel_kbd_macro_events);
+ defsubr (&Sstore_kbd_macro_event);
- DEFVAR_BOOL ("defining-kbd-macro", &defining_kbd_macro,
- "Non-nil while a keyboard macro is being defined. Don't set this!");
+ DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
+ doc: /* Non-nil while a keyboard macro is being defined. Don't set this!
+The value is the symbol `append' while appending to the definition of
+an existing macro. */);
- DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
- "Currently executing keyboard macro (a string); nil if none executing.");
+ DEFVAR_LISP ("executing-kbd-macro", &Vexecuting_kbd_macro,
+ doc: /* Currently executing keyboard macro (string or vector).
+This is nil when not executing a keyboard macro. */);
- DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro,
- "Currently executing keyboard macro (a string); nil if none executing.");
+ DEFVAR_INT ("executing-kbd-macro-index", &executing_kbd_macro_index,
+ doc: /* Index in currently executing keyboard macro; undefined if none executing. */);
- DEFVAR_LISP ("last-kbd-macro", &Vlast_kbd_macro,
- "Last kbd macro defined, as a string; nil if none defined.");
+ DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro,
+ doc: /* Last kbd macro defined, as a string or vector; nil if none defined. */);
}
-keys_of_macros ()
-{
- initial_define_key (control_x_map, ('e'), "call-last-kbd-macro");
- initial_define_key (control_x_map, ('('), "start-kbd-macro");
- initial_define_key (control_x_map, (')'), "end-kbd-macro");
-}
+/* arch-tag: d293fcc9-2266-4163-9198-7fa0de12ec9e
+ (do not change this comment) */