Sync docs of some X, W32, NS C functions.
[emacs.git] / src / macros.h
blob761b5fdf51403a26bedf4ab871a5424639c8a0a6
1 /* Definitions for keyboard macro interpretation in GNU Emacs.
2 Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
3 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
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.
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.
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/>. */
21 /* Kbd macro currently being executed (a string or vector). */
23 extern Lisp_Object Vexecuting_kbd_macro;
25 /* Index of next character to fetch from that macro. */
27 extern EMACS_INT executing_kbd_macro_index;
29 /* Number of successful iterations so far
30 for innermost keyboard macro.
31 This is not bound at each level,
32 so after an error, it describes the innermost interrupted macro. */
34 extern int executing_kbd_macro_iterations;
36 /* This is the macro that was executing.
37 This is not bound at each level,
38 so after an error, it describes the innermost interrupted macro. */
40 extern Lisp_Object executing_kbd_macro;
42 /* Finish defining the current keyboard macro. */
44 extern void end_kbd_macro (void);
46 /* Declare that all chars stored so far in the kbd macro being defined
47 really belong to it. This is done in between editor commands. */
49 extern void finalize_kbd_macro_chars (void);
51 /* Store a character into kbd macro being defined */
53 extern void store_kbd_macro_char (Lisp_Object);
55 /* arch-tag: 8edb7088-682f-4d1f-a4d9-0fbb7284234e
56 (do not change this comment) */