Refer to set-coding-system-priority instead of the obsolete
[bpt/emacs.git] / src / macros.c
index 09ae87b..c281c89 100644 (file)
@@ -1,12 +1,13 @@
 /* Keyboard macros.
-   Copyright (C) 1985, 1986, 1993, 2000, 2001 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1986, 1993, 2000, 2001, 2002, 2003, 2004,
+                 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
-GNU Emacs is free software; you can redistribute it and/or modify
+GNU Emacs is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
-any later version.
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -14,12 +15,11 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 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, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.  */
+along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
 
 
 #include <config.h>
+#include <setjmp.h>
 #include "lisp.h"
 #include "macros.h"
 #include "commands.h"
@@ -31,29 +31,27 @@ Lisp_Object Qexecute_kbd_macro, Qkbd_macro_termination_hook;
 
 /* 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.  */
 
-EMACS_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.  */
 
-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.  */
 
-Lisp_Object executing_macro;
+Lisp_Object executing_kbd_macro;
 
-extern Lisp_Object real_this_command;
-
-Lisp_Object Fexecute_kbd_macro ();
+Lisp_Object Fexecute_kbd_macro (Lisp_Object macro, Lisp_Object count, Lisp_Object loopfunc);
 \f
 DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 2, "P",
        doc: /* Record subsequent keyboard input, defining a keyboard macro.
@@ -64,8 +62,7 @@ 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;
+  (Lisp_Object append, Lisp_Object no_exec)
 {
   if (!NILP (current_kboard->defining_kbd_macro))
     error ("Already defining kbd macro");
@@ -96,10 +93,7 @@ macro before appending to it. */)
       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);
+      CHECK_VECTOR_OR_STRING (current_kboard->Vlast_kbd_macro);
 
       len = XINT (Flength (current_kboard->Vlast_kbd_macro));
 
@@ -114,7 +108,7 @@ macro before appending to it. */)
        }
 
       /* Must convert meta modifier when copying string to vector.  */
-      cvt = STRINGP (current_kboard->Vlast_kbd_macro); 
+      cvt = STRINGP (current_kboard->Vlast_kbd_macro);
       for (i = 0; i < len; i++)
        {
          Lisp_Object c;
@@ -143,7 +137,7 @@ macro before appending to it. */)
 /* Finish defining the current keyboard macro.  */
 
 void
-end_kbd_macro ()
+end_kbd_macro (void)
 {
   current_kboard->defining_kbd_macro = Qnil;
   update_mode_lines++;
@@ -166,8 +160,7 @@ 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;
+  (Lisp_Object repeat, Lisp_Object loopfunc)
 {
   if (NILP (current_kboard->defining_kbd_macro))
     error ("Not defining kbd macro");
@@ -197,8 +190,7 @@ each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
 /* Store character c into kbd macro being defined */
 
 void
-store_kbd_macro_char (c)
-     Lisp_Object c;
+store_kbd_macro_char (Lisp_Object c)
 {
   struct kboard *kb = current_kboard;
 
@@ -226,7 +218,7 @@ store_kbd_macro_char (c)
  really belong to it.  This is done in between editor commands.  */
 
 void
-finalize_kbd_macro_chars ()
+finalize_kbd_macro_chars (void)
 {
   current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr;
 }
@@ -234,7 +226,7 @@ finalize_kbd_macro_chars ()
 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.  */)
-     ()
+  (void)
 {
   current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end;
   return Qnil;
@@ -243,8 +235,7 @@ DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events,
 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;
+  (Lisp_Object event)
 {
   store_kbd_macro_char (event);
   return Qnil;
@@ -261,8 +252,7 @@ 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;
+  (Lisp_Object prefix, Lisp_Object loopfunc)
 {
   /* Don't interfere with recognition of the previous command
      from before this macro started.  */
@@ -285,17 +275,16 @@ each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
   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;
+pop_kbd_macro (Lisp_Object info)
 {
   Lisp_Object tem;
-  Vexecuting_macro = XCAR (info);
+  Vexecuting_kbd_macro = XCAR (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;
@@ -308,8 +297,7 @@ 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 macro, Lisp_Object count, Lisp_Object loopfunc)
 {
   Lisp_Object final;
   Lisp_Object tem;
@@ -318,7 +306,7 @@ each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
   struct gcpro gcpro1, gcpro2;
   int success_count = 0;
 
-  executing_macro_iterations = 0;
+  executing_kbd_macro_iterations = 0;
 
   if (!NILP (count))
     {
@@ -330,17 +318,17 @@ each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
   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);
 
   GCPRO2 (final, loopfunc);
   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;
 
@@ -354,34 +342,34 @@ each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
 
       command_loop_1 ();
 
-      executing_macro_iterations = ++success_count;
+      executing_kbd_macro_iterations = ++success_count;
 
       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);
 }
 \f
 void
-init_macros ()
+init_macros (void)
 {
-  Vexecuting_macro = Qnil;
-  executing_macro = Qnil;
+  Vexecuting_kbd_macro = Qnil;
+  executing_kbd_macro = Qnil;
 }
 
 void
-syms_of_macros ()
+syms_of_macros (void)
 {
-  Qexecute_kbd_macro = intern ("execute-kbd-macro");
+  Qexecute_kbd_macro = intern_c_string ("execute-kbd-macro");
   staticpro (&Qexecute_kbd_macro);
-  Qkbd_macro_termination_hook = intern ("kbd-macro-termination-hook");
+  Qkbd_macro_termination_hook = intern_c_string ("kbd-macro-termination-hook");
   staticpro (&Qkbd_macro_termination_hook);
 
   defsubr (&Sstart_kbd_macro);
@@ -396,15 +384,13 @@ syms_of_macros ()
 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_INT ("executing-macro-index", &executing_macro_index,
+  DEFVAR_INT ("executing-kbd-macro-index", &executing_kbd_macro_index,
              doc: /* Index in currently executing keyboard macro; undefined if none executing.  */);
 
-  DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro,
-                    doc: /* Currently executing keyboard macro (string or vector); nil 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.  */);
 }