(echo-area-clear-hook): Undo Oct 29 change.

[bpt/emacs.git] / src / macros.c

diff --git a/src/macros.c b/src/macros.c
index 75227ec..4bacf78 100644 (file)
--- a/src/macros.c
+++ b/src/macros.c
@@ -1,5 +1,5 @@
 /* Keyboard macros.
 /* Keyboard macros.

-   Copyright (C) 1985, 1986, 1993 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1986, 1993, 2000, 2001 Free Software Foundation, Inc.

 
 This file is part of GNU Emacs.
 
 
 This file is part of GNU Emacs.
 


@@ -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
 
 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>
 
 
 #include <config.h>


@@ -24,14 +25,34 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #include "commands.h"
 #include "buffer.h"
 #include "window.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;

 
 

-Lisp_Object Vlast_kbd_macro;
+/* Kbd macro currently being executed (a string or vector).  */

 
 Lisp_Object Vexecuting_macro;
 
 Lisp_Object Vexecuting_macro;

+
+/* Index of next character to fetch from that macro.  */
+

 int executing_macro_index;
 
 int executing_macro_index;
 

+/* 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.  */
+
+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
 DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 1, "P",
 Lisp_Object Fexecute_kbd_macro ();
 \f
 DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 1, "P",


@@ -40,33 +61,69 @@ 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\
 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.")
+this begins by re-executing that macro as if you typed it again.")

   (append)
      Lisp_Object append;
 {
   (append)
      Lisp_Object append;
 {

-  if (!NILP (current_perdisplay->defining_kbd_macro))
+  if (!NILP (current_kboard->defining_kbd_macro))

     error ("Already defining kbd macro");
 
     error ("Already defining kbd macro");
 

-  if (!current_perdisplay->kbd_macro_buffer)
+  if (!current_kboard->kbd_macro_buffer)

     {
     {

-      current_perdisplay->kbd_macro_bufsize = 30;
-      current_perdisplay->kbd_macro_buffer
-       = (Lisp_Object *)malloc (30 * sizeof (Lisp_Object));
+      current_kboard->kbd_macro_bufsize = 30;
+      current_kboard->kbd_macro_buffer
+       = (Lisp_Object *)xmalloc (30 * sizeof (Lisp_Object));

     }
   update_mode_lines++;
   if (NILP (append))
     {
     }
   update_mode_lines++;
   if (NILP (append))
     {

-      current_perdisplay->kbd_macro_ptr = current_perdisplay->kbd_macro_buffer;
-      current_perdisplay->kbd_macro_end = current_perdisplay->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
     {
     }
   else
     {

-      message("Appending to kbd macro...");
-      current_perdisplay->kbd_macro_ptr = current_perdisplay->kbd_macro_end;
-      Fexecute_kbd_macro (Vlast_kbd_macro, make_number (1));
+      int i, len;
+
+      /* 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));
+       }
+      for (i = 0; i < len; i++)
+       current_kboard->kbd_macro_buffer[i]
+         = Faref (current_kboard->Vlast_kbd_macro, make_number (i));
+
+      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.  */
+      Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro,
+                         make_number (1));
+
+      message ("Appending to kbd macro...");

     }
     }

-  current_perdisplay->defining_kbd_macro = Qt;
+  current_kboard->defining_kbd_macro = Qt;

   
   return Qnil;
 }
   
   return Qnil;
 }


@@ -81,71 +138,93 @@ 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.")
 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 (NILP (current_perdisplay->defining_kbd_macro))
-      error ("Not defining kbd macro.");
+  if (NILP (current_kboard->defining_kbd_macro))
+    error ("Not defining kbd macro");

 
 

-  if (NILP (arg))
-    XSETFASTINT (arg, 1);
+  if (NILP (repeat))
+    XSETFASTINT (repeat, 1);

   else
   else

-    CHECK_NUMBER (arg, 0);
+    CHECK_NUMBER (repeat);

 
 

