]> code.delx.au - gnu-emacs/blobdiff - src/macros.c
(nnmail-active-file-coding-system, gnus-original-article-buffer,
[gnu-emacs] / src / macros.c
index 5f6d83b52d6ac43e9c6a77a2b435ec64e365d5ce..8167e274dab452f9e9cab386d072b250d5807955 100644 (file)
@@ -1,5 +1,6 @@
 /* Keyboard macros.
 /* Keyboard macros.
-   Copyright (C) 1985, 1986, 1993, 2000, 2001 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1986, 1993, 2000, 2001, 2002, 2003, 2004,
+                 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
 
 This file is part of GNU Emacs.
 
@@ -15,8 +16,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, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.  */
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.  */
 
 
 #include <config.h>
 
 
 #include <config.h>
@@ -31,39 +32,41 @@ Lisp_Object Qexecute_kbd_macro, Qkbd_macro_termination_hook;
 
 /* Kbd macro currently being executed (a string or vector).  */
 
 
 /* Kbd macro currently being executed (a string or vector).  */
 
-Lisp_Object Vexecuting_macro;
+Lisp_Object Vexecuting_kbd_macro;
 
 /* Index of next character to fetch from that macro.  */
 
 
 /* Index of next character to fetch from that macro.  */
 
-int executing_macro_index;
+EMACS_INT executing_kbd_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.  */
 
 
 /* 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;
+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.  */
 
 
 /* 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;
+Lisp_Object executing_kbd_macro;
 
 extern Lisp_Object real_this_command;
 
 Lisp_Object Fexecute_kbd_macro ();
 \f
 
 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",
+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;
        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.  */)
-     (append)
-     Lisp_Object append;
+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");
 {
   if (!NILP (current_kboard->defining_kbd_macro))
     error ("Already defining kbd macro");
@@ -91,6 +94,7 @@ this begins by re-executing that macro as if you typed it again.  */)
   else
     {
       int i, len;
   else
     {
       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)
 
       /* Check the type of last-kbd-macro in case Lisp code changed it.  */
       if (!STRINGP (current_kboard->Vlast_kbd_macro)
@@ -109,26 +113,48 @@ this begins by re-executing that macro as if you typed it again.  */)
            = (Lisp_Object *)xrealloc (current_kboard->kbd_macro_buffer,
                                       (len + 30) * sizeof (Lisp_Object));
        }
            = (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++)
       for (i = 0; i < len; i++)
-       current_kboard->kbd_macro_buffer[i]
-         = Faref (current_kboard->Vlast_kbd_macro, make_number (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.  */
 
       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));
+      if (NILP (no_exec))
+       Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro,
+                           make_number (1), Qnil);
 
       message ("Appending to kbd macro...");
     }
   current_kboard->defining_kbd_macro = Qt;
 
       message ("Appending to kbd macro...");
     }
   current_kboard->defining_kbd_macro = Qt;
-  
+
   return Qnil;
 }
 
   return Qnil;
 }
 
-DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 1, "p",
+/* 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],
        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],
@@ -137,9 +163,12 @@ under that name.
 
 With numeric arg, repeat macro now that many times,
 counting the definition just completed as the first repetition.
 
 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.  */)
-     (repeat)
-     Lisp_Object repeat;
+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 (current_kboard->defining_kbd_macro))
     error ("Not defining kbd macro");
@@ -151,22 +180,17 @@ An argument of zero means repeat until error.  */)
 
   if (!NILP (current_kboard->defining_kbd_macro))
     {
 
   if (!NILP (current_kboard->defining_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);
+      end_kbd_macro ();
       message ("Keyboard macro defined");
     }
 
   if (XFASTINT (repeat) == 0)
       message ("Keyboard macro defined");
     }
 
   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)
   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;
 }
     }
   return Qnil;
 }
@@ -184,7 +208,7 @@ store_kbd_macro_char (c)
       if (kb->kbd_macro_ptr - kb->kbd_macro_buffer == kb->kbd_macro_bufsize)
        {
          int ptr_offset, end_offset, nbytes;
       if (kb->kbd_macro_ptr - kb->kbd_macro_buffer == kb->kbd_macro_bufsize)
        {
          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;
          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;
@@ -194,7 +218,7 @@ store_kbd_macro_char (c)
          kb->kbd_macro_ptr = kb->kbd_macro_buffer + ptr_offset;
          kb->kbd_macro_end = kb->kbd_macro_buffer + end_offset;
        }
          kb->kbd_macro_ptr = kb->kbd_macro_buffer + ptr_offset;
          kb->kbd_macro_end = kb->kbd_macro_buffer + end_offset;
        }
-      
+
       *kb->kbd_macro_ptr++ = c;
     }
 }
       *kb->kbd_macro_ptr++ = c;
     }
 }
@@ -228,15 +252,18 @@ DEFUN ("store-kbd-macro-event", Fstore_kbd_macro_event,
 }
 \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,
-       0, 1, "p",
+       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
        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].  */)
