(Fexecute_kbd_macro): Initialize executing_macro_iterations at beginning.
[bpt/emacs.git] / src / macros.c
index 6ed3a86..0d86d9c 100644 (file)
@@ -15,7 +15,8 @@ GNU General Public License for more details.
 
 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., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
 
 
 #include <config.h>
@@ -24,29 +25,33 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #include "commands.h"
 #include "buffer.h"
 #include "window.h"
+#include "keyboard.h"
 
 Lisp_Object Qexecute_kbd_macro;
 
-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_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;
+int executing_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_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_macro;
+
+extern Lisp_Object real_this_command;
 
 Lisp_Object Fexecute_kbd_macro ();
 \f
@@ -60,23 +65,37 @@ Non-nil arg (prefix arg) means append to last macro defined;\n\
   (append)
      Lisp_Object append;
 {
-  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));
+      message ("Appending to kbd macro...");
+      current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end;
+      Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro,
+                         make_number (1));
     }
-  defining_kbd_macro++;
+  current_kboard->defining_kbd_macro = Qt;
   
   return Qnil;
 }
@@ -91,64 +110,91 @@ under that name.\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;
+  (repeat)
+     Lisp_Object repeat;
 {
-  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, 0);
 
-  if (defining_kbd_macro)
+  if (!NILP (current_kboard->defining_kbd_macro))
     {
-      defining_kbd_macro = 0;
+      current_kboard->defining_kbd_macro = Qnil;
       update_mode_lines++;
-      Vlast_kbd_macro = make_event_array (kbd_macro_end - kbd_macro_buffer,
-                                         kbd_macro_buffer);
-      message("Keyboard macro defined");
+      current_kboard->Vlast_kbd_macro
+       = make_event_array ((current_kboard->kbd_macro_end
+                            - current_kboard->kbd_macro_buffer),
+                           current_kboard->kbd_macro_buffer);
+      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);
   else
     {
-      XSETINT (arg, XINT (arg)-1);
-      if (XINT (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);
     }
   return Qnil;
 }
 
 /* Store character c into kbd macro being defined */
 
+void
 store_kbd_macro_char (c)
      Lisp_Object c;
 {
-  if (defining_kbd_macro)
+  if (!NILP (current_kboard->defining_kbd_macro))
     {
-      if (kbd_macro_ptr - kbd_macro_buffer == kbd_macro_bufsize)
+      if ((current_kboard->kbd_macro_ptr
+          - current_kboard->kbd_macro_buffer)
+         == current_kboard->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;
+         register Lisp_Object *new;
+         current_kboard->kbd_macro_bufsize *= 2;
+         new = (Lisp_Object *)xrealloc (current_kboard->kbd_macro_buffer,
+                                        (current_kboard->kbd_macro_bufsize
+                                         * sizeof (Lisp_Object)));
+         current_kboard->kbd_macro_ptr
+           += new - current_kboard->kbd_macro_buffer;
+         current_kboard->kbd_macro_end
+           += new - current_kboard->kbd_macro_buffer;
+         current_kboard->kbd_macro_buffer = new;
        }
-      *kbd_macro_ptr++ = c;
+      *current_kboard->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,
+  "Cancel the events added to a keyboard macro for this command.")
+  ()
+{
+  current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end;
+}
+
+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)
+     Lisp_Object event;
+{
+  store_kbd_macro_char (event);
+  return Qnil;
 }
 \f
 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro,
@@ -162,17 +208,28 @@ defining others, use \\[name-last-kbd-macro].")
   (prefix)
      Lisp_Object prefix;
 {
-  if (defining_kbd_macro)
+  /* Don't interfere with recognition of the previous command
+     from before this macro started.  */
+  Vthis_command = current_kboard->Vlast_command;
+
+  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);
+
+  /* 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.  */
+
 static Lisp_Object
 pop_kbd_macro (info)
      Lisp_Object info;
@@ -188,24 +245,29 @@ 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;
+  (macro, count)
+     Lisp_Object macro, count;
 {
   Lisp_Object final;
   Lisp_Object tem;
-  int count = specpdl_ptr - specpdl;
+  int pdlcount = specpdl_ptr - specpdl;
   int repeat = 1;
   struct gcpro gcpro1;
+  int success_count = 0;
 
-  if (!NILP (prefixarg))
-    prefixarg = Fprefix_numeric_value (prefixarg),
-    repeat = XINT (prefixarg);
+  executing_macro_iterations = 0;
+
+  if (!NILP (count))
+    {
+      count = Fprefix_numeric_value (count);
+      repeat = XINT (count);
+    }
 
   final = indirect_function (macro);
   if (!STRINGP (final) && !VECTORP (final))
-    error ("Keyboard macros must be strings or vectors.");
+    error ("Keyboard macros must be strings or vectors");
 
-  XFASTINT (tem) = executing_macro_index;
+  XSETFASTINT (tem, executing_macro_index);
   tem = Fcons (Vexecuting_macro, tem);
   record_unwind_protect (pop_kbd_macro, tem);
 
@@ -213,33 +275,37 @@ COUNT is a repeat count, or nil for once, or 0 for infinite loop.")
   do
     {
       Vexecuting_macro = final;
+      executing_macro = final;
       executing_macro_index = 0;
 
+      current_kboard->Vprefix_arg = Qnil;
       command_loop_1 ();
 
+      executing_macro_iterations = ++success_count;
+
       QUIT;
     }
   while (--repeat
         && (STRINGP (Vexecuting_macro) || VECTORP (Vexecuting_macro)));
 
+  executing_macro = Qnil;
+
+  real_this_command = Vexecuting_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;
+  executing_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);
 
@@ -247,20 +313,23 @@ syms_of_macros ()
   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,
+  DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
     "Non-nil while a keyboard macro is being defined.  Don't set this!");
 
   DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
-    "Currently executing keyboard macro (a string); nil if none executing.");
+    "Currently executing keyboard macro (string or vector); nil if none executing.");
 
   DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro,
-    "Currently executing keyboard macro (a string); nil if none executing.");
+    "Currently executing keyboard macro (string or vector); nil 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,
+    "Last kbd macro defined, as a string or vector; nil if none defined.");
 }
 
+void
 keys_of_macros ()
 {
   initial_define_key (control_x_map, ('e'), "call-last-kbd-macro");