src/macros.c

   1 /* Keyboard macros.
   2
   3 Copyright (C) 1985-1986, 1993, 2000-2012  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20
  21 #include <config.h>
  22 #include <setjmp.h>
  23 #include "lisp.h"
  24 #include "macros.h"
  25 #include "commands.h"
  26 #include "character.h"
  27 #include "buffer.h"
  28 #include "window.h"
  29 #include "keyboard.h"
  30
  31 Lisp_Object Qexecute_kbd_macro;
  32 static Lisp_Object Qkbd_macro_termination_hook;
  33
  34 /* Number of successful iterations so far
  35    for innermost keyboard macro.
  36    This is not bound at each level,
  37    so after an error, it describes the innermost interrupted macro.  */
  38
  39 EMACS_INT executing_kbd_macro_iterations;
  40
  41 /* This is the macro that was executing.
  42    This is not bound at each level,
  43    so after an error, it describes the innermost interrupted macro.
  44    We use it only as a kind of flag, so no need to protect it.  */
  45
  46 Lisp_Object executing_kbd_macro;
  47
  48 Lisp_Object Fexecute_kbd_macro (Lisp_Object macro, Lisp_Object count, Lisp_Object loopfunc);
  49 \f
  50 DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 2, "P",
  51        doc: /* Record subsequent keyboard input, defining a keyboard macro.
  52 The commands are recorded even as they are executed.
  53 Use \\[end-kbd-macro] to finish recording and make the macro available.
  54 Use \\[name-last-kbd-macro] to give it a permanent name.
  55 Non-nil arg (prefix arg) means append to last macro defined;
  56 this begins by re-executing that macro as if you typed it again.
  57 If optional second arg, NO-EXEC, is non-nil, do not re-execute last
  58 macro before appending to it. */)
  59   (Lisp_Object append, Lisp_Object no_exec)
  60 {
  61   if (!NILP (KVAR (current_kboard, defining_kbd_macro)))
  62     error ("Already defining kbd macro");
  63
  64   if (!current_kboard->kbd_macro_buffer)
  65     {
  66       current_kboard->kbd_macro_buffer = xmalloc (30 * word_size);
  67       current_kboard->kbd_macro_bufsize = 30;
  68     }
  69   update_mode_lines++;
  70   if (NILP (append))
  71     {
  72       if (current_kboard->kbd_macro_bufsize > 200)
  73         {
  74           current_kboard->kbd_macro_buffer
  75             = xrealloc (current_kboard->kbd_macro_buffer,
  76                         30 * word_size);
  77           current_kboard->kbd_macro_bufsize = 30;
  78         }
  79       current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer;
  80       current_kboard->kbd_macro_end = current_kboard->kbd_macro_buffer;
  81       message ("Defining kbd macro...");
  82     }
  83   else
  84     {
  85       ptrdiff_t i;
  86       EMACS_INT len;
  87       int cvt;
  88
  89       /* Check the type of last-kbd-macro in case Lisp code changed it.  */
  90       CHECK_VECTOR_OR_STRING (KVAR (current_kboard, Vlast_kbd_macro));
  91
  92       len = XINT (Flength (KVAR (current_kboard, Vlast_kbd_macro)));
  93
  94       /* Copy last-kbd-macro into the buffer, in case the Lisp code
  95          has put another macro there.  */
  96       if (current_kboard->kbd_macro_bufsize < len + 30)
  97         {
  98           if (PTRDIFF_MAX < MOST_POSITIVE_FIXNUM + 30
  99               && PTRDIFF_MAX < len + 30)
 100             memory_full (SIZE_MAX);
 101           current_kboard->kbd_macro_buffer =
 102             xpalloc (current_kboard->kbd_macro_buffer,
 103                      &current_kboard->kbd_macro_bufsize,
 104                      len + 30 - current_kboard->kbd_macro_bufsize, -1,
 105                      sizeof *current_kboard->kbd_macro_buffer);
 106         }
 107
 108       /* Must convert meta modifier when copying string to vector.  */
 109       cvt = STRINGP (KVAR (current_kboard, Vlast_kbd_macro));
 110       for (i = 0; i < len; i++)
 111         {
 112           Lisp_Object c;
 113           c = Faref (KVAR (current_kboard, Vlast_kbd_macro), make_number (i));
 114           if (cvt && NATNUMP (c) && (XFASTINT (c) & 0x80))
 115             XSETFASTINT (c, CHAR_META | (XFASTINT (c) & ~0x80));
 116           current_kboard->kbd_macro_buffer[i] = c;
 117         }
 118
 119       current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer + len;
 120       current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr;
 121
 122       /* Re-execute the macro we are appending to,
 123          for consistency of behavior.  */
 124       if (NILP (no_exec))
 125         Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro),
 126                             make_number (1), Qnil);
 127
 128       message ("Appending to kbd macro...");
 129     }
 130   KVAR (current_kboard, defining_kbd_macro) = Qt;
 131
 132   return Qnil;
 133 }
 134
 135 /* Finish defining the current keyboard macro.  */
 136
 137 void
 138 end_kbd_macro (void)
 139 {
 140   KVAR (current_kboard, defining_kbd_macro) = Qnil;
 141   update_mode_lines++;
 142   KVAR (current_kboard, Vlast_kbd_macro)
 143     = make_event_array ((current_kboard->kbd_macro_end
 144                          - current_kboard->kbd_macro_buffer),
 145                         current_kboard->kbd_macro_buffer);
 146 }
 147
 148 DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 2, "p",
 149        doc: /* Finish defining a keyboard macro.
 150 The definition was started by \\[start-kbd-macro].
 151 The macro is now available for use via \\[call-last-kbd-macro],
 152 or it can be given a name with \\[name-last-kbd-macro] and then invoked
 153 under that name.
 154
 155 With numeric arg, repeat macro now that many times,
 156 counting the definition just completed as the first repetition.
 157 An argument of zero means repeat until error.
 158
 159 In Lisp, optional second arg LOOPFUNC may be a function that is called prior to
 160 each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
 161   (Lisp_Object repeat, Lisp_Object loopfunc)
 162 {
 163   if (NILP (KVAR (current_kboard, defining_kbd_macro)))
 164     error ("Not defining kbd macro");
 165
 166   if (NILP (repeat))
 167     XSETFASTINT (repeat, 1);
 168   else
 169     CHECK_NUMBER (repeat);
 170
 171   if (!NILP (KVAR (current_kboard, defining_kbd_macro)))
 172     {
 173       end_kbd_macro ();
 174       message ("Keyboard macro defined");
 175     }
 176
 177   if (XFASTINT (repeat) == 0)
 178     Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro), repeat, loopfunc);
 179   else if (XINT (repeat) > 1)
 180     {
 181       XSETINT (repeat, XINT (repeat)-1);
 182       Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro),
 183                           repeat, loopfunc);
 184     }
 185   return Qnil;
 186 }
 187
 188 /* Store character c into kbd macro being defined */
 189
 190 void
 191 store_kbd_macro_char (Lisp_Object c)
 192 {
 193   struct kboard *kb = current_kboard;
 194
 195   if (!NILP (KVAR (kb, defining_kbd_macro)))
 196     {
 197       if (kb->kbd_macro_ptr - kb->kbd_macro_buffer == kb->kbd_macro_bufsize)
 198         {
 199           ptrdiff_t ptr_offset, end_offset, nbytes;
 200
 201           ptr_offset = kb->kbd_macro_ptr - kb->kbd_macro_buffer;
 202           end_offset = kb->kbd_macro_end - kb->kbd_macro_buffer;
 203           if (min (PTRDIFF_MAX, SIZE_MAX) / sizeof *kb->kbd_macro_buffer / 2
 204               < kb->kbd_macro_bufsize)
 205             memory_full (SIZE_MAX);
 206           nbytes = kb->kbd_macro_bufsize * (2 * sizeof *kb->kbd_macro_buffer);
 207           kb->kbd_macro_buffer = xrealloc (kb->kbd_macro_buffer, nbytes);
 208           kb->kbd_macro_bufsize *= 2;
 209           kb->kbd_macro_ptr = kb->kbd_macro_buffer + ptr_offset;
 210           kb->kbd_macro_end = kb->kbd_macro_buffer + end_offset;
 211         }
 212
 213       *kb->kbd_macro_ptr++ = c;
 214     }
 215 }
 216
 217 /* Declare that all chars stored so far in the kbd macro being defined
 218  really belong to it.  This is done in between editor commands.  */
 219
 220 void
 221 finalize_kbd_macro_chars (void)
 222 {
 223   current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr;
 224 }
 225
 226 DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events,
 227        Scancel_kbd_macro_events, 0, 0, 0,
 228        doc: /* Cancel the events added to a keyboard macro for this command.  */)
 229   (void)
 230 {
 231   current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end;
 232   return Qnil;
 233 }
 234
 235 DEFUN ("store-kbd-macro-event", Fstore_kbd_macro_event,
 236        Sstore_kbd_macro_event, 1, 1, 0,
 237        doc: /* Store EVENT into the keyboard macro being defined.  */)
 238   (Lisp_Object event)
 239 {
 240   store_kbd_macro_char (event);
 241   return Qnil;
 242 }
 243 \f
 244 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro,
 245        0, 2, "p",
 246        doc: /* Call the last keyboard macro that you defined with \\[start-kbd-macro].
 247
 248 A prefix argument serves as a repeat count.  Zero means repeat until error.
 249
 250 To make a macro permanent so you can call it even after
 251 defining others, use \\[name-last-kbd-macro].
 252
 253 In Lisp, optional second arg LOOPFUNC may be a function that is called prior to
 254 each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
 255   (Lisp_Object prefix, Lisp_Object loopfunc)
 256 {
 257   /* Don't interfere with recognition of the previous command
 258      from before this macro started.  */
 259   Vthis_command = KVAR (current_kboard, Vlast_command);
 260   /* C-x z after the macro should repeat the macro.  */
 261   Vreal_this_command = KVAR (current_kboard, Vlast_kbd_macro);
 262
 263   if (! NILP (KVAR (current_kboard, defining_kbd_macro)))
 264     error ("Can't execute anonymous macro while defining one");
 265   else if (NILP (KVAR (current_kboard, Vlast_kbd_macro)))
 266     error ("No kbd macro has been defined");
 267   else
 268     Fexecute_kbd_macro (KVAR (current_kboard, Vlast_kbd_macro), prefix, loopfunc);
 269
 270   /* command_loop_1 sets this to nil before it returns;
 271      get back the last command within the macro
 272      so that it can be last, again, after we return.  */
 273   Vthis_command = KVAR (current_kboard, Vlast_command);
 274
 275   return Qnil;
 276 }
 277
 278 /* Restore Vexecuting_kbd_macro and executing_kbd_macro_index.
 279    Called when the unwind-protect in Fexecute_kbd_macro gets invoked.  */
 280
 281 static Lisp_Object
 282 pop_kbd_macro (Lisp_Object info)
 283 {
 284   Lisp_Object tem;
 285   Vexecuting_kbd_macro = XCAR (info);
 286   tem = XCDR (info);
 287   executing_kbd_macro_index = XINT (XCAR (tem));
 288   Vreal_this_command = XCDR (tem);
 289   Frun_hooks (1, &Qkbd_macro_termination_hook);
 290   return Qnil;
 291 }
 292
 293 DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 3, 0,
 294        doc: /* Execute MACRO as string of editor command characters.
 295 If MACRO is a symbol, its function definition is used.
 296 COUNT is a repeat count, or nil for once, or 0 for infinite loop.
 297
 298 Optional third arg LOOPFUNC may be a function that is called prior to
 299 each iteration of the macro.  Iteration stops if LOOPFUNC returns nil.  */)
 300   (Lisp_Object macro, Lisp_Object count, Lisp_Object loopfunc)
 301 {
 302   Lisp_Object final;
 303   Lisp_Object tem;
 304   ptrdiff_t pdlcount = SPECPDL_INDEX ();
 305   EMACS_INT repeat = 1;
 306   struct gcpro gcpro1, gcpro2;
 307   EMACS_INT success_count = 0;
 308
 309   executing_kbd_macro_iterations = 0;
 310
 311   if (!NILP (count))
 312     {
 313       count = Fprefix_numeric_value (count);
 314       repeat = XINT (count);
 315     }
 316
 317   final = indirect_function (macro);
 318   if (!STRINGP (final) && !VECTORP (final))
 319     error ("Keyboard macros must be strings or vectors");
 320
 321   tem = Fcons (Vexecuting_kbd_macro,
 322                Fcons (make_number (executing_kbd_macro_index),
 323                       Vreal_this_command));
 324   record_unwind_protect (pop_kbd_macro, tem);
 325
 326   GCPRO2 (final, loopfunc);
 327   do
 328     {
 329       Vexecuting_kbd_macro = final;
 330       executing_kbd_macro = final;
 331       executing_kbd_macro_index = 0;
 332
 333       KVAR (current_kboard, Vprefix_arg) = Qnil;
 334
 335       if (!NILP (loopfunc))
 336         {
 337           Lisp_Object cont;
 338           cont = call0 (loopfunc);
 339           if (NILP (cont))
 340             break;
 341         }
 342
 343       command_loop_1 ();
 344
 345       executing_kbd_macro_iterations = ++success_count;
 346
 347       QUIT;
 348     }
 349   while (--repeat
 350          && (STRINGP (Vexecuting_kbd_macro) || VECTORP (Vexecuting_kbd_macro)));
 351
 352   executing_kbd_macro = Qnil;
 353
 354   Vreal_this_command = Vexecuting_kbd_macro;
 355
 356   UNGCPRO;
 357   return unbind_to (pdlcount, Qnil);
 358 }
 359 \f
 360 void
 361 init_macros (void)
 362 {
 363   Vexecuting_kbd_macro = Qnil;
 364   executing_kbd_macro = Qnil;
 365 }
 366
 367 void
 368 syms_of_macros (void)
 369 {
 370   DEFSYM (Qexecute_kbd_macro, "execute-kbd-macro");
 371
 372   DEFVAR_LISP ("kbd-macro-termination-hook", Vkbd_macro_termination_hook,
 373                doc: /* Normal hook run whenever a keyboard macro terminates.
 374 This is run whether the macro ends normally or prematurely due to an error.  */);
 375   Vkbd_macro_termination_hook = Qnil;
 376   DEFSYM (Qkbd_macro_termination_hook, "kbd-macro-termination-hook");
 377
 378   defsubr (&Sstart_kbd_macro);
 379   defsubr (&Send_kbd_macro);
 380   defsubr (&Scall_last_kbd_macro);
 381   defsubr (&Sexecute_kbd_macro);
 382   defsubr (&Scancel_kbd_macro_events);
 383   defsubr (&Sstore_kbd_macro_event);
 384
 385   DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
 386                  doc: /* Non-nil while a keyboard macro is being defined.  Don't set this!
 387 The value is the symbol `append' while appending to the definition of
 388 an existing macro.  */);
 389
 390   DEFVAR_LISP ("executing-kbd-macro", Vexecuting_kbd_macro,
 391                doc: /* Currently executing keyboard macro (string or vector).
 392 This is nil when not executing a keyboard macro.  */);
 393
 394   DEFVAR_INT ("executing-kbd-macro-index", executing_kbd_macro_index,
 395               doc: /* Index in currently executing keyboard macro; undefined if none executing.  */);
 396
 397   DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro,
 398                  doc: /* Last kbd macro defined, as a string or vector; nil if none defined.  */);
 399 }