-     (prefix)
-     Lisp_Object prefix;
+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.  */
 {
   /* Don't interfere with recognition of the previous command
      from before this macro started.  */
@@ -249,7 +276,7 @@ defining others, use \\[name-last-kbd-macro].  */)
   else if (NILP (current_kboard->Vlast_kbd_macro))
     error ("No kbd macro has been defined");
   else
   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
 
   /* command_loop_1 sets this to nil before it returns;
      get back the last command within the macro
@@ -259,37 +286,40 @@ defining others, use \\[name-last-kbd-macro].  */)
   return Qnil;
 }
 
   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;
 
 static Lisp_Object
 pop_kbd_macro (info)
      Lisp_Object info;
 {
   Lisp_Object tem;
-  Vexecuting_macro = XCAR (info);
+  Vexecuting_kbd_macro = XCAR (info);
   tem = XCDR (info);
   tem = XCDR (info);
-  executing_macro_index = XINT (XCAR (tem));
+  executing_kbd_macro_index = XINT (XCAR (tem));
   real_this_command = XCDR (tem);
   Frun_hooks (1, &Qkbd_macro_termination_hook);
   return Qnil;
 }
 
   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,
+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.
        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.  */)
-     (macro, count)
-     Lisp_Object macro, count;
+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_INDEX ();
   int repeat = 1;
 {
   Lisp_Object final;
   Lisp_Object tem;
   int pdlcount = SPECPDL_INDEX ();
   int repeat = 1;
-  struct gcpro gcpro1;
+  struct gcpro gcpro1, gcpro2;
   int success_count = 0;
 
   int success_count = 0;
 
-  executing_macro_iterations = 0;
+  executing_kbd_macro_iterations = 0;
 
   if (!NILP (count))
     {
 
   if (!NILP (count))
     {
@@ -301,31 +331,40 @@ COUNT is a repeat count, or nil for once, or 0 for infinite loop.  */)
   if (!STRINGP (final) && !VECTORP (final))
     error ("Keyboard macros must be strings or vectors");
 
   if (!STRINGP (final) && !VECTORP (final))
     error ("Keyboard macros must be strings or vectors");
 
-  tem = Fcons (Vexecuting_macro,
-              Fcons (make_number (executing_macro_index),
+  tem = Fcons (Vexecuting_kbd_macro,
+              Fcons (make_number (executing_kbd_macro_index),
                      real_this_command));
   record_unwind_protect (pop_kbd_macro, tem);
 
                      real_this_command));
   record_unwind_protect (pop_kbd_macro, tem);
 
-  GCPRO1 (final);
+  GCPRO2 (final, loopfunc);
   do
     {
   do
     {
-      Vexecuting_macro = final;
-      executing_macro = final;
-      executing_macro_index = 0;
+      Vexecuting_kbd_macro = final;
+      executing_kbd_macro = final;
+      executing_kbd_macro_index = 0;
 
       current_kboard->Vprefix_arg = Qnil;
 
       current_kboard->Vprefix_arg = Qnil;
+
+      if (!NILP (loopfunc))
+       {
+         Lisp_Object cont;
+         cont = call0 (loopfunc);
+         if (NILP (cont))
+           break;
+       }
+
       command_loop_1 ();
 
       command_loop_1 ();
 
-      executing_macro_iterations = ++success_count;
+      executing_kbd_macro_iterations = ++success_count;
 
       QUIT;
     }
   while (--repeat
 
       QUIT;
     }
   while (--repeat
-        && (STRINGP (Vexecuting_macro) || VECTORP (Vexecuting_macro)));
+        && (STRINGP (Vexecuting_kbd_macro) || VECTORP (Vexecuting_kbd_macro)));
 
 
-  executing_macro = Qnil;
+  executing_kbd_macro = Qnil;
 
 
-  real_this_command = Vexecuting_macro;
+  real_this_command = Vexecuting_kbd_macro;
 
   UNGCPRO;
   return unbind_to (pdlcount, Qnil);
 
   UNGCPRO;
   return unbind_to (pdlcount, Qnil);
@@ -334,8 +373,8 @@ COUNT is a repeat count, or nil for once, or 0 for infinite loop.  */)
 void
 init_macros ()
 {
 void
 init_macros ()
 {
-  Vexecuting_macro = Qnil;
-  executing_macro = Qnil;
+  Vexecuting_kbd_macro = Qnil;
+  executing_kbd_macro = Qnil;
 }
 
 void
 }
 
 void
@@ -354,14 +393,20 @@ syms_of_macros ()
   defsubr (&Sstore_kbd_macro_event);
 
   DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
   defsubr (&Sstore_kbd_macro_event);
 
   DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
-                doc: /* 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!
+The value is the symbol `append' while appending to the definition of
+an existing macro.  */);
 
 
-  DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
-              doc: /* Currently executing keyboard macro (string or vector); 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,
-                    doc: /* Currently executing keyboard macro (string or vector); 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_KBOARD ("last-kbd-macro", Vlast_kbd_macro,
                 doc: /* Last kbd macro defined, as a string or vector; 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.  */);
 }
+
+/* arch-tag: d293fcc9-2266-4163-9198-7fa0de12ec9e
+   (do not change this comment) */