-  if (!NILP (current_perdisplay->defining_kbd_macro))
+  if (!NILP (current_kboard->defining_kbd_macro))

     {
     {

-      current_perdisplay->defining_kbd_macro = Qnil;
+      current_kboard->defining_kbd_macro = Qnil;

       update_mode_lines++;
       update_mode_lines++;

-      Vlast_kbd_macro
-       = make_event_array ((current_perdisplay->kbd_macro_end
-                            - current_perdisplay->kbd_macro_buffer),
-                           current_perdisplay->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
     {
   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 */
 
     }
   return Qnil;
 }
 
 /* Store character c into kbd macro being defined */
 

+void

 store_kbd_macro_char (c)
      Lisp_Object c;
 {
 store_kbd_macro_char (c)
      Lisp_Object c;
 {

-  if (!NILP (current_perdisplay->defining_kbd_macro))
+  struct kboard *kb = current_kboard;
+
+  if (!NILP (kb->defining_kbd_macro))

     {
     {

-      if ((current_perdisplay->kbd_macro_ptr
-          - current_perdisplay->kbd_macro_buffer)
-         == current_perdisplay->kbd_macro_bufsize)
+      if (kb->kbd_macro_ptr - kb->kbd_macro_buffer == kb->kbd_macro_bufsize)

        {
        {

-         register Lisp_Object *new;
-         current_perdisplay->kbd_macro_bufsize *= 2;
-         new = (Lisp_Object *)xrealloc (current_perdisplay->kbd_macro_buffer,
-                                        (current_perdisplay->kbd_macro_bufsize
-                                         * sizeof (Lisp_Object)));
-         current_perdisplay->kbd_macro_ptr
-           += new - current_perdisplay->kbd_macro_buffer;
-         current_perdisplay->kbd_macro_end
-           += new - current_perdisplay->kbd_macro_buffer;
-         current_perdisplay->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;

        }
        }

-      *current_perdisplay->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.  */
 
     }
 }
 
 /* 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 ()
 {
 finalize_kbd_macro_chars ()
 {

-  current_perdisplay->kbd_macro_end = current_perdisplay->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;
+  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)
+     Lisp_Object event;
+{
+  store_kbd_macro_char (event);
+  return Qnil;

 }
 \f
 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro,
 }
 \f
 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro,


@@ -159,25 +238,40 @@ defining others, use \\[name-last-kbd-macro].")
   (prefix)
      Lisp_Object prefix;
 {
   (prefix)
      Lisp_Object prefix;
 {

-  if (! NILP (current_perdisplay->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");
     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
     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.  */
   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;
 {
   Lisp_Object tem;
 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_macro = XCAR (info);
+  tem = XCDR (info);
+  executing_macro_index = XINT (XCAR (tem));
+  real_this_command = XCDR (tem);
+  Frun_hooks (1, &Qkbd_macro_termination_hook);

   return Qnil;
 }
 
   return Qnil;
 }
 


@@ -185,79 +279,89 @@ 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.")
   "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;
 {
   Lisp_Object final;
   Lisp_Object tem;

-  int count = specpdl_ptr - specpdl;
+  int pdlcount = specpdl_ptr - specpdl;

   int repeat = 1;
   struct gcpro gcpro1;
   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))
 
   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");

 
 

-  XSETFASTINT (tem, executing_macro_index);
-  tem = Fcons (Vexecuting_macro, tem);
+  tem = Fcons (Vexecuting_macro,
+              Fcons (make_number (executing_macro_index),
+                     real_this_command));

   record_unwind_protect (pop_kbd_macro, tem);
 
   GCPRO1 (final);
   do
     {
       Vexecuting_macro = final;
   record_unwind_protect (pop_kbd_macro, tem);
 
   GCPRO1 (final);
   do
     {
       Vexecuting_macro = final;

+      executing_macro = final;

       executing_macro_index = 0;
 
       executing_macro_index = 0;
 

-      if (!current_perdisplay)
-       abort ();
-      clear_prefix_arg ();
+      current_kboard->Vprefix_arg = Qnil;

       command_loop_1 ();
 
       command_loop_1 ();
 

+      executing_macro_iterations = ++success_count;
+

       QUIT;
     }
   while (--repeat
         && (STRINGP (Vexecuting_macro) || VECTORP (Vexecuting_macro)));
 
       QUIT;
     }
   while (--repeat
         && (STRINGP (Vexecuting_macro) || VECTORP (Vexecuting_macro)));
 

+  executing_macro = Qnil;
+
+  real_this_command = Vexecuting_macro;
+

   UNGCPRO;
   UNGCPRO;

-  return unbind_to (count, Qnil);
+  return unbind_to (pdlcount, Qnil);

 }
 \f
 }
 \f

+void

 init_macros ()
 {
 init_macros ()
 {

-  Vlast_kbd_macro = Qnil;

   Vexecuting_macro = Qnil;
   Vexecuting_macro = Qnil;

+  executing_macro = Qnil;

 }
 
 }
 

+void

 syms_of_macros ()
 {
   Qexecute_kbd_macro = intern ("execute-kbd-macro");
   staticpro (&Qexecute_kbd_macro);
 syms_of_macros ()
 {
   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 (&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_DISPLAY ("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,
     "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,
 
   DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro,

-    "Currently executing keyboard macro (a string); nil if none executing.");
-
-  DEFVAR_LISP ("last-kbd-macro", &Vlast_kbd_macro,
-    "Last kbd macro defined, as a string; nil if none defined.");
-}
+    "Currently executing keyboard macro (string or vector); nil if none executing.");

 
 

-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");
+  DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro,
+    "Last kbd macro defined, as a string or vector; nil if none defined.");

 }
 }